@thoughtspot/visual-embed-sdk 1.39.2 → 1.40.0

package/src/types.ts

@@ -217,6 +217,12 @@ export enum HomeLeftNavItem {
      * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
      */
     Spotter = 'spotter',
+    /**
+     * Favorites option in the insights left navigation,
+     * available when new navigation V3 is enabled.
+     * @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl
+     */
+    Favorites = 'favorites',
 }
 export type DOMSelector = string | HTMLElement;
 
@@ -645,9 +651,9 @@ export interface EmbedConfig {
     customVariablesForThirdPartyTools?: Record< string, any >;
 
     disablePreauthCache?: boolean;
-    
+
     /**
-     * Disable fullscreen presentation mode functionality. When enabled, prevents entering 
+     * Disable fullscreen presentation mode functionality. When enabled, prevents entering
      * and exiting fullscreen mode for embedded visualizations during presentations.
      * @default true (feature is disabled by default)
      * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
@@ -702,7 +708,7 @@ export interface BaseViewConfig {
     /**
      * The width and height dimensions to render an embedded
      * object inside your app.  Specify the values in pixels or percentage.
-     * 
+     *
      * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
      * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 7.2.1
      * @example
@@ -732,7 +738,7 @@ export interface BaseViewConfig {
      * (...), and the contextual menu. These actions will be disabled
      * for the user.
      * Use this to disable actions.
-     * 
+     *
      * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
      * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
      * @example
@@ -747,7 +753,7 @@ export interface BaseViewConfig {
     disabledActions?: Action[];
     /**
      * The tooltip to display for disabled actions.
-     * 
+     *
      * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
      * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
      * @example
@@ -765,7 +771,7 @@ export interface BaseViewConfig {
      * The list of actions to hide from the embedded.
      * This actions will be hidden from the user.
      * Use this to hide an action.
-     * 
+     *
      * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
      * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
      * @example
@@ -786,7 +792,7 @@ export interface BaseViewConfig {
      * Use this to hide all actions except the ones you want to show.
      *
      * Use either this or hiddenActions.
-     * 
+     *
      * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
      * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
      * @important
@@ -802,7 +808,7 @@ export interface BaseViewConfig {
     visibleActions?: Action[];
     /**
      * The locale settings to apply to the embedded view.
-     * 
+     *
      * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
      * @version SDK: 1.9.4 | ThoughtSpot 8.1.0.cl, 8.4.1.sw
      * @example
@@ -823,7 +829,7 @@ export interface BaseViewConfig {
      * 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.
-     * 
+     *
      * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
      * @example
      * ```js
@@ -849,7 +855,7 @@ export interface BaseViewConfig {
     /**
      * Insert as a sibling of the target container, instead of appending to a
      * child inside it.
-     * 
+     *
      * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
      * @version SDK: 1.2.0 | ThoughtSpot: 9.0.0.cl, 9.0.0.sw
      * @example
@@ -875,7 +881,7 @@ export interface BaseViewConfig {
      * PreRender id to be used for PreRendering the embed.
      * Use PreRender to render the embed in the background and then
      * show or hide the rendered embed using showPreRender or hidePreRender respectively.
-     * 
+     *
      * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
      * @example
      * ```js
@@ -913,7 +919,7 @@ export interface BaseViewConfig {
     /**
      * Enable the V2 shell. This can provide performance benefits
      * due to a lighterweight shell.
-     * 
+     *
      * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
      * @example
      * ```js
@@ -941,7 +947,7 @@ export interface BaseViewConfig {
     /**
      * This flag can be used to disable links inside the embedded app,
      * and disable redirection of links in a new tab.
-     * 
+     *
      * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
      * @example
      * ```js
@@ -960,7 +966,7 @@ export interface BaseViewConfig {
      * objects from another Org.
      * The `overrideOrgId` setting is honoured only if the
      * Per Org URL feature is enabled on your ThoughtSpot instance.
-     * 
+     *
      * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
      * @example
      * ```js
@@ -975,7 +981,7 @@ export interface BaseViewConfig {
     overrideOrgId?: number;
     /**
      * Flag to override the *Open Link in New Tab* context menu option.
-     * 
+     *
      * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
      * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
      * @example
@@ -991,7 +997,7 @@ export interface BaseViewConfig {
     /**
      * The primary action to display on top of the viz for Liveboard and App Embed.
      * Use this to set the primary action.
-     * 
+     *
      * Supported embed types: `AppEmbed`, `LiveboardEmbed`
      * @version SDK: 1.39.0 | ThoughtSpot: 10.11.0.cl
      * @example
@@ -1010,6 +1016,20 @@ export interface BaseViewConfig {
      * @private
      */
     insertInToSlide?: boolean;
+    /**
+     * Show alert messages and toast messages in the embed.
+     * Supported embed in all embed types.
+     * 
+     * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
+     * @example
+     * ```js
+     * const embed = new AppEmbed('#tsEmbed', {
+     *    ... // other embed view config
+     *    showAlerts:true,
+     * })
+     * ```
+     */
+    showAlerts?: boolean;
 }
 
 /**
@@ -1021,7 +1041,7 @@ export interface HomePageConfig {
      * For example: hiddenListColumns = [ListPageColumns.Author]
      *
      * **Note**: This option is available only in full app embedding.
-     * 
+     *
      * Supported embed types: `AppEmbed`
      * @version SDK: 1.38.0 | ThoughtSpot: 10.9.0.cl
      * @example
@@ -1040,7 +1060,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).
-     * 
+     *
      * Supported embed types: `AppEmbed`
      * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
      * @example
@@ -1059,7 +1079,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).
-     * 
+     *
      * Supported embed types: `AppEmbed`
      * @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl, 10.1.0.sw
      * @example
@@ -1075,7 +1095,7 @@ export interface HomePageConfig {
      * homepageLeftNavItems : Show or hide the left navigation bar items.
      * There are 8 eight home navigation list items.
      * To hide these items, specify the string in the array.
-     * 
+     *
      * Supported embed types: `AppEmbed`
      * @example
      * ```js
@@ -1100,7 +1120,7 @@ export interface SearchLiveboardCommonViewConfig {
     /**
      * The list of runtime filters to apply to a search Answer,
      * visualization, or Liveboard.
-     * 
+     *
      * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SearchEmbed`
      * @version SDK: 1.9.4 | ThoughtSpot 8.1.0.cl, 8.4.1.sw
      * @example
@@ -1122,7 +1142,7 @@ export interface SearchLiveboardCommonViewConfig {
     /**
      * The list of parameter override to apply to a search Answer,
      * visualization, or Liveboard.
-     * 
+     *
      * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SearchEmbed`
      * @version SDK : 1.25.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
      * @example
@@ -1142,7 +1162,7 @@ export interface SearchLiveboardCommonViewConfig {
     runtimeParameters?: RuntimeParameter[];
     /**
      * flag to set ContextMenu Trigger to either left or right click.
-     * 
+     *
      * Supported embed types: `AppEmbed`, `SageEmbed`, `SearchEmbed`
      * @example
      * ```js
@@ -1178,7 +1198,7 @@ export interface SearchLiveboardCommonViewConfig {
     excludeRuntimeParametersfromURL?: boolean;
     /**
      * To set the initial state of the search bar in case of saved Answers.
-     * 
+     *
      * Supported embed types: `SageEmbed`, `AppEmbed`, `SearchBarEmbed`
      * @default true
      * @version SDK: 1.34.0 | ThoughtSpot: 10.3.0.cl
@@ -1193,7 +1213,7 @@ export interface SearchLiveboardCommonViewConfig {
     collapseSearchBar?: boolean;
     /**
      * Flag to control Data panel experience
-     * 
+     *
      * Supported embed types: `SageEmbed`, `AppEmbed`, `SearchBarEmbed`, `LiveboardEmbed`, `SearchEmbed`
      * @default false
      * @version SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
@@ -1209,7 +1229,7 @@ export interface SearchLiveboardCommonViewConfig {
     dataPanelV2?: boolean;
     /**
      * To enable custom column groups in data panel v2
-     * 
+     *
      * Supported embed types: `SageEmbed`, `SearchBarEmbed`, `LiveboardEmbed`, `SearchEmbed`
      * @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl, 10.1.0.sw
      * @default false
@@ -1231,7 +1251,7 @@ export interface SearchLiveboardCommonViewConfig {
 export interface LiveboardAppEmbedViewConfig {
     /**
      * Show or hide Liveboard header
-     * 
+     *
      * Supported embed types: `AppEmbed`, `LiveboardEmbed`
      * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
      * @default false
@@ -1247,7 +1267,7 @@ export interface LiveboardAppEmbedViewConfig {
     hideLiveboardHeader?: boolean;
     /**
      * Show or hide Liveboard title
-     * 
+     *
      * Supported embed types: `AppEmbed`, `LiveboardEmbed`
      * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
      * @default false
@@ -1263,7 +1283,7 @@ export interface LiveboardAppEmbedViewConfig {
     showLiveboardTitle?: boolean;
     /**
      * Show or hide Liveboard description
-     * 
+     *
      * Supported embed types: `AppEmbed`, `LiveboardEmbed`
      * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
      * @default false
@@ -1279,7 +1299,7 @@ export interface LiveboardAppEmbedViewConfig {
     showLiveboardDescription?: boolean;
     /**
      * Boolean to control if Liveboard header is sticky or not.
-     * 
+     *
      * Supported embed types: `AppEmbed`, `LiveboardEmbed`
      * @example
      * ```js
@@ -1294,7 +1314,7 @@ export interface LiveboardAppEmbedViewConfig {
     isLiveboardHeaderSticky?: boolean;
     /**
      * This attribute can be used to enable the two-column layout on an embedded Liveboard
-     * 
+     *
      * Supported embed types: `AppEmbed`, `LiveboardEmbed`
      * @type {boolean}
      * @default false
@@ -1311,7 +1331,7 @@ export interface LiveboardAppEmbedViewConfig {
     enable2ColumnLayout?: boolean;
     /**
      * This flag can be used to enable the compact header in Liveboard
-     * 
+     *
      * Supported embed types: `AppEmbed`, `LiveboardEmbed`
      * @type {boolean}
      * @default false
@@ -1328,7 +1348,7 @@ export interface LiveboardAppEmbedViewConfig {
     isLiveboardCompactHeaderEnabled?: boolean;
     /**
      * This flag can be used to show or hide the Liveboard verified icon in the compact header.
-     * 
+     *
      * Supported embed types: `AppEmbed`, `LiveboardEmbed`
      * @version SDK: 1.35.0 | ThoughtSpot:10.4.0.cl
      * @default true
@@ -1344,7 +1364,7 @@ export interface LiveboardAppEmbedViewConfig {
     showLiveboardVerifiedBadge?: boolean;
     /**
      * This flag is used to enable/disable hide irrelevant filters in Liveboard tab
-     * 
+     *
      * Supported embed types: `AppEmbed`, `LiveboardEmbed`
      * @version SDK: 1.36.0 | ThoughtSpot:10.6.0.cl
      * @default false
@@ -1360,7 +1380,7 @@ export interface LiveboardAppEmbedViewConfig {
     hideIrrelevantChipsInLiveboardTabs?: boolean;
     /**
      * This flag can be used to show or hide the re-verify banner on the Liveboard compact header
-     * 
+     *
      * Supported embed types: `AppEmbed`, `LiveboardEmbed`
      * @version SDK: 1.35.0 | ThoughtSpot:10.4.0.cl
      * @default true
@@ -1376,7 +1396,7 @@ export interface LiveboardAppEmbedViewConfig {
     showLiveboardReverifyBanner?: boolean;
     /**
      * enable or disable ask sage
-     * 
+     *
      * Supported embed types: `AppEmbed`, `LiveboardEmbed`
      * @version SDK: 1.29.0 | Thoughtspot: 9.12.0.cl
      * @default false
@@ -1390,6 +1410,22 @@ 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,
+     * })
+     * ```
+     */
+    coverAndFilterOptionInPDF?: boolean;
 }
 
 export interface AllEmbedViewConfig extends BaseViewConfig, SearchLiveboardCommonViewConfig, HomePageConfig, LiveboardAppEmbedViewConfig {}
