telnyx 3.0.0a0__py3-none-any.whl

telnyx/types/fqdn_connection_update_params.py

@@ -0,0 +1,104 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import List, Optional
+from typing_extensions import TypedDict
+
+from .dtmf_type import DtmfType
+from .encrypted_media import EncryptedMedia
+from .inbound_fqdn_param import InboundFqdnParam
+from .transport_protocol import TransportProtocol
+from .anchorsite_override import AnchorsiteOverride
+from .outbound_fqdn_param import OutboundFqdnParam
+from .webhook_api_version import WebhookAPIVersion
+from .connection_rtcp_settings_param import ConnectionRtcpSettingsParam
+
+__all__ = ["FqdnConnectionUpdateParams"]
+
+
+class FqdnConnectionUpdateParams(TypedDict, total=False):
+    active: bool
+    """Defaults to true"""
+
+    anchorsite_override: AnchorsiteOverride
+    """
+    `Latency` directs Telnyx to route media through the site with the lowest
+    round-trip time to the user's connection. Telnyx calculates this time using ICMP
+    ping messages. This can be disabled by specifying a site to handle all media.
+    """
+
+    android_push_credential_id: Optional[str]
+    """The uuid of the push credential for Android"""
+
+    connection_name: str
+    """A user-assigned name to help manage the connection."""
+
+    default_on_hold_comfort_noise_enabled: bool
+    """When enabled, Telnyx will generate comfort noise when you place the call on
+    hold.
+
+    If disabled, you will need to generate comfort noise or on hold music to avoid
+    RTP timeout.
+    """
+
+    dtmf_type: DtmfType
+    """Sets the type of DTMF digits sent from Telnyx to this Connection.
+
+    Note that DTMF digits sent to Telnyx will be accepted in all formats.
+    """
+
+    encode_contact_header_enabled: bool
+    """
+    Encode the SIP contact header sent by Telnyx to avoid issues for NAT or ALG
+    scenarios.
+    """
+
+    encrypted_media: Optional[EncryptedMedia]
+    """Enable use of SRTP for encryption.
+
+    Cannot be set if the transport_portocol is TLS.
+    """
+
+    inbound: InboundFqdnParam
+
+    ios_push_credential_id: Optional[str]
+    """The uuid of the push credential for Ios"""
+
+    onnet_t38_passthrough_enabled: bool
+    """
+    Enable on-net T38 if you prefer that the sender and receiver negotiate T38
+    directly when both are on the Telnyx network. If this is disabled, Telnyx will
+    be able to use T38 on just one leg of the call according to each leg's settings.
+    """
+
+    outbound: OutboundFqdnParam
+
+    rtcp_settings: ConnectionRtcpSettingsParam
+
+    tags: List[str]
+    """Tags associated with the connection."""
+
+    transport_protocol: TransportProtocol
+    """One of UDP, TLS, or TCP.
+
+    Applies only to connections with IP authentication or FQDN authentication.
+    """
+
+    webhook_api_version: WebhookAPIVersion
+    """Determines which webhook format will be used, Telnyx API v1 or v2."""
+
+    webhook_event_failover_url: Optional[str]
+    """
+    The failover URL where webhooks related to this connection will be sent if
+    sending to the primary URL fails. Must include a scheme, such as 'https'.
+    """
+
+    webhook_event_url: str
+    """The URL where webhooks related to this connection will be sent.
+
+    Must include a scheme, such as 'https'.
+    """
+
+    webhook_timeout_secs: Optional[int]
+    """Specifies how many seconds to wait before timing out a webhook."""

telnyx/types/fqdn_connection_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 .fqdn_connection import FqdnConnection
+
+__all__ = ["FqdnConnectionUpdateResponse"]
+
+
+class FqdnConnectionUpdateResponse(BaseModel):
+    data: Optional[FqdnConnection] = None

telnyx/types/fqdn_create_params.py

@@ -0,0 +1,27 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Optional
+from typing_extensions import Required, TypedDict
+
+__all__ = ["FqdnCreateParams"]
+
+
+class FqdnCreateParams(TypedDict, total=False):
+    connection_id: Required[str]
+    """ID of the FQDN connection to which this IP should be attached."""
+
+    dns_record_type: Required[str]
+    """The DNS record type for the FQDN.
+
+    For cases where a port is not set, the DNS record type must be 'srv'. For cases
+    where a port is set, the DNS record type must be 'a'. If the DNS record type is
+    'a' and a port is not specified, 5060 will be used.
+    """
+
+    fqdn: Required[str]
+    """FQDN represented by this resource."""
+
+    port: Optional[int]
+    """Port to use when connecting to this FQDN."""

