@thoughtspot/visual-embed-sdk 1.35.10 → 1.35.11

package/lib/src/types.js

@@ -14,7 +14,7 @@
 export var AuthType;
 (function (AuthType) {
     /**
-     * No authentication on the SDK. Passthrough to the embedded App. Alias for
+     * No authentication on the SDK. Pass-through to the embedded App. Alias for
      * `Passthrough`.
      * @example
      * ```js
@@ -275,7 +275,7 @@ export var RuntimeFilterOp;
  * **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
+ * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
  */
 // eslint-disable-next-line no-shadow
 export var HomepageModule;
@@ -1088,7 +1088,7 @@ export var EmbedEvent;
      */
     EmbedEvent["Explore"] = "explore";
     /**
-     * Emitted when a user clicks **Copy link** action on a visualization
+     * 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
@@ -1138,23 +1138,26 @@ export var EmbedEvent;
      */
     EmbedEvent["FilterChanged"] = "filterChanged";
     /**
-     *  Emitted when a user clicks the **Go** button on the sage embed
-     * @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
+     *  Emitted when a user clicks the **Go** button to initiate
+     *  a Natural Language Search query
+     * @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
      */
     EmbedEvent["SageEmbedQuery"] = "sageEmbedQuery";
     /**
-     * Emitted when a user selects a data source on the sage embed
-     * @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
+     * Emitted when a user selects a data source on the embedded
+     * Natural Language Search interface.
+     *
+     * @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
      */
     EmbedEvent["SageWorksheetUpdated"] = "sageWorksheetUpdated";
     /**
      * Emitted when a user updates a connection on the **Data** page
-     * @version SDK : 1.27.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
+     * @version SDK : 1.27.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
      */
     EmbedEvent["UpdateConnection"] = "updateConnection";
     /**
      * Emitted when a user updates a connection on the **Data** page
-     * @version SDK : 1.27.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
+     * @version SDK : 1.27.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
      */
     EmbedEvent["CreateConnection"] = "createConnection";
     /**
@@ -1164,7 +1167,7 @@ export var EmbedEvent;
      * @returns viewId: string
      * @returns liveboardId: string
      * @returns isPublic: boolean
-     * @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
+     * @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
      */
     EmbedEvent["UpdatePersonalisedView"] = "updatePersonalisedView";
     /**
@@ -1173,7 +1176,7 @@ export var EmbedEvent;
      * @returns viewId: string
      * @returns liveboardId: string
      * @returns isPublic: boolean
-     * @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
+     * @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
      */
     EmbedEvent["SavePersonalisedView"] = "savePersonalisedView";
     /**
@@ -1182,28 +1185,28 @@ export var EmbedEvent;
      * @returns viewId: string
      * @returns liveboardId: string
      * @returns isPublic: boolean
-     * @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
+     * @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
      */
     EmbedEvent["ResetLiveboard"] = "resetLiveboard";
     /**
      * Emitted when a PersonalisedView is deleted.
      * @returns views: string[]
      * @returns liveboardId: string
-     * @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
+     * @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
      */
     EmbedEvent["DeletePersonalisedView"] = "deletePersonalisedView";
     /**
      * Emitted when a user creates a new worksheet
-     * @version SDK : 1.27.0 | Thoughtspot: 9.8.0.cl
+     * @version SDK : 1.27.0 | ThoughtSpot Cloud: 9.8.0.cl
      */
     EmbedEvent["CreateWorksheet"] = "createWorksheet";
     /**
-     * Emitted when Ask Sage is initialized.
+     * Emitted when the *Ask Sage* is initialized.
      * @returns viewName: string
      * @returns viewId: string
      * @returns liveboardId: string
      * @returns isPublic: boolean
-     * @version SDK : 1.29.0 | Thoughtspot: 9.12.0.cl
+     * @version SDK : 1.29.0 | ThoughtSpot Cloud: 9.12.0.cl
      */
     EmbedEvent["AskSageInit"] = "AskSageInit";
     /**
@@ -1231,7 +1234,7 @@ export var EmbedEvent;
      *
      * error: Developers can customize the error message text when `execute`
      * returns `false` using the error parameter in responder.
-     * @version SDK : 1.29.0 | Thoughtspot : 10.3.0.cl
+     * @version SDK : 1.29.0 | ThoughtSpot : 10.3.0.cl
      * @example
      *```js
      * .on(EmbedEvent.OnBeforeGetVizDataIntercept,
@@ -1279,7 +1282,7 @@ export var EmbedEvent;
      *     console.log('payload', payload);
      * })
      *```
-     * @version SDK : 1.29.0 | Thoughtspot : 10.3.0.cl
+     * @version SDK : 1.29.0 | ThoughtSpot : 10.3.0.cl
      */
     EmbedEvent["ParameterChanged"] = "parameterChanged";
 })(EmbedEvent || (EmbedEvent = {}));
