o2g-node-sdk 1.0.0 → 2.4.0

package/dist/types/directory/filter-item.d.ts

@@ -1,21 +0,0 @@
-/**
- * FilterItem represents the attributes that can be used to filter a directory search.
- */
-export declare enum FilterItem {
-    /**
-     * The last name.
-     */
-    LAST_NAME = 0,
-    /**
-     * The first name.
-     */
-    FIRST_NAME = 1,
-    /**
-     * The phone number.
-     */
-    PHONE_NUMBER = 2,
-    /**
-     * The login name.
-     */
-    LOGIN_NAME = 3
-}

package/dist/types/directory/operation-filter.d.ts

@@ -1,21 +0,0 @@
-/**
- * OperationFilter represents the operation that can be used to filter a directory search.
- */
-export declare enum OperationFilter {
-    /**
-     * The attribute and the given value are equals (case insensitive).
-     */
-    EQUAL_IGNORE_CASE = 0,
-    /**
-     * The attribute begins with the value.
-     */
-    BEGINS_WITH = 1,
-    /**
-     * The attribute contains the value.
-     */
-    CONTAINS = 2,
-    /**
-     * The attribute ends with the value.
-     */
-    ENDS_WITH = 3
-}

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

@@ -1,54 +0,0 @@
-import { O2GEvent } from "../../internal/events/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;
-}>;
-export interface EventMap {
-    OnChannelInformation: OnChannelInformation;
-    OnEventSummaryUpdated: OnEventSummaryUpdated;
-    OnUserCreated: OnUserCreated;
-    OnUserInfoChanged: OnUserInfoChanged;
-    OnUserDeleted: OnUserDeleted;
-    OnCallCreated: OnCallCreated;
-    OnCallModified: OnCallModified;
-    OnCallRemoved: OnCallRemoved;
-    OnDeviceStateModified: OnDeviceStateModified;
-    OnDynamicStateChanged: OnDynamicStateChanged;
-    OnTelephonyState: OnTelephonyState;
-    OnUserStateModified: OnUserStateModified;
-    OnRoutingStateChanged: OnRoutingStateChanged;
-    OnComRecordCreated: OnComRecordCreated;
-    OnComRecordModified: OnComRecordModified;
-    OnComRecordsDeleted: OnComRecordsDeleted;
-    OnComRecordsAck: OnComRecordsAck;
-    OnComRecordsUnAck: OnComRecordsUnAck;
-    OnCtiLinkUp: OnCtiLinkUp;
-    OnCtiLinkDown: OnCtiLinkDown;
-    OnLicenseExpiration: OnLicenseExpiration;
-    OnPbxLoaded: OnPbxLoaded;
-    OnServerStart: OnServerStart;
-    OnPbxObjectInstanceCreated: OnPbxObjectInstanceCreated;
-    OnPbxObjectInstanceDeleted: OnPbxObjectInstanceDeleted;
-    OnPbxObjectInstanceModified: OnPbxObjectInstanceModified;
-    OnAgentSkillChanged: OnAgentSkillChanged;
-    OnAgentStateChanged: OnAgentStateChanged;
-    OnSupervisorHelpCancelled: OnSupervisorHelpCancelled;
-    OnSupervisorHelpRequested: OnSupervisorHelpRequested;
-    OnPilotCallCreated: OnPilotCallCreated;
-    OnPilotCallQueued: OnPilotCallQueued;
-    OnPilotCallRemoved: OnPilotCallRemoved;
-    OnToneGeneratedStart: OnToneGeneratedStart;
-    OnToneGeneratedStop: OnToneGeneratedStop;
-    OnDigitCollected: OnDigitCollected;
-    OnRouteRequest: OnRouteRequest;
-    OnRouteEnd: OnRouteEnd;
-}

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

