useragentblockingrulesv1

type CreateZoneUserAgentRuleOptions struct {
	// Whether this user-agent rule is currently disabled.
	Paused *bool `json:"paused,omitempty"`

	// Some useful information about this rule to help identify the purpose of it.
	Description *string `json:"description,omitempty"`

	// The type of action to perform.
	Mode *string `json:"mode,omitempty"`

	// Target/Value pair to use for this rule. The value is the exact UserAgent to match.
	Configuration *UseragentRuleInputConfiguration `json:"configuration,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

type DeleteUseragentRuleResp struct {
	// Operation success flag.
	Success *bool `json:"success" validate:"required"`

	// Array of errors encountered.
	Errors [][]string `json:"errors" validate:"required"`

	// Array of messages returned.
	Messages [][]string `json:"messages" validate:"required"`

	// Container for response information.
	Result *DeleteUseragentRuleRespResult `json:"result" validate:"required"`
}

type DeleteUseragentRuleRespResult struct {
	// ID.
	ID *string `json:"id" validate:"required"`
}

type DeleteZoneUserAgentRuleOptions struct {
	// Identifier of the user-agent rule to be deleted.
	UseragentRuleIdentifier *string `json:"useragent_rule_identifier" validate:"required,ne="`

	// Allows users to set headers on API requests
	Headers map[string]string
}

type GetUserAgentRuleOptions struct {
	// Identifier of user-agent blocking rule for the given zone.
	UseragentRuleIdentifier *string `json:"useragent_rule_identifier" validate:"required,ne="`

	// Allows users to set headers on API requests
	Headers map[string]string
}

type ListAllZoneUserAgentRulesOptions struct {
	// Page number of paginated results.
	Page *int64 `json:"page,omitempty"`

	// Maximum number of user-agent rules per page.
	PerPage *int64 `json:"per_page,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

type ListUseragentRulesResp struct {
	// Was operation successful.
	Success *bool `json:"success" validate:"required"`

	// Array of errors encountered.
	Errors [][]string `json:"errors" validate:"required"`

	// Array of messages returned.
	Messages [][]string `json:"messages" validate:"required"`

	// Container for response information.
	Result []UseragentRuleObject `json:"result" validate:"required"`

	// Statistics of results.
	ResultInfo *ListUseragentRulesRespResultInfo `json:"result_info" validate:"required"`
}

type ListUseragentRulesRespResultInfo struct {
	// Page number.
	Page *int64 `json:"page" validate:"required"`

	// Number of results per page.
	PerPage *int64 `json:"per_page" validate:"required"`

	// Number of results.
	Count *int64 `json:"count" validate:"required"`

	// Total number of results.
	TotalCount *int64 `json:"total_count" validate:"required"`
}

type UpdateUserAgentRuleOptions struct {
	// Identifier of user-agent rule.
	UseragentRuleIdentifier *string `json:"useragent_rule_identifier" validate:"required,ne="`

	// Whether this user-agent rule is currently disabled.
	Paused *bool `json:"paused,omitempty"`

	// Some useful information about this rule to help identify the purpose of it.
	Description *string `json:"description,omitempty"`

	// The type of action to perform.
	Mode *string `json:"mode,omitempty"`

	// Target/Value pair to use for this rule. The value is the exact UserAgent to match.
	Configuration *UseragentRuleInputConfiguration `json:"configuration,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

type UserAgentBlockingRulesV1 struct {
	Service *core.BaseService

	// Full crn of the service instance.
	Crn *string

	// Zone identifier (zone id).
	ZoneIdentifier *string
}

type UserAgentBlockingRulesV1Options struct {
	ServiceName   string
	URL           string
	Authenticator core.Authenticator

	// Full crn of the service instance.
	Crn *string `validate:"required"`

	// Zone identifier (zone id).
	ZoneIdentifier *string `validate:"required"`
}

type UseragentRuleInputConfiguration struct {
	// properties.
	Target *string `json:"target" validate:"required"`

	// The exact UserAgent string to match with this rule.
	Value *string `json:"value" validate:"required"`
}

type UseragentRuleObject struct {
	// Identifier of the user-agent blocking rule.
	ID *string `json:"id" validate:"required"`

	// Whether this user-agent rule is currently disabled.
	Paused *bool `json:"paused" validate:"required"`

	// Some useful information about this rule to help identify the purpose of it.
	Description *string `json:"description" validate:"required"`

	// The type of action to perform.
	Mode *string `json:"mode" validate:"required"`

	// Target/Value pair to use for this rule. The value is the exact UserAgent to match.
	Configuration *UseragentRuleObjectConfiguration `json:"configuration" validate:"required"`
}

type UseragentRuleObjectConfiguration struct {
	// properties.
	Target *string `json:"target" validate:"required"`

	// The exact UserAgent string to match with this rule.
	Value *string `json:"value" validate:"required"`
}

type UseragentRuleResp struct {
	// Was operation successful.
	Success *bool `json:"success" validate:"required"`

	// Array of errors encountered.
	Errors [][]string `json:"errors" validate:"required"`

	// Array of messages returned.
	Messages [][]string `json:"messages" validate:"required"`

	// user agent rule object.
	Result *UseragentRuleObject `json:"result" validate:"required"`
}