dodopayments 1.44.0__py3-none-any.whl → 1.47.0__py3-none-any.whl

dodopayments/resources/webhooks/webhooks.py

@@ -0,0 +1,676 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Dict, List, Optional
+
+import httpx
+
+from ...types import webhook_list_params, webhook_create_params, webhook_update_params
+from .headers import (
+    HeadersResource,
+    AsyncHeadersResource,
+    HeadersResourceWithRawResponse,
+    AsyncHeadersResourceWithRawResponse,
+    HeadersResourceWithStreamingResponse,
+    AsyncHeadersResourceWithStreamingResponse,
+)
+from ..._types import NOT_GIVEN, Body, Query, Headers, NoneType, 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 ...pagination import SyncCursorPagePagination, AsyncCursorPagePagination
+from ..._base_client import AsyncPaginator, make_request_options
+from ...types.webhook_event_type import WebhookEventType
+from ...types.webhook_list_response import WebhookListResponse
+from ...types.webhook_create_response import WebhookCreateResponse
+from ...types.webhook_update_response import WebhookUpdateResponse
+from ...types.webhook_retrieve_response import WebhookRetrieveResponse
+
+__all__ = ["WebhooksResource", "AsyncWebhooksResource"]
+
+
+class WebhooksResource(SyncAPIResource):
+    @cached_property
+    def headers(self) -> HeadersResource:
+        return HeadersResource(self._client)
+
+    @cached_property
+    def with_raw_response(self) -> WebhooksResourceWithRawResponse:
+        """
+        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/dodopayments/dodopayments-python#accessing-raw-response-data-eg-headers
+        """
+        return WebhooksResourceWithRawResponse(self)
+
+    @cached_property
+    def with_streaming_response(self) -> WebhooksResourceWithStreamingResponse:
+        """
+        An alternative to `.with_raw_response` that doesn't eagerly read the response body.
+
+        For more information, see https://www.github.com/dodopayments/dodopayments-python#with_streaming_response
+        """
+        return WebhooksResourceWithStreamingResponse(self)
+
+    def create(
+        self,
+        *,
+        url: str,
+        description: Optional[str] | NotGiven = NOT_GIVEN,
+        disabled: Optional[bool] | NotGiven = NOT_GIVEN,
+        filter_types: List[WebhookEventType] | NotGiven = NOT_GIVEN,
+        headers: Optional[Dict[str, str]] | NotGiven = NOT_GIVEN,
+        idempotency_key: Optional[str] | NotGiven = NOT_GIVEN,
+        metadata: Optional[Dict[str, str]] | NotGiven = NOT_GIVEN,
+        rate_limit: Optional[int] | 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,
+    ) -> WebhookCreateResponse:
+        """
+        Create a new webhook
+
+        Args:
+          url: Url of the webhook
+
+          description: Filter events to the webhook.
+
+              Webhook event will only be sent for events in the list.
+
+          disabled: Create the webhook in a disabled state.
+
+              Default is false
+
+          headers: Custom headers to be passed
+
+          idempotency_key: The request's idempotency key
+
+          metadata: Metadata to be passed to the webhook Defaut is {}
+
+          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
+        """
+        return self._post(
+            "/webhooks",
+            body=maybe_transform(
+                {
+                    "url": url,
+                    "description": description,
+                    "disabled": disabled,
+                    "filter_types": filter_types,
+                    "headers": headers,
+                    "idempotency_key": idempotency_key,
+                    "metadata": metadata,
+                    "rate_limit": rate_limit,
+                },
+                webhook_create_params.WebhookCreateParams,
+            ),
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=WebhookCreateResponse,
+        )
+
+    def retrieve(
+        self,
+        webhook_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,
+    ) -> WebhookRetrieveResponse:
+        """
+        Get a webhook by id
+
+        Args:
+          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 webhook_id:
+            raise ValueError(f"Expected a non-empty value for `webhook_id` but received {webhook_id!r}")
+        return self._get(
+            f"/webhooks/{webhook_id}",
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=WebhookRetrieveResponse,
+        )
+
+    def update(
+        self,
+        webhook_id: str,
+        *,
+        description: Optional[str] | NotGiven = NOT_GIVEN,
+        disabled: Optional[bool] | NotGiven = NOT_GIVEN,
+        filter_types: Optional[List[WebhookEventType]] | NotGiven = NOT_GIVEN,
+        metadata: Optional[Dict[str, str]] | NotGiven = NOT_GIVEN,
+        rate_limit: Optional[int] | NotGiven = NOT_GIVEN,
+        url: Optional[str] | 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,
+    ) -> WebhookUpdateResponse:
+        """
+        Patch a webhook by id
+
+        Args:
+          description: Description of the webhook
+
+          disabled: To Disable the endpoint, set it to true.
+
+          filter_types: Filter events to the endpoint.
+
+              Webhook event will only be sent for events in the list.
+
+          metadata: Metadata
+
+          rate_limit: Rate limit
+
+          url: Url endpoint
+
+          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 webhook_id:
+            raise ValueError(f"Expected a non-empty value for `webhook_id` but received {webhook_id!r}")
+        return self._patch(
+            f"/webhooks/{webhook_id}",
+            body=maybe_transform(
+                {
+                    "description": description,
+                    "disabled": disabled,
+                    "filter_types": filter_types,
+                    "metadata": metadata,
+                    "rate_limit": rate_limit,
+                    "url": url,
+                },
+                webhook_update_params.WebhookUpdateParams,
+            ),
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=WebhookUpdateResponse,
+        )
+
+    def list(
+        self,
+        *,
+        iterator: Optional[str] | NotGiven = NOT_GIVEN,
+        limit: Optional[int] | 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,
+    ) -> SyncCursorPagePagination[WebhookListResponse]:
+        """
+        List all webhooks
+
+        Args:
+          iterator: The iterator returned from a prior invocation
+
+          limit: Limit the number of returned items
+
+          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
+        """
+        return self._get_api_list(
+            "/webhooks",
+            page=SyncCursorPagePagination[WebhookListResponse],
+            options=make_request_options(
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+                query=maybe_transform(
+                    {
+                        "iterator": iterator,
+                        "limit": limit,
+                    },
+                    webhook_list_params.WebhookListParams,
+                ),
+            ),
+            model=WebhookListResponse,
+        )
+
+    def delete(
+        self,
+        webhook_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,
+    ) -> None:
+        """
+        Delete a webhook by id
+
+        Args:
+          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 webhook_id:
+            raise ValueError(f"Expected a non-empty value for `webhook_id` but received {webhook_id!r}")
+        extra_headers = {"Accept": "*/*", **(extra_headers or {})}
+        return self._delete(
+            f"/webhooks/{webhook_id}",
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=NoneType,
+        )
+
+
+class AsyncWebhooksResource(AsyncAPIResource):
+    @cached_property
+    def headers(self) -> AsyncHeadersResource:
+        return AsyncHeadersResource(self._client)
+
+    @cached_property
+    def with_raw_response(self) -> AsyncWebhooksResourceWithRawResponse:
+        """
+        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/dodopayments/dodopayments-python#accessing-raw-response-data-eg-headers
+        """
+        return AsyncWebhooksResourceWithRawResponse(self)
+
+    @cached_property
+    def with_streaming_response(self) -> AsyncWebhooksResourceWithStreamingResponse:
+        """
+        An alternative to `.with_raw_response` that doesn't eagerly read the response body.
+
+        For more information, see https://www.github.com/dodopayments/dodopayments-python#with_streaming_response
+        """
+        return AsyncWebhooksResourceWithStreamingResponse(self)
+
+    async def create(
+        self,
+        *,
+        url: str,
+        description: Optional[str] | NotGiven = NOT_GIVEN,
+        disabled: Optional[bool] | NotGiven = NOT_GIVEN,
+        filter_types: List[WebhookEventType] | NotGiven = NOT_GIVEN,
+        headers: Optional[Dict[str, str]] | NotGiven = NOT_GIVEN,
+        idempotency_key: Optional[str] | NotGiven = NOT_GIVEN,
+        metadata: Optional[Dict[str, str]] | NotGiven = NOT_GIVEN,
+        rate_limit: Optional[int] | 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,
+    ) -> WebhookCreateResponse:
+        """
+        Create a new webhook
+
+        Args:
+          url: Url of the webhook
+
+          description: Filter events to the webhook.
+
+              Webhook event will only be sent for events in the list.
+
+          disabled: Create the webhook in a disabled state.
+
+              Default is false
+
+          headers: Custom headers to be passed
+
+          idempotency_key: The request's idempotency key
+
+          metadata: Metadata to be passed to the webhook Defaut is {}
+
+          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
+        """
+        return await self._post(
+            "/webhooks",
+            body=await async_maybe_transform(
+                {
+                    "url": url,
+                    "description": description,
+                    "disabled": disabled,
+                    "filter_types": filter_types,
+                    "headers": headers,
+                    "idempotency_key": idempotency_key,
+                    "metadata": metadata,
+                    "rate_limit": rate_limit,
+                },
+                webhook_create_params.WebhookCreateParams,
+            ),
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=WebhookCreateResponse,
+        )
+
+    async def retrieve(
+        self,
+        webhook_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,
+    ) -> WebhookRetrieveResponse:
+        """
+        Get a webhook by id
+
+        Args:
+          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 webhook_id:
+            raise ValueError(f"Expected a non-empty value for `webhook_id` but received {webhook_id!r}")
+        return await self._get(
+            f"/webhooks/{webhook_id}",
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=WebhookRetrieveResponse,
+        )
+
+    async def update(
+        self,
+        webhook_id: str,
+        *,
+        description: Optional[str] | NotGiven = NOT_GIVEN,
+        disabled: Optional[bool] | NotGiven = NOT_GIVEN,
+        filter_types: Optional[List[WebhookEventType]] | NotGiven = NOT_GIVEN,
+        metadata: Optional[Dict[str, str]] | NotGiven = NOT_GIVEN,
+        rate_limit: Optional[int] | NotGiven = NOT_GIVEN,
+        url: Optional[str] | 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,
+    ) -> WebhookUpdateResponse:
+        """
+        Patch a webhook by id
+
+        Args:
+          description: Description of the webhook
+
+          disabled: To Disable the endpoint, set it to true.
+
+          filter_types: Filter events to the endpoint.
+
+              Webhook event will only be sent for events in the list.
+
+          metadata: Metadata
+
+          rate_limit: Rate limit
+
+          url: Url endpoint
+
+          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 webhook_id:
+            raise ValueError(f"Expected a non-empty value for `webhook_id` but received {webhook_id!r}")
+        return await self._patch(
+            f"/webhooks/{webhook_id}",
+            body=await async_maybe_transform(
+                {
+                    "description": description,
+                    "disabled": disabled,
+                    "filter_types": filter_types,
+                    "metadata": metadata,
+                    "rate_limit": rate_limit,
+                    "url": url,
+                },
+                webhook_update_params.WebhookUpdateParams,
+            ),
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=WebhookUpdateResponse,
+        )
+
+    def list(
+        self,
+        *,
+        iterator: Optional[str] | NotGiven = NOT_GIVEN,
+        limit: Optional[int] | 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[WebhookListResponse, AsyncCursorPagePagination[WebhookListResponse]]:
+        """
+        List all webhooks
+
+        Args:
+          iterator: The iterator returned from a prior invocation
+
+          limit: Limit the number of returned items
+
+          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
+        """
+        return self._get_api_list(
+            "/webhooks",
+            page=AsyncCursorPagePagination[WebhookListResponse],
+            options=make_request_options(
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+                query=maybe_transform(
+                    {
+                        "iterator": iterator,
+                        "limit": limit,
+                    },
+                    webhook_list_params.WebhookListParams,
+                ),
+            ),
+            model=WebhookListResponse,
+        )
+
+    async def delete(
+        self,
+        webhook_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,
+    ) -> None:
+        """
+        Delete a webhook by id
+
+        Args:
+          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 webhook_id:
+            raise ValueError(f"Expected a non-empty value for `webhook_id` but received {webhook_id!r}")
+        extra_headers = {"Accept": "*/*", **(extra_headers or {})}
+        return await self._delete(
+            f"/webhooks/{webhook_id}",
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=NoneType,
+        )
+
+
+class WebhooksResourceWithRawResponse:
+    def __init__(self, webhooks: WebhooksResource) -> None:
+        self._webhooks = webhooks
+
+        self.create = to_raw_response_wrapper(
+            webhooks.create,
+        )
+        self.retrieve = to_raw_response_wrapper(
+            webhooks.retrieve,
+        )
+        self.update = to_raw_response_wrapper(
+            webhooks.update,
+        )
+        self.list = to_raw_response_wrapper(
+            webhooks.list,
+        )
+        self.delete = to_raw_response_wrapper(
+            webhooks.delete,
+        )
+
+    @cached_property
+    def headers(self) -> HeadersResourceWithRawResponse:
+        return HeadersResourceWithRawResponse(self._webhooks.headers)
+
+
+class AsyncWebhooksResourceWithRawResponse:
+    def __init__(self, webhooks: AsyncWebhooksResource) -> None:
+        self._webhooks = webhooks
+
+        self.create = async_to_raw_response_wrapper(
+            webhooks.create,
+        )
+        self.retrieve = async_to_raw_response_wrapper(
+            webhooks.retrieve,
+        )
+        self.update = async_to_raw_response_wrapper(
+            webhooks.update,
+        )
+        self.list = async_to_raw_response_wrapper(
+            webhooks.list,
+        )
+        self.delete = async_to_raw_response_wrapper(
+            webhooks.delete,
+        )
+
+    @cached_property
+    def headers(self) -> AsyncHeadersResourceWithRawResponse:
+        return AsyncHeadersResourceWithRawResponse(self._webhooks.headers)
+
+
+class WebhooksResourceWithStreamingResponse:
+    def __init__(self, webhooks: WebhooksResource) -> None:
+        self._webhooks = webhooks
+
+        self.create = to_streamed_response_wrapper(
+            webhooks.create,
+        )
+        self.retrieve = to_streamed_response_wrapper(
+            webhooks.retrieve,
+        )
+        self.update = to_streamed_response_wrapper(
+            webhooks.update,
+        )
+        self.list = to_streamed_response_wrapper(
+            webhooks.list,
+        )
+        self.delete = to_streamed_response_wrapper(
+            webhooks.delete,
+        )
+
+    @cached_property
+    def headers(self) -> HeadersResourceWithStreamingResponse:
+        return HeadersResourceWithStreamingResponse(self._webhooks.headers)
+
+
+class AsyncWebhooksResourceWithStreamingResponse:
+    def __init__(self, webhooks: AsyncWebhooksResource) -> None:
+        self._webhooks = webhooks
+
+        self.create = async_to_streamed_response_wrapper(
+            webhooks.create,
+        )
+        self.retrieve = async_to_streamed_response_wrapper(
+            webhooks.retrieve,
+        )
+        self.update = async_to_streamed_response_wrapper(
+            webhooks.update,
+        )
+        self.list = async_to_streamed_response_wrapper(
+            webhooks.list,
+        )
+        self.delete = async_to_streamed_response_wrapper(
+            webhooks.delete,
+        )
+
+    @cached_property
+    def headers(self) -> AsyncHeadersResourceWithStreamingResponse:
+        return AsyncHeadersResourceWithStreamingResponse(self._webhooks.headers)