@webex/contact-center 3.12.0-next.9 → 3.12.0-next.90

package/dist/types/services/task/voice/Voice.d.ts

@@ -0,0 +1,184 @@
+import routingContact from '../contact';
+import { ConsultPayload, ConsultEndPayload, ResumeRecordingPayload, TaskData, TaskResponse, IVoice, VoiceUIControlOptions, TransferPayLoad } from '../types';
+import Task from '../Task';
+import { TaskActionArgs } from '../state-machine';
+import { WrapupData } from '../../config/types';
+export default class Voice extends Task implements IVoice {
+    constructor(contact: ReturnType<typeof routingContact>, data: TaskData, callOptions?: VoiceUIControlOptions, wrapupData?: WrapupData, agentId?: string);
+    private getStateMachineSnapshot;
+    /**
+     * This method is used to accept the task.
+     * It is expected to be overridden by child classes.
+     * @returns Promise<TaskResponse>
+     * @throws Error
+     */
+    accept(): Promise<TaskResponse>;
+    /**
+     * This method is used to decline the task.
+     * It is expected to be overridden by child classes.
+     * @returns Promise<TaskResponse>
+     * @throws Error
+     */
+    decline(): Promise<TaskResponse>;
+    /**
+     * This is used to hold the task.
+     * @returns Promise<TaskResponse>
+     * @throws Error
+     * @example
+     * ```typescript
+     * task.hold().then(()=>{}).catch(()=>{})
+     * ```
+     * */
+    hold(): Promise<TaskResponse>;
+    /**
+     * This is used to resume the task.
+     * @returns Promise<TaskResponse>
+     * @throws Error
+     * @example
+     * ```typescript
+     * task.resume().then(()=>{}).catch(()=>{})
+     * ```
+     * */
+    resume(): Promise<TaskResponse>;
+    /**
+     * This is used to hold or resume the task.
+     * @param isHeld: boolean - true to hold the task, false to resume it
+     * @returns Promise<TaskResponse>
+     * @throws Error
+     * @example
+     * ```typescript
+     * task.holdResume(isHeld: true).then(()=>{}).catch(()=>{})
+     * ```
+     * */
+    holdResume(): Promise<TaskResponse>;
+    /**
+     * This is used to pause the call recording
+     * @returns Promise<TaskResponse>
+     * @throws Error
+     * @example
+     * ```typescript
+     * task.pauseRecording().then(()=>{}).catch(()=>{});
+     * ```
+     */
+    pauseRecording(): Promise<TaskResponse>;
+    /**
+     * This is used to pause the call recording
+     * @param resumeRecordingPayload
+     * @returns Promise<TaskResponse>
+     * @throws Error
+     * @example
+     * ```typescript
+     * task.resumeRecording(resumeRecordingPayload).then(()=>{}).catch(()=>{});
+     * ```
+     */
+    resumeRecording(resumeRecordingPayload?: ResumeRecordingPayload): Promise<TaskResponse>;
+    /**
+     * This is used to consult the task
+     * @param consultPayload
+     * @returns Promise<TaskResponse>
+     * @throws Error
+     * @example
+     * ```typescript
+     * const consultPayload = {
+     *   destination: 'myBuddyAgentId',
+     *   destinationType: DESTINATION_TYPE.AGENT,
+     * }
+     * task.consult(consultPayload).then(()=>{}).catch(()=>{});
+     * ```
+     * */
+    consult(consultPayload?: ConsultPayload): Promise<TaskResponse>;
+    /**
+     * This is used to end the consult session on the task.
+     * @param consultEndPayload - Payload indicating consult end flags and identifiers
+     * @returns Promise<TaskResponse>
+     * @throws Error
+     * @example
+     * ```typescript
+     * task.endConsult({
+     *   isConsult: true,
+     *   queueId: 'myQueueId',
+     *   taskId: 'taskId',
+     * });
+     * ```
+     */
+    endConsult(consultEndPayload?: ConsultEndPayload): Promise<TaskResponse>;
+    /**
+     * This is used to transfer the task.
+     * @param payload - Transfer payload
+     * @returns Promise<TaskResponse>
+     * @throws Error
+     * @example
+     * ```typescript
+     * task.transfer({
+     *   to: 'destinationId',
+     *   destinationType: DESTINATION_TYPE.AGENT,
+     *   consult: true, // Optional, if true will perform a consult transfer else blind transfer
+     * });
+     * ```
+     */
+    transfer(payload: TransferPayLoad): Promise<TaskResponse>;
+    /**
+     * Start a consult conference, merging main and consult calls.
+     */
+    consultConference(): Promise<TaskResponse>;
+    /**
+     * Exit from a conference call.
+     * Per conference-spec.md:
+     * - Primary agent exits to wrapup
+     * - Non-primary agent exits to available/connected
+     * - Other participants continue the call
+     *
+     * @returns Promise<TaskResponse>
+     * @throws Error if not in conference or exit fails
+     * @example
+     * ```typescript
+     * task.exitConference().then(() => {}).catch(() => {});
+     * ```
+     */
+    exitConference(): Promise<TaskResponse>;
+    /**
+     * Transfer the conference to another participant.
+     * Per conference-spec.md: Only primary agent can transfer conference.
+     * After transfer, the transferring agent exits to wrapup.
+     *
+     * @returns Promise<TaskResponse>
+     * @throws Error if not in conference or transfer fails
+     * @example
+     * ```typescript
+     * task.transferConference().then(() => {}).catch(() => {});
+     * ```
+     */
+    transferConference(): Promise<TaskResponse>;
+    /**
+     * Toggle between consult call and main call during consulting.
+     * If on consult leg (consultCallHeld = false), switches to main call by holding consult.
+     * If on main call (consultCallHeld = true), switches to consult by resuming consult.
+     *
+     * @returns Promise<TaskResponse>
+     * @throws Error if not in CONSULTING state or no consult media resource
+     * @example
+     * ```typescript
+     * await task.switchCall();
+     * ```
+     */
+    switchCall(): Promise<TaskResponse>;
+    protected getChannelSpecificActionOverrides(): {
+        emitTaskHold: ({ event }: TaskActionArgs) => void;
+        emitTaskResume: ({ event }: TaskActionArgs) => void;
+        emitTaskRecordingStarted: ({ event }: TaskActionArgs) => void;
+        emitTaskRecordingPaused: ({ event }: TaskActionArgs) => void;
+        emitTaskRecordingPauseFailed: ({ event }: TaskActionArgs) => void;
+        emitTaskRecordingResumed: ({ event }: TaskActionArgs) => void;
+        emitTaskRecordingResumeFailed: ({ event }: TaskActionArgs) => void;
+        emitTaskParticipantJoined: ({ event }: TaskActionArgs) => void;
+        emitTaskParticipantLeft: ({ event }: TaskActionArgs) => void;
+        emitTaskConferenceStarted: ({ event }: TaskActionArgs) => void;
+        emitTaskConferenceEnded: ({ event }: TaskActionArgs) => void;
+        emitTaskConferenceFailed: ({ event }: TaskActionArgs) => void;
+        emitTaskExitConference: ({ event }: TaskActionArgs) => void;
+        emitTaskTransferConference: ({ event }: TaskActionArgs) => void;
+        emitTaskSwitchCall: ({ event }: TaskActionArgs) => void;
+        emitTaskTransferConferenceFailed: ({ event }: TaskActionArgs) => void;
+        emitTaskOutdialFailed: ({ event }: TaskActionArgs) => void;
+    };
+}

