@thoughtspot/visual-embed-sdk 1.42.3 → 1.43.1

package/src/types.ts

@@ -14,7 +14,7 @@ import type { SessionInterface } from './utils/graphql/answerService/answerServi
  * the embedded app
  * @group Authentication / Init
  */
- 
+
 export enum AuthType {
     /**
      * No authentication on the SDK. Pass-through to the embedded App. Alias for
@@ -262,7 +262,7 @@ export interface customCssInterface {
      *   };
      * ```
      */
-     
+
     rules_UNSTABLE?: {
         [selector: string]: {
             [declaration: string]: string;
@@ -681,12 +681,12 @@ export interface EmbedConfig {
      *   ... // other embed config options
      *   customActions: [
      *     {
-     *       name: 'customAction', 
+     *       name: 'customAction',
      *       id: 'customAction',
      *       target: CustomActionTarget.VISUALIZATION,
      *       position: CustomActionPosition.PRIMARY,
      *       }
-     *     }    
+     *     }
      *   ]
      * })
      * ```
@@ -708,7 +708,7 @@ export interface EmbedConfig {
 }
 
 // eslint-disable-next-line @typescript-eslint/no-empty-object-type
-export interface LayoutConfig { }
+export interface LayoutConfig {}
 
 /**
  * Embedded iframe configuration
@@ -739,7 +739,7 @@ export interface FrameParams {
 /**
  * The common configuration object for an embedded view.
  */
-export interface BaseViewConfig {
+export interface BaseViewConfig extends ApiInterceptFlags {
     /**
      * @hidden
      */
@@ -770,7 +770,7 @@ export interface BaseViewConfig {
     /**
      * @hidden
      */
-     
+
     styleSheet__unstable?: string;
     /**
      * The list of actions to disable from the primary menu, more menu
@@ -970,7 +970,7 @@ export interface BaseViewConfig {
      * ```
      * @version SDK: 1.31.2 | ThoughtSpot: 10.0.0.cl
      */
