kgess-mirror/cloudflare-python
1
0
Fork 0
mirror of https://github.com/cloudflare/cloudflare-python.git synced 2026-01-16 23:01:03 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2
cloudflare-python/src/cloudflare/resources/turnstile/widgets.py
stainless-app[bot] 29147073fa feat(api): api update
2025-05-14 16:30:11 +00:00

943 lines
36 KiB
Python
Raw Permalink Blame History

# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
from __future__ import annotations
from typing import List, Type, Optional, cast
from typing_extensions import Literal
import httpx
from ..._types import NOT_GIVEN, Body, Query, Headers, NotGiven
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.turnstile import (
widget_list_params,
widget_create_params,
widget_update_params,
widget_rotate_secret_params,
)
from ...types.turnstile.widget import Widget
from ...types.turnstile.widget_domain import WidgetDomain
from ...types.turnstile.widget_list_response import WidgetListResponse
__all__ = ["WidgetsResource", "AsyncWidgetsResource"]
class WidgetsResource(SyncAPIResource):
@cached_property
def with_raw_response(self) -> WidgetsResourceWithRawResponse:
"""
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 WidgetsResourceWithRawResponse(self)
@cached_property
def with_streaming_response(self) -> WidgetsResourceWithStreamingResponse:
"""
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 WidgetsResourceWithStreamingResponse(self)
def create(
self,
*,
account_id: str,
domains: List[WidgetDomain],
mode: Literal["non-interactive", "invisible", "managed"],
name: str,
direction: Literal["asc", "desc"] | NotGiven = NOT_GIVEN,
order: Literal["id", "sitekey", "name", "created_on", "modified_on"] | NotGiven = NOT_GIVEN,
page: float | NotGiven = NOT_GIVEN,
per_page: float | NotGiven = NOT_GIVEN,
bot_fight_mode: bool | NotGiven = NOT_GIVEN,
clearance_level: Literal["no_clearance", "jschallenge", "managed", "interactive"] | NotGiven = NOT_GIVEN,
ephemeral_id: bool | NotGiven = NOT_GIVEN,
offlabel: bool | NotGiven = NOT_GIVEN,
region: Literal["world", "china"] | NotGiven = NOT_GIVEN,
# 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,
) -> Optional[Widget]:
"""
Lists challenge widgets.
Args:
account_id: Identifier
mode: Widget Mode
name: Human readable widget name. Not unique. Cloudflare suggests that you set this to
a meaningful string to make it easier to identify your widget, and where it is
used.
direction: Direction to order widgets.
order: Field to order widgets by.
page: Page number of paginated results.
per_page: Number of items per page.
bot_fight_mode: If bot_fight_mode is set to `true`, Cloudflare issues computationally expensive
challenges in response to malicious bots (ENT only).
clearance_level: If Turnstile is embedded on a Cloudflare site and the widget should grant
challenge clearance, this setting can determine the clearance level to be set
ephemeral_id: Return the Ephemeral ID in /siteverify (ENT only).
offlabel: Do not show any Cloudflare branding on the widget (ENT only).
region: Region where this widget can be used. This cannot be changed after creation.
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 account_id:
raise ValueError(f"Expected a non-empty value for `account_id` but received {account_id!r}")
return self._post(
f"/accounts/{account_id}/challenges/widgets",
body=maybe_transform(
{
"domains": domains,
"mode": mode,
"name": name,
"bot_fight_mode": bot_fight_mode,
"clearance_level": clearance_level,
"ephemeral_id": ephemeral_id,
"offlabel": offlabel,
"region": region,
},
widget_create_params.WidgetCreateParams,
),
options=make_request_options(
extra_headers=extra_headers,
extra_query=extra_query,
extra_body=extra_body,
timeout=timeout,
query=maybe_transform(
{
"direction": direction,
"order": order,
"page": page,
"per_page": per_page,
},
widget_create_params.WidgetCreateParams,
),
post_parser=ResultWrapper[Optional[Widget]]._unwrapper,
),
cast_to=cast(Type[Optional[Widget]], ResultWrapper[Widget]),
)
def update(
self,
sitekey: str,
*,
account_id: str,
domains: List[WidgetDomain],
mode: Literal["non-interactive", "invisible", "managed"],
name: str,
bot_fight_mode: bool | NotGiven = NOT_GIVEN,
clearance_level: Literal["no_clearance", "jschallenge", "managed", "interactive"] | NotGiven = NOT_GIVEN,
ephemeral_id: bool | NotGiven = NOT_GIVEN,
offlabel: bool | NotGiven = NOT_GIVEN,
region: Literal["world", "china"] | NotGiven = NOT_GIVEN,
# 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,
) -> Optional[Widget]:
"""
Update the configuration of a widget.
Args:
account_id: Identifier
sitekey: Widget item identifier tag.
mode: Widget Mode
name: Human readable widget name. Not unique. Cloudflare suggests that you set this to
a meaningful string to make it easier to identify your widget, and where it is
used.
bot_fight_mode: If bot_fight_mode is set to `true`, Cloudflare issues computationally expensive
challenges in response to malicious bots (ENT only).
clearance_level: If Turnstile is embedded on a Cloudflare site and the widget should grant
challenge clearance, this setting can determine the clearance level to be set
ephemeral_id: Return the Ephemeral ID in /siteverify (ENT only).
offlabel: Do not show any Cloudflare branding on the widget (ENT only).
region: Region where this widget can be used. This cannot be changed after creation.
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 account_id:
raise ValueError(f"Expected a non-empty value for `account_id` but received {account_id!r}")
if not sitekey:
raise ValueError(f"Expected a non-empty value for `sitekey` but received {sitekey!r}")
return self._put(
f"/accounts/{account_id}/challenges/widgets/{sitekey}",
body=maybe_transform(
{
"domains": domains,
"mode": mode,
"name": name,
"bot_fight_mode": bot_fight_mode,
"clearance_level": clearance_level,
"ephemeral_id": ephemeral_id,
"offlabel": offlabel,
"region": region,
},
widget_update_params.WidgetUpdateParams,
),
options=make_request_options(
extra_headers=extra_headers,
extra_query=extra_query,
extra_body=extra_body,
timeout=timeout,
post_parser=ResultWrapper[Optional[Widget]]._unwrapper,
),
cast_to=cast(Type[Optional[Widget]], ResultWrapper[Widget]),
)
def list(
self,
*,
account_id: str,
direction: Literal["asc", "desc"] | NotGiven = NOT_GIVEN,
order: Literal["id", "sitekey", "name", "created_on", "modified_on"] | NotGiven = NOT_GIVEN,
page: float | NotGiven = NOT_GIVEN,
per_page: float | NotGiven = NOT_GIVEN,
# 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[WidgetListResponse]:
"""
Lists all turnstile widgets of an account.
Args:
account_id: Identifier
direction: Direction to order widgets.
order: Field to order widgets by.
page: Page number of paginated results.
per_page: Number of items per page.
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 account_id:
raise ValueError(f"Expected a non-empty value for `account_id` but received {account_id!r}")
return self._get_api_list(
f"/accounts/{account_id}/challenges/widgets",
page=SyncV4PagePaginationArray[WidgetListResponse],
options=make_request_options(
extra_headers=extra_headers,
extra_query=extra_query,
extra_body=extra_body,
timeout=timeout,
query=maybe_transform(
{
"direction": direction,
"order": order,
"page": page,
"per_page": per_page,
},
widget_list_params.WidgetListParams,
),
),
model=WidgetListResponse,
)
def delete(
self,
sitekey: str,
*,
account_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,
) -> Optional[Widget]:
"""
Destroy a Turnstile Widget.
Args:
account_id: Identifier
sitekey: Widget item identifier tag.
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 account_id:
raise ValueError(f"Expected a non-empty value for `account_id` but received {account_id!r}")
if not sitekey:
raise ValueError(f"Expected a non-empty value for `sitekey` but received {sitekey!r}")
return self._delete(
f"/accounts/{account_id}/challenges/widgets/{sitekey}",
options=make_request_options(
extra_headers=extra_headers,
extra_query=extra_query,
extra_body=extra_body,
timeout=timeout,
post_parser=ResultWrapper[Optional[Widget]]._unwrapper,
),
cast_to=cast(Type[Optional[Widget]], ResultWrapper[Widget]),
)
def get(
self,
sitekey: str,
*,
account_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,
) -> Optional[Widget]:
"""
Show a single challenge widget configuration.
Args:
account_id: Identifier
sitekey: Widget item identifier tag.
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 account_id:
raise ValueError(f"Expected a non-empty value for `account_id` but received {account_id!r}")
if not sitekey:
raise ValueError(f"Expected a non-empty value for `sitekey` but received {sitekey!r}")
return self._get(
f"/accounts/{account_id}/challenges/widgets/{sitekey}",
options=make_request_options(
extra_headers=extra_headers,
extra_query=extra_query,
extra_body=extra_body,
timeout=timeout,
post_parser=ResultWrapper[Optional[Widget]]._unwrapper,
),
cast_to=cast(Type[Optional[Widget]], ResultWrapper[Widget]),
)
def rotate_secret(
self,
sitekey: str,
*,
account_id: str,
invalidate_immediately: bool | NotGiven = NOT_GIVEN,
# 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,
) -> Optional[Widget]:
"""Generate a new secret key for this widget.
If `invalidate_immediately` is set to
`false`, the previous secret remains valid for 2 hours.
Note that secrets cannot be rotated again during the grace period.
Args:
account_id: Identifier
sitekey: Widget item identifier tag.
invalidate_immediately: If `invalidate_immediately` is set to `false`, the previous secret will remain
valid for two hours. Otherwise, the secret is immediately invalidated, and
requests using it will be rejected.
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 account_id:
raise ValueError(f"Expected a non-empty value for `account_id` but received {account_id!r}")
if not sitekey:
raise ValueError(f"Expected a non-empty value for `sitekey` but received {sitekey!r}")
return self._post(
f"/accounts/{account_id}/challenges/widgets/{sitekey}/rotate_secret",
body=maybe_transform(
{"invalidate_immediately": invalidate_immediately}, widget_rotate_secret_params.WidgetRotateSecretParams
),
options=make_request_options(
extra_headers=extra_headers,
extra_query=extra_query,
extra_body=extra_body,
timeout=timeout,
post_parser=ResultWrapper[Optional[Widget]]._unwrapper,
),
cast_to=cast(Type[Optional[Widget]], ResultWrapper[Widget]),
)
class AsyncWidgetsResource(AsyncAPIResource):
@cached_property
def with_raw_response(self) -> AsyncWidgetsResourceWithRawResponse:
"""
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 AsyncWidgetsResourceWithRawResponse(self)
@cached_property
def with_streaming_response(self) -> AsyncWidgetsResourceWithStreamingResponse:
"""
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 AsyncWidgetsResourceWithStreamingResponse(self)
async def create(
self,
*,
account_id: str,
domains: List[WidgetDomain],
mode: Literal["non-interactive", "invisible", "managed"],
name: str,
direction: Literal["asc", "desc"] | NotGiven = NOT_GIVEN,
order: Literal["id", "sitekey", "name", "created_on", "modified_on"] | NotGiven = NOT_GIVEN,
page: float | NotGiven = NOT_GIVEN,
per_page: float | NotGiven = NOT_GIVEN,
bot_fight_mode: bool | NotGiven = NOT_GIVEN,
clearance_level: Literal["no_clearance", "jschallenge", "managed", "interactive"] | NotGiven = NOT_GIVEN,
ephemeral_id: bool | NotGiven = NOT_GIVEN,
offlabel: bool | NotGiven = NOT_GIVEN,
region: Literal["world", "china"] | NotGiven = NOT_GIVEN,
# 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,
) -> Optional[Widget]:
"""
Lists challenge widgets.
Args:
account_id: Identifier
mode: Widget Mode
name: Human readable widget name. Not unique. Cloudflare suggests that you set this to
a meaningful string to make it easier to identify your widget, and where it is
used.
direction: Direction to order widgets.
order: Field to order widgets by.
page: Page number of paginated results.
per_page: Number of items per page.
bot_fight_mode: If bot_fight_mode is set to `true`, Cloudflare issues computationally expensive
challenges in response to malicious bots (ENT only).
clearance_level: If Turnstile is embedded on a Cloudflare site and the widget should grant
challenge clearance, this setting can determine the clearance level to be set
ephemeral_id: Return the Ephemeral ID in /siteverify (ENT only).
offlabel: Do not show any Cloudflare branding on the widget (ENT only).
region: Region where this widget can be used. This cannot be changed after creation.
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 account_id:
raise ValueError(f"Expected a non-empty value for `account_id` but received {account_id!r}")
return await self._post(
f"/accounts/{account_id}/challenges/widgets",
body=await async_maybe_transform(
{
"domains": domains,
"mode": mode,
"name": name,
"bot_fight_mode": bot_fight_mode,
"clearance_level": clearance_level,
"ephemeral_id": ephemeral_id,
"offlabel": offlabel,
"region": region,
},
widget_create_params.WidgetCreateParams,
),
options=make_request_options(
extra_headers=extra_headers,
extra_query=extra_query,
extra_body=extra_body,
timeout=timeout,
query=await async_maybe_transform(
{
"direction": direction,
"order": order,
"page": page,
"per_page": per_page,
},
widget_create_params.WidgetCreateParams,
),
post_parser=ResultWrapper[Optional[Widget]]._unwrapper,
),
cast_to=cast(Type[Optional[Widget]], ResultWrapper[Widget]),
)
async def update(
self,
sitekey: str,
*,
account_id: str,
domains: List[WidgetDomain],
mode: Literal["non-interactive", "invisible", "managed"],
name: str,
bot_fight_mode: bool | NotGiven = NOT_GIVEN,
clearance_level: Literal["no_clearance", "jschallenge", "managed", "interactive"] | NotGiven = NOT_GIVEN,
ephemeral_id: bool | NotGiven = NOT_GIVEN,
offlabel: bool | NotGiven = NOT_GIVEN,
region: Literal["world", "china"] | NotGiven = NOT_GIVEN,
# 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,
) -> Optional[Widget]:
"""
Update the configuration of a widget.
Args:
account_id: Identifier
sitekey: Widget item identifier tag.
mode: Widget Mode
name: Human readable widget name. Not unique. Cloudflare suggests that you set this to
a meaningful string to make it easier to identify your widget, and where it is
used.
bot_fight_mode: If bot_fight_mode is set to `true`, Cloudflare issues computationally expensive
challenges in response to malicious bots (ENT only).
clearance_level: If Turnstile is embedded on a Cloudflare site and the widget should grant
challenge clearance, this setting can determine the clearance level to be set
ephemeral_id: Return the Ephemeral ID in /siteverify (ENT only).
offlabel: Do not show any Cloudflare branding on the widget (ENT only).
region: Region where this widget can be used. This cannot be changed after creation.
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 account_id:
raise ValueError(f"Expected a non-empty value for `account_id` but received {account_id!r}")
if not sitekey:
raise ValueError(f"Expected a non-empty value for `sitekey` but received {sitekey!r}")
return await self._put(
f"/accounts/{account_id}/challenges/widgets/{sitekey}",
body=await async_maybe_transform(
{
"domains": domains,
"mode": mode,
"name": name,
"bot_fight_mode": bot_fight_mode,
"clearance_level": clearance_level,
"ephemeral_id": ephemeral_id,
"offlabel": offlabel,
"region": region,
},
widget_update_params.WidgetUpdateParams,
),
options=make_request_options(
extra_headers=extra_headers,
extra_query=extra_query,
extra_body=extra_body,
timeout=timeout,
post_parser=ResultWrapper[Optional[Widget]]._unwrapper,
),
cast_to=cast(Type[Optional[Widget]], ResultWrapper[Widget]),
)
def list(
self,
*,
account_id: str,
direction: Literal["asc", "desc"] | NotGiven = NOT_GIVEN,
order: Literal["id", "sitekey", "name", "created_on", "modified_on"] | NotGiven = NOT_GIVEN,
page: float | NotGiven = NOT_GIVEN,
per_page: float | NotGiven = NOT_GIVEN,
# 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[WidgetListResponse, AsyncV4PagePaginationArray[WidgetListResponse]]:
"""
Lists all turnstile widgets of an account.
Args:
account_id: Identifier
direction: Direction to order widgets.
order: Field to order widgets by.
page: Page number of paginated results.
per_page: Number of items per page.
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 account_id:
raise ValueError(f"Expected a non-empty value for `account_id` but received {account_id!r}")
return self._get_api_list(
f"/accounts/{account_id}/challenges/widgets",
page=AsyncV4PagePaginationArray[WidgetListResponse],
options=make_request_options(
extra_headers=extra_headers,
extra_query=extra_query,
extra_body=extra_body,
timeout=timeout,
query=maybe_transform(
{
"direction": direction,
"order": order,
"page": page,
"per_page": per_page,
},
widget_list_params.WidgetListParams,
),
),
model=WidgetListResponse,
)
async def delete(
self,
sitekey: str,
*,
account_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,
) -> Optional[Widget]:
"""
Destroy a Turnstile Widget.
Args:
account_id: Identifier
sitekey: Widget item identifier tag.
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 account_id:
raise ValueError(f"Expected a non-empty value for `account_id` but received {account_id!r}")
if not sitekey:
raise ValueError(f"Expected a non-empty value for `sitekey` but received {sitekey!r}")
return await self._delete(
f"/accounts/{account_id}/challenges/widgets/{sitekey}",
options=make_request_options(
extra_headers=extra_headers,
extra_query=extra_query,
extra_body=extra_body,
timeout=timeout,
post_parser=ResultWrapper[Optional[Widget]]._unwrapper,
),
cast_to=cast(Type[Optional[Widget]], ResultWrapper[Widget]),
)
async def get(
self,
sitekey: str,
*,
account_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,
) -> Optional[Widget]:
"""
Show a single challenge widget configuration.
Args:
account_id: Identifier
sitekey: Widget item identifier tag.
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 account_id:
raise ValueError(f"Expected a non-empty value for `account_id` but received {account_id!r}")
if not sitekey:
raise ValueError(f"Expected a non-empty value for `sitekey` but received {sitekey!r}")
return await self._get(
f"/accounts/{account_id}/challenges/widgets/{sitekey}",
options=make_request_options(
extra_headers=extra_headers,
extra_query=extra_query,
extra_body=extra_body,
timeout=timeout,
post_parser=ResultWrapper[Optional[Widget]]._unwrapper,
),
cast_to=cast(Type[Optional[Widget]], ResultWrapper[Widget]),
)
async def rotate_secret(
self,
sitekey: str,
*,
account_id: str,
invalidate_immediately: bool | NotGiven = NOT_GIVEN,
# 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,
) -> Optional[Widget]:
"""Generate a new secret key for this widget.
If `invalidate_immediately` is set to
`false`, the previous secret remains valid for 2 hours.
Note that secrets cannot be rotated again during the grace period.
Args:
account_id: Identifier
sitekey: Widget item identifier tag.
invalidate_immediately: If `invalidate_immediately` is set to `false`, the previous secret will remain
valid for two hours. Otherwise, the secret is immediately invalidated, and
requests using it will be rejected.
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 account_id:
raise ValueError(f"Expected a non-empty value for `account_id` but received {account_id!r}")
if not sitekey:
raise ValueError(f"Expected a non-empty value for `sitekey` but received {sitekey!r}")
return await self._post(
f"/accounts/{account_id}/challenges/widgets/{sitekey}/rotate_secret",
body=await async_maybe_transform(
{"invalidate_immediately": invalidate_immediately}, widget_rotate_secret_params.WidgetRotateSecretParams
),
options=make_request_options(
extra_headers=extra_headers,
extra_query=extra_query,
extra_body=extra_body,
timeout=timeout,
post_parser=ResultWrapper[Optional[Widget]]._unwrapper,
),
cast_to=cast(Type[Optional[Widget]], ResultWrapper[Widget]),
)
class WidgetsResourceWithRawResponse:
def __init__(self, widgets: WidgetsResource) -> None:
self._widgets = widgets
self.create = to_raw_response_wrapper(
widgets.create,
)
self.update = to_raw_response_wrapper(
widgets.update,
)
self.list = to_raw_response_wrapper(
widgets.list,
)
self.delete = to_raw_response_wrapper(
widgets.delete,
)
self.get = to_raw_response_wrapper(
widgets.get,
)
self.rotate_secret = to_raw_response_wrapper(
widgets.rotate_secret,
)
class AsyncWidgetsResourceWithRawResponse:
def __init__(self, widgets: AsyncWidgetsResource) -> None:
self._widgets = widgets
self.create = async_to_raw_response_wrapper(
widgets.create,
)
self.update = async_to_raw_response_wrapper(
widgets.update,
)
self.list = async_to_raw_response_wrapper(
widgets.list,
)
self.delete = async_to_raw_response_wrapper(
widgets.delete,
)
self.get = async_to_raw_response_wrapper(
widgets.get,
)
self.rotate_secret = async_to_raw_response_wrapper(
widgets.rotate_secret,
)
class WidgetsResourceWithStreamingResponse:
def __init__(self, widgets: WidgetsResource) -> None:
self._widgets = widgets
self.create = to_streamed_response_wrapper(
widgets.create,
)
self.update = to_streamed_response_wrapper(
widgets.update,
)
self.list = to_streamed_response_wrapper(
widgets.list,
)
self.delete = to_streamed_response_wrapper(
widgets.delete,
)
self.get = to_streamed_response_wrapper(
widgets.get,
)
self.rotate_secret = to_streamed_response_wrapper(
widgets.rotate_secret,
)
class AsyncWidgetsResourceWithStreamingResponse:
def __init__(self, widgets: AsyncWidgetsResource) -> None:
self._widgets = widgets
self.create = async_to_streamed_response_wrapper(
widgets.create,
)
self.update = async_to_streamed_response_wrapper(
widgets.update,
)
self.list = async_to_streamed_response_wrapper(
widgets.list,
)
self.delete = async_to_streamed_response_wrapper(
widgets.delete,
)
self.get = async_to_streamed_response_wrapper(
widgets.get,
)
self.rotate_secret = async_to_streamed_response_wrapper(
widgets.rotate_secret,
)
Reference in a new issue View git blame Copy permalink