o2g-node-sdk 1.0.1 → 2.4.1

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

@@ -1,131 +0,0 @@
-import { Reason } from "./reason";
-import { Role } from "./role";
-import { PartyInfo } from "../common/common-types";
-/**
- * ComRecordParticipant represents a participant referenced in a com
- * record.
- * <p><b><u>Record content</u></b>: For a <b>simple call</b> (user A calls user B), the
- * call record on each party will contain <u>both the participant A and the
- * participant B</u>: (no guaranty on the order of the participants on 2
- * successive responses).
- * <table>
- * <caption>Simple call</caption>
- * <tr>
- * <th>Side</th>
- * <th>Com record content</th>
- * </tr>
- * <tr>
- * <td>On A side</td>
- * <td>
- * <ul>
- * <li>Participant A (the owner of the record) with role=Caller and the
- * answered status (whether the call has been answered or not).</li>
- * <li>Participant B : neither the role nor the state is provided.</li>
- * </ul>
- * </td>
- * </tr>
- * <tr>
- * <td>On B side</td>
- * <td>
- * <ul>
- * <li>Participant A : neither the role nor the state is provided.</li>
- * <li>Participant B (the owner of the record) with role=Callee and the
- * answered status (whether the call has been answered or not)</li>
- * </ul>
- * </td>
- * </tr>
- * </table>
- * <p>
- * For a <b>re-routed call</b> (user A calls user B, the call is re-routed on
- * user C, caused by overflow, redirection or pickup), the record generated on
- * each side including the user B side (the "victim" of the re-routing) will not
- * contain as participant the user B itself because he was not the last
- * destination of the call:
- * <table>
- * <caption>Re-routed call</caption>
- * <tr>
- * <th>Side</th>
- * <th>Com record content</th>
- * </tr>
- * <tr>
- * <td>On A side</td>
- * <td>
- * <ul>
- * <li>Participant A : with role=Caller, the answered status,
- * initialCalled=B.</li>
- * <li>Participant C.</li>
- * </ul>
- * </td>
- * </tr>
- * <tr>
- * <td>On B side</td>
- * <td>
- * <ul>
- * <li>Participant A : neither the role nor the state is provided.</li>
- * <li>Participant C with role=Callee, the answered status (whether the
- * call has been answered or not) and initialCalled=B which tells B that he was
- * called by A but the call has been rerouted to C(with a reason) which answered
- * or not to the call</li>
- * </ul>
- * </td>
- * </tr>
- * <tr>
- * <td>On C side</td>
- * <td>
- * <ul>
- * <li>Participant A : neither the role nor the state is provided.</li>
- * <li>Participant C with role=Callee, the answered status (whether the
- * call has been answered or not) and initialCalled=B.</li>
- * </ul>
- * </td>
- * </tr>
- * </table>
- * <p>
- * Furthermore, for a multi-parties call using addParticipant, the already
- * connected users in the call will also received a call record which will
- * contain the answered status of the added participant: this information is
- * provided to distinguish the added participants which have really answered and
- * the other which decline the call.
- * <p><b><u>Identification of the participant</u></b>: In the comlog notification events,
- * the participant owner is identified only by its loginName (in order to reduce
- * the event call flow), the other participants are identified with their full
- * identity (loginName, phoneNumber).
- * <p>
- * In a {@link QueryResult} result:
- * <ul>
- * <li>if no optimization is asked, all the participants are identified with
- * their full identity.</li>
- * <li>If the 'optimized' parameter is set to 'true', only the first
- * occurence of a participant (owner or other) is identified with its full
- * identity. The following occurences are identified only with the
- * phonenumber.</li>
- * </ul>
- *
- */
-export type ComRecordParticipant = {
-    /**
-     * The participant's role
-     */
-    role: Role;
-    /**
-     * Whether this participant has answered the call.
-     */
-    answered?: boolean;
-    /**
-     * Returns this participant's identity.
-     */
-    identity: PartyInfo;
-    /**
-     * Whether this participant is anonymous.
-     */
-    anonymous: boolean;
-    /**
-     * The number that has been initially called when this participant has
-     * been entered in the call.
-     */
-    initialCalled: PartyInfo;
-    /**
-     * The reason why the call has been established, rerouted, terminated ...
-     */
-    reason: Reason;
-};

package/dist/types/comlog/query-filter.d.ts

