telnyx 3.0.0a0__py3-none-any.whl

telnyx/types/virtual_cross_connect_create_params.py

@@ -0,0 +1,95 @@
+# 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__ = ["VirtualCrossConnectCreateParams"]
+
+
+class VirtualCrossConnectCreateParams(TypedDict, total=False):
+    bgp_asn: Required[float]
+    """The Border Gateway Protocol (BGP) Autonomous System Number (ASN).
+
+    If null, value will be assigned by Telnyx.
+    """
+
+    cloud_provider: Required[Literal["aws", "azure", "gce"]]
+    """
+    The Virtual Private Cloud with which you would like to establish a cross
+    connect.
+    """
+
+    cloud_provider_region: Required[str]
+    """
+    The region where your Virtual Private Cloud hosts are located.<br /><br />The
+    available regions can be found using the /virtual_cross_connect_regions
+    endpoint.
+    """
+
+    network_id: Required[str]
+    """The id of the network associated with the interface."""
+
+    primary_cloud_account_id: Required[str]
+    """The identifier for your Virtual Private Cloud.
+
+    The number will be different based upon your Cloud provider.
+    """
+
+    region_code: Required[str]
+    """The region the interface should be deployed to."""
+
+    bandwidth_mbps: float
+    """
+    The desired throughput in Megabits per Second (Mbps) for your Virtual Cross
+    Connect.<br /><br />The available bandwidths can be found using the
+    /virtual_cross_connect_regions endpoint.
+    """
+
+    name: str
+    """A user specified name for the interface."""
+
+    primary_bgp_key: str
+    """The authentication key for BGP peer configuration."""
+
+    primary_cloud_ip: str
+    """
+    The IP address assigned for your side of the Virtual Cross
+    Connect.<br /><br />If none is provided, one will be generated for
+    you.<br /><br />This value should be null for GCE as Google will only inform you
+    of your assigned IP once the connection has been accepted.
+    """
+
+    primary_telnyx_ip: str
+    """
+    The IP address assigned to the Telnyx side of the Virtual Cross
+    Connect.<br /><br />If none is provided, one will be generated for
+    you.<br /><br />This value should be null for GCE as Google will only inform you
+    of your assigned IP once the connection has been accepted.
+    """
+
+    secondary_bgp_key: str
+    """The authentication key for BGP peer configuration."""
+
+    secondary_cloud_account_id: str
+    """The identifier for your Virtual Private Cloud.
+
+    The number will be different based upon your Cloud provider.<br /><br />This
+    attribute is only necessary for GCE.
+    """
+
+    secondary_cloud_ip: str
+    """
+    The IP address assigned for your side of the Virtual Cross
+    Connect.<br /><br />If none is provided, one will be generated for
+    you.<br /><br />This value should be null for GCE as Google will only inform you
+    of your assigned IP once the connection has been accepted.
+    """
+
+    secondary_telnyx_ip: str
+    """
+    The IP address assigned to the Telnyx side of the Virtual Cross
+    Connect.<br /><br />If none is provided, one will be generated for
+    you.<br /><br />This value should be null for GCE as Google will only inform you
+    of your assigned IP once the connection has been accepted.
+    """

telnyx/types/virtual_cross_connect_create_response.py

