telnyx 3.7.0a0__py3-none-any.whl → 3.8.0__py3-none-any.whl

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_status_update_webhook_event1.py

@@ -0,0 +1,26 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+
+from pydantic import Field as FieldInfo
+
+from .._models import BaseModel
+
+__all__ = ["CampaignStatusUpdateWebhookEvent"]
+
+
+class CampaignStatusUpdateWebhookEvent(BaseModel):
+    brand_id: Optional[str] = FieldInfo(alias="brandId", default=None)
+    """Brand ID associated with the campaign."""
+
+    campaign_id: Optional[str] = FieldInfo(alias="campaignId", default=None)
+    """The ID of the campaign."""
+
+    create_date: Optional[str] = FieldInfo(alias="createDate", default=None)
+    """Unix timestamp when campaign was created."""
+
+    csp_id: Optional[str] = FieldInfo(alias="cspId", default=None)
+    """Alphanumeric identifier of the CSP associated with this campaign."""
+
+    is_t_mobile_registered: Optional[bool] = FieldInfo(alias="isTMobileRegistered", default=None)
+    """Indicates whether the campaign is registered with T-Mobile."""

telnyx/types/conference_created_webhook_event1.py

@@ -0,0 +1,53 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+from datetime import datetime
+from typing_extensions import Literal
+
+from .._models import BaseModel
+
+__all__ = ["ConferenceCreatedWebhookEvent", "Data", "DataPayload"]
+
+
+class DataPayload(BaseModel):
+    call_control_id: Optional[str] = None
+    """Call ID used to issue commands via Call Control API."""
+
+    call_leg_id: Optional[str] = None
+    """ID that is unique to the call and can be used to correlate webhook events."""
+
+    call_session_id: Optional[str] = None
+    """
+    ID that is unique to the call session and can be used to correlate webhook
+    events. Call session is a group of related call legs that logically belong to
+    the same phone call, e.g. an inbound and outbound leg of a transferred call.
+    """
+
+    client_state: Optional[str] = None
+    """State received from a command."""
+
+    conference_id: Optional[str] = None
+    """Conference ID that the participant joined."""
+
+    connection_id: Optional[str] = None
+    """Call Control App ID (formerly Telnyx connection ID) used in the call."""
+
+    occurred_at: Optional[datetime] = None
+    """ISO 8601 datetime of when the event occurred."""
+
+
+class Data(BaseModel):
+    id: Optional[str] = None
+    """Identifies the type of resource."""
+
+    event_type: Optional[Literal["conference.created"]] = None
+    """The type of event being delivered."""
+
+    payload: Optional[DataPayload] = None
+
+    record_type: Optional[Literal["event"]] = None
+    """Identifies the type of the resource."""
+
+
+class ConferenceCreatedWebhookEvent(BaseModel):
+    data: Optional[Data] = None

telnyx/types/conference_ended_webhook_event1.py

@@ -0,0 +1,56 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+from datetime import datetime
+from typing_extensions import Literal
+
+from .._models import BaseModel
+
+__all__ = ["ConferenceEndedWebhookEvent", "Data", "DataPayload"]
+
+
+class DataPayload(BaseModel):
+    call_control_id: Optional[str] = None
+    """Call ID used to issue commands via Call Control API."""
+
+    call_leg_id: Optional[str] = None
+    """ID that is unique to the call and can be used to correlate webhook events."""
+
+    call_session_id: Optional[str] = None
+    """
+    ID that is unique to the call session and can be used to correlate webhook
+    events. Call session is a group of related call legs that logically belong to
+    the same phone call, e.g. an inbound and outbound leg of a transferred call.
+    """
+
+    client_state: Optional[str] = None
+    """State received from a command."""
+
+    conference_id: Optional[str] = None
+    """Conference ID that the participant joined."""
+
+    connection_id: Optional[str] = None
+    """Call Control App ID (formerly Telnyx connection ID) used in the call."""
+
+    occurred_at: Optional[datetime] = None
+    """ISO 8601 datetime of when the event occurred."""
+
+    reason: Optional[Literal["all_left", "host_left", "time_exceeded"]] = None
+    """Reason the conference ended."""
+
+
+class Data(BaseModel):
+    id: Optional[str] = None
+    """Identifies the type of resource."""
+
+    event_type: Optional[Literal["conference.ended"]] = None
+    """The type of event being delivered."""
+
+    payload: Optional[DataPayload] = None
+
+    record_type: Optional[Literal["event"]] = None
+    """Identifies the type of the resource."""
+
+
+class ConferenceEndedWebhookEvent(BaseModel):
+    data: Optional[Data] = None

