o2g-node-sdk 1.0.1 → 2.4.1

package/dist/o2g-eventSummary.d.ts

@@ -1,33 +0,0 @@
-import { EventRegistry } from "./internal/events/event-dispatcher";
-import EventSumaryRest from "./internal/rest/eventSummary-rest";
-import { EventSummaryCounters } from "./types/eventsummary/event-summary-counter";
-import { EventEmitter } from 'events';
-/**
- * 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,
- */
-export declare class EventSummary extends EventEmitter {
-    private readonly _eventSummaryRest;
-    /**
-     * Event raised each time the user's counters have changed.
-     * @event
-     */
-    static readonly ON_EVENT_SUMMARY_UPDATED = "OnEventSummaryUpdated";
-    /**
-     *
-     * @internal
-     */
-    constructor(_eventSummaryRest: EventSumaryRest, eventRegistry: EventRegistry);
-    /**
-     * 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
-     * @return the {@link EventSummaryCounters}
-     */
-    get(loginName?: string | null): Promise<EventSummaryCounters | null>;
-}

package/dist/o2g-maint.d.ts

@@ -1,48 +0,0 @@
-import EventEmitter from "events";
-import MaintenanceRest from "./internal/rest/maint-rest";
-import { SystemStatus } from "./types/maint/maint-types";
-import { EventRegistry } from "./internal/events/event-dispatcher";
-/**
- * The MaintenanceService allows to retrieve information about the
- * system state, in particular information on the pbx nodes and their connection
- * state. Informations about license are also provided per item: total allocated
- * licenses, numbers of current used and expiration date.
- */
-export declare class Maintenance extends EventEmitter {
-    private readonly _maintenanceRest;
-    /**
-     * 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 datas are fully loaded from an OmniPCX Enterprise node.
-     * @event
-     */
-    static readonly ON_PBX_LOADED = "OnPbxLoaded";
-    /**
-     * Occurs when 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";
-    /**
-     * @internal
-     */
-    constructor(_maintenanceRest: MaintenanceRest, eventRegistry: EventRegistry);
-    /**
-     * This operation provides information about the system state , and the total
-     * number of each license type available for the system. This operation is
-     * restricted to an admin session only.
-     */
-    getSystemStatus(): Promise<SystemStatus | null>;
-}

package/dist/o2g-messaging.d.ts

@@ -1,115 +0,0 @@
-import MessagingRest from "./internal/rest/messaging-rest";
-import { MailBox } from "./types/messaging/messaging-types";
-import { MailBoxInfo } from "./types/messaging/messaging-types";
-import { VoiceMessage } from "./types/messaging/messaging-types";
-/**
- * Messaging service provides access to user's voice mail box.
- * It's 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. <br>It's
- * possible to download the voice mail as a wav file and to delete an existing
- * messages.
- */
-export declare class Messaging {
-    private _messagingRest;
-    /**
-     * @internal
-     */
-    constructor(messagingRest: MessagingRest);
-    /**
-     * Get the specified user's mailboxes. This is the logical first step to access
-     * further operation on 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
-     */
-    getMailboxes(loginName?: string | null): Promise<MailBox[] | null>;
-    /**
-     * Get the information on the specified mail box.
-     * <p>
-     * The 'password' is optional. if not set, the user password is used to
-     * connect on the voicemail. This is only possible if the OmniPCX Enterprise
-     * administrator has managed the same pasword for the user and his 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}
-     * @param password  the mail box password
-     * @param loginName the user login name
-     *
-     */
-    getMailboxInfo(mailBoxId: string, password?: string | null, loginName?: string | null): Promise<MailBoxInfo | null>;
-    /**
-     * Get 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.
-     *
-     * @param mailboxId the mail box identifier given in a {@link MailBox}
-     *                  object
-     * @param newOnly   filter only unread voicemail if set to 'true'
-     * @param offset    the offset from which to start retrieving the voicemail list
-     * @param limit     the maximum number of items to return
-     * @param loginName the user login name
-     */
-    getVoiceMessages(mailboxId: string, newOnly?: boolean, offset?: number | null, limit?: number | null, loginName?: string | null): Promise<VoiceMessage[] | null>;
-    /**
-     * Delete 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}
-     * @param loginName the user login name
-     */
-    deleteVoiceMessage(mailboxId: string, voicemailId: string, loginName?: string | null): Promise<boolean>;
-    /**
-     * Acknowledge 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}
-     * @param loginName the user login name
-     */
-    acknowledgeVoiceMessage(mailboxId: string, voicemailId: string, loginName?: string | null): Promise<boolean>;
-    /**
-     * Delete 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 voicemail identifiers given in a {@link VoiceMessage}
-     * @param loginName the user login name
-     */
-    deleteVoiceMessages(mailboxId: string, msgIds: string[], loginName?: string | null): Promise<boolean>;
-    /**
-     * Download 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.
-     *
-     * @param mailboxId the mail box identifier given in a {@link MailBox}
-     *                  object
-     * @param voicemailId the voice mail identifier given in a {@link VoiceMessage}
-     * @param wavPath an optional destination file name
-     * @param loginName the user login name
-     */
-    downloadVoiceMessage(mailboxId: string, voicemailId: string, wavPath: string | null, loginName?: string | null): Promise<string | null>;
-}

