@webex/contact-center 3.11.0 → 3.12.0-mobius-socket.2

package/dist/types/metrics/constants.d.ts

@@ -0,0 +1,161 @@
+type Enum<T extends Record<string, unknown>> = T[keyof T];
+/**
+ * @ignore
+ * @module METRIC_EVENT_NAMES
+ * @export
+ * @description
+ * A constant object containing all metric event names used for tracking various agent and task-related events
+ * within the Contact Center plugin. Each property represents a specific event and its corresponding string value
+ * as reported in metrics.
+ *
+ * @property {string} STATION_LOGIN_SUCCESS - Event name for successful station login.
+ * @property {string} STATION_LOGIN_FAILED - Event name for failed station login.
+ * @property {string} STATION_LOGOUT_SUCCESS - Event name for successful station logout.
+ * @property {string} STATION_LOGOUT_FAILED - Event name for failed station logout.
+ * @property {string} STATION_RELOGIN_SUCCESS - Event name for successful station relogin.
+ * @property {string} STATION_RELOGIN_FAILED - Event name for failed station relogin.
+ * @property {string} AGENT_STATE_CHANGE_SUCCESS - Event name for successful agent state change.
+ * @property {string} AGENT_STATE_CHANGE_FAILED - Event name for failed agent state change.
+ * @property {string} FETCH_BUDDY_AGENTS_SUCCESS - Event name for successfully fetching buddy agents.
+ * @property {string} FETCH_BUDDY_AGENTS_FAILED - Event name for failed attempt to fetch buddy agents.
+ * @property {string} WEBSOCKET_REGISTER_SUCCESS - Event name for successful websocket registration.
+ * @property {string} WEBSOCKET_REGISTER_FAILED - Event name for failed websocket registration.
+ * @property {string} AGENT_RONA - Event name for agent RONA (Ring No Answer).
+ * @property {string} AGENT_CONTACT_ASSIGN_FAILED - Event name for failed agent contact assignment.
+ * @property {string} AGENT_INVITE_FAILED - Event name for failed agent invite.
+ *
+ * @property {string} TASK_ACCEPT_SUCCESS - Event name for successful task acceptance.
+ * @property {string} TASK_ACCEPT_FAILED - Event name for failed task acceptance.
+ * @property {string} TASK_DECLINE_SUCCESS - Event name for successful task decline.
+ * @property {string} TASK_DECLINE_FAILED - Event name for failed task decline.
+ * @property {string} TASK_END_SUCCESS - Event name for successful task end.
+ * @property {string} TASK_END_FAILED - Event name for failed task end.
+ * @property {string} TASK_WRAPUP_SUCCESS - Event name for successful task wrap-up.
+ * @property {string} TASK_WRAPUP_FAILED - Event name for failed task wrap-up.
+ * @property {string} TASK_HOLD_SUCCESS - Event name for successful task hold.
+ * @property {string} TASK_HOLD_FAILED - Event name for failed task hold.
+ * @property {string} TASK_RESUME_SUCCESS - Event name for successful task resume.
+ * @property {string} TASK_RESUME_FAILED - Event name for failed task resume.
+ * @property {string} TASK_CONSULT_START_SUCCESS - Event name for successful consult start.
+ * @property {string} TASK_CONSULT_START_FAILED - Event name for failed consult start.
+ * @property {string} TASK_CONSULT_END_SUCCESS - Event name for successful consult end.
+ * @property {string} TASK_CONSULT_END_FAILED - Event name for failed consult end.
+ * @property {string} TASK_TRANSFER_SUCCESS - Event name for successful task transfer.
+ * @property {string} TASK_TRANSFER_FAILED - Event name for failed task transfer.
+ * @property {string} TASK_RESUME_RECORDING_SUCCESS - Event name for successful resume of recording.
+ * @property {string} TASK_RESUME_RECORDING_FAILED - Event name for failed resume of recording.
+ * @property {string} TASK_PAUSE_RECORDING_SUCCESS - Event name for successful pause of recording.
+ * @property {string} TASK_PAUSE_RECORDING_FAILED - Event name for failed pause of recording.
+ * @property {string} TASK_ACCEPT_CONSULT_SUCCESS - Event name for successful consult acceptance.
+ * @property {string} TASK_ACCEPT_CONSULT_FAILED - Event name for failed consult acceptance.
+ * @property {string} TASK_AUTO_ANSWER_SUCCESS - Event name for successful auto-answer.
+ * @property {string} TASK_AUTO_ANSWER_FAILED - Event name for failed auto-answer.
+ *
+ * @property {string} TASK_CONFERENCE_START_SUCCESS - Event name for successful conference start.
+ * @property {string} TASK_CONFERENCE_START_FAILED - Event name for failed conference start.
+ * @property {string} TASK_CONFERENCE_END_SUCCESS - Event name for successful conference end.
+ * @property {string} TASK_CONFERENCE_END_FAILED - Event name for failed conference end.
+ * @property {string} TASK_CONFERENCE_TRANSFER_SUCCESS - Event name for successful conference transfer.
+ * @property {string} TASK_CONFERENCE_TRANSFER_FAILED - Event name for failed conference transfer.
+ *
+ * @property {string} TASK_OUTDIAL_SUCCESS - Event name for successful outdial task.
+ * @property {string} TASK_OUTDIAL_FAILED - Event name for failed outdial task.
+ *
+ * @property {string} UPLOAD_LOGS_SUCCESS - Event name for successful log upload.
+ * @property {string} UPLOAD_LOGS_FAILED - Event name for failed log upload.
+ * @property {string} WEBSOCKET_DEREGISTER_SUCCESS - Event name for successful websocket deregistration.
+ * @property {string} WEBSOCKET_DEREGISTER_FAIL - Event name for failed websocket deregistration.
+ *
+ * @property {string} AGENT_DEVICE_TYPE_UPDATE_SUCCESS - Event name for successful agent device type update.
+ * @property {string} AGENT_DEVICE_TYPE_UPDATE_FAILED - Event name for failed agent device type update.
+ *
+ * @property {string} OUTDIAL_ANI_EP_FETCH_SUCCESS - Event name for successful outdial ANI entries fetch.
+ * @property {string} OUTDIAL_ANI_EP_FETCH_FAILED - Event name for failed outdial ANI entries fetch.
+ *
+ * @readonly
+ */
+export declare const METRIC_EVENT_NAMES: {
+    readonly STATION_LOGIN_SUCCESS: "Station Login Success";
+    readonly STATION_LOGIN_FAILED: "Station Login Failed";
+    readonly STATION_LOGOUT_SUCCESS: "Station Logout Success";
+    readonly STATION_LOGOUT_FAILED: "Station Logout Failed";
+    readonly STATION_RELOGIN_SUCCESS: "Station Relogin Success";
+    readonly STATION_RELOGIN_FAILED: "Station Relogin Failed";
+    readonly AGENT_STATE_CHANGE_SUCCESS: "Agent State Change Success";
+    readonly AGENT_STATE_CHANGE_FAILED: "Agent State Change Failed";
+    readonly FETCH_BUDDY_AGENTS_SUCCESS: "Fetch Buddy Agents Success";
+    readonly FETCH_BUDDY_AGENTS_FAILED: "Fetch Buddy Agents Failed";
+    readonly WEBSOCKET_REGISTER_SUCCESS: "Websocket Register Success";
+    readonly WEBSOCKET_REGISTER_FAILED: "Websocket Register Failed";
+    readonly AGENT_RONA: "Agent RONA";
+    readonly AGENT_CONTACT_ASSIGN_FAILED: "Agent Contact Assign Failed";
+    readonly AGENT_INVITE_FAILED: "Agent Invite Failed";
+    readonly TASK_ACCEPT_SUCCESS: "Task Accept Success";
+    readonly TASK_ACCEPT_FAILED: "Task Accept Failed";
+    readonly TASK_DECLINE_SUCCESS: "Task Decline Success";
+    readonly TASK_DECLINE_FAILED: "Task Decline Failed";
+    readonly TASK_END_SUCCESS: "Task End Success";
+    readonly TASK_END_FAILED: "Task End Failed";
+    readonly TASK_WRAPUP_SUCCESS: "Task Wrapup Success";
+    readonly TASK_WRAPUP_FAILED: "Task Wrapup Failed";
+    readonly TASK_HOLD_SUCCESS: "Task Hold Success";
+    readonly TASK_HOLD_FAILED: "Task Hold Failed";
+    readonly TASK_RESUME_SUCCESS: "Task Resume Success";
+    readonly TASK_RESUME_FAILED: "Task Resume Failed";
+    readonly TASK_CONSULT_START_SUCCESS: "Task Consult Start Success";
+    readonly TASK_CONSULT_START_FAILED: "Task Consult Start Failed";
+    readonly TASK_CONSULT_END_SUCCESS: "Task Consult End Success";
+    readonly TASK_CONSULT_END_FAILED: "Task Consult End Failed";
+    readonly TASK_TRANSFER_SUCCESS: "Task Transfer Success";
+    readonly TASK_TRANSFER_FAILED: "Task Transfer Failed";
+    readonly TASK_RESUME_RECORDING_SUCCESS: "Task Resume Recording Success";
+    readonly TASK_RESUME_RECORDING_FAILED: "Task Resume Recording Failed";
+    readonly TASK_PAUSE_RECORDING_SUCCESS: "Task Pause Recording Success";
+    readonly TASK_PAUSE_RECORDING_FAILED: "Task Pause Recording Failed";
+    readonly TASK_ACCEPT_CONSULT_SUCCESS: "Task Accept Consult Success";
+    readonly TASK_ACCEPT_CONSULT_FAILED: "Task Accept Consult Failed";
+    readonly TASK_AUTO_ANSWER_SUCCESS: "Task Auto Answer Success";
+    readonly TASK_AUTO_ANSWER_FAILED: "Task Auto Answer Failed";
+    readonly TASK_CONFERENCE_START_SUCCESS: "Task Conference Start Success";
+    readonly TASK_CONFERENCE_START_FAILED: "Task Conference Start Failed";
+    readonly TASK_CONFERENCE_END_SUCCESS: "Task Conference End Success";
+    readonly TASK_CONFERENCE_END_FAILED: "Task Conference End Failed";
+    readonly TASK_CONFERENCE_TRANSFER_SUCCESS: "Task Conference Transfer Success";
+    readonly TASK_CONFERENCE_TRANSFER_FAILED: "Task Conference Transfer Failed";
+    readonly TASK_OUTDIAL_SUCCESS: "Task Outdial Success";
+    readonly TASK_OUTDIAL_FAILED: "Task Outdial Failed";
+    readonly UPLOAD_LOGS_SUCCESS: "Upload Logs Success";
+    readonly UPLOAD_LOGS_FAILED: "Upload Logs Failed";
+    readonly WEBSOCKET_DEREGISTER_SUCCESS: "Websocket Deregister Success";
+    readonly WEBSOCKET_DEREGISTER_FAIL: "Websocket Deregister Failed";
+    readonly WEBSOCKET_EVENT_RECEIVED: "Websocket Event Received";
+    readonly AGENT_DEVICE_TYPE_UPDATE_SUCCESS: "Agent Device Type Update Success";
+    readonly AGENT_DEVICE_TYPE_UPDATE_FAILED: "Agent Device Type Update Failed";
+    readonly ENTRYPOINT_FETCH_SUCCESS: "Entrypoint Fetch Success";
+    readonly ENTRYPOINT_FETCH_FAILED: "Entrypoint Fetch Failed";
+    readonly ADDRESSBOOK_FETCH_SUCCESS: "AddressBook Fetch Success";
+    readonly ADDRESSBOOK_FETCH_FAILED: "AddressBook Fetch Failed";
+    readonly QUEUE_FETCH_SUCCESS: "Queue Fetch Success";
+    readonly QUEUE_FETCH_FAILED: "Queue Fetch Failed";
+    readonly OUTDIAL_ANI_EP_FETCH_SUCCESS: "Outdial ANI Entries Fetch Success";
+    readonly OUTDIAL_ANI_EP_FETCH_FAILED: "Outdial ANI Entries Fetch Failed";
+    readonly CAMPAIGN_PREVIEW_ACCEPT_SUCCESS: "Campaign Preview Accept Success";
+    readonly CAMPAIGN_PREVIEW_ACCEPT_FAILED: "Campaign Preview Accept Failed";
+    readonly AI_ASSISTANT_SEND_EVENT_SUCCESS: "AI Assistant Send Event Success";
+    readonly AI_ASSISTANT_SEND_EVENT_FAILED: "AI Assistant Send Event Failed";
+    readonly AI_ASSISTANT_FETCH_HISTORIC_TRANSCRIPTS_SUCCESS: "AI Assistant Fetch Historic Transcripts Success";
+    readonly AI_ASSISTANT_FETCH_HISTORIC_TRANSCRIPTS_FAILED: "AI Assistant Fetch Historic Transcripts Failed";
+};
+/**
+ * Represents the possible metric event names used within the metrics system.
+ *
+ * This type is derived from the keys of the `METRIC_EVENT_NAMES` constant, ensuring
+ * type safety and consistency when referring to metric event names throughout the codebase.
+ * @export
+ * @typedef {Enum<typeof METRIC_EVENT_NAMES>} METRIC_EVENT_NAMES
+ * @typeParam T - The type of the `METRIC_EVENT_NAMES` constant.
+ *
+ * @see {@link METRIC_EVENT_NAMES}
+ */
+export type METRIC_EVENT_NAMES = Enum<typeof METRIC_EVENT_NAMES>;
+export {};

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/ApiAiAssistant.d.ts

