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

package/src/cc.ts

@@ -44,13 +44,8 @@ import WebexRequest from './services/core/WebexRequest';
 import LoggerProxy from './logger-proxy';
 import {StateChange, Logout, StateChangeSuccess, AGENT_EVENTS} from './services/agent/types';
 import {getErrorDetails, isValidDialNumber} from './services/core/Utils';
-import {Profile, WelcomeEvent, CC_EVENTS, ContactServiceQueue} from './services/config/types';
-import {
-  AGENT_STATE_AVAILABLE,
-  AGENT_STATE_AVAILABLE_ID,
-  DEFAULT_PAGE,
-  DEFAULT_PAGE_SIZE,
-} from './services/config/constants';
+import {Profile, WelcomeEvent, CC_EVENTS} from './services/config/types';
+import {AGENT_STATE_AVAILABLE, AGENT_STATE_AVAILABLE_ID} from './services/config/constants';
 import {ConnectionLostDetails} from './services/core/websocket/types';
 import TaskManager from './services/task/TaskManager';
 import WebCallingService from './services/WebCallingService';
@@ -58,6 +53,15 @@ import {ITask, TASK_EVENTS, TaskResponse, DialerPayload} from './services/task/t
 import MetricsManager from './metrics/MetricsManager';
 import {METRIC_EVENT_NAMES} from './metrics/constants';
 import {Failure} from './services/core/GlobalTypes';
+import EntryPoint from './services/EntryPoint';
+import AddressBook from './services/AddressBook';
+import Queue from './services/Queue';
+import type {
+  EntryPointListResponse,
+  EntryPointSearchParams,
+  ContactServiceQueuesResponse,
+  ContactServiceQueueSearchParams,
+} from './types';
 
 /**
  * The main Contact Center plugin class that enables integration with Webex Contact Center.
@@ -163,6 +167,7 @@ import {Failure} from './services/core/GlobalTypes';
  *
  * @public
  */
+
 export default class ContactCenter extends WebexPlugin implements IContactCenter {
   /**
    * The plugin's unique namespace identifier in the Webex SDK.
@@ -243,6 +248,71 @@ export default class ContactCenter extends WebexPlugin implements IContactCenter
    */
   private metricsManager: MetricsManager;
 
+  /**
+   * 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
+   * });
+   * ```
+   */
+  private entryPoint: EntryPoint;
+
+  /**
+   * 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
+   * });
+   * ```
+   */
+  public addressBook: AddressBook;
+
+  /**
+   * 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"'
+   * });
+   * ```
+   */
+  private queue: Queue;
+
   /**
    * Logger utility for Contact Center plugin
    * Provides consistent logging across the plugin
@@ -289,6 +359,13 @@ export default class ContactCenter extends WebexPlugin implements IContactCenter
       );
       this.incomingTaskListener();
 
+      // Initialize API instances
+      // will have future function for indivdual fetch etc so better be in an object
+      this.entryPoint = new EntryPoint(this.$webex);
+      this.addressBook = new AddressBook(this.$webex, () => this.agentConfig?.addressBookId);
+      this.queue = new Queue(this.$webex);
+
+      // Initialize logger
       LoggerProxy.initialize(this.$webex.logger);
     });
   }
@@ -979,11 +1056,25 @@ export default class ContactCenter extends WebexPlugin implements IContactCenter
       return;
     }
 
-    LoggerProxy.log(`Received event: ${eventData.type}`, {
+    LoggerProxy.log(`Received event: ${eventData?.data?.type ?? eventData.type}`, {
       module: CC_FILE,
       method: 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 !== CC_EVENTS.WELCOME && eventData.keepalive !== 'true') {
+      const metricsPayload: Record<string, any> = {
+        ws_event_type: nestedType || topLevelType,
+        top_level_type: topLevelType,
+        has_data: Boolean(eventData.data),
+      };
+      this.metricsManager.trackEvent(METRIC_EVENT_NAMES.WEBSOCKET_EVENT_RECEIVED, metricsPayload, [
+        'operational',
+      ]);
+    }
+
     switch (eventData.type) {
       case CC_EVENTS.AGENT_MULTI_LOGIN:
         // @ts-ignore
@@ -1398,79 +1489,6 @@ export default class ContactCenter extends WebexPlugin implements IContactCenter
     }
   }
 
-  /**
-   * 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
-   * @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();
-   *
-   * // Search for specific queues
-   * const salesQueues = await cc.getQueues('sales'); // Search for 'sales' in queue names
-   *
-   * // 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
-   * );
-   *
-   * // Process queue results
-   * queues.forEach(queue => {
-   *   console.log('Queue:', {
-   *     id: queue.queueId,
-   *     name: queue.queueName,
-   *     channelType: queue.channelType,
-   *     isActive: queue.isActive,
-   *     description: queue.description
-   *   });
-   * });
-   * ```
-   */
-  public async getQueues(
-    search?: string,
-    filter?: string,
-    page = DEFAULT_PAGE,
-    pageSize = DEFAULT_PAGE_SIZE
-  ): Promise<ContactServiceQueue[]> {
-    LoggerProxy.info('Fetching queues', {
-      module: CC_FILE,
-      method: METHODS.GET_QUEUES,
-    });
-
-    const orgId = this.$webex.credentials.getOrgId();
-
-    if (!orgId) {
-      LoggerProxy.error('Org ID not found.', {
-        module: CC_FILE,
-        method: METHODS.GET_QUEUES,
-      });
-
-      throw new Error('Org ID not found.');
-    }
-
-    const result = await this.services.config.getQueues(orgId, page, pageSize, search, filter);
-
-    LoggerProxy.log(`Successfully retrieved ${result?.length} queues`, {
-      module: CC_FILE,
-      method: METHODS.GET_QUEUES,
-    });
-
-    return result;
-  }
-
   /**
    * Uploads logs to help troubleshoot SDK issues.
    *
@@ -1615,4 +1633,26 @@ export default class ContactCenter extends WebexPlugin implements IContactCenter
       throw error;
     }
   }
+
+  /**
+   * Returns paginated entry points for the organization.
+   * Thin wrapper around internal EntryPoint instance.
+   * @public
+   */
+  public async getEntryPoints(
+    params: EntryPointSearchParams = {}
+  ): Promise<EntryPointListResponse> {
+    return this.entryPoint.getEntryPoints(params);
+  }
+
+  /**
+   * Returns paginated contact service queues for the organization.
+   * Thin wrapper around internal Queue instance.
+   * @public
+   */
+  public async getQueues(
+    params: ContactServiceQueueSearchParams = {}
+  ): Promise<ContactServiceQueuesResponse> {
+    return this.queue.getQueues(params);
+  }
 }

