telnyx 3.0.0a0__py3-none-any.whl → 3.1.0__py3-none-any.whl

telnyx/types/oauth_register_client_params.py

@@ -0,0 +1,39 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import List
+from typing_extensions import Literal, TypedDict
+
+from .._types import SequenceNotStr
+
+__all__ = ["OAuthRegisterClientParams"]
+
+
+class OAuthRegisterClientParams(TypedDict, total=False):
+    client_name: str
+    """Human-readable string name of the client to be presented to the end-user"""
+
+    grant_types: List[Literal["authorization_code", "client_credentials", "refresh_token"]]
+    """Array of OAuth 2.0 grant type strings that the client may use"""
+
+    logo_uri: str
+    """URL of the client logo"""
+
+    policy_uri: str
+    """URL of the client's privacy policy"""
+
+    redirect_uris: SequenceNotStr[str]
+    """Array of redirection URI strings for use in redirect-based flows"""
+
+    response_types: SequenceNotStr[str]
+    """Array of the OAuth 2.0 response type strings that the client may use"""
+
+    scope: str
+    """Space-separated string of scope values that the client may use"""
+
+    token_endpoint_auth_method: Literal["none", "client_secret_basic", "client_secret_post"]
+    """Authentication method for the token endpoint"""
+
+    tos_uri: str
+    """URL of the client's terms of service"""

telnyx/types/oauth_register_client_response.py

@@ -0,0 +1,45 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Optional
+
+from .._models import BaseModel
+
+__all__ = ["OAuthRegisterClientResponse"]
+
+
+class OAuthRegisterClientResponse(BaseModel):
+    client_id: str
+    """Unique client identifier"""
+
+    client_id_issued_at: int
+    """Unix timestamp of when the client ID was issued"""
+
+    client_name: Optional[str] = None
+    """Human-readable client name"""
+
+    client_secret: Optional[str] = None
+    """Client secret (only for confidential clients)"""
+
+    grant_types: Optional[List[str]] = None
+    """Array of allowed grant types"""
+
+    logo_uri: Optional[str] = None
+    """URL of the client logo"""
+
+    policy_uri: Optional[str] = None
+    """URL of the client's privacy policy"""
+
+    redirect_uris: Optional[List[str]] = None
+    """Array of redirection URIs"""
+
+    response_types: Optional[List[str]] = None
+    """Array of allowed response types"""
+
+    scope: Optional[str] = None
+    """Space-separated scope values"""
+
+    token_endpoint_auth_method: Optional[str] = None
+    """Token endpoint authentication method"""
+
+    tos_uri: Optional[str] = None
+    """URL of the client's terms of service"""

telnyx/types/oauth_retrieve_consent_response.py

@@ -0,0 +1,47 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Optional
+
+from .._models import BaseModel
+
+__all__ = ["OAuthRetrieveConsentResponse", "Data", "DataRequestedScope"]
+
+
+class DataRequestedScope(BaseModel):
+    id: Optional[str] = None
+    """Scope ID"""
+
+    description: Optional[str] = None
+    """Scope description"""
+
+    name: Optional[str] = None
+    """Scope name"""
+
+
+class Data(BaseModel):
+    client_id: Optional[str] = None
+    """Client ID"""
+
+    logo_uri: Optional[str] = None
+    """URL of the client logo"""
+
+    name: Optional[str] = None
+    """Client name"""
+
+    policy_uri: Optional[str] = None
+    """URL of the client's privacy policy"""
+
+    redirect_uri: Optional[str] = None
+    """The redirect URI for this authorization"""
+
+    requested_scopes: Optional[List[DataRequestedScope]] = None
+
+    tos_uri: Optional[str] = None
+    """URL of the client's terms of service"""
+
+    verified: Optional[bool] = None
+    """Whether the client is verified"""
+
+
+class OAuthRetrieveConsentResponse(BaseModel):
+    data: Optional[Data] = None

telnyx/types/oauth_retrieve_jwks_response.py

