label-studio-sdk 1.0.8__py3-none-any.whl → 1.0.11__py3-none-any.whl

label_studio_sdk/webhooks/client.py

@@ -1,19 +1,19 @@
 # This file was auto-generated by Fern from our API Definition.
 
-import datetime as dt
 import typing
-from json.decoder import JSONDecodeError
-
-from ..core.api_error import ApiError
-from ..core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
-from ..core.jsonable_encoder import jsonable_encoder
-from ..core.pydantic_utilities import pydantic_v1
+from ..core.client_wrapper import SyncClientWrapper
 from ..core.request_options import RequestOptions
 from ..types.webhook import Webhook
+from ..core.pydantic_utilities import parse_obj_as
+from json.decoder import JSONDecodeError
+from ..core.api_error import ApiError
 from ..types.webhook_actions_item import WebhookActionsItem
-from ..types.webhook_serializer_for_update import WebhookSerializerForUpdate
-from ..types.webhook_serializer_for_update_actions_item import WebhookSerializerForUpdateActionsItem
+import datetime as dt
+from ..core.jsonable_encoder import jsonable_encoder
 from .types.webhooks_update_request_actions_item import WebhooksUpdateRequestActionsItem
+from ..types.webhook_serializer_for_update_actions_item import WebhookSerializerForUpdateActionsItem
+from ..types.webhook_serializer_for_update import WebhookSerializerForUpdate
+from ..core.client_wrapper import AsyncClientWrapper
 
 # this is used as the default value for optional parameters
 OMIT = typing.cast(typing.Any, ...)