telnyx/types/fqdn_create_response.py

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

telnyx/types/fqdn_delete_response.py

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

telnyx/types/fqdn_list_params.py

@@ -0,0 +1,44 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import TypedDict
+
+__all__ = ["FqdnListParams", "Filter", "Page"]
+
+
+class FqdnListParams(TypedDict, total=False):
+    filter: Filter
+    """Consolidated filter parameter (deepObject style).
+
+    Originally: filter[connection_id], filter[fqdn], filter[port],
+    filter[dns_record_type]
+    """
+
+    page: Page
+    """Consolidated page parameter (deepObject style).
+
+    Originally: page[size], page[number]
+    """
+
+
+class Filter(TypedDict, total=False):
+    connection_id: str
+    """ID of the FQDN connection to which the FQDN belongs."""
+
+    dns_record_type: str
+    """DNS record type used by the FQDN."""
+
+    fqdn: str
+    """FQDN represented by the resource."""
+
+    port: int
+    """Port to use when connecting to the FQDN."""
+
+
+class Page(TypedDict, total=False):
+    number: int
+    """The page number to load"""
+
+    size: int
+    """The size of the page"""

telnyx/types/fqdn_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 .fqdn import Fqdn
+from .._models import BaseModel
+from .shared.connections_pagination_meta import ConnectionsPaginationMeta
+
+__all__ = ["FqdnListResponse"]
+
+
+class FqdnListResponse(BaseModel):
+    data: Optional[List[Fqdn]] = None
+
+    meta: Optional[ConnectionsPaginationMeta] = None

telnyx/types/fqdn_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 .fqdn import Fqdn
+from .._models import BaseModel
+
+__all__ = ["FqdnRetrieveResponse"]
+
+
+class FqdnRetrieveResponse(BaseModel):
+    data: Optional[Fqdn] = None

telnyx/types/fqdn_update_params.py

@@ -0,0 +1,27 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Optional
+from typing_extensions import TypedDict
+
+__all__ = ["FqdnUpdateParams"]
+
+
+class FqdnUpdateParams(TypedDict, total=False):
+    connection_id: str
+    """ID of the FQDN connection to which this IP should be attached."""
+
+    dns_record_type: str
+    """The DNS record type for the FQDN.
+
+    For cases where a port is not set, the DNS record type must be 'srv'. For cases
+    where a port is set, the DNS record type must be 'a'. If the DNS record type is
+    'a' and a port is not specified, 5060 will be used.
+    """
+
+    fqdn: str
+    """FQDN represented by this resource."""
+
+    port: Optional[int]
+    """Port to use when connecting to this FQDN."""

telnyx/types/fqdn_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 .fqdn import Fqdn
+from .._models import BaseModel
+
+__all__ = ["FqdnUpdateResponse"]
+
+
+class FqdnUpdateResponse(BaseModel):
+    data: Optional[Fqdn] = None

telnyx/types/gcs_configuration_data.py

@@ -0,0 +1,18 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+
+from .._models import BaseModel
+
+__all__ = ["GcsConfigurationData"]
+
+
+class GcsConfigurationData(BaseModel):
+    bucket: Optional[str] = None
+    """Name of the bucket to be used to store recording files."""
+
+    credentials: Optional[str] = None
+    """
+    Opaque credential token used to authenticate and authorize with storage
+    provider.
+    """

telnyx/types/gcs_configuration_data_param.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 TypedDict
+
+__all__ = ["GcsConfigurationDataParam"]
+
+
+class GcsConfigurationDataParam(TypedDict, total=False):
+    bucket: str
+    """Name of the bucket to be used to store recording files."""
+
+    credentials: str
+    """
+    Opaque credential token used to authenticate and authorize with storage
+    provider.
+    """

telnyx/types/global_ip_allowed_port_list_response.py