package/src/index.ts

@@ -2,7 +2,9 @@ import {registerPlugin} from '@webex/webex-core';
 import config from './config';
 import ContactCenter from './cc';
 
-/** @module ContactCenterModule */
+/**
+ * @module ContactCenterModule
+ * /
 
 // Core exports
 /**
@@ -24,6 +26,22 @@ export {default as Task} from './services/task';
  */
 export {default as routingAgent} from './services/agent';
 
+// API exports (AddressBook is public, EntryPoint and Queue are accessed via cc wrappers)
+export {default as AddressBook} from './services/AddressBook';
+
+/** EntryPoint API types */
+export type {
+  EntryPointRecord,
+  EntryPointListResponse,
+  EntryPointSearchParams,
+  AddressBookEntry,
+  AddressBookEntriesResponse,
+  AddressBookEntrySearchParams,
+  ContactServiceQueuesResponse,
+  ContactServiceQueueSearchParams,
+  ContactServiceQueue,
+} from './types';
+
 // Enums
 /**
  * Task Events for Contact Center operations
@@ -155,8 +173,6 @@ export type {
 export type {
   /** Profile interface */
   Profile,
-  /** Contact service queue interface */
-  ContactServiceQueue,
   /** Response type from getUserUsingCI method */
   AgentResponse,
   /** Response from getDesktopProfileById */

package/src/logger-proxy.ts

@@ -105,6 +105,29 @@ export default class LoggerProxy {
     const interactionId = context.interactionId ? ` - interactionId:${context.interactionId}` : '';
     const trackingId = context.trackingId ? ` - trackingId:${context.trackingId}` : '';
 
-    return `${timestamp} ${LOG_PREFIX} - [${level}]: module:${moduleName} - method:${methodName}${interactionId}${trackingId} - ${message}`;
+    // Format additional data if provided
+    let dataString = '';
+    if (context.data) {
+      try {
+        dataString = ` - data:${JSON.stringify(context.data)}`;
+      } catch (e) {
+        dataString = ` - data:[object]`;
+      }
+    }
+
+    // Format error if provided
+    let errorString = '';
+    if (context.error) {
+      if (context.error instanceof Error) {
+        errorString = ` - error:${context.error.name}:${context.error.message}`;
+        if (context.error.stack && level === LOGGING_LEVEL.error) {
+          errorString += ` - stack:${context.error.stack}`;
+        }
+      } else {
+        errorString = ` - error:${String(context.error)}`;
+      }
+    }
+
+    return `${timestamp} ${LOG_PREFIX} - [${level}]: module:${moduleName} - method:${methodName}${interactionId}${trackingId}${dataString}${errorString} - ${message}`;
   }
 }

