telnyx 3.6.0__py3-none-any.whl → 3.7.0__py3-none-any.whl

telnyx/types/streaming_failed_webhook_event1.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__ = ["StreamingFailedWebhookEvent", "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 StreamingFailedWebhookEvent(BaseModel):
+    data: Optional[Data] = None

telnyx/types/streaming_started_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__ = ["StreamingStartedWebhookEvent", "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 StreamingStartedWebhookEvent(BaseModel):
+    data: Optional[Data] = None

telnyx/types/streaming_stopped_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__ = ["StreamingStoppedWebhookEvent", "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 StreamingStoppedWebhookEvent(BaseModel):
+    data: Optional[Data] = None

telnyx/types/transcription_webhook_event1.py

@@ -0,0 +1,72 @@
+# 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__ = ["TranscriptionWebhookEvent", "Data", "DataPayload", "DataPayloadTranscriptionData"]
+
+
+class DataPayloadTranscriptionData(BaseModel):
+    confidence: Optional[float] = None
+    """Speech recognition confidence level."""
+
+    is_final: Optional[bool] = None
+    """When false, it means that this is an interim result."""
+
+    transcript: Optional[str] = None
+    """Recognized text."""
+
+    transcription_track: Optional[Literal["inbound", "outbound"]] = None
+    """Indicates which leg of the call has been transcribed.
+
+    This is only available when `transcription_engine` is set to `B`.
+    """
+
+
+class DataPayload(BaseModel):
+    call_control_id: Optional[str] = None
+    """Unique identifier and token for controlling the call."""
+
+    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
+    """Use this field to add state to every subsequent webhook.
+
+    It must be a valid Base-64 encoded string.
+    """
+
+    connection_id: Optional[str] = None
+    """Call Control App ID (formerly Telnyx connection ID) used in the call."""
+
+    transcription_data: Optional[DataPayloadTranscriptionData] = None
+
+
+class Data(BaseModel):
+    id: Optional[str] = None
+    """Identifies the type of resource."""
+
+    event_type: Optional[Literal["call.transcription"]] = 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 TranscriptionWebhookEvent(BaseModel):
+    data: Optional[Data] = None

telnyx/types/unsafe_unwrap_webhook_event.py

@@ -0,0 +1,138 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Union
+from typing_extensions import TypeAlias
+
+from .fax_failed_webhook_event import FaxFailedWebhookEvent
+from .fax_queued_webhook_event import FaxQueuedWebhookEvent
+from .call_hangup_webhook_event import CallHangupWebhookEvent
+from .call_bridged_webhook_event import CallBridgedWebhookEvent
+from .call_answered_webhook_event import CallAnsweredWebhookEvent
+from .call_enqueued_webhook_event import CallEnqueuedWebhookEvent
+from .fax_delivered_webhook_event import FaxDeliveredWebhookEvent
+from .transcription_webhook_event import TranscriptionWebhookEvent
+from .call_initiated_webhook_event import CallInitiatedWebhookEvent
+from .call_left_queue_webhook_event import CallLeftQueueWebhookEvent
+from .delivery_update_webhook_event import DeliveryUpdateWebhookEvent
+from .inbound_message_webhook_event import InboundMessageWebhookEvent
+from .call_speak_ended_webhook_event import CallSpeakEndedWebhookEvent
+from .conference_ended_webhook_event import ConferenceEndedWebhookEvent
+from .streaming_failed_webhook_event import StreamingFailedWebhookEvent
+from .call_fork_started_webhook_event import CallForkStartedWebhookEvent
+from .call_fork_stopped_webhook_event import CallForkStoppedWebhookEvent
+from .call_gather_ended_webhook_event import CallGatherEndedWebhookEvent
+from .call_refer_failed_webhook_event import CallReferFailedWebhookEvent
+from .streaming_started_webhook_event import StreamingStartedWebhookEvent
+from .streaming_stopped_webhook_event import StreamingStoppedWebhookEvent
+from .call_dtmf_received_webhook_event import CallDtmfReceivedWebhookEvent
+from .call_refer_started_webhook_event import CallReferStartedWebhookEvent
+from .call_siprec_failed_webhook_event import CallSiprecFailedWebhookEvent
+from .call_speak_started_webhook_event import CallSpeakStartedWebhookEvent
+from .conference_created_webhook_event import ConferenceCreatedWebhookEvent
+from .call_playback_ended_webhook_event import CallPlaybackEndedWebhookEvent
+from .call_siprec_started_webhook_event import CallSiprecStartedWebhookEvent
+from .call_siprec_stopped_webhook_event import CallSiprecStoppedWebhookEvent
+from .fax_media_processed_webhook_event import FaxMediaProcessedWebhookEvent
+from .fax_sending_started_webhook_event import FaxSendingStartedWebhookEvent
+from .replaced_link_click_webhook_event import ReplacedLinkClickWebhookEvent
+from .call_ai_gather_ended_webhook_event import CallAIGatherEndedWebhookEvent
+from .call_recording_error_webhook_event import CallRecordingErrorWebhookEvent
+from .call_recording_saved_webhook_event import CallRecordingSavedWebhookEvent
+from .call_refer_completed_webhook_event import CallReferCompletedWebhookEvent
+from .call_playback_started_webhook_event import CallPlaybackStartedWebhookEvent
+from .call_streaming_failed_webhook_event import CallStreamingFailedWebhookEvent
+from .call_streaming_started_webhook_event import CallStreamingStartedWebhookEvent
+from .call_streaming_stopped_webhook_event import CallStreamingStoppedWebhookEvent
+from .campaign_status_update_webhook_event import CampaignStatusUpdateWebhookEvent
+from .conference_speak_ended_webhook_event import ConferenceSpeakEndedWebhookEvent
+from .call_conversation_ended_webhook_event import CallConversationEndedWebhookEvent
+from .conference_floor_changed_webhook_event import ConferenceFloorChangedWebhookEvent
+from .conference_speak_started_webhook_event import ConferenceSpeakStartedWebhookEvent
+from .conference_playback_ended_webhook_event import ConferencePlaybackEndedWebhookEvent
+from .conference_recording_saved_webhook_event import ConferenceRecordingSavedWebhookEvent
+from .number_order_status_update_webhook_event import NumberOrderStatusUpdateWebhookEvent
+from .call_machine_greeting_ended_webhook_event import CallMachineGreetingEndedWebhookEvent
+from .conference_participant_left_webhook_event import ConferenceParticipantLeftWebhookEvent
+from .conference_playback_started_webhook_event import ConferencePlaybackStartedWebhookEvent
+from .call_machine_detection_ended_webhook_event import CallMachineDetectionEndedWebhookEvent
+from .conference_participant_joined_webhook_event import ConferenceParticipantJoinedWebhookEvent
+from .call_ai_gather_partial_results_webhook_event import CallAIGatherPartialResultsWebhookEvent
+from .call_recording_transcription_saved_webhook_event import CallRecordingTranscriptionSavedWebhookEvent
+from .conference_participant_speak_ended_webhook_event import ConferenceParticipantSpeakEndedWebhookEvent
+from .call_machine_premium_greeting_ended_webhook_event import CallMachinePremiumGreetingEndedWebhookEvent
+from .call_conversation_insights_generated_webhook_event import CallConversationInsightsGeneratedWebhookEvent
+from .call_machine_premium_detection_ended_webhook_event import CallMachinePremiumDetectionEndedWebhookEvent
+from .conference_participant_speak_started_webhook_event import ConferenceParticipantSpeakStartedWebhookEvent
+from .conference_participant_playback_ended_webhook_event import ConferenceParticipantPlaybackEndedWebhookEvent
+from .call_ai_gather_message_history_updated_webhook_event import CallAIGatherMessageHistoryUpdatedWebhookEvent
+from .customer_service_record_status_changed_webhook_event import CustomerServiceRecordStatusChangedWebhookEvent
+from .conference_participant_playback_started_webhook_event import ConferenceParticipantPlaybackStartedWebhookEvent
+
+__all__ = ["UnsafeUnwrapWebhookEvent"]
+
+UnsafeUnwrapWebhookEvent: TypeAlias = Union[
+    CallAIGatherEndedWebhookEvent,
+    CallAIGatherMessageHistoryUpdatedWebhookEvent,
+    CallAIGatherPartialResultsWebhookEvent,
+    CustomerServiceRecordStatusChangedWebhookEvent,
+    CallAnsweredWebhookEvent,
+    CallBridgedWebhookEvent,
+    CallConversationEndedWebhookEvent,
+    CallConversationInsightsGeneratedWebhookEvent,
+    CallDtmfReceivedWebhookEvent,
+    CallEnqueuedWebhookEvent,
+    CallForkStartedWebhookEvent,
+    CallForkStoppedWebhookEvent,
+    CallGatherEndedWebhookEvent,
+    CallHangupWebhookEvent,
+    CallInitiatedWebhookEvent,
+    CallLeftQueueWebhookEvent,
+    CallMachineDetectionEndedWebhookEvent,
+    CallMachineGreetingEndedWebhookEvent,
+    CallMachinePremiumDetectionEndedWebhookEvent,
+    CallMachinePremiumGreetingEndedWebhookEvent,
+    CallPlaybackEndedWebhookEvent,
+    CallPlaybackStartedWebhookEvent,
+    CallRecordingErrorWebhookEvent,
+    CallRecordingSavedWebhookEvent,
+    CallRecordingTranscriptionSavedWebhookEvent,
+    CallReferCompletedWebhookEvent,
+    CallReferFailedWebhookEvent,
+    CallReferStartedWebhookEvent,
+    CallSiprecFailedWebhookEvent,
+    CallSiprecStartedWebhookEvent,
+    CallSiprecStoppedWebhookEvent,
+    CallSpeakEndedWebhookEvent,
+    CallSpeakStartedWebhookEvent,
+    CallStreamingFailedWebhookEvent,
+    CallStreamingStartedWebhookEvent,
+    CallStreamingStoppedWebhookEvent,
+    CampaignStatusUpdateWebhookEvent,
+    ConferenceCreatedWebhookEvent,
+    ConferenceEndedWebhookEvent,
+    ConferenceFloorChangedWebhookEvent,
+    ConferenceParticipantJoinedWebhookEvent,
+    ConferenceParticipantLeftWebhookEvent,
+    ConferenceParticipantPlaybackEndedWebhookEvent,
+    ConferenceParticipantPlaybackStartedWebhookEvent,
+    ConferenceParticipantSpeakEndedWebhookEvent,
+    ConferenceParticipantSpeakStartedWebhookEvent,
+    ConferencePlaybackEndedWebhookEvent,
+    ConferencePlaybackStartedWebhookEvent,
+    ConferenceRecordingSavedWebhookEvent,
+    ConferenceSpeakEndedWebhookEvent,
+    ConferenceSpeakStartedWebhookEvent,
+    DeliveryUpdateWebhookEvent,
+    FaxDeliveredWebhookEvent,
+    FaxFailedWebhookEvent,
+    FaxMediaProcessedWebhookEvent,
+    FaxQueuedWebhookEvent,
+    FaxSendingStartedWebhookEvent,
+    InboundMessageWebhookEvent,
+    NumberOrderStatusUpdateWebhookEvent,
+    ReplacedLinkClickWebhookEvent,
+    StreamingFailedWebhookEvent,
+    StreamingStartedWebhookEvent,
+    StreamingStoppedWebhookEvent,
+    TranscriptionWebhookEvent,
+]

{telnyx-3.6.0.dist-info → telnyx-3.7.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: telnyx
-Version: 3.6.0
+Version: 3.7.0
 Summary: The official Python library for the telnyx API
 Project-URL: Homepage, https://github.com/team-telnyx/telnyx-python
 Project-URL: Repository, https://github.com/team-telnyx/telnyx-python