o2g-node-sdk 2.4.0 → 2.4.1

package/dist/types/internal/types/eventsummary/eventsummary-types.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Notification sent each time the user's counters have changed.
+ */
+export type OnEventSummaryUpdatedJson = {
+    /**
+     * Login name of the user (identifier which can be used for filtering).
+     */
+    loginName: string;
+    /**
+     * The new event summary.
+     */
+    eventSummary: EventSummaryJson;
+};
+//# sourceMappingURL=eventsummary-types.d.ts.map

package/dist/types/internal/types/eventsummary/eventsummary-types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"eventsummary-types.d.ts","sourceRoot":"","sources":["../../../../../src/internal/types/eventsummary/eventsummary-types.ts"],"names":[],"mappings":"AAuEA;;GAEG;AACH,MAAM,MAAM,yBAAyB,GAAG;IACpC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,YAAY,EAAE,gBAAgB,CAAC;CAClC,CAAC"}

package/dist/types/internal/types/maint/maint-types.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=maint-types.d.ts.map

package/dist/types/internal/types/maint/maint-types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"maint-types.d.ts","sourceRoot":"","sources":["../../../../../src/internal/types/maint/maint-types.ts"],"names":[],"mappings":""}

package/dist/types/internal/types/messaging/messaging-types.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=messaging-types.d.ts.map

package/dist/types/internal/types/messaging/messaging-types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"messaging-types.d.ts","sourceRoot":"","sources":["../../../../../src/internal/types/messaging/messaging-types.ts"],"names":[],"mappings":""}

package/dist/types/internal/types/pbxmngt/pbxmngt-types.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=pbxmngt-types.d.ts.map

package/dist/types/internal/types/pbxmngt/pbxmngt-types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"pbxmngt-types.d.ts","sourceRoot":"","sources":["../../../../../src/internal/types/pbxmngt/pbxmngt-types.ts"],"names":[],"mappings":""}

package/dist/types/internal/types/phoneset/phoneset-types.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=phoneset-types.d.ts.map

package/dist/types/internal/types/phoneset/phoneset-types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"phoneset-types.d.ts","sourceRoot":"","sources":["../../../../../src/internal/types/phoneset/phoneset-types.ts"],"names":[],"mappings":""}

package/dist/types/internal/types/routing/routing-types.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=routing-types.d.ts.map

package/dist/types/internal/types/routing/routing-types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"routing-types.d.ts","sourceRoot":"","sources":["../../../../../src/internal/types/routing/routing-types.ts"],"names":[],"mappings":""}

package/dist/types/internal/types/rsi/rsi-types.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=rsi-types.d.ts.map

package/dist/types/internal/types/rsi/rsi-types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"rsi-types.d.ts","sourceRoot":"","sources":["../../../../../src/internal/types/rsi/rsi-types.ts"],"names":[],"mappings":""}

package/dist/types/internal/types/telephony/telephony-types.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=telephony-types.d.ts.map

package/dist/types/internal/types/telephony/telephony-types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"telephony-types.d.ts","sourceRoot":"","sources":["../../../../../src/internal/types/telephony/telephony-types.ts"],"names":[],"mappings":""}

package/dist/types/internal/types/users/users-types.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=users-types.d.ts.map

package/dist/types/internal/types/users/users-types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"users-types.d.ts","sourceRoot":"","sources":["../../../../../src/internal/types/users/users-types.ts"],"names":[],"mappings":""}

package/dist/types/internal/util/IHttpClient.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=IHttpClient.d.ts.map

package/dist/types/internal/util/IHttpClient.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"IHttpClient.d.ts","sourceRoot":"","sources":["../../../../src/internal/util/IHttpClient.ts"],"names":[],"mappings":""}

package/dist/types/internal/util/assert.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=assert.d.ts.map

package/dist/types/internal/util/assert.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"assert.d.ts","sourceRoot":"","sources":["../../../../src/internal/util/assert.ts"],"names":[],"mappings":""}

package/dist/types/internal/util/file-utils.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=file-utils.d.ts.map

package/dist/types/internal/util/file-utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"file-utils.d.ts","sourceRoot":"","sources":["../../../../src/internal/util/file-utils.ts"],"names":[],"mappings":""}

