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

telnyx/types/phone_numbers/phone_numbers_job.py

@@ -5,49 +5,16 @@ from datetime import datetime
 from typing_extensions import Literal
 
 from ..._models import BaseModel
+from ..phone_number_blocks.job_error import JobError
 
-__all__ = [
-    "PhoneNumbersJob",
-    "FailedOperation",
-    "FailedOperationError",
-    "FailedOperationErrorMeta",
-    "FailedOperationErrorSource",
-    "PendingOperation",
-    "PhoneNumber",
-    "SuccessfulOperation",
-]
-
-
-class FailedOperationErrorMeta(BaseModel):
-    url: Optional[str] = None
-    """URL with additional information on the error."""
-
-
-class FailedOperationErrorSource(BaseModel):
-    parameter: Optional[str] = None
-    """Indicates which query parameter caused the error."""
-
-    pointer: Optional[str] = None
-    """JSON pointer (RFC6901) to the offending entity."""
-
-
-class FailedOperationError(BaseModel):
-    code: str
-
-    title: str
-
-    detail: Optional[str] = None
-
-    meta: Optional[FailedOperationErrorMeta] = None
-
-    source: Optional[FailedOperationErrorSource] = None
+__all__ = ["PhoneNumbersJob", "FailedOperation", "PendingOperation", "PhoneNumber", "SuccessfulOperation"]
 
 
 class FailedOperation(BaseModel):
     id: Optional[str] = None
     """The phone number's ID"""
 
-    errors: Optional[List[FailedOperationError]] = None
+    errors: Optional[List[JobError]] = None
 
     phone_number: Optional[str] = None
     """The phone number in e164 format."""

telnyx/types/replaced_link_click_webhook_event1.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/report_list_mdrs_response.py

@@ -5,8 +5,9 @@ from datetime import datetime
 from typing_extensions import Literal
 
 from .._models import BaseModel
+from .reports.pagination_meta_reporting import PaginationMetaReporting
 
-__all__ = ["ReportListMdrsResponse", "Data", "Meta"]
+__all__ = ["ReportListMdrsResponse", "Data"]
 
 
 class Data(BaseModel):
@@ -58,17 +59,7 @@ class Data(BaseModel):
     """Message status"""
 
 
-class Meta(BaseModel):
-    page_number: Optional[int] = None
-
-    page_size: Optional[int] = None
-
-    total_pages: Optional[int] = None
-
-    total_results: Optional[int] = None
-
-
 class ReportListMdrsResponse(BaseModel):
     data: Optional[List[Data]] = None
 
-    meta: Optional[Meta] = None
+    meta: Optional[PaginationMetaReporting] = None

telnyx/types/reports/__init__.py

@@ -3,6 +3,7 @@
 from __future__ import annotations
 
 from .mdr_usage_report import MdrUsageReport as MdrUsageReport
+from .pagination_meta_reporting import PaginationMetaReporting as PaginationMetaReporting
 from .mdr_usage_report_list_params import MdrUsageReportListParams as MdrUsageReportListParams
 from .mdr_usage_report_create_params import MdrUsageReportCreateParams as MdrUsageReportCreateParams
 from .mdr_usage_report_list_response import MdrUsageReportListResponse as MdrUsageReportListResponse

telnyx/types/reports/mdr_usage_report_list_response.py

@@ -4,21 +4,12 @@ from typing import List, Optional
 
 from ..._models import BaseModel
 from .mdr_usage_report import MdrUsageReport
+from .pagination_meta_reporting import PaginationMetaReporting
 
-__all__ = ["MdrUsageReportListResponse", "Meta"]
-
-
-class Meta(BaseModel):
-    page_number: Optional[int] = None
-
-    page_size: Optional[int] = None
-
-    total_pages: Optional[int] = None
-
-    total_results: Optional[int] = None
+__all__ = ["MdrUsageReportListResponse"]
 
 
 class MdrUsageReportListResponse(BaseModel):
     data: Optional[List[MdrUsageReport]] = None
 
-    meta: Optional[Meta] = None
+    meta: Optional[PaginationMetaReporting] = None

telnyx/types/reports/pagination_meta_reporting.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__ = ["PaginationMetaReporting"]
+
+
+class PaginationMetaReporting(BaseModel):
+    page_number: Optional[int] = None
+
+    page_size: Optional[int] = None
+
+    total_pages: Optional[int] = None
+
+    total_results: Optional[int] = None

telnyx/types/requirement_group.py

@@ -20,7 +20,7 @@ class RegulatoryRequirement(BaseModel):
 
     requirement_id: Optional[str] = None
 
-    status: Optional[Literal["approved", "unapproved", "pending-approval", "declined"]] = None
+    status: Optional[Literal["approved", "unapproved", "pending-approval", "declined", "expired"]] = None
 
     updated_at: Optional[datetime] = None
 
@@ -42,6 +42,6 @@ class RequirementGroup(BaseModel):
 
     regulatory_requirements: Optional[List[RegulatoryRequirement]] = None
 
-    status: Optional[Literal["approved", "unapproved", "pending-approval", "declined"]] = None
+    status: Optional[Literal["approved", "unapproved", "pending-approval", "declined", "expired"]] = None
 
     updated_at: Optional[datetime] = None

telnyx/types/requirement_group_list_params.py

@@ -29,5 +29,5 @@ class Filter(TypedDict, total=False):
     phone_number_type: Literal["local", "toll_free", "mobile", "national", "shared_cost"]
     """Filter requirement groups by phone number type."""
 
-    status: Literal["approved", "unapproved", "pending-approval", "declined"]
+    status: Literal["approved", "unapproved", "pending-approval", "declined", "expired"]
     """Filter requirement groups by status"""

telnyx/types/shared/__init__.py

@@ -1,6 +1,7 @@
 # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 from .metadata import Metadata as Metadata
+from .api_error import APIError as APIError
 from .short_code import ShortCode as ShortCode
 from .hosted_number import HostedNumber as HostedNumber
 from .sim_card_status import SimCardStatus as SimCardStatus

telnyx/types/{api_error.py → shared/api_error.py}

@@ -2,7 +2,7 @@
 
 from typing import Dict, Optional
 
-from .._models import BaseModel
+from ..._models import BaseModel
 
 __all__ = ["APIError", "Source"]
 

telnyx/types/stream_bidirectional_sampling_rate.py

@@ -0,0 +1,7 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing_extensions import Literal, TypeAlias
+
+__all__ = ["StreamBidirectionalSamplingRate"]
+
+StreamBidirectionalSamplingRate: TypeAlias = Literal[8000, 16000, 22050, 24000, 48000]

telnyx/types/streaming_failed_webhook_event1.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_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__ = ["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_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__ = ["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/texml/accounts/call_calls_params.py

@@ -2,11 +2,12 @@
 
 from __future__ import annotations
 
+from typing import Iterable
 from typing_extensions import Literal, Required, Annotated, TypedDict
 
 from ...._utils import PropertyInfo
 
-__all__ = ["CallCallsParams"]
+__all__ = ["CallCallsParams", "CustomHeader"]
 
 
 class CallCallsParams(TypedDict, total=False):
@@ -59,6 +60,12 @@ class CallCallsParams(TypedDict, total=False):
     cancel_playback_on_machine_detection: Annotated[bool, PropertyInfo(alias="CancelPlaybackOnMachineDetection")]
     """Whether to cancel ongoing playback on `machine` detection. Defaults to `true`."""
 
+    custom_headers: Annotated[Iterable[CustomHeader], PropertyInfo(alias="CustomHeaders")]
+    """Custom HTTP headers to be sent with the call.
+
+    Each header should be an object with 'name' and 'value' properties.
+    """
+
     detection_mode: Annotated[Literal["Premium", "Regular"], PropertyInfo(alias="DetectionMode")]
     """Allows you to chose between Premium and Standard detections."""
 
@@ -167,3 +174,11 @@ class CallCallsParams(TypedDict, total=False):
 
     The default value is inherited from TeXML Application setting.
     """
+
+
+class CustomHeader(TypedDict, total=False):
+    name: Required[str]
+    """The name of the custom header"""
+
+    value: Required[str]
+    """The value of the custom header"""

telnyx/types/texml/accounts/conferences/participant_participants_params.py

@@ -2,11 +2,12 @@
 
 from __future__ import annotations
 
+from typing import Iterable
 from typing_extensions import Literal, Required, Annotated, TypedDict
 
 from ....._utils import PropertyInfo
 
-__all__ = ["ParticipantParticipantsParams"]
+__all__ = ["ParticipantParticipantsParams", "CustomHeader"]
 
 
 class ParticipantParticipantsParams(TypedDict, total=False):
@@ -113,6 +114,12 @@ class ParticipantParticipantsParams(TypedDict, total=False):
     Defaults to `trim-silence`.
     """
 
+    custom_headers: Annotated[Iterable[CustomHeader], PropertyInfo(alias="CustomHeaders")]
+    """Custom HTTP headers to be sent with the call.
+
+    Each header should be an object with 'name' and 'value' properties.
+    """
+
     early_media: Annotated[bool, PropertyInfo(alias="EarlyMedia")]
     """
     Whether participant shall be bridged to conference before the participant
@@ -249,3 +256,11 @@ class ParticipantParticipantsParams(TypedDict, total=False):
     The URL to call for an audio file to play while the participant is waiting for
     the conference to start.
     """
+
+
+class CustomHeader(TypedDict, total=False):
+    name: Required[str]
+    """The name of the custom header"""
+
+    value: Required[str]
+    """The value of the custom header"""

telnyx/types/transcription_webhook_event1.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