@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
@@ -1057,8 +1057,17 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
1057
1057
  */
1058
1058
  enableSearchAssist?: boolean;
1059
1059
  /**
1060
- * If set to true, the embedded object container dynamically resizes
1061
- * according to the height of the pages which support fullHeight mode.
1060
+ * If set to true, the Liveboard container dynamically resizes
1061
+ * according to the height of the Liveboard.
1062
+ *
1063
+ * **Note**: Using fullHeight loads all visualizations
1064
+ * on the Liveboard simultaneously, which results in
1065
+ * multiple warehouse queries and potentially a
1066
+ * longer wait for the topmost visualizations to
1067
+ * display on the screen. Setting fullHeight to
1068
+ * `false` fetches visualizations incrementally as
1069
+ * users scroll the page to view the charts and tables.
1070
+ *
1062
1071
  * @version SDK: 1.21.0 | ThoughtSpot: 9.4.0.cl, 9.4.0-sw
1063
1072
  * @example
1064
1073
  * ```js
@@ -1320,12 +1329,14 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
1320
1329
  /**
1321
1330
  * If set to true, the embedded object container dynamically resizes
1322
1331
  * according to the height of the Liveboard.
1332
+ *
1323
1333
  * **Note**: Using fullHeight loads all visualizations on the
1324
1334
  * Liveboard simultaneously, which results in multiple warehouse
1325
1335
  * queries and potentially a longer wait for the topmost
1326
1336
  * visualizations to display on the screen.
1327
1337
  * Setting `fullHeight` to `false` fetches visualizations
1328
1338
  * incrementally as users scroll the page to view the charts and tables.
1339
+ *
1329
1340
  * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 7.2.1
1330
1341
  * @example
1331
1342
  * ```js
@@ -1687,10 +1698,11 @@ export declare class LiveboardEmbed extends V1Embed {
1687
1698
  protected handleRenderForPrerender(): void;
1688
1699
  /**
1689
1700
  * Triggers an event to the embedded app
1690
- * @param messageType The event type
1691
- * @param data The payload to send with the message
1701
+ * @param {HostEvent} messageType The event type
1702
+ * @param {any} data The payload to send with the message
1703
+ * @returns A promise that resolves with the response from the embedded app
1692
1704
  */
1693
- trigger<HostEventT extends HostEvent>(messageType: HostEventT, data?: HostEventRequest<HostEventT>): Promise<HostEventResponse<HostEventT>>;
1705
+ trigger<HostEventT extends HostEvent, PayloadT>(messageType: HostEventT, data?: TriggerPayload<PayloadT, HostEventT>): Promise<TriggerResponse<PayloadT, HostEventT>>;
1694
1706
  /**
1695
1707
  * Render an embedded ThoughtSpot Liveboard or visualization
1696
1708
  * @param renderOptions An object specifying the Liveboard ID,
@@ -2217,7 +2229,7 @@ export declare function resetCachedSessionInfo(): void;
2217
2229
  */
