@wildix/wim-voicebots-client 1.0.26 → 1.1.0

package/dist-cjs/protocols/Aws_restJson1.js

@@ -605,6 +605,7 @@ const se_VoiceBotFunctionIntegrationWebhook = (input, context) => {
 const se_VoiceBotLlmEndpoint = (input, context) => {
     return (0, smithy_client_1.take)(input, {
         'embeddedTools': _ => se_VoiceBotEmbeddedToolsList(_, context),
+        'metadata': smithy_client_1._json,
         'model': [],
         'prompt': [],
         'tools': _ => se_VoiceBotToolsList(_, context),
@@ -970,6 +971,7 @@ const de_VoiceBotFunctionIntegrationWebhook = (output, context) => {
 const de_VoiceBotLlmEndpoint = (output, context) => {
     return (0, smithy_client_1.take)(output, {
         'embeddedTools': (_) => de_VoiceBotEmbeddedToolsList(_, context),
+        'metadata': smithy_client_1._json,
         'model': smithy_client_1.expectString,
         'prompt': smithy_client_1.expectString,
         'tools': (_) => de_VoiceBotToolsList(_, context),

package/dist-es/protocols/Aws_restJson1.js

@@ -574,6 +574,7 @@ const se_VoiceBotFunctionIntegrationWebhook = (input, context) => {
 const se_VoiceBotLlmEndpoint = (input, context) => {
     return take(input, {
         'embeddedTools': _ => se_VoiceBotEmbeddedToolsList(_, context),
+        'metadata': _json,
         'model': [],
         'prompt': [],
         'tools': _ => se_VoiceBotToolsList(_, context),
@@ -939,6 +940,7 @@ const de_VoiceBotFunctionIntegrationWebhook = (output, context) => {
 const de_VoiceBotLlmEndpoint = (output, context) => {
     return take(output, {
         'embeddedTools': (_) => de_VoiceBotEmbeddedToolsList(_, context),
+        'metadata': _json,
         'model': __expectString,
         'prompt': __expectString,
         'tools': (_) => de_VoiceBotToolsList(_, context),

package/dist-types/commands/CreateVoiceBotCommand.d.ts

@@ -27,8 +27,7 @@ declare const CreateVoiceBotCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * @public
- *
+ * Creates a new voice bot with the specified configuration for the company.
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -63,6 +62,24 @@ declare const CreateVoiceBotCommand_base: {
  *     llm: { // VoiceBotLlmEndpoint
  *       prompt: "STRING_VALUE", // required
  *       model: "STRING_VALUE",
+ *       metadata: { // VoiceBotPromptMetadata
+ *         userName: { // VoiceBotPromptMetadataEnabled
+ *           enabled: true || false, // required
+ *         },
+ *         userPhoneNumber: {
+ *           enabled: true || false, // required
+ *         },
+ *         userEmail: { // VoiceBotPromptMetadataDisabled
+ *           enabled: true || false, // required
+ *         },
+ *         userCompany: {
+ *           enabled: true || false, // required
+ *         },
+ *         time: { // VoiceBotPromptMetadataTime
+ *           enabled: true || false, // required
+ *           timeZone: "STRING_VALUE", // required
+ *         },
+ *       },
  *       embeddedTools: [ // VoiceBotEmbeddedToolsList
  *         { // VoiceBotEmbeddedTool
  *           type: "HANGUP" || "TRANSFER" || "DELEGATE" || "WAIT", // required
@@ -165,6 +182,24 @@ declare const CreateVoiceBotCommand_base: {
  * //       llm: { // VoiceBotLlmEndpoint
  * //         prompt: "STRING_VALUE", // required
  * //         model: "STRING_VALUE",
+ * //         metadata: { // VoiceBotPromptMetadata
+ * //           userName: { // VoiceBotPromptMetadataEnabled
+ * //             enabled: true || false, // required
+ * //           },
+ * //           userPhoneNumber: {
+ * //             enabled: true || false, // required
+ * //           },
+ * //           userEmail: { // VoiceBotPromptMetadataDisabled
+ * //             enabled: true || false, // required
+ * //           },
+ * //           userCompany: {
+ * //             enabled: true || false, // required
+ * //           },
+ * //           time: { // VoiceBotPromptMetadataTime
+ * //             enabled: true || false, // required
+ * //             timeZone: "STRING_VALUE", // required
+ * //           },
+ * //         },
  * //         embeddedTools: [ // VoiceBotEmbeddedToolsList
  * //           { // VoiceBotEmbeddedTool
  * //             type: "HANGUP" || "TRANSFER" || "DELEGATE" || "WAIT", // required
@@ -258,6 +293,7 @@ declare const CreateVoiceBotCommand_base: {
  * <p>Base exception class for all service exceptions from VoiceBots service.</p>
  *
  *
+ * @public
  */
 export declare class CreateVoiceBotCommand extends CreateVoiceBotCommand_base {
     /** @internal type navigation helper, not in runtime. */

package/dist-types/commands/DeleteVoiceBotCommand.d.ts

@@ -27,8 +27,7 @@ declare const DeleteVoiceBotCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * @public
- *
+ * Deletes an existing voice bot and all its associated data.
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -59,6 +58,7 @@ declare const DeleteVoiceBotCommand_base: {
  * <p>Base exception class for all service exceptions from VoiceBots service.</p>
  *
  *
+ * @public
  */
 export declare class DeleteVoiceBotCommand extends DeleteVoiceBotCommand_base {
     /** @internal type navigation helper, not in runtime. */

package/dist-types/commands/GetTraceCommand.d.ts

@@ -27,8 +27,7 @@ declare const GetTraceCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * @public
- *
+ * Retrieves detailed trace information for a specific voice bot session.
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -356,6 +355,7 @@ declare const GetTraceCommand_base: {
  * <p>Base exception class for all service exceptions from VoiceBots service.</p>
  *
  *
+ * @public
  */
 export declare class GetTraceCommand extends GetTraceCommand_base {
     /** @internal type navigation helper, not in runtime. */

package/dist-types/commands/GetVoiceBotCommand.d.ts

@@ -27,8 +27,7 @@ declare const GetVoiceBotCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * @public
- *
+ * Retrieves details of a specific voice bot by its unique identifier.
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -70,6 +69,24 @@ declare const GetVoiceBotCommand_base: {
  * //       llm: { // VoiceBotLlmEndpoint
  * //         prompt: "STRING_VALUE", // required
  * //         model: "STRING_VALUE",
+ * //         metadata: { // VoiceBotPromptMetadata
+ * //           userName: { // VoiceBotPromptMetadataEnabled
+ * //             enabled: true || false, // required
+ * //           },
+ * //           userPhoneNumber: {
+ * //             enabled: true || false, // required
+ * //           },
+ * //           userEmail: { // VoiceBotPromptMetadataDisabled
+ * //             enabled: true || false, // required
+ * //           },
+ * //           userCompany: {
+ * //             enabled: true || false, // required
+ * //           },
+ * //           time: { // VoiceBotPromptMetadataTime
+ * //             enabled: true || false, // required
+ * //             timeZone: "STRING_VALUE", // required
+ * //           },
+ * //         },
  * //         embeddedTools: [ // VoiceBotEmbeddedToolsList
  * //           { // VoiceBotEmbeddedTool
  * //             type: "HANGUP" || "TRANSFER" || "DELEGATE" || "WAIT", // required
@@ -163,6 +180,7 @@ declare const GetVoiceBotCommand_base: {
  * <p>Base exception class for all service exceptions from VoiceBots service.</p>
  *
  *
+ * @public
  */
 export declare class GetVoiceBotCommand extends GetVoiceBotCommand_base {
     /** @internal type navigation helper, not in runtime. */

package/dist-types/commands/ListTracesCommand.d.ts

@@ -27,8 +27,7 @@ declare const ListTracesCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * @public
- *
+ * Retrieves a list of voice bot trace sessions for the specified company.
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -76,6 +75,7 @@ declare const ListTracesCommand_base: {
  * <p>Base exception class for all service exceptions from VoiceBots service.</p>
  *
  *
+ * @public
  */
 export declare class ListTracesCommand extends ListTracesCommand_base {
     /** @internal type navigation helper, not in runtime. */

package/dist-types/commands/ListVoiceBotsCommand.d.ts

@@ -27,8 +27,7 @@ declare const ListVoiceBotsCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * @public
- *
+ * Retrieves a list of all voice bots for the specified company.
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -70,6 +69,24 @@ declare const ListVoiceBotsCommand_base: {
  * //         llm: { // VoiceBotLlmEndpoint
  * //           prompt: "STRING_VALUE", // required
  * //           model: "STRING_VALUE",
+ * //           metadata: { // VoiceBotPromptMetadata
+ * //             userName: { // VoiceBotPromptMetadataEnabled
+ * //               enabled: true || false, // required
+ * //             },
+ * //             userPhoneNumber: {
+ * //               enabled: true || false, // required
+ * //             },
+ * //             userEmail: { // VoiceBotPromptMetadataDisabled
+ * //               enabled: true || false, // required
+ * //             },
+ * //             userCompany: {
+ * //               enabled: true || false, // required
+ * //             },
+ * //             time: { // VoiceBotPromptMetadataTime
+ * //               enabled: true || false, // required
+ * //               timeZone: "STRING_VALUE", // required
+ * //             },
+ * //           },
  * //           embeddedTools: [ // VoiceBotEmbeddedToolsList
  * //             { // VoiceBotEmbeddedTool
  * //               type: "HANGUP" || "TRANSFER" || "DELEGATE" || "WAIT", // required
@@ -162,6 +179,7 @@ declare const ListVoiceBotsCommand_base: {
  * <p>Base exception class for all service exceptions from VoiceBots service.</p>
  *
  *
+ * @public
  */
 export declare class ListVoiceBotsCommand extends ListVoiceBotsCommand_base {
     /** @internal type navigation helper, not in runtime. */

package/dist-types/commands/ListVoiceBotsNamesCommand.d.ts

@@ -27,8 +27,7 @@ declare const ListVoiceBotsNamesCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * @public
- *
+ * Retrieves a list of voice bot names and basic information for the specified company.
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -65,6 +64,7 @@ declare const ListVoiceBotsNamesCommand_base: {
  * <p>Base exception class for all service exceptions from VoiceBots service.</p>
  *
  *
+ * @public
  */
 export declare class ListVoiceBotsNamesCommand extends ListVoiceBotsNamesCommand_base {
     /** @internal type navigation helper, not in runtime. */

package/dist-types/commands/UpdateVoiceBotCommand.d.ts

@@ -27,8 +27,7 @@ declare const UpdateVoiceBotCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * @public
- *
+ * Updates the configuration of an existing voice bot with new settings.
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -63,6 +62,24 @@ declare const UpdateVoiceBotCommand_base: {
  *     llm: { // VoiceBotLlmEndpoint
  *       prompt: "STRING_VALUE", // required
  *       model: "STRING_VALUE",
+ *       metadata: { // VoiceBotPromptMetadata
+ *         userName: { // VoiceBotPromptMetadataEnabled
+ *           enabled: true || false, // required
+ *         },
+ *         userPhoneNumber: {
+ *           enabled: true || false, // required
+ *         },
+ *         userEmail: { // VoiceBotPromptMetadataDisabled
+ *           enabled: true || false, // required
+ *         },
+ *         userCompany: {
+ *           enabled: true || false, // required
+ *         },
+ *         time: { // VoiceBotPromptMetadataTime
+ *           enabled: true || false, // required
+ *           timeZone: "STRING_VALUE", // required
+ *         },
+ *       },
  *       embeddedTools: [ // VoiceBotEmbeddedToolsList
  *         { // VoiceBotEmbeddedTool
  *           type: "HANGUP" || "TRANSFER" || "DELEGATE" || "WAIT", // required
@@ -166,6 +183,24 @@ declare const UpdateVoiceBotCommand_base: {
  * //       llm: { // VoiceBotLlmEndpoint
  * //         prompt: "STRING_VALUE", // required
  * //         model: "STRING_VALUE",
+ * //         metadata: { // VoiceBotPromptMetadata
+ * //           userName: { // VoiceBotPromptMetadataEnabled
+ * //             enabled: true || false, // required
+ * //           },
+ * //           userPhoneNumber: {
+ * //             enabled: true || false, // required
+ * //           },
+ * //           userEmail: { // VoiceBotPromptMetadataDisabled
+ * //             enabled: true || false, // required
+ * //           },
+ * //           userCompany: {
+ * //             enabled: true || false, // required
+ * //           },
+ * //           time: { // VoiceBotPromptMetadataTime
+ * //             enabled: true || false, // required
+ * //             timeZone: "STRING_VALUE", // required
+ * //           },
+ * //         },
  * //         embeddedTools: [ // VoiceBotEmbeddedToolsList
  * //           { // VoiceBotEmbeddedTool
  * //             type: "HANGUP" || "TRANSFER" || "DELEGATE" || "WAIT", // required
@@ -261,6 +296,7 @@ declare const UpdateVoiceBotCommand_base: {
  * <p>Base exception class for all service exceptions from VoiceBots service.</p>
  *
  *
+ * @public
  */
 export declare class UpdateVoiceBotCommand extends UpdateVoiceBotCommand_base {
     /** @internal type navigation helper, not in runtime. */

package/dist-types/models/models_0.d.ts

@@ -138,6 +138,71 @@ export interface VoiceBotEmbeddedTool {
      */
     parameters?: __DocumentType | undefined;
 }
+/**
+ * @public
+ */
+export interface VoiceBotPromptMetadataTime {
+    /**
+     * Whether this metadata field is enabled
+     * @public
+     */
+    enabled: boolean;
+    /**
+     * Timezone for time formatting (e.g., 'Europe/Rome', 'UTC')
+     * @public
+     */
+    timeZone: string;
+}
+/**
+ * @public
+ */
+export interface VoiceBotPromptMetadataDisabled {
+    /**
+     * Whether this metadata field is enabled
+     * @public
+     */
+    enabled: boolean;
+}
+/**
+ * @public
+ */
+export interface VoiceBotPromptMetadataEnabled {
+    /**
+     * Whether this metadata field is enabled
+     * @public
+     */
+    enabled: boolean;
+}
+/**
+ * @public
+ */
+export interface VoiceBotPromptMetadata {
+    /**
+     * Enable/disable user name in context (enabled by default)
+     * @public
+     */
+    userName?: VoiceBotPromptMetadataEnabled | undefined;
+    /**
+     * Enable/disable user phone number in context (enabled by default)
+     * @public
+     */
+    userPhoneNumber?: VoiceBotPromptMetadataEnabled | undefined;
+    /**
+     * Enable/disable user email in context
+     * @public
+     */
+    userEmail?: VoiceBotPromptMetadataDisabled | undefined;
+    /**
+     * Enable/disable user company in context
+     * @public
+     */
+    userCompany?: VoiceBotPromptMetadataDisabled | undefined;
+    /**
+     * Time metadata with timezone configuration
+     * @public
+     */
+    time?: VoiceBotPromptMetadataTime | undefined;
+}
 /**
  * @public
  */
@@ -320,6 +385,11 @@ export interface VoiceBotLlmEndpoint {
      * @public
      */
     model?: string | undefined;
+    /**
+     * Metadata configuration to include in the system prompt context.
+     * @public
+     */
+    metadata?: VoiceBotPromptMetadata | undefined;
     /**
      * Embedded functions to use within voice session.
      * @public

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@wildix/wim-voicebots-client",
     "description": "@wildix/wim-voicebots-client client",
-    "version": "1.0.26",
+    "version": "1.1.0",
     "scripts": {
         "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
         "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -80,4 +80,4 @@
     "react-native": {
         "./dist-es/runtimeConfig": "./dist-es/runtimeConfig.native"
     }
-}
+}