@webex/contact-center 3.12.0-next.16 → 3.12.0-next.161

package/dist/types/types.d.ts

@@ -1,6 +1,6 @@
 import { CallingClientConfig } from '@webex/calling';
 import * as Agent from './services/agent/types';
-import { Profile } from './services/config/types';
+import { Entity, Profile } from './services/config/types';
 import { PaginatedResponse, BaseSearchParams } from './utils/PageCache';
 /**
  * HTTP methods supported by WebexRequest.
@@ -52,6 +52,8 @@ export type WebexRequestPayload = {
     uri?: string;
     /** Whether to add authorization header */
     addAuthHeader?: boolean;
+    /** Request timeout in milliseconds */
+    timeout?: number;
     /** Custom headers to include in request */
     headers?: {
         [key: string]: string | null;
@@ -106,6 +108,10 @@ export interface CCPluginConfig {
     };
     /** Configuration for the calling client */
     callingClientConfig: CallingClientConfig;
+    /** Whether to skip Mobius/WebRTC registration for browser login flows */
+    disableWebRTCRegistration?: boolean;
+    /** Whether wxApp Better Together (telephony REST + usersub) is enabled at init (WXCC-6026) */
+    enableWxBetterTogether?: boolean;
 }
 /**
  * Logger interface for standardized logging throughout the plugin.
@@ -249,6 +255,8 @@ export interface IContactCenter {
      * cc.register().then(profile => { ... });
      */
     register(): Promise<Profile>;
+    /** Returns the system-managed WellbeingBreak idle code for the registered session. */
+    getWellbeingBreakIdleCode(): Promise<Entity>;
 }
 /**
  * Generic HTTP response structure.
@@ -364,26 +372,29 @@ export type AgentLogin = {
 export type AgentProfileUpdate = Pick<AgentLogin, 'loginOption' | 'dialNumber' | 'teamId'>;
 /**
  * Represents the options to fetch buddy agents for the logged in agent.
- * Buddy agents are other agents who can be consulted or transfered to.
+ * Buddy agents are other agents who can be consulted or transferred to.
  * @public
  * @example
  * const opts: BuddyAgents = { mediaType: 'telephony', state: 'Available' };
- * @ignore
  */
 export type BuddyAgents = {
     /**
-     * The media type channel to filter buddy agents.
-     * Determines which channel capability the returned agents must have.
+     * The media type channel to filter buddy agents. Defaults to telephony when omitted.
      */
-    mediaType: 'telephony' | 'chat' | 'social' | 'email';
+    mediaType?: 'telephony' | 'chat' | 'social' | 'email';
     /**
      * Optional filter for agent state.
      * If specified, returns only agents in that state.
      * If omitted, returns both available and idle agents.
      */
     state?: 'Available' | 'Idle';
+    /**
+     * Applies the default state policy for the operation. An explicit state takes precedence.
+     */
+    action?: 'Consult' | 'Transfer';
 };
 /**
+
  * Generic error structure for Contact Center SDK errors.
  * Contains detailed information about the error context.
  * @public
@@ -461,10 +472,12 @@ export interface AddressBookEntrySearchParams extends BaseSearchParams {
 export interface EntryPointRecord {
     id: string;
     name: string;
+    /** Dialled number mapped to this entry point when included in the list response. */
+    number?: string;
     description?: string;
-    type: string;
-    isActive: boolean;
-    orgId: string;
+    type?: string;
+    isActive?: boolean;
+    orgId?: string;
     createdAt?: string;
     updatedAt?: string;
     settings?: Record<string, any>;
@@ -612,32 +625,221 @@ export type BuddyAgentsResponse = Agent.BuddyAgentsSuccess | Error;
  * function handleUpdateDeviceType(resp: UpdateDeviceTypeResponse) { ... }
  */
 export type UpdateDeviceTypeResponse = Agent.DeviceTypeUpdateSuccess | Error;
+/**
+ * Supported transcript control actions for AI Assistant events.
+ * @public
+ * @example
+ * const action: TranscriptAction = 'START';
+ * @ignore
+ */
 export type TranscriptAction = 'START' | 'STOP';
