@thoughtspot/visual-embed-sdk 1.22.0 → 1.23.0

package/lib/src/types.js

@@ -164,7 +164,7 @@ export var AuthType;
      *      .then((data) => data.token);
      *  }
      * ```
-     * @version SDK: 1.22.0| ThouhgtSpot: 9.3.0.cl, 9.5.1-sw
+     * @version SDK: 1.22.0| ThouhgtSpot: 9.3.0.cl, 9.5.1.sw
      */
     AuthType["TrustedAuthTokenCookieless"] = "AuthServerCookieless";
     /**
@@ -314,7 +314,7 @@ export var EmbedEvent;
      * 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
+     * @version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
      */
     EmbedEvent["AddRemoveColumns"] = "addRemoveColumns";
     /**
@@ -347,7 +347,7 @@ export var EmbedEvent;
      * });
      * ```
      * @return viz, clickedPoint - metadata about point that is clicked
-     * @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
      * @important
      */
     EmbedEvent["VizPointClick"] = "vizPointClick";
@@ -397,7 +397,7 @@ export var EmbedEvent;
      * Emitted when  the "Get Data" button in Search Bar embed
      * is clicked.
      *
-     * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.0-sw
+     * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.0.sw
      */
     EmbedEvent["GetDataClick"] = "getDataClick";
     /**
@@ -427,13 +427,13 @@ 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
+     * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
      */
     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
+     * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
      */
     EmbedEvent["DialogClose"] = "dialog-close";
     /**
@@ -441,136 +441,136 @@ export var EmbedEvent;
      * You can use this event as a hook to trigger
      * other events on the rendered Liveboard.
      *
-     * @version SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
+     * @version SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
      */
     EmbedEvent["LiveboardRendered"] = "PinboardRendered";
     /**
      * This can be used to register an event listener which
      * is triggered on 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
      */
     EmbedEvent["ALL"] = "*";
     /**
-     * Emitted when answer is saved in the app
+     * Emitted when an Answer is saved in the app
      *
-     * @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
      */
     EmbedEvent["Save"] = "save";
     /**
      * Emitted when the download action is triggered on an answer
      *
-     * @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
      */
     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
+     * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.4.0.sw
      */
     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
+     * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
      */
     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
+     * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
      */
     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
+     * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
      */
     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
+     * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
      */
     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
+     * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
      */
     EmbedEvent["Pin"] = "pin";
     /**
      * Emitted when SpotIQ analysis is triggered
      *
-     * @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
      */
     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
+     * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
      */
     EmbedEvent["Share"] = "share";
     /**
      * 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
+     * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
      */
     EmbedEvent["DrillInclude"] = "context-menu-item-include";
     /**
      * 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
+     * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
      */
     EmbedEvent["DrillExclude"] = "context-menu-item-exclude";
     /**
      * Emitted when copied column value on the app
      *
-     * @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
      */
     EmbedEvent["CopyToClipboard"] = "context-menu-item-copy-to-clipboard";
     /**
      * Emitted when a user clicks the Update TML action
      *
-     * @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
      */
     EmbedEvent["UpdateTML"] = "updateTSL";
     /**
      * Emitted when a user clicks the Edit TML action
      *
-     * @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
      */
     EmbedEvent["EditTML"] = "editTSL";
     /**
      * Emitted when ExportTML trigger in answer on the app
      *
-     * @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
      */
     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
+     * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
      */
     EmbedEvent["SaveAsView"] = "saveAsView";
     /**
      * Emitted when copy of existing answer on the app
      *
-     * @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
      */
     EmbedEvent["CopyAEdit"] = "copyAEdit";
     /**
      * Emitted when a user clicks Show underlying data on an answe
      *
-     * @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
      */
     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
+     * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
      */
     EmbedEvent["AnswerChartSwitcher"] = "answerChartSwitcher";
     /**
@@ -582,67 +582,67 @@ 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
+     * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
      */
     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
+     * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
      */
     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
+     * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
      */
     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
+     * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
      */
     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
+     * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
      */
     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
+     * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
      */
     EmbedEvent["Present"] = "present";
     /**
      * Emitted when a user clicks Delete on a Liveboard
      *
-     * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
+     * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
      */
     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
+     * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
      */
     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
+     * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
      */
     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
+     * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
      */
     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
+     * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
      */
     EmbedEvent["CopyLink"] = "embedDocument";
     /**
@@ -663,6 +663,12 @@ export var EmbedEvent;
      * @hidden
      */
     EmbedEvent["InsertIntoSlide"] = "insertInToSlide";