package/dist/o2g-node-sdk.d.ts

@@ -1,159 +0,0 @@
-/**
- * Copyright 2025 ALE International
- *
- * Licensed under the MIT License. You may obtain a copy of the License at:
- * https://opensource.org/licenses/MIT
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy of this
- * software and associated documentation files (the "Software"), to deal in the Software
- * without restriction, including without limitation the rights to use, copy, modify, merge,
- * publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons
- * to whom the Software is furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in all copies or
- * substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
- * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
- * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
- * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
- */
-import { Routing } from "./o2g-routing";
-import { EventSummary } from "./o2g-eventSummary";
-import { Directory } from "./o2g-directory";
-import { Users } from "./o2g-users";
-import { Telephony } from "./o2g-telephony";
-import { CommunicationLog } from "./o2g-comlog";
-import { Analytics } from "./o2g-analytics";
-import { CallCenterAgent } from "./o2g-cc-agent";
-import { CallCenterPilot } from "./o2g-cc-pilot";
-import { Maintenance } from "./o2g-maint";
-import { PbxManagement } from "./o2g-pbx-mngt";
-import { PhoneSetProgramming } from "./o2g-phone-set-prog";
-import { Messaging } from "./o2g-messaging";
-import { Subscription } from "./subscription";
-import { TimeRange } from "./types/analytics/time-range";
-import { TelFacility } from "./types/analytics/tel-facility";
-import { CallType } from "./types/analytics/call-type";
-import { IntrusionMode } from "./types/cc-agent/intrusion-mode";
-import { OperatorType } from "./types/cc-agent/operator-type";
-import { OperatorMainState } from "./types/cc-agent/operator-main-state";
-import { Page } from "./types/comlog/page";
-import { QueryFilter } from "./types/comlog/query-filter";
-import { Reason } from "./types/comlog/reason";
-import { Role } from "./types/comlog/role";
-import { Criteria } from "./types/directory/criteria";
-import { FilterItem } from "./types/directory/filter-item";
-import { OperationFilter } from "./types/directory/operation-filter";
-import { AttributeFilter } from "./types/pbxmngt/attribute-filter";
-import { AttributeType } from "./types/pbxmngt/attribute-type";
-import { Filter } from "./types/pbxmngt/filter";
-import { Option } from './types/comlog/option';
-import { PbxAttributeMap } from "./types/pbxmngt/pbx-attr-map";
-import { PbxAttribute } from "./types/pbxmngt/pbx-attribute";
-import { Pin } from "./types/phoneset/pin";
-import { PinControl } from "./types/phoneset/pin-control";
-import { ProgrammableKey } from "./types/phoneset/programmable-key";
-import { SoftKey } from "./types/phoneset/softkey";
-import { Destination } from "./types/routing/destination";
-import { ForwardCondition } from "./types/routing/forward";
-import { OverflowCondition } from "./types/routing/overflow";
-import { AcrSkill } from "./types/telephony/acr-skill";
-import { RecordingAction } from "./types/telephony/RecordingAction";
-import { UserManagement } from "./o2g-user-mngt";
-import { CallCenterManagement } from "./o2g-cc-mngt";
-import { Pilot } from "./types/cc-mngt/pilot";
-import { PilotRule } from "./types/cc-mngt/pilot-rule";
-export declare class O2G {
-    static get O2G_ONCHANNEL_INFORMATION(): string;
-    private static _application;
-    private static _logger;
-    private static _routing;
-    private static _eventSummary;
-    private static _users;
-    private static _userManagement;
-    private static _telephony;
-    private static _directory;
-    private static _comlog;
-    private static _analytics;
-    private static _callCenterAgent;
-    private static _callCenterPilot;
-    private static _callCenterManagement;
-    private static _maintenance;
-    private static _pbxManagement;
-    private static _phoneSetProgramming;
-    private static _messaging;
-    static initialize(appName: string, host: Host, apiVersion?: string): void;
-    static login(loginName: string, password: string): Promise<boolean>;
-    static subscribe(subscription: Subscription): Promise<void>;
-    static shutdown(): Promise<void>;
-    static on(event: string, listener: (...args: any[]) => void): void;
-    static off(event: string, listener: (...args: any[]) => void): void;
-    static get routing(): Routing;
-    static get eventSummary(): EventSummary;
-    static get users(): Users;
-    static get userManagement(): UserManagement;
-    static get telephony(): Telephony;
-    static get directory(): Directory;
-    static get comlog(): CommunicationLog;
-    static get analytics(): Analytics;
-    static get callCenterAgent(): CallCenterAgent;
-    static get callCenterPilot(): CallCenterPilot;
-    static get callCenterManagement(): CallCenterManagement;
-    static get maintenance(): Maintenance;
-    static get pbxManagement(): PbxManagement;
-    static get phoneSetProgramming(): PhoneSetProgramming;
-    static get messaging(): Messaging;
-    static readonly types: {
-        Subscription: typeof Subscription;
-        analytics: {
-            TimeRange: typeof TimeRange;
-            CallType: typeof CallType;
-            TelFacility: typeof TelFacility;
-        };
-        ccAgent: {
-            IntrusionMode: typeof IntrusionMode;
-            OperatorType: typeof OperatorType;
-            OperatorMainState: typeof OperatorMainState;
-        };
-        comlog: {
-            Page: typeof Page;
-            QueryFilter: typeof QueryFilter;
-            Role: typeof Role;
-            Option: typeof Option;
-            Reason: typeof Reason;
-        };
-        ccManagement: {
-            Pilot: typeof Pilot;
-            PilotRule: typeof PilotRule;
-        };
-        directory: {
-            Criteria: typeof Criteria;
-            FilterItem: typeof FilterItem;
-            OperationFilter: typeof OperationFilter;
-        };
-        pbxmngt: {
-            PbxAttribute: typeof PbxAttribute;
-            PbxAttributeMap: typeof PbxAttributeMap;
-            AttributeType: typeof AttributeType;
-            AttributeFilter: typeof AttributeFilter;
-            Filter: typeof Filter;
-        };
-        phoneset: {
-            PinControl: typeof PinControl;
-            Pin: typeof Pin;
-            ProgrammableKey: typeof ProgrammableKey;
-            SoftKey: typeof SoftKey;
-        };
-        routing: {
-            Destination: typeof Destination;
-            ForwardCondition: typeof ForwardCondition;
-            OverflowCondition: typeof OverflowCondition;
-        };
-        telephony: {
-            AcrSkill: typeof AcrSkill;
-            RecordingAction: typeof RecordingAction;
-        };
-    };
-}

