o2g-node-sdk 2.4.0 → 2.5.0

package/dist/types/o2g-cc-agent.d.ts

@@ -0,0 +1,376 @@
+import { IntrusionMode } from './types/cc-agent/intrusion-mode';
+import EventEmitter from 'events';
+import { OperatorConfig } from './types/cc-agent/operator-config';
+import { OperatorState } from './types/cc-agent/operator-state';
+import { WithdrawReason } from './types/cc-agent/withdraw-reason';
+/**
+ * CallCenterAgent provides services for CCD operators. Using this
+ * service requires having a <b>CONTACTCENTER_AGENT</b> license.
+ */
+export declare class CallCenterAgent extends EventEmitter {
+    #private;
+    /**
+     * Occurs when an agent state has changed.
+     * @event
+     */
+    static readonly ON_AGENT_STATE_CHANGED = "OnAgentStateChanged";
+    /**
+     * Occurs when CCD agent skills are modified: one or several skills have been activated or deactivated.
+     * @event
+     */
+    static readonly ON_AGENT_SKILL_CHANGED = "OnAgentSkillChanged";
+    /**
+     * Occurs when an agent requests help from their supervisor.
+     * @see requestPermanentListening
+     * @see requestSupervisorHelp
+     * @event
+     */
+    static readonly ON_SUPERVISOR_HELP_REQUESTED = "OnSupervisorHelpRequested";
+    /**
+     * Occurs when an agent has requested the assistance of their supervisor and the request
+     * is cancelled by the agent, or rejected by the supervisor.
+     * @see cancelSupervisorHelpRequest
+     * @see rejectAgentHelpRequest
+     * @event
+     */
+    static readonly ON_SUPERVISOR_HELP_CANCELLED = "OnSupervisorHelpCancelled";
+    /**
+     * Gets the operator configuration.
+     * <p>
+     * If the session has been opened for a user, the `loginName` parameter is
+     * ignored, but it is mandatory if the session has been opened by an administrator.
+     *
+     * @param loginName the operator login name
+     * @returns the {@link OperatorConfig} on success; `null` otherwise.
+     */
+    getConfiguration(loginName?: string | null): Promise<OperatorConfig | null>;
+    /**
+     * Gets the specified agent or supervisor state.
+     * <p>
+     * If the session has been opened for a user, the `loginName` parameter is
+     * ignored, but it is mandatory if the session has been opened by an administrator.
+     *
+     * @param loginName the operator login name
+     * @returns the {@link OperatorState} on success; `null` otherwise.
+     */
+    getState(loginName?: string | null): Promise<OperatorState | null>;
+    /**
+     * Logs on an agent or a supervisor.
+     * <p>
+     * For a supervisor, if `pgNumber` is omitted, the supervisor is logged on out of group.
+     * <p>
+     * If the session has been opened for a user, the `loginName` parameter is
+     * ignored, but it is mandatory if the session has been opened by an administrator.
+     *
+     * @example
+     * ```typescript
+     * // Log on an agent to processing group "pg001" with headset mode
+     * await O2G.callCenterAgent.logon("acd001", "pg001", true);
+     *
+     * // Log on a supervisor out of group (no pgNumber)
+     * await O2G.callCenterAgent.logon("acd001");
+     *
+     * // Administrator logging on an agent on behalf of a user
+     * await O2G.callCenterAgent.logon("acd001", "pg001", false, "jdoe");
+     * ```
+     *
+     * @param proAcdNumber the pro-ACD device number
+     * @param pgNumber     the agent processing group number
+     * @param headset      activate the headset mode
+     * @param loginName    the CCD operator login name
+     * @returns `true` if the operation succeeded; `false` otherwise.
+     * @see logoff
+     */
+    logon(proAcdNumber: string, pgNumber?: string | null, headset?: boolean, loginName?: string | null): Promise<boolean>;
+    /**
+     * Logs off an agent or a supervisor.
+     * <p>
+     * This method does nothing and returns `true` if the agent or supervisor is already logged off.
+     * <p>
+     * If the session has been opened for a user, the `loginName` parameter is
+     * ignored, but it is mandatory if the session has been opened by an administrator.
+     *
+     * @param loginName the CCD operator login name
+     * @returns `true` if the operation succeeded; `false` otherwise.
+     * @see logon
+     */
+    logoff(loginName?: string | null): Promise<boolean>;
+    /**
+     * Enters an agent group. Only for a supervisor.
+     * <p>
+     * This method is used by a supervisor to enter an agent group when in
+     * pre-assigned state (logged on but not in an agent group).
+     * <p>
+     * If the session has been opened for a user, the `loginName` parameter is
+     * ignored, but it is mandatory if the session has been opened by an administrator.
+     *
+     * @param pgNumber  the agent processing group number
+     * @param loginName the supervisor login name
+     * @returns `true` if the operation succeeded; `false` otherwise.
+     * @see exit
+     */
+    enter(pgNumber: string, loginName?: string | null): Promise<boolean>;
+    /**
+     * Exits from an agent group. Only for a supervisor.
+     * <p>
+     * This method is used by a supervisor to leave an agent group and go back to
+     * pre-assigned state (logged on but not in an agent group).
+     * <p>
+     * If the session has been opened for a user, the `loginName` parameter is
+     * ignored, but it is mandatory if the session has been opened by an administrator.
+     *
+     * @param loginName the supervisor login name
+     * @returns `true` if the operation succeeded; `false` otherwise.
+     * @see enter
+     */
+    exit(loginName?: string | null): Promise<boolean>;
+    /**
+     * Puts the specified agent in wrapup state.
+     * <p>
+     * If the session has been opened for a user, the `loginName` parameter is
+     * ignored, but it is mandatory if the session has been opened by an administrator.
+     *
+     * @param loginName the agent login name
+     * @returns `true` if the operation succeeded; `false` otherwise.
+     */
+    setWrapup(loginName?: string | null): Promise<boolean>;
+    /**
+     * Puts the specified agent in ready state.
+     * <p>
+     * If the session has been opened for a user, the `loginName` parameter is
+     * ignored, but it is mandatory if the session has been opened by an administrator.
+     *
+     * @param loginName the agent login name
+     * @returns `true` if the operation succeeded; `false` otherwise.
+     */
+    setReady(loginName?: string | null): Promise<boolean>;
+    /**
+     * Puts the specified agent in pause state.
+     * <p>
+     * If the session has been opened for a user, the `loginName` parameter is
+     * ignored, but it is mandatory if the session has been opened by an administrator.
+     *
+     * @param loginName the agent login name
+     * @returns `true` if the operation succeeded; `false` otherwise.
+     */
+    setPause(loginName?: string | null): Promise<boolean>;
+    /**
+     * Requests a supervisor to listen to the specified agent.
+     * <p>
+     * On success, an {@link ON_SUPERVISOR_HELP_REQUESTED} event is raised for both the agent and the supervisor.
+     * <p>
+     * If the session has been opened for a user, the `loginName` parameter is
+     * ignored, but it is mandatory if the session has been opened by an administrator.
+     *
+     * @example
+     * ```typescript
+     * // Start permanent listening on agent "5001"
+     * await O2G.callCenterAgent.requestPermanentListening("5001");
+     *
+     * // Listen to events to know when listening is established
+     * O2G.callCenterAgent.on(CallCenterAgent.ON_SUPERVISOR_HELP_REQUESTED, (event) => {
+     *     console.log("Listening established");
+     * });
+     *
+     * // Cancel the listening when done
+     * await O2G.callCenterAgent.cancelPermanentListening();
+     * ```
+     *
+     * @param agentNumber the extension number of the agent to listen to
+     * @param loginName   the supervisor login name
+     * @returns `true` if the operation succeeded; `false` otherwise.
+     * @see cancelPermanentListening
+     */
+    requestPermanentListening(agentNumber: string, loginName?: string | null): Promise<boolean>;
+    /**
+     * Cancels a permanent listening by a supervisor.
+     * <p>
+     * On success, an {@link ON_SUPERVISOR_HELP_CANCELLED} event is raised for both the agent and the supervisor.
+     * <p>
+     * If the session has been opened for a user, the `loginName` parameter is
+     * ignored, but it is mandatory if the session has been opened by an administrator.
+     *
+     * @param loginName the supervisor login name
+     * @returns `true` if the operation succeeded; `false` otherwise.
+     * @see requestPermanentListening
+     */
+    cancelPermanentListening(loginName?: string | null): Promise<boolean>;
+    /**
+     * Requests an intrusion in a CCD call.
+     * <p>
+     * If the session has been opened for a user, the `loginName` parameter is
+     * ignored, but it is mandatory if the session has been opened by an administrator.
+     *
+     * @example
+     * ```typescript
+     * // Intrude on agent "5001" in normal mode
+     * await O2G.callCenterAgent.requestIntrusion("5001");
+     *
+     * // Intrude in coach mode (agent hears supervisor, caller does not)
+     * await O2G.callCenterAgent.requestIntrusion("5001", IntrusionMode.COACH);
+     *
+     * // Switch from coach mode to normal intrusion
+     * await O2G.callCenterAgent.changeIntrusionMode(IntrusionMode.NORMAL);
+     *
+     * // Cancel the intrusion by passing the current mode
+     * await O2G.callCenterAgent.changeIntrusionMode(IntrusionMode.NORMAL);
+     * ```
+     *
+     * @param agentNumber   the extension number of the CCD agent answering the call
+     * @param intrusionMode the intrusion mode
+     * @param loginName     the supervisor login name
+     * @returns `true` if the operation succeeded; `false` otherwise.
+     * @see changeIntrusionMode
+     */
+    requestIntrusion(agentNumber: string, intrusionMode?: IntrusionMode, loginName?: string | null): Promise<boolean>;
+    /**
+     * Changes the intrusion mode.
+     * <p>
+     * This method allows changing the intrusion mode or cancelling an intrusion.
+     * To cancel an intrusion, pass the current mode in the `newIntrusionMode` parameter.
+     * <p>
+     * If the session has been opened for a user, the `loginName` parameter is
+     * ignored, but it is mandatory if the session has been opened by an administrator.
+     *
+     * @param newIntrusionMode the new intrusion mode
+     * @param loginName        the supervisor login name
+     * @returns `true` if the operation succeeded; `false` otherwise.
+     * @see requestIntrusion
+     */
+    changeIntrusionMode(newIntrusionMode: IntrusionMode, loginName?: string | null): Promise<boolean>;
+    /**
+     * Requests help from the supervisor.
+     * <p>
+     * On success, an {@link ON_SUPERVISOR_HELP_REQUESTED} event is raised for both the agent and the supervisor.
+     * <p>
+     * If the session has been opened for a user, the `loginName` parameter is
+     * ignored, but it is mandatory if the session has been opened by an administrator.
+     *
+     * @param loginName the agent login name
+     * @returns `true` if the operation succeeded; `false` otherwise.
+     * @see cancelSupervisorHelpRequest
+     */
+    requestSupervisorHelp(loginName?: string | null): Promise<boolean>;
+    /**
+     * Rejects a help request from an agent.
+     * <p>
+     * This method is invoked by a supervisor to reject a help request from an agent.
+     * On success, an {@link ON_SUPERVISOR_HELP_CANCELLED} event is raised.
+     * <p>
+     * If the session has been opened for a user, the `loginName` parameter is
+     * ignored, but it is mandatory if the session has been opened by an administrator.
+     *
+     * @param agentNumber the extension number of the agent who requested help
+     * @param loginName   the supervisor login name
+     * @returns `true` if the operation succeeded; `false` otherwise.
+     * @see cancelSupervisorHelpRequest
+     */
+    rejectAgentHelpRequest(agentNumber: string, loginName?: string | null): Promise<boolean>;
+    /**
+     * Cancels a supervisor help request.
+     * <p>
+     * This method is invoked by an agent to cancel a help request.
+     * On success, an {@link ON_SUPERVISOR_HELP_CANCELLED} event is raised.
+     * <p>
+     * If the session has been opened for a user, the `loginName` parameter is
+     * ignored, but it is mandatory if the session has been opened by an administrator.
+     *
+     * @param supervisorNumber the extension number of the requested supervisor
+     * @param loginName        the agent login name
+     * @returns `true` if the operation succeeded; `false` otherwise.
+     * @see requestSupervisorHelp
+     */
+    cancelSupervisorHelpRequest(supervisorNumber: string, loginName?: string | null): Promise<boolean>;
+    /**
+     * Asks a snapshot event to receive an {@link ON_AGENT_STATE_CHANGED} event.
+     * <p>
+     * The {@link ON_AGENT_STATE_CHANGED} event contains the operator {@link OperatorState}.
+     * If a second request is asked while the previous one is still in progress, it has no effect.
+     * <p>
+     * If an administrator invokes this method with `loginName` set to `null`, the snapshot
+     * request is done for all agents. The event processing can be long depending on the number
+     * of users.
+     *
+     * @param loginName the agent login name
+     * @returns `true` if the request was successfully submitted; `false` otherwise.
+     */
+    requestSnapshot(loginName?: string | null): Promise<boolean>;
+    /**
+     * Activates the specified skills.
+     * <p>
+     * If the session has been opened for a user, the `loginName` parameter is
+     * ignored, but it is mandatory if the session has been opened by an administrator.
+     * <p>
+     * This method does not validate skill numbers. If a skill number is invalid
+     * (not assigned to the operator), it is ignored and the method returns `true`.
+     *
+     * @example
+     * ```typescript
+     * // Activate skills 1, 2 and 5 for the current user
+     * await O2G.callCenterAgent.activateSkills([1, 2, 5]);
+     *
+     * // Activate skills for a specific agent (administrator session)
+     * await O2G.callCenterAgent.activateSkills([1, 2, 5], "jdoe");
+     *
+     * // Invalid skill numbers are silently ignored — this still returns true
+     * await O2G.callCenterAgent.activateSkills([1, 99, 100]);
+     * ```
+     *
+     * @param skillNumbers the list of skill numbers to activate
+     * @param loginName    the agent login name
+     * @returns `true` if the operation succeeded; `false` otherwise.
+     * @see deactivateSkills
+     */
+    activateSkills(skillNumbers: number[], loginName?: string | null): Promise<boolean>;
+    /**
+     * Deactivates the specified skills.
+     * <p>
+     * If the session has been opened for a user, the `loginName` parameter is
+     * ignored, but it is mandatory if the session has been opened by an administrator.
+     * <p>
+     * This method does not validate skill numbers. If a skill number is invalid
+     * (not assigned to the operator), it is ignored and the method returns `true`.
+     *
+     * @param skillNumbers the list of skill numbers to deactivate
+     * @param loginName    the agent login name
+     * @returns `true` if the operation succeeded; `false` otherwise.
+     * @see activateSkills
+     */
+    deactivateSkills(skillNumbers: number[], loginName?: string | null): Promise<boolean>;
+    /**
+     * Returns the list of withdraw reasons for the specified processing group.
+     * <p>
+     * If the session has been opened for a user, the `loginName` parameter is
+     * ignored, but it is mandatory if the session has been opened by an administrator.
+     *
+     * @param pgNumber  the agent processing group number
+     * @param loginName the agent login name
+     * @returns the list of {@link WithdrawReason} objects on success; `null` otherwise.
+     * @see setWithdraw
+     */
+    getWithdrawReasons(pgNumber: string, loginName?: string | null): Promise<WithdrawReason[] | null>;
+    /**
+     * Withdraws an agent with the specified reason.
+     * <p>
+     * If the session has been opened for a user, the `loginName` parameter is
+     * ignored, but it is mandatory if the session has been opened by an administrator.
+     *
+     * @example
+     * ```typescript
+     * // First retrieve the available withdraw reasons for the processing group
+     * const reasons = await O2G.callCenterAgent.getWithdrawReasons("pg001");
+     *
+     * // Then withdraw the agent using one of the returned reasons
+     * if (reasons && reasons.length > 0) {
+     *     await O2G.callCenterAgent.setWithdraw(reasons[0]);
+     * }
+     * ```
+     *
+     * @param reason    the withdraw reason
+     * @param loginName the agent login name
+     * @returns `true` if the operation succeeded; `false` otherwise.
+     * @see getWithdrawReasons
+     */
+    setWithdraw(reason: WithdrawReason, loginName?: string | null): Promise<boolean>;
+}
+//# sourceMappingURL=o2g-cc-agent.d.ts.map