@@ -2303,7 +2339,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);
      * })
      *```
@@ -2671,6 +2707,89 @@ export enum EmbedEvent {
      * @version SDK : 1.40.0 | ThoughtSpot: 10.11.0.cl
      */
     ExitPresentMode = 'exitPresentMode',
+    /**
+     * Emitted when a user requests the full height lazy load data.
+     * @version SDK : 1.39.0 | ThoughtSpot : 10.10.0.cl
+     * @hidden
+     */
+    RequestVisibleEmbedCoordinates = 'requestVisibleEmbedCoordinates',
+    /**
+     * Emitted when Spotter response is text data
+     * @example
+     * ```js
+     * spotterEmbed.on(EmbedEvent.SpotterData, (payload) => {
+     *     console.log('payload', payload);
+     * })
+     *```
+     * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
+     */
+    SpotterData = 'SpotterData',
+    /**
+     * 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.39.0 | ThoughtSpot: 10.10.0.cl
+     */
+    PreviewSpotterData = 'PreviewSpotterData',
+    /**
+     * Emitted when the Spotter query is triggered in Spotter embed.
+     * @example
+     * ```js
+     * spotterEmbed.on(EmbedEvent.SpotterQueryTriggered, (payload) => {
+     *     console.log('payload', payload);
+     * })
+     *```
+     * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
+     */
+    SpotterQueryTriggered = 'SpotterQueryTriggered',
+    /**
+     * 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.39.0 | ThoughtSpot: 10.10.0.cl
+     */
+    LastPromptEdited = 'LastPromptEdited',
+    /**
+     * 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.39.0 | ThoughtSpot: 10.10.0.cl
+     */
+    LastPromptDeleted = 'LastPromptDeleted',
+    /**
+     * Emitted when the coversation is reset in spotter embed.
+     * @example
+     * ```js
+     * spotterEmbed.on(EmbedEvent.ResetSpotterConversation, (payload) => {
+     *     console.log('payload', payload);
+     * })
+     *```
+     * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
+     */
+    ResetSpotterConversation = 'ResetSpotterConversation',
+    /**
+     * Emitted when the *Spotter* is initialized.
+     * @example
+     * ```js
+     * spotterEmbed.on(EmbedEvent.SpotterInit, (payload) => {
+     *     console.log('payload', payload);
+     * })
+     *```
+     * @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl
+     */
+    SpotterInit = 'spotterInit'
 }
 
 /**
@@ -2689,7 +2808,7 @@ export enum EmbedEvent {
  * // create the liveboard embed.
  *
  * liveboardEmbed.trigger(HostEvent.UpdateRuntimeFilters, [
- *   { columnName: 'state, operator: RuntimeFilterOp.EQ, values: ['california']}
+ *   { columnName: 'state', operator: RuntimeFilterOp.EQ, values: ["california"]}
  * ]);
  * ```
  * @example
