telnyx 3.2.0a0__py3-none-any.whl → 3.3.0a0__py3-none-any.whl

telnyx/types/call_ai_gather_partial_results_webhook_event.py

@@ -0,0 +1,75 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Optional
+from datetime import datetime
+from typing_extensions import Literal
+
+from pydantic import Field as FieldInfo
+
+from .._models import BaseModel
+
+__all__ = ["CallAIGatherPartialResultsWebhookEvent", "Data", "DataPayload", "DataPayloadMessageHistory"]
+
+
+class DataPayloadMessageHistory(BaseModel):
+    content: Optional[str] = None
+    """The content of the message"""
+
+    role: Optional[Literal["assistant", "user"]] = None
+    """The role of the message sender"""
+
+
+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
+    """Telnyx connection ID used in the call."""
+
+    from_: Optional[str] = FieldInfo(alias="from", default=None)
+    """Number or SIP URI placing the call."""
+
+    message_history: Optional[List[DataPayloadMessageHistory]] = None
+    """The history of the messages exchanged during the AI gather"""
+
+    partial_results: Optional[object] = None
+    """
+    The partial result of the AI gather, its type depends of the `parameters`
+    provided in the command
+    """
+
+    to: Optional[str] = None
+    """Destination number or SIP URI of the call."""
+
+
+class Data(BaseModel):
+    id: Optional[str] = None
+    """Identifies the type of resource."""
+
+    event_type: Optional[Literal["call.ai_gather.partial_results"]] = 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 CallAIGatherPartialResultsWebhookEvent(BaseModel):
+    data: Optional[Data] = None

telnyx/types/call_answered_webhook_event.py

