o2g-node-sdk 2.5.5 → 2.5.7

package/dist/types/services/o2g-comlog.d.ts

@@ -4,9 +4,17 @@ import { QueryFilter } from '../types/comlog/query-filter';
 import { QueryResult } from '../types/comlog/query-result';
 import { ComRecord } from '../types/comlog/com-record';
 /**
- * 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
@@ -64,20 +72,19 @@ export declare class CommunicationLog extends EventEmitter {
      */
     static readonly ON_COM_RECORDS_UNACK = "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
@@ -96,65 +103,63 @@ export declare class CommunicationLog extends EventEmitter {
      *
      * @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.
      */
     getComRecords(filter?: QueryFilter | null, page?: Page | null, optimized?: boolean, loginName?: string | null): Promise<QueryResult | null>;
     /**
-     * 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.
      */
     getComRecord(recordId: string, loginName?: string | null): Promise<ComRecord | null>;
     /**
-     * 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
      */
     deleteComRecord(recordId: string, loginName?: string | null): Promise<boolean>;
     /**
-     * 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
      */
     deleteComRecordsById(recordIds: string[], loginName?: string | null): Promise<boolean>;
     /**
-     * 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
@@ -171,72 +176,68 @@ export declare class CommunicationLog extends EventEmitter {
      * ```
      *
      * @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
      */
     deleteComRecords(filter?: QueryFilter | null, loginName?: string | null): Promise<boolean>;
     /**
-     * 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
      */
     acknowledgeComRecords(recordIds: string[], loginName?: string | null): Promise<boolean>;
     /**
-     * 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
      */
     acknowledgeComRecord(recordId: string, loginName?: string | null): Promise<boolean>;
     /**
-     * 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
      */
     unacknowledgeComRecords(recordIds: string[], loginName?: string | null): Promise<boolean>;
     /**
-     * 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
      */

package/dist/types/services/o2g-comlog.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"o2g-comlog.d.ts","sourceRoot":"","sources":["../../../src/services/o2g-comlog.ts"],"names":[],"mappings":"AAmBA,OAAO,YAAY,MAAM,QAAQ,CAAC;AAElC,OAAO,EAAE,IAAI,EAAE,MAAM,sBAAsB,CAAC;AAC5C,OAAO,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAC;AAC3D,OAAO,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAC;AAS3D,OAAO,EAAE,SAAS,EAAE,MAAM,4BAA4B,CAAC;AAEvD;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,qBAAa,gBAAiB,SAAQ,YAAY;;IAG9C;;;OAGG;IACH,MAAM,CAAC,QAAQ,CAAC,qBAAqB,wBAAwB;IAE7D;;;OAGG;IACH,MAAM,CAAC,QAAQ,CAAC,sBAAsB,yBAAyB;IAE/D;;;;;;OAMG;IACH,MAAM,CAAC,QAAQ,CAAC,sBAAsB,yBAAyB;IAE/D;;;;;OAKG;IACH,MAAM,CAAC,QAAQ,CAAC,kBAAkB,qBAAqB;IAEvD;;;;;OAKG;IACH,MAAM,CAAC,QAAQ,CAAC,oBAAoB,uBAAuB;IAgB3D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAoCG;IACG,aAAa,CACf,MAAM,GAAE,WAAW,GAAG,IAAW,EACjC,IAAI,GAAE,IAAI,GAAG,IAAW,EACxB,SAAS,GAAE,OAAe,EAC1B,SAAS,GAAE,MAAM,GAAG,IAAW,GAChC,OAAO,CAAC,WAAW,GAAG,IAAI,CAAC;IAI9B;;;;;;;;;;OAUG;IACG,YAAY,CAAC,QAAQ,EAAE,MAAM,EAAE,SAAS,GAAE,MAAM,GAAG,IAAW,GAAG,OAAO,CAAC,SAAS,GAAG,IAAI,CAAC;IAIhG;;;;;;;;;;;;OAYG;IACG,eAAe,CAAC,QAAQ,EAAE,MAAM,EAAE,SAAS,GAAE,MAAM,GAAG,IAAW,GAAG,OAAO,CAAC,OAAO,CAAC;IAI1F;;;;;;;;;;;;;;;OAeG;IACG,oBAAoB,CAAC,SAAS,EAAE,MAAM,EAAE,EAAE,SAAS,GAAE,MAAM,GAAG,IAAW,GAAG,OAAO,CAAC,OAAO,CAAC;IAIlG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACG,gBAAgB,CAAC,MAAM,GAAE,WAAW,GAAG,IAAW,EAAE,SAAS,GAAE,MAAM,GAAG,IAAW,GAAG,OAAO,CAAC,OAAO,CAAC;IAI5G;;;;;;;;;;;;;;OAcG;IACG,qBAAqB,CAAC,SAAS,EAAE,MAAM,EAAE,EAAE,SAAS,GAAE,MAAM,GAAG,IAAW,GAAG,OAAO,CAAC,OAAO,CAAC;IAInG;;;;;;;;;;;;;;OAcG;IACG,oBAAoB,CAAC,QAAQ,EAAE,MAAM,EAAE,SAAS,GAAE,MAAM,GAAG,IAAW,GAAG,OAAO,CAAC,OAAO,CAAC;IAI/F;;;;;;;;;;;;;;OAcG;IACG,uBAAuB,CAAC,SAAS,EAAE,MAAM,EAAE,EAAE,SAAS,GAAE,MAAM,GAAG,IAAW,GAAG,OAAO,CAAC,OAAO,CAAC;IAIrG;;;;;;;;;;;;;;OAcG;IACG,sBAAsB,CAAC,QAAQ,EAAE,MAAM,EAAE,SAAS,GAAE,MAAM,GAAG,IAAW,GAAG,OAAO,CAAC,OAAO,CAAC;CAGpG"}
+{"version":3,"file":"o2g-comlog.d.ts","sourceRoot":"","sources":["../../../src/services/o2g-comlog.ts"],"names":[],"mappings":"AAmBA,OAAO,YAAY,MAAM,QAAQ,CAAC;AAElC,OAAO,EAAE,IAAI,EAAE,MAAM,sBAAsB,CAAC;AAC5C,OAAO,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAC;AAC3D,OAAO,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAC;AAS3D,OAAO,EAAE,SAAS,EAAE,MAAM,4BAA4B,CAAC;AAEvD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AACH,qBAAa,gBAAiB,SAAQ,YAAY;;IAG9C;;;OAGG;IACH,MAAM,CAAC,QAAQ,CAAC,qBAAqB,wBAAwB;IAE7D;;;OAGG;IACH,MAAM,CAAC,QAAQ,CAAC,sBAAsB,yBAAyB;IAE/D;;;;;;OAMG;IACH,MAAM,CAAC,QAAQ,CAAC,sBAAsB,yBAAyB;IAE/D;;;;;OAKG;IACH,MAAM,CAAC,QAAQ,CAAC,kBAAkB,qBAAqB;IAEvD;;;;;OAKG;IACH,MAAM,CAAC,QAAQ,CAAC,oBAAoB,uBAAuB;IAgB3D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAmCG;IACG,aAAa,CACf,MAAM,GAAE,WAAW,GAAG,IAAW,EACjC,IAAI,GAAE,IAAI,GAAG,IAAW,EACxB,SAAS,GAAE,OAAe,EAC1B,SAAS,GAAE,MAAM,GAAG,IAAW,GAChC,OAAO,CAAC,WAAW,GAAG,IAAI,CAAC;IAI9B;;;;;;;;;OASG;IACG,YAAY,CAAC,QAAQ,EAAE,MAAM,EAAE,SAAS,GAAE,MAAM,GAAG,IAAW,GAAG,OAAO,CAAC,SAAS,GAAG,IAAI,CAAC;IAIhG;;;;;;;;;;;;;OAaG;IACG,eAAe,CAAC,QAAQ,EAAE,MAAM,EAAE,SAAS,GAAE,MAAM,GAAG,IAAW,GAAG,OAAO,CAAC,OAAO,CAAC;IAI1F;;;;;;;;;;;;;;OAcG;IACG,oBAAoB,CAAC,SAAS,EAAE,MAAM,EAAE,EAAE,SAAS,GAAE,MAAM,GAAG,IAAW,GAAG,OAAO,CAAC,OAAO,CAAC;IAIlG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACG,gBAAgB,CAAC,MAAM,GAAE,WAAW,GAAG,IAAW,EAAE,SAAS,GAAE,MAAM,GAAG,IAAW,GAAG,OAAO,CAAC,OAAO,CAAC;IAI5G;;;;;;;;;;;;;OAaG;IACG,qBAAqB,CAAC,SAAS,EAAE,MAAM,EAAE,EAAE,SAAS,GAAE,MAAM,GAAG,IAAW,GAAG,OAAO,CAAC,OAAO,CAAC;IAInG;;;;;;;;;;;;;OAaG;IACG,oBAAoB,CAAC,QAAQ,EAAE,MAAM,EAAE,SAAS,GAAE,MAAM,GAAG,IAAW,GAAG,OAAO,CAAC,OAAO,CAAC;IAI/F;;;;;;;;;;;;;OAaG;IACG,uBAAuB,CAAC,SAAS,EAAE,MAAM,EAAE,EAAE,SAAS,GAAE,MAAM,GAAG,IAAW,GAAG,OAAO,CAAC,OAAO,CAAC;IAIrG;;;;;;;;;;;;;OAaG;IACG,sBAAsB,CAAC,QAAQ,EAAE,MAAM,EAAE,SAAS,GAAE,MAAM,GAAG,IAAW,GAAG,OAAO,CAAC,OAAO,CAAC;CAGpG"}