@@ -0,0 +1,31 @@
+import { WebexSDK, TranscriptAction, AIAssistantEventType, AIAssistantEventName, HistoricTranscriptsResponse } from '../types';
+import { AIFeatureFlags } from './config/types';
+/**
+ * ApiAIAssistant provides AI Assistant APIs for transcript controls.
+ * @public
+ */
+export declare class ApiAIAssistant {
+    private webex;
+    private metricsManager;
+    aiFeature: AIFeatureFlags;
+    constructor(webex: WebexSDK);
+    setAIFeatureFlags(aiFeature: AIFeatureFlags): void;
+    private getBaseUrl;
+    /**
+     * Sends an event to the AI Assistant service.
+     * @param agentId - agent identifier
+     * @param interactionId - interaction/conversation identifier
+     * @param eventType - the type of event (e.g. 'CUSTOM_EVENT')
+     * @param eventName - the name of the event (e.g. 'GET_TRANSCRIPTS')
+     * @param action - action within eventDetails (e.g. 'START' or 'STOP')
+     */
+    sendEvent(agentId: string, interactionId: string, eventType: AIAssistantEventType, eventName: AIAssistantEventName, action: TranscriptAction): Promise<Record<string, unknown>>;
+    /**
+     * Fetches historic transcripts for an interaction.
+     * This API is allowed only when real-time transcription feature is enabled.
+     *
+     * @param interactionId - interaction/conversation identifier
+     */
+    fetchHistoricTranscripts(agentId: string, interactionId: string): Promise<HistoricTranscriptsResponse>;
+}
+export default ApiAIAssistant;

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/WebCallingService.d.ts

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,46 @@
+import * as Agent from './types';
+import AqmReqs from '../core/aqm-reqs';
+/**
+ * Agent Service provides methods to manage agent states and operations
+ * @param routing - AqmReqs instance for making API requests
+ * @ignore
+ */
+export default function routingAgent(routing: AqmReqs): {
+    /**
+     * Reloads the agent session
+     * @public
+     */
+    reload: import("../core/types").ResEmpty<Agent.ReloginSuccess>;
+    /**
+     * Logs out the agent
+     * @param p.data - Logout parameters
+     * @public
+     */
+    logout: import("../core/types").Res<Agent.LogoutSuccess, {
+        data: Agent.Logout;
+    }>;
+    /**
+     * Logs in the agent to a station
+     * @param p.data - Station login parameters
+     * @public
+     */
+    stationLogin: import("../core/types").Res<Agent.StationLoginSuccess, {
+        data: Agent.UserStationLogin;
+    }>;
+    /**
+     * Changes the agent's state
+     * @param p.data - State change parameters
+     * @public
+     */
+    stateChange: import("../core/types").Res<Agent.StateChangeSuccess, {
+        data: Agent.StateChange;
+    }>;
+    /**
+     * Retrieves list of buddy agents
+     * @param p.data - Buddy agent query parameters
+     * @public
+     */
+    buddyAgents: import("../core/types").Res<Agent.BuddyAgentsSuccess, {
+        data: Agent.BuddyAgents;
+    }>;
+};