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

telnyx/types/phone_numbers/job_update_batch_params.py

@@ -2,9 +2,9 @@
 
 from __future__ import annotations
 
-from typing import List
 from typing_extensions import Literal, Required, Annotated, TypedDict
 
+from ..._types import SequenceNotStr
 from ..._utils import PropertyInfo
 from .update_voice_settings_param import UpdateVoiceSettingsParam
 
@@ -12,7 +12,7 @@ __all__ = ["JobUpdateBatchParams", "Filter", "FilterVoiceConnectionName"]
 
 
 class JobUpdateBatchParams(TypedDict, total=False):
-    phone_numbers: Required[List[str]]
+    phone_numbers: Required[SequenceNotStr[str]]
     """Array of phone number ids and/or phone numbers in E164 format to update.
 
     This parameter is required if no filter parameters are provided. If you want to
@@ -39,6 +39,13 @@ class JobUpdateBatchParams(TypedDict, total=False):
     customer_reference: str
     """A customer reference string for customer look ups."""
 
+    deletion_lock_enabled: bool
+    """Indicates whether to enable or disable the deletion lock on each phone number.
+
+    When enabled, this prevents the phone number from being deleted via the API or
+    Telnyx portal.
+    """
+
     external_pin: str
     """
     If someone attempts to port your phone number away from Telnyx and your phone
@@ -54,7 +61,7 @@ class JobUpdateBatchParams(TypedDict, total=False):
     details about it can be found in the Telnyx support documentation.
     """
 
-    tags: List[str]
+    tags: SequenceNotStr[str]
     """A list of user-assigned tags to help organize phone numbers."""
 
     voice: UpdateVoiceSettingsParam

telnyx/types/phone_numbers/job_update_emergency_settings_batch_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__ = ["JobUpdateEmergencySettingsBatchParams"]
 
 
@@ -12,7 +14,7 @@ class JobUpdateEmergencySettingsBatchParams(TypedDict, total=False):
     emergency_enabled: Required[bool]
     """Indicates whether to enable or disable emergency services on the numbers."""
 
-    phone_numbers: Required[List[str]]
+    phone_numbers: Required[SequenceNotStr[str]]
 
     emergency_address_id: Optional[str]
     """Identifies the address to be used with emergency services.

telnyx/types/portability_check_run_params.py

@@ -2,12 +2,13 @@
 
 from __future__ import annotations
 
-from typing import List
 from typing_extensions import TypedDict
 
+from .._types import SequenceNotStr
+
 __all__ = ["PortabilityCheckRunParams"]
 
 
 class PortabilityCheckRunParams(TypedDict, total=False):
-    phone_numbers: List[str]
+    phone_numbers: SequenceNotStr[str]
     """The list of +E.164 formatted phone numbers to check for portability"""

