@thoughtspot/visual-embed-sdk 1.40.1-alpha.2 → 1.41.0-pre-render-1

package/src/types.ts

@@ -231,12 +231,12 @@ export type DOMSelector = string | HTMLElement;
  * Use {@link CustomCssVariables} or css rules.
  */
 export interface customCssInterface {
-  /**
-   * The custom css variables, which can be set.
-   * The variables are available in the {@link CustomCssVariables}
-   * interface. For more information, see
-   * link:https://developers.thoughtspot.com/docs/css-variables-reference[CSS variable reference].
-   */
+    /**
+     * The custom css variables, which can be set.
+     * The variables are available in the {@link CustomCssVariables}
+     * interface. For more information, see
+     * link:https://developers.thoughtspot.com/docs/css-variables-reference[CSS variable reference].
+     */
     variables?: CustomCssVariables;
     /**
      * Can be used to define a custom font face
@@ -648,7 +648,7 @@ export interface EmbedConfig {
      * ```
      *  @version SDK 1.37.0 | ThoughtSpot: 10.8.0.cl
      */
-    customVariablesForThirdPartyTools?: Record< string, any >;
+    customVariablesForThirdPartyTools?: Record<string, any>;
 
     disablePreauthCache?: boolean;
 
@@ -669,7 +669,7 @@ export interface EmbedConfig {
 }
 
 // eslint-disable-next-line @typescript-eslint/no-empty-object-type
-export interface LayoutConfig {}
+export interface LayoutConfig { }
 
 /**
  * Embedded iframe configuration
@@ -1040,12 +1040,14 @@ export interface HomePageConfig {
      * Hide list page columns
      * For example: hiddenListColumns = [ListPageColumns.Author]
      *
-     * **Note**: This option is available only in full app embedding.
+     * **Note**: This option is available only in full app embedding. To use it, you need to import `ListPageColumns` enum.
      *
      * Supported embed types: `AppEmbed`
      * @version SDK: 1.38.0 | ThoughtSpot: 10.9.0.cl
      * @example
      * ```js
+     * import { ListPageColumns } from '@thoughtspot/visual-embed-sdk';
+     * 
      * const embed = new AppEmbed('#tsEmbed', {
      *    ... //other embed view config
      *    hiddenListColumns : [ListPageColumns.Favorite,ListPageColumns.Author],
@@ -1060,11 +1062,14 @@ export interface HomePageConfig {
      * **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).
+     * To use it, you need to import `HomepageModule` enum.
      *
      * Supported embed types: `AppEmbed`
      * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
      * @example
      * ```js
+     * import { HomepageModule } from '@thoughtspot/visual-embed-sdk';
+     * 
      * const embed = new AppEmbed('#tsEmbed', {
      *    ... //other embed view config
      *    hiddenHomepageModules : [HomepageModule.Favorite,HomepageModule.Learning],
@@ -1079,11 +1084,14 @@ export interface HomePageConfig {
      * **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).
+     * To use it, you need to import `HomepageModule` enum.
      *
      * Supported embed types: `AppEmbed`
      * @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl, 10.1.0.sw
      * @example
      * ```js
+     * import { HomepageModule } from '@thoughtspot/visual-embed-sdk';
+     * 
      * const embed = new AppEmbed('#tsEmbed', {
      *    ... //other embed view config
      *    reorderedHomepageModules:[HomepageModule.Favorite,HomepageModule.MyLibrary],
@@ -1099,6 +1107,8 @@ export interface HomePageConfig {
      * Supported embed types: `AppEmbed`
      * @example
      * ```js
+     * import { HomeLeftNavItem } from '@thoughtspot/visual-embed-sdk';
+     * 
      * const embed = new AppEmbed('#tsEmbed', {
      *    ... //other embed view config
      *    hiddenHomeLeftNavItems : [HomeLeftNavItem.Home,HomeLeftNavItem.Answers],
@@ -1108,6 +1118,7 @@ export interface HomePageConfig {
      * **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).
+     * To use it, you need to import `HomeLeftNavItem` enum.
      * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
      */
     hiddenHomeLeftNavItems?: HomeLeftNavItem[];
@@ -1410,25 +1421,25 @@ export interface LiveboardAppEmbedViewConfig {
      * ```
      */
     enableAskSage?: boolean;
-     /**
-     * This flag is used to show or hide checkboxes for including or excluding
-     * the cover and filters pages in the Liveboard PDF.
-     *
-     * Supported embed types: `AppEmbed`, `LiveboardEmbed`
-     * @version SDK: 1.40.0 | ThoughtSpot:10.8.0.cl
-     * @example
-     * ```js
-     * // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
-     * const embed = new <EmbedComponent>('#tsEmbed', {
-     *    ... // other embed view config
-     *    coverAndFilterOptionInPDF: false,
-     * })
-     * ```
-     */
+    /**
+    * This flag is used to show or hide checkboxes for including or excluding
+    * the cover and filters pages in the Liveboard PDF.
+    *
+    * Supported embed types: `AppEmbed`, `LiveboardEmbed`
+    * @version SDK: 1.40.0 | ThoughtSpot:10.8.0.cl
+    * @example
+    * ```js
+    * // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
+    * const embed = new <EmbedComponent>('#tsEmbed', {
+    *    ... // other embed view config
+    *    coverAndFilterOptionInPDF: false,
+    * })
+    * ```
+    */
     coverAndFilterOptionInPDF?: boolean;
 }
 
-export interface AllEmbedViewConfig extends BaseViewConfig, SearchLiveboardCommonViewConfig, HomePageConfig, LiveboardAppEmbedViewConfig {}
+export interface AllEmbedViewConfig extends BaseViewConfig, SearchLiveboardCommonViewConfig, HomePageConfig, LiveboardAppEmbedViewConfig { }
 
 /**
  * MessagePayload: Embed event payload: message type, data and status (start/end)
@@ -2339,7 +2350,7 @@ export enum EmbedEvent {
      * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
      * @example
      *```js
-     * liveboardEmbed.on(EmbedEvent.AnswerChartSwitcher, payload => {
+     * liveboardEmbed.on(EmbedEvent.LiveboardInfo, payload => {
      *    console.log('Liveboard details', payload);
      * })
      *```
@@ -2682,25 +2693,25 @@ export enum EmbedEvent {
      * ```
      * @version SDK: 1.37.0 | ThoughtSpot: 10.8.0.cl
      */
-     TableVizRendered = 'TableVizRendered',
-     /**
-     * Emitted when the liveboard is created from pin modal or Liveboard list page.
-     * You can use this event as a hook to trigger
-     * other events on liveboard creation.
-     *
-     * ```js
-     * liveboardEmbed.on(EmbedEvent.CreateLiveboard, (payload) => {
-     *     console.log('payload', payload);
-     * })
-     *```
-     * @version SDK : 1.37.0 | ThoughtSpot: 10.8.0.cl
-     */
+    TableVizRendered = 'TableVizRendered',
+    /**
+    * Emitted when the liveboard is created from pin modal or Liveboard list page.
+    * You can use this event as a hook to trigger
+    * other events on liveboard creation.
+    *
+    * ```js
+    * liveboardEmbed.on(EmbedEvent.CreateLiveboard, (payload) => {
+    *     console.log('payload', payload);
+    * })
+    *```
+    * @version SDK : 1.37.0 | ThoughtSpot: 10.8.0.cl
+    */
     CreateLiveboard = 'createLiveboard',
     /**
      * Emitted when a user creates a Model.
      * @version SDK : 1.37.0 | ThoughtSpot: 10.8.0.cl
      */
-     CreateModel = 'createModel',
+    CreateModel = 'createModel',
     /**
      * @hidden
      * Emitted when a user exits present mode.
@@ -2714,58 +2725,58 @@ export enum EmbedEvent {
      */
     RequestVisibleEmbedCoordinates = 'requestVisibleEmbedCoordinates',
     /**
-     * Emitted when spotter response is text data
+     * Emitted when Spotter response is text data
      * @example
      * ```js
      * spotterEmbed.on(EmbedEvent.SpotterData, (payload) => {
      *     console.log('payload', payload);
      * })
      *```
-     * @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl
+     * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
      */
     SpotterData = 'SpotterData',
     /**
-     * Emitted when user opens up the worksheet preview modal in spotter embed.
+     * Emitted when user opens up the worksheet preview modal in Spotter embed.
      * @example
      * ```js
      * spotterEmbed.on(EmbedEvent.PreviewSpotterData, (payload) => {
      *     console.log('payload', payload);
      * })
      *```
-     * @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl
+     * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
      */
     PreviewSpotterData = 'PreviewSpotterData',
     /**
-     * Emitted when the spotter query is triggered in spotter embed.
+     * Emitted when the Spotter query is triggered in Spotter embed.
      * @example
      * ```js
      * spotterEmbed.on(EmbedEvent.SpotterQueryTriggered, (payload) => {
      *     console.log('payload', payload);
      * })
      *```
-     * @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl
+     * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
      */
     SpotterQueryTriggered = 'SpotterQueryTriggered',
     /**
-     * Emitted when the last spotter query is edited in spotter embed.
+     * Emitted when the last Spotter query is edited in Spotter embed.
      * @example
      * ```js
      * spotterEmbed.on(EmbedEvent.LastPromptEdited, (payload) => {
      *     console.log('payload', payload);
      * })
      *```
-     * @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl
+     * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
      */
     LastPromptEdited = 'LastPromptEdited',
     /**
-     * Emitted when the last spotter query is deleted in spotter embed.
+     * Emitted when the last Spotter query is deleted in Spotter embed.
      * @example
      * ```js
      * spotterEmbed.on(EmbedEvent.LastPromptDeleted, (payload) => {
      *     console.log('payload', payload);
      * })
      *```
-     * @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl
+     * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
      */
     LastPromptDeleted = 'LastPromptDeleted',
     /**
@@ -2776,7 +2787,7 @@ export enum EmbedEvent {
      *     console.log('payload', payload);
      * })
      *```
-     * @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl
+     * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
      */
     ResetSpotterConversation = 'ResetSpotterConversation',
     /**
@@ -2789,7 +2800,19 @@ export enum EmbedEvent {
      *```
      * @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl
      */
-    SpotterInit = 'SpotterInit'
+    SpotterInit = 'spotterInit',
+    /**
+     * @hidden
+     * Triggers when the embed listener is ready to receive events.
+     * This is used to trigger events after the embed container is loaded.
+     * @example
+     * ```js
+     * liveboardEmbed.on(EmbedEvent.EmbedListenerReady, () => {
+     *     console.log('EmbedListenerReady');
+     * })
+     * ```
+     */
+    EmbedListenerReady = 'EmbedListenerReady',
 }
 
 /**
@@ -2879,6 +2902,7 @@ export enum HostEvent {
      * done automatically on the most popular column.
      * @param - vizId [TS >= 9.8.0] - Optional. The GUID of the visualization to drill
      * in case of a Liveboard.
+     * @param - `vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed.
      * @example
      * ```js
      * searchEmbed.on(EmbedEvent.VizPointDoubleClick, (payload) => {
@@ -3198,12 +3222,21 @@ export enum HostEvent {
      * Trigger the **Download PDF** action on an embedded Liveboard,
      * visualization or Answer.
      *
+     * @param - `vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed.
+     * 
      * **NOTE**: The **Download** > **PDF** action is available on
      * visualizations and Answers if the data is in tabular format.
      * @example
      * ```js
      * liveboardEmbed.trigger(HostEvent.DownloadAsPdf)
      * ```
+     * @example
+     * ```js
+     * spotterEmbed.trigger(HostEvent.DownloadAsPdf, {
+     *     vizId:'730496d6-6903-4601-937e-2c691821af3c'
+     *  });
+     * ```
+     * 
      * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
      */
     DownloadAsPdf = 'downloadAsPdf',
@@ -3305,7 +3338,8 @@ export enum HostEvent {
      * This event is not supported in visualization embed and search embed.
      * @param - object - To trigger the action for a specific visualization
      * in Liveboard embed, pass in `vizId` as a key.
-     * **Required** in Spotter embed.
+     * @param - `vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed.
+     * 
      * @example
      * ```js
      * liveboardEmbed.trigger(HostEvent.Edit)
@@ -3320,6 +3354,12 @@ export enum HostEvent {
      *     vizId:'730496d6-6903-4601-937e-2c691821af3c'
      *  });
      * ```
+     * @example
+     * ```js
+     * const editResponse = await spotterEmbed.trigger(HostEvent.Edit, {
+     *     vizId:'730496d6-6903-4601-937e-2c691821af3c'
+     *  });
+     * ```
      * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
      */
     Edit = 'edit',
@@ -3440,6 +3480,7 @@ export enum HostEvent {
     /**
      * Trigger the **Download** action on charts in
      * the embedded view.
+     * @param - `vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed.
      * @example
      * ```js
      * liveboardEmbed.trigger(HostEvent.Download, {vizId:
@@ -3448,6 +3489,11 @@ export enum HostEvent {
      * ```js
      * embed.trigger(HostEvent.Download)
      * ```
+     * ```js
+     * spotterEmbed.trigger(HostEvent.Download, {
+     *     vizId:'730496d6-6903-4601-937e-2c691821af3c'
+     *  });
+     * ```
      * @deprecated from SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl ,9.4.1.sw
      * Use {@link DownloadAsPng}
      * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
@@ -3476,6 +3522,7 @@ export enum HostEvent {
     /**
      * Trigger the **Download** > **CSV**  action on tables in
      * the embedded view.
+     * @param - `vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed.
      * @example
      * ```js
      * liveboardEmbed.trigger(HostEvent.DownloadAsCsv, {vizId:
@@ -3498,6 +3545,7 @@ export enum HostEvent {
     /**
      * Trigger the **Download** > **XLSX**  action on tables
      * in the embedded view.
+     * @param - `vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed.
      * @example
      * ```js
      * liveboardEmbed.trigger(HostEvent.DownloadAsXlsx, {vizId:
@@ -3533,7 +3581,7 @@ export enum HostEvent {
     /**
      * Trigger the **Save**  action on a Liveboard or Answer.
      * Saves the changes.
-     * @param - `vizId` is required in Spotter Embed.
+     * @param - `vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed.
      * @example
      * ```js
      * liveboardEmbed.trigger(HostEvent.Save)
@@ -3843,6 +3891,7 @@ export enum HostEvent {
     UpdateParameters = 'UpdateParameters',
     /**
      * Triggers GetParameters to fetch the runtime Parameters.
+     * @param - `vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed.
      * ```js
      * liveboardEmbed.trigger(HostEvent.GetParameters).then((parameter) => {
      *  console.log('parameters', parameter);
@@ -3874,7 +3923,7 @@ export enum HostEvent {
      *```
      * @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
      */
-     InfoSuccess = 'InfoSuccess',
+    InfoSuccess = 'InfoSuccess',
     /**
      * Trigger the save action for an Answer.
      * To programmatically save an answer without opening the
@@ -3886,7 +3935,7 @@ export enum HostEvent {
      * @param - optional attributes to set Answer properties.
      *  `name` - Name string for the Answer.
      *  `description` - Description text for the Answer.
-     *
+     * @param - `vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed.
      * @example
      * ```js
      * const saveAnswerResponse = await searchEmbed.trigger(HostEvent.SaveAnswer, {
@@ -3894,6 +3943,14 @@ export enum HostEvent {
      *      description: "Total sales by states in MidWest"
      *   });
      * ```
+     * @example
+     * ```js
+     * const saveAnswerResponse = await spotterEmbed.trigger(HostEvent.SaveAnswer, {
+     *      vizId: '730496d6-6903-4601-937e-2c691821af3c',
+     *      name: "Sales by states",
+     *      description: "Total sales by states in MidWest"
+     * });
+     * ```
      * @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
      */
     SaveAnswer = 'saveAnswer',
@@ -3925,7 +3982,7 @@ export enum HostEvent {
     /**
      * Triggers a search operation with the search tokens specified in
      * the search query string in spotter embed.
-     * @param - `queryString`: Text string in Natural Language format
+     * @param - `query`: Text string in Natural Language format
      * @param - `executeSearch`: Boolean to execute search and update search query
      * @example
      * ```js
@@ -3934,6 +3991,7 @@ export enum HostEvent {
      *  executeSearch: true,
      * })
      * ```
+     * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
      */
     SpotterSearch = 'SpotterSearch',
     /**
@@ -3943,6 +4001,7 @@ export enum HostEvent {
      * ```js
      * spotterEmbed.trigger(HostEvent.EditLastPrompt, "revenue per year");
      * ```
+     * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
      */
     EditLastPrompt = 'EditLastPrompt',
     /**
@@ -3951,6 +4010,7 @@ export enum HostEvent {
      * ```js
      * spotterEmbed.trigger(HostEvent.PreviewSpotterData);
      * ```
+     * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
      */
     PreviewSpotterData = 'PreviewSpotterData',
     /**
@@ -3959,6 +4019,7 @@ export enum HostEvent {
      * ```js
      * spotterEmbed.trigger(HostEvent.ResetSpotterConversation);
      * ```
+     * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
      */
     ResetSpotterConversation = 'ResetSpotterConversation',
     /**
@@ -3967,17 +4028,19 @@ export enum HostEvent {
      * ```js
      * spotterEmbed.trigger(HostEvent.DeleteLastPrompt);
      * ```
+     * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
      */
     DeleteLastPrompt = 'DeleteLastPrompt',
     /**
      * Toggle the visualization to chart or table view.
-     * @param - `vizId ` In Spotter Embed, vizId is required.
+     * @param - `vizId ` refers to the answer id in spotter Embed, it is required in spotter Embed.
      * @example
      * ```js
      * spotterEmbed.trigger(HostEvent.AnswerChartSwitcher, {
-     *          vizId:"'b535c760-8bbe-4e6f-bb26-af56b4129a1e'"
+     *          vizId:'b535c760-8bbe-4e6f-bb26-af56b4129a1e'
      * });
      *```
+     * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
      */
     AnswerChartSwitcher = 'answerChartSwitcher',
     /**
@@ -4004,15 +4067,16 @@ export enum HostEvent {
      */
     VisibleEmbedCoordinates = 'visibleEmbedCoordinates',
     /**
-     * Trigger the *Ask Sage* action for visualizations
+     * Trigger the *Ask Spotter* action for visualizations
+     * @param - `vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed.
      * @example
      * ```js
-     * liveboardEmbed.trigger(HostEvent.AskSpotter,
-     * {containerId:'730496d6-6903-4601-937e-2c691821af3c'})
+     * spotterEmbed.trigger(HostEvent.AskSpotter,
+     * {vizId:'730496d6-6903-4601-937e-2c691821af3c'})
      * ```
      * @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl
      */
-    AskSpotter = 'askSpotter',
+    AskSpotter = 'AskSpotter',
 
     /**
      * @hidden
@@ -4323,27 +4387,27 @@ export enum Action {
      */
     ConfigureFilter = 'configureFilter',
     /**
-    * The **Collapse data sources** icon on the Search page.
-    * Collapses the panel showing data sources.
-    *
-    * @example
-    * ```js
-    * disabledActions: [Action.CollapseDataPanel]
-    * ```
-    * @version: SDK: 1.1.0 | ThoughtSpot Cloud: ts7.may.cl, 8.4.1.sw
-    */
+     * The **Collapse data sources** icon on the Search page.
+     * Collapses the panel showing data sources.
+     *
+     * @example
+     * ```js
+     * disabledActions: [Action.CollapseDataPanel]
+     * ```
+     * @version: SDK: 1.1.0 | ThoughtSpot Cloud: ts7.may.cl, 8.4.1.sw
+     */
     CollapseDataSources = 'collapseDataSources',
     /**
-    * The **Collapse data panel** icon on the Search page.
-    * Collapses the data panel view.
-    *
-    * @version: SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
-    *
-    * @example
-    * ```js
-    * disabledActions: [Action.CollapseDataPanel]
-    * ```
-    */
+     * The **Collapse data panel** icon on the Search page.
+     * Collapses the data panel view.
+     *
+     * @version: SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
+     *
+     * @example
+     * ```js
+     * disabledActions: [Action.CollapseDataPanel]
+     * ```
+     */
     CollapseDataPanel = 'collapseDataPanel',
     /**
      * The **Choose sources** button on Search page.
@@ -5040,6 +5104,17 @@ export enum Action {
      * @version SDK: 1.25.0 | ThoughtSpot Cloud: 9.6.0.cl
      */
     EnableContextualChangeAnalysis = 'enableContextualChangeAnalysis',
+    /**
+     * Action ID to hide or disable Iterative Change Analysis option
+     * on contextual change analysis  Inisght charts context menu
+     *
+     * @example
+     * ```js
+     * disabledActions: [Action.EnableIterativeChangeAnalysis]
+     * ```
+     * @version SDK: 1.41.0 | ThoughtSpot Cloud: 9.12.0.cl
+     */
+    EnableIterativeChangeAnalysis = 'enableIterativeChangeAnalysis',
     /**
      * Action ID to hide or disable Natural Language Search query.
      *
@@ -5425,6 +5500,39 @@ export enum Action {
      *  @version SDK: 1.39.0 | ThoughtSpot Cloud: 10.10.0.cl
      */
     InConversationTraining = 'InConversationTraining',
+    /**
+     * Action ID to hide the warnings banner in
+     * Spotter results. It's an EA feature and
+     * handled by LD.
+     *  @example
+     * ```js
+     * hiddenAction: [Action.SpotterWarningsBanner]
+     * ```
+     *  @version SDK: 1.41.0 | ThoughtSpot Cloud: 10.13.0.cl
+     */
+    SpotterWarningsBanner = 'SpotterWarningsBanner',
+    /**
+     * Action ID to hide the warnings border on the knowledge
+     * card in Spotter results. It's an EA feature and
+     * handled by LD.
+     *  @example
+     * ```js
+     * hiddenAction: [Action.SpotterWarningsOnTokens]
+     * ```
+     *  @version SDK: 1.41.0 | ThoughtSpot Cloud: 10.13.0.cl
+     */
+    SpotterWarningsOnTokens = 'SpotterWarningsOnTokens',
+    /**
+     * Action ID to disable the click event handler on knowledge
+     * card in Spotter results. It's an EA feature and
+     * handled by LD.
+     *  @example
+     * ```js
+     * hiddenAction: [Action.SpotterTokenQuickEdit]
+     * ```
+     *  @version SDK: 1.41.0 | ThoughtSpot Cloud: 10.13.0.cl
+     */
+    SpotterTokenQuickEdit = 'SpotterTokenQuickEdit',
 }
 
 export interface AnswerServiceType {
@@ -5456,15 +5564,15 @@ export interface ColumnValue {
         [key: string]: any;
     };
     value:
-        | string
-        | number
-        | boolean
-        | {
-              v: {
-                  s: number;
-                  e: number;
-              };
-          };
+    | string
+    | number
+    | boolean
+    | {
+        v: {
+            s: number;
+            e: number;
+        };
+    };
 }
 
 export interface VizPoint {

package/src/utils/liveboardService/liveboardService.ts

@@ -4,16 +4,31 @@ import { getEmbedConfig } from '../../embed/embedConfig';
 import { executeTML } from '../../embed/base';
 
 /**
- * Create a liveboard with the given answers
- * @param answers AnswerService[]
- * @param name string
+ * Creates a new Liveboard in ThoughtSpot using the provided AnswerService instances.
+ * 
+ * Each answer will be added as a visualization to the newly created Liveboard.
+ * 
+ * @param {AnswerService[]} answers - An array of initialized `AnswerService` instances
+ * representing the answers to be added to the Liveboard.
+ * @param {string} name - The name of the Liveboard to create.
  * @returns result Promise
  * @version SDK: 1.33.1 | ThoughtSpot: *
  * @example
  * ```js
- *   const lb = createLiveboardWithAnswers([
- *      new AnswerService(session, null, 'tshost'),
- *   ], "my-liveboard");
+ * import { EmbedEvent, AnswerService } from "@thoughtspot/visual-embed-sdk";
+ *
+ * embed.on(EmbedEvent.Data, async () => {
+ *   try {
+ *     const answerService = await embed.getAnswerService();
+ *     const lb = await createLiveboardWithAnswers(
+ *       [answerService],
+ *       "My Liveboard"
+ *     );
+ *     console.log("Liveboard created:", lb);
+ *   } catch (err) {
+ *     console.error("Failed to create liveboard:", err);
+ *   }
+ * });
  * ```
  */
 export const createLiveboardWithAnswers = async (