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

telnyx/types/oauth_token_params.py

@@ -0,0 +1,33 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Literal, Required, TypedDict
+
+__all__ = ["OAuthTokenParams"]
+
+
+class OAuthTokenParams(TypedDict, total=False):
+    grant_type: Required[Literal["client_credentials", "authorization_code", "refresh_token"]]
+    """OAuth 2.0 grant type"""
+
+    client_id: str
+    """OAuth client ID (if not using HTTP Basic auth)"""
+
+    client_secret: str
+    """OAuth client secret (if not using HTTP Basic auth)"""
+
+    code: str
+    """Authorization code (for authorization_code flow)"""
+
+    code_verifier: str
+    """PKCE code verifier (for authorization_code flow)"""
+
+    redirect_uri: str
+    """Redirect URI (for authorization_code flow)"""
+
+    refresh_token: str
+    """Refresh token (for refresh_token flow)"""
+
+    scope: str
+    """Space-separated list of requested scopes (for client_credentials)"""

telnyx/types/oauth_token_response.py

@@ -0,0 +1,25 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+from typing_extensions import Literal
+
+from .._models import BaseModel
+
+__all__ = ["OAuthTokenResponse"]
+
+
+class OAuthTokenResponse(BaseModel):
+    access_token: str
+    """The access token"""
+
+    expires_in: int
+    """Token lifetime in seconds"""
+
+    token_type: Literal["Bearer"]
+    """Token type"""
+
+    refresh_token: Optional[str] = None
+    """Refresh token (if applicable)"""
+
+    scope: Optional[str] = None
+    """Space-separated list of granted scopes"""

telnyx/types/outbound_voice_profile.py

@@ -8,7 +8,27 @@ from .traffic_type import TrafficType
 from .usage_payment_method import UsagePaymentMethod
 from .outbound_call_recording import OutboundCallRecording
 
-__all__ = ["OutboundVoiceProfile"]
+__all__ = ["OutboundVoiceProfile", "CallingWindow"]
+
+
+class CallingWindow(BaseModel):
+    calls_per_cld: Optional[int] = None
+    """
+    (BETA) The maximum number of calls that can be initiated to a single called
+    party (CLD) within the calling window. A null value means no limit.
+    """
+
+    end_time: Optional[str] = None
+    """
+    (BETA) The UTC time of day (in HH:MM format, 24-hour clock) when calls are no
+    longer allowed to start.
+    """
+
+    start_time: Optional[str] = None
+    """
+    (BETA) The UTC time of day (in HH:MM format, 24-hour clock) when calls are
+    allowed to start.
+    """
 
 
 class OutboundVoiceProfile(BaseModel):
@@ -26,6 +46,12 @@ class OutboundVoiceProfile(BaseModel):
 
     call_recording: Optional[OutboundCallRecording] = None
 
+    calling_window: Optional[CallingWindow] = None
+    """
+    (BETA) Specifies the time window and call limits for calls made using this
+    outbound voice profile. Note that all times are UTC in 24-hour clock time.
+    """
+
     concurrent_call_limit: Optional[int] = None
     """Must be no more than your global concurrent call limit. Null means no limit."""
 

telnyx/types/outbound_voice_profile_create_params.py

@@ -11,7 +11,7 @@ from .traffic_type import TrafficType
 from .usage_payment_method import UsagePaymentMethod
 from .outbound_call_recording_param import OutboundCallRecordingParam
 
-__all__ = ["OutboundVoiceProfileCreateParams"]
+__all__ = ["OutboundVoiceProfileCreateParams", "CallingWindow"]
 
 
 class OutboundVoiceProfileCreateParams(TypedDict, total=False):
@@ -26,6 +26,12 @@ class OutboundVoiceProfileCreateParams(TypedDict, total=False):
 
     call_recording: OutboundCallRecordingParam
 
+    calling_window: CallingWindow
+    """
+    (BETA) Specifies the time window and call limits for calls made using this
+    outbound voice profile. Note that all times are UTC in 24-hour clock time.
+    """
+
     concurrent_call_limit: Optional[int]
     """Must be no more than your global concurrent call limit. Null means no limit."""
 
@@ -70,3 +76,23 @@ class OutboundVoiceProfileCreateParams(TypedDict, total=False):
     The list of destinations you want to be able to call using this outbound voice
     profile formatted in alpha2.
     """
+
+
+class CallingWindow(TypedDict, total=False):
+    calls_per_cld: int
+    """
+    (BETA) The maximum number of calls that can be initiated to a single called
+    party (CLD) within the calling window. A null value means no limit.
+    """
+
+    end_time: str
+    """
+    (BETA) The UTC time of day (in HH:MM format, 24-hour clock) when calls are no
+    longer allowed to start.
+    """
+
+    start_time: str
+    """
+    (BETA) The UTC time of day (in HH:MM format, 24-hour clock) when calls are
+    allowed to start.
+    """

telnyx/types/outbound_voice_profile_list_params.py

@@ -17,7 +17,7 @@ class OutboundVoiceProfileListParams(TypedDict, total=False):
     page: Page
     """Consolidated page parameter (deepObject style).
 
