hume 0.11.1 → 0.11.3

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

@@ -52,6 +52,7 @@ exports.Tts = void 0;
 const environments = __importStar(require("../../../../environments"));
 const core = __importStar(require("../../../../core"));
 const Hume = __importStar(require("../../../index"));
+const headers_js_1 = require("../../../../core/headers.js");
 const serializers = __importStar(require("../../../../serialization/index"));
 const url_join_1 = __importDefault(require("url-join"));
 const errors = __importStar(require("../../../../errors/index"));
@@ -69,50 +70,64 @@ class Tts {
      *
      * The response includes the base64-encoded audio and metadata in JSON format.
      *
-     * @param {Hume.tts.PostedTts} request
+     * @param {Hume.tts.SynthesizeJsonRequest} request
      * @param {Tts.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Hume.tts.UnprocessableEntityError}
      *
      * @example
      *     await client.tts.synthesizeJson({
-     *         utterances: [{
-     *                 text: "Beauty is no quality in things themselves: It exists merely in the mind which contemplates them.",
-     *                 description: "Middle-aged masculine voice with a clear, rhythmic Scots lilt, rounded vowels, and a warm, steady tone with an articulate, academic quality."
-     *             }],
-     *         context: {
+     *         body: {
      *             utterances: [{
-     *                     text: "How can people see beauty so differently?",
-     *                     description: "A curious student with a clear and respectful tone, seeking clarification on Hume's ideas with a straightforward question."
-     *                 }]
-     *         },
-     *         format: {
-     *             type: "mp3"
-     *         },
-     *         numGenerations: 1
+     *                     text: "Beauty is no quality in things themselves: It exists merely in the mind which contemplates them.",
+     *                     description: "Middle-aged masculine voice with a clear, rhythmic Scots lilt, rounded vowels, and a warm, steady tone with an articulate, academic quality."
+     *                 }],
+     *             context: {
+     *                 utterances: [{
+     *                         text: "How can people see beauty so differently?",
+     *                         description: "A curious student with a clear and respectful tone, seeking clarification on Hume's ideas with a straightforward question."
+     *                     }]
+     *             },
+     *             format: {
+     *                 type: "mp3"
+     *             },
+     *             numGenerations: 1
+     *         }
      *     })
      */
     synthesizeJson(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__synthesizeJson(request, requestOptions));
+    }
+    __synthesizeJson(request, requestOptions) {
         return __awaiter(this, void 0, void 0, function* () {
-            var _a, _b, _c;
+            var _a, _b, _c, _d;
+            const { accessToken, body: _body } = request;
+            const _queryParams = {};
+            if (accessToken != null) {
+                _queryParams["access_token"] = accessToken;
+            }
             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"),
                 method: "POST",
-                headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "hume", "X-Fern-SDK-Version": "0.11.1", "User-Agent": "hume/0.11.1", "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: (0, headers_js_1.mergeHeaders)((_d = this._options) === null || _d === void 0 ? void 0 : _d.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)(Object.assign({}, (yield this._getCustomAuthorizationHeaders()))), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
                 contentType: "application/json",
+                queryParameters: _queryParams,
                 requestType: "json",
-                body: serializers.tts.PostedTts.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
+                body: serializers.tts.PostedTts.jsonOrThrow(_body, { unrecognizedObjectKeys: "strip" }),
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
                 maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
                 abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
             });
             if (_response.ok) {
-                return serializers.tts.ReturnTts.parseOrThrow(_response.body, {
-                    unrecognizedObjectKeys: "passthrough",
-                    allowUnrecognizedUnionMembers: true,
-                    allowUnrecognizedEnumValues: true,
-                    breadcrumbsPrefix: ["response"],
-                });
+                return {
+                    data: serializers.tts.ReturnTts.parseOrThrow(_response.body, {
+                        unrecognizedObjectKeys: "passthrough",
+                        allowUnrecognizedUnionMembers: true,
+                        allowUnrecognizedEnumValues: true,
+                        breadcrumbsPrefix: ["response"],
+                    }),
+                    rawResponse: _response.rawResponse,
+                };
             }
             if (_response.error.reason === "status-code") {
                 switch (_response.error.statusCode) {
@@ -122,11 +137,12 @@ class Tts {
                             allowUnrecognizedUnionMembers: true,
                             allowUnrecognizedEnumValues: true,
                             breadcrumbsPrefix: ["response"],
-                        }));
+                        }), _response.rawResponse);
                     default:
                         throw new errors.HumeError({
                             statusCode: _response.error.statusCode,
                             body: _response.error.body,
+                            rawResponse: _response.rawResponse,
                         });
                 }
             }