@@ -0,0 +1,129 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+from typing_extensions import Literal
+
+from .record import Record
+from .._models import BaseModel
+from .interface import Interface
+from .region_in import RegionIn
+
+__all__ = ["VirtualCrossConnectCreateResponse", "Data", "DataRegion"]
+
+
+class DataRegion(BaseModel):
+    code: Optional[str] = None
+    """Region code of the interface."""
+
+    name: Optional[str] = None
+    """Region name of the interface."""
+
+    record_type: Optional[str] = None
+    """Identifies the type of the resource."""
+
+
+class Data(Record, Interface, RegionIn):
+    bgp_asn: float
+    """The Border Gateway Protocol (BGP) Autonomous System Number (ASN).
+
+    If null, value will be assigned by Telnyx.
+    """
+
+    cloud_provider: Literal["aws", "azure", "gce"]
+    """
+    The Virtual Private Cloud with which you would like to establish a cross
+    connect.
+    """
+
+    cloud_provider_region: str
+    """
+    The region where your Virtual Private Cloud hosts are located.<br /><br />The
+    available regions can be found using the /virtual_cross_connect_regions
+    endpoint.
+    """
+
+    primary_cloud_account_id: str
+    """The identifier for your Virtual Private Cloud.
+
+    The number will be different based upon your Cloud provider.
+    """
+
+    region_code: str  # type: ignore
+    """The region interface is deployed to."""
+
+    bandwidth_mbps: Optional[float] = None
+    """
+    The desired throughput in Megabits per Second (Mbps) for your Virtual Cross
+    Connect.<br /><br />The available bandwidths can be found using the
+    /virtual_cross_connect_regions endpoint.
+    """
+
+    primary_bgp_key: Optional[str] = None
+    """The authentication key for BGP peer configuration."""
+
+    primary_cloud_ip: Optional[str] = None
+    """
+    The IP address assigned for your side of the Virtual Cross
+    Connect.<br /><br />If none is provided, one will be generated for
+    you.<br /><br />This value can not be patched once the VXC has bene provisioned.
+    """
+
+    primary_enabled: Optional[bool] = None
+    """Indicates whether the primary circuit is enabled.
+
+    Setting this to `false` will disable the circuit.
+    """
+
+    primary_routing_announcement: Optional[bool] = None
+    """Whether the primary BGP route is being announced."""
+
+    primary_telnyx_ip: Optional[str] = None
+    """
+    The IP address assigned to the Telnyx side of the Virtual Cross
+    Connect.<br /><br />If none is provided, one will be generated for
+    you.<br /><br />This value should be null for GCE as Google will only inform you
+    of your assigned IP once the connection has been accepted.
+    """
+
+    record_type: Optional[str] = None  # type: ignore
+    """Identifies the type of the resource."""
+
+    region: Optional[DataRegion] = None
+
+    secondary_bgp_key: Optional[str] = None
+    """The authentication key for BGP peer configuration."""
+
+    secondary_cloud_account_id: Optional[str] = None
+    """The identifier for your Virtual Private Cloud.
+
+    The number will be different based upon your Cloud provider.<br /><br />This
+    attribute is only necessary for GCE.
+    """
+
+    secondary_cloud_ip: Optional[str] = None
+    """
+    The IP address assigned for your side of the Virtual Cross
+    Connect.<br /><br />If none is provided, one will be generated for
+    you.<br /><br />This value can not be patched once the VXC has bene provisioned.
+    """
+
+    secondary_enabled: Optional[bool] = None
+    """Indicates whether the secondary circuit is enabled.
+
+    Setting this to `false` will disable the circuit.
+    """
+
+    secondary_routing_announcement: Optional[bool] = None
+    """Whether the secondary BGP route is being announced."""
+
+    secondary_telnyx_ip: Optional[str] = None
+    """
+    The IP address assigned to the Telnyx side of the Virtual Cross
+    Connect.<br /><br />If none is provided, one will be generated for
+    you.<br /><br />This value should be null for GCE as Google will only inform you
+    of your assigned IP once the connection has been accepted.
+    """
+
+
+class VirtualCrossConnectCreateResponse(BaseModel):
+    data: Optional[Data] = None

telnyx/types/virtual_cross_connect_delete_response.py

