@wildix/wim-voicebots-client 1.0.22 → 1.0.24

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

@@ -28,6 +28,7 @@ export declare class ForbiddenException extends __BaseException {
  * @enum
  */
 export declare const VoiceBotEventType: {
+    readonly AUDIO: "audio";
     readonly COMPLETE: "complete";
     readonly ENDED: "ended";
     readonly INTERRUPTION: "interruption";
@@ -40,6 +41,27 @@ export declare const VoiceBotEventType: {
  * @public
  */
 export type VoiceBotEventType = typeof VoiceBotEventType[keyof typeof VoiceBotEventType];
+/**
+ * @public
+ */
+export interface AudioEvent {
+    type: VoiceBotEventType;
+    /**
+     * Audio chunk with a specified sample rate defined in the session.
+     * @public
+     */
+    data: string;
+}
+/**
+ * @public
+ */
+export interface AudioWebhookEvent {
+    sessionId: string;
+    botId: string;
+    callId: string;
+    flowIndex: number;
+    event: AudioEvent;
+}
 /**
  * @public
  */
@@ -114,7 +136,7 @@ export interface VoiceBotEmbeddedTool {
      * The parameters the functions accepts.
      * @public
      */
-    parameters?: __DocumentType;
+    parameters?: __DocumentType | undefined;
 }
 /**
  * @public
@@ -136,7 +158,7 @@ export interface VoiceBotFunctionIntegrationWebhookAuthorizationOAuth {
     clientId: string;
     clientSecret: string;
     endpointUrl: string;
-    scope?: string;
+    scope?: string | undefined;
 }
 /**
  * @public
@@ -208,11 +230,21 @@ export type VoiceBotFunctionIntegrationMethod = typeof VoiceBotFunctionIntegrati
  */
 export interface VoiceBotFunctionIntegrationWebhook {
     url: string;
-    method?: VoiceBotFunctionIntegrationMethod;
-    async?: boolean;
-    authorization?: VoiceBotFunctionIntegrationWebhookAuthorization;
-    headers?: (VoiceBotFunctionIntegrationWebhookHeader)[];
-    parameters?: __DocumentType;
+    method?: VoiceBotFunctionIntegrationMethod | undefined;
+    async?: boolean | undefined;
+    authorization?: VoiceBotFunctionIntegrationWebhookAuthorization | undefined;
+    headers?: (VoiceBotFunctionIntegrationWebhookHeader)[] | undefined;
+    /**
+     * Timeout in milliseconds for the webhook request.
+     * @public
+     */
+    timeout?: number | undefined;
+    /**
+     * Message spoken when the function call starts.
+     * @public
+     */
+    startMessage?: string | undefined;
+    parameters?: __DocumentType | undefined;
 }
 /**
  * @public
@@ -252,13 +284,13 @@ export interface VoiceBotFunctionDefinition {
      * A description of what the function does, used by the model to choose when and how to call the function.
      * @public
      */
-    description?: string;
+    description?: string | undefined;
     /**
      * The parameters the functions accepts, described as a JSON Schema object.
      * @public
      */
-    parameters?: __DocumentType;
-    integration?: VoiceBotFunctionIntegration;
+    parameters?: __DocumentType | undefined;
+    integration?: VoiceBotFunctionIntegration | undefined;
 }
 /**
  * @public
@@ -276,7 +308,7 @@ export type VoiceBotToolType = typeof VoiceBotToolType[keyof typeof VoiceBotTool
  */
 export interface VoiceBotTool {
     type: VoiceBotToolType;
-    function?: VoiceBotFunctionDefinition;
+    function?: VoiceBotFunctionDefinition | undefined;
 }
 /**
  * @public
@@ -287,12 +319,12 @@ export interface VoiceBotLlmEndpoint {
      * Embedded functions to use within voice session.
      * @public
      */
-    embeddedTools?: (VoiceBotEmbeddedTool)[];
+    embeddedTools?: (VoiceBotEmbeddedTool)[] | undefined;
     /**
      * Custom tools to be used within voice session.
      * @public
      */
-    tools?: (VoiceBotTool)[];
+    tools?: (VoiceBotTool)[] | undefined;
 }
 /**
  * @public
@@ -438,37 +470,37 @@ export interface VoiceBotPipelineSettings {
      * If enabled the user can interrupt the the bot playback.
      * @public
      */
-    interuptionsEnabled?: boolean;
+    interuptionsEnabled?: boolean | undefined;
     /**
      * The maximum number of seconds a call will last.
      * @public
      */
-    maximumDuration?: number;
+    maximumDuration?: number | undefined;
     /**
      * An action that should be performed when max duration reached.
      * @public
      */
-    maximumDurationAction?: VoiceBotPipelineTerminateAction;
+    maximumDurationAction?: VoiceBotPipelineTerminateAction | undefined;
     /**
      * How long to wait before a call is automatically ended due to inactivity.
      * @public
      */
-    silenceTimeout?: number;
+    silenceTimeout?: number | undefined;
     /**
      * An action that should be performed when silence timeout reached.
      * @public
      */
-    silenceTimeoutAction?: VoiceBotPipelineTerminateAction;
+    silenceTimeoutAction?: VoiceBotPipelineTerminateAction | undefined;
     /**
      * If enabled the bot can hangup the call.
      * @public
      */
-    endCallEnabled?: boolean;
+    endCallEnabled?: boolean | undefined;
     /**
      * A list of phases separated by comma, which will end the call matched.
      * @public
      */
-    endCallPhases?: string;
+    endCallPhases?: string | undefined;
 }
 /**
  * @public
@@ -479,14 +511,14 @@ export interface CreateVoiceBotInput {
      * The initial message that will be played at the start of the session.
      * @public
      */
