telnyx 3.0.0a0__py3-none-any.whl

telnyx/types/phone_number_list_params.py

@@ -0,0 +1,130 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import List, Union
+from typing_extensions import Literal, Annotated, TypedDict
+
+from .._utils import PropertyInfo
+
+__all__ = ["PhoneNumberListParams", "Filter", "FilterNumberType", "FilterVoiceConnectionName", "Page"]
+
+
+class PhoneNumberListParams(TypedDict, total=False):
+    filter: Filter
+    """Consolidated filter parameter (deepObject style).
+
+    Originally: filter[tag], filter[phone_number], filter[status],
+    filter[country_iso_alpha2], filter[connection_id],
+    filter[voice.connection_name], filter[voice.usage_payment_method],
+    filter[billing_group_id], filter[emergency_address_id],
+    filter[customer_reference], filter[number_type], filter[source]
+    """
+
+    page: Page
+    """Consolidated page parameter (deepObject style).
+
+    Originally: page[size], page[number]
+    """
+
+    sort: Literal["purchased_at", "phone_number", "connection_name", "usage_payment_method"]
+    """Specifies the sort order for results.
+
+    If not given, results are sorted by created_at in descending order.
+    """
+
+
+class FilterNumberType(TypedDict, total=False):
+    eq: Literal["local", "national", "toll_free", "mobile", "shared_cost"]
+    """Filter phone numbers by phone number type."""
+
+
+class FilterVoiceConnectionName(TypedDict, total=False):
+    contains: str
+    """Filter contains connection name. Requires at least three characters."""
+
+    ends_with: str
+    """Filter ends with connection name. Requires at least three characters."""
+
+    eq: str
+    """Filter by connection name."""
+
+    starts_with: str
+    """Filter starts with connection name. Requires at least three characters."""
+
+
+class Filter(TypedDict, total=False):
+    billing_group_id: str
+    """Filter by the billing_group_id associated with phone numbers.
+
+    To filter to only phone numbers that have no billing group associated them, set
+    the value of this filter to the string 'null'.
+    """
+
+    connection_id: str
+    """Filter by connection_id."""
+
+    country_iso_alpha2: Union[str, List[str]]
+    """Filter by phone number country ISO alpha-2 code.
+
+    Can be a single value or an array of values.
+    """
+
+    customer_reference: str
+    """Filter numbers via the customer_reference set."""
+
+    emergency_address_id: str
+    """Filter by the emergency_address_id associated with phone numbers.
+
+    To filter only phone numbers that have no emergency address associated with
+    them, set the value of this filter to the string 'null'.
+    """
+
+    number_type: FilterNumberType
+    """Filter phone numbers by phone number type."""
+
+    phone_number: str
+    """Filter by phone number.
+
+    Requires at least three digits. Non-numerical characters will result in no
+    values being returned.
+    """
+
+    source: Literal["ported", "purchased"]
+    """Filter phone numbers by their source.
+
+    Use 'ported' for numbers ported from other carriers, or 'purchased' for numbers
+    bought directly from Telnyx.
+    """
+
+    status: Literal[
+        "purchase-pending",
+        "purchase-failed",
+        "port-pending",
+        "active",
+        "deleted",
+        "port-failed",
+        "emergency-only",
+        "ported-out",
+        "port-out-pending",
+    ]
+    """Filter by phone number status."""
+
+    tag: str
+    """Filter by phone number tags."""
+
+    voice_connection_name: Annotated[FilterVoiceConnectionName, PropertyInfo(alias="voice.connection_name")]
+    """Filter by voice connection name pattern matching."""
+
+    voice_usage_payment_method: Annotated[
+        Literal["pay-per-minute", "channel"], PropertyInfo(alias="voice.usage_payment_method")
+    ]
+    """Filter by usage_payment_method."""
+
+
+class Page(TypedDict, total=False):
+    number: int
+    """The page number to load"""
+
+    size: int
+    """The size of the page"""

telnyx/types/phone_number_list_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
+from .pagination_meta import PaginationMeta
+from .phone_number_detailed import PhoneNumberDetailed
+
+__all__ = ["PhoneNumberListResponse"]
+
+
+class PhoneNumberListResponse(BaseModel):
+    data: Optional[List[PhoneNumberDetailed]] = None
+
+    meta: Optional[PaginationMeta] = None

telnyx/types/phone_number_retrieve_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 .phone_number_detailed import PhoneNumberDetailed
+
+__all__ = ["PhoneNumberRetrieveResponse"]
+
+
+class PhoneNumberRetrieveResponse(BaseModel):
+    data: Optional[PhoneNumberDetailed] = None

