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

label_studio_sdk/workspaces/client.py

@@ -1,15 +1,16 @@
 # This file was auto-generated by Fern from our API Definition.
 
 import typing
+from ..core.client_wrapper import SyncClientWrapper
+from .members.client import MembersClient
+from ..core.request_options import RequestOptions
+from ..types.workspace import Workspace
+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.workspace import Workspace
-from .members.client import AsyncMembersClient, MembersClient
+from ..core.client_wrapper import AsyncClientWrapper
+from .members.client import AsyncMembersClient
 
 # this is used as the default value for optional parameters
 OMIT = typing.cast(typing.Any, ...)
@@ -22,6 +23,7 @@ class WorkspacesClient:
 
     def list(self, *, request_options: typing.Optional[RequestOptions] = None) -> typing.List[Workspace]:
         """
+
         List all workspaces for your organization.
 
         Workspaces in Label Studio let you organize your projects and users into separate spaces. This is useful for managing different teams, departments, or projects within your organization.
@@ -40,7 +42,7 @@ class WorkspacesClient:
 
         Examples
         --------
-        from label_studio_sdk.client import LabelStudio
+        from label_studio_sdk import LabelStudio
 
         client = LabelStudio(
             api_key="YOUR_API_KEY",
@@ -48,11 +50,19 @@ class WorkspacesClient:
         client.workspaces.list()
         """
         _response = self._client_wrapper.httpx_client.request(
-            "api/workspaces", method="GET", request_options=request_options
+            "api/workspaces",
+            method="GET",
+            request_options=request_options,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(typing.List[Workspace], _response.json())  # type: ignore
+                return typing.cast(
+                    typing.List[Workspace],
+                    parse_obj_as(
+                        type_=typing.List[Workspace],  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -70,6 +80,7 @@ class WorkspacesClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> Workspace:
         """
+
         Create a new workspace.
 
         Workspaces in Label Studio let you organize your projects and users into separate spaces. This is useful for managing different teams, departments, or projects within your organization.
@@ -106,7 +117,7 @@ class WorkspacesClient:
 
         Examples
         --------
-        from label_studio_sdk.client import LabelStudio
+        from label_studio_sdk import LabelStudio
 
         client = LabelStudio(
             api_key="YOUR_API_KEY",
@@ -124,12 +135,21 @@ class WorkspacesClient:
                 "color": color,
                 "is_archived": is_archived,
             },
+            headers={
+                "content-type": "application/json",
+            },
             request_options=request_options,
             omit=OMIT,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(Workspace, _response.json())  # type: ignore
+                return typing.cast(
+                    Workspace,
+                    parse_obj_as(
+                        type_=Workspace,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -137,6 +157,7 @@ class WorkspacesClient:
 
     def get(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> Workspace:
         """
+
         Get information about a specific workspace. You will need to provide the workspace ID. You can find this using [List workspaces](list).
 
         Parameters
@@ -154,7 +175,7 @@ class WorkspacesClient:
 
         Examples
         --------
-        from label_studio_sdk.client import LabelStudio
+        from label_studio_sdk import LabelStudio
 
         client = LabelStudio(
             api_key="YOUR_API_KEY",
@@ -164,11 +185,19 @@ class WorkspacesClient:
         )
         """
         _response = self._client_wrapper.httpx_client.request(
-            f"api/workspaces/{jsonable_encoder(id)}", method="GET", request_options=request_options
+            f"api/workspaces/{jsonable_encoder(id)}",
+            method="GET",
+            request_options=request_options,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(Workspace, _response.json())  # type: ignore
+                return typing.cast(
+                    Workspace,
+                    parse_obj_as(
+                        type_=Workspace,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -176,6 +205,7 @@ class WorkspacesClient:
 
     def delete(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> None:
         """
+
         Delete a specific workspace. You will need to provide the workspace ID. You can find this using [List workspaces](list).
 
         Parameters
@@ -192,7 +222,7 @@ class WorkspacesClient:
 
         Examples
         --------
-        from label_studio_sdk.client import LabelStudio
+        from label_studio_sdk import LabelStudio
 
         client = LabelStudio(
             api_key="YOUR_API_KEY",
@@ -202,7 +232,9 @@ class WorkspacesClient:
         )
         """
         _response = self._client_wrapper.httpx_client.request(
-            f"api/workspaces/{jsonable_encoder(id)}", method="DELETE", request_options=request_options
+            f"api/workspaces/{jsonable_encoder(id)}",
+            method="DELETE",
+            request_options=request_options,
         )
         try:
             if 200 <= _response.status_code < 300:
@@ -225,6 +257,7 @@ class WorkspacesClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> Workspace:
         """
+
         Update a specific workspace. You will need to provide the workspace ID. You can find this using [List workspaces](list).
 
         Parameters
@@ -260,7 +293,7 @@ class WorkspacesClient:
 
         Examples
         --------
-        from label_studio_sdk.client import LabelStudio
+        from label_studio_sdk import LabelStudio
 
         client = LabelStudio(
             api_key="YOUR_API_KEY",
@@ -280,12 +313,21 @@ class WorkspacesClient:
                 "color": color,
                 "is_archived": is_archived,
             },
+            headers={
+                "content-type": "application/json",
+            },
             request_options=request_options,
             omit=OMIT,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(Workspace, _response.json())  # type: ignore
+                return typing.cast(
+                    Workspace,
+                    parse_obj_as(
+                        type_=Workspace,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -299,6 +341,7 @@ class AsyncWorkspacesClient:
 
     async def list(self, *, request_options: typing.Optional[RequestOptions] = None) -> typing.List[Workspace]:
         """
+
         List all workspaces for your organization.
 
         Workspaces in Label Studio let you organize your projects and users into separate spaces. This is useful for managing different teams, departments, or projects within your organization.
@@ -317,19 +360,35 @@ class AsyncWorkspacesClient:
 
         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.workspaces.list()
+
+
+        async def main() -> None:
+            await client.workspaces.list()
+
+
+        asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
-            "api/workspaces", method="GET", request_options=request_options
+            "api/workspaces",
+            method="GET",
+            request_options=request_options,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(typing.List[Workspace], _response.json())  # type: ignore
+                return typing.cast(
+                    typing.List[Workspace],
+                    parse_obj_as(
+                        type_=typing.List[Workspace],  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -347,6 +406,7 @@ class AsyncWorkspacesClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> Workspace:
         """
+
         Create a new workspace.
 
         Workspaces in Label Studio let you organize your projects and users into separate spaces. This is useful for managing different teams, departments, or projects within your organization.
@@ -383,12 +443,20 @@ class AsyncWorkspacesClient:
 
         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.workspaces.create()
+
+
+        async def main() -> None:
+            await client.workspaces.create()
+
+
+        asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
             "api/workspaces",
@@ -401,12 +469,21 @@ class AsyncWorkspacesClient:
                 "color": color,
                 "is_archived": is_archived,
             },
+            headers={
+                "content-type": "application/json",
+            },
             request_options=request_options,
             omit=OMIT,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(Workspace, _response.json())  # type: ignore
+                return typing.cast(
+                    Workspace,
+                    parse_obj_as(
+                        type_=Workspace,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -414,6 +491,7 @@ class AsyncWorkspacesClient:
 
     async def get(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> Workspace:
         """
+
         Get information about a specific workspace. You will need to provide the workspace ID. You can find this using [List workspaces](list).
 
         Parameters
@@ -431,21 +509,37 @@ class AsyncWorkspacesClient:
 
         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.workspaces.get(
-            id=1,
-        )
+
+
+        async def main() -> None:
+            await client.workspaces.get(
+                id=1,
+            )
+
+
+        asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
-            f"api/workspaces/{jsonable_encoder(id)}", method="GET", request_options=request_options
+            f"api/workspaces/{jsonable_encoder(id)}",
+            method="GET",
+            request_options=request_options,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(Workspace, _response.json())  # type: ignore
+                return typing.cast(
+                    Workspace,
+                    parse_obj_as(
+                        type_=Workspace,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -453,6 +547,7 @@ class AsyncWorkspacesClient:
 
     async def delete(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> None:
         """
+
         Delete a specific workspace. You will need to provide the workspace ID. You can find this using [List workspaces](list).
 
         Parameters
@@ -469,17 +564,27 @@ class AsyncWorkspacesClient:
 
         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.workspaces.delete(
-            id=1,
-        )
+
+
+        async def main() -> None:
+            await client.workspaces.delete(
+                id=1,
+            )
+
+
+        asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
-            f"api/workspaces/{jsonable_encoder(id)}", method="DELETE", request_options=request_options
+            f"api/workspaces/{jsonable_encoder(id)}",
+            method="DELETE",
+            request_options=request_options,
         )
         try:
             if 200 <= _response.status_code < 300:
@@ -502,6 +607,7 @@ class AsyncWorkspacesClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> Workspace:
         """
+
         Update a specific workspace. You will need to provide the workspace ID. You can find this using [List workspaces](list).
 
         Parameters
@@ -537,14 +643,22 @@ class AsyncWorkspacesClient:
 
         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.workspaces.update(
-            id=1,
-        )
+
+
+        async def main() -> None:
+            await client.workspaces.update(
+                id=1,
+            )
+
+
+        asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
             f"api/workspaces/{jsonable_encoder(id)}",
@@ -557,12 +671,21 @@ class AsyncWorkspacesClient:
                 "color": color,
                 "is_archived": is_archived,
             },
+            headers={
+                "content-type": "application/json",
+            },
             request_options=request_options,
             omit=OMIT,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(Workspace, _response.json())  # type: ignore
+                return typing.cast(
+                    Workspace,
+                    parse_obj_as(
+                        type_=Workspace,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)