@thoughtspot/visual-embed-sdk 1.27.9 → 1.27.11

package/lib/src/visual-embed-sdk.d.ts

@@ -18,12 +18,14 @@ declare module '@thoughtspot/visual-embed-sdk' {
     import { SearchEmbed, SearchViewConfig } from '@thoughtspot/visual-embed-sdk/embed/search';
     import { SearchBarEmbed, SearchBarViewConfig } from '@thoughtspot/visual-embed-sdk/embed/search-bar';
     import { AuthFailureType, AuthStatus, AuthEvent, AuthEventEmitter, getSessionInfo } from '@thoughtspot/visual-embed-sdk/auth';
-    import { AuthType, RuntimeFilter, RuntimeFilterOp, EmbedEvent, HostEvent, DataSourceVisualMode, Action, EmbedConfig, PrefetchFeatures, FrameParams, DOMSelector, HomeLeftNavItem, HomepageModule, MessageOptions, MessageCallback, MessagePayload, CustomisationsInterface, CustomStyles, customCssInterface, ContextMenuTriggerOptions, RuntimeParameter, LogLevel } from '@thoughtspot/visual-embed-sdk/types';
+    import { AuthType, RuntimeFilter, RuntimeFilterOp, EmbedEvent, HostEvent, DataSourceVisualMode, Action, EmbedConfig, PrefetchFeatures, FrameParams, DOMSelector, HomeLeftNavItem, HomepageModule, MessageOptions, MessageCallback, MessagePayload, CustomisationsInterface, CustomStyles, customCssInterface, ContextMenuTriggerOptions, RuntimeParameter, LogLevel, VizPoint, CustomActionPayload } from '@thoughtspot/visual-embed-sdk/types';
     import { CustomCssVariables } from '@thoughtspot/visual-embed-sdk/css-variables';
     import { SageEmbed, SageViewConfig } from '@thoughtspot/visual-embed-sdk/embed/sage';
-    import { AnswerService } from '@thoughtspot/visual-embed-sdk/utils/graphql/answerService/answerService';
+    import { AnswerService, SessionInterface, UnderlyingDataPoint } from '@thoughtspot/visual-embed-sdk/utils/graphql/answerService/answerService';
     import { getEmbedConfig } from '@thoughtspot/visual-embed-sdk/embed/embedConfig';
-    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, };
+    import { uploadMixpanelEvent, MIXPANEL_EVENT } from '@thoughtspot/visual-embed-sdk/mixpanel-service';
+    import { tokenizedFetch } from '@thoughtspot/visual-embed-sdk/tokenizedFetch';
+    export { init, logout, prefetch, executeTML, exportTML, executeTMLInput, exportTMLInput, getEmbedConfig as getInitConfig, getSessionInfo, tokenizedFetch, SearchEmbed, SearchBarEmbed, PinboardEmbed, LiveboardEmbed, SageEmbed, AppEmbed, AuthFailureType, AuthStatus, AuthEvent, AuthEventEmitter, AnswerService, SessionInterface, UnderlyingDataPoint, 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, uploadMixpanelEvent, MIXPANEL_EVENT, VizPoint, CustomActionPayload, };
 }
 
 declare module '@thoughtspot/visual-embed-sdk/embed/app' {
@@ -37,7 +39,7 @@ declare module '@thoughtspot/visual-embed-sdk/embed/app' {
         * @module
         * @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
         */
-    import { DOMSelector, ViewConfig, MessagePayload } from '@thoughtspot/visual-embed-sdk/types';
+    import { DOMSelector, MessagePayload, ViewConfig } from '@thoughtspot/visual-embed-sdk/types';
     import { V1Embed } from '@thoughtspot/visual-embed-sdk/embed/ts-embed';
     /**
         * Pages within the ThoughtSpot app that can be embedded.
@@ -82,6 +84,16 @@ declare module '@thoughtspot/visual-embed-sdk/embed/app' {
                 * If true, the top navigation bar within the ThoughtSpot app
                 * is displayed. By default, the navigation bar is hidden.
                 * This flag also controls the homepage left navigation bar.
+                *
+                * @default true
+                * @version SDK: 1.2.0 | Thoughtspot: 8.4.0.cl
+                * @example
+                * ```js
+                * const embed = new AppEmbed('#tsEmbed', {
+                *    ... // other options
+                *    showPrimaryNavbar:true,
+                * })
+                * ```
                 */
             showPrimaryNavbar?: boolean;
             /**
@@ -90,23 +102,73 @@ declare module '@thoughtspot/visual-embed-sdk/embed/app' {
                 * nav-bars are visible, this flag will only hide the homepage left nav-bar.
                 * The showPrimaryNavbar flag takes precedence over the hideHomepageLeftNav.
                 *
+                * **Note**: This option does not apply to the classic homepage.
+                * To access the updated modular homepage, set
+                * `modularHomeExperience` to `true` (available in Early Access from 9.12 forward).
+                *
                 * @default false
-                * @version SDK: 1.27.0 | Thoughtspot: 9.8.0.cl
+                * @version SDK: 1.27.9 | Thoughtspot: 9.12.0.cl
+                * @example
+                * ```js
+                * const embed = new AppEmbed('#tsEmbed', {
+                *    ... // other options
+                *    hideHomepageLeftNav : true,
+                * })
+                * ```
                 */
             hideHomepageLeftNav?: boolean;
             /**
                 * Control the visibility of the help (?) and profile buttons on the
                 * Global nav-bar. By default, these buttons are visible on the nav-bar.
+                *
+                * @default false
+                * @version SDK: 1.2.0 | Thoughtspot: 8.4.0.cl
+                * @example
+                * ```js
+                * const embed = new AppEmbed('#tsEmbed', {
+                *    ... // other options
+                *    disableProfileAndHelp: true,
+                * })
+                * ```
                 */
             disableProfileAndHelp?: boolean;
             /**
                 * Control the visibility of the application switcher button on the nav-bar.
                 * By default, the application switcher is shown.
+                *
+                * **Note**: This option does not apply to the classic homepage.
+                * To access the updated modular homepage, set
+                * `modularHomeExperience` to `true` (available in Early Access from 9.12 forward).
+                *
+                * @default false
+                * @version SDK: 1.2.0 | Thoughtspot: 8.4.0.cl
+                * @example
+                * ```js
+                * const embed = new AppEmbed('#tsEmbed', {
+                *    ... // other options
+                *    hideApplicationSwitcher : true,
+                * })
+                * ```
                 */
             hideApplicationSwitcher?: boolean;
             /**
                 * Control the visibility of the Org switcher button on the nav-bar.
                 * By default, the Org switcher button is shown.
+                *
+                * **Note**: This option does not apply to the classic homepage.
+                * To access the updated modular homepage, set
+                * `modularHomeExperience` to `true` (available in Early Access from 9.12 forward).
+                *
+                *
+                * @default true
+                * @version SDK: 1.2.0 | Thoughtspot: 9.4.0.cl
+                * @example
+                * ```js
+                * const embed = new AppEmbed('#tsEmbed', {
+                *    ... // other options
+                *    hideOrgSwitcher : true,
+                * })
+                * ```
                 */
             hideOrgSwitcher?: boolean;
             /**
@@ -118,9 +180,13 @@ declare module '@thoughtspot/visual-embed-sdk/embed/app' {
                 * For eg, if you want the component to open to a specific Liveboard
                 * you could set the path to `pinboard/<liveboardId>/tab/<tabId>`.
                 *
+                * @version SDK: 1.1.0 | Thoughtspot: 9.4.0.cl
                 * @example
-                * ```
-                * <AppEmbed path="pinboard/1234/tab/7464" />
+                * ```js
+                * const embed = new AppEmbed('#tsEmbed', {
+                *    ... // other options
+                *    path:"pinboard/1234/tab/7464"
+                * })
                 * ```
                 */
             path?: string;
@@ -130,16 +196,46 @@ declare module '@thoughtspot/visual-embed-sdk/embed/app' {
                 *
                 * Use this to open to particular page in the app. To open to a specific
                 * path within the app, use the `path` attribute which is more flexible.
+                *
+                * @version SDK: 1.1.0 | Thoughtspot: 9.4.0.cl
+                * @example
+                * ```js
+                * const embed = new AppEmbed('#tsEmbed', {
+                *    ... // other options
+                *    pageId : Page.Answers | Page.Data
+                * })
+                * ```
                 */
             pageId?: Page;
             /**
                 * This puts a filter tag on the application. All metadata lists in the
                 * application, such as Liveboards and answers, would be filtered by this
                 * tag.
+                *
+                * @version SDK: 1.1.0 | Thoughtspot: 9.4.0.cl
+                * @example
+                * ```js
+                * const embed = new AppEmbed('#tsEmbed', {
+                *    ... // other options
+                *    tag:'value',
+                * })
+                * ```
                 */
             tag?: string;
             /**
                 * The array of GUIDs to be hidden
+                *
+                * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
+                * @example
+                * ```js
+                * const embed = new AppEmbed('#tsEmbed', {
+                *    ... // other options
+                *    hideObjects: [
+                *       '430496d6-6903-4601-937e-2c691821af3c',
+                *       'f547ec54-2a37-4516-a222-2b06719af726'
+                *     ]
+                * })
+                * ```
                 */
             hideObjects?: string[];
             /**
@@ -153,7 +249,15 @@ declare module '@thoughtspot/visual-embed-sdk/embed/app' {
             /**
                 * If set to true, the Search Assist feature is enabled.
                 *
+                * @default true
                 * @version SDK: 1.13.0 | ThoughtSpot: 8.5.0.cl, 8.8.1-sw
+                * @example
+                * ```js
+                * const embed = new AppEmbed('#tsEmbed', {
+                *    ... // other options
+                *    enableSearchAssist: true,
+                * })
+                * ```
                 */
             enableSearchAssist?: boolean;
             /**
@@ -161,6 +265,13 @@ declare module '@thoughtspot/visual-embed-sdk/embed/app' {
                 * according to the height of the pages which support fullHeight mode.
                 *
                 * @version SDK: 1.21.0 | ThoughtSpot: 9.4.0.cl, 9.4.0-sw
+                * @example
+                * ```js
+                * const embed = new AppEmbed('#tsEmbed', {
+                *    ... // other options
+                *    fullHeight: true,
+                * })
+                * ```
                 */
             fullHeight?: boolean;
             /**
@@ -176,6 +287,13 @@ declare module '@thoughtspot/visual-embed-sdk/embed/app' {
                 *
                 * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
                 * @default false
+                * @example
+                * ```js
+                * const embed = new AppEmbed('#tsEmbed', {
+                *    ... // other options
+                *    hideLiveboardHeader : true,
+                * })
+                * ```
                 */
             hideLiveboardHeader?: boolean;
             /**
@@ -183,6 +301,13 @@ declare module '@thoughtspot/visual-embed-sdk/embed/app' {
                 *
                 * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
                 * @default false
+                * @example
+                * ```js
+                * const embed = new AppEmbed('#tsEmbed', {
+                *    ... // other options
+                *    showLiveboardTitle:true,
+                * })
+                * ```
                 */
             showLiveboardTitle?: boolean;
             /**
@@ -190,13 +315,27 @@ declare module '@thoughtspot/visual-embed-sdk/embed/app' {
                 *
                 * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
                 * @default false
+                * @example
+                * ```js
+                * const embed = new AppEmbed('#tsEmbed', {
+                *    ... // other options
+                *    showLiveboardDescription:true,
+                * })
+                * ```
                 */
             showLiveboardDescription?: boolean;
             /**
-                * Flag to control new Modular Home experience
+                * Flag to control new Modular Home experience.
                 *
                 * @default false
-                * @version SDK: 1.27.0 | Thoughtspot: 9.8.0.cl
+                * @version SDK: 1.27.9 | Thoughtspot: 9.12.0.cl
+                * @example
+                * ```js
+                * const embed = new AppEmbed('#tsEmbed', {
+                *    ... // other options
+                *    modularHomeExperience : true,
+                * })
+                * ```
                 */
             modularHomeExperience?: boolean;
             /**
@@ -265,7 +404,7 @@ declare module '@thoughtspot/visual-embed-sdk/embed/app' {
                 * @param renderOptions An object containing the page ID
                 * to be embedded.
                 */
-            render(): AppEmbed;
+            render(): Promise<AppEmbed>;
     }
 }
 
@@ -433,8 +572,21 @@ declare module '@thoughtspot/visual-embed-sdk/embed/liveboard' {
             /**
                 * If set to true, the embedded object container dynamically resizes
                 * according to the height of the Liveboard.
+                * **Note**:  Using fullHeight loads all visualizations on the
+                * Liveboard simultaneously, which results in multiple warehouse
+                * queries and potentially a longer wait for the topmost
+                * visualizations to display on the screen.
+                * Setting `fullHeight` to `false` fetches visualizations
+                * incrementally as users scroll the page to view the charts and tables.
                 *
                 * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 7.2.1
+                * @example
+                * ```js
+                * const embed = new LiveboardEmbed('#embed', {
+                *   ... // other liveboard view config
+                *  fullHeight: true,
+                * });
+                * ```
                 */
             fullHeight?: boolean;
             /**
@@ -444,10 +596,26 @@ declare module '@thoughtspot/visual-embed-sdk/embed/liveboard' {
                 *
                 * @version SDK: 1.5.0 | ThoughtSpot: ts7.oct.cl, 7.2.1
                 * @default 500
+                * @example
+                * ```js
+                * const embed = new LiveboardEmbed('#embed', {
+                *   ... // other liveboard view config
+                *   fullHeight: true,
+                *   defaultHeight: 600,
+                * });
+                * ```
                 */
             defaultHeight?: number;
             /**
                 * @Deprecated If set to true, the context menu in visualizations will be enabled.
+                * @example
+                * ```js
+                * const embed = new LiveboardEmbed('#tsEmbed', {
+                *    ... // other options
+                *    enableVizTransformations:true,
+                * })
+                * ```
+                * @version: SDK: 1.1.0 | ThoughtSpot: 8.1.0.sw
                 */
             enableVizTransformations?: boolean;
             /**
@@ -455,6 +623,12 @@ declare module '@thoughtspot/visual-embed-sdk/embed/liveboard' {
                 * Use either liveboardId or pinboardId to reference the Liveboard to embed.
                 *
                 * @version SDK: 1.3.0 | ThoughtSpot ts7.aug.cl, 7.2.1
+                * @example
+                * ```js
+                * const embed = new LiveboardEmbed('#embed-container', {
+                *    ... // other options
+                *    liveboardId:id of liveboard,
+                * })
                 */
             liveboardId?: string;
             /**
@@ -465,6 +639,15 @@ declare module '@thoughtspot/visual-embed-sdk/embed/liveboard' {
             pinboardId?: string;
             /**
                 * The visualization within the Liveboard to display.
+                *
+                * @version SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
+                * @example
+                * ```js
+                * const embed = new LiveboardEmbed('#embed-container', {
+                *    ... // other options
+                *    vizId:'430496d6-6903-4601-937e-2c691821af3c',
+                * })
+                * ```
                 */
             vizId?: string;
             /**
@@ -472,6 +655,13 @@ declare module '@thoughtspot/visual-embed-sdk/embed/liveboard' {
                 * Liveboard page will be read-only (no X buttons)
                 *
                 * @version SDK: 1.3.0 | ThoughtSpot ts7.aug.cl, 7.2.1.sw
+                * @example
+                * ```js
+                * const embed = new LiveboardEmbed('#embed-container', {
+                *    ... // other options
+                *    preventLiveboardFilterRemoval:true,
+                * })
+                * ```
                 */
             preventLiveboardFilterRemoval?: boolean;
             /**
@@ -480,6 +670,15 @@ declare module '@thoughtspot/visual-embed-sdk/embed/liveboard' {
                 * event.
                 *
                 * @version SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
+                * @example
+                * ```js
+                * const embed = new LiveboardEmbed('#embed-container', {
+                *    ... // other options
+                *    visibleVizs: [
+                *       '430496d6-6903-4601-937e-2c691821af3c',
+                *       'f547ec54-2a37-4516-a222-2b06719af726'
+                *     ]
+                * })
                 */
             visibleVizs?: string[];
             /**
@@ -493,12 +692,26 @@ declare module '@thoughtspot/visual-embed-sdk/embed/liveboard' {
                 * new Liveboard experience mode.
                 *
                 * @version SDK: 1.14.0 | ThoughtSpot: 8.6.0.cl, 8.8.1-sw
+                * @example
+                * ```js
+                * const embed = new LiveboardEmbed('#embed-container', {
+                *    ... // other options
+                *    liveboardV2:true,
+                * })
+                * ```
                 */
             liveboardV2?: boolean;
             /**
                 * Set a Liveboard tab as an active tab.
                 * Specify the tab ID.
                 *
+                * @example
+                * ```js
+                * const embed = new LiveboardEmbed('#tsEmbed', {
+                *    ... // other options
+                *    activeTabId:'id-1234',
+                * })
+                * ```
                 * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
                 */
             activeTabId?: string;
@@ -506,6 +719,13 @@ declare module '@thoughtspot/visual-embed-sdk/embed/liveboard' {
                 * Show or hide the tab panel of the embedded Liveboard.
                 *
                 * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl, 9.8.0.sw
+                * @example
+                * ```js
+                * const embed = new LiveboardEmbed('#embed-container', {
+                *    ... // other options
+                *    hideTabPanel:true,
+                * })
+                * ```
                 */
             hideTabPanel?: boolean;
             /**
@@ -513,20 +733,41 @@ declare module '@thoughtspot/visual-embed-sdk/embed/liveboard' {
                 *
                 * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
                 * @default false
+                * @example
+                * ```js
+                * const embed = new LiveboardEmbed('#embed', {
+                *   ... // other liveboard view config
+                *   hideLiveboardHeader:true,
+                * });
+                * ```
                 */
             hideLiveboardHeader?: boolean;
             /**
                 * Show or hide the Liveboard title.
                 *
-                * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
                 * @default false
+                * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
+                * @example
+                * ```js
+                * const embed = new LiveboardEmbed('#embed-container', {
+                *    ... // other options
+                *    showLiveboardTitle:true,
+                * })
+                * ```
                 */
             showLiveboardTitle?: boolean;
             /**
                 * Show or hide the Liveboard description.
                 *
-                * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
                 * @default false
+                * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
+                * @example
+                * ```js
+                * const embed = new LiveboardEmbed('#embed-container', {
+                *    ... // other options
+                *    showLiveboardDescription:true,
+                * })
+                * ```
                 */
             showLiveboardDescription?: boolean;
             /**
@@ -547,8 +788,15 @@ declare module '@thoughtspot/visual-embed-sdk/embed/liveboard' {
             /**
                 * enable or disable ask sage
                 *
-                * @version SDK: 1.29.0 | Thoughtspot: 9.12.0.cl
                 * @default false
+                * @version SDK: 1.29.0 | Thoughtspot: 9.12.0.cl
+                * @example
+                * ```js
+                * const embed = new SearchEmbed('#tsEmbed', {
+                *    ... // other options
+                *    enableAskSage:true,
+                * })
+                * ```
                 */
             enableAskSage?: boolean;
     }
@@ -591,7 +839,7 @@ declare module '@thoughtspot/visual-embed-sdk/embed/liveboard' {
                 * @param renderOptions An object specifying the Liveboard ID,
                 * visualization ID and the runtime filters.
                 */
-            render(): LiveboardEmbed;
+            render(): Promise<LiveboardEmbed>;
             navigateToLiveboard(liveboardId: string, vizId?: string, activeTabId?: string): void;
     }
     /**
@@ -638,16 +886,43 @@ declare module '@thoughtspot/visual-embed-sdk/embed/search' {
             /**
                 * If set to true, the data sources panel is collapsed on load,
                 * but can be expanded manually.
+                *
+                * @version: SDK: 1.1.0 | ThoughtSpot: 8.1.0.sw
+                * @example
+                * ```js
+                * const embed = new SearchEmbed('#tsEmbed', {
+                *    ... // other options
+                *    collapseDataSources:true,
+                * })
+                * ```
                 */
             collapseDataSources?: boolean;
             /**
                 * Show or hide the data sources panel.
+                *
+                * @version: SDK: 1.2.0 | ThoughtSpot: 9.1.0.sw
+                * @example
+                * ```js
+                * const embed = new SearchEmbed('#tsEmbed', {
+                *    ... // other options
+                *    hideDataSources:true,
+                * })
+                * ```
                 */
             hideDataSources?: boolean;
             /**
                 * Show or hide the charts and tables in search answers.
                 * This attribute can be used to create a custom visualization
                 * using raw answer data.
+                *
+                * @version: SDK: 1.2.0 | ThoughtSpot: 9.1.0.sw
+                * @example
+                * ```js
+                * const embed = new SearchEmbed('#tsEmbed', {
+                *    ... // other options
+                *    hideResults:true,
+                * })
+                * ```
                 */
             hideResults?: boolean;
             /**
@@ -658,11 +933,26 @@ declare module '@thoughtspot/visual-embed-sdk/embed/search' {
                 * If set to true, the Search Assist feature is enabled.
                 *
                 * @version SDK: 1.13.0 | ThoughtSpot: 8.5.0.cl, 8.8.1-sw
+                * @example
+                * ```js
+                * const embed = new SearchEmbed('#tsEmbed', {
+                *    ... // other options
+                *    enableSearchAssist:true,
+                * })
+                * ```
                 */
             enableSearchAssist?: boolean;
             /**
                 * If set to true, the tabular view is set as the default
                 * format for presenting search data.
+                *
+                * @version: SDK: 1.1.0 | ThoughtSpot: 8.1.0.sw
+                * @example
+                * ```js
+                * const embed = new SearchEmbed('#tsEmbed', {
+                *    ... // other options
+                *    forceTable:true,
+                * })
                 */
             forceTable?: boolean;
             /**
@@ -670,12 +960,26 @@ declare module '@thoughtspot/visual-embed-sdk/embed/search' {
                 * Only a single data source is supported currently.
                 *
                 * @deprecated Use `dataSource` instead.
+                * @example
+                * ```js
+                * const embed = new SearchEmbed('#tsEmbed', {
+                *    ... // other options
+                *    dataSources:['id-234','id-456'],
+                * })
+                * ```
                 */
             dataSources?: string[];
             /**
                 * The array of data source GUIDs to set on load.
                 *
                 * @version: SDK: 1.19.0
+                * @example
+                * ```js
+                * const embed = new SearchEmbed('#tsEmbed', {
+                *    ... // other options
+                *    dataSource:'id-234',
+                * })
+                * ```
                 */
             dataSource?: string;
             /**
@@ -708,6 +1012,15 @@ declare module '@thoughtspot/visual-embed-sdk/embed/search' {
             searchOptions?: SearchOptions;
             /**
                 * The GUID of a saved answer to load initially.
+                *
+                * @version: SDK: 1.1.0 | ThoughtSpot: 8.1.0.sw
+                * @example
+                * ```js
+                * const embed = new SearchEmbed('#tsEmbed', {
+                *    ... // other options
+                *    answerId:'sed-1234',
+                * })
+                * ```
                 */
             answerId?: string;
             /**
@@ -715,6 +1028,13 @@ declare module '@thoughtspot/visual-embed-sdk/embed/search' {
                 * The chart/table should still be visible.
                 *
                 * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
+                * @example
+                * ```js
+                * const embed = new SearchEmbed('#tsEmbed', {
+                *    ... // other options
+                *    hideSearchBar:true,
+                * })
+                * ```
                 */
             hideSearchBar?: boolean;
             /**
@@ -722,6 +1042,13 @@ declare module '@thoughtspot/visual-embed-sdk/embed/search' {
                 *
                 * @default false
                 * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
+                * @example
+                * ```js
+                * const embed = new SearchEmbed('#tsEmbed', {
+                *    ... // other options
+                *    dataPanelV2:false,
+                * })
+                * ```
                 */
             dataPanelV2?: boolean;
             /**
@@ -755,7 +1082,7 @@ declare module '@thoughtspot/visual-embed-sdk/embed/search' {
             /**
                 * Render the embedded ThoughtSpot search
                 */
-            render(): SearchEmbed;
+            render(): Promise<SearchEmbed>;
     }
 }
 
