o2g-node-sdk 2.4.0 → 2.5.0

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,131 @@
+/**
+ * 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;
+}
+/**
+ * Notification sent when connection to remote twin server is lost.
+ */
+export declare class OnRemoteServerLinkDown {
+    #private;
+    private constructor();
+    /**
+     * Gets the node identifier for which the PBX link is down.
+     *
+     * @returns The node ID.
+     */
+    get host(): string;
+}
+/**
+ * Notification sent when connection to remote twin server is recovered.
+ */
+export declare class OnRemoteServerLinkUp {
+    #private;
+    private constructor();
+    /**
+     * Gets the node identifier for which the PBX link is down.
+     *
+     * @returns The node ID.
+     */
+    get host(): 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":"AA+BA;;;;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;AAGD;;GAEG;AACH,qBAAa,sBAAsB;;IAG/B,OAAO;IAIP;;;;OAIG;IACH,IAAI,IAAI,IAAI,MAAM,CAEjB;CAOJ;AAED;;GAEG;AACH,qBAAa,oBAAoB;;IAG7B,OAAO;IAIP;;;;OAIG;IACH,IAAI,IAAI,IAAI,MAAM,CAEjB;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"}

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

@@ -0,0 +1,31 @@
+/**
+ * Represents the status of an individual system service on the O2G server.
+ *
+ * Includes the service name, its current status, and an optional operating mode.
+ */
+export declare class ServiceStatus {
+    #private;
+    /**
+     * Creates a ServiceStatus instance.
+     * @param name - Name of the service
+     * @param status - Current status of the service (e.g., running, stopped)
+     * @param mode - Optional mode or configuration of the service
+     */
+    private constructor();
+    /**
+     * Name of the service
+     * @returns {string | null} Service name or null if not available
+     */
+    get name(): string | null;
+    /**
+     * Current status of the service
+     * @returns {string | null} Service status or null if not available
+     */
+    get status(): string | null;
+    /**
+     * Optional mode or configuration of the service
+     * @returns {string | null} Service mode or null if not set
+     */
+    get mode(): string | null;
+}
+//# sourceMappingURL=service-status.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"service-status.d.ts","sourceRoot":"","sources":["../../../../src/types/maint/service-status.ts"],"names":[],"mappings":"AAqBA;;;;GAIG;AACH,qBAAa,aAAa;;IAKtB;;;;;OAKG;IACH,OAAO;IAMP;;;OAGG;IACH,IAAI,IAAI,IAAI,MAAM,GAAG,IAAI,CAExB;IAED;;;OAGG;IACH,IAAI,MAAM,IAAI,MAAM,GAAG,IAAI,CAE1B;IAED;;;OAGG;IACH,IAAI,IAAI,IAAI,MAAM,GAAG,IAAI,CAExB;CAYJ"}

package/dist/types/types/maint/subscriber-filter.d.ts

@@ -0,0 +1,24 @@
+/**
+ * Defines how O2G automatically loads users from OXE subscribers.
+ *
+ * Controls which OXE subscribers are automatically imported or filtered
+ * when provisioning users in the O2G system.
+ */
+export declare enum SubscriberFilter {
+    /**
+     * Only OXE subscribers with the **A4980 attribute** are automatically loaded.
+     * Useful when selective subscriber provisioning is required.
+     */
+    A4980 = 0,
+    /**
+     * All OXE subscribers are automatically loaded.
+     * Use this for full subscriber synchronization.
+     */
+    ALL = 1,
+    /**
+     * No OXE subscribers are automatically loaded.
+     * Users must be created manually or through another provisioning process.
+     */
+    NONE = 2
+}
+//# sourceMappingURL=subscriber-filter.d.ts.map

package/dist/types/types/maint/subscriber-filter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"subscriber-filter.d.ts","sourceRoot":"","sources":["../../../../src/types/maint/subscriber-filter.ts"],"names":[],"mappings":"AAmBA;;;;;GAKG;AACH,oBAAY,gBAAgB;IACxB;;;OAGG;IACH,KAAK,IAAA;IAEL;;;OAGG;IACH,GAAG,IAAA;IAEH;;;OAGG;IACH,IAAI,IAAA;CACP"}