@@ -1,44 +0,0 @@
-import { Role } from "./role";
-import { Option } from "./option";
-/**
- * QueryFilter class represents a communication log query filter. It is used to filter records in a
- * {@link CommunicationLog.getComRecords} query.
- */
-export declare class QueryFilter {
-    /**
-     * The start date from which the query searches for matching the
-     * records. When used, the query returns the records not older than this date.
-     * When omitted the query searches for matching records starting from the
-     * oldest.
-     */
-    after?: Date;
-    /**
-     * The end date from which the query stop searching the records. When
-     * used the query returns the records older than this date. When omitted the
-     * query searches for matching records until the newest.
-     */
-    before?: Date;
-    /**
-     * The search options.
-     */
-    options?: Option;
-    /**
-     * The call reference used in this query filter. When used, the query
-     * will retrieve only the com record related to this call reference.
-     */
-    callRef: string;
-    /**
-     * The remote party. When used, filters on the records in which the user
-     * is engaged with this remote party.
-     */
-    remotePartyId: string;
-    /**
-     * The user's role in the communication. Allows to filter on the user's
-     * role in the communication.
-     */
-    role?: Role;
-    /**
-     * @internal
-     */
-    constructor();
-}

package/dist/types/comlog/query-result.d.ts

@@ -1,27 +0,0 @@
-import { ComRecord } from "./com-record";
-import { Page } from "./page";
-import { O2GComHistoryRecords } from "../../internal/types/comlog/o2gcomlog-types";
-/**
- * QueryResult class represents the result of a communication log query.
- * The {@link CommunicationLog} service provides a paging mechanism that allows the application to query the result by pages.
- */
-export declare class QueryResult {
-    private _count;
-    private _page;
-    private _records;
-    /**
-     * @internal
-     */
-    private constructor();
-    /** Returns the number of records in this result. */
-    get count(): number;
-    /** Returns the page associated with this result. */
-    get page(): Page;
-    /** Gets the list of communication records returned by the query. */
-    get records(): ComRecord[];
-    /**
-     * @ignore
-     * Factory method to build a QueryResult from raw O2G records.
-     */
-    static build(o2gComRecords: O2GComHistoryRecords): QueryResult;
-}

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

@@ -1,78 +0,0 @@
-/**
- * MainType represents the main type a participant can be.
- */
-export declare enum MainType {
-    /**
-     * The participant is a user of the system.
-     */
-    USER = "USER",
-    /**
-     * The participant is a device of the system.
-     */
-    DEVICE = "DEVICE",
-    /**
-     * The participant is a service of the system. For exemple the voice mail.
-     */
-    SERVICE = "SERVICE",
-    /**
-     * The participant is not a user of the system.
-     */
-    EXTERNAL = "EXTERNAL",
-    /**
-     * The participant type has not been identified.
-     */
-    UNKNOWN = "UNKNOWN"
-}
-/**
- * Identifier represents the information used to uniquely identify a participant; either the login name or the phone number.
- */
-export type Identifier = {
-    /**
-     * Login name.
-     */
-    loginName: string;
-    /**
-     * Company phone number.
-     */
-    phoneNumber: string;
-    /**
-     * True is this phone number is part of a multi-device configuration.
-     * @since 2.7.3
-     */
-    multiLine: boolean;
-};
-/**
- * PartyInfo represents a party involved in a call.
- */
-export type PartyInfo = {
-    /**
-     * This participant's identifier; Either the login name or the phone number.
-     */
-    id: Identifier;
-    /**
-     * This participant's first name.
-     */
-    firstName: string;
-    /**
-     * This participant's last name.
-     */
-    lastName: string;
-    /**
-     * This participant's display name.
-     * If 'firstName' and 'lastName' are filled, the 'displayName' is 'null'.
-     */
-    displayName: string;
-    /**
-     * This participant's type.
-     */
-    type: {
-        /**
-         * The main type.
-         */
-        main: MainType;
-        /**
-         * The sub-type.
-         */
-        subType: string;
-    };
-};

package/dist/types/directory/criteria.d.ts