@@ -0,0 +1,31 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Optional
+
+from .._models import BaseModel
+
+__all__ = ["GlobalIPAllowedPortListResponse", "Data"]
+
+
+class Data(BaseModel):
+    id: Optional[str] = None
+    """Identifies the resource."""
+
+    first_port: Optional[int] = None
+    """First port of a range."""
+
+    last_port: Optional[int] = None
+    """Last port of a range."""
+
+    name: Optional[str] = None
+    """A name for the Global IP ports range."""
+
+    protocol_code: Optional[str] = None
+    """The Global IP Protocol code."""
+
+    record_type: Optional[str] = None
+    """Identifies the type of the resource."""
+
+
+class GlobalIPAllowedPortListResponse(BaseModel):
+    data: Optional[List[Data]] = None

telnyx/types/global_ip_assignment.py

@@ -0,0 +1,31 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+
+from .record import Record
+from .interface_status import InterfaceStatus
+
+__all__ = ["GlobalIPAssignment"]
+
+
+class GlobalIPAssignment(Record):
+    global_ip_id: Optional[str] = None
+    """Global IP ID."""
+
+    is_announced: Optional[bool] = None
+    """Status of BGP announcement."""
+
+    is_connected: Optional[bool] = None
+    """Wireguard peer is connected."""
+
+    is_in_maintenance: Optional[bool] = None
+    """Enable/disable BGP announcement."""
+
+    record_type: Optional[str] = None  # type: ignore
+    """Identifies the type of the resource."""
+
+    status: Optional[InterfaceStatus] = None
+    """The current status of the interface deployment."""
+
+    wireguard_peer_id: Optional[str] = None
+    """Wireguard peer ID."""

telnyx/types/global_ip_assignment_create_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 TypedDict
+
+__all__ = ["GlobalIPAssignmentCreateParams"]
+
+
+class GlobalIPAssignmentCreateParams(TypedDict, total=False):
+    global_ip_id: str
+    """Global IP ID."""
+
+    is_in_maintenance: bool
+    """Enable/disable BGP announcement."""
+
+    wireguard_peer_id: str
+    """Wireguard peer ID."""

telnyx/types/global_ip_assignment_create_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 .global_ip_assignment import GlobalIPAssignment
+
+__all__ = ["GlobalIPAssignmentCreateResponse"]
+
+
+class GlobalIPAssignmentCreateResponse(BaseModel):
+    data: Optional[GlobalIPAssignment] = None

telnyx/types/global_ip_assignment_delete_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 .global_ip_assignment import GlobalIPAssignment
+
+__all__ = ["GlobalIPAssignmentDeleteResponse"]
+
+
+class GlobalIPAssignmentDeleteResponse(BaseModel):
+    data: Optional[GlobalIPAssignment] = None

telnyx/types/global_ip_assignment_health_retrieve_params.py

@@ -0,0 +1,62 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Union
+from typing_extensions import TypeAlias, TypedDict
+
+__all__ = [
+    "GlobalIPAssignmentHealthRetrieveParams",
+    "Filter",
+    "FilterGlobalIPAssignmentID",
+    "FilterGlobalIPAssignmentIDIn",
+    "FilterGlobalIPID",
+    "FilterGlobalIPIDIn",
+]
+
+
+class GlobalIPAssignmentHealthRetrieveParams(TypedDict, total=False):
+    filter: Filter
+    """Consolidated filter parameter (deepObject style).
+
+    Originally: filter[global_ip_id][in], filter[global_ip_assignment_id][in]
+    """
+
+
+_FilterGlobalIPAssignmentIDInReservedKeywords = TypedDict(
+    "_FilterGlobalIPAssignmentIDInReservedKeywords",
+    {
+        "in": str,
+    },
+    total=False,
+)
+
+
+class FilterGlobalIPAssignmentIDIn(_FilterGlobalIPAssignmentIDInReservedKeywords, total=False):
+    pass
+
+
+FilterGlobalIPAssignmentID: TypeAlias = Union[str, FilterGlobalIPAssignmentIDIn]
+
+_FilterGlobalIpidInReservedKeywords = TypedDict(
+    "_FilterGlobalIpidInReservedKeywords",
+    {
+        "in": str,
+    },
+    total=False,
+)
+
+
+class FilterGlobalIPIDIn(_FilterGlobalIpidInReservedKeywords, total=False):
+    pass
+
+
+FilterGlobalIPID: TypeAlias = Union[str, FilterGlobalIPIDIn]
+
+
+class Filter(TypedDict, total=False):
+    global_ip_assignment_id: FilterGlobalIPAssignmentID
+    """Filter by exact Global IP Assignment ID"""
+
+    global_ip_id: FilterGlobalIPID
+    """Filter by exact Global IP ID"""