package/dist/types/types/maint/sys-service-status.d.ts

@@ -0,0 +1,33 @@
+import { ServiceStatus } from './service-status';
+/**
+ * Represents the status of all system services on an O2G server.
+ *
+ * Includes individual service statuses, the server's global IP address,
+ * and the DRBD status for high availability.
+ */
+export declare class SystemServiceStatus {
+    #private;
+    /**
+     * Creates a SystemServiceStatus instance.
+     * @param services - Array of service statuses
+     * @param globalIPAddress - Global IP address of the server
+     * @param drbd - DRBD status (for HA configuration)
+     */
+    private constructor();
+    /**
+     * Array of individual service statuses
+     * @returns {ServiceStatus[] | null} List of services or null if not available
+     */
+    get services(): ServiceStatus[] | null;
+    /**
+     * Global IP address of the server
+     * @returns {string | null} Global IP address or null if not available
+     */
+    get globalIPAddress(): string | null;
+    /**
+     * DRBD status for high availability
+     * @returns {string | null} DRBD status or null if not available
+     */
+    get drbd(): string | null;
+}
+//# sourceMappingURL=sys-service-status.d.ts.map

package/dist/types/types/maint/sys-service-status.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sys-service-status.d.ts","sourceRoot":"","sources":["../../../../src/types/maint/sys-service-status.ts"],"names":[],"mappings":"AAoBA,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAEjD;;;;;GAKG;AACH,qBAAa,mBAAmB;;IAK5B;;;;;OAKG;IACH,OAAO;IAMP;;;OAGG;IACH,IAAI,QAAQ,IAAI,aAAa,EAAE,GAAG,IAAI,CAErC;IAED;;;OAGG;IACH,IAAI,eAAe,IAAI,MAAM,GAAG,IAAI,CAEnC;IAED;;;OAGG;IACH,IAAI,IAAI,IAAI,MAAM,GAAG,IAAI,CAExB;CAYJ"}

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