+/**
+ * Parameters used to request AI Assistant real-time assistance.
+ * @public
+ * @example
+ * const params: RealTimeAssistanceParams = {
+ *   interactionId: 'interaction-123',
+ *   context: 'Need help with credit card payment due date',
+ * };
+ */
+export type RealTimeAssistanceParams = {
+    /** Agent identifier */
+    agentId: string;
+    /** Interaction identifier for which assistance should be generated */
+    interactionId: string;
+    /** Optional additional context that should refine the assistance */
+    context?: string;
+    /** Optional language code for assistance (for example, 'en'). Defaults to 'en'. */
+    languageCode?: string;
+};
+/**
+ * Supported user actions on an AI Assistant real-time assistance adaptive card.
+ * @public
+ */
+export declare const RealTimeAssistanceUserActionId: {
+    /** User liked the real-time assistance response */
+    readonly LIKE: "likeButton";
+    /** User disliked the real-time assistance response */
+    readonly DISLIKE: "dislikeButton";
+    /** User copied the real-time assistance response */
+    readonly COPY: "copyButton";
+};
+/**
+ * Union type of supported real-time assistance user actions.
+ * @public
+ */
+export type RealTimeAssistanceUserActionId = Enum<typeof RealTimeAssistanceUserActionId>;
+/**
+ * Parameters used to send user action feedback for a real-time assistance adaptive card.
+ * @public
+ * @example
+ * const params: RealTimeAssistanceUserActionParams = {
+ *   agentId: 'agent-123',
+ *   interactionId: 'interaction-123',
+ *   adaptiveCardId: 'adaptive-card-123',
+ *   actionId: RealTimeAssistanceUserActionId.LIKE,
+ * };
+ */
+export type RealTimeAssistanceUserActionParams = {
+    /** Agent identifier */
+    agentId: string;
+    /** Interaction identifier associated with the real-time assistance response */
+    interactionId: string;
+    /** Adaptive card identifier from the real-time assistance payload */
+    adaptiveCardId: string;
+    /** User action performed on the adaptive card */
+    actionId: RealTimeAssistanceUserActionId;
+    /** Optional language code. Defaults to 'en'. */
+    languageCode?: string;
+};
+/**
+ * Wellness notification actions delivered by the Contact Center notification service.
+ * @public
+ */
+export declare const WELLNESS_BREAK_NOTIFICATION_ACTIONS: {
+    readonly PROVIDE_WELLNESS_BREAK: "PROVIDE_WELLNESS_BREAK";
+    readonly SUGGEST_WELLNESS_BREAK: "SUGGEST_WELLNESS_BREAK";
+    readonly WELLNESS_BREAK_NOT_ALLOWED: "WELLNESS_BREAK_NOT_ALLOWED";
+};
+/** Union of supported wellness notification actions. @public */
+export type WellnessBreakNotificationAction = Enum<typeof WELLNESS_BREAK_NOTIFICATION_ACTIONS>;
+/**
+ * Agent actions accepted by the wellness action API.
+ * @public
+ */
+export declare const WELLNESS_BREAK_USER_ACTIONS: {
+    readonly REQUESTED: "REQUESTED";
+    readonly ACCEPTED: "ACCEPTED";
+    readonly REJECTED: "REJECTED";
+    readonly NO_RESPONSE: "NO_RESPONSE";
+};
+/** Union of supported wellness action API values. @public */
+export type WellnessBreakUserAction = Enum<typeof WELLNESS_BREAK_USER_ACTIONS>;
+/**
+ * Validated, agent-scoped wellness notification emitted by Contact Center.
+ * @public
+ */
+export interface WellnessBreakEvent {
+    /** Agent identifier */
+    agentId: string;
+    /** Organization identifier */
+    orgId: string;
+    /** Session identifier supplied by the notification; it may differ from the consumer's active session */
+    agentSessionId: string;
+    /** Backend wellness action */
+    actionEvent: WellnessBreakNotificationAction;
+    /** Optional untrusted plain-text message supplied by the backend */
+    actionText?: string;
+    /** Optional normalized interaction diagnostic */
+    interactionId?: string;
+    /** Notification diagnostic only; never an action-request correlation identifier */
+    trackingId?: string;
+}
+/**
+ * Parameters for responding to a backend-provided wellness offer.
+ * @public
+ */
+export interface RespondToWellnessBreakParams {
+    /** Agent response; REQUESTED is available only through requestWellnessBreak */
+    action: Exclude<WellnessBreakUserAction, typeof WELLNESS_BREAK_USER_ACTIONS.REQUESTED>;
+}
+/**
+ * Supported AI Assistant event categories.
+ * @public
+ * @example
+ * const eventType: AIAssistantEventType = AIAssistantEventType.CUSTOM_EVENT;
+ * @ignore
+ */
 export declare const AIAssistantEventType: {
+    /** Custom AI Assistant event */
     readonly CUSTOM_EVENT: "CUSTOM_EVENT";
+    /** CTI-backed AI Assistant event */
     readonly CTI_EVENT: "CTI_EVENT";
 };