@@ -1428,7 +1431,7 @@ export var HostEvent;
      * const url = embed.trigger(HostEvent.GetIframeUrl);
      * console.log("iFrameURL",url);
      * ```
-     * @version SDK: 1.35.0 | Thoughtspot: 10.4.0.cl
+     * @version SDK: 1.35.0 | ThoughtSpot: 10.4.0.cl
      */
     HostEvent["GetIframeUrl"] = "GetIframeUrl";
     /**
@@ -1461,6 +1464,11 @@ export var HostEvent;
      * attributes passed with this event are appended to the existing runtime
      * filters applied on a Liveboard.
      *
+     * **Note**: `HostEvent.UpdateRuntimeFilters` is supported in `LiveboardEmbed`
+     * and `AppEmbed` only. In full application embedding, this event updates
+     * the runtime filters applied on the Liveboard and saved Answer objects.
+     *
+     *
      * Pass an array of runtime filters with the following attributes:
      *
      * `columnName` - _String_. The name of the column to filter on.
@@ -1471,9 +1479,12 @@ export var HostEvent;
      * `values` - List of operands. Some operators such as EQ and LE allow a
      * single value, whereas BW and IN accept multiple values.
      *
-     * **Note**: `HostEvent.UpdateRuntimeFilters` is supported in `LiveboardEmbed`
-     * and `AppEmbed` only. In full application embedding, this event updates
-     * the runtime filters applied on the Liveboard and saved Answer objects.
+     * **Note**: Updating runtime filters resets the ThoughtSpot
+     * object to its original state and applies new filter conditions.
+     * Any user changes (like drilling into a visualization)
+     * will be cleared, restoring the original visualization
+     * with the updated filters.
+     *
      * @param - {@link RuntimeFilter}[] an array of {@link RuntimeFilter} Types.
      * @example
      * ```js
@@ -1488,7 +1499,7 @@ export var HostEvent;
     HostEvent["UpdateRuntimeFilters"] = "UpdateRuntimeFilters";
     /**
      * Navigate to a specific page in the embedded ThoughtSpot application.
-     * This is the same as calling `appEmbed.navigateToPage(path, true)`
+     * 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
@@ -1783,7 +1794,9 @@ export var HostEvent;
      */
     HostEvent["GetTML"] = "getTML";
     /**
-     * Trigger the **Show underlying data** action on visualization or search
+     * Trigger the **Show underlying data** action on a
+     * chart or table.
+     *
      * @param - an object with vizId as a key
      * @example
      * ```js
@@ -1817,8 +1830,8 @@ export var HostEvent;
      */
     HostEvent["Delete"] = "onDeleteAnswer";
     /**
-     * Trigger the **SpotIQ analyze** action on visualization
-     * or search.
+     * Trigger the **SpotIQ analyze** action on a
+     * chart or table.
      * @param - Liveboard embed takes `vizId` as a
      * key. Can be left undefined when embedding Search or
      * visualization.
@@ -2091,7 +2104,7 @@ export var HostEvent;
      *  '430496d6-6903-4601-937e-2c691821af3c',
      *  'f547ec54-2a37-4516-a222-2b06719af726'])
      * ```
-     * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
+     * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
      */
     HostEvent["SetVisibleTabs"] = "SetPinboardVisibleTabs";
     /**
@@ -2104,7 +2117,7 @@ export var HostEvent;
      *  '630496d6-6903-4601-937e-2c691821af3c',
      *  'i547ec54-2a37-4516-a222-2b06719af726'])
      * ```
-     * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
+     * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
      */
     HostEvent["SetHiddenTabs"] = "SetPinboardHiddenTabs";
     /**
@@ -2118,7 +2131,7 @@ export var HostEvent;
      *  executeSearch: true,
      * })
      * ```
-     * @version SDK: 1.26.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
+     * @version SDK: 1.26.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
      */
     HostEvent["UpdateSageQuery"] = "updateSageQuery";
     /**
@@ -2135,21 +2148,22 @@ export var HostEvent;
      * ```js
      * const {session} = await embed.trigger( HostEvent.GetAnswerSession )
      * ```
-     * @version SDK: 1.26.0 | Thoughtspot: 9.10.0.cl
+     * @version SDK: 1.26.0 | ThoughtSpot: 9.10.0.cl, 10.1.0.sw
      */
     HostEvent["GetAnswerSession"] = "getAnswerSession";
     /**
-     * Trigger Ask Sage for viz
+     * Trigger the *Ask Sage* action for visualizations
      * @example
      * ```js
      * liveboardEmbed.trigger(HostEvent.AskSage,
      * {vizId:'730496d6-6903-4601-937e-2c691821af3c'})
      * ```
-     * @version SDK: 1.29.0 | Thoughtspot: 9.12.0.cl
+     * @version SDK: 1.29.0 | ThoughtSpot Cloud: 9.12.0.cl
      */
     HostEvent["AskSage"] = "AskSage";
     /**
-     * Trigger cross filter update action on a Liveboard
+     * Trigger cross filter update action on a Liveboard.
+     *
      * @example
      * ```js
      * liveboardEmbed.trigger(HostEvent.UpdateCrossFilter, {
@@ -2160,7 +2174,7 @@ export var HostEvent;
      *    ],
      * });
      * ```
-     * @version SDK: 1.29.0 | Thoughtspot: 10.0.0.cl
+     * @version SDK: 1.29.0 | ThoughtSpot Cloud: 10.0.0.cl, 10.1.0.sw
      */
     HostEvent["UpdateCrossFilter"] = "UpdateCrossFilter";
     /**
@@ -2169,11 +2183,13 @@ export var HostEvent;
      * ```js
      * liveboardEmbed.trigger(HostEvent.ResetLiveboardPersonalisedView);
      * ```
-     * @version SDK: 1.29.0 | Thoughtspot: 10.1.0.cl
+     * @version SDK: 1.29.0 | ThoughtSpot Cloud: 10.1.0.cl, 10.1.0.sw
      */
     HostEvent["ResetLiveboardPersonalisedView"] = "ResetLiveboardPersonalisedView";
     /**
-     * Triggers an event to Update Parameter values for Answers and Liveboard
+     * Triggers an action to update Parameter values on embedded
+     * Answers and Liveboard.
+     *
      * @example
      * ```js
      * liveboardEmbed.trigger(HostEvent.UpdateParameters, [{
@@ -2181,30 +2197,30 @@ export var HostEvent;
      * value: "almond"
      * }])
      *
-     * @version SDK: 1.29.0 | Thoughtspot: 10.1.0.cl
+     * @version SDK: 1.29.0 | ThoughtSpot: 10.1.0.cl, 10.1.0.sw
      */
     HostEvent["UpdateParameters"] = "UpdateParameters";
     /**
-     * Triggers GetParameters to fetch the runtime parameters
+     * Triggers GetParameters to fetch the runtime Parameters.
      * ```js
      * liveboardEmbed.trigger(HostEvent.GetParameters).then((parameter) => {
      *  console.log('parameters', parameter);
      * });
      *```
-     * @version SDK: 1.29.0 | Thoughtspot: 10.1.0.cl
+     * @version SDK: 1.29.0 | ThoughtSpot: 10.1.0.cl, 10.1.0.sw
      */
     HostEvent["GetParameters"] = "GetParameters";
     /**
-     * Triggers an event to update a persoanlised view of a Liveboard
+     * Triggers an event to update a personalized view of a Liveboard.
      * ```js
      * liveboardEmbed.trigger(HostEvent.UpdatePersonalisedView, {viewId: '1234'})
      * ```
-     * @version SDK: 1.36.0 | Thoughtspot: 10.6.0.cl
+     * @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
      */
     HostEvent["UpdatePersonalisedView"] = "UpdatePersonalisedView";
     /**
-     * Triggers the action to get the current view of the liveboard
-     * @version SDK: 1.36.0 | Thoughtspot: 10.6.0.cl
+     * Triggers the action to get the current view of the Liveboard.
+     * @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
      */
     HostEvent["SaveAnswer"] = "saveAnswer";
     /**
@@ -2431,7 +2447,8 @@ export var Action;
     Action["ResetLayout"] = "resetLayout";
     /**
      * The **Schedule** menu action on a Liveboard.
-     * Allows scheduling a Liveboard notification.
+     * Allows scheduling a Liveboard job, for example,
+     * sending periodic notifications.
      * @example
      * ```js
      * disabledActions: [Action.Schedule]
@@ -2473,7 +2490,7 @@ export var Action;
      * ```js
      * disabledActions: [Action.AddDataPanelObjects]
      * ```
-     * @version SDK: 1.32.0 | Thoughtspot: 10.0.0.cl
+     * @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl, 10.1.0.sw
      */
     Action["AddDataPanelObjects"] = "addDataPanelObjects";
     /**
@@ -2486,7 +2503,28 @@ export var Action;
      * ```
      */
     Action["ConfigureFilter"] = "configureFilter";
