# This file was auto-generated by Fern from our API Definition.
import typing
from ...core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
from ...core.request_options import RequestOptions
from ...types.project_role import ProjectRole
from ...types.role9e7enum import Role9E7Enum
from .raw_client import AsyncRawRolesClient, RawRolesClient
# this is used as the default value for optional parameters
OMIT = typing.cast(typing.Any, ...)
class RolesClient:
def __init__(self, *, client_wrapper: SyncClientWrapper):
self._raw_client = RawRolesClient(client_wrapper=client_wrapper)
@property
def with_raw_response(self) -> RawRolesClient:
"""
Retrieves a raw implementation of this client that returns raw responses.
Returns
-------
RawRolesClient
"""
return self._raw_client
def list(
self,
*,
ids: typing.Optional[int] = None,
ordering: typing.Optional[str] = None,
request_options: typing.Optional[RequestOptions] = None,
) -> 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
-------
typing.List[ProjectRole]
Examples
--------
from label_studio_sdk import LabelStudio
client = LabelStudio(
api_key="YOUR_API_KEY",
)
client.projects.roles.list()
"""
_response = self._raw_client.list(ids=ids, ordering=ordering, request_options=request_options)
return _response.data
def add(
self, *, project: int, role: Role9E7Enum, user: int, request_options: typing.Optional[RequestOptions] = None
) -> 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
-------
ProjectRole
Role created
Examples
--------
from label_studio_sdk import LabelStudio
client = LabelStudio(
api_key="YOUR_API_KEY",
)
client.projects.roles.add(
project=1,
role="OW",
user=1,
)
"""
_response = self._raw_client.add(project=project, role=role, user=user, request_options=request_options)
return _response.data
def remove(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> 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
-------
None
Examples
--------
from label_studio_sdk import LabelStudio
client = LabelStudio(
api_key="YOUR_API_KEY",
)
client.projects.roles.remove(
id=1,
)
"""
_response = self._raw_client.remove(id, request_options=request_options)
return _response.data
def get(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> 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
-------
typing.List[ProjectRole]
Examples
--------
from label_studio_sdk import LabelStudio
client = LabelStudio(
api_key="YOUR_API_KEY",
)
client.projects.roles.get(
id=1,
)
"""
_response = self._raw_client.get(id, request_options=request_options)
return _response.data
class AsyncRolesClient:
def __init__(self, *, client_wrapper: AsyncClientWrapper):
self._raw_client = AsyncRawRolesClient(client_wrapper=client_wrapper)
@property
def with_raw_response(self) -> AsyncRawRolesClient:
"""
Retrieves a raw implementation of this client that returns raw responses.
Returns
-------
AsyncRawRolesClient
"""
return self._raw_client
async def list(
self,
*,
ids: typing.Optional[int] = None,
ordering: typing.Optional[str] = None,
request_options: typing.Optional[RequestOptions] = None,
) -> 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
-------
typing.List[ProjectRole]
Examples
--------
import asyncio
from label_studio_sdk import AsyncLabelStudio
client = AsyncLabelStudio(
api_key="YOUR_API_KEY",
)
async def main() -> None:
await client.projects.roles.list()
asyncio.run(main())
"""
_response = await self._raw_client.list(ids=ids, ordering=ordering, request_options=request_options)
return _response.data
async def add(
self, *, project: int, role: Role9E7Enum, user: int, request_options: typing.Optional[RequestOptions] = None
) -> 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
-------
ProjectRole
Role created
Examples
--------
import asyncio
from label_studio_sdk import AsyncLabelStudio
client = AsyncLabelStudio(
api_key="YOUR_API_KEY",
)
async def main() -> None:
await client.projects.roles.add(
project=1,
role="OW",
user=1,
)
asyncio.run(main())
"""
_response = await self._raw_client.add(project=project, role=role, user=user, request_options=request_options)
return _response.data
async def remove(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> 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
-------
None
Examples
--------
import asyncio
from label_studio_sdk import AsyncLabelStudio
client = AsyncLabelStudio(
api_key="YOUR_API_KEY",
)
async def main() -> None:
await client.projects.roles.remove(
id=1,
)
asyncio.run(main())
"""
_response = await self._raw_client.remove(id, request_options=request_options)
return _response.data
async def get(
self, id: int, *, request_options: typing.Optional[RequestOptions] = None
) -> 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
-------
typing.List[ProjectRole]
Examples
--------
import asyncio
from label_studio_sdk import AsyncLabelStudio
client = AsyncLabelStudio(
api_key="YOUR_API_KEY",
)
async def main() -> None:
await client.projects.roles.get(
id=1,
)
asyncio.run(main())
"""
_response = await self._raw_client.get(id, request_options=request_options)
return _response.data