@sinch/voice 1.5.0 → 1.6.0

package/dist/models/v2/svaml-commands/dial-command/dial-command.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"dial-command.js","sourceRoot":"","sources":["../../../../../src/models/v2/svaml-commands/dial-command/dial-command.ts"],"names":[],"mappings":";;;AAuBA,oCAAoC;AACvB,QAAA,eAAe,GAAG,OAAO,CAAC"}

package/dist/models/v2/svaml-commands/dial-command/index.d.ts

@@ -0,0 +1,2 @@
+export type { DialCommand } from './dial-command';
+export type { CallEvents } from './call-events';

package/dist/models/v2/svaml-commands/dial-command/index.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=index.js.map

package/dist/models/v2/svaml-commands/dial-command/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../src/models/v2/svaml-commands/dial-command/index.ts"],"names":[],"mappings":""}

package/dist/models/v2/svaml-commands/goto-menu-command/goto-menu-command.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Switches execution to another menu within the current menu context. The menu name must be a menu defined in the `menu` command. This is a blocking command — execution waits for the menu to complete before proceeding to the next command.  **Important**: this command can only be called within a menu execution context.
+ */
+export interface GotoMenuCommand {
+    /** Switch execution to another menu within the current menu context. */
+    command: 'gotoMenu';
+    /** Name of the target menu to execute next. Must match a key in menus. */
+    menuName: string;
+}

package/dist/models/v2/svaml-commands/goto-menu-command/goto-menu-command.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=goto-menu-command.js.map

package/dist/models/v2/svaml-commands/goto-menu-command/goto-menu-command.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"goto-menu-command.js","sourceRoot":"","sources":["../../../../../src/models/v2/svaml-commands/goto-menu-command/goto-menu-command.ts"],"names":[],"mappings":""}

package/dist/models/v2/svaml-commands/goto-menu-command/index.d.ts

@@ -0,0 +1 @@
+export type { GotoMenuCommand } from './goto-menu-command';

package/dist/models/v2/svaml-commands/goto-menu-command/index.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=index.js.map

package/dist/models/v2/svaml-commands/goto-menu-command/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../src/models/v2/svaml-commands/goto-menu-command/index.ts"],"names":[],"mappings":""}

package/dist/models/v2/svaml-commands/hangup-command/hangup-command.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Ends a call leg. This is a non-blocking command — execution continues to the next command in the sequence even though the call has been ended. The `onHangup` event is triggered for the call leg that was ended.  Any subsequent commands that target the ended call leg (such as `messages` or other media commands) are valid but will not be executed. Commands that operate independently — such as initiating a new call with `dial` — will execute normally. This makes it possible, for example, to end one call and immediately start another within the same sequence.
+ */
+export interface HangupCommand {
+    /** Hangup call */
+    command: 'hangup';
+    /** Name of the call leg to end, as set by `callName` in the `dial` command.  If omitted, the current call leg is ended. */
+    callName?: string;
+}
+/** Validation regex for callName */
+export declare const callNamePattern: RegExp;

package/dist/models/v2/svaml-commands/hangup-command/hangup-command.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.callNamePattern = void 0;
+/** Validation regex for callName */
+exports.callNamePattern = /^\S+$/;
+//# sourceMappingURL=hangup-command.js.map

package/dist/models/v2/svaml-commands/hangup-command/hangup-command.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"hangup-command.js","sourceRoot":"","sources":["../../../../../src/models/v2/svaml-commands/hangup-command/hangup-command.ts"],"names":[],"mappings":";;;AASA,oCAAoC;AACvB,QAAA,eAAe,GAAG,OAAO,CAAC"}

package/dist/models/v2/svaml-commands/hangup-command/index.d.ts

@@ -0,0 +1 @@
+export type { HangupCommand } from './hangup-command';

package/dist/models/v2/svaml-commands/hangup-command/index.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=index.js.map

package/dist/models/v2/svaml-commands/hangup-command/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../src/models/v2/svaml-commands/hangup-command/index.ts"],"names":[],"mappings":""}

package/dist/models/v2/svaml-commands/index.d.ts

@@ -0,0 +1,14 @@
+export * from './amd-command';
+export * from './answer-command';
+export * from './bridge-call-command';
+export * from './dial-command';
+export * from './goto-menu-command';
+export * from './hangup-command';
+export * from './menu-command';
+export * from './messages-command';
+export * from './pause-command';
+export * from './start-recording-command';
+export * from './stop-messages-command';
+export * from './stop-recording-command';
+export * from './svaml-command';
+export * from './webhook-command';

