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

telnyx/types/calls/transcription_start_request_param.py

@@ -2,15 +2,266 @@
 
 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__ = ["TranscriptionStartRequestParam", "TranscriptionEngineConfig"]
+__all__ = [
+    "TranscriptionStartRequestParam",
+    "TranscriptionEngineConfig",
+    "TranscriptionEngineConfigTranscriptionEngineGoogleConfig",
+    "TranscriptionEngineConfigTranscriptionEngineGoogleConfigSpeechContext",
+    "TranscriptionEngineConfigTranscriptionEngineTelnyxConfig",
+    "TranscriptionEngineConfigTranscriptionEngineDeepgramConfig",
+]
 
-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,
+]
 
 
 class TranscriptionStartRequestParam(TypedDict, total=False):
@@ -27,8 +278,12 @@ class TranscriptionStartRequestParam(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
 

telnyx/types/campaign_builder_create_params.py

@@ -2,9 +2,10 @@
 
 from __future__ import annotations
 
-from typing import List, Iterable
+from typing import Iterable
 from typing_extensions import Required, Annotated, TypedDict
 
+from .._types import SequenceNotStr
 from .._utils import PropertyInfo
 
 __all__ = ["CampaignBuilderCreateParams"]
@@ -122,14 +123,14 @@ class CampaignBuilderCreateParams(TypedDict, total=False):
     subscriber_optout: Annotated[bool, PropertyInfo(alias="subscriberOptout")]
     """Does campaign support subscriber opt-out keyword(s)?"""
 
-    sub_usecases: Annotated[List[str], PropertyInfo(alias="subUsecases")]
+    sub_usecases: Annotated[SequenceNotStr[str], PropertyInfo(alias="subUsecases")]
     """Campaign sub-usecases.
 
     Must be of defined valid sub-usecase types. Use `/registry/enum/usecase`
     operation to retrieve list of valid sub-usecases
     """
 
-    tag: List[str]
+    tag: SequenceNotStr[str]
     """Tags to be set on the Campaign."""
 
     terms_and_conditions: Annotated[bool, PropertyInfo(alias="termsAndConditions")]

telnyx/types/campaign_submit_appeal_response.py

@@ -11,6 +11,3 @@ __all__ = ["CampaignSubmitAppealResponse"]
 class CampaignSubmitAppealResponse(BaseModel):
     appealed_at: Optional[datetime] = None
     """Timestamp when the appeal was submitted"""
-
-    previous_status: Optional[str] = None
-    """Previous campaign status (currently always null)"""

telnyx/types/conferences/action_hold_params.py

@@ -2,9 +2,10 @@
 
 from __future__ import annotations
 
-from typing import List
 from typing_extensions import TypedDict
 
+from ..._types import SequenceNotStr
+
 __all__ = ["ActionHoldParams"]
 
 
@@ -15,7 +16,7 @@ class ActionHoldParams(TypedDict, total=False):
     media_name and audio_url cannot be used together in one request.
     """
 
-    call_control_ids: List[str]
+    call_control_ids: SequenceNotStr[str]
     """List of unique identifiers and tokens for controlling the call.
 
     When empty all participants will be placed on hold.

telnyx/types/conferences/action_join_params.py

@@ -2,9 +2,10 @@
 
 from __future__ import annotations
 
-from typing import List
 from typing_extensions import Literal, Required, TypedDict
 
+from ..._types import SequenceNotStr
+
 __all__ = ["ActionJoinParams"]
 
 
@@ -92,7 +93,7 @@ class ActionJoinParams(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/conferences/action_mute_params.py

@@ -2,14 +2,15 @@
 
 from __future__ import annotations
 
-from typing import List
 from typing_extensions import TypedDict
 
+from ..._types import SequenceNotStr
+
 __all__ = ["ActionMuteParams"]
 
 
 class ActionMuteParams(TypedDict, total=False):
-    call_control_ids: List[str]
+    call_control_ids: SequenceNotStr[str]
     """Array of unique identifiers and tokens for controlling the call.
 
     When empty all participants will be muted.

telnyx/types/conferences/action_play_params.py

@@ -2,9 +2,9 @@
 
 from __future__ import annotations
 
-from typing import List
 from typing_extensions import TypedDict
 
+from ..._types import SequenceNotStr
 from ..calls.loopcount_param import LoopcountParam
 
 __all__ = ["ActionPlayParams"]
@@ -17,7 +17,7 @@ class ActionPlayParams(TypedDict, total=False):
     media_name and audio_url cannot be used together in one request.
     """
 
-    call_control_ids: List[str]
+    call_control_ids: SequenceNotStr[str]
     """
     List of call control ids identifying participants the audio file should be
     played to. If not given, the audio file will be played to the entire conference.

telnyx/types/conferences/action_speak_params.py

@@ -2,9 +2,10 @@
 
 from __future__ import annotations
 
-from typing import List, Union
+from typing import Union
 from typing_extensions import Literal, Required, TypeAlias, TypedDict
 
+from ..._types import SequenceNotStr
 from ..calls.aws_voice_settings_param import AwsVoiceSettingsParam
 from ..calls.telnyx_voice_settings_param import TelnyxVoiceSettingsParam
 from ..calls.eleven_labs_voice_settings_param import ElevenLabsVoiceSettingsParam
@@ -47,7 +48,7 @@ class ActionSpeakParams(TypedDict, total=False):
     female).
     """
 
-    call_control_ids: List[str]
+    call_control_ids: SequenceNotStr[str]
     """Call Control IDs of participants who will hear the spoken text.
 
     When empty all participants will hear the spoken text.

telnyx/types/conferences/action_stop_params.py

@@ -2,14 +2,15 @@
 
 from __future__ import annotations
 
-from typing import List
 from typing_extensions import TypedDict
 
+from ..._types import SequenceNotStr
+
 __all__ = ["ActionStopParams"]
 
 
 class ActionStopParams(TypedDict, total=False):
-    call_control_ids: List[str]
+    call_control_ids: SequenceNotStr[str]
     """
     List of call control ids identifying participants the audio file should stop be
     played to. If not given, the audio will be stoped to the entire conference.

telnyx/types/conferences/action_unhold_params.py

@@ -2,14 +2,15 @@
 
 from __future__ import annotations
 
-from typing import List
 from typing_extensions import Required, TypedDict
 
+from ..._types import SequenceNotStr
+
 __all__ = ["ActionUnholdParams"]
 
 
 class ActionUnholdParams(TypedDict, total=False):
-    call_control_ids: Required[List[str]]
+    call_control_ids: Required[SequenceNotStr[str]]
     """List of unique identifiers and tokens for controlling the call.
 
     Enter each call control ID to be unheld.

telnyx/types/conferences/action_unmute_params.py

@@ -2,14 +2,15 @@
 
 from __future__ import annotations
 
-from typing import List
 from typing_extensions import TypedDict
 
+from ..._types import SequenceNotStr
+
 __all__ = ["ActionUnmuteParams"]
 
 
 class ActionUnmuteParams(TypedDict, total=False):
-    call_control_ids: List[str]
+    call_control_ids: SequenceNotStr[str]
     """List of unique identifiers and tokens for controlling the call.
 
     Enter each call control ID to be unmuted. When empty all participants will be

telnyx/types/conferences/action_update_params.py

@@ -2,9 +2,10 @@
 
 from __future__ import annotations
 
-from typing import List
 from typing_extensions import Literal, Required, TypedDict
 
+from ..._types import SequenceNotStr
+
 __all__ = ["ActionUpdateParams"]
 
 
@@ -29,7 +30,7 @@ class ActionUpdateParams(TypedDict, total=False):
     has already been executed.
     """
 
-    whisper_call_control_ids: List[str]
+    whisper_call_control_ids: SequenceNotStr[str]
     """Array of unique call_control_ids the supervisor can whisper to.
 
     If none provided, the supervisor will join the conference as a monitoring

telnyx/types/country_coverage_retrieve_country_response.py

@@ -10,6 +10,8 @@ __all__ = ["CountryCoverageRetrieveCountryResponse", "Data", "DataLocal", "DataT
 class DataLocal(BaseModel):
     features: Optional[List[str]] = None
 
+    full_pstn_replacement: Optional[bool] = None
+
     international_sms: Optional[bool] = None
 
     p2p: Optional[bool] = None
@@ -22,6 +24,8 @@ class DataLocal(BaseModel):
 class DataTollFree(BaseModel):
     features: Optional[List[str]] = None
 
+    full_pstn_replacement: Optional[bool] = None
+
     international_sms: Optional[bool] = None
 
     p2p: Optional[bool] = None
@@ -59,6 +63,9 @@ class Data(BaseModel):
     quickship: Optional[bool] = None
     """Supports quickship"""
 
+    region: Optional[str] = None
+    """Geographic region (e.g., AMER, EMEA, APAC)"""
+
     reservable: Optional[bool] = None
     """Supports reservable"""
 

telnyx/types/country_coverage_retrieve_response.py

@@ -10,6 +10,8 @@ __all__ = ["CountryCoverageRetrieveResponse", "Data", "DataLocal", "DataTollFree
 class DataLocal(BaseModel):
     features: Optional[List[str]] = None
 
+    full_pstn_replacement: Optional[bool] = None
+
     international_sms: Optional[bool] = None
 
     p2p: Optional[bool] = None
@@ -22,6 +24,8 @@ class DataLocal(BaseModel):
 class DataTollFree(BaseModel):
     features: Optional[List[str]] = None
 
+    full_pstn_replacement: Optional[bool] = None
+
     international_sms: Optional[bool] = None
 
     p2p: Optional[bool] = None
@@ -59,6 +63,9 @@ class Data(BaseModel):
     quickship: Optional[bool] = None
     """Supports quickship"""
 
+    region: Optional[str] = None
+    """Geographic region (e.g., AMER, EMEA, APAC)"""
+
     reservable: Optional[bool] = None
     """Supports reservable"""
 

telnyx/types/credential_connection_create_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 .dtmf_type import DtmfType
 from .encrypted_media import EncryptedMedia
 from .anchorsite_override import AnchorsiteOverride
@@ -96,7 +97,7 @@ class CredentialConnectionCreateParams(TypedDict, total=False):
     account (internal).
     """
 
-    tags: List[str]
+    tags: SequenceNotStr[str]
     """Tags associated with the connection."""
 
     webhook_api_version: Literal["1", "2", "texml"]

telnyx/types/credential_connection_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, TypedDict
 
+from .._types import SequenceNotStr
 from .dtmf_type import DtmfType
 from .encrypted_media import EncryptedMedia
 from .anchorsite_override import AnchorsiteOverride
@@ -89,7 +90,7 @@ class CredentialConnectionUpdateParams(TypedDict, total=False):
     account (internal).
     """
 
-    tags: List[str]
+    tags: SequenceNotStr[str]
     """Tags associated with the connection."""
 
     user_name: str

telnyx/types/credential_inbound_param.py

@@ -2,9 +2,10 @@
 
 from __future__ import annotations
 
-from typing import List
 from typing_extensions import Literal, TypedDict
 
+from .._types import SequenceNotStr
+
 __all__ = ["CredentialInboundParam"]
 
 
@@ -21,7 +22,7 @@ class CredentialInboundParam(TypedDict, total=False):
     associated with this connection.
     """
 
-    codecs: List[str]
+    codecs: SequenceNotStr[str]
     """
     Defines the list of codecs that Telnyx will send for inbound calls to a specific
     number on your portal account, in priority order. This only works when the

telnyx/types/customer_service_record_list_params.py

@@ -6,6 +6,7 @@ from typing import List, Union
 from datetime import datetime
 from typing_extensions import Literal, Annotated, TypedDict
 
+from .._types import SequenceNotStr
 from .._utils import PropertyInfo
 
 __all__ = [
@@ -49,7 +50,7 @@ class FilterCreatedAt(TypedDict, total=False):
 _FilterPhoneNumberReservedKeywords = TypedDict(
     "_FilterPhoneNumberReservedKeywords",
     {
-        "in": List[str],
+        "in": SequenceNotStr[str],
     },
     total=False,
 )

telnyx/types/customer_service_record_verify_phone_number_coverage_params.py

@@ -2,12 +2,13 @@
 
 from __future__ import annotations
 
-from typing import List
 from typing_extensions import Required, TypedDict
 
+from .._types import SequenceNotStr
+
 __all__ = ["CustomerServiceRecordVerifyPhoneNumberCoverageParams"]
 
 
 class CustomerServiceRecordVerifyPhoneNumberCoverageParams(TypedDict, total=False):
-    phone_numbers: Required[List[str]]
+    phone_numbers: Required[SequenceNotStr[str]]
     """The phone numbers list to be verified."""

telnyx/types/detail_record_list_params.py

@@ -2,9 +2,11 @@
 
 from __future__ import annotations
 
-from typing import Dict, List, Union
+from typing import Dict, Union
 from typing_extensions import Literal, Required, TypeAlias, TypedDict
 
+from .._types import SequenceNotStr
+
 __all__ = ["DetailRecordListParams", "Filter", "Page"]
 
 
@@ -22,7 +24,7 @@ class DetailRecordListParams(TypedDict, total=False):
     Originally: page[number], page[size]
     """
 
-    sort: List[str]
+    sort: SequenceNotStr[str]
     """Specifies the sort order for results. <br/>Example: sort=-created_at"""