telnyx 6.83.0 → 7.2.0

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

@@ -1,4 +1,4 @@
-export { SpeechToText, type SpeechToTextListProvidersResponse, type TranscribeClientEvent, type TranscribeServerEvent, type SpeechToTextListProvidersParams, } from "./speech-to-text.mjs";
+export { SpeechToText, type SttServiceType, type SpeechToTextListProvidersResponse, type TranscribeClientEvent, type TranscribeServerEvent, type SpeechToTextListProvidersParams, type SpeechToTextRetrieveTranscriptionParams, } from "./speech-to-text.mjs";
 export { type SpeechToTextWSClientOptions } from "./ws.mjs";
 export { type SpeechToTextWSReconnectOptions } from "./ws-base.mjs";
 //# sourceMappingURL=index.d.mts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../../src/resources/speech-to-text/index.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,YAAY,EACZ,KAAK,iCAAiC,EACtC,KAAK,qBAAqB,EAC1B,KAAK,qBAAqB,EAC1B,KAAK,+BAA+B,GACrC,6BAAyB;AAC1B,OAAO,EAAE,KAAK,2BAA2B,EAAE,iBAAa;AACxD,OAAO,EAAE,KAAK,8BAA8B,EAAE,sBAAkB"}
+{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../../src/resources/speech-to-text/index.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,YAAY,EACZ,KAAK,cAAc,EACnB,KAAK,iCAAiC,EACtC,KAAK,qBAAqB,EAC1B,KAAK,qBAAqB,EAC1B,KAAK,+BAA+B,EACpC,KAAK,uCAAuC,GAC7C,6BAAyB;AAC1B,OAAO,EAAE,KAAK,2BAA2B,EAAE,iBAAa;AACxD,OAAO,EAAE,KAAK,8BAA8B,EAAE,sBAAkB"}

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

@@ -1,4 +1,4 @@
-export { SpeechToText, type SpeechToTextListProvidersResponse, type TranscribeClientEvent, type TranscribeServerEvent, type SpeechToTextListProvidersParams, } from "./speech-to-text.js";
+export { SpeechToText, type SttServiceType, type SpeechToTextListProvidersResponse, type TranscribeClientEvent, type TranscribeServerEvent, type SpeechToTextListProvidersParams, type SpeechToTextRetrieveTranscriptionParams, } from "./speech-to-text.js";
 export { type SpeechToTextWSClientOptions } from "./ws.js";
 export { type SpeechToTextWSReconnectOptions } from "./ws-base.js";
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/resources/speech-to-text/index.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,YAAY,EACZ,KAAK,iCAAiC,EACtC,KAAK,qBAAqB,EAC1B,KAAK,qBAAqB,EAC1B,KAAK,+BAA+B,GACrC,4BAAyB;AAC1B,OAAO,EAAE,KAAK,2BAA2B,EAAE,gBAAa;AACxD,OAAO,EAAE,KAAK,8BAA8B,EAAE,qBAAkB"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/resources/speech-to-text/index.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,YAAY,EACZ,KAAK,cAAc,EACnB,KAAK,iCAAiC,EACtC,KAAK,qBAAqB,EAC1B,KAAK,qBAAqB,EAC1B,KAAK,+BAA+B,EACpC,KAAK,uCAAuC,GAC7C,4BAAyB;AAC1B,OAAO,EAAE,KAAK,2BAA2B,EAAE,gBAAa;AACxD,OAAO,EAAE,KAAK,8BAA8B,EAAE,qBAAkB"}

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

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

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

