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

telnyx/types/reports/pagination_meta_reporting.py

@@ -0,0 +1,17 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+
+from ..._models import BaseModel
+
+__all__ = ["PaginationMetaReporting"]
+
+
+class PaginationMetaReporting(BaseModel):
+    page_number: Optional[int] = None
+
+    page_size: Optional[int] = None
+
+    total_pages: Optional[int] = None
+
+    total_results: Optional[int] = None

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

@@ -0,0 +1,7 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing_extensions import Literal, TypeAlias
+
+__all__ = ["StreamBidirectionalSamplingRate"]
+
+StreamBidirectionalSamplingRate: TypeAlias = Literal[8000, 16000, 22050, 24000, 48000]

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

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/verifications/__init__.py

@@ -2,5 +2,6 @@
 
 from __future__ import annotations
 
+from .verify_meta import VerifyMeta as VerifyMeta
 from .action_verify_params import ActionVerifyParams as ActionVerifyParams
 from .by_phone_number_list_response import ByPhoneNumberListResponse as ByPhoneNumberListResponse

telnyx/types/verifications/by_phone_number_list_response.py

@@ -1,24 +1,15 @@
 # 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_meta import VerifyMeta
 from ..verification import Verification
 
-__all__ = ["ByPhoneNumberListResponse", "Meta"]
-
-
-class Meta(BaseModel):
-    page_number: Optional[int] = None
-
-    page_size: Optional[int] = None
-
-    total_pages: Optional[int] = None
-
-    total_results: Optional[int] = None
+__all__ = ["ByPhoneNumberListResponse"]
 
 
 class ByPhoneNumberListResponse(BaseModel):
     data: List[Verification]
 
-    meta: Meta
+    meta: VerifyMeta

telnyx/types/verifications/verify_meta.py

@@ -0,0 +1,17 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+
+from ..._models import BaseModel
+
+__all__ = ["VerifyMeta"]
+
+
+class VerifyMeta(BaseModel):
+    page_number: Optional[int] = None
+
+    page_size: Optional[int] = None
+
+    total_pages: Optional[int] = None
+
+    total_results: Optional[int] = None

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

@@ -1,24 +1,15 @@
 # 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 import VerifyProfile
+from .verifications.verify_meta import VerifyMeta
 
-__all__ = ["VerifyProfileListResponse", "Meta"]
-
-
-class Meta(BaseModel):
-    page_number: Optional[int] = None
-
-    page_size: Optional[int] = None
-
-    total_pages: Optional[int] = None
-
-    total_results: Optional[int] = None
+__all__ = ["VerifyProfileListResponse"]
 
 
 class VerifyProfileListResponse(BaseModel):
     data: List[VerifyProfile]
 
-    meta: Meta
+    meta: VerifyMeta

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/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.5.0a0.dist-info → telnyx-3.6.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: telnyx
-Version: 3.5.0a0
+Version: 3.6.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
@@ -30,7 +30,7 @@ Requires-Dist: sniffio
 Requires-Dist: typing-extensions<5,>=4.10
 Provides-Extra: aiohttp
 Requires-Dist: aiohttp; extra == 'aiohttp'
-Requires-Dist: httpx-aiohttp>=0.1.8; extra == 'aiohttp'
+Requires-Dist: httpx-aiohttp>=0.1.9; extra == 'aiohttp'
 Description-Content-Type: text/markdown
 
 # Telnyx Python API library
@@ -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
@@ -118,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()`: