@webex/contact-center 3.12.0-next.13 → 3.12.0-next.130

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

@@ -27,7 +27,7 @@ import type { EntryPointListResponse, EntryPointSearchParams } from '../types';
  * });
  *
  * // Search for specific entry points
- * const searchResults = await entryPointAPI.searchEntryPoints({
+ * const searchResults = await entryPointAPI.getEntryPoints({
  *   search: 'support',
  *   filter: 'type=="voice"'
  * });
@@ -37,7 +37,6 @@ export declare class EntryPoint {
     private webexRequest;
     private webex;
     private metricsManager;
-    private pageCache;
     /**
      * Creates an instance of EntryPoint
      * @param {WebexSDK} webex - The Webex SDK instance
@@ -45,14 +44,17 @@ export declare class EntryPoint {
      */
     constructor(webex: WebexSDK);
     /**
-     * Fetches entry points for the organization with pagination support
-     * @param {EntryPointSearchParams} [params] - Search and pagination parameters
+     * Fetches entry-point dial-number mappings for the organization with pagination support. By
+     * default, returns the agent's desktop-profile-filtered mappings in backend entry-point-name order.
+     * Search, filter, attribute, and sort parameters can customize the request while desktop-profile
+     * scoping and required mapping fields remain SDK-owned.
+     * @param {EntryPointSearchParams} [params] - Search, pagination, and compatible override 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
+     * // Get the first page using the default entry-point policy
      * const response = await entryPointAPI.getEntryPoints();
      *
      * // Get specific page with custom page size

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

@@ -48,14 +48,16 @@ export declare class Queue {
      */
     constructor(webex: WebexSDK);
     /**
-     * Fetches contact service queues for the organization
-     * @param {ContactServiceQueueSearchParams} [params] - Search and pagination parameters
+     * Fetches contact service queues for the organization. By default, returns active inbound
+     * telephony queues in backend name-ascending order using the agent's desktop profile views.
+     * Existing filter, sort, and desktop-profile parameters override those defaults.
+     * @param {ContactServiceQueueSearchParams} [params] - Search, pagination, and override 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
+     * // Get queues using the default list policy and pagination
      * const response = await queueAPI.getQueues();
      *
      * // Get queues with specific pagination

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

@@ -0,0 +1,118 @@
+import { WebexSDK } from '../types';
+import type { UserPreference as UserPreferenceResponse, CreateUserPreferenceRequest, UpdateUserPreferenceRequest, GetUserPreferenceParams } from './config/types';
+/**
+ * UserPreference API class for managing Webex Contact Center user preferences.
+ * Provides functionality to get, create, update, and delete user preferences.
+ *
+ * @class UserPreference
+ * @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 UserPreference API instance from ContactCenter
+ * const userPreferenceAPI = cc.userPreference;
+ *
+ * // Get user preferences for the current user
+ * const preferences = await userPreferenceAPI.getUserPreference();
+ *
+ * // Create new user preferences
+ * const newPreferences = await userPreferenceAPI.createUserPreference({
+ *   userId: 'user123',
+ *   preferences: { e911Reminder: true }
+ * });
+ *
+ * // Update user preferences
+ * const updatedPreferences = await userPreferenceAPI.updateUserPreference('user123', {
+ *   preferences: { e911Reminder: false }
+ * });
+ *
+ * // Delete user preferences
+ * await userPreferenceAPI.deleteUserPreference('user123');
+ * ```
+ */
+export declare class UserPreference {
+    private webexRequest;
+    private webex;
+    private getUserId;
+    private metricsManager;
+    /**
+     * Creates an instance of UserPreference
+     * @param {WebexSDK} webex - The Webex SDK instance
+     * @param {() => string} getUserId - Function to get the current user's CI user ID
+     * @public
+     */
+    constructor(webex: WebexSDK, getUserId: () => string);
+    /**
+     * Fetches user preferences for a specific user
+     * @param {GetUserPreferenceParams} [params] - Optional parameters for fetching preferences
+     * @param {string} [params.userId] - User ID to fetch preferences for. Defaults to current user's CI user ID.
+     * @param {number} [params.page=0] - Page number (0-indexed). Default: 0
+     * @param {number} [params.pageSize=100] - Number of items per page. Default: 100
+     * @returns {Promise<UserPreferenceResponse>} Promise resolving to user preferences
+     * @throws {Error} If the API call fails
+     * @public
+     * @example
+     * ```typescript
+     * // Get preferences for current user
+     * const preferences = await userPreferenceAPI.getUserPreference();
+     *
+     * // Get preferences for a specific user
+     * const preferences = await userPreferenceAPI.getUserPreference({ userId: 'user123' });
+     *
+     * // Get preferences with pagination
+     * const preferences = await userPreferenceAPI.getUserPreference({ page: 0, pageSize: 50 });
+     * ```
+     */
+    getUserPreference(params?: GetUserPreferenceParams): Promise<UserPreferenceResponse>;
+    /**
+     * Creates new user preferences
+     * @param {CreateUserPreferenceRequest} data - The user preference data to create
+     * @returns {Promise<UserPreference>} Promise resolving to created user preferences
+     * @throws {Error} If the API call fails
+     * @public
+     * @example
+     * ```typescript
+     * const newPreferences = await userPreferenceAPI.createUserPreference({
+     *   userId: 'user123',
+     *   preferences: { e911Reminder: true, notificationSettings: { email: true } }
+     * });
+     * ```
+     */
+    createUserPreference(data: CreateUserPreferenceRequest): Promise<UserPreferenceResponse>;
+    /**
+     * Updates existing user preferences
+     * @param {string} userId - User ID to update preferences for
+     * @param {UpdateUserPreferenceRequest} data - The user preference data to update
+     * @returns {Promise<UserPreference>} Promise resolving to updated user preferences
+     * @throws {Error} If the API call fails
+     * @public
+     * @example
+     * ```typescript
+     * const updatedPreferences = await userPreferenceAPI.updateUserPreference('user123', {
+     *   preferences: { e911Reminder: false }
+     * });
+     * ```
+     */
+    updateUserPreference(userId: string, data: UpdateUserPreferenceRequest): Promise<UserPreferenceResponse>;
+    /**
+     * Deletes user preferences for a specific user
+     * @param {string} userId - User ID to delete preferences for
+     * @returns {Promise<void>} Promise resolving when deletion is complete
+     * @throws {Error} If the API call fails
+     * @public
+     * @example
+     * ```typescript
+     * await userPreferenceAPI.deleteUserPreference('user123');
+     * ```
+     */
+    deleteUserPreference(userId: string): Promise<void>;
+}
+export default UserPreference;

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

@@ -0,0 +1,32 @@
+import { WebexSDK } from '../types';
+/**
+ * Publishes usersub cross-client state so Webex App suppresses native calling toasts (WXCC-6026).
+ */
+export default class WebexCrossClientService {
+    private webex;
+    private refreshTimer?;
+    private refreshRetryTimer?;
+    private answerCallsState;
+    private appName;
+    /** Incremented on teardown/disable to ignore stale refresh timer callbacks. */
+    private refreshGeneration;
+    /** Monotonic id for usersub publish metrics timers; stale publishes cancel only their own timer. */
+    private usersubPublishMetricsId;
+    constructor(webex: WebexSDK);
+    private extractDeviceIdFromUrl;
+    private getDeviceUrl;
+    private clearRefreshTimer;
+    private scheduleRefreshRetry;
+    private startRefreshTimer;
+    private publishCrossClientState;
+    setManageWebexCallingInWxcc(enable: boolean, options?: {
+        userId?: string;
+        ttl?: number;
+        appName?: string;
+        trackPublishMetrics?: boolean;
+    }): Promise<void>;
+    private trackUsersubPreflightFailure;
+    teardown(): void;
+    /** Whether usersub `answer-calls-on-wxcc: true` was successfully published this session. */
+    isAnswerCallsStateActive(): boolean;
+}

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

@@ -0,0 +1,28 @@
+import { WebexSDK } from '../types';
+export declare const TELEPHONY_CALL_MUTED = "event:telephony_calls.muted";
+export declare const TELEPHONY_CALL_UNMUTED = "event:telephony_calls.unmuted";
+export type UpdatedCallMuteStateEvent = {
+    data: {
+        actorId: string;
+        callId: string;
+        muted: boolean;
+    };
+};
+type MuteChangeHandler = (callId: string, muted: boolean) => void;
+/**
+ * Subscribes to Mercury telephony mute/unmute events for wxApp thick-client sync (AD parity).
+ */
+export default class WxAppTelephonyMercurySync {
+    private webex;
+    private subscribedAgentId?;
+    private muteChangeHandler?;
+    private boundMuteHandler?;
+    private boundUnmuteHandler?;
+    constructor(webex: WebexSDK);
+    private decodeBase64;
+    private handleMuteStateEvent;
+    subscribe(agentId: string, onMuteChange: MuteChangeHandler): void;
+    unsubscribe(): void;
+    isSubscribed(): boolean;
+}
+export {};

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

@@ -1,4 +1,10 @@
 export declare const DEFAULT_PAGE = 0;
+/** Desktop Profile access levels for collaboration destination categories. */
+export declare const COLLABORATION_ACCESS: {
+    readonly ALL: "ALL";
+    readonly SPECIFIC: "SPECIFIC";
+    readonly NONE: "NONE";
+};
 /**
  * Default page size for paginated API requests.
  * @type {number}
@@ -22,6 +28,8 @@ export declare const AGENT_STATE_AVAILABLE_ID = "0";
  * @ignore
  */
 export declare const AGENT_STATE_AVAILABLE = "Available";
+/** System idle-code name reserved for Agent Wellness Break. */
+export declare const WELLBEING_BREAK_IDLE_CODE = "WellbeingBreak";
 /**
  * Description for the 'Available' agent state.
  * @type {string}
@@ -52,6 +60,7 @@ export declare const METHODS: {
     GET_URL_MAPPING: string;
     GET_DIAL_PLAN_DATA: string;
     GET_AI_FEATURE_FLAGS: string;
+    GET_WELLBEING_BREAK_IDLE_CODE: string;
     GET_QUEUES: string;
     PARSE_AGENT_CONFIGS: string;
     GET_URL_MAPPING_UTIL: string;
@@ -129,6 +138,8 @@ export declare const endPointMap: {
      * @ignore
      */
     listAuxCodes: (orgId: string, page: number, pageSize: number, filter: string[], attributes: string[]) => string;
+    /** Lists system idle codes without applying the agent Desktop Profile filter. */
+    systemIdleCodes: (orgId: string, page: number, pageSize: number) => string;
     /**
      * Gets the endpoint for organization info.
      * @param orgId - Organization ID.
@@ -212,16 +223,13 @@ export declare const endPointMap: {
      */
     queueList: (orgId: string, queryParams: string) => string;
     /**
-     * Gets the endpoint for entry points list with custom query parameters.
+     * Gets the desktop-profile-filtered dial-number mappings used by entry-point destination lists.
      * @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;
+    entryPointDialNumberList: (orgId: string, queryParams: string) => string;
     /**
      * Gets the endpoint for address book entries with custom query parameters.
      * @param orgId - Organization ID.
@@ -246,4 +254,25 @@ export declare const endPointMap: {
      * @ignore
      */
     outdialAniEntries: (orgId: string, outdialANI: string, queryParams: string) => string;
+    /**
+     * Gets the endpoint for user preference by user ID.
+     * @param orgId - Organization ID.
+     * @param userId - User ID.
+     * @returns The endpoint URL string.
+     * @public
+     * @example
+     * const url = endPointMap.userPreference('org123', 'user456');
+     * @ignore
+     */
+    userPreference: (orgId: string, userId: string) => string;
+    /**
+     * Gets the endpoint for creating user preference.
+     * @param orgId - Organization ID.
+     * @returns The endpoint URL string.
+     * @public
+     * @example
+     * const url = endPointMap.userPreferenceCreate('org123');
+     * @ignore
+     */
+    userPreferenceCreate: (orgId: string) => string;
 };