telnyx 6.53.0 → 6.55.0

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

@@ -1,7 +1,8 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { APIResource } from '../core/resource';
-import * as NetworksAPI from './networks/networks';
+import * as GlobalIPAssignmentsAPI from './global-ip-assignments';
+import * as PublicInternetGatewaysAPI from './public-internet-gateways';
 import { APIPromise } from '../core/api-promise';
 import { DefaultFlatPagination, type DefaultFlatPaginationParams, PagePromise } from '../core/pagination';
 import { RequestOptions } from '../internal/request-options';
@@ -120,20 +121,22 @@ export interface VirtualCrossConnectCreateResponse {
 }
 
 export namespace VirtualCrossConnectCreateResponse {
-  export interface Data {
+  export 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;
 
@@ -144,76 +147,88 @@ export 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;
+    secondary_bgp_key?: string;
 
-    region?: Data.Region;
+    /**
+     * 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 region interface is deployed to.
+     * 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;
   }
 
   export namespace Data {
@@ -241,20 +256,22 @@ export interface VirtualCrossConnectRetrieveResponse {
 }
 
 export namespace VirtualCrossConnectRetrieveResponse {
-  export interface Data {
+  export 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;
 
@@ -265,76 +282,88 @@ export 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;
+    secondary_bgp_key?: string;
 
-    region?: Data.Region;
+    /**
+     * 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 region interface is deployed to.
+     * 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;
   }
 
   export namespace Data {
@@ -362,20 +391,22 @@ export interface VirtualCrossConnectUpdateResponse {
 }
 
 export namespace VirtualCrossConnectUpdateResponse {
-  export interface Data {
+  export 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;
 
@@ -386,76 +417,88 @@ export 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;
+    secondary_bgp_key?: string;
 
-    region?: Data.Region;
+    /**
+     * 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 region interface is deployed to.
+     * 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;
   }
 
   export namespace Data {
@@ -478,20 +521,24 @@ export 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;
 
@@ -502,76 +549,88 @@ 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;
+  secondary_bgp_key?: string;
 
-  region?: VirtualCrossConnectListResponse.Region;
+  /**
+   * 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 region interface is deployed to.
+   * 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;
 }
 
 export namespace VirtualCrossConnectListResponse {
@@ -598,20 +657,22 @@ export interface VirtualCrossConnectDeleteResponse {
 }
 
 export namespace VirtualCrossConnectDeleteResponse {
-  export interface Data {
+  export 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;
 
@@ -622,76 +683,88 @@ export 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;
+    secondary_bgp_key?: string;
 
-    region?: Data.Region;
+    /**
+     * 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 region interface is deployed to.
+     * 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;
   }
 
   export namespace Data {