@thoughtspot/visual-embed-sdk 1.28.0-alpha.3 → 1.28.0-alpha.5

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

@@ -234,18 +234,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;
         /**
@@ -259,12 +285,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;
@@ -484,27 +515,74 @@ 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, 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;
         /**
@@ -512,12 +590,28 @@ 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;
         /**
@@ -550,6 +644,16 @@ 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;
         /**
@@ -557,6 +661,14 @@ 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;
         /**
@@ -564,6 +676,14 @@ 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;
         /**
@@ -653,6 +773,17 @@ 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;
         /**
@@ -667,11 +798,29 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
             *
             * @default false
             * @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;
         /**
@@ -682,6 +831,16 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
             * 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;
         /**
@@ -692,6 +851,17 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
             * 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;
         /**
@@ -703,9 +873,14 @@ 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;
@@ -715,16 +890,48 @@ 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[];
         /**
@@ -737,8 +944,17 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
         liveboardV2?: boolean;
         /**
             * 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;
         /**
@@ -746,6 +962,14 @@ 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;
         /**
@@ -761,6 +985,14 @@ 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;
         /**
@@ -768,6 +1000,14 @@ 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;
         /**
@@ -775,6 +1015,14 @@ 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;
         /**
@@ -782,6 +1030,14 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
             *
             * @default false
             * @version SDK: 1.27.9 | Thoughtspot: 9.12.0.cl
+            *
+            * @example
+            * ```js
+            * const embed = new AppEmbed('#tsEmbed', {
+            *    ... // other options
+            *    modularHomeExperience : true,
+            * })
+            * ```
             */
         modularHomeExperience?: boolean;
         /**
@@ -880,6 +1136,14 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
             * 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;
         /**
@@ -889,10 +1153,28 @@ 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;
         /**
@@ -900,6 +1182,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;
         /**
@@ -910,6 +1198,16 @@ 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;
         /**
@@ -917,6 +1215,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;
         /**
@@ -925,6 +1230,16 @@ 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[];
         /**
@@ -938,12 +1253,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;
@@ -951,6 +1280,14 @@ 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;
         /**
@@ -958,20 +1295,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;
         /**
@@ -992,8 +1350,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;
 }
@@ -1670,8 +2035,21 @@ 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;
         /**
@@ -1688,6 +2066,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', {
@@ -1699,6 +2078,15 @@ 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;
         /**
@@ -1706,6 +2094,8 @@ 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', {
@@ -1726,17 +2116,49 @@ 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[];
         /**
@@ -1744,12 +2166,32 @@ 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;
         /**
@@ -1759,7 +2201,16 @@ export interface ViewConfig {
             * Warning: This option is for advanced use only and is used internally
             * 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?: {
@@ -1776,18 +2227,42 @@ 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;
         /**
@@ -1845,6 +2320,14 @@ export interface ViewConfig {
             * `modularHomeExperience` to `true` (available in Early Access from 9.12 forward).
             *
             * @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[];
         /**
@@ -1856,6 +2339,14 @@ export interface ViewConfig {
             * `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[];
         /**
@@ -1864,13 +2355,18 @@ 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[];
         /**
@@ -1878,8 +2374,14 @@ 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],
+            * })
             * ```
             *
             * **Note**: This option does not apply to the classic homepage.
@@ -1913,7 +2415,10 @@ 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,
@@ -1921,6 +2426,7 @@ export interface ViewConfig {
             *
             * // Instantiate an object with the configuration
             * const myComponent = new MyComponent(config);
+            * ```
             */
         doNotTrackPreRenderSize?: boolean;
         /**
@@ -6162,3 +6668,12 @@ export declare function testResetMixpanel(): void;
   */
 export declare const tokenizedFetch: typeof fetch;
 
+export declare const getAuthenticationToken: (embedConfig: EmbedConfig) => Promise<string>;
+/**
+  * Resets the auth token and a new token will be fetched on the next request.
+  *
+  * @version SDK: 1.28.0 | ThoughtSpot: *
+  * @group Authentication / Init
+  */
+export declare const resetCachedAuthToken: () => void;
+