@@ -0,0 +1,129 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+from typing_extensions import Literal
+
+from .record import Record
+from .._models import BaseModel
+from .interface import Interface
+from .region_in import RegionIn
+
+__all__ = ["VirtualCrossConnectDeleteResponse", "Data", "DataRegion"]
+
+
+class DataRegion(BaseModel):
+    code: Optional[str] = None
+    """Region code of the interface."""
+
+    name: Optional[str] = None
+    """Region name of the interface."""
+
+    record_type: Optional[str] = None
+    """Identifies the type of the resource."""
+
+
+class Data(Record, Interface, RegionIn):
+    bgp_asn: float
+    """The Border Gateway Protocol (BGP) Autonomous System Number (ASN).
+
+    If null, value will be assigned by Telnyx.
+    """
+
+    cloud_provider: Literal["aws", "azure", "gce"]
+    """
+    The Virtual Private Cloud with which you would like to establish a cross
+    connect.
+    """
+
+    cloud_provider_region: str
+    """
+    The region where your Virtual Private Cloud hosts are located.<br /><br />The
+    available regions can be found using the /virtual_cross_connect_regions
+    endpoint.
+    """
+
+    primary_cloud_account_id: str
+    """The identifier for your Virtual Private Cloud.
+
+    The number will be different based upon your Cloud provider.
+    """
+
+    region_code: str  # type: ignore
+    """The region interface is deployed to."""
+
+    bandwidth_mbps: Optional[float] = None
+    """
+    The desired throughput in Megabits per Second (Mbps) for your Virtual Cross
+    Connect.<br /><br />The available bandwidths can be found using the
+    /virtual_cross_connect_regions endpoint.
+    """
+
+    primary_bgp_key: Optional[str] = None
+    """The authentication key for BGP peer configuration."""
+
+    primary_cloud_ip: Optional[str] = None
+    """
+    The IP address assigned for your side of the Virtual Cross
+    Connect.<br /><br />If none is provided, one will be generated for
+    you.<br /><br />This value can not be patched once the VXC has bene provisioned.
+    """
+
+    primary_enabled: Optional[bool] = None
+    """Indicates whether the primary circuit is enabled.
+
+    Setting this to `false` will disable the circuit.
+    """
+
+    primary_routing_announcement: Optional[bool] = None
+    """Whether the primary BGP route is being announced."""
+
+    primary_telnyx_ip: Optional[str] = None
+    """
+    The IP address assigned to the Telnyx side of the Virtual Cross
+    Connect.<br /><br />If none is provided, one will be generated for
+    you.<br /><br />This value should be null for GCE as Google will only inform you
+    of your assigned IP once the connection has been accepted.
+    """
+
+    record_type: Optional[str] = None  # type: ignore
+    """Identifies the type of the resource."""
+
+    region: Optional[DataRegion] = None
+
+    secondary_bgp_key: Optional[str] = None
+    """The authentication key for BGP peer configuration."""
+
+    secondary_cloud_account_id: Optional[str] = None
+    """The identifier for your Virtual Private Cloud.
+
+    The number will be different based upon your Cloud provider.<br /><br />This
+    attribute is only necessary for GCE.
+    """
+
+    secondary_cloud_ip: Optional[str] = None
+    """
+    The IP address assigned for your side of the Virtual Cross
+    Connect.<br /><br />If none is provided, one will be generated for
+    you.<br /><br />This value can not be patched once the VXC has bene provisioned.
+    """
+
+    secondary_enabled: Optional[bool] = None
+    """Indicates whether the secondary circuit is enabled.
+
+    Setting this to `false` will disable the circuit.
+    """
+
+    secondary_routing_announcement: Optional[bool] = None
+    """Whether the secondary BGP route is being announced."""
+
+    secondary_telnyx_ip: Optional[str] = None
+    """
+    The IP address assigned to the Telnyx side of the Virtual Cross
+    Connect.<br /><br />If none is provided, one will be generated for
+    you.<br /><br />This value should be null for GCE as Google will only inform you
+    of your assigned IP once the connection has been accepted.
+    """
+
+
+class VirtualCrossConnectDeleteResponse(BaseModel):
+    data: Optional[Data] = None

telnyx/types/virtual_cross_connect_list_params.py

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

telnyx/types/virtual_cross_connect_list_response.py

