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

label_studio_sdk/export_storage/azure/client.py

@@ -1,16 +1,16 @@
 # 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.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.azure_blob_export_storage import AzureBlobExportStorage
+from ...core.pydantic_utilities import parse_obj_as
+from json.decoder import JSONDecodeError
+from ...core.api_error import ApiError
 from .types.azure_create_response import AzureCreateResponse
+from ...core.jsonable_encoder import jsonable_encoder
 from .types.azure_update_response import AzureUpdateResponse
+from ...core.client_wrapper import AsyncClientWrapper
 
 # this is used as the default value for optional parameters
 OMIT = typing.cast(typing.Any, ...)
@@ -24,6 +24,7 @@ class AzureClient:
         self, *, project: typing.Optional[int] = None, request_options: typing.Optional[RequestOptions] = None
     ) -> typing.List[AzureBlobExportStorage]:
         """
+
         You can connect your Microsoft Azure Blob storage container to Label Studio as a source storage or target storage. Use this API request to get a list of all Azure export (target) storage connections for a specific project.
 
         The project ID can be found in the URL when viewing the project in Label Studio, or you can retrieve all project IDs using [List all projects](../projects/list).
@@ -45,7 +46,7 @@ class AzureClient:
 
         Examples
         --------
-        from label_studio_sdk.client import LabelStudio
+        from label_studio_sdk import LabelStudio
 
         client = LabelStudio(
             api_key="YOUR_API_KEY",
@@ -53,11 +54,22 @@ class AzureClient:
         client.export_storage.azure.list()
         """
         _response = self._client_wrapper.httpx_client.request(
-            "api/storages/export/azure", method="GET", params={"project": project}, request_options=request_options
+            "api/storages/export/azure",
+            method="GET",
+            params={
+                "project": project,
+            },
+            request_options=request_options,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(typing.List[AzureBlobExportStorage], _response.json())  # type: ignore
+                return typing.cast(
+                    typing.List[AzureBlobExportStorage],
+                    parse_obj_as(
+                        type_=typing.List[AzureBlobExportStorage],  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -77,6 +89,7 @@ class AzureClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> AzureCreateResponse:
         """
+
         Create a new target storage connection to Microsoft Azure Blob storage.
 
         For information about the required fields and prerequisites, see [Microsoft Azure Blob storage](https://labelstud.io/guide/storage#Microsoft-Azure-Blob-storage) in the Label Studio documentation.
@@ -119,7 +132,7 @@ class AzureClient:
 
         Examples
         --------
-        from label_studio_sdk.client import LabelStudio
+        from label_studio_sdk import LabelStudio
 
         client = LabelStudio(
             api_key="YOUR_API_KEY",
@@ -139,12 +152,21 @@ class AzureClient:
                 "account_name": account_name,
                 "account_key": account_key,
             },
+            headers={
+                "content-type": "application/json",
+            },
             request_options=request_options,
             omit=OMIT,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(AzureCreateResponse, _response.json())  # type: ignore
+                return typing.cast(
+                    AzureCreateResponse,
+                    parse_obj_as(
+                        type_=AzureCreateResponse,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -165,6 +187,7 @@ class AzureClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> None:
         """
+
         Validate a specific Azure export storage connection. This is useful to ensure that the storage configuration settings are correct and operational before attempting to export data.
 
         Parameters
@@ -205,7 +228,7 @@ class AzureClient:
 
         Examples
         --------
-        from label_studio_sdk.client import LabelStudio
+        from label_studio_sdk import LabelStudio
 
         client = LabelStudio(
             api_key="YOUR_API_KEY",
@@ -226,6 +249,9 @@ class AzureClient:
                 "account_name": account_name,
                 "account_key": account_key,
             },
+            headers={
+                "content-type": "application/json",
+            },
             request_options=request_options,
             omit=OMIT,
         )
@@ -239,6 +265,7 @@ class AzureClient:
 
     def get(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> AzureBlobExportStorage:
         """
+
         Get a specific Azure export storage connection. You will need to provide the export storage ID. You can find this using [List export storages](list).
 
         For more information about working with external storage, see [Sync data from external storage](https://labelstud.io/guide/storage).
@@ -258,7 +285,7 @@ class AzureClient:
 
         Examples
         --------
-        from label_studio_sdk.client import LabelStudio
+        from label_studio_sdk import LabelStudio
 
         client = LabelStudio(
             api_key="YOUR_API_KEY",
@@ -268,11 +295,19 @@ class AzureClient:
         )
         """
         _response = self._client_wrapper.httpx_client.request(
-            f"api/storages/export/azure/{jsonable_encoder(id)}", method="GET", request_options=request_options
+            f"api/storages/export/azure/{jsonable_encoder(id)}",
+            method="GET",
+            request_options=request_options,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(AzureBlobExportStorage, _response.json())  # type: ignore
+                return typing.cast(
+                    AzureBlobExportStorage,
+                    parse_obj_as(
+                        type_=AzureBlobExportStorage,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -280,6 +315,7 @@ class AzureClient:
 
     def delete(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> None:
         """
+
         Delete a specific Azure export storage connection. You will need to provide the export storage ID. You can find this using [List export storages](list).
 
         Deleting an export/target storage connection does not affect tasks with synced data in Label Studio. If you want to remove the tasks that were synced from the external storage, you will need to delete them manually from within the Label Studio UI or use the [Delete tasks](../../tasks/delete-all-tasks) API.
@@ -298,7 +334,7 @@ class AzureClient:
 
         Examples
         --------
-        from label_studio_sdk.client import LabelStudio
+        from label_studio_sdk import LabelStudio
 
         client = LabelStudio(
             api_key="YOUR_API_KEY",
@@ -308,7 +344,9 @@ class AzureClient:
         )
         """
         _response = self._client_wrapper.httpx_client.request(
-            f"api/storages/export/azure/{jsonable_encoder(id)}", method="DELETE", request_options=request_options
+            f"api/storages/export/azure/{jsonable_encoder(id)}",
+            method="DELETE",
+            request_options=request_options,
         )
         try:
             if 200 <= _response.status_code < 300:
@@ -333,6 +371,7 @@ class AzureClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> AzureUpdateResponse:
         """
+
         Update a specific Azure export storage connection. You will need to provide the export storage ID. You can find this using [List export storages](list).
 
         For more information about working with external storage, see [Sync data from external storage](https://labelstud.io/guide/storage).
@@ -376,7 +415,7 @@ class AzureClient:
 
         Examples
         --------
-        from label_studio_sdk.client import LabelStudio
+        from label_studio_sdk import LabelStudio
 
         client = LabelStudio(
             api_key="YOUR_API_KEY",
@@ -398,19 +437,29 @@ class AzureClient:
                 "account_name": account_name,
                 "account_key": account_key,
             },
+            headers={
+                "content-type": "application/json",
+            },
             request_options=request_options,
             omit=OMIT,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(AzureUpdateResponse, _response.json())  # type: ignore
+                return typing.cast(
+                    AzureUpdateResponse,
+                    parse_obj_as(
+                        type_=AzureUpdateResponse,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
         raise ApiError(status_code=_response.status_code, body=_response_json)
 
-    def sync(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> AzureBlobExportStorage:
+    def sync(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> AzureBlobExportStorage:
         """
+
         Sync tasks to an Azure export/target storage connection. You will need to provide the export storage ID. You can find this using [List export storages](list).
 
         Sync operations with external containers only go one way. They either create tasks from objects in the container (source/import storage) or push annotations to the output container (export/target storage). Changing something on the Microsoft side doesn’t guarantee consistency in results.
@@ -419,7 +468,7 @@ class AzureClient:
 
         Parameters
         ----------
-        id : str
+        id : int
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -431,21 +480,29 @@ class AzureClient:
 
         Examples
         --------
-        from label_studio_sdk.client import LabelStudio
+        from label_studio_sdk import LabelStudio
 
         client = LabelStudio(
             api_key="YOUR_API_KEY",
         )
         client.export_storage.azure.sync(
-            id="id",
+            id=1,
         )
         """
         _response = self._client_wrapper.httpx_client.request(
-            f"api/storages/export/azure/{jsonable_encoder(id)}/sync", method="POST", request_options=request_options
+            f"api/storages/export/azure/{jsonable_encoder(id)}/sync",
+            method="POST",
+            request_options=request_options,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(AzureBlobExportStorage, _response.json())  # type: ignore
+                return typing.cast(
+                    AzureBlobExportStorage,
+                    parse_obj_as(
+                        type_=AzureBlobExportStorage,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -460,6 +517,7 @@ class AsyncAzureClient:
         self, *, project: typing.Optional[int] = None, request_options: typing.Optional[RequestOptions] = None
     ) -> typing.List[AzureBlobExportStorage]:
         """
+
         You can connect your Microsoft Azure Blob storage container to Label Studio as a source storage or target storage. Use this API request to get a list of all Azure export (target) storage connections for a specific project.
 
         The project ID can be found in the URL when viewing the project in Label Studio, or you can retrieve all project IDs using [List all projects](../projects/list).
@@ -481,19 +539,38 @@ class AsyncAzureClient:
 
         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.export_storage.azure.list()
+
+
+        async def main() -> None:
+            await client.export_storage.azure.list()
+
+
+        asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
-            "api/storages/export/azure", method="GET", params={"project": project}, request_options=request_options
+            "api/storages/export/azure",
+            method="GET",
+            params={
+                "project": project,
+            },
+            request_options=request_options,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(typing.List[AzureBlobExportStorage], _response.json())  # type: ignore
+                return typing.cast(
+                    typing.List[AzureBlobExportStorage],
+                    parse_obj_as(
+                        type_=typing.List[AzureBlobExportStorage],  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -513,6 +590,7 @@ class AsyncAzureClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> AzureCreateResponse:
         """
+
         Create a new target storage connection to Microsoft Azure Blob storage.
 
         For information about the required fields and prerequisites, see [Microsoft Azure Blob storage](https://labelstud.io/guide/storage#Microsoft-Azure-Blob-storage) in the Label Studio documentation.
@@ -555,12 +633,20 @@ class AsyncAzureClient:
 
         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.export_storage.azure.create()
+
+
+        async def main() -> None:
+            await client.export_storage.azure.create()
+
+
+        asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
             "api/storages/export/azure",
@@ -575,12 +661,21 @@ class AsyncAzureClient:
                 "account_name": account_name,
                 "account_key": account_key,
             },
+            headers={
+                "content-type": "application/json",
+            },
             request_options=request_options,
             omit=OMIT,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(AzureCreateResponse, _response.json())  # type: ignore
+                return typing.cast(
+                    AzureCreateResponse,
+                    parse_obj_as(
+                        type_=AzureCreateResponse,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -601,6 +696,7 @@ class AsyncAzureClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> None:
         """
+
         Validate a specific Azure export storage connection. This is useful to ensure that the storage configuration settings are correct and operational before attempting to export data.
 
         Parameters
@@ -641,12 +737,20 @@ class AsyncAzureClient:
 
         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.export_storage.azure.validate()
+
+
+        async def main() -> None:
+            await client.export_storage.azure.validate()
+
+
+        asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
             "api/storages/export/azure/validate",
@@ -662,6 +766,9 @@ class AsyncAzureClient:
                 "account_name": account_name,
                 "account_key": account_key,
             },
+            headers={
+                "content-type": "application/json",
+            },
             request_options=request_options,
             omit=OMIT,
         )
@@ -675,6 +782,7 @@ class AsyncAzureClient:
 
     async def get(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> AzureBlobExportStorage:
         """
+
         Get a specific Azure export storage connection. You will need to provide the export storage ID. You can find this using [List export storages](list).
 
         For more information about working with external storage, see [Sync data from external storage](https://labelstud.io/guide/storage).
@@ -694,21 +802,37 @@ class AsyncAzureClient:
 
         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.export_storage.azure.get(
-            id=1,
-        )
+
+
+        async def main() -> None:
+            await client.export_storage.azure.get(
+                id=1,
+            )
+
+
+        asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
-            f"api/storages/export/azure/{jsonable_encoder(id)}", method="GET", request_options=request_options
+            f"api/storages/export/azure/{jsonable_encoder(id)}",
+            method="GET",
+            request_options=request_options,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(AzureBlobExportStorage, _response.json())  # type: ignore
+                return typing.cast(
+                    AzureBlobExportStorage,
+                    parse_obj_as(
+                        type_=AzureBlobExportStorage,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -716,6 +840,7 @@ class AsyncAzureClient:
 
     async def delete(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> None:
         """
+
         Delete a specific Azure export storage connection. You will need to provide the export storage ID. You can find this using [List export storages](list).
 
         Deleting an export/target storage connection does not affect tasks with synced data in Label Studio. If you want to remove the tasks that were synced from the external storage, you will need to delete them manually from within the Label Studio UI or use the [Delete tasks](../../tasks/delete-all-tasks) API.
@@ -734,17 +859,27 @@ class AsyncAzureClient:
 
         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.export_storage.azure.delete(
-            id=1,
-        )
+
+
+        async def main() -> None:
+            await client.export_storage.azure.delete(
+                id=1,
+            )
+
+
+        asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
-            f"api/storages/export/azure/{jsonable_encoder(id)}", method="DELETE", request_options=request_options
+            f"api/storages/export/azure/{jsonable_encoder(id)}",
+            method="DELETE",
+            request_options=request_options,
         )
         try:
             if 200 <= _response.status_code < 300:
@@ -769,6 +904,7 @@ class AsyncAzureClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> AzureUpdateResponse:
         """
+
         Update a specific Azure export storage connection. You will need to provide the export storage ID. You can find this using [List export storages](list).
 
         For more information about working with external storage, see [Sync data from external storage](https://labelstud.io/guide/storage).
@@ -812,14 +948,22 @@ class AsyncAzureClient:
 
         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.export_storage.azure.update(
-            id=1,
-        )
+
+
+        async def main() -> None:
+            await client.export_storage.azure.update(
+                id=1,
+            )
+
+
+        asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
             f"api/storages/export/azure/{jsonable_encoder(id)}",
@@ -834,19 +978,29 @@ class AsyncAzureClient:
                 "account_name": account_name,
                 "account_key": account_key,
             },
+            headers={
+                "content-type": "application/json",
+            },
             request_options=request_options,
             omit=OMIT,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(AzureUpdateResponse, _response.json())  # type: ignore
+                return typing.cast(
+                    AzureUpdateResponse,
+                    parse_obj_as(
+                        type_=AzureUpdateResponse,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
         raise ApiError(status_code=_response.status_code, body=_response_json)
 
-    async def sync(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> AzureBlobExportStorage:
+    async def sync(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> AzureBlobExportStorage:
         """
+
         Sync tasks to an Azure export/target storage connection. You will need to provide the export storage ID. You can find this using [List export storages](list).
 
         Sync operations with external containers only go one way. They either create tasks from objects in the container (source/import storage) or push annotations to the output container (export/target storage). Changing something on the Microsoft side doesn’t guarantee consistency in results.
@@ -855,7 +1009,7 @@ class AsyncAzureClient:
 
         Parameters
         ----------
-        id : str
+        id : int
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -867,21 +1021,37 @@ class AsyncAzureClient:
 
         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.export_storage.azure.sync(
-            id="id",
-        )
+
+
+        async def main() -> None:
+            await client.export_storage.azure.sync(
+                id=1,
+            )
+
+
+        asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
-            f"api/storages/export/azure/{jsonable_encoder(id)}/sync", method="POST", request_options=request_options
+            f"api/storages/export/azure/{jsonable_encoder(id)}/sync",
+            method="POST",
+            request_options=request_options,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(AzureBlobExportStorage, _response.json())  # type: ignore
+                return typing.cast(
+                    AzureBlobExportStorage,
+                    parse_obj_as(
+                        type_=AzureBlobExportStorage,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)