o2g-node-sdk 1.0.1 → 2.4.0

package/dist/types/routing/routing-state.d.ts

@@ -1,67 +0,0 @@
-import { O2GRoutingState } from "../../internal/types/routing/o2grouting-types";
-import { Forward } from "./forward";
-import { Overflow } from "./overflow";
-import { DndState } from "./routing-types";
-/**
- * RoutingState represente a user routing state. A routing state is
- * composed of four elements:
- * <table>
- * <caption>Routing state elements</caption>
- * <tr>
- * <td>Remote extension activation</td>
- * <td>When the user is configured with a remote extension, he has the
- * possibility to activate or deactivate this remote extension. when the remote
- * extension is de-activated, call are not presented on the mobile device.</td>
- * </tr>
- * <tr>
- * <td>Forward</td>
- * <td>The user can configure a forward, on his voice mail if any or on any
- * other number (depending on the cOmniPCX Enterprise configuration).</td>
- * </tr>
- * <tr>
- * <td>Overflow</td>
- * <td>The user can configure an overflow on his voice mail.
- * If a forward is configured, it is considered prior the overflow.</td>
- * </tr>
- * <tr>
- * <td>Do Not Disturb</td>
- * <td>When Do Not Disturb (DND) is activated, call are not presented to the
- * user.</td>
- * </tr>
- *
- * </table>
- */
-export declare class RoutingState {
-    private _dndState;
-    private _forward;
-    private _overflow;
-    private _remoteExtensionActivated;
-    /**
-     * @internal
-     */
-    private constructor();
-    /**
-     * Return the do not disturb state.
-     */
-    get dndState(): DndState;
-    /**
-     * Returns the forward.
-     */
-    get forward(): Forward;
-    /**
-     * Returns the overflow.
-     */
-    get overflow(): Overflow;
-    /**
-     * Returns whether the routing on remote extension is activated.
-     */
-    get remoteExtensionActivated(): boolean;
-    /**
-     * @ignore
-     */
-    static build(routingState: O2GRoutingState): RoutingState;
-    /**
-     * @ignore
-     */
-    private static getRemoteExtensionActivation;
-}

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

@@ -1,10 +0,0 @@
-/**
- * Represents the DoNotDisturb state. When the DoNotDisturb is activated for a
- * user, he does not receive any call.
- */
-export type DndState = {
-    /**
-     * Whether the DoNotDisturb is activated.
-     */
-    activate: boolean;
-};

package/dist/types/rsi/add-digit-coll-criteria.d.ts

@@ -1,16 +0,0 @@
-/**
- * AdditionalDigitCollectionCriteria is used to define a digit collection strategy.
- */
-export declare class AdditionalDigitCollectionCriteria {
-    private abortDigits;
-    private ignoreDigits;
-    private backspaceDigits;
-    private termDigits;
-    private resetDigits;
-    private startTimeout;
-    private digitTimeout;
-    /**
-     * Constructs a new empty AdditionalDigitCollectionCriteria
-     */
-    constructor();
-}

package/dist/types/rsi/collection-cause.d.ts

@@ -1,21 +0,0 @@
-/**
- * CollectionCause represents the reason the digits collection ended.
- */
-export declare enum CollectionCause {
-    /**
-     * A specific tone specified in the retrieval criteria is received.
-     */
-    FLUSCHAR_RECEIVED = "FLUSCHAR_RECEIVED",
-    /**
-     * The number of tones specified in the retrieval criteria is received.
-     */
-    CHAR_COUNT_REACHED = "CHAR_COUNT_REACHED",
-    /**
-     * The timeout specified in the retrieval criteria has elapsed.
-     */
-    TIMEOUT = "TIMEOUT",
-    /**
-     * An error occurs.
-     */
-    SF_TERMINATED = "SF_TERMINATED"
-}

package/dist/types/rsi/routing-caller-type.d.ts

@@ -1,17 +0,0 @@
-/**
- * RoutingCallerType represents the call origin of a route request.
- */
-export declare enum RoutingCallerType {
-    /**
-     * The caller is internal.
-     */
-    INTERNAL = "INTERNAL",
-    /**
-     * The caller is external.
-     */
-    EXTERNAL = "EXTERNAL",
-    /**
-     * The caller origin is unknown.
-     */
-    UNKNOWN = "UNKNOWN"
-}

package/dist/types/rsi/routing-reason.d.ts

@@ -1,25 +0,0 @@
-/**
- * RoutingReason represents the possible reason associated to a route request.
- */
-export declare enum RoutingReason {
-    /**
-     * First route request.
-     */
-    INITIAL = "INITIAL",
-    /**
-     * The call is rerouted because of no answer from initial route.
-     */
-    NOANSWER = "NOANSWER",
-    /**
-     * The call is rerouted because of busy initial route.
-     */
-    BUSY = "BUSY",
-    /**
-     * The call is rerouted because of not obtainable initial route.
-     */
-    NOT_OBTAINABLE = "NOT_OBTAINABLE",
-    /**
-     * Unknown reason.
-     */
-    UNKNOWN = "UNKNOWN"
-}

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

