o2g-node-sdk 1.0.1 → 2.4.1

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

@@ -0,0 +1,313 @@
+import EventEmitter from 'events';
+import { ForwardCondition } from './types/routing/forward-condition';
+import { OverflowCondition } from './types/routing/overflow-condition';
+import { DndState } from './types/routing/dnd-state';
+import { Forward } from './types/routing/forward';
+import { Overflow } from './types/routing/overflow';
+import { RoutingCapabilities } from './types/routing/routing-capabilities';
+import { RoutingState } from './types/routing/routing-state';
+/**
+ * The Routing service allows a user to manage forward, overflow, DoNotDisturb
+ * and activation of their remote extension device (if any). Using this service
+ * requires having a <b>TELEPHONY_ADVANCED</b> license.
+ * <h2>Forward:</h2>A forward can be activated on the voice mail or on any
+ * number as far as this number is authorized by the OmniPCX Enterprise
+ * numbering policy. Use one of the methods:
+ * {@link forwardOnNumber} or {@link forwardOnVoiceMail} to activate a forward. <br>
+ * A {@link ForwardCondition} can be associated to the forward:
+ * <table>
+ * <caption>Forward conditions</caption>
+ * <tr><td>IMMEDIATE</td><td>Incoming calls are immediately forwarded on the target.</td></tr>
+ * <tr><td>BUSY</td><td>Incoming calls are forwarded on the target if the user is busy.</td></tr>
+ * <tr><td>NO_ANSWER</td><td>Incoming calls are forwarded on the target if the user does not answer the call.</td></tr>
+ * <tr><td>BUSY_NO_ANSWER</td><td>One of the two last conditions.</td></tr>
+ * </table>
+ * <h2>Overflow:</h2>An overflow can be activated on the voice mail (if any).
+ * Use method:
+ * {@link overflowOnVoiceMail} to activate an overflow. <br>
+ * A {@link OverflowCondition} can be associated to the overflow:
+ * <table>
+ * <caption>Overflow conditions</caption>
+ * <tr><td>BUSY</td><td>Incoming calls are redirected on the target if the user is busy.</td></tr>
+ * <tr><td>NO_ANSWER</td><td>Incoming calls are redirected on the target if the user does not answer the call.</td></tr>
+ * <tr><td>BUSY_NO_ANSWER</td><td>One of the two last conditions.</td></tr>
+ * </table>
+ * <h2>Do Not Disturb:</h2> When the Do Not Disturb (DND) is activated, the user
+ * does not receive any call. The DND is activated using method
+ * {@link activateDnd}.
+ * <h2>Remote extension activation:</h2> When a remote extension is not
+ * activated, it does not ring on incoming call. Use the method
+ * {@link activateRemoteExtension} to activate the remote extension.
+ * <h2>Eventing:</h2> For each routing modification, a
+ * {@link ON_ROUTING_STATE_CHANGED} event is raised.
+ *
+ * @example
+ * ```typescript
+ * // Listen for routing state changes
+ * O2G.routing.on(Routing.ON_ROUTING_STATE_CHANGED, (event) => {
+ *     console.log("Routing state changed:", event);
+ * });
+ *
+ * // Activate Do Not Disturb
+ * await O2G.routing.activateDnd();
+ *
+ * // Forward all calls immediately to another number
+ * await O2G.routing.forwardOnNumber("5001", ForwardCondition.IMMEDIATE);
+ *
+ * // Forward to voice mail when busy or no answer
+ * await O2G.routing.forwardOnVoiceMail(ForwardCondition.BUSY_NO_ANSWER);
+ *
+ * // Overflow to voice mail when busy
+ * await O2G.routing.overflowOnVoiceMail(OverflowCondition.BUSY);
+ *
+ * // Check the current routing state
+ * const state = await O2G.routing.getRoutingState();
+ *
+ * // Cancel all active routing rules
+ * await O2G.routing.cancelForward();
+ * await O2G.routing.cancelOverflow();
+ * await O2G.routing.cancelDnd();
+ * ```
+ */
+export declare class Routing extends EventEmitter {
+    #private;
+    /**
+     * Raised for each routing modification.
+     * @event
+     */
+    static readonly ON_ROUTING_STATE_CHANGED = "OnRoutingStateChanged";
+    /**
+     * Activates the Do Not Disturb for the specified user.
+     * <p>
+     * This method does nothing and returns `true` if the Do Not Disturb is
+     * already activated.
+     * <p>
+     * If the session has been opened for a user, the `loginName` parameter is
+     * ignored, but it is mandatory if the session has been opened by an
+     * administrator.
+     *
+     * @param loginName the user login name
+     * @returns `true` if the operation succeeded; `false` otherwise.
+     * @see cancelDnd
+     */
+    activateDnd(loginName?: string | null): Promise<boolean>;
+    /**
+     * Cancels the Do Not Disturb for the specified user.
+     * <p>
+     * This method does nothing and returns `true` if the Do Not Disturb was
+     * not activated.
+     * <p>
+     * If the session has been opened for a user, the `loginName` parameter is
+     * ignored, but it is mandatory if the session has been opened by an
+     * administrator.
+     *
+     * @param loginName the user login name
+     * @returns `true` if the operation succeeded; `false` otherwise.
+     * @see activateDnd
+     */
+    cancelDnd(loginName?: string | null): Promise<boolean>;
+    /**
+     * Gets the Do Not Disturb state of the specified user.
+     * <p>
+     * If the session has been opened for a user, the `loginName` parameter is
+     * ignored, but it is mandatory if the session has been opened by an
+     * administrator.
+     *
+     * @param loginName the user login name
+     * @returns the {@link DndState} on success; `null` otherwise.
+     */
+    getDndState(loginName?: string | null): Promise<DndState | null>;
+    /**
+     * Returns the routing capabilities of the specified user.
+     * <p>
+     * If the session has been opened for a user, the `loginName` parameter is
+     * ignored, but it is mandatory if the session has been opened by an
+     * administrator.
+     *
+     * @param loginName the user login name
+     * @returns the {@link RoutingCapabilities} on success; `null` otherwise.
+     */
+    getCapabilities(loginName?: string | null): Promise<RoutingCapabilities | null>;
+    /**
+     * Activates the remote extension device for the specified user.
+     * <p>
+     * When the remote extension is activated, it rings on incoming calls on the
+     * user's company phone.
+     * <p>
+     * If the session has been opened for a user, the `loginName` parameter is
+     * ignored, but it is mandatory if the session has been opened by an
+     * administrator.
+     *
+     * @param loginName the user login name
+     * @returns `true` if the operation succeeded; `false` otherwise.
+     * @see deactivateRemoteExtension
+     */
+    activateRemoteExtension(loginName?: string | null): Promise<boolean>;
+    /**
+     * Deactivates the remote extension device for the specified user.
+     * <p>
+     * When deactivated, it never rings, but it can still be used to place
+     * an outgoing call.
+     * <p>
+     * If the session has been opened for a user, the `loginName` parameter is
+     * ignored, but it is mandatory if the session has been opened by an
+     * administrator.
+     *
+     * @param loginName the user login name
+     * @returns `true` if the operation succeeded; `false` otherwise.
+     * @see activateRemoteExtension
+     */
+    deactivateRemoteExtension(loginName?: string | null): Promise<boolean>;
+    /**
+     * Gets the forward state of the specified user.
+     * <p>
+     * If the session has been opened for a user, the `loginName` parameter is
+     * ignored, but it is mandatory if the session has been opened by an
+     * administrator.
+     *
+     * @param loginName the user login name
+     * @returns the {@link Forward} state on success; `null` otherwise.
+     */
+    getForward(loginName?: string | null): Promise<Forward | null>;
+    /**
+     * Cancels the forward for the specified user.
+     * <p>
+     * This method does nothing and returns `true` if there is no forward
+     * activated.
+     * <p>
+     * If the session has been opened for a user, the `loginName` parameter is
+     * ignored, but it is mandatory if the session has been opened by an
+     * administrator.
+     *
+     * @param loginName the user login name
+     * @returns `true` if the operation succeeded; `false` otherwise.
+     */
+    cancelForward(loginName?: string | null): Promise<boolean>;
+    /**
+     * Sets a forward on voice mail with the specified condition, for the specified user.
+     * <p>
+     * This method will fail and return `false` if the user does not have a voice mail.
+     * <p>
+     * If the session has been opened for a user, the `loginName` parameter is
+     * ignored, but it is mandatory if the session has been opened by an
+     * administrator.
+     *
+     * @param condition the forward condition
+     * @param loginName the user login name
+     * @returns `true` if the operation succeeded; `false` otherwise.
+     * @see forwardOnNumber
+     */
+    forwardOnVoiceMail(condition: ForwardCondition, loginName?: string | null): Promise<boolean>;
+    /**
+     * Sets a forward on the specified number, with the specified condition, for the
+     * specified user.
+     * <p>
+     * If the session has been opened for a user, the `loginName` parameter is
+     * ignored, but it is mandatory if the session has been opened by an
+     * administrator.
+     *
+     * @example
+     * ```typescript
+     * // Forward all calls immediately to a mobile number
+     * await O2G.routing.forwardOnNumber("0612345678", ForwardCondition.IMMEDIATE);
+     *
+     * // Forward only when busy to an assistant
+     * await O2G.routing.forwardOnNumber("5002", ForwardCondition.BUSY);
+     *
+     * // Forward when no answer or busy to voice mail number
+     * await O2G.routing.forwardOnNumber("5003", ForwardCondition.BUSY_NO_ANSWER);
+     *
+     * // Cancel the forward when done
+     * await O2G.routing.cancelForward();
+     * ```
+     *
+     * @param number    the phone number on which the forward is activated
+     * @param condition the forward condition
+     * @param loginName the user login name
+     * @returns `true` if the operation succeeded; `false` otherwise.
+     * @see forwardOnVoiceMail
+     * @see cancelForward
+     */
+    forwardOnNumber(number: string, condition: ForwardCondition, loginName?: string | null): Promise<boolean>;
+    /**
+     * Cancels the overflow for the specified user.
+     * <p>
+     * This method does nothing and returns `true` if there is no overflow activated.
+     * <p>
+     * If the session has been opened for a user, the `loginName` parameter is
+     * ignored, but it is mandatory if the session has been opened by an
+     * administrator.
+     *
+     * @param loginName the user login name
+     * @returns `true` if the operation succeeded; `false` otherwise.
+     */
+    cancelOverflow(loginName?: string | null): Promise<boolean>;
+    /**
+     * Gets the overflow state for the specified user.
+     * <p>
+     * If the session has been opened for a user, the `loginName` parameter is
+     * ignored, but it is mandatory if the session has been opened by an
+     * administrator.
+     *
+     * @param loginName the user login name
+     * @returns the {@link Overflow} state on success; `null` otherwise.
+     */
+    getOverflow(loginName?: string | null): Promise<Overflow | null>;
+    /**
+     * Activates an overflow on voice mail with the specified condition, for the
+     * specified user.
+     * <p>
+     * This method will fail and return `false` if the user does not have a voice mail.
+     * <p>
+     * If the session has been opened for a user, the `loginName` parameter is
+     * ignored, but it is mandatory if the session has been opened by an
+     * administrator.
+     *
+     * @param condition the overflow condition
+     * @param loginName the user login name
+     * @returns `true` if the operation succeeded; `false` otherwise.
+     * @see cancelOverflow
+     */
+    overflowOnVoiceMail(condition: OverflowCondition, loginName?: string | null): Promise<boolean>;
+    /**
+     * Gets the routing state of the specified user.
+     * <p>
+     * If the session has been opened for a user, the `loginName` parameter is
+     * ignored, but it is mandatory if the session has been opened by an
+     * administrator.
+     *
+     * @param loginName the user login name
+     * @returns the {@link RoutingState} on success; `null` otherwise.
+     */
+    getRoutingState(loginName?: string | null): Promise<RoutingState | null>;
+    /**
+     * Asks a snapshot event on the specified user.
+     * <p>
+     * The {@link ON_ROUTING_STATE_CHANGED} event will contain the
+     * {@link RoutingState} (forward/overflow/dnd state). If a second request
+     * is asked while the previous one is still in progress, it has no effect.
+     * <p>
+     * If the session has been opened for a user, the `loginName` parameter is
+     * ignored, but it is mandatory if the session has been opened by an
+     * administrator.
+     *
+     * @example
+     * ```typescript
+     * // Register listener before requesting snapshot
+     * O2G.routing.on(Routing.ON_ROUTING_STATE_CHANGED, (event) => {
+     *     const state = event.routingState;
+     *     console.log("DND active:", state.dndState?.activated);
+     *     console.log("Forward active:", state.forward?.activated);
+     *     console.log("Overflow active:", state.overflow?.activated);
+     * });
+     *
+     * // Request current routing state
+     * await O2G.routing.requestSnapshot();
+     * ```
+     *
+     * @param loginName the user login name
+     * @returns `true` if the request was successfully submitted; `false` otherwise.
+     */
+    requestSnapshot(loginName?: string | null): Promise<boolean>;
+}
+//# sourceMappingURL=o2g-routing.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"o2g-routing.d.ts","sourceRoot":"","sources":["../../src/o2g-routing.ts"],"names":[],"mappings":"AAmBA,OAAO,YAAY,MAAM,QAAQ,CAAC;AAIlC,OAAO,EAAE,gBAAgB,EAAE,MAAM,mCAAmC,CAAC;AACrE,OAAO,EAAE,iBAAiB,EAAE,MAAM,oCAAoC,CAAC;AACvE,OAAO,EAAE,QAAQ,EAAE,MAAM,2BAA2B,CAAC;AACrD,OAAO,EAAE,OAAO,EAAE,MAAM,yBAAyB,CAAC;AAClD,OAAO,EAAE,QAAQ,EAAE,MAAM,0BAA0B,CAAC;AACpD,OAAO,EAAE,mBAAmB,EAAE,MAAM,sCAAsC,CAAC;AAC3E,OAAO,EAAE,YAAY,EAAE,MAAM,+BAA+B,CAAC;AAE7D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8DG;AACH,qBAAa,OAAQ,SAAQ,YAAY;;IAGrC;;;OAGG;IACH,MAAM,CAAC,QAAQ,CAAC,wBAAwB,2BAA2B;IAWnE;;;;;;;;;;;;;OAaG;IACG,WAAW,CAAC,SAAS,GAAE,MAAM,GAAG,IAAW,GAAG,OAAO,CAAC,OAAO,CAAC;IAIpE;;;;;;;;;;;;;OAaG;IACG,SAAS,CAAC,SAAS,GAAE,MAAM,GAAG,IAAW,GAAG,OAAO,CAAC,OAAO,CAAC;IAIlE;;;;;;;;;OASG;IACG,WAAW,CAAC,SAAS,GAAE,MAAM,GAAG,IAAW,GAAG,OAAO,CAAC,QAAQ,GAAG,IAAI,CAAC;IAI5E;;;;;;;;;OASG;IACG,eAAe,CAAC,SAAS,GAAE,MAAM,GAAG,IAAW,GAAG,OAAO,CAAC,mBAAmB,GAAG,IAAI,CAAC;IAI3F;;;;;;;;;;;;;OAaG;IACG,uBAAuB,CAAC,SAAS,GAAE,MAAM,GAAG,IAAW,GAAG,OAAO,CAAC,OAAO,CAAC;IAIhF;;;;;;;;;;;;;OAaG;IACG,yBAAyB,CAAC,SAAS,GAAE,MAAM,GAAG,IAAW,GAAG,OAAO,CAAC,OAAO,CAAC;IAIlF;;;;;;;;;OASG;IACG,UAAU,CAAC,SAAS,GAAE,MAAM,GAAG,IAAW,GAAG,OAAO,CAAC,OAAO,GAAG,IAAI,CAAC;IAI1E;;;;;;;;;;;;OAYG;IACG,aAAa,CAAC,SAAS,GAAE,MAAM,GAAG,IAAW,GAAG,OAAO,CAAC,OAAO,CAAC;IAItE;;;;;;;;;;;;;OAaG;IACG,kBAAkB,CAAC,SAAS,EAAE,gBAAgB,EAAE,SAAS,GAAE,MAAM,GAAG,IAAW,GAAG,OAAO,CAAC,OAAO,CAAC;IAIxG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACG,eAAe,CACjB,MAAM,EAAE,MAAM,EACd,SAAS,EAAE,gBAAgB,EAC3B,SAAS,GAAE,MAAM,GAAG,IAAW,GAChC,OAAO,CAAC,OAAO,CAAC;IAInB;;;;;;;;;;;OAWG;IACG,cAAc,CAAC,SAAS,GAAE,MAAM,GAAG,IAAW,GAAG,OAAO,CAAC,OAAO,CAAC;IAIvE;;;;;;;;;OASG;IACG,WAAW,CAAC,SAAS,GAAE,MAAM,GAAG,IAAW,GAAG,OAAO,CAAC,QAAQ,GAAG,IAAI,CAAC;IAI5E;;;;;;;;;;;;;;OAcG;IACG,mBAAmB,CAAC,SAAS,EAAE,iBAAiB,EAAE,SAAS,GAAE,MAAM,GAAG,IAAW,GAAG,OAAO,CAAC,OAAO,CAAC;IAI1G;;;;;;;;;OASG;IACG,eAAe,CAAC,SAAS,GAAE,MAAM,GAAG,IAAW,GAAG,OAAO,CAAC,YAAY,GAAG,IAAI,CAAC;IAIpF;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACG,eAAe,CAAC,SAAS,GAAE,MAAM,GAAG,IAAW,GAAG,OAAO,CAAC,OAAO,CAAC;CAG3E"}