@@ -1,90 +0,0 @@
-import { FilterItem } from "./filter-item";
-import { OperationFilter } from "./operation-filter";
-/**
- * Criteria allows to specifiy a filter to apply on a directory search.
- * <p>
- * A simple criteria is a tuple of the form: [Attribute, Operation, Value]. For example : [LAST_NAME, BEGINS_WITH, "fr"].
- * <br>A Criteria can also be the logical OR or AND combination of the set of other Criteria's.
- * <p>
- * The acceptable values for the Attributes are:<br>
- * <table>
- * <caption>Attributes values</caption>
- * <thead>
- * <tr><th>Value</th><th>Description</th></tr>
- * </thead>
- * <tr><td>LAST_NAME</td><td>The last name.</td></tr>
- * <tr><td>FIRST_NAME</td><td>The first name.</td></tr>
- * <tr><td>LOGIN_NAME</td><td>The login name.</td></tr>
- * <tr><td>PHONE_NUMBER</td><td>The phone number.</td></tr>
- * </table>
- * <p>
- * The acceptable values for the Operands are<br>
- * <table>
- * <caption>Operands values</caption>
- * <thead>
- * <tr><th>Value</th><th>Description</th></tr>
- * </thead>
- * <tr><td>BEGINS_WITH</td><td>The attribute must begin with the given value.</td></tr>
- * <tr><td>ENDS_WITH</td><td>The attribute must end with the given value.</td></tr>
- * <tr><td>CONTAINS</td><td>The attribute must contain with the given value.</td></tr>
- * <tr><td>EQUAL_IGNORE_CASE</td><td>The attribute is equal to the given value (case insensitive comparison).</td></tr>
- * </table>
- * <p><b><u>exemples</u></b>:
- * @example
- * ```typescript
- *     // Search users whom last name begins with 'b'
- *     let criteria = Criteria.create(
- *                               FilterItem.LASTNAME,
- *                               OperationFilter.BEGINS_WITH,
- *                               'b');
- *
- *     // Search users whom last name begins with 'b' and first name contains 'ja'
- *     let criteria = Criteria.and(
- *                      Criteria.create(
- *                          FilterItem.LASTNAME,
- *                          OperationFilter.BEGINS_WITH,
- *                          'b'
- *                      ),
- *                      Criteria.create(
- *                          FilterItem.FIRSTNAME,
- *                          OperationFilter.CONTAINS,
- *                          'ja'
- *                      )
- *                    );
- * ```
- *
- */
-export declare class Criteria {
-    private field;
-    private operation;
-    private operand;
-    private static _makeField;
-    private static _makeOperation;
-    /**
-     * @internal
-     */
-    constructor();
-    /**
-     * Create a new search Criteria with the specified attribute filter, operation
-     * filter and value.
-     *
-     * @param field     the attribute filter
-     * @param operation the operation
-     * @param operand   the value associated to this critera
-     */
-    static create(field: FilterItem, operation: OperationFilter, value: string): Criteria;
-    /**
-     * Create a search Criteria that is the OR combination of the given
-     * list of Criterias.
-     *
-     * @param criterias a list of Criteria objects.
-     */
-    static or(): Criteria;
-    /**
-     * Create a search Criteria that is the AND combination of the given
-     * list of Criterias.
-     *
-     * @param criterias a list of Criteria objects.
-     */
-    static and(): Criteria;
-}

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

@@ -1,44 +0,0 @@
-import { PartyInfo } from "../common/common-types";
-/**
- * Code represents the status of a directory search. Each time a call to
- * {@link Directory.getResults} is done, the returned result code must be
- * tested.
- */
-export declare enum Code {
-    /**
-     * Responses are provided this time. Continue to invoking
-     * {@linkplain Directory.getResults} periodically to get the next results.
-     */
-    OK = "OK",
-    /**
-     * No response received. Continue to invoking
-     * {@link Directory.getResults} to get more results.
-     */
-    NOK = "NOK",
-    /**
-     * Search is finished.
-     */
-    FINISH = "FINISH",
-    /**
-     * Search is ended for timeout reason.
-     */
-    TIMEOUT = "TIMEOUT"
-}
-/**
- * SearchResult represents the result of a directory search.
- */
-export type SearchResult = {
-    /**
-     * The result code of this search result.
-     */
-    resultCode: Code;
-    /**
-     * The results.
-     */
-    resultElements: {
-        /**
-         * The contacts found.
-         */
-        contacts: PartyInfo[];
-    }[];
-};

package/dist/types/events/o2g-event.d.ts

@@ -1,3 +0,0 @@
-export type O2GEvent<Name extends string, Data> = {
-    eventName: Name;
-} & Data;

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/maint/maint-events.d.ts

@@ -1,51 +0,0 @@
-import { O2GEvent } from "../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;
-};