o2g-node-sdk 1.0.0

package/dist/o2g-pbx-mngt.d.ts

@@ -0,0 +1,146 @@
+import PbxManagementRest from "./internal/rest/pbx-mngt-rest";
+import { Model } from "./types/pbxmngt/model";
+import { PbxAttribute } from "./types/pbxmngt/pbx-attribute";
+import { PbxObject } from "./types/pbxmngt/pbx-object";
+import { Pbx } from "./types/pbxmngt/pbxmngt-types";
+import { Filter } from "./types/pbxmngt/filter";
+import EventEmitter from "events";
+import { EventRegistry } from "./internal/events/event-dispatcher";
+/**
+ * PbxManagement service allows an administrator to manage an OmniPcx
+ * Enterprise, that is to create/modify/delete any object or sub-object in the
+ * OmniPcx Enterprise object model. Using this service requires having a
+ * <b>MANAGEMENT</b> license.
+ * <p>
+ * <b>WARNING:</b> Using this service requires to have a good knowledge of the
+ * OmniPCX Enterprise object model.
+ * <p>
+ * The service uses two kinds of resource: the object model resource and the
+ * object instance resource.
+ * <p><b><u>The object model</u></b>: The object model can be retrieved for the whole Pbx
+ * or for a particular object. It provides the detail of object attributes:
+ * whether the attribute is mandatory/optional in the object creation, what
+ * range of value is authorized, what are the possible enumeration value.
+ * <p><b><u>The object instance</u></b>: It is used to create, modify, retrieve or remove
+ * any instances of any object, giving the reference of this object. For the
+ * creation or the modification of an object, the body must be compliant with
+ * the object model.
+ * <p>
+ * The list of sub-objects which are returned by a get instance of an object
+ * corresponds to the relative path of the first instanciable objects in the
+ * hierarchy in order to be able by recursion to build the path to access to any
+ * object and sub-object.
+ * <p>
+ * When access to an object which is a sub-object, the full path must be given :
+ * {object1Name}/{object1Id}/{object2Name}/{object2Id}/..../{objectxName}/{objectxId}.
+ */
+export declare class PbxManagement extends EventEmitter {
+    private readonly _pbxMngtRest;
+    /**
+     * Occurs when a PBX object instance is created.
+     * Only Object Subscriber is concerned by this event.
+     * @event
+     */
+    static readonly ON_PBX_OBJECT_INSTANCE_CREATED = "OnPbxObjectInstanceCreated";
+    /**
+     * Occurs when a PBX object instance is deleted.
+     * Only Object Subscriber is concerned by this event.
+     * @event
+     */
+    static readonly ON_PBX_OBJECT_INSTANCE_DELETED = "OnPbxObjectInstanceDeleted";
+    /**
+     * Occurs when a PBX object instance is modified.
+     * Only Object Subscriber is concerned by this event.
+     * @event
+     */
+    static readonly ON_PBX_OBJECT_INSTANCE_MODIFIED = "OnPbxObjectInstanceModified";
+    /**
+     *
+     * @internal
+     */
+    constructor(_pbxMngtRest: PbxManagementRest, eventRegistry: EventRegistry);
+    /**
+     * Gets the list of OmniPCX Enterprise nodes connected on this O2G server.
+     */
+    getPbxs(): Promise<number[] | null>;
+    /**
+    * Gets the OmniPCX Enterprise specified by its node id.
+    *
+    * @param nodeId the PCX Enterprise node id
+    */
+    getPbx(nodeId: number): Promise<Pbx | null>;
+    /**
+     * Get the description of the data model for the specified object on the
+     * specified OmniPCX Enterprise node.
+     * <p>
+     * If 'objectName' is 'null', the global object model of the OmniPCX Enterprise node is returned.
+     *
+     * @param nodeId     the OmniPCX Enterprise node id
+     * @param objectName the object name
+     */
+    getObjectModel(nodeId: number, objectName?: string | null): Promise<Model | null>;
+    /**
+     * Gets the node(root) object.
+     *
+     * @param nodeId the OmniPCX Enterprise node id
+     */
+    getNodeObject(nodeId: number): Promise<PbxObject | null>;
+    /**
+     * Gets the object specified by its instance definition and its instance id.
+     *
+     * @param nodeId                   the OmniPCX Enterprise node id
+     * @param objectInstanceDefinition the object instance definition
+     * @param objectId                 the object instance id
+     * @param attributes               the optional attributes to retrieve. It can be a string with a comma separated attribute name, or an array of PbxAtribute objects.
+     */
+    getObject(nodeId: number, objectInstanceDefinition: string, objectId: string, attributes?: string | PbxAttribute[] | null): Promise<PbxObject | null>;
+    /**
+     * Queries the list of object instances that match the specified filter.
+     * A filter can be built using the {@link Filter} class, or it can be a string object.
+     * @example
+     * ```typescript
+     *      // Using a Filter object
+     *      let filter = o2g.types.pbxmngt.Filter.create(
+     *                          "StationType",
+     *                          o2g.types.pbxmngt.AttributeFilter.Equals,
+     *                          "ANALOG");
+     *      let objectInstances = await o2g.pbxManagement.getObjectInstances(5, "Subscriber", filter);
+     *
+     *      // Using a string as a filter
+     *      objectInstances = await o2g.pbxManagement.getObjectInstances(5, "Subscriber", "StationType==ANALOG");
+     *
+     * ```
+     *
+     * @param nodeId the OmniPCX Enterprise node id
+     * @param objectInstanceDefinition the object instance definition
+     * @param filter a filter to query the instances ({@link Filter} object or string)
+     */
+    getObjectInstances(nodeId: number, objectInstanceDefinition: string, filter?: string | Filter | null): Promise<string[] | null>;
+    /**
+     * Changes one or several attribute values of the specified object.
+     * @param nodeId the OmniPCX Enterprise node id
+     * @param objectInstanceDefinition the object instance definition
+     * @param objectId the object instance id
+     * @param attributes the array of attributes to change
+     */
+    setObject(nodeId: number, objectInstanceDefinition: string, objectId: string, attributes: PbxAttribute[]): Promise<boolean>;
+    /**
+     * Deletes the specified instance of object.
+     * <p>
+     * The "<i>FORCED_DELETE</i>" action is not available for all object.
+     * Check the availability in the {@link Model} model corresponding to this object.
+     * This option can be used, for exemple, to delete a {@code Subscriber} having voice mails in his mail box.
+     * @param nodeId the OmniPCX Enterprise node id
+     * @param objectInstanceDefinition the object instance definition
+     * @param objectId the object instance id
+     * @param forceDelete Use the "<i>FORCED_DELETE</i>" action to delete the object.
+     */
+    deleteObject(nodeId: number, objectInstanceDefinition: string, objectId: string, forceDelete?: boolean): Promise<boolean>;
+    /**
+     * Creates a new object with the specified collection of attributes
+     * @param nodeId the OmniPCX Enterprise node id
+     * @param objectInstanceDefinition the object instance definition
+     * @param attributes the array of attributes to set at this object creation.
+     */
+    createObject(nodeId: number, objectInstanceDefinition: string, attributes: PbxAttribute[]): Promise<boolean>;
+}