package/dist/types/services/o2g-directory.d.ts

@@ -1,36 +1,36 @@
 import { Criteria } from '../types/directory/criteria';
 import { SearchResult } from '../types/directory/search-result';
 /**
- * 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;
+ *     }
+ * }
  * ```
  */
 export declare class Directory {
@@ -40,12 +40,11 @@ export declare 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
@@ -55,28 +54,26 @@ export declare 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
      */
     cancel(loginName?: string | null): Promise<boolean>;
     /**
-     * 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
@@ -88,19 +85,17 @@ export declare 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
      */

package/dist/types/services/o2g-directory.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"o2g-directory.d.ts","sourceRoot":"","sources":["../../../src/services/o2g-directory.ts"],"names":[],"mappings":"AAoBA,OAAO,EAAE,QAAQ,EAAE,MAAM,6BAA6B,CAAC;AACvD,OAAO,EAAE,YAAY,EAAE,MAAM,kCAAkC,CAAC;AAEhE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AACH,qBAAa,SAAS;;IAUlB;;;;;;;;;;;;;;OAcG;IACG,MAAM,CAAC,MAAM,EAAE,QAAQ,EAAE,KAAK,GAAE,MAAM,GAAG,IAAW,EAAE,SAAS,GAAE,MAAM,GAAG,IAAW,GAAG,OAAO,CAAC,OAAO,CAAC;IAI9G;;;;;;;;;;OAUG;IACG,MAAM,CAAC,SAAS,GAAE,MAAM,GAAG,IAAW,GAAG,OAAO,CAAC,OAAO,CAAC;IAI/D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAwCG;IACG,UAAU,CAAC,SAAS,GAAE,MAAM,GAAG,IAAW,GAAG,OAAO,CAAC,YAAY,GAAG,IAAI,CAAC;CAGlF"}
+{"version":3,"file":"o2g-directory.d.ts","sourceRoot":"","sources":["../../../src/services/o2g-directory.ts"],"names":[],"mappings":"AAoBA,OAAO,EAAE,QAAQ,EAAE,MAAM,6BAA6B,CAAC;AACvD,OAAO,EAAE,YAAY,EAAE,MAAM,kCAAkC,CAAC;AAEhE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AACH,qBAAa,SAAS;;IAUlB;;;;;;;;;;;;;OAaG;IACG,MAAM,CAAC,MAAM,EAAE,QAAQ,EAAE,KAAK,GAAE,MAAM,GAAG,IAAW,EAAE,SAAS,GAAE,MAAM,GAAG,IAAW,GAAG,OAAO,CAAC,OAAO,CAAC;IAI9G;;;;;;;;;OASG;IACG,MAAM,CAAC,SAAS,GAAE,MAAM,GAAG,IAAW,GAAG,OAAO,CAAC,OAAO,CAAC;IAI/D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqCG;IACG,UAAU,CAAC,SAAS,GAAE,MAAM,GAAG,IAAW,GAAG,OAAO,CAAC,YAAY,GAAG,IAAI,CAAC;CAGlF"}

