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

telnyx/types/inbound_message_webhook_event1.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/legacy/reporting/__init__.py

@@ -2,6 +2,8 @@
 
 from __future__ import annotations
 
+from .filter import Filter as Filter
+from .filter_param import FilterParam as FilterParam
 from .usage_report_retrieve_speech_to_text_params import (
     UsageReportRetrieveSpeechToTextParams as UsageReportRetrieveSpeechToTextParams,
 )

telnyx/types/legacy/reporting/batch_detail_records/__init__.py

@@ -9,8 +9,12 @@ from .voice_delete_response import VoiceDeleteResponse as VoiceDeleteResponse
 from .messaging_create_params import MessagingCreateParams as MessagingCreateParams
 from .messaging_list_response import MessagingListResponse as MessagingListResponse
 from .voice_retrieve_response import VoiceRetrieveResponse as VoiceRetrieveResponse
+from .batch_csv_pagination_meta import BatchCsvPaginationMeta as BatchCsvPaginationMeta
+from .cdr_detailed_req_response import CdrDetailedReqResponse as CdrDetailedReqResponse
 from .messaging_create_response import MessagingCreateResponse as MessagingCreateResponse
 from .messaging_delete_response import MessagingDeleteResponse as MessagingDeleteResponse
+from .mdr_detail_report_response import MdrDetailReportResponse as MdrDetailReportResponse
+from .stt_detail_report_response import SttDetailReportResponse as SttDetailReportResponse
 from .messaging_retrieve_response import MessagingRetrieveResponse as MessagingRetrieveResponse
 from .speech_to_text_create_params import SpeechToTextCreateParams as SpeechToTextCreateParams
 from .speech_to_text_list_response import SpeechToTextListResponse as SpeechToTextListResponse

telnyx/types/legacy/reporting/batch_detail_records/batch_csv_pagination_meta.py

@@ -0,0 +1,17 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+
+from ....._models import BaseModel
+
+__all__ = ["BatchCsvPaginationMeta"]
+
+
+class BatchCsvPaginationMeta(BaseModel):
+    page_number: Optional[int] = None
+
+    page_size: Optional[int] = None
+
+    total_pages: Optional[int] = None
+
+    total_results: Optional[int] = None

telnyx/types/legacy/reporting/batch_detail_records/cdr_detailed_req_response.py

@@ -0,0 +1,63 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Optional
+
+from ..filter import Filter
+from ....._models import BaseModel
+
+__all__ = ["CdrDetailedReqResponse"]
+
+
+class CdrDetailedReqResponse(BaseModel):
+    id: Optional[str] = None
+    """Unique identifier for the report"""
+
+    call_types: Optional[List[int]] = None
+    """List of call types (Inbound = 1, Outbound = 2)"""
+
+    connections: Optional[List[int]] = None
+    """List of connections"""
+
+    created_at: Optional[str] = None
+    """Creation date of the report"""
+
+    end_time: Optional[str] = None
+    """End time in ISO format"""
+
+    filters: Optional[List[Filter]] = None
+    """List of filters"""
+
+    managed_accounts: Optional[List[str]] = None
+    """List of managed accounts"""
+
+    record_type: Optional[str] = None
+
+    record_types: Optional[List[int]] = None
+    """List of record types (Complete = 1, Incomplete = 2, Errors = 3)"""
+
+    report_name: Optional[str] = None
+    """Name of the report"""
+
+    report_url: Optional[str] = None
+    """URL to download the report"""
+
+    retry: Optional[int] = None
+    """Number of retries"""
+
+    source: Optional[str] = None
+    """Source of the report.
+
+    Valid values: calls (default), call-control, fax-api, webrtc
+    """
+
+    start_time: Optional[str] = None
+    """Start time in ISO format"""
+
+    status: Optional[int] = None
+    """Status of the report (Pending = 1, Complete = 2, Failed = 3, Expired = 4)"""
+
+    timezone: Optional[str] = None
+    """Timezone for the report"""
+
+    updated_at: Optional[str] = None
+    """Last update date of the report"""

telnyx/types/legacy/reporting/batch_detail_records/mdr_detail_report_response.py

@@ -0,0 +1,42 @@
+# 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 ..filter import Filter
+from ....._models import BaseModel
+
+__all__ = ["MdrDetailReportResponse"]
+
+
+class MdrDetailReportResponse(BaseModel):
+    id: Optional[str] = None
+    """Identifies the resource"""
+
+    connections: Optional[List[int]] = None
+
+    created_at: Optional[datetime] = None
+
+    directions: Optional[List[Literal["INBOUND", "OUTBOUND"]]] = None
+
+    end_date: Optional[datetime] = None
+
+    filters: Optional[List[Filter]] = None
+
+    profiles: Optional[List[str]] = None
+    """List of messaging profile IDs"""
+
+    record_type: Optional[str] = None
+
+    record_types: Optional[List[Literal["INCOMPLETE", "COMPLETED", "ERRORS"]]] = None
+
+    report_name: Optional[str] = None
+
+    report_url: Optional[str] = None
+
+    start_date: Optional[datetime] = None
+
+    status: Optional[Literal["PENDING", "COMPLETE", "FAILED", "EXPIRED"]] = None
+
+    updated_at: Optional[datetime] = None