@@ -1,44 +0,0 @@
-/**
- * EventSummary represents event counters associated to the user. It allows a user to get its new message
- */
-export type EventSummaryCounters = {
-    /**
-     * Return the number of missed calls.
-     * <p>If this attribute is not specified, it means that the server is not able to provide that information.
-     * <p>
-     * <b>CAUTION</b>: This attribute doesn't reflect the missed call number managed by the call server itself but is related to the unanswered and non acknowledged incoming calls in the history call.
-     * Therefore, either only the explicit acknowledgment of these history com records through the communication log API service, or a new answered call with the same user will decrease this counter.
-     * Moreover, the counter is incremented for each non answered incoming call, including successive attempts from the same caller.
-     */
-    missedCallsNb?: number;
-    /**
-     * Return the number of new voice messages.
-     * <p>If this attribute is not specified, it means that the server is not able to provide that information.
-     */
-    voiceMessagesNb?: number;
-    /**
-     * Return the number of new callback requests.
-     * <p>If this attribute is not specified, it means that the server is not able to provide that information.
-     */
-    callBackRequestsNb?: number;
-    /**
-     * Return the number of new faxes.
-     * <p>If this attribute is not specified, it means that the server is not able to provide that information.
-     */
-    faxNb?: number;
-    /**
-     * Return the number of new text messages.
-     * <p>If this attribute is not specified, it means that the server is not able to provide that information.
-     */
-    newTextNb?: number;
-    /**
-     * Return the number of old text messages.
-     * <p>If this attribute is not specified, it means that the server is not able to provide that information.
-     */
-    oldTextNb?: number;
-    /**
-     * Return whether an event is waiting.
-     * <p>This flags can be used to notify the application that there are new events waiting.
-     */
-    eventWaiting?: boolean;
-};

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

@@ -1,15 +0,0 @@
-import { O2GEvent } from "../../internal/events/o2g-event";
-import { EventSummary } from "../../o2g-eventSummary";
-/**
- * Notification sent each time the user's counters have changed.
- */
-export type OnEventSummaryUpdated = O2GEvent<'OnEventSummaryUpdated', {
-    /**
-     * Login name of the user (identifier which can be used for filtering).
-     */
-    loginName: string;
-    /**
-     * The new event summary.
-     */
-    eventSummary: EventSummary;
-}>;

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

@@ -1,51 +0,0 @@
-import { O2GEvent } from "../../internal/events/o2g-event";
-/**
- * Notification sent when CTI link is down. This event is sent with a 30 s minimum and 60 s maximum delay.
- */
-export type OnCtiLinkDown = O2GEvent<'OnCtiLinkDown', {
-    /**
-     * the nodeId which CTI link is down.
-     */
-    nodeId: number;
-}>;
-/**
- * Notification sent when CTI link is up.
- */
-export type OnCtiLinkUp = O2GEvent<'OnCtiLinkUp', {
-    /**
-     * the nodeId which CTI link is down.
-     */
-    nodeId: number;
-}>;
-/**
- * Notification sent when the license file will soon expire or has recently expired.
- */
-export type OnLicenseExpiration = O2GEvent<'OnLicenseExpiration', {
-    /**
-     * Alarm message.
-     */
-    message: string;
-    /**
-     * Number of days since or to expiration date: nbDays>0 means the license will expire in nb days and nbDays<0 means the license has already expired since nb days
-     */
-    nbDays: number;
-}>;
-/**
- * Notification sent when datas are fully loaded from an OXE.
- */
-export type OnPbxLoaded = O2GEvent<'OnPbxLoaded', {
-    /**
-     * the nodeId identifier.
-     */
-    nodeId: number;
-}>;
-/**
- * Notification sent when O2G is ready (all oxe nodes are connected and loaded).
- * To be received, this event needs a webhook url to be configured.
- */
-export type OnServerStart = O2GEvent<'OnServerStart', {
-    /**
-     * the IP address of the server which starts.
-     */
-    serverId: string;
-}>;

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