@@ -0,0 +1,132 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Optional
+from typing_extensions import Literal
+
+from .record import Record
+from .._models import BaseModel
+from .interface import Interface
+from .region_in import RegionIn
+from .pagination_meta import PaginationMeta
+
+__all__ = ["VirtualCrossConnectListResponse", "Data", "DataRegion"]
+
+
+class DataRegion(BaseModel):
+    code: Optional[str] = None
+    """Region code of the interface."""
+
+    name: Optional[str] = None
+    """Region name of the interface."""
+
+    record_type: Optional[str] = None
+    """Identifies the type of the resource."""
+
+
+class Data(Record, Interface, RegionIn):
+    bgp_asn: float
+    """The Border Gateway Protocol (BGP) Autonomous System Number (ASN).
+
+    If null, value will be assigned by Telnyx.
+    """
+
+    cloud_provider: Literal["aws", "azure", "gce"]
+    """
+    The Virtual Private Cloud with which you would like to establish a cross
+    connect.
+    """
+
+    cloud_provider_region: str
+    """
+    The region where your Virtual Private Cloud hosts are located.<br /><br />The
+    available regions can be found using the /virtual_cross_connect_regions
+    endpoint.
+    """
+
+    primary_cloud_account_id: str
+    """The identifier for your Virtual Private Cloud.
+
+    The number will be different based upon your Cloud provider.
+    """
+
+    region_code: str  # type: ignore
+    """The region interface is deployed to."""
+
+    bandwidth_mbps: Optional[float] = None
+    """
+    The desired throughput in Megabits per Second (Mbps) for your Virtual Cross
+    Connect.<br /><br />The available bandwidths can be found using the
+    /virtual_cross_connect_regions endpoint.
+    """
+
+    primary_bgp_key: Optional[str] = None
+    """The authentication key for BGP peer configuration."""
+
+    primary_cloud_ip: Optional[str] = None
+    """
+    The IP address assigned for your side of the Virtual Cross
+    Connect.<br /><br />If none is provided, one will be generated for
+    you.<br /><br />This value can not be patched once the VXC has bene provisioned.
+    """
+
+    primary_enabled: Optional[bool] = None
+    """Indicates whether the primary circuit is enabled.
+
+    Setting this to `false` will disable the circuit.
+    """
+
+    primary_routing_announcement: Optional[bool] = None
+    """Whether the primary BGP route is being announced."""
+
+    primary_telnyx_ip: Optional[str] = None
+    """
+    The IP address assigned to the Telnyx side of the Virtual Cross
+    Connect.<br /><br />If none is provided, one will be generated for
+    you.<br /><br />This value should be null for GCE as Google will only inform you
+    of your assigned IP once the connection has been accepted.
+    """
+
+    record_type: Optional[str] = None  # type: ignore
+    """Identifies the type of the resource."""
+
+    region: Optional[DataRegion] = None
+
+    secondary_bgp_key: Optional[str] = None
+    """The authentication key for BGP peer configuration."""
+
+    secondary_cloud_account_id: Optional[str] = None
+    """The identifier for your Virtual Private Cloud.
+
+    The number will be different based upon your Cloud provider.<br /><br />This
+    attribute is only necessary for GCE.
+    """
+
+    secondary_cloud_ip: Optional[str] = None
+    """
+    The IP address assigned for your side of the Virtual Cross
+    Connect.<br /><br />If none is provided, one will be generated for
+    you.<br /><br />This value can not be patched once the VXC has bene provisioned.
+    """
+
+    secondary_enabled: Optional[bool] = None
+    """Indicates whether the secondary circuit is enabled.
+
+    Setting this to `false` will disable the circuit.
+    """
+
+    secondary_routing_announcement: Optional[bool] = None
+    """Whether the secondary BGP route is being announced."""
+
+    secondary_telnyx_ip: Optional[str] = None
+    """
+    The IP address assigned to the Telnyx side of the Virtual Cross
+    Connect.<br /><br />If none is provided, one will be generated for
+    you.<br /><br />This value should be null for GCE as Google will only inform you
+    of your assigned IP once the connection has been accepted.
+    """
+
+
+class VirtualCrossConnectListResponse(BaseModel):
+    data: Optional[List[Data]] = None
+
+    meta: Optional[PaginationMeta] = None

telnyx/types/virtual_cross_connect_retrieve_response.py