@@ -1,76 +0,0 @@
-import { O2GEvent } from "../events/o2g-event";
-import { RoutingReason } from "./routing-reason";
-import { Tones } from "./tones";
-/**
- * Notification sent when a data collection has ended.
- */
-export type OnToneGeneratedStop = O2GEvent<'OnToneGeneratedStop', {
-    /**
-     * The RSI point extension number.
-     */
-    rsiPoint: string;
-    /**
-     * The reference of the call on which the tones are played.
-     */
-    callRef: string;
-}>;
-/**
- * This event is sent from a RSI point when a tone generation is started.
- */
-export type OnToneGeneratedStart = O2GEvent<'OnToneGeneratedStart', {
-    /**
-     * The RSI point extension number.
-     */
-    rsiPoint: string;
-    /**
-     * The reference of the call on which the tones are played.
-     */
-    callRef: string;
-    /**
-     * The tones types
-     */
-    tonesTypes: Tones;
-}>;
-/**
- * This event is raised when a data collection has ended..
- */
-export type OnDigitCollected = O2GEvent<'OnDigitCollected', {
-    /**
-     * The RSI point extension number.
-     */
-    rsiPoint: string;
-    /**
-     * The reference of the call on which the tones are played.
-     */
-    callRef: string;
-}>;
-/**
- * This event is sent from a Routing point to request a route.
- */
-export type OnRouteRequest = O2GEvent<'OnRouteRequest', {
-    /**
-     * The RSI point extension number.
-     */
-    rsiPoint: string;
-}>;
-/**
- * This event is sent from a Routing point to close a route session (routing crid is no longer valid).
- */
-export type OnRouteEnd = O2GEvent<'OnRouteEnd', {
-    /**
-     * The RSI point extension number.
-     */
-    rsiPoint: string;
-    /**
-     * The routing session unique identifier.
-     */
-    routeCrid: string;
-    /**
-     * The routed call reference.
-     */
-    routedCallRef: string;
-    /**
-     * The routing reason.
-     */
-    reason: RoutingReason;
-}>;

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

@@ -1,49 +0,0 @@
-/**
- * RsiPoint represents a RSI point. When a call is receive by a RSI
- * routing point, a {@link Rsi.ON_ROUTE_REQUEST} is send to the application.
- */
-export type RsiPoint = {
-    /**
-     * This rsi point extension number.
-     */
-    number: string;
-    /**
-     * The name of this rsi point.
-     */
-    name: string;
-    /**
-     * The OmniPcx Enterprise node on which this RSI point is configured.
-     */
-    node: number;
-    /**
-     * Whether this rsi point is registered.
-     */
-    registered: boolean;
-};
-/**
- * RouteSession represents a route request session between a RSI point
- * and an application.
- * <p>
- * A route session is initiated by a RSI point by sending a
- * {@link Rsi.ON_ROUTE_REQUEST}.
- * The application selects a route and answer the request by calling
- * {@link Rsi.routeSelect}
- */
-export type RouteSession = {
-    /**
-     * This Route session unique idnetifier.
-     */
-    routeCrid: string;
-    /**
-     * The call extension number.
-     */
-    caller: string;
-    /**
-     * The called number.
-     */
-    called: string;
-    /**
-     * The routed call reference.
-     */
-    routedCallRef: string;
-};

package/dist/types/rsi/tones.d.ts

@@ -1,25 +0,0 @@
-/**
- * Tones represents tones that can be generated by a RSI point.
- */
-export declare enum Tones {
-    /**
-     * The busy tone.
-     */
-    BUSY = "BUSY",
-    /**
-     * The ring back tone.
-     */
-    RINGBACK = "RINGBACK",
-    /**
-     * The silent tone.
-     */
-    SILENCE = "SILENCE",
-    /**
-     * The music tone.
-     */
-    MUSIC = "MUSIC",
-    /**
-     * The annoucement tone.
-     */
-    ANNOUNCEMENT = "ANNOUNCEMENT"
-}

package/dist/types/telephony/RecordingAction.d.ts

@@ -1,6 +0,0 @@
-export declare enum RecordingAction {
-    START = "Start",
-    STOP = "Stop",
-    PAUSE = "Pause",
-    RESUME = "Resume"
-}

package/dist/types/telephony/acr-skill.d.ts