telnyx/types/phone_number_slim_list_params.py

@@ -0,0 +1,148 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import List, Union
+from typing_extensions import Literal, Annotated, TypedDict
+
+from .._utils import PropertyInfo
+
+__all__ = ["PhoneNumberSlimListParams", "Filter", "FilterNumberType", "FilterVoiceConnectionName", "Page"]
+
+
+class PhoneNumberSlimListParams(TypedDict, total=False):
+    filter: Filter
+    """Consolidated filter parameter (deepObject style).
+
+    Originally: filter[tag], filter[phone_number], filter[status],
+    filter[country_iso_alpha2], filter[connection_id],
+    filter[voice.connection_name], filter[voice.usage_payment_method],
+    filter[billing_group_id], filter[emergency_address_id],
+    filter[customer_reference], filter[number_type], filter[source]
+    """
+
+    include_connection: bool
+    """Include the connection associated with the phone number."""
+
+    include_tags: bool
+    """Include the tags associated with the phone number."""
+
+    page: Page
+    """Consolidated page parameter (deepObject style).
+
+    Originally: page[size], page[number]
+    """
+
+    sort: Literal["purchased_at", "phone_number", "connection_name", "usage_payment_method"]
+    """Specifies the sort order for results.
+
+    If not given, results are sorted by created_at in descending order.
+    """
+
+
+class FilterNumberType(TypedDict, total=False):
+    eq: Literal["local", "national", "toll_free", "mobile", "shared_cost"]
+    """Filter phone numbers by phone number type."""
+
+
+class FilterVoiceConnectionName(TypedDict, total=False):
+    contains: str
+    """Filter contains connection name.
+
+    Requires at least three characters and the include_connection param.
+    """
+
+    ends_with: str
+    """Filter ends with connection name.
+
+    Requires at least three characters and the include_connection param.
+    """
+
+    eq: str
+    """Filter by connection name."""
+
+    starts_with: str
+    """Filter starts with connection name.
+
+    Requires at least three characters and the include_connection param.
+    """
+
+
+class Filter(TypedDict, total=False):
+    billing_group_id: str
+    """Filter by the billing_group_id associated with phone numbers.
+
+    To filter to only phone numbers that have no billing group associated them, set
+    the value of this filter to the string 'null'.
+    """
+
+    connection_id: str
+    """Filter by connection_id."""
+
+    country_iso_alpha2: Union[str, List[str]]
+    """Filter by phone number country ISO alpha-2 code.
+
+    Can be a single value or an array of values.
+    """
+
+    customer_reference: str
+    """Filter numbers via the customer_reference set."""
+
+    emergency_address_id: str
+    """Filter by the emergency_address_id associated with phone numbers.
+
+    To filter only phone numbers that have no emergency address associated with
+    them, set the value of this filter to the string 'null'.
+    """
+
+    number_type: FilterNumberType
+    """Filter phone numbers by phone number type."""
+
+    phone_number: str
+    """Filter by phone number.
+
+    Requires at least three digits. Non-numerical characters will result in no
+    values being returned.
+    """
+
+    source: Literal["ported", "purchased"]
+    """Filter phone numbers by their source.
+
+    Use 'ported' for numbers ported from other carriers, or 'purchased' for numbers
+    bought directly from Telnyx.
+    """
+
+    status: Literal[
+        "purchase-pending",
+        "purchase-failed",
+        "port_pending",
+        "active",
+        "deleted",
+        "port-failed",
+        "emergency-only",
+        "ported-out",
+        "port-out-pending",
+    ]
+    """Filter by phone number status."""
+
+    tag: str
+    """Filter by phone number tags. (This requires the include_tags param)"""
+
+    voice_connection_name: Annotated[FilterVoiceConnectionName, PropertyInfo(alias="voice.connection_name")]
+    """
+    Filter by voice connection name pattern matching (requires include_connection
+    param).
+    """
+
+    voice_usage_payment_method: Annotated[
+        Literal["pay-per-minute", "channel"], PropertyInfo(alias="voice.usage_payment_method")
+    ]
+    """Filter by usage_payment_method."""
+
+
+class Page(TypedDict, total=False):
+    number: int
+    """The page number to load"""
+
+    size: int
+    """The size of the page"""

telnyx/types/phone_number_slim_list_response.py

