@thoughtspot/visual-embed-sdk 1.33.0-alpha.1 → 1.33.0-dc.1

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

@@ -12,7 +12,7 @@ import EventEmitter from 'eventemitter3';
   * @summary ThoughtSpot Visual Embed SDK
   * @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
   */
-export { init, logout, prefetch, executeTML, exportTML, executeTMLInput, exportTMLInput, getEmbedConfig as getInitConfig, getSessionInfo, 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, };
+export { init, logout, prefetch, executeTML, exportTML, executeTMLInput, exportTMLInput, getEmbedConfig as getInitConfig, getSessionInfo, tokenizedFetch, getAnswerFromQuery, createLiveboardWithAnswers, SearchEmbed, SearchBarEmbed, PinboardEmbed, LiveboardEmbed, SageEmbed, AppEmbed, BodylessConversation, BodylessConversationViewConfig, 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, };
 
 /**
     * Copyright (c) 2022
@@ -54,7 +54,11 @@ export enum Page {
         /**
             * SpotIQ listing page
             */
-        SpotIQ = "insights"
+        SpotIQ = "insights",
+        /**
+            *  Monitor Alerts Page
+            */
+        Monitor = "monitor"
 }
 /**
     * Define the initial state os column custom group accordions
@@ -74,6 +78,11 @@ export enum DataPanelCustomColumnGroupsAccordionState {
             */
         EXPAND_FIRST = "EXPAND_FIRST"
 }
+export enum HomePageSearchBarMode {
+        OBJECT_SEARCH = "objectSearch",
+        AI_ANSWER = "aiAnswer",
+        NONE = "none"
+}
 /**
     * The view configuration for full app embedding.
     * @group Embed components
@@ -260,19 +269,6 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
             * ```
             */
         fullHeight?: boolean;
-        /**
-            * Flag to control Data panel experience
-            * @default false
-            * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
-            * @example
-            * ```js
-            * const embed = new AppEmbed('#tsEmbed', {
-            *    ... // other options
-            *    dataPanelV2: true,
-            * })
-            * ```
-            */
-        dataPanelV2?: boolean;
         /**
             * Show or hide Liveboard header
             * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
@@ -347,6 +343,7 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
             * To set the initial state of the search bar in case of saved-answers.
             * @version SDK: 1.32.0 | Thoughtspot: 10.0.0.cl
             * @default false
+            * @deprecated Use {@link collapseSearchBar} instead
             */
         collapseSearchBarInitially?: boolean;
         /**
@@ -400,6 +397,53 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
             * @version SDK : 1.29.0 | Thoughtspot : 10.1.0.cl
             */
         isOnBeforeGetVizDataInterceptEnabled?: boolean;
+        /**
+            * Flag to use home page search bar mode
+            * @version SDK : 1.33.0 | Thoughtspot : 10.2.0.cl
+            */
+        homePageSearchBarMode?: HomePageSearchBarMode;
+        /**
+            * This flag is used to enable the compact header in liveboard
+            * @type {boolean}
+            * @default false
+            * @version SDK: 1.35.0 | ThoughtSpot:10.3.0.cl
+            * @example
+            * ```js
+            * const embed = new AppEmbed('#embed-container', {
+            *    ... // other options
+            *    isLiveboardCompactHeaderEnabled: true,
+            * })
+            * ```
+            */
+        isLiveboardCompactHeaderEnabled?: boolean;
+        /**
+            * This flag is used to show/hide verified Icon in liveboard compact header
+            * @type {boolean}
+            * @default true
+            * @version SDK: 1.35.0 | ThoughtSpot:10.4.0.cl
+            * @example
+            * ```js
+            * const embed = new AppEmbed('#embed-container', {
+            *    ... // other options
+            *    showLiveboardVerifiedBadge: true,
+            * })
+            * ```
+            */
+        showLiveboardVerifiedBadge?: boolean;
+        /**
+            * This flag is used to show/hide re-verify banner in liveboard compact header
+            * @type {boolean}
+            * @default true
+            * @version SDK: 1.35.0 | ThoughtSpot:10.4.0.cl
+            * @example
+            * ```js
+            * const embed = new AppEmbed('#embed-container', {
+            *    ... // other options
+            *    showLiveboardReverifyBanner: true,
+            * })
+            * ```
+            */
+        showLiveboardReverifyBanner?: boolean;
 }
 /**
     * Embeds full ThoughtSpot experience in a host application.
@@ -521,22 +565,23 @@ export const renderInQueue: (fn: (next?: (val?: any) => void) => Promise<any>) =
 /**
     * Imports TML representation of the metadata objects into ThoughtSpot.
     * @param data
+    * @returns imports TML data into ThoughtSpot
     * @example
     * ```js
-    *   executeTML({
-    * //Array of metadata Tmls
-        metadata_tmls: [
-            "'\''{\"guid\":\"9bd202f5-d431-44bf-9a07-b4f7be372125\",
-            \"liveboard\":{\"name\":\"Parameters Liveboard\"}}'\''"
-        ],
-        import_policy: 'PARTIAL', // Specifies the import policy for the TML import.
-        create_new: false, // If selected, creates TML objects with new GUIDs.
-    }).then(result => {
-        console.log(result);
-    }).catch(error => {
-        console.error(error);
-    });
-    *
+    *  executeTML({
+    * //Array of metadata Tmls in string format
+    *      metadata_tmls: [
+    *          "'\''{\"guid\":\"9bd202f5-d431-44bf-9a07-b4f7be372125\",
+    *          \"liveboard\":{\"name\":\"Parameters Liveboard\"}}'\''"
+    *      ],
+    *      import_policy: 'PARTIAL', // Specifies the import policy for the TML import.
+    *      create_new: false, // If selected, creates TML objects with new GUIDs.
+    *  }).then(result => {
+    *      console.log(result);
+    *  }).catch(error => {
+    *      console.error(error);
+    *  });
+    *```
     * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
     * @group Global methods
     */
