hume 0.15.9 → 0.15.10

package/dist/esm/api/resources/empathicVoice/resources/tools/client/Client.d.mts

@@ -1,22 +1,18 @@
 import type { BaseClientOptions, BaseRequestOptions } from "../../../../../../BaseClient.mjs";
+import { type NormalizedClientOptionsWithAuth } from "../../../../../../BaseClient.mjs";
 import * as core from "../../../../../../core/index.mjs";
 import * as Hume from "../../../../../index.mjs";
-export declare namespace Tools {
-    interface Options extends BaseClientOptions {
-    }
+export declare namespace ToolsClient {
+    type Options = BaseClientOptions;
     interface RequestOptions extends BaseRequestOptions {
     }
 }
-export declare class Tools {
-    protected readonly _options: Tools.Options;
-    constructor(_options?: Tools.Options);
+export declare class ToolsClient {
+    protected readonly _options: NormalizedClientOptionsWithAuth<ToolsClient.Options>;
+    constructor(options?: ToolsClient.Options);
     /**
-     * Fetches a paginated list of **Tools**.
-     *
-     * Refer to our [tool use](/docs/speech-to-speech-evi/features/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
-     *
      * @param {Hume.empathicVoice.ToolsListToolsRequest} request
-     * @param {Tools.RequestOptions} requestOptions - Request-specific configuration.
+     * @param {ToolsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Hume.empathicVoice.BadRequestError}
      *
@@ -26,14 +22,10 @@ export declare class Tools {
      *         pageSize: 2
      *     })
      */
-    listTools(request?: Hume.empathicVoice.ToolsListToolsRequest, requestOptions?: Tools.RequestOptions): Promise<core.Page<Hume.empathicVoice.ReturnUserDefinedTool | undefined, Hume.empathicVoice.ReturnPagedUserDefinedTools>>;
+    listTools(request?: Hume.empathicVoice.ToolsListToolsRequest, requestOptions?: ToolsClient.RequestOptions): Promise<core.Page<Hume.empathicVoice.ReturnUserDefinedTool | undefined, Hume.empathicVoice.ReturnPagedUserDefinedTools>>;
     /**
-     * Creates a **Tool** that can be added to an [EVI configuration](/reference/speech-to-speech-evi/configs/create-config).
-     *
-     * Refer to our [tool use](/docs/speech-to-speech-evi/features/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
-     *
      * @param {Hume.empathicVoice.PostedUserDefinedTool} request
-     * @param {Tools.RequestOptions} requestOptions - Request-specific configuration.
+     * @param {ToolsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Hume.empathicVoice.BadRequestError}
      *
@@ -46,31 +38,23 @@ export declare class Tools {
      *         fallbackContent: "Unable to fetch current weather."
      *     })
      */
-    createTool(request: Hume.empathicVoice.PostedUserDefinedTool, requestOptions?: Tools.RequestOptions): core.HttpResponsePromise<Hume.empathicVoice.ReturnUserDefinedTool | undefined>;
+    createTool(request: Hume.empathicVoice.PostedUserDefinedTool, requestOptions?: ToolsClient.RequestOptions): core.HttpResponsePromise<Hume.empathicVoice.ReturnUserDefinedTool | undefined>;
     private __createTool;
     /**
-     * Fetches a list of a **Tool's** versions.
-     *
-     * Refer to our [tool use](/docs/speech-to-speech-evi/features/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
-     *
-     * @param {string} id - Identifier for a Tool. Formatted as a UUID.
+     * @param {string} id
      * @param {Hume.empathicVoice.ToolsListToolVersionsRequest} request
-     * @param {Tools.RequestOptions} requestOptions - Request-specific configuration.
+     * @param {ToolsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Hume.empathicVoice.BadRequestError}
      *
      * @example
      *     await client.empathicVoice.tools.listToolVersions("00183a3f-79ba-413d-9f3b-609864268bea")
      */
-    listToolVersions(id: string, request?: Hume.empathicVoice.ToolsListToolVersionsRequest, requestOptions?: Tools.RequestOptions): Promise<core.Page<Hume.empathicVoice.ReturnUserDefinedTool | undefined, Hume.empathicVoice.ReturnPagedUserDefinedTools>>;
+    listToolVersions(id: string, request?: Hume.empathicVoice.ToolsListToolVersionsRequest, requestOptions?: ToolsClient.RequestOptions): Promise<core.Page<Hume.empathicVoice.ReturnUserDefinedTool | undefined, Hume.empathicVoice.ReturnPagedUserDefinedTools>>;
     /**
-     * Updates a **Tool** by creating a new version of the **Tool**.
-     *
-     * Refer to our [tool use](/docs/speech-to-speech-evi/features/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
-     *
-     * @param {string} id - Identifier for a Tool. Formatted as a UUID.
+     * @param {string} id - Identifier for a tool. Formatted as a UUID.
      * @param {Hume.empathicVoice.PostedUserDefinedToolVersion} request
-     * @param {Tools.RequestOptions} requestOptions - Request-specific configuration.
+     * @param {ToolsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Hume.empathicVoice.BadRequestError}
      *
@@ -82,31 +66,23 @@ export declare class Tools {
      *         description: "This tool is for getting the current weather."
      *     })
      */
-    createToolVersion(id: string, request: Hume.empathicVoice.PostedUserDefinedToolVersion, requestOptions?: Tools.RequestOptions): core.HttpResponsePromise<Hume.empathicVoice.ReturnUserDefinedTool | undefined>;
+    createToolVersion(id: string, request: Hume.empathicVoice.PostedUserDefinedToolVersion, requestOptions?: ToolsClient.RequestOptions): core.HttpResponsePromise<Hume.empathicVoice.ReturnUserDefinedTool | undefined>;
     private __createToolVersion;
     /**
-     * Deletes a **Tool** and its versions.
-     *
-     * Refer to our [tool use](/docs/speech-to-speech-evi/features/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
-     *
-     * @param {string} id - Identifier for a Tool. Formatted as a UUID.
-     * @param {Tools.RequestOptions} requestOptions - Request-specific configuration.
+     * @param {string} id - Identifier for a tool. Formatted as a UUID.
+     * @param {ToolsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Hume.empathicVoice.BadRequestError}
      *
      * @example
      *     await client.empathicVoice.tools.deleteTool("00183a3f-79ba-413d-9f3b-609864268bea")
      */
-    deleteTool(id: string, requestOptions?: Tools.RequestOptions): core.HttpResponsePromise<void>;
+    deleteTool(id: string, requestOptions?: ToolsClient.RequestOptions): core.HttpResponsePromise<void>;
     private __deleteTool;
     /**
-     * Updates the name of a **Tool**.
-     *
-     * Refer to our [tool use](/docs/speech-to-speech-evi/features/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
-     *
-     * @param {string} id - Identifier for a Tool. Formatted as a UUID.
+     * @param {string} id - Identifier for a tool. Formatted as a UUID.
      * @param {Hume.empathicVoice.PostedUserDefinedToolName} request
-     * @param {Tools.RequestOptions} requestOptions - Request-specific configuration.
+     * @param {ToolsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Hume.empathicVoice.BadRequestError}
      *
@@ -115,61 +91,37 @@ export declare class Tools {
      *         name: "get_current_temperature"
      *     })
      */
-    updateToolName(id: string, request: Hume.empathicVoice.PostedUserDefinedToolName, requestOptions?: Tools.RequestOptions): core.HttpResponsePromise<string>;
+    updateToolName(id: string, request: Hume.empathicVoice.PostedUserDefinedToolName, requestOptions?: ToolsClient.RequestOptions): core.HttpResponsePromise<string>;
     private __updateToolName;
     /**
-     * Fetches a specified version of a **Tool**.
-     *
-     * Refer to our [tool use](/docs/speech-to-speech-evi/features/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
-     *
-     * @param {string} id - Identifier for a Tool. Formatted as a UUID.
-     * @param {number} version - Version number for a Tool.
-     *
-     *                           Tools, Configs, Custom Voices, and Prompts are versioned. This versioning system supports iterative development, allowing you to progressively refine tools and revert to previous versions if needed.
-     *
-     *                           Version numbers are integer values representing different iterations of the Tool. Each update to the Tool increments its version number.
-     * @param {Tools.RequestOptions} requestOptions - Request-specific configuration.
+     * @param {string} id - Identifier for a tool. Formatted as a UUID.
+     * @param {number} version - Version number for a tool. Version numbers should be integers.
+     * @param {ToolsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Hume.empathicVoice.BadRequestError}
      *
      * @example
      *     await client.empathicVoice.tools.getToolVersion("00183a3f-79ba-413d-9f3b-609864268bea", 1)
      */
-    getToolVersion(id: string, version: number, requestOptions?: Tools.RequestOptions): core.HttpResponsePromise<Hume.empathicVoice.ReturnUserDefinedTool | undefined>;
+    getToolVersion(id: string, version: number, requestOptions?: ToolsClient.RequestOptions): core.HttpResponsePromise<Hume.empathicVoice.ReturnUserDefinedTool | undefined>;
     private __getToolVersion;
     /**
-     * Deletes a specified version of a **Tool**.
-     *
-     * Refer to our [tool use](/docs/speech-to-speech-evi/features/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
-     *
-     * @param {string} id - Identifier for a Tool. Formatted as a UUID.
-     * @param {number} version - Version number for a Tool.
-     *
-     *                           Tools, Configs, Custom Voices, and Prompts are versioned. This versioning system supports iterative development, allowing you to progressively refine tools and revert to previous versions if needed.
-     *
-     *                           Version numbers are integer values representing different iterations of the Tool. Each update to the Tool increments its version number.
-     * @param {Tools.RequestOptions} requestOptions - Request-specific configuration.
+     * @param {string} id - Identifier for a tool. Formatted as a UUID.
+     * @param {number} version - Version number for a tool. Version numbers should be integers.
+     * @param {ToolsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Hume.empathicVoice.BadRequestError}
      *
      * @example
      *     await client.empathicVoice.tools.deleteToolVersion("00183a3f-79ba-413d-9f3b-609864268bea", 1)
      */
-    deleteToolVersion(id: string, version: number, requestOptions?: Tools.RequestOptions): core.HttpResponsePromise<void>;
+    deleteToolVersion(id: string, version: number, requestOptions?: ToolsClient.RequestOptions): core.HttpResponsePromise<void>;
     private __deleteToolVersion;
     /**
-     * Updates the description of a specified **Tool** version.
-     *
-     * Refer to our [tool use](/docs/speech-to-speech-evi/features/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
-     *
-     * @param {string} id - Identifier for a Tool. Formatted as a UUID.
-     * @param {number} version - Version number for a Tool.
-     *
-     *                           Tools, Configs, Custom Voices, and Prompts are versioned. This versioning system supports iterative development, allowing you to progressively refine tools and revert to previous versions if needed.
-     *
-     *                           Version numbers are integer values representing different iterations of the Tool. Each update to the Tool increments its version number.
+     * @param {string} id - Identifier for a tool. Formatted as a UUID.
+     * @param {number} version - Version number for a tool. Version numbers should be integers.
      * @param {Hume.empathicVoice.PostedUserDefinedToolVersionDescription} request
-     * @param {Tools.RequestOptions} requestOptions - Request-specific configuration.
+     * @param {ToolsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Hume.empathicVoice.BadRequestError}
      *
@@ -178,7 +130,6 @@ export declare class Tools {
      *         versionDescription: "Fetches current temperature, precipitation, wind speed, AQI, and other weather conditions. Uses Celsius, Fahrenheit, or kelvin depending on user's region."
      *     })
      */
-    updateToolDescription(id: string, version: number, request?: Hume.empathicVoice.PostedUserDefinedToolVersionDescription, requestOptions?: Tools.RequestOptions): core.HttpResponsePromise<Hume.empathicVoice.ReturnUserDefinedTool | undefined>;
+    updateToolDescription(id: string, version: number, request?: Hume.empathicVoice.PostedUserDefinedToolVersionDescription, requestOptions?: ToolsClient.RequestOptions): core.HttpResponsePromise<Hume.empathicVoice.ReturnUserDefinedTool | undefined>;
     private __updateToolDescription;
-    protected _getCustomAuthorizationHeaders(): Promise<Record<string, string | undefined>>;
 }