o2g-node-sdk 1.0.1 → 2.4.1

package/dist/types/types/directory/search-result.d.ts

@@ -0,0 +1,64 @@
+import { ResultItem } from './result-item';
+/**
+ * Represents the outcome of a directory search performed via the `DirectoryService`.
+ *
+ * A search may return multiple batches of results. Each batch contains a set of
+ * contacts along with a status code indicating the current state of the search.
+ *
+ * ## Example usage
+ * ```ts
+ * const searchResult = SearchResult.fromJson(jsonData);
+ * console.log(searchResult.resultCode);
+ * console.log(searchResult.resultElements);
+ * ```
+ */
+export declare class SearchResult {
+    #private;
+    private constructor();
+    /**
+     * Returns the status code of this search result.
+     *
+     * The status code indicates whether more results are available or if the
+     * search is complete.
+     *
+     * @returns The `SearchStatus` of this search result, or `null` if unavailable.
+     */
+    get status(): SearchResult.Status | null;
+    /**
+     * Returns the list of result items from the search.
+     *
+     * Each element in the array corresponds to a `ResultItem`, which contains
+     * contact information returned by the search.
+     *
+     * @returns An array of `ResultItem` objects, or `null` if no results are present.
+     */
+    get items(): ResultItem[] | null;
+}
+export declare namespace SearchResult {
+    /**
+     * Code represents the status of a directory search. Each time a call to
+     * {@link Directory.getResults} is done, the returned result code must be
+     * tested.
+     */
+    enum Status {
+        /**
+         * Responses are provided this time. Continue to invoking
+         * {@linkplain Directory.getResults} periodically to get the next results.
+         */
+        OK = "OK",
+        /**
+         * No response received. Continue to invoking
+         * {@link Directory.getResults} to get more results.
+         */
+        NOK = "NOK",
+        /**
+         * Search is finished.
+         */
+        FINISH = "FINISH",
+        /**
+         * Search is ended for timeout reason.
+         */
+        TIMEOUT = "TIMEOUT"
+    }
+}
+//# sourceMappingURL=search-result.d.ts.map

package/dist/types/types/directory/search-result.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"search-result.d.ts","sourceRoot":"","sources":["../../../../src/types/directory/search-result.ts"],"names":[],"mappings":"AAoBA,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAE3C;;;;;;;;;;;;GAYG;AACH,qBAAa,YAAY;;IAIrB,OAAO;IAKP;;;;;;;OAOG;IACH,IAAI,MAAM,IAAI,YAAY,CAAC,MAAM,GAAG,IAAI,CAEvC;IAED;;;;;;;OAOG;IACH,IAAI,KAAK,IAAI,UAAU,EAAE,GAAG,IAAI,CAE/B;CAcJ;AAED,yBAAiB,YAAY,CAAC;IAC1B;;;;OAIG;IACH,KAAY,MAAM;QACd;;;WAGG;QACH,EAAE,OAAO;QAET;;;WAGG;QACH,GAAG,QAAQ;QAEX;;WAEG;QACH,MAAM,WAAW;QAEjB;;WAEG;QACH,OAAO,YAAY;KACtB;CACJ"}

package/dist/types/{events → types/events}/events.d.ts

