telnyx 6.8.0 → 6.8.2

package/resources/speech-to-text.mjs

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+export * from "./speech-to-text/index.mjs";
+//# sourceMappingURL=speech-to-text.mjs.map

package/resources/speech-to-text.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"speech-to-text.mjs","sourceRoot":"","sources":["../src/resources/speech-to-text.ts"],"names":[],"mappings":"AAAA,sFAAsF"}

package/resources/text-to-speech/index.d.mts

@@ -1,2 +1,3 @@
 export { TextToSpeech, type TextToSpeechGenerateResponse, type TextToSpeechListVoicesResponse, type StreamClientEvent, type StreamServerEvent, type TextToSpeechGenerateParams, type TextToSpeechListVoicesParams, } from "./text-to-speech.mjs";
+export { TextToSpeechWS } from "./ws.mjs";
 //# sourceMappingURL=index.d.mts.map

package/resources/text-to-speech/index.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../../src/resources/text-to-speech/index.ts"],"names":[],"mappings":"OAEO,EACL,YAAY,EACZ,KAAK,4BAA4B,EACjC,KAAK,8BAA8B,EACnC,KAAK,iBAAiB,EACtB,KAAK,iBAAiB,EACtB,KAAK,0BAA0B,EAC/B,KAAK,4BAA4B,GAClC"}
+{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../../src/resources/text-to-speech/index.ts"],"names":[],"mappings":"OAEO,EACL,YAAY,EACZ,KAAK,4BAA4B,EACjC,KAAK,8BAA8B,EACnC,KAAK,iBAAiB,EACtB,KAAK,iBAAiB,EACtB,KAAK,0BAA0B,EAC/B,KAAK,4BAA4B,GAClC;OACM,EAAE,cAAc,EAAE"}

package/resources/text-to-speech/index.d.ts

@@ -1,2 +1,3 @@
 export { TextToSpeech, type TextToSpeechGenerateResponse, type TextToSpeechListVoicesResponse, type StreamClientEvent, type StreamServerEvent, type TextToSpeechGenerateParams, type TextToSpeechListVoicesParams, } from "./text-to-speech.js";
+export { TextToSpeechWS } from "./ws.js";
 //# sourceMappingURL=index.d.ts.map

package/resources/text-to-speech/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/resources/text-to-speech/index.ts"],"names":[],"mappings":"OAEO,EACL,YAAY,EACZ,KAAK,4BAA4B,EACjC,KAAK,8BAA8B,EACnC,KAAK,iBAAiB,EACtB,KAAK,iBAAiB,EACtB,KAAK,0BAA0B,EAC/B,KAAK,4BAA4B,GAClC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/resources/text-to-speech/index.ts"],"names":[],"mappings":"OAEO,EACL,YAAY,EACZ,KAAK,4BAA4B,EACjC,KAAK,8BAA8B,EACnC,KAAK,iBAAiB,EACtB,KAAK,iBAAiB,EACtB,KAAK,0BAA0B,EAC/B,KAAK,4BAA4B,GAClC;OACM,EAAE,cAAc,EAAE"}

package/resources/text-to-speech/index.js

@@ -1,7 +1,9 @@
 "use strict";
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.TextToSpeech = void 0;
+exports.TextToSpeechWS = exports.TextToSpeech = void 0;
 var text_to_speech_1 = require("./text-to-speech.js");
 Object.defineProperty(exports, "TextToSpeech", { enumerable: true, get: function () { return text_to_speech_1.TextToSpeech; } });
+var ws_1 = require("./ws.js");
+Object.defineProperty(exports, "TextToSpeechWS", { enumerable: true, get: function () { return ws_1.TextToSpeechWS; } });
 //# sourceMappingURL=index.js.map

package/resources/text-to-speech/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/resources/text-to-speech/index.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,sDAQ0B;AAPxB,8GAAA,YAAY,OAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/resources/text-to-speech/index.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,sDAQ0B;AAPxB,8GAAA,YAAY,OAAA;AAQd,8BAAsC;AAA7B,oGAAA,cAAc,OAAA"}

package/resources/text-to-speech/index.mjs

@@ -1,3 +1,4 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 export { TextToSpeech, } from "./text-to-speech.mjs";
+export { TextToSpeechWS } from "./ws.mjs";
 //# sourceMappingURL=index.mjs.map

package/resources/text-to-speech/index.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../../src/resources/text-to-speech/index.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EACL,YAAY,GAOb"}
+{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../../src/resources/text-to-speech/index.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EACL,YAAY,GAOb;OACM,EAAE,cAAc,EAAE"}

package/src/resources/index.ts

@@ -1064,6 +1064,16 @@ export {
   type ShortCodeUpdateParams,
   type ShortCodeListParams,
 } from './short-codes';
+export {
+  SpeechToText,
+  SpeechToTextWS,
+  WebSocketError as SpeechToTextWebSocketError,
+  type SpeechToTextStreamParams,
+  type SttClientEvent,
+  type SttServerEvent,
+  type TranscriptFrame,
+  type SttErrorFrame,
+} from './speech-to-text';
 export {
   SimCardDataUsageNotifications,
   type SimCardDataUsageNotification,
@@ -1181,6 +1191,7 @@ export {
 } from './texml-applications';
 export {
   TextToSpeech,
+  TextToSpeechWS,
   type TextToSpeechGenerateResponse,
   type TextToSpeechListVoicesResponse,
   type StreamClientEvent,

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

@@ -0,0 +1,13 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export {
+  SpeechToText,
+  type SpeechToTextStreamParams,
+  type SttClientEvent,
+  type SttServerEvent,
+  type TranscriptFrame,
+  type SttErrorFrame,
+} from './speech-to-text';
+
+export { SpeechToTextWS } from './ws';
+export { WebSocketError } from './internal-base';

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

@@ -0,0 +1,93 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import * as SpeechToTextAPI from './speech-to-text';
+import { Telnyx } from '../../client';
+
+import { EventEmitter } from '../../core/EventEmitter';
+import { TelnyxError } from '../../core/error';
+import { stringifyQuery } from '../../internal/utils';
+
+export class WebSocketError extends TelnyxError {
+  /**
+   * The error data that the API sent back in an error event.
+   */
+  error?: SpeechToTextAPI.SttServerEvent.ErrorFrame | undefined;
+
+  constructor(message: string, event: SpeechToTextAPI.SttServerEvent.ErrorFrame | null) {
+    super(message);
+
+    this.error = event ?? undefined;
+  }
+}
+
+type Simplify<T> = { [KeyType in keyof T]: T[KeyType] } & {};
+
+type WebsocketEvents = Simplify<
+  {
+    event: (event: SpeechToTextAPI.SttServerEvent) => void;
+    error: (error: WebSocketError) => void;
+  } & {
+    [EventType in Exclude<NonNullable<SpeechToTextAPI.SttServerEvent['type']>, 'error'>]: (
+      event: Extract<SpeechToTextAPI.SttServerEvent, { type?: EventType }>,
+    ) => unknown;
+  }
+>;
+
+export abstract class SpeechToTextEmitter extends EventEmitter<WebsocketEvents> {
+  /**
+   * Send binary audio data to the API.
+   */
+  abstract send(data: SpeechToTextAPI.SttClientEvent): void;
+
+  /**
+   * Close the websocket connection.
+   */
+  abstract close(props?: { code: number; reason: string }): void;
+
+  protected _onError(event: null, message: string, cause: any): void;
+  protected _onError(event: SpeechToTextAPI.SttServerEvent.ErrorFrame, message?: string | undefined): void;
+  protected _onError(
+    event: SpeechToTextAPI.SttServerEvent.ErrorFrame | null,
+    message?: string | undefined,
+    cause?: any,
+  ): void {
+    message = message ?? safeJSONStringify(event) ?? 'unknown error';
+
+    if (!this._hasListener('error')) {
+      const error = new WebSocketError(
+        message +
+          `\n\nTo resolve these unhandled rejection errors you should bind an \`error\` callback, e.g. \`ws.on('error', (error) => ...)\` `,
+        event,
+      );
+      // @ts-ignore
+      error.cause = cause;
+      Promise.reject(error);
+      return;
+    }
+
+    const error = new WebSocketError(message, event);
+    // @ts-ignore
+    error.cause = cause;
+
+    this._emit('error', error);
+  }
+}
+
+export function buildURL(client: Telnyx, query?: SpeechToTextAPI.SpeechToTextStreamParams | null): URL {
+  const path = '/speech-to-text/transcription';
+  const baseURL = client.baseURL;
+  const url = new URL(baseURL + (baseURL.endsWith('/') ? path.slice(1) : path));
+  if (query) {
+    url.search = stringifyQuery(query);
+  }
+  url.protocol = 'wss';
+  return url;
+}
+
+function safeJSONStringify(value: unknown): string | null {
+  try {
+    return JSON.stringify(value);
+  } catch {
+    return null;
+  }
+}

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

@@ -0,0 +1,102 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+
+/**
+ * Speech to text streaming operations via WebSocket
+ */
+export class SpeechToText extends APIResource {}
+
+/**
+ * Parameters for establishing a speech-to-text WebSocket connection.
+ */
+export interface SpeechToTextStreamParams {
+  /**
+   * The transcription engine to use for processing the audio stream.
+   */
+  transcription_engine: 'Azure' | 'Deepgram' | 'Google' | 'Telnyx';
+
+  /**
+   * The format of the input audio stream.
+   */
+  input_format?: 'mp3' | 'wav' | 'raw';
+
+  /**
+   * The language code for transcription (e.g., 'en-US', 'es-ES').
+   */
+  language?: string;
+
+  /**
+   * Whether to return interim (partial) transcription results.
+   */
+  interim_results?: boolean;
+
+  /**
+   * The model to use for transcription (engine-specific).
+   */
+  model?: string;
+}
+
+/**
+ * Binary audio data sent from client to server.
+ * Send raw audio bytes in mp3 or wav format.
+ */
+export type SttClientEvent = ArrayBuffer | Buffer | Uint8Array;
+
+/**
+ * Union of all server-to-client WebSocket events for STT streaming.
+ */
+export type SttServerEvent = SttServerEvent.TranscriptFrame | SttServerEvent.ErrorFrame;
+
+export namespace SttServerEvent {
+  /**
+   * Server-to-client frame containing a transcription result.
+   */
+  export interface TranscriptFrame {
+    /**
+     * Frame type identifier.
+     */
+    type: 'transcript';
+
+    /**
+     * The transcribed text from the audio.
+     */
+    transcript: string;
+
+    /**
+     * Whether this is a final transcription result.
+     * When `false`, this is an interim result that may be refined.
+     */
+    is_final?: boolean;
+
+    /**
+     * Confidence score of the transcription, ranging from 0 to 1.
+     */
+    confidence?: number;
+  }
+
+  /**
+   * Server-to-client frame indicating an error during transcription.
+   */
+  export interface ErrorFrame {
+    /**
+     * Frame type identifier.
+     */
+    type: 'error';
+
+    /**
+     * Error message describing what went wrong.
+     */
+    error: string;
+  }
+}
+
+/**
+ * Transcript frame with transcription result.
+ */
+export type TranscriptFrame = SttServerEvent.TranscriptFrame;
+
+/**
+ * Error frame indicating transcription failure.
+ */
+export type SttErrorFrame = SttServerEvent.ErrorFrame;

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

@@ -0,0 +1,127 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import * as WS from 'ws';
+import { SpeechToTextEmitter, buildURL } from './internal-base';
+import * as SpeechToTextAPI from './speech-to-text';
+import { Telnyx } from '../../client';
+
+export class SpeechToTextWS extends SpeechToTextEmitter {
+  url: URL;
+  socket: WS.WebSocket;
+  private client: Telnyx;
+
+  constructor(
+    client: Telnyx,
+    parameters: SpeechToTextAPI.SpeechToTextStreamParams,
+    options?: WS.ClientOptions | null | undefined,
+  ) {
+    super();
+    this.client = client;
+    this.url = buildURL(client, parameters);
+    this.socket = new WS.WebSocket(this.url, {
+      ...options,
+      headers: {
+        ...this.authHeaders(),
+        ...options?.headers,
+      },
+    });
+
+    this.socket.on('open', () => {
+      // Connection established, ready to send audio
+    });
+
+    this.socket.on('message', (wsEvent) => {
+      const event = (() => {
+        try {
+          return JSON.parse(wsEvent.toString()) as SpeechToTextAPI.SttServerEvent;
+        } catch (err) {
+          this._onError(null, 'could not parse websocket event', err);
+          return null;
+        }
+      })();
+
+      if (event) {
+        this._emit('event', event);
+
+        if (event.type === 'error') {
+          this._onError(event);
+        } else {
+          // @ts-ignore TS isn't smart enough to get the relationship right here
+          this._emit(event.type, event);
+        }
+      }
+    });
+
+    this.socket.on('error', (err) => {
+      this._onError(null, err.message, err);
+    });
+
+    this.socket.on('close', (code, reason) => {
+      // Connection closed
+    });
+  }
+
+  /**
+   * Send binary audio data to the server for transcription.
+   * @param data - Raw audio bytes (mp3 or wav format)
+   */
+  send(data: SpeechToTextAPI.SttClientEvent) {
+    try {
+      this.socket.send(data);
+    } catch (err) {
+      this._onError(null, 'could not send audio data', err);
+    }
+  }
+
+  /**
+   * Close the WebSocket connection.
+   */
+  close(props?: { code: number; reason: string }) {
+    try {
+      this.socket.close(props?.code ?? 1000, props?.reason ?? 'OK');
+    } catch (err) {
+      this._onError(null, 'could not close the connection', err);
+    }
+  }
+
+  /**
+   * Check if the WebSocket is open and ready to send data.
+   */
+  get isOpen(): boolean {
+    return this.socket.readyState === WS.WebSocket.OPEN;
+  }
+
+  /**
+   * Wait for the connection to be established.
+   */
+  waitForOpen(): Promise<void> {
+    return new Promise((resolve, reject) => {
+      if (this.socket.readyState === WS.WebSocket.OPEN) {
+        resolve();
+        return;
+      }
+
+      const onOpen = () => {
+        this.socket.off('open', onOpen);
+        this.socket.off('error', onError);
+        resolve();
+      };
+
+      const onError = (err: Error) => {
+        this.socket.off('open', onOpen);
+        this.socket.off('error', onError);
+        reject(err);
+      };
+
+      this.socket.on('open', onOpen);
+      this.socket.on('error', onError);
+    });
+  }
+
+  private authHeaders(): Record<string, string> {
+    if (this.client.apiKey) {
+      return { Authorization: `Bearer ${this.client.apiKey}` };
+    }
+    return {};
+  }
+}

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

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export * from './speech-to-text/index';

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

@@ -9,3 +9,4 @@ export {
   type TextToSpeechGenerateParams,
   type TextToSpeechListVoicesParams,
 } from './text-to-speech';
+export { TextToSpeechWS } from './ws';

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '6.8.0'; // x-release-please-version
+export const VERSION = '6.8.2'; // x-release-please-version

package/version.d.mts

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

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "6.8.0";
+export declare const VERSION = "6.8.2";
 //# 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.8.0'; // x-release-please-version
+exports.VERSION = '6.8.2'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

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