botman

package
v8.3.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jul 9, 2024 License: Apache-2.0 Imports: 12 Imported by: 1

Documentation

Overview

Package botman provides access to the Akamai Application Security Botman APIs

Index

Constants

This section is empty.

Variables

View Source 
var (
	// ErrStructValidation is returned when given struct validation failed
	ErrStructValidation = errors.New("struct validation")
)

Functions

This section is empty.

Types

type AkamaiBotCategory 

type AkamaiBotCategory interface {
	// GetAkamaiBotCategoryList https://techdocs.akamai.com/bot-manager/reference/get-akamai-bot-categories
	GetAkamaiBotCategoryList(ctx context.Context, params GetAkamaiBotCategoryListRequest) (*GetAkamaiBotCategoryListResponse, error)
}

The AkamaiBotCategory interface supports retrieving akamai bot categories

type AkamaiBotCategoryAction 

type AkamaiBotCategoryAction interface {
	// GetAkamaiBotCategoryActionList https://techdocs.akamai.com/bot-manager/reference/get-akamai-bot-category-actions
	GetAkamaiBotCategoryActionList(ctx context.Context, params GetAkamaiBotCategoryActionListRequest) (*GetAkamaiBotCategoryActionListResponse, error)

	// GetAkamaiBotCategoryAction https://techdocs.akamai.com/bot-manager/reference/get-akamai-bot-category-action
	GetAkamaiBotCategoryAction(ctx context.Context, params GetAkamaiBotCategoryActionRequest) (map[string]interface{}, error)

	// UpdateAkamaiBotCategoryAction https://techdocs.akamai.com/bot-manager/reference/put-akamai-bot-category-action
	UpdateAkamaiBotCategoryAction(ctx context.Context, params UpdateAkamaiBotCategoryActionRequest) (map[string]interface{}, error)
}

The AkamaiBotCategoryAction interface supports retrieving and updating the actions for the akamai bot categories of a configuration

type AkamaiDefinedBot 

type AkamaiDefinedBot interface {
	// GetAkamaiDefinedBotList https://techdocs.akamai.com/bot-manager/reference/get-akamai-defined-bots
	GetAkamaiDefinedBotList(ctx context.Context, params GetAkamaiDefinedBotListRequest) (*GetAkamaiDefinedBotListResponse, error)
}

The AkamaiDefinedBot interface supports retrieving akamai defined bots

type BotAnalyticsCookie 

type BotAnalyticsCookie interface {

	// GetBotAnalyticsCookie https://techdocs.akamai.com/bot-manager/reference/get-bot-analytics-cookie
	GetBotAnalyticsCookie(ctx context.Context, params GetBotAnalyticsCookieRequest) (map[string]interface{}, error)

	// UpdateBotAnalyticsCookie https://techdocs.akamai.com/bot-manager/reference/put-bot-analytics-cookie
	UpdateBotAnalyticsCookie(ctx context.Context, params UpdateBotAnalyticsCookieRequest) (map[string]interface{}, error)
}

The BotAnalyticsCookie interface supports retrieving and updating bot analytics cookie settings

type BotAnalyticsCookieValues 

type BotAnalyticsCookieValues interface {
	// GetBotAnalyticsCookieValues https://techdocs.akamai.com/bot-manager/reference/get-akamai-defined-bots
	GetBotAnalyticsCookieValues(ctx context.Context) (map[string]interface{}, error)
}

The BotAnalyticsCookieValues interface supports retrieving bot analytics cookie values for an account

type BotCategoryException 

type BotCategoryException interface {
	// GetBotCategoryException https://techdocs.akamai.com/bot-manager/reference/get-bot-category-exception
	GetBotCategoryException(ctx context.Context, params GetBotCategoryExceptionRequest) (map[string]interface{}, error)

	// UpdateBotCategoryException https://techdocs.akamai.com/bot-manager/reference/put-bot-category-exception
	UpdateBotCategoryException(ctx context.Context, params UpdateBotCategoryExceptionRequest) (map[string]interface{}, error)
}

The BotCategoryException interface supports retrieving bot category exceptions

type BotDetection 

type BotDetection interface {
	// GetBotDetectionList todo: add link
	GetBotDetectionList(ctx context.Context, params GetBotDetectionListRequest) (*GetBotDetectionListResponse, error)
}

The BotDetection interface supports retrieving bot detections

type BotDetectionAction 

type BotDetectionAction interface {
	// GetBotDetectionActionList todo: add link
	GetBotDetectionActionList(ctx context.Context, params GetBotDetectionActionListRequest) (*GetBotDetectionActionListResponse, error)
	// GetBotDetectionAction todo: add link
	GetBotDetectionAction(ctx context.Context, params GetBotDetectionActionRequest) (map[string]interface{}, error)
	// UpdateBotDetectionAction todo: add link
	UpdateBotDetectionAction(ctx context.Context, params UpdateBotDetectionActionRequest) (map[string]interface{}, error)
}

The BotDetectionAction interface supports retrieving and updating the actions for bot detections of a configuration.

type BotEndpointCoverageReport 

type BotEndpointCoverageReport interface {
	// GetBotEndpointCoverageReport https://techdocs.akamai.com/bot-manager/reference/get-bot-endpoint-coverage-report
	GetBotEndpointCoverageReport(ctx context.Context, params GetBotEndpointCoverageReportRequest) (*GetBotEndpointCoverageReportResponse, error)
}

The BotEndpointCoverageReport interface supports retrieving bot endpoint coverage report for an account or a specific configuration

type BotMan 

type BotMan interface {
	AkamaiBotCategory
	AkamaiBotCategoryAction
	AkamaiDefinedBot
	BotAnalyticsCookie
	BotAnalyticsCookieValues
	BotCategoryException
	BotDetection
	BotDetectionAction
	BotEndpointCoverageReport
	BotManagementSetting
	ChallengeAction
	ChallengeInjectionRules
	ChallengeInterceptionRules
	ClientSideSecurity
	ConditionalAction
	ContentProtectionJavaScriptInjectionRule
	ContentProtectionRule
	ContentProtectionRuleSequence
	CustomBotCategory
	CustomBotCategoryAction
	CustomBotCategoryItemSequence
	CustomBotCategorySequence
	CustomClient
	CustomClientSequence
	CustomDefinedBot
	CustomDenyAction
	CustomCode
	JavascriptInjection
	RecategorizedAkamaiDefinedBot
	ResponseAction
	ServeAlternateAction
	TransactionalEndpoint
	TransactionalEndpointProtection
}

BotMan is the botman api interface

func Client 

func Client(sess session.Session, opts ...Option) BotMan

Client returns a new botman Client instance with the specified controller

type BotManagementSetting 

type BotManagementSetting interface {

	// GetBotManagementSetting todo: add link
	GetBotManagementSetting(ctx context.Context, params GetBotManagementSettingRequest) (map[string]interface{}, error)

	// UpdateBotManagementSetting todo: add link
	UpdateBotManagementSetting(ctx context.Context, params UpdateBotManagementSettingRequest) (map[string]interface{}, error)
}

The BotManagementSetting interface supports retrieving and updating bot management settings

type ChallengeAction 

type ChallengeAction interface {
	// GetChallengeActionList https://techdocs.akamai.com/bot-manager/reference/get-challenge-actions
	GetChallengeActionList(ctx context.Context, params GetChallengeActionListRequest) (*GetChallengeActionListResponse, error)

	// GetChallengeAction https://techdocs.akamai.com/bot-manager/reference/get-challenge-action
	GetChallengeAction(ctx context.Context, params GetChallengeActionRequest) (map[string]interface{}, error)

	// CreateChallengeAction https://techdocs.akamai.com/bot-manager/reference/post-challenge-action
	CreateChallengeAction(ctx context.Context, params CreateChallengeActionRequest) (map[string]interface{}, error)

	// UpdateChallengeAction https://techdocs.akamai.com/bot-manager/reference/put-challenge-action
	UpdateChallengeAction(ctx context.Context, params UpdateChallengeActionRequest) (map[string]interface{}, error)

	// RemoveChallengeAction https://techdocs.akamai.com/bot-manager/reference/delete-challenge-action
	RemoveChallengeAction(ctx context.Context, params RemoveChallengeActionRequest) error

	// UpdateGoogleReCaptchaSecretKey https://techdocs.akamai.com/bot-manager/reference/put-google-recaptch-secret-key
	UpdateGoogleReCaptchaSecretKey(ctx context.Context, params UpdateGoogleReCaptchaSecretKeyRequest) error
}

The ChallengeAction interface supports creating, retrieving, modifying and removing challenge action as well as updating google recaptcha secret key for challenge action for a configuration.

type ChallengeInjectionRules 

type ChallengeInjectionRules interface {
	// GetChallengeInjectionRules https://techdocs.akamai.com/bot-manager/reference/get-challenge-injection-rules
	GetChallengeInjectionRules(ctx context.Context, params GetChallengeInjectionRulesRequest) (map[string]interface{}, error)
	// UpdateChallengeInjectionRules https://techdocs.akamai.com/bot-manager/reference/put-challenge-injection-rules
	UpdateChallengeInjectionRules(ctx context.Context, params UpdateChallengeInjectionRulesRequest) (map[string]interface{}, error)
}

The ChallengeInjectionRules interface supports retrieving and updating the challenge injection rules for a configuration

type ChallengeInterceptionRules 

type ChallengeInterceptionRules interface {
	// GetChallengeInterceptionRules https://techdocs.akamai.com/bot-manager/reference/get-challenge-interception-rules
	// Deprecated: this method will be removed in a future release. Use GetChallengeInjectionRules instead.
	GetChallengeInterceptionRules(ctx context.Context, params GetChallengeInterceptionRulesRequest) (map[string]interface{}, error)
	// UpdateChallengeInterceptionRules https://techdocs.akamai.com/bot-manager/reference/put-challenge-interception-rules
	// Deprecated: this method will be removed in a future release. Use UpdateChallengeInjectionRules instead.
	UpdateChallengeInterceptionRules(ctx context.Context, params UpdateChallengeInterceptionRulesRequest) (map[string]interface{}, error)
}

The ChallengeInterceptionRules interface supports retrieving and updating the challenge interception rules for a configuration Deprecated: this interface will be removed in a future release. Use ChallengeInjectionRules instead.

type ClientFunc 

type ClientFunc func(sess session.Session, opts ...Option) BotMan

ClientFunc is a botman client new method, this can be used for mocking

type ClientSideSecurity 

type ClientSideSecurity interface {

	// GetClientSideSecurity https://techdocs.akamai.com/bot-manager/reference/get-client-side-security
	GetClientSideSecurity(ctx context.Context, params GetClientSideSecurityRequest) (map[string]interface{}, error)

	// UpdateClientSideSecurity https://techdocs.akamai.com/bot-manager/reference/put-client-side-security
	UpdateClientSideSecurity(ctx context.Context, params UpdateClientSideSecurityRequest) (map[string]interface{}, error)
}

The ClientSideSecurity interface supports retrieving and updating client side security settings

type ConditionalAction 

type ConditionalAction interface {
	// GetConditionalActionList https://techdocs.akamai.com/bot-manager/reference/get-conditional-actions
	GetConditionalActionList(ctx context.Context, params GetConditionalActionListRequest) (*GetConditionalActionListResponse, error)

	// GetConditionalAction https://techdocs.akamai.com/bot-manager/reference/get-conditional-action
	GetConditionalAction(ctx context.Context, params GetConditionalActionRequest) (map[string]interface{}, error)

	// CreateConditionalAction https://techdocs.akamai.com/bot-manager/reference/post-conditional-action
	CreateConditionalAction(ctx context.Context, params CreateConditionalActionRequest) (map[string]interface{}, error)

	// UpdateConditionalAction https://techdocs.akamai.com/bot-manager/reference/put-conditional-action
	UpdateConditionalAction(ctx context.Context, params UpdateConditionalActionRequest) (map[string]interface{}, error)

	// RemoveConditionalAction https://techdocs.akamai.com/bot-manager/reference/delete-conditional-action
	RemoveConditionalAction(ctx context.Context, params RemoveConditionalActionRequest) error
}

The ConditionalAction interface supports creating, retrieving, modifying and removing conditional action for a configuration.

type ContentProtectionJavaScriptInjectionRule added in v8.3.0 

