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

label_studio_sdk/import_storage/s3s/client.py

@@ -1,14 +1,14 @@
 # This file was auto-generated by Fern from our API Definition.
 
 import typing
+from ...core.client_wrapper import SyncClientWrapper
+from ...core.request_options import RequestOptions
+from ...types.s3s_import_storage import S3SImportStorage
+from ...core.pydantic_utilities import parse_obj_as
 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.request_options import RequestOptions
-from ...types.s3s_import_storage import S3SImportStorage
+from ...core.client_wrapper import AsyncClientWrapper
 
 # this is used as the default value for optional parameters
 OMIT = typing.cast(typing.Any, ...)
@@ -22,6 +22,7 @@ class S3SClient:
         self, *, project: typing.Optional[int] = None, request_options: typing.Optional[RequestOptions] = None
     ) -> typing.List[S3SImportStorage]:
         """
+
         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 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).
@@ -43,7 +44,7 @@ class S3SClient:
 
         Examples
         --------
-        from label_studio_sdk.client import LabelStudio
+        from label_studio_sdk import LabelStudio
 
         client = LabelStudio(
             api_key="YOUR_API_KEY",
@@ -51,11 +52,22 @@ class S3SClient:
         client.import_storage.s3s.list()
         """
         _response = self._client_wrapper.httpx_client.request(
-            "api/storages/s3s", method="GET", params={"project": project}, request_options=request_options
+            "api/storages/s3s",
+            method="GET",
+            params={
+                "project": project,
+            },
+            request_options=request_options,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(typing.List[S3SImportStorage], _response.json())  # type: ignore
+                return typing.cast(
+                    typing.List[S3SImportStorage],
+                    parse_obj_as(
+                        type_=typing.List[S3SImportStorage],  # 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 S3SClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> S3SImportStorage:
         """
+
         Create a new source storage connection to a S3 bucket.
 
         For information about the required fields and prerequisites, see [Amazon S3](https://labelstud.io/guide/storage#Amazon-S3) in the Label Studio documentation.
@@ -143,7 +156,7 @@ class S3SClient:
 
         Examples
         --------
-        from label_studio_sdk.client import LabelStudio
+        from label_studio_sdk import LabelStudio
 
         client = LabelStudio(
             api_key="YOUR_API_KEY",
@@ -169,12 +182,21 @@ class S3SClient:
                 "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(S3SImportStorage, _response.json())  # type: ignore
+                return typing.cast(
+                    S3SImportStorage,
+                    parse_obj_as(
+                        type_=S3SImportStorage,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -182,6 +204,7 @@ class S3SClient:
 
     def get(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> S3SImportStorage:
         """
+
         Get a specific S3 import storage connection. You will need to provide the import storage ID. You can find this using [List import storages](list).
 
         Parameters
@@ -199,7 +222,7 @@ class S3SClient:
 
         Examples
         --------
-        from label_studio_sdk.client import LabelStudio
+        from label_studio_sdk import LabelStudio
 
         client = LabelStudio(
             api_key="YOUR_API_KEY",
@@ -209,11 +232,19 @@ class S3SClient:
         )
         """
         _response = self._client_wrapper.httpx_client.request(
-            f"api/storages/s3s/{jsonable_encoder(id)}", method="GET", request_options=request_options
+            f"api/storages/s3s/{jsonable_encoder(id)}",
+            method="GET",
+            request_options=request_options,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(S3SImportStorage, _response.json())  # type: ignore
+                return typing.cast(
+                    S3SImportStorage,
+                    parse_obj_as(
+                        type_=S3SImportStorage,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -221,6 +252,7 @@ class S3SClient:
 
     def delete(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> None:
         """
+
         Delete a specific S3 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.
@@ -241,7 +273,7 @@ class S3SClient:
 
         Examples
         --------
-        from label_studio_sdk.client import LabelStudio
+        from label_studio_sdk import LabelStudio
 
         client = LabelStudio(
             api_key="YOUR_API_KEY",
@@ -251,7 +283,9 @@ class S3SClient:
         )
         """
         _response = self._client_wrapper.httpx_client.request(
-            f"api/storages/s3s/{jsonable_encoder(id)}", method="DELETE", request_options=request_options
+            f"api/storages/s3s/{jsonable_encoder(id)}",
+            method="DELETE",
+            request_options=request_options,
         )
         try:
             if 200 <= _response.status_code < 300:
@@ -282,6 +316,7 @@ class S3SClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> S3SImportStorage:
         """
+
         Update a specific S3 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).
@@ -343,7 +378,7 @@ class S3SClient:
 
         Examples
         --------
-        from label_studio_sdk.client import LabelStudio
+        from label_studio_sdk import LabelStudio
 
         client = LabelStudio(
             api_key="YOUR_API_KEY",
@@ -371,12 +406,21 @@ class S3SClient:
                 "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(S3SImportStorage, _response.json())  # type: ignore
+                return typing.cast(
+                    S3SImportStorage,
+                    parse_obj_as(
+                        type_=S3SImportStorage,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -402,6 +446,7 @@ class S3SClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> None:
         """
+
         Validate a specific S3 import storage connection. This is useful to ensure that the storage configuration settings are correct and operational before attempting to import data.
 
         Parameters
@@ -457,7 +502,7 @@ class S3SClient:
 
         Examples
         --------
-        from label_studio_sdk.client import LabelStudio
+        from label_studio_sdk import LabelStudio
 
         client = LabelStudio(
             api_key="YOUR_API_KEY",
@@ -483,6 +528,9 @@ class S3SClient:
                 "region_name": region_name,
                 "s3_endpoint": s3endpoint,
             },
+            headers={
+                "content-type": "application/json",
+            },
             request_options=request_options,
             omit=OMIT,
         )
@@ -496,6 +544,7 @@ class S3SClient:
 
     def sync(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> S3SImportStorage:
         """
+
         Sync tasks from an S3 import storage connection. You will need to provide the import storage ID. You can find this using [List import storages](list).
 
         Parameters
@@ -513,7 +562,7 @@ class S3SClient:
 
         Examples
         --------
-        from label_studio_sdk.client import LabelStudio
+        from label_studio_sdk import LabelStudio
 
         client = LabelStudio(
             api_key="YOUR_API_KEY",
@@ -523,11 +572,19 @@ class S3SClient:
         )
         """
         _response = self._client_wrapper.httpx_client.request(
-            f"api/storages/s3s/{jsonable_encoder(id)}/sync", method="POST", request_options=request_options
+            f"api/storages/s3s/{jsonable_encoder(id)}/sync",
+            method="POST",
+            request_options=request_options,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(S3SImportStorage, _response.json())  # type: ignore
+                return typing.cast(
+                    S3SImportStorage,
+                    parse_obj_as(
+                        type_=S3SImportStorage,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -542,6 +599,7 @@ class AsyncS3SClient:
         self, *, project: typing.Optional[int] = None, request_options: typing.Optional[RequestOptions] = None
     ) -> typing.List[S3SImportStorage]:
         """
+
         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 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).
@@ -563,19 +621,38 @@ class AsyncS3SClient:
 
         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.s3s.list()
+
+
+        async def main() -> None:
+            await client.import_storage.s3s.list()
+
+
+        asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
-            "api/storages/s3s", method="GET", params={"project": project}, request_options=request_options
+            "api/storages/s3s",
+            method="GET",
+            params={
+                "project": project,
+            },
+            request_options=request_options,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(typing.List[S3SImportStorage], _response.json())  # type: ignore
+                return typing.cast(
+                    typing.List[S3SImportStorage],
+                    parse_obj_as(
+                        type_=typing.List[S3SImportStorage],  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -601,6 +678,7 @@ class AsyncS3SClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> S3SImportStorage:
         """
+
         Create a new source storage connection to a S3 bucket.
 
         For information about the required fields and prerequisites, see [Amazon S3](https://labelstud.io/guide/storage#Amazon-S3) in the Label Studio documentation.
@@ -663,12 +741,20 @@ class AsyncS3SClient:
 
         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.s3s.create()
+
+
+        async def main() -> None:
+            await client.import_storage.s3s.create()
+
+
+        asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
             "api/storages/s3s",
@@ -689,12 +775,21 @@ class AsyncS3SClient:
                 "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(S3SImportStorage, _response.json())  # type: ignore
+                return typing.cast(
+                    S3SImportStorage,
+                    parse_obj_as(
+                        type_=S3SImportStorage,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -702,6 +797,7 @@ class AsyncS3SClient:
 
     async def get(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> S3SImportStorage:
         """
+
         Get a specific S3 import storage connection. You will need to provide the import storage ID. You can find this using [List import storages](list).
 
         Parameters
@@ -719,21 +815,37 @@ class AsyncS3SClient:
 
         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.s3s.get(
-            id=1,
-        )
+
+
+        async def main() -> None:
+            await client.import_storage.s3s.get(
+                id=1,
+            )
+
+
+        asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
-            f"api/storages/s3s/{jsonable_encoder(id)}", method="GET", request_options=request_options
+            f"api/storages/s3s/{jsonable_encoder(id)}",
+            method="GET",
+            request_options=request_options,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(S3SImportStorage, _response.json())  # type: ignore
+                return typing.cast(
+                    S3SImportStorage,
+                    parse_obj_as(
+                        type_=S3SImportStorage,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -741,6 +853,7 @@ class AsyncS3SClient:
 
     async def delete(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> None:
         """
+
         Delete a specific S3 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.
@@ -761,17 +874,27 @@ class AsyncS3SClient:
 
         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.s3s.delete(
-            id=1,
-        )
+
+
+        async def main() -> None:
+            await client.import_storage.s3s.delete(
+                id=1,
+            )
+
+
+        asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
-            f"api/storages/s3s/{jsonable_encoder(id)}", method="DELETE", request_options=request_options
+            f"api/storages/s3s/{jsonable_encoder(id)}",
+            method="DELETE",
+            request_options=request_options,
         )
         try:
             if 200 <= _response.status_code < 300:
@@ -802,6 +925,7 @@ class AsyncS3SClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> S3SImportStorage:
         """
+
         Update a specific S3 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).
@@ -863,14 +987,22 @@ class AsyncS3SClient:
 
         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.s3s.update(
-            id=1,
-        )
+
+
+        async def main() -> None:
+            await client.import_storage.s3s.update(
+                id=1,
+            )
+
+
+        asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
             f"api/storages/s3s/{jsonable_encoder(id)}",
@@ -891,12 +1023,21 @@ class AsyncS3SClient:
                 "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(S3SImportStorage, _response.json())  # type: ignore
+                return typing.cast(
+                    S3SImportStorage,
+                    parse_obj_as(
+                        type_=S3SImportStorage,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -922,6 +1063,7 @@ class AsyncS3SClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> None:
         """
+
         Validate a specific S3 import storage connection. This is useful to ensure that the storage configuration settings are correct and operational before attempting to import data.
 
         Parameters
@@ -977,12 +1119,20 @@ class AsyncS3SClient:
 
         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.s3s.validate()
+
+
+        async def main() -> None:
+            await client.import_storage.s3s.validate()
+
+
+        asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
             "api/storages/s3s/validate",
@@ -1003,6 +1153,9 @@ class AsyncS3SClient:
                 "region_name": region_name,
                 "s3_endpoint": s3endpoint,
             },
+            headers={
+                "content-type": "application/json",
+            },
             request_options=request_options,
             omit=OMIT,
         )
@@ -1016,6 +1169,7 @@ class AsyncS3SClient:
 
     async def sync(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> S3SImportStorage:
         """
+
         Sync tasks from an S3 import storage connection. You will need to provide the import storage ID. You can find this using [List import storages](list).
 
         Parameters
@@ -1033,21 +1187,37 @@ class AsyncS3SClient:
 
         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.s3s.sync(
-            id=1,
-        )
+
+
+        async def main() -> None:
+            await client.import_storage.s3s.sync(
+                id=1,
+            )
+
+
+        asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
-            f"api/storages/s3s/{jsonable_encoder(id)}/sync", method="POST", request_options=request_options
+            f"api/storages/s3s/{jsonable_encoder(id)}/sync",
+            method="POST",
+            request_options=request_options,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(S3SImportStorage, _response.json())  # type: ignore
+                return typing.cast(
+                    S3SImportStorage,
+                    parse_obj_as(
+                        type_=S3SImportStorage,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)

label_studio_sdk/import_storage/types/import_storage_list_types_response_item.py

@@ -1,30 +1,20 @@
 # This file was auto-generated by Fern from our API Definition.
 
-import datetime as dt
+from ...core.pydantic_utilities import UniversalBaseModel
 import typing
+from ...core.pydantic_utilities import IS_PYDANTIC_V2
+import pydantic
 
-from ...core.datetime_utils import serialize_datetime
-from ...core.pydantic_utilities import deep_union_pydantic_dicts, pydantic_v1
 
-
-class ImportStorageListTypesResponseItem(pydantic_v1.BaseModel):
+class ImportStorageListTypesResponseItem(UniversalBaseModel):
     name: typing.Optional[str] = None
     title: typing.Optional[str] = None
 
-    def json(self, **kwargs: typing.Any) -> str:
-        kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}
-        return super().json(**kwargs_with_defaults)
-
-    def dict(self, **kwargs: typing.Any) -> typing.Dict[str, typing.Any]:
-        kwargs_with_defaults_exclude_unset: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}
-        kwargs_with_defaults_exclude_none: typing.Any = {"by_alias": True, "exclude_none": True, **kwargs}
-
-        return deep_union_pydantic_dicts(
-            super().dict(**kwargs_with_defaults_exclude_unset), super().dict(**kwargs_with_defaults_exclude_none)
-        )
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
 
-    class Config:
-        frozen = True
-        smart_union = True
-        extra = pydantic_v1.Extra.allow
-        json_encoders = {dt.datetime: serialize_datetime}
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow