telnyx 3.3.0a0__py3-none-any.whl → 3.4.0__py3-none-any.whl

telnyx/types/ai/voice_settings_param.py

@@ -2,9 +2,49 @@
 
 from __future__ import annotations
 
-from typing_extensions import Required, TypedDict
+from typing import Union
+from typing_extensions import Literal, Required, TypeAlias, TypedDict
 
-__all__ = ["VoiceSettingsParam"]
+__all__ = [
+    "VoiceSettingsParam",
+    "BackgroundAudio",
+    "BackgroundAudioUnionMember0",
+    "BackgroundAudioUnionMember1",
+    "BackgroundAudioUnionMember2",
+]
+
+
+class BackgroundAudioUnionMember0(TypedDict, total=False):
+    type: Required[Literal["predefined_media"]]
+    """Select from predefined media options."""
+
+    value: Required[Literal["silence", "office"]]
+    """The predefined media to use. `silence` disables background audio."""
+
+
+class BackgroundAudioUnionMember1(TypedDict, total=False):
+    type: Required[Literal["media_url"]]
+    """Provide a direct URL to an MP3 file. The audio will loop during the call."""
+
+    value: Required[str]
+    """HTTPS URL to an MP3 file."""
+
+
+class BackgroundAudioUnionMember2(TypedDict, total=False):
+    type: Required[Literal["media_name"]]
+    """Reference a previously uploaded media by its name from Telnyx Media Storage."""
+
+    value: Required[str]
+    """
+    The `name` of a media asset created via
+    [Media Storage API](https://developers.telnyx.com/api/media-storage/create-media-storage).
+    The audio will loop during the call.
+    """
+
+
+BackgroundAudio: TypeAlias = Union[
+    BackgroundAudioUnionMember0, BackgroundAudioUnionMember1, BackgroundAudioUnionMember2
+]
 
 
 class VoiceSettingsParam(TypedDict, total=False):
@@ -28,6 +68,13 @@ class VoiceSettingsParam(TypedDict, total=False):
     with this integration.
     """
 
+    background_audio: BackgroundAudio
+    """Optional background audio to play on the call.
+
+    Use a predefined media bed, or supply a looped MP3 URL. If a media URL is chosen
+    in the portal, customers can preview it before saving.
+    """
+
     voice_speed: float
     """The speed of the voice in the range [0.25, 2.0].
 

telnyx/types/brand_create_params.py

@@ -31,7 +31,8 @@ class BrandCreateParams(TypedDict, total=False):
     business_contact_email: Annotated[str, PropertyInfo(alias="businessContactEmail")]
     """Business contact email.
 
-    Required if `entityType` is `PUBLIC_PROFIT`.
+    Required if `entityType` is `PUBLIC_PROFIT`. Otherwise, it is recommended to
+    either omit this field or set it to `null`.
     """
 
     city: str

telnyx/types/brand_update_params.py

@@ -39,7 +39,8 @@ class BrandUpdateParams(TypedDict, total=False):
     business_contact_email: Annotated[str, PropertyInfo(alias="businessContactEmail")]
     """Business contact email.
 
-    Required if `entityType` will be changed to `PUBLIC_PROFIT`.
+    Required if `entityType` will be changed to `PUBLIC_PROFIT`. Otherwise, it is
+    recommended to either omit this field or set it to `null`.
     """
 
     city: str

telnyx/types/bundle_pricing/billing_bundle_list_params.py

@@ -2,9 +2,10 @@
 
 from __future__ import annotations
 
-from typing import List
 from typing_extensions import TypedDict
 
+from ..._types import SequenceNotStr
+
 __all__ = ["BillingBundleListParams", "Filter", "Page"]
 
 
@@ -27,10 +28,10 @@ class BillingBundleListParams(TypedDict, total=False):
 
 
 class Filter(TypedDict, total=False):
-    country_iso: List[str]
+    country_iso: SequenceNotStr[str]
     """Filter by country code."""
 
-    resource: List[str]
+    resource: SequenceNotStr[str]
     """Filter by resource."""
 
 

telnyx/types/bundle_pricing/user_bundle_list_params.py

@@ -2,9 +2,10 @@
 
 from __future__ import annotations
 
-from typing import List
 from typing_extensions import TypedDict
 
+from ..._types import SequenceNotStr
+
 __all__ = ["UserBundleListParams", "Filter", "Page"]
 
 
@@ -27,10 +28,10 @@ class UserBundleListParams(TypedDict, total=False):
 
 
 class Filter(TypedDict, total=False):
-    country_iso: List[str]
+    country_iso: SequenceNotStr[str]
     """Filter by country code."""
 
-    resource: List[str]
+    resource: SequenceNotStr[str]
     """Filter by resource."""
 
 

telnyx/types/bundle_pricing/user_bundle_list_unused_params.py

@@ -2,9 +2,10 @@
 
 from __future__ import annotations
 
-from typing import List
 from typing_extensions import TypedDict
 
+from ..._types import SequenceNotStr
+
 __all__ = ["UserBundleListUnusedParams", "Filter"]
 
 
@@ -21,8 +22,8 @@ class UserBundleListUnusedParams(TypedDict, total=False):
 
 
 class Filter(TypedDict, total=False):
-    country_iso: List[str]
+    country_iso: SequenceNotStr[str]
     """Filter by country code."""
 
-    resource: List[str]
+    resource: SequenceNotStr[str]
     """Filter by resource."""

telnyx/types/call_control_application_update_params.py

@@ -2,9 +2,10 @@
 
 from __future__ import annotations
 
-from typing import List, Optional
+from typing import Optional
 from typing_extensions import Literal, Required, TypedDict
 
+from .._types import SequenceNotStr
 from .call_control_application_inbound_param import CallControlApplicationInboundParam
 from .call_control_application_outbound_param import CallControlApplicationOutboundParam
 
@@ -57,7 +58,7 @@ class CallControlApplicationUpdateParams(TypedDict, total=False):
     protect PII data entered through IVR interactions.
     """
 
-    tags: List[str]
+    tags: SequenceNotStr[str]
     """Tags assigned to the Call Control Application."""
 
     webhook_api_version: Literal["1", "2"]

telnyx/types/call_dial_params.py

@@ -2,9 +2,10 @@
 
 from __future__ import annotations
 
-from typing import List, Union, Iterable
+from typing import Union, Iterable
 from typing_extensions import Literal, Required, Annotated, TypedDict
 
+from .._types import SequenceNotStr
 from .._utils import PropertyInfo
 from .stream_codec import StreamCodec
 from .sip_header_param import SipHeaderParam
@@ -32,7 +33,7 @@ class CallDialParams(TypedDict, total=False):
     number). The number should be in +E164 format.
     """
 
-    to: Required[Union[str, List[str]]]
+    to: Required[Union[str, SequenceNotStr[str]]]
     """The DID or SIP URI to dial out to.
 
     Multiple DID or SIP URIs can be provided using an array of strings
@@ -138,6 +139,14 @@ class CallDialParams(TypedDict, total=False):
     WAV or MP3 file.
     """
 
+    park_after_unbridge: str
+    """If supplied with the value `self`, the current leg will be parked after
+    unbridge.
+
+    If not set, the default behavior is to hang up the leg. When park_after_unbridge
+    is set, link_to becomes required.
+    """
+
     preferred_codecs: str
     """
     The list of comma-separated codecs in a preferred order for the forked media to
@@ -224,7 +233,7 @@ class CallDialParams(TypedDict, total=False):
     stream_bidirectional_mode: StreamBidirectionalMode
     """Configures method of bidirectional streaming (mp3, rtp)."""
 
-    stream_bidirectional_sampling_rate: Literal[8000, 16000, 48000]
+    stream_bidirectional_sampling_rate: Literal[8000, 16000, 22050, 24000, 48000]
     """Audio sampling rate."""
 
     stream_bidirectional_target_legs: StreamBidirectionalTargetLegs
@@ -234,8 +243,7 @@ class CallDialParams(TypedDict, total=False):
     """Specifies the codec to be used for the streamed audio.
 
     When set to 'default' or when transcoding is not possible, the codec from the
-    call will be used. Currently, transcoding is only supported between PCMU and
-    PCMA codecs.
+    call will be used.
     """
 
     stream_establish_before_call_originate: bool
@@ -427,7 +435,7 @@ class ConferenceConfig(TypedDict, total=False):
     Defaults to "none".
     """
 
-    whisper_call_control_ids: List[str]
+    whisper_call_control_ids: SequenceNotStr[str]
     """Array of unique call_control_ids the joining supervisor can whisper to.
 
     If none provided, the supervisor will join the conference as a monitoring

telnyx/types/calls/action_answer_params.py

@@ -124,8 +124,7 @@ class ActionAnswerParams(TypedDict, total=False):
     """Specifies the codec to be used for the streamed audio.
 
     When set to 'default' or when transcoding is not possible, the codec from the
