rate_limits

type Error = apierror.Error

type RateLimitDeleteResponse struct {
	// The unique identifier of the rate limit.
	ID   string                      `json:"id"`
	JSON rateLimitDeleteResponseJSON `json:"-"`
}

type RateLimitDeleteResponseEnvelope struct {
	Errors   []RateLimitDeleteResponseEnvelopeErrors   `json:"errors,required"`
	Messages []RateLimitDeleteResponseEnvelopeMessages `json:"messages,required"`
	Result   RateLimitDeleteResponse                   `json:"result,required,nullable"`
	// Whether the API call was successful
	Success RateLimitDeleteResponseEnvelopeSuccess `json:"success,required"`
	JSON    rateLimitDeleteResponseEnvelopeJSON    `json:"-"`
}

type RateLimitDeleteResponseEnvelopeErrors struct {
	Code    int64                                     `json:"code,required"`
	Message string                                    `json:"message,required"`
	JSON    rateLimitDeleteResponseEnvelopeErrorsJSON `json:"-"`
}

type RateLimitDeleteResponseEnvelopeMessages struct {
	Code    int64                                       `json:"code,required"`
	Message string                                      `json:"message,required"`
	JSON    rateLimitDeleteResponseEnvelopeMessagesJSON `json:"-"`
}

type RateLimitDeleteResponseEnvelopeSuccess bool

type RateLimitEditParams struct {
	Body param.Field[interface{}] `json:"body,required"`
}

type RateLimitEditResponse interface {
	ImplementsRateLimitsRateLimitEditResponse()
}

type RateLimitEditResponseEnvelope struct {
	Errors   []RateLimitEditResponseEnvelopeErrors   `json:"errors,required"`
	Messages []RateLimitEditResponseEnvelopeMessages `json:"messages,required"`
	Result   RateLimitEditResponse                   `json:"result,required,nullable"`
	// Whether the API call was successful
	Success RateLimitEditResponseEnvelopeSuccess `json:"success,required"`
	JSON    rateLimitEditResponseEnvelopeJSON    `json:"-"`
}

type RateLimitEditResponseEnvelopeErrors struct {
	Code    int64                                   `json:"code,required"`
	Message string                                  `json:"message,required"`
	JSON    rateLimitEditResponseEnvelopeErrorsJSON `json:"-"`
}

type RateLimitEditResponseEnvelopeMessages struct {
	Code    int64                                     `json:"code,required"`
	Message string                                    `json:"message,required"`
	JSON    rateLimitEditResponseEnvelopeMessagesJSON `json:"-"`
}

type RateLimitEditResponseEnvelopeSuccess bool

type RateLimitGetResponse interface {
	ImplementsRateLimitsRateLimitGetResponse()
}

type RateLimitGetResponseEnvelope struct {
	Errors   []RateLimitGetResponseEnvelopeErrors   `json:"errors,required"`
	Messages []RateLimitGetResponseEnvelopeMessages `json:"messages,required"`
	Result   RateLimitGetResponse                   `json:"result,required,nullable"`
	// Whether the API call was successful
	Success RateLimitGetResponseEnvelopeSuccess `json:"success,required"`
	JSON    rateLimitGetResponseEnvelopeJSON    `json:"-"`
}

type RateLimitGetResponseEnvelopeErrors struct {
	Code    int64                                  `json:"code,required"`
	Message string                                 `json:"message,required"`
	JSON    rateLimitGetResponseEnvelopeErrorsJSON `json:"-"`
}

type RateLimitGetResponseEnvelopeMessages struct {
	Code    int64                                    `json:"code,required"`
	Message string                                   `json:"message,required"`
	JSON    rateLimitGetResponseEnvelopeMessagesJSON `json:"-"`
}

type RateLimitGetResponseEnvelopeSuccess bool

type RateLimitListParams struct {
	// The page number of paginated results.
	Page param.Field[float64] `query:"page"`
	// The maximum number of results per page. You can only set the value to `1` or to
	// a multiple of 5 such as `5`, `10`, `15`, or `20`.
	PerPage param.Field[float64] `query:"per_page"`
}

type RateLimitListResponse struct {
	// The unique identifier of the rate limit.
	ID string `json:"id"`
	// The action to perform when the threshold of matched traffic within the
	// configured period is exceeded.
	Action RateLimitListResponseAction `json:"action"`
	// Criteria specifying when the current rate limit should be bypassed. You can
	// specify that the rate limit should not apply to one or more URLs.
	Bypass []RateLimitListResponseBypass `json:"bypass"`
	// An informative summary of the rate limit. This value is sanitized and any tags
	// will be removed.
	Description string `json:"description"`
	// When true, indicates that the rate limit is currently disabled.
	Disabled bool `json:"disabled"`
	// Determines which traffic the rate limit counts towards the threshold.
	Match RateLimitListResponseMatch `json:"match"`
	// The time in seconds (an integer value) to count matching traffic. If the count
	// exceeds the configured threshold within this period, Cloudflare will perform the
	// configured action.
	Period float64 `json:"period"`
	// The threshold that will trigger the configured mitigation action. Configure this
	// value along with the `period` property to establish a threshold per period.
	Threshold float64                   `json:"threshold"`
	JSON      rateLimitListResponseJSON `json:"-"`
}

