@thoughtspot/visual-embed-sdk 1.46.0 → 1.46.2

package/lib/src/types.js

@@ -6,7 +6,7 @@
  * @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
  */
 /**
- * The authentication mechanism for allowing access to the
+ * The authentication mechanism for allowing access to
  * the embedded app
  * @group Authentication / Init
  */
@@ -32,6 +32,7 @@ export var AuthType;
      * To use this:
      * Your SAML or OpenID provider must allow iframe redirects.
      * For example, if you are using Okta as IdP, you can enable iframe embedding.
+     * @version SDK: 1.15.0 | ThoughtSpot: 8.8.0.cl
      * @example
      * ```js
      * init({
@@ -39,18 +40,17 @@ export var AuthType;
      *   authType: AuthType.EmbeddedSSO,
      *  });
      * ```
-     * @version: SDK: 1.15.0 | ThoughtSpot: 8.8.0.cl
      */
     AuthType["EmbeddedSSO"] = "EmbeddedSSO";
     /**
-     * SSO using SAML
-     * @deprecated Use {@link SAMLRedirect} instead
+     * SSO using SAML, Use {@link SAMLRedirect} instead
+     * @deprecated This option is deprecated.
      * @hidden
      */
     AuthType["SSO"] = "SSO_SAML";
     /**
-     * SSO using SAML
-     * @deprecated Use {@link SAMLRedirect} instead
+     * SSO using SAML, Use {@link SAMLRedirect} instead
+     * @deprecated This option is deprecated.
      * @hidden
      */
     AuthType["SAML"] = "SSO_SAML";
@@ -101,8 +101,9 @@ export var AuthType;
     AuthType["SAMLRedirect"] = "SSO_SAML";
     /**
      * SSO using OIDC
+     * SSO using OIDC, Use {@link OIDCRedirect} instead
+     * @deprecated This option is deprecated.
      * @hidden
-     * @deprecated Use {@link OIDCRedirect} instead
      */
     AuthType["OIDC"] = "SSO_OIDC";
     /**
@@ -113,8 +114,9 @@ export var AuthType;
     AuthType["OIDCRedirect"] = "SSO_OIDC";
     /**
      * Trusted authentication server
+     * Use {@link TrustedAuth} instead
+     * @deprecated This option is deprecated.
      * @hidden
-     * @deprecated Use {@link TrustedAuth} instead
      */
     AuthType["AuthServer"] = "AuthServer";
     /**
@@ -141,6 +143,7 @@ export var AuthType;
      * obtained from ThoughtSpot. This uses a cookieless authentication
      * approach, recommended to bypass the third-party cookie-blocking restriction
      * implemented by some browsers.
+     * @version SDK: 1.22.0 | ThoughtSpot: 9.3.0.cl, 9.5.1.sw
      * @example
      * ```js
      * init({
@@ -151,8 +154,8 @@ export var AuthType;
      *      .then((response) => response.json())
      *      .then((data) => data.token);
      *  }
+     * });
      * ```
-     * @version SDK: 1.22.0| ThoughtSpot: 9.3.0.cl, 9.5.1.sw
      */
     AuthType["TrustedAuthTokenCookieless"] = "AuthServerCookieless";
     /**
@@ -173,43 +176,43 @@ export var HomeLeftNavItem;
     /**
      * The *Search data* option in
      * the *Insights* left navigation panel.
-     * @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
+     * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
      */
     HomeLeftNavItem["SearchData"] = "search-data";
     /**
      * The *Home* menu option in
      * the *Insights* left navigation panel.
-     * @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
+     * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
      */
     HomeLeftNavItem["Home"] = "insights-home";
     /**
      * The *Liveboards* menu option in
      * the *Insights* left navigation panel.
-     * @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
+     * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
      */
     HomeLeftNavItem["Liveboards"] = "liveboards";
     /**
      * The *Answers* menu option in
      * the *Insights* left navigation panel.
-     * @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
+     * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
      */
     HomeLeftNavItem["Answers"] = "answers";
     /**
      * The *Monitor subscriptions* menu option in
      * the *Insights* left navigation panel.
-     * @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
+     * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
      */
     HomeLeftNavItem["MonitorSubscription"] = "monitor-alerts";
     /**
      * The *SpotIQ analysis* menu option in
      * the *Insights* left navigation panel.
-     * @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
+     * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
      */
     HomeLeftNavItem["SpotIQAnalysis"] = "spotiq-analysis";
     /**
      * The *Liveboard schedules* menu option in
      * the *Insights* left navigation panel.
-     * @version SDK: 1.34.0| ThoughtSpot: 10.3.0.cl
+     * @version SDK: 1.34.0 | ThoughtSpot: 10.3.0.cl
      */
     HomeLeftNavItem["LiveboardSchedules"] = "liveboard-schedules";
     /**
@@ -315,7 +318,7 @@ export var HomepageModule;
      */
     HomepageModule["Search"] = "SEARCH";
     /**
-     * kPI watchlist module
+     * KPI watchlist module
      */
     HomepageModule["Watchlist"] = "WATCHLIST";
     /**
@@ -347,7 +350,8 @@ export var ListPageColumns;
      */
     ListPageColumns["Favorites"] = "FAVOURITE";
     /**
-     * @deprecated Use {@link ListPageColumns.Favorites} instead.
+     * Favourite Use {@link ListPageColumns.Favorites} instead.
+     * @deprecated This option is deprecated.
      */
     ListPageColumns["Favourite"] = "FAVOURITE";
     /**
@@ -415,13 +419,13 @@ export var EmbedEvent;
     /**
      * Rendering has initialized.
      * @example
-     *```js
+     * ```js
      * liveboardEmbed.on(EmbedEvent.Init, showLoader)
      *  //show a loader
      * function showLoader() {
      * document.getElementById("loader");
      * }
-     *```
+     * ```
      * @returns timestamp - The timestamp when the event was generated.
      */
     EmbedEvent["Init"] = "init";
@@ -429,11 +433,11 @@ export var EmbedEvent;
      * Authentication has either succeeded or failed.
      * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
      * @example
-     *```js
+     * ```js
      * appEmbed.on(EmbedEvent.AuthInit, payload => {
      *    console.log('AuthInit', payload);
      * })
-     *```
+     * ```
      * @returns isLoggedIn - A Boolean specifying whether authentication was successful.
      */
     EmbedEvent["AuthInit"] = "authInit";
@@ -442,13 +446,13 @@ export var EmbedEvent;
      * @returns timestamp - The timestamp when the event was generated.
      * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
      * @example
