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

label_studio_sdk/export_storage/s3/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.s3export_storage import S3ExportStorage
+from ...core.pydantic_utilities import parse_obj_as
+from json.decoder import JSONDecodeError
+from ...core.api_error import ApiError
 from .types.s3create_response import S3CreateResponse
+from ...core.jsonable_encoder import jsonable_encoder
 from .types.s3update_response import S3UpdateResponse
+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 S3Client:
         self, *, project: typing.Optional[int] = None, request_options: typing.Optional[RequestOptions] = None
     ) -> typing.List[S3ExportStorage]:
         """
+
         You can connect your S3 bucket to Label Studio as a source storage or target storage. Use this API request to get a list of all S3 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 S3Client:
 
         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 S3Client:
         client.export_storage.s3.list()
         """
         _response = self._client_wrapper.httpx_client.request(
-            "api/storages/export/s3", method="GET", params={"project": project}, request_options=request_options
+            "api/storages/export/s3",
+            method="GET",
+            params={
+                "project": project,
+            },
+            request_options=request_options,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(typing.List[S3ExportStorage], _response.json())  # type: ignore
+                return typing.cast(
+                    typing.List[S3ExportStorage],
+                    parse_obj_as(
+                        type_=typing.List[S3ExportStorage],  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -81,6 +93,7 @@ class S3Client:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> S3CreateResponse:
         """
+
         Create a new target storage connection to S3 storage.
 
         For information about the required fields and prerequisites, see [Amazon S3](https://labelstud.io/guide/storage#Amazon-S3) in the Label Studio documentation.
@@ -135,7 +148,7 @@ class S3Client:
 
         Examples
         --------
-        from label_studio_sdk.client import LabelStudio
+        from label_studio_sdk import LabelStudio
 
         client = LabelStudio(
             api_key="YOUR_API_KEY",
@@ -159,12 +172,21 @@ class S3Client:
                 "region_name": region_name,
                 "s3_endpoint": s3endpoint,
             },
+            headers={
+                "content-type": "application/json",
+            },
             request_options=request_options,
             omit=OMIT,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(S3CreateResponse, _response.json())  # type: ignore
+                return typing.cast(
+                    S3CreateResponse,
+                    parse_obj_as(
+                        type_=S3CreateResponse,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -189,6 +211,7 @@ class S3Client:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> None:
         """
+
         Validate a specific S3 export storage connection. This is useful to ensure that the storage configuration settings are correct and operational before attempting to export data.
 
         Parameters
@@ -241,7 +264,7 @@ class S3Client:
 
         Examples
         --------
-        from label_studio_sdk.client import LabelStudio
+        from label_studio_sdk import LabelStudio
 
         client = LabelStudio(
             api_key="YOUR_API_KEY",
@@ -266,6 +289,9 @@ class S3Client:
                 "region_name": region_name,
                 "s3_endpoint": s3endpoint,
             },
+            headers={
+                "content-type": "application/json",
+            },
             request_options=request_options,
             omit=OMIT,
         )
@@ -279,6 +305,7 @@ class S3Client:
 
     def get(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> S3ExportStorage:
         """
+
         Get a specific S3 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).
@@ -298,7 +325,7 @@ class S3Client:
 
         Examples
         --------
-        from label_studio_sdk.client import LabelStudio
+        from label_studio_sdk import LabelStudio
 
         client = LabelStudio(
             api_key="YOUR_API_KEY",
@@ -308,11 +335,19 @@ class S3Client:
         )
         """
         _response = self._client_wrapper.httpx_client.request(
-            f"api/storages/export/s3/{jsonable_encoder(id)}", method="GET", request_options=request_options
+            f"api/storages/export/s3/{jsonable_encoder(id)}",
+            method="GET",
+            request_options=request_options,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(S3ExportStorage, _response.json())  # type: ignore
+                return typing.cast(
+                    S3ExportStorage,
+                    parse_obj_as(
+                        type_=S3ExportStorage,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -320,6 +355,7 @@ class S3Client:
 
     def delete(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> None:
         """
+
         Delete a specific S3 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.
@@ -338,7 +374,7 @@ class S3Client:
 
         Examples
         --------
-        from label_studio_sdk.client import LabelStudio
+        from label_studio_sdk import LabelStudio
 
         client = LabelStudio(
             api_key="YOUR_API_KEY",
@@ -348,7 +384,9 @@ class S3Client:
         )
         """
         _response = self._client_wrapper.httpx_client.request(
-            f"api/storages/export/s3/{jsonable_encoder(id)}", method="DELETE", request_options=request_options
+            f"api/storages/export/s3/{jsonable_encoder(id)}",
+            method="DELETE",
+            request_options=request_options,
         )
         try:
             if 200 <= _response.status_code < 300:
@@ -377,6 +415,7 @@ class S3Client:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> S3UpdateResponse:
         """
+
         Update a specific S3 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).
@@ -432,7 +471,7 @@ class S3Client:
 
         Examples
         --------
-        from label_studio_sdk.client import LabelStudio
+        from label_studio_sdk import LabelStudio
 
         client = LabelStudio(
             api_key="YOUR_API_KEY",
@@ -458,19 +497,29 @@ class S3Client:
                 "region_name": region_name,
                 "s3_endpoint": s3endpoint,
             },
+            headers={
+                "content-type": "application/json",
+            },
             request_options=request_options,
             omit=OMIT,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(S3UpdateResponse, _response.json())  # type: ignore
+                return typing.cast(
+                    S3UpdateResponse,
+                    parse_obj_as(
+                        type_=S3UpdateResponse,  # 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) -> S3ExportStorage:
+    def sync(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> S3ExportStorage:
         """
+
         Sync tasks to an S3 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.
@@ -479,7 +528,7 @@ class S3Client:
 
         Parameters
         ----------
-        id : str
+        id : int
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -491,21 +540,29 @@ class S3Client:
 
         Examples
         --------
-        from label_studio_sdk.client import LabelStudio
+        from label_studio_sdk import LabelStudio
 
         client = LabelStudio(
             api_key="YOUR_API_KEY",
         )
         client.export_storage.s3.sync(
-            id="id",
+            id=1,
         )
         """
         _response = self._client_wrapper.httpx_client.request(
-            f"api/storages/export/s3/{jsonable_encoder(id)}/sync", method="POST", request_options=request_options
+            f"api/storages/export/s3/{jsonable_encoder(id)}/sync",
+            method="POST",
+            request_options=request_options,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(S3ExportStorage, _response.json())  # type: ignore
+                return typing.cast(
+                    S3ExportStorage,
+                    parse_obj_as(
+                        type_=S3ExportStorage,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -520,6 +577,7 @@ class AsyncS3Client:
         self, *, project: typing.Optional[int] = None, request_options: typing.Optional[RequestOptions] = None
     ) -> typing.List[S3ExportStorage]:
         """
+
         You can connect your S3 bucket to Label Studio as a source storage or target storage. Use this API request to get a list of all S3 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).
@@ -541,19 +599,38 @@ class AsyncS3Client:
 
         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.s3.list()
+
+
+        async def main() -> None:
+            await client.export_storage.s3.list()
+
+
+        asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
-            "api/storages/export/s3", method="GET", params={"project": project}, request_options=request_options
+            "api/storages/export/s3",
+            method="GET",
+            params={
+                "project": project,
+            },
+            request_options=request_options,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(typing.List[S3ExportStorage], _response.json())  # type: ignore
+                return typing.cast(
+                    typing.List[S3ExportStorage],
+                    parse_obj_as(
+                        type_=typing.List[S3ExportStorage],  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -577,6 +654,7 @@ class AsyncS3Client:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> S3CreateResponse:
         """
+
         Create a new target storage connection to S3 storage.
 
         For information about the required fields and prerequisites, see [Amazon S3](https://labelstud.io/guide/storage#Amazon-S3) in the Label Studio documentation.
@@ -631,12 +709,20 @@ class AsyncS3Client:
 
         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.s3.create()
+
+
+        async def main() -> None:
+            await client.export_storage.s3.create()
+
+
+        asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
             "api/storages/export/s3",
@@ -655,12 +741,21 @@ class AsyncS3Client:
                 "region_name": region_name,
                 "s3_endpoint": s3endpoint,
             },
+            headers={
+                "content-type": "application/json",
+            },
             request_options=request_options,
             omit=OMIT,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(S3CreateResponse, _response.json())  # type: ignore
+                return typing.cast(
+                    S3CreateResponse,
+                    parse_obj_as(
+                        type_=S3CreateResponse,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -685,6 +780,7 @@ class AsyncS3Client:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> None:
         """
+
         Validate a specific S3 export storage connection. This is useful to ensure that the storage configuration settings are correct and operational before attempting to export data.
 
         Parameters
@@ -737,12 +833,20 @@ class AsyncS3Client:
 
         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.s3.validate()
+
+
+        async def main() -> None:
+            await client.export_storage.s3.validate()
+
+
+        asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
             "api/storages/export/s3/validate",
@@ -762,6 +866,9 @@ class AsyncS3Client:
                 "region_name": region_name,
                 "s3_endpoint": s3endpoint,
             },
+            headers={
+                "content-type": "application/json",
+            },
             request_options=request_options,
             omit=OMIT,
         )
@@ -775,6 +882,7 @@ class AsyncS3Client:
 
     async def get(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> S3ExportStorage:
         """
+
         Get a specific S3 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).
@@ -794,21 +902,37 @@ class AsyncS3Client:
 
         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.s3.get(
-            id=1,
-        )
+
+
+        async def main() -> None:
+            await client.export_storage.s3.get(
+                id=1,
+            )
+
+
+        asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
-            f"api/storages/export/s3/{jsonable_encoder(id)}", method="GET", request_options=request_options
+            f"api/storages/export/s3/{jsonable_encoder(id)}",
+            method="GET",
+            request_options=request_options,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(S3ExportStorage, _response.json())  # type: ignore
+                return typing.cast(
+                    S3ExportStorage,
+                    parse_obj_as(
+                        type_=S3ExportStorage,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -816,6 +940,7 @@ class AsyncS3Client:
 
     async def delete(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> None:
         """
+
         Delete a specific S3 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.
@@ -834,17 +959,27 @@ class AsyncS3Client:
 
         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.s3.delete(
-            id=1,
-        )
+
+
+        async def main() -> None:
+            await client.export_storage.s3.delete(
+                id=1,
+            )
+
+
+        asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
-            f"api/storages/export/s3/{jsonable_encoder(id)}", method="DELETE", request_options=request_options
+            f"api/storages/export/s3/{jsonable_encoder(id)}",
+            method="DELETE",
+            request_options=request_options,
         )
         try:
             if 200 <= _response.status_code < 300:
@@ -873,6 +1008,7 @@ class AsyncS3Client:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> S3UpdateResponse:
         """
+
         Update a specific S3 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).
@@ -928,14 +1064,22 @@ class AsyncS3Client:
 
         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.s3.update(
-            id=1,
-        )
+
+
+        async def main() -> None:
+            await client.export_storage.s3.update(
+                id=1,
+            )
+
+
+        asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
             f"api/storages/export/s3/{jsonable_encoder(id)}",
@@ -954,19 +1098,29 @@ class AsyncS3Client:
                 "region_name": region_name,
                 "s3_endpoint": s3endpoint,
             },
+            headers={
+                "content-type": "application/json",
+            },
             request_options=request_options,
             omit=OMIT,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(S3UpdateResponse, _response.json())  # type: ignore
+                return typing.cast(
+                    S3UpdateResponse,
+                    parse_obj_as(
+                        type_=S3UpdateResponse,  # 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) -> S3ExportStorage:
+    async def sync(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> S3ExportStorage:
         """
+
         Sync tasks to an S3 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.
@@ -975,7 +1129,7 @@ class AsyncS3Client:
 
         Parameters
         ----------
-        id : str
+        id : int
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -987,21 +1141,37 @@ class AsyncS3Client:
 
         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.s3.sync(
-            id="id",
-        )
+
+
+        async def main() -> None:
+            await client.export_storage.s3.sync(
+                id=1,
+            )
+
+
+        asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
-            f"api/storages/export/s3/{jsonable_encoder(id)}/sync", method="POST", request_options=request_options
+            f"api/storages/export/s3/{jsonable_encoder(id)}/sync",
+            method="POST",
+            request_options=request_options,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(S3ExportStorage, _response.json())  # type: ignore
+                return typing.cast(
+                    S3ExportStorage,
+                    parse_obj_as(
+                        type_=S3ExportStorage,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)