@@ -1 +1 @@
-{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../../src/resources/speech-to-text/index.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EACL,YAAY,GAKb,6BAAyB"}
+{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../../src/resources/speech-to-text/index.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EACL,YAAY,GAOb,6BAAyB"}

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

@@ -1,10 +1,8 @@
 import { APIResource } from "../../core/resource.mjs";
+import * as SpeechToTextAPI from "./speech-to-text.mjs";
 import { APIPromise } from "../../core/api-promise.mjs";
 import { type Uploadable } from "../../core/uploads.mjs";
 import { RequestOptions } from "../../internal/request-options.mjs";
-/**
- * Discover available speech-to-text providers, models, and supported languages.
- */
 export declare class SpeechToText extends APIResource {
     /**
      * Retrieve the canonical list of supported speech-to-text providers, models,
@@ -14,17 +12,43 @@ export declare class SpeechToText extends APIResource {
      *
      * - `streaming` — standalone WebSocket transcription via
      *   `/speech-to-text/transcription`.
-     * - `file_transcription` — file-based transcription via
-     *   `/ai/audio/transcriptions`.
-     * - `in_call_transcription` — live call transcription via Call Control
-     *   `transcription_start`.
+     * - `file_based` — file-based transcription via `/ai/audio/transcriptions`.
+     * - `in_call` — live call transcription via Call Control `transcription_start`.
+     * - `ai_assistant` — STT configured on a Call Control AI Assistant via
+     *   voice-assistant `TranscriptionConfig` (covers both live-streaming and
+     *   non-streaming/batch models).
      *
      * Use this endpoint to discover which (provider, model) combinations are available
      * for the surface you need, and which language codes each accepts. `auto` in a
      * `languages` array indicates the provider performs language detection.
      */
     listProviders(query?: SpeechToTextListProvidersParams | null | undefined, options?: RequestOptions): APIPromise<SpeechToTextListProvidersResponse>;
+    /**
+     * Open a WebSocket connection to stream audio and receive transcriptions in
+     * real-time. Authentication is provided via the standard
+     * `Authorization: Bearer <API_KEY>` header.
+     *
+     * Supported engines: `Azure`, `Deepgram`, `Google`, `Telnyx`, `xAI`,
+     * `Speechmatics`, `Soniox`.
+     *
+     * **Connection flow:**
+     *
+     * 1. Open WebSocket with query parameters specifying engine, input format, and
+     *    language.
+     * 2. Send binary audio frames (mp3/wav format).
+     * 3. Receive JSON transcript frames with `transcript`, `is_final`, and
+     *    `confidence` fields.
+     * 4. Close connection when done.
+     */
+    retrieveTranscription(query: SpeechToTextRetrieveTranscriptionParams, options?: RequestOptions): APIPromise<void>;
 }
+/**
+ * Service surface a model is available on. `ai_assistant` is the STT surface
+ * configured via Call Control voice-assistant transcription; it covers both
+ * live-streaming and non-streaming/batch models (matching the
+ * `TranscriptionConfig.model` enum on `call-control` voice assistants).
+ */
+export type SttServiceType = 'streaming' | 'file_based' | 'in_call' | 'ai_assistant';
 /**
  * List of supported STT providers and models.
  */
@@ -34,14 +58,10 @@ export interface SpeechToTextListProvidersResponse {
 }
 export declare namespace SpeechToTextListProvidersResponse {
     /**
-     * A (provider, model) tuple along with its supported service types and languages.
+     * A (provider, model) tuple along with the service surfaces it supports. Each
+     * entry in `service_types` describes one surface and the languages accepted on it.
      */
     interface Data {
-        /**
-         * Languages this (provider, model) accepts, in the provider's native code format.
-         * `auto` indicates the provider performs language detection.
-         */
-        languages: Array<string>;
         /**
          * Provider-scoped model name.
          */
@@ -51,9 +71,33 @@ export declare namespace SpeechToTextListProvidersResponse {
          */
         provider: string;
         /**
-         * Service surfaces this (provider, model) supports.
+         * Service surfaces this (provider, model) supports. When the request filters by
+         * `service_type`, only the matching nested entry is returned for each matching
+         * model.
+         */
+        service_types: Array<Data.ServiceType>;
+    }
+    namespace Data {
+        /**
+         * A supported service surface for a given (provider, model), along with the
+         * language codes accepted on that surface. Language support can differ per surface
+         * — for example, a model may accept a narrower language set for streaming than for
+         * file transcription.
          */
-        service_types: Array<'streaming' | 'file_transcription' | 'in_call_transcription'>;
+        interface ServiceType {
+            /**
+             * Languages accepted on this service surface, in the provider's native code
+             * format. `auto` indicates the provider performs language detection.
+             */
+            languages: Array<string>;
+            /**
+             * Service surface a model is available on. `ai_assistant` is the STT surface
+             * configured via Call Control voice-assistant transcription; it covers both
+             * live-streaming and non-streaming/batch models (matching the
+             * `TranscriptionConfig.model` enum on `call-control` voice assistants).
+             */
+            type: SpeechToTextAPI.SttServiceType;
+        }
     }
     interface Meta {
         /**
@@ -118,11 +162,61 @@ export interface SpeechToTextListProvidersParams {
      */
     provider?: 'deepgram' | 'speechmatics' | 'assemblyai' | 'xai' | 'soniox' | 'azure' | 'openai' | 'google' | 'telnyx';
     /**
-     * Filter to entries that support the given service type.
+     * Filter to entries that support the given service type. For backward
+     * compatibility with the values that briefly shipped before the product-aligned
+     * rename, the legacy aliases `file_transcription`, `in_call_transcription`, and
+     * `ai_assistant_transcription` are silently accepted and normalized to
+     * `file_based`, `in_call`, and `ai_assistant` respectively. The response always
+     * emits the canonical (post-rename) values.
+     */
+    service_type?: SttServiceType;
+}
+export interface SpeechToTextRetrieveTranscriptionParams {
+    /**
+     * The format of input audio stream.
+     */
+    input_format: 'mp3' | 'wav';
+    /**
+     * The transcription engine to use for processing the audio stream.
+     */
+    transcription_engine: 'Azure' | 'Deepgram' | 'Google' | 'Telnyx' | 'xAI' | 'Speechmatics' | 'Soniox';
+    /**
+     * Silence duration (in milliseconds) that triggers end-of-speech detection. When
+     * set, the engine uses this value to determine when a speaker has stopped talking.
+     * Supported by `xAI`, `Deepgram`, `Google`, `Speechmatics`, and `Soniox`. `Soniox`
+     * accepts values between 500 and 3000. Other engines may not support this
+     * parameter.
+     */
+    endpointing?: number;
+    /**
+     * Whether to receive interim transcription results.
+     */
+    interim_results?: boolean;
+    /**
+     * A key term to boost in the transcription. The engine will be more likely to
+     * recognize this term. Can be specified multiple times for multiple terms.
+     */
+    keyterm?: string;
+    /**
+     * Comma-separated list of keywords to boost in the transcription. The engine will
+     * prioritize recognition of these words.
+     */
+    keywords?: string;
+    /**
+     * The language spoken in the audio stream.
+     */
+    language?: string;
+    /**
+     * The specific model to use within the selected transcription engine.
+     */
+    model?: 'fast' | 'deepgram/nova-2' | 'deepgram/nova-3' | 'latest_long' | 'latest_short' | 'command_and_search' | 'phone_call' | 'video' | 'default' | 'medical_conversation' | 'medical_dictation' | 'openai/whisper-tiny' | 'openai/whisper-large-v3-turbo' | 'xai/grok-stt' | 'speechmatics/standard' | 'soniox/stt-rt-v4';
+    /**
+     * Enable redaction of sensitive information (e.g., PCI data, SSN) from
+     * transcription results. Supported values depend on the transcription engine.
      */
-    service_type?: 'streaming' | 'file_transcription' | 'in_call_transcription';
+    redact?: string;
 }
 export declare namespace SpeechToText {
-    export { type SpeechToTextListProvidersResponse as SpeechToTextListProvidersResponse, type TranscribeClientEvent as TranscribeClientEvent, type TranscribeServerEvent as TranscribeServerEvent, type SpeechToTextListProvidersParams as SpeechToTextListProvidersParams, };
+    export { type SttServiceType as SttServiceType, type SpeechToTextListProvidersResponse as SpeechToTextListProvidersResponse, type TranscribeClientEvent as TranscribeClientEvent, type TranscribeServerEvent as TranscribeServerEvent, type SpeechToTextListProvidersParams as SpeechToTextListProvidersParams, type SpeechToTextRetrieveTranscriptionParams as SpeechToTextRetrieveTranscriptionParams, };
 }
 //# sourceMappingURL=speech-to-text.d.mts.map

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

@@ -1 +1 @@
-{"version":3,"file":"speech-to-text.d.mts","sourceRoot":"","sources":["../../src/resources/speech-to-text/speech-to-text.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAClD,OAAO,EAAE,UAAU,EAAE,mCAA+B;AACpD,OAAO,EAAE,KAAK,UAAU,EAAE,+BAA2B;AACrD,OAAO,EAAE,cAAc,EAAE,2CAAuC;AAEhE;;GAEG;AACH,qBAAa,YAAa,SAAQ,WAAW;IAC3C;;;;;;;;;;;;;;;;OAgBG;IACH,aAAa,CACX,KAAK,GAAE,+BAA+B,GAAG,IAAI,GAAG,SAAc,EAC9D,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,iCAAiC,CAAC;CAOjD;AAED;;GAEG;AACH,MAAM,WAAW,iCAAiC;IAChD,IAAI,EAAE,KAAK,CAAC,iCAAiC,CAAC,IAAI,CAAC,CAAC;IAEpD,IAAI,EAAE,iCAAiC,CAAC,IAAI,CAAC;CAC9C;AAED,yBAAiB,iCAAiC,CAAC;IACjD;;OAEG;IACH,UAAiB,IAAI;QACnB;;;WAGG;QACH,SAAS,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAEzB;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;QAEjB;;WAEG;QACH,aAAa,EAAE,KAAK,CAAC,WAAW,GAAG,oBAAoB,GAAG,uBAAuB,CAAC,CAAC;KACpF;IAED,UAAiB,IAAI;QACnB;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;KACf;CACF;AAED;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG,UAAU,CAAC;AAE/C;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAC7B,qBAAqB,CAAC,eAAe,GACrC,qBAAqB,CAAC,aAAa,CAAC;AAExC,yBAAiB,qBAAqB,CAAC;IACrC;;OAEG;IACH,UAAiB,eAAe;QAC9B;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,IAAI,EAAE,YAAY,CAAC;QAEnB;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;QAEpB;;;WAGG;QACH,QAAQ,CAAC,EAAE,OAAO,CAAC;KACpB;IAED;;;OAGG;IACH,UAAiB,aAAa;QAC5B;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,IAAI,EAAE,OAAO,CAAC;KACf;CACF;AAED,MAAM,WAAW,+BAA+B;IAC9C;;;;;;OAMG;IACH,QAAQ,CAAC,EACL,UAAU,GACV,cAAc,GACd,YAAY,GACZ,KAAK,GACL,QAAQ,GACR,OAAO,GACP,QAAQ,GACR,QAAQ,GACR,QAAQ,CAAC;IAEb;;OAEG;IACH,YAAY,CAAC,EAAE,WAAW,GAAG,oBAAoB,GAAG,uBAAuB,CAAC;CAC7E;AAED,MAAM,CAAC,OAAO,WAAW,YAAY,CAAC;IACpC,OAAO,EACL,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,+BAA+B,IAAI,+BAA+B,GACxE,CAAC;CACH"}
+{"version":3,"file":"speech-to-text.d.mts","sourceRoot":"","sources":["../../src/resources/speech-to-text/speech-to-text.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAClD,OAAO,KAAK,eAAe,6BAAyB;AACpD,OAAO,EAAE,UAAU,EAAE,mCAA+B;AACpD,OAAO,EAAE,KAAK,UAAU,EAAE,+BAA2B;AAErD,OAAO,EAAE,cAAc,EAAE,2CAAuC;AAEhE,qBAAa,YAAa,SAAQ,WAAW;IAC3C;;;;;;;;;;;;;;;;;OAiBG;IACH,aAAa,CACX,KAAK,GAAE,+BAA+B,GAAG,IAAI,GAAG,SAAc,EAC9D,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,iCAAiC,CAAC;IAQhD;;;;;;;;;;;;;;;;OAgBG;IACH,qBAAqB,CACnB,KAAK,EAAE,uCAAuC,EAC9C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,IAAI,CAAC;CAWpB;AAED;;;;;GAKG;AACH,MAAM,MAAM,cAAc,GAAG,WAAW,GAAG,YAAY,GAAG,SAAS,GAAG,cAAc,CAAC;AAErF;;GAEG;AACH,MAAM,WAAW,iCAAiC;IAChD,IAAI,EAAE,KAAK,CAAC,iCAAiC,CAAC,IAAI,CAAC,CAAC;IAEpD,IAAI,EAAE,iCAAiC,CAAC,IAAI,CAAC;CAC9C;AAED,yBAAiB,iCAAiC,CAAC;IACjD;;;OAGG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;QAEjB;;;;WAIG;QACH,aAAa,EAAE,KAAK,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;KACxC;IAED,UAAiB,IAAI,CAAC;QACpB;;;;;WAKG;QACH,UAAiB,WAAW;YAC1B;;;eAGG;YACH,SAAS,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;YAEzB;;;;;eAKG;YACH,IAAI,EAAE,eAAe,CAAC,cAAc,CAAC;SACtC;KACF;IAED,UAAiB,IAAI;QACnB;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;KACf;CACF;AAED;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG,UAAU,CAAC;AAE/C;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAC7B,qBAAqB,CAAC,eAAe,GACrC,qBAAqB,CAAC,aAAa,CAAC;AAExC,yBAAiB,qBAAqB,CAAC;IACrC;;OAEG;IACH,UAAiB,eAAe;QAC9B;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,IAAI,EAAE,YAAY,CAAC;QAEnB;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;QAEpB;;;WAGG;QACH,QAAQ,CAAC,EAAE,OAAO,CAAC;KACpB;IAED;;;OAGG;IACH,UAAiB,aAAa;QAC5B;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,IAAI,EAAE,OAAO,CAAC;KACf;CACF;AAED,MAAM,WAAW,+BAA+B;IAC9C;;;;;;OAMG;IACH,QAAQ,CAAC,EACL,UAAU,GACV,cAAc,GACd,YAAY,GACZ,KAAK,GACL,QAAQ,GACR,OAAO,GACP,QAAQ,GACR,QAAQ,GACR,QAAQ,CAAC;IAEb;;;;;;;OAOG;IACH,YAAY,CAAC,EAAE,cAAc,CAAC;CAC/B;AAED,MAAM,WAAW,uCAAuC;IACtD;;OAEG;IACH,YAAY,EAAE,KAAK,GAAG,KAAK,CAAC;IAE5B;;OAEG;IACH,oBAAoB,EAAE,OAAO,GAAG,UAAU,GAAG,QAAQ,GAAG,QAAQ,GAAG,KAAK,GAAG,cAAc,GAAG,QAAQ,CAAC;IAErG;;;;;;OAMG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;IAE1B;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,KAAK,CAAC,EACF,MAAM,GACN,iBAAiB,GACjB,iBAAiB,GACjB,aAAa,GACb,cAAc,GACd,oBAAoB,GACpB,YAAY,GACZ,OAAO,GACP,SAAS,GACT,sBAAsB,GACtB,mBAAmB,GACnB,qBAAqB,GACrB,+BAA+B,GAC/B,cAAc,GACd,uBAAuB,GACvB,kBAAkB,CAAC;IAEvB;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,CAAC,OAAO,WAAW,YAAY,CAAC;IACpC,OAAO,EACL,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,uCAAuC,IAAI,uCAAuC,GACxF,CAAC;CACH"}

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

@@ -1,10 +1,8 @@
 import { APIResource } from "../../core/resource.js";
+import * as SpeechToTextAPI from "./speech-to-text.js";
 import { APIPromise } from "../../core/api-promise.js";
 import { type Uploadable } from "../../core/uploads.js";
 import { RequestOptions } from "../../internal/request-options.js";
-/**
- * Discover available speech-to-text providers, models, and supported languages.
- */
 export declare class SpeechToText extends APIResource {
     /**
      * Retrieve the canonical list of supported speech-to-text providers, models,
@@ -14,17 +12,43 @@ export declare class SpeechToText extends APIResource {
      *
      * - `streaming` — standalone WebSocket transcription via
      *   `/speech-to-text/transcription`.
-     * - `file_transcription` — file-based transcription via
-     *   `/ai/audio/transcriptions`.
-     * - `in_call_transcription` — live call transcription via Call Control
-     *   `transcription_start`.
+     * - `file_based` — file-based transcription via `/ai/audio/transcriptions`.
+     * - `in_call` — live call transcription via Call Control `transcription_start`.
+     * - `ai_assistant` — STT configured on a Call Control AI Assistant via
+     *   voice-assistant `TranscriptionConfig` (covers both live-streaming and
+     *   non-streaming/batch models).
      *
      * Use this endpoint to discover which (provider, model) combinations are available
      * for the surface you need, and which language codes each accepts. `auto` in a
      * `languages` array indicates the provider performs language detection.
      */
     listProviders(query?: SpeechToTextListProvidersParams | null | undefined, options?: RequestOptions): APIPromise<SpeechToTextListProvidersResponse>;
+    /**
+     * Open a WebSocket connection to stream audio and receive transcriptions in
+     * real-time. Authentication is provided via the standard
+     * `Authorization: Bearer <API_KEY>` header.
+     *
+     * Supported engines: `Azure`, `Deepgram`, `Google`, `Telnyx`, `xAI`,
+     * `Speechmatics`, `Soniox`.
+     *
+     * **Connection flow:**
+     *
+     * 1. Open WebSocket with query parameters specifying engine, input format, and
+     *    language.
+     * 2. Send binary audio frames (mp3/wav format).
+     * 3. Receive JSON transcript frames with `transcript`, `is_final`, and
+     *    `confidence` fields.
+     * 4. Close connection when done.
+     */
+    retrieveTranscription(query: SpeechToTextRetrieveTranscriptionParams, options?: RequestOptions): APIPromise<void>;
 }
+/**
+ * Service surface a model is available on. `ai_assistant` is the STT surface
+ * configured via Call Control voice-assistant transcription; it covers both
+ * live-streaming and non-streaming/batch models (matching the
+ * `TranscriptionConfig.model` enum on `call-control` voice assistants).
+ */
+export type SttServiceType = 'streaming' | 'file_based' | 'in_call' | 'ai_assistant';
 /**
  * List of supported STT providers and models.
  */
@@ -34,14 +58,10 @@ export interface SpeechToTextListProvidersResponse {
 }
 export declare namespace SpeechToTextListProvidersResponse {
     /**
-     * A (provider, model) tuple along with its supported service types and languages.
+     * A (provider, model) tuple along with the service surfaces it supports. Each
+     * entry in `service_types` describes one surface and the languages accepted on it.
      */
     interface Data {
-        /**
-         * Languages this (provider, model) accepts, in the provider's native code format.
-         * `auto` indicates the provider performs language detection.
-         */
-        languages: Array<string>;
         /**
          * Provider-scoped model name.
          */
@@ -51,9 +71,33 @@ export declare namespace SpeechToTextListProvidersResponse {
          */
         provider: string;
         /**
-         * Service surfaces this (provider, model) supports.
+         * Service surfaces this (provider, model) supports. When the request filters by
+         * `service_type`, only the matching nested entry is returned for each matching
+         * model.
+         */
+        service_types: Array<Data.ServiceType>;
+    }
+    namespace Data {
+        /**
+         * A supported service surface for a given (provider, model), along with the
+         * language codes accepted on that surface. Language support can differ per surface
+         * — for example, a model may accept a narrower language set for streaming than for
+         * file transcription.
          */
-        service_types: Array<'streaming' | 'file_transcription' | 'in_call_transcription'>;
+        interface ServiceType {
+            /**
+             * Languages accepted on this service surface, in the provider's native code
+             * format. `auto` indicates the provider performs language detection.
+             */
+            languages: Array<string>;
+            /**
+             * Service surface a model is available on. `ai_assistant` is the STT surface
+             * configured via Call Control voice-assistant transcription; it covers both
+             * live-streaming and non-streaming/batch models (matching the
+             * `TranscriptionConfig.model` enum on `call-control` voice assistants).
+             */
+            type: SpeechToTextAPI.SttServiceType;
+        }
     }
     interface Meta {
         /**
@@ -118,11 +162,61 @@ export interface SpeechToTextListProvidersParams {
      */
     provider?: 'deepgram' | 'speechmatics' | 'assemblyai' | 'xai' | 'soniox' | 'azure' | 'openai' | 'google' | 'telnyx';
     /**
-     * Filter to entries that support the given service type.
+     * Filter to entries that support the given service type. For backward
+     * compatibility with the values that briefly shipped before the product-aligned
+     * rename, the legacy aliases `file_transcription`, `in_call_transcription`, and
+     * `ai_assistant_transcription` are silently accepted and normalized to
+     * `file_based`, `in_call`, and `ai_assistant` respectively. The response always
+     * emits the canonical (post-rename) values.
+     */
+    service_type?: SttServiceType;
+}
+export interface SpeechToTextRetrieveTranscriptionParams {
+    /**
+     * The format of input audio stream.
+     */
+    input_format: 'mp3' | 'wav';
+    /**
+     * The transcription engine to use for processing the audio stream.
+     */
+    transcription_engine: 'Azure' | 'Deepgram' | 'Google' | 'Telnyx' | 'xAI' | 'Speechmatics' | 'Soniox';
+    /**
+     * Silence duration (in milliseconds) that triggers end-of-speech detection. When
+     * set, the engine uses this value to determine when a speaker has stopped talking.
+     * Supported by `xAI`, `Deepgram`, `Google`, `Speechmatics`, and `Soniox`. `Soniox`
+     * accepts values between 500 and 3000. Other engines may not support this
+     * parameter.
+     */
+    endpointing?: number;
+    /**
+     * Whether to receive interim transcription results.
+     */
+    interim_results?: boolean;
+    /**
+     * A key term to boost in the transcription. The engine will be more likely to
+     * recognize this term. Can be specified multiple times for multiple terms.
+     */
+    keyterm?: string;
+    /**
+     * Comma-separated list of keywords to boost in the transcription. The engine will
+     * prioritize recognition of these words.
+     */
+    keywords?: string;
+    /**
+     * The language spoken in the audio stream.
+     */
+    language?: string;
+    /**
+     * The specific model to use within the selected transcription engine.
+     */
+    model?: 'fast' | 'deepgram/nova-2' | 'deepgram/nova-3' | 'latest_long' | 'latest_short' | 'command_and_search' | 'phone_call' | 'video' | 'default' | 'medical_conversation' | 'medical_dictation' | 'openai/whisper-tiny' | 'openai/whisper-large-v3-turbo' | 'xai/grok-stt' | 'speechmatics/standard' | 'soniox/stt-rt-v4';
+    /**
+     * Enable redaction of sensitive information (e.g., PCI data, SSN) from
+     * transcription results. Supported values depend on the transcription engine.
      */
-    service_type?: 'streaming' | 'file_transcription' | 'in_call_transcription';
+    redact?: string;
 }
 export declare namespace SpeechToText {
-    export { type SpeechToTextListProvidersResponse as SpeechToTextListProvidersResponse, type TranscribeClientEvent as TranscribeClientEvent, type TranscribeServerEvent as TranscribeServerEvent, type SpeechToTextListProvidersParams as SpeechToTextListProvidersParams, };
+    export { type SttServiceType as SttServiceType, type SpeechToTextListProvidersResponse as SpeechToTextListProvidersResponse, type TranscribeClientEvent as TranscribeClientEvent, type TranscribeServerEvent as TranscribeServerEvent, type SpeechToTextListProvidersParams as SpeechToTextListProvidersParams, type SpeechToTextRetrieveTranscriptionParams as SpeechToTextRetrieveTranscriptionParams, };
 }
 //# sourceMappingURL=speech-to-text.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"speech-to-text.d.ts","sourceRoot":"","sources":["../../src/resources/speech-to-text/speech-to-text.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,+BAA4B;AAClD,OAAO,EAAE,UAAU,EAAE,kCAA+B;AACpD,OAAO,EAAE,KAAK,UAAU,EAAE,8BAA2B;AACrD,OAAO,EAAE,cAAc,EAAE,0CAAuC;AAEhE;;GAEG;AACH,qBAAa,YAAa,SAAQ,WAAW;IAC3C;;;;;;;;;;;;;;;;OAgBG;IACH,aAAa,CACX,KAAK,GAAE,+BAA+B,GAAG,IAAI,GAAG,SAAc,EAC9D,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,iCAAiC,CAAC;CAOjD;AAED;;GAEG;AACH,MAAM,WAAW,iCAAiC;IAChD,IAAI,EAAE,KAAK,CAAC,iCAAiC,CAAC,IAAI,CAAC,CAAC;IAEpD,IAAI,EAAE,iCAAiC,CAAC,IAAI,CAAC;CAC9C;AAED,yBAAiB,iCAAiC,CAAC;IACjD;;OAEG;IACH,UAAiB,IAAI;QACnB;;;WAGG;QACH,SAAS,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAEzB;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;QAEjB;;WAEG;QACH,aAAa,EAAE,KAAK,CAAC,WAAW,GAAG,oBAAoB,GAAG,uBAAuB,CAAC,CAAC;KACpF;IAED,UAAiB,IAAI;QACnB;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;KACf;CACF;AAED;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG,UAAU,CAAC;AAE/C;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAC7B,qBAAqB,CAAC,eAAe,GACrC,qBAAqB,CAAC,aAAa,CAAC;AAExC,yBAAiB,qBAAqB,CAAC;IACrC;;OAEG;IACH,UAAiB,eAAe;QAC9B;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,IAAI,EAAE,YAAY,CAAC;QAEnB;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;QAEpB;;;WAGG;QACH,QAAQ,CAAC,EAAE,OAAO,CAAC;KACpB;IAED;;;OAGG;IACH,UAAiB,aAAa;QAC5B;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,IAAI,EAAE,OAAO,CAAC;KACf;CACF;AAED,MAAM,WAAW,+BAA+B;IAC9C;;;;;;OAMG;IACH,QAAQ,CAAC,EACL,UAAU,GACV,cAAc,GACd,YAAY,GACZ,KAAK,GACL,QAAQ,GACR,OAAO,GACP,QAAQ,GACR,QAAQ,GACR,QAAQ,CAAC;IAEb;;OAEG;IACH,YAAY,CAAC,EAAE,WAAW,GAAG,oBAAoB,GAAG,uBAAuB,CAAC;CAC7E;AAED,MAAM,CAAC,OAAO,WAAW,YAAY,CAAC;IACpC,OAAO,EACL,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,+BAA+B,IAAI,+BAA+B,GACxE,CAAC;CACH"}
+{"version":3,"file":"speech-to-text.d.ts","sourceRoot":"","sources":["../../src/resources/speech-to-text/speech-to-text.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,+BAA4B;AAClD,OAAO,KAAK,eAAe,4BAAyB;AACpD,OAAO,EAAE,UAAU,EAAE,kCAA+B;AACpD,OAAO,EAAE,KAAK,UAAU,EAAE,8BAA2B;AAErD,OAAO,EAAE,cAAc,EAAE,0CAAuC;AAEhE,qBAAa,YAAa,SAAQ,WAAW;IAC3C;;;;;;;;;;;;;;;;;OAiBG;IACH,aAAa,CACX,KAAK,GAAE,+BAA+B,GAAG,IAAI,GAAG,SAAc,EAC9D,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,iCAAiC,CAAC;IAQhD;;;;;;;;;;;;;;;;OAgBG;IACH,qBAAqB,CACnB,KAAK,EAAE,uCAAuC,EAC9C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,IAAI,CAAC;CAWpB;AAED;;;;;GAKG;AACH,MAAM,MAAM,cAAc,GAAG,WAAW,GAAG,YAAY,GAAG,SAAS,GAAG,cAAc,CAAC;AAErF;;GAEG;AACH,MAAM,WAAW,iCAAiC;IAChD,IAAI,EAAE,KAAK,CAAC,iCAAiC,CAAC,IAAI,CAAC,CAAC;IAEpD,IAAI,EAAE,iCAAiC,CAAC,IAAI,CAAC;CAC9C;AAED,yBAAiB,iCAAiC,CAAC;IACjD;;;OAGG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;QAEjB;;;;WAIG;QACH,aAAa,EAAE,KAAK,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;KACxC;IAED,UAAiB,IAAI,CAAC;QACpB;;;;;WAKG;QACH,UAAiB,WAAW;YAC1B;;;eAGG;YACH,SAAS,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;YAEzB;;;;;eAKG;YACH,IAAI,EAAE,eAAe,CAAC,cAAc,CAAC;SACtC;KACF;IAED,UAAiB,IAAI;QACnB;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;KACf;CACF;AAED;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG,UAAU,CAAC;AAE/C;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAC7B,qBAAqB,CAAC,eAAe,GACrC,qBAAqB,CAAC,aAAa,CAAC;AAExC,yBAAiB,qBAAqB,CAAC;IACrC;;OAEG;IACH,UAAiB,eAAe;QAC9B;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,IAAI,EAAE,YAAY,CAAC;QAEnB;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;QAEpB;;;WAGG;QACH,QAAQ,CAAC,EAAE,OAAO,CAAC;KACpB;IAED;;;OAGG;IACH,UAAiB,aAAa;QAC5B;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,IAAI,EAAE,OAAO,CAAC;KACf;CACF;AAED,MAAM,WAAW,+BAA+B;IAC9C;;;;;;OAMG;IACH,QAAQ,CAAC,EACL,UAAU,GACV,cAAc,GACd,YAAY,GACZ,KAAK,GACL,QAAQ,GACR,OAAO,GACP,QAAQ,GACR,QAAQ,GACR,QAAQ,CAAC;IAEb;;;;;;;OAOG;IACH,YAAY,CAAC,EAAE,cAAc,CAAC;CAC/B;AAED,MAAM,WAAW,uCAAuC;IACtD;;OAEG;IACH,YAAY,EAAE,KAAK,GAAG,KAAK,CAAC;IAE5B;;OAEG;IACH,oBAAoB,EAAE,OAAO,GAAG,UAAU,GAAG,QAAQ,GAAG,QAAQ,GAAG,KAAK,GAAG,cAAc,GAAG,QAAQ,CAAC;IAErG;;;;;;OAMG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;IAE1B;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,KAAK,CAAC,EACF,MAAM,GACN,iBAAiB,GACjB,iBAAiB,GACjB,aAAa,GACb,cAAc,GACd,oBAAoB,GACpB,YAAY,GACZ,OAAO,GACP,SAAS,GACT,sBAAsB,GACtB,mBAAmB,GACnB,qBAAqB,GACrB,+BAA+B,GAC/B,cAAc,GACd,uBAAuB,GACvB,kBAAkB,CAAC;IAEvB;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,CAAC,OAAO,WAAW,YAAY,CAAC;IACpC,OAAO,EACL,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,uCAAuC,IAAI,uCAAuC,GACxF,CAAC;CACH"}

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

@@ -3,9 +3,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SpeechToText = void 0;
 const resource_1 = require("../../core/resource.js");
-/**
- * Discover available speech-to-text providers, models, and supported languages.
- */
+const headers_1 = require("../../internal/headers.js");
 class SpeechToText extends resource_1.APIResource {
     /**
      * Retrieve the canonical list of supported speech-to-text providers, models,
@@ -15,10 +13,11 @@ class SpeechToText extends resource_1.APIResource {
      *
      * - `streaming` — standalone WebSocket transcription via
      *   `/speech-to-text/transcription`.
-     * - `file_transcription` — file-based transcription via
-     *   `/ai/audio/transcriptions`.
-     * - `in_call_transcription` — live call transcription via Call Control
-     *   `transcription_start`.
+     * - `file_based` — file-based transcription via `/ai/audio/transcriptions`.
+     * - `in_call` — live call transcription via Call Control `transcription_start`.
+     * - `ai_assistant` — STT configured on a Call Control AI Assistant via
+     *   voice-assistant `TranscriptionConfig` (covers both live-streaming and
+     *   non-streaming/batch models).
      *
      * Use this endpoint to discover which (provider, model) combinations are available
      * for the surface you need, and which language codes each accepts. `auto` in a
@@ -31,6 +30,34 @@ class SpeechToText extends resource_1.APIResource {
             ...options,
         });
     }
+    /**
+     * Open a WebSocket connection to stream audio and receive transcriptions in
+     * real-time. Authentication is provided via the standard
+     * `Authorization: Bearer <API_KEY>` header.
+     *
+     * Supported engines: `Azure`, `Deepgram`, `Google`, `Telnyx`, `xAI`,
+     * `Speechmatics`, `Soniox`.
+     *
+     * **Connection flow:**
+     *
+     * 1. Open WebSocket with query parameters specifying engine, input format, and
+     *    language.
+     * 2. Send binary audio frames (mp3/wav format).
+     * 3. Receive JSON transcript frames with `transcript`, `is_final`, and
+     *    `confidence` fields.
+     * 4. Close connection when done.
+     */
+    retrieveTranscription(query, options) {
+        return this._client.get('/speech-to-text/transcription', {
+            query,
+            defaultBaseURL: 'wss://api.telnyx.com/v2',
+            ...options,
+            headers: (0, headers_1.buildHeaders)([
+                { 'Content-Type': 'application/octet-stream', Accept: '*/*' },
+                options?.headers,
+            ]),
+        });
+    }
 }
 exports.SpeechToText = SpeechToText;
 //# sourceMappingURL=speech-to-text.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"speech-to-text.js","sourceRoot":"","sources":["../../src/resources/speech-to-text/speech-to-text.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAKlD;;GAEG;AACH,MAAa,YAAa,SAAQ,sBAAW;IAC3C;;;;;;;;;;;;;;;;OAgBG;IACH,aAAa,CACX,QAA4D,EAAE,EAC9D,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,2BAA2B,EAAE;YACnD,KAAK;YACL,cAAc,EAAE,2BAA2B;YAC3C,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;CACF;AA5BD,oCA4BC"}
+{"version":3,"file":"speech-to-text.js","sourceRoot":"","sources":["../../src/resources/speech-to-text/speech-to-text.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAIlD,uDAAsD;AAGtD,MAAa,YAAa,SAAQ,sBAAW;IAC3C;;;;;;;;;;;;;;;;;OAiBG;IACH,aAAa,CACX,QAA4D,EAAE,EAC9D,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,2BAA2B,EAAE;YACnD,KAAK;YACL,cAAc,EAAE,2BAA2B;YAC3C,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,qBAAqB,CACnB,KAA8C,EAC9C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,+BAA+B,EAAE;YACvD,KAAK;YACL,cAAc,EAAE,yBAAyB;YACzC,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB,EAAE,cAAc,EAAE,0BAA0B,EAAE,MAAM,EAAE,KAAK,EAAE;gBAC7D,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;CACF;AA7DD,oCA6DC"}

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

@@ -1,8 +1,6 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 import { APIResource } from "../../core/resource.mjs";
-/**
- * Discover available speech-to-text providers, models, and supported languages.
- */
+import { buildHeaders } from "../../internal/headers.mjs";
 export class SpeechToText extends APIResource {
     /**
      * Retrieve the canonical list of supported speech-to-text providers, models,
@@ -12,10 +10,11 @@ export class SpeechToText extends APIResource {
      *
      * - `streaming` — standalone WebSocket transcription via
      *   `/speech-to-text/transcription`.
-     * - `file_transcription` — file-based transcription via
-     *   `/ai/audio/transcriptions`.
-     * - `in_call_transcription` — live call transcription via Call Control
-     *   `transcription_start`.
+     * - `file_based` — file-based transcription via `/ai/audio/transcriptions`.
+     * - `in_call` — live call transcription via Call Control `transcription_start`.
+     * - `ai_assistant` — STT configured on a Call Control AI Assistant via
+     *   voice-assistant `TranscriptionConfig` (covers both live-streaming and
+     *   non-streaming/batch models).
      *
      * Use this endpoint to discover which (provider, model) combinations are available
      * for the surface you need, and which language codes each accepts. `auto` in a
@@ -28,5 +27,33 @@ export class SpeechToText extends APIResource {
             ...options,
         });
     }
+    /**
+     * Open a WebSocket connection to stream audio and receive transcriptions in
+     * real-time. Authentication is provided via the standard
+     * `Authorization: Bearer <API_KEY>` header.
+     *
+     * Supported engines: `Azure`, `Deepgram`, `Google`, `Telnyx`, `xAI`,
+     * `Speechmatics`, `Soniox`.
+     *
+     * **Connection flow:**
+     *
+     * 1. Open WebSocket with query parameters specifying engine, input format, and
+     *    language.
+     * 2. Send binary audio frames (mp3/wav format).
+     * 3. Receive JSON transcript frames with `transcript`, `is_final`, and
+     *    `confidence` fields.
+     * 4. Close connection when done.
+     */
+    retrieveTranscription(query, options) {
+        return this._client.get('/speech-to-text/transcription', {
+            query,
+            defaultBaseURL: 'wss://api.telnyx.com/v2',
+            ...options,
+            headers: buildHeaders([
+                { 'Content-Type': 'application/octet-stream', Accept: '*/*' },
+                options?.headers,
+            ]),
+        });
+    }
 }
 //# sourceMappingURL=speech-to-text.mjs.map

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

@@ -1 +1 @@
-{"version":3,"file":"speech-to-text.mjs","sourceRoot":"","sources":["../../src/resources/speech-to-text/speech-to-text.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAKlD;;GAEG;AACH,MAAM,OAAO,YAAa,SAAQ,WAAW;IAC3C;;;;;;;;;;;;;;;;OAgBG;IACH,aAAa,CACX,QAA4D,EAAE,EAC9D,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,2BAA2B,EAAE;YACnD,KAAK;YACL,cAAc,EAAE,2BAA2B;YAC3C,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;CACF"}
+{"version":3,"file":"speech-to-text.mjs","sourceRoot":"","sources":["../../src/resources/speech-to-text/speech-to-text.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAIlD,OAAO,EAAE,YAAY,EAAE,mCAA+B;AAGtD,MAAM,OAAO,YAAa,SAAQ,WAAW;IAC3C;;;;;;;;;;;;;;;;;OAiBG;IACH,aAAa,CACX,QAA4D,EAAE,EAC9D,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,2BAA2B,EAAE;YACnD,KAAK;YACL,cAAc,EAAE,2BAA2B;YAC3C,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,qBAAqB,CACnB,KAA8C,EAC9C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,+BAA+B,EAAE;YACvD,KAAK;YACL,cAAc,EAAE,yBAAyB;YACzC,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB,EAAE,cAAc,EAAE,0BAA0B,EAAE,MAAM,EAAE,KAAK,EAAE;gBAC7D,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;CACF"}

package/resources/terms-of-service/agreements.d.mts

@@ -0,0 +1,71 @@
+import { APIResource } from "../../core/resource.mjs";
+import { APIPromise } from "../../core/api-promise.mjs";
+import { DefaultFlatPagination, type DefaultFlatPaginationParams, PagePromise } from "../../core/pagination.mjs";
+import { RequestOptions } from "../../internal/request-options.mjs";
+/**
+ * Accept and review the Branded Calling and Phone Number Reputation terms of service.
+ */
+export declare class Agreements extends APIResource {
+    /**
+     * Retrieve a single ToS agreement record. Returns `404` if the agreement does not
+     * exist or does not belong to the authenticated user.
+     */
+    retrieve(agreementID: string, options?: RequestOptions): APIPromise<TosAgreementWrapped>;
+    /**
+     * Returns the Terms of Service agreements the authenticated user has on file. Each
+     * entry records the version agreed to and when. Most users only have one agreement
+     * per product, but if the ToS is updated and the user re-agrees a new entry is
+     * added.
+     *
+     * Results are paginated with the standard `page[number]` / `page[size]`
+     * parameters; the response uses the standard `{data, meta}` JSON:API envelope.
+     *
+     * By default this returns agreements for **all** products the user has agreed to.
+     * Pass the `product_type` query parameter to scope the result to a single product.
+     */
+    list(query?: AgreementListParams | null | undefined, options?: RequestOptions): PagePromise<TosAgreementsDefaultFlatPagination, TosAgreement>;
+}
+export type TosAgreementsDefaultFlatPagination = DefaultFlatPagination<TosAgreement>;
+/**
+ * A recorded user agreement to a product's Terms of Service. The `user_id` is
+ * intentionally NOT echoed back on this public surface - the caller already knows
+ * their own identity.
+ */
+export interface TosAgreement {
+    id?: string;
+    agreed_at?: string;
+    created_at?: string;
+    /**
+     * Telnyx product the Terms of Service apply to.
+     */
+    product_type?: TosProductType;
+    terms_version?: string;
+    /**
+     * Convenience alias of `terms_version`. Both keys are present on every response.
+     */
+    version?: string;
+}
+export interface TosAgreementWrapped {
+    /**
+     * A recorded user agreement to a product's Terms of Service. The `user_id` is
+     * intentionally NOT echoed back on this public surface - the caller already knows
+     * their own identity.
+     */
+    data: TosAgreement;
+}
+/**
+ * Telnyx product the Terms of Service apply to.
+ */
+export type TosProductType = 'branded_calling' | 'number_reputation';
+export interface AgreementListParams extends DefaultFlatPaginationParams {
+    /**
+     * Optional filter. Omit to list the user's agreements for **every** product
+     * (branded_calling and number_reputation); pass a value to return only that
+     * product's agreements.
+     */
+    product_type?: TosProductType;
+}
+export declare namespace Agreements {
+    export { type TosAgreement as TosAgreement, type TosAgreementWrapped as TosAgreementWrapped, type TosProductType as TosProductType, type TosAgreementsDefaultFlatPagination as TosAgreementsDefaultFlatPagination, type AgreementListParams as AgreementListParams, };
+}
+//# sourceMappingURL=agreements.d.mts.map

package/resources/terms-of-service/agreements.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"agreements.d.mts","sourceRoot":"","sources":["../../src/resources/terms-of-service/agreements.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAClD,OAAO,EAAE,UAAU,EAAE,mCAA+B;AACpD,OAAO,EAAE,qBAAqB,EAAE,KAAK,2BAA2B,EAAE,WAAW,EAAE,kCAA8B;AAC7G,OAAO,EAAE,cAAc,EAAE,2CAAuC;AAGhE;;GAEG;AACH,qBAAa,UAAW,SAAQ,WAAW;IACzC;;;OAGG;IACH,QAAQ,CAAC,WAAW,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,mBAAmB,CAAC;IAIxF;;;;;;;;;;;OAWG;IACH,IAAI,CACF,KAAK,GAAE,mBAAmB,GAAG,IAAI,GAAG,SAAc,EAClD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,kCAAkC,EAAE,YAAY,CAAC;CAMjE;AAED,MAAM,MAAM,kCAAkC,GAAG,qBAAqB,CAAC,YAAY,CAAC,CAAC;AAErF;;;;GAIG;AACH,MAAM,WAAW,YAAY;IAC3B,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,YAAY,CAAC,EAAE,cAAc,CAAC;IAE9B,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,mBAAmB;IAClC;;;;OAIG;IACH,IAAI,EAAE,YAAY,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG,iBAAiB,GAAG,mBAAmB,CAAC;AAErE,MAAM,WAAW,mBAAoB,SAAQ,2BAA2B;IACtE;;;;OAIG;IACH,YAAY,CAAC,EAAE,cAAc,CAAC;CAC/B;AAED,MAAM,CAAC,OAAO,WAAW,UAAU,CAAC;IAClC,OAAO,EACL,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,kCAAkC,IAAI,kCAAkC,EAC7E,KAAK,mBAAmB,IAAI,mBAAmB,GAChD,CAAC;CACH"}