@@ -135,12 +151,14 @@ class Tts {
                     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.");
                 case "unknown":
                     throw new errors.HumeError({
                         message: _response.error.errorMessage,
+                        rawResponse: _response.rawResponse,
                     });
             }
         });
@@ -152,12 +170,15 @@ class Tts {
      * @throws {@link Hume.tts.UnprocessableEntityError}
      */
     synthesizeFile(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__synthesizeFile(request, requestOptions));
+    }
+    __synthesizeFile(request, requestOptions) {
         return __awaiter(this, void 0, void 0, function* () {
-            var _a, _b, _c;
+            var _a, _b, _c, _d;
             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/file"),
                 method: "POST",
-                headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "hume", "X-Fern-SDK-Version": "0.11.1", "User-Agent": "hume/0.11.1", "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: (0, headers_js_1.mergeHeaders)((_d = this._options) === null || _d === void 0 ? void 0 : _d.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)(Object.assign({}, (yield this._getCustomAuthorizationHeaders()))), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
                 contentType: "application/json",
                 requestType: "json",
                 body: serializers.tts.PostedTts.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
@@ -167,7 +188,7 @@ class Tts {
                 abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
             });
             if (_response.ok) {
-                return _response.body;
+                return { data: _response.body, rawResponse: _response.rawResponse };
             }
             if (_response.error.reason === "status-code") {
                 switch (_response.error.statusCode) {
@@ -177,11 +198,12 @@ class Tts {
                             allowUnrecognizedUnionMembers: true,
                             allowUnrecognizedEnumValues: true,
                             breadcrumbsPrefix: ["response"],
-                        }));
+                        }), _response.rawResponse);
                     default:
                         throw new errors.HumeError({
                             statusCode: _response.error.statusCode,
                             body: _response.error.body,
+                            rawResponse: _response.rawResponse,
                         });
                 }
             }
@@ -190,12 +212,14 @@ class Tts {
                     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/file.");
                 case "unknown":
                     throw new errors.HumeError({
                         message: _response.error.errorMessage,
+                        rawResponse: _response.rawResponse,
                     });
             }
         });
@@ -205,12 +229,15 @@ class Tts {
      * @throws {@link Hume.tts.UnprocessableEntityError}
      */
     synthesizeFileStreaming(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__synthesizeFileStreaming(request, requestOptions));
+    }
+    __synthesizeFileStreaming(request, requestOptions) {
         return __awaiter(this, void 0, void 0, function* () {
-            var _a, _b, _c;
+            var _a, _b, _c, _d;
             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/stream/file"),
                 method: "POST",
-                headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "hume", "X-Fern-SDK-Version": "0.11.1", "User-Agent": "hume/0.11.1", "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: (0, headers_js_1.mergeHeaders)((_d = this._options) === null || _d === void 0 ? void 0 : _d.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)(Object.assign({}, (yield this._getCustomAuthorizationHeaders()))), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
                 contentType: "application/json",
                 requestType: "json",
                 body: serializers.tts.PostedTts.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
@@ -220,7 +247,7 @@ class Tts {
                 abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
             });
             if (_response.ok) {
-                return _response.body;
+                return { data: _response.body, rawResponse: _response.rawResponse };
             }
             if (_response.error.reason === "status-code") {
                 switch (_response.error.statusCode) {
@@ -230,11 +257,12 @@ class Tts {
                             allowUnrecognizedUnionMembers: true,
                             allowUnrecognizedEnumValues: true,
                             breadcrumbsPrefix: ["response"],
-                        }));
+                        }), _response.rawResponse);
                     default:
                         throw new errors.HumeError({
                             statusCode: _response.error.statusCode,
                             body: _response.error.body,
+                            rawResponse: _response.rawResponse,
                         });
                 }
             }
@@ -243,12 +271,14 @@ class Tts {
                     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/stream/file.");
                 case "unknown":
                     throw new errors.HumeError({
                         message: _response.error.errorMessage,
+                        rawResponse: _response.rawResponse,
                     });
             }
         });
