label-studio-sdk 1.0.20__py3-none-any.whl → 2.0.1__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.20.dist-info → label_studio_sdk-2.0.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: label-studio-sdk
-Version: 1.0.20
+Version: 2.0.1
 Summary: 
 Requires-Python: >=3.9,<4
 Classifier: Intended Audience :: Developers
@@ -45,29 +45,6 @@ Description-Content-Type: text/markdown
 
 # Label Studio Python Library
 
-<!-- Note about deprecated version <1 -->
----
-> :warning: **Note**<br/>
->
-> The version of `label-studio-sdk<1` is deprecated and no longer supported. We recommend updating to the latest version.
-> If you still want to use the old version, you can install it with `pip install "label-studio-sdk<1"`.
-> OR You can find the branch with the old version by cloning the repository and checking out the branch as follows:
->
-> ```sh
-> git clone https://github.com/HumanSignal/label-studio-sdk.git
-> cd label-studio-sdk
-> git fetch origin
-> git checkout release/0.0.34
-> ```
-> 
-> OR you can change your import statements as follows:
-> ```python
-> from label_studio_sdk import Client
-> from label_studio_sdk.data_manager import Filters, Column, Operator, Type
-> from label_studio_sdk._legacy import Project
-> ```
----
-
 [![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-SDK%20generated%20by%20Fern-brightgreen)](https://github.com/fern-api/fern)
 [![pypi](https://img.shields.io/pypi/v/label-studio-sdk.svg)](https://pypi.python.org/pypi/label-studio-sdk)
 
@@ -100,6 +77,77 @@ ls = LabelStudio(
 )
 ```
 
+# Versions
+
+## SDK 2.0.0
+
+In August 2025, we released SDK version 2.0.0. 
+
+This version has a number of documentation and functional improvements over SDK 1. 
+
+### Enhancements 
+
+**Enterprise-only**
+
+- Added a new `projects.stats.iaa` endpoint to return stats from the inter-annotator agreement matrix. 
+- You can now update tasks that have comments.
+- Added support for `sync` to `S3s` (S3 with IAM role) exports.
+
+**Enterprise and open source**
+
+- Expanded support to include all project settings, many of which were missing in SDK 1. For example, in Enterprise environments you can now configure `assignment_settings`, `review_settings`, `annotator_evaluation`, and many more.
+- Fixed passing the `project` parameter in `actions.list()` (broken in SDK 1). 
+- Relaxed request/response validation reduces pydantic errors in SDK 2.
+
+### Breaking changes
+
+**Enterprise-only**
+
+- `comments.create` no longer accepts a `project` argument.
+- In `prompts.indicators`, the `pk` parameter is now `id`.
+- In `prompts.runs` and `prompts.versions`, the `id` parameter is now `prompt_id`.
+- `workspaces.members.list` responses are now objects instead of dictionaries.
+
+**Enterprise and open source**
+
+- In `projects.exports` calls, the project ID is now passed as `id`, while the export ID is passed as `export_pk`.
+- Predictions returned in task responses are now objects instead of dictionaries. 
+
+## SDK 1.0+
+
+SDK 1 was released in June 2024. 
+
+If you use the Label Studio SDK 1 package in any automated pipelines, we strongly recommend pinning your SDK version to `<2.0.0` until you can reconcile the breaking changes. 
+
+
+## SDK <1
+
+The version of `label-studio-sdk<1` is deprecated and no longer supported. We recommend updating to the latest version.
+
+<details>
+
+<summary> To use SDK <1 </summary>
+
+If you still want to use the deprecated version, you can install it with `pip install "label-studio-sdk<1"`. 
+
+OR You can find the branch with the old version by cloning the repository and checking out the branch as follows:
+
+```sh
+git clone https://github.com/HumanSignal/label-studio-sdk.git
+cd label-studio-sdk
+git fetch origin
+git checkout release/0.0.34
+```
+
+OR you can change your import statements as follows:
+```python
+from label_studio_sdk import Client
+from label_studio_sdk.data_manager import Filters, Column, Operator, Type
+from label_studio_sdk._legacy import Project
+```
+
+</details>
+
 # Examples
 
 Check more examples [here](https://api.labelstud.io/).
@@ -111,7 +159,7 @@ from label_studio_sdk.label_interface import LabelInterface
 from label_studio_sdk.label_interface.create import labels
 
 project = ls.projects.create(
-    name="Project name",
+    title="Project name",
     description="Project description",
     label_config=LabelInterface.create({
       "image": "Image",