telnyx/types/porting/export_porting_orders_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__ = ["ExportPortingOrdersCsvReportParam", "Filters"]
@@ -18,7 +19,7 @@ class Filters(TypedDict, total=False):
     created_at_lt: Annotated[Union[str, datetime], PropertyInfo(alias="created_at__lt", format="iso8601")]
     """The date and time the porting order 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 porting orders to include in the report."""
 
     status_in: Annotated[

telnyx/types/porting_order.py

@@ -33,6 +33,9 @@ class PortingOrder(BaseModel):
     created_at: Optional[datetime] = None
     """ISO 8601 formatted date indicating when the resource was created."""
 
+    customer_group_reference: Optional[str] = None
+    """A customer-specified group reference for customer bookkeeping purposes"""
+
     customer_reference: Optional[str] = None
     """A customer-specified reference number for customer bookkeeping purposes"""
 

telnyx/types/porting_order_create_params.py

@@ -2,15 +2,19 @@
 
 from __future__ import annotations
 
-from typing import List
 from typing_extensions import Required, TypedDict
 
+from .._types import SequenceNotStr
+
 __all__ = ["PortingOrderCreateParams"]
 
 
 class PortingOrderCreateParams(TypedDict, total=False):
-    phone_numbers: Required[List[str]]
+    phone_numbers: Required[SequenceNotStr[str]]
     """The list of +E.164 formatted phone numbers"""
 
+    customer_group_reference: str
+    """A customer-specified group reference for customer bookkeeping purposes"""
+
     customer_reference: str
     """A customer-specified reference number for customer bookkeeping purposes"""

telnyx/types/porting_order_list_params.py

@@ -2,15 +2,19 @@
 
 from __future__ import annotations
 
-from typing_extensions import Literal, Annotated, TypedDict
+from typing_extensions import Literal, TypedDict
 
-from .._utils import PropertyInfo
 from .porting_order_type import PortingOrderType
 
 __all__ = [
     "PortingOrderListParams",
     "Filter",
+    "FilterActivationSettings",
     "FilterActivationSettingsFocDatetimeRequested",
+    "FilterEndUser",
+    "FilterEndUserAdmin",
+    "FilterMisc",
+    "FilterPhoneNumbers",
     "FilterPhoneNumbersPhoneNumber",
     "Page",
     "Sort",
@@ -21,10 +25,10 @@ class PortingOrderListParams(TypedDict, total=False):
     filter: Filter
     """Consolidated filter parameter (deepObject style).
 
-    Originally: filter[customer_reference], filter[parent_support_key],
-    filter[phone_numbers.country_code], filter[phone_numbers.carrier_name],
-    filter[misc.type], filter[end_user.admin.entity_name],
-    filter[end_user.admin.auth_person_name],
+    Originally: filter[customer_reference], filter[customer_group_reference],
+    filter[parent_support_key], filter[phone_numbers.country_code],
+    filter[phone_numbers.carrier_name], filter[misc.type],
+    filter[end_user.admin.entity_name], filter[end_user.admin.auth_person_name],
     filter[activation_settings.fast_port_eligible],
     filter[activation_settings.foc_datetime_requested][gt],
     filter[activation_settings.foc_datetime_requested][lt],
@@ -52,47 +56,64 @@ class FilterActivationSettingsFocDatetimeRequested(TypedDict, total=False):
     """Filter results by foc date earlier than this value"""
 
 
-class FilterPhoneNumbersPhoneNumber(TypedDict, total=False):
-    contains: str
-    """Filter results by full or partial phone_number"""
-
-
-class Filter(TypedDict, total=False):
-    activation_settings_fast_port_eligible: Annotated[
-        bool, PropertyInfo(alias="activation_settings.fast_port_eligible")
-    ]
+class FilterActivationSettings(TypedDict, total=False):
+    fast_port_eligible: bool
     """Filter results by fast port eligible"""
 
-    activation_settings_foc_datetime_requested: Annotated[
-        FilterActivationSettingsFocDatetimeRequested, PropertyInfo(alias="activation_settings.foc_datetime_requested")
-    ]
+    foc_datetime_requested: FilterActivationSettingsFocDatetimeRequested
     """FOC datetime range filtering operations"""
 
-    customer_reference: str
-    """Filter results by customer_reference"""
 
-    end_user_admin_auth_person_name: Annotated[str, PropertyInfo(alias="end_user.admin.auth_person_name")]
+class FilterEndUserAdmin(TypedDict, total=False):
+    auth_person_name: str
     """Filter results by authorized person"""
 
-    end_user_admin_entity_name: Annotated[str, PropertyInfo(alias="end_user.admin.entity_name")]
+    entity_name: str
     """Filter results by person or company name"""
 
-    misc_type: Annotated[PortingOrderType, PropertyInfo(alias="misc.type")]
+
+class FilterEndUser(TypedDict, total=False):
+    admin: FilterEndUserAdmin
+
+
+class FilterMisc(TypedDict, total=False):
+    type: PortingOrderType
     """Filter results by porting order type"""
 
-    parent_support_key: str
-    """Filter results by parent_support_key"""
 
-    phone_numbers_carrier_name: Annotated[str, PropertyInfo(alias="phone_numbers.carrier_name")]
+class FilterPhoneNumbersPhoneNumber(TypedDict, total=False):
+    contains: str
+    """Filter results by full or partial phone_number"""
+
+
+class FilterPhoneNumbers(TypedDict, total=False):
+    carrier_name: str
     """Filter results by old service provider"""
 
-    phone_numbers_country_code: Annotated[str, PropertyInfo(alias="phone_numbers.country_code")]
+    country_code: str
     """Filter results by country ISO 3166-1 alpha-2 code"""
 
-    phone_numbers_phone_number: Annotated[
-        FilterPhoneNumbersPhoneNumber, PropertyInfo(alias="phone_numbers.phone_number")
-    ]
-    """Phone number filtering operations"""
+    phone_number: FilterPhoneNumbersPhoneNumber
+    """Phone number pattern filtering operations"""
+
+
+class Filter(TypedDict, total=False):
+    activation_settings: FilterActivationSettings
+
+    customer_group_reference: str
+    """Filter results by customer_group_reference"""
+
+    customer_reference: str
+    """Filter results by customer_reference"""
+
+    end_user: FilterEndUser
+
+    misc: FilterMisc
+
+    parent_support_key: str
+    """Filter results by parent_support_key"""
+
+    phone_numbers: FilterPhoneNumbers
 
 
 class Page(TypedDict, total=False):

telnyx/types/porting_order_phone_number_configuration_param.py

@@ -2,9 +2,10 @@
 
 from __future__ import annotations
 
-from typing import List
 from typing_extensions import TypedDict
 
+from .._types import SequenceNotStr
+
 __all__ = ["PortingOrderPhoneNumberConfigurationParam"]
 
 
@@ -21,4 +22,4 @@ class PortingOrderPhoneNumberConfigurationParam(TypedDict, total=False):
     messaging_profile_id: str
     """identifies the messaging profile to set on the numbers when ported"""
 
-    tags: List[str]
+    tags: SequenceNotStr[str]

telnyx/types/porting_order_update_params.py

@@ -19,6 +19,8 @@ __all__ = ["PortingOrderUpdateParams", "ActivationSettings", "Messaging", "Requi
 class PortingOrderUpdateParams(TypedDict, total=False):
     activation_settings: ActivationSettings
 
+    customer_group_reference: str
+
     customer_reference: str
 
     documents: PortingOrderDocumentsParam

telnyx/types/porting_orders/action_requirement_list_params.py

@@ -2,9 +2,10 @@
 
 from __future__ import annotations
 
-from typing import List
 from typing_extensions import Literal, TypedDict
 
+from ..._types import SequenceNotStr
+
 __all__ = ["ActionRequirementListParams", "Filter", "Page", "Sort"]
 
 
@@ -27,7 +28,7 @@ class ActionRequirementListParams(TypedDict, total=False):
 
 
 class Filter(TypedDict, total=False):
-    id: List[str]
+    id: SequenceNotStr[str]
     """Filter action requirements by a list of IDs"""
 
     action_type: Literal["au_id_verification"]

telnyx/types/porting_orders/phone_number_block_list_params.py

@@ -5,6 +5,8 @@ from __future__ import annotations
 from typing import List, Union
 from typing_extensions import Literal, TypedDict
 
+from ..._types import SequenceNotStr
+
 __all__ = ["PhoneNumberBlockListParams", "Filter", "Page", "Sort"]
 
 
@@ -44,13 +46,13 @@ class Filter(TypedDict, total=False):
     ]
     """Filter results by activation status"""
 
-    phone_number: List[str]
+    phone_number: SequenceNotStr[str]
     """Filter results by a list of phone numbers"""
 
     portability_status: Literal["pending", "confirmed", "provisional"]
     """Filter results by portability status"""
 
-    porting_order_id: List[str]
+    porting_order_id: SequenceNotStr[str]
     """Filter results by a list of porting order ids"""
 
     status: Union[
@@ -82,7 +84,7 @@ class Filter(TypedDict, total=False):
     Originally: filter[status], filter[status][in][]
     """
 
-    support_key: Union[str, List[str]]
+    support_key: Union[str, SequenceNotStr[str]]
     """Filter results by support key(s).
 
     Originally: filter[support_key][eq], filter[support_key][in][]

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/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