@@ -259,12 +289,15 @@ class Tts {
      * The response is a stream of JSON objects including audio encoded in base64.
      */
     synthesizeJsonStreaming(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__synthesizeJsonStreaming(request, requestOptions));
+    }
+    __synthesizeJsonStreaming(request, requestOptions) {
         return __awaiter(this, void 0, void 0, function* () {
-            var _a, _b, _c;
+            var _a, _b, _c, _d;
             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/stream/json"),
                 method: "POST",
-                headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "hume", "X-Fern-SDK-Version": "0.11.1", "User-Agent": "hume/0.11.1", "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: (0, headers_js_1.mergeHeaders)((_d = this._options) === null || _d === void 0 ? void 0 : _d.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)(Object.assign({}, (yield this._getCustomAuthorizationHeaders()))), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
                 contentType: "application/json",
                 requestType: "json",
                 body: serializers.tts.PostedTts.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
@@ -274,22 +307,25 @@ class Tts {
                 abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
             });
             if (_response.ok) {
-                return new core.Stream({
-                    stream: _response.body,
-                    parse: (data) => __awaiter(this, void 0, void 0, function* () {
-                        return serializers.tts.SnippetAudioChunk.parseOrThrow(data, {
-                            unrecognizedObjectKeys: "passthrough",
-                            allowUnrecognizedUnionMembers: true,
-                            allowUnrecognizedEnumValues: true,
-                            breadcrumbsPrefix: ["response"],
-                        });
+                return {
+                    data: new core.Stream({
+                        stream: _response.body,
+                        parse: (data) => __awaiter(this, void 0, void 0, function* () {
+                            return serializers.tts.SnippetAudioChunk.parseOrThrow(data, {
+                                unrecognizedObjectKeys: "passthrough",
+                                allowUnrecognizedUnionMembers: true,
+                                allowUnrecognizedEnumValues: true,
+                                breadcrumbsPrefix: ["response"],
+                            });
+                        }),
+                        signal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
+                        eventShape: {
+                            type: "json",
+                            messageTerminator: "\n",
+                        },
                     }),
-                    signal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
-                    eventShape: {
-                        type: "json",
-                        messageTerminator: "\n",
-                    },
-                });
+                    rawResponse: _response.rawResponse,
+                };
             }
             if (_response.error.reason === "status-code") {
                 switch (_response.error.statusCode) {
@@ -299,11 +335,12 @@ class Tts {
                             allowUnrecognizedUnionMembers: true,
                             allowUnrecognizedEnumValues: true,
                             breadcrumbsPrefix: ["response"],
-                        }));
+                        }), _response.rawResponse);
                     default:
                         throw new errors.HumeError({
                             statusCode: _response.error.statusCode,
                             body: _response.error.body,
+                            rawResponse: _response.rawResponse,
                         });
                 }
             }
@@ -312,12 +349,14 @@ class Tts {
                     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/stream/json.");
                 case "unknown":
                     throw new errors.HumeError({
                         message: _response.error.errorMessage,
+                        rawResponse: _response.rawResponse,
                     });
             }
         });

package/dist/api/resources/tts/client/index.d.ts

@@ -1 +1 @@
-export {};
+export * from "./requests";

package/dist/api/resources/tts/client/index.js

@@ -1,2 +1,17 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
 Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./requests"), exports);

package/dist/api/resources/tts/client/requests/SynthesizeJsonRequest.d.ts

@@ -0,0 +1,36 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Hume from "../../../../index";
+/**
+ * @example
+ *     {
+ *         body: {
+ *             utterances: [{
+ *                     text: "Beauty is no quality in things themselves: It exists merely in the mind which contemplates them.",
+ *                     description: "Middle-aged masculine voice with a clear, rhythmic Scots lilt, rounded vowels, and a warm, steady tone with an articulate, academic quality."
+ *                 }],
+ *             context: {
+ *                 utterances: [{
+ *                         text: "How can people see beauty so differently?",
+ *                         description: "A curious student with a clear and respectful tone, seeking clarification on Hume's ideas with a straightforward question."
+ *                     }]
+ *             },
+ *             format: {
+ *                 type: "mp3"
+ *             },
+ *             numGenerations: 1
+ *         }
+ *     }
+ */
+export interface SynthesizeJsonRequest {
+    /**
+     * Access token used for authenticating the client. If not provided, an `api_key` must be provided to authenticate.
+     *
+     * The access token is generated using both an API key and a Secret key, which provides an additional layer of security compared to using just an API key.
+     *
+     * For more details, refer to the [Authentication Strategies Guide](/docs/introduction/api-key#authentication-strategies).
+     */
+    accessToken?: string;
+    body: Hume.tts.PostedTts;
+}

