@voicenter-team/events-sdk 0.0.119 → 0.0.120

package/dist/voicenter-events-sdk.d.ts

@@ -78,6 +78,26 @@ export declare type AllUsersStatusEvent = {
 
 export declare type AllUsersStatusEventSDK = EventTypeData<EventsEnum.ALL_USERS_STATUS>
 
+export declare type AllVoicebotsStatus = {
+    /**
+     * 0 - Connection was establishing successfully.
+     */
+    errorCode?: number;
+    /**
+     * “Ok” - Connection was establishing successfully.
+     */
+    errorDesc?: string;
+    voicebots: Array<Voicebot>;
+    /**
+     * Server time at the moment of the event
+     */
+    servertime: number;
+    /**
+     * Difference in time between server and client
+     */
+    servertimeoffset: number;
+};
+
 declare class AuthClass {
     private readonly eventsSdkClass;
     constructor(eventsSdkClass: EventsSdkClass);
@@ -280,6 +300,7 @@ export declare interface EventDataMap {
     [EventsEnum.ALL_EXTENSION_STATUS]: AllExtensionStatusEvent
     [EventsEnum.ALL_DIALER_STATUS]: AllDialersStatusEvent
     [EventsEnum.ALL_USERS_STATUS]: AllUsersStatusEvent
+    [EventsEnum.ALL_VOICEBOTS_STATUS]: AllVoicebotsStatus
     [EventsEnum.QUEUE_EVENT]: QueueEvent
     [EventsEnum.EXTENSION_EVENT]: ExtensionEvent
     [EventsEnum.DIALER_EVENT]: DialerEvent
@@ -288,6 +309,11 @@ export declare interface EventDataMap {
     [EventsEnum.KEEP_ALIVE_RESPONSE]: KeepAliveResponseEvent
     [EventsEnum.ONLINE_STATUS_EVENT]: OnlineStatusEvent
     [EventsEnum.EXTENSIONS_UPDATED]: ExtensionsUpdated
+    [EventsEnum.VOICEBOT_SUBSCRIBED_TO_CALL]: SubscribedToVoicebotCall
+    [EventsEnum.VOICEBOT_SUBSCRIBE_TO_CALL_FAILED]: SubscribeToVoicebotCallFailed
+    [EventsEnum.VOICEBOT_INITIAL_CALL_HISTORY]: InitialVoicebotCallHistory
+    [EventsEnum.VOICEBOT_UNSUBSCRIBED_FROM_CALL]: UnsubscribedFromVoicebotCall
+    [EventsEnum.VOICEBOT_EVENT]: VoicebotEvent
 }
 
 /**
@@ -328,6 +354,12 @@ export declare enum EventsEnum {
     ONLINE_STATUS_EVENT = 'onlineStatusEvent',
     DIALER_EVENT = 'DialerEvent',
     EXTENSIONS_UPDATED = 'ExtensionsUpdated',
+    ALL_VOICEBOTS_STATUS = 'AllVoicebotsStatus',
+    VOICEBOT_SUBSCRIBE_TO_CALL_FAILED = 'subscribeToCallFailed',
+    VOICEBOT_SUBSCRIBED_TO_CALL = 'subscribedToCall',
+    VOICEBOT_INITIAL_CALL_HISTORY = 'initialCallHistory',
+    VOICEBOT_UNSUBSCRIBED_FROM_CALL = 'unsubscribedFromCall',
+    VOICEBOT_EVENT = 'VoicebotEvent',
 }
 
 /**
@@ -576,6 +608,10 @@ export declare type ExtensionCall = {
      */
     callername: string;
     callstatus: CallStatusEnum;
+    /**
+     * cam id
+     */
+    campaignID?: string;
     customdata: CustomData;
     /**
      * Is internal
@@ -760,6 +796,18 @@ export declare interface ExternalLoginResponse<T> {
  */
 export declare type GenericEventWrapper = EventWrappedSocketDataMap[EventTypeNames]
 
+export declare type InitialVoicebotCallHistory = {
+    history: Array<VoicebotEventDataCall>;
+    /**
+     * Voicebot id
+     */
+    voicebotID: number;
+    /**
+     * Ivr unique id
+     */
+    IvrUniqueID: string;
+};
+
 export declare type KeepAliveResponseEvent = {
     /**
      * Is ok
@@ -888,7 +936,8 @@ export declare type LoginSuccessEventSDK = EventTypeData<EventsEnum.LOGIN_SUCCES
 
 export declare enum LoginType {
     USER = "User",
-    TOKEN = "Token"
+    TOKEN = "Token",
+    JWT = "Jwt"
 }
 
 export declare type OnlineStatusEvent = {
@@ -1092,7 +1141,9 @@ export declare type ServerEmitEventCallbackRegistry = {
  */
 export declare interface ServerEmitEventDataMap {
     [ServerListenerEventsEnum.UPDATE_MONITORED_EXTENSIONS]: UpdateMonitoredExtensionsPayload
-    [ServerListenerEventsEnum.KEEP_ALIVE]: string
+    [ServerListenerEventsEnum.KEEP_ALIVE]: string,
+    [ServerListenerEventsEnum.SUBSCRIBE_VOICEBOT_CALL_UPDATES]: SubscriptionVoicebotCallUpdatesPayload,
+    [ServerListenerEventsEnum.UNSUBSCRIBE_VOICEBOT_CALL_UPDATES]: SubscriptionVoicebotCallUpdatesPayload
 }
 
 /**
@@ -1103,7 +1154,9 @@ export declare type ServerEmitEventTypeNames = keyof ServerEmitEventDataMap
 
 export declare enum ServerListenerEventsEnum {
     UPDATE_MONITORED_EXTENSIONS = "updateMonitoredExtensions",
-    KEEP_ALIVE = "keepalive"
+    KEEP_ALIVE = "keepalive",
+    SUBSCRIBE_VOICEBOT_CALL_UPDATES = "subscribeVoicebotCallUpdates",
+    UNSUBSCRIBE_VOICEBOT_CALL_UPDATES = "unsubscribeVoicebotCallUpdates"
 }
 
 export declare enum ServerParameter {
@@ -1209,6 +1262,12 @@ declare class SocketIoClass {
     private onQueueEvent;
     private onExtensionEvent;
     private onDialerEvent;
+    private onVoicebotEvent;
+    private onAllVoicebotsStatus;
+    private onVoicebotSubscribedToCall;
+    private onVoicebotSubscribeToCallFailed;
+    private onVoicebotInitialCallHistory;
+    private onVoicebotUnsubscribedFromCall;
     private onLoginStatusEvent;
     private onAllExtensionStatus;
     private onAllDialerStatus;
@@ -1241,6 +1300,37 @@ declare class SocketIoClass {
 
 export declare type SocketTyped = Socket_2<EventCallbackRegistry, ServerEmitEventCallbackRegistry>
 
+export declare type SubscribedToVoicebotCall = {
+    /**
+     * subscribe success?
+     */
+    success: boolean;
+    /**
+     * voicebot id
+     */
+    voicebotID: number;
+    /**
+     * ivr id
+     */
+    IvrUniqueID: string;
+};
+
+export declare type SubscribeToVoicebotCallFailed = {
+    /**
+     * error
+     */
+    error: string;
+    /**
+     * success
+     */
+    success: boolean;
+};
+
+export declare interface SubscriptionVoicebotCallUpdatesPayload {
+    voicebotID: number,
+    IvrUniqueID: string
+}
+
 export declare type Summery = {
     /**
      * Representative
@@ -1254,6 +1344,9 @@ export declare type TestEventListener = (event: { test: string }) => void
 
 declare type TypedSocketIo = (...args: Parameters<typeof io>) => SocketTyped;
 
+export declare type UnsubscribedFromVoicebotCall = {
+};
+
 export declare interface UpdateMonitoredExtensionsPayload {
     extensionsString: string
 }
@@ -1277,6 +1370,146 @@ export declare type User = {
 
 export declare type UserSDK = User
 
+export declare type Voicebot = {
+    Calls: Array<VoicebotEventDataCall>;
+    /**
+     * Acc id
+     */
+    AccountID: string;
+    /**
+     * Voicebot id
+     */
+    VoicebotID: number;
+    /**
+     * Voicebot name
+     */
+    VoicebotName: string;
+};
+
+export declare type VoicebotCall = {
+};
+
+export declare type VoicebotCallHistory = {
+};
+
+export declare type VoicebotEvent = {
+    data: VoicebotEventData;
+    type: VoicebotEventTypeEnum;
+    reason: VoicebotEventReasonEnum;
+    /**
+     * Event name (voicebot)
+     */
+    eventName: string;
+    /**
+     * servertime
+     */
+    servertime: number;
+    /**
+     * servertimeoffset
+     */
+    servertimeoffset: number;
+    /**
+     * telephonyservertime
+     */
+    telephonyservertime: number;
+};
+
+export declare type VoicebotEventData = {
+    Call: VoicebotEventDataCall;
+    /**
+     * account id
+     */
+    AccountID: number;
+    /**
+     * voicebot id
+     */
+    VoicebotID: number;
+    /**
+     * ivr id
+     */
+    IvrUniqueID: string;
+    /**
+     * voicebot name
+     */
+    VoicebotName: string;
+};
+
+export declare type VoicebotEventDataCall = {
+    /**
+     * did
+     */
+    did: string;
+    /**
+     * ivrid
+     */
+    ivrid: string;
+    /**
+     * CallerID
+     */
+    CallerID: string;
+    /**
+     * callType
+     */
+    callType: string;
+    /**
+     * aiSummary
+     */
+    aiSummary: string;
+    direction: VoicebotEventDataCallDirectionEnum;
+    callStatus: VoicebotEventDataCallStatusEnum;
+    /**
+     * callername
+     */
+    callername?: string;
+    customData: any;
+    eventsData: Array<VoicebotEventDataCallEventsData>;
+    /**
+     * IvrUniqueID
+     */
+    IvrUniqueID: string;
+    /**
+     * callStarted
+     */
+    callStarted: number;
+};
+
+export declare enum VoicebotEventDataCallDirectionEnum {
+    INCOMING = 'INCOMING',
+    OUTGOING = 'OUTGOING',
+}
+
+export declare type VoicebotEventDataCallEventsData = {
+    Role: VoicebotEventDataCallEventsDataRoleEnum;
+    Type: VoicebotEventDataCallEventsDataTypeEnum;
+    ToolName?: string;
+    Timestamp: number;
+    Transcript?: string;
+};
+
+export declare type VoicebotEventDataCallEventsDataRoleEnum = {
+};
+
+export declare enum VoicebotEventDataCallEventsDataTypeEnum {
+    CALLSTARTED = 'CallStarted',
+    TRANSCRIPT = 'Transcript',
+    TOOL_EXECUTED = 'ToolExecuted',
+    TOOL_RESPONSE = 'ToolResponse',
+    CALL_ENDED = 'CallEnded',
+}
+
+export declare enum VoicebotEventDataCallStatusEnum {
+    TALKING = 'Talking',
+    ENDED = 'Ended',
+}
+
+export declare enum VoicebotEventReasonEnum {
+    CALLSTARTED = 'CALLSTARTED',
+}
+
+export declare enum VoicebotEventTypeEnum {
+    UNKNOWN = 'UNKNOWN',
+}
+
 /**
  * The structure of received socket events.
  */