+/**
+ * Union type of AI Assistant event categories.
+ * @public
+ * @example
+ * function send(type: AIAssistantEventType) { ... }
+ * @ignore
+ */
 export type AIAssistantEventType = Enum<typeof AIAssistantEventType>;
+/**
+ * Supported AI Assistant event names.
+ * @public
+ * @example
+ * const name: AIAssistantEventName = AIAssistantEventName.GET_TRANSCRIPTS;
+ * @ignore
+ */
 export declare const AIAssistantEventName: {
+    /** Request transcript streaming for an interaction */
     readonly GET_TRANSCRIPTS: "GET_TRANSCRIPTS";
-    readonly GET_MID_CALL_SUMMARY: "GET_MID_CALL_SUMMARY";
+    /** Request a suggested response for an interaction */
+    readonly GET_SUGGESTIONS: "GET_SUGGESTIONS";
+    /** Add extra context to refine a suggested response */
+    readonly ADD_SUGGESTIONS_EXTRA_CONTEXT: "ADD_SUGGESTIONS_EXTRA_CONTEXT";
+    /** Request post-call summary generation */
     readonly GET_POST_CALL_SUMMARY: "GET_POST_CALL_SUMMARY";
-    readonly MID_CALL_SUMMARY_RESPONSE: "MID_CALL_SUMMARY_RESPONSE";
+    /** Request consult mid-call summary generation */
+    readonly GET_MID_CALL_CONSULT_SUMMARY: "GET_MID_CALL_CONSULT_SUMMARY";
+    /** Request transfer mid-call summary generation */
+    readonly GET_MID_CALL_TRANSFER_SUMMARY: "GET_MID_CALL_TRANSFER_SUMMARY";
+    /** Post-call summary response event */
     readonly POST_CALL_SUMMARY_RESPONSE: "POST_CALL_SUMMARY_RESPONSE";
+    /** Consult mid-call summary response event */
+    readonly MID_CALL_CONSULT_SUMMARY_RESPONSE: "MID_CALL_CONSULT_SUMMARY_RESPONSE";
+    /** Transfer mid-call summary response event */
+    readonly MID_CALL_TRANSFER_SUMMARY_RESPONSE: "MID_CALL_TRANSFER_SUMMARY_RESPONSE";
+    /** Suggested digital response event */
     readonly SUGGESTED_RESPONSES_DIGITAL: "SUGGESTED_RESPONSES_DIGITAL";
+    /** User action on a suggested response adaptive card */
+    readonly SUGGESTED_RESPONSES_USER_ACTION: "SUGGESTED_RESPONSES_USER_ACTION";
+    /** Agent Wellness Break request/response action */
+    readonly WELLNESS_BREAK_ACTION: "WellnessBreakAction";
 };
