@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
@@ -257,8 +257,17 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
257
257
  */
258
258
  enableSearchAssist?: boolean;
259
259
  /**
260
- * If set to true, the embedded object container dynamically resizes
261
- * according to the height of the pages which support fullHeight mode.
260
+ * If set to true, the Liveboard container dynamically resizes
261
+ * according to the height of the Liveboard.
262
+ *
263
+ * **Note**: Using fullHeight loads all visualizations
264
+ * on the Liveboard simultaneously, which results in
265
+ * multiple warehouse queries and potentially a
266
+ * longer wait for the topmost visualizations to
267
+ * display on the screen. Setting fullHeight to
268
+ * `false` fetches visualizations incrementally as
269
+ * users scroll the page to view the charts and tables.
270
+ *
262
271
  * @version SDK: 1.21.0 | ThoughtSpot: 9.4.0.cl, 9.4.0-sw
263
272
  * @example
264
273
  * ```js
@@ -657,12 +666,14 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
657
666
  /**
658
667
  * If set to true, the embedded object container dynamically resizes
659
668
  * according to the height of the Liveboard.
669
+ *
660
670
  * **Note**: Using fullHeight loads all visualizations on the
661
671
  * Liveboard simultaneously, which results in multiple warehouse
662
672
  * queries and potentially a longer wait for the topmost
663
673
  * visualizations to display on the screen.
664
674
  * Setting `fullHeight` to `false` fetches visualizations
665
675
  * incrementally as users scroll the page to view the charts and tables.
676
+ *
666
677
  * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 7.2.1
667
678
  * @example
668
679
  * ```js
@@ -1024,10 +1035,11 @@ export class LiveboardEmbed extends V1Embed {
1024
1035
  protected handleRenderForPrerender(): void;
1025
1036
  /**
1026
1037
  * Triggers an event to the embedded app
1027
- * @param messageType The event type
1028
- * @param data The payload to send with the message
1038
+ * @param {HostEvent} messageType The event type
1039
+ * @param {any} data The payload to send with the message
1040
+ * @returns A promise that resolves with the response from the embedded app
1029
1041
  */
1030
- trigger<HostEventT extends HostEvent>(messageType: HostEventT, data?: HostEventRequest<HostEventT>): Promise<HostEventResponse<HostEventT>>;
1042
+ trigger<HostEventT extends HostEvent, PayloadT>(messageType: HostEventT, data?: TriggerPayload<PayloadT, HostEventT>): Promise<TriggerResponse<PayloadT, HostEventT>>;
1031
1043
  /**
1032
1044
  * Render an embedded ThoughtSpot Liveboard or visualization
1033
1045
  * @param renderOptions An object specifying the Liveboard ID,
@@ -1806,7 +1818,7 @@ export function resetCachedSessionInfo(): void;
1806
1818
  */