-     *```js
+     * ```js
      * liveboardEmbed.on(EmbedEvent.Load, hideLoader)
      *    //hide loader
      * function hideLoader() {
      *   document.getElementById("loader");
      * }
-     *```
+     * ```
      */
     EmbedEvent["Load"] = "load";
     /**
@@ -457,11 +461,11 @@ export var EmbedEvent;
      * @return data -  Answer of Liveboard data
      * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
      * @example
-     *```js
+     * ```js
      * liveboardEmbed.on(EmbedEvent.Data, payload => {
      *    console.log('data', payload);
      * })
-     *```
+     * ```
      * @important
      */
     EmbedEvent["Data"] = "data";
@@ -469,9 +473,9 @@ export var EmbedEvent;
      * Search query has been updated by the user.
      * @version SDK: 1.4.0 | ThoughtSpot: ts7.sep.cl, 8.4.1.sw
      * @example
-     *```js
+     * ```js
      * searchEmbed.on(EmbedEvent.QueryChanged, payload => console.log('data', payload))
-     *```
+     * ```
      */
     EmbedEvent["QueryChanged"] = "queryChanged";
     /**
@@ -481,7 +485,7 @@ export var EmbedEvent;
      * @returns drillDownColumns - The columns on which drill down was performed
      * @returns nonFilteredColumns - The columns that were not filtered
      * @example
-     *```js
+     * ```js
      * searchEmbed.on(EmbedEvent.DrillDown, {
      *    points: {
      *        clickedPoint,
@@ -489,12 +493,12 @@ export var EmbedEvent;
      *    },
      *    autoDrillDown: true,
      * })
-     *```
+     * ```
      * In this example, `VizPointDoubleClick` event is used for
      * triggering the `DrillDown` event when an area or specific
      * data point on a table or chart is double-clicked.
      * @example
-     *```js
+     * ```js
      * searchEmbed.on(EmbedEvent.VizPointDoubleClick, (payload) => {
      *   console.log(payload);
      *   const clickedPoint = payload.data.clickedPoint;
@@ -508,7 +512,7 @@ export var EmbedEvent;
      *   autoDrillDown: true,
      *     })
      * })
-     *```
+     * ```
      */
     EmbedEvent["Drilldown"] = "drillDown";
     /**
@@ -633,13 +637,13 @@ export var EmbedEvent;
      * The ThoughtSpot authentication session has expired.
      * @version SDK: 1.4.0 | ThoughtSpot: ts7.sep.cl, 8.4.1.sw
      * @example
-     *```js
+     * ```js
      * appEmbed.on(EmbedEvent.AuthExpire, showAuthExpired)
      * //show auth expired banner
      * function showAuthExpired() {
      *    document.getElementById("authExpiredBanner");
      * }
-     *```
+     * ```
      */
     EmbedEvent["AuthExpire"] = "ThoughtspotAuthExpired";
     /**
@@ -674,22 +678,22 @@ export var EmbedEvent;
      * Applicable to `SearchBarEmbed` only.
      * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
      * @example
-     *```js
+     * ```js
      * searchbarEmbed.on(EmbedEvent.GetDataClick)
      *  .then(data => {
      *  console.log('Answer Data:', data);
      * })
-     *```
+     * ```
      */
     EmbedEvent["GetDataClick"] = "getDataClick";
     /**
      * Detects the route change.
      * @version SDK: 1.7.0 | ThoughtSpot: 8.0.0.cl, 8.4.1.sw
      * @example
-     *```js
+     * ```js
      * searchEmbed.on(EmbedEvent.RouteChange, payload =>
      *    console.log('data', payload))
-     *```
+     * ```
      */
     EmbedEvent["RouteChange"] = "ROUTE_CHANGE";
     /**
@@ -699,12 +703,12 @@ export var EmbedEvent;
     EmbedEvent["V1Data"] = "exportVizDataToParent";
     /**
      * Emitted when the embed does not have cookie access. This happens
-     * when Safari and other Web browsers block third-party cookies
-     * are blocked by default. `NoCookieAccess` can trigger.
+     * when third-party cookies are blocked by Safari or other
+     * web browsers. `NoCookieAccess` can trigger.
      * @example
-     *```js
+     * ```js
      * appEmbed.on(EmbedEvent.NoCookieAccess)
-     *```
+     * ```
      * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 7.2.1.sw
      */
     EmbedEvent["NoCookieAccess"] = "noCookieAccess";
@@ -718,22 +722,22 @@ export var EmbedEvent;
      * Emitted when any modal is opened in the app
      * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
      * @example
-     *```js
+     * ```js
      * appEmbed.on(EmbedEvent.DialogOpen, payload => {
      *    console.log('dialog open', payload);
      *  })