2218
2230
  export declare enum AuthType {
2219
2231
  /**
2220
- * No authentication on the SDK. Passthrough to the embedded App. Alias for
2232
+ * No authentication on the SDK. Pass-through to the embedded App. Alias for
2221
2233
  * `Passthrough`.
2222
2234
  * @example
2223
2235
  * ```js
@@ -2414,8 +2426,8 @@ export interface customCssInterface {
2414
2426
  /**
2415
2427
  * The custom css variables, which can be set.
2416
2428
  * The allowed list is in the CustomCssVariables
2417
- * interface.
2418
- * Or here: https://try-everywhere.thoughtspot.cloud/resources/static/css/custom_variables.css
2429
+ * interface. For more information, see
2430
+ * link:https://developers.thoughtspot.com/docs/css-variables-reference
2419
2431
  */
2420
2432
  variables?: CustomCssVariables;
2421
2433
  /**
@@ -2457,7 +2469,7 @@ export interface CustomStyles {
2457
2469
  }
2458
2470
  /**
2459
2471
  * Configuration to define the customization on the Embedded
2460
- * Thoughtspot components.
2472
+ * ThoughtSpot components.
2461
2473
  * You can customize styles, text strings, and icons.
2462
2474
  * For more information, see https://developers.thoughtspot.com/docs/custom-css.
2463
2475
  * @example
@@ -2577,7 +2589,7 @@ export interface EmbedConfig {
2577
2589
  /**
2578
2590
  * Boolean to define if the query parameters in the ThoughtSpot URL
2579
2591
  * should be encoded in base64. This provides additional security to
2580
- * Thoughtspot clusters against cross-site scripting attacks.
2592
+ * ThoughtSpot clusters against cross-site scripting attacks.
2581
2593
  * @default false
2582
2594
  */
2583
2595
  shouldEncodeUrlQueryParams?: boolean;
@@ -2730,18 +2742,18 @@ export interface EmbedConfig {
2730
2742
  */
2731
2743
  disableSDKTracking?: boolean;
2732
2744
  /**
2733
- * Overrides default/user preffered locale for date formatting
2734
- * @version SDK: 1.28.4 | Thoughtspot: 10.0.0.cl, 9.5.0.sw
2745
+ * Overrides default/user preferred locale for date formatting
2746
+ * @version SDK: 1.28.4 | ThoughtSpot: 10.0.0.cl, 9.5.0.sw
2735
2747
  */
2736
2748
  dateFormatLocale?: string;
2737
2749
  /**
2738
- * Overrides default/user preffered locale for number formatting
2739
- * @version SDK: 1.28.4 | Thoughtspot: 10.0.0.cl, 9.5.0.sw
2750
+ * Overrides default/user preferred locale for number formatting
2751
+ * @version SDK: 1.28.4 | ThoughtSpot: 10.0.0.cl, 9.5.0.sw
2740
2752
  */
2741
2753
  numberFormatLocale?: string;
2742
2754
  /**
2743
2755
  * Format to be used for currency when currency format is set to infer from browser
2744
- * @version SDK: 1.28.4 | Thoughtspot: 10.0.0.cl, 9.5.0.sw
2756
+ * @version SDK: 1.28.4 | ThoughtSpot: 10.0.0.cl, 9.5.0.sw
2745
2757
  */
2746
2758
  currencyFormat?: string;
2747
2759
  /**
@@ -2755,12 +2767,12 @@ export interface EmbedConfig {
2755
2767
  * disableTokenVerification : true
2756
2768
  * })
2757
2769
  * ```
2758
- * @version SDK: 1.28.5 | Thoughtspot: *
2770
+ * @version SDK: 1.28.5 | ThoughtSpot: 9.10.0.cl, 10.1.0.sw
2759
2771
  */
2760
2772
  disableTokenVerification?: boolean;
2761
2773
  /**
2762
2774
  * This flag is used to disable showing the login failure page in the embedded app.
2763
- * @version SDK 1.32.3 | Thoughtspot: *
2775
+ * @version SDK 1.32.3 | ThoughtSpot: 10.1.0.cl, 10.1.0.sw
2764
2776
  */
2765
2777
  disableLoginFailurePage?: boolean;
2766
2778
  /**
@@ -2798,7 +2810,7 @@ export interface EmbedConfig {
2798
2810
  * }
2799
2811
  * });
2800
2812
  * ```
2801
- * @version SDK 1.37.0 | Thoughtspot: 10.7.0.cl
2813
+ * @version SDK 1.37.0 | ThoughtSpot: 10.7.0.cl
2802
2814
  */
2803
2815
  customVariablesForThirdPartyTools?: Record<string, any>;
2804
2816
  }
@@ -2957,7 +2969,7 @@ export interface ViewConfig {
2957
2969
  /**
2958
2970
  * The list of parameter override to apply to a search answer,
2959
2971
  * visualization, or Liveboard.
2960
- * @version SDK : 1.25.0 | Thoughtspot: 9.2.0.cl, 9.5.0.sw
2972
+ * @version SDK : 1.25.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
2961
2973
  * @example
2962
2974
  * ```js
2963
2975
  * const embed = new LiveboardEmbed('#embed-container', {
@@ -3017,7 +3029,7 @@ export interface ViewConfig {
3017
3029
  /**
3018
3030
  * Insert as a sibling of the target container, instead of appending to a
3019
3031
  * child inside it.
3020
- * @version SDK: 1.2.0 | Thoughtspot: 9.0.0.cl, 9.0.0.sw
3032
+ * @version SDK: 1.2.0 | ThoughtSpot: 9.0.0.cl, 9.0.0.sw
3021
3033
  * @example
3022
3034
  * ```js
3023
3035
  * const embed = new LiveboardEmbed('#embed-container', {
@@ -3090,7 +3102,7 @@ export interface ViewConfig {
3090
3102
  * 'f547ec54-2a37-4516-a222-2b06719af726']
3091
3103
  * });
3092
3104
  * ```
3093
- * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
3105
+ * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw
3094
3106
  */
3095
3107
  hiddenTabs?: string[];
3096
3108
  /**
@@ -3100,7 +3112,7 @@ export interface ViewConfig {
3100
3112
  * **Note**: This option does not apply to the classic homepage.
3101
3113
  * To access the updated modular homepage, set
3102
3114
  * `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
3103
- * @version SDK: 1.28.0 | Thoughtspot: 9.12.5.cl
3115
+ * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
3104
3116
  * @example
3105
3117
  * ```js
3106
3118
  * const embed = new AppEmbed('#tsEmbed', {
@@ -3117,7 +3129,7 @@ export interface ViewConfig {
3117
3129
  * **Note**: This option does not apply to the classic homepage.
3118
3130
  * To access the updated modular homepage, set
3119
3131
  * `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
3120
- * @version SDK: 1.28.0| Thoughtspot: 9.12.5.cl
3132
+ * @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl, 10.1.0.sw
3121
3133
  * @example
3122
3134
  * ```js
3123
3135
  * const embed = new AppEmbed('#tsEmbed', {
@@ -3132,7 +3144,7 @@ export interface ViewConfig {
3132
3144
  * Only the tabs specified in the array will be shown in the Liveboard.
3133
3145
  *
3134
3146
  * Use either `visibleTabs` or `hiddenTabs`.
3135
- * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
3147
+ * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw
3136
3148
  * @example
3137
3149
  * ```js
3138
3150
  * const embed = new LiveboardEmbed('#embed-container', {
@@ -3160,7 +3172,7 @@ export interface ViewConfig {
3160
3172
  * **Note**: This option does not apply to the classic homepage.
3161
3173
  * To access the updated modular homepage, set
3162
3174
  * `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
3163
- * @version SDK: 1.28.0 | Thoughtspot: 9.12.5.cl
3175
+ * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
3164
3176
  */
3165
3177
  hiddenHomeLeftNavItems?: HomeLeftNavItem[];
3166
3178
  /**
@@ -3175,7 +3187,7 @@ export interface ViewConfig {
3175
3187
  * });
3176
3188
  * embed.showPreRender();
3177
3189
  * ```
3178
- * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl, 9.8.0.sw
3190
+ * @version SDK: 1.25.0 | ThoughtSpot: 9.6.0.cl, 9.8.0.sw
3179
3191
  */
3180
3192
  preRenderId?: string;
3181
3193
  /**
@@ -3229,7 +3241,7 @@ export interface ViewConfig {
3229
3241
  /**
3230
3242
  * To set the initial state of the search bar in case of saved Answers.
3231
3243
  * @default true
3232
- * @version SDK: 1.34.0 | Thoughtspot: 10.3.0.cl
3244
+ * @version SDK: 1.34.0 | ThoughtSpot: 10.3.0.cl
3233
3245
  * @example
3234
3246
  * ```js
3235
3247
  * const embed = new LiveboardEmbed('#embed', {
@@ -3253,7 +3265,7 @@ export interface ViewConfig {
3253
3265
  /**
3254
3266
  * Flag to control Data panel experience
3255
3267
  * @default false
3256
- * @version SDK: 1.34.0 | Thoughtspot: 10.3.0.cl
3268
+ * @version SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
3257
3269
  * @example
3258
3270
  * ```js
3259
3271
  * const embed = new AppEmbed('#tsEmbed', {
@@ -3265,7 +3277,7 @@ export interface ViewConfig {
3265
3277
  dataPanelV2?: boolean;
3266
3278
  /**
3267
3279
  * To enable custom column groups in data panel v2
3268
- * @version SDK: 1.32.0 | Thoughtspot: 10.0.0.cl
3280
+ * @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl, 10.1.0.sw
3269
3281
  * @default false
3270
3282
  * @example
3271
3283
  * ```js
@@ -3293,9 +3305,10 @@ export interface ViewConfig {
3293
3305
  */
3294
3306
  overrideOrgId?: number;
3295
3307
  /**
3296
- * Flag to control new flip tooltip context menu experience
3308
+ * Flag to enhance the visual effects of charts
3309
+ * This feature is a beta release for 10.6
3297
3310
  * @default false
3298
- * @version SDK: 1.36.0 | Thoughtspot: 10.6.0.cl
3311
+ * @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
3299
3312
  */
3300
3313
  enableFlipTooltipToContextMenu?: boolean;
3301
3314
  }
@@ -3415,7 +3428,7 @@ export declare enum RuntimeFilterOp {
3415
3428
  * **Note**: This option does not apply to the classic homepage.
3416
3429
  * To access the updated modular homepage, set
3417
3430
  * `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
3418
- * @version SDK: 1.28.0 | Thoughtspot: 9.12.5.cl
3431
+ * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
3419
3432
  */
3420
3433
  export declare enum HomepageModule {
3421
3434
  /**
@@ -4258,7 +4271,7 @@ export declare enum EmbedEvent {
4258
4271
  */
4259
4272
  Explore = "explore",
4260
4273
  /**
4261
- * Emitted when a user clicks **Copy link** action on a visualization
4274
+ * Emitted when a user clicks **Copy link** action on a visualization.
4262
4275
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
4263
4276
  * @example
4264
4277
  *```js
@@ -4308,23 +4321,26 @@ export declare enum EmbedEvent {
4308
4321
  */
4309
4322
  FilterChanged = "filterChanged",
4310
4323
  /**
4311
- * Emitted when a user clicks the **Go** button on the sage embed
4312
- * @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
4324
+ * Emitted when a user clicks the **Go** button to initiate
4325
+ * a Natural Language Search query
4326
+ * @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
4313
4327
  */
4314
4328
  SageEmbedQuery = "sageEmbedQuery",
4315
4329
  /**
4316
- * Emitted when a user selects a data source on the sage embed
4317
- * @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
4330
+ * Emitted when a user selects a data source on the embedded
4331
+ * Natural Language Search interface.
4332
+ *
4333
+ * @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
4318
4334
  */
4319
4335
  SageWorksheetUpdated = "sageWorksheetUpdated",
4320
4336
  /**
4321
4337
  * Emitted when a user updates a connection on the **Data** page
4322
- * @version SDK : 1.27.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
4338
+ * @version SDK : 1.27.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
4323
4339
  */
4324
4340
  UpdateConnection = "updateConnection",
4325
4341
  /**
4326
4342
  * Emitted when a user updates a connection on the **Data** page
4327
- * @version SDK : 1.27.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
4343
+ * @version SDK : 1.27.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
4328
4344
  */
4329
4345
  CreateConnection = "createConnection",
4330
4346
  /**
@@ -4334,7 +4350,7 @@ export declare enum EmbedEvent {
4334
4350
  * @returns viewId: string
4335
4351
  * @returns liveboardId: string
4336
4352
  * @returns isPublic: boolean
4337
- * @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
4353
+ * @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
4338
4354
  */
4339
4355
  UpdatePersonalisedView = "updatePersonalisedView",
4340
4356
  /**
@@ -4343,7 +4359,7 @@ export declare enum EmbedEvent {
4343
4359
  * @returns viewId: string
4344
4360
  * @returns liveboardId: string
4345
4361
  * @returns isPublic: boolean
4346
- * @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
4362
+ * @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
4347
4363
  */
4348
4364
  SavePersonalisedView = "savePersonalisedView",
4349
4365
  /**
@@ -4352,28 +4368,28 @@ export declare enum EmbedEvent {
4352
4368
  * @returns viewId: string
4353
4369
  * @returns liveboardId: string
4354
4370
  * @returns isPublic: boolean
4355
- * @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
4371
+ * @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
4356
4372
  */
4357
4373
  ResetLiveboard = "resetLiveboard",
4358
4374
  /**
4359
4375
  * Emitted when a PersonalisedView is deleted.
4360
4376
  * @returns views: string[]
4361
4377
  * @returns liveboardId: string
4362
- * @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
4378
+ * @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
4363
4379
  */
4364
4380
  DeletePersonalisedView = "deletePersonalisedView",
4365
4381
  /**
4366
4382
  * Emitted when a user creates a new worksheet
4367
- * @version SDK : 1.27.0 | Thoughtspot: 9.8.0.cl
4383
+ * @version SDK : 1.27.0 | ThoughtSpot Cloud: 9.8.0.cl
4368
4384
  */
4369
4385
  CreateWorksheet = "createWorksheet",
4370
4386
  /**
4371
- * Emitted when Ask Sage is initialized.
4387
+ * Emitted when the *Ask Sage* is initialized.
4372
4388
  * @returns viewName: string
4373
4389
  * @returns viewId: string
4374
4390
  * @returns liveboardId: string
4375
4391
  * @returns isPublic: boolean
4376
- * @version SDK : 1.29.0 | Thoughtspot: 9.12.0.cl
4392
+ * @version SDK : 1.29.0 | ThoughtSpot Cloud: 9.12.0.cl
4377
4393
  */
4378
4394
  AskSageInit = "AskSageInit",
4379
4395
  /**
@@ -4401,7 +4417,7 @@ export declare enum EmbedEvent {
4401
4417
  *
4402
4418
  * error: Developers can customize the error message text when `execute`
4403
4419
  * returns `false` using the error parameter in responder.
4404
- * @version SDK : 1.29.0 | Thoughtspot : 10.3.0.cl
4420
+ * @version SDK : 1.29.0 | ThoughtSpot : 10.3.0.cl
4405
4421
  * @example
4406
4422
  *```js
4407
4423
  * .on(EmbedEvent.OnBeforeGetVizDataIntercept,
@@ -4449,9 +4465,26 @@ export declare enum EmbedEvent {
4449
4465
  * console.log('payload', payload);
4450
4466
  * })
4451
4467
  *```
4452
- * @version SDK : 1.29.0 | Thoughtspot : 10.3.0.cl
4468
+ * @version SDK : 1.29.0 | ThoughtSpot : 10.3.0.cl
4469
+ */
4470
+ ParameterChanged = "parameterChanged",
4471
+ /**
4472
+ * Emitted when the table viz renders.
4473
+ * You can use this event as a hook to trigger
4474
+ * other events on the rendered table viz data.
4475
+ * @example
4476
+ * ```js
4477
+ * searchEmbed.on(EmbedEvent.TableVizRendered, (payload) => {
4478
+ * console.log(payload);
4479
+ * const columnDataLite = payload.data.data.columnDataLite;
4480
+ * columnDataLite[0].dataValue[0]="new fob";
4481
+ * console.log('>>> new Data', columnDataLite);
4482
+ * searchEmbed.trigger(HostEvent.TransformTableVizData, columnDataLite);
4483
+ * })
4484
+ * ```
4485
+ * @version SDK: 1.35.12 | ThoughtSpot: 10.7.0.cl
4453
4486
  */
4454
- ParameterChanged = "parameterChanged"
4487
+ TableVizRendered = "TableVizRendered"
4455
4488
  }
4456
4489
  /**
4457
4490
  * Event types that can be triggered by the host application
@@ -4596,7 +4629,7 @@ export declare enum HostEvent {
4596
4629
  * const url = embed.trigger(HostEvent.GetIframeUrl);
4597
4630
  * console.log("iFrameURL",url);
4598
4631
  * ```
4599
- * @version SDK: 1.35.0 | Thoughtspot: 10.4.0.cl
4632
+ * @version SDK: 1.35.0 | ThoughtSpot: 10.4.0.cl
4600
4633
  */
4601
4634
  GetIframeUrl = "GetIframeUrl",
4602
4635
  /**
@@ -4629,6 +4662,11 @@ export declare enum HostEvent {
4629
4662
  * attributes passed with this event are appended to the existing runtime
4630
4663
  * filters applied on a Liveboard.
4631
4664
  *
4665
+ * **Note**: `HostEvent.UpdateRuntimeFilters` is supported in `LiveboardEmbed`
4666
+ * and `AppEmbed` only. In full application embedding, this event updates
4667
+ * the runtime filters applied on the Liveboard and saved Answer objects.
4668
+ *
4669
+ *
4632
4670
  * Pass an array of runtime filters with the following attributes:
4633
4671
  *
4634
4672
  * `columnName` - _String_. The name of the column to filter on.
@@ -4639,9 +4677,12 @@ export declare enum HostEvent {
4639
4677
  * `values` - List of operands. Some operators such as EQ and LE allow a
4640
4678
  * single value, whereas BW and IN accept multiple values.
4641
4679
  *
4642
- * **Note**: `HostEvent.UpdateRuntimeFilters` is supported in `LiveboardEmbed`
4643
- * and `AppEmbed` only. In full application embedding, this event updates
4644
- * the runtime filters applied on the Liveboard and saved Answer objects.
4680
+ * **Note**: Updating runtime filters resets the ThoughtSpot
4681
+ * object to its original state and applies new filter conditions.
4682
+ * Any user changes (like drilling into a visualization)
4683
+ * will be cleared, restoring the original visualization
4684
+ * with the updated filters.
4685
+ *
4645
4686
  * @param - {@link RuntimeFilter}[] an array of {@link RuntimeFilter} Types.
4646
4687
  * @example
4647
4688
  * ```js
@@ -4656,7 +4697,7 @@ export declare enum HostEvent {
4656
4697
  UpdateRuntimeFilters = "UpdateRuntimeFilters",
4657
4698
  /**
4658
4699
  * Navigate to a specific page in the embedded ThoughtSpot application.
4659
- * This is the same as calling `appEmbed.navigateToPage(path, true)`
4700
+ * This is the same as calling `appEmbed.navigateToPage(path, true)`.
4660
4701
  * @param - `path` - the path to navigate to to go forward or back. The path value can
4661
4702
  * be a number; for example, `1`, `-1`.
4662
4703
  * @example
@@ -4852,7 +4893,7 @@ export declare enum HostEvent {
4852
4893
  * @param - an object with `vizId` as a key
4853
4894
  * @example
4854
4895
  * ```js
4855
- * liveboardEmbed.trigger(HostEvent.CreateMonitor {
4896
+ * liveboardEmbed.trigger(HostEvent.CreateMonitor, {
4856
4897
  * vizId: '730496d6-6903-4601-937e-2c691821af3c'
4857
4898
  * })
4858
4899
  * ```
@@ -4951,7 +4992,9 @@ export declare enum HostEvent {
4951
4992
  */
4952
4993
  GetTML = "getTML",
4953
4994
  /**
4954
- * Trigger the **Show underlying data** action on visualization or search
4995
+ * Trigger the **Show underlying data** action on a
4996
+ * chart or table.
4997
+ *
4955
4998
  * @param - an object with vizId as a key
4956
4999
  * @example
4957
5000
  * ```js
@@ -4985,8 +5028,8 @@ export declare enum HostEvent {
4985
5028
  */
4986
5029
  Delete = "onDeleteAnswer",
4987
5030
  /**
4988
- * Trigger the **SpotIQ analyze** action on visualization
4989
- * or search.
5031
+ * Trigger the **SpotIQ analyze** action on a
5032
+ * chart or table.
4990
5033
  * @param - Liveboard embed takes `vizId` as a
4991
5034
  * key. Can be left undefined when embedding Search or
4992
5035
  * visualization.
@@ -5259,7 +5302,7 @@ export declare enum HostEvent {
5259
5302
  * '430496d6-6903-4601-937e-2c691821af3c',
5260
5303
  * 'f547ec54-2a37-4516-a222-2b06719af726'])
5261
5304
  * ```
5262
- * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
5305
+ * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
5263
5306
  */
5264
5307
  SetVisibleTabs = "SetPinboardVisibleTabs",
5265
5308
  /**
@@ -5272,7 +5315,7 @@ export declare enum HostEvent {
5272
5315
  * '630496d6-6903-4601-937e-2c691821af3c',
5273
5316
  * 'i547ec54-2a37-4516-a222-2b06719af726'])
5274
5317
  * ```
5275
- * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
5318
+ * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
5276
5319
  */
5277
5320
  SetHiddenTabs = "SetPinboardHiddenTabs",
5278
5321
  /**
@@ -5286,7 +5329,7 @@ export declare enum HostEvent {
5286
5329
  * executeSearch: true,
5287
5330
  * })
5288
5331
  * ```
5289
- * @version SDK: 1.26.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
5332
+ * @version SDK: 1.26.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
5290
5333
  */
5291
5334
  UpdateSageQuery = "updateSageQuery",
5292
5335
  /**
@@ -5303,21 +5346,22 @@ export declare enum HostEvent {
5303
5346
  * ```js
5304
5347
  * const {session} = await embed.trigger( HostEvent.GetAnswerSession )
5305
5348
  * ```
5306
- * @version SDK: 1.26.0 | Thoughtspot: 9.10.0.cl
5349
+ * @version SDK: 1.26.0 | ThoughtSpot: 9.10.0.cl, 10.1.0.sw
5307
5350
  */
5308
5351
  GetAnswerSession = "getAnswerSession",
5309
5352
  /**
5310
- * Trigger Ask Sage for viz
5353
+ * Trigger the *Ask Sage* action for visualizations
5311
5354
  * @example
5312
5355
  * ```js
5313
5356
  * liveboardEmbed.trigger(HostEvent.AskSage,
5314
5357
  * {vizId:'730496d6-6903-4601-937e-2c691821af3c'})
5315
5358
  * ```
5316
- * @version SDK: 1.29.0 | Thoughtspot: 9.12.0.cl
5359
+ * @version SDK: 1.29.0 | ThoughtSpot Cloud: 9.12.0.cl
5317
5360
  */
5318
5361
  AskSage = "AskSage",
5319
5362
  /**
5320
- * Trigger cross filter update action on a Liveboard
5363
+ * Trigger cross filter update action on a Liveboard.
5364
+ *
5321
5365
  * @example
5322
5366
  * ```js
5323
5367
  * liveboardEmbed.trigger(HostEvent.UpdateCrossFilter, {
@@ -5328,7 +5372,7 @@ export declare enum HostEvent {
5328
5372
  * ],
5329
5373
  * });
5330
5374
  * ```
5331
- * @version SDK: 1.29.0 | Thoughtspot: 10.0.0.cl
5375
+ * @version SDK: 1.29.0 | ThoughtSpot Cloud: 10.0.0.cl, 10.1.0.sw
5332
5376
  */
5333
5377
  UpdateCrossFilter = "UpdateCrossFilter",
5334
5378
  /**
@@ -5337,11 +5381,13 @@ export declare enum HostEvent {
5337
5381
  * ```js
5338
5382
  * liveboardEmbed.trigger(HostEvent.ResetLiveboardPersonalisedView);
5339
5383
  * ```
5340
- * @version SDK: 1.29.0 | Thoughtspot: 10.1.0.cl
5384
+ * @version SDK: 1.29.0 | ThoughtSpot Cloud: 10.1.0.cl, 10.1.0.sw
5341
5385
  */
5342
5386
  ResetLiveboardPersonalisedView = "ResetLiveboardPersonalisedView",
5343
5387
  /**
5344
- * Triggers an event to Update Parameter values for Answers and Liveboard
5388
+ * Triggers an action to update Parameter values on embedded
5389
+ * Answers and Liveboard.
5390
+ *
5345
5391
  * @example
5346
5392
  * ```js
5347
5393
  * liveboardEmbed.trigger(HostEvent.UpdateParameters, [{
@@ -5349,37 +5395,56 @@ export declare enum HostEvent {
5349
5395
  * value: "almond"
5350
5396
  * }])
5351
5397
  *
5352
- * @version SDK: 1.29.0 | Thoughtspot: 10.1.0.cl
5398
+ * @version SDK: 1.29.0 | ThoughtSpot: 10.1.0.cl, 10.1.0.sw
5353
5399
  */
5354
5400
  UpdateParameters = "UpdateParameters",
5355
5401
  /**
5356
- * Triggers GetParameters to fetch the runtime parameters
5402
+ * Triggers GetParameters to fetch the runtime Parameters.
5357
5403
  * ```js
5358
5404
  * liveboardEmbed.trigger(HostEvent.GetParameters).then((parameter) => {
5359
5405
  * console.log('parameters', parameter);
5360
5406
  * });
5361
5407
  *```
5362
- * @version SDK: 1.29.0 | Thoughtspot: 10.1.0.cl
5408
+ * @version SDK: 1.29.0 | ThoughtSpot: 10.1.0.cl, 10.1.0.sw
5363
5409
  */
5364
5410
  GetParameters = "GetParameters",
5365
5411
  /**
5366
- * Triggers an event to update a persoanlised view of a Liveboard
5412
+ * Triggers an event to update a personalized view of a Liveboard.
5367
5413
  * ```js
5368
5414
  * liveboardEmbed.trigger(HostEvent.UpdatePersonalisedView, {viewId: '1234'})
5369
5415
  * ```
5370
- * @version SDK: 1.36.0 | Thoughtspot: 10.6.0.cl
5416
+ * @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
5371
5417
  */
5372
5418
  UpdatePersonalisedView = "UpdatePersonalisedView",
5373
5419
  /**
5374
- * Triggers the action to get the current view of the liveboard
5375
- * @version SDK: 1.36.0 | Thoughtspot: 10.6.0.cl
5420
+ * Triggers the action to get the current view of the Liveboard.
5421
+ * @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
5376
5422
  */
5377
5423
  SaveAnswer = "saveAnswer",
5378
5424
  /**
5379
5425
  * EmbedApi
5380
5426
  * @hidden
5381
5427
  */
5382
- UIPassthrough = "UiPassthrough"
5428
+ UIPassthrough = "UiPassthrough",
5429
+ /**
5430
+ * Triggers the table viz rerender with the updated data.
5431
+ * Includes the following properties:
5432
+ * @param - columnDataLite - an array of object containing data
5433
+ * transformed from data picked from TableVizRendered event.
5434
+ * For example, { columnDataLite: []}
5435
+ * @example
5436
+ * ```js
5437
+ * searchEmbed.on(EmbedEvent.TableVizRendered, (payload) => {
5438
+ * console.log(payload);
5439
+ * const columnDataLite = payload.data.data.columnDataLite;
5440
+ * columnDataLite[0].dataValue[0]="new fob";
5441
+ * console.log('>>> new Data', columnDataLite);
5442
+ * searchEmbed.trigger(HostEvent.TransformTableVizData, columnDataLite);
5443
+ * })
5444
+ * ```
5445
+ * @version SDK: 1.35.12 | ThoughtSpot: 10.7.0.cl
5446
+ */
5447
+ TransformTableVizData = "TransformTableVizData"
5383
5448
  }
5384
5449
  /**
5385
5450
  * The different visual modes that the data sources panel within
@@ -5441,7 +5506,7 @@ export declare enum Param {
5441
5506
  AuthType = "authType",
5442
5507
  IconSpriteUrl = "iconSprite",
5443
5508
  cookieless = "cookieless",
5444
- ContextMenuTrigger = "isContextMenuEnabledOnLeftClick",
5509
+ ContextMenuTrigger = "contextMenuEnabledOnWhichClick",
5445
5510
  LinkOverride = "linkOverride",
5446
5511
  blockNonEmbedFullAppAccess = "blockNonEmbedFullAppAccess",
5447
5512
  ShowInsertToSlide = "insertInToSlide",
@@ -5592,7 +5657,8 @@ export declare enum Action {
5592
5657
  ResetLayout = "resetLayout",
5593
5658
  /**
5594
5659
  * The **Schedule** menu action on a Liveboard.
5595
- * Allows scheduling a Liveboard notification.
5660
+ * Allows scheduling a Liveboard job, for example,
5661
+ * sending periodic notifications.
5596
5662
  * @example
5597
5663
  * ```js
5598
5664
  * disabledActions: [Action.Schedule]
@@ -5634,7 +5700,7 @@ export declare enum Action {
5634
5700
  * ```js
5635
5701
  * disabledActions: [Action.AddDataPanelObjects]
5636
5702
  * ```
5637
- * @version SDK: 1.32.0 | Thoughtspot: 10.0.0.cl
5703
+ * @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl, 10.1.0.sw
5638
5704
  */
5639
5705
  AddDataPanelObjects = "addDataPanelObjects",
5640
5706
  /**
@@ -5647,7 +5713,28 @@ export declare enum Action {
5647
5713
  * ```
5648
5714
  */
5649
5715
  ConfigureFilter = "configureFilter",
5716
+ /**
5717
+ * The **Collapse data sources** icon on the Search page.
5718
+ * Collapses the panel showing data sources.
5719
+ *
5720
+ * @example
5721
+ * ```js
5722
+ * disabledActions: [Action.CollapseDataPanel]
5723
+ * ```
5724
+ * @version: SDK: 1.1.0 | ThoughtSpot Cloud: ts7.may.cl, 8.4.1.sw
5725
+ */
5650
5726
  CollapseDataSources = "collapseDataSources",
5727
+ /**
5728
+ * The **Collapse data panel** icon on the Search page.
5729
+ * Collapses the data panel view.
5730
+ *
5731
+ * @version: SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl, 10.7.0.sw
5732
+ *
5733
+ * @example
5734
+ * ```js
5735
+ * disabledActions: [Action.CollapseDataPanel]
5736
+ * ```
5737
+ */
5651
5738
  CollapseDataPanel = "collapseDataPanel",
5652
5739
  /**
5653
5740
  * The **Choose sources** button on Search page.
@@ -5683,7 +5770,7 @@ export declare enum Action {
5683
5770
  * ```js
5684
5771
  * disabledActions: [Action.AddColumnSet]
5685
5772
  * ```
5686
- * @version SDK: 1.32.0 | Thoughtspot: 10.0.0.cl
5773
+ * @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl, 10.1.0.sw
5687
5774
  */
5688
5775
  AddColumnSet = "addSimpleCohort",
5689
5776
  /**
@@ -5693,7 +5780,7 @@ export declare enum Action {
5693
5780
  * ```js
5694
5781
  * disabledActions: [Action.AddQuerySet]
5695
5782
  * ```
5696
- * @version SDK: 1.32.0 | Thoughtspot: 10.0.0.cl
5783
+ * @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl, 10.1.0.sw
5697
5784
  */
5698
5785
  AddQuerySet = "addAdvancedCohort",
5699
5786
  /**
@@ -5725,6 +5812,8 @@ export declare enum Action {
5725
5812
  /**
5726
5813
  * The **Show underlying data** menu action on a visualization or
5727
5814
  * Answer page.
5815
+ * Displays detailed information and raw data
5816
+ * for a given visualization.
5728
5817
  * @example
5729
5818
  * ```js
5730
5819
  * disabledActions: [Action.ShowUnderlyingData]
@@ -5926,6 +6015,7 @@ export declare enum Action {
5926
6015
  AnalysisInfo = "analysisInfo",
5927
6016
  /**
5928
6017
  * The **Schedule** menu action on a Liveboard.
6018
+ * Allows scheduling a Liveboard job.
5929
6019
  * @example
5930
6020
  * ```js
5931
6021
  * disabledActions: [Action.Subscription]
@@ -5995,8 +6085,13 @@ export declare enum Action {
5995
6085
  */
5996
6086
  RequestAccess = "requestAccess",
5997
6087
  /**
5998
- * The **Query visualizer** and **Query SQL** buttons in Query details panel
5999
- * of the Answer page
6088
+ * The **Query visualizer** and **Query SQL** buttons in
6089
+ * Query details panel of the Answer page.
6090
+ *
6091
+ * **Query visualizer** - Displays the tables
6092
+ * and filters used in a search query.
6093
+ * **Query SQL** - Displays the SQL statements used
6094
+ * in a search query to fetch data.
6000
6095
  * @example
6001
6096
  * ```js
6002
6097
  * disabledActions: [Action.QueryDetailsButtons]
@@ -6014,7 +6109,10 @@ export declare enum Action {
6014
6109
  */
6015
6110
  AnswerDelete = "onDeleteAnswer",
6016
6111
  /**
6017
- * The Chart switcher icon on Answer and visualization pages.
6112
+ * The chart switcher icon on Answer page and
6113
+ * visualizations in edit mode.
6114
+ * Allows switching to the table or chart mode
6115
+ * when editing a visualization.
6018
6116
  * @example
6019
6117
  * ```js
6020
6118
  * disabledActions: [Action.AnswerChartSwitcher]
@@ -6023,7 +6121,10 @@ export declare enum Action {
6023
6121
  */
6024
6122
  AnswerChartSwitcher = "answerChartSwitcher",
6025
6123
  /**
6026
- * Favorites icon (*) on Answers, Liveboard, and Data pages
6124
+ * The Favorites icon (*) for Answers,
6125
+ * Liveboard, and data objects like Worksheet, Model,
6126
+ * Tables and Views.
6127
+ * Allows adding an object to the user’s favorites list.
6027
6128
  * @example
6028
6129
  * ```js
6029
6130
  * disabledActions: [Action.AddToFavorites]
@@ -6041,7 +6142,9 @@ export declare enum Action {
6041
6142
  */
6042
6143
  EditDetails = "editDetails",
6043
6144
  /**
6044
- * The Create alert action on KPI charts.
6145
+ * The *Create alert* action for KPI charts.
6146
+ * Allows users to schedule threshold-based alerts
6147
+ * for KPI charts.
6045
6148
  * @example
6046
6149
  * ```js
6047
6150
  * disabledActions: [Action.CreateMonitor]
@@ -6097,7 +6200,7 @@ export declare enum Action {
6097
6200
  * ```js
6098
6201
  * disabledActions: [Action.CrossFilter]
6099
6202
  * ```
6100
- * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
6203
+ * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.8.0.sw
6101
6204
  */
6102
6205
  CrossFilter = "context-menu-item-cross-filter",
6103
6206
  /**
@@ -6107,7 +6210,7 @@ export declare enum Action {
6107
6210
  * ```js
6108
6211
  * disabledActions: [Action.SyncToSlack]
6109
6212
  * ```
6110
- * @version @version SDK : 1.32.0 | Thoughtspot: 10.1.0.cl
6213
+ * @version @version SDK : 1.32.0 | ThoughtSpot Cloud: 10.1.0.cl
6111
6214
  */
6112
6215
  SyncToSlack = "syncToSlack",
6113
6216
  /**
@@ -6117,7 +6220,7 @@ export declare enum Action {
6117
6220
  * ```js
6118
6221
  * disabledActions: [Action.SyncToTeams]
6119
6222
  * ```
6120
- * @version @version SDK : 1.32.0 | Thoughtspot: 10.1.0.cl
6223
+ * @version @version SDK : 1.32.0 | ThoughtSpot Cloud: 10.1.0.cl
6121
6224
  */
6122
6225
  SyncToTeams = "syncToTeams",
6123
6226
  /**
@@ -6128,7 +6231,7 @@ export declare enum Action {
6128
6231
  * ```js
6129
6232
  * disabledActions: [Action.RemoveCrossFilter]
6130
6233
  * ```
6131
- * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
6234
+ * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
6132
6235
  */
6133
6236
  RemoveCrossFilter = "context-menu-item-remove-cross-filter",
6134
6237
  /**
@@ -6139,7 +6242,7 @@ export declare enum Action {
6139
6242
  * ```js
6140
6243
  * disabledActions: [Action.AxisMenuAggregate]
6141
6244
  * ```
6142
- * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
6245
+ * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
6143
6246
  */
6144
6247
  AxisMenuAggregate = "axisMenuAggregate",
6145
6248
  /**
@@ -6150,17 +6253,19 @@ export declare enum Action {
6150
6253
  * ```js
6151
6254
  * disabledActions: [Action.AxisMenuTimeBucket]
6152
6255
  * ```
6153
- * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
6256
+ * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
6154
6257
  */
6155
6258
  AxisMenuTimeBucket = "axisMenuTimeBucket",
6156
6259
  /**
6157
6260
  * The **Filter** action in the chart axis or table column
6158
6261
  * customization menu.
6262
+ * Allows adding, editing, or removing filters.
6263
+ *
6159
6264
  * @example
6160
6265
  * ```js
6161
6266
  * disabledActions: [Action.AxisMenuFilter]
6162
6267
  * ```
6163
- * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
6268
+ * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
6164
6269
  */
6165
6270
  AxisMenuFilter = "axisMenuFilter",
6166
6271
  /**
@@ -6171,7 +6276,7 @@ export declare enum Action {
6171
6276
  * ```js
6172
6277
  * disabledActions: [Action.AxisMenuConditionalFormat]
6173
6278
  * ```
6174
- * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
6279
+ * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
6175
6280
  */
6176
6281
  AxisMenuConditionalFormat = "axisMenuConditionalFormat",
6177
6282
  /**
@@ -6182,7 +6287,7 @@ export declare enum Action {
6182
6287
  * ```js
6183
6288
  * disabledActions: [Action.AxisMenuConditionalFormat]
6184
6289
  * ```
6185
- * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
6290
+ * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
6186
6291
  */
6187
6292
  AxisMenuSort = "axisMenuSort",
6188
6293
  /**
@@ -6194,7 +6299,7 @@ export declare enum Action {
6194
6299
  * ```js
6195
6300
  * disabledActions: [Action.AxisMenuGroup]
6196
6301
  * ```
6197
- * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
6302
+ * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
6198
6303
  */
6199
6304
  AxisMenuGroup = "axisMenuGroup",
6200
6305
  /**
@@ -6205,7 +6310,7 @@ export declare enum Action {
6205
6310
  * ```js
6206
6311
  * disabledActions: [Action.AxisMenuPosition]
6207
6312
  * ```
6208
- * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
6313
+ * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
6209
6314
  */
6210
6315
  AxisMenuPosition = "axisMenuPosition",
6211
6316
  /**
@@ -6215,7 +6320,7 @@ export declare enum Action {
6215
6320
  * ```js
6216
6321
  * disabledActions: [Action.AxisMenuRename]
6217
6322
  * ```
6218
- * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
6323
+ * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
6219
6324
  */
6220
6325
  AxisMenuRename = "axisMenuRename",
6221
6326
  /**
@@ -6226,7 +6331,7 @@ export declare enum Action {
6226
6331
  * ```js
6227
6332
  * disabledActions: [Action.AxisMenuEdit]
6228
6333
  * ```
6229
- * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
6334
+ * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
6230
6335
  */
6231
6336
  AxisMenuEdit = "axisMenuEdit",
6232
6337
  /**
@@ -6236,7 +6341,7 @@ export declare enum Action {
6236
6341
  * ```js
6237
6342
  * disabledActions: [Action.AxisMenuNumberFormat]
6238
6343
  * ```
6239
- * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
6344
+ * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
6240
6345
  */
6241
6346
  AxisMenuNumberFormat = "axisMenuNumberFormat",
6242
6347
  /**
@@ -6246,7 +6351,7 @@ export declare enum Action {
6246
6351
  * ```js
6247
6352
  * disabledActions: [Action.AxisMenuTextWrapping]
6248
6353
  * ```
6249
- * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
6354
+ * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
6250
6355
  */
6251
6356
  AxisMenuTextWrapping = "axisMenuTextWrapping",
6252
6357
  /**
@@ -6258,7 +6363,7 @@ export declare enum Action {
6258
6363
  * ```js
6259
6364
  * disabledActions: [Action.AxisMenuRemove]
6260
6365
  * ```
6261
- * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
6366
+ * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
6262
6367
  */
6263
6368
  AxisMenuRemove = "axisMenuRemove",
6264
6369
  /**
@@ -6272,26 +6377,27 @@ export declare enum Action {
6272
6377
  * ```js
6273
6378
  * disabledActions: [Action.RenameModalTitleDescription]
6274
6379
  * ```
6275
- * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
6380
+ * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl, 9.8.0.sw
6276
6381
  */
6277
6382
  RenameModalTitleDescription = "renameModalTitleDescription",
6278
6383
  /**
6279
- *
6384
+ * The *Request verification* action on a Liveboard.
6385
+ * Initiates a request for Liveboard verification.
6280
6386
  * @example
6281
6387
  * ```js
6282
6388
  * disabledActions: [Action.RequestVerification]
6283
6389
  * ```
6284
- * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
6390
+ * @version SDK: 1.25.0 | ThoughtSpot: 9.6.0.cl, 10.1.0.sw
6285
6391
  */
6286
6392
  RequestVerification = "requestVerification",
6287
6393
  /**
6288
6394
  *
6289
- *Allows users to mark a Liveboard as verified.
6395
+ * Allows users to mark a Liveboard as verified.
6290
6396
  * @example
6291
6397
  * ```js
6292
6398
  * disabledActions: [Action.MarkAsVerified]
6293
6399
  * ```
6294
- * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
6400
+ * @version SDK: 1.25.0 | ThoughtSpot: 9.6.0.cl, 10.1.0.sw
6295
6401
  */
6296
6402
  MarkAsVerified = "markAsVerified",
6297
6403
  /**
@@ -6301,7 +6407,7 @@ export declare enum Action {
6301
6407
  * ```js
6302
6408
  * disabledActions: [Action.AddTab]
6303
6409
  * ```
6304
- * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
6410
+ * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
6305
6411
  */
6306
6412
  AddTab = "addTab",
6307
6413
  /**
@@ -6311,35 +6417,42 @@ export declare enum Action {
6311
6417
  * ```js
6312
6418
  * disabledActions: [Action.EnableContextualChangeAnalysis]
6313
6419
  * ```
6314
- * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
6420
+ * @version SDK: 1.25.0 | ThoughtSpot Cloud: 9.6.0.cl
6315
6421
  */
6316
6422
  EnableContextualChangeAnalysis = "enableContextualChangeAnalysis",
6317
6423
  /**
6424
+ * Action ID to hide or disable Natural Language Search query.
6318
6425
  *
6319
6426
  * @example
6320
6427
  * ```js
6321
6428
  * disabledActions: [Action.ShowSageQuery]
6322
6429
  * ```
6323
- * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
6430
+ * @version SDK: 1.26.0 | ThoughtSpot Cloud: 9.7.0.cl
6324
6431
  */
6325
6432
  ShowSageQuery = "showSageQuery",
6326
6433
  /**
6434
+ *
6435
+ * Action ID to hide or disable the edit option for the
6436
+ * results generated from the
6437
+ * Natural Language Search query.
6327
6438
  *
6328
6439
  * @example
6329
6440
  * ```js
6330
6441
  * disabledActions: [Action.EditSageAnswer]
6331
6442
  * ```
6332
- * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
6443
+ * @version SDK: 1.26.0 | ThoughtSpot Cloud: 9.7.0.cl
6333
6444
  */
6334
6445
  EditSageAnswer = "editSageAnswer",
6335
6446
  /**
6447
+ * The feedback widget for AI-generated Answers.
6448
+ * Allows users to send feedback on the Answers generated
6449
+ * from a Natural Language Search query.
6336
6450
  *
6337
- *This action allows users to send feedback on AI-generated Answers.
6338
6451
  * @example
6339
6452
  * ```js
6340
6453
  * disabledActions: [Action.SageAnswerFeedback]
6341
6454
  * ```
6342
- * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
6455
+ * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl
6343
6456
  */
6344
6457
  SageAnswerFeedback = "sageAnswerFeedback",
6345
6458
  /**
@@ -6348,7 +6461,7 @@ export declare enum Action {
6348
6461
  * ```js
6349
6462
  * disabledActions: [Action.ModifySageAnswer]
6350
6463
  * ```
6351
- * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
6464
+ * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl
6352
6465
  */
6353
6466
  ModifySageAnswer = "modifySageAnswer",
6354
6467
  /**
@@ -6361,7 +6474,10 @@ export declare enum Action {
6361
6474
  */
6362
6475
  MoveToTab = "onContainerMove",
6363
6476
  /**
6364
- * The **Manage Alertsb** menu action on KPI visualizations.
6477
+ * The **Manage Alerts** menu action on KPI visualizations.
6478
+ * Allows creating, viewing, and editing monitor
6479
+ * alerts for a KPI chart.
6480
+ *
6365
6481
  * @example
6366
6482
  * ```js
6367
6483
  * disabledActions: [Action.ManageMonitor]
@@ -6369,21 +6485,23 @@ export declare enum Action {
6369
6485
  */
6370
6486
  ManageMonitor = "manageMonitor",
6371
6487
  /**
6372
- * Action ID for Liveboard Personalised Views dropdown
6488
+ * The Liveboard Personalised Views dropdown.
6489
+ * Allows navigating to a personalized Liveboard View.
6373
6490
  * @example
6374
6491
  * ```js
6375
6492
  * disabledActions: [Action.PersonalisedViewsDropdown]
6376
6493
  * ```
6377
- * @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl
6494
+ * @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw
6378
6495
  */
6379
6496
  PersonalisedViewsDropdown = "personalisedViewsDropdown",
6380
6497
  /**
6381
- * Action ID for Liveboard Users ( Recently Visited / social proof )
6498
+ * Action ID for show or hide the user details on a
6499
+ * Liveboard (Recently visited / social proof)
6382
6500
  * @example
6383
6501
  * ```js
6384
6502
  * disabledActions: [Action.LiveboardUsers]
6385
6503
  * ```
6386
- * @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl
6504
+ * @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw
6387
6505
  */
6388
6506
  LiveboardUsers = "liveboardUsers",
6389
6507
  /**
@@ -6401,108 +6519,124 @@ export declare enum Action {
6401
6519
  * hiddenAction: [Action.TML] // hide all TML actions
6402
6520
  * disabledActions: [Action.TML] // to disable all TML actions
6403
6521
  * ```
6404
- * @version SDK : 1.28.3 | Thoughtspot: 9.12.0.cl
6522
+ * @version SDK : 1.28.3 | ThoughtSpot: 9.12.0.cl, 10.1.0.sw
6405
6523
  */
6406
6524
  TML = "tml",
6407
6525
  /**
6408
- * Action ID for the create Liveboard option on the Liveboard list page
6409
- * and Pin modal
6526
+ * The **Create Liveboard* action on
6527
+ * the Liveboards page and the Pin modal.
6528
+ * Allows users to create a Liveboard.
6529
+ *
6410
6530
  * @example
6411
6531
  * ```js
6412
6532
  * hiddenAction: [Action.CreateLiveboard]
6413
6533
  * disabledActions: [Action.CreateLiveboard]
6414
6534
  * ```
6415
- * @version SDK: 1.32.0 | Thoughtspot: 10.1.0.cl
6535
+ * @version SDK: 1.32.0 | ThoughtSpot: 10.1.0.cl, 10.1.0.sw
6416
6536
  */
6417
6537
  CreateLiveboard = "createLiveboard",
6418
6538
  /**
6419
- * Action ID for to hide Verified Liveboard Banner
6539
+ * Action ID for to hide or disable the
6540
+ * Verified Liveboard banner.
6420
6541
  * @example
6421
6542
  * ```js
6422
6543
  * hiddenAction: [Action.VerifiedLiveboard]
6423
6544
  * ```
6424
- * @version SDK: 1.29.0 | Thoughtspot: 9.10.0.cl
6545
+ * @version SDK: 1.29.0 | ThoughtSpot: 9.10.0.cl, 10.1.0.sw
6425
6546
  */
6426
6547
  VerifiedLiveboard = "verifiedLiveboard",
6427
6548
  /**
6428
- * Action ID for ask sage button
6549
+ * The *Ask Sage* action for Answers and visualizations.
6550
+ * Allows initiating a Natural Language Search query.
6551
+ *
6429
6552
  * @example
6430
6553
  * ```js
6431
6554
  * hiddenAction: [Action.AskAi]
6432
6555
  * ```
6433
- * @version SDK: 1.29.0 | Thoughtspot: 9.12.0.cl
6556
+ * @version SDK: 1.29.0 | ThoughtSpot Cloud: 9.12.0.cl
6434
6557
  */
6435
6558
  AskAi = "AskAi",
6436
6559
  /**
6437
6560
  * The **Add KPI to Watchlist** action on Home page watchlist.
6561
+ * Adds a KPI chart to the watchlist on the Home page.
6438
6562
  * @example
6439
6563
  * ```js
6440
6564
  * disabledActions: [Action.AddToWatchlist]
6441
6565
  * ```
6442
- * @version SDK : 1.27.9 | Thoughtspot: 9.12.5.cl
6566
+ * @version SDK : 1.27.9 | ThoughtSpot Cloud: 9.12.5.cl
6443
6567
  */
6444
6568
  AddToWatchlist = "addToWatchlist",
6445
6569
  /**
6446
6570
  * The **Remove from watchlist** menu action on KPI watchlist.
6571
+ * Removes a KPI chart from the watchlist on the Home page.
6447
6572
  * @example
6448
6573
  * ```js
6449
6574
  * disabledActions: [Action.RemoveFromWatchlist]
6450
6575
  * ```
6451
- * @version SDK : 1.27.9 | Thoughtspot: 9.12.5.cl
6576
+ * @version SDK : 1.27.9 | ThoughtSpot: 9.12.5.cl
6452
6577
  */
6453
6578
  RemoveFromWatchlist = "removeFromWatchlist",
6454
6579
  /**
6455
- * The **Organise Favourites** action on Homepage Favourite Module.
6580
+ * The **Organize Favourites** action on Homepage
6581
+ * *Favorites* module.
6582
+ *
6456
6583
  * @example
6457
6584
  * ```js
6458
6585
  * disabledActions: [Action.OrganiseFavourites]
6459
6586
  * ```
6460
- * @version SDK : 1.32.0 | Thoughtspot: 10.0.0.cl
6587
+ * @version SDK : 1.32.0 | ThoughtSpot: 10.0.0.cl
6461
6588
  */
6462
6589
  OrganiseFavourites = "organiseFavourites",
6463
6590
  /**
6464
- * Action ID for AI Highlights button
6591
+ * The **AI Highlights** action on a Liveboard.
6592
+ *
6465
6593
  * @example
6466
6594
  * ```js
6467
6595
  * hiddenAction: [Action.AIHighlights]
6468
6596
  * ```
6469
- * @version SDK: 1.27.10 | Thoughtspot: 9.12.5.cl
6597
+ * @version SDK: 1.27.10 | ThoughtSpot Cloud: 9.12.5.cl
6470
6598
  */
6471
6599
  AIHighlights = "AIHighlights",
6472
6600
  /**
6473
- * Action ID for edit the schedule action on schedule on homepage
6601
+ * The *Edit* action on the *Liveboard Schedules* page
6602
+ * (new Homepage experience).
6603
+ * Allows editing Liveboard schedules.
6604
+ *
6474
6605
  * @example
6475
6606
  * ```js
6476
6607
  * disabledActions: [Action.EditScheduleHomepage]
6477
6608
  * ```
6478
- * @version SDK: 1.34.0 | Thoughtspot: 10.3.0.cl
6609
+ * @version SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
6479
6610
  */
6480
6611
  EditScheduleHomepage = "editScheduleHomepage",
6481
6612
  /**
6482
- * Action ID for pause schedule action on schedule on homepage
6613
+ * The *Pause* action on the *Liveboard Schedules* page
6614
+ * Pauses a scheduled Liveboard job.
6483
6615
  * @example
6484
6616
  * ```js
6485
6617
  * disabledActions: [Action.PauseScheduleHomepage]
6486
6618
  * ```
6487
- * @version SDK: 1.34.0 | Thoughtspot: 10.3.0.cl
6619
+ * @version SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
6488
6620
  */
6489
6621
  PauseScheduleHomepage = "pauseScheduleHomepage",
6490
6622
  /**
6491
- * Action ID for view schedule run action on schedule on homepage
6623
+ * The **View run history** action **Liveboard Schedules** page.
6624
+ * Allows viewing schedule run history.
6492
6625
  * @example
6493
6626
  * ```js
6494
6627
  * disabledActions: [Action.ViewScheduleRunHomepage]
6495
6628
  * ```
6496
- * @version SDK: 1.34.0 | Thoughtspot: 10.3.0.cl
6629
+ * @version SDK: 1.34.0 | ThoughtSpot: 10.3.0.cl
6497
6630
  */
6498
6631
  ViewScheduleRunHomepage = "viewScheduleRunHomepage",
6499
6632
  /**
6500
- * Action ID for unsubscribe schedule action on schedule on homepage
6633
+ * Action ID to hide or disable the
6634
+ * unsubscribe option for Liveboard schedules.
6501
6635
  * @example
6502
6636
  * ```js
6503
6637
  * disabledActions: [Action.UnsubscribeScheduleHomepage]
6504
6638
  * ```
6505
- * @version SDK: 1.34.0 | Thoughtspot: 10.3.0.cl
6639
+ * @version SDK: 1.34.0 | ThoughtSpot: 10.3.0.cl
6506
6640
  */
6507
6641
  UnsubscribeScheduleHomepage = "unsubscribeScheduleHomepage",
6508
6642
  /**
@@ -6511,16 +6645,17 @@ export declare enum Action {
6511
6645
  * ```js
6512
6646
  * disabledActions: [Action.ManageTags]
6513
6647
  * ```
6514
- * @version SDK : 1.34.0 | Thoughtspot: 10.3.0.cl
6648
+ * @version SDK : 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
6515
6649
  */
6516
6650
  ManageTags = "manageTags",
6517
6651
  /**
6518
- * Action ID for delete schedule action on schedule on homepage
6652
+ * The **Delete** action on the **Liveboard Schedules* page.
6653
+ * Deletes a Liveboard schedule.
6519
6654
  * @example
6520
6655
  * ```js
6521
6656
  * disabledActions: [Action.DeleteScheduleHomepage]
6522
6657
  * ```
6523
- * @version SDK: 1.34.0 | Thoughtspot: 10.3.0.cl
6658
+ * @version SDK: 1.34.0 | ThoughtSpot: 10.3.0.cl
6524
6659
  */
6525
6660
  DeleteScheduleHomepage = "deleteScheduleHomepage",
6526
6661
  /**
@@ -6529,7 +6664,7 @@ export declare enum Action {
6529
6664
  * ```js
6530
6665
  * disabledActions: [Action.KPIAnalysisCTA]
6531
6666
  * ```
6532
- * @version SDK: 1.34.0 | Thoughtspot: 10.3.0.cl
6667
+ * @version SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
6533
6668
  */
6534
6669
  KPIAnalysisCTA = "kpiAnalysisCTA",
6535
6670
  /**
@@ -6538,61 +6673,73 @@ export declare enum Action {
6538
6673
  * ```js
6539
6674
  * const disabledActions = [Action.DisableChipReorder]
6540
6675
  * ```
6541
- * @version SDK: 1.36.0 | Thoughtspot: 10.6.0.cl
6676
+ * @version SDK: 1.36.0 | ThoughtSpot Cloud: 10.6.0.cl
6542
6677
  */
6543
6678
  DisableChipReorder = "disableChipReorder",
6544
6679
  /**
6545
- * Action ID for Hide Irrelevant filters button
6680
+ * Action ID to show, hide, or disable filters
6681
+ * in a Liveboard tab.
6682
+ *
6546
6683
  * @example
6547
6684
  * ```js
6548
6685
  * hiddenAction: [Action.ChangeFilterVisibilityInTab]
6549
6686
  * ```
6550
- * @version SDK: 1.36.0 | Thoughtspot: 10.6.0.cl
6687
+ * @version SDK: 1.36.0 | ThoughtSpot Cloud: 10.6.0.cl
6551
6688
  */
6552
6689
  ChangeFilterVisibilityInTab = "changeFilterVisibilityInTab",
6553
6690
  /**
6554
- * Action ID for hide/disable Preview data button in spotter
6691
+ * The **Preview data** button on the Spotter interface.
6692
+ * Allows previewing the data used for Spotter queries.
6693
+ *
6555
6694
  * @example
6556
6695
  * ```js
6557
6696
  * hiddenAction: [Action.PreviewDataSpotter]
6558
6697
  * ```
6559
- * @version SDK: 1.36.0 | Thoughtspot: 10.6.0.cl
6698
+ * @version SDK: 1.36.0 | ThoughtSpot Cloud: 10.6.0.cl
6560
6699
  */
6561
6700
  PreviewDataSpotter = "previewDataSpotter",
6562
6701
  /**
6563
- * Action ID for hide/disable reset button in spotter
6702
+ * The **Reset** link on the Spotter interface.
6703
+ * Resets the conversation with Spotter.
6704
+ *
6564
6705
  * @example
6565
6706
  * ```js
6566
6707
  * hiddenAction: [Action.ResetSpotterChat]
6567
6708
  * ```
6568
- * @version SDK: 1.36.0 | Thoughtspot: 10.6.0.cl
6709
+ * @version SDK: 1.36.0 | ThoughtSpot Cloud: 10.6.0.cl
6569
6710
  */
6570
6711
  ResetSpotterChat = "resetSpotterChat",
6571
6712
  /**
6572
- * Action ID for hide/disable feedback in spotter
6713
+ * Action ID for hide or disable the
6714
+ * Spotter feedback widget.
6715
+ *
6573
6716
  * @example
6574
6717
  * ```js
6575
6718
  * hiddenAction: [Action.SpotterFeedback]
6576
6719
  * ```
6577
- * @version SDK: 1.36.0 | Thoughtspot: 10.6.0.cl
6720
+ * @version SDK: 1.36.0 | ThoughtSpot Cloud: 10.6.0.cl
6578
6721
  */
6579
6722
  SpotterFeedback = "spotterFeedback",
6580
6723
  /**
6581
- * Action ID for hide/disable editing previous prompt in spotter
6724
+ * Action ID for hide or disable
6725
+ * the previous prompt edit option in Spotter.
6726
+ *
6582
6727
  * @example
6583
6728
  * ```js
6584
6729
  * hiddenAction: [Action.EditPreviousPrompt]
6585
6730
  * ```
6586
- * @version SDK: 1.36.0 | Thoughtspot: 10.6.0.cl
6731
+ * @version SDK: 1.36.0 | ThoughtSpot Cloud: 10.6.0.cl
6587
6732
  */
6588
6733
  EditPreviousPrompt = "editPreviousPrompt",
6589
6734
  /**
6590
- * Action ID for hide/disable deleting previous prompt in spotter
6735
+ * Action ID for hide or disable
6736
+ * the previous prompt deletion option in Spotter.
6737
+ *
6591
6738
  * @example
6592
6739
  * ```js
6593
6740
  * hiddenAction: [Action.DeletePreviousPrompt]
6594
6741
  * ```
6595
- * @version SDK: 1.36.0 | Thoughtspot: 10.6.0.cl
6742
+ * @version SDK: 1.36.0 | ThoughtSpot Cloud: 10.6.0.cl
6596
6743
  */
6597
6744
  DeletePreviousPrompt = "deletePreviousPrompt",
6598
6745
  /**
@@ -6601,7 +6748,7 @@ export declare enum Action {
6601
6748
  * ```js
6602
6749
  * hiddenAction: [Action.EditTokens]
6603
6750
  * ```
6604
- * @version SDK: 1.36.0 | Thoughtspot: 10.6.0.cl
6751
+ * @version SDK: 1.36.0 | ThoughtSpot Cloud: 10.6.0.cl
6605
6752
  */
6606
6753
  EditTokens = "editTokens"
6607
6754
  }
