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

label_studio_sdk/comments/client.py

@@ -1,14 +1,14 @@
 # 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.comment import Comment
+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.comment import Comment
+from ..core.client_wrapper import AsyncClientWrapper
 
 # this is used as the default value for optional parameters
 OMIT = typing.cast(typing.Any, ...)
@@ -27,6 +27,7 @@ class CommentsClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> typing.List[Comment]:
         """
+
         Get a list of comments for a specific project.
 
         Parameters
@@ -50,7 +51,7 @@ class CommentsClient:
 
         Examples
         --------
-        from label_studio_sdk.client import LabelStudio
+        from label_studio_sdk import LabelStudio
 
         client = LabelStudio(
             api_key="YOUR_API_KEY",
@@ -60,12 +61,22 @@ class CommentsClient:
         _response = self._client_wrapper.httpx_client.request(
             "api/comments/",
             method="GET",
-            params={"project": project, "expand_created_by": expand_created_by, "annotation": annotation},
+            params={
+                "project": project,
+                "expand_created_by": expand_created_by,
+                "annotation": annotation,
+            },
             request_options=request_options,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(typing.List[Comment], _response.json())  # type: ignore
+                return typing.cast(
+                    typing.List[Comment],
+                    parse_obj_as(
+                        type_=typing.List[Comment],  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -81,6 +92,7 @@ class CommentsClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> Comment:
         """
+
         Create a new comment.
 
         Parameters
@@ -103,7 +115,7 @@ class CommentsClient:
 
         Examples
         --------