package/dist/types/o2g-cc-agent.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"o2g-cc-agent.d.ts","sourceRoot":"","sources":["../../src/o2g-cc-agent.ts"],"names":[],"mappings":"AAmBA,OAAO,EAAE,aAAa,EAAE,MAAM,iCAAiC,CAAC;AAEhE,OAAO,YAAY,MAAM,QAAQ,CAAC;AAQlC,OAAO,EAAE,cAAc,EAAE,MAAM,kCAAkC,CAAC;AAClE,OAAO,EAAE,aAAa,EAAE,MAAM,iCAAiC,CAAC;AAChE,OAAO,EAAE,cAAc,EAAE,MAAM,kCAAkC,CAAC;AAElE;;;GAGG;AACH,qBAAa,eAAgB,SAAQ,YAAY;;IAG7C;;;OAGG;IACH,MAAM,CAAC,QAAQ,CAAC,sBAAsB,yBAAyB;IAE/D;;;OAGG;IACH,MAAM,CAAC,QAAQ,CAAC,sBAAsB,yBAAyB;IAE/D;;;;;OAKG;IACH,MAAM,CAAC,QAAQ,CAAC,4BAA4B,+BAA+B;IAE3E;;;;;;OAMG;IACH,MAAM,CAAC,QAAQ,CAAC,4BAA4B,+BAA+B;IAe3E;;;;;;;;OAQG;IACG,gBAAgB,CAAC,SAAS,GAAE,MAAM,GAAG,IAAW,GAAG,OAAO,CAAC,cAAc,GAAG,IAAI,CAAC;IAIvF;;;;;;;;OAQG;IACG,QAAQ,CAAC,SAAS,GAAE,MAAM,GAAG,IAAW,GAAG,OAAO,CAAC,aAAa,GAAG,IAAI,CAAC;IAI9E;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACG,KAAK,CACP,YAAY,EAAE,MAAM,EACpB,QAAQ,GAAE,MAAM,GAAG,IAAW,EAC9B,OAAO,UAAQ,EACf,SAAS,GAAE,MAAM,GAAG,IAAW,GAChC,OAAO,CAAC,OAAO,CAAC;IAInB;;;;;;;;;;;OAWG;IACG,MAAM,CAAC,SAAS,GAAE,MAAM,GAAG,IAAW,GAAG,OAAO,CAAC,OAAO,CAAC;IAI/D;;;;;;;;;;;;;OAaG;IACG,KAAK,CAAC,QAAQ,EAAE,MAAM,EAAE,SAAS,GAAE,MAAM,GAAG,IAAW,GAAG,OAAO,CAAC,OAAO,CAAC;IAIhF;;;;;;;;;;;;OAYG;IACG,IAAI,CAAC,SAAS,GAAE,MAAM,GAAG,IAAW,GAAG,OAAO,CAAC,OAAO,CAAC;IAI7D;;;;;;;;OAQG;IACG,SAAS,CAAC,SAAS,GAAE,MAAM,GAAG,IAAW,GAAG,OAAO,CAAC,OAAO,CAAC;IAIlE;;;;;;;;OAQG;IACG,QAAQ,CAAC,SAAS,GAAE,MAAM,GAAG,IAAW,GAAG,OAAO,CAAC,OAAO,CAAC;IAIjE;;;;;;;;OAQG;IACG,QAAQ,CAAC,SAAS,GAAE,MAAM,GAAG,IAAW;IAI9C;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACG,yBAAyB,CAAC,WAAW,EAAE,MAAM,EAAE,SAAS,GAAE,MAAM,GAAG,IAAW,GAAG,OAAO,CAAC,OAAO,CAAC;IAIvG;;;;;;;;;;;OAWG;IACG,wBAAwB,CAAC,SAAS,GAAE,MAAM,GAAG,IAAW,GAAG,OAAO,CAAC,OAAO,CAAC;IAIjF;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACG,gBAAgB,CAClB,WAAW,EAAE,MAAM,EACnB,aAAa,gBAAuB,EACpC,SAAS,GAAE,MAAM,GAAG,IAAW,GAChC,OAAO,CAAC,OAAO,CAAC;IAInB;;;;;;;;;;;;;OAaG;IACG,mBAAmB,CAAC,gBAAgB,EAAE,aAAa,EAAE,SAAS,GAAE,MAAM,GAAG,IAAW,GAAG,OAAO,CAAC,OAAO,CAAC;IAI7G;;;;;;;;;;;OAWG;IACG,qBAAqB,CAAC,SAAS,GAAE,MAAM,GAAG,IAAW,GAAG,OAAO,CAAC,OAAO,CAAC;IAI9E;;;;;;;;;;;;;OAaG;IACG,sBAAsB,CAAC,WAAW,EAAE,MAAM,EAAE,SAAS,GAAE,MAAM,GAAG,IAAW,GAAG,OAAO,CAAC,OAAO,CAAC;IAIpG;;;;;;;;;;;;;OAaG;IACG,2BAA2B,CAAC,gBAAgB,EAAE,MAAM,EAAE,SAAS,GAAE,MAAM,GAAG,IAAW,GAAG,OAAO,CAAC,OAAO,CAAC;IAI9G;;;;;;;;;;;;OAYG;IACG,eAAe,CAAC,SAAS,GAAE,MAAM,GAAG,IAAW,GAAG,OAAO,CAAC,OAAO,CAAC;IAIxE;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACG,cAAc,CAAC,YAAY,EAAE,MAAM,EAAE,EAAE,SAAS,GAAE,MAAM,GAAG,IAAW,GAAG,OAAO,CAAC,OAAO,CAAC;IAI/F;;;;;;;;;;;;;OAaG;IACG,gBAAgB,CAAC,YAAY,EAAE,MAAM,EAAE,EAAE,SAAS,GAAE,MAAM,GAAG,IAAW,GAAG,OAAO,CAAC,OAAO,CAAC;IAIjG;;;;;;;;;;OAUG;IACG,kBAAkB,CAAC,QAAQ,EAAE,MAAM,EAAE,SAAS,GAAE,MAAM,GAAG,IAAW,GAAG,OAAO,CAAC,cAAc,EAAE,GAAG,IAAI,CAAC;IAI7G;;;;;;;;;;;;;;;;;;;;;OAqBG;IACG,WAAW,CAAC,MAAM,EAAE,cAAc,EAAE,SAAS,GAAE,MAAM,GAAG,IAAW,GAAG,OAAO,CAAC,OAAO,CAAC;CAG/F"}