package/dist/o2g-pbx-mngt.d.ts

@@ -1,146 +0,0 @@
-import PbxManagementRest from "./internal/rest/pbx-mngt-rest";
-import { Model } from "./types/pbxmngt/model";
-import { PbxAttribute } from "./types/pbxmngt/pbx-attribute";
-import { PbxObject } from "./types/pbxmngt/pbx-object";
-import { Pbx } from "./types/pbxmngt/pbxmngt-types";
-import { Filter } from "./types/pbxmngt/filter";
-import EventEmitter from "events";
-import { EventRegistry } from "./internal/events/event-dispatcher";
-/**
- * PbxManagement service allows an administrator to manage an OmniPcx
- * Enterprise, that is to create/modify/delete any object or sub-object in the
- * OmniPcx Enterprise object model. Using this service requires having a
- * <b>MANAGEMENT</b> license.
- * <p>
- * <b>WARNING:</b> Using this service requires to have a good knowledge of the
- * OmniPCX Enterprise object model.
- * <p>
- * The service uses two kinds of resource: the object model resource and the
- * object instance resource.
- * <p><b><u>The object model</u></b>: The object model can be retrieved for the whole Pbx
- * or for a particular object. It provides the detail of object attributes:
- * whether the attribute is mandatory/optional in the object creation, what
- * range of value is authorized, what are the possible enumeration value.
- * <p><b><u>The object instance</u></b>: It is used to create, modify, retrieve or remove
- * any instances of any object, giving the reference of this object. For the
- * creation or the modification of an object, the body must be compliant with
- * the object model.
- * <p>
- * The list of sub-objects which are returned by a get instance of an object
- * corresponds to the relative path of the first instanciable objects in the
- * hierarchy in order to be able by recursion to build the path to access to any
- * object and sub-object.
- * <p>
- * When access to an object which is a sub-object, the full path must be given :
- * {object1Name}/{object1Id}/{object2Name}/{object2Id}/..../{objectxName}/{objectxId}.
- */
-export declare class PbxManagement extends EventEmitter {
-    private readonly _pbxMngtRest;
-    /**
-     * Occurs when a PBX object instance is created.
-     * Only Object Subscriber is concerned by this event.
-     * @event
-     */
-    static readonly ON_PBX_OBJECT_INSTANCE_CREATED = "OnPbxObjectInstanceCreated";
-    /**
-     * Occurs when a PBX object instance is deleted.
-     * Only Object Subscriber is concerned by this event.
-     * @event
-     */
-    static readonly ON_PBX_OBJECT_INSTANCE_DELETED = "OnPbxObjectInstanceDeleted";
-    /**
-     * Occurs when a PBX object instance is modified.
-     * Only Object Subscriber is concerned by this event.
-     * @event
-     */
-    static readonly ON_PBX_OBJECT_INSTANCE_MODIFIED = "OnPbxObjectInstanceModified";
-    /**
-     *
-     * @internal
-     */
-    constructor(_pbxMngtRest: PbxManagementRest, eventRegistry: EventRegistry);
-    /**
-     * Gets the list of OmniPCX Enterprise nodes connected on this O2G server.
-     */
-    getPbxs(): Promise<number[] | null>;
-    /**
-    * Gets the OmniPCX Enterprise specified by its node id.
-    *
-    * @param nodeId the PCX Enterprise node id
-    */
-    getPbx(nodeId: number): Promise<Pbx | null>;
-    /**
-     * Get the description of the data model for the specified object on the
-     * specified OmniPCX Enterprise node.
-     * <p>
-     * If 'objectName' is 'null', the global object model of the OmniPCX Enterprise node is returned.
-     *
-     * @param nodeId     the OmniPCX Enterprise node id
-     * @param objectName the object name
-     */
-    getObjectModel(nodeId: number, objectName?: string | null): Promise<Model | null>;
-    /**
-     * Gets the node(root) object.
-     *
-     * @param nodeId the OmniPCX Enterprise node id
-     */
-    getNodeObject(nodeId: number): Promise<PbxObject | null>;
-    /**
-     * Gets the object specified by its instance definition and its instance id.
-     *
-     * @param nodeId                   the OmniPCX Enterprise node id
-     * @param objectInstanceDefinition the object instance definition
-     * @param objectId                 the object instance id
-     * @param attributes               the optional attributes to retrieve. It can be a string with a comma separated attribute name, or an array of PbxAtribute objects.
-     */
-    getObject(nodeId: number, objectInstanceDefinition: string, objectId: string, attributes?: string | PbxAttribute[] | null): Promise<PbxObject | null>;
-    /**
-     * Queries the list of object instances that match the specified filter.
-     * A filter can be built using the {@link Filter} class, or it can be a string object.
-     * @example
-     * ```typescript
-     *      // Using a Filter object
-     *      let filter = o2g.types.pbxmngt.Filter.create(
-     *                          "StationType",
-     *                          o2g.types.pbxmngt.AttributeFilter.Equals,
-     *                          "ANALOG");
-     *      let objectInstances = await o2g.pbxManagement.getObjectInstances(5, "Subscriber", filter);
-     *
-     *      // Using a string as a filter
-     *      objectInstances = await o2g.pbxManagement.getObjectInstances(5, "Subscriber", "StationType==ANALOG");
-     *
-     * ```
-     *
-     * @param nodeId the OmniPCX Enterprise node id
-     * @param objectInstanceDefinition the object instance definition
-     * @param filter a filter to query the instances ({@link Filter} object or string)
-     */
-    getObjectInstances(nodeId: number, objectInstanceDefinition: string, filter?: string | Filter | null): Promise<string[] | null>;
-    /**
-     * Changes one or several attribute values of the specified object.
-     * @param nodeId the OmniPCX Enterprise node id
-     * @param objectInstanceDefinition the object instance definition
-     * @param objectId the object instance id
-     * @param attributes the array of attributes to change
-     */
-    setObject(nodeId: number, objectInstanceDefinition: string, objectId: string, attributes: PbxAttribute[]): Promise<boolean>;
-    /**
-     * Deletes the specified instance of object.
-     * <p>
-     * The "<i>FORCED_DELETE</i>" action is not available for all object.
-     * Check the availability in the {@link Model} model corresponding to this object.
-     * This option can be used, for exemple, to delete a {@code Subscriber} having voice mails in his mail box.
-     * @param nodeId the OmniPCX Enterprise node id
-     * @param objectInstanceDefinition the object instance definition
-     * @param objectId the object instance id
-     * @param forceDelete Use the "<i>FORCED_DELETE</i>" action to delete the object.
-     */
-    deleteObject(nodeId: number, objectInstanceDefinition: string, objectId: string, forceDelete?: boolean): Promise<boolean>;
-    /**
-     * Creates a new object with the specified collection of attributes
-     * @param nodeId the OmniPCX Enterprise node id
-     * @param objectInstanceDefinition the object instance definition
-     * @param attributes the array of attributes to set at this object creation.
-     */
-    createObject(nodeId: number, objectInstanceDefinition: string, attributes: PbxAttribute[]): Promise<boolean>;
-}