+    /**
+    * The **Collapse data sources** icon on the Search page.
+    * Collapses the panel showing data sources.
+    *
+    * @example
+    * ```js
+    * disabledActions: [Action.CollapseDataPanel]
+    * ```
+    * @version: SDK: 1.1.0 | ThoughtSpot Cloud: ts7.may.cl, 8.4.1.sw
+    */
     Action["CollapseDataSources"] = "collapseDataSources";
+    /**
+    * The **Collapse data panel** icon on the Search page.
+    * Collapses the data panel view.
+    *
+    * @version: SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl, 10.7.0.sw
+    *
+    * @example
+    * ```js
+    * disabledActions: [Action.CollapseDataPanel]
+    * ```
+    */
     Action["CollapseDataPanel"] = "collapseDataPanel";
     /**
      * The **Choose sources** button on Search page.
@@ -2522,7 +2560,7 @@ export var Action;
      * ```js
      * disabledActions: [Action.AddColumnSet]
      * ```
-     * @version SDK: 1.32.0 | Thoughtspot: 10.0.0.cl
+     * @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl, 10.1.0.sw
      */
     Action["AddColumnSet"] = "addSimpleCohort";
     /**
@@ -2532,7 +2570,7 @@ export var Action;
      * ```js
      * disabledActions: [Action.AddQuerySet]
      * ```
-     * @version SDK: 1.32.0 | Thoughtspot: 10.0.0.cl
+     * @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl, 10.1.0.sw
      */
     Action["AddQuerySet"] = "addAdvancedCohort";
     /**
@@ -2564,6 +2602,8 @@ export var Action;
     /**
      * The **Show underlying data** menu action on a visualization or
      * Answer page.
+     * Displays detailed information and raw data
+     * for a given visualization.
      * @example
      * ```js
      * disabledActions: [Action.ShowUnderlyingData]
@@ -2765,6 +2805,7 @@ export var Action;
     Action["AnalysisInfo"] = "analysisInfo";
     /**
      * The **Schedule** menu action on a Liveboard.
+     * Allows scheduling a Liveboard job.
      * @example
      * ```js
      * disabledActions: [Action.Subscription]
@@ -2834,8 +2875,13 @@ export var Action;
      */
     Action["RequestAccess"] = "requestAccess";
     /**
-     * The **Query visualizer** and **Query SQL** buttons in Query details panel
-     * of the Answer page
+     * The **Query visualizer** and **Query SQL** buttons in
+     * Query details panel of the Answer page.
+     *
+     * **Query visualizer** - Displays the tables
+     * and filters used in a search query.
+     * **Query SQL** - Displays the SQL statements used
+     * in a search query to fetch data.
      * @example
      * ```js
      * disabledActions: [Action.QueryDetailsButtons]
@@ -2853,7 +2899,10 @@ export var Action;
      */
     Action["AnswerDelete"] = "onDeleteAnswer";
     /**
-     * The Chart switcher icon on Answer and visualization pages.
+     * The chart switcher icon on Answer page and
+     * visualizations in edit mode.
+     * Allows switching to the table or chart mode
+     * when editing a visualization.
      * @example
      * ```js
      * disabledActions: [Action.AnswerChartSwitcher]
@@ -2862,7 +2911,10 @@ export var Action;
      */
     Action["AnswerChartSwitcher"] = "answerChartSwitcher";
     /**
-     * Favorites icon (*) on Answers, Liveboard, and Data pages
+     * The Favorites icon (*) for Answers,
+     * Liveboard, and data objects like Worksheet, Model,
+     * Tables and Views.
+     * Allows adding an object to the user’s favorites list.
      * @example
      * ```js
      * disabledActions: [Action.AddToFavorites]
@@ -2880,7 +2932,9 @@ export var Action;
      */
     Action["EditDetails"] = "editDetails";
     /**
-     * The Create alert action on KPI charts.
+     * The *Create alert* action for KPI charts.
+     * Allows users to schedule threshold-based alerts
+     * for KPI charts.
      * @example
      * ```js
      * disabledActions: [Action.CreateMonitor]
@@ -2936,7 +2990,7 @@ export var Action;
      * ```js
      * disabledActions: [Action.CrossFilter]
      * ```
-     * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
+     * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.8.0.sw
      */
     Action["CrossFilter"] = "context-menu-item-cross-filter";
     /**
@@ -2946,7 +3000,7 @@ export var Action;
      * ```js
      * disabledActions: [Action.SyncToSlack]
      * ```
-     * @version @version SDK : 1.32.0 | Thoughtspot: 10.1.0.cl
+     * @version @version SDK : 1.32.0 | ThoughtSpot Cloud: 10.1.0.cl
      */
     Action["SyncToSlack"] = "syncToSlack";
     /**
@@ -2956,7 +3010,7 @@ export var Action;
      * ```js
      * disabledActions: [Action.SyncToTeams]
      * ```
-     * @version @version SDK : 1.32.0 | Thoughtspot: 10.1.0.cl
+     * @version @version SDK : 1.32.0 | ThoughtSpot Cloud: 10.1.0.cl
      */
     Action["SyncToTeams"] = "syncToTeams";
     /**
@@ -2967,7 +3021,7 @@ export var Action;
      * ```js
      * disabledActions: [Action.RemoveCrossFilter]
      * ```
-     * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
+     * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
      */
     Action["RemoveCrossFilter"] = "context-menu-item-remove-cross-filter";
     /**
@@ -2978,7 +3032,7 @@ export var Action;
      * ```js
      * disabledActions: [Action.AxisMenuAggregate]
      * ```
-     * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
+     * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
      */
     Action["AxisMenuAggregate"] = "axisMenuAggregate";
     /**
@@ -2989,17 +3043,19 @@ export var Action;
      * ```js
      * disabledActions: [Action.AxisMenuTimeBucket]
      * ```
-     * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
+     * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
      */
     Action["AxisMenuTimeBucket"] = "axisMenuTimeBucket";
     /**
      * The **Filter** action in the chart axis or table column
      * customization menu.
+     * Allows adding, editing, or removing filters.
+     *
      * @example
      * ```js
      * disabledActions: [Action.AxisMenuFilter]
      * ```
-     * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
+     * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
      */
     Action["AxisMenuFilter"] = "axisMenuFilter";
     /**
@@ -3010,7 +3066,7 @@ export var Action;
      * ```js
      * disabledActions: [Action.AxisMenuConditionalFormat]
      * ```
-     * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
+     * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
      */
     Action["AxisMenuConditionalFormat"] = "axisMenuConditionalFormat";
     /**
@@ -3021,7 +3077,7 @@ export var Action;
      * ```js
      * disabledActions: [Action.AxisMenuConditionalFormat]
      * ```
-     * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
+     * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
      */
     Action["AxisMenuSort"] = "axisMenuSort";
     /**
@@ -3033,7 +3089,7 @@ export var Action;
      * ```js
      * disabledActions: [Action.AxisMenuGroup]
      * ```
-     * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
+     * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
      */
     Action["AxisMenuGroup"] = "axisMenuGroup";
     /**
@@ -3044,7 +3100,7 @@ export var Action;
      * ```js
      * disabledActions: [Action.AxisMenuPosition]
      * ```
-     * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
+     * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
      */
     Action["AxisMenuPosition"] = "axisMenuPosition";
     /**
@@ -3054,7 +3110,7 @@ export var Action;
      * ```js
      * disabledActions: [Action.AxisMenuRename]
      * ```
-     * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
+     * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
      */
     Action["AxisMenuRename"] = "axisMenuRename";
     /**
@@ -3065,7 +3121,7 @@ export var Action;
      * ```js
      * disabledActions: [Action.AxisMenuEdit]
      * ```
-     * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
+     * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
      */
     Action["AxisMenuEdit"] = "axisMenuEdit";
     /**
@@ -3075,7 +3131,7 @@ export var Action;
      * ```js
      * disabledActions: [Action.AxisMenuNumberFormat]
      * ```
-     * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
+     * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
      */
     Action["AxisMenuNumberFormat"] = "axisMenuNumberFormat";
     /**
@@ -3085,7 +3141,7 @@ export var Action;
      * ```js
      * disabledActions: [Action.AxisMenuTextWrapping]
      * ```
-     * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
+     * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
      */
     Action["AxisMenuTextWrapping"] = "axisMenuTextWrapping";
     /**
@@ -3097,7 +3153,7 @@ export var Action;
      * ```js
      * disabledActions: [Action.AxisMenuRemove]
      * ```
-     * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
+     * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
      */
     Action["AxisMenuRemove"] = "axisMenuRemove";
     /**
@@ -3111,26 +3167,27 @@ export var Action;
      * ```js
      * disabledActions: [Action.RenameModalTitleDescription]
      * ```
-     * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
+     * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl, 9.8.0.sw
      */
     Action["RenameModalTitleDescription"] = "renameModalTitleDescription";
     /**
-     *
+     * The *Request verification* action on a Liveboard.
+     * Initiates a request for Liveboard verification.
      * @example
      * ```js
      * disabledActions: [Action.RequestVerification]
      * ```
-     * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
+     * @version SDK: 1.25.0 | ThoughtSpot: 9.6.0.cl, 10.1.0.sw
      */
     Action["RequestVerification"] = "requestVerification";
     /**
      *
-     *Allows users to mark a Liveboard as verified.
+     * Allows users to mark a Liveboard as verified.
      * @example
      * ```js
      * disabledActions: [Action.MarkAsVerified]
      * ```
-     * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
+     * @version SDK: 1.25.0 | ThoughtSpot: 9.6.0.cl, 10.1.0.sw
      */
     Action["MarkAsVerified"] = "markAsVerified";
     /**
@@ -3140,7 +3197,7 @@ export var Action;
      * ```js
      * disabledActions: [Action.AddTab]
      * ```
-     * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
+     * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
      */
     Action["AddTab"] = "addTab";
     /**
@@ -3150,35 +3207,42 @@ export var Action;
      * ```js
      * disabledActions: [Action.EnableContextualChangeAnalysis]
      * ```
-     * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
+     * @version SDK: 1.25.0 | ThoughtSpot Cloud: 9.6.0.cl
      */
     Action["EnableContextualChangeAnalysis"] = "enableContextualChangeAnalysis";
     /**
+     * Action ID to hide or disable Natural Language Search query.
      *
      * @example
      * ```js
      * disabledActions: [Action.ShowSageQuery]
      * ```
-     * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
+     * @version SDK: 1.26.0 | ThoughtSpot Cloud: 9.7.0.cl
      */
     Action["ShowSageQuery"] = "showSageQuery";
     /**
+     *
+     * Action ID to hide or disable the edit option for the
+     * results generated from the
+     * Natural Language Search query.
      *
      * @example
      * ```js
      * disabledActions: [Action.EditSageAnswer]
      * ```
-     * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
+     * @version SDK: 1.26.0 | ThoughtSpot Cloud: 9.7.0.cl
      */
     Action["EditSageAnswer"] = "editSageAnswer";
     /**
+     * The feedback widget for AI-generated Answers.
+     * Allows users to send feedback on the Answers generated
+     * from a Natural Language Search query.
      *
-     *This action allows users to send feedback on AI-generated Answers.
      * @example
      * ```js
      * disabledActions: [Action.SageAnswerFeedback]
      * ```
-     * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
+     * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl
      */
     Action["SageAnswerFeedback"] = "sageAnswerFeedback";
     /**
@@ -3187,7 +3251,7 @@ export var Action;
      * ```js
      * disabledActions: [Action.ModifySageAnswer]
      * ```
-     * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
+     * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl
      */
     Action["ModifySageAnswer"] = "modifySageAnswer";
     /**
@@ -3200,7 +3264,10 @@ export var Action;
      */
     Action["MoveToTab"] = "onContainerMove";
     /**
-     * The **Manage Alertsb** menu action on KPI visualizations.
+     * The **Manage Alerts** menu action on KPI visualizations.
+     * Allows creating, viewing, and editing monitor
+     * alerts for a KPI chart.
+     *
      * @example
      * ```js
      * disabledActions: [Action.ManageMonitor]
@@ -3208,21 +3275,23 @@ export var Action;
      */
     Action["ManageMonitor"] = "manageMonitor";
     /**
-     * Action ID for Liveboard Personalised Views dropdown
+     * The Liveboard Personalised Views dropdown.
+     * Allows navigating to a personalized Liveboard View.
      *  @example
      * ```js
      * disabledActions: [Action.PersonalisedViewsDropdown]
      * ```
-     *  @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl
+     *  @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw
      */
     Action["PersonalisedViewsDropdown"] = "personalisedViewsDropdown";
     /**
-     * Action ID for Liveboard Users ( Recently Visited / social proof )
+     * Action ID for show or hide the user details on a
+     * Liveboard (Recently visited / social proof)
      *  @example
      * ```js
      * disabledActions: [Action.LiveboardUsers]
      * ```
-     *  @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl
+     *  @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw
      */
     Action["LiveboardUsers"] = "liveboardUsers";
     /**
@@ -3240,108 +3309,124 @@ export var Action;
      * hiddenAction: [Action.TML] // hide all TML actions
      * disabledActions: [Action.TML] // to disable all TML actions
      * ```
-     * @version SDK : 1.28.3 | Thoughtspot: 9.12.0.cl
+     * @version SDK : 1.28.3 | ThoughtSpot: 9.12.0.cl, 10.1.0.sw
      */
     Action["TML"] = "tml";
     /**
-     * Action ID for the create Liveboard option on the Liveboard list page
-     * and Pin modal
+     * The **Create Liveboard* action on
+     * the Liveboards page and the Pin modal.
+     * Allows users to create a Liveboard.
+     *
      * @example
      * ```js
      * hiddenAction: [Action.CreateLiveboard]
      * disabledActions: [Action.CreateLiveboard]
      * ```
-     * @version SDK: 1.32.0 | Thoughtspot: 10.1.0.cl
+     * @version SDK: 1.32.0 | ThoughtSpot: 10.1.0.cl, 10.1.0.sw
      */
     Action["CreateLiveboard"] = "createLiveboard";
     /**
-     * Action ID for to hide Verified Liveboard Banner
+     * Action ID for to hide or disable the
+     * Verified Liveboard banner.
      *  @example
      * ```js
      * hiddenAction: [Action.VerifiedLiveboard]
      * ```
-     *  @version SDK: 1.29.0 | Thoughtspot: 9.10.0.cl
+     *  @version SDK: 1.29.0 | ThoughtSpot: 9.10.0.cl, 10.1.0.sw
      */
     Action["VerifiedLiveboard"] = "verifiedLiveboard";
     /**
-     * Action ID for ask sage button
+     * The *Ask Sage* action for Answers and visualizations.
+     * Allows initiating a Natural Language Search query.
+     *
      *  @example
      * ```js
      * hiddenAction: [Action.AskAi]
      * ```
-     *  @version SDK: 1.29.0 | Thoughtspot: 9.12.0.cl
+     *  @version SDK: 1.29.0 | ThoughtSpot Cloud: 9.12.0.cl
      */
     Action["AskAi"] = "AskAi";
     /**
      * The **Add KPI to Watchlist** action on Home page watchlist.
+     * Adds a KPI chart to the watchlist on the Home page.
      * @example
      * ```js
      * disabledActions: [Action.AddToWatchlist]
      * ```
-     * @version SDK : 1.27.9 | Thoughtspot: 9.12.5.cl
+     * @version SDK : 1.27.9 | ThoughtSpot Cloud: 9.12.5.cl
      */
     Action["AddToWatchlist"] = "addToWatchlist";
     /**
      * The **Remove from watchlist** menu action on KPI watchlist.
+     * Removes a KPI chart from the watchlist on the Home page.
      * @example
      * ```js
      * disabledActions: [Action.RemoveFromWatchlist]
      * ```
-     * @version SDK : 1.27.9 | Thoughtspot: 9.12.5.cl
+     * @version SDK : 1.27.9 | ThoughtSpot: 9.12.5.cl
      */
     Action["RemoveFromWatchlist"] = "removeFromWatchlist";
     /**
-     * The **Organise Favourites** action on Homepage Favourite Module.
+     * The **Organize Favourites** action on Homepage
+     * *Favorites* module.
+     *
      * @example
      * ```js
      * disabledActions: [Action.OrganiseFavourites]
      * ```
-     * @version SDK : 1.32.0 | Thoughtspot: 10.0.0.cl
+     * @version SDK : 1.32.0 | ThoughtSpot: 10.0.0.cl
      */
     Action["OrganiseFavourites"] = "organiseFavourites";
     /**
-     * Action ID for AI Highlights button
+     * The **AI Highlights** action on a Liveboard.
+     *
      *  @example
      * ```js
      * hiddenAction: [Action.AIHighlights]
      * ```
-     *  @version SDK: 1.27.10 | Thoughtspot: 9.12.5.cl
+     *  @version SDK: 1.27.10 | ThoughtSpot Cloud: 9.12.5.cl
      */
     Action["AIHighlights"] = "AIHighlights";
     /**
-     * Action ID for edit the schedule action on schedule on homepage
+     * The *Edit* action on the *Liveboard Schedules* page
+     * (new Homepage experience).
+     * Allows editing Liveboard schedules.
+     *
      * @example
      * ```js
      * disabledActions: [Action.EditScheduleHomepage]
      * ```
-     *  @version SDK: 1.34.0 | Thoughtspot: 10.3.0.cl
+     *  @version SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
      */
     Action["EditScheduleHomepage"] = "editScheduleHomepage";
     /**
-     * Action ID for pause schedule action on schedule on homepage
+     * The *Pause* action on the *Liveboard Schedules* page
+     * Pauses a scheduled Liveboard job.
      * @example
      * ```js
      * disabledActions: [Action.PauseScheduleHomepage]
      * ```
-     *  @version SDK: 1.34.0 | Thoughtspot: 10.3.0.cl
+     *  @version SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
      */
     Action["PauseScheduleHomepage"] = "pauseScheduleHomepage";
     /**
-     * Action ID for view schedule run action on schedule on homepage
+     * The **View run history** action **Liveboard Schedules** page.
+     * Allows viewing schedule run history.
      * @example
      * ```js
      * disabledActions: [Action.ViewScheduleRunHomepage]
      * ```
-     *  @version SDK: 1.34.0 | Thoughtspot: 10.3.0.cl
+     *  @version SDK: 1.34.0 | ThoughtSpot: 10.3.0.cl
      */
     Action["ViewScheduleRunHomepage"] = "viewScheduleRunHomepage";
     /**
-     * Action ID for unsubscribe schedule action on schedule on homepage
+     * Action ID to hide or disable the
+     * unsubscribe option for Liveboard schedules.
      * @example
      * ```js
      * disabledActions: [Action.UnsubscribeScheduleHomepage]
      * ```
-     *  @version SDK: 1.34.0 | Thoughtspot: 10.3.0.cl
+     *  @version SDK: 1.34.0 | ThoughtSpot: 10.3.0.cl
      */
     Action["UnsubscribeScheduleHomepage"] = "unsubscribeScheduleHomepage";
     /**
@@ -3350,16 +3435,17 @@ export var Action;
      * ```js
      * disabledActions: [Action.ManageTags]
      * ```
-     * @version SDK : 1.34.0 | Thoughtspot: 10.3.0.cl
+     * @version SDK : 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
      */
     Action["ManageTags"] = "manageTags";
     /**
-     * Action ID for delete schedule action on schedule on homepage
+     * The **Delete** action on the **Liveboard Schedules* page.
+     * Deletes a Liveboard schedule.
      * @example
      * ```js
      * disabledActions: [Action.DeleteScheduleHomepage]
      * ```
-     *  @version SDK: 1.34.0 | Thoughtspot: 10.3.0.cl
+     *  @version SDK: 1.34.0 | ThoughtSpot: 10.3.0.cl
      */
     Action["DeleteScheduleHomepage"] = "deleteScheduleHomepage";
     /**
@@ -3368,7 +3454,7 @@ export var Action;
      * ```js
      * disabledActions: [Action.KPIAnalysisCTA]
      * ```
-     *  @version SDK: 1.34.0 | Thoughtspot: 10.3.0.cl
+     *  @version SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
      */
     Action["KPIAnalysisCTA"] = "kpiAnalysisCTA";
     /**
@@ -3377,61 +3463,73 @@ export var Action;
      * ```js
      * const disabledActions = [Action.DisableChipReorder]
      * ```
-     * @version SDK: 1.36.0 | Thoughtspot: 10.6.0.cl
+     * @version SDK: 1.36.0 | ThoughtSpot Cloud: 10.6.0.cl
      */
     Action["DisableChipReorder"] = "disableChipReorder";
     /**
-     * Action ID for Hide Irrelevant filters button
+     * Action ID to show, hide, or disable filters
+     * in a Liveboard tab.
+     *
      *  @example
      * ```js
      * hiddenAction: [Action.ChangeFilterVisibilityInTab]
      * ```
-     *  @version SDK: 1.36.0 | Thoughtspot: 10.6.0.cl
+     *  @version SDK: 1.36.0 | ThoughtSpot Cloud: 10.6.0.cl
      */
     Action["ChangeFilterVisibilityInTab"] = "changeFilterVisibilityInTab";
     /**
-     * Action ID for hide/disable Preview data button in spotter
+     * The **Preview data** button on the Spotter interface.
+     * Allows previewing the data used for Spotter queries.
+     *
      *  @example
      * ```js
      * hiddenAction: [Action.PreviewDataSpotter]
      * ```
-     *  @version SDK: 1.36.0 | Thoughtspot: 10.6.0.cl
+     *  @version SDK: 1.36.0 | ThoughtSpot Cloud: 10.6.0.cl
      */
     Action["PreviewDataSpotter"] = "previewDataSpotter";
     /**
-     * Action ID for hide/disable reset button in spotter
+     * The **Reset** link on the Spotter interface.
+     * Resets the conversation with Spotter.
+     *
      *  @example
      * ```js
      * hiddenAction: [Action.ResetSpotterChat]
      * ```
-     *  @version SDK: 1.36.0 | Thoughtspot: 10.6.0.cl
+     *  @version SDK: 1.36.0 | ThoughtSpot Cloud: 10.6.0.cl
      */
     Action["ResetSpotterChat"] = "resetSpotterChat";
     /**
-     * Action ID for hide/disable feedback in spotter
+     * Action ID for hide or disable the
+     * Spotter feedback widget.
+     *
      *  @example
      * ```js
      * hiddenAction: [Action.SpotterFeedback]
      * ```
-     *  @version SDK: 1.36.0 | Thoughtspot: 10.6.0.cl
+     *  @version SDK: 1.36.0 | ThoughtSpot Cloud: 10.6.0.cl
      */
     Action["SpotterFeedback"] = "spotterFeedback";
     /**
-     * Action ID for hide/disable editing previous prompt in spotter
+     * Action ID for hide or disable
+     * the previous prompt edit option in Spotter.
+     *
      *  @example
      * ```js
      * hiddenAction: [Action.EditPreviousPrompt]
      * ```
-     *  @version SDK: 1.36.0 | Thoughtspot: 10.6.0.cl
+     *  @version SDK: 1.36.0 | ThoughtSpot Cloud: 10.6.0.cl
      */
     Action["EditPreviousPrompt"] = "editPreviousPrompt";
     /**
-     * Action ID for hide/disable deleting previous prompt in spotter
+     * Action ID for hide or disable
+     * the previous prompt deletion option in Spotter.
+     *
      *  @example
      * ```js
      * hiddenAction: [Action.DeletePreviousPrompt]
      * ```
-     *  @version SDK: 1.36.0 | Thoughtspot: 10.6.0.cl
+     *  @version SDK: 1.36.0 | ThoughtSpot Cloud: 10.6.0.cl
      */
     Action["DeletePreviousPrompt"] = "deletePreviousPrompt";
     /**
@@ -3440,7 +3538,7 @@ export var Action;
      * ```js
      * hiddenAction: [Action.EditTokens]
      * ```
-     *  @version SDK: 1.36.0 | Thoughtspot: 10.6.0.cl
+     *  @version SDK: 1.36.0 | ThoughtSpot Cloud: 10.6.0.cl
      */
     Action["EditTokens"] = "editTokens";
 })(Action || (Action = {}));
