@webex/contact-center 3.8.1 → 3.9.0-multi-llms.2

package/dist/types/types.d.ts

@@ -1,6 +1,7 @@
 import { CallingClientConfig } from '@webex/calling';
 import * as Agent from './services/agent/types';
 import { Profile } from './services/config/types';
+import { PaginatedResponse, BaseSearchParams } from './utils/PageCache';
 /**
  * HTTP methods supported by WebexRequest.
  * @enum {string}
@@ -140,6 +141,10 @@ export interface LogContext {
     method?: string;
     interactionId?: string;
     trackingId?: string;
+    /** Additional structured data to include in logs */
+    data?: Record<string, any>;
+    /** Error object to include in logs */
+    error?: Error | unknown;
 }
 /**
  * Available logging severity levels.
@@ -434,6 +439,163 @@ export type StationReLoginResponse = Agent.ReloginSuccess | Error;
  * @ignore
  */
 export type SetStateResponse = Agent.StateChangeSuccess | Error;
+/**
+ * AddressBook types
+ */
+export interface AddressBookEntry {
+    id: string;
+    organizationId?: string;
+    version?: number;
+    name: string;
+    number: string;
+    createdTime?: number;
+    lastUpdatedTime?: number;
+}
+export type AddressBookEntriesResponse = PaginatedResponse<AddressBookEntry>;
+export interface AddressBookEntrySearchParams extends BaseSearchParams {
+    addressBookId?: string;
+}
+/**
+ * EntryPointRecord types
+ */
+export interface EntryPointRecord {
+    id: string;
+    name: string;
+    description?: string;
+    type: string;
+    isActive: boolean;
+    orgId: string;
+    createdAt?: string;
+    updatedAt?: string;
+    settings?: Record<string, any>;
+}
+export type EntryPointListResponse = PaginatedResponse<EntryPointRecord>;
+export type EntryPointSearchParams = BaseSearchParams;
+/**
+ * Queue types
+ */
+export interface QueueSkillRequirement {
+    organizationId?: string;
+    id?: string;
+    version?: number;
+    skillId: string;
+    skillName?: string;
+    skillType?: string;
+    condition: string;
+    skillValue: string;
+    createdTime?: number;
+    lastUpdatedTime?: number;
+}
+export interface QueueAgent {
+    id: string;
+    ciUserId?: string;
+}
+export interface AgentGroup {
+    teamId: string;
+}
+export interface CallDistributionGroup {
+    agentGroups: AgentGroup[];
+    order: number;
+    duration?: number;
+}
+export interface AssistantSkillMapping {
+    assistantSkillId?: string;
+    assistantSkillUpdatedTime?: number;
+}
+/**
+ * Configuration for a contact service queue
+ * @public
+ */
+export interface ContactServiceQueue {
+    /** Organization ID */
+    organizationId?: string;
+    /** Unique identifier for the queue */
+    id?: string;
+    /** Version of the queue */
+    version?: number;
+    /** Name of the Contact Service Queue */
+    name: string;
+    /** Description of the queue */
+    description?: string;
+    /** Queue type (INBOUND, OUTBOUND) */
+    queueType: 'INBOUND' | 'OUTBOUND';
+    /** Whether to check agent availability */
+    checkAgentAvailability: boolean;
+    /** Channel type (TELEPHONY, EMAIL, SOCIAL_CHANNEL, CHAT, etc.) */
+    channelType: 'TELEPHONY' | 'EMAIL' | 'FAX' | 'CHAT' | 'VIDEO' | 'OTHERS' | 'SOCIAL_CHANNEL';
+    /** Social channel type for SOCIAL_CHANNEL channelType */
+    socialChannelType?: 'MESSAGEBIRD' | 'MESSENGER' | 'WHATSAPP' | 'APPLE_BUSINESS_CHAT' | 'GOOGLE_BUSINESS_MESSAGES';
+    /** Service level threshold in seconds */
+    serviceLevelThreshold: number;
+    /** Maximum number of simultaneous contacts */
+    maxActiveContacts: number;
+    /** Maximum time in queue in seconds */
+    maxTimeInQueue: number;
+    /** Default music in queue media file ID */
+    defaultMusicInQueueMediaFileId: string;
+    /** Timezone for routing strategies */
+    timezone?: string;
+    /** Whether the queue is active */
+    active: boolean;
+    /** Whether outdial campaign is enabled */
+    outdialCampaignEnabled?: boolean;
+    /** Whether monitoring is permitted */
+    monitoringPermitted: boolean;
+    /** Whether parking is permitted */
+    parkingPermitted: boolean;
+    /** Whether recording is permitted */
+    recordingPermitted: boolean;
+    /** Whether recording all calls is permitted */
+    recordingAllCallsPermitted: boolean;
+    /** Whether pausing recording is permitted */
+    pauseRecordingPermitted: boolean;
+    /** Recording pause duration in seconds */
+    recordingPauseDuration?: number;
+    /** Control flow script URL */
+    controlFlowScriptUrl: string;
+    /** IVR requeue URL */
+    ivrRequeueUrl: string;
+    /** Overflow number for telephony */
+    overflowNumber?: string;
+    /** Vendor ID */
+    vendorId?: string;
+    /** Routing type */
+    routingType: 'LONGEST_AVAILABLE_AGENT' | 'SKILLS_BASED' | 'CIRCULAR' | 'LINEAR';
+    /** Skills-based routing type */
+    skillBasedRoutingType?: 'LONGEST_AVAILABLE_AGENT' | 'BEST_AVAILABLE_AGENT';
+    /** Queue routing type */
+    queueRoutingType: 'TEAM_BASED' | 'SKILL_BASED' | 'AGENT_BASED';
+    /** Queue skill requirements */
+    queueSkillRequirements?: QueueSkillRequirement[];
+    /** List of agents for agent-based queue */
+    agents?: QueueAgent[];
+    /** Call distribution groups */
+    callDistributionGroups: CallDistributionGroup[];
+    /** XSP version */
+    xspVersion?: string;
+    /** Subscription ID */
+    subscriptionId?: string;
+    /** Assistant skill mapping */
+    assistantSkill?: AssistantSkillMapping;
+    /** Whether this is a system default queue */
+    systemDefault?: boolean;
+    /** User who last updated agents list */
+    agentsLastUpdatedByUserName?: string;
+    /** Email of user who last updated agents list */
+    agentsLastUpdatedByUserEmailPrefix?: string;
+    /** When agents list was last updated */
+    agentsLastUpdatedTime?: number;
+    /** Creation timestamp in epoch millis */
+    createdTime?: number;
+    /** Last updated timestamp in epoch millis */
+    lastUpdatedTime?: number;
+}
+export type ContactServiceQueuesResponse = PaginatedResponse<ContactServiceQueue>;
+export interface ContactServiceQueueSearchParams extends BaseSearchParams {
+    desktopProfileFilter?: boolean;
+    provisioningView?: boolean;
+    singleObjectResponse?: boolean;
+}
 /**
  * Response type for buddy agents query operations.
  * Either a success response with list of buddy agents or an error.

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

@@ -0,0 +1,173 @@
+/**
+ * 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;
+}
+/**
+ * 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 (no search/filter parameters)
+ * if (cache.canUseCache({ search, filter })) {
+ *   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 search/filter/attributes/sort.
+     * @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.js

@@ -274,6 +274,23 @@ const LoginOption = exports.LoginOption = {
  * @ignore
  */
 
