o2g-node-sdk 2.4.0 → 2.5.0

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

@@ -0,0 +1,245 @@
+import EventEmitter from 'events';
+import { Page } from './types/comlog/page';
+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
+ * <b>TELEPHONY_ADVANCED</b> license.
+ *
+ * @example
+ * ```typescript
+ * // Query the last 10 unanswered records
+ * const filter = new QueryFilter();
+ * filter.setUnacknowledged(true);
+ *
+ * const page = new Page(0, 10);
+ *
+ * const result = await O2G.comlog.getComRecords(filter, page, true);
+ * if (result) {
+ *     console.log(`Total records: ${result.totalCount}`);
+ *
+ *     // Acknowledge all retrieved records
+ *     const ids = result.records.map(r => r.recordId);
+ *     await O2G.comlog.acknowledgeComRecords(ids);
+ *
+ *     // Delete records matching the filter
+ *     await O2G.comlog.deleteComRecords(filter);
+ * }
+ * ```
+ */
+export declare class CommunicationLog extends EventEmitter {
+    #private;
+    /**
+     * Occurs when a new comlog entry has been created.
+     * @event
+     */
+    static readonly ON_COM_RECORD_CREATED = "OnComRecordCreated";
+    /**
+     * Occurs when one or more records have been modified.
+     * @event
+     */
+    static readonly ON_COM_RECORD_MODIFIED = "OnComRecordModified";
+    /**
+     * Occurs when one or more call log records have been deleted.
+     * @see deleteComRecords
+     * @see deleteComRecord
+     * @see deleteComRecordsById
+     * @event
+     */
+    static readonly ON_COM_RECORDS_DELETED = "OnComRecordsDeleted";
+    /**
+     * Occurs when one or more unanswered comlog records have been acknowledged.
+     * @see acknowledgeComRecords
+     * @see acknowledgeComRecord
+     * @event
+     */
+    static readonly ON_COM_RECORDS_ACK = "OnComRecordsAck";
+    /**
+     * Occurs when one or more unanswered comlog records have been unacknowledged.
+     * @see unacknowledgeComRecords
+     * @see unacknowledgeComRecord
+     * @event
+     */
+    static readonly ON_COM_RECORDS_UNACK = "OnComRecordsUnAck";
+    /**
+     * Gets the com records corresponding to the specified filter, using the
+     * specified page, with a possible 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.
+     * <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.
+     * <p>
+     * If the session has been opened for a user, the `loginName` parameter is
+     * ignored, but it is mandatory if the session has been opened by an
+     * administrator.
+     *
+     * @example
+     * ```typescript
+     * // Get all records with no filter, no pagination
+     * const all = await O2G.comlog.getComRecords();
+     *
+     * // Get only missed calls, first page of 20, with optimization
+     * const filter = new QueryFilter();
+     * filter.setCallType(FilterOption.MISSED);
+     * const page = new Page(0, 20);
+     * const missed = await O2G.comlog.getComRecords(filter, page, true);
+     *
+     * // Administrator querying records for a specific user
+     * const userRecords = await O2G.comlog.getComRecords(null, null, false, "jdoe");
+     * ```
+     *
+     * @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
+     * @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.
+     * <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
+     * @returns the {@link ComRecord} on success; `null` otherwise.
+     */
+    getComRecord(recordId: string, loginName?: string | null): Promise<ComRecord | null>;
+    /**
+     * Deletes the specified com record.
+     * <p>
+     * If the session has been opened for a user, the `loginName` parameter is
+     * ignored, but it is mandatory if the session has been opened by an
+     * administrator.
+     *
+     * @param recordId  the com record identifier
+     * @param loginName the user login name
+     * @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.
+     * <p>
+     * An {@link ON_COM_RECORDS_DELETED} event is raised containing the list of
+     * com records that have been deleted.
+     * <p>
+     * If the session has been opened for a user, the `loginName` parameter is
+     * ignored, but it is mandatory if the session has been opened by an
+     * administrator.
+     *
+     * @param recordIds the list of com record identifiers to delete
+     * @param loginName the user 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.
+     * <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.
+     * <p>
+     * If the session has been opened for a user, the `loginName` parameter is
+     * ignored, but it is mandatory if the session has been opened by an
+     * administrator.
+     *
+     * @example
+     * ```typescript
+     * // Delete all acknowledged records
+     * const filter = new QueryFilter();
+     * filter.setAcknowledged(true);
+     * await O2G.comlog.deleteComRecords(filter);
+     *
+     * // Delete all records (no filter)
+     * await O2G.comlog.deleteComRecords();
+     *
+     * // Note: to delete specific records by id, use deleteComRecordsById instead
+     * await O2G.comlog.deleteComRecordsById(["id1", "id2", "id3"]);
+     * ```
+     *
+     * @param filter    the filter describing the query criteria
+     * @param loginName the user 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.
+     * <p>
+     * An {@link ON_COM_RECORDS_ACK} event is raised containing the list of
+     * com records that have been acknowledged.
+     * <p>
+     * If the session has been opened for a user, the `loginName` parameter is
+     * ignored, but it is mandatory if the session has been opened by an
+     * administrator.
+     *
+     * @param recordIds the list of com record identifiers to acknowledge
+     * @param loginName the user 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.
+     * <p>
+     * An {@link ON_COM_RECORDS_ACK} event is raised containing the list of
+     * com records that have been acknowledged.
+     * <p>
+     * If the session has been opened for a user, the `loginName` parameter is
+     * ignored, but it is mandatory if the session has been opened by an
+     * administrator.
+     *
+     * @param recordId  the com record identifier
+     * @param loginName the user login name
+     * @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.
+     * <p>
+     * An {@link ON_COM_RECORDS_UNACK} event is raised containing the list of
+     * 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.
+     *
+     * @param recordIds the list of com record identifiers to unacknowledge
+     * @param loginName the user 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.
+     * <p>
+     * An {@link ON_COM_RECORDS_UNACK} event is raised containing the list of
+     * 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.
+     *
+     * @param recordId  the com record identifier
+     * @param loginName the user login name
+     * @returns `true` if the operation succeeded; `false` otherwise.
+     * @see unacknowledgeComRecords
+     */
+    unacknowledgeComRecord(recordId: string, loginName?: string | null): Promise<boolean>;
+}
+//# sourceMappingURL=o2g-comlog.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"o2g-comlog.d.ts","sourceRoot":"","sources":["../../src/o2g-comlog.ts"],"names":[],"mappings":"AAmBA,OAAO,YAAY,MAAM,QAAQ,CAAC;AAElC,OAAO,EAAE,IAAI,EAAE,MAAM,qBAAqB,CAAC;AAC3C,OAAO,EAAE,WAAW,EAAE,MAAM,6BAA6B,CAAC;AAC1D,OAAO,EAAE,WAAW,EAAE,MAAM,6BAA6B,CAAC;AAS1D,OAAO,EAAE,SAAS,EAAE,MAAM,2BAA2B,CAAC;AAEtD;;;;;;;;;;;;;;;;;;;;;;;;;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"}

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