type RateLimitListResponseAction struct {
	// The action to perform.
	Mode RateLimitListResponseActionMode `json:"mode"`
	// A custom content type and reponse to return when the threshold is exceeded. The
	// custom response configured in this object will override the custom error for the
	// zone. This object is optional. Notes: If you omit this object, Cloudflare will
	// use the default HTML error page. If "mode" is "challenge", "managed_challenge",
	// or "js_challenge", Cloudflare will use the zone challenge pages and you should
	// not provide the "response" object.
	Response RateLimitListResponseActionResponse `json:"response"`
	// The time in seconds during which Cloudflare will perform the mitigation action.
	// Must be an integer value greater than or equal to the period. Notes: If "mode"
	// is "challenge", "managed_challenge", or "js_challenge", Cloudflare will use the
	// zone's Challenge Passage time and you should not provide this value.
	Timeout float64                         `json:"timeout"`
	JSON    rateLimitListResponseActionJSON `json:"-"`
}

type RateLimitListResponseActionMode string

type RateLimitListResponseActionResponse struct {
	// The response body to return. The value must conform to the configured content
	// type.
	Body string `json:"body"`
	// The content type of the body. Must be one of the following: `text/plain`,
	// `text/xml`, or `application/json`.
	ContentType string                                  `json:"content_type"`
	JSON        rateLimitListResponseActionResponseJSON `json:"-"`
}

type RateLimitListResponseBypass struct {
	Name RateLimitListResponseBypassName `json:"name"`
	// The URL to bypass.
	Value string                          `json:"value"`
	JSON  rateLimitListResponseBypassJSON `json:"-"`
}

type RateLimitListResponseBypassName string

type RateLimitListResponseMatch struct {
	Headers  []RateLimitListResponseMatchHeader `json:"headers"`
	Request  RateLimitListResponseMatchRequest  `json:"request"`
	Response RateLimitListResponseMatchResponse `json:"response"`
	JSON     rateLimitListResponseMatchJSON     `json:"-"`
}

type RateLimitListResponseMatchHeader struct {
	// The name of the response header to match.
	Name string `json:"name"`
	// The operator used when matching: `eq` means "equal" and `ne` means "not equal".
	Op RateLimitListResponseMatchHeadersOp `json:"op"`
	// The value of the response header, which must match exactly.
	Value string                               `json:"value"`
	JSON  rateLimitListResponseMatchHeaderJSON `json:"-"`
}

type RateLimitListResponseMatchHeadersOp string

type RateLimitListResponseMatchRequest struct {
	// The HTTP methods to match. You can specify a subset (for example,
	// `['POST','PUT']`) or all methods (`['_ALL_']`). This field is optional when
	// creating a rate limit.
	Methods []RateLimitListResponseMatchRequestMethod `json:"methods"`
	// The HTTP schemes to match. You can specify one scheme (`['HTTPS']`), both
	// schemes (`['HTTP','HTTPS']`), or all schemes (`['_ALL_']`). This field is
	// optional.
	Schemes []string `json:"schemes"`
	// The URL pattern to match, composed of a host and a path such as
	// `example.org/path*`. Normalization is applied before the pattern is matched. `*`
	// wildcards are expanded to match applicable traffic. Query strings are not
	// matched. Set the value to `*` to match all traffic to your zone.
	URL  string                                `json:"url"`
	JSON rateLimitListResponseMatchRequestJSON `json:"-"`
}

type RateLimitListResponseMatchRequestMethod string

type RateLimitListResponseMatchResponse struct {
	// When true, only the uncached traffic served from your origin servers will count
	// towards rate limiting. In this case, any cached traffic served by Cloudflare
	// will not count towards rate limiting. This field is optional. Notes: This field
	// is deprecated. Instead, use response headers and set "origin_traffic" to "false"
	// to avoid legacy behaviour interacting with the "response_headers" property.
	OriginTraffic bool                                   `json:"origin_traffic"`
	JSON          rateLimitListResponseMatchResponseJSON `json:"-"`
}

type RateLimitNewParams struct {
	Body param.Field[interface{}] `json:"body,required"`
}

type RateLimitNewResponse interface {
	ImplementsRateLimitsRateLimitNewResponse()
}

type RateLimitNewResponseEnvelope struct {
	Errors   []RateLimitNewResponseEnvelopeErrors   `json:"errors,required"`
	Messages []RateLimitNewResponseEnvelopeMessages `json:"messages,required"`
	Result   RateLimitNewResponse                   `json:"result,required,nullable"`
	// Whether the API call was successful
	Success RateLimitNewResponseEnvelopeSuccess `json:"success,required"`
	JSON    rateLimitNewResponseEnvelopeJSON    `json:"-"`
}

type RateLimitNewResponseEnvelopeErrors struct {
	Code    int64                                  `json:"code,required"`
	Message string                                 `json:"message,required"`
	JSON    rateLimitNewResponseEnvelopeErrorsJSON `json:"-"`
}

type RateLimitNewResponseEnvelopeMessages struct {
	Code    int64                                    `json:"code,required"`
	Message string                                   `json:"message,required"`
	JSON    rateLimitNewResponseEnvelopeMessagesJSON `json:"-"`
}

type RateLimitNewResponseEnvelopeSuccess bool

type RateLimitService struct {
	Options []option.RequestOption
}