# This file was auto-generated by Fern from our API Definition. import typing from json.decoder import JSONDecodeError from ...core.api_error import ApiError from ...core.client_wrapper import AsyncClientWrapper, SyncClientWrapper from ...core.http_response import AsyncHttpResponse, HttpResponse from ...core.jsonable_encoder import jsonable_encoder from ...core.request_options import RequestOptions from ...core.unchecked_base_model import construct_type from ...types.pause import Pause from ...types.reason_enum import ReasonEnum # this is used as the default value for optional parameters OMIT = typing.cast(typing.Any, ...) class RawPausesClient: 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, ordering: typing.Optional[str] = None, request_options: typing.Optional[RequestOptions] = None, ) -> HttpResponse[typing.List[Pause]]: """ Label Studio Enterprise badge

This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)

Retrieve a list of all pauses. Parameters ---------- project_pk : int user_pk : int include_deleted : typing.Optional[bool] Include deleted pauses. ordering : typing.Optional[str] Which field to use when ordering the results. request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- HttpResponse[typing.List[Pause]] """ _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, "ordering": ordering, }, request_options=request_options, ) try: if 200 <= _response.status_code < 300: _data = typing.cast( typing.List[Pause], construct_type( type_=typing.List[Pause], # type: ignore object_=_response.json(), ), ) return HttpResponse(response=_response, data=_data) _response_json = _response.json() except JSONDecodeError: raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) def create( self, project_pk: int, user_pk: int, *, reason: ReasonEnum, verbose_reason: typing.Optional[str] = OMIT, request_options: typing.Optional[RequestOptions] = None, ) -> HttpResponse[Pause]: """ Label Studio Enterprise badge

This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)

Create a new pause entry. Parameters ---------- project_pk : int user_pk : int reason : ReasonEnum Reason for pausing * `MANUAL` - Manual * `BEHAVIOR_BASED` - Behavior-based * `ANNOTATOR_EVALUATION` - Annotator evaluation * `ANNOTATION_LIMIT` - Annotation limit * `CUSTOM_SCRIPT` - Custom script verbose_reason : typing.Optional[str] Detailed description of why the project is paused, will be readable by paused annotators request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- HttpResponse[Pause] """ _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: _data = typing.cast( Pause, construct_type( type_=Pause, # type: ignore object_=_response.json(), ), ) return HttpResponse(response=_response, data=_data) _response_json = _response.json() except JSONDecodeError: raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) def get( self, project_pk: int, user_pk: int, id: str, *, request_options: typing.Optional[RequestOptions] = None ) -> HttpResponse[Pause]: """ Label Studio Enterprise badge

This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)

Retrieve a specific pause by ID. Parameters ---------- project_pk : int user_pk : int id : str request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- HttpResponse[Pause] """ _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: _data = typing.cast( Pause, construct_type( type_=Pause, # type: ignore object_=_response.json(), ), ) return HttpResponse(response=_response, data=_data) _response_json = _response.json() except JSONDecodeError: raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) def delete( self, project_pk: int, user_pk: int, id: str, *, request_options: typing.Optional[RequestOptions] = None ) -> HttpResponse[None]: """ Label Studio Enterprise badge

This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)

Delete a specific pause by ID. Parameters ---------- project_pk : int user_pk : int id : str request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- HttpResponse[None] """ _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 HttpResponse(response=_response, data=None) _response_json = _response.json() except JSONDecodeError: raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) def update( self, project_pk: int, user_pk: int, id: str, *, reason: typing.Optional[ReasonEnum] = OMIT, verbose_reason: typing.Optional[str] = OMIT, request_options: typing.Optional[RequestOptions] = None, ) -> HttpResponse[Pause]: """ Label Studio Enterprise badge

This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)

Partially update a pause entry by ID. Parameters ---------- project_pk : int user_pk : int id : str reason : typing.Optional[ReasonEnum] Reason for pausing * `MANUAL` - Manual * `BEHAVIOR_BASED` - Behavior-based * `ANNOTATOR_EVALUATION` - Annotator evaluation * `ANNOTATION_LIMIT` - Annotation limit * `CUSTOM_SCRIPT` - Custom script verbose_reason : typing.Optional[str] Detailed description of why the project is paused, will be readable by paused annotators request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- HttpResponse[Pause] """ _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: _data = typing.cast( Pause, construct_type( type_=Pause, # type: ignore object_=_response.json(), ), ) return HttpResponse(response=_response, data=_data) _response_json = _response.json() except JSONDecodeError: raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) class AsyncRawPausesClient: 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, ordering: typing.Optional[str] = None, request_options: typing.Optional[RequestOptions] = None, ) -> AsyncHttpResponse[typing.List[Pause]]: """ Label Studio Enterprise badge

