telnyx 3.0.0a0__py3-none-any.whl

telnyx/types/global_ip_usage_retrieve_params.py

@@ -0,0 +1,37 @@
+# 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__ = ["GlobalIPUsageRetrieveParams", "Filter", "FilterGlobalIPID", "FilterGlobalIPIDIn"]
+
+
+class GlobalIPUsageRetrieveParams(TypedDict, total=False):
+    filter: Filter
+    """Consolidated filter parameter (deepObject style).
+
+    Originally: filter[global_ip_id][in]
+    """
+
+
+_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_id: FilterGlobalIPID
+    """Filter by exact Global IP ID"""

telnyx/types/global_ip_usage_retrieve_response.py

@@ -0,0 +1,47 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Optional
+from datetime import datetime
+
+from .._models import BaseModel
+
+__all__ = ["GlobalIPUsageRetrieveResponse", "Data", "DataGlobalIP", "DataReceived", "DataTransmitted"]
+
+
+class DataGlobalIP(BaseModel):
+    id: Optional[str] = None
+    """Global IP ID."""
+
+    ip_address: Optional[str] = None
+    """The Global IP address."""
+
+
+class DataReceived(BaseModel):
+    amount: Optional[float] = None
+    """The amount of data received."""
+
+    unit: Optional[str] = None
+    """The unit of the amount of data received."""
+
+
+class DataTransmitted(BaseModel):
+    amount: Optional[float] = None
+    """The amount of data transmitted."""
+
+    unit: Optional[str] = None
+    """The unit of the amount of data transmitted."""
+
+
+class Data(BaseModel):
+    global_ip: Optional[DataGlobalIP] = None
+
+    received: Optional[DataReceived] = None
+
+    timestamp: Optional[datetime] = None
+    """The timestamp of the metric."""
+
+    transmitted: Optional[DataTransmitted] = None
+
+
+class GlobalIPUsageRetrieveResponse(BaseModel):
+    data: Optional[List[Data]] = None

telnyx/types/inbound_channel_list_response.py

@@ -0,0 +1,19 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+
+from .._models import BaseModel
+
+__all__ = ["InboundChannelListResponse", "Data"]
+
+
+class Data(BaseModel):
+    channels: Optional[int] = None
+    """The current number of concurrent channels set for the account"""
+
+    record_type: Optional[str] = None
+    """Identifies the type of the response"""
+
+
+class InboundChannelListResponse(BaseModel):
+    data: Optional[Data] = None

telnyx/types/inbound_channel_update_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__ = ["InboundChannelUpdateParams"]
+
+
+class InboundChannelUpdateParams(TypedDict, total=False):
+    channels: Required[int]
+    """The new number of concurrent channels for the account"""

telnyx/types/inbound_channel_update_response.py

@@ -0,0 +1,19 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+
+from .._models import BaseModel
+
+__all__ = ["InboundChannelUpdateResponse", "Data"]
+
+
+class Data(BaseModel):
+    channels: Optional[int] = None
+    """The number of channels set for the account"""
+
+    record_type: Optional[str] = None
+    """Identifies the type of the response"""
+
+
+class InboundChannelUpdateResponse(BaseModel):
+    data: Optional[Data] = None

telnyx/types/inbound_fqdn.py