telnyx/types/conference_floor_changed_webhook_event1.py

@@ -0,0 +1,45 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+from datetime import datetime
+from typing_extensions import Literal
+
+from .._models import BaseModel
+
+__all__ = ["ConferenceFloorChangedWebhookEvent", "Payload"]
+
+
+class Payload(BaseModel):
+    call_control_id: Optional[str] = None
+    """Call Control ID of the new speaker."""
+
+    call_leg_id: Optional[str] = None
+    """Call Leg ID of the new speaker."""
+
+    call_session_id: Optional[str] = None
+    """Call Session ID of the new speaker."""
+
+    client_state: Optional[str] = None
+    """State received from a command."""
+
+    conference_id: Optional[str] = None
+    """Conference ID that had a speaker change event."""
+
+    connection_id: Optional[str] = None
+    """Call Control App ID (formerly Telnyx connection ID) used in the call."""
+
+    occurred_at: Optional[datetime] = None
+    """ISO 8601 datetime of when the event occurred."""
+
+
+class ConferenceFloorChangedWebhookEvent(BaseModel):
+    id: Optional[str] = None
+    """Identifies the type of resource."""
+
+    event_type: Optional[Literal["conference.floor.changed"]] = None
+    """The type of event being delivered."""
+
+    payload: Optional[Payload] = None
+
+    record_type: Optional[Literal["event"]] = None
+    """Identifies the type of the resource."""

telnyx/types/conference_participant_joined_webhook_event1.py

@@ -0,0 +1,53 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+from datetime import datetime
+from typing_extensions import Literal
+
+from .._models import BaseModel
+
+__all__ = ["ConferenceParticipantJoinedWebhookEvent", "Data", "DataPayload"]
+
+
+class DataPayload(BaseModel):
+    call_control_id: Optional[str] = None
+    """Call ID used to issue commands via Call Control API."""
+
+    call_leg_id: Optional[str] = None
+    """ID that is unique to the call and can be used to correlate webhook events."""
+
+    call_session_id: Optional[str] = None
+    """
+    ID that is unique to the call session and can be used to correlate webhook
+    events. Call session is a group of related call legs that logically belong to
+    the same phone call, e.g. an inbound and outbound leg of a transferred call.
+    """
+
+    client_state: Optional[str] = None
+    """State received from a command."""
+
+    conference_id: Optional[str] = None
+    """Conference ID that the participant joined."""
+
+    connection_id: Optional[str] = None
+    """Call Control App ID (formerly Telnyx connection ID) used in the call."""
+
+
+class Data(BaseModel):
+    id: Optional[str] = None
+    """Identifies the type of resource."""
+
+    event_type: Optional[Literal["conference.participant.joined"]] = None
+    """The type of event being delivered."""
+
+    occurred_at: Optional[datetime] = None
+    """ISO 8601 datetime of when the event occurred."""
+
+    payload: Optional[DataPayload] = None
+
+    record_type: Optional[Literal["event"]] = None
+    """Identifies the type of the resource."""
+
+
+class ConferenceParticipantJoinedWebhookEvent(BaseModel):
+    data: Optional[Data] = None