@@ -0,0 +1,75 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Optional
+from datetime import datetime
+from typing_extensions import Literal
+
+from pydantic import Field as FieldInfo
+
+from .._models import BaseModel
+from .sip_header import SipHeader
+from .custom_sip_header import CustomSipHeader
+
+__all__ = ["CallAnsweredWebhookEvent", "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."""
+
+    custom_headers: Optional[List[CustomSipHeader]] = None
+    """Custom headers set on answer command"""
+
+    from_: Optional[str] = FieldInfo(alias="from", default=None)
+    """Number or SIP URI placing the call."""
+
+    sip_headers: Optional[List[SipHeader]] = None
+    """User-to-User and Diversion headers from sip invite."""
+
+    start_time: Optional[datetime] = None
+    """ISO 8601 datetime of when the call started."""
+
+    state: Optional[Literal["answered"]] = None
+    """State received from a command."""
+
+    tags: Optional[List[str]] = None
+    """Array of tags associated to number."""
+
+    to: Optional[str] = None
+    """Destination number or SIP URI of the call."""
+
+
+class Data(BaseModel):
+    id: Optional[str] = None
+    """Identifies the type of resource."""
+
+    event_type: Optional[Literal["call.answered"]] = 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 CallAnsweredWebhookEvent(BaseModel):
+    data: Optional[Data] = None

telnyx/types/call_bridged_webhook_event.py

@@ -0,0 +1,58 @@
+# 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 pydantic import Field as FieldInfo
+
+from .._models import BaseModel
+
+__all__ = ["CallBridgedWebhookEvent", "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."""
+
+    from_: Optional[str] = FieldInfo(alias="from", default=None)
+    """Number or SIP URI placing the call."""
+
+    to: Optional[str] = None
+    """Destination number or SIP URI of the call."""
+
+
+class Data(BaseModel):
+    id: Optional[str] = None
+    """Identifies the type of resource."""
+
+    event_type: Optional[Literal["call.bridged"]] = 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 CallBridgedWebhookEvent(BaseModel):
+    data: Optional[Data] = None

telnyx/types/call_conversation_ended_webhook_event.py

@@ -0,0 +1,84 @@
+# 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 pydantic import Field as FieldInfo
+
+from .._models import BaseModel
+
+__all__ = ["CallConversationEndedWebhookEvent", "Data", "DataPayload"]
+
+
+class DataPayload(BaseModel):
+    assistant_id: Optional[str] = None
+    """Unique identifier of the assistant involved in the call."""
+
+    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 leg."""
+
+    call_session_id: Optional[str] = None
+    """ID that is unique to the call session (group of related call legs)."""
+
+    calling_party_type: Optional[Literal["pstn", "sip"]] = None
+    """The type of calling party connection."""
+
+    client_state: Optional[str] = None
+    """Base64-encoded state received from a command."""
+
+    connection_id: Optional[str] = None
+    """Call Control App ID (formerly Telnyx connection ID) used in the call."""
+
+    conversation_id: Optional[str] = None
+    """ID unique to the conversation or insight group generated for the call."""
+
+    duration_sec: Optional[int] = None
+    """Duration of the conversation in seconds."""
+
+    from_: Optional[str] = FieldInfo(alias="from", default=None)
+    """The caller's number or identifier."""
+
+    llm_model: Optional[str] = None
+    """The large language model used during the conversation."""
+
+    stt_model: Optional[str] = None
+    """The speech-to-text model used in the conversation."""
+
+    to: Optional[str] = None
+    """The callee's number or SIP address."""
+
+    tts_model_id: Optional[str] = None
+    """The model ID used for text-to-speech synthesis."""
+
+    tts_provider: Optional[str] = None
+    """The text-to-speech provider used in the call."""
+
+    tts_voice_id: Optional[str] = None
+    """Voice ID used for TTS."""
+
+
+class Data(BaseModel):
+    id: Optional[str] = None
+    """Unique identifier for the event."""
+
+    created_at: Optional[datetime] = None
+    """Timestamp when the event was created in the system."""
+
+    event_type: Optional[Literal["call.conversation.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 CallConversationEndedWebhookEvent(BaseModel):
+    data: Optional[Data] = None

telnyx/types/call_conversation_insights_generated_webhook_event.py

@@ -0,0 +1,67 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Union, Optional
+from datetime import datetime
+from typing_extensions import Literal
+
+from .._models import BaseModel
+
+__all__ = ["CallConversationInsightsGeneratedWebhookEvent", "Data", "DataPayload", "DataPayloadResult"]
+
+
+class DataPayloadResult(BaseModel):
+    insight_id: Optional[str] = None
+    """ID that is unique to the insight result being generated for the call."""
+
+    result: Union[str, object, None] = None
+    """The result of the insight."""
+
+
+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.
+    """
+
+    calling_party_type: Optional[Literal["pstn", "sip"]] = None
+    """The type of calling party connection."""
+
+    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."""
+
+    insight_group_id: Optional[str] = None
+    """ID that is unique to the insight group being generated for the call."""
+
+    results: Optional[List[DataPayloadResult]] = None
+    """Array of insight results being generated for the call."""
+
+
+class Data(BaseModel):
+    id: Optional[str] = None
+    """Identifies the type of resource."""
+
+    event_type: Optional[Literal["call.conversation_insights.generated"]] = 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 CallConversationInsightsGeneratedWebhookEvent(BaseModel):
+    data: Optional[Data] = None

telnyx/types/call_dtmf_received_webhook_event.py

@@ -0,0 +1,61 @@
+# 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 pydantic import Field as FieldInfo
+
+from .._models import BaseModel
+
+__all__ = ["CallDtmfReceivedWebhookEvent", "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
+    """Identifies the type of resource."""
+
+    digit: Optional[str] = None
+    """The received DTMF digit or symbol."""
+
+    from_: Optional[str] = FieldInfo(alias="from", default=None)
+    """Number or SIP URI placing the call."""
+
+    to: Optional[str] = None
+    """Destination number or SIP URI of the call."""
+
+
+class Data(BaseModel):
+    id: Optional[str] = None
+    """Identifies the type of resource."""
+
+    event_type: Optional[Literal["call.dtmf.received"]] = 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 CallDtmfReceivedWebhookEvent(BaseModel):
+    data: Optional[Data] = None

telnyx/types/call_enqueued_webhook_event.py

@@ -0,0 +1,59 @@
+# 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__ = ["CallEnqueuedWebhookEvent", "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."""
+
+    current_position: Optional[int] = None
+    """Current position of the call in the queue."""
+
+    queue: Optional[str] = None
+    """The name of the queue"""
+
+    queue_avg_wait_time_secs: Optional[int] = None
+    """Average time call spends in the queue in seconds."""
+
+
+class Data(BaseModel):
+    id: Optional[str] = None
+    """Identifies the type of resource."""
+
+    event_type: Optional[Literal["call.enqueued"]] = 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 CallEnqueuedWebhookEvent(BaseModel):
+    data: Optional[Data] = None

telnyx/types/call_fork_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__ = ["CallForkStartedWebhookEvent", "Data", "DataPayload"]
+
+
+class DataPayload(BaseModel):
+    call_control_id: Optional[str] = None
+    """Unique ID 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
+    """State received from a command."""
+
+    connection_id: Optional[str] = None
+    """Call Control App ID (formerly Telnyx connection ID) used in the call."""
+
+    stream_type: Optional[Literal["decrypted"]] = None
+    """Type of media streamed. It can be either 'raw' or 'decrypted'."""
+
+
+class Data(BaseModel):
+    id: Optional[str] = None
+    """Identifies the type of resource."""
+
+    event_type: Optional[Literal["call.fork.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 CallForkStartedWebhookEvent(BaseModel):
+    data: Optional[Data] = None

telnyx/types/call_fork_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__ = ["CallForkStoppedWebhookEvent", "Data", "DataPayload"]
+
+
+class DataPayload(BaseModel):
+    call_control_id: Optional[str] = None
+    """Unique ID 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
+    """State received from a command."""
+
+    connection_id: Optional[str] = None
+    """Call Control App ID (formerly Telnyx connection ID) used in the call."""
+
+    stream_type: Optional[Literal["decrypted"]] = None
+    """Type of media streamed. It can be either 'raw' or 'decrypted'."""
+
+
+class Data(BaseModel):
+    id: Optional[str] = None
+    """Identifies the type of resource."""
+
+    event_type: Optional[Literal["call.fork.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 CallForkStoppedWebhookEvent(BaseModel):
+    data: Optional[Data] = None

telnyx/types/call_gather_ended_webhook_event.py

@@ -0,0 +1,64 @@
+# 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 pydantic import Field as FieldInfo
+
+from .._models import BaseModel
+
+__all__ = ["CallGatherEndedWebhookEvent", "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."""
+
+    digits: Optional[str] = None
+    """The received DTMF digit or symbol."""
+
+    from_: Optional[str] = FieldInfo(alias="from", default=None)
+    """Number or SIP URI placing the call."""
+
+    status: Optional[Literal["valid", "invalid", "call_hangup", "cancelled", "cancelled_amd", "timeout"]] = None
+    """Reflects how command ended."""
+
+    to: Optional[str] = None
+    """Destination number or SIP URI of the call."""
+
+
+class Data(BaseModel):
+    id: Optional[str] = None
+    """Identifies the type of resource."""
+
+    event_type: Optional[Literal["call.gather.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 CallGatherEndedWebhookEvent(BaseModel):
+    data: Optional[Data] = None