@@ -0,0 +1,125 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Optional
+from typing_extensions import Literal
+
+from .._models import BaseModel
+from .pagination_meta import PaginationMeta
+
+__all__ = ["PhoneNumberSlimListResponse", "Data"]
+
+
+class Data(BaseModel):
+    id: Optional[str] = None
+    """Identifies the resource."""
+
+    billing_group_id: Optional[str] = None
+    """Identifies the billing group associated with the phone number."""
+
+    call_forwarding_enabled: Optional[bool] = None
+    """
+    Indicates if call forwarding will be enabled for this number if forwards_to and
+    forwarding_type are filled in. Defaults to true for backwards compatibility with
+    APIV1 use of numbers endpoints.
+    """
+
+    call_recording_enabled: Optional[bool] = None
+    """Indicates whether call recording is enabled for this number."""
+
+    caller_id_name_enabled: Optional[bool] = None
+    """Indicates whether caller ID is enabled for this number."""
+
+    cnam_listing_enabled: Optional[bool] = None
+    """Indicates whether a CNAM listing is enabled for this number."""
+
+    connection_id: Optional[str] = None
+    """Identifies the connection associated with the phone number."""
+
+    country_iso_alpha2: Optional[str] = None
+    """The ISO 3166-1 alpha-2 country code of the phone number."""
+
+    created_at: Optional[str] = None
+    """ISO 8601 formatted date indicating when the resource was created."""
+
+    customer_reference: Optional[str] = None
+    """A customer reference string for customer look ups."""
+
+    emergency_address_id: Optional[str] = None
+    """Identifies the emergency address associated with the phone number."""
+
+    emergency_enabled: Optional[bool] = None
+    """Indicates whether emergency services are enabled for this number."""
+
+    emergency_status: Optional[
+        Literal["active", "deprovisioning", "disabled", "provisioning", "provisioning-failed"]
+    ] = None
+    """
+    Indicates the status of the provisioning of emergency services for the phone
+    number. This field contains information about activity that may be ongoing for a
+    number where it either is being provisioned or deprovisioned but is not yet
+    enabled/disabled.
+    """
+
+    external_pin: Optional[str] = None
+    """
+    If someone attempts to port your phone number away from Telnyx and your phone
+    number has an external PIN set, Telnyx will attempt to verify that you provided
+    the correct external PIN to the winning carrier. Note that not all carriers
+    cooperate with this security mechanism.
+    """
+
+    inbound_call_screening: Optional[Literal["disabled", "reject_calls", "flag_calls"]] = None
+    """
+    The inbound_call_screening setting is a phone number configuration option
+    variable that allows users to configure their settings to block or flag
+    fraudulent calls. It can be set to disabled, reject_calls, or flag_calls. This
+    feature has an additional per-number monthly cost associated with it.
+    """
+
+    phone_number: Optional[str] = None
+    """The +E.164-formatted phone number associated with this record."""
+
+    phone_number_type: Optional[
+        Literal[
+            "local", "toll_free", "mobile", "national", "shared_cost", "landline", "tollfree", "shortcode", "longcode"
+        ]
+    ] = None
+    """
+    The phone number's type. Note: For numbers purchased prior to July 2023 or when
+    fetching a number's details immediately after a purchase completes, the legacy
+    values `tollfree`, `shortcode` or `longcode` may be returned instead.
+    """
+
+    purchased_at: Optional[str] = None
+    """ISO 8601 formatted date indicating when the resource was purchased."""
+
+    record_type: Optional[str] = None
+    """Identifies the type of the resource."""
+
+    status: Optional[
+        Literal[
+            "purchase-pending",
+            "purchase-failed",
+            "port-pending",
+            "port-failed",
+            "active",
+            "deleted",
+            "emergency-only",
+            "ported-out",
+            "port-out-pending",
+            "requirement-info-pending",
+            "requirement-info-under-review",
+            "requirement-info-exception",
+            "provision-pending",
+        ]
+    ] = None
+    """The phone number's current status."""
+
+    t38_fax_gateway_enabled: Optional[bool] = None
+    """Indicates whether T38 Fax Gateway for inbound calls to this number."""
+
+
+class PhoneNumberSlimListResponse(BaseModel):
+    data: Optional[List[Data]] = None
+
+    meta: Optional[PaginationMeta] = None

telnyx/types/phone_number_update_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 import List
+from typing_extensions import TypedDict
+
+__all__ = ["PhoneNumberUpdateParams"]
+
+
+class PhoneNumberUpdateParams(TypedDict, total=False):
+    billing_group_id: str
+    """Identifies the billing group associated with the phone number."""
+
+    connection_id: str
+    """Identifies the connection associated with the phone number."""
+
+    customer_reference: str
+    """A customer reference string for customer look ups."""
+
+    external_pin: str
+    """
+    If someone attempts to port your phone number away from Telnyx and your phone
+    number has an external PIN set, we will attempt to verify that you provided the
+    correct external PIN to the winning carrier. Note that not all carriers
+    cooperate with this security mechanism.
+    """
+
+    hd_voice_enabled: bool
+    """Indicates whether HD voice is enabled for this number."""
+
+    tags: List[str]
+    """A list of user-assigned tags to help organize phone numbers."""

