@thoughtspot/visual-embed-sdk 1.52.0 → 1.52.2-beta

package/cjs/src/types.js

@@ -844,6 +844,9 @@ var EmbedEvent;
     EmbedEvent["Download"] = "download";
     /**
      * Emitted when the download action is triggered on an Answer.
+     * Payload varies by context: {@link VizScopedRequest} (Search, Answer,
+     * Liveboard), {@link RequiredVizRequest} (Spotter, vizId required). trigger()
+     * accepts the union now; per-context enforced next release.
      *  Use start:true to subscribe to when download is initiated, or end:true to
      *  subscribe to when download is completed. Default is end:true.
      * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.4.0.sw
@@ -860,6 +863,9 @@ var EmbedEvent;
     EmbedEvent["DownloadAsPng"] = "downloadAsPng";
     /**
      * Emitted when the Download as PDF action is triggered on an Answer
+     * Payload varies by context: {@link VizScopedRequest} (Search, Answer; plus
+     * liveboardId on Liveboard), {@link RequiredVizRequest} (Spotter). trigger()
+     * accepts the union now; per-context enforced next release.
      *  Use start:true to subscribe to when download as PDF is initiated, or end:true to
      *  subscribe to when download as PDF is completed. Default is end:true.
      * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
@@ -876,6 +882,9 @@ var EmbedEvent;
     EmbedEvent["DownloadAsPdf"] = "downloadAsPdf";
     /**
      * Emitted when the Download as CSV action is triggered on an Answer.
+     * Payload varies by context: {@link VizScopedRequest} (Search, Answer,
+     * Liveboard), {@link RequiredVizRequest} (Spotter, vizId required). trigger()
+     * accepts the union now; per-context enforced next release.
      *  Use start:true to subscribe to when download as CSV is initiated, or end:true to
      *  subscribe to when download as CSV is completed. Default is end:true.
      * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
@@ -892,6 +901,9 @@ var EmbedEvent;
     EmbedEvent["DownloadAsCsv"] = "downloadAsCsv";
     /**
      * Emitted when the Download as XLSX action is triggered on an Answer.
+     * Payload varies by context: {@link VizScopedRequest} (Search, Answer,
+     * Liveboard), {@link RequiredVizRequest} (Spotter, vizId required). trigger()
+     * accepts the union now; per-context enforced next release.
      *  Use start:true to subscribe to when download as XLSX is initiated, or end:true to
      *  subscribe to when download as XLSX is completed. Default is end:true.
      * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
@@ -1170,6 +1182,9 @@ var EmbedEvent;
     EmbedEvent["Schedule"] = "subscription";
     /**
      * Emitted when a user clicks **Edit** on a Liveboard or visualization
+     * Payload varies by context: {@link VizScopedRequest} (Liveboard),
+     * {@link RequiredVizRequest} (Spotter, vizId required). trigger() accepts the
+     * union now; per-context enforced next release.
      * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
      * @example
      * ```js
@@ -2249,6 +2264,7 @@ var HostEvent;
      * the search query string.
      * Supported in `AppEmbed` and `SearchEmbed` deployments.
      * Includes the following properties:
+     * Payload: {@link SearchRequest}.
      * @param - Includes the following keys:
      * - `searchQuery`: Query string with search tokens.
      * - `dataSources`: Data source GUID to search on.
@@ -2276,6 +2292,9 @@ var HostEvent;
     HostEvent["Search"] = "search";
     /**
      * Triggers a drill on certain points of the specified column
+     * Payload: {@link DrillDownRequest}; in Liveboard context vizId is required
+     * ({@link RequiredVizRequest}). trigger() accepts the union now; per-context
+     * enforced next release.
      * Includes the following properties:
      * @param - Includes the following keys:
      * - `points`: An object containing `selectedPoints` and/or `clickedPoint`
@@ -2355,6 +2374,8 @@ var HostEvent;
     HostEvent["Reload"] = "reload";
     /**
      * Get iframe URL for the current embed view.
+     * Payload: none.
+     * Response: {@link GetIframeUrlResponse}.
      * @example
      * ```js
      * const url = embed.trigger(HostEvent.GetIframeUrl);
@@ -2373,6 +2394,7 @@ var HostEvent;
     HostEvent["GetIframeUrl"] = "GetIframeUrl";
     /**
      * Display specific visualizations on a Liveboard.
+     * Payload: `string[]`.
      * @param - An array of GUIDs of the visualization to show. The visualization IDs not passed
      *  in this parameter will be hidden.
      * @example
@@ -2395,6 +2417,7 @@ var HostEvent;
     HostEvent["SetVisibleVizs"] = "SetPinboardVisibleVizs";
     /**
      * Set a Liveboard tab as an active tab.
+     * Payload: {@link SetActiveTabRequest}.
      * @param - tabId - string of id of Tab to show
      * @example
      * ```js
@@ -2422,6 +2445,7 @@ var HostEvent;
      * and `AppEmbed` only. In full application embedding, this event updates
      * the runtime filters applied on the Liveboard and saved Answer objects.
      *
+     * Payload: {@link RuntimeFilter}[].
      * @param - Array of {@link RuntimeFilter} objects. Each item includes:
      * - `columnName`: Name of the column to filter on.
      * - `operator`: {@link RuntimeFilterOp} to apply. For more information, see
@@ -2463,6 +2487,7 @@ var HostEvent;
      * Accepts either a plain value or an object with `path`
      * and an optional `replace` flag.
      *
+     * Payload: `string` | `number` | {@link NavigateRequest}.
      * @param data - A string path, a numeric history delta, or an object
      *   `{ path: string | number, replace?: boolean }`.
      *   - `path` — the route to navigate to, or a history delta such as `1`
@@ -2490,6 +2515,9 @@ var HostEvent;
     /**
      * Open the filter panel for a particular column.
      * Works with Search and Liveboard embed.
+     * Payload: {@link OpenFilterRequest} (the cross-context superset). The
+     * accepted fields vary by context: {@link OpenFilterLiveboardRequest},
+     * {@link OpenFilterSpotterRequest}, {@link OpenFilterSearchRequest}.
      * @param - { columnId: string,
      *  name: string,
      *  type: ATTRIBUTE/MEASURE,
@@ -2572,6 +2600,7 @@ var HostEvent;
     /**
      * Open the parameter panel for a particular parameter on a Liveboard.
      * Mirrors {@link HostEvent.OpenFilter} for parameters.
+     * Payload: {@link OpenParameterRequest}.
      * @param - Includes the following keys:
      * - `parameter`: An object identifying the parameter to open, for
      *   example, `{ parameterId: '<parameter-GUID>' }`.
@@ -2603,6 +2632,7 @@ var HostEvent;
     HostEvent["OpenParameter"] = "openParameter";
     /**
      * Add columns to the current search query.
+     * Payload: `{ columnIds: string[] }`.
      * @param - { columnIds: string[] }
      * @example
      * ```js
@@ -2621,6 +2651,7 @@ var HostEvent;
     HostEvent["AddColumns"] = "addColumns";
     /**
      * Remove a column from the current search query.
+     * Payload: `{ columnId: string }`.
      * @param - { columnId: string }
      * @example
      * ```js
@@ -2645,6 +2676,8 @@ var HostEvent;
      * sorting, toggling of legends, and data drill down.
      * For more information, see
      * link:https://developers.thoughtspot.com/docs/fetch-data-and-report-apis#transient-lb-content[Liveboard data with unsaved changes].
+     * Payload: none.
+     * Response: {@link GetExportRequestForCurrentPinboardResponse}.
      * @example
      * ```js
      * liveboardEmbed.trigger(HostEvent.getExportRequestForCurrentPinboard).then(
@@ -2666,6 +2699,8 @@ var HostEvent;
      * requiring additional user input via the *Pin to Liveboard* modal, define
      * the following parameters:
      *
+     * Payload: {@link PinAnswerToLiveboardRequest}.
+     * Response: {@link PinAnswerToLiveboardResponse}.
      * @param - Includes the following keys:
      * - `vizId`: GUID of the saved Answer or Spotter visualization ID to pin to a
      * Liveboard.
@@ -2780,6 +2815,7 @@ var HostEvent;
     HostEvent["LiveboardInfo"] = "pinboardInfo";
     /**
      * Trigger the **Schedule** action on an embedded Liveboard.
+     * Payload: {@link VizScopedRequest}.
      * @example
      * ```js
      *  liveboardEmbed.trigger(HostEvent.Schedule)
@@ -2795,6 +2831,7 @@ var HostEvent;
     HostEvent["Schedule"] = "subscription";
     /**
      * Trigger the **Manage schedule** action on an embedded Liveboard
+     * Payload: {@link VizScopedRequest}.
      * @example
      * ```js
      *  liveboardEmbed.trigger(HostEvent.SchedulesList)
@@ -2811,6 +2848,7 @@ var HostEvent;
     /**
      * Trigger the **Export TML** action on an embedded Liveboard or
      * Answer.
+     * Payload: {@link VizScopedRequest}.
      * @example
      * ```js
      * liveboardEmbed.trigger(HostEvent.ExportTML)
@@ -2833,6 +2871,7 @@ var HostEvent;
     /**
      * Trigger the **Edit TML** action on an embedded Liveboard or
      * saved Answers in the full application embedding.
+     * Payload: {@link VizScopedRequest}.
      * @example
      * ```js
      * liveboardEmbed.trigger(HostEvent.EditTML)
@@ -2854,6 +2893,7 @@ var HostEvent;
     HostEvent["EditTML"] = "editTSL";
     /**
      * Trigger the **Update TML** action on an embedded Liveboard.
+     * Payload: {@link VizScopedRequest}.
      * @example
      * ```js
      * liveboardEmbed.trigger(HostEvent.UpdateTML)
@@ -2871,6 +2911,7 @@ var HostEvent;
      * Trigger the **Download PDF** action on an embedded Liveboard,
      * visualization or Answer.
      *
+     * Payload: {@link VizScopedRequest} plus optional `liveboardId`.
      * @param - `vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed.
      *
      * **NOTE**: The **Download** > **PDF** action is available on
@@ -2921,6 +2962,7 @@ var HostEvent;
     /**
      * Trigger the **AI Highlights** action on an embedded Liveboard
      *
+     * Payload: none.
      * @example
      * ```js
      * liveboardEmbed.trigger(HostEvent.AIHighlights)
@@ -2975,6 +3017,9 @@ var HostEvent;
     HostEvent["MakeACopy"] = "makeACopy";
     /**
      * Trigger the **Delete** action for a Liveboard.
+     * Payload varies by context: {@link RequiredVizRequest} (Liveboard, vizId
+     * required), {@link VizScopedRequest} (Search). trigger() accepts the union
+     * now; per-context enforced next release.
      * @example
      * ```js
      * appEmbed.trigger(HostEvent.Remove)
@@ -2989,6 +3034,7 @@ var HostEvent;
     HostEvent["Remove"] = "delete";
     /**
      * Trigger the **Explore** action on a visualization.
+     * Payload: {@link RequiredVizRequest}.
      * @param - an object with `vizId` as a key
      * @example
      * ```js
@@ -3008,6 +3054,7 @@ var HostEvent;
     /**
      * Trigger the **Create alert** action on a KPI chart
      * in a Liveboard or saved Answer.
+     * Payload: {@link VizScopedRequest}.
      * @param - an object with `vizId` as a key
      * @example
      * ```js
@@ -3039,6 +3086,7 @@ var HostEvent;
     /**
      * Trigger the **Manage alerts** action on a KPI chart
      * in a visualization or saved Answer.
+     * Payload: {@link VizScopedRequest}.
      * @param - an object with `vizId` as a key
      * @example
      * ```js
@@ -3076,6 +3124,7 @@ var HostEvent;
      * on a Liveboard.
      *
      * This event is not supported in visualization embed and search embed.
+     * Payload: {@link VizScopedRequest}.
      * @param - Object parameter. Includes the following keys:
      * - `vizId`: To trigger the action for a specific visualization in Liveboard embed,
      *   pass in `vizId` as a key. In Spotter embed, `vizId` refers to the Answer ID and
@@ -3118,6 +3167,7 @@ var HostEvent;
     HostEvent["Edit"] = "edit";
     /**
      * Trigger the **Copy link** action on a Liveboard or visualization
+     * Payload: {@link VizScopedRequest}.
      * @param - object - to trigger the action for a
      * specific visualization in Liveboard embed, pass in `vizId` as a key
      * @example
@@ -3163,6 +3213,7 @@ var HostEvent;
     HostEvent["CopyLink"] = "embedDocument";
     /**
      * Trigger the **Present** action on a Liveboard or visualization
+     * Payload: {@link VizScopedRequest}.
      * @param - object - to trigger the action for a specific visualization
      *  in Liveboard embed, pass in `vizId` as a key
      * @example
@@ -3208,6 +3259,8 @@ var HostEvent;
     HostEvent["Present"] = "present";
     /**
      * Get TML for the current search.
+     * Payload: {@link GetTMLRequest}.
+     * Response: `Record<string, any>`.
      * @example
      * ```js
      * searchEmbed.trigger(HostEvent.GetTML).then((tml) => {
@@ -3257,6 +3310,7 @@ var HostEvent;
      * Trigger the **Show underlying data** action on a
      * chart or table.
      *
+     * Payload: {@link VizScopedRequest}.
      * @param - an object with vizId as a key
      * @example
      * ```js
@@ -3290,6 +3344,7 @@ var HostEvent;
      * Trigger the **Delete** action for a visualization
      * in an embedded Liveboard, or a chart or table
      * generated from Search.
+     * Payload: {@link VizScopedRequest}.
      * @param - Liveboard embed takes an object with `vizId` as a key.
      * Can be left empty if embedding Search or visualization.
      * @example
@@ -3318,6 +3373,7 @@ var HostEvent;
     /**
      * Trigger the **SpotIQ analyze** action on a
      * chart or table.
+     * Payload: {@link VizScopedRequest}.
      * @param - Liveboard embed takes `vizId` as a
      * key. Can be left undefined when embedding Search or
      * visualization.
@@ -3380,6 +3436,7 @@ var HostEvent;
     /**
      * Trigger the **Download** > **PNG** action on
      * charts in the embedded view.
+     * Payload: {@link VizScopedRequest}.
      * @example
      * ```js
      * liveboardEmbed.trigger(HostEvent.DownloadAsPng,
@@ -3411,6 +3468,7 @@ var HostEvent;
     /**
      * Trigger the **Download** > **CSV**  action on tables in
      * the embedded view.
+     * Payload: {@link VizScopedRequest}.
      * @param - `vizId` refers to the Visualization ID in Spotter embed and is required in Spotter embed.
      * @example
      * ```js
@@ -3450,6 +3508,7 @@ var HostEvent;
     /**
      * Trigger the **Download** > **XLSX**  action on tables
      * in the embedded view.
+     * Payload: {@link VizScopedRequest}.
      * @param - `vizId` refers to the Visualization ID in Spotter embed and is required in Spotter embed.
      * @example
      * ```js
@@ -3489,6 +3548,7 @@ var HostEvent;
     /**
      * Trigger the **Share** action on an embedded
      * Liveboard or Answer.
+     * Payload: {@link VizScopedRequest}.
      * @example
      * ```js
      * liveboardEmbed.trigger(HostEvent.Share)
@@ -3515,6 +3575,7 @@ var HostEvent;
      * Trigger the **Save** action on a Liveboard, Answer, or Spotter.
      * Saves the changes.
      *
+     * Payload: {@link VizScopedRequest}.
      * @param - `vizId` refers to the Spotter Visualization Id used in Spotter embed.
      * It is required and can be retrieved from the data embed event.
      *
@@ -3566,6 +3627,7 @@ var HostEvent;
     /**
      * Trigger the **Sync to Sheets** action on an embedded visualization or Answer
      * Sends data from an Answer or Liveboard visualization to a Google sheet.
+     * Payload: {@link VizScopedRequest}.
      * @param - an object with `vizId` as a key
      * @example
      * ```js
@@ -3596,6 +3658,7 @@ var HostEvent;
      * Trigger the **Sync to Other Apps** action on an embedded visualization or Answer
      * Sends data from an Answer or Liveboard visualization to third-party apps such
      * as Slack, Salesforce, Microsoft Teams, ServiceNow and so on.
+     * Payload: {@link VizScopedRequest}.
      * @param - an object with vizId as a key
      * @example
      * ```js
@@ -3626,6 +3689,7 @@ var HostEvent;
      * Trigger the **Manage pipelines** action on an embedded
      * visualization or Answer.
      * Allows users to manage ThoughtSpot Sync pipelines.
+     * Payload: {@link VizScopedRequest}.
      * @param - an object with `vizId` as a key
      * @example
      * ```js
@@ -3654,6 +3718,7 @@ var HostEvent;
     HostEvent["ManagePipelines"] = "manage-pipeline";
     /**
      * Reset search operation on the Search or Answer page.
+     * Payload: none.
      * @example
      * ```js
      * searchEmbed.trigger(HostEvent.ResetSearch)
@@ -3681,10 +3746,18 @@ var HostEvent;
      * whole Liveboard.
      * The `applicability` attribute is available from SDK: 1.53.0 |
      * ThoughtSpot: 26.10.0.cl.
+     * Payload: {@link GetFiltersRequest}.
+     * Response: {@link GetFiltersResponse}.
      * @example
      * ```js
      * const data = await liveboardEmbed.trigger(HostEvent.GetFilters);
      *     console.log('data', data);
+     * // {
+     * //   liveboardFilters: [ ... ],
+     * //   runtimeFilters: [
+     * //     { columnName: "Region", operator: "IN", values: ["West"] }
+     * //   ]
+     * // }
      * ```
      * @example
      * ```js
@@ -3700,6 +3773,7 @@ var HostEvent;
     HostEvent["GetFilters"] = "getFilters";
     /**
      * Update one or several filters applied on a Liveboard.
+     * Payload: {@link UpdateFiltersRequest}.
      * @param - Includes the following keys:
      * - `filter`: A single filter object containing column name, filter operator, and
      * values.
@@ -3708,9 +3782,9 @@ var HostEvent;
      *
      * Each filter object must include the following attributes:
      *
-     * `column` - Name of the column to filter on.
+     * `columnName` - Name of the column to filter on.
      *
-     * `oper`  - Filter operator, for example, EQ, IN, CONTAINS.
+     * `operator`  - Filter operator, for example, EQ, IN, CONTAINS.
      *  For information about the supported filter operators,
      *  see link:https://developers.thoughtspot.com/docs/runtime-filters#rtOperator[Developer Documentation].
      *
@@ -3737,8 +3811,8 @@ var HostEvent;
      *
      * liveboardEmbed.trigger(HostEvent.UpdateFilters, {
      *     filter: {
-     *         column: "item type",
-     *         oper: "IN",
+     *         columnName: "item type",
+     *         operator: "IN",
      *         values: ["bags","shirts"]
      *        }
      *    });
@@ -3748,8 +3822,8 @@ var HostEvent;
      *
      * liveboardEmbed.trigger(HostEvent.UpdateFilters, {
      *     filter: {
-     *         column: "date",
-     *         oper: "EQ",
+     *         columnName: "date",
+     *         operator: "EQ",
      *         values: ["JULY","2023"],
      *         type: "MONTH_YEAR"
      *        }
@@ -3760,18 +3834,18 @@ var HostEvent;
      * ```js
      * liveboardEmbed.trigger(HostEvent.UpdateFilters, {
      *  filters: [{
-     *      column: "Item Type",
-     *      oper: 'IN',
+     *      columnName: "Item Type",
+     *      operator: 'IN',
      *      values: ["bags","shirts"]
      *  },
      *    {
-     *      column: "Region",
-     *      oper: 'IN',
+     *      columnName: "Region",
+     *      operator: 'IN',
      *      values: ["West","Midwest"]
      *  },
      *    {
-     *      column: "Date",
-     *      oper: 'EQ',
+     *      columnName: "Date",
+     *      operator: 'EQ',
      *      values: ["2023-07-31"],
      *      type: "EXACT_DATE"
      *    }]
@@ -3785,13 +3859,13 @@ var HostEvent;
      * ```js
      * liveboardEmbed.trigger(HostEvent.UpdateFilters, {
      *  filters: [{
-     *      column: "(Sample) Retail - Apparel::city",
-     *      oper: 'IN',
+     *      columnName: "(Sample) Retail - Apparel::city",
+     *      operator: 'IN',
      *      values: ["atlanta"]
      *  },
      *  {
-     *      column: "(Sample) Retail - Apparel::Region",
-     *      oper: 'IN',
+     *      columnName: "(Sample) Retail - Apparel::Region",
+     *      operator: 'IN',
      *      values: ["West","Midwest"]
      *  }]
      * });
@@ -3802,8 +3876,8 @@ var HostEvent;
      * import { ContextType } from '@thoughtspot/visual-embed-sdk';
      * liveboardEmbed.trigger(HostEvent.UpdateFilters, {
      *     filter: {
-     *         column: "item type",
-     *         oper: "IN",
+     *         columnName: "item type",
+     *         operator: "IN",
      *         values: ["shoes", "boots"]
      *     }
      * }, ContextType.Liveboard);
@@ -3813,8 +3887,8 @@ var HostEvent;
      * // Scope the filter to a specific Liveboard tab
      * liveboardEmbed.trigger(HostEvent.UpdateFilters, {
      *     filter: {
-     *         column: "item type",
-     *         oper: "IN",
+     *         columnName: "item type",
+     *         operator: "IN",
      *         values: ["bags", "shirts"],
      *         applicability: {
      *             level: "TAB",
@@ -3823,11 +3897,19 @@ var HostEvent;
      *     }
      * });
      * ```
+     * Use `columnName` and `operator` - the same spelling as
+     * {@link RuntimeFilter}. The older `column` and `oper` spellings are
+     * deprecated; they are still accepted, but pass only one spelling of each
+     * field, never both. To reapply the filter state captured from
+     * {@link EmbedEvent.FilterChanged}, use `convertFilterChangedToUpdateFiltersPayload`
+     * to convert its payload into the shape expected here.
      * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
      */
     HostEvent["UpdateFilters"] = "updateFilters";
     /**
      * Get tab details for the current Liveboard.
+     * Payload: none.
+     * Response: {@link GetTabsResponse}.
      * @example
      * ```js
      * liveboardEmbed.trigger(HostEvent.GetTabs).then((tabDetails) => {
@@ -3853,6 +3935,8 @@ var HostEvent;
     /**
      * Get group details for the current Liveboard.
      * Mirrors {@link HostEvent.GetTabs} for filter/parameter groups.
+     * Payload: none.
+     * Response: {@link GetGroupsResponse}.
      * @example
      * ```js
      * liveboardEmbed.trigger(HostEvent.GetGroups).then((groupDetails) => {
@@ -3877,6 +3961,7 @@ var HostEvent;
     HostEvent["GetGroups"] = "getGroups";
     /**
      * Set the visible tabs on a Liveboard.
+     * Payload: `string[]`.
      * @param - an array of ids of tabs to show, the IDs not passed
      *          will be hidden.
      * @example
@@ -3899,6 +3984,7 @@ var HostEvent;
     HostEvent["SetVisibleTabs"] = "SetPinboardVisibleTabs";
     /**
      * Set the hidden tabs on a Liveboard.
+     * Payload: `string[]`.
      * @param - an array of the IDs of the tabs to hide.
      * The IDs not passed will be shown.
      * @example
@@ -3927,6 +4013,8 @@ var HostEvent;
      * `getAnswerService()` method on the embed instance to get an AnswerService
      * object that provides a more convenient interface for working with answers.
      *
+     * Payload: {@link GetAnswerSessionRequest}.
+     * Response: {@link GetAnswerSessionResponse}.
      * @example
      * ```js
      * // Preferred way to get an AnswerService
@@ -3954,6 +4042,7 @@ var HostEvent;
     HostEvent["GetAnswerSession"] = "getAnswerSession";
     /**
      * Trigger the *Ask Sage* action for visualizations
+     * Payload: {@link RequiredVizRequest}.
      * @example
      * ```js
      * liveboardEmbed.trigger(HostEvent.AskSage,
@@ -3965,6 +4054,7 @@ var HostEvent;
     /**
      * Trigger cross filter update action on a Liveboard.
      *
+     * Payload: {@link UpdateCrossFilterRequest}.
      * @example
      * ```js
      * liveboardEmbed.trigger(HostEvent.UpdateCrossFilter, {
@@ -3980,7 +4070,9 @@ var HostEvent;
     HostEvent["UpdateCrossFilter"] = "UpdateCrossFilter";
     /**
      * Trigger reset action for a personalized Liveboard view.
-     * This event is deprecated. Use {@link HostEvent.ResetLiveboardPersonalizedView} instead.
+     * This event is deprecated.
+     * Use {@link HostEvent.ResetLiveboardPersonalizedView} instead.
+     * Payload: none.
      * @example
      * ```js
      * liveboardEmbed.trigger(HostEvent.ResetLiveboardPersonalisedView);
@@ -4001,6 +4093,7 @@ var HostEvent;
     /**
      * Triggers an action to update Parameter values on embedded
      * Answers, Liveboard, and Spotter answer in Edit mode.
+     * Payload: {@link RuntimeParameter}[].
      * @param - Includes the following keys for each item:
      * - `name`: Name of the parameter.
      * - `value`: The value to set for the parameter.
@@ -4058,6 +4151,8 @@ var HostEvent;
      * whole Liveboard.
      * The `applicability` attribute is available from SDK: 1.53.0 |
      * ThoughtSpot: 26.10.0.cl.
+     * Payload: none.
+     * Response: {@link GetParametersResponse}.
      * @param - `vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed.
      * ```js
      * liveboardEmbed.trigger(HostEvent.GetParameters).then((parameter) => {
@@ -4095,6 +4190,7 @@ var HostEvent;
      * ```js
      * liveboardEmbed.trigger(HostEvent.UpdatePersonalisedView, {viewId: '1234'})
      * ```
+     * Payload: {@link PersonalisedViewRequest} (`viewId` only).
      * @example
      * ```js
      * // Update personalized view from liveboard context
@@ -4127,6 +4223,7 @@ var HostEvent;
      * If neither is provided, the Liveboard resets to the original/default view.
      * When a `viewName` is provided and multiple views share
      * the same name, the first match is selected.
+     * Payload: {@link PersonalisedViewRequest}.
      * @example
      * ```js
      * liveboardEmbed.trigger(
@@ -4170,6 +4267,8 @@ var HostEvent;
      * If no parameters are specified, the save action is
      * triggered with a modal to prompt users to
      * add a name and description for the Answer.
+     * Payload: {@link SaveAnswerRequest}.
+     * Response: {@link SaveAnswerResponse}.
      * @param - Includes the following keys:
      * - `vizId`: Refers to the Answer ID in Spotter embed and is **required** in Spotter
      * embed.
@@ -4255,6 +4354,7 @@ var HostEvent;
     /**
      * Triggers a search operation with the search tokens specified in
      * the search query string in spotter embed.
+     * Payload: {@link SpotterSearchRequest}.
      * @param - Includes the following keys:
      * - `query`: Text string in Natural Language format.
      * - `executeSearch`: Boolean to execute search and update search query.
@@ -4279,6 +4379,7 @@ var HostEvent;
     HostEvent["SpotterSearch"] = "SpotterSearch";
     /**
      * Edits the last prompt in spotter embed.
+     * Payload: `string`.
      * @param - `query`: Text string
      * @example
      * ```js
@@ -4295,6 +4396,7 @@ var HostEvent;
     HostEvent["EditLastPrompt"] = "EditLastPrompt";
     /**
      * Opens the data source preview modal in Spotter Embed.
+     * Payload: none.
      * @example
      * ```js
      * spotterEmbed.trigger(HostEvent.PreviewSpotterData);
@@ -4330,6 +4432,7 @@ var HostEvent;
     HostEvent["DataModelInstructions"] = "DataModelInstructions";
     /**
      * Resets the Spotter Embed Conversation.
+     * Payload: none.
      * @example
      * ```js
      * spotterEmbed.trigger(HostEvent.ResetSpotterConversation);
@@ -4342,6 +4445,7 @@ var HostEvent;
      * `conversationId` is **mandatory** — you must pass the id of the
      * conversation to share. Also no-op when sharing is disabled
      * (enableShareConversation off) or when already in the read-only shared view.
+     * Payload: {@link ConversationScopedRequest}.
      * @example
      * ```js
      * spotterEmbed.trigger(HostEvent.ShareSpotterConversation, { conversationId: 'abc' });
@@ -4351,6 +4455,7 @@ var HostEvent;
     HostEvent["ShareSpotterConversation"] = "ShareSpotterConversation";
     /**
      * Closes the Spotter share-conversation modal. No-op if none is open.
+     * Payload: none.
      * @example
      * ```js
      * spotterEmbed.trigger(HostEvent.CloseSpotterShareConversation);
@@ -4360,6 +4465,7 @@ var HostEvent;
     HostEvent["CloseSpotterShareConversation"] = "CloseSpotterShareConversation";
     /**
      * Exits the read-only shared-conversation view.
+     * Payload: none.
      * @example
      * ```js
      * spotterEmbed.trigger(HostEvent.ExitSpotterSharedConversation);
@@ -4369,6 +4475,7 @@ var HostEvent;
     HostEvent["ExitSpotterSharedConversation"] = "ExitSpotterSharedConversation";
     /**
      * Deletes the last prompt in spotter embed.
+     * Payload: none.
      * @example
      * ```js
      * spotterEmbed.trigger(HostEvent.DeleteLastPrompt);
@@ -4378,6 +4485,7 @@ var HostEvent;
     HostEvent["DeleteLastPrompt"] = "DeleteLastPrompt";
     /**
      * Toggle the visualization to chart or table view.
+     * Payload: {@link RequiredVizRequest}.
      * @param - `vizId ` refers to the Visualization ID in Spotter embed and is required.
      * @example
      * ```js
@@ -4416,6 +4524,7 @@ var HostEvent;
     HostEvent["VisibleEmbedCoordinates"] = "visibleEmbedCoordinates";
     /**
      * Trigger the *Spotter* action for visualizations present on the liveboard's vizzes.
+     * Payload: {@link RequiredVizRequest}.
      * @param - `vizId` refers to the Visualization ID in Spotter embed and is required.
      * @example
      * ```js
@@ -4477,6 +4586,7 @@ var HostEvent;
      * instance. Contact your admin or ThoughtSpot Support to enable chat history on your
      * instance.
      *
+     * Payload: {@link ConversationScopedRequest}.
      * @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
      * @example
      * ```js
@@ -4494,6 +4604,7 @@ var HostEvent;
      * instance. Contact your admin or ThoughtSpot Support to enable chat history on your
      * instance.
      *
+     * Payload: {@link ConversationScopedRequest}.
      * @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
      * @example
      * ```js
@@ -4518,6 +4629,7 @@ var HostEvent;
      * Trigger the **Send Test Email** action in the Liveboard schedule modal.
      * Sends a test schedule email to self or all recipients.
      * Requires `isSendNowLiveboardSchedulingEnabled` to be enabled.
+     * Payload: {@link ScheduleEmailRequest}.
      * @example
      * ```js
      * liveboardEmbed.trigger(HostEvent.SendTestScheduleEmail, {
@@ -4536,6 +4648,7 @@ var HostEvent;
     HostEvent["SendTestScheduleEmail"] = "sendTestScheduleEmail";
     /**
      * Sends a user message (prompt) to the SpotterViz panel programmatically.
+     * Payload: `{ query: string }`.
      * @version SDK: 1.50.0 | ThoughtSpot Cloud: 26.7.0.cl
      * @param query - the prompt text to send.
      * @example
@@ -4548,6 +4661,7 @@ var HostEvent;
     HostEvent["SpotterVizSendUserMessage"] = "SpotterVizSendUserMessage";
     /**
      * Initializes a new SpotterViz conversation.
+     * Payload: none.
      * @version SDK: 1.50.0 | ThoughtSpot Cloud: 26.7.0.cl
      * @example
      * ```js
@@ -4557,6 +4671,7 @@ var HostEvent;
     HostEvent["InitSpotterVizConversation"] = "InitSpotterVizConversation";
     /**
      * Opens the SpotterViz panel.
+     * Payload: none.
      * @version SDK: 1.50.0 | ThoughtSpot Cloud: 26.7.0.cl
      * @example
      * ```js
@@ -4566,6 +4681,7 @@ var HostEvent;
     HostEvent["OpenSpotterVizPanel"] = "OpenSpotterVizPanel";
     /**
      * Closes the SpotterViz panel.
+     * Payload: none.
      * @version SDK: 1.50.0 | ThoughtSpot Cloud: 26.7.0.cl
      * @example
      * ```js
@@ -4576,6 +4692,7 @@ var HostEvent;
     /**
      * Clears browser cache and fetches new data for liveboard ChartViz Containers.
      * Requires `enableLiveboardDataCache` to be enabled.
+     * Payload: {@link ScheduleEmailRequest}.
      * @example
      * ```js
      * liveboardEmbed.trigger(HostEvent.RefreshLiveboardBrowserCache);
@@ -4771,8 +4888,8 @@ var Param;
     Param["IsStarterPromptsEnabled"] = "enableStarterPrompts";
     Param["UpdatedSpotterExperience"] = "updatedSpotterExperience";
     Param["SpotterDataSources"] = "spotterDataSources";
-    Param["AnalystId"] = "analystId";
     Param["OpenSpotterOnLiveboardByDefault"] = "openSpotterOnLiveboardByDefault";
+    Param["ShowAnswerEditPanel"] = "showAnswerEditPanel";
 })(Param = exports.Param || (exports.Param = {}));
 /**
  * ThoughtSpot application pages include actions and menu commands
@@ -6777,6 +6894,237 @@ var Action;
      * ```
      */
     Action["SpotterOnLiveboard"] = "spotterOnLiveboard";
