label-studio-sdk 2.0.10__py3-none-any.whl → 2.0.12__py3-none-any.whl

label_studio_sdk/projects/members/client.py

@@ -1,11 +1,11 @@
 # This file was auto-generated by Fern from our API Definition.
 
+import typing
 from ...core.client_wrapper import SyncClientWrapper
 from .bulk.client import BulkClient
 from .paginated.client import PaginatedClient
-import typing
 from ...core.request_options import RequestOptions
-from ...types.lse_user import LseUser
+from ...types.project_member import ProjectMember
 from ...core.jsonable_encoder import jsonable_encoder
 from ...core.unchecked_base_model import construct_type
 from json.decoder import JSONDecodeError
@@ -14,6 +14,9 @@ from ...core.client_wrapper import AsyncClientWrapper
 from .bulk.client import AsyncBulkClient
 from .paginated.client import AsyncPaginatedClient
 
+# this is used as the default value for optional parameters
+OMIT = typing.cast(typing.Any, ...)
+
 
 class MembersClient:
     def __init__(self, *, client_wrapper: SyncClientWrapper):
@@ -21,26 +24,29 @@ class MembersClient:
         self.bulk = BulkClient(client_wrapper=self._client_wrapper)
         self.paginated = PaginatedClient(client_wrapper=self._client_wrapper)
 
