o2g-node-sdk 2.5.5 → 2.5.7

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

@@ -79,8 +79,8 @@ export declare class Routing extends EventEmitter {
     /**
      * 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.
+     * When active, no calls are presented to the user. 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
@@ -118,7 +118,7 @@ export declare class Routing extends EventEmitter {
      */
     getDndState(loginName?: string | null): Promise<DndState | null>;
     /**
-     * Returns the routing capabilities of the specified user.
+     * Returns the routing capabilities available to 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
@@ -131,8 +131,9 @@ export declare class Routing extends EventEmitter {
     /**
      * 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.
+     * When activated, the remote extension rings on incoming calls on the user's
+     * company phone. If it is already activated, this method does nothing and
+     * returns `true`.
      * <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
@@ -146,8 +147,8 @@ export declare class Routing extends EventEmitter {
     /**
      * 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.
+     * When deactivated, the remote extension does not ring on incoming calls,
+     * but can still be used to place outgoing calls.
      * <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
@@ -170,10 +171,9 @@ export declare class Routing extends EventEmitter {
      */
     getForward(loginName?: string | null): Promise<Forward | null>;
     /**
-     * Cancels the forward for the specified user.
+     * Cancels the active forward for the specified user.
      * <p>
-     * This method does nothing and returns `true` if there is no forward
-     * activated.
+     * 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
@@ -181,12 +181,15 @@ export declare class Routing extends EventEmitter {
      *
      * @param loginName the user login name
      * @returns `true` if the operation succeeded; `false` otherwise.
+     * @see forwardOnNumber
+     * @see forwardOnVoiceMail
      */
     cancelForward(loginName?: string | null): Promise<boolean>;
     /**
-     * Sets a forward on voice mail with the specified condition, for the specified user.
+     * Activates a forward to the 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.
+     * If a forward is already active, it is replaced by the new one.
      * <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
@@ -196,12 +199,16 @@ export declare class Routing extends EventEmitter {
      * @param loginName the user login name
      * @returns `true` if the operation succeeded; `false` otherwise.
      * @see forwardOnNumber
+     * @see cancelForward
      */
     forwardOnVoiceMail(condition: ForwardCondition, loginName?: string | null): Promise<boolean>;
     /**
-     * Sets a forward on the specified number, with the specified condition, for the
+     * Activates a forward to the specified number, with the specified condition, for the
      * specified user.
      * <p>
+     * The number must be authorized by the OmniPCX Enterprise numbering policy.
+     * If a forward is already active, it is replaced by the new one.
+     * <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.
@@ -230,7 +237,7 @@ export declare class Routing extends EventEmitter {
      */
     forwardOnNumber(number: string, condition: ForwardCondition, loginName?: string | null): Promise<boolean>;
     /**
-     * Cancels the overflow for the specified user.
+     * Cancels the active overflow for the specified user.
      * <p>
      * This method does nothing and returns `true` if there is no overflow activated.
      * <p>
@@ -240,6 +247,7 @@ export declare class Routing extends EventEmitter {
      *
      * @param loginName the user login name
      * @returns `true` if the operation succeeded; `false` otherwise.
+     * @see overflowOnVoiceMail
      */
     cancelOverflow(loginName?: string | null): Promise<boolean>;
     /**
@@ -254,9 +262,12 @@ export declare class Routing extends EventEmitter {
      */
     getOverflow(loginName?: string | null): Promise<Overflow | null>;
     /**
-     * Activates an overflow on voice mail with the specified condition, for the
+     * Activates an overflow to the voice mail with the specified condition, for the
      * specified user.
      * <p>
+     * The overflow only applies when no forward is active. If an overflow is already
+     * active, it is replaced by the new one.
+     * <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
@@ -270,7 +281,10 @@ export declare class Routing extends EventEmitter {
      */
     overflowOnVoiceMail(condition: OverflowCondition, loginName?: string | null): Promise<boolean>;
     /**
-     * Gets the routing state of the specified user.
+     * Gets the complete routing state of the specified user.
+     * <p>
+     * The routing state includes the forward, overflow, Do Not Disturb and remote
+     * extension activation status in a single 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
@@ -281,11 +295,15 @@ export declare class Routing extends EventEmitter {
      */
     getRoutingState(loginName?: string | null): Promise<RoutingState | null>;
     /**
-     * Asks a snapshot event on the specified user.
+     * Requests a snapshot event to be fired with the current routing state of 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 made while the previous one is still
+     * in progress, it has no effect.
      * <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.
+     * If the session has been opened by an administrator and `loginName` is `null`, the snapshot
+     * is requested for all users. The request is immediately acknowledged but processing may take
+     * a long time if the number of users is large.
      * <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

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

@@ -1 +1 @@
-{"version":3,"file":"o2g-routing.d.ts","sourceRoot":"","sources":["../../../src/services/o2g-routing.ts"],"names":[],"mappings":"AAmBA,OAAO,YAAY,MAAM,QAAQ,CAAC;AAIlC,OAAO,EAAE,gBAAgB,EAAE,MAAM,oCAAoC,CAAC;AACtE,OAAO,EAAE,iBAAiB,EAAE,MAAM,qCAAqC,CAAC;AACxE,OAAO,EAAE,QAAQ,EAAE,MAAM,4BAA4B,CAAC;AACtD,OAAO,EAAE,OAAO,EAAE,MAAM,0BAA0B,CAAC;AACnD,OAAO,EAAE,QAAQ,EAAE,MAAM,2BAA2B,CAAC;AACrD,OAAO,EAAE,mBAAmB,EAAE,MAAM,uCAAuC,CAAC;AAC5E,OAAO,EAAE,YAAY,EAAE,MAAM,gCAAgC,CAAC;AAE9D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;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"}
+{"version":3,"file":"o2g-routing.d.ts","sourceRoot":"","sources":["../../../src/services/o2g-routing.ts"],"names":[],"mappings":"AAmBA,OAAO,YAAY,MAAM,QAAQ,CAAC;AAIlC,OAAO,EAAE,gBAAgB,EAAE,MAAM,oCAAoC,CAAC;AACtE,OAAO,EAAE,iBAAiB,EAAE,MAAM,qCAAqC,CAAC;AACxE,OAAO,EAAE,QAAQ,EAAE,MAAM,4BAA4B,CAAC;AACtD,OAAO,EAAE,OAAO,EAAE,MAAM,0BAA0B,CAAC;AACnD,OAAO,EAAE,QAAQ,EAAE,MAAM,2BAA2B,CAAC;AACrD,OAAO,EAAE,mBAAmB,EAAE,MAAM,uCAAuC,CAAC;AAC5E,OAAO,EAAE,YAAY,EAAE,MAAM,gCAAgC,CAAC;AAE9D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;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;;;;;;;;;;;;;;OAcG;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;;;;;;;;;;;;;OAaG;IACG,aAAa,CAAC,SAAS,GAAE,MAAM,GAAG,IAAW,GAAG,OAAO,CAAC,OAAO,CAAC;IAItE;;;;;;;;;;;;;;;OAeG;IACG,kBAAkB,CAAC,SAAS,EAAE,gBAAgB,EAAE,SAAS,GAAE,MAAM,GAAG,IAAW,GAAG,OAAO,CAAC,OAAO,CAAC;IAIxG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACG,eAAe,CACjB,MAAM,EAAE,MAAM,EACd,SAAS,EAAE,gBAAgB,EAC3B,SAAS,GAAE,MAAM,GAAG,IAAW,GAChC,OAAO,CAAC,OAAO,CAAC;IAInB;;;;;;;;;;;;OAYG;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;;;;;;;;;;;;;;;;;OAiBG;IACG,mBAAmB,CAAC,SAAS,EAAE,iBAAiB,EAAE,SAAS,GAAE,MAAM,GAAG,IAAW,GAAG,OAAO,CAAC,OAAO,CAAC;IAI1G;;;;;;;;;;;;OAYG;IACG,eAAe,CAAC,SAAS,GAAE,MAAM,GAAG,IAAW,GAAG,OAAO,CAAC,YAAY,GAAG,IAAI,CAAC;IAIpF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACG,eAAe,CAAC,SAAS,GAAE,MAAM,GAAG,IAAW,GAAG,OAAO,CAAC,OAAO,CAAC;CAG3E"}

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

@@ -4,8 +4,7 @@ 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:
+ * `Rsi` provides access to the RSI (Routing Service Intelligence) point features:
  * <ul>
  * <li>Makes route selection.</li>
  * <li>Makes digits collection.</li>
@@ -13,143 +12,152 @@ import { RouteSession } from '../types/rsi/route-session';
  * <li>Plays announcements (prompts and/or digits).</li>
  * </ul>
  * <p>
- * To be able to receive the RouteRequest from the OmniPCX Enterprise, the first
- * action is subscribe to rsi events and the second action is to enable the RSI
- * point.
+ * To be able to receive route requests from the OmniPCX Enterprise, the application
+ * must first subscribe to RSI events and then enable the RSI point.
  * <p>
  * Using this service requires having a <b>CONTACTCENTER_RSI</b> license.
  */
 export declare class Rsi extends EventEmitter {
     #private;
     /**
-     * Occurs when a data collection has ended.
+     * Raised when a digit collection session has ended.
      * @event
      */
     static readonly ON_DIGIT_COLLECTED = "OnDigitCollected";
     /**
-     * Raised from a RSI point when a tone generation is started.
+     * Raised from an RSI point when a tone generation starts.
      * @event
      */
     static readonly ON_TONE_GENERATED_START = "OnToneGeneratedStart";
     /**
-     * Raised from a RSI point when a tone generation is stopped.
+     * Raised from an RSI point when a tone generation stops.
      * @event
      */
     static readonly ON_TONE_GENERATED_STOP = "OnToneGeneratedStop";
     /**
-     * Raised from a Routing point to close a route session (routing crid is no longer valid).
+     * Raised from a routing point to close a route session (the routing Crid is no longer valid).
      * @event
      */
     static readonly ON_ROUTE_END = "OnRouteEnd";
     /**
-     * Raised from a Routing point to request a route.
+     * Raised from a routing point to request a route selection.
      * @event
      */
     static readonly ON_ROUTE_REQUEST = "OnRouteRequest";
     /**
-     * Gets the configured Rsi points.
+     * Gets the configured RSI points.
+     *
+     * @returns the list of {@link RsiPoint} objects representing all declared RSI points, or `null` in case of error.
      */
     getRsiPoints(): Promise<RsiPoint[] | null>;
     /**
-     * Enables the specified rsi point.
+     * Enables the specified RSI point.
      *
-     * @param rsiNumber the rsi point extension number.
-     * @param [backup=false] true to enable the RSI point in backup mode.
+     * @param rsiNumber the RSI point extension number
+     * @param backup `true` to enable the RSI point in backup mode
+     * @returns `true` in case of success; `false` otherwise.
      */
     enableRsiPoint(rsiNumber: string, backup?: boolean): Promise<boolean>;
     /**
-     * Disables the specified rsi point.
+     * Disables the specified RSI point.
      *
-     * @param rsiNumber the rsi point extension number.
+     * @param rsiNumber the RSI point extension number
+     * @returns `true` in case of success; `false` otherwise.
      */
     disableRsiPoint(rsiNumber: string): Promise<boolean>;
     /**
-     * Starts a digits collection for the specified rsi, on the specified call.
+     * Starts a digits collection on the specified RSI point, for the specified call.
      *
-     * @param rsiNumber          the rsi point extension number
+     * @param rsiNumber          the RSI point extension number
      * @param callRef            the call reference
-     * @param numChars           the optionnal number of digits to collect. The
-     *                           digit collection is stopped when this number is
-     *                           reached
-     * @param flushChar          the optional character used to stop the digit
-     *                           collection when pressed.
-     * @param timeout            optional timeout in second. Stop the digit
-     *                           collection after this time elapses.
+     * @param numChars           the optional number of digits to collect; the digit collection stops when this number is reached
+     * @param flushChar          the optional character that stops the digit collection when pressed
+     * @param timeout            the optional timeout in seconds; the digit collection stops when this delay elapses
      * @param additionalCriteria extension criteria used to collect digits
+     * @returns a unique identifier (Crid) for this digit collection session, or `null` in case of error.
      * @see {@link ON_DIGIT_COLLECTED} event
      * @see {@link stopCollectDigits}
      */
     startCollectDigits(rsiNumber: string, callRef: string, numChars: number, flushChar?: string | null, timeout?: number | null, additionalCriteria?: AdditionalDigitCollectionCriteria | null): Promise<boolean | null>;
     /**
-     * Stops the specified digits collection.
+     * Stops the specified digits collection on the specified RSI point.
      *
-     * @param rsiNumber the rsi point extension number
-     * @param callCrid  the digit collection identifier
-     * @see {@link startCollectDigits}.
+     * @param rsiNumber the RSI point extension number
+     * @param collCrid  the digit collection identifier returned by {@link startCollectDigits}
+     * @returns `true` in case of success; `false` otherwise.
+     * @see {@link startCollectDigits}
      */
     stopCollectDigits(rsiNumber: string, collCrid: string): Promise<boolean>;
     /**
      * Plays the specified tone on the specified call.
      *
-     * @param rsiNumber the rsi point extension number
+     * @param rsiNumber the RSI point extension number
      * @param callRef   the call reference
      * @param tone      the tone to play
-     * @param duration  the duration the tone is played (in second)
-     * @see {@link ON_TONE_GENERATED_START} event.
-     * @see {@link cancelTone}.
+     * @param duration  the duration the tone is played, in seconds
+     * @returns `true` in case of success; `false` otherwise.
+     * @see {@link ON_TONE_GENERATED_START} event
+     * @see {@link cancelTone}
      */
     playTone(rsiNumber: string, callRef: string, tone: Tones, duration: number): Promise<boolean>;
     /**
-     * Cancels playing a tone on the specified call.
+     * Cancels the tone currently playing on the specified call.
      *
-     * @param rsiNumber the rsi point extension number
+     * @param rsiNumber the RSI point extension number
      * @param callRef   the call reference
-     * @see {@link ON_TONE_GENERATED_STOP} event.
+     * @returns `true` in case of success; `false` otherwise.
+     * @see {@link ON_TONE_GENERATED_STOP} event
      * @see {@link playTone}
      */
     cancelTone(rsiNumber: string, callRef: string): Promise<boolean>;
     /**
      * Plays the specified voice guide on the specified call.
      *
-     * @param rsiNumber   the rsi point extension number
+     * @param rsiNumber   the RSI point extension number
      * @param callRef     the call reference
-     * @param guideNumber the voice guide number as defined in the OmniPcx
-     *                    Enterprise
-     * @param duration    an optional duration for the voice guide in second.
+     * @param guideNumber the voice guide number as defined in the OmniPCX Enterprise
+     * @param duration    an optional duration for the voice guide, in seconds
+     * @returns `true` in case of success; `false` otherwise.
      * @see {@link ON_TONE_GENERATED_START}
      */
     playVoiceGuide(rsiNumber: string, callRef: string, guideNumber: number, duration?: number | null): Promise<boolean>;
     /**
-     * Ends a route session.
+     * Ends a route session, indicating that no route will be selected.
      *
-     * @param rsiNumber the rsi point extension number
+     * @param rsiNumber the RSI point extension number
      * @param routeCrid the routing session unique identifier
-     * @see {@link ON_ROUTE_REQUEST} event.
+     * @returns `true` in case of success; `false` otherwise.
+     * @see {@link ON_ROUTE_REQUEST} event
      */
     routeEnd(rsiNumber: string, routeCrid: string): Promise<boolean>;
     /**
-     * Selects a route for the specified route session.
-     * @param rsiNumber        the rsi point extension number
+     * Selects a route as a response to a route request.
+     * <p>
+     * `callingLine` can be used to change the identity of the calling number presented to the called party.
+     *
+     * @param rsiNumber        the RSI point extension number
      * @param routeCrid        the routing session unique identifier
      * @param selectedRoute    the selected route number
-     * @param callingLine      an optional calling line value that will be presented
-     *                         to the selected route
-     * @param associatedData   the optional associated data to attach to the call
-     * @param routeToVoiceMail 'true' if the selected route is the voice mail; 'false' otherwise
-     * @see {@link ON_ROUTE_REQUEST} event.
+     * @param callingLine      an optional calling line number that will be presented to the selected route
+     * @param associatedData   optional correlator data to attach to the call
+     * @param routeToVoiceMail `true` if the selected route is the voice mail; `false` otherwise
+     * @returns `true` in case of success; `false` otherwise.
+     * @see {@link ON_ROUTE_REQUEST} event
      */
     routeSelect(rsiNumber: string, routeCrid: string, selectedRoute: string, callingLine?: string | null, associatedData?: string | null, routeToVoiceMail?: boolean | null): Promise<boolean>;
     /**
-     * Gets the list of existing route sessions for the specified rsi point.
+     * Gets the list of existing route sessions for the specified RSI point.
      *
-     * @param rsiNumber the rsi point extension number
+     * @param rsiNumber the RSI point extension number
+     * @returns the list of {@link RouteSession} objects representing the route sessions in progress, or `null` in case of error.
      */
     getRouteSessions(rsiNumber: string): Promise<RouteSession[] | null>;
     /**
-     * Return the specified route session.
+     * Returns the specified route session.
      *
-     * @param rsiNumber the rsi point extension number
+     * @param rsiNumber the RSI point extension number
      * @param routeCrid the routing session unique identifier
+     * @returns the {@link RouteSession} object on success; `null` in case of error or if no such route session exists.
      */
     getRouteSession(rsiNumber: string, routeCrid: string): Promise<RouteSession | null>;
 }

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

@@ -1 +1 @@
-{"version":3,"file":"o2g-rsi.d.ts","sourceRoot":"","sources":["../../../src/services/o2g-rsi.ts"],"names":[],"mappings":"AAmBA,OAAO,YAAY,MAAM,QAAQ,CAAC;AAElC,OAAO,EAAE,iCAAiC,EAAE,MAAM,sCAAsC,CAAC;AACzF,OAAO,EAAE,KAAK,EAAE,MAAM,oBAAoB,CAAC;AAS3C,OAAO,EAAE,QAAQ,EAAE,MAAM,wBAAwB,CAAC;AAClD,OAAO,EAAE,YAAY,EAAE,MAAM,4BAA4B,CAAC;AAE1D;;;;;;;;;;;;;;;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;;;;;OAKG;IACG,cAAc,CAAC,SAAS,EAAE,MAAM,EAAE,MAAM,GAAE,OAAe,GAAG,OAAO,CAAC,OAAO,CAAC;IAIlF;;;;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"}
+{"version":3,"file":"o2g-rsi.d.ts","sourceRoot":"","sources":["../../../src/services/o2g-rsi.ts"],"names":[],"mappings":"AAmBA,OAAO,YAAY,MAAM,QAAQ,CAAC;AAElC,OAAO,EAAE,iCAAiC,EAAE,MAAM,sCAAsC,CAAC;AACzF,OAAO,EAAE,KAAK,EAAE,MAAM,oBAAoB,CAAC;AAS3C,OAAO,EAAE,QAAQ,EAAE,MAAM,wBAAwB,CAAC;AAClD,OAAO,EAAE,YAAY,EAAE,MAAM,4BAA4B,CAAC;AAE1D;;;;;;;;;;;;;GAaG;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;;;;OAIG;IACG,YAAY,IAAI,OAAO,CAAC,QAAQ,EAAE,GAAG,IAAI,CAAC;IAIhD;;;;;;OAMG;IACG,cAAc,CAAC,SAAS,EAAE,MAAM,EAAE,MAAM,GAAE,OAAe,GAAG,OAAO,CAAC,OAAO,CAAC;IAIlF;;;;;OAKG;IACG,eAAe,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAI1D;;;;;;;;;;;;OAYG;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;;;;;;;OAOG;IACG,iBAAiB,CAAC,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAI9E;;;;;;;;;;OAUG;IACG,QAAQ,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAInG;;;;;;;;OAQG;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;;;;;;;OAOG;IACG,QAAQ,CAAC,SAAS,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAItE;;;;;;;;;;;;;OAaG;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;;;;;OAKG;IACG,gBAAgB,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,EAAE,GAAG,IAAI,CAAC;IAIzE;;;;;;OAMG;IACG,eAAe,CAAC,SAAS,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,GAAG,IAAI,CAAC;CAG5F"}