hume 0.11.0 → 0.11.2

package/api/resources/tts/resources/voices/client/Client.js

@@ -60,7 +60,7 @@ class Voices {
         this._options = _options;
     }
     /**
-     * Lists voices in your **Voice Library**. Set provider to `HUME_AI` to list Hume's preset voices, or to `CUSTOM_VOICE` to a custom voice created in your account.
+     * Lists voices you have saved in your account, or voices from the [Voice Library](https://platform.hume.ai/tts/voice-library).
      *
      * @param {Hume.tts.VoicesListRequest} request
      * @param {Voices.RequestOptions} requestOptions - Request-specific configuration.
@@ -74,7 +74,7 @@ class Voices {
      */
     list(request, requestOptions) {
         return __awaiter(this, void 0, void 0, function* () {
-            const list = (request) => __awaiter(this, void 0, void 0, function* () {
+            const list = core.HttpResponsePromise.interceptFunction((request) => __awaiter(this, void 0, void 0, function* () {
                 var _a, _b, _c;
                 const { provider, pageNumber, pageSize, ascendingOrder } = request;
                 const _queryParams = {};
@@ -93,7 +93,7 @@ class Voices {
                 const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
                     url: (0, url_join_1.default)((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.HumeEnvironment.Production, "v0/tts/voices"),
                     method: "GET",
-                    headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "hume", "X-Fern-SDK-Version": "0.10.3", "User-Agent": "hume/0.10.3", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                    headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "hume", "X-Fern-SDK-Version": "0.11.2", "User-Agent": "hume/0.11.2", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
                     contentType: "application/json",
                     queryParameters: _queryParams,
                     requestType: "json",
@@ -102,12 +102,15 @@ class Voices {
                     abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
                 });
                 if (_response.ok) {
-                    return serializers.tts.ReturnPagedVoices.parseOrThrow(_response.body, {
-                        unrecognizedObjectKeys: "passthrough",
-                        allowUnrecognizedUnionMembers: true,
-                        allowUnrecognizedEnumValues: true,
-                        breadcrumbsPrefix: ["response"],
-                    });
+                    return {
+                        data: serializers.tts.ReturnPagedVoices.parseOrThrow(_response.body, {
+                            unrecognizedObjectKeys: "passthrough",
+                            allowUnrecognizedUnionMembers: true,
+                            allowUnrecognizedEnumValues: true,
+                            breadcrumbsPrefix: ["response"],
+                        }),
+                        rawResponse: _response.rawResponse,
+                    };
                 }
                 if (_response.error.reason === "status-code") {
                     switch (_response.error.statusCode) {
@@ -117,11 +120,12 @@ class Voices {
                                 allowUnrecognizedUnionMembers: true,
                                 allowUnrecognizedEnumValues: true,
                                 breadcrumbsPrefix: ["response"],
-                            }));
+                            }), _response.rawResponse);
                         default:
                             throw new errors.HumeError({
                                 statusCode: _response.error.statusCode,
                                 body: _response.error.body,
+                                rawResponse: _response.rawResponse,
                             });
                     }
                 }
@@ -130,18 +134,22 @@ class Voices {
                         throw new errors.HumeError({
                             statusCode: _response.error.statusCode,
                             body: _response.error.rawBody,
+                            rawResponse: _response.rawResponse,
                         });
                     case "timeout":
                         throw new errors.HumeTimeoutError("Timeout exceeded when calling GET /v0/tts/voices.");
                     case "unknown":
                         throw new errors.HumeError({
                             message: _response.error.errorMessage,
+                            rawResponse: _response.rawResponse,
                         });
                 }
-            });
-            let _offset = (request === null || request === void 0 ? void 0 : request.pageNumber) != null ? request === null || request === void 0 ? void 0 : request.pageNumber : 1;
+            }));
+            let _offset = (request === null || request === void 0 ? void 0 : request.pageNumber) != null ? request === null || request === void 0 ? void 0 : request.pageNumber : 0;
+            const dataWithRawResponse = yield list(request).withRawResponse();
             return new core.Pageable({
-                response: yield list(request),
+                response: dataWithRawResponse.data,
+                rawResponse: dataWithRawResponse.rawResponse,
                 hasNextPage: (response) => { var _a; return ((_a = response === null || response === void 0 ? void 0 : response.voicesPage) !== null && _a !== void 0 ? _a : []).length > 0; },
                 getItems: (response) => { var _a; return (_a = response === null || response === void 0 ? void 0 : response.voicesPage) !== null && _a !== void 0 ? _a : []; },
                 loadPage: (_response) => {
@@ -152,7 +160,9 @@ class Voices {
         });
     }
     /**
-     * Creates a new voice from a specified TTS generation ID and saves it to your **Voice Library**. This allows for consistent speech style and prosody across multiple requests.
+     * Saves a new custom voice to your account using the specified TTS generation ID.
+     *
+     * Once saved, this voice can be reused in subsequent TTS requests, ensuring consistent speech style and prosody. For more details on voice creation, see the [Voices Guide](/docs/text-to-speech-tts/voices).
      *
      * @param {Hume.tts.PostedVoice} request
      * @param {Voices.RequestOptions} requestOptions - Request-specific configuration.
@@ -166,12 +176,15 @@ class Voices {
      *     })
      */
     create(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__create(request, requestOptions));
+    }
+    __create(request, requestOptions) {
         return __awaiter(this, void 0, void 0, function* () {
             var _a, _b, _c;
             const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
                 url: (0, url_join_1.default)((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.HumeEnvironment.Production, "v0/tts/voices"),
                 method: "POST",
-                headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "hume", "X-Fern-SDK-Version": "0.10.3", "User-Agent": "hume/0.10.3", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "hume", "X-Fern-SDK-Version": "0.11.2", "User-Agent": "hume/0.11.2", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
                 contentType: "application/json",
                 requestType: "json",
                 body: serializers.tts.PostedVoice.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
@@ -180,12 +193,15 @@ class Voices {
                 abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
             });
             if (_response.ok) {
-                return serializers.tts.ReturnVoice.parseOrThrow(_response.body, {
-                    unrecognizedObjectKeys: "passthrough",
-                    allowUnrecognizedUnionMembers: true,
-                    allowUnrecognizedEnumValues: true,
-                    breadcrumbsPrefix: ["response"],
-                });
+                return {
+                    data: serializers.tts.ReturnVoice.parseOrThrow(_response.body, {
+                        unrecognizedObjectKeys: "passthrough",
+                        allowUnrecognizedUnionMembers: true,
+                        allowUnrecognizedEnumValues: true,
+                        breadcrumbsPrefix: ["response"],
+                    }),
+                    rawResponse: _response.rawResponse,
+                };
             }
             if (_response.error.reason === "status-code") {
                 switch (_response.error.statusCode) {
@@ -195,11 +211,12 @@ class Voices {
                             allowUnrecognizedUnionMembers: true,
                             allowUnrecognizedEnumValues: true,
                             breadcrumbsPrefix: ["response"],
-                        }));
+                        }), _response.rawResponse);
                     default:
                         throw new errors.HumeError({
                             statusCode: _response.error.statusCode,
                             body: _response.error.body,
+                            rawResponse: _response.rawResponse,
                         });
                 }
             }
