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

package/dist/types/services/AddressBook.d.ts

@@ -0,0 +1,74 @@
+import { WebexSDK } from '../types';
+import type { AddressBookEntriesResponse, AddressBookEntrySearchParams } from '../types';
+/**
+ * AddressBook API class for managing Webex Contact Center address book entries.
+ * Provides functionality to fetch address book entries using the entry API.
+ *
+ * @class AddressBook
+ * @public
+ * @example
+ * ```typescript
+ * import Webex from 'webex';
+ *
+ * const webex = new Webex({ credentials: 'YOUR_ACCESS_TOKEN' });
+ * const cc = webex.cc;
+ *
+ * // Register and login first
+ * await cc.register();
+ * await cc.stationLogin({ teamId: 'team123', loginOption: 'BROWSER' });
+ *
+ * // Get AddressBook API instance from ContactCenter
+ * const addressBookAPI = cc.addressBook;
+ *
+ * // Get entries from agent's default address book
+ * const entries = await addressBookAPI.getEntries();
+ *
+ * // Get entries from a specific address book with pagination
+ * const entries = await addressBookAPI.getEntries({
+ *   addressBookId: 'addressBookId123',
+ *   page: 0,
+ *   pageSize: 50
+ * });
+ *
+ * // Search for specific entries
+ * const searchResults = await addressBook.getEntries({
+ *   search: 'john',
+ *   filter: 'name=="John Doe"'
+ * });
+ * ```
+ */
+export declare class AddressBook {
+    private webexRequest;
+    private webex;
+    private getAddressBookId;
+    private metricsManager;
+    private pageCache;
+    /**
+     * Creates an instance of AddressBook
+     * @param {WebexSDK} webex - The Webex SDK instance
+     * @param {() => string} getAddressBookId - Function to get the addressBookId from agent profile
+     * @public
+     */
+    constructor(webex: WebexSDK, getAddressBookId: () => string);
+    /**
+     * Fetches address book entries for a specific address book using the entry API
+     * @param {AddressBookEntrySearchParams} [params] - Search and pagination parameters including addressBookId
+     * @returns {Promise<AddressBookEntriesResponse>} Promise resolving to address book entries
+     * @throws {Error} If the API call fails
+     * @public
+     * @example
+     * ```typescript
+     * // Get entries from agent's default address book
+     * const response = await addressBookAPI.getEntries();
+     *
+     * // Get entries from a specific address book with pagination
+     * const response = await addressBookAPI.getEntries({
+     *   addressBookId: 'addressBookId123',
+     *   page: 0,
+     *   pageSize: 25
+     * });
+     * ```
+     */
+    getEntries(params?: AddressBookEntrySearchParams): Promise<AddressBookEntriesResponse>;
+}
+export default AddressBook;

package/dist/types/services/EntryPoint.d.ts

@@ -0,0 +1,67 @@
+import { WebexSDK } from '../types';
+import type { EntryPointListResponse, EntryPointSearchParams } from '../types';
+/**
+ * EntryPoint class for managing Webex Contact Center entry points.
+ * Provides functionality to fetch, search, and paginate through entry points.
+ *
+ * @class EntryPoint
+ * @public
+ * @example
+ * ```typescript
+ * import Webex from 'webex';
+ *
+ * const webex = new Webex({ credentials: 'YOUR_ACCESS_TOKEN' });
+ * const cc = webex.cc;
+ *
+ * // Register and login first
+ * await cc.register();
+ * await cc.stationLogin({ teamId: 'team123', loginOption: 'BROWSER' });
+ *
+ * // Get EntryPoint API instance from ContactCenter
+ * const entryPointAPI = cc.entryPoint;
+ *
+ * // Get all entry points with pagination
+ * const response = await entryPointAPI.getEntryPoints({
+ *   page: 0,
+ *   pageSize: 50
+ * });
+ *
+ * // Search for specific entry points
+ * const searchResults = await entryPointAPI.searchEntryPoints({
+ *   search: 'support',
+ *   filter: 'type=="voice"'
+ * });
+ * ```
+ */
+export declare class EntryPoint {
+    private webexRequest;
+    private webex;
+    private metricsManager;
+    private pageCache;
+    /**
+     * Creates an instance of EntryPoint
+     * @param {WebexSDK} webex - The Webex SDK instance
+     * @public
+     */
+    constructor(webex: WebexSDK);
+    /**
+     * Fetches entry points for the organization with pagination support
+     * @param {EntryPointSearchParams} [params] - Search and pagination parameters
+     * @returns {Promise<EntryPointListResponse>} Promise resolving to paginated entry points
+     * @throws {Error} If the API call fails
+     * @public
+     * @example
+     * ```typescript
+     * // Get first page of entry points
+     * const response = await entryPointAPI.getEntryPoints();
+     *
+     * // Get specific page with custom page size
+     * const response = await entryPointAPI.getEntryPoints({
+     *   page: 2,
+     *   pageSize: 25
+     * });
+     * ```
+     */
+    getEntryPoints(params?: EntryPointSearchParams): Promise<EntryPointListResponse>;
+}
+export default EntryPoint;