type ContentProtectionJavaScriptInjectionRule interface {
	// GetContentProtectionJavaScriptInjectionRuleList https://techdocs.akamai.com/content-protector/reference/get-content-protection-javascript-injection-rules
	GetContentProtectionJavaScriptInjectionRuleList(ctx context.Context, params GetContentProtectionJavaScriptInjectionRuleListRequest) (*GetContentProtectionJavaScriptInjectionRuleListResponse, error)

	// GetContentProtectionJavaScriptInjectionRule https://techdocs.akamai.com/content-protector/reference/get-content-protection-javascript-injection-rule
	GetContentProtectionJavaScriptInjectionRule(ctx context.Context, params GetContentProtectionJavaScriptInjectionRuleRequest) (map[string]interface{}, error)

	// CreateContentProtectionJavaScriptInjectionRule https://techdocs.akamai.com/content-protector/reference/post-content-protection-javascript-injection-rule
	CreateContentProtectionJavaScriptInjectionRule(ctx context.Context, params CreateContentProtectionJavaScriptInjectionRuleRequest) (map[string]interface{}, error)

	// UpdateContentProtectionJavaScriptInjectionRule https://techdocs.akamai.com/content-protector/reference/put-content-protection-javascript-injection-rule
	UpdateContentProtectionJavaScriptInjectionRule(ctx context.Context, params UpdateContentProtectionJavaScriptInjectionRuleRequest) (map[string]interface{}, error)

	// RemoveContentProtectionJavaScriptInjectionRule https://techdocs.akamai.com/content-protector/reference/delete-content-protection-javascript-injection-rule
	RemoveContentProtectionJavaScriptInjectionRule(ctx context.Context, params RemoveContentProtectionJavaScriptInjectionRuleRequest) error
}

The ContentProtectionJavaScriptInjectionRule interface supports creating, retrieving, modifying and removing content protection JavaScript injection rule for a policy.

type ContentProtectionRule added in v8.3.0 

type ContentProtectionRule interface {
	// GetContentProtectionRuleList https://techdocs.akamai.com/content-protector/reference/get-content-protection-rules
	GetContentProtectionRuleList(ctx context.Context, params GetContentProtectionRuleListRequest) (*GetContentProtectionRuleListResponse, error)

	// GetContentProtectionRule https://techdocs.akamai.com/content-protector/reference/get-content-protection-rule
	GetContentProtectionRule(ctx context.Context, params GetContentProtectionRuleRequest) (map[string]interface{}, error)

	// CreateContentProtectionRule https://techdocs.akamai.com/content-protector/reference/post-content-protection-rule
	CreateContentProtectionRule(ctx context.Context, params CreateContentProtectionRuleRequest) (map[string]interface{}, error)

	// UpdateContentProtectionRule https://techdocs.akamai.com/content-protector/reference/put-content-protection-rule
	UpdateContentProtectionRule(ctx context.Context, params UpdateContentProtectionRuleRequest) (map[string]interface{}, error)

	// RemoveContentProtectionRule https://techdocs.akamai.com/content-protector/reference/delete-content-protection-rule
	RemoveContentProtectionRule(ctx context.Context, params RemoveContentProtectionRuleRequest) error
}

The ContentProtectionRule interface supports creating, retrieving, modifying and removing content protection rule for a policy.

type ContentProtectionRuleSequence added in v8.3.0 

type ContentProtectionRuleSequence interface {
	// GetContentProtectionRuleSequence https://techdocs.akamai.com/content-protector/reference/get-content-protection-rule-sequence
	GetContentProtectionRuleSequence(ctx context.Context, params GetContentProtectionRuleSequenceRequest) (*GetContentProtectionRuleSequenceResponse, error)

	// UpdateContentProtectionRuleSequence https://techdocs.akamai.com/content-protector/reference/put-content-protection-rule-sequence
	UpdateContentProtectionRuleSequence(ctx context.Context, params UpdateContentProtectionRuleSequenceRequest) (*UpdateContentProtectionRuleSequenceResponse, error)
}

The ContentProtectionRuleSequence interface supports retrieving and updating content protection rule sequence

type ContentProtectionRuleUUIDSequence added in v8.3.0 

type ContentProtectionRuleUUIDSequence struct {
	ContentProtectionRuleSequence []string `json:"contentProtectionRuleSequence"`
}

ContentProtectionRuleUUIDSequence is a sequence of UUIDs.

type CreateChallengeActionRequest 

type CreateChallengeActionRequest struct {
	ConfigID    int64
	Version     int64
	JsonPayload json.RawMessage
}

CreateChallengeActionRequest is used to create a new challenge action for a specific configuration.

func (CreateChallengeActionRequest) Validate 

func (v CreateChallengeActionRequest) Validate() error

Validate validates a CreateChallengeActionRequest.

type CreateConditionalActionRequest 

type CreateConditionalActionRequest struct {
	ConfigID    int64
	Version     int64
	JsonPayload json.RawMessage
}

CreateConditionalActionRequest is used to create a new conditional action for a specific configuration.

func (CreateConditionalActionRequest) Validate 

func (v CreateConditionalActionRequest) Validate() error

Validate validates a CreateConditionalActionRequest.

type CreateContentProtectionJavaScriptInjectionRuleRequest added in v8.3.0 

type CreateContentProtectionJavaScriptInjectionRuleRequest struct {
	ConfigID         int64
	Version          int64
	SecurityPolicyID string
	JsonPayload      json.RawMessage
}

CreateContentProtectionJavaScriptInjectionRuleRequest is used to create a new content protection JavaScript injection rule for a specific policy.

func (CreateContentProtectionJavaScriptInjectionRuleRequest) Validate added in v8.3.0 

func (v CreateContentProtectionJavaScriptInjectionRuleRequest) Validate() error

Validate validates a CreateContentProtectionJavaScriptInjectionRuleRequest.

type CreateContentProtectionRuleRequest added in v8.3.0 

type CreateContentProtectionRuleRequest struct {
	ConfigID         int64
	Version          int64
	SecurityPolicyID string
	JsonPayload      json.RawMessage
}

CreateContentProtectionRuleRequest is used to create a new content protection rule for a specific policy.

func (CreateContentProtectionRuleRequest) Validate added in v8.3.0 

func (v CreateContentProtectionRuleRequest) Validate() error

Validate validates a CreateContentProtectionRuleRequest.

type CreateCustomBotCategoryRequest 

type CreateCustomBotCategoryRequest struct {
	ConfigID    int64
	Version     int64
	JsonPayload json.RawMessage
}

CreateCustomBotCategoryRequest is used to create a new custom bot category for a specific configuration.

func (CreateCustomBotCategoryRequest) Validate 

func (v CreateCustomBotCategoryRequest) Validate() error

Validate validates a CreateCustomBotCategoryRequest.

type CreateCustomClientRequest 

type CreateCustomClientRequest struct {
	ConfigID    int64
	Version     int64
	JsonPayload json.RawMessage
}

CreateCustomClientRequest is used to create a new custom client for a specific configuration.

func (CreateCustomClientRequest) Validate 

func (v CreateCustomClientRequest) Validate() error

Validate validates a CreateCustomClientRequest.

type CreateCustomDefinedBotRequest 

type CreateCustomDefinedBotRequest struct {
	ConfigID    int64
	Version     int64
	JsonPayload json.RawMessage
}

CreateCustomDefinedBotRequest is used to create a new custom defined bot for a specific configuration.

func (CreateCustomDefinedBotRequest) Validate 

func (v CreateCustomDefinedBotRequest) Validate() error

Validate validates a CreateCustomDefinedBotRequest.

type CreateCustomDenyActionRequest 

type CreateCustomDenyActionRequest struct {
	ConfigID    int64
	Version     int64
	JsonPayload json.RawMessage
}

CreateCustomDenyActionRequest is used to create a new custom deny action for a specific configuration.

func (CreateCustomDenyActionRequest) Validate 

func (v CreateCustomDenyActionRequest) Validate() error

Validate validates a CreateCustomDenyActionRequest.

type CreateRecategorizedAkamaiDefinedBotRequest 

type CreateRecategorizedAkamaiDefinedBotRequest struct {
	ConfigID   int64  `json:"-"`
	Version    int64  `json:"-"`
	BotID      string `json:"botId"`
	CategoryID string `json:"customBotCategoryId"`
}

CreateRecategorizedAkamaiDefinedBotRequest is used to create a new recategorized akamai defined bot for a specific configuration.

func (CreateRecategorizedAkamaiDefinedBotRequest) Validate 

func (v CreateRecategorizedAkamaiDefinedBotRequest) Validate() error

Validate validates a CreateRecategorizedAkamaiDefinedBotRequest.

type CreateServeAlternateActionRequest 

type CreateServeAlternateActionRequest struct {
	ConfigID    int64
	Version     int64
	JsonPayload json.RawMessage
}

CreateServeAlternateActionRequest is used to create a new serve alternate action for a specific configuration.

func (CreateServeAlternateActionRequest) Validate 

func (v CreateServeAlternateActionRequest) Validate() error

Validate validates a CreateServeAlternateActionRequest.

type CreateTransactionalEndpointRequest 

type CreateTransactionalEndpointRequest struct {
	ConfigID         int64
	Version          int64
	SecurityPolicyID string
	JsonPayload      json.RawMessage
}

CreateTransactionalEndpointRequest is used to create a new transactional endpoint for a specific configuration.

func (CreateTransactionalEndpointRequest) Validate 

func (v CreateTransactionalEndpointRequest) Validate() error

Validate validates a CreateTransactionalEndpointRequest.

type CustomBotCategory 

type CustomBotCategory interface {
	// GetCustomBotCategoryList https://techdocs.akamai.com/bot-manager/reference/get-custom-bot-categories
	GetCustomBotCategoryList(ctx context.Context, params GetCustomBotCategoryListRequest) (*GetCustomBotCategoryListResponse, error)

	// GetCustomBotCategory https://techdocs.akamai.com/bot-manager/reference/get-custom-bot-category
	GetCustomBotCategory(ctx context.Context, params GetCustomBotCategoryRequest) (map[string]interface{}, error)

	// CreateCustomBotCategory https://techdocs.akamai.com/bot-manager/reference/post-custom-bot-category
	CreateCustomBotCategory(ctx context.Context, params CreateCustomBotCategoryRequest) (map[string]interface{}, error)

	// UpdateCustomBotCategory https://techdocs.akamai.com/bot-manager/reference/put-custom-bot-category
	UpdateCustomBotCategory(ctx context.Context, params UpdateCustomBotCategoryRequest) (map[string]interface{}, error)

	// RemoveCustomBotCategory https://techdocs.akamai.com/bot-manager/reference/delete-custom-bot-category
	RemoveCustomBotCategory(ctx context.Context, params RemoveCustomBotCategoryRequest) error
}

The CustomBotCategory interface supports creating, retrieving, modifying and removing custom bot categories for a configuration.

type CustomBotCategoryAction 

type CustomBotCategoryAction interface {
	// GetCustomBotCategoryActionList https://techdocs.akamai.com/bot-manager/reference/get-custom-bot-category-actions
	GetCustomBotCategoryActionList(ctx context.Context, params GetCustomBotCategoryActionListRequest) (*GetCustomBotCategoryActionListResponse, error)

	// GetCustomBotCategoryAction https://techdocs.akamai.com/bot-manager/reference/get-custom-bot-category-action
	GetCustomBotCategoryAction(ctx context.Context, params GetCustomBotCategoryActionRequest) (map[string]interface{}, error)

	// UpdateCustomBotCategoryAction https://techdocs.akamai.com/bot-manager/reference/put-custom-bot-category-action
	UpdateCustomBotCategoryAction(ctx context.Context, params UpdateCustomBotCategoryActionRequest) (map[string]interface{}, error)
}

The CustomBotCategoryAction interface supports retrieving and updating the actions for the custom bot categories of a configuration

type CustomBotCategoryItemSequence added in v8.2.0 

type CustomBotCategoryItemSequence interface {
	// GetCustomBotCategoryItemSequence https://techdocs.akamai.com/bot-manager/reference/get-custom-bot-category-item-sequence
	GetCustomBotCategoryItemSequence(ctx context.Context, params GetCustomBotCategoryItemSequenceRequest) (*GetCustomBotCategoryItemSequenceResponse, error)
	// UpdateCustomBotCategoryItemSequence https://techdocs.akamai.com/bot-manager/reference/put-custom-bot-category-item-sequence
	UpdateCustomBotCategoryItemSequence(ctx context.Context, params UpdateCustomBotCategoryItemSequenceRequest) (*UpdateCustomBotCategoryItemSequenceResponse, error)
}

The CustomBotCategoryItemSequence interface supports retrieving and updating custom bot category item sequence

type CustomBotCategorySequence 

type CustomBotCategorySequence interface {
	// GetCustomBotCategorySequence https://techdocs.akamai.com/bot-manager/reference/get-custom-bot-category-sequence
	GetCustomBotCategorySequence(ctx context.Context, params GetCustomBotCategorySequenceRequest) (*CustomBotCategorySequenceResponse, error)

	// UpdateCustomBotCategorySequence https://techdocs.akamai.com/bot-manager/reference/put-custom-bot-category-sequence
	UpdateCustomBotCategorySequence(ctx context.Context, params UpdateCustomBotCategorySequenceRequest) (*CustomBotCategorySequenceResponse, error)
}

The CustomBotCategorySequence interface supports retrieving and updating custom bot category sequence

type CustomBotCategorySequenceResponse 

type CustomBotCategorySequenceResponse struct {
	Sequence []string `json:"sequence"`
}

CustomBotCategorySequenceResponse is used to retrieve custom bot category sequence

type CustomClient 

