@thoughtspot/visual-embed-sdk 1.29.1 → 1.30.0-alpha.1

package/cjs/src/types.d.ts

@@ -2,6 +2,7 @@
  * Copyright (c) 2023
  *
  * TypeScript type definitions for ThoughtSpot Visual Embed SDK
+ *
  * @summary Type definitions for Embed SDK
  * @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
  */
@@ -10,12 +11,14 @@ import type { SessionInterface } from './utils/graphql/answerService/answerServi
 /**
  * The authentication mechanism for allowing access to the
  * the embedded app
+ *
  * @group Authentication / Init
  */
 export declare enum AuthType {
     /**
      * No authentication on the SDK. Passthrough to the embedded App. Alias for
      * `Passthrough`.
+     *
      * @example
      * ```js
      * init({
@@ -33,6 +36,7 @@ export declare enum 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.
+     *
      * @example
      * ```js
      * init({
@@ -45,12 +49,14 @@ export declare enum AuthType {
     EmbeddedSSO = "EmbeddedSSO",
     /**
      * SSO using SAML
+     *
      * @deprecated Use {@link SAMLRedirect} instead
      * @hidden
      */
     SSO = "SSO_SAML",
     /**
      * SSO using SAML
+     *
      * @deprecated Use {@link SAMLRedirect} instead
      * @hidden
      */
@@ -62,6 +68,7 @@ export declare enum AuthType {
      *
      * This redirects the host application to the SAML IdP. The host application
      * will be redirected back to the ThoughtSpot app after authentication.
+     *
      * @example
      * ```js
      * init({
@@ -102,6 +109,7 @@ export declare enum AuthType {
     SAMLRedirect = "SSO_SAML",
     /**
      * SSO using OIDC
+     *
      * @hidden
      * @deprecated Use {@link OIDCRedirect} instead
      */
@@ -114,6 +122,7 @@ export declare enum AuthType {
     OIDCRedirect = "SSO_OIDC",
     /**
      * Trusted authentication server
+     *
      * @hidden
      * @deprecated Use {@link TrustedAuth} instead
      */
@@ -122,6 +131,7 @@ export declare enum AuthType {
      * Trusted authentication server. Use your own authentication server
      * which returns a bearer token, generated using the `secret_key` obtained
      * from ThoughtSpot.
+     *
      * @example
      * ```js
      * init({
@@ -133,7 +143,6 @@ export declare enum AuthType {
      *      .then((data) => data.token);
      *  }
      * });
-     * });
      * ```
      */
     TrustedAuthToken = "AuthServer",
@@ -143,6 +152,7 @@ export declare enum AuthType {
      * obtained from ThoughtSpot. This uses a cookieless authentication
      * approach, recommended to bypass the third-party cookie-blocking restriction
      * implemented by some browsers.
+     *
      * @example
      * ```js
      * init({
@@ -215,6 +225,7 @@ export interface customCssInterface {
     /**
      * Can be used to define a custom font face
      * like:
+     *
      * @example
      * ```js
      * rules_UNSTABLE?: {
@@ -254,6 +265,7 @@ export interface CustomStyles {
  * Thoughtspot components.
  * You can customize styles, text strings, and icons.
  * For more information, see https://developers.thoughtspot.com/docs/custom-css.
+ *
  * @example
  * ```js
  *  init({
@@ -296,6 +308,7 @@ export interface CustomisationsInterface {
  * It includes the ThoughtSpot hostname or IP address,
  * the type of authentication, and the authentication endpoint
  * if a trusted authentication server is used.
+ *
  * @group Authentication / Init
  */
 export interface EmbedConfig {
@@ -343,6 +356,7 @@ export interface EmbedConfig {
      * [SSO] For SSO Authentication, if `noRedirect` is set to true, it will
      * open the SAML auth flow in a popup, instead of redirecting the browser in
      * place.
+     *
      * @default false
      * @deprecated
      */
@@ -353,6 +367,7 @@ export interface EmbedConfig {
      *
      * Need to use this with `authTriggerContainer`. Or manually trigger
      * the `AuthEvent.TRIGGER_SSO_POPUP` event on a user interaction.
+     *
      * @default false
      * @version SDK: 1.18.0
      */
@@ -363,6 +378,7 @@ export interface EmbedConfig {
      * terminated.
      *
      * Eg: "/dashboard", "#/foo" [Do not include the host]
+     *
      * @version SDK: 1.10.2 | ThoughtSpot 8.2.0.cl, 8.4.1.sw
      */
     redirectPath?: string;
@@ -372,6 +388,7 @@ export interface EmbedConfig {
      * Boolean to define if the query parameters in the ThoughtSpot URL
      * should be encoded in base64. This provides additional security to
      * Thoughtspot clusters against cross-site scripting attacks.
+     *
      * @default false
      */
     shouldEncodeUrlQueryParams?: boolean;
@@ -381,6 +398,7 @@ export interface EmbedConfig {
      * some web browsers like Safari. If you set this attribute to `true`,
      * you are encouraged to handle `noCookieAccess` event, to show your own treatment
      * in this case.
+     *
      * @default false
      */
     suppressNoCookieAccessAlert?: boolean;
@@ -388,12 +406,14 @@ export interface EmbedConfig {
      * Ignore the cookie access alert when third-party cookies are blocked by the
      * user's browser. If you set this to `true`, the embedded iframe behaviour
      * persists even in the case of a non-logged-in user.
+     *
      * @default false
      */
     ignoreNoCookieAccess?: boolean;
     /**
      * Re-login a user with the previous login options
      * when a user session expires.
+     *
      * @default false
      */
     autoLogin?: boolean;
@@ -402,17 +422,20 @@ export interface EmbedConfig {
      * This flag is typically used alongside the combination of authentication modes such
      * as {@link AuthType.AuthServer} and auto-login behavior {@link
      * EmbedConfig.autoLogin}
+     *
      * @version SDK: 1.9.3 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
      * @default false
      */
     disableLoginRedirect?: boolean;
     /**
      * This message is displayed in the embedded view when a user login fails.
+     *
      * @version SDK: 1.10.1 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
      */
     loginFailedMessage?: string;
     /**
      * Calls the prefetch method internally when set to `true`
+     *
      * @default false
      */
     callPrefetch?: boolean;
@@ -420,6 +443,7 @@ export interface EmbedConfig {
      * When there are multiple objects embedded, queue the rendering of embedded objects
      * to start after the previous embed's render is complete. This helps improve
      * performance by decreasing the load on the browser.
+     *
      *  @Version SDK: 1.5.0 | ThoughtSpot: ts7.oct.cl, 7.2.1
      * @default false
      */
@@ -427,6 +451,7 @@ export interface EmbedConfig {
     /**
      * Dynamic CSS URL to be injected in the loaded application.
      * You would also need to set `style-src` in the CSP settings.
+     *
      * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
      * @default ''
      */
@@ -438,11 +463,13 @@ export interface EmbedConfig {
      *
      * This is slightly slower than letting the browser handle the cookie check, as it
      * involves an extra network call.
+     *
      * @version SDK: 1.10.4 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
      */
     detectCookieAccessSlow?: boolean;
     /**
      * Hide the `beta` alert warning message for SearchEmbed.
+     *
      * @version SDK: 1.12.0 | ThoughtSpot: 8.4.0.cl, 8.4.1.sw*
      */
     suppressSearchEmbedBetaWarning?: boolean;
@@ -453,6 +480,7 @@ export interface EmbedConfig {
     suppressSageEmbedBetaWarning?: boolean;
     /**
      * Custom style params for embed Config.
+     *
      * @version SDK: 1.17.0 | ThoughtSpot: 8.9.0.cl, 9.0.1.sw
      */
     customizations?: CustomisationsInterface;
@@ -460,6 +488,7 @@ export interface EmbedConfig {
      * For `inPopup` SAMLRedirect or OIDCRedirect authentication, we need a
      * button that the user can click to trigger the flow.
      * This attribute sets a containing element for that button.
+     *
      * @example
      * ```js
      * init({
@@ -481,6 +510,7 @@ export interface EmbedConfig {
     /**
      * Text to show in the button which triggers the popup auth flow.
      * Default: `Authorize`.
+     *
      * @version SDK: 1.17.0 | ThoughtSpot: 8.9.0.cl, 9.0.1.sw
      */
     authTriggerText?: string;
@@ -488,12 +518,14 @@ export interface EmbedConfig {
      * Prevent users from accessing the full application or ThoughtSpot application pages
      * access to the embedded application users
      * outside of the iframe.
+     *
      * @default true
      * @version SDK: 1.22.0 | ThoughtSpot: 9.3.0.cl, 9.5.1.sw
      */
     blockNonEmbedFullAppAccess?: boolean;
     /**
      * Host config in case embedded app is inside TS app itself
+     *
      * @hidden
      */
     hostConfig?: {
@@ -503,17 +535,20 @@ export interface EmbedConfig {
     };
     /**
      * Pendo API key to enable Pendo tracking to your own subscription, the key
-     * is added as an additional key to the embed, as per this [doc](https://support.pendo.io/hc/en-us/articles/360032201951-Send-data-to-multiple-subscriptions).
+     * is added as an additional key to the embed, as per this link:https://support.pendo.io/hc/en-us/articles/360032201951-Send-data-to-multiple-subscriptions[document].
+     *
      * @version SDK: 1.27.0 | ThoughtSpot: 9.8.0.cl
      */
     pendoTrackingKey?: string;
     /**
      * If passed as true all alerts will be suppressed in the embedded app.
+     *
      * @version SDK: 1.26.2 | ThoughtSpot: *
      */
     suppressErrorAlerts?: boolean;
     /**
      * Log level for the SDK.
+     *
      * @default LogLevel.ERROR
      * @example
      * ```js
@@ -527,28 +562,34 @@ export interface EmbedConfig {
     logLevel?: LogLevel;
     /**
      * Disables the Mixpanel tracking from the SDK.
+     *
      * @version SDK: 1.27.9
      */
     disableSDKTracking?: boolean;
     /**
      * Overrides default/user preffered locale for date formatting
+     *
      * @version SDK: 1.28.4 | Thoughtspot: 10.0.0.cl, 9.5.0.sw
      */
     dateFormatLocale?: string;
     /**
      * Overrides default/user preffered locale for number formatting
+     *
      * @version SDK: 1.28.4 | Thoughtspot: 10.0.0.cl, 9.5.0.sw
      */
     numberFormatLocale?: string;
     /**
      * Format to be used for currency when currency format is set to infer from browser
+     *
      * @version SDK: 1.28.4 | Thoughtspot: 10.0.0.cl, 9.5.0.sw
      */
     currencyFormat?: string;
     /**
      * This flag is used to disable the token verification in the SDK.
      * Enabling this flag will also disable the caching of the token.
+     *
      * @hidden
+     *
      * @example
      * ```js
      * init({
@@ -556,6 +597,7 @@ export interface EmbedConfig {
      *   disableTokenVerification : true
      * })
      * ```
+     *
      * @version SDK: 1.28.5 | Thoughtspot: *
      */
     disableTokenVerification?: boolean;
@@ -564,6 +606,7 @@ export interface LayoutConfig {
 }
 /**
  * Embedded iframe configuration
+ *
  * @group Embed components
  */
 export interface FrameParams {
@@ -598,7 +641,9 @@ export interface ViewConfig {
     /**
      * The width and height dimensions to render an embedded
      * object inside your app.  Specify the values in pixels or percentage.
+     *
      * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 7.2.1
+     *
      * @example
      * ```js
      * const embed = new LiveboardEmbed('#embed', {
@@ -624,6 +669,7 @@ export interface ViewConfig {
      * (...), and the contextual menu. These actions will be disabled
      * for the user.
      * Use this to disable actions.
+     *
      * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
      * @example
      * ```js
@@ -651,7 +697,9 @@ export interface ViewConfig {
      * The list of actions to hide from the embedded.
      * This actions will be hidden from the user.
      * Use this to hide an action.
+     *
      * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
+     *
      * @example
      * ```js
      * const embed = new LiveboardEmbed('#embed', {
@@ -669,8 +717,10 @@ export interface ViewConfig {
      * Use this to hide all actions except the ones you want to show.
      *
      * Use either this or hiddenActions.
+     *
      * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
      * @important
+     *
      * @example
      * ```js
      * const embed = new LiveboardEmbed('#embed', {
@@ -682,7 +732,9 @@ export interface ViewConfig {
     visibleActions?: Action[];
     /**
      * Show alert messages and toast messages in the embedded view.
+     *
      * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
+     *
      * @example
      * ```js
      * const embed = new LiveboardEmbed('#embed-container', {
@@ -695,7 +747,9 @@ export interface ViewConfig {
     /**
      * The list of runtime filters to apply to a search answer,
      * visualization, or Liveboard.
+     *
      * @version SDK: 1.9.4 | ThoughtSpot 8.1.0.cl, 8.4.1.sw
+     *
      * @example
      * ```js
      * const embed = new LiveboardEmbed('#embed-container', {
@@ -714,7 +768,9 @@ export interface ViewConfig {
     /**
      * The list of parameter override to apply to a search answer,
      * visualization, or Liveboard.
+     *
      * @version SDK : 1.25.0 | Thoughtspot: 9.2.0.cl, 9.5.0.sw
+     *
      * @example
      * ```js
      * const embed = new LiveboardEmbed('#embed-container', {
@@ -731,6 +787,7 @@ export interface ViewConfig {
     runtimeParameters?: RuntimeParameter[];
     /**
      * The locale/language to use for the embedded view.
+     *
      * @version SDK: 1.9.4 | ThoughtSpot 8.1.0.cl, 8.4.1.sw
      * @example
      * ```js
@@ -766,6 +823,7 @@ export interface ViewConfig {
     /**
      * Dynamic CSSUrl and customCSS to be injected in the loaded application.
      * You would also need to set `style-src` in the CSP settings.
+     *
      * @version SDK: 1.17.2 | ThoughtSpot: 8.4.1.sw, 8.4.0.cl
      * @default ''
      */
@@ -773,7 +831,9 @@ export interface ViewConfig {
     /**
      * Insert as a sibling of the target container, instead of appending to a
      * child inside it.
+     *
      * @version SDK: 1.2.0 | Thoughtspot: 9.0.0.cl, 9.0.0.sw
+     *
      * @example
      * ```js
      * const embed = new LiveboardEmbed('#embed-container', {
@@ -785,6 +845,7 @@ export interface ViewConfig {
     insertAsSibling?: boolean;
     /**
      * flag to set ContextMenu Trigger to either left or right click.
+     *
      * @example
      * ```js
      * const embed = new LiveboardEmbed('#tsEmbed', {
@@ -797,6 +858,7 @@ export interface ViewConfig {
     contextMenuTrigger?: ContextMenuTriggerOptions;
     /**
      * Flag to override openNew tab context menu link
+     *
      * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
      * @example
      * ```js
@@ -809,6 +871,7 @@ export interface ViewConfig {
     linkOverride?: boolean;
     /**
      * flag to enable insert into slides action
+     *
      * @hidden
      * @private
      */
@@ -816,6 +879,7 @@ export interface ViewConfig {
     /**
      * Use a pre-rendered iframe from a pool of pre-rendered iframes
      * if available and matches the configuration.
+     *
      * @version SDK: 1.22.0
      * @hidden
      *
@@ -829,6 +893,7 @@ export interface ViewConfig {
      *
      * Irrespective of this flag, runtime filters ( if passed ) will be applied to the
      * embedded view.
+     *
      * @default false
      * @version SDK: 1.24.0 | ThoughtSpot: 9.5.0.cl
      */
@@ -837,6 +902,7 @@ export interface ViewConfig {
      * The list of tab IDs to hide from the embedded.
      * This Tabs will be hidden from their respective LBs.
      * Use this to hide an tabID.
+     *
      * @example
      * ```js
      * const embed = new LiveboardEmbed('#embed', {
@@ -853,11 +919,10 @@ export interface ViewConfig {
      * Hide the home page modules
      * For example: hiddenHomepageModules = [HomepageModule.MyLibrary]
      *
-     *
-     *
      * **Note**: This option does not apply to the classic homepage.
      * To access the updated modular homepage, set
      * `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
+     *
      * @version SDK: 1.28.0 | Thoughtspot: 9.12.5.cl
      * @example
      * ```js
@@ -866,17 +931,19 @@ export interface ViewConfig {
      *    hiddenHomepageModules : [HomepageModule.Favorite,HomepageModule.Learning],
      * })
      * ```
+     *
      */
     hiddenHomepageModules?: HomepageModule[];
     /**
      * reordering the home page modules
      * eg: reorderedHomepageModules = [HomepageModule.MyLibrary, HomepageModule.Watchlist]
      *
-     *
      * **Note**: This option does not apply to the classic homepage.
      * To access the updated modular homepage, set
      * `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
+     *
      * @version SDK: 1.28.0| Thoughtspot: 9.12.5.cl
+     *
      * @example
      * ```js
      * const embed = new AppEmbed('#tsEmbed', {
@@ -891,7 +958,9 @@ export interface ViewConfig {
      * Only the tabs specified in the array will be shown in the Liveboard.
      *
      * Use either `visibleTabs` or `hiddenTabs`.
+     *
      * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
+     *
      * @example
      * ```js
      * const embed = new LiveboardEmbed('#embed-container', {
@@ -908,7 +977,8 @@ export interface ViewConfig {
      * homepageLeftNavItems : Show or hide the left navigation bar items.
      * There are 8 eight home navigation list items.
      * To hide these items, specify the string in the array.
-     * @example
+     *
+     * * @example
      * ```js
      * const embed = new AppEmbed('#tsEmbed', {
      *    ... // other options
@@ -916,11 +986,10 @@ export interface ViewConfig {
      * })
      * ```
      *
-     *
-     *
      * **Note**: This option does not apply to the classic homepage.
      * To access the updated modular homepage, set
      * `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
+     *
      * @version SDK: 1.28.0 | Thoughtspot: 9.12.5.cl
      */
     hiddenHomeLeftNavItems?: HomeLeftNavItem[];
@@ -928,6 +997,7 @@ export interface ViewConfig {
      * PreRender id to be used for PreRendering the embed.
      * Use PreRender to render the embed in the background and then
      * show or hide the rendered embed using showPreRender or hidePreRender respectively.
+     *
      * @example
      * ```js
      * const embed = new LiveboardEmbed('#embed', {
@@ -944,9 +1014,11 @@ export interface ViewConfig {
      * of its embedding element and adjust its own size accordingly.
      * Enabling this option allows the PreRender component to automatically adapt
      * its dimensions based on changes to the size of the embedding element.
+     *
      * @type {boolean}
      * @default false
      * @version SDK: 1.24.0 | ThoughtSpot:9.4.0.cl, 9.4.0.sw
+     *
      * @example
      * ```js
      * // Disable tracking PreRender size in the configuration
@@ -961,6 +1033,7 @@ export interface ViewConfig {
     doNotTrackPreRenderSize?: boolean;
     /**
      * For internal tracking of the embed component type.
+     *
      * @hidden
      */
     embedComponentType?: string;
@@ -970,6 +1043,7 @@ export interface ViewConfig {
      *
      * Irrespective of this flag, runtime filters ( if passed ) will be applied to the
      * embedded view.
+     *
      * @default false
      * @version SDK: 1.29.0 | ThoughtSpot: 10.1.0.cl
      */
@@ -977,6 +1051,7 @@ export interface ViewConfig {
 }
 /**
  * MessagePayload: Embed event payload: message type, data and status (start/end)
+ *
  * @group Events
  */
 export type MessagePayload = {
@@ -987,6 +1062,7 @@ export type MessagePayload = {
 /**
  * MessageOptions: By providing options, getting specific event start / end based on
  * option
+ *
  * @group Events
  */
 export type MessageOptions = {
@@ -998,6 +1074,7 @@ export type MessageOptions = {
 };
 /**
  * MessageCallback: Embed event message callback
+ *
  * @group Events
  */
 export type MessageCallback = (payload: MessagePayload, 
@@ -1080,13 +1157,18 @@ export declare enum RuntimeFilterOp {
     /**
      * Is included in this list of values
      */
-    IN = "IN"
+    IN = "IN",
+    /**
+     * Is not included in this list of values
+     */
+    NOT_IN = "NOT_IN"
 }
 /**
  * Home page module that can be hidden.
  * **Note**: This option does not apply to the classic homepage.
  * To access the updated modular homepage, set
  * `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
+ *
  * @version SDK: 1.28.0 | Thoughtspot: 9.12.5.cl
  */
 export declare enum HomepageModule {
@@ -1154,6 +1236,7 @@ export interface RuntimeParameter {
  *
  * To add an event listener use the corresponding
  * {@link LiveboardEmbed.on} or {@link AppEmbed.on} or {@link SearchEmbed.on} method.
+ *
  *  @example
  * ```js
  * import { EmbedEvent } from '@thoughtspot/visual-embed-sdk';
@@ -1171,6 +1254,7 @@ export interface RuntimeParameter {
 export declare enum EmbedEvent {
     /**
      * Rendering has initialized.
+     *
      * @example
      *```js
      * liveboardEmbed.on(EmbedEvent.Init, showLoader)
@@ -1184,7 +1268,9 @@ export declare enum EmbedEvent {
     Init = "init",
     /**
      * Authentication has either succeeded or failed.
+     *
      * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
+     *
      * @example
      *```js
      * appEmbed.on(EmbedEvent.AuthInit, payload => {
@@ -1196,7 +1282,9 @@ export declare enum EmbedEvent {
     AuthInit = "authInit",
     /**
      * The embed object container has loaded.
+     *
      * @returns timestamp - The timestamp when the event was generated.
+     *
      * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
      * @example
      *```js
@@ -1210,7 +1298,9 @@ export declare enum EmbedEvent {
     Load = "load",
     /**
      * Data pertaining to answer or Liveboard is received
+     *
      * @return data - The answer or Liveboard data
+     *
      * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
      * @example
      *```js
@@ -1223,11 +1313,13 @@ export declare enum EmbedEvent {
     Data = "data",
     /**
      * Search/Answer/Liveboard filters have been applied/updated by the user.
+     *
      * @hidden
      */
     FiltersChanged = "filtersChanged",
     /**
      * Search query has been updated by the user.
+     *
      * @version SDK: 1.4.0 | ThoughtSpot: ts7.sep.cl, 8.4.1.sw
      * @example
      *```js
@@ -1237,7 +1329,9 @@ export declare enum EmbedEvent {
     QueryChanged = "queryChanged",
     /**
      * A drill-down operation has been performed.
+     *
      * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
+     *
      * @returns additionalFilters - Any additional filters applied
      * @returns drillDownColumns - The columns on which drill down was performed
      * @returns nonFilteredColumns - The columns that were not filtered
@@ -1274,7 +1368,9 @@ export declare enum EmbedEvent {
     Drilldown = "drillDown",
     /**
      * One or more data sources have been selected.
+     *
      * @returns dataSourceIds - the list of data sources
+     *
      * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
      * @example
      * ```js
@@ -1286,6 +1382,7 @@ export declare enum EmbedEvent {
     DataSourceSelected = "dataSourceSelected",
     /**
      * One or more data columns have been selected.
+     *
      * @returns columnIds - the list of columns
      * @version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
      * @example
@@ -1298,9 +1395,11 @@ export declare enum EmbedEvent {
     AddRemoveColumns = "addRemoveColumns",
     /**
      * A custom action has been triggered.
+     *
      * @returns actionId - ID of the custom action
      * @returns payload {@link CustomActionPayload} - Response payload with the
      * Answer or Liveboard data
+     *
      * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
      * @example
      * ```js
@@ -1315,6 +1414,7 @@ export declare enum EmbedEvent {
     CustomAction = "customAction",
     /**
      * Listen to double click actions on a visualization.
+     *
      * @return ContextMenuInputPoints - Data point that is double-clicked
      * @version SDK: 1.5.0 | ThoughtSpot: ts7.oct.cl, 7.2.1
      * @example
@@ -1327,6 +1427,7 @@ export declare enum EmbedEvent {
     VizPointDoubleClick = "vizPointDoubleClick",
     /**
      * Listen to clicks on a visualization in a Liveboard or Search result.
+     *
      * @return viz, clickedPoint - metadata about the point that is clicked
      * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
      * @important
@@ -1347,21 +1448,17 @@ export declare enum EmbedEvent {
     /**
      * An error has occurred. This event is fired for the following error types:
      *
-     * `API`: API call failure error.
-     *
-     * `FULLSCREEN`: Error when presenting a Liveboard or visualization in full screen
-     * mode.
-     *
-     * `SINGLE_VALUE_FILTER`: Error due to multiple values in the single value filter.
-     *
-     * `NON_EXIST_FILTER`: Error due to a non-existent filter.
+     *  `API` - API call failure error.
+     *  `FULLSCREEN` - Error when presenting a Liveboard or visualization in full screen mode.
+     *  `SINGLE_VALUE_FILTER` - Error due to multiple values in the single value filter.
+     *  `NON_EXIST_FILTER` - Error due to a non-existent filter.
+     *  `INVALID_DATE_VALUE` - Invalid date value error.
+     *  `INVALID_OPERATOR` - Use of invalid operator during filter application.
      *
-     * `INVALID_DATE_VALUE`: Invalid date value error.
+     *  For more information, see https://developers.thoughtspot.com/docs/events-app-integration#errorType
      *
-     * `INVALID_OPERATOR`: Use of invalid operator during filter application.
-     *
-     * For more information, see https://developers.thoughtspot.com/docs/events-app-integration#errorType.
      * @returns error - An error object or message
+     *
      * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
      * @example
      * ```js
@@ -1386,8 +1483,11 @@ export declare enum EmbedEvent {
     Error = "Error",
     /**
      * The embedded object has sent an alert.
+     *
      * @returns alert - An alert object
+     *
      * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
+     *
      * @example
      * ```js
      * searchEmbed.on(EmbedEvent.Alert)
@@ -1396,7 +1496,9 @@ export declare enum EmbedEvent {
     Alert = "alert",
     /**
      * The ThoughtSpot auth session has expired.
+     *
      * @version SDK: 1.4.0 | ThoughtSpot: ts7.sep.cl, 8.4.1.sw
+     *
      * @example
      *```js
      * appEmbed.on(EmbedEvent.AuthExpire, showAuthExpired)
@@ -1409,22 +1511,26 @@ export declare enum EmbedEvent {
     AuthExpire = "ThoughtspotAuthExpired",
     /**
      * ThoughtSpot failed to validate the auth session.
+     *
      * @hidden
      */
     AuthFailure = "ThoughtspotAuthFailure",
     /**
      * ThoughtSpot failed to validate the auth session.
+     *
      * @hidden
      */
     AuthLogout = "ThoughtspotAuthLogout",
     /**
      * The height of the embedded Liveboard or visualization has been computed.
+     *
      * @returns data - The height of the embedded Liveboard or visualization
      * @hidden
      */
     EmbedHeight = "EMBED_HEIGHT",
     /**
      * The center of visible iframe viewport is calculated.
+     *
      * @returns data - The center of the visible Iframe viewport.
      * @hidden
      */
@@ -1432,6 +1538,7 @@ export declare enum EmbedEvent {
     /**
      * Emitted when the **Get Data** action is initiated.
      * Applicable to `SearchBarEmbed` only.
+     *
      * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
      * @example
      *```js
@@ -1444,6 +1551,7 @@ export declare enum EmbedEvent {
     GetDataClick = "getDataClick",
     /**
      * Detects the route change.
+     *
      * @version SDK: 1.7.0 | ThoughtSpot: 8.0.0.cl, 8.4.1.sw
      * @example
      *```js
@@ -1454,13 +1562,15 @@ export declare enum EmbedEvent {
     RouteChange = "ROUTE_CHANGE",
     /**
      * The v1 event type for Data
+     *
      * @hidden
      */
     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.
+     * are blocked by default. `NoCookieAccess` can trigger
+     *
      * @example
      *```js
      * appEmbed.on(EmbedEvent.NoCookieAccess)
@@ -1470,12 +1580,14 @@ export declare enum EmbedEvent {
     NoCookieAccess = "noCookieAccess",
     /**
      * Emitted when SAML is complete
+     *
      * @private
      * @hidden
      */
     SAMLComplete = "samlComplete",
     /**
      * Emitted when any modal is opened in the app
+     *
      * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
      * @example
      *```js
@@ -1487,6 +1599,7 @@ export declare enum 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
@@ -1499,7 +1612,8 @@ export declare enum EmbedEvent {
     /**
      * Emitted when the Liveboard shell loads.
      * You can use this event as a hook to trigger
-     * actions on the rendered Liveboard.
+     * other events on the rendered Liveboard.
+     *
      * @version SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
      * @example
      *```js
@@ -1520,6 +1634,7 @@ export declare enum EmbedEvent {
     LiveboardRendered = "PinboardRendered",
     /**
      * Emits all events.
+     *
      * @Version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
      * @example
      *```js
@@ -1531,6 +1646,7 @@ export declare enum EmbedEvent {
     ALL = "*",
     /**
      * Emitted when an Answer is saved in the app
+     *
      * @Version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
      * @example
      *```js
@@ -1550,10 +1666,11 @@ export declare enum EmbedEvent {
     /**
      * Emitted when the download action is triggered on an answer
      *
-     * **Note**:  This event is deprecated in v1.21.0.
+     * **Note**: This event is deprecated in v1.21.0.
      * To fire an event when a download action is initiated on a chart or table,
      * use `EmbedEvent.DownloadAsPng`, `EmbedEvent.DownloadAsPDF`, `EmbedEvent.DownloadAsCSV`,
      * or `EmbedEvent.DownloadAsXLSX`
+     *
      * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
      * @example
      *```js
@@ -1565,6 +1682,7 @@ export declare enum EmbedEvent {
     Download = "download",
     /**
      * Emitted when the download action is triggered on an answer
+     *
      * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.4.0.sw
      * @example
      *```js
@@ -1579,6 +1697,7 @@ export declare enum EmbedEvent {
     DownloadAsPng = "downloadAsPng",
     /**
      * Emitted when the Download as PDF action is triggered on an answer
+     *
      * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
      * @example
      *```js
@@ -1593,6 +1712,7 @@ export declare enum EmbedEvent {
     DownloadAsPdf = "downloadAsPdf",
     /**
      * Emitted when the Download as CSV action is triggered on an answer
+     *
      * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
      * @example
      *```js
@@ -1607,6 +1727,7 @@ export declare enum EmbedEvent {
     DownloadAsCsv = "downloadAsCsv",
     /**
      * Emitted when the Download as XLSX action is triggered on an answer
+     *
      * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
      * @example
      *```js
@@ -1621,13 +1742,14 @@ export declare enum EmbedEvent {
     DownloadAsXlsx = "downloadAsXlsx",
     /**
      * Emitted when an Answer is deleted in the app
+     *
      * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
      * @example
      *```js
      * //emit when action starts
      * appEmbed.on(EmbedEvent.AnswerDelete, payload => {
      *    console.log('delete answer', payload)}, {start: true })
-     * //emit when action is completed
+     * //trigger when action is completed
      * appEmbed.on(EmbedEvent.AnswerDelete, payload => {
      *    console.log('delete answer', payload)})
      *```
@@ -1635,6 +1757,7 @@ export declare enum EmbedEvent {
     AnswerDelete = "answerDelete",
     /**
      * Emitted when an answer is pinned to a Liveboard
+     *
      * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
      * @example
      *```js
@@ -1653,6 +1776,7 @@ export declare enum 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
@@ -1671,6 +1795,7 @@ export declare enum 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
@@ -1690,6 +1815,7 @@ export declare enum EmbedEvent {
     /**
      * Emitted when a user clicks the **Include** action to include a specific value or
      * data on a chart or table.
+     *
      * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
      * @example
      *```js
@@ -1702,6 +1828,7 @@ export declare enum EmbedEvent {
     /**
      * Emitted when a user clicks the **Exclude** action to exclude a specific value or
      * data on a chart or table
+     *
      * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
      * @example
      *```js
@@ -1713,6 +1840,7 @@ export declare enum 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
@@ -1723,7 +1851,9 @@ export declare enum EmbedEvent {
      */
     CopyToClipboard = "context-menu-item-copy-to-clipboard",
     /**
-     * Emitted when a user clicks the **Update TML** action
+     * Emitted when a user clicks the **Update TML** action on
+     * embedded Liveboard.
+     *
      * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
      * @example
      *```js
@@ -1734,6 +1864,8 @@ export declare enum EmbedEvent {
     UpdateTML = "updateTSL",
     /**
      * Emitted when a user clicks the **Edit TML** action
+     * on an embedded Liveboard.
+     *
      * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
      * @example
      *```js
@@ -1746,6 +1878,7 @@ export declare enum EmbedEvent {
     /**
      * Emitted when the **Export TML** action is triggered on an
      * an embedded object in the app
+     *
      * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
      * @example
      *```js
@@ -1760,6 +1893,7 @@ export declare enum 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
@@ -1771,6 +1905,7 @@ export declare enum EmbedEvent {
     SaveAsView = "saveAsView",
     /**
      * Emitted when the user creates a copy of an Answer
+     *
      * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
      * @example
      *```js
@@ -1785,6 +1920,7 @@ export declare enum 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
@@ -1796,6 +1932,7 @@ export declare enum 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
@@ -1807,11 +1944,13 @@ export declare enum EmbedEvent {
     AnswerChartSwitcher = "answerChartSwitcher",
     /**
      * Internal event to communicate the initial settings back to the ThoughtSpot app
+     *
      * @hidden
      */
     APP_INIT = "appInit",
     /**
      * 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
@@ -1823,6 +1962,7 @@ export declare enum 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
@@ -1834,6 +1974,7 @@ export declare enum 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
@@ -1845,6 +1986,7 @@ export declare enum 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
@@ -1856,6 +1998,7 @@ export declare enum 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
@@ -1867,6 +2010,7 @@ export declare enum 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
@@ -1882,6 +2026,7 @@ export declare enum 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
@@ -1892,6 +2037,7 @@ export declare enum 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
@@ -1901,6 +2047,7 @@ export declare enum 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
@@ -1910,6 +2057,7 @@ export declare enum 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
@@ -1920,6 +2068,7 @@ export declare enum 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
@@ -1930,16 +2079,18 @@ export declare enum EmbedEvent {
     CopyLink = "embedDocument",
     /**
      * Emitted when a user interacts with cross filters on a visualization or Liveboard
+     *
      * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
      * @example
      *```js
-     * liveboardEmbed.on(EmbedEvent.CrossFilterChanged, {
+     * liveboardEmbed.trigger(HostEvent.CrossFilterChanged, {
      *    vizId: '730496d6-6903-4601-937e-2c691821af3c'})
      *```
      */
     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
@@ -1951,6 +2102,7 @@ export declare enum EmbedEvent {
     VizPointRightClick = "vizPointRightClick",
     /**
      * Emitted when a user clicks **Insert to slide** on a visualization
+     *
      * @hidden
      */
     InsertIntoSlide = "insertInToSlide",
@@ -1958,6 +2110,7 @@ export declare enum EmbedEvent {
      * Emitted when a user changes any filter on a Liveboard.
      * Returns filter type and name, column name and ID, and runtime
      * filter details.
+     *
      * @example
      *
      *```js
@@ -1966,38 +2119,36 @@ export declare enum EmbedEvent {
      * })
      *
      * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl, 9.5.0.sw
-     * @example
-     *
-     *```js
-     * LiveboardEmbed.on(EmbedEvent.FilterChanged, (payload) => {
-     *    console.log('payload', payload);
-     * })
-     *```
      */
     FilterChanged = "filterChanged",
     /**
      *  Emitted when a user clicks the **Go** button on the Search page
+     *
      * @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
      */
     SageEmbedQuery = "sageEmbedQuery",
     /**
      * Emitted when a user selects a data source.
+     *
      * @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
      */
     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
      */
     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
      */
     CreateConnection = "createConnection",
     /**
      * Emitted when name, status (private or public) or filter values of a
      * Personalised view is updated.
+     *
      * @returns viewName: string
      * @returns viewId: string
      * @returns liveboardId: string
@@ -2007,6 +2158,7 @@ export declare enum EmbedEvent {
     UpdatePersonalisedView = "updatePersonalisedView",
     /**
      * Emitted when a Personalised view is saved.
+     *
      * @returns viewName: string
      * @returns viewId: string
      * @returns liveboardId: string
@@ -2016,6 +2168,7 @@ export declare enum EmbedEvent {
     SavePersonalisedView = "savePersonalisedView",
     /**
      * Emitted when a Liveboard is reset.
+     *
      * @returns viewName: string
      * @returns viewId: string
      * @returns liveboardId: string
@@ -2025,6 +2178,7 @@ export declare enum 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
@@ -2032,11 +2186,13 @@ export declare enum EmbedEvent {
     DeletePersonalisedView = "deletePersonalisedView",
     /**
      * Emitted when a user creates a new worksheet
+     *
      * @version SDK : 1.27.0 | Thoughtspot: 9.8.0.cl
      */
     CreateWorksheet = "createWorksheet",
     /**
      * Emitted when Ask Sage is initialized.
+     *
      * @returns viewName: string
      * @returns viewId: string
      * @returns liveboardId: string
@@ -2046,6 +2202,7 @@ export declare enum EmbedEvent {
     AskSageInit = "AskSageInit",
     /**
      * Emitted when a LB/viz is renamed
+     *
      * @version SDK : 1.28.0 | ThoughtSpot: 9.10.5.cl
      */
     Rename = "rename",
@@ -2069,6 +2226,7 @@ export declare enum EmbedEvent {
     OnBeforeGetVizDataIntercept = "onBeforeGetVizDataIntercept",
     /**
      * Emitted when runtime parameters changes
+     *
      * @version SDK : 1.29.0 | Thoughtspot : 10.1.0.cl
      */
     ParameterChanged = "ParameterChanged"
@@ -2080,6 +2238,7 @@ export declare enum EmbedEvent {
  * To trigger an event use the corresponding
  * {@link LiveboardEmbed.trigger} or {@link AppEmbed.trigger} or {@link
  * SearchEmbed.trigger} method.
+ *
  * @example
  * ```js
  * import { HostEvent } from '@thoughtspot/visual-embed-sdk';
@@ -2100,6 +2259,7 @@ export declare enum HostEvent {
      * the search query string.
      * Supported in `AppEmbed` and `SearchEmbed` deployments.
      * Includes the following properties:
+     *
      * @param - `searchQuery` - query string with search tokens
      * @param - `dataSources` - Data source GUID to Search on
      *                        - Although an array, only a single source
@@ -2118,6 +2278,7 @@ export declare enum HostEvent {
     /**
      * Triggers a drill on certain points of the specified column
      * Includes the following properties:
+     *
      * @param - points - an object containing selectedPoints/clickedPoints
      * to drill to. For example, { selectedPoints: []}
      * @param - columnGuid - Optional. GUID of the column to drill
@@ -2167,16 +2328,19 @@ export declare enum HostEvent {
     DrillDown = "triggerDrillDown",
     /**
      * Apply filters
+     *
      * @hidden
      */
     Filter = "filter",
     /**
      * Reload the answer or visualization
+     *
      * @hidden
      */
     Reload = "reload",
     /**
      * Display specific visualizations on a Liveboard.
+     *
      * @param - An array of GUIDs of the visualization to show. The visualization IDs not passed
      *  in this parameter will be hidden.
      * @example
@@ -2190,6 +2354,7 @@ export declare enum HostEvent {
     SetVisibleVizs = "SetPinboardVisibleVizs",
     /**
      * Set a Liveboard tab as an active tab.
+     *
      * @param - tabId - string of id of Tab to show
      * @example
      * ```js
@@ -2210,16 +2375,17 @@ export declare enum HostEvent {
      * _String_. The name of the column to filter on.
      *
      * `operator`
-     * Runtime filter operator to apply. For information,
-     * see [Developer Documentation](https://developers.thoughtspot.com/docs/?pageid=runtime-filters#rtOperator).
+     *  Runtime filter operator to apply. For information,
+     *  see link:https://developers.thoughtspot.com/docs/?pageid=runtime-filters#rtOperator[Developer Documentation].
      *
      * `values`
-     * List of operands. Some operators such as EQ, LE allow a single value, whereas
-     * operators such as BW and IN accept multiple operands.
+     *  List of operands. Some operators such as EQ, LE allow a single value, whereas
+     *  operators such as BW and IN accept multiple operands.
+     *
+     *  **Note**: `HostEvent.UpdateRuntimeFilters` is not supported in
+     *  Search embedding (SearchEmbed) and Natural Language Search
+     *  embedding (SageEmbed).
      *
-     * **Note**: `HostEvent.UpdateRuntimeFilters` is not supported in
-     * Search embedding (SearchEmbed) and Natural Language Search
-     * embedding (SageEmbed).
      * @param - {@link RuntimeFilter}[] an array of {@link RuntimeFilter} Types.
      * @example
      * ```js
@@ -2235,6 +2401,7 @@ export declare enum HostEvent {
     /**
      * Navigate to a specific page in the embedded ThoughtSpot application.
      * This is the same as calling `appEmbed.navigateToPage(path, true)`
+     *
      * @param - `path` - the path to navigate to to go forward or back. The path value can
      * be a number; for example, `1`, `-1`.
      * @example
@@ -2247,6 +2414,7 @@ export declare enum HostEvent {
     /**
      * Open the filter panel for a particular column.
      * Works with Search and Liveboard embed.
+     *
      * @param - { columnId: string,
      *  name: string,
      *  type: INT64/CHAR/DATE,
@@ -2263,6 +2431,7 @@ export declare enum HostEvent {
     OpenFilter = "openFilter",
     /**
      * Add columns to the current search query.
+     *
      * @param - { columnIds: string[] }
      * @example
      * ```js
@@ -2273,6 +2442,7 @@ export declare enum HostEvent {
     AddColumns = "addColumns",
     /**
      * Remove a column from the current search query.
+     *
      * @param - { columnId: string }
      * @example
      * ```js
@@ -2287,6 +2457,7 @@ export declare enum HostEvent {
      * Liveboard filters, runtime filters applied on visualizations on a
      * Liveboard, and Liveboard layout, changes to visualizations such as
      * sorting, toggling of legends, and data drill down.
+     *
      * @example
      * ```js
      * liveboardEmbed.trigger(HostEvent.getexportrequestforcurrentpinboard).then(
@@ -2297,6 +2468,7 @@ export declare enum HostEvent {
     getExportRequestForCurrentPinboard = "getExportRequestForCurrentPinboard",
     /**
      * Trigger the **Pin** action on an embedded object
+     *
      * @param - Liveboard embed takes the `vizId` as a
      * key. Can be left undefined when embedding Search, full app, or
      * a visualization.
@@ -2313,6 +2485,7 @@ export declare enum HostEvent {
     /**
      * Trigger the **Show Liveboard details** action
      * on an embedded Liveboard.
+     *
      * @example
      *```js
      * liveboardEmbed.trigger(HostEvent.LiveboardInfo)
@@ -2322,6 +2495,7 @@ export declare enum HostEvent {
     LiveboardInfo = "pinboardInfo",
     /**
      * Trigger the **Schedule** action on an embedded Liveboard.
+     *
      * @example
      * ```js
      *  liveboardEmbed.trigger(HostEvent.Schedule)
@@ -2331,6 +2505,7 @@ export declare enum HostEvent {
     Schedule = "subscription",
     /**
      * Trigger the **Manage schedule** action on an embedded Liveboard
+     *
      * @example
      * ```js
      *  liveboardEmbed.trigger(HostEvent.ScheduleList)
@@ -2339,16 +2514,22 @@ export declare enum HostEvent {
      */
     SchedulesList = "schedule-list",
     /**
-     * Trigger the **Export TML** action on an embedded Liveboard.
+     * Trigger the **Export TML** action on an embedded Liveboard or
+     * Answer.
+     *
      * @example
      * ```js
      * liveboardEmbed.trigger(HostEvent.ExportTML)
      * ```
+     *
      * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
      */
     ExportTML = "exportTSL",
     /**
-     * Trigger the **Edit TML** action on an embedded Liveboard.
+     * Trigger the **Edit TML** action on an embedded Liveboard or
+     * saved Answers in the full application embedding.
+     *
+     *
      * @example
      * ```js
      * liveboardEmbed.trigger(HostEvent.EditTML)
@@ -2358,6 +2539,7 @@ export declare enum HostEvent {
     EditTML = "editTSL",
     /**
      * Trigger the **Update TML** action on an embedded Liveboard.
+     *
      * @example
      * ```js
      * liveboardEmbed.trigger(HostEvent.UpdateTML)
@@ -2366,7 +2548,12 @@ export declare enum HostEvent {
      */
     UpdateTML = "updateTSL",
     /**
-     * Trigger the **Download PDF** action on an embedded Liveboard.
+     * Trigger the **Download PDF** action on an embedded Liveboard,
+     * visualization or Answer.
+     *
+     * **NOTE**: The **Download** > **PDF** action is available on
+     * visualizations and Answers if the data is in tabular format.
+     *
      * @example
      * ```js
      * liveboardEmbed.trigger(HostEvent.DownloadAsPdf)
@@ -2377,6 +2564,7 @@ export declare enum HostEvent {
     /**
      * Trigger the **Make a copy** action on a Liveboard, Search, or
      * visualization page.
+     *
      * @example
      * ```js
      * liveboardEmbed.trigger(HostEvent.MakeACopy, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
@@ -2392,6 +2580,7 @@ export declare enum HostEvent {
     MakeACopy = "makeACopy",
     /**
      * Trigger the **Delete** action for a Liveboard.
+     *
      * @example
      * ```js
      * appEmbed.trigger(HostEvent.Remove)
@@ -2401,6 +2590,7 @@ export declare enum HostEvent {
     Remove = "delete",
     /**
      * Trigger the **Explore** action on a visualization.
+     *
      * @param - an object with `vizId` as a key
      * @example
      * ```js
@@ -2411,6 +2601,7 @@ export declare enum HostEvent {
     Explore = "explore",
     /**
      * Trigger the **Create alert** action on a visualization
+     *
      * @param - an object with `vizId` as a key
      * @example
      * ```js
@@ -2423,6 +2614,7 @@ export declare enum HostEvent {
     CreateMonitor = "createMonitor",
     /**
      * Trigger the **Manage alerts** action on a visualization
+     *
      * @param - an object with `vizId` as a key
      * @example
      * ```js
@@ -2434,11 +2626,14 @@ export declare enum HostEvent {
      */
     ManageMonitor = "manageMonitor",
     /**
-     * Trigger the **Edit** action on a Liveboard or visualization
+     * Trigger the **Edit** action on a Liveboard or a visualization
+     * on a Liveboard.
+     *
+     * This event is not supported in visualization embed and search embed.
+     *
      * @param - object - To trigger the action for a specific visualization
      * in Liveboard embed, pass in `vizId` as a key.
-     * Can be left undefined when embedding Search, full app, or
-     * a visualization.
+     *
      * @example
      * ```js
      * liveboardEmbed.trigger(HostEvent.Edit)
@@ -2447,14 +2642,12 @@ export declare enum HostEvent {
      * liveboardEmbed.trigger(HostEvent.Edit, {vizId:
      * '730496d6-6903-4601-937e-2c691821af3c'})
      * ```
-     * ```js
-     * vizEmbed.trigger((HostEvent.Edit)
-     * ```
      * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
      */
     Edit = "edit",
     /**
      * Trigger the **Copy link** action on a Liveboard or visualization
+     *
      * @param - object - to trigger the action for a
      * specific visualization in Liveboard embed, pass in `vizId` as a key
      * @example
@@ -2472,6 +2665,7 @@ export declare enum HostEvent {
     CopyLink = "embedDocument",
     /**
      * Trigger the **Present** action on a Liveboard or visualization
+     *
      * @param - object - to trigger the action for a specific visualization
      *  in Liveboard embed, pass in `vizId` as a key
      * @example
@@ -2489,6 +2683,7 @@ export declare enum HostEvent {
     Present = "present",
     /**
      * Get TML for the current search.
+     *
      * @example
      * ```js
      * searchEmbed.trigger(HostEvent.GetTML).then((tml) => {
@@ -2503,6 +2698,7 @@ export declare enum HostEvent {
     GetTML = "getTML",
     /**
      * Trigger the **Show underlying data** action on visualization or search
+     *
      * @param - an object with vizId as a key
      * @example
      * ```js
@@ -2522,6 +2718,7 @@ export declare enum HostEvent {
      * Trigger the **Delete** action for a visualization
      * in an embedded Liveboard, or a chart or table
      * generated from Search.
+     *
      * @param - Liveboard embed takes an object with `vizId` as a key.
      * Can be left empty if embedding Search or visualization.
      * @example
@@ -2538,6 +2735,7 @@ export declare enum HostEvent {
     /**
      * Trigger the **SpotIQ analyze** action on visualization
      * or search.
+     *
      * @param - Liveboard embed takes `vizId` as a
      * key. Can be left undefined when embedding Search or
      * visualization.
@@ -2558,6 +2756,7 @@ export declare enum HostEvent {
     /**
      * Trigger the **Download** action on charts in
      * the embedded view.
+     *
      * @example
      * ```js
      * liveboardEmbed.trigger(HostEvent.Download, {vizId:
@@ -2574,6 +2773,7 @@ export declare enum HostEvent {
     /**
      * Trigger the **Download** > **PNG** action on
      * charts in the embedded view.
+     *
      * @example
      * ```js
      * liveboardEmbed.trigger(HostEvent.DownloadAsPng,
@@ -2589,6 +2789,7 @@ export declare enum HostEvent {
     /**
      * Trigger the **Download** > **CSV**  action on tables in
      * the embedded view.
+     *
      * @example
      * ```js
      * liveboardEmbed.trigger(HostEvent.DownloadAsCsv, {vizId:
@@ -2606,6 +2807,7 @@ export declare enum HostEvent {
     /**
      * Trigger the **Download** > **XLSX**  action on tables
      * in the embedded view.
+     *
      * @example
      * ```js
      * liveboardEmbed.trigger(HostEvent.DownloadAsXlsx, {vizId:
@@ -2623,6 +2825,7 @@ export declare enum HostEvent {
     /**
      * Trigger the **Share** action on an embedded
      * Liveboard or Answer.
+     *
      * @example
      * ```js
      * liveboardEmbed.trigger(HostEvent.Share)
@@ -2636,6 +2839,7 @@ export declare enum HostEvent {
     /**
      * Trigger the **Save**  action on a Liveboard or Answer.
      * Saves the changes.
+     *
      * @example
      * ```js
      * liveboardEmbed.trigger(HostEvent.Save)
@@ -2649,6 +2853,7 @@ export declare enum HostEvent {
     /**
      * Trigger the **Sync to Sheets** action on an embedded visualization or Answer
      * Sends data from an Answer or Liveboard visualization to a Google sheet.
+     *
      * @param - an object with `vizId` as a key
      * @example
      * ```js
@@ -2665,6 +2870,7 @@ export declare enum HostEvent {
      * Trigger the **Sync to Other Apps** action on an embedded visualization or Answer
      * Sends data from an Answer or Liveboard visualization to third-party apps such
      * as Slack, Salesforce, Microsoft Teams, ServiceNow and so on.
+     *
      * @param - an object with vizId as a key
      * @example
      * ```js
@@ -2681,6 +2887,7 @@ export declare enum HostEvent {
      * Trigger the **Manage pipelines** action on an embedded
      * visualization or Answer.
      * Allows users to manage ThoughtSpot Sync pipelines.
+     *
      * @param - an object with `vizId` as a key
      * @example
      * ```js
@@ -2695,6 +2902,7 @@ export declare enum HostEvent {
     ManagePipelines = "manage-pipeline",
     /**
      * Reset search operation on the Search or Answer page.
+     *
      * @example
      * ```js
      * searchEmbed.trigger(HostEvent.ResetSearch)
@@ -2706,17 +2914,21 @@ export declare enum HostEvent {
      */
     ResetSearch = "resetSearch",
     /**
-     * Get details of the visible and runtime filters applied on Liveboard.
+     * Get details of filters applied on the Liveboard.
+     * Returns arrays containing Liveboard filter and runtime filter elements.
+     *
      * @example
      * ```js
      * const data = await liveboardEmbed.trigger(HostEvent.GetFilters);
      *     console.log('data', data);
      * ```
+     *
      * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
      */
     GetFilters = "getFilters",
     /**
      * Update one or several filters applied on a Liveboard.
+     *
      * @param - `filter`: a single filter object containing column name,
      * filter operator, and values.
      * @param - `filters`: multiple filter objects with column name, filter operator,
@@ -2728,11 +2940,12 @@ export declare enum HostEvent {
      *
      * `oper`  - Filter operator, for example, EQ, IN, CONTAINS.
      *  For information about the supported filter operators,
-     *  see [Developer Documentation](https://developers.thoughtspot.com/docs/runtime-filters#rtOperator).
+     *  see link:https://developers.thoughtspot.com/docs/runtime-filters#rtOperator[Developer Documentation].
      *
      * `values` - An array of one or several values. The value definition on the
      *  data type you choose to filter on. For a complete list of supported data types,
-     *  see [Developer Documentation](https://developers.thoughtspot.com/docs/runtime-filters#_supported_data_types).
+     *  see link:https://developers.thoughtspot.com/docs/runtime-filters#_supported_data_types[Developer Documentation].
+     *
      * @example
      * ```js
      *
@@ -2744,6 +2957,7 @@ export declare enum HostEvent {
      *        }
      *    });
      * ```
+     *
      * @example
      *
      * ```js
@@ -2765,11 +2979,13 @@ export declare enum HostEvent {
      *    }]
      * });
      * ```
+     *
      * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
      */
     UpdateFilters = "updateFilters",
     /**
      * Get tab details for the current Liveboard.
+     *
      * @example
      * ```js
      * liveboardEmbed.trigger(HostEvent.GetTabs).then((tabDetails) => {
@@ -2783,6 +2999,7 @@ export declare enum HostEvent {
     GetTabs = "getTabs",
     /**
      * Set the visible tabs on a Liveboard.
+     *
      * @param - an array of ids of tabs to show, the IDs not passed
      *          will be hidden.
      * @example
@@ -2796,6 +3013,7 @@ export declare enum HostEvent {
     SetVisibleTabs = "SetPinboardVisibleTabs",
     /**
      * Set the hidden tabs on a Liveboard.
+     *
      * @param - an array of the IDs of the tabs to hide.
      * The IDs not passed will be shown.
      * @example
@@ -2809,6 +3027,7 @@ export declare enum HostEvent {
     SetHiddenTabs = "SetPinboardHiddenTabs",
     /**
      * Updates the search query string for Natural Language Search operations.
+     *
      * @param - `queryString`: Text string in Natural Language format
      * @param - `executeSearch`: Boolean to execute search and update search query
      * @example
@@ -2823,6 +3042,7 @@ export declare enum HostEvent {
     UpdateSageQuery = "updateSageQuery",
     /**
      * Get the answer session for a Search / Visualization.
+     *
      * @example
      * ```js
      * const {session} = await embed.trigger(
@@ -2835,6 +3055,7 @@ export declare enum HostEvent {
     GetAnswerSession = "getAnswerSession",
     /**
      * Trigger Ask Sage for viz
+     *
      * @example
      * ```js
      * liveboardEmbed.trigger(HostEvent.AskSage,
@@ -2845,6 +3066,7 @@ export declare enum HostEvent {
     AskSage = "AskSage",
     /**
      * Trigger UpdateCrossFilter for Liveboard
+     *
      * @example
      * ```js
      * liveboardEmbed.trigger(HostEvent.UpdateCrossFilter, {
@@ -2860,6 +3082,7 @@ export declare enum HostEvent {
     UpdateCrossFilter = "UpdateCrossFilter",
     /**
      * Trigger ResetLiveboardPersonalisedView for Liveboard
+     *
      * @example
      * ```js
      * liveboardEmbed.trigger(HostEvent.ResetLiveboardPersonalisedView);
@@ -2869,6 +3092,7 @@ export declare enum HostEvent {
     ResetLiveboardPersonalisedView = "ResetLiveboardPersonalisedView",
     /**
      * Trigger CreateLiveboard for liveboard list page & Pin Modal
+     *
      * @example
      * ```js
      * liveboardEmbed.trigger(HostEvent.CreateLiveboard);
@@ -3009,6 +3233,7 @@ export declare enum Param {
  * specific actions in the embedded view, define the Action
  * enumeration members in the `disabledActions`, `visibleActions`,
  * or `hiddenActions` array.
+ *
  * @example
  * ```js
  * const embed = new LiveboardEmbed('#embed-container', {
@@ -3032,6 +3257,7 @@ export declare enum Action {
     /**
      * The **Save** action on an Answer or Liveboard.
      * Allows users to save the changes.
+     *
      * @example
      * ```js
      * disabledActions: [Action.Save]
@@ -3048,7 +3274,9 @@ export declare enum Action {
     SaveUntitled = "saveUntitled",
     /**
      * The **Save as View** action on the Answer
-     * page. Saves an Answer as a View object.
+     * page. Saves an Answer as a View object in the full
+     * application embedding mode.
+     *
      * @example
      * ```js
      * disabledActions: [Action.SaveAsView]
@@ -3062,6 +3290,7 @@ export declare enum Action {
      * visualizations in the embedded Liveboard view.
      * In AppEmbed, the **Make a copy** action is available on both
      * Liveboards and visualizations.
+     *
      * @example
      * ```js
      * disabledActions: [Action.MakeACopy]
@@ -3071,6 +3300,7 @@ export declare enum Action {
     /**
      * The **Copy and Edit** action on a Liveboard.
      * This action is now replaced with `Action.MakeACopy`.
+     *
      * @example
      * ```js
      * disabledActions: [Action.EditACopy]
@@ -3080,6 +3310,7 @@ export declare enum Action {
     /**
      * The **Copy link** menu action on a Liveboard visualization.
      * Copies the visualization URL
+     *
      * @example
      * ```js
      * disabledActions: [Action.CopyLink]
@@ -3093,6 +3324,7 @@ export declare enum Action {
     /**
      * The **Schedule** menu action on a Liveboard.
      * Allows scheduling a Liveboard notification.
+     *
      * @example
      * ```js
      * disabledActions: [Action.Schedule]
@@ -3102,6 +3334,7 @@ export declare enum Action {
     /**
      * The **Manage schedules** menu action on a Liveboard.
      * Allows users to manage scheduled Liveboard jobs.
+     *
      * @example
      * ```js
      * disabledActions: [Action.SchedulesList]
@@ -3111,6 +3344,7 @@ export declare enum Action {
     /**
      * The **Share** action on a Liveboard, Answer, or Worksheet.
      * Allows users to share an object with other users and groups.
+     *
      * @example
      * ```js
      * disabledActions: [Action.Share]
@@ -3120,6 +3354,7 @@ export declare enum Action {
     /**
      * The **Add filter** action on a Liveboard and Search page.
      * Allows adding filters to Answers and visualizations on a Liveboard.
+     *
      * @example
      * ```js
      * disabledActions: [Action.AddFilter]
@@ -3130,6 +3365,7 @@ export declare enum Action {
      * The **Add Data Panel Objects** action on the data panel v2.
      * Allows to show action menu to add different objects (like
      * formulas, parameters) in data panel v2.
+     *
      * @example
      * ```js
      * disabledActions: [Action.AddDataPanelObjects]
@@ -3141,6 +3377,7 @@ export declare enum Action {
      * Filter configuration options on a Liveboard and Search page.
      * Allows configuring filter options when adding filters to a
      * Liveboard or Answer.
+     *
      * @example
      * ```js
      * disabledActions: [Action.ConfigureFilter]
@@ -3151,6 +3388,7 @@ export declare enum Action {
     /**
      * The **Choose sources** button on Search page.
      * Allows selecting data sources for search queries.
+     *
      * @example
      * ```js
      * disabledActions: [Action.ChooseDataSources]
@@ -3160,6 +3398,7 @@ export declare enum Action {
     /**
      * The **Create formula** action on a Search or Answer page.
      * Allows adding formulas to an Answer.
+     *
      * @example
      * ```js
      * disabledActions: [Action.AddFormula]
@@ -3169,6 +3408,7 @@ export declare enum Action {
     /**
      * The **Add parameter** action on a Liveboard or Answer.
      * Allows adding Parameters to a Liveboard or Answer.
+     *
      * @example
      * ```js
      * disabledActions: [Action.AddParameter]
@@ -3178,6 +3418,7 @@ export declare enum Action {
     /**
      * The **Add Column Set** action on a Answer.
      * Allows adding column sets to a Answer.
+     *
      * @example
      * ```js
      * disabledActions: [Action.AddColumnSet]
@@ -3188,6 +3429,7 @@ export declare enum Action {
     /**
      * The **Add Query Set** action on a Answer.
      * Allows adding query sets to a Answer.
+     *
      * @example
      * ```js
      * disabledActions: [Action.AddQuerySet]
@@ -3202,6 +3444,7 @@ export declare enum Action {
     /**
      * The **SpotIQ analyze** menu action on a visualization or
      * Answer page.
+     *
      * @example
      * ```js
      * disabledActions: [Action.SpotIQAnalyze]
@@ -3224,6 +3467,7 @@ export declare enum Action {
     /**
      * The **Show underlying data** menu action on a visualization or
      * Answer page.
+     *
      * @example
      * ```js
      * disabledActions: [Action.ShowUnderlyingData]
@@ -3234,6 +3478,7 @@ export declare enum Action {
      * The **Download** menu action on Liveboard visualizations
      * and Answers.
      * Allows downloading a visualization or Answer.
+     *
      * @example
      * ```js
      * disabledActions: [Action.DownloadAsPng]
@@ -3244,6 +3489,7 @@ export declare enum Action {
      * The **Download** > **PNG** menu action for charts on a Liveboard
      * or Answer page.
      * Downloads a visualization or Answer as a PNG file.
+     *
      * @example
      * ```js
      * disabledActions: [Action.DownloadAsPng]
@@ -3252,11 +3498,13 @@ export declare enum Action {
     DownloadAsPng = "downloadAsPng",
     /**
      *
-     *The **Download PDF** action that downloads a Liveboard,
-     *visualization, or Answer as a PDF file.
+     * The **Download PDF** action that downloads a Liveboard,
+     * visualization, or Answer as a PDF file.
+     *
+     *
+     * **NOTE**: The **Download** > **PDF** action is available on
+     * visualizations and Answers if the data is in tabular format.
      *
-     ***NOTE**: The **Download** > **PDF** action is available on
-     *visualizations and Answers if the data is in tabular format.
      * @example
      * ```js
      * disabledActions: [Action.DownloadAsPdf]
@@ -3267,6 +3515,7 @@ export declare enum Action {
      * The **Download** > **CSV** menu action for tables on a Liveboard
      * or Answer page.
      * Downloads a visualization or Answer in the XLSX format.
+     *
      * @example
      * ```js
      * disabledActions: [Action.DownloadAsCsv]
@@ -3277,6 +3526,7 @@ export declare enum Action {
      * The **Download** > **XLSX** menu action for tables on a Liveboard
      * or Answer page.
      * Downloads a visualization or Answer in the XLSX format.
+     *
      * @example
      * ```js
      * disabledActions: [Action.DownloadAsXlsx]
@@ -3291,6 +3541,7 @@ export declare enum Action {
      * The **Export TML** menu action on Liveboard, Answers
      * Worksheets and Data Connections page.
      * Exports an object as a TML file.
+     *
      * @example
      * ```js
      * disabledActions: [Action.ExportTML]
@@ -3300,6 +3551,7 @@ export declare enum Action {
     /**
      * The **Import TML** menu action for Liveboards and Answers.
      * Imports TML representation of ThoughtSpot objects.
+     *
      * @example
      * ```js
      * disabledActions: [Action.ImportTML]
@@ -3309,6 +3561,7 @@ export declare enum Action {
     /**
      * The **Update TML** menu action for Liveboards and Answers.
      * Update TML representation of ThoughtSpot objects.
+     *
      * @example
      * ```js
      * disabledActions: [Action.UpdateTML]
@@ -3318,6 +3571,7 @@ export declare enum Action {
     /**
      * The **Edit TML** menu action for Liveboards and Answers.
      * Opens the TML editor.
+     *
      * @example
      * ```js
      * disabledActions: [Action.EditTML]
@@ -3328,6 +3582,7 @@ export declare enum Action {
      * The **Present** menu action for Liveboards and Answers.
      * Allows presenting a Liveboard or visualization in
      * slideshow mode.
+     *
      * @example
      * ```js
      * disabledActions: [Action.Present]
@@ -3337,6 +3592,7 @@ export declare enum Action {
     /**
      * The tile resize options in the visualization menu.
      * Allows switching between different preset layouts.
+     *
      * @example
      * ```js
      * disabledActions: [Action.ToggleSize]
@@ -3347,6 +3603,7 @@ export declare enum Action {
      * The *Edit* action on the Liveboard page and in the
      * visualization menu.
      * Opens a Liveboard or visualization in edit mode.
+     *
      * @example
      * ```js
      * disabledActions: [Action.Edit]
@@ -3355,6 +3612,7 @@ export declare enum Action {
     Edit = "edit",
     /**
      * The text edit option for Liveboard and visualization titles.
+     *
      * @example
      * ```js
      * disabledActions: [Action.EditTitle]
@@ -3364,6 +3622,7 @@ export declare enum Action {
     /**
      * The **Delete** menu action on Liveboards and visualizations.
      * Deletes a Liveboard or a visualization from a Liveboard.
+     *
      * @example
      * ```js
      * disabledActions: [Action.Remove]
@@ -3395,6 +3654,7 @@ export declare enum Action {
      * Displays details such as the name, description, and
      * author of the Liveboard, and timestamp of Liveboard creation
      * and update.
+     *
      * @example
      * ```js
      * disabledActions: [Action.LiveboardInfo]
@@ -3412,6 +3672,7 @@ export declare enum Action {
     /**
      * The **Pin** menu action on an Answer or
      * Search results page.
+     *
      * @example
      * ```js
      * disabledActions: [Action.Pin]
@@ -3424,6 +3685,7 @@ export declare enum Action {
     AnalysisInfo = "analysisInfo",
     /**
      * The **Schedule** menu action on a Liveboard.
+     *
      * @example
      * ```js
      * disabledActions: [Action.Subscription]
@@ -3432,6 +3694,7 @@ export declare enum Action {
     Subscription = "subscription",
     /**
      * The **Explore** action on Liveboard visualizations
+     *
      * @example
      * ```js
      * disabledActions: [Action.Explore]
@@ -3441,6 +3704,7 @@ export declare enum Action {
     /**
      * The action to include data points on a drilled-down Answer
      * or visualization
+     *
      * @example
      * ```js
      * disabledActions: [Action.DrillInclude]
@@ -3450,6 +3714,7 @@ export declare enum Action {
     /**
      * The action to exclude data points on a drilled-down Answer
      * or visualization
+     *
      * @example
      * ```js
      * disabledActions: [Action.DrillInclude]
@@ -3460,6 +3725,7 @@ export declare enum Action {
      * The **Copy to clipboard** menu action on tables in an Answer
      * or Liveboard.
      * Copies the selected data point.
+     *
      * @example
      * ```js
      * disabledActions: [Action.CopyToClipboard]
@@ -3477,6 +3743,7 @@ export declare enum Action {
      * The **Drill down** menu action on Answers and Liveboard
      * visualizations.
      * Allows drilling down to a specific data point on a chart or table.
+     *
      * @example
      * ```js
      * disabledActions: [Action.DrillDown]
@@ -3486,6 +3753,7 @@ export declare enum Action {
     /**
      * The request access action on Liveboards.
      * Allows users with view permissions to request edit access to a Liveboard.
+     *
      * @example
      * ```js
      * disabledActions: [Action.RequestAccess]
@@ -3495,6 +3763,7 @@ export declare enum Action {
     /**
      * The **Query visualizer** and **Query SQL** buttons in Query details panel
      * of the Answer page
+     *
      * @example
      * ```js
      * disabledActions: [Action.QueryDetailsButtons]
@@ -3502,7 +3771,9 @@ export declare enum Action {
      */
     QueryDetailsButtons = "queryDetailsButtons",
     /**
-     * The **Delete** action for Answers.
+     * The **Delete** action for Answers in the full application
+     * embedding mode.
+     *
      * @example
      * ```js
      * disabledActions: [Action.AnswerDelete]
@@ -3512,6 +3783,7 @@ export declare enum Action {
     AnswerDelete = "onDeleteAnswer",
     /**
      * The Chart switcher icon on Answer and visualization pages.
+     *
      * @example
      * ```js
      * disabledActions: [Action.AnswerChartSwitcher]
@@ -3521,6 +3793,7 @@ export declare enum Action {
     AnswerChartSwitcher = "answerChartSwitcher",
     /**
      * Favorites icon (*) on Answers, Liveboard, and Data pages
+     *
      * @example
      * ```js
      * disabledActions: [Action.AddToFavorites]
@@ -3530,6 +3803,7 @@ export declare enum Action {
     AddToFavorites = "addToFavorites",
     /**
      * The edit icon on Liveboards (Classic experience).
+     *
      * @example
      * ```js
      * disabledActions: [Action.EditDetails]
@@ -3539,6 +3813,7 @@ export declare enum Action {
     EditDetails = "editDetails",
     /**
      * The Create alert action on KPI charts.
+     *
      * @example
      * ```js
      * disabledActions: [Action.CreateMonitor ]
@@ -3557,6 +3832,7 @@ export declare enum Action {
     /**
      * The **Sync to sheets** action on Answers and Liveboard visualizations.
      * Allows sending data to a Google Sheet.
+     *
      * @example
      * ```js
      * disabledActions: [Action.SyncToSheets]
@@ -3568,6 +3844,7 @@ export declare enum Action {
      * The **Sync to other apps** action on Answers and Liveboard visualizations.
      * Allows sending data to third-party apps like Slack, Salesforce,
      * Microsoft Teams, and so on.
+     *
      * @example
      * ```js
      * disabledActions: [Action.SyncToOtherApps]
@@ -3578,6 +3855,7 @@ export declare enum Action {
     /**
      * The **Manage pipelines** action on Answers and Liveboard visualizations.
      * Allows users to manage data sync pipelines to third-party apps.
+     *
      * @example
      * ```js
      * disabledActions: [Action.SyncToOtherApps]
@@ -3588,6 +3866,7 @@ export declare enum Action {
     /**
      * The **Filter** action on Liveboard visualizations.
      * Allows users to apply cross-filters on a Liveboard.
+     *
      * @example
      * ```js
      * disabledActions: [Action.CrossFilter]
@@ -3598,6 +3877,7 @@ export declare enum Action {
     /**
      * The **Sync to Slack** action on Liveboard visualizations.
      * Allows sending data to third-party apps Slack
+     *
      * @example
      * ```js
      * disabledActions: [Action.SyncToSlack]
@@ -3608,6 +3888,7 @@ export declare enum Action {
     /**
      * The **Sync to Teams** action on Liveboard visualizations.
      * Allows sending data to third-party apps Team
+     *
      * @example
      * ```js
      * disabledActions: [Action.SyncToTeams]
@@ -3619,6 +3900,7 @@ export declare enum Action {
      * The **Remove** action that appears when cross filters are applied
      * on a Liveboard.
      * Removes filters applied o a visualization.
+     *
      * @example
      * ```js
      * disabledActions: [Action.RemoveCrossFilter]
@@ -3630,6 +3912,7 @@ export declare enum Action {
      * The **Aggregate** option in the chart axis or the
      * table column customization menu.
      * Provides aggregation options to analyze the data on a chart or table.
+     *
      * @example
      * ```js
      * disabledActions: [Action.AxisMenuAggregate]
@@ -3641,6 +3924,7 @@ export declare enum Action {
      * The **Time bucket** option in the chart axis or table column
      * customization menu.
      * Allows defining time metric for date comparison.
+     *
      * @example
      * ```js
      * disabledActions: [Action.AxisMenuTimeBucket]
@@ -3651,6 +3935,7 @@ export declare enum Action {
     /**
      * The **Filter** action in the chart axis or table column
      * customization menu.
+     *
      * @example
      * ```js
      * disabledActions: [Action.AxisMenuFilter]
@@ -3662,6 +3947,7 @@ export declare enum Action {
      * The **Conditional formatting** action on chart or table.
      * Allows adding rules for conditional formatting of data
      * points on a chart or table.
+     *
      * @example
      * ```js
      * disabledActions: [Action.AxisMenuConditionalFormat]
@@ -3673,6 +3959,7 @@ export declare enum Action {
      * The **Sort** menu action on a table or chart axis
      * Sorts data in ascending or descending order.
      * Allows adding, editing, or removing filters.
+     *
      * @example
      * ```js
      * disabledActions: [Action.AxisMenuConditionalFormat]
@@ -3685,6 +3972,7 @@ export declare enum Action {
      * customization menu.
      * Allows grouping data points if the axes use the same
      * unit of measurement and a similar scale.
+     *
      * @example
      * ```js
      * disabledActions: [Action.AxisMenuGroup]
@@ -3696,6 +3984,7 @@ export declare enum Action {
      * The **Position** option in the axis customization menu.
      * Allows changing the position of the axis to the
      * left or right side of the chart.
+     *
      * @example
      * ```js
      * disabledActions: [Action.AxisMenuPosition]
@@ -3706,6 +3995,7 @@ export declare enum Action {
     /**
      * The **Rename** option in the chart axis or table column customization menu.
      * Renames the axis label on a chart or the column header on a table.
+     *
      * @example
      * ```js
      * disabledActions: [Action.AxisMenuRename]
@@ -3717,6 +4007,7 @@ export declare enum Action {
      * The **Edit** action in the axis customization menu.
      * Allows editing the axis name, position, minimum and maximum values,
      * and format of a column.
+     *
      * @example
      * ```js
      * disabledActions: [Action.AxisMenuEdit]
@@ -3727,6 +4018,7 @@ export declare enum Action {
     /**
      * The **Number format** action to customize the format of
      * the data labels on a chart or table.
+     *
      * @example
      * ```js
      * disabledActions: [Action.AxisMenuNumberFormat]
@@ -3737,6 +4029,7 @@ export declare enum Action {
     /**
      * The **Text wrapping** action on a table.
      * Wraps or clips column text on a table.
+     *
      * @example
      * ```js
      * disabledActions: [Action.AxisMenuTextWrapping]
@@ -3749,6 +4042,7 @@ export declare enum Action {
      * customization menu.
      * Removes the data labels from a chart or the column of a
      * table visualization.
+     *
      * @example
      * ```js
      * disabledActions: [Action.AxisMenuRemove]
@@ -3763,6 +4057,7 @@ export declare enum Action {
     /**
      * The **Rename** menu action on Liveboards and visualizations.
      * Allows renaming a Liveboard or visualization.
+     *
      * @example
      * ```js
      * disabledActions: [Action.RenameModalTitleDescription]
@@ -3806,6 +4101,7 @@ export declare enum Action {
     /**
      * The **Move to Tab** menu action on visualizations in liveboard edit mode.
      * Allows moving a visualization to a different tab.
+     *
      * @example
      * ```js
      * disabledActions: [Action.MoveToTab]
@@ -3814,6 +4110,7 @@ export declare enum Action {
     MoveToTab = "onContainerMove",
     /**
      * The **Manage Alertsb** menu action on KPI visualizations.
+     *
      * @example
      * ```js
      * disabledActions: [Action.ManageMonitor]
@@ -3822,6 +4119,7 @@ export declare enum Action {
     ManageMonitor = "ManageMonitor",
     /**
      * Action ID for Liveboard Personalised Views dropdown
+     *
      *  @example
      * ```js
      * disabledActions: [Action.PersonalisedViewsDropdown]
@@ -3831,6 +4129,7 @@ export declare enum Action {
     PersonalisedViewsDropdown = "personalisedViewsDropdown",
     /**
      * Action ID for Liveboard Users ( Recently Visited / social proof )
+     *
      *  @example
      * ```js
      * disabledActions: [Action.LiveboardUsers]
@@ -3842,6 +4141,7 @@ export declare enum Action {
      * Action ID for the Parent TML action
      * The parent action **TML** must be included to access TML-related options
      * within the cascading menu (specific to the answer page)
+     *
      * @example
      * ```js
      * // to include specific TML actions
@@ -3853,11 +4153,13 @@ export declare enum 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
      */
     TML = "tml",
     /**
      * Action ID for to hide Verified Liveboard Banner
+     *
      *  @example
      * ```js
      * hiddenAction: [Action.VerifiedLiveboard]
@@ -3867,6 +4169,7 @@ export declare enum Action {
     VerifiedLiveboard = "verifiedLiveboard",
     /**
      * Action ID for ask sage button
+     *
      *  @example
      * ```js
      * hiddenAction: [Action.AskAi]
@@ -3876,6 +4179,7 @@ export declare enum Action {
     AskAi = "AskAi",
     /**
      * The **Add KPI to Watchlist** action on Home page watchlist.
+     *
      * @example
      * ```js
      * disabledActions: [Action.AddToWatchlist]
@@ -3885,6 +4189,7 @@ export declare enum Action {
     AddToWatchlist = "addToWatchlist",
     /**
      * The **Remove from watchlist** menu action on KPI watchlist.
+     *
      * @example
      * ```js
      * disabledActions: [Action.RemoveFromWatchlist]
@@ -3894,6 +4199,7 @@ export declare enum Action {
     RemoveFromWatchlist = "removeFromWatchlist",
     /**
      * The **Organise Favourites** action on Homepage Favourite Module.
+     *
      * @example
      * ```js
      * disabledActions: [Action.OrganiseFavourites]
@@ -3903,6 +4209,7 @@ export declare enum Action {
     OrganiseFavourites = "organiseFavourites",
     /**
      * Action ID for AI Highlights button
+     *
      *  @example
      * ```js
      * hiddenAction: [Action.AIHighlights]
@@ -3971,6 +4278,7 @@ export interface CustomActionPayload {
 export declare enum LogLevel {
     /**
      * No logs will be logged in the console.
+     *
      * @example
      * ```js
      * init({
@@ -3983,6 +4291,7 @@ export declare enum LogLevel {
     SILENT = "SILENT",
     /**
      * Only ERROR logs will be logged in the console.
+     *
      * @example
      * ```js
      * init({
@@ -3995,6 +4304,7 @@ export declare enum LogLevel {
     ERROR = "ERROR",
     /**
      * Only WARN and ERROR logs will be logged in the console.
+     *
      * @example
      * ```js
      * init({
@@ -4007,6 +4317,7 @@ export declare enum LogLevel {
     WARN = "WARN",
     /**
      * Only INFO, WARN, and ERROR logs will be logged in the console.
+     *
      * @example
      * ```js
      * init({
@@ -4019,6 +4330,7 @@ export declare enum LogLevel {
     INFO = "INFO",
     /**
      * Only DEBUG, INFO, WARN, and ERROR logs will be logged in the console.
+     *
      * @example
      * ```js
      * init({
@@ -4031,6 +4343,7 @@ export declare enum LogLevel {
     DEBUG = "DEBUG",
     /**
      * All logs will be logged in the console.
+     *
      * @example
      * ```js
      * init({