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

label_studio_sdk/workspaces/members/client.py

@@ -3,12 +3,12 @@
 import typing
 from ...core.client_wrapper import SyncClientWrapper
 from ...core.request_options import RequestOptions
-from .types.members_list_response_item import MembersListResponseItem
+from ...types.workspace_member_list import WorkspaceMemberList
 from ...core.jsonable_encoder import jsonable_encoder
-from ...core.pydantic_utilities import parse_obj_as
+from ...core.unchecked_base_model import construct_type
 from json.decoder import JSONDecodeError
 from ...core.api_error import ApiError
-from .types.members_create_response import MembersCreateResponse
+from ...types.workspace_member_create import WorkspaceMemberCreate
 from ...core.client_wrapper import AsyncClientWrapper
 
 # this is used as the default value for optional parameters
@@ -21,23 +21,21 @@ class MembersClient:
 
     def list(
         self, id: int, *, request_options: typing.Optional[RequestOptions] = None
-    ) -> typing.List[MembersListResponseItem]:
+    ) -> typing.List[WorkspaceMemberList]:
         """
-
-        List all workspace memberships for a specific workspace. You will need to provide the workspace ID. You can find this using [List workspaces](list).
+        Get a list of all members in a specific workspace.
 
         Parameters
         ----------
         id : int
-            Workspace ID
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
         Returns
         -------
-        typing.List[MembersListResponseItem]
-
+        typing.List[WorkspaceMemberList]
+            A list of workspace memberships
 
         Examples
         --------
@@ -51,16 +49,16 @@ class MembersClient:
         )
         """
         _response = self._client_wrapper.httpx_client.request(
-            f"api/workspaces/{jsonable_encoder(id)}/memberships",
+            f"api/workspaces/{jsonable_encoder(id)}/memberships/",
             method="GET",
             request_options=request_options,
         )
         try:
             if 200 <= _response.status_code < 300:
                 return typing.cast(
-                    typing.List[MembersListResponseItem],
-                    parse_obj_as(
-                        type_=typing.List[MembersListResponseItem],  # type: ignore
+                    typing.List[WorkspaceMemberList],
+                    construct_type(
+                        type_=typing.List[WorkspaceMemberList],  # type: ignore
                         object_=_response.json(),
                     ),
                 )
@@ -70,26 +68,32 @@ class MembersClient:
         raise ApiError(status_code=_response.status_code, body=_response_json)
 
     def create(
-        self, id: int, *, user: typing.Optional[int] = OMIT, request_options: typing.Optional[RequestOptions] = None
-    ) -> MembersCreateResponse:
+        self,
+        id: int,
+        *,
+        user: int,
+        workspace: typing.Optional[int] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> WorkspaceMemberCreate:
         """
-
-        Create a new workspace membership. You will need to provide the workspace ID. You can find this using [List workspaces](list).
+        Add a new workspace member by user ID.
 
         Parameters
         ----------
         id : int
-            Workspace ID
 
-        user : typing.Optional[int]
-            User ID of the workspace member
+        user : int
+            User ID
+
+        workspace : typing.Optional[int]
+            Workspace ID
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
         Returns
         -------
-        MembersCreateResponse
+        WorkspaceMemberCreate
 
 
         Examples
@@ -101,13 +105,15 @@ class MembersClient:
         )
         client.workspaces.members.create(
             id=1,
+            user=1,
         )
         """
         _response = self._client_wrapper.httpx_client.request(
-            f"api/workspaces/{jsonable_encoder(id)}/memberships",
+            f"api/workspaces/{jsonable_encoder(id)}/memberships/",
             method="POST",
             json={
                 "user": user,
+                "workspace": workspace,
             },
             headers={
                 "content-type": "application/json",
@@ -118,9 +124,9 @@ class MembersClient:
         try:
             if 200 <= _response.status_code < 300:
                 return typing.cast(
-                    MembersCreateResponse,
-                    parse_obj_as(
-                        type_=MembersCreateResponse,  # type: ignore
+                    WorkspaceMemberCreate,
+                    construct_type(
+                        type_=WorkspaceMemberCreate,  # type: ignore
                         object_=_response.json(),
                     ),
                 )
@@ -129,20 +135,13 @@ class MembersClient:
             raise ApiError(status_code=_response.status_code, body=_response.text)
         raise ApiError(status_code=_response.status_code, body=_response_json)
 
-    def delete(
-        self, id: int, *, user: typing.Optional[int] = OMIT, request_options: typing.Optional[RequestOptions] = None
-    ) -> None:
+    def delete(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> None:
         """
-
-        Delete a specific workspace membership. You will need to provide the workspace ID and the user ID. You can find this using [List workspace memberships](list).
+        Remove a specific member by ID from a workspace. This endpoint expects an object like `{"user_id": 123}`.
 
         Parameters
         ----------
         id : int
-            Workspace ID
-
-        user : typing.Optional[int]
-            User ID of the workspace member
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -163,16 +162,9 @@ class MembersClient:
         )
         """
         _response = self._client_wrapper.httpx_client.request(
-            f"api/workspaces/{jsonable_encoder(id)}/memberships",
+            f"api/workspaces/{jsonable_encoder(id)}/memberships/",
             method="DELETE",
-            json={
-                "user": user,
-            },
-            headers={
-                "content-type": "application/json",
-            },
             request_options=request_options,
-            omit=OMIT,
         )
         try:
             if 200 <= _response.status_code < 300:
@@ -189,23 +181,21 @@ class AsyncMembersClient:
 
     async def list(
         self, id: int, *, request_options: typing.Optional[RequestOptions] = None
-    ) -> typing.List[MembersListResponseItem]:
+    ) -> typing.List[WorkspaceMemberList]:
         """
-
-        List all workspace memberships for a specific workspace. You will need to provide the workspace ID. You can find this using [List workspaces](list).
+        Get a list of all members in a specific workspace.
 
         Parameters
         ----------
         id : int
-            Workspace ID
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
         Returns
         -------
-        typing.List[MembersListResponseItem]
-
+        typing.List[WorkspaceMemberList]
+            A list of workspace memberships
 
         Examples
         --------
@@ -227,16 +217,16 @@ class AsyncMembersClient:
         asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
-            f"api/workspaces/{jsonable_encoder(id)}/memberships",
+            f"api/workspaces/{jsonable_encoder(id)}/memberships/",
             method="GET",
             request_options=request_options,
         )
         try:
             if 200 <= _response.status_code < 300:
                 return typing.cast(
-                    typing.List[MembersListResponseItem],
-                    parse_obj_as(
-                        type_=typing.List[MembersListResponseItem],  # type: ignore
+                    typing.List[WorkspaceMemberList],
+                    construct_type(
+                        type_=typing.List[WorkspaceMemberList],  # type: ignore
                         object_=_response.json(),
                     ),
                 )
@@ -246,26 +236,32 @@ class AsyncMembersClient:
         raise ApiError(status_code=_response.status_code, body=_response_json)
 
     async def create(
-        self, id: int, *, user: typing.Optional[int] = OMIT, request_options: typing.Optional[RequestOptions] = None
-    ) -> MembersCreateResponse:
+        self,
+        id: int,
+        *,
+        user: int,
+        workspace: typing.Optional[int] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> WorkspaceMemberCreate:
         """
-
-        Create a new workspace membership. You will need to provide the workspace ID. You can find this using [List workspaces](list).
+        Add a new workspace member by user ID.
 
         Parameters
         ----------
         id : int
-            Workspace ID
 
-        user : typing.Optional[int]
-            User ID of the workspace member
+        user : int
+            User ID
+
+        workspace : typing.Optional[int]
+            Workspace ID
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
         Returns
         -------
-        MembersCreateResponse
+        WorkspaceMemberCreate
 
 
         Examples
@@ -282,16 +278,18 @@ class AsyncMembersClient:
         async def main() -> None:
             await client.workspaces.members.create(
                 id=1,
+                user=1,
             )
 
 
         asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
-            f"api/workspaces/{jsonable_encoder(id)}/memberships",
+            f"api/workspaces/{jsonable_encoder(id)}/memberships/",
             method="POST",
             json={
                 "user": user,
+                "workspace": workspace,
             },
             headers={
                 "content-type": "application/json",
@@ -302,9 +300,9 @@ class AsyncMembersClient:
         try:
             if 200 <= _response.status_code < 300:
                 return typing.cast(
-                    MembersCreateResponse,
-                    parse_obj_as(
-                        type_=MembersCreateResponse,  # type: ignore
+                    WorkspaceMemberCreate,
+                    construct_type(
+                        type_=WorkspaceMemberCreate,  # type: ignore
                         object_=_response.json(),
                     ),
                 )
@@ -313,20 +311,13 @@ class AsyncMembersClient:
             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: int, *, user: typing.Optional[int] = OMIT, request_options: typing.Optional[RequestOptions] = None
-    ) -> None:
+    async def delete(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> None:
         """
-
-        Delete a specific workspace membership. You will need to provide the workspace ID and the user ID. You can find this using [List workspace memberships](list).
+        Remove a specific member by ID from a workspace. This endpoint expects an object like `{"user_id": 123}`.
 
         Parameters
         ----------
         id : int
-            Workspace ID
-
-        user : typing.Optional[int]
-            User ID of the workspace member
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -355,16 +346,9 @@ class AsyncMembersClient:
         asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
-            f"api/workspaces/{jsonable_encoder(id)}/memberships",
+            f"api/workspaces/{jsonable_encoder(id)}/memberships/",
             method="DELETE",
-            json={
-                "user": user,
-            },
-            headers={
-                "content-type": "application/json",
-            },
             request_options=request_options,
-            omit=OMIT,
         )
         try:
             if 200 <= _response.status_code < 300:

{label_studio_sdk-1.0.19.dist-info → label_studio_sdk-2.0.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: label-studio-sdk
-Version: 1.0.19
+Version: 2.0.0
 Summary: 
 Requires-Python: >=3.9,<4
 Classifier: Intended Audience :: Developers