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

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/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/types/verification_trigger_call_params.py

@@ -18,5 +18,12 @@ class VerificationTriggerCallParams(TypedDict, total=False):
     custom_code: Optional[str]
     """Send a self-generated numeric code to the end-user"""
 
+    extension: Optional[str]
+    """Optional extension to dial after call is answered using DTMF digits.
+
+    Valid digits are 0-9, A-D, \\**, and #. Pauses can be added using w (0.5s) and W
+    (1s).
+    """
+
     timeout_secs: int
     """The number of seconds the verification code is valid for."""

telnyx/types/verified_number_create_params.py

@@ -2,6 +2,7 @@
 
 from __future__ import annotations
 
+from typing import Optional
 from typing_extensions import Literal, Required, TypedDict
 
 __all__ = ["VerifiedNumberCreateParams"]
@@ -12,3 +13,12 @@ class VerifiedNumberCreateParams(TypedDict, total=False):
 
     verification_method: Required[Literal["sms", "call"]]
     """Verification method."""
+
+    extension: Optional[str]
+    """Optional DTMF extension sequence to dial after the call is answered.
+
+    This parameter enables verification of phone numbers behind IVR systems that
+    require extension dialing. Valid characters: digits 0-9, letters A-D, symbols \\**
+    and #. Pauses: w = 0.5 second pause, W = 1 second pause. Maximum length: 50
+    characters. Only works with 'call' verification method.
+    """

telnyx/types/verify_profile.py

@@ -38,12 +38,17 @@ class Call(BaseModel):
     to `["*"]`, all destinations will be allowed.
     """
 
-    __pydantic_extra__: Dict[str, object] = FieldInfo(init=False)  # pyright: ignore[reportIncompatibleVariableOverride]
     if TYPE_CHECKING:
+        # Some versions of Pydantic <2.8.0 have a bug and don’t allow assigning a
+        # value to this field, so for compatibility we avoid doing it at runtime.
+        __pydantic_extra__: Dict[str, object] = FieldInfo(init=False)  # pyright: ignore[reportIncompatibleVariableOverride]
+
         # Stub to indicate that arbitrary properties are accepted.
         # To access properties that are not valid identifiers you can use `getattr`, e.g.
         # `getattr(obj, '$type')`
         def __getattr__(self, attr: str) -> object: ...
+    else:
+        __pydantic_extra__: Dict[str, object]
 
 
 class Flashcall(BaseModel):
@@ -55,12 +60,17 @@ class Flashcall(BaseModel):
     identity.
     """
 
-    __pydantic_extra__: Dict[str, object] = FieldInfo(init=False)  # pyright: ignore[reportIncompatibleVariableOverride]
     if TYPE_CHECKING:
+        # Some versions of Pydantic <2.8.0 have a bug and don’t allow assigning a
+        # value to this field, so for compatibility we avoid doing it at runtime.
+        __pydantic_extra__: Dict[str, object] = FieldInfo(init=False)  # pyright: ignore[reportIncompatibleVariableOverride]
+
         # Stub to indicate that arbitrary properties are accepted.
         # To access properties that are not valid identifiers you can use `getattr`, e.g.
         # `getattr(obj, '$type')`
         def __getattr__(self, attr: str) -> object: ...
+    else:
+        __pydantic_extra__: Dict[str, object]
 
 
 class SMS(BaseModel):
