@wxcc-desktop/sdk 2.0.0 → 2.0.2

package/README.md

@@ -9,6 +9,7 @@ WxCC Agent Desktop JS API modules set
 - Actions module
 - Logger service module
 - ShortcutKey service module
+- Webex Metrics module
 - AQM/Notifs **agent-contact** service layer API module for WxCC Agent Desktop.
 - AQM/Notifs **agent-state** service layer API module for WxCC Agent Desktop.
 - AQM/Notifs **dialer** service layer API module for WxCC Agent Desktop.
@@ -27,6 +28,7 @@ const {
   logger,
   shortcutKey,
   i18n,
+  webexMetricsInternal,
 
   // AQM/Notifs modules
   agentContact,
@@ -262,6 +264,22 @@ await Desktop.agentContact.vteamList({ ... });
 await Desktop.agentContact.pauseRecording({ ... });
 await Desktop.agentContact.resumeRecording({ ... });
 
+// List of new routing API's
+await Desktop.agentContact.acceptV2({ ... });
+await Desktop.agentContact.cancelTaskV2({ ... });
+await Desktop.agentContact.endV2({ ... });
+await Desktop.agentContact.pauseRecordingV2({ ... });
+await Desktop.agentContact.resumeRecordingV2({ ... });
+await Desktop.agentContact.wrapupV2({ ... });
+await Desktop.agentContact.consultV2({ ... });
+await Desktop.agentContact.consultEndV2({ ... });
+await Desktop.agentContact.consultConferenceV2({ ... });
+await Desktop.agentContact.exitConference({ ... });
+await Desktop.agentContact.vteamTransferV2({ ... });
+await Desktop.agentContact.blindTransferV2({ ... });
+await Desktop.agentContact.consultTransferV2({ ... });
+await Desktop.agentContact.buddyAgentsV2({ ... });
+
 // List of available agent-contact aqm notifs events:
 Desktop.agentContact.addEventListener("eAgentContact", msg => console.log(msg));
 Desktop.agentContact.addEventListener("eAgentContactAssigned", msg => console.log(msg));
@@ -439,8 +457,8 @@ Desktop.monitoring.addEventListener("eMonitoringHeld", listener);
 Desktop.monitoring.addEventListener("eMonitoringHoldFailed", listener);
 Desktop.monitoring.addEventListener("eMonitoringUnHeld", listener);
 Desktop.monitoring.addEventListener("eMonitoringUnHoldFailed", listener);
-Desktop.monitoring.addEventListener("eBargedIn", listener);
-Desktop.monitoring.addEventListener("eBargeInFailed", listener);
+Desktop.monitoring.addEventListener("eAgentMonitorStateChanged", listener);
+Desktop.monitoring.addEventListener("eAgentMonitorStateChangeFailed", listener);
 
 Desktop.monitoring.removeEventListener("eMonitoringOffered", listener);
 Desktop.monitoring.removeEventListener("eMonitoringStarted", listener);
@@ -452,8 +470,8 @@ Desktop.monitoring.removeEventListener("eMonitoringHeld", listener);
 Desktop.monitoring.removeEventListener("eMonitoringHoldFailed", listener);
 Desktop.monitoring.removeEventListener("eMonitoringUnHeld", listener);
 Desktop.monitoring.removeEventListener("eMonitoringUnHoldFailed", listener);
-Desktop.monitoring.removeEventListener("eBargedIn", listener);
-Desktop.monitoring.removeEventListener("eBargeInFailed", listener);
+Desktop.monitoring.removeEventListener("eAgentMonitorStateChanged", listener);
+Desktop.monitoring.removeEventListener("eAgentMonitorStateChangeFailed", listener);
 
 
 // Module supports one-time added listeners like:
@@ -467,8 +485,8 @@ Desktop.monitoring.addOnceEventListener("eMonitoringHeld", listener);
 Desktop.monitoring.addOnceEventListener("eMonitoringHoldFailed", listener);
 Desktop.monitoring.addOnceEventListener("eMonitoringUnHeld", listener);
 Desktop.monitoring.addOnceEventListener("eMonitoringUnHoldFailed", listener);
-Desktop.monitoring.addOnceEventListener("eBargedIn", listener);
-Desktop.monitoring.addOnceEventListener("eBargeInFailed", listener);
+Desktop.monitoring.addOnceEventListener("eAgentMonitorStateChanged", listener);
+Desktop.monitoring.addOnceEventListener("eAgentMonitorStateChangeFailed", listener);
 
 Desktop.monitoring.removeOnceEventListener("eMonitoringOffered", listener);
 Desktop.monitoring.removeOnceEventListener("eMonitoringStarted", listener);
@@ -480,8 +498,8 @@ Desktop.monitoring.removeOnceEventListener("eMonitoringHeld", listener);
 Desktop.monitoring.removeOnceEventListener("eMonitoringHoldFailed", listener);
 Desktop.monitoring.removeOnceEventListener("eMonitoringUnHeld", listener);
 Desktop.monitoring.removeOnceEventListener("eMonitoringUnHoldFailed", listener);
-Desktop.monitoring.removeOnceEventListener("eBargedIn", listener);
-Desktop.monitoring.removeOnceEventListener("eBargeInFailed", listener);
+Desktop.monitoring.removeOnceEventListener("eAgentMonitorStateChanged", listener);
+Desktop.monitoring.removeOnceEventListener("eAgentMonitorStateChangeFailed", listener);
 // Module supports removing all listeners like:
 Desktop.monitoring.removeAllEventListeners();
 
@@ -534,6 +552,41 @@ await Desktop.postInteraction.fetchCapture({taskId});
 
 ```
 
+### `Desktop.agentConfigJsApi` sub-module
+
+`Desktop.agentConfigJsApi` sub-module is intended to fetch Agent configurations from contact center Backend service API's.
+
+```Javascript
+/*
+  Supposing Desktop.config.init() was called
+*/
+
+// AgentX paginated idleCodes/wrapupCodes:
+const requestAuxCodes =  {
+  workType: "IDLE_CODE" | "WRAP_UP_CODE";
+  page?: number;
+  pageSize?: number;
+  search?: string;
+  customFilter?: string;
+  }
+const paginatedAuxCodes: await Desktop.agentConfigJsApi.fetchPaginatedAuxCodes(requestAuxCodes);
+
+```
+
+### `Desktop.webexMetricsInternal` sub-module
+
+`Desktop.webexMetricsInternal` sub-module is intended for tracking metrics and events from widgits
+
+```Javascript
+/*
+  Supposing Desktop.config.init() was called
+*/
+
+// Module supports tracking behavioral events within widgit
+Desktop.webexMetricsInternal.trackBehavioralEvent(name: string, options?: EventPayload);
+
+```
+
 ### Publishing the wxcc-desktop/js-api
 
 For publishing internally to Internal Cisco Repository: `yarn npm:publish:internal`