+/**
+ * Union type of AI Assistant event names.
+ * @public
+ * @example
+ * function handle(name: AIAssistantEventName) { ... }
+ * @ignore
+ */
 export type AIAssistantEventName = Enum<typeof AIAssistantEventName>;
+/**
+ * A single transcript message entry returned by AI Assistant APIs.
+ * @public
+ * @example
+ * const message: TranscriptMessage = { role: 'AGENT', content: 'Hello', messageId: '1', publishTimestamp: Date.now() };
+ *
+ */
 export type TranscriptMessage = {
+    /** Speaker role for this message */
     role: string;
+    /** Transcript chunk content */
     content: string;
+    /** Unique message identifier */
     messageId: string;
+    /** Message publish timestamp (epoch milliseconds) */
     publishTimestamp: number;
 };
+/**
+ * Response payload for historic transcripts API.
+ * @public
+ * @example
+ * const resp: HistoricTranscriptsResponse = { orgId: 'org', agentId: 'agent', conversationId: null, interactionId: 'int', source: 'AI', data: [] };
+ *
+ */
 export type HistoricTranscriptsResponse = {
+    /** Organization identifier */
     orgId: string;
+    /** Agent identifier */
     agentId: string;
+    /** Conversation identifier when available */
     conversationId: string | null;
+    /** Interaction identifier */
     interactionId: string;
+    /** Data source identifier */
     source: string;
+    /** Transcript messages */
     data: TranscriptMessage[];
 };

package/dist/types/utils/PageCache.d.ts

@@ -90,6 +90,12 @@ export interface CacheValidationParams {
     attributes?: string;
     /** Sort by parameter */
     sortBy?: string;
+    /** Desktop-profile filtering changes the returned result set */
+    desktopProfileFilter?: boolean;
+    /** Provisioning-view filtering changes the returned result set */
+    provisioningView?: boolean;
+    /** Single-object response mode changes the response shape */
+    singleObjectResponse?: boolean;
 }
 /**
  * Page cache utility class for managing paginated API response caching.
@@ -103,8 +109,18 @@ export interface CacheValidationParams {
  * // Create a cache instance for a specific data type
  * const cache = new PageCache<AddressBookEntry>('AddressBook');
  *
- * // Check if we can use cache (no search/filter parameters)
- * if (cache.canUseCache({ search, filter })) {
+ * // Check if we can use cache for the complete result/response-shape input set
+ * if (
+ *   cache.canUseCache({
+ *     search,
+ *     filter,
+ *     attributes,
+ *     sortBy,
+ *     desktopProfileFilter,
+ *     provisioningView,
+ *     singleObjectResponse,
+ *   })
+ * ) {
  *   const cacheKey = cache.buildCacheKey(orgId, page, pageSize);
  *   const cachedPage = cache.getCachedPage(cacheKey);
  *
@@ -128,7 +144,8 @@ export declare class PageCache<T> {
     constructor(apiName: string);
     /**
      * Checks if cache can be used for the given parameters.
-     * Cache is only used for simple pagination without search/filter/attributes/sort.
+     * Cache is only used for simple pagination without query variants or enabled
+     * result/response-shape flags.
      * @param {CacheValidationParams} params - Parameters to validate
      * @returns {boolean} True if cache can be used
      * @public

package/dist/types/webex.d.ts

@@ -1,3 +1,4 @@
+export * from "./index";
 export default Webex;
 /**
  * Webex SDK class extended from the core SDK.

package/dist/types.js

@@ -3,7 +3,7 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.LoginOption = exports.LOGGING_LEVEL = exports.HTTP_METHODS = exports.AIAssistantEventType = exports.AIAssistantEventName = void 0;
+exports.WELLNESS_BREAK_USER_ACTIONS = exports.WELLNESS_BREAK_NOTIFICATION_ACTIONS = exports.RealTimeAssistanceUserActionId = exports.LoginOption = exports.LOGGING_LEVEL = exports.HTTP_METHODS = exports.AIAssistantEventType = exports.AIAssistantEventName = void 0;
 /**
  * Generic type for converting a const enum object into a union type of its values.
  * @template T The enum object type
@@ -58,6 +58,12 @@ const HTTP_METHODS = exports.HTTP_METHODS = {
  * @ignore
  */
 