@@ -1,17 +1,31 @@
-import { O2GEvent } from "./o2g-event";
-import { OnAgentSkillChanged, OnAgentStateChanged, OnSupervisorHelpCancelled, OnSupervisorHelpRequested } from "../cc-agent/cc-agent-events";
-import { OnPilotCallCreated, OnPilotCallQueued, OnPilotCallRemoved } from "../cc-pilot/cc-pilot-events";
-import { OnComRecordCreated, OnComRecordModified, OnComRecordsAck, OnComRecordsDeleted, OnComRecordsUnAck } from "../comlog/comlog-events";
-import { OnEventSummaryUpdated } from "../eventsummary/event-summary-events";
-import { OnCtiLinkUp, OnCtiLinkDown, OnLicenseExpiration, OnPbxLoaded, OnServerStart } from "../maint/maint-events";
-import { OnPbxObjectInstanceCreated, OnPbxObjectInstanceDeleted, OnPbxObjectInstanceModified } from "../pbxmngt/pbxmngt-events";
-import { OnRoutingStateChanged } from "../routing/routing-events";
-import { OnToneGeneratedStart, OnToneGeneratedStop, OnDigitCollected, OnRouteRequest, OnRouteEnd } from "../rsi/rsi-events";
-import { OnCallCreated, OnCallModified, OnCallRemoved, OnDeviceStateModified, OnDynamicStateChanged, OnTelephonyState, OnUserStateModified } from "../telephony/telephony-events";
-import { OnUserCreated, OnUserInfoChanged, OnUserDeleted } from "../users/users-events";
-export type OnChannelInformation = O2GEvent<'OnChannelInformation', {
-    text: string;
-}>;
+import { OnAcdStatsProgress } from '../../internal/types/cc-stat/on-stats-progress';
+import { OnAgentSkillChanged, OnAgentStateChanged, OnSupervisorHelpCancelled, OnSupervisorHelpRequested } from '../cc-agent/cc-agent-events';
+import { OnPilotCallCreated, OnPilotCallQueued, OnPilotCallRemoved } from '../cc-pilot/cc-pilot-events';
+import { OnAgentProcessingGroupRtiChanged, OnAgentRtiChanged, OnOtherProcessingGroupRtiChanged, OnPilotRtiChanged, OnQueueRtiChanged } from '../cc-rt/cc-rt-events';
+import { OnComRecordCreated, OnComRecordModified, OnComRecordsAck, OnComRecordsDeleted, OnComRecordsUnAck } from '../comlog/comlog-events';
+import { OnEventSummaryUpdated } from '../eventsummary/event-summary-events';
+import { OnCtiLinkUp, OnCtiLinkDown, OnLicenseExpiration, OnPbxLoaded, OnServerStart, OnPbxLinkDown, OnPbxLinkUp } from '../maint/maint-events';
+import { OnPbxObjectInstanceCreated, OnPbxObjectInstanceDeleted, OnPbxObjectInstanceModified } from '../pbxmngt/pbxmngt-events';
+import { OnRoutingStateChanged } from '../routing/routing-events';
+import { OnToneGeneratedStart, OnToneGeneratedStop, OnDigitCollected, OnRouteRequest, OnRouteEnd } from '../rsi/rsi-events';
+import { OnCallCreated, OnCallModified, OnCallRemoved, OnDeviceStateModified, OnDynamicStateChanged, OnTelephonyState, OnUserStateModified } from '../telephony/telephony-events';
+import { OnUserCreated, OnUserInfoChanged, OnUserDeleted } from '../users/users-events';
+/**
+ * Event emitted when an event occurs related to the event channel.
+ *
+ * This event provides textual information about the channel activity,
+ * which can be used for logging, monitoring, or triggering business logic.
+ */
+export declare class OnChannelInformation {
+    #private;
+    private constructor();
+    /**
+     * Gets the textual information for this channel event.
+     *
+     * @returns The channel information as a string.
+     */
+    get text(): string;
+}
 export interface EventMap {
     OnChannelInformation: OnChannelInformation;
     OnEventSummaryUpdated: OnEventSummaryUpdated;
@@ -31,6 +45,8 @@ export interface EventMap {
     OnComRecordsDeleted: OnComRecordsDeleted;
     OnComRecordsAck: OnComRecordsAck;
     OnComRecordsUnAck: OnComRecordsUnAck;
+    OnPbxLinkUp: OnPbxLinkUp;
+    OnPbxLinkDown: OnPbxLinkDown;
     OnCtiLinkUp: OnCtiLinkUp;
     OnCtiLinkDown: OnCtiLinkDown;
     OnLicenseExpiration: OnLicenseExpiration;
@@ -46,9 +62,16 @@ export interface EventMap {
     OnPilotCallCreated: OnPilotCallCreated;
     OnPilotCallQueued: OnPilotCallQueued;
     OnPilotCallRemoved: OnPilotCallRemoved;
+    OnAgentRtiChanged: OnAgentRtiChanged;
+    OnPGAgentRtiChanged: OnAgentProcessingGroupRtiChanged;
+    OnPGOtherRtiChanged: OnOtherProcessingGroupRtiChanged;
+    OnPilotRtiChanged: OnPilotRtiChanged;
+    OnQueueRtiChanged: OnQueueRtiChanged;
+    OnAcdStatsProgress: OnAcdStatsProgress;
     OnToneGeneratedStart: OnToneGeneratedStart;
     OnToneGeneratedStop: OnToneGeneratedStop;
     OnDigitCollected: OnDigitCollected;
     OnRouteRequest: OnRouteRequest;
     OnRouteEnd: OnRouteEnd;
 }
+//# sourceMappingURL=events.d.ts.map

package/dist/types/types/events/events.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"events.d.ts","sourceRoot":"","sources":["../../../../src/types/events/events.ts"],"names":[],"mappings":"AAmBA,OAAO,EAAE,kBAAkB,EAAE,MAAM,gDAAgD,CAAC;AACpF,OAAO,EACH,mBAAmB,EACnB,mBAAmB,EACnB,yBAAyB,EACzB,yBAAyB,EAC5B,MAAM,6BAA6B,CAAC;AACrC,OAAO,EAAE,kBAAkB,EAAE,iBAAiB,EAAE,kBAAkB,EAAE,MAAM,6BAA6B,CAAC;AACxG,OAAO,EACH,gCAAgC,EAChC,iBAAiB,EACjB,gCAAgC,EAChC,iBAAiB,EACjB,iBAAiB,EACpB,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EACH,kBAAkB,EAClB,mBAAmB,EACnB,eAAe,EACf,mBAAmB,EACnB,iBAAiB,EACpB,MAAM,yBAAyB,CAAC;AACjC,OAAO,EAAE,qBAAqB,EAAE,MAAM,sCAAsC,CAAC;AAC7E,OAAO,EACH,WAAW,EACX,aAAa,EACb,mBAAmB,EACnB,WAAW,EACX,aAAa,EACb,aAAa,EACb,WAAW,EACd,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EACH,0BAA0B,EAC1B,0BAA0B,EAC1B,2BAA2B,EAC9B,MAAM,2BAA2B,CAAC;AACnC,OAAO,EAAE,qBAAqB,EAAE,MAAM,2BAA2B,CAAC;AAClE,OAAO,EACH,oBAAoB,EACpB,mBAAmB,EACnB,gBAAgB,EAChB,cAAc,EACd,UAAU,EACb,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EACH,aAAa,EACb,cAAc,EACd,aAAa,EACb,qBAAqB,EACrB,qBAAqB,EACrB,gBAAgB,EAChB,mBAAmB,EACtB,MAAM,+BAA+B,CAAC;AACvC,OAAO,EAAE,aAAa,EAAE,iBAAiB,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAC;AAExF;;;;;GAKG;AACH,qBAAa,oBAAoB;;IAG7B,OAAO;IAgBP;;;;OAIG;IACH,IAAI,IAAI,IAAI,MAAM,CAEjB;CACJ;AAED,MAAM,WAAW,QAAQ;IACrB,oBAAoB,EAAE,oBAAoB,CAAC;IAG3C,qBAAqB,EAAE,qBAAqB,CAAC;IAG7C,aAAa,EAAE,aAAa,CAAC;IAC7B,iBAAiB,EAAE,iBAAiB,CAAC;IACrC,aAAa,EAAE,aAAa,CAAC;IAG7B,aAAa,EAAE,aAAa,CAAC;IAC7B,cAAc,EAAE,cAAc,CAAC;IAC/B,aAAa,EAAE,aAAa,CAAC;IAC7B,qBAAqB,EAAE,qBAAqB,CAAC;IAC7C,qBAAqB,EAAE,qBAAqB,CAAC;IAC7C,gBAAgB,EAAE,gBAAgB,CAAC;IACnC,mBAAmB,EAAE,mBAAmB,CAAC;IAGzC,qBAAqB,EAAE,qBAAqB,CAAC;IAG7C,kBAAkB,EAAE,kBAAkB,CAAC;IACvC,mBAAmB,EAAE,mBAAmB,CAAC;IACzC,mBAAmB,EAAE,mBAAmB,CAAC;IACzC,eAAe,EAAE,eAAe,CAAC;IACjC,iBAAiB,EAAE,iBAAiB,CAAC;IAGrC,WAAW,EAAE,WAAW,CAAC;IACzB,aAAa,EAAE,aAAa,CAAC;IAC7B,WAAW,EAAE,WAAW,CAAC;IACzB,aAAa,EAAE,aAAa,CAAC;IAC7B,mBAAmB,EAAE,mBAAmB,CAAC;IACzC,WAAW,EAAE,WAAW,CAAC;IACzB,aAAa,EAAE,aAAa,CAAC;IAG7B,0BAA0B,EAAE,0BAA0B,CAAC;IACvD,0BAA0B,EAAE,0BAA0B,CAAC;IACvD,2BAA2B,EAAE,2BAA2B,CAAC;IAGzD,mBAAmB,EAAE,mBAAmB,CAAC;IACzC,mBAAmB,EAAE,mBAAmB,CAAC;IACzC,yBAAyB,EAAE,yBAAyB,CAAC;IACrD,yBAAyB,EAAE,yBAAyB,CAAC;IAGrD,kBAAkB,EAAE,kBAAkB,CAAC;IACvC,iBAAiB,EAAE,iBAAiB,CAAC;IACrC,kBAAkB,EAAE,kBAAkB,CAAC;IAGvC,iBAAiB,EAAE,iBAAiB,CAAC;IACrC,mBAAmB,EAAE,gCAAgC,CAAC;IACtD,mBAAmB,EAAE,gCAAgC,CAAC;IACtD,iBAAiB,EAAE,iBAAiB,CAAC;IACrC,iBAAiB,EAAE,iBAAiB,CAAC;IAGrC,kBAAkB,EAAE,kBAAkB,CAAC;IAGvC,oBAAoB,EAAE,oBAAoB,CAAC;IAC3C,mBAAmB,EAAE,mBAAmB,CAAC;IACzC,gBAAgB,EAAE,gBAAgB,CAAC;IACnC,cAAc,EAAE,cAAc,CAAC;IAC/B,UAAU,EAAE,UAAU,CAAC;CAC1B"}

package/dist/types/types/eventsummary/event-summary-counter.d.ts

@@ -0,0 +1,69 @@
+/**
+ * EventSummaryCounters represents event counters associated with a user.
+ * It provides access to counts of missed calls, voice messages, callback requests,
+ * faxes, new and old text messages, and indicates whether an event is waiting.
+ */
+export declare class EventSummaryCounters {
+    #private;
+    private constructor();
+    /**
+     * Get the number of missed calls.
+     *
+     * <p>If this attribute is not specified, the server is unable to provide that information.
+     * <b>Note:</b> This counter reflects unanswered and non-acknowledged incoming calls in the history.
+     * Only explicit acknowledgment via the communication log API or a new answered call decreases this counter.
+     * Successive attempts from the same caller also increment the counter.
+     *
+     * @returns {number} Number of missed calls (0 if unspecified)
+     */
+    get missedCallsCount(): number;
+    /**
+     * Get the number of new voice messages.
+     *
+     * <p>If this attribute is not specified, the server is unable to provide that information.
+     *
+     * @returns {number} Number of new voice messages (0 if unspecified)
+     */
+    get voiceMessagesCount(): number;
+    /**
+     * Get the number of new callback requests.
+     *
+     * <p>If this attribute is not specified, the server is unable to provide that information.
+     *
+     * @returns {number} Number of callback requests (0 if unspecified)
+     */
+    get callBackRequestsCount(): number;
+    /**
+     * Get the number of new faxes.
+     *
+     * <p>If this attribute is not specified, the server is unable to provide that information.
+     *
+     * @returns {number} Number of faxes (0 if unspecified)
+     */
+    get faxCount(): number;
+    /**
+     * Get the number of new text messages.
+     *
+     * <p>If this attribute is not specified, the server is unable to provide that information.
+     *
+     * @returns {number} Number of new text messages (0 if unspecified)
+     */
+    get newTextMessageCount(): number;
+    /**
+     * Get the number of old text messages.
+     *
+     * <p>If this attribute is not specified, the server is unable to provide that information.
+     *
+     * @returns {number} Number of old text messages (0 if unspecified)
+     */
+    get oldTextMessageCount(): number;
+    /**
+     * Indicates whether an event is waiting.
+     *
+     * <p>This flag can be used to notify the application that new events are waiting.
+     *
+     * @returns {boolean} True if an event is waiting, false otherwise
+     */
+    get eventWaiting(): boolean;
+}
+//# sourceMappingURL=event-summary-counter.d.ts.map

package/dist/types/types/eventsummary/event-summary-counter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"event-summary-counter.d.ts","sourceRoot":"","sources":["../../../../src/types/eventsummary/event-summary-counter.ts"],"names":[],"mappings":"AAqBA;;;;GAIG;AACH,qBAAa,oBAAoB;;IAS7B,OAAO;IAkBP;;;;;;;;;OASG;IACH,IAAI,gBAAgB,IAAI,MAAM,CAE7B;IAED;;;;;;OAMG;IACH,IAAI,kBAAkB,IAAI,MAAM,CAE/B;IAED;;;;;;OAMG;IACH,IAAI,qBAAqB,IAAI,MAAM,CAElC;IAED;;;;;;OAMG;IACH,IAAI,QAAQ,IAAI,MAAM,CAErB;IAED;;;;;;OAMG;IACH,IAAI,mBAAmB,IAAI,MAAM,CAEhC;IAED;;;;;;OAMG;IACH,IAAI,mBAAmB,IAAI,MAAM,CAEhC;IAED;;;;;;OAMG;IACH,IAAI,YAAY,IAAI,OAAO,CAE1B;CAqBJ"}

