telnyx 6.74.2 → 7.1.0

package/src/resources/uac-connections/uac-connections.ts

@@ -226,7 +226,7 @@ export interface UacConnection {
    * applied to outgoing audio. When set to 'both', it's applied in both directions.
    * When set to 'disabled', noise suppression is turned off.
    */
-  noise_suppression?: 'inbound' | 'outbound' | 'both' | 'disabled';
+  noise_suppression?: CredentialConnectionsAPI.ConnectionNoiseSuppression;
 
   /**
    * Configuration options for noise suppression. These settings are stored
@@ -456,6 +456,85 @@ export interface UacInbound {
   timeout_2xx_secs?: number;
 }
 
+/**
+ * Inbound settings that can be supplied when creating or updating a UAC
+ * connection. The SIP subdomain fields returned in UAC connection responses are
+ * generated by Telnyx and are not accepted as request parameters.
+ */
+export interface UacInboundRequest {
+  /**
+   * This setting allows you to set the format with which the caller's number (ANI)
+   * is sent for inbound phone calls.
+   */
+  ani_number_format?: '+E.164' | 'E.164' | '+E.164-national' | 'E.164-national';
+
+  /**
+   * When set, this will limit the total number of inbound calls to phone numbers
+   * associated with this connection.
+   */
+  channel_limit?: number;
+
+  /**
+   * Defines the list of codecs that Telnyx will send for inbound calls to a specific
+   * number on your portal account, in priority order. This only works when the
+   * Connection the number is assigned to uses Media Handling mode: default. OPUS and
+   * H.264 codecs are available only when using TCP or TLS transport for SIP.
+   */
+  codecs?: Array<string>;
+
+  /**
+   * Default routing method to be used when a number is associated with the
+   * connection. Must be one of the routing method types or left blank, other values
+   * are not allowed.
+   */
+  default_routing_method?: 'sequential' | 'round-robin';
+
+  dnis_number_format?: '+e164' | 'e164' | 'national' | 'sip_username';
+
+  /**
+   * Generate ringback tone through 183 session progress message with early media.
+   */
+  generate_ringback_tone?: boolean;
+
+  /**
+   * When set, inbound phone calls will receive ISUP parameters via SIP headers.
+   * (Only when available and only when using TCP or TLS transport.)
+   */
+  isup_headers_enabled?: boolean;
+
+  /**
+   * Enable PRACK messages as defined in RFC3262.
+   */
+  prack_enabled?: boolean;
+
+  /**
+   * When enabled the SIP Connection will receive the Identity header with
+   * Shaken/Stir data in the SIP INVITE message of inbound calls, even when using UDP
+   * transport.
+   */
+  shaken_stir_enabled?: boolean;
+
+  /**
+   * When enabled, allows multiple devices to ring simultaneously on incoming calls.
+   */
+  simultaneous_ringing?: 'disabled' | 'enabled';
+
+  /**
+   * Defaults to true.
+   */
+  sip_compact_headers_enabled?: boolean;
+
+  /**
+   * Time(sec) before aborting if connection is not made.
+   */
+  timeout_1xx_secs?: number;
+
+  /**
+   * Time(sec) before aborting if call is unanswered (min: 1, max: 600).
+   */
+  timeout_2xx_secs?: number;
+}
+
 /**
  * Internal Telnyx-side settings for a UAC connection.
  */
@@ -640,7 +719,7 @@ export interface UacConnectionCreateParams {
    * connection. The SIP subdomain fields returned in UAC connection responses are
    * generated by Telnyx and are not accepted as request parameters.
    */
-  inbound?: UacConnectionCreateParams.Inbound;
+  inbound?: UacInboundRequest;
 
   /**
    * Internal Telnyx-side settings for a UAC connection.
@@ -667,7 +746,7 @@ export interface UacConnectionCreateParams {
    * applied to outgoing audio. When set to 'both', it's applied in both directions.
    * When set to 'disabled', noise suppression is turned off.
    */
-  noise_suppression?: 'inbound' | 'outbound' | 'both' | 'disabled';
+  noise_suppression?: CredentialConnectionsAPI.ConnectionNoiseSuppression;
 
   /**
    * Configuration options for noise suppression. These settings are stored
@@ -739,87 +818,6 @@ export interface UacConnectionCreateParams {
   webhook_timeout_secs?: number | null;
 }
 
-export namespace UacConnectionCreateParams {
-  /**
-   * Inbound settings that can be supplied when creating or updating a UAC
-   * connection. The SIP subdomain fields returned in UAC connection responses are
-   * generated by Telnyx and are not accepted as request parameters.
-   */
-  export interface Inbound {
-    /**
-     * This setting allows you to set the format with which the caller's number (ANI)
-     * is sent for inbound phone calls.
-     */
-    ani_number_format?: '+E.164' | 'E.164' | '+E.164-national' | 'E.164-national';
-
-    /**
-     * When set, this will limit the total number of inbound calls to phone numbers
-     * associated with this connection.
-     */
-    channel_limit?: number;
-
-    /**
-     * Defines the list of codecs that Telnyx will send for inbound calls to a specific
-     * number on your portal account, in priority order. This only works when the
-     * Connection the number is assigned to uses Media Handling mode: default. OPUS and
-     * H.264 codecs are available only when using TCP or TLS transport for SIP.
-     */
-    codecs?: Array<string>;
-
-    /**
-     * Default routing method to be used when a number is associated with the
-     * connection. Must be one of the routing method types or left blank, other values
-     * are not allowed.
-     */
-    default_routing_method?: 'sequential' | 'round-robin';
-
-    dnis_number_format?: '+e164' | 'e164' | 'national' | 'sip_username';
-
-    /**
-     * Generate ringback tone through 183 session progress message with early media.
-     */
-    generate_ringback_tone?: boolean;
-
-    /**
-     * When set, inbound phone calls will receive ISUP parameters via SIP headers.
-     * (Only when available and only when using TCP or TLS transport.)
-     */
-    isup_headers_enabled?: boolean;
-
-    /**
-     * Enable PRACK messages as defined in RFC3262.
-     */
-    prack_enabled?: boolean;
-
-    /**
-     * When enabled the SIP Connection will receive the Identity header with
-     * Shaken/Stir data in the SIP INVITE message of inbound calls, even when using UDP
-     * transport.
-     */
-    shaken_stir_enabled?: boolean;
-
-    /**
-     * When enabled, allows multiple devices to ring simultaneously on incoming calls.
-     */
-    simultaneous_ringing?: 'disabled' | 'enabled';
-
-    /**
-     * Defaults to true.
-     */
-    sip_compact_headers_enabled?: boolean;
-
-    /**
-     * Time(sec) before aborting if connection is not made.
-     */
-    timeout_1xx_secs?: number;
-
-    /**
-     * Time(sec) before aborting if call is unanswered (min: 1, max: 600).
-     */
-    timeout_2xx_secs?: number;
-  }
-}
-
 export interface UacConnectionUpdateParams {
   /**
    * Defaults to true
@@ -884,7 +882,7 @@ export interface UacConnectionUpdateParams {
    * connection. The SIP subdomain fields returned in UAC connection responses are
    * generated by Telnyx and are not accepted as request parameters.
    */
-  inbound?: UacConnectionUpdateParams.Inbound;
+  inbound?: UacInboundRequest;
 
   /**
    * Internal Telnyx-side settings for a UAC connection.
@@ -911,7 +909,7 @@ export interface UacConnectionUpdateParams {
    * applied to outgoing audio. When set to 'both', it's applied in both directions.
    * When set to 'disabled', noise suppression is turned off.
    */
-  noise_suppression?: 'inbound' | 'outbound' | 'both' | 'disabled';
+  noise_suppression?: CredentialConnectionsAPI.ConnectionNoiseSuppression;
 
   /**
    * Configuration options for noise suppression. These settings are stored
@@ -981,87 +979,6 @@ export interface UacConnectionUpdateParams {
   webhook_timeout_secs?: number | null;
 }
 
-export namespace UacConnectionUpdateParams {
-  /**
-   * Inbound settings that can be supplied when creating or updating a UAC
-   * connection. The SIP subdomain fields returned in UAC connection responses are
-   * generated by Telnyx and are not accepted as request parameters.
-   */
-  export interface Inbound {
-    /**
-     * This setting allows you to set the format with which the caller's number (ANI)
-     * is sent for inbound phone calls.
-     */
-    ani_number_format?: '+E.164' | 'E.164' | '+E.164-national' | 'E.164-national';
-
-    /**
-     * When set, this will limit the total number of inbound calls to phone numbers
-     * associated with this connection.
-     */
-    channel_limit?: number;
-
-    /**
-     * Defines the list of codecs that Telnyx will send for inbound calls to a specific
-     * number on your portal account, in priority order. This only works when the
-     * Connection the number is assigned to uses Media Handling mode: default. OPUS and
-     * H.264 codecs are available only when using TCP or TLS transport for SIP.
-     */
-    codecs?: Array<string>;
-
-    /**
-     * Default routing method to be used when a number is associated with the
-     * connection. Must be one of the routing method types or left blank, other values
-     * are not allowed.
-     */
-    default_routing_method?: 'sequential' | 'round-robin';
-
-    dnis_number_format?: '+e164' | 'e164' | 'national' | 'sip_username';
-
-    /**
-     * Generate ringback tone through 183 session progress message with early media.
-     */
-    generate_ringback_tone?: boolean;
-
-    /**
-     * When set, inbound phone calls will receive ISUP parameters via SIP headers.
-     * (Only when available and only when using TCP or TLS transport.)
-     */
-    isup_headers_enabled?: boolean;
-
-    /**
-     * Enable PRACK messages as defined in RFC3262.
-     */
-    prack_enabled?: boolean;
-
-    /**
-     * When enabled the SIP Connection will receive the Identity header with
-     * Shaken/Stir data in the SIP INVITE message of inbound calls, even when using UDP
-     * transport.
-     */
-    shaken_stir_enabled?: boolean;
-
-    /**
-     * When enabled, allows multiple devices to ring simultaneously on incoming calls.
-     */
-    simultaneous_ringing?: 'disabled' | 'enabled';
-
-    /**
-     * Defaults to true.
-     */
-    sip_compact_headers_enabled?: boolean;
-
-    /**
-     * Time(sec) before aborting if connection is not made.
-     */
-    timeout_1xx_secs?: number;
-
-    /**
-     * Time(sec) before aborting if call is unanswered (min: 1, max: 600).
-     */
-    timeout_2xx_secs?: number;
-  }
-}
-
 export interface UacConnectionListParams extends DefaultFlatPaginationParams {
   /**
    * Consolidated filter parameter (deepObject style). Originally:
@@ -1135,6 +1052,7 @@ export declare namespace UacConnections {
     type UacConnection as UacConnection,
     type UacExternalSettings as UacExternalSettings,
     type UacInbound as UacInbound,
+    type UacInboundRequest as UacInboundRequest,
     type UacInternalSettings as UacInternalSettings,
     type UacOutbound as UacOutbound,
     type UacConnectionCreateResponse as UacConnectionCreateResponse,

package/src/resources/verifications/index.ts

@@ -4,6 +4,7 @@ export { Actions, type ActionVerifyParams } from './actions';
 export { ByPhoneNumber, type VerifyMeta, type ByPhoneNumberListResponse } from './by-phone-number/index';
 export {
   Verifications,
+  type CreateVerificationRequestSMS,
   type CreateVerificationResponse,
   type Verification,
   type VerificationRetrieveResponse,

package/src/resources/verifications/verifications.ts

@@ -111,6 +111,31 @@ export class Verifications extends APIResource {
   }
 }
 
+/**
+ * The request body when creating a verification.
+ */
+export interface CreateVerificationRequestSMS {
+  /**
+   * +E164 formatted phone number.
+   */
+  phone_number: string;
+
+  /**
+   * The identifier of the associated Verify profile.
+   */
+  verify_profile_id: string;
+
+  /**
+   * Send a self-generated numeric code to the end-user
+   */
+  custom_code?: string | null;
+
+  /**
+   * The number of seconds the verification code is valid for.
+   */
+  timeout_secs?: number;
+}
+
 export interface CreateVerificationResponse {
   data: Verification;
 }
@@ -258,6 +283,7 @@ Verifications.Actions = Actions;
 
 export declare namespace Verifications {
   export {
+    type CreateVerificationRequestSMS as CreateVerificationRequestSMS,
     type CreateVerificationResponse as CreateVerificationResponse,
     type Verification as Verification,
     type VerificationRetrieveResponse as VerificationRetrieveResponse,

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

@@ -1,6 +1,8 @@
 // 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';
@@ -115,6 +117,34 @@ export class VirtualCrossConnects extends APIResource {
 export type VirtualCrossConnectCombinedsDefaultFlatPagination =
   DefaultFlatPagination<VirtualCrossConnectCombined>;
 
+export interface RegionOut {
+  region?: RegionOut.Region;
+
+  /**
+   * The region interface is deployed to.
+   */
+  region_code?: string;
+}
+
+export namespace RegionOut {
+  export interface Region {
+    /**
+     * Region code of the interface.
+     */
+    code?: string;
+
+    /**
+     * Region name of the interface.
+     */
+    name?: string;
+
+    /**
+     * Identifies the type of the resource.
+     */
+    record_type?: string;
+  }
+}
+
 export interface VirtualCrossConnectCombined {
   /**
    * Identifies the resource.
@@ -230,6 +260,146 @@ export namespace VirtualCrossConnectCombined {
   }
 }
 
+export interface VirtualCrossConnectCreate
+  extends GlobalIPAssignmentsAPI.Record,
+    PublicInternetGatewaysAPI.NetworkInterface {
+  /**
+   * The region the interface should be deployed to.
+   */
+  region_code: 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.
+   */
+  bandwidth_mbps?: number;
+
+  /**
+   * The Border Gateway Protocol (BGP) Autonomous System Number (ASN). If null, value
+   * will be assigned by Telnyx.
+   */
+  bgp_asn?: number;
+
+  /**
+   * The Virtual Private Cloud with which you would like to establish a cross
+   * connect.
+   */
+  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.
+   */
+  cloud_provider_region?: 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.
+   */
+  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 should be null for GCE as Google will only inform you
+   * of your assigned IP once the connection has been accepted.
+   */
+  primary_cloud_ip?: string;
+
+  /**
+   * Indicates whether the primary circuit is enabled. Setting this to `false` will
+   * disable the circuit.
+   */
+  primary_enabled?: 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.
+   */
+  primary_telnyx_ip?: string;
+
+  /**
+   * 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.
+   */
+  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 should be null for GCE as Google will only inform you
+   * of your assigned IP once the connection has been accepted.
+   */
+  secondary_cloud_ip?: string;
+
+  /**
+   * Indicates whether the secondary circuit is enabled. Setting this to `false` will
+   * disable the circuit.
+   */
+  secondary_enabled?: 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 interface VirtualCrossConnectPatch {
+  /**
+   * 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. Setting this to `false` will
+   * disable the circuit.
+   */
+  primary_enabled?: boolean;
+
+  /**
+   * Whether the primary BGP route is being announced.
+   */
+  primary_routing_announcement?: boolean;
+
+  /**
+   * 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.
+   */
+  secondary_enabled?: boolean;
+
+  /**
+   * Whether the secondary BGP route is being announced.
+   */
+  secondary_routing_announcement?: boolean;
+}
+
 export interface VirtualCrossConnectCreateResponse {
   data?: VirtualCrossConnectCombined;
 }
@@ -403,7 +573,10 @@ export namespace VirtualCrossConnectListParams {
 
 export declare namespace VirtualCrossConnects {
   export {
+    type RegionOut as RegionOut,
     type VirtualCrossConnectCombined as VirtualCrossConnectCombined,
+    type VirtualCrossConnectCreate as VirtualCrossConnectCreate,
+    type VirtualCrossConnectPatch as VirtualCrossConnectPatch,
     type VirtualCrossConnectCreateResponse as VirtualCrossConnectCreateResponse,
     type VirtualCrossConnectRetrieveResponse as VirtualCrossConnectRetrieveResponse,
     type VirtualCrossConnectUpdateResponse as VirtualCrossConnectUpdateResponse,