@thoughtspot/visual-embed-sdk 1.26.2 → 1.27.0-logger

package/dist/visual-embed-sdk.d.ts

@@ -13,7 +13,7 @@ import EventEmitter from 'eventemitter3';
   * @summary ThoughtSpot Visual Embed SDK
   * @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
   */
-export { init, logout, prefetch, executeTML, exportTML, executeTMLInput, exportTMLInput, getEmbedConfig as getInitConfig, getSessionInfo, SearchEmbed, SearchBarEmbed, PinboardEmbed, LiveboardEmbed, SageEmbed, AppEmbed, AuthFailureType, AuthStatus, AuthEvent, AuthEventEmitter, AnswerService, Page, AuthType, RuntimeFilter, RuntimeFilterOp, EmbedEvent, HostEvent, DataSourceVisualMode, Action, ContextMenuTriggerOptions, EmbedConfig, SearchViewConfig, SearchBarViewConfig, LiveboardViewConfig, SageViewConfig, AppViewConfig, PrefetchFeatures, FrameParams, HomeLeftNavItem, HomepageModule, DOMSelector, MessageOptions, MessageCallback, MessagePayload, CustomisationsInterface, CustomStyles, customCssInterface, CustomCssVariables, RuntimeParameter, };
+export { init, logout, prefetch, executeTML, exportTML, executeTMLInput, exportTMLInput, getEmbedConfig as getInitConfig, getSessionInfo, SearchEmbed, SearchBarEmbed, PinboardEmbed, LiveboardEmbed, SageEmbed, AppEmbed, AuthFailureType, AuthStatus, AuthEvent, AuthEventEmitter, AnswerService, Page, AuthType, RuntimeFilter, RuntimeFilterOp, EmbedEvent, HostEvent, DataSourceVisualMode, Action, ContextMenuTriggerOptions, EmbedConfig, SearchViewConfig, SearchBarViewConfig, LiveboardViewConfig, SageViewConfig, AppViewConfig, PrefetchFeatures, FrameParams, HomeLeftNavItem, HomepageModule, DOMSelector, MessageOptions, MessageCallback, MessagePayload, CustomisationsInterface, CustomStyles, customCssInterface, CustomCssVariables, RuntimeParameter, LogLevel, };
 
 /**
     * Copyright (c) 2022
@@ -65,43 +65,43 @@ export enum Page {
     */
 export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
         /**
-            * If true, the main navigation bar within the ThoughtSpot app
+            * If true, the top navigation bar within the ThoughtSpot app
             * is displayed. By default, the navigation bar is hidden.
-            * This flag also control the homepage left nav-bar.
+            * This flag also controls the homepage left navigation bar.
             */
         showPrimaryNavbar?: boolean;
         /**
-            * Flag to control Homepage Left Nav Bar
-            * If showPrimaryNavbar is true, ie navigation bar(Global nav-bar) and Homepage left
-            * nav-bar is visible, this flag will only hide the homepage left nav.
-            * Precedence of showPrimaryNavbar flag > hideHomepageLeftNav flag.
+            * Control the visibility of the left navigation bar on the Homepage.
+            * If showPrimaryNavbar is true, that is, if the Global and Homepage
+            * nav-bars are visible, this flag will only hide the homepage left nav-bar.
+            * The showPrimaryNavbar flag takes precedence over the hideHomepageLeftNav.
             *
             * @default false
             * @version SDK: 1.27.0 | Thoughtspot: 9.8.0.cl
             */
         hideHomepageLeftNav?: boolean;
         /**
-            * If true, help and profile buttons will hide on NavBar. By default,
-            * they are shown.
+            * Control the visibility of the help (?) and profile buttons on the
+            * Global nav-bar. By default, these buttons are visible on the nav-bar.
             */
         disableProfileAndHelp?: boolean;
         /**
-            * If true, application switcher button will hide on NavBar. By default,
-            * they are shown.
+            * Control the visibility of the application switcher button on the nav-bar.
+            * By default, the application switcher is shown.
             */
         hideApplicationSwitcher?: boolean;
         /**
-            * If true, org switcher button will hide on NavBar. By default,
-            * they are shown.
+            * Control the visibility of the Org switcher button on the nav-bar.
+            * By default, the Org switcher button is shown.
             */
         hideOrgSwitcher?: boolean;
         /**
-            * A URL path within the app that is to be embedded.
+            * A URL path to the embedded application page
             * If both path and pageId attributes are defined, the path definition
             * takes precedence. This is the path post the `#/` in the URL of the standalone
             * ThoughtSpot app. Use this to open the embedded view to a specific path.
             *
-            * For eg, if you want the component to open to a specific liveboard
+            * For eg, if you want the component to open to a specific Liveboard
             * you could set the path to `pinboard/<liveboardId>/tab/<tabId>`.
             *
             * @example
@@ -404,8 +404,8 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
             */
         fullHeight?: boolean;
         /**
-            * This is the minimum height(in pixels) for a full height Liveboard.
-            * Setting this height helps resolves issues with empty Liveboards and
+            * This is the minimum height(in pixels) for a full-height Liveboard.
+            * Setting this height helps resolve issues with empty Liveboards and
             * other screens navigable from a Liveboard.
             *
             * @version SDK: 1.5.0 | ThoughtSpot: ts7.oct.cl, 7.2.1
@@ -418,7 +418,7 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
         enableVizTransformations?: boolean;
         /**
             * The Liveboard to display in the embedded view.
-            * Use either of liveboardId or pinboardId to reference the Liveboard to embed.
+            * Use either liveboardId or pinboardId to reference the Liveboard to embed.
             *
             * @version SDK: 1.3.0 | ThoughtSpot ts7.aug.cl, 7.2.1
             */
@@ -437,79 +437,84 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
             * If set to true, all filter chips from a
             * Liveboard page will be read-only (no X buttons)
             *
-            * @version SDK: 1.3.0 | ThoughtSpot ts7.aug.cl, 7.2.1
+            * @version SDK: 1.3.0 | ThoughtSpot ts7.aug.cl, 7.2.1.sw
             */
         preventLiveboardFilterRemoval?: boolean;
         /**
-            * Array of viz ids which should be visible when the liveboard
-            * first renders. This can be changed by triggering the "SetVisibleVizs"
+            * Array of visualization IDs which should be visible when the Liveboard
+            * renders. This can be changed by triggering the `SetVisibleVizs`
             * event.
             *
             * @version SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
             */
         visibleVizs?: string[];
         /**
-            * To support backward compatibilty
+            * To support backward compatibility
             *
             * @hidden
             */
         preventPinboardFilterRemoval?: boolean;
         /**
-            * Render embedded Liveboards and visualizations in the new Liveboard experience mode
+            * Render embedded Liveboards and visualizations in the
+            * new Liveboard experience mode.
             *
             * @version SDK: 1.14.0 | ThoughtSpot: 8.6.0.cl, 8.8.1-sw
             */
         liveboardV2?: boolean;
         /**
-            * Tab ID of the Liveboard that is supposed to be active
+            * Set a Liveboard tab as an active tab.
+            * Specify the tab ID.
             *
             * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
             */
         activeTabId?: string;
         /**
-            * Hide tab Panel of embedded LB
+            * Show or hide the tab panel of the embedded Liveboard.
             *
-            * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
+            * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl, 9.8.0.sw
             */
         hideTabPanel?: boolean;
         /**
-            * Show or hide Liveboard header
+            * Show or hide the Liveboard header.
             *
-            * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
+            * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
             * @default false
             */
         hideLiveboardHeader?: boolean;
         /**
-            * Show or hide Liveboard title
+            * Show or hide the Liveboard title.
             *
-            * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
+            * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
             * @default false
             */
         showLiveboardTitle?: boolean;
         /**
-            * Show or hide Liveboard description
+            * Show or hide the Liveboard description.
             *
-            * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
+            * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
             * @default false
             */
         showLiveboardDescription?: boolean;
         /**
-            * Boolean for sticky Liveboard header.
+            * Control the position and visibility of
+            * the Liveboard header as the users scroll down the
+            * embedded Liveboard page.
             *
             * @example
             * ```js
             * const embed = new LiveboardEmbed('#embed', {
-            *   ... // other liveboard view config
+            *   ... // other Liveboard view config
             *   isLiveboardHeaderSticky: true,
             * });
             * ```
-            * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
+            * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
             */
         isLiveboardHeaderSticky?: boolean;
 }
 /**
-    * Embed a ThoughtSpot Liveboard or a Thoughtspot visualization. When rendered it already
-    * waits for the authentication to complete, so no need to wait for AuthStatus.SUCCESS.
+    * Embed a ThoughtSpot Liveboard or visualization. When rendered it already
+    * waits for the authentication to complete, so you need not wait for
+    * `AuthStatus.SUCCESS`.
     *
     * @example
     * ```js
@@ -564,18 +569,19 @@ export class PinboardEmbed extends LiveboardEmbed {
     * @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
     */
 /**
-    * Configuration for search options
+    * Configuration for search options.
+    *
     */
 export interface SearchOptions {
         /**
-            * The tml string to load the answer
+            * Search tokens to pass in the query.
             */
         searchTokenString: string;
         /**
-            * Boolean to determine if the search should be executed or not.
-            * if it is executed, put the focus on the results.
-            * if it’s not executed, put the focus in the search bar - at the end of
-            * the tokens
+            * Boolean to define if the search should be executed or not.
+            * If it is executed, the focus is placed on the results.
+            * If it’s not executed, the focus is placed at the end of
+            * the token string in the search bar.
             */
         executeSearch?: boolean;
 }
@@ -591,19 +597,15 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
             */
         collapseDataSources?: boolean;
         /**
-            * If set to true, hides the data sources panel.
+            * Show or hide the data sources panel.
             */
         hideDataSources?: boolean;
         /**
-            * If set to true, hides the charts and tables in search answers.
+            * Show or hide the charts and tables in search answers.
             * This attribute can be used to create a custom visualization
             * using raw answer data.
             */
         hideResults?: boolean;