@@ -1,29 +0,0 @@
-/**
- * AcrSkill represents a skill associated to a call. When the "Advanced Call Routing" call distribution strategy is configured,
- * the CCD agent are selected according to their {@link AgentSkill}.
- * The selected agent skills must match the skill required by the call.
- */
-export declare class AcrSkill {
-    private skillNumber;
-    private acrStatus;
-    private expertEvalLevel;
-    /**
-     * Construct a new AcrSkill with the specified parameters.
-     * @param number the skill number
-     * @param level the expected skill level
-     * @param mandatory whether this skill is a mandatory skill.
-     */
-    constructor(number: number, level: number, mandatory: boolean);
-    /**
-     * Returns the skill number
-     */
-    get number(): number;
-    /**
-     * Returns whether this skill is a mandatory skill.
-     */
-    get mandatory(): boolean;
-    /**
-     * Returns the skill level.
-     */
-    get evalLevel(): number;
-}

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

@@ -1,292 +0,0 @@
-import { O2GEvent } from "../events/o2g-event";
-import { CallData, DeviceCapabilities, DeviceState, HuntingGroupStatus, Leg, Participant, TelephonicState, UserState } from "../telephony/telephony-types";
-/**
- * Lists the different call causes.
- */
-export declare enum CallCause {
-    /**
-     * Caller in a two-party call has disconnected before the call was answered.
-     **/
-    ABANDONED = "ABANDONED",
-    /**
-     * The call is receiving the network congestion tone.
-     **/
-    ALL_TRUNK_BUSY = "ALL_TRUNK_BUSY",
-    /**
-     * The call is receiving the busy tone.
-     **/
-    BUSY = "BUSY",
-    /**
-     * One party in a two-party call has disconnected after the call was answered.
-     **/
-    CLEARED = "CLEARED",
-    /**
-     * One party has left the conference call.
-     **/
-    PARTICIPANT_LEFT = "PARTICIPANT_LEFT",
-    /**
-     * This is a multi-party call.
-     **/
-    CONFERENCED = "CONFERENCED",
-    /**
-     * The call is receiving the invalid number tone.
-     **/
-    INVALID_NUMBER = "INVALID_NUMBER",
-    /**
-     * The destination cannot be reached.
-     **/
-    DESTINATION_NOT_OBTAINABLE = "DESTINATION_NOT_OBTAINABLE",
-    /**
-     * The device is in DND.
-     **/
-    DO_NOT_DISTURB = "DO_NOT_DISTURB",
-    /**
-     * The call has been forwarded.
-     **/
-    FORWARDED = "FORWARDED",
-    /**
-     * The call has been hanged up before answer.
-     **/
-    NOT_ANSWERED = "NOT_ANSWERED",
-    /**
-     * The call has been picked up.
-     **/
-    PICKED_UP = "PICKED_UP",
-    /**
-     * The call has been parked.
-     **/
-    PARKED = "PARKED",
-    /**
-     * The call has been redirected.
-     **/
-    REDIRECTED = "REDIRECTED",
-    /**
-     * The call goes on overflow destination.
-     **/
-    OVERFLOWN = "OVERFLOWN",
-    /**
-     * This is a transferred call.
-     **/
-    TRANSFERRED = "TRANSFERRED",
-    /**
-     * Unknown cause.
-     **/
-    UNKNOWN = "UNKNOWN",
-    /**
-     * Picked up tandem.
-     **/
-    PICKED_UP_TANDEM = "PICKED_UP_TANDEM",
-    /**
-     * The call is a call back.
-     **/
-    CALL_BACK = "CALL_BACK",
-    /**
-     * The call is recall (e.g. on HELD call indicates that device rings back).
-     **/
-    RECALL = "RECALL",
-    /**
-     * CCD context: call distribution
-     **/
-    DISTRIBUTED = "DISTRIBUTED",
-    /**
-     * CCD context: call enters in distribution
-     **/
-    ACD_ENTER_DISTRIBUTION = "ACD_ENTER_DISTRIBUTION",
-    /**
-     * CCD context: pilot is not open
-     **/
-    RESOURCES_NOT_AVAILABLE = "RESOURCES_NOT_AVAILABLE",
-    /**
-     * CCD context: supervisor is listening the agent conversation
-     **/
-    SUPERVISOR_LISTENING = "SUPERVISOR_LISTENING",
-    /**
-     * CCD context: supervisor is fully intruded in the agent conversation
-     **/
-    SUPERVISOR_INTRUSION = "SUPERVISOR_INTRUSION",
-    /**
-     * CCD context: supervisor can speak to the agent
-     **/
-    SUPERVISOR_RESTRICT_INTRUSION = "SUPERVISOR_RESTRICT_INTRUSION",
-    /**
-     * CCD context: No available agent
-     **/
-    NO_AVAILABLE_AGENT = "NO_AVAILABLE_AGENT",
-    /**
-     * Physical phone set device is off the hook
-     **/
-    LOCKOUT = "LOCKOUT"
-}
-/**
- * This notification indicates that a new call has been created.
- */
-export type OnCallCreated = O2GEvent<'OnCallCreated', {
-    /**
-     * Login name of the user receiving the event.
-     */
-    loginName: string;
-    /**
-     * The call reference.
-     */
-    callRef: string;
-    /**
-     * Cause of the event.
-     */
-    cause: CallCause;
-    /**
-     * Call data.
-     */
-    callData: CallData;
-    /**
-     * Initiator of the call : correspond to one participant of the call, the matching can be done with the participantId value of the participants.
-     */
-    initiator: string;
-    /**
-     * Legs associated to this call.
-     */
-    legs: Leg[];
-    /**
-     * Participants associated to this call.
-     */
-    participants: Participant[];
-    /**
-     * Devices capabilities (if not specified, it means there is no modification).
-     */
-    deviceCapabilities: DeviceCapabilities[];
-}>;
-/**
- * This notification indicates that an existing call has been modified.
- */
-export type OnCallModified = O2GEvent<'OnCallModified', {
-    /**
-     * Login name of the user receiving the event.
-     */
-    loginName: string;
-    /**
-     * The call reference.
-     */
-    callRef: string;
-    /**
-     * Cause of the event.
-     */
-    cause: CallCause;
-    /**
-     * If specified, this call reference indicates that the "callRef" replace "previousCallRef".
-     * This also indicates that "previousCallRef" has been removed (call removed event is not generated)
-     */
-    previousCallRef: string;
-    /**
-     * This call reference appears when a call is released, the replacedByCallRef if present indicates that the "callRef" is replaced by this one.
-     */
-    replacedByCallRef: string;
-    /**
-     * Call data.
-     */
-    callData: CallData;
-    /**
-     * Legs modified (if not specified, it means there is no modification).
-     */
-    modifiedLegs: Leg[];
-    /**
-     * Legs added (if not specified, it means there is no added leg).
-     */
-    addedLegs: Leg[];
-    /**
-     * Legs removed (if not specified, it means there is no removed leg).
-     */
-    removedLeg: Leg[];
-    /**
-     * Participants modified (if not specified, it means there is no modification).
-     */
-    modifiedParticipants: Participant[];
-    /**
-     * Participants added (if not specified, it means there is no added participant).
-     */
-    addedParticipants: Participant[];
-    /**
-     * Participants removed (if not specified, it means there is no removed participant).
-     */
-    removedParticipants: string[];
-    /**
-     * Devices capabilities (if not specified, it means there is no modification).
-     */
-    deviceCapabilities: DeviceCapabilities[];
-}>;
-/**
- * This notification indicates that a call has been removed (hang up, transfer...).
- */
-export type OnCallRemoved = O2GEvent<'OnCallRemoved', {
-    /**
-     * Login name of the user receiving the event.
-     */
-    loginName: string;
-    /**
-     * The call reference.
-     */
-    callRef: string;
-    /**
-     * Cause of the event.
-     */
-    cause: CallCause;
-    /**
-     * If the call is forwarded or redirected, this field indicate the new destination number.
-     * This number is a user phone number if the destination is a device associated to an user, else the number is the number provided by the system.
-     */
-    newDestination: string;
-    /**
-     * Devices capabilities (if not specified, it means there is no modification).
-     */
-    deviceCapabilities: DeviceCapabilities[];
-}>;
-/**
- * This notification indicates that device's state has been modified.
- */
-export type OnDeviceStateModified = O2GEvent<'OnDeviceStateModified', {
-    /**
-     * Login name of the user receiving the event.
-     */
-    loginName: string;
-    /**
-     * Device state modified.
-     */
-    deviceStates: DeviceState[];
-}>;
-/**
- * This notification indicates the user's dynamic state change. (hunting group logon state)
- */
-export type OnDynamicStateChanged = O2GEvent<'OnDynamicStateChanged', {
-    /**
-     * Login name of the user receiving the event.
-     */
-    loginName: string;
-    /**
-     * User hg state.
-     */
-    huntingGroupState: HuntingGroupStatus;
-}>;
-/**
- * This notification indicates the telephonic state (calls[] and deviceCapabilities[]) of a user.
- */
-export type OnTelephonyState = O2GEvent<'OnTelephonyState', {
-    /**
-     * Login name of the user receiving the event.
-     */
-    loginName: string;
-    /**
-     * Telephonic state of the user.
-     */
-    state: TelephonicState;
-}>;
-/**
- * This notification indicates that user's state has been modified (FREE, BUSY ...).
- */
-export type OnUserStateModified = O2GEvent<'OnUserStateModified', {
-    /**
-     * Login name of the user receiving the event.
-     */
-    loginName: string;
-    /**
-     * User state.
-     */
-    state: UserState;
-}>;