telnyx/types/phone_number_update_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 .phone_number_detailed import PhoneNumberDetailed
+
+__all__ = ["PhoneNumberUpdateResponse"]
+
+
+class PhoneNumberUpdateResponse(BaseModel):
+    data: Optional[PhoneNumberDetailed] = None

telnyx/types/phone_numbers/__init__.py

@@ -0,0 +1,56 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from .cnam_listing import CnamListing as CnamListing
+from .csv_download import CsvDownload as CsvDownload
+from .call_recording import CallRecording as CallRecording
+from .media_features import MediaFeatures as MediaFeatures
+from .call_forwarding import CallForwarding as CallForwarding
+from .job_list_params import JobListParams as JobListParams
+from .job_list_response import JobListResponse as JobListResponse
+from .phone_numbers_job import PhoneNumbersJob as PhoneNumbersJob
+from .voice_list_params import VoiceListParams as VoiceListParams
+from .cnam_listing_param import CnamListingParam as CnamListingParam
+from .voice_list_response import VoiceListResponse as VoiceListResponse
+from .voice_update_params import VoiceUpdateParams as VoiceUpdateParams
+from .call_recording_param import CallRecordingParam as CallRecordingParam
+from .media_features_param import MediaFeaturesParam as MediaFeaturesParam
+from .call_forwarding_param import CallForwardingParam as CallForwardingParam
+from .job_retrieve_response import JobRetrieveResponse as JobRetrieveResponse
+from .messaging_list_params import MessagingListParams as MessagingListParams
+from .voice_update_response import VoiceUpdateResponse as VoiceUpdateResponse
+from .job_delete_batch_params import JobDeleteBatchParams as JobDeleteBatchParams
+from .job_update_batch_params import JobUpdateBatchParams as JobUpdateBatchParams
+from .messaging_list_response import MessagingListResponse as MessagingListResponse
+from .messaging_update_params import MessagingUpdateParams as MessagingUpdateParams
+from .voice_retrieve_response import VoiceRetrieveResponse as VoiceRetrieveResponse
+from .voicemail_create_params import VoicemailCreateParams as VoicemailCreateParams
+from .voicemail_pref_response import VoicemailPrefResponse as VoicemailPrefResponse
+from .voicemail_update_params import VoicemailUpdateParams as VoicemailUpdateParams
+from .csv_download_list_params import CsvDownloadListParams as CsvDownloadListParams
+from .job_delete_batch_response import JobDeleteBatchResponse as JobDeleteBatchResponse
+from .job_update_batch_response import JobUpdateBatchResponse as JobUpdateBatchResponse
+from .messaging_update_response import MessagingUpdateResponse as MessagingUpdateResponse
+from .voicemail_create_response import VoicemailCreateResponse as VoicemailCreateResponse
+from .voicemail_update_response import VoicemailUpdateResponse as VoicemailUpdateResponse
+from .csv_download_create_params import CsvDownloadCreateParams as CsvDownloadCreateParams
+from .csv_download_list_response import CsvDownloadListResponse as CsvDownloadListResponse
+from .messaging_retrieve_response import MessagingRetrieveResponse as MessagingRetrieveResponse
+from .update_voice_settings_param import UpdateVoiceSettingsParam as UpdateVoiceSettingsParam
+from .voicemail_retrieve_response import VoicemailRetrieveResponse as VoicemailRetrieveResponse
+from .csv_download_create_response import CsvDownloadCreateResponse as CsvDownloadCreateResponse
+from .action_enable_emergency_params import ActionEnableEmergencyParams as ActionEnableEmergencyParams
+from .action_verify_ownership_params import ActionVerifyOwnershipParams as ActionVerifyOwnershipParams
+from .csv_download_retrieve_response import CsvDownloadRetrieveResponse as CsvDownloadRetrieveResponse
+from .action_enable_emergency_response import ActionEnableEmergencyResponse as ActionEnableEmergencyResponse
+from .action_verify_ownership_response import ActionVerifyOwnershipResponse as ActionVerifyOwnershipResponse
+from .phone_number_with_voice_settings import PhoneNumberWithVoiceSettings as PhoneNumberWithVoiceSettings
+from .action_change_bundle_status_params import ActionChangeBundleStatusParams as ActionChangeBundleStatusParams
+from .action_change_bundle_status_response import ActionChangeBundleStatusResponse as ActionChangeBundleStatusResponse
+from .job_update_emergency_settings_batch_params import (
+    JobUpdateEmergencySettingsBatchParams as JobUpdateEmergencySettingsBatchParams,
+)
+from .job_update_emergency_settings_batch_response import (
+    JobUpdateEmergencySettingsBatchResponse as JobUpdateEmergencySettingsBatchResponse,
+)