package/dist/models/v2/svaml-commands/index.js

@@ -0,0 +1,31 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./amd-command"), exports);
+__exportStar(require("./answer-command"), exports);
+__exportStar(require("./bridge-call-command"), exports);
+__exportStar(require("./dial-command"), exports);
+__exportStar(require("./goto-menu-command"), exports);
+__exportStar(require("./hangup-command"), exports);
+__exportStar(require("./menu-command"), exports);
+__exportStar(require("./messages-command"), exports);
+__exportStar(require("./pause-command"), exports);
+__exportStar(require("./start-recording-command"), exports);
+__exportStar(require("./stop-messages-command"), exports);
+__exportStar(require("./stop-recording-command"), exports);
+__exportStar(require("./svaml-command"), exports);
+__exportStar(require("./webhook-command"), exports);
+//# sourceMappingURL=index.js.map

package/dist/models/v2/svaml-commands/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/models/v2/svaml-commands/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,gDAA8B;AAC9B,mDAAiC;AACjC,wDAAsC;AACtC,iDAA+B;AAC/B,sDAAoC;AACpC,mDAAiC;AACjC,iDAA+B;AAC/B,qDAAmC;AACnC,kDAAgC;AAChC,4DAA0C;AAC1C,0DAAwC;AACxC,2DAAyC;AACzC,kDAAgC;AAChC,oDAAkC"}

package/dist/models/v2/svaml-commands/menu-command/index.d.ts

@@ -0,0 +1 @@
+export type { MenuCommand } from './menu-command';

package/dist/models/v2/svaml-commands/menu-command/index.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=index.js.map

package/dist/models/v2/svaml-commands/menu-command/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../src/models/v2/svaml-commands/menu-command/index.ts"],"names":[],"mappings":""}

package/dist/models/v2/svaml-commands/menu-command/menu-command.d.ts

@@ -0,0 +1,14 @@
+import { MenuItem } from '../../menu-item';
+/**
+ * Defines a set of named menus and executes them starting from startMenu. This is a blocking command — execution waits for the menu to complete before proceeding to the next command.  Each menu item configures prompts, input collection, timeout handling, and repeat behavior.
+ */
+export interface MenuCommand {
+    /** Executes menu-based input collection using the configured menu definitions. */
+    command: 'menu';
+    /** Name of the menu to execute first. Must match a key in menus. */
+    startMenu: string;
+    /** Map of menu definitions keyed by menu name. */
+    menus: {
+        [key: string]: MenuItem;
+    };
+}

package/dist/models/v2/svaml-commands/menu-command/menu-command.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=menu-command.js.map

package/dist/models/v2/svaml-commands/menu-command/menu-command.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"menu-command.js","sourceRoot":"","sources":["../../../../../src/models/v2/svaml-commands/menu-command/menu-command.ts"],"names":[],"mappings":""}

package/dist/models/v2/svaml-commands/messages-command/index.d.ts

@@ -0,0 +1,2 @@
+export type { MessagesCommand } from './messages-command';
+export type { MessageEvents } from './message-events';

package/dist/models/v2/svaml-commands/messages-command/index.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=index.js.map

package/dist/models/v2/svaml-commands/messages-command/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../src/models/v2/svaml-commands/messages-command/index.ts"],"names":[],"mappings":""}

package/dist/models/v2/svaml-commands/messages-command/message-events.d.ts

@@ -0,0 +1,8 @@
+import { SvamlCommand } from '../svaml-command';
+/**
+ * SVAML commands to execute based on message playback outcomes.
+ */
+export interface MessageEvents {
+    /** Commands to execute when all messages in the sequence have finished playing.  */
+    onFinish?: SvamlCommand[];
+}

package/dist/models/v2/svaml-commands/messages-command/message-events.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=message-events.js.map

package/dist/models/v2/svaml-commands/messages-command/message-events.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"message-events.js","sourceRoot":"","sources":["../../../../../src/models/v2/svaml-commands/messages-command/message-events.ts"],"names":[],"mappings":""}

package/dist/models/v2/svaml-commands/messages-command/messages-command.d.ts