-        from label_studio_sdk.client import LabelStudio
+        from label_studio_sdk import LabelStudio
 
         client = LabelStudio(
             api_key="YOUR_API_KEY",
@@ -113,13 +125,27 @@ class CommentsClient:
         _response = self._client_wrapper.httpx_client.request(
             "api/comments/",
             method="POST",
-            json={"annotation": annotation, "project": project, "text": text, "is_resolved": is_resolved},
+            json={
+                "annotation": annotation,
+                "project": project,
+                "text": text,
+                "is_resolved": is_resolved,
+            },
+            headers={
+                "content-type": "application/json",
+            },
             request_options=request_options,
             omit=OMIT,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(Comment, _response.json())  # type: ignore
+                return typing.cast(
+                    Comment,
+                    parse_obj_as(
+                        type_=Comment,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -127,6 +153,7 @@ class CommentsClient:
 
     def get(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> Comment:
         """
+
         Get a specific comment.
 
         Parameters
@@ -144,7 +171,7 @@ class CommentsClient:
 
         Examples
         --------
-        from label_studio_sdk.client import LabelStudio
+        from label_studio_sdk import LabelStudio
 
         client = LabelStudio(
             api_key="YOUR_API_KEY",
@@ -154,11 +181,19 @@ class CommentsClient:
         )
         """
         _response = self._client_wrapper.httpx_client.request(
-            f"api/comments/{jsonable_encoder(id)}", method="GET", request_options=request_options
+            f"api/comments/{jsonable_encoder(id)}",
+            method="GET",
+            request_options=request_options,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(Comment, _response.json())  # type: ignore
+                return typing.cast(
+                    Comment,
+                    parse_obj_as(
+                        type_=Comment,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -166,6 +201,7 @@ class CommentsClient:
 
     def delete(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> None:
         """
+
         Delete a specific comment.
 
         Parameters
@@ -182,7 +218,7 @@ class CommentsClient:
 
         Examples
         --------
-        from label_studio_sdk.client import LabelStudio
+        from label_studio_sdk import LabelStudio
 
         client = LabelStudio(
             api_key="YOUR_API_KEY",
@@ -192,7 +228,9 @@ class CommentsClient:
         )
         """
         _response = self._client_wrapper.httpx_client.request(
-            f"api/comments/{jsonable_encoder(id)}", method="DELETE", request_options=request_options
+            f"api/comments/{jsonable_encoder(id)}",
+            method="DELETE",
+            request_options=request_options,
         )
         try:
             if 200 <= _response.status_code < 300:
@@ -213,6 +251,7 @@ class CommentsClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> Comment:
         """
+
         Update a specific comment.
 
         Parameters
@@ -238,7 +277,7 @@ class CommentsClient:
 
         Examples
         --------
-        from label_studio_sdk.client import LabelStudio
+        from label_studio_sdk import LabelStudio
 
         client = LabelStudio(
             api_key="YOUR_API_KEY",
@@ -250,13 +289,27 @@ class CommentsClient:
         _response = self._client_wrapper.httpx_client.request(
             f"api/comments/{jsonable_encoder(id)}",
             method="PATCH",
-            json={"annotation": annotation, "project": project, "text": text, "is_resolved": is_resolved},
+            json={
+                "annotation": annotation,
+                "project": project,
+                "text": text,
+                "is_resolved": is_resolved,
+            },
+            headers={
+                "content-type": "application/json",
+            },
             request_options=request_options,
             omit=OMIT,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(Comment, _response.json())  # type: ignore
+                return typing.cast(
+                    Comment,
+                    parse_obj_as(
+                        type_=Comment,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -276,6 +329,7 @@ class AsyncCommentsClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> typing.List[Comment]:
         """
+
         Get a list of comments for a specific project.
 
         Parameters
@@ -299,22 +353,40 @@ class AsyncCommentsClient:
 
         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.comments.list()
+
+
+        async def main() -> None:
+            await client.comments.list()
+
+
+        asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
             "api/comments/",
             method="GET",
-            params={"project": project, "expand_created_by": expand_created_by, "annotation": annotation},
+            params={
+                "project": project,
+                "expand_created_by": expand_created_by,
+                "annotation": annotation,
+            },
             request_options=request_options,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(typing.List[Comment], _response.json())  # type: ignore
+                return typing.cast(
+                    typing.List[Comment],
+                    parse_obj_as(
+                        type_=typing.List[Comment],  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -330,6 +402,7 @@ class AsyncCommentsClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> Comment:
         """
+
         Create a new comment.
 
         Parameters
@@ -352,23 +425,45 @@ class AsyncCommentsClient:
 
         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.comments.create()
+
+
+        async def main() -> None:
+            await client.comments.create()
+
+
+        asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
             "api/comments/",
             method="POST",
-            json={"annotation": annotation, "project": project, "text": text, "is_resolved": is_resolved},
+            json={
+                "annotation": annotation,
+                "project": project,
+                "text": text,
+                "is_resolved": is_resolved,
+            },
+            headers={
+                "content-type": "application/json",
+            },
             request_options=request_options,
             omit=OMIT,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(Comment, _response.json())  # type: ignore
+                return typing.cast(
+                    Comment,
+                    parse_obj_as(
+                        type_=Comment,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -376,6 +471,7 @@ class AsyncCommentsClient:
 
     async def get(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> Comment:
         """
+
         Get a specific comment.
 
         Parameters
@@ -393,21 +489,37 @@ class AsyncCommentsClient:
 
         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.comments.get(
-            id=1,
-        )
+
+
+        async def main() -> None:
+            await client.comments.get(
+                id=1,
+            )
+
+
+        asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
-            f"api/comments/{jsonable_encoder(id)}", method="GET", request_options=request_options
+            f"api/comments/{jsonable_encoder(id)}",
+            method="GET",
+            request_options=request_options,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(Comment, _response.json())  # type: ignore
+                return typing.cast(
+                    Comment,
+                    parse_obj_as(
+                        type_=Comment,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -415,6 +527,7 @@ class AsyncCommentsClient:
 
     async def delete(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> None:
         """
+
         Delete a specific comment.
 
         Parameters
@@ -431,17 +544,27 @@ class AsyncCommentsClient:
 
         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.comments.delete(
-            id=1,
-        )
+
+
+        async def main() -> None:
+            await client.comments.delete(
+                id=1,
+            )
+
+
+        asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
-            f"api/comments/{jsonable_encoder(id)}", method="DELETE", request_options=request_options
+            f"api/comments/{jsonable_encoder(id)}",
+            method="DELETE",
+            request_options=request_options,
         )
         try:
             if 200 <= _response.status_code < 300:
@@ -462,6 +585,7 @@ class AsyncCommentsClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> Comment:
         """
+
         Update a specific comment.
 
         Parameters
@@ -487,25 +611,47 @@ class AsyncCommentsClient:
 
         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.comments.update(
-            id=1,
-        )
+
+
+        async def main() -> None:
+            await client.comments.update(
+                id=1,
+            )
+
+
+        asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
             f"api/comments/{jsonable_encoder(id)}",
             method="PATCH",
-            json={"annotation": annotation, "project": project, "text": text, "is_resolved": is_resolved},
+            json={
+                "annotation": annotation,
+                "project": project,
+                "text": text,
+                "is_resolved": is_resolved,
+            },
+            headers={
+                "content-type": "application/json",
+            },
             request_options=request_options,
             omit=OMIT,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(Comment, _response.json())  # type: ignore
+                return typing.cast(
+                    Comment,
+                    parse_obj_as(
+                        type_=Comment,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)