@@ -0,0 +1,25 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Optional
+
+from .._models import BaseModel
+
+__all__ = ["OAuthRetrieveJwksResponse", "Key"]
+
+
+class Key(BaseModel):
+    alg: Optional[str] = None
+    """Algorithm"""
+
+    kid: Optional[str] = None
+    """Key ID"""
+
+    kty: Optional[str] = None
+    """Key type"""
+
+    use: Optional[str] = None
+    """Key use"""
+
+
+class OAuthRetrieveJwksResponse(BaseModel):
+    keys: Optional[List[Key]] = None

telnyx/types/outbound_call_recording_param.py

@@ -2,14 +2,15 @@
 
 from __future__ import annotations
 
-from typing import List
 from typing_extensions import Literal, TypedDict
 
+from .._types import SequenceNotStr
+
 __all__ = ["OutboundCallRecordingParam"]
 
 
 class OutboundCallRecordingParam(TypedDict, total=False):
-    call_recording_caller_phone_numbers: List[str]
+    call_recording_caller_phone_numbers: SequenceNotStr[str]
     """
     When call_recording_type is 'by_caller_phone_number', only outbound calls using
     one of these numbers will be recorded. Numbers must be specified in E164 format.

telnyx/types/outbound_voice_profile_create_params.py

@@ -2,9 +2,10 @@
 
 from __future__ import annotations
 
-from typing import List, Optional
+from typing import Optional
 from typing_extensions import Required, TypedDict
 
+from .._types import SequenceNotStr
 from .service_plan import ServicePlan
 from .traffic_type import TrafficType
 from .usage_payment_method import UsagePaymentMethod
@@ -56,7 +57,7 @@ class OutboundVoiceProfileCreateParams(TypedDict, total=False):
     service_plan: ServicePlan
     """Indicates the coverage of the termination regions."""
 
-    tags: List[str]
+    tags: SequenceNotStr[str]
 
     traffic_type: TrafficType
     """Specifies the type of traffic allowed in this profile."""
@@ -64,7 +65,7 @@ class OutboundVoiceProfileCreateParams(TypedDict, total=False):
     usage_payment_method: UsagePaymentMethod
     """Setting for how costs for outbound profile are calculated."""
 
-    whitelisted_destinations: List[str]
+    whitelisted_destinations: SequenceNotStr[str]
     """
     The list of destinations you want to be able to call using this outbound voice
     profile formatted in alpha2.

telnyx/types/outbound_voice_profile_update_params.py

@@ -2,9 +2,10 @@
 
 from __future__ import annotations
 
-from typing import List, Optional
+from typing import Optional
 from typing_extensions import Required, TypedDict
 
+from .._types import SequenceNotStr
 from .service_plan import ServicePlan
 from .traffic_type import TrafficType
 from .usage_payment_method import UsagePaymentMethod
@@ -56,7 +57,7 @@ class OutboundVoiceProfileUpdateParams(TypedDict, total=False):
     service_plan: ServicePlan
     """Indicates the coverage of the termination regions."""
 
-    tags: List[str]
+    tags: SequenceNotStr[str]
 
     traffic_type: TrafficType
     """Specifies the type of traffic allowed in this profile."""
@@ -64,7 +65,7 @@ class OutboundVoiceProfileUpdateParams(TypedDict, total=False):
     usage_payment_method: UsagePaymentMethod
     """Setting for how costs for outbound profile are calculated."""
 