@@ -0,0 +1,17 @@
+import { Message } from '../../message';
+import { MessageEvents } from './message-events';
+/**
+ * Plays one or more messages on the call. Multiple messages in the array are played sequentially in order.  This is a non-blocking command — the next command in the sequence executes immediately while messages play in parallel.  Playback outcomes are handled via the `events` property. The `onFinish` event can be used to run a command after all messages complete.
+ */
+export interface MessagesCommand {
+    /** Command to play a message on the channel */
+    command: 'messages';
+    /** Name of the message for identification and reference within the call session.  This name is used to uniquely identify the message and must be unique within the current call session. This name can be referenced in other commands (e.g., `stopMessages`) to control this specific message. */
+    messagesName?: string;
+    /** Ordered list of messages to play. */
+    messages: Message[];
+    /** @see MessageEvents */
+    events?: MessageEvents;
+}
+/** Validation regex for messagesName */
+export declare const messagesNamePattern: RegExp;

package/dist/models/v2/svaml-commands/messages-command/messages-command.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.messagesNamePattern = void 0;
+/** Validation regex for messagesName */
+exports.messagesNamePattern = /^\S+$/;
+//# sourceMappingURL=messages-command.js.map

package/dist/models/v2/svaml-commands/messages-command/messages-command.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"messages-command.js","sourceRoot":"","sources":["../../../../../src/models/v2/svaml-commands/messages-command/messages-command.ts"],"names":[],"mappings":";;;AAgBA,wCAAwC;AAC3B,QAAA,mBAAmB,GAAG,OAAO,CAAC"}

package/dist/models/v2/svaml-commands/pause-command/index.d.ts

@@ -0,0 +1 @@
+export type { PauseCommand } from './pause-command';

package/dist/models/v2/svaml-commands/pause-command/index.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=index.js.map

package/dist/models/v2/svaml-commands/pause-command/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../src/models/v2/svaml-commands/pause-command/index.ts"],"names":[],"mappings":""}

package/dist/models/v2/svaml-commands/pause-command/pause-command.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Delays execution of the next command in the sequence for a specified duration. This is a blocking command — no further commands execute until the pause completes.  The pause does not affect call audio; the call remains connected and audio continues uninterrupted.
+ */
+export interface PauseCommand {
+    /** Pause execution. */
+    command: 'pause';
+    /** Duration of the pause in milliseconds. */
+    durationMilliseconds: number;
+}

package/dist/models/v2/svaml-commands/pause-command/pause-command.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=pause-command.js.map

package/dist/models/v2/svaml-commands/pause-command/pause-command.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"pause-command.js","sourceRoot":"","sources":["../../../../../src/models/v2/svaml-commands/pause-command/pause-command.ts"],"names":[],"mappings":""}

package/dist/models/v2/svaml-commands/start-recording-command/index.d.ts

@@ -0,0 +1,2 @@
+export type { StartRecordingCommand } from './start-recording-command';
+export type { RecordingEvents } from './recording-events';

package/dist/models/v2/svaml-commands/start-recording-command/index.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=index.js.map

package/dist/models/v2/svaml-commands/start-recording-command/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../src/models/v2/svaml-commands/start-recording-command/index.ts"],"names":[],"mappings":""}

package/dist/models/v2/svaml-commands/start-recording-command/recording-events.d.ts

@@ -0,0 +1,10 @@
+import { SvamlCommand } from '../svaml-command';
+/**
+ * SVAML commands to execute based on recording lifecycle outcomes.
+ */
+export interface RecordingEvents {
+    /** Commands to execute when the recording is successfully stopped. Note that this does not mean that the file is delivered to the configured destination yet.  */
+    onFinish?: SvamlCommand[];
+    /** Commands to execute if the recording fails to start. If omitted, failures are silently ignored and the call flow continues.  */
+    onFailure?: SvamlCommand[];
+}

package/dist/models/v2/svaml-commands/start-recording-command/recording-events.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=recording-events.js.map

package/dist/models/v2/svaml-commands/start-recording-command/recording-events.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"recording-events.js","sourceRoot":"","sources":["../../../../../src/models/v2/svaml-commands/start-recording-command/recording-events.ts"],"names":[],"mappings":""}

package/dist/models/v2/svaml-commands/start-recording-command/start-recording-command.d.ts