type CustomClient interface {
	// GetCustomClientList https://techdocs.akamai.com/bot-manager/reference/get-custom-clients
	GetCustomClientList(ctx context.Context, params GetCustomClientListRequest) (*GetCustomClientListResponse, error)

	// GetCustomClient https://techdocs.akamai.com/bot-manager/reference/get-custom-client
	GetCustomClient(ctx context.Context, params GetCustomClientRequest) (map[string]interface{}, error)

	// CreateCustomClient https://techdocs.akamai.com/bot-manager/reference/post-custom-clients
	CreateCustomClient(ctx context.Context, params CreateCustomClientRequest) (map[string]interface{}, error)

	// UpdateCustomClient https://techdocs.akamai.com/bot-manager/reference/put-custom-clients
	UpdateCustomClient(ctx context.Context, params UpdateCustomClientRequest) (map[string]interface{}, error)

	// RemoveCustomClient https://techdocs.akamai.com/bot-manager/reference/delete-custom-clients
	RemoveCustomClient(ctx context.Context, params RemoveCustomClientRequest) error
}

The CustomClient interface supports creating, retrieving, modifying and removing custom clients for a configuration.

type CustomClientSequence 

type CustomClientSequence interface {
	// GetCustomClientSequence is used to retrieve the custom client sequence for a config version
	// See https://techdocs.akamai.com/bot-manager/reference/get-custom-client-sequence
	GetCustomClientSequence(ctx context.Context, params GetCustomClientSequenceRequest) (*CustomClientSequenceResponse, error)

	// UpdateCustomClientSequence is used to update the existing custom client sequence for a config version
	// See https://techdocs.akamai.com/bot-manager/reference/put-custom-client-sequence
	UpdateCustomClientSequence(ctx context.Context, params UpdateCustomClientSequenceRequest) (*CustomClientSequenceResponse, error)
}

The CustomClientSequence interface supports retrieving and updating the custom client sequence for a configuration

type CustomClientSequenceResponse 

type CustomClientSequenceResponse struct {
	Sequence   []string           `json:"sequence"`
	Validation ValidationResponse `json:"validation"`
}

CustomClientSequenceResponse is used to represent custom client sequence

type CustomCode 

type CustomCode interface {
	GetCustomCode(ctx context.Context, params GetCustomCodeRequest) (map[string]interface{}, error)

	UpdateCustomCode(ctx context.Context, params UpdateCustomCodeRequest) (map[string]interface{}, error)
}

The CustomCode interface supports retrieving and updating custom code

type CustomDefinedBot 

type CustomDefinedBot interface {
	// GetCustomDefinedBotList https://techdocs.akamai.com/bot-manager/reference/get-custom-defined-bots
	GetCustomDefinedBotList(ctx context.Context, params GetCustomDefinedBotListRequest) (*GetCustomDefinedBotListResponse, error)

	// GetCustomDefinedBot https://techdocs.akamai.com/bot-manager/reference/get-custom-defined-bot
	GetCustomDefinedBot(ctx context.Context, params GetCustomDefinedBotRequest) (map[string]interface{}, error)

	// CreateCustomDefinedBot https://techdocs.akamai.com/bot-manager/reference/post-custom-defined-bot
	CreateCustomDefinedBot(ctx context.Context, params CreateCustomDefinedBotRequest) (map[string]interface{}, error)

	// UpdateCustomDefinedBot https://techdocs.akamai.com/bot-manager/reference/put-custom-defined-bot
	UpdateCustomDefinedBot(ctx context.Context, params UpdateCustomDefinedBotRequest) (map[string]interface{}, error)

	// RemoveCustomDefinedBot https://techdocs.akamai.com/bot-manager/reference/delete-custom-defined-bot
	RemoveCustomDefinedBot(ctx context.Context, params RemoveCustomDefinedBotRequest) error
}

The CustomDefinedBot interface supports creating, retrieving, modifying and removing custom defined bots for a configuration.

type CustomDenyAction 

type CustomDenyAction interface {
	// GetCustomDenyActionList https://techdocs.akamai.com/bot-manager/reference/get-custom-deny-actions
	GetCustomDenyActionList(ctx context.Context, params GetCustomDenyActionListRequest) (*GetCustomDenyActionListResponse, error)

	// GetCustomDenyAction https://techdocs.akamai.com/bot-manager/reference/get-custom-deny-action
	GetCustomDenyAction(ctx context.Context, params GetCustomDenyActionRequest) (map[string]interface{}, error)

	// CreateCustomDenyAction https://techdocs.akamai.com/bot-manager/reference/post-custom-deny-action
	CreateCustomDenyAction(ctx context.Context, params CreateCustomDenyActionRequest) (map[string]interface{}, error)

	// UpdateCustomDenyAction https://techdocs.akamai.com/bot-manager/reference/put-custom-deny-action
	UpdateCustomDenyAction(ctx context.Context, params UpdateCustomDenyActionRequest) (map[string]interface{}, error)

	// RemoveCustomDenyAction https://techdocs.akamai.com/bot-manager/reference/delete-custom-deny-action
	RemoveCustomDenyAction(ctx context.Context, params RemoveCustomDenyActionRequest) error
}

The CustomDenyAction interface supports creating, retrieving, modifying and removing custom deny action for a configuration.

type Error 

type Error struct {
	Type       string  `json:"type"`
	Title      string  `json:"title"`
	Detail     string  `json:"detail"`
	Errors     []Error `json:"errors,omitempty"`
	StatusCode int     `json:"status,omitempty"`
}

Error is a botman error interface.

func (*Error) Error 

func (e *Error) Error() string

Error returns a string formatted using a given title, type, and detail information.

func (*Error) Is 

func (e *Error) Is(target error) bool

Is handles error comparisons.

type GetAkamaiBotCategoryActionListRequest 

type GetAkamaiBotCategoryActionListRequest struct {
	ConfigID         int64
	Version          int64
	SecurityPolicyID string
	CategoryID       string
}

GetAkamaiBotCategoryActionListRequest is used to retrieve the akamai bot category actions for a policy.

func (GetAkamaiBotCategoryActionListRequest) Validate 

func (v GetAkamaiBotCategoryActionListRequest) Validate() error

Validate validates a GetAkamaiBotCategoryActionListRequest.

type GetAkamaiBotCategoryActionListResponse 

type GetAkamaiBotCategoryActionListResponse struct {
	Actions []map[string]interface{} `json:"actions"`
}

GetAkamaiBotCategoryActionListResponse is returned from a call to GetAkamaiBotCategoryActionList.

type GetAkamaiBotCategoryActionRequest 

type GetAkamaiBotCategoryActionRequest struct {
	ConfigID         int64
	Version          int64
	SecurityPolicyID string
	CategoryID       string
}

GetAkamaiBotCategoryActionRequest is used to retrieve the action for an akamai bot category.

func (GetAkamaiBotCategoryActionRequest) Validate 

func (v GetAkamaiBotCategoryActionRequest) Validate() error

Validate validates a GetAkamaiBotCategoryActionRequest.

type GetAkamaiBotCategoryListRequest 

type GetAkamaiBotCategoryListRequest struct {
	CategoryName string
}

GetAkamaiBotCategoryListRequest is used to retrieve the akamai bot category actions for a policy.

type GetAkamaiBotCategoryListResponse 

type GetAkamaiBotCategoryListResponse struct {
	Categories []map[string]interface{} `json:"categories"`
}

GetAkamaiBotCategoryListResponse is returned from a call to GetAkamaiBotCategoryList.

type GetAkamaiDefinedBotListRequest 

type GetAkamaiDefinedBotListRequest struct {
	BotName string
}

GetAkamaiDefinedBotListRequest is used to retrieve the akamai bot category actions for a policy.

type GetAkamaiDefinedBotListResponse 

type GetAkamaiDefinedBotListResponse struct {
	Bots []map[string]interface{} `json:"bots"`
}

GetAkamaiDefinedBotListResponse is returned from a call to GetAkamaiDefinedBotList.

type GetBotAnalyticsCookieRequest 

type GetBotAnalyticsCookieRequest struct {
	ConfigID int64
	Version  int64
}

GetBotAnalyticsCookieRequest is used to retrieve the bot analytics cookie settings

func (GetBotAnalyticsCookieRequest) Validate 

func (v GetBotAnalyticsCookieRequest) Validate() error

Validate validates a GetBotAnalyticsCookieRequest.

type GetBotCategoryExceptionRequest 

type GetBotCategoryExceptionRequest struct {
	ConfigID         int64
	Version          int64
	SecurityPolicyID string
}

GetBotCategoryExceptionRequest is used to retrieve bot category exceptions

func (GetBotCategoryExceptionRequest) Validate 

func (v GetBotCategoryExceptionRequest) Validate() error

Validate validates a GetBotCategoryExceptionRequest.

type GetBotDetectionActionListRequest 

type GetBotDetectionActionListRequest struct {
	ConfigID         int64
	Version          int64
	SecurityPolicyID string
	DetectionID      string
}

GetBotDetectionActionListRequest is used to retrieve the bot detection actions for a configuration.

func (GetBotDetectionActionListRequest) Validate 

func (v GetBotDetectionActionListRequest) Validate() error

Validate validates a GetBotDetectionActionListRequest.

type GetBotDetectionActionListResponse 

type GetBotDetectionActionListResponse struct {
	Actions []map[string]interface{} `json:"actions"`
}

GetBotDetectionActionListResponse is used to retrieve the bot detection actions for a configuration.

type GetBotDetectionActionRequest 

type GetBotDetectionActionRequest struct {
	ConfigID         int64
	Version          int64
	SecurityPolicyID string
	DetectionID      string
}

GetBotDetectionActionRequest is used to retrieve the action for a bot detection.

func (GetBotDetectionActionRequest) Validate 

func (v GetBotDetectionActionRequest) Validate() error

Validate validates a GetBotDetectionActionRequest.

type GetBotDetectionListRequest 

type GetBotDetectionListRequest struct {
	DetectionName string
}

GetBotDetectionListRequest is used to retrieve the akamai bot category actions for a policy.

type GetBotDetectionListResponse 

type GetBotDetectionListResponse struct {
	Detections []map[string]interface{} `json:"detections"`
}

GetBotDetectionListResponse is returned from a call to GetBotDetectionList.

type GetBotEndpointCoverageReportRequest 

type GetBotEndpointCoverageReportRequest struct {
	ConfigID    int64
	Version     int64
	OperationID string
}

GetBotEndpointCoverageReportRequest is used to retrieve the akamai bot category actions for a policy.

func (GetBotEndpointCoverageReportRequest) Validate 

func (v GetBotEndpointCoverageReportRequest) Validate() error

Validate validates GetBotEndpointCoverageReportRequest

type GetBotEndpointCoverageReportResponse 

type GetBotEndpointCoverageReportResponse struct {
	Operations []map[string]interface{} `json:"operations"`
}

GetBotEndpointCoverageReportResponse is returned from a call to GetBotEndpointCoverageReport.

type GetBotManagementSettingRequest 

type GetBotManagementSettingRequest struct {
	ConfigID         int64
	Version          int64
	SecurityPolicyID string
}

GetBotManagementSettingRequest is used to retrieve the bot management settings

func (GetBotManagementSettingRequest) Validate 

func (v GetBotManagementSettingRequest) Validate() error

Validate validates a GetBotManagementSettingRequest.

type GetChallengeActionListRequest 

type GetChallengeActionListRequest struct {
	ConfigID int64
	Version  int64
	ActionID string
}

GetChallengeActionListRequest is used to retrieve challenge actions for a configuration.

func (GetChallengeActionListRequest) Validate 

func (v GetChallengeActionListRequest) Validate() error

Validate validates a GetChallengeActionListRequest.

type GetChallengeActionListResponse 

type GetChallengeActionListResponse struct {
	ChallengeActions []map[string]interface{} `json:"challengeActions"`
}

GetChallengeActionListResponse is used to retrieve challenge actions for a configuration.

type GetChallengeActionRequest 

type GetChallengeActionRequest struct {
	ConfigID int64
	Version  int64
	ActionID string
}

GetChallengeActionRequest is used to retrieve a specific challenge action

func (GetChallengeActionRequest) Validate 

func (v GetChallengeActionRequest) Validate() error

Validate validates a GetChallengeActionRequest.

type GetChallengeInjectionRulesRequest 

type GetChallengeInjectionRulesRequest struct {
	ConfigID int64
	Version  int64
}

GetChallengeInjectionRulesRequest is used to retrieve challenge injection rules

func (GetChallengeInjectionRulesRequest) Validate 

func (v GetChallengeInjectionRulesRequest) Validate() error

Validate validates a GetChallengeInjectionRulesRequest.

type GetChallengeInterceptionRulesRequest 

type GetChallengeInterceptionRulesRequest struct {
	ConfigID int64
	Version  int64
}

GetChallengeInterceptionRulesRequest is used to retrieve challenge interception rules Deprecated: this struct will be removed in a future release. Use GetChallengeInjectionRulesRequest instead.

func (GetChallengeInterceptionRulesRequest) Validate 

