Download data/src/elevenlabs/workspace/resources/client.py from introvoyz045/elevenlabs-python: direct link, hf CLI and curl.
- Browser
- Download file 15.3 kB
-
https://huggingface.co/datasets/introvoyz045/elevenlabs-python/resolve/main/data/src/elevenlabs/workspace/resources/client.py
- Command line
-
hf download hf://datasets/introvoyz045/elevenlabs-python/data/src/elevenlabs/workspace/resources/client.py
-
curl -L -o client.py https://huggingface.co/datasets/introvoyz045/elevenlabs-python/resolve/main/data/src/elevenlabs/workspace/resources/client.py
15.3 kB
| # 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.resource_metadata_response_model import ResourceMetadataResponseModel | |
| from ...types.workspace_resource_type import WorkspaceResourceType | |
| from .raw_client import AsyncRawResourcesClient, RawResourcesClient | |
| from .types.body_share_workspace_resource_v_1_workspace_resources_resource_id_share_post_role import ( | |
| BodyShareWorkspaceResourceV1WorkspaceResourcesResourceIdSharePostRole, | |
| ) | |
| # this is used as the default value for optional parameters | |
| OMIT = typing.cast(typing.Any, ...) | |
| class ResourcesClient: | |
| def __init__(self, *, client_wrapper: SyncClientWrapper): | |
| self._raw_client = RawResourcesClient(client_wrapper=client_wrapper) | |
| def with_raw_response(self) -> RawResourcesClient: | |
| """ | |
| Retrieves a raw implementation of this client that returns raw responses. | |
| Returns | |
| ------- | |
| RawResourcesClient | |
| """ | |
| return self._raw_client | |
| def get( | |
| self, | |
| resource_id: str, | |
| *, | |
| resource_type: WorkspaceResourceType, | |
| request_options: typing.Optional[RequestOptions] = None, | |
| ) -> ResourceMetadataResponseModel: | |
| """ | |
| Gets the metadata of a resource by ID. | |
| Parameters | |
| ---------- | |
| resource_id : str | |
| The ID of the target resource. | |
| resource_type : WorkspaceResourceType | |
| Resource type of the target resource. | |
| request_options : typing.Optional[RequestOptions] | |
| Request-specific configuration. | |
| Returns | |
| ------- | |
| ResourceMetadataResponseModel | |
| Successful Response | |
| Examples | |
| -------- | |
| from elevenlabs import ElevenLabs | |
| client = ElevenLabs( | |
| api_key="YOUR_API_KEY", | |
| ) | |
| client.workspace.resources.get( | |
| resource_id="resource_id", | |
| resource_type="voice", | |
| ) | |
| """ | |
| _response = self._raw_client.get(resource_id, resource_type=resource_type, request_options=request_options) | |
| return _response.data | |
| def share( | |
| self, | |
| resource_id: str, | |
| *, | |
| role: BodyShareWorkspaceResourceV1WorkspaceResourcesResourceIdSharePostRole, | |
| resource_type: WorkspaceResourceType, | |
| user_email: typing.Optional[str] = OMIT, | |
| group_id: typing.Optional[str] = OMIT, | |
| workspace_api_key_id: typing.Optional[str] = OMIT, | |
| request_options: typing.Optional[RequestOptions] = None, | |
| ) -> typing.Any: | |
| """ | |
| Grants a role (one of 'admin', 'editor', 'commenter', or 'viewer') on a workspace resource to a user, group, or workspace (service account) API key. This overrides any existing role the target has on the resource. To target a user or service account, pass only the user email; the user must be in your workspace. To target a group, pass only the group id. To target a workspace (service account) API key, pass the api key id; the resource will be shared with the service account associated with that key. You must have admin access to the resource to share it. | |
| Parameters | |
| ---------- | |
| resource_id : str | |
| The ID of the target resource. | |
| role : BodyShareWorkspaceResourceV1WorkspaceResourcesResourceIdSharePostRole | |
| Role to grant to the target: one of 'admin', 'editor', 'commenter', or 'viewer'. | |
| resource_type : WorkspaceResourceType | |
| Resource type of the target resource. | |
| user_email : typing.Optional[str] | |
| The email of the user or service account. | |
| group_id : typing.Optional[str] | |
| The ID of the target group. Use 'default' to set the resource's baseline role β every workspace member receives this role unless they hold a higher one through a direct user grant, group membership, or workspace (service account) API key. | |
| workspace_api_key_id : typing.Optional[str] | |
| The ID of the target workspace (service account) API key. This is not the API key string itself that you pass in the header for authentication β it is the key's ID, which workspace admins can find under Developers β Service Accounts. | |
| request_options : typing.Optional[RequestOptions] | |
| Request-specific configuration. | |
| Returns | |
| ------- | |
| typing.Any | |
| Successful Response | |
| Examples | |
| -------- | |
| from elevenlabs import ElevenLabs | |
| client = ElevenLabs( | |
| api_key="YOUR_API_KEY", | |
| ) | |
| client.workspace.resources.share( | |
| resource_id="resource_id", | |
| role="admin", | |
| resource_type="voice", | |
| ) | |
| """ | |
| _response = self._raw_client.share( | |
| resource_id, | |
| role=role, | |
| resource_type=resource_type, | |
| user_email=user_email, | |
| group_id=group_id, | |
| workspace_api_key_id=workspace_api_key_id, | |
| request_options=request_options, | |
| ) | |
| return _response.data | |
| def unshare( | |
| self, | |
| resource_id: str, | |
| *, | |
| resource_type: WorkspaceResourceType, | |
| user_email: typing.Optional[str] = OMIT, | |
| group_id: typing.Optional[str] = OMIT, | |
| workspace_api_key_id: typing.Optional[str] = OMIT, | |
| request_options: typing.Optional[RequestOptions] = None, | |
| ) -> typing.Any: | |
| """ | |
| Removes any existing role on a workspace resource from a user, group, or workspace (service account) API key. To target a user or service account, pass only the user email; the user must be in your workspace. To target a group, pass only the group id. To target a workspace (service account) API key, pass the api key id; the resource will be unshared from the service account associated with that key. You must have admin access to the resource to unshare it. You cannot remove permissions from the user who created the resource. | |
| Parameters | |
| ---------- | |
| resource_id : str | |
| The ID of the target resource. | |
| resource_type : WorkspaceResourceType | |
| Resource type of the target resource. | |
| user_email : typing.Optional[str] | |
| The email of the user or service account. | |
| group_id : typing.Optional[str] | |
| The ID of the target group. Use 'default' to set the resource's baseline role β every workspace member receives this role unless they hold a higher one through a direct user grant, group membership, or workspace (service account) API key. | |
| workspace_api_key_id : typing.Optional[str] | |
| The ID of the target workspace (service account) API key. This is not the API key string itself that you pass in the header for authentication β it is the key's ID, which workspace admins can find under Developers β Service Accounts. | |
| request_options : typing.Optional[RequestOptions] | |
| Request-specific configuration. | |
| Returns | |
| ------- | |
| typing.Any | |
| Successful Response | |
| Examples | |
| -------- | |
| from elevenlabs import ElevenLabs | |
| client = ElevenLabs( | |
| api_key="YOUR_API_KEY", | |
| ) | |
| client.workspace.resources.unshare( | |
| resource_id="resource_id", | |
| resource_type="voice", | |
| ) | |
| """ | |
| _response = self._raw_client.unshare( | |
| resource_id, | |
| resource_type=resource_type, | |
| user_email=user_email, | |
| group_id=group_id, | |
| workspace_api_key_id=workspace_api_key_id, | |
| request_options=request_options, | |
| ) | |
| return _response.data | |
| class AsyncResourcesClient: | |
| def __init__(self, *, client_wrapper: AsyncClientWrapper): | |
| self._raw_client = AsyncRawResourcesClient(client_wrapper=client_wrapper) | |
| def with_raw_response(self) -> AsyncRawResourcesClient: | |
| """ | |
| Retrieves a raw implementation of this client that returns raw responses. | |
| Returns | |
| ------- | |
| AsyncRawResourcesClient | |
| """ | |
| return self._raw_client | |
| async def get( | |
| self, | |
| resource_id: str, | |
| *, | |
| resource_type: WorkspaceResourceType, | |
| request_options: typing.Optional[RequestOptions] = None, | |
| ) -> ResourceMetadataResponseModel: | |
| """ | |
| Gets the metadata of a resource by ID. | |
| Parameters | |
| ---------- | |
| resource_id : str | |
| The ID of the target resource. | |
| resource_type : WorkspaceResourceType | |
| Resource type of the target resource. | |
| request_options : typing.Optional[RequestOptions] | |
| Request-specific configuration. | |
| Returns | |
| ------- | |
| ResourceMetadataResponseModel | |
| Successful Response | |
| Examples | |
| -------- | |
| import asyncio | |
| from elevenlabs import AsyncElevenLabs | |
| client = AsyncElevenLabs( | |
| api_key="YOUR_API_KEY", | |
| ) | |
| async def main() -> None: | |
| await client.workspace.resources.get( | |
| resource_id="resource_id", | |
| resource_type="voice", | |
| ) | |
| asyncio.run(main()) | |
| """ | |
| _response = await self._raw_client.get( | |
| resource_id, resource_type=resource_type, request_options=request_options | |
| ) | |
| return _response.data | |
| async def share( | |
| self, | |
| resource_id: str, | |
| *, | |
| role: BodyShareWorkspaceResourceV1WorkspaceResourcesResourceIdSharePostRole, | |
| resource_type: WorkspaceResourceType, | |
| user_email: typing.Optional[str] = OMIT, | |
| group_id: typing.Optional[str] = OMIT, | |
| workspace_api_key_id: typing.Optional[str] = OMIT, | |
| request_options: typing.Optional[RequestOptions] = None, | |
| ) -> typing.Any: | |
| """ | |
| Grants a role (one of 'admin', 'editor', 'commenter', or 'viewer') on a workspace resource to a user, group, or workspace (service account) API key. This overrides any existing role the target has on the resource. To target a user or service account, pass only the user email; the user must be in your workspace. To target a group, pass only the group id. To target a workspace (service account) API key, pass the api key id; the resource will be shared with the service account associated with that key. You must have admin access to the resource to share it. | |
| Parameters | |
| ---------- | |
| resource_id : str | |
| The ID of the target resource. | |
| role : BodyShareWorkspaceResourceV1WorkspaceResourcesResourceIdSharePostRole | |
| Role to grant to the target: one of 'admin', 'editor', 'commenter', or 'viewer'. | |
| resource_type : WorkspaceResourceType | |
| Resource type of the target resource. | |
| user_email : typing.Optional[str] | |
| The email of the user or service account. | |
| group_id : typing.Optional[str] | |
| The ID of the target group. Use 'default' to set the resource's baseline role β every workspace member receives this role unless they hold a higher one through a direct user grant, group membership, or workspace (service account) API key. | |
| workspace_api_key_id : typing.Optional[str] | |
| The ID of the target workspace (service account) API key. This is not the API key string itself that you pass in the header for authentication β it is the key's ID, which workspace admins can find under Developers β Service Accounts. | |
| request_options : typing.Optional[RequestOptions] | |
| Request-specific configuration. | |
| Returns | |
| ------- | |
| typing.Any | |
| Successful Response | |
| Examples | |
| -------- | |
| import asyncio | |
| from elevenlabs import AsyncElevenLabs | |
| client = AsyncElevenLabs( | |
| api_key="YOUR_API_KEY", | |
| ) | |
| async def main() -> None: | |
| await client.workspace.resources.share( | |
| resource_id="resource_id", | |
| role="admin", | |
| resource_type="voice", | |
| ) | |
| asyncio.run(main()) | |
| """ | |
| _response = await self._raw_client.share( | |
| resource_id, | |
| role=role, | |
| resource_type=resource_type, | |
| user_email=user_email, | |
| group_id=group_id, | |
| workspace_api_key_id=workspace_api_key_id, | |
| request_options=request_options, | |
| ) | |
| return _response.data | |
| async def unshare( | |
| self, | |
| resource_id: str, | |
| *, | |
| resource_type: WorkspaceResourceType, | |
| user_email: typing.Optional[str] = OMIT, | |
| group_id: typing.Optional[str] = OMIT, | |
| workspace_api_key_id: typing.Optional[str] = OMIT, | |
| request_options: typing.Optional[RequestOptions] = None, | |
| ) -> typing.Any: | |
| """ | |
| Removes any existing role on a workspace resource from a user, group, or workspace (service account) API key. To target a user or service account, pass only the user email; the user must be in your workspace. To target a group, pass only the group id. To target a workspace (service account) API key, pass the api key id; the resource will be unshared from the service account associated with that key. You must have admin access to the resource to unshare it. You cannot remove permissions from the user who created the resource. | |
| Parameters | |
| ---------- | |
| resource_id : str | |
| The ID of the target resource. | |
| resource_type : WorkspaceResourceType | |
| Resource type of the target resource. | |
| user_email : typing.Optional[str] | |
| The email of the user or service account. | |
| group_id : typing.Optional[str] | |
| The ID of the target group. Use 'default' to set the resource's baseline role β every workspace member receives this role unless they hold a higher one through a direct user grant, group membership, or workspace (service account) API key. | |
| workspace_api_key_id : typing.Optional[str] | |
| The ID of the target workspace (service account) API key. This is not the API key string itself that you pass in the header for authentication β it is the key's ID, which workspace admins can find under Developers β Service Accounts. | |
| request_options : typing.Optional[RequestOptions] | |
| Request-specific configuration. | |
| Returns | |
| ------- | |
| typing.Any | |
| Successful Response | |
| Examples | |
| -------- | |
| import asyncio | |
| from elevenlabs import AsyncElevenLabs | |
| client = AsyncElevenLabs( | |
| api_key="YOUR_API_KEY", | |
| ) | |
| async def main() -> None: | |
| await client.workspace.resources.unshare( | |
| resource_id="resource_id", | |
| resource_type="voice", | |
| ) | |
| asyncio.run(main()) | |
| """ | |
| _response = await self._raw_client.unshare( | |
| resource_id, | |
| resource_type=resource_type, | |
| user_email=user_email, | |
| group_id=group_id, | |
| workspace_api_key_id=workspace_api_key_id, | |
| request_options=request_options, | |
| ) | |
| return _response.data | |