package/dist/types/services/Queue.d.ts

@@ -0,0 +1,76 @@
+import { WebexSDK } from '../types';
+import type { ContactServiceQueuesResponse, ContactServiceQueueSearchParams } from '../types';
+/**
+ * Queue API class for managing Webex Contact Center contact service queues.
+ * Provides functionality to fetch contact service queues using the queue API.
+ *
+ * @class Queue
+ * @public
+ * @example
+ * ```typescript
+ * import Webex from 'webex';
+ *
+ * const webex = new Webex({ credentials: 'YOUR_ACCESS_TOKEN' });
+ * const cc = webex.cc;
+ *
+ * // Register and login first
+ * await cc.register();
+ * await cc.stationLogin({ teamId: 'team123', loginOption: 'BROWSER' });
+ *
+ * // Get Queue API instance from ContactCenter
+ * const queueAPI = cc.queue;
+ *
+ * // Get all queues
+ * const queues = await queueAPI.getQueues();
+ *
+ * // Get queues with pagination
+ * const queues = await queueAPI.getQueues({
+ *   page: 0,
+ *   pageSize: 50
+ * });
+ *
+ * // Search for specific queues
+ * const searchResults = await queueAPI.getQueues({
+ *   search: 'support',
+ *   filter: 'name=="Support Queue"'
+ * });
+ * ```
+ */
+export declare class Queue {
+    private webexRequest;
+    private webex;
+    private metricsManager;
+    private pageCache;
+    /**
+     * Creates an instance of Queue
+     * @param {WebexSDK} webex - The Webex SDK instance
+     * @public
+     */
+    constructor(webex: WebexSDK);
+    /**
+     * Fetches contact service queues for the organization
+     * @param {ContactServiceQueueSearchParams} [params] - Search and pagination parameters
+     * @returns {Promise<ContactServiceQueuesResponse>} Promise resolving to contact service queues
+     * @throws {Error} If the API call fails
+     * @public
+     * @example
+     * ```typescript
+     * // Get all queues with default pagination
+     * const response = await queueAPI.getQueues();
+     *
+     * // Get queues with specific pagination
+     * const response = await queueAPI.getQueues({
+     *   page: 0,
+     *   pageSize: 25
+     * });
+     *
+     * // Search for queues
+     * const response = await queueAPI.getQueues({
+     *   search: 'support',
+     *   filter: 'queueType=="INBOUND"'
+     * });
+     * ```
+     */
+    getQueues(params?: ContactServiceQueueSearchParams): Promise<ContactServiceQueuesResponse>;
+}
+export default Queue;

package/dist/types/services/config/constants.d.ts