telnyx/types/legacy/reporting/batch_detail_records/messaging_create_params.py

@@ -4,12 +4,13 @@ from __future__ import annotations
 
 from typing import Union, Iterable
 from datetime import datetime
-from typing_extensions import Literal, Required, Annotated, TypedDict
+from typing_extensions import Required, Annotated, TypedDict
 
 from ....._types import SequenceNotStr
 from ....._utils import PropertyInfo
+from ..filter_param import FilterParam
 
-__all__ = ["MessagingCreateParams", "Filter"]
+__all__ = ["MessagingCreateParams"]
 
 
 class MessagingCreateParams(TypedDict, total=False):
@@ -29,7 +30,7 @@ class MessagingCreateParams(TypedDict, total=False):
     directions: Iterable[int]
     """List of directions to filter by (Inbound = 1, Outbound = 2)"""
 
-    filters: Iterable[Filter]
+    filters: Iterable[FilterParam]
     """List of filters to apply"""
 
     include_message_body: bool
@@ -52,26 +53,3 @@ class MessagingCreateParams(TypedDict, total=False):
 
     timezone: str
     """Timezone for the report"""
-
-
-class Filter(TypedDict, total=False):
-    billing_group: str
-    """Billing group UUID to filter by"""
-
-    cld: str
-    """Called line identification (destination number)"""
-
-    cld_filter: Literal["contains", "starts_with", "ends_with"]
-    """Filter type for CLD matching"""
-
-    cli: str
-    """Calling line identification (caller ID)"""
-
-    cli_filter: Literal["contains", "starts_with", "ends_with"]
-    """Filter type for CLI matching"""
-
-    filter_type: Literal["and", "or"]
-    """Logical operator for combining filters"""
-
-    tags_list: str
-    """Tag name to filter by"""

telnyx/types/legacy/reporting/batch_detail_records/messaging_create_response.py

@@ -1,68 +1,12 @@
 # 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 typing import Optional
 
 from ....._models import BaseModel
+from .mdr_detail_report_response import MdrDetailReportResponse
 
-__all__ = ["MessagingCreateResponse", "Data", "DataFilter"]
-
-
-class DataFilter(BaseModel):
-    billing_group: Optional[str] = None
-    """Billing group UUID to filter by"""
-
-    cld: Optional[str] = None
-    """Called line identification (destination number)"""
-
-    cld_filter: Optional[Literal["contains", "starts_with", "ends_with"]] = None
-    """Filter type for CLD matching"""
-
-    cli: Optional[str] = None
-    """Calling line identification (caller ID)"""
-
-    cli_filter: Optional[Literal["contains", "starts_with", "ends_with"]] = None
-    """Filter type for CLI matching"""
-
-    filter_type: Optional[Literal["and", "or"]] = None
-    """Logical operator for combining filters"""
-
-    tags_list: Optional[str] = None
-    """Tag name to filter by"""
-
-
-class Data(BaseModel):
-    id: Optional[str] = None
-    """Identifies the resource"""
-
-    connections: Optional[List[int]] = None
-
-    created_at: Optional[datetime] = None
-
-    directions: Optional[List[Literal["INBOUND", "OUTBOUND"]]] = None
-
-    end_date: Optional[datetime] = None
-
-    filters: Optional[List[DataFilter]] = None
-
-    profiles: Optional[List[str]] = None
-    """List of messaging profile IDs"""
-
-    record_type: Optional[str] = None
-
-    record_types: Optional[List[Literal["INCOMPLETE", "COMPLETED", "ERRORS"]]] = None
-
-    report_name: Optional[str] = None
-
-    report_url: Optional[str] = None
-
-    start_date: Optional[datetime] = None
-
-    status: Optional[Literal["PENDING", "COMPLETE", "FAILED", "EXPIRED"]] = None
-
-    updated_at: Optional[datetime] = None
+__all__ = ["MessagingCreateResponse"]
 
 
 class MessagingCreateResponse(BaseModel):
-    data: Optional[Data] = None
+    data: Optional[MdrDetailReportResponse] = None

telnyx/types/legacy/reporting/batch_detail_records/messaging_delete_response.py

@@ -1,68 +1,12 @@
 # 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 typing import Optional
 
 from ....._models import BaseModel