@@ -0,0 +1,109 @@
+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.
+ * <p>
+ * A directory search is a set of 2 or more sequential operations:
+ * <ol>
+ * <li>The first operation initiates the search with a set of criteria.</li>
+ * <li>The second and subsequent operations retrieve results.</li>
+ * </ol>
+ * <p>
+ * Note: For each session (user or administrator), only 5 concurrent searches
+ * are authorized. An unused search context is freed after 1 minute.
+ *
+ * @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
+ *      }
+ *   }
+ * ```
+ */
+export declare class Directory {
+    #private;
+    /**
+     * Initiates a directory search with the specified filter, limited to the
+     * specified number of results.
+     * <p>
+     * If the session has been opened for a user, the `loginName` parameter is
+     * ignored, but it is mandatory if the session has been opened by an
+     * administrator.
+     *
+     * @param filter    the search filter
+     * @param limit     maximum number of results, in the range [1..100]
+     * @param loginName the user login name
+     * @returns `true` if the search was successfully initiated; `false` otherwise.
+     * @see getResults
+     * @see cancel
+     */
+    search(filter: Criteria, limit?: number | null, loginName?: string | null): Promise<boolean>;
+    /**
+     * 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.
+     *
+     * @param loginName the user login name
+     * @returns `true` if the operation succeeded; `false` otherwise.
+     * @see search
+     */
+    cancel(loginName?: string | null): Promise<boolean>;
+    /**
+     * Gets 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>
+     * <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.
+     *
+     * @example
+     * ```typescript
+     * await O2G.directory.search(criteria);
+     *
+     * 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;
+     *     }
+     * }
+     * ```
+     *
+     * @param loginName the user login name
+     * @returns the {@link SearchResult} on success; `null` otherwise.
+     * @see search
+     */
+    getResults(loginName?: string | null): Promise<SearchResult | null>;
+}
+//# sourceMappingURL=o2g-directory.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"o2g-directory.d.ts","sourceRoot":"","sources":["../../src/o2g-directory.ts"],"names":[],"mappings":"AAoBA,OAAO,EAAE,QAAQ,EAAE,MAAM,4BAA4B,CAAC;AACtD,OAAO,EAAE,YAAY,EAAE,MAAM,iCAAiC,CAAC;AAE/D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;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"}

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

@@ -0,0 +1,44 @@
+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).
+ * <p>
+ * Using this service requires having a <b>TELEPHONY_ADVANCED</b> license.
+ *
+ * @example
+ * ```typescript
+ * // Listen for counter updates and refresh on each change
+ * O2G.eventSummary.on(EventSummary.ON_EVENT_SUMMARY_UPDATED, async () => {
+ *     const counters = await O2G.eventSummary.get();
+ *     if (counters) {
+ *         console.log(`Missed calls: ${counters.missedCalls}`);
+ *         console.log(`Voice mails: ${counters.voiceMails}`);
+ *         console.log(`Callbacks: ${counters.callbacks}`);
+ *     }
+ * });
+ *
+ * // Or fetch counters on demand without waiting for an event
+ * const counters = await O2G.eventSummary.get();
+ * ```
+ */
+export declare class EventSummary extends EventEmitter {
+    #private;
+    /**
+     * Event raised each time the user's counters have changed.
+     * @event
+     */
+    static readonly ON_EVENT_SUMMARY_UPDATED = "OnEventSummaryUpdated";
+    /**
+     * Retrieves main 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.
+     *
+     * @param loginName the user login name
+     * @returns the {@link EventSummaryCounters} on success; `null` otherwise.
+     */
+    get(loginName?: string | null): Promise<EventSummaryCounters | null>;
+}
+//# sourceMappingURL=o2g-eventSummary.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"o2g-eventSummary.d.ts","sourceRoot":"","sources":["../../src/o2g-eventSummary.ts"],"names":[],"mappings":"AAqBA,OAAO,EAAE,YAAY,EAAE,MAAM,QAAQ,CAAC;AAEtC,OAAO,EAAE,oBAAoB,EAAE,MAAM,4CAA4C,CAAC;AAElF;;;;;;;;;;;;;;;;;;;;;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"}

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

@@ -0,0 +1,92 @@
+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.
+ * 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.
+ *
+ * @example
+ * ```typescript
+ * // Monitor system readiness and connection state
+ * O2G.maintenance.on(Maintenance.ON_SERVER_STARTED, async () => {
+ *     console.log("O2G server is ready");
+ *     const status = await O2G.maintenance.getSystemStatus();
+ *     if (status) {
+ *         console.log(`Connected PBXs: ${status.pbxs.length}`);
+ *     }
+ * });
+ *
+ * O2G.maintenance.on(Maintenance.ON_PBX_LINK_DOWN, (event) => {
+ *     console.warn(`PBX link down: node ${event.nodeId}`);
+ * });
+ *
+ * O2G.maintenance.on(Maintenance.ON_PBX_LINK_UP, (event) => {
+ *     console.log(`PBX link restored: node ${event.nodeId}`);
+ * });
+ *
+ * O2G.maintenance.on(Maintenance.ON_LICENSE_EXPIRATION, (event) => {
+ *     console.warn(`License expiring soon: ${event.licenseType}`);
+ * });
+ * ```
+ */
+export declare class Maintenance extends EventEmitter {
+    #private;
+    /**
+     * Occurs when connection to remote twin server is lost.
+     * @event
+     */
+    static readonly ON_REMOTE_SERVER_LINK_DOWN = "OnRemoteServerLinkDown";
+    /**
+     * Occurs when connection to remote twin server is recovered.
+     * @event
+     */
+    static readonly ON_REMOTE_SERVER_LINK_UP = "OnRemoteServerLinkUp";
+    /**
+     * Occurs when a CTI link is down.
+     * @event
+     */
+    static readonly ON_CTI_LINK_DOWN = "OnCtiLinkDown";
+    /**
+     * Occurs when a CTI link is up.
+     * @event
+     */
+    static readonly ON_CTI_LINK_UP = "OnCtiLinkUp";
+    /**
+     * Occurs when a PBX link is down.
+     * @event
+     */
+    static readonly ON_PBX_LINK_DOWN = "OnPbxLinkDown";
+    /**
+     * Occurs when a PBX link is up.
+     * @event
+     */
+    static readonly ON_PBX_LINK_UP = "OnPbxLinkUp";
+    /**
+     * Occurs when data is fully loaded from an OmniPCX Enterprise node.
+     * @event
+     */
+    static readonly ON_PBX_LOADED = "OnPbxLoaded";
+    /**
+     * Occurs when the license file will soon expire or has recently expired.
+     * @event
+     */
+    static readonly ON_LICENSE_EXPIRATION = "OnLicenseExpiration";
+    /**
+     * Occurs when O2G is ready (all OXE nodes are connected and loaded).
+     * @event
+     */
+    static readonly ON_SERVER_STARTED = "OnServerStart";
+    /**
+     * Retrieves information about the system state and the total number of each
+     * license type available for the system.
+     * <p>
+     * This operation is restricted to an administrator session only.
+     *
+     * @returns the {@link SystemStatus} on success; `null` otherwise.
+     */
+    getSystemStatus(): Promise<SystemStatus | null>;
+}
+//# sourceMappingURL=o2g-maint.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"o2g-maint.d.ts","sourceRoot":"","sources":["../../src/o2g-maint.ts"],"names":[],"mappings":"AAmBA,OAAO,YAAY,MAAM,QAAQ,CAAC;AAclC,OAAO,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAC;AAExD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACH,qBAAa,WAAY,SAAQ,YAAY;;IAGzC;;;OAGG;IACH,MAAM,CAAC,QAAQ,CAAC,0BAA0B,4BAA4B;IAEtE;;;OAGG;IACH,MAAM,CAAC,QAAQ,CAAC,wBAAwB,0BAA0B;IAElE;;;OAGG;IACH,MAAM,CAAC,QAAQ,CAAC,gBAAgB,mBAAmB;IAEnD;;;OAGG;IACH,MAAM,CAAC,QAAQ,CAAC,cAAc,iBAAiB;IAE/C;;;OAGG;IACH,MAAM,CAAC,QAAQ,CAAC,gBAAgB,mBAAmB;IAEnD;;;OAGG;IACH,MAAM,CAAC,QAAQ,CAAC,cAAc,iBAAiB;IAE/C;;;OAGG;IACH,MAAM,CAAC,QAAQ,CAAC,aAAa,iBAAiB;IAE9C;;;OAGG;IACH,MAAM,CAAC,QAAQ,CAAC,qBAAqB,yBAAyB;IAE9D;;;OAGG;IACH,MAAM,CAAC,QAAQ,CAAC,iBAAiB,mBAAmB;IAqBpD;;;;;;;OAOG;IACG,eAAe,IAAI,OAAO,CAAC,YAAY,GAAG,IAAI,CAAC;CAGxD"}

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

@@ -0,0 +1,137 @@
+import { MailBox } from './types/messaging/mailbox';
+import { MailBoxInfo } from './types/messaging/mailbox-info';
+import { VoiceMessage } from './types/messaging/voice-message';
+/**
+ * Messaging service provides access to the user's voice mail box.
+ * It is possible using this service to connect to the voice mail box, retrieve
+ * 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.
+ */
+export declare class Messaging {
+    #private;
+    /**
+     * Gets the specified user's mailboxes. This is the logical first step to
+     * access further operations on the voice mail feature.
+     * <p>
+     * If the session has been opened for a user, the `loginName` parameter is
+     * ignored, but it is mandatory if the session has been opened by an
+     * administrator.
+     *
+     * @param loginName the user login name
+     * @returns the list of {@link MailBox} objects on success; `null` otherwise.
+     */
+    getMailboxes(loginName?: string | null): Promise<MailBox[] | null>;
+    /**
+     * Gets the information on the specified mail box.
+     * <p>
+     * The `password` is optional. If not set, the user password is used to
+     * connect to the voicemail. This is only possible if the OmniPCX Enterprise
+     * administrator has configured the same password for the user and their mailbox.
+     * <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 mailBoxId the mail box identifier given in a {@link MailBox} object
+     * @param password  the mail box password
+     * @param loginName the user login name
+     * @returns the {@link MailBoxInfo} on success; `null` otherwise.
+     */
+    getMailboxInfo(mailBoxId: string, password?: string | null, loginName?: string | null): Promise<MailBoxInfo | null>;
+    /**
+     * Gets the list of voice messages in the specified mail box.
+     * <p>
+     * If the session has been opened for a user, the `loginName` parameter is
+     * ignored, but it is mandatory if the session has been opened by an
+     * administrator.
+     * @example
+     * ```typescript
+     * // Get all voice messages in the mailbox
+     * const messages = await O2G.messaging.getVoiceMessages("mbx001");
+     *
+     * // Get only unread messages
+     * const newMessages = await O2G.messaging.getVoiceMessages("mbx001", true);
+     *
+     * // Get a page of 10 messages starting from the 20th
+     * const page = await O2G.messaging.getVoiceMessages("mbx001", false, 20, 10);
+     * ```
+     *
+     * @param mailboxId the mail box identifier given in a {@link MailBox} object
+     * @param newOnly   if `true`, returns only unread voice messages
+     * @param offset    the offset from which to start retrieving the voice message list
+     * @param limit     the maximum number of items to return
+     * @param loginName the user login name
+     * @returns the list of {@link VoiceMessage} objects on success; `null` otherwise.
+     */
+    getVoiceMessages(mailboxId: string, newOnly?: boolean, offset?: number | null, limit?: number | null, loginName?: string | null): Promise<VoiceMessage[] | null>;
+    /**
+     * Deletes the specified voice message.
+     * <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 mailboxId   the mail box identifier given in a {@link MailBox} object
+     * @param voicemailId the voice mail identifier given in a {@link VoiceMessage} object
+     * @param loginName   the user login name
+     * @returns `true` if the operation succeeded; `false` otherwise.
+     * @see deleteVoiceMessages
+     */
+    deleteVoiceMessage(mailboxId: string, voicemailId: string, loginName?: string | null): Promise<boolean>;
+    /**
+     * Acknowledges the specified voice message.
+     * <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 mailboxId   the mail box identifier given in a {@link MailBox} object
+     * @param voicemailId the voice mail identifier given in a {@link VoiceMessage} object
+     * @param loginName   the user login name
+     * @returns `true` if the operation succeeded; `false` otherwise.
+     */
+    acknowledgeVoiceMessage(mailboxId: string, voicemailId: string, loginName?: string | null): Promise<boolean>;
+    /**
+     * Deletes the specified list of voice 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 mailboxId the mail box identifier given in a {@link MailBox} object
+     * @param msgIds    the list of voice mail identifiers to delete
+     * @param loginName the user login name
+     * @returns `true` if the operation succeeded; `false` otherwise.
+     * @see deleteVoiceMessage
+     */
+    deleteVoiceMessages(mailboxId: string, msgIds: string[], loginName?: string | null): Promise<boolean>;
+    /**
+     * Downloads a voice mail as a wav file.
+     * <p>
+     * If the session has been opened for a user, the `loginName` parameter is
+     * ignored, but it is mandatory if the session has been opened by an
+     * administrator.
+     *
+     * @example
+     * ```typescript
+     * // Download to a specific path
+     * const path = await O2G.messaging.downloadVoiceMessage("mbx001", "msg42", "/tmp/voicemail.wav");
+     *
+     * // Let the SDK choose the destination path
+     * const autoPath = await O2G.messaging.downloadVoiceMessage("mbx001", "msg42", null);
+     * if (autoPath) {
+     *     console.log(`Downloaded to: ${autoPath}`);
+     * }
+     * ```
+     *
+     * @param mailboxId   the mail box identifier given in a {@link MailBox} object
+     * @param voicemailId the voice mail identifier given in a {@link VoiceMessage} object
+     * @param wavPath     an optional destination file path for the downloaded wav file
+     * @param loginName   the user login name
+     * @returns the path to the downloaded wav file on success; `null` otherwise.
+     */
+    downloadVoiceMessage(mailboxId: string, voicemailId: string, wavPath: string | null, loginName?: string | null): Promise<string | null>;
+}
+//# sourceMappingURL=o2g-messaging.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"o2g-messaging.d.ts","sourceRoot":"","sources":["../../src/o2g-messaging.ts"],"names":[],"mappings":"AAoBA,OAAO,EAAE,OAAO,EAAE,MAAM,2BAA2B,CAAC;AACpD,OAAO,EAAE,WAAW,EAAE,MAAM,gCAAgC,CAAC;AAC7D,OAAO,EAAE,YAAY,EAAE,MAAM,iCAAiC,CAAC;AAE/D;;;;;;;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"}