hume 0.8.10 → 0.9.0

package/api/resources/empathicVoice/resources/chatGroups/client/requests/ChatGroupsGetChatGroupRequest.d.ts

@@ -0,0 +1,29 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * @example
+ *     {
+ *         pageNumber: 0,
+ *         pageSize: 1,
+ *         ascendingOrder: true
+ *     }
+ */
+export interface ChatGroupsGetChatGroupRequest {
+    /**
+     * Specifies the maximum number of results to include per page, enabling pagination. The value must be between 1 and 100, inclusive.
+     *
+     * For example, if `page_size` is set to 10, each page will include up to 10 items. Defaults to 10.
+     */
+    pageSize?: number;
+    /**
+     * Specifies the page number to retrieve, enabling pagination.
+     *
+     * This parameter uses zero-based indexing. For example, setting `page_number` to 0 retrieves the first page of results (items 0-9 if `page_size` is 10), setting `page_number` to 1 retrieves the second page (items 10-19), and so on. Defaults to 0, which retrieves the first page.
+     */
+    pageNumber?: number;
+    /**
+     * Specifies the sorting order of the results based on their creation date. Set to true for ascending order (chronological, with the oldest records first) and false for descending order (reverse-chronological, with the newest records first). Defaults to true.
+     */
+    ascendingOrder?: boolean;
+}

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

@@ -1,2 +1,3 @@
 export { type ChatGroupsListChatGroupsRequest } from "./ChatGroupsListChatGroupsRequest";
+export { type ChatGroupsGetChatGroupRequest } from "./ChatGroupsGetChatGroupRequest";
 export { type ChatGroupsListChatGroupEventsRequest } from "./ChatGroupsListChatGroupEventsRequest";

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

