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

telnyx/types/porting_orders/phone_number_configuration_list_params.py

@@ -3,11 +3,11 @@
 from __future__ import annotations
 
 from typing import List
-from typing_extensions import Literal, Annotated, TypedDict
+from typing_extensions import Literal, TypedDict
 
-from ..._utils import PropertyInfo
+from ..._types import SequenceNotStr
 
-__all__ = ["PhoneNumberConfigurationListParams", "Filter", "Page", "Sort"]
+__all__ = ["PhoneNumberConfigurationListParams", "Filter", "FilterPortingOrder", "Page", "Sort"]
 
 
 class PhoneNumberConfigurationListParams(TypedDict, total=False):
@@ -28,29 +28,30 @@ class PhoneNumberConfigurationListParams(TypedDict, total=False):
     """Consolidated sort parameter (deepObject style). Originally: sort[value]"""
 
 
-class Filter(TypedDict, total=False):
-    porting_order_status: Annotated[
-        List[
-            Literal[
-                "activation-in-progress",
-                "cancel-pending",
-                "cancelled",
-                "draft",
-                "exception",
-                "foc-date-confirmed",
-                "in-process",
-                "ported",
-                "submitted",
-            ]
-        ],
-        PropertyInfo(alias="porting_order.status"),
+class FilterPortingOrder(TypedDict, total=False):
+    status: List[
+        Literal[
+            "activation-in-progress",
+            "cancel-pending",
+            "cancelled",
+            "draft",
+            "exception",
+            "foc-date-confirmed",
+            "in-process",
+            "ported",
+            "submitted",
+        ]
     ]
     """Filter results by specific porting order statuses"""
 
-    porting_phone_number: List[str]
+
+class Filter(TypedDict, total=False):
+    porting_order: FilterPortingOrder
+
+    porting_phone_number: SequenceNotStr[str]
     """Filter results by a list of porting phone number IDs"""
 
-    user_bundle_id: List[str]
+    user_bundle_id: SequenceNotStr[str]
     """Filter results by a list of user bundle IDs"""
 
 

telnyx/types/porting_orders/verification_code_send_params.py

@@ -2,13 +2,14 @@
 
 from __future__ import annotations
 
-from typing import List
 from typing_extensions import Literal, TypedDict
 
+from ..._types import SequenceNotStr
+
 __all__ = ["VerificationCodeSendParams"]
 
 
 class VerificationCodeSendParams(TypedDict, total=False):
-    phone_numbers: List[str]
+    phone_numbers: SequenceNotStr[str]
 
     verification_method: Literal["sms", "call"]

telnyx/types/portout_list_params.py

@@ -6,6 +6,7 @@ from typing import List, Union
 from datetime import datetime
 from typing_extensions import Literal, Annotated, TypedDict
 
+from .._types import SequenceNotStr
 from .._utils import PropertyInfo
 
 __all__ = ["PortoutListParams", "Filter", "FilterInsertedAt", "FilterPortedOutAt", "Page"]
@@ -51,7 +52,7 @@ class Filter(TypedDict, total=False):
     country_code: str
     """Filter by 2-letter country code"""
 
-    country_code_in: List[str]
+    country_code_in: SequenceNotStr[str]
     """Filter by a list of 2-letter country codes"""
 
     foc_date: Annotated[Union[str, datetime], PropertyInfo(format="iso8601")]

telnyx/types/portouts/export_portouts_csv_report_param.py

@@ -6,6 +6,7 @@ from typing import List, Union
 from datetime import datetime
 from typing_extensions import Literal, Required, Annotated, TypedDict
 
+from ..._types import SequenceNotStr
 from ..._utils import PropertyInfo
 
 __all__ = ["ExportPortoutsCsvReportParam", "Filters"]
@@ -18,13 +19,13 @@ class Filters(TypedDict, total=False):
     created_at_lt: Annotated[Union[str, datetime], PropertyInfo(alias="created_at__lt", format="iso8601")]
     """The date and time the port-out was created before."""
 
-    customer_reference_in: Annotated[List[str], PropertyInfo(alias="customer_reference__in")]
+    customer_reference_in: Annotated[SequenceNotStr[str], PropertyInfo(alias="customer_reference__in")]
     """The customer reference of the port-outs to include in the report."""
 
     end_user_name: str
     """The end user name of the port-outs to include in the report."""
 
-    phone_numbers_overlaps: Annotated[List[str], PropertyInfo(alias="phone_numbers__overlaps")]
+    phone_numbers_overlaps: Annotated[SequenceNotStr[str], PropertyInfo(alias="phone_numbers__overlaps")]
     """A list of phone numbers that the port-outs phone numbers must overlap with."""
 
     status_in: Annotated[

telnyx/types/recordings/action_delete_params.py

@@ -2,12 +2,13 @@
 
 from __future__ import annotations
 
-from typing import List
 from typing_extensions import Required, TypedDict
 
+from ..._types import SequenceNotStr
+
 __all__ = ["ActionDeleteParams"]
 
 
 class ActionDeleteParams(TypedDict, total=False):
-    ids: Required[List[str]]
+    ids: Required[SequenceNotStr[str]]
     """List of call recording IDs to delete."""

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/report_list_wdrs_params.py

@@ -2,9 +2,10 @@
 
 from __future__ import annotations
 
-from typing import List
 from typing_extensions import TypedDict
 
+from .._types import SequenceNotStr
+
 __all__ = ["ReportListWdrsParams", "Page"]
 
 
@@ -42,7 +43,7 @@ class ReportListWdrsParams(TypedDict, total=False):
     sim_group_name: str
     """Sim group name"""
 
-    sort: List[str]
+    sort: SequenceNotStr[str]
     """Field used to order the data.
 
     If no field is specified, default value is 'created_at'

telnyx/types/reports/mdr_usage_report_fetch_sync_params.py

@@ -2,10 +2,11 @@
 
 from __future__ import annotations
 
-from typing import List, Union
+from typing import Union
 from datetime import datetime
 from typing_extensions import Literal, Required, Annotated, TypedDict
 
+from ..._types import SequenceNotStr
 from ..._utils import PropertyInfo
 
 __all__ = ["MdrUsageReportFetchSyncParams"]
@@ -16,6 +17,6 @@ class MdrUsageReportFetchSyncParams(TypedDict, total=False):
 
     end_date: Annotated[Union[str, datetime], PropertyInfo(format="iso8601")]
 
-    profiles: List[str]
+    profiles: SequenceNotStr[str]
 
     start_date: Annotated[Union[str, datetime], PropertyInfo(format="iso8601")]

telnyx/types/rooms/sessions/action_kick_params.py

@@ -2,17 +2,19 @@
 
 from __future__ import annotations
 
-from typing import List, Union
+from typing import Union
 from typing_extensions import Literal, TypedDict
 
+from ...._types import SequenceNotStr
+
 __all__ = ["ActionKickParams"]
 
 
 class ActionKickParams(TypedDict, total=False):
-    exclude: List[str]
+    exclude: SequenceNotStr[str]
     """List of participant id to exclude from the action."""
 
-    participants: Union[Literal["all"], List[str]]
+    participants: Union[Literal["all"], SequenceNotStr[str]]
     """
     Either a list of participant id to perform the action on, or the keyword "all"
     to perform the action on all participant.

telnyx/types/rooms/sessions/action_mute_params.py

@@ -2,17 +2,19 @@
 
 from __future__ import annotations
 
-from typing import List, Union
+from typing import Union
 from typing_extensions import Literal, TypedDict
 
+from ...._types import SequenceNotStr
+
 __all__ = ["ActionMuteParams"]
 
 
 class ActionMuteParams(TypedDict, total=False):
-    exclude: List[str]
+    exclude: SequenceNotStr[str]
     """List of participant id to exclude from the action."""
 
-    participants: Union[Literal["all"], List[str]]
+    participants: Union[Literal["all"], SequenceNotStr[str]]
     """
     Either a list of participant id to perform the action on, or the keyword "all"
     to perform the action on all participant.

telnyx/types/rooms/sessions/action_unmute_params.py

@@ -2,17 +2,19 @@
 
 from __future__ import annotations
 
-from typing import List, Union
+from typing import Union
 from typing_extensions import Literal, TypedDict
 
+from ...._types import SequenceNotStr
+
 __all__ = ["ActionUnmuteParams"]
 
 
 class ActionUnmuteParams(TypedDict, total=False):
-    exclude: List[str]
+    exclude: SequenceNotStr[str]
     """List of participant id to exclude from the action."""
 
-    participants: Union[Literal["all"], List[str]]
+    participants: Union[Literal["all"], SequenceNotStr[str]]
     """
     Either a list of participant id to perform the action on, or the keyword "all"
     to perform the action on all participant.

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/{error.py → shared/api_error.py}

@@ -2,9 +2,9 @@
 
 from typing import Dict, Optional
 
-from .._models import BaseModel
+from ..._models import BaseModel
 
-__all__ = ["Error", "Source"]
+__all__ = ["APIError", "Source"]
 
 
 class Source(BaseModel):
@@ -15,7 +15,7 @@ class Source(BaseModel):
     """JSON pointer (RFC6901) to the offending entity."""
 
 
-class Error(BaseModel):
+class APIError(BaseModel):
     code: str
 
     title: str

telnyx/types/shared/simple_sim_card.py

@@ -28,6 +28,9 @@ class SimpleSimCard(BaseModel):
     actions_in_progress: Optional[bool] = None
     """Indicate whether the SIM card has any pending (in-progress) actions."""
 
+    authorized_imeis: Optional[List[str]] = None
+    """List of IMEIs authorized to use a given SIM card."""
+
     created_at: Optional[str] = None
     """ISO 8601 formatted date-time indicating when the resource was created."""
 
@@ -37,6 +40,12 @@ class SimpleSimCard(BaseModel):
     data_limit: Optional[DataLimit] = None
     """The SIM card individual data limit configuration."""
 
+    eid: Optional[str] = None
+    """The Embedded Identity Document (eID) for eSIM cards."""
+
+    esim_installation_status: Optional[Literal["released", "disabled"]] = None
+    """The installation status of the eSIM. Only applicable for eSIM cards."""
+
     iccid: Optional[str] = None
     """The ICCID is the identifier of the specific SIM card/chip.
 
@@ -66,6 +75,9 @@ class SimpleSimCard(BaseModel):
 
     record_type: Optional[str] = None
 
+    resources_with_in_progress_actions: Optional[List[object]] = None
+    """List of resources with actions in progress."""
+
     sim_card_group_id: Optional[str] = None
     """The group SIMCardGroup identification.
 
@@ -83,3 +95,6 @@ class SimpleSimCard(BaseModel):
 
     updated_at: Optional[str] = None
     """ISO 8601 formatted date-time indicating when the resource was updated."""
+
+    version: Optional[str] = None
+    """The version of the SIM card."""

telnyx/types/sim_card.py

@@ -103,6 +103,12 @@ class SimCard(BaseModel):
     data_limit: Optional[DataLimit] = None
     """The SIM card individual data limit configuration."""
 
+    eid: Optional[str] = None
+    """The Embedded Identity Document (eID) for eSIM cards."""
+
+    esim_installation_status: Optional[Literal["released", "disabled"]] = None
+    """The installation status of the eSIM. Only applicable for eSIM cards."""
+
     iccid: Optional[str] = None
     """The ICCID is the identifier of the specific SIM card/chip.
 
@@ -158,6 +164,9 @@ class SimCard(BaseModel):
 
     record_type: Optional[str] = None
 
+    resources_with_in_progress_actions: Optional[List[object]] = None
+    """List of resources with actions in progress."""
+
     sim_card_group_id: Optional[str] = None
     """The group SIMCardGroup identification.
 
@@ -175,3 +184,6 @@ class SimCard(BaseModel):
 
     updated_at: Optional[str] = None
     """ISO 8601 formatted date-time indicating when the resource was updated."""
+
+    version: Optional[str] = None
+    """The version of the SIM card."""

telnyx/types/sim_card_list_params.py

@@ -5,6 +5,7 @@ from __future__ import annotations
 from typing import List
 from typing_extensions import Literal, Annotated, TypedDict
 
+from .._types import SequenceNotStr
 from .._utils import PropertyInfo
 
 __all__ = ["SimCardListParams", "Filter", "Page"]
@@ -43,7 +44,7 @@ class Filter(TypedDict, total=False):
     status: List[Literal["enabled", "disabled", "standby", "data_limit_exceeded", "unauthorized_imei"]]
     """Filter by a SIM card's status."""
 
-    tags: List[str]
+    tags: SequenceNotStr[str]
     """
     A list of SIM card tags to filter on.<br/><br/> If the SIM card contains
     <b><i>all</i></b> of the given <code>tags</code> they will be found.<br/><br/>

telnyx/types/sim_card_update_params.py

@@ -2,16 +2,17 @@
 
 from __future__ import annotations
 
-from typing import List
+from typing import Optional
 from typing_extensions import Literal, TypedDict
 
+from .._types import SequenceNotStr
 from .shared_params.sim_card_status import SimCardStatus
 
 __all__ = ["SimCardUpdateParams", "DataLimit"]
 
 
 class SimCardUpdateParams(TypedDict, total=False):
-    authorized_imeis: List[str]
+    authorized_imeis: Optional[SequenceNotStr[str]]
     """List of IMEIs authorized to use a given SIM card."""
 
     data_limit: DataLimit
@@ -26,7 +27,7 @@ class SimCardUpdateParams(TypedDict, total=False):
 
     status: SimCardStatus
 
-    tags: List[str]
+    tags: SequenceNotStr[str]
     """Searchable tags associated with the SIM card"""
 
 

telnyx/types/sim_cards/action_bulk_set_public_ips_params.py

@@ -2,11 +2,12 @@
 
 from __future__ import annotations
 
-from typing import List
 from typing_extensions import Required, TypedDict
 
+from ..._types import SequenceNotStr
+
 __all__ = ["ActionBulkSetPublicIPsParams"]
 
 
 class ActionBulkSetPublicIPsParams(TypedDict, total=False):
-    sim_card_ids: Required[List[str]]
+    sim_card_ids: Required[SequenceNotStr[str]]

telnyx/types/sim_cards/action_validate_registration_codes_params.py

@@ -2,11 +2,12 @@
 
 from __future__ import annotations
 
-from typing import List
 from typing_extensions import TypedDict
 
+from ..._types import SequenceNotStr
+
 __all__ = ["ActionValidateRegistrationCodesParams"]
 
 
 class ActionValidateRegistrationCodesParams(TypedDict, total=False):
-    registration_codes: List[str]
+    registration_codes: SequenceNotStr[str]

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/stream_bidirectional_codec.py

@@ -4,4 +4,4 @@ from typing_extensions import Literal, TypeAlias
 
 __all__ = ["StreamBidirectionalCodec"]
 
-StreamBidirectionalCodec: TypeAlias = Literal["PCMU", "PCMA", "G722", "OPUS", "AMR-WB"]
+StreamBidirectionalCodec: TypeAlias = Literal["PCMU", "PCMA", "G722", "OPUS", "AMR-WB", "L16"]

telnyx/types/stream_codec.py

@@ -4,4 +4,4 @@ from typing_extensions import Literal, TypeAlias
 
 __all__ = ["StreamCodec"]
 
-StreamCodec: TypeAlias = Literal["PCMA", "PCMU", "default"]
+StreamCodec: TypeAlias = Literal["PCMU", "PCMA", "G722", "OPUS", "AMR-WB", "L16", "default"]

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