telnyx/types/conference_participant_left_webhook_event1.py

@@ -0,0 +1,53 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+from datetime import datetime
+from typing_extensions import Literal
+
+from .._models import BaseModel
+
+__all__ = ["ConferenceParticipantLeftWebhookEvent", "Data", "DataPayload"]
+
+
+class DataPayload(BaseModel):
+    call_control_id: Optional[str] = None
+    """Call ID used to issue commands via Call Control API."""
+
+    call_leg_id: Optional[str] = None
+    """ID that is unique to the call and can be used to correlate webhook events."""
+
+    call_session_id: Optional[str] = None
+    """
+    ID that is unique to the call session and can be used to correlate webhook
+    events. Call session is a group of related call legs that logically belong to
+    the same phone call, e.g. an inbound and outbound leg of a transferred call.
+    """
+
+    client_state: Optional[str] = None
+    """State received from a command."""
+
+    conference_id: Optional[str] = None
+    """Conference ID that the participant joined."""
+
+    connection_id: Optional[str] = None
+    """Call Control App ID (formerly Telnyx connection ID) used in the call."""
+
+
+class Data(BaseModel):
+    id: Optional[str] = None
+    """Identifies the type of resource."""
+
+    event_type: Optional[Literal["conference.participant.left"]] = None
+    """The type of event being delivered."""
+
+    occurred_at: Optional[datetime] = None
+    """ISO 8601 datetime of when the event occurred."""
+
+    payload: Optional[DataPayload] = None
+
+    record_type: Optional[Literal["event"]] = None
+    """Identifies the type of the resource."""
+
+
+class ConferenceParticipantLeftWebhookEvent(BaseModel):
+    data: Optional[Data] = None

telnyx/types/conference_participant_playback_ended_webhook_event1.py

@@ -0,0 +1,65 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+from datetime import datetime
+from typing_extensions import Literal
+
+from .._models import BaseModel
+
+__all__ = ["ConferenceParticipantPlaybackEndedWebhookEvent", "Data", "DataPayload"]
+
+
+class DataPayload(BaseModel):
+    call_control_id: Optional[str] = None
+    """Participant's call ID used to issue commands via Call Control API."""
+
+    call_leg_id: Optional[str] = None
+    """ID that is unique to the call and can be used to correlate webhook events."""
+
+    call_session_id: Optional[str] = None
+    """
+    ID that is unique to the call session and can be used to correlate webhook
+    events. Call session is a group of related call legs that logically belong to
+    the same phone call, e.g. an inbound and outbound leg of a transferred call.
+    """
+
+    client_state: Optional[str] = None
+    """State received from a command."""
+
+    conference_id: Optional[str] = None
+    """ID of the conference the text was spoken in."""
+
+    connection_id: Optional[str] = None
+    """Call Control App ID (formerly Telnyx connection ID) used in the call."""
+
+    creator_call_session_id: Optional[str] = None
+    """ID that is unique to the call session that started the conference."""
+
+    media_name: Optional[str] = None
+    """
+    The name of the audio media file being played back, if media_name has been used
+    to start.
+    """
+
+    media_url: Optional[str] = None
+    """The audio URL being played back, if audio_url has been used to start."""
+
+    occurred_at: Optional[datetime] = None
+    """ISO 8601 datetime of when the event occurred."""
+
+
+class Data(BaseModel):
+    id: Optional[str] = None
+    """Identifies the type of resource."""
+
+    event_type: Optional[Literal["conference.participant.playback.ended"]] = None
+    """The type of event being delivered."""
+
+    payload: Optional[DataPayload] = None
+
+    record_type: Optional[Literal["event"]] = None
+    """Identifies the type of the resource."""
+
+
+class ConferenceParticipantPlaybackEndedWebhookEvent(BaseModel):
+    data: Optional[Data] = None

telnyx/types/conference_participant_playback_started_webhook_event1.py