func (v GetChallengeInterceptionRulesRequest) Validate() error

Validate validates a GetChallengeInterceptionRulesRequest.

type GetClientSideSecurityRequest 

type GetClientSideSecurityRequest struct {
	ConfigID int64 `json:"configId"`
	Version  int64 `json:"version"`
}

GetClientSideSecurityRequest is used to retrieve client side security settings

func (GetClientSideSecurityRequest) Validate 

func (v GetClientSideSecurityRequest) Validate() error

Validate validates a GetClientSideSecurityRequest.

type GetConditionalActionListRequest 

type GetConditionalActionListRequest struct {
	ConfigID int64
	Version  int64
	ActionID string
}

GetConditionalActionListRequest is used to retrieve conditional actions for a configuration.

func (GetConditionalActionListRequest) Validate 

func (v GetConditionalActionListRequest) Validate() error

Validate validates a GetConditionalActionListRequest.

type GetConditionalActionListResponse 

type GetConditionalActionListResponse struct {
	ConditionalActions []map[string]interface{} `json:"conditionalActions"`
}

GetConditionalActionListResponse is used to retrieve conditional actions for a configuration.

type GetConditionalActionRequest 

type GetConditionalActionRequest struct {
	ConfigID int64
	Version  int64
	ActionID string
}

GetConditionalActionRequest is used to retrieve a specific conditional action

func (GetConditionalActionRequest) Validate 

func (v GetConditionalActionRequest) Validate() error

Validate validates a GetConditionalActionRequest.

type GetContentProtectionJavaScriptInjectionRuleListRequest added in v8.3.0 

type GetContentProtectionJavaScriptInjectionRuleListRequest struct {
	ConfigID                                   int64
	Version                                    int64
	SecurityPolicyID                           string
	ContentProtectionJavaScriptInjectionRuleID string
}

GetContentProtectionJavaScriptInjectionRuleListRequest is used to retrieve the content protection JavaScript injection rules for a policy.

func (GetContentProtectionJavaScriptInjectionRuleListRequest) Validate added in v8.3.0 

func (v GetContentProtectionJavaScriptInjectionRuleListRequest) Validate() error

Validate validates a GetContentProtectionJavaScriptInjectionRuleListRequest.

type GetContentProtectionJavaScriptInjectionRuleListResponse added in v8.3.0 

type GetContentProtectionJavaScriptInjectionRuleListResponse struct {
	ContentProtectionJavaScriptInjectionRules []map[string]interface{} `json:"contentProtectionJavaScriptInjectionRules"`
}

GetContentProtectionJavaScriptInjectionRuleListResponse is used to retrieve the content protection JavaScript injection rules for a policy.

type GetContentProtectionJavaScriptInjectionRuleRequest added in v8.3.0 

type GetContentProtectionJavaScriptInjectionRuleRequest struct {
	ConfigID                                   int64
	Version                                    int64
	SecurityPolicyID                           string
	ContentProtectionJavaScriptInjectionRuleID string
}

GetContentProtectionJavaScriptInjectionRuleRequest is used to retrieve a specific content protection JavaScript injection rule.

func (GetContentProtectionJavaScriptInjectionRuleRequest) Validate added in v8.3.0 

func (v GetContentProtectionJavaScriptInjectionRuleRequest) Validate() error

Validate validates a GetContentProtectionJavaScriptInjectionRuleRequest.

type GetContentProtectionRuleListRequest added in v8.3.0 

type GetContentProtectionRuleListRequest struct {
	ConfigID                int64
	Version                 int64
	SecurityPolicyID        string
	ContentProtectionRuleID string
}

GetContentProtectionRuleListRequest is used to retrieve the content protection rules for a policy.

func (GetContentProtectionRuleListRequest) Validate added in v8.3.0 

func (v GetContentProtectionRuleListRequest) Validate() error

Validate validates a GetContentProtectionRuleListRequest.

type GetContentProtectionRuleListResponse added in v8.3.0 

type GetContentProtectionRuleListResponse struct {
	ContentProtectionRules []map[string]interface{} `json:"contentProtectionRules"`
}

GetContentProtectionRuleListResponse is used to retrieve the content protection rules for a policy.

type GetContentProtectionRuleRequest added in v8.3.0 

type GetContentProtectionRuleRequest struct {
	ConfigID                int64
	Version                 int64
	SecurityPolicyID        string
	ContentProtectionRuleID string
}

GetContentProtectionRuleRequest is used to retrieve a specific content protection rule.

func (GetContentProtectionRuleRequest) Validate added in v8.3.0 

func (v GetContentProtectionRuleRequest) Validate() error

Validate validates a GetContentProtectionRuleRequest.

type GetContentProtectionRuleSequenceRequest added in v8.3.0 

type GetContentProtectionRuleSequenceRequest struct {
	ConfigID         int64
	Version          int64
	SecurityPolicyID string
}

GetContentProtectionRuleSequenceRequest is used to retrieve content protection rule sequence

func (GetContentProtectionRuleSequenceRequest) Validate added in v8.3.0 

func (v GetContentProtectionRuleSequenceRequest) Validate() error

Validate validates a GetContentProtectionRuleSequenceRequest.

type GetContentProtectionRuleSequenceResponse added in v8.3.0 

type GetContentProtectionRuleSequenceResponse ContentProtectionRuleUUIDSequence

GetContentProtectionRuleSequenceResponse contains the sequence of content protection rule

type GetCustomBotCategoryActionListRequest 

type GetCustomBotCategoryActionListRequest struct {
	ConfigID         int64
	Version          int64
	SecurityPolicyID string
	CategoryID       string
}

GetCustomBotCategoryActionListRequest is used to retrieve the custom bot category actions for a policy.

func (GetCustomBotCategoryActionListRequest) Validate 

func (v GetCustomBotCategoryActionListRequest) Validate() error

Validate validates a GetCustomBotCategoryActionListRequest.

type GetCustomBotCategoryActionListResponse 

type GetCustomBotCategoryActionListResponse struct {
	Actions []map[string]interface{} `json:"actions"`
}

GetCustomBotCategoryActionListResponse is returned from a call to GetCustomBotCategoryActionList.

type GetCustomBotCategoryActionRequest 

type GetCustomBotCategoryActionRequest struct {
	ConfigID         int64
	Version          int64
	SecurityPolicyID string
	CategoryID       string
}

GetCustomBotCategoryActionRequest is used to retrieve the action for a custom bot category

func (GetCustomBotCategoryActionRequest) Validate 

func (v GetCustomBotCategoryActionRequest) Validate() error

Validate validates a GetCustomBotCategoryActionRequest.

type GetCustomBotCategoryItemSequenceRequest added in v8.2.0 

type GetCustomBotCategoryItemSequenceRequest struct {
	ConfigID   int64
	Version    int64
	CategoryID string
}

GetCustomBotCategoryItemSequenceRequest is used to retrieve custom bot category sequence

func (GetCustomBotCategoryItemSequenceRequest) Validate added in v8.2.0 

func (v GetCustomBotCategoryItemSequenceRequest) Validate() error

Validate validates a GetCustomBotCategoryItemSequenceRequest.

type GetCustomBotCategoryItemSequenceResponse added in v8.2.0 

type GetCustomBotCategoryItemSequenceResponse UUIDSequence

GetCustomBotCategoryItemSequenceResponse contains the sequence of botIds

type GetCustomBotCategoryListRequest 

type GetCustomBotCategoryListRequest struct {
	ConfigID   int64
	Version    int64
	CategoryID string
}

GetCustomBotCategoryListRequest is used to retrieve custom bot categories for a configuration.

func (GetCustomBotCategoryListRequest) Validate 

func (v GetCustomBotCategoryListRequest) Validate() error

Validate validates a GetCustomBotCategoryListRequest.

type GetCustomBotCategoryListResponse 

type GetCustomBotCategoryListResponse struct {
	Categories []map[string]interface{} `json:"categories"`
}

GetCustomBotCategoryListResponse is used to retrieve custom bot categories for a configuration.

type GetCustomBotCategoryRequest 

type GetCustomBotCategoryRequest struct {
	ConfigID   int64
	Version    int64
	CategoryID string
}

GetCustomBotCategoryRequest is used to retrieve a specific custom bot category

func (GetCustomBotCategoryRequest) Validate 

func (v GetCustomBotCategoryRequest) Validate() error

Validate validates a GetCustomBotCategoryRequest.

type GetCustomBotCategorySequenceRequest 

type GetCustomBotCategorySequenceRequest struct {
	ConfigID int64
	Version  int64
}

GetCustomBotCategorySequenceRequest is used to retrieve custom bot category sequence

func (GetCustomBotCategorySequenceRequest) Validate 

func (v GetCustomBotCategorySequenceRequest) Validate() error

Validate validates a GetCustomBotCategorySequenceRequest.

type GetCustomClientListRequest 

type GetCustomClientListRequest struct {
	ConfigID       int64
	Version        int64
	CustomClientID string
}

GetCustomClientListRequest is used to retrieve the custom clients for a configuration.

func (GetCustomClientListRequest) Validate 

func (v GetCustomClientListRequest) Validate() error

Validate validates a GetCustomClientsRequest.

type GetCustomClientListResponse 

type GetCustomClientListResponse struct {
	CustomClients []map[string]interface{} `json:"customClients"`
}

GetCustomClientListResponse is used to retrieve the custom clients for a configuration.

type GetCustomClientRequest 

type GetCustomClientRequest struct {
	ConfigID       int64
	Version        int64
	CustomClientID string
}

GetCustomClientRequest is used to retrieve a specific custom client.

func (GetCustomClientRequest) Validate 

func (v GetCustomClientRequest) Validate() error

Validate validates a GetCustomClientRequest.

type GetCustomClientSequenceRequest 

type GetCustomClientSequenceRequest struct {
	ConfigID int64
	Version  int64
}

GetCustomClientSequenceRequest is used to retrieve custom client sequence

func (GetCustomClientSequenceRequest) Validate 

func (v GetCustomClientSequenceRequest) Validate() error

Validate validates a GetCustomClientSequenceRequest.

type GetCustomCodeRequest 

type GetCustomCodeRequest struct {
	ConfigID int64
	Version  int64
}

GetCustomCodeRequest is used to retrieve custom code

func (GetCustomCodeRequest) Validate 

func (v GetCustomCodeRequest) Validate() error

Validate validates a GetCustomCodeRequest.

type GetCustomDefinedBotListRequest 

type GetCustomDefinedBotListRequest struct {
	ConfigID int64
	Version  int64
	BotID    string
}

GetCustomDefinedBotListRequest is used to retrieve the custom defined bots for a configuration.

func (GetCustomDefinedBotListRequest) Validate 

func (v GetCustomDefinedBotListRequest) Validate() error

Validate validates a GetCustomDefinedBotsRequest.

type GetCustomDefinedBotListResponse 

type GetCustomDefinedBotListResponse struct {
	Bots []map[string]interface{} `json:"bots"`
}

GetCustomDefinedBotListResponse is used to retrieve the custom defined bots for a configuration.

type GetCustomDefinedBotRequest 

type GetCustomDefinedBotRequest struct {
	ConfigID int64
	Version  int64
	BotID    string
}

GetCustomDefinedBotRequest is used to retrieve a specific custom defined bot.

func (GetCustomDefinedBotRequest) Validate 

func (v GetCustomDefinedBotRequest) Validate() error

Validate validates a GetCustomDefinedBotRequest.

type GetCustomDenyActionListRequest 

type GetCustomDenyActionListRequest struct {
	ConfigID int64
	Version  int64
	ActionID string
}

GetCustomDenyActionListRequest is used to retrieve custom deny actions for a configuration.

func (GetCustomDenyActionListRequest) Validate 

func (v GetCustomDenyActionListRequest) Validate() error

Validate validates a GetCustomDenyActionListRequest.

type GetCustomDenyActionListResponse 

type GetCustomDenyActionListResponse struct {
	CustomDenyActions []map[string]interface{} `json:"customDenyActions"`
}

GetCustomDenyActionListResponse is used to retrieve custom deny actions for a configuration.

type GetCustomDenyActionRequest 

type GetCustomDenyActionRequest struct {
	ConfigID int64
	Version  int64
	ActionID string
}

GetCustomDenyActionRequest is used to retrieve a specific custom deny action

func (GetCustomDenyActionRequest) Validate 

func (v GetCustomDenyActionRequest) Validate() error

Validate validates a GetCustomDenyActionRequest.

type GetJavascriptInjectionRequest 

type GetJavascriptInjectionRequest struct {
	ConfigID         int64
	Version          int64
	SecurityPolicyID string
}

GetJavascriptInjectionRequest is used to retrieve javascript injection settings

func (GetJavascriptInjectionRequest) Validate 

func (v GetJavascriptInjectionRequest) Validate() error

Validate validates a GetJavascriptInjectionRequest.

type GetRecategorizedAkamaiDefinedBotListRequest 

type GetRecategorizedAkamaiDefinedBotListRequest struct {
	ConfigID int64
	Version  int64
	BotID    string
}

