@thoughtspot/visual-embed-sdk 1.44.4 → 1.45.0

package/cjs/src/types.js

@@ -346,7 +346,11 @@ var HomepageModule;
 var ListPageColumns;
 (function (ListPageColumns) {
     /**
-     * Favourite
+     * Favorites
+     */
+    ListPageColumns["Favorites"] = "FAVOURITE";
+    /**
+     * @deprecated Use {@link ListPageColumns.Favorites} instead.
      */
     ListPageColumns["Favourite"] = "FAVOURITE";
     /**
@@ -365,6 +369,10 @@ var ListPageColumns;
      * Share
      */
     ListPageColumns["Share"] = "SHARE";
+    /**
+     * Verified badge/column
+     */
+    ListPageColumns["Verified"] = "VERIFIED";
 })(ListPageColumns = exports.ListPageColumns || (exports.ListPageColumns = {}));
 /**
  * Event types emitted by the embedded ThoughtSpot application.
@@ -581,7 +589,7 @@ var EmbedEvent;
     /**
      * An error has occurred. This event is fired for the following error types:
      *
-     * `API` - API call failure error.
+     * `API` - API call failure.
      * `FULLSCREEN` - Error when presenting a Liveboard or visualization in full screen
      * mode. `SINGLE_VALUE_FILTER` - Error due to multiple values in the single value
      * filter. `NON_EXIST_FILTER` - Error due to a non-existent filter.
@@ -1312,20 +1320,20 @@ var EmbedEvent;
     /**
      *
      * This event can be emitted to intercept search execution initiated by
-     * the users and implement the logic to allow or restrict search execution.
-     * You can can also show custom error text if the search query must be
+     * users and implement logic to allow or restrict search execution.
+     * You can also show custom error text if the search query must be
      * restricted due to your application or business requirements.
 
      * Prerequisite: Set `isOnBeforeGetVizDataInterceptEnabled` to `true`
      * for this embed event to get emitted.
-     * @param:payload The payload received from the embed related to the Data API call.
-     * @param:responder
-     * Contains elements that lets developers define whether ThoughtSpot
-     * should run the search, and if not, what error message
-     * should be shown to the user.
+     * @param - Includes the following event listener parameters:
+     * - `payload`: The payload received from the embed related to the Data API call.
+     * - `responder`: Contains elements that let developers define whether ThoughtSpot
+     *   should run the search, and if not, what error message
+     *   should be shown to the user.
      *
-     * `execute` - When execute returns `true`, the search will be run.
-     * When execute returns `false`, the search will not be executed.
+     * `execute` - When `execute` returns `true`, the search will be run.
+     * When `execute` returns `false`, the search will not be executed.
      *
      * `error` - Developers can customize the error message text when `execute`
      * is `false` using the `errorText` and `errorDescription` parameters in responder.
@@ -1497,7 +1505,7 @@ var EmbedEvent;
      *     console.log('payload', payload);
      * })
      * ```
-     * @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
+     * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
      */
     EmbedEvent["DataModelInstructions"] = "DataModelInstructions";
     /**
@@ -1716,14 +1724,14 @@ var HostEvent;
      * the search query string.
      * Supported in `AppEmbed` and `SearchEmbed` deployments.
      * Includes the following properties:
-     * @param - `searchQuery` - query string with search tokens
-     * @param - `dataSources` - Data source GUID to Search on
-     *                        - Although an array, only a single source
-     *                          is supported.
-     * @param - `execute` - executes search and updates the existing query
+     * @param - Includes the following keys:
+     * - `searchQuery`: Query string with search tokens.
+     * - `dataSources`: Data source GUID to search on.
+     *   Although an array, only a single source is supported.
+     * - `execute`: Executes search and updates the existing query.
      * @example
      * ```js
-     * searchembed.trigger(HostEvent.Search, {
+     * searchEmbed.trigger(HostEvent.Search, {
          searchQuery: "[sales] by [item type]",
          dataSources: ["cd252e5c-b552-49a8-821d-3eadaa049cca"],
          execute: true
@@ -1734,16 +1742,15 @@ var HostEvent;
     /**
      * Triggers a drill on certain points of the specified column
      * Includes the following properties:
-     * @param - points - an object containing selectedPoints/clickedPoints
-     * to drill to. For example, { selectedPoints: []}
-     * @param - columnGuid - Optional. GUID of the column to drill
-     * by. If not provided it will auto drill by the configured
-     *   column.
-     * @param - autoDrillDown - Optional. If true, the drill down will be
-     * done automatically on the most popular column.
-     * @param - vizId [TS >= 9.8.0] - Optional. The GUID of the visualization to drill
-     * in case of a Liveboard.
-     * @param - `vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed.
+     * @param - Includes the following keys:
+     * - `points`: An object containing `selectedPoints` and/or `clickedPoint`
+     *   to drill to. For example, `{ selectedPoints: [] }`.
+     * - `columnGuid`: Optional. GUID of the column to drill by. If not provided,
+     *   it will auto drill by the configured column.
+     * - `autoDrillDown`: Optional. If `true`, the drill down will be done automatically
+     *   on the most popular column.
+     * - `vizId` (TS >= 9.8.0): Optional. The GUID of the visualization to drill in case
+     *   of a Liveboard. In Spotter embed, `vizId` refers to the Answer ID and is **required**.
      * @example
      * ```js
      * searchEmbed.on(EmbedEvent.VizPointDoubleClick, (payload) => {
@@ -1836,14 +1843,12 @@ var HostEvent;
      * and `AppEmbed` only. In full application embedding, this event updates
      * the runtime filters applied on the Liveboard and saved Answer objects.
      *
-     * @param - Pass an array of {@link RuntimeFilter} with the following attributes:
-     * `columnName` - _String_. The name of the column to filter on.
-     *
-     * `operator` - {@link RuntimeFilterOp} to apply. For more information,
-     * see link:https://developers.thoughtspot.com/docs/?pageid=runtime-filters#rtOperator[Developer Documentation].
-     *
-     * `values` - List of operands. Some operators such as EQ and LE allow a
-     * single value, whereas BW and IN accept multiple values.
+     * @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
+     *   link:https://developers.thoughtspot.com/docs/runtime-filters#rtOperator[Developer Documentation].
+     * - `values`: List of operands. Some operators such as EQ and LE allow a single
+     *   value, whereas BW and IN accept multiple values.
      *
      * **Note**: Updating runtime filters resets the ThoughtSpot
      * object to its original state and applies new filter conditions.
@@ -1866,7 +1871,7 @@ var HostEvent;
     /**
      * Navigate to a specific page in the embedded ThoughtSpot application.
      * This is the same as calling `appEmbed.navigateToPage(path, true)`.
-     * @param - `path` - the path to navigate to to go forward or back. The path value can
+     * @param - `path` - the path to navigate to go forward or back. The path value can
      * be a number; for example, `1`, `-1`.
      * @example
      * ```js
@@ -1937,30 +1942,25 @@ var HostEvent;
      * for the Answer that the user is currently on
      * and a modal opens for Liveboard selection.
      * To add an Answer or visualization to a Liveboard programmatically without
-     * showing requiring additional user input via *Pin to Liveboard* modal, define
+     * requiring additional user input via the *Pin to Liveboard* modal, define
      * the following parameters:
      *
-     * @param
-     * `vizId`-  GUID of the saved Answer or Spotter visualization ID to pin to a Liveboard.
-     *  Optional when pinning a new chart or table generated from a Search query.
-     *  **Required** in Spotter Embed.
-     * @param
-     * `liveboardID` - GUID of the Liveboard to pin an Answer. If there is no Liveboard,
-     *  specify the `newLiveboardName` parameter to create a new Liveboard.
-     * @param
-     * `tabId` - GUID of the Liveboard tab. Adds the Answer to the Liveboard tab
-     *  specified in the code.
-     * @param
-     * `newVizName` - Name string for the Answer or visualization. If defined,
-     *  this parameter adds a new visualization object or creates a copy of the
-     *  Answer or visualization specified in `vizId`.
-     *  Required attribute.
-     * @param
-     * `newLiveboardName` - Name string for the Liveboard.
-     *  Creates a new Liveboard object with the specified name.
-     * @param
-     * `newTabName` - Name of the tab. Adds a new tab Liveboard specified
-     *  in the code.
+     * @param - Includes the following keys:
+     * - `vizId`: GUID of the saved Answer or Spotter visualization ID to pin to a Liveboard.
+     *   Optional when pinning a new chart or table generated from a Search query.
+     *   **Required** in Spotter Embed.
+     * - `liveboardId`: GUID of the Liveboard to pin an Answer. If there is no Liveboard,
+     *   specify the `newLiveboardName` parameter to create a new Liveboard.
+     * - `tabId`: GUID of the Liveboard tab. Adds the Answer to the Liveboard tab
+     *   specified in the code.
+     * - `newVizName`: Name string for the Answer or visualization. If defined,
+     *   this parameter adds a new visualization object or creates a copy of the
+     *   Answer or visualization specified in `vizId`.
+     *   Required.
+     * - `newLiveboardName`: Name string for the Liveboard.
+     *   Creates a new Liveboard object with the specified name.
+     * - `newTabName`: Name of the tab. Adds a new tab Liveboard specified
+     *   in the code.
      *
      * @example
      * ```js
@@ -2200,9 +2200,9 @@ var HostEvent;
      * on a Liveboard.
      *
      * This event is not supported in visualization embed and search embed.
-     * @param - object - To trigger the action for a specific visualization
-     * in Liveboard embed, pass in `vizId` as a key.
-     * @param - `vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed.
+     * @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 is **required**.
      *
      * @example
      * ```js
@@ -2569,10 +2569,9 @@ var HostEvent;
     HostEvent["GetFilters"] = "getFilters";
     /**
      * Update one or several filters applied on a Liveboard.
-     * @param - `filter`: a single filter object containing column name,
-     * filter operator, and values.
-     * @param - `filters`: multiple filter objects with column name, filter operator,
-     * and values for each.
+     * @param - Includes the following keys:
+     * - `filter`: A single filter object containing column name, filter operator, and values.
+     * - `filters`: Multiple filter objects with column name, filter operator, and values for each.
      *
      * Each filter object must include the following attributes:
      *
@@ -2698,8 +2697,9 @@ var HostEvent;
     HostEvent["SetHiddenTabs"] = "SetPinboardHiddenTabs";
     /**
      * Updates the search query string for Natural Language Search operations.
-     * @param - `queryString`: Text string in Natural Language format
-     * @param - `executeSearch`: Boolean to execute search and update search query
+     * @param - Includes the following keys:
+     * - `queryString`: Text string in Natural Language format.
+     * - `executeSearch`: Boolean to execute search and update search query.
      * @example
      * ```js
      * sageEmbed.trigger(HostEvent.UpdateSageQuery, {
@@ -2778,11 +2778,10 @@ var HostEvent;
     /**
      * Triggers an action to update Parameter values on embedded
      * Answers, Liveboard, and Spotter answer in Edit mode.
-     * @param - `name` - Name of the Parameter
-     * @param - `value` - The value to set for the Parameter.
-     *
-     * Optionally, to control the visibility of the Parameter chip,
-     * use the `isVisibleToUser` attribute when applying an override.
+     * @param - Includes the following keys for each item:
+     * - `name`: Name of the parameter.
+     * - `value`: The value to set for the parameter.
+     * - `isVisibleToUser`: Optional. To control the visibility of the parameter chip.
      *
      * @example
      * ```js
@@ -2840,11 +2839,10 @@ 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.
-     * @param - `vizId` refers to the Answer ID in Spotter embed
-     * and is required in Spotter embed.
-     * Optional attributes to set Answer properties include:
-     * @param - `name` - Name string for the Answer.
-     * @param - `description` - Description text for the Answer.
+     * @param - Includes the following keys:
+     * - `vizId`: Refers to the Answer ID in Spotter embed and is **required** in Spotter embed.
+     * - `name`: Optional. Name string for the Answer.
+     * - `description`: Optional. Description text for the Answer.
      * @example
      * ```js
      * const saveAnswerResponse = await searchEmbed.trigger(HostEvent.SaveAnswer, {
@@ -2893,8 +2891,9 @@ var HostEvent;
     /**
      * Triggers a search operation with the search tokens specified in
      * the search query string in spotter embed.
-     * @param - `query`: Text string in Natural Language format
-     * @param - `executeSearch`: Boolean to execute search and update search query
+     * @param - Includes the following keys:
+     * - `query`: Text string in Natural Language format.
+     * - `executeSearch`: Boolean to execute search and update search query.
      * @example
      * ```js
      * spotterEmbed.trigger(HostEvent.SpotterSearch, {
@@ -2941,7 +2940,7 @@ var HostEvent;
      * ```js
      * spotterEmbed.trigger(HostEvent.DataModelInstructions);
      * ```
-     * @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
+     * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
      */
     HostEvent["DataModelInstructions"] = "DataModelInstructions";
     /**
@@ -3026,7 +3025,7 @@ var HostEvent;
      */
     HostEvent["UpdateEmbedParams"] = "updateEmbedParams";
     /**
-     * Triggered when the embed is needed to be destroyed. This is used to clean up any embed related resources internally.
+     * Triggered when the embed needs to be destroyed. This is used to clean up any embed-related resources internally.
      * @example
      * ```js
      * liveboardEmbed.trigger(HostEvent.DestroyEmbed);
@@ -3034,11 +3033,12 @@ var HostEvent;
      * @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl
      */
     HostEvent["DestroyEmbed"] = "EmbedDestroyed";
