@webex/contact-center 3.11.0-next.21 → 3.11.0-next.23

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    /** 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\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;AAuFA;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"],"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    /** 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\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;AAuFA;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;;AAkBA;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":[]}

package/dist/webex.js

@@ -29,7 +29,7 @@ if (!global.Buffer) {
  */
 const Webex = _webexCore.default.extend({
   webex: true,
-  version: `3.11.0-next.21`
+  version: `3.11.0-next.23`
 });
 
 /**

package/package.json

@@ -48,7 +48,7 @@
     "@webex/calling": "3.11.0-next.13",
     "@webex/internal-plugin-mercury": "3.11.0-next.9",
     "@webex/internal-plugin-metrics": "3.11.0-next.7",
-    "@webex/internal-plugin-support": "3.11.0-next.9",
+    "@webex/internal-plugin-support": "3.11.0-next.10",
     "@webex/plugin-authorization": "3.11.0-next.7",
     "@webex/plugin-logger": "3.11.0-next.7",
     "@webex/webex-core": "3.11.0-next.7",
@@ -80,5 +80,5 @@
     "typedoc": "^0.25.0",
     "typescript": "4.9.5"
   },
-  "version": "3.11.0-next.21"
+  "version": "3.11.0-next.23"
 }

package/src/cc.ts

@@ -55,7 +55,13 @@ import {
 import {ConnectionLostDetails} from './services/core/websocket/types';
 import TaskManager from './services/task/TaskManager';
 import WebCallingService from './services/WebCallingService';
-import {ITask, TASK_EVENTS, TaskResponse, DialerPayload} from './services/task/types';
+import {
+  ITask,
+  TASK_EVENTS,
+  TaskResponse,
+  DialerPayload,
+  PreviewContactPayload,
+} from './services/task/types';
 import MetricsManager from './metrics/MetricsManager';
 import {METRIC_EVENT_NAMES} from './metrics/constants';
 import {Failure} from './services/core/GlobalTypes';
@@ -119,6 +125,7 @@ import type {
  *   - `task:established` - Task/call has been connected
  *   - `task:ended` - Task/call has ended
  *   - `task:error` - An error occurred during task handling
+ *   - `task:campaignPreviewReservation` - Campaign preview contact offered to agent
  *
  * @public
  *
@@ -406,6 +413,16 @@ export default class ContactCenter extends WebexPlugin implements IContactCenter
     this.trigger(TASK_EVENTS.TASK_MERGED, task);
   };
 
+  /**
+   * Handles campaign preview reservation events when a contact is offered to the agent
+   * @private
+   * @param {ITask} task The campaign reservation task
+   */
+  private handleCampaignPreviewReservation = (task: ITask) => {
+    // @ts-ignore
+    this.trigger(TASK_EVENTS.TASK_CAMPAIGN_PREVIEW_RESERVATION, task);
+  };
+
   /**
    * Sets up event listeners for incoming tasks and task hydration
    * Subscribes to task events from the task manager
@@ -415,6 +432,10 @@ export default class ContactCenter extends WebexPlugin implements IContactCenter
     this.taskManager.on(TASK_EVENTS.TASK_INCOMING, this.handleIncomingTask);
     this.taskManager.on(TASK_EVENTS.TASK_HYDRATE, this.handleTaskHydrate);
     this.taskManager.on(TASK_EVENTS.TASK_MERGED, this.handleTaskMerged);
+    this.taskManager.on(
+      TASK_EVENTS.TASK_CAMPAIGN_PREVIEW_RESERVATION,
+      this.handleCampaignPreviewReservation
+    );
   }
 
   /**
@@ -543,6 +564,10 @@ export default class ContactCenter extends WebexPlugin implements IContactCenter
 
       this.taskManager.off(TASK_EVENTS.TASK_INCOMING, this.handleIncomingTask);
       this.taskManager.off(TASK_EVENTS.TASK_HYDRATE, this.handleTaskHydrate);
+      this.taskManager.off(
+        TASK_EVENTS.TASK_CAMPAIGN_PREVIEW_RESERVATION,
+        this.handleCampaignPreviewReservation
+      );
       this.taskManager.unregisterIncomingCallEvent();
 
       this.services.webSocketManager.off('message', this.handleWebsocketMessage);
@@ -1513,6 +1538,79 @@ export default class ContactCenter extends WebexPlugin implements IContactCenter
     }
   }
 
+  /**
+   * Accepts a campaign preview contact, initiating the outbound call.
+   *
+   * When a campaign manager reserves a contact for an agent, the agent receives an
+   * `AgentOfferCampaignReservation` event. The agent can then accept the preview contact
+   * to initiate the outbound call.
+   *
+   * @param {PreviewContactPayload} payload - The preview contact payload containing interactionId and campaignId (campaign name, not UUID).
+   * @returns {Promise<TaskResponse>} Promise resolving with agent contact on success.
+   * @throws {Error} If the operation fails (network error, customer unavailable, etc.)
+   *
+   * @example
+   * ```typescript
+   * webex.cc.on('task:campaignPreviewReservation', async (task) => {
+   *   const { interactionId } = task.data;
+   *   // campaignId is the campaign name (e.g. "MyCampaign"), not a UUID
+   *   const campaignId = task.data.interaction.callProcessingDetails.campaignId;
+   *
+   *   const result = await webex.cc.acceptPreviewContact({ interactionId, campaignId });
+   * });
+   * ```
+   */
+  public async acceptPreviewContact(payload: PreviewContactPayload): Promise<TaskResponse> {
+    LoggerProxy.info('Accepting campaign preview contact', {
+      module: CC_FILE,
+      method: METHODS.ACCEPT_PREVIEW_CONTACT,
+    });
+    try {
+      this.metricsManager.timeEvent([
+        METRIC_EVENT_NAMES.CAMPAIGN_PREVIEW_ACCEPT_SUCCESS,
+        METRIC_EVENT_NAMES.CAMPAIGN_PREVIEW_ACCEPT_FAILED,
+      ]);
+
+      const result = await this.services.dialer.acceptPreviewContact({data: payload});
+
+      this.metricsManager.trackEvent(
+        METRIC_EVENT_NAMES.CAMPAIGN_PREVIEW_ACCEPT_SUCCESS,
+        {
+          ...MetricsManager.getCommonTrackingFieldForAQMResponse(result),
+          interactionId: payload.interactionId,
+          campaignId: payload.campaignId,
+        },
+        ['behavioral', 'business', 'operational']
+      );
+
+      LoggerProxy.log('Campaign preview contact accepted successfully', {
+        module: CC_FILE,
+        method: METHODS.ACCEPT_PREVIEW_CONTACT,
+        trackingId: result.trackingId,
+        interactionId: payload.interactionId,
+      });
+
+      return result;
+    } catch (error) {
+      const failure = error.details as Failure;
+      this.metricsManager.trackEvent(
+        METRIC_EVENT_NAMES.CAMPAIGN_PREVIEW_ACCEPT_FAILED,
+        {
+          ...MetricsManager.getCommonTrackingFieldForAQMResponseFailed(failure),
+          interactionId: payload.interactionId,
+          campaignId: payload.campaignId,
+        },
+        ['behavioral', 'business', 'operational']
+      );
+      const {error: detailedError} = getErrorDetails(
+        error,
+        METHODS.ACCEPT_PREVIEW_CONTACT,
+        CC_FILE
+      );
+      throw detailedError;
+    }
+  }
+
   /**
    * Fetches outdial ANI (Automatic Number Identification) entries for an outdial ANI ID.
    *

package/src/constants.ts

@@ -49,4 +49,5 @@ export const METHODS = {
   HANDLE_INCOMING_TASK: 'handleIncomingTask',
   HANDLE_TASK_HYDRATE: 'handleTaskHydrate',
   INCOMING_TASK_LISTENER: 'incomingTaskListener',
+  ACCEPT_PREVIEW_CONTACT: 'acceptPreviewContact',
 };

package/src/metrics/behavioral-events.ts

@@ -435,6 +435,20 @@ const eventTaxonomyMap: Record<string, BehavioralEventTaxonomy> = {
     target: 'outdial_ani_ep_fetch',
     verb: 'fail',
   },
+
+  // Campaign Preview API Events
+  [METRIC_EVENT_NAMES.CAMPAIGN_PREVIEW_ACCEPT_SUCCESS]: {
+    product,
+    agent: 'user',
+    target: 'campaign_preview_accept',
+    verb: 'complete',
+  },
+  [METRIC_EVENT_NAMES.CAMPAIGN_PREVIEW_ACCEPT_FAILED]: {
+    product,
+    agent: 'user',
+    target: 'campaign_preview_accept',
+    verb: 'fail',
+  },
 };
 
 /**

package/src/metrics/constants.ts

@@ -159,6 +159,10 @@ export const METRIC_EVENT_NAMES = {
   // Outdial ANI Entries API Events
   OUTDIAL_ANI_EP_FETCH_SUCCESS: 'Outdial ANI Entries Fetch Success',
   OUTDIAL_ANI_EP_FETCH_FAILED: 'Outdial ANI Entries Fetch Failed',
+
+  // Campaign Preview API Events
+  CAMPAIGN_PREVIEW_ACCEPT_SUCCESS: 'Campaign Preview Accept Success',
+  CAMPAIGN_PREVIEW_ACCEPT_FAILED: 'Campaign Preview Accept Failed',
 } as const;
 
 /**

package/src/services/config/types.ts

@@ -111,6 +111,12 @@ export const CC_TASK_EVENTS = {
   AGENT_CONTACT_UNASSIGNED: 'AgentContactUnassigned',
   /** Event emitted when inviting agent fails */
   AGENT_INVITE_FAILED: 'AgentInviteFailed',
