@voicenter-team/events-sdk 0.0.1 → 0.0.3

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

@@ -87,6 +87,20 @@ declare interface Dialer {
     statistics: unknown
 }
 
+/**
+ * Data structure for dialer event.
+ */
+declare interface DialerEvent extends CommonEventProperties {
+    data: Dialer
+    eventName: EventNameEnum.DIALER
+    //reason: ExtensionEventReasonEnum // TODO: do research for dialer 'reason' prop
+    telephonyServerTime?: number
+    callerID?: string
+    ivrUniqueId?: string
+    dialStatus?: string
+    //cause?: ExtensionHangupCauseEnum // TODO: do research for dialer 'cause' prop
+}
+
 declare enum DialerType {
     AUTOMATIC = "Automatic",
     IVR = "IVR"
@@ -104,6 +118,11 @@ declare enum DoNotCallMeStatusCodeEnum {
     RESPONSE_FROM_API_INVALID = "RESPONSE_FROM_API_INVALID"
 }
 
+export declare enum Environment {
+    BROWSER = "browser",
+    CHROME_EXTENSION = "chrome-extension"
+}
+
 /**
  * Defines a registry of callback functions for each event type.
  * Each key is an event type name, and the value is a function that takes the specific event data type as an argument.
@@ -117,15 +136,16 @@ declare type EventCallbackRegistry = {
  * Mapping of event names to their respective data structures.
  */
 declare interface EventDataMap {
-    [EventsEnum.ALL_EXTENSION_STATUS]: AllExtensionStatusEvent
-    [EventsEnum.ALL_DIALER_STATUS]: AllDialersStatusEvent
-    [EventsEnum.ALL_USERS_STATUS]: AllUsersStatusEvent
-    [EventsEnum.QUEUE_EVENT]: QueueEvent
-    [EventsEnum.EXTENSION_EVENT]: ExtensionEvent
-    [EventsEnum.LOGIN_SUCCESS]: LoginSuccessEvent
-    [EventsEnum.LOGIN_STATUS]: LoginStatusEvent
-    [EventsEnum.KEEP_ALIVE_RESPONSE]: KeepAliveResponseEvent
-    [EventsEnum.ONLINE_STATUS_EVENT]: OnlineStatusEvent
+    [EventsEnum_2.ALL_EXTENSION_STATUS]: AllExtensionStatusEvent
+    [EventsEnum_2.ALL_DIALER_STATUS]: AllDialersStatusEvent
+    [EventsEnum_2.ALL_USERS_STATUS]: AllUsersStatusEvent
+    [EventsEnum_2.QUEUE_EVENT]: QueueEvent
+    [EventsEnum_2.EXTENSION_EVENT]: ExtensionEvent
+    [EventsEnum_2.DIALER_EVENT]: DialerEvent
+    [EventsEnum_2.LOGIN_SUCCESS]: LoginSuccessEvent
+    [EventsEnum_2.LOGIN_STATUS]: LoginStatusEvent
+    [EventsEnum_2.KEEP_ALIVE_RESPONSE]: KeepAliveResponseEvent
+    [EventsEnum_2.ONLINE_STATUS_EVENT]: OnlineStatusEvent
 }
 
 /**
@@ -134,12 +154,32 @@ declare interface EventDataMap {
 declare enum EventNameEnum {
     EXTENSION = 'extension',
     QUEUE = 'queue',
+    DIALER = 'dialer',
+}
+
+/**
+ * All events that can be received from the server.
+ */
+export declare enum EventsEnum {
+    ALL_DIALER_STATUS = "AllDialersStatus",
+    ALL_EXTENSION_STATUS = "AllExtensionsStatus",
+    ALL_USERS_STATUS = "AllUsersStatus",
+    CONNECT = "connect",
+    DISCONNECT = "disconnect",
+    EXTENSION_EVENT = "ExtensionEvent",
+    KEEP_ALIVE = "keepalive",
+    KEEP_ALIVE_RESPONSE = "keepaliveResponse",
+    LOGIN_STATUS = "loginStatus",
+    LOGIN_SUCCESS = "loginSuccess",
+    QUEUE_EVENT = "QueueEvent",
+    ONLINE_STATUS_EVENT = "onlineStatusEvent",
+    DIALER_EVENT = "DialerEvent"
 }
 
 /**
  * All events that can be received from the server.
  */
-declare enum EventsEnum {
+declare enum EventsEnum_2 {
     ALL_DIALER_STATUS = 'AllDialersStatus',
     ALL_EXTENSION_STATUS = 'AllExtensionsStatus',
     ALL_USERS_STATUS = 'AllUsersStatus',
@@ -157,25 +197,8 @@ declare enum EventsEnum {
     // In case of wrong username or password or token, you will receive a 401 (“Unauthorized”) or 500 (“Unexpected token”) http error.
     LOGIN_SUCCESS = 'loginSuccess',
     QUEUE_EVENT = 'QueueEvent',
-    ONLINE_STATUS_EVENT = 'onlineStatusEvent'
-}
-
-/**
- * All events that can be received from the server.
- */
-declare enum EventsEnum_2 {
-    ALL_DIALER_STATUS = "AllDialersStatus",
-    ALL_EXTENSION_STATUS = "AllExtensionsStatus",
-    ALL_USERS_STATUS = "AllUsersStatus",
-    CONNECT = "connect",
-    DISCONNECT = "disconnect",
-    EXTENSION_EVENT = "ExtensionEvent",
-    KEEP_ALIVE = "keepalive",
-    KEEP_ALIVE_RESPONSE = "keepaliveResponse",
-    LOGIN_STATUS = "loginStatus",
-    LOGIN_SUCCESS = "loginSuccess",
-    QUEUE_EVENT = "QueueEvent",
-    ONLINE_STATUS_EVENT = "onlineStatusEvent"
+    ONLINE_STATUS_EVENT = 'onlineStatusEvent',
+    DIALER_EVENT = 'DialerEvent',
 }
 
 /**
@@ -250,7 +273,7 @@ declare interface EventsSdkOptions {
     username: string;
 }
 
-declare type EventTypeData<T extends EventsEnum> = EventDataMap[T]
+declare type EventTypeData<T extends EventsEnum_2> = EventDataMap[T]
 
 /**
  * Represents the set of all possible event type names as keys from the EventDataMap.
@@ -487,7 +510,7 @@ declare class SocketIoClass {
     private onDisconnect;
 }
 
-declare type SocketTyped = Socket<EventCallbackRegistry, Record<EventsEnum_2, any>>
+declare type SocketTyped = Socket<EventCallbackRegistry, Record<EventsEnum, any>>
 
 declare interface Summery {
     representative: string
@@ -502,7 +525,7 @@ declare interface User {
 
 }
 
-declare type WrappedSocketEvent<T extends EventsEnum> = {
+declare type WrappedSocketEvent<T extends EventsEnum_2> = {
     name: T
     data: EventDataMap[T]
 }