introvoyz045's picture
Migrated from GitHub
9410704 verified
Raw History Blame Contribute Delete
9.53 kB
# This file was auto-generated by Fern from our API Definition.
import typing
from .. import core
from ..core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
from ..core.request_options import RequestOptions
from ..types.asset_list_response import AssetListResponse
from ..types.asset_response import AssetResponse
from .raw_client import AsyncRawAssetsClient, RawAssetsClient
# this is used as the default value for optional parameters
OMIT = typing.cast(typing.Any, ...)
class AssetsClient:
def __init__(self, *, client_wrapper: SyncClientWrapper):
self._raw_client = RawAssetsClient(client_wrapper=client_wrapper)
@property
def with_raw_response(self) -> RawAssetsClient:
"""
Retrieves a raw implementation of this client that returns raw responses.
Returns
-------
RawAssetsClient
"""
return self._raw_client
def list(
self,
*,
page_size: typing.Optional[int] = None,
cursor: typing.Optional[str] = None,
search: typing.Optional[str] = None,
request_options: typing.Optional[RequestOptions] = None,
) -> AssetListResponse:
"""
List assets in the workspace, most recently created first.
Parameters
----------
page_size : typing.Optional[int]
Number of assets to return.
cursor : typing.Optional[str]
Token from a previous response's `next_cursor`. Omit to fetch the first page.
search : typing.Optional[str]
Optional free-text search filter over asset names.
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
AssetListResponse
Successful Response
Examples
--------
from elevenlabs import ElevenLabs
client = ElevenLabs(
api_key="YOUR_API_KEY",
)
client.assets.list(
page_size=1,
cursor="cursor",
search="search",
)
"""
_response = self._raw_client.list(
page_size=page_size, cursor=cursor, search=search, request_options=request_options
)
return _response.data
def create(
self, *, asset: core.File, name: str, request_options: typing.Optional[RequestOptions] = None
) -> AssetResponse:
"""
Upload a new asset.
Parameters
----------
asset : core.File
See core.File for more documentation
name : str
Display name for the asset.
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
AssetResponse
Successful Response
Examples
--------
from elevenlabs import ElevenLabs
client = ElevenLabs(
api_key="YOUR_API_KEY",
)
client.assets.create(
name="name",
)
"""
_response = self._raw_client.create(asset=asset, name=name, request_options=request_options)
return _response.data
def get(self, asset_id: str, *, request_options: typing.Optional[RequestOptions] = None) -> AssetResponse:
"""
Retrieve a single asset by ID.
Parameters
----------
asset_id : str
ID of the asset.
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
AssetResponse
Successful Response
Examples
--------
from elevenlabs import ElevenLabs
client = ElevenLabs(
api_key="YOUR_API_KEY",
)
client.assets.get(
asset_id="5xM2KqOnZyce22SPZ9d4",
)
"""
_response = self._raw_client.get(asset_id, request_options=request_options)
return _response.data
def delete(self, asset_id: str, *, request_options: typing.Optional[RequestOptions] = None) -> None:
"""
Delete an asset by ID.
Parameters
----------
asset_id : str
ID of the asset.
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
None
Examples
--------
from elevenlabs import ElevenLabs
client = ElevenLabs(
api_key="YOUR_API_KEY",
)
client.assets.delete(
asset_id="5xM2KqOnZyce22SPZ9d4",
)
"""
_response = self._raw_client.delete(asset_id, request_options=request_options)
return _response.data
class AsyncAssetsClient:
def __init__(self, *, client_wrapper: AsyncClientWrapper):
self._raw_client = AsyncRawAssetsClient(client_wrapper=client_wrapper)
@property
def with_raw_response(self) -> AsyncRawAssetsClient:
"""
Retrieves a raw implementation of this client that returns raw responses.
Returns
-------
AsyncRawAssetsClient
"""
return self._raw_client
async def list(
self,
*,
page_size: typing.Optional[int] = None,
cursor: typing.Optional[str] = None,
search: typing.Optional[str] = None,
request_options: typing.Optional[RequestOptions] = None,
) -> AssetListResponse:
"""
List assets in the workspace, most recently created first.
Parameters
----------
page_size : typing.Optional[int]
Number of assets to return.
cursor : typing.Optional[str]
Token from a previous response's `next_cursor`. Omit to fetch the first page.
search : typing.Optional[str]
Optional free-text search filter over asset names.
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
AssetListResponse
Successful Response
Examples
--------
import asyncio
from elevenlabs import AsyncElevenLabs
client = AsyncElevenLabs(
api_key="YOUR_API_KEY",
)
async def main() -> None:
await client.assets.list(
page_size=1,
cursor="cursor",
search="search",
)
asyncio.run(main())
"""
_response = await self._raw_client.list(
page_size=page_size, cursor=cursor, search=search, request_options=request_options
)
return _response.data
async def create(
self, *, asset: core.File, name: str, request_options: typing.Optional[RequestOptions] = None
) -> AssetResponse:
"""
Upload a new asset.
Parameters
----------
asset : core.File
See core.File for more documentation
name : str
Display name for the asset.
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
AssetResponse
Successful Response
Examples
--------
import asyncio
from elevenlabs import AsyncElevenLabs
client = AsyncElevenLabs(
api_key="YOUR_API_KEY",
)
async def main() -> None:
await client.assets.create(
name="name",
)
asyncio.run(main())
"""
_response = await self._raw_client.create(asset=asset, name=name, request_options=request_options)
return _response.data
async def get(self, asset_id: str, *, request_options: typing.Optional[RequestOptions] = None) -> AssetResponse:
"""
Retrieve a single asset by ID.
Parameters
----------
asset_id : str
ID of the asset.
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
AssetResponse
Successful Response
Examples
--------
import asyncio
from elevenlabs import AsyncElevenLabs
client = AsyncElevenLabs(
api_key="YOUR_API_KEY",
)
async def main() -> None:
await client.assets.get(
asset_id="5xM2KqOnZyce22SPZ9d4",
)
asyncio.run(main())
"""
_response = await self._raw_client.get(asset_id, request_options=request_options)
return _response.data
async def delete(self, asset_id: str, *, request_options: typing.Optional[RequestOptions] = None) -> None:
"""
Delete an asset by ID.
Parameters
----------
asset_id : str
ID of the asset.
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
None
Examples
--------
import asyncio
from elevenlabs import AsyncElevenLabs
client = AsyncElevenLabs(
api_key="YOUR_API_KEY",
)
async def main() -> None:
await client.assets.delete(
asset_id="5xM2KqOnZyce22SPZ9d4",
)
asyncio.run(main())
"""
_response = await self._raw_client.delete(asset_id, request_options=request_options)
return _response.data