@thoughtspot/visual-embed-sdk 1.28.0-preRender → 1.28.0

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

@@ -234,7 +234,7 @@ export function useEmbedRef<T extends EmbedComponent>(): React.MutableRefObject<
   * @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, 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, };
+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, };
 
 /**
     * @group Embed components
@@ -245,18 +245,44 @@ export interface SearchBarViewConfig extends Omit<ViewConfig, 'runtimeFilters' |
             * 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;
         /**
@@ -270,12 +296,17 @@ export interface SearchBarViewConfig extends Omit<ViewConfig, 'runtimeFilters' |
             * 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;
@@ -296,7 +327,7 @@ export declare class SearchBarEmbed extends TsEmbed {
         /**
             * Render the embedded ThoughtSpot search
             */
-        render(): SearchBarEmbed;
+        render(): Promise<SearchBarEmbed>;
 }
 
 /**
@@ -458,7 +489,7 @@ export declare class SageEmbed extends V1Embed {
             *
             * @returns {SageEmbed} Eureka/Sage embed
             */
-        render(): SageEmbed;
+        render(): Promise<SageEmbed>;
 }
 
 /**
@@ -495,27 +526,73 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
         /**
             * 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;
+        /**
+            * If set to true, expands all the data sources panel.
+            */
+        expandAllDataSource?: boolean;
         /**
             * 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;
         /**
@@ -523,12 +600,26 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
             * 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;
         /**
@@ -561,6 +652,15 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
         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;
         /**
@@ -568,6 +668,13 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
             * 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;
         /**
@@ -575,6 +682,13 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
             *
             * @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;
         /**
@@ -608,7 +722,7 @@ export declare class SearchEmbed extends TsEmbed {
         /**
             * Render the embedded ThoughtSpot search
             */
-        render(): SearchEmbed;
+        render(): Promise<SearchEmbed>;
 }
 
 /**
@@ -664,6 +778,16 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
             * 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;
         /**
@@ -672,23 +796,78 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
             * 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 as Early Access feature in 9.12.5.cl).
+            *
             * @default false
-            * @version SDK: 1.27.0 | Thoughtspot: 9.8.0.cl
+            * @version SDK: 1.28.0 | Thoughtspot: 9.12.5.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 as Early Access feature in 9.12.5.cl).
+            *
+            * @version SDK: 1.28.0 | Thoughtspot: 9.12.5.cl
+            * @default false
+            *
+            * @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 as Early Access feature in 9.12.5.cl).
+            *
+            * @version SDK: 1.28.0 | Thoughtspot: 9.12.5.cl
+            * @default true
+            *
+            * @example
+            * ```js
+            * const embed = new AppEmbed('#tsEmbed', {
+            *    ... // other options
+            *    hideOrgSwitcher : true,
+            * })
+            * ```
             */
         hideOrgSwitcher?: boolean;
         /**
@@ -700,9 +879,13 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
             * 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;
@@ -712,16 +895,46 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
             *
             * 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[];
         /**
@@ -735,7 +948,15 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
         /**
             * 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;
         /**
@@ -743,6 +964,13 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
             * 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;
         /**
@@ -758,6 +986,13 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
             *
             * @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;
         /**
@@ -765,6 +1000,13 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
             *
             * @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;
         /**
@@ -772,13 +1014,28 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
             *
             * @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.28.0 | Thoughtspot: 9.12.5.cl
+            *
+            * @example
+            * ```js
+            * const embed = new AppEmbed('#tsEmbed', {
+            *    ... // other options
+            *    modularHomeExperience : true,
+            * })
+            * ```
             */
         modularHomeExperience?: boolean;
         /**
@@ -847,7 +1104,7 @@ export declare class AppEmbed extends V1Embed {
             * @param renderOptions An object containing the page ID
             * to be embedded.
             */
-        render(): AppEmbed;
+        render(): Promise<AppEmbed>;
 }
 
 /**
@@ -869,8 +1126,21 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
         /**
             * 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;
         /**
@@ -880,10 +1150,26 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
             *
             * @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;
         /**
@@ -891,6 +1177,12 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
             * 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;
         /**
@@ -901,6 +1193,15 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
         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;
         /**
@@ -908,6 +1209,13 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
             * 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;
         /**
@@ -916,6 +1224,15 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
             * 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[];
         /**
@@ -929,12 +1246,26 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
             * 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;
@@ -942,6 +1273,13 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
             * 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;
         /**
@@ -949,20 +1287,41 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
             *
             * @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;
         /**
@@ -983,8 +1342,15 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
         /**
             * 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;
 }
@@ -1027,7 +1393,7 @@ export declare class LiveboardEmbed extends V1Embed {
             * @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;
 }
 /**
@@ -1274,7 +1640,22 @@ export interface AuthEventEmitter {
             *
             * @param {@link AuthEvent}
             */