+    /**
+     * Emitted when a user changes any filter on a Liveboard.
+     *
+     * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
+     */
+    EmbedEvent["FilterChanged"] = "filterChanged";
 })(EmbedEvent || (EmbedEvent = {}));
 /**
  * Event types that can be triggered by the host application
@@ -690,13 +696,14 @@ export var EmbedEvent;
 export var HostEvent;
 (function (HostEvent) {
     /**
-     * Trigger a search
-     *
+     * Triggers a search query in AppEmbed and SearchEmbed
+     * deployments.
+     * Includes the following properties:
      * @param - dataSourceIds - The data source GUID to Search on
      *                        - Although an array, only a single source
-     *                          is supported at this time.
-     * @param - searchQuery - The search query
-     * @param - execute - execute the existing / updated query
+     *                          is supported.
+     * @param - searchQuery - Query string with search tokens
+     * @param - execute - executes the existing / updated query
      * @example
      * ```js
      * searchEmbed.trigger(HostEvent.Search, {
@@ -708,13 +715,13 @@ export var HostEvent;
      */
     HostEvent["Search"] = "search";
     /**
-     * Trigger a drill on certain points by certain column
-     *
+     * Triggers a drill on certain points of the specified column
+     * Includes the following properties:
      * @param - points - an object containing selectedPoints/clickedPoints
-     *              eg. { selectedPoints: []}
-     * @param - columnGuid - a string guid of the column to drill by. This is optional,
-     *                     if not provided it will auto drill by the configured
-     *                     column.
+     * to drill to. For example, { selectedPoints: []}
+     * @param - columnGuid - Optional. GUID of the column to drill
+     * by. If not provided it will auto drill by the configured
+     *   column.
      * @example
      * ```js
      * searchEmbed.on(EmbedEvent.VizPointDoubleClick, (payload) => {
@@ -747,17 +754,17 @@ export var HostEvent;
      */
     HostEvent["Reload"] = "reload";
     /**
-     * Set the visible visualizations on a Liveboard.
+     * Sets the visible visualizations on a Liveboard.
      *
-     * @param - an array of ids of visualizations to show, the ids not passed
-     *          will be hidden.
+     * @param - An array of GUIDs of the visualization to show. The visualization IDs not passed
+     *  in this parameter will be hidden.
      * @example
      * ```js
      * liveboardEmbed.trigger(HostEvent.SetVisibleVizs, [
      *  '730496d6-6903-4601-937e-2c691821af3c',
      *  'd547ec54-2a37-4516-a222-2b06719af726'])
      * ```
-     * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1-sw
+     * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
      */
     HostEvent["SetVisibleVizs"] = "SetPinboardVisibleVizs";
     /**
@@ -774,9 +781,18 @@ export var HostEvent;
      */
     HostEvent["SetActiveTab"] = "SetActiveTab";
     /**
-     * Update the runtime filters. The runtime filters passed here are extended
-     * on to the existing runtime filters if they exist.
-     *
+    * Updates runtime filters applied on a Saved Answer or Liveboard. The
+    * runtime filters passed here are appended to the existing runtime
+    * filters.
+    * Pass an array of runtime filters with the following attributes:
+    * `columnName`
+    * _String_. The name of the column to filter on.
+    * `operator`
+    *  Runtime filter operator to apply. For information,
+    *  see [Runtime filter operators](https://developers.thoughtspot.com/docs/?pageid=runtime-filters#rtOperator).
+    * `values`
+    *  List of operands. Some operators such as EQ, LE allow a single value, whereas operators
+    *  such as BW and IN accept multiple operands.
      * @param - {@link RuntimeFilter}[] an array of {@link RuntimeFilter} Types.
      * @example
      * ```js
@@ -785,25 +801,24 @@ export var HostEvent;
      *   {columnName: "item type",operator: RuntimeFilterOp.EQ,values: ["Jackets"]}
      * ])
      * ```
-     * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
+     * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
      * @important
      */
     HostEvent["UpdateRuntimeFilters"] = "UpdateRuntimeFilters";
     /**
-     * Navigate to a specific page in App embed without any reload.
+     * Navigate to a specific page in the embedded application without reloading the page.
      * This is the same as calling `appEmbed.navigateToPage(path, true)`
-     *
      * @param - path - the path to navigate to (can be a number[1/-1] to go forward/back)
      * @example
      * ```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";
     /**
      * Opens the filter panel for a particular column.
-     * Works with Search embed.
+     * Works with Search and Liveboard embed.
      *
      * @param - { columnId: string,
      *  name: string,
@@ -812,233 +827,257 @@ export var HostEvent;
      * @example
      * ```js
      * searchEmbed.trigger(HostEvent.OpenFilter,
-     *  { columnId: '123', name: 'column name', type: 'INT64', dataType: 'ATTRIBUTE' })
+     * { columnId: '<column-GUID>', name: 'column name', type: 'INT64', dataType: 'ATTRIBUTE'})
+     * LiveboardEmbed.trigger(HostEvent.OpenFilter,
+     *  { columnId: '<column-GUID>'})
      * ```
      * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
      */
     HostEvent["OpenFilter"] = "openFilter";
     /**
-     * Adds the columns to the current Search.
+     * Adds columns to the current search query.
      *
      * @param - { columnIds: string[] }
      * @example
      * ```js
-     * searchEmbed.trigger(HostEvent.AddColumns, { columnIds: ['123', '456'] })
+     * searchEmbed.trigger(HostEvent.AddColumns, { columnIds: ['<column-GUID>','<column-GUID>'] })
      * ```
      * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
      */
     HostEvent["AddColumns"] = "addColumns";
     /**
-     * Removes a column from the current Search.
+     * Removes a column from the current search query.
      *
      * @param - { columnId: string }
      * @example
      * ```js
-     * searchEmbed.trigger(HostEvent.RemoveColumn, { columnId: '123' })
+     * searchEmbed.trigger(HostEvent.RemoveColumn, { columnId: '<column-Guid>' })
      * ```
      * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
      */
     HostEvent["RemoveColumn"] = "removeColumn";
     /**
-     * Gets the current pinboard content.
+     * Gets the current Liveboard content.
      *
      * @example
      * ```js
      * liveboardEmbed.trigger(HostEvent.getExportRequestForCurrentPinboard)
      * ```
-     * @version SDK: 1.13.0 | ThoughtSpot: 8.5.0.cl, 8.8.1-sw
+     * @version SDK: 1.13.0 | ThoughtSpot: 8.5.0.cl, 8.8.1.sw
      */
     HostEvent["getExportRequestForCurrentPinboard"] = "getExportRequestForCurrentPinboard";
     /**
-     * Triggers the Pin action on an embedded object
+     * Triggers the **Pin** action on an embedded object
      *
-     * @param - incase of Liveboard embed, takes in an object with vizId as a key
-     * can be left empty for search and visualization embeds
+     * @param - Liveboard embed takes the `vizId` as a
+     * key. Can be left undefined when embedding Search, full app or
+     * a visualization.
      * @example
      * ```js
      * liveboardEmbed.trigger(HostEvent.Pin, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
+     * ```
+     * ```js
      * vizEmbed.trigger(HostEvent.Pin)
+     * ```
+     * ```js
      * searchEmbed.trigger(HostEvent.Pin)
      * ```
-     * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
+     * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
      */
     HostEvent["Pin"] = "pin";
     /**
-     * Triggers the Show Liveboard details action on a Liveboard
+     * Triggers the **Show Liveboard details** action on a Liveboard
      *
      * @example
      * ```js
      *  liveboardEmbed.trigger(HostEvent.LiveboardInfo)
      * ```
-     * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
+     * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
      */
     HostEvent["LiveboardInfo"] = "pinboardInfo";
     /**
-     * Triggers the Schedule action on a Liveboard
+     * Triggers the **Schedule** action on a Liveboard
      *
      * @example
      * ```js
      *  liveboardEmbed.trigger(HostEvent.Schedule)
      * ```
-     * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
+     * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
      */
     HostEvent["Schedule"] = "subscription";
     /**
-     * Triggers the Manage schedule action on a Liveboard
+     * Triggers the **Manage schedule** action on a Liveboard
      *
      * @example
      * ```js
      *  liveboardEmbed.trigger(HostEvent.ScheduleList)
      * ```
-     * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
+     * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
      */
     HostEvent["SchedulesList"] = "schedule-list";
     /**
-     * Triggers the Export TML action on a Liveboard
+     * Triggers the **Export TML** action on a Liveboard
      *
      * @example
      * ```js
      * liveboardEmbed.trigger(HostEvent.ExportTML)
      * ```
-     * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
+     * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
      */
     HostEvent["ExportTML"] = "exportTSL";
     /**
-     * Triggers the Edit TML action on a Liveboard
+     * Triggers the **Edit TML** action on a Liveboard
      *
      * @example
      * ```js
      * liveboardEmbed.trigger(HostEvent.EditTML)
      * ```
-     * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
+     * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
      */
     HostEvent["EditTML"] = "editTSL";
     /**
-     * Triggers the Update TML action on a Liveboard
+     * Triggers the **Update TML** action on a Liveboard
      *
      * @example
      * ```js
      * liveboardEmbed.trigger(HostEvent.UpdateTML)
      * ```
-     * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
+     * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
      */
     HostEvent["UpdateTML"] = "updateTSL";
     /**
-     * Triggers the Download PDF action on a Liveboard
+     * Triggers the **Download PDF** action on a Liveboard
      *
      * @example
      * ```js
      * liveboardEmbed.trigger(HostEvent.DownloadAsPdf)
      * ```
-     * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
+     * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
      */
     HostEvent["DownloadAsPdf"] = "downloadAsPdf";
     /**
-     * Triggers the Make a copy action on a Liveboard, search or visualization
+     * Triggers the **Make a copy** action on a Liveboard, Search, or
+     * visualization page
      *
      * @example
      * ```js
      * liveboardEmbed.trigger(HostEvent.MakeACopy, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
+     * ```
+     * ```js
      * vizEmbed.trigger(HostEvent.MakeACopy)
+     * ```
+     * ```js
      * searchEmbed.trigger(HostEvent.MakeACopy)
      * ```
-     * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
+     * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
      */
     HostEvent["MakeACopy"] = "makeACopy";
     /**
-     * Triggers the Delete action on a Liveboard
+     * Triggers the **Delete** action on a Liveboard
      *
      * @example
      * ```js
      * appEmbed.trigger(HostEvent.Remove)
      * ```
-     * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
+     * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
      */
     HostEvent["Remove"] = "delete";
     /**
-     * Triggers the Explore action on a visualization
+     * Triggers the **Explore* action on a visualization
      *
-     * @param - an object with vizId as a key
+     * @param - an object with `vizId` as a key
      * @example
      * ```js
      * liveboardEmbed.trigger(HostEvent.Explore, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
      * ```
-     * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
+     * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
      */
     HostEvent["Explore"] = "explore";
     /**
-     * Triggers the Create alert action on a visualization
+     * Triggers the **Create alert** action on a visualization
      *
-     * @param - an object with vizId as a key
+     * @param - an object with `vizId` as a key
      * @example
      * ```js
      * liveboardEmbed.trigger(HostEvent.CreateMonitor {
      *  vizId: '730496d6-6903-4601-937e-2c691821af3c'
      * })
      * ```
-     * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
+     * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
      */
     HostEvent["CreateMonitor"] = "createMonitor";
     /**
-     * Triggers the Manage alert action on a visualization
+     * Triggers the **Manage alerts** action on a visualization
      *
-     * @param - an object with vizId as a key
+     * @param - an object with `vizId` as a key
      * @example
      * ```js
      * liveboardEmbed.trigger(HostEvent.ManageMonitor, {
      *  vizId: '730496d6-6903-4601-937e-2c691821af3c'
      * })
      * ```
-     * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
+     * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
      */
     HostEvent["ManageMonitor"] = "manageMonitor";
     /**
-     * Triggers the Edit action on a Liveboard or visualization
+     * Triggers the **Edit** action on a Liveboard or visualization
      *
-     * @param - object - to trigger the action for a specfic visualization
-     *   in Liveboard embed, pass in vizId as a key
+     * @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)
-     *
+     * ```
+     * ```js
      * 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
+     * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
      */
     HostEvent["Edit"] = "edit";
     /**
-     * Triggers the Copy link action on a Liveboard or visualization
+     * Triggers the **Copy link** action on a Liveboard or visualization
      *
-     * @param - object - to trigger the action for a s
-     *  pecfic visualization in Liveboard embed, pass in vizId as a key
+     * @param - object - to trigger the action for a
+     * specific visualization in Liveboard embed, pass in `vizId` as a key
      * @example
      * ```js
      * liveboardEmbed.trigger(HostEvent.CopyLink)
+     * ```
+     * ```js
      * liveboardEmbed.trigger(HostEvent.CopyLink, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
+     * ```
+     * ```js
      * vizEmbed.trigger((HostEvent.CopyLink)
      * ```
-     * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
+     * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
      */
     HostEvent["CopyLink"] = "embedDocument";
     /**
-     * Triggers the Present action on a Liveboard or visualization
+     * Triggers the **Present** action on a Liveboard or visualization
      *
-     * @param - object - to trigger the action for a specfic visualization
-     *  in Liveboard embed, pass in vizId as a key
+     * @param - object - to trigger the action for a specific visualization
+     *  in Liveboard embed, pass in `vizId` as a key
      * @example
      * ```js
      * liveboardEmbed.trigger(HostEvent.Present)
+     * ```
+     * ```js
      * liveboardEmbed.trigger(HostEvent.Present, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
+     * ```
+     * ```js
      * vizEmbed.trigger((HostEvent.Present)
      * ```
-     * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
+     * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
      */
     HostEvent["Present"] = "present";
     /**
-     * Get TML for the current search.
+     * Gets TML for the current search.
      *
      * @example
      * ```js
@@ -1048,79 +1087,89 @@ export var HostEvent;
      *   );
      * })
      * ```
-     * @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
      * @important
      */
     HostEvent["GetTML"] = "getTML";
     /**
-     * Triggers the ShowUnderlyingData action on visualization or search
+     * Triggers the **Show underlying data** action on visualization or search
      *
      * @param - an object with vizId as a key
      * @example
      * ```js
      * liveboardEmbed.trigger(HostEvent.ShowUnderlyingData, {vizId:
      * '730496d6-6903-4601-937e-2c691821af3c'})
-     *
+     * ```
+     * ```js
      * vizEmbed.trigger(HostEvent.ShowUnderlyingData)
-     *
+     * ```
+     * ```js
      * searchEmbed.trigger(HostEvent.ShowUnderlyingData)
      * ```
-     * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
+     * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
      */
     HostEvent["ShowUnderlyingData"] = "showUnderlyingData";
     /**
-     * Triggers the Delete action on visualization or search
+     * Triggers the **Delete** action on visualization or search
      *
-     * @param - incase of Liveboard embed, takes in an object with vizId as a key
-     * can be left empty for search and visualization embeds
+     * @param - Liveboard embed takes an object with `vizId` as a key.
+     * Can be left empty if embedding Search or visualization.
      * @example
      * ```js
      * liveboardEmbed.trigger(HostEvent.Delete, {vizId:
      * '730496d6-6903-4601-937e-2c691821af3c'})
-     *
+     * ```
+     * ```js
      * vizEmbed.trigger(HostEvent.Delete)
-     *
+     * ```
+     * ```js
      * searchEmbed.trigger(HostEvent.Delete)
      * ```
-     * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
+     * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
      */
     HostEvent["Delete"] = "onDeleteAnswer";
     /**
-     * Triggers the SpotIQAnalyze action on visualization or search
-     *
-     * @param - incase of Liveboard embed, takes in an object with vizId as a key
-     * can be left empty for search and visualization embeds
+     * Triggers 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.
      * @example
      * ```js
      * liveboardEmbed.trigger(HostEvent.SpotIQAnalyze, {vizId:
      * '730496d6-6903-4601-937e-2c691821af3c'})
-     *
+     * ```
+     * ```js
      * vizEmbed.trigger(HostEvent.SpotIQAnalyze)
-     *
+     * ```
+     * ```js
      * searchEmbed.trigger(HostEvent.SpotIQAnalyze)
      * ```
-     * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
+     * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
      */
     HostEvent["SpotIQAnalyze"] = "spotIQAnalyze";
     /**
-     * Triggers the Download action on visualization or search when Displaymode is Chart
+     * Triggers the **Download** action on charts in
+     * the embedded view.
      *
      * @example
      * ```js
      * liveboardEmbed.trigger(HostEvent.Download, {vizId:
      * '730496d6-6903-4601-937e-2c691821af3c'})
-     *
+     * ```
+     * ```js
      * vizEmbed.trigger(HostEvent.Download)
-     *
+     * ```
+     * ```js
      * searchEmbed.trigger(HostEvent.Download)
      * ```
-     * @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
+     * @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";
     /**
-     * Triggers the Download action on visualization or search when Displaymode is Chart
-     *
+     * Triggers the **Download** > **PNG** action on
+     * charts in the embedded view.
      * @example
      * ```js
      * liveboardEmbed.trigger(HostEvent.DownloadAsPng,
@@ -1130,115 +1179,192 @@ export var HostEvent;
      *
      * searchEmbed.trigger(HostEvent.DownloadAsPng)
      * ```
-     * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.4.1-sw
+     * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.4.1.sw
      */
     HostEvent["DownloadAsPng"] = "downloadAsPng";
     /**
-     * Triggers the downloadAsCSV action on visualization or search
+     * Triggers the **Download** > **CSV**  action on tables in
+     * the embedded view.
      *
      * @example
      * ```js
      * liveboardEmbed.trigger(HostEvent.DownloadAsCsv, {vizId:
      * '730496d6-6903-4601-937e-2c691821af3c'})
-     *
+     * ```
+     * ```js
      * vizEmbed.trigger(HostEvent.DownloadAsCsv)
-     *
+     * ```
+     * ```js
      * searchEmbed.trigger(HostEvent.DownloadAsCsv)
      * ```
-     * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
+     * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
      */
     HostEvent["DownloadAsCsv"] = "downloadAsCSV";
     /**
-     * Triggers the downloadAsXLSX action on visualization or search
-     *
+     * Triggers the **Download** > **XLSX**  action on tables
+     * in the embedded view.
      * @example
      * ```js
      * liveboardEmbed.trigger(HostEvent.DownloadAsXlsx, {vizId:
      * '730496d6-6903-4601-937e-2c691821af3c'})
-     *
+     * ```
+     * ```js
      * vizEmbed.trigger(HostEvent.DownloadAsXlsx)
-     *
+     * ```
+     * ```js
      * searchEmbed.trigger(HostEvent.DownloadAsXlsx)
      * ```
-     * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
+     * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
      */
     HostEvent["DownloadAsXlsx"] = "downloadAsXLSX";
     /**
-     * Triggers the Share action on a liveboard or answer
+     * Triggers the **Share** action on an embedded
+     * Liveboard or Answer.
      *
      * @example
      * ```js
      * liveboardEmbed.trigger(HostEvent.Share)
-     *
+     * ```
+     * ```js
      * searchEmbed.trigger(HostEvent.Share)
      * ```
-     * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
+     * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
      */
     HostEvent["Share"] = "share";
     /**
-     * Trigger the Save action on a liveboard or answer
-     *
+     * Triggers the **Save**  action on a Liveboard or Answer.
+     * Saves the changes.
      * @example
      * ```js
      * liveboardEmbed.trigger(HostEvent.Save)
-     *
+     * ```
+     * ```js
      * searchEmbed.trigger(HostEvent.Save)
      * ```
-     * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
+     * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
      */
     HostEvent["Save"] = "save";
     /**
-     * Triggers the SyncToSheets action on visualization
-     *
-     * @param - an object with vizId as a key
+     * Triggers 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
      * liveboardEmbed.trigger(HostEvent.SyncToSheets, {vizId:
      * '730496d6-6903-4601-937e-2c691821af3c'})
-     *
+     * ```
+     * ```js
      * vizEmbed.trigger(HostEvent.SyncToSheets)
      * ```
-     * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
+     * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
      */
     HostEvent["SyncToSheets"] = "sync-to-sheets";
     /**
-     * Triggers the SyncToOtherApps action on visualization
-     *
+     * Triggers 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
      * liveboardEmbed.trigger(HostEvent.SyncToOtherApps, {vizId:
      * '730496d6-6903-4601-937e-2c691821af3c'})
-     *
+     * ```
+     * ```js
      * vizEmbed.trigger(HostEvent.SyncToOtherApps)
      * ```
-     * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
+     * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
      */
     HostEvent["SyncToOtherApps"] = "sync-to-other-apps";
     /**
-     * Triggers the ManagePipelines action on visualization
-     *
-     * @param - an object with vizId as a key
+     * Triggers 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
      * liveboardEmbed.trigger(HostEvent.ManagePipelines, {vizId:
      * '730496d6-6903-4601-937e-2c691821af3c'})
-     *
+     * ```
+     * ```js
      * vizEmbed.trigger(HostEvent.ManagePipelines)
      * ```
-     * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
+     * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
      */
     HostEvent["ManagePipelines"] = "manage-pipeline";
     /**
-     * Triggers the Reset search in answer
+     * Triggers the Reset search on the Search page
      *
      * @example
      * ```js
      * searchEmbed.trigger(HostEvent.ResetSearch)
      * ```
-     * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.0.1-sw
+     * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.0.1.sw
      */
     HostEvent["ResetSearch"] = "resetSearch";