@@ -0,0 +1,65 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+from datetime import datetime
+from typing_extensions import Literal
+
+from .._models import BaseModel
+
+__all__ = ["ConferenceParticipantPlaybackStartedWebhookEvent", "Data", "DataPayload"]
+
+
+class DataPayload(BaseModel):
+    call_control_id: Optional[str] = None
+    """Participant's call ID used to issue commands via Call Control API."""
+
+    call_leg_id: Optional[str] = None
+    """ID that is unique to the call and can be used to correlate webhook events."""
+
+    call_session_id: Optional[str] = None
+    """
+    ID that is unique to the call session and can be used to correlate webhook
+    events. Call session is a group of related call legs that logically belong to
+    the same phone call, e.g. an inbound and outbound leg of a transferred call.
+    """
+
+    client_state: Optional[str] = None
+    """State received from a command."""
+
+    conference_id: Optional[str] = None
+    """ID of the conference the text was spoken in."""
+
+    connection_id: Optional[str] = None
+    """Call Control App ID (formerly Telnyx connection ID) used in the call."""
+
+    creator_call_session_id: Optional[str] = None
+    """ID that is unique to the call session that started the conference."""
+
+    media_name: Optional[str] = None
+    """
+    The name of the audio media file being played back, if media_name has been used
+    to start.
+    """
+
+    media_url: Optional[str] = None
+    """The audio URL being played back, if audio_url has been used to start."""
+
+    occurred_at: Optional[datetime] = None
+    """ISO 8601 datetime of when the event occurred."""
+
+
+class Data(BaseModel):
+    id: Optional[str] = None
+    """Identifies the type of resource."""
+
+    event_type: Optional[Literal["conference.participant.playback.started"]] = None
+    """The type of event being delivered."""
+
+    payload: Optional[DataPayload] = None
+
+    record_type: Optional[Literal["event"]] = None
+    """Identifies the type of the resource."""
+
+
+class ConferenceParticipantPlaybackStartedWebhookEvent(BaseModel):
+    data: Optional[Data] = None

telnyx/types/conference_participant_speak_ended_webhook_event1.py

@@ -0,0 +1,56 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+from datetime import datetime
+from typing_extensions import Literal
+
+from .._models import BaseModel
+
+__all__ = ["ConferenceParticipantSpeakEndedWebhookEvent", "Data", "DataPayload"]
+
+
+class DataPayload(BaseModel):
+    call_control_id: Optional[str] = None
+    """Participant's call ID used to issue commands via Call Control API."""
+
+    call_leg_id: Optional[str] = None
+    """ID that is unique to the call and can be used to correlate webhook events."""
+
+    call_session_id: Optional[str] = None
+    """
+    ID that is unique to the call session and can be used to correlate webhook
+    events. Call session is a group of related call legs that logically belong to
+    the same phone call, e.g. an inbound and outbound leg of a transferred call.
+    """
+
+    client_state: Optional[str] = None
+    """State received from a command."""
+
+    conference_id: Optional[str] = None
+    """ID of the conference the text was spoken in."""
+
+    connection_id: Optional[str] = None
+    """Call Control App ID (formerly Telnyx connection ID) used in the call."""
+
+    creator_call_session_id: Optional[str] = None
+    """ID that is unique to the call session that started the conference."""
+
+    occurred_at: Optional[datetime] = None
+    """ISO 8601 datetime of when the event occurred."""
+
+
+class Data(BaseModel):
+    id: Optional[str] = None
+    """Identifies the type of resource."""
+
+    event_type: Optional[Literal["conference.participant.speak.ended"]] = None
+    """The type of event being delivered."""
+
+    payload: Optional[DataPayload] = None
+
+    record_type: Optional[Literal["event"]] = None
+    """Identifies the type of the resource."""
+
+
+class ConferenceParticipantSpeakEndedWebhookEvent(BaseModel):
+    data: Optional[Data] = None