-     *```
+     * ```
      */
     EmbedEvent["DialogOpen"] = "dialog-open";
     /**
      * Emitted when any modal is closed in the app
      * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
      * @example
-     *```js
+     * ```js
      * appEmbed.on(EmbedEvent.DialogClose, payload => {
      *     console.log('dialog close', payload);
      * })
-     *```
+     * ```
      */
     EmbedEvent["DialogClose"] = "dialog-close";
     /**
@@ -742,39 +746,39 @@ export var EmbedEvent;
      * other events on the rendered Liveboard.
      * @version SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
      * @example
-     *```js
+     * ```js
      * liveboardEmbed.on(EmbedEvent.LiveboardRendered, payload => {
            console.log('Liveboard is rendered', payload);
        })
-     *```
+     * ```
      * The following example shows how to trigger
      * `SetVisibleVizs` event using LiveboardRendered embed event:
      * @example
-     *```js
+     * ```js
      * const embedRef = useEmbedRef();
      * const onLiveboardRendered = () => {
      * embed.trigger(HostEvent.SetVisibleVizs, ['viz1', 'viz2']);
      * };
-     *```
+     * ```
      */
     EmbedEvent["LiveboardRendered"] = "PinboardRendered";
     /**
      * Emits all events.
-     * @Version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
+     * @version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
      * @example
-     *```js
+     * ```js
      * appEmbed.on(EmbedEvent.ALL, payload => {
      *  console.log('Embed Events', payload)
      * })
-     *```
+     * ```
      */
     EmbedEvent["ALL"] = "*";
     /**
      * Emitted when an Answer is saved in the app.
      * Use start:true to subscribe to when save is initiated, or end:true to subscribe to when save is completed. Default is end:true.
-     * @Version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
+     * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
      * @example
-     *```js
+     * ```js
      * //Emit when action starts
      *  searchEmbed.on(EmbedEvent.Save, payload => {
      *    console.log('Save', payload)
@@ -785,7 +789,7 @@ export var EmbedEvent;
      * searchEmbed.on(EmbedEvent.Save, payload => {
      *    console.log('Save', payload)
      * })
-     *```
+     * ```
      */
     EmbedEvent["Save"] = "save";
     /**
@@ -797,11 +801,11 @@ export var EmbedEvent;
      * `EmbedEvent.DownloadAsCSV`, or `EmbedEvent.DownloadAsXLSX`
      * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
      * @example
-     *```js
+     * ```js
      * liveboardEmbed.on(EmbedEvent.Download, {
      * vizId: '730496d6-6903-4601-937e-2c691821af3c'
      * })
-     *```
+     * ```
      */
     EmbedEvent["Download"] = "download";
     /**
@@ -809,14 +813,14 @@ export var EmbedEvent;
      *  Use start:true to subscribe to when download is initiated, or end:true to subscribe to when download is completed. Default is end:true.
      * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.4.0.sw
      * @example
-     *```js
+     * ```js
      * //emit when action starts
      * searchEmbed.on(EmbedEvent.DownloadAsPng, payload => {
      *   console.log('download PNG', payload)}, {start: true })
      * //emit when action ends
      * searchEmbed.on(EmbedEvent.DownloadAsPng, payload => {
      *   console.log('download PNG', payload)})
-     *```
+     * ```
      */
     EmbedEvent["DownloadAsPng"] = "downloadAsPng";
     /**
@@ -824,14 +828,14 @@ export var EmbedEvent;
      *  Use start:true to subscribe to when download as PDF is initiated, or end:true to subscribe to when download as PDF is completed. Default is end:true.
      * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
      * @example
-     *```js
+     * ```js
      * //emit when action starts
      * searchEmbed.on(EmbedEvent.DownloadAsPdf, payload => {
      *   console.log('download PDF', payload)}, {start: true })
      * //emit when action ends
      * searchEmbed.on(EmbedEvent.DownloadAsPdf, payload => {
      *   console.log('download PDF', payload)})
-     *```
+     * ```
      */
     EmbedEvent["DownloadAsPdf"] = "downloadAsPdf";
     /**
@@ -839,14 +843,14 @@ export var EmbedEvent;
      *  Use start:true to subscribe to when download as CSV is initiated, or end:true to subscribe to when download as CSV is completed. Default is end:true.
      * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
      * @example
-     *```js
+     * ```js
      * //emit when action starts
      * searchEmbed.on(EmbedEvent.DownloadAsCSV, payload => {
      *   console.log('download CSV', payload)}, {start: true })
      * //emit when action ends
      * searchEmbed.on(EmbedEvent.DownloadAsCSV, payload => {
      *    console.log('download CSV', payload)})
-     *```
+     * ```
      */
     EmbedEvent["DownloadAsCsv"] = "downloadAsCsv";
     /**
@@ -854,14 +858,14 @@ export var EmbedEvent;
      *  Use start:true to subscribe to when download as XLSX is initiated, or end:true to subscribe to when download as XLSX is completed. Default is end:true.
      * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
      * @example
-     *```js
+     * ```js
      * //emit when action starts
      * searchEmbed.on(EmbedEvent.DownloadAsXlsx, payload => {
      *   console.log('download Xlsx', payload)}, { start: true })
      * //emit when action ends
      * searchEmbed.on(EmbedEvent.DownloadAsXlsx, payload => {
      *   console.log('download Xlsx', payload)})
-     *```
+     * ```
      */
     EmbedEvent["DownloadAsXlsx"] = "downloadAsXlsx";
     /**
@@ -869,25 +873,25 @@ export var EmbedEvent;
      *  Use start:true to subscribe to when delete is initiated, or end:true to subscribe to when delete is completed. Default is end:true.
      * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
      * @example
-     *```js
+     * ```js
      * //emit when action starts
      * appEmbed.on(EmbedEvent.AnswerDelete, payload => {
      *    console.log('delete answer', payload)}, {start: true })
      * //trigger when action is completed
      * appEmbed.on(EmbedEvent.AnswerDelete, payload => {
      *    console.log('delete answer', payload)})
-     *```
+     * ```
      */
     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
