speechify-api 0.0.145__py3-none-any.whl

speechifyinc/tts/auth/client.py

@@ -0,0 +1,171 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+from ...core.client_wrapper import SyncClientWrapper
+from .types.create_access_token_request_scope import CreateAccessTokenRequestScope
+from ...core.request_options import RequestOptions
+from ..types.access_token import AccessToken
+from ...core.pydantic_utilities import parse_obj_as
+from ..errors.bad_request_error import BadRequestError
+from json.decoder import JSONDecodeError
+from ...core.api_error import ApiError
+from ...core.client_wrapper import AsyncClientWrapper
+
+# this is used as the default value for optional parameters
+OMIT = typing.cast(typing.Any, ...)
+
+
+class AuthClient:
+    def __init__(self, *, client_wrapper: SyncClientWrapper):
+        self._client_wrapper = client_wrapper
+
+    def create_access_token(
+        self,
+        *,
+        scope: typing.Optional[CreateAccessTokenRequestScope] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> AccessToken:
+        """
+        Create a new API token for the logged in user
+
+        Parameters
+        ----------
+        scope : typing.Optional[CreateAccessTokenRequestScope]
+            The scope, or a space-delimited list of scopes the token is requested for
+            in: body
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        AccessToken
+            Contains the details of the token which can be used by the user to access the API
+
+        Examples
+        --------
+        from speechifyinc import Speechify
+
+        client = Speechify(
+            token="YOUR_TOKEN",
+        )
+        client.tts.auth.create_access_token()
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            "v1/auth/token",
+            method="POST",
+            json={
+                "scope": scope,
+                "grant_type": "client_credentials",
+            },
+            headers={
+                "content-type": "application/json",
+            },
+            request_options=request_options,
+            omit=OMIT,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                return typing.cast(
+                    AccessToken,
+                    parse_obj_as(
+                        type_=AccessToken,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+            if _response.status_code == 400:
+                raise BadRequestError(
+                    typing.cast(
+                        typing.Optional[typing.Any],
+                        parse_obj_as(
+                            type_=typing.Optional[typing.Any],  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    )
+                )
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, body=_response.text)
+        raise ApiError(status_code=_response.status_code, body=_response_json)
+
+
+class AsyncAuthClient:
+    def __init__(self, *, client_wrapper: AsyncClientWrapper):
+        self._client_wrapper = client_wrapper
+
+    async def create_access_token(
+        self,
+        *,
+        scope: typing.Optional[CreateAccessTokenRequestScope] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> AccessToken:
+        """
+        Create a new API token for the logged in user
+
+        Parameters
+        ----------
+        scope : typing.Optional[CreateAccessTokenRequestScope]
+            The scope, or a space-delimited list of scopes the token is requested for
+            in: body
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        AccessToken
+            Contains the details of the token which can be used by the user to access the API
+
+        Examples
+        --------
+        import asyncio
+
+        from speechifyinc import AsyncSpeechify
+
+        client = AsyncSpeechify(
+            token="YOUR_TOKEN",
+        )
+
+
+        async def main() -> None:
+            await client.tts.auth.create_access_token()
+
+
+        asyncio.run(main())
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            "v1/auth/token",
+            method="POST",
+            json={
+                "scope": scope,
+                "grant_type": "client_credentials",
+            },
+            headers={
+                "content-type": "application/json",
+            },
+            request_options=request_options,
+            omit=OMIT,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                return typing.cast(
+                    AccessToken,
+                    parse_obj_as(
+                        type_=AccessToken,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+            if _response.status_code == 400:
+                raise BadRequestError(
+                    typing.cast(
+                        typing.Optional[typing.Any],
+                        parse_obj_as(
+                            type_=typing.Optional[typing.Any],  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    )
+                )
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, body=_response.text)
+        raise ApiError(status_code=_response.status_code, body=_response_json)

speechifyinc/tts/auth/types/__init__.py

@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from .create_access_token_request_scope import CreateAccessTokenRequestScope
+
+__all__ = ["CreateAccessTokenRequestScope"]

speechifyinc/tts/auth/types/create_access_token_request_scope.py

@@ -0,0 +1,10 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+CreateAccessTokenRequestScope = typing.Union[
+    typing.Literal[
+        "audio:speech", "audio:stream", "audio:all", "voices:read", "voices:create", "voices:delete", "voices:all"
+    ],
+    typing.Any,
+]

speechifyinc/tts/client.py

@@ -0,0 +1,26 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.client_wrapper import SyncClientWrapper
+from .audio.client import AudioClient
+from .auth.client import AuthClient
+from .voices.client import VoicesClient
+from ..core.client_wrapper import AsyncClientWrapper
+from .audio.client import AsyncAudioClient
+from .auth.client import AsyncAuthClient
+from .voices.client import AsyncVoicesClient
+
+
+class TtsClient:
+    def __init__(self, *, client_wrapper: SyncClientWrapper):
+        self._client_wrapper = client_wrapper
+        self.audio = AudioClient(client_wrapper=self._client_wrapper)
+        self.auth = AuthClient(client_wrapper=self._client_wrapper)
+        self.voices = VoicesClient(client_wrapper=self._client_wrapper)
+
+
+class AsyncTtsClient:
+    def __init__(self, *, client_wrapper: AsyncClientWrapper):
+        self._client_wrapper = client_wrapper
+        self.audio = AsyncAudioClient(client_wrapper=self._client_wrapper)
+        self.auth = AsyncAuthClient(client_wrapper=self._client_wrapper)
+        self.voices = AsyncVoicesClient(client_wrapper=self._client_wrapper)

speechifyinc/tts/errors/__init__.py

@@ -0,0 +1,9 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from .bad_request_error import BadRequestError
+from .forbidden_error import ForbiddenError
+from .internal_server_error import InternalServerError
+from .not_found_error import NotFoundError
+from .payment_required_error import PaymentRequiredError
+
+__all__ = ["BadRequestError", "ForbiddenError", "InternalServerError", "NotFoundError", "PaymentRequiredError"]

speechifyinc/tts/errors/bad_request_error.py

@@ -0,0 +1,9 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ...core.api_error import ApiError
+import typing
+
+
+class BadRequestError(ApiError):
+    def __init__(self, body: typing.Optional[typing.Any]):
+        super().__init__(status_code=400, body=body)

speechifyinc/tts/errors/forbidden_error.py

@@ -0,0 +1,9 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ...core.api_error import ApiError
+import typing
+
+
+class ForbiddenError(ApiError):
+    def __init__(self, body: typing.Optional[typing.Any]):
+        super().__init__(status_code=403, body=body)

speechifyinc/tts/errors/internal_server_error.py

@@ -0,0 +1,9 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ...core.api_error import ApiError
+import typing
+
+
+class InternalServerError(ApiError):
+    def __init__(self, body: typing.Optional[typing.Any]):
+        super().__init__(status_code=500, body=body)

speechifyinc/tts/errors/not_found_error.py

@@ -0,0 +1,9 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ...core.api_error import ApiError
+import typing
+
+
+class NotFoundError(ApiError):
+    def __init__(self, body: typing.Optional[typing.Any]):
+        super().__init__(status_code=404, body=body)

speechifyinc/tts/errors/payment_required_error.py

@@ -0,0 +1,9 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ...core.api_error import ApiError
+import typing
+
+
+class PaymentRequiredError(ApiError):
+    def __init__(self, body: typing.Optional[typing.Any]):
+        super().__init__(status_code=402, body=body)

speechifyinc/tts/types/__init__.py

@@ -0,0 +1,57 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from .access_token import AccessToken
+from .access_token_scope import AccessTokenScope
+from .api_key import ApiKey
+from .create_voice_language import CreateVoiceLanguage
+from .create_voice_model import CreateVoiceModel
+from .create_voice_model_name import CreateVoiceModelName
+from .created_voice import CreatedVoice
+from .created_voice_gender import CreatedVoiceGender
+from .created_voice_type import CreatedVoiceType
+from .experimental_stream_request import ExperimentalStreamRequest
+from .experimental_stream_request_model import ExperimentalStreamRequestModel
+from .experimental_stream_response import ExperimentalStreamResponse
+from .get_speech_options_request import GetSpeechOptionsRequest
+from .get_speech_response import GetSpeechResponse
+from .get_speech_response_audio_format import GetSpeechResponseAudioFormat
+from .get_stream_options_request import GetStreamOptionsRequest
+from .get_voice import GetVoice
+from .get_voice_gender import GetVoiceGender
+from .get_voice_language import GetVoiceLanguage
+from .get_voice_type import GetVoiceType
+from .get_voices_model import GetVoicesModel
+from .get_voices_model_name import GetVoicesModelName
+from .nested_chunk import NestedChunk
+from .o_auth_error import OAuthError
+from .o_auth_error_error import OAuthErrorError
+from .speech_marks import SpeechMarks
+
+__all__ = [
+    "AccessToken",
+    "AccessTokenScope",
+    "ApiKey",
+    "CreateVoiceLanguage",
+    "CreateVoiceModel",
+    "CreateVoiceModelName",
+    "CreatedVoice",
+    "CreatedVoiceGender",
+    "CreatedVoiceType",
+    "ExperimentalStreamRequest",
+    "ExperimentalStreamRequestModel",
+    "ExperimentalStreamResponse",
+    "GetSpeechOptionsRequest",
+    "GetSpeechResponse",
+    "GetSpeechResponseAudioFormat",
+    "GetStreamOptionsRequest",
+    "GetVoice",
+    "GetVoiceGender",
+    "GetVoiceLanguage",
+    "GetVoiceType",
+    "GetVoicesModel",
+    "GetVoicesModelName",
+    "NestedChunk",
+    "OAuthError",
+    "OAuthErrorError",
+    "SpeechMarks",
+]

speechifyinc/tts/types/access_token.py

@@ -0,0 +1,34 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ...core.pydantic_utilities import UniversalBaseModel
+import typing
+import pydantic
+from .access_token_scope import AccessTokenScope
+from ...core.pydantic_utilities import IS_PYDANTIC_V2
+
+
+class AccessToken(UniversalBaseModel):
+    access_token: typing.Optional[str] = None
+    expires_in: typing.Optional[int] = pydantic.Field(default=None)
+    """
+    Expiration time, in seconds from the issue time
+    """
+
+    scope: typing.Optional[AccessTokenScope] = pydantic.Field(default=None)
+    """
+    The scope, or a space-delimited list of scopes the token is issued for
+    """
+
+    token_type: typing.Optional[typing.Literal["bearer"]] = pydantic.Field(default=None)
+    """
+    Token type
+    """
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

speechifyinc/tts/types/access_token_scope.py

@@ -0,0 +1,10 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+AccessTokenScope = typing.Union[
+    typing.Literal[
+        "audio:speech", "audio:stream", "audio:all", "voices:read", "voices:create", "voices:delete", "voices:all"
+    ],
+    typing.Any,
+]

speechifyinc/tts/types/api_key.py

@@ -0,0 +1,47 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ...core.pydantic_utilities import UniversalBaseModel
+import typing
+import pydantic
+from ...core.pydantic_utilities import IS_PYDANTIC_V2
+
+
+class ApiKey(UniversalBaseModel):
+    api_key: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    API key
+    """
+
+    created_at: typing.Optional[int] = pydantic.Field(default=None)
+    """
+    Creation time of the key
+    """
+
+    id: typing.Optional[int] = pydantic.Field(default=None)
+    """
+    ID of the key
+    """
+
+    name: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Name of the key
+    """
+
+    updated_at: typing.Optional[int] = pydantic.Field(default=None)
+    """
+    Last updated time of the key
+    """
+
+    user_id: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    User ID to whom the key belongs
+    """
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

speechifyinc/tts/types/create_voice_language.py

@@ -0,0 +1,20 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ...core.pydantic_utilities import UniversalBaseModel
+import typing
+from ...core.pydantic_utilities import IS_PYDANTIC_V2
+import pydantic
+
+
+class CreateVoiceLanguage(UniversalBaseModel):
+    locale: typing.Optional[str] = None
+    preview_audio: typing.Optional[str] = None
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

speechifyinc/tts/types/create_voice_model.py

@@ -0,0 +1,22 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ...core.pydantic_utilities import UniversalBaseModel
+import typing
+from .create_voice_language import CreateVoiceLanguage
+from .create_voice_model_name import CreateVoiceModelName
+from ...core.pydantic_utilities import IS_PYDANTIC_V2
+import pydantic
+
+
+class CreateVoiceModel(UniversalBaseModel):
+    languages: typing.Optional[typing.List[CreateVoiceLanguage]] = None
+    name: typing.Optional[CreateVoiceModelName] = None
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

speechifyinc/tts/types/create_voice_model_name.py

@@ -0,0 +1,7 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+CreateVoiceModelName = typing.Union[
+    typing.Literal["simba-base", "simba-english", "simba-multilingual", "simba-turbo"], typing.Any
+]

speechifyinc/tts/types/created_voice.py

@@ -0,0 +1,28 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ...core.pydantic_utilities import UniversalBaseModel
+import typing
+from .created_voice_gender import CreatedVoiceGender
+from .create_voice_model import CreateVoiceModel
+from .created_voice_type import CreatedVoiceType
+from ...core.pydantic_utilities import IS_PYDANTIC_V2
+import pydantic
+
+
+class CreatedVoice(UniversalBaseModel):
+    avatar_image: typing.Optional[str] = None
+    display_name: typing.Optional[str] = None
+    gender: typing.Optional[CreatedVoiceGender] = None
+    locale: typing.Optional[str] = None
+    id: typing.Optional[str] = None
+    models: typing.Optional[typing.List[CreateVoiceModel]] = None
+    type: typing.Optional[CreatedVoiceType] = None
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

speechifyinc/tts/types/created_voice_gender.py

@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+CreatedVoiceGender = typing.Union[typing.Literal["male", "female", "notSpecified"], typing.Any]

speechifyinc/tts/types/created_voice_type.py

@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+CreatedVoiceType = typing.Union[typing.Literal["shared", "personal"], typing.Any]

speechifyinc/tts/types/experimental_stream_request.py

@@ -0,0 +1,49 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ...core.pydantic_utilities import UniversalBaseModel
+import pydantic
+import typing
+from .experimental_stream_request_model import ExperimentalStreamRequestModel
+from ...core.pydantic_utilities import IS_PYDANTIC_V2
+
+
+class ExperimentalStreamRequest(UniversalBaseModel):
+    """
+    ExperimentalStreamRequest is the wrapper for request parameters to the client
+    """
+
+    input: str = pydantic.Field()
+    """
+    Plain text or SSML to be synthesized to speech.
+    Refer to https://docs.sws.speechify.com/docs/api-limits for the input size limits.
+    Emotion, Pitch and Speed Rate are configured in the ssml input, please refer to the ssml documentation for more information: https://docs.sws.speechify.com/docs/ssml#prosody
+    """
+
+    language: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Language of the input. Follow the format of an ISO 639-1 language code and an ISO 3166-1 region code, separated by a hyphen, e.g. en-US.
+    Please refer to the list of the supported languages and recommendations regarding this parameter: https://docs.sws.speechify.com/docs/language-support.
+    """
+
+    model: typing.Optional[ExperimentalStreamRequestModel] = pydantic.Field(default=None)
+    """
+    Model used for audio synthesis
+    simba-base ModelBase  ModelBase is deprecated. Use simba-english or simba-multilingual instead.  @deprecated
+    simba-english ModelEnglish
+    simba-multilingual ModelMultilingual
+    simba-turbo ModelTurbo
+    """
+
+    voice_id: str = pydantic.Field()
+    """
+    Id of the voice to be used for synthesizing speech. Refer to /v1/voices endpoint for available voices
+    """
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

speechifyinc/tts/types/experimental_stream_request_model.py

@@ -0,0 +1,7 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+ExperimentalStreamRequestModel = typing.Union[
+    typing.Literal["simba-base", "simba-english", "simba-multilingual", "simba-turbo"], typing.Any
+]

speechifyinc/tts/types/experimental_stream_response.py

@@ -0,0 +1,33 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ...core.pydantic_utilities import UniversalBaseModel
+import typing
+import pydantic
+from ...core.pydantic_utilities import IS_PYDANTIC_V2
+
+
+class ExperimentalStreamResponse(UniversalBaseModel):
+    """
+    ExperimentalStreamResponse represents generated audio stream info
+    """
+
+    audio_url: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    URL to the synthesized audio file. It includes the expiration time and a signature in the query params.
+    The audio file will be available for download until the expiration time.
+    For the URL to work correctly, it must be used verbatim, with all the query parameters.
+    """
+
+    expires: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Expiry time of the audio file, in ISO-8601 format.
+    """
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

speechifyinc/tts/types/get_speech_options_request.py

@@ -0,0 +1,32 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ...core.pydantic_utilities import UniversalBaseModel
+import typing
+import pydantic
+from ...core.pydantic_utilities import IS_PYDANTIC_V2
+
+
+class GetSpeechOptionsRequest(UniversalBaseModel):
+    """
+    GetSpeechOptionsRequest is the wrapper for request parameters to the client
+    """
+
+    loudness_normalization: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Determines whether to normalize the audio loudness to a standard level.
+    When enabled, loudness normalization aligns the audio output to the following standards:
+    Integrated loudness: -14 LUFS
+    True peak: -2 dBTP
+    Loudness range: 7 LU
+    If disabled, the audio loudness will match the original loudness of the selected voice, which may vary significantly and be either too quiet or too loud.
+    Enabling loudness normalization can increase latency due to additional processing required for audio level adjustments.
+    """
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow