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

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/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,16 @@
 
 from __future__ import annotations
 
-from typing import List
 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: SequenceNotStr[str]
     """List of IMEIs authorized to use a given SIM card."""
 
     data_limit: DataLimit
@@ -26,7 +26,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/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/texml_application_create_params.py

@@ -2,9 +2,9 @@
 
 from __future__ import annotations
 
-from typing import List
 from typing_extensions import Literal, Required, TypedDict
 
+from .._types import SequenceNotStr
 from .dtmf_type import DtmfType
 from .anchorsite_override import AnchorsiteOverride
 
@@ -56,7 +56,7 @@ class TexmlApplicationCreateParams(TypedDict, total=False):
     status_callback_method: Literal["get", "post"]
     """HTTP request method Telnyx should use when requesting the status_callback URL."""
 
-    tags: List[str]
+    tags: SequenceNotStr[str]
     """Tags associated with the Texml Application."""
 
     voice_fallback_url: str

telnyx/types/texml_application_update_params.py

@@ -2,9 +2,9 @@
 
 from __future__ import annotations
 
-from typing import List
 from typing_extensions import Literal, Required, TypedDict
 
+from .._types import SequenceNotStr
 from .dtmf_type import DtmfType
 from .anchorsite_override import AnchorsiteOverride
 
@@ -56,7 +56,7 @@ class TexmlApplicationUpdateParams(TypedDict, total=False):
     status_callback_method: Literal["get", "post"]
     """HTTP request method Telnyx should use when requesting the status_callback URL."""
 
-    tags: List[str]
+    tags: SequenceNotStr[str]
     """Tags associated with the Texml Application."""
 
     voice_fallback_url: str

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