zoneratelimitsv1

type CreateZoneRateLimitsOptions struct {
	// Whether this ratelimit is currently disabled.
	Disabled *bool `json:"disabled,omitempty"`

	// A note that you can use to describe the reason for a rate limit.
	Description *string `json:"description,omitempty"`

	// Criteria that would allow the rate limit to be bypassed, for example to express that you shouldn't apply a rate
	// limit to a given set of URLs.
	Bypass []RatelimitInputBypassItem `json:"bypass,omitempty"`

	// The threshold that triggers the rate limit mitigations, combine with period. i.e. threshold per period.
	Threshold *int64 `json:"threshold,omitempty"`

	// The time in seconds to count matching traffic. If the count exceeds threshold within this period the action will be
	// performed.
	Period *int64 `json:"period,omitempty"`

	// action.
	Action *RatelimitInputAction `json:"action,omitempty"`

	// Enable NAT based rate limits.
	Correlate *RatelimitInputCorrelate `json:"correlate,omitempty"`

	// Determines which traffic the rate limit counts towards the threshold. Needs to be one of "request" or "response"
	// objects.
	Match *RatelimitInputMatch `json:"match,omitempty"`

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

type DeleteRateLimitResp 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 *DeleteRateLimitRespResult `json:"result" validate:"required"`
}

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

type DeleteZoneRateLimitOptions struct {
	// Identifier of the rate limit to be deleted.
	RateLimitIdentifier *string `json:"rate_limit_identifier" validate:"required,ne="`

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

type GetRateLimitOptions struct {
	// Identifier of rate limit for the given zone.
	RateLimitIdentifier *string `json:"rate_limit_identifier" validate:"required,ne="`

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

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

	// Maximum number of rate limits per page.
	PerPage *int64 `json:"per_page,omitempty"`

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

type ListRatelimitResp 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 []RatelimitObject `json:"result" validate:"required"`

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

type ListRatelimitRespResultInfo 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 RatelimitInputAction struct {
	// The type of action to perform.
	Mode *string `json:"mode" validate:"required"`

	// The time in seconds as an integer to perform the mitigation action. Must be the same or greater than the period.
	// This field is valid only when mode is "simulate" or "ban".
	Timeout *int64 `json:"timeout,omitempty"`

	// Custom content-type and body to return, this overrides the custom error for the zone. This field is not required.
	// Omission will result in default HTML error page.This field is valid only when mode is "simulate" or "ban".
	Response *RatelimitInputActionResponse `json:"response,omitempty"`
}

type RatelimitInputActionResponse struct {
	// The content type of the body.
	ContentType *string `json:"content_type,omitempty"`

	// The body to return, the content here should conform to the content_type.
	Body *string `json:"body,omitempty"`
}

type RatelimitInputBypassItem struct {
	// Rate limit name.
	Name *string `json:"name" validate:"required"`

	// The url to bypass.
	Value *string `json:"value" validate:"required"`
}

type RatelimitInputCorrelate struct {
	// NAT rate limits by.
	By *string `json:"by" validate:"required"`
}

type RatelimitInputMatch struct {
	// request.
	Request *RatelimitInputMatchRequest `json:"request,omitempty"`

	// response.
	Response *RatelimitInputMatchResponse `json:"response,omitempty"`
}

type RatelimitInputMatchRequest struct {
	// A subset of the list HTTP methods, or ["_ALL_"] for selecting all methods.
	Methods []string `json:"methods,omitempty"`

	// HTTP schemes list, or ["_ALL_"] for selecting all schemes.
	Schemes []string `json:"schemes,omitempty"`

	// The URL pattern to match comprised of the host and path, i.e. example.org/path. Wildcard are expanded to match
	// applicable traffic, query strings are not matched. Use * for all traffic to your zone.
	URL *string `json:"url" validate:"required"`
}

type RatelimitInputMatchResponse struct {
	// HTTP Status codes, can be one [403], many [401,403] or indicate all by not providing this value. This field is not
	// required.
	Status []int64 `json:"status,omitempty"`

	// Array of response headers to match. If a response does not meet the header criteria then the request will not be
	// counted towards the rate limit.
	HeadersVar []RatelimitInputMatchResponseHeadersItem `json:"headers,omitempty"`

	// Deprecated, please use response headers instead and also provide "origin_traffic:false" to avoid legacy behaviour
	// interacting with the response.headers property.
	OriginTraffic *bool `json:"origin_traffic,omitempty"`
}

type RatelimitInputMatchResponseHeadersItem struct {
	// The name of the response header to match.
	Name *string `json:"name" validate:"required"`

	// The operator when matchin, eq means equals, ne means not equals.
	Op *string `json:"op" validate:"required"`

	// The value of the header, which will be exactly matched.
	Value *string `json:"value" validate:"required"`
}

type RatelimitObject struct {
	// Identifier of the rate limit.
	ID *string `json:"id" validate:"required"`

	// Whether this ratelimit is currently disabled.
	Disabled *bool `json:"disabled" validate:"required"`

	// A note that you can use to describe the reason for a rate limit.
	Description *string `json:"description" validate:"required"`

	// Criteria that would allow the rate limit to be bypassed, for example to express that you shouldn't apply a rate
	// limit to a given set of URLs.
	Bypass []RatelimitObjectBypassItem `json:"bypass" validate:"required"`

	// The threshold that triggers the rate limit mitigations, combine with period. i.e. threshold per period.
	Threshold *int64 `json:"threshold" validate:"required"`

	// The time in seconds to count matching traffic. If the count exceeds threshold within this period the action will be
	// performed.
	Period *int64 `json:"period" validate:"required"`

	// Enable NAT based rate limits.
	Correlate *RatelimitObjectCorrelate `json:"correlate,omitempty"`

	// action.
	Action *RatelimitObjectAction `json:"action" validate:"required"`

	// Determines which traffic the rate limit counts towards the threshold. Needs to be one of "request" or "response"
	// objects.
	Match *RatelimitObjectMatch `json:"match" validate:"required"`
}

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

	// The time in seconds as an integer to perform the mitigation action. Must be the same or greater than the period.
	// This field is valid only when mode is "simulate" or "ban".
	Timeout *int64 `json:"timeout,omitempty"`

	// Custom content-type and body to return, this overrides the custom error for the zone. This field is not required.
	// Omission will result in default HTML error page.This field is valid only when mode is "simulate" or "ban".
	Response *RatelimitObjectActionResponse `json:"response,omitempty"`
}

type RatelimitObjectActionResponse struct {
	// The content type of the body.
	ContentType *string `json:"content_type" validate:"required"`

	// The body to return, the content here should conform to the content_type.
	Body *string `json:"body" validate:"required"`
}

type RatelimitObjectBypassItem struct {
	// rate limit name.
	Name *string `json:"name" validate:"required"`

	// The url to bypass.
	Value *string `json:"value" validate:"required"`
}

type RatelimitObjectCorrelate struct {
	// rate limit enabled by.
	By *string `json:"by" validate:"required"`
}

type RatelimitObjectMatch struct {
	// request.
	Request *RatelimitObjectMatchRequest `json:"request,omitempty"`

	// response.
	Response *RatelimitObjectMatchResponse `json:"response,omitempty"`
}

type RatelimitObjectMatchRequest struct {
	// A subset of the list HTTP methods, or ["_ALL_"] for selecting all methods.
	Methods []string `json:"methods,omitempty"`

	// HTTP schemes list, or ["_ALL_"] for selecting all schemes.
	Schemes []string `json:"schemes,omitempty"`

	// The URL pattern to match comprised of the host and path, i.e. example.org/path. Wildcard are expanded to match
	// applicable traffic, query strings are not matched. Use * for all traffic to your zone.
	URL *string `json:"url" validate:"required"`
}

type RatelimitObjectMatchResponse struct {
	// HTTP Status codes, can be one [403], many [401,403] or indicate all by not providing this value. This field is not
	// required.
	Status []int64 `json:"status,omitempty"`

	// Array of response headers to match. If a response does not meet the header criteria then the request will not be
	// counted towards the rate limit.
	HeadersVar []RatelimitObjectMatchResponseHeadersItem `json:"headers,omitempty"`

	// Deprecated, please use response headers instead and also provide "origin_traffic:false" to avoid legacy behaviour
	// interacting with the response.headers property.
	OriginTraffic *bool `json:"origin_traffic,omitempty"`
}

type RatelimitObjectMatchResponseHeadersItem struct {
	// The name of the response header to match.
	Name *string `json:"name" validate:"required"`

	// The operator when matchin, eq means equals, ne means not equals.
	Op *string `json:"op" validate:"required"`

	// The value of the header, which will be exactly matched.
	Value *string `json:"value" validate:"required"`
}

type RatelimitResp 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"`

	// rate limit object.
	Result *RatelimitObject `json:"result" validate:"required"`
}