@@ -208,18 +225,20 @@ class Voices {
                     throw new errors.HumeError({
                         statusCode: _response.error.statusCode,
                         body: _response.error.rawBody,
+                        rawResponse: _response.rawResponse,
                     });
                 case "timeout":
                     throw new errors.HumeTimeoutError("Timeout exceeded when calling POST /v0/tts/voices.");
                 case "unknown":
                     throw new errors.HumeError({
                         message: _response.error.errorMessage,
+                        rawResponse: _response.rawResponse,
                     });
             }
         });
     }
     /**
-     * Removes a custom voice from your **Voice Library**.
+     * Deletes a previously generated custom voice.
      *
      * @param {Hume.tts.VoicesDeleteRequest} request
      * @param {Voices.RequestOptions} requestOptions - Request-specific configuration.
@@ -232,6 +251,9 @@ class Voices {
      *     })
      */
     delete(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__delete(request, requestOptions));
+    }
+    __delete(request, requestOptions) {
         return __awaiter(this, void 0, void 0, function* () {
             var _a, _b, _c;
             const { name } = request;
@@ -240,7 +262,7 @@ class Voices {
             const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
                 url: (0, url_join_1.default)((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.HumeEnvironment.Production, "v0/tts/voices"),
                 method: "DELETE",
-                headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "hume", "X-Fern-SDK-Version": "0.10.3", "User-Agent": "hume/0.10.3", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "hume", "X-Fern-SDK-Version": "0.11.2", "User-Agent": "hume/0.11.2", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
                 contentType: "application/json",
                 queryParameters: _queryParams,
                 requestType: "json",
@@ -249,7 +271,7 @@ class Voices {
                 abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
             });
             if (_response.ok) {
-                return;
+                return { data: undefined, rawResponse: _response.rawResponse };
             }
             if (_response.error.reason === "status-code") {
                 switch (_response.error.statusCode) {
@@ -259,11 +281,12 @@ class Voices {
                             allowUnrecognizedUnionMembers: true,
                             allowUnrecognizedEnumValues: true,
                             breadcrumbsPrefix: ["response"],
-                        }));
+                        }), _response.rawResponse);
                     default:
                         throw new errors.HumeError({
                             statusCode: _response.error.statusCode,
                             body: _response.error.body,
+                            rawResponse: _response.rawResponse,
                         });
                 }
             }
