introvoyz045's picture
Migrated from GitHub
9410704 verified
Raw History Blame Contribute Delete
6.87 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.environment_response import EnvironmentResponse
from ..types.environments_list_response import EnvironmentsListResponse
from .raw_client import AsyncRawEnvironmentsClient, RawEnvironmentsClient
# this is used as the default value for optional parameters
OMIT = typing.cast(typing.Any, ...)
class EnvironmentsClient:
def __init__(self, *, client_wrapper: SyncClientWrapper):
self._raw_client = RawEnvironmentsClient(client_wrapper=client_wrapper)
@property
def with_raw_response(self) -> RawEnvironmentsClient:
"""
Retrieves a raw implementation of this client that returns raw responses.
Returns
-------
RawEnvironmentsClient
"""
return self._raw_client
def list(self, *, request_options: typing.Optional[RequestOptions] = None) -> EnvironmentsListResponse:
"""
List the workspace environments, including 'production'.
Parameters
----------
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
EnvironmentsListResponse
Successful Response
Examples
--------
from elevenlabs import ElevenLabs
client = ElevenLabs(
api_key="YOUR_API_KEY",
)
client.environments.list()
"""
_response = self._raw_client.list(request_options=request_options)
return _response.data
def create(self, *, name: str, request_options: typing.Optional[RequestOptions] = None) -> EnvironmentResponse:
"""
Create a workspace environment. Variables without a value for it fall back to their production value.
Parameters
----------
name : str
Unique name of the environment, e.g. 'staging'.
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
EnvironmentResponse
Successful Response
Examples
--------
from elevenlabs import ElevenLabs
client = ElevenLabs(
api_key="YOUR_API_KEY",
)
client.environments.create(
name="name",
)
"""
_response = self._raw_client.create(name=name, request_options=request_options)
return _response.data
def delete(self, environment: str, *, request_options: typing.Optional[RequestOptions] = None) -> None:
"""
Delete a workspace environment and remove its values from all environment variables. 'production' cannot be deleted.
Parameters
----------
environment : str
Name of the environment to delete, e.g. 'staging'.
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
None
Examples
--------
from elevenlabs import ElevenLabs
client = ElevenLabs(
api_key="YOUR_API_KEY",
)
client.environments.delete(
environment="environment",
)
"""
_response = self._raw_client.delete(environment, request_options=request_options)
return _response.data
class AsyncEnvironmentsClient:
def __init__(self, *, client_wrapper: AsyncClientWrapper):
self._raw_client = AsyncRawEnvironmentsClient(client_wrapper=client_wrapper)
@property
def with_raw_response(self) -> AsyncRawEnvironmentsClient:
"""
Retrieves a raw implementation of this client that returns raw responses.
Returns
-------
AsyncRawEnvironmentsClient
"""
return self._raw_client
async def list(self, *, request_options: typing.Optional[RequestOptions] = None) -> EnvironmentsListResponse:
"""
List the workspace environments, including 'production'.
Parameters
----------
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
EnvironmentsListResponse
Successful Response
Examples
--------
import asyncio
from elevenlabs import AsyncElevenLabs
client = AsyncElevenLabs(
api_key="YOUR_API_KEY",
)
async def main() -> None:
await client.environments.list()
asyncio.run(main())
"""
_response = await self._raw_client.list(request_options=request_options)
return _response.data
async def create(
self, *, name: str, request_options: typing.Optional[RequestOptions] = None
) -> EnvironmentResponse:
"""
Create a workspace environment. Variables without a value for it fall back to their production value.
Parameters
----------
name : str
Unique name of the environment, e.g. 'staging'.
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
EnvironmentResponse
Successful Response
Examples
--------
import asyncio
from elevenlabs import AsyncElevenLabs
client = AsyncElevenLabs(
api_key="YOUR_API_KEY",
)
async def main() -> None:
await client.environments.create(
name="name",
)
asyncio.run(main())
"""
_response = await self._raw_client.create(name=name, request_options=request_options)
return _response.data
async def delete(self, environment: str, *, request_options: typing.Optional[RequestOptions] = None) -> None:
"""
Delete a workspace environment and remove its values from all environment variables. 'production' cannot be deleted.
Parameters
----------
environment : str
Name of the environment to delete, e.g. 'staging'.
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.environments.delete(
environment="environment",
)
asyncio.run(main())
"""
_response = await self._raw_client.delete(environment, request_options=request_options)
return _response.data