@@ -772,18 +1099,44 @@ declare module '@thoughtspot/visual-embed-sdk/embed/search-bar' {
                 * Only a single data source is supported currently.
                 *
                 * @deprecated Use `dataSource` instead
+                *
+                * @version: SDK: 1.1.0 | ThoughtSpot: 8.1.1-sw
+                *
+                * @example
+                * ```js
+                * const embed = new SearchBarEmbed('#tsEmbed', {
+                *    ... // other options
+                *    dataSources:['id-2345','id-2345'],
+                * })
+                * ```
                 */
             dataSources?: string[];
             /**
-                * The array of data source GUIDs to set on load.
+                * Pass the ID of the source to be selected.
                 *
                 * @version: SDK: 1.19.0, ThoughtSpot 9.0.0.cl, 9.0.1.sw
+                *
+                * @example
+                * ```js
+                * const embed = new SearchBarEmbed('#tsEmbed', {
+                *    ... // other options
+                *    dataSource:'id-2345',
+                * })
+                * ```
                 */
             dataSource?: string;
             /**
                 * Boolean to define if the last selected data source should be used
                 *
                 * @version: SDK: 1.24.0, ThoughtSpot 9.5.0.cl, 9.5.0.sw
+                *
+                * @example
+                * ```js
+                * const embed = new SearchBarEmbed('#tsEmbed', {
+                *    ... // other options
+                *    useLastSelectedSources:false,
+                * })
+                * ```
                 */
             useLastSelectedSources?: boolean;
             /**
@@ -797,12 +1150,17 @@ declare module '@thoughtspot/visual-embed-sdk/embed/search-bar' {
                 * If it’s not executed, the focus is placed at the end of
                 * the token string in the search bar.
                 *
+                * @version: SDK: 1.2.0 | ThoughtSpot: 9.4.0.sw
+                *
                 * @example
                 * ```js
-                * searchOptions: {
-                *    searchTokenString: '[quantity purchased] [region]',
-                *    executeSearch: true,
-                * }
+                * const embed = new SearchBarEmbed('#tsEmbed', {
+                *    ... // other options
+                *    searchOptions: {
+                *        searchTokenString: '[quantity purchased] [region]',
+                *        executeSearch: true,
+                *    }
+                * })
                 * ```
                 */
             searchOptions?: SearchOptions;
@@ -823,7 +1181,7 @@ declare module '@thoughtspot/visual-embed-sdk/embed/search-bar' {
             /**
                 * Render the embedded ThoughtSpot search
                 */
-            render(): SearchBarEmbed;
+            render(): Promise<SearchBarEmbed>;
     }
 }
 