@@ -3470,7 +3568,7 @@ export var LogLevel;
      *  logLevel: LogLevel.SILENT,
      * })
      * ```
-     * @version SDK: 1.26.7 | Thoughtspot: 9.10.0.cl
+     * @version SDK: 1.26.7 | ThoughtSpot Cloud: 9.10.0.cl
      */
     LogLevel["SILENT"] = "SILENT";
     /**
@@ -3482,7 +3580,7 @@ export var LogLevel;
      *  logLevel: LogLevel.ERROR,
      * })
      * ```
-     * @version SDK: 1.26.7 | Thoughtspot: 9.10.0.cl
+     * @version SDK: 1.26.7 | ThoughtSpot Cloud: 9.10.0.cl
      */
     LogLevel["ERROR"] = "ERROR";
     /**
@@ -3494,7 +3592,7 @@ export var LogLevel;
      *  logLevel: LogLevel.WARN,
      * })
      * ```
-     * @version SDK: 1.26.7 | Thoughtspot: 9.10.0.cl
+     * @version SDK: 1.26.7 | ThoughtSpot Cloud: 9.10.0.cl
      */
     LogLevel["WARN"] = "WARN";
     /**
@@ -3506,7 +3604,7 @@ export var LogLevel;
      *  logLevel: LogLevel.INFO,
      * })
      * ```
-     * @version SDK: 1.26.7 | Thoughtspot: 9.10.0.cl
+     * @version SDK: 1.26.7 | ThoughtSpot Cloud: 9.10.0.cl
      */
     LogLevel["INFO"] = "INFO";
     /**
@@ -3518,7 +3616,7 @@ export var LogLevel;
      *  logLevel: LogLevel.DEBUG,
      * })
      * ```
-     * @version SDK: 1.26.7 | Thoughtspot: 9.10.0.cl
+     * @version SDK: 1.26.7 | ThoughtSpot Cloud: 9.10.0.cl
      */
     LogLevel["DEBUG"] = "DEBUG";
     /**
@@ -3530,7 +3628,7 @@ export var LogLevel;
      *  logLevel: LogLevel.TRACE,
      * })
      * ```
-     * @version SDK: 1.26.7 | Thoughtspot: 9.10.0.cl
+     * @version SDK: 1.26.7 | ThoughtSpot Cloud: 9.10.0.cl
      */
     LogLevel["TRACE"] = "TRACE";
 })(LogLevel || (LogLevel = {}));