-    def get(
-        self, id: int, *, user_ids: typing.Optional[str] = None, request_options: typing.Optional[RequestOptions] = None
-    ) -> typing.List[LseUser]:
+    def add(self, id: int, *, user: int, request_options: typing.Optional[RequestOptions] = None) -> ProjectMember:
         """
-        Retrieve the members for a specific project. Optionally filter by user IDs (comma-separated).
+        <Card href="https://humansignal.com/goenterprise">
+                <img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
+                <p style="margin-top: 10px; font-size: 14px;">
+                    This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
+                </p>
+            </Card>
+        Add a member to a specific project.
 
         Parameters
         ----------
         id : int
 
-        user_ids : typing.Optional[str]
-            Comma-separated list of user IDs to include. Example: user_ids=1,2,3
+        user : int
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
         Returns
         -------
-        typing.List[LseUser]
-            List of users with membership information
+        ProjectMember
+
 
         Examples
         --------
@@ -49,24 +55,29 @@ class MembersClient:
         client = LabelStudio(
             api_key="YOUR_API_KEY",
         )
-        client.projects.members.get(
+        client.projects.members.add(
             id=1,
+            user=1,
         )
         """
         _response = self._client_wrapper.httpx_client.request(
             f"api/projects/{jsonable_encoder(id)}/members/",
-            method="GET",
-            params={
-                "user_ids": user_ids,
+            method="POST",
+            json={
+                "user": user,
+            },
+            headers={
+                "content-type": "application/json",
             },
             request_options=request_options,
+            omit=OMIT,
         )
         try:
             if 200 <= _response.status_code < 300:
                 return typing.cast(
-                    typing.List[LseUser],
+                    ProjectMember,
                     construct_type(
-                        type_=typing.List[LseUser],  # type: ignore
+                        type_=ProjectMember,  # type: ignore
                         object_=_response.json(),
                     ),
                 )
@@ -75,6 +86,51 @@ class MembersClient:
             raise ApiError(status_code=_response.status_code, body=_response.text)
         raise ApiError(status_code=_response.status_code, body=_response_json)
 
+    def remove(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> None:
+        """
+        <Card href="https://humansignal.com/goenterprise">
+                <img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
+                <p style="margin-top: 10px; font-size: 14px;">
+                    This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
+                </p>
+            </Card>
+        Remove a member from a specific project.
+
+        Parameters
+        ----------
+        id : int
+
+        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.projects.members.remove(
+            id=1,
+        )
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            f"api/projects/{jsonable_encoder(id)}/members/",
+            method="DELETE",
+            request_options=request_options,
+        )
+        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)
+
 
 class AsyncMembersClient:
     def __init__(self, *, client_wrapper: AsyncClientWrapper):
@@ -82,26 +138,31 @@ class AsyncMembersClient:
         self.bulk = AsyncBulkClient(client_wrapper=self._client_wrapper)
         self.paginated = AsyncPaginatedClient(client_wrapper=self._client_wrapper)
 
-    async def get(
-        self, id: int, *, user_ids: typing.Optional[str] = None, request_options: typing.Optional[RequestOptions] = None
-    ) -> typing.List[LseUser]:
+    async def add(
+        self, id: int, *, user: int, request_options: typing.Optional[RequestOptions] = None
+    ) -> ProjectMember:
         """
-        Retrieve the members for a specific project. Optionally filter by user IDs (comma-separated).
+        <Card href="https://humansignal.com/goenterprise">
+                <img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
+                <p style="margin-top: 10px; font-size: 14px;">
+                    This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
+                </p>
+            </Card>
+        Add a member to a specific project.
 
         Parameters
         ----------
         id : int
 
-        user_ids : typing.Optional[str]
-            Comma-separated list of user IDs to include. Example: user_ids=1,2,3
+        user : int
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
         Returns
         -------
-        typing.List[LseUser]
-            List of users with membership information
+        ProjectMember
+
 
         Examples
         --------
@@ -115,8 +176,9 @@ class AsyncMembersClient:
 
 
         async def main() -> None:
-            await client.projects.members.get(
+            await client.projects.members.add(
                 id=1,
+                user=1,
             )
 
 
@@ -124,18 +186,22 @@ class AsyncMembersClient:
         """
         _response = await self._client_wrapper.httpx_client.request(
             f"api/projects/{jsonable_encoder(id)}/members/",
-            method="GET",
-            params={
-                "user_ids": user_ids,
+            method="POST",
+            json={
+                "user": user,
+            },
+            headers={
+                "content-type": "application/json",
             },
             request_options=request_options,
+            omit=OMIT,
         )
         try:
             if 200 <= _response.status_code < 300:
                 return typing.cast(
-                    typing.List[LseUser],
+                    ProjectMember,
                     construct_type(
-                        type_=typing.List[LseUser],  # type: ignore
+                        type_=ProjectMember,  # type: ignore
                         object_=_response.json(),
                     ),
                 )
@@ -143,3 +209,56 @@ class AsyncMembersClient:
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
         raise ApiError(status_code=_response.status_code, body=_response_json)
+
+    async def remove(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> None:
+        """
+        <Card href="https://humansignal.com/goenterprise">
+                <img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
+                <p style="margin-top: 10px; font-size: 14px;">
+                    This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
+                </p>
+            </Card>
+        Remove a member from a specific project.
+
+        Parameters
+        ----------
+        id : int
+
+        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.projects.members.remove(
+                id=1,
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            f"api/projects/{jsonable_encoder(id)}/members/",
+            method="DELETE",
+            request_options=request_options,
+        )
+        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)

label_studio_sdk/projects/members/paginated/client.py

@@ -32,6 +32,12 @@ class PaginatedClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> SyncPager[PaginatedProjectMember]:
         """
+        <Card href="https://humansignal.com/goenterprise">
+                <img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
+                <p style="margin-top: 10px; font-size: 14px;">
+                    This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
+                </p>
+            </Card>
         Retrieve the members for a specific project.
 
         Parameters
@@ -145,6 +151,12 @@ class AsyncPaginatedClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> AsyncPager[PaginatedProjectMember]:
         """
+        <Card href="https://humansignal.com/goenterprise">
+                <img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
+                <p style="margin-top: 10px; font-size: 14px;">
+                    This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
+                </p>
+            </Card>
         Retrieve the members for a specific project.
 
         Parameters

label_studio_sdk/projects/metrics/client.py

@@ -23,6 +23,12 @@ class MetricsClient:
 
     def get(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> MetricParam:
         """
+        <Card href="https://humansignal.com/goenterprise">
+                <img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
+                <p style="margin-top: 10px; font-size: 14px;">
+                    This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
+                </p>
+            </Card>
         Get the current metrics configuration for a project.
 
         Parameters
@@ -78,6 +84,12 @@ class MetricsClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> MetricParam:
         """
+        <Card href="https://humansignal.com/goenterprise">
+                <img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
+                <p style="margin-top: 10px; font-size: 14px;">
+                    This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
+                </p>
+            </Card>
         Update metrics strategy and parameters for a project.
 
         Parameters
@@ -148,6 +160,12 @@ class AsyncMetricsClient:
 
     async def get(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> MetricParam:
         """
+        <Card href="https://humansignal.com/goenterprise">
+                <img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
+                <p style="margin-top: 10px; font-size: 14px;">
+                    This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
+                </p>
+            </Card>
         Get the current metrics configuration for a project.
 
         Parameters
@@ -211,6 +229,12 @@ class AsyncMetricsClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> MetricParam:
         """
+        <Card href="https://humansignal.com/goenterprise">
+                <img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
+                <p style="margin-top: 10px; font-size: 14px;">
+                    This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
+                </p>
+            </Card>
         Update metrics strategy and parameters for a project.
 
         Parameters

label_studio_sdk/projects/pauses/client.py

@@ -29,6 +29,12 @@ class PausesClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> typing.List[Pause]:
         """
+        <Card href="https://humansignal.com/goenterprise">
+                <img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
+                <p style="margin-top: 10px; font-size: 14px;">
+                    This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
+                </p>
+            </Card>
         Retrieve a list of all pauses.
 
         Parameters
@@ -96,6 +102,12 @@ class PausesClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> Pause:
         """
+        <Card href="https://humansignal.com/goenterprise">
+                <img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
+                <p style="margin-top: 10px; font-size: 14px;">
+                    This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
+                </p>
+            </Card>
         Create a new pause entry.
 
         Parameters
@@ -165,6 +177,12 @@ class PausesClient:
         self, id: str, project_pk: int, user_pk: int, *, request_options: typing.Optional[RequestOptions] = None
     ) -> Pause:
         """
+        <Card href="https://humansignal.com/goenterprise">
+                <img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
+                <p style="margin-top: 10px; font-size: 14px;">
+                    This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
+                </p>
+            </Card>
         Retrieve a specific pause by ID.
 
         Parameters
@@ -219,6 +237,12 @@ class PausesClient:
         self, id: str, project_pk: int, user_pk: int, *, request_options: typing.Optional[RequestOptions] = None
     ) -> None:
         """
+        <Card href="https://humansignal.com/goenterprise">
+                <img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
+                <p style="margin-top: 10px; font-size: 14px;">
+                    This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
+                </p>
+            </Card>
         Delete a specific pause by ID.
 
         Parameters
@@ -273,6 +297,12 @@ class PausesClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> Pause:
         """
+        <Card href="https://humansignal.com/goenterprise">
+                <img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
+                <p style="margin-top: 10px; font-size: 14px;">
+                    This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
+                </p>
+            </Card>
         Partially update a pause entry by ID.
 
         Parameters
@@ -358,6 +388,12 @@ class AsyncPausesClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> typing.List[Pause]:
         """
+        <Card href="https://humansignal.com/goenterprise">
+                <img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
+                <p style="margin-top: 10px; font-size: 14px;">
+                    This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
+                </p>
+            </Card>
         Retrieve a list of all pauses.
 
         Parameters
@@ -433,6 +469,12 @@ class AsyncPausesClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> Pause:
         """
+        <Card href="https://humansignal.com/goenterprise">
+                <img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
+                <p style="margin-top: 10px; font-size: 14px;">
+                    This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
+                </p>
+            </Card>
         Create a new pause entry.
 
         Parameters
@@ -510,6 +552,12 @@ class AsyncPausesClient:
         self, id: str, project_pk: int, user_pk: int, *, request_options: typing.Optional[RequestOptions] = None
     ) -> Pause:
         """
+        <Card href="https://humansignal.com/goenterprise">
+                <img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
+                <p style="margin-top: 10px; font-size: 14px;">
+                    This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
+                </p>
+            </Card>
         Retrieve a specific pause by ID.
 
         Parameters
@@ -572,6 +620,12 @@ class AsyncPausesClient:
         self, id: str, project_pk: int, user_pk: int, *, request_options: typing.Optional[RequestOptions] = None
     ) -> None:
         """
+        <Card href="https://humansignal.com/goenterprise">
+                <img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
+                <p style="margin-top: 10px; font-size: 14px;">
+                    This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
+                </p>
+            </Card>
         Delete a specific pause by ID.
 
         Parameters
@@ -634,6 +688,12 @@ class AsyncPausesClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> Pause:
         """
+        <Card href="https://humansignal.com/goenterprise">
+                <img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
+                <p style="margin-top: 10px; font-size: 14px;">
+                    This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
+                </p>
+            </Card>
         Partially update a pause entry by ID.
 
         Parameters

label_studio_sdk/projects/roles/__init__.py

@@ -0,0 +1,2 @@
+# This file was auto-generated by Fern from our API Definition.
+