o2g-node-sdk 1.0.1 → 2.4.1

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

@@ -1,120 +0,0 @@
-import { PartyInfo } from "../common/common-types";
-/**
- * MailBox represents a mail box in a voice mail system. A voice mail is assigned to a user.
- */
-export type MailBox = {
-    /**
-     * The mail box identifier.
-     */
-    id: string;
-    /**
-     * The mail box name.
-     */
-    name: string;
-    /**
-     * The mail box capabilities.
-     */
-    capabilities: {
-        /**
-         * Whether the voicemail server can return the list of messages.
-         */
-        listMessages: boolean;
-        /**
-         * Whether Voice messages can be downloaded.
-         */
-        getMessages: boolean;
-        /**
-         * Whether Recorded messages can be downloaded.
-         */
-        getRecord: boolean;
-        /**
-         * Whether the voicemail server can play voice messages.
-         */
-        play: boolean;
-        /**
-         * Whether a played voice message can be paused and resumes from the position it has been paused.
-         */
-        pause: boolean;
-        /**
-         * Whether the media session can be terminate.
-         */
-        hangup: boolean;
-        /**
-         * Whether the voicemail server can record voice messages.
-         */
-        record: boolean;
-        /**
-         * Wheter a voice message can be resumed to the position it has been paused.
-         */
-        resume: boolean;
-        /**
-         * Whether the current recording can be cancelled.
-         */
-        cancel: boolean;
-        /**
-         * Wheter the voicemail server can forward voice messages.
-         */
-        forward: boolean;
-        /**
-         * Whether the voicemail server can call back the originator of the voice message.
-         */
-        callback: boolean;
-        /**
-         * Whether a voice message or a record can be sent to recipients.
-         */
-        send: boolean;
-        /**
-         * Whether the voicemail server can send events in case of message deposit / removal.
-         */
-        events: boolean;
-    };
-};
-/**
- * MailBoxInfo provides information on the mail box the user is
- * connected on.
- *
- * @see {@link Messaging.getMailboxInfo}
- */
-export type MailBoxInfo = {
-    /**
-     * The number of voice messages in this mail box.
-     */
-    totalVoiceMsg: number;
-    /**
-     * The new voice messages in this mail box.
-     */
-    newVoiceMsg: number;
-    /**
-     * The storage usage.
-     */
-    storageUsage: number;
-};
-/**
- * VoiceMessage represents a message stored in a voice Mail box.
- */
-export type VoiceMessage = {
-    /**
-     * The message identifier.
-     */
-    voicemailId: string;
-    /**
-     * The party who has deposit this message.
-     */
-    from: PartyInfo;
-    /**
-     * The message duration.
-     */
-    duration: number;
-    /**
-     * The date this message has been deposit.
-     */
-    date: Date;
-    /**
-     * Whether this message has been read.
-     */
-    unread: boolean;
-    /**
-     * Whether this message has high priority.
-     */
-    highPriority: boolean;
-};

package/dist/types/pbxmngt/attribute-type.d.ts

@@ -1,34 +0,0 @@
-/**
- * AttributeType represents the possible type of an attribute.
- * @see {@link Model}
- */
-export declare enum AttributeType {
-    /**
-     * An enumerated type.
-     */
-    Enumerated = "Enumerated",
-    /**
-     * An octet string type.
-     */
-    OctetString = "OctetString",
-    /**
-     * A sequence of other attributes.
-     */
-    Sequence = "Sequence",
-    /**
-     * An integer type.
-     */
-    Integer = "Integer",
-    /**
-     * A boolean type.
-     */
-    Boolean = "Boolean",
-    /**
-     * A set of other attributes.
-     */
-    Set = "Set",
-    /**
-     * A byte string type.
-     */
-    ByteString = "ByteString"
-}

package/dist/types/pbxmngt/filter.d.ts

