telnyx 6.70.0 → 6.72.0

package/src/resources/text-to-speech/text-to-speech.ts

@@ -29,13 +29,49 @@ export class TextToSpeech extends APIResource {
    * adjustment, and volume control. Use the `telnyx` provider-specific parameters to
    * configure these features.
    */
-  generate(
-    body: TextToSpeechGenerateParams,
+  createSpeech(
+    body: TextToSpeechCreateSpeechParams,
     options?: RequestOptions,
-  ): APIPromise<TextToSpeechGenerateResponse> {
+  ): APIPromise<TextToSpeechCreateSpeechResponse> {
     return this._client.post('/text-to-speech/speech', { body, ...options });
   }
 
+  /**
+   * Open a WebSocket connection to stream text and receive synthesized audio in real
+   * time. Authentication is provided via the standard
+   * `Authorization: Bearer <API_KEY>` header. Send JSON frames with text to
+   * synthesize; receive JSON frames containing base64-encoded audio chunks.
+   *
+   * Supported providers: `aws`, `telnyx`, `azure`, `murfai`, `minimax`, `rime`,
+   * `resemble`, `elevenlabs`, `xai`.
+   *
+   * **Connection flow:**
+   *
+   * 1. Open WebSocket with query parameters specifying provider, voice, and model.
+   * 2. Send an initial handshake message `{"text": " "}` (single space) with
+   *    optional `voice_settings` to initialize the session.
+   * 3. Send text messages as `{"text": "Hello world"}`.
+   * 4. Receive audio chunks as JSON frames with base64-encoded audio.
+   * 5. A final frame with `isFinal: true` indicates the end of audio for the current
+   *    text.
+   *
+   * To interrupt and restart synthesis mid-stream, send `{"force": true}` — the
+   * current worker is stopped and a new one is started.
+   *
+   * **Note:** The Telnyx `Ultra` model is not available over WebSocket. Use the HTTP
+   * POST `/text-to-speech/speech` endpoint instead.
+   */
+  generateSpeech(
+    query: TextToSpeechGenerateSpeechParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<void> {
+    return this._client.get('/text-to-speech/speech', {
+      query,
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+
   /**
    * Retrieve a list of available voices from one or all TTS providers. When
    * `provider` is specified, returns voices for that provider only. Otherwise,
@@ -71,7 +107,7 @@ export class TextToSpeech extends APIResource {
 /**
  * Response when `output_type` is `base64_output`.
  */
-export interface TextToSpeechGenerateResponse {
+export interface TextToSpeechCreateSpeechResponse {
   /**
    * Base64-encoded audio data.
    */
@@ -236,16 +272,16 @@ export namespace StreamServerEvent {
   }
 }
 
-export interface TextToSpeechGenerateParams {
+export interface TextToSpeechCreateSpeechParams {
   /**
    * AWS Polly provider-specific parameters.
    */
-  aws?: TextToSpeechGenerateParams.Aws;
+  aws?: TextToSpeechCreateSpeechParams.Aws;
 
   /**
    * Azure Cognitive Services provider-specific parameters.
    */
-  azure?: TextToSpeechGenerateParams.Azure;
+  azure?: TextToSpeechCreateSpeechParams.Azure;
 
   /**
    * When `true`, bypass the audio cache and generate fresh audio.
@@ -255,7 +291,7 @@ export interface TextToSpeechGenerateParams {
   /**
    * ElevenLabs provider-specific parameters.
    */
-  elevenlabs?: TextToSpeechGenerateParams.Elevenlabs;
+  elevenlabs?: TextToSpeechCreateSpeechParams.Elevenlabs;
 
   /**
    * Inworld provider-specific parameters.
@@ -270,7 +306,7 @@ export interface TextToSpeechGenerateParams {
   /**
    * Minimax provider-specific parameters.
    */
-  minimax?: TextToSpeechGenerateParams.Minimax;
+  minimax?: TextToSpeechCreateSpeechParams.Minimax;
 
   /**
    * Determines the response format. `binary_output` returns raw audio bytes,
@@ -286,19 +322,19 @@ export interface TextToSpeechGenerateParams {
   /**
    * Resemble AI provider-specific parameters.
    */
-  resemble?: TextToSpeechGenerateParams.Resemble;
+  resemble?: TextToSpeechCreateSpeechParams.Resemble;
 
   /**
    * Rime provider-specific parameters.
    */
-  rime?: TextToSpeechGenerateParams.Rime;
+  rime?: TextToSpeechCreateSpeechParams.Rime;
 
   /**
    * Telnyx provider-specific parameters. Use `voice_speed` and `temperature` for
    * `Natural` and `NaturalHD` models. For the `Ultra` model, use `voice_speed`,
    * `volume`, and `emotion`.
    */
-  telnyx?: TextToSpeechGenerateParams.Telnyx;
+  telnyx?: TextToSpeechCreateSpeechParams.Telnyx;
 
   /**
    * The text to convert to speech.
@@ -329,10 +365,10 @@ export interface TextToSpeechGenerateParams {
   /**
    * xAI provider-specific parameters.
    */
-  xai?: TextToSpeechGenerateParams.Xai;
+  xai?: TextToSpeechCreateSpeechParams.Xai;
 }
 
-export namespace TextToSpeechGenerateParams {
+export namespace TextToSpeechCreateSpeechParams {
   /**
    * AWS Polly provider-specific parameters.
    */
@@ -567,6 +603,53 @@ export namespace TextToSpeechGenerateParams {
   }
 }
 
+export interface TextToSpeechGenerateSpeechParams {
+  /**
+   * Audio output format override. Supported for Telnyx models. `pcm` and `wav` are
+   * available for `Natural`/`NaturalHD` models. The `Ultra` model outputs PCM at
+   * 24kHz s16le or MP3 at 128kbps 24kHz.
+   */
+  audio_format?: 'pcm' | 'wav' | 'mp3';
+
+  /**
+   * When `true`, bypass the audio cache and generate fresh audio.
+   */
+  disable_cache?: boolean;
+
+  /**
+   * Model identifier for the chosen provider. Examples: `Natural`, `NaturalHD`,
+   * `Ultra` (Telnyx); `Polly.Generative` (AWS).
+   */
+  model_id?: string;
+
+  /**
+   * TTS provider. Defaults to `telnyx` if not specified. Ignored when `voice` is
+   * provided.
+   */
+  provider?: 'aws' | 'telnyx' | 'azure' | 'elevenlabs' | 'minimax' | 'murfai' | 'rime' | 'resemble' | 'xai';
+
+  /**
+   * Client-provided socket identifier for tracking. If not provided, one is
+   * generated server-side.
+   */
+  socket_id?: string;
+
+  /**
+   * Voice identifier in the format `provider.model_id.voice_id` or
+   * `provider.voice_id` (e.g. `telnyx.NaturalHD.Telnyx_Alloy`,
+   * `Telnyx.Ultra.<voice_id>`, or `azure.en-US-AvaMultilingualNeural`). When
+   * provided, the `provider`, `model_id`, and `voice_id` are extracted
+   * automatically. Takes precedence over individual `provider`/`model_id`/`voice_id`
+   * parameters.
+   */
+  voice?: string;
+
+  /**
+   * Voice identifier for the chosen provider.
+   */
+  voice_id?: string;
+}
+
 export interface TextToSpeechListVoicesParams {
   /**
    * API key for providers that require one to list voices (e.g. ElevenLabs).
@@ -581,11 +664,12 @@ export interface TextToSpeechListVoicesParams {
 
 export declare namespace TextToSpeech {
   export {
-    type TextToSpeechGenerateResponse as TextToSpeechGenerateResponse,
+    type TextToSpeechCreateSpeechResponse as TextToSpeechCreateSpeechResponse,
     type TextToSpeechListVoicesResponse as TextToSpeechListVoicesResponse,
     type StreamClientEvent as StreamClientEvent,
     type StreamServerEvent as StreamServerEvent,
-    type TextToSpeechGenerateParams as TextToSpeechGenerateParams,
+    type TextToSpeechCreateSpeechParams as TextToSpeechCreateSpeechParams,
+    type TextToSpeechGenerateSpeechParams as TextToSpeechGenerateSpeechParams,
     type TextToSpeechListVoicesParams as TextToSpeechListVoicesParams,
   };
 }

package/src/resources/voice-sdk-call-reports.ts

@@ -1,6 +1,7 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { APIResource } from '../core/resource';
+import * as VoiceSDKCallReportsAPI from './voice-sdk-call-reports';
 import { APIPromise } from '../core/api-promise';
 import { DefaultFlatPagination, type DefaultFlatPaginationParams, PagePromise } from '../core/pagination';
 import { RequestOptions } from '../internal/request-options';
@@ -39,6 +40,33 @@ export class VoiceSDKCallReports extends APIResource {
 export type VoiceSDKCallReportListResponsesDefaultFlatPagination =
   DefaultFlatPagination<VoiceSDKCallReportListResponse>;
 
+/**
+ * A raw Voice SDK log entry. Additional SDK-specific fields may be present.
+ */
+export interface VoiceSDKCallReportLogEntry {
+  /**
+   * Raw structured context attached to the log entry.
+   */
+  context?: { [key: string]: unknown };
+
+  /**
+   * Log level emitted by the SDK.
+   */
+  level?: 'debug' | 'info' | 'warn' | 'error';
+
+  /**
+   * Log message.
+   */
+  message?: string;
+
+  /**
+   * Time when the log entry was emitted.
+   */
+  timestamp?: string;
+
+  [k: string]: unknown;
+}
+
 /**
  * Raw Voice SDK call report stats payloads as stored by voice-sdk-debug.
  */
@@ -80,7 +108,7 @@ export namespace VoiceSDKCallReportRetrieveResponse {
      * payloads are also allowed for compatibility.
      */
     logs?:
-      | Array<VoiceSDKCallReportRetrieveResponseItem.UnionMember0>
+      | Array<VoiceSDKCallReportsAPI.VoiceSDKCallReportLogEntry>
       | VoiceSDKCallReportRetrieveResponseItem.Entries;
 
     /**
@@ -162,33 +190,6 @@ export namespace VoiceSDKCallReportRetrieveResponse {
   }
 
   export namespace VoiceSDKCallReportRetrieveResponseItem {
-    /**
-     * A raw Voice SDK log entry. Additional SDK-specific fields may be present.
-     */
-    export interface UnionMember0 {
-      /**
-       * Raw structured context attached to the log entry.
-       */
-      context?: { [key: string]: unknown };
-
-      /**
-       * Log level emitted by the SDK.
-       */
-      level?: 'debug' | 'info' | 'warn' | 'error';
-
-      /**
-       * Log message.
-       */
-      message?: string;
-
-      /**
-       * Time when the log entry was emitted.
-       */
-      timestamp?: string;
-
-      [k: string]: unknown;
-    }
-
     /**
      * Raw logs object emitted by the Voice SDK when logs are grouped under an entries
      * field.
@@ -197,40 +198,11 @@ export namespace VoiceSDKCallReportRetrieveResponse {
       /**
        * Raw log entries when the SDK groups logs under an entries field.
        */
-      entries?: Array<Entries.Entry>;
+      entries?: Array<VoiceSDKCallReportsAPI.VoiceSDKCallReportLogEntry>;
 
       [k: string]: unknown;
     }
 
-    export namespace Entries {
-      /**
-       * A raw Voice SDK log entry. Additional SDK-specific fields may be present.
-       */
-      export interface Entry {
-        /**
-         * Raw structured context attached to the log entry.
-         */
-        context?: { [key: string]: unknown };
-
-        /**
-         * Log level emitted by the SDK.
-         */
-        level?: 'debug' | 'info' | 'warn' | 'error';
-
-        /**
-         * Log message.
-         */
-        message?: string;
-
-        /**
-         * Time when the log entry was emitted.
-         */
-        timestamp?: string;
-
-        [k: string]: unknown;
-      }
-    }
-
     /**
      * Raw stats object emitted by the Voice SDK.
      */
@@ -297,7 +269,7 @@ export interface VoiceSDKCallReportListResponse {
    * responses commonly return an array of log entries, but object-shaped log
    * payloads are also allowed for compatibility.
    */
-  logs?: Array<VoiceSDKCallReportListResponse.UnionMember0> | VoiceSDKCallReportListResponse.Entries;
+  logs?: Array<VoiceSDKCallReportLogEntry> | VoiceSDKCallReportListResponse.Entries;
 
   /**
    * Organization associated with the stored call report when provided by the Voice
@@ -378,33 +350,6 @@ export interface VoiceSDKCallReportListResponse {
 }
 
 export namespace VoiceSDKCallReportListResponse {
-  /**
-   * A raw Voice SDK log entry. Additional SDK-specific fields may be present.
-   */
-  export interface UnionMember0 {
-    /**
-     * Raw structured context attached to the log entry.
-     */
-    context?: { [key: string]: unknown };
-
-    /**
-     * Log level emitted by the SDK.
-     */
-    level?: 'debug' | 'info' | 'warn' | 'error';
-
-    /**
-     * Log message.
-     */
-    message?: string;
-
-    /**
-     * Time when the log entry was emitted.
-     */
-    timestamp?: string;
-
-    [k: string]: unknown;
-  }
-
   /**
    * Raw logs object emitted by the Voice SDK when logs are grouped under an entries
    * field.
@@ -413,40 +358,11 @@ export namespace VoiceSDKCallReportListResponse {
     /**
      * Raw log entries when the SDK groups logs under an entries field.
      */
-    entries?: Array<Entries.Entry>;
+    entries?: Array<VoiceSDKCallReportsAPI.VoiceSDKCallReportLogEntry>;
 
     [k: string]: unknown;
   }
 
-  export namespace Entries {
-    /**
-     * A raw Voice SDK log entry. Additional SDK-specific fields may be present.
-     */
-    export interface Entry {
-      /**
-       * Raw structured context attached to the log entry.
-       */
-      context?: { [key: string]: unknown };
-
-      /**
-       * Log level emitted by the SDK.
-       */
-      level?: 'debug' | 'info' | 'warn' | 'error';
-
-      /**
-       * Log message.
-       */
-      message?: string;
-
-      /**
-       * Time when the log entry was emitted.
-       */
-      timestamp?: string;
-
-      [k: string]: unknown;
-    }
-  }
-
   /**
    * Raw stats object emitted by the Voice SDK.
    */
@@ -490,6 +406,7 @@ export interface VoiceSDKCallReportListParams extends DefaultFlatPaginationParam
 
 export declare namespace VoiceSDKCallReports {
   export {
+    type VoiceSDKCallReportLogEntry as VoiceSDKCallReportLogEntry,
     type VoiceSDKCallReportRetrieveResponse as VoiceSDKCallReportRetrieveResponse,
     type VoiceSDKCallReportListResponse as VoiceSDKCallReportListResponse,
     type VoiceSDKCallReportListResponsesDefaultFlatPagination as VoiceSDKCallReportListResponsesDefaultFlatPagination,

package/src/resources/whatsapp/index.ts

@@ -23,6 +23,7 @@ export {
 } from './templates';
 export {
   UserData,
+  type WhatsappUserData,
   type UserDataRetrieveResponse,
   type UserDataUpdateResponse,
   type UserDataUpdateParams,

package/src/resources/whatsapp/user-data.ts

@@ -33,52 +33,30 @@ export class UserData extends APIResource {
   }
 }
 
-export interface UserDataRetrieveResponse {
-  data?: UserDataRetrieveResponse.Data;
-}
-
-export namespace UserDataRetrieveResponse {
-  export interface Data {
-    created_at?: string;
+export interface WhatsappUserData {
+  created_at?: string;
 
-    record_type?: string;
+  record_type?: string;
 
-    updated_at?: string;
+  updated_at?: string;
 
-    /**
-     * Failover URL to receive Whatsapp signup events
-     */
-    webhook_failover_url?: string;
+  /**
+   * Failover URL to receive Whatsapp signup events
+   */
+  webhook_failover_url?: string;
 
-    /**
-     * URL to receive Whatsapp signup events
-     */
-    webhook_url?: string;
-  }
+  /**
+   * URL to receive Whatsapp signup events
+   */
+  webhook_url?: string;
 }
 
-export interface UserDataUpdateResponse {
-  data?: UserDataUpdateResponse.Data;
+export interface UserDataRetrieveResponse {
+  data?: WhatsappUserData;
 }
 
-export namespace UserDataUpdateResponse {
-  export interface Data {
-    created_at?: string;
-
-    record_type?: string;
-
-    updated_at?: string;
-
-    /**
-     * Failover URL to receive Whatsapp signup events
-     */
-    webhook_failover_url?: string;
-
-    /**
-     * URL to receive Whatsapp signup events
-     */
-    webhook_url?: string;
-  }
+export interface UserDataUpdateResponse {
+  data?: WhatsappUserData;
 }
 
 export interface UserDataUpdateParams {
@@ -95,6 +73,7 @@ export interface UserDataUpdateParams {
 
 export declare namespace UserData {
   export {
+    type WhatsappUserData as WhatsappUserData,
     type UserDataRetrieveResponse as UserDataRetrieveResponse,
     type UserDataUpdateResponse as UserDataUpdateResponse,
     type UserDataUpdateParams as UserDataUpdateParams,

package/src/resources/whatsapp/whatsapp.ts

@@ -9,6 +9,7 @@ import {
   UserDataRetrieveResponse,
   UserDataUpdateParams,
   UserDataUpdateResponse,
+  WhatsappUserData,
 } from './user-data';
 import * as BusinessAccountsAPI from './business-accounts/business-accounts';
 import {
@@ -69,6 +70,7 @@ export declare namespace Whatsapp {
 
   export {
     UserData as UserData,
+    type WhatsappUserData as WhatsappUserData,
     type UserDataRetrieveResponse as UserDataRetrieveResponse,
     type UserDataUpdateResponse as UserDataUpdateResponse,
     type UserDataUpdateParams as UserDataUpdateParams,

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '6.70.0'; // x-release-please-version
+export const VERSION = '6.72.0'; // x-release-please-version

package/version.d.mts

@@ -1,2 +1,2 @@
-export declare const VERSION = "6.70.0";
+export declare const VERSION = "6.72.0";
 //# sourceMappingURL=version.d.mts.map

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "6.70.0";
+export declare const VERSION = "6.72.0";
 //# sourceMappingURL=version.d.ts.map

package/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '6.70.0'; // x-release-please-version
+exports.VERSION = '6.72.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '6.70.0'; // x-release-please-version
+export const VERSION = '6.72.0'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map