@@ -0,0 +1,17 @@
+import { RecordingOptions } from '../../recording-options';
+import { RecordingEvents } from './recording-events';
+/**
+ * Starts recording the call. This is a non-blocking command — execution continues to the next command in the sequence immediately after recording begins.
+ */
+export interface StartRecordingCommand {
+    /** Command to start recording on the channel */
+    command: 'startRecording';
+    /** Identifier for this recording within the session. Must be unique across active recordings in the session.  Other commands (e.g., `stopRecording`) reference this name to target a specific recording.  Setting the recording name is useful for stopping the recording using the `stopRecording` command. If name is not set, recording can only be stopped when the call is disconnected. */
+    recordingName?: string;
+    /** @see RecordingOptions */
+    recordingOptions: RecordingOptions;
+    /** @see RecordingEvents */
+    events?: RecordingEvents;
+}
+/** Validation regex for recordingName */
+export declare const recordingNamePattern: RegExp;

package/dist/models/v2/svaml-commands/start-recording-command/start-recording-command.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.recordingNamePattern = void 0;
+/** Validation regex for recordingName */
+exports.recordingNamePattern = /^\S+$/;
+//# sourceMappingURL=start-recording-command.js.map

package/dist/models/v2/svaml-commands/start-recording-command/start-recording-command.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"start-recording-command.js","sourceRoot":"","sources":["../../../../../src/models/v2/svaml-commands/start-recording-command/start-recording-command.ts"],"names":[],"mappings":";;;AAgBA,yCAAyC;AAC5B,QAAA,oBAAoB,GAAG,OAAO,CAAC"}

package/dist/models/v2/svaml-commands/stop-messages-command/index.d.ts

@@ -0,0 +1 @@
+export type { StopMessagesCommand } from './stop-messages-command';

package/dist/models/v2/svaml-commands/stop-messages-command/index.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=index.js.map

package/dist/models/v2/svaml-commands/stop-messages-command/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../src/models/v2/svaml-commands/stop-messages-command/index.ts"],"names":[],"mappings":""}

package/dist/models/v2/svaml-commands/stop-messages-command/stop-messages-command.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Stops a message sequence started by a `messages` command. It will also cancel any messages with specified `messagesName` that will appear in the call session in the future.  This is a non-blocking command.
+ */
+export interface StopMessagesCommand {
+    /** Command to stop playing messages */
+    command: 'stopMessages';
+    /** Name of the message sequence to stop, as set by `messagesName` in the `messages` command. */
+    messagesName: string;
+}
+/** Validation regex for messagesName */
+export declare const messagesNamePattern: RegExp;

package/dist/models/v2/svaml-commands/stop-messages-command/stop-messages-command.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.messagesNamePattern = void 0;
+/** Validation regex for messagesName */
+exports.messagesNamePattern = /^\S+$/;
+//# sourceMappingURL=stop-messages-command.js.map

package/dist/models/v2/svaml-commands/stop-messages-command/stop-messages-command.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"stop-messages-command.js","sourceRoot":"","sources":["../../../../../src/models/v2/svaml-commands/stop-messages-command/stop-messages-command.ts"],"names":[],"mappings":";;;AASA,wCAAwC;AAC3B,QAAA,mBAAmB,GAAG,OAAO,CAAC"}

package/dist/models/v2/svaml-commands/stop-recording-command/index.d.ts

@@ -0,0 +1 @@
+export type { StopRecordingCommand } from './stop-recording-command';

package/dist/models/v2/svaml-commands/stop-recording-command/index.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=index.js.map

package/dist/models/v2/svaml-commands/stop-recording-command/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../src/models/v2/svaml-commands/stop-recording-command/index.ts"],"names":[],"mappings":""}

package/dist/models/v2/svaml-commands/stop-recording-command/stop-recording-command.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Stops a recording previously started by a `startRecording` command. This is a non-blocking command — execution continues to the next command in the sequence immediately after the stop is initiated.
+ */
+export interface StopRecordingCommand {
+    /** Command to stop recording on the channel */
+    command: 'stopRecording';
+    /** Name of the recording to stop, as set by `recordingName` in the `startRecording` command. */
+    recordingName: string;
+}
+/** Validation regex for recordingName */
+export declare const recordingNamePattern: RegExp;

package/dist/models/v2/svaml-commands/stop-recording-command/stop-recording-command.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.recordingNamePattern = void 0;
+/** Validation regex for recordingName */
+exports.recordingNamePattern = /^\S+$/;
+//# sourceMappingURL=stop-recording-command.js.map