@@ -1,46 +0,0 @@
-import { AttributeFilter } from "./attribute-filter";
-import { PbxAttribute } from "./pbx-attribute";
-/**
- * Filter class represents a filter that can be used to query OmniPCX Enterprise Object instances.
- * <p>
- * @example
- * ```typescript
- *   let complex = Filter.and(
- *                      Filter.or(
- *                        Filter.create("Station_Type", AttributeFilter.Equals, "ANALOG"),
- *                        Filter.create("Station_Type", AttributeFilter.Equals, "ALE-300")
- *                      ),
- *                      Filter.create("Directory_Name", OperationFilter.StartsWith, "f")
- *                    );
- * ```
- */
-export declare class Filter {
-    private _value;
-    /**
-     * @internal
-     */
-    constructor(value: string);
-    get value(): string;
-    /**
-     * Create a new filter with the specified attribute, operation and value.
-     * @param attribute the attribute, either a {@link PbxAttribute} value, or a string object
-     * @param operation the operation
-     * @param value the value to test
-     */
-    static create(attribute: string | PbxAttribute, operation: AttributeFilter, value: string): Filter;
-    private static combineOperator;
-    /**
-     * Combine a set of filter with a logical And.
-     * @param filter1 the first filter
-     * @param filter2 the second filter
-     * @param otherFilters other optional filters
-     */
-    static and(filter1: Filter, filter2: Filter, ...otherFilters: Filter[]): Filter;
-    /**
-     * Combine a set of filter with a logical Or.
-     * @param filter1 the first filter
-     * @param filter2 the second filter
-     * @param otherFilters other optional filters
-     */
-    static or(filter1: Filter, filter2: Filter, ...otherFilters: Filter[]): Filter;
-}

package/dist/types/pbxmngt/model.d.ts

@@ -1,63 +0,0 @@
-import { AttributeType } from "./attribute-type";
-import { O2GAttributeModel, O2GObjectModel } from "../../internal/types/pbxmngt/o2gpbxmngt-types";
-export declare class OctetStringLength {
-    private readonly _min;
-    private readonly _max;
-    private constructor();
-    get min(): number;
-    get max(): number;
-    /**
-     * @ignore
-     */
-    static parseLengthValue(value: string | null | undefined): OctetStringLength | null;
-}
-export declare class ModelAttribute {
-    private _name;
-    private _mandatory;
-    private _multiValue;
-    private _allowedValues;
-    private _octetStringLength;
-    private _defaultValue;
-    private _filtering;
-    private _usedWhen;
-    private _type;
-    constructor();
-    get name(): string;
-    get mandatory(): boolean;
-    get type(): AttributeType;
-    get multiValue(): boolean;
-    get allowedValues(): string[];
-    get octetStringLength(): OctetStringLength | null;
-    get defaultValue(): string;
-    get filtering(): boolean;
-    get usedWhen(): string;
-    /**
-     * @ignore
-     */
-    static build(attr: O2GAttributeModel): ModelAttribute;
-}
-export declare class Model {
-    private _name;
-    private _hidden;
-    private _canCreate;
-    private _canDelete;
-    private _canSet;
-    private _canGet;
-    private _otherActions;
-    private _attributes;
-    private _children;
-    get name(): string;
-    get hidden(): boolean;
-    get canCreate(): boolean;
-    get canDelete(): boolean;
-    get canSet(): boolean;
-    get canGet(): boolean;
-    get otherActions(): string[];
-    attribute(attrName: string): ModelAttribute | undefined;
-    child(name: string): Model | undefined;
-    getMandatoryAttributes(): ModelAttribute[];
-    /**
-     * @ignore
-     */
-    static build(o2gObjModel: O2GObjectModel): Model;
-}

package/dist/types/pbxmngt/pbx-attr-map.d.ts

