@webex/contact-center 3.9.0 → 3.10.0-next.10

package/dist/cc.js

@@ -9,19 +9,22 @@ var _events = _interopRequireDefault(require("events"));
 var _uuid = require("uuid");
 var _types = require("./types");
 var _constants = require("./constants");
-var _constants2 = require("./services/constants");
+var _constants2 = require("./services/config/constants");
+var _constants3 = require("./services/constants");
 var _services = _interopRequireDefault(require("./services"));
 var _WebexRequest = _interopRequireDefault(require("./services/core/WebexRequest"));
 var _loggerProxy = _interopRequireDefault(require("./logger-proxy"));
 var _types2 = require("./services/agent/types");
 var _Utils = require("./services/core/Utils");
 var _types3 = require("./services/config/types");
-var _constants3 = require("./services/config/constants");
 var _TaskManager = _interopRequireDefault(require("./services/task/TaskManager"));
 var _WebCallingService = _interopRequireDefault(require("./services/WebCallingService"));
 var _types4 = require("./services/task/types");
 var _MetricsManager = _interopRequireDefault(require("./metrics/MetricsManager"));
 var _constants4 = require("./metrics/constants");
+var _EntryPoint = _interopRequireDefault(require("./services/EntryPoint"));
+var _AddressBook = _interopRequireDefault(require("./services/AddressBook"));
+var _Queue = _interopRequireDefault(require("./services/Queue"));
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 /**
  * @module CCPlugin
@@ -135,6 +138,7 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
  *
  * @public
  */
