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

telnyx/types/conferences/action_mute_params.py

@@ -2,14 +2,15 @@
 
 from __future__ import annotations
 
-from typing import List
 from typing_extensions import TypedDict
 
+from ..._types import SequenceNotStr
+
 __all__ = ["ActionMuteParams"]
 
 
 class ActionMuteParams(TypedDict, total=False):
-    call_control_ids: List[str]
+    call_control_ids: SequenceNotStr[str]
     """Array of unique identifiers and tokens for controlling the call.
 
     When empty all participants will be muted.

telnyx/types/conferences/action_play_params.py

@@ -2,9 +2,9 @@
 
 from __future__ import annotations
 
-from typing import List
 from typing_extensions import TypedDict
 
+from ..._types import SequenceNotStr
 from ..calls.loopcount_param import LoopcountParam
 
 __all__ = ["ActionPlayParams"]
@@ -17,7 +17,7 @@ class ActionPlayParams(TypedDict, total=False):
     media_name and audio_url cannot be used together in one request.
     """
 
-    call_control_ids: List[str]
+    call_control_ids: SequenceNotStr[str]
     """
     List of call control ids identifying participants the audio file should be
     played to. If not given, the audio file will be played to the entire conference.

telnyx/types/conferences/action_speak_params.py

@@ -2,9 +2,10 @@
 
 from __future__ import annotations
 
-from typing import List, Union
+from typing import Union
 from typing_extensions import Literal, Required, TypeAlias, TypedDict
 
+from ..._types import SequenceNotStr
 from ..calls.aws_voice_settings_param import AwsVoiceSettingsParam
 from ..calls.telnyx_voice_settings_param import TelnyxVoiceSettingsParam
 from ..calls.eleven_labs_voice_settings_param import ElevenLabsVoiceSettingsParam
@@ -47,7 +48,7 @@ class ActionSpeakParams(TypedDict, total=False):
     female).
     """
 
-    call_control_ids: List[str]
+    call_control_ids: SequenceNotStr[str]
     """Call Control IDs of participants who will hear the spoken text.
 
     When empty all participants will hear the spoken text.

telnyx/types/conferences/action_stop_params.py

@@ -2,14 +2,15 @@
 
 from __future__ import annotations
 
-from typing import List
 from typing_extensions import TypedDict
 
+from ..._types import SequenceNotStr
+
 __all__ = ["ActionStopParams"]
 
 
 class ActionStopParams(TypedDict, total=False):
-    call_control_ids: List[str]
+    call_control_ids: SequenceNotStr[str]
     """
     List of call control ids identifying participants the audio file should stop be
     played to. If not given, the audio will be stoped to the entire conference.

telnyx/types/conferences/action_unhold_params.py

@@ -2,14 +2,15 @@
 
 from __future__ import annotations
 
-from typing import List
 from typing_extensions import Required, TypedDict
 
+from ..._types import SequenceNotStr
+
 __all__ = ["ActionUnholdParams"]
 
 
 class ActionUnholdParams(TypedDict, total=False):
-    call_control_ids: Required[List[str]]
+    call_control_ids: Required[SequenceNotStr[str]]
     """List of unique identifiers and tokens for controlling the call.
 
     Enter each call control ID to be unheld.

telnyx/types/conferences/action_unmute_params.py

@@ -2,14 +2,15 @@
 
 from __future__ import annotations
 
-from typing import List
 from typing_extensions import TypedDict
 
+from ..._types import SequenceNotStr
+
 __all__ = ["ActionUnmuteParams"]
 
 
 class ActionUnmuteParams(TypedDict, total=False):
-    call_control_ids: List[str]
+    call_control_ids: SequenceNotStr[str]
     """List of unique identifiers and tokens for controlling the call.
 
     Enter each call control ID to be unmuted. When empty all participants will be

telnyx/types/conferences/action_update_params.py

@@ -2,9 +2,10 @@
 
 from __future__ import annotations
 
-from typing import List
 from typing_extensions import Literal, Required, TypedDict
 
+from ..._types import SequenceNotStr
+
 __all__ = ["ActionUpdateParams"]
 
 