1807
1819
  export enum AuthType {
1808
1820
  /**
1809
- * No authentication on the SDK. Passthrough to the embedded App. Alias for
1821
+ * No authentication on the SDK. Pass-through to the embedded App. Alias for
1810
1822
  * `Passthrough`.
1811
1823
  * @example
1812
1824
  * ```js
@@ -2003,8 +2015,8 @@ export interface customCssInterface {
2003
2015
  /**
2004
2016
  * The custom css variables, which can be set.
2005
2017
  * The allowed list is in the CustomCssVariables
2006
- * interface.
2007
- * Or here: https://try-everywhere.thoughtspot.cloud/resources/static/css/custom_variables.css
2018
+ * interface. For more information, see
2019
+ * link:https://developers.thoughtspot.com/docs/css-variables-reference
2008
2020
  */
2009
2021
  variables?: CustomCssVariables;
2010
2022
  /**
@@ -2046,7 +2058,7 @@ export interface CustomStyles {
2046
2058
  }
2047
2059
  /**
2048
2060
  * Configuration to define the customization on the Embedded
2049
- * Thoughtspot components.
2061
+ * ThoughtSpot components.
2050
2062
  * You can customize styles, text strings, and icons.
2051
2063
  * For more information, see https://developers.thoughtspot.com/docs/custom-css.
2052
2064
  * @example
@@ -2166,7 +2178,7 @@ export interface EmbedConfig {
2166
2178
  /**
2167
2179
  * Boolean to define if the query parameters in the ThoughtSpot URL
2168
2180
  * should be encoded in base64. This provides additional security to
2169
- * Thoughtspot clusters against cross-site scripting attacks.
2181
+ * ThoughtSpot clusters against cross-site scripting attacks.
2170
2182
  * @default false
2171
2183
  */
2172
2184
  shouldEncodeUrlQueryParams?: boolean;
@@ -2319,18 +2331,18 @@ export interface EmbedConfig {
2319
2331
  */
2320
2332
  disableSDKTracking?: boolean;
2321
2333
  /**
2322
- * Overrides default/user preffered locale for date formatting
2323
- * @version SDK: 1.28.4 | Thoughtspot: 10.0.0.cl, 9.5.0.sw
2334
+ * Overrides default/user preferred locale for date formatting
2335
+ * @version SDK: 1.28.4 | ThoughtSpot: 10.0.0.cl, 9.5.0.sw
2324
2336
  */
2325
2337
  dateFormatLocale?: string;
2326
2338
  /**
2327
- * Overrides default/user preffered locale for number formatting
2328
- * @version SDK: 1.28.4 | Thoughtspot: 10.0.0.cl, 9.5.0.sw
2339
+ * Overrides default/user preferred locale for number formatting
2340
+ * @version SDK: 1.28.4 | ThoughtSpot: 10.0.0.cl, 9.5.0.sw
2329
2341
  */
2330
2342
  numberFormatLocale?: string;
2331
2343
  /**
2332
2344
  * Format to be used for currency when currency format is set to infer from browser
2333
- * @version SDK: 1.28.4 | Thoughtspot: 10.0.0.cl, 9.5.0.sw
2345
+ * @version SDK: 1.28.4 | ThoughtSpot: 10.0.0.cl, 9.5.0.sw
2334
2346
  */
2335
2347
  currencyFormat?: string;
2336
2348
  /**
@@ -2344,12 +2356,12 @@ export interface EmbedConfig {
2344
2356
  * disableTokenVerification : true
2345
2357
  * })
2346
2358
  * ```
2347
- * @version SDK: 1.28.5 | Thoughtspot: *
2359
+ * @version SDK: 1.28.5 | ThoughtSpot: 9.10.0.cl, 10.1.0.sw
2348
2360
  */
2349
2361
  disableTokenVerification?: boolean;
2350
2362
  /**
2351
2363
  * This flag is used to disable showing the login failure page in the embedded app.
2352
- * @version SDK 1.32.3 | Thoughtspot: *
2364
+ * @version SDK 1.32.3 | ThoughtSpot: 10.1.0.cl, 10.1.0.sw
2353
2365
  */
2354
2366
  disableLoginFailurePage?: boolean;
2355
2367
  /**
@@ -2387,7 +2399,7 @@ export interface EmbedConfig {
2387
2399
  * }
2388
2400
  * });
2389
2401
  * ```
2390
- * @version SDK 1.37.0 | Thoughtspot: 10.7.0.cl
2402
+ * @version SDK 1.37.0 | ThoughtSpot: 10.7.0.cl
2391
2403
  */
2392
2404
  customVariablesForThirdPartyTools?: Record<string, any>;
2393
2405
  }
@@ -2546,7 +2558,7 @@ export interface ViewConfig {
2546
2558
  /**
2547
2559
  * The list of parameter override to apply to a search answer,
2548
2560
  * visualization, or Liveboard.
2549
- * @version SDK : 1.25.0 | Thoughtspot: 9.2.0.cl, 9.5.0.sw
2561
+ * @version SDK : 1.25.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
2550
2562
  * @example
2551
2563
  * ```js
2552
2564
  * const embed = new LiveboardEmbed('#embed-container', {
@@ -2606,7 +2618,7 @@ export interface ViewConfig {
2606
2618
  /**
2607
2619
  * Insert as a sibling of the target container, instead of appending to a
2608
2620
  * child inside it.
2609
- * @version SDK: 1.2.0 | Thoughtspot: 9.0.0.cl, 9.0.0.sw
2621
+ * @version SDK: 1.2.0 | ThoughtSpot: 9.0.0.cl, 9.0.0.sw
2610
2622
  * @example
2611
2623
  * ```js
2612
2624
  * const embed = new LiveboardEmbed('#embed-container', {
@@ -2679,7 +2691,7 @@ export interface ViewConfig {
2679
2691
  * 'f547ec54-2a37-4516-a222-2b06719af726']
2680
2692
  * });
2681
2693
  * ```
2682
- * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
2694
+ * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw
2683
2695
  */
2684
2696
  hiddenTabs?: string[];
2685
2697
  /**
@@ -2689,7 +2701,7 @@ export interface ViewConfig {
2689
2701
  * **Note**: This option does not apply to the classic homepage.
2690
2702
  * To access the updated modular homepage, set
2691
2703
  * `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
2692
- * @version SDK: 1.28.0 | Thoughtspot: 9.12.5.cl
2704
+ * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
2693
2705
  * @example
2694
2706
  * ```js
2695
2707
  * const embed = new AppEmbed('#tsEmbed', {
@@ -2706,7 +2718,7 @@ export interface ViewConfig {
2706
2718
  * **Note**: This option does not apply to the classic homepage.
2707
2719
  * To access the updated modular homepage, set
2708
2720
  * `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
2709
- * @version SDK: 1.28.0| Thoughtspot: 9.12.5.cl
2721
+ * @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl, 10.1.0.sw
2710
2722
  * @example
2711
2723
  * ```js
2712
2724
  * const embed = new AppEmbed('#tsEmbed', {
@@ -2721,7 +2733,7 @@ export interface ViewConfig {
2721
2733
  * Only the tabs specified in the array will be shown in the Liveboard.
2722
2734
  *
2723
2735
  * Use either `visibleTabs` or `hiddenTabs`.
2724
- * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
2736
+ * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw
2725
2737
  * @example
2726
2738
  * ```js
2727
2739
  * const embed = new LiveboardEmbed('#embed-container', {
@@ -2749,7 +2761,7 @@ export interface ViewConfig {
2749
2761
  * **Note**: This option does not apply to the classic homepage.
2750
2762
  * To access the updated modular homepage, set
2751
2763
  * `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
2752
- * @version SDK: 1.28.0 | Thoughtspot: 9.12.5.cl
2764
+ * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
2753
2765
  */
2754
2766
  hiddenHomeLeftNavItems?: HomeLeftNavItem[];
2755
2767
  /**
@@ -2764,7 +2776,7 @@ export interface ViewConfig {
2764
2776
  * });
2765
2777
  * embed.showPreRender();
2766
2778
  * ```
2767
- * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl, 9.8.0.sw
2779
+ * @version SDK: 1.25.0 | ThoughtSpot: 9.6.0.cl, 9.8.0.sw
2768
2780
  */
2769
2781
  preRenderId?: string;
2770
2782
  /**
@@ -2818,7 +2830,7 @@ export interface ViewConfig {
2818
2830
  /**
2819
2831
  * To set the initial state of the search bar in case of saved Answers.
2820
2832
  * @default true
2821
- * @version SDK: 1.34.0 | Thoughtspot: 10.3.0.cl
2833
+ * @version SDK: 1.34.0 | ThoughtSpot: 10.3.0.cl
2822
2834
  * @example
2823
2835
  * ```js
2824
2836
  * const embed = new LiveboardEmbed('#embed', {
@@ -2842,7 +2854,7 @@ export interface ViewConfig {
2842
2854
  /**
2843
2855
  * Flag to control Data panel experience
2844
2856
  * @default false
2845
- * @version SDK: 1.34.0 | Thoughtspot: 10.3.0.cl
2857
+ * @version SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
2846
2858
  * @example
2847
2859
  * ```js
2848
2860
  * const embed = new AppEmbed('#tsEmbed', {
@@ -2854,7 +2866,7 @@ export interface ViewConfig {
2854
2866
  dataPanelV2?: boolean;
2855
2867
  /**
2856
2868
  * To enable custom column groups in data panel v2
2857
- * @version SDK: 1.32.0 | Thoughtspot: 10.0.0.cl
2869
+ * @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl, 10.1.0.sw
2858
2870
  * @default false
2859
2871
  * @example
2860
2872
  * ```js
@@ -2882,9 +2894,10 @@ export interface ViewConfig {
2882
2894
  */
2883
2895
  overrideOrgId?: number;
2884
2896
  /**
2885
- * Flag to control new flip tooltip context menu experience
2897
+ * Flag to enhance the visual effects of charts
2898
+ * This feature is a beta release for 10.6
2886
2899
  * @default false
2887
- * @version SDK: 1.36.0 | Thoughtspot: 10.6.0.cl
2900
+ * @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
2888
2901
  */
2889
2902
  enableFlipTooltipToContextMenu?: boolean;
2890
2903
  }
@@ -3004,7 +3017,7 @@ export enum RuntimeFilterOp {
3004
3017
  * **Note**: This option does not apply to the classic homepage.
3005
3018
  * To access the updated modular homepage, set
3006
3019
  * `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
3007
- * @version SDK: 1.28.0 | Thoughtspot: 9.12.5.cl
3020
+ * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
3008
3021
  */
3009
3022
  export enum HomepageModule {
3010
3023
  /**
@@ -3847,7 +3860,7 @@ export enum EmbedEvent {
3847
3860
  */
3848
3861
  Explore = "explore",
3849
3862
  /**
3850
- * Emitted when a user clicks **Copy link** action on a visualization
3863
+ * Emitted when a user clicks **Copy link** action on a visualization.
3851
3864
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
3852
3865
  * @example
3853
3866
  *```js
@@ -3897,23 +3910,26 @@ export enum EmbedEvent {
3897
3910
  */
3898
3911
  FilterChanged = "filterChanged",
3899
3912
  /**
3900
- * Emitted when a user clicks the **Go** button on the sage embed
3901
- * @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
3913
+ * Emitted when a user clicks the **Go** button to initiate
3914
+ * a Natural Language Search query
3915
+ * @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
3902
3916
  */
3903
3917
  SageEmbedQuery = "sageEmbedQuery",
3904
3918
  /**
3905
- * Emitted when a user selects a data source on the sage embed
3906
- * @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
3919
+ * Emitted when a user selects a data source on the embedded
3920
+ * Natural Language Search interface.
3921
+ *
3922
+ * @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
3907
3923
  */
3908
3924
  SageWorksheetUpdated = "sageWorksheetUpdated",
3909
3925
  /**
3910
3926
  * Emitted when a user updates a connection on the **Data** page
3911
- * @version SDK : 1.27.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
3927
+ * @version SDK : 1.27.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
3912
3928
  */
3913
3929
  UpdateConnection = "updateConnection",
3914
3930
  /**
3915
3931
  * Emitted when a user updates a connection on the **Data** page
3916
- * @version SDK : 1.27.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
3932
+ * @version SDK : 1.27.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
3917
3933
  */
3918
3934
  CreateConnection = "createConnection",
3919
3935
  /**
@@ -3923,7 +3939,7 @@ export enum EmbedEvent {
3923
3939
  * @returns viewId: string
3924
3940
  * @returns liveboardId: string
3925
3941
  * @returns isPublic: boolean
3926
- * @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
3942
+ * @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
3927
3943
  */
3928
3944
  UpdatePersonalisedView = "updatePersonalisedView",
3929
3945
  /**
@@ -3932,7 +3948,7 @@ export enum EmbedEvent {
3932
3948
  * @returns viewId: string
3933
3949
  * @returns liveboardId: string
3934
3950
  * @returns isPublic: boolean
3935
- * @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
3951
+ * @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
3936
3952
  */
3937
3953
  SavePersonalisedView = "savePersonalisedView",
3938
3954
  /**
@@ -3941,28 +3957,28 @@ export enum EmbedEvent {
3941
3957
  * @returns viewId: string
3942
3958
  * @returns liveboardId: string
3943
3959
  * @returns isPublic: boolean
3944
- * @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
3960
+ * @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
3945
3961
  */
3946
3962
  ResetLiveboard = "resetLiveboard",
3947
3963
  /**
3948
3964
  * Emitted when a PersonalisedView is deleted.
3949
3965
  * @returns views: string[]
3950
3966
  * @returns liveboardId: string
3951
- * @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
3967
+ * @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
3952
3968
  */
3953
3969
  DeletePersonalisedView = "deletePersonalisedView",
3954
3970
  /**
3955
3971
  * Emitted when a user creates a new worksheet
3956
- * @version SDK : 1.27.0 | Thoughtspot: 9.8.0.cl
3972
+ * @version SDK : 1.27.0 | ThoughtSpot Cloud: 9.8.0.cl
3957
3973
  */
3958
3974
  CreateWorksheet = "createWorksheet",
3959
3975
  /**
3960
- * Emitted when Ask Sage is initialized.
3976
+ * Emitted when the *Ask Sage* is initialized.
3961
3977
  * @returns viewName: string
3962
3978
  * @returns viewId: string
3963
3979
  * @returns liveboardId: string
3964
3980
  * @returns isPublic: boolean
3965
- * @version SDK : 1.29.0 | Thoughtspot: 9.12.0.cl
3981
+ * @version SDK : 1.29.0 | ThoughtSpot Cloud: 9.12.0.cl
3966
3982
  */
3967
3983
  AskSageInit = "AskSageInit",
3968
3984
  /**
@@ -3990,7 +4006,7 @@ export enum EmbedEvent {
3990
4006
  *
3991
4007
  * error: Developers can customize the error message text when `execute`
3992
4008
  * returns `false` using the error parameter in responder.
3993
- * @version SDK : 1.29.0 | Thoughtspot : 10.3.0.cl
4009
+ * @version SDK : 1.29.0 | ThoughtSpot : 10.3.0.cl
3994
4010
  * @example
3995
4011
  *```js
3996
4012
  * .on(EmbedEvent.OnBeforeGetVizDataIntercept,
@@ -4038,9 +4054,26 @@ export enum EmbedEvent {
4038
4054
  * console.log('payload', payload);
4039
4055
  * })
4040
4056
  *```
4041
- * @version SDK : 1.29.0 | Thoughtspot : 10.3.0.cl
4057
+ * @version SDK : 1.29.0 | ThoughtSpot : 10.3.0.cl
4042
4058
  */
4043
- ParameterChanged = "parameterChanged"
4059
+ ParameterChanged = "parameterChanged",
4060
+ /**
4061
+ * Emitted when the table viz renders.
4062
+ * You can use this event as a hook to trigger
4063
+ * other events on the rendered table viz data.
4064
+ * @example
4065
+ * ```js
4066
+ * searchEmbed.on(EmbedEvent.TableVizRendered, (payload) => {
4067
+ * console.log(payload);
4068
+ * const columnDataLite = payload.data.data.columnDataLite;
4069
+ * columnDataLite[0].dataValue[0]="new fob";
4070
+ * console.log('>>> new Data', columnDataLite);
4071
+ * searchEmbed.trigger(HostEvent.TransformTableVizData, columnDataLite);
4072
+ * })
4073
+ * ```
4074
+ * @version SDK: 1.35.12 | ThoughtSpot: 10.7.0.cl
4075
+ */
4076
+ TableVizRendered = "TableVizRendered"
4044
4077
  }
4045
4078
  /**
4046
4079
  * Event types that can be triggered by the host application
@@ -4185,7 +4218,7 @@ export enum HostEvent {
4185
4218
  * const url = embed.trigger(HostEvent.GetIframeUrl);
4186
4219
  * console.log("iFrameURL",url);
4187
4220
  * ```
4188
- * @version SDK: 1.35.0 | Thoughtspot: 10.4.0.cl
4221
+ * @version SDK: 1.35.0 | ThoughtSpot: 10.4.0.cl
4189
4222
  */
4190
4223
  GetIframeUrl = "GetIframeUrl",
4191
4224
  /**
@@ -4218,6 +4251,11 @@ export enum HostEvent {
4218
4251
  * attributes passed with this event are appended to the existing runtime
4219
4252
  * filters applied on a Liveboard.
4220
4253
  *
4254
+ * **Note**: `HostEvent.UpdateRuntimeFilters` is supported in `LiveboardEmbed`
4255
+ * and `AppEmbed` only. In full application embedding, this event updates
4256
+ * the runtime filters applied on the Liveboard and saved Answer objects.
4257
+ *
4258
+ *
4221
4259
  * Pass an array of runtime filters with the following attributes:
4222
4260
  *
4223
4261
  * `columnName` - _String_. The name of the column to filter on.
@@ -4228,9 +4266,12 @@ export enum HostEvent {
4228
4266
  * `values` - List of operands. Some operators such as EQ and LE allow a
4229
4267
  * single value, whereas BW and IN accept multiple values.
4230
4268
  *
4231
- * **Note**: `HostEvent.UpdateRuntimeFilters` is supported in `LiveboardEmbed`
4232
- * and `AppEmbed` only. In full application embedding, this event updates
4233
- * the runtime filters applied on the Liveboard and saved Answer objects.
4269
+ * **Note**: Updating runtime filters resets the ThoughtSpot
4270
+ * object to its original state and applies new filter conditions.
4271
+ * Any user changes (like drilling into a visualization)
4272
+ * will be cleared, restoring the original visualization
4273
+ * with the updated filters.
4274
+ *
4234
4275
  * @param - {@link RuntimeFilter}[] an array of {@link RuntimeFilter} Types.
4235
4276
  * @example
4236
4277
  * ```js
@@ -4245,7 +4286,7 @@ export enum HostEvent {
4245
4286
  UpdateRuntimeFilters = "UpdateRuntimeFilters",
4246
4287
  /**
4247
4288
  * Navigate to a specific page in the embedded ThoughtSpot application.
4248
- * This is the same as calling `appEmbed.navigateToPage(path, true)`
4289
+ * This is the same as calling `appEmbed.navigateToPage(path, true)`.
4249
4290
  * @param - `path` - the path to navigate to to go forward or back. The path value can
4250
4291
  * be a number; for example, `1`, `-1`.
4251
4292
  * @example
@@ -4441,7 +4482,7 @@ export enum HostEvent {
4441
4482
  * @param - an object with `vizId` as a key
4442
4483
  * @example
4443
4484
  * ```js
4444
- * liveboardEmbed.trigger(HostEvent.CreateMonitor {
4485
+ * liveboardEmbed.trigger(HostEvent.CreateMonitor, {
4445
4486
  * vizId: '730496d6-6903-4601-937e-2c691821af3c'
4446
4487
  * })
4447
4488
  * ```
@@ -4540,7 +4581,9 @@ export enum HostEvent {
4540
4581
  */
4541
4582
  GetTML = "getTML",
4542
4583
  /**
4543
- * Trigger the **Show underlying data** action on visualization or search
4584
+ * Trigger the **Show underlying data** action on a
4585
+ * chart or table.
4586
+ *
4544
4587
  * @param - an object with vizId as a key
4545
4588
  * @example
4546
4589
  * ```js
@@ -4574,8 +4617,8 @@ export enum HostEvent {
4574
4617
  */
4575
4618
  Delete = "onDeleteAnswer",
4576
4619
  /**
4577
- * Trigger the **SpotIQ analyze** action on visualization
4578
- * or search.
4620
+ * Trigger the **SpotIQ analyze** action on a
4621
+ * chart or table.
4579
4622
  * @param - Liveboard embed takes `vizId` as a
4580
4623
  * key. Can be left undefined when embedding Search or
4581
4624
  * visualization.
@@ -4848,7 +4891,7 @@ export enum HostEvent {
4848
4891
  * '430496d6-6903-4601-937e-2c691821af3c',
4849
4892
  * 'f547ec54-2a37-4516-a222-2b06719af726'])
4850
4893
  * ```
4851
- * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
4894
+ * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
4852
4895
  */
4853
4896
  SetVisibleTabs = "SetPinboardVisibleTabs",
4854
4897
  /**
@@ -4861,7 +4904,7 @@ export enum HostEvent {
4861
4904
  * '630496d6-6903-4601-937e-2c691821af3c',
4862
4905
  * 'i547ec54-2a37-4516-a222-2b06719af726'])
4863
4906
  * ```
4864
- * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
4907
+ * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
4865
4908
  */
4866
4909
  SetHiddenTabs = "SetPinboardHiddenTabs",
4867
4910
  /**
@@ -4875,7 +4918,7 @@ export enum HostEvent {
4875
4918
  * executeSearch: true,
4876
4919
  * })
4877
4920
  * ```
4878
- * @version SDK: 1.26.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
4921
+ * @version SDK: 1.26.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
4879
4922
  */
4880
4923
  UpdateSageQuery = "updateSageQuery",
4881
4924
  /**
@@ -4892,21 +4935,22 @@ export enum HostEvent {
4892
4935
  * ```js
4893
4936
  * const {session} = await embed.trigger( HostEvent.GetAnswerSession )
4894
4937
  * ```
4895
- * @version SDK: 1.26.0 | Thoughtspot: 9.10.0.cl
4938
+ * @version SDK: 1.26.0 | ThoughtSpot: 9.10.0.cl, 10.1.0.sw
4896
4939
  */
4897
4940
  GetAnswerSession = "getAnswerSession",
4898
4941
  /**
4899
- * Trigger Ask Sage for viz
4942
+ * Trigger the *Ask Sage* action for visualizations
4900
4943
  * @example
4901
4944
  * ```js
4902
4945
  * liveboardEmbed.trigger(HostEvent.AskSage,
4903
4946
  * {vizId:'730496d6-6903-4601-937e-2c691821af3c'})
4904
4947
  * ```
4905
- * @version SDK: 1.29.0 | Thoughtspot: 9.12.0.cl
4948
+ * @version SDK: 1.29.0 | ThoughtSpot Cloud: 9.12.0.cl
4906
4949
  */
4907
4950
  AskSage = "AskSage",
4908
4951
  /**
4909
- * Trigger cross filter update action on a Liveboard
4952
+ * Trigger cross filter update action on a Liveboard.
4953
+ *
4910
4954
  * @example
4911
4955
  * ```js
4912
4956
  * liveboardEmbed.trigger(HostEvent.UpdateCrossFilter, {
@@ -4917,7 +4961,7 @@ export enum HostEvent {
4917
4961
  * ],
4918
4962
  * });
4919
4963
  * ```
4920
- * @version SDK: 1.29.0 | Thoughtspot: 10.0.0.cl
4964
+ * @version SDK: 1.29.0 | ThoughtSpot Cloud: 10.0.0.cl, 10.1.0.sw
4921
4965
  */
4922
4966
  UpdateCrossFilter = "UpdateCrossFilter",
4923
4967
  /**
@@ -4926,11 +4970,13 @@ export enum HostEvent {
4926
4970
  * ```js
4927
4971
  * liveboardEmbed.trigger(HostEvent.ResetLiveboardPersonalisedView);
4928
4972
  * ```
4929
- * @version SDK: 1.29.0 | Thoughtspot: 10.1.0.cl
4973
+ * @version SDK: 1.29.0 | ThoughtSpot Cloud: 10.1.0.cl, 10.1.0.sw
4930
4974
  */
4931
4975
  ResetLiveboardPersonalisedView = "ResetLiveboardPersonalisedView",
4932
4976
  /**
4933
- * Triggers an event to Update Parameter values for Answers and Liveboard
4977
+ * Triggers an action to update Parameter values on embedded
4978
+ * Answers and Liveboard.
4979
+ *
4934
4980
  * @example
4935
4981
  * ```js
4936
4982
  * liveboardEmbed.trigger(HostEvent.UpdateParameters, [{
@@ -4938,37 +4984,56 @@ export enum HostEvent {
4938
4984
  * value: "almond"
4939
4985
  * }])
4940
4986
  *
4941
- * @version SDK: 1.29.0 | Thoughtspot: 10.1.0.cl
4987
+ * @version SDK: 1.29.0 | ThoughtSpot: 10.1.0.cl, 10.1.0.sw
4942
4988
  */
4943
4989
  UpdateParameters = "UpdateParameters",
4944
4990
  /**
4945
- * Triggers GetParameters to fetch the runtime parameters
4991
+ * Triggers GetParameters to fetch the runtime Parameters.
4946
4992
  * ```js
4947
4993
  * liveboardEmbed.trigger(HostEvent.GetParameters).then((parameter) => {
4948
4994
  * console.log('parameters', parameter);
4949
4995
  * });
4950
4996
  *```
4951
- * @version SDK: 1.29.0 | Thoughtspot: 10.1.0.cl
4997
+ * @version SDK: 1.29.0 | ThoughtSpot: 10.1.0.cl, 10.1.0.sw
4952
4998
  */
4953
4999
  GetParameters = "GetParameters",
4954
5000
  /**
4955
- * Triggers an event to update a persoanlised view of a Liveboard
5001
+ * Triggers an event to update a personalized view of a Liveboard.
4956
5002
  * ```js
4957
5003
  * liveboardEmbed.trigger(HostEvent.UpdatePersonalisedView, {viewId: '1234'})
4958
5004
  * ```
4959
- * @version SDK: 1.36.0 | Thoughtspot: 10.6.0.cl
5005
+ * @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
4960
5006
  */
4961
5007
  UpdatePersonalisedView = "UpdatePersonalisedView",
4962
5008
  /**
4963
- * Triggers the action to get the current view of the liveboard
4964
- * @version SDK: 1.36.0 | Thoughtspot: 10.6.0.cl
5009
+ * Triggers the action to get the current view of the Liveboard.
5010
+ * @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
4965
5011
  */
4966
5012
  SaveAnswer = "saveAnswer",
4967
5013
  /**
4968
5014
  * EmbedApi
4969
5015
  * @hidden
4970
5016
  */
4971
- UIPassthrough = "UiPassthrough"
5017
+ UIPassthrough = "UiPassthrough",
5018
+ /**
5019
+ * Triggers the table viz rerender with the updated data.
5020
+ * Includes the following properties:
5021
+ * @param - columnDataLite - an array of object containing data
5022
+ * transformed from data picked from TableVizRendered event.
5023
+ * For example, { columnDataLite: []}
5024
+ * @example
5025
+ * ```js
5026
+ * searchEmbed.on(EmbedEvent.TableVizRendered, (payload) => {
5027
+ * console.log(payload);
5028
+ * const columnDataLite = payload.data.data.columnDataLite;
5029
+ * columnDataLite[0].dataValue[0]="new fob";
5030
+ * console.log('>>> new Data', columnDataLite);
5031
+ * searchEmbed.trigger(HostEvent.TransformTableVizData, columnDataLite);
5032
+ * })
5033
+ * ```
5034
+ * @version SDK: 1.35.12 | ThoughtSpot: 10.7.0.cl
5035
+ */
5036
+ TransformTableVizData = "TransformTableVizData"
4972
5037
  }
4973
5038
  /**
4974
5039
  * The different visual modes that the data sources panel within
@@ -5030,7 +5095,7 @@ export enum Param {
5030
5095
  AuthType = "authType",
5031
5096
  IconSpriteUrl = "iconSprite",
5032
5097
  cookieless = "cookieless",
5033
- ContextMenuTrigger = "isContextMenuEnabledOnLeftClick",
5098
+ ContextMenuTrigger = "contextMenuEnabledOnWhichClick",
5034
5099
  LinkOverride = "linkOverride",
5035
5100
  blockNonEmbedFullAppAccess = "blockNonEmbedFullAppAccess",
5036
5101
  ShowInsertToSlide = "insertInToSlide",
@@ -5181,7 +5246,8 @@ export enum Action {
5181
5246
  ResetLayout = "resetLayout",
5182
5247
  /**
5183
5248
  * The **Schedule** menu action on a Liveboard.
5184
- * Allows scheduling a Liveboard notification.
5249
+ * Allows scheduling a Liveboard job, for example,
5250
+ * sending periodic notifications.
5185
5251
  * @example
5186
5252
  * ```js
5187
5253
  * disabledActions: [Action.Schedule]
@@ -5223,7 +5289,7 @@ export enum Action {
5223
5289
  * ```js
5224
5290
  * disabledActions: [Action.AddDataPanelObjects]
5225
5291
  * ```
5226
- * @version SDK: 1.32.0 | Thoughtspot: 10.0.0.cl
5292
+ * @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl, 10.1.0.sw
5227
5293
  */
5228
5294
  AddDataPanelObjects = "addDataPanelObjects",
5229
5295
  /**
@@ -5236,7 +5302,28 @@ export enum Action {
5236
5302
  * ```
5237
5303
  */
5238
5304
  ConfigureFilter = "configureFilter",
5305
+ /**
5306
+ * The **Collapse data sources** icon on the Search page.
5307
+ * Collapses the panel showing data sources.
5308
+ *
5309
+ * @example
5310
+ * ```js
5311
+ * disabledActions: [Action.CollapseDataPanel]
5312
+ * ```
5313
+ * @version: SDK: 1.1.0 | ThoughtSpot Cloud: ts7.may.cl, 8.4.1.sw
5314
+ */
5239
5315
  CollapseDataSources = "collapseDataSources",
5316
+ /**
5317
+ * The **Collapse data panel** icon on the Search page.
5318
+ * Collapses the data panel view.
5319
+ *
5320
+ * @version: SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl, 10.7.0.sw
5321
+ *
5322
+ * @example
5323
+ * ```js
5324
+ * disabledActions: [Action.CollapseDataPanel]
5325
+ * ```
5326
+ */
5240
5327
  CollapseDataPanel = "collapseDataPanel",
5241
5328
  /**
5242
5329
  * The **Choose sources** button on Search page.
@@ -5272,7 +5359,7 @@ export enum Action {
5272
5359
  * ```js
5273
5360
  * disabledActions: [Action.AddColumnSet]
5274
5361
  * ```
5275
- * @version SDK: 1.32.0 | Thoughtspot: 10.0.0.cl
5362
+ * @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl, 10.1.0.sw
5276
5363
  */
5277
5364
  AddColumnSet = "addSimpleCohort",
5278
5365
  /**
@@ -5282,7 +5369,7 @@ export enum Action {
5282
5369
  * ```js
5283
5370
  * disabledActions: [Action.AddQuerySet]
5284
5371
  * ```
5285
- * @version SDK: 1.32.0 | Thoughtspot: 10.0.0.cl
5372
+ * @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl, 10.1.0.sw
5286
5373
  */
5287
5374
  AddQuerySet = "addAdvancedCohort",
5288
5375
  /**
@@ -5314,6 +5401,8 @@ export enum Action {
5314
5401
  /**
5315
5402
  * The **Show underlying data** menu action on a visualization or
5316
5403
  * Answer page.
5404
+ * Displays detailed information and raw data
5405
+ * for a given visualization.
5317
5406
  * @example
5318
5407
  * ```js
5319
5408
  * disabledActions: [Action.ShowUnderlyingData]
@@ -5515,6 +5604,7 @@ export enum Action {
5515
5604
  AnalysisInfo = "analysisInfo",
5516
5605
  /**
5517
5606
  * The **Schedule** menu action on a Liveboard.
5607
+ * Allows scheduling a Liveboard job.
5518
5608
  * @example
5519
5609
  * ```js
5520
5610
  * disabledActions: [Action.Subscription]
@@ -5584,8 +5674,13 @@ export enum Action {
5584
5674
  */
5585
5675
  RequestAccess = "requestAccess",
5586
5676
  /**
5587
- * The **Query visualizer** and **Query SQL** buttons in Query details panel
5588
- * of the Answer page
5677
+ * The **Query visualizer** and **Query SQL** buttons in
5678
+ * Query details panel of the Answer page.
5679
+ *
5680
+ * **Query visualizer** - Displays the tables
5681
+ * and filters used in a search query.
5682
+ * **Query SQL** - Displays the SQL statements used
5683
+ * in a search query to fetch data.
5589
5684
  * @example
5590
5685
  * ```js
5591
5686
  * disabledActions: [Action.QueryDetailsButtons]
@@ -5603,7 +5698,10 @@ export enum Action {
5603
5698
  */
5604
5699
  AnswerDelete = "onDeleteAnswer",
5605
5700
  /**
5606
- * The Chart switcher icon on Answer and visualization pages.
5701
+ * The chart switcher icon on Answer page and
5702
+ * visualizations in edit mode.
5703
+ * Allows switching to the table or chart mode
5704
+ * when editing a visualization.
5607
5705
  * @example
5608
5706
  * ```js
5609
5707
  * disabledActions: [Action.AnswerChartSwitcher]
@@ -5612,7 +5710,10 @@ export enum Action {
5612
5710
  */
5613
5711
  AnswerChartSwitcher = "answerChartSwitcher",
5614
5712
  /**
5615
- * Favorites icon (*) on Answers, Liveboard, and Data pages
5713
+ * The Favorites icon (*) for Answers,
5714
+ * Liveboard, and data objects like Worksheet, Model,
5715
+ * Tables and Views.
5716
+ * Allows adding an object to the user’s favorites list.
5616
5717
  * @example
5617
5718
  * ```js
5618
5719
  * disabledActions: [Action.AddToFavorites]
@@ -5630,7 +5731,9 @@ export enum Action {
5630
5731
  */
5631
5732
  EditDetails = "editDetails",
5632
5733
  /**
5633
- * The Create alert action on KPI charts.
5734
+ * The *Create alert* action for KPI charts.
5735
+ * Allows users to schedule threshold-based alerts
5736
+ * for KPI charts.
5634
5737
  * @example
5635
5738
  * ```js
5636
5739
  * disabledActions: [Action.CreateMonitor]
@@ -5686,7 +5789,7 @@ export enum Action {
5686
5789
  * ```js
5687
5790
  * disabledActions: [Action.CrossFilter]
5688
5791
  * ```
5689
- * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
5792
+ * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.8.0.sw
5690
5793
  */
5691
5794
  CrossFilter = "context-menu-item-cross-filter",
5692
5795
  /**
@@ -5696,7 +5799,7 @@ export enum Action {
5696
5799
  * ```js
5697
5800
  * disabledActions: [Action.SyncToSlack]
5698
5801
  * ```
5699
- * @version @version SDK : 1.32.0 | Thoughtspot: 10.1.0.cl
5802
+ * @version @version SDK : 1.32.0 | ThoughtSpot Cloud: 10.1.0.cl
5700
5803
  */
5701
5804
  SyncToSlack = "syncToSlack",
5702
5805
  /**
@@ -5706,7 +5809,7 @@ export enum Action {
5706
5809
  * ```js
5707
5810
  * disabledActions: [Action.SyncToTeams]
5708
5811
  * ```
5709
- * @version @version SDK : 1.32.0 | Thoughtspot: 10.1.0.cl
5812
+ * @version @version SDK : 1.32.0 | ThoughtSpot Cloud: 10.1.0.cl
5710
5813
  */
5711
5814
  SyncToTeams = "syncToTeams",
5712
5815
  /**
@@ -5717,7 +5820,7 @@ export enum Action {
5717
5820
  * ```js
5718
5821
  * disabledActions: [Action.RemoveCrossFilter]
5719
5822
  * ```
5720
- * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
5823
+ * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
5721
5824
  */
5722
5825
  RemoveCrossFilter = "context-menu-item-remove-cross-filter",
5723
5826
  /**
@@ -5728,7 +5831,7 @@ export enum Action {
5728
5831
  * ```js
5729
5832
  * disabledActions: [Action.AxisMenuAggregate]
5730
5833
  * ```
5731
- * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
5834
+ * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
5732
5835
  */
5733
5836
  AxisMenuAggregate = "axisMenuAggregate",
5734
5837
  /**
@@ -5739,17 +5842,19 @@ export enum Action {
5739
5842
  * ```js
5740
5843
  * disabledActions: [Action.AxisMenuTimeBucket]
5741
5844
  * ```
5742
- * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
5845
+ * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
5743
5846
  */
5744
5847
  AxisMenuTimeBucket = "axisMenuTimeBucket",
5745
5848
  /**
5746
5849
  * The **Filter** action in the chart axis or table column
5747
5850
  * customization menu.
5851
+ * Allows adding, editing, or removing filters.
5852
+ *
5748
5853
  * @example
5749
5854
  * ```js
5750
5855
  * disabledActions: [Action.AxisMenuFilter]
5751
5856
  * ```
5752
- * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
5857
+ * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
5753
5858
  */
5754
5859
  AxisMenuFilter = "axisMenuFilter",
5755
5860
  /**
@@ -5760,7 +5865,7 @@ export enum Action {
5760
5865
  * ```js
5761
5866
  * disabledActions: [Action.AxisMenuConditionalFormat]
5762
5867
  * ```
5763
- * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
5868
+ * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
5764
5869
  */
5765
5870
  AxisMenuConditionalFormat = "axisMenuConditionalFormat",
5766
5871
  /**
@@ -5771,7 +5876,7 @@ export enum Action {
5771
5876
  * ```js
5772
5877
  * disabledActions: [Action.AxisMenuConditionalFormat]
5773
5878
  * ```
5774
- * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
5879
+ * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
5775
5880
  */
5776
5881
  AxisMenuSort = "axisMenuSort",
5777
5882
  /**
@@ -5783,7 +5888,7 @@ export enum Action {
5783
5888
  * ```js
5784
5889
  * disabledActions: [Action.AxisMenuGroup]
5785
5890
  * ```
5786
- * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
5891
+ * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
5787
5892
  */
5788
5893
  AxisMenuGroup = "axisMenuGroup",
5789
5894
  /**
@@ -5794,7 +5899,7 @@ export enum Action {
5794
5899
  * ```js
5795
5900
  * disabledActions: [Action.AxisMenuPosition]
5796
5901
  * ```
5797
- * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
5902
+ * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
5798
5903
  */
5799
5904
  AxisMenuPosition = "axisMenuPosition",
5800
5905
  /**
@@ -5804,7 +5909,7 @@ export enum Action {
5804
5909
  * ```js
5805
5910
  * disabledActions: [Action.AxisMenuRename]
5806
5911
  * ```
5807
- * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
5912
+ * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
5808
5913
  */
5809
5914
  AxisMenuRename = "axisMenuRename",
5810
5915
  /**
@@ -5815,7 +5920,7 @@ export enum Action {
5815
5920
  * ```js
5816
5921
  * disabledActions: [Action.AxisMenuEdit]
5817
5922
  * ```
5818
- * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
5923
+ * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
5819
5924
  */
5820
5925
  AxisMenuEdit = "axisMenuEdit",
5821
5926
  /**
@@ -5825,7 +5930,7 @@ export enum Action {
5825
5930
  * ```js
5826
5931
  * disabledActions: [Action.AxisMenuNumberFormat]
5827
5932
  * ```
5828
- * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
5933
+ * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
5829
5934
  */
5830
5935
  AxisMenuNumberFormat = "axisMenuNumberFormat",
5831
5936
  /**
@@ -5835,7 +5940,7 @@ export enum Action {
5835
5940
  * ```js
5836
5941
  * disabledActions: [Action.AxisMenuTextWrapping]
5837
5942
  * ```
5838
- * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
5943
+ * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
5839
5944
  */
5840
5945
  AxisMenuTextWrapping = "axisMenuTextWrapping",
5841
5946
  /**
@@ -5847,7 +5952,7 @@ export enum Action {
5847
5952
  * ```js
5848
5953
  * disabledActions: [Action.AxisMenuRemove]
5849
5954
  * ```
5850
- * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
5955
+ * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
5851
5956
  */
5852
5957
  AxisMenuRemove = "axisMenuRemove",
5853
5958
  /**
@@ -5861,26 +5966,27 @@ export enum Action {
5861
5966
  * ```js
5862
5967
  * disabledActions: [Action.RenameModalTitleDescription]
5863
5968
  * ```
5864
- * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
5969
+ * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl, 9.8.0.sw
5865
5970
  */
5866
5971
  RenameModalTitleDescription = "renameModalTitleDescription",
5867
5972
  /**
5868
- *
5973
+ * The *Request verification* action on a Liveboard.
5974
+ * Initiates a request for Liveboard verification.
5869
5975
  * @example
5870
5976
  * ```js
5871
5977
  * disabledActions: [Action.RequestVerification]
5872
5978
  * ```
5873
- * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
5979
+ * @version SDK: 1.25.0 | ThoughtSpot: 9.6.0.cl, 10.1.0.sw
5874
5980
  */
5875
5981
  RequestVerification = "requestVerification",
5876
5982
  /**
5877
5983
  *
5878
- *Allows users to mark a Liveboard as verified.
5984
+ * Allows users to mark a Liveboard as verified.
5879
5985
  * @example
5880
5986
  * ```js
5881
5987
  * disabledActions: [Action.MarkAsVerified]
5882
5988
  * ```
5883
- * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
5989
+ * @version SDK: 1.25.0 | ThoughtSpot: 9.6.0.cl, 10.1.0.sw
5884
5990
  */
5885
5991
  MarkAsVerified = "markAsVerified",
5886
5992
  /**
@@ -5890,7 +5996,7 @@ export enum Action {
5890
5996
  * ```js
5891
5997
  * disabledActions: [Action.AddTab]
5892
5998
  * ```
5893
- * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
5999
+ * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
5894
6000
  */
5895
6001
  AddTab = "addTab",
5896
6002
  /**
@@ -5900,35 +6006,42 @@ export enum Action {
5900
6006
  * ```js
5901
6007
  * disabledActions: [Action.EnableContextualChangeAnalysis]
5902
6008
  * ```
5903
- * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
6009
+ * @version SDK: 1.25.0 | ThoughtSpot Cloud: 9.6.0.cl
5904
6010
  */
5905
6011
  EnableContextualChangeAnalysis = "enableContextualChangeAnalysis",
5906
6012
  /**
6013
+ * Action ID to hide or disable Natural Language Search query.
5907
6014
  *
5908
6015
  * @example
5909
6016
  * ```js
5910
6017
  * disabledActions: [Action.ShowSageQuery]
5911
6018
  * ```
5912
- * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
6019
+ * @version SDK: 1.26.0 | ThoughtSpot Cloud: 9.7.0.cl
5913
6020
  */
5914
6021
  ShowSageQuery = "showSageQuery",
5915
6022
  /**
6023
+ *
6024
+ * Action ID to hide or disable the edit option for the
6025
+ * results generated from the
6026
+ * Natural Language Search query.
5916
6027
  *
5917
6028
  * @example
5918
6029
  * ```js
5919
6030
  * disabledActions: [Action.EditSageAnswer]
5920
6031
  * ```
5921
- * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
6032
+ * @version SDK: 1.26.0 | ThoughtSpot Cloud: 9.7.0.cl
5922
6033
  */
5923
6034
  EditSageAnswer = "editSageAnswer",
5924
6035
  /**
6036
+ * The feedback widget for AI-generated Answers.
6037
+ * Allows users to send feedback on the Answers generated
6038
+ * from a Natural Language Search query.
5925
6039
  *
5926
- *This action allows users to send feedback on AI-generated Answers.
5927
6040
  * @example
5928
6041
  * ```js
5929
6042
  * disabledActions: [Action.SageAnswerFeedback]
5930
6043
  * ```
5931
- * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
6044
+ * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl
5932
6045
  */
5933
6046
  SageAnswerFeedback = "sageAnswerFeedback",
5934
6047
  /**
@@ -5937,7 +6050,7 @@ export enum Action {
5937
6050
  * ```js
5938
6051
  * disabledActions: [Action.ModifySageAnswer]
5939
6052
  * ```
5940
- * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
6053
+ * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl
5941
6054
  */
5942
6055
  ModifySageAnswer = "modifySageAnswer",
5943
6056
  /**
@@ -5950,7 +6063,10 @@ export enum Action {
5950
6063
  */
5951
6064
  MoveToTab = "onContainerMove",
5952
6065
  /**
5953
- * The **Manage Alertsb** menu action on KPI visualizations.
6066
+ * The **Manage Alerts** menu action on KPI visualizations.
6067
+ * Allows creating, viewing, and editing monitor
6068
+ * alerts for a KPI chart.
6069
+ *
5954
6070
  * @example
5955
6071
  * ```js
5956
6072
  * disabledActions: [Action.ManageMonitor]
@@ -5958,21 +6074,23 @@ export enum Action {
5958
6074
  */
5959
6075
  ManageMonitor = "manageMonitor",
5960
6076
  /**
5961
- * Action ID for Liveboard Personalised Views dropdown
6077
+ * The Liveboard Personalised Views dropdown.
6078
+ * Allows navigating to a personalized Liveboard View.
5962
6079
  * @example
5963
6080
  * ```js
5964
6081
  * disabledActions: [Action.PersonalisedViewsDropdown]
5965
6082
  * ```
5966
- * @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl
6083
+ * @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw
5967
6084
  */
5968
6085
  PersonalisedViewsDropdown = "personalisedViewsDropdown",
5969
6086
  /**
5970
- * Action ID for Liveboard Users ( Recently Visited / social proof )
6087
+ * Action ID for show or hide the user details on a
6088
+ * Liveboard (Recently visited / social proof)
5971
6089
  * @example
5972
6090
  * ```js
5973
6091
  * disabledActions: [Action.LiveboardUsers]
5974
6092
  * ```
5975
- * @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl
6093
+ * @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw
5976
6094
  */
5977
6095
  LiveboardUsers = "liveboardUsers",
5978
6096
  /**
@@ -5990,108 +6108,124 @@ export enum Action {
5990
6108
  * hiddenAction: [Action.TML] // hide all TML actions
5991
6109
  * disabledActions: [Action.TML] // to disable all TML actions
5992
6110
  * ```
5993
- * @version SDK : 1.28.3 | Thoughtspot: 9.12.0.cl
6111
+ * @version SDK : 1.28.3 | ThoughtSpot: 9.12.0.cl, 10.1.0.sw
5994
6112
  */
5995
6113
  TML = "tml",
5996
6114
  /**
5997
- * Action ID for the create Liveboard option on the Liveboard list page
5998
- * and Pin modal
6115
+ * The **Create Liveboard* action on
6116
+ * the Liveboards page and the Pin modal.
6117
+ * Allows users to create a Liveboard.
6118
+ *
5999
6119
  * @example
6000
6120
  * ```js
6001
6121
  * hiddenAction: [Action.CreateLiveboard]
6002
6122
  * disabledActions: [Action.CreateLiveboard]
6003
6123
  * ```
6004
- * @version SDK: 1.32.0 | Thoughtspot: 10.1.0.cl
6124
+ * @version SDK: 1.32.0 | ThoughtSpot: 10.1.0.cl, 10.1.0.sw
6005
6125
  */
6006
6126
  CreateLiveboard = "createLiveboard",
6007
6127
  /**
6008
- * Action ID for to hide Verified Liveboard Banner
6128
+ * Action ID for to hide or disable the
6129
+ * Verified Liveboard banner.
6009
6130
  * @example
6010
6131
  * ```js
6011
6132
  * hiddenAction: [Action.VerifiedLiveboard]
6012
6133
  * ```
6013
- * @version SDK: 1.29.0 | Thoughtspot: 9.10.0.cl
6134
+ * @version SDK: 1.29.0 | ThoughtSpot: 9.10.0.cl, 10.1.0.sw
6014
6135
  */
6015
6136
  VerifiedLiveboard = "verifiedLiveboard",
6016
6137
  /**
6017
- * Action ID for ask sage button
6138
+ * The *Ask Sage* action for Answers and visualizations.
6139
+ * Allows initiating a Natural Language Search query.
6140
+ *
6018
6141
  * @example
6019
6142
  * ```js
6020
6143
  * hiddenAction: [Action.AskAi]
6021
6144
  * ```
6022
- * @version SDK: 1.29.0 | Thoughtspot: 9.12.0.cl
6145
+ * @version SDK: 1.29.0 | ThoughtSpot Cloud: 9.12.0.cl
6023
6146
  */
6024
6147
  AskAi = "AskAi",
6025
6148
  /**
6026
6149
  * The **Add KPI to Watchlist** action on Home page watchlist.
6150
+ * Adds a KPI chart to the watchlist on the Home page.
6027
6151
  * @example
6028
6152
  * ```js
6029
6153
  * disabledActions: [Action.AddToWatchlist]
6030
6154
  * ```
6031
- * @version SDK : 1.27.9 | Thoughtspot: 9.12.5.cl
6155
+ * @version SDK : 1.27.9 | ThoughtSpot Cloud: 9.12.5.cl
6032
6156
  */
6033
6157
  AddToWatchlist = "addToWatchlist",
6034
6158
  /**
6035
6159
  * The **Remove from watchlist** menu action on KPI watchlist.
6160
+ * Removes a KPI chart from the watchlist on the Home page.
6036
6161
  * @example
6037
6162
  * ```js
6038
6163
  * disabledActions: [Action.RemoveFromWatchlist]
6039
6164
  * ```
6040
- * @version SDK : 1.27.9 | Thoughtspot: 9.12.5.cl
6165
+ * @version SDK : 1.27.9 | ThoughtSpot: 9.12.5.cl
6041
6166
  */
6042
6167
  RemoveFromWatchlist = "removeFromWatchlist",
6043
6168
  /**
6044
- * The **Organise Favourites** action on Homepage Favourite Module.
6169
+ * The **Organize Favourites** action on Homepage
6170
+ * *Favorites* module.
6171
+ *
6045
6172
  * @example
6046
6173
  * ```js
6047
6174
  * disabledActions: [Action.OrganiseFavourites]
6048
6175
  * ```
6049
- * @version SDK : 1.32.0 | Thoughtspot: 10.0.0.cl
6176
+ * @version SDK : 1.32.0 | ThoughtSpot: 10.0.0.cl
6050
6177
  */
6051
6178
  OrganiseFavourites = "organiseFavourites",
6052
6179
  /**
6053
- * Action ID for AI Highlights button
6180
+ * The **AI Highlights** action on a Liveboard.
6181
+ *
6054
6182
  * @example
6055
6183
  * ```js
6056
6184
  * hiddenAction: [Action.AIHighlights]
6057
6185
  * ```
6058
- * @version SDK: 1.27.10 | Thoughtspot: 9.12.5.cl
6186
+ * @version SDK: 1.27.10 | ThoughtSpot Cloud: 9.12.5.cl
6059
6187
  */
6060
6188
  AIHighlights = "AIHighlights",
6061
6189
  /**
6062
- * Action ID for edit the schedule action on schedule on homepage
6190
+ * The *Edit* action on the *Liveboard Schedules* page
6191
+ * (new Homepage experience).
6192
+ * Allows editing Liveboard schedules.
6193
+ *
6063
6194
  * @example
6064
6195
  * ```js
6065
6196
  * disabledActions: [Action.EditScheduleHomepage]
6066
6197
  * ```
6067
- * @version SDK: 1.34.0 | Thoughtspot: 10.3.0.cl
6198
+ * @version SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
6068
6199
  */
6069
6200
  EditScheduleHomepage = "editScheduleHomepage",
6070
6201
  /**
6071
- * Action ID for pause schedule action on schedule on homepage
6202
+ * The *Pause* action on the *Liveboard Schedules* page
6203
+ * Pauses a scheduled Liveboard job.
6072
6204
  * @example
6073
6205
  * ```js
6074
6206
  * disabledActions: [Action.PauseScheduleHomepage]
6075
6207
  * ```
6076
- * @version SDK: 1.34.0 | Thoughtspot: 10.3.0.cl
6208
+ * @version SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
6077
6209
  */
6078
6210
  PauseScheduleHomepage = "pauseScheduleHomepage",
6079
6211
  /**
6080
- * Action ID for view schedule run action on schedule on homepage
6212
+ * The **View run history** action **Liveboard Schedules** page.
6213
+ * Allows viewing schedule run history.
6081
6214
  * @example
6082
6215
  * ```js
6083
6216
  * disabledActions: [Action.ViewScheduleRunHomepage]
6084
6217
  * ```
6085
- * @version SDK: 1.34.0 | Thoughtspot: 10.3.0.cl
6218
+ * @version SDK: 1.34.0 | ThoughtSpot: 10.3.0.cl
6086
6219
  */
6087
6220
  ViewScheduleRunHomepage = "viewScheduleRunHomepage",
6088
6221
  /**
6089
- * Action ID for unsubscribe schedule action on schedule on homepage
6222
+ * Action ID to hide or disable the
6223
+ * unsubscribe option for Liveboard schedules.
6090
6224
  * @example
6091
6225
  * ```js
6092
6226
  * disabledActions: [Action.UnsubscribeScheduleHomepage]
6093
6227
  * ```
6094
- * @version SDK: 1.34.0 | Thoughtspot: 10.3.0.cl
6228
+ * @version SDK: 1.34.0 | ThoughtSpot: 10.3.0.cl
6095
6229
  */
6096
6230
  UnsubscribeScheduleHomepage = "unsubscribeScheduleHomepage",
6097
6231
  /**
@@ -6100,16 +6234,17 @@ export enum Action {
6100
6234
  * ```js
6101
6235
  * disabledActions: [Action.ManageTags]
6102
6236
  * ```
6103
- * @version SDK : 1.34.0 | Thoughtspot: 10.3.0.cl
6237
+ * @version SDK : 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
6104
6238
  */
6105
6239
  ManageTags = "manageTags",
6106
6240
  /**
6107
- * Action ID for delete schedule action on schedule on homepage
6241
+ * The **Delete** action on the **Liveboard Schedules* page.
6242
+ * Deletes a Liveboard schedule.
6108
6243
  * @example
6109
6244
  * ```js
6110
6245
  * disabledActions: [Action.DeleteScheduleHomepage]
6111
6246
  * ```
6112
- * @version SDK: 1.34.0 | Thoughtspot: 10.3.0.cl
6247
+ * @version SDK: 1.34.0 | ThoughtSpot: 10.3.0.cl
6113
6248
  */
6114
6249
  DeleteScheduleHomepage = "deleteScheduleHomepage",
6115
6250
  /**
@@ -6118,7 +6253,7 @@ export enum Action {
6118
6253
  * ```js
6119
6254
  * disabledActions: [Action.KPIAnalysisCTA]
6120
6255
  * ```
6121
- * @version SDK: 1.34.0 | Thoughtspot: 10.3.0.cl
6256
+ * @version SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
6122
6257
  */
6123
6258
  KPIAnalysisCTA = "kpiAnalysisCTA",
6124
6259
  /**
@@ -6127,61 +6262,73 @@ export enum Action {
6127
6262
  * ```js
6128
6263
  * const disabledActions = [Action.DisableChipReorder]
6129
6264
  * ```
6130
- * @version SDK: 1.36.0 | Thoughtspot: 10.6.0.cl
6265
+ * @version SDK: 1.36.0 | ThoughtSpot Cloud: 10.6.0.cl
6131
6266
  */
6132
6267
  DisableChipReorder = "disableChipReorder",
6133
6268
  /**
6134
- * Action ID for Hide Irrelevant filters button
6269
+ * Action ID to show, hide, or disable filters
6270
+ * in a Liveboard tab.
6271
+ *
6135
6272
  * @example
6136
6273
  * ```js
6137
6274
  * hiddenAction: [Action.ChangeFilterVisibilityInTab]
6138
6275
  * ```
6139
- * @version SDK: 1.36.0 | Thoughtspot: 10.6.0.cl
6276
+ * @version SDK: 1.36.0 | ThoughtSpot Cloud: 10.6.0.cl
6140
6277
  */
6141
6278
  ChangeFilterVisibilityInTab = "changeFilterVisibilityInTab",
6142
6279
  /**
6143
- * Action ID for hide/disable Preview data button in spotter
6280
+ * The **Preview data** button on the Spotter interface.
6281
+ * Allows previewing the data used for Spotter queries.
6282
+ *
6144
6283
  * @example
6145
6284
  * ```js
6146
6285
  * hiddenAction: [Action.PreviewDataSpotter]
6147
6286
  * ```
6148
- * @version SDK: 1.36.0 | Thoughtspot: 10.6.0.cl
6287
+ * @version SDK: 1.36.0 | ThoughtSpot Cloud: 10.6.0.cl
6149
6288
  */
6150
6289
  PreviewDataSpotter = "previewDataSpotter",
6151
6290
  /**
6152
- * Action ID for hide/disable reset button in spotter
6291
+ * The **Reset** link on the Spotter interface.
6292
+ * Resets the conversation with Spotter.
6293
+ *
6153
6294
  * @example
6154
6295
  * ```js
6155
6296
  * hiddenAction: [Action.ResetSpotterChat]
6156
6297
  * ```
6157
- * @version SDK: 1.36.0 | Thoughtspot: 10.6.0.cl
6298
+ * @version SDK: 1.36.0 | ThoughtSpot Cloud: 10.6.0.cl
6158
6299
  */
6159
6300
  ResetSpotterChat = "resetSpotterChat",
6160
6301
  /**
6161
- * Action ID for hide/disable feedback in spotter
6302
+ * Action ID for hide or disable the
6303
+ * Spotter feedback widget.
6304
+ *
6162
6305
  * @example
6163
6306
  * ```js
6164
6307
  * hiddenAction: [Action.SpotterFeedback]
6165
6308
  * ```
6166
- * @version SDK: 1.36.0 | Thoughtspot: 10.6.0.cl
6309
+ * @version SDK: 1.36.0 | ThoughtSpot Cloud: 10.6.0.cl
6167
6310
  */
6168
6311
  SpotterFeedback = "spotterFeedback",
6169
6312
  /**
6170
- * Action ID for hide/disable editing previous prompt in spotter
6313
+ * Action ID for hide or disable
6314
+ * the previous prompt edit option in Spotter.
6315
+ *
6171
6316
  * @example
6172
6317
  * ```js
6173
6318
  * hiddenAction: [Action.EditPreviousPrompt]
6174
6319
  * ```
6175
- * @version SDK: 1.36.0 | Thoughtspot: 10.6.0.cl
6320
+ * @version SDK: 1.36.0 | ThoughtSpot Cloud: 10.6.0.cl
6176
6321
  */
6177
6322
  EditPreviousPrompt = "editPreviousPrompt",
6178
6323
  /**
6179
- * Action ID for hide/disable deleting previous prompt in spotter
6324
+ * Action ID for hide or disable
6325
+ * the previous prompt deletion option in Spotter.
6326
+ *
6180
6327
  * @example
6181
6328
  * ```js
6182
6329
  * hiddenAction: [Action.DeletePreviousPrompt]
6183
6330
  * ```
6184
- * @version SDK: 1.36.0 | Thoughtspot: 10.6.0.cl
6331
+ * @version SDK: 1.36.0 | ThoughtSpot Cloud: 10.6.0.cl
6185
6332
  */
6186
6333
  DeletePreviousPrompt = "deletePreviousPrompt",
6187
6334
  /**
@@ -6190,7 +6337,7 @@ export enum Action {
6190
6337
  * ```js
6191
6338
  * hiddenAction: [Action.EditTokens]
6192
6339
  * ```
6193
- * @version SDK: 1.36.0 | Thoughtspot: 10.6.0.cl
6340
+ * @version SDK: 1.36.0 | ThoughtSpot Cloud: 10.6.0.cl
6194
6341
  */
6195
6342
  EditTokens = "editTokens"
6196
6343
  }