@@ -0,0 +1,111 @@
+# 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
+
+__all__ = ["InboundFqdn"]
+
+
+class InboundFqdn(BaseModel):
+    ani_number_format: Optional[Literal["+E.164", "E.164", "+E.164-national", "E.164-national"]] = None
+    """
+    This setting allows you to set the format with which the caller's number (ANI)
+    is sent for inbound phone calls.
+    """
+
+    channel_limit: Optional[int] = None
+    """
+    When set, this will limit the total number of inbound calls to phone numbers
+    associated with this connection.
+    """
+
+    codecs: Optional[List[str]] = None
+    """
+    Defines the list of codecs that Telnyx will send for inbound calls to a specific
+    number on your portal account, in priority order. This only works when the
+    Connection the number is assigned to uses Media Handling mode: default. OPUS and
+    H.264 codecs are available only when using TCP or TLS transport for SIP.
+    """
+
+    default_primary_fqdn_id: Optional[str] = None
+    """The default primary FQDN to use for the number.
+
+    Only settable if the connection is of FQDN type. Value must be the ID of an FQDN
+    set on the connection.
+    """
+
+    default_routing_method: Optional[Literal["sequential", "round-robin"]] = None
+    """
+    Default routing method to be used when a number is associated with the
+    connection. Must be one of the routing method types or null, other values are
+    not allowed.
+    """
+
+    default_secondary_fqdn_id: Optional[str] = None
+    """The default secondary FQDN to use for the number.
+
+    Only settable if the connection is of FQDN type. Value must be the ID of an FQDN
+    set on the connection.
+    """
+
+    default_tertiary_fqdn_id: Optional[str] = None
+    """The default tertiary FQDN to use for the number.
+
+    Only settable if the connection is of FQDN type. Value must be the ID of an FQDN
+    set on the connection.
+    """
+
+    dnis_number_format: Optional[Literal["+e164", "e164", "national", "sip_username"]] = None
+
+    generate_ringback_tone: Optional[bool] = None
+    """Generate ringback tone through 183 session progress message with early media."""
+
+    isup_headers_enabled: Optional[bool] = None
+    """When set, inbound phone calls will receive ISUP parameters via SIP headers.
+
+    (Only when available and only when using TCP or TLS transport.)
+    """
+
+    prack_enabled: Optional[bool] = None
+    """Enable PRACK messages as defined in RFC3262."""
+
+    shaken_stir_enabled: Optional[bool] = None
+    """
+    When enabled the SIP Connection will receive the Identity header with
+    Shaken/Stir data in the SIP INVITE message of inbound calls, even when using UDP
+    transport.
+    """
+
+    sip_compact_headers_enabled: Optional[bool] = None
+    """Defaults to true."""
+
+    sip_region: Optional[Literal["US", "Europe", "Australia"]] = None
+    """Selects which `sip_region` to receive inbound calls from.
+
+    If null, the default region (US) will be used.
+    """
+
+    sip_subdomain: Optional[str] = None
+    """
+    Specifies a subdomain that can be used to receive Inbound calls to a Connection,
+    in the same way a phone number is used, from a SIP endpoint. Example: the
+    subdomain "example.sip.telnyx.com" can be called from any SIP endpoint by using
+    the SIP URI "sip:@example.sip.telnyx.com" where the user part can be any
+    alphanumeric value. Please note TLS encrypted calls are not allowed for
+    subdomain calls.
+    """
+
+    sip_subdomain_receive_settings: Optional[Literal["only_my_connections", "from_anyone"]] = None
+    """
+    This option can be enabled to receive calls from: "Anyone" (any SIP endpoint in
+    the public Internet) or "Only my connections" (any connection assigned to the
+    same Telnyx user).
+    """
+
+    timeout_1xx_secs: Optional[int] = None
+    """Time(sec) before aborting if connection is not made."""
+
+    timeout_2xx_secs: Optional[int] = None
+    """Time(sec) before aborting if call is unanswered (min: 1, max: 600)."""

telnyx/types/inbound_fqdn_param.py