package/dist/models/v2/svaml-commands/stop-recording-command/stop-recording-command.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"stop-recording-command.js","sourceRoot":"","sources":["../../../../../src/models/v2/svaml-commands/stop-recording-command/stop-recording-command.ts"],"names":[],"mappings":";;;AASA,yCAAyC;AAC5B,QAAA,oBAAoB,GAAG,OAAO,CAAC"}

package/dist/models/v2/svaml-commands/svaml-command/index.d.ts

@@ -0,0 +1 @@
+export type { SvamlCommand } from './svaml-command';

package/dist/models/v2/svaml-commands/svaml-command/index.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=index.js.map

package/dist/models/v2/svaml-commands/svaml-command/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../src/models/v2/svaml-commands/svaml-command/index.ts"],"names":[],"mappings":""}

package/dist/models/v2/svaml-commands/svaml-command/svaml-command.d.ts

@@ -0,0 +1,17 @@
+import { AmdCommand } from '../amd-command';
+import { AnswerCommand } from '../answer-command';
+import { BridgeCallCommand } from '../bridge-call-command';
+import { DialCommand } from '../dial-command';
+import { GotoMenuCommand } from '../goto-menu-command';
+import { HangupCommand } from '../hangup-command';
+import { MenuCommand } from '../menu-command';
+import { MessagesCommand } from '../messages-command';
+import { PauseCommand } from '../pause-command';
+import { StartRecordingCommand } from '../start-recording-command';
+import { StopMessagesCommand } from '../stop-messages-command';
+import { StopRecordingCommand } from '../stop-recording-command';
+import { WebhookCommand } from '../webhook-command';
+/**
+ * A single SVAML (Sinch Voice Application Markup Language) command that controls call behavior.  The `command` property acts as a discriminator and determines which command schema applies. When multiple commands appear in a `svamlCommands` array, they execute sequentially in order.  **Available commands:** - `dial` — Initiate an outbound call leg within the session. - `messages` — Play one or more TTS or audio messages on the call. - `stopMessages` — Stop a currently playing message sequence. - `webhook` — Trigger a mid-call webhook to the application backend for dynamic call control. - `amd` — Detect whether the call was answered by a human or an answering machine. - `hangup` — End the call or a specific call leg within the session. - `answer` — Explicitly answer an incoming call leg before executing further commands. - `pause` — Delay script execution without affecting call audio. - `startRecording` — Begin recording the call. - `stopRecording` — Stop an active call recording. - `bridgeCall` — Add the call to a named bridge for multi-party audio. - `menu` — Run menu-based input collection and route the call based on collected input. - `gotoMenu` — Switch execution to another named menu within the current menu context.
+ */
+export type SvamlCommand = AmdCommand | DialCommand | MessagesCommand | StopMessagesCommand | WebhookCommand | HangupCommand | AnswerCommand | PauseCommand | StartRecordingCommand | StopRecordingCommand | BridgeCallCommand | MenuCommand | GotoMenuCommand;

package/dist/models/v2/svaml-commands/svaml-command/svaml-command.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=svaml-command.js.map

package/dist/models/v2/svaml-commands/svaml-command/svaml-command.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"svaml-command.js","sourceRoot":"","sources":["../../../../../src/models/v2/svaml-commands/svaml-command/svaml-command.ts"],"names":[],"mappings":""}

package/dist/models/v2/svaml-commands/webhook-command/index.d.ts

@@ -0,0 +1 @@
+export type { WebhookCommand } from './webhook-command';

package/dist/models/v2/svaml-commands/webhook-command/index.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=index.js.map

package/dist/models/v2/svaml-commands/webhook-command/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../src/models/v2/svaml-commands/webhook-command/index.ts"],"names":[],"mappings":""}

package/dist/models/v2/svaml-commands/webhook-command/webhook-command.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Triggers a mid-call webhook to the application backend, allowing it to return a new set of SVAML commands that control the remainder of the call flow.  This is a blocking command — execution pauses until a response is received from the webhook endpoint. The next command in the sequence runs only after the backend responds. Webhook requests use a 5-second timeout. If a `fallbackUrl` is provided, a failed request is re-sent to it — see *Timeouts and failover* in the **Webhooks** section for the authoritative algorithm.
+ */
+export interface WebhookCommand {
+    /** Command to trigger a mid-call webhook */
+    command: 'webhook';
+    /** Name for this webhook event. When triggered, the webhook request\'s `event` property will contain this name prepended with `call.webhook.`.  For example, if `webhookName` is set to `\"my.custom.event\"`, the event will be delivered as `\"call.webhook.my.custom.event\"`. */
+    webhookName: string;
+    /** URL of the webhook endpoint to send the mid-call event to. */
+    url: string;
+    /** Fallback webhook URL used when the primary webhook URL fails.  A failed request is re-sent to this URL immediately. After repeated consecutive failures of the primary URL, requests are sent only here until the primary URL recovers.  See *Timeouts and failover* in the **Webhooks** section for the authoritative algorithm. */
+    fallbackUrl?: string;
+}
+/** Validation regex for webhookName */
+export declare const webhookNamePattern: RegExp;