@@ -272,12 +295,14 @@ class Voices {
                     throw new errors.HumeError({
                         statusCode: _response.error.statusCode,
                         body: _response.error.rawBody,
+                        rawResponse: _response.rawResponse,
                     });
                 case "timeout":
                     throw new errors.HumeTimeoutError("Timeout exceeded when calling DELETE /v0/tts/voices.");
                 case "unknown":
                     throw new errors.HumeError({
                         message: _response.error.errorMessage,
+                        rawResponse: _response.rawResponse,
                     });
             }
         });

package/api/resources/tts/resources/voices/client/requests/VoicesListRequest.d.ts

@@ -10,7 +10,10 @@ import * as Hume from "../../../../../../index";
  */
 export interface VoicesListRequest {
     /**
-     * Specifies whether to return custom voices created in your account or shared voices provided by Hume
+     * Specify the voice provider to filter voices returned by the endpoint:
+     *
+     * - **`HUME_AI`**: Lists preset, shared voices from Hume's [Voice Library](https://platform.hume.ai/tts/voice-library).
+     * - **`CUSTOM_VOICE`**: Lists custom voices created and saved to your account.
      */
     provider: Hume.tts.VoiceProvider;
     /**

package/api/resources/tts/types/PostedTts.d.ts

@@ -12,11 +12,11 @@ export interface PostedTts {
     /**
      * Controls how audio output is segmented in the response.
      *
-     * - When **enabled** (`true`),  input utterances are automatically split into natural-sounding speech segments.
+     * - When **enabled** (`true`), input utterances are automatically split into natural-sounding speech segments.
      *
-     * - When **disabled**  (`false`), the response maintains a strict one-to-one mapping between input utterances and output snippets.
+     * - When **disabled** (`false`), the response maintains a strict one-to-one mapping between input utterances and output snippets.
      *
-     * This setting affects how the `snippets` array is structured in the response, which may be important  for applications that need to track the relationship between input text and generated audio segments. When  setting to `false`, avoid including utterances with long `text`, as this can result in distorted output.
+     * This setting affects how the `snippets` array is structured in the response, which may be important for applications that need to track the relationship between input text and generated audio segments. When setting to `false`, avoid including utterances with long `text`, as this can result in distorted output.
      */
     splitUtterances?: boolean;
     /** If enabled, the audio for all the chunks of a generation, once concatenated together, will constitute a single audio file. Otherwise, if disabled, each chunk's audio will be its own audio file, each with its own headers (if applicable). */
@@ -24,13 +24,13 @@ export interface PostedTts {
     /**
      * A list of **Utterances** to be converted to speech output.
      *
-     * An **Utterance** is a unit of  input for [Octave](/docs/text-to-speech-tts/overview), and includes input `text`, an  optional `description` to serve as the prompt for how the speech should be delivered, an optional `voice` specification, and additional controls to guide delivery for `speed` and `trailing_silence`.
+     * An **Utterance** is a unit of input for [Octave](/docs/text-to-speech-tts/overview), and includes input `text`, an optional `description` to serve as the prompt for how the speech should be delivered, an optional `voice` specification, and additional controls to guide delivery for `speed` and `trailing_silence`.
      */
     utterances: Hume.tts.PostedUtterance[];
     /**
      * Enables ultra-low latency streaming, significantly reducing the time until the first audio chunk is received. Recommended for real-time applications requiring immediate audio playback. For further details, see our documentation on [instant mode](/docs/text-to-speech-tts/overview#ultra-low-latency-streaming-instant-mode).
-     * - Dynamic voice generation is not supported with this mode; a predefined  [voice](/reference/text-to-speech-tts/synthesize-json-streaming#request.body.utterances.voice)  must be specified in your request.
-     * - This mode is only supported for streaming endpoints (e.g.,  [/v0/tts/stream/json](/reference/text-to-speech-tts/synthesize-json-streaming), [/v0/tts/stream/file](/reference/text-to-speech-tts/synthesize-file-streaming)).
+     * - Dynamic voice generation is not supported with this mode; a predefined [voice](/reference/text-to-speech-tts/synthesize-json-streaming#request.body.utterances.voice) must be specified in your request.
+     * - This mode is only supported for streaming endpoints (e.g., [/v0/tts/stream/json](/reference/text-to-speech-tts/synthesize-json-streaming), [/v0/tts/stream/file](/reference/text-to-speech-tts/synthesize-file-streaming)).
      * - Ensure only a single generation is requested ([num_generations](/reference/text-to-speech-tts/synthesize-json-streaming#request.body.num_generations) must be `1` or omitted).
      * - With `instant_mode` enabled, **requests incur a 10% higher cost** due to increased compute and resource requirements.
      */

package/api/resources/tts/types/PostedUtterance.d.ts

@@ -4,9 +4,9 @@
 import * as Hume from "../../../index";
 export interface PostedUtterance {
     /**
-     * Natural language instructions describing how the synthesized speech should sound, including  but not limited to tone, intonation, pacing, and accent (e.g., 'a soft, gentle voice with a strong British  accent').
-     * - If a Voice is specified in the request, this description serves as acting instructions. For  tips on how to effectively guide speech delivery, see our guide on [Acting instructions](/docs/text-to-speech-tts/acting-instructions).
-     *  - If no Voice is specified, a new voice is generated based on this description. See our [prompting guide](/docs/text-to-speech-tts/prompting)  for tips on designing a voice.
+     * Natural language instructions describing how the synthesized speech should sound, including but not limited to tone, intonation, pacing, and accent (e.g., 'a soft, gentle voice with a strong British accent').
+     * - If a Voice is specified in the request, this description serves as acting instructions. For tips on how to effectively guide speech delivery, see our guide on [Acting instructions](/docs/text-to-speech-tts/acting-instructions).
+     *  - If no Voice is specified, a new voice is generated based on this description. See our [prompting guide](/docs/text-to-speech-tts/prompting) for tips on designing a voice.
      */
     description?: string;
     /** Speed multiplier for the synthesized speech. */
@@ -16,9 +16,9 @@ export interface PostedUtterance {
     /** Duration of trailing silence (in seconds) to add to this utterance */
     trailingSilence?: number;
     /**
-     * The `name` or `id` associated with a **Voice** from the **Voice Library** to be used as the  speaker for this and all subsequent `utterances`, until the `voice` field is updated again.
+     * The `name` or `id` associated with a **Voice** from the **Voice Library** to be used as the speaker for this and all subsequent `utterances`, until the `voice` field is updated again.
      *
-     *  See our  [voices guide](/docs/text-to-speech-tts/voices) for more details on generating and specifying **Voices**.
+     *  See our [voices guide](/docs/text-to-speech-tts/voices) for more details on generating and specifying **Voices**.
      */
     voice?: Hume.tts.PostedUtteranceVoice;
 }

package/api/resources/tts/types/PostedUtteranceVoiceWithId.d.ts

@@ -3,18 +3,17 @@
  */
 import * as Hume from "../../../index";
 export interface PostedUtteranceVoiceWithId {
-    /** The ID of a **Voice** within the **Voice Library**. */
+    /** The unique ID associated with the **Voice**. */
     id: string;
     /**
-     * Specifies the provider of the voice associated with this voice ID.
+     * Specifies the source provider associated with the chosen voice.
      *
-     *  - **HUME_AI**:  Preset voices generated by Hume.
+     * - **`HUME_AI`**: Select voices from Hume's [Voice Library](https://platform.hume.ai/tts/voice-library), containing a variety of preset, shared voices.
+     * - **`CUSTOM_VOICE`**: Select from voices you've personally generated and saved in your account.
      *
-     *  - **CUSTOM_VOICE**: Voices you have generated and saved to your  `Voice library`.
+     * If no provider is explicitly set, the default provider is `CUSTOM_VOICE`. When using voices from Hume's **Voice Library**, you must explicitly set the provider to `HUME_AI`.
      *
-     *  If a provider is not specified, the provider will default to `CUSTOM_VOICE`.
-     *
-     *   While Hume's preset voices are shared and usable by anyone, your custom voices are only available to calls  made with your API key.
+     * Preset voices from Hume's **Voice Library** are accessible by all users. In contrast, your custom voices are private and accessible only via requests authenticated with your API key.
      */
     provider?: Hume.tts.VoiceProvider;
 }

package/api/resources/tts/types/PostedUtteranceVoiceWithName.d.ts

@@ -3,18 +3,17 @@
  */
 import * as Hume from "../../../index";
 export interface PostedUtteranceVoiceWithName {
-    /** The name of a **Voice** within the **Voice Library**. */
+    /** The name of a **Voice**. */
     name: string;
     /**
-     * Specifies the provider of the voice associated with this voice name.
+     * Specifies the source provider associated with the chosen voice.
      *
-     *  - **HUME_AI**:  Preset voices generated by Hume.
+     * - **`HUME_AI`**: Select voices from Hume's [Voice Library](https://platform.hume.ai/tts/voice-library), containing a variety of preset, shared voices.
+     * - **`CUSTOM_VOICE`**: Select from voices you've personally generated and saved in your account.
      *
-     *  - **CUSTOM_VOICE**: Voices you have generated and saved to your  `Voice library`.
+     * If no provider is explicitly set, the default provider is `CUSTOM_VOICE`. When using voices from Hume's **Voice Library**, you must explicitly set the provider to `HUME_AI`.
      *
-     *  If a provider is not specified, the provider will default to `CUSTOM_VOICE`.
-     *
-     *   While Hume's preset voices are shared and usable by anyone, your custom voices are only available to calls  made with your API key.
+     * Preset voices from Hume's **Voice Library** are accessible by all users. In contrast, your custom voices are private and accessible only via requests authenticated with your API key.
      */
     provider?: Hume.tts.VoiceProvider;
 }

package/api/resources/tts/types/ReturnGeneration.d.ts

@@ -12,6 +12,6 @@ export interface ReturnGeneration {
     fileSize: number;
     /** A unique ID associated with this TTS generation that can be used as context for generating consistent speech style and prosody across multiple requests. */
     generationId: string;
-    /** A list of snippet groups where each group corresponds to an utterance in the request. Each  group contains segmented snippets that represent the original utterance divided into more natural-sounding units optimized for speech delivery. */
+    /** A list of snippet groups where each group corresponds to an utterance in the request. Each group contains segmented snippets that represent the original utterance divided into more natural-sounding units optimized for speech delivery. */
     snippets: Hume.tts.Snippet[][];
 }

package/api/resources/tts/types/ReturnTts.d.ts

@@ -4,6 +4,6 @@
 import * as Hume from "../../../index";
 export interface ReturnTts {
     generations: Hume.tts.ReturnGeneration[];
-    /** A unique ID associated with this request for tracking and troubleshooting. Use this ID when  contacting [support](/support) for troubleshooting assistance. */
+    /** A unique ID associated with this request for tracking and troubleshooting. Use this ID when contacting [support](/support) for troubleshooting assistance. */
     requestId?: string;
 }

package/api/resources/tts/types/ReturnVoice.d.ts

@@ -11,15 +11,9 @@ export interface ReturnVoice {
     /** Name of the voice in the `Voice Library`. */
     name?: string;
     /**
-     * Specifies the provider of the voice.
+     * The provider associated with the created voice.
      *
-     *  - **HUME_AI**:  Preset voices generated by Hume.
-     *
-     *  - **CUSTOM_VOICE**: Voices you have generated and saved to your  `Voice library`.
-     *
-     *  If a provider is not specified, the provider will default to `CUSTOM_VOICE`.
-     *
-     *   While Hume's preset voices are shared and usable by anyone, your custom voices are only available to calls  made with your API key.
+     * Voices created through this endpoint will always have the provider set to `CUSTOM_VOICE`, indicating a custom voice stored in your account.
      */
     provider?: Hume.tts.VoiceProvider;
 }

package/api/resources/tts/types/Snippet.d.ts

@@ -10,6 +10,8 @@ export interface Snippet {
     id: string;
     /** The text for this **Snippet**. */
     text: string;
+    /** The transcribed text of the generated audio. It is only present if `instant_mode` is set to `false`. */
+    transcribedText?: string;
     /** The index of the utterance in the request this snippet corresponds to. */
     utteranceIndex?: number;
 }

package/api/resources/tts/types/SnippetAudioChunk.d.ts

@@ -14,6 +14,8 @@ export interface SnippetAudioChunk {
     snippetId: string;
     /** The text of the parent snippet that this chunk corresponds to. */
     text: string;
+    /** The transcribed text of the generated audio of the parent snippet that this chunk corresponds to. It is only present if `instant_mode` is set to `false`. */
+    transcribedText?: string;
     /** The index of the utterance in the request that the parent snippet of this chunk corresponds to. */
     utteranceIndex?: number;
 }

package/core/fetcher/APIResponse.d.ts

@@ -1,10 +1,20 @@
+import { RawResponse } from "./RawResponse";
+/**
+ * The response of an API call.
+ * It is a successful response or a failed response.
+ */
 export type APIResponse<Success, Failure> = SuccessfulResponse<Success> | FailedResponse<Failure>;
 export interface SuccessfulResponse<T> {
     ok: true;
     body: T;
+    /**
+     * @deprecated Use `rawResponse` instead
+     */
     headers?: Record<string, any>;
+    rawResponse: RawResponse;
 }
 export interface FailedResponse<T> {
     ok: false;
     error: T;
+    rawResponse: RawResponse;
 }

package/core/fetcher/Fetcher.js

@@ -12,6 +12,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.fetcher = void 0;
 exports.fetcherImpl = fetcherImpl;
 const json_1 = require("../json");
+const RawResponse_1 = require("./RawResponse");
 const createRequestUrl_1 = require("./createRequestUrl");
 const getFetchFn_1 = require("./getFetchFn");
 const getRequestBody_1 = require("./getRequestBody");
@@ -47,6 +48,7 @@ function fetcherImpl(args) {
                     ok: true,
                     body: responseBody,
                     headers: response.headers,
+                    rawResponse: (0, RawResponse_1.toRawResponse)(response),
                 };
             }
             else {
@@ -57,6 +59,7 @@ function fetcherImpl(args) {
                         statusCode: response.status,
                         body: responseBody,
                     },
+                    rawResponse: (0, RawResponse_1.toRawResponse)(response),
                 };
             }
         }
