o2g-node-sdk 1.0.0

package/README.md

@@ -0,0 +1,10 @@
+# o2g-sdk-node
+
+A Node.js SDK for the O2G platform, providing tools to interact with O2G telephony and call control features.
+
+## Installation
+
+Install via npm:
+
+```bash
+npm install o2g-sdk-node

package/dist/ErrorInfo.d.ts

@@ -0,0 +1,87 @@
+/**
+ * Represents an O2G host.
+ * <p>
+ * An O2G host can be reacheable from the local network, or from a wide area
+ * network. In this case, enterprise access can be secured by a reverse proxy
+ * border element.
+ */
+export type ErrorInfo = {
+    httpStatus?: string;
+    code?: number;
+    helpMessage?: string;
+    type?: string;
+    innerMessage?: string;
+    canRetry?: boolean;
+    routing?: RoutingErrorInfo;
+    telephony?: TelephonyErrorInfo;
+    userPreferences?: UserPreferencesErrorInfo;
+};
+export interface RoutingErrorInfo {
+    errorType: RoutingErrorType;
+    errorCause: RoutingErrorCause;
+    message?: string;
+}
+export declare enum RoutingErrorType {
+    Unknown = "UNKNOWN",
+    BadParameterValue = "BAD_PARAMETER_VALUE",
+    Unauthorized = "UNAUTHORIZED",
+    InvalidOperation = "INVALID_OPERATION",
+    IncompletePhoneNumber = "INCOMPLETE_PHONE_NUMBER",
+    UnknownPhoneNumber = "UNKNOWN_PHONE_NUMBER"
+}
+export declare enum RoutingErrorCause {
+    Unknown = "UNKNOWN",
+    BadPhoneNumberFormat = "BAD_PHONE_NUMBER_FORMAT",
+    InvalidCurrentDevice = "INVALID_CURRENT_DEVICE",
+    InvalidForwardRoute = "INVALID_FORWARD_ROUTE",
+    InvalidOverflowRoute = "INVALID_OVERFLOW_ROUTE",
+    NullOrEmptyParameter = "NULL_OR_EMPTY_PARAMETER",
+    NullParameter = "NULL_PARAMETER",
+    UnauthorizedCancelOverflow = "UNAUTHORIZED_CANCEL_OVERFLOW",
+    UnauthorizedNotAUser = "UNAUTHORIZED_NOT_A_USER",
+    UnauthorizedOverflow = "UNAUTHORIZED_OVERFLOW",
+    UnauthorizedPhoneNumber = "UNAUTHORIZED_PHONE_NUMBER"
+}
+export interface TelephonyErrorInfo {
+    errorType: TelephonyErrorType;
+    errorCause: TelephonyErrorCause;
+    message?: string;
+}
+export declare enum TelephonyErrorType {
+    Unknown = "UNKNOWN",
+    CallReferenceNotFound = "CALL_REFERENCE_NOT_FOUND",
+    MegNotFound = "LEG_NOT_FOUND",
+    BasParameterValue = "BAD_PARAMETER_VALUE",
+    IncompatibleWithState = "INCOMPATIBLE_WITH_STATE",
+    ServiceNotProvided = "SERVICE_NOT_PROVIDED",
+    ServiceUnavailable = "SERVICE_UNAVAILABLE",
+    Initialization = "INITIALIZATION",
+    Unauthorized = "UNAUTHORIZED",
+    CallserverError = "CALL_SERVER_ERROR",
+    RequestTimeout = "REQUEST_TIMEOUT"
+}
+export declare enum TelephonyErrorCause {
+    Unknown = "UNKNOWN",
+    InvalidCalling = "INVALID_CALLING",
+    InvalidDestination = "INVALID_DESTINATION",
+    InvalidCallId = "INVALID_CALL_ID",
+    InvalidConnectionState = "INVALID_CONNECTION_STATE",
+    DeviceOutOfService = "DEVICE_OUT_OF_SERVICE",
+    InvalidDevice = "INVALID_DEVICE",
+    InvalidDeviceState = "INVALID_DEVICE_STATE",
+    InvalidData = "INVALID_DATA",
+    ResourceBusy = "RESOURCE_BUSY"
+}
+export interface UserPreferencesErrorInfo {
+    userPreferencesError: UserPreferencesErrorType;
+    userPreferencesParameter: UserPreferenceParameter;
+}
+export declare enum UserPreferencesErrorType {
+    Unknown = "UNKNOWN",
+    WrongValue = "WRONG_VALUE",
+    WrongNumberFormat = "WRONG_NUMBER_FORMAT"
+}
+export declare enum UserPreferenceParameter {
+    GuiLanguage = "GUI_LANGUAGE",
+    Unknown = "UNKNOWN"
+}

package/dist/host.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Represents an O2G host.
+ * <p>
+ * An O2G host can be reacheable from the local network, or from a wide area
+ * network. In this case, enterprise access can be secured by a reverse proxy
+ * border element.
+ */
+type Host = {
+    /**
+     * The private address for this host.
+     */
+    privateAddress: string;
+    /**
+     * The public address for this host.
+     */
+    publicAddress: string;
+};

package/dist/o2g-analytics.d.ts

@@ -0,0 +1,66 @@
+import AnalyticsRest from "./internal/rest/analytics-rest";
+import { Incident } from "./types/analytics/incident";
+import { ChargingFile } from "./types/analytics/charging-file";
+import { ChargingResult } from "./types/analytics/charging-result";
+import { TimeRange } from "./types/analytics/time-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 _analyticsRest;
+    /**
+     *
+     * @internal
+     */
+    constructor(analyticsRest: AnalyticsRest);
+    /**
+     * 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?: TimeRange | 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?: TimeRange | 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>;
+}

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

@@ -0,0 +1,247 @@
+import { IntrusionMode } from "./types/cc-agent/intrusion-mode";
+import CallCenterAgentRest from "./internal/rest/ccAgent-rest";
+import { OperatorConfig, OperatorState } from "./types/cc-agent/cc-agent-types";
+import { WithdrawReason } from "./types/cc-agent/cc-agent-types";
+import EventEmitter from "events";
+import { EventRegistry } from "./internal/events/event-dispatcher";
+/**
+ * CallCenterAgent provides services for CCD operators. Using this
+ * service requires having a <b>CONTACTCENTER_AGENT</b> license.
+ */
+export declare class CallCenterAgent extends EventEmitter {
+    private readonly _ccAgentRest;
+    /**
+     * Occurs when an agent state has changed.
+     * @event
+     */
+    static readonly ON_AGENT_STATE_CHANGED = "OnAgentStateChanged";
+    /**
+     * Occurs when when CCD agent skills is modified: one or several skills has been activate or deactivate.
+     * @event
+     */
+    static readonly ON_AGENT_SKILL_CHANGED = "OnAgentSkillChanged";
+    /**
+     * Occurs when an agent request help from his supervisor.
+     * @see {@link requestPermanentListening}, {@link requestSupervisorHelp}
+     * @event
+     */
+    static readonly ON_SUPERVISOR_HELP_REQUESTED = "OnSupervisorHelpRequested";
+    /**
+     * Occurs when an agent has requested the assistance of his supervisor and when the request is canceled by the agent
+     * or when the request is rejected by the supervisor.
+     * @see {@link cancelSupervisorHelpRequest}, {@link rejectAgentHelpRequest}
+     * @event
+     */
+    static readonly ON_SUPERVISOR_HELP_CANCELLED = "OnSupervisorHelpCancelled";
+    /**
+     *
+     * @internal
+     */
+    constructor(_ccAgentRest: CallCenterAgentRest, eventRegistry: EventRegistry);
+    /**
+     * Gets the operator configuration.
+     * @param loginName the operator login name
+     * @returns
+     */
+    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
+     */
+    getState(loginName?: string | null): Promise<OperatorState | null>;
+    /**
+     * Logon an agent or a supervisor.
+     * <p>
+     * For a Supervisor, if the 'pgNumber' is omitted, the supervisor is logged on out off 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 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.
+     */
+    logon(proAcdNumber: string, pgNumber?: string | null, headset?: boolean, loginName?: string | null): Promise<boolean>;
+    /**
+     * Logoff an agent or a supervisor.
+     * <p>This method does nothing an returns 'true" if the agent or the 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.
+     */
+    logoff(loginName?: string | null): Promise<boolean>;
+    /**
+     * Enters in a agent group. Only for a supervisor.
+     * <p>
+     * This method is used by a supervisor to enter an agent group when it is in
+     * pre-assigned state (logged 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
+     */
+    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 an go back in
+     * pre-assigned state (logged 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
+     */
+    exit(loginName?: string | null): Promise<boolean>;
+    /**
+     * Puts the specified agent in wrapup.
+     * <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
+     */
+    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
+     */
+    setReady(loginName?: string | null): Promise<boolean>;
+    /**
+     * Puts the specified agent in pause.
+     * <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
+     */
+    setPause(loginName?: string | null): Promise<boolean>;
+    /**
+     * Requests to listen to the agent by a 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 agentNumber the listened agent number
+     * @param loginName   the supervisor login name
+     */
+    requestPermanentListening(agentNumber: string, loginName?: string | null): Promise<boolean>;
+    /**
+     * Cancel a permanent listening by a 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 supervisor login name
+     */
+    cancelPermanentListening(loginName?: string | null): Promise<boolean>;
+    /**
+     * Requests 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.
+     *
+     * @param agentNumber   the extension number of the ccd agent who answers the
+     *                      ccd call
+     * @param intrusionMode the intrusion mode
+     * @param loginName     the supervisor login name
+     */
+    requestIntrusion(agentNumber: string, intrusionMode?: IntrusionMode, loginName?: string | null): Promise<boolean>;
+    /**
+     * Changes the intrusion mode.
+     * <p>
+     * Calling this method allows to change the intrusion mode, or to cancel an intrusion. To cancel an intrusion, the application must 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
+     */
+    changeIntrusionMode(newIntrusionMode: IntrusionMode, loginName?: string | null): Promise<boolean>;
+    /**
+     * Requests help of the supervisor.
+     * <p>
+     * On success, an {@link ON_SUPERVISOR_HELP_REQUESTED} event is raised for both the agent and 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
+     */
+    requestSupervisorHelp(loginName?: string | null): Promise<boolean>;
+    /**
+     * Rejects an help request from an agent.
+     * <p>
+     * This method is invoked by a supervisor when he reject an 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 has requested help
+     * @param loginName   the supervisor login name
+     */
+    rejectAgentHelpRequest(agentNumber: string, loginName?: string | null): Promise<boolean>;
+    /**
+     * Cancels a supervisor help request.
+     * <p>
+     * This method is invoked by an agent when he want to cancel an 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 requested supervisor extension number
+     * @param loginName        the agent login name
+     */
+    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 contain the operator {@link  OperatorState} object. If a second
+     * request is asked since the previous one is still in progress, it has no effect.
+     * <p>
+     * If an administrator invokes this method with loginName=null, the snapshot event request is done for all the agents. The event processing can
+     * be long depending on the number of users.
+     *
+     * @param loginName the agent login name
+     */
+    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 doesn't control the skills number. If a skill number is invalid
+     * (not assigned to the operator), it is ignored and the method returns 'true'.
+     *
+     * @param skills    the list of skills to activate.
+     * @param loginName the agent login name
+     */
+    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 doesn't control the skills number. If a skill number is invalid
+     * (not assigned to the operator), it is ignored and the method returns 'true'.
+     *
+     * @param skills    the list of skills to activate.
+     * @param loginName the agent login name
+     */
+    deactivateSkills(skillNumbers: number[], loginName?: string | null): Promise<boolean>;
+    /**
+     * Returns the list of withdraw reason 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
+     */
+    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.
+     * @see {@link getWithdrawReasons}
+     *
+     * @param reason    the withdraw reason
+     * @param loginName the agent login name
+     */
+    setWithdraw(reason: WithdrawReason, loginName?: string | null): Promise<boolean>;
+}

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

@@ -0,0 +1,32 @@
+import CallCenterManagementRest from "./internal/rest/ccMngt-rest";
+import { Calendar } from "./types/cc-mngt/calendar/calendar";
+import { DayOfWeek } from "./types/cc-mngt/calendar/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";
+/**
+ * This service allows an administrator session to manage CCD pilot objects.
+ * service requires having a <b>CONTACTCENTER_SRV</b> license.
+ */
+export declare class CallCenterManagement {
+    private readonly _ccManagementRest;
+    /**
+     *
+     * @internal
+     */
+    constructor(ccManagementRest: CallCenterManagementRest);
+    getPilots(nodeId: number): Promise<Pilot[] | null>;
+    getPilot(nodeId: number, pilotNumber: string): Promise<Pilot | null>;
+    getCalendar(nodeId: number, pilotNumber: string): Promise<Calendar | null>;
+    getExceptionCalendar(nodeId: number, pilotNumber: string): Promise<ExceptionCalendar | null>;
+    addExceptionTransition(nodeId: number, pilotNumber: string, dateTransition: Date, transition: Transition): Promise<boolean>;
+    deleteExceptionTransition(nodeId: number, pilotNumber: string, dateTransition: Date, index: number): Promise<boolean>;
+    setExceptionTransition(nodeId: number, pilotNumber: string, dateTransition: Date, index: number, transition: Transition): Promise<boolean>;
+    getNormalCalendar(nodeId: number, pilotNumber: string): Promise<NormalCalendar | null>;
+    addNormalTransition(nodeId: number, pilotNumber: string, day: DayOfWeek, transition: Transition): Promise<boolean>;
+    deleteNormalTransition(nodeId: number, pilotNumber: string, day: DayOfWeek, index: number): Promise<boolean>;
+    setNormalTransition(nodeId: number, pilotNumber: string, day: DayOfWeek, index: number, transition: Transition): Promise<boolean>;
+    openPilot(nodeId: number, pilotNumber: string): Promise<boolean>;
+    closePilot(nodeId: number, pilotNumber: string): Promise<boolean>;
+}

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

@@ -0,0 +1,42 @@
+import EventEmitter from "events";
+import CallCenterPilotRest from "./internal/rest/ccPilot-rest";
+import { EventRegistry } from "./internal/events/event-dispatcher";
+/**
+ * CallCenterPilot allows an administrator to monitor the CCD pilots. Using this
+ * service requires having a <b>CONTACTCENTER_SRV</b> license.
+ */
+export declare class CallCenterPilot extends EventEmitter {
+    private readonly _ccPilotRest;
+    /**
+     * 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 the call has been removed from the pilot: cause distribution, cancel or overflow.
+ * @event
+ */
+    static readonly ON_PILOT_CALL_REMOVED = "OnPilotCallRemoved";
+    /**
+     *
+     * @internal
+     */
+    constructor(_ccPilotRest: CallCenterPilotRest, eventRegistry: EventRegistry);
+    /**
+     * Start the monitoring of a pilot.
+     * If the pilot is already monitored, no error is returned.
+     * @param pilotNumber the pilot number
+     */
+    monitorStart(pilotNumber: string): Promise<boolean>;
+    /**
+     * Stop the monitoring of a pilot.
+     * If the pilot is already monitored, no error is returned.
+     * @param pilotNumber the pilot number
+     */
+    monitorStop(pilotNumber: string): Promise<boolean>;
+}