-    /** Triggers a create new conversation operation in spotter embed.
-     * @example
-     * ```js
+    /**
+     * Triggers a new conversation in Spotter embed.
+     *
      * This feature is available only when chat history is enabled on your ThoughtSpot instance.
      * Contact your admin or ThoughtSpot Support to enable chat history on your instance.
+     *
      * @example
      * ```js
      * spotterEmbed.trigger(HostEvent.StartNewSpotterConversation);
@@ -3195,12 +3195,14 @@ var Param;
     Param["IsLiveboardStylingAndGroupingEnabled"] = "isLiveboardStylingAndGroupingEnabled";
     Param["IsLazyLoadingForEmbedEnabled"] = "isLazyLoadingForEmbedEnabled";
     Param["RootMarginForLazyLoad"] = "rootMarginForLazyLoad";
-    Param["LiveboardXLSXCSVDownload"] = "isLiveboardXLSXCSVDownloadEnabled";
     Param["isPNGInScheduledEmailsEnabled"] = "isPNGInScheduledEmailsEnabled";
+    Param["isLiveboardXLSXCSVDownloadEnabled"] = "isLiveboardXLSXCSVDownloadEnabled";
+    Param["isGranularXLSXCSVSchedulesEnabled"] = "isGranularXLSXCSVSchedulesEnabled";
     Param["isCentralizedLiveboardFilterUXEnabled"] = "isCentralizedLiveboardFilterUXEnabled";
     Param["isLinkParametersEnabled"] = "isLinkParametersEnabled";
     Param["EnablePastConversationsSidebar"] = "enablePastConversationsSidebar";
     Param["UpdatedSpotterChatPrompt"] = "updatedSpotterChatPrompt";
+    Param["IsThisPeriodInDateFiltersEnabled"] = "isThisPeriodInDateFiltersEnabled";
 })(Param = exports.Param || (exports.Param = {}));
 /**
  * ThoughtSpot application pages include actions and menu commands
@@ -3213,7 +3215,7 @@ var Param;
  * ```js
  * const embed = new LiveboardEmbed('#tsEmbed', {
  *    ... //other embed view config
- *    visibleActions: [Action.Save, Action.Edit, Action.Present, ActionAction.Explore],
+ *    visibleActions: [Action.Save, Action.Edit, Action.Present, Action.Explore],
  *    disabledActions: [Action.Download],
  *    //hiddenActions: [], // Set either this or visibleActions
  * })
@@ -3224,10 +3226,10 @@ var Param;
  *    ... //other embed view config
  *    //visibleActions: [],
  *    disabledActions: [Action.Download],
- *    hiddenActions: [Action.Edit, ActionAction.Explore],
+ *    hiddenActions: [Action.Edit, Action.Explore],
  * })
  * ```
- * See also link:https://developers.thoughtspot.com/docs/actions[Action IDs in the SDK]
+ * See also link:https://developers.thoughtspot.com/docs/actions[Developer Documentation].
  */
 var Action;
 (function (Action) {
@@ -3515,6 +3517,16 @@ var Action;
      * ```
      */
     Action["DownloadAsXlsx"] = "downloadAsXLSX";
+    /**
+     * The **Download Liveboard** menu action on a Liveboard.
+     * Allows downloading the entire Liveboard.
+     * @example
+     * ```js
+     * disabledActions: [Action.DownloadLiveboard]
+     * ```
+     * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
+     */
+    Action["DownloadLiveboard"] = "downloadLiveboard";
     /**
      * @hidden
      */
@@ -3734,13 +3746,15 @@ var Action;
      */
     Action["RequestAccess"] = "requestAccess";
     /**
-     * The **Query visualizer** and **Query SQL** buttons in
-     * Query details panel of the Answer page.
+     * Controls the display and availability of the **Query visualizer** and
+     * **Query SQL** buttons in the Query details panel on 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.
+     * **Query visualizer** - Displays the tables and filters used in the search query.
+     * **Query SQL** - Displays the SQL statements used to retrieve data for the query.
+     *
+     * Note: This action ID only affects the visibility of the buttons within the
+     * Query details panel. It does not control the visibility
+     * of the query details icon on the Answer page.
      * @example
      * ```js
      * disabledActions: [Action.QueryDetailsButtons]
@@ -3854,28 +3868,28 @@ var Action;
     Action["CrossFilter"] = "context-menu-item-cross-filter";
     /**
      * The **Sync to Slack** action on Liveboard visualizations.
-     * Allows sending data to third-party apps Slack
+     * Allows sending data to third-party apps like Slack.
      * @example
      * ```js
      * disabledActions: [Action.SyncToSlack]
      * ```
-     * @version @version SDK : 1.32.0 | ThoughtSpot Cloud: 10.1.0.cl
+     * @version SDK: 1.32.0 | ThoughtSpot Cloud: 10.1.0.cl
      */
     Action["SyncToSlack"] = "syncToSlack";
     /**
      * The **Sync to Teams** action on Liveboard visualizations.
-     * Allows sending data to third-party apps Team
+     * Allows sending data to third-party apps like Microsoft Teams.
      * @example
      * ```js
      * disabledActions: [Action.SyncToTeams]
      * ```
-     * @version @version SDK : 1.32.0 | ThoughtSpot Cloud: 10.1.0.cl
+     * @version SDK: 1.32.0 | ThoughtSpot Cloud: 10.1.0.cl
      */
     Action["SyncToTeams"] = "syncToTeams";
     /**
      * The **Remove** action that appears when cross filters are applied
      * on a Liveboard.
-     * Removes filters applied o a visualization.
+     * Removes filters applied to a visualization.
      * @example
      * ```js
      * disabledActions: [Action.RemoveCrossFilter]
@@ -4061,7 +4075,7 @@ var Action;
     Action["AddTab"] = "addTab";
     /**
      *
-     *Initiates contextual change analysis on KPI charts.
+     * Initiates contextual change analysis on KPI charts.
      * @example
      * ```js
      * disabledActions: [Action.EnableContextualChangeAnalysis]
@@ -4071,7 +4085,7 @@ var Action;
     Action["EnableContextualChangeAnalysis"] = "enableContextualChangeAnalysis";
     /**
      * Action ID to hide or disable Iterative Change Analysis option
-     * on contextual change analysis  Inisght charts context menu
+     * in the contextual change analysis Insight charts context menu.
      *
      * @example
      * ```js
@@ -4349,6 +4363,17 @@ var Action;
      *  @version SDK: 1.36.0 | ThoughtSpot Cloud: 10.6.0.cl
      */
     Action["ChangeFilterVisibilityInTab"] = "changeFilterVisibilityInTab";
+    /**
+     * The **Data model instructions** button on the Spotter interface.
+     * Allows opening the data model instructions modal.
+     *
+     *  @example
+     * ```js
+     * hiddenAction: [Action.DataModelInstructions]
+     * ```
+     *  @version SDK: 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
+     */
+    Action["DataModelInstructions"] = "DataModelInstructions";
     /**
      * The **Preview data** button on the Spotter interface.
      * Allows previewing the data used for Spotter queries.
@@ -4434,12 +4459,11 @@ var Action;
      */
     Action["CoverAndFilterOptionInPDF"] = "coverAndFilterOptionInPDF";
     /**
-     * Action ID for hide or disable the
-     * Spotter in conversation training widget.
-     * The Add to Coaching feature is currently in beta
-     * and is disabled by default on embed deployments.
-     * To enable this feature on your instance,
-     * contact ThoughtSpot Support.
+    * Action ID to hide or disable the Coaching workflow in Spotter conversations.
+    * When disabled, users cannot access **Add to Coaching** workflow in conversation.
+    * The **Add to Coaching** feature allows adding reference questions and
+    * business terms to improve Spotter’s responses. This feature is generally available
+    * (GA) from version 26.2.0.cl and enabled by default on embed deployments.
      *  @example
      * ```js
      * hiddenAction: [Action.InConversationTraining]
@@ -4515,6 +4539,55 @@ var Action;
      * @version SDK: 1.43.0 | ThoughtSpot Cloud: 10.15.0.cl
      */
     Action["LiveboardStylePanel"] = "liveboardStylePanel";
+    /**
+    * The **Publish** action for Liveboards, Answers and Models.
+    * Opens the publishing modal. It's a parent action for the
+    * **Manage Publishing** and **Unpublish** actions if the object
+    * is already published, otherwise appears standalone.
+    * @example
+    * ```js
+    * hiddenActions: [Action.Publish]
+    * disabledActions: [Action.Publish]
+    * ```
+    * @version SDK: 1.45.0 | ThoughtSpot Cloud: 26.2.0.cl
+    */
+    Action["Publish"] = "publish";
+    /**
+     * The **Manage Publishing** action for Liveboards, Answers and Models.
+     * Opens the same publishing modal as the **Publish** action.
+     * Appears as a child action to the **Publish** action if the
+     * object is already published.
+     * @example
+     * ```js
+     * hiddenActions: [Action.ManagePublishing]
+     * disabledActions: [Action.ManagePublishing]
+     * ```
+     * @version SDK: 1.45.0 | ThoughtSpot Cloud: 26.2.0.cl
+     */
+    Action["ManagePublishing"] = "managePublishing";
+    /**
+     * The **Unpublish** action for Liveboards, Answers and Models.
+     * Opens the unpublishing modal. Appears as a child action to
+     * the **Publish** action if the object is already published.
+     * @example
+     * ```js
+     * hiddenActions: [Action.Unpublish]
+     * disabledActions: [Action.Unpublish]
+     * ```
+     * @version SDK: 1.45.0 | ThoughtSpot Cloud: 26.2.0.cl
+     */
+    Action["Unpublish"] = "unpublish";
+    /**
+     * The **Parameterize** action for Tables and Connections.
+     * Opens the parameterization modal.
+     * @example
+     * ```js
+     * hiddenActions: [Action.Parameterize]
+     * disabledActions: [Action.Parameterize]
+     * ```
+     * @version SDK: 1.45.0 | ThoughtSpot Cloud: 26.2.0.cl
+     */
+    Action["Parameterize"] = "parameterise";
     /**
      * The **Move to Group** menu action on a Liveboard.
      * Allows moving a visualization to a different group.
@@ -4555,6 +4628,18 @@ var Action;
      * @version SDK: 1.44.0 | ThoughtSpot Cloud: 26.2.0.cl
      */
     Action["UngroupLiveboardGroup"] = "ungroupLiveboardGroup";
+    /**
+     * The **Include current period** checkbox for date filters.
+     * Controls the visibility and availability of the option to include
+     * the current time period in filter results.
+     * @example
+     * ```js
+     * hiddenActions: [Action.IncludeCurrentPeriod]
+     * disabledActions: [Action.IncludeCurrentPeriod]
+     * ```
+     * @version SDK: 1.45.0 | ThoughtSpot: 26.4.0.cl
+     */
+    Action["IncludeCurrentPeriod"] = "includeCurrentPeriod";
 })(Action = exports.Action || (exports.Action = {}));
 var PrefetchFeatures;
 (function (PrefetchFeatures) {
@@ -4699,31 +4784,19 @@ var ErrorDetailsTypes;
     ErrorDetailsTypes["NETWORK"] = "NETWORK";
 })(ErrorDetailsTypes = exports.ErrorDetailsTypes || (exports.ErrorDetailsTypes = {}));
 /**
- * Specific error codes for embedded component errors.
- *
- * These codes provide granular identification of errors that occur in embedded components.
- * They are returned in the {@link EmbedErrorDetailsEvent.code} property and allow for
- * precise error handling and debugging.
+ * Error codes for identifying specific issues in embedded ThoughtSpot components.
  *
- * The codes are organized into categories:
- * - **Worksheet ID not found or does not exist**: Errors related to applying or updating filters
- * - **Liveboard ID missing**: Errors related to missing liveboard ID
- * - **Conflicting actions configuration**: Errors related to conflicting actions configuration
- * - **Conflicting tabs configuration**: Errors related to conflicting tabs configuration
- * - **Initialization error**: Errors related to initialization error
- * - **Network error**: Errors related to network error
- * - **Custom action validation**: Errors related to custom action validation
- * - **Login failed**: Errors related to login failed
- * - **Render not called**: Errors related to render not called
- * - **Host event type undefined or invalid**: Errors related to host event type undefined or invalid
+ * Use these codes for precise error handling and debugging. Each code maps to a
+ * distinct failure scenario, enabling targeted recovery strategies.
  *
  * @version SDK: 1.44.2 | ThoughtSpot: 26.2.0.cl
  * @group Error Handling
+ *
  * @see {@link EmbedErrorDetailsEvent} - The error event object that includes these codes
  * @see {@link ErrorDetailsTypes} - General error type categories
  *
  * @example
- * Handle specific error codes
+ * Handle specific error codes in the error event handler
  *
  * embed.on(EmbedEvent.Error, (error) => {
  *   if (error.code === EmbedErrorCodes.WORKSHEET_ID_NOT_FOUND) {