-    whitelisted_destinations: List[str]
+    whitelisted_destinations: SequenceNotStr[str]
     """
     The list of destinations you want to be able to call using this outbound voice
     profile formatted in alpha2.

telnyx/types/phone_number_delete_response.py

@@ -49,6 +49,13 @@ class Data(BaseModel):
     customer_reference: Optional[str] = None
     """A customer reference string for customer look ups."""
 
+    deletion_lock_enabled: Optional[bool] = None
+    """Indicates whether deletion lock is enabled for this number.
+
+    When enabled, this prevents the phone number from being deleted via the API or
+    Telnyx portal.
+    """
+
     emergency_address_id: Optional[str] = None
     """Identifies the emergency address associated with the phone number."""
 

telnyx/types/phone_number_detailed.py

@@ -49,6 +49,13 @@ class PhoneNumberDetailed(BaseModel):
     customer_reference: Optional[str] = None
     """A customer reference string for customer look ups."""
 
+    deletion_lock_enabled: Optional[bool] = None
+    """Indicates whether deletion lock is enabled for this number.
+
+    When enabled, this prevents the phone number from being deleted via the API or
+    Telnyx portal.
+    """
+
     emergency_address_id: Optional[str] = None
     """Identifies the emergency address associated with the phone number."""
 

telnyx/types/phone_number_list_params.py

@@ -2,9 +2,10 @@
 
 from __future__ import annotations
 
-from typing import List, Union
+from typing import Union
 from typing_extensions import Literal, Annotated, TypedDict
 
+from .._types import SequenceNotStr
 from .._utils import PropertyInfo
 
 __all__ = ["PhoneNumberListParams", "Filter", "FilterNumberType", "FilterVoiceConnectionName", "Page"]
@@ -64,7 +65,7 @@ class Filter(TypedDict, total=False):
     connection_id: str
     """Filter by connection_id."""
 
-    country_iso_alpha2: Union[str, List[str]]
+    country_iso_alpha2: Union[str, SequenceNotStr[str]]
     """Filter by phone number country ISO alpha-2 code.
 
     Can be a single value or an array of values.
@@ -121,6 +122,12 @@ class Filter(TypedDict, total=False):
     ]
     """Filter by usage_payment_method."""
 
+    without_tags: Literal["true", "false"]
+    """When set to 'true', filters for phone numbers that do not have any tags applied.
+
+    All other values are ignored.
+    """
+
 
 class Page(TypedDict, total=False):
     number: int

telnyx/types/phone_number_slim_list_params.py

@@ -2,9 +2,10 @@
 
 from __future__ import annotations
 
-from typing import List, Union
+from typing import Union
 from typing_extensions import Literal, Annotated, TypedDict
 
+from .._types import SequenceNotStr
 from .._utils import PropertyInfo
 
 __all__ = ["PhoneNumberSlimListParams", "Filter", "FilterNumberType", "FilterVoiceConnectionName", "Page"]
@@ -79,7 +80,7 @@ class Filter(TypedDict, total=False):
     connection_id: str
     """Filter by connection_id."""
 
-    country_iso_alpha2: Union[str, List[str]]
+    country_iso_alpha2: Union[str, SequenceNotStr[str]]
     """Filter by phone number country ISO alpha-2 code.
 
     Can be a single value or an array of values.

telnyx/types/phone_number_update_params.py

@@ -2,9 +2,10 @@
 
 from __future__ import annotations
 
-from typing import List
 from typing_extensions import TypedDict
 
+from .._types import SequenceNotStr
+
 __all__ = ["PhoneNumberUpdateParams"]
 
 
@@ -29,5 +30,5 @@ class PhoneNumberUpdateParams(TypedDict, total=False):
     hd_voice_enabled: bool
     """Indicates whether HD voice is enabled for this number."""
 
-    tags: List[str]
+    tags: SequenceNotStr[str]
     """A list of user-assigned tags to help organize phone numbers."""

telnyx/types/phone_numbers/action_verify_ownership_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__ = ["ActionVerifyOwnershipParams"]
 
 
 class ActionVerifyOwnershipParams(TypedDict, total=False):
-    phone_numbers: Required[List[str]]
+    phone_numbers: Required[SequenceNotStr[str]]
     """Array of phone numbers to verify ownership for"""

telnyx/types/phone_numbers/job_delete_batch_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__ = ["JobDeleteBatchParams"]
 
 
 class JobDeleteBatchParams(TypedDict, total=False):
-    phone_numbers: Required[List[str]]
+    phone_numbers: Required[SequenceNotStr[str]]

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