@webex/contact-center 3.11.0 → 3.12.0-mobius-socket.1

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

@@ -0,0 +1,413 @@
+import { Msg } from '../core/GlobalTypes';
+/**
+ * Response type received when an agent successfully logs out from the system
+ * @public
+ * @remarks
+ * This type represents the response message sent by the server when an agent
+ * successfully logs out. It includes essential details about the logout action
+ * and the agent's final state.
+ */
+export type LogoutSuccess = Msg<{
+    /** Message type identifier for agent desktop events */
+    eventType: 'AgentDesktopMessage';
+    /** Unique identifier of the agent */
+    agentId: string;
+    /** Tracking ID for the logout request */
+    trackingId: string;
+    /** Current session ID of the agent */
+    agentSessionId: string;
+    /** Organization ID the agent belongs to */
+    orgId: string;
+    /** Current status of the agent (e.g., 'LoggedOut') */
+    status: string;
+    /** Detailed status information */
+    subStatus: string;
+    /** Identity of who initiated the logout if not the agent themselves */
+    loggedOutBy?: string;
+    /** List of roles assigned to the agent */
+    roles?: string[];
+    /** Type identifier for logout success event */
+    type: 'AgentLogoutSuccess';
+}>;
+/**
+ * Response type received when an agent successfully relogins to the system
+ * @public
+ * @remarks
+ * Represents the response message when an agent successfully re-authenticates.
+ * Contains comprehensive information about the agent's new session, including
+ * their state, assigned channels, and device information.
+ */
+export type ReloginSuccess = Msg<{
+    /** Message type identifier for agent desktop events */
+    eventType: 'AgentDesktopMessage';
+    /** Unique identifier of the agent */
+    agentId: string;
+    /** Tracking ID for the relogin request */
+    trackingId: string;
+    /** Auxiliary code ID for the agent's initial state */
+    auxCodeId: string;
+    /** ID of the team the agent belongs to */
+    teamId: string;
+    /** New session ID assigned to the agent */
+    agentSessionId: string;
+    /** Directory number assigned to the agent */
+    dn: string;
+    /** Organization ID the agent belongs to */
+    orgId: string;
+    /** List of active interaction IDs */
+    interactionIds: string[];
+    /** Indicates if login is via extension */
+    isExtension: boolean;
+    /** Current login status */
+    status: 'LoggedIn';
+    /** Current sub-status */
+    subStatus: 'Idle';
+    /** ID of the site where the agent is located */
+    siteId: string;
+    /** Timestamp of last idle code change */
+    lastIdleCodeChangeTimestamp: number;
+    /** Timestamp of last state change */
+    lastStateChangeTimestamp: number;
+    /** Reason for the last state change */
+    lastStateChangeReason?: string;
+    /** Type of agent profile */
+    profileType: string;
+    /** Map of channel types to channel IDs */
+    channelsMap: Record<string, string[]>;
+    /** Phone number for dialing */
+    dialNumber?: string;
+    /** List of roles assigned to the agent */
+    roles?: string[];
+    /** Type of device being used */
+    deviceType?: DeviceType;
+    /** Unique identifier of the device */
+    deviceId?: string | null;
+    /** Flag indicating if emergency modal was shown */
+    isEmergencyModalAlreadyDisplayed?: boolean;
+    /** Type identifier for relogin success event */
+    type: 'AgentReloginSuccess';
+}>;
+/**
+ * Response type received when an agent's state is successfully changed
+ * @public
+ * @remarks
+ * Contains information about the agent's new state, including who initiated
+ * the change and timestamps for tracking state transitions.
+ */
+export type StateChangeSuccess = Msg<{
+    /** Message type identifier for agent desktop events */
+    eventType: 'AgentDesktopMessage';
+    /** Unique identifier of the agent */
+    agentId: string;
+    /** Tracking ID for the state change request */
+    trackingId: string;
+    /** Auxiliary code ID associated with the new state */
+    auxCodeId: string;
+    /** Current session ID of the agent */
+    agentSessionId: string;
+    /** Organization ID the agent belongs to */
+    orgId: string;
+    /** Current status of the agent */
+    status: string;
+    /** Detailed status indicating availability */
+    subStatus: 'Available' | 'Idle';
+    /** Timestamp of last idle code change */
+    lastIdleCodeChangeTimestamp: number;
+    /** Timestamp of current state change */
+    lastStateChangeTimestamp: number;
+    /** Type identifier for state change success event */
+    type: 'AgentStateChangeSuccess';
+    /** Identity of who initiated the state change */
+    changedBy: string | null;
+    /** ID of the user who initiated the change */
+    changedById: string | null;
+    /** Name of the user who initiated the change */
+    changedByName: string | null;
+    /** Reason for the state change */
+    lastStateChangeReason: string;
+}>;
+/**
+ * Response type received when an agent successfully logs into their station
+ * @public
+ * @remarks
+ * Represents the success response when an agent logs into their workstation.
+ * Includes details about the agent's initial state, assigned teams, and channels.
+ */
+export type StationLoginSuccess = Msg<{
+    /** Message type identifier for agent desktop events */
+    eventType: 'AgentDesktopMessage';
+    /** Unique identifier of the agent */
+    agentId: string;
+    /** Tracking ID for the station login request */
+    trackingId: string;
+    /** Auxiliary code ID for initial state */
+    auxCodeId: string;
+    /** ID of the team the agent belongs to */
+    teamId: string;
+    /** New session ID assigned to the agent */
+    agentSessionId: string;
+    /** Organization ID the agent belongs to */
+    orgId: string;
+    /** List of active interaction IDs */
+    interactionIds: string[];
+    /** Current login status */
+    status: string;
+    /** Current availability status */
+    subStatus: 'Available' | 'Idle';
+    /** ID of the site where the agent is located */
+    siteId: string;
+    /** Timestamp of last idle code change */
+    lastIdleCodeChangeTimestamp: number;
+    /** Timestamp of last state change */
+    lastStateChangeTimestamp: number;
+    /** Type of agent profile */
+    profileType: string;
+    /** Map of channel types to channel IDs */
+    channelsMap: Record<string, string[]>;
+    /** Phone number for dialing */
+    dialNumber?: string;
+    /** List of roles assigned to the agent */
+    roles?: string[];
+    /** Session ID of the supervising agent if applicable */
+    supervisorSessionId?: string;
+    /** Type identifier for station login success event */
+    type: 'AgentStationLoginSuccess';
+}>;
+/**
+ * Extended response type for station login success that includes notification tracking
+ * @public
+ * @remarks
+ * Similar to StationLoginSuccess but includes additional fields for notification
+ * tracking and multimedia profile settings.
+ */
+export type StationLoginSuccessResponse = {
+    /** Message type identifier for agent desktop events */
+    eventType: 'AgentDesktopMessage';
+    /** Unique identifier of the agent */
+    agentId: string;
+    /** Tracking ID for the station login request */
+    trackingId: string;
+    /** Auxiliary code ID for initial state */
+    auxCodeId: string;
+    /** ID of the team the agent belongs to */
+    teamId: string;
+    /** New session ID assigned to the agent */
+    agentSessionId: string;
+    /** Organization ID the agent belongs to */
+    orgId: string;
+    /** List of active interaction IDs */
+    interactionIds: string[];
+    /** Current login status */
+    status: string;
+    /** Current availability status */
+    subStatus: 'Available' | 'Idle';
+    /** ID of the site where the agent is located */
+    siteId: string;
+    /** Timestamp of last idle code change */
+    lastIdleCodeChangeTimestamp: number;
+    /** Timestamp of last state change */
+    lastStateChangeTimestamp: number;
+    /** Type of agent profile */
+    profileType: string;
+    /** Multimedia profile capacity settings */
+    mmProfile: {
+        /** Maximum concurrent chat capacity */
+        chat: number;
+        /** Maximum concurrent email capacity */
+        email: number;
+        /** Maximum concurrent social media capacity */
+        social: number;
+        /** Maximum concurrent voice call capacity */
+        telephony: number;
+    };
+    /** Phone number for dialing */
+    dialNumber?: string;
+    /** List of roles assigned to the agent */
+    roles?: string[];
+    /** Session ID of the supervising agent if applicable */
+    supervisorSessionId?: string;
+    /** Type identifier for station login success event */
+    type: 'AgentStationLoginSuccess';
+    /** Tracking ID for notifications */
+    notifsTrackingId: string;
+};
+/**
+ * Extended response type for agent device type update success
+ * @public
+ * @remarks
+ * Represents the response when an agent's device type is successfully updated.
+ * Contains all the details of the agent's session and device configuration.
+ */
+export type DeviceTypeUpdateSuccess = Omit<StationLoginSuccessResponse, 'type'> & {
+    type: 'AgentDeviceTypeUpdateSuccess';
+};
+/**
+ * Parameters required for initiating an agent logout
+ * @public
+ * @remarks
+ * Defines the parameters that can be provided when logging out an agent,
+ * including the reason for logout which helps with reporting and auditing.
+ */
+export type Logout = {
+    /** Reason for the logout action */
+    logoutReason?: 'User requested logout' | 'Inactivity Logout' | 'User requested agent profile update';
+};
+/**
+ * Represents the possible states an agent can be in
+ * @public
+ * @remarks
+ * Defines the various states an agent can transition between during their session.
+ * Common states include 'Available' (ready to handle interactions), 'Idle' (on break
+ * or not ready), and 'RONA' (Response on No Answer).
+ */
+export type AgentState = 'Available' | 'Idle' | 'RONA' | string;
+/**
+ * Parameters required for changing an agent's state
+ * @public
+ * @remarks
+ * Defines the necessary information for transitioning an agent from one state to another.
+ */
+export type StateChange = {
+    /** New state to transition the agent to */
+    state: AgentState;
+    /** Auxiliary code ID associated with the state change */
+    auxCodeId: string;
+    /** Reason for the state change */
+    lastStateChangeReason?: string;
+    /** ID of the agent whose state is being changed */
+    agentId?: string;
+};
+/**
+ * Parameters required for agent station login
+ * @public
+ * @remarks
+ * Contains all the necessary information for logging an agent into their workstation,
+ * including team assignments, roles, and device configurations.
+ */
+export type UserStationLogin = {
+    /** Phone number for dialing */
+    dialNumber?: string | null;
+    /** Directory number */
+    dn?: string | null;
+    /** ID of the team the agent belongs to */
+    teamId: string | null;
+    /** Name of the team */
+    teamName: string | null;
+    /** List of roles assigned to the agent */
+    roles?: Array<string>;
+    /** ID of the site where the agent is located */
+    siteId: string;
+    /** Indicates if agent uses a different DN than their assigned one */
+    usesOtherDN: boolean;
+    /** ID of the agent's skill profile */
+    skillProfileId?: string;
+    /** ID of the initial auxiliary state code */
+    auxCodeId: string;
+    /** Indicates if login is via extension */
+    isExtension?: boolean;
+    /** Type of device being used */
+    deviceType?: DeviceType;
+    /** Unique identifier of the device */
+    deviceId?: string | null;
+    /** Flag indicating if emergency modal was shown */
+    isEmergencyModalAlreadyDisplayed?: boolean;
+};
+/**
+ * Available options for agent login methods
+ * @public
+ * @remarks
+ * Defines the supported methods for agent login:
+ * - AGENT_DN: Login using agent's direct number
+ * - EXTENSION: Login using extension number
+ * - BROWSER: Browser-based login
+ */
+export type LoginOption = 'AGENT_DN' | 'EXTENSION' | 'BROWSER';
+/**
+ * Type of device used for agent login
+ * @public
+ * @remarks
+ * Represents the type of device being used for login. Can be one of the standard
+ * LoginOptions or a custom device type string.
+ */
+export type DeviceType = LoginOption | string;
+/**
+ * Parameters for retrieving buddy agent information
+ * @public
+ * @remarks
+ * Defines the criteria for fetching information about other agents (buddies)
+ * in the system, allowing filtering by profile, media type, and state.
+ */
+export type BuddyAgents = {
+    agentProfileId: string;
+    mediaType: string;
+    /** Filter for agent state eg : Available | Idle  */
+    state?: string;
+};
+/**
+ * Detailed information about a buddy agent
+ * @public
+ * @remarks
+ * Contains comprehensive information about a buddy agent including their
+ * current state, assignments, and contact information.
+ */
+export type BuddyDetails = {
+    agentId: string;
+    state: string;
+    teamId: string;
+    dn: string;
+    agentName: string;
+    siteId: string;
+};
+/**
+ * Response type received when successfully retrieving buddy agent information
+ * @public
+ * @remarks
+ * Contains the list of buddy agents and their details returned from a buddy
+ * agent lookup request. Used for monitoring team member statuses and availability.
+ */
+export type BuddyAgentsSuccess = Msg<{
+    /** Message type identifier for agent desktop events */
+    eventType: 'AgentDesktopMessage';
+    /** Unique identifier of the requesting agent */
+    agentId: string;
+    /** Tracking ID for the buddy list request */
+    trackingId: string;
+    /** Current session ID of the requesting agent */
+    agentSessionId: string;
+    /** Organization ID the agent belongs to */
+    orgId: string;
+    /** Type identifier for buddy agents response */
+    type: 'BuddyAgents';
+    /** List of buddy agents and their details */
+    agentList: Array<BuddyDetails>;
+}>;
+/**
+ * Events emitted by the agent service for various state changes and actions
+ * @public
+ * @remarks
+ * Enumeration of all possible events that can be emitted by the agent service.
+ * These events can be used to track and respond to changes in agent state,
+ * login status, and other important agent-related activities.
+ */
+export declare enum AGENT_EVENTS {
+    /** Emitted when an agent's state changes (e.g., Available to Idle) */
+    AGENT_STATE_CHANGE = "agent:stateChange",
+    /** Emitted when multiple logins are detected for the same agent */
+    AGENT_MULTI_LOGIN = "agent:multiLogin",
+    /** Emitted when an agent successfully logs into their station */
+    AGENT_STATION_LOGIN_SUCCESS = "agent:stationLoginSuccess",
+    /** Emitted when station login attempt fails */
+    AGENT_STATION_LOGIN_FAILED = "agent:stationLoginFailed",
+    /** Emitted when an agent successfully logs out */
+    AGENT_LOGOUT_SUCCESS = "agent:logoutSuccess",
+    /** Emitted when logout attempt fails */
+    AGENT_LOGOUT_FAILED = "agent:logoutFailed",
+    /** Emitted when an agent's directory number is successfully registered */
+    AGENT_DN_REGISTERED = "agent:dnRegistered",
+    /** Emitted when an agent successfully re-authenticates */
+    AGENT_RELOGIN_SUCCESS = "agent:reloginSuccess",
+    /** Emitted when agent state change is successful */
+    AGENT_STATE_CHANGE_SUCCESS = "agent:stateChangeSuccess",
+    /** Emitted when agent state change attempt fails */
+    AGENT_STATE_CHANGE_FAILED = "agent:stateChangeFailed"
+}

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