+  /** Event emitted when a campaign preview contact is offered to the agent */
+  AGENT_OFFER_CAMPAIGN_RESERVATION: 'AgentOfferCampaignReservation',
+  /** Event emitted when campaign contact is updated */
+  CAMPAIGN_CONTACT_UPDATED: 'CampaignContactUpdated',
+  /** Event emitted when accepting a campaign preview contact fails */
+  CAMPAIGN_PREVIEW_ACCEPT_FAILED: 'CampaignPreviewAcceptFailed',
 } as const;
 
 /**

package/src/services/core/Err.ts

@@ -38,6 +38,7 @@ export type TaskErrorIds =
   | {'Service.aqm.task.pauseRecording': Failure}
   | {'Service.aqm.task.resumeRecording': Failure}
   | {'Service.aqm.dialer.startOutdial': Failure}
+  | {'Service.aqm.dialer.acceptPreviewContact': Failure}
   | {'Service.reqs.generic.failure': {trackingId: string}};
 
 export type ReqError =

package/src/services/core/aqm-reqs.ts

@@ -20,18 +20,40 @@ export default class AqmReqs {
     this.webSocketManager.on('message', this.onMessage.bind(this));
   }
 
+  /**
+   * Creates a request function for an API call with parameters
+   * @param c - The configuration for the request
+   * @returns A function that makes the API request
+   */
   req<TRes, TErr, TReq>(c: Conf<TRes, TErr, TReq>): Res<TRes, TReq> {
     return (p: TReq, cbRes?: CbRes<TRes>) => this.makeAPIRequest(c(p), cbRes);
   }
 
