@webex/contact-center 3.12.0 → 3.13.0-next.10

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.
Files changed (297) hide show
  1. package/.repo-context.json +704 -0
  2. package/.sdd/manifest.json +1613 -0
  3. package/AGENTS.md +969 -0
  4. package/dist/cc.js +1102 -47
  5. package/dist/cc.js.map +1 -1
  6. package/dist/config.js +13 -0
  7. package/dist/config.js.map +1 -1
  8. package/dist/constants.js +46 -3
  9. package/dist/constants.js.map +1 -1
  10. package/dist/index.js +86 -17
  11. package/dist/index.js.map +1 -1
  12. package/dist/metrics/MetricsManager.js +16 -0
  13. package/dist/metrics/MetricsManager.js.map +1 -1
  14. package/dist/metrics/behavioral-events.js +211 -0
  15. package/dist/metrics/behavioral-events.js.map +1 -1
  16. package/dist/metrics/constants.js +58 -4
  17. package/dist/metrics/constants.js.map +1 -1
  18. package/dist/services/AddressBook.js +18 -15
  19. package/dist/services/AddressBook.js.map +1 -1
  20. package/dist/services/AnswerCallOnWebexService.js +202 -0
  21. package/dist/services/AnswerCallOnWebexService.js.map +1 -0
  22. package/dist/services/ApiAiAssistant.js +369 -14
  23. package/dist/services/ApiAiAssistant.js.map +1 -1
  24. package/dist/services/EntryPoint.js +46 -68
  25. package/dist/services/EntryPoint.js.map +1 -1
  26. package/dist/services/Queue.js +27 -22
  27. package/dist/services/Queue.js.map +1 -1
  28. package/dist/services/UserPreference.js +427 -0
  29. package/dist/services/UserPreference.js.map +1 -0
  30. package/dist/services/WebCallingService.js +287 -37
  31. package/dist/services/WebCallingService.js.map +1 -1
  32. package/dist/services/WebexCrossClientService.js +225 -0
  33. package/dist/services/WebexCrossClientService.js.map +1 -0
  34. package/dist/services/WxAppTelephonyMercurySync.js +111 -0
  35. package/dist/services/WxAppTelephonyMercurySync.js.map +1 -0
  36. package/dist/services/config/Util.js +48 -48
  37. package/dist/services/config/Util.js.map +1 -1
  38. package/dist/services/config/constants.js +57 -79
  39. package/dist/services/config/constants.js.map +1 -1
  40. package/dist/services/config/index.js +100 -226
  41. package/dist/services/config/index.js.map +1 -1
  42. package/dist/services/config/types.js +100 -40
  43. package/dist/services/config/types.js.map +1 -1
  44. package/dist/services/constants.js +19 -1
  45. package/dist/services/constants.js.map +1 -1
  46. package/dist/services/core/Err.js.map +1 -1
  47. package/dist/services/core/Utils.js +131 -32
  48. package/dist/services/core/Utils.js.map +1 -1
  49. package/dist/services/core/WebexRequest.js +6 -2
  50. package/dist/services/core/WebexRequest.js.map +1 -1
  51. package/dist/services/core/aqm-reqs.js +17 -11
  52. package/dist/services/core/aqm-reqs.js.map +1 -1
  53. package/dist/services/core/constants.js +9 -1
  54. package/dist/services/core/constants.js.map +1 -1
  55. package/dist/services/core/types.js.map +1 -1
  56. package/dist/services/core/websocket/WebSocketManager.js +26 -6
  57. package/dist/services/core/websocket/WebSocketManager.js.map +1 -1
  58. package/dist/services/core/websocket/connection-service.js +3 -1
  59. package/dist/services/core/websocket/connection-service.js.map +1 -1
  60. package/dist/services/core/websocket/types.js.map +1 -1
  61. package/dist/services/index.js +6 -0
  62. package/dist/services/index.js.map +1 -1
  63. package/dist/services/task/Task.js +955 -0
  64. package/dist/services/task/Task.js.map +1 -0
  65. package/dist/services/task/TaskFactory.js +50 -0
  66. package/dist/services/task/TaskFactory.js.map +1 -0
  67. package/dist/services/task/TaskManager.js +1275 -504
  68. package/dist/services/task/TaskManager.js.map +1 -1
  69. package/dist/services/task/TaskUtils.js +221 -27
  70. package/dist/services/task/TaskUtils.js.map +1 -1
  71. package/dist/services/task/WebexCallingUtils.js +70 -0
  72. package/dist/services/task/WebexCallingUtils.js.map +1 -0
  73. package/dist/services/task/constants.js +22 -2
  74. package/dist/services/task/constants.js.map +1 -1
  75. package/dist/services/task/contact.js +29 -0
  76. package/dist/services/task/contact.js.map +1 -1
  77. package/dist/services/task/dialer.js +78 -0
  78. package/dist/services/task/dialer.js.map +1 -1
  79. package/dist/services/task/digital/Digital.js +78 -0
  80. package/dist/services/task/digital/Digital.js.map +1 -0
  81. package/dist/services/task/state-machine/TaskStateMachine.js +982 -0
  82. package/dist/services/task/state-machine/TaskStateMachine.js.map +1 -0
  83. package/dist/services/task/state-machine/actions.js +572 -0
  84. package/dist/services/task/state-machine/actions.js.map +1 -0
  85. package/dist/services/task/state-machine/constants.js +161 -0
  86. package/dist/services/task/state-machine/constants.js.map +1 -0
  87. package/dist/services/task/state-machine/guards.js +379 -0
  88. package/dist/services/task/state-machine/guards.js.map +1 -0
  89. package/dist/services/task/state-machine/index.js +53 -0
  90. package/dist/services/task/state-machine/index.js.map +1 -0
  91. package/dist/services/task/state-machine/types.js +54 -0
  92. package/dist/services/task/state-machine/types.js.map +1 -0
  93. package/dist/services/task/state-machine/uiControlsComputer.js +703 -0
  94. package/dist/services/task/state-machine/uiControlsComputer.js.map +1 -0
  95. package/dist/services/task/taskDataNormalizer.js +99 -0
  96. package/dist/services/task/taskDataNormalizer.js.map +1 -0
  97. package/dist/services/task/types.js +259 -5
  98. package/dist/services/task/types.js.map +1 -1
  99. package/dist/services/task/voice/Voice.js +1504 -0
  100. package/dist/services/task/voice/Voice.js.map +1 -0
  101. package/dist/services/task/voice/WebRTC.js +152 -0
  102. package/dist/services/task/voice/WebRTC.js.map +1 -0
  103. package/dist/services/task/voice/wxAppOfferObservability.js +145 -0
  104. package/dist/services/task/voice/wxAppOfferObservability.js.map +1 -0
  105. package/dist/services/task/voice/wxAppVoiceMethods.js +395 -0
  106. package/dist/services/task/voice/wxAppVoiceMethods.js.map +1 -0
  107. package/dist/services/wxAppDiagnosticLogging.js +159 -0
  108. package/dist/services/wxAppDiagnosticLogging.js.map +1 -0
  109. package/dist/services/wxAppTelephonyUtils.js +19 -0
  110. package/dist/services/wxAppTelephonyUtils.js.map +1 -0
  111. package/dist/types/cc.d.ts +222 -10
  112. package/dist/types/config.d.ts +13 -0
  113. package/dist/types/constants.d.ts +40 -1
  114. package/dist/types/index.d.ts +58 -22
  115. package/dist/types/metrics/MetricsManager.d.ts +6 -0
  116. package/dist/types/metrics/constants.d.ts +52 -1
  117. package/dist/types/services/AddressBook.d.ts +2 -1
  118. package/dist/types/services/AnswerCallOnWebexService.d.ts +38 -0
  119. package/dist/types/services/ApiAiAssistant.d.ts +67 -5
  120. package/dist/types/services/EntryPoint.d.ts +7 -5
  121. package/dist/types/services/Queue.d.ts +5 -3
  122. package/dist/types/services/UserPreference.d.ts +118 -0
  123. package/dist/types/services/WebexCrossClientService.d.ts +32 -0
  124. package/dist/types/services/WxAppTelephonyMercurySync.d.ts +28 -0
  125. package/dist/types/services/config/Util.d.ts +4 -8
  126. package/dist/types/services/config/constants.d.ts +49 -76
  127. package/dist/types/services/config/index.d.ts +16 -64
  128. package/dist/types/services/config/types.d.ts +252 -114
  129. package/dist/types/services/constants.d.ts +16 -0
  130. package/dist/types/services/core/Err.d.ts +6 -0
  131. package/dist/types/services/core/Utils.d.ts +43 -13
  132. package/dist/types/services/core/WebexRequest.d.ts +1 -0
  133. package/dist/types/services/core/constants.d.ts +7 -0
  134. package/dist/types/services/core/types.d.ts +2 -0
  135. package/dist/types/services/core/websocket/WebSocketManager.d.ts +2 -0
  136. package/dist/types/services/core/websocket/types.d.ts +1 -1
  137. package/dist/types/services/index.d.ts +2 -0
  138. package/dist/types/services/task/Task.d.ts +186 -0
  139. package/dist/types/services/task/TaskFactory.d.ts +14 -0
  140. package/dist/types/services/task/TaskUtils.d.ts +54 -2
  141. package/dist/types/services/task/WebexCallingUtils.d.ts +11 -0
  142. package/dist/types/services/task/constants.d.ts +20 -0
  143. package/dist/types/services/task/contact.d.ts +4 -0
  144. package/dist/types/services/task/dialer.d.ts +30 -0
  145. package/dist/types/services/task/digital/Digital.d.ts +23 -0
  146. package/dist/types/services/task/state-machine/TaskStateMachine.d.ts +1442 -0
  147. package/dist/types/services/task/state-machine/actions.d.ts +10 -0
  148. package/dist/types/services/task/state-machine/constants.d.ts +107 -0
  149. package/dist/types/services/task/state-machine/guards.d.ts +103 -0
  150. package/dist/types/services/task/state-machine/index.d.ts +13 -0
  151. package/dist/types/services/task/state-machine/types.d.ts +277 -0
  152. package/dist/types/services/task/state-machine/uiControlsComputer.d.ts +9 -0
  153. package/dist/types/services/task/taskDataNormalizer.d.ts +10 -0
  154. package/dist/types/services/task/types.d.ts +790 -66
  155. package/dist/types/services/task/voice/Voice.d.ts +241 -0
  156. package/dist/types/services/task/voice/WebRTC.d.ts +54 -0
  157. package/dist/types/services/task/voice/wxAppOfferObservability.d.ts +39 -0
  158. package/dist/types/services/task/voice/wxAppVoiceMethods.d.ts +68 -0
  159. package/dist/types/services/wxAppDiagnosticLogging.d.ts +63 -0
  160. package/dist/types/services/wxAppTelephonyUtils.d.ts +5 -0
  161. package/dist/types/types.d.ts +258 -11
  162. package/dist/types/utils/PageCache.d.ts +20 -3
  163. package/dist/types/webex.d.ts +1 -0
  164. package/dist/types.js +204 -6
  165. package/dist/types.js.map +1 -1
  166. package/dist/utils/PageCache.js +19 -5
  167. package/dist/utils/PageCache.js.map +1 -1
  168. package/dist/webex.js +22 -2
  169. package/dist/webex.js.map +1 -1
  170. package/docs/adr/0001-spec-source-policy.md +97 -0
  171. package/docs/adr/0002-consult-transfer-list-policy.md +345 -0
  172. package/docs/adr/0003-repo-standards-migration.md +104 -0
  173. package/docs/adr/index.md +35 -0
  174. package/docs/architecture.md +460 -0
  175. package/docs/getting-started.md +142 -0
  176. package/docs/index.md +53 -0
  177. package/docs/specs/README.md +98 -0
  178. package/package.json +17 -12
  179. package/schemas/repo-context.schema.json +796 -0
  180. package/src/cc.ts +1439 -105
  181. package/src/config.ts +13 -0
  182. package/src/constants.ts +53 -1
  183. package/src/docs/README.md +727 -0
  184. package/src/index.ts +72 -16
  185. package/src/metrics/MetricsManager.ts +16 -0
  186. package/src/metrics/behavioral-events.ts +218 -0
  187. package/src/metrics/constants.ts +63 -4
  188. package/src/metrics/docs/README.md +710 -0
  189. package/src/services/AddressBook.ts +17 -6
  190. package/src/services/AnswerCallOnWebexService.ts +239 -0
  191. package/src/services/ApiAiAssistant.ts +494 -15
  192. package/src/services/EntryPoint.ts +59 -60
  193. package/src/services/Queue.ts +29 -12
  194. package/src/services/UserPreference.ts +509 -0
  195. package/src/services/WebCallingService.ts +362 -40
  196. package/src/services/WebexCrossClientService.ts +298 -0
  197. package/src/services/WxAppTelephonyMercurySync.ts +142 -0
  198. package/src/services/agent/docs/README.md +673 -0
  199. package/src/services/config/Util.ts +54 -84
  200. package/src/services/config/constants.ts +64 -86
  201. package/src/services/config/docs/README.md +530 -0
  202. package/src/services/config/index.ts +116 -277
  203. package/src/services/config/types.ts +238 -125
  204. package/src/services/constants.ts +18 -0
  205. package/src/services/core/Err.ts +3 -0
  206. package/src/services/core/Utils.ts +151 -37
  207. package/src/services/core/WebexRequest.ts +3 -1
  208. package/src/services/core/aqm-reqs.ts +18 -12
  209. package/src/services/core/constants.ts +8 -0
  210. package/src/services/core/docs/README.md +993 -0
  211. package/src/services/core/types.ts +33 -1
  212. package/src/services/core/websocket/WebSocketManager.ts +37 -8
  213. package/src/services/core/websocket/connection-service.ts +5 -1
  214. package/src/services/core/websocket/types.ts +1 -1
  215. package/src/services/docs/README.md +765 -0
  216. package/src/services/index.ts +4 -0
  217. package/src/services/task/Task.ts +1211 -0
  218. package/src/services/task/TaskFactory.ts +82 -0
  219. package/src/services/task/TaskManager.ts +1551 -584
  220. package/src/services/task/TaskUtils.ts +316 -25
  221. package/src/services/task/WebexCallingUtils.ts +136 -0
  222. package/src/services/task/constants.ts +21 -0
  223. package/src/services/task/contact.ts +30 -0
  224. package/src/services/task/dialer.ts +80 -0
  225. package/src/services/task/digital/Digital.ts +102 -0
  226. package/src/services/task/docs/README.md +1569 -0
  227. package/src/services/task/state-machine/TaskStateMachine.ts +1320 -0
  228. package/src/services/task/state-machine/actions.ts +741 -0
  229. package/src/services/task/state-machine/constants.ts +172 -0
  230. package/src/services/task/state-machine/docs/README.md +1388 -0
  231. package/src/services/task/state-machine/guards.ts +442 -0
  232. package/src/services/task/state-machine/index.ts +28 -0
  233. package/src/services/task/state-machine/types.ts +258 -0
  234. package/src/services/task/state-machine/uiControlsComputer.ts +1135 -0
  235. package/src/services/task/taskDataNormalizer.ts +137 -0
  236. package/src/services/task/types.ts +974 -70
  237. package/src/services/task/voice/Voice.ts +1878 -0
  238. package/src/services/task/voice/WebRTC.ts +194 -0
  239. package/src/services/task/voice/wxAppOfferObservability.ts +204 -0
  240. package/src/services/task/voice/wxAppVoiceMethods.ts +575 -0
  241. package/src/services/wxAppDiagnosticLogging.ts +286 -0
  242. package/src/services/wxAppTelephonyUtils.ts +14 -0
  243. package/src/types.ts +323 -13
  244. package/src/utils/AGENTS.md +291 -0
  245. package/src/utils/PageCache.ts +38 -5
  246. package/src/utils/docs/README.md +413 -0
  247. package/src/webex.js +10 -0
  248. package/test/unit/fixtures/aiSummaryTestUtils.ts +40 -0
  249. package/test/unit/spec/cc.ts +4046 -181
  250. package/test/unit/spec/index.ts +891 -0
  251. package/test/unit/spec/logger-proxy.ts +70 -0
  252. package/test/unit/spec/metrics/MetricsManager.ts +25 -0
  253. package/test/unit/spec/metrics/behavioral-events.ts +60 -0
  254. package/test/unit/spec/services/AddressBook.ts +37 -6
  255. package/test/unit/spec/services/AnswerCallOnWebexService.ts +264 -0
  256. package/test/unit/spec/services/ApiAiAssistant.ts +442 -23
  257. package/test/unit/spec/services/EntryPoint.ts +87 -40
  258. package/test/unit/spec/services/Queue.ts +123 -12
  259. package/test/unit/spec/services/UserPreference.ts +401 -0
  260. package/test/unit/spec/services/WebCallingService.ts +484 -49
  261. package/test/unit/spec/services/WebexCrossClientService.ts +509 -0
  262. package/test/unit/spec/services/WxAppTelephonyMercurySync.ts +136 -0
  263. package/test/unit/spec/services/config/Util.ts +501 -0
  264. package/test/unit/spec/services/config/index.ts +318 -548
  265. package/test/unit/spec/services/core/Utils.ts +447 -8
  266. package/test/unit/spec/services/core/WebexRequest.ts +8 -7
  267. package/test/unit/spec/services/core/aqm-reqs.ts +142 -1
  268. package/test/unit/spec/services/core/websocket/WebSocketManager.ts +132 -56
  269. package/test/unit/spec/services/core/websocket/connection-service.ts +3 -1
  270. package/test/unit/spec/services/task/AutoWrapup.ts +63 -0
  271. package/test/unit/spec/services/task/Task.ts +2723 -0
  272. package/test/unit/spec/services/task/TaskFactory.ts +116 -0
  273. package/test/unit/spec/services/task/TaskManager.ts +4800 -1586
  274. package/test/unit/spec/services/task/TaskUtils.ts +307 -0
  275. package/test/unit/spec/services/task/WebexCallingUtils.ts +153 -0
  276. package/test/unit/spec/services/task/contact.ts +33 -0
  277. package/test/unit/spec/services/task/dialer.ts +190 -0
  278. package/test/unit/spec/services/task/digital/Digital.ts +105 -0
  279. package/test/unit/spec/services/task/state-machine/TaskStateMachine.ts +4060 -0
  280. package/test/unit/spec/services/task/state-machine/guards.ts +839 -0
  281. package/test/unit/spec/services/task/state-machine/types.ts +18 -0
  282. package/test/unit/spec/services/task/state-machine/uiControlsComputer.ts +3101 -0
  283. package/test/unit/spec/services/task/taskTestUtils.ts +87 -0
  284. package/test/unit/spec/services/task/voice/Voice.ts +2355 -0
  285. package/test/unit/spec/services/task/voice/WebRTC.ts +235 -0
  286. package/test/unit/spec/services/task/voice/wxAppOfferObservability.ts +361 -0
  287. package/test/unit/spec/services/task/voice/wxAppVoiceMethods.ts +719 -0
  288. package/test/unit/spec/services/wxAppDiagnosticLogging.ts +179 -0
  289. package/test/unit/spec/wellnessSampleUtils.ts +288 -0
  290. package/typedoc.md +1 -1
  291. package/umd/contact-center.min.js +2 -2
  292. package/umd/contact-center.min.js.map +1 -1
  293. package/dist/services/task/index.js +0 -1525
  294. package/dist/services/task/index.js.map +0 -1
  295. package/dist/types/services/task/index.d.ts +0 -650
  296. package/src/services/task/index.ts +0 -1801
  297. package/test/unit/spec/services/task/index.ts +0 -2184