package/dist/types/types/eventsummary/event-summary-events.d.ts

@@ -0,0 +1,26 @@
+import { EventSummaryCounters } from './event-summary-counter';
+/**
+ * Notification sent whenever a user's event counters have changed.
+ *
+ * This event is typically emitted to reflect updated counters for the user,
+ * such as calls, messages, or other activity tracked in the system.
+ */
+export declare class OnEventSummaryUpdated {
+    #private;
+    private constructor();
+    /**
+     * Gets the login name of the user whose counters were updated.
+     *
+     * This identifier can be used for filtering events for a specific user.
+     *
+     * @returns The user's login name.
+     */
+    get loginName(): string;
+    /**
+     * Gets the updated event summary counters for the user.
+     *
+     * @returns An {@link EventSummaryCounters} instance representing the new counters.
+     */
+    get eventSummary(): EventSummaryCounters;
+}
+//# sourceMappingURL=event-summary-events.d.ts.map

package/dist/types/types/eventsummary/event-summary-events.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"event-summary-events.d.ts","sourceRoot":"","sources":["../../../../src/types/eventsummary/event-summary-events.ts"],"names":[],"mappings":"AAoBA,OAAO,EAAE,oBAAoB,EAAE,MAAM,yBAAyB,CAAC;AAE/D;;;;;GAKG;AACH,qBAAa,qBAAqB;;IAI9B,OAAO;IAKP;;;;;;OAMG;IACH,IAAI,SAAS,IAAI,MAAM,CAEtB;IAED;;;;OAIG;IACH,IAAI,YAAY,IAAI,oBAAoB,CAEvC;CAaJ"}