@@ -1164,6 +1522,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 *      .then((data) => data.token);
                 *  }
                 * });
+                * });
                 * ```
                 */
             TrustedAuthToken = "AuthServer",
@@ -1196,16 +1555,38 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 */
             Basic = "Basic"
     }
+    /**
+        *
+        * This option does not apply to the classic homepage experience. To access the
+        * updated modular homepage, set `modularHomeExperience` to `true` (available in Early
+        * Access from 9.12.0.cl onwards).
+        *
+        */
     export enum HomeLeftNavItem {
-            QueryBuilder = "query-builder",
+            /**
+                * @version SDK: 1.27.9| ThoughtSpot: 9.12.0.cl
+                */
+            SearchData = "search-data",
+            /**
+                * @version SDK: 1.27.9| ThoughtSpot: 9.12.0.cl
+                */
             Home = "insights-home",
+            /**
+                * @version SDK: 1.27.9| ThoughtSpot: 9.12.0.cl
+                */
             Liveboards = "liveboards",
+            /**
+                * @version SDK: 1.27.9| ThoughtSpot: 9.12.0.cl
+                */
             Answers = "answers",
+            /**
+                * @version SDK: 1.27.9| ThoughtSpot: 9.12.0.cl
+                */
             MonitorSubscription = "monitor-alerts",
-            SpotIQAnalysis = "spotiq-analysis",
-            Tutorials = "tutorials",
-            Documentation = "documentation",
-            Community = "community"
+            /**
+                * @version SDK: 1.27.9| ThoughtSpot: 9.12.0.cl
+                */
+            SpotIQAnalysis = "spotiq-analysis"
     }
     export type DOMSelector = string | HTMLElement;
     /**
@@ -1261,6 +1642,8 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
     /**
         * Configuration to define the customization on the Embedded
         * Thoughtspot components.
+        * You can customize styles, text strings, and icons.
+        * For more information, see https://developers.thoughtspot.com/docs/custom-css.
         *
         * @example
         * ```js