package/dist/models/v2/svaml-commands/webhook-command/webhook-command.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.webhookNamePattern = void 0;
+/** Validation regex for webhookName */
+exports.webhookNamePattern = /^\S+$/;
+//# sourceMappingURL=webhook-command.js.map

package/dist/models/v2/svaml-commands/webhook-command/webhook-command.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"webhook-command.js","sourceRoot":"","sources":["../../../../../src/models/v2/svaml-commands/webhook-command/webhook-command.ts"],"names":[],"mappings":";;;AAaA,uCAAuC;AAC1B,QAAA,kBAAkB,GAAG,OAAO,CAAC"}

package/dist/models/v2/svaml-description-response/index.d.ts

@@ -0,0 +1 @@
+export type { SvamlDescriptionResponse } from './svaml-description-response';

package/dist/models/v2/svaml-description-response/index.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=index.js.map

package/dist/models/v2/svaml-description-response/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/models/v2/svaml-description-response/index.ts"],"names":[],"mappings":""}

package/dist/models/v2/svaml-description-response/svaml-description-response.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Response containing a human-readable description of the SVAML call flow.
+ */
+export interface SvamlDescriptionResponse {
+    /** Human-readable description of the call flow. */
+    description?: string;
+}

package/dist/models/v2/svaml-description-response/svaml-description-response.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=svaml-description-response.js.map

package/dist/models/v2/svaml-description-response/svaml-description-response.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"svaml-description-response.js","sourceRoot":"","sources":["../../../../src/models/v2/svaml-description-response/svaml-description-response.ts"],"names":[],"mappings":""}

package/dist/models/v2/svaml-input/index.d.ts

@@ -0,0 +1 @@
+export type { SvamlInput, SvamlInputEvents } from './svaml-input';

package/dist/models/v2/svaml-input/index.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=index.js.map

package/dist/models/v2/svaml-input/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/models/v2/svaml-input/index.ts"],"names":[],"mappings":""}

package/dist/models/v2/svaml-input/svaml-input.d.ts

@@ -0,0 +1,20 @@
+import { SvamlCommand } from '../svaml-commands';
+/**
+ * Commands to execute on specific events for this call.
+ */
+export interface SvamlInputEvents {
+    /** SVAML commands to be executed when the call is hung up. */
+    onHangup?: SvamlCommand[];
+}
+/**
+ * A SVAML v2 (Sinch Voice Application Markup Language) document describing a call flow.
+ * Contains the ordered list of commands to execute, an optional call name, and optional event handlers.
+ */
+export interface SvamlInput {
+    /** The ordered list of SVAML commands to execute. Contains at least one command. */
+    commands: SvamlCommand[];
+    /** Name of the call. */
+    callName?: string;
+    /** Commands to execute on specific events for this call. */
+    events?: SvamlInputEvents;
+}

package/dist/models/v2/svaml-input/svaml-input.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=svaml-input.js.map

package/dist/models/v2/svaml-input/svaml-input.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"svaml-input.js","sourceRoot":"","sources":["../../../../src/models/v2/svaml-input/svaml-input.ts"],"names":[],"mappings":""}

package/dist/models/v2/transcription-options/index.d.ts

@@ -0,0 +1 @@
+export type { TranscriptionOptions } from './transcription-options';

package/dist/models/v2/transcription-options/index.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=index.js.map

package/dist/models/v2/transcription-options/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/models/v2/transcription-options/index.ts"],"names":[],"mappings":""}

package/dist/models/v2/transcription-options/transcription-options.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Configuration for automatic speech-to-text transcription of the recording.
+ */
+export interface TranscriptionOptions {
+    /** If true, the recording will be transcribed to text. */
+    isEnabled: boolean;
+    /** Language code in BCP-47 format. */
+    locale?: string;
+}