package/src/index.ts CHANGED
@@ -4,7 +4,7 @@ import ContactCenter from './cc';
4
4
 
5
5
  /**
6
6
  * @module ContactCenterModule
7
- * /
7
+ */
8
8
 
9
9
  // Core exports
10
10
  /**
@@ -13,22 +13,26 @@ import ContactCenter from './cc';
13
13
  */
14
14
  export {default as ContactCenter} from './cc';
15
15
 
16
- // Service exports
17
16
  /**
18
- * Task class represents a contact center task that can be managed by an agent
17
+ * Agent routing service for Contact Center operations
19
18
  * @category Services
20
19
  */
21
- export {default as Task} from './services/task';
20
+ export {default as routingAgent} from './services/agent';
22
21
 
23
22
  /**
24
- * Agent routing service for Contact Center operations
23
+ * Task class represents a contact center task that can be managed by an agent
25
24
  * @category Services
26
25
  */
27
- export {default as routingAgent} from './services/agent';
26
+ export {default as Task} from './services/task/Task';
28
27
 
29
28
  // API exports (AddressBook is public, EntryPoint and Queue are accessed via cc wrappers)
30
29
  export {default as AddressBook} from './services/AddressBook';
31
30
  export {default as ApiAIAssistant} from './services/ApiAiAssistant';