+
 class ContactCenter extends _webexCore.WebexPlugin {
   /**
    * The plugin's unique namespace identifier in the Webex SDK.
@@ -206,6 +210,68 @@ class ContactCenter extends _webexCore.WebexPlugin {
    * @private
    */
 
+  /**
+   * API instance for managing Webex Contact Center entry points
+   * Provides functionality to fetch entry points with caching support
+   * @type {EntryPoint}
+   * @public
+   * @example
+   * ```typescript
+   * const cc = webex.cc;
+   * await cc.register();
+   * await cc.stationLogin({ teamId: 'team123', loginOption: 'BROWSER' });
+   *
+   * // Access EntryPointRecord
+   * const response = await cc.entryPoint.getEntryPoints({
+   *   page: 0,
+   *   pageSize: 50
+   * });
+   * ```
+   */
+
+  /**
+   * API instance for managing Webex Contact Center address book contacts
+   * Provides functionality to fetch address book entries with caching support
+   * @type {AddressBook}
+   * @public
+   * @example
+   * ```typescript
+   * const cc = webex.cc;
+   * await cc.register();
+   * await cc.stationLogin({ teamId: 'team123', loginOption: 'BROWSER' });
+   *
+   * // Access AddressBook API
+   * const response = await cc.addressBook.getEntries({
+   *   page: 0,
+   *   pageSize: 25
+   * });
+   * ```
+   */
+
+  /**
+   * API instance for managing Webex Contact Center queues
+   * Provides functionality to fetch queues with caching support
+   * @type {Queue}
+   * @public
+   * @example
+   * ```typescript
+   * const cc = webex.cc;
+   * await cc.register();
+   * await cc.stationLogin({ teamId: 'team123', loginOption: 'BROWSER' });
+   *
+   * // Access Queue API
+   * const response = await cc.queue.getQueues({
+   *   page: 0,
+   *   pageSize: 50
+   * });
+   *
+   * // Filter queues by specific criteria
+   * const filteredQueues = await cc.queue.getQueues({
+   *   filter: 'id=="queue-id-123"'
+   * });
+   * ```
+   */
+
   /**
    * Logger utility for Contact Center plugin
    * Provides consistent logging across the plugin
@@ -245,6 +311,14 @@ class ContactCenter extends _webexCore.WebexPlugin {
       });
       this.taskManager = _TaskManager.default.getTaskManager(this.services.contact, this.webCallingService, this.services.webSocketManager);
       this.incomingTaskListener();
+
+      // Initialize API instances
+      // will have future function for indivdual fetch etc so better be in an object
+      this.entryPoint = new _EntryPoint.default(this.$webex);
+      this.addressBook = new _AddressBook.default(this.$webex, () => this.agentConfig?.addressBookId);
+      this.queue = new _Queue.default(this.$webex);
+
+      // Initialize logger
       _loggerProxy.default.initialize(this.$webex.logger);
     });
   }
@@ -269,6 +343,16 @@ class ContactCenter extends _webexCore.WebexPlugin {
     this.trigger(_types4.TASK_EVENTS.TASK_HYDRATE, task);
   };
 
+  /**
+   * Handles task merged events when tasks are combined eg: EPDN merge/transfer
+   * @private
+   * @param {ITask} task The task object that has been merged
+   */
+  handleTaskMerged = task => {
+    // @ts-ignore
+    this.trigger(_types4.TASK_EVENTS.TASK_MERGED, task);
+  };
+
   /**
    * Sets up event listeners for incoming tasks and task hydration
    * Subscribes to task events from the task manager
@@ -277,6 +361,7 @@ class ContactCenter extends _webexCore.WebexPlugin {
   incomingTaskListener() {
     this.taskManager.on(_types4.TASK_EVENTS.TASK_INCOMING, this.handleIncomingTask);
     this.taskManager.on(_types4.TASK_EVENTS.TASK_HYDRATE, this.handleTaskHydrate);
+    this.taskManager.on(_types4.TASK_EVENTS.TASK_MERGED, this.handleTaskMerged);
   }
 
   /**
@@ -522,6 +607,7 @@ class ContactCenter extends _webexCore.WebexPlugin {
         });
         // TODO: Make profile a singleton to make it available throughout app/sdk so we dont need to inject info everywhere
         this.taskManager.setWrapupData(this.agentConfig.wrapUpData);
+        this.taskManager.setAgentId(this.agentConfig.agentId);
         if (this.agentConfig.webRtcEnabled && this.agentConfig.loginVoiceOptions.includes(_types.LoginOption.BROWSER)) {
           this.$webex.internal.mercury.connect().then(() => {
             _loggerProxy.default.log('Authentication: webex.internal.mercury.connect successful', {
@@ -596,14 +682,14 @@ class ContactCenter extends _webexCore.WebexPlugin {
         };
         throw error;
       }
-      const loginResponse = this.services.agent.stationLogin({
+      const loginResponse = await this.services.agent.stationLogin({
         data: {
           dialNumber: data.loginOption === _types.LoginOption.BROWSER ? this.agentConfig.agentId : data.dialNumber,
           teamId: data.teamId,
           deviceType: data.loginOption,
           isExtension: data.loginOption === _types.LoginOption.EXTENSION,
           deviceId: this.getDeviceId(data.loginOption, data.dialNumber),
-          roles: [_constants2.AGENT],
+          roles: [_constants3.AGENT],
           teamName: _constants.EMPTY_STRING,
           siteId: _constants.EMPTY_STRING,
           usesOtherDN: false,
@@ -726,7 +812,7 @@ class ContactCenter extends _webexCore.WebexPlugin {
     if (loginOption === _types.LoginOption.EXTENSION || loginOption === _types.LoginOption.AGENT_DN) {
       return dialNumber;
     }
-    return _constants2.WEB_RTC_PREFIX + this.agentConfig.agentId;
+    return _constants3.WEB_RTC_PREFIX + this.agentConfig.agentId;
   }
 
   /**
@@ -837,6 +923,18 @@ class ContactCenter extends _webexCore.WebexPlugin {
       module: _constants.CC_FILE,
       method: _constants.METHODS.HANDLE_WEBSOCKET_MESSAGE
     });
+
+    // Emit metrics for all websocket events except keepalive and welcome
+    const topLevelType = eventData.type;
+    const nestedType = eventData?.data?.type;
+    if (topLevelType !== _types3.CC_EVENTS.WELCOME && eventData.keepalive !== 'true') {
+      const metricsPayload = {
+        ws_event_type: nestedType || topLevelType,
+        top_level_type: topLevelType,
+        has_data: Boolean(eventData.data)
+      };
+      this.metricsManager.trackEvent(_constants4.METRIC_EVENT_NAMES.WEBSOCKET_EVENT_RECEIVED, metricsPayload, ['operational']);
+    }
     switch (eventData.type) {
       case _types3.CC_EVENTS.AGENT_MULTI_LOGIN:
         // @ts-ignore
@@ -1001,9 +1099,9 @@ class ContactCenter extends _webexCore.WebexPlugin {
           module: _constants.CC_FILE,
           method: _constants.METHODS.SILENT_RELOGIN
         });
-        auxCodeId = _constants3.AGENT_STATE_AVAILABLE_ID;
+        auxCodeId = _constants2.AGENT_STATE_AVAILABLE_ID;
         const stateChangeData = {
-          state: _constants3.AGENT_STATE_AVAILABLE,
+          state: _constants2.AGENT_STATE_AVAILABLE,
           auxCodeId,
           lastStateChangeReason,
           agentId
@@ -1085,6 +1183,7 @@ class ContactCenter extends _webexCore.WebexPlugin {
    * Makes an outbound call to a specified phone number.
    *
    * @param {string} destination - The phone number to dial (e.g., '+1234567890').
+   * @param {string} origin - The contact center number that will be used while making a call to the customer.
    * Should include country code and be in E.164 format.
    * @returns {Promise<TaskResponse>} Resolves with the task response containing:
    *   - interactionId: Unique identifier for the outbound call
@@ -1120,7 +1219,7 @@ class ContactCenter extends _webexCore.WebexPlugin {
    *
    *   // Start the outbound call
    *   const destination = '+1234567890';
-   *   const task = await cc.startOutdial(destination);
+   *   const task = await cc.startOutdial(destination, origin);
    *
    *   // Listen for all relevant task events
    *   task.on('task:ringing', () => {
@@ -1188,7 +1287,7 @@ class ContactCenter extends _webexCore.WebexPlugin {
    * }
    * ```
    */
-  async startOutdial(destination) {
+  async startOutdial(destination, origin) {
     _loggerProxy.default.info('Starting outbound dial', {
       module: _constants.CC_FILE,
       method: _constants.METHODS.START_OUTDIAL
@@ -1199,6 +1298,7 @@ class ContactCenter extends _webexCore.WebexPlugin {
       // Construct the outdial payload.
       const outDialPayload = {
         destination,
+        origin,
         entryPointId: this.agentConfig.outDialEp,
         direction: _constants.OUTDIAL_DIRECTION,
         attributes: _constants.ATTRIBUTES,
@@ -1211,6 +1311,7 @@ class ContactCenter extends _webexCore.WebexPlugin {
       this.metricsManager.trackEvent(_constants4.METRIC_EVENT_NAMES.TASK_OUTDIAL_SUCCESS, {
         ..._MetricsManager.default.getCommonTrackingFieldForAQMResponse(result),
         destination,
+        origin,
         mediaType: _constants.OUTDIAL_MEDIA_TYPE
       }, ['behavioral', 'business', 'operational']);
       _loggerProxy.default.log(`Outbound dial completed successfully`, {
@@ -1225,6 +1326,7 @@ class ContactCenter extends _webexCore.WebexPlugin {
       this.metricsManager.trackEvent(_constants4.METRIC_EVENT_NAMES.TASK_OUTDIAL_FAILED, {
         ..._MetricsManager.default.getCommonTrackingFieldForAQMResponseFailed(failure),
         destination,
+        origin,
         mediaType: _constants.OUTDIAL_MEDIA_TYPE
       }, ['behavioral', 'business', 'operational']);
       const {
@@ -1235,65 +1337,105 @@ class ContactCenter extends _webexCore.WebexPlugin {
   }
 
   /**
-   * This is used for getting the list of queues to which a task can be consulted or transferred.
-   * @param {string} [search] - Optional search string to filter queues by name
-   * @param {string} [filter] - Optional OData filter expression (e.g., 'teamId eq "team123"')
-   * @param {number} [page=0] - Page number for paginated results, starting at 0
-   * @param {number} [pageSize=100] - Number of queues to return per page
-   * @returns Promise<ContactServiceQueue[]> Resolves with the list of queues
-   * @throws Error If the operation fails
+   * Fetches outdial ANI (Automatic Number Identification) entries for an outdial ANI ID.
+   *
+   * This method retrieves the list of phone numbers that can be used as caller ID when making
+   * outbound calls. The ANI data is associated with an outdial ANI ID and can be filtered
+   * and paginated as needed.
+   *
+   * @param {string} outdialANI - The outdial ANI ID to fetch ANI data for
+   * @param {number} [page] - Optional page number for pagination (0-based)
+   * @param {number} [pageSize] - Optional number of items per page
+   * @param {string} [search] - Optional search term to filter results by name or number
+   * @param {string} [filter] - Optional filter string
+   * @param {string} [attributes] - Optional attributes to include in response
+   * @returns {Promise<OutdialAniEntriesResponse>} Promise resolving to outdial ANI response containing:
+   *   - data: Array of ANI entries with number and name
+   *   - meta: Pagination metadata
+   * @throws {Error} If the operation fails or agent is not registered
    * @public
    * @example
    * ```typescript
    * const cc = webex.cc;
    * await cc.register();
-   * await cc.stationLogin({ teamId: 'team123', loginOption: 'BROWSER' });
    *
-   * // Basic usage - get all queues
-   * const allQueues = await cc.getQueues();
+   * // Get agent profile to obtain outdial ANI ID
+   * const agentProfile = cc.agentConfig;
+   * const outdialANI = agentProfile.outdialANIId;
    *
-   * // Search for specific queues
-   * const salesQueues = await cc.getQueues('sales'); // Search for 'sales' in queue names
+   * // Basic usage - get all ANI data for an outdial ANI ID
+   * const aniData = await cc.getOutdialAniEntries({ outdialANI });
    *
-   * // Use filtering and pagination
-   * const filteredQueues = await cc.getQueues(
-   *   '', // No search term
-   *   'teamId eq "team123"', // Filter by team
-   *   0,  // First page
-   *   50  // 50 items per page
-   * );
+   * // With pagination and search
+   * const paginatedAni = await cc.getOutdialAniEntries({
+   *   outdialANI,
+   *   page: 0,
+   *   pageSize: 50,
+   *   search: '555' // search for numbers containing '555'
+   * });
    *
-   * // Process queue results
-   * queues.forEach(queue => {
-   *   console.log('Queue:', {
-   *     id: queue.queueId,
-   *     name: queue.queueName,
-   *     channelType: queue.channelType,
-   *     isActive: queue.isActive,
-   *     description: queue.description
-   *   });
+   * // Process the results
+   * paginatedAni.forEach(ani => {
+   *   console.log(`ANI: ${ani.number} - ${ani.name}`);
    * });
    * ```
    */
-  async getQueues(search, filter, page = _constants3.DEFAULT_PAGE, pageSize = _constants3.DEFAULT_PAGE_SIZE) {
-    _loggerProxy.default.info('Fetching queues', {
+  async getOutdialAniEntries(params) {
+    const {
+      outdialANI,
+      page,
+      pageSize,
+      search,
+      filter,
+      attributes
+    } = params;
+    _loggerProxy.default.info('Fetching outdial ANI entries', {
       module: _constants.CC_FILE,
-      method: _constants.METHODS.GET_QUEUES
+      method: _constants.METHODS.GET_OUTDIAL_ANI_ENTRIES
     });
     const orgId = this.$webex.credentials.getOrgId();
     if (!orgId) {
       _loggerProxy.default.error('Org ID not found.', {
         module: _constants.CC_FILE,
-        method: _constants.METHODS.GET_QUEUES
+        method: _constants.METHODS.GET_OUTDIAL_ANI_ENTRIES
       });
       throw new Error('Org ID not found.');
     }
-    const result = await this.services.config.getQueues(orgId, page, pageSize, search, filter);
-    _loggerProxy.default.log(`Successfully retrieved ${result?.length} queues`, {
-      module: _constants.CC_FILE,
-      method: _constants.METHODS.GET_QUEUES
-    });
-    return result;
+    try {
+      const result = await this.services.config.getOutdialAniEntries(orgId, {
+        outdialANI,
+        page,
+        pageSize,
+        search,
+        filter,
+        attributes
+      });
+      this.metricsManager.trackEvent(_constants4.METRIC_EVENT_NAMES.OUTDIAL_ANI_EP_FETCH_SUCCESS, {
+        outdialANI,
+        resultCount: result?.length || 0
+      }, ['behavioral', 'business', 'operational']);
+      _loggerProxy.default.log(`Successfully retrieved outdial ANI entries for ANI ID ${outdialANI}`, {
+        module: _constants.CC_FILE,
+        method: _constants.METHODS.GET_OUTDIAL_ANI_ENTRIES
+      });
+      return result;
+    } catch (error) {
+      const failure = error.details;
+      this.metricsManager.trackEvent(_constants4.METRIC_EVENT_NAMES.OUTDIAL_ANI_EP_FETCH_FAILED, {
+        ..._MetricsManager.default.getCommonTrackingFieldForAQMResponseFailed(failure),
+        outdialANI,
+        error
+      }, ['behavioral', 'business', 'operational']);
+      _loggerProxy.default.error(`Failed to fetch outdial ANI entries for ANI ID ${outdialANI} due to: ${error}`, {
+        module: _constants.CC_FILE,
+        method: _constants.METHODS.GET_OUTDIAL_ANI_ENTRIES,
+        trackingId: failure.trackingId
+      });
+      const {
+        error: detailedError
+      } = (0, _Utils.getErrorDetails)(error, _constants.METHODS.GET_OUTDIAL_ANI_ENTRIES, _constants.CC_FILE);
+      throw detailedError;
+    }
   }
 
   /**
@@ -1411,6 +1553,24 @@ class ContactCenter extends _webexCore.WebexPlugin {
       throw error;
     }
   }
+
+  /**
+   * Returns paginated entry points for the organization.
+   * Thin wrapper around internal EntryPoint instance.
+   * @public
+   */
+  async getEntryPoints(params = {}) {
+    return this.entryPoint.getEntryPoints(params);
+  }
+
+  /**
+   * Returns paginated contact service queues for the organization.
+   * Thin wrapper around internal Queue instance.
+   * @public
+   */
+  async getQueues(params = {}) {
+    return this.queue.getQueues(params);
+  }
 }
 exports.default = ContactCenter;
 //# sourceMappingURL=cc.js.map