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

label_studio_sdk/tasks/types/__init__.py

@@ -1,6 +1,5 @@
 # This file was auto-generated by Fern from our API Definition.
 
 from .tasks_list_request_fields import TasksListRequestFields
-from .tasks_list_response import TasksListResponse
 
-__all__ = ["TasksListRequestFields", "TasksListResponse"]
+__all__ = ["TasksListRequestFields"]

label_studio_sdk/tokens/client.py

@@ -3,14 +3,14 @@
 import typing
 from ..core.client_wrapper import SyncClientWrapper
 from ..core.request_options import RequestOptions
-from ..errors.not_found_error import NotFoundError
-from ..core.pydantic_utilities import parse_obj_as
+from ..types.lseapi_token_list import LseapiTokenList
+from ..core.unchecked_base_model import construct_type
 from json.decoder import JSONDecodeError
 from ..core.api_error import ApiError
-from ..types.api_token_response import ApiTokenResponse
-from ..types.access_token_response import AccessTokenResponse
-from ..errors.unauthorized_error import UnauthorizedError
-from ..types.rotate_token_response import RotateTokenResponse
+from ..types.lseapi_token_create import LseapiTokenCreate
+from ..errors.not_found_error import NotFoundError
+from ..types.token_refresh_response import TokenRefreshResponse
+from ..types.token_rotate_response import TokenRotateResponse
 from ..errors.bad_request_error import BadRequestError
 from ..core.client_wrapper import AsyncClientWrapper
 
@@ -22,21 +22,24 @@ class TokensClient:
     def __init__(self, *, client_wrapper: SyncClientWrapper):
         self._client_wrapper = client_wrapper
 
