label-studio-sdk 2.0.0__py3-none-any.whl → 2.0.2__py3-none-any.whl

label_studio_sdk/export_storage/gcs/client.py

@@ -79,14 +79,14 @@ class GcsClient:
     def create(
         self,
         *,
+        bucket: typing.Optional[str] = OMIT,
         can_delete_objects: typing.Optional[bool] = OMIT,
-        title: typing.Optional[str] = OMIT,
         description: typing.Optional[str] = OMIT,
-        project: typing.Optional[int] = OMIT,
-        bucket: typing.Optional[str] = OMIT,
-        prefix: typing.Optional[str] = OMIT,
         google_application_credentials: typing.Optional[str] = OMIT,
         google_project_id: typing.Optional[str] = OMIT,
+        prefix: typing.Optional[str] = OMIT,
+        project: typing.Optional[int] = OMIT,
+        title: typing.Optional[str] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> GcsExportStorage:
         """
@@ -94,29 +94,29 @@ class GcsClient:
 
         Parameters
         ----------
+        bucket : typing.Optional[str]
+            GCS bucket name
+
         can_delete_objects : typing.Optional[bool]
             Deletion from storage enabled.
 
-        title : typing.Optional[str]
-            Storage title
-
         description : typing.Optional[str]
             Storage description
 
-        project : typing.Optional[int]
-            Project ID
+        google_application_credentials : typing.Optional[str]
+            The content of GOOGLE_APPLICATION_CREDENTIALS json file. Check official Google Cloud Authentication documentation for more details.
 
-        bucket : typing.Optional[str]
-            GCS bucket name
+        google_project_id : typing.Optional[str]
+            Google project ID
 
         prefix : typing.Optional[str]
             GCS bucket prefix
 
-        google_application_credentials : typing.Optional[str]
-            The content of GOOGLE_APPLICATION_CREDENTIALS json file. Check official Google Cloud Authentication documentation for more details.
+        project : typing.Optional[int]
+            Project ID
 
-        google_project_id : typing.Optional[str]
-            Google project ID
+        title : typing.Optional[str]
+            Storage title
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -139,14 +139,14 @@ class GcsClient:
             "api/storages/export/gcs",
             method="POST",
             json={
+                "bucket": bucket,
                 "can_delete_objects": can_delete_objects,
-                "title": title,
                 "description": description,
-                "project": project,
-                "bucket": bucket,
-                "prefix": prefix,
                 "google_application_credentials": google_application_credentials,
                 "google_project_id": google_project_id,
+                "prefix": prefix,
+                "project": project,
+                "title": title,
             },
             headers={
                 "content-type": "application/json",
@@ -168,6 +168,96 @@ class GcsClient:
             raise ApiError(status_code=_response.status_code, body=_response.text)
         raise ApiError(status_code=_response.status_code, body=_response_json)
 
+    def validate(
+        self,
+        *,
+        bucket: typing.Optional[str] = OMIT,
+        can_delete_objects: typing.Optional[bool] = OMIT,
+        description: typing.Optional[str] = OMIT,
+        google_application_credentials: typing.Optional[str] = OMIT,
+        google_project_id: typing.Optional[str] = OMIT,
+        id: typing.Optional[int] = OMIT,
+        prefix: typing.Optional[str] = OMIT,
+        project: typing.Optional[int] = OMIT,
+        title: typing.Optional[str] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> None:
+        """
+        Validate a specific GCS export storage connection.
+
+        Parameters
+        ----------
+        bucket : typing.Optional[str]
+            GCS bucket name
+
+        can_delete_objects : typing.Optional[bool]
+            Deletion from storage enabled.
+
+        description : typing.Optional[str]
+            Storage description
+
+        google_application_credentials : typing.Optional[str]
+            The content of GOOGLE_APPLICATION_CREDENTIALS json file. Check official Google Cloud Authentication documentation for more details.
+
+        google_project_id : typing.Optional[str]
+            Google project ID
+
+        id : typing.Optional[int]
+            Storage ID. If set, storage with specified ID will be updated
+
+        prefix : typing.Optional[str]
+            GCS bucket prefix
+
+        project : typing.Optional[int]
+            Project ID
+
+        title : typing.Optional[str]
+            Storage title
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        None
+
+        Examples
+        --------
+        from label_studio_sdk import LabelStudio
+
+        client = LabelStudio(
+            api_key="YOUR_API_KEY",
+        )
+        client.export_storage.gcs.validate()
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            "api/storages/export/gcs/validate",
+            method="POST",
+            json={
+                "bucket": bucket,
+                "can_delete_objects": can_delete_objects,
+                "description": description,
+                "google_application_credentials": google_application_credentials,
+                "google_project_id": google_project_id,
+                "id": id,
+                "prefix": prefix,
+                "project": project,
+                "title": title,
+            },
+            headers={
+                "content-type": "application/json",
+            },
+            request_options=request_options,
+            omit=OMIT,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                return
+            _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 get(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> GcsExportStorage:
         """
         Get a specific GCS export storage connection.
@@ -257,14 +347,14 @@ class GcsClient:
         self,
         id: int,
         *,
+        bucket: typing.Optional[str] = OMIT,
         can_delete_objects: typing.Optional[bool] = OMIT,
-        title: typing.Optional[str] = OMIT,
         description: typing.Optional[str] = OMIT,
-        project: typing.Optional[int] = OMIT,
-        bucket: typing.Optional[str] = OMIT,
-        prefix: typing.Optional[str] = OMIT,
         google_application_credentials: typing.Optional[str] = OMIT,
         google_project_id: typing.Optional[str] = OMIT,
+        prefix: typing.Optional[str] = OMIT,
+        project: typing.Optional[int] = OMIT,
+        title: typing.Optional[str] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> GcsExportStorage:
         """
@@ -274,29 +364,29 @@ class GcsClient:
         ----------
         id : int
 
+        bucket : typing.Optional[str]
+            GCS bucket name
+
         can_delete_objects : typing.Optional[bool]
             Deletion from storage enabled.
 
-        title : typing.Optional[str]
-            Storage title
-
         description : typing.Optional[str]
             Storage description
 
-        project : typing.Optional[int]
-            Project ID
+        google_application_credentials : typing.Optional[str]
+            The content of GOOGLE_APPLICATION_CREDENTIALS json file. Check official Google Cloud Authentication documentation for more details.
 
-        bucket : typing.Optional[str]
-            GCS bucket name
+        google_project_id : typing.Optional[str]
+            Google project ID
 
         prefix : typing.Optional[str]
             GCS bucket prefix
 
-        google_application_credentials : typing.Optional[str]
-            The content of GOOGLE_APPLICATION_CREDENTIALS json file. Check official Google Cloud Authentication documentation for more details.
+        project : typing.Optional[int]
+            Project ID
 
-        google_project_id : typing.Optional[str]
-            Google project ID
+        title : typing.Optional[str]
+            Storage title
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -321,14 +411,14 @@ class GcsClient:
             f"api/storages/export/gcs/{jsonable_encoder(id)}",
             method="PATCH",
             json={
+                "bucket": bucket,
                 "can_delete_objects": can_delete_objects,
-                "title": title,
                 "description": description,
-                "project": project,
-                "bucket": bucket,
-                "prefix": prefix,
                 "google_application_credentials": google_application_credentials,
                 "google_project_id": google_project_id,
+                "prefix": prefix,
+                "project": project,
+                "title": title,
             },
             headers={
                 "content-type": "application/json",
@@ -396,125 +486,125 @@ class GcsClient:
             raise ApiError(status_code=_response.status_code, body=_response.text)
         raise ApiError(status_code=_response.status_code, body=_response_json)
 
-    def validate(
+
+class AsyncGcsClient:
+    def __init__(self, *, client_wrapper: AsyncClientWrapper):
+        self._client_wrapper = client_wrapper
+
+    async def list(
         self,
         *,
-        id: typing.Optional[int] = OMIT,
-        can_delete_objects: typing.Optional[bool] = OMIT,
-        title: typing.Optional[str] = OMIT,
-        description: typing.Optional[str] = OMIT,
-        project: typing.Optional[int] = OMIT,
-        bucket: typing.Optional[str] = OMIT,
-        prefix: typing.Optional[str] = OMIT,
-        google_application_credentials: typing.Optional[str] = OMIT,
-        google_project_id: typing.Optional[str] = OMIT,
+        ordering: typing.Optional[str] = None,
+        project: typing.Optional[int] = None,
         request_options: typing.Optional[RequestOptions] = None,
-    ) -> None:
+    ) -> typing.List[GcsExportStorage]:
         """
-        Validate a specific GCS export storage connection.
+        Get a list of all GCS export storage connections.
 
         Parameters
         ----------
-        id : typing.Optional[int]
-            Storage ID. If set, storage with specified ID will be updated
-
-        can_delete_objects : typing.Optional[bool]
-            Deletion from storage enabled.
-
-        title : typing.Optional[str]
-            Storage title
-
-        description : typing.Optional[str]
-            Storage description
+        ordering : typing.Optional[str]
+            Which field to use when ordering the results.
 
         project : typing.Optional[int]
             Project ID
 
-        bucket : typing.Optional[str]
-            GCS bucket name
-
-        prefix : typing.Optional[str]
-            GCS bucket prefix
-
-        google_application_credentials : typing.Optional[str]
-            The content of GOOGLE_APPLICATION_CREDENTIALS json file. Check official Google Cloud Authentication documentation for more details.
-
-        google_project_id : typing.Optional[str]
-            Google project ID
-
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
         Returns
         -------
-        None
+        typing.List[GcsExportStorage]
+
 
         Examples
         --------
-        from label_studio_sdk import LabelStudio
+        import asyncio
 
-        client = LabelStudio(
+        from label_studio_sdk import AsyncLabelStudio
+
+        client = AsyncLabelStudio(
             api_key="YOUR_API_KEY",
         )
-        client.export_storage.gcs.validate()
+
+
+        async def main() -> None:
+            await client.export_storage.gcs.list()
+
+
+        asyncio.run(main())
         """
-        _response = self._client_wrapper.httpx_client.request(
-            "api/storages/export/gcs/validate",
-            method="POST",
-            json={
-                "id": id,
-                "can_delete_objects": can_delete_objects,
-                "title": title,
-                "description": description,
+        _response = await self._client_wrapper.httpx_client.request(
+            "api/storages/export/gcs",
+            method="GET",
+            params={
+                "ordering": ordering,
                 "project": project,
-                "bucket": bucket,
-                "prefix": prefix,
-                "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
+                return typing.cast(
+                    typing.List[GcsExportStorage],
+                    construct_type(
+                        type_=typing.List[GcsExportStorage],  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
         raise ApiError(status_code=_response.status_code, body=_response_json)
 
-
-class AsyncGcsClient:
-    def __init__(self, *, client_wrapper: AsyncClientWrapper):
-        self._client_wrapper = client_wrapper
-
-    async def list(
+    async def create(
         self,
         *,
-        ordering: typing.Optional[str] = None,
-        project: typing.Optional[int] = None,
+        bucket: typing.Optional[str] = OMIT,
+        can_delete_objects: typing.Optional[bool] = OMIT,
+        description: typing.Optional[str] = OMIT,
+        google_application_credentials: typing.Optional[str] = OMIT,
+        google_project_id: typing.Optional[str] = OMIT,
+        prefix: typing.Optional[str] = OMIT,
+        project: typing.Optional[int] = OMIT,
+        title: typing.Optional[str] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
-    ) -> typing.List[GcsExportStorage]:
+    ) -> GcsExportStorage:
         """
-        Get a list of all GCS export storage connections.
+        Create a new GCS export storage connection to store annotations.
 
         Parameters
         ----------
-        ordering : typing.Optional[str]
-            Which field to use when ordering the results.
+        bucket : typing.Optional[str]
+            GCS bucket name
+
+        can_delete_objects : typing.Optional[bool]
+            Deletion from storage enabled.
+
+        description : typing.Optional[str]
+            Storage description
+
+        google_application_credentials : typing.Optional[str]
+            The content of GOOGLE_APPLICATION_CREDENTIALS json file. Check official Google Cloud Authentication documentation for more details.
+
+        google_project_id : typing.Optional[str]
+            Google project ID
+
+        prefix : typing.Optional[str]
+            GCS bucket prefix
 
         project : typing.Optional[int]
             Project ID
 
+        title : typing.Optional[str]
+            Storage title
+
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
         Returns
         -------
-        typing.List[GcsExportStorage]
+        GcsExportStorage
 
 
         Examples
@@ -529,26 +619,36 @@ class AsyncGcsClient:
 
 
         async def main() -> None:
-            await client.export_storage.gcs.list()
+            await client.export_storage.gcs.create()
 
 
         asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
             "api/storages/export/gcs",
-            method="GET",
-            params={
-                "ordering": ordering,
+            method="POST",
+            json={
+                "bucket": bucket,
+                "can_delete_objects": can_delete_objects,
+                "description": description,
+                "google_application_credentials": google_application_credentials,
+                "google_project_id": google_project_id,
+                "prefix": prefix,
                 "project": project,
+                "title": title,
+            },
+            headers={
+                "content-type": "application/json",
             },
             request_options=request_options,
+            omit=OMIT,
         )
         try:
             if 200 <= _response.status_code < 300:
                 return typing.cast(
-                    typing.List[GcsExportStorage],
+                    GcsExportStorage,
                     construct_type(
-                        type_=typing.List[GcsExportStorage],  # type: ignore
+                        type_=GcsExportStorage,  # type: ignore
                         object_=_response.json(),
                     ),
                 )
@@ -557,55 +657,58 @@ class AsyncGcsClient:
             raise ApiError(status_code=_response.status_code, body=_response.text)
         raise ApiError(status_code=_response.status_code, body=_response_json)
 
-    async def create(
+    async def validate(
         self,
         *,
+        bucket: typing.Optional[str] = OMIT,
         can_delete_objects: typing.Optional[bool] = OMIT,
-        title: typing.Optional[str] = OMIT,
         description: typing.Optional[str] = OMIT,
-        project: typing.Optional[int] = OMIT,
-        bucket: typing.Optional[str] = OMIT,
-        prefix: typing.Optional[str] = OMIT,
         google_application_credentials: typing.Optional[str] = OMIT,
         google_project_id: typing.Optional[str] = OMIT,
+        id: typing.Optional[int] = OMIT,
+        prefix: typing.Optional[str] = OMIT,
+        project: typing.Optional[int] = OMIT,
+        title: typing.Optional[str] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
-    ) -> GcsExportStorage:
+    ) -> None:
         """
-        Create a new GCS export storage connection to store annotations.
+        Validate a specific GCS export storage connection.
 
         Parameters
         ----------
+        bucket : typing.Optional[str]
+            GCS bucket name
+
         can_delete_objects : typing.Optional[bool]
             Deletion from storage enabled.
 
-        title : typing.Optional[str]
-            Storage title
-
         description : typing.Optional[str]
             Storage description
 
-        project : typing.Optional[int]
-            Project ID
+        google_application_credentials : typing.Optional[str]
+            The content of GOOGLE_APPLICATION_CREDENTIALS json file. Check official Google Cloud Authentication documentation for more details.
 
-        bucket : typing.Optional[str]
-            GCS bucket name
+        google_project_id : typing.Optional[str]
+            Google project ID
+
+        id : typing.Optional[int]
+            Storage ID. If set, storage with specified ID will be updated
 
         prefix : typing.Optional[str]
             GCS bucket prefix
 
-        google_application_credentials : typing.Optional[str]
-            The content of GOOGLE_APPLICATION_CREDENTIALS json file. Check official Google Cloud Authentication documentation for more details.
+        project : typing.Optional[int]
+            Project ID
 
-        google_project_id : typing.Optional[str]
-            Google project ID
+        title : typing.Optional[str]
+            Storage title
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
         Returns
         -------
-        GcsExportStorage
-
+        None
 
         Examples
         --------
@@ -619,23 +722,24 @@ class AsyncGcsClient:
 
 
         async def main() -> None:
-            await client.export_storage.gcs.create()
+            await client.export_storage.gcs.validate()
 
 
         asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
-            "api/storages/export/gcs",
+            "api/storages/export/gcs/validate",
             method="POST",
             json={
+                "bucket": bucket,
                 "can_delete_objects": can_delete_objects,
-                "title": title,
                 "description": description,
-                "project": project,
-                "bucket": bucket,
-                "prefix": prefix,
                 "google_application_credentials": google_application_credentials,
                 "google_project_id": google_project_id,
+                "id": id,
+                "prefix": prefix,
+                "project": project,
+                "title": title,
             },
             headers={
                 "content-type": "application/json",
@@ -645,13 +749,7 @@ class AsyncGcsClient:
         )
         try:
             if 200 <= _response.status_code < 300:
-                return typing.cast(
-                    GcsExportStorage,
-                    construct_type(
-                        type_=GcsExportStorage,  # type: ignore
-                        object_=_response.json(),
-                    ),
-                )
+                return
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -762,14 +860,14 @@ class AsyncGcsClient:
         self,
         id: int,
         *,
+        bucket: typing.Optional[str] = OMIT,
         can_delete_objects: typing.Optional[bool] = OMIT,
-        title: typing.Optional[str] = OMIT,
         description: typing.Optional[str] = OMIT,
-        project: typing.Optional[int] = OMIT,
-        bucket: typing.Optional[str] = OMIT,
-        prefix: typing.Optional[str] = OMIT,
         google_application_credentials: typing.Optional[str] = OMIT,
         google_project_id: typing.Optional[str] = OMIT,
+        prefix: typing.Optional[str] = OMIT,
+        project: typing.Optional[int] = OMIT,
+        title: typing.Optional[str] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> GcsExportStorage:
         """
@@ -779,29 +877,29 @@ class AsyncGcsClient:
         ----------
         id : int
 
+        bucket : typing.Optional[str]
+            GCS bucket name
+
         can_delete_objects : typing.Optional[bool]
             Deletion from storage enabled.
 
-        title : typing.Optional[str]
-            Storage title
-
         description : typing.Optional[str]
             Storage description
 
-        project : typing.Optional[int]
-            Project ID
+        google_application_credentials : typing.Optional[str]
+            The content of GOOGLE_APPLICATION_CREDENTIALS json file. Check official Google Cloud Authentication documentation for more details.
 
-        bucket : typing.Optional[str]
-            GCS bucket name
+        google_project_id : typing.Optional[str]
+            Google project ID
 
         prefix : typing.Optional[str]
             GCS bucket prefix
 
-        google_application_credentials : typing.Optional[str]
-            The content of GOOGLE_APPLICATION_CREDENTIALS json file. Check official Google Cloud Authentication documentation for more details.
+        project : typing.Optional[int]
+            Project ID
 
-        google_project_id : typing.Optional[str]
-            Google project ID
+        title : typing.Optional[str]
+            Storage title
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -834,14 +932,14 @@ class AsyncGcsClient:
             f"api/storages/export/gcs/{jsonable_encoder(id)}",
             method="PATCH",
             json={
+                "bucket": bucket,
                 "can_delete_objects": can_delete_objects,
-                "title": title,
                 "description": description,
-                "project": project,
-                "bucket": bucket,
-                "prefix": prefix,
                 "google_application_credentials": google_application_credentials,
                 "google_project_id": google_project_id,
+                "prefix": prefix,
+                "project": project,
+                "title": title,
             },
             headers={
                 "content-type": "application/json",
@@ -916,101 +1014,3 @@ class AsyncGcsClient:
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
         raise ApiError(status_code=_response.status_code, body=_response_json)
-
-    async def validate(
-        self,
-        *,
-        id: typing.Optional[int] = OMIT,
-        can_delete_objects: typing.Optional[bool] = OMIT,
-        title: typing.Optional[str] = OMIT,
-        description: typing.Optional[str] = OMIT,
-        project: typing.Optional[int] = OMIT,
-        bucket: typing.Optional[str] = OMIT,
-        prefix: typing.Optional[str] = OMIT,
-        google_application_credentials: typing.Optional[str] = OMIT,
-        google_project_id: typing.Optional[str] = OMIT,
-        request_options: typing.Optional[RequestOptions] = None,
-    ) -> None:
-        """
-        Validate a specific GCS export storage connection.
-
-        Parameters
-        ----------
-        id : typing.Optional[int]
-            Storage ID. If set, storage with specified ID will be updated
-
-        can_delete_objects : typing.Optional[bool]
-            Deletion from storage enabled.
-
-        title : typing.Optional[str]
-            Storage title
-
-        description : typing.Optional[str]
-            Storage description
-
-        project : typing.Optional[int]
-            Project ID
-
-        bucket : typing.Optional[str]
-            GCS bucket name
-
-        prefix : typing.Optional[str]
-            GCS bucket prefix
-
-        google_application_credentials : typing.Optional[str]
-            The content of GOOGLE_APPLICATION_CREDENTIALS json file. Check official Google Cloud Authentication documentation for more details.
-
-        google_project_id : typing.Optional[str]
-            Google project ID
-
-        request_options : typing.Optional[RequestOptions]
-            Request-specific configuration.
-
-        Returns
-        -------
-        None
-
-        Examples
-        --------
-        import asyncio
-
-        from label_studio_sdk import AsyncLabelStudio
-
-        client = AsyncLabelStudio(
-            api_key="YOUR_API_KEY",
-        )
-
-
-        async def main() -> None:
-            await client.export_storage.gcs.validate()
-
-
-        asyncio.run(main())
-        """
-        _response = await self._client_wrapper.httpx_client.request(
-            "api/storages/export/gcs/validate",
-            method="POST",
-            json={
-                "id": id,
-                "can_delete_objects": can_delete_objects,
-                "title": title,
-                "description": description,
-                "project": project,
-                "bucket": bucket,
-                "prefix": prefix,
-                "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
-            _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)