mirror of
https://github.com/cloudflare/cloudflare-python.git
synced 2026-01-16 23:01:03 +00:00
383 lines
14 KiB
Python
383 lines
14 KiB
Python
# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
|
|
from __future__ import annotations
|
|
|
|
from typing import Any, Optional, cast
|
|
|
|
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 ..._base_client import make_request_options
|
|
from ...types.stream import webhook_update_params
|
|
from ...types.stream.webhook_get_response import WebhookGetResponse
|
|
from ...types.stream.webhook_delete_response import WebhookDeleteResponse
|
|
from ...types.stream.webhook_update_response import WebhookUpdateResponse
|
|
|
|
__all__ = ["WebhooksResource", "AsyncWebhooksResource"]
|
|
|
|
|
|
class WebhooksResource(SyncAPIResource):
|
|
@cached_property
|
|
def with_raw_response(self) -> WebhooksResourceWithRawResponse:
|
|
return WebhooksResourceWithRawResponse(self)
|
|
|
|
@cached_property
|
|
def with_streaming_response(self) -> WebhooksResourceWithStreamingResponse:
|
|
return WebhooksResourceWithStreamingResponse(self)
|
|
|
|
def update(
|
|
self,
|
|
*,
|
|
account_id: str,
|
|
notification_url: 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[WebhookUpdateResponse]:
|
|
"""
|
|
Creates a webhook notification.
|
|
|
|
Args:
|
|
account_id: The account identifier tag.
|
|
|
|
notification_url: The URL where webhooks will be sent.
|
|
|
|
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 cast(
|
|
Optional[WebhookUpdateResponse],
|
|
self._put(
|
|
f"/accounts/{account_id}/stream/webhook",
|
|
body=maybe_transform({"notification_url": notification_url}, webhook_update_params.WebhookUpdateParams),
|
|
options=make_request_options(
|
|
extra_headers=extra_headers,
|
|
extra_query=extra_query,
|
|
extra_body=extra_body,
|
|
timeout=timeout,
|
|
post_parser=ResultWrapper[Optional[WebhookUpdateResponse]]._unwrapper,
|
|
),
|
|
cast_to=cast(
|
|
Any, ResultWrapper[WebhookUpdateResponse]
|
|
), # Union types cannot be passed in as arguments in the type system
|
|
),
|
|
)
|
|
|
|
def delete(
|
|
self,
|
|
*,
|
|
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[WebhookDeleteResponse]:
|
|
"""
|
|
Deletes a webhook.
|
|
|
|
Args:
|
|
account_id: The account 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}")
|
|
return cast(
|
|
Optional[WebhookDeleteResponse],
|
|
self._delete(
|
|
f"/accounts/{account_id}/stream/webhook",
|
|
options=make_request_options(
|
|
extra_headers=extra_headers,
|
|
extra_query=extra_query,
|
|
extra_body=extra_body,
|
|
timeout=timeout,
|
|
post_parser=ResultWrapper[Optional[WebhookDeleteResponse]]._unwrapper,
|
|
),
|
|
cast_to=cast(
|
|
Any, ResultWrapper[WebhookDeleteResponse]
|
|
), # Union types cannot be passed in as arguments in the type system
|
|
),
|
|
)
|
|
|
|
def get(
|
|
self,
|
|
*,
|
|
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[WebhookGetResponse]:
|
|
"""
|
|
Retrieves a list of webhooks.
|
|
|
|
Args:
|
|
account_id: The account 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}")
|
|
return cast(
|
|
Optional[WebhookGetResponse],
|
|
self._get(
|
|
f"/accounts/{account_id}/stream/webhook",
|
|
options=make_request_options(
|
|
extra_headers=extra_headers,
|
|
extra_query=extra_query,
|
|
extra_body=extra_body,
|
|
timeout=timeout,
|
|
post_parser=ResultWrapper[Optional[WebhookGetResponse]]._unwrapper,
|
|
),
|
|
cast_to=cast(
|
|
Any, ResultWrapper[WebhookGetResponse]
|
|
), # Union types cannot be passed in as arguments in the type system
|
|
),
|
|
)
|
|
|
|
|
|
class AsyncWebhooksResource(AsyncAPIResource):
|
|
@cached_property
|
|
def with_raw_response(self) -> AsyncWebhooksResourceWithRawResponse:
|
|
return AsyncWebhooksResourceWithRawResponse(self)
|
|
|
|
@cached_property
|
|
def with_streaming_response(self) -> AsyncWebhooksResourceWithStreamingResponse:
|
|
return AsyncWebhooksResourceWithStreamingResponse(self)
|
|
|
|
async def update(
|
|
self,
|
|
*,
|
|
account_id: str,
|
|
notification_url: 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[WebhookUpdateResponse]:
|
|
"""
|
|
Creates a webhook notification.
|
|
|
|
Args:
|
|
account_id: The account identifier tag.
|
|
|
|
notification_url: The URL where webhooks will be sent.
|
|
|
|
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 cast(
|
|
Optional[WebhookUpdateResponse],
|
|
await self._put(
|
|
f"/accounts/{account_id}/stream/webhook",
|
|
body=await async_maybe_transform(
|
|
{"notification_url": notification_url}, webhook_update_params.WebhookUpdateParams
|
|
),
|
|
options=make_request_options(
|
|
extra_headers=extra_headers,
|
|
extra_query=extra_query,
|
|
extra_body=extra_body,
|
|
timeout=timeout,
|
|
post_parser=ResultWrapper[Optional[WebhookUpdateResponse]]._unwrapper,
|
|
),
|
|
cast_to=cast(
|
|
Any, ResultWrapper[WebhookUpdateResponse]
|
|
), # Union types cannot be passed in as arguments in the type system
|
|
),
|
|
)
|
|
|
|
async def delete(
|
|
self,
|
|
*,
|
|
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[WebhookDeleteResponse]:
|
|
"""
|
|
Deletes a webhook.
|
|
|
|
Args:
|
|
account_id: The account 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}")
|
|
return cast(
|
|
Optional[WebhookDeleteResponse],
|
|
await self._delete(
|
|
f"/accounts/{account_id}/stream/webhook",
|
|
options=make_request_options(
|
|
extra_headers=extra_headers,
|
|
extra_query=extra_query,
|
|
extra_body=extra_body,
|
|
timeout=timeout,
|
|
post_parser=ResultWrapper[Optional[WebhookDeleteResponse]]._unwrapper,
|
|
),
|
|
cast_to=cast(
|
|
Any, ResultWrapper[WebhookDeleteResponse]
|
|
), # Union types cannot be passed in as arguments in the type system
|
|
),
|
|
)
|
|
|
|
async def get(
|
|
self,
|
|
*,
|
|
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[WebhookGetResponse]:
|
|
"""
|
|
Retrieves a list of webhooks.
|
|
|
|
Args:
|
|
account_id: The account 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}")
|
|
return cast(
|
|
Optional[WebhookGetResponse],
|
|
await self._get(
|
|
f"/accounts/{account_id}/stream/webhook",
|
|
options=make_request_options(
|
|
extra_headers=extra_headers,
|
|
extra_query=extra_query,
|
|
extra_body=extra_body,
|
|
timeout=timeout,
|
|
post_parser=ResultWrapper[Optional[WebhookGetResponse]]._unwrapper,
|
|
),
|
|
cast_to=cast(
|
|
Any, ResultWrapper[WebhookGetResponse]
|
|
), # Union types cannot be passed in as arguments in the type system
|
|
),
|
|
)
|
|
|
|
|
|
class WebhooksResourceWithRawResponse:
|
|
def __init__(self, webhooks: WebhooksResource) -> None:
|
|
self._webhooks = webhooks
|
|
|
|
self.update = to_raw_response_wrapper(
|
|
webhooks.update,
|
|
)
|
|
self.delete = to_raw_response_wrapper(
|
|
webhooks.delete,
|
|
)
|
|
self.get = to_raw_response_wrapper(
|
|
webhooks.get,
|
|
)
|
|
|
|
|
|
class AsyncWebhooksResourceWithRawResponse:
|
|
def __init__(self, webhooks: AsyncWebhooksResource) -> None:
|
|
self._webhooks = webhooks
|
|
|
|
self.update = async_to_raw_response_wrapper(
|
|
webhooks.update,
|
|
)
|
|
self.delete = async_to_raw_response_wrapper(
|
|
webhooks.delete,
|
|
)
|
|
self.get = async_to_raw_response_wrapper(
|
|
webhooks.get,
|
|
)
|
|
|
|
|
|
class WebhooksResourceWithStreamingResponse:
|
|
def __init__(self, webhooks: WebhooksResource) -> None:
|
|
self._webhooks = webhooks
|
|
|
|
self.update = to_streamed_response_wrapper(
|
|
webhooks.update,
|
|
)
|
|
self.delete = to_streamed_response_wrapper(
|
|
webhooks.delete,
|
|
)
|
|
self.get = to_streamed_response_wrapper(
|
|
webhooks.get,
|
|
)
|
|
|
|
|
|
class AsyncWebhooksResourceWithStreamingResponse:
|
|
def __init__(self, webhooks: AsyncWebhooksResource) -> None:
|
|
self._webhooks = webhooks
|
|
|
|
self.update = async_to_streamed_response_wrapper(
|
|
webhooks.update,
|
|
)
|
|
self.delete = async_to_streamed_response_wrapper(
|
|
webhooks.delete,
|
|
)
|
|
self.get = async_to_streamed_response_wrapper(
|
|
webhooks.get,
|
|
)
|