@@ -51,7 +51,6 @@ export declare const METHODS: {
     GET_TENANT_DATA: string;
     GET_URL_MAPPING: string;
     GET_DIAL_PLAN_DATA: string;
-    GET_QUEUES: string;
     PARSE_AGENT_CONFIGS: string;
     GET_URL_MAPPING_UTIL: string;
     GET_MSFT_CONFIG: string;
@@ -200,4 +199,27 @@ export declare const endPointMap: {
      * @ignore
      */
     queueList: (orgId: string, queryParams: string) => string;
+    /**
+     * Gets the endpoint for entry points list with custom query parameters.
+     * @param orgId - Organization ID.
+     * @param queryParams - Query parameters string.
+     * @returns The endpoint URL string.
+     * @public
+     * @example
+     * const url = endPointMap.entryPointList('org123', 'page=0&pageSize=10');
+     * @ignore
+     */
+    entryPointList: (orgId: string, queryParams: string) => string;
+    /**
+     * Gets the endpoint for address book entries with custom query parameters.
+     * @param orgId - Organization ID.
+     * @param addressBookId - Address book ID.
+     * @param queryParams - Query parameters string.
+     * @returns The endpoint URL string.
+     * @public
+     * @example
+     * const url = endPointMap.addressBookEntries('org123', 'book456', 'page=0&pageSize=10');
+     * @ignore
+     */
+    addressBookEntries: (orgId: string, addressBookId: string, queryParams: string) => string;
 };

package/dist/types/services/config/index.d.ts

@@ -2,7 +2,7 @@
  * @packageDocumentation
  * @module AgentConfigService
  */
-import { DesktopProfileResponse, ListAuxCodesResponse, AgentResponse, OrgInfo, OrgSettings, TenantData, URLMapping, TeamList, DialPlanEntity, Profile, ListTeamsResponse, AuxCode, MultimediaProfileResponse, SiteInfo, ContactServiceQueue } from './types';
+import { DesktopProfileResponse, ListAuxCodesResponse, AgentResponse, OrgInfo, OrgSettings, TenantData, URLMapping, TeamList, DialPlanEntity, Profile, ListTeamsResponse, AuxCode, MultimediaProfileResponse, SiteInfo } from './types';
 /**
  * The AgentConfigService class provides methods to fetch agent configuration data.
  * @private
@@ -155,17 +155,4 @@ export default class AgentConfigService {
      * @private
      */
     getDialPlanData(orgId: string): Promise<DialPlanEntity[]>;
-    /**
-     * Fetches the list of queues for the given orgId.
-     * @ignore
-     * @param {string} orgId - organization ID for which the queues are to be fetched.
-     * @param {number} page - the page number to fetch.
-     * @param {number} pageSize - the number of queues to fetch per page.
-     * @param {string} search - optional search string
-     * @param {string} filter - optional filter string
-     * @returns Promise<ContactServiceQueue[]> - A promise that resolves to the list of contact service queues.
-     * @throws {Error} - Throws an error if the API call fails or if the response status is not 200.
-     * @private
-     */
-    getQueues(orgId: string, page: number, pageSize: number, search?: string, filter?: string): Promise<ContactServiceQueue[]>;
 }

package/dist/types/services/config/types.d.ts

@@ -1047,67 +1047,3 @@ export type CallDistributionGroup = {
     /** Distribution time duration in seconds */
     duration: number;
 };
