@wildix/wim-voicebots-client 1.0.4 → 1.0.6

package/dist-cjs/models/models_0.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.VoiceSessionNotFoundException = exports.VoiceBotNotFoundException = exports.VoiceBotCommandType = exports.BotEndpoint = exports.VoiceBotEventType = exports.ForbiddenException = exports.ValidationException = void 0;
+exports.VoiceSessionNotFoundException = exports.VoiceBotNotFoundException = exports.VoiceBotCommandType = exports.VoiceBotEndpoint = exports.VoiceBotToolType = exports.VoiceBotEmbeddedToolType = exports.VoiceBotEventType = exports.ForbiddenException = exports.ValidationException = void 0;
 const VoiceBotsServiceException_1 = require("./VoiceBotsServiceException");
 class ValidationException extends VoiceBotsServiceException_1.VoiceBotsServiceException {
     constructor(opts) {
@@ -32,13 +32,23 @@ exports.VoiceBotEventType = {
     COMPLETE: "complete",
     ENDED: "ended",
     INTERRUPTION: "interruption",
+    PLAYBACK: "playback",
     REPLY: "reply",
     STARTED: "started",
     TRANSCRIPTION: "transcription",
 };
-var BotEndpoint;
-(function (BotEndpoint) {
-    BotEndpoint.visit = (value, visitor) => {
+exports.VoiceBotEmbeddedToolType = {
+    HANGUP: "HANGUP",
+    TRANSFER: "TRANSFER",
+};
+exports.VoiceBotToolType = {
+    FUNCTION: "function",
+};
+var VoiceBotEndpoint;
+(function (VoiceBotEndpoint) {
+    VoiceBotEndpoint.visit = (value, visitor) => {
+        if (value.llm !== undefined)
+            return visitor.llm(value.llm);
         if (value.dialogflowCx !== undefined)
             return visitor.dialogflowCx(value.dialogflowCx);
         if (value.openAiAssistant !== undefined)
@@ -49,7 +59,7 @@ var BotEndpoint;
             return visitor.sqs(value.sqs);
         return visitor._(value.$unknown[0], value.$unknown[1]);
     };
-})(BotEndpoint = exports.BotEndpoint || (exports.BotEndpoint = {}));
+})(VoiceBotEndpoint = exports.VoiceBotEndpoint || (exports.VoiceBotEndpoint = {}));
 exports.VoiceBotCommandType = {
     HANGUP: "hangup",
     SAY: "say",

package/dist-cjs/protocols/Aws_restJson1.js

@@ -16,7 +16,7 @@ const se_CreateVoiceBotCommand = async (input, context) => {
     });
     let body;
     body = JSON.stringify((0, smithy_client_1.take)(input, {
-        'endpoint': _ => se_BotEndpoint(_, context),
+        'endpoint': _ => se_VoiceBotEndpoint(_, context),
         'message': [],
         'name': [],
         'pipeline': _ => (0, smithy_client_1._json)(_),
@@ -170,7 +170,7 @@ const se_UpdateVoiceBotCommand = async (input, context) => {
     });
     let body;
     body = JSON.stringify((0, smithy_client_1.take)(input, {
-        'endpoint': _ => se_BotEndpoint(_, context),
+        'endpoint': _ => se_VoiceBotEndpoint(_, context),
         'message': [],
         'name': [],
         'pipeline': _ => (0, smithy_client_1._json)(_),
@@ -222,6 +222,8 @@ const de_DescribeEventCommand = async (output, context) => {
         'HangupWebsocketCommand': smithy_client_1._json,
         'InterruptionWebhookEvent': smithy_client_1._json,
         'InterruptionWebsocketEvent': smithy_client_1._json,
+        'PlaybackWebhookEvent': smithy_client_1._json,
+        'PlaybackWebsocketEvent': smithy_client_1._json,
         'ReplyWebhookEvent': smithy_client_1._json,
         'ReplyWebsocketEvent': smithy_client_1._json,
         'SayWebsocketCommand': smithy_client_1._json,
@@ -414,30 +416,68 @@ const de_VoiceSessionNotFoundExceptionRes = async (parsedOutput, context) => {
 const se_Document = (input, context) => {
     return input;
 };
-const se_BotDialogflowCxEndpoint = (input, context) => {
+const se_VoiceBotEmbeddedTool = (input, context) => {
     return (0, smithy_client_1.take)(input, {
-        'agent': [],
-        'credentials': _ => se_Document(_, context),
-        'language': [],
-        'location': [],
+        'name': [],
+        'parameters': _ => se_Document(_, context),
+        'type': [],
+    });
+};
+const se_VoiceBotEmbeddedToolsList = (input, context) => {
+    return input.filter((e) => e != null).map(entry => {
+        return se_VoiceBotEmbeddedTool(entry, context);
     });
 };
-const se_BotEndpoint = (input, context) => {
-    return models_0_1.BotEndpoint.visit(input, {
+const se_VoiceBotEndpoint = (input, context) => {
+    return models_0_1.VoiceBotEndpoint.visit(input, {
         dialogflowCx: value => ({ "dialogflowCx": se_BotDialogflowCxEndpoint(value, context) }),
+        llm: value => ({ "llm": se_VoiceBotLlmEndpoint(value, context) }),
         openAiAssistant: value => ({ "openAiAssistant": (0, smithy_client_1._json)(value) }),
         sqs: value => ({ "sqs": (0, smithy_client_1._json)(value) }),
         webhook: value => ({ "webhook": (0, smithy_client_1._json)(value) }),
         _: (name, value) => ({ name: value })
     });
 };
+const se_VoiceBotFunctionDefinition = (input, context) => {
+    return (0, smithy_client_1.take)(input, {
+        'description': [],
+        'name': [],
+        'parameters': _ => se_Document(_, context),
+    });
+};
+const se_VoiceBotLlmEndpoint = (input, context) => {
+    return (0, smithy_client_1.take)(input, {
+        'embeddedTools': _ => se_VoiceBotEmbeddedToolsList(_, context),
+        'prompt': [],
+        'tools': _ => se_VoiceBotToolsList(_, context),
+    });
+};
+const se_VoiceBotTool = (input, context) => {
+    return (0, smithy_client_1.take)(input, {
+        'function': _ => se_VoiceBotFunctionDefinition(_, context),
+        'type': [],
+    });
+};
+const se_VoiceBotToolsList = (input, context) => {
+    return input.filter((e) => e != null).map(entry => {
+        return se_VoiceBotTool(entry, context);
+    });
+};
+const se_BotDialogflowCxEndpoint = (input, context) => {
+    return (0, smithy_client_1.take)(input, {
+        'agent': [],
+        'credentials': _ => se_Document(_, context),
+        'language': [],
+        'location': [],
+    });
+};
 const de_Document = (output, context) => {
     return output;
 };
 const de_VoiceBot = (output, context) => {
     return (0, smithy_client_1.take)(output, {
         'createdAt': smithy_client_1.expectString,
-        'endpoint': (_) => de_BotEndpoint((0, smithy_client_1.expectUnion)(_), context),
+        'endpoint': (_) => de_VoiceBotEndpoint((0, smithy_client_1.expectUnion)(_), context),
         'id': smithy_client_1.expectString,
         'message': smithy_client_1.expectString,
         'name': smithy_client_1.expectString,
@@ -445,26 +485,30 @@ const de_VoiceBot = (output, context) => {
         'updatedAt': smithy_client_1.expectString,
     });
 };
-const de_VoiceBotsList = (output, context) => {
-    const retVal = (output || []).filter((e) => e != null).map((entry) => {
-        return de_VoiceBot(entry, context);
+const de_VoiceBotEmbeddedTool = (output, context) => {
+    return (0, smithy_client_1.take)(output, {
+        'name': smithy_client_1.expectString,
+        'parameters': (_) => de_Document(_, context),
+        'type': smithy_client_1.expectString,
     });
-    return retVal;
 };
-const de_BotDialogflowCxEndpoint = (output, context) => {
-    return (0, smithy_client_1.take)(output, {
-        'agent': smithy_client_1.expectString,
-        'credentials': (_) => de_Document(_, context),
-        'language': smithy_client_1.expectString,
-        'location': smithy_client_1.expectString,
+const de_VoiceBotEmbeddedToolsList = (output, context) => {
+    const retVal = (output || []).filter((e) => e != null).map((entry) => {
+        return de_VoiceBotEmbeddedTool(entry, context);
     });
+    return retVal;
 };
-const de_BotEndpoint = (output, context) => {
+const de_VoiceBotEndpoint = (output, context) => {
     if (output.dialogflowCx != null) {
         return {
             dialogflowCx: de_BotDialogflowCxEndpoint(output.dialogflowCx, context)
         };
     }
+    if (output.llm != null) {
+        return {
+            llm: de_VoiceBotLlmEndpoint(output.llm, context)
+        };
+    }
     if (output.openAiAssistant != null) {
         return {
             openAiAssistant: (0, smithy_client_1._json)(output.openAiAssistant)
@@ -482,6 +526,46 @@ const de_BotEndpoint = (output, context) => {
     }
     return { $unknown: Object.entries(output)[0] };
 };
+const de_VoiceBotFunctionDefinition = (output, context) => {
+    return (0, smithy_client_1.take)(output, {
+        'description': smithy_client_1.expectString,
+        'name': smithy_client_1.expectString,
+        'parameters': (_) => de_Document(_, context),
+    });
+};
+const de_VoiceBotLlmEndpoint = (output, context) => {
+    return (0, smithy_client_1.take)(output, {
+        'embeddedTools': (_) => de_VoiceBotEmbeddedToolsList(_, context),
+        'prompt': smithy_client_1.expectString,
+        'tools': (_) => de_VoiceBotToolsList(_, context),
+    });
+};
+const de_VoiceBotsList = (output, context) => {
+    const retVal = (output || []).filter((e) => e != null).map((entry) => {
+        return de_VoiceBot(entry, context);
+    });
+    return retVal;
+};
+const de_VoiceBotTool = (output, context) => {
+    return (0, smithy_client_1.take)(output, {
+        'function': (_) => de_VoiceBotFunctionDefinition(_, context),
+        'type': smithy_client_1.expectString,
+    });
+};
+const de_VoiceBotToolsList = (output, context) => {
+    const retVal = (output || []).filter((e) => e != null).map((entry) => {
+        return de_VoiceBotTool(entry, context);
+    });
+    return retVal;
+};
+const de_BotDialogflowCxEndpoint = (output, context) => {
+    return (0, smithy_client_1.take)(output, {
+        'agent': smithy_client_1.expectString,
+        'credentials': (_) => de_Document(_, context),
+        'language': smithy_client_1.expectString,
+        'location': smithy_client_1.expectString,
+    });
+};
 const deserializeMetadata = (output) => ({
     httpStatusCode: output.statusCode,
     requestId: output.headers["x-amzn-requestid"] ?? output.headers["x-amzn-request-id"] ?? output.headers["x-amz-request-id"],

package/dist-es/models/models_0.js

@@ -27,13 +27,23 @@ export const VoiceBotEventType = {
     COMPLETE: "complete",
     ENDED: "ended",
     INTERRUPTION: "interruption",
+    PLAYBACK: "playback",
     REPLY: "reply",
     STARTED: "started",
     TRANSCRIPTION: "transcription",
 };
-export var BotEndpoint;
-(function (BotEndpoint) {
-    BotEndpoint.visit = (value, visitor) => {
+export const VoiceBotEmbeddedToolType = {
+    HANGUP: "HANGUP",
+    TRANSFER: "TRANSFER",
+};
+export const VoiceBotToolType = {
+    FUNCTION: "function",
+};
+export var VoiceBotEndpoint;
+(function (VoiceBotEndpoint) {
+    VoiceBotEndpoint.visit = (value, visitor) => {
+        if (value.llm !== undefined)
+            return visitor.llm(value.llm);
         if (value.dialogflowCx !== undefined)
             return visitor.dialogflowCx(value.dialogflowCx);
         if (value.openAiAssistant !== undefined)
@@ -44,7 +54,7 @@ export var BotEndpoint;
             return visitor.sqs(value.sqs);
         return visitor._(value.$unknown[0], value.$unknown[1]);
     };
-})(BotEndpoint || (BotEndpoint = {}));
+})(VoiceBotEndpoint || (VoiceBotEndpoint = {}));
 export const VoiceBotCommandType = {
     HANGUP: "hangup",
     SAY: "say",

package/dist-es/protocols/Aws_restJson1.js

@@ -1,5 +1,5 @@
 import { VoiceBotsServiceException as __BaseException } from "../models/VoiceBotsServiceException";
-import { BotEndpoint, ForbiddenException, ValidationException, VoiceBotNotFoundException, VoiceSessionNotFoundException, } from "../models/models_0";
+import { ForbiddenException, ValidationException, VoiceBotEndpoint, VoiceBotNotFoundException, VoiceSessionNotFoundException, } from "../models/models_0";
 import { requestBuilder as rb } from "@smithy/core";
 import { decorateServiceException as __decorateServiceException, expectNonNull as __expectNonNull, expectObject as __expectObject, expectString as __expectString, expectUnion as __expectUnion, _json, collectBody, map, take, withBaseException, } from "@smithy/smithy-client";
 export const se_CreateVoiceBotCommand = async (input, context) => {
@@ -13,7 +13,7 @@ export const se_CreateVoiceBotCommand = async (input, context) => {
     });
     let body;
     body = JSON.stringify(take(input, {
-        'endpoint': _ => se_BotEndpoint(_, context),
+        'endpoint': _ => se_VoiceBotEndpoint(_, context),
         'message': [],
         'name': [],
         'pipeline': _ => _json(_),
@@ -158,7 +158,7 @@ export const se_UpdateVoiceBotCommand = async (input, context) => {
     });
     let body;
     body = JSON.stringify(take(input, {
-        'endpoint': _ => se_BotEndpoint(_, context),
+        'endpoint': _ => se_VoiceBotEndpoint(_, context),
         'message': [],
         'name': [],
         'pipeline': _ => _json(_),
@@ -207,6 +207,8 @@ export const de_DescribeEventCommand = async (output, context) => {
         'HangupWebsocketCommand': _json,
         'InterruptionWebhookEvent': _json,
         'InterruptionWebsocketEvent': _json,
+        'PlaybackWebhookEvent': _json,
+        'PlaybackWebsocketEvent': _json,
         'ReplyWebhookEvent': _json,
         'ReplyWebsocketEvent': _json,
         'SayWebsocketCommand': _json,
@@ -391,30 +393,68 @@ const de_VoiceSessionNotFoundExceptionRes = async (parsedOutput, context) => {
 const se_Document = (input, context) => {
     return input;
 };
-const se_BotDialogflowCxEndpoint = (input, context) => {
+const se_VoiceBotEmbeddedTool = (input, context) => {
     return take(input, {
-        'agent': [],
-        'credentials': _ => se_Document(_, context),
-        'language': [],
-        'location': [],
+        'name': [],
+        'parameters': _ => se_Document(_, context),
+        'type': [],
+    });
+};
+const se_VoiceBotEmbeddedToolsList = (input, context) => {
+    return input.filter((e) => e != null).map(entry => {
+        return se_VoiceBotEmbeddedTool(entry, context);
     });
 };
-const se_BotEndpoint = (input, context) => {
-    return BotEndpoint.visit(input, {
+const se_VoiceBotEndpoint = (input, context) => {
+    return VoiceBotEndpoint.visit(input, {
         dialogflowCx: value => ({ "dialogflowCx": se_BotDialogflowCxEndpoint(value, context) }),
+        llm: value => ({ "llm": se_VoiceBotLlmEndpoint(value, context) }),
         openAiAssistant: value => ({ "openAiAssistant": _json(value) }),
         sqs: value => ({ "sqs": _json(value) }),
         webhook: value => ({ "webhook": _json(value) }),
         _: (name, value) => ({ name: value })
     });
 };
+const se_VoiceBotFunctionDefinition = (input, context) => {
+    return take(input, {
+        'description': [],
+        'name': [],
+        'parameters': _ => se_Document(_, context),
+    });
+};
+const se_VoiceBotLlmEndpoint = (input, context) => {
+    return take(input, {
+        'embeddedTools': _ => se_VoiceBotEmbeddedToolsList(_, context),
+        'prompt': [],
+        'tools': _ => se_VoiceBotToolsList(_, context),
+    });
+};
+const se_VoiceBotTool = (input, context) => {
+    return take(input, {
+        'function': _ => se_VoiceBotFunctionDefinition(_, context),
+        'type': [],
+    });
+};
+const se_VoiceBotToolsList = (input, context) => {
+    return input.filter((e) => e != null).map(entry => {
+        return se_VoiceBotTool(entry, context);
+    });
+};
+const se_BotDialogflowCxEndpoint = (input, context) => {
+    return take(input, {
+        'agent': [],
+        'credentials': _ => se_Document(_, context),
+        'language': [],
+        'location': [],
+    });
+};
 const de_Document = (output, context) => {
     return output;
 };
 const de_VoiceBot = (output, context) => {
     return take(output, {
         'createdAt': __expectString,
-        'endpoint': (_) => de_BotEndpoint(__expectUnion(_), context),
+        'endpoint': (_) => de_VoiceBotEndpoint(__expectUnion(_), context),
         'id': __expectString,
         'message': __expectString,
         'name': __expectString,
@@ -422,26 +462,30 @@ const de_VoiceBot = (output, context) => {
         'updatedAt': __expectString,
     });
 };
-const de_VoiceBotsList = (output, context) => {
-    const retVal = (output || []).filter((e) => e != null).map((entry) => {
-        return de_VoiceBot(entry, context);
+const de_VoiceBotEmbeddedTool = (output, context) => {
+    return take(output, {
+        'name': __expectString,
+        'parameters': (_) => de_Document(_, context),
+        'type': __expectString,
     });
-    return retVal;
 };
-const de_BotDialogflowCxEndpoint = (output, context) => {
-    return take(output, {
-        'agent': __expectString,
-        'credentials': (_) => de_Document(_, context),
-        'language': __expectString,
-        'location': __expectString,
+const de_VoiceBotEmbeddedToolsList = (output, context) => {
+    const retVal = (output || []).filter((e) => e != null).map((entry) => {
+        return de_VoiceBotEmbeddedTool(entry, context);
     });
+    return retVal;
 };
-const de_BotEndpoint = (output, context) => {
+const de_VoiceBotEndpoint = (output, context) => {
     if (output.dialogflowCx != null) {
         return {
             dialogflowCx: de_BotDialogflowCxEndpoint(output.dialogflowCx, context)
         };
     }
+    if (output.llm != null) {
+        return {
+            llm: de_VoiceBotLlmEndpoint(output.llm, context)
+        };
+    }
     if (output.openAiAssistant != null) {
         return {
             openAiAssistant: _json(output.openAiAssistant)
@@ -459,6 +503,46 @@ const de_BotEndpoint = (output, context) => {
     }
     return { $unknown: Object.entries(output)[0] };
 };
+const de_VoiceBotFunctionDefinition = (output, context) => {
+    return take(output, {
+        'description': __expectString,
+        'name': __expectString,
+        'parameters': (_) => de_Document(_, context),
+    });
+};
+const de_VoiceBotLlmEndpoint = (output, context) => {
+    return take(output, {
+        'embeddedTools': (_) => de_VoiceBotEmbeddedToolsList(_, context),
+        'prompt': __expectString,
+        'tools': (_) => de_VoiceBotToolsList(_, context),
+    });
+};
+const de_VoiceBotsList = (output, context) => {
+    const retVal = (output || []).filter((e) => e != null).map((entry) => {
+        return de_VoiceBot(entry, context);
+    });
+    return retVal;
+};
+const de_VoiceBotTool = (output, context) => {
+    return take(output, {
+        'function': (_) => de_VoiceBotFunctionDefinition(_, context),
+        'type': __expectString,
+    });
+};
+const de_VoiceBotToolsList = (output, context) => {
+    const retVal = (output || []).filter((e) => e != null).map((entry) => {
+        return de_VoiceBotTool(entry, context);
+    });
+    return retVal;
+};
+const de_BotDialogflowCxEndpoint = (output, context) => {
+    return take(output, {
+        'agent': __expectString,
+        'credentials': (_) => de_Document(_, context),
+        'language': __expectString,
+        'location': __expectString,
+    });
+};
 const deserializeMetadata = (output) => ({
     httpStatusCode: output.statusCode,
     requestId: output.headers["x-amzn-requestid"] ?? output.headers["x-amzn-request-id"] ?? output.headers["x-amz-request-id"],

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

@@ -45,7 +45,27 @@ declare const CreateVoiceBotCommand_base: {
  *     endCallEnabled: true || false,
  *     endCallPhases: "STRING_VALUE",
  *   },
- *   endpoint: { // BotEndpoint Union: only one key present
+ *   endpoint: { // VoiceBotEndpoint Union: only one key present
+ *     llm: { // VoiceBotLlmEndpoint
+ *       prompt: "STRING_VALUE", // required
+ *       embeddedTools: [ // VoiceBotEmbeddedToolsList
+ *         { // VoiceBotEmbeddedTool
+ *           type: "HANGUP" || "TRANSFER", // required
+ *           name: "STRING_VALUE", // required
+ *           parameters: "DOCUMENT_VALUE",
+ *         },
+ *       ],
+ *       tools: [ // VoiceBotToolsList
+ *         { // VoiceBotTool
+ *           type: "function", // required
+ *           function: { // VoiceBotFunctionDefinition
+ *             name: "STRING_VALUE", // required
+ *             description: "STRING_VALUE",
+ *             parameters: "DOCUMENT_VALUE",
+ *           },
+ *         },
+ *       ],
+ *     },
  *     dialogflowCx: { // BotDialogflowCxEndpoint
  *       credentials: "DOCUMENT_VALUE", // required
  *       agent: "STRING_VALUE", // required
@@ -81,7 +101,27 @@ declare const CreateVoiceBotCommand_base: {
  * //       endCallEnabled: true || false,
  * //       endCallPhases: "STRING_VALUE",
  * //     },
- * //     endpoint: { // BotEndpoint Union: only one key present
+ * //     endpoint: { // VoiceBotEndpoint Union: only one key present
+ * //       llm: { // VoiceBotLlmEndpoint
+ * //         prompt: "STRING_VALUE", // required
+ * //         embeddedTools: [ // VoiceBotEmbeddedToolsList
+ * //           { // VoiceBotEmbeddedTool
+ * //             type: "HANGUP" || "TRANSFER", // required
+ * //             name: "STRING_VALUE", // required
+ * //             parameters: "DOCUMENT_VALUE",
+ * //           },
+ * //         ],
+ * //         tools: [ // VoiceBotToolsList
+ * //           { // VoiceBotTool
+ * //             type: "function", // required
+ * //             function: { // VoiceBotFunctionDefinition
+ * //               name: "STRING_VALUE", // required
+ * //               description: "STRING_VALUE",
+ * //               parameters: "DOCUMENT_VALUE",
+ * //             },
+ * //           },
+ * //         ],
+ * //       },
  * //       dialogflowCx: { // BotDialogflowCxEndpoint
  * //         credentials: "DOCUMENT_VALUE", // required
  * //         agent: "STRING_VALUE", // required

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

@@ -42,7 +42,7 @@ declare const DescribeEventCommand_base: {
  * //   TranscriptionWebsocketEvent: { // TranscriptionWebsocketEvent
  * //     type: "STRING_VALUE", // required
  * //     event: { // TranscriptionEvent
- * //       type: "started" || "ended" || "reply" || "transcription" || "interruption" || "complete", // required
+ * //       type: "started" || "ended" || "reply" || "playback" || "transcription" || "interruption" || "complete", // required
  * //       id: "STRING_VALUE", // required
  * //       text: "STRING_VALUE", // required
  * //       time: Number("long"), // required
@@ -51,17 +51,28 @@ declare const DescribeEventCommand_base: {
  * //   ReplyWebsocketEvent: { // ReplyWebsocketEvent
  * //     type: "STRING_VALUE", // required
  * //     event: { // ReplyEvent
- * //       type: "started" || "ended" || "reply" || "transcription" || "interruption" || "complete", // required
+ * //       type: "started" || "ended" || "reply" || "playback" || "transcription" || "interruption" || "complete", // required
  * //       id: "STRING_VALUE", // required
  * //       text: "STRING_VALUE", // required
  * //       startTime: Number("long"), // required
  * //       endTime: Number("long"), // required
  * //     },
  * //   },
+ * //   PlaybackWebsocketEvent: { // PlaybackWebsocketEvent
+ * //     type: "STRING_VALUE", // required
+ * //     event: { // PlaybackEvent
+ * //       type: "started" || "ended" || "reply" || "playback" || "transcription" || "interruption" || "complete", // required
+ * //       replyId: "STRING_VALUE", // required
+ * //       text: "STRING_VALUE", // required
+ * //       complete: true || false, // required
+ * //       startTime: Number("long"), // required
+ * //       endTime: Number("long"),
+ * //     },
+ * //   },
  * //   InterruptionWebsocketEvent: { // InterruptionWebsocketEvent
  * //     type: "STRING_VALUE", // required
  * //     event: { // InterruptionEvent
- * //       type: "started" || "ended" || "reply" || "transcription" || "interruption" || "complete", // required
+ * //       type: "started" || "ended" || "reply" || "playback" || "transcription" || "interruption" || "complete", // required
  * //       replyId: "STRING_VALUE", // required
  * //       playedText: "STRING_VALUE", // required
  * //       originalText: "STRING_VALUE", // required
@@ -71,7 +82,7 @@ declare const DescribeEventCommand_base: {
  * //   CompleteWebsocketEvent: { // CompleteWebsocketEvent
  * //     type: "STRING_VALUE", // required
  * //     event: { // CompleteEvent
- * //       type: "started" || "ended" || "reply" || "transcription" || "interruption" || "complete", // required
+ * //       type: "started" || "ended" || "reply" || "playback" || "transcription" || "interruption" || "complete", // required
  * //       reason: "STRING_VALUE", // required
  * //       time: Number("long"), // required
  * //     },
@@ -106,7 +117,7 @@ declare const DescribeEventCommand_base: {
  * //     callId: "STRING_VALUE", // required
  * //     flowIndex: Number("int"), // required
  * //     event: { // SessionStartedEvent
- * //       type: "started" || "ended" || "reply" || "transcription" || "interruption" || "complete", // required
+ * //       type: "started" || "ended" || "reply" || "playback" || "transcription" || "interruption" || "complete", // required
  * //       language: "STRING_VALUE", // required
  * //       time: Number("long"), // required
  * //     },
@@ -117,7 +128,7 @@ declare const DescribeEventCommand_base: {
  * //     callId: "STRING_VALUE", // required
  * //     flowIndex: Number("int"), // required
  * //     event: { // SessionEndedEvent
- * //       type: "started" || "ended" || "reply" || "transcription" || "interruption" || "complete", // required
+ * //       type: "started" || "ended" || "reply" || "playback" || "transcription" || "interruption" || "complete", // required
  * //       error: "STRING_VALUE",
  * //       time: Number("long"), // required
  * //     },
@@ -128,7 +139,7 @@ declare const DescribeEventCommand_base: {
  * //     callId: "STRING_VALUE", // required
  * //     flowIndex: Number("int"), // required
  * //     event: {
- * //       type: "started" || "ended" || "reply" || "transcription" || "interruption" || "complete", // required
+ * //       type: "started" || "ended" || "reply" || "playback" || "transcription" || "interruption" || "complete", // required
  * //       id: "STRING_VALUE", // required
  * //       text: "STRING_VALUE", // required
  * //       time: Number("long"), // required
@@ -140,20 +151,34 @@ declare const DescribeEventCommand_base: {
  * //     callId: "STRING_VALUE", // required
  * //     flowIndex: Number("int"), // required
  * //     event: {
- * //       type: "started" || "ended" || "reply" || "transcription" || "interruption" || "complete", // required
+ * //       type: "started" || "ended" || "reply" || "playback" || "transcription" || "interruption" || "complete", // required
  * //       id: "STRING_VALUE", // required
  * //       text: "STRING_VALUE", // required
  * //       startTime: Number("long"), // required
  * //       endTime: Number("long"), // required
  * //     },
  * //   },
+ * //   PlaybackWebhookEvent: { // PlaybackWebhookEvent
+ * //     sessionId: "STRING_VALUE", // required
+ * //     botId: "STRING_VALUE", // required
+ * //     callId: "STRING_VALUE", // required
+ * //     flowIndex: Number("int"), // required
+ * //     event: {
+ * //       type: "started" || "ended" || "reply" || "playback" || "transcription" || "interruption" || "complete", // required
+ * //       replyId: "STRING_VALUE", // required
+ * //       text: "STRING_VALUE", // required
+ * //       complete: true || false, // required
+ * //       startTime: Number("long"), // required
+ * //       endTime: Number("long"),
+ * //     },
+ * //   },
  * //   InterruptionWebhookEvent: { // InterruptionWebhookEvent
  * //     sessionId: "STRING_VALUE", // required
  * //     botId: "STRING_VALUE", // required
  * //     callId: "STRING_VALUE", // required
  * //     flowIndex: Number("int"), // required
  * //     event: {
- * //       type: "started" || "ended" || "reply" || "transcription" || "interruption" || "complete", // required
+ * //       type: "started" || "ended" || "reply" || "playback" || "transcription" || "interruption" || "complete", // required
  * //       replyId: "STRING_VALUE", // required
  * //       playedText: "STRING_VALUE", // required
  * //       originalText: "STRING_VALUE", // required

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

@@ -52,7 +52,27 @@ declare const GetVoiceBotCommand_base: {
  * //       endCallEnabled: true || false,
  * //       endCallPhases: "STRING_VALUE",
  * //     },
- * //     endpoint: { // BotEndpoint Union: only one key present
+ * //     endpoint: { // VoiceBotEndpoint Union: only one key present
+ * //       llm: { // VoiceBotLlmEndpoint
+ * //         prompt: "STRING_VALUE", // required
+ * //         embeddedTools: [ // VoiceBotEmbeddedToolsList
+ * //           { // VoiceBotEmbeddedTool
+ * //             type: "HANGUP" || "TRANSFER", // required
+ * //             name: "STRING_VALUE", // required
+ * //             parameters: "DOCUMENT_VALUE",
+ * //           },
+ * //         ],
+ * //         tools: [ // VoiceBotToolsList
+ * //           { // VoiceBotTool
+ * //             type: "function", // required
+ * //             function: { // VoiceBotFunctionDefinition
+ * //               name: "STRING_VALUE", // required
+ * //               description: "STRING_VALUE",
+ * //               parameters: "DOCUMENT_VALUE",
+ * //             },
+ * //           },
+ * //         ],
+ * //       },
  * //       dialogflowCx: { // BotDialogflowCxEndpoint
  * //         credentials: "DOCUMENT_VALUE", // required
  * //         agent: "STRING_VALUE", // required

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

@@ -52,7 +52,27 @@ declare const ListVoiceBotsCommand_base: {
  * //         endCallEnabled: true || false,
  * //         endCallPhases: "STRING_VALUE",
  * //       },
- * //       endpoint: { // BotEndpoint Union: only one key present
+ * //       endpoint: { // VoiceBotEndpoint Union: only one key present
+ * //         llm: { // VoiceBotLlmEndpoint
+ * //           prompt: "STRING_VALUE", // required
+ * //           embeddedTools: [ // VoiceBotEmbeddedToolsList
+ * //             { // VoiceBotEmbeddedTool
+ * //               type: "HANGUP" || "TRANSFER", // required
+ * //               name: "STRING_VALUE", // required
+ * //               parameters: "DOCUMENT_VALUE",
+ * //             },
+ * //           ],
+ * //           tools: [ // VoiceBotToolsList
+ * //             { // VoiceBotTool
+ * //               type: "function", // required
+ * //               function: { // VoiceBotFunctionDefinition
+ * //                 name: "STRING_VALUE", // required
+ * //                 description: "STRING_VALUE",
+ * //                 parameters: "DOCUMENT_VALUE",
+ * //               },
+ * //             },
+ * //           ],
+ * //         },
  * //         dialogflowCx: { // BotDialogflowCxEndpoint
  * //           credentials: "DOCUMENT_VALUE", // required
  * //           agent: "STRING_VALUE", // required

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

@@ -45,7 +45,27 @@ declare const UpdateVoiceBotCommand_base: {
  *     endCallEnabled: true || false,
  *     endCallPhases: "STRING_VALUE",
  *   },
- *   endpoint: { // BotEndpoint Union: only one key present
+ *   endpoint: { // VoiceBotEndpoint Union: only one key present
+ *     llm: { // VoiceBotLlmEndpoint
+ *       prompt: "STRING_VALUE", // required
+ *       embeddedTools: [ // VoiceBotEmbeddedToolsList
+ *         { // VoiceBotEmbeddedTool
+ *           type: "HANGUP" || "TRANSFER", // required
+ *           name: "STRING_VALUE", // required
+ *           parameters: "DOCUMENT_VALUE",
+ *         },
+ *       ],
+ *       tools: [ // VoiceBotToolsList
+ *         { // VoiceBotTool
+ *           type: "function", // required
+ *           function: { // VoiceBotFunctionDefinition
+ *             name: "STRING_VALUE", // required
+ *             description: "STRING_VALUE",
+ *             parameters: "DOCUMENT_VALUE",
+ *           },
+ *         },
+ *       ],
+ *     },
  *     dialogflowCx: { // BotDialogflowCxEndpoint
  *       credentials: "DOCUMENT_VALUE", // required
  *       agent: "STRING_VALUE", // required
@@ -82,7 +102,27 @@ declare const UpdateVoiceBotCommand_base: {
  * //       endCallEnabled: true || false,
  * //       endCallPhases: "STRING_VALUE",
  * //     },
- * //     endpoint: { // BotEndpoint Union: only one key present
+ * //     endpoint: { // VoiceBotEndpoint Union: only one key present
+ * //       llm: { // VoiceBotLlmEndpoint
+ * //         prompt: "STRING_VALUE", // required
+ * //         embeddedTools: [ // VoiceBotEmbeddedToolsList
+ * //           { // VoiceBotEmbeddedTool
+ * //             type: "HANGUP" || "TRANSFER", // required
+ * //             name: "STRING_VALUE", // required
+ * //             parameters: "DOCUMENT_VALUE",
+ * //           },
+ * //         ],
+ * //         tools: [ // VoiceBotToolsList
+ * //           { // VoiceBotTool
+ * //             type: "function", // required
+ * //             function: { // VoiceBotFunctionDefinition
+ * //               name: "STRING_VALUE", // required
+ * //               description: "STRING_VALUE",
+ * //               parameters: "DOCUMENT_VALUE",
+ * //             },
+ * //           },
+ * //         ],
+ * //       },
  * //       dialogflowCx: { // BotDialogflowCxEndpoint
  * //         credentials: "DOCUMENT_VALUE", // required
  * //         agent: "STRING_VALUE", // required

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

@@ -31,6 +31,7 @@ export declare const VoiceBotEventType: {
     readonly COMPLETE: "complete";
     readonly ENDED: "ended";
     readonly INTERRUPTION: "interruption";
+    readonly PLAYBACK: "playback";
     readonly REPLY: "reply";
     readonly STARTED: "started";
     readonly TRANSCRIPTION: "transcription";
@@ -88,6 +89,84 @@ export interface BotDialogflowCxEndpoint {
      */
     language: string;
 }
+/**
+ * @public
+ * @enum
+ */
+export declare const VoiceBotEmbeddedToolType: {
+    readonly HANGUP: "HANGUP";
+    readonly TRANSFER: "TRANSFER";
+};
+/**
+ * @public
+ */
+export type VoiceBotEmbeddedToolType = typeof VoiceBotEmbeddedToolType[keyof typeof VoiceBotEmbeddedToolType];
+/**
+ * @public
+ */
+export interface VoiceBotEmbeddedTool {
+    type: VoiceBotEmbeddedToolType;
+    name: string;
+    /**
+     * The parameters the functions accepts.
+     * @public
+     */
+    parameters?: __DocumentType;
+}
+/**
+ * @public
+ */
+export interface VoiceBotFunctionDefinition {
+    /**
+     * The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.
+     * @public
+     */
+    name: string;
+    /**
+     * A description of what the function does, used by the model to choose when and how to call the function.
+     * @public
+     */
+    description?: string;
+    /**
+     * The parameters the functions accepts, described as a JSON Schema object.
+     * @public
+     */
+    parameters?: __DocumentType;
+}
+/**
+ * @public
+ * @enum
+ */
+export declare const VoiceBotToolType: {
+    readonly FUNCTION: "function";
+};
+/**
+ * @public
+ */
+export type VoiceBotToolType = typeof VoiceBotToolType[keyof typeof VoiceBotToolType];
+/**
+ * @public
+ */
+export interface VoiceBotTool {
+    type: VoiceBotToolType;
+    function?: VoiceBotFunctionDefinition;
+}
+/**
+ * @public
+ */
+export interface VoiceBotLlmEndpoint {
+    prompt: string;
+    /**
+     * Embedded functions to use within voice session.
+     * @public
+     */
+    embeddedTools?: (VoiceBotEmbeddedTool)[];
+    /**
+     * Custom tools to be used within voice session.
+     * @public
+     */
+    tools?: (VoiceBotTool)[];
+}
 /**
  * @public
  */
@@ -113,12 +192,21 @@ export interface BotWebhookEndpoint {
 /**
  * @public
  */
-export type BotEndpoint = BotEndpoint.DialogflowCxMember | BotEndpoint.OpenAiAssistantMember | BotEndpoint.SqsMember | BotEndpoint.WebhookMember | BotEndpoint.$UnknownMember;
+export type VoiceBotEndpoint = VoiceBotEndpoint.DialogflowCxMember | VoiceBotEndpoint.LlmMember | VoiceBotEndpoint.OpenAiAssistantMember | VoiceBotEndpoint.SqsMember | VoiceBotEndpoint.WebhookMember | VoiceBotEndpoint.$UnknownMember;
 /**
  * @public
  */
-export declare namespace BotEndpoint {
+export declare namespace VoiceBotEndpoint {
+    interface LlmMember {
+        llm: VoiceBotLlmEndpoint;
+        dialogflowCx?: never;
+        openAiAssistant?: never;
+        webhook?: never;
+        sqs?: never;
+        $unknown?: never;
+    }
     interface DialogflowCxMember {
+        llm?: never;
         dialogflowCx: BotDialogflowCxEndpoint;
         openAiAssistant?: never;
         webhook?: never;
@@ -126,6 +214,7 @@ export declare namespace BotEndpoint {
         $unknown?: never;
     }
     interface OpenAiAssistantMember {
+        llm?: never;
         dialogflowCx?: never;
         openAiAssistant: BotOpenAiAssistantEndpoint;
         webhook?: never;
@@ -133,6 +222,7 @@ export declare namespace BotEndpoint {
         $unknown?: never;
     }
     interface WebhookMember {
+        llm?: never;
         dialogflowCx?: never;
         openAiAssistant?: never;
         webhook: BotWebhookEndpoint;
@@ -140,6 +230,7 @@ export declare namespace BotEndpoint {
         $unknown?: never;
     }
     interface SqsMember {
+        llm?: never;
         dialogflowCx?: never;
         openAiAssistant?: never;
         webhook?: never;
@@ -150,6 +241,7 @@ export declare namespace BotEndpoint {
      * @public
      */
     interface $UnknownMember {
+        llm?: never;
         dialogflowCx?: never;
         openAiAssistant?: never;
         webhook?: never;
@@ -157,13 +249,14 @@ export declare namespace BotEndpoint {
         $unknown: [string, any];
     }
     interface Visitor<T> {
+        llm: (value: VoiceBotLlmEndpoint) => T;
         dialogflowCx: (value: BotDialogflowCxEndpoint) => T;
         openAiAssistant: (value: BotOpenAiAssistantEndpoint) => T;
         webhook: (value: BotWebhookEndpoint) => T;
         sqs: (value: BotSqsEndpoint) => T;
         _: (name: string, value: any) => T;
     }
-    const visit: <T>(value: BotEndpoint, visitor: Visitor<T>) => T;
+    const visit: <T>(value: VoiceBotEndpoint, visitor: Visitor<T>) => T;
 }
 /**
  * @public
@@ -210,7 +303,7 @@ export interface CreateVoiceBotInput {
      * An endpoint to use to generate replies during voice bot session.
      * @public
      */
-    endpoint: BotEndpoint;
+    endpoint: VoiceBotEndpoint;
     company?: string;
 }
 /**
@@ -228,7 +321,7 @@ export interface VoiceBot {
      * An endpoint to use to generate replies during voice bot session.
      * @public
      */
-    endpoint: BotEndpoint;
+    endpoint: VoiceBotEndpoint;
     id: string;
     createdAt: string;
     updatedAt?: string;
@@ -310,6 +403,34 @@ export interface InterruptionWebsocketEvent {
     type: string;
     event: InterruptionEvent;
 }
+/**
+ * @public
+ */
+export interface PlaybackEvent {
+    type: VoiceBotEventType;
+    replyId: string;
+    text: string;
+    complete: boolean;
+    startTime: number;
+    endTime?: number;
+}
+/**
+ * @public
+ */
+export interface PlaybackWebhookEvent {
+    sessionId: string;
+    botId: string;
+    callId: string;
+    flowIndex: number;
+    event: PlaybackEvent;
+}
+/**
+ * @public
+ */
+export interface PlaybackWebsocketEvent {
+    type: string;
+    event: PlaybackEvent;
+}
 /**
  * @public
  */
@@ -440,6 +561,7 @@ export interface TransferWebsocketCommand {
 export interface DescribeEventOutput {
     TranscriptionWebsocketEvent?: TranscriptionWebsocketEvent;
     ReplyWebsocketEvent?: ReplyWebsocketEvent;
+    PlaybackWebsocketEvent?: PlaybackWebsocketEvent;
     InterruptionWebsocketEvent?: InterruptionWebsocketEvent;
     CompleteWebsocketEvent?: CompleteWebsocketEvent;
     SayWebsocketCommand?: SayWebsocketCommand;
@@ -449,6 +571,7 @@ export interface DescribeEventOutput {
     SessionEndedWebhookEvent?: SessionEndedWebhookEvent;
     TranscriptionWebhookEvent?: TranscriptionWebhookEvent;
     ReplyWebhookEvent?: ReplyWebhookEvent;
+    PlaybackWebhookEvent?: PlaybackWebhookEvent;
     InterruptionWebhookEvent?: InterruptionWebhookEvent;
     CompleteWebhookEvent?: CompleteWebhookEvent;
 }
@@ -574,7 +697,7 @@ export interface UpdateVoiceBotInput {
      * An endpoint to use to generate replies during voice bot session.
      * @public
      */
-    endpoint: BotEndpoint;
+    endpoint: VoiceBotEndpoint;
     company?: string;
     botId: string;
 }

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@wildix/wim-voicebots-client",
     "description": "@wildix/wim-voicebots-client client",
-    "version": "1.0.4",
+    "version": "1.0.6",
     "scripts": {
         "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
         "build:cjs": "tsc -p tsconfig.cjs.json",