This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)

Retrieve a list of all pauses. Parameters ---------- project_pk : int user_pk : int include_deleted : typing.Optional[bool] Include deleted pauses. ordering : typing.Optional[str] Which field to use when ordering the results. request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- AsyncHttpResponse[typing.List[Pause]] """ _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, "ordering": ordering, }, request_options=request_options, ) try: if 200 <= _response.status_code < 300: _data = typing.cast( typing.List[Pause], construct_type( type_=typing.List[Pause], # type: ignore object_=_response.json(), ), ) return AsyncHttpResponse(response=_response, data=_data) _response_json = _response.json() except JSONDecodeError: raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) async def create( self, project_pk: int, user_pk: int, *, reason: ReasonEnum, verbose_reason: typing.Optional[str] = OMIT, request_options: typing.Optional[RequestOptions] = None, ) -> AsyncHttpResponse[Pause]: """ Label Studio Enterprise badge

This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)

Create a new pause entry. Parameters ---------- project_pk : int user_pk : int reason : ReasonEnum Reason for pausing * `MANUAL` - Manual * `BEHAVIOR_BASED` - Behavior-based * `ANNOTATOR_EVALUATION` - Annotator evaluation * `ANNOTATION_LIMIT` - Annotation limit * `CUSTOM_SCRIPT` - Custom script verbose_reason : typing.Optional[str] Detailed description of why the project is paused, will be readable by paused annotators request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- AsyncHttpResponse[Pause] """ _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: _data = typing.cast( Pause, construct_type( type_=Pause, # type: ignore object_=_response.json(), ), ) return AsyncHttpResponse(response=_response, data=_data) _response_json = _response.json() except JSONDecodeError: raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) async def get( self, project_pk: int, user_pk: int, id: str, *, request_options: typing.Optional[RequestOptions] = None ) -> AsyncHttpResponse[Pause]: """ Label Studio Enterprise badge

This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)

Retrieve a specific pause by ID. Parameters ---------- project_pk : int user_pk : int id : str request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- AsyncHttpResponse[Pause] """ _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: _data = typing.cast( Pause, construct_type( type_=Pause, # type: ignore object_=_response.json(), ), ) return AsyncHttpResponse(response=_response, data=_data) _response_json = _response.json() except JSONDecodeError: raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) async def delete( self, project_pk: int, user_pk: int, id: str, *, request_options: typing.Optional[RequestOptions] = None ) -> AsyncHttpResponse[None]: """ Label Studio Enterprise badge

This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)

Delete a specific pause by ID. Parameters ---------- project_pk : int user_pk : int id : str request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- AsyncHttpResponse[None] """ _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 AsyncHttpResponse(response=_response, data=None) _response_json = _response.json() except JSONDecodeError: raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) async def update( self, project_pk: int, user_pk: int, id: str, *, reason: typing.Optional[ReasonEnum] = OMIT, verbose_reason: typing.Optional[str] = OMIT, request_options: typing.Optional[RequestOptions] = None, ) -> AsyncHttpResponse[Pause]: """ Label Studio Enterprise badge

This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)

Partially update a pause entry by ID. Parameters ---------- project_pk : int user_pk : int id : str reason : typing.Optional[ReasonEnum] Reason for pausing * `MANUAL` - Manual * `BEHAVIOR_BASED` - Behavior-based * `ANNOTATOR_EVALUATION` - Annotator evaluation * `ANNOTATION_LIMIT` - Annotation limit * `CUSTOM_SCRIPT` - Custom script verbose_reason : typing.Optional[str] Detailed description of why the project is paused, will be readable by paused annotators request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- AsyncHttpResponse[Pause] """ _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: _data = typing.cast( Pause, construct_type( type_=Pause, # type: ignore object_=_response.json(), ), ) return AsyncHttpResponse(response=_response, data=_data) _response_json = _response.json() except JSONDecodeError: raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)