-        /**
-            * If set to true, expands all the data sources panel.
-            */
-        expandAllDataSource?: boolean;
         /**
             * If set to true, the Search Assist feature is enabled.
             *
@@ -617,9 +619,9 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
         forceTable?: boolean;
         /**
             * The array of data source GUIDs to set on load.
-            * Only a single dataSource supported currently.
+            * Only a single data source is supported currently.
             *
-            * @deprecated Use dataSource instead
+            * @deprecated Use `dataSource` instead.
             */
         dataSources?: string[];
         /**
@@ -631,11 +633,29 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
         /**
             * The initial search query to load the answer with.
             *
-            * @deprecated Use {@link searchOptions} instead
+            * @deprecated
+            *
+            * Use {@link searchOptions} instead.
             */
         searchQuery?: string;
         /**
-            * Configuration for search options
+            * Configuration for search options.
+            * Includes the following properties:
+            *
+            * `searchTokenString`: Search tokens to pass in the query.
+            *
+            * `executeSearch`: Boolean to define if the search should be executed or not.
+            * If it is executed, the focus is placed on the results.
+            * If it’s not executed, the focus is placed at the end of
+            * the token string in the search bar.
+            *
+            * @example
+            * ```js
+            * searchOptions: {
+            *    searchTokenString: '[quantity purchased] [region]',
+            *    executeSearch: true,
+            * }
+            * ```
             */
         searchOptions?: SearchOptions;
         /**
@@ -643,10 +663,10 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
             */
         answerId?: string;
         /**
-            * If set to true, search page will render without the Search Bar
+            * If set to true, the search page will render without the Search Bar
             * The chart/table should still be visible.
             *
-            * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
+            * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
             */
         hideSearchBar?: boolean;
         /**
@@ -689,25 +709,41 @@ export class SearchEmbed extends TsEmbed {
 export interface SearchBarViewConfig extends Omit<ViewConfig, 'runtimeFilters' | 'showAlerts' | 'dataPanelV2' | 'hiddenHomepageModules' | 'hiddenHomeLeftNavItems' | 'hiddenTabs' | 'visibleTabs' | 'reorderedHomepageModules'> {
         /**
             * The array of data source GUIDs to set on load.
-            * Only a single dataSource supported currently.
+            * Only a single data source is supported currently.
             *
-            * @deprecated Use dataSource instead
+            * @deprecated Use `dataSource` instead
             */
         dataSources?: string[];
         /**
             * The array of data source GUIDs to set on load.
             *
-            * @version: SDK: 1.19.0
+            * @version: SDK: 1.19.0, ThoughtSpot 9.0.0.cl, 9.0.1.sw
             */
         dataSource?: string;
         /**
-            * Flag to set if last selected dataSource should be used
+            * Boolean to define if the last selected data source should be used
             *
-            * @version: SDK: 1.24.0
+            * @version: SDK: 1.24.0, ThoughtSpot 9.5.0.cl, 9.5.0.sw
             */
         useLastSelectedSources?: boolean;
         /**
-            * Configuration for search options
+            * Configuration for search options.
+            * Includes the following properties:
+            *
+            * `searchTokenString`: Search tokens to pass in the query.
+            *
+            * `executeSearch`: Boolean to define if the search should be executed or not.
+            * If it is executed, the focus is placed on the results.
+            * If it’s not executed, the focus is placed at the end of
+            * the token string in the search bar.
+            *
+            * @example
+            * ```js
+            * searchOptions: {
+            *    searchTokenString: '[quantity purchased] [region]',
+            *    executeSearch: true,
+            * }
+            * ```
             */
         searchOptions?: SearchOptions;
 }