GetRecategorizedAkamaiDefinedBotListRequest is used to retrieve the recategorized akamai defined bots for a configuration.

func (GetRecategorizedAkamaiDefinedBotListRequest) Validate 

func (v GetRecategorizedAkamaiDefinedBotListRequest) Validate() error

Validate validates a GetRecategorizedAkamaiDefinedBotsRequest.

type GetRecategorizedAkamaiDefinedBotListResponse 

type GetRecategorizedAkamaiDefinedBotListResponse struct {
	Bots []RecategorizedAkamaiDefinedBotResponse `json:"recategorizedBots"`
}

GetRecategorizedAkamaiDefinedBotListResponse is used to retrieve the recategorized akamai defined bots for a configuration.

type GetRecategorizedAkamaiDefinedBotRequest 

type GetRecategorizedAkamaiDefinedBotRequest struct {
	ConfigID int64
	Version  int64
	BotID    string
}

GetRecategorizedAkamaiDefinedBotRequest is used to retrieve a specific recategorized akamai defined bot

func (GetRecategorizedAkamaiDefinedBotRequest) Validate 

func (v GetRecategorizedAkamaiDefinedBotRequest) Validate() error

Validate validates a GetRecategorizedAkamaiDefinedBotRequest.

type GetResponseActionListRequest 

type GetResponseActionListRequest struct {
	ConfigID int64
	Version  int64
	ActionID string
}

GetResponseActionListRequest is used to retrieve the akamai bot category actions for a policy.

func (GetResponseActionListRequest) Validate 

func (v GetResponseActionListRequest) Validate() error

Validate validates a GetAkamaiBotCategoryActionListRequest.

type GetResponseActionListResponse 

type GetResponseActionListResponse struct {
	ResponseActions []map[string]interface{} `json:"responseActions"`
}

GetResponseActionListResponse is returned from a call to GetResponseActionList.

type GetServeAlternateActionListRequest 

type GetServeAlternateActionListRequest struct {
	ConfigID int64
	Version  int64
	ActionID string
}

GetServeAlternateActionListRequest is used to retrieve serve alternate actions for a configuration.

func (GetServeAlternateActionListRequest) Validate 

func (v GetServeAlternateActionListRequest) Validate() error

Validate validates a GetServeAlternateActionListRequest.

type GetServeAlternateActionListResponse 

type GetServeAlternateActionListResponse struct {
	ServeAlternateActions []map[string]interface{} `json:"serveAlternateActions"`
}

GetServeAlternateActionListResponse is used to retrieve serve alternate actions for a configuration.

type GetServeAlternateActionRequest 

type GetServeAlternateActionRequest struct {
	ConfigID int64
	Version  int64
	ActionID string
}

GetServeAlternateActionRequest is used to retrieve a specific serve alternate action

func (GetServeAlternateActionRequest) Validate 

func (v GetServeAlternateActionRequest) Validate() error

Validate validates a GetServeAlternateActionRequest.

type GetTransactionalEndpointListRequest 

type GetTransactionalEndpointListRequest struct {
	ConfigID         int64
	Version          int64
	SecurityPolicyID string
	OperationID      string
}

GetTransactionalEndpointListRequest is used to retrieve the transactional endpoint for a configuration.

func (GetTransactionalEndpointListRequest) Validate 

func (v GetTransactionalEndpointListRequest) Validate() error

Validate validates a GetTransactionalEndpointListRequest.

type GetTransactionalEndpointListResponse 

type GetTransactionalEndpointListResponse struct {
	Operations []map[string]interface{} `json:"operations"`
}

GetTransactionalEndpointListResponse is used to retrieve the transactional endpoints for a configuration.

type GetTransactionalEndpointProtectionRequest 

type GetTransactionalEndpointProtectionRequest struct {
	ConfigID int64
	Version  int64
}

GetTransactionalEndpointProtectionRequest is used to retrieve transactional endpoint protection settings

func (GetTransactionalEndpointProtectionRequest) Validate 

func (v GetTransactionalEndpointProtectionRequest) Validate() error

Validate validates a GetTransactionalEndpointProtectionRequest.

type GetTransactionalEndpointRequest 

type GetTransactionalEndpointRequest struct {
	ConfigID         int64
	Version          int64
	SecurityPolicyID string
	OperationID      string
}

GetTransactionalEndpointRequest is used to retrieve a specific transactional endpoint.

func (GetTransactionalEndpointRequest) Validate 

func (v GetTransactionalEndpointRequest) Validate() error

Validate validates a GetTransactionalEndpointRequest.

type JavascriptInjection 

type JavascriptInjection interface {
	// GetJavascriptInjection https://techdocs.akamai.com/bot-manager/reference/get-javascript-injection
	GetJavascriptInjection(ctx context.Context, params GetJavascriptInjectionRequest) (map[string]interface{}, error)
	// UpdateJavascriptInjection https://techdocs.akamai.com/bot-manager/reference/put-javascript-injection
	UpdateJavascriptInjection(ctx context.Context, params UpdateJavascriptInjectionRequest) (map[string]interface{}, error)
}

The JavascriptInjection interface supports retrieving and updating the javascript injection settings for a configuration

type Mock 

type Mock struct {
	mock.Mock
}

func (*Mock) CreateChallengeAction 

func (p *Mock) CreateChallengeAction(ctx context.Context, params CreateChallengeActionRequest) (map[string]interface{}, error)

func (*Mock) CreateConditionalAction 

func (p *Mock) CreateConditionalAction(ctx context.Context, params CreateConditionalActionRequest) (map[string]interface{}, error)

func (*Mock) CreateContentProtectionJavaScriptInjectionRule added in v8.3.0 

func (p *Mock) CreateContentProtectionJavaScriptInjectionRule(ctx context.Context, params CreateContentProtectionJavaScriptInjectionRuleRequest) (map[string]interface{}, error)

func (*Mock) CreateContentProtectionRule added in v8.3.0 

func (p *Mock) CreateContentProtectionRule(ctx context.Context, params CreateContentProtectionRuleRequest) (map[string]interface{}, error)

func (*Mock) CreateCustomBotCategory 

func (p *Mock) CreateCustomBotCategory(ctx context.Context, params CreateCustomBotCategoryRequest) (map[string]interface{}, error)

func (*Mock) CreateCustomClient 

func (p *Mock) CreateCustomClient(ctx context.Context, params CreateCustomClientRequest) (map[string]interface{}, error)

func (*Mock) CreateCustomDefinedBot 

func (p *Mock) CreateCustomDefinedBot(ctx context.Context, params CreateCustomDefinedBotRequest) (map[string]interface{}, error)

func (*Mock) CreateCustomDenyAction 

func (p *Mock) CreateCustomDenyAction(ctx context.Context, params CreateCustomDenyActionRequest) (map[string]interface{}, error)

func (*Mock) CreateRecategorizedAkamaiDefinedBot 

func (p *Mock) CreateRecategorizedAkamaiDefinedBot(ctx context.Context, params CreateRecategorizedAkamaiDefinedBotRequest) (*RecategorizedAkamaiDefinedBotResponse, error)

func (*Mock) CreateServeAlternateAction 

func (p *Mock) CreateServeAlternateAction(ctx context.Context, params CreateServeAlternateActionRequest) (map[string]interface{}, error)

func (*Mock) CreateTransactionalEndpoint 

func (p *Mock) CreateTransactionalEndpoint(ctx context.Context, params CreateTransactionalEndpointRequest) (map[string]interface{}, error)

func (*Mock) GetAkamaiBotCategoryAction 

func (p *Mock) GetAkamaiBotCategoryAction(ctx context.Context, params GetAkamaiBotCategoryActionRequest) (map[string]interface{}, error)

func (*Mock) GetAkamaiBotCategoryActionList 

func (p *Mock) GetAkamaiBotCategoryActionList(ctx context.Context, params GetAkamaiBotCategoryActionListRequest) (*GetAkamaiBotCategoryActionListResponse, error)

func (*Mock) GetAkamaiBotCategoryList 

func (p *Mock) GetAkamaiBotCategoryList(ctx context.Context, params GetAkamaiBotCategoryListRequest) (*GetAkamaiBotCategoryListResponse, error)

func (*Mock) GetAkamaiDefinedBotList 

func (p *Mock) GetAkamaiDefinedBotList(ctx context.Context, params GetAkamaiDefinedBotListRequest) (*GetAkamaiDefinedBotListResponse, error)

func (*Mock) GetBotAnalyticsCookie 

func (p *Mock) GetBotAnalyticsCookie(ctx context.Context, params GetBotAnalyticsCookieRequest) (map[string]interface{}, error)

func (*Mock) GetBotAnalyticsCookieValues 

func (p *Mock) GetBotAnalyticsCookieValues(ctx context.Context) (map[string]interface{}, error)

func (*Mock) GetBotCategoryException 

func (p *Mock) GetBotCategoryException(ctx context.Context, params GetBotCategoryExceptionRequest) (map[string]interface{}, error)

func (*Mock) GetBotDetectionAction 

func (p *Mock) GetBotDetectionAction(ctx context.Context, params GetBotDetectionActionRequest) (map[string]interface{}, error)

func (*Mock) GetBotDetectionActionList 

func (p *Mock) GetBotDetectionActionList(ctx context.Context, params GetBotDetectionActionListRequest) (*GetBotDetectionActionListResponse, error)

func (*Mock) GetBotDetectionList 

func (p *Mock) GetBotDetectionList(ctx context.Context, params GetBotDetectionListRequest) (*GetBotDetectionListResponse, error)

func (*Mock) GetBotEndpointCoverageReport 

func (p *Mock) GetBotEndpointCoverageReport(ctx context.Context, params GetBotEndpointCoverageReportRequest) (*GetBotEndpointCoverageReportResponse, error)

func (*Mock) GetBotManagementSetting 

func (p *Mock) GetBotManagementSetting(ctx context.Context, params GetBotManagementSettingRequest) (map[string]interface{}, error)

func (*Mock) GetChallengeAction 

func (p *Mock) GetChallengeAction(ctx context.Context, params GetChallengeActionRequest) (map[string]interface{}, error)

func (*Mock) GetChallengeActionList 

func (p *Mock) GetChallengeActionList(ctx context.Context, params GetChallengeActionListRequest) (*GetChallengeActionListResponse, error)

func (*Mock) GetChallengeInjectionRules 

func (p *Mock) GetChallengeInjectionRules(ctx context.Context, params GetChallengeInjectionRulesRequest) (map[string]interface{}, error)

func (*Mock) GetChallengeInterceptionRules 

func (p *Mock) GetChallengeInterceptionRules(ctx context.Context, params GetChallengeInterceptionRulesRequest) (map[string]interface{}, error)

func (*Mock) GetClientSideSecurity 

func (p *Mock) GetClientSideSecurity(ctx context.Context, params GetClientSideSecurityRequest) (map[string]interface{}, error)

func (*Mock) GetConditionalAction 

func (p *Mock) GetConditionalAction(ctx context.Context, params GetConditionalActionRequest) (map[string]interface{}, error)

func (*Mock) GetConditionalActionList 

func (p *Mock) GetConditionalActionList(ctx context.Context, params GetConditionalActionListRequest) (*GetConditionalActionListResponse, error)

func (*Mock) GetContentProtectionJavaScriptInjectionRule added in v8.3.0 

func (p *Mock) GetContentProtectionJavaScriptInjectionRule(ctx context.Context, params GetContentProtectionJavaScriptInjectionRuleRequest) (map[string]interface{}, error)

func (*Mock) GetContentProtectionJavaScriptInjectionRuleList added in v8.3.0 

func (p *Mock) GetContentProtectionJavaScriptInjectionRuleList(ctx context.Context, params GetContentProtectionJavaScriptInjectionRuleListRequest) (*GetContentProtectionJavaScriptInjectionRuleListResponse, error)

func (*Mock) GetContentProtectionRule added in v8.3.0 

func (p *Mock) GetContentProtectionRule(ctx context.Context, params GetContentProtectionRuleRequest) (map[string]interface{}, error)

func (*Mock) GetContentProtectionRuleList added in v8.3.0 

func (p *Mock) GetContentProtectionRuleList(ctx context.Context, params GetContentProtectionRuleListRequest) (*GetContentProtectionRuleListResponse, error)

func (*Mock) GetContentProtectionRuleSequence added in v8.3.0 

func (p *Mock) GetContentProtectionRuleSequence(ctx context.Context, params GetContentProtectionRuleSequenceRequest) (*GetContentProtectionRuleSequenceResponse, error)

func (*Mock) GetCustomBotCategory 

func (p *Mock) GetCustomBotCategory(ctx context.Context, params GetCustomBotCategoryRequest) (map[string]interface{}, error)

func (*Mock) GetCustomBotCategoryAction 

func (p *Mock) GetCustomBotCategoryAction(ctx context.Context, params GetCustomBotCategoryActionRequest) (map[string]interface{}, error)

func (*Mock) GetCustomBotCategoryActionList 

