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

label_studio_sdk/import_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_import_storage import GcsImportStorage
+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[GcsImportStorage]:
         """
+
         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 Google import (source) 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.import_storage.gcs.list()
         """
         _response = self._client_wrapper.httpx_client.request(
-            "api/storages/gcs/", method="GET", params={"project": project}, request_options=request_options
+            "api/storages/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[GcsImportStorage], _response.json())  # type: ignore
+                return typing.cast(
+                    typing.List[GcsImportStorage],
+                    parse_obj_as(
+                        type_=typing.List[GcsImportStorage],  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -80,6 +92,7 @@ class GcsClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> GcsCreateResponse:
         """
+
         Create a new source storage connection to a Google Cloud Storage bucket.
 
         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.
@@ -133,7 +146,7 @@ class GcsClient:
 
         Examples
         --------
-        from label_studio_sdk.client import LabelStudio
+        from label_studio_sdk import LabelStudio
 
         client = LabelStudio(
             api_key="YOUR_API_KEY",
@@ -156,12 +169,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)
@@ -185,6 +207,7 @@ class GcsClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> None:
         """
+
         Validate a specific GCS import storage connection. This is useful to ensure that the storage configuration settings are correct and operational before attempting to import data.
 
         Parameters
@@ -234,7 +257,7 @@ class GcsClient:
 
         Examples
         --------
-        from label_studio_sdk.client import LabelStudio
+        from label_studio_sdk import LabelStudio
 
         client = LabelStudio(
             api_key="YOUR_API_KEY",
@@ -258,6 +281,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,
         )
@@ -271,6 +297,7 @@ class GcsClient:
 
     def get(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> GcsImportStorage:
         """
+
         Get a specific GCS import storage connection. You will need to provide the import storage ID. You can find this using [List import storages](list).
 
         For more information about working with external storage, see [Sync data from external storage](https://labelstud.io/guide/storage).
@@ -290,7 +317,7 @@ class GcsClient:
 
         Examples
         --------
-        from label_studio_sdk.client import LabelStudio
+        from label_studio_sdk import LabelStudio
 
         client = LabelStudio(
             api_key="YOUR_API_KEY",
@@ -300,11 +327,19 @@ class GcsClient:
         )
         """
         _response = self._client_wrapper.httpx_client.request(
-            f"api/storages/gcs/{jsonable_encoder(id)}", method="GET", request_options=request_options
+            f"api/storages/gcs/{jsonable_encoder(id)}",
+            method="GET",
+            request_options=request_options,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(GcsImportStorage, _response.json())  # type: ignore
+                return typing.cast(
+                    GcsImportStorage,
+                    parse_obj_as(
+                        type_=GcsImportStorage,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -312,6 +347,7 @@ class GcsClient:
 
     def delete(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> None:
         """
+
         Delete a specific GCS import storage connection. You will need to provide the import storage ID. You can find this using [List import storages](list).
 
         Deleting a source storage connection does not affect tasks with synced data in Label Studio. The sync process is designed to import new or updated tasks from the connected storage into the project, but it does not track deletions of files from the storage. Therefore, if you remove the external storage connection, the tasks that were created from that storage will remain in the project.
@@ -332,7 +368,7 @@ class GcsClient:
 
         Examples
         --------
-        from label_studio_sdk.client import LabelStudio
+        from label_studio_sdk import LabelStudio
 
         client = LabelStudio(
             api_key="YOUR_API_KEY",
@@ -342,7 +378,9 @@ class GcsClient:
         )
         """
         _response = self._client_wrapper.httpx_client.request(
-            f"api/storages/gcs/{jsonable_encoder(id)}", method="DELETE", request_options=request_options
+            f"api/storages/gcs/{jsonable_encoder(id)}",
+            method="DELETE",
+            request_options=request_options,
         )
         try:
             if 200 <= _response.status_code < 300:
@@ -370,6 +408,7 @@ class GcsClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> GcsUpdateResponse:
         """
+
         Update a specific GCS import storage connection. You will need to provide the import storage ID. You can find this using [List import storages](list).
 
         For more information about working with external storage, see [Sync data from external storage](https://labelstud.io/guide/storage).
@@ -422,7 +461,7 @@ class GcsClient:
 
         Examples
         --------
-        from label_studio_sdk.client import LabelStudio
+        from label_studio_sdk import LabelStudio
 
         client = LabelStudio(
             api_key="YOUR_API_KEY",
@@ -447,12 +486,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(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)
@@ -460,6 +508,7 @@ class GcsClient:
 
     def sync(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> GcsImportStorage:
         """
+
         Sync tasks from a GCS import storage connection. You will need to provide the import storage ID. You can find this using [List import 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.
@@ -481,7 +530,7 @@ class GcsClient:
 
         Examples
         --------
-        from label_studio_sdk.client import LabelStudio
+        from label_studio_sdk import LabelStudio
 
         client = LabelStudio(
             api_key="YOUR_API_KEY",
@@ -491,11 +540,19 @@ class GcsClient:
         )
         """
         _response = self._client_wrapper.httpx_client.request(
-            f"api/storages/gcs/{jsonable_encoder(id)}/sync", method="POST", request_options=request_options
+            f"api/storages/gcs/{jsonable_encoder(id)}/sync",
+            method="POST",
+            request_options=request_options,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(GcsImportStorage, _response.json())  # type: ignore
+                return typing.cast(
+                    GcsImportStorage,
+                    parse_obj_as(
+                        type_=GcsImportStorage,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -510,6 +567,7 @@ class AsyncGcsClient:
         self, *, project: typing.Optional[int] = None, request_options: typing.Optional[RequestOptions] = None
     ) -> typing.List[GcsImportStorage]:
         """
+
         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 Google import (source) 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).
@@ -531,19 +589,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.import_storage.gcs.list()
+
+
+        async def main() -> None:
+            await client.import_storage.gcs.list()
+
+
+        asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
-            "api/storages/gcs/", method="GET", params={"project": project}, request_options=request_options
+            "api/storages/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[GcsImportStorage], _response.json())  # type: ignore
+                return typing.cast(
+                    typing.List[GcsImportStorage],
+                    parse_obj_as(
+                        type_=typing.List[GcsImportStorage],  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -566,6 +643,7 @@ class AsyncGcsClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> GcsCreateResponse:
         """
+
         Create a new source storage connection to a Google Cloud Storage bucket.
 
         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.
@@ -619,12 +697,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.import_storage.gcs.create()
+
+
+        async def main() -> None:
+            await client.import_storage.gcs.create()
+
+
+        asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
             "api/storages/gcs/",
@@ -642,12 +728,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)
@@ -671,6 +766,7 @@ class AsyncGcsClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> None:
         """
+
         Validate a specific GCS import storage connection. This is useful to ensure that the storage configuration settings are correct and operational before attempting to import data.
 
         Parameters
@@ -720,12 +816,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.import_storage.gcs.validate()
+
+
+        async def main() -> None:
+            await client.import_storage.gcs.validate()
+
+
+        asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
             "api/storages/gcs/validate",
@@ -744,6 +848,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,
         )
@@ -757,6 +864,7 @@ class AsyncGcsClient:
 
     async def get(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> GcsImportStorage:
         """
+
         Get a specific GCS import storage connection. You will need to provide the import storage ID. You can find this using [List import storages](list).
 
         For more information about working with external storage, see [Sync data from external storage](https://labelstud.io/guide/storage).
@@ -776,21 +884,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.import_storage.gcs.get(
-            id=1,
-        )
+
+
+        async def main() -> None:
+            await client.import_storage.gcs.get(
+                id=1,
+            )
+
+
+        asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
-            f"api/storages/gcs/{jsonable_encoder(id)}", method="GET", request_options=request_options
+            f"api/storages/gcs/{jsonable_encoder(id)}",
+            method="GET",
+            request_options=request_options,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(GcsImportStorage, _response.json())  # type: ignore
+                return typing.cast(
+                    GcsImportStorage,
+                    parse_obj_as(
+                        type_=GcsImportStorage,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -798,6 +922,7 @@ class AsyncGcsClient:
 
     async def delete(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> None:
         """
+
         Delete a specific GCS import storage connection. You will need to provide the import storage ID. You can find this using [List import storages](list).
 
         Deleting a source storage connection does not affect tasks with synced data in Label Studio. The sync process is designed to import new or updated tasks from the connected storage into the project, but it does not track deletions of files from the storage. Therefore, if you remove the external storage connection, the tasks that were created from that storage will remain in the project.
@@ -818,17 +943,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.import_storage.gcs.delete(
-            id=1,
-        )
+
+
+        async def main() -> None:
+            await client.import_storage.gcs.delete(
+                id=1,
+            )
+
+
+        asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
-            f"api/storages/gcs/{jsonable_encoder(id)}", method="DELETE", request_options=request_options
+            f"api/storages/gcs/{jsonable_encoder(id)}",
+            method="DELETE",
+            request_options=request_options,
         )
         try:
             if 200 <= _response.status_code < 300:
@@ -856,6 +991,7 @@ class AsyncGcsClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> GcsUpdateResponse:
         """
+
         Update a specific GCS import storage connection. You will need to provide the import storage ID. You can find this using [List import storages](list).
 
         For more information about working with external storage, see [Sync data from external storage](https://labelstud.io/guide/storage).
@@ -908,14 +1044,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.import_storage.gcs.update(
-            id=1,
-        )
+
+
+        async def main() -> None:
+            await client.import_storage.gcs.update(
+                id=1,
+            )
+
+
+        asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
             f"api/storages/gcs/{jsonable_encoder(id)}",
@@ -933,12 +1077,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(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)
@@ -946,6 +1099,7 @@ class AsyncGcsClient:
 
     async def sync(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> GcsImportStorage:
         """
+
         Sync tasks from a GCS import storage connection. You will need to provide the import storage ID. You can find this using [List import 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.
@@ -967,21 +1121,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.import_storage.gcs.sync(
-            id=1,
-        )
+
+
+        async def main() -> None:
+            await client.import_storage.gcs.sync(
+                id=1,
+            )
+
+
+        asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
-            f"api/storages/gcs/{jsonable_encoder(id)}/sync", method="POST", request_options=request_options
+            f"api/storages/gcs/{jsonable_encoder(id)}/sync",
+            method="POST",
+            request_options=request_options,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(GcsImportStorage, _response.json())  # type: ignore
+                return typing.cast(
+                    GcsImportStorage,
+                    parse_obj_as(
+                        type_=GcsImportStorage,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)