+    /**
+     * Gets the currents visible and runtime filters applied on a Liveboard
+     *
+     * @example
+     * liveboardEmbed.trigger(HostEvent.GetFilters)
+     * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
+     */
+    HostEvent["GetFilters"] = "getFilters";
+    /**
+     * Updates the visible filters on the Liveboard.
+     *
+     * @param - filter: filter object containing column name and filter operation and values
+     * @example
+     *
+     * ```js
+     * liveboardEmbed.trigger(HostEvent.UpdateFilters, {
+     *  filter: { column: 'column name', oper: 'in', values: [1,2,3], is_mandatory: false }
+     * })
+     * ```
+     * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
+     */
+    HostEvent["UpdateFilters"] = "updateFilters";
+    /*
+     * Get Tab for the current Liveboard.
+     *
+     * @example
+     * ```js
+     * liveboardEmbed.trigger(HostEvent.GetTabs).then((tabDetails) => {
+     *   console.log(
+     *      tabDetails // TabDetails of current LB
+     *   );
+     * })
+     * ```
+     * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
+     */
+    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
+     * ```js
+     * liveboardEmbed.trigger(HostEvent.SetVisibleTabs, [
+     *  '430496d6-6903-4601-937e-2c691821af3c',
+     *  'f547ec54-2a37-4516-a222-2b06719af726'])
+     * ```
+     * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
+     */
+    HostEvent["SetVisibleTabs"] = "SetPinboardVisibleTabs";
+    /**
+     * Set the hidden tabs on a Liveboard.
+     *
+     * @param - an array of ids of Tabs to hide, the ids not passed
+     *          will be shown.
+     * @example
+     * ```js
+     * liveboardEmbed.trigger(HostEvent.SetHiddenTabs, [
+     *  '630496d6-6903-4601-937e-2c691821af3c',
+     *  'i547ec54-2a37-4516-a222-2b06719af726'])
+     * ```
+     * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
+     */
+    HostEvent["SetHiddenTabs"] = "SetPinboardHiddenTabs";
 })(HostEvent || (HostEvent = {}));
 /**
  * The different visual modes that the data sources panel within
@@ -1318,27 +1444,51 @@ export var Param;
     Param["DisableWorksheetChange"] = "disableWorksheetChange";
     Param["HideEurekaResults"] = "hideEurekaResults";
     Param["HideEurekaSuggestions"] = "hideEurekaSuggestions";
+    Param["HideLiveboardHeader"] = "hideLiveboardHeader";
+    Param["ShowLiveboardDescription"] = "showLiveboardDescription";
+    Param["ShowLiveboardTitle"] = "showLiveboardTitle";
+    Param["HiddenTabs"] = "hideTabs";
+    Param["VisibleTabs"] = "visibleTabs";
+    Param["HideTabPanel"] = "hideTabPanel";
 })(Param || (Param = {}));
 /**
- * The list of actions that can be performed on visual ThoughtSpot
- * entities, such as answers and Liveboards.
- *
- * This enum is used to specify the actions that could be disabled,
- * hidden or made visible.
- *
+ * ThoughtSpot application pages include actions and menu commands
+ * for various user-initiated operations. These actions are represented
+ * as enumeration members in the SDK. To show, hide, or disable
+ * 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', {
  *    ... // other options
- *    visibleActions: [Action.Save, Action.Explore],
- *    disableActions: [Action.Save],
- *    hiddenActions: [Action.Download], // Set either this or visibleActions
+ *    visibleActions: [Action.Save, Action.Edit, Action.Present, ActionAction.Explore],
+ *    disabledActions: [Action.Download],
+ *    //hiddenActions: [], // Set either this or visibleActions
  * })
  * ```
+ * @example
+ * ```js
+ * const embed = new LiveboardEmbed('#embed-container', {
+ *    ... // other options
+ *    //visibleActions: [],
+ *    disabledActions: [Action.Download],
+ *    hiddenActions: [Action.Edit, ActionAction.Explore],
+ * })
+ * ```
+
  */
 // eslint-disable-next-line no-shadow
 export var Action;
 (function (Action) {
+    /**
+     * The **Save** action on an Answer or Liveboard.
+     * Allows users to save the changes.
+     * @example
+     * ```js
+     * disabledActions: [Action.SaveAsView]
+     * ```
+     */
     Action["Save"] = "save";
     /**
      * @hidden
@@ -1348,27 +1498,137 @@ export var Action;
      * @hidden
      */
     Action["SaveUntitled"] = "saveUntitled";
+    /**
+    * The **Save as View** action on the Answer
+    * page. Saves an Answer as a View object.
+    *
+    * @example
+    * ```js
+    * disabledActions: [Action.SaveAsView]
+    * ```
+    */
     Action["SaveAsView"] = "saveAsView";
+    /**
+    * The **Make a copy** action on a Liveboard or Answer
+    * page.
+    * Creates a copy of the Liveboard, visualization,
+    * or Answer.
+    *
+    * @example
+    * ```js
+    * disabledActions: [Action.MakeACopy]
+    * ```
+    */
     Action["MakeACopy"] = "makeACopy";
+    /**
+    * The **Copy and Edit** action on a Liveboard.
+    * This action is now replaced with `Action.MakeACopy`.
+    *
+    * @example
+    * ```js
+    * disabledActions: [Action.EditACopy]
+    * ```
+    */
     Action["EditACopy"] = "editACopy";
+    /**
+    * The **Copy link** menu action on a Liveboard visualization.
+    * Copies the visualization URL
+    * @example
+    * ```js
+    * disabledActions: [Action.CopyLink]
+    * ```
+    */
     Action["CopyLink"] = "embedDocument";
     /**
      * @hidden
      */
     Action["ResetLayout"] = "resetLayout";
+    /**
+    * The **Schedule** menu action on a Liveboard.
+    * Allows scheduling a Liveboard notification.
+    * @example
+    * ```js
+    * disabledActions: [Action.Schedule]
+    * ```
+    */
     Action["Schedule"] = "subscription";
+    /**
+    * The **Manage schedules** menu action on a Liveboard.
+    * Allows users to manage scheduled Liveboard jobs.
+    * @example
+    * ```js
+    * disabledActions: [Action.SchedulesList]
+    * ```
+    */
     Action["SchedulesList"] = "schedule-list";
+    /**
+    * 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]
+    * ```
+    */
     Action["Share"] = "share";
+    /**
+    * 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]
+    * ```
+    */
     Action["AddFilter"] = "addFilter";
+    /**
+    * 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]
+    * ```
+    */
     Action["ConfigureFilter"] = "configureFilter";
     Action["CollapseDataSources"] = "collapseDataSources";
+    /**
+    * The **Choose sources** button on Search page.
+    * Allows selecting data sources for search queries.
+    * @example
+    * ```js
+    * disabledActions: [Action.ChooseDataSources]
+    * ```
+    */
     Action["ChooseDataSources"] = "chooseDataSources";
+    /**
+    * The **Create formula** action on a Search or Answer page.
+    * Allows adding formulas to an Answer.
+    * @example
+    * ```js
+    * disabledActions: [Action.AddFormula]
+    * ```
+    */
     Action["AddFormula"] = "addFormula";
+    /**
+    * The **Add parameter** action on a Liveboard or Answer.
+    * Allows adding Parameters to a Liveboard or Answer.
+    * @example
+    * ```js
+    * disabledActions: [Action.AddParameter]
+    * ```
+    */
     Action["AddParameter"] = "addParameter";
     /**
      * @hidden
      */
     Action["SearchOnTop"] = "searchOnTop";
+    /**
+    * The **SpotIQ analyze** menu action on a visualization or
+    * Answer page.
+    * @example
+    * ```js
+    * disabledActions: [Action.SpotIQAnalyze]
+    * ```
+    */
     Action["SpotIQAnalyze"] = "spotIQAnalyze";
     /**
      * @hidden
@@ -1383,24 +1643,150 @@ export var Action;
      * @hidden
      */
     Action["ReplaySearch"] = "replaySearch";
+    /**
+    * The **Show underlying data** menu action on a visualization or
+    * Answer page.
+    * @example
+    * ```js
+    * disabledActions: [Action.ShowUnderlyingData]
+    * ```
+    */
     Action["ShowUnderlyingData"] = "showUnderlyingData";
+    /**
+    * The **Download** menu action on Liveboard visualizations
+    * and Answers.
+    * Allows downloading a visualization or Answer.
+    * @example
+    * ```js
+    * disabledActions: [Action.DownloadAsPng]
+    * ```
+    */
     Action["Download"] = "download";
+    /**
+    * 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]
+    * ```
+    */
     Action["DownloadAsPng"] = "downloadAsPng";
+    /**
+    * The **Download** > **PDF** menu action on a Liveboard.
+    * Downloads a visualization or Answer as a PDF file.
+    * @example
+    * ```js
+    * disabledActions: [Action.DownloadAsPdf]
+    * ```
+    */
     Action["DownloadAsPdf"] = "downloadAsPdf";
+    /**
+    * 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]
+    * ```
+    */
     Action["DownloadAsCsv"] = "downloadAsCSV";
+    /**
+    * 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]
+    * ```
+    */
     Action["DownloadAsXlsx"] = "downloadAsXLSX";
     /**
      * @hidden
      */
     Action["DownloadTrace"] = "downloadTrace";
+    /**
+    * 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]
+    * ```
+    */
     Action["ExportTML"] = "exportTSL";
+    /**
+    * The **Import TML** menu action for Liveboards and Answers.
+    * Imports TML representation of ThoughtSpot objects.
+    * @example
+    * ```js
+    * disabledActions: [Action.ImportTML]
+    * ```
+    */
     Action["ImportTML"] = "importTSL";
+    /**
+     * The **Update TML** menu action for Liveboards and Answers.
+     * Update TML representation of ThoughtSpot objects.
+     * @example
+     * ```js
+     * disabledActions: [Action.UpdateTML]
+     * ```
+     */
     Action["UpdateTML"] = "updateTSL";
+    /**
+     * The **Edit TML** menu action for Liveboards and Answers.
+     * Opens the TML editor.
+     * @example
+     * ```js
+     * disabledActions: [Action.EditTML]
+     * ```
+     */
     Action["EditTML"] = "editTSL";
+    /**
+    * The **Present** menu action for Liveboards and Answers.
+    * Allows presenting a Liveboard or visualization in
+    * slideshow mode.
+    * @example
+    * ```js
+    * disabledActions: [Action.Present]
+    * ```
+    */
     Action["Present"] = "present";
+    /**
+    * The tile resize options in the visualization menu.
+    * Allows switching between different preset layouts.
+    * @example
+    * ```js
+    * disabledActions: [Action.ToggleSize]
+    * ```
+    */
     Action["ToggleSize"] = "toggleSize";
+    /**
+    * 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]
+    * ```
+    */
     Action["Edit"] = "edit";
+    /**
+    * The text edit option for Liveboard and visualization titles.
+    * @example
+    * ```js
+    * disabledActions: [Action.EditTitle]
+    * ```
+    */
     Action["EditTitle"] = "editTitle";
+    /**
+    * The **Delete** menu action on Liveboards and visualizations.
+    * Deletes a Liveboard or a visualization from a Liveboard.
+    * @example
+    * ```js
+    * disabledActions: [Action.Remove]
+    * ```
+    */
     Action["Remove"] = "delete";
     /**
      * @hidden
@@ -1422,6 +1808,16 @@ export var Action;
      * @hidden
      */
     Action["PinboardInfo"] = "pinboardInfo";
+    /**
+    * The **Show Liveboard details** menu action on a Liveboard.
+    * Displays details such as the name, description, and
+    * author of the Liveboard, and timestamp of Liveboard creation
+    * and update.
+    * @example
+    * ```js
+    * disabledActions: [Action.LiveboardInfo]
+    * ```
+    */
     Action["LiveboardInfo"] = "pinboardInfo";
     /**
      * @hidden
@@ -1432,20 +1828,61 @@ export var Action;
      */
     Action["DownloadEmbraceQueries"] = "downloadEmbraceQueries";
     /**
-     * Pin action.
-     */
+    * The **Pin** menu action on an Answer or
+    * Search results page.
+    * @example
+    * ```js
+    * disabledActions: [Action.Pin]
+    * ```
+    */
     Action["Pin"] = "pin";
     /**
      * @hidden
      */
     Action["AnalysisInfo"] = "analysisInfo";
-    Action["Subscription"] = "subscription";
     /**
-     * Explore action.
+     * The **Schedule** menu action on a Liveboard.
+     * @example
+     * ```js
+     * disabledActions: [Action.Subscription]
+     * ```
      */
+    Action["Subscription"] = "subscription";
+    /**
+    * The **Explore** action on Liveboard visualizations
+    * @example
+    * ```js
+    * disabledActions: [Action.Explore]
+    * ```
+    */
     Action["Explore"] = "explore";
+    /**
+    * The action to include data points on a drilled-down Answer
+    * or visualization
+    * @example
+    * ```js
+    * disabledActions: [Action.DrillInclude]
+    * ```
+    */
     Action["DrillInclude"] = "context-menu-item-include";
+    /**
+     * The action to exclude data points on a drilled-down Answer
+     * or visualization
+     * @example
+     * ```js
+     * disabledActions: [Action.DrillInclude]
+     * ```
+     */
     Action["DrillExclude"] = "context-menu-item-exclude";
+    /**
+     * The **Copy to clipboard** menu action on tables in an Answer
+     * or Liveboard.
+     * Copies the selected data point.
+     * @example
+     * ```js
+     * disabledActions: [Action.CopyToClipboard]
+     * ```
+     */
     Action["CopyToClipboard"] = "context-menu-item-copy-to-clipboard";
     Action["CopyAndEdit"] = "context-menu-item-copy-and-edit";
     /**
@@ -1454,89 +1891,266 @@ export var Action;
     Action["DrillEdit"] = "context-menu-item-edit";
     Action["EditMeasure"] = "context-menu-item-edit-measure";
     Action["Separator"] = "context-menu-item-separator";
+    /**
+     * 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]
+     * ```
+     */
     Action["DrillDown"] = "DRILL";
+    /**
+     * The request access action on Liveboards.
+     * Allows users with view permissions to request edit access to a Liveboard.
+     * @example
+     * ```js
+     * disabledActions: [Action.RequestAccess]
+     * ```
+     */
     Action["RequestAccess"] = "requestAccess";
-    Action["QueryDetailsButtons"] = "queryDetailsButtons";
     /**
-     * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
+     * The **Query visualizer** and **Query SQL** buttons in Query details panel
+     * of the Answer page
+     * @example
+     * ```js
+     * disabledActions: [Action.QueryDetailsButtons]
+     * ```
+     */
+    Action["QueryDetailsButtons"] = "QueryDetailsButtons";
+    /**
+     * The **Delete** action for Answers.
+     * @example
+     * ```js
+     * disabledActions: [Action.AnswerDelete]
+     * ```
+     * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
      */
     Action["AnswerDelete"] = "onDeleteAnswer";
     /**
-     * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
+     * The Chart switcher icon on Answer and visualization pages.
+     * @example
+     * ```js
+     * disabledActions: [Action.AnswerChartSwitcher]
+     * ```
+     * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
      */
     Action["AnswerChartSwitcher"] = "answerChartSwitcher";
     /**
-     * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
+     * Favorites icon (*) on Answers, Liveboard, and Data pages
+     * @example
+     * ```js
+     * disabledActions: [Action.AddToFavorites]
+     * ```
+     * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
      */
     Action["AddToFavorites"] = "addToFavorites";
     /**
-     * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
+     * The edit icon on Liveboards (Classic experience).
+     * @example
+     * ```js
+     * disabledActions: [Action.EditDetails]
+     * ```
+     * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
      */
     Action["EditDetails"] = "editDetails";
     /**
-     * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
+     * The Create alert action on KPI charts.
+     * @example
+     * ```js
+     * disabledActions: [Action.CreateMonitor ]
+     * ```
+     * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
      */
     Action["CreateMonitor"] = "createMonitor";
     /**
-     * @version SDK: 1.11.1 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
+     * @example
+     * ```js
+     * disabledActions: [Action.ReportError]
+     * ```
+     * @version SDK: 1.11.1 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
      */
     Action["ReportError"] = "reportError";
+    /**
+     * The **Sync to sheets** action on Answers and Liveboard visualizations.
+     * Allows sending data to a Google Sheet.
+     * @example
+     * ```js
+     * disabledActions: [Action.SyncToSheets]
+     * ```
+     * @version SDK: 1.18.0| ThoughtSpot: 8.10.0.cl, 9.0.1.sw
+     */
     Action["SyncToSheets"] = "sync-to-sheets";
+    /**
+     * 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]
+     * ```
+     * @version SDK: 1.18.0| ThoughtSpot: 8.10.0.cl, 9.0.1.sw
+     */
     Action["SyncToOtherApps"] = "sync-to-other-apps";
+    /**
+     * 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]
+     * ```
+     * @version SDK: 1.18.0| ThoughtSpot: 8.10.0.cl, 9.0.1.sw
+     */
     Action["ManagePipelines"] = "manage-pipeline";
     /**
+     * The **Filter** action on Liveboard visualizations.
+     * Allows users to apply cross-filters on a Liveboard.
+     * @example
+     * ```js
+     * disabledActions: [Action.CrossFilter]
+     * ```
      * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
      */
     Action["CrossFilter"] = "context-menu-item-cross-filter";
     /**
+     * The **Remove** action that appears when cross filters are applied
+     * on a Liveboard.
+     * Removes filters applied o a visualization.
+     * @example
+     * ```js
+     * disabledActions: [Action.RemoveCrossFilter]
+     * ```
      * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
      */
     Action["RemoveCrossFilter"] = "context-menu-item-remove-cross-filter";
     /**
+     * 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]
+     * ```
      * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
      */
     Action["AxisMenuAggregate"] = "axisMenuAggregate";
     /**
+     * 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]
+     * ```
      * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
      */
     Action["AxisMenuTimeBucket"] = "axisMenuTimeBucket";
     /**
+     * The **Filter** action in the chart axis or table column
+     * customization menu.
+     * @example
+     * ```js
+     * disabledActions: [Action.AxisMenuFilter]
+     * ```
      * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
      */
     Action["AxisMenuFilter"] = "axisMenuFilter";
     /**
+     * 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]
+     * ```
      * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
      */
     Action["AxisMenuConditionalFormat"] = "axisMenuConditionalFormat";
     /**
+     * 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]
+     * ```
      * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
      */
     Action["AxisMenuSort"] = "axisMenuSort";
     /**
+     * The **Group** option in the chart axis or table column
+     * customization menu.
+     * Allows grouping data points if the axes use the same
+     * unit of measurement and a similar scale.
+     * @example
+     * ```js
+     * disabledActions: [Action.AxisMenuGroup]
+     * ```
      * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
      */
     Action["AxisMenuGroup"] = "axisMenuGroup";
     /**
+     * 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]
+     * ```
      * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
      */
     Action["AxisMenuPosition"] = "axisMenuPosition";
     /**
+     * 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]
+     * ```
      * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
      */
     Action["AxisMenuRename"] = "axisMenuRename";
     /**
+     * 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]
+     * ```
      * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
      */
     Action["AxisMenuEdit"] = "axisMenuEdit";
     /**
+     * The **Number format** action to customize the format of
+     * the data labels on a chart or table.
+     * @example
+     * ```js
+     * disabledActions: [Action.AxisMenuNumberFormat]
+     * ```
      * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
      */
     Action["AxisMenuNumberFormat"] = "axisMenuNumberFormat";
     /**
+     * The **Text wrapping** action on a table.
+     * Wraps or clips column text on a table.
+     * @example
+     * ```js
+     * disabledActions: [Action.AxisMenuTextWrapping]
+     * ```
      * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
      */
     Action["AxisMenuTextWrapping"] = "axisMenuTextWrapping";
     /**
+     * The **Remove** action in the chart axis or table column
+     * customization menu.
+     * Removes the data labels from a chart or the column of a
+     * table visualization.
+     * @example
+     * ```js
+     * disabledActions: [Action.AxisMenuRemove]
+     * ```
      * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
      */
     Action["AxisMenuRemove"] = "axisMenuRemove";
@@ -1545,9 +2159,31 @@ export var Action;
      */
     Action["InsertInToSlide"] = "insertInToSlide";
     /**
+     * The **Rename** menu action on Liveboards and visualizations.
+     * Allows renaming a Liveboard or visualization.
+     * @example
+     * ```js
+     * disabledActions: [Action.RenameModalTitleDescription]
+     * ```
      * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
      */
     Action["RenameModalTitleDescription"] = "renameModalTitleDescription";
+    /**
+     * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
+     */
+    Action["RequestVerification"] = "requestVerification";
+    /**
+     * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
+     */
+    Action["MarkAsVerified"] = "markAsVerified";
+    /**
+     * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
+     */
+    Action["AddTab"] = "addTab";
+    /**
+     * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
+     */
+    Action["EnableContextualChangeAnalysis"] = "enableContextualChangeAnalysis";
 })(Action || (Action = {}));
 // eslint-disable-next-line no-shadow
 export var OperationType;