31
+ export {AI_SUMMARY_ERROR_CODES} from './constants';
32
+ export {default as UserPreference} from './services/UserPreference';
33
+
34
+ /** Agent Wellness Break notification and action wire values. */
35
+ export {WELLNESS_BREAK_NOTIFICATION_ACTIONS, WELLNESS_BREAK_USER_ACTIONS} from './types';
32
36
 
33
37
  /** EntryPoint API types */
34
38
  export type {
@@ -61,7 +65,7 @@ export {AGENT_EVENTS} from './services/agent/types';
61
65
  export type {AGENT_EVENTS as AgentEvents} from './services/agent/types';
62
66
 
63
67
  /**
64
- * Contact Center Task Events
68
+ * Contact Center task, realtime, and AI Assistant events
65
69
  * @enum {string}
66
70
  * @category Enums
67
71
  */
@@ -79,9 +83,17 @@ export {CC_AGENT_EVENTS} from './services/config/types';
79
83
  * @enum {string}
80
84
  * @category Enums
81
85
  */
82
- export {CC_EVENTS} from './services/config/types';
86
+ export {CC_EVENTS, VOICE_CONNECTION_EVENTS} from './services/config/types';
83
87
  export type {CC_EVENTS as ContactCenterEvents} from './services/config/types';
84
88
 
89
+ /** Browser voice connection state event and status values */
90
+ export {
91
+ VOICE_CONNECTION_ERROR,
92
+ VOICE_CONNECTION_STATUS,
93
+ VoiceLineStatus,
94
+ VoiceMobiusSocketStatus,
95
+ } from './types';
96
+
85
97
  // Interfaces
86
98
  /** Main types and interfaces for Contact Center functionality */
87
99
  export type {
@@ -91,6 +103,7 @@ export type {
91
103
  CCPluginConfig,
92
104
  /** WebexSDK interface */
93
105
  WebexSDK,
106
+ VoiceConnectionState,
94
107
  } from './types';
95
108
 
96
109
  // Types
@@ -120,17 +133,29 @@ export type {
120
133
  GenericError,
121
134
  /** Set state response */
122
135
  SetStateResponse,
136
+ /** Wellness notification action */
137
+ WellnessBreakNotificationAction,
138
+ /** Wellness action API value */
139
+ WellnessBreakUserAction,
140
+ /** Validated agent-scoped wellness notification */
141
+ WellnessBreakEvent,
142
+ /** Wellness offer-response parameters */
143
+ RespondToWellnessBreakParams,
123
144
  } from './types';
124
145
 
125
146
  /** Task related types */
126
147
  export type {
127
148
  AgentContact,
149
+ /** Event emitter contract for task consumers (no @types/node needed) */
150
+ IEventEmitter,
128
151
  /** Task interface */
129
152
  ITask,
130
153
  Interaction,
131
154
  TaskData,
132
155
  /** Task response */
133
156
  TaskResponse,
157
+ /** Conference participant drop request */
158
+ DropConferenceParticipantPayload,
134
159
  ConsultPayload,
135
160
  ConsultEndPayload,
136
161
  ConsultTransferPayLoad,
@@ -139,8 +164,23 @@ export type {
139
164
  TransferPayLoad,
140
165
  ResumeRecordingPayload,
141
166
  WrapupPayLoad,
167
+ /** UI control types for task buttons */
168
+ InteractionUIControls,
169
+ TaskUILeg,
170
+ TaskUIControls,
171
+ TaskUIControlState,
172
+ AISummaryAction,
173
+ AISummaryFeedback,
174
+ AISummaryState,
175
+ AISummarySections,
176
+ AISummary,
177
+ AISummaryFeatureEnablement,
178
+ AISummaryResponse,
142
179
  } from './services/task/types';
143
180
 
181
+ /** UI controls utilities */
182
+ export {getDefaultUIControls} from './services/task/state-machine/uiControlsComputer';
183
+
144
184
  /** Agent related types */
145
185
  export type {
146
186
  /** State change interface */
@@ -175,10 +215,14 @@ export type {
175
215
  export type {
176
216
  /** Profile interface */
177
217
  Profile,
178
- /** Response type from getUserUsingCI method */
218
+ /** Aggregated organization configuration from getOrgDesktopLoginConfig */
219
+ OrgDesktopLoginResponse,
220
+ /** Aggregated user configuration from getUserDesktopLoginConfig */
221
+ UserDesktopLoginResponse,
222
+ /** Agent identity, the `user` section of the user desktop-login aggregate */
179
223
  AgentResponse,
180
- /** Response from getDesktopProfileById */
181
- DesktopProfileResponse,
224
+ /** Desktop Profile settings, the `agentProfile` section of the user desktop-login aggregate */
225
+ AgentProfile,
182
226
  /** Response from getMultimediaProfileById */
183
227
  MultimediaProfileResponse,
184
228
  /** Response from getListOfTeams */
@@ -187,14 +231,18 @@ export type {
187
231
  ListAuxCodesResponse,
188
232
  /** Response from getSiteInfo */
189
233
  SiteInfo,
190
- /** Response from getOrgInfo */
234
+ /** Organization identity, the `organization` section of the org desktop-login aggregate */
191
235
  OrgInfo,
192
- /** Response from getOrganizationSetting */
236
+ /** Organization settings, the `organizationSetting` section of the org desktop-login aggregate */
193
237
  OrgSettings,
194
- /** Response from getTenantData */
238
+ /** Tenant configuration, the `tenantConfiguration` section of the org desktop-login aggregate */
195
239
  TenantData,
196
- /** Response from getURLMapping */
197
- URLMapping,
240
+ /** Microsoft Teams integration configuration, from the org desktop-login aggregate */
241
+ MicrosoftConfig,
242
+ /** Webex integration configuration, from the org desktop-login aggregate */
243
+ WebexConfig,
244
+ /** External integration URLs, the `urlMappings` section of the org desktop-login aggregate */
245
+ OrgUrlMappings,
198
246
  /** Response from getDialPlanData */
199
247
  DialPlanEntity,
200
248
  /** Auxiliary code information */
@@ -213,6 +261,14 @@ export type {
213
261
  DialPlan,
214
262
  /** Auxiliary code type (IDLE_CODE or WRAP_UP_CODE) */
215
263
  AuxCodeType,
264
+ /** User preference data structure */
265
+ UserPreference as UserPreferenceData,
266
+ /** Request payload for creating user preferences */
267
+ CreateUserPreferenceRequest,
268
+ /** Request payload for updating user preferences */
269
+ UpdateUserPreferenceRequest,
270
+ /** Query parameters for fetching user preferences */
271
+ GetUserPreferenceParams,
216
272
  } from './services/config/types';
217
273
 
218
274
  // Constants
@@ -412,6 +412,22 @@ export default class MetricsManager {
412
412
  this.runningEvents[genericKey] = {startTime: Date.now(), keys: new Set(keyArray)};
413
413
  }
414
414
 
415
+ /**
416
+ * Clears a running timed event without emitting a metric.
417
+ * @param keys - A string or array of strings representing event keys (same as timeEvent).
418
+ * @public
419
+ */
420
+ public cancelTimedEvent(keys: string | string[]): void {
421
+ if (this.isMetricsDisabled()) {
422
+ return;
423
+ }
424
+ const keyArray = Array.isArray(keys) ? keys : [keys];
425
+ if (keyArray.length === 0) {
426
+ return;
427
+ }
428
+ delete this.runningEvents[keyArray[0]];
429
+ }
430
+
415
431
  /**
416
432
  * Sets the Webex SDK instance and marks the manager as ready when the SDK is ready.
417
433
  * @param webex - The Webex SDK instance.
@@ -313,6 +313,104 @@ const eventTaxonomyMap: Record<string, BehavioralEventTaxonomy> = {
313
313
  target: 'task_outdial',
314
314
  verb: 'fail',
315
315
  },
316
+ [METRIC_EVENT_NAMES.WXAPP_TASK_MUTE_SUCCESS]: {
317
+ product,
318
+ agent: 'user',
319
+ target: 'task_mute_webex_together',
320
+ verb: 'complete',
321
+ },
322
+ [METRIC_EVENT_NAMES.WXAPP_TASK_MUTE_FAILED]: {
323
+ product,
324
+ agent: 'user',
325
+ target: 'task_mute_webex_together',
326
+ verb: 'fail',
327
+ },
328
+ [METRIC_EVENT_NAMES.WXAPP_TASK_DTMF_SUCCESS]: {
329
+ product,
330
+ agent: 'user',
331
+ target: 'task_dtmf_webex_together',
332
+ verb: 'complete',
333
+ },
334
+ [METRIC_EVENT_NAMES.WXAPP_TASK_DTMF_FAILED]: {
335
+ product,
336
+ agent: 'user',
337
+ target: 'task_dtmf_webex_together',
338
+ verb: 'fail',
339
+ },
340
+
341
+ // Webex Together (wxApp)
342
+ [METRIC_EVENT_NAMES.WXAPP_TASK_ACCEPT_SUCCESS]: {
343
+ product,
344
+ agent: 'user',
345
+ target: 'task_accept_webex_together',
346
+ verb: 'complete',
347
+ },
348
+ [METRIC_EVENT_NAMES.WXAPP_TASK_ACCEPT_FAILED]: {
349
+ product,
350
+ agent: 'user',
351
+ target: 'task_accept_webex_together',
352
+ verb: 'fail',
353
+ },
354
+ [METRIC_EVENT_NAMES.WXAPP_TASK_DECLINE_SUCCESS]: {
355
+ product,
356
+ agent: 'user',
357
+ target: 'task_reject_webex_together',
358
+ verb: 'complete',
359
+ },
360
+ [METRIC_EVENT_NAMES.WXAPP_TASK_DECLINE_FAILED]: {
361
+ product,
362
+ agent: 'user',
363
+ target: 'task_reject_webex_together',
364
+ verb: 'fail',
365
+ },
366
+ [METRIC_EVENT_NAMES.WXAPP_SESSION_INIT_SUCCESS]: {
367
+ product,
368
+ agent: 'user',
369
+ target: 'webex_together_session_init',
370
+ verb: 'complete',
371
+ },
372
+ [METRIC_EVENT_NAMES.WXAPP_SESSION_INIT_FAILED]: {
373
+ product,
374
+ agent: 'user',
375
+ target: 'webex_together_session_init',
376
+ verb: 'fail',
377
+ },
378
+ [METRIC_EVENT_NAMES.WXAPP_SESSION_SKIPPED]: {
379
+ product,
380
+ agent: 'user',
381
+ target: 'webex_together_session_init',
382
+ verb: 'ignore',
383
+ },
384
+ [METRIC_EVENT_NAMES.WXAPP_USERSUB_PUBLISH_SUCCESS]: {
385
+ product,
386
+ agent: 'user',
387
+ target: 'webex_together_usersub_publish',
388
+ verb: 'complete',
389
+ },
390
+ [METRIC_EVENT_NAMES.WXAPP_USERSUB_PUBLISH_FAILED]: {
391
+ product,
392
+ agent: 'user',
393
+ target: 'webex_together_usersub_publish',
394
+ verb: 'fail',
395
+ },
396
+ [METRIC_EVENT_NAMES.WXAPP_MERCURY_SUBSCRIBE_SUCCESS]: {
397
+ product,
398
+ agent: 'user',
399
+ target: 'webex_together_mercury_subscribe',
400
+ verb: 'complete',
401
+ },
402
+ [METRIC_EVENT_NAMES.WXAPP_MERCURY_SUBSCRIBE_FAILED]: {
403
+ product,
404
+ agent: 'user',
405
+ target: 'webex_together_mercury_subscribe',
406
+ verb: 'fail',
407
+ },
408
+ [METRIC_EVENT_NAMES.WXAPP_OFFER_PARTICIPANT_FIELDS_MISSING]: {
409
+ product,
410
+ agent: 'user',
411
+ target: 'webex_together_offer_participant_fields',
412
+ verb: 'fail',
413
+ },
316
414
 
317
415
  // Conference Tasks
318
416
  [METRIC_EVENT_NAMES.TASK_CONFERENCE_START_SUCCESS]: {
@@ -352,6 +450,48 @@ const eventTaxonomyMap: Record<string, BehavioralEventTaxonomy> = {
352
450
  verb: 'fail',
353
451
  },
354
452
 
453
+ // Conference Exit
454
+ [METRIC_EVENT_NAMES.TASK_CONFERENCE_EXIT_SUCCESS]: {
455
+ product,
456
+ agent: 'user',
457
+ target: 'task_conference_exit',
458
+ verb: 'complete',
459
+ },
460
+ [METRIC_EVENT_NAMES.TASK_CONFERENCE_EXIT_FAILED]: {
461
+ product,
462
+ agent: 'user',
463
+ target: 'task_conference_exit',
464
+ verb: 'fail',
465
+ },
466
+
467
+ // Conference Participant Drop
468
+ [METRIC_EVENT_NAMES.TASK_CONFERENCE_PARTICIPANT_DROP_SUCCESS]: {
469
+ product,
470
+ agent: 'user',
471
+ target: 'task_conference_participant_drop',
472
+ verb: 'complete',
473
+ },
474
+ [METRIC_EVENT_NAMES.TASK_CONFERENCE_PARTICIPANT_DROP_FAILED]: {
475
+ product,
476
+ agent: 'user',
477
+ target: 'task_conference_participant_drop',
478
+ verb: 'fail',
479
+ },
480
+
481
+ // Switch Call
482
+ [METRIC_EVENT_NAMES.TASK_SWITCH_CALL_SUCCESS]: {
483
+ product,
484
+ agent: 'user',
485
+ target: 'task_switch_call',
486
+ verb: 'complete',
487
+ },
488
+ [METRIC_EVENT_NAMES.TASK_SWITCH_CALL_FAILED]: {
489
+ product,
490
+ agent: 'user',
491
+ target: 'task_switch_call',
492
+ verb: 'fail',
493
+ },
494
+
355
495
  // upload logs
356
496
  [METRIC_EVENT_NAMES.UPLOAD_LOGS_SUCCESS]: {
357
497
  product,
@@ -449,6 +589,84 @@ const eventTaxonomyMap: Record<string, BehavioralEventTaxonomy> = {
449
589
  target: 'campaign_preview_accept',
450
590
  verb: 'fail',
451
591
  },
592
+
593
+ // Campaign Preview Skip API Events
594
+ [METRIC_EVENT_NAMES.CAMPAIGN_PREVIEW_SKIP_SUCCESS]: {
595
+ product,
596
+ agent: 'user',
597
+ target: 'campaign_preview_skip',
598
+ verb: 'complete',
599
+ },
600
+ [METRIC_EVENT_NAMES.CAMPAIGN_PREVIEW_SKIP_FAILED]: {
601
+ product,
602
+ agent: 'user',
603
+ target: 'campaign_preview_skip',
604
+ verb: 'fail',
605
+ },
606
+
607
+ // Campaign Preview Remove API Events
608
+ [METRIC_EVENT_NAMES.CAMPAIGN_PREVIEW_REMOVE_SUCCESS]: {
609
+ product,
610
+ agent: 'user',
611
+ target: 'campaign_preview_remove',
612
+ verb: 'complete',
613
+ },
614
+ [METRIC_EVENT_NAMES.CAMPAIGN_PREVIEW_REMOVE_FAILED]: {
615
+ product,
616
+ agent: 'user',
617
+ target: 'campaign_preview_remove',
618
+ verb: 'fail',
619
+ },
620
+
621
+ // User Preference API Events
622
+ [METRIC_EVENT_NAMES.USER_PREFERENCE_GET_SUCCESS]: {
623
+ product,
624
+ agent: 'user',
625
+ target: 'user_preference_get',
626
+ verb: 'complete',
627
+ },
628
+ [METRIC_EVENT_NAMES.USER_PREFERENCE_GET_FAILED]: {
629
+ product,
630
+ agent: 'user',
631
+ target: 'user_preference_get',
632
+ verb: 'fail',
633
+ },
634
+ [METRIC_EVENT_NAMES.USER_PREFERENCE_CREATE_SUCCESS]: {
635
+ product,
636
+ agent: 'user',
637
+ target: 'user_preference_create',
638
+ verb: 'complete',
639
+ },
640
+ [METRIC_EVENT_NAMES.USER_PREFERENCE_CREATE_FAILED]: {
641
+ product,
642
+ agent: 'user',
643
+ target: 'user_preference_create',
644
+ verb: 'fail',
645
+ },
646
+ [METRIC_EVENT_NAMES.USER_PREFERENCE_UPDATE_SUCCESS]: {
647
+ product,
648
+ agent: 'user',
649
+ target: 'user_preference_update',
650
+ verb: 'complete',
651
+ },
652
+ [METRIC_EVENT_NAMES.USER_PREFERENCE_UPDATE_FAILED]: {
653
+ product,
654
+ agent: 'user',
655
+ target: 'user_preference_update',
656
+ verb: 'fail',
657
+ },
658
+ [METRIC_EVENT_NAMES.USER_PREFERENCE_DELETE_SUCCESS]: {
659
+ product,
660
+ agent: 'user',
661
+ target: 'user_preference_delete',
662
+ verb: 'complete',
663
+ },
664
+ [METRIC_EVENT_NAMES.USER_PREFERENCE_DELETE_FAILED]: {
665
+ product,
666
+ agent: 'user',
667
+ target: 'user_preference_delete',
668
+ verb: 'fail',
669
+ },
452
670
  };
453
671
 
454
672
  /**
@@ -129,20 +129,44 @@ export const METRIC_EVENT_NAMES = {
129
129
  TASK_CONFERENCE_END_FAILED: 'Task Conference End Failed',
130
130
  TASK_CONFERENCE_TRANSFER_SUCCESS: 'Task Conference Transfer Success',
131
131
  TASK_CONFERENCE_TRANSFER_FAILED: 'Task Conference Transfer Failed',
132
+ TASK_CONFERENCE_EXIT_SUCCESS: 'Task Conference Exit Success',
133
+ TASK_CONFERENCE_EXIT_FAILED: 'Task Conference Exit Failed',
134
+ TASK_CONFERENCE_PARTICIPANT_DROP_SUCCESS: 'Task Conference Participant Drop Success',
135
+ TASK_CONFERENCE_PARTICIPANT_DROP_FAILED: 'Task Conference Participant Drop Failed',
136
+ TASK_SWITCH_CALL_SUCCESS: 'Task Switch Call Success',
137
+ TASK_SWITCH_CALL_FAILED: 'Task Switch Call Failed',
132
138
 
133
139
  TASK_OUTDIAL_SUCCESS: 'Task Outdial Success',
134
140
  TASK_OUTDIAL_FAILED: 'Task Outdial Failed',
135
141
 
142
+ WXAPP_TASK_MUTE_SUCCESS: 'WxApp Task Mute Success',
143
+ WXAPP_TASK_MUTE_FAILED: 'WxApp Task Mute Failed',
144
+ WXAPP_TASK_DTMF_SUCCESS: 'WxApp Task Dtmf Success',
145
+ WXAPP_TASK_DTMF_FAILED: 'WxApp Task Dtmf Failed',
146
+
147
+ // WxApp Better Together
148
+ WXAPP_TASK_ACCEPT_SUCCESS: 'WxApp Task Accept Success',
149
+ WXAPP_TASK_ACCEPT_FAILED: 'WxApp Task Accept Failed',
150
+ WXAPP_TASK_DECLINE_SUCCESS: 'WxApp Task Decline Success',
151
+ WXAPP_TASK_DECLINE_FAILED: 'WxApp Task Decline Failed',
152
+ WXAPP_SESSION_INIT_SUCCESS: 'WxApp Session Init Success',
153
+ WXAPP_SESSION_INIT_FAILED: 'WxApp Session Init Failed',
154
+ WXAPP_SESSION_SKIPPED: 'WxApp Session Skipped',
155
+ WXAPP_USERSUB_PUBLISH_SUCCESS: 'WxApp Usersub Publish Success',
156
+ WXAPP_USERSUB_PUBLISH_FAILED: 'WxApp Usersub Publish Failed',
157
+ WXAPP_MERCURY_SUBSCRIBE_SUCCESS: 'WxApp Mercury Subscribe Success',
158
+ WXAPP_MERCURY_SUBSCRIBE_FAILED: 'WxApp Mercury Subscribe Failed',
159
+ WXAPP_OFFER_PARTICIPANT_FIELDS_MISSING: 'WxApp Offer Participant Fields Missing',
160
+
136
161
  UPLOAD_LOGS_SUCCESS: 'Upload Logs Success',
137
162
  UPLOAD_LOGS_FAILED: 'Upload Logs Failed',
138
163
  WEBSOCKET_DEREGISTER_SUCCESS: 'Websocket Deregister Success',
139
164
  WEBSOCKET_DEREGISTER_FAIL: 'Websocket Deregister Failed',
140
165
 
141
- // WebSocket message events
142
- WEBSOCKET_EVENT_RECEIVED: 'Websocket Event Received',
143
-
144
166
  AGENT_DEVICE_TYPE_UPDATE_SUCCESS: 'Agent Device Type Update Success',
145
167
  AGENT_DEVICE_TYPE_UPDATE_FAILED: 'Agent Device Type Update Failed',
168
+ // WebSocket message events
169
+ WEBSOCKET_EVENT_RECEIVED: 'Websocket Event Received',
146
170
 
147
171
  // EntryPoint API Events
148
172
  ENTRYPOINT_FETCH_SUCCESS: 'Entrypoint Fetch Success',
@@ -163,13 +187,48 @@ export const METRIC_EVENT_NAMES = {
163
187
  // Campaign Preview API Events
164
188
  CAMPAIGN_PREVIEW_ACCEPT_SUCCESS: 'Campaign Preview Accept Success',
165
189
  CAMPAIGN_PREVIEW_ACCEPT_FAILED: 'Campaign Preview Accept Failed',
190
+ CAMPAIGN_PREVIEW_SKIP_SUCCESS: 'Campaign Preview Skip Success',
191
+ CAMPAIGN_PREVIEW_SKIP_FAILED: 'Campaign Preview Skip Failed',
192
+ CAMPAIGN_PREVIEW_REMOVE_SUCCESS: 'Campaign Preview Remove Success',
193
+ CAMPAIGN_PREVIEW_REMOVE_FAILED: 'Campaign Preview Remove Failed',
166
194
 
167
- // AI Assistant transcript events
195
+ // AI Assistant Transcript events
168
196
  AI_ASSISTANT_SEND_EVENT_SUCCESS: 'AI Assistant Send Event Success',
169
197
  AI_ASSISTANT_SEND_EVENT_FAILED: 'AI Assistant Send Event Failed',
198
+ AI_ASSISTANT_GET_REAL_TIME_ASSISTANCE_SUCCESS: 'AI Assistant Get Real Time Assistance Success',
199
+ AI_ASSISTANT_GET_REAL_TIME_ASSISTANCE_FAILED: 'AI Assistant Get Real Time Assistance Failed',
200
+ AI_ASSISTANT_SEND_REAL_TIME_ASSISTANCE_USER_ACTION_SUCCESS:
201
+ 'AI Assistant Send Real Time Assistance User Action Success',
202
+ AI_ASSISTANT_SEND_REAL_TIME_ASSISTANCE_USER_ACTION_FAILED:
203
+ 'AI Assistant Send Real Time Assistance User Action Failed',
170
204
  AI_ASSISTANT_FETCH_HISTORIC_TRANSCRIPTS_SUCCESS:
171
205
  'AI Assistant Fetch Historic Transcripts Success',
172
206
  AI_ASSISTANT_FETCH_HISTORIC_TRANSCRIPTS_FAILED: 'AI Assistant Fetch Historic Transcripts Failed',
207
+ AI_ASSISTANT_WELLNESS_ACTION_ACCEPTED: 'AI Assistant Wellness Action Accepted',
208
+ AI_ASSISTANT_WELLNESS_ACTION_FAILED: 'AI Assistant Wellness Action Failed',
209
+ AI_ASSISTANT_WELLNESS_EVENT_INVALID: 'AI Assistant Wellness Event Invalid',
210
+ WELLBEING_BREAK_IDLE_CODE_FETCH_SUCCESS: 'Wellbeing Break Idle Code Fetch Success',
211
+ WELLBEING_BREAK_IDLE_CODE_FETCH_FAILED: 'Wellbeing Break Idle Code Fetch Failed',
212
+
213
+ // AI summary events
214
+ AI_SUMMARY_GET_POST_CALL_SUCCESS: 'Post Call Summary Get Success',
215
+ AI_SUMMARY_GET_POST_CALL_FAILED: 'Post Call Summary Get Failed',
216
+ AI_SUMMARY_GET_MID_CALL_SUCCESS: 'Mid Call Summary Get Success',
217
+ AI_SUMMARY_GET_MID_CALL_FAILED: 'Mid Call Summary Get Failed',
218
+ AI_SUMMARY_POST_CALL_RESPONSE_SUCCESS: 'Post Call Summary Response Success',
219
+ AI_SUMMARY_POST_CALL_RESPONSE_FAILED: 'Post Call Summary Response Failed',
220
+ AI_SUMMARY_MID_CALL_RESPONSE_SUCCESS: 'Mid Call Summary Response Success',
221
+ AI_SUMMARY_MID_CALL_RESPONSE_FAILED: 'Mid Call Summary Response Failed',
222
+
223
+ // User Preference API Events
224
+ USER_PREFERENCE_GET_SUCCESS: 'User Preference Get Success',
225
+ USER_PREFERENCE_GET_FAILED: 'User Preference Get Failed',
226
+ USER_PREFERENCE_CREATE_SUCCESS: 'User Preference Create Success',
227
+ USER_PREFERENCE_CREATE_FAILED: 'User Preference Create Failed',
228
+ USER_PREFERENCE_UPDATE_SUCCESS: 'User Preference Update Success',
229
+ USER_PREFERENCE_UPDATE_FAILED: 'User Preference Update Failed',
230
+ USER_PREFERENCE_DELETE_SUCCESS: 'User Preference Delete Success',
231
+ USER_PREFERENCE_DELETE_FAILED: 'User Preference Delete Failed',
173
232
  } as const;
174
233
 
175
234
  /**