-     
+
     enableV2Shell_experimental?: boolean;
     /**
      * For internal tracking of the embed component type.
@@ -1058,7 +1058,7 @@ export interface BaseViewConfig {
     /**
      * 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
@@ -1075,7 +1075,7 @@ export interface BaseViewConfig {
      * actions enable users to trigger custom workflows — such as navigating to an
      * external app, calling an API, or opening a modal — based on the data context of
      * what they clicked can be used to trigger custom logic when the action is clicked.
-     * 
+     *
      * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterEmbed`
      * @version SDK: 1.43.0 | ThoughtSpot: 10.14.0.cl
      * @example
@@ -1086,12 +1086,12 @@ export interface BaseViewConfig {
      *   ... // other embed config options
      *   customActions: [
      *     {
-     *       name: 'customAction', 
+     *       name: 'customAction',
      *       id: 'customAction',
      *       target: CustomActionTarget.VISUALIZATION,
      *       position: CustomActionPosition.PRIMARY,
      *       }
-     *     }    
+     *     }
      *   ]
      * })
      * ```
@@ -1107,7 +1107,7 @@ export interface HomePageConfig {
      * Hide list page columns
      * For example: hiddenListColumns = [ListPageColumns.Author]
      *
-     * **Note**: This option is currently available only in full app embedding and requires importing the ListPageColumns enum. 
+     * **Note**: This option is currently available only in full app embedding and requires importing the ListPageColumns enum.
      * At present, it can be used with Liveboard and Answer list pages, and starting with version 10.14.0.cl, it will also be supported for the Home page.
      *
      * Supported embed types: `AppEmbed`
@@ -1115,7 +1115,7 @@ export interface HomePageConfig {
      * @example
      * ```js
      * import { ListPageColumns } from '@thoughtspot/visual-embed-sdk';
-     * 
+     *
      * const embed = new AppEmbed('#tsEmbed', {
      *    ... //other embed view config
      *    hiddenListColumns : [ListPageColumns.Favorite,ListPageColumns.Author],
@@ -1137,7 +1137,7 @@ export interface HomePageConfig {
      * @example
      * ```js
      * import { HomepageModule } from '@thoughtspot/visual-embed-sdk';
-     * 
+     *
      * const embed = new AppEmbed('#tsEmbed', {
      *    ... //other embed view config
      *    hiddenHomepageModules : [HomepageModule.Favorite,HomepageModule.Learning],
@@ -1159,7 +1159,7 @@ export interface HomePageConfig {
      * @example
      * ```js
      * import { HomepageModule } from '@thoughtspot/visual-embed-sdk';
-     * 
+     *
      * const embed = new AppEmbed('#tsEmbed', {
      *    ... //other embed view config
      *    reorderedHomepageModules:[HomepageModule.Favorite,HomepageModule.MyLibrary],
@@ -1176,7 +1176,7 @@ export interface HomePageConfig {
      * @example
      * ```js
      * import { HomeLeftNavItem } from '@thoughtspot/visual-embed-sdk';
-     * 
+     *
      * const embed = new AppEmbed('#tsEmbed', {
      *    ... //other embed view config
      *    hiddenHomeLeftNavItems : [HomeLeftNavItem.Home,HomeLeftNavItem.Answers],
@@ -1295,7 +1295,7 @@ export interface SearchLiveboardCommonViewConfig {
      *
      * Supported embed types: `SageEmbed`, `AppEmbed`, `SearchBarEmbed`, `LiveboardEmbed`, `SearchEmbed`
      * @default true
-     * @version SDK: 1.43.0 | ThoughtSpot Cloud: 10.14.0.cl
+     * @version SDK: 1.41.1 | ThoughtSpot Cloud: 10.14.0.cl
      * @example
      * ```js
      * // Replace <EmbedComponent> with embed component name. For example, SageEmbed, AppEmbed, or SearchBarEmbed
@@ -1444,7 +1444,7 @@ export interface LiveboardAppEmbedViewConfig {
     showLiveboardVerifiedBadge?: boolean;
     /**
      * This flag is used to enable/disable hide irrelevant filters in Liveboard tab
-     * 
+     *
      * **Note**: This feature is supported only if compact header is enabled on your Liveboard. To enable compact header, use the `isLiveboardCompactHeaderEnabled` attribute.
      *
      * Supported embed types: `AppEmbed`, `LiveboardEmbed`
@@ -1495,26 +1495,27 @@ 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;
     /**
      * This flag is used to enable or disable the XLSX/CSV download option for Liveboards.
+     * To enable this feature on your instance, contact ThoughtSpot Support.
      *
      * Supported embed types: `AppEmbed`, `LiveboardEmbed`
-     * @version SDK: 1.41.0 | ThoughtSpot: 10.14.0.cl
+     * @version SDK: 1.41.0 | ThoughtSpot: 26.3.0.cl
      * @example
      * ```js
      * // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
@@ -1576,7 +1577,11 @@ export interface LiveboardAppEmbedViewConfig {
     isEnhancedFilterInteractivityEnabled?: 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)
@@ -1637,7 +1642,7 @@ export type QueryParams = {
 /**
  * A map of the supported runtime filter operations
  */
