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

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

@@ -0,0 +1,190 @@
+/**
+ * Common pagination metadata interface used across all APIs.
+ * @public
+ * @template T - Additional metadata properties specific to the API
+ */
+export interface PaginationMeta {
+    /** Organization ID */
+    orgid?: string;
+    /** Current page number */
+    page?: number;
+    /** Page size for current data set */
+    pageSize?: number;
+    /** Number of pages */
+    totalPages?: number;
+    /** Total number of items */
+    totalRecords?: number;
+    /** Total number of items (alias for compatibility) */
+    totalItems?: number;
+    /** Current page number (alias for compatibility) */
+    currentPage?: number;
+    /** Map of pagination links */
+    links?: Record<string, string>;
+}
+/**
+ * Common paginated response interface used across all APIs.
+ * @public
+ * @template T - The type of data items in the response
+ */
+export interface PaginatedResponse<T> {
+    /** Array of data items */
+    data: T[];
+    /** Pagination metadata */
+    meta: PaginationMeta;
+}
+/**
+ * Common search and pagination parameters interface.
+ * @public
+ */
+export interface BaseSearchParams {
+    /** Search keyword */
+    search?: string;
+    /** Filter criteria using RSQL syntax */
+    filter?: string;
+    /** Attributes to be returned */
+    attributes?: string;
+    /** Page number (starts from 0) */
+    page?: number;
+    /** Number of items per page */
+    pageSize?: number;
+    /** Sort field */
+    sortBy?: string;
+    /** Sort direction */
+    sortOrder?: 'asc' | 'desc';
+}
+/**
+ * Default pagination constants used across all APIs.
+ * @public
+ */
+export declare const PAGINATION_DEFAULTS: {
+    /** Default page number */
+    readonly PAGE: 0;
+    /** Default page size */
+    readonly PAGE_SIZE: 100;
+};
+/**
+ * Interface for cached page entry with metadata
+ * @public
+ */
+export interface PageCacheEntry<T> {
+    /** Cached data items for this page */
+    data: T[];
+    /** Timestamp when this page was cached */
+    timestamp: number;
+    /** Total metadata if available */
+    totalMeta?: {
+        totalPages?: number;
+        totalRecords?: number;
+    };
+}
+/**
+ * Interface for cache validation parameters
+ * @public
+ */
+export interface CacheValidationParams {
+    /** Search query parameter */
+    search?: string;
+    /** Filter parameter */
+    filter?: string;
+    /** Attributes parameter */
+    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.
+ * Provides consistent caching behavior across all Contact Center APIs.
+ *
+ * @class PageCache
+ * @public
+ * @template T - The type of data items being cached
+ * @example
+ * ```typescript
+ * // Create a cache instance for a specific data type
+ * const cache = new PageCache<AddressBookEntry>('AddressBook');
+ *
+ * // 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);
+ *
+ *   if (cachedPage) {
+ *     return cachedPage.data;
+ *   }
+ * }
+ *
+ * // Cache API response
+ * cache.cachePage(cacheKey, responseData, responseMeta);
+ * ```
+ */
+export declare class PageCache<T> {
+    private cache;
+    private apiName;
+    /**
+     * Creates an instance of PageCache
+     * @param {string} apiName - Name of the API using this cache (for logging)
+     * @public
+     */
+    constructor(apiName: string);
+    /**
+     * Checks if cache can be used for the given parameters.
+     * 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
+     */
+    canUseCache(params: CacheValidationParams): boolean;
+    /**
+     * Builds a cache key for the given parameters
+     * @param {string} orgId - Organization ID
+     * @param {number} page - Page number
+     * @param {number} pageSize - Page size
+     * @returns {string} Cache key
+     * @public
+     */
+    buildCacheKey(orgId: string, page: number, pageSize: number): string;
+    /**
+     * Gets a cached page if it exists and is valid
+     * @param {string} cacheKey - Cache key to look up
+     * @returns {PageCacheEntry<T> | null} Cached page entry or null if not found/expired
+     * @public
+     */
+    getCachedPage(cacheKey: string): PageCacheEntry<T> | null;
+    /**
+     * Caches a page of data with metadata
+     * @param {string} cacheKey - Cache key
+     * @param {T[]} data - Data items to cache
+     * @param {any} meta - Metadata from API response
+     * @public
+     */
+    cachePage(cacheKey: string, data: T[], meta?: any): void;
+    /**
+     * Clears all cached entries
+     * @public
+     */
+    clearCache(): void;
+    /**
+     * Gets the current number of cached entries
+     * @returns {number} Number of cached entries
+     * @public
+     */
+    getCacheSize(): number;
+}
+export default PageCache;

package/dist/types/webex-config.d.ts

@@ -0,0 +1,53 @@
+/**
+ * Default Webex SDK configuration for Contact Center integration.
+ *
+ * @public
+ * @example
+ * import webexConfig from './webex-config';
+ * const hydraUrl = webexConfig.hydra;
+ */
+declare const _default: {
+    /**
+     * URL for the Hydra API service.
+     * @type {string}
+     * @public
+     * @default process.env.HYDRA_SERVICE_URL || 'https://api.ciscospark.com/v1'
+     */
+    hydra: string;
+    /**
+     * Alias for the Hydra API service URL.
+     * @type {string}
+     * @public
+     * @default process.env.HYDRA_SERVICE_URL || 'https://api.ciscospark.com/v1'
+     */
+    hydraServiceUrl: string;
+    /**
+     * Credentials configuration (empty by default).
+     * @type {object}
+     * @public
+     */
+    credentials: {};
+    /**
+     * Device configuration options.
+     * @type {object}
+     * @public
+     * @property {boolean} validateDomains - Whether to validate device domains.
+     * @property {boolean} ephemeral - Whether the device is ephemeral.
+     */
+    device: {
+        validateDomains: boolean;
+        ephemeral: boolean;
+    };
+    /**
+     * Storage configuration for the SDK.
+     * @type {object}
+     * @public
+     * @property {typeof MemoryStoreAdapter} boundedAdapter - Adapter for bounded storage.
+     * @property {typeof MemoryStoreAdapter} unboundedAdapter - Adapter for unbounded storage.
+     */
+    storage: {
+        boundedAdapter: any;
+        unboundedAdapter: any;
+    };
+};
+export default _default;

package/dist/types/webex.d.ts

@@ -0,0 +1,8 @@
+export * from "./index";
+export default Webex;
+/**
+ * Webex SDK class extended from the core SDK.
+ * Includes custom configuration and plugin registration for CC (Contact Center) use cases.
+ * @ignore
+ */
+declare const Webex: any;

package/dist/types.js

@@ -3,7 +3,7 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.LoginOption = exports.LOGGING_LEVEL = exports.HTTP_METHODS = 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
@@ -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
@@ -311,4 +323,126 @@ const LoginOption = exports.LoginOption = {
  * @example
  * 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 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

package/dist/types.js.map

@@ -1 +1 @@
-{"version":3,"names":["HTTP_METHODS","exports","GET","POST","PATCH","PUT","DELETE","LOGGING_LEVEL","LoginOption","AGENT_DN","EXTENSION","BROWSER"],"sources":["types.ts"],"sourcesContent":["import {CallingClientConfig} from '@webex/calling';\nimport {\n  SubmitBehavioralEvent,\n  SubmitOperationalEvent,\n  SubmitBusinessEvent,\n} from '@webex/internal-plugin-metrics/src/metrics.types';\nimport * as Agent from './services/agent/types';\nimport * as Contact from './services/task/types';\nimport {Profile} from './services/config/types';\nimport {PaginatedResponse, BaseSearchParams} from './utils/PageCache';\n\n/**\n * Generic type for converting a const enum object into a union type of its values.\n * @template T The enum object type\n * @internal\n * @ignore\n */\ntype Enum<T extends Record<string, unknown>> = T[keyof T];\n\n/**\n * HTTP methods supported by WebexRequest.\n * @enum {string}\n * @public\n * @example\n * const method: HTTP_METHODS = HTTP_METHODS.GET;\n * @ignore\n */\nexport const HTTP_METHODS = {\n  /** HTTP GET method for retrieving data */\n  GET: 'GET',\n  /** HTTP POST method for creating resources */\n  POST: 'POST',\n  /** HTTP PATCH method for partial updates */\n  PATCH: 'PATCH',\n  /** HTTP PUT method for complete updates */\n  PUT: 'PUT',\n  /** HTTP DELETE method for removing resources */\n  DELETE: 'DELETE',\n} as const;\n\n/**\n * Union type of HTTP methods.\n * @public\n * @example\n * function makeRequest(method: HTTP_METHODS) { ... }\n * @ignore\n */\nexport type HTTP_METHODS = Enum<typeof HTTP_METHODS>;\n\n/**\n * Payload for making requests to Webex APIs.\n * @public\n * @example\n * const payload: WebexRequestPayload = {\n *   service: 'identity',\n *   resource: '/users',\n *   method: HTTP_METHODS.GET\n * };\n * @ignore\n */\nexport type WebexRequestPayload = {\n  /** Service name to target */\n  service?: string;\n  /** Resource path within the service */\n  resource?: string;\n  /** HTTP method to use */\n  method?: HTTP_METHODS;\n  /** Full URI if not using service/resource pattern */\n  uri?: string;\n  /** Whether to add authorization header */\n  addAuthHeader?: boolean;\n  /** Custom headers to include in request */\n  headers?: {\n    [key: string]: string | null;\n  };\n  /** Request body data */\n  body?: object;\n  /** Expected response status code */\n  statusCode?: number;\n  /** Whether to parse response as JSON */\n  json?: boolean;\n};\n\n/**\n * Event listener function type.\n * @internal\n * @ignore\n */\ntype Listener = (e: string, data?: unknown) => void;\n\n/**\n * Event listener removal function type.\n * @internal\n * @ignore\n */\ntype ListenerOff = (e: string) => void;\n\n/**\n * Service host configuration.\n * @internal\n * @ignore\n */\ntype ServiceHost = {\n  /** Host URL/domain for the service */\n  host: string;\n  /** Time-to-live in seconds */\n  ttl: number;\n  /** Priority level for load balancing (lower is higher priority) */\n  priority: number;\n  /** Unique identifier for this host */\n  id: string;\n  /** Whether this is the home cluster for the user */\n  homeCluster?: boolean;\n};\n\n/**\n * Configuration options for the Contact Center Plugin.\n * @interface CCPluginConfig\n * @public\n * @example\n * const config: CCPluginConfig = {\n *   allowMultiLogin: true,\n *   allowAutomatedRelogin: false,\n *   clientType: 'browser',\n *   isKeepAliveEnabled: true,\n *   force: false,\n *   metrics: { clientName: 'myClient', clientType: 'browser' },\n *   logging: { enable: true, verboseEvents: false },\n *   callingClientConfig: { ... }\n * };\n */\nexport interface CCPluginConfig {\n  /** Whether to allow multiple logins from different devices */\n  allowMultiLogin: boolean;\n  /** Whether to automatically attempt relogin on connection loss */\n  allowAutomatedRelogin: boolean;\n  /** The type of client making the connection */\n  clientType: string;\n  /** Whether to enable keep-alive messages */\n  isKeepAliveEnabled: boolean;\n  /** Whether to force registration */\n  force: boolean;\n  /** Metrics configuration */\n  metrics: {\n    /** Name of the client for metrics */\n    clientName: string;\n    /** Type of client for metrics */\n    clientType: string;\n  };\n  /** Logging configuration */\n  logging: {\n    /** Whether to enable logging */\n    enable: boolean;\n    /** Whether to log verbose events */\n    verboseEvents: boolean;\n  };\n  /** Configuration for the calling client */\n  callingClientConfig: CallingClientConfig;\n}\n\n/**\n * Logger interface for standardized logging throughout the plugin.\n * @public\n * @example\n * logger.log('This is a log message');\n * logger.error('This is an error message');\n * @ignore\n */\nexport type Logger = {\n  /** Log general messages */\n  log: (payload: string) => void;\n  /** Log error messages */\n  error: (payload: string) => void;\n  /** Log warning messages */\n  warn: (payload: string) => void;\n  /** Log informational messages */\n  info: (payload: string) => void;\n  /** Log detailed trace messages */\n  trace: (payload: string) => void;\n  /** Log debug messages */\n  debug: (payload: string) => void;\n};\n\n/**\n * Contextual information for log entries.\n * @public\n * @ignore\n */\nexport interface LogContext {\n  /** Module name where the log originated */\n  module?: string;\n  /** Method name where the log originated */\n  method?: string;\n  interactionId?: string;\n  trackingId?: string;\n  /** Additional structured data to include in logs */\n  data?: Record<string, any>;\n  /** Error object to include in logs */\n  error?: Error | unknown;\n}\n\n/**\n * Available logging severity levels.\n * @enum {string}\n * @public\n * @example\n * const level: LOGGING_LEVEL = LOGGING_LEVEL.error;\n * @ignore\n */\nexport enum LOGGING_LEVEL {\n  /** Critical failures that require immediate attention */\n  error = 'ERROR',\n  /** Important issues that don't prevent the system from working */\n  warn = 'WARN',\n  /** General informational logs */\n  log = 'LOG',\n  /** Detailed information about system operation */\n  info = 'INFO',\n  /** Highly detailed diagnostic information */\n  trace = 'TRACE',\n}\n\n/**\n * Metadata for log uploads.\n * @public\n * @example\n * const meta: LogsMetaData = { feedbackId: 'fb123', correlationId: 'corr456' };\n * @ignore\n */\nexport type LogsMetaData = {\n  /** Optional feedback ID to associate with logs */\n  feedbackId?: string;\n  /** Optional correlation ID to track related operations */\n  correlationId?: string;\n};\n\n/**\n * Response from uploading logs to the server.\n * @public\n * @example\n * const response: UploadLogsResponse = { trackingid: 'track123', url: 'https://...', userId: 'user1' };\n */\nexport type UploadLogsResponse = {\n  /** Tracking ID for the upload request */\n  trackingid?: string;\n  /** URL where the logs can be accessed */\n  url?: string;\n  /** ID of the user who uploaded logs */\n  userId?: string;\n  /** Feedback ID associated with the logs */\n  feedbackId?: string;\n  /** Correlation ID for tracking related operations */\n  correlationId?: string;\n};\n\n/**\n * Internal Webex SDK interfaces needed for plugin integration.\n * @internal\n * @ignore\n */\ninterface IWebexInternal {\n  /** Mercury service for real-time messaging */\n  mercury: {\n    /** Register an event listener */\n    on: Listener;\n    /** Remove an event listener */\n    off: ListenerOff;\n    /** Establish a connection to the Mercury service */\n    connect: () => Promise<void>;\n    /** Disconnect from the Mercury service */\n    disconnect: () => Promise<void>;\n    /** Whether Mercury is currently connected */\n    connected: boolean;\n    /** Whether Mercury is in the process of connecting */\n    connecting: boolean;\n  };\n  /** Device information */\n  device: {\n    /** Current WDM URL */\n    url: string;\n    /** Current user's ID */\n    userId: string;\n    /** Current organization ID */\n    orgId: string;\n    /** Device version */\n    version: string;\n    /** Calling behavior configuration */\n    callingBehavior: string;\n  };\n  /** Presence service */\n  presence: unknown;\n  /** Services discovery and management */\n  services: {\n    /** Get a service URL by name */\n    get: (service: string) => string;\n    /** Wait for service catalog to be loaded */\n    waitForCatalog: (service: string) => Promise<void>;\n    /** Host catalog for service discovery */\n    _hostCatalog: Record<string, ServiceHost[]>;\n    /** Service URLs cache */\n    _serviceUrls: {\n      /** Mobius calling service */\n      mobius: string;\n      /** Identity service */\n      identity: string;\n      /** Janus media server */\n      janus: string;\n      /** WDM (WebEx Device Management) service */\n      wdm: string;\n      /** BroadWorks IDP proxy service */\n      broadworksIdpProxy: string;\n      /** Hydra API service */\n      hydra: string;\n      /** Mercury API service */\n      mercuryApi: string;\n      /** UC Management gateway service */\n      'ucmgmt-gateway': string;\n      /** Contacts service */\n      contactsService: string;\n    };\n  };\n  /** Metrics collection services */\n  newMetrics: {\n    /** Submit behavioral events (user actions) */\n    submitBehavioralEvent: SubmitBehavioralEvent;\n    /** Submit operational events (system operations) */\n    submitOperationalEvent: SubmitOperationalEvent;\n    /** Submit business events (business outcomes) */\n    submitBusinessEvent: SubmitBusinessEvent;\n  };\n  /** Support functionality */\n  support: {\n    /** Submit logs to server */\n    submitLogs: (\n      metaData: LogsMetaData,\n      logs: string,\n      options: {\n        /** Whether to submit full logs or just differences */\n        type: 'diff' | 'full';\n      }\n    ) => Promise<UploadLogsResponse>;\n  };\n}\n\n/**\n * Interface representing the WebexSDK core functionality.\n * @interface WebexSDK\n * @public\n * @example\n * const sdk: WebexSDK = ...;\n * sdk.request({ service: 'identity', resource: '/users', method: HTTP_METHODS.GET });\n * @ignore\n */\nexport interface WebexSDK {\n  /** Version of the WebexSDK */\n  version: string;\n  /** Whether the SDK can authorize requests */\n  canAuthorize: boolean;\n  /** Credentials management */\n  credentials: {\n    /** Get the user token for authentication */\n    getUserToken: () => Promise<string>;\n    /** Get the organization ID */\n    getOrgId: () => string;\n  };\n  /** Whether the SDK is ready for use */\n  ready: boolean;\n  /** Make a request to the Webex APIs */\n  request: <T>(payload: WebexRequestPayload) => Promise<T>;\n  /** Register a one-time event handler */\n  once: (event: string, callBack: () => void) => void;\n  /** Internal plugins and services */\n  internal: IWebexInternal;\n  /** Logger instance */\n  logger: Logger;\n}\n\n/**\n * An interface for the `ContactCenter` class.\n * The `ContactCenter` package is designed to provide a set of APIs to perform various operations for the Agent flow within Webex Contact Center.\n * @public\n * @example\n * const cc: IContactCenter = ...;\n * cc.register().then(profile => { ... });\n * @ignore\n */\nexport interface IContactCenter {\n  /**\n   * Initialize the CC SDK by setting up the contact center mercury connection.\n   * This establishes WebSocket connectivity for real-time communication.\n   *\n   * @returns A Promise that resolves to the agent's profile upon successful registration\n   * @public\n   * @example\n   * cc.register().then(profile => { ... });\n   */\n  register(): Promise<Profile>;\n}\n\n/**\n * Generic HTTP response structure.\n * @public\n * @example\n * const response: IHttpResponse = { body: {}, statusCode: 200, method: 'GET', headers: {}, url: '...' };\n * @ignore\n */\nexport interface IHttpResponse {\n  /** Response body content */\n  body: any;\n  /** HTTP status code */\n  statusCode: number;\n  /** HTTP method used for the request */\n  method: string;\n  /** Response headers */\n  headers: Headers;\n  /** Request URL */\n  url: string;\n}\n\n/**\n * Supported login options for agent authentication.\n * @public\n * @example\n * const option: LoginOption = LoginOption.AGENT_DN;\n * @ignore\n */\nexport const LoginOption = {\n  /** Login using agent's direct number */\n  AGENT_DN: 'AGENT_DN',\n  /** Login using an extension number */\n  EXTENSION: 'EXTENSION',\n  /** Login using browser WebRTC capabilities */\n  BROWSER: 'BROWSER',\n} as const;\n\n/**\n * Union type of login options.\n * @public\n * @example\n * function login(option: LoginOption) { ... }\n * @ignore\n */\nexport type LoginOption = Enum<typeof LoginOption>;\n\n/**\n * Request payload for subscribing to the contact center websocket.\n * @public\n * @example\n * const req: SubscribeRequest = { force: true, isKeepAliveEnabled: true, clientType: 'browser', allowMultiLogin: false };\n * @ignore\n */\nexport type SubscribeRequest = {\n  /** Whether to force connection even if another exists */\n  force: boolean;\n  /** Whether to send keepalive messages */\n  isKeepAliveEnabled: boolean;\n  /** Type of client connecting */\n  clientType: string;\n  /** Whether to allow login from multiple devices */\n  allowMultiLogin: boolean;\n};\n\n/**\n * Represents the response from getListOfTeams method.\n * Teams are groups of agents that can be managed together.\n * @public\n * @example\n * const team: Team = { id: 'team1', name: 'Support', desktopLayoutId: 'layout1' };\n * @ignore\n */\nexport type Team = {\n  /**\n   * Unique identifier of the team.\n   */\n  id: string;\n\n  /**\n   * Display name of the team.\n   */\n  name: string;\n\n  /**\n   * Associated desktop layout ID for the team.\n   * Controls how the agent desktop is displayed for team members.\n   */\n  desktopLayoutId?: string;\n};\n\n/**\n * Represents the request to perform agent login.\n * @public\n * @example\n * const login: AgentLogin = { dialNumber: '1234', teamId: 'team1', loginOption: LoginOption.AGENT_DN };\n */\nexport type AgentLogin = {\n  /**\n   * A dialNumber field contains the number to dial such as a route point or extension.\n   * Required for AGENT_DN and EXTENSION login options.\n   */\n  dialNumber?: string;\n\n  /**\n   * The unique ID representing a team of users.\n   * The agent must belong to this team.\n   */\n  teamId: string;\n\n  /**\n   * The loginOption field specifies the type of login method.\n   * Controls how calls are delivered to the agent.\n   */\n  loginOption: LoginOption;\n};\n\n/**\n * Represents the request to update agent profile settings.\n * @public\n * @example\n * const update: AgentProfileUpdate = { loginOption: LoginOption.BROWSER, dialNumber: '5678' };\n */\nexport type AgentProfileUpdate = Pick<AgentLogin, 'loginOption' | 'dialNumber' | 'teamId'>;\n\n/**\n * Union type for all possible request body types.\n * @internal\n * @ignore\n */\nexport type RequestBody =\n  | SubscribeRequest\n  | Agent.Logout\n  | Agent.UserStationLogin\n  | Agent.StateChange\n  | Agent.BuddyAgents\n  | Contact.HoldResumePayload\n  | Contact.ResumeRecordingPayload\n  | Contact.ConsultPayload\n  | Contact.ConsultEndAPIPayload // API Payload accepts only QueueId wheres SDK API allows more params\n  | Contact.TransferPayLoad\n  | Contact.ConsultTransferPayLoad\n  | Contact.cancelCtq\n  | Contact.WrapupPayLoad\n  | Contact.DialerPayload;\n\n/**\n * Represents the options to fetch buddy agents for the logged in agent.\n * Buddy agents are other agents who can be consulted or transfered to.\n * @public\n * @example\n * const opts: BuddyAgents = { mediaType: 'telephony', state: 'Available' };\n * @ignore\n */\nexport type BuddyAgents = {\n  /**\n   * The media type channel to filter buddy agents.\n   * Determines which channel capability the returned agents must have.\n   */\n  mediaType: 'telephony' | 'chat' | 'social' | 'email';\n\n  /**\n   * Optional filter for agent state.\n   * If specified, returns only agents in that state.\n   * If omitted, returns both available and idle agents.\n   */\n  state?: 'Available' | 'Idle';\n};\n\n/**\n * Generic error structure for Contact Center SDK errors.\n * Contains detailed information about the error context.\n * @public\n * @example\n * const err: GenericError = new Error('Failed');\n * err.details = { type: 'ERR', orgId: 'org1', trackingId: 'track1', data: {} };\n * @ignore\n */\nexport interface GenericError extends Error {\n  /** Structured details about the error */\n  details: {\n    /** Error type identifier */\n    type: string;\n    /** Organization ID where the error occurred */\n    orgId: string;\n    /** Unique tracking ID for the error */\n    trackingId: string;\n    /** Additional error context data */\n    data: Record<string, any>;\n  };\n}\n\n/**\n * Response type for station login operations.\n * Either a success response with agent details or an error.\n * @public\n * @example\n * function handleLogin(resp: StationLoginResponse) { ... }\n */\nexport type StationLoginResponse = Agent.StationLoginSuccessResponse | Error;\n\n/**\n * Response type for station logout operations.\n * Either a success response with logout details or an error.\n * @public\n * @example\n * function handleLogout(resp: StationLogoutResponse) { ... }\n */\nexport type StationLogoutResponse = Agent.LogoutSuccess | Error;\n\n/**\n * Response type for station relogin operations.\n * Either a success response with relogin details or an error.\n * @public\n * @example\n * function handleReLogin(resp: StationReLoginResponse) { ... }\n * @ignore\n */\nexport type StationReLoginResponse = Agent.ReloginSuccess | Error;\n\n/**\n * Response type for agent state change operations.\n * Either a success response with state change details or an error.\n * @public\n * @example\n * function handleStateChange(resp: SetStateResponse) { ... }\n * @ignore\n */\nexport type SetStateResponse = Agent.StateChangeSuccess | Error;\n\n/**\n * AddressBook types\n */\nexport interface AddressBookEntry {\n  id: string;\n  organizationId?: string;\n  version?: number;\n  name: string;\n  number: string;\n  createdTime?: number;\n  lastUpdatedTime?: number;\n}\n\nexport type AddressBookEntriesResponse = PaginatedResponse<AddressBookEntry>;\n\nexport interface AddressBookEntrySearchParams extends BaseSearchParams {\n  addressBookId?: string;\n}\n\n/**\n * EntryPointRecord types\n */\nexport interface EntryPointRecord {\n  id: string;\n  name: string;\n  description?: string;\n  type: string;\n  isActive: boolean;\n  orgId: string;\n  createdAt?: string;\n  updatedAt?: string;\n  settings?: Record<string, any>;\n}\n\nexport type EntryPointListResponse = PaginatedResponse<EntryPointRecord>;\nexport type EntryPointSearchParams = BaseSearchParams;\n\n/**\n * Queue types\n */\nexport interface QueueSkillRequirement {\n  organizationId?: string;\n  id?: string;\n  version?: number;\n  skillId: string;\n  skillName?: string;\n  skillType?: string;\n  condition: string;\n  skillValue: string;\n  createdTime?: number;\n  lastUpdatedTime?: number;\n}\n\nexport interface QueueAgent {\n  id: string;\n  ciUserId?: string;\n}\n\nexport interface AgentGroup {\n  teamId: string;\n}\n\nexport interface CallDistributionGroup {\n  agentGroups: AgentGroup[];\n  order: number;\n  duration?: number;\n}\n\nexport interface AssistantSkillMapping {\n  assistantSkillId?: string;\n  assistantSkillUpdatedTime?: number;\n}\n\n/**\n * Configuration for a contact service queue\n * @public\n */\nexport interface ContactServiceQueue {\n  /** Organization ID */\n  organizationId?: string;\n  /** Unique identifier for the queue */\n  id?: string;\n  /** Version of the queue */\n  version?: number;\n  /** Name of the Contact Service Queue */\n  name: string;\n  /** Description of the queue */\n  description?: string;\n  /** Queue type (INBOUND, OUTBOUND) */\n  queueType: 'INBOUND' | 'OUTBOUND';\n  /** Whether to check agent availability */\n  checkAgentAvailability: boolean;\n  /** Channel type (TELEPHONY, EMAIL, SOCIAL_CHANNEL, CHAT, etc.) */\n  channelType: 'TELEPHONY' | 'EMAIL' | 'FAX' | 'CHAT' | 'VIDEO' | 'OTHERS' | 'SOCIAL_CHANNEL';\n  /** Social channel type for SOCIAL_CHANNEL channelType */\n  socialChannelType?:\n    | 'MESSAGEBIRD'\n    | 'MESSENGER'\n    | 'WHATSAPP'\n    | 'APPLE_BUSINESS_CHAT'\n    | 'GOOGLE_BUSINESS_MESSAGES';\n  /** Service level threshold in seconds */\n  serviceLevelThreshold: number;\n  /** Maximum number of simultaneous contacts */\n  maxActiveContacts: number;\n  /** Maximum time in queue in seconds */\n  maxTimeInQueue: number;\n  /** Default music in queue media file ID */\n  defaultMusicInQueueMediaFileId: string;\n  /** Timezone for routing strategies */\n  timezone?: string;\n  /** Whether the queue is active */\n  active: boolean;\n  /** Whether outdial campaign is enabled */\n  outdialCampaignEnabled?: boolean;\n  /** Whether monitoring is permitted */\n  monitoringPermitted: boolean;\n  /** Whether parking is permitted */\n  parkingPermitted: boolean;\n  /** Whether recording is permitted */\n  recordingPermitted: boolean;\n  /** Whether recording all calls is permitted */\n  recordingAllCallsPermitted: boolean;\n  /** Whether pausing recording is permitted */\n  pauseRecordingPermitted: boolean;\n  /** Recording pause duration in seconds */\n  recordingPauseDuration?: number;\n  /** Control flow script URL */\n  controlFlowScriptUrl: string;\n  /** IVR requeue URL */\n  ivrRequeueUrl: string;\n  /** Overflow number for telephony */\n  overflowNumber?: string;\n  /** Vendor ID */\n  vendorId?: string;\n  /** Routing type */\n  routingType: 'LONGEST_AVAILABLE_AGENT' | 'SKILLS_BASED' | 'CIRCULAR' | 'LINEAR';\n  /** Skills-based routing type */\n  skillBasedRoutingType?: 'LONGEST_AVAILABLE_AGENT' | 'BEST_AVAILABLE_AGENT';\n  /** Queue routing type */\n  queueRoutingType: 'TEAM_BASED' | 'SKILL_BASED' | 'AGENT_BASED';\n  /** Queue skill requirements */\n  queueSkillRequirements?: QueueSkillRequirement[];\n  /** List of agents for agent-based queue */\n  agents?: QueueAgent[];\n  /** Call distribution groups */\n  callDistributionGroups: CallDistributionGroup[];\n  /** XSP version */\n  xspVersion?: string;\n  /** Subscription ID */\n  subscriptionId?: string;\n  /** Assistant skill mapping */\n  assistantSkill?: AssistantSkillMapping;\n  /** Whether this is a system default queue */\n  systemDefault?: boolean;\n  /** User who last updated agents list */\n  agentsLastUpdatedByUserName?: string;\n  /** Email of user who last updated agents list */\n  agentsLastUpdatedByUserEmailPrefix?: string;\n  /** When agents list was last updated */\n  agentsLastUpdatedTime?: number;\n  /** Creation timestamp in epoch millis */\n  createdTime?: number;\n  /** Last updated timestamp in epoch millis */\n  lastUpdatedTime?: number;\n}\n\nexport type ContactServiceQueuesResponse = PaginatedResponse<ContactServiceQueue>;\n\nexport interface ContactServiceQueueSearchParams extends BaseSearchParams {\n  desktopProfileFilter?: boolean;\n  provisioningView?: boolean;\n  singleObjectResponse?: boolean;\n}\n\n/**\n * Response type for buddy agents query operations.\n * Either a success response with list of buddy agents or an error.\n * @public\n * @example\n * function handleBuddyAgents(resp: BuddyAgentsResponse) { ... }\n */\nexport type BuddyAgentsResponse = Agent.BuddyAgentsSuccess | Error;\n\n/**\n * Response type for device type update operations.\n * Either a success response with update confirmation or an error.\n * @public\n * @example\n * function handleUpdateDeviceType(resp: UpdateDeviceTypeResponse) { ... }\n */\nexport type UpdateDeviceTypeResponse = Agent.DeviceTypeUpdateSuccess | Error;\n"],"mappings":";;;;;;AAWA;AACA;AACA;AACA;AACA;AACA;;AAGA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,MAAMA,YAAY,GAAAC,OAAA,CAAAD,YAAA,GAAG;EAC1B;EACAE,GAAG,EAAE,KAAK;EACV;EACAC,IAAI,EAAE,MAAM;EACZ;EACAC,KAAK,EAAE,OAAO;EACd;EACAC,GAAG,EAAE,KAAK;EACV;EACAC,MAAM,EAAE;AACV,CAAU;;AAEV;AACA;AACA;AACA;AACA;AACA;AACA;;AAGA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAwBA;AACA;AACA;AACA;AACA;;AAGA;AACA;AACA;AACA;AACA;;AAGA;AACA;AACA;AACA;AACA;;AAcA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AA8BA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAgBA;AACA;AACA;AACA;AACA;AAcA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AAPA,IAQYC,aAAa,GAAAN,OAAA,CAAAM,aAAA,0BAAbA,aAAa;EACvB;EADUA,aAAa;EAGvB;EAHUA,aAAa;EAKvB;EALUA,aAAa;EAOvB;EAPUA,aAAa;EASvB;EATUA,aAAa;EAAA,OAAbA,aAAa;AAAA;AAazB;AACA;AACA;AACA;AACA;AACA;AACA;AAQA;AACA;AACA;AACA;AACA;AACA;AAcA;AACA;AACA;AACA;AACA;AAqFA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AAyBA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AAcA;AACA;AACA;AACA;AACA;AACA;AACA;AAcA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,MAAMC,WAAW,GAAAP,OAAA,CAAAO,WAAA,GAAG;EACzB;EACAC,QAAQ,EAAE,UAAU;EACpB;EACAC,SAAS,EAAE,WAAW;EACtB;EACAC,OAAO,EAAE;AACX,CAAU;;AAEV;AACA;AACA;AACA;AACA;AACA;AACA;;AAGA;AACA;AACA;AACA;AACA;AACA;AACA;;AAYA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAmBA;AACA;AACA;AACA;AACA;AACA;;AAqBA;AACA;AACA;AACA;AACA;AACA;;AAGA;AACA;AACA;AACA;AACA;;AAiBA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAgBA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAeA;AACA;AACA;AACA;AACA;AACA;AACA;;AAGA;AACA;AACA;AACA;AACA;AACA;AACA;;AAGA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAGA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAGA;AACA;AACA;;AAiBA;AACA;AACA;;AAgBA;AACA;AACA;;AAkCA;AACA;AACA;AACA;;AAmGA;AACA;AACA;AACA;AACA;AACA;AACA;;AAGA;AACA;AACA;AACA;AACA;AACA;AACA","ignoreList":[]}
+{"version":3,"names":["HTTP_METHODS","exports","GET","POST","PATCH","PUT","DELETE","LOGGING_LEVEL","LoginOption","AGENT_DN","EXTENSION","BROWSER","RealTimeAssistanceUserActionId","LIKE","DISLIKE","COPY","AIAssistantEventType","CUSTOM_EVENT","CTI_EVENT","AIAssistantEventName","GET_TRANSCRIPTS","GET_SUGGESTIONS","ADD_SUGGESTIONS_EXTRA_CONTEXT","GET_MID_CALL_SUMMARY","GET_POST_CALL_SUMMARY","MID_CALL_SUMMARY_RESPONSE","POST_CALL_SUMMARY_RESPONSE","SUGGESTED_RESPONSES_DIGITAL","SUGGESTED_RESPONSES_USER_ACTION"],"sources":["types.ts"],"sourcesContent":["import {CallingClientConfig} from '@webex/calling';\nimport {\n  SubmitBehavioralEvent,\n  SubmitOperationalEvent,\n  SubmitBusinessEvent,\n} from '@webex/internal-plugin-metrics/src/metrics.types';\nimport * as Agent from './services/agent/types';\nimport * as Contact from './services/task/types';\nimport {\n  AIFeatureFlags,\n  Profile,\n  CreateUserPreferenceRequest,\n  UpdateUserPreferenceRequest,\n} from './services/config/types';\nimport {PaginatedResponse, BaseSearchParams} from './utils/PageCache';\n\n/**\n * Generic type for converting a const enum object into a union type of its values.\n * @template T The enum object type\n * @internal\n * @ignore\n */\ntype Enum<T extends Record<string, unknown>> = T[keyof T];\n\n/**\n * HTTP methods supported by WebexRequest.\n * @enum {string}\n * @public\n * @example\n * const method: HTTP_METHODS = HTTP_METHODS.GET;\n * @ignore\n */\nexport const HTTP_METHODS = {\n  /** HTTP GET method for retrieving data */\n  GET: 'GET',\n  /** HTTP POST method for creating resources */\n  POST: 'POST',\n  /** HTTP PATCH method for partial updates */\n  PATCH: 'PATCH',\n  /** HTTP PUT method for complete updates */\n  PUT: 'PUT',\n  /** HTTP DELETE method for removing resources */\n  DELETE: 'DELETE',\n} as const;\n\n/**\n * Union type of HTTP methods.\n * @public\n * @example\n * function makeRequest(method: HTTP_METHODS) { ... }\n * @ignore\n */\nexport type HTTP_METHODS = Enum<typeof HTTP_METHODS>;\n\n/**\n * Payload for making requests to Webex APIs.\n * @public\n * @example\n * const payload: WebexRequestPayload = {\n *   service: 'identity',\n *   resource: '/users',\n *   method: HTTP_METHODS.GET\n * };\n * @ignore\n */\nexport type WebexRequestPayload = {\n  /** Service name to target */\n  service?: string;\n  /** Resource path within the service */\n  resource?: string;\n  /** HTTP method to use */\n  method?: HTTP_METHODS;\n  /** Full URI if not using service/resource pattern */\n  uri?: string;\n  /** Whether to add authorization header */\n  addAuthHeader?: boolean;\n  /** Custom headers to include in request */\n  headers?: {\n    [key: string]: string | null;\n  };\n  /** Request body data */\n  body?: object;\n  /** Expected response status code */\n  statusCode?: number;\n  /** Whether to parse response as JSON */\n  json?: boolean;\n};\n\n/**\n * Event listener function type.\n * @internal\n * @ignore\n */\ntype Listener = (e: string, data?: unknown) => void;\n\n/**\n * Mercury event handler callback.\n * @internal\n * @ignore\n */\ntype MercuryEventHandler = (data?: unknown) => void;\n\n/**\n * Event listener removal function type.\n * @internal\n * @ignore\n */\ntype ListenerOff = (e: string, handler?: MercuryEventHandler) => void;\n\n/**\n * Service host configuration.\n * @internal\n * @ignore\n */\ntype ServiceHost = {\n  /** Host URL/domain for the service */\n  host: string;\n  /** Time-to-live in seconds */\n  ttl: number;\n  /** Priority level for load balancing (lower is higher priority) */\n  priority: number;\n  /** Unique identifier for this host */\n  id: string;\n  /** Whether this is the home cluster for the user */\n  homeCluster?: boolean;\n};\n\n/**\n * Configuration options for the Contact Center Plugin.\n * @interface CCPluginConfig\n * @public\n * @example\n * const config: CCPluginConfig = {\n *   allowMultiLogin: true,\n *   allowAutomatedRelogin: false,\n *   clientType: 'browser',\n *   isKeepAliveEnabled: true,\n *   force: false,\n *   metrics: { clientName: 'myClient', clientType: 'browser' },\n *   logging: { enable: true, verboseEvents: false },\n *   callingClientConfig: { ... }\n * };\n */\nexport interface CCPluginConfig {\n  /** Whether to allow multiple logins from different devices */\n  allowMultiLogin: boolean;\n  /** Whether to automatically attempt relogin on connection loss */\n  allowAutomatedRelogin: boolean;\n  /** The type of client making the connection */\n  clientType: string;\n  /** Whether to enable keep-alive messages */\n  isKeepAliveEnabled: boolean;\n  /** Whether to force registration */\n  force: boolean;\n  /** Metrics configuration */\n  metrics: {\n    /** Name of the client for metrics */\n    clientName: string;\n    /** Type of client for metrics */\n    clientType: string;\n  };\n  /** Logging configuration */\n  logging: {\n    /** Whether to enable logging */\n    enable: boolean;\n    /** Whether to log verbose events */\n    verboseEvents: boolean;\n  };\n  /** Configuration for the calling client */\n  callingClientConfig: CallingClientConfig;\n  /** Whether to skip Mobius/WebRTC registration for browser login flows */\n  disableWebRTCRegistration?: boolean;\n  /** Whether wxApp Better Together (telephony REST + usersub) is enabled at init (WXCC-6026) */\n  enableWxBetterTogether?: boolean;\n}\n\n/**\n * Logger interface for standardized logging throughout the plugin.\n * @public\n * @example\n * logger.log('This is a log message');\n * logger.error('This is an error message');\n * @ignore\n */\nexport type Logger = {\n  /** Log general messages */\n  log: (payload: string) => void;\n  /** Log error messages */\n  error: (payload: string) => void;\n  /** Log warning messages */\n  warn: (payload: string) => void;\n  /** Log informational messages */\n  info: (payload: string) => void;\n  /** Log detailed trace messages */\n  trace: (payload: string) => void;\n  /** Log debug messages */\n  debug: (payload: string) => void;\n};\n\n/**\n * Contextual information for log entries.\n * @public\n * @ignore\n */\nexport interface LogContext {\n  /** Module name where the log originated */\n  module?: string;\n  /** Method name where the log originated */\n  method?: string;\n  interactionId?: string;\n  trackingId?: string;\n  /** Additional structured data to include in logs */\n  data?: Record<string, any>;\n  /** Error object to include in logs */\n  error?: Error | unknown;\n}\n\n/**\n * Available logging severity levels.\n * @enum {string}\n * @public\n * @example\n * const level: LOGGING_LEVEL = LOGGING_LEVEL.error;\n * @ignore\n */\nexport enum LOGGING_LEVEL {\n  /** Critical failures that require immediate attention */\n  error = 'ERROR',\n  /** Important issues that don't prevent the system from working */\n  warn = 'WARN',\n  /** General informational logs */\n  log = 'LOG',\n  /** Detailed information about system operation */\n  info = 'INFO',\n  /** Highly detailed diagnostic information */\n  trace = 'TRACE',\n}\n\n/**\n * Metadata for log uploads.\n * @public\n * @example\n * const meta: LogsMetaData = { feedbackId: 'fb123', correlationId: 'corr456' };\n * @ignore\n */\nexport type LogsMetaData = {\n  /** Optional feedback ID to associate with logs */\n  feedbackId?: string;\n  /** Optional correlation ID to track related operations */\n  correlationId?: string;\n};\n\n/**\n * Response from uploading logs to the server.\n * @public\n * @example\n * const response: UploadLogsResponse = { trackingid: 'track123', url: 'https://...', userId: 'user1' };\n */\nexport type UploadLogsResponse = {\n  /** Tracking ID for the upload request */\n  trackingid?: string;\n  /** URL where the logs can be accessed */\n  url?: string;\n  /** ID of the user who uploaded logs */\n  userId?: string;\n  /** Feedback ID associated with the logs */\n  feedbackId?: string;\n  /** Correlation ID for tracking related operations */\n  correlationId?: string;\n};\n\n/**\n * Internal Webex SDK interfaces needed for plugin integration.\n * @internal\n * @ignore\n */\ninterface IWebexInternal {\n  /** Mercury service for real-time messaging */\n  mercury: {\n    /** Register an event listener */\n    on: Listener;\n    /** Remove an event listener */\n    off: ListenerOff;\n    /** Establish a connection to the Mercury service */\n    connect: () => Promise<void>;\n    /** Disconnect from the Mercury service */\n    disconnect: () => Promise<void>;\n    /** Whether Mercury is currently connected */\n    connected: boolean;\n    /** Whether Mercury is in the process of connecting */\n    connecting: boolean;\n  };\n  /** Device information */\n  device: {\n    /** Current WDM URL */\n    url: string;\n    /** Current user's ID */\n    userId: string;\n    /** Current organization ID */\n    orgId: string;\n    /** Device version */\n    version: string;\n    /** Calling behavior configuration */\n    callingBehavior: string;\n    /** Whether the device is registered with WDM */\n    registered?: boolean;\n    /** Register the device with WDM */\n    register?: () => Promise<void>;\n    /** Unregister the device from WDM */\n    unregister?: () => Promise<void>;\n  };\n  /** Presence service */\n  presence: unknown;\n  /** Services discovery and management */\n  services: {\n    /** Get a service URL by name */\n    get: (service: string) => string;\n    /** Wait for service catalog to be loaded */\n    waitForCatalog: (service: string) => Promise<void>;\n    /** Check if current environment is INT (integration) */\n    isIntegrationEnvironment: () => boolean;\n    /** Host catalog for service discovery */\n    _hostCatalog: Record<string, ServiceHost[]>;\n    /** Service URLs cache */\n    _serviceUrls: {\n      /** Mobius calling service */\n      mobius: string;\n      /** Identity service */\n      identity: string;\n      /** Janus media server */\n      janus: string;\n      /** WDM (WebEx Device Management) service */\n      wdm: string;\n      /** BroadWorks IDP proxy service */\n      broadworksIdpProxy: string;\n      /** Hydra API service */\n      hydra: string;\n      /** Mercury API service */\n      mercuryApi: string;\n      /** UC Management gateway service */\n      'ucmgmt-gateway': string;\n      /** Contacts service */\n      contactsService: string;\n    };\n  };\n  /** Metrics collection services */\n  newMetrics: {\n    /** Submit behavioral events (user actions) */\n    submitBehavioralEvent: SubmitBehavioralEvent;\n    /** Submit operational events (system operations) */\n    submitOperationalEvent: SubmitOperationalEvent;\n    /** Submit business events (business outcomes) */\n    submitBusinessEvent: SubmitBusinessEvent;\n  };\n  /** Support functionality */\n  support: {\n    /** Submit logs to server */\n    submitLogs: (\n      metaData: LogsMetaData,\n      logs: string,\n      options: {\n        /** Whether to submit full logs or just differences */\n        type: 'diff' | 'full';\n      }\n    ) => Promise<UploadLogsResponse>;\n  };\n}\n\n/**\n * Interface representing the WebexSDK core functionality.\n * @interface WebexSDK\n * @public\n * @example\n * const sdk: WebexSDK = ...;\n * sdk.request({ service: 'identity', resource: '/users', method: HTTP_METHODS.GET });\n * @ignore\n */\nexport interface WebexSDK {\n  /** Version of the WebexSDK */\n  version: string;\n  /** Whether the SDK can authorize requests */\n  canAuthorize: boolean;\n  /** Credentials management */\n  credentials: {\n    /** Get the user token for authentication */\n    getUserToken: () => Promise<string>;\n    /** Get the organization ID */\n    getOrgId: () => string;\n  };\n  /** Whether the SDK is ready for use */\n  ready: boolean;\n  /** Make a request to the Webex APIs */\n  request: <T>(payload: WebexRequestPayload) => Promise<T>;\n  /** Register a one-time event handler */\n  once: (event: string, callBack: () => void) => void;\n  /** Internal plugins and services */\n  internal: IWebexInternal;\n  /** Logger instance */\n  logger: Logger;\n}\n\n/**\n * An interface for the `ContactCenter` class.\n * The `ContactCenter` package is designed to provide a set of APIs to perform various operations for the Agent flow within Webex Contact Center.\n * @public\n * @example\n * const cc: IContactCenter = ...;\n * cc.register().then(profile => { ... });\n * @ignore\n */\nexport interface IContactCenter {\n  /**\n   * Initialize the CC SDK by setting up the contact center mercury connection.\n   * This establishes WebSocket connectivity for real-time communication.\n   *\n   * @returns A Promise that resolves to the agent's profile upon successful registration\n   * @public\n   * @example\n   * cc.register().then(profile => { ... });\n   */\n  register(): Promise<Profile>;\n}\n\n/**\n * Generic HTTP response structure.\n * @public\n * @example\n * const response: IHttpResponse = { body: {}, statusCode: 200, method: 'GET', headers: {}, url: '...' };\n * @ignore\n */\nexport interface IHttpResponse {\n  /** Response body content */\n  body: any;\n  /** HTTP status code */\n  statusCode: number;\n  /** HTTP method used for the request */\n  method: string;\n  /** Response headers */\n  headers: Headers;\n  /** Request URL */\n  url: string;\n}\n\n/**\n * Supported login options for agent authentication.\n * @public\n * @example\n * const option: LoginOption = LoginOption.AGENT_DN;\n * @ignore\n */\nexport const LoginOption = {\n  /** Login using agent's direct number */\n  AGENT_DN: 'AGENT_DN',\n  /** Login using an extension number */\n  EXTENSION: 'EXTENSION',\n  /** Login using browser WebRTC capabilities */\n  BROWSER: 'BROWSER',\n} as const;\n\n/**\n * Union type of login options.\n * @public\n * @example\n * function login(option: LoginOption) { ... }\n * @ignore\n */\nexport type LoginOption = Enum<typeof LoginOption>;\n\n/**\n * Request payload for subscribing to the contact center websocket.\n * @public\n * @example\n * const req: SubscribeRequest = { force: true, isKeepAliveEnabled: true, clientType: 'browser', allowMultiLogin: false };\n * @ignore\n */\nexport type SubscribeRequest = {\n  /** Whether to force connection even if another exists */\n  force: boolean;\n  /** Whether to send keepalive messages */\n  isKeepAliveEnabled: boolean;\n  /** Type of client connecting */\n  clientType: string;\n  /** Whether to allow login from multiple devices */\n  allowMultiLogin: boolean;\n};\n\n/**\n * Represents the response from getListOfTeams method.\n * Teams are groups of agents that can be managed together.\n * @public\n * @example\n * const team: Team = { id: 'team1', name: 'Support', desktopLayoutId: 'layout1' };\n * @ignore\n */\nexport type Team = {\n  /**\n   * Unique identifier of the team.\n   */\n  id: string;\n\n  /**\n   * Display name of the team.\n   */\n  name: string;\n\n  /**\n   * Associated desktop layout ID for the team.\n   * Controls how the agent desktop is displayed for team members.\n   */\n  desktopLayoutId?: string;\n};\n\n/**\n * Represents the request to perform agent login.\n * @public\n * @example\n * const login: AgentLogin = { dialNumber: '1234', teamId: 'team1', loginOption: LoginOption.AGENT_DN };\n */\nexport type AgentLogin = {\n  /**\n   * A dialNumber field contains the number to dial such as a route point or extension.\n   * Required for AGENT_DN and EXTENSION login options.\n   */\n  dialNumber?: string;\n\n  /**\n   * The unique ID representing a team of users.\n   * The agent must belong to this team.\n   */\n  teamId: string;\n\n  /**\n   * The loginOption field specifies the type of login method.\n   * Controls how calls are delivered to the agent.\n   */\n  loginOption: LoginOption;\n};\n\n/**\n * Represents the request to update agent profile settings.\n * @public\n * @example\n * const update: AgentProfileUpdate = { loginOption: LoginOption.BROWSER, dialNumber: '5678' };\n */\nexport type AgentProfileUpdate = Pick<AgentLogin, 'loginOption' | 'dialNumber' | 'teamId'>;\n\n/**\n * Union type for all possible request body types.\n * @internal\n * @ignore\n */\nexport type RequestBody =\n  | SubscribeRequest\n  | Agent.Logout\n  | Agent.UserStationLogin\n  | Agent.StateChange\n  | Agent.BuddyAgents\n  | Contact.HoldResumePayload\n  | Contact.ResumeRecordingPayload\n  | Contact.ConsultPayload\n  | Contact.ConsultEndAPIPayload // API Payload accepts only QueueId wheres SDK API allows more params\n  | Contact.TransferPayLoad\n  | Contact.ConsultTransferPayLoad\n  | Contact.cancelCtq\n  | Contact.WrapupPayLoad\n  | Contact.DialerPayload\n  | Contact.PreviewContactPayload\n  | CreateUserPreferenceRequest\n  | UpdateUserPreferenceRequest;\n\n/**\n * Represents the options to fetch buddy agents for the logged in agent.\n * Buddy agents are other agents who can be consulted or transferred to.\n * @public\n * @example\n * const opts: BuddyAgents = { mediaType: 'telephony', state: 'Available' };\n */\nexport type BuddyAgents = {\n  /**\n   * The media type channel to filter buddy agents. Defaults to telephony when omitted.\n   */\n  mediaType?: 'telephony' | 'chat' | 'social' | 'email';\n\n  /**\n   * Optional filter for agent state.\n   * If specified, returns only agents in that state.\n   * If omitted, returns both available and idle agents.\n   */\n  state?: 'Available' | 'Idle';\n\n  /**\n   * Applies the default state policy for the operation. An explicit state takes precedence.\n   */\n  action?: 'Consult' | 'Transfer';\n};\n\n/**\n * Holds the configuration flags for the Agent.\n * These flags determine the availability of certain features in the Agent UI.\n * @internal\n */\nexport type ConfigFlags = {\n  isEndTaskEnabled: boolean;\n  isEndConsultEnabled: boolean;\n  webRtcEnabled: boolean;\n  autoWrapup: boolean;\n  aiFeature?: AIFeatureFlags;\n  /** Agent-profile policy used to derive task consult/transfer destination controls. */\n  consultTransfer?: Contact.ConsultTransferDestinationConfig;\n  /**\n   * Optional toggle to globally enable/disable recording controls.\n   * Falls back to backend hints when omitted.\n   */\n  isRecordingEnabled?: boolean;\n  /** Whether wxApp thick-client answer controls/APIs are enabled (WXCC-6026) */\n  enableWxBetterTogether?: boolean;\n};\n\n/**\n\n * Generic error structure for Contact Center SDK errors.\n * Contains detailed information about the error context.\n * @public\n * @example\n * const err: GenericError = new Error('Failed');\n * err.details = { type: 'ERR', orgId: 'org1', trackingId: 'track1', data: {} };\n * @ignore\n */\nexport interface GenericError extends Error {\n  /** Structured details about the error */\n  details: {\n    /** Error type identifier */\n    type: string;\n    /** Organization ID where the error occurred */\n    orgId: string;\n    /** Unique tracking ID for the error */\n    trackingId: string;\n    /** Additional error context data */\n    data: Record<string, any>;\n  };\n}\n\n/**\n * Response type for station login operations.\n * Either a success response with agent details or an error.\n * @public\n * @example\n * function handleLogin(resp: StationLoginResponse) { ... }\n */\nexport type StationLoginResponse = Agent.StationLoginSuccessResponse | Error;\n\n/**\n * Response type for station logout operations.\n * Either a success response with logout details or an error.\n * @public\n * @example\n * function handleLogout(resp: StationLogoutResponse) { ... }\n */\nexport type StationLogoutResponse = Agent.LogoutSuccess | Error;\n\n/**\n * Response type for station relogin operations.\n * Either a success response with relogin details or an error.\n * @public\n * @example\n * function handleReLogin(resp: StationReLoginResponse) { ... }\n * @ignore\n */\nexport type StationReLoginResponse = Agent.ReloginSuccess | Error;\n\n/**\n * Response type for agent state change operations.\n * Either a success response with state change details or an error.\n * @public\n * @example\n * function handleStateChange(resp: SetStateResponse) { ... }\n * @ignore\n */\nexport type SetStateResponse = Agent.StateChangeSuccess | Error;\n\n/**\n * AddressBook types\n */\nexport interface AddressBookEntry {\n  id: string;\n  organizationId?: string;\n  version?: number;\n  name: string;\n  number: string;\n  createdTime?: number;\n  lastUpdatedTime?: number;\n}\n\nexport type AddressBookEntriesResponse = PaginatedResponse<AddressBookEntry>;\n\nexport interface AddressBookEntrySearchParams extends BaseSearchParams {\n  addressBookId?: string;\n}\n\n/**\n * EntryPointRecord types\n */\nexport interface EntryPointRecord {\n  id: string;\n  name: string;\n  /** Dialled number mapped to this entry point when included in the list response. */\n  number?: string;\n  description?: string;\n  type?: string;\n  isActive?: boolean;\n  orgId?: string;\n  createdAt?: string;\n  updatedAt?: string;\n  settings?: Record<string, any>;\n}\n\nexport type EntryPointListResponse = PaginatedResponse<EntryPointRecord>;\nexport type EntryPointSearchParams = BaseSearchParams;\n\n/**\n * Queue types\n */\nexport interface QueueSkillRequirement {\n  organizationId?: string;\n  id?: string;\n  version?: number;\n  skillId: string;\n  skillName?: string;\n  skillType?: string;\n  condition: string;\n  skillValue: string;\n  createdTime?: number;\n  lastUpdatedTime?: number;\n}\n\nexport interface QueueAgent {\n  id: string;\n  ciUserId?: string;\n}\n\nexport interface AgentGroup {\n  teamId: string;\n}\n\nexport interface CallDistributionGroup {\n  agentGroups: AgentGroup[];\n  order: number;\n  duration?: number;\n}\n\nexport interface AssistantSkillMapping {\n  assistantSkillId?: string;\n  assistantSkillUpdatedTime?: number;\n}\n\n/**\n * Configuration for a contact service queue\n * @public\n */\nexport interface ContactServiceQueue {\n  /** Organization ID */\n  organizationId?: string;\n  /** Unique identifier for the queue */\n  id?: string;\n  /** Version of the queue */\n  version?: number;\n  /** Name of the Contact Service Queue */\n  name: string;\n  /** Description of the queue */\n  description?: string;\n  /** Queue type (INBOUND, OUTBOUND) */\n  queueType: 'INBOUND' | 'OUTBOUND';\n  /** Whether to check agent availability */\n  checkAgentAvailability: boolean;\n  /** Channel type (TELEPHONY, EMAIL, SOCIAL_CHANNEL, CHAT, etc.) */\n  channelType: 'TELEPHONY' | 'EMAIL' | 'FAX' | 'CHAT' | 'VIDEO' | 'OTHERS' | 'SOCIAL_CHANNEL';\n  /** Social channel type for SOCIAL_CHANNEL channelType */\n  socialChannelType?:\n    | 'MESSAGEBIRD'\n    | 'MESSENGER'\n    | 'WHATSAPP'\n    | 'APPLE_BUSINESS_CHAT'\n    | 'GOOGLE_BUSINESS_MESSAGES';\n  /** Service level threshold in seconds */\n  serviceLevelThreshold: number;\n  /** Maximum number of simultaneous contacts */\n  maxActiveContacts: number;\n  /** Maximum time in queue in seconds */\n  maxTimeInQueue: number;\n  /** Default music in queue media file ID */\n  defaultMusicInQueueMediaFileId: string;\n  /** Timezone for routing strategies */\n  timezone?: string;\n  /** Whether the queue is active */\n  active: boolean;\n  /** Whether outdial campaign is enabled */\n  outdialCampaignEnabled?: boolean;\n  /** Whether monitoring is permitted */\n  monitoringPermitted: boolean;\n  /** Whether parking is permitted */\n  parkingPermitted: boolean;\n  /** Whether recording is permitted */\n  recordingPermitted: boolean;\n  /** Whether recording all calls is permitted */\n  recordingAllCallsPermitted: boolean;\n  /** Whether pausing recording is permitted */\n  pauseRecordingPermitted: boolean;\n  /** Recording pause duration in seconds */\n  recordingPauseDuration?: number;\n  /** Control flow script URL */\n  controlFlowScriptUrl: string;\n  /** IVR requeue URL */\n  ivrRequeueUrl: string;\n  /** Overflow number for telephony */\n  overflowNumber?: string;\n  /** Vendor ID */\n  vendorId?: string;\n  /** Routing type */\n  routingType: 'LONGEST_AVAILABLE_AGENT' | 'SKILLS_BASED' | 'CIRCULAR' | 'LINEAR';\n  /** Skills-based routing type */\n  skillBasedRoutingType?: 'LONGEST_AVAILABLE_AGENT' | 'BEST_AVAILABLE_AGENT';\n  /** Queue routing type */\n  queueRoutingType: 'TEAM_BASED' | 'SKILL_BASED' | 'AGENT_BASED';\n  /** Queue skill requirements */\n  queueSkillRequirements?: QueueSkillRequirement[];\n  /** List of agents for agent-based queue */\n  agents?: QueueAgent[];\n  /** Call distribution groups */\n  callDistributionGroups: CallDistributionGroup[];\n  /** XSP version */\n  xspVersion?: string;\n  /** Subscription ID */\n  subscriptionId?: string;\n  /** Assistant skill mapping */\n  assistantSkill?: AssistantSkillMapping;\n  /** Whether this is a system default queue */\n  systemDefault?: boolean;\n  /** User who last updated agents list */\n  agentsLastUpdatedByUserName?: string;\n  /** Email of user who last updated agents list */\n  agentsLastUpdatedByUserEmailPrefix?: string;\n  /** When agents list was last updated */\n  agentsLastUpdatedTime?: number;\n  /** Creation timestamp in epoch millis */\n  createdTime?: number;\n  /** Last updated timestamp in epoch millis */\n  lastUpdatedTime?: number;\n}\n\nexport type ContactServiceQueuesResponse = PaginatedResponse<ContactServiceQueue>;\n\nexport interface ContactServiceQueueSearchParams extends BaseSearchParams {\n  desktopProfileFilter?: boolean;\n  provisioningView?: boolean;\n  singleObjectResponse?: boolean;\n}\n\n/**\n * Response type for buddy agents query operations.\n * Either a success response with list of buddy agents or an error.\n * @public\n * @example\n * function handleBuddyAgents(resp: BuddyAgentsResponse) { ... }\n */\nexport type BuddyAgentsResponse = Agent.BuddyAgentsSuccess | Error;\n\n/**\n * Response type for device type update operations.\n * Either a success response with update confirmation or an error.\n * @public\n * @example\n * function handleUpdateDeviceType(resp: UpdateDeviceTypeResponse) { ... }\n */\nexport type UpdateDeviceTypeResponse = Agent.DeviceTypeUpdateSuccess | Error;\n\n/**\n * Supported transcript control actions for AI Assistant events.\n * @public\n * @example\n * const action: TranscriptAction = 'START';\n * @ignore\n */\nexport type TranscriptAction = 'START' | 'STOP';\n\n/**\n * Parameters used to request AI Assistant real-time assistance.\n * @public\n * @example\n * const params: RealTimeAssistanceParams = {\n *   interactionId: 'interaction-123',\n *   context: 'Need help with credit card payment due date',\n * };\n */\nexport type RealTimeAssistanceParams = {\n  /** Agent identifier */\n  agentId: string;\n  /** Interaction identifier for which assistance should be generated */\n  interactionId: string;\n  /** Optional additional context that should refine the assistance */\n  context?: string;\n  /** Optional language code for assistance (for example, 'en'). Defaults to 'en'. */\n  languageCode?: string;\n};\n\n/**\n * Supported user actions on an AI Assistant real-time assistance adaptive card.\n * @public\n */\nexport const RealTimeAssistanceUserActionId = {\n  /** User liked the real-time assistance response */\n  LIKE: 'likeButton',\n  /** User disliked the real-time assistance response */\n  DISLIKE: 'dislikeButton',\n  /** User copied the real-time assistance response */\n  COPY: 'copyButton',\n} as const;\n\n/**\n * Union type of supported real-time assistance user actions.\n * @public\n */\nexport type RealTimeAssistanceUserActionId = Enum<typeof RealTimeAssistanceUserActionId>;\n\n/**\n * Parameters used to send user action feedback for a real-time assistance adaptive card.\n * @public\n * @example\n * const params: RealTimeAssistanceUserActionParams = {\n *   agentId: 'agent-123',\n *   interactionId: 'interaction-123',\n *   adaptiveCardId: 'adaptive-card-123',\n *   actionId: RealTimeAssistanceUserActionId.LIKE,\n * };\n */\nexport type RealTimeAssistanceUserActionParams = {\n  /** Agent identifier */\n  agentId: string;\n  /** Interaction identifier associated with the real-time assistance response */\n  interactionId: string;\n  /** Adaptive card identifier from the real-time assistance payload */\n  adaptiveCardId: string;\n  /** User action performed on the adaptive card */\n  actionId: RealTimeAssistanceUserActionId;\n  /** Optional language code. Defaults to 'en'. */\n  languageCode?: string;\n};\n\n/**\n * Supported AI Assistant event categories.\n * @public\n * @example\n * const eventType: AIAssistantEventType = AIAssistantEventType.CUSTOM_EVENT;\n * @ignore\n */\nexport const AIAssistantEventType = {\n  /** Custom AI Assistant event */\n  CUSTOM_EVENT: 'CUSTOM_EVENT',\n  /** CTI-backed AI Assistant event */\n  CTI_EVENT: 'CTI_EVENT',\n} as const;\n\n/**\n * Union type of AI Assistant event categories.\n * @public\n * @example\n * function send(type: AIAssistantEventType) { ... }\n * @ignore\n */\nexport type AIAssistantEventType = Enum<typeof AIAssistantEventType>;\n\n/**\n * Supported AI Assistant event names.\n * @public\n * @example\n * const name: AIAssistantEventName = AIAssistantEventName.GET_TRANSCRIPTS;\n * @ignore\n */\nexport const AIAssistantEventName = {\n  /** Request transcript streaming for an interaction */\n  GET_TRANSCRIPTS: 'GET_TRANSCRIPTS',\n  /** Request a suggested response for an interaction */\n  GET_SUGGESTIONS: 'GET_SUGGESTIONS',\n  /** Add extra context to refine a suggested response */\n  ADD_SUGGESTIONS_EXTRA_CONTEXT: 'ADD_SUGGESTIONS_EXTRA_CONTEXT',\n  /** Request mid-call summary generation */\n  GET_MID_CALL_SUMMARY: 'GET_MID_CALL_SUMMARY',\n  /** Request post-call summary generation */\n  GET_POST_CALL_SUMMARY: 'GET_POST_CALL_SUMMARY',\n  /** Mid-call summary response event */\n  MID_CALL_SUMMARY_RESPONSE: 'MID_CALL_SUMMARY_RESPONSE',\n  /** Post-call summary response event */\n  POST_CALL_SUMMARY_RESPONSE: 'POST_CALL_SUMMARY_RESPONSE',\n  /** Suggested digital response event */\n  SUGGESTED_RESPONSES_DIGITAL: 'SUGGESTED_RESPONSES_DIGITAL',\n  /** User action on a suggested response adaptive card */\n  SUGGESTED_RESPONSES_USER_ACTION: 'SUGGESTED_RESPONSES_USER_ACTION',\n} as const;\n\n/**\n * Union type of AI Assistant event names.\n * @public\n * @example\n * function handle(name: AIAssistantEventName) { ... }\n * @ignore\n */\nexport type AIAssistantEventName = Enum<typeof AIAssistantEventName>;\n\n/**\n * A single transcript message entry returned by AI Assistant APIs.\n * @public\n * @example\n * const message: TranscriptMessage = { role: 'AGENT', content: 'Hello', messageId: '1', publishTimestamp: Date.now() };\n *\n */\nexport type TranscriptMessage = {\n  /** Speaker role for this message */\n  role: string;\n  /** Transcript chunk content */\n  content: string;\n  /** Unique message identifier */\n  messageId: string;\n  /** Message publish timestamp (epoch milliseconds) */\n  publishTimestamp: number;\n};\n\n/**\n * Response payload for historic transcripts API.\n * @public\n * @example\n * const resp: HistoricTranscriptsResponse = { orgId: 'org', agentId: 'agent', conversationId: null, interactionId: 'int', source: 'AI', data: [] };\n *\n */\nexport type HistoricTranscriptsResponse = {\n  /** Organization identifier */\n  orgId: string;\n  /** Agent identifier */\n  agentId: string;\n  /** Conversation identifier when available */\n  conversationId: string | null;\n  /** Interaction identifier */\n  interactionId: string;\n  /** Data source identifier */\n  source: string;\n  /** Transcript messages */\n  data: TranscriptMessage[];\n};\n"],"mappings":";;;;;;AAgBA;AACA;AACA;AACA;AACA;AACA;;AAGA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,MAAMA,YAAY,GAAAC,OAAA,CAAAD,YAAA,GAAG;EAC1B;EACAE,GAAG,EAAE,KAAK;EACV;EACAC,IAAI,EAAE,MAAM;EACZ;EACAC,KAAK,EAAE,OAAO;EACd;EACAC,GAAG,EAAE,KAAK;EACV;EACAC,MAAM,EAAE;AACV,CAAU;;AAEV;AACA;AACA;AACA;AACA;AACA;AACA;;AAGA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAwBA;AACA;AACA;AACA;AACA;;AAGA;AACA;AACA;AACA;AACA;;AAGA;AACA;AACA;AACA;AACA;;AAGA;AACA;AACA;AACA;AACA;;AAcA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAkCA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAgBA;AACA;AACA;AACA;AACA;AAcA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AAPA,IAQYC,aAAa,GAAAN,OAAA,CAAAM,aAAA,0BAAbA,aAAa;EACvB;EADUA,aAAa;EAGvB;EAHUA,aAAa;EAKvB;EALUA,aAAa;EAOvB;EAPUA,aAAa;EASvB;EATUA,aAAa;EAAA,OAAbA,aAAa;AAAA;AAazB;AACA;AACA;AACA;AACA;AACA;AACA;AAQA;AACA;AACA;AACA;AACA;AACA;AAcA;AACA;AACA;AACA;AACA;AA6FA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AAyBA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AAcA;AACA;AACA;AACA;AACA;AACA;AACA;AAcA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,MAAMC,WAAW,GAAAP,OAAA,CAAAO,WAAA,GAAG;EACzB;EACAC,QAAQ,EAAE,UAAU;EACpB;EACAC,SAAS,EAAE,WAAW;EACtB;EACAC,OAAO,EAAE;AACX,CAAU;;AAEV;AACA;AACA;AACA;AACA;AACA;AACA;;AAGA;AACA;AACA;AACA;AACA;AACA;AACA;;AAYA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAmBA;AACA;AACA;AACA;AACA;AACA;;AAqBA;AACA;AACA;AACA;AACA;AACA;;AAGA;AACA;AACA;AACA;AACA;;AAoBA;AACA;AACA;AACA;AACA;AACA;AACA;;AAoBA;AACA;AACA;AACA;AACA;;AAkBA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAeA;AACA;AACA;AACA;AACA;AACA;AACA;;AAGA;AACA;AACA;AACA;AACA;AACA;AACA;;AAGA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAGA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAGA;AACA;AACA;;AAiBA;AACA;AACA;;AAkBA;AACA;AACA;;AAkCA;AACA;AACA;AACA;;AAmGA;AACA;AACA;AACA;AACA;AACA;AACA;;AAGA;AACA;AACA;AACA;AACA;AACA;AACA;;AAGA;AACA;AACA;AACA;AACA;AACA;AACA;;AAGA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAYA;AACA;AACA;AACA;AACO,MAAMC,8BAA8B,GAAAX,OAAA,CAAAW,8BAAA,GAAG;EAC5C;EACAC,IAAI,EAAE,YAAY;EAClB;EACAC,OAAO,EAAE,eAAe;EACxB;EACAC,IAAI,EAAE;AACR,CAAU;;AAEV;AACA;AACA;AACA;;AAGA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAcA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,MAAMC,oBAAoB,GAAAf,OAAA,CAAAe,oBAAA,GAAG;EAClC;EACAC,YAAY,EAAE,cAAc;EAC5B;EACAC,SAAS,EAAE;AACb,CAAU;;AAEV;AACA;AACA;AACA;AACA;AACA;AACA;;AAGA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,MAAMC,oBAAoB,GAAAlB,OAAA,CAAAkB,oBAAA,GAAG;EAClC;EACAC,eAAe,EAAE,iBAAiB;EAClC;EACAC,eAAe,EAAE,iBAAiB;EAClC;EACAC,6BAA6B,EAAE,+BAA+B;EAC9D;EACAC,oBAAoB,EAAE,sBAAsB;EAC5C;EACAC,qBAAqB,EAAE,uBAAuB;EAC9C;EACAC,yBAAyB,EAAE,2BAA2B;EACtD;EACAC,0BAA0B,EAAE,4BAA4B;EACxD;EACAC,2BAA2B,EAAE,6BAA6B;EAC1D;EACAC,+BAA+B,EAAE;AACnC,CAAU;;AAEV;AACA;AACA;AACA;AACA;AACA;AACA;;AAGA;AACA;AACA;AACA;AACA;AACA;AACA;;AAYA;AACA;AACA;AACA;AACA;AACA;AACA","ignoreList":[]}

package/dist/utils/PageCache.js

@@ -61,8 +61,18 @@ const DEFAULT_CACHE_TTL_MINUTES = 5;
  * // 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);
  *
@@ -88,7 +98,8 @@ class PageCache {
 
   /**
    * 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
@@ -98,9 +109,12 @@ class PageCache {
       search,
       filter,
       attributes,
-      sortBy
+      sortBy,
+      desktopProfileFilter,
+      provisioningView,
+      singleObjectResponse
     } = params;
-    return !search && !filter && !attributes && !sortBy;
+    return !search && !filter && !attributes && !sortBy && !desktopProfileFilter && !provisioningView && !singleObjectResponse;
   }
 
   /**