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

telnyx/types/fax_queued_webhook_event.py

@@ -0,0 +1,63 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+from typing_extensions import Literal
+
+from pydantic import Field as FieldInfo
+
+from .._models import BaseModel
+
+__all__ = ["FaxQueuedWebhookEvent", "Payload"]
+
+
+class Payload(BaseModel):
+    client_state: Optional[str] = None
+    """State received from a command."""
+
+    connection_id: Optional[str] = None
+    """The ID of the connection used to send the fax."""
+
+    direction: Optional[Literal["inbound", "outbound"]] = None
+    """The direction of the fax."""
+
+    fax_id: Optional[str] = None
+    """Identifies the fax."""
+
+    from_: Optional[str] = FieldInfo(alias="from", default=None)
+    """The phone number, in E.164 format, the fax will be sent from."""
+
+    media_name: Optional[str] = None
+    """The media_name used for the fax's media.
+
+    Must point to a file previously uploaded to api.telnyx.com/v2/media by the same
+    user/organization. media_name and media_url/contents can't be submitted
+    together.
+    """
+
+    original_media_url: Optional[str] = None
+    """The original URL to the PDF used for the fax's media.
+
+    If media_name was supplied, this is omitted
+    """
+
+    status: Optional[Literal["queued"]] = None
+    """The status of the fax."""
+
+    to: Optional[str] = None
+    """The phone number, in E.164 format, the fax will be sent to or SIP URI"""
+
+    user_id: Optional[str] = None
+    """Identifier of the user to whom the fax belongs"""
+
+
+class FaxQueuedWebhookEvent(BaseModel):
+    id: Optional[str] = None
+    """Identifies the type of resource."""
+
+    event_type: Optional[Literal["fax.queued"]] = 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/fax_sending_started_webhook_event.py

@@ -0,0 +1,63 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+from typing_extensions import Literal
+
+from pydantic import Field as FieldInfo
+
+from .._models import BaseModel
+
+__all__ = ["FaxSendingStartedWebhookEvent", "Payload"]
+
+
+class Payload(BaseModel):
+    client_state: Optional[str] = None
+    """State received from a command."""
+
+    connection_id: Optional[str] = None
+    """The ID of the connection used to send the fax."""
+
+    direction: Optional[Literal["inbound", "outbound"]] = None
+    """The direction of the fax."""
+
+    fax_id: Optional[str] = None
+    """Identifies the fax."""
+
+    from_: Optional[str] = FieldInfo(alias="from", default=None)
+    """The phone number, in E.164 format, the fax will be sent from."""
+
+    media_name: Optional[str] = None
+    """The media_name used for the fax's media.
+
+    Must point to a file previously uploaded to api.telnyx.com/v2/media by the same
+    user/organization. media_name and media_url/contents can't be submitted
+    together.
+    """
+
+    original_media_url: Optional[str] = None
+    """The original URL to the PDF used for the fax's media.
+
+    If media_name was supplied, this is omitted
+    """
+
+    status: Optional[Literal["sending"]] = None
+    """The status of the fax."""
+
+    to: Optional[str] = None
+    """The phone number, in E.164 format, the fax will be sent to or SIP URI"""
+
+    user_id: Optional[str] = None
+    """Identifier of the user to whom the fax belongs"""
+
+
+class FaxSendingStartedWebhookEvent(BaseModel):
+    id: Optional[str] = None
+    """Identifies the type of resource."""
+
+    event_type: Optional[Literal["fax.sending.started"]] = 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/inbound_message_webhook_event.py