@@ -1275,7 +1658,12 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
         *     },
         *     content: {
         *      strings: {
-        *        'LIVEBOARDS': 'Dashboards'
+        *        'LIVEBOARDS': 'Dashboards',
+        *        'ANSWERS': 'Visualizations',
+        *        'Edit': 'Modify',
+        *        'Show underlying data': 'Show source data',
+        *        'SpotIQ': 'Insights',
+        *        'Monitor': 'Alerts',
         *      }
         *     },
         *     iconSpriteUrl: 'https://my-custom-icon-sprite.svg'
@@ -1307,12 +1695,6 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 * 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.
                 */
@@ -1601,8 +1983,20 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 */
             layoutConfig?: LayoutConfig;
             /**
-                * The <b>width</b> and <b>height</b> dimensions to render an embedded
+                * The width and height dimensions to render an embedded
                 * object inside your app.  Specify the values in pixels or percentage.
+                *
+                * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 7.2.1
+                * @example
+                * ```js
+                * const embed = new LiveboardEmbed('#embed', {
+                *   ... // other liveboard view config
+                *   frameParams: {
+                *     width: '500px' | '50%',
+                *      height: '400px' | '60%',
+                *   },
+                * });
+                * ```
                 */
             frameParams?: FrameParams;
             /**
@@ -1619,6 +2013,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 * for the user.
                 * Use this to disable actions.
                 *
+                * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
                 * @example
                 * ```js
                 * const embed = new LiveboardEmbed('#embed', {
@@ -1630,6 +2025,16 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
             disabledActions?: Action[];
             /**
                 * The tooltip to display for disabled actions.
+                *
+                * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
+                * @example
+                * ```js
+                * const embed = new LiveboardEmbed('#embed', {
+                *   ... // other liveboard view config
+                *   disabledActions: [Action.Download, Action.Save]
+                *   disabledActionReason: "Reason for disabling",
+                * });
+                * ```
                 */
             disabledActionReason?: string;
             /**
@@ -1637,6 +2042,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 * This actions will be hidden from the user.
                 * Use this to hide an action.
                 *
+                * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
                 * @example
                 * ```js
                 * const embed = new LiveboardEmbed('#embed', {
@@ -1657,17 +2063,46 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 *
                 * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
                 * @important
+                * @example
+                * ```js
+                * const embed = new LiveboardEmbed('#embed', {
+                *   ... // other liveboard view config
+                *   visibleActions: [Action.Download, Action.Export]
+                * });
+                * ```
                 */
             visibleActions?: Action[];
             /**
                 * Show alert messages and toast messages in the embedded view.
                 *
                 * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
+                * @example
+                * ```js
+                * const embed = new LiveboardEmbed('#embed-container', {
+                *    ... // other options
+                *    showAlerts:true,
+                * })
+                * ```
                 */
             showAlerts?: boolean;
             /**
                 * The list of runtime filters to apply to a search answer,
                 * visualization, or Liveboard.
+                *
+                * @version SDK: 1.9.4 | ThoughtSpot 8.1.0.cl, 8.4.1.sw
+                * @example
+                * ```js
+                * const embed = new LiveboardEmbed('#embed-container', {
+                *    ... // other options
+                *    runtimeFilters: [
+                *           {
+                *             columnName: 'value',
+                *              operator: RuntimeFilterOp.EQ,
+                *             values: ['string' | 123 | true],
+                *           },
+                *       ],
+                * })
+                * ```
                 */
             runtimeFilters?: RuntimeFilter[];
             /**
@@ -1675,12 +2110,31 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 * visualization, or Liveboard.
                 *
                 * @version SDK : 1.25.0 | Thoughtspot: 9.2.0.cl, 9.5.0.sw
+                * @example
+                * ```js
+                * const embed = new LiveboardEmbed('#embed-container', {
+                *    ... // other options
+                *    runtimeParameters: [
+                *     {
+                *       name: 'value',
+                *       value: 'string' | 123 | true,
+                *     },
+                *   ],
+                * })
+                * ```
                 */
             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