-    Originally: page[number], page[size]
+    Originally: page[size], page[number]
     """
 
     sort: Literal[

telnyx/types/outbound_voice_profile_update_params.py

@@ -11,7 +11,7 @@ from .traffic_type import TrafficType
 from .usage_payment_method import UsagePaymentMethod
 from .outbound_call_recording_param import OutboundCallRecordingParam
 
-__all__ = ["OutboundVoiceProfileUpdateParams"]
+__all__ = ["OutboundVoiceProfileUpdateParams", "CallingWindow"]
 
 
 class OutboundVoiceProfileUpdateParams(TypedDict, total=False):
@@ -26,6 +26,12 @@ class OutboundVoiceProfileUpdateParams(TypedDict, total=False):
 
     call_recording: OutboundCallRecordingParam
 
+    calling_window: CallingWindow
+    """
+    (BETA) Specifies the time window and call limits for calls made using this
+    outbound voice profile.
+    """
+
     concurrent_call_limit: Optional[int]
     """Must be no more than your global concurrent call limit. Null means no limit."""
 
@@ -70,3 +76,23 @@ class OutboundVoiceProfileUpdateParams(TypedDict, total=False):
     The list of destinations you want to be able to call using this outbound voice
     profile formatted in alpha2.
     """
+
+
+class CallingWindow(TypedDict, total=False):
+    calls_per_cld: int
+    """
+    (BETA) The maximum number of calls that can be initiated to a single called
+    party (CLD) within the calling window. A null value means no limit.
+    """
+
+    end_time: str
+    """
+    (BETA) The UTC time of day (in HH:MM format, 24-hour clock) when calls are no
+    longer allowed to start.
+    """
+
+    start_time: str
+    """
+    (BETA) The UTC time of day (in HH:MM format, 24-hour clock) when calls are
+    allowed to start.
+    """

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

@@ -122,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_numbers/job_update_batch_params.py

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

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

@@ -13,5 +13,8 @@ class PortingOrderCreateParams(TypedDict, total=False):
     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_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/phone_number_configuration_list_params.py

@@ -3,12 +3,11 @@
 from __future__ import annotations
 
 from typing import List
-from typing_extensions import Literal, Annotated, TypedDict
+from typing_extensions import Literal, TypedDict
 
 from ..._types import SequenceNotStr
-from ..._utils import PropertyInfo
 
-__all__ = ["PhoneNumberConfigurationListParams", "Filter", "Page", "Sort"]
+__all__ = ["PhoneNumberConfigurationListParams", "Filter", "FilterPortingOrder", "Page", "Sort"]
 
 
 class PhoneNumberConfigurationListParams(TypedDict, total=False):
@@ -29,25 +28,26 @@ 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"""
 
+
+class Filter(TypedDict, total=False):
+    porting_order: FilterPortingOrder
+
     porting_phone_number: SequenceNotStr[str]
     """Filter results by a list of porting phone number IDs"""
 

telnyx/types/requirement_group.py

@@ -20,7 +20,7 @@ class RegulatoryRequirement(BaseModel):
 
     requirement_id: Optional[str] = None
 
-    status: Optional[Literal["approved", "unapproved", "pending-approval", "declined"]] = None
+    status: Optional[Literal["approved", "unapproved", "pending-approval", "declined", "expired"]] = None
 
     updated_at: Optional[datetime] = None
 
@@ -42,6 +42,6 @@ class RequirementGroup(BaseModel):
 
     regulatory_requirements: Optional[List[RegulatoryRequirement]] = None
 
-    status: Optional[Literal["approved", "unapproved", "pending-approval", "declined"]] = None
+    status: Optional[Literal["approved", "unapproved", "pending-approval", "declined", "expired"]] = None
 
     updated_at: Optional[datetime] = None

telnyx/types/requirement_group_list_params.py

@@ -29,5 +29,5 @@ class Filter(TypedDict, total=False):
     phone_number_type: Literal["local", "toll_free", "mobile", "national", "shared_cost"]
     """Filter requirement groups by phone number type."""
 
-    status: Literal["approved", "unapproved", "pending-approval", "declined"]
+    status: Literal["approved", "unapproved", "pending-approval", "declined", "expired"]
     """Filter requirement groups by status"""

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_update_params.py

@@ -2,6 +2,7 @@
 
 from __future__ import annotations
 
+from typing import Optional
 from typing_extensions import Literal, TypedDict
 
 from .._types import SequenceNotStr
@@ -11,7 +12,7 @@ __all__ = ["SimCardUpdateParams", "DataLimit"]
 
 
 class SimCardUpdateParams(TypedDict, total=False):
-    authorized_imeis: SequenceNotStr[str]
+    authorized_imeis: Optional[SequenceNotStr[str]]
     """List of IMEIs authorized to use a given SIM card."""
 
     data_limit: DataLimit

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"]