package/dist/types/types/maint/configuration-type.d.ts

@@ -0,0 +1,15 @@
+/**
+ * ConfigurationType represents the possible O2G server configurations.
+ */
+export declare enum ConfigurationType {
+    /**
+     * O2G Server is configured for management. An O2G server configured for
+     * management does not monitor devices on the OmniPCX Enterprise.
+     */
+    PBX_MANAGEMENT = "PBX_MANAGEMENT",
+    /**
+     * O2G Server is configured with full services.
+     */
+    FULL_SERVICES = "FULL_SERVICES"
+}
+//# sourceMappingURL=configuration-type.d.ts.map

package/dist/types/types/maint/configuration-type.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"configuration-type.d.ts","sourceRoot":"","sources":["../../../../src/types/maint/configuration-type.ts"],"names":[],"mappings":"AAmBA;;GAEG;AACH,oBAAY,iBAAiB;IACzB;;;OAGG;IACH,cAAc,mBAAmB;IAEjC;;OAEG;IACH,aAAa,kBAAkB;CAClC"}

package/dist/types/types/maint/cti-link-state.d.ts

@@ -0,0 +1,19 @@
+/**
+ * CTILinkState represents the differents possible states of the CTI
+ * link between OmniPCX Enterprise and O2G server.
+ */
+export declare enum CTILinkState {
+    /**
+     * CTI Link is established with the main OmniPCX Enterprise call server.
+     */
+    CONNECTED_MAIN = "CONNECTED_MAIN",
+    /**
+     * CTI Link is established with the standby OmniPCX Enterprise call server.
+     */
+    CONNECTED_SECONDARY = "CONNECTED_SECONDARY",
+    /**
+     * CTI Link is not established.
+     */
+    DISCONNECTED = "DISCONNECTED"
+}
+//# sourceMappingURL=cti-link-state.d.ts.map