@@ -0,0 +1,129 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+from typing_extensions import Literal
+
+from .record import Record
+from .._models import BaseModel
+from .interface import Interface
+from .region_in import RegionIn
+
+__all__ = ["VirtualCrossConnectRetrieveResponse", "Data", "DataRegion"]
+
+
+class DataRegion(BaseModel):
+    code: Optional[str] = None
+    """Region code of the interface."""
+
+    name: Optional[str] = None
+    """Region name of the interface."""
+
+    record_type: Optional[str] = None
+    """Identifies the type of the resource."""
+
+
+class Data(Record, Interface, RegionIn):
+    bgp_asn: float
+    """The Border Gateway Protocol (BGP) Autonomous System Number (ASN).
+
+    If null, value will be assigned by Telnyx.
+    """
+
+    cloud_provider: Literal["aws", "azure", "gce"]
+    """
+    The Virtual Private Cloud with which you would like to establish a cross
+    connect.
+    """
+
+    cloud_provider_region: str
+    """
+    The region where your Virtual Private Cloud hosts are located.<br /><br />The
+    available regions can be found using the /virtual_cross_connect_regions
+    endpoint.
+    """
+
+    primary_cloud_account_id: str
+    """The identifier for your Virtual Private Cloud.
+
+    The number will be different based upon your Cloud provider.
+    """
+
+    region_code: str  # type: ignore
+    """The region interface is deployed to."""
+
+    bandwidth_mbps: Optional[float] = None
+    """
+    The desired throughput in Megabits per Second (Mbps) for your Virtual Cross
+    Connect.<br /><br />The available bandwidths can be found using the
+    /virtual_cross_connect_regions endpoint.
+    """
+
+    primary_bgp_key: Optional[str] = None
+    """The authentication key for BGP peer configuration."""
+
+    primary_cloud_ip: Optional[str] = None
+    """
+    The IP address assigned for your side of the Virtual Cross
+    Connect.<br /><br />If none is provided, one will be generated for
+    you.<br /><br />This value can not be patched once the VXC has bene provisioned.
+    """
+
+    primary_enabled: Optional[bool] = None
+    """Indicates whether the primary circuit is enabled.
+
+    Setting this to `false` will disable the circuit.
+    """
+
+    primary_routing_announcement: Optional[bool] = None
+    """Whether the primary BGP route is being announced."""
+
+    primary_telnyx_ip: Optional[str] = None
+    """
+    The IP address assigned to the Telnyx side of the Virtual Cross
+    Connect.<br /><br />If none is provided, one will be generated for
+    you.<br /><br />This value should be null for GCE as Google will only inform you
+    of your assigned IP once the connection has been accepted.
+    """
+
+    record_type: Optional[str] = None  # type: ignore
+    """Identifies the type of the resource."""
+
+    region: Optional[DataRegion] = None
+
+    secondary_bgp_key: Optional[str] = None
+    """The authentication key for BGP peer configuration."""
+
+    secondary_cloud_account_id: Optional[str] = None
+    """The identifier for your Virtual Private Cloud.
+
+    The number will be different based upon your Cloud provider.<br /><br />This
+    attribute is only necessary for GCE.
+    """
+
+    secondary_cloud_ip: Optional[str] = None
+    """
+    The IP address assigned for your side of the Virtual Cross
+    Connect.<br /><br />If none is provided, one will be generated for
+    you.<br /><br />This value can not be patched once the VXC has bene provisioned.
+    """
+
+    secondary_enabled: Optional[bool] = None
+    """Indicates whether the secondary circuit is enabled.
+
+    Setting this to `false` will disable the circuit.
+    """
+
+    secondary_routing_announcement: Optional[bool] = None
+    """Whether the secondary BGP route is being announced."""
+
+    secondary_telnyx_ip: Optional[str] = None
+    """
+    The IP address assigned to the Telnyx side of the Virtual Cross
+    Connect.<br /><br />If none is provided, one will be generated for
+    you.<br /><br />This value should be null for GCE as Google will only inform you
+    of your assigned IP once the connection has been accepted.
+    """
+
+
+class VirtualCrossConnectRetrieveResponse(BaseModel):
+    data: Optional[Data] = None

telnyx/types/virtual_cross_connect_update_params.py

@@ -0,0 +1,41 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import TypedDict
+
+__all__ = ["VirtualCrossConnectUpdateParams"]
+
+
+class VirtualCrossConnectUpdateParams(TypedDict, total=False):
+    primary_cloud_ip: str
+    """
+    The IP address assigned for your side of the Virtual Cross
+    Connect.<br /><br />If none is provided, one will be generated for
+    you.<br /><br />This value can not be patched once the VXC has bene provisioned.
+    """
+
+    primary_enabled: bool
+    """Indicates whether the primary circuit is enabled.
+
+    Setting this to `false` will disable the circuit.
+    """
+
+    primary_routing_announcement: bool
+    """Whether the primary BGP route is being announced."""
+
+    secondary_cloud_ip: str
+    """
+    The IP address assigned for your side of the Virtual Cross
+    Connect.<br /><br />If none is provided, one will be generated for
+    you.<br /><br />This value can not be patched once the VXC has bene provisioned.
+    """
+
+    secondary_enabled: bool
+    """Indicates whether the secondary circuit is enabled.
+
+    Setting this to `false` will disable the circuit.
+    """
+
+    secondary_routing_announcement: bool
+    """Whether the secondary BGP route is being announced."""