@@ -6205,10 +6352,12 @@ export enum PrefetchFeatures {
6205
6352
  }
6206
6353
  /**
6207
6354
  * Enum for options to change context trigger
6355
+ * BOTH_CLICKS option is introduced in 10.7
6208
6356
  */
6209
6357
  export enum ContextMenuTriggerOptions {
6210
6358
  LEFT_CLICK = "left-click",
6211
- RIGHT_CLICK = "right-click"
6359
+ RIGHT_CLICK = "right-click",
6360
+ BOTH_CLICKS = "both-clicks"
6212
6361
  }
6213
6362
  export interface ColumnValue {
6214
6363
  column: {
@@ -6261,7 +6410,7 @@ export enum LogLevel {
6261
6410
  * logLevel: LogLevel.SILENT,
6262
6411
  * })
6263
6412
  * ```
6264
- * @version SDK: 1.26.7 | Thoughtspot: 9.10.0.cl
6413
+ * @version SDK: 1.26.7 | ThoughtSpot Cloud: 9.10.0.cl
6265
6414
  */
6266
6415
  SILENT = "SILENT",
6267
6416
  /**
@@ -6273,7 +6422,7 @@ export enum LogLevel {
6273
6422
  * logLevel: LogLevel.ERROR,
6274
6423
  * })
6275
6424
  * ```
6276
- * @version SDK: 1.26.7 | Thoughtspot: 9.10.0.cl
6425
+ * @version SDK: 1.26.7 | ThoughtSpot Cloud: 9.10.0.cl
6277
6426
  */
6278
6427
  ERROR = "ERROR",
6279
6428
  /**
@@ -6285,7 +6434,7 @@ export enum LogLevel {
6285
6434
  * logLevel: LogLevel.WARN,
6286
6435
  * })
6287
6436
  * ```
6288
- * @version SDK: 1.26.7 | Thoughtspot: 9.10.0.cl
6437
+ * @version SDK: 1.26.7 | ThoughtSpot Cloud: 9.10.0.cl
6289
6438
  */
6290
6439
  WARN = "WARN",
6291
6440
  /**
@@ -6297,7 +6446,7 @@ export enum LogLevel {
6297
6446
  * logLevel: LogLevel.INFO,
6298
6447
  * })
6299
6448
  * ```
6300
- * @version SDK: 1.26.7 | Thoughtspot: 9.10.0.cl
6449
+ * @version SDK: 1.26.7 | ThoughtSpot Cloud: 9.10.0.cl
6301
6450
  */
6302
6451
  INFO = "INFO",
6303
6452
  /**
@@ -6309,7 +6458,7 @@ export enum LogLevel {
6309
6458
  * logLevel: LogLevel.DEBUG,
6310
6459
  * })
6311
6460
  * ```
6312
- * @version SDK: 1.26.7 | Thoughtspot: 9.10.0.cl
6461
+ * @version SDK: 1.26.7 | ThoughtSpot Cloud: 9.10.0.cl
6313
6462
  */
6314
6463
  DEBUG = "DEBUG",
6315
6464
  /**
@@ -6321,7 +6470,7 @@ export enum LogLevel {
6321
6470
  * logLevel: LogLevel.TRACE,
6322
6471
  * })
6323
6472
  * ```
6324
- * @version SDK: 1.26.7 | Thoughtspot: 9.10.0.cl
6473
+ * @version SDK: 1.26.7 | ThoughtSpot Cloud: 9.10.0.cl
6325
6474
  */
6326
6475
  TRACE = "TRACE"
6327
6476
  }
@@ -7143,7 +7292,7 @@ export enum UIPassthroughEvent {
7143
7292
  PinAnswerToLiveboard = "addVizToPinboard",
7144
7293
  SaveAnswer = "saveAnswer",
7145
7294
  GetDiscoverabilityStatus = "getDiscoverabilityStatus",
7146
- GetAvailableUIPassthroughs = "getAvailableUIPassthroughs",
7295
+ GetAvailableUIPassthroughs = "getAvailableUiPassthroughs",
7147
7296
  GetAnswerConfig = "getAnswerPageConfig",
7148
7297
  GetLiveboardConfig = "getPinboardPageConfig"
7149
7298
  }