package/dist/types/internal/util/format-util.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=format-util.d.ts.map

package/dist/types/internal/util/format-util.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"format-util.d.ts","sourceRoot":"","sources":["../../../../src/internal/util/format-util.ts"],"names":[],"mappings":""}

package/dist/types/internal/util/hexa-string.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=hexa-string.d.ts.map

package/dist/types/internal/util/hexa-string.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"hexa-string.d.ts","sourceRoot":"","sources":["../../../../src/internal/util/hexa-string.ts"],"names":[],"mappings":""}

package/dist/types/internal/util/http-client.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=http-client.d.ts.map

package/dist/types/internal/util/http-client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"http-client.d.ts","sourceRoot":"","sources":["../../../../src/internal/util/http-client.ts"],"names":[],"mappings":""}

package/dist/types/internal/util/http-content.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=http-content.d.ts.map

package/dist/types/internal/util/http-content.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"http-content.d.ts","sourceRoot":"","sources":["../../../../src/internal/util/http-content.ts"],"names":[],"mappings":""}

package/dist/types/internal/util/http-response.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=http-response.d.ts.map

package/dist/types/internal/util/http-response.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"http-response.d.ts","sourceRoot":"","sources":["../../../../src/internal/util/http-response.ts"],"names":[],"mappings":""}

package/dist/types/internal/util/injection-container.d.ts

@@ -0,0 +1,5 @@
+import 'reflect-metadata';
+import { Container } from 'inversify';
+declare const ObjectsContainer: Container;
+export {};
+//# sourceMappingURL=injection-container.d.ts.map

package/dist/types/internal/util/injection-container.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"injection-container.d.ts","sourceRoot":"","sources":["../../../../src/internal/util/injection-container.ts"],"names":[],"mappings":"AAmBA,OAAO,kBAAkB,CAAC;AAC1B,OAAO,EAAE,SAAS,EAAE,MAAM,WAAW,CAAC;AAQtC,QAAA,MAAM,gBAAgB,WAAkB,CAAC"}

package/dist/types/internal/util/logger.d.ts

@@ -0,0 +1,7 @@
+declare const _default: {
+    Colors: typeof Color;
+    LogLevels: typeof LogLevel;
+    setLogLevel: (level: LogLevel) => void;
+};
+export default _default;
+//# sourceMappingURL=logger.d.ts.map

package/dist/types/internal/util/logger.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"logger.d.ts","sourceRoot":"","sources":["../../../../src/internal/util/logger.ts"],"names":[],"mappings":";;;yBAkLyB,QAAQ;;AAHjC,wBAYE"}

package/dist/types/internal/util/util-uri.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=util-uri.d.ts.map

package/dist/types/internal/util/util-uri.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"util-uri.d.ts","sourceRoot":"","sources":["../../../../src/internal/util/util-uri.ts"],"names":[],"mappings":""}

package/dist/types/o2g-analytics.d.ts

