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

label_studio_sdk/export_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_export_storage import S3SExportStorage
+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_export_storage import S3SExportStorage
+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[S3SExportStorage]:
         """
+
         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).
@@ -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.export_storage.s3s.list()
         """
         _response = self._client_wrapper.httpx_client.request(
-            "api/storages/export/s3s", method="GET", params={"project": project}, request_options=request_options
+            "api/storages/export/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[S3SExportStorage], _response.json())  # type: ignore
+                return typing.cast(
+                    typing.List[S3SExportStorage],
+                    parse_obj_as(
+                        type_=typing.List[S3SExportStorage],  # 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 S3SClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> S3SExportStorage:
         """
+
         Create a new target storage connection to a S3 bucket with IAM role access.
 
         For information about the required fields and prerequisites, see [Amazon S3](https://docs.humansignal.com/guide/storage#Set-up-an-S3-connection-with-IAM-role-access) in the Label Studio documentation.
@@ -123,7 +136,7 @@ class S3SClient:
 
         Examples
         --------
-        from label_studio_sdk.client import LabelStudio
+        from label_studio_sdk import LabelStudio
 
         client = LabelStudio(
             api_key="YOUR_API_KEY",
@@ -145,12 +158,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(S3SExportStorage, _response.json())  # type: ignore
+                return typing.cast(
+                    S3SExportStorage,
+                    parse_obj_as(
+                        type_=S3SExportStorage,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -158,6 +180,7 @@ class S3SClient:
 
     def get(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> S3SExportStorage:
         """
+
         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).
 
         Parameters
@@ -175,7 +198,7 @@ class S3SClient:
 
         Examples
         --------
-        from label_studio_sdk.client import LabelStudio
+        from label_studio_sdk import LabelStudio
 
         client = LabelStudio(
             api_key="YOUR_API_KEY",
@@ -185,11 +208,19 @@ class S3SClient:
         )
         """
         _response = self._client_wrapper.httpx_client.request(
-            f"api/storages/export/s3s/{jsonable_encoder(id)}", method="GET", request_options=request_options
+            f"api/storages/export/s3s/{jsonable_encoder(id)}",
+            method="GET",
+            request_options=request_options,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(S3SExportStorage, _response.json())  # type: ignore
+                return typing.cast(
+                    S3SExportStorage,
+                    parse_obj_as(
+                        type_=S3SExportStorage,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -197,6 +228,7 @@ class S3SClient:
 
     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).
 
         Parameters
@@ -213,7 +245,7 @@ class S3SClient:
 
         Examples
         --------
-        from label_studio_sdk.client import LabelStudio
+        from label_studio_sdk import LabelStudio
 
         client = LabelStudio(
             api_key="YOUR_API_KEY",
@@ -223,7 +255,9 @@ class S3SClient:
         )
         """
         _response = self._client_wrapper.httpx_client.request(
-            f"api/storages/export/s3s/{jsonable_encoder(id)}", method="DELETE", request_options=request_options
+            f"api/storages/export/s3s/{jsonable_encoder(id)}",
+            method="DELETE",
+            request_options=request_options,
         )
         try:
             if 200 <= _response.status_code < 300:
@@ -250,6 +284,7 @@ class S3SClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> S3SExportStorage:
         """
+
         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).
 
         Parameters
@@ -297,7 +332,7 @@ class S3SClient:
 
         Examples
         --------
-        from label_studio_sdk.client import LabelStudio
+        from label_studio_sdk import LabelStudio
 
         client = LabelStudio(
             api_key="YOUR_API_KEY",
@@ -321,12 +356,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(S3SExportStorage, _response.json())  # type: ignore
+                return typing.cast(
+                    S3SExportStorage,
+                    parse_obj_as(
+                        type_=S3SExportStorage,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -348,6 +392,7 @@ class S3SClient:
         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
@@ -391,7 +436,7 @@ class S3SClient:
 
         Examples
         --------
-        from label_studio_sdk.client import LabelStudio
+        from label_studio_sdk import LabelStudio
 
         client = LabelStudio(
             api_key="YOUR_API_KEY",
@@ -413,6 +458,9 @@ class S3SClient:
                 "region_name": region_name,
                 "s3_endpoint": s3endpoint,
             },
+            headers={
+                "content-type": "application/json",
+            },
             request_options=request_options,
             omit=OMIT,
         )
@@ -433,6 +481,7 @@ class AsyncS3SClient:
         self, *, project: typing.Optional[int] = None, request_options: typing.Optional[RequestOptions] = None
     ) -> typing.List[S3SExportStorage]:
         """
+
         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).
@@ -454,19 +503,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.export_storage.s3s.list()
+
+
+        async def main() -> None:
+            await client.export_storage.s3s.list()
+
+
+        asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
-            "api/storages/export/s3s", method="GET", params={"project": project}, request_options=request_options
+            "api/storages/export/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[S3SExportStorage], _response.json())  # type: ignore
+                return typing.cast(
+                    typing.List[S3SExportStorage],
+                    parse_obj_as(
+                        type_=typing.List[S3SExportStorage],  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -488,6 +556,7 @@ class AsyncS3SClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> S3SExportStorage:
         """
+
         Create a new target storage connection to a S3 bucket with IAM role access.
 
         For information about the required fields and prerequisites, see [Amazon S3](https://docs.humansignal.com/guide/storage#Set-up-an-S3-connection-with-IAM-role-access) in the Label Studio documentation.
@@ -534,12 +603,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.export_storage.s3s.create()
+
+
+        async def main() -> None:
+            await client.export_storage.s3s.create()
+
+
+        asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
             "api/storages/export/s3s",
@@ -556,12 +633,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(S3SExportStorage, _response.json())  # type: ignore
+                return typing.cast(
+                    S3SExportStorage,
+                    parse_obj_as(
+                        type_=S3SExportStorage,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -569,6 +655,7 @@ class AsyncS3SClient:
 
     async def get(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> S3SExportStorage:
         """
+
         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).
 
         Parameters
@@ -586,21 +673,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.export_storage.s3s.get(
-            id=1,
-        )
+
+
+        async def main() -> None:
+            await client.export_storage.s3s.get(
+                id=1,
+            )
+
+
+        asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
-            f"api/storages/export/s3s/{jsonable_encoder(id)}", method="GET", request_options=request_options
+            f"api/storages/export/s3s/{jsonable_encoder(id)}",
+            method="GET",
+            request_options=request_options,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(S3SExportStorage, _response.json())  # type: ignore
+                return typing.cast(
+                    S3SExportStorage,
+                    parse_obj_as(
+                        type_=S3SExportStorage,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -608,6 +711,7 @@ class AsyncS3SClient:
 
     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).
 
         Parameters
@@ -624,17 +728,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.export_storage.s3s.delete(
-            id=1,
-        )
+
+
+        async def main() -> None:
+            await client.export_storage.s3s.delete(
+                id=1,
+            )
+
+
+        asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
-            f"api/storages/export/s3s/{jsonable_encoder(id)}", method="DELETE", request_options=request_options
+            f"api/storages/export/s3s/{jsonable_encoder(id)}",
+            method="DELETE",
+            request_options=request_options,
         )
         try:
             if 200 <= _response.status_code < 300:
@@ -661,6 +775,7 @@ class AsyncS3SClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> S3SExportStorage:
         """
+
         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).
 
         Parameters
@@ -708,14 +823,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.export_storage.s3s.update(
-            id=1,
-        )
+
+
+        async def main() -> None:
+            await client.export_storage.s3s.update(
+                id=1,
+            )
+
+
+        asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
             f"api/storages/export/s3s/{jsonable_encoder(id)}",
@@ -732,12 +855,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(S3SExportStorage, _response.json())  # type: ignore
+                return typing.cast(
+                    S3SExportStorage,
+                    parse_obj_as(
+                        type_=S3SExportStorage,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -759,6 +891,7 @@ class AsyncS3SClient:
         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
@@ -802,12 +935,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.export_storage.s3s.validate()
+
+
+        async def main() -> None:
+            await client.export_storage.s3s.validate()
+
+
+        asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
             "api/storages/export/s3s/validate",
@@ -824,6 +965,9 @@ class AsyncS3SClient:
                 "region_name": region_name,
                 "s3_endpoint": s3endpoint,
             },
+            headers={
+                "content-type": "application/json",
+            },
             request_options=request_options,
             omit=OMIT,
         )

label_studio_sdk/export_storage/types/export_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 ExportStorageListTypesResponseItem(pydantic_v1.BaseModel):
+class ExportStorageListTypesResponseItem(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