package/dist/types/services/o2g-eventSummary.d.ts

@@ -1,10 +1,10 @@
 import { EventEmitter } from 'events';
 import { EventSummaryCounters } from '../types/eventsummary/event-summary-counter';
 /**
- * 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
@@ -25,19 +25,18 @@ import { EventSummaryCounters } from '../types/eventsummary/event-summary-counte
 export declare class EventSummary extends EventEmitter {
     #private;
     /**
-     * Event raised each time the user's counters have changed.
+     * Occurs each time the user's event counters have changed.
      * @event
      */
     static readonly ON_EVENT_SUMMARY_UPDATED = "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?: string | null): Promise<EventSummaryCounters | null>;
 }

package/dist/types/services/o2g-eventSummary.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"o2g-eventSummary.d.ts","sourceRoot":"","sources":["../../../src/services/o2g-eventSummary.ts"],"names":[],"mappings":"AAqBA,OAAO,EAAE,YAAY,EAAE,MAAM,QAAQ,CAAC;AAEtC,OAAO,EAAE,oBAAoB,EAAE,MAAM,6CAA6C,CAAC;AAEnF;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,qBAAa,YAAa,SAAQ,YAAY;;IAG1C;;;OAGG;IACH,MAAM,CAAC,QAAQ,CAAC,wBAAwB,2BAA2B;IAYnE;;;;;;;;;OASG;IACH,GAAG,CAAC,SAAS,GAAE,MAAM,GAAG,IAAW,GAAG,OAAO,CAAC,oBAAoB,GAAG,IAAI,CAAC;CAG7E"}
+{"version":3,"file":"o2g-eventSummary.d.ts","sourceRoot":"","sources":["../../../src/services/o2g-eventSummary.ts"],"names":[],"mappings":"AAqBA,OAAO,EAAE,YAAY,EAAE,MAAM,QAAQ,CAAC;AAEtC,OAAO,EAAE,oBAAoB,EAAE,MAAM,6CAA6C,CAAC;AAEnF;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,qBAAa,YAAa,SAAQ,YAAY;;IAG1C;;;OAGG;IACH,MAAM,CAAC,QAAQ,CAAC,wBAAwB,2BAA2B;IAYnE;;;;;;;;OAQG;IACH,GAAG,CAAC,SAAS,GAAE,MAAM,GAAG,IAAW,GAAG,OAAO,CAAC,oBAAoB,GAAG,IAAI,CAAC;CAG7E"}

