o2g-node-sdk 1.0.0

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

@@ -0,0 +1,51 @@
+import { ComRecordParticipant } from "./comlog-types";
+import { O2GComHistoryRecord } from "../../internal/types/comlog/o2gcomlog-types";
+/**
+ * ComRecord class represents a communication record, that is an history
+ * call ticket stored by the O2G server for each conversation.
+ */
+export declare class ComRecord {
+    private _id;
+    private _callRef;
+    private _acknowledged;
+    private _participants;
+    private _begin;
+    private _end;
+    private _beginConv;
+    /**
+     * @internal
+     */
+    private constructor();
+    /**
+     * Returns this communication record identifier.
+     */
+    get id(): number;
+    /**
+     * Returns the reference of the call that has created this communication record.
+     *
+     * @return the callRef the call reference.
+     */
+    get callRef(): string;
+    /**
+     * Returns whether this communication record has been acknowledged. This
+     * parameter can only be 'true' for a missed incoming call.
+     */
+    get acknowledged(): boolean;
+    /**
+     * Returns the start date of this call.
+     */
+    get begin(): Date;
+    /**
+     * Returns the end date of this call.
+     */
+    get end(): Date;
+    /**
+     * Return the participants
+     */
+    get participants(): ComRecordParticipant[];
+    get beginConversation(): Date;
+    /**
+     * @ignore
+     */
+    static build(record: O2GComHistoryRecord): ComRecord;
+}

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

@@ -0,0 +1,74 @@
+import { O2GEvent } from "../../internal/events/o2g-event";
+import { ComRecord } from "./com-record";
+/**
+ * Notification sent when a new comlog entry has been created.
+ */
+export type OnComRecordCreated = O2GEvent<'OnComRecordCreated', {
+    /**
+     * Login name of the user (identifier which can be used for filtering).
+     */
+    loginName: string;
+    /**
+     * Contains all the fields of a call log record.
+     */
+    record: ComRecord;
+}>;
+/**
+ * Notification sent when one or more records have been modified.
+ * <p>
+ * Modification, could be trigerred by:
+ * <ul>
+ * <li>a change of state (e.g. from unanswered to answered)
+ * <li>a change of media list (e.g. IM and call in a conference).
+ * <li>a change of end date (e.g. when participants are dropped from a conference)
+ * </ul>
+ */
+export type OnComRecordModified = O2GEvent<'OnComRecordModified', {
+    /**
+     * Login name of the user (identifier which can be used for filtering).
+     */
+    loginName: string;
+    /**
+     * Contains all or part of the modified fields of a modified com log record.(example: acknowledged).
+     */
+    record: ComRecord;
+}>;
+/**
+ * Notification sent when one or more unanswered comlog records have been acknowledged.
+ */
+export type OnComRecordsAck = O2GEvent<'OnComRecordsAck', {
+    /**
+     * Login name of the user (identifier which can be used for filtering).
+     */
+    loginName: string;
+    /**
+     * A list of IDs of records which have been acknowledged.
+     */
+    recordIds: number[];
+}>;
+/**
+ * Notification sent when one or more unanswered comlog records have been acknowledged.
+ */
+export type OnComRecordsDeleted = O2GEvent<'OnComRecordsDeleted', {
+    /**
+     * Login name of the user (identifier which can be used for filtering).
+     */
+    loginName: string;
+    /**
+     * A list of IDs of records which have been destroyed Remark : if element is not present it means that all user's records have been destroyed.
+     */
+    recordIds: number[];
+}>;
+/**
+ * Notification sent when one or more unanswered comlog records have been unacknowledged.
+ */
+export type OnComRecordsUnAck = O2GEvent<'OnComRecordsUnAck', {
+    /**
+     * Login name of the user (identifier which can be used for filtering).
+     */
+    loginName: string;
+    /**
+     * A list of IDs of records which have been unacknowledged.
+     */
+    recordIds: number[];
+}>;

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

@@ -0,0 +1,131 @@
+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/option.d.ts