@@ -97,12 +107,17 @@ class SMS(BaseModel):
     to `["*"]`, all destinations will be allowed.
     """
 
-    __pydantic_extra__: Dict[str, object] = FieldInfo(init=False)  # pyright: ignore[reportIncompatibleVariableOverride]
     if TYPE_CHECKING:
+        # Some versions of Pydantic <2.8.0 have a bug and don’t allow assigning a
+        # value to this field, so for compatibility we avoid doing it at runtime.
+        __pydantic_extra__: Dict[str, object] = FieldInfo(init=False)  # pyright: ignore[reportIncompatibleVariableOverride]
+
         # Stub to indicate that arbitrary properties are accepted.
         # To access properties that are not valid identifiers you can use `getattr`, e.g.
         # `getattr(obj, '$type')`
         def __getattr__(self, attr: str) -> object: ...
+    else:
+        __pydantic_extra__: Dict[str, object]
 
 
 class VerifyProfile(BaseModel):

telnyx/types/verify_profile_create_template_params.py

@@ -0,0 +1,12 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Required, TypedDict
+
+__all__ = ["VerifyProfileCreateTemplateParams"]
+
+
+class VerifyProfileCreateTemplateParams(TypedDict, total=False):
+    text: Required[str]
+    """The text content of the message template."""

telnyx/types/verify_profile_create_template_response.py

@@ -0,0 +1,12 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+
+from .._models import BaseModel
+from .verify_profile_message_template_response import VerifyProfileMessageTemplateResponse
+
+__all__ = ["VerifyProfileCreateTemplateResponse"]
+
+
+class VerifyProfileCreateTemplateResponse(BaseModel):
+    data: Optional[VerifyProfileMessageTemplateResponse] = None

telnyx/types/verify_profile_message_template_response.py

@@ -0,0 +1,13 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+
+from .._models import BaseModel
+
+__all__ = ["VerifyProfileMessageTemplateResponse"]
+
+
+class VerifyProfileMessageTemplateResponse(BaseModel):
+    id: Optional[str] = None
+
+    text: Optional[str] = None

telnyx/types/verify_profile_retrieve_templates_response.py

@@ -1,17 +1,12 @@
 # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-from typing import List, Optional
+from typing import List
 
 from .._models import BaseModel
+from .verify_profile_message_template_response import VerifyProfileMessageTemplateResponse
 
-__all__ = ["VerifyProfileRetrieveTemplatesResponse", "Data"]
-
-
-class Data(BaseModel):
-    id: Optional[str] = None
-
-    text: Optional[str] = None
+__all__ = ["VerifyProfileRetrieveTemplatesResponse"]
 
 
 class VerifyProfileRetrieveTemplatesResponse(BaseModel):
-    data: List[Data]
+    data: List[VerifyProfileMessageTemplateResponse]

telnyx/types/verify_profile_update_template_params.py

@@ -0,0 +1,12 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Required, TypedDict
+
+__all__ = ["VerifyProfileUpdateTemplateParams"]
+
+
+class VerifyProfileUpdateTemplateParams(TypedDict, total=False):
+    text: Required[str]
+    """The text content of the message template."""

telnyx/types/verify_profile_update_template_response.py

@@ -0,0 +1,12 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+
+from .._models import BaseModel
+from .verify_profile_message_template_response import VerifyProfileMessageTemplateResponse
+
+__all__ = ["VerifyProfileUpdateTemplateResponse"]
+
+
+class VerifyProfileUpdateTemplateResponse(BaseModel):
+    data: Optional[VerifyProfileMessageTemplateResponse] = None

telnyx/types/well_known_retrieve_authorization_server_metadata_response.py

@@ -0,0 +1,42 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Optional
+
+from .._models import BaseModel
+
+__all__ = ["WellKnownRetrieveAuthorizationServerMetadataResponse"]
+
+
+class WellKnownRetrieveAuthorizationServerMetadataResponse(BaseModel):
+    authorization_endpoint: Optional[str] = None
+    """Authorization endpoint URL"""
+
+    code_challenge_methods_supported: Optional[List[str]] = None
+    """Supported PKCE code challenge methods"""
+
+    grant_types_supported: Optional[List[str]] = None
+    """Supported grant types"""
+
+    introspection_endpoint: Optional[str] = None
+    """Token introspection endpoint URL"""
+
+    issuer: Optional[str] = None
+    """Authorization server issuer URL"""
+
+    jwks_uri: Optional[str] = None
+    """JWK Set endpoint URL"""
+
+    registration_endpoint: Optional[str] = None
+    """Dynamic client registration endpoint URL"""
+
+    response_types_supported: Optional[List[str]] = None
+    """Supported response types"""
+
+    scopes_supported: Optional[List[str]] = None
+    """Supported OAuth scopes"""
+
+    token_endpoint: Optional[str] = None
+    """Token endpoint URL"""
+
+    token_endpoint_auth_methods_supported: Optional[List[str]] = None
+    """Supported token endpoint authentication methods"""

telnyx/types/well_known_retrieve_protected_resource_metadata_response.py

@@ -0,0 +1,15 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Optional
+
+from .._models import BaseModel
+
+__all__ = ["WellKnownRetrieveProtectedResourceMetadataResponse"]
+
+
+class WellKnownRetrieveProtectedResourceMetadataResponse(BaseModel):
+    authorization_servers: Optional[List[str]] = None
+    """List of authorization server URLs"""
+
+    resource: Optional[str] = None
+    """Protected resource URL"""

{telnyx-3.4.0a0.dist-info → telnyx-3.5.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: telnyx
-Version: 3.4.0a0
+Version: 3.5.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
@@ -52,7 +52,7 @@ The full API of this library can be found in [api.md](https://github.com/team-te
 
 ```sh
 # install from PyPI
-pip install --pre telnyx
+pip install telnyx
 ```
 
 ## Usage
@@ -67,8 +67,13 @@ client = Telnyx(
     api_key=os.environ.get("TELNYX_API_KEY"),  # This is the default and can be omitted
 )
 
-response = client.list_buckets()
-print(response.buckets)
+response = client.calls.dial(
+    connection_id="conn12345",
+    from_="+15557654321",
+    to="+15551234567",
+    webhook_url="https://your-webhook.url/events",
+)
+print(response.data)
 ```
 
 While you can provide an `api_key` keyword argument,
@@ -91,8 +96,13 @@ client = AsyncTelnyx(
 
 
 async def main() -> None:
-    response = await client.list_buckets()
-    print(response.buckets)
+    response = await client.calls.dial(
+        connection_id="conn12345",
+        from_="+15557654321",
+        to="+15551234567",
+        webhook_url="https://your-webhook.url/events",
+    )
+    print(response.data)
 
 
 asyncio.run(main())
@@ -108,7 +118,7 @@ You can enable this by installing `aiohttp`:
 
 ```sh
 # install from PyPI
-pip install --pre telnyx[aiohttp]
+pip install telnyx[aiohttp]
 ```
 
 Then you can enable it by instantiating the client with `http_client=DefaultAioHttpClient()`:
@@ -124,8 +134,13 @@ async def main() -> None:
         api_key="My API Key",
         http_client=DefaultAioHttpClient(),
     ) as client:
-        response = await client.list_buckets()
-        print(response.buckets)
+        response = await client.calls.dial(
+            connection_id="conn12345",
+            from_="+15557654321",
+            to="+15551234567",
+            webhook_url="https://your-webhook.url/events",
+        )
+        print(response.data)
 
 
 asyncio.run(main())
@@ -149,10 +164,24 @@ from telnyx import Telnyx
 
 client = Telnyx()
 
-access_ip_addresses = client.access_ip_address.list(
-    filter={},
+response = client.calls.dial(
+    connection_id="7267xxxxxxxxxxxxxx",
+    from_="+18005550101",
+    to="+18005550100 or sip:username@sip.telnyx.com",
+    answering_machine_detection_config={
+        "after_greeting_silence_millis": 1000,
+        "between_words_silence_millis": 1000,
+        "greeting_duration_millis": 1000,
+        "greeting_silence_duration_millis": 2000,
+        "greeting_total_analysis_time_millis": 50000,
+        "initial_silence_millis": 1000,
+        "maximum_number_of_words": 1000,
+        "maximum_word_length_millis": 2000,
+        "silence_threshold": 512,
+        "total_analysis_time_millis": 5000,
+    },
 )
-print(access_ip_addresses.filter)
+print(response.answering_machine_detection_config)
 ```
 
 ## File uploads
@@ -189,7 +218,9 @@ from telnyx import Telnyx
 client = Telnyx()
 
 try:
-    client.list_buckets()
+    client.number_orders.create(
+        phone_numbers=[{"phone_number": "+15558675309"}],
+    )
 except telnyx.APIConnectionError as e:
     print("The server could not be reached")
     print(e.__cause__)  # an underlying Exception, likely raised within httpx.
@@ -232,7 +263,9 @@ client = Telnyx(
 )
 
 # Or, configure per-request:
-client.with_options(max_retries=5).list_buckets()
+client.with_options(max_retries=5).number_orders.create(
+    phone_numbers=[{"phone_number": "+15558675309"}],
+)
 ```
 
 ### Timeouts
@@ -255,7 +288,9 @@ client = Telnyx(
 )
 
 # Override per-request:
-client.with_options(timeout=5.0).list_buckets()
+client.with_options(timeout=5.0).number_orders.create(
+    phone_numbers=[{"phone_number": "+15558675309"}],
+)
 ```
 
 On timeout, an `APITimeoutError` is thrown.
@@ -296,11 +331,15 @@ The "raw" Response object can be accessed by prefixing `.with_raw_response.` to
 from telnyx import Telnyx
 
 client = Telnyx()
-response = client.with_raw_response.list_buckets()
+response = client.number_orders.with_raw_response.create(
+    phone_numbers=[{
+        "phone_number": "+15558675309"
+    }],
+)
 print(response.headers.get('X-My-Header'))
 
-client = response.parse()  # get the object that `list_buckets()` would have returned
-print(client.buckets)
+number_order = response.parse()  # get the object that `number_orders.create()` would have returned
+print(number_order.data)
 ```
 
 These methods return an [`APIResponse`](https://github.com/team-telnyx/telnyx-python/tree/master/src/telnyx/_response.py) object.
@@ -314,7 +353,9 @@ The above interface eagerly reads the full response body when you make the reque
 To stream the response body, use `.with_streaming_response` instead, which requires a context manager and only reads the response body once you call `.read()`, `.text()`, `.json()`, `.iter_bytes()`, `.iter_text()`, `.iter_lines()` or `.parse()`. In the async client, these are async methods.
 
 ```python
-with client.with_streaming_response.list_buckets() as response:
+with client.number_orders.with_streaming_response.create(
+    phone_numbers=[{"phone_number": "+15558675309"}],
+) as response:
     print(response.headers.get("X-My-Header"))
 
     for line in response.iter_lines():