package/dist/o2g-phone-set-prog.d.ts

@@ -0,0 +1,29 @@
+import PhoneSetProgrammingRest from "./internal/rest/phone-set-prog-rest";
+import { Device } from "./types/users/users-types";
+import { DynamicState } from "./types/phoneset/phoneset-types";
+import { Pin } from "./types/phoneset/pin";
+import { ProgrammableKey } from "./types/phoneset/programmable-key";
+import { SoftKey } from "./types/phoneset/softkey";
+export declare class PhoneSetProgramming {
+    private _phoneSetProgrRest;
+    constructor(phoneSetProgrRest: PhoneSetProgrammingRest);
+    getDevices(loginName: string | null): Promise<Device[] | null>;
+    getDevice(loginName: string | null, deviceId: string): Promise<Device | null>;
+    getProgrammableKeys(loginName: string | null, deviceId: string): Promise<ProgrammableKey[] | null>;
+    getProgrammedKeys(loginName: string | null, deviceId: string): Promise<ProgrammableKey[] | null>;
+    setProgrammableKey(loginName: string | null, deviceId: string, key: ProgrammableKey): Promise<boolean>;
+    deleteProgrammableKey(loginName: string | null, deviceId: string, position: number): Promise<boolean>;
+    getSoftKeys(loginName: string | null, deviceId: string): Promise<SoftKey[] | null>;
+    setSoftKey(loginName: string | null, deviceId: string, key: SoftKey): Promise<boolean>;
+    deleteSoftKey(loginName: string | null, deviceId: string, position: number): Promise<boolean>;
+    lockDevice(loginName: string | null, deviceId: string): Promise<boolean>;
+    unlockDevice(loginName: string | null, deviceId: string): Promise<boolean>;
+    enableCampon(loginName: string | null, deviceId: string): Promise<boolean>;
+    disableCampon(loginName: string | null, deviceId: string): Promise<boolean>;
+    getPinCode(loginName: string | null, deviceId: string): Promise<Pin | null>;
+    setPinCode(loginName: string | null, deviceId: string, code: Pin): Promise<boolean>;
+    getDynamicState(loginName: string | null, deviceId: string): Promise<DynamicState | null>;
+    setAssociate(loginName: string | null, deviceId: string, associate: string): Promise<boolean>;
+    activateRemoteExtension(loginName: string | null, deviceId: string): Promise<boolean>;
+    deactivateRemoteExtension(loginName: string | null, deviceId: string): Promise<boolean>;
+}