-    message?: string;
-    pipeline?: VoiceBotPipelineSettings;
+    message?: string | undefined;
+    pipeline?: VoiceBotPipelineSettings | undefined;
     /**
      * An endpoint to use to generate replies during voice bot session.
      * @public
      */
     endpoint: VoiceBotEndpoint;
-    company?: string;
+    company?: string | undefined;
 }
 /**
  * @public
@@ -497,8 +529,8 @@ export interface VoiceBot {
      * The initial message that will be played at the start of the session.
      * @public
      */
-    message?: string;
-    pipeline?: VoiceBotPipelineSettings;
+    message?: string | undefined;
+    pipeline?: VoiceBotPipelineSettings | undefined;
     /**
      * An endpoint to use to generate replies during voice bot session.
      * @public
@@ -506,7 +538,7 @@ export interface VoiceBot {
     endpoint: VoiceBotEndpoint;
     id: string;
     createdAt: string;
-    updatedAt?: string;
+    updatedAt?: string | undefined;
 }
 /**
  * @public
@@ -520,7 +552,7 @@ export interface CreateVoiceBotOutput {
 export declare class VoiceBotNonUniqueNameException extends __BaseException {
     readonly name: "VoiceBotNonUniqueNameException";
     readonly $fault: "client";
-    type?: string;
+    type?: string | undefined;
     /**
      * @internal
      */
