telnyx 6.65.0 → 6.66.0

package/src/resources/calls/calls.ts

@@ -99,11 +99,13 @@ import {
   TelnyxVoiceSettings,
   TranscriptionConfig,
   TranscriptionEngineAConfig,
+  TranscriptionEngineAssemblyaiConfig,
   TranscriptionEngineAzureConfig,
   TranscriptionEngineBConfig,
   TranscriptionEngineDeepgramConfig,
   TranscriptionEngineGoogleConfig,
   TranscriptionEngineTelnyxConfig,
+  TranscriptionEngineXaiConfig,
   TranscriptionStartRequest,
 } from './actions';
 import * as AssistantsAPI from '../ai/assistants/assistants';
@@ -1210,11 +1212,13 @@ export declare namespace Calls {
     type TelnyxVoiceSettings as TelnyxVoiceSettings,
     type TranscriptionConfig as TranscriptionConfig,
     type TranscriptionEngineAConfig as TranscriptionEngineAConfig,
+    type TranscriptionEngineAssemblyaiConfig as TranscriptionEngineAssemblyaiConfig,
     type TranscriptionEngineAzureConfig as TranscriptionEngineAzureConfig,
     type TranscriptionEngineBConfig as TranscriptionEngineBConfig,
     type TranscriptionEngineDeepgramConfig as TranscriptionEngineDeepgramConfig,
     type TranscriptionEngineGoogleConfig as TranscriptionEngineGoogleConfig,
     type TranscriptionEngineTelnyxConfig as TranscriptionEngineTelnyxConfig,
+    type TranscriptionEngineXaiConfig as TranscriptionEngineXaiConfig,
     type TranscriptionStartRequest as TranscriptionStartRequest,
     type ActionAddAIAssistantMessagesResponse as ActionAddAIAssistantMessagesResponse,
     type ActionAnswerResponse as ActionAnswerResponse,

package/src/resources/calls/index.ts

@@ -16,11 +16,13 @@ export {
   type TelnyxVoiceSettings,
   type TranscriptionConfig,
   type TranscriptionEngineAConfig,
+  type TranscriptionEngineAssemblyaiConfig,
   type TranscriptionEngineAzureConfig,
   type TranscriptionEngineBConfig,
   type TranscriptionEngineDeepgramConfig,
   type TranscriptionEngineGoogleConfig,
   type TranscriptionEngineTelnyxConfig,
+  type TranscriptionEngineXaiConfig,
   type TranscriptionStartRequest,
   type ActionAddAIAssistantMessagesResponse,
   type ActionAnswerResponse,

package/src/resources/conferences/actions.ts

@@ -1020,7 +1020,7 @@ export interface ActionSpeakParams {
     | Shared.RimeVoiceSettings
     | Shared.ResembleVoiceSettings
     | ActionSpeakParams.InworldVoiceSettings
-    | ActionSpeakParams.XaiVoiceSettings;
+    | Shared.XaiVoiceSettings;
 }
 
 export namespace ActionSpeakParams {
@@ -1030,18 +1030,6 @@ export namespace ActionSpeakParams {
      */
     type: 'inworld';
   }
-
-  export interface XaiVoiceSettings {
-    /**
-     * Voice settings provider type
-     */
-    type: 'xai';
-
-    /**
-     * Language code, or `auto` to detect automatically.
-     */
-    language?: string;
-  }
 }
 
 export interface ActionStopParams {

package/src/resources/faxes/faxes.ts

@@ -21,6 +21,18 @@ export class Faxes extends APIResource {
    * is bigger than 50MB or has more than 350 pages it will fail with
    * `file_size_limit_exceeded` and `page_count_limit_exceeded` respectively.
    *
+   * **Supported file formats:**
+   *
+   * - PDF (`application/pdf`)
+   * - TIFF (`application/tiff`, `image/tiff`)
+   * - JPEG (`image/jpeg`)
+   * - PNG (`image/png`)
+   * - Microsoft Word `.doc` (`application/msword`)
+   * - Microsoft Word `.docx`
+   *   (`application/vnd.openxmlformats-officedocument.wordprocessingml.document`)
+   * - Rich Text Format `.rtf` (`application/rtf`)
+   * - Plain text `.txt` (`text/plain`)
+   *
    * **Expected Webhooks:**
    *
    * - `fax.queued`
@@ -133,14 +145,16 @@ export interface Fax {
 
   /**
    * The media_name used for the fax's media. Must point to a file previously
-   * uploaded to api.telnyx.com/v2/media by the same user/organization. media_name
-   * and media_url/contents can't be submitted together.
+   * uploaded to api.telnyx.com/v2/media by the same user/organization. Supported
+   * formats: PDF, TIFF, JPEG, PNG, DOC, DOCX, RTF, and TXT. media_name and
+   * media_url/contents can't be submitted together.
    */
   media_name?: string;
 
   /**
-   * The URL (or list of URLs) to the PDF used for the fax's media. media_url and
-   * media_name/contents can't be submitted together.
+   * The URL (or list of URLs) to the fax document. Supported formats: PDF, TIFF,
+   * JPEG, PNG, DOC, DOCX, RTF, and TXT. media_url and media_name/contents can't be
+   * submitted together.
    */
   media_url?: string;
 
@@ -257,14 +271,16 @@ export interface FaxCreateParams {
 
   /**
    * The media_name used for the fax's media. Must point to a file previously
-   * uploaded to api.telnyx.com/v2/media by the same user/organization. media_name
-   * and media_url/contents can't be submitted together.
+   * uploaded to api.telnyx.com/v2/media by the same user/organization. Supported
+   * formats: PDF, TIFF, JPEG, PNG, DOC, DOCX, RTF, and TXT. media_name and
+   * media_url/contents can't be submitted together.
    */
   media_name?: string;
 
   /**
-   * The URL (or list of URLs) to the PDF used for the fax's media. media_url and
-   * media_name/contents can't be submitted together.
+   * The URL (or list of URLs) to the fax document. Supported formats: PDF, TIFF,
+   * JPEG, PNG, DOC, DOCX, RTF, and TXT. media_url and media_name/contents can't be
+   * submitted together.
    */
   media_url?: string;
 

package/src/resources/index.ts

@@ -3,6 +3,7 @@
 export * from './shared';
 export {
   AI,
+  type ModelMetadata,
   type AICreateResponseResponse,
   type AIRetrieveModelsResponse,
   type AISummarizeResponse,
@@ -968,13 +969,13 @@ export {
   PublicInternetGateways,
   type NetworkInterface,
   type NetworkInterfaceRegion,
+  type PublicInternetGatewayRead,
   type PublicInternetGatewayCreateResponse,
   type PublicInternetGatewayRetrieveResponse,
-  type PublicInternetGatewayListResponse,
   type PublicInternetGatewayDeleteResponse,
   type PublicInternetGatewayCreateParams,
   type PublicInternetGatewayListParams,
-  type PublicInternetGatewayListResponsesDefaultFlatPagination,
+  type PublicInternetGatewayReadsDefaultFlatPagination,
 } from './public-internet-gateways';
 export {
   Queues,
@@ -1251,15 +1252,19 @@ export {
 } from './traffic-policy-profiles';
 export {
   UacConnections,
+  type UacConnection,
+  type UacExternalSettings,
+  type UacInbound,
+  type UacInternalSettings,
+  type UacOutbound,
   type UacConnectionCreateResponse,
   type UacConnectionRetrieveResponse,
   type UacConnectionUpdateResponse,
-  type UacConnectionListResponse,
   type UacConnectionDeleteResponse,
   type UacConnectionCreateParams,
   type UacConnectionUpdateParams,
   type UacConnectionListParams,
-  type UacConnectionListResponsesDefaultFlatPagination,
+  type UacConnectionsDefaultFlatPagination,
 } from './uac-connections/uac-connections';
 export {
   UsageReports,
@@ -1314,15 +1319,15 @@ export {
 } from './verify-profiles';
 export {
   VirtualCrossConnects,
+  type VirtualCrossConnectCombined,
   type VirtualCrossConnectCreateResponse,
   type VirtualCrossConnectRetrieveResponse,
   type VirtualCrossConnectUpdateResponse,
-  type VirtualCrossConnectListResponse,
   type VirtualCrossConnectDeleteResponse,
   type VirtualCrossConnectCreateParams,
   type VirtualCrossConnectUpdateParams,
   type VirtualCrossConnectListParams,
-  type VirtualCrossConnectListResponsesDefaultFlatPagination,
+  type VirtualCrossConnectCombinedsDefaultFlatPagination,
 } from './virtual-cross-connects';
 export {
   VirtualCrossConnectsCoverage,
@@ -1503,13 +1508,13 @@ export {
 } from './whatsapp-message-templates';
 export {
   WireguardInterfaces,
+  type WireguardInterfaceRead,
   type WireguardInterfaceCreateResponse,
   type WireguardInterfaceRetrieveResponse,
-  type WireguardInterfaceListResponse,
   type WireguardInterfaceDeleteResponse,
   type WireguardInterfaceCreateParams,
   type WireguardInterfaceListParams,
-  type WireguardInterfaceListResponsesDefaultFlatPagination,
+  type WireguardInterfaceReadsDefaultFlatPagination,
 } from './wireguard-interfaces';
 export {
   WireguardPeers,

package/src/resources/networks/networks.ts

@@ -2,7 +2,6 @@
 
 import { APIResource } from '../../core/resource';
 import * as GlobalIPAssignmentsAPI from '../global-ip-assignments';
-import * as PublicInternetGatewaysAPI from '../public-internet-gateways';
 import * as DefaultGatewayAPI from './default-gateway';
 import {
   DefaultGateway,
@@ -206,9 +205,27 @@ export namespace NetworkDeleteResponse {
   }
 }
 
-export interface NetworkListInterfacesResponse
-  extends GlobalIPAssignmentsAPI.Record,
-    PublicInternetGatewaysAPI.NetworkInterface {
+export interface NetworkListInterfacesResponse {
+  /**
+   * Identifies the resource.
+   */
+  id?: 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;
+
   /**
    * Identifies the type of the resource.
    */
@@ -221,10 +238,20 @@ export interface NetworkListInterfacesResponse
    */
   region_code?: string;
 
+  /**
+   * The current status of the interface deployment.
+   */
+  status?: InterfaceStatus;
+
   /**
    * Identifies the type of the interface.
    */
   type?: string;
+
+  /**
+   * ISO 8601 formatted date-time indicating when the resource was updated.
+   */
+  updated_at?: string;
 }
 
 export namespace NetworkListInterfacesResponse {

package/src/resources/public-internet-gateways.ts

@@ -1,8 +1,6 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { APIResource } from '../core/resource';
-import * as PublicInternetGatewaysAPI from './public-internet-gateways';
-import * as GlobalIPAssignmentsAPI from './global-ip-assignments';
 import * as NetworksAPI from './networks/networks';
 import { APIPromise } from '../core/api-promise';
 import { DefaultFlatPagination, type DefaultFlatPaginationParams, PagePromise } from '../core/pagination';
@@ -50,7 +48,7 @@ export class PublicInternetGateways extends APIResource {
    * @example
    * ```ts
    * // Automatically fetches more pages as needed.
-   * for await (const publicInternetGatewayListResponse of client.publicInternetGateways.list()) {
+   * for await (const publicInternetGatewayRead of client.publicInternetGateways.list()) {
    *   // ...
    * }
    * ```
@@ -58,10 +56,10 @@ export class PublicInternetGateways extends APIResource {
   list(
     query: PublicInternetGatewayListParams | null | undefined = {},
     options?: RequestOptions,
-  ): PagePromise<PublicInternetGatewayListResponsesDefaultFlatPagination, PublicInternetGatewayListResponse> {
+  ): PagePromise<PublicInternetGatewayReadsDefaultFlatPagination, PublicInternetGatewayRead> {
     return this._client.getAPIList(
       '/public_internet_gateways',
-      DefaultFlatPagination<PublicInternetGatewayListResponse>,
+      DefaultFlatPagination<PublicInternetGatewayRead>,
       { query, ...options },
     );
   }
@@ -82,8 +80,8 @@ export class PublicInternetGateways extends APIResource {
   }
 }
 
-export type PublicInternetGatewayListResponsesDefaultFlatPagination =
-  DefaultFlatPagination<PublicInternetGatewayListResponse>;
+export type PublicInternetGatewayReadsDefaultFlatPagination =
+  DefaultFlatPagination<PublicInternetGatewayRead>;
 
 export interface NetworkInterface {
   /**
@@ -109,70 +107,63 @@ export interface NetworkInterfaceRegion {
   region_code?: string;
 }
 
-export interface PublicInternetGatewayCreateResponse {
-  data?: PublicInternetGatewayCreateResponse.Data;
-}
-
-export namespace PublicInternetGatewayCreateResponse {
-  export interface Data extends GlobalIPAssignmentsAPI.Record, PublicInternetGatewaysAPI.NetworkInterface {
-    /**
-     * The publically accessible ip for this interface.
-     */
-    public_ip?: string;
-
-    /**
-     * The region interface is deployed to.
-     */
-    region_code?: string;
-  }
-}
+export interface PublicInternetGatewayRead {
+  /**
+   * Identifies the resource.
+   */
+  id?: string;
 
-export interface PublicInternetGatewayRetrieveResponse {
-  data?: PublicInternetGatewayRetrieveResponse.Data;
-}
+  /**
+   * ISO 8601 formatted date-time indicating when the resource was created.
+   */
+  created_at?: string;
 
-export namespace PublicInternetGatewayRetrieveResponse {
-  export interface Data extends GlobalIPAssignmentsAPI.Record, PublicInternetGatewaysAPI.NetworkInterface {
-    /**
-     * The publically accessible ip for this interface.
-     */
-    public_ip?: string;
+  /**
+   * A user specified name for the interface.
+   */
+  name?: string;
 
-    /**
-     * The region interface is deployed to.
-     */
-    region_code?: string;
-  }
-}
+  /**
+   * The id of the network associated with the interface.
+   */
+  network_id?: string;
 
-export interface PublicInternetGatewayListResponse extends GlobalIPAssignmentsAPI.Record, NetworkInterface {
   /**
    * The publically accessible ip for this interface.
    */
   public_ip?: string;
 
+  /**
+   * Identifies the type of the resource.
+   */
+  record_type?: string;
+
   /**
    * The region interface is deployed to.
    */
   region_code?: string;
+
+  /**
+   * The current status of the interface deployment.
+   */
+  status?: NetworksAPI.InterfaceStatus;
+
+  /**
+   * ISO 8601 formatted date-time indicating when the resource was updated.
+   */
+  updated_at?: string;
 }
 
-export interface PublicInternetGatewayDeleteResponse {
-  data?: PublicInternetGatewayDeleteResponse.Data;
+export interface PublicInternetGatewayCreateResponse {
+  data?: PublicInternetGatewayRead;
 }
 
-export namespace PublicInternetGatewayDeleteResponse {
-  export interface Data extends GlobalIPAssignmentsAPI.Record, PublicInternetGatewaysAPI.NetworkInterface {
-    /**
-     * The publically accessible ip for this interface.
-     */
-    public_ip?: string;
+export interface PublicInternetGatewayRetrieveResponse {
+  data?: PublicInternetGatewayRead;
+}
 
-    /**
-     * The region interface is deployed to.
-     */
-    region_code?: string;
-  }
+export interface PublicInternetGatewayDeleteResponse {
+  data?: PublicInternetGatewayRead;
 }
 
 export interface PublicInternetGatewayCreateParams {
@@ -215,11 +206,11 @@ export declare namespace PublicInternetGateways {
   export {
     type NetworkInterface as NetworkInterface,
     type NetworkInterfaceRegion as NetworkInterfaceRegion,
+    type PublicInternetGatewayRead as PublicInternetGatewayRead,
     type PublicInternetGatewayCreateResponse as PublicInternetGatewayCreateResponse,
     type PublicInternetGatewayRetrieveResponse as PublicInternetGatewayRetrieveResponse,
-    type PublicInternetGatewayListResponse as PublicInternetGatewayListResponse,
     type PublicInternetGatewayDeleteResponse as PublicInternetGatewayDeleteResponse,
-    type PublicInternetGatewayListResponsesDefaultFlatPagination as PublicInternetGatewayListResponsesDefaultFlatPagination,
+    type PublicInternetGatewayReadsDefaultFlatPagination as PublicInternetGatewayReadsDefaultFlatPagination,
     type PublicInternetGatewayCreateParams as PublicInternetGatewayCreateParams,
     type PublicInternetGatewayListParams as PublicInternetGatewayListParams,
   };

package/src/resources/shared.ts

@@ -1423,6 +1423,18 @@ export namespace WhatsappTemplateData {
   }
 }
 
+export interface XaiVoiceSettings {
+  /**
+   * Voice settings provider type
+   */
+  type: 'xai';
+
+  /**
+   * Language code, or `auto` to detect automatically.
+   */
+  language?: string;
+}
+
 export type MessagingHostedNumberOrdersDefaultFlatPagination =
   DefaultFlatPagination<MessagingHostedNumberOrder>;
 

package/src/resources/texml/accounts/calls/calls.ts

@@ -754,9 +754,11 @@ export namespace CallCallsParams {
     DeepfakeDetectionCallbackUrl?: string;
 
     /**
-     * Allows you to chose between Premium and Standard detections.
+     * Allows you to choose between Regular, Premium, and PremiumCallScreening
+     * detections. See
+     * https://developers.telnyx.com/docs/voice/programmable-voice/answering-machine-detection
      */
-    DetectionMode?: 'Premium' | 'Regular';
+    DetectionMode?: 'Premium' | 'Regular' | 'PremiumCallScreening';
 
     /**
      * A failover URL for which Telnyx will retrieve the TeXML call instructions if the
@@ -775,6 +777,12 @@ export namespace CallCallsParams {
      */
     MachineDetection?: 'Enable' | 'Disable' | 'DetectMessageEnd';
 
+    /**
+     * Silence duration threshold after a call screening prompt before ending prompt
+     * detection, in milliseconds. Used when `DetectionMode` is `PremiumCallScreening`.
+     */
+    MachineDetectionPromptEndTimeout?: number;
+
     /**
      * If initial silence duration is greater than this value, consider it a machine.
      * Ignored when `premium` detection is used.
@@ -1022,9 +1030,11 @@ export namespace CallCallsParams {
     DeepfakeDetectionCallbackUrl?: string;
 
     /**
-     * Allows you to chose between Premium and Standard detections.
+     * Allows you to choose between Regular, Premium, and PremiumCallScreening
+     * detections. See
+     * https://developers.telnyx.com/docs/voice/programmable-voice/answering-machine-detection
      */
-    DetectionMode?: 'Premium' | 'Regular';
+    DetectionMode?: 'Premium' | 'Regular' | 'PremiumCallScreening';
 
     /**
      * A failover URL for which Telnyx will retrieve the TeXML call instructions if the
@@ -1043,6 +1053,12 @@ export namespace CallCallsParams {
      */
     MachineDetection?: 'Enable' | 'Disable' | 'DetectMessageEnd';
 
+    /**
+     * Silence duration threshold after a call screening prompt before ending prompt
+     * detection, in milliseconds. Used when `DetectionMode` is `PremiumCallScreening`.
+     */
+    MachineDetectionPromptEndTimeout?: number;
+
     /**
      * If initial silence duration is greater than this value, consider it a machine.
      * Ignored when `premium` detection is used.
@@ -1284,9 +1300,11 @@ export namespace CallCallsParams {
     DeepfakeDetectionCallbackUrl?: string;
 
     /**
-     * Allows you to chose between Premium and Standard detections.
+     * Allows you to choose between Regular, Premium, and PremiumCallScreening
+     * detections. See
+     * https://developers.telnyx.com/docs/voice/programmable-voice/answering-machine-detection
      */
-    DetectionMode?: 'Premium' | 'Regular';
+    DetectionMode?: 'Premium' | 'Regular' | 'PremiumCallScreening';
 
     /**
      * A failover URL for which Telnyx will retrieve the TeXML call instructions if the
@@ -1305,6 +1323,12 @@ export namespace CallCallsParams {
      */
     MachineDetection?: 'Enable' | 'Disable' | 'DetectMessageEnd';
 
+    /**
+     * Silence duration threshold after a call screening prompt before ending prompt
+     * detection, in milliseconds. Used when `DetectionMode` is `PremiumCallScreening`.
+     */
+    MachineDetectionPromptEndTimeout?: number;
+
     /**
      * If initial silence duration is greater than this value, consider it a machine.
      * Ignored when `premium` detection is used.

package/src/resources/texml/texml.ts

@@ -180,15 +180,23 @@ export interface TexmlInitiateAICallParams {
   CustomHeaders?: Array<TexmlInitiateAICallParams.CustomHeader>;
 
   /**
-   * Allows you to choose between Premium and Standard detections.
+   * Allows you to choose between Regular, Premium, and PremiumCallScreening
+   * detections. See
+   * https://developers.telnyx.com/docs/voice/programmable-voice/answering-machine-detection
    */
-  DetectionMode?: 'Premium' | 'Regular';
+  DetectionMode?: 'Premium' | 'Regular' | 'PremiumCallScreening';
 
   /**
    * Enables Answering Machine Detection.
    */
   MachineDetection?: 'Enable' | 'Disable' | 'DetectMessageEnd';
 
+  /**
+   * Silence duration threshold after a call screening prompt before ending prompt
+   * detection, in milliseconds. Used when `DetectionMode` is `PremiumCallScreening`.
+   */
+  MachineDetectionPromptEndTimeout?: number;
+
   /**
    * If initial silence duration is greater than this value, consider it a machine.
    * Ignored when `premium` detection is used.

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

@@ -3,13 +3,17 @@
 export { Actions, type ActionCheckRegistrationStatusResponse } from './actions';
 export {
   UacConnections,
+  type UacConnection,
+  type UacExternalSettings,
+  type UacInbound,
+  type UacInternalSettings,
+  type UacOutbound,
   type UacConnectionCreateResponse,
   type UacConnectionRetrieveResponse,
   type UacConnectionUpdateResponse,
-  type UacConnectionListResponse,
   type UacConnectionDeleteResponse,
   type UacConnectionCreateParams,
   type UacConnectionUpdateParams,
   type UacConnectionListParams,
-  type UacConnectionListResponsesDefaultFlatPagination,
+  type UacConnectionsDefaultFlatPagination,
 } from './uac-connections';