telnyx 3.7.0a0__py3-none-any.whl → 3.9.0__py3-none-any.whl

telnyx/types/conference_participant_speak_started_webhook_event1.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__ = ["ConferenceParticipantSpeakStartedWebhookEvent", "Data", "DataPayload"]
+
+
+class DataPayload(BaseModel):
+    call_control_id: Optional[str] = None
+    """Participant's 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
+    """ID of the conference the text was spoken in."""
+
+    connection_id: Optional[str] = None
+    """Call Control App ID (formerly Telnyx connection ID) used in the call."""
+
+    creator_call_session_id: Optional[str] = None
+    """ID that is unique to the call session that started the conference."""
+
+    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.participant.speak.started"]] = None
+    """The type of event being delivered."""
+
+    payload: Optional[DataPayload] = None
+
+    record_type: Optional[Literal["event"]] = None
+    """Identifies the type of the resource."""
+
+
+class ConferenceParticipantSpeakStartedWebhookEvent(BaseModel):
+    data: Optional[Data] = None

telnyx/types/conference_playback_ended_webhook_event1.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__ = ["ConferencePlaybackEndedWebhookEvent", "Data", "DataPayload"]
+
+
+class DataPayload(BaseModel):
+    conference_id: Optional[str] = None
+    """ID of the conference the text was spoken in."""
+
+    connection_id: Optional[str] = None
+    """Call Control App ID (formerly Telnyx connection ID) used in the call."""
+
+    creator_call_session_id: Optional[str] = None
+    """ID that is unique to the call session that started the conference."""
+
+    media_name: Optional[str] = None
+    """
+    The name of the audio media file being played back, if media_name has been used
+    to start.
+    """
+
+    media_url: Optional[str] = None
+    """The audio URL being played back, if audio_url has been used to start."""
+
+    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.playback.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 ConferencePlaybackEndedWebhookEvent(BaseModel):
+    data: Optional[Data] = None

telnyx/types/conference_playback_started_webhook_event1.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__ = ["ConferencePlaybackStartedWebhookEvent", "Data", "DataPayload"]
+
+
+class DataPayload(BaseModel):
+    conference_id: Optional[str] = None
+    """ID of the conference the text was spoken in."""
+
+    connection_id: Optional[str] = None
+    """Call Control App ID (formerly Telnyx connection ID) used in the call."""
+
+    creator_call_session_id: Optional[str] = None
+    """ID that is unique to the call session that started the conference."""
+
+    media_name: Optional[str] = None
+    """
+    The name of the audio media file being played back, if media_name has been used
+    to start.
+    """
+
+    media_url: Optional[str] = None
+    """The audio URL being played back, if audio_url has been used to start."""
+
+    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.playback.started"]] = None
+    """The type of event being delivered."""
+
+    payload: Optional[DataPayload] = None
+
+    record_type: Optional[Literal["event"]] = None
+    """Identifies the type of the resource."""
+
+
+class ConferencePlaybackStartedWebhookEvent(BaseModel):
+    data: Optional[Data] = None

telnyx/types/conference_recording_saved_webhook_event1.py

@@ -0,0 +1,103 @@
+# 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__ = [
+    "ConferenceRecordingSavedWebhookEvent",
+    "Data",
+    "DataPayload",
+    "DataPayloadPublicRecordingURLs",
+    "DataPayloadRecordingURLs",
+]
+
+
+class DataPayloadPublicRecordingURLs(BaseModel):
+    mp3: Optional[str] = None
+    """Recording URL in requested `mp3` format."""
+
+    wav: Optional[str] = None
+    """Recording URL in requested `wav` format."""
+
+
+class DataPayloadRecordingURLs(BaseModel):
+    mp3: Optional[str] = None
+    """Recording URL in requested `mp3` format."""
+
+    wav: Optional[str] = None
+    """Recording URL in requested `wav` format."""
+
+
+class DataPayload(BaseModel):
+    call_control_id: Optional[str] = None
+    """Participant's call ID used to issue commands via Call Control API."""
+
+    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.
+    """
+
+    channels: Optional[Literal["single", "dual"]] = None
+    """Whether recording was recorded in `single` or `dual` channel."""
+
+    client_state: Optional[str] = None
+    """State received from a command."""
+
+    conference_id: Optional[str] = None
+    """ID of the conference that is being recorded."""
+
+    connection_id: Optional[str] = None
+    """Call Control App ID (formerly Telnyx connection ID) used in the call."""
+
+    format: Optional[Literal["wav", "mp3"]] = None
+    """The audio file format used when storing the call recording.
+
+    Can be either `mp3` or `wav`.
+    """
+
+    public_recording_urls: Optional[DataPayloadPublicRecordingURLs] = None
+    """Recording URLs in requested format.
+
+    The URL is valid for as long as the file exists. For security purposes, this
+    feature is activated on a per request basis. Please contact customer support
+    with your Account ID to request activation.
+    """
+
+    recording_ended_at: Optional[datetime] = None
+    """ISO 8601 datetime of when recording ended."""
+
+    recording_id: Optional[str] = None
+    """ID of the conference recording."""
+
+    recording_started_at: Optional[datetime] = None
+    """ISO 8601 datetime of when recording started."""
+
+    recording_urls: Optional[DataPayloadRecordingURLs] = None
+    """Recording URLs in requested format.
+
+    These URLs are valid for 10 minutes. After 10 minutes, you may retrieve
+    recordings via API using Reports -> Call Recordings documentation, or via
+    Mission Control under Reporting -> Recordings.
+    """
+
+
+class Data(BaseModel):
+    id: Optional[str] = None
+    """Identifies the type of resource."""
+
+    event_type: Optional[Literal["conference.recording.saved"]] = None
+    """The type of event being delivered."""
+
+    payload: Optional[DataPayload] = None
+
+    record_type: Optional[Literal["event"]] = None
+    """Identifies the type of the resource."""
+
+
+class ConferenceRecordingSavedWebhookEvent(BaseModel):
+    data: Optional[Data] = None

telnyx/types/conference_speak_ended_webhook_event1.py

@@ -0,0 +1,40 @@
+# 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__ = ["ConferenceSpeakEndedWebhookEvent", "Data", "DataPayload"]
+
+
+class DataPayload(BaseModel):
+    conference_id: Optional[str] = None
+    """ID of the conference the text was spoken in."""
+
+    connection_id: Optional[str] = None
+    """Call Control App ID (formerly Telnyx connection ID) used in the call."""
+
+    creator_call_session_id: Optional[str] = None
+    """ID that is unique to the call session that started the conference."""
+
+    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.speak.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 ConferenceSpeakEndedWebhookEvent(BaseModel):
+    data: Optional[Data] = None

telnyx/types/conference_speak_started_webhook_event1.py

@@ -0,0 +1,40 @@
+# 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__ = ["ConferenceSpeakStartedWebhookEvent", "Data", "DataPayload"]
+
+
+class DataPayload(BaseModel):
+    conference_id: Optional[str] = None
+    """ID of the conference the text was spoken in."""
+
+    connection_id: Optional[str] = None
+    """Call Control App ID (formerly Telnyx connection ID) used in the call."""
+
+    creator_call_session_id: Optional[str] = None
+    """ID that is unique to the call session that started the conference."""
+
+    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.speak.started"]] = None
+    """The type of event being delivered."""
+
+    payload: Optional[DataPayload] = None
+
+    record_type: Optional[Literal["event"]] = None
+    """Identifies the type of the resource."""
+
+
+class ConferenceSpeakStartedWebhookEvent(BaseModel):
+    data: Optional[Data] = None

telnyx/types/country_coverage_retrieve_country_response.py

@@ -10,6 +10,8 @@ __all__ = ["CountryCoverageRetrieveCountryResponse", "Data", "DataLocal", "DataT
 class DataLocal(BaseModel):
     features: Optional[List[str]] = None
 
+    full_pstn_replacement: Optional[bool] = None
+
     international_sms: Optional[bool] = None
 
     p2p: Optional[bool] = None
@@ -22,6 +24,8 @@ class DataLocal(BaseModel):
 class DataTollFree(BaseModel):
     features: Optional[List[str]] = None
 
+    full_pstn_replacement: Optional[bool] = None
+
     international_sms: Optional[bool] = None
 
     p2p: Optional[bool] = None
@@ -59,6 +63,9 @@ class Data(BaseModel):
     quickship: Optional[bool] = None
     """Supports quickship"""
 
+    region: Optional[str] = None
+    """Geographic region (e.g., AMER, EMEA, APAC)"""
+
     reservable: Optional[bool] = None
     """Supports reservable"""
 

telnyx/types/country_coverage_retrieve_response.py

@@ -10,6 +10,8 @@ __all__ = ["CountryCoverageRetrieveResponse", "Data", "DataLocal", "DataTollFree
 class DataLocal(BaseModel):
     features: Optional[List[str]] = None
 
+    full_pstn_replacement: Optional[bool] = None
+
     international_sms: Optional[bool] = None
 
     p2p: Optional[bool] = None
@@ -22,6 +24,8 @@ class DataLocal(BaseModel):
 class DataTollFree(BaseModel):
     features: Optional[List[str]] = None
 
+    full_pstn_replacement: Optional[bool] = None
+
     international_sms: Optional[bool] = None
 
     p2p: Optional[bool] = None
@@ -59,6 +63,9 @@ class Data(BaseModel):
     quickship: Optional[bool] = None
     """Supports quickship"""
 
+    region: Optional[str] = None
+    """Geographic region (e.g., AMER, EMEA, APAC)"""
+
     reservable: Optional[bool] = None
     """Supports reservable"""
 

telnyx/types/customer_service_record_status_changed_webhook_event1.py

@@ -0,0 +1,55 @@
+# 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__ = ["CustomerServiceRecordStatusChangedWebhookEvent", "Data", "DataPayload", "Meta"]
+
+
+class DataPayload(BaseModel):
+    id: Optional[str] = None
+    """Uniquely identifies the customer service record."""
+
+    phone_number: Optional[str] = None
+    """The phone number of the customer service record."""
+
+    status: Optional[Literal["pending", "completed", "failed"]] = None
+    """The status of the customer service record"""
+
+    updated_at: Optional[datetime] = None
+    """
+    ISO 8601 formatted date indicating the last time where the resource was updated.
+    """
+
+
+class Data(BaseModel):
+    id: Optional[str] = None
+    """Uniquely identifies the callback event."""
+
+    event_type: Optional[Literal["customer_service_record.status_changed"]] = None
+    """The type of the callback event."""
+
+    occurred_at: Optional[datetime] = None
+    """ISO 8601 formatted date indicating when the callback event occurred."""
+
+    payload: Optional[DataPayload] = None
+
+    record_type: Optional[Literal["event"]] = None
+    """Identifies the type of the resource."""
+
+
+class Meta(BaseModel):
+    attempt: Optional[int] = None
+    """The number of times the callback webhook has been attempted."""
+
+    delivered_to: Optional[str] = None
+    """The URL that the callback webhook was delivered to."""
+
+
+class CustomerServiceRecordStatusChangedWebhookEvent(BaseModel):
+    data: Optional[Data] = None
+
+    meta: Optional[Meta] = None

telnyx/types/delivery_update_webhook_event1.py

@@ -0,0 +1,40 @@
+# 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
+from .outbound_message_payload import OutboundMessagePayload
+
+__all__ = ["DeliveryUpdateWebhookEvent", "Data", "Meta"]
+
+
+class Data(BaseModel):
+    id: Optional[str] = None
+    """Identifies the type of resource."""
+
+    event_type: Optional[Literal["message.sent", "message.finalized"]] = None
+    """The type of event being delivered."""
+
+    occurred_at: Optional[datetime] = None
+    """ISO 8601 formatted date indicating when the resource was created."""
+
+    payload: Optional[OutboundMessagePayload] = None
+
+    record_type: Optional[Literal["event"]] = None
+    """Identifies the type of the resource."""
+
+
+class Meta(BaseModel):
+    attempt: Optional[int] = None
+    """Number of attempts to deliver the webhook event."""
+
+    delivered_to: Optional[str] = None
+    """The webhook URL the event was delivered to."""
+
+
+class DeliveryUpdateWebhookEvent(BaseModel):
+    data: Optional[Data] = None
+
+    meta: Optional[Meta] = None

telnyx/types/document_upload_json_params.py

@@ -0,0 +1,39 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Union
+from typing_extensions import Required, Annotated, TypeAlias, TypedDict
+
+from .._types import Base64FileInput
+from .._utils import PropertyInfo
+
+__all__ = ["DocumentUploadJsonParams", "DocServiceDocumentUploadURL", "DocServiceDocumentUploadInline"]
+
+
+class DocServiceDocumentUploadURL(TypedDict, total=False):
+    url: Required[str]
+    """
+    If the file is already hosted publicly, you can provide a URL and have the
+    documents service fetch it for you.
+    """
+
+    customer_reference: str
+    """Optional reference string for customer tracking."""
+
+    filename: str
+    """The filename of the document."""
+
+
+class DocServiceDocumentUploadInline(TypedDict, total=False):
+    file: Required[Annotated[Union[str, Base64FileInput], PropertyInfo(format="base64")]]
+    """The Base64 encoded contents of the file you are uploading."""
+
+    customer_reference: str
+    """A customer reference string for customer look ups."""
+
+    filename: str
+    """The filename of the document."""
+
+
+DocumentUploadJsonParams: TypeAlias = Union[DocServiceDocumentUploadURL, DocServiceDocumentUploadInline]

telnyx/types/document_upload_json_response.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 .doc_service_document import DocServiceDocument
+
+__all__ = ["DocumentUploadJsonResponse"]
+
+
+class DocumentUploadJsonResponse(BaseModel):
+    data: Optional[DocServiceDocument] = None

telnyx/types/fax_delivered_webhook_event1.py

@@ -0,0 +1,69 @@
+# 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__ = ["FaxDeliveredWebhookEvent", "Payload"]
+
+
+class Payload(BaseModel):
+    call_duration_secs: Optional[int] = None
+    """The duration of the call in seconds."""
+
+    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
+    """
+
+    page_count: Optional[int] = None
+    """Number of transferred pages"""
+
+    status: Optional[Literal["delivered"]] = 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 FaxDeliveredWebhookEvent(BaseModel):
+    id: Optional[str] = None
+    """Identifies the type of resource."""
+
+    event_type: Optional[Literal["fax.delivered"]] = 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_failed_webhook_event1.py

@@ -0,0 +1,66 @@
+# 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__ = ["FaxFailedWebhookEvent", "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."""
+
+    failure_reason: Optional[Literal["rejected"]] = None
+    """Cause of the sending failure"""
+
+    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["failed"]] = 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 FaxFailedWebhookEvent(BaseModel):
+    id: Optional[str] = None
+    """Identifies the type of resource."""
+
+    event_type: Optional[Literal["fax.failed"]] = None
+    """The type of event being delivered."""
+
+    payload: Optional[Payload] = None
+
+    record_type: Optional[Literal["event"]] = None
+    """Identifies the type of the resource."""