package/dist/types/services/task/voice/WebRTC.d.ts

@@ -0,0 +1,53 @@
+import routingContact from '../contact';
+import { TaskData, TaskResponse, IWebRTC, VoiceUIControlOptions } from '../types';
+import Voice from './Voice';
+import WebCallingService from '../../WebCallingService';
+import { WrapupData } from '../../config/types';
+export default class WebRTC extends Voice implements IWebRTC {
+    private localAudioStream;
+    private webCallingService;
+    constructor(contact: ReturnType<typeof routingContact>, webCallingService: WebCallingService, data: TaskData, callOptions?: VoiceUIControlOptions, wrapupData?: WrapupData, agentId?: string);
+    private registerWebCallListeners;
+    private handleRemoteMedia;
+    /**
+     * This method is used to unregister the web call listeners.
+     * @returns void
+     * @example
+     * ```typescript
+     * task.unregisterWebCallListeners();
+     * ```
+     */
+    unregisterWebCallListeners(): void;
+    /**
+     * This is used for incoming task accept by agent.
+     *
+     * @returns Promise<TaskResponse>
+     * @throws Error
+     * @example
+     * ```typescript
+     * task.accept().then(()=>{}).catch(()=>{})
+     * ```
+     */
+    accept(): Promise<TaskResponse>;
+    /**
+     * This is used for the incoming task decline by agent.
+     *
+     * @returns Promise<TaskResponse>
+     * @throws Error
+     * @example
+     * ```typescript
+     * task.decline().then(()=>{}).catch(()=>{})
+     * ```
+     */
+    decline(): Promise<TaskResponse>;
+    /**
+     * This is used for the placing the call in mute or unmute by the agent.
+     *
+     * @throws Error
+     * @example
+     * ```typescript
+     * task.toggleMute().then(()=>{}).catch(()=>{})
+     * ```
+     */
+    toggleMute(): Promise<void>;
+}