type UpdateRateLimitOptions struct {
	// Identifier of rate limit.
	RateLimitIdentifier *string `json:"rate_limit_identifier" validate:"required,ne="`

	// Whether this ratelimit is currently disabled.
	Disabled *bool `json:"disabled,omitempty"`

	// A note that you can use to describe the reason for a rate limit.
	Description *string `json:"description,omitempty"`

	// Criteria that would allow the rate limit to be bypassed, for example to express that you shouldn't apply a rate
	// limit to a given set of URLs.
	Bypass []RatelimitInputBypassItem `json:"bypass,omitempty"`

	// The threshold that triggers the rate limit mitigations, combine with period. i.e. threshold per period.
	Threshold *int64 `json:"threshold,omitempty"`

	// The time in seconds to count matching traffic. If the count exceeds threshold within this period the action will be
	// performed.
	Period *int64 `json:"period,omitempty"`

	// action.
	Action *RatelimitInputAction `json:"action,omitempty"`

	// Enable NAT based rate limits.
	Correlate *RatelimitInputCorrelate `json:"correlate,omitempty"`

	// Determines which traffic the rate limit counts towards the threshold. Needs to be one of "request" or "response"
	// objects.
	Match *RatelimitInputMatch `json:"match,omitempty"`

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

type ZoneRateLimitsV1 struct {
	Service *core.BaseService

	// Full url-encoded cloud resource name (CRN) of resource instance.
	Crn *string

	// Zone identifier of the zone for which rate limit is to be created.
	ZoneIdentifier *string
}

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

	// Full url-encoded cloud resource name (CRN) of resource instance.
	Crn *string `validate:"required"`

	// Zone identifier of the zone for which rate limit is to be created.
	ZoneIdentifier *string `validate:"required"`
}