@webex/contact-center 3.11.0 → 3.12.0-auth-prejoin-fetch.1

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

@@ -0,0 +1,73 @@
+import AqmReqs from '../core/aqm-reqs';
+import * as Contact from './types';
+export default function routingContact(aqm: AqmReqs): {
+    accept: import("../core/types").Res<Contact.AgentContact, {
+        interactionId: string;
+    }>;
+    hold: import("../core/types").Res<Contact.AgentContact, {
+        interactionId: string;
+        data: Contact.HoldResumePayload;
+    }>;
+    unHold: import("../core/types").Res<Contact.AgentContact, {
+        interactionId: string;
+        data: Contact.HoldResumePayload;
+    }>;
+    pauseRecording: import("../core/types").Res<Contact.AgentContact, {
+        interactionId: string;
+    }>;
+    resumeRecording: import("../core/types").Res<Contact.AgentContact, {
+        interactionId: string;
+        data: Contact.ResumeRecordingPayload;
+    }>;
+    consult: import("../core/types").Res<Contact.AgentContact, {
+        interactionId: string;
+        data: Contact.ConsultPayload;
+    }>;
+    consultEnd: import("../core/types").Res<Contact.AgentContact, {
+        interactionId: string;
+        data: Contact.ConsultEndPayload;
+    }>;
+    consultAccept: import("../core/types").Res<Contact.AgentContact, {
+        interactionId: string;
+    }>;
+    blindTransfer: import("../core/types").Res<Contact.AgentContact, {
+        interactionId: string;
+        data: Contact.TransferPayLoad;
+    }>;
+    vteamTransfer: import("../core/types").Res<Contact.AgentContact, {
+        interactionId: string;
+        data: Contact.TransferPayLoad;
+    }>;
+    consultTransfer: import("../core/types").Res<Contact.AgentContact, {
+        interactionId: string;
+        data: Contact.ConsultTransferPayLoad;
+    }>;
+    end: import("../core/types").Res<Contact.AgentContact, {
+        interactionId: string;
+    }>;
+    wrapup: import("../core/types").Res<Contact.AgentContact, {
+        interactionId: string;
+        data: Contact.WrapupPayLoad;
+    }>;
+    cancelTask: import("../core/types").Res<Contact.AgentContact, {
+        interactionId: string;
+    }>;
+    cancelCtq: import("../core/types").Res<Contact.AgentContact, {
+        interactionId: string;
+        data: Contact.cancelCtq;
+    }>;
+    consultConference: import("../core/types").Res<Contact.AgentContact, {
+        interactionId: string;
+        data: Contact.ConsultConferenceData;
+    }>;
+    dropConferenceParticipant: import("../core/types").Res<Contact.AgentContact, {
+        interactionId: string;
+        participantId: string;
+    }>;
+    exitConference: import("../core/types").Res<Contact.AgentContact, {
+        interactionId: string;
+    }>;
+    conferenceTransfer: import("../core/types").Res<Contact.AgentContact, {
+        interactionId: string;
+    }>;
+};

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

@@ -0,0 +1,73 @@
+import * as Contact from './types';
+import AqmReqs from '../core/aqm-reqs';
+/**
+ * Returns an object with AQM dialer functions used for outbound contact handling.
+ *
+ * @param {AqmReqs} aqm - An instance of AQM request handler.
+ * @returns {{
+ *   startOutdial: (params: {data: Contact.DialerPayload}) => Promise<any>
+ * }} Object containing methods for outbound dialing.
+ * @ignore
+ */
+export default function aqmDialer(aqm: AqmReqs): {
+    /**
+     * Initiates an outbound contact (outdial) request.
+     *
+     * @param {Object} p - Parameters object.
+     * @param {Contact.DialerPayload} p.data - Payload for the outbound call.
+     * @returns {Promise<any>} A promise that resolves or rejects based on the outbound call response.
+     *
+     * Emits:
+     * - `CC_EVENTS.AGENT_OFFER_CONTACT` on success
+     * - `CC_EVENTS.AGENT_OUTBOUND_FAILED` on failure
+     * @ignore
+     */
+    startOutdial: import("../core/types").Res<Contact.AgentContact, {
+        data: Contact.DialerPayload;
+    }>;
+    /**
+     * Accepts a campaign preview contact, initiating the outbound call.
+     *
+     * @param {Object} p - Parameters object.
+     * @param {Contact.PreviewContactPayload} p.data - Payload containing interactionId and campaignId.
+     * @returns {Promise<Contact.AgentContact>} A promise that resolves with agent contact on success.
+     *
+     * Emits:
+     * - `CC_EVENTS.AGENT_CONTACT_ASSIGNED` on success
+     * - `CC_EVENTS.CAMPAIGN_PREVIEW_ACCEPT_FAILED` on failure
+     * @ignore
+     */
+    acceptPreviewContact: import("../core/types").Res<Contact.AgentContact, {
+        data: Contact.PreviewContactPayload;
+    }>;
+    /**
+     * Skips a campaign preview contact, requesting the next contact from the campaign.
+     *
+     * @param {Object} p - Parameters object.
+     * @param {Contact.PreviewContactPayload} p.data - Payload containing interactionId and campaignId.
+     * @returns {Promise<Contact.AgentContact>} A promise that resolves with agent contact on success.
+     *
+     * Emits:
+     * - `CC_EVENTS.CAMPAIGN_CONTACT_UPDATED` or `CC_EVENTS.CONTACT_ENDED` on success
+     * - `CC_EVENTS.CAMPAIGN_PREVIEW_SKIP_FAILED` on failure
+     * @ignore
+     */
+    skipPreviewContact: import("../core/types").Res<Contact.AgentContact, {
+        data: Contact.PreviewContactPayload;
+    }>;
+    /**
+     * Removes a campaign preview contact from the campaign list entirely.
+     *
+     * @param {Object} p - Parameters object.
+     * @param {Contact.PreviewContactPayload} p.data - Payload containing interactionId and campaignId.
+     * @returns {Promise<Contact.AgentContact>} A promise that resolves with agent contact on success.
+     *
+     * Emits:
+     * - `CC_EVENTS.CAMPAIGN_CONTACT_UPDATED` or `CC_EVENTS.CONTACT_ENDED` on success
+     * - `CC_EVENTS.CAMPAIGN_PREVIEW_REMOVE_FAILED` on failure
+     * @ignore
+     */
+    removePreviewContact: import("../core/types").Res<Contact.AgentContact, {
+        data: Contact.PreviewContactPayload;
+    }>;
+};

package/dist/types/services/task/digital/Digital.d.ts

@@ -0,0 +1,22 @@
+import { ConsultTransferDestinationConfig, IDigital, TaskResponse, TaskData } from '../types';
+import { WrapupData } from '../../config/types';
+import Task from '../Task';
+import routingContact from '../contact';
+export default class Digital extends Task implements IDigital {
+    constructor(contact: ReturnType<typeof routingContact>, data: TaskData, wrapupData?: WrapupData, agentId?: string, consultTransferConfig?: ConsultTransferDestinationConfig);
+    /**
+     * Refresh the digital task with the latest backend payload and recompute UI controls.
+     */
+    updateTaskData(newData: TaskData, shouldOverwrite?: boolean): IDigital;
+    /**
+     * This is used for incoming digital task accept by agent.
+     *
+     * @returns Promise<TaskResponse>
+     * @throws Error
+     * @example
+     * ```typescript
+     * task.accept().then(()=>{}).catch(()=>{})
+     * ```
+     */
+    accept(): Promise<TaskResponse>;
+}