telnyx 3.0.0a0__py3-none-any.whl → 3.1.0__py3-none-any.whl

telnyx/types/call_streaming_failed_webhook_event.py

@@ -0,0 +1,70 @@
+# 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__ = ["CallStreamingFailedWebhookEvent", "Data", "DataPayload", "DataPayloadStreamParams"]
+
+
+class DataPayloadStreamParams(BaseModel):
+    stream_url: Optional[str] = None
+    """The destination WebSocket address where the stream is going to be delivered."""
+
+    track: Optional[Literal["inbound_track", "outbound_track", "both_tracks"]] = None
+    """Specifies which track should be streamed."""
+
+
+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."""
+
+    connection_id: Optional[str] = None
+    """Call Control App ID (formerly Telnyx connection ID) used in the call."""
+
+    failure_reason: Optional[str] = None
+    """A short description explaning why the media streaming failed."""
+
+    stream_id: Optional[str] = None
+    """Identifies the streaming."""
+
+    stream_params: Optional[DataPayloadStreamParams] = None
+    """Streaming parameters as they were originally given to the Call Control API."""
+
+    stream_type: Optional[Literal["websocket", "dialogflow"]] = None
+    """The type of stream connection the stream is performing."""
+
+
+class Data(BaseModel):
+    id: Optional[str] = None
+    """Identifies the type of resource."""
+
+    event_type: Optional[Literal["streaming.failed"]] = 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 resource."""
+
+
+class CallStreamingFailedWebhookEvent(BaseModel):
+    data: Optional[Data] = None

telnyx/types/call_streaming_started_webhook_event.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__ = ["CallStreamingStartedWebhookEvent", "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."""
+
+    connection_id: Optional[str] = None
+    """Call Control App ID (formerly Telnyx connection ID) used in the call."""
+
+    stream_url: Optional[str] = None
+    """Destination WebSocket address where the stream is going to be delivered."""
+
+
+class Data(BaseModel):
+    id: Optional[str] = None
+    """Identifies the type of resource."""
+
+    event_type: Optional[Literal["streaming.started"]] = 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 CallStreamingStartedWebhookEvent(BaseModel):
+    data: Optional[Data] = None

telnyx/types/call_streaming_stopped_webhook_event.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__ = ["CallStreamingStoppedWebhookEvent", "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."""
+
+    connection_id: Optional[str] = None
+    """Call Control App ID (formerly Telnyx connection ID) used in the call."""
+
+    stream_url: Optional[str] = None
+    """Destination WebSocket address where the stream is going to be delivered."""
+
+
+class Data(BaseModel):
+    id: Optional[str] = None
+    """Identifies the type of resource."""
+
+    event_type: Optional[Literal["streaming.stopped"]] = 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 CallStreamingStoppedWebhookEvent(BaseModel):
+    data: Optional[Data] = None

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_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

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_status_update_webhook_event.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/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/conference_created_webhook_event.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_event.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_event.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_event.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_event.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