+     * ```js
      * liveboardEmbed.on(EmbedEvent.AIHighlights, (payload) => {
      *   console.log('AI Highlights', payload);
      * })
-     *```
+     * ```
      */
     EmbedEvent["AIHighlights"] = "AIHighlights";
     /**
@@ -896,7 +900,7 @@ export var EmbedEvent;
      *  Use start:true to subscribe to when pin is initiated, or end:true to subscribe to when pin is completed. Default is end:true.
      * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
      * @example
-     *```js
+     * ```js
      * //emit when action starts
      * searchEmbed.on(EmbedEvent.Pin, payload => {
      *    console.log('pin', payload)
@@ -907,14 +911,14 @@ export var EmbedEvent;
      * searchEmbed.on(EmbedEvent.Pin, payload => {
      *    console.log('pin', payload)
      * })
-     *```
+     * ```
      */
     EmbedEvent["Pin"] = "pin";
     /**
      * Emitted when SpotIQ analysis is triggered
      * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
      * @example
-     *```js
+     * ```js
      * //emit when action starts
      * searchEmbed.on(EmbedEvent.SpotIQAnalyze, payload => {
      *   console.log('SpotIQAnalyze', payload)
@@ -925,14 +929,14 @@ export var EmbedEvent;
      * searchEmbed.on(EmbedEvent.SpotIQAnalyze, payload => {
      *   console.log('SpotIQ analyze', payload)
      * })
-     *```
+     * ```
      */
     EmbedEvent["SpotIQAnalyze"] = "spotIQAnalyze";
     /**
      * Emitted when a user shares an object with another user or group
      * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
      * @example
-     *```js
+     * ```js
      * //emit when action starts
      * searchEmbed.on(EmbedEvent.Share, payload => {
      *    console.log('Share', payload)
@@ -943,7 +947,7 @@ export var EmbedEvent;
      * searchEmbed.on(EmbedEvent.Share, payload => {
      *   console.log('Share', payload)
      * })
-     *```
+     * ```
      */
     EmbedEvent["Share"] = "share";
     /**
@@ -951,11 +955,11 @@ export var EmbedEvent;
      * data on a chart or table.
      * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
      * @example
-     *```js
+     * ```js
      * appEmbed.on(EmbedEvent.DrillInclude, payload => {
      *    console.log('Drill include', payload);
      * })
-     *```
+     * ```
      */
     EmbedEvent["DrillInclude"] = "context-menu-item-include";
     /**
@@ -963,22 +967,22 @@ export var EmbedEvent;
      * data on a chart or table
      * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
      * @example
-     *```js
+     * ```js
      * appEmbed.on(EmbedEvent.DrillExclude, payload => {
      *     console.log('Drill exclude', payload);
      * })
-     *```
+     * ```
      */
     EmbedEvent["DrillExclude"] = "context-menu-item-exclude";
     /**
      * Emitted when a column value is copied in the embedded app.
      * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
      * @example
-     *```js
-     * seachEmbed.on(EmbedEvent.CopyToClipboard, payload => {
+     * ```js
+     * searchEmbed.on(EmbedEvent.CopyToClipboard, payload => {
      *    console.log('copy to clipboard', payload);
      * })
-     *```
+     * ```
      */
     EmbedEvent["CopyToClipboard"] = "context-menu-item-copy-to-clipboard";
     /**
@@ -986,10 +990,10 @@ export var EmbedEvent;
      * embedded Liveboard.
      * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
      * @example
-     *```js
+     * ```js
      * liveboardEmbed.on(EmbedEvent.UpdateTML)
      * })
-     *```
+     * ```
      */
     EmbedEvent["UpdateTML"] = "updateTSL";
     /**
@@ -997,11 +1001,11 @@ export var EmbedEvent;
      * on an embedded Liveboard.
      * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
      * @example
-     *```js
+     * ```js
      * appEmbed.on(EmbedEvent.EditTML, payload => {
      *    console.log('Edit TML', payload);
      * })
-     *```
+     * ```
      */
     EmbedEvent["EditTML"] = "editTSL";
     /**
@@ -1010,25 +1014,25 @@ export var EmbedEvent;
      *  Use start:true to subscribe to when export is initiated, or end:true to subscribe to when export is completed. Default is end:true.
      * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
      * @example
-     *```js
+     * ```js
      * //emit when action starts
      * searchEmbed.on(EmbedEvent.ExportTML, payload => {
      *     console.log('Export TML', payload)}, { start: true })
      * //emit when action ends
      * searchEmbed.on(EmbedEvent.ExportTML, payload => {
      *     console.log('Export TML', payload)})
-     *```
+     * ```
      */
     EmbedEvent["ExportTML"] = "exportTSL";
     /**
      * Emitted when an Answer is saved as a View.
      * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
      * @example
-     *```js
+     * ```js
      * appEmbed.on(EmbedEvent.SaveAsView, payload => {
      *    console.log('View', payload);
      * })
-     *```
+     * ```
      */
     EmbedEvent["SaveAsView"] = "saveAsView";
     /**
@@ -1036,36 +1040,36 @@ export var EmbedEvent;
      *  Use start:true to subscribe to when copy and edit is initiated, or end:true to subscribe to when copy and edit is completed. Default is end:true.
      * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
      * @example
-     *```js
+     * ```js
      * //emit when action starts
      * appEmbed.on(EmbedEvent.CopyAEdit, payload => {
      *    console.log('Copy and edit', payload)}, {start: true })
      * //emit when action ends
      * appEmbed.on(EmbedEvent.CopyAEdit, payload => {
      *    console.log('Copy and edit', payload)})
-     *```
+     * ```
      */
     EmbedEvent["CopyAEdit"] = "copyAEdit";
     /**
      * Emitted when a user clicks *Show underlying data* on an Answer.
      * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
      * @example
-     *```js
+     * ```js
      * liveboardEmbed.on(EmbedEvent.ShowUnderlyingData, payload => {
      *    console.log('show data', payload);
      * })
-     *```
+     * ```
      */
     EmbedEvent["ShowUnderlyingData"] = "showUnderlyingData";
     /**
      * Emitted when an Answer is switched to a chart or table view.
      * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
      * @example
-     *```js
+     * ```js
      * searchEmbed.on(EmbedEvent.AnswerChartSwitcher, payload => {
      *    console.log('switch view', payload);
      * })
-     *```
+     * ```
      */
     EmbedEvent["AnswerChartSwitcher"] = "answerChartSwitcher";
     /**
@@ -1082,118 +1086,118 @@ export var EmbedEvent;
      * Emitted when a user clicks **Show Liveboard details** on a Liveboard
      * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
      * @example
-     *```js
+     * ```js
      * liveboardEmbed.on(EmbedEvent.LiveboardInfo, payload => {
      *    console.log('Liveboard details', payload);
      * })
-     *```
+     * ```
      */
     EmbedEvent["LiveboardInfo"] = "pinboardInfo";
     /**
      * Emitted when a user clicks on the Favorite icon on a Liveboard
      * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
      * @example
-     *```js
+     * ```js
      * liveboardEmbed.on(EmbedEvent.AddToFavorites, payload => {
      *    console.log('favorites', payload);
      * })
-     *```
+     * ```
      */
     EmbedEvent["AddToFavorites"] = "addToFavorites";
     /**
      * Emitted when a user clicks **Schedule** on a Liveboard
      * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
      * @example
-     *```js
+     * ```js
      * liveboardEmbed.on(EmbedEvent.Schedule, payload => {
-     *    console.log(`Liveboard schedule', payload);
+     *    console.log('Liveboard schedule', payload);
      * })