- 
+
 export enum RuntimeFilterOp {
     /**
      * Equals
@@ -1708,7 +1713,7 @@ export enum RuntimeFilterOp {
  * `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
  * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
  */
- 
+
 export enum HomepageModule {
     /**
      * Search bar
@@ -1741,7 +1746,7 @@ export enum HomepageModule {
  * **Note**: This option is applicable to full app embedding only.
  * @version SDK: 1.38.0 | ThoughtSpot: 10.9.0.cl
  */
- 
+
 export enum ListPageColumns {
     /**
      * Favourite
@@ -1839,7 +1844,7 @@ export interface RuntimeParameter {
  * ```
  * @group Events
  */
- 
+
 export enum EmbedEvent {
     /**
      * Rendering has initialized.
@@ -1881,7 +1886,7 @@ export enum EmbedEvent {
      */
     Load = 'load',
     /**
-     * Data pertaining to an Answer or Liveboard is received.
+     * Data pertaining to an Answer, Liveboard or Spotter visualization is received.
      * The event payload includes the raw data of the object.
      * @return data -  Answer of Liveboard data
      * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
@@ -2302,6 +2307,17 @@ export enum EmbedEvent {
      *```
      */
     AnswerDelete = 'answerDelete',
+    /**
+     * Emitted when the AI Highlights action is triggered on a Liveboard
+     * @version SDK: 1.44.0 | ThoughtSpot: 10.15.0.cl
+     * @example
+     *```js
+     * liveboardEmbed.on(EmbedEvent.AIHighlights, (payload) => {
+     *   console.log('AI Highlights', payload);
+     * })
+     *```
+     */
+    AIHighlights = 'AIHighlights',
     /**
      * Emitted when a user initiates the Pin action to
      *  add an Answer to a Liveboard.
@@ -2732,21 +2748,24 @@ export enum EmbedEvent {
 
      * Prerequisite: Set `isOnBeforeGetVizDataInterceptEnabled` to `true`
      * for this embed event to get emitted.
-     * @param: payload
-     * @param: responder
+     * @param:payload The payload received from the embed related to the Data API call.
+     * @param:responder
      * Contains elements that lets developers define whether ThoughtSpot
      * should run the search, and if not, what error message
      * should be shown to the user.
      *
-     * execute: When execute returns `true`, the search will be run.
+     * `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 error message text when `execute`
-     * returns `false` using the error parameter in responder.
+     * `error` - Developers can customize the error message text when `execute`
+     * is `false` using the `errorText` and `errorDescription` parameters in responder.
+     * 
+     * `errorText` - The error message text to be shown to the user.
+     * `errorDescription (ThoughtSpot: 10.15.0.cl and above)` - The error description to be shown to the user.
      * @version SDK : 1.29.0 | ThoughtSpot: 10.3.0.cl
      * @example
      *```js
-     * .on(EmbedEvent.OnBeforeGetVizDataIntercept,
+     * embed.on(EmbedEvent.OnBeforeGetVizDataIntercept,
      * (payload, responder) => {
      *  responder({
      *      data: {
@@ -2762,7 +2781,7 @@ export enum EmbedEvent {
      * ```
      *
      *```js
-     * .on(EmbedEvent.OnBeforeGetVizDataIntercept,
+     * embed.on(EmbedEvent.OnBeforeGetVizDataIntercept,
      * (payload, responder) => {
      * const query = payload.data.data.answer.search_query
      * responder({
@@ -2773,7 +2792,8 @@ export enum EmbedEvent {
      *      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 + ".
+     *      errorText: "Error Occurred",
+     *      errorDescription: "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."
      *      }
@@ -2837,17 +2857,17 @@ export enum EmbedEvent {
      */
     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
-    */
+     * 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.
@@ -2943,6 +2963,17 @@ export enum EmbedEvent {
      * @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl
      */
     SpotterInit = 'spotterInit',
+    /**
+     * Emitted when a *Spotter* conversation has been successfully created.
+     * @example
+     * ```js
+     * spotterEmbed.on(EmbedEvent.SpotterLoadComplete, (payload) => {
+     *     console.log('payload', payload);
+     * })
+     *```
+     * @version SDK: 1.44.0 | ThoughtSpot: 26.2.0.cl
+     */
+    SpotterLoadComplete = 'spotterLoadComplete',
     /**
      * @hidden
      * Triggers when the embed listener is ready to receive events.
@@ -2966,6 +2997,72 @@ export enum EmbedEvent {
      * @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl
      */
     OrgSwitched = 'orgSwitched',
+    /**
+     * Emitted when the user intercepts a URL.
+     *
+     * Supported on all embed types.
+     *
+     * @example
+     *
+     * ```js
+     * embed.on(EmbedEvent.ApiIntercept, (payload, responder) => {
+     *     console.log('payload', payload);
+     *     responder({
+     *         data: {
+     *             execute: false,
+     *             error: {
+     *                 errorText: 'Error Occurred',
+     *             }
+     *         }
+     *     })
+     * })
+     * ```
+     *
+     * ```js
+     * // We can also send a response for the intercepted api
+     * embed.on(EmbedEvent.ApiIntercept, (payload, responder) => {
+     *     console.log('payload', payload);
+     *     responder({
+     *         data: {
+     *             execute: false,
+     *             response: {
+     *                body: {
+     *                    data: {
+     *                       // Some api response
+     *                    },
+     *                }
+     *             }
+     *         }
+     *     })
+     * })
+     *
+     * // here embed will use the response from the responder as the response for the api
+     * ```
+     *
+     * ```js
+     * // We can also send error in response for the intercepted api
+     * embed.on(EmbedEvent.ApiIntercept, (payload, responder) => {
+     *     console.log('payload', payload);
+     *     responder({
+     *         data: {
+     *             execute: false,
+     *             response: {
+     *                body: {
+     *                    errors: [{
+     *                      title: 'Error Occurred',
+     *                      description: 'Error Description',
+     *                      isUserError: true,
+     *                    }],
+     *                    data: {},
+     *                },
+     *             }
+     *         }
+     *     })
+     * })
+     * ```
+     * @version SDK: 1.43.0 | ThoughtSpot: 10.15.0.cl
+     */
+    ApiIntercept = 'ApiIntercept',
 }
 
 /**
@@ -3021,7 +3118,7 @@ export enum EmbedEvent {
  * ```
  * @group Events
  */
- 
+
 export enum HostEvent {
     /**
      * Triggers a search operation with the search tokens specified in
@@ -3253,7 +3350,7 @@ export enum HostEvent {
      * the following parameters:
      *
      * @param
-     * `vizId`-  GUID of the saved Answer or visualization to pin to a Liveboard.
+     * `vizId`-  GUID of the saved Answer or Spotter visualization ID to pin to a Liveboard.
      *  Optional when pinning a new chart or table generated from a Search query.
      *  **Required** in Spotter Embed.
      * @param
@@ -3305,10 +3402,16 @@ export enum HostEvent {
      * ```
      * @example
      * ```js
-     * const pinResponse = await spotterEmbed.trigger(HostEvent.Pin, {
-     *     vizId:'730496d6-6903-4601-937e-2c691821af3c'
-     *  });
-     * ```
+
+    * // You can use the Data event dispatched on each answer creation to get the vizId and use in Pin host event.
+    * let latestSpotterVizId = '';
+    * spotterEmbed.on(EmbedEvent.Data, (payload) => {
+    *   latestSpotterVizId = payload.data.id;
+    * });
+    *
+    * spotterEmbed.trigger(HostEvent.Pin, { vizId: latestSpotterVizId });
+    * ```
+     * 
      * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
      */
     Pin = 'pin',
@@ -3383,14 +3486,29 @@ export enum HostEvent {
      * ```
      * @example
      * ```js
-     * spotterEmbed.trigger(HostEvent.DownloadAsPdf, {
-     *     vizId:'730496d6-6903-4601-937e-2c691821af3c'
-     *  });
-     * ```
+
+    * // You can use the Data event dispatched on each answer creation to get the vizId and use in DownloadAsPdf host event.
+    * let latestSpotterVizId = '';
+    * spotterEmbed.on(EmbedEvent.Data, (payload) => {
+    *   latestSpotterVizId = payload.data.id;
+    * });
+    *
+    * spotterEmbed.trigger(HostEvent.DownloadAsPdf, { vizId: latestSpotterVizId });
+    * ```
      * 
      * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
      */
     DownloadAsPdf = 'downloadAsPdf',
+    /**
+     * Trigger the **AI Highlights** action on an embedded Liveboard
+     *
+     * @example
+     * ```js
+     * liveboardEmbed.trigger(HostEvent.AIHighlights)
+     * ```
+     * @version SDK: 1.44.0 | ThoughtSpot: 10.15.0.cl
+     */
+    AIHighlights = 'AIHighlights',
     /**
      * Trigger the **Make a copy** action on a Liveboard,
      * visualization, or Answer page.
@@ -3413,9 +3531,13 @@ export enum HostEvent {
      * ```
      * @example
      * ```js
-     * const pinResponse = await spotterEmbed.trigger(HostEvent.MakeACopy, {
-     *     vizId:'730496d6-6903-4601-937e-2c691821af3c'
-     *  });
+     * // You can use the Data event dispatched on each answer creation to get the vizId and use in MakeACopy host event.
+     * let latestSpotterVizId = '';
+     * spotterEmbed.on(EmbedEvent.Data, (payload) => {
+     *   latestSpotterVizId = payload.data.id;
+     * });
+     *
+     * spotterEmbed.trigger(HostEvent.MakeACopy, { vizId: latestSpotterVizId });
      * ```
      * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
      */
@@ -3490,7 +3612,7 @@ export enum HostEvent {
      * @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)
@@ -3501,15 +3623,7 @@ export enum HostEvent {
      * ```
      * @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'
-     *  });
+     * spotterEmbed.trigger(HostEvent.Edit);
      * ```
      * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
      */
@@ -3558,16 +3672,23 @@ export enum HostEvent {
      *   );
      * })
      * ```
-     * @example
+     * * @example
      * ```js
-     * spotterEmbed.trigger(HostEvent.GetTML, {
-     *   vizId: '730496d6-6903-4601-937e-2c691821af3c'
+
+    * // You can use the Data event dispatched on each answer creation to get the vizId and use in Pin host event.
+    * let latestSpotterVizId = '';
+    * spotterEmbed.on(EmbedEvent.Data, (payload) => {
+    *   latestSpotterVizId = payload.data.id;
+    * });
+    *
+    * spotterEmbed.trigger(HostEvent.GetTML, {
+     *   vizId: latestSpotterVizId
      * }).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
      */
@@ -3631,7 +3752,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.
+     * @param - `vizId` refers to the Visualization ID in Spotter embed and is required in Spotter embed.
      * @example
      * ```js
      * liveboardEmbed.trigger(HostEvent.Download, {vizId:
@@ -3641,9 +3762,13 @@ export enum HostEvent {
      * embed.trigger(HostEvent.Download)
      * ```
      * ```js
-     * spotterEmbed.trigger(HostEvent.Download, {
-     *     vizId:'730496d6-6903-4601-937e-2c691821af3c'
-     *  });
+     * // You can use the Data event dispatched on each answer creation to get the vizId and use in Download host event.
+     * let latestSpotterVizId = '';
+     * spotterEmbed.on(EmbedEvent.Data, (payload) => {
+     *   latestSpotterVizId = payload.data.id;
+     * });
+     *
+     * spotterEmbed.trigger(HostEvent.Download, { vizId: latestSpotterVizId });
      * ```
      * @deprecated from SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl ,9.4.1.sw
      * Use {@link DownloadAsPng}
@@ -3661,19 +3786,23 @@ export enum HostEvent {
      * vizEmbed.trigger(HostEvent.DownloadAsPng)
      *
      * searchEmbed.trigger(HostEvent.DownloadAsPng)
-     * 
-     * spotterEmbed.trigger(HostEvent.DownloadAsPng, {
-     *       vizId:"730496d6-6903-4601-937e-2c691821af3c"
-     * })
+     *
+     * // You can use the Data event dispatched on each answer creation to get the vizId and use in DownloadAsPng host event.
+     * let latestSpotterVizId = '';
+     * spotterEmbed.on(EmbedEvent.Data, (payload) => {
+     *   latestSpotterVizId = payload.data.id;
+     * });
+     *
+     * spotterEmbed.trigger(HostEvent.DownloadAsPng, { vizId: latestSpotterVizId });
      * ```
-     * 
+     *
      * @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.
+     * @param - `vizId` refers to the Visualization ID in Spotter embed and is required in Spotter embed.
      * @example
      * ```js
      * liveboardEmbed.trigger(HostEvent.DownloadAsCsv, {vizId:
@@ -3686,9 +3815,13 @@ export enum HostEvent {
      * searchEmbed.trigger(HostEvent.DownloadAsCsv)
      * ```
      * ```js
-     * spotterEmbed.trigger(HostEvent.DownloadAsCsv, {
-     *       vizId:"730496d6-6903-4601-937e-2c691821af3c"
-     * })
+     * // You can use the Data event dispatched on each answer creation to get the vizId and use in DownloadAsCsv host event.
+     * let latestSpotterVizId = '';
+     * spotterEmbed.on(EmbedEvent.Data, (payload) => {
+     *   latestSpotterVizId = payload.data.id;
+     * });
+     *
+     * spotterEmbed.trigger(HostEvent.DownloadAsCsv, { vizId: latestSpotterVizId });
      * ```
      * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
      */
@@ -3696,7 +3829,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.
+     * @param - `vizId` refers to the Visualization ID in Spotter embed and is required in Spotter embed.
      * @example
      * ```js
      * liveboardEmbed.trigger(HostEvent.DownloadAsXlsx, {vizId:
@@ -3709,9 +3842,13 @@ export enum HostEvent {
      * searchEmbed.trigger(HostEvent.DownloadAsXlsx)
      * ```
      * ```js
-     * spotterEmbed.trigger(HostEvent.downloadAsXLSX, {
-     *       vizId:"730496d6-6903-4601-937e-2c691821af3c"
-     * })
+     * // You can use the Data event dispatched on each answer creation to get the vizId and use in DownloadAsXlsx host event.
+     * let latestSpotterVizId = '';
+     * spotterEmbed.on(EmbedEvent.Data, (payload) => {
+     *   latestSpotterVizId = payload.data.id;
+     * });
+     *
+     * spotterEmbed.trigger(HostEvent.DownloadAsXlsx, { vizId: latestSpotterVizId });
      * ```
      * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
      */
@@ -3729,45 +3866,45 @@ export enum HostEvent {
      * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
      */
     Share = 'share',
-  /**
-   * Trigger the **Save** action on a Liveboard, Answer, or Spotter.
-   * Saves the changes.
-   *
-   * @param - `vizId` refers to the Spotter Visualization Id used in Spotter embed.
-   * It is required and can be retrieved from the data embed event.
-   *
-   * @example
-   * ```js
-   * // Save changes in a Liveboard
-   * liveboardEmbed.trigger(HostEvent.Save)
-   * ```
-   *
-   * ```js
-   * // Save the current Answer in Search embed
-   * searchEmbed.trigger(HostEvent.Save)
-   * ```
-   *
-   * ```js
-   * // Save an Answer in Spotter (requires vizId)
-   * spotterEmbed.trigger(HostEvent.Save, {
-   *   vizId: "730496d6-6903-4601-937e-2c691821af3c"
-   * })
-   * ```
-   *
-   * ```js
-   * // How to get the vizId in Spotter?
-   *
-   * // You can use the Data event dispatched on each answer creation to get the vizId.
-   * let latestSpotterVizId = '';
-   * spotterEmbed.on(EmbedEvent.Data, (payload) => {
-   *   latestSpotterVizId = payload.data.id;
-   * });
-   *
-   * spotterEmbed.trigger(HostEvent.Save, { vizId: latestSpotterVizId });
-   * ```
-   *
-   * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
-   */
+    /**
+     * Trigger the **Save** action on a Liveboard, Answer, or Spotter.
+     * Saves the changes.
+     *
+     * @param - `vizId` refers to the Spotter Visualization Id used in Spotter embed.
+     * It is required and can be retrieved from the data embed event.
+     *
+     * @example
+     * ```js
+     * // Save changes in a Liveboard
+     * liveboardEmbed.trigger(HostEvent.Save)
+     * ```
+     *
+     * ```js
+     * // Save the current Answer in Search embed
+     * searchEmbed.trigger(HostEvent.Save)
+     * ```
+     *
+     * ```js
+     * // Save a Visualization in Spotter (requires vizId)
+     * spotterEmbed.trigger(HostEvent.Save, {
+     *   vizId: "730496d6-6903-4601-937e-2c691821af3c"
+     * })
+     * ```
+     *
+     * ```js
+     * // How to get the vizId in Spotter?
+     *
+     * // You can use the Data event dispatched on each answer creation to get the vizId.
+     * let latestSpotterVizId = '';
+     * spotterEmbed.on(EmbedEvent.Data, (payload) => {
+     *   latestSpotterVizId = payload.data.id;
+     * });
+     *
+     * spotterEmbed.trigger(HostEvent.Save, { vizId: latestSpotterVizId });
+     * ```
+     *
+     * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
+     */
     Save = 'save',
     /**
      * Trigger the **Sync to Sheets** action on an embedded visualization or Answer
@@ -4049,15 +4186,21 @@ export enum HostEvent {
     ResetLiveboardPersonalisedView = 'ResetLiveboardPersonalisedView',
     /**
      * Triggers an action to update Parameter values on embedded
-     * Answers, Liveboard and Spotter answer in Edit mode.
+     * Answers, Liveboard, and Spotter answer in Edit mode.
+     * @param - `name` - Name of the Parameter
+     * @param - `value` - The value to set for the Parameter.
+     *
+     * Optionally, to control the visibility of the Parameter chip,
+     * use the `isVisibleToUser` attribute when applying an override.
      *
      * @example
      * ```js
      * liveboardEmbed.trigger(HostEvent.UpdateParameters, [{
-     * name: "Color",
-     * value: "almond"
+     *   name: "Integer Range Param",
+     *   value: 10,
+     *   isVisibleToUser: false
      * }])
-     *
+     * ```
      * @version SDK: 1.29.0 | ThoughtSpot: 10.1.0.cl, 10.1.0.sw
      */
     UpdateParameters = 'UpdateParameters',
@@ -4070,11 +4213,13 @@ export enum HostEvent {
      * });
      *```
      *```js
-     * spotterEmbed.trigger(HostEvent.GetParameters, {
-     *  vizId: '730496d6-6903-4601-937e-2c691821af3c'
-     * }).then((parameter) => {
-     *  console.log('parameters', parameter);
+     * // You can use the Data event dispatched on each answer creation to get the vizId and use in GetParameters host event.
+     * let latestSpotterVizId = '';
+     * spotterEmbed.on(EmbedEvent.Data, (payload) => {
+     *   latestSpotterVizId = payload.data.id;
      * });
+     *
+     * spotterEmbed.trigger(HostEvent.GetParameters, { vizId: latestSpotterVizId });
      *```
      * @version SDK: 1.29.0 | ThoughtSpot: 10.1.0.cl, 10.1.0.sw
      */
@@ -4104,10 +4249,11 @@ export enum HostEvent {
      * If no parameters are specified, the save action is
      * triggered with a modal to prompt users to
      * add a name and description for the Answer.
-     * @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.
+     * @param - `vizId` refers to the Answer ID in Spotter embed
+     * and is required in Spotter embed.
+     * Optional attributes to set Answer properties include:
+     * @param - `name` - Name string for the Answer.
+     * @param - `description` - Description text for the Answer.
      * @example
      * ```js
      * const saveAnswerResponse = await searchEmbed.trigger(HostEvent.SaveAnswer, {
@@ -4117,11 +4263,13 @@ export enum HostEvent {
      * ```
      * @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"
+     * // You can use the Data event dispatched on each answer creation to get the vizId and use in SaveAnswer host event.
+     * let latestSpotterVizId = '';
+     * spotterEmbed.on(EmbedEvent.Data, (payload) => {
+     *   latestSpotterVizId = payload.data.id;
      * });
+     *
+     * spotterEmbed.trigger(HostEvent.SaveAnswer, { vizId: latestSpotterVizId });
      * ```
      * @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
      */
@@ -4205,12 +4353,15 @@ export enum HostEvent {
     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.
+     * @param - `vizId ` refers to the Visualization ID in Spotter embed and is required.
      * @example
      * ```js
-     * spotterEmbed.trigger(HostEvent.AnswerChartSwitcher, {
-     *          vizId:'b535c760-8bbe-4e6f-bb26-af56b4129a1e'
+     * let latestSpotterVizId = '';
+     * spotterEmbed.on(EmbedEvent.Data, (payload) => {
+     *   latestSpotterVizId = payload.data.id;
      * });
+     *
+     * spotterEmbed.trigger(HostEvent.AnswerChartSwitcher, { vizId: latestSpotterVizId });
      *```
      * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
      */
@@ -4239,12 +4390,16 @@ export enum HostEvent {
      */
     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.
+     * Trigger the *Spotter* action for visualizations present on the liveboard's vizzes.
+     * @param - `vizId` refers to the Visualization ID in Spotter embed and is required.
      * @example
      * ```js
-     * spotterEmbed.trigger(HostEvent.AskSpotter,
-     * {vizId:'730496d6-6903-4601-937e-2c691821af3c'})
+     * let latestSpotterVizId = '';
+     * spotterEmbed.on(EmbedEvent.Data, (payload) => {
+     *   latestSpotterVizId = payload.data.id;
+     * });
+     *
+     * spotterEmbed.trigger(HostEvent.AskSpotter, { vizId: latestSpotterVizId });
      * ```
      * @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl
      */
@@ -4253,7 +4408,7 @@ export enum HostEvent {
     /**
      * @hidden
      * Triggers the update of the embed params.
-     * 
+     *
      * @example
      * ```js
      * liveboardEmbed.trigger(HostEvent.UpdateEmbedParams, viewConfig);
@@ -4269,13 +4424,25 @@ export enum HostEvent {
      * @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl
      */
     DestroyEmbed = 'EmbedDestroyed',
+    /** Triggers a create new conversation operation in spotter embed.
+     * @example
+     * ```js
+     * This feature is available only when chat history is enabled on your ThoughtSpot instance.
+     * Contact your admin or ThoughtSpot Support to enable chat history on your instance.
+     * @example
+     * ```js
+     * spotterEmbed.trigger(HostEvent.StartNewSpotterConversation);
+     * ```
+     * @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
+     */
+    StartNewSpotterConversation = 'StartNewSpotterConversation',
 }
 
 /**
  * The different visual modes that the data sources panel within
  * search could appear in, such as hidden, collapsed, or expanded.
  */
- 
+
 export enum DataSourceVisualMode {
     /**
      * The data source panel is hidden.
@@ -4295,7 +4462,7 @@ export enum DataSourceVisualMode {
  * The query params passed down to the embedded ThoughtSpot app
  * containing configuration and/or visual information.
  */
- 
+
 export enum Param {
     EmbedApp = 'embedApp',
     DataSources = 'dataSources',
@@ -4452,7 +4619,7 @@ export enum Param {
  * ```
  * See also link:https://developers.thoughtspot.com/docs/actions[Action IDs in the SDK]
  */
- 
+
 export enum Action {
     /**
      * The **Save** action on an Answer or Liveboard.
@@ -5786,15 +5953,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 {
@@ -5839,7 +6006,7 @@ export interface CustomAction {
     dataModelIds?: {
         modelIds?: string[];
         modelColumnNames?: string[];
-    }
+    };
     orgIds?: string[];
     groupIds?: string[];
 }
@@ -5962,4 +6129,68 @@ export interface DefaultAppInitData {
     customVariablesForThirdPartyTools: Record<string, any>;
     hiddenListColumns: ListPageColumns[];
     customActions: CustomAction[];
+    interceptTimeout: number | undefined;
+    interceptUrls: (string | InterceptedApiType)[];
+}
+
+/**
+ * Enum for the type of API intercepted
+ */
+export enum InterceptedApiType {
+    /**
+     * The apis that are use to get the data for the embed
+     */
+    AnswerData = 'AnswerData',
+    /**
+     * This will intercept all the apis
+     */
+    ALL = 'ALL',
+    /**
+     * The apis that are use to get the data for the liveboard
+     */
+    LiveboardData = 'LiveboardData',
 }
+
+export type ApiInterceptFlags = {
+    /**
+     * Flag that allows using `EmbedEvent.OnBeforeGetVizDataIntercept`.
+     *
+     * Can be used for Serach and App Embed from SDK 1.29.0
+     *
+     * @version SDK : 1.43.0 | ThoughtSpot: 10.15.0.cl
+     */
+    isOnBeforeGetVizDataInterceptEnabled?: boolean;
+    /**
+     * This allows to intercept the urls passed, once intercepted the api will only
+     * run based on the reponse from the responder of ApiIntercept event.
+     *
+     * @example
+     * ```js
+     * const embed = new LiveboardEmbed('#embed', {
+     *   ...viewConfig,
+     *   enableApiIntercept: true,
+     *   interceptUrls: [InterceptedApiType.DATA],
+     * })
+     * ```
+     *
+     * @version SDK : 1.43.0 | ThoughtSpot: 10.15.0.cl
+     */
+    interceptUrls?: (string | InterceptedApiType)[];
+    /**
+     * The timeout for the intercept, default is 30000ms
+     * the api will error out if the timeout is reached
+     *
+     * @example
+     * ```js
+     * const embed = new LiveboardEmbed('#embed', {
+     *   ...viewConfig,
+     *   enableApiIntercept: true,
+     *   interceptUrls: [InterceptedApiType.ALL],
+     *   interceptTimeout: 1000,
+     * })
+     * ```
+     *
+     * @version SDK : 1.43.0 | ThoughtSpot: 10.15.0.cl
+     */
+    interceptTimeout?: number;
+};