func (p *Mock) GetCustomBotCategoryActionList(ctx context.Context, params GetCustomBotCategoryActionListRequest) (*GetCustomBotCategoryActionListResponse, error)

func (*Mock) GetCustomBotCategoryItemSequence added in v8.2.0 

func (p *Mock) GetCustomBotCategoryItemSequence(ctx context.Context, params GetCustomBotCategoryItemSequenceRequest) (*GetCustomBotCategoryItemSequenceResponse, error)

func (*Mock) GetCustomBotCategoryList 

func (p *Mock) GetCustomBotCategoryList(ctx context.Context, params GetCustomBotCategoryListRequest) (*GetCustomBotCategoryListResponse, error)

func (*Mock) GetCustomBotCategorySequence 

func (p *Mock) GetCustomBotCategorySequence(ctx context.Context, params GetCustomBotCategorySequenceRequest) (*CustomBotCategorySequenceResponse, error)

func (*Mock) GetCustomClient 

func (p *Mock) GetCustomClient(ctx context.Context, params GetCustomClientRequest) (map[string]interface{}, error)

func (*Mock) GetCustomClientList 

func (p *Mock) GetCustomClientList(ctx context.Context, params GetCustomClientListRequest) (*GetCustomClientListResponse, error)

func (*Mock) GetCustomClientSequence 

func (p *Mock) GetCustomClientSequence(ctx context.Context, params GetCustomClientSequenceRequest) (*CustomClientSequenceResponse, error)

func (*Mock) GetCustomCode 

func (p *Mock) GetCustomCode(ctx context.Context, params GetCustomCodeRequest) (map[string]interface{}, error)

func (*Mock) GetCustomDefinedBot 

func (p *Mock) GetCustomDefinedBot(ctx context.Context, params GetCustomDefinedBotRequest) (map[string]interface{}, error)

func (*Mock) GetCustomDefinedBotList 

func (p *Mock) GetCustomDefinedBotList(ctx context.Context, params GetCustomDefinedBotListRequest) (*GetCustomDefinedBotListResponse, error)

func (*Mock) GetCustomDenyAction 

func (p *Mock) GetCustomDenyAction(ctx context.Context, params GetCustomDenyActionRequest) (map[string]interface{}, error)

func (*Mock) GetCustomDenyActionList 

func (p *Mock) GetCustomDenyActionList(ctx context.Context, params GetCustomDenyActionListRequest) (*GetCustomDenyActionListResponse, error)

func (*Mock) GetJavascriptInjection 

func (p *Mock) GetJavascriptInjection(ctx context.Context, params GetJavascriptInjectionRequest) (map[string]interface{}, error)

func (*Mock) GetRecategorizedAkamaiDefinedBot 

func (p *Mock) GetRecategorizedAkamaiDefinedBot(ctx context.Context, params GetRecategorizedAkamaiDefinedBotRequest) (*RecategorizedAkamaiDefinedBotResponse, error)

func (*Mock) GetRecategorizedAkamaiDefinedBotList 

func (p *Mock) GetRecategorizedAkamaiDefinedBotList(ctx context.Context, params GetRecategorizedAkamaiDefinedBotListRequest) (*GetRecategorizedAkamaiDefinedBotListResponse, error)

func (*Mock) GetResponseActionList 

func (p *Mock) GetResponseActionList(ctx context.Context, params GetResponseActionListRequest) (*GetResponseActionListResponse, error)

func (*Mock) GetServeAlternateAction 

func (p *Mock) GetServeAlternateAction(ctx context.Context, params GetServeAlternateActionRequest) (map[string]interface{}, error)

func (*Mock) GetServeAlternateActionList 

func (p *Mock) GetServeAlternateActionList(ctx context.Context, params GetServeAlternateActionListRequest) (*GetServeAlternateActionListResponse, error)

func (*Mock) GetTransactionalEndpoint 

func (p *Mock) GetTransactionalEndpoint(ctx context.Context, params GetTransactionalEndpointRequest) (map[string]interface{}, error)

func (*Mock) GetTransactionalEndpointList 

func (p *Mock) GetTransactionalEndpointList(ctx context.Context, params GetTransactionalEndpointListRequest) (*GetTransactionalEndpointListResponse, error)

func (*Mock) GetTransactionalEndpointProtection 

func (p *Mock) GetTransactionalEndpointProtection(ctx context.Context, params GetTransactionalEndpointProtectionRequest) (map[string]interface{}, error)

func (*Mock) RemoveChallengeAction 

func (p *Mock) RemoveChallengeAction(ctx context.Context, params RemoveChallengeActionRequest) error

func (*Mock) RemoveConditionalAction 

func (p *Mock) RemoveConditionalAction(ctx context.Context, params RemoveConditionalActionRequest) error

func (*Mock) RemoveContentProtectionJavaScriptInjectionRule added in v8.3.0 

func (p *Mock) RemoveContentProtectionJavaScriptInjectionRule(ctx context.Context, params RemoveContentProtectionJavaScriptInjectionRuleRequest) error

func (*Mock) RemoveContentProtectionRule added in v8.3.0 

func (p *Mock) RemoveContentProtectionRule(ctx context.Context, params RemoveContentProtectionRuleRequest) error

func (*Mock) RemoveCustomBotCategory 

func (p *Mock) RemoveCustomBotCategory(ctx context.Context, params RemoveCustomBotCategoryRequest) error

func (*Mock) RemoveCustomClient 

func (p *Mock) RemoveCustomClient(ctx context.Context, params RemoveCustomClientRequest) error

func (*Mock) RemoveCustomDefinedBot 

func (p *Mock) RemoveCustomDefinedBot(ctx context.Context, params RemoveCustomDefinedBotRequest) error

func (*Mock) RemoveCustomDenyAction 

func (p *Mock) RemoveCustomDenyAction(ctx context.Context, params RemoveCustomDenyActionRequest) error

func (*Mock) RemoveRecategorizedAkamaiDefinedBot 

func (p *Mock) RemoveRecategorizedAkamaiDefinedBot(ctx context.Context, params RemoveRecategorizedAkamaiDefinedBotRequest) error

func (*Mock) RemoveServeAlternateAction 

func (p *Mock) RemoveServeAlternateAction(ctx context.Context, params RemoveServeAlternateActionRequest) error

func (*Mock) RemoveTransactionalEndpoint 

func (p *Mock) RemoveTransactionalEndpoint(ctx context.Context, params RemoveTransactionalEndpointRequest) error

func (*Mock) UpdateAkamaiBotCategoryAction 

func (p *Mock) UpdateAkamaiBotCategoryAction(ctx context.Context, params UpdateAkamaiBotCategoryActionRequest) (map[string]interface{}, error)

func (*Mock) UpdateBotAnalyticsCookie 

func (p *Mock) UpdateBotAnalyticsCookie(ctx context.Context, params UpdateBotAnalyticsCookieRequest) (map[string]interface{}, error)

func (*Mock) UpdateBotCategoryException 

func (p *Mock) UpdateBotCategoryException(ctx context.Context, params UpdateBotCategoryExceptionRequest) (map[string]interface{}, error)

func (*Mock) UpdateBotDetectionAction 

func (p *Mock) UpdateBotDetectionAction(ctx context.Context, params UpdateBotDetectionActionRequest) (map[string]interface{}, error)

func (*Mock) UpdateBotManagementSetting 

func (p *Mock) UpdateBotManagementSetting(ctx context.Context, params UpdateBotManagementSettingRequest) (map[string]interface{}, error)

func (*Mock) UpdateChallengeAction 

func (p *Mock) UpdateChallengeAction(ctx context.Context, params UpdateChallengeActionRequest) (map[string]interface{}, error)

func (*Mock) UpdateChallengeInjectionRules 

func (p *Mock) UpdateChallengeInjectionRules(ctx context.Context, params UpdateChallengeInjectionRulesRequest) (map[string]interface{}, error)

func (*Mock) UpdateChallengeInterceptionRules 

func (p *Mock) UpdateChallengeInterceptionRules(ctx context.Context, params UpdateChallengeInterceptionRulesRequest) (map[string]interface{}, error)

func (*Mock) UpdateClientSideSecurity 

func (p *Mock) UpdateClientSideSecurity(ctx context.Context, params UpdateClientSideSecurityRequest) (map[string]interface{}, error)

func (*Mock) UpdateConditionalAction 

func (p *Mock) UpdateConditionalAction(ctx context.Context, params UpdateConditionalActionRequest) (map[string]interface{}, error)

func (*Mock) UpdateContentProtectionJavaScriptInjectionRule added in v8.3.0 

func (p *Mock) UpdateContentProtectionJavaScriptInjectionRule(ctx context.Context, params UpdateContentProtectionJavaScriptInjectionRuleRequest) (map[string]interface{}, error)

func (*Mock) UpdateContentProtectionRule added in v8.3.0 

func (p *Mock) UpdateContentProtectionRule(ctx context.Context, params UpdateContentProtectionRuleRequest) (map[string]interface{}, error)

func (*Mock) UpdateContentProtectionRuleSequence added in v8.3.0 

func (p *Mock) UpdateContentProtectionRuleSequence(ctx context.Context, params UpdateContentProtectionRuleSequenceRequest) (*UpdateContentProtectionRuleSequenceResponse, error)

func (*Mock) UpdateCustomBotCategory 

func (p *Mock) UpdateCustomBotCategory(ctx context.Context, params UpdateCustomBotCategoryRequest) (map[string]interface{}, error)

func (*Mock) UpdateCustomBotCategoryAction 

func (p *Mock) UpdateCustomBotCategoryAction(ctx context.Context, params UpdateCustomBotCategoryActionRequest) (map[string]interface{}, error)

func (*Mock) UpdateCustomBotCategoryItemSequence added in v8.2.0 

func (p *Mock) UpdateCustomBotCategoryItemSequence(ctx context.Context, params UpdateCustomBotCategoryItemSequenceRequest) (*UpdateCustomBotCategoryItemSequenceResponse, error)

func (*Mock) UpdateCustomBotCategorySequence 

func (p *Mock) UpdateCustomBotCategorySequence(ctx context.Context, params UpdateCustomBotCategorySequenceRequest) (*CustomBotCategorySequenceResponse, error)

func (*Mock) UpdateCustomClient 

func (p *Mock) UpdateCustomClient(ctx context.Context, params UpdateCustomClientRequest) (map[string]interface{}, error)

func (*Mock) UpdateCustomClientSequence 

func (p *Mock) UpdateCustomClientSequence(ctx context.Context, params UpdateCustomClientSequenceRequest) (*CustomClientSequenceResponse, error)

func (*Mock) UpdateCustomCode 

func (p *Mock) UpdateCustomCode(ctx context.Context, params UpdateCustomCodeRequest) (map[string]interface{}, error)

func (*Mock) UpdateCustomDefinedBot 

func (p *Mock) UpdateCustomDefinedBot(ctx context.Context, params UpdateCustomDefinedBotRequest) (map[string]interface{}, error)

func (*Mock) UpdateCustomDenyAction 

func (p *Mock) UpdateCustomDenyAction(ctx context.Context, params UpdateCustomDenyActionRequest) (map[string]interface{}, error)

func (*Mock) UpdateGoogleReCaptchaSecretKey 

func (p *Mock) UpdateGoogleReCaptchaSecretKey(ctx context.Context, params UpdateGoogleReCaptchaSecretKeyRequest) error

func (*Mock) UpdateJavascriptInjection 

func (p *Mock) UpdateJavascriptInjection(ctx context.Context, params UpdateJavascriptInjectionRequest) (map[string]interface{}, error)

func (*Mock) UpdateRecategorizedAkamaiDefinedBot 

func (p *Mock) UpdateRecategorizedAkamaiDefinedBot(ctx context.Context, params UpdateRecategorizedAkamaiDefinedBotRequest) (*RecategorizedAkamaiDefinedBotResponse, error)

func (*Mock) UpdateServeAlternateAction 

func (p *Mock) UpdateServeAlternateAction(ctx context.Context, params UpdateServeAlternateActionRequest) (map[string]interface{}, error)

func (*Mock) UpdateTransactionalEndpoint 

func (p *Mock) UpdateTransactionalEndpoint(ctx context.Context, params UpdateTransactionalEndpointRequest) (map[string]interface{}, error)

func (*Mock) UpdateTransactionalEndpointProtection 

func (p *Mock) UpdateTransactionalEndpointProtection(ctx context.Context, params UpdateTransactionalEndpointProtectionRequest) (map[string]interface{}, error)

type Option 

type Option func(*botman)

Option defines a BotMan option

type RecategorizedAkamaiDefinedBot 