package/dist/types/types/maint/cti-link-state.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cti-link-state.d.ts","sourceRoot":"","sources":["../../../../src/types/maint/cti-link-state.ts"],"names":[],"mappings":"AAmBA;;;GAGG;AACH,oBAAY,YAAY;IACpB;;OAEG;IACH,cAAc,mBAAmB;IAEjC;;OAEG;IACH,mBAAmB,wBAAwB;IAE3C;;OAEG;IACH,YAAY,iBAAiB;CAChC"}

package/dist/types/types/maint/license-status.d.ts

@@ -0,0 +1,42 @@
+import { License } from './license';
+import { LicenseType } from './license-type';
+/**
+ * Represents the license status of the O2G server.
+ *
+ * Contains information about the license type, context, the current server,
+ * overall status, detailed status message, and the list of individual licenses.
+ */
+export declare class LicenseStatus {
+    #private;
+    /**
+     * Type of license control (e.g., FLEXLM or LMS).
+     * @returns {LicenseType | null} The license type or null if not set
+     */
+    get type(): LicenseType | null;
+    /**
+     * Context or scope of the license.
+     * @returns {string | null} License context or null if not set
+     */
+    get context(): string | null;
+    /**
+     * Name of the current server managing the license.
+     * @returns {string | null} Server name or null if not set
+     */
+    get currentServer(): string | null;
+    /**
+     * Overall status of the license.
+     * @returns {string | null} License status or null if not set
+     */
+    get status(): string | null;
+    /**
+     * Additional status message describing the license state.
+     * @returns {string | null} Status message or null if not set
+     */
+    get statusMessage(): string | null;
+    /**
+     * Array of individual licenses associated with this license status.
+     * @returns {License[] | null} List of licenses or null if none
+     */
+    get licenses(): License[] | null;
+}
+//# sourceMappingURL=license-status.d.ts.map