package/dist/types/o2g-cc-mngt.d.ts

@@ -0,0 +1,213 @@
+import { Calendar } from './types/cc-mngt/calendar/calendar';
+import { DayOfWeek } from './types/common/day-of-week';
+import { ExceptionCalendar } from './types/cc-mngt/calendar/exception-calendar';
+import { NormalCalendar } from './types/cc-mngt/calendar/normal-calendar';
+import { Transition } from './types/cc-mngt/calendar/transition';
+import { Pilot } from './types/cc-mngt/pilot';
+import { PilotTransferQueryParameters } from './types/telephony/call/ccd/pilot-transfer-query-param';
+/**
+ * This service allows an administrator session to manage CCD pilot objects.
+ * <p>
+ * This service requires having a <b>CONTACTCENTER_SRV</b> license.
+ */
+export declare class CallCenterManagement {
+    #private;
+    /**
+     * Retrieves the list of CCD pilots configured on the specified OmniPCX Enterprise node.
+     *
+     * @param nodeId the PCX Enterprise node id
+     * @returns the list of {@link Pilot} objects on success; `null` otherwise.
+     */
+    getPilots(nodeId: number): Promise<Pilot[] | null>;
+    /**
+     * Get information about a CCD pilot.
+     *
+     * When called without `pilotTransferQueryParam`, returns the pilot's current
+     * configuration and state.
+     *
+     * When called with `pilotTransferQueryParam`, returns the pilot's routing
+     * capabilities evaluated against the specified call profile context (agent,
+     * skills, transfer type). This advanced form requires O2G version 2.7.4 or later.
+     *
+     * @example
+     * ```typescript
+     * // Simple form — get the pilot's current configuration
+     * const pilot = await O2G.callCenterManagement.getPilot(1, "60141");
+     *
+     * // Advanced form — evaluate routing for a specific agent and skill set
+     * const queryParam = new PilotTransferQueryParameters({
+     *     agentNumber: "5001",
+     *     skills: { skills: [{ skillNumber: 1, acrStatus: true, expertEvalLevel: 3 }] },
+     *     priorityTransfer: true
+     * });
+     * const pilotAdvanced = await O2G.callCenterManagement.getPilot(1, "60141", queryParam);
+     * ```
+     *
+     * @param nodeId                  the PCX Enterprise node id
+     * @param pilotNumber             the pilot number
+     * @param pilotTransferQueryParam optional call profile context. When provided,
+     *                                the pilot information is evaluated against the
+     *                                specified agent number, skills and transfer type.
+     *                                Requires O2G >= 2.7.4.
+     * @returns the {@link Pilot} information on success; `null` otherwise.
+     */
+    getPilot(nodeId: number, pilotNumber: string, pilotTransferQueryParam?: PilotTransferQueryParameters | null): Promise<Pilot | null>;
+    /**
+     * Retrieves the routing calendar of the specified CCD pilot.
+     * <p>
+     * The calendar defines the normal and exception schedules that govern
+     * the pilot's open/closed state over time.
+     *
+     * @param nodeId      the PCX Enterprise node id
+     * @param pilotNumber the pilot number
+     * @returns the {@link Calendar} on success; `null` otherwise.
+     */
+    getCalendar(nodeId: number, pilotNumber: string): Promise<Calendar | null>;
+    /**
+     * Retrieves the exception calendar of the specified CCD pilot.
+     * <p>
+     * The exception calendar contains date-specific transitions that override
+     * the normal weekly schedule.
+     *
+     * @param nodeId      the PCX Enterprise node id
+     * @param pilotNumber the pilot number
+     * @returns the {@link ExceptionCalendar} on success; `null` otherwise.
+     */
+    getExceptionCalendar(nodeId: number, pilotNumber: string): Promise<ExceptionCalendar | null>;
+    /**
+     * Adds a transition to the exception calendar of the specified CCD pilot.
+     *
+     * @example
+     * ```typescript
+     * // Add a closing transition on December 25th
+     * const christmas = new Date(2025, 11, 25);
+     * const closingTransition = new Transition({ ... });
+     * await O2G.callCenterManagement.addExceptionTransition(1, "60141", christmas, closingTransition);
+     *
+     * // Later, update that transition (index 0 = first transition of the day)
+     * const updatedTransition = new Transition({ ... });
+     * await O2G.callCenterManagement.setExceptionTransition(1, "60141", christmas, 0, updatedTransition);
+     *
+     * // Or remove it entirely
+     * await O2G.callCenterManagement.deleteExceptionTransition(1, "60141", christmas, 0);
+     * ```
+     *
+     * @param nodeId         the PCX Enterprise node id
+     * @param pilotNumber    the pilot number
+     * @param dateTransition the date for which the exception transition applies
+     * @param transition     the transition to add
+     * @returns `true` if the operation succeeded; `false` otherwise.
+     */
+    addExceptionTransition(nodeId: number, pilotNumber: string, dateTransition: Date, transition: Transition): Promise<boolean>;
+    /**
+     * Deletes a transition from the exception calendar of the specified CCD pilot.
+     *
+     * @param nodeId         the PCX Enterprise node id
+     * @param pilotNumber    the pilot number
+     * @param dateTransition the date of the exception transition to delete
+     * @param index          the index of the transition to delete
+     * @returns `true` if the operation succeeded; `false` otherwise.
+     */
+    deleteExceptionTransition(nodeId: number, pilotNumber: string, dateTransition: Date, index: number): Promise<boolean>;
+    /**
+     * Updates a transition in the exception calendar of the specified CCD pilot.
+     *
+     * @param nodeId         the PCX Enterprise node id
+     * @param pilotNumber    the pilot number
+     * @param dateTransition the date of the exception transition to update
+     * @param index          the index of the transition to update
+     * @param transition     the new transition value
+     * @returns `true` if the operation succeeded; `false` otherwise.
+     */
+    setExceptionTransition(nodeId: number, pilotNumber: string, dateTransition: Date, index: number, transition: Transition): Promise<boolean>;
+    /**
+     * Retrieves the normal (weekly) calendar of the specified CCD pilot.
+     * <p>
+     * The normal calendar defines the recurring weekly schedule of open/closed
+     * transitions for each day of the week.
+     *
+     * @param nodeId      the PCX Enterprise node id
+     * @param pilotNumber the pilot number
+     * @returns the {@link NormalCalendar} on success; `null` otherwise.
+     */
+    getNormalCalendar(nodeId: number, pilotNumber: string): Promise<NormalCalendar | null>;
+    /**
+     * Adds a transition to the normal calendar of the specified CCD pilot for the given day of the week.
+     *
+     * @example
+     * ```typescript
+     * // Add an opening transition on Monday at 08:00
+     * const openingTransition = new Transition({ ... });
+     * await O2G.callCenterManagement.addNormalTransition(1, "60141", DayOfWeek.MONDAY, openingTransition);
+     *
+     * // Add a closing transition on Monday at 18:00
+     * const closingTransition = new Transition({ ... });
+     * await O2G.callCenterManagement.addNormalTransition(1, "60141", DayOfWeek.MONDAY, closingTransition);
+     *
+     * // Later, update the closing transition (index 1 = second transition of the day)
+     * const updatedTransition = new Transition({ ... });
+     * await O2G.callCenterManagement.setNormalTransition(1, "60141", DayOfWeek.MONDAY, 1, updatedTransition);
+     *
+     * // Or remove it
+     * await O2G.callCenterManagement.deleteNormalTransition(1, "60141", DayOfWeek.MONDAY, 1);
+     * ```
+     *
+     * @param nodeId      the PCX Enterprise node id
+     * @param pilotNumber the pilot number
+     * @param day         the day of the week to which the transition applies
+     * @param transition  the transition to add
+     * @returns `true` if the operation succeeded; `false` otherwise.
+     */
+    addNormalTransition(nodeId: number, pilotNumber: string, day: DayOfWeek, transition: Transition): Promise<boolean>;
+    /**
+     * Deletes a transition from the normal calendar of the specified CCD pilot.
+     *
+     * @param nodeId      the PCX Enterprise node id
+     * @param pilotNumber the pilot number
+     * @param day         the day of the week from which the transition is deleted
+     * @param index       the index of the transition to delete
+     * @returns `true` if the operation succeeded; `false` otherwise.
+     */
+    deleteNormalTransition(nodeId: number, pilotNumber: string, day: DayOfWeek, index: number): Promise<boolean>;
+    /**
+     * Updates a transition in the normal calendar of the specified CCD pilot.
+     *
+     * @param nodeId      the PCX Enterprise node id
+     * @param pilotNumber the pilot number
+     * @param day         the day of the week containing the transition to update
+     * @param index       the index of the transition to update
+     * @param transition  the new transition value
+     * @returns `true` if the operation succeeded; `false` otherwise.
+     */
+    setNormalTransition(nodeId: number, pilotNumber: string, day: DayOfWeek, index: number, transition: Transition): Promise<boolean>;
+    /**
+     * Forces the specified CCD pilot into the open state, regardless of its calendar schedule.
+     *
+     * @example
+     * ```typescript
+     * // Force a pilot open outside its normal schedule
+     * await O2G.callCenterManagement.openPilot(1, "60141");
+     *
+     * // Force it closed (e.g. during an incident)
+     * await O2G.callCenterManagement.closePilot(1, "60141");
+     *
+     * // Note: these methods override the calendar schedule.
+     * // The pilot will remain in the forced state until the next
+     * // scheduled calendar transition occurs.
+     * ```
+     *
+     * @param nodeId      the PCX Enterprise node id
+     * @param pilotNumber the pilot number
+     * @returns `true` if the operation succeeded; `false` otherwise.
+     */
+    openPilot(nodeId: number, pilotNumber: string): Promise<boolean>;
+    /**
+     * Forces the specified CCD pilot into the closed state, regardless of its calendar schedule.
+     *
+     * @param nodeId      the PCX Enterprise node id
+     * @param pilotNumber the pilot number
+     * @returns `true` if the operation succeeded; `false` otherwise.
+     */
+    closePilot(nodeId: number, pilotNumber: string): Promise<boolean>;
+}
+//# sourceMappingURL=o2g-cc-mngt.d.ts.map