@@ -0,0 +1,61 @@
+import { Incident } from './types/analytics/incident';
+import { ChargingFile } from './types/analytics/charging-file';
+import { ChargingResult } from './types/analytics/charging-result';
+import { DateRange } from './types/common/date-range';
+/**
+ * The Analytics service allows to retrieve OmniPCX entreprise charging information and incidents.
+ * <p>Using this service requires having a <b>ANALYTICS</b> license. This service requires an administrative login.
+ * <p>
+ * O2G uses SSH to get the information from an OmniPCX Enterprise node. So
+ * <b>SSH must be enabled</b> on the OmniPCX Enterprise node to use this
+ * service.
+ */
+export declare class Analytics {
+    #private;
+    /**
+     * Returns a list of incidents from the specified OmniPCX Enterprise node.
+     * @param nodeId the OmniPCX Enterprise node id
+     * @param last the number of incidents to retrieve
+     */
+    getIncidents(nodeId: number, last?: number): Promise<Array<Incident> | null>;
+    /**
+     * Get the list of charging file from the specified node, using the time range filter.
+     * @param nodeId the OmniPCX Enterprise node id
+     * @param filter  time range filter
+     * @see {@link getChargingsFromFiles}
+     */
+    getChargingFiles(nodeId: number, filter?: DateRange | null): Promise<Array<ChargingFile> | null>;
+    /**
+     * Query the charging information for the specified node, using the specified options.
+     * <p>
+     * If 'all' is set to 'true', all the tickets are returned, including the zero cost ticket, and with the called party; If 'all' is
+     * set to 'false', the total of charging info is returned for each user, the call number giving the number of calls with non null charging cost.
+     * <p>
+     * The request processes charging files on the OmniPCX Enterprise. The processing is limited to a maximum of 100 files for performance reason. If
+     * the range filter is too large and the number of file to process is greater than 100, the method fails and returns 'null'. In this case, a smaller
+     * range must be specified.
+     *
+     * @param nodeId     the OmniPCX Enterprise node id
+     * @param filter     a time range filter
+     * @param topResults allows to return only the 'top N' tickets
+     * @param all        'true' to include tickets with a 0 cost
+     */
+    getChargingsFromFilter(nodeId: number, filter?: DateRange | null, topResults?: number | null, all?: boolean): Promise<ChargingResult | null>;
+    /**
+     * Query the charging information for the specified node, using the specified charging files. The charging files can be retrieved with {@link getChargingFiles}.
+     * <p>
+     * If 'all' is set to 'true', all the tickets are returned, including the zero cost ticket, and with the called party; If 'all' is
+     * set to 'false', the total of charging info is returned for each user, the call number giving the number of calls with non null charging cost.
+     * <p>
+     * The request processes charging files on the OmniPCX Enterprise. The processing is limited to a maximum of 100 files for performance reason. If
+     * the range filter is too large and the number of file to process is greater than 100, the method fails and returns 'null'. In this case, a smaller
+     * range must be specified.
+     *
+     * @param nodeId     the OmniPCX Enterprise node id
+     * @param files     the list of file to process
+     * @param topResults allows to return only the 'top N' tickets
+     * @param all        'true' to include tickets with a 0 cost
+     */
+    getChargingsFromFiles(nodeId: number, files: Array<ChargingFile>, topResults?: number | null, all?: boolean): Promise<ChargingResult | null>;
+}
+//# sourceMappingURL=o2g-analytics.d.ts.map

package/dist/types/o2g-analytics.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"o2g-analytics.d.ts","sourceRoot":"","sources":["../../src/o2g-analytics.ts"],"names":[],"mappings":"AAoBA,OAAO,EAAE,QAAQ,EAAE,MAAM,4BAA4B,CAAC;AACtD,OAAO,EAAE,YAAY,EAAE,MAAM,iCAAiC,CAAC;AAC/D,OAAO,EAAE,cAAc,EAAE,MAAM,mCAAmC,CAAC;AACnE,OAAO,EAAE,SAAS,EAAE,MAAM,2BAA2B,CAAC;AAEtD;;;;;;;GAOG;AACH,qBAAa,SAAS;;IAWlB;;;;OAIG;IACG,YAAY,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,GAAE,MAAU,GAAG,OAAO,CAAC,KAAK,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC;IAIrF;;;;;OAKG;IACG,gBAAgB,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,GAAE,SAAS,GAAG,IAAW,GAAG,OAAO,CAAC,KAAK,CAAC,YAAY,CAAC,GAAG,IAAI,CAAC;IAI5G;;;;;;;;;;;;;;OAcG;IACG,sBAAsB,CACxB,MAAM,EAAE,MAAM,EACd,MAAM,GAAE,SAAS,GAAG,IAAW,EAC/B,UAAU,GAAE,MAAM,GAAG,IAAW,EAChC,GAAG,GAAE,OAAe,GACrB,OAAO,CAAC,cAAc,GAAG,IAAI,CAAC;IAIjC;;;;;;;;;;;;;;OAcG;IACG,qBAAqB,CACvB,MAAM,EAAE,MAAM,EACd,KAAK,EAAE,KAAK,CAAC,YAAY,CAAC,EAC1B,UAAU,GAAE,MAAM,GAAG,IAAW,EAChC,GAAG,GAAE,OAAe,GACrB,OAAO,CAAC,cAAc,GAAG,IAAI,CAAC;CAGpC"}

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"}