o2g-node-sdk 1.0.1 → 2.4.1

package/package.json

@@ -1,21 +1,54 @@
 {
   "name": "o2g-node-sdk",
-  "version": "1.0.1",
-  "description": "A Node.js library for O2G.",
+  "version": "2.4.1",
+  "description": "A Node.js SDK for the ALE International O2G (OmniPCX OpenTouch Gateway) platform.",
   "main": "dist/o2g-node-sdk.js",
+  "types": "dist/types/o2g-node-sdk.d.ts",
   "scripts": {
-    "tsc": "tsc",
     "build": "webpack --config webpack.config.js",
     "docs": "typedoc --options typedoc.json",
-    "clean": "rm -rf dist docs"
+    "publish:docs": "gh-pages -d docs",
+    "clean": "rimraf dist docs",
+    "test": "jest",
+    "test:watch": "jest --watch",
+    "format": "prettier --write \"src/**/*.ts\""
   },
-  "keywords": [],
-  "author": "",
-  "license": "ISC",
+  "files": [
+    "dist/o2g-node-sdk.js",
+    "dist/o2g-node-sdk.js.map",
+    "dist/types"
+  ],
+  "keywords": [
+    "o2g",
+    "opentouch",
+    "omnipcx",
+    "ale",
+    "telephony",
+    "call-center",
+    "ccd",
+    "pbx"
+  ],
+  "author": "ALE International",
+  "license": "MIT",
   "type": "commonjs",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/ALE-OPENNESS/o2g-node-sdk.git"
+  },
+  "homepage": "https://github.com/ALE-OPENNESS/o2g-node-sdk#readme",
+  "bugs": {
+    "url": "https://github.com/ALE-OPENNESS/o2g-node-sdk/issues"
+  },
   "devDependencies": {
+    "@types/adm-zip": "^0.5.7",
+    "@types/jest": "^30.0.0",
     "@types/node": "^24.0.13",
     "@types/node-fetch": "^2.6.12",
+    "gh-pages": "^6.3.0",
+    "jest": "^30.2.0",
+    "prettier": "^3.8.1",
+    "rimraf": "^6.1.2",
+    "ts-jest": "^29.4.6",
     "ts-loader": "^9.5.2",
     "typedoc": "^0.28.7",
     "typescript": "^5.8.3",
@@ -23,6 +56,7 @@
     "webpack-cli": "^6.0.1"
   },
   "dependencies": {
+    "adm-zip": "^0.5.16",
     "fetch-cookie": "^3.1.0",
     "inversify": "^7.6.1",
     "node-fetch": "^3.3.2",

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

@@ -1,247 +0,0 @@
-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

@@ -1,32 +0,0 @@
-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

@@ -1,42 +0,0 @@
-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>;
-}

package/dist/o2g-comlog.d.ts