telnyx/types/phone_numbers/action_change_bundle_status_params.py

@@ -0,0 +1,18 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Required, TypedDict
+
+__all__ = ["ActionChangeBundleStatusParams"]
+
+
+class ActionChangeBundleStatusParams(TypedDict, total=False):
+    bundle_id: Required[str]
+    """The new bundle_id setting for the number.
+
+    If you are assigning the number to a bundle, this is the unique ID of the bundle
+    you wish to use. If you are removing the number from a bundle, this must be
+    null. You cannot assign a number from one bundle to another directly. You must
+    first remove it from a bundle, and then assign it to a new bundle.
+    """

telnyx/types/phone_numbers/action_change_bundle_status_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 .phone_number_with_voice_settings import PhoneNumberWithVoiceSettings
+
+__all__ = ["ActionChangeBundleStatusResponse"]
+
+
+class ActionChangeBundleStatusResponse(BaseModel):
+    data: Optional[PhoneNumberWithVoiceSettings] = None

telnyx/types/phone_numbers/action_enable_emergency_params.py

@@ -0,0 +1,15 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Required, TypedDict
+
+__all__ = ["ActionEnableEmergencyParams"]
+
+
+class ActionEnableEmergencyParams(TypedDict, total=False):
+    emergency_address_id: Required[str]
+    """Identifies the address to be used with emergency services."""
+
+    emergency_enabled: Required[bool]
+    """Indicates whether to enable emergency services on this number."""

telnyx/types/phone_numbers/action_enable_emergency_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 .phone_number_with_voice_settings import PhoneNumberWithVoiceSettings
+
+__all__ = ["ActionEnableEmergencyResponse"]
+
+
+class ActionEnableEmergencyResponse(BaseModel):
+    data: Optional[PhoneNumberWithVoiceSettings] = None

telnyx/types/phone_numbers/action_verify_ownership_params.py

@@ -0,0 +1,13 @@
+# 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 Required, TypedDict
+
+__all__ = ["ActionVerifyOwnershipParams"]
+
+
+class ActionVerifyOwnershipParams(TypedDict, total=False):
+    phone_numbers: Required[List[str]]
+    """Array of phone numbers to verify ownership for"""

telnyx/types/phone_numbers/action_verify_ownership_response.py

@@ -0,0 +1,30 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Optional
+
+from ..._models import BaseModel
+
+__all__ = ["ActionVerifyOwnershipResponse", "Data", "DataFound"]
+
+
+class DataFound(BaseModel):
+    id: Optional[str] = None
+    """Identifies the resource."""
+
+    number_val_e164: Optional[str] = None
+    """The phone number in E.164 format"""
+
+
+class Data(BaseModel):
+    found: Optional[List[DataFound]] = None
+    """The list of phone numbers which you own and are in an editable state"""
+
+    not_found: Optional[List[str]] = None
+    """Phone numbers that are not found in the account"""
+
+    record_type: Optional[str] = None
+    """Identifies the type of the resource."""
+
+
+class ActionVerifyOwnershipResponse(BaseModel):
+    data: Optional[Data] = None

telnyx/types/phone_numbers/call_forwarding.py

@@ -0,0 +1,27 @@
+# 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__ = ["CallForwarding"]
+
+
+class CallForwarding(BaseModel):
+    call_forwarding_enabled: Optional[bool] = None
+    """
+    Indicates if call forwarding will be enabled for this number if forwards_to and
+    forwarding_type are filled in. Defaults to true for backwards compatibility with
+    APIV1 use of numbers endpoints.
+    """
+
+    forwarding_type: Optional[Literal["always", "on-failure"]] = None
+    """Call forwarding type. 'forwards_to' must be set for this to have an effect."""
+
+    forwards_to: Optional[str] = None
+    """The phone number to which inbound calls to this number are forwarded.
+
+    Inbound calls will not be forwarded if this field is left blank. If set, must be
+    a +E.164-formatted phone number.
+    """