mirror of
https://github.com/cloudflare/cloudflare-python.git
synced 2026-01-16 23:01:03 +00:00
775 lines
31 KiB
Python
775 lines
31 KiB
Python
# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
|
|
from __future__ import annotations
|
|
|
|
import typing_extensions
|
|
from typing import Type, cast
|
|
|
|
import httpx
|
|
|
|
from .._types import Body, Omit, Query, Headers, NotGiven, omit, not_given
|
|
from .._utils import maybe_transform, async_maybe_transform
|
|
from .._compat import cached_property
|
|
from .._resource import SyncAPIResource, AsyncAPIResource
|
|
from .._response import (
|
|
to_raw_response_wrapper,
|
|
to_streamed_response_wrapper,
|
|
async_to_raw_response_wrapper,
|
|
async_to_streamed_response_wrapper,
|
|
)
|
|
from .._wrappers import ResultWrapper
|
|
from ..pagination import SyncV4PagePaginationArray, AsyncV4PagePaginationArray
|
|
from .._base_client import AsyncPaginator, make_request_options
|
|
from ..types.rate_limits import rate_limit_edit_params, rate_limit_list_params, rate_limit_create_params
|
|
from ..types.rate_limits.rate_limit import RateLimit
|
|
from ..types.rate_limits.rate_limit_delete_response import RateLimitDeleteResponse
|
|
|
|
__all__ = ["RateLimitsResource", "AsyncRateLimitsResource"]
|
|
|
|
|
|
class RateLimitsResource(SyncAPIResource):
|
|
@cached_property
|
|
def with_raw_response(self) -> RateLimitsResourceWithRawResponse:
|
|
"""
|
|
This property can be used as a prefix for any HTTP method call to return
|
|
the raw response object instead of the parsed content.
|
|
|
|
For more information, see https://www.github.com/cloudflare/cloudflare-python#accessing-raw-response-data-eg-headers
|
|
"""
|
|
return RateLimitsResourceWithRawResponse(self)
|
|
|
|
@cached_property
|
|
def with_streaming_response(self) -> RateLimitsResourceWithStreamingResponse:
|
|
"""
|
|
An alternative to `.with_raw_response` that doesn't eagerly read the response body.
|
|
|
|
For more information, see https://www.github.com/cloudflare/cloudflare-python#with_streaming_response
|
|
"""
|
|
return RateLimitsResourceWithStreamingResponse(self)
|
|
|
|
@typing_extensions.deprecated(
|
|
"Rate limiting API is deprecated in favour of using the Ruleset Engine. See https://developers.cloudflare.com/fundamentals/api/reference/deprecations/#rate-limiting-api-previous-version for full details."
|
|
)
|
|
def create(
|
|
self,
|
|
*,
|
|
zone_id: str,
|
|
action: rate_limit_create_params.Action,
|
|
match: rate_limit_create_params.Match,
|
|
period: float,
|
|
threshold: float,
|
|
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
|
|
# The extra values given here take precedence over values defined on the client or passed to this method.
|
|
extra_headers: Headers | None = None,
|
|
extra_query: Query | None = None,
|
|
extra_body: Body | None = None,
|
|
timeout: float | httpx.Timeout | None | NotGiven = not_given,
|
|
) -> RateLimit:
|
|
"""Creates a new rate limit for a zone.
|
|
|
|
Refer to the object definition for a list
|
|
of required attributes.
|
|
|
|
Args:
|
|
zone_id: Defines an identifier.
|
|
|
|
action: The action to perform when the threshold of matched traffic within the
|
|
configured period is exceeded.
|
|
|
|
match: Determines which traffic the rate limit counts towards the threshold.
|
|
|
|
period: 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.
|
|
|
|
threshold: The threshold that will trigger the configured mitigation action. Configure this
|
|
value along with the `period` property to establish a threshold per period.
|
|
|
|
extra_headers: Send extra headers
|
|
|
|
extra_query: Add additional query parameters to the request
|
|
|
|
extra_body: Add additional JSON properties to the request
|
|
|
|
timeout: Override the client-level default timeout for this request, in seconds
|
|
"""
|
|
if not zone_id:
|
|
raise ValueError(f"Expected a non-empty value for `zone_id` but received {zone_id!r}")
|
|
return self._post(
|
|
f"/zones/{zone_id}/rate_limits",
|
|
body=maybe_transform(
|
|
{
|
|
"action": action,
|
|
"match": match,
|
|
"period": period,
|
|
"threshold": threshold,
|
|
},
|
|
rate_limit_create_params.RateLimitCreateParams,
|
|
),
|
|
options=make_request_options(
|
|
extra_headers=extra_headers,
|
|
extra_query=extra_query,
|
|
extra_body=extra_body,
|
|
timeout=timeout,
|
|
post_parser=ResultWrapper[RateLimit]._unwrapper,
|
|
),
|
|
cast_to=cast(Type[RateLimit], ResultWrapper[RateLimit]),
|
|
)
|
|
|
|
@typing_extensions.deprecated(
|
|
"Rate limiting API is deprecated in favour of using the Ruleset Engine. See https://developers.cloudflare.com/fundamentals/api/reference/deprecations/#rate-limiting-api-previous-version for full details."
|
|
)
|
|
def list(
|
|
self,
|
|
*,
|
|
zone_id: str,
|
|
page: float | Omit = omit,
|
|
per_page: float | Omit = omit,
|
|
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
|
|
# The extra values given here take precedence over values defined on the client or passed to this method.
|
|
extra_headers: Headers | None = None,
|
|
extra_query: Query | None = None,
|
|
extra_body: Body | None = None,
|
|
timeout: float | httpx.Timeout | None | NotGiven = not_given,
|
|
) -> SyncV4PagePaginationArray[RateLimit]:
|
|
"""
|
|
Fetches the rate limits for a zone.
|
|
|
|
Args:
|
|
zone_id: Defines an identifier.
|
|
|
|
page: Defines the page number of paginated results.
|
|
|
|
per_page: Defines 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`.
|
|
|
|
extra_headers: Send extra headers
|
|
|
|
extra_query: Add additional query parameters to the request
|
|
|
|
extra_body: Add additional JSON properties to the request
|
|
|
|
timeout: Override the client-level default timeout for this request, in seconds
|
|
"""
|
|
if not zone_id:
|
|
raise ValueError(f"Expected a non-empty value for `zone_id` but received {zone_id!r}")
|
|
return self._get_api_list(
|
|
f"/zones/{zone_id}/rate_limits",
|
|
page=SyncV4PagePaginationArray[RateLimit],
|
|
options=make_request_options(
|
|
extra_headers=extra_headers,
|
|
extra_query=extra_query,
|
|
extra_body=extra_body,
|
|
timeout=timeout,
|
|
query=maybe_transform(
|
|
{
|
|
"page": page,
|
|
"per_page": per_page,
|
|
},
|
|
rate_limit_list_params.RateLimitListParams,
|
|
),
|
|
),
|
|
model=RateLimit,
|
|
)
|
|
|
|
@typing_extensions.deprecated(
|
|
"Rate limiting API is deprecated in favour of using the Ruleset Engine. See https://developers.cloudflare.com/fundamentals/api/reference/deprecations/#rate-limiting-api-previous-version for full details."
|
|
)
|
|
def delete(
|
|
self,
|
|
rate_limit_id: str,
|
|
*,
|
|
zone_id: str,
|
|
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
|
|
# The extra values given here take precedence over values defined on the client or passed to this method.
|
|
extra_headers: Headers | None = None,
|
|
extra_query: Query | None = None,
|
|
extra_body: Body | None = None,
|
|
timeout: float | httpx.Timeout | None | NotGiven = not_given,
|
|
) -> RateLimitDeleteResponse:
|
|
"""
|
|
Deletes an existing rate limit.
|
|
|
|
Args:
|
|
zone_id: Defines an identifier.
|
|
|
|
rate_limit_id: Defines the unique identifier of the rate limit.
|
|
|
|
extra_headers: Send extra headers
|
|
|
|
extra_query: Add additional query parameters to the request
|
|
|
|
extra_body: Add additional JSON properties to the request
|
|
|
|
timeout: Override the client-level default timeout for this request, in seconds
|
|
"""
|
|
if not zone_id:
|
|
raise ValueError(f"Expected a non-empty value for `zone_id` but received {zone_id!r}")
|
|
if not rate_limit_id:
|
|
raise ValueError(f"Expected a non-empty value for `rate_limit_id` but received {rate_limit_id!r}")
|
|
return self._delete(
|
|
f"/zones/{zone_id}/rate_limits/{rate_limit_id}",
|
|
options=make_request_options(
|
|
extra_headers=extra_headers,
|
|
extra_query=extra_query,
|
|
extra_body=extra_body,
|
|
timeout=timeout,
|
|
post_parser=ResultWrapper[RateLimitDeleteResponse]._unwrapper,
|
|
),
|
|
cast_to=cast(Type[RateLimitDeleteResponse], ResultWrapper[RateLimitDeleteResponse]),
|
|
)
|
|
|
|
@typing_extensions.deprecated(
|
|
"Rate limiting API is deprecated in favour of using the Ruleset Engine. See https://developers.cloudflare.com/fundamentals/api/reference/deprecations/#rate-limiting-api-previous-version for full details."
|
|
)
|
|
def edit(
|
|
self,
|
|
rate_limit_id: str,
|
|
*,
|
|
zone_id: str,
|
|
action: rate_limit_edit_params.Action,
|
|
match: rate_limit_edit_params.Match,
|
|
period: float,
|
|
threshold: float,
|
|
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
|
|
# The extra values given here take precedence over values defined on the client or passed to this method.
|
|
extra_headers: Headers | None = None,
|
|
extra_query: Query | None = None,
|
|
extra_body: Body | None = None,
|
|
timeout: float | httpx.Timeout | None | NotGiven = not_given,
|
|
) -> RateLimit:
|
|
"""
|
|
Updates an existing rate limit.
|
|
|
|
Args:
|
|
zone_id: Defines an identifier.
|
|
|
|
rate_limit_id: Defines the unique identifier of the rate limit.
|
|
|
|
action: The action to perform when the threshold of matched traffic within the
|
|
configured period is exceeded.
|
|
|
|
match: Determines which traffic the rate limit counts towards the threshold.
|
|
|
|
period: 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.
|
|
|
|
threshold: The threshold that will trigger the configured mitigation action. Configure this
|
|
value along with the `period` property to establish a threshold per period.
|
|
|
|
extra_headers: Send extra headers
|
|
|
|
extra_query: Add additional query parameters to the request
|
|
|
|
extra_body: Add additional JSON properties to the request
|
|
|
|
timeout: Override the client-level default timeout for this request, in seconds
|
|
"""
|
|
if not zone_id:
|
|
raise ValueError(f"Expected a non-empty value for `zone_id` but received {zone_id!r}")
|
|
if not rate_limit_id:
|
|
raise ValueError(f"Expected a non-empty value for `rate_limit_id` but received {rate_limit_id!r}")
|
|
return self._put(
|
|
f"/zones/{zone_id}/rate_limits/{rate_limit_id}",
|
|
body=maybe_transform(
|
|
{
|
|
"action": action,
|
|
"match": match,
|
|
"period": period,
|
|
"threshold": threshold,
|
|
},
|
|
rate_limit_edit_params.RateLimitEditParams,
|
|
),
|
|
options=make_request_options(
|
|
extra_headers=extra_headers,
|
|
extra_query=extra_query,
|
|
extra_body=extra_body,
|
|
timeout=timeout,
|
|
post_parser=ResultWrapper[RateLimit]._unwrapper,
|
|
),
|
|
cast_to=cast(Type[RateLimit], ResultWrapper[RateLimit]),
|
|
)
|
|
|
|
@typing_extensions.deprecated(
|
|
"Rate limiting API is deprecated in favour of using the Ruleset Engine. See https://developers.cloudflare.com/fundamentals/api/reference/deprecations/#rate-limiting-api-previous-version for full details."
|
|
)
|
|
def get(
|
|
self,
|
|
rate_limit_id: str,
|
|
*,
|
|
zone_id: str,
|
|
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
|
|
# The extra values given here take precedence over values defined on the client or passed to this method.
|
|
extra_headers: Headers | None = None,
|
|
extra_query: Query | None = None,
|
|
extra_body: Body | None = None,
|
|
timeout: float | httpx.Timeout | None | NotGiven = not_given,
|
|
) -> RateLimit:
|
|
"""
|
|
Fetches the details of a rate limit.
|
|
|
|
Args:
|
|
zone_id: Defines an identifier.
|
|
|
|
rate_limit_id: Defines the unique identifier of the rate limit.
|
|
|
|
extra_headers: Send extra headers
|
|
|
|
extra_query: Add additional query parameters to the request
|
|
|
|
extra_body: Add additional JSON properties to the request
|
|
|
|
timeout: Override the client-level default timeout for this request, in seconds
|
|
"""
|
|
if not zone_id:
|
|
raise ValueError(f"Expected a non-empty value for `zone_id` but received {zone_id!r}")
|
|
if not rate_limit_id:
|
|
raise ValueError(f"Expected a non-empty value for `rate_limit_id` but received {rate_limit_id!r}")
|
|
return self._get(
|
|
f"/zones/{zone_id}/rate_limits/{rate_limit_id}",
|
|
options=make_request_options(
|
|
extra_headers=extra_headers,
|
|
extra_query=extra_query,
|
|
extra_body=extra_body,
|
|
timeout=timeout,
|
|
post_parser=ResultWrapper[RateLimit]._unwrapper,
|
|
),
|
|
cast_to=cast(Type[RateLimit], ResultWrapper[RateLimit]),
|
|
)
|
|
|
|
|
|
class AsyncRateLimitsResource(AsyncAPIResource):
|
|
@cached_property
|
|
def with_raw_response(self) -> AsyncRateLimitsResourceWithRawResponse:
|
|
"""
|
|
This property can be used as a prefix for any HTTP method call to return
|
|
the raw response object instead of the parsed content.
|
|
|
|
For more information, see https://www.github.com/cloudflare/cloudflare-python#accessing-raw-response-data-eg-headers
|
|
"""
|
|
return AsyncRateLimitsResourceWithRawResponse(self)
|
|
|
|
@cached_property
|
|
def with_streaming_response(self) -> AsyncRateLimitsResourceWithStreamingResponse:
|
|
"""
|
|
An alternative to `.with_raw_response` that doesn't eagerly read the response body.
|
|
|
|
For more information, see https://www.github.com/cloudflare/cloudflare-python#with_streaming_response
|
|
"""
|
|
return AsyncRateLimitsResourceWithStreamingResponse(self)
|
|
|
|
@typing_extensions.deprecated(
|
|
"Rate limiting API is deprecated in favour of using the Ruleset Engine. See https://developers.cloudflare.com/fundamentals/api/reference/deprecations/#rate-limiting-api-previous-version for full details."
|
|
)
|
|
async def create(
|
|
self,
|
|
*,
|
|
zone_id: str,
|
|
action: rate_limit_create_params.Action,
|
|
match: rate_limit_create_params.Match,
|
|
period: float,
|
|
threshold: float,
|
|
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
|
|
# The extra values given here take precedence over values defined on the client or passed to this method.
|
|
extra_headers: Headers | None = None,
|
|
extra_query: Query | None = None,
|
|
extra_body: Body | None = None,
|
|
timeout: float | httpx.Timeout | None | NotGiven = not_given,
|
|
) -> RateLimit:
|
|
"""Creates a new rate limit for a zone.
|
|
|
|
Refer to the object definition for a list
|
|
of required attributes.
|
|
|
|
Args:
|
|
zone_id: Defines an identifier.
|
|
|
|
action: The action to perform when the threshold of matched traffic within the
|
|
configured period is exceeded.
|
|
|
|
match: Determines which traffic the rate limit counts towards the threshold.
|
|
|
|
period: 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.
|
|
|
|
threshold: The threshold that will trigger the configured mitigation action. Configure this
|
|
value along with the `period` property to establish a threshold per period.
|
|
|
|
extra_headers: Send extra headers
|
|
|
|
extra_query: Add additional query parameters to the request
|
|
|
|
extra_body: Add additional JSON properties to the request
|
|
|
|
timeout: Override the client-level default timeout for this request, in seconds
|
|
"""
|
|
if not zone_id:
|
|
raise ValueError(f"Expected a non-empty value for `zone_id` but received {zone_id!r}")
|
|
return await self._post(
|
|
f"/zones/{zone_id}/rate_limits",
|
|
body=await async_maybe_transform(
|
|
{
|
|
"action": action,
|
|
"match": match,
|
|
"period": period,
|
|
"threshold": threshold,
|
|
},
|
|
rate_limit_create_params.RateLimitCreateParams,
|
|
),
|
|
options=make_request_options(
|
|
extra_headers=extra_headers,
|
|
extra_query=extra_query,
|
|
extra_body=extra_body,
|
|
timeout=timeout,
|
|
post_parser=ResultWrapper[RateLimit]._unwrapper,
|
|
),
|
|
cast_to=cast(Type[RateLimit], ResultWrapper[RateLimit]),
|
|
)
|
|
|
|
@typing_extensions.deprecated(
|
|
"Rate limiting API is deprecated in favour of using the Ruleset Engine. See https://developers.cloudflare.com/fundamentals/api/reference/deprecations/#rate-limiting-api-previous-version for full details."
|
|
)
|
|
def list(
|
|
self,
|
|
*,
|
|
zone_id: str,
|
|
page: float | Omit = omit,
|
|
per_page: float | Omit = omit,
|
|
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
|
|
# The extra values given here take precedence over values defined on the client or passed to this method.
|
|
extra_headers: Headers | None = None,
|
|
extra_query: Query | None = None,
|
|
extra_body: Body | None = None,
|
|
timeout: float | httpx.Timeout | None | NotGiven = not_given,
|
|
) -> AsyncPaginator[RateLimit, AsyncV4PagePaginationArray[RateLimit]]:
|
|
"""
|
|
Fetches the rate limits for a zone.
|
|
|
|
Args:
|
|
zone_id: Defines an identifier.
|
|
|
|
page: Defines the page number of paginated results.
|
|
|
|
per_page: Defines 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`.
|
|
|
|
extra_headers: Send extra headers
|
|
|
|
extra_query: Add additional query parameters to the request
|
|
|
|
extra_body: Add additional JSON properties to the request
|
|
|
|
timeout: Override the client-level default timeout for this request, in seconds
|
|
"""
|
|
if not zone_id:
|
|
raise ValueError(f"Expected a non-empty value for `zone_id` but received {zone_id!r}")
|
|
return self._get_api_list(
|
|
f"/zones/{zone_id}/rate_limits",
|
|
page=AsyncV4PagePaginationArray[RateLimit],
|
|
options=make_request_options(
|
|
extra_headers=extra_headers,
|
|
extra_query=extra_query,
|
|
extra_body=extra_body,
|
|
timeout=timeout,
|
|
query=maybe_transform(
|
|
{
|
|
"page": page,
|
|
"per_page": per_page,
|
|
},
|
|
rate_limit_list_params.RateLimitListParams,
|
|
),
|
|
),
|
|
model=RateLimit,
|
|
)
|
|
|
|
@typing_extensions.deprecated(
|
|
"Rate limiting API is deprecated in favour of using the Ruleset Engine. See https://developers.cloudflare.com/fundamentals/api/reference/deprecations/#rate-limiting-api-previous-version for full details."
|
|
)
|
|
async def delete(
|
|
self,
|
|
rate_limit_id: str,
|
|
*,
|
|
zone_id: str,
|
|
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
|
|
# The extra values given here take precedence over values defined on the client or passed to this method.
|
|
extra_headers: Headers | None = None,
|
|
extra_query: Query | None = None,
|
|
extra_body: Body | None = None,
|
|
timeout: float | httpx.Timeout | None | NotGiven = not_given,
|
|
) -> RateLimitDeleteResponse:
|
|
"""
|
|
Deletes an existing rate limit.
|
|
|
|
Args:
|
|
zone_id: Defines an identifier.
|
|
|
|
rate_limit_id: Defines the unique identifier of the rate limit.
|
|
|
|
extra_headers: Send extra headers
|
|
|
|
extra_query: Add additional query parameters to the request
|
|
|
|
extra_body: Add additional JSON properties to the request
|
|
|
|
timeout: Override the client-level default timeout for this request, in seconds
|
|
"""
|
|
if not zone_id:
|
|
raise ValueError(f"Expected a non-empty value for `zone_id` but received {zone_id!r}")
|
|
if not rate_limit_id:
|
|
raise ValueError(f"Expected a non-empty value for `rate_limit_id` but received {rate_limit_id!r}")
|
|
return await self._delete(
|
|
f"/zones/{zone_id}/rate_limits/{rate_limit_id}",
|
|
options=make_request_options(
|
|
extra_headers=extra_headers,
|
|
extra_query=extra_query,
|
|
extra_body=extra_body,
|
|
timeout=timeout,
|
|
post_parser=ResultWrapper[RateLimitDeleteResponse]._unwrapper,
|
|
),
|
|
cast_to=cast(Type[RateLimitDeleteResponse], ResultWrapper[RateLimitDeleteResponse]),
|
|
)
|
|
|
|
@typing_extensions.deprecated(
|
|
"Rate limiting API is deprecated in favour of using the Ruleset Engine. See https://developers.cloudflare.com/fundamentals/api/reference/deprecations/#rate-limiting-api-previous-version for full details."
|
|
)
|
|
async def edit(
|
|
self,
|
|
rate_limit_id: str,
|
|
*,
|
|
zone_id: str,
|
|
action: rate_limit_edit_params.Action,
|
|
match: rate_limit_edit_params.Match,
|
|
period: float,
|
|
threshold: float,
|
|
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
|
|
# The extra values given here take precedence over values defined on the client or passed to this method.
|
|
extra_headers: Headers | None = None,
|
|
extra_query: Query | None = None,
|
|
extra_body: Body | None = None,
|
|
timeout: float | httpx.Timeout | None | NotGiven = not_given,
|
|
) -> RateLimit:
|
|
"""
|
|
Updates an existing rate limit.
|
|
|
|
Args:
|
|
zone_id: Defines an identifier.
|
|
|
|
rate_limit_id: Defines the unique identifier of the rate limit.
|
|
|
|
action: The action to perform when the threshold of matched traffic within the
|
|
configured period is exceeded.
|
|
|
|
match: Determines which traffic the rate limit counts towards the threshold.
|
|
|
|
period: 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.
|
|
|
|
threshold: The threshold that will trigger the configured mitigation action. Configure this
|
|
value along with the `period` property to establish a threshold per period.
|
|
|
|
extra_headers: Send extra headers
|
|
|
|
extra_query: Add additional query parameters to the request
|
|
|
|
extra_body: Add additional JSON properties to the request
|
|
|
|
timeout: Override the client-level default timeout for this request, in seconds
|
|
"""
|
|
if not zone_id:
|
|
raise ValueError(f"Expected a non-empty value for `zone_id` but received {zone_id!r}")
|
|
if not rate_limit_id:
|
|
raise ValueError(f"Expected a non-empty value for `rate_limit_id` but received {rate_limit_id!r}")
|
|
return await self._put(
|
|
f"/zones/{zone_id}/rate_limits/{rate_limit_id}",
|
|
body=await async_maybe_transform(
|
|
{
|
|
"action": action,
|
|
"match": match,
|
|
"period": period,
|
|
"threshold": threshold,
|
|
},
|
|
rate_limit_edit_params.RateLimitEditParams,
|
|
),
|
|
options=make_request_options(
|
|
extra_headers=extra_headers,
|
|
extra_query=extra_query,
|
|
extra_body=extra_body,
|
|
timeout=timeout,
|
|
post_parser=ResultWrapper[RateLimit]._unwrapper,
|
|
),
|
|
cast_to=cast(Type[RateLimit], ResultWrapper[RateLimit]),
|
|
)
|
|
|
|
@typing_extensions.deprecated(
|
|
"Rate limiting API is deprecated in favour of using the Ruleset Engine. See https://developers.cloudflare.com/fundamentals/api/reference/deprecations/#rate-limiting-api-previous-version for full details."
|
|
)
|
|
async def get(
|
|
self,
|
|
rate_limit_id: str,
|
|
*,
|
|
zone_id: str,
|
|
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
|
|
# The extra values given here take precedence over values defined on the client or passed to this method.
|
|
extra_headers: Headers | None = None,
|
|
extra_query: Query | None = None,
|
|
extra_body: Body | None = None,
|
|
timeout: float | httpx.Timeout | None | NotGiven = not_given,
|
|
) -> RateLimit:
|
|
"""
|
|
Fetches the details of a rate limit.
|
|
|
|
Args:
|
|
zone_id: Defines an identifier.
|
|
|
|
rate_limit_id: Defines the unique identifier of the rate limit.
|
|
|
|
extra_headers: Send extra headers
|
|
|
|
extra_query: Add additional query parameters to the request
|
|
|
|
extra_body: Add additional JSON properties to the request
|
|
|
|
timeout: Override the client-level default timeout for this request, in seconds
|
|
"""
|
|
if not zone_id:
|
|
raise ValueError(f"Expected a non-empty value for `zone_id` but received {zone_id!r}")
|
|
if not rate_limit_id:
|
|
raise ValueError(f"Expected a non-empty value for `rate_limit_id` but received {rate_limit_id!r}")
|
|
return await self._get(
|
|
f"/zones/{zone_id}/rate_limits/{rate_limit_id}",
|
|
options=make_request_options(
|
|
extra_headers=extra_headers,
|
|
extra_query=extra_query,
|
|
extra_body=extra_body,
|
|
timeout=timeout,
|
|
post_parser=ResultWrapper[RateLimit]._unwrapper,
|
|
),
|
|
cast_to=cast(Type[RateLimit], ResultWrapper[RateLimit]),
|
|
)
|
|
|
|
|
|
class RateLimitsResourceWithRawResponse:
|
|
def __init__(self, rate_limits: RateLimitsResource) -> None:
|
|
self._rate_limits = rate_limits
|
|
|
|
self.create = ( # pyright: ignore[reportDeprecated]
|
|
to_raw_response_wrapper(
|
|
rate_limits.create, # pyright: ignore[reportDeprecated],
|
|
)
|
|
)
|
|
self.list = ( # pyright: ignore[reportDeprecated]
|
|
to_raw_response_wrapper(
|
|
rate_limits.list, # pyright: ignore[reportDeprecated],
|
|
)
|
|
)
|
|
self.delete = ( # pyright: ignore[reportDeprecated]
|
|
to_raw_response_wrapper(
|
|
rate_limits.delete, # pyright: ignore[reportDeprecated],
|
|
)
|
|
)
|
|
self.edit = ( # pyright: ignore[reportDeprecated]
|
|
to_raw_response_wrapper(
|
|
rate_limits.edit, # pyright: ignore[reportDeprecated],
|
|
)
|
|
)
|
|
self.get = ( # pyright: ignore[reportDeprecated]
|
|
to_raw_response_wrapper(
|
|
rate_limits.get, # pyright: ignore[reportDeprecated],
|
|
)
|
|
)
|
|
|
|
|
|
class AsyncRateLimitsResourceWithRawResponse:
|
|
def __init__(self, rate_limits: AsyncRateLimitsResource) -> None:
|
|
self._rate_limits = rate_limits
|
|
|
|
self.create = ( # pyright: ignore[reportDeprecated]
|
|
async_to_raw_response_wrapper(
|
|
rate_limits.create, # pyright: ignore[reportDeprecated],
|
|
)
|
|
)
|
|
self.list = ( # pyright: ignore[reportDeprecated]
|
|
async_to_raw_response_wrapper(
|
|
rate_limits.list, # pyright: ignore[reportDeprecated],
|
|
)
|
|
)
|
|
self.delete = ( # pyright: ignore[reportDeprecated]
|
|
async_to_raw_response_wrapper(
|
|
rate_limits.delete, # pyright: ignore[reportDeprecated],
|
|
)
|
|
)
|
|
self.edit = ( # pyright: ignore[reportDeprecated]
|
|
async_to_raw_response_wrapper(
|
|
rate_limits.edit, # pyright: ignore[reportDeprecated],
|
|
)
|
|
)
|
|
self.get = ( # pyright: ignore[reportDeprecated]
|
|
async_to_raw_response_wrapper(
|
|
rate_limits.get, # pyright: ignore[reportDeprecated],
|
|
)
|
|
)
|
|
|
|
|
|
class RateLimitsResourceWithStreamingResponse:
|
|
def __init__(self, rate_limits: RateLimitsResource) -> None:
|
|
self._rate_limits = rate_limits
|
|
|
|
self.create = ( # pyright: ignore[reportDeprecated]
|
|
to_streamed_response_wrapper(
|
|
rate_limits.create, # pyright: ignore[reportDeprecated],
|
|
)
|
|
)
|
|
self.list = ( # pyright: ignore[reportDeprecated]
|
|
to_streamed_response_wrapper(
|
|
rate_limits.list, # pyright: ignore[reportDeprecated],
|
|
)
|
|
)
|
|
self.delete = ( # pyright: ignore[reportDeprecated]
|
|
to_streamed_response_wrapper(
|
|
rate_limits.delete, # pyright: ignore[reportDeprecated],
|
|
)
|
|
)
|
|
self.edit = ( # pyright: ignore[reportDeprecated]
|
|
to_streamed_response_wrapper(
|
|
rate_limits.edit, # pyright: ignore[reportDeprecated],
|
|
)
|
|
)
|
|
self.get = ( # pyright: ignore[reportDeprecated]
|
|
to_streamed_response_wrapper(
|
|
rate_limits.get, # pyright: ignore[reportDeprecated],
|
|
)
|
|
)
|
|
|
|
|
|
class AsyncRateLimitsResourceWithStreamingResponse:
|
|
def __init__(self, rate_limits: AsyncRateLimitsResource) -> None:
|
|
self._rate_limits = rate_limits
|
|
|
|
self.create = ( # pyright: ignore[reportDeprecated]
|
|
async_to_streamed_response_wrapper(
|
|
rate_limits.create, # pyright: ignore[reportDeprecated],
|
|
)
|
|
)
|
|
self.list = ( # pyright: ignore[reportDeprecated]
|
|
async_to_streamed_response_wrapper(
|
|
rate_limits.list, # pyright: ignore[reportDeprecated],
|
|
)
|
|
)
|
|
self.delete = ( # pyright: ignore[reportDeprecated]
|
|
async_to_streamed_response_wrapper(
|
|
rate_limits.delete, # pyright: ignore[reportDeprecated],
|
|
)
|
|
)
|
|
self.edit = ( # pyright: ignore[reportDeprecated]
|
|
async_to_streamed_response_wrapper(
|
|
rate_limits.edit, # pyright: ignore[reportDeprecated],
|
|
)
|
|
)
|
|
self.get = ( # pyright: ignore[reportDeprecated]
|
|
async_to_streamed_response_wrapper(
|
|
rate_limits.get, # pyright: ignore[reportDeprecated],
|
|
)
|
|
)
|