-        emit(event: AuthEvent): void;
+        emit(event: AuthEvent, ...args: any[]): boolean;
+        /**
+            * Remove listener from the emitter returned from init.
+            *
+            * @param event
+            * @param listener
+            * @param context
+            * @param once
+            */
+        off(event: AuthStatus, listener: (...args: any[]) => void, context: any, once: boolean): this;
+        /**
+            * Remove all the event listeners
+            *
+            * @param event
+            */
+        removeAllListeners(event: AuthStatus): this;
 }
 /**
     * Events which can be triggered on the emitter returned from {@link init}.
@@ -1507,6 +1888,7 @@ export declare enum AuthType {
             *      .then((data) => data.token);
             *  }
             * });
+            * });
             * ```
             */
         TrustedAuthToken = "AuthServer",
@@ -1539,16 +1921,39 @@ export declare enum AuthType {
             */
         Basic = "Basic"
 }
+/**
+    *
+    * This option does not apply to the classic homepage experience.
+    * To access the updated modular homepage,
+    * set `modularHomeExperience` to `true`
+    * (available as Early Access feature in 9.12.5.cl).
+    *
+    */
 export declare enum HomeLeftNavItem {
-        QueryBuilder = "query-builder",
+        /**
+            * @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
+            */
+        SearchData = "search-data",
+        /**
+            * @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
+            */
         Home = "insights-home",
+        /**
+            * @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
+            */
         Liveboards = "liveboards",
+        /**
+            * @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
+            */
         Answers = "answers",
+        /**
+            * @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
+            */
         MonitorSubscription = "monitor-alerts",
-        SpotIQAnalysis = "spotiq-analysis",
-        Tutorials = "tutorials",
-        Documentation = "documentation",
-        Community = "community"
+        /**
+            * @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
+            */
+        SpotIQAnalysis = "spotiq-analysis"
 }
 export type DOMSelector = string | HTMLElement;
 /**
@@ -1604,6 +2009,8 @@ export interface CustomStyles {
 /**
     * 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
@@ -1618,7 +2025,12 @@ export interface CustomStyles {
     *     },
     *     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'
@@ -1650,12 +2062,6 @@ 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.
             */
@@ -1900,6 +2306,12 @@ export interface EmbedConfig {
             * @version SDK: 1.26.7 | ThoughtSpot: 9.10.0.cl
             */
         logLevel?: LogLevel;
+        /**
+            * Disables the Mixpanel tracking from the SDK.
+            *
+            * @version SDK: 1.27.9
+            */
+        disableSDKTracking?: boolean;
 }
 export interface LayoutConfig {
 }
