telnyx 6.53.0 → 6.55.0

package/resources/virtual-cross-connects.d.ts

@@ -1,5 +1,6 @@
 import { APIResource } from "../core/resource.js";
-import * as NetworksAPI from "./networks/networks.js";
+import * as GlobalIPAssignmentsAPI from "./global-ip-assignments.js";
+import * as PublicInternetGatewaysAPI from "./public-internet-gateways.js";
 import { APIPromise } from "../core/api-promise.js";
 import { DefaultFlatPagination, type DefaultFlatPaginationParams, PagePromise } from "../core/pagination.js";
 import { RequestOptions } from "../internal/request-options.js";
@@ -84,18 +85,20 @@ export interface VirtualCrossConnectCreateResponse {
     data?: VirtualCrossConnectCreateResponse.Data;
 }
 export declare namespace VirtualCrossConnectCreateResponse {
-    interface Data {
+    interface Data extends GlobalIPAssignmentsAPI.Record, PublicInternetGatewaysAPI.NetworkInterface {
         /**
-         * Identifies the resource.
+         * The region interface is deployed to.
          */
-        id?: string;
+        region_code: string;
         /**
          * The desired throughput in Megabits per Second (Mbps) for your Virtual Cross
-         * Connect.
+         * Connect.<br /><br />The available bandwidths can be found using the
+         * /virtual_cross_connect_regions endpoint.
          */
         bandwidth_mbps?: number;
         /**
-         * The Border Gateway Protocol (BGP) Autonomous System Number (ASN).
+         * The Border Gateway Protocol (BGP) Autonomous System Number (ASN). If null, value
+         * will be assigned by Telnyx.
          */
         bgp_asn?: number;
         /**
@@ -104,62 +107,75 @@ export declare namespace VirtualCrossConnectCreateResponse {
          */
         cloud_provider?: 'aws' | 'azure' | 'gce';
         /**
-         * The region where your Virtual Private Cloud hosts are located.
+         * 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.
          */
         cloud_provider_region?: string;
-        /**
-         * ISO 8601 formatted date-time indicating when the resource was created.
-         */
-        created_at?: string;
-        /**
-         * A user specified name for the interface.
-         */
-        name?: string;
-        /**
-         * The id of the network associated with the interface.
-         */
-        network_id?: string;
         /**
          * The authentication key for BGP peer configuration.
          */
         primary_bgp_key?: string;
         /**
-         * The identifier for your Virtual Private Cloud.
+         * The identifier for your Virtual Private Cloud. The number will be different
+         * based upon your Cloud provider.
          */
         primary_cloud_account_id?: string;
         /**
-         * The IP address assigned for your side of the Virtual Cross Connect.
+         * 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_cloud_ip?: string;
         /**
-         * Indicates whether the primary circuit is enabled.
+         * Indicates whether the primary circuit is enabled. Setting this to `false` will
+         * disable the circuit.
          */
         primary_enabled?: boolean;
         /**
-         * Whether
+         * Whether the primary BGP route is being announced.
          */
         primary_routing_announcement?: boolean;
         /**
-         * The IP address assigned to the Telnyx side of the Virtual Cross Connect.
+         * 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.
          */
         primary_telnyx_ip?: string;
+        region?: Data.Region;
         /**
-         * Identifies the type of the resource.
+         * The authentication key for BGP peer configuration.
          */
-        record_type?: string;
-        region?: Data.Region;
+        secondary_bgp_key?: string;
         /**
-         * The region interface is deployed to.
+         * 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_account_id?: string;
+        /**
+         * 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.
          */
-        region_code?: string;
+        secondary_cloud_ip?: string;
         /**
-         * The current status of the interface deployment.
+         * Indicates whether the secondary circuit is enabled. Setting this to `false` will
+         * disable the circuit.
          */
-        status?: NetworksAPI.InterfaceStatus;
+        secondary_enabled?: boolean;
         /**
-         * ISO 8601 formatted date-time indicating when the resource was updated.
+         * Whether the secondary BGP route is being announced.
          */
-        updated_at?: string;
+        secondary_routing_announcement?: boolean;
+        /**
+         * 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_telnyx_ip?: string;
     }
     namespace Data {
         interface Region {
@@ -182,18 +198,20 @@ export interface VirtualCrossConnectRetrieveResponse {
     data?: VirtualCrossConnectRetrieveResponse.Data;
 }
 export declare namespace VirtualCrossConnectRetrieveResponse {
-    interface Data {
+    interface Data extends GlobalIPAssignmentsAPI.Record, PublicInternetGatewaysAPI.NetworkInterface {
         /**
-         * Identifies the resource.
+         * The region interface is deployed to.
          */
-        id?: string;
+        region_code: string;
         /**
          * The desired throughput in Megabits per Second (Mbps) for your Virtual Cross
-         * Connect.
+         * Connect.<br /><br />The available bandwidths can be found using the
+         * /virtual_cross_connect_regions endpoint.
          */
         bandwidth_mbps?: number;
         /**
-         * The Border Gateway Protocol (BGP) Autonomous System Number (ASN).
+         * The Border Gateway Protocol (BGP) Autonomous System Number (ASN). If null, value
+         * will be assigned by Telnyx.
          */
         bgp_asn?: number;
         /**
@@ -202,62 +220,75 @@ export declare namespace VirtualCrossConnectRetrieveResponse {
          */
         cloud_provider?: 'aws' | 'azure' | 'gce';
         /**
-         * The region where your Virtual Private Cloud hosts are located.
+         * 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.
          */
         cloud_provider_region?: string;
-        /**
-         * ISO 8601 formatted date-time indicating when the resource was created.
-         */
-        created_at?: string;
-        /**
-         * A user specified name for the interface.
-         */
-        name?: string;
-        /**
-         * The id of the network associated with the interface.
-         */
-        network_id?: string;
         /**
          * The authentication key for BGP peer configuration.
          */
         primary_bgp_key?: string;
         /**
-         * The identifier for your Virtual Private Cloud.
+         * The identifier for your Virtual Private Cloud. The number will be different
+         * based upon your Cloud provider.
          */
         primary_cloud_account_id?: string;
         /**
-         * The IP address assigned for your side of the Virtual Cross Connect.
+         * 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_cloud_ip?: string;
         /**
-         * Indicates whether the primary circuit is enabled.
+         * Indicates whether the primary circuit is enabled. Setting this to `false` will
+         * disable the circuit.
          */
         primary_enabled?: boolean;
         /**
-         * Whether
+         * Whether the primary BGP route is being announced.
          */
         primary_routing_announcement?: boolean;
         /**
-         * The IP address assigned to the Telnyx side of the Virtual Cross Connect.
+         * 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.
          */
         primary_telnyx_ip?: string;
+        region?: Data.Region;
         /**
-         * Identifies the type of the resource.
+         * The authentication key for BGP peer configuration.
          */
-        record_type?: string;
-        region?: Data.Region;
+        secondary_bgp_key?: string;
         /**
-         * The region interface is deployed to.
+         * 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.
          */
-        region_code?: string;
+        secondary_cloud_account_id?: string;
         /**
-         * The current status of the interface deployment.
+         * 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.
          */
-        status?: NetworksAPI.InterfaceStatus;
+        secondary_cloud_ip?: string;
         /**
-         * ISO 8601 formatted date-time indicating when the resource was updated.
+         * Indicates whether the secondary circuit is enabled. Setting this to `false` will
+         * disable the circuit.
          */
-        updated_at?: string;
+        secondary_enabled?: boolean;
+        /**
+         * Whether the secondary BGP route is being announced.
+         */
+        secondary_routing_announcement?: boolean;
+        /**
+         * 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_telnyx_ip?: string;
     }
     namespace Data {
         interface Region {
@@ -280,18 +311,20 @@ export interface VirtualCrossConnectUpdateResponse {
     data?: VirtualCrossConnectUpdateResponse.Data;
 }
 export declare namespace VirtualCrossConnectUpdateResponse {
-    interface Data {
+    interface Data extends GlobalIPAssignmentsAPI.Record, PublicInternetGatewaysAPI.NetworkInterface {
         /**
-         * Identifies the resource.
+         * The region interface is deployed to.
          */
-        id?: string;
+        region_code: string;
         /**
          * The desired throughput in Megabits per Second (Mbps) for your Virtual Cross
-         * Connect.
+         * Connect.<br /><br />The available bandwidths can be found using the
+         * /virtual_cross_connect_regions endpoint.
          */
         bandwidth_mbps?: number;
         /**
-         * The Border Gateway Protocol (BGP) Autonomous System Number (ASN).
+         * The Border Gateway Protocol (BGP) Autonomous System Number (ASN). If null, value
+         * will be assigned by Telnyx.
          */
         bgp_asn?: number;
         /**
@@ -300,62 +333,75 @@ export declare namespace VirtualCrossConnectUpdateResponse {
          */
         cloud_provider?: 'aws' | 'azure' | 'gce';
         /**
-         * The region where your Virtual Private Cloud hosts are located.
+         * 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.
          */
         cloud_provider_region?: string;
-        /**
-         * ISO 8601 formatted date-time indicating when the resource was created.
-         */
-        created_at?: string;
-        /**
-         * A user specified name for the interface.
-         */
-        name?: string;
-        /**
-         * The id of the network associated with the interface.
-         */
-        network_id?: string;
         /**
          * The authentication key for BGP peer configuration.
          */
         primary_bgp_key?: string;
         /**
-         * The identifier for your Virtual Private Cloud.
+         * The identifier for your Virtual Private Cloud. The number will be different
+         * based upon your Cloud provider.
          */
         primary_cloud_account_id?: string;
         /**
-         * The IP address assigned for your side of the Virtual Cross Connect.
+         * 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_cloud_ip?: string;
         /**
-         * Indicates whether the primary circuit is enabled.
+         * Indicates whether the primary circuit is enabled. Setting this to `false` will
+         * disable the circuit.
          */
         primary_enabled?: boolean;
         /**
-         * Whether
+         * Whether the primary BGP route is being announced.
          */
         primary_routing_announcement?: boolean;
         /**
-         * The IP address assigned to the Telnyx side of the Virtual Cross Connect.
+         * 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.
          */
         primary_telnyx_ip?: string;
+        region?: Data.Region;
         /**
-         * Identifies the type of the resource.
+         * The authentication key for BGP peer configuration.
          */
-        record_type?: string;
-        region?: Data.Region;
+        secondary_bgp_key?: string;
         /**
-         * The region interface is deployed to.
+         * 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_account_id?: string;
+        /**
+         * 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.
          */
-        region_code?: string;
+        secondary_cloud_ip?: string;
         /**
-         * The current status of the interface deployment.
+         * Indicates whether the secondary circuit is enabled. Setting this to `false` will
+         * disable the circuit.
          */
-        status?: NetworksAPI.InterfaceStatus;
+        secondary_enabled?: boolean;
         /**
-         * ISO 8601 formatted date-time indicating when the resource was updated.
+         * Whether the secondary BGP route is being announced.
          */
-        updated_at?: string;
+        secondary_routing_announcement?: boolean;
+        /**
+         * 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_telnyx_ip?: string;
     }
     namespace Data {
         interface Region {
@@ -374,18 +420,20 @@ export declare namespace VirtualCrossConnectUpdateResponse {
         }
     }
 }
-export interface VirtualCrossConnectListResponse {
+export interface VirtualCrossConnectListResponse extends GlobalIPAssignmentsAPI.Record, PublicInternetGatewaysAPI.NetworkInterface {
     /**
-     * Identifies the resource.
+     * The region interface is deployed to.
      */
-    id?: string;
+    region_code: string;
     /**
      * The desired throughput in Megabits per Second (Mbps) for your Virtual Cross
-     * Connect.
+     * Connect.<br /><br />The available bandwidths can be found using the
+     * /virtual_cross_connect_regions endpoint.
      */
     bandwidth_mbps?: number;
     /**
-     * The Border Gateway Protocol (BGP) Autonomous System Number (ASN).
+     * The Border Gateway Protocol (BGP) Autonomous System Number (ASN). If null, value
+     * will be assigned by Telnyx.
      */
     bgp_asn?: number;
     /**
@@ -394,62 +442,75 @@ export interface VirtualCrossConnectListResponse {
      */
     cloud_provider?: 'aws' | 'azure' | 'gce';
     /**
-     * The region where your Virtual Private Cloud hosts are located.
+     * 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.
      */
     cloud_provider_region?: string;
-    /**
-     * ISO 8601 formatted date-time indicating when the resource was created.
-     */
-    created_at?: string;
-    /**
-     * A user specified name for the interface.
-     */
-    name?: string;
-    /**
-     * The id of the network associated with the interface.
-     */
-    network_id?: string;
     /**
      * The authentication key for BGP peer configuration.
      */
     primary_bgp_key?: string;
     /**
-     * The identifier for your Virtual Private Cloud.
+     * The identifier for your Virtual Private Cloud. The number will be different
+     * based upon your Cloud provider.
      */
     primary_cloud_account_id?: string;
     /**
-     * The IP address assigned for your side of the Virtual Cross Connect.
+     * 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_cloud_ip?: string;
     /**
-     * Indicates whether the primary circuit is enabled.
+     * Indicates whether the primary circuit is enabled. Setting this to `false` will
+     * disable the circuit.
      */
     primary_enabled?: boolean;
     /**
-     * Whether
+     * Whether the primary BGP route is being announced.
      */
     primary_routing_announcement?: boolean;
     /**
-     * The IP address assigned to the Telnyx side of the Virtual Cross Connect.
+     * 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.
      */
     primary_telnyx_ip?: string;
+    region?: VirtualCrossConnectListResponse.Region;
     /**
-     * Identifies the type of the resource.
+     * The authentication key for BGP peer configuration.
      */
-    record_type?: string;
-    region?: VirtualCrossConnectListResponse.Region;
+    secondary_bgp_key?: string;
     /**
-     * The region interface is deployed to.
+     * 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.
      */
-    region_code?: string;
+    secondary_cloud_account_id?: string;
     /**
-     * The current status of the interface deployment.
+     * 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.
      */
-    status?: NetworksAPI.InterfaceStatus;
+    secondary_cloud_ip?: string;
     /**
-     * ISO 8601 formatted date-time indicating when the resource was updated.
+     * Indicates whether the secondary circuit is enabled. Setting this to `false` will
+     * disable the circuit.
      */
-    updated_at?: string;
+    secondary_enabled?: boolean;
+    /**
+     * Whether the secondary BGP route is being announced.
+     */
+    secondary_routing_announcement?: boolean;
+    /**
+     * 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_telnyx_ip?: string;
 }
 export declare namespace VirtualCrossConnectListResponse {
     interface Region {
@@ -471,18 +532,20 @@ export interface VirtualCrossConnectDeleteResponse {
     data?: VirtualCrossConnectDeleteResponse.Data;
 }
 export declare namespace VirtualCrossConnectDeleteResponse {
-    interface Data {
+    interface Data extends GlobalIPAssignmentsAPI.Record, PublicInternetGatewaysAPI.NetworkInterface {
         /**
-         * Identifies the resource.
+         * The region interface is deployed to.
          */
-        id?: string;
+        region_code: string;
         /**
          * The desired throughput in Megabits per Second (Mbps) for your Virtual Cross
-         * Connect.
+         * Connect.<br /><br />The available bandwidths can be found using the
+         * /virtual_cross_connect_regions endpoint.
          */
         bandwidth_mbps?: number;
         /**
-         * The Border Gateway Protocol (BGP) Autonomous System Number (ASN).
+         * The Border Gateway Protocol (BGP) Autonomous System Number (ASN). If null, value
+         * will be assigned by Telnyx.
          */
         bgp_asn?: number;
         /**
@@ -491,62 +554,75 @@ export declare namespace VirtualCrossConnectDeleteResponse {
          */
         cloud_provider?: 'aws' | 'azure' | 'gce';
         /**
-         * The region where your Virtual Private Cloud hosts are located.
+         * 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.
          */
         cloud_provider_region?: string;
-        /**
-         * ISO 8601 formatted date-time indicating when the resource was created.
-         */
-        created_at?: string;
-        /**
-         * A user specified name for the interface.
-         */
-        name?: string;
-        /**
-         * The id of the network associated with the interface.
-         */
-        network_id?: string;
         /**
          * The authentication key for BGP peer configuration.
          */
         primary_bgp_key?: string;
         /**
-         * The identifier for your Virtual Private Cloud.
+         * The identifier for your Virtual Private Cloud. The number will be different
+         * based upon your Cloud provider.
          */
         primary_cloud_account_id?: string;
         /**
-         * The IP address assigned for your side of the Virtual Cross Connect.
+         * 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_cloud_ip?: string;
         /**
-         * Indicates whether the primary circuit is enabled.
+         * Indicates whether the primary circuit is enabled. Setting this to `false` will
+         * disable the circuit.
          */
         primary_enabled?: boolean;
         /**
-         * Whether
+         * Whether the primary BGP route is being announced.
          */
         primary_routing_announcement?: boolean;
         /**
-         * The IP address assigned to the Telnyx side of the Virtual Cross Connect.
+         * 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.
          */
         primary_telnyx_ip?: string;
+        region?: Data.Region;
         /**
-         * Identifies the type of the resource.
+         * The authentication key for BGP peer configuration.
          */
-        record_type?: string;
-        region?: Data.Region;
+        secondary_bgp_key?: string;
         /**
-         * The region interface is deployed to.
+         * 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_account_id?: string;
+        /**
+         * 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_cloud_ip?: string;
+        /**
+         * Indicates whether the secondary circuit is enabled. Setting this to `false` will
+         * disable the circuit.
          */
-        region_code?: string;
+        secondary_enabled?: boolean;
         /**
-         * The current status of the interface deployment.
+         * Whether the secondary BGP route is being announced.
          */
-        status?: NetworksAPI.InterfaceStatus;
+        secondary_routing_announcement?: boolean;
         /**
-         * ISO 8601 formatted date-time indicating when the resource was updated.
+         * 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.
          */
-        updated_at?: string;
+        secondary_telnyx_ip?: string;
     }
     namespace Data {
         interface Region {