@@ -1,173 +0,0 @@
-import EventEmitter from "events";
-import CommunicationLogRest from "./internal/rest/comlog-rest";
-import { ComRecord } from "./types/comlog/com-record";
-import { Page } from "./types/comlog/page";
-import { QueryFilter } from "./types/comlog/query-filter";
-import { QueryResult } from "./types/comlog/query-result";
-import { EventRegistry } from "./internal/events/event-dispatcher";
-/**
- * The CommunicationLog service allows a user to retrieve his last communication history records and to manage them. Using this service requires
- * having a <b>TELEPHONY_ADVANCED</b> license.
- */
-export declare class CommunicationLog extends EventEmitter {
-    private readonly _comLogRest;
-    /**
-     * Occurs when a new comlog entry has been created.
-     * @event
-     */
-    static readonly ON_COM_RECORD_CREATED = "OnComRecordCreated";
-    /**
-     * Occurs when one or more records have been modified.
-     * @event
-     */
-    static readonly ON_COM_RECORD_MODIFIED = "OnComRecordModified";
-    /**
-     * Occurs when one or more call log records have been deleted.
-     * @see {@link deleteComRecords}, {@link deleteComRecord}, {@link deleteComRecordsById}.
-     * @event
-     */
-    static readonly ON_COM_RECORDS_DELETED = "OnComRecordsDeleted";
-    /**
-     * Occurs when one or more unanswered comlog records have been acknowledged.
-     * @see {@link acknowledgeComRecords}, {@link acknowledgeComRecord}
-     * @event
-     */
-    static readonly ON_COM_RECORDS_ACK = "OnComRecordsAck";
-    /**
-     * Occurs when one or more unanswered comlog records have been unacknowledged.
-     * @see {@link unacknowledgeComRecords}, {@link unacknowledgeComRecord}
-     * @event
-     */
-    static readonly ON_COM_RECORDS_UNACK = "OnComRecordsUnAck";
-    /**
-     *
-     * @internal
-     */
-    constructor(_comLogRest: CommunicationLogRest, eventRegistry: EventRegistry);
-    /**
-     * Gets the com records corresponding to the specified filter, using the
-     * specified page, with a possible optimization.
-     * <p>
-     * If 'optimized' is used and set to 'true' the query returns the
-     * full identity of a participant only the first time it occurs, when the same
-     * participant appears in several records. When omitted this query returns the
-     * records with no optimization.
-     * <p>
-     * 'page' parameter allows to query the communication log by page. The
-     * {@link QueryResult} result contains the same parameters and the total number
-     * of records retrieved by the query.
-     * <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 filter    the filter describing the query criterias
-     * @param page      the page description
-     * @param optimized 'true' to activate optimization.
-     * @param loginName the user login name
-     */
-    getComRecords(filter?: QueryFilter | null, page?: Page | null, optimized?: boolean, loginName?: string | null): Promise<QueryResult | null>;
-    /**
-     * Gets the specified com record.
-     * <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 recordId  the com record identifier
-     * @param loginName the user login name
-     */
-    getComRecord(recordId: string, loginName?: string | null): Promise<ComRecord | null>;
-    /**
-     * Deletes the specified com record.
-     * <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 recordId  the com record identifier
-     * @param loginName the user login name
-     */
-    deleteComRecord(recordId: string, loginName?: string | null): Promise<boolean>;
-    /**
-     * Deletes the specified list of com records.
-     * <p>
-     * An {@link ON_COM_RECORDS_DELETED} event is raised containing the list of the com records that have been deleted.
-     * <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 recordIds the list of com records
-     * @param loginName the user login name
-     */
-    deleteComRecordsById(recordIds: string[], loginName?: string | null): Promise<boolean>;
-    /**
-     * Deletes the com records corresponding to the given filter.
-     * <p>
-     * When used, the 'filter' parameter defines the search criteria for the delete operation.
-     * <p>
-     * An {@link ON_COM_RECORDS_DELETED} event is raised
-     * containing the list of the com records that have been deleted.
-     * <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 filter    the filter describing the query criterias
-     * @param loginName the user login name
-     */
-    deleteComRecords(filter?: QueryFilter | null, loginName?: string | null): Promise<boolean>;
-    /**
-     * Acknowledge the specified list of com records.
-     * <p>
-     * An {@link ON_COM_RECORDS_ACK} event is raised containing the list of the com records that have been acknowledged.
-     * <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 recordIds the list of com records
-     * @param loginName the user login name
-     */
-    acknowledgeComRecords(recordIds: string[], loginName?: string | null): Promise<boolean>;
-    /**
-     * Acknowledge the specified com record.
-     * <p>
-     * An {@link ON_COM_RECORDS_ACK} event is raised containing the list of the com records that have been acknowledged.
-     * <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 recordId  the com record identifier
-     * @param loginName the user login name
-     */
-    acknowledgeComRecord(recordId: string, loginName?: string | null): Promise<boolean>;
-    /**
-    * Unacknowledge the specified list of com records.
-    * <p>
-    * An {@link ON_COM_RECORDS_UNACK} event is raised containing the list of the com records that have been acknowledged.
-    * <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 recordIds the list of com records
-    * @param loginName the user login name
-    */
-    unacknowledgeComRecords(recordIds: string[], loginName?: string | null): Promise<boolean>;
-    /**
-     * Unacknowledge the specified com record.
-     * <p>
-     * An {@link ON_COM_RECORDS_UNACK} event is raised containing the list of the com records that have been acknowledged.
-     * <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 recordId  the com record identifier
-     * @param loginName the user login name
-     */
-    unacknowledgeComRecord(recordId: string, loginName?: string | null): Promise<boolean>;
-}

package/dist/o2g-directory.d.ts

@@ -1,88 +0,0 @@
-import DirectoryRest from "./internal/rest/directory-rest";
-import { Criteria } from "./types/directory/criteria";
-import { SearchResult } from "./types/directory/directory-types";
-/**
- * The DirectoryService is used to search contacts in the OmniPCX
- * Enterprise phone book. Using this service requires having a
- * <b>TELEPHONY_ADVANCED</b> license.
- * <p>
- * A directory search is a set of 2 or more sequential operations:
- * <ol>
- * <li>The first operation initiate the search with a set of criteria</li>
- * <li>The second and next operations retrieve results</li>
- * </ol>
- * <p>
- * Note: For each session (user or administrator), only 5 concurrent searches
- * are authorized. An unused search context is freed after 1 minute.
- *
- * <p>
- * @example
- * ```typescript
- *
- *   await o2g.directory.search(myCriteria);
- *   while (!finished) {
- *
- *      let result = await o2g.directory.getResults();
- *      if (result.getResultCode() == SearchResult.ResultCode.NOK) {
- *         // Wait the results
- *      }
- *      else if ((result.getResultCode() == SearchResult.ResultCode.FINISH) ||
- *               (result.getResultCode() == SearchResult.ResultCode.TIMEOUT)) {
- *          // Exit the loop
- *          finished = true;
- *      }
- *      else {
- *         // Process results
- *      }
- *   }
- * ```
- */
-export declare class Directory {
-    private _directoryRest;
-    /**
-     * @internal
-     */
-    constructor(directoryRest: DirectoryRest);
-    /**
-     * Initiates a search for the specified user with the specified filter. The
-     * search will be limited to the specified number of results.
-     * <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 filter    the search filter
-     * @param limit     maximum number of results. The range of supported values is[1 .. 100]
-     * @param loginName the user login name
-     */
-    search(filter: Criteria, limit?: number | null, loginName?: string | null): Promise<boolean>;
-    /**
-     * Cancel a search query for the specified user.
-     * <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 user login name
-     */
-    cancel(loginName?: string | null): Promise<boolean>;
-    /**
-     * Gets the next available results for the current search.
-     * 'getResults' is generally called in a loop and for each iteration
-     * <ul>
-     * <li>if the status result code is 'NOK', the search is in progress but no result is
-     * available : it is recommended to wait before the next iteration (500ms for
-     * example)</li>
-     * <li>if the status result code is 'OK', results are available and can be processed</li>
-     * <li>if the status result code is 'FINISH' or 'TIMEOUT', search is ended, exit from the
-     * loop</li>
-     * </ul>
-     * <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 user login name
-     */
-    getResults(loginName?: string | null): Promise<SearchResult | null>;
-}