-    def blacklist(self, *, refresh: str, request_options: typing.Optional[RequestOptions] = None) -> None:
+    def list(
+        self, *, ordering: typing.Optional[str] = None, request_options: typing.Optional[RequestOptions] = None
+    ) -> typing.List[LseapiTokenList]:
         """
-        Blacklist a refresh token to prevent its future use.
+        List all API tokens for the current user.
 
         Parameters
         ----------
-        refresh : str
-            JWT refresh token
+        ordering : typing.Optional[str]
+            Which field to use when ordering the results.
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
         Returns
         -------
-        None
+        typing.List[LseapiTokenList]
+
 
         Examples
         --------
@@ -45,43 +48,33 @@ class TokensClient:
         client = LabelStudio(
             api_key="YOUR_API_KEY",
         )
-        client.tokens.blacklist(
-            refresh="refresh",
-        )
+        client.tokens.list()
         """
         _response = self._client_wrapper.httpx_client.request(
-            "api/token/blacklist",
-            method="POST",
-            json={
-                "refresh": refresh,
-            },
-            headers={
-                "content-type": "application/json",
+            "api/token/",
+            method="GET",
+            params={
+                "ordering": ordering,
             },
             request_options=request_options,
-            omit=OMIT,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return
-            if _response.status_code == 404:
-                raise NotFoundError(
-                    typing.cast(
-                        typing.Optional[typing.Any],
-                        parse_obj_as(
-                            type_=typing.Optional[typing.Any],  # type: ignore
-                            object_=_response.json(),
-                        ),
-                    )
+                return typing.cast(
+                    typing.List[LseapiTokenList],
+                    construct_type(
+                        type_=typing.List[LseapiTokenList],  # 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, *, request_options: typing.Optional[RequestOptions] = None) -> typing.List[ApiTokenResponse]:
+    def create(self, *, request_options: typing.Optional[RequestOptions] = None) -> LseapiTokenCreate:
         """
-        List all API tokens for the current user.
+        Create a new API token for the current user.
 
         Parameters
         ----------
@@ -90,8 +83,8 @@ class TokensClient:
 
         Returns
         -------
-        typing.List[ApiTokenResponse]
-            List of API tokens retrieved successfully
+        LseapiTokenCreate
+
 
         Examples
         --------
@@ -100,19 +93,19 @@ class TokensClient:
         client = LabelStudio(
             api_key="YOUR_API_KEY",
         )
-        client.tokens.get()
+        client.tokens.create()
         """
         _response = self._client_wrapper.httpx_client.request(
-            "api/token",
-            method="GET",
+            "api/token/",
+            method="POST",
             request_options=request_options,
         )
         try:
             if 200 <= _response.status_code < 300:
                 return typing.cast(
-                    typing.List[ApiTokenResponse],
-                    parse_obj_as(
-                        type_=typing.List[ApiTokenResponse],  # type: ignore
+                    LseapiTokenCreate,
+                    construct_type(
+                        type_=LseapiTokenCreate,  # type: ignore
                         object_=_response.json(),
                     ),
                 )
@@ -121,19 +114,23 @@ class TokensClient:
             raise ApiError(status_code=_response.status_code, body=_response.text)
         raise ApiError(status_code=_response.status_code, body=_response_json)
 
-    def create(self, *, request_options: typing.Optional[RequestOptions] = None) -> ApiTokenResponse:
+    def blacklist(
+        self, *, refresh: str, request_options: typing.Optional[RequestOptions] = None
+    ) -> typing.Dict[str, typing.Optional[typing.Any]]:
         """
-        Create a new API token for the current user.
+        Adds a JWT refresh token to the blacklist, preventing it from being used to obtain new access tokens.
 
         Parameters
         ----------
+        refresh : str
+
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
         Returns
         -------
-        ApiTokenResponse
-            Token created successfully
+        typing.Dict[str, typing.Optional[typing.Any]]
+
 
         Examples
         --------
@@ -142,43 +139,61 @@ class TokensClient:
         client = LabelStudio(
             api_key="YOUR_API_KEY",
         )
-        client.tokens.create()
+        client.tokens.blacklist(
+            refresh="refresh",
+        )
         """
         _response = self._client_wrapper.httpx_client.request(
-            "api/token",
+            "api/token/blacklist/",
             method="POST",
+            json={
+                "refresh": refresh,
+            },
+            headers={
+                "content-type": "application/json",
+            },
             request_options=request_options,
+            omit=OMIT,
         )
         try:
             if 200 <= _response.status_code < 300:
                 return typing.cast(
-                    ApiTokenResponse,
-                    parse_obj_as(
-                        type_=ApiTokenResponse,  # type: ignore
+                    typing.Dict[str, typing.Optional[typing.Any]],
+                    construct_type(
+                        type_=typing.Dict[str, typing.Optional[typing.Any]],  # type: ignore
                         object_=_response.json(),
                     ),
                 )
+            if _response.status_code == 404:
+                raise NotFoundError(
+                    typing.cast(
+                        typing.Optional[typing.Any],
+                        construct_type(
+                            type_=typing.Optional[typing.Any],  # 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 refresh(self, *, refresh: str, request_options: typing.Optional[RequestOptions] = None) -> AccessTokenResponse:
+    def refresh(self, *, refresh: str, request_options: typing.Optional[RequestOptions] = None) -> TokenRefreshResponse:
         """
         Get a new access token, using a refresh token.
 
         Parameters
         ----------
         refresh : str
-            JWT refresh token
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
         Returns
         -------
-        AccessTokenResponse
-            New access token created successfully
+        TokenRefreshResponse
+
 
         Examples
         --------
@@ -192,7 +207,7 @@ class TokensClient:
         )
         """
         _response = self._client_wrapper.httpx_client.request(
-            "api/token/refresh",
+            "api/token/refresh/",
             method="POST",
             json={
                 "refresh": refresh,
@@ -206,43 +221,32 @@ class TokensClient:
         try:
             if 200 <= _response.status_code < 300:
                 return typing.cast(
-                    AccessTokenResponse,
-                    parse_obj_as(
-                        type_=AccessTokenResponse,  # type: ignore
+                    TokenRefreshResponse,
+                    construct_type(
+                        type_=TokenRefreshResponse,  # type: ignore
                         object_=_response.json(),
                     ),
                 )
-            if _response.status_code == 401:
-                raise UnauthorizedError(
-                    typing.cast(
-                        typing.Optional[typing.Any],
-                        parse_obj_as(
-                            type_=typing.Optional[typing.Any],  # 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 rotate(self, *, refresh: str, request_options: typing.Optional[RequestOptions] = None) -> RotateTokenResponse:
+    def rotate(self, *, refresh: str, request_options: typing.Optional[RequestOptions] = None) -> TokenRotateResponse:
         """
-        Blacklist existing refresh token, and get a new refresh token.
+        Creates a new JWT refresh token and blacklists the current one.
 
         Parameters
         ----------
         refresh : str
-            JWT refresh token
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
         Returns
         -------
-        RotateTokenResponse
-            Refresh token successfully rotated
+        TokenRotateResponse
+
 
         Examples
         --------
@@ -256,7 +260,7 @@ class TokensClient:
         )
         """
         _response = self._client_wrapper.httpx_client.request(
-            "api/token/rotate",
+            "api/token/rotate/",
             method="POST",
             json={
                 "refresh": refresh,
@@ -270,9 +274,9 @@ class TokensClient:
         try:
             if 200 <= _response.status_code < 300:
                 return typing.cast(
-                    RotateTokenResponse,
-                    parse_obj_as(
-                        type_=RotateTokenResponse,  # type: ignore
+                    TokenRotateResponse,
+                    construct_type(
+                        type_=TokenRotateResponse,  # type: ignore
                         object_=_response.json(),
                     ),
                 )
@@ -280,7 +284,7 @@ class TokensClient:
                 raise BadRequestError(
                     typing.cast(
                         typing.Optional[typing.Any],
-                        parse_obj_as(
+                        construct_type(
                             type_=typing.Optional[typing.Any],  # type: ignore
                             object_=_response.json(),
                         ),
@@ -296,21 +300,24 @@ class AsyncTokensClient:
     def __init__(self, *, client_wrapper: AsyncClientWrapper):
         self._client_wrapper = client_wrapper
 
-    async def blacklist(self, *, refresh: str, request_options: typing.Optional[RequestOptions] = None) -> None:
+    async def list(
+        self, *, ordering: typing.Optional[str] = None, request_options: typing.Optional[RequestOptions] = None
+    ) -> typing.List[LseapiTokenList]:
         """
-        Blacklist a refresh token to prevent its future use.
+        List all API tokens for the current user.
 
         Parameters
         ----------
-        refresh : str
-            JWT refresh token
+        ordering : typing.Optional[str]
+            Which field to use when ordering the results.
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
         Returns
         -------
-        None
+        typing.List[LseapiTokenList]
+
 
         Examples
         --------
@@ -324,46 +331,36 @@ class AsyncTokensClient:
 
 
         async def main() -> None:
-            await client.tokens.blacklist(
-                refresh="refresh",
-            )
+            await client.tokens.list()
 
 
         asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
-            "api/token/blacklist",
-            method="POST",
-            json={
-                "refresh": refresh,
-            },
-            headers={
-                "content-type": "application/json",
+            "api/token/",
+            method="GET",
+            params={
+                "ordering": ordering,
             },
             request_options=request_options,
-            omit=OMIT,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return
-            if _response.status_code == 404:
-                raise NotFoundError(
-                    typing.cast(
-                        typing.Optional[typing.Any],
-                        parse_obj_as(
-                            type_=typing.Optional[typing.Any],  # type: ignore
-                            object_=_response.json(),
-                        ),
-                    )
+                return typing.cast(
+                    typing.List[LseapiTokenList],
+                    construct_type(
+                        type_=typing.List[LseapiTokenList],  # 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, *, request_options: typing.Optional[RequestOptions] = None) -> typing.List[ApiTokenResponse]:
+    async def create(self, *, request_options: typing.Optional[RequestOptions] = None) -> LseapiTokenCreate:
         """
-        List all API tokens for the current user.
+        Create a new API token for the current user.
 
         Parameters
         ----------
@@ -372,8 +369,8 @@ class AsyncTokensClient:
 
         Returns
         -------
-        typing.List[ApiTokenResponse]
-            List of API tokens retrieved successfully
+        LseapiTokenCreate
+
 
         Examples
         --------
@@ -387,22 +384,22 @@ class AsyncTokensClient:
 
 
         async def main() -> None:
-            await client.tokens.get()
+            await client.tokens.create()
 
 
         asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
-            "api/token",
-            method="GET",
+            "api/token/",
+            method="POST",
             request_options=request_options,
         )
         try:
             if 200 <= _response.status_code < 300:
                 return typing.cast(
-                    typing.List[ApiTokenResponse],
-                    parse_obj_as(
-                        type_=typing.List[ApiTokenResponse],  # type: ignore
+                    LseapiTokenCreate,
+                    construct_type(
+                        type_=LseapiTokenCreate,  # type: ignore
                         object_=_response.json(),
                     ),
                 )
@@ -411,19 +408,23 @@ class AsyncTokensClient:
             raise ApiError(status_code=_response.status_code, body=_response.text)
         raise ApiError(status_code=_response.status_code, body=_response_json)
 
-    async def create(self, *, request_options: typing.Optional[RequestOptions] = None) -> ApiTokenResponse:
+    async def blacklist(
+        self, *, refresh: str, request_options: typing.Optional[RequestOptions] = None
+    ) -> typing.Dict[str, typing.Optional[typing.Any]]:
         """
-        Create a new API token for the current user.
+        Adds a JWT refresh token to the blacklist, preventing it from being used to obtain new access tokens.
 
         Parameters
         ----------
+        refresh : str
+
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
         Returns
         -------
-        ApiTokenResponse
-            Token created successfully
+        typing.Dict[str, typing.Optional[typing.Any]]
+
 
         Examples
         --------
@@ -437,25 +438,44 @@ class AsyncTokensClient:
 
 
         async def main() -> None:
-            await client.tokens.create()
+            await client.tokens.blacklist(
+                refresh="refresh",
+            )
 
 
         asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
-            "api/token",
+            "api/token/blacklist/",
             method="POST",
+            json={
+                "refresh": refresh,
+            },
+            headers={
+                "content-type": "application/json",
+            },
             request_options=request_options,
+            omit=OMIT,
         )
         try:
             if 200 <= _response.status_code < 300:
                 return typing.cast(
-                    ApiTokenResponse,
-                    parse_obj_as(
-                        type_=ApiTokenResponse,  # type: ignore
+                    typing.Dict[str, typing.Optional[typing.Any]],
+                    construct_type(
+                        type_=typing.Dict[str, typing.Optional[typing.Any]],  # type: ignore
                         object_=_response.json(),
                     ),
                 )
+            if _response.status_code == 404:
+                raise NotFoundError(
+                    typing.cast(
+                        typing.Optional[typing.Any],
+                        construct_type(
+                            type_=typing.Optional[typing.Any],  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    )
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -463,22 +483,21 @@ class AsyncTokensClient:
 
     async def refresh(
         self, *, refresh: str, request_options: typing.Optional[RequestOptions] = None
-    ) -> AccessTokenResponse:
+    ) -> TokenRefreshResponse:
         """
         Get a new access token, using a refresh token.
 
         Parameters
         ----------
         refresh : str
-            JWT refresh token
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
         Returns
         -------
-        AccessTokenResponse
-            New access token created successfully
+        TokenRefreshResponse
+
 
         Examples
         --------
@@ -500,7 +519,7 @@ class AsyncTokensClient:
         asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
-            "api/token/refresh",
+            "api/token/refresh/",
             method="POST",
             json={
                 "refresh": refresh,
@@ -514,22 +533,12 @@ class AsyncTokensClient:
         try:
             if 200 <= _response.status_code < 300:
                 return typing.cast(
-                    AccessTokenResponse,
-                    parse_obj_as(
-                        type_=AccessTokenResponse,  # type: ignore
+                    TokenRefreshResponse,
+                    construct_type(
+                        type_=TokenRefreshResponse,  # type: ignore
                         object_=_response.json(),
                     ),
                 )
-            if _response.status_code == 401:
-                raise UnauthorizedError(
-                    typing.cast(
-                        typing.Optional[typing.Any],
-                        parse_obj_as(
-                            type_=typing.Optional[typing.Any],  # type: ignore
-                            object_=_response.json(),
-                        ),
-                    )
-                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -537,22 +546,21 @@ class AsyncTokensClient:
 
     async def rotate(
         self, *, refresh: str, request_options: typing.Optional[RequestOptions] = None
-    ) -> RotateTokenResponse:
+    ) -> TokenRotateResponse:
         """
-        Blacklist existing refresh token, and get a new refresh token.
+        Creates a new JWT refresh token and blacklists the current one.
 
         Parameters
         ----------
         refresh : str
-            JWT refresh token
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
         Returns
         -------
-        RotateTokenResponse
-            Refresh token successfully rotated
+        TokenRotateResponse
+
 
         Examples
         --------
@@ -574,7 +582,7 @@ class AsyncTokensClient:
         asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
-            "api/token/rotate",
+            "api/token/rotate/",
             method="POST",
             json={
                 "refresh": refresh,
@@ -588,9 +596,9 @@ class AsyncTokensClient:
         try:
             if 200 <= _response.status_code < 300:
                 return typing.cast(
-                    RotateTokenResponse,
-                    parse_obj_as(
-                        type_=RotateTokenResponse,  # type: ignore
+                    TokenRotateResponse,
+                    construct_type(
+                        type_=TokenRotateResponse,  # type: ignore
                         object_=_response.json(),
                     ),
                 )
@@ -598,7 +606,7 @@ class AsyncTokensClient:
                 raise BadRequestError(
                     typing.cast(
                         typing.Optional[typing.Any],
-                        parse_obj_as(
+                        construct_type(
                             type_=typing.Optional[typing.Any],  # type: ignore
                             object_=_response.json(),
                         ),