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

label_studio_sdk/export_storage/gcs/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.gcs_export_storage import GcsExportStorage
+from ...core.pydantic_utilities import parse_obj_as
+from json.decoder import JSONDecodeError
+from ...core.api_error import ApiError
 from .types.gcs_create_response import GcsCreateResponse
+from ...core.jsonable_encoder import jsonable_encoder
 from .types.gcs_update_response import GcsUpdateResponse
+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 GcsClient:
         self, *, project: typing.Optional[int] = None, request_options: typing.Optional[RequestOptions] = None
     ) -> typing.List[GcsExportStorage]:
         """
+
         You can connect your Google Cloud Storage bucket to Label Studio as a source storage or target storage. Use this API request to get a list of all GCS 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 GcsClient:
 
         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 GcsClient:
         client.export_storage.gcs.list()
         """
         _response = self._client_wrapper.httpx_client.request(
-            "api/storages/export/gcs", method="GET", params={"project": project}, request_options=request_options
+            "api/storages/export/gcs",
+            method="GET",
+            params={
+                "project": project,
+            },
+            request_options=request_options,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(typing.List[GcsExportStorage], _response.json())  # type: ignore
+                return typing.cast(
+                    typing.List[GcsExportStorage],
+                    parse_obj_as(
+                        type_=typing.List[GcsExportStorage],  # 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 GcsClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> GcsCreateResponse:
         """
+
         Create a new target storage connection to Google Cloud Storage.
 
         For information about the required fields and prerequisites, see [Google Cloud Storage](https://labelstud.io/guide/storage#Google-Cloud-Storage) in the Label Studio documentation.
@@ -119,7 +132,7 @@ class GcsClient:
 
         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 GcsClient:
                 "google_application_credentials": google_application_credentials,
                 "google_project_id": google_project_id,
             },
+            headers={
+                "content-type": "application/json",
+            },
             request_options=request_options,
             omit=OMIT,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(GcsCreateResponse, _response.json())  # type: ignore
+                return typing.cast(
+                    GcsCreateResponse,
+                    parse_obj_as(
+                        type_=GcsCreateResponse,  # 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 GcsClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> None:
         """
+
         Validate a specific GCS 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 GcsClient:
 
         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 GcsClient:
                 "google_application_credentials": google_application_credentials,
                 "google_project_id": google_project_id,
             },
+            headers={
+                "content-type": "application/json",
+            },
             request_options=request_options,
             omit=OMIT,
         )
@@ -239,6 +265,7 @@ class GcsClient:
 
     def get(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> GcsExportStorage:
         """
+
         Get a specific GCS 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 GcsClient:
 
         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 GcsClient:
         )
         """
         _response = self._client_wrapper.httpx_client.request(
-            f"api/storages/export/gcs/{jsonable_encoder(id)}", method="GET", request_options=request_options
+            f"api/storages/export/gcs/{jsonable_encoder(id)}",
+            method="GET",
+            request_options=request_options,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(GcsExportStorage, _response.json())  # type: ignore
+                return typing.cast(
+                    GcsExportStorage,
+                    parse_obj_as(
+                        type_=GcsExportStorage,  # 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 GcsClient:
 
     def delete(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> None:
         """
+
         Delete a specific GCS 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 GcsClient:
 
         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 GcsClient:
         )
         """
         _response = self._client_wrapper.httpx_client.request(
-            f"api/storages/export/gcs/{jsonable_encoder(id)}", method="DELETE", request_options=request_options
+            f"api/storages/export/gcs/{jsonable_encoder(id)}",
+            method="DELETE",
+            request_options=request_options,
         )
         try:
             if 200 <= _response.status_code < 300:
@@ -333,6 +371,7 @@ class GcsClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> GcsUpdateResponse:
         """
+
         Update a specific GCS 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 GcsClient:
 
         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 GcsClient:
                 "google_application_credentials": google_application_credentials,
                 "google_project_id": google_project_id,
             },
+            headers={
+                "content-type": "application/json",
+            },
             request_options=request_options,
             omit=OMIT,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(GcsUpdateResponse, _response.json())  # type: ignore
+                return typing.cast(
+                    GcsUpdateResponse,
+                    parse_obj_as(
+                        type_=GcsUpdateResponse,  # 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) -> GcsExportStorage:
+    def sync(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> GcsExportStorage:
         """
+
         Sync tasks to a GCS 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 buckets only go one way. They either create tasks from objects in the bucket (source/import storage) or push annotations to the output bucket (export/target storage). Changing something on the bucket side doesn’t guarantee consistency in results.
@@ -419,7 +468,7 @@ class GcsClient:
 
         Parameters
         ----------
-        id : str
+        id : int
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -431,21 +480,29 @@ class GcsClient:
 
         Examples
         --------
-        from label_studio_sdk.client import LabelStudio
+        from label_studio_sdk import LabelStudio
 
         client = LabelStudio(
             api_key="YOUR_API_KEY",
         )
         client.export_storage.gcs.sync(
-            id="id",
+            id=1,
         )
         """
         _response = self._client_wrapper.httpx_client.request(
-            f"api/storages/export/gcs/{jsonable_encoder(id)}/sync", method="POST", request_options=request_options
+            f"api/storages/export/gcs/{jsonable_encoder(id)}/sync",
+            method="POST",
+            request_options=request_options,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(GcsExportStorage, _response.json())  # type: ignore
+                return typing.cast(
+                    GcsExportStorage,
+                    parse_obj_as(
+                        type_=GcsExportStorage,  # 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 AsyncGcsClient:
         self, *, project: typing.Optional[int] = None, request_options: typing.Optional[RequestOptions] = None
     ) -> typing.List[GcsExportStorage]:
         """
+
         You can connect your Google Cloud Storage bucket to Label Studio as a source storage or target storage. Use this API request to get a list of all GCS 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 AsyncGcsClient:
 
         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.gcs.list()
+
+
+        async def main() -> None:
+            await client.export_storage.gcs.list()
+
+
+        asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
-            "api/storages/export/gcs", method="GET", params={"project": project}, request_options=request_options
+            "api/storages/export/gcs",
+            method="GET",
+            params={
+                "project": project,
+            },
+            request_options=request_options,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(typing.List[GcsExportStorage], _response.json())  # type: ignore
+                return typing.cast(
+                    typing.List[GcsExportStorage],
+                    parse_obj_as(
+                        type_=typing.List[GcsExportStorage],  # 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 AsyncGcsClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> GcsCreateResponse:
         """
+
         Create a new target storage connection to Google Cloud Storage.
 
         For information about the required fields and prerequisites, see [Google Cloud Storage](https://labelstud.io/guide/storage#Google-Cloud-Storage) in the Label Studio documentation.
@@ -555,12 +633,20 @@ class AsyncGcsClient:
 
         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.gcs.create()
+
+
+        async def main() -> None:
+            await client.export_storage.gcs.create()
+
+
+        asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
             "api/storages/export/gcs",
@@ -575,12 +661,21 @@ class AsyncGcsClient:
                 "google_application_credentials": google_application_credentials,
                 "google_project_id": google_project_id,
             },
+            headers={
+                "content-type": "application/json",
+            },
             request_options=request_options,
             omit=OMIT,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(GcsCreateResponse, _response.json())  # type: ignore
+                return typing.cast(
+                    GcsCreateResponse,
+                    parse_obj_as(
+                        type_=GcsCreateResponse,  # 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 AsyncGcsClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> None:
         """
+
         Validate a specific GCS 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 AsyncGcsClient:
 
         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.gcs.validate()
+
+
+        async def main() -> None:
+            await client.export_storage.gcs.validate()
+
+
+        asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
             "api/storages/export/gcs/validate",
@@ -662,6 +766,9 @@ class AsyncGcsClient:
                 "google_application_credentials": google_application_credentials,
                 "google_project_id": google_project_id,
             },
+            headers={
+                "content-type": "application/json",
+            },
             request_options=request_options,
             omit=OMIT,
         )
@@ -675,6 +782,7 @@ class AsyncGcsClient:
 
     async def get(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> GcsExportStorage:
         """
+
         Get a specific GCS 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 AsyncGcsClient:
 
         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.gcs.get(
-            id=1,
-        )
+
+
+        async def main() -> None:
+            await client.export_storage.gcs.get(
+                id=1,
+            )
+
+
+        asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
-            f"api/storages/export/gcs/{jsonable_encoder(id)}", method="GET", request_options=request_options
+            f"api/storages/export/gcs/{jsonable_encoder(id)}",
+            method="GET",
+            request_options=request_options,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(GcsExportStorage, _response.json())  # type: ignore
+                return typing.cast(
+                    GcsExportStorage,
+                    parse_obj_as(
+                        type_=GcsExportStorage,  # 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 AsyncGcsClient:
 
     async def delete(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> None:
         """
+
         Delete a specific GCS 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 AsyncGcsClient:
 
         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.gcs.delete(
-            id=1,
-        )
+
+
+        async def main() -> None:
+            await client.export_storage.gcs.delete(
+                id=1,
+            )
+
+
+        asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
-            f"api/storages/export/gcs/{jsonable_encoder(id)}", method="DELETE", request_options=request_options
+            f"api/storages/export/gcs/{jsonable_encoder(id)}",
+            method="DELETE",
+            request_options=request_options,
         )
         try:
             if 200 <= _response.status_code < 300:
@@ -769,6 +904,7 @@ class AsyncGcsClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> GcsUpdateResponse:
         """
+
         Update a specific GCS 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 AsyncGcsClient:
 
         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.gcs.update(
-            id=1,
-        )
+
+
+        async def main() -> None:
+            await client.export_storage.gcs.update(
+                id=1,
+            )
+
+
+        asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
             f"api/storages/export/gcs/{jsonable_encoder(id)}",
@@ -834,19 +978,29 @@ class AsyncGcsClient:
                 "google_application_credentials": google_application_credentials,
                 "google_project_id": google_project_id,
             },
+            headers={
+                "content-type": "application/json",
+            },
             request_options=request_options,
             omit=OMIT,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(GcsUpdateResponse, _response.json())  # type: ignore
+                return typing.cast(
+                    GcsUpdateResponse,
+                    parse_obj_as(
+                        type_=GcsUpdateResponse,  # 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) -> GcsExportStorage:
+    async def sync(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> GcsExportStorage:
         """
+
         Sync tasks to a GCS 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 buckets only go one way. They either create tasks from objects in the bucket (source/import storage) or push annotations to the output bucket (export/target storage). Changing something on the bucket side doesn’t guarantee consistency in results.
@@ -855,7 +1009,7 @@ class AsyncGcsClient:
 
         Parameters
         ----------
-        id : str
+        id : int
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -867,21 +1021,37 @@ class AsyncGcsClient:
 
         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.gcs.sync(
-            id="id",
-        )
+
+
+        async def main() -> None:
+            await client.export_storage.gcs.sync(
+                id=1,
+            )
+
+
+        asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
-            f"api/storages/export/gcs/{jsonable_encoder(id)}/sync", method="POST", request_options=request_options
+            f"api/storages/export/gcs/{jsonable_encoder(id)}/sync",
+            method="POST",
+            request_options=request_options,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(GcsExportStorage, _response.json())  # type: ignore
+                return typing.cast(
+                    GcsExportStorage,
+                    parse_obj_as(
+                        type_=GcsExportStorage,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)