package/dist/types/types/maint/license-status.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"license-status.d.ts","sourceRoot":"","sources":["../../../../src/types/maint/license-status.ts"],"names":[],"mappings":"AAoBA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C;;;;;GAKG;AACH,qBAAa,aAAa;;IA2BtB;;;OAGG;IACH,IAAI,IAAI,IAAI,WAAW,GAAG,IAAI,CAE7B;IAED;;;OAGG;IACH,IAAI,OAAO,IAAI,MAAM,GAAG,IAAI,CAE3B;IAED;;;OAGG;IACH,IAAI,aAAa,IAAI,MAAM,GAAG,IAAI,CAEjC;IAED;;;OAGG;IACH,IAAI,MAAM,IAAI,MAAM,GAAG,IAAI,CAE1B;IAED;;;OAGG;IACH,IAAI,aAAa,IAAI,MAAM,GAAG,IAAI,CAEjC;IAED;;;OAGG;IACH,IAAI,QAAQ,IAAI,OAAO,EAAE,GAAG,IAAI,CAE/B;CAeJ"}

package/dist/types/types/maint/license-type.d.ts

@@ -0,0 +1,19 @@
+/**
+ * Defines the license control mode for the O2G system.
+ *
+ * Determines how licenses are managed and provisioned, either via an external
+ * FlexLM server (CAPEX mode) or the internal License Manager Server (OPEX mode).
+ */
+export declare enum LicenseType {
+    /**
+     * License controlled via an external **FlexLM server** (CAPEX mode).
+     * Typically used for on-premises deployments with traditional license management.
+     */
+    FLEXLM = "FLEXLM",
+    /**
+     * License controlled via the **License Manager Server** (OPEX mode, "Purple on Demand").
+     * Typically used for subscription-based deployments.
+     */
+    LMS = "LMS"
+}
+//# sourceMappingURL=license-type.d.ts.map

package/dist/types/types/maint/license-type.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"license-type.d.ts","sourceRoot":"","sources":["../../../../src/types/maint/license-type.ts"],"names":[],"mappings":"AAmBA;;;;;GAKG;AACH,oBAAY,WAAW;IACnB;;;OAGG;IACH,MAAM,WAAW;IAEjB;;;OAGG;IACH,GAAG,QAAQ;CACd"}

package/dist/types/types/maint/license.d.ts

@@ -0,0 +1,38 @@
+/**
+ * Represents a license in the O2G system.
+ *
+ * Includes the license name, total available licenses, the number currently used,
+ * and the license expiration date.
+ */
+export declare class License {
+    #private;
+    /**
+     * Creates a License instance.
+     * @param name - License name
+     * @param total - Total number of licenses
+     * @param currentUsed - Number of licenses currently in use
+     * @param expiration - Expiration date of the license
+     */
+    private constructor();
+    /**
+     * License name
+     * @returns {string | null} The license name, or null if not set
+     */
+    get name(): string | null;
+    /**
+     * Total number of licenses
+     * @returns {number} Total licenses (defaults to 0 if not set)
+     */
+    get total(): number;
+    /**
+     * Number of licenses currently used
+     * @returns {number} Currently used licenses (defaults to 0 if not set)
+     */
+    get currentUsed(): number;
+    /**
+     * License expiration date
+     * @returns {Date | null} Expiration date, or null if not set
+     */
+    get expiration(): Date | null;
+}
+//# sourceMappingURL=license.d.ts.map

package/dist/types/types/maint/license.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"license.d.ts","sourceRoot":"","sources":["../../../../src/types/maint/license.ts"],"names":[],"mappings":"AAsBA;;;;;GAKG;AACH,qBAAa,OAAO;;IAMhB;;;;;;OAMG;IACH,OAAO;IAOP;;;OAGG;IACH,IAAI,IAAI,IAAI,MAAM,GAAG,IAAI,CAExB;IAED;;;OAGG;IACH,IAAI,KAAK,IAAI,MAAM,CAElB;IAED;;;OAGG;IACH,IAAI,WAAW,IAAI,MAAM,CAExB;IAED;;;OAGG;IACH,IAAI,UAAU,IAAI,IAAI,GAAG,IAAI,CAE5B;CAiBJ"}

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

