@thoughtspot/visual-embed-sdk 1.35.10 → 1.35.12

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (133) hide show
  1. package/cjs/package.json +1 -1
  2. package/cjs/src/embed/app.d.ts +11 -2
  3. package/cjs/src/embed/app.d.ts.map +1 -1
  4. package/cjs/src/embed/app.js.map +1 -1
  5. package/cjs/src/embed/hostEventClient/contracts.d.ts +1 -1
  6. package/cjs/src/embed/hostEventClient/contracts.js +1 -1
  7. package/cjs/src/embed/liveboard.d.ts +7 -4
  8. package/cjs/src/embed/liveboard.d.ts.map +1 -1
  9. package/cjs/src/embed/liveboard.js +4 -3
  10. package/cjs/src/embed/liveboard.js.map +1 -1
  11. package/cjs/src/embed/liveboard.spec.js +17 -1
  12. package/cjs/src/embed/liveboard.spec.js.map +1 -1
  13. package/cjs/src/embed/searchEmbed-basic-auth.spec.d.ts +2 -0
  14. package/cjs/src/embed/searchEmbed-basic-auth.spec.d.ts.map +1 -0
  15. package/cjs/src/embed/searchEmbed-basic-auth.spec.js +104 -0
  16. package/cjs/src/embed/searchEmbed-basic-auth.spec.js.map +1 -0
  17. package/cjs/src/embed/ts-embed.d.ts.map +1 -1
  18. package/cjs/src/embed/ts-embed.js +5 -2
  19. package/cjs/src/embed/ts-embed.js.map +1 -1
  20. package/cjs/src/embed/ts-embed.spec.d.ts.map +1 -1
  21. package/cjs/src/embed/ts-embed.spec.js +110 -0
  22. package/cjs/src/embed/ts-embed.spec.js.map +1 -1
  23. package/cjs/src/hostEventsTypeMapping.d.ts +2 -0
  24. package/cjs/src/hostEventsTypeMapping.d.ts.map +1 -0
  25. package/cjs/src/hostEventsTypeMapping.js +4 -0
  26. package/cjs/src/hostEventsTypeMapping.js.map +1 -0
  27. package/cjs/src/types.d.ts +298 -161
  28. package/cjs/src/types.d.ts.map +1 -1
  29. package/cjs/src/types.js +274 -133
  30. package/cjs/src/types.js.map +1 -1
  31. package/cjs/src/utils/embedApi/contracts.d.ts +101 -0
  32. package/cjs/src/utils/embedApi/contracts.d.ts.map +1 -0
  33. package/cjs/src/utils/embedApi/contracts.js +17 -0
  34. package/cjs/src/utils/embedApi/contracts.js.map +1 -0
  35. package/cjs/src/utils/embedApi/embedApiClient.d.ts +12 -0
  36. package/cjs/src/utils/embedApi/embedApiClient.d.ts.map +1 -0
  37. package/cjs/src/utils/embedApi/embedApiClient.js +46 -0
  38. package/cjs/src/utils/embedApi/embedApiClient.js.map +1 -0
  39. package/cjs/src/utils/embedApi/processEmbedApi.d.ts +9 -0
  40. package/cjs/src/utils/embedApi/processEmbedApi.d.ts.map +1 -0
  41. package/cjs/src/utils/embedApi/processEmbedApi.js +18 -0
  42. package/cjs/src/utils/embedApi/processEmbedApi.js.map +1 -0
  43. package/dist/{index-DWOIXXJ1.js → index-BBBimG1x.js} +1 -1
  44. package/dist/index-BGnxP5NY.js +7370 -0
  45. package/dist/index-CENLvayL.js +7370 -0
  46. package/dist/index-CbltIawo.js +7370 -0
  47. package/dist/index-CoQfqaHj.js +7370 -0
  48. package/dist/index-CzwzS0P4.js +7370 -0
  49. package/dist/index-D-9WUCUl.js +7370 -0
  50. package/dist/index-DFwi_pV_.js +7370 -0
  51. package/dist/index-DOIjN0N_.js +7370 -0
  52. package/dist/index-DYBx8SuE.js +7370 -0
  53. package/dist/index-DaLHJaLd.js +7370 -0
  54. package/dist/index-DnJX-gN2.js +7370 -0
  55. package/dist/index-IDmSUe93.js +7370 -0
  56. package/dist/index-nWevLycs.js +7370 -0
  57. package/dist/src/embed/app.d.ts +11 -2
  58. package/dist/src/embed/app.d.ts.map +1 -1
  59. package/dist/src/embed/hostEventClient/contracts.d.ts +1 -1
  60. package/dist/src/embed/liveboard.d.ts +7 -4
  61. package/dist/src/embed/liveboard.d.ts.map +1 -1
  62. package/dist/src/embed/searchEmbed-basic-auth.spec.d.ts +2 -0
  63. package/dist/src/embed/searchEmbed-basic-auth.spec.d.ts.map +1 -0
  64. package/dist/src/embed/ts-embed.d.ts.map +1 -1
  65. package/dist/src/embed/ts-embed.spec.d.ts.map +1 -1
  66. package/dist/src/hostEventsTypeMapping.d.ts +2 -0
  67. package/dist/src/hostEventsTypeMapping.d.ts.map +1 -0
  68. package/dist/src/types.d.ts +298 -161
  69. package/dist/src/types.d.ts.map +1 -1
  70. package/dist/src/utils/embedApi/contracts.d.ts +101 -0
  71. package/dist/src/utils/embedApi/contracts.d.ts.map +1 -0
  72. package/dist/src/utils/embedApi/embedApiClient.d.ts +12 -0
  73. package/dist/src/utils/embedApi/embedApiClient.d.ts.map +1 -0
  74. package/dist/src/utils/embedApi/processEmbedApi.d.ts +9 -0
  75. package/dist/src/utils/embedApi/processEmbedApi.d.ts.map +1 -0
  76. package/dist/tsembed-react.es.js +287 -142
  77. package/dist/tsembed-react.js +286 -141
  78. package/dist/tsembed.es.js +287 -142
  79. package/dist/tsembed.js +286 -141
  80. package/dist/visual-embed-sdk-react-full.d.ts +316 -167
  81. package/dist/visual-embed-sdk-react.d.ts +316 -167
  82. package/dist/visual-embed-sdk.d.ts +316 -167
  83. package/lib/package.json +1 -1
  84. package/lib/src/embed/app.d.ts +11 -2
  85. package/lib/src/embed/app.d.ts.map +1 -1
  86. package/lib/src/embed/app.js.map +1 -1
  87. package/lib/src/embed/hostEventClient/contracts.d.ts +1 -1
  88. package/lib/src/embed/hostEventClient/contracts.js +1 -1
  89. package/lib/src/embed/liveboard.d.ts +7 -4
  90. package/lib/src/embed/liveboard.d.ts.map +1 -1
  91. package/lib/src/embed/liveboard.js +4 -3
  92. package/lib/src/embed/liveboard.js.map +1 -1
  93. package/lib/src/embed/liveboard.spec.js +17 -1
  94. package/lib/src/embed/liveboard.spec.js.map +1 -1
  95. package/lib/src/embed/searchEmbed-basic-auth.spec.d.ts +2 -0
  96. package/lib/src/embed/searchEmbed-basic-auth.spec.d.ts.map +1 -0
  97. package/lib/src/embed/searchEmbed-basic-auth.spec.js +101 -0
  98. package/lib/src/embed/searchEmbed-basic-auth.spec.js.map +1 -0
  99. package/lib/src/embed/ts-embed.d.ts.map +1 -1
  100. package/lib/src/embed/ts-embed.js +5 -2
  101. package/lib/src/embed/ts-embed.js.map +1 -1
  102. package/lib/src/embed/ts-embed.spec.d.ts.map +1 -1
  103. package/lib/src/embed/ts-embed.spec.js +111 -1
  104. package/lib/src/embed/ts-embed.spec.js.map +1 -1
  105. package/lib/src/hostEventsTypeMapping.d.ts +2 -0
  106. package/lib/src/hostEventsTypeMapping.d.ts.map +1 -0
  107. package/lib/src/hostEventsTypeMapping.js +2 -0
  108. package/lib/src/hostEventsTypeMapping.js.map +1 -0
  109. package/lib/src/types.d.ts +298 -161
  110. package/lib/src/types.d.ts.map +1 -1
  111. package/lib/src/types.js +274 -133
  112. package/lib/src/types.js.map +1 -1
  113. package/lib/src/utils/embedApi/contracts.d.ts +101 -0
  114. package/lib/src/utils/embedApi/contracts.d.ts.map +1 -0
  115. package/lib/src/utils/embedApi/contracts.js +14 -0
  116. package/lib/src/utils/embedApi/contracts.js.map +1 -0
  117. package/lib/src/utils/embedApi/embedApiClient.d.ts +12 -0
  118. package/lib/src/utils/embedApi/embedApiClient.d.ts.map +1 -0
  119. package/lib/src/utils/embedApi/embedApiClient.js +42 -0
  120. package/lib/src/utils/embedApi/embedApiClient.js.map +1 -0
  121. package/lib/src/utils/embedApi/processEmbedApi.d.ts +9 -0
  122. package/lib/src/utils/embedApi/processEmbedApi.d.ts.map +1 -0
  123. package/lib/src/utils/embedApi/processEmbedApi.js +14 -0
  124. package/lib/src/utils/embedApi/processEmbedApi.js.map +1 -0
  125. package/lib/src/visual-embed-sdk.d.ts +317 -168
  126. package/package.json +1 -1
  127. package/src/embed/app.ts +11 -2
  128. package/src/embed/hostEventClient/contracts.ts +1 -1
  129. package/src/embed/liveboard.spec.ts +23 -2
  130. package/src/embed/liveboard.ts +11 -8
  131. package/src/embed/ts-embed.spec.ts +160 -1
  132. package/src/embed/ts-embed.ts +4 -4
  133. package/src/types.ts +300 -164