@@ -23,9 +23,13 @@ export declare class Chats {
     protected readonly _options: Chats.Options;
     constructor(_options?: Chats.Options);
     /**
+     * Fetches a paginated list of **Chats**.
+     *
      * @param {Hume.empathicVoice.ChatsListChatsRequest} request
      * @param {Chats.RequestOptions} requestOptions - Request-specific configuration.
      *
+     * @throws {@link Hume.empathicVoice.BadRequestError}
+     *
      * @example
      *     await client.empathicVoice.chats.listChats({
      *         pageNumber: 0,
@@ -35,10 +39,14 @@ export declare class Chats {
      */
     listChats(request?: Hume.empathicVoice.ChatsListChatsRequest, requestOptions?: Chats.RequestOptions): Promise<core.Page<Hume.empathicVoice.ReturnChat>>;
     /**
+     * Fetches a paginated list of **Chat** events.
+     *
      * @param {string} id - Identifier for a Chat. Formatted as a UUID.
      * @param {Hume.empathicVoice.ChatsListChatEventsRequest} request
      * @param {Chats.RequestOptions} requestOptions - Request-specific configuration.
      *
+     * @throws {@link Hume.empathicVoice.BadRequestError}
+     *
      * @example
      *     await client.empathicVoice.chats.listChatEvents("470a49f6-1dec-4afe-8b61-035d3b2d63b0", {
      *         pageNumber: 0,

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

@@ -41,6 +41,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Chats = void 0;
 const environments = __importStar(require("../../../../../../environments"));
 const core = __importStar(require("../../../../../../core"));
+const Hume = __importStar(require("../../../../../index"));
 const url_join_1 = __importDefault(require("url-join"));
 const serializers = __importStar(require("../../../../../../serialization/index"));
 const errors = __importStar(require("../../../../../../errors/index"));
@@ -49,9 +50,13 @@ class Chats {
         this._options = _options;
     }
     /**
+     * Fetches a paginated list of **Chats**.
+     *
      * @param {Hume.empathicVoice.ChatsListChatsRequest} request
      * @param {Chats.RequestOptions} requestOptions - Request-specific configuration.
      *
+     * @throws {@link Hume.empathicVoice.BadRequestError}
+     *
      * @example
      *     await client.empathicVoice.chats.listChats({
      *         pageNumber: 0,
@@ -77,7 +82,7 @@ class Chats {
                 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, "v0/evi/chats"),
                     method: "GET",
-                    headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "hume", "X-Fern-SDK-Version": "0.8.9", "User-Agent": "hume/0.8.9", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
+                    headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "hume", "X-Fern-SDK-Version": "0.8.11", "User-Agent": "hume/0.8.11", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                     contentType: "application/json",
                     queryParameters: _queryParams,
                     requestType: "json",
@@ -94,10 +99,20 @@ class Chats {
                     });
                 }
                 if (_response.error.reason === "status-code") {
-                    throw new errors.HumeError({
-                        statusCode: _response.error.statusCode,
-                        body: _response.error.body,
-                    });
+                    switch (_response.error.statusCode) {
+                        case 400:
+                            throw new Hume.empathicVoice.BadRequestError(serializers.empathicVoice.ErrorResponse.parseOrThrow(_response.error.body, {
+                                unrecognizedObjectKeys: "passthrough",
+                                allowUnrecognizedUnionMembers: true,
+                                allowUnrecognizedEnumValues: true,
+                                breadcrumbsPrefix: ["response"],
+                            }));
+                        default:
+                            throw new errors.HumeError({
+                                statusCode: _response.error.statusCode,
+                                body: _response.error.body,
+                            });
+                    }
                 }
                 switch (_response.error.reason) {
                     case "non-json":
@@ -126,10 +141,14 @@ class Chats {
         });
     }
     /**
+     * Fetches a paginated list of **Chat** events.
+     *
      * @param {string} id - Identifier for a Chat. Formatted as a UUID.
      * @param {Hume.empathicVoice.ChatsListChatEventsRequest} request
      * @param {Chats.RequestOptions} requestOptions - Request-specific configuration.
      *
+     * @throws {@link Hume.empathicVoice.BadRequestError}
+     *
      * @example
      *     await client.empathicVoice.chats.listChatEvents("470a49f6-1dec-4afe-8b61-035d3b2d63b0", {
      *         pageNumber: 0,
@@ -155,7 +174,7 @@ class Chats {
                 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, `v0/evi/chats/${encodeURIComponent(id)}`),
                     method: "GET",
-                    headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "hume", "X-Fern-SDK-Version": "0.8.9", "User-Agent": "hume/0.8.9", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
+                    headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "hume", "X-Fern-SDK-Version": "0.8.11", "User-Agent": "hume/0.8.11", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                     contentType: "application/json",
                     queryParameters: _queryParams,
                     requestType: "json",
@@ -172,10 +191,20 @@ class Chats {
                     });
                 }
                 if (_response.error.reason === "status-code") {
-                    throw new errors.HumeError({
-                        statusCode: _response.error.statusCode,
-                        body: _response.error.body,
-                    });
+                    switch (_response.error.statusCode) {
+                        case 400:
+                            throw new Hume.empathicVoice.BadRequestError(serializers.empathicVoice.ErrorResponse.parseOrThrow(_response.error.body, {
+                                unrecognizedObjectKeys: "passthrough",
+                                allowUnrecognizedUnionMembers: true,
+                                allowUnrecognizedEnumValues: true,
+                                breadcrumbsPrefix: ["response"],
+                            }));
+                        default:
+                            throw new errors.HumeError({
+                                statusCode: _response.error.statusCode,
+                                body: _response.error.body,
+                            });
+                    }
                 }
                 switch (_response.error.reason) {
                     case "non-json":

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

@@ -23,9 +23,15 @@ export declare class Configs {
     protected readonly _options: Configs.Options;
     constructor(_options?: Configs.Options);
     /**
+     * Fetches a paginated list of **Configs**.
+     *
+     * For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/empathic-voice-interface-evi/configuration).
+     *
      * @param {Hume.empathicVoice.ConfigsListConfigsRequest} request
      * @param {Configs.RequestOptions} requestOptions - Request-specific configuration.
      *
+     * @throws {@link Hume.empathicVoice.BadRequestError}
+     *
      * @example
      *     await client.empathicVoice.configs.listConfigs({
      *         pageNumber: 0,
@@ -34,9 +40,15 @@ export declare class Configs {
      */
     listConfigs(request?: Hume.empathicVoice.ConfigsListConfigsRequest, requestOptions?: Configs.RequestOptions): Promise<Hume.empathicVoice.ReturnPagedConfigs>;
     /**
+     * Creates a **Config** which can be applied to EVI.
+     *
+     * For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/empathic-voice-interface-evi/configuration).
+     *
      * @param {Hume.empathicVoice.PostedConfig} request
      * @param {Configs.RequestOptions} requestOptions - Request-specific configuration.
      *
+     * @throws {@link Hume.empathicVoice.BadRequestError}
+     *
      * @example
      *     await client.empathicVoice.configs.createConfig({
      *         name: "Weather Assistant Config",
@@ -44,9 +56,10 @@ export declare class Configs {
      *             id: "af699d45-2985-42cc-91b9-af9e5da3bac5",
      *             version: 0
      *         },
+     *         eviVersion: "2",
      *         voice: {
      *             provider: "HUME_AI",
-     *             name: Hume.empathicVoice.PostedVoiceName.Kora
+     *             name: "SAMPLE VOICE"
      *         },
      *         languageModel: {
      *             modelProvider: Hume.empathicVoice.PostedLanguageModelModelProvider.Anthropic,
@@ -71,29 +84,42 @@ export declare class Configs {
      */
     createConfig(request: Hume.empathicVoice.PostedConfig, requestOptions?: Configs.RequestOptions): Promise<Hume.empathicVoice.ReturnConfig>;
     /**
+     * Fetches a list of a **Config's** versions.
+     *
+     * For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/empathic-voice-interface-evi/configuration).
+     *
      * @param {string} id - Identifier for a Config. Formatted as a UUID.
      * @param {Hume.empathicVoice.ConfigsListConfigVersionsRequest} request
      * @param {Configs.RequestOptions} requestOptions - Request-specific configuration.
      *
+     * @throws {@link Hume.empathicVoice.BadRequestError}
+     *
      * @example
      *     await client.empathicVoice.configs.listConfigVersions("1b60e1a0-cc59-424a-8d2c-189d354db3f3")
      */
     listConfigVersions(id: string, request?: Hume.empathicVoice.ConfigsListConfigVersionsRequest, requestOptions?: Configs.RequestOptions): Promise<Hume.empathicVoice.ReturnPagedConfigs>;
     /**
+     * Updates a **Config** by creating a new version of the **Config**.
+     *
+     * For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/empathic-voice-interface-evi/configuration).
+     *
      * @param {string} id - Identifier for a Config. Formatted as a UUID.
      * @param {Hume.empathicVoice.PostedConfigVersion} request
      * @param {Configs.RequestOptions} requestOptions - Request-specific configuration.
      *
+     * @throws {@link Hume.empathicVoice.BadRequestError}
+     *
      * @example
      *     await client.empathicVoice.configs.createConfigVersion("1b60e1a0-cc59-424a-8d2c-189d354db3f3", {
      *         versionDescription: "This is an updated version of the Weather Assistant Config.",
+     *         eviVersion: "2",
      *         prompt: {
      *             id: "af699d45-2985-42cc-91b9-af9e5da3bac5",
      *             version: 0
      *         },
      *         voice: {
      *             provider: "HUME_AI",
-     *             name: Hume.empathicVoice.PostedVoiceName.Ito
+     *             name: "ITO"
      *         },
      *         languageModel: {
      *             modelProvider: Hume.empathicVoice.PostedLanguageModelModelProvider.Anthropic,
@@ -119,20 +145,32 @@ export declare class Configs {
      *         }
      *     })
      */
-    createConfigVersion(id: string, request?: Hume.empathicVoice.PostedConfigVersion, requestOptions?: Configs.RequestOptions): Promise<Hume.empathicVoice.ReturnConfig>;
+    createConfigVersion(id: string, request: Hume.empathicVoice.PostedConfigVersion, requestOptions?: Configs.RequestOptions): Promise<Hume.empathicVoice.ReturnConfig>;
     /**
+     * Deletes a **Config** and its versions.
+     *
+     * For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/empathic-voice-interface-evi/configuration).
+     *
      * @param {string} id - Identifier for a Config. Formatted as a UUID.
      * @param {Configs.RequestOptions} requestOptions - Request-specific configuration.
      *
+     * @throws {@link Hume.empathicVoice.BadRequestError}
+     *
      * @example
      *     await client.empathicVoice.configs.deleteConfig("1b60e1a0-cc59-424a-8d2c-189d354db3f3")
      */
     deleteConfig(id: string, requestOptions?: Configs.RequestOptions): Promise<void>;
     /**
+     * Updates the name of a **Config**.
+     *
+     * For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/empathic-voice-interface-evi/configuration).
+     *
      * @param {string} id - Identifier for a Config. Formatted as a UUID.
      * @param {Hume.empathicVoice.PostedConfigName} request
      * @param {Configs.RequestOptions} requestOptions - Request-specific configuration.
      *
+     * @throws {@link Hume.empathicVoice.BadRequestError}
+     *
      * @example
      *     await client.empathicVoice.configs.updateConfigName("1b60e1a0-cc59-424a-8d2c-189d354db3f3", {
      *         name: "Updated Weather Assistant Config Name"
@@ -140,41 +178,59 @@ export declare class Configs {
      */
     updateConfigName(id: string, request: Hume.empathicVoice.PostedConfigName, requestOptions?: Configs.RequestOptions): Promise<string>;
     /**
+     * Fetches a specified version of a **Config**.
+     *
+     * For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/empathic-voice-interface-evi/configuration).
+     *
      * @param {string} id - Identifier for a Config. Formatted as a UUID.
      * @param {number} version - Version number for a Config.
      *
-     *                           Configs, as well as Prompts and Tools, are versioned. This versioning system supports iterative development, allowing you to progressively refine configurations and revert to previous versions if needed.
+     *                           Configs, Prompts, Custom Voices, and Tools are versioned. This versioning system supports iterative development, allowing you to progressively refine configurations and revert to previous versions if needed.
      *
      *                           Version numbers are integer values representing different iterations of the Config. Each update to the Config increments its version number.
      * @param {Configs.RequestOptions} requestOptions - Request-specific configuration.
      *
+     * @throws {@link Hume.empathicVoice.BadRequestError}
+     *
      * @example
      *     await client.empathicVoice.configs.getConfigVersion("1b60e1a0-cc59-424a-8d2c-189d354db3f3", 1)
      */
     getConfigVersion(id: string, version: number, requestOptions?: Configs.RequestOptions): Promise<Hume.empathicVoice.ReturnConfig>;
     /**
+     * Deletes a specified version of a **Config**.
+     *
+     * For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/empathic-voice-interface-evi/configuration).
+     *
      * @param {string} id - Identifier for a Config. Formatted as a UUID.
      * @param {number} version - Version number for a Config.
      *
-     *                           Configs, as well as Prompts and Tools, are versioned. This versioning system supports iterative development, allowing you to progressively refine configurations and revert to previous versions if needed.
+     *                           Configs, Prompts, Custom Voices, and Tools are versioned. This versioning system supports iterative development, allowing you to progressively refine configurations and revert to previous versions if needed.
      *
      *                           Version numbers are integer values representing different iterations of the Config. Each update to the Config increments its version number.
      * @param {Configs.RequestOptions} requestOptions - Request-specific configuration.
      *
+     * @throws {@link Hume.empathicVoice.BadRequestError}
+     *
      * @example
      *     await client.empathicVoice.configs.deleteConfigVersion("1b60e1a0-cc59-424a-8d2c-189d354db3f3", 1)
      */
     deleteConfigVersion(id: string, version: number, requestOptions?: Configs.RequestOptions): Promise<void>;
     /**
+     * Updates the description of a **Config**.
+     *
+     * For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/empathic-voice-interface-evi/configuration).
+     *
      * @param {string} id - Identifier for a Config. Formatted as a UUID.
      * @param {number} version - Version number for a Config.
      *
-     *                           Configs, as well as Prompts and Tools, are versioned. This versioning system supports iterative development, allowing you to progressively refine configurations and revert to previous versions if needed.
+     *                           Configs, Prompts, Custom Voices, and Tools are versioned. This versioning system supports iterative development, allowing you to progressively refine configurations and revert to previous versions if needed.
      *
      *                           Version numbers are integer values representing different iterations of the Config. Each update to the Config increments its version number.
      * @param {Hume.empathicVoice.PostedConfigVersionDescription} request
      * @param {Configs.RequestOptions} requestOptions - Request-specific configuration.
      *
+     * @throws {@link Hume.empathicVoice.BadRequestError}
+     *
      * @example
      *     await client.empathicVoice.configs.updateConfigDescription("1b60e1a0-cc59-424a-8d2c-189d354db3f3", 1, {
      *         versionDescription: "This is an updated version_description."