@@ -0,0 +1,83 @@
+import { ConfigurationType } from './configuration-type';
+import { LicenseStatus } from './license-status';
+import { PbxStatus } from './pbx-status';
+import { ServerAddress } from './server-address';
+import { ServiceStatus } from './service-status';
+import { SubscriberFilter } from './subscriber-filter';
+import { SystemServiceStatus } from './sys-service-status';
+/**
+ * Provides a comprehensive status of the O2G server and its connected components.
+ *
+ * Includes details such as:
+ * - Logical server address
+ * - HA deployment mode
+ * - Primary and secondary server FQDN, version, and service status
+ * - Connected OmniPCX Enterprise (PBX) nodes
+ * - License status
+ * - Configuration type, application ID, and subscriber filters
+ */
+export declare class SystemStatus {
+    #private;
+    private constructor();
+    /** Logical address of this O2G server
+     * @returns {ServerAddress | null} The server's logical address or null if not available
+     */
+    get logicalAddress(): ServerAddress | null;
+    /** Start date/time of the O2G server
+     * @returns {Date | null} Server start date or null if not available
+     */
+    get startDate(): Date | null;
+    /** Indicates whether the server is deployed in High Availability (HA) mode
+     * @returns {boolean} True if HA mode, false otherwise
+     */
+    get haMode(): boolean;
+    /** FQDN of the primary O2G server
+     * @returns {string | null} Primary server FQDN or null if not available
+     */
+    get primary(): string | null;
+    /** Version of the primary O2G server
+     * @returns {string | null} Primary server version or null if not available
+     */
+    get primaryVersion(): string | null;
+    /** Status of services on the primary O2G server
+     * @returns {SystemServiceStatus | null} Primary server service status or null if not available
+     */
+    get primaryServiceStatus(): SystemServiceStatus | null;
+    /** FQDN of the secondary O2G server
+     * @returns {string | null} Secondary server FQDN or null if not available
+     */
+    get secondary(): string | null;
+    /** Version of the secondary O2G server
+     * @returns {string | null} Secondary server version or null if not available
+     */
+    get secondaryVersion(): string | null;
+    /** Status of services on the secondary O2G server
+     * @returns {ServiceStatus | null} Secondary server service status or null if not available
+     */
+    get secondaryServicesStatus(): ServiceStatus | null;
+    /** Collection of connected OmniPCX Enterprise (PBX) nodes
+     * @returns {PbxStatus[] | null} Array of PBX statuses or null if not available
+     */
+    get pbxs(): PbxStatus[] | null;
+    /** License status of this O2G server
+     * @returns {LicenseStatus | null} License status or null if not available
+     */
+    get license(): LicenseStatus | null;
+    /** System resources of this O2G server
+     * @returns {LicenseStatus | null} System resources or null if not available
+     */
+    get systemResources(): ServerAddress | null;
+    /** Configuration type of the O2G server
+     * @returns {ConfigurationType | null} Configuration type or null if not available
+     */
+    get configurationType(): ConfigurationType | null;
+    /** Application ID associated with the server
+     * @returns {string | null} Application ID or null if not available
+     */
+    get applicationId(): string | null;
+    /** Subscriber filter applied on the server
+     * @returns {SubscriberFilter | null} Subscriber filter or null if not available
+     */
+    get subscriberFilter(): SubscriberFilter | null;
+}
+//# sourceMappingURL=sys-status.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"sys-status.d.ts","sourceRoot":"","sources":["../../../../src/types/maint/sys-status.ts"],"names":[],"mappings":"AAoBA,OAAO,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAC;AACzD,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AACjD,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AACzC,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AACjD,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AACjD,OAAO,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AACvD,OAAO,EAAE,mBAAmB,EAAE,MAAM,sBAAsB,CAAC;AAE3D;;;;;;;;;;GAUG;AACH,qBAAa,YAAY;;IAiBrB,OAAO;IAkCP;;OAEG;IACH,IAAI,cAAc,IAAI,aAAa,GAAG,IAAI,CAEzC;IAED;;OAEG;IACH,IAAI,SAAS,IAAI,IAAI,GAAG,IAAI,CAE3B;IAED;;OAEG;IACH,IAAI,MAAM,IAAI,OAAO,CAEpB;IAED;;OAEG;IACH,IAAI,OAAO,IAAI,MAAM,GAAG,IAAI,CAE3B;IAED;;OAEG;IACH,IAAI,cAAc,IAAI,MAAM,GAAG,IAAI,CAElC;IAED;;OAEG;IACH,IAAI,oBAAoB,IAAI,mBAAmB,GAAG,IAAI,CAErD;IAED;;OAEG;IACH,IAAI,SAAS,IAAI,MAAM,GAAG,IAAI,CAE7B;IAED;;OAEG;IACH,IAAI,gBAAgB,IAAI,MAAM,GAAG,IAAI,CAEpC;IAED;;OAEG;IACH,IAAI,uBAAuB,IAAI,aAAa,GAAG,IAAI,CAElD;IAED;;OAEG;IACH,IAAI,IAAI,IAAI,SAAS,EAAE,GAAG,IAAI,CAE7B;IAED;;OAEG;IACH,IAAI,OAAO,IAAI,aAAa,GAAG,IAAI,CAElC;IAED;;OAEG;IACH,IAAI,eAAe,IAAI,aAAa,GAAG,IAAI,CAE1C;IAGD;;OAEG;IACH,IAAI,iBAAiB,IAAI,iBAAiB,GAAG,IAAI,CAEhD;IAED;;OAEG;IACH,IAAI,aAAa,IAAI,MAAM,GAAG,IAAI,CAEjC;IAED;;OAEG;IACH,IAAI,gBAAgB,IAAI,gBAAgB,GAAG,IAAI,CAE9C;CA8BJ"}

package/dist/types/types/messaging/mailbox-info.d.ts