@@ -68,6 +71,7 @@ function fetcherImpl(args) {
                         reason: "unknown",
                         errorMessage: "The user aborted a request",
                     },
+                    rawResponse: RawResponse_1.abortRawResponse,
                 };
             }
             else if (error instanceof Error && error.name === "AbortError") {
@@ -76,6 +80,7 @@ function fetcherImpl(args) {
                     error: {
                         reason: "timeout",
                     },
+                    rawResponse: RawResponse_1.abortRawResponse,
                 };
             }
             else if (error instanceof Error) {
@@ -85,6 +90,7 @@ function fetcherImpl(args) {
                         reason: "unknown",
                         errorMessage: error.message,
                     },
+                    rawResponse: RawResponse_1.unknownRawResponse,
                 };
             }
             return {
@@ -93,6 +99,7 @@ function fetcherImpl(args) {
                     reason: "unknown",
                     errorMessage: (0, json_1.toJson)(error),
                 },
+                rawResponse: RawResponse_1.unknownRawResponse,
             };
         }
     });

package/core/fetcher/Headers.d.ts

@@ -0,0 +1,2 @@
+declare let Headers: typeof globalThis.Headers;
+export { Headers };

package/core/fetcher/Headers.js

@@ -0,0 +1,84 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Headers = void 0;
+let Headers;
+if (typeof globalThis.Headers !== "undefined") {
+    exports.Headers = Headers = globalThis.Headers;
+}
+else {
+    exports.Headers = Headers = class Headers {
+        constructor(init) {
+            this.headers = new Map();
+            if (init) {
+                if (init instanceof Headers) {
+                    init.forEach((value, key) => this.append(key, value));
+                }
+                else if (Array.isArray(init)) {
+                    for (const [key, value] of init) {
+                        if (typeof key === "string" && typeof value === "string") {
+                            this.append(key, value);
+                        }
+                        else {
+                            throw new TypeError("Each header entry must be a [string, string] tuple");
+                        }
+                    }
+                }
+                else {
+                    for (const [key, value] of Object.entries(init)) {
+                        if (typeof value === "string") {
+                            this.append(key, value);
+                        }
+                        else {
+                            throw new TypeError("Header values must be strings");
+                        }
+                    }
+                }
+            }
+        }
+        append(name, value) {
+            const key = name.toLowerCase();
+            const existing = this.headers.get(key) || [];
+            this.headers.set(key, [...existing, value]);
+        }
+        delete(name) {
+            const key = name.toLowerCase();
+            this.headers.delete(key);
+        }
+        get(name) {
+            const key = name.toLowerCase();
+            const values = this.headers.get(key);
+            return values ? values.join(", ") : null;
+        }
+        has(name) {
+            const key = name.toLowerCase();
+            return this.headers.has(key);
+        }
+        set(name, value) {
+            const key = name.toLowerCase();
+            this.headers.set(key, [value]);
+        }
+        forEach(callbackfn, thisArg) {
+            const boundCallback = thisArg ? callbackfn.bind(thisArg) : callbackfn;
+            this.headers.forEach((values, key) => boundCallback(values.join(", "), key, this));
+        }
+        getSetCookie() {
+            return this.headers.get("set-cookie") || [];
+        }
+        *entries() {
+            for (const [key, values] of this.headers.entries()) {
+                yield [key, values.join(", ")];
+            }
+        }
+        *keys() {
+            yield* this.headers.keys();
+        }
+        *values() {
+            for (const values of this.headers.values()) {
+                yield values.join(", ");
+            }
+        }
+        [Symbol.iterator]() {
+            return this.entries();
+        }
+    };
+}