@@ -0,0 +1,111 @@
+# 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 Literal, TypedDict
+
+__all__ = ["InboundFqdnParam"]
+
+
+class InboundFqdnParam(TypedDict, total=False):
+    ani_number_format: Literal["+E.164", "E.164", "+E.164-national", "E.164-national"]
+    """
+    This setting allows you to set the format with which the caller's number (ANI)
+    is sent for inbound phone calls.
+    """
+
+    channel_limit: Optional[int]
+    """
+    When set, this will limit the total number of inbound calls to phone numbers
+    associated with this connection.
+    """
+
+    codecs: List[str]
+    """
+    Defines the list of codecs that Telnyx will send for inbound calls to a specific
+    number on your portal account, in priority order. This only works when the
+    Connection the number is assigned to uses Media Handling mode: default. OPUS and
+    H.264 codecs are available only when using TCP or TLS transport for SIP.
+    """
+
+    default_primary_fqdn_id: Optional[str]
+    """The default primary FQDN to use for the number.
+
+    Only settable if the connection is of FQDN type. Value must be the ID of an FQDN
+    set on the connection.
+    """
+
+    default_routing_method: Optional[Literal["sequential", "round-robin"]]
+    """
+    Default routing method to be used when a number is associated with the
+    connection. Must be one of the routing method types or null, other values are
+    not allowed.
+    """
+
+    default_secondary_fqdn_id: Optional[str]
+    """The default secondary FQDN to use for the number.
+
+    Only settable if the connection is of FQDN type. Value must be the ID of an FQDN
+    set on the connection.
+    """
+
+    default_tertiary_fqdn_id: Optional[str]
+    """The default tertiary FQDN to use for the number.
+
+    Only settable if the connection is of FQDN type. Value must be the ID of an FQDN
+    set on the connection.
+    """
+
+    dnis_number_format: Literal["+e164", "e164", "national", "sip_username"]
+
+    generate_ringback_tone: bool
+    """Generate ringback tone through 183 session progress message with early media."""
+
+    isup_headers_enabled: bool
+    """When set, inbound phone calls will receive ISUP parameters via SIP headers.
+
+    (Only when available and only when using TCP or TLS transport.)
+    """
+
+    prack_enabled: bool
+    """Enable PRACK messages as defined in RFC3262."""
+
+    shaken_stir_enabled: bool
+    """
+    When enabled the SIP Connection will receive the Identity header with
+    Shaken/Stir data in the SIP INVITE message of inbound calls, even when using UDP
+    transport.
+    """
+
+    sip_compact_headers_enabled: bool
+    """Defaults to true."""
+
+    sip_region: Literal["US", "Europe", "Australia"]
+    """Selects which `sip_region` to receive inbound calls from.
+
+    If null, the default region (US) will be used.
+    """
+
+    sip_subdomain: Optional[str]
+    """
+    Specifies a subdomain that can be used to receive Inbound calls to a Connection,
+    in the same way a phone number is used, from a SIP endpoint. Example: the
+    subdomain "example.sip.telnyx.com" can be called from any SIP endpoint by using
+    the SIP URI "sip:@example.sip.telnyx.com" where the user part can be any
+    alphanumeric value. Please note TLS encrypted calls are not allowed for
+    subdomain calls.
+    """
+
+    sip_subdomain_receive_settings: Literal["only_my_connections", "from_anyone"]
+    """
+    This option can be enabled to receive calls from: "Anyone" (any SIP endpoint in
+    the public Internet) or "Only my connections" (any connection assigned to the
+    same Telnyx user).
+    """
+
+    timeout_1xx_secs: int
+    """Time(sec) before aborting if connection is not made."""
+
+    timeout_2xx_secs: int
+    """Time(sec) before aborting if call is unanswered (min: 1, max: 600)."""

telnyx/types/inbound_ip.py