package/dist/types/o2g-cc-mngt.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"o2g-cc-mngt.d.ts","sourceRoot":"","sources":["../../src/o2g-cc-mngt.ts"],"names":[],"mappings":"AAoBA,OAAO,EAAE,QAAQ,EAAE,MAAM,mCAAmC,CAAC;AAC7D,OAAO,EAAE,SAAS,EAAE,MAAM,4BAA4B,CAAC;AACvD,OAAO,EAAE,iBAAiB,EAAE,MAAM,6CAA6C,CAAC;AAChF,OAAO,EAAE,cAAc,EAAE,MAAM,0CAA0C,CAAC;AAC1E,OAAO,EAAE,UAAU,EAAE,MAAM,qCAAqC,CAAC;AACjE,OAAO,EAAE,KAAK,EAAE,MAAM,uBAAuB,CAAC;AAC9C,OAAO,EAAE,4BAA4B,EAAE,MAAM,uDAAuD,CAAC;AAErG;;;;GAIG;AACH,qBAAa,oBAAoB;;IAW7B;;;;;OAKG;IACG,SAAS,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,KAAK,EAAE,GAAG,IAAI,CAAC;IAIxD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACG,QAAQ,CACV,MAAM,EAAE,MAAM,EACd,WAAW,EAAE,MAAM,EACnB,uBAAuB,GAAE,4BAA4B,GAAG,IAAW,GACpE,OAAO,CAAC,KAAK,GAAG,IAAI,CAAC;IAQxB;;;;;;;;;OASG;IACG,WAAW,CAAC,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,GAAG,IAAI,CAAC;IAIhF;;;;;;;;;OASG;IACG,oBAAoB,CAAC,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,iBAAiB,GAAG,IAAI,CAAC;IAIlG;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACG,sBAAsB,CACxB,MAAM,EAAE,MAAM,EACd,WAAW,EAAE,MAAM,EACnB,cAAc,EAAE,IAAI,EACpB,UAAU,EAAE,UAAU,GACvB,OAAO,CAAC,OAAO,CAAC;IAInB;;;;;;;;OAQG;IACG,yBAAyB,CAC3B,MAAM,EAAE,MAAM,EACd,WAAW,EAAE,MAAM,EACnB,cAAc,EAAE,IAAI,EACpB,KAAK,EAAE,MAAM,GACd,OAAO,CAAC,OAAO,CAAC;IAInB;;;;;;;;;OASG;IACG,sBAAsB,CACxB,MAAM,EAAE,MAAM,EACd,WAAW,EAAE,MAAM,EACnB,cAAc,EAAE,IAAI,EACpB,KAAK,EAAE,MAAM,EACb,UAAU,EAAE,UAAU,GACvB,OAAO,CAAC,OAAO,CAAC;IAInB;;;;;;;;;OASG;IACG,iBAAiB,CAAC,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,GAAG,IAAI,CAAC;IAI5F;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACG,mBAAmB,CACrB,MAAM,EAAE,MAAM,EACd,WAAW,EAAE,MAAM,EACnB,GAAG,EAAE,SAAS,EACd,UAAU,EAAE,UAAU,GACvB,OAAO,CAAC,OAAO,CAAC;IAInB;;;;;;;;OAQG;IACG,sBAAsB,CAAC,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,GAAG,EAAE,SAAS,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAIlH;;;;;;;;;OASG;IACG,mBAAmB,CACrB,MAAM,EAAE,MAAM,EACd,WAAW,EAAE,MAAM,EACnB,GAAG,EAAE,SAAS,EACd,KAAK,EAAE,MAAM,EACb,UAAU,EAAE,UAAU,GACvB,OAAO,CAAC,OAAO,CAAC;IAInB;;;;;;;;;;;;;;;;;;;OAmBG;IACG,SAAS,CAAC,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAItE;;;;;;OAMG;IACG,UAAU,CAAC,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;CAG1E"}

