# This file was auto-generated by Fern from our API Definition. import typing from json.decoder import JSONDecodeError from ..core.api_error import ApiError from ..core.client_wrapper import AsyncClientWrapper, SyncClientWrapper from ..core.http_response import AsyncHttpResponse, HttpResponse from ..core.jsonable_encoder import jsonable_encoder from ..core.parse_error import ParsingError from ..core.request_options import RequestOptions from ..core.serialization import convert_and_respect_annotation_metadata from ..core.unchecked_base_model import construct_type from ..errors.unprocessable_entity_error import UnprocessableEntityError from ..types.delete_workspace_webhook_response_model import DeleteWorkspaceWebhookResponseModel from ..types.patch_workspace_webhook_response_model import PatchWorkspaceWebhookResponseModel from ..types.webhook_hmac_settings import WebhookHmacSettings from ..types.workspace_create_webhook_response_model import WorkspaceCreateWebhookResponseModel from ..types.workspace_webhook_event_type import WorkspaceWebhookEventType from ..types.workspace_webhook_list_response_model import WorkspaceWebhookListResponseModel from pydantic import ValidationError # this is used as the default value for optional parameters OMIT = typing.cast(typing.Any, ...) class RawWebhooksClient: def __init__(self, *, client_wrapper: SyncClientWrapper): self._client_wrapper = client_wrapper def list( self, *, include_usages: typing.Optional[bool] = None, request_options: typing.Optional[RequestOptions] = None ) -> HttpResponse[WorkspaceWebhookListResponseModel]: """ List all webhooks for a workspace Parameters ---------- include_usages : typing.Optional[bool] Whether to include active usages of the webhook, only usable by admins request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- HttpResponse[WorkspaceWebhookListResponseModel] Successful Response """ _response = self._client_wrapper.httpx_client.request( "v1/workspace/webhooks", method="GET", params={ "include_usages": include_usages, }, request_options=request_options, ) try: if 200 <= _response.status_code < 300: _data = typing.cast( WorkspaceWebhookListResponseModel, construct_type( type_=WorkspaceWebhookListResponseModel, # type: ignore object_=_response.json(), ), ) return HttpResponse(response=_response, data=_data) if _response.status_code == 422: raise UnprocessableEntityError( headers=dict(_response.headers), body=typing.cast( typing.Any, construct_type( type_=typing.Any, # type: ignore object_=_response.json(), ), ), ) _response_json = _response.json() except JSONDecodeError: raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) except ValidationError as e: raise ParsingError( status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e ) raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) def create( self, *, settings: WebhookHmacSettings, request_options: typing.Optional[RequestOptions] = None ) -> HttpResponse[WorkspaceCreateWebhookResponseModel]: """ Create a new webhook for the workspace with the specified authentication type. Parameters ---------- settings : WebhookHmacSettings Webhook settings object containing auth_type and corresponding configuration request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- HttpResponse[WorkspaceCreateWebhookResponseModel] Successful Response """ _response = self._client_wrapper.httpx_client.request( "v1/workspace/webhooks", method="POST", json={ "settings": convert_and_respect_annotation_metadata( object_=settings, annotation=WebhookHmacSettings, direction="write" ), }, headers={ "content-type": "application/json", }, request_options=request_options, omit=OMIT, ) try: if 200 <= _response.status_code < 300: _data = typing.cast( WorkspaceCreateWebhookResponseModel, construct_type( type_=WorkspaceCreateWebhookResponseModel, # type: ignore object_=_response.json(), ), ) return HttpResponse(response=_response, data=_data) if _response.status_code == 422: raise UnprocessableEntityError( headers=dict(_response.headers), body=typing.cast( typing.Any, construct_type( type_=typing.Any, # type: ignore object_=_response.json(), ), ), ) _response_json = _response.json() except JSONDecodeError: raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) except ValidationError as e: raise ParsingError( status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e ) raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) def delete( self, webhook_id: str, *, request_options: typing.Optional[RequestOptions] = None ) -> HttpResponse[DeleteWorkspaceWebhookResponseModel]: """ Delete the specified workspace webhook Parameters ---------- webhook_id : str The unique ID for the webhook request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- HttpResponse[DeleteWorkspaceWebhookResponseModel] Successful Response """ _response = self._client_wrapper.httpx_client.request( f"v1/workspace/webhooks/{jsonable_encoder(webhook_id)}", method="DELETE", request_options=request_options, ) try: if 200 <= _response.status_code < 300: _data = typing.cast( DeleteWorkspaceWebhookResponseModel, construct_type( type_=DeleteWorkspaceWebhookResponseModel, # type: ignore object_=_response.json(), ), ) return HttpResponse(response=_response, data=_data) if _response.status_code == 422: raise UnprocessableEntityError( headers=dict(_response.headers), body=typing.cast( typing.Any, construct_type( type_=typing.Any, # type: ignore object_=_response.json(), ), ), ) _response_json = _response.json() except JSONDecodeError: raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) except ValidationError as e: raise ParsingError( status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e ) raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) def update( self, webhook_id: str, *, is_disabled: bool, name: str, retry_enabled: typing.Optional[bool] = OMIT, request_headers: typing.Optional[typing.Dict[str, typing.Optional[str]]] = OMIT, events: typing.Optional[typing.Sequence[WorkspaceWebhookEventType]] = OMIT, request_options: typing.Optional[RequestOptions] = None, ) -> HttpResponse[PatchWorkspaceWebhookResponseModel]: """ Update the specified workspace webhook Parameters ---------- webhook_id : str The unique ID for the webhook is_disabled : bool Whether to disable or enable the webhook name : str The display name of the webhook (used for display purposes only). retry_enabled : typing.Optional[bool] Whether to enable automatic retries for transient failures (5xx, 429, timeout) request_headers : typing.Optional[typing.Dict[str, typing.Optional[str]]] A list of request headers to include with the webhook delivery (optional) events : typing.Optional[typing.Sequence[WorkspaceWebhookEventType]] The complete set of workspace-level events this webhook should be subscribed to. The webhook is added to the events in the list and removed from any not in the list. Omit to leave the current event subscriptions unchanged. request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- HttpResponse[PatchWorkspaceWebhookResponseModel] Successful Response """ _response = self._client_wrapper.httpx_client.request( f"v1/workspace/webhooks/{jsonable_encoder(webhook_id)}", method="PATCH", json={ "is_disabled": is_disabled, "name": name, "retry_enabled": retry_enabled, "request_headers": request_headers, "events": events, }, headers={ "content-type": "application/json", }, request_options=request_options, omit=OMIT, ) try: if 200 <= _response.status_code < 300: _data = typing.cast( PatchWorkspaceWebhookResponseModel, construct_type( type_=PatchWorkspaceWebhookResponseModel, # type: ignore object_=_response.json(), ), ) return HttpResponse(response=_response, data=_data) if _response.status_code == 422: raise UnprocessableEntityError( headers=dict(_response.headers), body=typing.cast( typing.Any, construct_type( type_=typing.Any, # type: ignore object_=_response.json(), ), ), ) _response_json = _response.json() except JSONDecodeError: raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) except ValidationError as e: raise ParsingError( status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e ) raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) class AsyncRawWebhooksClient: def __init__(self, *, client_wrapper: AsyncClientWrapper): self._client_wrapper = client_wrapper async def list( self, *, include_usages: typing.Optional[bool] = None, request_options: typing.Optional[RequestOptions] = None ) -> AsyncHttpResponse[WorkspaceWebhookListResponseModel]: """ List all webhooks for a workspace Parameters ---------- include_usages : typing.Optional[bool] Whether to include active usages of the webhook, only usable by admins request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- AsyncHttpResponse[WorkspaceWebhookListResponseModel] Successful Response """ _response = await self._client_wrapper.httpx_client.request( "v1/workspace/webhooks", method="GET", params={ "include_usages": include_usages, }, request_options=request_options, ) try: if 200 <= _response.status_code < 300: _data = typing.cast( WorkspaceWebhookListResponseModel, construct_type( type_=WorkspaceWebhookListResponseModel, # type: ignore object_=_response.json(), ), ) return AsyncHttpResponse(response=_response, data=_data) if _response.status_code == 422: raise UnprocessableEntityError( headers=dict(_response.headers), body=typing.cast( typing.Any, construct_type( type_=typing.Any, # type: ignore object_=_response.json(), ), ), ) _response_json = _response.json() except JSONDecodeError: raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) except ValidationError as e: raise ParsingError( status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e ) raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) async def create( self, *, settings: WebhookHmacSettings, request_options: typing.Optional[RequestOptions] = None ) -> AsyncHttpResponse[WorkspaceCreateWebhookResponseModel]: """ Create a new webhook for the workspace with the specified authentication type. Parameters ---------- settings : WebhookHmacSettings Webhook settings object containing auth_type and corresponding configuration request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- AsyncHttpResponse[WorkspaceCreateWebhookResponseModel] Successful Response """ _response = await self._client_wrapper.httpx_client.request( "v1/workspace/webhooks", method="POST", json={ "settings": convert_and_respect_annotation_metadata( object_=settings, annotation=WebhookHmacSettings, direction="write" ), }, headers={ "content-type": "application/json", }, request_options=request_options, omit=OMIT, ) try: if 200 <= _response.status_code < 300: _data = typing.cast( WorkspaceCreateWebhookResponseModel, construct_type( type_=WorkspaceCreateWebhookResponseModel, # type: ignore object_=_response.json(), ), ) return AsyncHttpResponse(response=_response, data=_data) if _response.status_code == 422: raise UnprocessableEntityError( headers=dict(_response.headers), body=typing.cast( typing.Any, construct_type( type_=typing.Any, # type: ignore object_=_response.json(), ), ), ) _response_json = _response.json() except JSONDecodeError: raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) except ValidationError as e: raise ParsingError( status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e ) raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) async def delete( self, webhook_id: str, *, request_options: typing.Optional[RequestOptions] = None ) -> AsyncHttpResponse[DeleteWorkspaceWebhookResponseModel]: """ Delete the specified workspace webhook Parameters ---------- webhook_id : str The unique ID for the webhook request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- AsyncHttpResponse[DeleteWorkspaceWebhookResponseModel] Successful Response """ _response = await self._client_wrapper.httpx_client.request( f"v1/workspace/webhooks/{jsonable_encoder(webhook_id)}", method="DELETE", request_options=request_options, ) try: if 200 <= _response.status_code < 300: _data = typing.cast( DeleteWorkspaceWebhookResponseModel, construct_type( type_=DeleteWorkspaceWebhookResponseModel, # type: ignore object_=_response.json(), ), ) return AsyncHttpResponse(response=_response, data=_data) if _response.status_code == 422: raise UnprocessableEntityError( headers=dict(_response.headers), body=typing.cast( typing.Any, construct_type( type_=typing.Any, # type: ignore object_=_response.json(), ), ), ) _response_json = _response.json() except JSONDecodeError: raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) except ValidationError as e: raise ParsingError( status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e ) raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) async def update( self, webhook_id: str, *, is_disabled: bool, name: str, retry_enabled: typing.Optional[bool] = OMIT, request_headers: typing.Optional[typing.Dict[str, typing.Optional[str]]] = OMIT, events: typing.Optional[typing.Sequence[WorkspaceWebhookEventType]] = OMIT, request_options: typing.Optional[RequestOptions] = None, ) -> AsyncHttpResponse[PatchWorkspaceWebhookResponseModel]: """ Update the specified workspace webhook Parameters ---------- webhook_id : str The unique ID for the webhook is_disabled : bool Whether to disable or enable the webhook name : str The display name of the webhook (used for display purposes only). retry_enabled : typing.Optional[bool] Whether to enable automatic retries for transient failures (5xx, 429, timeout) request_headers : typing.Optional[typing.Dict[str, typing.Optional[str]]] A list of request headers to include with the webhook delivery (optional) events : typing.Optional[typing.Sequence[WorkspaceWebhookEventType]] The complete set of workspace-level events this webhook should be subscribed to. The webhook is added to the events in the list and removed from any not in the list. Omit to leave the current event subscriptions unchanged. request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- AsyncHttpResponse[PatchWorkspaceWebhookResponseModel] Successful Response """ _response = await self._client_wrapper.httpx_client.request( f"v1/workspace/webhooks/{jsonable_encoder(webhook_id)}", method="PATCH", json={ "is_disabled": is_disabled, "name": name, "retry_enabled": retry_enabled, "request_headers": request_headers, "events": events, }, headers={ "content-type": "application/json", }, request_options=request_options, omit=OMIT, ) try: if 200 <= _response.status_code < 300: _data = typing.cast( PatchWorkspaceWebhookResponseModel, construct_type( type_=PatchWorkspaceWebhookResponseModel, # type: ignore object_=_response.json(), ), ) return AsyncHttpResponse(response=_response, data=_data) if _response.status_code == 422: raise UnprocessableEntityError( headers=dict(_response.headers), body=typing.cast( typing.Any, construct_type( type_=typing.Any, # type: ignore object_=_response.json(), ), ), ) _response_json = _response.json() except JSONDecodeError: raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) except ValidationError as e: raise ParsingError( status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e ) raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)