speechify-api 1.1.0__tar.gz → 1.2.1__tar.gz

{speechify_api-1.1.0 → speechify_api-1.2.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: speechify-api
-Version: 1.1.0
+Version: 1.2.1
 Summary: Official Speechify API SDK
 Keywords: speechify,ai,api,sdk,text-to-speech,tts
 Author: Speechify

{speechify_api-1.1.0 → speechify_api-1.2.1}/pyproject.toml

@@ -3,7 +3,7 @@ name = "speechify-api"
 
 [tool.poetry]
 name = "speechify-api"
-version = "1.1.0"
+version = "1.2.1"
 description = "Official Speechify API SDK"
 readme = "README.md"
 authors = [

{speechify_api-1.1.0 → speechify_api-1.2.1}/src/speechify/core/client_wrapper.py

@@ -22,7 +22,7 @@ class BaseClientWrapper:
         headers: typing.Dict[str, str] = {
             "X-Fern-Language": "Python",
             "X-Fern-SDK-Name": "speechify-api",
-            "X-Fern-SDK-Version": "1.1.0",
+            "X-Fern-SDK-Version": "1.2.1",
         }
         headers["Authorization"] = f"Bearer {self._get_token()}"
         return headers

{speechify_api-1.1.0 → speechify_api-1.2.1}/src/speechify/tts/__init__.py

@@ -28,7 +28,14 @@ from .types import (
     OAuthErrorError,
     SpeechMarks,
 )
-from .errors import BadRequestError, ForbiddenError, InternalServerError, NotFoundError, PaymentRequiredError
+from .errors import (
+    BadRequestError,
+    ForbiddenError,
+    InternalServerError,
+    NotFoundError,
+    PaymentRequiredError,
+    UnauthorizedError,
+)
 from . import audio, auth, voices
 from .audio import AudioStreamRequestAccept, GetSpeechRequestAudioFormat, GetSpeechRequestModel, GetStreamRequestModel
 from .auth import CreateAccessTokenRequestScope
@@ -71,6 +78,7 @@ __all__ = [
     "OAuthErrorError",
     "PaymentRequiredError",
     "SpeechMarks",
+    "UnauthorizedError",
     "VoicesCreateRequestGender",
     "audio",
     "auth",

{speechify_api-1.1.0 → speechify_api-1.2.1}/src/speechify/tts/audio/client.py

@@ -60,11 +60,7 @@ class AudioClient:
             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[GetSpeechRequestModel]
-            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
+            Model used for audio synthesis. `simba-base` and `simba-turbo` are deprecated. Use `simba-english` or `simba-multilingual` instead.
 
         options : typing.Optional[GetSpeechOptionsRequest]
 
@@ -192,11 +188,7 @@ class AudioClient:
             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[GetStreamRequestModel]
-            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
+            Model used for audio synthesis. `simba-base` and `simba-turbo` are deprecated. Use `simba-english` or `simba-multilingual` instead.
 
         options : typing.Optional[GetStreamOptionsRequest]
 
@@ -316,11 +308,7 @@ class AsyncAudioClient:
             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[GetSpeechRequestModel]
-            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
+            Model used for audio synthesis. `simba-base` and `simba-turbo` are deprecated. Use `simba-english` or `simba-multilingual` instead.
 
         options : typing.Optional[GetSpeechOptionsRequest]
 
@@ -456,11 +444,7 @@ class AsyncAudioClient:
             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[GetStreamRequestModel]
-            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
+            Model used for audio synthesis. `simba-base` and `simba-turbo` are deprecated. Use `simba-english` or `simba-multilingual` instead.
 
         options : typing.Optional[GetStreamOptionsRequest]
 

{speechify_api-1.1.0 → speechify_api-1.2.1}/src/speechify/tts/auth/client.py

@@ -26,7 +26,7 @@ class AuthClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> AccessToken:
         """
-        Create a new API token for the logged in user
+        WARNING: This endpoint is deprecated. Create a new API token for the logged in user.
 
         Parameters
         ----------
@@ -100,7 +100,7 @@ class AsyncAuthClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> AccessToken:
         """
-        Create a new API token for the logged in user
+        WARNING: This endpoint is deprecated. Create a new API token for the logged in user.
 
         Parameters
         ----------

{speechify_api-1.1.0 → speechify_api-1.2.1}/src/speechify/tts/errors/__init__.py

@@ -5,5 +5,13 @@ from .forbidden_error import ForbiddenError
 from .internal_server_error import InternalServerError
 from .not_found_error import NotFoundError
 from .payment_required_error import PaymentRequiredError
+from .unauthorized_error import UnauthorizedError
 
-__all__ = ["BadRequestError", "ForbiddenError", "InternalServerError", "NotFoundError", "PaymentRequiredError"]
+__all__ = [
+    "BadRequestError",
+    "ForbiddenError",
+    "InternalServerError",
+    "NotFoundError",
+    "PaymentRequiredError",
+    "UnauthorizedError",
+]

speechify_api-1.2.1/src/speechify/tts/errors/unauthorized_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 UnauthorizedError(ApiError):
+    def __init__(self, body: typing.Optional[typing.Any]):
+        super().__init__(status_code=401, body=body)

{speechify_api-1.1.0 → speechify_api-1.2.1}/src/speechify/tts/types/created_voice.py

@@ -11,12 +11,12 @@ 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
+    display_name: str
+    gender: CreatedVoiceGender
+    locale: str
+    id: str
+    models: typing.List[CreateVoiceModel]
+    type: CreatedVoiceType
 
     if IS_PYDANTIC_V2:
         model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

{speechify_api-1.1.0 → speechify_api-1.2.1}/src/speechify/tts/types/get_speech_response.py

@@ -1,30 +1,30 @@
 # This file was auto-generated by Fern from our API Definition.
 
 from ...core.pydantic_utilities import UniversalBaseModel
-import typing
 import pydantic
 from .get_speech_response_audio_format import GetSpeechResponseAudioFormat
 from .speech_marks import SpeechMarks
 from ...core.pydantic_utilities import IS_PYDANTIC_V2
+import typing
 
 
 class GetSpeechResponse(UniversalBaseModel):
-    audio_data: typing.Optional[str] = pydantic.Field(default=None)
+    audio_data: str = pydantic.Field()
     """
     Synthesized speech audio, Base64-encoded
     """
 
-    audio_format: typing.Optional[GetSpeechResponseAudioFormat] = pydantic.Field(default=None)
+    audio_format: GetSpeechResponseAudioFormat = pydantic.Field()
     """
     The format of the audio data
     """
 
-    billable_characters_count: typing.Optional[int] = pydantic.Field(default=None)
+    billable_characters_count: int = pydantic.Field()
     """
     The number of billable characters processed in the request.
     """
 
-    speech_marks: typing.Optional[SpeechMarks] = None
+    speech_marks: SpeechMarks
 
     if IS_PYDANTIC_V2:
         model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

{speechify_api-1.1.0 → speechify_api-1.2.1}/src/speechify/tts/types/get_voice.py

@@ -11,14 +11,14 @@ import pydantic
 
 class GetVoice(UniversalBaseModel):
     avatar_image: typing.Optional[str] = None
-    display_name: typing.Optional[str] = None
-    gender: typing.Optional[GetVoiceGender] = None
-    locale: typing.Optional[str] = None
-    id: typing.Optional[str] = None
-    models: typing.Optional[typing.List[GetVoicesModel]] = None
+    display_name: str
+    gender: GetVoiceGender
+    locale: str
+    id: str
+    models: typing.List[GetVoicesModel]
     preview_audio: typing.Optional[str] = None
     tags: typing.Optional[typing.List[str]] = None
-    type: typing.Optional[GetVoiceType] = None
+    type: GetVoiceType
 
     if IS_PYDANTIC_V2:
         model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

{speechify_api-1.1.0 → speechify_api-1.2.1}/src/speechify/tts/types/get_voice_language.py

@@ -7,7 +7,7 @@ import pydantic
 
 
 class GetVoiceLanguage(UniversalBaseModel):
-    locale: typing.Optional[str] = None
+    locale: str
     preview_audio: typing.Optional[str] = None
 
     if IS_PYDANTIC_V2:

{speechify_api-1.1.0 → speechify_api-1.2.1}/src/speechify/tts/types/get_voices_model.py

@@ -9,8 +9,8 @@ import pydantic
 
 
 class GetVoicesModel(UniversalBaseModel):
-    languages: typing.Optional[typing.List[GetVoiceLanguage]] = None
-    name: typing.Optional[GetVoicesModelName] = None
+    languages: typing.List[GetVoiceLanguage]
+    name: GetVoicesModelName
 
     if IS_PYDANTIC_V2:
         model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

{speechify_api-1.1.0 → speechify_api-1.2.1}/src/speechify/tts/types/speech_marks.py

@@ -12,16 +12,16 @@ class SpeechMarks(UniversalBaseModel):
     It is used to annotate the audio data with metadata about the synthesis process, like word timing or phoneme details.
     """
 
-    chunks: typing.Optional[typing.List[NestedChunk]] = pydantic.Field(default=None)
+    chunks: typing.List[NestedChunk] = pydantic.Field()
     """
     Array of NestedChunk, each providing detailed segment information within the synthesized speech.
     """
 
-    end: typing.Optional[int] = None
-    end_time: typing.Optional[float] = None
-    start: typing.Optional[int] = None
-    start_time: typing.Optional[float] = None
-    type: typing.Optional[str] = None
+    end: int
+    end_time: float
+    start: int
+    start_time: float
+    type: str
     value: typing.Optional[str] = None
 
     if IS_PYDANTIC_V2:

{speechify_api-1.1.0 → speechify_api-1.2.1}/src/speechify/tts/voices/client.py

@@ -15,6 +15,7 @@ from ..types.created_voice import CreatedVoice
 from ..errors.bad_request_error import BadRequestError
 from ..errors.payment_required_error import PaymentRequiredError
 from ...core.jsonable_encoder import jsonable_encoder
+from ..errors.unauthorized_error import UnauthorizedError
 from ...core.client_wrapper import AsyncClientWrapper
 
 # this is used as the default value for optional parameters
@@ -277,6 +278,82 @@ class VoicesClient:
             raise ApiError(status_code=_response.status_code, body=_response.text)
         raise ApiError(status_code=_response.status_code, body=_response_json)
 
+    def download_sample(
+        self, id: str, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> typing.Iterator[bytes]:
+        """
+        Download a personal (cloned) voice sample
+
+        Parameters
+        ----------
+        id : str
+            The ID of the voice to download sample for
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration. You can pass in configuration such as `chunk_size`, and more to customize the request and response.
+
+        Yields
+        ------
+        typing.Iterator[bytes]
+            Voice sample audio file
+        """
+        with self._client_wrapper.httpx_client.stream(
+            f"v1/voices/{jsonable_encoder(id)}/sample",
+            method="GET",
+            request_options=request_options,
+        ) as _response:
+            try:
+                if 200 <= _response.status_code < 300:
+                    _chunk_size = request_options.get("chunk_size", None) if request_options is not None else None
+                    for _chunk in _response.iter_bytes(chunk_size=_chunk_size):
+                        yield _chunk
+                    return
+                _response.read()
+                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(),
+                            ),
+                        )
+                    )
+                if _response.status_code == 401:
+                    raise UnauthorizedError(
+                        typing.cast(
+                            typing.Optional[typing.Any],
+                            parse_obj_as(
+                                type_=typing.Optional[typing.Any],  # type: ignore
+                                object_=_response.json(),
+                            ),
+                        )
+                    )
+                if _response.status_code == 404:
+                    raise NotFoundError(
+                        typing.cast(
+                            typing.Optional[typing.Any],
+                            parse_obj_as(
+                                type_=typing.Optional[typing.Any],  # type: ignore
+                                object_=_response.json(),
+                            ),
+                        )
+                    )
+                if _response.status_code == 500:
+                    raise InternalServerError(
+                        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 AsyncVoicesClient:
     def __init__(self, *, client_wrapper: AsyncClientWrapper):
@@ -557,3 +634,79 @@ class AsyncVoicesClient:
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
         raise ApiError(status_code=_response.status_code, body=_response_json)
+
+    async def download_sample(
+        self, id: str, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> typing.AsyncIterator[bytes]:
+        """
+        Download a personal (cloned) voice sample
+
+        Parameters
+        ----------
+        id : str
+            The ID of the voice to download sample for
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration. You can pass in configuration such as `chunk_size`, and more to customize the request and response.
+
+        Yields
+        ------
+        typing.AsyncIterator[bytes]
+            Voice sample audio file
+        """
+        async with self._client_wrapper.httpx_client.stream(
+            f"v1/voices/{jsonable_encoder(id)}/sample",
+            method="GET",
+            request_options=request_options,
+        ) as _response:
+            try:
+                if 200 <= _response.status_code < 300:
+                    _chunk_size = request_options.get("chunk_size", None) if request_options is not None else None
+                    async for _chunk in _response.aiter_bytes(chunk_size=_chunk_size):
+                        yield _chunk
+                    return
+                await _response.aread()
+                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(),
+                            ),
+                        )
+                    )
+                if _response.status_code == 401:
+                    raise UnauthorizedError(
+                        typing.cast(
+                            typing.Optional[typing.Any],
+                            parse_obj_as(
+                                type_=typing.Optional[typing.Any],  # type: ignore
+                                object_=_response.json(),
+                            ),
+                        )
+                    )
+                if _response.status_code == 404:
+                    raise NotFoundError(
+                        typing.cast(
+                            typing.Optional[typing.Any],
+                            parse_obj_as(
+                                type_=typing.Optional[typing.Any],  # type: ignore
+                                object_=_response.json(),
+                            ),
+                        )
+                    )
+                if _response.status_code == 500:
+                    raise InternalServerError(
+                        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)