+                * @example
+                * ```js
+                * const embed = new LiveboardEmbed('#embed-container', {
+                *    ... // other options
+                *    locale:'en',
+                * })
+                * ```
                 */
             locale?: string;
             /**
@@ -1691,6 +2145,16 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 * to control embed behavior in non-regular ways. We do not publish the
                 * list of supported keys and values associated with each.
                 *
+                * @example
+                * ```js
+                * const embed = new LiveboardEmbed('#embed', {
+                *   ... // other liveboard view config
+                *   additionalFlags: {
+                *        flag1: 'value1',
+                *        flag2: 'value2'
+                *     }
+                * });
+                * ```
                 * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
                 */
             additionalFlags?: {
@@ -1707,18 +2171,41 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
             /**
                 * Insert as a sibling of the target container, instead of appending to a
                 * child inside it.
+                *
+                * @version SDK: 1.2.0 | Thoughtspot: 9.0.0.cl, 9.0.0.sw
+                * @example
+                * ```js
+                * const embed = new LiveboardEmbed('#embed-container', {
+                *    ... // other options
+                *    insertAsSibling:true,
+                * })
+                * ```
                 */
             insertAsSibling?: boolean;
             /**
                 * flag to set ContextMenu Trigger to either left or right click.
                 *
+                * @example
+                * ```js
+                * const embed = new LiveboardEmbed('#tsEmbed', {
+                *    ... // other options
+                *    contextMenuTrigger:ContextMenuTriggerOptions.LEFT_CLICK || RIGHT_CLICK,
+                * })
+                * ```
                 * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
                 */
             contextMenuTrigger?: ContextMenuTriggerOptions;
             /**
-                * flag to override openNew tab context menu link
+                * Flag to override openNew tab context menu link
                 *
                 * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
+                * @example
+                * ```js
+                * const embed = new LiveboardEmbed('#embed-container', {
+                *    ... // other options
+                *    linkOverride:false,
+                * })
+                * ```
                 */
             linkOverride?: boolean;
             /**
@@ -1740,9 +2227,14 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
             usePrerenderedIfAvailable?: boolean;
             /**
                 * Boolean to exclude runtimeFilters in the URL
+                * By default it is true, this flag removes runtime filters from the URL
+                * when set to false, runtime filters will be included in the URL.
                 *
-                * @default false
-                * @hidden
+                * Irrespective of this flag, runtime filters ( if passed ) will be applied to the
+                * embedded view.
+                *
+                * @default true
+                * @version SDK: 1.24.0 | ThoughtSpot: 9.5.0.cl
                 */
             excludeRuntimeFiltersfromURL?: boolean;
             /**
@@ -1764,16 +2256,40 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
             hiddenTabs?: string[];
             /**
                 * Hide the home page modules
-                * eg: hiddenHomepageModules = [HomepageModule.MyLibrary]
+                * For example: hiddenHomepageModules = [HomepageModule.MyLibrary]
+                *
+                *
+                * **Note**: This option does not apply to the classic homepage.
+                * To access the updated modular homepage, set
+                * `modularHomeExperience` to `true` (available as Early Access feature in 9.12.0.cl).
                 *
-                * @version SDK: 1.27.0 | Thoughtspot: 9.12.0.cl
+                * @version SDK: 1.27.9 | Thoughtspot: 9.12.0.cl
+                * @example
+                * ```js
+                * const embed = new AppEmbed('#tsEmbed', {
+                *    ... // other options
+                *    hiddenHomepageModules : [HomepageModule.Favorite,HomepageModule.Learning],
+                * })
+                * ```
                 */
             hiddenHomepageModules?: HomepageModule[];
             /**
                 * reordering the home page modules
                 * eg: reorderedHomepageModules = [HomepageModule.MyLibrary, HomepageModule.Watchlist]
                 *
-                * @version SDK: 1.28.0 | Thoughtspot: 9.12.0.cl
+                * **Note**: This option does not apply to the classic homepage.
+                * To access the updated modular homepage, set
+                * `modularHomeExperience` to `true` (available in Early Access from 9.12.0.cl
+                * onwards).
+                *
+                * @version SDK: 1.27.9| Thoughtspot: 9.12.0.cl
+                * @example
+                * ```js
+                * const embed = new AppEmbed('#tsEmbed', {
+                *    ... // other options
+                *    reorderedHomepageModules:[HomepageModule.Favorite,HomepageModule.MyLibrary]
+                * })
+                * ```
                 */
             reorderedHomepageModules?: HomepageModule[];
             /**
@@ -1782,13 +2298,17 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 *
                 * Use either `visibleTabs` or `hiddenTabs`.
                 *
+                * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
                 * @example
                 * ```js
-                * visibleTabs: [
-                * '430496d6-6903-4601-937e-2c691821af3c',
-                * 'f547ec54-2a37-4516-a222-2b06719af726']
+                * const embed = new LiveboardEmbed('#embed-container', {
+                *    ... // other options
+                *    visibleTabs: [
+                *       '430496d6-6903-4601-937e-2c691821af3c',
+                *       'f547ec54-2a37-4516-a222-2b06719af726'
+                *     ]
+                * })
                 * ```
-                * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
                 */
             visibleTabs?: string[];
             /**
@@ -1796,11 +2316,19 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 * 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.10.0.cl
+                * @example
                 * ```js
-                * hiddenHomeLeftNavItems = [HomeLeftNavItem.Home]
+                * const embed = new AppEmbed('#tsEmbed', {
+                *    ... // other options
+                *    hiddenHomeLeftNavItems : [HomeLeftNavItem.Home,HomeLeftNavItem.Answers],
+                * })
                 * ```
                 *
-                * @version SDK: 1.27.0 | Thoughtspot: 9.12.0.cl
+                * **Note**: This option does not apply to the classic homepage.
+                * To access the updated modular homepage, set
+                * `modularHomeExperience` to `true` (available in Early Access from 9.12 forward).
+                * @version SDK: 1.27.9 | Thoughtspot: 9.12.0.cl
                 */
             hiddenHomeLeftNavItems?: HomeLeftNavItem[];
             /**
@@ -1827,7 +2355,9 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 *
                 * @type {boolean}
                 * @default false
+                * @version SDK: 1.24.0 | ThoughtSpot:9.4.0.cl, 9.4.0.sw
                 * @example
+                * ```js
                 * // Disable tracking PreRender size in the configuration
                 * const config = {
                 *   doNotTrackPreRenderSize: true,
@@ -1835,6 +2365,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 *
                 * // Instantiate an object with the configuration
                 * const myComponent = new MyComponent(config);
+                * ```
                 */
             doNotTrackPreRenderSize?: boolean;
             /**
@@ -1976,6 +2507,11 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
             MyLibrary = "MY_LIBRARY",
             /**
                 * Trending list
+                *
+                * **Note**: This option does not apply to the classic homepage.
+                * To access the updated modular homepage, set
+                * `modularHomeExperience` to `true` (available in Early Access from 9.12.0.cl
+                * onwards).
                 */
             Trending = "TRENDING",
             /**
@@ -2114,7 +2650,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 * @returns nonFilteredColumns - The columns that were not filtered
                 * @example
                 *```js
-                * searchEmbed.trigger(HostEvent.DrillDown, {
+                * searchEmbed.trigger(EmbedEvent.DrillDown, {
                 *    points: {
                 *        clickedPoint,
                 *        selectedPoints: selectedPoint
@@ -2172,7 +2708,8 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 * A custom action has been triggered.
                 *
                 * @returns actionId - ID of the custom action
-                * @returns data - Response payload with the Answer or Liveboard data
+                * @returns payload {@link CustomActionPayload} - Response payload with the
+                * Answer or Liveboard data
                 * @example
                 * ```js
                 * appEmbed.on(EmbedEvent.customAction, payload => {
@@ -2192,7 +2729,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 * @example
                 * ```js
                 * livebaordEmbed.on(EmbedEvent.VizPointDoubleClick, payload => {
-                *      console.log('VizPointDoubleClick', payload)
+                *      console.log('VizPointDoubleClick', payload);
                 * })
                 * ```
                 */
@@ -2205,7 +2742,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 * @important
                 * @example
                 * ```js
-                * embed.on(ThoughtSpotEmbed.Event.VizPointClick, ({data}) => {
+                * embed.on(EmbedEvent.VizPointClick, ({data}) => {
                 *   console.log(
                 *    data.vizId, // viz id
                 *    data.clickedPoint.selectedAttributes[0].value,
@@ -2220,18 +2757,18 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
             /**
                 * An error has occurred. This event is fired for the following error types:
                 *
-                *  `API` - API call failure error.
+                *  API - API call failure error.
                 *
-                *  `FULLSCREEN` - Error when presenting a Liveboard or visualization in full screen
+                *  FULLSCREEN - Error when presenting a Liveboard or visualization in full screen
                 *  mode.
                 *
-                *  `SINGLE_VALUE_FILTER` - Error due to multiple values in the single value filter.
+                *  SINGLE_VALUE_FILTER - Error due to multiple values in the single value filter.
                 *
-                *  `NON_EXIST_FILTER` - Error due to a non-existent filter.
+                *  NON_EXIST_FILTER - Error due to a non-existent filter.
                 *
-                *  `INVALID_DATE_VALUE` - Invalid date value error.
+                *  INVALID_DATE_VALUE - Invalid date value error.
                 *
-                *  `INVALID_OPERATOR` - Use of invalid operator during filter application.
+                *  INVALID_OPERATOR - Use of invalid operator during filter application.
                 *
                 *  For more information, see [Developer Documentation](https://developers.thoughtspot.com/docs/events-app-integration#errorType)
                 *
@@ -2799,7 +3336,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
                 * @example
                 *```js
-                * liveboardEmbed.trigger(HostEvent.Delete,
+                * liveboardEmbed.trigger(EmbedEvent.Delete,
                 *   {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
                 *```
                 */
@@ -2810,7 +3347,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
                 * @example
                 *```js
-                * liveboardEmbed.trigger(HostEvent.SchedulesList)
+                * liveboardEmbed.trigger(EmbedEvent.SchedulesList)
                 *```
                 */
             SchedulesList = "schedule-list",
@@ -2820,7 +3357,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
                 * @example
                 *```js
-                * liveboardEmbed.trigger(HostEvent.Cancel)
+                * liveboardEmbed.trigger(EmbedEvent.Cancel)
                 *```
                 */
             Cancel = "cancel",
@@ -2830,7 +3367,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
                 * @example
                 *```js
-                * liveboardEmbed.trigger(HostEvent.Explore,  {
+                * liveboardEmbed.trigger(EmbedEvent.Explore,  {
                 *   vizId: '730496d6-6903-4601-937e-2c691821af3c'})
                 *```
                 */
@@ -2841,7 +3378,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
                 * @example
                 *```js
-                * liveboardEmbed.trigger(HostEvent.CopyLink, {
+                * liveboardEmbed.trigger(EmbedEvent.CopyLink, {
                 *   vizId: '730496d6-6903-4601-937e-2c691821af3c'})
                 *```
                 */
@@ -3110,10 +3647,13 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 * _String_. The name of the column to filter on.
                 * `operator`
                 *  Runtime filter operator to apply. For information,
-                *  see [Runtime filter operators](https://developers.thoughtspot.com/docs/?pageid=runtime-filters#rtOperator).
+                *  see https://developers.thoughtspot.com/docs/?pageid=runtime-filters#rtOperator.
                 * `values`
                 *  List of operands. Some operators such as EQ, LE allow a single value, whereas
                 *  operators such as BW and IN accept multiple operands.
+                *  **Note**: `HostEvent.UpdateRuntimeFilters` is not supported in
+                *  Search embedding (SearchEmbed) and Natural Language Search
+                *  embedding (SageEmbed).
                 *
                 * @param - {@link RuntimeFilter}[] an array of {@link RuntimeFilter} Types.
                 * @example
@@ -3653,7 +4193,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 *
                 * ```js
                 * liveboardEmbed.trigger(HostEvent.UpdateFilters, {
-                *  filter: { column: 'column name', oper: 'in', values: [1,2,3], is_mandatory: false }
+                *  filter: { column: 'column name', oper: 'IN', values: [1,2,3], is_mandatory: false }
                 * })
                 * ```
                 * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
@@ -3739,7 +4279,33 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 * ```
                 * @version SDK: 1.29.0 | Thoughtspot: 9.12.0.cl
                 */
-            AskSage = "AskSage"
+            AskSage = "AskSage",
+            /**
+                * Trigger UpdateCrossFilter for Liveboard
+                *
+                * @example
+                * ```js
+                * liveboardEmbed.trigger(HostEvent.UpdateCrossFilter, {
+                *      vizId: 'b535c760-8bbe-4e6f-bb26-af56b4129a1e',
+                *      conditions: [
+                *      { columnName: 'Category', values: ['mfgr#12','mfgr#14'] },
+                *      { columnName: 'color', values: ['mint','hot'] },
+                *    ],
+                * });
+                * ```
+                * @version SDK: 1.29.0 | Thoughtspot: 10.0.0.cl
+                */
+            UpdateCrossFilter = "UpdateCrossFilter",
+            /**
+                * Trigger ResetLiveboardPersonalisedView for Liveboard
+                *
+                * @example
+                * ```js
+                * liveboardEmbed.trigger(HostEvent.ResetLiveboardPersonalisedView);
+                * ```
+                * @version SDK: 1.29.0 | Thoughtspot: 10.1.0.cl
+                */
+            ResetLiveboardPersonalisedView = "ResetLiveboardPersonalisedView"
     }
     /**
         * The different visual modes that the data sources panel within
@@ -4704,7 +5270,47 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 * ```
                 *  @version SDK: 1.29.0 | Thoughtspot: 9.12.0.cl
                 */
-            AskAi = "AskAi"
+            AskAi = "AskAi",
+            /**
+                * The **Add KPI to Watchlist** action on Home page watchlist.
+                *
+                * @example
+                * ```js
+                * disabledActions: [Action.AddToWatchlist]
+                * ```
+                * @version SDK : 1.27.9 | Thoughtspot: 9.12.5.cl
+                */
+            AddToWatchlist = "addToWatchlist",
+            /**
+                * The **Remove from watchlist** menu action on KPI watchlist.
+                *
+                * @example
+                * ```js
+                * disabledActions: [Action.RemoveFromWatchlist]
+                * ```
+                * @version SDK : 1.27.9 | Thoughtspot: 9.12.5.cl
+                */
+            RemoveFromWatchlist = "removeFromWatchlist",
+            /**
+                * The **Copy KPI Link** menu action on KPI watchlist.
+                *
+                * @example
+                * ```js
+                * disabledActions: [Action.CopyKpiLink]
+                * ```
+                * @version SDK : 1.27.9 | Thoughtspot: 9.12.5.cl
+                */
+            CopyKpiLink = "copyKpiLink",
+            /**
+                * Action ID for AI Highlights button
+                *
+                *  @example
+                * ```js
+                * hiddenAction: [Action.AIHighlights]
+                * ```
+                *  @version SDK: 1.27.10 | Thoughtspot: 9.12.5.cl
+                */
+            AIHighlights = "AIHighlights"
     }
     export interface AnswerServiceType {
             getAnswer?: (offset: number, batchSize: number) => any;
@@ -4740,6 +5346,9 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
             selectedAttributes: ColumnValue[];
             selectedMeasures: ColumnValue[];
     }
+    /**
+        * @group Events
+        */
     export interface CustomActionPayload {
             contextMenuPoints?: {
                     clickedPoint: VizPoint;
@@ -5347,7 +5956,7 @@ declare module '@thoughtspot/visual-embed-sdk/embed/sage' {
                 *
                 * @returns {SageEmbed} Eureka/Sage embed
                 */
-            render(): SageEmbed;
+            render(): Promise<SageEmbed>;
     }
 }
 
@@ -5365,7 +5974,7 @@ declare module '@thoughtspot/visual-embed-sdk/utils/graphql/answerService/answer
             GetChartWithData = "GetChartWithData",
             GetTableWithHeadlineData = "GetTableWithHeadlineData"
     }
-    interface UnderlyingDataPoint {
+    export interface UnderlyingDataPoint {
             columnId: string;
             dataValue: any;
     }
@@ -5388,24 +5997,67 @@ declare module '@thoughtspot/visual-embed-sdk/utils/graphql/answerService/answer
         * @group Events
         */
     export class AnswerService {
+            /**
+                * Should not need to be called directly.
+                *
+                * @param session
+                * @param answer
+                * @param thoughtSpotHost
+                * @param selectedPoints
+                */
             constructor(session: SessionInterface, answer: any, thoughtSpotHost: string, selectedPoints?: VizPoint[]);
+            /**
+                * Get the details about the source used in the answer.
+                * This can be used to get the list of all columns in the data source for example.
+                */
             getSourceDetail(): Promise<any>;
+            /**
+                * Remove columnIds and return updated answer session.
+                *
+                * @param columnIds
+                * @returns
+                */
             removeColumns(columnIds: string[]): Promise<any>;
+            /**
+                * Add columnIds and return updated answer session.
+                *
+                * @param columnIds
+                * @returns
+                */
             addColumns(columnIds: string[]): Promise<any>;
+            /**
+                * Fetch data from the answer.
+                *
+                * @param offset
+                * @param size
+                * @returns
+                */
             fetchData(offset?: number, size?: number): Promise<{
                     columns: any;
                     data: any;
             }>;
             /**
+                * Fetch the data for the answer as a CSV blob. This might be
+                * quicker for larger data.
                 *
                 * @param userLocale
                 * @param includeInfo Include the CSV header in the output
                 * @returns Response
                 */
             fetchCSVBlob(userLocale?: string, includeInfo?: boolean): Promise<Response>;
+            /**
+                * Just get the internal URL for this answer's data
+                * as a CSV blob.
+                *
+                * @param userLocale
+                * @param includeInfo
+                * @returns
+                */
             getFetchCSVBlobUrl(userLocale?: string, includeInfo?: boolean): string;
             /**
                 * Get underlying data given a point and the output column names.
+                * In case of a context menu action, the selectedPoints are
+                * automatically passed.
                 *
                 * @param outputColumnNames
                 * @param selectedPoints
@@ -5421,10 +6073,21 @@ declare module '@thoughtspot/visual-embed-sdk/utils/graphql/answerService/answer
                 * @version SDK: 1.25.0| ThoughtSpot: 9.10.0.cl
                 */
             getUnderlyingDataForPoint(outputColumnNames: string[], selectedPoints?: UnderlyingDataPoint[]): Promise<AnswerService>;
+            /**
+                * Execute a custom graphql query in the context of the answer.
+                *
+                * @param query graphql query
+                * @param variables graphql variables
+                * @returns
+                */
             executeQuery(query: string, variables: any): Promise<any>;
+            /**
+                * Get the internal session details for the answer.
+                *
+                * @returns
+                */
             getSession(): SessionInterface;
     }
-    export {};
 }
 
 declare module '@thoughtspot/visual-embed-sdk/embed/embedConfig' {
@@ -5448,6 +6111,52 @@ declare module '@thoughtspot/visual-embed-sdk/embed/embedConfig' {
     export const setEmbedConfig: (newConfig: EmbedConfig) => EmbedConfig;
 }
 
+declare module '@thoughtspot/visual-embed-sdk/mixpanel-service' {
+    export const EndPoints: {
+            CONFIG: string;
+    };
+    export const MIXPANEL_EVENT: {
+            VISUAL_SDK_RENDER_START: string;
+            VISUAL_SDK_CALLED_INIT: string;
+            VISUAL_SDK_RENDER_COMPLETE: string;
+            VISUAL_SDK_RENDER_FAILED: string;
+            VISUAL_SDK_TRIGGER: string;
+            VISUAL_SDK_ON: string;
+            VISUAL_SDK_IFRAME_LOAD_PERFORMANCE: string;
+            VISUAL_SDK_EMBED_CREATE: string;
+            VERCEL_INTEGRATION_COMPLETED: string;
+    };
+    /**
+        * Pushes the event with its Property key-value map to mixpanel.
+        *
+        * @param eventId
+        * @param eventProps
+        */
+    export function uploadMixpanelEvent(eventId: string, eventProps?: {}): void;
+    /**
+        *
+        * @param sessionInfo
+        */
+    export function initMixpanel(sessionInfo: any): void;
+    /**
+        *
+        */
+    export function testResetMixpanel(): void;
+}
+
+declare module '@thoughtspot/visual-embed-sdk/tokenizedFetch' {
+    /**
+      * Fetch wrapper that adds the authentication token to the request.
+      * Use this to call the ThoughtSpot APIs when using the visual embed sdk.
+      *
+      * @param input
+      * @param init
+      * @version SDK: 1.28.0
+      * @group Global methods
+      */
+    export const tokenizedFetch: typeof fetch;
+}
+
 declare module '@thoughtspot/visual-embed-sdk/embed/ts-embed' {
     /**
         * Copyright (c) 2022
@@ -5643,7 +6352,7 @@ declare module '@thoughtspot/visual-embed-sdk/embed/ts-embed' {
                 *
                 * @param args
                 */
-            render(): TsEmbed;
+            render(): Promise<TsEmbed>;
             getIframeSrc(): string;
             protected handleRenderForPrerender(): void;
             /**