@@ -27,6 +27,7 @@ class WebhooksClient:
         self, *, project: typing.Optional[str] = None, request_options: typing.Optional[RequestOptions] = None
     ) -> typing.List[Webhook]:
         """
+
         List all webhooks set up for your organization.
 
         Webhooks in Label Studio let you set up integrations that subscribe to certain events that occur inside Label Studio. When an event is triggered, Label Studio sends an HTTP POST request to the configured webhook URL.
@@ -48,7 +49,7 @@ class WebhooksClient:
 
         Examples
         --------
-        from label_studio_sdk.client import LabelStudio
+        from label_studio_sdk import LabelStudio
 
         client = LabelStudio(
             api_key="YOUR_API_KEY",
@@ -56,11 +57,22 @@ class WebhooksClient:
         client.webhooks.list()
         """
         _response = self._client_wrapper.httpx_client.request(
-            "api/webhooks/", method="GET", params={"project": project}, request_options=request_options
+            "api/webhooks/",
+            method="GET",
+            params={
+                "project": project,
+            },
+            request_options=request_options,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(typing.List[Webhook], _response.json())  # type: ignore
+                return typing.cast(
+                    typing.List[Webhook],
+                    parse_obj_as(
+                        type_=typing.List[Webhook],  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -75,7 +87,7 @@ class WebhooksClient:
         project: typing.Optional[int] = OMIT,
         send_payload: typing.Optional[bool] = OMIT,
         send_for_all_actions: typing.Optional[bool] = OMIT,
-        headers: typing.Optional[typing.Dict[str, typing.Any]] = OMIT,
+        headers: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = OMIT,
         is_active: typing.Optional[bool] = OMIT,
         actions: typing.Optional[typing.Sequence[WebhookActionsItem]] = OMIT,
         created_at: typing.Optional[dt.datetime] = OMIT,
@@ -83,6 +95,7 @@ class WebhooksClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> Webhook:
         """
+
         Create a webhook.
         Label Studio provides several out-of-the box webhook events, which you can find listed here: [Available Label Studio webhooks](https://labelstud.io/guide/webhooks#Available-Label-Studio-webhooks).
 
@@ -107,7 +120,7 @@ class WebhooksClient:
         send_for_all_actions : typing.Optional[bool]
             If value is False - used only for actions from WebhookAction
 
-        headers : typing.Optional[typing.Dict[str, typing.Any]]
+        headers : typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]
             Key Value Json of headers
 
         is_active : typing.Optional[bool]
@@ -131,7 +144,7 @@ class WebhooksClient:
 
         Examples
         --------
-        from label_studio_sdk.client import LabelStudio
+        from label_studio_sdk import LabelStudio
 
         client = LabelStudio(
             api_key="YOUR_API_KEY",
@@ -161,7 +174,13 @@ class WebhooksClient:
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(Webhook, _response.json())  # type: ignore
+                return typing.cast(
+                    Webhook,
+                    parse_obj_as(
+                        type_=Webhook,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -174,6 +193,7 @@ class WebhooksClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> None:
         """
+
         Get descriptions of all available webhook actions to set up webhooks. For more information, see the [Webhook event reference](https://labelstud.io/guide/webhook_reference).
 
         Parameters
@@ -190,7 +210,7 @@ class WebhooksClient:
 
         Examples
         --------
-        from label_studio_sdk.client import LabelStudio
+        from label_studio_sdk import LabelStudio
 
         client = LabelStudio(
             api_key="YOUR_API_KEY",
@@ -200,7 +220,9 @@ class WebhooksClient:
         _response = self._client_wrapper.httpx_client.request(
             "api/webhooks/info/",
             method="GET",
-            params={"organization-only": organization_only},
+            params={
+                "organization-only": organization_only,
+            },
             request_options=request_options,
         )
         try:
@@ -213,6 +235,7 @@ class WebhooksClient:
 
     def get(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> Webhook:
         """
+
         Get information about a specific webhook. You will need to provide the webhook ID. You can get this from [List all webhooks](list).
 
         For more information about webhooks, see [Set up webhooks in Label Studio](https://labelstud.io/guide/webhooks) and the [Webhook event reference](https://labelstud.io/guide/webhook_reference).
@@ -232,7 +255,7 @@ class WebhooksClient:
 
         Examples
         --------
-        from label_studio_sdk.client import LabelStudio
+        from label_studio_sdk import LabelStudio
 
         client = LabelStudio(
             api_key="YOUR_API_KEY",
@@ -242,11 +265,19 @@ class WebhooksClient:
         )
         """
         _response = self._client_wrapper.httpx_client.request(
-            f"api/webhooks/{jsonable_encoder(id)}/", method="GET", request_options=request_options
+            f"api/webhooks/{jsonable_encoder(id)}/",
+            method="GET",
+            request_options=request_options,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(Webhook, _response.json())  # type: ignore
+                return typing.cast(
+                    Webhook,
+                    parse_obj_as(
+                        type_=Webhook,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -254,6 +285,7 @@ class WebhooksClient:
 
     def delete(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> None:
         """
+
         Delete a webhook. You will need to provide the webhook ID. You can get this from [List all webhooks](list).
 
         For more information about webhooks, see [Set up webhooks in Label Studio](https://labelstud.io/guide/webhooks) and the [Webhook event reference](https://labelstud.io/guide/webhook_reference).
@@ -272,7 +304,7 @@ class WebhooksClient:
 
         Examples
         --------
-        from label_studio_sdk.client import LabelStudio
+        from label_studio_sdk import LabelStudio
 
         client = LabelStudio(
             api_key="YOUR_API_KEY",
@@ -282,7 +314,9 @@ class WebhooksClient:
         )
         """
         _response = self._client_wrapper.httpx_client.request(
-            f"api/webhooks/{jsonable_encoder(id)}/", method="DELETE", request_options=request_options
+            f"api/webhooks/{jsonable_encoder(id)}/",
+            method="DELETE",
+            request_options=request_options,
         )
         try:
             if 200 <= _response.status_code < 300:
@@ -310,7 +344,7 @@ class WebhooksClient:
         project: typing.Optional[int] = OMIT,
         webhook_serializer_for_update_send_payload: typing.Optional[bool] = OMIT,
         webhook_serializer_for_update_send_for_all_actions: typing.Optional[bool] = OMIT,
-        webhook_serializer_for_update_headers: typing.Optional[typing.Dict[str, typing.Any]] = OMIT,
+        webhook_serializer_for_update_headers: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = OMIT,
         webhook_serializer_for_update_is_active: typing.Optional[bool] = OMIT,
         webhook_serializer_for_update_actions: typing.Optional[
             typing.Sequence[WebhookSerializerForUpdateActionsItem]
@@ -320,6 +354,7 @@ class WebhooksClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> WebhookSerializerForUpdate:
         """
+
         Update a webhook. You will need to provide the webhook ID. You can get this from [List all webhooks](list).
 
         For more information about webhooks, see [Set up webhooks in Label Studio](https://labelstud.io/guide/webhooks) and the [Webhook event reference](https://labelstud.io/guide/webhook_reference).
@@ -361,7 +396,7 @@ class WebhooksClient:
         webhook_serializer_for_update_send_for_all_actions : typing.Optional[bool]
             If value is False - used only for actions from WebhookAction
 
-        webhook_serializer_for_update_headers : typing.Optional[typing.Dict[str, typing.Any]]
+        webhook_serializer_for_update_headers : typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]
             Key Value Json of headers
 
         webhook_serializer_for_update_is_active : typing.Optional[bool]
@@ -385,7 +420,7 @@ class WebhooksClient:
 
         Examples
         --------
-        from label_studio_sdk.client import LabelStudio
+        from label_studio_sdk import LabelStudio
 
         client = LabelStudio(
             api_key="YOUR_API_KEY",
@@ -425,7 +460,13 @@ class WebhooksClient:
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(WebhookSerializerForUpdate, _response.json())  # type: ignore
+                return typing.cast(
+                    WebhookSerializerForUpdate,
+                    parse_obj_as(
+                        type_=WebhookSerializerForUpdate,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -440,6 +481,7 @@ class AsyncWebhooksClient:
         self, *, project: typing.Optional[str] = None, request_options: typing.Optional[RequestOptions] = None
     ) -> typing.List[Webhook]:
         """
+
         List all webhooks set up for your organization.
 
         Webhooks in Label Studio let you set up integrations that subscribe to certain events that occur inside Label Studio. When an event is triggered, Label Studio sends an HTTP POST request to the configured webhook URL.
@@ -461,19 +503,38 @@ class AsyncWebhooksClient:
 
         Examples
         --------
-        from label_studio_sdk.client import AsyncLabelStudio
+        import asyncio
+
+        from label_studio_sdk import AsyncLabelStudio
 
         client = AsyncLabelStudio(
             api_key="YOUR_API_KEY",
         )
-        await client.webhooks.list()
+
+
+        async def main() -> None:
+            await client.webhooks.list()
+
+
+        asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
-            "api/webhooks/", method="GET", params={"project": project}, request_options=request_options
+            "api/webhooks/",
+            method="GET",
+            params={
+                "project": project,
+            },
+            request_options=request_options,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(typing.List[Webhook], _response.json())  # type: ignore
+                return typing.cast(
+                    typing.List[Webhook],
+                    parse_obj_as(
+                        type_=typing.List[Webhook],  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -488,7 +549,7 @@ class AsyncWebhooksClient:
         project: typing.Optional[int] = OMIT,
         send_payload: typing.Optional[bool] = OMIT,
         send_for_all_actions: typing.Optional[bool] = OMIT,
-        headers: typing.Optional[typing.Dict[str, typing.Any]] = OMIT,
+        headers: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = OMIT,
         is_active: typing.Optional[bool] = OMIT,
         actions: typing.Optional[typing.Sequence[WebhookActionsItem]] = OMIT,
         created_at: typing.Optional[dt.datetime] = OMIT,
@@ -496,6 +557,7 @@ class AsyncWebhooksClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> Webhook:
         """
+
         Create a webhook.
         Label Studio provides several out-of-the box webhook events, which you can find listed here: [Available Label Studio webhooks](https://labelstud.io/guide/webhooks#Available-Label-Studio-webhooks).
 
@@ -520,7 +582,7 @@ class AsyncWebhooksClient:
         send_for_all_actions : typing.Optional[bool]
             If value is False - used only for actions from WebhookAction
 
-        headers : typing.Optional[typing.Dict[str, typing.Any]]
+        headers : typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]
             Key Value Json of headers
 
         is_active : typing.Optional[bool]
@@ -544,14 +606,22 @@ class AsyncWebhooksClient:
 
         Examples
         --------
-        from label_studio_sdk.client import AsyncLabelStudio
+        import asyncio
+
+        from label_studio_sdk import AsyncLabelStudio
 
         client = AsyncLabelStudio(
             api_key="YOUR_API_KEY",
         )
-        await client.webhooks.create(
-            url="url",
-        )
+
+
+        async def main() -> None:
+            await client.webhooks.create(
+                url="url",
+            )
+
+
+        asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
             "api/webhooks/",
@@ -574,7 +644,13 @@ class AsyncWebhooksClient:
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(Webhook, _response.json())  # type: ignore
+                return typing.cast(
+                    Webhook,
+                    parse_obj_as(
+                        type_=Webhook,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -587,6 +663,7 @@ class AsyncWebhooksClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> None:
         """
+
         Get descriptions of all available webhook actions to set up webhooks. For more information, see the [Webhook event reference](https://labelstud.io/guide/webhook_reference).
 
         Parameters
@@ -603,17 +680,27 @@ class AsyncWebhooksClient:
 
         Examples
         --------
-        from label_studio_sdk.client import AsyncLabelStudio
+        import asyncio
+
+        from label_studio_sdk import AsyncLabelStudio
 
         client = AsyncLabelStudio(
             api_key="YOUR_API_KEY",
         )
-        await client.webhooks.info()
+
+
+        async def main() -> None:
+            await client.webhooks.info()
+
+
+        asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
             "api/webhooks/info/",
             method="GET",
-            params={"organization-only": organization_only},
+            params={
+                "organization-only": organization_only,
+            },
             request_options=request_options,
         )
         try:
@@ -626,6 +713,7 @@ class AsyncWebhooksClient:
 
     async def get(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> Webhook:
         """
+
         Get information about a specific webhook. You will need to provide the webhook ID. You can get this from [List all webhooks](list).
 
         For more information about webhooks, see [Set up webhooks in Label Studio](https://labelstud.io/guide/webhooks) and the [Webhook event reference](https://labelstud.io/guide/webhook_reference).
@@ -645,21 +733,37 @@ class AsyncWebhooksClient:
 
         Examples
         --------
-        from label_studio_sdk.client import AsyncLabelStudio
+        import asyncio
+
+        from label_studio_sdk import AsyncLabelStudio
 
         client = AsyncLabelStudio(
             api_key="YOUR_API_KEY",
         )
-        await client.webhooks.get(
-            id=1,
-        )
+
+
+        async def main() -> None:
+            await client.webhooks.get(
+                id=1,
+            )
+
+
+        asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
-            f"api/webhooks/{jsonable_encoder(id)}/", method="GET", request_options=request_options
+            f"api/webhooks/{jsonable_encoder(id)}/",
+            method="GET",
+            request_options=request_options,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(Webhook, _response.json())  # type: ignore
+                return typing.cast(
+                    Webhook,
+                    parse_obj_as(
+                        type_=Webhook,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -667,6 +771,7 @@ class AsyncWebhooksClient:
 
     async def delete(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> None:
         """
+
         Delete a webhook. You will need to provide the webhook ID. You can get this from [List all webhooks](list).
 
         For more information about webhooks, see [Set up webhooks in Label Studio](https://labelstud.io/guide/webhooks) and the [Webhook event reference](https://labelstud.io/guide/webhook_reference).
@@ -685,17 +790,27 @@ class AsyncWebhooksClient:
 
         Examples
         --------
-        from label_studio_sdk.client import AsyncLabelStudio
+        import asyncio
+
+        from label_studio_sdk import AsyncLabelStudio
 
         client = AsyncLabelStudio(
             api_key="YOUR_API_KEY",
         )
-        await client.webhooks.delete(
-            id=1,
-        )
+
+
+        async def main() -> None:
+            await client.webhooks.delete(
+                id=1,
+            )
+
+
+        asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
-            f"api/webhooks/{jsonable_encoder(id)}/", method="DELETE", request_options=request_options
+            f"api/webhooks/{jsonable_encoder(id)}/",
+            method="DELETE",
+            request_options=request_options,
         )
         try:
             if 200 <= _response.status_code < 300:
@@ -723,7 +838,7 @@ class AsyncWebhooksClient:
         project: typing.Optional[int] = OMIT,
         webhook_serializer_for_update_send_payload: typing.Optional[bool] = OMIT,
         webhook_serializer_for_update_send_for_all_actions: typing.Optional[bool] = OMIT,
-        webhook_serializer_for_update_headers: typing.Optional[typing.Dict[str, typing.Any]] = OMIT,
+        webhook_serializer_for_update_headers: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = OMIT,
         webhook_serializer_for_update_is_active: typing.Optional[bool] = OMIT,
         webhook_serializer_for_update_actions: typing.Optional[
             typing.Sequence[WebhookSerializerForUpdateActionsItem]
@@ -733,6 +848,7 @@ class AsyncWebhooksClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> WebhookSerializerForUpdate:
         """
+
         Update a webhook. You will need to provide the webhook ID. You can get this from [List all webhooks](list).
 
         For more information about webhooks, see [Set up webhooks in Label Studio](https://labelstud.io/guide/webhooks) and the [Webhook event reference](https://labelstud.io/guide/webhook_reference).
@@ -774,7 +890,7 @@ class AsyncWebhooksClient:
         webhook_serializer_for_update_send_for_all_actions : typing.Optional[bool]
             If value is False - used only for actions from WebhookAction
 
-        webhook_serializer_for_update_headers : typing.Optional[typing.Dict[str, typing.Any]]
+        webhook_serializer_for_update_headers : typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]
             Key Value Json of headers
 
         webhook_serializer_for_update_is_active : typing.Optional[bool]
@@ -798,16 +914,24 @@ class AsyncWebhooksClient:
 
         Examples
         --------
-        from label_studio_sdk.client import AsyncLabelStudio
+        import asyncio
+
+        from label_studio_sdk import AsyncLabelStudio
 
         client = AsyncLabelStudio(
             api_key="YOUR_API_KEY",
         )
-        await client.webhooks.update(
-            id_=1,
-            url="url",
-            webhook_serializer_for_update_url="url",
-        )
+
+
+        async def main() -> None:
+            await client.webhooks.update(
+                id_=1,
+                url="url",
+                webhook_serializer_for_update_url="url",
+            )
+
+
+        asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
             f"api/webhooks/{jsonable_encoder(id_)}/",
@@ -838,7 +962,13 @@ class AsyncWebhooksClient:
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(WebhookSerializerForUpdate, _response.json())  # type: ignore
+                return typing.cast(
+                    WebhookSerializerForUpdate,
+                    parse_obj_as(
+                        type_=WebhookSerializerForUpdate,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)