@thoughtspot/visual-embed-sdk 1.42.3 → 1.43.1

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

@@ -697,6 +697,10 @@ export interface CustomCssVariables {
 	 * Background color of the summary header in the CCA modal.
 	 */
 	"--ts-var-cca-modal-summary-header-background"?: string;
+	/**
+	 * Width of the Spotter chat window.
+	 */
+	"--ts-var-spotter-chat-width"?: string;
 }
 export interface SessionInterface {
 	sessionId: string;
@@ -1592,7 +1596,7 @@ export interface FrameParams {
 /**
  * The common configuration object for an embedded view.
  */
-export interface BaseViewConfig {
+export interface BaseViewConfig extends ApiInterceptFlags {
 	/**
 	 * @hidden
 	 */
@@ -2145,7 +2149,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
@@ -2344,26 +2348,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
@@ -2695,7 +2700,7 @@ export declare 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
@@ -3114,6 +3119,17 @@ export declare 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.
@@ -3544,21 +3560,24 @@ export declare 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: {
@@ -3574,7 +3593,7 @@ export declare enum EmbedEvent {
 	 * ```
 	 *
 	 *```js
-	 * .on(EmbedEvent.OnBeforeGetVizDataIntercept,
+	 * embed.on(EmbedEvent.OnBeforeGetVizDataIntercept,
 	 * (payload, responder) => {
 	 * const query = payload.data.data.answer.search_query
 	 * responder({
@@ -3585,7 +3604,8 @@ export declare 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."
 	 *      }
@@ -3649,17 +3669,17 @@ export declare 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.
@@ -3755,6 +3775,17 @@ export declare 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.
@@ -3777,7 +3808,73 @@ export declare enum EmbedEvent {
 	 * ```
 	 * @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl
 	 */
-	OrgSwitched = "orgSwitched"
+	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"
 }
 /**
  * Event types that can be triggered by the host application
@@ -4063,7 +4160,7 @@ export declare 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
@@ -4115,10 +4212,16 @@ export declare 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",
@@ -4193,14 +4296,29 @@ export declare 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.
@@ -4223,9 +4341,13 @@ export declare 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
 	 */
@@ -4311,15 +4433,7 @@ export declare 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
 	 */
@@ -4368,16 +4482,23 @@ export declare 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
 	 */
@@ -4441,7 +4562,7 @@ export declare 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:
@@ -4451,9 +4572,13 @@ export declare 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}
@@ -4472,9 +4597,13 @@ export declare enum HostEvent {
 	 *
 	 * 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
@@ -4483,7 +4612,7 @@ export declare 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.
+	 * @param - `vizId` refers to the Visualization ID in Spotter embed and is required in Spotter embed.
 	 * @example
 	 * ```js
 	 * liveboardEmbed.trigger(HostEvent.DownloadAsCsv, {vizId:
@@ -4496,9 +4625,13 @@ export declare 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
 	 */
@@ -4506,7 +4639,7 @@ export declare 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:
@@ -4519,9 +4652,13 @@ export declare 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
 	 */
@@ -4558,7 +4695,7 @@ export declare enum HostEvent {
 	 * ```
 	 *
 	 * ```js
-	 * // Save an Answer in Spotter (requires vizId)
+	 * // Save a Visualization in Spotter (requires vizId)
 	 * spotterEmbed.trigger(HostEvent.Save, {
 	 *   vizId: "730496d6-6903-4601-937e-2c691821af3c"
 	 * })
@@ -4859,15 +4996,21 @@ export declare 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",
@@ -4880,11 +5023,13 @@ export declare 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
 	 */
@@ -4914,10 +5059,11 @@ export declare 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, {
@@ -4927,11 +5073,13 @@ export declare 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
 	 */
@@ -5015,12 +5163,15 @@ export declare 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
 	 */
@@ -5049,12 +5200,16 @@ export declare 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
 	 */
@@ -5077,7 +5232,19 @@ export declare enum HostEvent {
 	 * ```
 	 * @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl
 	 */
-	DestroyEmbed = "EmbedDestroyed"
+	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
@@ -6596,14 +6763,77 @@ 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 declare 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;
+};
 export declare enum UIPassthroughEvent {
 	PinAnswerToLiveboard = "addVizToPinboard",
 	SaveAnswer = "saveAnswer",
 	GetDiscoverabilityStatus = "getDiscoverabilityStatus",
 	GetAvailableUIPassthroughs = "getAvailableUiPassthroughs",
 	GetAnswerConfig = "getAnswerPageConfig",
-	GetLiveboardConfig = "getPinboardPageConfig"
+	GetLiveboardConfig = "getPinboardPageConfig",
+	GetUnsavedAnswerTML = "getUnsavedAnswerTML"
 }
 export type UIPassthroughContractBase = {
 	[UIPassthroughEvent.PinAnswerToLiveboard]: {
@@ -6658,6 +6888,15 @@ export type UIPassthroughContractBase = {
 		request: any;
 		response: any;
 	};
+	[UIPassthroughEvent.GetUnsavedAnswerTML]: {
+		request: {
+			sessionId?: string;
+			vizId?: string;
+		};
+		response: {
+			tml: string;
+		};
+	};
 };
 export type UIPassthroughRequest<T extends keyof UIPassthroughContractBase> = UIPassthroughContractBase[T]["request"];
 export type UIPassthroughResponse<T extends keyof UIPassthroughContractBase> = UIPassthroughContractBase[T]["response"];
@@ -6813,6 +7052,8 @@ declare class TsEmbed {
 	 * work regardless of auth status
 	 */
 	private subscribeToNetworkEvents;
+	private handleApiInterceptEvent;
+	private messageEventListener;
 	/**
 	 * Subscribe to message events that depend on successful iframe setup
 	 */
@@ -6899,6 +7140,14 @@ declare class TsEmbed {
 	 * @param height The height in pixels
 	 */
 	protected setIFrameHeight(height: number | string): void;
+	/**
+	 * We can process the customer given payload before sending it to the embed port
+	 * Embed event handler -> responder -> createEmbedEventResponder -> send response
+	 * @param eventPort The event port for a specific MessageChannel
+	 * @param eventType The event type
+	 * @returns
+	 */
+	protected createEmbedEventResponder: (eventPort: MessagePort | void, eventType: EmbedEvent) => (payload: any) => void;
 	/**
 	 * Executes all registered event handlers for a particular event type
 	 * @param eventType The event type
@@ -7619,11 +7868,6 @@ export interface AppViewConfig extends AllEmbedViewConfig {
 	 * ```
 	 */
 	dataPanelCustomGroupsAccordionInitialState?: DataPanelCustomColumnGroupsAccordionState;
-	/**
-	 * Flag that allows using `EmbedEvent.OnBeforeGetVizDataIntercept`.
-	 * @version SDK : 1.29.0 | ThoughtSpot: 10.1.0.cl
-	 */
-	isOnBeforeGetVizDataInterceptEnabled?: boolean;
 	/**
 	 * Flag to use home page search bar mode
 	 *
@@ -8712,13 +8956,6 @@ export interface SearchViewConfig extends SearchLiveboardCommonViewConfig, Omit<
 	 * @deprecated Use {@link collapseSearchBar} instead
 	 */
 	collapseSearchBarInitially?: boolean;
-	/**
-	 * Flag to enable onBeforeSearchExecute Embed Event
-	 *
-	 * Supported embed types: `SearchEmbed`
-	 * @version: SDK: 1.29.0 | ThoughtSpot: 10.1.0.cl
-	 */
-	isOnBeforeGetVizDataInterceptEnabled?: boolean;
 	/**
 	 * This controls the initial behaviour of custom column groups accordion.
 	 * It takes DataPanelCustomColumnGroupsAccordionState enum values as input.
@@ -9080,7 +9317,7 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
 	 *
 	 * 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
@@ -9195,7 +9432,7 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
 	 *    enablePastConversationsSidebar : true,
 	 * })
 	 * ```
-	 * @version SDK: 1.43.0 | ThoughtSpot: 10.14.0.cl
+	 * @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
 	 */
 	enablePastConversationsSidebar?: boolean;
 }