@@ -29,7 +30,7 @@ class ActionUpdateParams(TypedDict, total=False):
     has already been executed.
     """
 
-    whisper_call_control_ids: List[str]
+    whisper_call_control_ids: SequenceNotStr[str]
     """Array of unique call_control_ids the supervisor can whisper to.
 
     If none provided, the supervisor will join the conference as a monitoring

telnyx/types/credential_connection_create_params.py

@@ -2,9 +2,10 @@
 
 from __future__ import annotations
 
-from typing import List, Optional
+from typing import Optional
 from typing_extensions import Literal, Required, TypedDict
 
+from .._types import SequenceNotStr
 from .dtmf_type import DtmfType
 from .encrypted_media import EncryptedMedia
 from .anchorsite_override import AnchorsiteOverride
@@ -96,7 +97,7 @@ class CredentialConnectionCreateParams(TypedDict, total=False):
     account (internal).
     """
 
-    tags: List[str]
+    tags: SequenceNotStr[str]
     """Tags associated with the connection."""
 
     webhook_api_version: Literal["1", "2", "texml"]

telnyx/types/credential_connection_update_params.py

@@ -2,9 +2,10 @@
 
 from __future__ import annotations
 
-from typing import List, Optional
+from typing import Optional
 from typing_extensions import Literal, TypedDict
 
+from .._types import SequenceNotStr
 from .dtmf_type import DtmfType
 from .encrypted_media import EncryptedMedia
 from .anchorsite_override import AnchorsiteOverride
@@ -89,7 +90,7 @@ class CredentialConnectionUpdateParams(TypedDict, total=False):
     account (internal).
     """
 
-    tags: List[str]
+    tags: SequenceNotStr[str]
     """Tags associated with the connection."""
 
     user_name: str

telnyx/types/credential_inbound_param.py

@@ -2,9 +2,10 @@
 
 from __future__ import annotations
 
-from typing import List
 from typing_extensions import Literal, TypedDict
 
+from .._types import SequenceNotStr
+
 __all__ = ["CredentialInboundParam"]
 
 
@@ -21,7 +22,7 @@ class CredentialInboundParam(TypedDict, total=False):
     associated with this connection.
     """
 
-    codecs: List[str]
+    codecs: SequenceNotStr[str]
     """
     Defines the list of codecs that Telnyx will send for inbound calls to a specific
     number on your portal account, in priority order. This only works when the

telnyx/types/custom_sip_header.py

@@ -0,0 +1,13 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from .._models import BaseModel
+
+__all__ = ["CustomSipHeader"]
+
+
+class CustomSipHeader(BaseModel):
+    name: str
+    """The name of the header to add."""
+
+    value: str
+    """The value of the header."""