package/dist/types/types.d.ts

@@ -106,6 +106,8 @@ export interface CCPluginConfig {
     };
     /** Configuration for the calling client */
     callingClientConfig: CallingClientConfig;
+    /** Whether to skip Mobius/WebRTC registration for browser login flows */
+    disableWebRTCRegistration?: boolean;
 }
 /**
  * Logger interface for standardized logging throughout the plugin.
@@ -384,6 +386,7 @@ export type BuddyAgents = {
     state?: 'Available' | 'Idle';
 };
 /**
+
  * Generic error structure for Contact Center SDK errors.
  * Contains detailed information about the error context.
  * @public
@@ -612,32 +615,164 @@ 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;
+};
+/**
+ * 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";
+    /** 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 mid-call summary generation */
     readonly GET_MID_CALL_SUMMARY: "GET_MID_CALL_SUMMARY";
+    /** Request post-call summary generation */
     readonly GET_POST_CALL_SUMMARY: "GET_POST_CALL_SUMMARY";
+    /** Mid-call summary response event */
     readonly MID_CALL_SUMMARY_RESPONSE: "MID_CALL_SUMMARY_RESPONSE";
+    /** Post-call summary response event */
     readonly POST_CALL_SUMMARY_RESPONSE: "POST_CALL_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";
 };
+/**
+ * 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/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.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
@@ -236,6 +236,13 @@ const LoginOption = exports.LoginOption = {
  */
 
 /**
+ * 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 +319,125 @@ 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,
+ * };
+ */
+
+/**
+ * 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',
+  /** 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 mid-call summary generation */
   GET_MID_CALL_SUMMARY: 'GET_MID_CALL_SUMMARY',
+  /** Request post-call summary generation */
   GET_POST_CALL_SUMMARY: 'GET_POST_CALL_SUMMARY',
+  /** Mid-call summary response event */
   MID_CALL_SUMMARY_RESPONSE: 'MID_CALL_SUMMARY_RESPONSE',
+  /** Post-call summary response event */
   POST_CALL_SUMMARY_RESPONSE: 'POST_CALL_SUMMARY_RESPONSE',
-  SUGGESTED_RESPONSES_DIGITAL: 'SUGGESTED_RESPONSES_DIGITAL'
+  /** 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'
 };
+
+/**
+ * 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