@@ -1047,8 +1047,17 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
1047
1047
  */
1048
1048
  enableSearchAssist?: boolean;
1049
1049
  /**
1050
- * If set to true, the embedded object container dynamically resizes
1051
- * according to the height of the pages which support fullHeight mode.
1050
+ * If set to true, the Liveboard container dynamically resizes
1051
+ * according to the height of the Liveboard.
1052
+ *
1053
+ * **Note**: Using fullHeight loads all visualizations
1054
+ * on the Liveboard simultaneously, which results in
1055
+ * multiple warehouse queries and potentially a
1056
+ * longer wait for the topmost visualizations to
1057
+ * display on the screen. Setting fullHeight to
1058
+ * `false` fetches visualizations incrementally as
1059
+ * users scroll the page to view the charts and tables.
1060
+ *
1052
1061
  * @version SDK: 1.21.0 | ThoughtSpot: 9.4.0.cl, 9.4.0-sw
1053
1062
  * @example
1054
1063
  * ```js
@@ -1310,12 +1319,14 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
1310
1319
  /**
1311
1320
  * If set to true, the embedded object container dynamically resizes
1312
1321
  * according to the height of the Liveboard.
1322
+ *
1313
1323
  * **Note**: Using fullHeight loads all visualizations on the
1314
1324
  * Liveboard simultaneously, which results in multiple warehouse
1315
1325
  * queries and potentially a longer wait for the topmost
1316
1326
  * visualizations to display on the screen.
1317
1327
  * Setting `fullHeight` to `false` fetches visualizations
1318
1328
  * incrementally as users scroll the page to view the charts and tables.
1329
+ *
1319
1330
  * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 7.2.1
1320
1331
  * @example
1321
1332
  * ```js
@@ -1677,10 +1688,11 @@ export declare class LiveboardEmbed extends V1Embed {
1677
1688
  protected handleRenderForPrerender(): void;
1678
1689
  /**
1679
1690
  * Triggers an event to the embedded app
1680
- * @param messageType The event type
1681
- * @param data The payload to send with the message
1691
+ * @param {HostEvent} messageType The event type
1692
+ * @param {any} data The payload to send with the message
1693
+ * @returns A promise that resolves with the response from the embedded app
1682
1694
  */
1683
- trigger<HostEventT extends HostEvent>(messageType: HostEventT, data?: HostEventRequest<HostEventT>): Promise<HostEventResponse<HostEventT>>;
1695
+ trigger<HostEventT extends HostEvent, PayloadT>(messageType: HostEventT, data?: TriggerPayload<PayloadT, HostEventT>): Promise<TriggerResponse<PayloadT, HostEventT>>;
1684
1696
  /**
1685
1697
  * Render an embedded ThoughtSpot Liveboard or visualization
1686
1698
  * @param renderOptions An object specifying the Liveboard ID,
@@ -1809,7 +1821,7 @@ export { init, logout, prefetch, executeTML, exportTML, executeTMLInput, exportT
1809
1821
  */