@@ -1938,8 +2350,20 @@ export interface ViewConfig {
             */
         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;
         /**
@@ -1956,6 +2380,7 @@ export interface ViewConfig {
             * 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', {
@@ -1967,6 +2392,16 @@ export interface ViewConfig {
         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;
         /**
@@ -1974,6 +2409,7 @@ export interface ViewConfig {
             * 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', {
@@ -1994,17 +2430,46 @@ export interface ViewConfig {
             *
             * @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[];
         /**
@@ -2012,12 +2477,31 @@ export interface ViewConfig {
             * 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;
         /**
@@ -2028,6 +2512,16 @@ export interface ViewConfig {
             * 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?: {
@@ -2044,18 +2538,41 @@ export interface ViewConfig {
         /**
             * 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;
         /**
@@ -2077,9 +2594,14 @@ export interface ViewConfig {
         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;
         /**
@@ -2101,16 +2623,42 @@ export interface ViewConfig {
         hiddenTabs?: string[];
         /**
             * Hide the home page modules
-            * eg: hiddenHomepageModules = [HomepageModule.MyLibrary]
+            * For example: hiddenHomepageModules = [HomepageModule.MyLibrary]
+            *
             *
-            * @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 as Early Access feature in 9.12.0.cl).
+            *
+            * @version SDK: 1.28.0 | Thoughtspot: 9.12.5.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 as Early Access feature in 9.12.5.cl).
+            *
+            * @version SDK: 1.28.0| Thoughtspot: 9.12.5.cl
+            *
+            * @example
+            * ```js
+            * const embed = new AppEmbed('#tsEmbed', {
+            *    ... // other options
+            *    reorderedHomepageModules:[HomepageModule.Favorite,HomepageModule.MyLibrary]
+            * })
+            * ```
             */
         reorderedHomepageModules?: HomepageModule[];
         /**
@@ -2119,13 +2667,17 @@ export interface ViewConfig {
             *
             * 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[];
         /**
@@ -2133,11 +2685,22 @@ export interface ViewConfig {
             * 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.28.0 | Thoughtspot: 9.12.5.cl
             */
         hiddenHomeLeftNavItems?: HomeLeftNavItem[];
         /**
@@ -2164,7 +2727,9 @@ export interface ViewConfig {
             *
             * @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,
@@ -2172,6 +2737,7 @@ export interface ViewConfig {
             *
             * // Instantiate an object with the configuration
             * const myComponent = new MyComponent(config);
+            * ```
             */
         doNotTrackPreRenderSize?: boolean;
         /**
@@ -2292,7 +2858,12 @@ export declare enum RuntimeFilterOp {
         IN = "IN"
 }
 /**
-    * Home page module that can be hidden
+    * Home page module that can be hidden.
+    * **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.5.cl).
+    *
+    * @version SDK: 1.28.0 | Thoughtspot: 9.12.5.cl
     */
 export declare enum HomepageModule {
         /**
@@ -2451,7 +3022,7 @@ export declare enum EmbedEvent {
             * @returns nonFilteredColumns - The columns that were not filtered
             * @example
             *```js
-            * searchEmbed.trigger(HostEvent.DrillDown, {
+            * searchEmbed.trigger(EmbedEvent.DrillDown, {
             *    points: {
             *        clickedPoint,
             *        selectedPoints: selectedPoint
@@ -2543,7 +3114,7 @@ export declare enum EmbedEvent {
             * @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,
@@ -2558,19 +3129,21 @@ export declare enum EmbedEvent {
         /**
             * 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 mode.
+            *  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)
+            *
             * @returns error - An error object or message
             * @example
             * ```js
@@ -3135,7 +3708,7 @@ export declare enum EmbedEvent {
             * @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'})
             *```
             */
@@ -3146,7 +3719,7 @@ export declare enum EmbedEvent {
             * @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",
@@ -3156,7 +3729,7 @@ export declare enum EmbedEvent {
             * @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",
@@ -3166,7 +3739,7 @@ export declare enum EmbedEvent {
             * @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'})
             *```
             */
@@ -3177,7 +3750,7 @@ export declare enum EmbedEvent {
             * @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'})
             *```
             */
@@ -3446,10 +4019,13 @@ export declare enum HostEvent {
             * _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
@@ -3974,6 +4550,7 @@ export declare enum HostEvent {
         /**
             *
             * 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
@@ -3982,12 +4559,13 @@ export declare enum HostEvent {
         /**
             *
             * Update the visible filters on the Liveboard.
+            *
             * @param - filter: filter object containing column name and filter operation and values
             * @example
             *
             * ```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
@@ -4073,7 +4651,33 @@ export declare enum HostEvent {
             * ```
             * @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
@@ -5041,6 +5645,7 @@ export declare enum Action {
         AskAi = "AskAi",
         /**
             * The **Add KPI to Watchlist** action on Home page watchlist.
+            *
             * @example
             * ```js
             * disabledActions: [Action.AddToWatchlist]
@@ -5050,6 +5655,7 @@ export declare enum Action {
         AddToWatchlist = "addToWatchlist",
         /**
             * The **Remove from watchlist** menu action on KPI watchlist.
+            *
             * @example
             * ```js
             * disabledActions: [Action.RemoveFromWatchlist]
@@ -5059,13 +5665,24 @@ export declare enum Action {
         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"
+        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;
@@ -5722,6 +6339,17 @@ export declare function initMixpanel(sessionInfo: any): void;
     */
 export declare function testResetMixpanel(): void;
 
+/**
+  * 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 declare const tokenizedFetch: typeof fetch;
+
 /**
     * Copyright (c) 2022
     *
@@ -5914,7 +6542,7 @@ export declare class TsEmbed {
             *
             * @param args
             */
-        render(): TsEmbed;
+        render(): Promise<TsEmbed>;
         getIframeSrc(): string;
         protected handleRenderForPrerender(): void;
         /**