introvoyz045's picture
Migrated from GitHub
9410704 verified
Raw History Blame Contribute Delete
5.81 kB
# This file was auto-generated by Fern from our API Definition.
from __future__ import annotations
import typing
from ...core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
from ...core.request_options import RequestOptions
from ...types.workspace_group_by_name_response_model import WorkspaceGroupByNameResponseModel
from ...types.workspace_group_response_model import WorkspaceGroupResponseModel
from .raw_client import AsyncRawGroupsClient, RawGroupsClient
if typing.TYPE_CHECKING:
from .members.client import AsyncMembersClient, MembersClient
class GroupsClient:
def __init__(self, *, client_wrapper: SyncClientWrapper):
self._raw_client = RawGroupsClient(client_wrapper=client_wrapper)
self._client_wrapper = client_wrapper
self._members: typing.Optional[MembersClient] = None
@property
def with_raw_response(self) -> RawGroupsClient:
"""
Retrieves a raw implementation of this client that returns raw responses.
Returns
-------
RawGroupsClient
"""
return self._raw_client
def list(
self, *, request_options: typing.Optional[RequestOptions] = None
) -> typing.Dict[str, WorkspaceGroupResponseModel]:
"""
Get all groups in the workspace
Parameters
----------
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
typing.Dict[str, WorkspaceGroupResponseModel]
Successful Response
Examples
--------
from elevenlabs import ElevenLabs
client = ElevenLabs(
api_key="YOUR_API_KEY",
)
client.workspace.groups.list()
"""
_response = self._raw_client.list(request_options=request_options)
return _response.data
def search(
self, *, name: str, request_options: typing.Optional[RequestOptions] = None
) -> typing.List[WorkspaceGroupByNameResponseModel]:
"""
Searches for user groups in the workspace. Multiple or no groups may be returned.
Parameters
----------
name : str
Name of the target group.
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
typing.List[WorkspaceGroupByNameResponseModel]
Successful Response
Examples
--------
from elevenlabs import ElevenLabs
client = ElevenLabs(
api_key="YOUR_API_KEY",
)
client.workspace.groups.search(
name="name",
)
"""
_response = self._raw_client.search(name=name, request_options=request_options)
return _response.data
@property
def members(self):
if self._members is None:
from .members.client import MembersClient # noqa: E402
self._members = MembersClient(client_wrapper=self._client_wrapper)
return self._members
class AsyncGroupsClient:
def __init__(self, *, client_wrapper: AsyncClientWrapper):
self._raw_client = AsyncRawGroupsClient(client_wrapper=client_wrapper)
self._client_wrapper = client_wrapper
self._members: typing.Optional[AsyncMembersClient] = None
@property
def with_raw_response(self) -> AsyncRawGroupsClient:
"""
Retrieves a raw implementation of this client that returns raw responses.
Returns
-------
AsyncRawGroupsClient
"""
return self._raw_client
async def list(
self, *, request_options: typing.Optional[RequestOptions] = None
) -> typing.Dict[str, WorkspaceGroupResponseModel]:
"""
Get all groups in the workspace
Parameters
----------
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
typing.Dict[str, WorkspaceGroupResponseModel]
Successful Response
Examples
--------
import asyncio
from elevenlabs import AsyncElevenLabs
client = AsyncElevenLabs(
api_key="YOUR_API_KEY",
)
async def main() -> None:
await client.workspace.groups.list()
asyncio.run(main())
"""
_response = await self._raw_client.list(request_options=request_options)
return _response.data
async def search(
self, *, name: str, request_options: typing.Optional[RequestOptions] = None
) -> typing.List[WorkspaceGroupByNameResponseModel]:
"""
Searches for user groups in the workspace. Multiple or no groups may be returned.
Parameters
----------
name : str
Name of the target group.
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
typing.List[WorkspaceGroupByNameResponseModel]
Successful Response
Examples
--------
import asyncio
from elevenlabs import AsyncElevenLabs
client = AsyncElevenLabs(
api_key="YOUR_API_KEY",
)
async def main() -> None:
await client.workspace.groups.search(
name="name",
)
asyncio.run(main())
"""
_response = await self._raw_client.search(name=name, request_options=request_options)
return _response.data
@property
def members(self):
if self._members is None:
from .members.client import AsyncMembersClient # noqa: E402
self._members = AsyncMembersClient(client_wrapper=self._client_wrapper)
return self._members