o2g-node-sdk 2.5.5 → 2.5.6

package/dist/o2g-node-sdk.js

@@ -8300,7 +8300,7 @@ class TelephonyRest extends rest_service_1.RestService {
     }
     async getPilotInfo(nodeId, pilotNumber, pilotTransferQueryParam = null, loginName = null) {
         __classPrivateFieldGet(this, _TelephonyRest_logger, "f").info(`getPilotInfo nodeId={}, pilotNumber={}, loginName={}`, nodeId, pilotNumber, loginName);
-        let uriPost = util_uri_1.default.appendPath(this._uri, 'pilots', assert_1.AssertUtil.notNullOrEmpty(pilotNumber, 'pilotNumber'), 'transferInfo');
+        let uriPost = util_uri_1.default.appendPath(this._uri, 'pilots', assert_1.AssertUtil.positive(nodeId, "nodeId").toString(), assert_1.AssertUtil.notNullOrEmpty(pilotNumber, 'pilotNumber'), 'transferInfo');
         if (loginName) {
             uriPost = util_uri_1.default.appendQuery(uriPost, 'loginName', loginName);
         }
@@ -8394,7 +8394,7 @@ class UsersManagementRest extends rest_service_1.RestService {
         if (__classPrivateFieldGet(this, _UsersManagementRest_logger, "f").isLevelEnabled(log_level_1.LogLevel.INFO)) {
             __classPrivateFieldGet(this, _UsersManagementRest_logger, "f").info(`getByDeviceNumber deviceNumber=${deviceNumber}`);
         }
-        const uriGet = util_uri_1.default.appendQuery(this._uri, 'deviceNumber=', assert_1.AssertUtil.notNullOrEmpty(deviceNumber, 'deviceNumber'));
+        const uriGet = util_uri_1.default.appendQuery(this._uri, 'deviceNumber', assert_1.AssertUtil.notNullOrEmpty(deviceNumber, 'deviceNumber'));
         const logins = this.getResult(await this._httpClient.get(uriGet));
         if (__classPrivateFieldGet(this, _UsersManagementRest_logger, "f").isLevelEnabled(log_level_1.LogLevel.DEBUG)) {
             __classPrivateFieldGet(this, _UsersManagementRest_logger, "f").debug(`getByDeviceNumber result={}`, logins);
@@ -8422,8 +8422,16 @@ class UsersManagementRest extends rest_service_1.RestService {
         if (__classPrivateFieldGet(this, _UsersManagementRest_logger, "f").isLevelEnabled(log_level_1.LogLevel.DEBUG)) {
             __classPrivateFieldGet(this, _UsersManagementRest_logger, "f").debug(`createUsers request={}`, req);
         }
-        let httpResponse = await this._httpClient.post(uriPost, new http_content_1.HttpContent(JSON.stringify(req)));
-        return httpResponse.isSuccessStatusCode();
+        const _json = this.getResult(await this._httpClient.post(uriPost, new http_content_1.HttpContent(JSON.stringify(req))));
+        if (__classPrivateFieldGet(this, _UsersManagementRest_logger, "f").isLevelEnabled(log_level_1.LogLevel.DEBUG)) {
+            __classPrivateFieldGet(this, _UsersManagementRest_logger, "f").debug(`createUsers result={}`, _json);
+        }
+        if (_json && Array.isArray(_json.users)) {
+            return _json.users.map(user_1.User.fromJson);
+        }
+        else {
+            return null;
+        }
     }
     async getByLoginName(loginName) {
         if (__classPrivateFieldGet(this, _UsersManagementRest_logger, "f").isLevelEnabled(log_level_1.LogLevel.INFO)) {
@@ -11902,12 +11910,11 @@ var _Analytics_analyticsRest;
 Object.defineProperty(exports, "__esModule", ({ value: true }));
 exports.Analytics = void 0;
 /**
- * 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.
+ * The Analytics service provides access to OmniPCX Enterprise charging information and incident reports.
  * <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.
+ * Using this service requires an <b>ANALYTICS</b> license and an administrative login.
+ * O2G uses SSH to collect information from an OmniPCX Enterprise node, so
+ * <b>SSH must be enabled</b> on the node.
  */
 class Analytics {
     /**
@@ -11919,54 +11926,64 @@ class Analytics {
         __classPrivateFieldSet(this, _Analytics_analyticsRest, analyticsRest, "f");
     }
     /**
-     * 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
+     * Retrieves a list of incidents from the specified OmniPCX Enterprise node.
+     *
+     * @param nodeId the OmniPCX Enterprise node identifier
+     * @param last the maximum number of incidents to retrieve; pass `0` to retrieve all incidents currently in progress
+     * @returns an array of {@link Incident} objects, or `null` if the request fails
      */
     async getIncidents(nodeId, last = 0) {
         return await __classPrivateFieldGet(this, _Analytics_analyticsRest, "f").getIncidents(nodeId, last);
     }
     /**
-     * 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
+     * Retrieves the list of charging files available on the specified node.
+     *
+     * @param nodeId the OmniPCX Enterprise node identifier
+     * @param filter an optional date range filter; when omitted, all available charging files are returned
+     * @returns an array of {@link ChargingFile} objects, or `null` if the request fails
      * @see {@link getChargingsFromFiles}
      */
     async getChargingFiles(nodeId, filter = null) {
         return await __classPrivateFieldGet(this, _Analytics_analyticsRest, "f").getChargingFiles(nodeId, filter);
     }
     /**
-     * Query the charging information for the specified node, using the specified options.
+     * Queries the charging information for the specified node using a date range filter and the given 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.
+     * If `all` is set to `true`, all tickets are returned, including zero-cost tickets and the called party.
+     * If `all` is set to `false`, the total charging information is returned per user, with the call count
+     * reflecting only calls that have a 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.
+     * Processing is limited to a maximum of 100 charging files for performance reasons. If the date range filter
+     * is too wide and the number of files to process exceeds 100, the method fails and returns `null`. In that
+     * case, a narrower date 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
+     * @param nodeId the OmniPCX Enterprise node identifier
+     * @param filter an optional date range filter
+     * @param topResults an optional limit to return only the top N tickets
+     * @param all `true` to include tickets with a 0 cost
+     * @returns a {@link ChargingResult} object, or `null` in case of error or if the filter yields no results
      */
     async getChargingsFromFilter(nodeId, filter = null, topResults = null, all = false) {
         return await __classPrivateFieldGet(this, _Analytics_analyticsRest, "f").getChargingsFromFilter(nodeId, filter, topResults, all);
     }
     /**
-     * Query the charging information for the specified node, using the specified charging files. The charging files can be retrieved with {@link getChargingFiles}.
+     * Queries the charging information for the specified node, processing the given charging files with the specified options.
+     * <p>
+     * This method gives finer control over the request by letting the caller specify the exact list of charging files to
+     * process. The list can be obtained via {@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.
+     * If `all` is set to `true`, all tickets are returned, including zero-cost tickets and the called party.
+     * If `all` is set to `false`, the total charging information is returned per user, with the call count
+     * reflecting only calls that have a 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.
+     * Processing is limited to a maximum of 100 files for performance reasons. If the number of files exceeds 100,
+     * the method fails and returns `null`.
      *
-     * @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
+     * @param nodeId the OmniPCX Enterprise node identifier
+     * @param files the list of charging files to process
+     * @param topResults an optional limit to return only the top N tickets
+     * @param all `true` to include tickets with a 0 cost
+     * @returns a {@link ChargingResult} object, or `null` in case of error or if the specified files yield no results
      */
     async getChargingsFromFiles(nodeId, files, topResults = null, all = false) {
         return await __classPrivateFieldGet(this, _Analytics_analyticsRest, "f").getChargingsFromFiles(nodeId, files, topResults, all);
@@ -12025,8 +12042,10 @@ const intrusion_mode_1 = __webpack_require__(/*! ../types/cc-agent/intrusion-mod
 const events_1 = __importDefault(__webpack_require__(/*! events */ "events"));
 const cc_agent_events_1 = __webpack_require__(/*! ../types/cc-agent/cc-agent-events */ "./src/types/cc-agent/cc-agent-events.ts");
 /**
- * CallCenterAgent provides services for CCD operators. Using this
- * service requires having a <b>CONTACTCENTER_AGENT</b> license.
+ * `CallCenterAgent` provides access to Contact Center features for CCD operators.
+ * A CCD operator can be either a CCD agent or a CCD supervisor.
+ * <p>
+ * Using this service requires having a <b>CONTACTCENTER_AGENT</b> license.
  */
 class CallCenterAgent extends events_1.default {
     /**
@@ -12061,6 +12080,7 @@ class CallCenterAgent extends events_1.default {
      *
      * @param loginName the operator login name
      * @returns the {@link OperatorState} on success; `null` otherwise.
+     * @see requestSnapshot
      */
     async getState(loginName = null) {
         return await __classPrivateFieldGet(this, _CallCenterAgent_ccAgentRest, "f").getState(loginName);
@@ -12168,7 +12188,7 @@ class CallCenterAgent extends events_1.default {
         return await __classPrivateFieldGet(this, _CallCenterAgent_ccAgentRest, "f").setReady(loginName);
     }
     /**
-     * Puts the specified agent in pause state.
+     * 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.
@@ -12180,7 +12200,7 @@ class CallCenterAgent extends events_1.default {
         return await __classPrivateFieldGet(this, _CallCenterAgent_ccAgentRest, "f").setPause(loginName);
     }
     /**
-     * Requests a supervisor to listen to the specified agent.
+     * Requests a supervisor to listen to the specified agent (permanent listening).
      * <p>
      * On success, an {@link ON_SUPERVISOR_HELP_REQUESTED} event is raised for both the agent and the supervisor.
      * <p>
@@ -12225,7 +12245,7 @@ class CallCenterAgent extends events_1.default {
         return await __classPrivateFieldGet(this, _CallCenterAgent_ccAgentRest, "f").cancelPermanentListening(loginName);
     }
     /**
-     * Requests an intrusion in a CCD call.
+     * 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.
@@ -12245,7 +12265,7 @@ class CallCenterAgent extends events_1.default {
      * await O2G.callCenterAgent.changeIntrusionMode(IntrusionMode.NORMAL);
      * ```
      *
-     * @param agentNumber   the extension number of the CCD agent answering the call
+     * @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
      * @returns `true` if the operation succeeded; `false` otherwise.
@@ -12295,7 +12315,7 @@ class CallCenterAgent extends events_1.default {
      * 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 agentNumber the extension number of the agent who has requested help
      * @param loginName   the supervisor login name
      * @returns `true` if the operation succeeded; `false` otherwise.
      * @see cancelSupervisorHelpRequest
@@ -12332,6 +12352,7 @@ class CallCenterAgent extends events_1.default {
      *
      * @param loginName the agent login name
      * @returns `true` if the request was successfully submitted; `false` otherwise.
+     * @see getState
      */
     async requestSnapshot(loginName = null) {
         return await __classPrivateFieldGet(this, _CallCenterAgent_ccAgentRest, "f").requestSnapshot(loginName);
@@ -12494,9 +12515,22 @@ var _CallCenterManagement_ccManagementRest;
 Object.defineProperty(exports, "__esModule", ({ value: true }));
 exports.CallCenterManagement = void 0;
 /**
- * This service allows an administrator session to manage CCD pilot objects.
+ * `CallCenterManagement` provides operations to configure and manage CCD pilots
+ * and their associated calendars.
+ * <p>
+ * Each CCD pilot has two types of calendars:
+ * <ul>
+ *   <li><b>Normal calendar</b> — defines standard pilot behaviour for each day of the
+ *       week. Each day can have up to 10 transitions (time slots).</li>
+ *   <li><b>Exception calendar</b> — defines special days that override the normal
+ *       calendar (e.g. holidays). Each exceptional day can also have up to 10
+ *       transitions.</li>
+ * </ul>
+ * A {@link Transition} represents a time slot in a calendar, including the start
+ * time, the pilot rule to apply, and the pilot operating mode.
  * <p>
- * This service requires having a <b>CONTACTCENTER_SRV</b> license.
+ * Using this service requires having a <b>CONTACTCENTER_SERVICE</b> license in
+ * CAPEX mode, or 40 api-tel-f subscriptions in OPEX mode (Purple On Demand).
  */
 class CallCenterManagement {
     /**
@@ -12508,10 +12542,10 @@ class CallCenterManagement {
         __classPrivateFieldSet(this, _CallCenterManagement_ccManagementRest, ccManagementRest, "f");
     }
     /**
-     * Retrieves the list of CCD pilots configured on the specified OmniPCX Enterprise node.
+     * Returns all 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.
+     * @param nodeId the OmniPCX Enterprise node identifier
+     * @returns the list of {@link Pilot} objects, or `null` if no pilots are configured.
      */
     async getPilots(nodeId) {
         return __classPrivateFieldGet(this, _CallCenterManagement_ccManagementRest, "f").getPilots(nodeId);
@@ -12540,13 +12574,13 @@ class CallCenterManagement {
      * const pilotAdvanced = await O2G.callCenterManagement.getPilot(1, "60141", queryParam);
      * ```
      *
-     * @param nodeId                  the PCX Enterprise node id
+     * @param nodeId                  the OmniPCX Enterprise node identifier
      * @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.
+     * @returns the {@link Pilot} information, or `null` if not found.
      */
     async getPilot(nodeId, pilotNumber, pilotTransferQueryParam = null) {
         if (pilotTransferQueryParam) {
@@ -12557,27 +12591,27 @@ class CallCenterManagement {
         }
     }
     /**
-     * Retrieves the routing calendar of the specified CCD pilot.
+     * Returns the calendar associated with the specified CCD pilot.
      * <p>
-     * The calendar defines the normal and exception schedules that govern
+     * The calendar combines the normal and exception schedules that govern
      * the pilot's open/closed state over time.
      *
-     * @param nodeId      the PCX Enterprise node id
+     * @param nodeId      the OmniPCX Enterprise node identifier
      * @param pilotNumber the pilot number
-     * @returns the {@link Calendar} on success; `null` otherwise.
+     * @returns the {@link Calendar} of the pilot, or `null` if not found.
      */
     async getCalendar(nodeId, pilotNumber) {
         return __classPrivateFieldGet(this, _CallCenterManagement_ccManagementRest, "f").getCalendar(nodeId, pilotNumber);
     }
     /**
-     * Retrieves the exception calendar of the specified CCD pilot.
+     * Returns the exception calendar for 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 nodeId      the OmniPCX Enterprise node identifier
      * @param pilotNumber the pilot number
-     * @returns the {@link ExceptionCalendar} on success; `null` otherwise.
+     * @returns the {@link ExceptionCalendar}, or `null` if not found.
      */
     async getExceptionCalendar(nodeId, pilotNumber) {
         return __classPrivateFieldGet(this, _CallCenterManagement_ccManagementRest, "f").getExceptionCalendar(nodeId, pilotNumber);
@@ -12600,10 +12634,10 @@ class CallCenterManagement {
      * await O2G.callCenterManagement.deleteExceptionTransition(1, "60141", christmas, 0);
      * ```
      *
-     * @param nodeId         the PCX Enterprise node id
+     * @param nodeId         the OmniPCX Enterprise node identifier
      * @param pilotNumber    the pilot number
-     * @param dateTransition the date for which the exception transition applies
-     * @param transition     the transition to add
+     * @param dateTransition the exceptional day to which the transition applies
+     * @param transition     the {@link Transition} to add
      * @returns `true` if the operation succeeded; `false` otherwise.
      */
     async addExceptionTransition(nodeId, pilotNumber, dateTransition, transition) {
@@ -12611,38 +12645,42 @@ class CallCenterManagement {
     }
     /**
      * Deletes a transition from the exception calendar of the specified CCD pilot.
+     * <p>
+     * The transition is identified by its zero-based index in the list of transitions for the day.
      *
-     * @param nodeId         the PCX Enterprise node id
+     * @param nodeId         the OmniPCX Enterprise node identifier
      * @param pilotNumber    the pilot number
-     * @param dateTransition the date of the exception transition to delete
-     * @param index          the index of the transition to delete
+     * @param dateTransition the exceptional day from which to remove the transition
+     * @param index          the zero-based index of the transition to delete
      * @returns `true` if the operation succeeded; `false` otherwise.
      */
     async deleteExceptionTransition(nodeId, pilotNumber, dateTransition, index) {
         return __classPrivateFieldGet(this, _CallCenterManagement_ccManagementRest, "f").deleteExceptionTransition(nodeId, pilotNumber, dateTransition, index);
     }
     /**
-     * Updates a transition in the exception calendar of the specified CCD pilot.
+     * Modifies a transition in the exception calendar of the specified CCD pilot.
+     * <p>
+     * The transition is identified by its zero-based index in the list of transitions for the day.
      *
-     * @param nodeId         the PCX Enterprise node id
+     * @param nodeId         the OmniPCX Enterprise node identifier
      * @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
+     * @param dateTransition the exceptional day containing the transition to modify
+     * @param index          the zero-based index of the transition to modify
+     * @param transition     the new {@link Transition} value
      * @returns `true` if the operation succeeded; `false` otherwise.
      */
     async setExceptionTransition(nodeId, pilotNumber, dateTransition, index, transition) {
         return __classPrivateFieldGet(this, _CallCenterManagement_ccManagementRest, "f").setExceptionTransition(nodeId, pilotNumber, dateTransition, index, transition);
     }
     /**
-     * Retrieves the normal (weekly) calendar of the specified CCD pilot.
+     * Returns 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 nodeId      the OmniPCX Enterprise node identifier
      * @param pilotNumber the pilot number
-     * @returns the {@link NormalCalendar} on success; `null` otherwise.
+     * @returns the {@link NormalCalendar}, or `null` if not found.
      */
     async getNormalCalendar(nodeId, pilotNumber) {
         return __classPrivateFieldGet(this, _CallCenterManagement_ccManagementRest, "f").getNormalCalendar(nodeId, pilotNumber);
@@ -12668,10 +12706,10 @@ class CallCenterManagement {
      * await O2G.callCenterManagement.deleteNormalTransition(1, "60141", DayOfWeek.MONDAY, 1);
      * ```
      *
-     * @param nodeId      the PCX Enterprise node id
+     * @param nodeId      the OmniPCX Enterprise node identifier
      * @param pilotNumber the pilot number
      * @param day         the day of the week to which the transition applies
-     * @param transition  the transition to add
+     * @param transition  the {@link Transition} to add
      * @returns `true` if the operation succeeded; `false` otherwise.
      */
     async addNormalTransition(nodeId, pilotNumber, day, transition) {
@@ -12679,24 +12717,28 @@ class CallCenterManagement {
     }
     /**
      * Deletes a transition from the normal calendar of the specified CCD pilot.
+     * <p>
+     * The transition is identified by its zero-based index in the list of transitions for the day.
      *
-     * @param nodeId      the PCX Enterprise node id
+     * @param nodeId      the OmniPCX Enterprise node identifier
      * @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
+     * @param day         the day of the week from which to remove the transition
+     * @param index       the zero-based index of the transition to delete
      * @returns `true` if the operation succeeded; `false` otherwise.
      */
     async deleteNormalTransition(nodeId, pilotNumber, day, index) {
         return __classPrivateFieldGet(this, _CallCenterManagement_ccManagementRest, "f").deleteNormalTransition(nodeId, pilotNumber, day, index);
     }
     /**
-     * Updates a transition in the normal calendar of the specified CCD pilot.
+     * Modifies a transition in the normal calendar of the specified CCD pilot.
+     * <p>
+     * The transition is identified by its zero-based index in the list of transitions for the day.
      *
-     * @param nodeId      the PCX Enterprise node id
+     * @param nodeId      the OmniPCX Enterprise node identifier
      * @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
+     * @param day         the day of the week containing the transition to modify
+     * @param index       the zero-based index of the transition to modify
+     * @param transition  the new {@link Transition} value
      * @returns `true` if the operation succeeded; `false` otherwise.
      */
     async setNormalTransition(nodeId, pilotNumber, day, index, transition) {
@@ -12718,7 +12760,7 @@ class CallCenterManagement {
      * // scheduled calendar transition occurs.
      * ```
      *
-     * @param nodeId      the PCX Enterprise node id
+     * @param nodeId      the OmniPCX Enterprise node identifier
      * @param pilotNumber the pilot number
      * @returns `true` if the operation succeeded; `false` otherwise.
      */
@@ -12728,7 +12770,7 @@ class CallCenterManagement {
     /**
      * Forces the specified CCD pilot into the closed state, regardless of its calendar schedule.
      *
-     * @param nodeId      the PCX Enterprise node id
+     * @param nodeId      the OmniPCX Enterprise node identifier
      * @param pilotNumber the pilot number
      * @returns `true` if the operation succeeded; `false` otherwise.
      */
@@ -12788,12 +12830,14 @@ exports.CallCenterPilot = void 0;
 const events_1 = __importDefault(__webpack_require__(/*! events */ "events"));
 const cc_pilot_events_1 = __webpack_require__(/*! ../types/cc-pilot/cc-pilot-events */ "./src/types/cc-pilot/cc-pilot-events.ts");
 /**
- * CallCenterPilot allows an administrator to monitor the CCD pilots. Using this
- * service requires having a <b>CONTACTCENTER_SRV</b> license.
+ * `CallCenterPilot` allows an administrator to monitor CCD pilots.
  * <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}.
+ * <p>
+ * Using this service requires having a <b>CONTACTCENTER_SERVICE</b> license in
+ * CAPEX mode, or 40 api-tel-f subscriptions in OPEX mode (Purple On Demand).
  *
  * @example
  * ```typescript
@@ -12859,17 +12903,17 @@ class CallCenterPilot extends events_1.default {
 exports.CallCenterPilot = CallCenterPilot;
 _CallCenterPilot_ccPilotRest = new WeakMap();
 /**
- * Occurs when a new call arrives on a pilot.
+ * Occurs when a new call arrives on a CCD pilot.
  * @event
  */
 CallCenterPilot.ON_PILOT_CALL_CREATED = 'OnPilotCallCreated';
 /**
- * Occurs when the call has been queued.
+ * Occurs when a CCD call is routed into a queue.
  * @event
  */
 CallCenterPilot.ON_PILOT_CALL_QUEUED = 'OnPilotCallQueued';
 /**
- * Occurs when a call has been removed from the pilot: by distribution, cancellation or overflow.
+ * Occurs when a CCD call has been removed from the queue, either by distribution, cancellation, or overflow.
  * @event
  */
 CallCenterPilot.ON_PILOT_CALL_REMOVED = 'OnPilotCallRemoved';
@@ -12993,11 +13037,12 @@ class CallCenterRealtime extends events_1.default {
     }
     /**
      * Retrieves all CCD objects that currently provide real-time information.
-     *
+     * <p>
      * The returned {@link RtiObjects} includes collections of agents, pilots,
      * queues, and processing groups that can be monitored.
      *
-     * Returns `null` if no objects are available or an error occurs.
+     * @returns The {@link RtiObjects} containing the CCD objects, or `null` if no objects
+     *          are available or an error occurs.
      */
     async getRtiObjects() {
         return __classPrivateFieldGet(this, _CallCenterRealtime_ccRealtimeRest, "f").getRtiObjects();
@@ -13006,7 +13051,7 @@ class CallCenterRealtime extends events_1.default {
      * Returns all CCD agents that provide real-time information.
      *
      * @returns An array of {@link RtiObjectIdentifier} representing agents,
-     *          or an empty array if none exist.
+     *          or an empty array if none exist, or `null` if an error occurs.
      */
     async getAgents() {
         return __classPrivateFieldGet(this, _CallCenterRealtime_ccRealtimeRest, "f").getAgents();
@@ -13160,8 +13205,18 @@ var _CallCenterStatistics_ccStatisticsRest;
 Object.defineProperty(exports, "__esModule", ({ value: true }));
 exports.CallCenterStatistics = void 0;
 /**
- * CallCenterStatistics provides access to historical ACD statistics and reporting.
- * Using this service requires having a <b>CONTACTCENTER_SRV</b> license.
+ * Provides access to historical ACD statistics and reporting for CCD agents and pilots.
+ * <p>
+ * Using this service requires a <b>CONTACTCENTER_SERVICE</b> license in CAPEX mode, or a
+ * <b>40 api-tel-f</b> subscription in OPEX mode (Purple On Demand).
+ * <p>
+ * This service supports two modes of data retrieval:
+ * <ul>
+ * <li><b>Immediate reports</b> — statistics retrieved on demand, returned as in-memory data
+ *     or exported as CSV or Excel files.</li>
+ * <li><b>Scheduled reports</b> — recurring statistics delivered as email attachments to
+ *     predefined recipients.</li>
+ * </ul>
  * <p>
  * Statistics are accessed through a two-level hierarchy:
  * <ul>
@@ -13221,24 +13276,24 @@ class CallCenterStatistics {
         __classPrivateFieldSet(this, _CallCenterStatistics_ccStatisticsRest, ccStatisticsRest, "f");
     }
     /**
-     * Returns whether there is an asynchronous statistics request currently in progress.
-     *
-     * This can be useful to check before calling {@link getDayFileData} or {@link getDaysFileData},
-     * since both methods enforce that only one request can run at a time.
+     * Returns whether an asynchronous statistics report generation request is currently in progress.
+     * <p>
+     * Use this method to check before calling {@link getDayFileData} or {@link getDaysFileData},
+     * since both methods enforce that only one request can be active at a time.
      *
-     * @returns `true` if a statistics request is currently active, `false` otherwise
+     * @returns `true` if a statistics request is currently active; `false` otherwise
      */
     hasAsyncRequestInProgress() {
         return __classPrivateFieldGet(this, _CallCenterStatistics_ccStatisticsRest, "f").hasAsyncRequestInProgress();
     }
     /**
-     * Creates a new `Requester` with the specified identifier, language, and time zone,
-     * and establishes the statistics scope defining which agents' data the requester
-     * is authorized to access.
-     *
-     * This method determines the set of agents whose statistics can be retrieved by
-     * the specified requester. Once the scope is created, the requester can query
-     * individual or aggregated statistics for those agents through the reporting services.
+     * Creates a new {@link Requester} with the specified identifier, language, and time zone,
+     * and establishes the statistics scope defining which agents' data the requester is
+     * authorized to access.
+     * <p>
+     * The agent scope determines which agents' statistics can be retrieved by the requester.
+     * Once created, the requester can query individual or aggregated statistics for those
+     * agents through the reporting services.
      *
      * @example
      * ```typescript
@@ -13259,164 +13314,151 @@ class CallCenterStatistics {
      * );
      * ```
      *
-     * @param id       the unique identifier of the requester
+     * @param id       the unique identifier of the requester (e.g., a supervisor ID)
      * @param language the requester's preferred {@link Language}
      * @param timezone the requester's time zone (e.g. `"Europe/Paris"`)
-     * @param agents   the agent identifiers that define the scope of accessible statistics
-     * @returns the newly created {@link Requester} on success; `null` otherwise.
+     * @param agents   the agent directory numbers that define the scope of accessible statistics
+     * @returns the newly created {@link Requester} on success; `null` otherwise
      * @see deleteRequester
      */
     async createRequester(id, language, timezone, ...agents) {
         return __classPrivateFieldGet(this, _CallCenterStatistics_ccStatisticsRest, "f").createRequester(id, language, timezone, agents);
     }
     /**
-     * Removes the requester and all its associated contexts.
-     *
-     * After calling this method, the specified requester will no longer have
-     * access to any agent statistics defined under their scope.
+     * Removes the specified requester and all its associated contexts.
+     * <p>
+     * After this call, the requester no longer has access to any agent statistics defined
+     * under its scope.
      *
-     * @param requester - The requester to removed.
-     * @returns `true` if the requester was successfully removed; otherwise, `false`.
+     * @param requester the requester to remove
+     * @returns `true` if the requester was successfully removed; `false` otherwise
      */
     async deleteRequester(requester) {
         return __classPrivateFieldGet(this, _CallCenterStatistics_ccStatisticsRest, "f").deleteRequester(requester);
     }
     /**
      * Retrieves the requester associated with the specified identifier.
+     * <p>
+     * The returned requester represents the scope of agents for which statistics can be
+     * accessed. If no requester exists with the given ID, this method returns `null`.
      *
-     * The returned requester represents the scope of agents for which statistics
-     * can be accessed. If no requester exists with the given ID, this method
-     * returns `null`.
-     *
-     * @param id - The unique identifier of the requester.
-     * @returns The `Requester` object corresponding to the ID, or `null`
-     *          if no matching requester is found.
+     * @param id the unique identifier of the requester
+     * @returns the {@link Requester} object corresponding to the ID, or `null` if no matching
+     *          requester is found
      */
     async getRequester(id) {
         return __classPrivateFieldGet(this, _CallCenterStatistics_ccStatisticsRest, "f").getRequester(id);
     }
     /**
-     * Creates a new statistical context with the specified label, description, and filter
+     * Creates a new statistics context with the specified label, description, and filter
      * for the given requester.
+     * <p>
+     * A context defines the filter criteria (pilots, agents, queues) for which call-center
+     * statistics are collected and analyzed.
      *
-     * A context defines a scope for which call center statistics can be collected and analyzed
-     * according to the specified filter criteria.
-     *
-     * @param requester - the requester for whom the context is being created
-     * @param label - a short label identifying this context
-     * @param description - a detailed description of the context
-     * @param filter - the filter defining the selection criteria for the context
-     * @returns the created `StatContext` if successful; `null` otherwise
+     * @param requester   the requester for whom the context is created
+     * @param label       a short label identifying this context
+     * @param description a detailed description of the context
+     * @param filter      the filter defining the selection criteria for the context
+     * @returns the created {@link StatsContext} if successful; `null` otherwise
      */
     async createContext(requester, label, description, filter) {
         return __classPrivateFieldGet(this, _CallCenterStatistics_ccStatisticsRest, "f").createContext(requester, label, description, filter);
     }
     /**
-     * Deletes all statistical contexts associated with the specified requester.
-     *
-     * A context defines a scope for collecting and analyzing call center statistics
-     * according to its associated filter criteria.
-     *
-     * @param requester - The requester whose contexts should be deleted.
-     * @returns `true` if all contexts were successfully deleted; `false`
-     * if an error occurred or no contexts were deleted.
+     * Deletes all statistics contexts associated with the specified requester.
      *
+     * @param requester the requester whose contexts should be deleted
+     * @returns `true` if all contexts were successfully deleted; `false` if an error occurred
+     *          or no contexts were deleted
      * @see createContext
      */
     async deleteContexts(requester) {
         return __classPrivateFieldGet(this, _CallCenterStatistics_ccStatisticsRest, "f").deleteContexts(requester);
     }
     /**
-     * Retrieves the statistical contexts created for the specified requester.
-     *
-     * Each context defines a scope for collecting and analyzing call center statistics
-     * according to its associated filter criteria.
+     * Retrieves all statistics contexts created for the specified requester.
      *
-     * @param requester - The requester whose contexts are being retrieved.
-     * @returns An array of `Context` objects if successful; `null`
-     *          if there is an error or if no contexts exist for this requester.
+     * @param requester the requester whose contexts are retrieved
+     * @returns an array of {@link StatsContext} objects if successful; `null` if there is an
+     *          error or if no contexts exist for this requester
      * @see createContext
      */
     async getContexts(requester) {
         return __classPrivateFieldGet(this, _CallCenterStatistics_ccStatisticsRest, "f").getContexts(requester);
     }
     /**
-     * Retrieves a statistical context by its identifier for the specified requester.
+     * Retrieves a statistics context by its identifier for the specified requester.
      *
-     * A context defines a scope for collecting and analyzing call center statistics
-     * according to its associated filter criteria.
-     *
-     * @param requester - The requester who owns the context.
-     * @param contextId - The unique identifier of the context.
-     * @returns The {@link StatsContext} if found and retrieval is successful; `null`
-     * if there is an error or if no context exists with the specified identifier.
+     * @param requester the requester who owns the context
+     * @param contextId the unique identifier of the context
+     * @returns the {@link StatsContext} if found; `null` if no context exists with the
+     *          specified identifier or if an error occurred
      */
     async getContext(requester, contextId) {
         return __classPrivateFieldGet(this, _CallCenterStatistics_ccStatisticsRest, "f").getContext(requester, contextId);
     }
     /**
-     * Deletes the specified statistical context.
-     *
-     * A context defines a scope for collecting and analyzing call center statistics
-     * according to its associated filter criteria.
+     * Deletes the specified statistics context.
      *
-     * @param context - The context to be deleted.
-     * @returns `true` if the context was successfully deleted; `false`
-     *          if an error occurred or the context could not be deleted.
-     * @see createContext(requester: Requester, name: string, description: string, filter: Filter)
+     * @param context the context to delete
+     * @returns `true` if the context was successfully deleted; `false` if an error occurred or
+     *          the context could not be deleted
+     * @see createContext
      */
     async deleteContext(context) {
         return __classPrivateFieldGet(this, _CallCenterStatistics_ccStatisticsRest, "f").deleteContext(context);
     }
     /**
-     * Retrieves statistical data for the specified context.
-     *
-     * This method generates a multi-day report corresponding to the time range
-     * defined by the provided {@link DateRange}. It allows reporting and analysis
-     * of call center metrics across multiple days within the selected period.
-     *
-     * The returned {@link StatisticsData} object contains the aggregated data,
-     * suitable for further processing or integration.
+     * Returns aggregated statistics for a range of days.
+     * <p>
+     * Multi-day reports provide one row of aggregated data per agent or pilot per day.
+     * The range can cover up to 31 consecutive days within the last 12 months and may span
+     * month boundaries.
      *
-     * @param context - The context defining the scope and filters for the statistics.
-     * @param range - The date range over which to collect statistics.
-     * @param shortHeader - True to return only limited number of headers in response
-     * @returns A {@link StatisticsData} object containing the data,
-     *          or `null` if the data could not be retrieved.
+     * @param context     the context defining the scope and filters for the statistics
+     * @param range       the date range over which to collect statistics
+     * @param shortHeader `true` to return only a limited number of headers in the response
+     * @returns a {@link StatisticsData} object containing the aggregated data, or `null` if the
+     *          data could not be retrieved
      */
     async getDaysData(context, range, shortHeader = false) {
         return __classPrivateFieldGet(this, _CallCenterStatistics_ccStatisticsRest, "f").getDaysData(context, shortHeader, range);
     }
     /**
-     * Retrieves statistical data for the specified context for a single day.
-     *
-     * The statistics are provided in time slots according to the `timeInterval` parameter.
-     *
-     * - If `date` is not provided, the current day is used.
-     * - If `timeInterval` is not provided or `undefined`, it is ignored and
-     *   `TimeInterval.QUARTE_HOUR` is used as the default value.
+     * Returns statistics for a single day.
+     * <p>
+     * Statistics are provided in time slots according to the `timeInterval` parameter,
+     * spanning from 00:00 until the last completed interval of the specified day.
+     * <p>
+     * If `date` is not provided, the current day is used. If `timeInterval` is not provided,
+     * `TimeInterval.QUARTE_HOUR` (15-minute slots) is used as the default.
      *
-     * @param context - The context defining the scope and filters for the statistics
-     * @param date - (Optional) The specific day for which to collect statistics; defaults to today if not provided
-     * @param timeInterval - (Optional) The time slot interval for reporting (e.g., 15 or 30 minutes);
-     *                       defaults to `TimeInterval.QUARTE_HOUR` if not provided
-     * @param shortHeader - True to return only limited number of headers in response
-     * @returns A `StatisticsData` object containing the data, or `null` if the data could not be retrieved
+     * @param context      the context defining the scope and filters for the statistics
+     * @param date         (optional) the day for which to collect statistics; defaults to today
+     * @param timeInterval (optional) the time slot interval for reporting (e.g., 15 or 30 minutes);
+     *                     defaults to `TimeInterval.QUARTE_HOUR`
+     * @param shortHeader  `true` to return only a limited number of headers in the response
+     * @returns a {@link StatisticsData} object containing the data, or `null` if the data could
+     *          not be retrieved
      */
     async getDayData(context, date, timeInterval, shortHeader = false) {
         return __classPrivateFieldGet(this, _CallCenterStatistics_ccStatisticsRest, "f").getDayData(context, shortHeader, date, timeInterval);
     }
     /**
-     * Asynchronously retrieves statistical data for the specified context for a single day
-     * and stores it as a report file in the given directory.
+     * Asynchronously downloads statistics for a single day as a report file.
+     * <p>
+     * The server generates the file asynchronously. The result is delivered as a ZIP archive
+     * whose single entry is extracted and saved into the specified directory. The returned
+     * `Promise` resolves when the extracted file has been saved to disk.
      * <p>
-     * The statistics are reported in time slots defined by the `timeInterval` parameter,
+     * Statistics are reported in time slots defined by the `timeInterval` parameter,
      * spanning from 00:00 until the last completed interval of the specified day.
      * <p>
      * Only one report generation request can be active at a time. Use
-     * {@link hasAsyncRequestInProgress} to check before calling this method. Any attempt
-     * to start another request while one is already in progress will reject the returned
-     * `Promise` with an `Error`.
+     * {@link hasAsyncRequestInProgress} to check before calling this method. Any attempt to
+     * start another request while one is already in progress will reject the returned `Promise`
+     * with an `Error`.
      *
      * @example
      * ```typescript
@@ -13439,14 +13481,14 @@ class CallCenterStatistics {
      *
      * @param context          the context defining the scope and filters for the statistics
      * @param date             the date for which to generate the report
-     * @param timeInterval     the length of each reporting interval within the day
+     * @param timeInterval     the length of each reporting time slot within the day
      * @param format           the output format for the report file
-     * @param shortHeader      true to return only limited number of headers in response
+     * @param shortHeader      `true` to return only a limited number of headers in the response
      * @param directory        the directory in which to save the generated report file
      * @param progressCallback optional callback invoked to report progress of the operation
-     * @returns a `Promise` that resolves with the path to the generated report file,
-     *          or rejects if an error occurs, the operation is cancelled, or another
-     *          request is already in progress
+     * @returns a `Promise` that resolves with the path to the generated report file, or rejects
+     *          if an error occurs, the operation is cancelled, or another request is already in
+     *          progress
      * @see getDaysFileData
      * @see hasAsyncRequestInProgress
      * @see cancelRequest
@@ -13455,13 +13497,19 @@ class CallCenterStatistics {
         return __classPrivateFieldGet(this, _CallCenterStatistics_ccStatisticsRest, "f").getDayFileData(context, shortHeader, date, timeInterval, format, directory, progressCallback);
     }
     /**
-     * Asynchronously retrieves statistical data for the specified context over a date range
-     * and stores it as a report file in the given directory.
+     * Asynchronously downloads statistics for a range of days as a report file.
+     * <p>
+     * The server generates the file asynchronously. The result is delivered as a ZIP archive
+     * whose single entry is extracted and saved into the specified directory. The returned
+     * `Promise` resolves when the extracted file has been saved to disk.
+     * <p>
+     * Multi-day reports provide one row of aggregated data per agent or pilot per day. The range
+     * can cover up to 31 consecutive days within the last 12 months and may span month boundaries.
      * <p>
      * Only one report generation request can be active at a time. Use
-     * {@link hasAsyncRequestInProgress} to check before calling this method. Any attempt
-     * to start another request while one is already in progress will reject the returned
-     * `Promise` with an `Error`.
+     * {@link hasAsyncRequestInProgress} to check before calling this method. Any attempt to
+     * start another request while one is already in progress will reject the returned `Promise`
+     * with an `Error`.
      *
      * @example
      * ```typescript
@@ -13488,12 +13536,12 @@ class CallCenterStatistics {
      * @param context          the context defining the scope and filters for the statistics
      * @param range            the date range over which to collect statistics
      * @param format           the output format for the report file
-     * @param shortHeader      true to return only limited number of headers in response
+     * @param shortHeader      `true` to return only a limited number of headers in the response
      * @param directory        the directory in which to save the generated report file
      * @param progressCallback optional callback invoked to report progress of the operation
-     * @returns a `Promise` that resolves with the path to the generated report file,
-     *          or rejects if an error occurs, the operation is cancelled, or another
-     *          request is already in progress
+     * @returns a `Promise` that resolves with the path to the generated report file, or rejects
+     *          if an error occurs, the operation is cancelled, or another request is already in
+     *          progress
      * @see getDayFileData
      * @see hasAsyncRequestInProgress
      * @see cancelRequest
@@ -13502,27 +13550,26 @@ class CallCenterStatistics {
         return __classPrivateFieldGet(this, _CallCenterStatistics_ccStatisticsRest, "f").getDaysFileData(context, shortHeader, range, format, directory, progressCallback);
     }
     /**
-     * Attempts to cancel an ongoing statistics report generation for the specified context.
-     *
-     * If a report generation process for the given `context` is currently running,
-     * this method will attempt to stop it. Cancellation may succeed only if the process
-     * has not already completed.
-     *
+     * Attempts to cancel an ongoing asynchronous statistics report generation for the
+     * specified context.
+     * <p>
+     * Cancellation may succeed only if the server-side process has not already completed.
      * The method returns immediately and does not block until the process is fully terminated.
      *
-     * @param context - The context identifying the report generation process to cancel
-     * @returns `true` if a running report generation was found and successfully requested to be cancelled,
-     *          `false` if there was no running process for the specified context or if it could not be cancelled
+     * @param context the context identifying the report generation process to cancel
+     * @returns `true` if a running request was found and cancellation was successfully requested;
+     *          `false` if there was no running process for the specified context or if it could
+     *          not be cancelled
      */
     async cancelRequest(context) {
         return __classPrivateFieldGet(this, _CallCenterStatistics_ccStatisticsRest, "f").cancelRequest(context);
     }
     /**
-     * Creates a new recurrent scheduled report with the specified configuration.
+     * Creates a new recurring scheduled report with the specified configuration.
      * <p>
-     * The report will be generated repeatedly according to the given `recurrence`
-     * pattern and `observationPeriod`, formatted in the specified output format,
-     * and sent to the provided recipients.
+     * The report is generated repeatedly according to the given `recurrence` pattern and
+     * `observationPeriod`, formatted in the specified output format, and sent as a ZIP file
+     * attachment to the provided recipients.
      *
      * @example
      * ```typescript
@@ -13547,11 +13594,11 @@ class CallCenterStatistics {
      * @param context           the context defining which data and counters to include
      * @param id                a unique identifier for the scheduled report
      * @param description       a human-readable description of the report
-     * @param observationPeriod the period over which statistics are collected
+     * @param observationPeriod the observation period over which statistics are collected
      * @param recurrence        the recurrence pattern for generating the report
      * @param format            the output format of the report
      * @param recipients        the list of email addresses to receive the report
-     * @returns the newly created {@link ScheduledReport} on success; `null` otherwise.
+     * @returns the newly created {@link ScheduledReport} on success; `null` otherwise
      * @see createOneTimeScheduledReport
      * @see deleteScheduledReport
      * @see setScheduledReportEnabled
@@ -13562,8 +13609,8 @@ class CallCenterStatistics {
     /**
      * Creates a new one-time scheduled report with the specified configuration.
      * <p>
-     * Unlike {@link createRecurrentScheduledReport}, this report is generated only
-     * once for the specified `observationPeriod`, then it is no longer active.
+     * Unlike {@link createRecurrentScheduledReport}, this report is generated only once for
+     * the specified `observationPeriod` and is no longer active afterwards.
      *
      * @example
      * ```typescript
@@ -13581,10 +13628,10 @@ class CallCenterStatistics {
      * @param context           the context defining which data and counters to include
      * @param id                a unique identifier for the scheduled report
      * @param description       a human-readable description of the report
-     * @param observationPeriod the period over which statistics are collected
+     * @param observationPeriod the observation period over which statistics are collected
      * @param format            the output format of the report
      * @param recipients        the list of email addresses to receive the report
-     * @returns the newly created {@link ScheduledReport} on success; `null` otherwise.
+     * @returns the newly created {@link ScheduledReport} on success; `null` otherwise
      * @see createRecurrentScheduledReport
      * @see deleteScheduledReport
      */
@@ -13592,11 +13639,10 @@ class CallCenterStatistics {
         return __classPrivateFieldGet(this, _CallCenterStatistics_ccStatisticsRest, "f").createOneTimeScheduledReport(context, id, description, observationPeriod, format, recipients);
     }
     /**
-     * Returns all scheduled reports associated with the given context.
+     * Returns all scheduled reports associated with the specified context.
      *
-     * @param context - The context defining which reports to retrieve
-     * @returns An array of {@link ScheduledReport} objects for the specified context;
-     *          may be empty if no reports exist
+     * @param context the context whose reports are retrieved
+     * @returns an array of {@link ScheduledReport} objects, or `null` on failure
      */
     async getScheduledReports(context) {
         return __classPrivateFieldGet(this, _CallCenterStatistics_ccStatisticsRest, "f").getScheduledReports(context);
@@ -13604,8 +13650,8 @@ class CallCenterStatistics {
     /**
      * Deletes the specified scheduled report.
      *
-     * @param report The scheduled report to delete.
-     * @returns `true` if the report was successfully deleted, `false` otherwise.
+     * @param report the scheduled report to delete
+     * @returns `true` if the report was successfully deleted; `false` otherwise
      */
     async deleteScheduledReport(report) {
         return __classPrivateFieldGet(this, _CallCenterStatistics_ccStatisticsRest, "f").deleteScheduledReport(report);
@@ -13613,37 +13659,33 @@ class CallCenterStatistics {
     /**
      * Enables or disables the specified scheduled report.
      *
-     * @param report The scheduled report to update.
-     * @param enabled `true` to enable the report, `false` to disable it.
-     * @returns `true` if the report state was successfully updated, `false` otherwise.
+     * @param report   the scheduled report to update
+     * @param enabled  `true` to enable the report; `false` to disable it
+     * @returns `true` if the report state was successfully updated; `false` otherwise
      */
     async setScheduledReportEnabled(report, enabled) {
         return __classPrivateFieldGet(this, _CallCenterStatistics_ccStatisticsRest, "f").setScheduledReportEnabled(report, enabled);
     }
     /**
-     * Retrieves a previously created scheduled report by its unique identifier.
-     *
-     * This method requires a valid `StatsContext` to perform the retrieval operation.
-     * The `scheduleReportId` must correspond to an existing scheduled report.
+     * Returns the scheduled report with the specified identifier.
      *
-     * @param context The session context used to access the service.
-     * @param scheduleReportId The unique identifier of the scheduled report to retrieve.
-     * @returns The `ScheduledReport` corresponding to the specified ID,
-     *          or `null` if no report exists with that ID.
+     * @param context          the statistics context that owns the report
+     * @param scheduleReportId the unique identifier of the scheduled report to retrieve
+     * @returns the {@link ScheduledReport} corresponding to the specified ID, or `null` if no
+     *          report exists with that ID
      */
     async getScheduledReport(context, scheduleReportId) {
         return __classPrivateFieldGet(this, _CallCenterStatistics_ccStatisticsRest, "f").getScheduledReport(context, scheduleReportId);
     }
     /**
-     * Updates the configuration of an existing scheduled report.
-     *
-     * This method persists any changes made to the provided `ScheduledReport` instance,
-     * including its description, observation period, recurrence, format, and recipients.
-     * Implementations should ensure that the report exists and that the updates are valid.
+     * Persists any changes made to the specified scheduled report.
+     * <p>
+     * Fields that can be updated include the description, observation period, recurrence
+     * pattern, output format, and recipient list.
      *
-     * @param report The `ScheduledReport` instance containing the updated information.
-     * @returns `true` if the update was successful; `false` if the report does not exist
-     *          or the update could not be applied.
+     * @param report the {@link ScheduledReport} instance containing the updated fields
+     * @returns `true` if the update was successful; `false` if the report does not exist or
+     *          the update could not be applied
      */
     async updateScheduledReport(report) {
         return __classPrivateFieldGet(this, _CallCenterStatistics_ccStatisticsRest, "f").updateScheduledReport(report);
@@ -13701,9 +13743,17 @@ exports.CommunicationLog = void 0;
 const events_1 = __importDefault(__webpack_require__(/*! events */ "events"));
 const comlog_events_1 = __webpack_require__(/*! ../types/comlog/comlog-events */ "./src/types/comlog/comlog-events.ts");
 /**
- * The CommunicationLog service allows a user to retrieve their last communication
- * history records and to manage them. Using this service requires having a
+ * The CommunicationLog service provides operations to retrieve, manage, and manipulate
+ * a user's communication log (com records). Using this service requires having a
  * <b>TELEPHONY_ADVANCED</b> license.
+ * <p>
+ * Communication records are generated by the O2G server and provide detailed information
+ * about calls, participants, call outcomes, and durations. The communication log has a
+ * depth of 100 records maximum per user; when the limit is reached, the oldest records
+ * are removed.
+ * <p>
+ * Acknowledgement and unacknowledgement of an incoming missed call using O2G is
+ * <b>NOT synchronized</b> with the OmniPCX Enterprise.
  *
  * @example
  * ```typescript
@@ -13741,20 +13791,19 @@ class CommunicationLog extends events_1.default {
         eventRegistry.register(this, CommunicationLog.ON_COM_RECORDS_UNACK, comlog_events_1.OnComRecordsUnAck);
     }
     /**
-     * Gets the com records corresponding to the specified filter, using the
-     * specified page, with a possible optimization.
+     * Retrieves communication records based on the specified filter, with pagination
+     * support and optional optimization.
      * <p>
-     * If `optimized` is 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, records are returned with no optimization.
+     * If `optimized` is set to `true`, the full identity of a participant is returned
+     * only the first time it appears in the records. Subsequent occurrences of the same
+     * participant will only include minimal identification (e.g., phone number).
      * <p>
-     * The `page` parameter allows querying the communication log by page. The
-     * {@link QueryResult} contains the same parameters and the total number of
-     * records retrieved by the query.
+     * The `page` parameter allows querying the communication log page by page. The
+     * {@link QueryResult} includes the records, paging information, and the total number
+     * of matching records.
      * <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.
+     * 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
@@ -13773,36 +13822,36 @@ class CommunicationLog extends events_1.default {
      *
      * @param filter    the filter describing the query criteria
      * @param page      the page description
-     * @param optimized `true` to activate optimization
-     * @param loginName the user login name
+     * @param optimized `true` to enable optimization
+     * @param loginName the target user's login name
      * @returns the {@link QueryResult} on success; `null` otherwise.
      */
     async getComRecords(filter = null, page = null, optimized = false, loginName = null) {
         return await __classPrivateFieldGet(this, _CommunicationLog_comLogRest, "f").getComRecords(filter, page, optimized, loginName);
     }
     /**
-     * Gets the specified com record.
+     * Retrieves the communication record with the specified identifier.
      * <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.
+     * 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
+     * @param loginName the target user's login name
      * @returns the {@link ComRecord} on success; `null` otherwise.
      */
     async getComRecord(recordId, loginName = null) {
         return await __classPrivateFieldGet(this, _CommunicationLog_comLogRest, "f").getComRecord(recordId, loginName);
     }
     /**
-     * Deletes the specified com record.
+     * Deletes the communication record with the specified identifier.
      * <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.
+     * An {@link ON_COM_RECORDS_DELETED} event is raised when the deletion succeeds.
+     * <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
+     * @param loginName the target user's login name
      * @returns `true` if the operation succeeded; `false` otherwise.
      * @see deleteComRecordsById
      * @see deleteComRecords
@@ -13811,17 +13860,16 @@ class CommunicationLog extends events_1.default {
         return await __classPrivateFieldGet(this, _CommunicationLog_comLogRest, "f").deleteComRecord(recordId, loginName);
     }
     /**
-     * Deletes the specified list of com records.
+     * Deletes the communication records with the specified identifiers.
      * <p>
-     * An {@link ON_COM_RECORDS_DELETED} event is raised containing the list of
-     * com records that have been deleted.
+     * An {@link ON_COM_RECORDS_DELETED} event is raised listing 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.
+     * 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 record identifiers to delete
-     * @param loginName the user login name
+     * @param loginName the target user's login name
      * @returns `true` if the operation succeeded; `false` otherwise.
      * @see deleteComRecord
      * @see deleteComRecords
@@ -13830,16 +13878,15 @@ class CommunicationLog extends events_1.default {
         return await __classPrivateFieldGet(this, _CommunicationLog_comLogRest, "f").deleteComRecordsById(recordIds, loginName);
     }
     /**
-     * Deletes the com records corresponding to the given filter.
+     * Deletes the communication records matching the specified filter.
      * <p>
      * 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
-     * com records that have been deleted.
+     * An {@link ON_COM_RECORDS_DELETED} event is raised listing 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.
+     * 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
@@ -13856,7 +13903,7 @@ class CommunicationLog extends events_1.default {
      * ```
      *
      * @param filter    the filter describing the query criteria
-     * @param loginName the user login name
+     * @param loginName the target user's login name
      * @returns `true` if the operation succeeded; `false` otherwise.
      * @see deleteComRecord
      * @see deleteComRecordsById
@@ -13865,17 +13912,16 @@ class CommunicationLog extends events_1.default {
         return await __classPrivateFieldGet(this, _CommunicationLog_comLogRest, "f").deleteComRecords(filter, loginName);
     }
     /**
-     * Acknowledges the specified list of com records.
+     * Acknowledges the communication records with the specified identifiers.
      * <p>
-     * An {@link ON_COM_RECORDS_ACK} event is raised containing the list of
-     * com records that have been acknowledged.
+     * An {@link ON_COM_RECORDS_ACK} event is raised listing 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.
+     * 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 record identifiers to acknowledge
-     * @param loginName the user login name
+     * @param loginName the target user's login name
      * @returns `true` if the operation succeeded; `false` otherwise.
      * @see acknowledgeComRecord
      */
@@ -13883,17 +13929,16 @@ class CommunicationLog extends events_1.default {
         return await __classPrivateFieldGet(this, _CommunicationLog_comLogRest, "f").acknowledgeComRecords(recordIds, loginName);
     }
     /**
-     * Acknowledges the specified com record.
+     * Acknowledges the communication record with the specified identifier.
      * <p>
-     * An {@link ON_COM_RECORDS_ACK} event is raised containing the list of
-     * com records that have been acknowledged.
+     * An {@link ON_COM_RECORDS_ACK} event is raised listing 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.
+     * 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
+     * @param loginName the target user's login name
      * @returns `true` if the operation succeeded; `false` otherwise.
      * @see acknowledgeComRecords
      */
@@ -13901,17 +13946,16 @@ class CommunicationLog extends events_1.default {
         return await __classPrivateFieldGet(this, _CommunicationLog_comLogRest, "f").acknowledgeComRecord(recordId, loginName);
     }
     /**
-     * Unacknowledges the specified list of com records.
+     * Unacknowledges the communication records with the specified identifiers.
      * <p>
-     * An {@link ON_COM_RECORDS_UNACK} event is raised containing the list of
-     * com records that have been unacknowledged.
+     * An {@link ON_COM_RECORDS_UNACK} event is raised listing the com records that
+     * have been unacknowledged.
      * <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.
+     * 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 record identifiers to unacknowledge
-     * @param loginName the user login name
+     * @param loginName the target user's login name
      * @returns `true` if the operation succeeded; `false` otherwise.
      * @see unacknowledgeComRecord
      */
@@ -13919,17 +13963,16 @@ class CommunicationLog extends events_1.default {
         return await __classPrivateFieldGet(this, _CommunicationLog_comLogRest, "f").unacknowledgeComRecords(recordIds, loginName);
     }
     /**
-     * Unacknowledges the specified com record.
+     * Unacknowledges the communication record with the specified identifier.
      * <p>
-     * An {@link ON_COM_RECORDS_UNACK} event is raised containing the list of
-     * com records that have been unacknowledged.
+     * An {@link ON_COM_RECORDS_UNACK} event is raised listing the com records that
+     * have been unacknowledged.
      * <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.
+     * 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
+     * @param loginName the target user's login name
      * @returns `true` if the operation succeeded; `false` otherwise.
      * @see unacknowledgeComRecords
      */
@@ -14016,36 +14059,36 @@ var _Directory_directoryRest;
 Object.defineProperty(exports, "__esModule", ({ value: true }));
 exports.Directory = void 0;
 /**
- * The DirectoryService is used to search contacts in the OmniPCX
- * Enterprise phone book. Using this service requires having a
- * <b>TELEPHONY_ADVANCED</b> license.
+ * The Directory service allows searching for 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:
+ * A directory search involves a sequence of operations:
  * <ol>
- * <li>The first operation initiates the search with a set of criteria.</li>
- * <li>The second and subsequent operations retrieve results.</li>
+ * <li>Initiate the search with a set of criteria.</li>
+ * <li>Retrieve results using one or more subsequent calls to {@link getResults}.</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.
+ * Note: For each session (user or administrator), only 5 concurrent searches are
+ * allowed. An unused search context is automatically freed after 1 minute.
  *
  * @example
  * ```typescript
- *   await o2g.directory.search(myCriteria);
- *   while (!finished) {
- *      let result = await o2g.directory.getResults();
- *      if (result.getResultCode() == SearchResult.ResultCode.NOK) {
- *         // Wait for results
- *      }
- *      else if ((result.getResultCode() == SearchResult.ResultCode.FINISH) ||
- *               (result.getResultCode() == SearchResult.ResultCode.TIMEOUT)) {
- *          // Exit the loop
- *          finished = true;
- *      }
- *      else {
- *         // Process results
- *      }
- *   }
+ * await O2G.directory.search(myCriteria);
+ *
+ * let finished = false;
+ * while (!finished) {
+ *     const result = await O2G.directory.getResults();
+ *     if (result?.resultCode === SearchResult.ResultCode.NOK) {
+ *         // Search still in progress, wait before retrying
+ *         await new Promise(resolve => setTimeout(resolve, 500));
+ *     } else if (result?.resultCode === SearchResult.ResultCode.OK) {
+ *         // Process available results
+ *         result.items.forEach(item => console.log(item.firstName, item.lastName));
+ *     } else {
+ *         // FINISH or TIMEOUT — search is complete
+ *         finished = true;
+ *     }
+ * }
  * ```
  */
 class Directory {
@@ -14061,12 +14104,11 @@ class Directory {
      * 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.
+     * 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, in the range [1..100]
-     * @param loginName the user login name
+     * @param limit     the maximum number of results, in the range [1..100]
+     * @param loginName the target user's login name
      * @returns `true` if the search was successfully initiated; `false` otherwise.
      * @see getResults
      * @see cancel
@@ -14078,30 +14120,28 @@ class Directory {
      * Cancels the current 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.
+     * ignored, but it is mandatory if the session has been opened by an administrator.
      *
-     * @param loginName the user login name
-     * @returns `true` if the operation succeeded; `false` otherwise.
+     * @param loginName the target user's login name
+     * @returns `true` if the search was successfully cancelled; `false` otherwise.
      * @see search
      */
     async cancel(loginName = null) {
         return await __classPrivateFieldGet(this, _Directory_directoryRest, "f").cancel(loginName);
     }
     /**
-     * Gets the next available results for the current search.
+     * Retrieves the next available results for the current search.
      * <p>
      * `getResults` is generally called in a loop. For each iteration:
      * <ul>
      * <li>if the result code is `NOK`, the search is in progress but no results are
-     * available — it is recommended to wait before the next iteration (e.g. 500ms)</li>
+     * available yet — it is recommended to wait before the next iteration (e.g., 500ms)</li>
      * <li>if the result code is `OK`, results are available and can be processed</li>
      * <li>if the result code is `FINISH` or `TIMEOUT`, the search has ended — exit 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.
+     * ignored, but it is mandatory if the session has been opened by an administrator.
      *
      * @example
      * ```typescript
@@ -14113,19 +14153,17 @@ class Directory {
      *     if (result?.resultCode === SearchResult.ResultCode.NOK) {
      *         // Search still in progress, wait before retrying
      *         await new Promise(resolve => setTimeout(resolve, 500));
-     *     }
-     *     else if (result?.resultCode === SearchResult.ResultCode.OK) {
+     *     } else if (result?.resultCode === SearchResult.ResultCode.OK) {
      *         // Process available results
      *         result.items.forEach(item => console.log(item.firstName, item.lastName));
-     *     }
-     *     else {
+     *     } else {
      *         // FINISH or TIMEOUT — search is complete
      *         finished = true;
      *     }
      * }
      * ```
      *
-     * @param loginName the user login name
+     * @param loginName the target user's login name
      * @returns the {@link SearchResult} on success; `null` otherwise.
      * @see search
      */
@@ -14182,10 +14220,10 @@ exports.EventSummary = void 0;
 const events_1 = __webpack_require__(/*! events */ "events");
 const event_summary_events_1 = __webpack_require__(/*! ../types/eventsummary/event-summary-events */ "./src/types/eventsummary/event-summary-events.ts");
 /**
- * The Event summary service allows a user to get its new message
- * indicators (missed call, voice mails, callback request, fax).
+ * The EventSummary service allows a user to retrieve new message indicators
+ * such as missed calls, voice mails, callback requests, and faxes.
  * <p>
- * Using this service requires having a <b>TELEPHONY_ADVANCED</b> license.
+ * Using this service requires a <b>TELEPHONY_ADVANCED</b> license.
  *
  * @example
  * ```typescript
@@ -14215,14 +14253,13 @@ class EventSummary extends events_1.EventEmitter {
         eventRegistry.register(this, EventSummary.ON_EVENT_SUMMARY_UPDATED, event_summary_events_1.OnEventSummaryUpdated);
     }
     /**
-     * Retrieves main counters for the specified user.
+     * Retrieves the main event counters 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.
+     * ignored, but it is mandatory if the session has been opened by an administrator.
      *
      * @param loginName the user login name
-     * @returns the {@link EventSummaryCounters} on success; `null` otherwise.
+     * @returns the {@link EventSummaryCounters} containing the event counters on success; `null` otherwise
      */
     get(loginName = null) {
         return __classPrivateFieldGet(this, _EventSummary_eventSummaryRest, "f").get(loginName);
@@ -14231,7 +14268,7 @@ class EventSummary extends events_1.EventEmitter {
 exports.EventSummary = EventSummary;
 _EventSummary_eventSummaryRest = new WeakMap();
 /**
- * Event raised each time the user's counters have changed.
+ * Occurs each time the user's event counters have changed.
  * @event
  */
 EventSummary.ON_EVENT_SUMMARY_UPDATED = 'OnEventSummaryUpdated';
@@ -14285,12 +14322,12 @@ exports.Maintenance = void 0;
 const events_1 = __importDefault(__webpack_require__(/*! events */ "events"));
 const maint_events_1 = __webpack_require__(/*! ../types/maint/maint-events */ "./src/types/maint/maint-events.ts");
 /**
- * The MaintenanceService allows retrieving information about the system state,
- * in particular information on the PBX nodes and their connection state.
+ * The Maintenance service provides information about the system state,
+ * in particular information on the OmniPCX Enterprise nodes and their connection state.
  * Information about licenses is also provided per item: total allocated licenses,
  * number currently in use, and expiration date.
  * <p>
- * This service is available to administrator sessions only.
+ * This service does not require any specific license on the O2G server.
  *
  * @example
  * ```typescript
@@ -14340,7 +14377,7 @@ class Maintenance extends events_1.default {
      * <p>
      * This operation is restricted to an administrator session only.
      *
-     * @returns the {@link SystemStatus} on success; `null` otherwise.
+     * @returns the {@link SystemStatus} on success; `null` otherwise
      */
     async getSystemStatus() {
         return await __classPrivateFieldGet(this, _Maintenance_maintenanceRest, "f").getSystemStatus();
@@ -14349,12 +14386,12 @@ class Maintenance extends events_1.default {
 exports.Maintenance = Maintenance;
 _Maintenance_maintenanceRest = new WeakMap();
 /**
- * Occurs when connection to remote twin server is lost.
+ * Occurs when the connection to the remote twin O2G server is lost.
  * @event
  */
 Maintenance.ON_REMOTE_SERVER_LINK_DOWN = 'OnRemoteServerLinkDown';
 /**
- * Occurs when connection to remote twin server is recovered.
+ * Occurs when the connection to the remote twin O2G server is recovered.
  * @event
  */
 Maintenance.ON_REMOTE_SERVER_LINK_UP = 'OnRemoteServerLinkUp';
@@ -14369,12 +14406,12 @@ Maintenance.ON_CTI_LINK_DOWN = 'OnCtiLinkDown';
  */
 Maintenance.ON_CTI_LINK_UP = 'OnCtiLinkUp';
 /**
- * Occurs when a PBX link is down.
+ * Occurs when the CMIS link to an OmniPCX Enterprise node goes down.
  * @event
  */
 Maintenance.ON_PBX_LINK_DOWN = 'OnPbxLinkDown';
 /**
- * Occurs when a PBX link is up.
+ * Occurs when the CMIS link to an OmniPCX Enterprise node is re-established.
  * @event
  */
 Maintenance.ON_PBX_LINK_UP = 'OnPbxLinkUp';
@@ -14384,12 +14421,12 @@ Maintenance.ON_PBX_LINK_UP = 'OnPbxLinkUp';
  */
 Maintenance.ON_PBX_LOADED = 'OnPbxLoaded';
 /**
- * Occurs when the license file will soon expire or has recently expired.
+ * Occurs when a license is about to expire or has expired.
  * @event
  */
 Maintenance.ON_LICENSE_EXPIRATION = 'OnLicenseExpiration';
 /**
- * Occurs when O2G is ready (all OXE nodes are connected and loaded).
+ * Occurs when the O2G server has started (all OmniPCX Enterprise nodes are connected and loaded).
  * @event
  */
 Maintenance.ON_SERVER_STARTED = 'OnServerStart';
@@ -14443,7 +14480,8 @@ exports.Messaging = void 0;
  * the information and the list of voice mails, and manage the mail box. Using
  * this service requires having a <b>TELEPHONY_ADVANCED</b> license.
  * <p>
- * It is possible to download a voice mail as a wav file and to delete existing messages.
+ * It is possible to download a voice mail as a wav file, acknowledge (mark as
+ * read) a voice mail, and delete existing messages.
  */
 class Messaging {
     /**
@@ -14531,7 +14569,7 @@ class Messaging {
         return __classPrivateFieldGet(this, _Messaging_messagingRest, "f").deleteVoiceMessage(mailboxId, voicemailId, loginName);
     }
     /**
-     * Acknowledges the specified voice message.
+     * Acknowledges the specified voice message, marking it as read.
      * <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
@@ -15386,8 +15424,8 @@ class Routing extends events_1.default {
     /**
      * Activates the Do Not Disturb for the specified user.
      * <p>
-     * This method does nothing and returns `true` if the Do Not Disturb is
-     * already activated.
+     * When active, no calls are presented to the user. This method does nothing and
+     * returns `true` if the Do Not Disturb is already activated.
      * <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
@@ -15431,7 +15469,7 @@ class Routing extends events_1.default {
         return await __classPrivateFieldGet(this, _Routing_routingRest, "f").getDndState(loginName);
     }
     /**
-     * Returns the routing capabilities of the specified user.
+     * Returns the routing capabilities available to 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
@@ -15446,8 +15484,9 @@ class Routing extends events_1.default {
     /**
      * Activates the remote extension device for the specified user.
      * <p>
-     * When the remote extension is activated, it rings on incoming calls on the
-     * user's company phone.
+     * When activated, the remote extension rings on incoming calls on the user's
+     * company phone. If it is already activated, this method does nothing and
+     * returns `true`.
      * <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
@@ -15463,8 +15502,8 @@ class Routing extends events_1.default {
     /**
      * Deactivates the remote extension device for the specified user.
      * <p>
-     * When deactivated, it never rings, but it can still be used to place
-     * an outgoing call.
+     * When deactivated, the remote extension does not ring on incoming calls,
+     * but can still be used to place outgoing calls.
      * <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
@@ -15491,10 +15530,9 @@ class Routing extends events_1.default {
         return await __classPrivateFieldGet(this, _Routing_routingRest, "f").getForward(loginName);
     }
     /**
-     * Cancels the forward for the specified user.
+     * Cancels the active forward for the specified user.
      * <p>
-     * This method does nothing and returns `true` if there is no forward
-     * activated.
+     * This method does nothing and returns `true` if there is no forward activated.
      * <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
@@ -15502,14 +15540,17 @@ class Routing extends events_1.default {
      *
      * @param loginName the user login name
      * @returns `true` if the operation succeeded; `false` otherwise.
+     * @see forwardOnNumber
+     * @see forwardOnVoiceMail
      */
     async cancelForward(loginName = null) {
         return await __classPrivateFieldGet(this, _Routing_routingRest, "f").cancelForward(loginName);
     }
     /**
-     * Sets a forward on voice mail with the specified condition, for the specified user.
+     * Activates a forward to the voice mail with the specified condition, for the specified user.
      * <p>
      * This method will fail and return `false` if the user does not have a voice mail.
+     * If a forward is already active, it is replaced by the new one.
      * <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
@@ -15519,14 +15560,18 @@ class Routing extends events_1.default {
      * @param loginName the user login name
      * @returns `true` if the operation succeeded; `false` otherwise.
      * @see forwardOnNumber
+     * @see cancelForward
      */
     async forwardOnVoiceMail(condition, loginName = null) {
         return await __classPrivateFieldGet(this, _Routing_routingRest, "f").forwardOnVoiceMail(condition, loginName);
     }
     /**
-     * Sets a forward on the specified number, with the specified condition, for the
+     * Activates a forward to the specified number, with the specified condition, for the
      * specified user.
      * <p>
+     * The number must be authorized by the OmniPCX Enterprise numbering policy.
+     * If a forward is already active, it is replaced by the new one.
+     * <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.
@@ -15557,7 +15602,7 @@ class Routing extends events_1.default {
         return await __classPrivateFieldGet(this, _Routing_routingRest, "f").forwardOnNumber(number, condition, loginName);
     }
     /**
-     * Cancels the overflow for the specified user.
+     * Cancels the active overflow for the specified user.
      * <p>
      * This method does nothing and returns `true` if there is no overflow activated.
      * <p>
@@ -15567,6 +15612,7 @@ class Routing extends events_1.default {
      *
      * @param loginName the user login name
      * @returns `true` if the operation succeeded; `false` otherwise.
+     * @see overflowOnVoiceMail
      */
     async cancelOverflow(loginName = null) {
         return await __classPrivateFieldGet(this, _Routing_routingRest, "f").cancelOverflow(loginName);
@@ -15585,9 +15631,12 @@ class Routing extends events_1.default {
         return await __classPrivateFieldGet(this, _Routing_routingRest, "f").getOverflow(loginName);
     }
     /**
-     * Activates an overflow on voice mail with the specified condition, for the
+     * Activates an overflow to the voice mail with the specified condition, for the
      * specified user.
      * <p>
+     * The overflow only applies when no forward is active. If an overflow is already
+     * active, it is replaced by the new one.
+     * <p>
      * This method will fail and return `false` if the user does not have a voice mail.
      * <p>
      * If the session has been opened for a user, the `loginName` parameter is
@@ -15603,7 +15652,10 @@ class Routing extends events_1.default {
         return await __classPrivateFieldGet(this, _Routing_routingRest, "f").overflowOnVoiceMail(condition, loginName);
     }
     /**
-     * Gets the routing state of the specified user.
+     * Gets the complete routing state of the specified user.
+     * <p>
+     * The routing state includes the forward, overflow, Do Not Disturb and remote
+     * extension activation status in a single 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
@@ -15616,11 +15668,15 @@ class Routing extends events_1.default {
         return await __classPrivateFieldGet(this, _Routing_routingRest, "f").getRoutingState(loginName);
     }
     /**
-     * Asks a snapshot event on the specified user.
+     * Requests a snapshot event to be fired with the current routing state of the specified user.
+     * <p>
+     * The {@link ON_ROUTING_STATE_CHANGED} event will contain the {@link RoutingState}
+     * (forward/overflow/DND state). If a second request is made while the previous one is still
+     * in progress, it has no effect.
      * <p>
-     * The {@link ON_ROUTING_STATE_CHANGED} event will contain the
-     * {@link RoutingState} (forward/overflow/dnd state). If a second request
-     * is asked while the previous one is still in progress, it has no effect.
+     * If the session has been opened by an administrator and `loginName` is `null`, the snapshot
+     * is requested for all users. The request is immediately acknowledged but processing may take
+     * a long time if the number of users is large.
      * <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
@@ -15704,8 +15760,7 @@ exports.Rsi = void 0;
 const events_1 = __importDefault(__webpack_require__(/*! events */ "events"));
 const rsi_events_1 = __webpack_require__(/*! ../types/rsi/rsi-events */ "./src/types/rsi/rsi-events.ts");
 /**
- * RsiService provides access to th RSI (Routing Service Intelligence)
- * points features:
+ * `Rsi` provides access to the RSI (Routing Service Intelligence) point features:
  * <ul>
  * <li>Makes route selection.</li>
  * <li>Makes digits collection.</li>
@@ -15713,9 +15768,8 @@ const rsi_events_1 = __webpack_require__(/*! ../types/rsi/rsi-events */ "./src/t
  * <li>Plays announcements (prompts and/or digits).</li>
  * </ul>
  * <p>
- * To be able to receive the RouteRequest from the OmniPCX Enterprise, the first
- * action is subscribe to rsi events and the second action is to enable the RSI
- * point.
+ * To be able to receive route requests from the OmniPCX Enterprise, the application
+ * must first subscribe to RSI events and then enable the RSI point.
  * <p>
  * Using this service requires having a <b>CONTACTCENTER_RSI</b> license.
  */
@@ -15735,41 +15789,42 @@ class Rsi extends events_1.default {
         eventRegistry.register(this, Rsi.ON_ROUTE_REQUEST, rsi_events_1.OnRouteRequest);
     }
     /**
-     * Gets the configured Rsi points.
+     * Gets the configured RSI points.
+     *
+     * @returns the list of {@link RsiPoint} objects representing all declared RSI points, or `null` in case of error.
      */
     async getRsiPoints() {
         return __classPrivateFieldGet(this, _Rsi_rsiRest, "f").getRsiPoints();
     }
     /**
-     * Enables the specified rsi point.
+     * Enables the specified RSI point.
      *
-     * @param rsiNumber the rsi point extension number.
-     * @param [backup=false] true to enable the RSI point in backup mode.
+     * @param rsiNumber the RSI point extension number
+     * @param backup `true` to enable the RSI point in backup mode
+     * @returns `true` in case of success; `false` otherwise.
      */
     async enableRsiPoint(rsiNumber, backup = false) {
         return __classPrivateFieldGet(this, _Rsi_rsiRest, "f").enableRsiPoint(rsiNumber, backup);
     }
     /**
-     * Disables the specified rsi point.
+     * Disables the specified RSI point.
      *
-     * @param rsiNumber the rsi point extension number.
+     * @param rsiNumber the RSI point extension number
+     * @returns `true` in case of success; `false` otherwise.
      */
     async disableRsiPoint(rsiNumber) {
         return __classPrivateFieldGet(this, _Rsi_rsiRest, "f").disableRsiPoint(rsiNumber);
     }
     /**
-     * Starts a digits collection for the specified rsi, on the specified call.
+     * Starts a digits collection on the specified RSI point, for the specified call.
      *
-     * @param rsiNumber          the rsi point extension number
+     * @param rsiNumber          the RSI point extension number
      * @param callRef            the call reference
-     * @param numChars           the optionnal number of digits to collect. The
-     *                           digit collection is stopped when this number is
-     *                           reached
-     * @param flushChar          the optional character used to stop the digit
-     *                           collection when pressed.
-     * @param timeout            optional timeout in second. Stop the digit
-     *                           collection after this time elapses.
+     * @param numChars           the optional number of digits to collect; the digit collection stops when this number is reached
+     * @param flushChar          the optional character that stops the digit collection when pressed
+     * @param timeout            the optional timeout in seconds; the digit collection stops when this delay elapses
      * @param additionalCriteria extension criteria used to collect digits
+     * @returns a unique identifier (Crid) for this digit collection session, or `null` in case of error.
      * @see {@link ON_DIGIT_COLLECTED} event
      * @see {@link stopCollectDigits}
      */
@@ -15777,11 +15832,12 @@ class Rsi extends events_1.default {
         return __classPrivateFieldGet(this, _Rsi_rsiRest, "f").startCollectDigits(rsiNumber, callRef, numChars, flushChar, timeout, additionalCriteria);
     }
     /**
-     * Stops the specified digits collection.
+     * Stops the specified digits collection on the specified RSI point.
      *
-     * @param rsiNumber the rsi point extension number
-     * @param callCrid  the digit collection identifier
-     * @see {@link startCollectDigits}.
+     * @param rsiNumber the RSI point extension number
+     * @param collCrid  the digit collection identifier returned by {@link startCollectDigits}
+     * @returns `true` in case of success; `false` otherwise.
+     * @see {@link startCollectDigits}
      */
     async stopCollectDigits(rsiNumber, collCrid) {
         return __classPrivateFieldGet(this, _Rsi_rsiRest, "f").stopCollectDigits(rsiNumber, collCrid);
@@ -15789,22 +15845,24 @@ class Rsi extends events_1.default {
     /**
      * Plays the specified tone on the specified call.
      *
-     * @param rsiNumber the rsi point extension number
+     * @param rsiNumber the RSI point extension number
      * @param callRef   the call reference
      * @param tone      the tone to play
-     * @param duration  the duration the tone is played (in second)
-     * @see {@link ON_TONE_GENERATED_START} event.
-     * @see {@link cancelTone}.
+     * @param duration  the duration the tone is played, in seconds
+     * @returns `true` in case of success; `false` otherwise.
+     * @see {@link ON_TONE_GENERATED_START} event
+     * @see {@link cancelTone}
      */
     async playTone(rsiNumber, callRef, tone, duration) {
         return __classPrivateFieldGet(this, _Rsi_rsiRest, "f").playTone(rsiNumber, callRef, tone, duration);
     }
     /**
-     * Cancels playing a tone on the specified call.
+     * Cancels the tone currently playing on the specified call.
      *
-     * @param rsiNumber the rsi point extension number
+     * @param rsiNumber the RSI point extension number
      * @param callRef   the call reference
-     * @see {@link ON_TONE_GENERATED_STOP} event.
+     * @returns `true` in case of success; `false` otherwise.
+     * @see {@link ON_TONE_GENERATED_STOP} event
      * @see {@link playTone}
      */
     async cancelTone(rsiNumber, callRef) {
@@ -15813,53 +15871,59 @@ class Rsi extends events_1.default {
     /**
      * Plays the specified voice guide on the specified call.
      *
-     * @param rsiNumber   the rsi point extension number
+     * @param rsiNumber   the RSI point extension number
      * @param callRef     the call reference
-     * @param guideNumber the voice guide number as defined in the OmniPcx
-     *                    Enterprise
-     * @param duration    an optional duration for the voice guide in second.
+     * @param guideNumber the voice guide number as defined in the OmniPCX Enterprise
+     * @param duration    an optional duration for the voice guide, in seconds
+     * @returns `true` in case of success; `false` otherwise.
      * @see {@link ON_TONE_GENERATED_START}
      */
     async playVoiceGuide(rsiNumber, callRef, guideNumber, duration = null) {
         return __classPrivateFieldGet(this, _Rsi_rsiRest, "f").playVoiceGuide(rsiNumber, callRef, guideNumber, duration);
     }
     /**
-     * Ends a route session.
+     * Ends a route session, indicating that no route will be selected.
      *
-     * @param rsiNumber the rsi point extension number
+     * @param rsiNumber the RSI point extension number
      * @param routeCrid the routing session unique identifier
-     * @see {@link ON_ROUTE_REQUEST} event.
+     * @returns `true` in case of success; `false` otherwise.
+     * @see {@link ON_ROUTE_REQUEST} event
      */
     async routeEnd(rsiNumber, routeCrid) {
         return __classPrivateFieldGet(this, _Rsi_rsiRest, "f").routeEnd(rsiNumber, routeCrid);
     }
     /**
-     * Selects a route for the specified route session.
-     * @param rsiNumber        the rsi point extension number
+     * Selects a route as a response to a route request.
+     * <p>
+     * `callingLine` can be used to change the identity of the calling number presented to the called party.
+     *
+     * @param rsiNumber        the RSI point extension number
      * @param routeCrid        the routing session unique identifier
      * @param selectedRoute    the selected route number
-     * @param callingLine      an optional calling line value that will be presented
-     *                         to the selected route
-     * @param associatedData   the optional associated data to attach to the call
-     * @param routeToVoiceMail 'true' if the selected route is the voice mail; 'false' otherwise
-     * @see {@link ON_ROUTE_REQUEST} event.
+     * @param callingLine      an optional calling line number that will be presented to the selected route
+     * @param associatedData   optional correlator data to attach to the call
+     * @param routeToVoiceMail `true` if the selected route is the voice mail; `false` otherwise
+     * @returns `true` in case of success; `false` otherwise.
+     * @see {@link ON_ROUTE_REQUEST} event
      */
     async routeSelect(rsiNumber, routeCrid, selectedRoute, callingLine = null, associatedData = null, routeToVoiceMail = null) {
         return __classPrivateFieldGet(this, _Rsi_rsiRest, "f").routeSelect(rsiNumber, routeCrid, selectedRoute, callingLine, associatedData, routeToVoiceMail);
     }
     /**
-     * Gets the list of existing route sessions for the specified rsi point.
+     * Gets the list of existing route sessions for the specified RSI point.
      *
-     * @param rsiNumber the rsi point extension number
+     * @param rsiNumber the RSI point extension number
+     * @returns the list of {@link RouteSession} objects representing the route sessions in progress, or `null` in case of error.
      */
     async getRouteSessions(rsiNumber) {
         return __classPrivateFieldGet(this, _Rsi_rsiRest, "f").getRouteSessions(rsiNumber);
     }
     /**
-     * Return the specified route session.
+     * Returns the specified route session.
      *
-     * @param rsiNumber the rsi point extension number
+     * @param rsiNumber the RSI point extension number
      * @param routeCrid the routing session unique identifier
+     * @returns the {@link RouteSession} object on success; `null` in case of error or if no such route session exists.
      */
     async getRouteSession(rsiNumber, routeCrid) {
         return __classPrivateFieldGet(this, _Rsi_rsiRest, "f").getRouteSession(rsiNumber, routeCrid);
@@ -15868,27 +15932,27 @@ class Rsi extends events_1.default {
 exports.Rsi = Rsi;
 _Rsi_rsiRest = new WeakMap();
 /**
- * Occurs when a data collection has ended.
+ * Raised when a digit collection session has ended.
  * @event
  */
 Rsi.ON_DIGIT_COLLECTED = 'OnDigitCollected';
 /**
- * Raised from a RSI point when a tone generation is started.
+ * Raised from an RSI point when a tone generation starts.
  * @event
  */
 Rsi.ON_TONE_GENERATED_START = 'OnToneGeneratedStart';
 /**
- * Raised from a RSI point when a tone generation is stopped.
+ * Raised from an RSI point when a tone generation stops.
  * @event
  */
 Rsi.ON_TONE_GENERATED_STOP = 'OnToneGeneratedStop';
 /**
- * Raised from a Routing point to close a route session (routing crid is no longer valid).
+ * Raised from a routing point to close a route session (the routing Crid is no longer valid).
  * @event
  */
 Rsi.ON_ROUTE_END = 'OnRouteEnd';
 /**
- * Raised from a Routing point to request a route.
+ * Raised from a routing point to request a route selection.
  * @event
  */
 Rsi.ON_ROUTE_REQUEST = 'OnRouteRequest';
@@ -15942,13 +16006,12 @@ exports.Telephony = void 0;
 const events_1 = __importDefault(__webpack_require__(/*! events */ "events"));
 const telephony_events_1 = __webpack_require__(/*! ../types/telephony/telephony-events */ "./src/types/telephony/telephony-events.ts");
 /**
- * The TelephonyService allows a user to initiate a call and to activate
+ * The TelephonyService allows a user to initiate calls and activate
  * any kind of OmniPCX Enterprise telephony services.
  * <p>
- * Using this service requires having a <b>TELEPHONY_ADVANCED</b> license,
- * except for the 3 basic services
- * {@link basicMakeCall}, {@link basicAnswerCall} and {@link basicDropMe} that are available without any
- * license.
+ * Using this service requires a <b>TELEPHONY_ADVANCED</b> license, except for
+ * the three basic services {@link basicMakeCall}, {@link basicAnswerCall} and
+ * {@link basicDropMe}, which are available without any license.
  */
 class Telephony extends events_1.default {
     /**
@@ -15967,17 +16030,20 @@ class Telephony extends events_1.default {
         eventRegistry.register(this, Telephony.ON_DYNAMIC_STATE_CHANGED, telephony_events_1.OnDynamicStateChanged);
     }
     /**
-     * Initiates a call from the specified device to the specified called number.
+     * Initiates a basic call from the specified device to the specified called number.
+     * <p>
+     * This method does not require a license.
      * <p>
      * If the session is opened by a user, the device phone number must be one of
      * the user's devices.
      * <p>
-     * If `autoAnswer` is set to `false`, the `deviceId` is called before launching
-     * the call to the callee; otherwise the callee is called immediately.
+     * If `autoAnswer` is set to `false`, the user's device is called first before
+     * placing the call to the callee; otherwise the callee is called immediately.
      *
-     * @param deviceId   the device phone number for which the call is made
-     * @param callee     the called number
-     * @param autoAnswer automatic answer on make call
+     * @param deviceId   the device phone number used to place the call
+     * @param callee     the called phone number
+     * @param autoAnswer if `true`, the callee is called immediately; if `false`,
+     *                   the user's device is called first before placing the call to the callee
      * @returns `true` if the operation succeeded; `false` otherwise.
      */
     async basicMakeCall(deviceId, callee, autoAnswer = true) {
@@ -15986,24 +16052,28 @@ class Telephony extends events_1.default {
     /**
      * Answers an incoming ringing call on the specified device.
      * <p>
+     * This method does not require a license.
+     * <p>
      * If the session is opened by a user, the device phone number must be one of
      * the user's devices.
      *
-     * @param deviceId the device phone number
+     * @param deviceId the device phone number on which to answer
      * @returns `true` if the operation succeeded; `false` otherwise.
      */
     async basicAnswerCall(deviceId) {
         return await __classPrivateFieldGet(this, _Telephony_telephonyRest, "f").basicAnswerCall(deviceId);
     }
     /**
-     * Exits from the call for the specified user.
+     * Exits from the current call 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.
+     * This method does not require a license.
      * <p>
      * If the call is a single call, it is released; if it is a conference, the call
      * carries on without the 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 login name for whom the drop is done
      * @returns `true` if the operation succeeded; `false` otherwise.
@@ -16012,7 +16082,7 @@ class Telephony extends events_1.default {
         return await __classPrivateFieldGet(this, _Telephony_telephonyRest, "f").basicDropMe(loginName);
     }
     /**
-     * Retrieves the calls in progress for the specified user.
+     * Retrieves the calls currently in progress 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
@@ -16020,20 +16090,21 @@ class Telephony extends events_1.default {
      *
      * @param loginName the login name
      * @returns the list of active {@link Call} objects on success; `null` otherwise.
+     * @see getCall
      */
     async getCalls(loginName = null) {
         return await __classPrivateFieldGet(this, _Telephony_telephonyRest, "f").getCalls(loginName);
     }
     /**
-     * Returns the call specified by the call reference for the specified user.
+     * Returns the call identified by the specified reference 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 callRef   the call reference
+     * @param callRef   the unique call reference
      * @param loginName the login name
-     * @returns the {@link Call} on success; `null` otherwise.
+     * @returns the {@link Call} on success; `null` if not found.
      */
     async getCall(callRef, loginName = null) {
         return await __classPrivateFieldGet(this, _Telephony_telephonyRest, "f").getCall(callRef, loginName);
@@ -16046,12 +16117,14 @@ class Telephony extends events_1.default {
      * ignored, but it is mandatory if the session has been opened by an
      * administrator.
      * <p>
-     * If `autoAnswer` is set to `false`, the `deviceId` is called before launching
-     * the call to the callee; otherwise the callee is called immediately.
-     *
-     * @param deviceId   the device phone number for which the call is made
-     * @param callee     the called number
-     * @param autoAnswer automatic answer on make call
+     * If `autoAnswer` is set to `false`, the user's device is called first before
+     * placing the call to the callee; otherwise the callee is called immediately.
+     *
+     * @param deviceId   the device phone number from which the call is placed; if the
+     *                   session is opened by a user, this must be one of the user's devices
+     * @param callee     the called phone number
+     * @param autoAnswer if `true`, the callee is called immediately; if `false`,
+     *                   the user's device is called first before placing the call to the callee
      * @param loginName  the login name
      * @returns `true` if the operation succeeded; `false` otherwise.
      */
@@ -16059,43 +16132,28 @@ class Telephony extends events_1.default {
         return await __classPrivateFieldGet(this, _Telephony_telephonyRest, "f").makeCall(deviceId, callee, autoAnswer, loginName);
     }
     /**
-     * Initiates a new call to another user (the callee), using the specified device and options.
+     * Initiates a call from the specified device to the specified called number,
+     * with extended options.
      * <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>
-     * First, the call server initiates a call on the user's `deviceId`. Then when the
-     * call is answered the call server starts the call to the `callee`, and an
-     * {@link ON_CALL_CREATED} event is raised.
-     * <p>
-     * If `inhibitProgressTone` is `true`, the progress tone is inhibited on the outbound call.
+     * If `autoAnswer` is set to `false`, the user's device is called first before
+     * placing the call to the callee; otherwise the callee is called immediately.
      * <p>
-     * The `callingNumber` can be used to present a different calling number on the public
-     * network in order to hide the real calling extension number.
-     *
-     *  * @example
-     * ```typescript
-     * // Simple call with auto-answer
-     * await O2G.telephony.makeCallEx("1234", "5678");
-     *
-     * // Call with progress tone inhibited and a different calling number
-     * await O2G.telephony.makeCallEx("1234", "5678", true, true, null, "9000");
-     *
-     * // Call with correlator data to carry application context
-     * const correlatorData = new CorrelatorData("transactionId=abc123");
-     * await O2G.telephony.makeCallEx("1234", "5678", true, false, correlatorData);
-     *
-     * // Administrator making a call on behalf of a user
-     * await O2G.telephony.makeCallEx("1234", "5678", true, false, null, null, "jdoe");
-     * ```
-     *
-     * @param deviceId            the device phone number for which the call is made
-     * @param callee              the called number
-     * @param autoAnswer          automatic answer on make call
-     * @param inhibitProgressTone allows to inhibit the progress tone on the current external call
-     * @param correlatorData      correlator data to add to the call
-     * @param callingNumber       calling number to present to the public network
+     * The `callingNumber` can be used to present a different calling number on the
+     * public network in order to mask the real calling extension number.
+     *
+     * @param deviceId            the device phone number from which the call is placed; if the
+     *                            session is opened by a user, this must be one of the user's devices
+     * @param callee              the called phone number
+     * @param autoAnswer          if `true`, the callee is called immediately; if `false`,
+     *                            the user's device is called first before placing the call to the callee
+     * @param inhibitProgressTone `true` to inhibit the progress tone on the outbound call
+     * @param correlatorData      correlator data to attach to the call
+     * @param callingNumber       optional calling number to present to the public network, used to mask
+     *                            the real calling extension number
      * @param loginName           the login name
      * @returns `true` if the operation succeeded; `false` otherwise.
      */
@@ -16103,23 +16161,19 @@ class Telephony extends events_1.default {
         return await __classPrivateFieldGet(this, _Telephony_telephonyRest, "f").makeCallEx(deviceId, callee, autoAnswer, inhibitProgressTone, correlatorData, callingNumber, loginName);
     }
     /**
-     * Initiates a new private call to another user (the callee), using a PIN code and an optional secret code.
+     * Initiates a private call to the specified callee, identified by a PIN code.
+     * <p>
+     * A private call allows the user to flag a call as personal rather than
+     * professional, enabling specific charging processing.
      * <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>
-     * The private call service allows a user to specify that an external call is personal
-     * rather than professional. The charging for this type of call can then be given
-     * specific processing.
-     * <p>
-     * First, the call server initiates a call on the user's `deviceId`. Then when the
-     * call is answered the call server starts the call to the `callee`, and an
-     * {@link ON_CALL_CREATED} event is raised.
      *
-     * @param deviceId   the device phone number for which the call is made
-     * @param callee     the called number
-     * @param pin        the PIN code to identify the caller
+     * @param deviceId   the device phone number from which the call is placed; if the
+     *                   session is opened by a user, this must be one of the user's devices
+     * @param callee     the called phone number
+     * @param pin        the PIN code identifying the caller
      * @param secretCode the optional secret code used to confirm the PIN code
      * @param loginName  the login name
      * @returns `true` if the operation succeeded; `false` otherwise.
@@ -16128,19 +16182,17 @@ class Telephony extends events_1.default {
         return await __classPrivateFieldGet(this, _Telephony_telephonyRest, "f").makePrivateCall(deviceId, callee, pin, secretCode, loginName);
     }
     /**
-     * Initiates a new business call to another user (the callee), using the specified business code.
+     * Initiates a business call to the specified callee, charged to the specified
+     * cost center.
      * <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>
-     * First, the call server initiates a call on the user's `deviceId`. Then when the
-     * call is answered the call server starts the call to the `callee`, and an
-     * {@link ON_CALL_CREATED} event is raised.
      *
-     * @param deviceId     the device phone number for which the call is made
-     * @param callee       the called number
-     * @param businessCode the cost center on which the call will be charged
+     * @param deviceId     the device phone number from which the call is placed; if the
+     *                     session is opened by a user, this must be one of the user's devices
+     * @param callee       the called phone number
+     * @param businessCode the cost center code to charge the call to
      * @param loginName    the login name
      * @returns `true` if the operation succeeded; `false` otherwise.
      */
@@ -16148,18 +16200,16 @@ class Telephony extends events_1.default {
         return await __classPrivateFieldGet(this, _Telephony_telephonyRest, "f").makeBusinessCall(deviceId, callee, businessCode, loginName);
     }
     /**
-     * Initiates a call from a CCD agent to a supervisor.
+     * Initiates a call from a CCD agent to their 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.
-     * <p>
-     * First, the call server initiates a call on the agent's `deviceId`. Then when
-     * the call is answered the call server calls the supervisor, and an
-     * {@link ON_CALL_CREATED} event is raised.
      *
-     * @param deviceId   the device phone number for which the call is made
-     * @param autoAnswer automatic answer on make call
+     * @param deviceId   the device phone number from which the call is placed; if the
+     *                   session is opened by a user, this must be one of the user's devices
+     * @param autoAnswer if `true`, the supervisor is called immediately; if `false`,
+     *                   the agent's device is called first
      * @param loginName  the login name
      * @returns `true` if the operation succeeded; `false` otherwise.
      */
@@ -16167,20 +16217,23 @@ class Telephony extends events_1.default {
         return await __classPrivateFieldGet(this, _Telephony_telephonyRest, "f").makeSupervisorCall(deviceId, autoAnswer, loginName);
     }
     /**
-     * Initiates an enquiry call from a CCD agent to a pilot or a RSI point.
+     * Initiates a supervised transfer enquiry call from a CCD agent to a pilot or
+     * a RSI point.
+     * <p>
+     * The CCD pilot or the RSI point performs call distribution to select an agent
+     * that will be alerted. The `callProfile` is mandatory when the
+     * <em>Advanced Call Routing</em> distribution strategy is configured.
      * <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>
-     * The CCD pilot or the RSI point performs a call distribution to select an agent
-     * that will be alerted by this call. The `callProfile` is mandatory in case of
-     * "Advanced Call Routing" call distribution strategy.
      *
-     * @param deviceId       the device phone number for which the call is made
-     * @param pilot          the called CCD pilot or RSI point number
-     * @param correlatorData correlator data to add to the call
-     * @param callProfile    the call profile associated to this call
+     * @param deviceId       the device phone number from which the call is placed; if the
+     *                       session is opened by a user, this must be one of the user's devices
+     * @param pilot          the CCD pilot or RSI point number to call
+     * @param correlatorData optional correlator data to attach to the call
+     * @param callProfile    the call profile associated to this call; mandatory when the
+     *                       <em>Advanced Call Routing</em> distribution strategy is in use
      * @param loginName      the login name
      * @returns `true` if the operation succeeded; `false` otherwise.
      */
@@ -16190,19 +16243,22 @@ class Telephony extends events_1.default {
     /**
      * Initiates a local call to a CCD pilot or a RSI point.
      * <p>
+     * The CCD pilot or the RSI point performs call distribution to select an agent
+     * that will be alerted. The `callProfile` is mandatory when the
+     * <em>Advanced Call Routing</em> distribution strategy is configured.
+     * <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>
-     * The CCD pilot or the RSI point performs a call distribution to select an agent
-     * that will be alerted by this call. The `callProfile` is mandatory in case of
-     * "Advanced Call Routing" call distribution strategy.
      *
-     * @param deviceId       the device phone number for which the call is made
-     * @param pilot          the called CCD pilot or RSI point number
-     * @param autoAnswer     automatic answer on make call
-     * @param correlatorData correlator data to add to the call
-     * @param callProfile    the call profile associated to this call
+     * @param deviceId       the device phone number from which the call is placed; if the
+     *                       session is opened by a user, this must be one of the user's devices
+     * @param pilot          the CCD pilot or RSI point number to call
+     * @param autoAnswer     if `true`, the pilot is called immediately; if `false`,
+     *                       the user's device is called first
+     * @param correlatorData optional correlator data to attach to the call
+     * @param callProfile    the call profile associated to this call; mandatory when the
+     *                       <em>Advanced Call Routing</em> distribution strategy is in use
      * @param loginName      the login name
      * @returns `true` if the operation succeeded; `false` otherwise.
      */
@@ -16210,15 +16266,16 @@ class Telephony extends events_1.default {
         return null;
     }
     /**
-     * Hangs up an active call; all parties are released.
+     * Releases the specified call; all parties are disconnected.
      * <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 callRef   the call reference to hang up
+     * @param callRef   the call reference
      * @param loginName the login name
      * @returns `true` if the operation succeeded; `false` otherwise.
+     * @see dropme
      */
     async release(callRef, loginName = null) {
         return await __classPrivateFieldGet(this, _Telephony_telephonyRest, "f").release(callRef, loginName);
@@ -16230,8 +16287,8 @@ class Telephony extends events_1.default {
      * If the session is opened by a user, the device phone number must be one of
      * the user's devices.
      *
-     * @param callRef  the call reference of the call on hold
-     * @param deviceId the device phone number for which the operation is done
+     * @param callRef  the call reference of the active call
+     * @param deviceId the device phone number for which the operation is performed
      * @returns `true` if the operation succeeded; `false` otherwise.
      */
     async alternate(callRef, deviceId) {
@@ -16248,7 +16305,7 @@ class Telephony extends events_1.default {
      * checking the capabilities of the involved leg (answer capability on the leg).
      *
      * @param callRef  the call reference of the ringing call
-     * @param deviceId the device phone number for which the operation is done
+     * @param deviceId the device phone number for which the operation is performed
      * @returns `true` if the operation succeeded; `false` otherwise.
      */
     async answer(callRef, deviceId) {
@@ -16258,11 +16315,12 @@ class Telephony extends events_1.default {
      * Attaches the specified correlator data to the specified call.
      * <p>
      * This is used by the application to provide application-related information
-     * (limited to 32 bytes). In general, it is used to give information concerning
-     * a previously established call to the party of a second call.
+     * (limited to 32 bytes). In general, it is used to convey context from a
+     * previously established call to the party of a second call.
      *
      * @param callRef        the call reference
-     * @param deviceId       the device phone number for which the operation is done
+     * @param deviceId       the device phone number for which the operation is performed;
+     *                       if the session is opened by a user, this must be one of the user's devices
      * @param correlatorData the correlator data to attach
      * @returns `true` if the operation succeeded; `false` otherwise.
      */
@@ -16270,15 +16328,15 @@ class Telephony extends events_1.default {
         return await __classPrivateFieldGet(this, _Telephony_telephonyRest, "f").attachData(callRef, deviceId, correlatorData);
     }
     /**
-     * Transfers the active call to another user, without keeping control of the call.
+     * Transfers the active call to another party without keeping control of the 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 callRef    the reference of the active call
-     * @param transferTo the phone number to which the call is transferred
-     * @param anonymous  if `true`, the call will be transferred anonymously
+     * @param transferTo the phone number to transfer the call to
+     * @param anonymous  if `true`, the call is transferred anonymously
      * @param loginName  the login name
      * @returns `true` if the operation succeeded; `false` otherwise.
      */
@@ -16286,8 +16344,7 @@ class Telephony extends events_1.default {
         return await __classPrivateFieldGet(this, _Telephony_telephonyRest, "f").blindTransfer(callRef, transferTo, anonymous, loginName);
     }
     /**
-     * Requests a callback on the call specified by the call reference for the
-     * specified user.
+     * Requests a callback on the specified 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
@@ -16301,8 +16358,7 @@ class Telephony extends events_1.default {
         return await __classPrivateFieldGet(this, _Telephony_telephonyRest, "f").callback(callRef, loginName);
     }
     /**
-     * Returns the legs involved in the call specified by the call reference for the
-     * specified user.
+     * Returns the legs associated to the specified 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
@@ -16311,13 +16367,13 @@ class Telephony extends events_1.default {
      * @param callRef   the call reference
      * @param loginName the login name
      * @returns the list of {@link Leg} objects on success; `null` otherwise.
+     * @see getLeg
      */
     async getLegs(callRef, loginName = null) {
         return await __classPrivateFieldGet(this, _Telephony_telephonyRest, "f").getLegs(callRef, loginName);
     }
     /**
-     * Returns the leg specified by its id, involved in the call specified by the
-     * call reference for the specified user.
+     * Returns the specified leg of the specified 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
@@ -16326,20 +16382,21 @@ class Telephony extends events_1.default {
      * @param callRef   the call reference
      * @param legId     the leg identifier
      * @param loginName the login name
-     * @returns the {@link Leg} on success; `null` otherwise.
+     * @returns the {@link Leg} with the given identifier on success; `null` if not found.
+     * @see getLegs
      */
     async getLeg(callRef, legId, loginName = null) {
         return await __classPrivateFieldGet(this, _Telephony_telephonyRest, "f").getLeg(callRef, legId, loginName);
     }
     /**
-     * Exits from the call specified by its reference for the specified user.
+     * Exits from the specified call for the specified user.
+     * <p>
+     * If the call is a single call, it is released; if it is a conference, the call
+     * carries on without the 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.
-     * <p>
-     * If the call is a single call, it is released; if it is a conference, the call
-     * carries on without the user.
      *
      * @param callRef   the call reference
      * @param loginName the login name for whom the drop is done
@@ -16349,24 +16406,24 @@ class Telephony extends events_1.default {
         return await __classPrivateFieldGet(this, _Telephony_telephonyRest, "f").dropme(callRef, loginName);
     }
     /**
-     * Puts on hold the call specified by its reference, on the specified device,
-     * for the specified user.
+     * Puts the specified call on hold on the specified device.
      * <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 callRef   the call reference
-     * @param deviceId  the device phone number from which the call is put on hold
+     * @param deviceId  the device phone number from which the hold is requested; if the
+     *                  session is opened by a user, this must be one of the user's devices
      * @param loginName the login name
      * @returns `true` if the operation succeeded; `false` otherwise.
+     * @see retrieve
      */
     async hold(callRef, deviceId, loginName = null) {
         return await __classPrivateFieldGet(this, _Telephony_telephonyRest, "f").hold(callRef, deviceId, loginName);
     }
     /**
-     * Makes a 3-party conference with a specified active call and a specified held
-     * call for the specified user.
+     * Creates a 3-party conference from the specified active call and a held 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
@@ -16381,8 +16438,7 @@ class Telephony extends events_1.default {
         return await __classPrivateFieldGet(this, _Telephony_telephonyRest, "f").merge(callRef, heldCallRef, loginName);
     }
     /**
-     * Redirects an outgoing ringing call specified by its reference to the voice
-     * mail of the called user.
+     * Redirects an outgoing ringing call to the voice mail of the called 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
@@ -16396,7 +16452,11 @@ class Telephony extends events_1.default {
         return await __classPrivateFieldGet(this, _Telephony_telephonyRest, "f").overflowToVoiceMail(callRef, loginName);
     }
     /**
-     * Gets the telephonic state and capabilities for the specified user.
+     * Returns a snapshot of the current telephonic state for the specified user.
+     * <p>
+     * This method performs a synchronous REST query. For an event-driven approach,
+     * use {@link requestSnapshot} instead, which raises an {@link ON_TELEPHONY_STATE}
+     * event asynchronously.
      * <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
@@ -16404,29 +16464,32 @@ class Telephony extends events_1.default {
      *
      * @param loginName the login name
      * @returns the {@link TelephonicState} on success; `null` otherwise.
+     * @see requestSnapshot
      */
     async getState(loginName = null) {
         return await __classPrivateFieldGet(this, _Telephony_telephonyRest, "f").getState(loginName);
     }
     /**
-     * Parks the specified active call to a target device.
+     * Parks the specified active call on a target device.
      * <p>
-     * If the device is not provided, the call will be parked on the current device.
+     * If `parkTo` is not provided, the call is parked on the current device.
      * <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 callRef   the active call reference
-     * @param parkTo    the target device, or `null` to park on the current device
+     * @param parkTo    the target device extension number, or `null` to park on the
+     *                  current device
      * @param loginName the login name
      * @returns `true` if the operation succeeded; `false` otherwise.
+     * @see unPark
      */
     async park(callRef, parkTo = null, loginName = null) {
         return await __classPrivateFieldGet(this, _Telephony_telephonyRest, "f").park(callRef, parkTo, loginName);
     }
     /**
-     * Returns the list of participants in the specified call.
+     * Returns the participants of the specified 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
@@ -16435,12 +16498,13 @@ class Telephony extends events_1.default {
      * @param callRef   the call reference
      * @param loginName the login name
      * @returns the list of {@link Participant} objects on success; `null` otherwise.
+     * @see getParticipant
      */
     async getParticipants(callRef, loginName = null) {
         return await __classPrivateFieldGet(this, _Telephony_telephonyRest, "f").getParticipants(callRef, loginName);
     }
     /**
-     * Returns the specified participant in the specified call.
+     * Returns the specified participant of the specified 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
@@ -16449,7 +16513,8 @@ class Telephony extends events_1.default {
      * @param callRef       the call reference
      * @param participantId the participant identifier
      * @param loginName     the login name
-     * @returns the {@link Participant} on success; `null` otherwise.
+     * @returns the {@link Participant} with the given identifier on success; `null` if not found.
+     * @see getParticipants
      */
     async getParticipant(callRef, participantId, loginName = null) {
         return await __classPrivateFieldGet(this, _Telephony_telephonyRest, "f").getParticipant(callRef, participantId, loginName);
@@ -16473,15 +16538,15 @@ class Telephony extends events_1.default {
         return await __classPrivateFieldGet(this, _Telephony_telephonyRest, "f").dropParticipant(callRef, participantId, loginName);
     }
     /**
-     * Releases the current call (active or ringing) to retrieve a previously put on
-     * hold call, cancelling a consultation call.
+     * Releases the current call to retrieve a previously held call (cancels a consultation 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 callRef        the held call reference
-     * @param deviceId       the device phone number for which the operation is done
+     * @param deviceId       the device phone number for which the operation is performed; if the
+     *                       session is opened by a user, this must be one of the user's devices
      * @param enquiryCallRef the reference of the enquiry call to cancel
      * @param loginName      the login name
      * @returns `true` if the operation succeeded; `false` otherwise.
@@ -16490,7 +16555,7 @@ class Telephony extends events_1.default {
         return await __classPrivateFieldGet(this, _Telephony_telephonyRest, "f").reconnect(callRef, deviceId, enquiryCallRef, loginName);
     }
     /**
-     * Starts, stops, pauses or resumes the recording of the specified call.
+     * Starts, stops, pauses, or resumes the recording of the specified 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
@@ -16505,8 +16570,7 @@ class Telephony extends events_1.default {
         return await __classPrivateFieldGet(this, _Telephony_telephonyRest, "f").doRecordAction(callRef, action, loginName);
     }
     /**
-     * Redirects an incoming ringing call to another user or number, instead of
-     * responding to it.
+     * Redirects an incoming ringing call to another number or to voice mail.
      * <p>
      * If `redirectTo` is equal to `"VOICEMAIL"`, the incoming ringing call is
      * redirected to the user's voice mail.
@@ -16516,8 +16580,9 @@ class Telephony extends events_1.default {
      * administrator.
      *
      * @param callRef    the incoming ringing call reference
-     * @param redirectTo the phone number of the redirection, or `"VOICEMAIL"`
-     * @param anonymous  if `true`, the call will be redirected anonymously
+     * @param redirectTo the phone number of the redirection, or `"VOICEMAIL"` to redirect
+     *                   to the user's voice mail
+     * @param anonymous  if `true`, the redirect is anonymous and the caller identity is hidden
      * @param loginName  the login name
      * @returns `true` if the operation succeeded; `false` otherwise.
      */
@@ -16527,12 +16592,16 @@ class Telephony extends events_1.default {
     /**
      * Retrieves a call that has been previously put on hold.
      * <p>
-     * This method will return `false` if it is invoked from a session opened
-     * by an administrator.
+     * 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 callRef  the held call reference
-     * @param deviceId the device phone number for which the operation is done
+     * @param callRef   the held call reference
+     * @param deviceId  the device phone number for which the operation is performed; if the
+     *                  session is opened by a user, this must be one of the user's devices
+     * @param loginName the login name
      * @returns `true` if the operation succeeded; `false` otherwise.
+     * @see hold
      */
     async retrieve(callRef, deviceId, loginName = null) {
         return await __classPrivateFieldGet(this, _Telephony_telephonyRest, "f").retrieve(callRef, deviceId, loginName);
@@ -16541,7 +16610,8 @@ class Telephony extends events_1.default {
      * Sends DTMF codes on the specified active call.
      *
      * @param callRef  the active call reference
-     * @param deviceId the device phone number for which the operation is done
+     * @param deviceId the device phone number for which the operation is performed; if the
+     *                 session is opened by a user, this must be one of the user's devices
      * @param number   the DTMF codes to send
      * @returns `true` if the operation succeeded; `false` otherwise.
      */
@@ -16549,22 +16619,22 @@ class Telephony extends events_1.default {
         return await __classPrivateFieldGet(this, _Telephony_telephonyRest, "f").sendDtmf(callRef, deviceId, number);
     }
     /**
-     * Sends the account info for the specified call, on the specified device.
+     * Sends the transaction code for the specified call on the specified device.
      * <p>
-     * This operation is used by a CCD agent to send the transaction code at the end
-     * of the call. The string value must comply with the transaction code accepted
-     * by OXE (numerical values only).
+     * Used by a CCD agent to send the transaction code at the end of a call.
+     * The value must comply with the OmniPCX Enterprise transaction code format
+     * (numeric values only).
      *
      * @param callRef     the call reference
      * @param deviceId    the device phone number for which the operation is done
-     * @param accountInfo the transaction code
+     * @param accountInfo the transaction code (numeric values only)
      * @returns `true` if the operation succeeded; `false` otherwise.
      */
     async sendAccountInfo(callRef, deviceId, accountInfo) {
         return await __classPrivateFieldGet(this, _Telephony_telephonyRest, "f").sendAccountInfo(callRef, deviceId, accountInfo);
     }
     /**
-     * Transfers a specified active call to a specified held call for the specified user.
+     * Transfers the specified active call to the specified held 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
@@ -16579,7 +16649,7 @@ class Telephony extends events_1.default {
         return await __classPrivateFieldGet(this, _Telephony_telephonyRest, "f").transfer(callRef, heldCallRef, loginName);
     }
     /**
-     * Logs the specified user on a specified desk sharing set.
+     * Logs the specified user onto a desk sharing set.
      * <p>
      * The user must be configured as a desk sharing user.
      * <p>
@@ -16587,7 +16657,7 @@ class Telephony extends events_1.default {
      * ignored, but it is mandatory if the session has been opened by an
      * administrator.
      *
-     * @param dssDeviceNumber the desk sharing set phone number
+     * @param dssDeviceNumber the desk sharing set phone number to log on to
      * @param loginName       the login name
      * @returns `true` if the operation succeeded; `false` otherwise.
      * @see deskSharingLogOff
@@ -16596,7 +16666,7 @@ class Telephony extends events_1.default {
         return await __classPrivateFieldGet(this, _Telephony_telephonyRest, "f").deskSharingLogOn(dssDeviceNumber, loginName);
     }
     /**
-     * Logs off the specified user from the desk sharing set.
+     * Logs the specified user off from their desk sharing set.
      * <p>
      * The user must be configured as a desk sharing user.
      * <p>
@@ -16612,7 +16682,7 @@ class Telephony extends events_1.default {
         return await __classPrivateFieldGet(this, _Telephony_telephonyRest, "f").deskSharingLogOff(loginName);
     }
     /**
-     * Gets the states of all devices of the specified user.
+     * Returns the operational state of all devices belonging to 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
@@ -16620,47 +16690,50 @@ class Telephony extends events_1.default {
      *
      * @param loginName the login name
      * @returns the list of {@link DeviceState} objects on success; `null` otherwise.
+     * @see getDeviceState
      */
     async getDevicesState(loginName = null) {
         return await __classPrivateFieldGet(this, _Telephony_telephonyRest, "f").getDevicesState(loginName);
     }
     /**
-     * Gets the state of the specified device of the specified user.
+     * Returns the operational state of the specified device.
      * <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 deviceId  the device phone number for which the operation is done
+     * @param deviceId  the device phone number
      * @param loginName the login name
-     * @returns the {@link DeviceState} on success; `null` otherwise.
+     * @returns the {@link DeviceState} for the requested device on success; `null` on error
+     *          or if the device does not belong to the user.
+     * @see getDevicesState
      */
     async getDeviceState(deviceId, loginName = null) {
         return await __classPrivateFieldGet(this, _Telephony_telephonyRest, "f").getDeviceState(deviceId, loginName);
     }
     /**
-     * Picks up the specified incoming call for another user.
+     * Picks up an incoming call ringing on another user's device.
      *
-     * @param deviceId         the device phone number for which the operation is done
-     * @param otherCallRef     the reference of the call to pick up (on the remote user)
+     * @param deviceId         the device phone number from which the pickup is performed;
+     *                         if the session is opened by a user, this must be one of the user's devices
+     * @param otherCallRef     the reference of the call to pick up on the remote user
      * @param otherPhoneNumber the phone number on which the call is ringing
-     * @param autoAnswer       if `true`, automatically answers the call after the pickup
+     * @param autoAnswer       if `true`, the call is automatically answered after pickup
      * @returns `true` if the operation succeeded; `false` otherwise.
      */
     async pickUp(deviceId, otherCallRef, otherPhoneNumber, autoAnswer = false) {
         return await __classPrivateFieldGet(this, _Telephony_telephonyRest, "f").pickUp(deviceId, otherCallRef, otherPhoneNumber, autoAnswer);
     }
     /**
-     * Performs an intrusion in the active call of a called user.
+     * Intrudes into the active call of a busy user.
+     * <p>
+     * Intrusion requires that the current device is in releasing state while calling
+     * a user who is engaged in a call, and that both the current device and the
+     * engaged users have the intrusion capability configured.
      * <p>
-     * No parameter is required to invoke the intrusion: it only depends on the
-     * current intrusion capability of the current device. It is based on the fact
-     * that the current device must be in releasing state while calling a user which
-     * is in a busy call with another user, the current device has the intrusion
-     * capability, and the 2 users engaged in the call have the capability to allow
-     * intrusion.
+     * Available from O2G 2.4.
      *
-     * @param deviceId the device from which the intrusion is requested
+     * @param deviceId the device phone number from which the intrusion is initiated
      * @returns `true` if the operation succeeded; `false` otherwise.
      * @since O2G 2.4
      */
@@ -16668,32 +16741,37 @@ class Telephony extends events_1.default {
         return await __classPrivateFieldGet(this, _Telephony_telephonyRest, "f").intrusion(deviceId);
     }
     /**
-     * Unparks a call from a target device.
+     * Unparks a previously parked call onto the specified device.
      *
-     * @param deviceId    the device from which the unpark request is made
-     * @param heldCallRef the reference of the held call to unpark
+     * @param deviceId    the device from which the unpark is requested
+     * @param heldCallRef the reference of the parked call
      * @returns `true` if the operation succeeded; `false` otherwise.
+     * @see park
      */
     async unPark(deviceId, heldCallRef) {
         return await __classPrivateFieldGet(this, _Telephony_telephonyRest, "f").unPark(deviceId, heldCallRef);
     }
     /**
-     * Retrieves the hunting group status of the specified user.
+     * Returns the hunting group login status of 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 login name
-     * @returns the {@link HuntingGroupStatus} on success; `null` otherwise.
+     * @returns the {@link HuntingGroupStatus} indicating whether the user is logged into
+     *          their hunting group on success; `null` otherwise.
+     * @see huntingGroupLogOn
+     * @see huntingGroupLogOff
      */
     async getHuntingGroupStatus(loginName = null) {
         return await __classPrivateFieldGet(this, _Telephony_telephonyRest, "f").getHuntingGroupStatus(loginName);
     }
     /**
-     * Logs on the specified user in their current hunting group.
+     * Logs the specified user into their current hunting group.
      * <p>
      * The user must be configured as a member of a hunting group.
+     * Has no effect and returns `true` if the user is already logged in.
      * <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
@@ -16707,9 +16785,10 @@ class Telephony extends events_1.default {
         return await __classPrivateFieldGet(this, _Telephony_telephonyRest, "f").huntingGroupLogOn(loginName);
     }
     /**
-     * Logs off the specified user from their current hunting group.
+     * Logs the specified user off from their current hunting group.
      * <p>
      * The user must be configured as a member of a hunting group.
+     * Has no effect and returns `true` if the user 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
@@ -16723,7 +16802,7 @@ class Telephony extends events_1.default {
         return await __classPrivateFieldGet(this, _Telephony_telephonyRest, "f").huntingGroupLogOff(loginName);
     }
     /**
-     * Sets the specified user as a member of a hunting group.
+     * Adds the specified user as a member of an existing hunting group.
      * <p>
      * The request will fail if the hunting group does not exist. If the user
      * already belongs to the group, nothing is done and `true` is returned.
@@ -16741,7 +16820,7 @@ class Telephony extends events_1.default {
         return await __classPrivateFieldGet(this, _Telephony_telephonyRest, "f").addMeToHuntingGroup(hgNumber, loginName);
     }
     /**
-     * Removes the specified user from a hunting group.
+     * Removes the specified user from an existing hunting group.
      * <p>
      * The request will fail if the hunting group does not exist. If the user does
      * not belong to the group, nothing is done and `true` is returned.
@@ -16759,33 +16838,40 @@ class Telephony extends events_1.default {
         return await __classPrivateFieldGet(this, _Telephony_telephonyRest, "f").removeMeFromHuntingGroup(hgNumber, loginName);
     }
     /**
-     * Gets the list of hunting groups on the OXE node the specified user belongs to.
+     * Returns the hunting groups available on the OmniPCX Enterprise node the
+     * specified user belongs to.
      * <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 login name
-     * @returns the {@link HuntingGroups} on success; `null` otherwise.
+     * @returns the {@link HuntingGroups} listing available hunting groups and the user's
+     *          current membership on success; `null` otherwise.
+     * @see getHuntingGroupStatus
+     * @see addMeToHuntingGroup
+     * @see removeMeFromHuntingGroup
      */
     async queryHuntingGroups(loginName = null) {
         return await __classPrivateFieldGet(this, _Telephony_telephonyRest, "f").queryHuntingGroups(loginName);
     }
     /**
-     * Returns the list of callback requests for the specified user.
+     * Returns the pending callback requests 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 login name
-     * @returns the list of {@link Callback} objects on success; `null` otherwise.
+     * @returns the list of pending {@link Callback} objects on success; `null` otherwise.
+     * @see deleteCallbacks
+     * @see deleteCallback
      */
     async getCallbacks(loginName = null) {
         return await __classPrivateFieldGet(this, _Telephony_telephonyRest, "f").getCallbacks(loginName);
     }
     /**
-     * Deletes all callback requests for the specified user.
+     * Deletes all pending callback requests 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
@@ -16793,122 +16879,131 @@ class Telephony extends events_1.default {
      *
      * @param loginName the login name
      * @returns `true` if the operation succeeded; `false` otherwise.
+     * @see getCallbacks
      */
     async deleteCallbacks(loginName = null) {
         return await __classPrivateFieldGet(this, _Telephony_telephonyRest, "f").deleteCallbacks(loginName);
     }
     /**
-     * Deletes the specified callback request for the specified user.
+     * Deletes the specified callback request.
      * <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 callbackId the callback identifier
+     * @param callbackId the callback identifier as returned by {@link getCallbacks}
      * @param loginName  the login name
      * @returns `true` if the operation succeeded; `false` otherwise.
+     * @see getCallbacks
+     * @see deleteCallbacks
      */
     async deleteCallback(callbackId, loginName = null) {
         return await __classPrivateFieldGet(this, _Telephony_telephonyRest, "f").deleteCallback(callbackId, loginName);
     }
     /**
-     * Returns the current new mini message for the specified user.
+     * Returns the next unread mini message for the specified user.
      * <p>
-     * As soon as a message is read, it is erased from OXE and cannot be read again.
-     * Messages are retrieved in Last In First Out order.
-     * <p>
-     * This method will return `null` if all messages have been retrieved.
+     * Messages are consumed on read — once retrieved, a message is deleted from the
+     * OXE and cannot be read again. Messages are returned in Last In First Out order.
+     * Returns `null` when there are no more unread messages.
      * <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 login name
-     * @returns the {@link MiniMessage} on success; `null` otherwise.
+     * @returns the {@link MiniMessage} on success; `null` if there are no unread
+     *          messages or on error.
      */
     async getMiniMessage(loginName = null) {
         return await __classPrivateFieldGet(this, _Telephony_telephonyRest, "f").getMiniMessage(loginName);
     }
     /**
-     * Sends the specified mini message to the specified recipient.
+     * Sends a mini message to the specified recipient.
      * <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 recipient the phone number of the mini message recipient
-     * @param message   the mini message text
+     * @param recipient the phone number of the message recipient
+     * @param message   the message text
      * @param loginName the login name
      * @returns `true` if the operation succeeded; `false` otherwise.
+     * @see getMiniMessage
      */
     async sendMiniMessage(recipient, message, loginName = null) {
         return await __classPrivateFieldGet(this, _Telephony_telephonyRest, "f").sendMiniMessage(recipient, message, loginName);
     }
     /**
-     * Requests a callback from an idle device of the specified user.
+     * Requests a callback from an idle device.
      * <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 callee    the phone number of the called party for which a callback is requested
+     * @param callee    the phone number of the party to request a callback from
      * @param loginName the login name
      * @returns `true` if the operation succeeded; `false` otherwise.
+     * @see getCallbacks
+     * @see deleteCallbacks
      */
     async requestCallback(callee, loginName = null) {
         return await __classPrivateFieldGet(this, _Telephony_telephonyRest, "f").requestCallback(callee, loginName);
     }
     /**
-     * Asks a snapshot event on the specified user.
+     * Requests a snapshot event to receive the current telephonic state via an
+     * {@link ON_TELEPHONY_STATE} event.
+     * <p>
+     * The resulting event will contain the full {@link TelephonicState} including
+     * active calls and device capabilities. If a second request is issued while the
+     * first is still in progress, it has no effect.
      * <p>
-     * The {@link ON_TELEPHONY_STATE} event will contain the {@link TelephonicState}
-     * (calls and device capabilities). If a second request is asked while the
-     * previous one is still in progress, it has no effect.
+     * If an administrator calls this with a `null` `loginName`, the snapshot is
+     * requested for all users, which may take time depending on the number of users.
      * <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 login name
-     * @returns `true` if the request was successfully submitted; `false` otherwise.
+     * @returns `true` if the operation succeeded; `false` otherwise.
+     * @see getState
      */
     async requestSnapshot(loginName = null) {
         return await __classPrivateFieldGet(this, _Telephony_telephonyRest, "f").requestSnapshot(loginName);
     }
     /**
-     * Toggles the microphone or interphony state on the specified device.
-     * <p>
-     * This action acts as a flip/flop and has the same effect as pressing the key:
+     * Toggles interphony or hands-free mode on the specified device.
      * <ul>
-     * <li>activates or deactivates the microphone if the device has an outgoing or established call</li>
+     * <li>activates or deactivates the microphone if the device has an active call</li>
      * <li>activates or deactivates the interphony if the device is idle</li>
      * <li>has no effect if the device is ringing on an incoming call</li>
      * </ul>
      * <p>
-     * This operation is done in blind mode: no state event is provided on the push,
-     * but when the device returns to idle after a call, the microphone comes back to
-     * the active state.
+     * This operation is done in blind mode: no state event is raised on the push,
+     * but when the device returns to idle after a call, the microphone comes back
+     * to the active state.
      *
-     * @param deviceId the device phone number for which the operation is done
+     * @param deviceId the device phone number for which the operation is performed
      * @returns `true` if the operation succeeded; `false` otherwise.
      */
     async toggleInterphony(deviceId) {
         return await __classPrivateFieldGet(this, _Telephony_telephonyRest, "f").toggleInterphony(deviceId);
     }
     /**
-     * Query the specified CCD pilot information.
-     * <p>
-     * This method is used to get various information on the CCD pilot routing
-     * capabilities.
+     * Returns transfer possibilities for the specified CCD pilot.
      * <p>
-     * This method will return `null` if it is invoked from a session opened
-     * by an administrator.
+     * 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 nodeId                  the PCX Enterprise node id
-     * @param pilotNumber             the pilot number
-     * @param pilotTransferQueryParam optional call profile context parameters
+     * @param nodeId                  the OmniPCX Enterprise node ID
+     * @param pilotNumber             the CCD pilot directory number
+     * @param pilotTransferQueryParam optional query criteria to filter results by agent number,
+     *                                priority transfer, supervised transfer, or call profile
      * @param loginName               the login name
-     * @returns the {@link PilotInfo} on success; `null` otherwise.
+     * @returns the {@link PilotInfo} describing the pilot's queue state and transfer possibilities
+     *          on success; `null` otherwise.
      * @since 2.7
      */
     async getPilotInfo(nodeId, pilotNumber, pilotTransferQueryParam = null, loginName = null) {
@@ -16997,9 +17092,17 @@ var _UsersManagement_usersManagementRest;
 Object.defineProperty(exports, "__esModule", ({ value: true }));
 exports.UsersManagement = void 0;
 /**
- * The Users Management service allows an administrator to create, delete and retrieve O2G users.
+ * The Users Management service allows an administrator to create, delete, and retrieve O2G users.
  * <p>
- * This service requires an administrator session.
+ * O2G allows users to be created according to different methods:
+ * <ul>
+ * <li>Automatically when O2G starts, according to the automatic user creation mode.</li>
+ * <li>Through provisioning files.</li>
+ * <li>On demand through this service, which allows creating one user, a list of users,
+ *     or all users on a given OmniPCX Enterprise node.</li>
+ * </ul>
+ * Using this service does not require any specific license. This service requires an
+ * administrator session.
  *
  * @example
  * ```typescript
@@ -17032,22 +17135,21 @@ class UsersManagement {
         __classPrivateFieldSet(this, _UsersManagement_usersManagementRest, usersManagementRest, "f");
     }
     /**
-     * Retrieves the login names of users from the connected OmniPCX Enterprise nodes.
+     * Retrieves a list of user login names from the connected OmniPCX Enterprise nodes.
      * <p>
      * If `nodeIds` is `null`, retrieves the login names from all connected nodes.
      *
      * @param nodeIds optional list of OXE node ids to restrict the query to.
-     *                Only valid for an administrator session.
      * @returns the list of user login names on success; `null` otherwise.
      */
     async getLogins(nodeIds = null) {
         return await __classPrivateFieldGet(this, _UsersManagement_usersManagementRest, "f").getLogins(nodeIds);
     }
     /**
-     * Retrieves the login name of a user identified by one of their devices.
+     * Retrieves the login name of a user identified by one of their device directory numbers.
      *
-     * @param deviceNumber the device phone number
-     * @returns the user login name on success; `null` otherwise.
+     * @param deviceNumber a directory number of a device belonging to the user being searched for.
+     * @returns the login name of the user on success; `null` otherwise.
      */
     async getByDeviceNumber(deviceNumber) {
         return await __classPrivateFieldGet(this, _UsersManagement_usersManagementRest, "f").getByDeviceNumber(deviceNumber);
@@ -17055,21 +17157,22 @@ class UsersManagement {
     /**
      * Creates O2G users on the specified OmniPCX Enterprise node.
      * <p>
-     * If `deviceNumbers` is `null` or empty, all users on the specified node are created.
+     * If `deviceNumbers` is `null` or empty, all users configured on the specified node
+     * are created.
      *
      * @example
      * ```typescript
      * // Create specific users by device number
-     * await O2G.usersManagement.createUsers(1, ["60200", "60201"]);
+     * const users = await O2G.usersManagement.createUsers(1, ["60200", "60201"]);
      *
      * // Create all users on the node
-     * await O2G.usersManagement.createUsers(1, null);
+     * const allUsers = await O2G.usersManagement.createUsers(1, null);
      * ```
      *
      * @param nodeId        the OXE node number
-     * @param deviceNumbers optional list of device phone numbers identifying the users to create.
+     * @param deviceNumbers optional list of device directory numbers identifying the users to create.
      *                      Pass `null` or an empty array to create all users on the node.
-     * @returns `true` if the operation succeeded; `false` otherwise.
+     * @returns the list of created {@link User} objects on success; `null` otherwise.
      */
     async createUsers(nodeId, deviceNumbers) {
         return await __classPrivateFieldGet(this, _UsersManagement_usersManagementRest, "f").createUsers(nodeId, deviceNumbers);
@@ -17145,12 +17248,13 @@ exports.Users = void 0;
 const events_1 = __importDefault(__webpack_require__(/*! events */ "events"));
 const users_events_1 = __webpack_require__(/*! ../types/users/users-events */ "./src/types/users/users-events.ts");
 /**
- * The User service allows:
+ * The Users service allows:
  * <ul>
  * <li>an administrator to retrieve the list of O2G users.</li>
  * <li>a user to get information on another user account.</li>
- * <li>a user to change their password or preferences such as supported language.</li>
+ * <li>a user to change their password or get parameters such as supported languages.</li>
  * </ul>
+ * Using this service does not require any specific license.
  *
  * @example
  * ```typescript
@@ -17237,7 +17341,7 @@ class Users extends events_1.default {
     /**
      * Retrieves the information of a user identified by their company extension number.
      *
-     * @param companyPhone the user extension number
+     * @param companyPhone the user company extension number
      * @returns the {@link User} information on success; `null` otherwise.
      */
     async getByCompanyPhone(companyPhone) {
@@ -17263,6 +17367,8 @@ class Users extends events_1.default {
     }
     /**
      * Changes the specified user's password.
+     * <p>
+     * This operation will fail if authentication is delegated to an external LDAP server.
      *
      * @param loginName   the user login name
      * @param oldPassword the current password
@@ -17276,7 +17382,7 @@ class Users extends events_1.default {
 exports.Users = Users;
 _Users_usersRest = new WeakMap();
 /**
- * Raised on creation of a user.
+ * Raised when a user is created.
  * @event
  */
 Users.ON_USER_CREATED = 'OnUserCreated';
@@ -17286,7 +17392,7 @@ Users.ON_USER_CREATED = 'OnUserCreated';
  */
 Users.ON_USER_DELETED = 'OnUserDeleted';
 /**
- * Raised on any change on the user's data.
+ * Raised on any change on a user's data.
  * @event
  */
 Users.ON_USER_INFO_CHANGED = 'OnUserInfoChanged';