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

package/test/unit/spec/cc.ts

@@ -7,6 +7,11 @@ import {
   WebexSDK,
 } from '../../../src/types';
 import ContactCenter from '../../../src/cc';
+import EntryPoint from '../../../src/services/EntryPoint';
+import type {EntryPointListResponse} from '../../../src/types';
+import AddressBook from '../../../src/services/AddressBook';
+import Queue from '../../../src/services/Queue';
+import type {ContactServiceQueuesResponse} from '../../../src/types';
 import MockWebex from '@webex/test-helper-mock-webex';
 import {StationLoginSuccess, AGENT_EVENTS} from '../../../src/services/agent/types';
 import {SetStateResponse} from '../../../src/types';
@@ -113,6 +118,7 @@ describe('webex.cc', () => {
       },
       config: {
         getAgentConfig: jest.fn(),
+        getOutdialAniEntries: jest.fn(),
       },
       webSocketManager: mockWebSocketManager,
       connectionService: {
@@ -134,6 +140,7 @@ describe('webex.cc', () => {
       webSocketManager: mockWebSocketManager,
       task: undefined,
       setWrapupData: jest.fn(),
+      setAgentId: jest.fn(),
       registerIncomingCallEvent: jest.fn(),
       registerTaskListeners: jest.fn(),
       getTask: jest.fn(),
@@ -155,7 +162,7 @@ describe('webex.cc', () => {
     };
 
     jest.spyOn(MetricsManager, 'getInstance').mockReturnValue(mockMetricsManager);
-    jest.spyOn(Services, 'getInstance').mockReturnValue(mockServicesInstance);
+    jest.spyOn(Services, 'getInstance').mockReturnValue(mockServicesInstance as any);
     jest.spyOn(TaskManager, 'getTaskManager').mockReturnValue(mockTaskManager);
     jest.spyOn(WebexRequest, 'getInstance').mockReturnValue(mockWebexRequest);
     // Instantiate ContactCenter to ensure it's fully initialized
@@ -1310,7 +1317,7 @@ describe('webex.cc', () => {
   });
 
   describe('startOutdial', () => {
-    it('should make outdial call successfully.', async () => {
+    it('should make outdial call successfully without origin.', async () => {
       // Setup outDialEp.
       webex.cc.agentConfig = {
         outDialEp: 'test-entry-point',
@@ -1319,9 +1326,10 @@ describe('webex.cc', () => {
       // destination number required for making outdial call.
       const destination = '1234567890';
 
-      // Construct Payload for startOutdial.
+      // Construct Payload for startOutdial without origin.
       const newPayload = {
         destination,
+        origin: undefined,
         entryPointId: 'test-entry-point',
         direction: OUTDIAL_DIRECTION,
         attributes: ATTRIBUTES,
@@ -1351,6 +1359,49 @@ describe('webex.cc', () => {
       expect(result).toEqual(mockResponse);
     });
 
+    it('should make outdial call successfully with origin.', async () => {
+      // Setup outDialEp.
+      webex.cc.agentConfig = {
+        outDialEp: 'test-entry-point',
+      };
+
+      // destination number and origin for making outdial call.
+      const destination = '1234567890';
+      const origin = '+19403016307';
+
+      // Construct Payload for startOutdial with origin.
+      const newPayload = {
+        destination,
+        origin,
+        entryPointId: 'test-entry-point',
+        direction: OUTDIAL_DIRECTION,
+        attributes: ATTRIBUTES,
+        mediaType: OUTDIAL_MEDIA_TYPE,
+        outboundType: OUTBOUND_TYPE,
+      } as const;
+
+      const mockResponse = {} as AgentContact;
+
+      const startOutdialMock = jest
+        .spyOn(webex.cc.services.dialer, 'startOutdial')
+        .mockResolvedValue(mockResponse);
+
+      const result = await webex.cc.startOutdial(destination, origin);
+
+      // Verify logging calls
+      expect(LoggerProxy.info).toHaveBeenCalledWith('Starting outbound dial', {
+        module: CC_FILE,
+        method: 'startOutdial',
+      });
+      expect(LoggerProxy.log).toHaveBeenCalledWith('Outbound dial completed successfully', {
+        module: CC_FILE,
+        method: 'startOutdial',
+      });
+
+      expect(startOutdialMock).toHaveBeenCalledWith({data: newPayload});
+      expect(result).toEqual(mockResponse);
+    });
+
     it('should handle error during startOutdial', async () => {
       // Setup outDialEp.
       webex.cc.agentConfig = {
@@ -1387,88 +1438,6 @@ describe('webex.cc', () => {
     });
   });
 
-  describe('getQueues', () => {
-    it('should return queues response when successful', async () => {
-      const mockQueuesResponse = [
-        {
-          queueId: 'queue1',
-          queueName: 'Queue 1',
-        },
-        {
-          queueId: 'queue2',
-          queueName: 'Queue 2',
-        },
-      ];
-
-      webex.cc.services.config.getQueues = jest.fn().mockResolvedValue(mockQueuesResponse);
-
-      const result = await webex.cc.getQueues();
-
-      // Verify logging calls
-      expect(LoggerProxy.info).toHaveBeenCalledWith('Fetching queues', {
-        module: CC_FILE,
-        method: 'getQueues',
-      });
-      expect(LoggerProxy.log).toHaveBeenCalledWith(
-        `Successfully retrieved ${result.length} queues`,
-        {
-          module: CC_FILE,
-          method: 'getQueues',
-        }
-      );
-
-      expect(webex.cc.services.config.getQueues).toHaveBeenCalledWith(
-        'mockOrgId',
-        0,
-        100,
-        undefined,
-        undefined
-      );
-      expect(result).toEqual(mockQueuesResponse);
-    });
-
-    it('should throw an error if orgId is not present', async () => {
-      jest.spyOn(webex.credentials, 'getOrgId').mockResolvedValue(undefined);
-      webex.cc.services.config.getQueues = jest.fn();
-
-      try {
-        await webex.cc.getQueues();
-      } catch (error) {
-        expect(error).toEqual(new Error('Org ID not found.'));
-        expect(LoggerProxy.info).toHaveBeenCalledWith('Fetching queues', {
-          module: CC_FILE,
-          method: 'getQueues',
-        });
-        expect(LoggerProxy.error).toHaveBeenCalledWith('Org ID not found.', {
-          module: CC_FILE,
-          method: 'getQueues',
-        });
-        expect(webex.cc.services.config.getQueues).not.toHaveBeenCalled();
-      }
-    });
-
-    it('should throw an error if config getQueues throws an error', async () => {
-      webex.cc.services.config.getQueues = jest.fn().mockRejectedValue(new Error('Test error.'));
-
-      try {
-        await webex.cc.getQueues();
-      } catch (error) {
-        expect(error).toEqual(new Error('Test error.'));
-        expect(LoggerProxy.info).toHaveBeenCalledWith('Fetching queues', {
-          module: CC_FILE,
-          method: 'getQueues',
-        });
-        expect(webex.cc.services.config.getQueues).toHaveBeenCalledWith(
-          'mockOrgId',
-          0,
-          100,
-          undefined,
-          undefined
-        );
-      }
-    });
-  });
-
   describe('uploadLogs', () => {
     it('should upload logs successfully', async () => {
       const uploadLogsMock = jest.spyOn(webex.cc.webexRequest, 'uploadLogs').mockResolvedValue({
@@ -1796,6 +1765,31 @@ describe('webex.cc', () => {
     });
   });
 
+  describe('API property exposure', () => {
+    it('should provide getEntryPoints wrapper that delegates to EntryPoint', async () => {
+      const spy = jest
+        .spyOn(EntryPoint.prototype, 'getEntryPoints')
+        .mockResolvedValue({} as EntryPointListResponse);
+      await webex.cc.getEntryPoints();
+      expect(spy).toHaveBeenCalled();
+      spy.mockRestore();
+    });
+
+    it('should expose addressBook API', () => {
+      expect(webex.cc.addressBook).toBeDefined();
+      expect(webex.cc.addressBook).toBeInstanceOf(AddressBook);
+    });
+
+    it('should provide getQueues wrapper that delegates to Queue', async () => {
+      const spy = jest
+        .spyOn(Queue.prototype, 'getQueues')
+        .mockResolvedValue({} as ContactServiceQueuesResponse);
+      await webex.cc.getQueues();
+      expect(spy).toHaveBeenCalled();
+      spy.mockRestore();
+    });
+  });
+
   describe('updateAgentProfile', () => {
     beforeEach(() => {
       webex.cc.agentConfig = {
@@ -1982,4 +1976,207 @@ describe('webex.cc', () => {
       });
     });
   });
+
+  describe('getOutdialAniEntries', () => {
+    const mockOutdialANI = 'ani-123-456';
+    const mockParams = {
+      outdialANI: mockOutdialANI,
+      page: 0,
+      pageSize: 10,
+      search: 'test',
+      filter: 'active=true',
+      attributes: 'id,name,number',
+    };
+
+    beforeEach(() => {
+      jest.clearAllMocks();
+      // Reset orgId mock to return valid value
+      webex.credentials.getOrgId.mockReturnValue('mockOrgId');
+    });
+
+    it('should successfully fetch outdial ANI entries and track success metrics', async () => {
+      const mockResult = [
+        {
+          id: '142fba3c-8502-4446-bf6e-584fd657553a',
+          name: 'Test Entry',
+          number: '+19403016307',
+        },
+        {
+          id: '6f53000b-e04a-4418-9de9-ba511d2367cb',
+          name: 'Another Entry',
+          number: '+19403016308',
+        },
+      ];
+
+      // Mock the service call to return successful result
+      webex.cc.services.config.getOutdialAniEntries.mockResolvedValue(mockResult);
+
+      const result = await webex.cc.getOutdialAniEntries(mockParams);
+
+      // Verify the service was called with correct parameters
+      expect(webex.cc.services.config.getOutdialAniEntries).toHaveBeenCalledWith('mockOrgId', {
+        outdialANI: mockOutdialANI,
+        page: 0,
+        pageSize: 10,
+        search: 'test',
+        filter: 'active=true',
+        attributes: 'id,name,number',
+      });
+
+      // Verify the result is returned correctly
+      expect(result).toEqual(mockResult);
+
+      // Verify success metrics are tracked
+      expect(mockMetricsManager.trackEvent).toHaveBeenCalledWith(
+        METRIC_EVENT_NAMES.OUTDIAL_ANI_EP_FETCH_SUCCESS,
+        {
+          outdialANI: mockOutdialANI,
+          resultCount: 2,
+        },
+        ['behavioral', 'business', 'operational']
+      );
+
+      // Verify success logging
+      expect(LoggerProxy.log).toHaveBeenCalledWith(
+        `Successfully retrieved outdial ANI entries for ANI ID ${mockOutdialANI}`,
+        {
+          module: CC_FILE,
+          method: 'getOutdialAniEntries',
+        }
+      );
+    });
+
+    it('should handle empty results and track success metrics with zero count', async () => {
+      const mockResult = [];
+
+      // Mock the service call to return empty result
+      webex.cc.services.config.getOutdialAniEntries.mockResolvedValue(mockResult);
+
+      const result = await webex.cc.getOutdialAniEntries({outdialANI: mockOutdialANI});
+
+      // Verify the result is returned correctly
+      expect(result).toEqual(mockResult);
+
+      // Verify success metrics are tracked with zero count
+      expect(mockMetricsManager.trackEvent).toHaveBeenCalledWith(
+        METRIC_EVENT_NAMES.OUTDIAL_ANI_EP_FETCH_SUCCESS,
+        {
+          outdialANI: mockOutdialANI,
+          resultCount: 0,
+        },
+        ['behavioral', 'business', 'operational']
+      );
+    });
+
+    it('should handle undefined results and track success metrics with zero count', async () => {
+      // Mock the service call to return undefined
+      webex.cc.services.config.getOutdialAniEntries.mockResolvedValue(undefined);
+
+      const result = await webex.cc.getOutdialAniEntries({outdialANI: mockOutdialANI});
+
+      // Verify the result is returned correctly
+      expect(result).toBeUndefined();
+
+      // Verify success metrics are tracked with zero count
+      expect(mockMetricsManager.trackEvent).toHaveBeenCalledWith(
+        METRIC_EVENT_NAMES.OUTDIAL_ANI_EP_FETCH_SUCCESS,
+        {
+          outdialANI: mockOutdialANI,
+          resultCount: 0,
+        },
+        ['behavioral', 'business', 'operational']
+      );
+    });
+
+    it('should handle service failure and track failure metrics', async () => {
+      const mockError = new Error('Service unavailable') as any;
+      mockError.details = {
+        trackingId: 'test-tracking-id',
+        orgId: 'mockOrgId',
+        error: 'Service error',
+      };
+
+      // Mock the service call to throw an error
+      webex.cc.services.config.getOutdialAniEntries.mockRejectedValue(mockError);
+
+      // Mock getErrorDetails to return a detailed error
+      const detailedError = new Error('Detailed service error');
+      getErrorDetailsSpy.mockReturnValue({error: detailedError});
+
+      await expect(webex.cc.getOutdialAniEntries(mockParams)).rejects.toThrow('Detailed service error');
+
+      // Verify failure metrics are tracked
+      expect(mockMetricsManager.trackEvent).toHaveBeenCalledWith(
+        METRIC_EVENT_NAMES.OUTDIAL_ANI_EP_FETCH_FAILED,
+        {
+          ...MetricsManager.getCommonTrackingFieldForAQMResponseFailed(mockError.details),
+          outdialANI: mockOutdialANI,
+          error: mockError,
+        },
+        ['behavioral', 'business', 'operational']
+      );
+
+      // Verify error logging
+      expect(LoggerProxy.error).toHaveBeenCalledWith(
+        `Failed to fetch outdial ANI entries for ANI ID ${mockOutdialANI} due to: ${mockError}`,
+        {
+          module: CC_FILE,
+          method: 'getOutdialAniEntries',
+          trackingId: 'test-tracking-id',
+        }
+      );
+
+      // Verify getErrorDetails was called
+      expect(getErrorDetailsSpy).toHaveBeenCalledWith(
+        mockError,
+        'getOutdialAniEntries',
+        CC_FILE
+      );
+    });
+
+    it('should throw error when orgId is not found', async () => {
+      // Mock getOrgId to return null
+      webex.credentials.getOrgId.mockReturnValue(null);
+
+      await expect(webex.cc.getOutdialAniEntries(mockParams)).rejects.toThrow('Org ID not found.');
+
+      // Verify error logging
+      expect(LoggerProxy.error).toHaveBeenCalledWith('Org ID not found.', {
+        module: CC_FILE,
+        method: 'getOutdialAniEntries',
+      });
+
+      // Verify service was not called
+      expect(webex.cc.services.config.getOutdialAniEntries).not.toHaveBeenCalled();
+
+      // Verify no metrics were tracked
+      expect(mockMetricsManager.trackEvent).not.toHaveBeenCalled();
+    });
+
+    it('should handle minimal parameters correctly', async () => {
+      const minimalParams = {outdialANI: mockOutdialANI};
+      const mockResult = [{id: 'test', name: 'Test', number: '+1234567890'}];
+
+      webex.cc.services.config.getOutdialAniEntries.mockResolvedValue(mockResult);
+
+      const result = await webex.cc.getOutdialAniEntries(minimalParams);
+
+      // Verify the service was called with minimal parameters
+      expect(webex.cc.services.config.getOutdialAniEntries).toHaveBeenCalledWith('mockOrgId', {
+        outdialANI: mockOutdialANI,
+      });
+
+      expect(result).toEqual(mockResult);
+
+      // Verify success metrics are tracked
+      expect(mockMetricsManager.trackEvent).toHaveBeenCalledWith(
+        METRIC_EVENT_NAMES.OUTDIAL_ANI_EP_FETCH_SUCCESS,
+        {
+          outdialANI: mockOutdialANI,
+          resultCount: 1,
+        },
+        ['behavioral', 'business', 'operational']
+      );
+    });
+  });
 });

package/test/unit/spec/metrics/behavioral-events.ts

@@ -110,6 +110,48 @@ describe('metrics/behavioral-events', () => {
         verb: 'fail',
       });
 
+      expect(getEventTaxonomy(METRIC_EVENT_NAMES.TASK_CONFERENCE_START_SUCCESS)).toEqual({
+        product,
+        agent: 'user',
+        target: 'task_conference_start',
+        verb: 'complete',
+      });
+
+      expect(getEventTaxonomy(METRIC_EVENT_NAMES.TASK_CONFERENCE_START_FAILED)).toEqual({
+        product,
+        agent: 'user',
+        target: 'task_conference_start',
+        verb: 'fail',
+      });
+
+      expect(getEventTaxonomy(METRIC_EVENT_NAMES.TASK_CONFERENCE_END_SUCCESS)).toEqual({
+        product,
+        agent: 'user',
+        target: 'task_conference_end',
+        verb: 'complete',
+      });
+
+      expect(getEventTaxonomy(METRIC_EVENT_NAMES.TASK_CONFERENCE_END_FAILED)).toEqual({
+        product,
+        agent: 'user',
+        target: 'task_conference_end',
+        verb: 'fail',
+      });
+
+      expect(getEventTaxonomy(METRIC_EVENT_NAMES.TASK_CONFERENCE_TRANSFER_SUCCESS)).toEqual({
+        product,
+        agent: 'user',
+        target: 'task_conference_transfer',
+        verb: 'complete',
+      });
+
+      expect(getEventTaxonomy(METRIC_EVENT_NAMES.TASK_CONFERENCE_TRANSFER_FAILED)).toEqual({
+        product,
+        agent: 'user',
+        target: 'task_conference_transfer',
+        verb: 'fail',
+      });
+
       expect(getEventTaxonomy('' as METRIC_EVENT_NAMES)).toEqual(undefined);
     });
   });