package/core/fetcher/HttpResponsePromise.d.ts

@@ -0,0 +1,58 @@
+import { WithRawResponse } from "./RawResponse";
+/**
+ * A promise that returns the parsed response and lets you retrieve the raw response too.
+ */
+export declare class HttpResponsePromise<T> extends Promise<T> {
+    private innerPromise;
+    private unwrappedPromise;
+    private constructor();
+    /**
+     * Creates an `HttpResponsePromise` from a function that returns a promise.
+     *
+     * @param fn - A function that returns a promise resolving to a `WithRawResponse` object.
+     * @param args - Arguments to pass to the function.
+     * @returns An `HttpResponsePromise` instance.
+     */
+    static fromFunction<F extends (...args: never[]) => Promise<WithRawResponse<T>>, T>(fn: F, ...args: Parameters<F>): HttpResponsePromise<T>;
+    /**
+     * Creates a function that returns an `HttpResponsePromise` from a function that returns a promise.
+     *
+     * @param fn - A function that returns a promise resolving to a `WithRawResponse` object.
+     * @returns A function that returns an `HttpResponsePromise` instance.
+     */
+    static interceptFunction<F extends (...args: never[]) => Promise<WithRawResponse<T>>, T = Awaited<ReturnType<F>>["data"]>(fn: F): (...args: Parameters<F>) => HttpResponsePromise<T>;
+    /**
+     * Creates an `HttpResponsePromise` from an existing promise.
+     *
+     * @param promise - A promise resolving to a `WithRawResponse` object.
+     * @returns An `HttpResponsePromise` instance.
+     */
+    static fromPromise<T>(promise: Promise<WithRawResponse<T>>): HttpResponsePromise<T>;
+    /**
+     * Creates an `HttpResponsePromise` from an executor function.
+     *
+     * @param executor - A function that takes resolve and reject callbacks to create a promise.
+     * @returns An `HttpResponsePromise` instance.
+     */
+    static fromExecutor<T>(executor: (resolve: (value: WithRawResponse<T>) => void, reject: (reason?: unknown) => void) => void): HttpResponsePromise<T>;
+    /**
+     * Creates an `HttpResponsePromise` from a resolved result.
+     *
+     * @param result - A `WithRawResponse` object to resolve immediately.
+     * @returns An `HttpResponsePromise` instance.
+     */
+    static fromResult<T>(result: WithRawResponse<T>): HttpResponsePromise<T>;
+    private unwrap;
+    /** @inheritdoc */
+    then<TResult1 = T, TResult2 = never>(onfulfilled?: ((value: T) => TResult1 | PromiseLike<TResult1>) | null, onrejected?: ((reason: unknown) => TResult2 | PromiseLike<TResult2>) | null): Promise<TResult1 | TResult2>;
+    /** @inheritdoc */
+    catch<TResult = never>(onrejected?: ((reason: unknown) => TResult | PromiseLike<TResult>) | null): Promise<T | TResult>;
+    /** @inheritdoc */
+    finally(onfinally?: (() => void) | null): Promise<T>;
+    /**
+     * Retrieves the data and raw response.
+     *
+     * @returns A promise resolving to a `WithRawResponse` object.
+     */
+    withRawResponse(): Promise<WithRawResponse<T>>;
+}