-/**
- * Comprehensive configuration for a contact service queue
- * @public
- */
-export type ContactServiceQueue = {
-    /** Unique identifier for the queue */
-    id: string;
-    /** Queue name */
-    name: string;
-    /** Queue description */
-    description: string;
-    /** Type of queue */
-    queueType: string;
-    /** Whether to check agent availability before routing */
-    checkAgentAvailability: boolean;
-    /** Type of channel this queue handles */
-    channelType: string;
-    /** Service level threshold in seconds */
-    serviceLevelThreshold: number;
-    /** Maximum number of active contacts allowed */
-    maxActiveContacts: number;
-    /** Maximum time contacts can wait in queue (seconds) */
-    maxTimeInQueue: number;
-    /** Default music on hold media file ID */
-    defaultMusicInQueueMediaFileId: string;
-    /** Queue timezone */
-    timezone: string;
-    /** Whether queue is active */
-    active: boolean;
-    /** Whether outbound campaign routing is enabled */
-    outdialCampaignEnabled: boolean;
-    /** Whether monitoring is permitted */
-    monitoringPermitted: boolean;
-    /** Whether parking is permitted */
-    parkingPermitted: boolean;
-    /** Whether recording is permitted */
-    recordingPermitted: boolean;
-    /** Whether recording all calls is permitted */
-    recordingAllCallsPermitted: boolean;
-    /** Whether pausing recordings is permitted */
-    pauseRecordingPermitted: boolean;
-    /** Maximum recording pause duration in seconds */
-    recordingPauseDuration: number;
-    /** Control flow script URL */
-    controlFlowScriptUrl: string;
-    /** IVR requeue URL */
-    ivrRequeueUrl: string;
-    /** Type of routing strategy */
-    routingType: string;
-    /** Queue-specific routing type */
-    queueRoutingType: string;
-    /** Queue skill requirements for routing */
-    queueSkillRequirements: object[];
-    /** Associated agents */
-    agents: object[];
-    /** Call distribution group configurations */
-    callDistributionGroups: CallDistributionGroup[];
-    /** Associated resource links */
-    links: Array<string>;
-    /** Timestamp when queue was created */
-    createdTime: string;
-    /** Timestamp when queue was last updated */
-    lastUpdatedTime: string;
-};

package/dist/types/services/core/GlobalTypes.d.ts

@@ -31,3 +31,28 @@ export type Failure = Msg<{
     /** Human-readable description of the failure reason */
     reason: string;
 }>;
+/**
+ * Represents task API error details in a structured format
+ * @public
+ */
+export interface TaskError {
+    /** Original error object for throwing */
+    error: Error;
+    /** Unique tracking identifier for correlation */
+    trackingId: string;
+    /** Detailed error message from the API */
+    errorMessage: string;
+    /** Type/category of the error (e.g., "Bad Request") */
+    errorType: string;
+    /** Additional error context data */
+    errorData: string;
+    /** Numeric reason code */
+    reasonCode: number;
+}
+/**
+ * An Error object augmented with a flexible data field for additional context.
+ * Use this to attach structured data to thrown errors without ts-ignore.
+ */
+export interface AugmentedError extends Error {
+    data?: Record<string, any>;
+}

package/dist/types/services/core/Utils.d.ts

@@ -1,6 +1,7 @@
 import * as Err from './Err';
 import { LoginOption, WebexRequestPayload } from '../../types';