-    call will be used. Currently, transcoding is only supported between PCMU and
-    PCMA codecs.
+    call will be used.
     """
 
     stream_track: Literal["inbound_track", "outbound_track", "both_tracks"]

telnyx/types/calls/action_gather_using_ai_params.py

@@ -67,20 +67,17 @@ class ActionGatherUsingAIParams(TypedDict, total=False):
     """Default is `false`.
 
     If set to `true`, the voice assistant will send updates to the message history
-    via the `call.ai_gather.message_history_updated`
-    [callback](https://developers.telnyx.com/api/call-control/call-gather-using-ai#callbacks)
-    in real time as the message history is updated.
+    via the `call.ai_gather.message_history_updated` callback in real time as the
+    message history is updated.
     """
 
     send_partial_results: bool
     """Default is `false`.
 
     If set to `true`, the voice assistant will send partial results via the
-    `call.ai_gather.partial_results`
-    [callback](https://developers.telnyx.com/api/call-control/call-gather-using-ai#callbacks)
-    in real time as individual fields are gathered. If set to `false`, the voice
-    assistant will only send the final result via the `call.ai_gather.ended`
-    callback.
+    `call.ai_gather.partial_results` callback in real time as individual fields are
+    gathered. If set to `false`, the voice assistant will only send the final result
+    via the `call.ai_gather.ended` callback.
     """
 
     transcription: TranscriptionConfigParam

telnyx/types/calls/action_start_streaming_params.py

@@ -41,6 +41,9 @@ class ActionStartStreamingParams(TypedDict, total=False):
     stream_bidirectional_mode: StreamBidirectionalMode
     """Configures method of bidirectional streaming (mp3, rtp)."""
 
+    stream_bidirectional_sampling_rate: Literal[8000, 16000, 22050, 24000, 48000]
+    """Audio sampling rate."""
+
     stream_bidirectional_target_legs: StreamBidirectionalTargetLegs
     """Specifies which call legs should receive the bidirectional stream audio."""
 
@@ -48,8 +51,7 @@ class ActionStartStreamingParams(TypedDict, total=False):
     """Specifies the codec to be used for the streamed audio.
 
     When set to 'default' or when transcoding is not possible, the codec from the
-    call will be used. Currently, transcoding is only supported between PCMU and
-    PCMA codecs.
+    call will be used.
     """
 
     stream_track: Literal["inbound_track", "outbound_track", "both_tracks"]

telnyx/types/calls/action_start_transcription_params.py

@@ -2,13 +2,22 @@
 
 from __future__ import annotations
 
-from typing import Union
-from typing_extensions import Literal, TypeAlias, TypedDict
+from typing import Union, Iterable
+from typing_extensions import Literal, Required, TypeAlias, TypedDict
 
+from ..._types import SequenceNotStr
+from .google_transcription_language import GoogleTranscriptionLanguage
 from .transcription_engine_a_config_param import TranscriptionEngineAConfigParam
 from .transcription_engine_b_config_param import TranscriptionEngineBConfigParam
 
-__all__ = ["ActionStartTranscriptionParams", "TranscriptionEngineConfig"]
+__all__ = [
+    "ActionStartTranscriptionParams",
+    "TranscriptionEngineConfig",
+    "TranscriptionEngineConfigTranscriptionEngineGoogleConfig",
+    "TranscriptionEngineConfigTranscriptionEngineGoogleConfigSpeechContext",
+    "TranscriptionEngineConfigTranscriptionEngineTelnyxConfig",
+    "TranscriptionEngineConfigTranscriptionEngineDeepgramConfig",
+]
 
 
 class ActionStartTranscriptionParams(TypedDict, total=False):
@@ -25,8 +34,12 @@ class ActionStartTranscriptionParams(TypedDict, total=False):
     `call_control_id`.
     """
 
-    transcription_engine: Literal["A", "B"]
-    """Engine to use for speech recognition. `A` - `Google`, `B` - `Telnyx`."""
+    transcription_engine: Literal["Google", "Telnyx", "Deepgram", "A", "B"]
+    """Engine to use for speech recognition.
+
+    Legacy values `A` - `Google`, `B` - `Telnyx` are supported for backward
+    compatibility.
+    """
 
     transcription_engine_config: TranscriptionEngineConfig
 
@@ -38,4 +51,245 @@ class ActionStartTranscriptionParams(TypedDict, total=False):
     """
 
 
-TranscriptionEngineConfig: TypeAlias = Union[TranscriptionEngineAConfigParam, TranscriptionEngineBConfigParam]
+class TranscriptionEngineConfigTranscriptionEngineGoogleConfigSpeechContext(TypedDict, total=False):
+    boost: float
+    """Boost factor for the speech context."""
+
+    phrases: SequenceNotStr[str]
+
+
+class TranscriptionEngineConfigTranscriptionEngineGoogleConfig(TypedDict, total=False):
+    enable_speaker_diarization: bool
+    """Enables speaker diarization."""
+
+    hints: SequenceNotStr[str]
+    """Hints to improve transcription accuracy."""
+
+    interim_results: bool
+    """Whether to send also interim results.
+
+    If set to false, only final results will be sent.
+    """
+
+    language: GoogleTranscriptionLanguage
+    """Language to use for speech recognition"""
+
+    max_speaker_count: int
+    """Defines maximum number of speakers in the conversation."""
+
+    min_speaker_count: int
+    """Defines minimum number of speakers in the conversation."""
+
+    model: Literal[
+        "latest_long",
+        "latest_short",
+        "command_and_search",
+        "phone_call",
+        "video",
+        "default",
+        "medical_conversation",
+        "medical_dictation",
+    ]
+    """The model to use for transcription."""
+
+    profanity_filter: bool
+    """Enables profanity_filter."""
+
+    speech_context: Iterable[TranscriptionEngineConfigTranscriptionEngineGoogleConfigSpeechContext]
+    """Speech context to improve transcription accuracy."""
+
+    transcription_engine: Literal["Google"]
+    """Engine identifier for Google transcription service"""
+
+    use_enhanced: bool
+    """Enables enhanced transcription, this works for models `phone_call` and `video`."""
+
+
+class TranscriptionEngineConfigTranscriptionEngineTelnyxConfig(TypedDict, total=False):
+    language: Literal[
+        "en",
+        "zh",
+        "de",
+        "es",
+        "ru",
+        "ko",
+        "fr",
+        "ja",
+        "pt",
+        "tr",
+        "pl",
+        "ca",
+        "nl",
+        "ar",
+        "sv",
+        "it",
+        "id",
+        "hi",
+        "fi",
+        "vi",
+        "he",
+        "uk",
+        "el",
+        "ms",
+        "cs",
+        "ro",
+        "da",
+        "hu",
+        "ta",
+        "no",
+        "th",
+        "ur",
+        "hr",
+        "bg",
+        "lt",
+        "la",
+        "mi",
+        "ml",
+        "cy",
+        "sk",
+        "te",
+        "fa",
+        "lv",
+        "bn",
+        "sr",
+        "az",
+        "sl",
+        "kn",
+        "et",
+        "mk",
+        "br",
+        "eu",
+        "is",
+        "hy",
+        "ne",
+        "mn",
+        "bs",
+        "kk",
+        "sq",
+        "sw",
+        "gl",
+        "mr",
+        "pa",
+        "si",
+        "km",
+        "sn",
+        "yo",
+        "so",
+        "af",
+        "oc",
+        "ka",
+        "be",
+        "tg",
+        "sd",
+        "gu",
+        "am",
+        "yi",
+        "lo",
+        "uz",
+        "fo",
+        "ht",
+        "ps",
+        "tk",
+        "nn",
+        "mt",
+        "sa",
+        "lb",
+        "my",
+        "bo",
+        "tl",
+        "mg",
+        "as",
+        "tt",
+        "haw",
+        "ln",
+        "ha",
+        "ba",
+        "jw",
+        "su",
+        "auto_detect",
+    ]
+    """Language to use for speech recognition"""
+
+    transcription_engine: Literal["Telnyx"]
+    """Engine identifier for Telnyx transcription service"""
+
+    transcription_model: Literal["openai/whisper-tiny", "openai/whisper-large-v3-turbo"]
+    """The model to use for transcription."""
+
+
+class TranscriptionEngineConfigTranscriptionEngineDeepgramConfig(TypedDict, total=False):
+    transcription_engine: Required[Literal["Deepgram"]]
+    """Engine identifier for Deepgram transcription service"""
+
+    transcription_model: Required[Literal["deepgram/nova-2", "deepgram/nova-3"]]
+    """The model to use for transcription."""
+
+    language: Literal[
+        "bg",
+        "ca",
+        "zh",
+        "zh-CN",
+        "zh-Hans",
+        "zh-TW",
+        "zh-Hant",
+        "zh-HK",
+        "cs",
+        "da",
+        "da-DK",
+        "nl",
+        "en",
+        "en-US",
+        "en-AU",
+        "en-GB",
+        "en-NZ",
+        "en-IN",
+        "et",
+        "fi",
+        "nl-BE",
+        "fr",
+        "fr-CA",
+        "de",
+        "de-CH",
+        "el",
+        "hi",
+        "hu",
+        "id",
+        "it",
+        "ja",
+        "ko",
+        "ko-KR",
+        "lv",
+        "lt",
+        "ms",
+        "no",
+        "pl",
+        "pt",
+        "pt-BR",
+        "pt-PT",
+        "ro",
+        "ru",
+        "sk",
+        "es",
+        "es-419",
+        "sv",
+        "sv-SE",
+        "th",
+        "th-TH",
+        "tr",
+        "uk",
+        "vi",
+        "auto_detect",
+    ]
+    """Language to use for speech recognition.
+
+    Available languages depend on the selected model.
+    """
+
+
+TranscriptionEngineConfig: TypeAlias = Union[
+    TranscriptionEngineConfigTranscriptionEngineGoogleConfig,
+    TranscriptionEngineConfigTranscriptionEngineTelnyxConfig,
+    TranscriptionEngineConfigTranscriptionEngineDeepgramConfig,
+    TranscriptionEngineAConfigParam,
+    TranscriptionEngineBConfigParam,
+]

telnyx/types/calls/action_transfer_params.py

@@ -102,6 +102,56 @@ class ActionTransferParams(TypedDict, total=False):
     behavior is to hang up the leg.
     """
 
+    record: Literal["record-from-answer"]
+    """Start recording automatically after an event. Disabled by default."""
+
+    record_channels: Literal["single", "dual"]
+    """
+    Defines which channel should be recorded ('single' or 'dual') when `record` is
+    specified.
+    """
+
+    record_custom_file_name: str
+    """The custom recording file name to be used instead of the default `call_leg_id`.
+
+    Telnyx will still add a Unix timestamp suffix.
+    """
+
+    record_format: Literal["wav", "mp3"]
+    """
+    Defines the format of the recording ('wav' or 'mp3') when `record` is specified.
+    """
+
+    record_max_length: int
+    """
+    Defines the maximum length for the recording in seconds when `record` is
+    specified. The minimum value is 0. The maximum value is 43200. The default value
+    is 0 (infinite).
+    """
+
+    record_timeout_secs: int
+    """
+    The number of seconds that Telnyx will wait for the recording to be stopped if
+    silence is detected when `record` is specified. The timer only starts when the
+    speech is detected. Please note that call transcription is used to detect
+    silence and the related charge will be applied. The minimum value is 0. The
+    default value is 0 (infinite).
+    """
+
+    record_track: Literal["both", "inbound", "outbound"]
+    """The audio track to be recorded.
+
+    Can be either `both`, `inbound` or `outbound`. If only single track is specified
+    (`inbound`, `outbound`), `channels` configuration is ignored and it will be
+    recorded as mono (single channel).
+    """
+
+    record_trim: Literal["trim-silence"]
+    """
+    When set to `trim-silence`, silence will be removed from the beginning and end
+    of the recording.
+    """
+
     sip_auth_password: str
     """SIP Authentication password used for SIP challenges."""
 

telnyx/types/calls/transcription_engine_a_config_param.py

@@ -2,9 +2,10 @@
 
 from __future__ import annotations
 
-from typing import List, Iterable
+from typing import Iterable
 from typing_extensions import Literal, TypedDict
 
+from ..._types import SequenceNotStr
 from .google_transcription_language import GoogleTranscriptionLanguage
 
 __all__ = ["TranscriptionEngineAConfigParam", "SpeechContext"]
@@ -14,14 +15,14 @@ class SpeechContext(TypedDict, total=False):
     boost: float
     """Boost factor for the speech context."""
 
-    phrases: List[str]
+    phrases: SequenceNotStr[str]
 
 
 class TranscriptionEngineAConfigParam(TypedDict, total=False):
     enable_speaker_diarization: bool
     """Enables speaker diarization."""
 
-    hints: List[str]
+    hints: SequenceNotStr[str]
     """Hints to improve transcription accuracy."""
 
     interim_results: bool