@@ -0,0 +1,35 @@
+/**
+ * MailBoxInfo provides information about the user's mailbox.
+ *
+ * <p>This class allows access to the total number of voice messages,
+ * the number of new (unread) voice messages, and the mailbox storage usage.
+ */
+export declare class MailBoxInfo {
+    #private;
+    /**
+     * @private
+     * @param {number} [totalVoiceMsg] Total number of voice messages in the mailbox
+     * @param {number} [newVoiceMsg] Number of new (unread) voice messages
+     * @param {number} [storageUsage] Storage usage of the mailbox in bytes
+     */
+    private constructor();
+    /**
+     * Get the total number of voice messages in the mailbox.
+     *
+     * @returns {number} Total voice messages (0 if unspecified)
+     */
+    get totalVoiceMsg(): number;
+    /**
+     * Get the number of new (unread) voice messages.
+     *
+     * @returns {number} New voice messages (0 if unspecified)
+     */
+    get newVoiceMsg(): number;
+    /**
+     * Get the mailbox storage usage in bytes.
+     *
+     * @returns {number} Storage usage in bytes (0 if unspecified)
+     */
+    get storageUsage(): number;
+}
+//# sourceMappingURL=mailbox-info.d.ts.map

package/dist/types/types/messaging/mailbox-info.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mailbox-info.d.ts","sourceRoot":"","sources":["../../../../src/types/messaging/mailbox-info.ts"],"names":[],"mappings":"AAqBA;;;;;GAKG;AACH,qBAAa,WAAW;;IAKpB;;;;;OAKG;IACH,OAAO;IAMP;;;;OAIG;IACH,IAAI,aAAa,IAAI,MAAM,CAE1B;IAED;;;;OAIG;IACH,IAAI,WAAW,IAAI,MAAM,CAExB;IAED;;;;OAIG;IACH,IAAI,YAAY,IAAI,MAAM,CAEzB;CAuBJ"}

package/dist/types/types/messaging/mailbox.d.ts

@@ -0,0 +1,119 @@
+/**
+ * Represents a mailbox in a voice mail system.
+ *
+ * <p>A mailbox has an identifier, a name, and optional capabilities describing
+ * which operations are supported on the mailbox.
+ */
+export declare class MailBox {
+    #private;
+    private constructor();
+    /**
+     * Get the mailbox identifier.
+     *
+     * @returns {string} The unique ID of this mailbox
+     */
+    get id(): string | null;
+    /**
+     * Get the mailbox name.
+     *
+     * @returns {string} The name of this mailbox
+     */
+    get name(): string | null;
+    /**
+     * Get the mailbox capabilities.
+     *
+     * @returns {MailBox.MailBoxCapabilities} The capabilities of this mailbox
+     */
+    get capabilities(): MailBox.MailBoxCapabilities | null;
+}
+export declare namespace MailBox {
+    /**
+     * Represents the capabilities of a mailbox.
+     *
+     * <p>Each capability indicates whether a certain action (e.g., playing messages,
+     * recording, forwarding) is supported by the mailbox.
+     */
+    class MailBoxCapabilities {
+        #private;
+        private constructor();
+        /**
+         * Indicates whether the voicemail server can list messages.
+         *
+         * @returns {boolean} True if the voicemail server can return the list of messages, false otherwise
+         */
+        get canListMessages(): boolean;
+        /**
+         * Indicates whether voice messages can be downloaded.
+         *
+         * @returns {boolean} True if voice messages can be downloaded, false otherwise
+         */
+        get canGetMessages(): boolean;
+        /**
+         * Indicates whether recorded messages can be downloaded.
+         *
+         * @returns {boolean} True if recorded messages can be downloaded, false otherwise
+         */
+        get canGetRecord(): boolean;
+        /**
+         * Indicates whether the voicemail server is capable of playing voice messages.
+         *
+         * @returns {boolean} True if playback is supported, false otherwise
+         */
+        get canPlay(): boolean;
+        /**
+         * Indicates whether playing a voice message can be paused and resumed from the paused position.
+         *
+         * @returns {boolean} True if pausing is supported, false otherwise
+         */
+        get canPause(): boolean;
+        /**
+         * Indicates whether the media session can be terminated.
+         *
+         * @returns {boolean} True if hangup is supported, false otherwise
+         */
+        get canHangup(): boolean;
+        /**
+         * Indicates whether the voicemail server is capable of recording voice messages.
+         *
+         * @returns {boolean} True if recording is supported, false otherwise
+         */
+        get canRecord(): boolean;
+        /**
+         * Indicates whether voice message recording can be resumed after being stopped.
+         *
+         * @returns {boolean} True if resuming recording is supported, false otherwise
+         */
+        get canResume(): boolean;
+        /**
+         * Indicates whether the current recording can be cancelled.
+         *
+         * @returns {boolean} True if cancelling is supported, false otherwise
+         */
+        get canCancel(): boolean;
+        /**
+         * Indicates whether the voicemail server is capable of forwarding voice messages.
+         *
+         * @returns {boolean} True if forwarding is supported, false otherwise
+         */
+        get canForward(): boolean;
+        /**
+         * Indicates whether the voicemail server can call back the originator of the voice message.
+         *
+         * @returns {boolean} True if callback is supported, false otherwise
+         */
+        get canCallback(): boolean;
+        /**
+         * Indicates whether a voice message or recording can be sent to recipients.
+         *
+         * @returns {boolean} True if sending is supported, false otherwise
+         */
+        get canSend(): boolean;
+        /**
+         * Indicates whether the voicemail server can send events in case of message deposit or removal.
+         *
+         * @returns {boolean} True if event notifications are supported, false otherwise
+         */
+        get canSendEvents(): boolean;
+    }
+}
+//# sourceMappingURL=mailbox.d.ts.map