+/**
+ * Mercury event handler callback.
+ * @internal
+ * @ignore
+ */
+
 /**
  * Event listener removal function type.
  * @internal
@@ -228,14 +234,20 @@ const LoginOption = exports.LoginOption = {
 
 /**
  * Represents the options to fetch buddy agents for the logged in agent.
- * Buddy agents are other agents who can be consulted or transfered to.
+ * Buddy agents are other agents who can be consulted or transferred to.
  * @public
  * @example
  * const opts: BuddyAgents = { mediaType: 'telephony', state: 'Available' };
- * @ignore
  */
 
 /**
+ * Holds the configuration flags for the Agent.
+ * These flags determine the availability of certain features in the Agent UI.
+ * @internal
+ */
+
+/**
+
  * Generic error structure for Contact Center SDK errors.
  * Contains detailed information about the error context.
  * @public
@@ -312,16 +324,166 @@ const LoginOption = exports.LoginOption = {
  * function handleUpdateDeviceType(resp: UpdateDeviceTypeResponse) { ... }
  */
 
+/**
+ * Supported transcript control actions for AI Assistant events.
+ * @public
+ * @example
+ * const action: TranscriptAction = 'START';
+ * @ignore
+ */
+
+/**
+ * Parameters used to request AI Assistant real-time assistance.
+ * @public
+ * @example
+ * const params: RealTimeAssistanceParams = {
+ *   interactionId: 'interaction-123',
+ *   context: 'Need help with credit card payment due date',
+ * };
+ */
+
+/**
+ * Supported user actions on an AI Assistant real-time assistance adaptive card.
+ * @public
+ */
+const RealTimeAssistanceUserActionId = exports.RealTimeAssistanceUserActionId = {
+  /** User liked the real-time assistance response */
+  LIKE: 'likeButton',
+  /** User disliked the real-time assistance response */
+  DISLIKE: 'dislikeButton',
+  /** User copied the real-time assistance response */
+  COPY: 'copyButton'
+};
+
+/**
+ * Union type of supported real-time assistance user actions.
+ * @public
+ */
+
+/**
+ * Parameters used to send user action feedback for a real-time assistance adaptive card.
+ * @public
+ * @example
+ * const params: RealTimeAssistanceUserActionParams = {
+ *   agentId: 'agent-123',
+ *   interactionId: 'interaction-123',
+ *   adaptiveCardId: 'adaptive-card-123',
+ *   actionId: RealTimeAssistanceUserActionId.LIKE,
+ * };
+ */
+
+/**
+ * Wellness notification actions delivered by the Contact Center notification service.
+ * @public
+ */
+const WELLNESS_BREAK_NOTIFICATION_ACTIONS = exports.WELLNESS_BREAK_NOTIFICATION_ACTIONS = {
+  PROVIDE_WELLNESS_BREAK: 'PROVIDE_WELLNESS_BREAK',
+  SUGGEST_WELLNESS_BREAK: 'SUGGEST_WELLNESS_BREAK',
+  WELLNESS_BREAK_NOT_ALLOWED: 'WELLNESS_BREAK_NOT_ALLOWED'
+};
+
+/** Union of supported wellness notification actions. @public */
+
+/**
+ * Agent actions accepted by the wellness action API.
+ * @public
+ */
+const WELLNESS_BREAK_USER_ACTIONS = exports.WELLNESS_BREAK_USER_ACTIONS = {
+  REQUESTED: 'REQUESTED',
+  ACCEPTED: 'ACCEPTED',
+  REJECTED: 'REJECTED',
+  NO_RESPONSE: 'NO_RESPONSE'
+};
+
+/** Union of supported wellness action API values. @public */
+
+/**
+ * Validated, agent-scoped wellness notification emitted by Contact Center.
+ * @public
+ */
+
+/**
+ * Parameters for responding to a backend-provided wellness offer.
+ * @public
+ */
+
+/**
+ * Supported AI Assistant event categories.
+ * @public
+ * @example
+ * const eventType: AIAssistantEventType = AIAssistantEventType.CUSTOM_EVENT;
+ * @ignore
+ */
 const AIAssistantEventType = exports.AIAssistantEventType = {
+  /** Custom AI Assistant event */
   CUSTOM_EVENT: 'CUSTOM_EVENT',
+  /** CTI-backed AI Assistant event */
   CTI_EVENT: 'CTI_EVENT'
 };