1810
1822
  export declare enum AuthType {
1811
1823
  /**
1812
- * No authentication on the SDK. Passthrough to the embedded App. Alias for
1824
+ * No authentication on the SDK. Pass-through to the embedded App. Alias for
1813
1825
  * `Passthrough`.
1814
1826
  * @example
1815
1827
  * ```js
@@ -2006,8 +2018,8 @@ export interface customCssInterface {
2006
2018
  /**
2007
2019
  * The custom css variables, which can be set.
2008
2020
  * The allowed list is in the CustomCssVariables
2009
- * interface.
2010
- * Or here: https://try-everywhere.thoughtspot.cloud/resources/static/css/custom_variables.css
2021
+ * interface. For more information, see
2022
+ * link:https://developers.thoughtspot.com/docs/css-variables-reference
2011
2023
  */
2012
2024
  variables?: CustomCssVariables;
2013
2025
  /**
@@ -2049,7 +2061,7 @@ export interface CustomStyles {
2049
2061
  }
2050
2062
  /**
2051
2063
  * Configuration to define the customization on the Embedded
2052
- * Thoughtspot components.
2064
+ * ThoughtSpot components.
2053
2065
  * You can customize styles, text strings, and icons.
2054
2066
  * For more information, see https://developers.thoughtspot.com/docs/custom-css.
2055
2067
  * @example
@@ -2169,7 +2181,7 @@ export interface EmbedConfig {
2169
2181
  /**
2170
2182
  * Boolean to define if the query parameters in the ThoughtSpot URL
2171
2183
  * should be encoded in base64. This provides additional security to
2172
- * Thoughtspot clusters against cross-site scripting attacks.
2184
+ * ThoughtSpot clusters against cross-site scripting attacks.
2173
2185
  * @default false
2174
2186
  */
2175
2187
  shouldEncodeUrlQueryParams?: boolean;
@@ -2322,18 +2334,18 @@ export interface EmbedConfig {
2322
2334
  */
2323
2335
  disableSDKTracking?: boolean;
2324
2336
  /**
2325
- * Overrides default/user preffered locale for date formatting
2326
- * @version SDK: 1.28.4 | Thoughtspot: 10.0.0.cl, 9.5.0.sw
2337
+ * Overrides default/user preferred locale for date formatting
2338
+ * @version SDK: 1.28.4 | ThoughtSpot: 10.0.0.cl, 9.5.0.sw
2327
2339
  */
2328
2340
  dateFormatLocale?: string;
2329
2341
  /**
2330
- * Overrides default/user preffered locale for number formatting
2331
- * @version SDK: 1.28.4 | Thoughtspot: 10.0.0.cl, 9.5.0.sw
2342
+ * Overrides default/user preferred locale for number formatting
2343
+ * @version SDK: 1.28.4 | ThoughtSpot: 10.0.0.cl, 9.5.0.sw
2332
2344
  */
2333
2345
  numberFormatLocale?: string;
2334
2346
  /**
2335
2347
  * Format to be used for currency when currency format is set to infer from browser
2336
- * @version SDK: 1.28.4 | Thoughtspot: 10.0.0.cl, 9.5.0.sw
2348
+ * @version SDK: 1.28.4 | ThoughtSpot: 10.0.0.cl, 9.5.0.sw
2337
2349
  */
2338
2350
  currencyFormat?: string;
2339
2351
  /**
@@ -2347,12 +2359,12 @@ export interface EmbedConfig {
2347
2359
  * disableTokenVerification : true
2348
2360
  * })
2349
2361
  * ```
2350
- * @version SDK: 1.28.5 | Thoughtspot: *
2362
+ * @version SDK: 1.28.5 | ThoughtSpot: 9.10.0.cl, 10.1.0.sw
2351
2363
  */
2352
2364
  disableTokenVerification?: boolean;
2353
2365
  /**
2354
2366
  * This flag is used to disable showing the login failure page in the embedded app.
2355
- * @version SDK 1.32.3 | Thoughtspot: *
2367
+ * @version SDK 1.32.3 | ThoughtSpot: 10.1.0.cl, 10.1.0.sw
2356
2368
  */
2357
2369
  disableLoginFailurePage?: boolean;
2358
2370
  /**
@@ -2390,7 +2402,7 @@ export interface EmbedConfig {
2390
2402
  * }
2391
2403
  * });
2392
2404
  * ```
2393
- * @version SDK 1.37.0 | Thoughtspot: 10.7.0.cl
2405
+ * @version SDK 1.37.0 | ThoughtSpot: 10.7.0.cl
2394
2406
  */
2395
2407
  customVariablesForThirdPartyTools?: Record<string, any>;
2396
2408
  }
@@ -2549,7 +2561,7 @@ export interface ViewConfig {
2549
2561
  /**
2550
2562
  * The list of parameter override to apply to a search answer,
2551
2563
  * visualization, or Liveboard.
2552
- * @version SDK : 1.25.0 | Thoughtspot: 9.2.0.cl, 9.5.0.sw
2564
+ * @version SDK : 1.25.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
2553
2565
  * @example
2554
2566
  * ```js
2555
2567
  * const embed = new LiveboardEmbed('#embed-container', {
@@ -2609,7 +2621,7 @@ export interface ViewConfig {
2609
2621
  /**
2610
2622
  * Insert as a sibling of the target container, instead of appending to a
2611
2623
  * child inside it.
2612
- * @version SDK: 1.2.0 | Thoughtspot: 9.0.0.cl, 9.0.0.sw
2624
+ * @version SDK: 1.2.0 | ThoughtSpot: 9.0.0.cl, 9.0.0.sw
2613
2625
  * @example
2614
2626
  * ```js
2615
2627
  * const embed = new LiveboardEmbed('#embed-container', {
@@ -2682,7 +2694,7 @@ export interface ViewConfig {
2682
2694
  * 'f547ec54-2a37-4516-a222-2b06719af726']
2683
2695
  * });
2684
2696
  * ```
2685
- * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
2697
+ * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw
2686
2698
  */
2687
2699
  hiddenTabs?: string[];
2688
2700
  /**
@@ -2692,7 +2704,7 @@ export interface ViewConfig {
2692
2704
  * **Note**: This option does not apply to the classic homepage.
2693
2705
  * To access the updated modular homepage, set
2694
2706
  * `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
2695
- * @version SDK: 1.28.0 | Thoughtspot: 9.12.5.cl
2707
+ * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
2696
2708
  * @example
2697
2709
  * ```js
2698
2710
  * const embed = new AppEmbed('#tsEmbed', {
@@ -2709,7 +2721,7 @@ export interface ViewConfig {
2709
2721
  * **Note**: This option does not apply to the classic homepage.
2710
2722
  * To access the updated modular homepage, set
2711
2723
  * `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
2712
- * @version SDK: 1.28.0| Thoughtspot: 9.12.5.cl
2724
+ * @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl, 10.1.0.sw
2713
2725
  * @example
2714
2726
  * ```js
2715
2727
  * const embed = new AppEmbed('#tsEmbed', {
@@ -2724,7 +2736,7 @@ export interface ViewConfig {
2724
2736
  * Only the tabs specified in the array will be shown in the Liveboard.
2725
2737
  *
2726
2738
  * Use either `visibleTabs` or `hiddenTabs`.
2727
- * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
2739
+ * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw
2728
2740
  * @example
2729
2741
  * ```js
2730
2742
  * const embed = new LiveboardEmbed('#embed-container', {
@@ -2752,7 +2764,7 @@ export interface ViewConfig {
2752
2764
  * **Note**: This option does not apply to the classic homepage.
2753
2765
  * To access the updated modular homepage, set
2754
2766
  * `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
2755
- * @version SDK: 1.28.0 | Thoughtspot: 9.12.5.cl
2767
+ * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
2756
2768
  */
2757
2769
  hiddenHomeLeftNavItems?: HomeLeftNavItem[];
2758
2770
  /**
@@ -2767,7 +2779,7 @@ export interface ViewConfig {
2767
2779
  * });
2768
2780
  * embed.showPreRender();
2769
2781
  * ```
2770
- * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl, 9.8.0.sw
2782
+ * @version SDK: 1.25.0 | ThoughtSpot: 9.6.0.cl, 9.8.0.sw
2771
2783
  */
2772
2784
  preRenderId?: string;
2773
2785
  /**
@@ -2821,7 +2833,7 @@ export interface ViewConfig {
2821
2833
  /**
2822
2834
  * To set the initial state of the search bar in case of saved Answers.
2823
2835
  * @default true
2824
- * @version SDK: 1.34.0 | Thoughtspot: 10.3.0.cl
2836
+ * @version SDK: 1.34.0 | ThoughtSpot: 10.3.0.cl
2825
2837
  * @example
2826
2838
  * ```js
2827
2839
  * const embed = new LiveboardEmbed('#embed', {
@@ -2845,7 +2857,7 @@ export interface ViewConfig {
2845
2857
  /**
2846
2858
  * Flag to control Data panel experience
2847
2859
  * @default false
2848
- * @version SDK: 1.34.0 | Thoughtspot: 10.3.0.cl
2860
+ * @version SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
2849
2861
  * @example
2850
2862
  * ```js
2851
2863
  * const embed = new AppEmbed('#tsEmbed', {
@@ -2857,7 +2869,7 @@ export interface ViewConfig {
2857
2869
  dataPanelV2?: boolean;
2858
2870
  /**
2859
2871
  * To enable custom column groups in data panel v2
2860
- * @version SDK: 1.32.0 | Thoughtspot: 10.0.0.cl
2872
+ * @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl, 10.1.0.sw
2861
2873
  * @default false
2862
2874
  * @example
2863
2875
  * ```js
@@ -2885,9 +2897,10 @@ export interface ViewConfig {
2885
2897
  */
2886
2898
  overrideOrgId?: number;
2887
2899
  /**
2888
- * Flag to control new flip tooltip context menu experience
2900
+ * Flag to enhance the visual effects of charts
2901
+ * This feature is a beta release for 10.6
2889
2902
  * @default false
2890
- * @version SDK: 1.36.0 | Thoughtspot: 10.6.0.cl
2903
+ * @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
2891
2904
  */
2892
2905
  enableFlipTooltipToContextMenu?: boolean;
2893
2906
  }
@@ -3007,7 +3020,7 @@ export declare enum RuntimeFilterOp {
3007
3020
  * **Note**: This option does not apply to the classic homepage.
3008
3021
  * To access the updated modular homepage, set
3009
3022
  * `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
3010
- * @version SDK: 1.28.0 | Thoughtspot: 9.12.5.cl
3023
+ * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
3011
3024
  */
3012
3025
  export declare enum HomepageModule {
3013
3026
  /**
@@ -3850,7 +3863,7 @@ export declare enum EmbedEvent {
3850
3863
  */
3851
3864
  Explore = "explore",
3852
3865
  /**
3853
- * Emitted when a user clicks **Copy link** action on a visualization
3866
+ * Emitted when a user clicks **Copy link** action on a visualization.
3854
3867
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
3855
3868
  * @example
3856
3869
  *```js
@@ -3900,23 +3913,26 @@ export declare enum EmbedEvent {
3900
3913
  */
3901
3914
  FilterChanged = "filterChanged",
3902
3915
  /**
3903
- * Emitted when a user clicks the **Go** button on the sage embed
3904
- * @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
3916
+ * Emitted when a user clicks the **Go** button to initiate
3917
+ * a Natural Language Search query
3918
+ * @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
3905
3919
  */
3906
3920
  SageEmbedQuery = "sageEmbedQuery",
3907
3921
  /**
3908
- * Emitted when a user selects a data source on the sage embed
3909
- * @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
3922
+ * Emitted when a user selects a data source on the embedded
3923
+ * Natural Language Search interface.
3924
+ *
3925
+ * @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
3910
3926
  */
3911
3927
  SageWorksheetUpdated = "sageWorksheetUpdated",
3912
3928
  /**
3913
3929
  * Emitted when a user updates a connection on the **Data** page
3914
- * @version SDK : 1.27.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
3930
+ * @version SDK : 1.27.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
3915
3931
  */
3916
3932
  UpdateConnection = "updateConnection",
3917
3933
  /**
3918
3934
  * Emitted when a user updates a connection on the **Data** page
3919
- * @version SDK : 1.27.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
3935
+ * @version SDK : 1.27.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
3920
3936
  */
3921
3937
  CreateConnection = "createConnection",
3922
3938
  /**
@@ -3926,7 +3942,7 @@ export declare enum EmbedEvent {
3926
3942
  * @returns viewId: string
3927
3943
  * @returns liveboardId: string
3928
3944
  * @returns isPublic: boolean
3929
- * @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
3945
+ * @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
3930
3946
  */
3931
3947
  UpdatePersonalisedView = "updatePersonalisedView",
3932
3948
  /**
@@ -3935,7 +3951,7 @@ export declare enum EmbedEvent {
3935
3951
  * @returns viewId: string
3936
3952
  * @returns liveboardId: string
3937
3953
  * @returns isPublic: boolean
3938
- * @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
3954
+ * @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
3939
3955
  */
3940
3956
  SavePersonalisedView = "savePersonalisedView",
3941
3957
  /**
@@ -3944,28 +3960,28 @@ export declare enum EmbedEvent {
3944
3960
  * @returns viewId: string
3945
3961
  * @returns liveboardId: string
3946
3962
  * @returns isPublic: boolean
3947
- * @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
3963
+ * @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
3948
3964
  */
3949
3965
  ResetLiveboard = "resetLiveboard",
3950
3966
  /**
3951
3967
  * Emitted when a PersonalisedView is deleted.
3952
3968
  * @returns views: string[]
3953
3969
  * @returns liveboardId: string
3954
- * @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
3970
+ * @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
3955
3971
  */
3956
3972
  DeletePersonalisedView = "deletePersonalisedView",
3957
3973
  /**
3958
3974
  * Emitted when a user creates a new worksheet
3959
- * @version SDK : 1.27.0 | Thoughtspot: 9.8.0.cl
3975
+ * @version SDK : 1.27.0 | ThoughtSpot Cloud: 9.8.0.cl
3960
3976
  */
3961
3977
  CreateWorksheet = "createWorksheet",
3962
3978
  /**
3963
- * Emitted when Ask Sage is initialized.
3979
+ * Emitted when the *Ask Sage* is initialized.
3964
3980
  * @returns viewName: string
3965
3981
  * @returns viewId: string
3966
3982
  * @returns liveboardId: string
3967
3983
  * @returns isPublic: boolean
3968
- * @version SDK : 1.29.0 | Thoughtspot: 9.12.0.cl
3984
+ * @version SDK : 1.29.0 | ThoughtSpot Cloud: 9.12.0.cl
3969
3985
  */
3970
3986
  AskSageInit = "AskSageInit",
3971
3987
  /**
@@ -3993,7 +4009,7 @@ export declare enum EmbedEvent {
3993
4009
  *
3994
4010
  * error: Developers can customize the error message text when `execute`
3995
4011
  * returns `false` using the error parameter in responder.
3996
- * @version SDK : 1.29.0 | Thoughtspot : 10.3.0.cl
4012
+ * @version SDK : 1.29.0 | ThoughtSpot : 10.3.0.cl
3997
4013
  * @example
3998
4014
  *```js
3999
4015
  * .on(EmbedEvent.OnBeforeGetVizDataIntercept,
@@ -4041,9 +4057,26 @@ export declare enum EmbedEvent {
4041
4057
  * console.log('payload', payload);
4042
4058
  * })
4043
4059
  *```
4044
- * @version SDK : 1.29.0 | Thoughtspot : 10.3.0.cl
4060
+ * @version SDK : 1.29.0 | ThoughtSpot : 10.3.0.cl
4061
+ */
4062
+ ParameterChanged = "parameterChanged",
4063
+ /**
4064
+ * Emitted when the table viz renders.
4065
+ * You can use this event as a hook to trigger
4066
+ * other events on the rendered table viz data.
4067
+ * @example
4068
+ * ```js
4069
+ * searchEmbed.on(EmbedEvent.TableVizRendered, (payload) => {
4070
+ * console.log(payload);
4071
+ * const columnDataLite = payload.data.data.columnDataLite;
4072
+ * columnDataLite[0].dataValue[0]="new fob";
4073
+ * console.log('>>> new Data', columnDataLite);
4074
+ * searchEmbed.trigger(HostEvent.TransformTableVizData, columnDataLite);
4075
+ * })
4076
+ * ```
4077
+ * @version SDK: 1.35.12 | ThoughtSpot: 10.7.0.cl
4045
4078
  */
4046
- ParameterChanged = "parameterChanged"
4079
+ TableVizRendered = "TableVizRendered"
4047
4080
  }
4048
4081
  /**
4049
4082
  * Event types that can be triggered by the host application
@@ -4188,7 +4221,7 @@ export declare enum HostEvent {
4188
4221
  * const url = embed.trigger(HostEvent.GetIframeUrl);
4189
4222
  * console.log("iFrameURL",url);
4190
4223
  * ```
4191
- * @version SDK: 1.35.0 | Thoughtspot: 10.4.0.cl
4224
+ * @version SDK: 1.35.0 | ThoughtSpot: 10.4.0.cl
4192
4225
  */
4193
4226
  GetIframeUrl = "GetIframeUrl",
4194
4227
  /**
@@ -4221,6 +4254,11 @@ export declare enum HostEvent {
4221
4254
  * attributes passed with this event are appended to the existing runtime
4222
4255
  * filters applied on a Liveboard.
4223
4256
  *
4257
+ * **Note**: `HostEvent.UpdateRuntimeFilters` is supported in `LiveboardEmbed`
4258
+ * and `AppEmbed` only. In full application embedding, this event updates
4259
+ * the runtime filters applied on the Liveboard and saved Answer objects.
4260
+ *
4261
+ *
4224
4262
  * Pass an array of runtime filters with the following attributes:
4225
4263
  *
4226
4264
  * `columnName` - _String_. The name of the column to filter on.
@@ -4231,9 +4269,12 @@ export declare enum HostEvent {
4231
4269
  * `values` - List of operands. Some operators such as EQ and LE allow a
4232
4270
  * single value, whereas BW and IN accept multiple values.
4233
4271
  *
4234
- * **Note**: `HostEvent.UpdateRuntimeFilters` is supported in `LiveboardEmbed`
4235
- * and `AppEmbed` only. In full application embedding, this event updates
4236
- * the runtime filters applied on the Liveboard and saved Answer objects.
4272
+ * **Note**: Updating runtime filters resets the ThoughtSpot
4273
+ * object to its original state and applies new filter conditions.
4274
+ * Any user changes (like drilling into a visualization)
4275
+ * will be cleared, restoring the original visualization
4276
+ * with the updated filters.
4277
+ *
4237
4278
  * @param - {@link RuntimeFilter}[] an array of {@link RuntimeFilter} Types.
4238
4279
  * @example
4239
4280
  * ```js
@@ -4248,7 +4289,7 @@ export declare enum HostEvent {
4248
4289
  UpdateRuntimeFilters = "UpdateRuntimeFilters",
4249
4290
  /**
4250
4291
  * Navigate to a specific page in the embedded ThoughtSpot application.
4251
- * This is the same as calling `appEmbed.navigateToPage(path, true)`
4292
+ * This is the same as calling `appEmbed.navigateToPage(path, true)`.
4252
4293
  * @param - `path` - the path to navigate to to go forward or back. The path value can
4253
4294
  * be a number; for example, `1`, `-1`.
4254
4295
  * @example
@@ -4444,7 +4485,7 @@ export declare enum HostEvent {
4444
4485
  * @param - an object with `vizId` as a key
4445
4486
  * @example
4446
4487
  * ```js
4447
- * liveboardEmbed.trigger(HostEvent.CreateMonitor {
4488
+ * liveboardEmbed.trigger(HostEvent.CreateMonitor, {
4448
4489
  * vizId: '730496d6-6903-4601-937e-2c691821af3c'
4449
4490
  * })
4450
4491
  * ```
@@ -4543,7 +4584,9 @@ export declare enum HostEvent {
4543
4584
  */
4544
4585
  GetTML = "getTML",
4545
4586
  /**
4546
- * Trigger the **Show underlying data** action on visualization or search
4587
+ * Trigger the **Show underlying data** action on a
4588
+ * chart or table.
4589
+ *
4547
4590
  * @param - an object with vizId as a key
4548
4591
  * @example
4549
4592
  * ```js
@@ -4577,8 +4620,8 @@ export declare enum HostEvent {
4577
4620
  */
4578
4621
  Delete = "onDeleteAnswer",
4579
4622
  /**
4580
- * Trigger the **SpotIQ analyze** action on visualization
4581
- * or search.
4623
+ * Trigger the **SpotIQ analyze** action on a
4624
+ * chart or table.
4582
4625
  * @param - Liveboard embed takes `vizId` as a
4583
4626
  * key. Can be left undefined when embedding Search or
4584
4627
  * visualization.
@@ -4851,7 +4894,7 @@ export declare enum HostEvent {
4851
4894
  * '430496d6-6903-4601-937e-2c691821af3c',
4852
4895
  * 'f547ec54-2a37-4516-a222-2b06719af726'])
4853
4896
  * ```
4854
- * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
4897
+ * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
4855
4898
  */
4856
4899
  SetVisibleTabs = "SetPinboardVisibleTabs",
4857
4900
  /**
@@ -4864,7 +4907,7 @@ export declare enum HostEvent {
4864
4907
  * '630496d6-6903-4601-937e-2c691821af3c',
4865
4908
  * 'i547ec54-2a37-4516-a222-2b06719af726'])
4866
4909
  * ```
4867
- * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
4910
+ * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
4868
4911
  */
4869
4912
  SetHiddenTabs = "SetPinboardHiddenTabs",
4870
4913
  /**
@@ -4878,7 +4921,7 @@ export declare enum HostEvent {
4878
4921
  * executeSearch: true,
4879
4922
  * })
4880
4923
  * ```
4881
- * @version SDK: 1.26.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
4924
+ * @version SDK: 1.26.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
4882
4925
  */
4883
4926
  UpdateSageQuery = "updateSageQuery",
4884
4927
  /**
@@ -4895,21 +4938,22 @@ export declare enum HostEvent {
4895
4938
  * ```js
4896
4939
  * const {session} = await embed.trigger( HostEvent.GetAnswerSession )
4897
4940
  * ```
4898
- * @version SDK: 1.26.0 | Thoughtspot: 9.10.0.cl
4941
+ * @version SDK: 1.26.0 | ThoughtSpot: 9.10.0.cl, 10.1.0.sw
4899
4942
  */
4900
4943
  GetAnswerSession = "getAnswerSession",
4901
4944
  /**
4902
- * Trigger Ask Sage for viz
4945
+ * Trigger the *Ask Sage* action for visualizations
4903
4946
  * @example
4904
4947
  * ```js
4905
4948
  * liveboardEmbed.trigger(HostEvent.AskSage,
4906
4949
  * {vizId:'730496d6-6903-4601-937e-2c691821af3c'})
4907
4950
  * ```
4908
- * @version SDK: 1.29.0 | Thoughtspot: 9.12.0.cl
4951
+ * @version SDK: 1.29.0 | ThoughtSpot Cloud: 9.12.0.cl
4909
4952
  */
4910
4953
  AskSage = "AskSage",
4911
4954
  /**
4912
- * Trigger cross filter update action on a Liveboard
4955
+ * Trigger cross filter update action on a Liveboard.
4956
+ *
4913
4957
  * @example
4914
4958
  * ```js
4915
4959
  * liveboardEmbed.trigger(HostEvent.UpdateCrossFilter, {
@@ -4920,7 +4964,7 @@ export declare enum HostEvent {
4920
4964
  * ],
4921
4965
  * });
4922
4966
  * ```
4923
- * @version SDK: 1.29.0 | Thoughtspot: 10.0.0.cl
4967
+ * @version SDK: 1.29.0 | ThoughtSpot Cloud: 10.0.0.cl, 10.1.0.sw
4924
4968
  */
4925
4969
  UpdateCrossFilter = "UpdateCrossFilter",
4926
4970
  /**
@@ -4929,11 +4973,13 @@ export declare enum HostEvent {
4929
4973
  * ```js
4930
4974
  * liveboardEmbed.trigger(HostEvent.ResetLiveboardPersonalisedView);
4931
4975
  * ```
4932
- * @version SDK: 1.29.0 | Thoughtspot: 10.1.0.cl
4976
+ * @version SDK: 1.29.0 | ThoughtSpot Cloud: 10.1.0.cl, 10.1.0.sw
4933
4977
  */
4934
4978
  ResetLiveboardPersonalisedView = "ResetLiveboardPersonalisedView",
4935
4979
  /**
4936
- * Triggers an event to Update Parameter values for Answers and Liveboard
4980
+ * Triggers an action to update Parameter values on embedded
4981
+ * Answers and Liveboard.
4982
+ *
4937
4983
  * @example
4938
4984
  * ```js
4939
4985
  * liveboardEmbed.trigger(HostEvent.UpdateParameters, [{
@@ -4941,37 +4987,56 @@ export declare enum HostEvent {
4941
4987
  * value: "almond"
4942
4988
  * }])
4943
4989
  *
4944
- * @version SDK: 1.29.0 | Thoughtspot: 10.1.0.cl
4990
+ * @version SDK: 1.29.0 | ThoughtSpot: 10.1.0.cl, 10.1.0.sw
4945
4991
  */
4946
4992
  UpdateParameters = "UpdateParameters",
4947
4993
  /**
4948
- * Triggers GetParameters to fetch the runtime parameters
4994
+ * Triggers GetParameters to fetch the runtime Parameters.
4949
4995
  * ```js
4950
4996
  * liveboardEmbed.trigger(HostEvent.GetParameters).then((parameter) => {
4951
4997
  * console.log('parameters', parameter);
4952
4998
  * });
4953
4999
  *```
4954
- * @version SDK: 1.29.0 | Thoughtspot: 10.1.0.cl
5000
+ * @version SDK: 1.29.0 | ThoughtSpot: 10.1.0.cl, 10.1.0.sw
4955
5001
  */
4956
5002
  GetParameters = "GetParameters",
4957
5003
  /**
4958
- * Triggers an event to update a persoanlised view of a Liveboard
5004
+ * Triggers an event to update a personalized view of a Liveboard.
4959
5005
  * ```js
4960
5006
  * liveboardEmbed.trigger(HostEvent.UpdatePersonalisedView, {viewId: '1234'})
4961
5007
  * ```
4962
- * @version SDK: 1.36.0 | Thoughtspot: 10.6.0.cl
5008
+ * @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
4963
5009
  */
4964
5010
  UpdatePersonalisedView = "UpdatePersonalisedView",
4965
5011
  /**
4966
- * Triggers the action to get the current view of the liveboard
4967
- * @version SDK: 1.36.0 | Thoughtspot: 10.6.0.cl
5012
+ * Triggers the action to get the current view of the Liveboard.
5013
+ * @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
4968
5014
  */
4969
5015
  SaveAnswer = "saveAnswer",
4970
5016
  /**
4971
5017
  * EmbedApi
4972
5018
  * @hidden
4973
5019
  */
4974
- UIPassthrough = "UiPassthrough"
5020
+ UIPassthrough = "UiPassthrough",
5021
+ /**
5022
+ * Triggers the table viz rerender with the updated data.
5023
+ * Includes the following properties:
5024
+ * @param - columnDataLite - an array of object containing data
5025
+ * transformed from data picked from TableVizRendered event.
5026
+ * For example, { columnDataLite: []}
5027
+ * @example
5028
+ * ```js
5029
+ * searchEmbed.on(EmbedEvent.TableVizRendered, (payload) => {
5030
+ * console.log(payload);
5031
+ * const columnDataLite = payload.data.data.columnDataLite;
5032
+ * columnDataLite[0].dataValue[0]="new fob";
5033
+ * console.log('>>> new Data', columnDataLite);
5034
+ * searchEmbed.trigger(HostEvent.TransformTableVizData, columnDataLite);
5035
+ * })
5036
+ * ```
5037
+ * @version SDK: 1.35.12 | ThoughtSpot: 10.7.0.cl
5038
+ */
5039
+ TransformTableVizData = "TransformTableVizData"
4975
5040
  }
4976
5041
  /**
4977
5042
  * The different visual modes that the data sources panel within
@@ -5033,7 +5098,7 @@ export declare enum Param {
5033
5098
  AuthType = "authType",
5034
5099
  IconSpriteUrl = "iconSprite",
5035
5100
  cookieless = "cookieless",
5036
- ContextMenuTrigger = "isContextMenuEnabledOnLeftClick",
5101
+ ContextMenuTrigger = "contextMenuEnabledOnWhichClick",
5037
5102
  LinkOverride = "linkOverride",
5038
5103
  blockNonEmbedFullAppAccess = "blockNonEmbedFullAppAccess",
5039
5104
  ShowInsertToSlide = "insertInToSlide",
@@ -5184,7 +5249,8 @@ export declare enum Action {
5184
5249
  ResetLayout = "resetLayout",
5185
5250
  /**
5186
5251
  * The **Schedule** menu action on a Liveboard.
5187
- * Allows scheduling a Liveboard notification.
5252
+ * Allows scheduling a Liveboard job, for example,
5253
+ * sending periodic notifications.
5188
5254
  * @example
5189
5255
  * ```js
5190
5256
  * disabledActions: [Action.Schedule]
@@ -5226,7 +5292,7 @@ export declare enum Action {
5226
5292
  * ```js
5227
5293
  * disabledActions: [Action.AddDataPanelObjects]
5228
5294
  * ```
5229
- * @version SDK: 1.32.0 | Thoughtspot: 10.0.0.cl
5295
+ * @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl, 10.1.0.sw
5230
5296
  */
5231
5297
  AddDataPanelObjects = "addDataPanelObjects",
5232
5298
  /**
@@ -5239,7 +5305,28 @@ export declare enum Action {
5239
5305
  * ```
5240
5306
  */
5241
5307
  ConfigureFilter = "configureFilter",
5308
+ /**
5309
+ * The **Collapse data sources** icon on the Search page.
5310
+ * Collapses the panel showing data sources.
5311
+ *
5312
+ * @example
5313
+ * ```js
5314
+ * disabledActions: [Action.CollapseDataPanel]
5315
+ * ```
5316
+ * @version: SDK: 1.1.0 | ThoughtSpot Cloud: ts7.may.cl, 8.4.1.sw
5317
+ */
5242
5318
  CollapseDataSources = "collapseDataSources",
5319
+ /**
5320
+ * The **Collapse data panel** icon on the Search page.
5321
+ * Collapses the data panel view.
5322
+ *
5323
+ * @version: SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl, 10.7.0.sw
5324
+ *
5325
+ * @example
5326
+ * ```js
5327
+ * disabledActions: [Action.CollapseDataPanel]
5328
+ * ```
5329
+ */
5243
5330
  CollapseDataPanel = "collapseDataPanel",
5244
5331
  /**
5245
5332
  * The **Choose sources** button on Search page.
@@ -5275,7 +5362,7 @@ export declare enum Action {
5275
5362
  * ```js
5276
5363
  * disabledActions: [Action.AddColumnSet]
5277
5364
  * ```
5278
- * @version SDK: 1.32.0 | Thoughtspot: 10.0.0.cl
5365
+ * @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl, 10.1.0.sw
5279
5366
  */
5280
5367
  AddColumnSet = "addSimpleCohort",
5281
5368
  /**
@@ -5285,7 +5372,7 @@ export declare enum Action {
5285
5372
  * ```js
5286
5373
  * disabledActions: [Action.AddQuerySet]
5287
5374
  * ```
5288
- * @version SDK: 1.32.0 | Thoughtspot: 10.0.0.cl
5375
+ * @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl, 10.1.0.sw
5289
5376
  */
5290
5377
  AddQuerySet = "addAdvancedCohort",
5291
5378
  /**
@@ -5317,6 +5404,8 @@ export declare enum Action {
5317
5404
  /**
5318
5405
  * The **Show underlying data** menu action on a visualization or
5319
5406
  * Answer page.
5407
+ * Displays detailed information and raw data
5408
+ * for a given visualization.
5320
5409
  * @example
5321
5410
  * ```js
5322
5411
  * disabledActions: [Action.ShowUnderlyingData]
@@ -5518,6 +5607,7 @@ export declare enum Action {
5518
5607
  AnalysisInfo = "analysisInfo",
5519
5608
  /**
5520
5609
  * The **Schedule** menu action on a Liveboard.
5610
+ * Allows scheduling a Liveboard job.
5521
5611
  * @example
5522
5612
  * ```js
5523
5613
  * disabledActions: [Action.Subscription]
@@ -5587,8 +5677,13 @@ export declare enum Action {
5587
5677
  */
5588
5678
  RequestAccess = "requestAccess",
5589
5679
  /**
5590
- * The **Query visualizer** and **Query SQL** buttons in Query details panel
5591
- * of the Answer page
5680
+ * The **Query visualizer** and **Query SQL** buttons in
5681
+ * Query details panel of the Answer page.
5682
+ *
5683
+ * **Query visualizer** - Displays the tables
5684
+ * and filters used in a search query.
5685
+ * **Query SQL** - Displays the SQL statements used
5686
+ * in a search query to fetch data.
5592
5687
  * @example
5593
5688
  * ```js
5594
5689
  * disabledActions: [Action.QueryDetailsButtons]
@@ -5606,7 +5701,10 @@ export declare enum Action {
5606
5701
  */
5607
5702
  AnswerDelete = "onDeleteAnswer",
5608
5703
  /**
5609
- * The Chart switcher icon on Answer and visualization pages.
5704
+ * The chart switcher icon on Answer page and
5705
+ * visualizations in edit mode.
5706
+ * Allows switching to the table or chart mode
5707
+ * when editing a visualization.
5610
5708
  * @example
5611
5709
  * ```js
5612
5710
  * disabledActions: [Action.AnswerChartSwitcher]
@@ -5615,7 +5713,10 @@ export declare enum Action {
5615
5713
  */
5616
5714
  AnswerChartSwitcher = "answerChartSwitcher",
5617
5715
  /**
5618
- * Favorites icon (*) on Answers, Liveboard, and Data pages
5716
+ * The Favorites icon (*) for Answers,
5717
+ * Liveboard, and data objects like Worksheet, Model,
5718
+ * Tables and Views.
5719
+ * Allows adding an object to the user’s favorites list.
5619
5720
  * @example
5620
5721
  * ```js
5621
5722
  * disabledActions: [Action.AddToFavorites]
@@ -5633,7 +5734,9 @@ export declare enum Action {
5633
5734
  */
5634
5735
  EditDetails = "editDetails",
5635
5736
  /**
5636
- * The Create alert action on KPI charts.
5737
+ * The *Create alert* action for KPI charts.
5738
+ * Allows users to schedule threshold-based alerts
5739
+ * for KPI charts.
5637
5740
  * @example
5638
5741
  * ```js
5639
5742
  * disabledActions: [Action.CreateMonitor]
@@ -5689,7 +5792,7 @@ export declare enum Action {
5689
5792
  * ```js
5690
5793
  * disabledActions: [Action.CrossFilter]
5691
5794
  * ```
5692
- * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
5795
+ * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.8.0.sw
5693
5796
  */
5694
5797
  CrossFilter = "context-menu-item-cross-filter",
5695
5798
  /**
@@ -5699,7 +5802,7 @@ export declare enum Action {
5699
5802
  * ```js
5700
5803
  * disabledActions: [Action.SyncToSlack]
5701
5804
  * ```
5702
- * @version @version SDK : 1.32.0 | Thoughtspot: 10.1.0.cl
5805
+ * @version @version SDK : 1.32.0 | ThoughtSpot Cloud: 10.1.0.cl
5703
5806
  */
5704
5807
  SyncToSlack = "syncToSlack",
5705
5808
  /**
@@ -5709,7 +5812,7 @@ export declare enum Action {
5709
5812
  * ```js
5710
5813
  * disabledActions: [Action.SyncToTeams]
5711
5814
  * ```
5712
- * @version @version SDK : 1.32.0 | Thoughtspot: 10.1.0.cl
5815
+ * @version @version SDK : 1.32.0 | ThoughtSpot Cloud: 10.1.0.cl
5713
5816
  */
5714
5817
  SyncToTeams = "syncToTeams",
5715
5818
  /**
@@ -5720,7 +5823,7 @@ export declare enum Action {
5720
5823
  * ```js
5721
5824
  * disabledActions: [Action.RemoveCrossFilter]
5722
5825
  * ```
5723
- * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
5826
+ * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
5724
5827
  */
5725
5828
  RemoveCrossFilter = "context-menu-item-remove-cross-filter",
5726
5829
  /**
@@ -5731,7 +5834,7 @@ export declare enum Action {
5731
5834
  * ```js
5732
5835
  * disabledActions: [Action.AxisMenuAggregate]
5733
5836
  * ```
5734
- * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
5837
+ * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
5735
5838
  */
5736
5839
  AxisMenuAggregate = "axisMenuAggregate",
5737
5840
  /**
@@ -5742,17 +5845,19 @@ export declare enum Action {
5742
5845
  * ```js
5743
5846
  * disabledActions: [Action.AxisMenuTimeBucket]
5744
5847
  * ```
5745
- * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
5848
+ * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
5746
5849
  */
5747
5850
  AxisMenuTimeBucket = "axisMenuTimeBucket",
5748
5851
  /**
5749
5852
  * The **Filter** action in the chart axis or table column
5750
5853
  * customization menu.
5854
+ * Allows adding, editing, or removing filters.
5855
+ *
5751
5856
  * @example
5752
5857
  * ```js
5753
5858
  * disabledActions: [Action.AxisMenuFilter]
5754
5859
  * ```
5755
- * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
5860
+ * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
5756
5861
  */
5757
5862
  AxisMenuFilter = "axisMenuFilter",
5758
5863
  /**
@@ -5763,7 +5868,7 @@ export declare enum Action {
5763
5868
  * ```js
5764
5869
  * disabledActions: [Action.AxisMenuConditionalFormat]
5765
5870
  * ```
5766
- * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
5871
+ * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
5767
5872
  */
5768
5873
  AxisMenuConditionalFormat = "axisMenuConditionalFormat",
5769
5874
  /**
@@ -5774,7 +5879,7 @@ export declare enum Action {
5774
5879
  * ```js
5775
5880
  * disabledActions: [Action.AxisMenuConditionalFormat]
5776
5881
  * ```
5777
- * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
5882
+ * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
5778
5883
  */
5779
5884
  AxisMenuSort = "axisMenuSort",
5780
5885
  /**
@@ -5786,7 +5891,7 @@ export declare enum Action {
5786
5891
  * ```js
5787
5892
  * disabledActions: [Action.AxisMenuGroup]
5788
5893
  * ```
5789
- * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
5894
+ * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
5790
5895
  */
5791
5896
  AxisMenuGroup = "axisMenuGroup",
5792
5897
  /**
@@ -5797,7 +5902,7 @@ export declare enum Action {
5797
5902
  * ```js
5798
5903
  * disabledActions: [Action.AxisMenuPosition]
5799
5904
  * ```
5800
- * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
5905
+ * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
5801
5906
  */
5802
5907
  AxisMenuPosition = "axisMenuPosition",
5803
5908
  /**
@@ -5807,7 +5912,7 @@ export declare enum Action {
5807
5912
  * ```js
5808
5913
  * disabledActions: [Action.AxisMenuRename]
5809
5914
  * ```
5810
- * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
5915
+ * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
5811
5916
  */
5812
5917
  AxisMenuRename = "axisMenuRename",
5813
5918
  /**
@@ -5818,7 +5923,7 @@ export declare enum Action {
5818
5923
  * ```js
5819
5924
  * disabledActions: [Action.AxisMenuEdit]
5820
5925
  * ```
5821
- * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
5926
+ * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
5822
5927
  */
5823
5928
  AxisMenuEdit = "axisMenuEdit",
5824
5929
  /**
@@ -5828,7 +5933,7 @@ export declare enum Action {
5828
5933
  * ```js
5829
5934
  * disabledActions: [Action.AxisMenuNumberFormat]
5830
5935
  * ```
5831
- * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
5936
+ * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
5832
5937
  */
5833
5938
  AxisMenuNumberFormat = "axisMenuNumberFormat",
5834
5939
  /**
@@ -5838,7 +5943,7 @@ export declare enum Action {
5838
5943
  * ```js
5839
5944
  * disabledActions: [Action.AxisMenuTextWrapping]
5840
5945
  * ```
5841
- * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
5946
+ * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
5842
5947
  */
5843
5948
  AxisMenuTextWrapping = "axisMenuTextWrapping",
5844
5949
  /**
@@ -5850,7 +5955,7 @@ export declare enum Action {
5850
5955
  * ```js
5851
5956
  * disabledActions: [Action.AxisMenuRemove]
5852
5957
  * ```
5853
- * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
5958
+ * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
5854
5959
  */
5855
5960
  AxisMenuRemove = "axisMenuRemove",
5856
5961
  /**
@@ -5864,26 +5969,27 @@ export declare enum Action {
5864
5969
  * ```js
5865
5970
  * disabledActions: [Action.RenameModalTitleDescription]
5866
5971
  * ```
5867
- * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
5972
+ * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl, 9.8.0.sw
5868
5973
  */
5869
5974
  RenameModalTitleDescription = "renameModalTitleDescription",
5870
5975
  /**
5871
- *
5976
+ * The *Request verification* action on a Liveboard.
5977
+ * Initiates a request for Liveboard verification.
5872
5978
  * @example
5873
5979
  * ```js
5874
5980
  * disabledActions: [Action.RequestVerification]
5875
5981
  * ```
5876
- * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
5982
+ * @version SDK: 1.25.0 | ThoughtSpot: 9.6.0.cl, 10.1.0.sw
5877
5983
  */
5878
5984
  RequestVerification = "requestVerification",
5879
5985
  /**
5880
5986
  *
5881
- *Allows users to mark a Liveboard as verified.
5987
+ * Allows users to mark a Liveboard as verified.
5882
5988
  * @example
5883
5989
  * ```js
5884
5990
  * disabledActions: [Action.MarkAsVerified]
5885
5991
  * ```
5886
- * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
5992
+ * @version SDK: 1.25.0 | ThoughtSpot: 9.6.0.cl, 10.1.0.sw
5887
5993
  */
5888
5994
  MarkAsVerified = "markAsVerified",
5889
5995
  /**
@@ -5893,7 +5999,7 @@ export declare enum Action {
5893
5999
  * ```js
5894
6000
  * disabledActions: [Action.AddTab]
5895
6001
  * ```
5896
- * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
6002
+ * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
5897
6003
  */
5898
6004
  AddTab = "addTab",
5899
6005
  /**
@@ -5903,35 +6009,42 @@ export declare enum Action {
5903
6009
  * ```js
5904
6010
  * disabledActions: [Action.EnableContextualChangeAnalysis]
5905
6011
  * ```
5906
- * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
6012
+ * @version SDK: 1.25.0 | ThoughtSpot Cloud: 9.6.0.cl
5907
6013
  */
5908
6014
  EnableContextualChangeAnalysis = "enableContextualChangeAnalysis",
5909
6015
  /**
6016
+ * Action ID to hide or disable Natural Language Search query.
5910
6017
  *
5911
6018
  * @example
5912
6019
  * ```js
5913
6020
  * disabledActions: [Action.ShowSageQuery]
5914
6021
  * ```
5915
- * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
6022
+ * @version SDK: 1.26.0 | ThoughtSpot Cloud: 9.7.0.cl
5916
6023
  */
5917
6024
  ShowSageQuery = "showSageQuery",
5918
6025
  /**
6026
+ *
6027
+ * Action ID to hide or disable the edit option for the
6028
+ * results generated from the
6029
+ * Natural Language Search query.
5919
6030
  *
5920
6031
  * @example
5921
6032
  * ```js
5922
6033
  * disabledActions: [Action.EditSageAnswer]
5923
6034
  * ```
5924
- * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
6035
+ * @version SDK: 1.26.0 | ThoughtSpot Cloud: 9.7.0.cl
5925
6036
  */
5926
6037
  EditSageAnswer = "editSageAnswer",
5927
6038
  /**
6039
+ * The feedback widget for AI-generated Answers.
6040
+ * Allows users to send feedback on the Answers generated
6041
+ * from a Natural Language Search query.
5928
6042
  *
5929
- *This action allows users to send feedback on AI-generated Answers.
5930
6043
  * @example
5931
6044
  * ```js
5932
6045
  * disabledActions: [Action.SageAnswerFeedback]
5933
6046
  * ```
5934
- * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
6047
+ * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl
5935
6048
  */
5936
6049
  SageAnswerFeedback = "sageAnswerFeedback",
5937
6050
  /**
@@ -5940,7 +6053,7 @@ export declare enum Action {
5940
6053
  * ```js
5941
6054
  * disabledActions: [Action.ModifySageAnswer]
5942
6055
  * ```
5943
- * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
6056
+ * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl
5944
6057
  */
5945
6058
  ModifySageAnswer = "modifySageAnswer",
5946
6059
  /**
@@ -5953,7 +6066,10 @@ export declare enum Action {
5953
6066
  */
5954
6067
  MoveToTab = "onContainerMove",
5955
6068
  /**
5956
- * The **Manage Alertsb** menu action on KPI visualizations.
6069
+ * The **Manage Alerts** menu action on KPI visualizations.
6070
+ * Allows creating, viewing, and editing monitor
6071
+ * alerts for a KPI chart.
6072
+ *
5957
6073
  * @example
5958
6074
  * ```js
5959
6075
  * disabledActions: [Action.ManageMonitor]
@@ -5961,21 +6077,23 @@ export declare enum Action {
5961
6077
  */
5962
6078
  ManageMonitor = "manageMonitor",
5963
6079
  /**
5964
- * Action ID for Liveboard Personalised Views dropdown
6080
+ * The Liveboard Personalised Views dropdown.
6081
+ * Allows navigating to a personalized Liveboard View.
5965
6082
  * @example
5966
6083
  * ```js
5967
6084
  * disabledActions: [Action.PersonalisedViewsDropdown]
5968
6085
  * ```
5969
- * @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl
6086
+ * @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw
5970
6087
  */
5971
6088
  PersonalisedViewsDropdown = "personalisedViewsDropdown",
5972
6089
  /**
5973
- * Action ID for Liveboard Users ( Recently Visited / social proof )
6090
+ * Action ID for show or hide the user details on a
6091
+ * Liveboard (Recently visited / social proof)
5974
6092
  * @example
5975
6093
  * ```js
5976
6094
  * disabledActions: [Action.LiveboardUsers]
5977
6095
  * ```
5978
- * @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl
6096
+ * @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw
5979
6097
  */
5980
6098
  LiveboardUsers = "liveboardUsers",
5981
6099
  /**
@@ -5993,108 +6111,124 @@ export declare enum Action {
5993
6111
  * hiddenAction: [Action.TML] // hide all TML actions
5994
6112
  * disabledActions: [Action.TML] // to disable all TML actions
5995
6113
  * ```
5996
- * @version SDK : 1.28.3 | Thoughtspot: 9.12.0.cl
6114
+ * @version SDK : 1.28.3 | ThoughtSpot: 9.12.0.cl, 10.1.0.sw
5997
6115
  */
5998
6116
  TML = "tml",
5999
6117
  /**
6000
- * Action ID for the create Liveboard option on the Liveboard list page
6001
- * and Pin modal
6118
+ * The **Create Liveboard* action on
6119
+ * the Liveboards page and the Pin modal.
6120
+ * Allows users to create a Liveboard.
6121
+ *
6002
6122
  * @example
6003
6123
  * ```js
6004
6124
  * hiddenAction: [Action.CreateLiveboard]
6005
6125
  * disabledActions: [Action.CreateLiveboard]
6006
6126
  * ```
6007
- * @version SDK: 1.32.0 | Thoughtspot: 10.1.0.cl
6127
+ * @version SDK: 1.32.0 | ThoughtSpot: 10.1.0.cl, 10.1.0.sw
6008
6128
  */
6009
6129
  CreateLiveboard = "createLiveboard",
6010
6130
  /**
6011
- * Action ID for to hide Verified Liveboard Banner
6131
+ * Action ID for to hide or disable the
6132
+ * Verified Liveboard banner.
6012
6133
  * @example
6013
6134
  * ```js
6014
6135
  * hiddenAction: [Action.VerifiedLiveboard]
6015
6136
  * ```
6016
- * @version SDK: 1.29.0 | Thoughtspot: 9.10.0.cl
6137
+ * @version SDK: 1.29.0 | ThoughtSpot: 9.10.0.cl, 10.1.0.sw
6017
6138
  */
6018
6139
  VerifiedLiveboard = "verifiedLiveboard",
6019
6140
  /**
6020
- * Action ID for ask sage button
6141
+ * The *Ask Sage* action for Answers and visualizations.
6142
+ * Allows initiating a Natural Language Search query.
6143
+ *
6021
6144
  * @example
6022
6145
  * ```js
6023
6146
  * hiddenAction: [Action.AskAi]
6024
6147
  * ```
6025
- * @version SDK: 1.29.0 | Thoughtspot: 9.12.0.cl
6148
+ * @version SDK: 1.29.0 | ThoughtSpot Cloud: 9.12.0.cl
6026
6149
  */
6027
6150
  AskAi = "AskAi",
6028
6151
  /**
6029
6152
  * The **Add KPI to Watchlist** action on Home page watchlist.
6153
+ * Adds a KPI chart to the watchlist on the Home page.
6030
6154
  * @example
6031
6155
  * ```js
6032
6156
  * disabledActions: [Action.AddToWatchlist]
6033
6157
  * ```
6034
- * @version SDK : 1.27.9 | Thoughtspot: 9.12.5.cl
6158
+ * @version SDK : 1.27.9 | ThoughtSpot Cloud: 9.12.5.cl
6035
6159
  */
6036
6160
  AddToWatchlist = "addToWatchlist",
6037
6161
  /**
6038
6162
  * The **Remove from watchlist** menu action on KPI watchlist.
6163
+ * Removes a KPI chart from the watchlist on the Home page.
6039
6164
  * @example
6040
6165
  * ```js
6041
6166
  * disabledActions: [Action.RemoveFromWatchlist]
6042
6167
  * ```
6043
- * @version SDK : 1.27.9 | Thoughtspot: 9.12.5.cl
6168
+ * @version SDK : 1.27.9 | ThoughtSpot: 9.12.5.cl
6044
6169
  */
6045
6170
  RemoveFromWatchlist = "removeFromWatchlist",
6046
6171
  /**
6047
- * The **Organise Favourites** action on Homepage Favourite Module.
6172
+ * The **Organize Favourites** action on Homepage
6173
+ * *Favorites* module.
6174
+ *
6048
6175
  * @example
6049
6176
  * ```js
6050
6177
  * disabledActions: [Action.OrganiseFavourites]
6051
6178
  * ```
6052
- * @version SDK : 1.32.0 | Thoughtspot: 10.0.0.cl
6179
+ * @version SDK : 1.32.0 | ThoughtSpot: 10.0.0.cl
6053
6180
  */
6054
6181
  OrganiseFavourites = "organiseFavourites",
6055
6182
  /**
6056
- * Action ID for AI Highlights button
6183
+ * The **AI Highlights** action on a Liveboard.
6184
+ *
6057
6185
  * @example
6058
6186
  * ```js
6059
6187
  * hiddenAction: [Action.AIHighlights]
6060
6188
  * ```
6061
- * @version SDK: 1.27.10 | Thoughtspot: 9.12.5.cl
6189
+ * @version SDK: 1.27.10 | ThoughtSpot Cloud: 9.12.5.cl
6062
6190
  */
6063
6191
  AIHighlights = "AIHighlights",
6064
6192
  /**
6065
- * Action ID for edit the schedule action on schedule on homepage
6193
+ * The *Edit* action on the *Liveboard Schedules* page
6194
+ * (new Homepage experience).
6195
+ * Allows editing Liveboard schedules.
6196
+ *
6066
6197
  * @example
6067
6198
  * ```js
6068
6199
  * disabledActions: [Action.EditScheduleHomepage]
6069
6200
  * ```
6070
- * @version SDK: 1.34.0 | Thoughtspot: 10.3.0.cl
6201
+ * @version SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
6071
6202
  */
6072
6203
  EditScheduleHomepage = "editScheduleHomepage",
6073
6204
  /**
6074
- * Action ID for pause schedule action on schedule on homepage
6205
+ * The *Pause* action on the *Liveboard Schedules* page
6206
+ * Pauses a scheduled Liveboard job.
6075
6207
  * @example
6076
6208
  * ```js
6077
6209
  * disabledActions: [Action.PauseScheduleHomepage]
6078
6210
  * ```
6079
- * @version SDK: 1.34.0 | Thoughtspot: 10.3.0.cl
6211
+ * @version SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
6080
6212
  */
6081
6213
  PauseScheduleHomepage = "pauseScheduleHomepage",
6082
6214
  /**
6083
- * Action ID for view schedule run action on schedule on homepage
6215
+ * The **View run history** action **Liveboard Schedules** page.
6216
+ * Allows viewing schedule run history.
6084
6217
  * @example
6085
6218
  * ```js
6086
6219
  * disabledActions: [Action.ViewScheduleRunHomepage]
6087
6220
  * ```
6088
- * @version SDK: 1.34.0 | Thoughtspot: 10.3.0.cl
6221
+ * @version SDK: 1.34.0 | ThoughtSpot: 10.3.0.cl
6089
6222
  */
6090
6223
  ViewScheduleRunHomepage = "viewScheduleRunHomepage",
6091
6224
  /**
6092
- * Action ID for unsubscribe schedule action on schedule on homepage
6225
+ * Action ID to hide or disable the
6226
+ * unsubscribe option for Liveboard schedules.
6093
6227
  * @example
6094
6228
  * ```js
6095
6229
  * disabledActions: [Action.UnsubscribeScheduleHomepage]
6096
6230
  * ```
6097
- * @version SDK: 1.34.0 | Thoughtspot: 10.3.0.cl
6231
+ * @version SDK: 1.34.0 | ThoughtSpot: 10.3.0.cl
6098
6232
  */
6099
6233
  UnsubscribeScheduleHomepage = "unsubscribeScheduleHomepage",
6100
6234
  /**
@@ -6103,16 +6237,17 @@ export declare enum Action {
6103
6237
  * ```js
6104
6238
  * disabledActions: [Action.ManageTags]
6105
6239
  * ```
6106
- * @version SDK : 1.34.0 | Thoughtspot: 10.3.0.cl
6240
+ * @version SDK : 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
6107
6241
  */
6108
6242
  ManageTags = "manageTags",
6109
6243
  /**
6110
- * Action ID for delete schedule action on schedule on homepage
6244
+ * The **Delete** action on the **Liveboard Schedules* page.
6245
+ * Deletes a Liveboard schedule.
6111
6246
  * @example
6112
6247
  * ```js
6113
6248
  * disabledActions: [Action.DeleteScheduleHomepage]
6114
6249
  * ```
6115
- * @version SDK: 1.34.0 | Thoughtspot: 10.3.0.cl
6250
+ * @version SDK: 1.34.0 | ThoughtSpot: 10.3.0.cl
6116
6251
  */
6117
6252
  DeleteScheduleHomepage = "deleteScheduleHomepage",
6118
6253
  /**
@@ -6121,7 +6256,7 @@ export declare enum Action {
6121
6256
  * ```js
6122
6257
  * disabledActions: [Action.KPIAnalysisCTA]
6123
6258
  * ```
6124
- * @version SDK: 1.34.0 | Thoughtspot: 10.3.0.cl
6259
+ * @version SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
6125
6260
  */
6126
6261
  KPIAnalysisCTA = "kpiAnalysisCTA",
6127
6262
  /**
@@ -6130,61 +6265,73 @@ export declare enum Action {
6130
6265
  * ```js
6131
6266
  * const disabledActions = [Action.DisableChipReorder]
6132
6267
  * ```
6133
- * @version SDK: 1.36.0 | Thoughtspot: 10.6.0.cl
6268
+ * @version SDK: 1.36.0 | ThoughtSpot Cloud: 10.6.0.cl
6134
6269
  */
6135
6270
  DisableChipReorder = "disableChipReorder",
6136
6271
  /**
6137
- * Action ID for Hide Irrelevant filters button
6272
+ * Action ID to show, hide, or disable filters
6273
+ * in a Liveboard tab.
6274
+ *
6138
6275
  * @example
6139
6276
  * ```js
6140
6277
  * hiddenAction: [Action.ChangeFilterVisibilityInTab]
6141
6278
  * ```
6142
- * @version SDK: 1.36.0 | Thoughtspot: 10.6.0.cl
6279
+ * @version SDK: 1.36.0 | ThoughtSpot Cloud: 10.6.0.cl
6143
6280
  */
6144
6281
  ChangeFilterVisibilityInTab = "changeFilterVisibilityInTab",
6145
6282
  /**
6146
- * Action ID for hide/disable Preview data button in spotter
6283
+ * The **Preview data** button on the Spotter interface.
6284
+ * Allows previewing the data used for Spotter queries.
6285
+ *
6147
6286
  * @example
6148
6287
  * ```js
6149
6288
  * hiddenAction: [Action.PreviewDataSpotter]
6150
6289
  * ```
6151
- * @version SDK: 1.36.0 | Thoughtspot: 10.6.0.cl
6290
+ * @version SDK: 1.36.0 | ThoughtSpot Cloud: 10.6.0.cl
6152
6291
  */
6153
6292
  PreviewDataSpotter = "previewDataSpotter",
6154
6293
  /**
6155
- * Action ID for hide/disable reset button in spotter
6294
+ * The **Reset** link on the Spotter interface.
6295
+ * Resets the conversation with Spotter.
6296
+ *
6156
6297
  * @example
6157
6298
  * ```js
6158
6299
  * hiddenAction: [Action.ResetSpotterChat]
6159
6300
  * ```
6160
- * @version SDK: 1.36.0 | Thoughtspot: 10.6.0.cl
6301
+ * @version SDK: 1.36.0 | ThoughtSpot Cloud: 10.6.0.cl
6161
6302
  */
6162
6303
  ResetSpotterChat = "resetSpotterChat",
6163
6304
  /**
6164
- * Action ID for hide/disable feedback in spotter
6305
+ * Action ID for hide or disable the
6306
+ * Spotter feedback widget.
6307
+ *
6165
6308
  * @example
6166
6309
  * ```js
6167
6310
  * hiddenAction: [Action.SpotterFeedback]
6168
6311
  * ```
6169
- * @version SDK: 1.36.0 | Thoughtspot: 10.6.0.cl
6312
+ * @version SDK: 1.36.0 | ThoughtSpot Cloud: 10.6.0.cl
6170
6313
  */
6171
6314
  SpotterFeedback = "spotterFeedback",
6172
6315
  /**
6173
- * Action ID for hide/disable editing previous prompt in spotter
6316
+ * Action ID for hide or disable
6317
+ * the previous prompt edit option in Spotter.
6318
+ *
6174
6319
  * @example
6175
6320
  * ```js
6176
6321
  * hiddenAction: [Action.EditPreviousPrompt]
6177
6322
  * ```
6178
- * @version SDK: 1.36.0 | Thoughtspot: 10.6.0.cl
6323
+ * @version SDK: 1.36.0 | ThoughtSpot Cloud: 10.6.0.cl
6179
6324
  */
6180
6325
  EditPreviousPrompt = "editPreviousPrompt",
6181
6326
  /**
6182
- * Action ID for hide/disable deleting previous prompt in spotter
6327
+ * Action ID for hide or disable
6328
+ * the previous prompt deletion option in Spotter.
6329
+ *
6183
6330
  * @example
6184
6331
  * ```js
6185
6332
  * hiddenAction: [Action.DeletePreviousPrompt]
6186
6333
  * ```
6187
- * @version SDK: 1.36.0 | Thoughtspot: 10.6.0.cl
6334
+ * @version SDK: 1.36.0 | ThoughtSpot Cloud: 10.6.0.cl
6188
6335
  */
6189
6336
  DeletePreviousPrompt = "deletePreviousPrompt",
6190
6337
  /**
@@ -6193,7 +6340,7 @@ export declare enum Action {
6193
6340
  * ```js
6194
6341
  * hiddenAction: [Action.EditTokens]
6195
6342
  * ```
6196
- * @version SDK: 1.36.0 | Thoughtspot: 10.6.0.cl
6343
+ * @version SDK: 1.36.0 | ThoughtSpot Cloud: 10.6.0.cl
6197
6344
  */
6198
6345
  EditTokens = "editTokens"
6199
6346
  }