+from .mdr_detail_report_response import MdrDetailReportResponse
 
-__all__ = ["MessagingDeleteResponse", "Data", "DataFilter"]
-
-
-class DataFilter(BaseModel):
-    billing_group: Optional[str] = None
-    """Billing group UUID to filter by"""
-
-    cld: Optional[str] = None
-    """Called line identification (destination number)"""
-
-    cld_filter: Optional[Literal["contains", "starts_with", "ends_with"]] = None
-    """Filter type for CLD matching"""
-
-    cli: Optional[str] = None
-    """Calling line identification (caller ID)"""
-
-    cli_filter: Optional[Literal["contains", "starts_with", "ends_with"]] = None
-    """Filter type for CLI matching"""
-
-    filter_type: Optional[Literal["and", "or"]] = None
-    """Logical operator for combining filters"""
-
-    tags_list: Optional[str] = None
-    """Tag name to filter by"""
-
-
-class Data(BaseModel):
-    id: Optional[str] = None
-    """Identifies the resource"""
-
-    connections: Optional[List[int]] = None
-
-    created_at: Optional[datetime] = None
-
-    directions: Optional[List[Literal["INBOUND", "OUTBOUND"]]] = None
-
-    end_date: Optional[datetime] = None
-
-    filters: Optional[List[DataFilter]] = None
-
-    profiles: Optional[List[str]] = None
-    """List of messaging profile IDs"""
-
-    record_type: Optional[str] = None
-
-    record_types: Optional[List[Literal["INCOMPLETE", "COMPLETED", "ERRORS"]]] = None
-
-    report_name: Optional[str] = None
-
-    report_url: Optional[str] = None
-
-    start_date: Optional[datetime] = None
-
-    status: Optional[Literal["PENDING", "COMPLETE", "FAILED", "EXPIRED"]] = None
-
-    updated_at: Optional[datetime] = None
+__all__ = ["MessagingDeleteResponse"]
 
 
 class MessagingDeleteResponse(BaseModel):
-    data: Optional[Data] = None
+    data: Optional[MdrDetailReportResponse] = None

telnyx/types/legacy/reporting/batch_detail_records/messaging_list_response.py

@@ -1,80 +1,15 @@
 # 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 ....._models import BaseModel
+from .batch_csv_pagination_meta import BatchCsvPaginationMeta
+from .mdr_detail_report_response import MdrDetailReportResponse
 
-__all__ = ["MessagingListResponse", "Data", "DataFilter", "Meta"]
-
-
-class DataFilter(BaseModel):
-    billing_group: Optional[str] = None
-    """Billing group UUID to filter by"""
-
-    cld: Optional[str] = None
-    """Called line identification (destination number)"""
-
-    cld_filter: Optional[Literal["contains", "starts_with", "ends_with"]] = None
-    """Filter type for CLD matching"""
-
-    cli: Optional[str] = None
-    """Calling line identification (caller ID)"""
-
-    cli_filter: Optional[Literal["contains", "starts_with", "ends_with"]] = None
-    """Filter type for CLI matching"""
-
-    filter_type: Optional[Literal["and", "or"]] = None
-    """Logical operator for combining filters"""
-
-    tags_list: Optional[str] = None
-    """Tag name to filter by"""
-
-
-class Data(BaseModel):
-    id: Optional[str] = None
-    """Identifies the resource"""
-
-    connections: Optional[List[int]] = None
-
-    created_at: Optional[datetime] = None
-
-    directions: Optional[List[Literal["INBOUND", "OUTBOUND"]]] = None
-
-    end_date: Optional[datetime] = None
-
-    filters: Optional[List[DataFilter]] = None
-
-    profiles: Optional[List[str]] = None
-    """List of messaging profile IDs"""
-
-    record_type: Optional[str] = None
-
-    record_types: Optional[List[Literal["INCOMPLETE", "COMPLETED", "ERRORS"]]] = None
-
-    report_name: Optional[str] = None
-
-    report_url: Optional[str] = None
-
-    start_date: Optional[datetime] = None
-
-    status: Optional[Literal["PENDING", "COMPLETE", "FAILED", "EXPIRED"]] = None
-
-    updated_at: Optional[datetime] = None
-
-
-class Meta(BaseModel):
-    page_number: Optional[int] = None
-
-    page_size: Optional[int] = None
-
-    total_pages: Optional[int] = None
-
-    total_results: Optional[int] = None
+__all__ = ["MessagingListResponse"]
 
 
 class MessagingListResponse(BaseModel):
-    data: Optional[List[Data]] = None
+    data: Optional[List[MdrDetailReportResponse]] = None
 
-    meta: Optional[Meta] = None
+    meta: Optional[BatchCsvPaginationMeta] = None