@@ -1,91 +0,0 @@
-import { O2GPbxComplexAttribute } from "../../internal/types/pbxmngt/o2gpbxmngt-types";
-import { PbxAttribute } from "./pbx-attribute";
-/**
- * PbxAttributeMap represents a sequence of named attributes.
- */
-export declare class PbxAttributeMap {
-    private _attributes;
-    /**
-     * @internal
-     */
-    constructor();
-    /**
-     * Returns the names of the attributes in this sequence.
-     */
-    get names(): string[];
-    /**
-     * Returns the Attribute with the specified name.
-     * @example
-     * ```typescript
-     *     let skillSequence = ...
-     *     let attr = skillSequence.getAttribute("Skill_nb");
-     * ```
-     *
-     * @param name The attribute name
-     */
-    getAttribute(name: string): PbxAttribute | undefined;
-    /**
-     * Adds the specified attribute to this sequence. It's possible to chain the
-     * add operations to create a complete sequence.
-     *
-     * @example
-     * ```typescript
-     *        let attr = PbxAttributeMap.create()
-     *                      .add(PbxAttribute.createBoolean("Elem1", true))
-     *                      .add(PbxAttribute.createInteger("Elem2", 23));
-     * ```
-     *
-     * @param value the attribute to add to this sequence
-     * @return the sequence object.
-     */
-    add(value: PbxAttribute): PbxAttributeMap;
-    /**
-     * Create a new empty PbxAttributeMap. Use this method to create a new sequence
-     * of attribute. For example:
-     *
-     * @example
-     * ```typescript
-     *     Sequence {
-     *         Param1 := Integer,
-     *         Param2 := Boolean
-     *     }
-     * ```
-     * Can be created with the following operations
-     * ```typescript
-     *     let sequence = PbxAttributeMap.create()
-     *                      .add(PbxAttribute.createInteger("Param1", 1))
-     *                      .add(PbxAttribute.createBoolean("Param2", true));
-     * ```
-     */
-    static create(): PbxAttributeMap;
-    /**
-     * Create a new PbxAttributeMap with the specified attributes.
-     * Use this method to create a new sequence of attributes. For example:
-     *
-     * @example
-     * ```typescript
-     *     Sequence {
-     *         Param1 := Integer,
-     *         Param2 := Boolean
-     *     }
-     * ```
-     * Can be created with the following:
-     * ```typescript
-     *     let sequence = PbxAttributeMap.createWith([
-     *         PbxAttribute.createInteger("Param1", 1),
-     *         PbxAttribute.createBoolean("Param2", true)
-     *     ]);
-     * ```
-     *
-     * @param attributes the array of attributes
-     */
-    static createWith(attributes: PbxAttribute[]): PbxAttributeMap;
-    /**
-     * @ignore
-     */
-    static build(o2gPbxComplexAttribute: O2GPbxComplexAttribute): PbxAttributeMap;
-    /**
-     * @ignore
-     */
-    static from(attributeMaps: PbxAttributeMap, attrName: string): O2GPbxComplexAttribute;
-}

package/dist/types/pbxmngt/pbx-attribute.d.ts

@@ -1,87 +0,0 @@
-import { PbxAttributeMap } from "./pbx-attr-map";
-import { O2GPbxAttribute } from "../../internal/types/pbxmngt/o2gpbxmngt-types";
-/**
- * PbxAttribute class represents an attribute in a {@link PbxObject} object. A PbxAttribute
- * can be of the following type:
- * <p><b><u>Integer</u></b>: An Integer value is equivalent to an int value.
- * <p><b><u>Boolean</u></b>: An Boolean value is equivalent to an boolean value.
- * <p><b><u>Enumerated</u></b>: An enumerated value can have a limited set of possible
- * values. PbxAttribute treats enumerated value as string value.
- * <p><b><u>OctetString, ByteString</u></b>: An OctetString or a ByteString are equivalent to a string value.
- * <p><b><u>Sequence</u></b>: A Sequence is a structured data whose attribute member have
- * a specific name and type: For exemple
- * @example
- * ```typescript
- *     Skill := Sequence {
- *         Skill_Nb := Integer,
- *         Skill_Level := Integer,
- *         Skill_Activate := Boolean
- *     }
- * ```
- *
- * <p><b><u>Set</u></b>: A Set value is a list of attributes of the same type. It can be
- * a list of simple value like:
- *
- * @example
- * ```typescript
- *     SimpleSet := Set {
- *         Item := OctetString
- *     }
- * ```
- *
- * or a list of sequences:
- *
- * @example
- * ```typescript
- *     SkillSet := Set {
- *         Item := Sequence {
- *             Skill_Nb := Integer,
- *             Skill_Level := Integer,
- *             Skill_Activate := Boolean
- *         }
- *     }
- * ```
- */
-export declare class PbxAttribute {
-    private _name;
-    private _values;
-    private _attributeMaps;
-    private _sequenceMap;
-    /**
-     * @internal
-     */
-    constructor(name: string);
-    /**
-     * Returns this attribute's name.
-     */
-    get name(): string;
-    /**
-     * @ignore
-     */
-    static build(attr: O2GPbxAttribute): PbxAttribute;
-    /**
-     * @ignore
-     */
-    static addSequenceAttribute(pbxAttribute: PbxAttribute, name: string, attr: O2GPbxAttribute): void;
-    static createSetOfStrings(attrName: string, values: string[]): PbxAttribute;
-    static createString(attrName: string, value: string): PbxAttribute;
-    static createBoolean(attrName: string, value: boolean): PbxAttribute;
-    static createInteger(attrName: string, value: number): PbxAttribute;
-    static createSequence(attrName: string, sequence: PbxAttributeMap): PbxAttribute;
-    static createSequenceSet(attrName: string, setOfSequences: PbxAttributeMap[]): PbxAttribute;
-    getAt(index: number): PbxAttributeMap;
-    asAttributeMap(): PbxAttributeMap | null;
-    asListOfMaps(): PbxAttributeMap[] | null;
-    private _assertUnique;
-    asBoolean(): boolean;
-    setBoolean(value: boolean): void;
-    asInteger(): number;
-    setInteger(value: number): void;
-    asString(): string;
-    setString(value: string): void;
-    asEnum(): string;
-    /**
-     * @ignore
-     */
-    static from(attr: PbxAttribute): O2GPbxAttribute[];
-}