type RecategorizedAkamaiDefinedBot interface {
	// GetRecategorizedAkamaiDefinedBotList https://techdocs.akamai.com/bot-manager/reference/get-recategorized-akamai-defined-bots
	GetRecategorizedAkamaiDefinedBotList(ctx context.Context, params GetRecategorizedAkamaiDefinedBotListRequest) (*GetRecategorizedAkamaiDefinedBotListResponse, error)

	// GetRecategorizedAkamaiDefinedBot https://techdocs.akamai.com/bot-manager/reference/get-recategorized-akamai-defined-bot
	GetRecategorizedAkamaiDefinedBot(ctx context.Context, params GetRecategorizedAkamaiDefinedBotRequest) (*RecategorizedAkamaiDefinedBotResponse, error)

	// CreateRecategorizedAkamaiDefinedBot https://techdocs.akamai.com/bot-manager/reference/post-recategorized-akamai-defined-bot
	CreateRecategorizedAkamaiDefinedBot(ctx context.Context, params CreateRecategorizedAkamaiDefinedBotRequest) (*RecategorizedAkamaiDefinedBotResponse, error)

	// UpdateRecategorizedAkamaiDefinedBot https://techdocs.akamai.com/bot-manager/reference/put-recategorized-akamai-defined-bot
	UpdateRecategorizedAkamaiDefinedBot(ctx context.Context, params UpdateRecategorizedAkamaiDefinedBotRequest) (*RecategorizedAkamaiDefinedBotResponse, error)

	// RemoveRecategorizedAkamaiDefinedBot https://techdocs.akamai.com/bot-manager/reference/delete-recategorized-akamai-defined-bot
	RemoveRecategorizedAkamaiDefinedBot(ctx context.Context, params RemoveRecategorizedAkamaiDefinedBotRequest) error
}

The RecategorizedAkamaiDefinedBot interface supports creating, retrieving, modifying and removing recategorized akamai defined bot for a configuration.

type RecategorizedAkamaiDefinedBotResponse 

type RecategorizedAkamaiDefinedBotResponse struct {
	BotID      string `json:"botId"`
	CategoryID string `json:"customBotCategoryId"`
}

RecategorizedAkamaiDefinedBotResponse is used to retrieve a specific recategorized akamai defined bot

type RemoveChallengeActionRequest 

type RemoveChallengeActionRequest struct {
	ConfigID int64
	Version  int64
	ActionID string
}

RemoveChallengeActionRequest is used to remove an existing challenge action

func (RemoveChallengeActionRequest) Validate 

func (v RemoveChallengeActionRequest) Validate() error

Validate validates a RemoveChallengeActionRequest.

type RemoveConditionalActionRequest 

type RemoveConditionalActionRequest struct {
	ConfigID int64
	Version  int64
	ActionID string
}

RemoveConditionalActionRequest is used to remove an existing conditional action

func (RemoveConditionalActionRequest) Validate 

func (v RemoveConditionalActionRequest) Validate() error

Validate validates a RemoveConditionalActionRequest.

type RemoveContentProtectionJavaScriptInjectionRuleRequest added in v8.3.0 

type RemoveContentProtectionJavaScriptInjectionRuleRequest struct {
	ConfigID                                   int64
	Version                                    int64
	SecurityPolicyID                           string
	ContentProtectionJavaScriptInjectionRuleID string
}

RemoveContentProtectionJavaScriptInjectionRuleRequest is used to remove an existing content protection JavaScript injection rule

func (RemoveContentProtectionJavaScriptInjectionRuleRequest) Validate added in v8.3.0 

func (v RemoveContentProtectionJavaScriptInjectionRuleRequest) Validate() error

Validate validates a RemoveContentProtectionJavaScriptInjectionRuleRequest.

type RemoveContentProtectionRuleRequest added in v8.3.0 

type RemoveContentProtectionRuleRequest struct {
	ConfigID                int64
	Version                 int64
	SecurityPolicyID        string
	ContentProtectionRuleID string
}

RemoveContentProtectionRuleRequest is used to remove an existing content protection rule

func (RemoveContentProtectionRuleRequest) Validate added in v8.3.0 

func (v RemoveContentProtectionRuleRequest) Validate() error

Validate validates a RemoveContentProtectionRuleRequest.

type RemoveCustomBotCategoryRequest 

type RemoveCustomBotCategoryRequest struct {
	ConfigID   int64
	Version    int64
	CategoryID string
}

RemoveCustomBotCategoryRequest is used to remove an existing custom bot category

func (RemoveCustomBotCategoryRequest) Validate 

func (v RemoveCustomBotCategoryRequest) Validate() error

Validate validates a RemoveCustomBotCategoryRequest.

type RemoveCustomClientRequest 

type RemoveCustomClientRequest struct {
	ConfigID       int64
	Version        int64
	CustomClientID string
}

RemoveCustomClientRequest is used to remove an existing custom client.

func (RemoveCustomClientRequest) Validate 

func (v RemoveCustomClientRequest) Validate() error

Validate validates a RemoveCustomClientRequest.

type RemoveCustomDefinedBotRequest 

type RemoveCustomDefinedBotRequest struct {
	ConfigID int64
	Version  int64
	BotID    string
}

RemoveCustomDefinedBotRequest is used to remove an existing custom defined bot.

func (RemoveCustomDefinedBotRequest) Validate 

func (v RemoveCustomDefinedBotRequest) Validate() error

Validate validates a RemoveCustomDefinedBotRequest.

type RemoveCustomDenyActionRequest 

type RemoveCustomDenyActionRequest struct {
	ConfigID int64
	Version  int64
	ActionID string
}

RemoveCustomDenyActionRequest is used to remove an existing custom deny action

func (RemoveCustomDenyActionRequest) Validate 

func (v RemoveCustomDenyActionRequest) Validate() error

Validate validates a RemoveCustomDenyActionRequest.

type RemoveRecategorizedAkamaiDefinedBotRequest 

type RemoveRecategorizedAkamaiDefinedBotRequest struct {
	ConfigID int64
	Version  int64
	BotID    string
}

RemoveRecategorizedAkamaiDefinedBotRequest is used to remove an existing recategorized akamai defined bot

func (RemoveRecategorizedAkamaiDefinedBotRequest) Validate 

func (v RemoveRecategorizedAkamaiDefinedBotRequest) Validate() error

Validate validates a RemoveRecategorizedAkamaiDefinedBotRequest.

type RemoveServeAlternateActionRequest 

type RemoveServeAlternateActionRequest struct {
	ConfigID int64
	Version  int64
	ActionID string
}

RemoveServeAlternateActionRequest is used to remove an existing serve alternate action

func (RemoveServeAlternateActionRequest) Validate 

func (v RemoveServeAlternateActionRequest) Validate() error

Validate validates a RemoveServeAlternateActionRequest.

type RemoveTransactionalEndpointRequest 

type RemoveTransactionalEndpointRequest struct {
	ConfigID         int64
	Version          int64
	SecurityPolicyID string
	OperationID      string
}

RemoveTransactionalEndpointRequest is used to remove an existing transactional endpoint

func (RemoveTransactionalEndpointRequest) Validate 

func (v RemoveTransactionalEndpointRequest) Validate() error

Validate validates a RemoveTransactionalEndpointRequest.

type ResponseAction 

type ResponseAction interface {
	// GetResponseActionList https://techdocs.akamai.com/bot-manager/reference/get-response-actions
	GetResponseActionList(ctx context.Context, params GetResponseActionListRequest) (*GetResponseActionListResponse, error)
}

The ResponseAction interface supports retrieving response actions of a configuration

type ServeAlternateAction 

type ServeAlternateAction interface {
	// GetServeAlternateActionList https://techdocs.akamai.com/bot-manager/reference/get-serve-alternate-actions
	GetServeAlternateActionList(ctx context.Context, params GetServeAlternateActionListRequest) (*GetServeAlternateActionListResponse, error)

	// GetServeAlternateAction https://techdocs.akamai.com/bot-manager/reference/get-serve-alternate-action
	GetServeAlternateAction(ctx context.Context, params GetServeAlternateActionRequest) (map[string]interface{}, error)

	// CreateServeAlternateAction https://techdocs.akamai.com/bot-manager/reference/post-serve-alternate-action
	CreateServeAlternateAction(ctx context.Context, params CreateServeAlternateActionRequest) (map[string]interface{}, error)

	// UpdateServeAlternateAction https://techdocs.akamai.com/bot-manager/reference/put-serve-alternate-action
	UpdateServeAlternateAction(ctx context.Context, params UpdateServeAlternateActionRequest) (map[string]interface{}, error)

	// RemoveServeAlternateAction https://techdocs.akamai.com/bot-manager/reference/delete-serve-alternate-action
	RemoveServeAlternateAction(ctx context.Context, params RemoveServeAlternateActionRequest) error
}

The ServeAlternateAction interface supports creating, retrieving, modifying and removing serve alternate action for a configuration.

type TransactionalEndpoint 

type TransactionalEndpoint interface {
	// GetTransactionalEndpointList https://techdocs.akamai.com/bot-manager/reference/get-transactional-endpoints
	GetTransactionalEndpointList(ctx context.Context, params GetTransactionalEndpointListRequest) (*GetTransactionalEndpointListResponse, error)

	// GetTransactionalEndpoint https://techdocs.akamai.com/bot-manager/reference/get-transactional-endpoint
	GetTransactionalEndpoint(ctx context.Context, params GetTransactionalEndpointRequest) (map[string]interface{}, error)

	// CreateTransactionalEndpoint https://techdocs.akamai.com/bot-manager/reference/post-transactional-endpoint
	CreateTransactionalEndpoint(ctx context.Context, params CreateTransactionalEndpointRequest) (map[string]interface{}, error)

	// UpdateTransactionalEndpoint https://techdocs.akamai.com/bot-manager/reference/put-transactional-endpoint
	UpdateTransactionalEndpoint(ctx context.Context, params UpdateTransactionalEndpointRequest) (map[string]interface{}, error)

	// RemoveTransactionalEndpoint https://techdocs.akamai.com/bot-manager/reference/delete-transactional-endpoint
	RemoveTransactionalEndpoint(ctx context.Context, params RemoveTransactionalEndpointRequest) error
}

The TransactionalEndpoint interface supports creating, retrieving, modifying and removing transactional endpoints for a configuration.

type TransactionalEndpointProtection 

type TransactionalEndpointProtection interface {

	// GetTransactionalEndpointProtection https://techdocs.akamai.com/bot-manager/reference/get-transactional-endpoint-protection
	GetTransactionalEndpointProtection(ctx context.Context, params GetTransactionalEndpointProtectionRequest) (map[string]interface{}, error)

	// UpdateTransactionalEndpointProtection https://techdocs.akamai.com/bot-manager/reference/put-transactional-endpoint-protection
	UpdateTransactionalEndpointProtection(ctx context.Context, params UpdateTransactionalEndpointProtectionRequest) (map[string]interface{}, error)
}

The TransactionalEndpointProtection interface supports retrieving and updating transactional endpoint protection settings for a configuration.

type UUIDSequence added in v8.2.0 

type UUIDSequence struct {
	Sequence []string `json:"sequence"`
}

UUIDSequence is nothing more than a sequence of UUIDs, in this case bots, but this could be reused.

type UpdateAkamaiBotCategoryActionRequest 

type UpdateAkamaiBotCategoryActionRequest struct {
	ConfigID         int64
	Version          int64
	SecurityPolicyID string
	CategoryID       string
	JsonPayload      json.RawMessage
}

UpdateAkamaiBotCategoryActionRequest is used to modify an akamai bot category action.

func (UpdateAkamaiBotCategoryActionRequest) Validate 

func (v UpdateAkamaiBotCategoryActionRequest) Validate() error

Validate validates an UpdateAkamaiBotCategoryActionRequest.

type UpdateBotAnalyticsCookieRequest 

type UpdateBotAnalyticsCookieRequest struct {
	ConfigID    int64
	Version     int64
	JsonPayload json.RawMessage
}

UpdateBotAnalyticsCookieRequest is used to modify bot analytics cookie settings

func (UpdateBotAnalyticsCookieRequest) Validate 

func (v UpdateBotAnalyticsCookieRequest) Validate() error

Validate validates an UpdateBotAnalyticsCookieRequest.

type UpdateBotCategoryExceptionRequest 

type UpdateBotCategoryExceptionRequest struct {
	ConfigID         int64
	Version          int64
	SecurityPolicyID string
	JsonPayload      json.RawMessage
}

UpdateBotCategoryExceptionRequest is used to update bot category exceptions

func (UpdateBotCategoryExceptionRequest) Validate 

func (v UpdateBotCategoryExceptionRequest) Validate() error

Validate validates an UpdateBotCategoryExceptionRequest.

type UpdateBotDetectionActionRequest 

type UpdateBotDetectionActionRequest struct {
	ConfigID         int64
	Version          int64
	SecurityPolicyID string
	DetectionID      string
	JsonPayload      json.RawMessage
}

UpdateBotDetectionActionRequest is used to modify a bot detection action.

func (UpdateBotDetectionActionRequest) Validate 

func (v UpdateBotDetectionActionRequest) Validate() error

Validate validates an UpdateBotDetectionActionRequest.

type UpdateBotManagementSettingRequest 

type UpdateBotManagementSettingRequest struct {
	ConfigID         int64
	Version          int64
	SecurityPolicyID string
	JsonPayload      json.RawMessage
}