@@ -545,27 +590,28 @@ export const executeTML: (data: executeTMLInput) => Promise<any>;
     * Exports TML representation of the metadata objects from ThoughtSpot in JSON or YAML
     * format.
     * @param data
+    * @returns exports TML data
     * @example
     * ```js
-    exportTML({
-        metadata: [
-            {
-                type: "LIVEBOARD", //Metadata Type
-                identifier: "9bd202f5-d431-44bf-9a07-b4f7be372125" //Metadata Id
-            }
-        ],
-        export_associated: false,//indicates whether to export associated metadata objects
-        export_fqn: false, //Adds FQNs of the referenced objects.For example, if you are
-                                             //exporting a Liveboard and its associated objects, the API
-                                             //returns the Liveboard TML data with the FQNs of the referenced
-                                             //worksheet. If the exported TML data includes FQNs, you don't need
-                                             //to manually add FQNs of the referenced objects during TML import.
-        edoc_format: "JSON" //It takes JSON or YAML value
-    }).then(result => {
-        console.log(result);
-    }).catch(error => {
-        console.error(error);
-    });
+    * exportTML({
+    *   metadata: [
+    *     {
+    *       type: "LIVEBOARD", //Metadata Type
+    *       identifier: "9bd202f5-d431-44bf-9a07-b4f7be372125" //Metadata Id
+    *     }
+    *   ],
+    *   export_associated: false,//indicates whether to export associated metadata objects
+    *   export_fqn: false, //Adds FQNs of the referenced objects.For example, if you are
+    *                      //exporting a Liveboard and its associated objects, the API
+    *                      //returns the Liveboard TML data with the FQNs of the referenced
+    *                      //worksheet. If the exported TML data includes FQNs, you don't need
+    *                      //to manually add FQNs of the referenced objects during TML import.
+    *   edoc_format: "JSON" //It takes JSON or YAML value
+    * }).then(result => {
+    *   console.log(result);
+    * }).catch(error => {
+    *   console.error(error);
+    * });
     * ```
     * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
     * @group Global methods
@@ -841,6 +887,48 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
             * @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl
             */
         showPreviewLoader?: boolean;
+        /**
+            * This flag is used to enable the compact header in liveboard
+            * @type {boolean}
+            * @default false
+            * @version SDK: 1.35.0 | ThoughtSpot:10.3.0.cl
+            * @example
+            * ```js
+            * const embed = new LiveboardEmbed('#embed-container', {
+            *    ... // other options
+            *    isLiveboardCompactHeaderEnabled: true,
+            * })
+            * ```
+            */
+        isLiveboardCompactHeaderEnabled?: boolean;
+        /**
+            * This flag is used to show/hide verified Icon in liveboard compact header
+            * @type {boolean}
+            * @default true
+            * @version SDK: 1.35.0 | ThoughtSpot:10.4.0.cl
+            * @example
+            * ```js
+            * const embed = new LiveboardEmbed('#embed-container', {
+            *    ... // other options
+            *    showLiveboardVerifiedBadge: true,
+            * })
+            * ```
+            */
+        showLiveboardVerifiedBadge?: boolean;
+        /**
+            * This flag is used to show/hide re-verify banner in liveboard compact header
+            * @type {boolean}
+            * @default true
+            * @version SDK: 1.35.0 | ThoughtSpot:10.4.0.cl
+            * @example
+            * ```js
+            * const embed = new LiveboardEmbed('#embed-container', {
+            *    ... // other options
+            *    showLiveboardReverifyBanner: true,
+            * })
+            * ```
+            */
+        showLiveboardReverifyBanner?: boolean;
 }
 /**
     * Embed a ThoughtSpot Liveboard or visualization. When rendered it already
@@ -880,6 +968,13 @@ export class LiveboardEmbed extends V1Embed {
             */
         render(): Promise<LiveboardEmbed>;
         navigateToLiveboard(liveboardId: string, vizId?: string, activeTabId?: string): void;