package/dist/types/pbxmngt/pbx-object.d.ts

@@ -1,45 +0,0 @@
-import { PbxAttribute } from "./pbx-attribute";
-import { O2GPbxObject } from "../../internal/types/pbxmngt/o2gpbxmngt-types";
-/**
- * PbxObject represents an object of the OmniPCX Enterprise object model.
- * <p>
- * A PbxObject object is referenced by it's object instance definition,
- * a hierarchical path from the root object, and a unique instance id.<br>
- * For exemple:
- * <ul>
- * <li>"Subscriber" : A Subscriber object.</li>
- * <li>"Application_Configuration/1/ACD2/1/ACD2_Operator/1/ACD2_Operator_data" :
- * A CCD operator data object.</li>
- * </ul>
- */
-export declare class PbxObject {
-    private _objectName;
-    private _id;
-    private _objectNames;
-    private _attributes;
-    /**
-     * @internal
-     */
-    private constructor();
-    /**
-     * Returns the collection of sub-object names.
-     */
-    get objectNames(): string[];
-    /**
-     * Returns this object's name.
-     */
-    get name(): string;
-    /**
-     * Returns this object's instance ID.
-     */
-    get id(): string;
-    /**
-     * Returns the attribute with the specified name.
-     * @param attrName The attribute name.
-     */
-    getAttribute(attrName: string): PbxAttribute | undefined;
-    /**
-     * @ignore
-     */
-    static build(o2GPbxObject: O2GPbxObject): PbxObject;
-}

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

@@ -1,59 +0,0 @@
-import { O2GEvent } from "../events/o2g-event";
-/**
- * Represent an OmniPCX Enterprise object definition.
- */
-export type PbxObjectDefinition = {
-    objectName: string;
-    objectId: string;
-};
-/**
- * Notification sent when a PBX object instance is created. Only Object Subscriber is concerned by this event.
- */
-export type OnPbxObjectInstanceCreated = O2GEvent<'OnPbxObjectInstanceCreated', {
-    /**
-     * The created object definition.
-     */
-    object: PbxObjectDefinition;
-    /**
-     * The object father of the created object.
-     */
-    father: PbxObjectDefinition;
-    /**
-     * The OmniPCX Enterprise node id that send this event.
-     */
-    nodeId: number;
-}>;
-/**
- * Notification sent when a PBX object instance is deleted. Only Object Subscriber is concerned by this event.
- */
-export type OnPbxObjectInstanceDeleted = O2GEvent<'OnPbxObjectInstanceDeleted', {
-    /**
-     * The deleted object definition.
-     */
-    object: PbxObjectDefinition;
-    /**
-     * The object father of the deleted object.
-     */
-    father: PbxObjectDefinition;
-    /**
-     * The OmniPCX Enterprise node id that send this event.
-     */
-    nodeId: number;
-}>;
-/**
- * Notification sent when a PBX object instance is modified. Only Object Subscriber is concerned by this event.
- */
-export type OnPbxObjectInstanceModified = O2GEvent<'OnPbxObjectInstanceModified', {
-    /**
-     * The modified object definition.
-     */
-    object: PbxObjectDefinition;
-    /**
-     * The object father of the modified object.
-     */
-    father: PbxObjectDefinition;
-    /**
-     * The OmniPCX Enterprise node id that send this event.
-     */
-    nodeId: number;
-}>;