UpdateBotManagementSettingRequest is used to modify bot management settings

func (UpdateBotManagementSettingRequest) Validate 

func (v UpdateBotManagementSettingRequest) Validate() error

Validate validates an UpdateBotManagementSettingRequest.

type UpdateChallengeActionRequest 

type UpdateChallengeActionRequest struct {
	ConfigID    int64
	Version     int64
	ActionID    string
	JsonPayload json.RawMessage
}

UpdateChallengeActionRequest is used to update an existing challenge action

func (UpdateChallengeActionRequest) Validate 

func (v UpdateChallengeActionRequest) Validate() error

Validate validates an UpdateChallengeActionRequest.

type UpdateChallengeInjectionRulesRequest 

type UpdateChallengeInjectionRulesRequest struct {
	ConfigID    int64
	Version     int64
	JsonPayload json.RawMessage
}

UpdateChallengeInjectionRulesRequest is used to modify challenge injection rules

func (UpdateChallengeInjectionRulesRequest) Validate 

func (v UpdateChallengeInjectionRulesRequest) Validate() error

Validate validates an UpdateChallengeInjectionRulesRequest.

type UpdateChallengeInterceptionRulesRequest 

type UpdateChallengeInterceptionRulesRequest struct {
	ConfigID    int64
	Version     int64
	JsonPayload json.RawMessage
}

UpdateChallengeInterceptionRulesRequest is used to modify challenge interception rules Deprecated: this struct will be removed in a future release. Use UpdateChallengeInjectionRulesRequest instead.

func (UpdateChallengeInterceptionRulesRequest) Validate 

func (v UpdateChallengeInterceptionRulesRequest) Validate() error

Validate validates an UpdateChallengeInterceptionRulesRequest.

type UpdateClientSideSecurityRequest 

type UpdateClientSideSecurityRequest struct {
	ConfigID    int64           `json:"-"`
	Version     int64           `json:"-"`
	JsonPayload json.RawMessage `json:"-"`
}

UpdateClientSideSecurityRequest is used to modify client side security settings

func (UpdateClientSideSecurityRequest) Validate 

func (v UpdateClientSideSecurityRequest) Validate() error

Validate validates an UpdateClientSideSecurityRequest.

type UpdateConditionalActionRequest 

type UpdateConditionalActionRequest struct {
	ConfigID    int64
	Version     int64
	ActionID    string
	JsonPayload json.RawMessage
}

UpdateConditionalActionRequest is used to update an existing conditional action

func (UpdateConditionalActionRequest) Validate 

func (v UpdateConditionalActionRequest) Validate() error

Validate validates an UpdateConditionalActionRequest.

type UpdateContentProtectionJavaScriptInjectionRuleRequest added in v8.3.0 

type UpdateContentProtectionJavaScriptInjectionRuleRequest struct {
	ConfigID                                   int64
	Version                                    int64
	SecurityPolicyID                           string
	ContentProtectionJavaScriptInjectionRuleID string
	JsonPayload                                json.RawMessage
}

UpdateContentProtectionJavaScriptInjectionRuleRequest is used to update details for a content protection JavaScript injection rule.

func (UpdateContentProtectionJavaScriptInjectionRuleRequest) Validate added in v8.3.0 

func (v UpdateContentProtectionJavaScriptInjectionRuleRequest) Validate() error

Validate validates an UpdateContentProtectionJavaScriptInjectionRuleRequest.

type UpdateContentProtectionRuleRequest added in v8.3.0 

type UpdateContentProtectionRuleRequest struct {
	ConfigID                int64
	Version                 int64
	SecurityPolicyID        string
	ContentProtectionRuleID string
	JsonPayload             json.RawMessage
}

UpdateContentProtectionRuleRequest is used to update details for a content protection rule.

func (UpdateContentProtectionRuleRequest) Validate added in v8.3.0 

func (v UpdateContentProtectionRuleRequest) Validate() error

Validate validates an UpdateContentProtectionRuleRequest.

type UpdateContentProtectionRuleSequenceRequest added in v8.3.0 

type UpdateContentProtectionRuleSequenceRequest struct {
	ConfigID                      int64
	Version                       int64
	SecurityPolicyID              string
	ContentProtectionRuleSequence ContentProtectionRuleUUIDSequence
}

UpdateContentProtectionRuleSequenceRequest is used to update content protection rule sequence

func (UpdateContentProtectionRuleSequenceRequest) Validate added in v8.3.0 

func (v UpdateContentProtectionRuleSequenceRequest) Validate() error

Validate validates an UpdateContentProtectionRuleSequenceRequest.

type UpdateContentProtectionRuleSequenceResponse added in v8.3.0 

type UpdateContentProtectionRuleSequenceResponse ContentProtectionRuleUUIDSequence

UpdateContentProtectionRuleSequenceResponse contains the sequence of content protection rule

type UpdateCustomBotCategoryActionRequest 

type UpdateCustomBotCategoryActionRequest struct {
	ConfigID         int64
	Version          int64
	SecurityPolicyID string
	CategoryID       string
	JsonPayload      json.RawMessage
}

UpdateCustomBotCategoryActionRequest is used to modify an existing custom bot category action

func (UpdateCustomBotCategoryActionRequest) Validate 

func (v UpdateCustomBotCategoryActionRequest) Validate() error

Validate validates an UpdateCustomBotCategoryActionRequest.

type UpdateCustomBotCategoryItemSequenceRequest added in v8.2.0 

type UpdateCustomBotCategoryItemSequenceRequest struct {
	ConfigID   int64
	Version    int64
	CategoryID string
	Sequence   UUIDSequence
}

UpdateCustomBotCategoryItemSequenceRequest is used to update custom bot category item sequence

func (UpdateCustomBotCategoryItemSequenceRequest) Validate added in v8.2.0 

func (v UpdateCustomBotCategoryItemSequenceRequest) Validate() error

Validate validates an UpdateCustomBotCategoryItemSequenceRequest.

type UpdateCustomBotCategoryItemSequenceResponse added in v8.2.0 

type UpdateCustomBotCategoryItemSequenceResponse UUIDSequence

UpdateCustomBotCategoryItemSequenceResponse contains the sequence of botIds

type UpdateCustomBotCategoryRequest 

type UpdateCustomBotCategoryRequest struct {
	ConfigID    int64
	Version     int64
	CategoryID  string
	JsonPayload json.RawMessage
}

UpdateCustomBotCategoryRequest is used to update an existing custom bot category

func (UpdateCustomBotCategoryRequest) Validate 

func (v UpdateCustomBotCategoryRequest) Validate() error

Validate validates an UpdateCustomBotCategoryRequest.

type UpdateCustomBotCategorySequenceRequest 

type UpdateCustomBotCategorySequenceRequest struct {
	ConfigID int64    `json:"-"`
	Version  int64    `json:"-"`
	Sequence []string `json:"sequence"`
}

UpdateCustomBotCategorySequenceRequest is used to update custom bot category sequence

func (UpdateCustomBotCategorySequenceRequest) Validate 

func (v UpdateCustomBotCategorySequenceRequest) Validate() error

Validate validates an UpdateCustomBotCategorySequenceRequest.

type UpdateCustomClientRequest 

type UpdateCustomClientRequest struct {
	ConfigID       int64
	Version        int64
	CustomClientID string
	JsonPayload    json.RawMessage
}

UpdateCustomClientRequest is used to update details for a specific custom client.

func (UpdateCustomClientRequest) Validate 

func (v UpdateCustomClientRequest) Validate() error

Validate validates an UpdateCustomClientRequest.

type UpdateCustomClientSequenceRequest 

type UpdateCustomClientSequenceRequest struct {
	ConfigID int64    `json:"-"`
	Version  int64    `json:"-"`
	Sequence []string `json:"sequence"`
}

UpdateCustomClientSequenceRequest is used to modify custom client sequence

func (UpdateCustomClientSequenceRequest) Validate 

func (v UpdateCustomClientSequenceRequest) Validate() error

Validate validates an UpdateCustomClientSequenceRequest.

type UpdateCustomCodeRequest 

type UpdateCustomCodeRequest struct {
	ConfigID    int64
	Version     int64
	JsonPayload json.RawMessage
}

UpdateCustomCodeRequest is used to modify custom code

func (UpdateCustomCodeRequest) Validate 

func (v UpdateCustomCodeRequest) Validate() error

Validate validates an UpdateCustomCodeRequest.

type UpdateCustomDefinedBotRequest 

type UpdateCustomDefinedBotRequest struct {
	ConfigID    int64
	Version     int64
	BotID       string
	JsonPayload json.RawMessage
}

UpdateCustomDefinedBotRequest is used to update details for a specific custom defined bot.

func (UpdateCustomDefinedBotRequest) Validate 

func (v UpdateCustomDefinedBotRequest) Validate() error

Validate validates an UpdateCustomDefinedBotRequest.

type UpdateCustomDenyActionRequest 

type UpdateCustomDenyActionRequest struct {
	ConfigID    int64
	Version     int64
	ActionID    string
	JsonPayload json.RawMessage
}

UpdateCustomDenyActionRequest is used to update an existing custom deny action

func (UpdateCustomDenyActionRequest) Validate 

func (v UpdateCustomDenyActionRequest) Validate() error

Validate validates an UpdateCustomDenyActionRequest.

type UpdateGoogleReCaptchaSecretKeyRequest 

type UpdateGoogleReCaptchaSecretKeyRequest struct {
	ConfigID  int64  `json:"-"`
	Version   int64  `json:"-"`
	ActionID  string `json:"-"`
	SecretKey string `json:"googleReCaptchaSecretKey"`
}

UpdateGoogleReCaptchaSecretKeyRequest is used to update google reCaptcha secret key

func (UpdateGoogleReCaptchaSecretKeyRequest) Validate 

func (v UpdateGoogleReCaptchaSecretKeyRequest) Validate() error

Validate validates a UpdateGoogleReCaptchaSecretKeyRequest.

type UpdateJavascriptInjectionRequest 

type UpdateJavascriptInjectionRequest struct {
	ConfigID         int64
	Version          int64
	SecurityPolicyID string
	JsonPayload      json.RawMessage
}

UpdateJavascriptInjectionRequest is used to modify javascript injection settings

func (UpdateJavascriptInjectionRequest) Validate 

func (v UpdateJavascriptInjectionRequest) Validate() error

Validate validates an UpdateJavascriptInjectionRequest.

type UpdateRecategorizedAkamaiDefinedBotRequest 

type UpdateRecategorizedAkamaiDefinedBotRequest struct {
	ConfigID   int64  `json:"-"`
	Version    int64  `json:"-"`
	BotID      string `json:"botId"`
	CategoryID string `json:"customBotCategoryId"`
}

UpdateRecategorizedAkamaiDefinedBotRequest is used to update details for a specific recategorized akamai defined bot

func (UpdateRecategorizedAkamaiDefinedBotRequest) Validate 

func (v UpdateRecategorizedAkamaiDefinedBotRequest) Validate() error

Validate validates an UpdateRecategorizedAkamaiDefinedBotRequest.

type UpdateServeAlternateActionRequest 

type UpdateServeAlternateActionRequest struct {
	ConfigID    int64
	Version     int64
	ActionID    string
	JsonPayload json.RawMessage
}

UpdateServeAlternateActionRequest is used to update an existing serve alternate action

func (UpdateServeAlternateActionRequest) Validate 

func (v UpdateServeAlternateActionRequest) Validate() error

Validate validates an UpdateServeAlternateActionRequest.

type UpdateTransactionalEndpointProtectionRequest 

type UpdateTransactionalEndpointProtectionRequest struct {
	ConfigID    int64
	Version     int64
	JsonPayload json.RawMessage
}

UpdateTransactionalEndpointProtectionRequest is used to modify transactional endpoint protection settings

func (UpdateTransactionalEndpointProtectionRequest) Validate 

func (v UpdateTransactionalEndpointProtectionRequest) Validate() error

Validate validates an UpdateTransactionalEndpointProtectionRequest.

type UpdateTransactionalEndpointRequest 

type UpdateTransactionalEndpointRequest struct {
	ConfigID         int64
	Version          int64
	SecurityPolicyID string
	OperationID      string
	JsonPayload      json.RawMessage
}

UpdateTransactionalEndpointRequest is used to update details for a specific transactional endpoint

func (UpdateTransactionalEndpointRequest) Validate 

func (v UpdateTransactionalEndpointRequest) Validate() error

Validate validates an UpdateTransactionalEndpointRequest.

type ValidationDetail 

type ValidationDetail struct {
	Title  string `json:"title"`
	Type   string `json:"type"`
	Detail string `json:"detail"`
}

ValidationDetail is used to represent validation details

type ValidationResponse 

type ValidationResponse struct {
	Errors   []ValidationDetail `json:"errors"`
	Notices  []ValidationDetail `json:"notices"`
	Warnings []ValidationDetail `json:"warnings"`
}

ValidationResponse is used to represent validation member in the botman api response

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.