package/dist/types/o2g-cc-pilot.d.ts

@@ -0,0 +1,71 @@
+import EventEmitter from 'events';
+/**
+ * CallCenterPilot allows an administrator to monitor the CCD pilots. Using this
+ * service requires having a <b>CONTACTCENTER_SRV</b> license.
+ * <p>
+ * Monitoring a pilot consists of starting the monitoring with {@link monitorStart},
+ * then listening to events to track call activity on the pilot. When monitoring
+ * is no longer needed, stop it with {@link monitorStop}.
+ *
+ * @example
+ * ```typescript
+ * // Register event listeners before starting monitoring
+ * O2G.callCenterPilot.on(CallCenterPilot.ON_PILOT_CALL_CREATED, (event) => {
+ *     console.log("New call on pilot:", event.pilotNumber);
+ * });
+ * O2G.callCenterPilot.on(CallCenterPilot.ON_PILOT_CALL_QUEUED, (event) => {
+ *     console.log("Call queued on pilot:", event.pilotNumber);
+ * });
+ * O2G.callCenterPilot.on(CallCenterPilot.ON_PILOT_CALL_REMOVED, (event) => {
+ *     console.log("Call removed from pilot:", event.pilotNumber);
+ * });
+ *
+ * // Start monitoring
+ * await O2G.callCenterPilot.monitorStart("60141");
+ *
+ * // Stop monitoring and clean up when done
+ * await O2G.callCenterPilot.monitorStop("60141");
+ * O2G.callCenterPilot.removeAllListeners(CallCenterPilot.ON_PILOT_CALL_CREATED);
+ * O2G.callCenterPilot.removeAllListeners(CallCenterPilot.ON_PILOT_CALL_QUEUED);
+ * O2G.callCenterPilot.removeAllListeners(CallCenterPilot.ON_PILOT_CALL_REMOVED);
+ * ```
+ */
+export declare class CallCenterPilot extends EventEmitter {
+    #private;
+    /**
+     * Occurs when a new call arrives on a pilot.
+     * @event
+     */
+    static readonly ON_PILOT_CALL_CREATED = "OnPilotCallCreated";
+    /**
+     * Occurs when the call has been queued.
+     * @event
+     */
+    static readonly ON_PILOT_CALL_QUEUED = "OnPilotCallQueued";
+    /**
+     * Occurs when a call has been removed from the pilot: by distribution, cancellation or overflow.
+     * @event
+     */
+    static readonly ON_PILOT_CALL_REMOVED = "OnPilotCallRemoved";
+    /**
+     * Starts the monitoring of a pilot.
+     * <p>
+     * If the pilot is already being monitored, no error is returned.
+     *
+     * @param pilotNumber the pilot number
+     * @returns `true` if the operation succeeded; `false` otherwise.
+     * @see monitorStop
+     */
+    monitorStart(pilotNumber: string): Promise<boolean>;
+    /**
+     * Stops the monitoring of a pilot.
+     * <p>
+     * If the pilot is not being monitored, no error is returned.
+     *
+     * @param pilotNumber the pilot number
+     * @returns `true` if the operation succeeded; `false` otherwise.
+     * @see monitorStart
+     */
+    monitorStop(pilotNumber: string): Promise<boolean>;
+}
+//# sourceMappingURL=o2g-cc-pilot.d.ts.map

package/dist/types/o2g-cc-pilot.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"o2g-cc-pilot.d.ts","sourceRoot":"","sources":["../../src/o2g-cc-pilot.ts"],"names":[],"mappings":"AAmBA,OAAO,YAAY,MAAM,QAAQ,CAAC;AAKlC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,qBAAa,eAAgB,SAAQ,YAAY;;IAG7C;;;OAGG;IACH,MAAM,CAAC,QAAQ,CAAC,qBAAqB,wBAAwB;IAE7D;;;OAGG;IACH,MAAM,CAAC,QAAQ,CAAC,oBAAoB,uBAAuB;IAE3D;;;OAGG;IACH,MAAM,CAAC,QAAQ,CAAC,qBAAqB,wBAAwB;IAe7D;;;;;;;;OAQG;IACG,YAAY,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAIzD;;;;;;;;OAQG;IACG,WAAW,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;CAG3D"}