package/dist/types/pbxmngt/pbxmngt-types.d.ts

@@ -1,14 +0,0 @@
-/**
- * Pbx represents basic information of a Pbx (OmniPCX Enterprise).
- * In an OmniPcx Enterprise sub-network, each OXE node is identifier by a unique node id.
- */
-export type Pbx = {
-    /**
-     * The OmniPcx Enterprise node id.
-     */
-    nodeId: number;
-    /**
-     * The OmniPCX Enterprise node Fqdn.
-     */
-    fqdn: string;
-};

package/dist/types/phoneset/device-key.d.ts

@@ -1,27 +0,0 @@
-/**
- * DeviceKey class represents the base class for key on an OmniPCX Enterprise device.
- */
-export declare class DeviceKey {
-    protected _position: number;
-    protected _number: string;
-    protected _mnemonic: string | null;
-    /**
-     * Constructs a new DeviceKey with the specified position, number, and optional mnemonic.
-     * @param position The key position on the device.
-     * @param number The phone number associated with this key.
-     * @param mnemonic The mnemonic associated with this key (optional).
-     */
-    constructor(position: number, number: string, mnemonic?: string | null);
-    /**
-     * Returns the key position.
-     */
-    get position(): number;
-    /**
-     * Returns the key-associated number.
-     */
-    get number(): string;
-    /**
-     * Returns the key mnemonic, or null if not set.
-     */
-    get mnemonic(): string | null;
-}

package/dist/types/phoneset/phoneset-types.d.ts

@@ -1,17 +0,0 @@
-/**
- * DynamicState represents the dynamic state of a device. This state provide information on the associate, and the locked and campon state.
- */
-export type DynamicState = {
-    /**
-     * Whether the device is locked.
-     */
-    lock: boolean;
-    /**
-     * Whether the camp on is activated.
-     */
-    campon: boolean;
-    /**
-     * The associated phone number.
-     */
-    associate: string;
-};

package/dist/types/phoneset/pin-control.d.ts

@@ -1,21 +0,0 @@
-/**
- * The type of access of a PIN code.
- */
-export declare enum PinControl {
-    /**
-     * PIN code can be used from any set according to categories.
-     */
-    ByCategory = "PIN_Category",
-    /**
-     * PIN code is restricted to the users set.
-     */
-    RestrictedToOwner = "PIN_Restricted_To_Owner_Set",
-    /**
-     * PIN code can be used on any set in the system.
-     */
-    UniversalAccess = "PIN_Universal_Access",
-    /**
-     * PIN code is limited to specific group.
-     */
-    ByGroup = "PIN_By_Group"
-}

package/dist/types/phoneset/pin.d.ts

@@ -1,50 +0,0 @@
-import { O2GPinCode } from "../../internal/types/phoneset/phoneset-types";
-import { PinControl } from "./pin-control";
-/**
- * Pin class represents a PIN (Personal Identification Number)
- * <p>
- * This service allows the user to announce that the call he is making is a personal (external) call and not a business call.
- * Using pulse metering tickets, the company is then able to invoice this call again as a personal call.
- * <p>
- * This service can be applied to local users (employees) or visitors (in this case, the created user set is a virtual set without a physical address).
- * <p>
- * To use this service, users must dial the personal prefix followed by the PIN No. and then the secret code followed by the external number.
- * <p>
- * The Personal Identification Number is private and secret; only the administrator and, in certain cases, the pulse metering administrator may know it.
- */
-export declare class Pin {
-    private _number;
-    private _withSecretCode;
-    private _control;
-    private _group;
-    /**
-     * @internal
-     */
-    private constructor();
-    /**
-     * Returns the PIN number.
-     */
-    get number(): string;
-    /**
-     * Returns whether the PIN code requires validation via the user's secret code.
-     */
-    get withSecretCode(): boolean;
-    /**
-     * Returns the access control associated with this PIN code.
-     */
-    get control(): PinControl;
-    /**
-     * Returns the PIN group associated with this PIN code.
-     */
-    get group(): number;
-    /**
-     * Builds a Pin object from an O2GPinCode object.
-     * @internal
-     */
-    static build(pin: O2GPinCode): Pin;
-    /**
-     * Converts a Pin instance into an O2GPinCode object.
-     * @internal
-     */
-    static from(pin: Pin): O2GPinCode;
-}