-     *```
+     * ```
      */
     EmbedEvent["Schedule"] = "subscription";
     /**
      * Emitted when a user clicks **Edit** on a Liveboard or visualization
      * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
      * @example
-     *```js
+     * ```js
      * liveboardEmbed.on(EmbedEvent.Edit, payload => {
-     *    console.log(`Liveboard edit', payload);
+     *    console.log('Liveboard edit', payload);
      * })
-     *```
+     * ```
      */
     EmbedEvent["Edit"] = "edit";
     /**
      * Emitted when a user clicks *Make a copy* on a Liveboard
      * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
      * @example
-     *```js
+     * ```js
      * liveboardEmbed.on(EmbedEvent.MakeACopy, payload => {
-     *    console.log(`Copy', payload);
+     *    console.log('Copy', payload);
      * })
-     *```
+     * ```
      */
     EmbedEvent["MakeACopy"] = "makeACopy";
     /**
      * Emitted when a user clicks **Present** on a Liveboard or visualization
      * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
      * @example
-     *```js
+     * ```js
      * liveboardEmbed.on(EmbedEvent.Present)
-     *```
+     * ```
      * @example
-     *```js
+     * ```js
      * liveboardEmbed.on(EmbedEvent.Present, {
      *   vizId: '730496d6-6903-4601-937e-2c691821af3c'})
      * })
-     *```
+     * ```
      */
     EmbedEvent["Present"] = "present";
     /**
      * Emitted when a user clicks **Delete** on a visualization
      * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
      * @example
-     *```js
+     * ```js
      * liveboardEmbed.on(EmbedEvent.Delete,
      *   {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
-     *```
+     * ```
      */
     EmbedEvent["Delete"] = "delete";
     /**
      * Emitted when a user clicks Manage schedules on a Liveboard
      * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
      * @example
-     *```js
+     * ```js
      * liveboardEmbed.on(EmbedEvent.SchedulesList)
-     *```
+     * ```
      */
     EmbedEvent["SchedulesList"] = "schedule-list";
     /**
      * Emitted when a user clicks **Cancel** in edit mode on a Liveboard
      * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
      * @example
-     *```js
+     * ```js
      * liveboardEmbed.on(EmbedEvent.Cancel)
-     *```
+     * ```
      */
     EmbedEvent["Cancel"] = "cancel";
     /**
      * Emitted when a user clicks **Explore** on a visualization
      * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
      * @example
-     *```js
+     * ```js
      * liveboardEmbed.on(EmbedEvent.Explore,  {
      *   vizId: '730496d6-6903-4601-937e-2c691821af3c'})
-     *```
+     * ```
      */
     EmbedEvent["Explore"] = "explore";
     /**
      * Emitted when a user clicks **Copy link** action on a visualization.
      * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
      * @example
-     *```js
+     * ```js
      * liveboardEmbed.on(EmbedEvent.CopyLink, {
      *   vizId: '730496d6-6903-4601-937e-2c691821af3c'})
-     *```
+     * ```
      */
     EmbedEvent["CopyLink"] = "embedDocument";
     /**
@@ -1201,21 +1205,21 @@ export var EmbedEvent;
      * visualization or Liveboard.
      * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
      * @example
-     *```js
+     * ```js
      * liveboardEmbed.on(EmbedEvent.CrossFilterChanged, {
      *    vizId: '730496d6-6903-4601-937e-2c691821af3c'})
-     *```
+     * ```
      */
     EmbedEvent["CrossFilterChanged"] = "cross-filter-changed";
     /**
      * Emitted when a user right clicks on a visualization (chart or table)
      * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
      * @example
-     *```js
+     * ```js
      * LiveboardEmbed.on(EmbedEvent.VizPointRightClick, payload => {
      *    console.log('VizPointClick', payload)
      * })
-     *```
+     * ```
      */
     EmbedEvent["VizPointRightClick"] = "vizPointRightClick";
     /**
@@ -1229,35 +1233,35 @@ export var EmbedEvent;
      * filter details.
      * @example
      *
-     *```js
+     * ```js
      * LiveboardEmbed.on(EmbedEvent.FilterChanged, (payload) => {
      *    console.log('payload', payload);
      * })
-     *
+     * ```
      * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl, 9.5.0.sw
      */
     EmbedEvent["FilterChanged"] = "filterChanged";
     /**
      *  Emitted when a user clicks the **Go** button to initiate
      *  a Natural Language Search query
-     * @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
+     * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
      */
     EmbedEvent["SageEmbedQuery"] = "sageEmbedQuery";
     /**
      * Emitted when a user selects a data source on the embedded
      * Natural Language Search interface.
      *
-     * @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
+     * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
      */
     EmbedEvent["SageWorksheetUpdated"] = "sageWorksheetUpdated";
     /**
      * Emitted when a user updates a connection on the **Data** page
-     * @version SDK : 1.27.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
+     * @version SDK: 1.27.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
      */
     EmbedEvent["UpdateConnection"] = "updateConnection";
     /**
      * Emitted when a user updates a connection on the **Data** page
-     * @version SDK : 1.27.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
+     * @version SDK: 1.27.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
      */
     EmbedEvent["CreateConnection"] = "createConnection";
     /**
@@ -1267,7 +1271,7 @@ export var EmbedEvent;
      * @returns viewId: string
      * @returns liveboardId: string
      * @returns isPublic: boolean
-     * @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
+     * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
      */
     EmbedEvent["UpdatePersonalisedView"] = "updatePersonalisedView";
     /**
@@ -1276,7 +1280,7 @@ export var EmbedEvent;
      * @returns viewId: string
      * @returns liveboardId: string
      * @returns isPublic: boolean
-     * @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
+     * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
      */
     EmbedEvent["SavePersonalisedView"] = "savePersonalisedView";
     /**
@@ -1285,19 +1289,19 @@ export var EmbedEvent;
      * @returns viewId: string
      * @returns liveboardId: string
      * @returns isPublic: boolean
-     * @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
+     * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
      */
     EmbedEvent["ResetLiveboard"] = "resetLiveboard";
     /**
      * Emitted when a PersonalisedView is deleted.
      * @returns views: string[]
      * @returns liveboardId: string
-     * @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
+     * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
      */
     EmbedEvent["DeletePersonalisedView"] = "deletePersonalisedView";
     /**
      * Emitted when a user creates a Worksheet.
-     * @version SDK : 1.27.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
+     * @version SDK: 1.27.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
      */
     EmbedEvent["CreateWorksheet"] = "createWorksheet";
     /**
@@ -1306,12 +1310,12 @@ export var EmbedEvent;
      * @returns viewId: string
      * @returns liveboardId: string
      * @returns isPublic: boolean
-     * @version SDK : 1.29.0 | ThoughtSpot Cloud: 9.12.0.cl
+     * @version SDK: 1.29.0 | ThoughtSpot Cloud: 9.12.0.cl
      */
     EmbedEvent["AskSageInit"] = "AskSageInit";
     /**
      * Emitted when a Liveboard or visualization is renamed.
-     * @version SDK : 1.28.0 | ThoughtSpot: 9.10.5.cl, 10.1.0.sw
+     * @version SDK: 1.28.0 | ThoughtSpot: 9.10.5.cl, 10.1.0.sw
      */
     EmbedEvent["Rename"] = "rename";
     /**
@@ -1329,14 +1333,12 @@ export var EmbedEvent;
      * - `payload`: The payload received from the embed related to the Data API call.
      * - `responder`: Contains elements that let developers define whether ThoughtSpot
      *   will run or block the search operation, and if blocked, which error message to provide.
-     *
-     * `execute` - When `execute` returns `true`, the search is run.
+     * - `execute` - When `execute` returns `true`, the search is run.
      * When `execute` returns `false`, the search is not executed.
-     *
-     * `error` - Developers can customize the user-facing error message when `execute`
+     * - `error` - Developers can customize the user-facing error message when `execute`
      * is `false` by using the `error` parameters in `responder`.
-     * `errorText` - The error message text shown to the user.
-     * @version SDK : 1.29.0 | ThoughtSpot: 10.3.0.cl
+     * - `errorText` - The error message text shown to the user.
+     * @version SDK: 1.29.0 | ThoughtSpot: 10.3.0.cl
      * @example
      *
      * This example blocks search operation and returns a custom error message:
@@ -1351,7 +1353,7 @@ export var EmbedEvent;
      *       },
      *     },
      *   });
-     * });
+     * })
      * ```
      * @example
      *
@@ -1377,7 +1379,7 @@ export var EmbedEvent;
      *       },
      *     },
      *   });
-     * });
+     * })
      * ```
      */
     EmbedEvent["OnBeforeGetVizDataIntercept"] = "onBeforeGetVizDataIntercept";