@@ -6616,10 +6763,12 @@ export declare enum PrefetchFeatures {
6616
6763
  }
6617
6764
  /**
6618
6765
  * Enum for options to change context trigger
6766
+ * BOTH_CLICKS option is introduced in 10.7
6619
6767
  */
6620
6768
  export declare enum ContextMenuTriggerOptions {
6621
6769
  LEFT_CLICK = "left-click",
6622
- RIGHT_CLICK = "right-click"
6770
+ RIGHT_CLICK = "right-click",
6771
+ BOTH_CLICKS = "both-clicks"
6623
6772
  }
6624
6773
  export interface ColumnValue {
6625
6774
  column: {
@@ -6672,7 +6821,7 @@ export declare enum LogLevel {
6672
6821
  * logLevel: LogLevel.SILENT,
6673
6822
  * })
6674
6823
  * ```
6675
- * @version SDK: 1.26.7 | Thoughtspot: 9.10.0.cl
6824
+ * @version SDK: 1.26.7 | ThoughtSpot Cloud: 9.10.0.cl
6676
6825
  */
6677
6826
  SILENT = "SILENT",
6678
6827
  /**
@@ -6684,7 +6833,7 @@ export declare enum LogLevel {
6684
6833
  * logLevel: LogLevel.ERROR,
6685
6834
  * })
6686
6835
  * ```
6687
- * @version SDK: 1.26.7 | Thoughtspot: 9.10.0.cl
6836
+ * @version SDK: 1.26.7 | ThoughtSpot Cloud: 9.10.0.cl
6688
6837
  */
6689
6838
  ERROR = "ERROR",
6690
6839
  /**
@@ -6696,7 +6845,7 @@ export declare enum LogLevel {
6696
6845
  * logLevel: LogLevel.WARN,
6697
6846
  * })
6698
6847
  * ```
6699
- * @version SDK: 1.26.7 | Thoughtspot: 9.10.0.cl
6848
+ * @version SDK: 1.26.7 | ThoughtSpot Cloud: 9.10.0.cl
6700
6849
  */
6701
6850
  WARN = "WARN",
6702
6851
  /**
@@ -6708,7 +6857,7 @@ export declare enum LogLevel {
6708
6857
  * logLevel: LogLevel.INFO,
6709
6858
  * })
6710
6859
  * ```
6711
- * @version SDK: 1.26.7 | Thoughtspot: 9.10.0.cl
6860
+ * @version SDK: 1.26.7 | ThoughtSpot Cloud: 9.10.0.cl
6712
6861
  */
6713
6862
  INFO = "INFO",
6714
6863
  /**
@@ -6720,7 +6869,7 @@ export declare enum LogLevel {
6720
6869
  * logLevel: LogLevel.DEBUG,
6721
6870
  * })
6722
6871
  * ```
6723
- * @version SDK: 1.26.7 | Thoughtspot: 9.10.0.cl
6872
+ * @version SDK: 1.26.7 | ThoughtSpot Cloud: 9.10.0.cl
6724
6873
  */
6725
6874
  DEBUG = "DEBUG",
6726
6875
  /**
@@ -6732,7 +6881,7 @@ export declare enum LogLevel {
6732
6881
  * logLevel: LogLevel.TRACE,
6733
6882
  * })
6734
6883
  * ```
6735
- * @version SDK: 1.26.7 | Thoughtspot: 9.10.0.cl
6884
+ * @version SDK: 1.26.7 | ThoughtSpot Cloud: 9.10.0.cl
6736
6885
  */
6737
6886
  TRACE = "TRACE"
6738
6887
  }
@@ -7408,7 +7557,7 @@ export declare enum UIPassthroughEvent {
7408
7557
  PinAnswerToLiveboard = "addVizToPinboard",
7409
7558
  SaveAnswer = "saveAnswer",
7410
7559
  GetDiscoverabilityStatus = "getDiscoverabilityStatus",
7411
- GetAvailableUIPassthroughs = "getAvailableUIPassthroughs",
7560
+ GetAvailableUIPassthroughs = "getAvailableUiPassthroughs",
7412
7561
  GetAnswerConfig = "getAnswerPageConfig",
7413
7562
  GetLiveboardConfig = "getPinboardPageConfig"
7414
7563
  }