@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
@@ -1,6 +1,11 @@
1
1
  import * as Agent from '../agent/types';
2
+ import { COLLABORATION_ACCESS } from './constants';
3
+ /** Desktop Profile access level for a collaboration destination category. */
4
+ export type CollaborationAccess = Enum<typeof COLLABORATION_ACCESS>;
2
5
  /**
3
- * Events emitted on task objects
6
+ * Contact Center backend and realtime event types.
7
+ *
8
+ * Includes task lifecycle, transcript, suggested-response, and AI summary events.
4
9
  * @enum {string}
5
10
  * @private
6
11
  * @ignore
@@ -50,6 +55,8 @@ export declare const CC_TASK_EVENTS: {
50
55
  readonly PARTICIPANT_LEFT_CONFERENCE: "ParticipantLeftConference";
51
56
  /** Event emitted when participant leaving conference fails */
52
57
  readonly PARTICIPANT_LEFT_CONFERENCE_FAILED: "ParticipantLeftConferenceFailed";
58
+ /** Event emitted when dropping another conference participant fails */
59
+ readonly PARTICIPANT_DROP_CONFERENCE_FAILED: "ParticipantDropConferenceFailed";
53
60
  /** Event emitted when consultation conference end fails */
54
61
  readonly AGENT_CONSULT_CONFERENCE_END_FAILED: "AgentConsultConferenceEndFailed";
55
62
  /** Event emitted when conference is successfully transferred */