package/dist/types/services/o2g-maint.d.ts

@@ -1,12 +1,12 @@
 import EventEmitter from 'events';
 import { SystemStatus } from '../types/maint/sys-status';
 /**
- * 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
@@ -35,12 +35,12 @@ import { SystemStatus } from '../types/maint/sys-status';
 export declare class Maintenance extends EventEmitter {
     #private;
     /**
-     * Occurs when connection to remote twin server is lost.
+     * Occurs when the connection to the remote twin O2G server is lost.
      * @event
      */
     static readonly 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
      */
     static readonly ON_REMOTE_SERVER_LINK_UP = "OnRemoteServerLinkUp";
@@ -55,12 +55,12 @@ export declare class Maintenance extends EventEmitter {
      */
     static readonly 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
      */
     static readonly 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
      */
     static readonly ON_PBX_LINK_UP = "OnPbxLinkUp";
@@ -70,12 +70,12 @@ export declare class Maintenance extends EventEmitter {
      */
     static readonly 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
      */
     static readonly 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
      */
     static readonly ON_SERVER_STARTED = "OnServerStart";
@@ -85,7 +85,7 @@ export declare class Maintenance extends EventEmitter {
      * <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
      */
     getSystemStatus(): Promise<SystemStatus | null>;
 }

package/dist/types/services/o2g-messaging.d.ts

@@ -7,7 +7,8 @@ import { VoiceMessage } from '../types/messaging/voice-message';
  * 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.
  */
 export declare class Messaging {
     #private;
@@ -81,7 +82,7 @@ export declare class Messaging {
      */
     deleteVoiceMessage(mailboxId: string, voicemailId: string, loginName?: string | null): Promise<boolean>;
     /**
-     * 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

package/dist/types/services/o2g-messaging.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"o2g-messaging.d.ts","sourceRoot":"","sources":["../../../src/services/o2g-messaging.ts"],"names":[],"mappings":"AAoBA,OAAO,EAAE,OAAO,EAAE,MAAM,4BAA4B,CAAC;AACrD,OAAO,EAAE,WAAW,EAAE,MAAM,iCAAiC,CAAC;AAC9D,OAAO,EAAE,YAAY,EAAE,MAAM,kCAAkC,CAAC;AAEhE;;;;;;;GAOG;AACH,qBAAa,SAAS;;IAUlB;;;;;;;;;;OAUG;IACG,YAAY,CAAC,SAAS,GAAE,MAAM,GAAG,IAAW,GAAG,OAAO,CAAC,OAAO,EAAE,GAAG,IAAI,CAAC;IAI9E;;;;;;;;;;;;;;;OAeG;IACG,cAAc,CAChB,SAAS,EAAE,MAAM,EACjB,QAAQ,GAAE,MAAM,GAAG,IAAW,EAC9B,SAAS,GAAE,MAAM,GAAG,IAAW,GAChC,OAAO,CAAC,WAAW,GAAG,IAAI,CAAC;IAI9B;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACG,gBAAgB,CAClB,SAAS,EAAE,MAAM,EACjB,OAAO,GAAE,OAAe,EACxB,MAAM,GAAE,MAAM,GAAG,IAAW,EAC5B,KAAK,GAAE,MAAM,GAAG,IAAW,EAC3B,SAAS,GAAE,MAAM,GAAG,IAAW,GAChC,OAAO,CAAC,YAAY,EAAE,GAAG,IAAI,CAAC;IAIjC;;;;;;;;;;;;OAYG;IACG,kBAAkB,CACpB,SAAS,EAAE,MAAM,EACjB,WAAW,EAAE,MAAM,EACnB,SAAS,GAAE,MAAM,GAAG,IAAW,GAChC,OAAO,CAAC,OAAO,CAAC;IAInB;;;;;;;;;;;OAWG;IACG,uBAAuB,CACzB,SAAS,EAAE,MAAM,EACjB,WAAW,EAAE,MAAM,EACnB,SAAS,GAAE,MAAM,GAAG,IAAW,GAChC,OAAO,CAAC,OAAO,CAAC;IAInB;;;;;;;;;;;;OAYG;IACG,mBAAmB,CAAC,SAAS,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,EAAE,SAAS,GAAE,MAAM,GAAG,IAAW,GAAG,OAAO,CAAC,OAAO,CAAC;IAIjH;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACG,oBAAoB,CACtB,SAAS,EAAE,MAAM,EACjB,WAAW,EAAE,MAAM,EACnB,OAAO,EAAE,MAAM,GAAG,IAAI,EACtB,SAAS,GAAE,MAAM,GAAG,IAAW,GAChC,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;CAG5B"}
+{"version":3,"file":"o2g-messaging.d.ts","sourceRoot":"","sources":["../../../src/services/o2g-messaging.ts"],"names":[],"mappings":"AAoBA,OAAO,EAAE,OAAO,EAAE,MAAM,4BAA4B,CAAC;AACrD,OAAO,EAAE,WAAW,EAAE,MAAM,iCAAiC,CAAC;AAC9D,OAAO,EAAE,YAAY,EAAE,MAAM,kCAAkC,CAAC;AAEhE;;;;;;;;GAQG;AACH,qBAAa,SAAS;;IAUlB;;;;;;;;;;OAUG;IACG,YAAY,CAAC,SAAS,GAAE,MAAM,GAAG,IAAW,GAAG,OAAO,CAAC,OAAO,EAAE,GAAG,IAAI,CAAC;IAI9E;;;;;;;;;;;;;;;OAeG;IACG,cAAc,CAChB,SAAS,EAAE,MAAM,EACjB,QAAQ,GAAE,MAAM,GAAG,IAAW,EAC9B,SAAS,GAAE,MAAM,GAAG,IAAW,GAChC,OAAO,CAAC,WAAW,GAAG,IAAI,CAAC;IAI9B;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACG,gBAAgB,CAClB,SAAS,EAAE,MAAM,EACjB,OAAO,GAAE,OAAe,EACxB,MAAM,GAAE,MAAM,GAAG,IAAW,EAC5B,KAAK,GAAE,MAAM,GAAG,IAAW,EAC3B,SAAS,GAAE,MAAM,GAAG,IAAW,GAChC,OAAO,CAAC,YAAY,EAAE,GAAG,IAAI,CAAC;IAIjC;;;;;;;;;;;;OAYG;IACG,kBAAkB,CACpB,SAAS,EAAE,MAAM,EACjB,WAAW,EAAE,MAAM,EACnB,SAAS,GAAE,MAAM,GAAG,IAAW,GAChC,OAAO,CAAC,OAAO,CAAC;IAInB;;;;;;;;;;;OAWG;IACG,uBAAuB,CACzB,SAAS,EAAE,MAAM,EACjB,WAAW,EAAE,MAAM,EACnB,SAAS,GAAE,MAAM,GAAG,IAAW,GAChC,OAAO,CAAC,OAAO,CAAC;IAInB;;;;;;;;;;;;OAYG;IACG,mBAAmB,CAAC,SAAS,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,EAAE,SAAS,GAAE,MAAM,GAAG,IAAW,GAAG,OAAO,CAAC,OAAO,CAAC;IAIjH;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACG,oBAAoB,CACtB,SAAS,EAAE,MAAM,EACjB,WAAW,EAAE,MAAM,EACnB,OAAO,EAAE,MAAM,GAAG,IAAI,EACtB,SAAS,GAAE,MAAM,GAAG,IAAW,GAChC,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;CAG5B"}