@@ -0,0 +1,23 @@
+/**
+ * Option enum defines the possible filter option when querying a communication log.
+ * It's possible to combine the options:
+ * @example
+ * ```typescript
+ * let options = Option.UNANSWERED | Option.UNACKNOWLEDGED
+ * ```
+ * @see {@link QueryFilter}
+ */
+export declare enum Option {
+    /**
+     * The default value that represents no filtering.
+     */
+    ONE = 0,
+    /**
+     * Use this value to filter unanswered calls.
+     */
+    UNANSWERED = 1,
+    /**
+     * Use this value to filter unacknowledged calls.
+     */
+    UNACKNOWLEDGED = 2
+}

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

@@ -0,0 +1,33 @@
+/**
+ * The Page class allows to define a paging mechanism to query the
+ * communication log.
+ * @see {@link CommunicationLog.getComRecords}
+ */
+export declare class Page {
+    private _offset;
+    private _limit;
+    /**
+     * Constructs a new Page starting with the specified offset and with the
+     * specified length.
+     *
+     * @param offset the page offset
+     * @param length  the page length
+     */
+    constructor(offset: number, limit: number);
+    /**
+     * Moves to the next page.
+     */
+    next(): void;
+    /**
+     * Moves to the previous page.
+     */
+    previous(): void;
+    /**
+     * Returns the offset of the page that is the offset of the first com record.
+     */
+    get offset(): number;
+    /**
+     * Returns the maximum number of record in this page.
+     */
+    get limit(): number;
+}

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

@@ -0,0 +1,44 @@
+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

@@ -0,0 +1,27 @@
+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/comlog/reason.d.ts

@@ -0,0 +1,61 @@
+/**
+ * Reason enum defines the why reason the communication has been released, established or rerouted.
+ */
+export declare enum Reason {
+    /**
+     * The call was abandonned because there was no Available trunk.
+     */
+    ALL_TRUNK_BUSY = "ALL_TRUNK_BUSY",
+    /**
+     * The call was refused because the dialed number is not valid.
+     */
+    INVALID_NUMBER = "INVALID_NUMBER",
+    /**
+     * The call was canceled by the caller.
+     */
+    ABANDONED = "ABANDONED",
+    /**
+     * The call failed because the called party is busy.
+     */
+    BUSY = "BUSY",
+    /**
+     * The call was set to be a conference.
+     */
+    CONFERENCED = "CONFERENCED",
+    /**
+     * he call was picked up.
+     */
+    PICKUP = "PICKUP",
+    /**
+     * The call was forwarded to another destination.
+     */
+    FORWARDED = "FORWARDED",
+    /**
+     * The call was redirected to another destination.
+     */
+    REDIRECTED = "REDIRECTED",
+    /**
+     * The call was released since redirection to another destination fails.
+     */
+    RELEASED_ON_REDIRECT = "RELEASED_ON_REDIRECT",
+    /**
+     * The call was transferred.
+     */
+    TRANSFERRED = "TRANSFERRED",
+    /**
+     * The call was released since transfer to another destination fails.
+     */
+    RELEASED_ON_TRANSFER = "RELEASED_ON_TRANSFER",
+    /**
+     * The call ended on voicemail.
+     */
+    VOICEMAIL = "VOICEMAIL",
+    /**
+     * The call normally ended.
+     */
+    NORMAL = "NORMAL",
+    /**
+     * The reason is unknown.
+     */
+    UNKNOWN = "UNKNOWN"
+}

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

@@ -0,0 +1,17 @@
+/**
+ * Role defines the roles a participant can have in a com record.
+ */
+export declare enum Role {
+    /**
+     * The participant is a caller party.
+     */
+    CALLER = "CALLER",
+    /**
+     * The participant is a called party.
+     */
+    CALLEE = "CALLEE",
+    /**
+     * The role is unknown.
+     */
+    UNKNOWN = "UNKNOWN"
+}

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

@@ -0,0 +1,78 @@
+/**
+ * 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

@@ -0,0 +1,90 @@
+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

@@ -0,0 +1,44 @@
+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[];
+    }[];
+};