@@ -0,0 +1,105 @@
+/**
+ * Notification sent when the CTI link for a node goes down.
+ *
+ * This event is sent with a delay between 30 and 60 seconds.
+ */
+export declare class OnCtiLinkDown {
+    #private;
+    private constructor();
+    /**
+     * Gets the node identifier for which the CTI link is down.
+     *
+     * @returns The node ID.
+     */
+    get nodeId(): number;
+}
+/**
+ * Notification sent when the CTI link for a node comes back up.
+ */
+export declare class OnCtiLinkUp {
+    #private;
+    private constructor();
+    /**
+     * Gets the node identifier for which the CTI link is up.
+     *
+     * @returns The node ID.
+     */
+    get nodeId(): number;
+}
+/**
+ * Notification sent when a license is about to expire or has recently expired.
+ */
+export declare class OnLicenseExpiration {
+    #private;
+    private constructor();
+    /**
+     * Gets the alarm message for the license expiration.
+     *
+     * @returns The license message.
+     */
+    get message(): string;
+    /**
+     * Gets the number of days since or until license expiration.
+     *
+     * - `nbDays > 0`: license will expire in nbDays
+     * - `nbDays < 0`: license expired nbDays ago
+     *
+     * @returns Number of days relative to expiration.
+     */
+    get nbDays(): number;
+}
+/**
+ * Notification sent when data is fully loaded from an OXE node.
+ */
+export declare class OnPbxLoaded {
+    #private;
+    private constructor();
+    /**
+     * Gets the node identifier for which the PBX is loaded.
+     *
+     * @returns The node ID.
+     */
+    get nodeId(): number;
+}
+/**
+ * Notification sent when a PBX link goes down.
+ */
+export declare class OnPbxLinkDown {
+    #private;
+    private constructor();
+    /**
+     * Gets the node identifier for which the PBX link is down.
+     *
+     * @returns The node ID.
+     */
+    get nodeId(): number;
+}
+/**
+ * Notification sent when a PBX link comes back up.
+ */
+export declare class OnPbxLinkUp {
+    #private;
+    private constructor();
+    /**
+     * Gets the node identifier for which the PBX link is up.
+     *
+     * @returns The node ID.
+     */
+    get nodeId(): number;
+}
+/**
+ * Notification sent when the O2G server is ready (all OXE nodes are connected and loaded).
+ *
+ * This event requires a webhook URL to be configured.
+ */
+export declare class OnServerStart {
+    #private;
+    private constructor();
+    /**
+     * Gets the server identifier or IP address of the server that started.
+     *
+     * @returns The server ID.
+     */
+    get serverId(): string;
+}
+//# sourceMappingURL=maint-events.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"maint-events.d.ts","sourceRoot":"","sources":["../../../../src/types/maint/maint-events.ts"],"names":[],"mappings":"AA6BA;;;;GAIG;AACH,qBAAa,aAAa;;IAGtB,OAAO;IAIP;;;;OAIG;IACH,IAAI,MAAM,IAAI,MAAM,CAEnB;CAaJ;AAED;;GAEG;AACH,qBAAa,WAAW;;IAGpB,OAAO;IAIP;;;;OAIG;IACH,IAAI,MAAM,IAAI,MAAM,CAEnB;CAOJ;AAED;;GAEG;AACH,qBAAa,mBAAmB;;IAI5B,OAAO;IAKP;;;;OAIG;IACH,IAAI,OAAO,IAAI,MAAM,CAEpB;IAED;;;;;;;OAOG;IACH,IAAI,MAAM,IAAI,MAAM,CAEnB;CAOJ;AAED;;GAEG;AACH,qBAAa,WAAW;;IAGpB,OAAO;IAIP;;;;OAIG;IACH,IAAI,MAAM,IAAI,MAAM,CAEnB;CAOJ;AAED;;GAEG;AACH,qBAAa,aAAa;;IAGtB,OAAO;IAIP;;;;OAIG;IACH,IAAI,MAAM,IAAI,MAAM,CAEnB;CAOJ;AAED;;GAEG;AACH,qBAAa,WAAW;;IAGpB,OAAO;IAIP;;;;OAIG;IACH,IAAI,MAAM,IAAI,MAAM,CAEnB;CAOJ;AAED;;;;GAIG;AACH,qBAAa,aAAa;;IAGtB,OAAO;IAIP;;;;OAIG;IACH,IAAI,QAAQ,IAAI,MAAM,CAErB;CAOJ"}

package/dist/types/types/maint/pbx-status.d.ts