-import { Failure } from './GlobalTypes';
+import { Failure, AugmentedError } from './GlobalTypes';
+import { TaskData, ConsultTransferPayLoad, Interaction } from '../task/types';
 export declare const isValidDialNumber: (input: string) => boolean;
 export declare const getStationLoginErrorData: (failure: Failure, loginOption: LoginOption) => {
     message: any;
@@ -23,6 +24,21 @@ export declare const getErrorDetails: (error: any, methodName: string, moduleNam
     error: Error;
     reason: string;
 };
+/**
+ * Extracts error details from task API errors and logs them. Also uploads logs for the error.
+ * This handles the specific error format returned by task API calls.
+ *
+ * @param error - The error object from task API calls with structure: {id: string, details: {trackingId: string, msg: {...}}}
+ * @param methodName - The name of the method where the error occurred.
+ * @param moduleName - The name of the module where the error occurred.
+ * @returns AugmentedError containing structured error details on err.data for metrics and logging
+ * @public
+ * @example
+ * const taskError = generateTaskErrorObject(error, 'transfer', 'TaskModule');
+ * throw taskError.error;
+ * @ignore
+ */
+export declare const generateTaskErrorObject: (error: any, methodName: string, moduleName: string) => AugmentedError;
 /**
  * Creates an error details object suitable for use with the Err.Details class.
  *
@@ -34,3 +50,13 @@ export declare const getErrorDetails: (error: any, methodName: string, moduleNam
  * @ignore
  */
 export declare const createErrDetailsObject: (errObj: WebexRequestPayload) => Err.Details<"Service.reqs.generic.failure">;
+/**
+ * Gets the destination agent ID from participants data by finding the first
+ * non-customer participant that is not the current agent and is not in wrap-up state.
+ *
+ * @param participants - The participants data from the interaction
+ * @param agentId - The current agent's ID to exclude from the search
+ * @returns The destination agent ID, or empty string if none found
+ */
+export declare const getDestinationAgentId: (participants: Interaction['participants'], agentId: string) => string;
+export declare const deriveConsultTransferDestinationType: (taskData?: TaskData) => ConsultTransferPayLoad['destinationType'];

package/dist/types/services/task/index.d.ts

@@ -565,5 +565,5 @@ export default class Task extends EventEmitter implements ITask {
      *   .catch(error => console.error('Failed to complete queue consultation transfer:', error));
      * ```
      */
-    consultTransfer(consultTransferPayload: ConsultTransferPayLoad): Promise<TaskResponse>;
+    consultTransfer(consultTransferPayload?: ConsultTransferPayLoad): Promise<TaskResponse>;
 }

package/dist/types/types.d.ts

@@ -1,6 +1,7 @@
 import { CallingClientConfig } from '@webex/calling';
 import * as Agent from './services/agent/types';
 import { Profile } from './services/config/types';
+import { PaginatedResponse, BaseSearchParams } from './utils/PageCache';
 /**
  * HTTP methods supported by WebexRequest.
  * @enum {string}
@@ -140,6 +141,10 @@ export interface LogContext {
     method?: string;
     interactionId?: string;
     trackingId?: string;
+    /** Additional structured data to include in logs */
+    data?: Record<string, any>;
+    /** Error object to include in logs */
+    error?: Error | unknown;
 }
 /**
  * Available logging severity levels.
@@ -434,6 +439,163 @@ export type StationReLoginResponse = Agent.ReloginSuccess | Error;
  * @ignore
  */
 export type SetStateResponse = Agent.StateChangeSuccess | Error;
+/**
+ * AddressBook types
+ */
+export interface AddressBookEntry {
+    id: string;
+    organizationId?: string;
+    version?: number;
+    name: string;
+    number: string;
+    createdTime?: number;
+    lastUpdatedTime?: number;
+}
+export type AddressBookEntriesResponse = PaginatedResponse<AddressBookEntry>;
+export interface AddressBookEntrySearchParams extends BaseSearchParams {
+    addressBookId?: string;
+}
+/**
+ * EntryPointRecord types
+ */
+export interface EntryPointRecord {
+    id: string;
+    name: string;
+    description?: string;
+    type: string;
+    isActive: boolean;
+    orgId: string;
+    createdAt?: string;
+    updatedAt?: string;
+    settings?: Record<string, any>;
+}
+export type EntryPointListResponse = PaginatedResponse<EntryPointRecord>;
+export type EntryPointSearchParams = BaseSearchParams;
+/**
+ * Queue types
+ */
+export interface QueueSkillRequirement {
+    organizationId?: string;
+    id?: string;
+    version?: number;
+    skillId: string;
+    skillName?: string;
+    skillType?: string;
+    condition: string;
+    skillValue: string;
+    createdTime?: number;
+    lastUpdatedTime?: number;
+}
+export interface QueueAgent {
+    id: string;
+    ciUserId?: string;
+}
+export interface AgentGroup {
+    teamId: string;
+}
+export interface CallDistributionGroup {
+    agentGroups: AgentGroup[];
+    order: number;
+    duration?: number;
+}
+export interface AssistantSkillMapping {
+    assistantSkillId?: string;
+    assistantSkillUpdatedTime?: number;
+}
+/**
+ * Configuration for a contact service queue
+ * @public
+ */
+export interface ContactServiceQueue {
+    /** Organization ID */
+    organizationId?: string;
+    /** Unique identifier for the queue */
+    id?: string;
+    /** Version of the queue */
+    version?: number;
+    /** Name of the Contact Service Queue */
+    name: string;
+    /** Description of the queue */
+    description?: string;
+    /** Queue type (INBOUND, OUTBOUND) */
+    queueType: 'INBOUND' | 'OUTBOUND';
+    /** Whether to check agent availability */
+    checkAgentAvailability: boolean;
+    /** Channel type (TELEPHONY, EMAIL, SOCIAL_CHANNEL, CHAT, etc.) */
+    channelType: 'TELEPHONY' | 'EMAIL' | 'FAX' | 'CHAT' | 'VIDEO' | 'OTHERS' | 'SOCIAL_CHANNEL';
+    /** Social channel type for SOCIAL_CHANNEL channelType */
+    socialChannelType?: 'MESSAGEBIRD' | 'MESSENGER' | 'WHATSAPP' | 'APPLE_BUSINESS_CHAT' | 'GOOGLE_BUSINESS_MESSAGES';
+    /** Service level threshold in seconds */
+    serviceLevelThreshold: number;
+    /** Maximum number of simultaneous contacts */
+    maxActiveContacts: number;
+    /** Maximum time in queue in seconds */
+    maxTimeInQueue: number;
+    /** Default music in queue media file ID */
+    defaultMusicInQueueMediaFileId: string;
+    /** Timezone for routing strategies */
+    timezone?: string;
+    /** Whether the queue is active */
+    active: boolean;
+    /** Whether outdial campaign is enabled */
+    outdialCampaignEnabled?: boolean;
+    /** Whether monitoring is permitted */
+    monitoringPermitted: boolean;
+    /** Whether parking is permitted */
+    parkingPermitted: boolean;
+    /** Whether recording is permitted */
+    recordingPermitted: boolean;
+    /** Whether recording all calls is permitted */
+    recordingAllCallsPermitted: boolean;
+    /** Whether pausing recording is permitted */
+    pauseRecordingPermitted: boolean;
+    /** Recording pause duration in seconds */
+    recordingPauseDuration?: number;
+    /** Control flow script URL */
+    controlFlowScriptUrl: string;
+    /** IVR requeue URL */
+    ivrRequeueUrl: string;
+    /** Overflow number for telephony */
+    overflowNumber?: string;
+    /** Vendor ID */
+    vendorId?: string;
+    /** Routing type */
+    routingType: 'LONGEST_AVAILABLE_AGENT' | 'SKILLS_BASED' | 'CIRCULAR' | 'LINEAR';
+    /** Skills-based routing type */
+    skillBasedRoutingType?: 'LONGEST_AVAILABLE_AGENT' | 'BEST_AVAILABLE_AGENT';
+    /** Queue routing type */
+    queueRoutingType: 'TEAM_BASED' | 'SKILL_BASED' | 'AGENT_BASED';
+    /** Queue skill requirements */
+    queueSkillRequirements?: QueueSkillRequirement[];
+    /** List of agents for agent-based queue */
+    agents?: QueueAgent[];
+    /** Call distribution groups */
+    callDistributionGroups: CallDistributionGroup[];
+    /** XSP version */
+    xspVersion?: string;
+    /** Subscription ID */
+    subscriptionId?: string;
+    /** Assistant skill mapping */
+    assistantSkill?: AssistantSkillMapping;
+    /** Whether this is a system default queue */
+    systemDefault?: boolean;
+    /** User who last updated agents list */
+    agentsLastUpdatedByUserName?: string;
+    /** Email of user who last updated agents list */
+    agentsLastUpdatedByUserEmailPrefix?: string;
+    /** When agents list was last updated */
+    agentsLastUpdatedTime?: number;
+    /** Creation timestamp in epoch millis */
+    createdTime?: number;
+    /** Last updated timestamp in epoch millis */
+    lastUpdatedTime?: number;
+}
+export type ContactServiceQueuesResponse = PaginatedResponse<ContactServiceQueue>;
+export interface ContactServiceQueueSearchParams extends BaseSearchParams {
+    desktopProfileFilter?: boolean;
+    provisioningView?: boolean;
+    singleObjectResponse?: boolean;
+}
 /**
  * Response type for buddy agents query operations.
  * Either a success response with list of buddy agents or an error.