hume 0.5.9 → 0.5.13

package/api/resources/empathicVoice/resources/configs/client/Client.js

@@ -42,12 +42,19 @@ exports.Configs = void 0;
 const environments = __importStar(require("../../../../../../environments"));
 const core = __importStar(require("../../../../../../core"));
 const url_join_1 = __importDefault(require("url-join"));
-const serializers = __importStar(require("../../../../../../serialization"));
-const errors = __importStar(require("../../../../../../errors"));
+const serializers = __importStar(require("../../../../../../serialization/index"));
+const errors = __importStar(require("../../../../../../errors/index"));
 class Configs {
     constructor(_options = {}) {
         this._options = _options;
     }
+    /**
+     * @param {Hume.empathicVoice.GetReturnConfigsForUserRequest} request
+     * @param {Configs.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await hume.empathicVoice.configs.getReturnConfigsForUser()
+     */
     getReturnConfigsForUser(request = {}, requestOptions) {
         var _a, _b;
         return __awaiter(this, void 0, void 0, function* () {
@@ -67,7 +74,7 @@ class Configs {
                 method: "GET",
                 headers: Object.assign({ "X-Account-Token": (yield core.Supplier.get(this._options.accountToken)) != null
                         ? yield core.Supplier.get(this._options.accountToken)
-                        : undefined, "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "hume", "X-Fern-SDK-Version": "0.5.8", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
+                        : undefined, "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "hume", "X-Fern-SDK-Version": "0.5.13", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: "application/json",
                 queryParameters: _queryParams,
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -103,6 +110,15 @@ class Configs {
             }
         });
     }
+    /**
+     * @param {Hume.empathicVoice.PostedConfig} request
+     * @param {Configs.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await hume.empathicVoice.configs.createNewConfig({
+     *         name: "name"
+     *     })
+     */
     createNewConfig(request, requestOptions) {
         var _a, _b;
         return __awaiter(this, void 0, void 0, function* () {
@@ -111,7 +127,7 @@ class Configs {
                 method: "POST",
                 headers: Object.assign({ "X-Account-Token": (yield core.Supplier.get(this._options.accountToken)) != null
                         ? yield core.Supplier.get(this._options.accountToken)
-                        : undefined, "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "hume", "X-Fern-SDK-Version": "0.5.8", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
+                        : undefined, "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "hume", "X-Fern-SDK-Version": "0.5.13", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: "application/json",
                 body: yield serializers.empathicVoice.PostedConfig.jsonOrThrow(request, {
                     unrecognizedObjectKeys: "strip",
@@ -149,6 +165,14 @@ class Configs {
             }
         });
     }
+    /**
+     * @param {string} id - Identifier for a config. Formatted as a UUID.
+     * @param {Hume.empathicVoice.GetReturnConfigByVersionIdRequest} request
+     * @param {Configs.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await hume.empathicVoice.configs.getReturnConfigByVersionId("id")
+     */
     getReturnConfigByVersionId(id, request = {}, requestOptions) {
         var _a, _b;
         return __awaiter(this, void 0, void 0, function* () {
@@ -164,11 +188,11 @@ class Configs {
                 _queryParams["restrict_to_most_recent"] = restrictToMostRecent.toString();
             }
             const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
-                url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.HumeEnvironment.Production, `configs/${id}`),
+                url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.HumeEnvironment.Production, `configs/${encodeURIComponent(id)}`),
                 method: "GET",
                 headers: Object.assign({ "X-Account-Token": (yield core.Supplier.get(this._options.accountToken)) != null
                         ? yield core.Supplier.get(this._options.accountToken)
-                        : undefined, "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "hume", "X-Fern-SDK-Version": "0.5.8", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
+                        : undefined, "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "hume", "X-Fern-SDK-Version": "0.5.13", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: "application/json",
                 queryParameters: _queryParams,
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -204,15 +228,23 @@ class Configs {
             }
         });
     }
+    /**
+     * @param {string} id - Identifier for a config. Formatted as a UUID.
+     * @param {Hume.empathicVoice.PostedConfigVersion} request
+     * @param {Configs.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await hume.empathicVoice.configs.addNewConfigVersion("id")
+     */
     addNewConfigVersion(id, request = {}, requestOptions) {
         var _a, _b;
         return __awaiter(this, void 0, void 0, function* () {
             const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
-                url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.HumeEnvironment.Production, `configs/${id}`),
+                url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.HumeEnvironment.Production, `configs/${encodeURIComponent(id)}`),
                 method: "POST",
                 headers: Object.assign({ "X-Account-Token": (yield core.Supplier.get(this._options.accountToken)) != null
                         ? yield core.Supplier.get(this._options.accountToken)
-                        : undefined, "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "hume", "X-Fern-SDK-Version": "0.5.8", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
+                        : undefined, "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "hume", "X-Fern-SDK-Version": "0.5.13", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: "application/json",
                 body: yield serializers.empathicVoice.PostedConfigVersion.jsonOrThrow(request, {
                     unrecognizedObjectKeys: "strip",
@@ -250,15 +282,22 @@ class Configs {
             }
         });
     }
+    /**
+     * @param {string} id - Identifier for a config. Formatted as a UUID.
+     * @param {Configs.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await hume.empathicVoice.configs.deleteConfig("id")
+     */
     deleteConfig(id, requestOptions) {
         var _a, _b;
         return __awaiter(this, void 0, void 0, function* () {
             const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
-                url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.HumeEnvironment.Production, `configs/${id}`),
+                url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.HumeEnvironment.Production, `configs/${encodeURIComponent(id)}`),
                 method: "DELETE",
                 headers: Object.assign({ "X-Account-Token": (yield core.Supplier.get(this._options.accountToken)) != null
                         ? yield core.Supplier.get(this._options.accountToken)
-                        : undefined, "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "hume", "X-Fern-SDK-Version": "0.5.8", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
+                        : undefined, "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "hume", "X-Fern-SDK-Version": "0.5.13", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: "application/json",
                 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,
@@ -287,24 +326,35 @@ class Configs {
             }
         });
     }
+    /**
+     * @param {string} id - Identifier for a config. Formatted as a UUID.
+     * @param {Hume.empathicVoice.PostedConfigName} request
+     * @param {Configs.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await hume.empathicVoice.configs.updateConfigName("string", {
+     *         name: "string"
+     *     })
+     */
     updateConfigName(id, request, requestOptions) {
         var _a, _b;
         return __awaiter(this, void 0, void 0, function* () {
             const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
-                url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.HumeEnvironment.Production, `configs/${id}`),
+                url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.HumeEnvironment.Production, `configs/${encodeURIComponent(id)}`),
                 method: "PATCH",
                 headers: Object.assign({ "X-Account-Token": (yield core.Supplier.get(this._options.accountToken)) != null
                         ? yield core.Supplier.get(this._options.accountToken)
-                        : undefined, "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "hume", "X-Fern-SDK-Version": "0.5.8", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
+                        : undefined, "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "hume", "X-Fern-SDK-Version": "0.5.13", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: "application/json",
                 body: yield serializers.empathicVoice.PostedConfigName.jsonOrThrow(request, {
                     unrecognizedObjectKeys: "strip",
                 }),
+                responseType: "text",
                 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,
             });
             if (_response.ok) {
-                return;
+                return _response.body;
             }
             if (_response.error.reason === "status-code") {
                 throw new errors.HumeError({
@@ -327,15 +377,23 @@ class Configs {
             }
         });
     }
+    /**
+     * @param {string} id - Identifier for a config. Formatted as a UUID.
+     * @param {number} version - Version number for a config. Version numbers should be integers.
+     * @param {Configs.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await hume.empathicVoice.configs.getReturnPromptByRevisionId("id", 1)
+     */
     getReturnPromptByRevisionId(id, version, requestOptions) {
         var _a, _b;
         return __awaiter(this, void 0, void 0, function* () {
             const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
-                url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.HumeEnvironment.Production, `configs/${id}/version/${version}`),
+                url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.HumeEnvironment.Production, `configs/${encodeURIComponent(id)}/version/${encodeURIComponent(version)}`),
                 method: "GET",
                 headers: Object.assign({ "X-Account-Token": (yield core.Supplier.get(this._options.accountToken)) != null
                         ? yield core.Supplier.get(this._options.accountToken)
-                        : undefined, "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "hume", "X-Fern-SDK-Version": "0.5.8", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
+                        : undefined, "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "hume", "X-Fern-SDK-Version": "0.5.13", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: "application/json",
                 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,
@@ -370,15 +428,23 @@ class Configs {
             }
         });
     }
+    /**
+     * @param {string} id - Identifier for a config. Formatted as a UUID.
+     * @param {number} version - Version number for a config. Version numbers should be integers.
+     * @param {Configs.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await hume.empathicVoice.configs.deleteConfigVersion("id", 1)
+     */
     deleteConfigVersion(id, version, requestOptions) {
         var _a, _b;
         return __awaiter(this, void 0, void 0, function* () {
             const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
-                url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.HumeEnvironment.Production, `configs/${id}/version/${version}`),
+                url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.HumeEnvironment.Production, `configs/${encodeURIComponent(id)}/version/${encodeURIComponent(version)}`),
                 method: "DELETE",
                 headers: Object.assign({ "X-Account-Token": (yield core.Supplier.get(this._options.accountToken)) != null
                         ? yield core.Supplier.get(this._options.accountToken)
-                        : undefined, "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "hume", "X-Fern-SDK-Version": "0.5.8", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
+                        : undefined, "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "hume", "X-Fern-SDK-Version": "0.5.13", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: "application/json",
                 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,
@@ -407,15 +473,24 @@ class Configs {
             }
         });
     }
+    /**
+     * @param {string} id - Identifier for a config. Formatted as a UUID.
+     * @param {number} version - Version number for a config. Version numbers should be integers.
+     * @param {Hume.empathicVoice.PostedConfigVersionDescription} request
+     * @param {Configs.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await hume.empathicVoice.configs.updateConfigVersionDescription("id", 1)
+     */
     updateConfigVersionDescription(id, version, request = {}, requestOptions) {
         var _a, _b;
         return __awaiter(this, void 0, void 0, function* () {
             const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
-                url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.HumeEnvironment.Production, `configs/${id}/version/${version}`),
+                url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.HumeEnvironment.Production, `configs/${encodeURIComponent(id)}/version/${encodeURIComponent(version)}`),
                 method: "PATCH",
                 headers: Object.assign({ "X-Account-Token": (yield core.Supplier.get(this._options.accountToken)) != null
                         ? yield core.Supplier.get(this._options.accountToken)
-                        : undefined, "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "hume", "X-Fern-SDK-Version": "0.5.8", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
+                        : undefined, "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "hume", "X-Fern-SDK-Version": "0.5.13", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: "application/json",
                 body: yield serializers.empathicVoice.PostedConfigVersionDescription.jsonOrThrow(request, {
                     unrecognizedObjectKeys: "strip",

package/api/resources/empathicVoice/resources/configs/client/requests/PostedConfig.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Hume from "../../../../../..";
+import * as Hume from "../../../../../../index";
 /**
  * @example
  *     {
@@ -15,4 +15,8 @@ export interface PostedConfig {
     versionDescription?: string;
     prompt?: Hume.empathicVoice.PostedPromptSpec;
     languageModel?: Hume.empathicVoice.PostedLanguageModel;
+    /** Tool specification for a Config. */
+    tools?: (Hume.empathicVoice.PostedUserDefinedToolSpec | undefined)[];
+    /** Built-in tool specification for a Config. */
+    builtinTools?: (Hume.empathicVoice.PostedBuiltinTool | undefined)[];
 }

package/api/resources/empathicVoice/resources/configs/client/requests/PostedConfigName.d.ts

@@ -4,7 +4,7 @@
 /**
  * @example
  *     {
- *         name: "name"
+ *         name: "string"
  *     }
  */
 export interface PostedConfigName {

package/api/resources/empathicVoice/resources/configs/client/requests/PostedConfigVersion.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Hume from "../../../../../..";
+import * as Hume from "../../../../../../index";
 /**
  * @example
  *     {}
@@ -11,4 +11,8 @@ export interface PostedConfigVersion {
     versionDescription?: string;
     prompt?: Hume.empathicVoice.PostedPromptSpec;
     languageModel?: Hume.empathicVoice.PostedLanguageModel;
+    /** Tool specification for a Config. */
+    tools?: (Hume.empathicVoice.PostedUserDefinedToolSpec | undefined)[];
+    /** Built-in tool specification for a Config. */
+    builtinTools?: (Hume.empathicVoice.PostedBuiltinTool | undefined)[];
 }

package/api/resources/empathicVoice/resources/configs/client/requests/index.d.ts

@@ -1,6 +1,6 @@
-export { GetReturnConfigsForUserRequest } from "./GetReturnConfigsForUserRequest";
-export { PostedConfig } from "./PostedConfig";
-export { GetReturnConfigByVersionIdRequest } from "./GetReturnConfigByVersionIdRequest";
-export { PostedConfigVersion } from "./PostedConfigVersion";
-export { PostedConfigName } from "./PostedConfigName";
-export { PostedConfigVersionDescription } from "./PostedConfigVersionDescription";
+export { type GetReturnConfigsForUserRequest } from "./GetReturnConfigsForUserRequest";
+export { type PostedConfig } from "./PostedConfig";
+export { type GetReturnConfigByVersionIdRequest } from "./GetReturnConfigByVersionIdRequest";
+export { type PostedConfigVersion } from "./PostedConfigVersion";
+export { type PostedConfigName } from "./PostedConfigName";
+export { type PostedConfigVersionDescription } from "./PostedConfigVersionDescription";

package/api/resources/empathicVoice/resources/index.d.ts

@@ -1,8 +1,10 @@
 export * as chat from "./chat";
 export * from "./chat/types";
+export * as tools from "./tools";
 export * as prompts from "./prompts";
 export * as configs from "./configs";
 export * as chats from "./chats";
+export * from "./tools/client/requests";
 export * from "./prompts/client/requests";
 export * from "./configs/client/requests";
 export * from "./chats/client/requests";

package/api/resources/empathicVoice/resources/index.js

@@ -26,12 +26,14 @@ 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 });
-exports.chats = exports.configs = exports.prompts = exports.chat = void 0;
+exports.chats = exports.configs = exports.prompts = exports.tools = exports.chat = void 0;
 exports.chat = __importStar(require("./chat"));
 __exportStar(require("./chat/types"), exports);
+exports.tools = __importStar(require("./tools"));
 exports.prompts = __importStar(require("./prompts"));
 exports.configs = __importStar(require("./configs"));
 exports.chats = __importStar(require("./chats"));
+__exportStar(require("./tools/client/requests"), exports);
 __exportStar(require("./prompts/client/requests"), exports);
 __exportStar(require("./configs/client/requests"), exports);
 __exportStar(require("./chats/client/requests"), exports);

package/api/resources/empathicVoice/resources/prompts/client/Client.d.ts

@@ -3,7 +3,7 @@
  */
 import * as environments from "../../../../../../environments";
 import * as core from "../../../../../../core";
-import * as Hume from "../../../../..";
+import * as Hume from "../../../../../index";
 export declare namespace Prompts {
     interface Options {
         environment?: core.Supplier<environments.HumeEnvironment | string>;
@@ -19,14 +19,91 @@ export declare namespace Prompts {
 export declare class Prompts {
     protected readonly _options: Prompts.Options;
     constructor(_options?: Prompts.Options);
+    /**
+     * @param {Hume.empathicVoice.GetReturnPromptsForUserRequest} request
+     * @param {Prompts.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await hume.empathicVoice.prompts.getReturnPromptsForUser()
+     */
     getReturnPromptsForUser(request?: Hume.empathicVoice.GetReturnPromptsForUserRequest, requestOptions?: Prompts.RequestOptions): Promise<Hume.empathicVoice.ReturnPagedPrompts>;
+    /**
+     * @param {Hume.empathicVoice.PostedPrompt} request
+     * @param {Prompts.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await hume.empathicVoice.prompts.createNewPrompt({
+     *         name: "name",
+     *         text: "text"
+     *     })
+     */
     createNewPrompt(request: Hume.empathicVoice.PostedPrompt, requestOptions?: Prompts.RequestOptions): Promise<Hume.empathicVoice.ReturnPrompt | undefined>;
+    /**
+     * @param {string} id
+     * @param {Hume.empathicVoice.GetReturnPromptByPromptIdRequest} request
+     * @param {Prompts.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await hume.empathicVoice.prompts.getReturnPromptByPromptId("id")
+     */
     getReturnPromptByPromptId(id: string, request?: Hume.empathicVoice.GetReturnPromptByPromptIdRequest, requestOptions?: Prompts.RequestOptions): Promise<Hume.empathicVoice.ReturnPagedPrompts>;
+    /**
+     * @param {string} id - Identifier for a prompt. Formatted as a UUID.
+     * @param {Hume.empathicVoice.PostedPromptVersion} request
+     * @param {Prompts.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await hume.empathicVoice.prompts.addNewPromptVersion("id", {
+     *         text: "text"
+     *     })
+     */
     addNewPromptVersion(id: string, request: Hume.empathicVoice.PostedPromptVersion, requestOptions?: Prompts.RequestOptions): Promise<Hume.empathicVoice.ReturnPrompt | undefined>;
+    /**
+     * @param {string} id - Identifier for a prompt. Formatted as a UUID.
+     * @param {Prompts.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await hume.empathicVoice.prompts.deletePromptVersion("id")
+     */
     deletePromptVersion(id: string, requestOptions?: Prompts.RequestOptions): Promise<void>;
-    updatePromptName(id: string, request: Hume.empathicVoice.PostedPromptName, requestOptions?: Prompts.RequestOptions): Promise<void>;
+    /**
+     * @param {string} id - Identifier for a prompt. Formatted as a UUID.
+     * @param {Hume.empathicVoice.PostedPromptName} request
+     * @param {Prompts.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await hume.empathicVoice.prompts.updatePromptName("string", {
+     *         name: "string"
+     *     })
+     */
+    updatePromptName(id: string, request: Hume.empathicVoice.PostedPromptName, requestOptions?: Prompts.RequestOptions): Promise<string>;
+    /**
+     * @param {string} id - Identifier for a prompt. Formatted as a UUID.
+     * @param {number} version - Version number for a prompt. Version numbers should be integers.
+     * @param {Prompts.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await hume.empathicVoice.prompts.getReturnPromptByVersionNumber("id", 1)
+     */
     getReturnPromptByVersionNumber(id: string, version: number, requestOptions?: Prompts.RequestOptions): Promise<Hume.empathicVoice.ReturnPrompt | undefined>;
+    /**
+     * @param {string} id - Identifier for a prompt. Formatted as a UUID.
+     * @param {number} version - Version number for a prompt. Version numbers should be integers.
+     * @param {Prompts.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await hume.empathicVoice.prompts.deletePromptVersion1("id", 1)
+     */
     deletePromptVersion1(id: string, version: number, requestOptions?: Prompts.RequestOptions): Promise<void>;
+    /**
+     * @param {string} id - Identifier for a prompt. Formatted as a UUID.
+     * @param {number} version - Version number for a prompt. Version numbers should be integers.
+     * @param {Hume.empathicVoice.PostedPromptVersionDescription} request
+     * @param {Prompts.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await hume.empathicVoice.prompts.updatePromptVersionDescription("id", 1)
+     */
     updatePromptVersionDescription(id: string, version: number, request?: Hume.empathicVoice.PostedPromptVersionDescription, requestOptions?: Prompts.RequestOptions): Promise<Hume.empathicVoice.ReturnPrompt | undefined>;
     protected _getCustomAuthorizationHeaders(): Promise<{
         "X-Hume-Api-Key": string | undefined;