@@ -58,6 +65,8 @@ export declare const CC_TASK_EVENTS: {
58
65
  readonly AGENT_CONFERENCE_TRANSFER_FAILED: "AgentConferenceTransferFailed";
59
66
  /** Event emitted for post-call activity by participant */
60
67
  readonly PARTICIPANT_POST_CALL_ACTIVITY: "ParticipantPostCallActivity";
68
+ /** Event emitted when consulted participant is being moved/transferred */
69
+ readonly CONSULTED_PARTICIPANT_MOVING: "ConsultedParticipantMoving";
61
70
  /** Event emitted when contact is blind transferred */
62
71
  readonly AGENT_BLIND_TRANSFERRED: "AgentBlindTransferred";
63
72
  /** Event emitted when blind transfer fails */
@@ -74,6 +83,8 @@ export declare const CC_TASK_EVENTS: {
74
83
  readonly AGENT_CONSULT_TRANSFER_FAILED: "AgentConsultTransferFailed";
75
84
  /** Event emitted when contact recording is paused */
76
85
  readonly CONTACT_RECORDING_PAUSED: "ContactRecordingPaused";
86
+ /** Event emitted when contact recording is started */
87
+ readonly CONTACT_RECORDING_STARTED: "ContactRecordingStarted";
77
88
  /** Event emitted when pausing contact recording fails */
78
89
  readonly CONTACT_RECORDING_PAUSE_FAILED: "ContactRecordingPauseFailed";
79
90
  /** Event emitted when contact recording is resumed */
@@ -84,6 +95,10 @@ export declare const CC_TASK_EVENTS: {
84
95
  readonly CONTACT_ENDED: "ContactEnded";
85
96
  /** Event emitted when contact is merged */
86
97
  readonly CONTACT_MERGED: "ContactMerged";
98
+ /** Event emitted when contact payload is updated (routing updates) */
99
+ readonly CONTACT_UPDATED: "ContactUpdated";
100
+ /** Event emitted when contact owner changes */
101
+ readonly CONTACT_OWNER_CHANGED: "ContactOwnerChanged";
87
102
  /** Event emitted when ending contact fails */
88
103
  readonly AGENT_CONTACT_END_FAILED: "AgentContactEndFailed";
89
104
  /** Event emitted when agent enters wrap-up state */
@@ -110,14 +125,29 @@ export declare const CC_TASK_EVENTS: {
110
125
  readonly CAMPAIGN_CONTACT_UPDATED: "CampaignContactUpdated";
111
126
  /** Event emitted when accepting a campaign preview contact fails */
112
127
  readonly CAMPAIGN_PREVIEW_ACCEPT_FAILED: "CampaignPreviewAcceptFailed";
128
+ /** Event emitted when skipping a campaign preview contact fails */
129
+ readonly CAMPAIGN_PREVIEW_SKIP_FAILED: "CampaignPreviewSkipFailed";
130
+ /** Event emitted when removing a campaign preview contact fails */
131
+ readonly CAMPAIGN_PREVIEW_REMOVE_FAILED: "CampaignPreviewRemoveFailed";
113
132
  /** Event emitted when a real-time transcript chunk is received */
114
133
  readonly REAL_TIME_TRANSCRIPTION: "REAL_TIME_TRANSCRIPTION";
134
+ /** Event emitted when an AI assistant suggested response is available */
135
+ readonly SUGGESTED_RESPONSE: "SUGGESTED_RESPONSE";
136
+ /** Event emitted when backend acknowledges it is listening for more context */
137
+ readonly SUGGESTED_RESPONSE_ACKNOWLEDGE: "SUGGESTED_RESPONSE_ACKNOWLEDGE";
138
+ /** Event received when a post-call summary is available through realtime delivery */
139
+ readonly POST_CALL_SUMMARY: "POST_CALL_SUMMARY";
140
+ /** Event received when a mid-call summary is available through realtime delivery */
141
+ readonly MID_CALL_SUMMARY: "MID_CALL_SUMMARY";
142
+ /** Event received when AI-summary feature enablement is available through realtime delivery */
143
+ readonly FEATURE_ENABLEMENT: "FEATURE_ENABLEMENT";
144
+ /** Event received when a subsequent agent receives a mid-call summary */
145
+ readonly MID_CALL_SUMMARY_RESPONSE_SUBSEQUENT_AGENT: "MID_CALL_SUMMARY_RESPONSE_SUBSEQUENT_AGENT";
115
146
  };
116
147
  /**
117
148
  * Events emitted on Contact Center agent operations
118
149
  * @enum {string}
119
- * @private
120
- * @ignore
150
+ * @public
121
151
  */
122
152
  export declare const CC_AGENT_EVENTS: {
123
153
  /** Welcome event when agent connects to websocket/backend */
@@ -156,6 +186,8 @@ export declare const CC_AGENT_EVENTS: {
156
186
  readonly AGENT_BUDDY_AGENTS_RETRIEVE_FAILED: "BuddyAgentsRetrieveFailed";
157
187
  /** Event emitted when contact is reserved for agent */
158
188
  readonly AGENT_CONTACT_RESERVED: "AgentContactReserved";
189
+ /** Agent-level Agent Wellness Break notification */
190
+ readonly WELLNESS_BREAK: "WellnessBreak";
159
191
  };
160
192
  /**
161
193
  * Combined Contact Center events including both agent and task events
@@ -207,6 +239,8 @@ export declare const CC_EVENTS: {
207
239
  readonly PARTICIPANT_LEFT_CONFERENCE: "ParticipantLeftConference";
208
240
  /** Event emitted when participant leaving conference fails */
209
241
  readonly PARTICIPANT_LEFT_CONFERENCE_FAILED: "ParticipantLeftConferenceFailed";
242
+ /** Event emitted when dropping another conference participant fails */
243
+ readonly PARTICIPANT_DROP_CONFERENCE_FAILED: "ParticipantDropConferenceFailed";
210
244
  /** Event emitted when consultation conference end fails */
211
245
  readonly AGENT_CONSULT_CONFERENCE_END_FAILED: "AgentConsultConferenceEndFailed";
212
246
  /** Event emitted when conference is successfully transferred */
@@ -215,6 +249,8 @@ export declare const CC_EVENTS: {
215
249
  readonly AGENT_CONFERENCE_TRANSFER_FAILED: "AgentConferenceTransferFailed";
216
250
  /** Event emitted for post-call activity by participant */
217
251
  readonly PARTICIPANT_POST_CALL_ACTIVITY: "ParticipantPostCallActivity";
252
+ /** Event emitted when consulted participant is being moved/transferred */
253
+ readonly CONSULTED_PARTICIPANT_MOVING: "ConsultedParticipantMoving";
218
254
  /** Event emitted when contact is blind transferred */
219
255
  readonly AGENT_BLIND_TRANSFERRED: "AgentBlindTransferred";
220
256
  /** Event emitted when blind transfer fails */
@@ -231,6 +267,8 @@ export declare const CC_EVENTS: {
231
267
  readonly AGENT_CONSULT_TRANSFER_FAILED: "AgentConsultTransferFailed";
232
268
  /** Event emitted when contact recording is paused */
233
269
  readonly CONTACT_RECORDING_PAUSED: "ContactRecordingPaused";
270
+ /** Event emitted when contact recording is started */
271
+ readonly CONTACT_RECORDING_STARTED: "ContactRecordingStarted";
234
272
  /** Event emitted when pausing contact recording fails */
235
273
  readonly CONTACT_RECORDING_PAUSE_FAILED: "ContactRecordingPauseFailed";
236
274
  /** Event emitted when contact recording is resumed */
@@ -241,6 +279,10 @@ export declare const CC_EVENTS: {
241
279
  readonly CONTACT_ENDED: "ContactEnded";
242
280
  /** Event emitted when contact is merged */
243
281
  readonly CONTACT_MERGED: "ContactMerged";
282
+ /** Event emitted when contact payload is updated (routing updates) */
283
+ readonly CONTACT_UPDATED: "ContactUpdated";
284
+ /** Event emitted when contact owner changes */
285
+ readonly CONTACT_OWNER_CHANGED: "ContactOwnerChanged";
244
286
  /** Event emitted when ending contact fails */
245
287
  readonly AGENT_CONTACT_END_FAILED: "AgentContactEndFailed";
246
288
  /** Event emitted when agent enters wrap-up state */
@@ -267,8 +309,24 @@ export declare const CC_EVENTS: {
267
309
  readonly CAMPAIGN_CONTACT_UPDATED: "CampaignContactUpdated";
268
310
  /** Event emitted when accepting a campaign preview contact fails */
269
311
  readonly CAMPAIGN_PREVIEW_ACCEPT_FAILED: "CampaignPreviewAcceptFailed";
312
+ /** Event emitted when skipping a campaign preview contact fails */
313
+ readonly CAMPAIGN_PREVIEW_SKIP_FAILED: "CampaignPreviewSkipFailed";
314
+ /** Event emitted when removing a campaign preview contact fails */
315
+ readonly CAMPAIGN_PREVIEW_REMOVE_FAILED: "CampaignPreviewRemoveFailed";
270
316
  /** Event emitted when a real-time transcript chunk is received */
271
317
  readonly REAL_TIME_TRANSCRIPTION: "REAL_TIME_TRANSCRIPTION";
318
+ /** Event emitted when an AI assistant suggested response is available */
319
+ readonly SUGGESTED_RESPONSE: "SUGGESTED_RESPONSE";
320
+ /** Event emitted when backend acknowledges it is listening for more context */
321
+ readonly SUGGESTED_RESPONSE_ACKNOWLEDGE: "SUGGESTED_RESPONSE_ACKNOWLEDGE";
322
+ /** Event received when a post-call summary is available through realtime delivery */
323
+ readonly POST_CALL_SUMMARY: "POST_CALL_SUMMARY";
324
+ /** Event received when a mid-call summary is available through realtime delivery */
325
+ readonly MID_CALL_SUMMARY: "MID_CALL_SUMMARY";
326
+ /** Event received when AI-summary feature enablement is available through realtime delivery */
327
+ readonly FEATURE_ENABLEMENT: "FEATURE_ENABLEMENT";
328
+ /** Event received when a subsequent agent receives a mid-call summary */
329
+ readonly MID_CALL_SUMMARY_RESPONSE_SUBSEQUENT_AGENT: "MID_CALL_SUMMARY_RESPONSE_SUBSEQUENT_AGENT";
272
330
  /** Welcome event when agent connects to websocket/backend */
273
331
  readonly WELCOME: "Welcome";
274
332
  /** Event emitted when agent re-login is successful */
@@ -305,7 +363,13 @@ export declare const CC_EVENTS: {
305
363
  readonly AGENT_BUDDY_AGENTS_RETRIEVE_FAILED: "BuddyAgentsRetrieveFailed";
306
364
  /** Event emitted when contact is reserved for agent */
307
365
  readonly AGENT_CONTACT_RESERVED: "AgentContactReserved";
366
+ /** Agent-level Agent Wellness Break notification */
367
+ readonly WELLNESS_BREAK: "WellnessBreak";
308
368
  };
369
+ /** Public Contact Center browser voice event names. */
370
+ export declare enum VOICE_CONNECTION_EVENTS {
371
+ STATE_CHANGE = "voice:connectionStateChange"
372
+ }
309
373
  /**
310
374
  * Event data received when agent connects to the system
311
375
  * @public
@@ -314,6 +378,14 @@ export type WelcomeEvent = {
314
378
  /** ID of the agent that connected */
315
379
  agentId: string;
316
380
  };
381
+ /**
382
+ * Available login options for voice channel access
383
+ * 'AGENT_DN' - Login using agent's DN
384
+ * 'EXTENSION' - Login using extension number
385
+ * 'BROWSER' - Login using browser-based WebRTC
386
+ * @public
387
+ */
388
+ export type LoginOption = 'AGENT_DN' | 'EXTENSION' | 'BROWSER';
317
389
  /**
318
390
  * Response type for welcome events which can be either success or error
319
391
  * @public
@@ -335,7 +407,7 @@ export type WebSocketEvent = {
335
407
  data: WelcomeEvent | Agent.StationLoginSuccess | Agent.LogoutSuccess | Agent.ReloginSuccess | Agent.StateChangeSuccess | Agent.BuddyAgentsSuccess;
336
408
  };
337
409
  /**
338
- * Represents the response from getUserUsingCI method.
410
+ * Agent identity carried by the `user` section of the user desktop-login aggregate.
339
411
  */
340
412
  export type AgentResponse = {
341
413
  /**
@@ -362,14 +434,6 @@ export type AgentResponse = {
362
434
  * The email address of the agent.
363
435
  */
364
436
  email: string;
365
- /**
366
- * Team IDs assigned to the agent.
367
- */
368
- teamIds: string[];
369
- /**
370
- * Multimedia profile ID associated with the agent.
371
- */
372
- multimediaProfileId: string;
373
437
  /**
374
438
  * Skill profile ID of the agent.
375
439
  */
@@ -379,20 +443,23 @@ export type AgentResponse = {
379
443
  */
380
444
  siteId: string;
381
445
  /**
382
- * Database ID of the agent.
446
+ * Database ID of the agent, distinct from `ciUserId`. Passed as `userDbId` to the team lookup,
447
+ * which sends it as the backend's `filter=userId==` value.
383
448
  */
384
- dbId?: string;
449
+ dbId: string;
385
450
  /**
386
451
  * The default dialed number of the agent.
452
+ * Note: The API returns this field as "deafultDialledNumber" (with typo).
387
453
  */
388
- defaultDialledNumber?: string;
454
+ deafultDialledNumber?: string;
389
455
  };
390
456
  /**
391
- * Represents the response from getDesktopProfileById method.
457
+ * Desktop Profile settings carried by the `agentProfile` section of the user desktop-login
458
+ * aggregate.
392
459
  */
393
- export type DesktopProfileResponse = {
460
+ export type AgentProfile = {
394
461
  /**
395
- * Represents the voice options of an agent.
462
+ * Represents the voice options of an agent. The order is nondeterministic; treat as a set.
396
463
  */
397
464
  loginVoiceOptions: LoginOption[];
398
465
  /**
@@ -403,14 +470,6 @@ export type DesktopProfileResponse = {
403
470
  * Idle codes that the agents can select in Agent Desktop. It can take one of these values: ALL - To make all idle codes available. SPECIFIC - To make specific codes available.
404
471
  */
405
472
  accessIdleCode: string;
406
- /**
407
- * Wrap-up codes list that the agents can select when they wrap up a contact.
408
- */
409
- wrapUpCodes: string[];
410
- /**
411
- * Idle codes list that the agents can select in Agent Desktop.
412
- */
413
- idleCodes: string[];
414
473
  /**
415
474
  * Dial plan enabled for the agent.
416
475
  */
@@ -424,9 +483,9 @@ export type DesktopProfileResponse = {
424
483
  */
425
484
  autoWrapUp: boolean;
426
485
  /**
427
- * Auto answer allowed.
486
+ * Whether the agent personal greeting is enabled.
428
487
  */
429
- autoAnswer: boolean;
488
+ agentPersonalGreeting?: boolean;
430
489
  /**
431
490
  * Auto wrap-up after seconds.
432
491
  */
@@ -439,6 +498,18 @@ export type DesktopProfileResponse = {
439
498
  * Allow auto wrap-up extension.
440
499
  */
441
500
  allowAutoWrapUpExtension: boolean;
501
+ /**
502
+ * Access control for queues assigned to the agent (ALL, SPECIFIC, or NONE).
503
+ */
504
+ accessQueue: CollaborationAccess;
505
+ /**
506
+ * Access control for entry points assigned to the agent.
507
+ */
508
+ accessEntryPoint: CollaborationAccess;
509
+ /**
510
+ * Access control for buddy teams assigned to the agent.
511
+ */
512
+ accessBuddyTeam: CollaborationAccess;
442
513
  /**
443
514
  * Outdial enabled for the agent.
444
515
  */
@@ -451,6 +522,10 @@ export type DesktopProfileResponse = {
451
522
  * Outdial ANI ID of the agent.
452
523
  */
453
524
  outdialANIId: string;
525
+ /**
526
+ * Whether the agent can schedule and manage callbacks.
527
+ */
528
+ scheduleAndManageCallBack?: boolean;
454
529
  /**
455
530
  * Consult to queue allowed.
456
531
  */
@@ -458,27 +533,18 @@ export type DesktopProfileResponse = {
458
533
  /**
459
534
  * Address book ID of the agent.
460
535
  */
461
- addressBookId: string;
536
+ addressBookId?: string;
462
537
  /**
463
538
  * Viewable statistics of the agent.
464
539
  */
465
540
  viewableStatistics: {
466
- id: string;
467
541
  agentStats: boolean;
468
- accessQueueStats: string;
469
- contactServiceQueues: string[];
470
- loggedInTeamStats: boolean;
471
- accessTeamStats: string;
472
- teams: string[];
542
+ aiAgentPerformance?: boolean;
473
543
  };
474
544
  /**
475
545
  * Agent DN validation of the agent.
476
546
  */
477
547
  agentDNValidation: string;
478
- /**
479
- * Dial plans of the agent.
480
- */
481
- dialPlans: string[];
482
548
  /**
483
549
  * Timeout desktop inactivity custom enabled.
484
550
  */
@@ -486,23 +552,7 @@ export type DesktopProfileResponse = {
486
552
  /**
487
553
  * Timeout desktop inactivity minutes.
488
554
  */
489
- timeoutDesktopInactivityMins: number;
490
- /**
491
- * Show user details in Microsoft enabled or not.
492
- */
493
- showUserDetailsMS: boolean;
494
- /**
495
- * State synchronization in Microsoft enabled or not.
496
- */
497
- stateSynchronizationMS: boolean;
498
- /**
499
- * Show user details in Webex enabled or not.
500
- */
501
- showUserDetailsWebex: boolean;
502
- /**
503
- * State synchronization in Webex enabled or not.
504
- */
505
- stateSynchronizationWebex: boolean;
555
+ timeoutDesktopInactivityMins?: number;
506
556
  };
507
557
  /**
508
558
  * Response containing multimedia profile configuration for an agent
@@ -649,7 +699,8 @@ export type ListTeamsResponse = {
649
699
  };
650
700
  };
651
701
  /**
652
- * Basic organization information in the contact center system
702
+ * Basic organization information carried by the `organization` section of the org desktop-login
703
+ * aggregate.
653
704
  * @private
654
705
  * @ignore
655
706
  */
@@ -658,11 +709,10 @@ export type OrgInfo = {
658
709
  tenantId: string;
659
710
  /** Organization timezone */
660
711
  timezone: string;
661
- /** Current environment (e.g., 'produs1', 'intgus1') */
662
- environment: string;
663
712
  };
664
713
  /**
665
- * Organization-wide feature settings and configurations
714
+ * Organization-wide feature settings carried by the `organizationSetting` section of the org
715
+ * desktop-login aggregate.
666
716
  * @private
667
717
  */
668
718
  export type OrgSettings = {
@@ -672,6 +722,8 @@ export type OrgSettings = {
672
722
  maskSensitiveData: boolean;
673
723
  /** Whether campaign manager features are enabled */
674
724
  campaignManagerEnabled: boolean;
725
+ /** Number of AI Assistant licenses assigned to the organization */
726
+ aiAssistantQuantity?: number | null;
675
727
  };
676
728
  /**
677
729
  * Contact center site configuration information
@@ -690,12 +742,13 @@ export type SiteInfo = {
690
742
  systemDefault: boolean;
691
743
  };
692
744
  /**
693
- * Tenant-level configuration data and settings
745
+ * Tenant-level configuration carried by the `tenantConfiguration` section of the org
746
+ * desktop-login aggregate.
694
747
  * @private
695
748
  */
696
749
  export type TenantData = {
697
- /** Desktop inactivity timeout in minutes */
698
- timeoutDesktopInactivityMins: number;
750
+ /** Desktop inactivity timeout in minutes. Omitted when the timeout is not enabled. */
751
+ timeoutDesktopInactivityMins?: number;
699
752
  /** Whether default DN is enforced */
700
753
  forceDefaultDn: boolean;
701
754
  /** Regex pattern for default DN validation */
@@ -718,16 +771,44 @@ export type TenantData = {
718
771
  lostConnectionRecoveryTimeout: number;
719
772
  };
720
773
  /**
721
- * URL mapping configuration for external integrations
774
+ * URL mappings carried by the `urlMappings` section of the org desktop-login aggregate, keyed by
775
+ * mapping name. The aggregate returns `{}` when the organization has no Acqueon configuration.
722
776
  * @public
723
777
  */
724
- export type URLMapping = {
725
- id: string;
726
- name: string;
727
- url: string;
728
- links: string[];
729
- createdTime: number;
730
- lastUpdatedTime: number;
778
+ export type OrgUrlMappings = {
779
+ /** Acqueon API endpoint URL */
780
+ ACQUEON_API_URL?: string;
781
+ /** Acqueon console URL */
782
+ ACQUEON_CONSOLE_URL?: string;
783
+ };
784
+ /**
785
+ * Organization-level Microsoft Teams integration configuration carried by the `microsoftConfig`
786
+ * section of the org desktop-login aggregate. The whole section is absent when the organization
787
+ * has no Microsoft integration.
788
+ * @public
789
+ */
790
+ export type MicrosoftConfig = {
791
+ /** Whether to show user details in Teams */
792
+ showUserDetails?: boolean;
793
+ /** Whether to sync agent state with Teams */
794
+ stateSynchronization?: boolean;
795
+ /** Whether the integration is enabled organization-wide */
796
+ active?: boolean;
797
+ /** Idle codes mapped to Teams presence states */
798
+ idleCodes?: Record<string, string>;
799
+ };
800
+ /**
801
+ * Organization-level Webex integration configuration carried by the `webexConfig` section of the
802
+ * org desktop-login aggregate.
803
+ * @public
804
+ */
805
+ export type WebexConfig = {
806
+ /** Whether to show user details in Webex */
807
+ showUserDetails?: boolean;
808
+ /** Whether to sync agent state with Webex */
809
+ stateSynchronization?: boolean;
810
+ /** Idle codes mapped to Webex presence states */
811
+ idleCodes?: Record<string, string>;
731
812
  };
732
813
  /**
733
814
  * Constant representing idle code
@@ -797,6 +878,8 @@ export type DialPlanEntity = {
797
878
  strippedChars: string;
798
879
  /** Name of the dial plan */
799
880
  name: string;
881
+ /** Whether the dial plan is active */
882
+ active: boolean;
800
883
  };
801
884
  /**
802
885
  * Complete dial plan configuration for number handling
@@ -898,26 +981,6 @@ export type WrapupData = {
898
981
  allowCancelAutoWrapup?: boolean;
899
982
  };
900
983
  };
901
- /**
902
- * Available login options for voice channel access
903
- * 'AGENT_DN' - Login using agent's DN
904
- * 'EXTENSION' - Login using extension number
905
- * 'BROWSER' - Login using browser-based WebRTC
906
- * @public
907
- */
908
- export type LoginOption = 'AGENT_DN' | 'EXTENSION' | 'BROWSER';
909
- /**
910
- * Team configuration information
911
- * @public
912
- */
913
- export type Team = {
914
- /** Unique team identifier */
915
- teamId: string;
916
- /** Team display name */
917
- teamName: string;
918
- /** Optional desktop layout configuration identifier */
919
- desktopLayoutId?: string;
920
- };
921
984
  /**
922
985
  * Basic queue configuration information
923
986
  * @public
@@ -939,11 +1002,12 @@ export type URLMappings = {
939
1002
  acqueonConsoleUrl: string;
940
1003
  };
941
1004
  /**
942
- * AI feature resource row returned by /v2/ai-feature API.
1005
+ * AI feature flags carried by the `aiFeature` section of the org desktop-login aggregate.
943
1006
  * @public
944
1007
  */
945
1008
  export type AIFeatureFlags = {
946
- id: string;
1009
+ /** Not carried by the aggregate; retained for responses that still supply a record id. */
1010
+ id?: string;
947
1011
  realtimeTranscripts?: {
948
1012
  enable?: boolean;
949
1013
  agentInclusionType?: string;
@@ -968,26 +1032,40 @@ export type AIFeatureFlags = {
968
1032
  queuesInclusionType?: string;
969
1033
  surveyDataSource?: string;
970
1034
  };
971
- links?: string[];
972
- createdTime?: number;
973
- lastUpdatedTime?: number;
974
1035
  };
975
1036
  /**
976
- * Response type for list AI feature resources API.
1037
+ * Aggregated organization configuration returned by `organization/{orgId}/desktop-login`.
1038
+ * Replaces the separate organization, organization-setting, tenant-configuration,
1039
+ * org-url-mapping and ai-feature calls.
977
1040
  * @public
978
1041
  */
979
- export type AIFeatureFlagsResponse = {
980
- meta?: {
981
- orgid?: string;
982
- page?: number;
983
- pageSize?: number;
984
- totalPages?: number;
985
- totalRecords?: number;
986
- links?: {
987
- self?: string;
988
- };
989
- };
990
- data: AIFeatureFlags[];
1042
+ export type OrgDesktopLoginResponse = {
1043
+ /** Organization identity and timezone */
1044
+ organization: OrgInfo;
1045
+ /** Organization-wide feature settings */
1046
+ organizationSetting: OrgSettings;
1047
+ /** Tenant-level configuration */
1048
+ tenantConfiguration: TenantData;
1049
+ /** External integration URLs, keyed by mapping name */
1050
+ urlMappings?: OrgUrlMappings;
1051
+ /** AI feature flags */
1052
+ aiFeature?: AIFeatureFlags;
1053
+ /** Microsoft Teams integration configuration; absent when not configured */
1054
+ microsoftConfig?: MicrosoftConfig;
1055
+ /** Webex integration configuration */
1056
+ webexConfig?: WebexConfig;
1057
+ };
1058
+ /**
1059
+ * Aggregated user configuration returned by
1060
+ * `organization/{orgId}/v2/user/by-ci-user-id/{ciUserId}/desktop-login`.
1061
+ * Replaces the separate user and agent-profile calls.
1062
+ * @public
1063
+ */
1064
+ export type UserDesktopLoginResponse = {
1065
+ /** Agent identity */
1066
+ user: AgentResponse;
1067
+ /** Desktop Profile settings for the agent */
1068
+ agentProfile: AgentProfile;
991
1069
  };
992
1070
  /**
993
1071
  * Comprehensive agent profile configuration in the contact center system
@@ -1009,8 +1087,8 @@ export type Profile = {
1009
1087
  /** Whether to sync agent state with Webex */
1010
1088
  stateSynchronizationWebex?: boolean;
1011
1089
  };
1012
- /** List of teams the agent belongs to */
1013
- teams: Team[];
1090
+ /** List of teams the agent belongs to, as returned by the team API */
1091
+ teams: TeamList[];
1014
1092
  /** Agent's default dial number */
1015
1093
  defaultDn: string;
1016
1094
  dn?: string;
@@ -1073,7 +1151,7 @@ export type Profile = {
1073
1151
  /** Outbound entry point */
1074
1152
  outDialEp: string;
1075
1153
  /** Whether ending calls is enabled */
1076
- isEndCallEnabled: boolean;
1154
+ isEndTaskEnabled: boolean;
1077
1155
  /** Whether ending consultations is enabled */
1078
1156
  isEndConsultEnabled: boolean;
1079
1157
  /** Optional lifecycle manager URL */
@@ -1084,6 +1162,12 @@ export type Profile = {
1084
1162
  agentAnalyzerId?: string;
1085
1163
  /** Whether consult to queue is allowed */
1086
1164
  allowConsultToQueue: boolean;
1165
+ /** Access control for queues on Desktop Profile Collaboration tab */
1166
+ accessQueue?: CollaborationAccess;
1167
+ /** Access control for entry points on Desktop Profile Collaboration tab */
1168
+ accessEntryPoint?: CollaborationAccess;
1169
+ /** Access control for buddy teams on Desktop Profile Collaboration tab */
1170
+ accessBuddyTeam?: CollaborationAccess;
1087
1171
  /** Additional campaign manager information */
1088
1172
  campaignManagerAdditionalInfo?: string;
1089
1173
  /** Whether personal statistics are enabled */
@@ -1120,8 +1204,6 @@ export type Profile = {
1120
1204
  isAnalyzerEnabled?: boolean;
1121
1205
  /** Tenant timezone */
1122
1206
  tenantTimezone?: string;
1123
- /** Current environment (e.g., 'produs1', 'intgus1') */
1124
- environment?: string;
1125
1207
  /** Available voice login options */
1126
1208
  loginVoiceOptions?: LoginOption[];
1127
1209
  /** Current login device type */
@@ -1140,6 +1222,8 @@ export type Profile = {
1140
1222
  maskSensitiveData?: boolean;
1141
1223
  /** Whether agent is currently logged in */
1142
1224
  isAgentLoggedIn?: boolean;
1225
+ /** Active station session after a successful registered relogin. */
1226
+ agentSessionId?: string;
1143
1227
  /** Last auxiliary code ID used for state change */
1144
1228
  lastStateAuxCodeId?: string;
1145
1229
  /** Timestamp of last state change */
@@ -1148,6 +1232,12 @@ export type Profile = {
1148
1232
  lastIdleCodeChangeTimestamp?: number;
1149
1233
  /** AI feature flags resolved from organization config */
1150
1234
  aiFeature?: AIFeatureFlags;
1235
+ /**
1236
+ * Whether Agent Wellness Break is effectively enabled for this profile.
1237
+ * This combines the organization wellbeing configuration with AI Assistant licensing;
1238
+ * Server-side rollout remains enforced by the backend configuration and notification delivery.
1239
+ */
1240
+ isWellnessBreakEnabled?: boolean;
1151
1241
  };
1152
1242
  /**
1153
1243
  * Contact distribution group configuration for routing logic
@@ -1205,3 +1295,51 @@ export type OutdialAniParams = {
1205
1295
  /** Comma-separated list of attributes to include in response (optional) */
1206
1296
  attributes?: string;
1207
1297
  };
1298
+ /**
1299
+ * User preference data structure
1300
+ * @public
1301
+ */
1302
+ export type UserPreference = {
1303
+ /** Unique identifier for the user preference */
1304
+ id: string;
1305
+ /** Organization ID */
1306
+ organizationId: string;
1307
+ /** User ID (CI user ID) */
1308
+ userId: string;
1309
+ /** User preference data as key-value pairs */
1310
+ preferences: Record<string, unknown>;
1311
+ /** Timestamp when this preference was created (Unix timestamp in milliseconds) */
1312
+ createdTime?: number;
1313
+ /** Timestamp when this preference was last updated (Unix timestamp in milliseconds) */
1314
+ lastUpdatedTime?: number;
1315
+ };
1316
+ /**
1317
+ * Request payload for creating user preferences
1318
+ * @public
1319
+ */
1320
+ export type CreateUserPreferenceRequest = {
1321
+ /** User ID (CI user ID) */
1322
+ userId: string;
1323
+ /** Desktop preference data as a JSON string (required) */
1324
+ desktopPreference: string;
1325
+ };
1326
+ /**
1327
+ * Request payload for updating user preferences
1328
+ * @public
1329
+ */
1330
+ export type UpdateUserPreferenceRequest = {
1331
+ /** Desktop preference data as a JSON string (required) */
1332
+ desktopPreference: string;
1333
+ };
1334
+ /**
1335
+ * Query parameters for fetching user preferences
1336
+ * @public
1337
+ */
1338
+ export type GetUserPreferenceParams = {
1339
+ /** User ID to fetch preferences for. Defaults to current user's CI user ID. */
1340
+ userId?: string;
1341
+ /** Page number (0-indexed). Default: 0 */
1342
+ page?: number;
1343
+ /** Number of items per page. Default: 100 */
1344
+ pageSize?: number;
1345
+ };