telnyx/types/global_ip_assignment_health_retrieve_response.py

@@ -0,0 +1,66 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Optional
+from datetime import datetime
+
+from pydantic import Field as FieldInfo
+
+from .._models import BaseModel
+
+__all__ = [
+    "GlobalIPAssignmentHealthRetrieveResponse",
+    "Data",
+    "DataGlobalIP",
+    "DataGlobalIPAssignment",
+    "DataGlobalIPAssignmentWireguardPeer",
+    "DataHealth",
+]
+
+
+class DataGlobalIP(BaseModel):
+    id: Optional[str] = None
+    """Global IP ID."""
+
+    ip_address: Optional[str] = None
+    """The Global IP address."""
+
+
+class DataGlobalIPAssignmentWireguardPeer(BaseModel):
+    ip_address: Optional[str] = None
+    """The IP address of the interface."""
+
+    name: Optional[str] = None
+    """A user specified name for the interface."""
+
+
+class DataGlobalIPAssignment(BaseModel):
+    id: Optional[str] = None
+    """Global IP assignment ID."""
+
+    wireguard_peer: Optional[DataGlobalIPAssignmentWireguardPeer] = None
+
+    wireguard_peer_id: Optional[str] = None
+    """Wireguard peer ID."""
+
+
+class DataHealth(BaseModel):
+    fail: Optional[float] = None
+    """The number of failed health checks."""
+
+    pass_: Optional[float] = FieldInfo(alias="pass", default=None)
+    """The number of successful health checks."""
+
+
+class Data(BaseModel):
+    global_ip: Optional[DataGlobalIP] = None
+
+    global_ip_assignment: Optional[DataGlobalIPAssignment] = None
+
+    health: Optional[DataHealth] = None
+
+    timestamp: Optional[datetime] = None
+    """The timestamp of the metric."""
+
+
+class GlobalIPAssignmentHealthRetrieveResponse(BaseModel):
+    data: Optional[List[Data]] = None

telnyx/types/global_ip_assignment_list_params.py

@@ -0,0 +1,23 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import TypedDict
+
+__all__ = ["GlobalIPAssignmentListParams", "Page"]
+
+
+class GlobalIPAssignmentListParams(TypedDict, total=False):
+    page: Page
+    """Consolidated page parameter (deepObject style).
+
+    Originally: page[number], page[size]
+    """
+
+
+class Page(TypedDict, total=False):
+    number: int
+    """The page number to load"""
+
+    size: int
+    """The size of the page"""

telnyx/types/global_ip_assignment_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 .global_ip_assignment import GlobalIPAssignment
+
+__all__ = ["GlobalIPAssignmentListResponse"]
+
+
+class GlobalIPAssignmentListResponse(BaseModel):
+    data: Optional[List[GlobalIPAssignment]] = None
+
+    meta: Optional[PaginationMeta] = None

telnyx/types/global_ip_assignment_param.py

@@ -0,0 +1,18 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from .record_param import RecordParam
+
+__all__ = ["GlobalIPAssignmentParam"]
+
+
+class GlobalIPAssignmentParam(RecordParam, total=False):
+    global_ip_id: str
+    """Global IP ID."""
+
+    is_in_maintenance: bool
+    """Enable/disable BGP announcement."""
+
+    wireguard_peer_id: str
+    """Wireguard peer ID."""

telnyx/types/global_ip_assignment_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 .global_ip_assignment import GlobalIPAssignment
+
+__all__ = ["GlobalIPAssignmentRetrieveResponse"]
+
+
+class GlobalIPAssignmentRetrieveResponse(BaseModel):
+    data: Optional[GlobalIPAssignment] = None

telnyx/types/global_ip_assignment_update_params.py

@@ -0,0 +1,17 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Required, TypedDict
+
+from .global_ip_assignment_param import GlobalIPAssignmentParam
+
+__all__ = ["GlobalIPAssignmentUpdateParams", "Body"]
+
+
+class GlobalIPAssignmentUpdateParams(TypedDict, total=False):
+    body: Required[Body]
+
+
+class Body(GlobalIPAssignmentParam, total=False):
+    pass

telnyx/types/global_ip_assignment_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 .global_ip_assignment import GlobalIPAssignment
+
+__all__ = ["GlobalIPAssignmentUpdateResponse"]
+
+
+class GlobalIPAssignmentUpdateResponse(BaseModel):
+    data: Optional[GlobalIPAssignment] = None