package/dist/types/types/messaging/mailbox.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mailbox.d.ts","sourceRoot":"","sources":["../../../../src/types/messaging/mailbox.ts"],"names":[],"mappings":"AAqBA;;;;;GAKG;AACH,qBAAa,OAAO;;IAKhB,OAAO;IAMP;;;;OAIG;IACH,IAAI,EAAE,IAAI,MAAM,GAAG,IAAI,CAEtB;IAED;;;;OAIG;IACH,IAAI,IAAI,IAAI,MAAM,GAAG,IAAI,CAExB;IAED;;;;OAIG;IACH,IAAI,YAAY,IAAI,OAAO,CAAC,mBAAmB,GAAG,IAAI,CAErD;CAcJ;AAED,yBAAiB,OAAO,CAAC;IACrB;;;;;OAKG;IACH,MAAa,mBAAmB;;QAe5B,OAAO;QA8BP;;;;WAIG;QACH,IAAI,eAAe,IAAI,OAAO,CAE7B;QAED;;;;WAIG;QACH,IAAI,cAAc,IAAI,OAAO,CAE5B;QAED;;;;WAIG;QACH,IAAI,YAAY,IAAI,OAAO,CAE1B;QAED;;;;WAIG;QACH,IAAI,OAAO,IAAI,OAAO,CAErB;QAED;;;;WAIG;QACH,IAAI,QAAQ,IAAI,OAAO,CAEtB;QAED;;;;WAIG;QACH,IAAI,SAAS,IAAI,OAAO,CAEvB;QAED;;;;WAIG;QACH,IAAI,SAAS,IAAI,OAAO,CAEvB;QAED;;;;WAIG;QACH,IAAI,SAAS,IAAI,OAAO,CAEvB;QAED;;;;WAIG;QACH,IAAI,SAAS,IAAI,OAAO,CAEvB;QAED;;;;WAIG;QACH,IAAI,UAAU,IAAI,OAAO,CAExB;QAED;;;;WAIG;QACH,IAAI,WAAW,IAAI,OAAO,CAEzB;QAED;;;;WAIG;QACH,IAAI,OAAO,IAAI,OAAO,CAErB;QAED;;;;WAIG;QACH,IAAI,aAAa,IAAI,OAAO,CAE3B;KAyCJ;CACJ"}