@@ -1388,8 +1390,8 @@ export var EmbedEvent;
      * liveboardEmbed.on(EmbedEvent.ParameterChanged, (payload) => {
      *     console.log('payload', payload);
      * })
-     *```
-     * @version SDK : 1.29.0 | ThoughtSpot: 10.3.0.cl
+     * ```
+     * @version SDK: 1.29.0 | ThoughtSpot: 10.3.0.cl
      */
     EmbedEvent["ParameterChanged"] = "parameterChanged";
     /**
@@ -1444,24 +1446,24 @@ export var EmbedEvent;
      * liveboardEmbed.on(EmbedEvent.CreateLiveboard, (payload) => {
      *     console.log('payload', payload);
      * })
-     *```
-     * @version SDK : 1.37.0 | ThoughtSpot: 10.8.0.cl
+     * ```
+     * @version SDK: 1.37.0 | ThoughtSpot: 10.8.0.cl
      */
     EmbedEvent["CreateLiveboard"] = "createLiveboard";
     /**
      * Emitted when a user creates a Model.
-     * @version SDK : 1.37.0 | ThoughtSpot: 10.8.0.cl
+     * @version SDK: 1.37.0 | ThoughtSpot: 10.8.0.cl
      */
     EmbedEvent["CreateModel"] = "createModel";
     /**
      * @hidden
      * Emitted when a user exits present mode.
-     * @version SDK : 1.40.0 | ThoughtSpot: 10.11.0.cl
+     * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
      */
     EmbedEvent["ExitPresentMode"] = "exitPresentMode";
     /**
      * Emitted when a user requests the full height lazy load data.
-     * @version SDK : 1.39.0 | ThoughtSpot : 10.10.0.cl
+     * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
      * @hidden
      */
     EmbedEvent["RequestVisibleEmbedCoordinates"] = "requestVisibleEmbedCoordinates";
@@ -1472,7 +1474,7 @@ export var EmbedEvent;
      * spotterEmbed.on(EmbedEvent.SpotterData, (payload) => {
      *     console.log('payload', payload);
      * })
-     *```
+     * ```
      * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
      */
     EmbedEvent["SpotterData"] = "SpotterData";
@@ -1483,7 +1485,7 @@ export var EmbedEvent;
      * spotterEmbed.on(EmbedEvent.PreviewSpotterData, (payload) => {
      *     console.log('payload', payload);
      * })
-     *```
+     * ```
      * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
      */
     EmbedEvent["PreviewSpotterData"] = "PreviewSpotterData";
@@ -1494,7 +1496,7 @@ export var EmbedEvent;
      * spotterEmbed.on(EmbedEvent.AddToCoaching, (payload) => {
      *     console.log('payload', payload);
      * })
-     *```
+     * ```
      * @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
      */
     EmbedEvent["AddToCoaching"] = "addToCoaching";
@@ -1516,7 +1518,7 @@ export var EmbedEvent;
      * spotterEmbed.on(EmbedEvent.SpotterQueryTriggered, (payload) => {
      *     console.log('payload', payload);
      * })
-     *```
+     * ```
      * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
      */
     EmbedEvent["SpotterQueryTriggered"] = "SpotterQueryTriggered";
@@ -1527,7 +1529,7 @@ export var EmbedEvent;
      * spotterEmbed.on(EmbedEvent.LastPromptEdited, (payload) => {
      *     console.log('payload', payload);
      * })
-     *```
+     * ```
      * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
      */
     EmbedEvent["LastPromptEdited"] = "LastPromptEdited";
@@ -1538,18 +1540,18 @@ export var EmbedEvent;
      * spotterEmbed.on(EmbedEvent.LastPromptDeleted, (payload) => {
      *     console.log('payload', payload);
      * })
-     *```
+     * ```
      * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
      */
     EmbedEvent["LastPromptDeleted"] = "LastPromptDeleted";
     /**
-     * Emitted when the coversation is reset in spotter embed.
+     * Emitted when the conversation 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
      */
     EmbedEvent["ResetSpotterConversation"] = "ResetSpotterConversation";
@@ -1560,7 +1562,7 @@ export var EmbedEvent;
      * spotterEmbed.on(EmbedEvent.SpotterInit, (payload) => {
      *     console.log('payload', payload);
      * })
-     *```
+     * ```
      * @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl
      */
     EmbedEvent["SpotterInit"] = "spotterInit";
@@ -1571,7 +1573,7 @@ export var EmbedEvent;
      * spotterEmbed.on(EmbedEvent.SpotterLoadComplete, (payload) => {
      *     console.log('payload', payload);
      * })
-     *```
+     * ```
      * @version SDK: 1.44.0 | ThoughtSpot: 26.2.0.cl
      */
     EmbedEvent["SpotterLoadComplete"] = "spotterLoadComplete";
@@ -1926,7 +1928,7 @@ export var HostEvent;
      * ```js
      * appEmbed.navigateToPage(-1)
      * ```
-     * @version SDK: 1.12.0 | ThoughtSpot 8.4.0.cl, 8.4.1.sw
+     * @version SDK: 1.12.0 | ThoughtSpot: 8.4.0.cl, 8.4.1.sw
      */
     HostEvent["Navigate"] = "Navigate";
     /**
@@ -2059,9 +2061,9 @@ export var HostEvent;
      * Trigger the **Show Liveboard details** action
      * on an embedded Liveboard.
      * @example
-     *```js
+     * ```js
      * liveboardEmbed.trigger(HostEvent.LiveboardInfo)
-     *```
+     * ```
      * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
      */
     HostEvent["LiveboardInfo"] = "pinboardInfo";