+/**
+ * AddressBook types
+ */
+
+/**
+ * EntryPointRecord types
+ */
+
+/**
+ * Queue types
+ */
+
+/**
+ * Configuration for a contact service queue
+ * @public
+ */
+
 /**
  * Response type for buddy agents query operations.
  * Either a success response with list of buddy agents or an error.

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';\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}\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 * 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":";;;;;;AAUA;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;AAUA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AAPA,IAQYC,aAAa,GAAAN,OAAA,CAAAM,aAAA,0BAAbA,aAAa;EAAbA,aAAa;EAAbA,aAAa;EAAbA,aAAa;EAAbA,aAAa;EAAbA,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;AACA;AACA;AACA;AACA;;AAGA;AACA;AACA;AACA;AACA;AACA;AACA"}
+{"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;EAAbA,aAAa;EAAbA,aAAa;EAAbA,aAAa;EAAbA,aAAa;EAAbA,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"}

package/dist/utils/PageCache.js

@@ -0,0 +1,192 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = exports.PageCache = exports.PAGINATION_DEFAULTS = void 0;
+var _loggerProxy = _interopRequireDefault(require("../logger-proxy"));
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+/**
+ * Common pagination metadata interface used across all APIs.
+ * @public
+ * @template T - Additional metadata properties specific to the API
+ */
+
+/**
+ * Common paginated response interface used across all APIs.
+ * @public
+ * @template T - The type of data items in the response
+ */
+
+/**
+ * Common search and pagination parameters interface.
+ * @public
+ */
+
+/**
+ * Default pagination constants used across all APIs.
+ * @public
+ */
+const PAGINATION_DEFAULTS = exports.PAGINATION_DEFAULTS = {
+  /** Default page number */
+  PAGE: 0,
+  /** Default page size */
+  PAGE_SIZE: 100
+};
+
+/**
+ * Interface for cached page entry with metadata
+ * @public
+ */
+
+/**
+ * Interface for cache validation parameters
+ * @public
+ */
+
+/**
+ * Default cache TTL in minutes
+ */
+const DEFAULT_CACHE_TTL_MINUTES = 5;
+
+/**
+ * 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 (no search/filter parameters)
+ * if (cache.canUseCache({ search, filter })) {
+ *   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);
+ * ```
+ */
+class PageCache {
+  cache = new Map();
+  /**
+   * Creates an instance of PageCache
+   * @param {string} apiName - Name of the API using this cache (for logging)
+   * @public
+   */
+  constructor(apiName) {
+    this.apiName = apiName;
+  }
+
+  /**
+   * Checks if cache can be used for the given parameters.
+   * Cache is only used for simple pagination without search/filter/attributes/sort.
+   * @param {CacheValidationParams} params - Parameters to validate
+   * @returns {boolean} True if cache can be used
+   * @public
+   */
+  canUseCache(params) {
+    const {
+      search,
+      filter,
+      attributes,
+      sortBy
+    } = params;
+    return !search && !filter && !attributes && !sortBy;
+  }
+
+  /**
+   * 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, page, pageSize) {
+    return `${orgId}:${page}:${pageSize}`;
+  }
+
+  /**
+   * 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) {
+    const cachedEntry = this.cache.get(cacheKey);
+    if (!cachedEntry) {
+      return null;
+    }
+
+    // Check if cache entry is expired
+    const now = Date.now();
+    const cacheAge = (now - cachedEntry.timestamp) / (1000 * 60); // in minutes
+
+    if (cacheAge >= DEFAULT_CACHE_TTL_MINUTES) {
+      _loggerProxy.default.log(`Cache entry expired for key: ${cacheKey}`, {
+        module: this.apiName,
+        method: 'getCachedPage'
+      });
+      this.cache.delete(cacheKey);
+      return null;
+    }
+    return cachedEntry;
+  }
+
+  /**
+   * 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, data, meta) {
+    const cacheEntry = {
+      data,
+      timestamp: Date.now(),
+      totalMeta: meta ? {
+        totalPages: meta.totalPages,
+        totalRecords: meta.totalRecords || meta.totalItems
+      } : undefined
+    };
+    this.cache.set(cacheKey, cacheEntry);
+    _loggerProxy.default.log(`Cached page with ${data.length} items for key: ${cacheKey}`, {
+      module: this.apiName,
+      method: 'cachePage'
+    });
+  }
+
+  /**
+   * Clears all cached entries
+   * @public
+   */
+  clearCache() {
+    const cacheSize = this.cache.size;
+    this.cache.clear();
+    _loggerProxy.default.log(`Cleared ${cacheSize} cache entries`, {
+      module: this.apiName,
+      method: 'clearCache'
+    });
+  }
+
+  /**
+   * Gets the current number of cached entries
+   * @returns {number} Number of cached entries
+   * @public
+   */
+  getCacheSize() {
+    return this.cache.size;
+  }
+}
+exports.PageCache = PageCache;
+var _default = exports.default = PageCache;
+//# sourceMappingURL=PageCache.js.map