+  /**
+   * Creates a request function for an API call with no parameters
+   * @param c - The configuration for the request
+   * @returns A function that makes the API request
+   */
   reqEmpty<TRes, TErr>(c: ConfEmpty<TRes, TErr>): ResEmpty<TRes> {
     return (cbRes?: CbRes<TRes>) => this.makeAPIRequest(c(), cbRes);
   }
 
+  /**
+   * Makes an API request
+   * @param c - The request configuration
+   * @param cbRes - The callback for the response
+   * @returns A promise that resolves with the response or rejects with an error
+   */
   private async makeAPIRequest<TRes, TErr>(c: Req<TRes, TErr>, cbRes?: CbRes<TRes>): Promise<TRes> {
     return this.createPromise(c, cbRes);
   }
 
+  /**
+   * Creates a promise for an API request
+   * @param c - The request configuration
+   * @param cbRes - The callback for the response
+   * @returns A promise that resolves with the response or rejects with an error
+   */
   private createPromise<TRes, TErr>(c: Req<TRes, TErr>, cbRes?: CbRes<TRes>) {
     return new Promise<TRes>((resolve, reject) => {
       const keySuccess = this.bindPrint(c.notifSuccess.bind);
@@ -154,10 +176,13 @@ export default class AqmReqs {
             if (response?.headers) {
               response.headers.Authorization = '*';
             }
-            LoggerProxy.error(`Routing request timeout${keySuccess}${response!}${c.url}`, {
-              module: AQM_REQS_FILE,
-              method: METHODS.CREATE_PROMISE,
-            });
+            LoggerProxy.error(
+              `Routing request timeout${keySuccess}${JSON.stringify(response)}${c.url}`,
+              {
+                module: AQM_REQS_FILE,
+                method: METHODS.CREATE_PROMISE,
+              }
+            );
             reject(
               new Err.Details('Service.aqm.reqs.Timeout', {
                 key: keySuccess,
@@ -171,39 +196,60 @@ export default class AqmReqs {
     });
   }
 
-  private bindPrint(bind: any) {
+  /**
+   * Converts a bind object to a string representation
+   * @param bind - The bind object to convert
+   * @returns A string representation of the bind object
+   */
+  private bindPrint(bind: any): string {
     let result = '';
-    // eslint-disable-next-line no-restricted-syntax
-    for (const k in bind) {
-      if (Array.isArray(bind[k])) {
-        result += `${k}=[${bind[k].join(',')}],`;
-      } else if (typeof bind[k] === 'object' && bind[k] !== null) {
-        result += `${k}=(${this.bindPrint(bind[k])}),`;
+    for (const key of Object.keys(bind).filter((prop) => prop !== '__typeMap')) {
+      const value = bind[key];
+
+      if (Array.isArray(value)) {
+        result += `${key}=[${value.join(',')}],`;
+      } else if (typeof value === 'object' && value !== null) {
+        result += `${key}=(${this.bindPrint(value)}),`;
       } else {
-        result += `${k}=${bind[k]},`;
+        result += `${key}=${value},`;
       }
     }
 
     return result ? result.slice(0, -1) : result;
   }
 
-  private bindCheck(bind: any, msg: any) {
-    // eslint-disable-next-line no-restricted-syntax
-    for (const k in bind) {
-      if (Array.isArray(bind[k])) {
+  /**
+   * Checks if a message matches a bind object
+   * @param bind - The bind object to check against
+   * @param msg - The message to check
+   * @returns True if the message matches the bind object, false otherwise
+   */
+  private bindCheck(bind: any, msg: any): boolean {
+    // Handle type-dependent field matching if __typeMap is present
+    if (bind.__typeMap && typeof bind.__typeMap === 'object') {
+      if (!AqmReqs.typeMapCheck(bind.__typeMap, msg)) {
+        return false;
+      }
+    }
+
+    for (const key of Object.keys(bind).filter((prop) => prop !== '__typeMap')) {
+      const bindValue = bind[key];
+      const msgValue = msg[key];
+
+      if (Array.isArray(bindValue)) {
         // Check if the message value matches any of the values in the array
-        if (!bind[k].includes(msg[k])) {
+        if (!bindValue.includes(msgValue)) {
           return false;
         }
-      } else if (typeof bind[k] === 'object' && bind[k] !== null) {
-        if (typeof msg[k] === 'object' && msg[k] !== null) {
-          if (!this.bindCheck(bind[k], msg[k])) {
+      } else if (typeof bindValue === 'object' && bindValue !== null) {
+        if (typeof msgValue === 'object' && msgValue !== null) {
+          if (!this.bindCheck(bindValue, msgValue)) {
             return false;
           }
         } else {
           return false;
         }
-      } else if (!msg[k] || msg[k] !== bind[k]) {
+      } else if (!msgValue || msgValue !== bindValue) {
         return false;
       }
     }
@@ -211,7 +257,39 @@ export default class AqmReqs {
     return true;
   }
 
-  // must be lambda
+  /**
+   * Checks type-dependent field conditions defined in __typeMap.
+   * @param typeMap - The type map to check against
+   * @param msg - The message to check
+   * @returns True if the message matches the type map, false otherwise
+   * The typeMap has the shape:
+   *   { typeField: "type", conditions: { EventA: { field: value }, EventB: { field: value } } }
+   * It reads msg[typeField] to determine which condition set to apply,
+   * then verifies all fields in that condition match the message.
+   */
+  private static typeMapCheck(typeMap: any, msg: any): boolean {
+    const typeField = typeMap.typeField || 'type';
+    const msgType = msg[typeField];
+
+    if (typeMap.conditions && typeMap.conditions[msgType]) {
+      const condition = typeMap.conditions[msgType];
+      for (const field of Object.keys(condition)) {
+        if (!msg[field] || msg[field] !== condition[field]) {
+          return false;
+        }
+      }
+
+      return true;
+    }
+
+    return false;
+  }
+
+  /**
+   * Handles incoming messages from the WebSocket (must be a lambda fn)
+   * @param msg - The message to handle
+   * @returns
+   */
   private readonly onMessage = (msg: any) => {
     const event = JSON.parse(msg);
     if (event.type === 'Welcome') {