package/src/metrics/MetricsManager.ts

@@ -6,8 +6,8 @@ import {
 } from '@webex/internal-plugin-metrics/src/metrics.types';
 
 import {WebexSDK} from '../types';
-import {BehavioralEventTaxonomy, getEventTaxonomy} from './behavioral-events';
 import LoggerProxy from '../logger-proxy';
+import {BehavioralEventTaxonomy, getEventTaxonomy} from './behavioral-events';
 import {METRIC_EVENT_NAMES} from './constants';
 import {Failure} from '../services/core/GlobalTypes';
 import {PRODUCT_NAME} from '../constants';

package/src/metrics/behavioral-events.ts

@@ -129,6 +129,18 @@ const eventTaxonomyMap: Record<string, BehavioralEventTaxonomy> = {
     target: 'agent_rona',
     verb: 'set',
   },
+  [METRIC_EVENT_NAMES.AGENT_CONTACT_ASSIGN_FAILED]: {
+    product,
+    agent: 'service',
+    target: 'agent_contact_assign',
+    verb: 'fail',
+  },
+  [METRIC_EVENT_NAMES.AGENT_INVITE_FAILED]: {
+    product,
+    agent: 'service',
+    target: 'agent_invite',
+    verb: 'fail',
+  },
 
   // Added Task events
   [METRIC_EVENT_NAMES.TASK_ACCEPT_SUCCESS]: {
@@ -317,6 +329,48 @@ const eventTaxonomyMap: Record<string, BehavioralEventTaxonomy> = {
     target: 'agent_device_type_update',
     verb: 'fail',
   },
+
+  // EntryPoint API Events
+  [METRIC_EVENT_NAMES.ENTRYPOINT_FETCH_SUCCESS]: {
+    product,
+    agent: 'user',
+    target: 'entrypoint_fetch',
+    verb: 'complete',
+  },
+  [METRIC_EVENT_NAMES.ENTRYPOINT_FETCH_FAILED]: {
+    product,
+    agent: 'user',
+    target: 'entrypoint_fetch',
+    verb: 'fail',
+  },
+
+  // AddressBook API Events
+  [METRIC_EVENT_NAMES.ADDRESSBOOK_FETCH_SUCCESS]: {
+    product,
+    agent: 'user',
+    target: 'addressbook_fetch',
+    verb: 'complete',
+  },
+  [METRIC_EVENT_NAMES.ADDRESSBOOK_FETCH_FAILED]: {
+    product,
+    agent: 'user',
+    target: 'addressbook_fetch',
+    verb: 'fail',
+  },
+
+  // Queue API Events
+  [METRIC_EVENT_NAMES.QUEUE_FETCH_SUCCESS]: {
+    product,
+    agent: 'user',
+    target: 'queue_fetch',
+    verb: 'complete',
+  },
+  [METRIC_EVENT_NAMES.QUEUE_FETCH_FAILED]: {
+    product,
+    agent: 'user',
+    target: 'queue_fetch',
+    verb: 'fail',
+  },
 };
 
 /**

package/src/metrics/constants.ts

@@ -117,8 +117,23 @@ export const METRIC_EVENT_NAMES = {
   WEBSOCKET_DEREGISTER_SUCCESS: 'Websocket Deregister Success',
   WEBSOCKET_DEREGISTER_FAIL: 'Websocket Deregister Failed',
 
+  // WebSocket message events
+  WEBSOCKET_EVENT_RECEIVED: 'Websocket Event Received',
+
   AGENT_DEVICE_TYPE_UPDATE_SUCCESS: 'Agent Device Type Update Success',
   AGENT_DEVICE_TYPE_UPDATE_FAILED: 'Agent Device Type Update Failed',
+
+  // EntryPoint API Events
+  ENTRYPOINT_FETCH_SUCCESS: 'Entrypoint Fetch Success',
+  ENTRYPOINT_FETCH_FAILED: 'Entrypoint Fetch Failed',
+
+  // AddressBook API Events
+  ADDRESSBOOK_FETCH_SUCCESS: 'AddressBook Fetch Success',
+  ADDRESSBOOK_FETCH_FAILED: 'AddressBook Fetch Failed',
+
+  // Queue API Events
+  QUEUE_FETCH_SUCCESS: 'Queue Fetch Success',
+  QUEUE_FETCH_FAILED: 'Queue Fetch Failed',
 } as const;
 
 /**