# 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.project_role import ProjectRole
from ...types.role9e7enum import Role9E7Enum
# this is used as the default value for optional parameters
OMIT = typing.cast(typing.Any, ...)
class RawRolesClient:
def __init__(self, *, client_wrapper: SyncClientWrapper):
self._client_wrapper = client_wrapper
def list(
self,
*,
ids: typing.Optional[int] = None,
ordering: typing.Optional[str] = None,
request_options: typing.Optional[RequestOptions] = None,
) -> HttpResponse[typing.List[ProjectRole]]:
"""
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
List project roles for requested IDs for the current user
Parameters
----------
ids : typing.Optional[int]
ordering : typing.Optional[str]
Which field to use when ordering the results.
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
HttpResponse[typing.List[ProjectRole]]
"""
_response = self._client_wrapper.httpx_client.request(
"api/projects/roles/",
method="GET",
params={
"ids": ids,
"ordering": ordering,
},
request_options=request_options,
)
try:
if 200 <= _response.status_code < 300:
_data = typing.cast(
typing.List[ProjectRole],
construct_type(
type_=typing.List[ProjectRole], # 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 add(
self, *, project: int, role: Role9E7Enum, user: int, request_options: typing.Optional[RequestOptions] = None
) -> HttpResponse[ProjectRole]:
"""
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Create project role for user allowing the user the same access level provided by organization role.
Parameters
----------
project : int
role : Role9E7Enum
user : int
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
HttpResponse[ProjectRole]
Role created
"""
_response = self._client_wrapper.httpx_client.request(
"api/projects/roles/",
method="POST",
json={
"project": project,
"role": role,
"user": user,
},
headers={
"content-type": "application/json",
},
request_options=request_options,
omit=OMIT,
)
try:
if 200 <= _response.status_code < 300:
_data = typing.cast(
ProjectRole,
construct_type(
type_=ProjectRole, # 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 remove(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> HttpResponse[None]:
"""
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Remove project role for user allowing the user the same access level provided by organization role.
Parameters
----------
id : int
A unique integer value identifying this project role.
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
HttpResponse[None]
"""
_response = self._client_wrapper.httpx_client.request(
f"api/projects/roles/{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 get(
self, id: int, *, request_options: typing.Optional[RequestOptions] = None
) -> HttpResponse[typing.List[ProjectRole]]:
"""
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
List users and their project level roles for a given project.
If user is not listed here and is a member of the project then they would behave as assigned role in organization.
Parameters
----------
id : int
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
HttpResponse[typing.List[ProjectRole]]
"""
_response = self._client_wrapper.httpx_client.request(
f"api/projects/{jsonable_encoder(id)}/roles",
method="GET",
request_options=request_options,
)
try:
if 200 <= _response.status_code < 300:
_data = typing.cast(
typing.List[ProjectRole],
construct_type(
type_=typing.List[ProjectRole], # 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 AsyncRawRolesClient:
def __init__(self, *, client_wrapper: AsyncClientWrapper):
self._client_wrapper = client_wrapper
async def list(
self,
*,
ids: typing.Optional[int] = None,
ordering: typing.Optional[str] = None,
request_options: typing.Optional[RequestOptions] = None,
) -> AsyncHttpResponse[typing.List[ProjectRole]]:
"""
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
List project roles for requested IDs for the current user
Parameters
----------
ids : typing.Optional[int]
ordering : typing.Optional[str]
Which field to use when ordering the results.
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
AsyncHttpResponse[typing.List[ProjectRole]]
"""
_response = await self._client_wrapper.httpx_client.request(
"api/projects/roles/",
method="GET",
params={
"ids": ids,
"ordering": ordering,
},
request_options=request_options,
)
try:
if 200 <= _response.status_code < 300:
_data = typing.cast(
typing.List[ProjectRole],
construct_type(
type_=typing.List[ProjectRole], # 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 add(
self, *, project: int, role: Role9E7Enum, user: int, request_options: typing.Optional[RequestOptions] = None
) -> AsyncHttpResponse[ProjectRole]:
"""
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Create project role for user allowing the user the same access level provided by organization role.
Parameters
----------
project : int
role : Role9E7Enum
user : int
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
AsyncHttpResponse[ProjectRole]
Role created
"""
_response = await self._client_wrapper.httpx_client.request(
"api/projects/roles/",
method="POST",
json={
"project": project,
"role": role,
"user": user,
},
headers={
"content-type": "application/json",
},
request_options=request_options,
omit=OMIT,
)
try:
if 200 <= _response.status_code < 300:
_data = typing.cast(
ProjectRole,
construct_type(
type_=ProjectRole, # 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 remove(
self, id: int, *, request_options: typing.Optional[RequestOptions] = None
) -> AsyncHttpResponse[None]:
"""
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Remove project role for user allowing the user the same access level provided by organization role.
Parameters
----------
id : int
A unique integer value identifying this project role.
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
AsyncHttpResponse[None]
"""
_response = await self._client_wrapper.httpx_client.request(
f"api/projects/roles/{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 get(
self, id: int, *, request_options: typing.Optional[RequestOptions] = None
) -> AsyncHttpResponse[typing.List[ProjectRole]]:
"""
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
List users and their project level roles for a given project.
If user is not listed here and is a member of the project then they would behave as assigned role in organization.
Parameters
----------
id : int
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
AsyncHttpResponse[typing.List[ProjectRole]]
"""
_response = await self._client_wrapper.httpx_client.request(
f"api/projects/{jsonable_encoder(id)}/roles",
method="GET",
request_options=request_options,
)
try:
if 200 <= _response.status_code < 300:
_data = typing.cast(
typing.List[ProjectRole],
construct_type(
type_=typing.List[ProjectRole], # 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)