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

label_studio_sdk/users/client.py

@@ -1,16 +1,16 @@
 # 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.users_reset_token_response import UsersResetTokenResponse
+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, SyncClientWrapper
-from ..core.jsonable_encoder import jsonable_encoder
-from ..core.pydantic_utilities import pydantic_v1
-from ..core.request_options import RequestOptions
-from ..types.base_user import BaseUser
 from .types.users_get_token_response import UsersGetTokenResponse
-from .types.users_reset_token_response import UsersResetTokenResponse
+from ..types.base_user import BaseUser
+from ..core.jsonable_encoder import jsonable_encoder
+from ..core.client_wrapper import AsyncClientWrapper
 
 # this is used as the default value for optional parameters
 OMIT = typing.cast(typing.Any, ...)
@@ -36,7 +36,7 @@ class UsersClient:
 
         Examples
         --------
-        from label_studio_sdk.client import LabelStudio
+        from label_studio_sdk import LabelStudio
 
         client = LabelStudio(
             api_key="YOUR_API_KEY",
@@ -44,11 +44,19 @@ class UsersClient:
         client.users.reset_token()
         """
         _response = self._client_wrapper.httpx_client.request(
-            "api/current-user/reset-token/", method="POST", request_options=request_options
+            "api/current-user/reset-token/",
+            method="POST",
+            request_options=request_options,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(UsersResetTokenResponse, _response.json())  # type: ignore
+                return typing.cast(
+                    UsersResetTokenResponse,
+                    parse_obj_as(
+                        type_=UsersResetTokenResponse,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -70,7 +78,7 @@ class UsersClient:
 
         Examples
         --------
-        from label_studio_sdk.client import LabelStudio
+        from label_studio_sdk import LabelStudio
 
         client = LabelStudio(
             api_key="YOUR_API_KEY",
@@ -78,11 +86,19 @@ class UsersClient:
         client.users.get_token()
         """
         _response = self._client_wrapper.httpx_client.request(
-            "api/current-user/token", method="GET", request_options=request_options
+            "api/current-user/token",
+            method="GET",
+            request_options=request_options,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(UsersGetTokenResponse, _response.json())  # type: ignore
+                return typing.cast(
+                    UsersGetTokenResponse,
+                    parse_obj_as(
+                        type_=UsersGetTokenResponse,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -104,7 +120,7 @@ class UsersClient:
 
         Examples
         --------
-        from label_studio_sdk.client import LabelStudio
+        from label_studio_sdk import LabelStudio
 
         client = LabelStudio(
             api_key="YOUR_API_KEY",
@@ -112,11 +128,19 @@ class UsersClient:
         client.users.whoami()
         """
         _response = self._client_wrapper.httpx_client.request(
-            "api/current-user/whoami", method="GET", request_options=request_options
+            "api/current-user/whoami",
+            method="GET",
+            request_options=request_options,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(BaseUser, _response.json())  # type: ignore
+                return typing.cast(
+                    BaseUser,
+                    parse_obj_as(
+                        type_=BaseUser,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -124,6 +148,7 @@ class UsersClient:
 
     def list(self, *, request_options: typing.Optional[RequestOptions] = None) -> typing.List[BaseUser]:
         """
+
         List all users in your Label Studio organization.
 
         Parameters
@@ -138,7 +163,7 @@ class UsersClient:
 
         Examples
         --------
-        from label_studio_sdk.client import LabelStudio
+        from label_studio_sdk import LabelStudio
 
         client = LabelStudio(
             api_key="YOUR_API_KEY",
@@ -146,11 +171,19 @@ class UsersClient:
         client.users.list()
         """
         _response = self._client_wrapper.httpx_client.request(
-            "api/users/", method="GET", request_options=request_options
+            "api/users/",
+            method="GET",
+            request_options=request_options,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(typing.List[BaseUser], _response.json())  # type: ignore
+                return typing.cast(
+                    typing.List[BaseUser],
+                    parse_obj_as(
+                        type_=typing.List[BaseUser],  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -171,6 +204,7 @@ class UsersClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> BaseUser:
         """
+
         Create a user in Label Studio.
 
         Parameters
@@ -212,7 +246,7 @@ class UsersClient:
 
         Examples
         --------
-        from label_studio_sdk.client import LabelStudio
+        from label_studio_sdk import LabelStudio
 
         client = LabelStudio(
             api_key="YOUR_API_KEY",
@@ -233,12 +267,21 @@ class UsersClient:
                 "phone": phone,
                 "allow_newsletters": allow_newsletters,
             },
+            headers={
+                "content-type": "application/json",
+            },
             request_options=request_options,
             omit=OMIT,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(BaseUser, _response.json())  # type: ignore
+                return typing.cast(
+                    BaseUser,
+                    parse_obj_as(
+                        type_=BaseUser,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -246,6 +289,7 @@ class UsersClient:
 
     def get(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> BaseUser:
         """
+
         Get info about a specific Label Studio user.
         You will need to provide their user ID. You can find a list of all user IDs using [List users](list).
 
@@ -264,7 +308,7 @@ class UsersClient:
 
         Examples
         --------
-        from label_studio_sdk.client import LabelStudio
+        from label_studio_sdk import LabelStudio
 
         client = LabelStudio(
             api_key="YOUR_API_KEY",
@@ -274,11 +318,19 @@ class UsersClient:
         )
         """
         _response = self._client_wrapper.httpx_client.request(
-            f"api/users/{jsonable_encoder(id)}/", method="GET", request_options=request_options
+            f"api/users/{jsonable_encoder(id)}/",
+            method="GET",
+            request_options=request_options,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(BaseUser, _response.json())  # type: ignore
+                return typing.cast(
+                    BaseUser,
+                    parse_obj_as(
+                        type_=BaseUser,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -286,6 +338,7 @@ class UsersClient:
 
     def delete(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> None:
         """
+
         Delete a specific Label Studio user.
 
         You will need to provide their user ID. You can find a list of all user IDs using [List users](list).
@@ -306,7 +359,7 @@ class UsersClient:
 
         Examples
         --------
-        from label_studio_sdk.client import LabelStudio
+        from label_studio_sdk import LabelStudio
 
         client = LabelStudio(
             api_key="YOUR_API_KEY",
@@ -316,7 +369,9 @@ class UsersClient:
         )
         """
         _response = self._client_wrapper.httpx_client.request(
-            f"api/users/{jsonable_encoder(id)}/", method="DELETE", request_options=request_options
+            f"api/users/{jsonable_encoder(id)}/",
+            method="DELETE",
+            request_options=request_options,
         )
         try:
             if 200 <= _response.status_code < 300:
@@ -342,6 +397,7 @@ class UsersClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> BaseUser:
         """
+
         Update details for a specific Label Studio user, such as their name or contact information.
 
         You will need to provide their user ID. You can find a list of all user IDs using [List users](list).
@@ -388,7 +444,7 @@ class UsersClient:
 
         Examples
         --------
-        from label_studio_sdk.client import LabelStudio
+        from label_studio_sdk import LabelStudio
 
         client = LabelStudio(
             api_key="YOUR_API_KEY",
@@ -411,12 +467,21 @@ class UsersClient:
                 "phone": phone,
                 "allow_newsletters": allow_newsletters,
             },
+            headers={
+                "content-type": "application/json",
+            },
             request_options=request_options,
             omit=OMIT,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(BaseUser, _response.json())  # type: ignore
+                return typing.cast(
+                    BaseUser,
+                    parse_obj_as(
+                        type_=BaseUser,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -443,19 +508,35 @@ class AsyncUsersClient:
 
         Examples
         --------
-        from label_studio_sdk.client import AsyncLabelStudio
+        import asyncio
+
+        from label_studio_sdk import AsyncLabelStudio
 
         client = AsyncLabelStudio(
             api_key="YOUR_API_KEY",
         )
-        await client.users.reset_token()
+
+
+        async def main() -> None:
+            await client.users.reset_token()
+
+
+        asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
-            "api/current-user/reset-token/", method="POST", request_options=request_options
+            "api/current-user/reset-token/",
+            method="POST",
+            request_options=request_options,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(UsersResetTokenResponse, _response.json())  # type: ignore
+                return typing.cast(
+                    UsersResetTokenResponse,
+                    parse_obj_as(
+                        type_=UsersResetTokenResponse,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -477,19 +558,35 @@ class AsyncUsersClient:
 
         Examples
         --------
-        from label_studio_sdk.client import AsyncLabelStudio
+        import asyncio
+
+        from label_studio_sdk import AsyncLabelStudio
 
         client = AsyncLabelStudio(
             api_key="YOUR_API_KEY",
         )
-        await client.users.get_token()
+
+
+        async def main() -> None:
+            await client.users.get_token()
+
+
+        asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
-            "api/current-user/token", method="GET", request_options=request_options
+            "api/current-user/token",
+            method="GET",
+            request_options=request_options,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(UsersGetTokenResponse, _response.json())  # type: ignore
+                return typing.cast(
+                    UsersGetTokenResponse,
+                    parse_obj_as(
+                        type_=UsersGetTokenResponse,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -511,19 +608,35 @@ class AsyncUsersClient:
 
         Examples
         --------
-        from label_studio_sdk.client import AsyncLabelStudio
+        import asyncio
+
+        from label_studio_sdk import AsyncLabelStudio
 
         client = AsyncLabelStudio(
             api_key="YOUR_API_KEY",
         )
-        await client.users.whoami()
+
+
+        async def main() -> None:
+            await client.users.whoami()
+
+
+        asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
-            "api/current-user/whoami", method="GET", request_options=request_options
+            "api/current-user/whoami",
+            method="GET",
+            request_options=request_options,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(BaseUser, _response.json())  # type: ignore
+                return typing.cast(
+                    BaseUser,
+                    parse_obj_as(
+                        type_=BaseUser,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -531,6 +644,7 @@ class AsyncUsersClient:
 
     async def list(self, *, request_options: typing.Optional[RequestOptions] = None) -> typing.List[BaseUser]:
         """
+
         List all users in your Label Studio organization.
 
         Parameters
@@ -545,19 +659,35 @@ class AsyncUsersClient:
 
         Examples
         --------
-        from label_studio_sdk.client import AsyncLabelStudio
+        import asyncio
+
+        from label_studio_sdk import AsyncLabelStudio
 
         client = AsyncLabelStudio(
             api_key="YOUR_API_KEY",
         )
-        await client.users.list()
+
+
+        async def main() -> None:
+            await client.users.list()
+
+
+        asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
-            "api/users/", method="GET", request_options=request_options
+            "api/users/",
+            method="GET",
+            request_options=request_options,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(typing.List[BaseUser], _response.json())  # type: ignore
+                return typing.cast(
+                    typing.List[BaseUser],
+                    parse_obj_as(
+                        type_=typing.List[BaseUser],  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -578,6 +708,7 @@ class AsyncUsersClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> BaseUser:
         """
+
         Create a user in Label Studio.
 
         Parameters
@@ -619,12 +750,20 @@ class AsyncUsersClient:
 
         Examples
         --------
-        from label_studio_sdk.client import AsyncLabelStudio
+        import asyncio
+
+        from label_studio_sdk import AsyncLabelStudio
 
         client = AsyncLabelStudio(
             api_key="YOUR_API_KEY",
         )
-        await client.users.create()
+
+
+        async def main() -> None:
+            await client.users.create()
+
+
+        asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
             "api/users/",
@@ -640,12 +779,21 @@ class AsyncUsersClient:
                 "phone": phone,
                 "allow_newsletters": allow_newsletters,
             },
+            headers={
+                "content-type": "application/json",
+            },
             request_options=request_options,
             omit=OMIT,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(BaseUser, _response.json())  # type: ignore
+                return typing.cast(
+                    BaseUser,
+                    parse_obj_as(
+                        type_=BaseUser,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -653,6 +801,7 @@ class AsyncUsersClient:
 
     async def get(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> BaseUser:
         """
+
         Get info about a specific Label Studio user.
         You will need to provide their user ID. You can find a list of all user IDs using [List users](list).
 
@@ -671,21 +820,37 @@ class AsyncUsersClient:
 
         Examples
         --------
-        from label_studio_sdk.client import AsyncLabelStudio
+        import asyncio
+
+        from label_studio_sdk import AsyncLabelStudio
 
         client = AsyncLabelStudio(
             api_key="YOUR_API_KEY",
         )
-        await client.users.get(
-            id=1,
-        )
+
+
+        async def main() -> None:
+            await client.users.get(
+                id=1,
+            )
+
+
+        asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
-            f"api/users/{jsonable_encoder(id)}/", method="GET", request_options=request_options
+            f"api/users/{jsonable_encoder(id)}/",
+            method="GET",
+            request_options=request_options,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(BaseUser, _response.json())  # type: ignore
+                return typing.cast(
+                    BaseUser,
+                    parse_obj_as(
+                        type_=BaseUser,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -693,6 +858,7 @@ class AsyncUsersClient:
 
     async def delete(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> None:
         """
+
         Delete a specific Label Studio user.
 
         You will need to provide their user ID. You can find a list of all user IDs using [List users](list).
@@ -713,17 +879,27 @@ class AsyncUsersClient:
 
         Examples
         --------
-        from label_studio_sdk.client import AsyncLabelStudio
+        import asyncio
+
+        from label_studio_sdk import AsyncLabelStudio
 
         client = AsyncLabelStudio(
             api_key="YOUR_API_KEY",
         )
-        await client.users.delete(
-            id=1,
-        )
+
+
+        async def main() -> None:
+            await client.users.delete(
+                id=1,
+            )
+
+
+        asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
-            f"api/users/{jsonable_encoder(id)}/", method="DELETE", request_options=request_options
+            f"api/users/{jsonable_encoder(id)}/",
+            method="DELETE",
+            request_options=request_options,
         )
         try:
             if 200 <= _response.status_code < 300:
@@ -749,6 +925,7 @@ class AsyncUsersClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> BaseUser:
         """
+
         Update details for a specific Label Studio user, such as their name or contact information.
 
         You will need to provide their user ID. You can find a list of all user IDs using [List users](list).
@@ -795,14 +972,22 @@ class AsyncUsersClient:
 
         Examples
         --------
-        from label_studio_sdk.client import AsyncLabelStudio
+        import asyncio
+
+        from label_studio_sdk import AsyncLabelStudio
 
         client = AsyncLabelStudio(
             api_key="YOUR_API_KEY",
         )
-        await client.users.update(
-            id=1,
-        )
+
+
+        async def main() -> None:
+            await client.users.update(
+                id=1,
+            )
+
+
+        asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
             f"api/users/{jsonable_encoder(id)}/",
@@ -818,12 +1003,21 @@ class AsyncUsersClient:
                 "phone": phone,
                 "allow_newsletters": allow_newsletters,
             },
+            headers={
+                "content-type": "application/json",
+            },
             request_options=request_options,
             omit=OMIT,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(BaseUser, _response.json())  # type: ignore
+                return typing.cast(
+                    BaseUser,
+                    parse_obj_as(
+                        type_=BaseUser,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)