# 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.organization_invite import OrganizationInvite
from ...types.role9e7enum import Role9E7Enum
from .raw_client import AsyncRawInvitesClient, RawInvitesClient
# this is used as the default value for optional parameters
OMIT = typing.cast(typing.Any, ...)
class InvitesClient:
def __init__(self, *, client_wrapper: SyncClientWrapper):
self._raw_client = RawInvitesClient(client_wrapper=client_wrapper)
@property
def with_raw_response(self) -> RawInvitesClient:
"""
Retrieves a raw implementation of this client that returns raw responses.
Returns
-------
RawInvitesClient
"""
return self._raw_client
def get_invite_link(self, *, request_options: typing.Optional[RequestOptions] = None) -> OrganizationInvite:
"""
Get invite link for organization
Parameters
----------
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
OrganizationInvite
Examples
--------
from label_studio_sdk import LabelStudio
client = LabelStudio(
api_key="YOUR_API_KEY",
)
client.organizations.invites.get_invite_link()
"""
_response = self._raw_client.get_invite_link(request_options=request_options)
return _response.data
def revoke_invite(self, *, email: str, 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)
Revoke invite to organization
Parameters
----------
email : str
Email address
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.organizations.invites.revoke_invite(
email="email",
)
"""
_response = self._raw_client.revoke_invite(email=email, request_options=request_options)
return _response.data
def send_email(
self,
*,
emails: typing.Sequence[str],
role: Role9E7Enum,
projects: typing.Optional[typing.Sequence[int]] = OMIT,
workspaces: typing.Optional[typing.Sequence[int]] = OMIT,
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)
Send email with invite to organization
Parameters
----------
emails : typing.Sequence[str]
Email addresses
role : Role9E7Enum
Organization role
* `OW` - Owner
* `AD` - Administrator
* `MA` - Manager
* `RE` - Reviewer
* `AN` - Annotator
* `DI` - Deactivated
* `NO` - Not Activated
projects : typing.Optional[typing.Sequence[int]]
Project IDs to grant access to
workspaces : typing.Optional[typing.Sequence[int]]
Workspace IDs to grant access to
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.organizations.invites.send_email(
emails=["emails"],
role="OW",
)
"""
_response = self._raw_client.send_email(
emails=emails, role=role, projects=projects, workspaces=workspaces, request_options=request_options
)
return _response.data
class AsyncInvitesClient:
def __init__(self, *, client_wrapper: AsyncClientWrapper):
self._raw_client = AsyncRawInvitesClient(client_wrapper=client_wrapper)
@property
def with_raw_response(self) -> AsyncRawInvitesClient:
"""
Retrieves a raw implementation of this client that returns raw responses.
Returns
-------
AsyncRawInvitesClient
"""
return self._raw_client
async def get_invite_link(self, *, request_options: typing.Optional[RequestOptions] = None) -> OrganizationInvite:
"""
Get invite link for organization
Parameters
----------
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
OrganizationInvite
Examples
--------
import asyncio
from label_studio_sdk import AsyncLabelStudio
client = AsyncLabelStudio(
api_key="YOUR_API_KEY",
)
async def main() -> None:
await client.organizations.invites.get_invite_link()
asyncio.run(main())
"""
_response = await self._raw_client.get_invite_link(request_options=request_options)
return _response.data
async def revoke_invite(self, *, email: str, 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)
Revoke invite to organization
Parameters
----------
email : str
Email address
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.organizations.invites.revoke_invite(
email="email",
)
asyncio.run(main())
"""
_response = await self._raw_client.revoke_invite(email=email, request_options=request_options)
return _response.data
async def send_email(
self,
*,
emails: typing.Sequence[str],
role: Role9E7Enum,
projects: typing.Optional[typing.Sequence[int]] = OMIT,
workspaces: typing.Optional[typing.Sequence[int]] = OMIT,
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)
Send email with invite to organization
Parameters
----------
emails : typing.Sequence[str]
Email addresses
role : Role9E7Enum
Organization role
* `OW` - Owner
* `AD` - Administrator
* `MA` - Manager
* `RE` - Reviewer
* `AN` - Annotator
* `DI` - Deactivated
* `NO` - Not Activated
projects : typing.Optional[typing.Sequence[int]]
Project IDs to grant access to
workspaces : typing.Optional[typing.Sequence[int]]
Workspace IDs to grant access to
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.organizations.invites.send_email(
emails=["emails"],
role="OW",
)
asyncio.run(main())
"""
_response = await self._raw_client.send_email(
emails=emails, role=role, projects=projects, workspaces=workspaces, request_options=request_options
)
return _response.data