@wildix/wim-voicebots-client 1.0.2 → 1.0.4

package/dist-cjs/models/models_0.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.VoiceSessionNotFoundException = exports.VoiceBotNotFoundException = exports.BotEndpoint = exports.VoiceBotEventType = exports.ForbiddenException = exports.ValidationException = void 0;
+exports.VoiceSessionNotFoundException = exports.VoiceBotNotFoundException = exports.VoiceBotCommandType = exports.BotEndpoint = exports.VoiceBotEventType = exports.ForbiddenException = exports.ValidationException = void 0;
 const VoiceBotsServiceException_1 = require("./VoiceBotsServiceException");
 class ValidationException extends VoiceBotsServiceException_1.VoiceBotsServiceException {
     constructor(opts) {
@@ -50,6 +50,11 @@ var BotEndpoint;
         return visitor._(value.$unknown[0], value.$unknown[1]);
     };
 })(BotEndpoint = exports.BotEndpoint || (exports.BotEndpoint = {}));
+exports.VoiceBotCommandType = {
+    HANGUP: "hangup",
+    SAY: "say",
+    TRANSFER: "transfer",
+};
 class VoiceBotNotFoundException extends VoiceBotsServiceException_1.VoiceBotsServiceException {
     constructor(opts) {
         super({

package/dist-cjs/protocols/Aws_restJson1.js

@@ -17,11 +17,9 @@ const se_CreateVoiceBotCommand = async (input, context) => {
     let body;
     body = JSON.stringify((0, smithy_client_1.take)(input, {
         'endpoint': _ => se_BotEndpoint(_, context),
-        'languageCode': [],
-        'maximumDuration': [],
+        'message': [],
         'name': [],
-        'silenceTimeout': [],
-        'voiceId': [],
+        'pipeline': _ => (0, smithy_client_1._json)(_),
     }));
     b.m("POST")
         .h(headers)
@@ -173,11 +171,9 @@ const se_UpdateVoiceBotCommand = async (input, context) => {
     let body;
     body = JSON.stringify((0, smithy_client_1.take)(input, {
         'endpoint': _ => se_BotEndpoint(_, context),
-        'languageCode': [],
-        'maximumDuration': [],
+        'message': [],
         'name': [],
-        'silenceTimeout': [],
-        'voiceId': [],
+        'pipeline': _ => (0, smithy_client_1._json)(_),
     }));
     b.m("PUT")
         .h(headers)
@@ -223,14 +219,17 @@ const de_DescribeEventCommand = async (output, context) => {
     const doc = (0, smithy_client_1.take)(data, {
         'CompleteWebhookEvent': smithy_client_1._json,
         'CompleteWebsocketEvent': smithy_client_1._json,
+        'HangupWebsocketCommand': smithy_client_1._json,
         'InterruptionWebhookEvent': smithy_client_1._json,
         'InterruptionWebsocketEvent': smithy_client_1._json,
         'ReplyWebhookEvent': smithy_client_1._json,
         'ReplyWebsocketEvent': smithy_client_1._json,
+        'SayWebsocketCommand': smithy_client_1._json,
         'SessionEndedWebhookEvent': smithy_client_1._json,
         'SessionStartedWebhookEvent': smithy_client_1._json,
         'TranscriptionWebhookEvent': smithy_client_1._json,
         'TranscriptionWebsocketEvent': smithy_client_1._json,
+        'TransferWebsocketCommand': smithy_client_1._json,
     });
     Object.assign(contents, doc);
     return contents;
@@ -440,12 +439,10 @@ const de_VoiceBot = (output, context) => {
         'createdAt': smithy_client_1.expectString,
         'endpoint': (_) => de_BotEndpoint((0, smithy_client_1.expectUnion)(_), context),
         'id': smithy_client_1.expectString,
-        'languageCode': smithy_client_1.expectString,
-        'maximumDuration': smithy_client_1.expectInt32,
+        'message': smithy_client_1.expectString,
         'name': smithy_client_1.expectString,
-        'silenceTimeout': smithy_client_1.expectInt32,
+        'pipeline': smithy_client_1._json,
         'updatedAt': smithy_client_1.expectString,
-        'voiceId': smithy_client_1.expectString,
     });
 };
 const de_VoiceBotsList = (output, context) => {

package/dist-es/models/models_0.js

@@ -45,6 +45,11 @@ export var BotEndpoint;
         return visitor._(value.$unknown[0], value.$unknown[1]);
     };
 })(BotEndpoint || (BotEndpoint = {}));
+export const VoiceBotCommandType = {
+    HANGUP: "hangup",
+    SAY: "say",
+    TRANSFER: "transfer",
+};
 export class VoiceBotNotFoundException extends __BaseException {
     constructor(opts) {
         super({

package/dist-es/protocols/Aws_restJson1.js

@@ -1,7 +1,7 @@
 import { VoiceBotsServiceException as __BaseException } from "../models/VoiceBotsServiceException";
 import { BotEndpoint, ForbiddenException, ValidationException, VoiceBotNotFoundException, VoiceSessionNotFoundException, } from "../models/models_0";
 import { requestBuilder as rb } from "@smithy/core";
-import { decorateServiceException as __decorateServiceException, expectInt32 as __expectInt32, expectNonNull as __expectNonNull, expectObject as __expectObject, expectString as __expectString, expectUnion as __expectUnion, _json, collectBody, map, take, withBaseException, } from "@smithy/smithy-client";
+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) => {
     const b = rb(input, context);
     const headers = {
@@ -14,11 +14,9 @@ export const se_CreateVoiceBotCommand = async (input, context) => {
     let body;
     body = JSON.stringify(take(input, {
         'endpoint': _ => se_BotEndpoint(_, context),
-        'languageCode': [],
-        'maximumDuration': [],
+        'message': [],
         'name': [],
-        'silenceTimeout': [],
-        'voiceId': [],
+        'pipeline': _ => _json(_),
     }));
     b.m("POST")
         .h(headers)
@@ -161,11 +159,9 @@ export const se_UpdateVoiceBotCommand = async (input, context) => {
     let body;
     body = JSON.stringify(take(input, {
         'endpoint': _ => se_BotEndpoint(_, context),
-        'languageCode': [],
-        'maximumDuration': [],
+        'message': [],
         'name': [],
-        'silenceTimeout': [],
-        'voiceId': [],
+        'pipeline': _ => _json(_),
     }));
     b.m("PUT")
         .h(headers)
@@ -208,14 +204,17 @@ export const de_DescribeEventCommand = async (output, context) => {
     const doc = take(data, {
         'CompleteWebhookEvent': _json,
         'CompleteWebsocketEvent': _json,
+        'HangupWebsocketCommand': _json,
         'InterruptionWebhookEvent': _json,
         'InterruptionWebsocketEvent': _json,
         'ReplyWebhookEvent': _json,
         'ReplyWebsocketEvent': _json,
+        'SayWebsocketCommand': _json,
         'SessionEndedWebhookEvent': _json,
         'SessionStartedWebhookEvent': _json,
         'TranscriptionWebhookEvent': _json,
         'TranscriptionWebsocketEvent': _json,
+        'TransferWebsocketCommand': _json,
     });
     Object.assign(contents, doc);
     return contents;
@@ -417,12 +416,10 @@ const de_VoiceBot = (output, context) => {
         'createdAt': __expectString,
         'endpoint': (_) => de_BotEndpoint(__expectUnion(_), context),
         'id': __expectString,
-        'languageCode': __expectString,
-        'maximumDuration': __expectInt32,
+        'message': __expectString,
         'name': __expectString,
-        'silenceTimeout': __expectInt32,
+        'pipeline': _json,
         'updatedAt': __expectString,
-        'voiceId': __expectString,
     });
 };
 const de_VoiceBotsList = (output, context) => {

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

@@ -37,10 +37,14 @@ declare const CreateVoiceBotCommand_base: {
  * const client = new VoiceBotsClient(config);
  * const input = { // CreateVoiceBotInput
  *   name: "STRING_VALUE", // required
- *   languageCode: "STRING_VALUE", // required
- *   voiceId: "STRING_VALUE", // required
- *   maximumDuration: Number("int"),
- *   silenceTimeout: Number("int"),
+ *   message: "STRING_VALUE",
+ *   pipeline: { // VoiceBotPipelineSettings
+ *     interuptionsEnabled: true || false,
+ *     maximumDuration: Number("int"),
+ *     silenceTimeout: Number("int"),
+ *     endCallEnabled: true || false,
+ *     endCallPhases: "STRING_VALUE",
+ *   },
  *   endpoint: { // BotEndpoint Union: only one key present
  *     dialogflowCx: { // BotDialogflowCxEndpoint
  *       credentials: "DOCUMENT_VALUE", // required
@@ -69,10 +73,14 @@ declare const CreateVoiceBotCommand_base: {
  * // { // CreateVoiceBotOutput
  * //   bot: { // VoiceBot
  * //     name: "STRING_VALUE", // required
- * //     languageCode: "STRING_VALUE", // required
- * //     voiceId: "STRING_VALUE", // required
- * //     maximumDuration: Number("int"),
- * //     silenceTimeout: Number("int"),
+ * //     message: "STRING_VALUE",
+ * //     pipeline: { // VoiceBotPipelineSettings
+ * //       interuptionsEnabled: true || false,
+ * //       maximumDuration: Number("int"),
+ * //       silenceTimeout: Number("int"),
+ * //       endCallEnabled: true || false,
+ * //       endCallPhases: "STRING_VALUE",
+ * //     },
  * //     endpoint: { // BotEndpoint Union: only one key present
  * //       dialogflowCx: { // BotDialogflowCxEndpoint
  * //         credentials: "DOCUMENT_VALUE", // required

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

@@ -72,9 +72,34 @@ declare const DescribeEventCommand_base: {
  * //     type: "STRING_VALUE", // required
  * //     event: { // CompleteEvent
  * //       type: "started" || "ended" || "reply" || "transcription" || "interruption" || "complete", // required
+ * //       reason: "STRING_VALUE", // required
  * //       time: Number("long"), // required
  * //     },
  * //   },
+ * //   SayWebsocketCommand: { // SayWebsocketCommand
+ * //     type: "STRING_VALUE", // required
+ * //     command: { // SayWebsocketCommandData
+ * //       text: "STRING_VALUE", // required
+ * //       replyId: "STRING_VALUE", // required
+ * //       interruptible: true || false,
+ * //       type: "say" || "hangup" || "transfer", // required
+ * //     },
+ * //   },
+ * //   HangupWebsocketCommand: { // HangupWebsocketCommand
+ * //     type: "STRING_VALUE", // required
+ * //     command: { // HangupWebsocketCommandData
+ * //       reason: "STRING_VALUE",
+ * //       type: "say" || "hangup" || "transfer", // required
+ * //     },
+ * //   },
+ * //   TransferWebsocketCommand: { // TransferWebsocketCommand
+ * //     type: "STRING_VALUE", // required
+ * //     command: { // TransferWebsocketCommandData
+ * //       context: "STRING_VALUE", // required
+ * //       extension: "STRING_VALUE", // required
+ * //       type: "say" || "hangup" || "transfer", // required
+ * //     },
+ * //   },
  * //   SessionStartedWebhookEvent: { // SessionStartedWebhookEvent
  * //     sessionId: "STRING_VALUE", // required
  * //     botId: "STRING_VALUE", // required
@@ -82,6 +107,7 @@ declare const DescribeEventCommand_base: {
  * //     flowIndex: Number("int"), // required
  * //     event: { // SessionStartedEvent
  * //       type: "started" || "ended" || "reply" || "transcription" || "interruption" || "complete", // required
+ * //       language: "STRING_VALUE", // required
  * //       time: Number("long"), // required
  * //     },
  * //   },

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

@@ -44,10 +44,14 @@ declare const GetVoiceBotCommand_base: {
  * // { // GetVoiceBotOutput
  * //   bot: { // VoiceBot
  * //     name: "STRING_VALUE", // required
- * //     languageCode: "STRING_VALUE", // required
- * //     voiceId: "STRING_VALUE", // required
- * //     maximumDuration: Number("int"),
- * //     silenceTimeout: Number("int"),
+ * //     message: "STRING_VALUE",
+ * //     pipeline: { // VoiceBotPipelineSettings
+ * //       interuptionsEnabled: true || false,
+ * //       maximumDuration: Number("int"),
+ * //       silenceTimeout: Number("int"),
+ * //       endCallEnabled: true || false,
+ * //       endCallPhases: "STRING_VALUE",
+ * //     },
  * //     endpoint: { // BotEndpoint Union: only one key present
  * //       dialogflowCx: { // BotDialogflowCxEndpoint
  * //         credentials: "DOCUMENT_VALUE", // required

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

@@ -44,10 +44,14 @@ declare const ListVoiceBotsCommand_base: {
  * //   bots: [ // VoiceBotsList // required
  * //     { // VoiceBot
  * //       name: "STRING_VALUE", // required
- * //       languageCode: "STRING_VALUE", // required
- * //       voiceId: "STRING_VALUE", // required
- * //       maximumDuration: Number("int"),
- * //       silenceTimeout: Number("int"),
+ * //       message: "STRING_VALUE",
+ * //       pipeline: { // VoiceBotPipelineSettings
+ * //         interuptionsEnabled: true || false,
+ * //         maximumDuration: Number("int"),
+ * //         silenceTimeout: Number("int"),
+ * //         endCallEnabled: true || false,
+ * //         endCallPhases: "STRING_VALUE",
+ * //       },
  * //       endpoint: { // BotEndpoint Union: only one key present
  * //         dialogflowCx: { // BotDialogflowCxEndpoint
  * //           credentials: "DOCUMENT_VALUE", // required

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

@@ -37,10 +37,14 @@ declare const UpdateVoiceBotCommand_base: {
  * const client = new VoiceBotsClient(config);
  * const input = { // UpdateVoiceBotInput
  *   name: "STRING_VALUE", // required
- *   languageCode: "STRING_VALUE", // required
- *   voiceId: "STRING_VALUE", // required
- *   maximumDuration: Number("int"),
- *   silenceTimeout: Number("int"),
+ *   message: "STRING_VALUE",
+ *   pipeline: { // VoiceBotPipelineSettings
+ *     interuptionsEnabled: true || false,
+ *     maximumDuration: Number("int"),
+ *     silenceTimeout: Number("int"),
+ *     endCallEnabled: true || false,
+ *     endCallPhases: "STRING_VALUE",
+ *   },
  *   endpoint: { // BotEndpoint Union: only one key present
  *     dialogflowCx: { // BotDialogflowCxEndpoint
  *       credentials: "DOCUMENT_VALUE", // required
@@ -70,10 +74,14 @@ declare const UpdateVoiceBotCommand_base: {
  * // { // UpdateVoiceBotOutput
  * //   bot: { // VoiceBot
  * //     name: "STRING_VALUE", // required
- * //     languageCode: "STRING_VALUE", // required
- * //     voiceId: "STRING_VALUE", // required
- * //     maximumDuration: Number("int"),
- * //     silenceTimeout: Number("int"),
+ * //     message: "STRING_VALUE",
+ * //     pipeline: { // VoiceBotPipelineSettings
+ * //       interuptionsEnabled: true || false,
+ * //       maximumDuration: Number("int"),
+ * //       silenceTimeout: Number("int"),
+ * //       endCallEnabled: true || false,
+ * //       endCallPhases: "STRING_VALUE",
+ * //     },
  * //     endpoint: { // BotEndpoint Union: only one key present
  * //       dialogflowCx: { // BotDialogflowCxEndpoint
  * //         credentials: "DOCUMENT_VALUE", // required

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

@@ -44,6 +44,7 @@ export type VoiceBotEventType = typeof VoiceBotEventType[keyof typeof VoiceBotEv
  */
 export interface CompleteEvent {
     type: VoiceBotEventType;
+    reason: string;
     time: number;
 }
 /**
@@ -167,18 +168,12 @@ export declare namespace BotEndpoint {
 /**
  * @public
  */
-export interface CreateVoiceBotInput {
-    name: string;
-    /**
-     * The language code that represents the language spoken in the voice bot.
-     * @public
-     */
-    languageCode: string;
+export interface VoiceBotPipelineSettings {
     /**
-     * Voice ID to use for the speech synthesis.
+     * If enabled the user can interrupt the the bot playback.
      * @public
      */
-    voiceId: string;
+    interuptionsEnabled?: boolean;
     /**
      * The maximum number of seconds a call will last.
      * @public
@@ -190,37 +185,45 @@ export interface CreateVoiceBotInput {
      */
     silenceTimeout?: number;
     /**
-     * An endpoint to use to generate replies during voice bot session.
+     * If enabled the bot can hangup the call.
      * @public
      */
-    endpoint: BotEndpoint;
-    company?: string;
+    endCallEnabled?: boolean;
+    /**
+     * A list of phases separated by comma, which will end the call matched.
+     * @public
+     */
+    endCallPhases?: string;
 }
 /**
  * @public
  */
-export interface VoiceBot {
+export interface CreateVoiceBotInput {
     name: string;
     /**
-     * The language code that represents the language spoken in the voice bot.
-     * @public
-     */
-    languageCode: string;
-    /**
-     * Voice ID to use for the speech synthesis.
+     * The initial message that will be played at the start of the session.
      * @public
      */
-    voiceId: string;
+    message?: string;
+    pipeline?: VoiceBotPipelineSettings;
     /**
-     * The maximum number of seconds a call will last.
+     * An endpoint to use to generate replies during voice bot session.
      * @public
      */
-    maximumDuration?: number;
+    endpoint: BotEndpoint;
+    company?: string;
+}
+/**
+ * @public
+ */
+export interface VoiceBot {
+    name: string;
     /**
-     * How long to wait before a call is automatically ended due to inactivity.
+     * The initial message that will be played at the start of the session.
      * @public
      */
-    silenceTimeout?: number;
+    message?: string;
+    pipeline?: VoiceBotPipelineSettings;
     /**
      * An endpoint to use to generate replies during voice bot session.
      * @public
@@ -253,6 +256,33 @@ export interface DeleteVoiceBotOutput {
  */
 export interface DescribeEventInput {
 }
+/**
+ * @public
+ * @enum
+ */
+export declare const VoiceBotCommandType: {
+    readonly HANGUP: "hangup";
+    readonly SAY: "say";
+    readonly TRANSFER: "transfer";
+};
+/**
+ * @public
+ */
+export type VoiceBotCommandType = typeof VoiceBotCommandType[keyof typeof VoiceBotCommandType];
+/**
+ * @public
+ */
+export interface HangupWebsocketCommandData {
+    reason?: string;
+    type: VoiceBotCommandType;
+}
+/**
+ * @public
+ */
+export interface HangupWebsocketCommand {
+    type: string;
+    command: HangupWebsocketCommandData;
+}
 /**
  * @public
  */
@@ -307,6 +337,22 @@ export interface ReplyWebsocketEvent {
     type: string;
     event: ReplyEvent;
 }
+/**
+ * @public
+ */
+export interface SayWebsocketCommandData {
+    text: string;
+    replyId: string;
+    interruptible?: boolean;
+    type: VoiceBotCommandType;
+}
+/**
+ * @public
+ */
+export interface SayWebsocketCommand {
+    type: string;
+    command: SayWebsocketCommandData;
+}
 /**
  * @public
  */
@@ -330,6 +376,11 @@ export interface SessionEndedWebhookEvent {
  */
 export interface SessionStartedEvent {
     type: VoiceBotEventType;
+    /**
+     * The language code that represents the language spoken in the session.
+     * @public
+     */
+    language: string;
     time: number;
 }
 /**
@@ -368,6 +419,21 @@ export interface TranscriptionWebsocketEvent {
     type: string;
     event: TranscriptionEvent;
 }
+/**
+ * @public
+ */
+export interface TransferWebsocketCommandData {
+    context: string;
+    extension: string;
+    type: VoiceBotCommandType;
+}
+/**
+ * @public
+ */
+export interface TransferWebsocketCommand {
+    type: string;
+    command: TransferWebsocketCommandData;
+}
 /**
  * @public
  */
@@ -376,6 +442,9 @@ export interface DescribeEventOutput {
     ReplyWebsocketEvent?: ReplyWebsocketEvent;
     InterruptionWebsocketEvent?: InterruptionWebsocketEvent;
     CompleteWebsocketEvent?: CompleteWebsocketEvent;
+    SayWebsocketCommand?: SayWebsocketCommand;
+    HangupWebsocketCommand?: HangupWebsocketCommand;
+    TransferWebsocketCommand?: TransferWebsocketCommand;
     SessionStartedWebhookEvent?: SessionStartedWebhookEvent;
     SessionEndedWebhookEvent?: SessionEndedWebhookEvent;
     TranscriptionWebhookEvent?: TranscriptionWebhookEvent;
@@ -496,25 +565,11 @@ export interface SendTransferOutput {
 export interface UpdateVoiceBotInput {
     name: string;
     /**
-     * The language code that represents the language spoken in the voice bot.
-     * @public
-     */
-    languageCode: string;
-    /**
-     * Voice ID to use for the speech synthesis.
+     * The initial message that will be played at the start of the session.
      * @public
      */
-    voiceId: string;
-    /**
-     * The maximum number of seconds a call will last.
-     * @public
-     */
-    maximumDuration?: number;
-    /**
-     * How long to wait before a call is automatically ended due to inactivity.
-     * @public
-     */
-    silenceTimeout?: number;
+    message?: string;
+    pipeline?: VoiceBotPipelineSettings;
     /**
      * An endpoint to use to generate replies during voice bot session.
      * @public

package/package.json

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