telnyx 3.5.0a0__py3-none-any.whl → 3.6.0__py3-none-any.whl

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/telnyx_transcription_language.py

@@ -0,0 +1,108 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing_extensions import Literal, TypeAlias
+
+__all__ = ["TelnyxTranscriptionLanguage"]
+
+TelnyxTranscriptionLanguage: TypeAlias = 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",
+]

telnyx/types/calls/transcription_engine_b_config_param.py

@@ -4,112 +4,13 @@ from __future__ import annotations
 
 from typing_extensions import Literal, TypedDict
 
+from .telnyx_transcription_language import TelnyxTranscriptionLanguage
+
 __all__ = ["TranscriptionEngineBConfigParam"]
 
 
 class TranscriptionEngineBConfigParam(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: TelnyxTranscriptionLanguage
     """Language to use for speech recognition"""
 
     transcription_engine: Literal["B"]

telnyx/types/calls/transcription_start_request_param.py

@@ -2,15 +2,166 @@
 
 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 .telnyx_transcription_language import TelnyxTranscriptionLanguage
 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: TelnyxTranscriptionLanguage
+    """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 +178,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_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/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/document_upload_json_params.py

@@ -0,0 +1,39 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Union
+from typing_extensions import Required, Annotated, TypeAlias, TypedDict
+
+from .._types import Base64FileInput
+from .._utils import PropertyInfo
+
+__all__ = ["DocumentUploadJsonParams", "DocServiceDocumentUploadURL", "DocServiceDocumentUploadInline"]
+
+
+class DocServiceDocumentUploadURL(TypedDict, total=False):
+    url: Required[str]
+    """
+    If the file is already hosted publicly, you can provide a URL and have the
+    documents service fetch it for you.
+    """
+
+    customer_reference: str
+    """Optional reference string for customer tracking."""
+
+    filename: str
+    """The filename of the document."""
+
+
+class DocServiceDocumentUploadInline(TypedDict, total=False):
+    file: Required[Annotated[Union[str, Base64FileInput], PropertyInfo(format="base64")]]
+    """The Base64 encoded contents of the file you are uploading."""
+
+    customer_reference: str
+    """A customer reference string for customer look ups."""
+
+    filename: str
+    """The filename of the document."""
+
+
+DocumentUploadJsonParams: TypeAlias = Union[DocServiceDocumentUploadURL, DocServiceDocumentUploadInline]

telnyx/types/document_upload_json_response.py

@@ -0,0 +1,12 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+
+from .._models import BaseModel
+from .doc_service_document import DocServiceDocument
+
+__all__ = ["DocumentUploadJsonResponse"]
+
+
+class DocumentUploadJsonResponse(BaseModel):
+    data: Optional[DocServiceDocument] = None

telnyx/types/legacy/__init__.py

@@ -0,0 +1,3 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations

telnyx/types/legacy/reporting/__init__.py

@@ -0,0 +1,12 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from .filter import Filter as Filter
+from .filter_param import FilterParam as FilterParam
+from .usage_report_retrieve_speech_to_text_params import (
+    UsageReportRetrieveSpeechToTextParams as UsageReportRetrieveSpeechToTextParams,
+)
+from .usage_report_retrieve_speech_to_text_response import (
+    UsageReportRetrieveSpeechToTextResponse as UsageReportRetrieveSpeechToTextResponse,
+)

telnyx/types/legacy/reporting/batch_detail_records/__init__.py

@@ -0,0 +1,24 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from .voice_create_params import VoiceCreateParams as VoiceCreateParams
+from .voice_list_response import VoiceListResponse as VoiceListResponse
+from .voice_create_response import VoiceCreateResponse as VoiceCreateResponse
+from .voice_delete_response import VoiceDeleteResponse as VoiceDeleteResponse
+from .messaging_create_params import MessagingCreateParams as MessagingCreateParams
+from .messaging_list_response import MessagingListResponse as MessagingListResponse
+from .voice_retrieve_response import VoiceRetrieveResponse as VoiceRetrieveResponse
+from .batch_csv_pagination_meta import BatchCsvPaginationMeta as BatchCsvPaginationMeta
+from .cdr_detailed_req_response import CdrDetailedReqResponse as CdrDetailedReqResponse
+from .messaging_create_response import MessagingCreateResponse as MessagingCreateResponse
+from .messaging_delete_response import MessagingDeleteResponse as MessagingDeleteResponse
+from .mdr_detail_report_response import MdrDetailReportResponse as MdrDetailReportResponse
+from .stt_detail_report_response import SttDetailReportResponse as SttDetailReportResponse
+from .messaging_retrieve_response import MessagingRetrieveResponse as MessagingRetrieveResponse
+from .speech_to_text_create_params import SpeechToTextCreateParams as SpeechToTextCreateParams
+from .speech_to_text_list_response import SpeechToTextListResponse as SpeechToTextListResponse
+from .speech_to_text_create_response import SpeechToTextCreateResponse as SpeechToTextCreateResponse
+from .speech_to_text_delete_response import SpeechToTextDeleteResponse as SpeechToTextDeleteResponse
+from .voice_retrieve_fields_response import VoiceRetrieveFieldsResponse as VoiceRetrieveFieldsResponse
+from .speech_to_text_retrieve_response import SpeechToTextRetrieveResponse as SpeechToTextRetrieveResponse

telnyx/types/legacy/reporting/batch_detail_records/batch_csv_pagination_meta.py

@@ -0,0 +1,17 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+
+from ....._models import BaseModel
+
+__all__ = ["BatchCsvPaginationMeta"]
+
+
+class BatchCsvPaginationMeta(BaseModel):
+    page_number: Optional[int] = None
+
+    page_size: Optional[int] = None
+
+    total_pages: Optional[int] = None
+
+    total_results: Optional[int] = None