@@ -0,0 +1,227 @@
+# 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 .messaging_error import MessagingError
+
+__all__ = [
+    "InboundMessageWebhookEvent",
+    "Data",
+    "DataPayload",
+    "DataPayloadCc",
+    "DataPayloadCost",
+    "DataPayloadCostBreakdown",
+    "DataPayloadCostBreakdownCarrierFee",
+    "DataPayloadCostBreakdownRate",
+    "DataPayloadFrom",
+    "DataPayloadMedia",
+    "DataPayloadTo",
+]
+
+
+class DataPayloadCc(BaseModel):
+    carrier: Optional[str] = None
+    """The carrier of the receiver."""
+
+    line_type: Optional[Literal["Wireline", "Wireless", "VoWiFi", "VoIP", "Pre-Paid Wireless", ""]] = None
+    """The line-type of the receiver."""
+
+    phone_number: Optional[str] = None
+    """Receiving address (+E.164 formatted phone number or short code)."""
+
+    status: Optional[
+        Literal["queued", "sending", "sent", "delivered", "sending_failed", "delivery_failed", "delivery_unconfirmed"]
+    ] = None
+
+
+class DataPayloadCost(BaseModel):
+    amount: Optional[str] = None
+    """The amount deducted from your account."""
+
+    currency: Optional[str] = None
+    """The ISO 4217 currency identifier."""
+
+
+class DataPayloadCostBreakdownCarrierFee(BaseModel):
+    amount: Optional[str] = None
+    """The carrier fee amount."""
+
+    currency: Optional[str] = None
+    """The ISO 4217 currency identifier."""
+
+
+class DataPayloadCostBreakdownRate(BaseModel):
+    amount: Optional[str] = None
+    """The rate amount applied."""
+
+    currency: Optional[str] = None
+    """The ISO 4217 currency identifier."""
+
+
+class DataPayloadCostBreakdown(BaseModel):
+    carrier_fee: Optional[DataPayloadCostBreakdownCarrierFee] = None
+
+    rate: Optional[DataPayloadCostBreakdownRate] = None
+
+
+class DataPayloadFrom(BaseModel):
+    carrier: Optional[str] = None
+    """The carrier of the sender."""
+
+    line_type: Optional[Literal["Wireline", "Wireless", "VoWiFi", "VoIP", "Pre-Paid Wireless", ""]] = None
+    """The line-type of the sender."""
+
+    phone_number: Optional[str] = None
+    """
+    Sending address (+E.164 formatted phone number, alphanumeric sender ID, or short
+    code).
+    """
+
+    status: Optional[Literal["received", "delivered"]] = None
+
+
+class DataPayloadMedia(BaseModel):
+    content_type: Optional[str] = None
+    """The MIME type of the requested media."""
+
+    hash_sha256: Optional[str] = None
+    """The SHA256 hash of the requested media."""
+
+    size: Optional[int] = None
+    """The size of the requested media."""
+
+    url: Optional[str] = None
+    """The url of the media requested to be sent."""
+
+
+class DataPayloadTo(BaseModel):
+    carrier: Optional[str] = None
+    """The carrier of the receiver."""
+
+    line_type: Optional[Literal["Wireline", "Wireless", "VoWiFi", "VoIP", "Pre-Paid Wireless", ""]] = None
+    """The line-type of the receiver."""
+
+    phone_number: Optional[str] = None
+    """Receiving address (+E.164 formatted phone number or short code)."""
+
+    status: Optional[
+        Literal[
+            "queued",
+            "sending",
+            "sent",
+            "delivered",
+            "sending_failed",
+            "delivery_failed",
+            "delivery_unconfirmed",
+            "webhook_delivered",
+        ]
+    ] = None
+
+
+class DataPayload(BaseModel):
+    id: Optional[str] = None
+    """Identifies the type of resource."""
+
+    cc: Optional[List[DataPayloadCc]] = None
+
+    completed_at: Optional[datetime] = None
+    """Not used for inbound messages."""
+
+    cost: Optional[DataPayloadCost] = None
+
+    cost_breakdown: Optional[DataPayloadCostBreakdown] = None
+    """Detailed breakdown of the message cost components."""
+
+    direction: Optional[Literal["inbound"]] = None
+    """The direction of the message.
+
+    Inbound messages are sent to you whereas outbound messages are sent from you.
+    """
+
+    encoding: Optional[str] = None
+    """Encoding scheme used for the message body."""
+
+    errors: Optional[List[MessagingError]] = None
+    """
+    These errors may point at addressees when referring to unsuccessful/unconfirmed
+    delivery statuses.
+    """
+
+    from_: Optional[DataPayloadFrom] = FieldInfo(alias="from", default=None)
+
+    media: Optional[List[DataPayloadMedia]] = None
+
+    messaging_profile_id: Optional[str] = None
+    """Unique identifier for a messaging profile."""
+
+    parts: Optional[int] = None
+    """Number of parts into which the message's body must be split."""
+
+    received_at: Optional[datetime] = None
+    """ISO 8601 formatted date indicating when the message request was received."""
+
+    record_type: Optional[Literal["message"]] = None
+    """Identifies the type of the resource."""
+
+    sent_at: Optional[datetime] = None
+    """Not used for inbound messages."""
+
+    tags: Optional[List[str]] = None
+    """Tags associated with the resource."""
+
+    tcr_campaign_billable: Optional[bool] = None
+    """Indicates whether the TCR campaign is billable."""
+
+    tcr_campaign_id: Optional[str] = None
+    """The Campaign Registry (TCR) campaign ID associated with the message."""
+
+    tcr_campaign_registered: Optional[str] = None
+    """The registration status of the TCR campaign."""
+
+    text: Optional[str] = None
+    """Message body (i.e., content) as a non-empty string.
+
+    **Required for SMS**
+    """
+
+    to: Optional[List[DataPayloadTo]] = None
+
+    type: Optional[Literal["SMS", "MMS"]] = None
+    """The type of message. This value can be either 'sms' or 'mms'."""
+
+    valid_until: Optional[datetime] = None
+    """Not used for inbound messages."""
+
+    webhook_failover_url: Optional[str] = None
+    """
+    The failover URL where webhooks related to this message will be sent if sending
+    to the primary URL fails.
+    """
+
+    webhook_url: Optional[str] = None
+    """The URL where webhooks related to this message will be sent."""
+
+
+class Data(BaseModel):
+    id: Optional[str] = None
+    """Identifies the type of resource."""
+
+    event_type: Optional[Literal["message.received"]] = None
+    """The type of event being delivered."""
+
+    occurred_at: Optional[datetime] = None
+    """ISO 8601 formatted date indicating when the resource was created."""
+
+    payload: Optional[DataPayload] = None
+
+    record_type: Optional[Literal["event"]] = None
+    """Identifies the type of the resource."""
+
+
+class InboundMessageWebhookEvent(BaseModel):
+    data: Optional[Data] = None

