telnyx 6.52.0 → 6.53.0

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

@@ -1,8 +1,7 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { APIResource } from '../core/resource';
-import * as GlobalIPAssignmentsAPI from './global-ip-assignments';
-import * as PublicInternetGatewaysAPI from './public-internet-gateways';
+import * as NetworksAPI from './networks/networks';
 import { APIPromise } from '../core/api-promise';
 import { DefaultFlatPagination, type DefaultFlatPaginationParams, PagePromise } from '../core/pagination';
 import { RequestOptions } from '../internal/request-options';
@@ -121,22 +120,20 @@ export interface VirtualCrossConnectCreateResponse {
 }
 
 export namespace VirtualCrossConnectCreateResponse {
-  export interface Data extends GlobalIPAssignmentsAPI.Record, PublicInternetGatewaysAPI.NetworkInterface {
+  export interface Data {
     /**
-     * The region interface is deployed to.
+     * Identifies the resource.
      */
-    region_code: string;
+    id?: string;
 
     /**
      * 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.
+     * Connect.
      */
     bandwidth_mbps?: number;
 
     /**
-     * The Border Gateway Protocol (BGP) Autonomous System Number (ASN). If null, value
-     * will be assigned by Telnyx.
+     * The Border Gateway Protocol (BGP) Autonomous System Number (ASN).
      */
     bgp_asn?: number;
 
@@ -147,88 +144,76 @@ export namespace VirtualCrossConnectCreateResponse {
     cloud_provider?: 'aws' | 'azure' | 'gce';
 
     /**
-     * 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.
+     * The region where your Virtual Private Cloud hosts are located.
      */
     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 number will be different
-     * based upon your Cloud provider.
+     * The identifier for your Virtual Private Cloud.
      */
     primary_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.
+     * The IP address assigned for your side of the Virtual Cross Connect.
      */
     primary_cloud_ip?: string;
 
     /**
-     * Indicates whether the primary circuit is enabled. Setting this to `false` will
-     * disable the circuit.
+     * Indicates whether the primary circuit is enabled.
      */
     primary_enabled?: boolean;
 
     /**
-     * Whether the primary BGP route is being announced.
+     * Whether
      */
     primary_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.
+     * The IP address assigned to the Telnyx side of the Virtual Cross Connect.
      */
     primary_telnyx_ip?: string;
 
-    region?: Data.Region;
-
-    /**
-     * The authentication key for BGP peer configuration.
-     */
-    secondary_bgp_key?: string;
-
     /**
-     * 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.
+     * Identifies the type of the resource.
      */
-    secondary_cloud_account_id?: string;
+    record_type?: 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;
+    region?: Data.Region;
 
     /**
-     * Indicates whether the secondary circuit is enabled. Setting this to `false` will
-     * disable the circuit.
+     * The region interface is deployed to.
      */
-    secondary_enabled?: boolean;
+    region_code?: string;
 
     /**
-     * Whether the secondary BGP route is being announced.
+     * The current status of the interface deployment.
      */
-    secondary_routing_announcement?: boolean;
+    status?: NetworksAPI.InterfaceStatus;
 
     /**
-     * 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.
+     * ISO 8601 formatted date-time indicating when the resource was updated.
      */
-    secondary_telnyx_ip?: string;
+    updated_at?: string;
   }
 
   export namespace Data {
@@ -256,22 +241,20 @@ export interface VirtualCrossConnectRetrieveResponse {
 }
 
 export namespace VirtualCrossConnectRetrieveResponse {
-  export interface Data extends GlobalIPAssignmentsAPI.Record, PublicInternetGatewaysAPI.NetworkInterface {
+  export interface Data {
     /**
-     * The region interface is deployed to.
+     * Identifies the resource.
      */
-    region_code: string;
+    id?: string;
 
     /**
      * 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.
+     * Connect.
      */
     bandwidth_mbps?: number;
 
     /**
-     * The Border Gateway Protocol (BGP) Autonomous System Number (ASN). If null, value
-     * will be assigned by Telnyx.
+     * The Border Gateway Protocol (BGP) Autonomous System Number (ASN).
      */
     bgp_asn?: number;
 
@@ -282,88 +265,76 @@ export namespace VirtualCrossConnectRetrieveResponse {
     cloud_provider?: 'aws' | 'azure' | 'gce';
 
     /**
-     * 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.
+     * The region where your Virtual Private Cloud hosts are located.
      */
     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 number will be different
-     * based upon your Cloud provider.
+     * The identifier for your Virtual Private Cloud.
      */
     primary_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.
+     * The IP address assigned for your side of the Virtual Cross Connect.
      */
     primary_cloud_ip?: string;
 
     /**
-     * Indicates whether the primary circuit is enabled. Setting this to `false` will
-     * disable the circuit.
+     * Indicates whether the primary circuit is enabled.
      */
     primary_enabled?: boolean;
 
     /**
-     * Whether the primary BGP route is being announced.
+     * Whether
      */
     primary_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.
+     * The IP address assigned to the Telnyx side of the Virtual Cross Connect.
      */
     primary_telnyx_ip?: string;
 
-    region?: Data.Region;
-
-    /**
-     * The authentication key for BGP peer configuration.
-     */
-    secondary_bgp_key?: string;
-
     /**
-     * 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.
+     * Identifies the type of the resource.
      */
-    secondary_cloud_account_id?: string;
+    record_type?: 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;
+    region?: Data.Region;
 
     /**
-     * Indicates whether the secondary circuit is enabled. Setting this to `false` will
-     * disable the circuit.
+     * The region interface is deployed to.
      */
-    secondary_enabled?: boolean;
+    region_code?: string;
 
     /**
-     * Whether the secondary BGP route is being announced.
+     * The current status of the interface deployment.
      */
-    secondary_routing_announcement?: boolean;
+    status?: NetworksAPI.InterfaceStatus;
 
     /**
-     * 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.
+     * ISO 8601 formatted date-time indicating when the resource was updated.
      */
-    secondary_telnyx_ip?: string;
+    updated_at?: string;
   }
 
   export namespace Data {
@@ -391,22 +362,20 @@ export interface VirtualCrossConnectUpdateResponse {
 }
 
 export namespace VirtualCrossConnectUpdateResponse {
-  export interface Data extends GlobalIPAssignmentsAPI.Record, PublicInternetGatewaysAPI.NetworkInterface {
+  export interface Data {
     /**
-     * The region interface is deployed to.
+     * Identifies the resource.
      */
-    region_code: string;
+    id?: string;
 
     /**
      * 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.
+     * Connect.
      */
     bandwidth_mbps?: number;
 
     /**
-     * The Border Gateway Protocol (BGP) Autonomous System Number (ASN). If null, value
-     * will be assigned by Telnyx.
+     * The Border Gateway Protocol (BGP) Autonomous System Number (ASN).
      */
     bgp_asn?: number;
 
@@ -417,88 +386,76 @@ export namespace VirtualCrossConnectUpdateResponse {
     cloud_provider?: 'aws' | 'azure' | 'gce';
 
     /**
-     * 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.
+     * The region where your Virtual Private Cloud hosts are located.
      */
     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 number will be different
-     * based upon your Cloud provider.
+     * The identifier for your Virtual Private Cloud.
      */
     primary_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.
+     * The IP address assigned for your side of the Virtual Cross Connect.
      */
     primary_cloud_ip?: string;
 
     /**
-     * Indicates whether the primary circuit is enabled. Setting this to `false` will
-     * disable the circuit.
+     * Indicates whether the primary circuit is enabled.
      */
     primary_enabled?: boolean;
 
     /**
-     * Whether the primary BGP route is being announced.
+     * Whether
      */
     primary_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.
+     * The IP address assigned to the Telnyx side of the Virtual Cross Connect.
      */
     primary_telnyx_ip?: string;
 
-    region?: Data.Region;
-
-    /**
-     * The authentication key for BGP peer configuration.
-     */
-    secondary_bgp_key?: string;
-
     /**
-     * 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.
+     * Identifies the type of the resource.
      */
-    secondary_cloud_account_id?: string;
+    record_type?: 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;
+    region?: Data.Region;
 
     /**
-     * Indicates whether the secondary circuit is enabled. Setting this to `false` will
-     * disable the circuit.
+     * The region interface is deployed to.
      */
-    secondary_enabled?: boolean;
+    region_code?: string;
 
     /**
-     * Whether the secondary BGP route is being announced.
+     * The current status of the interface deployment.
      */
-    secondary_routing_announcement?: boolean;
+    status?: NetworksAPI.InterfaceStatus;
 
     /**
-     * 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.
+     * ISO 8601 formatted date-time indicating when the resource was updated.
      */
-    secondary_telnyx_ip?: string;
+    updated_at?: string;
   }
 
   export namespace Data {
@@ -521,24 +478,20 @@ export namespace VirtualCrossConnectUpdateResponse {
   }
 }
 
-export interface VirtualCrossConnectListResponse
-  extends GlobalIPAssignmentsAPI.Record,
-    PublicInternetGatewaysAPI.NetworkInterface {
+export interface VirtualCrossConnectListResponse {
   /**
-   * The region interface is deployed to.
+   * Identifies the resource.
    */
-  region_code: string;
+  id?: string;
 
   /**
    * 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.
+   * Connect.
    */
   bandwidth_mbps?: number;
 
   /**
-   * The Border Gateway Protocol (BGP) Autonomous System Number (ASN). If null, value
-   * will be assigned by Telnyx.
+   * The Border Gateway Protocol (BGP) Autonomous System Number (ASN).
    */
   bgp_asn?: number;
 
@@ -549,88 +502,76 @@ export interface VirtualCrossConnectListResponse
   cloud_provider?: 'aws' | 'azure' | 'gce';
 
   /**
-   * 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.
+   * The region where your Virtual Private Cloud hosts are located.
    */
   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 number will be different
-   * based upon your Cloud provider.
+   * The identifier for your Virtual Private Cloud.
    */
   primary_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.
+   * The IP address assigned for your side of the Virtual Cross Connect.
    */
   primary_cloud_ip?: string;
 
   /**
-   * Indicates whether the primary circuit is enabled. Setting this to `false` will
-   * disable the circuit.
+   * Indicates whether the primary circuit is enabled.
    */
   primary_enabled?: boolean;
 
   /**
-   * Whether the primary BGP route is being announced.
+   * Whether
    */
   primary_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.
+   * The IP address assigned to the Telnyx side of the Virtual Cross Connect.
    */
   primary_telnyx_ip?: string;
 
-  region?: VirtualCrossConnectListResponse.Region;
-
-  /**
-   * The authentication key for BGP peer configuration.
-   */
-  secondary_bgp_key?: string;
-
   /**
-   * 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.
+   * Identifies the type of the resource.
    */
-  secondary_cloud_account_id?: string;
+  record_type?: 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;
+  region?: VirtualCrossConnectListResponse.Region;
 
   /**
-   * Indicates whether the secondary circuit is enabled. Setting this to `false` will
-   * disable the circuit.
+   * The region interface is deployed to.
    */
-  secondary_enabled?: boolean;
+  region_code?: string;
 
   /**
-   * Whether the secondary BGP route is being announced.
+   * The current status of the interface deployment.
    */
-  secondary_routing_announcement?: boolean;
+  status?: NetworksAPI.InterfaceStatus;
 
   /**
-   * 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.
+   * ISO 8601 formatted date-time indicating when the resource was updated.
    */
-  secondary_telnyx_ip?: string;
+  updated_at?: string;
 }
 
 export namespace VirtualCrossConnectListResponse {
@@ -657,22 +598,20 @@ export interface VirtualCrossConnectDeleteResponse {
 }
 
 export namespace VirtualCrossConnectDeleteResponse {
-  export interface Data extends GlobalIPAssignmentsAPI.Record, PublicInternetGatewaysAPI.NetworkInterface {
+  export interface Data {
     /**
-     * The region interface is deployed to.
+     * Identifies the resource.
      */
-    region_code: string;
+    id?: string;
 
     /**
      * 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.
+     * Connect.
      */
     bandwidth_mbps?: number;
 
     /**
-     * The Border Gateway Protocol (BGP) Autonomous System Number (ASN). If null, value
-     * will be assigned by Telnyx.
+     * The Border Gateway Protocol (BGP) Autonomous System Number (ASN).
      */
     bgp_asn?: number;
 
@@ -683,88 +622,76 @@ export namespace VirtualCrossConnectDeleteResponse {
     cloud_provider?: 'aws' | 'azure' | 'gce';
 
     /**
-     * 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.
+     * The region where your Virtual Private Cloud hosts are located.
      */
     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 number will be different
-     * based upon your Cloud provider.
+     * The identifier for your Virtual Private Cloud.
      */
     primary_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.
+     * The IP address assigned for your side of the Virtual Cross Connect.
      */
     primary_cloud_ip?: string;
 
     /**
-     * Indicates whether the primary circuit is enabled. Setting this to `false` will
-     * disable the circuit.
+     * Indicates whether the primary circuit is enabled.
      */
     primary_enabled?: boolean;
 
     /**
-     * Whether the primary BGP route is being announced.
+     * Whether
      */
     primary_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.
+     * The IP address assigned to the Telnyx side of the Virtual Cross Connect.
      */
     primary_telnyx_ip?: string;
 
-    region?: Data.Region;
-
     /**
-     * The authentication key for BGP peer configuration.
-     */
-    secondary_bgp_key?: string;
-
-    /**
-     * 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.
+     * Identifies the type of the resource.
      */
-    secondary_cloud_account_id?: string;
+    record_type?: 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;
+    region?: Data.Region;
 
     /**
-     * Indicates whether the secondary circuit is enabled. Setting this to `false` will
-     * disable the circuit.
+     * The region interface is deployed to.
      */
-    secondary_enabled?: boolean;
+    region_code?: string;
 
     /**
-     * Whether the secondary BGP route is being announced.
+     * The current status of the interface deployment.
      */
-    secondary_routing_announcement?: boolean;
+    status?: NetworksAPI.InterfaceStatus;
 
     /**
-     * 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.
+     * ISO 8601 formatted date-time indicating when the resource was updated.
      */
-    secondary_telnyx_ip?: string;
+    updated_at?: string;
   }
 
   export namespace Data {