@finsemble/finsemble-ui 10.0.0-iocd.8 → 10.0.3-beta.2

package/platform/preloads/BloombergBridgeClient.d.ts

@@ -1,454 +1,454 @@
-import { RouterMessage, QueryResponse } from "../../clients/routerClient";
-import { StandardCallback, CallbackError, StandardError } from "../../types";
-/**
- * Interface representing an event handler for connection events, which are fired
- * when the BloombergBridge connects or disconnects from the terminal.
- */
-export declare type BBGConnectionStatusMessage = {
-    registered: boolean;
-    enabled: boolean;
-    connectedTo: string;
-};
-export interface BBGConnectionEventListener extends StandardCallback {
-    (
-    /** Errors received from Terminal connect - most likely on registration of
-     * the listener. */
-    err: string | Error, 
-    /** Flags indicating if the BloombergBridge is enabled, whether it is registered
-     * with the terminal through terminal connect and, if connected, to what address.
-     * `registered` be true for any of the client functions to work.
-     */
-    response: RouterMessage<BBGConnectionStatusMessage>): void;
-}
-/**
- * Interface representing an event handler for Bloomberg group events.
- */
-export interface BBGGroupEventListener extends StandardCallback {
-    (
-    /** Errors received from Terminal connect - most likely on registration of
-     * the listener. */
-    err: string | Error, 
-    /** Details relating to BlpComponentContextChangedEventArgs messages received from
-     * Terminal connect. These will usually relate to single group and reflect changes
-     * in the group's context or creation of a group, which will generate context changed
-     * event, but for a group that did not previously exist.*/
-    response: RouterMessage<{
-        group: BBGGroup;
-        groups: BBGGroup[];
-    }>): void;
-}
-/**
- * Interface representing a Bloomberg worksheet.
- */
-export interface BBGWorksheet {
-    /** The name of the worksheet (non-unique). */
-    id: string;
-    /** The name of the worksheet assigned by the Bloomberg terminal and globally unique. */
-    name: string;
-    /** A flag indicating the Worksheet's IsActive status. */
-    isActive: boolean;
-    /** The list of securities appearing in the worksheet. */
-    securities: string[];
-}
-/**
- * @param {string} type The type of the group: security or monitor.
- * @param {string} name The name of the group assigned by the Bloomberg terminal, usually takes =
- * the form 'Group-A'.
- * @param {string} value the current value of the group.
- */
-export interface BBGGroup {
-    type: string;
-    name: string;
-    value: string;
-}
-/**
- * Client class for communicating with the Finsemble Bloomberg Bridge over the the Finsemble Router,
- * which in turn communicates with the Bloomberg Terminal via the Terminal Connect and BLP APIs.
- *
- * This Class may either be imported into code and initialized by passing in an instance
- * of the Finsemble RouterClient and Logger (e.g. in Finsemble Custom Desktop Service) or
- * used as a preload to be applied to a component, where it will be automatically initialized
- * via instances of the RouterClient and Logger referenced from `FSBL.Clients`.
- *
- * @experimental
- */
-export declare class BloombergBridgeClient {
-    private connectionEventListener;
-    private groupEventListener;
-    private routerClient;
-    private logger;
-    /**
-     * BloombergBridgeClient constructor.
-     * @example Instantiating the client in a Finsemble component:
-     * ```Javascript
-     * let bbg = new BloombergBridgeClient(FSBL.Clients.RouterClient, FSBL.Clients.Logger);
-     * ```
-     *
-     * Instantiating the client in a Finsemble service:
-     * ```Javascript
-     * let bbg = new BloombergBridgeClient();
-     * ```
-     */
-    constructor();
-    /**
-     * Set a handler function for connection events.
-     *
-     * Note that only one handler function is permitted, hence calling
-     * this multiple times will simply replace the existing handler.
-     *
-     * @param cb Callback
-     * @example
-     * ```Javascript
-     * let connectionEventHandler = (err, resp) => {
-     *     if (!err && resp && resp.registered) {
-     *         showConnectedIcon();
-     *     } else {
-     *         showDisconnectedIcon();
-     *     }
-     * };
-     * bbg.setConnectionEventListener(connectionEventHandler);
-     * ```
-     */
-    setConnectionEventListener(cb: BBGConnectionEventListener): void;
-    /**
-     * Remove the current connection event handler.
-     * @example
-     * ```Javascript
-     * bbg.removeConnectionEventListener();
-     * ```
-     */
-    removeConnectionEventListener(): void;
-    /**
-     * Set a handler function for Launchpad group context changed events, which
-     * are fired when a group's context changes or a new group is created.
-     *
-     * Note that only one handler function is permitted, hence calling
-     * this multiple times will simply replace the existing handler.
-     * @param cb Handler function to call on group context change events
-     * @example
-     * ```Javascript
-     * bbg.setGroupEventListener((err, response) => {
-     *     if (!err) {
-     *         if (response.data.group && response.data.group.type == "monitor") {
-     *             Logger.log("Monitor event:\n" + JSON.stringify(response.data, null, 2));
-     *         } else {
-     *             Logger.log("Security event:\n" + JSON.stringify(response.data, null, 2));
-     *         }
-     *     } else {
-     *             Logger.error("Error returned from setGroupEventListener", err);
-     *     }
-     * });
-     * ```
-     */
-    setGroupEventListener(cb: BBGGroupEventListener): void;
-    /**
-     * Remove the current group context changed event handler.
-     * @example
-     * ```Javascript
-     * bbg.removeGroupEventListener();
-     * ```
-     */
-    removeGroupEventListener(): void;
-    /**
-     * Set the connection state for Bloomberg bridge, i.e. whether it is enabled or not.
-     * Note that the remote connection config should only be changed while the connection is
-     * disabled or disconnected, as it is read when attempting to connect.
-     * @param enabled Boolean flag indicating whether the bridge should connect to Bloomberg.
-     * If set false while connected, the bridge will automatically disconnect.
-     * @param cb Optional callback that will return response as true if we have successfully set the
-     * connect states.
-     * @example
-     * ```Javascript
-     * bbg.setConnectState(true);
-     * bbg.setConnectState(false, (err, resp) => { ... });
-     * ```
-     */
-    setEnabled(enabled: boolean, cb?: StandardCallback): void;
-    /**
-     * Check that Bloomberg bridge is connected to the Bloomberg Terminal.
-     * @param cb Callback for connection response that will return response as true if we are
-     * connected.
-     * @example
-     * ```Javascript
-     * let checkConnectionHandler = (err, registered) => {
-     *     if (!err && registered) {
-     *         showConnectedIcon();
-     *     } else {
-     *         showDisconnectedIcon();
-     *     }
-     * };
-     * bbg.checkConnection(checkConnectionHandler);
-     * ```
-     */
-    checkConnection(cb: (err: string | CallbackError | Error | null, response: boolean | null) => void): void;
-    /**
-     * Internal function used to send a Query to the BBG_run_terminal_function responder of
-     * BloombergBridge,
-     * which implements the majority functions for the BloombergBridgeClient.
-     * @param message The query data to pass.
-     * @param message.function Required field that determines which function to run.
-     * @param cb Callback
-     * @private
-     */
-    queryBloombergBridge(message: {
-        function: string;
-    }, cb: StandardCallback): void;
-    /**
-     * Internal function used to return a call back that will wrap the supplied callback and log all
-     * responses
-     * from the Bloomberg Bridge to aid debugging.
-     * @param cb Callback
-     * @private
-     */
-    apiResponseHandler(cb: StandardCallback): (err: StandardError, response: QueryResponse<{
-        status: boolean;
-        message?: string;
-    }>) => void;
-    /**
-     * Run a function in one of the 4 Bloomberg panel windows.
-     * @param mnemonic The mnemonic of the Bloomberg command to run on a panel
-     * @param securities (optional) An array of strings representing one or more securities
-     * to pass to the function.
-     * @param panel Panel number to run the command on (accepts values "1", "2", "3" or
-     * "4")
-     * @param tails (optional) parameters passed to the function
-     * @param cb Callback
-     * @example
-     * ```Javascript
-     * let mnemonic = "DES";
-     * let securities = ["MSFT US Equity"];
-     * let panel = 3;
-     * let tails = null;
-     * bbg.runBBGCommand(mnemonic, securities, panel, tails, (err, response) => {
-     *     if (!err) {
-     *         Logger.log(`Ran command "${mnemonic}" on panel ${panel}`);
-     *     } else {
-     *         Logger.error("Error returned from runBBGCommand", err);
-     *     }
-     * });
-     * ```
-     */
-    runBBGCommand(mnemonic: string, securities: string[], panel: number, tails: string, cb: (err: StandardError, response: {
-        status: boolean;
-    }) => void): void;
-    /**
-     * Create a new worksheet with the specified securities and name.
-     * @param worksheetName Name for the worksheet.
-     * @param securities An array of strings representing one or more securities.
-     * @param cb Callback
-     * @example
-     * ```Javascript
-     * let securities = ["TSLA US Equity", "AMZN US Equity"];
-     * bbg.runCreateWorksheet(worksheetName, securities, (err, response) => {
-     *     if (!err) {
-     *         if (response && response.worksheet) {
-     *             //Id assigned to the worksheet
-     *             let worksheetId = response.worksheet.id;
-     *             //List of securities resolved by Bloomberg from the input list, unresolvable securities will be removed
-     *             let workSheetSecurities = response.worksheet.securities;
-     *         } else {
-     *             Logger.error("invalid response from runCreateWorksheet", response);
-     *         }
-     *     } else {
-     *         Logger.error("Error returned from runCreateWorksheet", err);
-     *     }
-     * });
-     * ```
-     */
-    runCreateWorksheet(worksheetName: string, securities: string[], cb: (err: StandardError, response: {
-        status: boolean;
-        worksheet: BBGWorksheet;
-    }) => void): void;
-    /**
-     * Retrieve all worksheets for the user.
-     * @param cb Callback
-     * @example
-     * ```Javascript
-     * bbg.runGetAllWorksheets((err, response) => {
-     *     if (!err) {
-     *         if (response && response.worksheets && Array.isArray(response.worksheets)) {
-     *             response.worksheets.forEach(worksheet => {
-     *                 let worksheetName = worksheet.name;
-     *                 let worksheetId = worksheet.id;
-     *                 ...
-     *             });
-     *         } else {
-     *             Logger.error("invalid response from runGetAllWorksheets", response);
-     *         }
-     *     } else {
-     *         Logger.error("Error returned from runGetAllWorksheets", err);
-     *     }
-     * });
-     * ```
-     */
-    runGetAllWorksheets(cb: (err: StandardError, response: {
-        status: boolean;
-        worksheets: BBGWorksheet[];
-    }) => void): void;
-    /**
-     * Retrieve a specific worksheet by id.
-     * @param worksheetId Worksheet ID to retrieve.
-     * @param cb Callback
-     * @example
-     * ```Javascript
-     * bbg.runGetWorksheet(worksheetId, (err, response) => {
-     *     if (!err) {
-     *         if (response && response.worksheet && Array.isArray(response.worksheet.securities)) {
-     *             let worksheetName = response.worksheet.name;
-     *             let worksheetId = response.worksheet.id;
-     *             let workSheetSecurities = response.worksheet.securities;
-     *             ...
-     *         } else {
-     *             Logger.error("invalid response from runGetWorksheet");
-     *         }
-     *     } else {
-     *         Logger.error("Error returned from runGetWorksheet", err);
-     *     }
-     * });
-     * ```
-     */
-    runGetWorksheet(worksheetId: string, cb: (err: StandardError, response: {
-        status: boolean;
-        worksheet: BBGWorksheet;
-    }) => void): void;
-    /**
-     * Replaces a specific worksheet by ID with a new list of securities.
-     * @param worksheetId  Worksheet ID to replace.
-     * @param securities An array of strings representing one or more securities.
-     * @param cb Callback
-     * ```Javascript
-     * let securities = ["TSLA US Equity", "AMZN US Equity"];
-     * bbg.runReplaceWorksheet(worksheetId, securities, (err, response) => {
-     *     if (!err) {
-     *         if (response && response.worksheet) {
-     *             //Details of the updated worksheet will be returned
-     *             let worksheetName = response.worksheet.name;
-     *             //List of securities resolved by Bloomberg from the input list, unresolvable securities will be removed
-     *             let workSheetSecurities = response.worksheet.securities;
-     *             ...
-     *         } else {
-     *             Logger.error("invalid response from runReplaceWorksheet", response);
-     *         }
-     *     } else {
-     *         Logger.error("Error returned from runReplaceWorksheet", err);
-     *     }
-     * });
-     * ```
-     */
-    runReplaceWorksheet(worksheetId: string, securities: string[], cb: (err: StandardError, response: {
-        status: boolean;
-        worksheet: BBGWorksheet;
-    }) => void): void;
-    /**
-     * Gets a list of all available Launchpad component groups.
-     * @param cb Callback
-     * @example
-     * ```Javascript
-     * bbg.runGetAllGroups((err, response) => {
-     *     if (!err) {
-     *         if (response && response.groups && Array.isArray(response.groups)) {
-     *             //do something with the returned data
-     *             response.groups.forEach(group => {
-     *                 let groupName = group.name;
-     *                 let groupType = group.type;
-     *                 let groupCurrentValue = group.value;
-     *                 ...
-     *             });
-     *         } else {
-     *             Logger.error("Invalid response returned from runGetAllGroups", response);
-     *         }
-     *     } else {
-     *         Logger.error("Error returned from runGetAllGroups", err);
-     *     }
-     * });
-     * ```
-     */
-    runGetAllGroups(cb: (err: StandardError, response: {
-        status: boolean;
-        groups: BBGGroup[];
-    }) => void): void;
-    /**
-     * Returns details of a Launchpad component group by name.
-     * @param groupName The name of the component group to retrieve.
-     * @param cb Callback
-     * @example
-     * ```Javascript
-     * bbg.runGetGroupContext(groupName, (err, response) => {
-     *     if (!err) {
-     *         if (response && response.group) {
-     *             let groupName = response.group.name;
-     *             let groupType = group.type;
-     *             let groupCurrentValue = group.value;
-     *             ...
-     *         } else {
-     *             Logger.error("Invalid response returned from runGetGroupContext", response);
-     *         }
-     *     } else {
-     *         Logger.error("Error returned from runGetGroupContext", err);
-     *     }
-     * });
-     * ```
-     */
-    runGetGroupContext(groupName: string, cb: (err: StandardError, response: {
-        status: boolean;
-        group: BBGGroup;
-    }) => void): void;
-    /**
-     * Set the context value of a Launchpad group by name.
-     * @param groupName The name of the component group to set the value of.
-     * @param value The value to set for hte group, this will usually be a string
-     * representing a security.
-     * @param cookie (optional) Cookie value identifying a particular component within
-     * a group to set the context of. Pass null if not required.
-     * @param cb Callback
-     * @example
-     * ```Javascript
-     * bbg.runSetGroupContext(groupName, newValue, null, (err, response) => {
-     *     if (!err) {
-     * 	       // You may wish to retrieve the current state of Launchpad group here as Bloomberg
-     *         // will resolve any security your set and may therefore its value may differ from
-     *         // what you sent.
-     *         bbg.runGetGroupContext(groupName, (err2, response2) => { ... });
-     *     } else {
-     *         Logger.error("Error returned from runSetGroupContext", err);
-     *     }
-     * });
-     * ```
-     */
-    runSetGroupContext(groupName: string, value: string, cookie: string | null, cb: (err: StandardError, response: {
-        status: boolean;
-    }) => void): void;
-    /**
-     * Search for Bloomberg securities by name
-     * @param security The string to lookup a security for
-     * @param cb Callback
-     * @example
-     * ```Javascript
-     * bbg.runSecurityLookup(security, (err, response) => {
-     *     if (!err) {
-     * 	       if (response && response.results) {
-     *             //do something with the results
-     *             response.results.forEach(result => {
-     *                 Logger.log(result.name + " " + result.type);
-     *                 ...
-     *             });
-     * 	       } else {
-     *             Logger.error("invalid response from runSecurityLookup", response);
-     * 	       }
-     *     } else {
-     * 	       Logger.error("Error returned from runSecurityLookup", err);
-     *     }
-     * });
-     * ```
-     */
-    runSecurityLookup(security: string, cb: (err: StandardError, response: {
-        status: boolean;
-        results: [{
-            name: string;
-            type: string;
-        }];
-    }) => void): void;
-}
-declare const _default: BloombergBridgeClient;
-export default _default;
+import { RouterMessage, QueryResponse } from "../../clients/routerClient";
+import { StandardCallback, CallbackError, StandardError } from "../../types";
+/**
+ * Interface representing an event handler for connection events, which are fired
+ * when the BloombergBridge connects or disconnects from the terminal.
+ */
+export type BBGConnectionStatusMessage = {
+    registered: boolean;
+    enabled: boolean;
+    connectedTo: string;
+};
+export interface BBGConnectionEventListener extends StandardCallback {
+    (
+    /** Errors received from Terminal connect - most likely on registration of
+     * the listener. */
+    err: string | Error, 
+    /** Flags indicating if the BloombergBridge is enabled, whether it is registered
+     * with the terminal through terminal connect and, if connected, to what address.
+     * `registered` be true for any of the client functions to work.
+     */
+    response: RouterMessage<BBGConnectionStatusMessage>): void;
+}
+/**
+ * Interface representing an event handler for Bloomberg group events.
+ */
+export interface BBGGroupEventListener extends StandardCallback {
+    (
+    /** Errors received from Terminal connect - most likely on registration of
+     * the listener. */
+    err: string | Error, 
+    /** Details relating to BlpComponentContextChangedEventArgs messages received from
+     * Terminal connect. These will usually relate to single group and reflect changes
+     * in the group's context or creation of a group, which will generate context changed
+     * event, but for a group that did not previously exist.*/
+    response: RouterMessage<{
+        group: BBGGroup;
+        groups: BBGGroup[];
+    }>): void;
+}
+/**
+ * Interface representing a Bloomberg worksheet.
+ */
+export interface BBGWorksheet {
+    /** The name of the worksheet (non-unique). */
+    id: string;
+    /** The name of the worksheet assigned by the Bloomberg terminal and globally unique. */
+    name: string;
+    /** A flag indicating the Worksheet's IsActive status. */
+    isActive: boolean;
+    /** The list of securities appearing in the worksheet. */
+    securities: string[];
+}
+/**
+ * @param {string} type The type of the group: security or monitor.
+ * @param {string} name The name of the group assigned by the Bloomberg terminal, usually takes =
+ * the form 'Group-A'.
+ * @param {string} value the current value of the group.
+ */
+export interface BBGGroup {
+    type: string;
+    name: string;
+    value: string;
+}
+/**
+ * Client class for communicating with the Finsemble Bloomberg Bridge over the the Finsemble Router,
+ * which in turn communicates with the Bloomberg Terminal via the Terminal Connect and BLP APIs.
+ *
+ * This Class may either be imported into code and initialized by passing in an instance
+ * of the Finsemble RouterClient and Logger (e.g. in Finsemble Custom Desktop Service) or
+ * used as a preload to be applied to a component, where it will be automatically initialized
+ * via instances of the RouterClient and Logger referenced from `FSBL.Clients`.
+ *
+ * @experimental
+ */
+export declare class BloombergBridgeClient {
+    private connectionEventListener;
+    private groupEventListener;
+    private routerClient;
+    private logger;
+    /**
+     * BloombergBridgeClient constructor.
+     * @example Instantiating the client in a Finsemble component:
+     * ```Javascript
+     * let bbg = new BloombergBridgeClient(FSBL.Clients.RouterClient, FSBL.Clients.Logger);
+     * ```
+     *
+     * Instantiating the client in a Finsemble service:
+     * ```Javascript
+     * let bbg = new BloombergBridgeClient();
+     * ```
+     */
+    constructor();
+    /**
+     * Set a handler function for connection events.
+     *
+     * Note that only one handler function is permitted, hence calling
+     * this multiple times will simply replace the existing handler.
+     *
+     * @param cb Callback
+     * @example
+     * ```Javascript
+     * let connectionEventHandler = (err, resp) => {
+     *     if (!err && resp && resp.registered) {
+     *         showConnectedIcon();
+     *     } else {
+     *         showDisconnectedIcon();
+     *     }
+     * };
+     * bbg.setConnectionEventListener(connectionEventHandler);
+     * ```
+     */
+    setConnectionEventListener(cb: BBGConnectionEventListener): void;
+    /**
+     * Remove the current connection event handler.
+     * @example
+     * ```Javascript
+     * bbg.removeConnectionEventListener();
+     * ```
+     */
+    removeConnectionEventListener(): void;
+    /**
+     * Set a handler function for Launchpad group context changed events, which
+     * are fired when a group's context changes or a new group is created.
+     *
+     * Note that only one handler function is permitted, hence calling
+     * this multiple times will simply replace the existing handler.
+     * @param cb Handler function to call on group context change events
+     * @example
+     * ```Javascript
+     * bbg.setGroupEventListener((err, response) => {
+     *     if (!err) {
+     *         if (response.data.group && response.data.group.type == "monitor") {
+     *             Logger.log("Monitor event:\n" + JSON.stringify(response.data, null, 2));
+     *         } else {
+     *             Logger.log("Security event:\n" + JSON.stringify(response.data, null, 2));
+     *         }
+     *     } else {
+     *             Logger.error("Error returned from setGroupEventListener", err);
+     *     }
+     * });
+     * ```
+     */
+    setGroupEventListener(cb: BBGGroupEventListener): void;
+    /**
+     * Remove the current group context changed event handler.
+     * @example
+     * ```Javascript
+     * bbg.removeGroupEventListener();
+     * ```
+     */
+    removeGroupEventListener(): void;
+    /**
+     * Set the connection state for Bloomberg bridge, i.e. whether it is enabled or not.
+     * Note that the remote connection config should only be changed while the connection is
+     * disabled or disconnected, as it is read when attempting to connect.
+     * @param enabled Boolean flag indicating whether the bridge should connect to Bloomberg.
+     * If set false while connected, the bridge will automatically disconnect.
+     * @param cb Optional callback that will return response as true if we have successfully set the
+     * connect states.
+     * @example
+     * ```Javascript
+     * bbg.setConnectState(true);
+     * bbg.setConnectState(false, (err, resp) => { ... });
+     * ```
+     */
+    setEnabled(enabled: boolean, cb?: StandardCallback): void;
+    /**
+     * Check that Bloomberg bridge is connected to the Bloomberg Terminal.
+     * @param cb Callback for connection response that will return response as true if we are
+     * connected.
+     * @example
+     * ```Javascript
+     * let checkConnectionHandler = (err, registered) => {
+     *     if (!err && registered) {
+     *         showConnectedIcon();
+     *     } else {
+     *         showDisconnectedIcon();
+     *     }
+     * };
+     * bbg.checkConnection(checkConnectionHandler);
+     * ```
+     */
+    checkConnection(cb: (err: string | CallbackError | Error | null, response: boolean | null) => void): void;
+    /**
+     * Internal function used to send a Query to the BBG_run_terminal_function responder of
+     * BloombergBridge,
+     * which implements the majority functions for the BloombergBridgeClient.
+     * @param message The query data to pass.
+     * @param message.function Required field that determines which function to run.
+     * @param cb Callback
+     * @private
+     */
+    queryBloombergBridge(message: {
+        function: string;
+    }, cb: StandardCallback): void;
+    /**
+     * Internal function used to return a call back that will wrap the supplied callback and log all
+     * responses
+     * from the Bloomberg Bridge to aid debugging.
+     * @param cb Callback
+     * @private
+     */
+    apiResponseHandler(cb: StandardCallback): (err: StandardError, response: QueryResponse<{
+        status: boolean;
+        message?: string;
+    }>) => void;
+    /**
+     * Run a function in one of the 4 Bloomberg panel windows.
+     * @param mnemonic The mnemonic of the Bloomberg command to run on a panel
+     * @param securities (optional) An array of strings representing one or more securities
+     * to pass to the function.
+     * @param panel Panel number to run the command on (accepts values "1", "2", "3" or
+     * "4")
+     * @param tails (optional) parameters passed to the function
+     * @param cb Callback
+     * @example
+     * ```Javascript
+     * let mnemonic = "DES";
+     * let securities = ["MSFT US Equity"];
+     * let panel = 3;
+     * let tails = null;
+     * bbg.runBBGCommand(mnemonic, securities, panel, tails, (err, response) => {
+     *     if (!err) {
+     *         Logger.log(`Ran command "${mnemonic}" on panel ${panel}`);
+     *     } else {
+     *         Logger.error("Error returned from runBBGCommand", err);
+     *     }
+     * });
+     * ```
+     */
+    runBBGCommand(mnemonic: string, securities: string[], panel: number, tails: string, cb: (err: StandardError, response: {
+        status: boolean;
+    }) => void): void;
+    /**
+     * Create a new worksheet with the specified securities and name.
+     * @param worksheetName Name for the worksheet.
+     * @param securities An array of strings representing one or more securities.
+     * @param cb Callback
+     * @example
+     * ```Javascript
+     * let securities = ["TSLA US Equity", "AMZN US Equity"];
+     * bbg.runCreateWorksheet(worksheetName, securities, (err, response) => {
+     *     if (!err) {
+     *         if (response && response.worksheet) {
+     *             //Id assigned to the worksheet
+     *             let worksheetId = response.worksheet.id;
+     *             //List of securities resolved by Bloomberg from the input list, unresolvable securities will be removed
+     *             let workSheetSecurities = response.worksheet.securities;
+     *         } else {
+     *             Logger.error("invalid response from runCreateWorksheet", response);
+     *         }
+     *     } else {
+     *         Logger.error("Error returned from runCreateWorksheet", err);
+     *     }
+     * });
+     * ```
+     */
+    runCreateWorksheet(worksheetName: string, securities: string[], cb: (err: StandardError, response: {
+        status: boolean;
+        worksheet: BBGWorksheet;
+    }) => void): void;
+    /**
+     * Retrieve all worksheets for the user.
+     * @param cb Callback
+     * @example
+     * ```Javascript
+     * bbg.runGetAllWorksheets((err, response) => {
+     *     if (!err) {
+     *         if (response && response.worksheets && Array.isArray(response.worksheets)) {
+     *             response.worksheets.forEach(worksheet => {
+     *                 let worksheetName = worksheet.name;
+     *                 let worksheetId = worksheet.id;
+     *                 ...
+     *             });
+     *         } else {
+     *             Logger.error("invalid response from runGetAllWorksheets", response);
+     *         }
+     *     } else {
+     *         Logger.error("Error returned from runGetAllWorksheets", err);
+     *     }
+     * });
+     * ```
+     */
+    runGetAllWorksheets(cb: (err: StandardError, response: {
+        status: boolean;
+        worksheets: BBGWorksheet[];
+    }) => void): void;
+    /**
+     * Retrieve a specific worksheet by id.
+     * @param worksheetId Worksheet ID to retrieve.
+     * @param cb Callback
+     * @example
+     * ```Javascript
+     * bbg.runGetWorksheet(worksheetId, (err, response) => {
+     *     if (!err) {
+     *         if (response && response.worksheet && Array.isArray(response.worksheet.securities)) {
+     *             let worksheetName = response.worksheet.name;
+     *             let worksheetId = response.worksheet.id;
+     *             let workSheetSecurities = response.worksheet.securities;
+     *             ...
+     *         } else {
+     *             Logger.error("invalid response from runGetWorksheet");
+     *         }
+     *     } else {
+     *         Logger.error("Error returned from runGetWorksheet", err);
+     *     }
+     * });
+     * ```
+     */
+    runGetWorksheet(worksheetId: string, cb: (err: StandardError, response: {
+        status: boolean;
+        worksheet: BBGWorksheet;
+    }) => void): void;
+    /**
+     * Replaces a specific worksheet by ID with a new list of securities.
+     * @param worksheetId  Worksheet ID to replace.
+     * @param securities An array of strings representing one or more securities.
+     * @param cb Callback
+     * ```Javascript
+     * let securities = ["TSLA US Equity", "AMZN US Equity"];
+     * bbg.runReplaceWorksheet(worksheetId, securities, (err, response) => {
+     *     if (!err) {
+     *         if (response && response.worksheet) {
+     *             //Details of the updated worksheet will be returned
+     *             let worksheetName = response.worksheet.name;
+     *             //List of securities resolved by Bloomberg from the input list, unresolvable securities will be removed
+     *             let workSheetSecurities = response.worksheet.securities;
+     *             ...
+     *         } else {
+     *             Logger.error("invalid response from runReplaceWorksheet", response);
+     *         }
+     *     } else {
+     *         Logger.error("Error returned from runReplaceWorksheet", err);
+     *     }
+     * });
+     * ```
+     */
+    runReplaceWorksheet(worksheetId: string, securities: string[], cb: (err: StandardError, response: {
+        status: boolean;
+        worksheet: BBGWorksheet;
+    }) => void): void;
+    /**
+     * Gets a list of all available Launchpad component groups.
+     * @param cb Callback
+     * @example
+     * ```Javascript
+     * bbg.runGetAllGroups((err, response) => {
+     *     if (!err) {
+     *         if (response && response.groups && Array.isArray(response.groups)) {
+     *             //do something with the returned data
+     *             response.groups.forEach(group => {
+     *                 let groupName = group.name;
+     *                 let groupType = group.type;
+     *                 let groupCurrentValue = group.value;
+     *                 ...
+     *             });
+     *         } else {
+     *             Logger.error("Invalid response returned from runGetAllGroups", response);
+     *         }
+     *     } else {
+     *         Logger.error("Error returned from runGetAllGroups", err);
+     *     }
+     * });
+     * ```
+     */
+    runGetAllGroups(cb: (err: StandardError, response: {
+        status: boolean;
+        groups: BBGGroup[];
+    }) => void): void;
+    /**
+     * Returns details of a Launchpad component group by name.
+     * @param groupName The name of the component group to retrieve.
+     * @param cb Callback
+     * @example
+     * ```Javascript
+     * bbg.runGetGroupContext(groupName, (err, response) => {
+     *     if (!err) {
+     *         if (response && response.group) {
+     *             let groupName = response.group.name;
+     *             let groupType = group.type;
+     *             let groupCurrentValue = group.value;
+     *             ...
+     *         } else {
+     *             Logger.error("Invalid response returned from runGetGroupContext", response);
+     *         }
+     *     } else {
+     *         Logger.error("Error returned from runGetGroupContext", err);
+     *     }
+     * });
+     * ```
+     */
+    runGetGroupContext(groupName: string, cb: (err: StandardError, response: {
+        status: boolean;
+        group: BBGGroup;
+    }) => void): void;
+    /**
+     * Set the context value of a Launchpad group by name.
+     * @param groupName The name of the component group to set the value of.
+     * @param value The value to set for hte group, this will usually be a string
+     * representing a security.
+     * @param cookie (optional) Cookie value identifying a particular component within
+     * a group to set the context of. Pass null if not required.
+     * @param cb Callback
+     * @example
+     * ```Javascript
+     * bbg.runSetGroupContext(groupName, newValue, null, (err, response) => {
+     *     if (!err) {
+     * 	       // You may wish to retrieve the current state of Launchpad group here as Bloomberg
+     *         // will resolve any security your set and may therefore its value may differ from
+     *         // what you sent.
+     *         bbg.runGetGroupContext(groupName, (err2, response2) => { ... });
+     *     } else {
+     *         Logger.error("Error returned from runSetGroupContext", err);
+     *     }
+     * });
+     * ```
+     */
+    runSetGroupContext(groupName: string, value: string, cookie: string | null, cb: (err: StandardError, response: {
+        status: boolean;
+    }) => void): void;
+    /**
+     * Search for Bloomberg securities by name
+     * @param security The string to lookup a security for
+     * @param cb Callback
+     * @example
+     * ```Javascript
+     * bbg.runSecurityLookup(security, (err, response) => {
+     *     if (!err) {
+     * 	       if (response && response.results) {
+     *             //do something with the results
+     *             response.results.forEach(result => {
+     *                 Logger.log(result.name + " " + result.type);
+     *                 ...
+     *             });
+     * 	       } else {
+     *             Logger.error("invalid response from runSecurityLookup", response);
+     * 	       }
+     *     } else {
+     * 	       Logger.error("Error returned from runSecurityLookup", err);
+     *     }
+     * });
+     * ```
+     */
+    runSecurityLookup(security: string, cb: (err: StandardError, response: {
+        status: boolean;
+        results: [{
+            name: string;
+            type: string;
+        }];
+    }) => void): void;
+}
+declare const _default: BloombergBridgeClient;
+export default _default;
 //# sourceMappingURL=BloombergBridgeClient.d.ts.map