telnyx 3.3.0__tar.gz → 3.4.0__tar.gz

telnyx-3.4.0/.release-please-manifest.json

@@ -0,0 +1,3 @@
+{
+  ".": "3.4.0"
+}

{telnyx-3.3.0 → telnyx-3.4.0}/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Changelog
 
+## 3.4.0 (2025-10-06)
+
+Full Changelog: [v3.3.0...v3.4.0](https://github.com/team-telnyx/telnyx-python/compare/v3.3.0...v3.4.0)
+
+### Features
+
+* ENGDESK-45343: Add CustomHeaders documentation to TeXML Dial endpoints ([ee94cac](https://github.com/team-telnyx/telnyx-python/commit/ee94cacc2228a6b2c02d207e53bef535474fb196))
+* MSG-5944: added mobile_only field to messaging profiles ([d34e586](https://github.com/team-telnyx/telnyx-python/commit/d34e586ab25edc4e346abf49837dfe23f5620593))
+
 ## 3.3.0 (2025-10-06)
 
 Full Changelog: [v3.2.0...v3.3.0](https://github.com/team-telnyx/telnyx-python/compare/v3.2.0...v3.3.0)

{telnyx-3.3.0 → telnyx-3.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: telnyx
-Version: 3.3.0
+Version: 3.4.0
 Summary: The official Python library for the telnyx API
 Project-URL: Homepage, https://github.com/team-telnyx/telnyx-python
 Project-URL: Repository, https://github.com/team-telnyx/telnyx-python

{telnyx-3.3.0 → telnyx-3.4.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "telnyx"
-version = "3.3.0"
+version = "3.4.0"
 description = "The official Python library for the telnyx API"
 dynamic = ["readme"]
 license = "MIT"

{telnyx-3.3.0 → telnyx-3.4.0}/src/telnyx/_version.py

@@ -1,4 +1,4 @@
 # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 __title__ = "telnyx"
-__version__ = "3.3.0"  # x-release-please-version
+__version__ = "3.4.0"  # x-release-please-version

{telnyx-3.3.0 → telnyx-3.4.0}/src/telnyx/resources/messaging_profiles/messaging_profiles.py

@@ -81,6 +81,7 @@ class MessagingProfilesResource(SyncAPIResource):
         enabled: bool | Omit = omit,
         mms_fall_back_to_sms: bool | Omit = omit,
         mms_transcoding: bool | Omit = omit,
+        mobile_only: bool | Omit = omit,
         number_pool_settings: Optional[NumberPoolSettingsParam] | Omit = omit,
         url_shortener_settings: Optional[URLShortenerSettingsParam] | Omit = omit,
         webhook_api_version: Literal["1", "2", "2010-04-01"] | Omit = omit,
@@ -117,6 +118,8 @@ class MessagingProfilesResource(SyncAPIResource):
 
           mms_transcoding: enables automated resizing of MMS media.
 
+          mobile_only: Send messages only to mobile phone numbers.
+
           number_pool_settings: Number Pool allows you to send messages from a pool of numbers of different
               types, assigning weights to each type. The pool consists of all the long code
               and toll free numbers assigned to the messaging profile.
@@ -159,6 +162,7 @@ class MessagingProfilesResource(SyncAPIResource):
                     "enabled": enabled,
                     "mms_fall_back_to_sms": mms_fall_back_to_sms,
                     "mms_transcoding": mms_transcoding,
+                    "mobile_only": mobile_only,
                     "number_pool_settings": number_pool_settings,
                     "url_shortener_settings": url_shortener_settings,
                     "webhook_api_version": webhook_api_version,
@@ -216,6 +220,7 @@ class MessagingProfilesResource(SyncAPIResource):
         enabled: bool | Omit = omit,
         mms_fall_back_to_sms: bool | Omit = omit,
         mms_transcoding: bool | Omit = omit,
+        mobile_only: bool | Omit = omit,
         name: str | Omit = omit,
         number_pool_settings: Optional[NumberPoolSettingsParam] | Omit = omit,
         url_shortener_settings: Optional[URLShortenerSettingsParam] | Omit = omit,
@@ -249,6 +254,8 @@ class MessagingProfilesResource(SyncAPIResource):
 
           mms_transcoding: enables automated resizing of MMS media.
 
+          mobile_only: Send messages only to mobile phone numbers.
+
           name: A user friendly name for the messaging profile.
 
           number_pool_settings: Number Pool allows you to send messages from a pool of numbers of different
@@ -301,6 +308,7 @@ class MessagingProfilesResource(SyncAPIResource):
                     "enabled": enabled,
                     "mms_fall_back_to_sms": mms_fall_back_to_sms,
                     "mms_transcoding": mms_transcoding,
+                    "mobile_only": mobile_only,
                     "name": name,
                     "number_pool_settings": number_pool_settings,
                     "url_shortener_settings": url_shortener_settings,
@@ -520,6 +528,7 @@ class AsyncMessagingProfilesResource(AsyncAPIResource):
         enabled: bool | Omit = omit,
         mms_fall_back_to_sms: bool | Omit = omit,
         mms_transcoding: bool | Omit = omit,
+        mobile_only: bool | Omit = omit,
         number_pool_settings: Optional[NumberPoolSettingsParam] | Omit = omit,
         url_shortener_settings: Optional[URLShortenerSettingsParam] | Omit = omit,
         webhook_api_version: Literal["1", "2", "2010-04-01"] | Omit = omit,
@@ -556,6 +565,8 @@ class AsyncMessagingProfilesResource(AsyncAPIResource):
 
           mms_transcoding: enables automated resizing of MMS media.
 
+          mobile_only: Send messages only to mobile phone numbers.
+
           number_pool_settings: Number Pool allows you to send messages from a pool of numbers of different
               types, assigning weights to each type. The pool consists of all the long code
               and toll free numbers assigned to the messaging profile.
@@ -598,6 +609,7 @@ class AsyncMessagingProfilesResource(AsyncAPIResource):
                     "enabled": enabled,
                     "mms_fall_back_to_sms": mms_fall_back_to_sms,
                     "mms_transcoding": mms_transcoding,
+                    "mobile_only": mobile_only,
                     "number_pool_settings": number_pool_settings,
                     "url_shortener_settings": url_shortener_settings,
                     "webhook_api_version": webhook_api_version,
@@ -655,6 +667,7 @@ class AsyncMessagingProfilesResource(AsyncAPIResource):
         enabled: bool | Omit = omit,
         mms_fall_back_to_sms: bool | Omit = omit,
         mms_transcoding: bool | Omit = omit,
+        mobile_only: bool | Omit = omit,
         name: str | Omit = omit,
         number_pool_settings: Optional[NumberPoolSettingsParam] | Omit = omit,
         url_shortener_settings: Optional[URLShortenerSettingsParam] | Omit = omit,
@@ -688,6 +701,8 @@ class AsyncMessagingProfilesResource(AsyncAPIResource):
 
           mms_transcoding: enables automated resizing of MMS media.
 
+          mobile_only: Send messages only to mobile phone numbers.
+
           name: A user friendly name for the messaging profile.
 
           number_pool_settings: Number Pool allows you to send messages from a pool of numbers of different
@@ -740,6 +755,7 @@ class AsyncMessagingProfilesResource(AsyncAPIResource):
                     "enabled": enabled,
                     "mms_fall_back_to_sms": mms_fall_back_to_sms,
                     "mms_transcoding": mms_transcoding,
+                    "mobile_only": mobile_only,
                     "name": name,
                     "number_pool_settings": number_pool_settings,
                     "url_shortener_settings": url_shortener_settings,

{telnyx-3.3.0 → telnyx-3.4.0}/src/telnyx/resources/texml/accounts/calls/calls.py

@@ -2,6 +2,7 @@
 
 from __future__ import annotations
 
+from typing import Iterable
 from typing_extensions import Literal
 
 import httpx
@@ -231,6 +232,7 @@ class CallsResource(SyncAPIResource):
         caller_id: str | Omit = omit,
         cancel_playback_on_detect_message_end: bool | Omit = omit,
         cancel_playback_on_machine_detection: bool | Omit = omit,
+        custom_headers: Iterable[call_calls_params.CustomHeader] | Omit = omit,
         detection_mode: Literal["Premium", "Regular"] | Omit = omit,
         fallback_url: str | Omit = omit,
         machine_detection: Literal["Enable", "Disable", "DetectMessageEnd"] | Omit = omit,
@@ -294,6 +296,9 @@ class CallsResource(SyncAPIResource):
 
           cancel_playback_on_machine_detection: Whether to cancel ongoing playback on `machine` detection. Defaults to `true`.
 
+          custom_headers: Custom HTTP headers to be sent with the call. Each header should be an object
+              with 'name' and 'value' properties.
+
           detection_mode: Allows you to chose between Premium and Standard detections.
 
           fallback_url: A failover URL for which Telnyx will retrieve the TeXML call instructions if the
@@ -377,6 +382,7 @@ class CallsResource(SyncAPIResource):
                     "caller_id": caller_id,
                     "cancel_playback_on_detect_message_end": cancel_playback_on_detect_message_end,
                     "cancel_playback_on_machine_detection": cancel_playback_on_machine_detection,
+                    "custom_headers": custom_headers,
                     "detection_mode": detection_mode,
                     "fallback_url": fallback_url,
                     "machine_detection": machine_detection,
@@ -824,6 +830,7 @@ class AsyncCallsResource(AsyncAPIResource):
         caller_id: str | Omit = omit,
         cancel_playback_on_detect_message_end: bool | Omit = omit,
         cancel_playback_on_machine_detection: bool | Omit = omit,
+        custom_headers: Iterable[call_calls_params.CustomHeader] | Omit = omit,
         detection_mode: Literal["Premium", "Regular"] | Omit = omit,
         fallback_url: str | Omit = omit,
         machine_detection: Literal["Enable", "Disable", "DetectMessageEnd"] | Omit = omit,
@@ -887,6 +894,9 @@ class AsyncCallsResource(AsyncAPIResource):
 
           cancel_playback_on_machine_detection: Whether to cancel ongoing playback on `machine` detection. Defaults to `true`.
 
+          custom_headers: Custom HTTP headers to be sent with the call. Each header should be an object
+              with 'name' and 'value' properties.
+
           detection_mode: Allows you to chose between Premium and Standard detections.
 
           fallback_url: A failover URL for which Telnyx will retrieve the TeXML call instructions if the
@@ -970,6 +980,7 @@ class AsyncCallsResource(AsyncAPIResource):
                     "caller_id": caller_id,
                     "cancel_playback_on_detect_message_end": cancel_playback_on_detect_message_end,
                     "cancel_playback_on_machine_detection": cancel_playback_on_machine_detection,
+                    "custom_headers": custom_headers,
                     "detection_mode": detection_mode,
                     "fallback_url": fallback_url,
                     "machine_detection": machine_detection,

{telnyx-3.3.0 → telnyx-3.4.0}/src/telnyx/resources/texml/accounts/conferences/participants.py

@@ -2,6 +2,7 @@
 
 from __future__ import annotations
 
+from typing import Iterable
 from typing_extensions import Literal
 
 import httpx
@@ -251,6 +252,7 @@ class ParticipantsResource(SyncAPIResource):
         conference_status_callback_event: str | Omit = omit,
         conference_status_callback_method: Literal["GET", "POST"] | Omit = omit,
         conference_trim: Literal["trim-silence", "do-not-trim"] | Omit = omit,
+        custom_headers: Iterable[participant_participants_params.CustomHeader] | Omit = omit,
         early_media: bool | Omit = omit,
         end_conference_on_exit: bool | Omit = omit,
         from_: str | Omit = omit,
@@ -343,6 +345,9 @@ class ParticipantsResource(SyncAPIResource):
           conference_trim: Whether to trim any leading and trailing silence from the conference recording.
               Defaults to `trim-silence`.
 
+          custom_headers: Custom HTTP headers to be sent with the call. Each header should be an object
+              with 'name' and 'value' properties.
+
           early_media: Whether participant shall be bridged to conference before the participant
               answers (from early media if available). Defaults to `false`.
 
@@ -451,6 +456,7 @@ class ParticipantsResource(SyncAPIResource):
                     "conference_status_callback_event": conference_status_callback_event,
                     "conference_status_callback_method": conference_status_callback_method,
                     "conference_trim": conference_trim,
+                    "custom_headers": custom_headers,
                     "early_media": early_media,
                     "end_conference_on_exit": end_conference_on_exit,
                     "from_": from_,
@@ -748,6 +754,7 @@ class AsyncParticipantsResource(AsyncAPIResource):
         conference_status_callback_event: str | Omit = omit,
         conference_status_callback_method: Literal["GET", "POST"] | Omit = omit,
         conference_trim: Literal["trim-silence", "do-not-trim"] | Omit = omit,
+        custom_headers: Iterable[participant_participants_params.CustomHeader] | Omit = omit,
         early_media: bool | Omit = omit,
         end_conference_on_exit: bool | Omit = omit,
         from_: str | Omit = omit,
@@ -840,6 +847,9 @@ class AsyncParticipantsResource(AsyncAPIResource):
           conference_trim: Whether to trim any leading and trailing silence from the conference recording.
               Defaults to `trim-silence`.
 
+          custom_headers: Custom HTTP headers to be sent with the call. Each header should be an object
+              with 'name' and 'value' properties.
+
           early_media: Whether participant shall be bridged to conference before the participant
               answers (from early media if available). Defaults to `false`.
 
@@ -948,6 +958,7 @@ class AsyncParticipantsResource(AsyncAPIResource):
                     "conference_status_callback_event": conference_status_callback_event,
                     "conference_status_callback_method": conference_status_callback_method,
                     "conference_trim": conference_trim,
+                    "custom_headers": custom_headers,
                     "early_media": early_media,
                     "end_conference_on_exit": end_conference_on_exit,
                     "from_": from_,

{telnyx-3.3.0 → telnyx-3.4.0}/src/telnyx/types/messaging_profile.py

@@ -42,6 +42,9 @@ class MessagingProfile(BaseModel):
     mms_transcoding: Optional[bool] = None
     """enables automated resizing of MMS media."""
 
+    mobile_only: Optional[bool] = None
+    """Send messages only to mobile phone numbers."""
+
     name: Optional[str] = None
     """A user friendly name for the messaging profile."""
 

{telnyx-3.3.0 → telnyx-3.4.0}/src/telnyx/types/messaging_profile_create_params.py

@@ -47,6 +47,9 @@ class MessagingProfileCreateParams(TypedDict, total=False):
     mms_transcoding: bool
     """enables automated resizing of MMS media."""
 
+    mobile_only: bool
+    """Send messages only to mobile phone numbers."""
+
     number_pool_settings: Optional[NumberPoolSettingsParam]
     """
     Number Pool allows you to send messages from a pool of numbers of different

{telnyx-3.3.0 → telnyx-3.4.0}/src/telnyx/types/messaging_profile_update_params.py

@@ -37,6 +37,9 @@ class MessagingProfileUpdateParams(TypedDict, total=False):
     mms_transcoding: bool
     """enables automated resizing of MMS media."""
 
+    mobile_only: bool
+    """Send messages only to mobile phone numbers."""
+
     name: str
     """A user friendly name for the messaging profile."""
 

{telnyx-3.3.0 → telnyx-3.4.0}/src/telnyx/types/texml/accounts/call_calls_params.py

@@ -2,11 +2,12 @@
 
 from __future__ import annotations
 
+from typing import Iterable
 from typing_extensions import Literal, Required, Annotated, TypedDict
 
 from ...._utils import PropertyInfo
 
-__all__ = ["CallCallsParams"]
+__all__ = ["CallCallsParams", "CustomHeader"]
 
 
 class CallCallsParams(TypedDict, total=False):
@@ -59,6 +60,12 @@ class CallCallsParams(TypedDict, total=False):
     cancel_playback_on_machine_detection: Annotated[bool, PropertyInfo(alias="CancelPlaybackOnMachineDetection")]
     """Whether to cancel ongoing playback on `machine` detection. Defaults to `true`."""
 
+    custom_headers: Annotated[Iterable[CustomHeader], PropertyInfo(alias="CustomHeaders")]
+    """Custom HTTP headers to be sent with the call.
+
+    Each header should be an object with 'name' and 'value' properties.
+    """
+
     detection_mode: Annotated[Literal["Premium", "Regular"], PropertyInfo(alias="DetectionMode")]
     """Allows you to chose between Premium and Standard detections."""
 
@@ -167,3 +174,11 @@ class CallCallsParams(TypedDict, total=False):
 
     The default value is inherited from TeXML Application setting.
     """
+
+
+class CustomHeader(TypedDict, total=False):
+    name: Required[str]
+    """The name of the custom header"""
+
+    value: Required[str]
+    """The value of the custom header"""

{telnyx-3.3.0 → telnyx-3.4.0}/src/telnyx/types/texml/accounts/conferences/participant_participants_params.py

@@ -2,11 +2,12 @@
 
 from __future__ import annotations
 
+from typing import Iterable
 from typing_extensions import Literal, Required, Annotated, TypedDict
 
 from ....._utils import PropertyInfo
 
-__all__ = ["ParticipantParticipantsParams"]
+__all__ = ["ParticipantParticipantsParams", "CustomHeader"]
 
 
 class ParticipantParticipantsParams(TypedDict, total=False):
@@ -113,6 +114,12 @@ class ParticipantParticipantsParams(TypedDict, total=False):
     Defaults to `trim-silence`.
     """
 
+    custom_headers: Annotated[Iterable[CustomHeader], PropertyInfo(alias="CustomHeaders")]
+    """Custom HTTP headers to be sent with the call.
+
+    Each header should be an object with 'name' and 'value' properties.
+    """
+
     early_media: Annotated[bool, PropertyInfo(alias="EarlyMedia")]
     """
     Whether participant shall be bridged to conference before the participant
@@ -249,3 +256,11 @@ class ParticipantParticipantsParams(TypedDict, total=False):
     The URL to call for an audio file to play while the participant is waiting for
     the conference to start.
     """
+
+
+class CustomHeader(TypedDict, total=False):
+    name: Required[str]
+    """The name of the custom header"""
+
+    value: Required[str]
+    """The value of the custom header"""

{telnyx-3.3.0 → telnyx-3.4.0}/tests/api_resources/test_messaging_profiles.py

@@ -46,6 +46,7 @@ class TestMessagingProfiles:
             enabled=True,
             mms_fall_back_to_sms=True,
             mms_transcoding=True,
+            mobile_only=True,
             number_pool_settings={
                 "long_code_weight": 1,
                 "skip_unhealthy": True,
@@ -154,6 +155,7 @@ class TestMessagingProfiles:
             enabled=True,
             mms_fall_back_to_sms=True,
             mms_transcoding=True,
+            mobile_only=True,
             name="Updated Profile for Messages",
             number_pool_settings={
                 "long_code_weight": 2,
@@ -427,6 +429,7 @@ class TestAsyncMessagingProfiles:
             enabled=True,
             mms_fall_back_to_sms=True,
             mms_transcoding=True,
+            mobile_only=True,
             number_pool_settings={
                 "long_code_weight": 1,
                 "skip_unhealthy": True,
@@ -535,6 +538,7 @@ class TestAsyncMessagingProfiles:
             enabled=True,
             mms_fall_back_to_sms=True,
             mms_transcoding=True,
+            mobile_only=True,
             name="Updated Profile for Messages",
             number_pool_settings={
                 "long_code_weight": 2,

{telnyx-3.3.0 → telnyx-3.4.0}/tests/api_resources/texml/accounts/conferences/test_participants.py

@@ -273,6 +273,12 @@ class TestParticipants:
             conference_status_callback_event="start end join leave",
             conference_status_callback_method="GET",
             conference_trim="trim-silence",
+            custom_headers=[
+                {
+                    "name": "X-Custom-Header",
+                    "value": "custom-value",
+                }
+            ],
             early_media=True,
             end_conference_on_exit=True,
             from_="+12065550200",
@@ -656,6 +662,12 @@ class TestAsyncParticipants:
             conference_status_callback_event="start end join leave",
             conference_status_callback_method="GET",
             conference_trim="trim-silence",
+            custom_headers=[
+                {
+                    "name": "X-Custom-Header",
+                    "value": "custom-value",
+                }
+            ],
             early_media=True,
             end_conference_on_exit=True,
             from_="+12065550200",

{telnyx-3.3.0 → telnyx-3.4.0}/tests/api_resources/texml/accounts/test_calls.py

@@ -170,6 +170,12 @@ class TestCalls:
             caller_id="Info",
             cancel_playback_on_detect_message_end=False,
             cancel_playback_on_machine_detection=False,
+            custom_headers=[
+                {
+                    "name": "X-Custom-Header",
+                    "value": "custom-value",
+                }
+            ],
             detection_mode="Premium",
             fallback_url="https://www.example.com/instructions-fallback.xml",
             machine_detection="Enable",
@@ -592,6 +598,12 @@ class TestAsyncCalls:
             caller_id="Info",
             cancel_playback_on_detect_message_end=False,
             cancel_playback_on_machine_detection=False,
+            custom_headers=[
+                {
+                    "name": "X-Custom-Header",
+                    "value": "custom-value",
+                }
+            ],
             detection_mode="Premium",
             fallback_url="https://www.example.com/instructions-fallback.xml",
             machine_detection="Enable",

telnyx-3.3.0/.release-please-manifest.json

@@ -1,3 +0,0 @@
-{
-  ".": "3.3.0"
-}