package/dist/{o2g-rsi.d.ts → types/o2g-rsi.d.ts}

@@ -1,9 +1,8 @@
-import EventEmitter from "events";
-import RsiRest from "./internal/rest/rsi-rest";
-import { AdditionalDigitCollectionCriteria } from "./types/rsi/add-digit-coll-criteria";
-import { RouteSession, RsiPoint } from "./types/rsi/rsi-types";
-import { Tones } from "./types/rsi/tones";
-import { EventRegistry } from "./internal/events/event-dispatcher";
+import EventEmitter from 'events';
+import { AdditionalDigitCollectionCriteria } from './types/rsi/add-digit-coll-criteria';
+import { Tones } from './types/rsi/tones';
+import { RsiPoint } from './types/rsi/rsi-point';
+import { RouteSession } from './types/rsi/route-session';
 /**
  * RsiService provides access to th RSI (Routing Service Intelligence)
  * points features:
@@ -21,7 +20,7 @@ import { EventRegistry } from "./internal/events/event-dispatcher";
  * Using this service requires having a <b>CONTACTCENTER_RSI</b> license.
  */
 export declare class Rsi extends EventEmitter {
-    private readonly _rsiRest;
+    #private;
     /**
      * Occurs when a data collection has ended.
      * @event
@@ -47,11 +46,6 @@ export declare class Rsi extends EventEmitter {
      * @event
      */
     static readonly ON_ROUTE_REQUEST = "OnRouteRequest";
-    /**
-     *
-     * @internal
-     */
-    constructor(_rsiRest: RsiRest, eventRegistry: EventRegistry);
     /**
      * Gets the configured Rsi points.
      */
@@ -158,3 +152,4 @@ export declare class Rsi extends EventEmitter {
      */
     getRouteSession(rsiNumber: string, routeCrid: string): Promise<RouteSession | null>;
 }
+//# sourceMappingURL=o2g-rsi.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"o2g-rsi.d.ts","sourceRoot":"","sources":["../../src/o2g-rsi.ts"],"names":[],"mappings":"AAmBA,OAAO,YAAY,MAAM,QAAQ,CAAC;AAElC,OAAO,EAAE,iCAAiC,EAAE,MAAM,qCAAqC,CAAC;AACxF,OAAO,EAAE,KAAK,EAAE,MAAM,mBAAmB,CAAC;AAS1C,OAAO,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAC;AACjD,OAAO,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAC;AAEzD;;;;;;;;;;;;;;;GAeG;AACH,qBAAa,GAAI,SAAQ,YAAY;;IAGjC;;;OAGG;IACH,MAAM,CAAC,QAAQ,CAAC,kBAAkB,sBAAsB;IAExD;;;OAGG;IACH,MAAM,CAAC,QAAQ,CAAC,uBAAuB,0BAA0B;IAEjE;;;OAGG;IACH,MAAM,CAAC,QAAQ,CAAC,sBAAsB,yBAAyB;IAE/D;;;OAGG;IACH,MAAM,CAAC,QAAQ,CAAC,YAAY,gBAAgB;IAE5C;;;OAGG;IACH,MAAM,CAAC,QAAQ,CAAC,gBAAgB,oBAAoB;IAiBpD;;OAEG;IACG,YAAY,IAAI,OAAO,CAAC,QAAQ,EAAE,GAAG,IAAI,CAAC;IAIhD;;;;OAIG;IACG,cAAc,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAIzD;;;;OAIG;IACG,eAAe,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAI1D;;;;;;;;;;;;;;;OAeG;IACG,kBAAkB,CACpB,SAAS,EAAE,MAAM,EACjB,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,MAAM,EAChB,SAAS,GAAE,MAAM,GAAG,IAAW,EAC/B,OAAO,GAAE,MAAM,GAAG,IAAW,EAC7B,kBAAkB,GAAE,iCAAiC,GAAG,IAAW,GACpE,OAAO,CAAC,OAAO,GAAG,IAAI,CAAC;IAI1B;;;;;;OAMG;IACG,iBAAiB,CAAC,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAI9E;;;;;;;;;OASG;IACG,QAAQ,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAInG;;;;;;;OAOG;IACG,UAAU,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAItE;;;;;;;;;OASG;IACG,cAAc,CAChB,SAAS,EAAE,MAAM,EACjB,OAAO,EAAE,MAAM,EACf,WAAW,EAAE,MAAM,EACnB,QAAQ,GAAE,MAAM,GAAG,IAAW,GAC/B,OAAO,CAAC,OAAO,CAAC;IAInB;;;;;;OAMG;IACG,QAAQ,CAAC,SAAS,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAItE;;;;;;;;;;OAUG;IACG,WAAW,CACb,SAAS,EAAE,MAAM,EACjB,SAAS,EAAE,MAAM,EACjB,aAAa,EAAE,MAAM,EACrB,WAAW,GAAE,MAAM,GAAG,IAAW,EACjC,cAAc,GAAE,MAAM,GAAG,IAAW,EACpC,gBAAgB,GAAE,OAAO,GAAG,IAAW,GACxC,OAAO,CAAC,OAAO,CAAC;IAWnB;;;;OAIG;IACG,gBAAgB,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,EAAE,GAAG,IAAI,CAAC;IAIzE;;;;;OAKG;IACG,eAAe,CAAC,SAAS,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,GAAG,IAAI,CAAC;CAG5F"}