package/dist/api/resources/tts/client/requests/SynthesizeJsonRequest.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/resources/tts/client/requests/index.d.ts

@@ -0,0 +1 @@
+export { type SynthesizeJsonRequest } from "./SynthesizeJsonRequest";

package/dist/api/resources/tts/client/requests/index.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/resources/tts/errors/BadRequestError.d.ts

@@ -3,6 +3,7 @@
  */
 import * as errors from "../../../../errors/index";
 import * as Hume from "../../../index";
+import * as core from "../../../../core";
 export declare class BadRequestError extends errors.HumeError {
-    constructor(body: Hume.tts.ErrorResponse);
+    constructor(body: Hume.tts.ErrorResponse, rawResponse?: core.RawResponse);
 }

package/dist/api/resources/tts/errors/BadRequestError.js

@@ -39,11 +39,12 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.BadRequestError = void 0;
 const errors = __importStar(require("../../../../errors/index"));
 class BadRequestError extends errors.HumeError {
-    constructor(body) {
+    constructor(body, rawResponse) {
         super({
             message: "BadRequestError",
             statusCode: 400,
             body: body,
+            rawResponse: rawResponse,
         });
         Object.setPrototypeOf(this, BadRequestError.prototype);
     }

package/dist/api/resources/tts/errors/UnprocessableEntityError.d.ts

@@ -3,6 +3,7 @@
  */
 import * as errors from "../../../../errors/index";
 import * as Hume from "../../../index";
+import * as core from "../../../../core";
 export declare class UnprocessableEntityError extends errors.HumeError {
-    constructor(body: Hume.tts.HttpValidationError);
+    constructor(body: Hume.tts.HttpValidationError, rawResponse?: core.RawResponse);
 }

package/dist/api/resources/tts/errors/UnprocessableEntityError.js

@@ -39,11 +39,12 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.UnprocessableEntityError = void 0;
 const errors = __importStar(require("../../../../errors/index"));
 class UnprocessableEntityError extends errors.HumeError {
-    constructor(body) {
+    constructor(body, rawResponse) {
         super({
             message: "UnprocessableEntityError",
             statusCode: 422,
             body: body,
+            rawResponse: rawResponse,
         });
         Object.setPrototypeOf(this, UnprocessableEntityError.prototype);
     }

package/dist/api/resources/tts/resources/voices/client/Client.d.ts

@@ -10,6 +10,8 @@ export declare namespace Voices {
         /** Specify a custom URL to connect the client to. */
         baseUrl?: core.Supplier<string>;
         apiKey?: core.Supplier<string | undefined>;
+        /** Additional headers to include in requests. */
+        headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
         fetcher?: core.FetchFunction;
     }
     interface RequestOptions {
@@ -20,7 +22,7 @@ export declare namespace Voices {
         /** A hook to abort the request. */
         abortSignal?: AbortSignal;
         /** Additional headers to include in the request. */
-        headers?: Record<string, string>;
+        headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
     }
 }
 export declare class Voices {
@@ -56,7 +58,8 @@ export declare class Voices {
      *         name: "David Hume"
      *     })
      */
-    create(request: Hume.tts.PostedVoice, requestOptions?: Voices.RequestOptions): Promise<Hume.tts.ReturnVoice>;
+    create(request: Hume.tts.PostedVoice, requestOptions?: Voices.RequestOptions): core.HttpResponsePromise<Hume.tts.ReturnVoice>;
+    private __create;
     /**
      * Deletes a previously generated custom voice.
      *
@@ -70,7 +73,8 @@ export declare class Voices {
      *         name: "David Hume"
      *     })
      */
-    delete(request: Hume.tts.VoicesDeleteRequest, requestOptions?: Voices.RequestOptions): Promise<void>;
+    delete(request: Hume.tts.VoicesDeleteRequest, requestOptions?: Voices.RequestOptions): core.HttpResponsePromise<void>;
+    private __delete;
     protected _getCustomAuthorizationHeaders(): Promise<{
         "X-Hume-Api-Key": string | undefined;
     }>;