package/dist/o2g-routing.d.ts

@@ -0,0 +1,267 @@
+import EventEmitter from "events";
+import RoutingRest from "./internal/rest/routing-rest";
+import { Forward, ForwardCondition } from "./types/routing/forward";
+import { Overflow, OverflowCondition } from "./types/routing/overflow";
+import { RoutingCapabilities } from "./types/routing/routing-capability";
+import { RoutingState } from "./types/routing/routing-state";
+import { DndState } from "./types/routing/routing-types";
+import { EventRegistry } from "./internal/events/event-dispatcher";
+/**
+ * The Routing service allows a user to manage forward, overflow, DoNotDisturb
+ * and activation of his 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 Condition} 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 setRemoteExtensionActivation} to activate the remote extension. <br>
+ * <h2>Eventing:</h2> For each routing modification, a
+ * {@link ON_ROUTING_STATE_CHANGED} event is raised.
+ */
+export declare class Routing extends EventEmitter {
+    private readonly _routingRest;
+    /**
+     * Raised for each routing modification.
+     * @event
+     */
+    static readonly ON_ROUTING_STATE_CHANGED = "OnRoutingStateChanged";
+    /**
+     *
+     * @internal
+     */
+    constructor(_routingRest: RoutingRest, eventRegistry: EventRegistry);
+    /**
+     * Activate the Do Not Disturb for the specified user.
+     * <p>
+     * This method does nothing and return '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
+     */
+    activateDnd(loginName?: string | null): Promise<boolean>;
+    /**
+     * Cancel the Do Not Disturb for the specified user.
+     * <p>
+     * This method does nothing and return '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
+     */
+    cancelDnd(loginName?: string | null): Promise<boolean>;
+    /**
+     * Get 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
+     */
+    getDndState(loginName?: string | null): Promise<DndState | null>;
+    /**
+     * Allows to know what the specified user is allowed to do.
+     * <p>
+     * If the session has been opened for a user, the 'logiName' parameter is
+     * ignored, but it is mandatory if the session has been opened by an
+     * administrator.
+     *
+     * @param loginName the user login name
+     */
+    getCapabilities(loginName?: string | null): Promise<RoutingCapabilities | null>;
+    /**
+     * Activate the remote extension device for the specified  user.
+     * <p>
+     * When the remote extension is activated, it rings on incoming call on the user
+     * 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
+     */
+    activateRemoteExtension(loginName?: string | null): Promise<boolean>;
+    /**
+     * Deactivate the remote extension device for the specified  user.
+     * <p>
+     * When it is deactivated, it never rings, but it can 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
+     */
+    deactivateRemoteExtension(loginName?: string | null): Promise<boolean>;
+    /**
+     * Get 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
+     */
+    getForward(loginName?: string | null): Promise<Forward | null>;
+    /**
+     * Cancel the forward for the specified user.
+     * <p>
+     * This method does nothing and return '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
+     */
+    cancelForward(loginName?: string | null): Promise<boolean>;
+    /**
+     * Set 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
+     */
+    forwardOnVoiceMail(condition: ForwardCondition, loginName?: string | null): Promise<boolean>;
+    /**
+     * Set 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.
+     *
+     * @param number    the phone number on which the forward is activated
+     * @param condition the forward condition
+     * @param loginName the user login name
+     */
+    forwardOnNumber(number: string, condition: ForwardCondition, loginName?: string | null): Promise<boolean>;
+    /**
+     * Cancel the overflow for the specified user.
+     * <p>
+     * This method does nothing and return '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
+     */
+    cancelOverflow(loginName?: string | null): Promise<boolean>;
+    /**
+     * Get 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
+     */
+    getOverflow(loginName?: string | null): Promise<Overflow | null>;
+    /**
+     * Activate 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
+     */
+    overflowOnVoiceMail(condition: OverflowCondition, loginName?: string | null): Promise<boolean>;
+    /**
+     * Get 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
+     */
+    getRoutingState(loginName?: string | null): Promise<RoutingState | null>;
+    /**
+     * Asks a snapshot event on the specified user.
+     * <p>
+     * The event OnRoutingStateChanged will contain the DynamicState
+     * (forward/overflow/dnd state). If a second request is asked since 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.
+     *
+     * @param loginName the login name
+     */
+    requestSnapshot(loginName?: string | null): Promise<boolean>;
+}

