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

label_studio_sdk/views/client.py

@@ -135,22 +135,25 @@ class ViewsClient:
             raise ApiError(status_code=_response.status_code, body=_response.text)
         raise ApiError(status_code=_response.status_code, body=_response_json)
 
-    def get(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> View:
+    def update_order(
+        self, *, ids: typing.Sequence[int], project: int, request_options: typing.Optional[RequestOptions] = None
+    ) -> None:
         """
-        Get the details about a specific view in the data manager
+        Update the order field of views based on the provided list of view IDs
 
         Parameters
         ----------
-        id : str
-            View ID
+        ids : typing.Sequence[int]
+            A list of view IDs in the desired order.
+
+        project : int
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
         Returns
         -------
-        View
-
+        None
 
         Examples
         --------
@@ -159,37 +162,40 @@ class ViewsClient:
         client = LabelStudio(
             api_key="YOUR_API_KEY",
         )
-        client.views.get(
-            id="id",
+        client.views.update_order(
+            ids=[1],
+            project=1,
         )
         """
         _response = self._client_wrapper.httpx_client.request(
-            f"api/dm/views/{jsonable_encoder(id)}/",
-            method="GET",
+            "api/dm/views/order/",
+            method="POST",
+            json={
+                "ids": ids,
+                "project": project,
+            },
+            headers={
+                "content-type": "application/json",
+            },
             request_options=request_options,
+            omit=OMIT,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return typing.cast(
-                    View,
-                    construct_type(
-                        type_=View,  # type: ignore
-                        object_=_response.json(),
-                    ),
-                )
+                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 delete(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> None:
+    def delete_all(self, *, project: int, request_options: typing.Optional[RequestOptions] = None) -> None:
         """
-        Delete a specific view by ID.
+        Delete all views for a specific project.
 
         Parameters
         ----------
-        id : str
-            View ID
+        project : int
+            Project ID
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -205,13 +211,16 @@ class ViewsClient:
         client = LabelStudio(
             api_key="YOUR_API_KEY",
         )
-        client.views.delete(
-            id="id",
+        client.views.delete_all(
+            project=1,
         )
         """
         _response = self._client_wrapper.httpx_client.request(
-            f"api/dm/views/{jsonable_encoder(id)}/",
+            "api/dm/views/reset/",
             method="DELETE",
+            params={
+                "project": project,
+            },
             request_options=request_options,
         )
         try:
@@ -222,28 +231,15 @@ class ViewsClient:
             raise ApiError(status_code=_response.status_code, body=_response.text)
         raise ApiError(status_code=_response.status_code, body=_response_json)
 
-    def update(
-        self,
-        id: str,
-        *,
-        data: typing.Optional[ViewsUpdateRequestData] = OMIT,
-        project: typing.Optional[int] = OMIT,
-        request_options: typing.Optional[RequestOptions] = None,
-    ) -> View:
+    def get(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> View:
         """
-        Update view data with additional filters and other information for a specific project.
+        Get the details about a specific view in the data manager
 
         Parameters
         ----------
         id : str
             View ID
 
-        data : typing.Optional[ViewsUpdateRequestData]
-            Custom view data
-
-        project : typing.Optional[int]
-            Project ID
-
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
@@ -259,24 +255,14 @@ class ViewsClient:
         client = LabelStudio(
             api_key="YOUR_API_KEY",
         )
-        client.views.update(
+        client.views.get(
             id="id",
         )
         """
         _response = self._client_wrapper.httpx_client.request(
             f"api/dm/views/{jsonable_encoder(id)}/",
-            method="PATCH",
-            json={
-                "data": convert_and_respect_annotation_metadata(
-                    object_=data, annotation=ViewsUpdateRequestData, direction="write"
-                ),
-                "project": project,
-            },
-            headers={
-                "content-type": "application/json",
-            },
+            method="GET",
             request_options=request_options,
-            omit=OMIT,
         )
         try:
             if 200 <= _response.status_code < 300:
@@ -292,18 +278,14 @@ class ViewsClient:
             raise ApiError(status_code=_response.status_code, body=_response.text)
         raise ApiError(status_code=_response.status_code, body=_response_json)
 
-    def update_order(
-        self, *, project: int, ids: typing.Sequence[int], request_options: typing.Optional[RequestOptions] = None
-    ) -> None:
+    def delete(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> None:
         """
-        Update the order field of views based on the provided list of view IDs
+        Delete a specific view by ID.
 
         Parameters
         ----------
-        project : int
-
-        ids : typing.Sequence[int]
-            A list of view IDs in the desired order.
+        id : str
+            View ID
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -319,23 +301,14 @@ class ViewsClient:
         client = LabelStudio(
             api_key="YOUR_API_KEY",
         )
-        client.views.update_order(
-            project=1,
-            ids=[1],
+        client.views.delete(
+            id="id",
         )
         """
         _response = self._client_wrapper.httpx_client.request(
-            "api/dm/views/order/",
-            method="POST",
-            json={
-                "project": project,
-                "ids": ids,
-            },
-            headers={
-                "content-type": "application/json",
-            },
+            f"api/dm/views/{jsonable_encoder(id)}/",
+            method="DELETE",
             request_options=request_options,
-            omit=OMIT,
         )
         try:
             if 200 <= _response.status_code < 300:
@@ -345,13 +318,26 @@ class ViewsClient:
             raise ApiError(status_code=_response.status_code, body=_response.text)
         raise ApiError(status_code=_response.status_code, body=_response_json)
 
-    def delete_all(self, *, project: int, request_options: typing.Optional[RequestOptions] = None) -> None:
+    def update(
+        self,
+        id: str,
+        *,
+        data: typing.Optional[ViewsUpdateRequestData] = OMIT,
+        project: typing.Optional[int] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> View:
         """
-        Delete all views for a specific project.
+        Update view data with additional filters and other information for a specific project.
 
         Parameters
         ----------
-        project : int
+        id : str
+            View ID
+
+        data : typing.Optional[ViewsUpdateRequestData]
+            Custom view data
+
+        project : typing.Optional[int]
             Project ID
 
         request_options : typing.Optional[RequestOptions]
@@ -359,7 +345,8 @@ class ViewsClient:
 
         Returns
         -------
-        None
+        View
+
 
         Examples
         --------
@@ -368,21 +355,34 @@ class ViewsClient:
         client = LabelStudio(
             api_key="YOUR_API_KEY",
         )
-        client.views.delete_all(
-            project=1,
+        client.views.update(
+            id="id",
         )
         """
         _response = self._client_wrapper.httpx_client.request(
-            "api/dm/views/reset/",
-            method="DELETE",
-            params={
+            f"api/dm/views/{jsonable_encoder(id)}/",
+            method="PATCH",
+            json={
+                "data": convert_and_respect_annotation_metadata(
+                    object_=data, annotation=ViewsUpdateRequestData, direction="write"
+                ),
                 "project": project,
             },
+            headers={
+                "content-type": "application/json",
+            },
             request_options=request_options,
+            omit=OMIT,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return
+                return typing.cast(
+                    View,
+                    construct_type(
+                        type_=View,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -523,22 +523,25 @@ class AsyncViewsClient:
             raise ApiError(status_code=_response.status_code, body=_response.text)
         raise ApiError(status_code=_response.status_code, body=_response_json)
 
-    async def get(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> View:
+    async def update_order(
+        self, *, ids: typing.Sequence[int], project: int, request_options: typing.Optional[RequestOptions] = None
+    ) -> None:
         """
-        Get the details about a specific view in the data manager
+        Update the order field of views based on the provided list of view IDs
 
         Parameters
         ----------
-        id : str
-            View ID
+        ids : typing.Sequence[int]
+            A list of view IDs in the desired order.
+
+        project : int
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
         Returns
         -------
-        View
-
+        None
 
         Examples
         --------
@@ -552,40 +555,43 @@ class AsyncViewsClient:
 
 
         async def main() -> None:
-            await client.views.get(
-                id="id",
+            await client.views.update_order(
+                ids=[1],
+                project=1,
             )
 
 
         asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
-            f"api/dm/views/{jsonable_encoder(id)}/",
-            method="GET",
+            "api/dm/views/order/",
+            method="POST",
+            json={
+                "ids": ids,
+                "project": project,
+            },
+            headers={
+                "content-type": "application/json",
+            },
             request_options=request_options,
+            omit=OMIT,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return typing.cast(
-                    View,
-                    construct_type(
-                        type_=View,  # type: ignore
-                        object_=_response.json(),
-                    ),
-                )
+                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)
 
-    async def delete(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> None:
+    async def delete_all(self, *, project: int, request_options: typing.Optional[RequestOptions] = None) -> None:
         """
-        Delete a specific view by ID.
+        Delete all views for a specific project.
 
         Parameters
         ----------
-        id : str
-            View ID
+        project : int
+            Project ID
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -606,16 +612,19 @@ class AsyncViewsClient:
 
 
         async def main() -> None:
-            await client.views.delete(
-                id="id",
+            await client.views.delete_all(
+                project=1,
             )
 
 
         asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
-            f"api/dm/views/{jsonable_encoder(id)}/",
+            "api/dm/views/reset/",
             method="DELETE",
+            params={
+                "project": project,
+            },
             request_options=request_options,
         )
         try:
@@ -626,28 +635,15 @@ class AsyncViewsClient:
             raise ApiError(status_code=_response.status_code, body=_response.text)
         raise ApiError(status_code=_response.status_code, body=_response_json)
 
-    async def update(
-        self,
-        id: str,
-        *,
-        data: typing.Optional[ViewsUpdateRequestData] = OMIT,
-        project: typing.Optional[int] = OMIT,
-        request_options: typing.Optional[RequestOptions] = None,
-    ) -> View:
+    async def get(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> View:
         """
-        Update view data with additional filters and other information for a specific project.
+        Get the details about a specific view in the data manager
 
         Parameters
         ----------
         id : str
             View ID
 
-        data : typing.Optional[ViewsUpdateRequestData]
-            Custom view data
-
-        project : typing.Optional[int]
-            Project ID
-
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
@@ -668,7 +664,7 @@ class AsyncViewsClient:
 
 
         async def main() -> None:
-            await client.views.update(
+            await client.views.get(
                 id="id",
             )
 
@@ -677,18 +673,8 @@ class AsyncViewsClient:
         """
         _response = await self._client_wrapper.httpx_client.request(
             f"api/dm/views/{jsonable_encoder(id)}/",
-            method="PATCH",
-            json={
-                "data": convert_and_respect_annotation_metadata(
-                    object_=data, annotation=ViewsUpdateRequestData, direction="write"
-                ),
-                "project": project,
-            },
-            headers={
-                "content-type": "application/json",
-            },
+            method="GET",
             request_options=request_options,
-            omit=OMIT,
         )
         try:
             if 200 <= _response.status_code < 300:
@@ -704,18 +690,14 @@ class AsyncViewsClient:
             raise ApiError(status_code=_response.status_code, body=_response.text)
         raise ApiError(status_code=_response.status_code, body=_response_json)
 
-    async def update_order(
-        self, *, project: int, ids: typing.Sequence[int], request_options: typing.Optional[RequestOptions] = None
-    ) -> None:
+    async def delete(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> None:
         """
-        Update the order field of views based on the provided list of view IDs
+        Delete a specific view by ID.
 
         Parameters
         ----------
-        project : int
-
-        ids : typing.Sequence[int]
-            A list of view IDs in the desired order.
+        id : str
+            View ID
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -736,26 +718,17 @@ class AsyncViewsClient:
 
 
         async def main() -> None:
-            await client.views.update_order(
-                project=1,
-                ids=[1],
+            await client.views.delete(
+                id="id",
             )
 
 
         asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
-            "api/dm/views/order/",
-            method="POST",
-            json={
-                "project": project,
-                "ids": ids,
-            },
-            headers={
-                "content-type": "application/json",
-            },
+            f"api/dm/views/{jsonable_encoder(id)}/",
+            method="DELETE",
             request_options=request_options,
-            omit=OMIT,
         )
         try:
             if 200 <= _response.status_code < 300:
@@ -765,13 +738,26 @@ class AsyncViewsClient:
             raise ApiError(status_code=_response.status_code, body=_response.text)
         raise ApiError(status_code=_response.status_code, body=_response_json)
 
-    async def delete_all(self, *, project: int, request_options: typing.Optional[RequestOptions] = None) -> None:
+    async def update(
+        self,
+        id: str,
+        *,
+        data: typing.Optional[ViewsUpdateRequestData] = OMIT,
+        project: typing.Optional[int] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> View:
         """
-        Delete all views for a specific project.
+        Update view data with additional filters and other information for a specific project.
 
         Parameters
         ----------
-        project : int
+        id : str
+            View ID
+
+        data : typing.Optional[ViewsUpdateRequestData]
+            Custom view data
+
+        project : typing.Optional[int]
             Project ID
 
         request_options : typing.Optional[RequestOptions]
@@ -779,7 +765,8 @@ class AsyncViewsClient:
 
         Returns
         -------
-        None
+        View
+
 
         Examples
         --------
@@ -793,24 +780,37 @@ class AsyncViewsClient:
 
 
         async def main() -> None:
-            await client.views.delete_all(
-                project=1,
+            await client.views.update(
+                id="id",
             )
 
 
         asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
-            "api/dm/views/reset/",
-            method="DELETE",
-            params={
+            f"api/dm/views/{jsonable_encoder(id)}/",
+            method="PATCH",
+            json={
+                "data": convert_and_respect_annotation_metadata(
+                    object_=data, annotation=ViewsUpdateRequestData, direction="write"
+                ),
                 "project": project,
             },
+            headers={
+                "content-type": "application/json",
+            },
             request_options=request_options,
+            omit=OMIT,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return
+                return typing.cast(
+                    View,
+                    construct_type(
+                        type_=View,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)