@@ -775,8 +811,8 @@ export enum AuthStatus {
             */
         LOGOUT = "LOGOUT",
         /**
-            * Emitted when inPopup: true in the SAMLRedirect flow.
-            * And, we are waiting for popup to be triggered either programatically
+            * Emitted when inPopup is true in the SAMLRedirect flow and the
+            * popup is waiting to be triggered either programmatically
             * or by the trigger button.
             *
             * @version SDK: 1.19.0
@@ -821,8 +857,8 @@ export interface AuthEventEmitter {
     */
 export enum AuthEvent {
         /**
-            * Manually trigger the SSO popup. This is useful with
-            * authStatus: SAMLRedirect/OIDCRedicre and inPopup: true
+            * Manually trigger the SSO popup. This is useful when
+            * authStatus is SAMLRedirect/OIDCRedirect and inPopup is set to true
             */
         TRIGGER_SSO_POPUP = "TRIGGER_SSO_POPUP"
 }
@@ -931,10 +967,14 @@ export enum AuthType {
             */
         None = "None",
         /**
-            * Passthrough SSO to the embedded App within the iframe. Requires least
+            * Passthrough SSO to the embedded application within the iframe. Requires least
             * configuration, but may not be supported by all IDPs. This will behave like `None`
             * if SSO is not configured on ThoughtSpot.
             *
+            * To use this:
+            * Your SAML or OpenID provider must allow iframe redirects.
+            * For example, if you are using Okta as IdP, you can enable iframe embedding.
+            *
             * @example
             * ```js
             * init({
@@ -942,12 +982,7 @@ export enum AuthType {
             *   authType: AuthType.EmbeddedSSO,
             *  });
             * ```
-            * Set authentication type as Embedded SSO.
-            *
-            * To use this:
-            * Your SAML or OpenID provider must allow iframe redirects.
-            * eg. If you are using okta as IdP, you can enable iFrame embedding.
-            * @version: SDK: 1.15.0 | ThouhgtSpot: 8.8.0.cl
+            * @version: SDK: 1.15.0 | ThoughtSpot: 8.8.0.cl
             */
         EmbeddedSSO = "EmbeddedSSO",
         /**
@@ -966,10 +1001,10 @@ export enum AuthType {
         SAML = "SSO_SAML",
         /**
             * SSO using SAML
-            * Will make the host application redirect to the SAML Idp. Use this
-            * when the idp does not allow itself to be embedded.
+            * Makes the host application redirect to the SAML IdP. Use this
+            * if your IdP does not allow itself to be embedded.
             *
-            * This redirects the host application to the SAML Idp. The host application
+            * This redirects the host application to the SAML IdP. The host application
             * will be redirected back to the ThoughtSpot app after authentication.
             *
             * @example
@@ -980,7 +1015,7 @@ export enum AuthType {
             *  });
             * ```
             *
-            * This opens the SAML Idp in a popup window. The popup is triggered
+            * This opens the SAML IdP in a popup window. The popup is triggered
             * when the user clicks the trigger button. The popup window will be
             * closed automatically after authentication.
             * @example
@@ -994,8 +1029,8 @@ export enum AuthType {
             * });
             * ```
             *
-            * Can also use event to trigger the popup flow. Works the same
-            * as above example.
+            * Can also use the event to trigger the popup flow. Works the same
+            * as the above example.
             * @example
             * ```js
             * const authEE = init({
@@ -1019,7 +1054,7 @@ export enum AuthType {
         OIDC = "SSO_OIDC",
         /**
             * SSO using OIDC
-            * Will make the host application redirect to the OIDC Idp.
+            * Will make the host application redirect to the OIDC IdP.
             * See code samples in {@link SAMLRedirect}.
             */
         OIDCRedirect = "SSO_OIDC",
@@ -1031,8 +1066,8 @@ export enum AuthType {
             */
         AuthServer = "AuthServer",
         /**
-            * Trusted authentication server, Use your own authentication server
-            * which returns a bearer token, generated using the secret_key obtained
+            * Trusted authentication server. Use your own authentication server
+            * which returns a bearer token, generated using the `secret_key` obtained
             * from ThoughtSpot.
             *
             * @example
@@ -1049,11 +1084,11 @@ export enum AuthType {
             */
         TrustedAuthToken = "AuthServer",
         /**
-            * Trusted authentication server Cookieless, Use you own authentication
-            * server which returns a bearer token, generated using the secret_key
+            * Trusted authentication server Cookieless, Use your own authentication
+            * server which returns a bearer token, generated using the `secret_key`
             * obtained from ThoughtSpot. This uses a cookieless authentication
-            * approach, recommended to by pass third-party cookie-blocking restriction
-            * implemented by some browsers
+            * approach, recommended to bypass the third-party cookie-blocking restriction
+            * implemented by some browsers.
             *
             * @example
             * ```js
@@ -1066,7 +1101,7 @@ export enum AuthType {
             *      .then((data) => data.token);
             *  }
             * ```
-            * @version SDK: 1.22.0| ThouhgtSpot: 9.3.0.cl, 9.5.1.sw
+            * @version SDK: 1.22.0| ThoughtSpot: 9.3.0.cl, 9.5.1.sw
             */
         TrustedAuthTokenCookieless = "AuthServerCookieless",
         /**
@@ -1188,13 +1223,19 @@ export interface EmbedConfig {
             * The ThoughtSpot cluster hostname or IP address.
             */
         thoughtSpotHost: string;
+        /**
+            * If true, all the iframe links will have /v2 added automatically.
+            * If false, all the iframe links will have /v1 added automatically.
+            * If undefined, nothing will be added
+            */
+        enableReactShell?: boolean | undefined;
         /**
             * The authentication mechanism to use.
             */
         authType: AuthType;
         /**
             * [AuthServer] The trusted authentication endpoint to use to get the
-            * authentication token. A GET request is made to the
+            * authentication token. A `GET` request is made to the
             * authentication API endpoint, which  returns the token
             * as a plaintext response. For trusted authentication,
             * the `authEndpoint` or `getAuthToken` attribute is required.
@@ -1207,8 +1248,8 @@ export interface EmbedConfig {
             * attribute is required.
             *
             * It is advisable to fetch a new token inside this method and not
-            * reuse and older issued token, as because when auth expires this is
-            * called again and if it is called with an older token the authentication
+            * reuse the old issued token. When auth expires this method is
+            * called again and if it is called with an older token, the authentication
             * will not succeed.
             */
         getAuthToken?: () => Promise<string>;
@@ -1218,7 +1259,7 @@ export interface EmbedConfig {
             */
         username?: string;
         /**
-            * [Basic] The ThoughtSpot login password corresponding to the user name
+            * [Basic] The ThoughtSpot login password corresponding to the username
             *
             * Warning: This feature is primarily intended for developer testing. It is
             * strongly advised not to use this authentication method in production.
@@ -1226,7 +1267,7 @@ export interface EmbedConfig {
         password?: string;
         /**
             * [SSO] For SSO Authentication, if `noRedirect` is set to true, it will
-            * open the SAML auth flow in a popup, instead of redirecting browser in
+            * open the SAML auth flow in a popup, instead of redirecting the browser in
             * place.
             *
             * @default false
@@ -1235,91 +1276,93 @@ export interface EmbedConfig {
         noRedirect?: boolean;
         /**
             * [SSO] For SSO Authentication, if `inPopup` is set to true, it will open
-            * the SAML auth flow in a popup, instead of redirecting browser in place.
+            * the SAML auth flow in a popup, instead of redirecting the browser in place.
             *
-            * Need to use this with authTriggerContainer. Or manually trigger
-            * the AuthEvent.TRIGGER_SSO_POPUP event on a user interaction.
+            * Need to use this with `authTriggerContainer`. Or manually trigger
+            * the `AuthEvent.TRIGGER_SSO_POPUP` event on a user interaction.
             *
             * @default false
             * @version SDK: 1.18.0
             */
         inPopup?: boolean;
         /**
-            * [SSO] For SSO Authentication, one can supply an optional path param,
-            * this will be the path on the host origin where the SAML flow will be
+            * [SSO] For SSO Authentication, one can supply an optional path param;
+            * This will be the path on the host origin where the SAML flow will be
             * terminated.
             *
             * Eg: "/dashboard", "#/foo" [Do not include the host]
             *
-            * @version SDK: 1.10.2 | 8.2.0.cl, 8.4.1.sw
+            * @version SDK: 1.10.2 | ThoughtSpot 8.2.0.cl, 8.4.1.sw
             */
         redirectPath?: string;
         /** @internal */
         basepath?: string;
         /**
-            * Should we encode URL Query Params using base64 encoding which thoughtspot
-            * will generate for embedding. This provides additional security to
-            * thoughtspot clusters against Cross site scripting attacks.
+            * Boolean to define if the query parameters in the ThoughtSpot URL
+            * should be encoded in base64. This provides additional security to
+            * Thoughtspot clusters against cross-site scripting attacks.
             *
             * @default false
             */
         shouldEncodeUrlQueryParams?: boolean;
         /**
-            * Suppress cookie access alert when third party cookies are blocked by the
-            * user's browser. Third party cookie blocking is the default behaviour on
-            * Safari and opt-in for Firefox/Chrome. If you set this to `true`, you are
-            * encouraged to handle `noCookieAccess` event, to show your own treatment
+            * Suppress cookie access alert when third-party cookies are blocked by the
+            * user's browser. Third-party cookie blocking is the default behaviour on
+            * some web browsers like Safari. If you set this attribute to `true`,
+            * you are encouraged to handle `noCookieAccess` event, to show your own treatment
             * in this case.
             *
             * @default false
             */
         suppressNoCookieAccessAlert?: boolean;
         /**
-            * Ignore cookie access alert when third party cookies are blocked by the
+            * Ignore the cookie access alert when third-party cookies are blocked by the
             * user's browser. If you set this to `true`, the embedded iframe behaviour
-            * persist even in case of non logged in user.
+            * persists even in the case of a non-logged-in user.
             *
             * @default false
             */
         ignoreNoCookieAccess?: boolean;
         /**
-            * Re-login when session expires with the previous login options
+            * Re-login a user with the previous login options
+            * when a user session expires.
             *
             * @default false
             */
         autoLogin?: boolean;
         /**
             * Disable redirection to the login page when the embedded session expires
-            * This flag is typically used alongside the combination of auth modes such as {@link
-            * AuthType.AuthServer} and auto login behavior {@link EmbedConfig.autoLogin}
+            * This flag is typically used alongside the combination of authentication modes such
+            * as {@link AuthType.AuthServer} and auto-login behavior {@link
+            * EmbedConfig.autoLogin}
             *
             * @version SDK: 1.9.3 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
             * @default false
             */
         disableLoginRedirect?: boolean;
         /**
-            * This message is displayed on the embed view when the login fails.
+            * This message is displayed in the embedded view when a user login fails.
             *
             * @version SDK: 1.10.1 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
             */
         loginFailedMessage?: string;
         /**
-            * Calls the prefetch method internally when set to true
+            * Calls the prefetch method internally when set to `true`
             *
             * @default false
             */
         callPrefetch?: boolean;
         /**
-            * When there are multiple embeds, queue the render of embed to start
-            *  after the previous embed's render is complete. This helps in the load
-            *  performance by decreasing the load on the browser.
+            * When there are multiple objects embedded, queue the rendering of embedded objects
+            * to start after the previous embed's render is complete. This helps improve
+            * performance by decreasing the load on the browser.
             *
             *  @Version SDK: 1.5.0 | ThoughtSpot: ts7.oct.cl, 7.2.1
             * @default false
             */
         queueMultiRenders?: boolean;
         /**
-            * Dynamic CSS Url to be injected in the loaded application.
+            * Dynamic CSS URL to be injected in the loaded application.
             * You would also need to set `style-src` in the CSP settings.
             *
             * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
@@ -1327,9 +1370,9 @@ export interface EmbedConfig {
             */
         customCssUrl?: string;
         /**
-            * [AuthServer|Basic] Detect if 3rd party cookies are enabled by doing an
+            * [AuthServer|Basic] Detect if third-party party cookies are enabled by doing an
             * additional call. This is slower and should be avoided. Listen to the
-            * NO_COOKIE_ACCESS event to handle the situation.
+            * `NO_COOKIE_ACCESS` event to handle the situation.
             *
             * This is slightly slower than letting the browser handle the cookie check, as it
             * involves an extra network call.
@@ -1338,26 +1381,26 @@ export interface EmbedConfig {
             */
         detectCookieAccessSlow?: boolean;
         /**
-            * Hide beta alert warning message for SearchEmbed.
+            * Hide the `beta` alert warning message for SearchEmbed.
             *
             * @version SDK: 1.12.0 | ThoughtSpot: 8.4.0.cl, 8.4.1.sw*
             */
         suppressSearchEmbedBetaWarning?: boolean;
         /**
-            * Hide beta alert warning message for SageEmbed.
+            * Hide `beta` alert warning message for SageEmbed.
             *
             */
         suppressSageEmbedBetaWarning?: boolean;
         /**
             * Custom style params for embed Config.
             *
-            * @version SDK: 1.17.0 | ThoughtSpot: 8.9.0.cl
+            * @version SDK: 1.17.0 | ThoughtSpot: 8.9.0.cl, 9.0.1.sw
             */
         customizations?: CustomisationsInterface;
         /**
-            * For inPopup SAMLRedirect or OIDCRedirect Auth, we need a button which the user
-            * click to trigger the flow. This is the containing element
-            * for that button.
+            * For `inPopup` SAMLRedirect or OIDCRedirect authentication, we need a
+            * button that the user can click to trigger the flow.
+            * This attribute sets a containing element for that button.
             *
             * @example
             * ```js
@@ -1367,11 +1410,11 @@ export interface EmbedConfig {
             *   authTriggerContainer: '#auth-trigger-container'
             * })
             * ```
-            * @version SDK: 1.17.0 | ThoughtSpot: *
+            * @version SDK: 1.17.0 | ThoughtSpot: 8.9.0.cl, 9.0.1.sw
             */
         authTriggerContainer?: string | HTMLElement;
         /**
-            * Specify that we want to use the AuthEvent.TRIGGER_SSO_POPUP event to trigger
+            * Specify that we want to use the `AuthEvent.TRIGGER_SSO_POPUP` event to trigger
             * SAML popup. This is useful when you want to trigger the popup on a custom user
             * action.
             *
@@ -1379,20 +1422,22 @@ export interface EmbedConfig {
         useEventForSAMLPopup?: boolean;
         /**
             * Text to show in the button which triggers the popup auth flow.
-            * Default: "Authorize".
+            * Default: `Authorize`.
             *
-            * @version SDK: 1.17.0 | ThoughtSpot: *
+            * @version SDK: 1.17.0 | ThoughtSpot: 8.9.0.cl, 9.0.1.sw
             */
         authTriggerText?: string;
         /**
-            * Disable Full App access of Embedded app outside of the iFrame.
+            * Prevent users from accessing the full application or ThoughtSpot application pages
+            * access to the embedded application users
+            * outside of the iframe.
             *
             * @default true
             * @version SDK: 1.22.0 | ThoughtSpot: 9.3.0.cl, 9.5.1.sw
             */
         blockNonEmbedFullAppAccess?: boolean;
         /**
-            * Host config incase embedded app is inside TS app itself
+            * Host config in case embedded app is inside TS app itself
             *
             * @hidden
             */
@@ -1414,21 +1459,35 @@ export interface EmbedConfig {
             * @version SDK: 1.26.2 | ThoughtSpot: *
             */
         suppressErrorAlerts?: boolean;
+        /**
+            * Log level for the SDK.
+            * @default LogLevel.ERROR
+            *
+            * @example
+            * ```js
+            * init({
+            *   ...embedConfig,
+            *   logLevel: LogLevel.SILENT
+            * })
+            * ```
+            * @version SDK: 1.26.3 | ThoughtSpot: 9.10.0.cl
+            */
+        logLevel?: LogLevel;
 }
 export interface LayoutConfig {
 }
 /**
-    * Embedded iFrame configuration
+    * Embedded iframe configuration
     *
     * @group Embed components
     */
 export interface FrameParams {
         /**
-            * The width of the iFrame (unit is pixels if numeric).
+            * The width of the iframe (unit is pixels if numeric).
             */
         width?: number | string;
         /**
-            * The height of the iFrame (unit is pixels if numeric).
+            * The height of the iframe (unit is pixels if numeric).
             */
         height?: number | string;
         /**
@@ -1529,7 +1588,6 @@ export interface ViewConfig {
             */
         runtimeParameters?: RuntimeParameter[];
         /**
-         /**
             * The locale/language to use for the embedded view.
             *
             * @version SDK: 1.9.4 | ThoughtSpot 8.1.0.cl, 8.4.1.sw
@@ -1629,31 +1687,29 @@ export interface ViewConfig {
             */
         reorderedHomepageModules?: HomepageModule[];
         /**
-            * The list of tab IDs to show in the embedded.
-            * Only this Tabs will be shown in their respective LBs.
-            * Use this to show an tabID.
+            * The list of tab IDs to show in the embedded Liveboard.
+            * Only the tabs specified in the array will be shown in the Liveboard.
             *
-            * Use either this or hiddenTabs.
+            * Use either `visibleTabs` or `hiddenTabs`.
             *
             * @example
             * ```js
-            * const embed = new LiveboardEmbed('#embed', {
-            *   ... // other liveboard view config
-            *   visibleTabs: [
+            * visibleTabs: [
             * '430496d6-6903-4601-937e-2c691821af3c',
-            *  'f547ec54-2a37-4516-a222-2b06719af726']
-            * });
+            * 'f547ec54-2a37-4516-a222-2b06719af726']
             * ```
             * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
             */
         visibleTabs?: string[];
         /**
-            * homepageLeftNavItems : show/hide Homeapage Left Nav Bar Items
-            * There are 8 home nav list items, we will send those item as list
-            * which we want to hide for TSE.
-            * eg: hiddenHomeLeftNavItems = [HomeLeftNavItem.Home] to hide home.
+            * homepageLeftNavItems : Show or hide the left navigation bar items.
+            * There are 8 eight home navigation list items.
+            * To hide these items, specify the string in the array.
             *
-            * @version SDK: 1.27.0 | Thoughtspot: 9.8.0.cl
+            * ```js
+            * hiddenHomeLeftNavItems = [HomeLeftNavItem.Home]
+            * ```
+            * @version SDK: 1.27.0 | Thoughtspot: 9.10.0.cl
             */
         hiddenHomeLeftNavItems?: HomeLeftNavItem[];
         /**
@@ -1669,7 +1725,7 @@ export interface ViewConfig {
             * });
             * embed.showPreRender();
             * ```
-            * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
+            * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl, 9.8.0.sw
             */
         preRenderId?: string;
         /**
@@ -1702,7 +1758,7 @@ export type MessagePayload = {
         status?: string;
 };
 /**
-    * MessageOptions: By Providing options, getting specific event start / end based on
+    * MessageOptions: By providing options, getting specific event start / end based on
     * option
     *
     * @group Events
@@ -1710,7 +1766,7 @@ export type MessagePayload = {
 export type MessageOptions = {
         /**
             *  A boolean value indicating that start status events of this type
-            *  will be dispatched
+            *  will be dispatched.
             */
         start?: boolean;
 };
@@ -1730,7 +1786,7 @@ responder?: (data: any) => void) => void;
     */
 export type MessageCallbackObj = {
         /**
-            *  options: It contains start, A boolean value indicating that start
+            *  options: It contains start, a boolean value indicating that start
             *  status events of this type will be dispatched
             */
         options: MessageOptions;
@@ -1802,7 +1858,7 @@ export enum RuntimeFilterOp {
         IN = "IN"
 }
 /**
-    * Home page module that can be hide
+    * Home page module that can be hidden
     */
 export enum HomepageModule {
         /**
@@ -1818,7 +1874,7 @@ export enum HomepageModule {
             */
         Favorite = "FAVORITE",
         /**
-            * List of answers and liveboards
+            * List of answers and Liveboards
             */
         MyLibrary = "MY_LIBRARY",
         /**
@@ -1851,7 +1907,7 @@ export interface RuntimeFilter {
         values: (number | boolean | string)[];
 }
 /**
-    * A filter that can be applied to ThoughtSpot answers, Liveboards, or
+    * A filter that can be applied to ThoughtSpot Answers, Liveboards, or
     * visualizations at runtime.
     */
 export interface RuntimeParameter {
@@ -1887,6 +1943,14 @@ export interface RuntimeParameter {
 export enum EmbedEvent {
         /**
             * Rendering has initialized.
+            * @example
+            *```js
+            * liveboardEmbed.on(EmbedEvent.Init, showLoader)
+            *  //show a loader
+            * function showLoader() {
+            * document.getElementById("loader");
+            * }
+            *```
             *
             * @returns timestamp - The timestamp when the event was generated.
             */
@@ -1894,69 +1958,162 @@ export enum EmbedEvent {
         /**
             * Authentication has either succeeded or failed.
             *
+            * @example
+            *```js
+            * appEmbed.on(EmbedEvent.AuthInit, payload => {
+            *    console.log('AuthInit', payload);
+            * })
+            *```
+            *
             * @returns isLoggedIn - A Boolean specifying whether authentication was successful.
             */
         AuthInit = "authInit",
         /**
             * The embed object container has loaded.
-            *
             * @returns timestamp - The timestamp when the event was generated.
+            * @example
+            *```js
+            * liveboardEmbed.on(EmbedEvent.Load, hideLoader)
+            *    //hide loader
+            * function hideLoader() {
+            *   document.getElementById("loader");
+            * }
+            *```
             */
         Load = "load",
         /**
             * Data pertaining to answer or Liveboard is received
-            *
             * @return data - The answer or Liveboard data
+            * @example
+            *```js
+            * liveboardEmbed.on(EmbedEvent.Data, payload => {
+            *    console.log('data', payload);
+            * })
+            *```
             * @important
             */
         Data = "data",
         /**
-            * Search/answer/Liveboard filters have been applied/updated by the user.
+            * Search/Answer/Liveboard filters have been applied/updated by the user.
             *
             * @hidden
             */
         FiltersChanged = "filtersChanged",
         /**
             * Search query has been updated by the user.
+            *
+            * @example
+            *```js
+            * searchEmbed.on(EmbedEvent.QueryChanged, payload => console.log('data', payload))
+            *```
+            *
             */
         QueryChanged = "queryChanged",
         /**
-            * A drill down operation has been performed.
+            * A drill-down operation has been performed.
             *
             * @returns additionalFilters - Any additional filters applied
             * @returns drillDownColumns - The columns on which drill down was performed
             * @returns nonFilteredColumns - The columns that were not filtered
+            *
+            * @example
+            *```js
+            * searchEmbed.trigger(HostEvent.DrillDown, {
+            *    points: {
+            *        clickedPoint,
+            *        selectedPoints: selectedPoint
+            *    },
+            *    autoDrillDown: true,
+            * })
+            *```
+            * In this example, `VizPointDoubleClick` event is used for
+            * triggering the `DrillDown` event when an area or specific
+            * data point on a table or chart is double-clicked.
+            *
+            * @example
+            *```js
+            * searchEmbed.on(EmbedEvent.VizPointDoubleClick, (payload) => {
+            *   console.log(payload);
+            *   const clickedPoint = payload.data.clickedPoint;
+            *   const selectedPoint = payload.data.selectedPoints;
+            *   console.log('>>> called', clickedPoint);
+            *   embed.trigger(HostEvent.DrillDown, {
+            *      points: {
+            *      clickedPoint,
+            *          selectedPoints: selectedPoint
+            *     },
+            *   autoDrillDown: true,
+            *     })
+            * })
+            *```
+            *
             */
         Drilldown = "drillDown",
         /**
             * One or more data sources have been selected.
-            *
             * @returns dataSourceIds - the list of data sources
+            *
+            * @example
+            * ```js
+            * searchEmbed.on(EmbedEvent.DataSourceSelected, payload => {
+            *    console.log('DataSourceSelected', payload);
+            * })
+            * ```
+            *
             */
         DataSourceSelected = "dataSourceSelected",
         /**
             * One or more data columns have been selected.
-            *
             * @returns columnIds - the list of columns
             * @version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
+            *
+            * @example
+            * ```js
+            * appEmbed.on(EmbedEvent.AddRemoveColumns, payload => {
+            *   console.log('AddRemoveColumns', payload);
+            * })
+            * ```
+            *
             */
         AddRemoveColumns = "addRemoveColumns",
         /**
-            * A custom action has been triggered
+            * A custom action has been triggered.
             *
-            * @returns actionId - The id of the custom action
-            * @returns data - The answer or Liveboard data
+            * @returns actionId - ID of the custom action
+            * @returns data - Response payload with the Answer or Liveboard data
+            *
+            * @example
+            * ```js
+            * appEmbed.on(EmbedEvent.customAction, payload => {
+            *     const data = payload.data;
+            *     if (data.id === 'insert Custom Action ID here') {
+            *         console.log('Custom Action event:', data.embedAnswerData);
+            *     }
+            * })
+            * ```
             */
         CustomAction = "customAction",
         /**
-            * Listen to double clicks on a visualization
+            * Listen to double click actions on a visualization.
+            *
+            * @return ContextMenuInputPoints - Data point that is double-clicked
             *
-            * @return ContextMenuInputPoints - data point that is double clicked
             * @version SDK: 1.5.0 | ThoughtSpot: ts7.oct.cl, 7.2.1
+            *
+            * @example
+            * ```js
+            * livebaordEmbed.on(EmbedEvent.VizPointDoubleClick, payload => {
+            *      console.log('VizPointDoubleClick', payload)
+            * })
+            * ```
             */
         VizPointDoubleClick = "vizPointDoubleClick",
         /**
-            * Listen to clicks on a visualization in a liveboard or Search result.
+            * Listen to clicks on a visualization in a Liveboard or Search result.
+            *
+            * @return viz, clickedPoint - metadata about the point that is clicked
+            * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
+            * @important
             *
             * @example
             * ```js
@@ -1970,25 +2127,46 @@ export enum EmbedEvent {
             *   )
             * });
             * ```
-            * @return viz, clickedPoint - metadata about point that is clicked
-            * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
-            * @important
             */
         VizPointClick = "vizPointClick",
         /**
             * An error has occurred.
             *
             * @returns error - An error object or message
+            *
+            * @example
+            * ```js
+            * SearchEmbed.on(EmbedEvent.Error, showErrorMsg)
+            * //show error messaage
+            *  function showErrorMsg() {
+            *    document.getElementById("error");
+            * ```
+            *
             */
         Error = "Error",
         /**
-            * The embedded object has sent an alert
+            * The embedded object has sent an alert.
             *
             * @returns alert - An alert object
+            *
+            * @example
+            * ```js
+            * searchEmbed.on(EmbedEvent.Alert)
+            * ```
+            *
             */
         Alert = "alert",
         /**
             * The ThoughtSpot auth session has expired.
+            *
+            * @example
+            *```js
+            * appEmbed.on(EmbedEvent.AuthExpire, showAuthExpired)
+            * //show auth expired banner
+            * function showAuthExpired() {
+            *    document.getElementById("authExpiredBanner");
+            * }
+            *```
             */
         AuthExpire = "ThoughtspotAuthExpired",
         /**
@@ -2018,14 +2196,28 @@ export enum EmbedEvent {
             */
         EmbedIframeCenter = "EmbedIframeCenter",
         /**
-            * Emitted when  the "Get Data" button in Search Bar embed
-            * is clicked.
+            * Emitted when the **Get Data** action is initiated.
+            * Applicable to `SearchBarEmbed` only.
+            *
+            * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
             *
-            * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.0.sw
+            * @example
+            *```js
+            * searchbarEmbed.on(EmbedEvent.GetDataClick)
+            *  .then(data => {
+            *  console.log('Answer Data:', data);
+            * })
+            *```
             */
         GetDataClick = "getDataClick",
         /**
             * Detects the route change.
+            *
+            * @example
+            *```js
+            * searchEmbed.on(EmbedEvent.RouteChange, payload =>
+            *    console.log('data', payload))
+            *```
             */
         RouteChange = "ROUTE_CHANGE",
         /**
@@ -2035,10 +2227,15 @@ export enum EmbedEvent {
             */
         V1Data = "exportVizDataToParent",
         /**
-            * Emitted when the embed does not have cookie access. This
-            * happens on Safari where third-party cookies are blocked by default.
+            * Emitted when the embed does not have cookie access. This happens
+            * when Safari and other Web browsers block third-party cookies
+            * are blocked by default. `NoCookieAccess` can trigger
             *
-            * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 7.2.1
+            * @example
+            *```js
+            * appEmbed.on(EmbedEvent.NoCookieAccess)
+            *```
+            * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 7.2.1.sw
             */
         NoCookieAccess = "noCookieAccess",
         /**
@@ -2050,239 +2247,539 @@ export enum EmbedEvent {
         SAMLComplete = "samlComplete",
         /**
             * Emitted when any modal is opened in the app
-            *
             * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
+            *
+            * @example
+            *```js
+            * appEmbed.on(EmbedEvent.DialogOpen, payload => {
+            *    console.log('dialog open', payload);
+            *  })
+            *```
             */
         DialogOpen = "dialog-open",
         /**
             * Emitted when any modal is closed in the app
-            *
             * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
+            *
+            * @example
+            *```js
+            * appEmbed.on(EmbedEvent.DialogClose, payload => {
+            *     console.log('dialog close', payload);
+            * })
+            *```
             */
         DialogClose = "dialog-close",
         /**
             * Emitted when the Liveboard shell loads.
             * You can use this event as a hook to trigger
             * other events on the rendered Liveboard.
-            *
             * @version SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
+            *
+            * @example
+            *```js
+            * liveboardEmbed.on(EmbedEvent.LiveboardRendered, payload => {
+                     console.log('Liveboard is rendered', payload);
+             })
+            *```
+            * The following example shows how to trigger
+            * `SetVisibleVizs` event using LiveboardRendered embed event:
+            *
+            * @example
+            *```js
+            * const embedRef = useEmbedRef();
+            * const onLiveboardRendered = () => {
+            * embed.trigger(HostEvent.SetVisibleVizs, ['viz1', 'viz2']);
+            * };
+            *```
             */
         LiveboardRendered = "PinboardRendered",
         /**
             * This can be used to register an event listener which
             * is triggered on all events.
-            *
             * @Version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
+            *
+            * @example
+            *```js
+            * appEmbed.on(EmbedEvent.ALL, payload => {
+            *  console.log('Embed Events', payload)
+            * })
+            *```
             */
         ALL = "*",
         /**
             * Emitted when an Answer is saved in the app
-            *
             * @Version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
+            * @example
+            *```js
+            * //trigger when action starts
+            *  searchEmbed.on(EmbedEvent.Save, payload => {
+            *    console.log('Save', payload)
+            *  }, {
+            *    start: true
+            * })
+            * //trigger when action ends
+            * searchEmbed.on(EmbedEvent.Save, payload => {
+            *    console.log('Save', payload)
+            * })
+            *```
             */
         Save = "save",
         /**
             * Emitted when the download action is triggered on an answer
             *
+            * **Note**: This event is deprecated in v1.21.0.
+            * To fire an event when a download action is initiated on a chart or table,
+            * use `EmbedEvent.DownloadAsPng`, `EmbedEvent.DownloadAsPDF`, `EmbedEvent.DownloadAsCSV`,
+            * or `EmbedEvent.DownloadAsXLSX`
+            *
             * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
+            *
+            * @example
+            *```js
+            * liveboardEmbed.trigger(HostEvent.Download, {
+            * vizId: '730496d6-6903-4601-937e-2c691821af3c'
+            * })
+            *```
             */
         Download = "download",
         /**
             * Emitted when the download action is triggered on an answer
-            *
             * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.4.0.sw
+            *
+            * @example
+            *```js
+            * //trigger when action starts
+            * searchEmbed.on(EmbedEvent.DownloadAsPng, payload => {
+            *   console.log('download PNG', payload)}, {start: true })
+            * //trigger when action ends
+            * searchEmbed.on(EmbedEvent.DownloadAsPng, payload => {
+            *   console.log('download PNG', payload)})
+            *```
+            *
             */
         DownloadAsPng = "downloadAsPng",
         /**
             * Emitted when the Download as PDF action is triggered on an answer
             *
             * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
+            *
+            * @example
+            *```js
+            * //trigger when action starts
+            * searchEmbed.on(EmbedEvent.DownloadAsPdf, payload => {
+            *   console.log('download PDF', payload)}, {start: true })
+            * //trigger when action ends
+            * searchEmbed.on(EmbedEvent.DownloadAsPdf, payload => {
+            *   console.log('download PDF', payload)})
+            *```
+            *
             */
         DownloadAsPdf = "downloadAsPdf",
         /**
             * Emitted when the Download as CSV action is triggered on an answer
             *
             * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
+            * @example
+            *```js
+            * //trigger when action starts
+            * searchEmbed.on(EmbedEvent.DownloadAsCSV, payload => {
+            *   console.log('download CSV', payload)}, {start: true })
+            * //trigger when action ends
+            * searchEmbed.on(EmbedEvent.DownloadAsCSV, payload => {
+            *    console.log('download CSV', payload)})
+            *```
             */
         DownloadAsCsv = "downloadAsCsv",
         /**
             * Emitted when the Download as XLSX action is triggered on an answer
             *
             * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
+            *
+            * @example
+            *```js
+            * //trigger when action starts
+            * searchEmbed.on(EmbedEvent.DownloadAsXlsx, payload => {
+            *   console.log('download Xlsx', payload)}, { start: true })
+            * //trigger when action ends
+            * searchEmbed.on(EmbedEvent.DownloadAsXlsx, payload => {
+            *   console.log('download Xlsx', payload)})
+            *```
             */
         DownloadAsXlsx = "downloadAsXlsx",
         /**
-            * Emitted when an answer is deleted in the app
+            * Emitted when an Answer is deleted in the app
             *
             * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
+            *
+            * @example
+            *```js
+            * //trigger when action starts
+            * appEmbed.on(EmbedEvent.AnswerDelete, payload => {
+            *    console.log('delete answer', payload)}, {start: true })
+            * //trigger when action is completed
+            * appEmbed.on(EmbedEvent.AnswerDelete, payload => {
+            *    console.log('delete answer', payload)})
+            *```
             */
         AnswerDelete = "answerDelete",
         /**
             * Emitted when an answer is pinned to a Liveboard
             *
             * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
+            * @example
+            *```js
+            * //trigger when action starts
+            * searchEmbed.on(EmbedEvent.Pin, payload => {
+            *    console.log('pin', payload)
+            * }, {
+            * start: true
+            * })
+            * //trigger when action ends
+            * searchEmbed.on(EmbedEvent.Pin, payload => {
+            *    console.log('pin', payload)
+            * })
+            *```
             */
         Pin = "pin",
         /**
             * Emitted when SpotIQ analysis is triggered
             *
             * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
+            * @example
+            *```js
+            * //trigger when action starts
+            * searchEmbed.on(EmbedEvent.SpotIQAnalyze, payload => {
+            *   console.log('SpotIQAnalyze', payload)
+            * }, {
+            * start: true
+            * })
+            * //trigger when action ends
+            * searchEmbed.on(EmbedEvent.SpotIQAnalyze, payload => {
+            *   console.log('SpotIQ analyze', payload)
+            * })
+            *```
             */
         SpotIQAnalyze = "spotIQAnalyze",
         /**
             * Emitted when a user shares an object with another user or group
             *
             * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
+            *
+            * @example
+            *```js
+            * //trigger when action starts
+            * searchEmbed.on(EmbedEvent.Share, payload => {
+            *    console.log('Share', payload)
+            * }, {
+            * start: true
+            * })
+            * //trigger when action ends
+            * searchEmbed.on(EmbedEvent.Share, payload => {
+            *   console.log('Share', payload)
+            * })
+            *```
             */
         Share = "share",
         /**
-            * Emitted when a user clicks the Include action to include a specific value or data
-            * on a chart or table
+            * Emitted when a user clicks the **Include** action to include a specific value or
+            * data on a chart or table.
             *
             * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
+            * @example
+            *```js
+            * appEmbed.on(EmbedEvent.DrillInclude, payload => {
+            *    console.log('Drill include', payload);
+            * })
+            *```
             */
         DrillInclude = "context-menu-item-include",
         /**
-            * Emitted when a user clicks the Exclude action to exclude a specific value or data
-            * on a chart or table
+            * Emitted when a user clicks the **Exclude** action to exclude a specific value or
+            * data on a chart or table
             *
             * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
+            * @example
+            *```js
+            * appEmbed.on(EmbedEvent.DrillExclude, payload => {
+            *     console.log('Drill exclude', payload);
+            * })
+            *```
             */
         DrillExclude = "context-menu-item-exclude",
         /**
-            * Emitted when copied column value on the app
+            * Emitted when a column value is copied in the embedded app.
             *
             * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
+            * @example
+            *```js
+            * seachEmbed.on(EmbedEvent.CopyToClipboard, payload => {
+            *    console.log('copy to clipboard', payload);
+            * })
+            *```
             */
         CopyToClipboard = "context-menu-item-copy-to-clipboard",
         /**
-            * Emitted when a user clicks the Update TML action
+            * Emitted when a user clicks the **Update TML** action
             *
             * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
+            * @example
+            *```js
+            * liveboardEmbed.on(EmbedEvent.UpdateTML)
+            * })
+            *```
             */
         UpdateTML = "updateTSL",
         /**
-            * Emitted when a user clicks the Edit TML action
+            * Emitted when a user clicks the **Edit TML** action
             *
             * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
+            * @example
+            *```js
+            * appEmbed.on(EmbedEvent.EditTML, payload => {
+            *    console.log('Edit TML', payload);
+            * })
+            *```
             */
         EditTML = "editTSL",
         /**
-            * Emitted when ExportTML trigger in answer on the app
-            *
+            * Emitted when the **Export TML** action is triggered on an
+            * an embedded object in the app
             * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
+            * @example
+            *```js
+            * //trigger when action starts
+            * searchEmbed.on(EmbedEvent.ExportTML, payload => {
+            *     console.log('Export TML', payload)}, { start: true })
+            * //trigger when action ends
+            * searchEmbed.on(EmbedEvent.ExportTML, payload => {
+            *     console.log('Export TML', payload)})
+            *```
             */
         ExportTML = "exportTSL",
         /**
-            * Emitted when an answer is saved as a view
+            * Emitted when an Answer is saved as a View.
             *
             * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
+            * @example
+            *```js
+            * appEmbed.on(EmbedEvent.SaveAsView, payload => {
+            *    console.log('View', payload);
+            * })
+            *```
             */
         SaveAsView = "saveAsView",
         /**
-            * Emitted when copy of existing answer on the app
+            * Emitted when the user creates a copy of an Answer
             *
             * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
+            * @example
+            *```js
+            * //trigger when action starts
+            * appEmbed.on(EmbedEvent.CopyAEdit, payload => {
+            *    console.log('Copy and edit', payload)}, {start: true })
+            * //trigger when action ends
+            * appEmbed.on(EmbedEvent.CopyAEdit, payload => {
+            *    console.log('Copy and edit', payload)})
+            *```
             */
         CopyAEdit = "copyAEdit",
         /**
-            * Emitted when a user clicks Show underlying data on an answe
+            * Emitted when a user clicks Show underlying data on an Answer
             *
             * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
+            * @example
+            *```js
+            * liveboardEmbed.on(EmbedEvent.ShowUnderlyingData, payload => {
+            *    console.log('show data', payload);
+            * })
+            *```
             */
         ShowUnderlyingData = "showUnderlyingData",
         /**
-            * Emitted when an answer is switched to a chart or table view
+            * Emitted when an answer is switched to a chart or table view.
             *
             * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
+            * @example
+            *```js
+            * searchEmbed.on(EmbedEvent.AnswerChartSwitcher, payload => {
+            *    console.log('switch view', payload);
+            * })
+            *```
             */
         AnswerChartSwitcher = "answerChartSwitcher",
         /**
-            * Internal event to communicate the initial settings back to the TS APP
+            * Internal event to communicate the initial settings back to the ThoughtSpot app
             *
             * @hidden
             */
         APP_INIT = "appInit",
         /**
-            * Emitted when a user clicks Show Liveboard details on a Liveboard
+            * Emitted when a user clicks **Show Liveboard details** on a Liveboard
             *
             * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
+            * @example
+            *```js
+            * liveboardEmbed.on(EmbedEvent.AnswerChartSwitcher, payload => {
+            *    console.log('Liveboard details', payload);
+            * })
+            *```
             */
         LiveboardInfo = "pinboardInfo",
         /**
             * Emitted when a user clicks on the Favorite icon on a Liveboard
             *
             * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
+            * @example
+            *```js
+            * liveboardEmbed.on(EmbedEvent.AddToFavorites, payload => {
+            *    console.log('favorites', payload);
+            * })
+            *```
             */
         AddToFavorites = "addToFavorites",
         /**
-            * Emitted when a user clicks Schedule on a Liveboard
+            * Emitted when a user clicks **Schedule** on a Liveboard
             *
             * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
+            * @example
+            *```js
+            * liveboardEmbed.on(EmbedEvent.Schedule, payload => {
+            *    console.log(`Liveboard schedule', payload);
+            * })
+            *```
             */
         Schedule = "subscription",
         /**
-            * Emitted when a user clicks Edit on a Liveboard or visualization
+            * Emitted when a user clicks **Edit** on a Liveboard or visualization
             *
             * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
+            * @example
+            *```js
+            * liveboardEmbed.on(EmbedEvent.Edit, payload => {
+            *    console.log(`Liveboard edit', payload);
+            * })
+            *```
             */
         Edit = "edit",
         /**
-            * Emitted when a user clicks Make a copy on a Liveboard
+            * Emitted when a user clicks *Make a copy* on a Liveboard
             *
             * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
+            * @example
+            *```js
+            * liveboardEmbed.on(EmbedEvent.MakeACopy, payload => {
+            *    console.log(`Copy', payload);
+            * })
+            *```
             */
         MakeACopy = "makeACopy",
         /**
-            * Emitted when a user clicks Present on a Liveboard or visualization
+            * Emitted when a user clicks **Present** on a Liveboard or visualization
             *
             * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
+            * @example
+            *```js
+            * liveboardEmbed.trigger(HostEvent.Present)
+            *```
+            *
+            * @example
+            *```js
+            * liveboardEmbed.on(EmbedEvent.Present, {
+            *   vizId: '730496d6-6903-4601-937e-2c691821af3c'})
+            * })
+            *```
             */
         Present = "present",
         /**
-            * Emitted when a user clicks Delete on a Liveboard
+            * Emitted when a user clicks **Delete** on a visualization
             *
             * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
+            * @example
+            *```js
+            * liveboardEmbed.trigger(HostEvent.Delete,
+            *   {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
+            *```
+            *
             */
         Delete = "delete",
         /**
             * Emitted when a user clicks Manage schedules on a Liveboard
             *
             * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
+            *
+            * @example
+            *```js
+            * liveboardEmbed.trigger(HostEvent.SchedulesList)
+            *```
+            *
             */
         SchedulesList = "schedule-list",
         /**
-            * Emitted when a user clicks Cancel in edit mode on a Liveboard
+            * Emitted when a user clicks **Cancel** in edit mode on a Liveboard
             *
             * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
+            *
+            * @example
+            *```js
+            * liveboardEmbed.trigger(HostEvent.Cancel)
+            *```
+            *
             */
         Cancel = "cancel",
         /**
-            * Emitted when a user clicks Explore on a visualization
+            * Emitted when a user clicks **Explore** on a visualization
             *
             * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
+            *
+            * @example
+            *```js
+            * liveboardEmbed.trigger(HostEvent.Explore,  {
+            *   vizId: '730496d6-6903-4601-937e-2c691821af3c'})
+            *```
+            *
             */
         Explore = "explore",
         /**
-            * Emitted when a user clicks Copy link action on a visualization
+            * Emitted when a user clicks **Copy link** action on a visualization
             *
             * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
+            *
+            * @example
+            *```js
+            * liveboardEmbed.trigger(HostEvent.CopyLink, {
+            *   vizId: '730496d6-6903-4601-937e-2c691821af3c'})
+            *```
+            *
             */
         CopyLink = "embedDocument",
         /**
-            * Emitted when a user interacts with cross filters on a visualization or liveboard
+            * Emitted when a user interacts with cross filters on a visualization or Liveboard
+            *
+            * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
+            *
+            * @example
+            *```js
+            * liveboardEmbed.trigger(HostEvent.CrossFilterChanged, {
+            *    vizId: '730496d6-6903-4601-937e-2c691821af3c'})
+            *```
             *
-            * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
             */
         CrossFilterChanged = "cross-filter-changed",
         /**
             * Emitted when a user right clicks on a visualization (chart or table)
             *
-            * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
+            * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
+            *
+            * @example
+            *```js
+            * LiveboardEmbed.on(EmbedEvent.VizPointRightClick, payload => {
+            *    console.log('VizPointClick', payload)
+            * })
+            *```
             */
         VizPointRightClick = "vizPointRightClick",
         /**
-            * Emitted when a user clicks on Insert to slide on a visualization
+            * Emitted when a user clicks **Insert to slide** on a visualization
             *
             * @hidden
             */
@@ -2290,52 +2787,53 @@ export enum EmbedEvent {
         /**
             * @hidden
             * Emitted when a user changes any filter on a Liveboard.
-            * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
+            * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl, 9.5.0.sw
             */
         FilterChanged = "filterChanged",
         /**
-            *  Emitted when a user click on Go button in Sage Embed
+            *  Emitted when a user clicks the **Go** button on the Search page
             *
-            * @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl
+            * @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
             */
         SageEmbedQuery = "sageEmbedQuery",
         /**
-            * Emitten when a user select data source in Sage Embed
+            * Emitted when a user selects a data source.
+            *
+            * @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
             *
-            * @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl
             */
         SageWorksheetUpdated = "sageWorksheetUpdated",
         /**
-            * Emitted when a user updates a connection in Data tab
+            * Emitted when a user updates a connection on the **Data** page
             *
-            * @version SDK : 1.27.0 | Thoughtspot: 9.8.0.cl
+            * @version SDK : 1.27.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
             */
         UpdateConnection = "updateConnection",
         /**
-            * Emitted when a user updates a connection in Data tab
+            * Emitted when a user updates a connection on the **Data** page
             *
-            * @version SDK : 1.27.0 | Thoughtspot: 9.8.0.cl
+            * @version SDK : 1.27.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
             */
         CreateConnection = "createConnection",
         /**
             * Emitted when name, status (private or public) or filter values of a
-            * PersonalisedView is updated.
+            * Personalised view is updated.
             *
             * @returns viewName: string
             * @returns viewId: string
             * @returns liveboardId: string
             * @returns isPublic: boolean
-            * @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl
+            * @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
             */
         UpdatePersonalisedView = "updatePersonalisedView",
         /**
-            * Emitted when a PersonalisedView is saved.
+            * Emitted when a Personalised view is saved.
             *
             * @returns viewName: string
             * @returns viewId: string
             * @returns liveboardId: string
             * @returns isPublic: boolean
-            * @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl
+            * @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
             */
         SavePersonalisedView = "savePersonalisedView",
         /**
@@ -2345,7 +2843,7 @@ export enum EmbedEvent {
             * @returns viewId: string
             * @returns liveboardId: string
             * @returns isPublic: boolean
-            * @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl
+            * @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
             */
         ResetLiveboard = "resetLiveboard",
         /**
@@ -2353,11 +2851,11 @@ export enum EmbedEvent {
             *
             * @returns views: string[]
             * @returns liveboardId: string
-            * @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl
+            * @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
             */
         DeletePersonalisedView = "deletePersonalisedView",
         /**
-            * Emitten when a user creates a new worksheet
+            * Emitted when a user creates a new worksheet
             *
             * @version SDK : 1.27.0 | Thoughtspot: 9.8.0.cl
             */
@@ -2387,15 +2885,16 @@ export enum EmbedEvent {
     */
 export enum HostEvent {
         /**
-            * Triggers a search query in AppEmbed and SearchEmbed
-            * deployments.
+            * Triggers a search operation with the search tokens specified in
+            * the search query string.
+            * Supported in `AppEmbed` and `SearchEmbed` deployments.
             * Includes the following properties:
             *
-            * @param - dataSourceIds - The data source GUID to Search on
+            * @param - `searchQuery` - query string with search tokens
+            * @param - `dataSources` - Data source GUID to Search on
             *                        - Although an array, only a single source
             *                          is supported.
-            * @param - searchQuery - Query string with search tokens
-            * @param - execute - executes the existing / updated query
+            * @param - `execute` - executes search and updates the existing query
             * @example
             * ```js
             * searchembed.trigger(HostEvent.Search, {
@@ -2415,6 +2914,10 @@ export enum HostEvent {
             * @param - columnGuid - Optional. GUID of the column to drill
             * by. If not provided it will auto drill by the configured
             *   column.
+            * @param - autoDrillDown - Optional. If true, the drill down will be
+            * done automatically on the most popular column.
+            * @param - vizId [TS >= 9.8.0] - Optional. The GUID of the visualization to drill
+            * in case of a liveboard.
             * @example
             * ```js
             * searchEmbed.on(EmbedEvent.VizPointDoubleClick, (payload) => {
@@ -2431,6 +2934,25 @@ export enum HostEvent {
             *       });
             * })
             * ```
+            * @example
+            * ```js
+            *  // Works with TS 9.8.0 and above
+            *
+            *  liveboardEmbed.on(EmbedEvent.VizPointDoubleClick, (payload) => {
+            *    console.log(payload);
+            *    const clickedPoint = payload.data.clickedPoint;
+            *    const selectedPoint = payload.data.selectedPoints;
+            *    console.log('>>> called', clickedPoint);
+            *    liveboardEmbed.trigger(HostEvent.DrillDown, {
+            *      points: {
+            *        clickedPoint,
+            *        selectedPoints: selectedPoint
+            *      },
+            *      autoDrillDown: true,
+            *      vizId: payload.data.vizId
+            *    });
+            *  })
+            * ```
             * @version SDK: 1.5.0 | ThoughtSpot: ts7.oct.cl, 7.2.1
             */
         DrillDown = "triggerDrillDown",
@@ -2447,7 +2969,7 @@ export enum HostEvent {
             */
         Reload = "reload",
         /**
-            * Sets the visible visualizations on a Liveboard.
+            * Display specific visualizations on a Liveboard.
             *
             * @param - An array of GUIDs of the visualization to show. The visualization IDs not passed
             *  in this parameter will be hidden.
@@ -2461,7 +2983,7 @@ export enum HostEvent {
             */
         SetVisibleVizs = "SetPinboardVisibleVizs",
         /**
-            * Set the Active Tab of a Liveboard.
+            * Set a Liveboard tab as an active tab.
             *
             * @param - tabId - string of id of Tab to show
             * @example
@@ -2474,7 +2996,7 @@ export enum HostEvent {
             */
         SetActiveTab = "SetActiveTab",
         /**
-            * Updates runtime filters applied on a Saved Answer or Liveboard. The
+            * Update runtime filters applied on a Saved Answer or Liveboard. The
             * runtime filters passed here are appended to the existing runtime
             * filters.
             * Pass an array of runtime filters with the following attributes:
@@ -2500,10 +3022,12 @@ export enum HostEvent {
             */
         UpdateRuntimeFilters = "UpdateRuntimeFilters",
         /**
-            * Navigate to a specific page in the embedded application without reloading the page.
+            * Navigate to a specific page in the embedded ThoughtSpot application.
             * This is the same as calling `appEmbed.navigateToPage(path, true)`
             *
-            * @param - path - the path to navigate to (can be a number[1/-1] to go forward/back)
+            * @param - `path` - the path to navigate to to go forward or back. The path value can
+            * be a number; for example, `1`, `-1`.
+            *
             * @example
             * ```js
             * appEmbed.navigateToPage(-1)
@@ -2512,7 +3036,7 @@ export enum HostEvent {
             */
         Navigate = "Navigate",
         /**
-            * Opens the filter panel for a particular column.
+            * Open the filter panel for a particular column.
             * Works with Search and Liveboard embed.
             *
             * @param - { columnId: string,
@@ -2530,7 +3054,7 @@ export enum HostEvent {
             */
         OpenFilter = "openFilter",
         /**
-            * Adds columns to the current search query.
+            * Add columns to the current search query.
             *
             * @param - { columnIds: string[] }
             * @example
@@ -2541,7 +3065,7 @@ export enum HostEvent {
             */
         AddColumns = "addColumns",
         /**
-            * Removes a column from the current search query.
+            * Remove a column from the current search query.
             *
             * @param - { columnId: string }
             * @example
@@ -2552,27 +3076,29 @@ export enum HostEvent {
             */
         RemoveColumn = "removeColumn",
         /**
-            * Gets the current Liveboard content.
+            * Get the transient state of a Liveboard as encoded content.
+            * This includes unsaved and ad hoc changes such as
+            * Liveboard filters, runtime filters applied on visualizations on a
+            * Liveboard, and Liveboard layout, changes to visualizations such as
+            * sorting, toggling of legends, and data drill down.
             *
             * @example
             * ```js
-            * liveboardEmbed.trigger(HostEvent.getExportRequestForCurrentPinboard)
+            * liveboardEmbed.trigger(HostEvent.getexportrequestforcurrentpinboard).then(
+            * data=>console.log(data))
             * ```
             * @version SDK: 1.13.0 | ThoughtSpot: 8.5.0.cl, 8.8.1.sw
             */
         getExportRequestForCurrentPinboard = "getExportRequestForCurrentPinboard",
         /**
-            * Triggers the **Pin** action on an embedded object
+            * Trigger the **Pin** action on an embedded object
             *
             * @param - Liveboard embed takes the `vizId` as a
-            * key. Can be left undefined when embedding Search, full app or
+            * key. Can be left undefined when embedding Search, full app, or
             * a visualization.
             * @example
             * ```js
-            * liveboardEmbed.trigger(HostEvent.Pin, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
-            * ```
-            * ```js
-            * vizEmbed.trigger(HostEvent.Pin)
+            * appEmbed.trigger(HostEvent.Pin)
             * ```
             * ```js
             * searchEmbed.trigger(HostEvent.Pin)
@@ -2581,17 +3107,18 @@ export enum HostEvent {
             */
         Pin = "pin",
         /**
-            * Triggers the **Show Liveboard details** action on a Liveboard
+            * Trigger the **Show Liveboard details** action
+            * on an embedded Liveboard.
             *
             * @example
-            * ```js
-            *  liveboardEmbed.trigger(HostEvent.LiveboardInfo)
-            * ```
+            *```js
+            * liveboardEmbed.trigger(HostEvent.LiveboardInfo)
+            *```
             * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
             */
         LiveboardInfo = "pinboardInfo",
         /**
-            * Triggers the **Schedule** action on a Liveboard
+            * Trigger the **Schedule** action on an embedded Liveboard.
             *
             * @example
             * ```js
@@ -2601,7 +3128,7 @@ export enum HostEvent {
             */
         Schedule = "subscription",
         /**
-            * Triggers the **Manage schedule** action on a Liveboard
+            * Trigger the **Manage schedule** action on an embedded Liveboard
             *
             * @example
             * ```js
@@ -2611,7 +3138,7 @@ export enum HostEvent {
             */
         SchedulesList = "schedule-list",
         /**
-            * Triggers the **Export TML** action on a Liveboard
+            * Trigger the **Export TML** action on an embedded Liveboard.
             *
             * @example
             * ```js
@@ -2621,7 +3148,7 @@ export enum HostEvent {
             */
         ExportTML = "exportTSL",
         /**
-            * Triggers the **Edit TML** action on a Liveboard
+            * Trigger the **Edit TML** action on an embedded Liveboard.
             *
             * @example
             * ```js
@@ -2631,7 +3158,7 @@ export enum HostEvent {
             */
         EditTML = "editTSL",
         /**
-            * Triggers the **Update TML** action on a Liveboard
+            * Trigger the **Update TML** action on an embedded Liveboard.
             *
             * @example
             * ```js
@@ -2641,7 +3168,7 @@ export enum HostEvent {
             */
         UpdateTML = "updateTSL",
         /**
-            * Triggers the **Download PDF** action on a Liveboard
+            * Trigger the **Download PDF** action on an embedded Liveboard.
             *
             * @example
             * ```js
@@ -2651,8 +3178,8 @@ export enum HostEvent {
             */
         DownloadAsPdf = "downloadAsPdf",
         /**
-            * Triggers the **Make a copy** action on a Liveboard, Search, or
-            * visualization page
+            * Trigger the **Make a copy** action on a Liveboard, Search, or
+            * visualization page.
             *
             * @example
             * ```js
@@ -2668,7 +3195,7 @@ export enum HostEvent {
             */
         MakeACopy = "makeACopy",
         /**
-            * Triggers the **Delete** action on a Liveboard
+            * Trigger the **Delete** action for a Liveboard.
             *
             * @example
             * ```js
@@ -2678,7 +3205,7 @@ export enum HostEvent {
             */
         Remove = "delete",
         /**
-            * Triggers the **Explore* action on a visualization
+            * Trigger the **Explore** action on a visualization.
             *
             * @param - an object with `vizId` as a key
             * @example
@@ -2689,7 +3216,7 @@ export enum HostEvent {
             */
         Explore = "explore",
         /**
-            * Triggers the **Create alert** action on a visualization
+            * Trigger the **Create alert** action on a visualization
             *
             * @param - an object with `vizId` as a key
             * @example
@@ -2702,7 +3229,7 @@ export enum HostEvent {
             */
         CreateMonitor = "createMonitor",
         /**
-            * Triggers the **Manage alerts** action on a visualization
+            * Trigger the **Manage alerts** action on a visualization
             *
             * @param - an object with `vizId` as a key
             * @example
@@ -2715,7 +3242,7 @@ export enum HostEvent {
             */
         ManageMonitor = "manageMonitor",
         /**
-            * Triggers the **Edit** action on a Liveboard or visualization
+            * Trigger the **Edit** action on a Liveboard or visualization
             *
             * @param - object - To trigger the action for a specific visualization
             * in Liveboard embed, pass in `vizId` as a key.
@@ -2736,7 +3263,7 @@ export enum HostEvent {
             */
         Edit = "edit",
         /**
-            * Triggers the **Copy link** action on a Liveboard or visualization
+            * Trigger the **Copy link** action on a Liveboard or visualization
             *
             * @param - object - to trigger the action for a
             * specific visualization in Liveboard embed, pass in `vizId` as a key
@@ -2754,7 +3281,7 @@ export enum HostEvent {
             */
         CopyLink = "embedDocument",
         /**
-            * Triggers the **Present** action on a Liveboard or visualization
+            * Trigger the **Present** action on a Liveboard or visualization
             *
             * @param - object - to trigger the action for a specific visualization
             *  in Liveboard embed, pass in `vizId` as a key
@@ -2772,7 +3299,7 @@ export enum HostEvent {
             */
         Present = "present",
         /**
-            * Gets TML for the current search.
+            * Get TML for the current search.
             *
             * @example
             * ```js
@@ -2787,7 +3314,7 @@ export enum HostEvent {
             */
         GetTML = "getTML",
         /**
-            * Triggers the **Show underlying data** action on visualization or search
+            * Trigger the **Show underlying data** action on visualization or search
             *
             * @param - an object with vizId as a key
             * @example
@@ -2805,7 +3332,9 @@ export enum HostEvent {
             */
         ShowUnderlyingData = "showUnderlyingData",
         /**
-            * Triggers the **Delete** action on visualization or search
+            * Trigger the **Delete** action for a visualization
+            * in an embedded Liveboard, or a chart or table
+            * generated from Search.
             *
             * @param - Liveboard embed takes an object with `vizId` as a key.
             * Can be left empty if embedding Search or visualization.
@@ -2815,16 +3344,13 @@ export enum HostEvent {
             * '730496d6-6903-4601-937e-2c691821af3c'})
             * ```
             * ```js
-            * vizEmbed.trigger(HostEvent.Delete)
-            * ```
-            * ```js
             * searchEmbed.trigger(HostEvent.Delete)
             * ```
             * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
             */
         Delete = "onDeleteAnswer",
         /**
-            * Triggers the **SpotIQ analyze** action on visualization
+            * Trigger the **SpotIQ analyze** action on visualization
             * or search.
             *
             * @param - Liveboard embed takes `vizId` as a
@@ -2845,7 +3371,7 @@ export enum HostEvent {
             */
         SpotIQAnalyze = "spotIQAnalyze",
         /**
-            * Triggers the **Download** action on charts in
+            * Trigger the **Download** action on charts in
             * the embedded view.
             *
             * @example
@@ -2854,17 +3380,15 @@ export enum HostEvent {
             * '730496d6-6903-4601-937e-2c691821af3c'})
             * ```
             * ```js
-            * vizEmbed.trigger(HostEvent.Download)
-            * ```
-            * ```js
-            * searchEmbed.trigger(HostEvent.Download)
+            * embed.trigger(HostEvent.Download)
             * ```
-            * @deprecated from SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl ,9.4.1.sw ,Use {@link DownloadAsPng}
+            * @deprecated from SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl ,9.4.1.sw
+            * Use {@link DownloadAsPng}
             * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
             */
         Download = "downloadAsPng",
         /**
-            * Triggers the **Download** > **PNG** action on
+            * Trigger the **Download** > **PNG** action on
             * charts in the embedded view.
             *
             * @example
@@ -2880,7 +3404,7 @@ export enum HostEvent {
             */
         DownloadAsPng = "downloadAsPng",
         /**
-            * Triggers the **Download** > **CSV**  action on tables in
+            * Trigger the **Download** > **CSV**  action on tables in
             * the embedded view.
             *
             * @example
@@ -2898,7 +3422,7 @@ export enum HostEvent {
             */
         DownloadAsCsv = "downloadAsCSV",
         /**
-            * Triggers the **Download** > **XLSX**  action on tables
+            * Trigger the **Download** > **XLSX**  action on tables
             * in the embedded view.
             *
             * @example
@@ -2916,7 +3440,7 @@ export enum HostEvent {
             */
         DownloadAsXlsx = "downloadAsXLSX",
         /**
-            * Triggers the **Share** action on an embedded
+            * Trigger the **Share** action on an embedded
             * Liveboard or Answer.
             *
             * @example
@@ -2930,7 +3454,7 @@ export enum HostEvent {
             */
         Share = "share",
         /**
-            * Triggers the **Save**  action on a Liveboard or Answer.
+            * Trigger the **Save**  action on a Liveboard or Answer.
             * Saves the changes.
             *
             * @example
@@ -2944,7 +3468,7 @@ export enum HostEvent {
             */
         Save = "save",
         /**
-            * Triggers the **Sync to Sheets** action on an embedded visualization or Answer
+            * Trigger the **Sync to Sheets** action on an embedded visualization or Answer
             * Sends data from an Answer or Liveboard visualization to a Google sheet.
             *
             * @param - an object with `vizId` as a key
@@ -2960,7 +3484,7 @@ export enum HostEvent {
             */
         SyncToSheets = "sync-to-sheets",
         /**
-            * Triggers the **Sync to Other Apps** action on an embedded visualization or Answer
+            * Trigger the **Sync to Other Apps** action on an embedded visualization or Answer
             * Sends data from an Answer or Liveboard visualization to third-party apps such
             * as Slack, Salesforce, Microsoft Teams, ServiceNow and so on.
             *
@@ -2977,7 +3501,7 @@ export enum HostEvent {
             */
         SyncToOtherApps = "sync-to-other-apps",
         /**
-            * Triggers the **Manage pipelines** action on an embedded
+            * Trigger the **Manage pipelines** action on an embedded
             * visualization or Answer.
             * Allows users to manage ThoughtSpot Sync pipelines.
             *
@@ -2994,18 +3518,21 @@ export enum HostEvent {
             */
         ManagePipelines = "manage-pipeline",
         /**
-            * Triggers the Reset search on the Search page
+            * Reset search operation on the Search or Answer page.
             *
             * @example
             * ```js
             * searchEmbed.trigger(HostEvent.ResetSearch)
             * ```
+            * ```js
+            * appEmbed.trigger(HostEvent.ResetSearch)
+            * ```
             * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.0.1.sw
             */
         ResetSearch = "resetSearch",
         /**
             * @hidden
-            * Gets the currents visible and runtime filters applied on a Liveboard
+            * Get the currents visible and runtime filters applied on a Liveboard
             * @example
             * liveboardEmbed.trigger(HostEvent.GetFilters)
             * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
@@ -3013,7 +3540,7 @@ export enum HostEvent {
         GetFilters = "getFilters",
         /**
             * @hidden
-            * Updates the visible filters on the Liveboard.
+            * Update the visible filters on the Liveboard.
             * @param - filter: filter object containing column name and filter operation and values
             * @example
             *
@@ -3026,7 +3553,7 @@ export enum HostEvent {
             */
         UpdateFilters = "updateFilters",
         /**
-            * Get Tab for the current Liveboard.
+            * Get tab details for the current Liveboard.
             *
             * @example
             * ```js
@@ -3040,9 +3567,9 @@ export enum HostEvent {
             */
         GetTabs = "getTabs",
         /**
-            * Set the visible Tabs on a Liveboard.
+            * Set the visible tabs on a Liveboard.
             *
-            * @param - an array of ids of Tabs to show, the ids not passed
+            * @param - an array of ids of tabs to show, the IDs not passed
             *          will be hidden.
             * @example
             * ```js
@@ -3056,8 +3583,8 @@ export enum HostEvent {
         /**
             * Set the hidden tabs on a Liveboard.
             *
-            * @param - an array of ids of Tabs to hide, the ids not passed
-            *          will be shown.
+            * @param - an array of the IDs of the tabs to hide.
+            * The IDs not passed will be shown.
             * @example
             * ```js
             * liveboardEmbed.trigger(HostEvent.SetHiddenTabs, [
@@ -3068,9 +3595,12 @@ export enum HostEvent {
             */
         SetHiddenTabs = "SetPinboardHiddenTabs",
         /**
-            * Updates the search query for sage embed.
+            * Updates the search query string for Natural Language Search operations.
+            *
+            * @param - `queryString`: Text string in Natural Language format
+            *
+            * @param - `executeSearch`: Boolean to execute search and update search query
             *
-            * @param - searchOptions: an object queryString and option to execute the query.
             * @example
             * ```js
             * sageEmbed.trigger(HostEvent.UpdateSageQuery, {
@@ -3078,7 +3608,7 @@ export enum HostEvent {
             *  executeSearch: true,
             * })
             * ```
-            * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
+            * @version SDK: 1.26.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
             */
         UpdateSageQuery = "updateSageQuery",
         /**
@@ -3091,24 +3621,25 @@ export enum HostEvent {
             *      vizId: '123', // For Liveboard Visualization.
             *  })
             * ```
+            * @version SDK: 1.26.0 | Thoughtspot: 9.10.0.cl
             */
         GetAnswerSession = "getAnswerSession"
 }
 /**
     * The different visual modes that the data sources panel within
-    * search could appear in, i.e., hidden, collapsed, or expanded.
+    * search could appear in, such as hidden, collapsed, or expanded.
     */
 export enum DataSourceVisualMode {
         /**
-            * Data source panel is hidden.
+            * The data source panel is hidden.
             */
         Hidden = "hide",
         /**
-            * Data source panel is collapsed, but the user can manually expand it.
+            * The data source panel is collapsed, but the user can manually expand it.
             */
         Collapsed = "collapse",
         /**
-            * Data source panel is expanded, but the user can manually collapse it.
+            * The data source panel is expanded, but the user can manually collapse it.
             */
         Expanded = "expand"
 }
@@ -3184,7 +3715,10 @@ export enum Param {
         LiveboardHeaderSticky = "isLiveboardHeaderSticky",
         IsProductTour = "isProductTour",
         HideSearchBarTitle = "hideSearchBarTitle",
-        HideSageAnswerHeader = "hideSageAnswerHeader"
+        HideSageAnswerHeader = "hideSageAnswerHeader",
+        HideSearchBar = "hideSearchBar",
+        ClientLogLevel = "clientLogLevel",
+        OverrideNativeConsole = "overrideConsoleLogs"
 }
 /**
     * ThoughtSpot application pages include actions and menu commands
@@ -3244,9 +3778,11 @@ export enum Action {
         SaveAsView = "saveAsView",
         /**
             * The **Make a copy** action on a Liveboard or Answer
-            * page.
-            * Creates a copy of the Liveboard, visualization,
-            * or Answer.
+            * page. Creates a copy of the Liveboard.
+            * In LiveboardEmbed, the **Make a copy** action is not available for
+            * visualizations in the embedded Liveboard view.
+            * In AppEmbed, the **Make a copy** action is available on both
+            * Liveboards and visualizations.
             *
             * @example
             * ```js
@@ -3430,7 +3966,7 @@ export enum Action {
             */
         DownloadAsPdf = "downloadAsPdf",
         /**
-            * The **Download**  > **CSV** menu action for tables on a Liveboard
+            * The **Download** > **CSV** menu action for tables on a Liveboard
             * or Answer page.
             * Downloads a visualization or Answer in the XLSX format.
             *
@@ -3961,6 +4497,7 @@ export enum Action {
             */
         RenameModalTitleDescription = "renameModalTitleDescription",
         /**
+            *
             * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
             */
         RequestVerification = "requestVerification",
@@ -4096,6 +4633,14 @@ export interface CustomActionPayload {
         session: SessionInterface;
         vizId?: string;
 }
+export enum LogLevel {
+        SILENT = "SILENT",
+        ERROR = "ERROR",
+        WARN = "WARN",
+        INFO = "INFO",
+        DEBUG = "DEBUG",
+        TRACE = "TRACE"
+}
 
 /**
     * The list of customization css variables. These
@@ -4451,14 +4996,14 @@ export interface CustomCssVariables {
     */
 export interface SearchOptions {
         /**
-            * The query string to pre-fill in natual language search bar
+            * The query string to pass for Natural Language Search.
             */
         searchQuery: string;
         /**
-            * Boolean to determine if the search should be executed or not.
-            * if it is executed, put the focus on the results.
-            * if it’s not executed, put the focus in the search bar - at the end of
-            * the tokens
+            * Boolean to define if the search should be executed or not.
+            * If it is executed, the focus is placed on the results.
+            * If it’s not executed, the focus is placed at the end of
+            * the token string in the search bar.
             */
         executeSearch?: boolean;
 }
@@ -4466,16 +5011,16 @@ export interface SearchOptions {
     * The configuration attributes for the embedded Natural language search view. Based on
     * GPT and LLM.
     *
-    * @version: SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl, 9.5.1-sw
+    * @version: SDK: 1.23.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
     * @group Embed components
     */
 export interface SageViewConfig extends Omit<ViewConfig, 'hiddenHomepageModules' | 'hiddenHomeLeftNavItems' | 'hiddenTabs' | 'visibleTabs' | 'reorderedHomepageModules'> {
         /**
-            * If set to true, a list of liveboard and answers related
+            * If set to true, a list of Liveboard and Answers related
             * to the natural language search will be shown below the
             * AI generated answer.
             *
-            * @deprecated Currently liveboard and answers related
+            * @deprecated Currently Liveboard and Answers related
             * to the natural language search will not be shown for sage
             * embed
             */
@@ -4492,63 +5037,81 @@ export interface SageViewConfig extends Omit<ViewConfig, 'hiddenHomepageModules'
             */
         isProductTour?: boolean;
         /**
-            * flag to hide search bar title. default false.
+            * Show or hide the search bar title.
             *
-            * @version SDK: 1.26.0 | Thoughtspot: 9.8.0.cl
+            * @version SDK: 1.26.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
             */
         hideSearchBarTitle?: boolean;
         /**
-            * flag to disable Sage Answer header(`AI Answer` title section on top of the Sage
-            * answer). default false.
+            * Show or hide the Answer header, that is, the `AI Answer` title
+            * at the top of the Answer page.
             *
-            * @version SDK: 1.26.0 | Thoughtspot: 9.9.0.cl
+            * @version SDK: 1.26.0 | Thoughtspot: 9.10.0.cl
             */
         hideSageAnswerHeader?: boolean;
         /**
-            * flag to disable changing worksheet. default false.
+            * Disable the worksheet selection option.
             *
-            * @version SDK: 1.26.0 | Thoughtspot: 9.9.0.cl
+            * @version SDK: 1.26.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
             */
         disableWorksheetChange?: boolean;
         /**
-            * flag to hide worksheet selector. default false.
+            * Hide the worksheet selection panel.
+            *
+            * @version SDK: 1.26.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
             */
         hideWorksheetSelector?: boolean;
         /**
-            * If set to true, the search bar auto complete search suggestions will not be shown.
-            * default false
+            * Show or hide autocomplete suggestions for the search query string.
             *
-            * @version SDK: 1.26.0 | Thoughtspot: 9.9.0.cl
+            * @version SDK: 1.26.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
             */
         hideAutocompleteSuggestions?: boolean;
         /**
-            * If set to false, the auto complete search suggestions not be shown
+            * Show or hide autocomplete suggestions for the search query string.
             *
-            * @deprecated currently, object suggestions will not be shown for sage embed
-            * earlier this flag was used to show Auto complete suggestions
+            * @deprecated
+            * Currently, the object suggestions will not be shown for Natural Language Search.
+            * You can use {@link hideAutocompleteSuggestions} instead.
             */
         showObjectSuggestions?: boolean;
         /**
-            * If set to true, sample questions would be hidden to user.
-            * These sample questions are autogenerated based on selected datasource.
+            * Show or hide sample questions.
+            * The sample questions are autogenerated based on the worksheet
+            * selected for the search operation.
             *
-            * @version SDK: 1.26.0 | Thoughtspot: 9.10.0.cl
+            * @version SDK: 1.26.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
             */
         hideSampleQuestions?: boolean;
         /**
-            * The data source GUID to set on load.
+            * The data source GUID (Worksheet GUID) to set on load.
             */
         dataSource?: string;
         /**
-            * Configuration for search options
+            * Includes the following properties:
             *
-            * @version SDK: 1.26.0 | Thoughtspot: 9.8.0.cl
+            * `searchQuery`: The search query string to pass in the search bar.
+            * Supports Natural Language Search queries.
+            *
+            * `executeSearch`: Boolean to define if the search should be executed or not.
+            * If it is executed, the focus is placed on the results.
+            * If it’s not executed, the focus is placed at the end of
+            * the token string in the search bar.
+            *
+            * @example
+            * ```js
+            * searchOptions: {
+            *    searchQuery: 'average sales by country and product type',
+            *    executeSearch: true,
+            * }
+            * ```
+            * @version SDK: 1.26.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
             */
         searchOptions?: SearchOptions;
 }
 export const HiddenActionItemByDefaultForSageEmbed: Action[];
 /**
-    * Embed ThoughtSpot LLM and GPT based natural language search component.
+    * Embed ThoughtSpot LLM and GPT-based Natural Language Search component.
     *
     * @version: SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl, 9.5.1-sw
     * @group Embed components
@@ -4607,8 +5170,7 @@ interface UnderlyingDataPoint {
     *     const data = await underlying.fetchData(0, 100);
     *  })
     * ```
-    * @version
-    * ThoughtSpot: 9.9.0.cl / SDK: 1.25.0
+    * @version SDK: 1.25.0| ThoughtSpot: 9.10.0.cl
     * @group Events
     */
 export class AnswerService {
@@ -4642,8 +5204,7 @@ export class AnswerService {
             *     const data = await underlying.fetchData(0, 100);
             *  })
             * ```
-            * @version
-            * ThoughtSpot: 9.9.0.cl / SDK: 1.25.0
+            * @version SDK: 1.25.0| ThoughtSpot: 9.10.0.cl
             */
         getUnderlyingDataForPoint(outputColumnNames: string[], selectedPoints?: UnderlyingDataPoint[]): Promise<AnswerService>;
         executeQuery(query: string, variables: any): Promise<any>;
@@ -4661,12 +5222,13 @@ export {};
 export const getEmbedConfig: () => EmbedConfig;
 /**
     * Sets the configuration embed was initialized with.
+    * And returns the new configuration.
     *
     * @param newConfig The configuration to set.
     * @version SDK: 1.27.0 | ThoughtSpot: *
     * @group Global methods
     */
-export const setEmbedConfig: (newConfig: EmbedConfig) => void;
+export const setEmbedConfig: (newConfig: EmbedConfig) => EmbedConfig;
 
 /**
     * Copyright (c) 2022