@@ -2189,7 +2191,7 @@ export var HostEvent;
      * appEmbed.trigger(HostEvent.Remove)
      * ```
      * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
-     * * @example
+     * @example
      * ```js
      * liveboardEmbed.trigger(HostEvent.Remove)
      * ```
@@ -2280,7 +2282,7 @@ export var HostEvent;
      * liveboardEmbed.trigger(HostEvent.CopyLink, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
      * ```
      * ```js
-     * vizEmbed.trigger((HostEvent.CopyLink)
+     * vizEmbed.trigger(HostEvent.CopyLink)
      * ```
      * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
      */
@@ -2297,7 +2299,7 @@ export var HostEvent;
      * liveboardEmbed.trigger(HostEvent.Present, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
      * ```
      * ```js
-     * vizEmbed.trigger((HostEvent.Present)
+     * vizEmbed.trigger(HostEvent.Present)
      * ```
      * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
      */
@@ -2312,23 +2314,22 @@ export var HostEvent;
      *   );
      * })
      * ```
-     * * @example
+     * @example
      * ```js
-
-    * // 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, {
+     * // You can use the Data event dispatched on each answer creation to get the vizId and use in GetTML 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
      */
@@ -2392,6 +2393,11 @@ export var HostEvent;
     /**
      * Trigger the **Download** action on charts in
      * the embedded view.
+     * Use {@link HostEvent.DownloadAsPng} instead.
+     *
+     * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
+     *
+     * @deprecated from SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl ,9.4.1.sw
      * @param - `vizId` refers to the Visualization ID in Spotter embed and is required in Spotter embed.
      * @example
      * ```js
@@ -2410,9 +2416,6 @@ export var HostEvent;
      *
      * spotterEmbed.trigger(HostEvent.Download, { vizId: latestSpotterVizId });
      * ```
-     * @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
      */
     HostEvent["Download"] = "downloadAsPng";
     /**
@@ -2850,8 +2853,8 @@ export var HostEvent;
      * liveboardEmbed.trigger(HostEvent.GetParameters).then((parameter) => {
      *  console.log('parameters', parameter);
      * });
-     *```
-     *```js
+     * ```
+     * ```js
      * // 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) => {
@@ -2859,7 +2862,7 @@ export var HostEvent;
      * });
      *
      * spotterEmbed.trigger(HostEvent.GetParameters, { vizId: latestSpotterVizId });
-     *```
+     * ```
      * @version SDK: 1.29.0 | ThoughtSpot: 10.1.0.cl, 10.1.0.sw
      */
     HostEvent["GetParameters"] = "GetParameters";
@@ -2876,7 +2879,7 @@ export var HostEvent;
      * Notify when info call is completed successfully
      * ```js
      * liveboardEmbed.trigger(HostEvent.InfoSuccess, data);
-     *```
+     * ```
      * @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
      */
     HostEvent["InfoSuccess"] = "InfoSuccess";
@@ -2979,7 +2982,7 @@ export var HostEvent;
      * ```js
      * spotterEmbed.trigger(HostEvent.AddToCoaching, { vizId: '730496d6-6903-4601-937e-2c691821af3c' });
      *
-     *```
+     * ```
      * @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
      */
     HostEvent["AddToCoaching"] = "addToCoaching";
@@ -3021,7 +3024,7 @@ export var HostEvent;
      * });
      *
      * spotterEmbed.trigger(HostEvent.AnswerChartSwitcher, { vizId: latestSpotterVizId });
-     *```
+     * ```
      * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
      */
     HostEvent["AnswerChartSwitcher"] = "answerChartSwitcher";
@@ -3031,7 +3034,7 @@ export var HostEvent;
      * This is automatically triggered by the SDK when fullscreen mode is exited.
      * ```js
      * liveboardEmbed.trigger(HostEvent.ExitPresentMode);
-     *```
+     * ```
      * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
      */
     HostEvent["ExitPresentMode"] = "exitPresentMode";
@@ -3181,6 +3184,7 @@ export var Param;
     // 'both' clicks in `contextMenuTrigger` configuration.
     Param["ContextMenuTrigger"] = "contextMenuEnabledOnWhichClick";
     Param["LinkOverride"] = "linkOverride";
+    Param["EnableLinkOverridesV2"] = "enableLinkOverridesV2";
     Param["blockNonEmbedFullAppAccess"] = "blockNonEmbedFullAppAccess";
     Param["ShowInsertToSlide"] = "insertInToSlide";
     Param["PrimaryNavHidden"] = "primaryNavHidden";
@@ -3275,6 +3279,7 @@ export var Param;
     Param["IsThisPeriodInDateFiltersEnabled"] = "isThisPeriodInDateFiltersEnabled";
     Param["HideToolResponseCardBranding"] = "hideToolResponseCardBranding";
     Param["ToolResponseCardBrandingLabel"] = "toolResponseCardBrandingLabel";
+    Param["EnableHomepageAnnouncement"] = "enableHomepageAnnouncement";
 })(Param || (Param = {}));
 /**
  * ThoughtSpot application pages include actions and menu commands
@@ -3434,14 +3439,14 @@ export var Action;
      * ```js
      * disabledActions: [Action.CollapseDataPanel]
      * ```
-     * @version: SDK: 1.1.0 | ThoughtSpot Cloud: ts7.may.cl, 8.4.1.sw
+     * @version SDK: 1.1.0 | ThoughtSpot Cloud: ts7.may.cl, 8.4.1.sw
      */
     Action["CollapseDataSources"] = "collapseDataSources";
     /**
      * The **Collapse data panel** icon on the Search page.
      * Collapses the data panel view.
      *
-     * @version: SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
+     * @version SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
      *
      * @example
      * ```js
@@ -3888,13 +3893,12 @@ export var Action;
      */
     Action["CreateMonitor"] = "createMonitor";
     /**
-     * @deprecated
-     * Reports errors
+     * @version SDK: 1.11.1 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
+     * @deprecated This action is deprecated. It was used for reporting errors.
      * @example
      * ```js
      * disabledActions: [Action.ReportError]
      * ```
-     * @version SDK: 1.11.1 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
      */
     Action["ReportError"] = "reportError";
     /**
@@ -3904,7 +3908,7 @@ export var Action;
      * ```js
      * disabledActions: [Action.SyncToSheets]
      * ```
-     * @version SDK: 1.18.0| ThoughtSpot: 8.10.0.cl, 9.0.1.sw
+     * @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1.sw
      */
     Action["SyncToSheets"] = "sync-to-sheets";
     /**
@@ -3915,7 +3919,7 @@ export var Action;
      * ```js
      * disabledActions: [Action.SyncToOtherApps]
      * ```
-     * @version SDK: 1.18.0| ThoughtSpot: 8.10.0.cl, 9.0.1.sw
+     * @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1.sw
      */
     Action["SyncToOtherApps"] = "sync-to-other-apps";
     /**
@@ -3925,7 +3929,7 @@ export var Action;
      * ```js
      * disabledActions: [Action.ManagePipelines]
      * ```
-     * @version SDK: 1.18.0| ThoughtSpot: 8.10.0.cl, 9.0.1.sw
+     * @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1.sw
      */
     Action["ManagePipelines"] = "manage-pipeline";
     /**
@@ -4237,7 +4241,7 @@ export var Action;
      * ```js
      * disabledActions: [Action.PersonalisedViewsDropdown]
      * ```
-     *  @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw
+     *  @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw
      */
     Action["PersonalisedViewsDropdown"] = "personalisedViewsDropdown";
     /**
@@ -4247,7 +4251,7 @@ export var Action;
      * ```js
      * disabledActions: [Action.LiveboardUsers]
      * ```
-     *  @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw
+     *  @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw
      */
     Action["LiveboardUsers"] = "liveboardUsers";
     /**
@@ -4265,7 +4269,7 @@ export var Action;
      * hiddenAction: [Action.TML] // hide all TML actions
      * disabledActions: [Action.TML] // to disable all TML actions
      * ```
-     * @version SDK : 1.28.3 | ThoughtSpot: 9.12.0.cl, 10.1.0.sw
+     * @version SDK: 1.28.3 | ThoughtSpot: 9.12.0.cl, 10.1.0.sw
      */
     Action["TML"] = "tml";
     /**
@@ -4311,7 +4315,7 @@ export var Action;
      * ```js
      * disabledActions: [Action.AddToWatchlist]
      * ```
-     * @version SDK : 1.27.9 | ThoughtSpot Cloud: 9.12.5.cl
+     * @version SDK: 1.27.9 | ThoughtSpot Cloud: 9.12.5.cl
      */
     Action["AddToWatchlist"] = "addToWatchlist";
     /**
@@ -4321,7 +4325,7 @@ export var Action;
      * ```js
      * disabledActions: [Action.RemoveFromWatchlist]
      * ```
-     * @version SDK : 1.27.9 | ThoughtSpot: 9.12.5.cl
+     * @version SDK: 1.27.9 | ThoughtSpot: 9.12.5.cl
      */
     Action["RemoveFromWatchlist"] = "removeFromWatchlist";
     /**
@@ -4332,7 +4336,7 @@ export var Action;
      * ```js
      * disabledActions: [Action.OrganiseFavourites]
      * ```
-     * @version SDK : 1.32.0 | ThoughtSpot: 10.0.0.cl
+     * @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl
      */
     Action["OrganiseFavourites"] = "organiseFavourites";
     /**
@@ -4393,7 +4397,7 @@ export var Action;
      * ```js
      * disabledActions: [Action.ManageTags]
      * ```
-     * @version SDK : 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
+     * @version SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
      */
     Action["ManageTags"] = "manageTags";
     /**
@@ -4826,18 +4830,80 @@ export var ContextMenuTriggerOptions;
  */
 export var CustomActionsPosition;
 (function (CustomActionsPosition) {
+    /**
+     * Shows the action as a primary button
+     * in the toolbar area of the embed.
+     */
     CustomActionsPosition["PRIMARY"] = "PRIMARY";
+    /**
+     * Shows the action inside the "More" menu
+     * (three-dot overflow menu).
+     */
     CustomActionsPosition["MENU"] = "MENU";
+    /**
+     * Shows the action in the right-click
+     * context menu. Only supported for
+     * {@link CustomActionTarget.VIZ},
+     * {@link CustomActionTarget.ANSWER}, and
+     * {@link CustomActionTarget.SPOTTER} targets.
+     */
     CustomActionsPosition["CONTEXTMENU"] = "CONTEXTMENU";
 })(CustomActionsPosition || (CustomActionsPosition = {}));
 /**
- * Enum options to mention the target of the custom action.
+ * Enum options to mention the target of the code-based custom action.
+ * The target determines which type of ThoughtSpot object the action is
+ * associated with, and also controls which positions and scoping options
+ * are available.
  */
 export var CustomActionTarget;
 (function (CustomActionTarget) {
+    /**
+     * Action applies at the Liveboard level.
+     * Supported positions:
+     * {@link CustomActionsPosition.PRIMARY},
+     * {@link CustomActionsPosition.MENU}.
+     * Can be scoped with
+     * `metadataIds.liveboardIds`,
+     * `orgIds`, and `groupIds`.
+     */
     CustomActionTarget["LIVEBOARD"] = "LIVEBOARD";
+    /**
+     * Action applies to individual
+     * visualizations (charts/tables).
+     * Supported positions:
+     * {@link CustomActionsPosition.PRIMARY},
+     * {@link CustomActionsPosition.MENU},
+     * {@link CustomActionsPosition.CONTEXTMENU}.
+     * Can be scoped with `metadataIds`
+     * (answerIds, liveboardIds, vizIds),
+     * `dataModelIds` (modelIds,
+     * modelColumnNames), `orgIds`,
+     * and `groupIds`.
+     */
     CustomActionTarget["VIZ"] = "VIZ";
+    /**
+     * Action applies to saved or unsaved
+     * Answers. Supported positions:
+     * {@link CustomActionsPosition.PRIMARY},
+     * {@link CustomActionsPosition.MENU},
+     * {@link CustomActionsPosition.CONTEXTMENU}.
+     * Can be scoped with
+     * `metadataIds.answerIds`,
+     * `dataModelIds` (modelIds,
+     * modelColumnNames), `orgIds`,
+     * and `groupIds`.
+     */
     CustomActionTarget["ANSWER"] = "ANSWER";
+    /**
+     * Action applies to Spotter
+     * (AI-powered search).
+     * Supported positions:
+     * {@link CustomActionsPosition.MENU},
+     * {@link CustomActionsPosition.CONTEXTMENU}.
+     * Can be scoped with
+     * `dataModelIds.modelIds`,
+     * `orgIds`, and `groupIds`.
+     */
     CustomActionTarget["SPOTTER"] = "SPOTTER";
 })(CustomActionTarget || (CustomActionTarget = {}));
 /**