telnyx 4.5.0__py3-none-any.whl

telnyx/types/call_speak_ended_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__ = ["CallSpeakEndedWebhookEvent", "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."""
+
+    status: Optional[Literal["completed", "call_hangup", "cancelled_amd"]] = None
+    """Reflects how the command ended."""
+
+
+class Data(BaseModel):
+    id: Optional[str] = None
+    """Identifies the type of resource."""
+
+    event_type: Optional[Literal["call.speak.ended"]] = 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 CallSpeakEndedWebhookEvent(BaseModel):
+    data: Optional[Data] = None

telnyx/types/call_speak_ended_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__ = ["CallSpeakEndedWebhookEvent", "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."""
+
+    status: Optional[Literal["completed", "call_hangup", "cancelled_amd"]] = None
+    """Reflects how the command ended."""
+
+
+class Data(BaseModel):
+    id: Optional[str] = None
+    """Identifies the type of resource."""
+
+    event_type: Optional[Literal["call.speak.ended"]] = 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 CallSpeakEndedWebhookEvent(BaseModel):
+    data: Optional[Data] = None

telnyx/types/call_speak_started_webhook_event.py

@@ -0,0 +1,50 @@
+# 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__ = ["CallSpeakStartedWebhookEvent", "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."""
+
+
+class Data(BaseModel):
+    id: Optional[str] = None
+    """Identifies the type of resource."""
+
+    event_type: Optional[Literal["call.speak.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 CallSpeakStartedWebhookEvent(BaseModel):
+    data: Optional[Data] = None

telnyx/types/call_speak_started_webhook_event1.py

@@ -0,0 +1,50 @@
+# 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__ = ["CallSpeakStartedWebhookEvent", "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."""
+
+
+class Data(BaseModel):
+    id: Optional[str] = None
+    """Identifies the type of resource."""
+
+    event_type: Optional[Literal["call.speak.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 CallSpeakStartedWebhookEvent(BaseModel):
+    data: Optional[Data] = None

telnyx/types/call_streaming_failed.py

@@ -0,0 +1,68 @@
+# 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__ = ["CallStreamingFailed", "Payload", "PayloadStreamParams"]
+
+
+class PayloadStreamParams(BaseModel):
+    """Streaming parameters as they were originally given to the Call Control API."""
+
+    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 Payload(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[PayloadStreamParams] = 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 CallStreamingFailed(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[Payload] = None
+
+    record_type: Optional[Literal["event"]] = None
+    """Identifies the resource."""

telnyx/types/call_streaming_failed_webhook_event.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 .call_streaming_failed import CallStreamingFailed
+
+__all__ = ["CallStreamingFailedWebhookEvent"]
+
+
+class CallStreamingFailedWebhookEvent(BaseModel):
+    data: Optional[CallStreamingFailed] = None

telnyx/types/call_streaming_failed_webhook_event1.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 .call_streaming_failed import CallStreamingFailed
+
+__all__ = ["CallStreamingFailedWebhookEvent"]
+
+
+class CallStreamingFailedWebhookEvent(BaseModel):
+    data: Optional[CallStreamingFailed] = None

telnyx/types/call_streaming_started.py

@@ -0,0 +1,49 @@
+# 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__ = ["CallStreamingStarted", "Payload"]
+
+
+class Payload(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 CallStreamingStarted(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[Payload] = None
+
+    record_type: Optional[Literal["event"]] = None
+    """Identifies the type of the resource."""

telnyx/types/call_streaming_started_webhook_event.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 .call_streaming_started import CallStreamingStarted
+
+__all__ = ["CallStreamingStartedWebhookEvent"]
+
+
+class CallStreamingStartedWebhookEvent(BaseModel):
+    data: Optional[CallStreamingStarted] = None

telnyx/types/call_streaming_started_webhook_event1.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 .call_streaming_started import CallStreamingStarted
+
+__all__ = ["CallStreamingStartedWebhookEvent"]
+
+
+class CallStreamingStartedWebhookEvent(BaseModel):
+    data: Optional[CallStreamingStarted] = None

telnyx/types/call_streaming_stopped.py

@@ -0,0 +1,49 @@
+# 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__ = ["CallStreamingStopped", "Payload"]
+
+
+class Payload(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 CallStreamingStopped(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[Payload] = None
+
+    record_type: Optional[Literal["event"]] = None
+    """Identifies the type of the resource."""

telnyx/types/call_streaming_stopped_webhook_event.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 .call_streaming_stopped import CallStreamingStopped
+
+__all__ = ["CallStreamingStoppedWebhookEvent"]
+
+
+class CallStreamingStoppedWebhookEvent(BaseModel):
+    data: Optional[CallStreamingStopped] = None

telnyx/types/call_streaming_stopped_webhook_event1.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 .call_streaming_stopped import CallStreamingStopped
+
+__all__ = ["CallStreamingStoppedWebhookEvent"]
+
+
+class CallStreamingStoppedWebhookEvent(BaseModel):
+    data: Optional[CallStreamingStopped] = None

telnyx/types/calls/__init__.py

@@ -0,0 +1,105 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from .loopcount_param import LoopcountParam as LoopcountParam
+from .action_refer_params import ActionReferParams as ActionReferParams
+from .action_speak_params import ActionSpeakParams as ActionSpeakParams
+from .action_answer_params import ActionAnswerParams as ActionAnswerParams
+from .action_bridge_params import ActionBridgeParams as ActionBridgeParams
+from .action_gather_params import ActionGatherParams as ActionGatherParams
+from .action_hangup_params import ActionHangupParams as ActionHangupParams
+from .action_reject_params import ActionRejectParams as ActionRejectParams
+from .action_enqueue_params import ActionEnqueueParams as ActionEnqueueParams
+from .action_refer_response import ActionReferResponse as ActionReferResponse
+from .action_speak_response import ActionSpeakResponse as ActionSpeakResponse
+from .action_answer_response import ActionAnswerResponse as ActionAnswerResponse
+from .action_bridge_response import ActionBridgeResponse as ActionBridgeResponse
+from .action_gather_response import ActionGatherResponse as ActionGatherResponse
+from .action_hangup_response import ActionHangupResponse as ActionHangupResponse
+from .action_reject_response import ActionRejectResponse as ActionRejectResponse
+from .action_transfer_params import ActionTransferParams as ActionTransferParams
+from .action_enqueue_response import ActionEnqueueResponse as ActionEnqueueResponse
+from .action_send_dtmf_params import ActionSendDtmfParams as ActionSendDtmfParams
+from .action_transfer_response import ActionTransferResponse as ActionTransferResponse
+from .aws_voice_settings_param import AwsVoiceSettingsParam as AwsVoiceSettingsParam
+from .action_leave_queue_params import ActionLeaveQueueParams as ActionLeaveQueueParams
+from .action_send_dtmf_response import ActionSendDtmfResponse as ActionSendDtmfResponse
+from .action_stop_gather_params import ActionStopGatherParams as ActionStopGatherParams
+from .action_stop_siprec_params import ActionStopSiprecParams as ActionStopSiprecParams
+from .action_start_siprec_params import ActionStartSiprecParams as ActionStartSiprecParams
+from .action_stop_forking_params import ActionStopForkingParams as ActionStopForkingParams
+from .transcription_config_param import TranscriptionConfigParam as TranscriptionConfigParam
+from .action_leave_queue_response import ActionLeaveQueueResponse as ActionLeaveQueueResponse
+from .action_send_sip_info_params import ActionSendSipInfoParams as ActionSendSipInfoParams
+from .action_start_forking_params import ActionStartForkingParams as ActionStartForkingParams
+from .action_stop_gather_response import ActionStopGatherResponse as ActionStopGatherResponse
+from .action_stop_playback_params import ActionStopPlaybackParams as ActionStopPlaybackParams
+from .action_stop_siprec_response import ActionStopSiprecResponse as ActionStopSiprecResponse
+from .call_control_command_result import CallControlCommandResult as CallControlCommandResult
+from .interruption_settings_param import InterruptionSettingsParam as InterruptionSettingsParam
+from .telnyx_voice_settings_param import TelnyxVoiceSettingsParam as TelnyxVoiceSettingsParam
+from .action_start_playback_params import ActionStartPlaybackParams as ActionStartPlaybackParams
+from .action_start_siprec_response import ActionStartSiprecResponse as ActionStartSiprecResponse
+from .action_stop_forking_response import ActionStopForkingResponse as ActionStopForkingResponse
+from .action_stop_recording_params import ActionStopRecordingParams as ActionStopRecordingParams
+from .action_stop_streaming_params import ActionStopStreamingParams as ActionStopStreamingParams
+from .action_gather_using_ai_params import ActionGatherUsingAIParams as ActionGatherUsingAIParams
+from .action_pause_recording_params import ActionPauseRecordingParams as ActionPauseRecordingParams
+from .action_send_sip_info_response import ActionSendSipInfoResponse as ActionSendSipInfoResponse
+from .action_start_forking_response import ActionStartForkingResponse as ActionStartForkingResponse
+from .action_start_recording_params import ActionStartRecordingParams as ActionStartRecordingParams
+from .action_start_streaming_params import ActionStartStreamingParams as ActionStartStreamingParams
+from .action_stop_playback_response import ActionStopPlaybackResponse as ActionStopPlaybackResponse
+from .google_transcription_language import GoogleTranscriptionLanguage as GoogleTranscriptionLanguage
+from .telnyx_transcription_language import TelnyxTranscriptionLanguage as TelnyxTranscriptionLanguage
+from .action_resume_recording_params import ActionResumeRecordingParams as ActionResumeRecordingParams
+from .action_start_playback_response import ActionStartPlaybackResponse as ActionStartPlaybackResponse
+from .action_stop_recording_response import ActionStopRecordingResponse as ActionStopRecordingResponse
+from .action_stop_streaming_response import ActionStopStreamingResponse as ActionStopStreamingResponse
+from .action_gather_using_ai_response import ActionGatherUsingAIResponse as ActionGatherUsingAIResponse
+from .action_pause_recording_response import ActionPauseRecordingResponse as ActionPauseRecordingResponse
+from .action_start_recording_response import ActionStartRecordingResponse as ActionStartRecordingResponse
+from .action_start_streaming_response import ActionStartStreamingResponse as ActionStartStreamingResponse
+from .action_stop_ai_assistant_params import ActionStopAIAssistantParams as ActionStopAIAssistantParams
+from .action_gather_using_audio_params import ActionGatherUsingAudioParams as ActionGatherUsingAudioParams
+from .action_gather_using_speak_params import ActionGatherUsingSpeakParams as ActionGatherUsingSpeakParams
+from .action_resume_recording_response import ActionResumeRecordingResponse as ActionResumeRecordingResponse
+from .action_start_ai_assistant_params import ActionStartAIAssistantParams as ActionStartAIAssistantParams
+from .action_stop_transcription_params import ActionStopTranscriptionParams as ActionStopTranscriptionParams
+from .eleven_labs_voice_settings_param import ElevenLabsVoiceSettingsParam as ElevenLabsVoiceSettingsParam
+from .action_start_transcription_params import ActionStartTranscriptionParams as ActionStartTranscriptionParams
+from .action_stop_ai_assistant_response import ActionStopAIAssistantResponse as ActionStopAIAssistantResponse
+from .action_update_client_state_params import ActionUpdateClientStateParams as ActionUpdateClientStateParams
+from .transcription_start_request_param import TranscriptionStartRequestParam as TranscriptionStartRequestParam
+from .action_gather_using_audio_response import ActionGatherUsingAudioResponse as ActionGatherUsingAudioResponse
+from .action_gather_using_speak_response import ActionGatherUsingSpeakResponse as ActionGatherUsingSpeakResponse
+from .action_start_ai_assistant_response import ActionStartAIAssistantResponse as ActionStartAIAssistantResponse
+from .action_stop_transcription_response import ActionStopTranscriptionResponse as ActionStopTranscriptionResponse
+from .action_start_transcription_response import ActionStartTranscriptionResponse as ActionStartTranscriptionResponse
+from .action_update_client_state_response import ActionUpdateClientStateResponse as ActionUpdateClientStateResponse
+from .transcription_engine_a_config_param import TranscriptionEngineAConfigParam as TranscriptionEngineAConfigParam
+from .transcription_engine_b_config_param import TranscriptionEngineBConfigParam as TranscriptionEngineBConfigParam
+from .action_stop_noise_suppression_params import ActionStopNoiseSuppressionParams as ActionStopNoiseSuppressionParams
+from .action_switch_supervisor_role_params import ActionSwitchSupervisorRoleParams as ActionSwitchSupervisorRoleParams
+from .action_start_noise_suppression_params import (
+    ActionStartNoiseSuppressionParams as ActionStartNoiseSuppressionParams,
+)
+from .action_stop_noise_suppression_response import (
+    ActionStopNoiseSuppressionResponse as ActionStopNoiseSuppressionResponse,
+)
+from .action_switch_supervisor_role_response import (
+    ActionSwitchSupervisorRoleResponse as ActionSwitchSupervisorRoleResponse,
+)
+from .action_start_noise_suppression_response import (
+    ActionStartNoiseSuppressionResponse as ActionStartNoiseSuppressionResponse,
+)
+from .transcription_engine_azure_config_param import (
+    TranscriptionEngineAzureConfigParam as TranscriptionEngineAzureConfigParam,
+)
+from .transcription_engine_google_config_param import (
+    TranscriptionEngineGoogleConfigParam as TranscriptionEngineGoogleConfigParam,
+)
+from .transcription_engine_telnyx_config_param import (
+    TranscriptionEngineTelnyxConfigParam as TranscriptionEngineTelnyxConfigParam,
+)