package/dist/o2g-phone-set-prog.d.ts

@@ -1,29 +0,0 @@
-import PhoneSetProgrammingRest from "./internal/rest/phone-set-prog-rest";
-import { Device } from "./types/users/users-types";
-import { DynamicState } from "./types/phoneset/phoneset-types";
-import { Pin } from "./types/phoneset/pin";
-import { ProgrammableKey } from "./types/phoneset/programmable-key";
-import { SoftKey } from "./types/phoneset/softkey";
-export declare class PhoneSetProgramming {
-    private _phoneSetProgrRest;
-    constructor(phoneSetProgrRest: PhoneSetProgrammingRest);
-    getDevices(loginName: string | null): Promise<Device[] | null>;
-    getDevice(loginName: string | null, deviceId: string): Promise<Device | null>;
-    getProgrammableKeys(loginName: string | null, deviceId: string): Promise<ProgrammableKey[] | null>;
-    getProgrammedKeys(loginName: string | null, deviceId: string): Promise<ProgrammableKey[] | null>;
-    setProgrammableKey(loginName: string | null, deviceId: string, key: ProgrammableKey): Promise<boolean>;
-    deleteProgrammableKey(loginName: string | null, deviceId: string, position: number): Promise<boolean>;
-    getSoftKeys(loginName: string | null, deviceId: string): Promise<SoftKey[] | null>;
-    setSoftKey(loginName: string | null, deviceId: string, key: SoftKey): Promise<boolean>;
-    deleteSoftKey(loginName: string | null, deviceId: string, position: number): Promise<boolean>;
-    lockDevice(loginName: string | null, deviceId: string): Promise<boolean>;
-    unlockDevice(loginName: string | null, deviceId: string): Promise<boolean>;
-    enableCampon(loginName: string | null, deviceId: string): Promise<boolean>;
-    disableCampon(loginName: string | null, deviceId: string): Promise<boolean>;
-    getPinCode(loginName: string | null, deviceId: string): Promise<Pin | null>;
-    setPinCode(loginName: string | null, deviceId: string, code: Pin): Promise<boolean>;
-    getDynamicState(loginName: string | null, deviceId: string): Promise<DynamicState | null>;
-    setAssociate(loginName: string | null, deviceId: string, associate: string): Promise<boolean>;
-    activateRemoteExtension(loginName: string | null, deviceId: string): Promise<boolean>;
-    deactivateRemoteExtension(loginName: string | null, deviceId: string): Promise<boolean>;
-}