@@ -0,0 +1,20 @@
+import { AgentResponse, AuxCode, DesktopProfileResponse, DialPlanEntity, OrgInfo, OrgSettings, Profile, Team, TenantData, URLMapping, AIFeatureFlagsResponse } from './types';
+/**
+ * Parse the agent configurations
+ * @param {Object} profileData
+ * @returns {Profile}
+ */
+declare function parseAgentConfigs(profileData: {
+    userData: AgentResponse;
+    teamData: Team[];
+    tenantData: TenantData;
+    orgInfoData: OrgInfo;
+    auxCodes: AuxCode[];
+    orgSettingsData: OrgSettings;
+    agentProfileData: DesktopProfileResponse;
+    dialPlanData: DialPlanEntity[];
+    urlMapping: URLMapping[];
+    multimediaProfileId: string;
+    aiFeatureFlags: AIFeatureFlagsResponse;
+}): Profile;
+export { parseAgentConfigs };

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

@@ -0,0 +1,249 @@
+export declare const DEFAULT_PAGE = 0;
+/**
+ * Default page size for paginated API requests.
+ * @type {number}
+ * @public
+ * @example
+ * const pageSize = DEFAULT_PAGE_SIZE; // 100
+ * @ignore
+ */
+export declare const DEFAULT_PAGE_SIZE = 100;
+/**
+ * Agent state ID for 'Available'.
+ * @type {string}
+ * @public
+ * @ignore
+ */
+export declare const AGENT_STATE_AVAILABLE_ID = "0";
+/**
+ * Agent state label for 'Available'.
+ * @type {string}
+ * @public
+ * @ignore
+ */
+export declare const AGENT_STATE_AVAILABLE = "Available";
+/**
+ * Description for the 'Available' agent state.
+ * @type {string}
+ * @public
+ * @ignore
+ */
+export declare const AGENT_STATE_AVAILABLE_DESCRIPTION = "Agent is available to receive calls";
+/**
+ * Default attributes for auxiliary code API requests.
+ * @type {string[]}
+ * @public
+ * @ignore
+ */
+export declare const DEFAULT_AUXCODE_ATTRIBUTES: string[];
+export declare const METHODS: {
+    GET_AGENT_CONFIG: string;
+    GET_USER_USING_CI: string;
+    GET_DESKTOP_PROFILE_BY_ID: string;
+    GET_MULTIMEDIA_PROFILE_BY_ID: string;
+    GET_LIST_OF_TEAMS: string;
+    GET_ALL_TEAMS: string;
+    GET_LIST_OF_AUX_CODES: string;
+    GET_ALL_AUX_CODES: string;
+    GET_SITE_INFO: string;
+    GET_ORG_INFO: string;
+    GET_ORGANIZATION_SETTING: string;
+    GET_TENANT_DATA: string;
+    GET_URL_MAPPING: string;
+    GET_DIAL_PLAN_DATA: string;
+    GET_AI_FEATURE_FLAGS: string;
+    GET_QUEUES: string;
+    PARSE_AGENT_CONFIGS: string;
+    GET_URL_MAPPING_UTIL: string;
+    GET_MSFT_CONFIG: string;
+    GET_WEBEX_CONFIG: string;
+    GET_DEFAULT_AGENT_DN: string;
+    GET_FILTERED_DIALPLAN_ENTRIES: string;
+    GET_FILTER_AUX_CODES: string;
+    GET_DEFAULT_WRAP_UP_CODE: string;
+};
+/**
+ * Maps API endpoint names to functions that generate endpoint URLs for various organization resources.
+ * @public
+ * @example
+ * const url = endPointMap.userByCI('org123', 'agent456');
+ */
+export declare const endPointMap: {
+    /**
+     * Gets the endpoint for a user by CI user ID.
+     * @param orgId - Organization ID.
+     * @param agentId - Agent ID.
+     * @returns The endpoint URL string.
+     * @public
+     * @example
+     * const url = endPointMap.userByCI('org123', 'agent456');
+     * @ignore
+     */
+    userByCI: (orgId: string, agentId: string) => string;
+    /**
+     * Gets the endpoint for a desktop profile.
+     * @param orgId - Organization ID.
+     * @param desktopProfileId - Desktop profile ID.
+     * @returns The endpoint URL string.
+     * @public
+     * @example
+     * const url = endPointMap.desktopProfile('org123', 'profile789');
+     * @ignore
+     */
+    desktopProfile: (orgId: string, desktopProfileId: string) => string;
+    /**
+     * Gets the endpoint for a multimedia profile.
+     * @param orgId - Organization ID.
+     * @param multimediaProfileId - Multimedia profile ID.
+     * @returns The endpoint URL string.
+     * @public
+     * @example
+     * const url = endPointMap.multimediaProfile('org123', 'multi456');
+     * @ignore
+     */
+    multimediaProfile: (orgId: string, multimediaProfileId: string) => string;
+    /**
+     * Gets the endpoint for listing teams with optional filters.
+     * @param orgId - Organization ID.
+     * @param page - Page number.
+     * @param pageSize - Page size.
+     * @param filter - Array of team IDs to filter.
+     * @returns The endpoint URL string.
+     * @public
+     * @example
+     * const url = endPointMap.listTeams('org123', 0, 100, ['team1', 'team2']);
+     * @ignore
+     */
+    listTeams: (orgId: string, page: number, pageSize: number, filter: string[]) => string;
+    /**
+     * Gets the endpoint for listing auxiliary codes with optional filters and attributes.
+     * @param orgId - Organization ID.
+     * @param page - Page number.
+     * @param pageSize - Page size.
+     * @param filter - Array of auxiliary code IDs to filter.
+     * @param attributes - Array of attribute names to include.
+     * @returns The endpoint URL string.
+     * @public
+     * @example
+     * const url = endPointMap.listAuxCodes('org123', 0, 100, ['aux1'], ['id', 'name']);
+     * @ignore
+     */
+    listAuxCodes: (orgId: string, page: number, pageSize: number, filter: string[], attributes: string[]) => string;
+    /**
+     * Gets the endpoint for organization info.
+     * @param orgId - Organization ID.
+     * @returns The endpoint URL string.
+     * @public
+     * @example
+     * const url = endPointMap.orgInfo('org123');
+     * @ignore
+     */
+    orgInfo: (orgId: string) => string;
+    /**
+     * Gets the endpoint for organization settings.
+     * @param orgId - Organization ID.
+     * @returns The endpoint URL string.
+     * @public
+     * @example
+     * const url = endPointMap.orgSettings('org123');
+     * @ignore
+     */
+    orgSettings: (orgId: string) => string;
+    /**
+     * Gets the endpoint for site info.
+     * @param orgId - Organization ID.
+     * @param siteId - Site ID.
+     * @returns The endpoint URL string.
+     * @public
+     * @example
+     * const url = endPointMap.siteInfo('org123', 'site456');
+     * @ignore
+     */
+    siteInfo: (orgId: string, siteId: string) => string;
+    /**
+     * Gets the endpoint for tenant configuration data.
+     * @param orgId - Organization ID.
+     * @returns The endpoint URL string.
+     * @public
+     * @example
+     * const url = endPointMap.tenantData('org123');
+     * @ignore
+     */
+    tenantData: (orgId: string) => string;
+    /**
+     * Gets the endpoint for organization URL mapping.
+     * @param orgId - Organization ID.
+     * @returns The endpoint URL string.
+     * @public
+     * @example
+     * const url = endPointMap.urlMapping('org123');
+     * @ignore
+     */
+    urlMapping: (orgId: string) => string;
+    /**
+     * Gets the endpoint for dial plan.
+     * @param orgId - Organization ID.
+     * @returns The endpoint URL string.
+     * @public
+     * @example
+     * const url = endPointMap.dialPlan('org123');
+     * @ignore
+     */
+    dialPlan: (orgId: string) => string;
+    /**
+     * Gets the endpoint for listing AI feature flags.
+     * @param orgId - Organization ID.
+     * @returns The endpoint URL string.
+     * @public
+     * @example
+     * const url = endPointMap.aiFeatureFlags('org123');
+     * @ignore
+     */
+    aiFeature: (orgId: string) => string;
+    /**
+     * Gets the endpoint for the queue list with custom query parameters.
+     * @param orgId - Organization ID.
+     * @param queryParams - Query parameters string.
+     * @returns The endpoint URL string.
+     * @public
+     * @example
+     * const url = endPointMap.queueList('org123', 'page=0&pageSize=10');
+     * @ignore
+     */
+    queueList: (orgId: string, queryParams: string) => string;
+    /**
+     * Gets the endpoint for entry points list with custom query parameters.
+     * @param orgId - Organization ID.
+     * @param queryParams - Query parameters string.
+     * @returns The endpoint URL string.
+     * @public
+     * @example
+     * const url = endPointMap.entryPointList('org123', 'page=0&pageSize=10');
+     * @ignore
+     */
+    entryPointList: (orgId: string, queryParams: string) => string;
+    /**
+     * Gets the endpoint for address book entries with custom query parameters.
+     * @param orgId - Organization ID.
+     * @param addressBookId - Address book ID.
+     * @param queryParams - Query parameters string.
+     * @returns The endpoint URL string.
+     * @public
+     * @example
+     * const url = endPointMap.addressBookEntries('org123', 'book456', 'page=0&pageSize=10');
+     * @ignore
+     */
+    addressBookEntries: (orgId: string, addressBookId: string, queryParams: string) => string;
+    /**
+     * Gets the endpoint for outdial ANI entries with custom query parameters.
+     * @param orgId - Organization ID.
+     * @param outdialANI - Outdial ANI ID.
+     * @param queryParams - Query parameters string.
+     * @returns The endpoint URL string.
+     * @public
+     * @example
+     * const url = endPointMap.outdialAniEntries('org123', 'ani456', 'page=0&pageSize=10');
+     * @ignore
+     */
+    outdialAniEntries: (orgId: string, outdialANI: string, queryParams: string) => string;
+};