@@ -530,7 +562,7 @@ export declare class VoiceBotNonUniqueNameException extends __BaseException {
  * @public
  */
 export interface DeleteVoiceBotInput {
-    company?: string;
+    company?: string | undefined;
     botId: string;
 }
 /**
@@ -549,7 +581,9 @@ export interface DescribeEventInput {
  */
 export declare const VoiceBotCommandType: {
     readonly HANGUP: "hangup";
+    readonly PLAY: "play";
     readonly SAY: "say";
+    readonly STOP: "stop";
     readonly TRANSFER: "transfer";
 };
 /**
@@ -560,7 +594,7 @@ export type VoiceBotCommandType = typeof VoiceBotCommandType[keyof typeof VoiceB
  * @public
  */
 export interface HangupWebsocketCommandData {
-    reason?: string;
+    reason?: string | undefined;
     type: VoiceBotCommandType;
 }
 /**
@@ -606,7 +640,7 @@ export interface PlaybackEvent {
     text: string;
     complete: boolean;
     startTime: number;
-    endTime?: number;
+    endTime?: number | undefined;
 }
 /**
  * @public
@@ -625,6 +659,26 @@ export interface PlaybackWebsocketEvent {
     type: string;
     event: PlaybackEvent;
 }
+/**
+ * @public
+ */
+export interface PlayWebsocketCommandData {
+    replyId: string;
+    streamId: string;
+    /**
+     * The audio chunk is encoded in base64 and should be played in the stream. The chunk must use the sample rate specified in the "say" command and be PCM encoded.
+     * @public
+     */
+    data: string;
+    type: VoiceBotCommandType;
+}
+/**
+ * @public
+ */
+export interface PlayWebsocketCommand {
+    type: string;
+    command: PlayWebsocketCommandData;
+}
 /**
  * @public
  */
@@ -683,19 +737,19 @@ export type TraceActivityStatus = typeof TraceActivityStatus[keyof typeof TraceA
  * @public
  */
 export interface TraceConnectEventTrigger {
-    parameters?: __DocumentType;
+    parameters?: __DocumentType | undefined;
 }
 /**
  * @public
  */
 export interface TraceDisconnectEventTrigger {
-    parameters?: __DocumentType;
+    parameters?: __DocumentType | undefined;
 }
 /**
  * @public
  */
 export interface TraceDurationTimeoutTaskTrigger {
-    parameters?: __DocumentType;
+    parameters?: __DocumentType | undefined;
 }
 /**
  * @public
@@ -714,13 +768,21 @@ export interface ReplyWebsocketEvent {
     type: string;
     event: ReplyEvent;
 }
+/**
+ * @public
+ */
+export interface SayCommandAudioOptions {
+    streamId: string;
+    sampleRate: number;
+}
 /**
  * @public
  */
 export interface SayWebsocketCommandData {
     text: string;
     replyId: string;
-    interruptible?: boolean;
+    interruptible?: boolean | undefined;
+    audio?: SayCommandAudioOptions | undefined;
     type: VoiceBotCommandType;
 }
 /**
@@ -734,7 +796,7 @@ export interface SayWebsocketCommand {
  * @public
  */
 export interface TraceSilenceTimeoutTaskTrigger {
-    parameters?: __DocumentType;
+    parameters?: __DocumentType | undefined;
 }
 /**
  * @public
@@ -743,7 +805,7 @@ export interface TranscriptionEvent {
     type: VoiceBotEventType;
     id: string;
     text: string;
-    final?: boolean;
+    final?: boolean | undefined;
     time: number;
 }
 /**
@@ -995,29 +1057,32 @@ export declare namespace TraceActivityTrigger {
  * @public
  */
 export interface TraceGenerationUsage {
-    tokens?: number;
-    outputTokens?: number;
-    inputTokens?: number;
+    tokens?: number | undefined;
+    outputTokens?: number | undefined;
+    inputTokens?: number | undefined;
+    category?: string | undefined;
 }
 /**
  * @public
  */
 export interface TracePlaybackUsage {
-    chars?: number;
+    chars?: number | undefined;
+    category?: string | undefined;
 }
 /**
  * @public
  */
 export interface TraceTranscribeUsage {
-    seconds?: number;
+    seconds?: number | undefined;
+    category?: string | undefined;
 }
 /**
  * @public
  */
 export interface TraceUsage {
-    generation?: TraceGenerationUsage;
-    transcribe?: TraceTranscribeUsage;
-    playback?: TracePlaybackUsage;
+    generation?: TraceGenerationUsage | undefined;
+    transcribe?: TraceTranscribeUsage | undefined;
+    playback?: TracePlaybackUsage | undefined;
 }
 /**
  * @public
@@ -1027,33 +1092,34 @@ export interface TraceActivity {
     version: number;
     status: TraceActivityStatus;
     trigger: TraceActivityTrigger;
-    result?: TraceActivityResult;
+    result?: TraceActivityResult | undefined;
     start: number;
-    duration?: number;
-    usage?: TraceUsage;
+    duration?: number | undefined;
+    timings?: Record<string, number> | undefined;
+    usage?: TraceUsage | undefined;
 }
 /**
  * @public
  */
 export interface TraceDelegationToolCall {
-    id?: string;
+    id?: string | undefined;
 }
 /**
  * @public
  */
 export interface TraceFunctionToolCallRequest {
-    url?: string;
-    method?: string;
-    headers?: Record<string, string>;
-    body?: string;
+    url?: string | undefined;
+    method?: string | undefined;
+    headers?: Record<string, string> | undefined;
+    body?: string | undefined;
 }
 /**
  * @public
  */
 export interface TraceFunctionToolCall {
-    name?: string;
-    args?: string;
-    request?: TraceFunctionToolCallRequest;
+    name?: string | undefined;
+    args?: string | undefined;
+    request?: TraceFunctionToolCallRequest | undefined;
 }
 /**
  * @public
@@ -1064,8 +1130,8 @@ export interface TraceHangupToolCall {
  * @public
  */
 export interface TraceTransferToolCall {
-    context?: string;
-    extension?: string;
+    context?: string | undefined;
+    extension?: string | undefined;
 }
 /**
  * @public
@@ -1145,8 +1211,8 @@ export declare namespace TraceToolCall {
  * @public
  */
 export interface TraceSegmentCompletionToolMessage {
-    call?: TraceToolCall;
-    result?: string;
+    call?: TraceToolCall | undefined;
+    result?: string | undefined;
 }
 /**
  * @public
@@ -1266,16 +1332,16 @@ export interface TraceGenericInputBlock {
  */
 export interface TraceGenericInput {
     title: string;
-    blocks?: (TraceGenericInputBlock)[];
+    blocks?: (TraceGenericInputBlock)[] | undefined;
 }
 /**
  * @public
  */
 export interface TraceOAuthInput {
-    clientId?: string;
-    clientSecret?: string;
-    endpointUrl?: string;
-    scope?: string;
+    clientId?: string | undefined;
+    clientSecret?: string | undefined;
+    endpointUrl?: string | undefined;
+    scope?: string | undefined;
 }
 /**
  * @public
@@ -1409,9 +1475,9 @@ export interface TraceSegment {
     version: number;
     status: TraceSegmentStatus;
     input: TraceSegmentInput;
-    result?: TraceSegmentResult;
+    result?: TraceSegmentResult | undefined;
     start: number;
-    duration?: number;
+    duration?: number | undefined;
 }
 /**
  * @public
@@ -1437,21 +1503,21 @@ export interface TraceSession {
     botName: string;
     callId: string;
     flowIndex: number;
-    language?: string;
-    callerName?: string;
-    callerNumber?: string;
+    language?: string | undefined;
+    callerName?: string | undefined;
+    callerNumber?: string | undefined;
     status: TraceSessionStatus;
     start: number;
-    duration?: number;
+    duration?: number | undefined;
 }
 /**
  * @public
  */
 export interface PubSubBroadcastItem {
-    session?: TraceSession;
-    sessionId?: string;
-    activity?: TraceActivity;
-    segment?: TraceSegment;
+    session?: TraceSession | undefined;
+    sessionId?: string | undefined;
+    activity?: TraceActivity | undefined;
+    segment?: TraceSegment | undefined;
 }
 /**
  * @public
@@ -1504,7 +1570,7 @@ export interface ReplyWebhookEvent {
  */
 export interface SessionEndedEvent {
     type: VoiceBotEventType;
-    error?: string;
+    error?: string | undefined;
     time: number;
 }
 /**
@@ -1539,6 +1605,19 @@ export interface SessionStartedWebhookEvent {
     flowIndex: number;
     event: SessionStartedEvent;
 }
+/**
+ * @public
+ */
+export interface StopWebsocketCommandData {
+    type: VoiceBotCommandType;
+}
+/**
+ * @public
+ */
+export interface StopWebsocketCommand {
+    type: string;
+    command: StopWebsocketCommandData;
+}
 /**
  * @public
  */
@@ -1553,32 +1632,35 @@ export interface TranscriptionWebhookEvent {
  * @public
  */
 export interface DescribeEventOutput {
-    TranscriptionWebsocketEvent?: TranscriptionWebsocketEvent;
-    ReplyWebsocketEvent?: ReplyWebsocketEvent;
-    PlaybackWebsocketEvent?: PlaybackWebsocketEvent;
-    InterruptionWebsocketEvent?: InterruptionWebsocketEvent;
-    CompleteWebsocketEvent?: CompleteWebsocketEvent;
-    SayWebsocketCommand?: SayWebsocketCommand;
-    HangupWebsocketCommand?: HangupWebsocketCommand;
-    TransferWebsocketCommand?: TransferWebsocketCommand;
-    SessionStartedWebhookEvent?: SessionStartedWebhookEvent;
-    SessionEndedWebhookEvent?: SessionEndedWebhookEvent;
-    TranscriptionWebhookEvent?: TranscriptionWebhookEvent;
-    ReplyWebhookEvent?: ReplyWebhookEvent;
-    PlaybackWebhookEvent?: PlaybackWebhookEvent;
-    InterruptionWebhookEvent?: InterruptionWebhookEvent;
-    CompleteWebhookEvent?: CompleteWebhookEvent;
-    PubSubBroadcastWebsocketEvent?: PubSubBroadcastWebsocketEvent;
-    PubSubSubscribeWebsocketCommand?: PubSubSubscribeWebsocketCommand;
-    PubSubSubscribedWebsocketEvent?: PubSubSubscribedWebsocketEvent;
-    PubSubUnsubscribeWebsocketCommand?: PubSubUnsubscribeWebsocketCommand;
-    PubSubUnsubscribedWebsocketEvent?: PubSubUnsubscribedWebsocketEvent;
+    TranscriptionWebsocketEvent?: TranscriptionWebsocketEvent | undefined;
+    ReplyWebsocketEvent?: ReplyWebsocketEvent | undefined;
+    PlaybackWebsocketEvent?: PlaybackWebsocketEvent | undefined;
+    InterruptionWebsocketEvent?: InterruptionWebsocketEvent | undefined;
+    CompleteWebsocketEvent?: CompleteWebsocketEvent | undefined;
+    SayWebsocketCommand?: SayWebsocketCommand | undefined;
+    PlayWebsocketCommand?: PlayWebsocketCommand | undefined;
+    StopWebsocketCommand?: StopWebsocketCommand | undefined;
+    HangupWebsocketCommand?: HangupWebsocketCommand | undefined;
+    TransferWebsocketCommand?: TransferWebsocketCommand | undefined;
+    SessionStartedWebhookEvent?: SessionStartedWebhookEvent | undefined;
+    SessionEndedWebhookEvent?: SessionEndedWebhookEvent | undefined;
+    TranscriptionWebhookEvent?: TranscriptionWebhookEvent | undefined;
+    AudioWebhookEvent?: AudioWebhookEvent | undefined;
+    ReplyWebhookEvent?: ReplyWebhookEvent | undefined;
+    PlaybackWebhookEvent?: PlaybackWebhookEvent | undefined;
+    InterruptionWebhookEvent?: InterruptionWebhookEvent | undefined;
+    CompleteWebhookEvent?: CompleteWebhookEvent | undefined;
+    PubSubBroadcastWebsocketEvent?: PubSubBroadcastWebsocketEvent | undefined;
+    PubSubSubscribeWebsocketCommand?: PubSubSubscribeWebsocketCommand | undefined;
+    PubSubSubscribedWebsocketEvent?: PubSubSubscribedWebsocketEvent | undefined;
+    PubSubUnsubscribeWebsocketCommand?: PubSubUnsubscribeWebsocketCommand | undefined;
+    PubSubUnsubscribedWebsocketEvent?: PubSubUnsubscribedWebsocketEvent | undefined;
 }
 /**
  * @public
  */
 export interface GetTraceInput {
-    company?: string;
+    company?: string | undefined;
     sessionId: string;
 }
 /**
@@ -1588,8 +1670,8 @@ export interface Trace {
     session: TraceSession;
     activities: (TraceActivity)[];
     segments: (TraceSegment)[];
-    usage?: TraceUsage;
-    cost?: number;
+    usage?: TraceUsage | undefined;
+    cost?: number | undefined;
 }
 /**
  * @public
@@ -1603,7 +1685,7 @@ export interface GetTraceOutput {
 export declare class VoiceBotNotFoundException extends __BaseException {
     readonly name: "VoiceBotNotFoundException";
     readonly $fault: "client";
-    type?: string;
+    type?: string | undefined;
     /**
      * @internal
      */
@@ -1613,7 +1695,7 @@ export declare class VoiceBotNotFoundException extends __BaseException {
  * @public
  */
 export interface GetVoiceBotInput {
-    company?: string;
+    company?: string | undefined;
     botId: string;
 }
 /**
@@ -1626,7 +1708,7 @@ export interface GetVoiceBotOutput {
  * @public
  */
 export interface ListTracesInput {
-    company?: string;
+    company?: string | undefined;
 }
 /**
  * @public
@@ -1638,7 +1720,7 @@ export interface ListTracesOutput {
  * @public
  */
 export interface ListVoiceBotsInput {
-    company?: string;
+    company?: string | undefined;
 }
 /**
  * @public
@@ -1650,7 +1732,7 @@ export interface ListVoiceBotsOutput {
  * @public
  */
 export interface ListVoiceBotsNamesInput {
-    company?: string;
+    company?: string | undefined;
 }
 /**
  * @public
@@ -1669,7 +1751,7 @@ export interface ListVoiceBotsNamesOutput {
  * @public
  */
 export interface SendHangupInput {
-    reason?: string;
+    reason?: string | undefined;
     sessionId: string;
 }
 /**
@@ -1683,19 +1765,38 @@ export interface SendHangupOutput {
 export declare class VoiceSessionNotFoundException extends __BaseException {
     readonly name: "VoiceSessionNotFoundException";
     readonly $fault: "client";
-    type?: string;
+    type?: string | undefined;
     /**
      * @internal
      */
     constructor(opts: __ExceptionOptionType<VoiceSessionNotFoundException, __BaseException>);
 }
+/**
+ * @public
+ */
+export interface SendPlayInput {
+    replyId: string;
+    streamId: string;
+    /**
+     * The audio chunk is encoded in base64 and should be played in the stream. The chunk must use the sample rate specified in the "say" command and be PCM encoded.
+     * @public
+     */
+    data: string;
+    sessionId: string;
+}
+/**
+ * @public
+ */
+export interface SendPlayOutput {
+}
 /**
  * @public
  */
 export interface SendSayInput {
     text: string;
     replyId: string;
-    interruptible?: boolean;
+    interruptible?: boolean | undefined;
+    audio?: SayCommandAudioOptions | undefined;
     sessionId: string;
 }
 /**
@@ -1703,6 +1804,17 @@ export interface SendSayInput {
  */
 export interface SendSayOutput {
 }
+/**
+ * @public
+ */
+export interface SendStopInput {
+    sessionId: string;
+}
+/**
+ * @public
+ */
+export interface SendStopOutput {
+}
 /**
  * @public
  */
@@ -1725,14 +1837,14 @@ export interface UpdateVoiceBotInput {
      * The initial message that will be played at the start of the session.
      * @public
      */
-    message?: string;
-    pipeline?: VoiceBotPipelineSettings;
+    message?: string | undefined;
+    pipeline?: VoiceBotPipelineSettings | undefined;
     /**
      * An endpoint to use to generate replies during voice bot session.
      * @public
      */
     endpoint: VoiceBotEndpoint;
-    company?: string;
+    company?: string | undefined;
     botId: string;
 }
 /**