telnyx/types/number_order_status_update_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 .number_block_order import NumberBlockOrder
+
+__all__ = ["NumberOrderStatusUpdateWebhookEvent"]
+
+
+class NumberOrderStatusUpdateWebhookEvent(BaseModel):
+    data: Optional[NumberBlockOrder] = None

telnyx/types/replaced_link_click_webhook_event.py

@@ -0,0 +1,32 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+from datetime import datetime
+
+from .._models import BaseModel
+
+__all__ = ["ReplacedLinkClickWebhookEvent", "Data"]
+
+
+class Data(BaseModel):
+    message_id: Optional[str] = None
+    """The message ID associated with the clicked link."""
+
+    record_type: Optional[str] = None
+    """Identifies the type of the resource."""
+
+    time_clicked: Optional[datetime] = None
+    """ISO 8601 formatted date indicating when the message request was received."""
+
+    to: Optional[str] = None
+    """
+    Sending address (+E.164 formatted phone number, alphanumeric sender ID, or short
+    code).
+    """
+
+    url: Optional[str] = None
+    """The original link that was sent in the message."""
+
+
+class ReplacedLinkClickWebhookEvent(BaseModel):
+    data: Optional[Data] = None

telnyx/types/sip_header.py

@@ -0,0 +1,15 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing_extensions import Literal
+
+from .._models import BaseModel
+
+__all__ = ["SipHeader"]
+
+
+class SipHeader(BaseModel):
+    name: Literal["User-to-User"]
+    """The name of the header to add."""
+
+    value: str
+    """The value of the header."""

telnyx/types/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__ = ["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_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__ = ["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_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__ = ["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_event.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