@@ -2760,6 +2879,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) => {
@@ -2898,12 +3018,12 @@ export enum HostEvent {
      * Works with Search and Liveboard embed.
      * @param - { columnId: string,
      *  name: string,
-     *  type: INT64/CHAR/DATE,
-     *  dataType: ATTRIBUTE/MEASURE }
+     *  type: ATTRIBUTE/MEASURE,
+     *  dataType: INT64/CHAR/DATE }
      * @example
      * ```js
      * searchEmbed.trigger(HostEvent.OpenFilter,
-     *  {column: { columnId: '<column-GUID>', name: 'column name', type: 'INT64', dataType: 'ATTRIBUTE'}})
+     *  {column: { columnId: '<column-GUID>', name: 'column name', type: 'ATTRIBUTE', dataType: 'INT64'}})
      * ```
      * @example
      * ```js
@@ -2961,6 +3081,7 @@ export enum HostEvent {
      * @param
      * `vizId`-  GUID of the saved Answer or visualization to pin to a Liveboard.
      *  Optional when pinning a new chart or table generated from a Search query.
+     *  **Required** in Spotter Embed.
      * @param
      * `liveboardID` - GUID of the Liveboard to pin an Answer. If there is no Liveboard,
      *  specify the `newLiveboardName` parameter to create a new Liveboard.
@@ -3008,6 +3129,12 @@ export enum HostEvent {
      * ```js
      * appEmbed.trigger(HostEvent.Pin)
      * ```
+     * @example
+     * ```js
+     * const pinResponse = await spotterEmbed.trigger(HostEvent.Pin, {
+     *     vizId:'730496d6-6903-4601-937e-2c691821af3c'
+     *  });
+     * ```
      * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
      */
     Pin = 'pin',
@@ -3072,12 +3199,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',
@@ -3101,6 +3237,12 @@ export enum HostEvent {
      * ```js
      * searchEmbed.trigger(HostEvent.MakeACopy)
      * ```
+     * @example
+     * ```js
+     * const pinResponse = await spotterEmbed.trigger(HostEvent.MakeACopy, {
+     *     vizId:'730496d6-6903-4601-937e-2c691821af3c'
+     *  });
+     * ```
      * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
      */
     MakeACopy = 'makeACopy',
@@ -3173,6 +3315,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.
+     * @param - `vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed.
+     * 
      * @example
      * ```js
      * liveboardEmbed.trigger(HostEvent.Edit)
@@ -3181,6 +3325,18 @@ export enum HostEvent {
      * liveboardEmbed.trigger(HostEvent.Edit, {vizId:
      * '730496d6-6903-4601-937e-2c691821af3c'})
      * ```
+     * @example
+     * ```js
+     * const pinResponse = await spotterEmbed.trigger(HostEvent.Edit, {
+     *     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',
@@ -3228,6 +3384,16 @@ export enum HostEvent {
      *   );
      * })
      * ```
+     * @example
+     * ```js
+     * spotterEmbed.trigger(HostEvent.GetTML, {
+     *   vizId: '730496d6-6903-4601-937e-2c691821af3c'
+     * }).then((tml) => {
+     *   console.log(
+     *      tml.answer.search_query // TML representation of the search query
+     *   );
+     * })
+     * ```
      * @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1.sw
      * @important
      */
@@ -3291,6 +3457,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:
@@ -3299,6 +3466,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
@@ -3315,13 +3487,19 @@ export enum HostEvent {
      * vizEmbed.trigger(HostEvent.DownloadAsPng)
      *
      * searchEmbed.trigger(HostEvent.DownloadAsPng)
+     * 
+     * spotterEmbed.trigger(HostEvent.DownloadAsPng, {
+     *       vizId:"730496d6-6903-4601-937e-2c691821af3c"
+     * })
      * ```
+     * 
      * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.4.1.sw
      */
     DownloadAsPng = 'downloadAsPng',
     /**
      * 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:
@@ -3333,12 +3511,18 @@ export enum HostEvent {
      * ```js
      * searchEmbed.trigger(HostEvent.DownloadAsCsv)
      * ```
+     * ```js
+     * spotterEmbed.trigger(HostEvent.DownloadAsCsv, {
+     *       vizId:"730496d6-6903-4601-937e-2c691821af3c"
+     * })
+     * ```
      * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
      */
     DownloadAsCsv = 'downloadAsCSV',
     /**
      * 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:
@@ -3350,6 +3534,11 @@ export enum HostEvent {
      * ```js
      * searchEmbed.trigger(HostEvent.DownloadAsXlsx)
      * ```
+     * ```js
+     * spotterEmbed.trigger(HostEvent.downloadAsXLSX, {
+     *       vizId:"730496d6-6903-4601-937e-2c691821af3c"
+     * })
+     * ```
      * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
      */
     DownloadAsXlsx = 'downloadAsXLSX',
@@ -3369,6 +3558,7 @@ export enum HostEvent {
     /**
      * Trigger the **Save**  action on a Liveboard or Answer.
      * Saves the changes.
+     * @param - `vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed.
      * @example
      * ```js
      * liveboardEmbed.trigger(HostEvent.Save)
@@ -3376,6 +3566,11 @@ export enum HostEvent {
      * ```js
      * searchEmbed.trigger(HostEvent.Save)
      * ```
+     * ```js
+     * spotterEmbed.trigger(HostEvent.Save, {
+     *       vizId:"730496d6-6903-4601-937e-2c691821af3c"
+     * })
+     * ```
      * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
      */
     Save = 'save',
@@ -3595,16 +3790,16 @@ export enum HostEvent {
     /**
      * Get the Answer session for a Search or
      * Liveboard visualization.
-     * 
-     * Note: This event is not typically used directly. Instead, use the 
-     * `getAnswerService()` method on the embed instance to get an AnswerService 
+     *
+     * Note: This event is not typically used directly. Instead, use the
+     * `getAnswerService()` method on the embed instance to get an AnswerService
      * object that provides a more convenient interface for working with answers.
-     * 
+     *
      * @example
      * ```js
      * // Preferred way to get an AnswerService
      * const service = await embed.getAnswerService();
-     * 
+     *
      * // Alternative direct usage (not recommended)
      * const {session} = await embed.trigger(
      *  HostEvent.GetAnswerSession, {
@@ -3615,7 +3810,7 @@ export enum HostEvent {
      * ```js
      * // Preferred way to get an AnswerService
      * const service = await embed.getAnswerService();
-     * 
+     *
      * // Alternative direct usage (not recommended)
      * const {session} = await embed.trigger( HostEvent.GetAnswerSession )
      * ```
@@ -3659,7 +3854,7 @@ export enum HostEvent {
     ResetLiveboardPersonalisedView = 'ResetLiveboardPersonalisedView',
     /**
      * Triggers an action to update Parameter values on embedded
-     * Answers and Liveboard.
+     * Answers, Liveboard and Spotter answer in Edit mode.
      *
      * @example
      * ```js
@@ -3673,11 +3868,19 @@ 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);
      * });
      *```
+     *```js
+     * spotterEmbed.trigger(HostEvent.GetParameters, {
+     *  vizId: '730496d6-6903-4601-937e-2c691821af3c'
+     * }).then((parameter) => {
+     *  console.log('parameters', parameter);
+     * });
+     *```
      * @version SDK: 1.29.0 | ThoughtSpot: 10.1.0.cl, 10.1.0.sw
      */
     GetParameters = 'GetParameters',
@@ -3709,7 +3912,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, {
@@ -3717,6 +3920,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',
@@ -3745,6 +3956,70 @@ export enum HostEvent {
      * @version SDK: 1.37.0 | ThoughtSpot: 10.8.0.cl
      */
     TransformTableVizData = 'TransformTableVizData',
+    /**
+     * Triggers a search operation with the search tokens specified in
+     * the search query string in spotter embed.
+     * @param - `query`: Text string in Natural Language format
+     * @param - `executeSearch`: Boolean to execute search and update search query
+     * @example
+     * ```js
+     * spotterEmbed.trigger(HostEvent.SpotterSearch, {
+     *  query: 'revenue per year',
+     *  executeSearch: true,
+     * })
+     * ```
+     * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
+     */
+    SpotterSearch = 'SpotterSearch',
+    /**
+     * Edits the last prompt in spotter embed.
+     * @param - `query`: Text string
+     * @example
+     * ```js
+     * spotterEmbed.trigger(HostEvent.EditLastPrompt, "revenue per year");
+     * ```
+     * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
+     */
+    EditLastPrompt = 'EditLastPrompt',
+    /**
+     * Opens the Worksheet preview modal in Spotter Embed.
+     * @example
+     * ```js
+     * spotterEmbed.trigger(HostEvent.PreviewSpotterData);
+     * ```
+     * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
+     */
+    PreviewSpotterData = 'PreviewSpotterData',
+    /**
+     * Resets the Spotter Embed Conversation.
+     * @example
+     * ```js
+     * spotterEmbed.trigger(HostEvent.ResetSpotterConversation);
+     * ```
+     * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
+     */
+    ResetSpotterConversation = 'ResetSpotterConversation',
+    /**
+     * Deletes the last prompt in spotter embed.
+     * @example
+     * ```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 ` 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'
+     * });
+     *```
+     * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
+     */
+    AnswerChartSwitcher = 'answerChartSwitcher',
     /**
      * @hidden
      * Trigger exit from presentation mode when user exits fullscreen.
@@ -3755,6 +4030,30 @@ export enum HostEvent {
      * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
      */
     ExitPresentMode = 'exitPresentMode',
+    /**
+     * Triggers the full height lazy load data.
+     * @example
+     * ```js
+     * liveboardEmbed.on(EmbedEvent.RequestVisibleEmbedCoordinates, (payload) => {
+     *      console.log(payload);
+     * });
+     * ```
+     * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
+     *
+     * @hidden
+     */
+    VisibleEmbedCoordinates = 'visibleEmbedCoordinates',
+    /**
+     * 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
+     * spotterEmbed.trigger(HostEvent.AskSpotter,
+     * {vizId:'730496d6-6903-4601-937e-2c691821af3c'})
+     * ```
+     * @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl
+     */
+    AskSpotter = 'AskSpotter',
 }
 
 /**
@@ -3860,6 +4159,7 @@ export enum Param {
     Query = 'query',
     HideHomepageLeftNav = 'hideHomepageLeftNav',
     ModularHomeExperienceEnabled = 'modularHomeExperience',
+    ListPageVersion = 'listpageVersion',
     PendoTrackingKey = 'additionalPendoKey',
     LiveboardHeaderSticky = 'isLiveboardHeaderSticky',
     IsProductTour = 'isProductTour',
@@ -3894,10 +4194,12 @@ export enum Param {
     DataSourceId = 'dataSourceId',
     preAuthCache = 'preAuthCache',
     ShowSpotterLimitations = 'showSpotterLimitations',
-    CoverAndFilterOptionInPDF = 'coverAndFilterOptionInPDF',
+    CoverAndFilterOptionInPDF = 'arePdfCoverFilterPageCheckboxesEnabled',
     PrimaryAction = 'primaryAction',
     isSpotterAgentEmbed = 'isSpotterAgentEmbed',
     IsLiveboardStylingAndGroupingEnabled = 'isLiveboardStylingAndGroupingEnabled',
+    IsLazyLoadingForEmbedEnabled = 'isLazyLoadingForEmbedEnabled',
+    RootMarginForLazyLoad = 'rootMarginForLazyLoad'
 }
 
 /**
@@ -5137,6 +5439,22 @@ export enum Action {
      *  @version SDK: 1.37.0 | ThoughtSpot Cloud: 10.8.0.cl
      */
     CoverAndFilterOptionInPDF = 'coverAndFilterOptionInPDF',
+    /**
+     * Action ID for hide or disable the
+     * Spotter in conversation training widget.
+     * The Add to Coaching feature is currently in beta
+     * and is disabled by default on embed deployments.
+     * To enable this feature on your instance,
+     * contact ThoughtSpot Support.
+     *  @example
+     * ```js
+     * hiddenAction: [Action.InConversationTraining]
+     * disabledActions: [Action.InConversationTraining]
+     *
+     * ```
+     *  @version SDK: 1.39.0 | ThoughtSpot Cloud: 10.10.0.cl
+     */
+    InConversationTraining = 'InConversationTraining',
 }
 
 export interface AnswerServiceType {