@@ -6208,10 +6355,12 @@ export declare enum PrefetchFeatures {
6208
6355
  }
6209
6356
  /**
6210
6357
  * Enum for options to change context trigger
6358
+ * BOTH_CLICKS option is introduced in 10.7
6211
6359
  */
6212
6360
  export declare enum ContextMenuTriggerOptions {
6213
6361
  LEFT_CLICK = "left-click",
6214
- RIGHT_CLICK = "right-click"
6362
+ RIGHT_CLICK = "right-click",
6363
+ BOTH_CLICKS = "both-clicks"
6215
6364
  }
6216
6365
  export interface ColumnValue {
6217
6366
  column: {
@@ -6264,7 +6413,7 @@ export declare enum LogLevel {
6264
6413
  * logLevel: LogLevel.SILENT,
6265
6414
  * })
6266
6415
  * ```
6267
- * @version SDK: 1.26.7 | Thoughtspot: 9.10.0.cl
6416
+ * @version SDK: 1.26.7 | ThoughtSpot Cloud: 9.10.0.cl
6268
6417
  */
6269
6418
  SILENT = "SILENT",
6270
6419
  /**
@@ -6276,7 +6425,7 @@ export declare enum LogLevel {
6276
6425
  * logLevel: LogLevel.ERROR,
6277
6426
  * })
6278
6427
  * ```
6279
- * @version SDK: 1.26.7 | Thoughtspot: 9.10.0.cl
6428
+ * @version SDK: 1.26.7 | ThoughtSpot Cloud: 9.10.0.cl
6280
6429
  */
6281
6430
  ERROR = "ERROR",
6282
6431
  /**
@@ -6288,7 +6437,7 @@ export declare enum LogLevel {
6288
6437
  * logLevel: LogLevel.WARN,
6289
6438
  * })
6290
6439
  * ```
6291
- * @version SDK: 1.26.7 | Thoughtspot: 9.10.0.cl
6440
+ * @version SDK: 1.26.7 | ThoughtSpot Cloud: 9.10.0.cl
6292
6441
  */
6293
6442
  WARN = "WARN",
6294
6443
  /**
@@ -6300,7 +6449,7 @@ export declare enum LogLevel {
6300
6449
  * logLevel: LogLevel.INFO,
6301
6450
  * })
6302
6451
  * ```
6303
- * @version SDK: 1.26.7 | Thoughtspot: 9.10.0.cl
6452
+ * @version SDK: 1.26.7 | ThoughtSpot Cloud: 9.10.0.cl
6304
6453
  */
6305
6454
  INFO = "INFO",
6306
6455
  /**
@@ -6312,7 +6461,7 @@ export declare enum LogLevel {
6312
6461
  * logLevel: LogLevel.DEBUG,
6313
6462
  * })
6314
6463
  * ```
6315
- * @version SDK: 1.26.7 | Thoughtspot: 9.10.0.cl
6464
+ * @version SDK: 1.26.7 | ThoughtSpot Cloud: 9.10.0.cl
6316
6465
  */
6317
6466
  DEBUG = "DEBUG",
6318
6467
  /**
@@ -6324,7 +6473,7 @@ export declare enum LogLevel {
6324
6473
  * logLevel: LogLevel.TRACE,
6325
6474
  * })
6326
6475
  * ```
6327
- * @version SDK: 1.26.7 | Thoughtspot: 9.10.0.cl
6476
+ * @version SDK: 1.26.7 | ThoughtSpot Cloud: 9.10.0.cl
6328
6477
  */
6329
6478
  TRACE = "TRACE"
6330
6479
  }
@@ -6652,7 +6801,7 @@ export declare enum UIPassthroughEvent {
6652
6801
  PinAnswerToLiveboard = "addVizToPinboard",
6653
6802
  SaveAnswer = "saveAnswer",
6654
6803
  GetDiscoverabilityStatus = "getDiscoverabilityStatus",
6655
- GetAvailableUIPassthroughs = "getAvailableUIPassthroughs",
6804
+ GetAvailableUIPassthroughs = "getAvailableUiPassthroughs",
6656
6805
  GetAnswerConfig = "getAnswerPageConfig",
6657
6806
  GetLiveboardConfig = "getPinboardPageConfig"
6658
6807
  }