@@ -1,162 +0,0 @@
-/**
- * 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"
-}
-export declare namespace ConfigurationType {
-    function isConfigurationType(value: string): value is ConfigurationType;
-}
-/**
- * ServerAddress defines an OmniPCX Enterprise address.
- */
-export type ServerAddress = {
-    /**
-     * This address FQDN.
-     */
-    fqdn: string;
-    /**
-     * This address IPv4 address.
-     */
-    ip: string;
-};
-/**
- * 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"
-}
-export type PbxStatus = {
-    /**
-     * The name of the OmniPCX Enterprise.
-     */
-    name: string;
-    /**
-     * The OmniPCX Enterprise node number.
-     */
-    nodeId: number;
-    /**
-     * The OmniPCX Enterprise main address.
-     */
-    mainAddress: ServerAddress;
-    /**
-     * The OmniPCX Enterprise secondary address.
-     */
-    secondaryAddress: ServerAddress;
-    /**
-     * The OmniPCX Enterprise version.
-     */
-    version: string;
-    /**
-     * Whether this O2G is connected to this OmniPCX Enterprise node.
-     */
-    connected: boolean;
-    /**
-     * Whether the O2G has loaded all this OmniPCX Enterprise node's users.
-     * @see {@link Maintenance.ON_PBX_LOADED} event.
-     */
-    loaded: boolean;
-    /**
-     * The state of the CSTA link between the O2Gserver and this OmniPCX
-     * Enterprise node.
-     */
-    ctiLinkState: CTILinkState;
-    /**
-     * Whether the OmniPCX Enterprise node is secured. If the OmniPCX
-     * Enterprise node is secured, the connection with the O2G server is done using
-     * SSH.
-     */
-    secured: boolean;
-    /**
-     * The number of monitored users on this OmniPCX Enterprise node.
-     */
-    monitoredUserNumber: number;
-};
-/**
- * License represents an O2G license.
- */
-export type License = {
-    /**
-     * The license name.
-     */
-    name: string;
-    /**
-     * The number of licenses.
-     */
-    total: number;
-    /**
-     * The number of licenses used.
-     */
-    currentUsed: number;
-    /**
-     * The expiration date.
-     */
-    expiration: string;
-};
-/**
- * SystemStatus provide a full status of the O2G server and its connections.
- */
-export type SystemStatus = {
-    /**
-     * This O2G server logical address.
-     */
-    logicalAddress: ServerAddress;
-    /**
-     * The start date of the O2G server.
-     */
-    startDate: Date;
-    /**
-     * Whether this O2G is deployed in high availability mode.
-     */
-    haMode: boolean;
-    /**
-     * The FQDN of the currently active O2G server when it is configured in
-     * HA mode.
-     */
-    primary: string;
-    /**
-     * The version of the current active O2G server when it is configured in
-     * HA mode.
-     */
-    primaryVersion: string;
-    /**
-     * The FQDN of the backup O2G server when it is configured in HA mode.
-     */
-    secondary: string;
-    /**
-     * The version of the backup O2G server when it is configured in HA mode.
-     */
-    secondaryVersion: string;
-    /**
-     * The collection of OmniPCX Enterprise nodes connected to this O2G server
-     */
-    pbxs: PbxStatus[];
-    /**
-     * The O2G server licenses.
-     */
-    licenses: License[];
-    /**
-     * The O2G Server configuration
-     */
-    configurationType: ConfigurationType;
-};

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-filter.d.ts

@@ -1,30 +0,0 @@
-/**
- * AttributeFilter represents the possible operation to apply to an attribute to build a filter.
- * @see {@link PbxManagement.getObjectInstances}
- */
-export declare enum AttributeFilter {
-    /**
-     * The attribute is equal to the value.
-     */
-    Equals = 0,
-    /**
-     * The attribute starts with the value.
-     */
-    StartsWith = 1,
-    /**
-     * The attributes ends with the value.
-     */
-    EndsWith = 2,
-    /**
-     * The attribute is not equals to the value.
-     */
-    NotEquals = 3,
-    /**
-     * The attribute is greather than or equals to the value.
-     */
-    GreatherThanOrEquals = 4,
-    /**
-     * The attribute is Less than or equals to the value.
-     */
-    LessThanOrEquals = 5
-}

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;
-}