@voicenter-team/events-sdk 0.0.45 → 0.0.47
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
|
@@ -7,9 +7,7 @@ export declare type ActiveRoomListener = (event: number | undefined) => void
|
|
|
7
7
|
|
|
8
8
|
export declare type addRoomListener = (value: string) => void
|
|
9
9
|
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
declare type AllDialersStatusEvent_2 = {
|
|
10
|
+
declare type AllDialersStatusEvent = {
|
|
13
11
|
dialers: Array<Dialer>;
|
|
14
12
|
/**
|
|
15
13
|
* 0 - Connection was establishing successfully.
|
|
@@ -29,9 +27,9 @@ declare type AllDialersStatusEvent_2 = {
|
|
|
29
27
|
serverTimeOffset: number;
|
|
30
28
|
};
|
|
31
29
|
|
|
32
|
-
export declare type
|
|
30
|
+
export declare type AllDialersStatusEventSDK = EventTypeData<EventsEnum.ALL_DIALER_STATUS>
|
|
33
31
|
|
|
34
|
-
declare type
|
|
32
|
+
declare type AllExtensionStatusEvent = {
|
|
35
33
|
/**
|
|
36
34
|
* 0 - Connection was establishing successfully.
|
|
37
35
|
*/
|
|
@@ -51,13 +49,13 @@ declare type AllExtensionStatusEvent_2 = {
|
|
|
51
49
|
servertimeoffset: number;
|
|
52
50
|
};
|
|
53
51
|
|
|
54
|
-
declare interface AllExtensionStatusEventExtended extends Omit<
|
|
55
|
-
extensions: Array<
|
|
52
|
+
declare interface AllExtensionStatusEventExtended extends Omit<AllExtensionStatusEvent, 'extensions'> {
|
|
53
|
+
extensions: Array<ExtensionSDK>
|
|
56
54
|
}
|
|
57
55
|
|
|
58
|
-
export declare type
|
|
56
|
+
export declare type AllExtensionStatusEventSDK = EventTypeData<EventsEnum.ALL_EXTENSION_STATUS>
|
|
59
57
|
|
|
60
|
-
declare type
|
|
58
|
+
declare type AllUsersStatusEvent = {
|
|
61
59
|
users: Array<User>;
|
|
62
60
|
/**
|
|
63
61
|
* 0 - Connection was establishing successfully.
|
|
@@ -77,6 +75,8 @@ declare type AllUsersStatusEvent_2 = {
|
|
|
77
75
|
serverTimeOffset: number;
|
|
78
76
|
};
|
|
79
77
|
|
|
78
|
+
export declare type AllUsersStatusEventSDK = EventTypeData<EventsEnum.ALL_USERS_STATUS>
|
|
79
|
+
|
|
80
80
|
declare class AuthClass {
|
|
81
81
|
private readonly eventsSdkClass;
|
|
82
82
|
constructor(eventsSdkClass: EventsSdkClass);
|
|
@@ -127,7 +127,7 @@ declare interface CurrentCallEnded extends CurrentCallUTCExtended {
|
|
|
127
127
|
duration: number
|
|
128
128
|
}
|
|
129
129
|
|
|
130
|
-
declare interface CurrentCallUTCExtended extends
|
|
130
|
+
declare interface CurrentCallUTCExtended extends ExtensionCall {
|
|
131
131
|
callStarted_UTC: number
|
|
132
132
|
callStarted_UTC_CLIENT: number
|
|
133
133
|
callAnswered_UTC: number
|
|
@@ -154,6 +154,8 @@ declare type CustomData = {
|
|
|
154
154
|
DoNotCallMetransactionId?: string;
|
|
155
155
|
};
|
|
156
156
|
|
|
157
|
+
export declare type CustomDataSDK = CustomData
|
|
158
|
+
|
|
157
159
|
declare type Dialer = {
|
|
158
160
|
/**
|
|
159
161
|
* Code
|
|
@@ -182,9 +184,7 @@ declare type Dialer = {
|
|
|
182
184
|
statistics: string;
|
|
183
185
|
};
|
|
184
186
|
|
|
185
|
-
|
|
186
|
-
|
|
187
|
-
declare type DialerEvent_2 = {
|
|
187
|
+
declare type DialerEvent = {
|
|
188
188
|
data: Dialer;
|
|
189
189
|
/**
|
|
190
190
|
* callerID
|
|
@@ -208,6 +208,10 @@ declare type DialerEvent_2 = {
|
|
|
208
208
|
telephonyServerTime?: number;
|
|
209
209
|
};
|
|
210
210
|
|
|
211
|
+
export declare type DialerEventSDK = EventTypeData<EventsEnum.DIALER_EVENT>
|
|
212
|
+
|
|
213
|
+
export declare type DialerSDK = Dialer
|
|
214
|
+
|
|
211
215
|
declare enum DialerTypeEnum {
|
|
212
216
|
AUTOMATIC = 'Automatic',
|
|
213
217
|
IVR = 'IVR',
|
|
@@ -228,6 +232,8 @@ declare enum DoNotCallMeStatusCodeEnum {
|
|
|
228
232
|
declare type Error_2 = {
|
|
229
233
|
};
|
|
230
234
|
|
|
235
|
+
export declare type ErrorSDK = Error_2
|
|
236
|
+
|
|
231
237
|
/**
|
|
232
238
|
* This type defines a map where each key is an event name, and the value is an array of callback functions associated with that event.
|
|
233
239
|
* This structure is used to manage event listeners for different events
|
|
@@ -252,17 +258,17 @@ export declare type EventData = EventDataMapExtended[EventsEnum]
|
|
|
252
258
|
* The data structures that socket io will send us
|
|
253
259
|
*/
|
|
254
260
|
export declare interface EventDataMap {
|
|
255
|
-
[EventsEnum.ALL_EXTENSION_STATUS]:
|
|
256
|
-
[EventsEnum.ALL_DIALER_STATUS]:
|
|
257
|
-
[EventsEnum.ALL_USERS_STATUS]:
|
|
258
|
-
[EventsEnum.QUEUE_EVENT]:
|
|
259
|
-
[EventsEnum.EXTENSION_EVENT]:
|
|
260
|
-
[EventsEnum.DIALER_EVENT]:
|
|
261
|
-
[EventsEnum.LOGIN_SUCCESS]:
|
|
262
|
-
[EventsEnum.LOGIN_STATUS]:
|
|
263
|
-
[EventsEnum.KEEP_ALIVE_RESPONSE]:
|
|
264
|
-
[EventsEnum.ONLINE_STATUS_EVENT]:
|
|
265
|
-
[EventsEnum.EXTENSIONS_UPDATED]:
|
|
261
|
+
[EventsEnum.ALL_EXTENSION_STATUS]: AllExtensionStatusEvent
|
|
262
|
+
[EventsEnum.ALL_DIALER_STATUS]: AllDialersStatusEvent
|
|
263
|
+
[EventsEnum.ALL_USERS_STATUS]: AllUsersStatusEvent
|
|
264
|
+
[EventsEnum.QUEUE_EVENT]: QueueEvent
|
|
265
|
+
[EventsEnum.EXTENSION_EVENT]: ExtensionEvent
|
|
266
|
+
[EventsEnum.DIALER_EVENT]: DialerEvent
|
|
267
|
+
[EventsEnum.LOGIN_SUCCESS]: LoginSuccessEvent
|
|
268
|
+
[EventsEnum.LOGIN_STATUS]: LoginStatusEvent
|
|
269
|
+
[EventsEnum.KEEP_ALIVE_RESPONSE]: KeepAliveResponseEvent
|
|
270
|
+
[EventsEnum.ONLINE_STATUS_EVENT]: OnlineStatusEvent
|
|
271
|
+
[EventsEnum.EXTENSIONS_UPDATED]: ExtensionsUpdated
|
|
266
272
|
}
|
|
267
273
|
|
|
268
274
|
/**
|
|
@@ -488,8 +494,6 @@ declare type Extension = {
|
|
|
488
494
|
lastAnsweredCallEventEpoch: number;
|
|
489
495
|
};
|
|
490
496
|
|
|
491
|
-
declare type Extension_2 = ExtensionUTCExtended | ExtensionEnded
|
|
492
|
-
|
|
493
497
|
declare type ExtensionCall = {
|
|
494
498
|
/**
|
|
495
499
|
* Ip
|
|
@@ -590,13 +594,13 @@ declare type ExtensionCall = {
|
|
|
590
594
|
calldurationinterval: number;
|
|
591
595
|
};
|
|
592
596
|
|
|
593
|
-
declare
|
|
597
|
+
export declare type ExtensionCallSDK = CurrentCallUTCExtended | CurrentCallEnded
|
|
598
|
+
|
|
599
|
+
declare interface ExtensionEnded extends Extension {
|
|
594
600
|
currentCall?: CurrentCallEnded
|
|
595
601
|
}
|
|
596
602
|
|
|
597
|
-
|
|
598
|
-
|
|
599
|
-
declare type ExtensionEvent_2 = {
|
|
603
|
+
declare type ExtensionEvent = {
|
|
600
604
|
data: Extension;
|
|
601
605
|
cause?: ExtensionHangupCauseEnum;
|
|
602
606
|
reason: ExtensionEventReasonEnum;
|
|
@@ -630,7 +634,7 @@ declare type ExtensionEvent_2 = {
|
|
|
630
634
|
telephonyServerTime?: number;
|
|
631
635
|
};
|
|
632
636
|
|
|
633
|
-
declare interface ExtensionEventEnded extends Omit<
|
|
637
|
+
declare interface ExtensionEventEnded extends Omit<ExtensionEvent, 'reason' | 'data'> {
|
|
634
638
|
reason: ExtensionEventReasonEnum.HANGUP
|
|
635
639
|
data: ExtensionEnded
|
|
636
640
|
}
|
|
@@ -646,7 +650,9 @@ declare enum ExtensionEventReasonEnum {
|
|
|
646
650
|
USER_STATUS_UPDATE = 'userStatusUpdate',
|
|
647
651
|
}
|
|
648
652
|
|
|
649
|
-
declare
|
|
653
|
+
export declare type ExtensionEventSDK = EventTypeData<EventsEnum.EXTENSION_EVENT>
|
|
654
|
+
|
|
655
|
+
declare interface ExtensionEventUTCExtended extends Omit<ExtensionEvent, 'reason' | 'data'> {
|
|
650
656
|
reason: Exclude<ExtensionEventReasonEnum, ExtensionEventReasonEnum.HANGUP>
|
|
651
657
|
data: ExtensionUTCExtended
|
|
652
658
|
}
|
|
@@ -662,11 +668,13 @@ declare enum ExtensionHangupCauseEnum {
|
|
|
662
668
|
ANSWERED_ELSEWHERE = 'Answered elsewhere',
|
|
663
669
|
}
|
|
664
670
|
|
|
665
|
-
export declare type
|
|
671
|
+
export declare type ExtensionSDK = ExtensionUTCExtended | ExtensionEnded
|
|
666
672
|
|
|
667
|
-
declare type
|
|
673
|
+
declare type ExtensionsUpdated = string;
|
|
668
674
|
|
|
669
|
-
declare
|
|
675
|
+
export declare type ExtensionsUpdatedSDK = EventTypeData<EventsEnum.EXTENSIONS_UPDATED>
|
|
676
|
+
|
|
677
|
+
declare interface ExtensionUTCExtended extends Extension {
|
|
670
678
|
currentCall?: CurrentCallUTCExtended
|
|
671
679
|
}
|
|
672
680
|
|
|
@@ -698,9 +706,7 @@ export declare interface ExternalLoginResponse<T> {
|
|
|
698
706
|
*/
|
|
699
707
|
export declare type GenericEventWrapper = EventWrappedSocketDataMap[EventTypeNames]
|
|
700
708
|
|
|
701
|
-
|
|
702
|
-
|
|
703
|
-
declare type KeepAliveResponseEvent_2 = {
|
|
709
|
+
declare type KeepAliveResponseEvent = {
|
|
704
710
|
/**
|
|
705
711
|
* Is ok
|
|
706
712
|
*/
|
|
@@ -723,6 +729,8 @@ declare type KeepAliveResponseEvent_2 = {
|
|
|
723
729
|
serverTimeOffset: number;
|
|
724
730
|
};
|
|
725
731
|
|
|
732
|
+
export declare type KeepAliveResponseEventSDK = EventTypeData<EventsEnum.KEEP_ALIVE_RESPONSE>
|
|
733
|
+
|
|
726
734
|
export declare type ListenerCallbackFnType<T extends ListenersKeyType> = OpenSIPSEventMap[T]
|
|
727
735
|
|
|
728
736
|
export declare type ListenersCallbackFnType = OpenSIPSEventMap[ListenersKeyType]
|
|
@@ -771,9 +779,7 @@ export declare interface LoginSessionPayload {
|
|
|
771
779
|
password: string
|
|
772
780
|
}
|
|
773
781
|
|
|
774
|
-
|
|
775
|
-
|
|
776
|
-
declare type LoginStatusEvent_2 = {
|
|
782
|
+
declare type LoginStatusEvent = {
|
|
777
783
|
queues: Array<Queue>;
|
|
778
784
|
/**
|
|
779
785
|
* 0 - Connection was establishing successfully.
|
|
@@ -793,16 +799,9 @@ declare type LoginStatusEvent_2 = {
|
|
|
793
799
|
serverTimeOffset: number;
|
|
794
800
|
};
|
|
795
801
|
|
|
796
|
-
|
|
797
|
-
* Event types declared for being used in the application.
|
|
798
|
-
* These are just aliases for the EventTypeData type.
|
|
799
|
-
* We need that for the IDE to show the correct type of the event data, based on if the event is extended or not.
|
|
800
|
-
* NOT FOR USAGE IN THE EVENTS SDK CODEBASE, JUST FOR USAGE IN THE APPLICATION CODEBASE.
|
|
801
|
-
*/
|
|
802
|
-
|
|
803
|
-
export declare type LoginSuccessEvent = EventTypeData<EventsEnum.LOGIN_SUCCESS>
|
|
802
|
+
export declare type LoginStatusEventSDK = EventTypeData<EventsEnum.LOGIN_STATUS>
|
|
804
803
|
|
|
805
|
-
declare type
|
|
804
|
+
declare type LoginSuccessEvent = {
|
|
806
805
|
/**
|
|
807
806
|
* 0 - Connection was establishing successfully.
|
|
808
807
|
*/
|
|
@@ -821,14 +820,14 @@ declare type LoginSuccessEvent_2 = {
|
|
|
821
820
|
serverTimeOffset: number;
|
|
822
821
|
};
|
|
823
822
|
|
|
823
|
+
export declare type LoginSuccessEventSDK = EventTypeData<EventsEnum.LOGIN_SUCCESS>
|
|
824
|
+
|
|
824
825
|
declare enum LoginType {
|
|
825
826
|
USER = "User",
|
|
826
827
|
TOKEN = "Token"
|
|
827
828
|
}
|
|
828
829
|
|
|
829
|
-
|
|
830
|
-
|
|
831
|
-
declare type OnlineStatusEvent_2 = {
|
|
830
|
+
declare type OnlineStatusEvent = {
|
|
832
831
|
/**
|
|
833
832
|
* if we do reconnect
|
|
834
833
|
*/
|
|
@@ -843,6 +842,8 @@ declare type OnlineStatusEvent_2 = {
|
|
|
843
842
|
isSocketConnected: boolean;
|
|
844
843
|
};
|
|
845
844
|
|
|
845
|
+
export declare type OnlineStatusEventSDK = EventTypeData<EventsEnum.ONLINE_STATUS_EVENT>
|
|
846
|
+
|
|
846
847
|
export declare interface OpenSIPSEventMap {
|
|
847
848
|
ready: readyListener
|
|
848
849
|
changeActiveCalls: changeActiveCallsListener
|
|
@@ -861,32 +862,6 @@ export declare interface OpenSIPSEventMap {
|
|
|
861
862
|
changeCallStatus: changeCallStatusListener
|
|
862
863
|
}
|
|
863
864
|
|
|
864
|
-
declare type OriginalAllDialersStatusEvent = RealtimeEvents.AllDialersStatusEvent
|
|
865
|
-
|
|
866
|
-
declare type OriginalAllExtensionStatusEvent = RealtimeEvents.AllExtensionStatusEvent
|
|
867
|
-
|
|
868
|
-
declare type OriginalAllUsersStatusEvent = RealtimeEvents.AllUsersStatusEvent
|
|
869
|
-
|
|
870
|
-
declare type OriginalDialerEvent = RealtimeEvents.DialerEvent
|
|
871
|
-
|
|
872
|
-
declare type OriginalExtension = RealtimeEvents.Extension
|
|
873
|
-
|
|
874
|
-
declare type OriginalExtensionCall = RealtimeEvents.ExtensionCall
|
|
875
|
-
|
|
876
|
-
declare type OriginalExtensionEvent = RealtimeEvents.ExtensionEvent
|
|
877
|
-
|
|
878
|
-
declare type OriginalExtensionsUpdated = RealtimeEvents.ExtensionsUpdated
|
|
879
|
-
|
|
880
|
-
declare type OriginalKeepAliveResponseEvent = RealtimeEvents.KeepAliveResponseEvent
|
|
881
|
-
|
|
882
|
-
declare type OriginalLoginStatusEvent = RealtimeEvents.LoginStatusEvent
|
|
883
|
-
|
|
884
|
-
declare type OriginalLoginSuccessEvent = RealtimeEvents.LoginSuccessEvent
|
|
885
|
-
|
|
886
|
-
declare type OriginalOnlineStatusEvent = RealtimeEvents.OnlineStatusEvent
|
|
887
|
-
|
|
888
|
-
declare type OriginalQueueEvent = RealtimeEvents.QueueEvent
|
|
889
|
-
|
|
890
865
|
declare type Queue = {
|
|
891
866
|
Calls: Array<QueueCall>;
|
|
892
867
|
/**
|
|
@@ -946,9 +921,9 @@ declare type QueueCall = {
|
|
|
946
921
|
calldurationinterval: number;
|
|
947
922
|
};
|
|
948
923
|
|
|
949
|
-
export declare type
|
|
924
|
+
export declare type QueueCallSDK = QueueCall
|
|
950
925
|
|
|
951
|
-
declare type
|
|
926
|
+
declare type QueueEvent = {
|
|
952
927
|
data: Queue;
|
|
953
928
|
reason: QueueEventReasonEnum;
|
|
954
929
|
/**
|
|
@@ -972,43 +947,11 @@ declare enum QueueEventReasonEnum {
|
|
|
972
947
|
JOIN = 'JOIN',
|
|
973
948
|
}
|
|
974
949
|
|
|
975
|
-
export declare type
|
|
950
|
+
export declare type QueueEventSDK = EventTypeData<EventsEnum.QUEUE_EVENT>
|
|
976
951
|
|
|
977
|
-
declare
|
|
978
|
-
|
|
979
|
-
|
|
980
|
-
AllExtensionStatusEvent_2 as AllExtensionStatusEvent,
|
|
981
|
-
AllUsersStatusEvent_2 as AllUsersStatusEvent,
|
|
982
|
-
CallStatusEnum,
|
|
983
|
-
CallTypeEnum,
|
|
984
|
-
CustomData,
|
|
985
|
-
Dialer,
|
|
986
|
-
DialerEvent_2 as DialerEvent,
|
|
987
|
-
DialerTypeEnum,
|
|
988
|
-
DirectionEnum,
|
|
989
|
-
DoNotCallMeStatusCodeEnum,
|
|
990
|
-
Error_2 as Error,
|
|
991
|
-
EventsEnum,
|
|
992
|
-
Extension,
|
|
993
|
-
ExtensionCall,
|
|
994
|
-
ExtensionEvent_2 as ExtensionEvent,
|
|
995
|
-
ExtensionEventReasonEnum,
|
|
996
|
-
ExtensionHangupCauseEnum,
|
|
997
|
-
ExtensionsUpdated_2 as ExtensionsUpdated,
|
|
998
|
-
KeepAliveResponseEvent_2 as KeepAliveResponseEvent,
|
|
999
|
-
LoginStatusEvent_2 as LoginStatusEvent,
|
|
1000
|
-
LoginSuccessEvent_2 as LoginSuccessEvent,
|
|
1001
|
-
OnlineStatusEvent_2 as OnlineStatusEvent,
|
|
1002
|
-
Queue,
|
|
1003
|
-
QueueCall,
|
|
1004
|
-
QueueEvent_2 as QueueEvent,
|
|
1005
|
-
QueueEventReasonEnum,
|
|
1006
|
-
Recording,
|
|
1007
|
-
Response_2 as Response,
|
|
1008
|
-
Summery,
|
|
1009
|
-
User
|
|
1010
|
-
}
|
|
1011
|
-
}
|
|
952
|
+
export declare type QueueSDK = Queue
|
|
953
|
+
|
|
954
|
+
export declare type readyListener = (value: boolean) => void
|
|
1012
955
|
|
|
1013
956
|
export declare interface ReconnectOptions {
|
|
1014
957
|
retryCount: number;
|
|
@@ -1037,11 +980,15 @@ declare type Recording = {
|
|
|
1037
980
|
ApproximateURL: string;
|
|
1038
981
|
};
|
|
1039
982
|
|
|
983
|
+
export declare type RecordingSDK = Recording
|
|
984
|
+
|
|
1040
985
|
export declare type removeRoomListener = (value: string) => void
|
|
1041
986
|
|
|
1042
987
|
declare type Response_2 = {
|
|
1043
988
|
};
|
|
1044
989
|
|
|
990
|
+
export declare type ResponseSDK = Response_2
|
|
991
|
+
|
|
1045
992
|
export declare type RoomDeletedListener = (roomId: number) => void
|
|
1046
993
|
|
|
1047
994
|
export declare interface Server {
|
|
@@ -1145,6 +1092,8 @@ declare type Summery = {
|
|
|
1145
1092
|
representative: string;
|
|
1146
1093
|
};
|
|
1147
1094
|
|
|
1095
|
+
export declare type SummerySDK = Summery
|
|
1096
|
+
|
|
1148
1097
|
export declare type TestEventListener = (event: { test: string }) => void
|
|
1149
1098
|
|
|
1150
1099
|
declare type TypedSocketIo = (...args: Parameters<typeof io>) => SocketTyped;
|
|
@@ -1170,6 +1119,8 @@ declare type User = {
|
|
|
1170
1119
|
accountID: number;
|
|
1171
1120
|
};
|
|
1172
1121
|
|
|
1122
|
+
export declare type UserSDK = User
|
|
1123
|
+
|
|
1173
1124
|
/**
|
|
1174
1125
|
* The structure of received socket events.
|
|
1175
1126
|
*/
|