package/dist/o2g-rsi.d.ts

@@ -0,0 +1,160 @@
+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";
+/**
+ * RsiService provides access to th RSI (Routing Service Intelligence)
+ * points features:
+ * <ul>
+ * <li>Makes route selection.</li>
+ * <li>Makes digits collection.</li>
+ * <li>Plays voice guides or tones.</li>
+ * <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.
+ * <p>
+ * Using this service requires having a <b>CONTACTCENTER_RSI</b> license.
+ */
+export declare class Rsi extends EventEmitter {
+    private readonly _rsiRest;
+    /**
+     * Occurs when a data collection has ended.
+     * @event
+     */
+    static readonly ON_DIGIT_COLLECTED = "OnDigitCollected";
+    /**
+     * Raised from a RSI point when a tone generation is started.
+     * @event
+     */
+    static readonly ON_TONE_GENERATED_START = "OnToneGeneratedStart";
+    /**
+     * Raised from a RSI point when a tone generation is stopped.
+     * @event
+     */
+    static readonly ON_TONE_GENERATED_STOP = "OnToneGeneratedStop";
+    /**
+     * Raised from a Routing point to close a route session (routing crid is no longer valid).
+     * @event
+     */
+    static readonly ON_ROUTE_END = "OnRouteEnd";
+    /**
+     * Raised from a Routing point to request a route.
+     * @event
+     */
+    static readonly ON_ROUTE_REQUEST = "OnRouteRequest";
+    /**
+     *
+     * @internal
+     */
+    constructor(_rsiRest: RsiRest, eventRegistry: EventRegistry);
+    /**
+     * Gets the configured Rsi points.
+     */
+    getRsiPoints(): Promise<RsiPoint[] | null>;
+    /**
+     * Enables the specified rsi point.
+     *
+     * @param rsiNumber the rsi point extension number
+     */
+    enableRsiPoint(rsiNumber: string): Promise<boolean>;
+    /**
+     * Disables the specified rsi point.
+     *
+     * @param rsiNumber the rsi point extension number.
+     */
+    disableRsiPoint(rsiNumber: string): Promise<boolean>;
+    /**
+     * Starts a digits collection for the specified rsi, on the specified call.
+     *
+     * @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 additionalCriteria extension criteria used to collect digits
+     * @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.
+     *
+     * @param rsiNumber the rsi point extension number
+     * @param callCrid  the digit collection identifier
+     * @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 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}.
+     */
+    playTone(rsiNumber: string, callRef: string, tone: Tones, duration: number): Promise<boolean>;
+    /**
+     * Cancels playing a tone on the specified call.
+     *
+     * @param rsiNumber the rsi point extension number
+     * @param callRef   the call reference
+     * @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 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.
+     * @see {@link ON_TONE_GENERATED_START}
+     */
+    playVoiceGuide(rsiNumber: string, callRef: string, guideNumber: number, duration?: number | null): Promise<boolean>;
+    /**
+     * Ends a route session.
+     *
+     * @param rsiNumber the rsi point extension number
+     * @param routeCrid the routing session unique identifier
+     * @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
+     * @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.
+     */
+    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.
+     *
+     * @param rsiNumber the rsi point extension number
+     */
+    getRouteSessions(rsiNumber: string): Promise<RouteSession[] | null>;
+    /**
+     * Return the specified route session.
+     *
+     * @param rsiNumber the rsi point extension number
+     * @param routeCrid the routing session unique identifier
+     */
+    getRouteSession(rsiNumber: string, routeCrid: string): Promise<RouteSession | null>;
+}