+    /**
+     * Controls the visibility and disabled state of the "Chart Type" menu item
+     * in Chart Settings V2.
+     * @version SDK: 1.54.0 | ThoughtSpot Cloud: 26.11.0.cl
+     * @example
+     * ```js
+     * {
+     *     hiddenActions: [Action.ChartTypeSettings],
+     *     disabledActions: [Action.ChartTypeSettings],
+     * }
+     * ```
+     */
+    Action["ChartTypeSettings"] = "CHART_TYPE";
+    /**
+     * Controls the visibility and disabled state of the "Layout" menu item
+     * in Chart Settings V2.
+     * @version SDK: 1.54.0 | ThoughtSpot Cloud: 26.11.0.cl
+     * @example
+     * ```js
+     * {
+     *     hiddenActions: [Action.LayoutSettings],
+     *     disabledActions: [Action.LayoutSettings],
+     * }
+     * ```
+     */
+    Action["LayoutSettings"] = "LAYOUT";
+    /**
+     * Controls the visibility and disabled state of the "Column" menu item
+     * in Chart Settings V2.
+     * @version SDK: 1.54.0 | ThoughtSpot Cloud: 26.11.0.cl
+     * @example
+     * ```js
+     * {
+     *     hiddenActions: [Action.ColumnSettings],
+     *     disabledActions: [Action.ColumnSettings],
+     * }
+     * ```
+     */
+    Action["ColumnSettings"] = "COLUMN";
+    /**
+     * Controls the visibility and disabled state of the "Axis" menu item
+     * in Chart Settings V2.
+     * @version SDK: 1.54.0 | ThoughtSpot Cloud: 26.11.0.cl
+     * @example
+     * ```js
+     * {
+     *     hiddenActions: [Action.AxisSettings],
+     *     disabledActions: [Action.AxisSettings],
+     * }
+     * ```
+     */
+    Action["AxisSettings"] = "AXIS";
+    /**
+     * Controls the visibility and disabled state of the "Data Label" menu item
+     * in Chart Settings V2.
+     * @version SDK: 1.54.0 | ThoughtSpot Cloud: 26.11.0.cl
+     * @example
+     * ```js
+     * {
+     *     hiddenActions: [Action.DataLabelSettings],
+     *     disabledActions: [Action.DataLabelSettings],
+     * }
+     * ```
+     */
+    Action["DataLabelSettings"] = "DATA_LABEL";
+    /**
+     * Controls the visibility and disabled state of the "Tooltip" menu item
+     * in Chart Settings V2.
+     * @version SDK: 1.54.0 | ThoughtSpot Cloud: 26.11.0.cl
+     * @example
+     * ```js
+     * {
+     *     hiddenActions: [Action.TooltipSettings],
+     *     disabledActions: [Action.TooltipSettings],
+     * }
+     * ```
+     */
+    Action["TooltipSettings"] = "TOOLTIP";
+    /**
+     * Controls the visibility and disabled state of the "Legend" menu item
+     * in Chart Settings V2.
+     * @version SDK: 1.54.0 | ThoughtSpot Cloud: 26.11.0.cl
+     * @example
+     * ```js
+     * {
+     *     hiddenActions: [Action.LegendSettings],
+     *     disabledActions: [Action.LegendSettings],
+     * }
+     * ```
+     */
+    Action["LegendSettings"] = "LEGEND";
+    /**
+     * Controls the visibility and disabled state of the "Display" menu item
+     * in Chart Settings V2.
+     * @version SDK: 1.54.0 | ThoughtSpot Cloud: 26.11.0.cl
+     * @example
+     * ```js
+     * {
+     *     hiddenActions: [Action.DisplaySettings],
+     *     disabledActions: [Action.DisplaySettings],
+     * }
+     * ```
+     */
+    Action["DisplaySettings"] = "DISPLAY";
+    /**
+     * Controls the visibility and disabled state of the "Query Details" menu
+     * item in Chart Settings V2.
+     * @version SDK: 1.54.0 | ThoughtSpot Cloud: 26.11.0.cl
+     * @example
+     * ```js
+     * {
+     *     hiddenActions: [Action.QuerySettings],
+     *     disabledActions: [Action.QuerySettings],
+     * }
+     * ```
+     */
+    Action["QuerySettings"] = "QUERY_DETAILS";
+    /**
+     * Controls the visibility and disabled state of the "Custom Action" menu
+     * item in Chart Settings V2.
+     * @version SDK: 1.54.0 | ThoughtSpot Cloud: 26.11.0.cl
+     * @example
+     * ```js
+     * {
+     *     hiddenActions: [Action.CustomSettings],
+     *     disabledActions: [Action.CustomSettings],
+     * }
+     * ```
+     */
+    Action["CustomSettings"] = "CUSTOM_ACTION";
+    /**
+     * Controls the visibility and disabled state of the "Muze AI" menu item
+     * in Chart Settings V2.
+     * @version SDK: 1.54.0 | ThoughtSpot Cloud: 26.11.0.cl
+     * @example
+     * ```js
+     * {
+     *     hiddenActions: [Action.MuzeAiSettings],
+     *     disabledActions: [Action.MuzeAiSettings],
+     * }
+     * ```
+     */
+    Action["MuzeAiSettings"] = "MUZE_AI";
+    /**
+     * Controls the visibility and disabled state of the "R Analysis" menu item
+     * in Chart Settings V2.
+     * @version SDK: 1.54.0 | ThoughtSpot Cloud: 26.11.0.cl
+     * @example
+     * ```js
+     * {
+     *     hiddenActions: [Action.RAnalysisSettings],
+     *     disabledActions: [Action.RAnalysisSettings],
+     * }
+     * ```
+     */
+    Action["RAnalysisSettings"] = "R_ANALYSIS";
+    /**
+     * Controls the visibility and disabled state of the "Add to Collection" menu item.
+     * @version SDK: 1.52.1 | ThoughtSpot Cloud: 26.5.0.cl
+     * @example
+     * ```js
+     * {
+     *     hiddenActions: [Action.AddToCollection],
+     *     disabledActions: [Action.AddToCollection],
+     * }
+     * ```
+     */
+    Action["AddToCollection"] = "addToCollection";
+    /**
+     * Controls the visibility and disabled state of the "Create Collection" button.
+     * @version SDK: 1.52.1 | ThoughtSpot Cloud: 26.5.0.cl
+     * @example
+     * ```js
+     * {
+     *     hiddenActions: [Action.CreateCollection],
+     *     disabledActions: [Action.CreateCollection],
+     * }
+     * ```
+     */
+    Action["CreateCollection"] = "createCollection";
+    /**
+     * Controls the visibility and disabled state of the "Move" menu item in a
+     * Collection.
+     * @version SDK: 1.52.1 | ThoughtSpot Cloud: 26.5.0.cl
+     * @example
+     * ```js
+     * {
+     *     hiddenActions: [Action.MoveToCollection],
+     *     disabledActions: [Action.MoveToCollection],
+     * }
+     * ```
+     */
+    Action["MoveToCollection"] = "moveToCollection";
+    /**
+     * Controls the visibility and disabled state of the "Remove" menu item in a
+     * Collection.
+     * @version SDK: 1.52.1 | ThoughtSpot Cloud: 26.5.0.cl
+     * @example
+     * ```js
+     * {
+     *     hiddenActions: [Action.RemoveFromCollection],
+     *     disabledActions: [Action.RemoveFromCollection],
+     * }
+     * ```
+     */
+    Action["RemoveFromCollection"] = "removeFromCollection";
+    /**
+     * Controls the visibility and disabled state of the "Delete" menu item for a
+     * Collection.
+     * @version SDK: 1.52.1 | ThoughtSpot Cloud: 26.5.0.cl
+     * @example
+     * ```js
+     * {
+     *     hiddenActions: [Action.DeleteCollection],
+     *     disabledActions: [Action.DeleteCollection],
+     * }
+     * ```
+     */
+    Action["DeleteCollection"] = "deleteCollection";
+    /**
+     * Controls the visibility of the "Customize homepage" button on the
+     * embedded home page.
+     * @version SDK: 1.55.0 | ThoughtSpot Cloud: 26.12.0.cl
+     * @example
+     * ```js
+     * {
+     *     hiddenActions: [Action.CustomizeHomepage],
+     * }
+     * ```
+     */
+    Action["CustomizeHomepage"] = "customizeHomepage";
 })(Action = exports.Action || (exports.Action = {}));
 var PrefetchFeatures;
 (function (PrefetchFeatures) {