+
+/**
+ * Union type of AI Assistant event categories.
+ * @public
+ * @example
+ * function send(type: AIAssistantEventType) { ... }
+ * @ignore
+ */
+
+/**
+ * Supported AI Assistant event names.
+ * @public
+ * @example
+ * const name: AIAssistantEventName = AIAssistantEventName.GET_TRANSCRIPTS;
+ * @ignore
+ */
 const AIAssistantEventName = exports.AIAssistantEventName = {
+  /** Request transcript streaming for an interaction */
   GET_TRANSCRIPTS: 'GET_TRANSCRIPTS',
-  GET_MID_CALL_SUMMARY: 'GET_MID_CALL_SUMMARY',
+  /** Request a suggested response for an interaction */
+  GET_SUGGESTIONS: 'GET_SUGGESTIONS',
+  /** Add extra context to refine a suggested response */
+  ADD_SUGGESTIONS_EXTRA_CONTEXT: 'ADD_SUGGESTIONS_EXTRA_CONTEXT',
+  /** Request post-call summary generation */
   GET_POST_CALL_SUMMARY: 'GET_POST_CALL_SUMMARY',
-  MID_CALL_SUMMARY_RESPONSE: 'MID_CALL_SUMMARY_RESPONSE',
+  /** Request consult mid-call summary generation */
+  GET_MID_CALL_CONSULT_SUMMARY: 'GET_MID_CALL_CONSULT_SUMMARY',
+  /** Request transfer mid-call summary generation */
+  GET_MID_CALL_TRANSFER_SUMMARY: 'GET_MID_CALL_TRANSFER_SUMMARY',
+  /** Post-call summary response event */
   POST_CALL_SUMMARY_RESPONSE: 'POST_CALL_SUMMARY_RESPONSE',
-  SUGGESTED_RESPONSES_DIGITAL: 'SUGGESTED_RESPONSES_DIGITAL'
+  /** Consult mid-call summary response event */
+  MID_CALL_CONSULT_SUMMARY_RESPONSE: 'MID_CALL_CONSULT_SUMMARY_RESPONSE',
+  /** Transfer mid-call summary response event */
+  MID_CALL_TRANSFER_SUMMARY_RESPONSE: 'MID_CALL_TRANSFER_SUMMARY_RESPONSE',
+  /** Suggested digital response event */
+  SUGGESTED_RESPONSES_DIGITAL: 'SUGGESTED_RESPONSES_DIGITAL',
+  /** User action on a suggested response adaptive card */
+  SUGGESTED_RESPONSES_USER_ACTION: 'SUGGESTED_RESPONSES_USER_ACTION',
+  /** Agent Wellness Break request/response action */
+  WELLNESS_BREAK_ACTION: 'WellnessBreakAction'
 };
+
+/**
+ * Union type of AI Assistant event names.
+ * @public
+ * @example
+ * function handle(name: AIAssistantEventName) { ... }
+ * @ignore
+ */
+
+/**
+ * A single transcript message entry returned by AI Assistant APIs.
+ * @public
+ * @example
+ * const message: TranscriptMessage = { role: 'AGENT', content: 'Hello', messageId: '1', publishTimestamp: Date.now() };
+ *
+ */
+
+/**
+ * Response payload for historic transcripts API.
+ * @public
+ * @example
+ * const resp: HistoricTranscriptsResponse = { orgId: 'org', agentId: 'agent', conversationId: null, interactionId: 'int', source: 'AI', data: [] };
+ *
+ */
 //# sourceMappingURL=types.js.map