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

label_studio_sdk/projects/pauses/client.py

@@ -0,0 +1,704 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+from ...core.client_wrapper import SyncClientWrapper
+from ...core.request_options import RequestOptions
+from ...types.pause import Pause
+from ...core.jsonable_encoder import jsonable_encoder
+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
+
+# this is used as the default value for optional parameters
+OMIT = typing.cast(typing.Any, ...)
+
+
+class PausesClient:
+    def __init__(self, *, client_wrapper: SyncClientWrapper):
+        self._client_wrapper = client_wrapper
+
+    def list(
+        self,
+        project_pk: int,
+        user_pk: int,
+        *,
+        include_deleted: typing.Optional[bool] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> typing.List[Pause]:
+        """
+        Return a list of pause objects for the specified project and user.
+
+        Parameters
+        ----------
+        project_pk : int
+            Project ID
+
+        user_pk : int
+            User ID
+
+        include_deleted : typing.Optional[bool]
+            Include deleted pauses
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        typing.List[Pause]
+            Successfully retrieved a list of pauses
+
+        Examples
+        --------
+        from label_studio_sdk import LabelStudio
+
+        client = LabelStudio(
+            api_key="YOUR_API_KEY",
+        )
+        client.projects.pauses.list(
+            project_pk=1,
+            user_pk=1,
+        )
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            f"api/projects/{jsonable_encoder(project_pk)}/members/{jsonable_encoder(user_pk)}/pauses",
+            method="GET",
+            params={
+                "include_deleted": include_deleted,
+            },
+            request_options=request_options,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                return typing.cast(
+                    typing.List[Pause],
+                    parse_obj_as(
+                        type_=typing.List[Pause],  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+            _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 create(
+        self,
+        project_pk: int,
+        user_pk: int,
+        *,
+        reason: str,
+        verbose_reason: typing.Optional[str] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> Pause:
+        """
+        Create a new pause object for the specified project and user.
+
+        Parameters
+        ----------
+        project_pk : int
+            Project ID
+
+        user_pk : int
+            User ID
+
+        reason : str
+
+        verbose_reason : typing.Optional[str]
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        Pause
+            Successfully created a pause
+
+        Examples
+        --------
+        from label_studio_sdk import LabelStudio
+
+        client = LabelStudio(
+            api_key="YOUR_API_KEY",
+        )
+        client.projects.pauses.create(
+            project_pk=1,
+            user_pk=1,
+            reason="reason",
+        )
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            f"api/projects/{jsonable_encoder(project_pk)}/members/{jsonable_encoder(user_pk)}/pauses",
+            method="POST",
+            json={
+                "reason": reason,
+                "verbose_reason": verbose_reason,
+            },
+            headers={
+                "content-type": "application/json",
+            },
+            request_options=request_options,
+            omit=OMIT,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                return typing.cast(
+                    Pause,
+                    parse_obj_as(
+                        type_=Pause,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+            _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 get(
+        self, project_pk: int, user_pk: int, id: int, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> Pause:
+        """
+        Return detailed information about a specific pause.
+
+        Parameters
+        ----------
+        project_pk : int
+            Project ID
+
+        user_pk : int
+            User ID
+
+        id : int
+            Pause ID
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        Pause
+            Successfully retrieved the pause
+
+        Examples
+        --------
+        from label_studio_sdk import LabelStudio
+
+        client = LabelStudio(
+            api_key="YOUR_API_KEY",
+        )
+        client.projects.pauses.get(
+            project_pk=1,
+            user_pk=1,
+            id=1,
+        )
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            f"api/projects/{jsonable_encoder(project_pk)}/members/{jsonable_encoder(user_pk)}/pauses/{jsonable_encoder(id)}",
+            method="GET",
+            request_options=request_options,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                return typing.cast(
+                    Pause,
+                    parse_obj_as(
+                        type_=Pause,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+            _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, project_pk: int, user_pk: int, id: int, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> None:
+        """
+        Remove a pause from the database.
+
+        Parameters
+        ----------
+        project_pk : int
+            Project ID
+
+        user_pk : int
+            User ID
+
+        id : int
+            Pause ID
+
+        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.pauses.delete(
+            project_pk=1,
+            user_pk=1,
+            id=1,
+        )
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            f"api/projects/{jsonable_encoder(project_pk)}/members/{jsonable_encoder(user_pk)}/pauses/{jsonable_encoder(id)}",
+            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)
+
+    def update(
+        self,
+        project_pk: int,
+        user_pk: int,
+        id: int,
+        *,
+        reason: str,
+        verbose_reason: typing.Optional[str] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> Pause:
+        """
+        Partially update one or more fields of an existing pause.
+
+        Parameters
+        ----------
+        project_pk : int
+            Project ID
+
+        user_pk : int
+            User ID
+
+        id : int
+            Pause ID
+
+        reason : str
+
+        verbose_reason : typing.Optional[str]
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        Pause
+            Successfully updated the pause (partial)
+
+        Examples
+        --------
+        from label_studio_sdk import LabelStudio
+
+        client = LabelStudio(
+            api_key="YOUR_API_KEY",
+        )
+        client.projects.pauses.update(
+            project_pk=1,
+            user_pk=1,
+            id=1,
+            reason="reason",
+        )
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            f"api/projects/{jsonable_encoder(project_pk)}/members/{jsonable_encoder(user_pk)}/pauses/{jsonable_encoder(id)}",
+            method="PATCH",
+            json={
+                "reason": reason,
+                "verbose_reason": verbose_reason,
+            },
+            headers={
+                "content-type": "application/json",
+            },
+            request_options=request_options,
+            omit=OMIT,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                return typing.cast(
+                    Pause,
+                    parse_obj_as(
+                        type_=Pause,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+            _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 AsyncPausesClient:
+    def __init__(self, *, client_wrapper: AsyncClientWrapper):
+        self._client_wrapper = client_wrapper
+
+    async def list(
+        self,
+        project_pk: int,
+        user_pk: int,
+        *,
+        include_deleted: typing.Optional[bool] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> typing.List[Pause]:
+        """
+        Return a list of pause objects for the specified project and user.
+
+        Parameters
+        ----------
+        project_pk : int
+            Project ID
+
+        user_pk : int
+            User ID
+
+        include_deleted : typing.Optional[bool]
+            Include deleted pauses
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        typing.List[Pause]
+            Successfully retrieved a list of pauses
+
+        Examples
+        --------
+        import asyncio
+
+        from label_studio_sdk import AsyncLabelStudio
+
+        client = AsyncLabelStudio(
+            api_key="YOUR_API_KEY",
+        )
+
+
+        async def main() -> None:
+            await client.projects.pauses.list(
+                project_pk=1,
+                user_pk=1,
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            f"api/projects/{jsonable_encoder(project_pk)}/members/{jsonable_encoder(user_pk)}/pauses",
+            method="GET",
+            params={
+                "include_deleted": include_deleted,
+            },
+            request_options=request_options,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                return typing.cast(
+                    typing.List[Pause],
+                    parse_obj_as(
+                        type_=typing.List[Pause],  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+            _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 create(
+        self,
+        project_pk: int,
+        user_pk: int,
+        *,
+        reason: str,
+        verbose_reason: typing.Optional[str] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> Pause:
+        """
+        Create a new pause object for the specified project and user.
+
+        Parameters
+        ----------
+        project_pk : int
+            Project ID
+
+        user_pk : int
+            User ID
+
+        reason : str
+
+        verbose_reason : typing.Optional[str]
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        Pause
+            Successfully created a pause
+
+        Examples
+        --------
+        import asyncio
+
+        from label_studio_sdk import AsyncLabelStudio
+
+        client = AsyncLabelStudio(
+            api_key="YOUR_API_KEY",
+        )
+
+
+        async def main() -> None:
+            await client.projects.pauses.create(
+                project_pk=1,
+                user_pk=1,
+                reason="reason",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            f"api/projects/{jsonable_encoder(project_pk)}/members/{jsonable_encoder(user_pk)}/pauses",
+            method="POST",
+            json={
+                "reason": reason,
+                "verbose_reason": verbose_reason,
+            },
+            headers={
+                "content-type": "application/json",
+            },
+            request_options=request_options,
+            omit=OMIT,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                return typing.cast(
+                    Pause,
+                    parse_obj_as(
+                        type_=Pause,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+            _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 get(
+        self, project_pk: int, user_pk: int, id: int, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> Pause:
+        """
+        Return detailed information about a specific pause.
+
+        Parameters
+        ----------
+        project_pk : int
+            Project ID
+
+        user_pk : int
+            User ID
+
+        id : int
+            Pause ID
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        Pause
+            Successfully retrieved the pause
+
+        Examples
+        --------
+        import asyncio
+
+        from label_studio_sdk import AsyncLabelStudio
+
+        client = AsyncLabelStudio(
+            api_key="YOUR_API_KEY",
+        )
+
+
+        async def main() -> None:
+            await client.projects.pauses.get(
+                project_pk=1,
+                user_pk=1,
+                id=1,
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            f"api/projects/{jsonable_encoder(project_pk)}/members/{jsonable_encoder(user_pk)}/pauses/{jsonable_encoder(id)}",
+            method="GET",
+            request_options=request_options,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                return typing.cast(
+                    Pause,
+                    parse_obj_as(
+                        type_=Pause,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+            _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, project_pk: int, user_pk: int, id: int, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> None:
+        """
+        Remove a pause from the database.
+
+        Parameters
+        ----------
+        project_pk : int
+            Project ID
+
+        user_pk : int
+            User ID
+
+        id : int
+            Pause ID
+
+        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.pauses.delete(
+                project_pk=1,
+                user_pk=1,
+                id=1,
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            f"api/projects/{jsonable_encoder(project_pk)}/members/{jsonable_encoder(user_pk)}/pauses/{jsonable_encoder(id)}",
+            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)
+
+    async def update(
+        self,
+        project_pk: int,
+        user_pk: int,
+        id: int,
+        *,
+        reason: str,
+        verbose_reason: typing.Optional[str] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> Pause:
+        """
+        Partially update one or more fields of an existing pause.
+
+        Parameters
+        ----------
+        project_pk : int
+            Project ID
+
+        user_pk : int
+            User ID
+
+        id : int
+            Pause ID
+
+        reason : str
+
+        verbose_reason : typing.Optional[str]
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        Pause
+            Successfully updated the pause (partial)
+
+        Examples
+        --------
+        import asyncio
+
+        from label_studio_sdk import AsyncLabelStudio
+
+        client = AsyncLabelStudio(
+            api_key="YOUR_API_KEY",
+        )
+
+
+        async def main() -> None:
+            await client.projects.pauses.update(
+                project_pk=1,
+                user_pk=1,
+                id=1,
+                reason="reason",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            f"api/projects/{jsonable_encoder(project_pk)}/members/{jsonable_encoder(user_pk)}/pauses/{jsonable_encoder(id)}",
+            method="PATCH",
+            json={
+                "reason": reason,
+                "verbose_reason": verbose_reason,
+            },
+            headers={
+                "content-type": "application/json",
+            },
+            request_options=request_options,
+            omit=OMIT,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                return typing.cast(
+                    Pause,
+                    parse_obj_as(
+                        type_=Pause,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+            _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/types/projects_update_response.py

@@ -66,6 +66,16 @@ class ProjectsUpdateResponse(UniversalBaseModel):
     Maximum annotations per task
     """
 
+    annotation_limit_count: typing.Optional[int] = pydantic.Field(default=None)
+    """
+    Maximum number of annotations per annotator
+    """
+
+    annotation_limit_percent: typing.Optional[float] = pydantic.Field(default=None)
+    """
+    Maximum percentage of annotations per annotator
+    """
+
     color: typing.Optional[str] = pydantic.Field(default=None)
     """
     Project color in HEX format

label_studio_sdk/tokens/__init__.py

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