@@ -0,0 +1,77 @@
+import { CTILinkState } from './cti-link-state';
+import { ServerAddress } from './server-address';
+/**
+ * Represents the status of an OmniPCX Enterprise (PBX) node connected to the O2G server.
+ *
+ * Includes node identification, addresses, version, connection status, security, monitored users,
+ * and the CSTA link state between the O2G server and the PBX node.
+ */
+export declare class PbxStatus {
+    #private;
+    /**
+     * Creates a PbxStatus instance.
+     * @param name - PBX node name
+     * @param nodeId - PBX node number
+     * @param mainAddress - Main address of the PBX node
+     * @param secondaryAddress - Secondary address of the PBX node
+     * @param version - Version of the PBX software
+     * @param connected - Whether O2G is connected to this PBX node
+     * @param loaded - Whether all users on this PBX node are loaded
+     * @param ctiLinkState - Current CSTA link state
+     * @param secured - Whether the PBX node is secured (SSH)
+     * @param monitoredUserNumber - Number of monitored users on this PBX node
+     */
+    private constructor();
+    /**
+     * PBX node name
+     * @returns {string | null} Name of the PBX node, or null if not available
+     */
+    get name(): string | null;
+    /**
+     * PBX node number
+     * @returns {number} Node ID (defaults to 0 if not set)
+     */
+    get nodeId(): number;
+    /**
+     * Main address of the PBX node
+     * @returns {ServerAddress | null} Main server address or null if not available
+     */
+    get mainAddress(): ServerAddress | null;
+    /**
+     * Secondary address of the PBX node
+     * @returns {ServerAddress | null} Secondary server address or null if not available
+     */
+    get secondaryAddress(): ServerAddress | null;
+    /**
+     * PBX software version
+     * @returns {string | null} Version string or null if not available
+     */
+    get version(): string | null;
+    /**
+     * Connection status between O2G and the PBX node
+     * @returns {boolean} True if connected, false otherwise
+     */
+    get connected(): boolean;
+    /**
+     * Indicates whether all users on this PBX node have been loaded by O2G
+     * @see {@link Maintenance.ON_PBX_LOADED} event
+     * @returns {boolean} True if all users are loaded, false otherwise
+     */
+    get loaded(): boolean;
+    /**
+     * CSTA link state between the O2G server and this PBX node
+     * @returns {CTILinkState | null} Current CSTA link state or null if not available
+     */
+    get ctiLinkState(): CTILinkState | null;
+    /**
+     * Whether the PBX node is secured. If true, the connection with O2G uses SSH.
+     * @returns {boolean} True if secured, false otherwise
+     */
+    get secured(): boolean;
+    /**
+     * Number of monitored users on this PBX node
+     * @returns {number} Number of monitored users (defaults to 0 if not set)
+     */
+    get monitoredUserNumber(): number;
+}
+//# sourceMappingURL=pbx-status.d.ts.map

package/dist/types/types/maint/pbx-status.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"pbx-status.d.ts","sourceRoot":"","sources":["../../../../src/types/maint/pbx-status.ts"],"names":[],"mappings":"AAoBA,OAAO,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAChD,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAEjD;;;;;GAKG;AACH,qBAAa,SAAS;;IAYlB;;;;;;;;;;;;OAYG;IACH,OAAO;IAwBP;;;OAGG;IACH,IAAI,IAAI,IAAI,MAAM,GAAG,IAAI,CAExB;IAED;;;OAGG;IACH,IAAI,MAAM,IAAI,MAAM,CAEnB;IAED;;;OAGG;IACH,IAAI,WAAW,IAAI,aAAa,GAAG,IAAI,CAEtC;IAED;;;OAGG;IACH,IAAI,gBAAgB,IAAI,aAAa,GAAG,IAAI,CAE3C;IAED;;;OAGG;IACH,IAAI,OAAO,IAAI,MAAM,GAAG,IAAI,CAE3B;IAED;;;OAGG;IACH,IAAI,SAAS,IAAI,OAAO,CAEvB;IAED;;;;OAIG;IACH,IAAI,MAAM,IAAI,OAAO,CAEpB;IAED;;;OAGG;IACH,IAAI,YAAY,IAAI,YAAY,GAAG,IAAI,CAEtC;IAED;;;OAGG;IACH,IAAI,OAAO,IAAI,OAAO,CAErB;IAED;;;OAGG;IACH,IAAI,mBAAmB,IAAI,MAAM,CAEhC;CAuBJ"}

package/dist/types/types/maint/server-address.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Represents an OmniPCX Enterprise server address.
+ *
+ * Includes both the fully qualified domain name (FQDN) and the IPv4 address of the server.
+ */
+export declare class ServerAddress {
+    #private;
+    /**
+     * Creates a ServerAddress instance.
+     * @param fqdn - Fully qualified domain name of the server
+     * @param ip - IPv4 address of the server
+     */
+    private constructor();
+    /**
+     * Fully qualified domain name of the server
+     * @returns {string | null} FQDN or null if not set
+     */
+    get fqdn(): string | null;
+    /**
+     * IPv4 address of the server
+     * @returns {string | null} IP address or null if not set
+     */
+    get ip(): string | null;
+}
+//# sourceMappingURL=server-address.d.ts.map

package/dist/types/types/maint/server-address.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"server-address.d.ts","sourceRoot":"","sources":["../../../../src/types/maint/server-address.ts"],"names":[],"mappings":"AAqBA;;;;GAIG;AACH,qBAAa,aAAa;;IAItB;;;;OAIG;IACH,OAAO;IAKP;;;OAGG;IACH,IAAI,IAAI,IAAI,MAAM,GAAG,IAAI,CAExB;IAED;;;OAGG;IACH,IAAI,EAAE,IAAI,MAAM,GAAG,IAAI,CAEtB;CAYJ"}