telnyx/types/customer_service_record_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__ = [
@@ -49,7 +50,7 @@ class FilterCreatedAt(TypedDict, total=False):
 _FilterPhoneNumberReservedKeywords = TypedDict(
     "_FilterPhoneNumberReservedKeywords",
     {
-        "in": List[str],
+        "in": SequenceNotStr[str],
     },
     total=False,
 )

telnyx/types/customer_service_record_status_changed_webhook_event.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/customer_service_record_verify_phone_number_coverage_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__ = ["CustomerServiceRecordVerifyPhoneNumberCoverageParams"]
 
 
 class CustomerServiceRecordVerifyPhoneNumberCoverageParams(TypedDict, total=False):
-    phone_numbers: Required[List[str]]
+    phone_numbers: Required[SequenceNotStr[str]]
     """The phone numbers list to be verified."""

telnyx/types/delivery_update_webhook_event.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/detail_record_list_params.py

@@ -2,9 +2,11 @@
 
 from __future__ import annotations
 
-from typing import Dict, List, Union
+from typing import Dict, Union
 from typing_extensions import Literal, Required, TypeAlias, TypedDict
 
+from .._types import SequenceNotStr
+
 __all__ = ["DetailRecordListParams", "Filter", "Page"]
 
 
@@ -22,7 +24,7 @@ class DetailRecordListParams(TypedDict, total=False):
     Originally: page[number], page[size]
     """
 
-    sort: List[str]
+    sort: SequenceNotStr[str]
     """Specifies the sort order for results. <br/>Example: sort=-created_at"""
 
 

telnyx/types/document_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__ = ["DocumentListParams", "Filter", "FilterCreatedAt", "FilterCustomerReference", "FilterFilename", "Page"]
@@ -43,7 +44,7 @@ class FilterCreatedAt(TypedDict, total=False):
 _FilterCustomerReferenceReservedKeywords = TypedDict(
     "_FilterCustomerReferenceReservedKeywords",
     {
-        "in": List[str],
+        "in": SequenceNotStr[str],
     },
     total=False,
 )

telnyx/types/external_connection_create_params.py

@@ -2,9 +2,11 @@
 
 from __future__ import annotations
 
-from typing import List, Optional
+from typing import Optional
 from typing_extensions import Literal, Required, TypedDict
 
+from .._types import SequenceNotStr
+
 __all__ = ["ExternalConnectionCreateParams", "Outbound", "Inbound"]
 
 
@@ -19,7 +21,7 @@ class ExternalConnectionCreateParams(TypedDict, total=False):
 
     inbound: Inbound
 
-    tags: List[str]
+    tags: SequenceNotStr[str]
     """Tags associated with the connection."""
 
     webhook_event_failover_url: Optional[str]

telnyx/types/external_connection_update_params.py

@@ -2,9 +2,11 @@
 
 from __future__ import annotations
 
-from typing import List, Optional
+from typing import Optional
 from typing_extensions import Required, TypedDict
 
+from .._types import SequenceNotStr
+
 __all__ = ["ExternalConnectionUpdateParams", "Outbound", "Inbound"]
 
 
@@ -16,7 +18,7 @@ class ExternalConnectionUpdateParams(TypedDict, total=False):
 
     inbound: Inbound
 
-    tags: List[str]
+    tags: SequenceNotStr[str]
     """Tags associated with the connection."""
 
     webhook_event_failover_url: Optional[str]

telnyx/types/external_connections/civic_address_list_params.py

@@ -2,9 +2,10 @@
 
 from __future__ import annotations
 
-from typing import List
 from typing_extensions import TypedDict
 
+from ..._types import SequenceNotStr
+
 __all__ = ["CivicAddressListParams", "Filter"]
 
 
@@ -17,5 +18,5 @@ class CivicAddressListParams(TypedDict, total=False):
 
 
 class Filter(TypedDict, total=False):
-    country: List[str]
+    country: SequenceNotStr[str]
     """The country (or countries) to filter addresses by."""

telnyx/types/external_connections/upload_create_params.py

@@ -5,11 +5,13 @@ from __future__ import annotations
 from typing import List
 from typing_extensions import Literal, Required, TypedDict
 
+from ..._types import SequenceNotStr
+
 __all__ = ["UploadCreateParams"]
 
 
 class UploadCreateParams(TypedDict, total=False):
-    number_ids: Required[List[str]]
+    number_ids: Required[SequenceNotStr[str]]
 
     additional_usages: List[Literal["calling_user_assignment", "first_party_app_assignment"]]
 

telnyx/types/fax_application_create_params.py

@@ -2,9 +2,10 @@
 
 from __future__ import annotations
 
-from typing import List, Optional
+from typing import Optional
 from typing_extensions import Literal, Required, TypedDict
 
+from .._types import SequenceNotStr
 from .anchorsite_override import AnchorsiteOverride
 
 __all__ = ["FaxApplicationCreateParams", "Inbound", "Outbound"]
@@ -34,7 +35,7 @@ class FaxApplicationCreateParams(TypedDict, total=False):
 
     outbound: Outbound
 
-    tags: List[str]
+    tags: SequenceNotStr[str]
     """Tags associated with the Fax Application."""
 
     webhook_event_failover_url: Optional[str]

telnyx/types/fax_application_update_params.py

@@ -2,9 +2,10 @@
 
 from __future__ import annotations
 
-from typing import List, Optional
+from typing import Optional
 from typing_extensions import Literal, Required, TypedDict
 
+from .._types import SequenceNotStr
 from .anchorsite_override import AnchorsiteOverride
 
 __all__ = ["FaxApplicationUpdateParams", "Inbound", "Outbound"]
@@ -40,7 +41,7 @@ class FaxApplicationUpdateParams(TypedDict, total=False):
 
     outbound: Outbound
 
-    tags: List[str]
+    tags: SequenceNotStr[str]
     """Tags associated with the Fax Application."""
 
     webhook_event_failover_url: Optional[str]

telnyx/types/fax_delivered_webhook_event.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_event.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."""