+        /**
+            * Returns the full url of the liveboard/viz which can be used to open
+            * this liveboard inside the full Thoughtspot application in a new tab.
+            *
+            * @returns url string
+            */
+        getLiveboardUrl(): string;
 }
 /**
     * @hidden
@@ -947,6 +1042,19 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
             * ```
             */
         collapseDataSources?: boolean;
+        /**
+            * If set to true, the data panel is collapsed on load,
+            * but can be expanded manually.
+            * @version: SDK: 1.34.0 | ThoughtSpot: 10.3.0.cl
+            * @example
+            * ```js
+            * const embed = new SearchEmbed('#tsEmbed', {
+            *    ... // other options
+            *    collapseDataPanel:true,
+            * })
+            * ```
+            */
+        collapseDataPanel?: boolean;
         /**
             * Show or hide the data sources panel.
             * @version: SDK: 1.2.0 | ThoughtSpot: 9.1.0.sw
@@ -1073,19 +1181,6 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
             * ```
             */
         hideSearchBar?: boolean;
-        /**
-            * Flag to control Data panel experience
-            * @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;
         /**
             * Flag to set if last selected dataSource should be used
             * @version: SDK: 1.24.0
@@ -1095,6 +1190,7 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
             * To set the initial state of the search bar in case of saved-answers.
             * @default false
             * @version SDK: 1.32.0 | Thoughtspot: 10.0.0.cl
+            * @deprecated Use {@link collapseSearchBar} instead
             */
         collapseSearchBarInitially?: boolean;
         /**
@@ -1258,6 +1354,29 @@ export class SearchBarEmbed extends TsEmbed {
         render(): Promise<SearchBarEmbed>;
 }
 
+export interface BodylessConversationViewConfig extends ViewConfig {
+        /**
+            * The ID of the worksheet to use for the conversation.
+            */
+        worksheetId: string;
+}
+/**
+    * Create a conversation embed, which can be integrated inside
+    * chatbots or other conversational interfaces.
+    * @group Embed components
+    * @version SDK: 1.34.0 | ThoughtSpot: 10.3.0.cl
+    */
+export class BodylessConversation {
+        constructor(viewConfig: BodylessConversationViewConfig);
+        sendMessage(userMessage: string): Promise<{
+                error: any;
+                container?: undefined;
+        } | {
+                container: HTMLDivElement;
+                error?: undefined;
+        }>;
+}
+
 export let loggedInStatus: boolean;
 export let samlAuthWindow: Window;
 export let samlCompletionPromise: Promise<void>;
@@ -1383,7 +1502,6 @@ export function notifyLogout(): void;
     * Services to be called after the login is successful,
     * This should be called after the cookie is set for cookie auth or
     * after the token is set for cookieless.
-    *
     * @return {Promise<void>}
     * @example
     * ```js
@@ -1690,7 +1808,11 @@ export enum HomeLeftNavItem {
         /**
             * @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
             */
-        SpotIQAnalysis = "spotiq-analysis"
+        SpotIQAnalysis = "spotiq-analysis",
+        /**
+            * @version SDK: 1.34.0| ThoughtSpot: 10.3.0.cl
+            */
+        LiveboardSchedules = "liveboard-schedules"
 }
 export type DOMSelector = string | HTMLElement;
 /**
@@ -1917,13 +2039,6 @@ export interface EmbedConfig {
             * @default false
             */
         queueMultiRenders?: boolean;
-        /**
-            * Dynamic CSS URL to be injected in the loaded application.
-            * You would also need to set `style-src` in the CSP settings.
-            * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
-            * @default ''
-            */
-        customCssUrl?: string;
         /**
             * [AuthServer|Basic] Detect if third-party party cookies are enabled by doing an
             * additional call. This is slower and should be avoided. Listen to the
@@ -2052,6 +2167,12 @@ export interface EmbedConfig {
             * @version SDK: 1.28.5 | Thoughtspot: *
             */
         disableTokenVerification?: boolean;
+        /**
+            * This flag is used to disable showing the login failure page in the embedded app.
+            *
+            * @version SDK 1.32.3 | Thoughtspot: *
+            */
+        disableLoginFailurePage?: boolean;
 }
 export interface LayoutConfig {
 }
@@ -2174,11 +2295,12 @@ export interface ViewConfig {
             */
         visibleActions?: Action[];
         /**
-            * Show alert messages and toast messages in the embedded view.
+            * Show alert messages and toast messages in the embedded
+            * view in full app embed.
             * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
             * @example
             * ```js