@@ -0,0 +1,111 @@
+# 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
+
+__all__ = ["InboundIP"]
+
+
+class InboundIP(BaseModel):
+    ani_number_format: Optional[Literal["+E.164", "E.164", "+E.164-national", "E.164-national"]] = None
+    """
+    This setting allows you to set the format with which the caller's number (ANI)
+    is sent for inbound phone calls.
+    """
+
+    channel_limit: Optional[int] = None
+    """
+    When set, this will limit the total number of inbound calls to phone numbers
+    associated with this connection.
+    """
+
+    codecs: Optional[List[str]] = None
+    """
+    Defines the list of codecs that Telnyx will send for inbound calls to a specific
+    number on your portal account, in priority order. This only works when the
+    Connection the number is assigned to uses Media Handling mode: default. OPUS and
+    H.264 codecs are available only when using TCP or TLS transport for SIP.
+    """
+
+    default_primary_ip_id: Optional[str] = None
+    """The default primary IP to use for the number.
+
+    Only settable if the connection is of IP authentication type. Value must be the
+    ID of an authorized IP set on the connection.
+    """
+
+    default_routing_method: Optional[Literal["sequential", "round-robin"]] = None
+    """
+    Default routing method to be used when a number is associated with the
+    connection. Must be one of the routing method types or left blank, other values
+    are not allowed.
+    """
+
+    default_secondary_ip_id: Optional[str] = None
+    """The default secondary IP to use for the number.
+
+    Only settable if the connection is of IP authentication type. Value must be the
+    ID of an authorized IP set on the connection.
+    """
+
+    default_tertiary_ip_id: Optional[str] = None
+    """The default tertiary IP to use for the number.
+
+    Only settable if the connection is of IP authentication type. Value must be the
+    ID of an authorized IP set on the connection.
+    """
+
+    dnis_number_format: Optional[Literal["+e164", "e164", "national", "sip_username"]] = None
+
+    generate_ringback_tone: Optional[bool] = None
+    """Generate ringback tone through 183 session progress message with early media."""
+
+    isup_headers_enabled: Optional[bool] = None
+    """When set, inbound phone calls will receive ISUP parameters via SIP headers.
+
+    (Only when available and only when using TCP or TLS transport.)
+    """
+
+    prack_enabled: Optional[bool] = None
+    """Enable PRACK messages as defined in RFC3262."""
+
+    shaken_stir_enabled: Optional[bool] = None
+    """
+    When enabled the SIP Connection will receive the Identity header with
+    Shaken/Stir data in the SIP INVITE message of inbound calls, even when using UDP
+    transport.
+    """
+
+    sip_compact_headers_enabled: Optional[bool] = None
+    """Defaults to true."""
+
+    sip_region: Optional[Literal["US", "Europe", "Australia"]] = None
+    """Selects which `sip_region` to receive inbound calls from.
+
+    If null, the default region (US) will be used.
+    """
+
+    sip_subdomain: Optional[str] = None
+    """
+    Specifies a subdomain that can be used to receive Inbound calls to a Connection,
+    in the same way a phone number is used, from a SIP endpoint. Example: the
+    subdomain "example.sip.telnyx.com" can be called from any SIP endpoint by using
+    the SIP URI "sip:@example.sip.telnyx.com" where the user part can be any
+    alphanumeric value. Please note TLS encrypted calls are not allowed for
+    subdomain calls.
+    """
+
+    sip_subdomain_receive_settings: Optional[Literal["only_my_connections", "from_anyone"]] = None
+    """
+    This option can be enabled to receive calls from: "Anyone" (any SIP endpoint in
+    the public Internet) or "Only my connections" (any connection assigned to the
+    same Telnyx user).
+    """
+
+    timeout_1xx_secs: Optional[int] = None
+    """Time(sec) before aborting if connection is not made."""
+
+    timeout_2xx_secs: Optional[int] = None
+    """Time(sec) before aborting if call is unanswered (min: 1, max: 600)."""

telnyx/types/inbound_ip_param.py