-            * const embed = new LiveboardEmbed('#embed-container', {
+            * const embed = new AppEmbed('#embed-container', {
             *    ... // other options
             *    showAlerts:true,
             * })
@@ -2475,6 +2597,43 @@ export interface ViewConfig {
             * @version SDK: 1.31.2 | ThoughtSpot: 10.0.0.cl
             */
         enableV2Shell_experimental?: boolean;
+        /**
+            * To set the initial state of the search bar in case of saved-answers.
+            * @default true
+            * @version SDK: 1.34.0 | Thoughtspot: 10.3.0.cl
+            * @example
+            * ```js
+            * const embed = new LiveboardEmbed('#embed', {
+            *   liveboardId: '123',
+            *   collapseSearchBar: true
+            * });
+            */
+        collapseSearchBar?: boolean;
+        /**
+            * This flag can be used to disable links inside the embedded app,
+            * and disables redirection of links in a new tab.
+            * @example
+            * ```js
+            * const embed = new LiveboardEmbed('#embed', {
+            *   disableRedirectionLinksInNewTab: true
+            * });
+            * ```
+            * @version SDK: 1.32.1 | ThoughtSpot: 10.3.0.cl
+            */
+        disableRedirectionLinksInNewTab?: boolean;
+        /**
+            * Flag to control Data panel experience
+            * @default true
+            * @version SDK: 1.34.0 | Thoughtspot: 10.3.0.cl
+            * @example
+            * ```js
+            * const embed = new AppEmbed('#tsEmbed', {
+            *    ... // other options
+            *    dataPanelV2: true,
+            * })
+            * ```
+            */
+        dataPanelV2?: boolean;
 }
 /**
     * MessagePayload: Embed event payload: message type, data and status (start/end)
@@ -2671,6 +2830,28 @@ export interface RuntimeParameter {
     *   console.log('Drilldown event', drilldown);
     * }));
     * ```
+    *
+    * If you are using React components for embedding, you can register to any
+    * events from the `EmbedEvent` list by using the `on<EventName>` convention.
+    * For example,`onAlert`, `onCopyToClipboard` and so on.
+    *
+    *  @example
+    * ```js
+    * // ...
+    * const MyComponent = ({ dataSources }) => {
+    *      const onLoad = () => {
+    *      console.log(EmbedEvent.Load, {});
+    *      };
+    *
+    *      return (
+    *          <SearchEmbed
+    *              dataSources={dataSources}
+    *              onLoad = {logEvent("Load")}
+    *          />
+    *     );
+    * };
+    * ```
+    *
     * @group Events
     */
 export enum EmbedEvent {
@@ -3539,21 +3720,61 @@ export enum EmbedEvent {
             */
         Rename = "rename",
         /**
-            * Emitted when user wants to intercept the search execution
+            * Emitted if the user wants to intercept the search execution
+            * and implement logic to decide whether to run the search or not
+            *
+            * Prerequisite: Set isOnBeforeGetVizDataInterceptEnabled : true
+            * for this embed event to get emitted.
+            *
+            * @param: payload
+            * @param: responder
+            * Contains elements that lets developers define whether ThoughtSpot
+            * will run the search or not, and if not, which error message to provide.
             *
-            * Set IsOnBeforeGetVizDataInterceptEnabled : true to use
-            * this embed event
+            * execute: When execute returns true, the search will be run.
+            * When execute returns false, the search will not be executed.
             *
+            * error: Developers can customize the user facing message when execute is
+            * set to false using the error parameter in responder
+            *
+            * @version SDK : 1.29.0 | Thoughtspot : 10.2.0.cl
+            *
+            * @example
             *```js
-            * searchEmbed.on(EmbedEvent.OnBeforeGetVizDataIntercept,
+            * .on(EmbedEvent.OnBeforeGetVizDataIntercept,
             * (payload, responder) => {
             *  responder({
             *      data: {
-            *          execute: true,
-            *   }})
+            *          execute:false,
+            *          error: {
+            *          //Provide a custom error message to explain to your end user
+            *          //why their search did not run
+            *          errorText: "This search query cannot be run.
+            *          Please contact your administrator for more details."
+            *          }
+            *  }})
+            * })
+            * ```
+            *
+            *```js
+            * .on(EmbedEvent.OnBeforeGetVizDataIntercept,
+            * (payload, responder) => {
+            * const query = payload.data.data.answer.search_query
+            * responder({
+            *  data: {
+            *      // returns true as long as the query does not include
+            *      // both the 'sales' AND the 'county' column
+            *      execute: !(query.includes("sales")&&query.includes("county")),
+            *      error: {
+            *      //Provide a custom error message to explain to your end user
+            *      // why their search did not run, and which searches are accepted by your custom logic.
+            *      errorText: "You can't use this query :" + query + ".
+            *      The 'sales' measures can never be used at the 'county' level.
+            *      Please try another measure, or remove 'county' from your search."
+            *      }
+            *  }})
             * })
             *```
-            * @version SDK : 1.29.0 | Thoughtspot : 10.2.0.cl
             */
         OnBeforeGetVizDataIntercept = "onBeforeGetVizDataIntercept",
         /**
@@ -3571,7 +3792,7 @@ export enum EmbedEvent {
 }
 /**
     * Event types that can be triggered by the host application
-    * to the embedded ThoughtSpot app
+    * to the embedded ThoughtSpot app.
     *
     * To trigger an event use the corresponding
     * {@link LiveboardEmbed.trigger} or {@link AppEmbed.trigger} or {@link
@@ -3588,6 +3809,40 @@ export enum EmbedEvent {
     *   { columnName: 'state, operator: RuntimeFilterOp.EQ, values: ['california']}
     * ]);
     * ```
+    * @example
+    * If using React components to embed, use the format shown in this example:
+    *
+    * ```js
+    *  const selectVizs = () => {
+    *      embedRef.current.trigger(HostEvent.SetVisibleVizs, [
+    *         "715e4613-c891-4884-be44-aa8d13701c06",
+    *         "3f84d633-e325-44b2-be25-c6650e5a49cf"
+    *      ]);
+    *    };
+    * ```
+    *
+    *
+    * You can also attach an Embed event to a Host event to trigger
+    * a specific action as shown in this example:
+    *
+    * @example
+    * ```js
+    *  const EmbeddedComponent = () => {
+    *       const embedRef = useRef(null); // import { useRef } from react
+    *       const onLiveboardRendered = () => {
+    *          embedRef.current.trigger(HostEvent.SetVisibleVizs, ['viz1', 'viz2']);
+    *      };
+    *
+    *      return (
+    *          <LiveboardEmbed
+    *              ref={embedRef}
+    *              liveboardId="<liveboard-guid>"
+    *              onLiveboardRendered={onLiveboardRendered}
+    *          />
+    *      );
+    *  }
+    * ```
+    *
     * @group Events
     */
 export enum HostEvent {
@@ -3671,6 +3926,15 @@ export enum HostEvent {
             * @hidden
             */
         Reload = "reload",
+        /**
+            * Get current iframe src
+            * @example
+            * ```js
+            * const frameUrl = AppEmbed.trigger(HostEvent.GetIframeUrl)
+            * ```
+            * @version SDK: 1.35.0 | Thoughtspot: 10.4.0.cl
+            */
+        GetIframeUrl = "GetIframeUrl",
         /**
             * Display specific visualizations on a Liveboard.
             * @param - An array of GUIDs of the visualization to show. The visualization IDs not passed
@@ -3937,13 +4201,15 @@ export enum HostEvent {
             *
             * @example
             * ```js
-            * appEmbed.trigger(HostEvent.CreateMonitor)
+            * searchEmbed.trigger(HostEvent.CreateMonitor)
             * ```
             * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
             */
         CreateMonitor = "createMonitor",
         /**
-            * Trigger the **Manage alerts** action on a visualization
+            * Trigger the **Manage alerts** action on a KPI chart
+            * in a visualization or saved Answer.
+            *
             * @param - an object with `vizId` as a key
             * @example
             * ```js
@@ -3951,6 +4217,16 @@ export enum HostEvent {
             *  vizId: '730496d6-6903-4601-937e-2c691821af3c'
             * })
             * ```
+            *
+            * @example
+            * ```js
+            * searchEmbed.trigger(HostEvent.ManageMonitor)
+            * ```
+            *
+            * @example
+            * ```js
+            * vizEmbed.trigger(HostEvent.ManageMonitor)
+            * ```
             * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
             */
         ManageMonitor = "manageMonitor",
@@ -4260,11 +4536,24 @@ export enum HostEvent {
             *     filter: {
             *         column: "item type",
             *         oper: "IN",
-            *         values: ["bags","shirts"],
+            *         values: ["bags","shirts"]
             *        }
             *    });
             * ```
             * @example
+            * ```js
+            *
+            * liveboardEmbed.trigger(HostEvent.UpdateFilters, {
+            *     filter: {
+            *         column: "date",
+            *         oper: "EQ",
+            *         values: ["JULY","2023"],
+            *         type: "MONTH_YEAR"
+            *        }
+            *    });
+            * ```
+            *
+            * @example
             *
             * ```js
             * liveboardEmbed.trigger(HostEvent.UpdateFilters, {
@@ -4281,7 +4570,8 @@ export enum HostEvent {
             *    {
             *      column: "Date",
             *      oper: 'EQ',
-            *      values: ["1656680400"]
+            *      values: ["2023-07-31"],
+            *      types: "EXACT_DATE"
             *    }]
             * });
             * ```
@@ -4467,7 +4757,6 @@ export enum Param {
         ViewPortHeight = "viewPortHeight",
         ViewPortWidth = "viewPortWidth",
         VisibleActions = "visibleAction",
-        CustomCSSUrl = "customCssUrl",
         DisableLoginRedirect = "disableLoginRedirect",
         visibleVizs = "pinboardVisibleVizs",
         LiveboardV2Enabled = "isPinboardV2Enabled",
@@ -4522,7 +4811,12 @@ export enum Param {
         Enable2ColumnLayout = "enable2ColumnLayout",
         IsFullAppEmbed = "isFullAppEmbed",
         IsOnBeforeGetVizDataInterceptEnabled = "isOnBeforeGetVizDataInterceptEnabled",
-        FocusSearchBarOnRender = "focusSearchBarOnRender"
+        FocusSearchBarOnRender = "focusSearchBarOnRender",
+        DisableRedirectionLinksInNewTab = "disableRedirectionLinksInNewTab",
+        HomePageSearchBarMode = "homePageSearchBarMode",
+        ShowLiveboardVerifiedBadge = "showLiveboardVerifiedBadge",
+        ShowLiveboardReverifyBanner = "showLiveboardReverifyBanner",
+        LiveboardHeaderV2 = "isLiveboardHeaderV2Enabled"
 }
 /**
     * ThoughtSpot application pages include actions and menu commands
@@ -4671,6 +4965,7 @@ export enum Action {
             */
         ConfigureFilter = "configureFilter",
         CollapseDataSources = "collapseDataSources",
+        CollapseDataPanel = "collapseDataPanel",
         /**
             * The **Choose sources** button on Search page.
             * Allows selecting data sources for search queries.
@@ -5066,12 +5361,15 @@ export enum Action {
             * The Create alert action on KPI charts.
             * @example
             * ```js
-            * disabledActions: [Action.CreateMonitor ]
+            * disabledActions: [Action.CreateMonitor]
             * ```
             * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
             */
         CreateMonitor = "createMonitor",
         /**
+            * @deprecated
+            * Reports errors
+            *
             * @example
             * ```js
             * disabledActions: [Action.ReportError]
@@ -5296,35 +5594,84 @@ export enum Action {
             */
         RenameModalTitleDescription = "renameModalTitleDescription",
         /**
+            *
+            * @example
+            * ```js
+            * disabledActions: [Action.RequestVerification]
+            * ```
             *
             * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
             */
         RequestVerification = "requestVerification",
         /**
+            *
+            * Allows users to mark a Liveboard as verified.
+            *
+            * @example
+            * ```js
+            * disabledActions: [Action.MarkAsVerified]
+            * ```
             * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
             */
         MarkAsVerified = "markAsVerified",
         /**
+            * The **Add Tab** action on a Liveboard.
+            * Allows adding a new tab to a Liveboard view.
+            *
+            * @example
+            * ```js
+            * disabledActions: [Action.AddTab]
+            * ```
             * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
             */
         AddTab = "addTab",
         /**
+            *
+            * Initiates contextual change analysis on KPI charts.
+            *
+            * @example
+            * ```js
+            * disabledActions: [Action.EnableContextualChangeAnalysis]
+            * ```
             * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
             */
         EnableContextualChangeAnalysis = "enableContextualChangeAnalysis",
         /**
+            *
+            * @example
+            * ```js
+            * disabledActions: [Action.ShowSageQuery]
+            * ```
+            *
             * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
             */
         ShowSageQuery = "showSageQuery",
         /**
+            *
+            * @example
+            * ```js
+            * disabledActions: [Action.EditSageAnswer]
+            * ```
             * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
             */
         EditSageAnswer = "editSageAnswer",
         /**
+            *
+            * This action allows users to send feedback on AI-generated Answers.
+            *
+            * @example
+            * ```js
+            * disabledActions: [Action.SageAnswerFeedback]
+            * ```
             * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
             */
         SageAnswerFeedback = "sageAnswerFeedback",
         /**
+            *
+            * @example
+            * ```js
+            * disabledActions: [Action.ModifySageAnswer]
+            * ```
             * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
             */
         ModifySageAnswer = "modifySageAnswer",
@@ -5391,7 +5738,7 @@ export enum Action {
             *
             * @version SDK: 1.32.0 | Thoughtspot: 10.1.0.cl
             */
-        CreateLiveboard = "CreateLiveboard",
+        CreateLiveboard = "createLiveboard",
         /**
             * Action ID for to hide Verified Liveboard Banner
             *  @example
@@ -5445,7 +5792,71 @@ export enum Action {
             * ```
             *  @version SDK: 1.27.10 | Thoughtspot: 9.12.5.cl
             */
-        AIHighlights = "AIHighlights"
+        AIHighlights = "AIHighlights",
+        /**
+            * Action ID for edit schedule action on schedule on homepage
+            * @example
+            * ```js
+            * disabledActions: [Action.EditScheduleHomepage]
+            * ```
+            *  @version SDK: 1.34.0 | Thoughtspot: 10.3.0.cl
+            */
+        EditScheduleHomepage = "editScheduleHomepage",
+        /**
+            * Action ID for pause schedule action on schedule on homepage
+            * @example
+            * ```js
+            * disabledActions: [Action.PauseScheduleHomepage]
+            * ```
+            *  @version SDK: 1.34.0 | Thoughtspot: 10.3.0.cl
+            */
+        PauseScheduleHomepage = "pauseScheduleHomepage",
+        /**
+            * Action ID for view schedule run action on schedule on homepage
+            * @example
+            * ```js
+            * disabledActions: [Action.ViewScheduleRunHomepage]
+            * ```
+            *  @version SDK: 1.34.0 | Thoughtspot: 10.3.0.cl
+            */
+        ViewScheduleRunHomepage = "viewScheduleRunHomepage",
+        /**
+            * Action ID for unsubscribe schedule action on schedule on homepage
+            * @example
+            * ```js
+            * disabledActions: [Action.UnsubscribeScheduleHomepage]
+            * ```
+            *  @version SDK: 1.34.0 | Thoughtspot: 10.3.0.cl
+            */
+        UnsubscribeScheduleHomepage = "unsubscribeScheduleHomepage",
+        /**
+            * The **Manage Tags** action on Homepage Favourite Module.
+            *
+            * @example
+            * ```js
+            * disabledActions: [Action.ManageTags]
+            * ```
+            * @version SDK : 1.34.0 | Thoughtspot: 10.3.0.cl
+            */
+        ManageTags = "manageTags",
+        /**
+            * Action ID for delete schedule action on schedule on homepage
+            * @example
+            * ```js
+            * disabledActions: [Action.DeleteScheduleHomepage]
+            * ```
+            *  @version SDK: 1.34.0 | Thoughtspot: 10.3.0.cl
+            */
+        DeleteScheduleHomepage = "deleteScheduleHomepage",
+        /**
+            * The **Analyze CTA** action on KPI chart.
+            * @example
+            * ```js
+            * disabledActions: [Action.KPIAnalysisCTA]
+            * ```
+            *  @version SDK: 1.34.0 | Thoughtspot: 10.3.0.cl
+            */
+        KPIAnalysisCTA = "kpiAnalysisCTA"
 }
 export interface AnswerServiceType {
         getAnswer?: (offset: number, batchSize: number) => any;
@@ -5601,9 +6012,12 @@ export interface CustomCssVariables {
             */
         '--ts-var-root-text-transform'?: string;
         /**
-            * application color, it replaces #2770EF which is rd-color(blue,base) and
-            * its similar colors like rd-color(blue,60), rd-color(accent, base) and
-            * rd-color(text, accent) in the app.
+            * Font color of the text on toggle buttons such as
+            * **All**, **Answers**, and **Liveboards** on the Home page (Classic experience),
+            * the text color of the chart and table tiles on Home page (New modular Homepage experience),
+            * and title text on the AI-generated charts and tables.
+            * The default color code is #2770EF.
+            *
             */
         '--ts-var-application-color'?: string;
         /**
@@ -5714,6 +6128,10 @@ export interface CustomCssVariables {
             * Background color of the primary buttons on hover.
             */
         '--ts-var-button--primary--hover-background'?: string;
+        /**
+            * Backgroud color of the primary buttons when active.
+            */
+        '--ts-var-button--primary--active-background'?: string;
         /**
             * Font color of the text on the secondary buttons.
             */
@@ -5730,6 +6148,10 @@ export interface CustomCssVariables {
             * Background color of the secondary button on hover.
             */
         '--ts-var-button--secondary--hover-background'?: string;
+        /**
+            * Backgroud color of the secondary buttons when active.
+            */
+        '--ts-var-button--secondary--active-background'?: string;
         /**
             * Font color of the tertiary button. For example, the *Undo*, *Redo*, and *Reset*
             * buttons on the *Search* page.
@@ -5743,6 +6165,10 @@ export interface CustomCssVariables {
             * Background color of the tertiary button when a user hovers over these buttons.
             */
         '--ts-var-button--tertiary--hover-background'?: string;
+        /**
+            * Backgroud color of the tertiary buttons when active.
+            */
+        '--ts-var-button--tertiary--active-background'?: string;
         /**
             * Font color of the title text of a visualization or Answer.
             */
@@ -5918,6 +6344,34 @@ export interface CustomCssVariables {
             * Background for favorite carousel find your favorites card in modular home.
             */
         '--ts-var-home-favorite-suggestion-card-background'?: string;
+        /**
+            * Border color of checkbox in error state.
+            */
+        '--ts-var-checkbox-error-border'?: string;
+        /**
+            * Border color of checkbox.
+            */
+        '--ts-var-checkbox-border-color'?: string;
+        /**
+            * Border color of checkbox in hover state.
+            */
+        '--ts-var-checkbox-hover-border'?: string;
+        /**
+            * Border and font color of checkbox in active state.
+            */
+        '--ts-var-checkbox-active-color'?: string;
+        /**
+            * Border color and font color of checkbox in checked state.
+            */
+        '--ts-var-checkbox-checked-color'?: string;
+        /**
+            * Border and font color of checkbox in disabled state.
+            */
+        '--ts-var-checkbox-checked-disabled'?: string;
+        /**
+            * Background color of checkbox.
+            */
+        '--ts-var-checkbox-background-color'?: string;
 }
 
 /**
@@ -6159,6 +6613,7 @@ export class AnswerService {
             * @returns
             */
         addFilter(columnName: string, operator: RuntimeFilterOp, values: RuntimeFilter['values']): Promise<any>;
+        getSQLQuery(): Promise<string>;
         /**
             * Fetch data from the answer.
             * @param offset
@@ -6177,6 +6632,16 @@ export class AnswerService {
             * @returns Response
             */
         fetchCSVBlob(userLocale?: string, includeInfo?: boolean): Promise<Response>;
+        /**
+            * Fetch the data for the answer as a PNG blob. This might be
+            * quicker for larger data.
+            * @param userLocale
+            * @param includeInfo
+            * @param omitBackground Omit the background in the PNG
+            * @param deviceScaleFactor The scale factor for the PNG
+            * @return Response
+            */
+        fetchPNGBlob(userLocale?: string, includeInfo?: boolean, omitBackground?: boolean, deviceScaleFactor?: number): Promise<Response>;
         /**
             * Just get the internal URL for this answer's data
             * as a CSV blob.
@@ -6185,6 +6650,14 @@ export class AnswerService {
             * @returns
             */
         getFetchCSVBlobUrl(userLocale?: string, includeInfo?: boolean): string;
+        /**
+            * Just get the internal URL for this answer's data
+            * as a PNG blob.
+            * @param userLocale
+            * @param omitBackground
+            * @param deviceScaleFactor
+            */
+        getFetchPNGBlobUrl(userLocale?: string, omitBackground?: boolean, deviceScaleFactor?: number): string;
         /**
             * Get underlying data given a point and the output column names.
             * In case of a context menu action, the selectedPoints are
@@ -6216,6 +6689,9 @@ export class AnswerService {
             */
         getSession(): SessionInterface;
         getAnswer(): Promise<any>;
+        getTML(): Promise<any>;
+        addDisplayedVizToLiveboard(liveboardId: string): Promise<any>;
+        setTMLOverride(override: any): void;
 }
 
 /**
@@ -6237,6 +6713,10 @@ export const setEmbedConfig: (newConfig: EmbedConfig) => EmbedConfig;
 export const EndPoints: {
         CONFIG: string;
 };
+/**
+    * Enum of mixpanel events
+    * @hidden
+    */
 export const MIXPANEL_EVENT: {
         VISUAL_SDK_RENDER_START: string;
         VISUAL_SDK_CALLED_INIT: string;
@@ -6282,16 +6762,33 @@ export function testResetMixpanel(): void;
   */
 export const tokenizedFetch: typeof fetch;
 
-export function getAuthenticationToken(embedConfig: EmbedConfig): Promise<string>;
 /**
-  * Resets the auth token and a new token will be fetched on the next request.
-  * @example
-  * ```js
-  * resetCachedAuthToken();
-  * ```
-  * @version SDK: 1.28.0 | ThoughtSpot: *
-  * @group Authentication / Init
+  *
+  * @param query string
+  * @param worksheetId string
+  * @returns answerService AnswerService
   */
+export const getAnswerFromQuery: (query: string, worksheetId: string) => Promise<{
+    answer: AnswerService;
+    suggestion: any;
+}>;
+
+export const createLiveboardWithAnswers: (answers: AnswerService[], name: string) => Promise<any>;
+
+/**
+    *
+    * @param embedConfig
+    */
+export function getAuthenticationToken(embedConfig: EmbedConfig): Promise<string>;
+/**
+    * Resets the auth token and a new token will be fetched on the next request.
+    * @example
+    * ```js
+    * resetCachedAuthToken();
+    * ```
+    * @version SDK: 1.28.0 | ThoughtSpot: *
+    * @group Authentication / Init
+    */
 export const resetCachedAuthToken: () => void;
 
 /**
@@ -6359,7 +6856,7 @@ export class TsEmbed {
             * @param queryParams
             * @returns queryParams
             */
-        protected getBaseQueryParams(queryParams?: {}): {};
+        protected getBaseQueryParams(queryParams?: Record<any, any>): Record<any, any>;
         /**
             * Constructs the base URL string to load v1 of the ThoughtSpot app.
             * This is used for embedding Liveboards, visualizations, and full application.
@@ -6486,7 +6983,9 @@ export class TsEmbed {
             * THOUGHTSPOT URL params starts with a prefix "ts-"
             * @version SDK: 1.14.0 | ThoughtSpot: 8.4.0.cl, 8.4.1-sw
             */
-        getThoughtSpotPostUrlParams(): string;
+        getThoughtSpotPostUrlParams(additionalParams?: {
+                [key: string]: string | number;
+        }): string;
         /**
             * Destroys the ThoughtSpot embed, and remove any nodes from the DOM.
             * @version SDK: 1.19.1 | ThoughtSpot: *
@@ -6577,7 +7076,6 @@ export class V1Embed extends TsEmbed {
         on(messageType: EmbedEvent, callback: MessageCallback, options?: MessageOptions): typeof TsEmbed.prototype;
         /**
             * Only for testing purposes.
-            *
             * @hidden
             */
         test__executeCallbacks: (eventType: EmbedEvent, data: any, eventPort?: void | MessagePort) => void;