@@ -0,0 +1,111 @@
+# 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 Literal, TypedDict
+
+__all__ = ["InboundIPParam"]
+
+
+class InboundIPParam(TypedDict, total=False):
+    ani_number_format: Literal["+E.164", "E.164", "+E.164-national", "E.164-national"]
+    """
+    This setting allows you to set the format with which the caller's number (ANI)
+    is sent for inbound phone calls.
+    """
+
+    channel_limit: int
+    """
+    When set, this will limit the total number of inbound calls to phone numbers
+    associated with this connection.
+    """
+
+    codecs: List[str]
+    """
+    Defines the list of codecs that Telnyx will send for inbound calls to a specific
+    number on your portal account, in priority order. This only works when the
+    Connection the number is assigned to uses Media Handling mode: default. OPUS and
+    H.264 codecs are available only when using TCP or TLS transport for SIP.
+    """
+
+    default_primary_ip_id: str
+    """The default primary IP to use for the number.
+
+    Only settable if the connection is of IP authentication type. Value must be the
+    ID of an authorized IP set on the connection.
+    """
+
+    default_routing_method: Literal["sequential", "round-robin"]
+    """
+    Default routing method to be used when a number is associated with the
+    connection. Must be one of the routing method types or left blank, other values
+    are not allowed.
+    """
+
+    default_secondary_ip_id: str
+    """The default secondary IP to use for the number.
+
+    Only settable if the connection is of IP authentication type. Value must be the
+    ID of an authorized IP set on the connection.
+    """
+
+    default_tertiary_ip_id: str
+    """The default tertiary IP to use for the number.
+
+    Only settable if the connection is of IP authentication type. Value must be the
+    ID of an authorized IP set on the connection.
+    """
+
+    dnis_number_format: Literal["+e164", "e164", "national", "sip_username"]
+
+    generate_ringback_tone: bool
+    """Generate ringback tone through 183 session progress message with early media."""
+
+    isup_headers_enabled: bool
+    """When set, inbound phone calls will receive ISUP parameters via SIP headers.
+
+    (Only when available and only when using TCP or TLS transport.)
+    """
+
+    prack_enabled: bool
+    """Enable PRACK messages as defined in RFC3262."""
+
+    shaken_stir_enabled: bool
+    """
+    When enabled the SIP Connection will receive the Identity header with
+    Shaken/Stir data in the SIP INVITE message of inbound calls, even when using UDP
+    transport.
+    """
+
+    sip_compact_headers_enabled: bool
+    """Defaults to true."""
+
+    sip_region: Literal["US", "Europe", "Australia"]
+    """Selects which `sip_region` to receive inbound calls from.
+
+    If null, the default region (US) will be used.
+    """
+
+    sip_subdomain: str
+    """
+    Specifies a subdomain that can be used to receive Inbound calls to a Connection,
+    in the same way a phone number is used, from a SIP endpoint. Example: the
+    subdomain "example.sip.telnyx.com" can be called from any SIP endpoint by using
+    the SIP URI "sip:@example.sip.telnyx.com" where the user part can be any
+    alphanumeric value. Please note TLS encrypted calls are not allowed for
+    subdomain calls.
+    """
+
+    sip_subdomain_receive_settings: Literal["only_my_connections", "from_anyone"]
+    """
+    This option can be enabled to receive calls from: "Anyone" (any SIP endpoint in
+    the public Internet) or "Only my connections" (any connection assigned to the
+    same Telnyx user).
+    """
+
+    timeout_1xx_secs: int
+    """Time(sec) before aborting if connection is not made."""
+
+    timeout_2xx_secs: int
+    """Time(sec) before aborting if call is unanswered (min: 1, max: 600)."""

telnyx/types/integration_secret.py

@@ -0,0 +1,20 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+from datetime import datetime
+
+from .._models import BaseModel
+
+__all__ = ["IntegrationSecret"]
+
+
+class IntegrationSecret(BaseModel):
+    id: str
+
+    created_at: datetime
+
+    identifier: str
+
+    record_type: str
+
+    updated_at: Optional[datetime] = None

telnyx/types/integration_secret_create_params.py

@@ -0,0 +1,30 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Literal, Required, TypedDict
+
+__all__ = ["IntegrationSecretCreateParams"]
+
+
+class IntegrationSecretCreateParams(TypedDict, total=False):
+    identifier: Required[str]
+    """The unique identifier of the secret."""
+
+    type: Required[Literal["bearer", "basic"]]
+    """The type of secret."""
+
+    token: str
+    """The token for the secret. Required for bearer type secrets, ignored otherwise."""
+
+    password: str
+    """The password for the secret.
+
+    Required for basic type secrets, ignored otherwise.
+    """
+
+    username: str
+    """The username for the secret.
+
+    Required for basic type secrets, ignored otherwise.
+    """

telnyx/types/integration_secret_create_response.py

@@ -0,0 +1,10 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from .._models import BaseModel
+from .integration_secret import IntegrationSecret
+
+__all__ = ["IntegrationSecretCreateResponse"]
+
+
+class IntegrationSecretCreateResponse(BaseModel):
+    data: IntegrationSecret

telnyx/types/integration_secret_list_params.py

@@ -0,0 +1,28 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Literal, TypedDict
+
+__all__ = ["IntegrationSecretListParams", "Filter", "Page"]
+
+
+class IntegrationSecretListParams(TypedDict, total=False):
+    filter: Filter
+    """Consolidated filter parameter (deepObject style). Originally: filter[type]"""
+
+    page: Page
+    """Consolidated page parameter (deepObject style).
+
+    Originally: page[size], page[number]
+    """
+
+
+class Filter(TypedDict, total=False):
+    type: Literal["bearer", "basic"]
+
+
+class Page(TypedDict, total=False):
+    number: int
+
+    size: int