@thoughtspot/visual-embed-sdk 1.23.0 → 1.24.0-alpha.0

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 (55) hide show
  1. package/README.md +1 -1
  2. package/cjs/package.json +1 -8
  3. package/cjs/src/embed/sage.d.ts +14 -0
  4. package/cjs/src/embed/sage.d.ts.map +1 -1
  5. package/cjs/src/embed/sage.js +12 -3
  6. package/cjs/src/embed/sage.js.map +1 -1
  7. package/cjs/src/embed/sage.spec.js +1 -1
  8. package/cjs/src/embed/sage.spec.js.map +1 -1
  9. package/cjs/src/embed/search.d.ts +0 -4
  10. package/cjs/src/embed/search.d.ts.map +1 -1
  11. package/cjs/src/embed/search.js +1 -1
  12. package/cjs/src/embed/search.js.map +1 -1
  13. package/cjs/src/react/index.spec.js +0 -12
  14. package/cjs/src/react/index.spec.js.map +1 -1
  15. package/cjs/src/types.d.ts +340 -239
  16. package/cjs/src/types.d.ts.map +1 -1
  17. package/cjs/src/types.js +337 -236
  18. package/cjs/src/types.js.map +1 -1
  19. package/dist/src/embed/sage.d.ts +14 -0
  20. package/dist/src/embed/sage.d.ts.map +1 -1
  21. package/dist/src/embed/search.d.ts +0 -4
  22. package/dist/src/embed/search.d.ts.map +1 -1
  23. package/dist/src/types.d.ts +340 -239
  24. package/dist/src/types.d.ts.map +1 -1
  25. package/dist/tsembed-react.es.js +351 -241
  26. package/dist/tsembed-react.js +350 -240
  27. package/dist/tsembed.es.js +351 -241
  28. package/dist/tsembed.js +350 -240
  29. package/dist/visual-embed-sdk-react-full.d.ts +354 -243
  30. package/dist/visual-embed-sdk-react.d.ts +354 -243
  31. package/dist/visual-embed-sdk.d.ts +354 -243
  32. package/lib/package.json +1 -8
  33. package/lib/src/embed/sage.d.ts +14 -0
  34. package/lib/src/embed/sage.d.ts.map +1 -1
  35. package/lib/src/embed/sage.js +12 -3
  36. package/lib/src/embed/sage.js.map +1 -1
  37. package/lib/src/embed/sage.spec.js +1 -1
  38. package/lib/src/embed/sage.spec.js.map +1 -1
  39. package/lib/src/embed/search.d.ts +0 -4
  40. package/lib/src/embed/search.d.ts.map +1 -1
  41. package/lib/src/embed/search.js +1 -1
  42. package/lib/src/embed/search.js.map +1 -1
  43. package/lib/src/react/index.spec.js +0 -12
  44. package/lib/src/react/index.spec.js.map +1 -1
  45. package/lib/src/types.d.ts +340 -239
  46. package/lib/src/types.d.ts.map +1 -1
  47. package/lib/src/types.js +337 -236
  48. package/lib/src/types.js.map +1 -1
  49. package/lib/src/visual-embed-sdk.d.ts +354 -243
  50. package/package.json +1 -8
  51. package/src/embed/sage.spec.ts +1 -1
  52. package/src/embed/sage.ts +24 -2
  53. package/src/embed/search.ts +0 -5
  54. package/src/react/index.spec.tsx +0 -29
  55. package/src/types.ts +338 -238
@@ -172,6 +172,7 @@ export declare class SearchBarEmbed extends TsEmbed {
172
172
  * The configuration attributes for the embedded Natural language search view. Based on
173
173
  * GPT and LLM.
174
174
  *
175
+ * @version: SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl, 9.5.1-sw
175
176
  * @group Embed components
176
177
  */
177
178
  export interface SageViewConfig extends ViewConfig {
@@ -192,6 +193,19 @@ export interface SageViewConfig extends ViewConfig {
192
193
  *
193
194
  */
194
195
  showObjectSuggestions?: boolean;
196
+ /**
197
+ * The query string to pre-fill in natual language search bar
198
+ */
199
+ searchQuery?: string;
200
+ /**
201
+ * If set to true, sample questions would be hidden to user.
202
+ * These sample questions are autogenerated based on selected datasource.
203
+ */
204
+ hideSampleQuestions?: boolean;
205
+ /**
206
+ * The data source GUID to set on load.
207
+ */
208
+ dataSource?: string;
195
209
  }
196
210
  export declare const HiddenActionItemByDefaultForSageEmbed: Action[];
197
211
  /**
@@ -267,10 +281,6 @@ export interface SearchViewConfig extends ViewConfig {
267
281
  * using raw answer data.
268
282
  */
269
283
  hideResults?: boolean;
270
- /**
271
- * If set to true, expands all the data sources panel.
272
- */
273
- expandAllDataSource?: boolean;
274
284
  /**
275
285
  * If set to true, the Search Assist feature is enabled.
276
286
  *
@@ -2423,7 +2433,19 @@ export declare enum EmbedEvent {
2423
2433
  *
2424
2434
  * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
2425
2435
  */
2426
- FilterChanged = "filterChanged"
2436
+ FilterChanged = "filterChanged",
2437
+ /**
2438
+ * Emitted when a user click on Go button in Sage Embed
2439
+ *
2440
+ * @version SDK : 1.27.0 | Thoughtspot: 9.7.0.cl
2441
+ */
2442
+ SageEmbedQuery = "sageEmbedQuery",
2443
+ /**
2444
+ * Emitten when a user select data source in Sage Embed
2445
+ *
2446
+ * @version SDK : 1.27.0 | Thoughtspot: 9.7.0.cl
2447
+ */
2448
+ SageWorksheetUpdated = "sageWorksheetUpdated"
2427
2449
  }
2428
2450
  /**
2429
2451
  * Event types that can be triggered by the host application
@@ -2452,6 +2474,7 @@ export declare enum HostEvent {
2452
2474
  * Triggers a search query in AppEmbed and SearchEmbed
2453
2475
  * deployments.
2454
2476
  * Includes the following properties:
2477
+ *
2455
2478
  * @param - dataSourceIds - The data source GUID to Search on
2456
2479
  * - Although an array, only a single source
2457
2480
  * is supported.
@@ -2470,6 +2493,7 @@ export declare enum HostEvent {
2470
2493
  /**
2471
2494
  * Triggers a drill on certain points of the specified column
2472
2495
  * Includes the following properties:
2496
+ *
2473
2497
  * @param - points - an object containing selectedPoints/clickedPoints
2474
2498
  * to drill to. For example, { selectedPoints: []}
2475
2499
  * @param - columnGuid - Optional. GUID of the column to drill
@@ -2534,18 +2558,19 @@ export declare enum HostEvent {
2534
2558
  */
2535
2559
  SetActiveTab = "SetActiveTab",
2536
2560
  /**
2537
- * Updates runtime filters applied on a Saved Answer or Liveboard. The
2538
- * runtime filters passed here are appended to the existing runtime
2539
- * filters.
2540
- * Pass an array of runtime filters with the following attributes:
2541
- * `columnName`
2542
- * _String_. The name of the column to filter on.
2543
- * `operator`
2544
- * Runtime filter operator to apply. For information,
2545
- * see [Runtime filter operators](https://developers.thoughtspot.com/docs/?pageid=runtime-filters#rtOperator).
2546
- * `values`
2547
- * List of operands. Some operators such as EQ, LE allow a single value, whereas operators
2548
- * such as BW and IN accept multiple operands.
2561
+ * Updates runtime filters applied on a Saved Answer or Liveboard. The
2562
+ * runtime filters passed here are appended to the existing runtime
2563
+ * filters.
2564
+ * Pass an array of runtime filters with the following attributes:
2565
+ * `columnName`
2566
+ * _String_. The name of the column to filter on.
2567
+ * `operator`
2568
+ * Runtime filter operator to apply. For information,
2569
+ * see [Runtime filter operators](https://developers.thoughtspot.com/docs/?pageid=runtime-filters#rtOperator).
2570
+ * `values`
2571
+ * List of operands. Some operators such as EQ, LE allow a single value, whereas
2572
+ * operators such as BW and IN accept multiple operands.
2573
+ *
2549
2574
  * @param - {@link RuntimeFilter}[] an array of {@link RuntimeFilter} Types.
2550
2575
  * @example
2551
2576
  * ```js
@@ -2561,6 +2586,7 @@ export declare enum HostEvent {
2561
2586
  /**
2562
2587
  * Navigate to a specific page in the embedded application without reloading the page.
2563
2588
  * This is the same as calling `appEmbed.navigateToPage(path, true)`
2589
+ *
2564
2590
  * @param - path - the path to navigate to (can be a number[1/-1] to go forward/back)
2565
2591
  * @example
2566
2592
  * ```js
@@ -2884,6 +2910,7 @@ export declare enum HostEvent {
2884
2910
  /**
2885
2911
  * Triggers the **SpotIQ analyze** action on visualization
2886
2912
  * or search.
2913
+ *
2887
2914
  * @param - Liveboard embed takes `vizId` as a
2888
2915
  * key. Can be left undefined when embedding Search or
2889
2916
  * visualization.
@@ -2923,6 +2950,7 @@ export declare enum HostEvent {
2923
2950
  /**
2924
2951
  * Triggers the **Download** > **PNG** action on
2925
2952
  * charts in the embedded view.
2953
+ *
2926
2954
  * @example
2927
2955
  * ```js
2928
2956
  * liveboardEmbed.trigger(HostEvent.DownloadAsPng,
@@ -2956,6 +2984,7 @@ export declare enum HostEvent {
2956
2984
  /**
2957
2985
  * Triggers the **Download** > **XLSX** action on tables
2958
2986
  * in the embedded view.
2987
+ *
2959
2988
  * @example
2960
2989
  * ```js
2961
2990
  * liveboardEmbed.trigger(HostEvent.DownloadAsXlsx, {vizId:
@@ -2987,6 +3016,7 @@ export declare enum HostEvent {
2987
3016
  /**
2988
3017
  * Triggers the **Save** action on a Liveboard or Answer.
2989
3018
  * Saves the changes.
3019
+ *
2990
3020
  * @example
2991
3021
  * ```js
2992
3022
  * liveboardEmbed.trigger(HostEvent.Save)
@@ -3000,6 +3030,7 @@ export declare enum HostEvent {
3000
3030
  /**
3001
3031
  * Triggers the **Sync to Sheets** action on an embedded visualization or Answer
3002
3032
  * Sends data from an Answer or Liveboard visualization to a Google sheet.
3033
+ *
3003
3034
  * @param - an object with `vizId` as a key
3004
3035
  * @example
3005
3036
  * ```js
@@ -3016,6 +3047,7 @@ export declare enum HostEvent {
3016
3047
  * Triggers the **Sync to Other Apps** action on an embedded visualization or Answer
3017
3048
  * Sends data from an Answer or Liveboard visualization to third-party apps such
3018
3049
  * as Slack, Salesforce, Microsoft Teams, ServiceNow and so on.
3050
+ *
3019
3051
  * @param - an object with vizId as a key
3020
3052
  * @example
3021
3053
  * ```js
@@ -3032,6 +3064,7 @@ export declare enum HostEvent {
3032
3064
  * Triggers the **Manage pipelines** action on an embedded
3033
3065
  * visualization or Answer.
3034
3066
  * Allows users to manage ThoughtSpot Sync pipelines.
3067
+ *
3035
3068
  * @param - an object with `vizId` as a key
3036
3069
  * @example
3037
3070
  * ```js
@@ -3184,7 +3217,10 @@ export declare enum Param {
3184
3217
  ShowLiveboardTitle = "showLiveboardTitle",
3185
3218
  HiddenTabs = "hideTabs",
3186
3219
  VisibleTabs = "visibleTabs",
3187
- HideTabPanel = "hideTabPanel"
3220
+ HideTabPanel = "hideTabPanel",
3221
+ HideSampleQuestions = "hideSampleQuestions",
3222
+ WorksheetId = "worksheetId",
3223
+ Query = "query,"
3188
3224
  }
3189
3225
  /**
3190
3226
  * ThoughtSpot application pages include actions and menu commands
@@ -3193,6 +3229,7 @@ export declare enum Param {
3193
3229
  * specific actions in the embedded view, define the Action
3194
3230
  * enumeration members in the `disabledActions`, `visibleActions`,
3195
3231
  * or `hiddenActions` array.
3232
+ *
3196
3233
  * @example
3197
3234
  * ```js
3198
3235
  * const embed = new LiveboardEmbed('#embed-container', {
@@ -3211,12 +3248,12 @@ export declare enum Param {
3211
3248
  * hiddenActions: [Action.Edit, ActionAction.Explore],
3212
3249
  * })
3213
3250
  * ```
3214
-
3215
3251
  */
3216
3252
  export declare enum Action {
3217
3253
  /**
3218
3254
  * The **Save** action on an Answer or Liveboard.
3219
3255
  * Allows users to save the changes.
3256
+ *
3220
3257
  * @example
3221
3258
  * ```js
3222
3259
  * disabledActions: [Action.SaveAsView]
@@ -3232,136 +3269,146 @@ export declare enum Action {
3232
3269
  */
3233
3270
  SaveUntitled = "saveUntitled",
3234
3271
  /**
3235
- * The **Save as View** action on the Answer
3236
- * page. Saves an Answer as a View object.
3237
- *
3238
- * @example
3239
- * ```js
3240
- * disabledActions: [Action.SaveAsView]
3241
- * ```
3242
- */
3272
+ * The **Save as View** action on the Answer
3273
+ * page. Saves an Answer as a View object.
3274
+ *
3275
+ * @example
3276
+ * ```js
3277
+ * disabledActions: [Action.SaveAsView]
3278
+ * ```
3279
+ */
3243
3280
  SaveAsView = "saveAsView",
3244
3281
  /**
3245
- * The **Make a copy** action on a Liveboard or Answer
3246
- * page.
3247
- * Creates a copy of the Liveboard, visualization,
3248
- * or Answer.
3249
- *
3250
- * @example
3251
- * ```js
3252
- * disabledActions: [Action.MakeACopy]
3253
- * ```
3254
- */
3282
+ * The **Make a copy** action on a Liveboard or Answer
3283
+ * page.
3284
+ * Creates a copy of the Liveboard, visualization,
3285
+ * or Answer.
3286
+ *
3287
+ * @example
3288
+ * ```js
3289
+ * disabledActions: [Action.MakeACopy]
3290
+ * ```
3291
+ */
3255
3292
  MakeACopy = "makeACopy",
3256
3293
  /**
3257
- * The **Copy and Edit** action on a Liveboard.
3258
- * This action is now replaced with `Action.MakeACopy`.
3259
- *
3260
- * @example
3261
- * ```js
3262
- * disabledActions: [Action.EditACopy]
3263
- * ```
3264
- */
3294
+ * The **Copy and Edit** action on a Liveboard.
3295
+ * This action is now replaced with `Action.MakeACopy`.
3296
+ *
3297
+ * @example
3298
+ * ```js
3299
+ * disabledActions: [Action.EditACopy]
3300
+ * ```
3301
+ */
3265
3302
  EditACopy = "editACopy",
3266
3303
  /**
3267
- * The **Copy link** menu action on a Liveboard visualization.
3268
- * Copies the visualization URL
3269
- * @example
3270
- * ```js
3271
- * disabledActions: [Action.CopyLink]
3272
- * ```
3273
- */
3304
+ * The **Copy link** menu action on a Liveboard visualization.
3305
+ * Copies the visualization URL
3306
+ *
3307
+ * @example
3308
+ * ```js
3309
+ * disabledActions: [Action.CopyLink]
3310
+ * ```
3311
+ */
3274
3312
  CopyLink = "embedDocument",
3275
3313
  /**
3276
3314
  * @hidden
3277
3315
  */
3278
3316
  ResetLayout = "resetLayout",
3279
3317
  /**
3280
- * The **Schedule** menu action on a Liveboard.
3281
- * Allows scheduling a Liveboard notification.
3282
- * @example
3283
- * ```js
3284
- * disabledActions: [Action.Schedule]
3285
- * ```
3286
- */
3318
+ * The **Schedule** menu action on a Liveboard.
3319
+ * Allows scheduling a Liveboard notification.
3320
+ *
3321
+ * @example
3322
+ * ```js
3323
+ * disabledActions: [Action.Schedule]
3324
+ * ```
3325
+ */
3287
3326
  Schedule = "subscription",
3288
3327
  /**
3289
- * The **Manage schedules** menu action on a Liveboard.
3290
- * Allows users to manage scheduled Liveboard jobs.
3291
- * @example
3292
- * ```js
3293
- * disabledActions: [Action.SchedulesList]
3294
- * ```
3295
- */
3328
+ * The **Manage schedules** menu action on a Liveboard.
3329
+ * Allows users to manage scheduled Liveboard jobs.
3330
+ *
3331
+ * @example
3332
+ * ```js
3333
+ * disabledActions: [Action.SchedulesList]
3334
+ * ```
3335
+ */
3296
3336
  SchedulesList = "schedule-list",
3297
3337
  /**
3298
- * The **Share** action on a Liveboard, Answer, or Worksheet.
3299
- * Allows users to share an object with other users and groups.
3300
- * @example
3301
- * ```js
3302
- * disabledActions: [Action.Share]
3303
- * ```
3304
- */
3338
+ * The **Share** action on a Liveboard, Answer, or Worksheet.
3339
+ * Allows users to share an object with other users and groups.
3340
+ *
3341
+ * @example
3342
+ * ```js
3343
+ * disabledActions: [Action.Share]
3344
+ * ```
3345
+ */
3305
3346
  Share = "share",
3306
3347
  /**
3307
- * The **Add filter** action on a Liveboard and Search page.
3308
- * Allows adding filters to Answers and visualizations on a Liveboard.
3309
- * @example
3310
- * ```js
3311
- * disabledActions: [Action.AddFilter]
3312
- * ```
3313
- */
3348
+ * The **Add filter** action on a Liveboard and Search page.
3349
+ * Allows adding filters to Answers and visualizations on a Liveboard.
3350
+ *
3351
+ * @example
3352
+ * ```js
3353
+ * disabledActions: [Action.AddFilter]
3354
+ * ```
3355
+ */
3314
3356
  AddFilter = "addFilter",
3315
3357
  /**
3316
- * Filter configuration options on a Liveboard and Search page.
3317
- * Allows configuring filter options when adding filters to a
3318
- * Liveboard or Answer.
3319
- * @example
3320
- * ```js
3321
- * disabledActions: [Action.ConfigureFilter]
3322
- * ```
3323
- */
3358
+ * Filter configuration options on a Liveboard and Search page.
3359
+ * Allows configuring filter options when adding filters to a
3360
+ * Liveboard or Answer.
3361
+ *
3362
+ * @example
3363
+ * ```js
3364
+ * disabledActions: [Action.ConfigureFilter]
3365
+ * ```
3366
+ */
3324
3367
  ConfigureFilter = "configureFilter",
3325
3368
  CollapseDataSources = "collapseDataSources",
3326
3369
  /**
3327
- * The **Choose sources** button on Search page.
3328
- * Allows selecting data sources for search queries.
3329
- * @example
3330
- * ```js
3331
- * disabledActions: [Action.ChooseDataSources]
3332
- * ```
3333
- */
3370
+ * The **Choose sources** button on Search page.
3371
+ * Allows selecting data sources for search queries.
3372
+ *
3373
+ * @example
3374
+ * ```js
3375
+ * disabledActions: [Action.ChooseDataSources]
3376
+ * ```
3377
+ */
3334
3378
  ChooseDataSources = "chooseDataSources",
3335
3379
  /**
3336
- * The **Create formula** action on a Search or Answer page.
3337
- * Allows adding formulas to an Answer.
3338
- * @example
3339
- * ```js
3340
- * disabledActions: [Action.AddFormula]
3341
- * ```
3342
- */
3380
+ * The **Create formula** action on a Search or Answer page.
3381
+ * Allows adding formulas to an Answer.
3382
+ *
3383
+ * @example
3384
+ * ```js
3385
+ * disabledActions: [Action.AddFormula]
3386
+ * ```
3387
+ */
3343
3388
  AddFormula = "addFormula",
3344
3389
  /**
3345
- * The **Add parameter** action on a Liveboard or Answer.
3346
- * Allows adding Parameters to a Liveboard or Answer.
3347
- * @example
3348
- * ```js
3349
- * disabledActions: [Action.AddParameter]
3350
- * ```
3351
- */
3390
+ * The **Add parameter** action on a Liveboard or Answer.
3391
+ * Allows adding Parameters to a Liveboard or Answer.
3392
+ *
3393
+ * @example
3394
+ * ```js
3395
+ * disabledActions: [Action.AddParameter]
3396
+ * ```
3397
+ */
3352
3398
  AddParameter = "addParameter",
3353
3399
  /**
3354
3400
  * @hidden
3355
3401
  */
3356
3402
  SearchOnTop = "searchOnTop",
3357
3403
  /**
3358
- * The **SpotIQ analyze** menu action on a visualization or
3359
- * Answer page.
3360
- * @example
3361
- * ```js
3362
- * disabledActions: [Action.SpotIQAnalyze]
3363
- * ```
3364
- */
3404
+ * The **SpotIQ analyze** menu action on a visualization or
3405
+ * Answer page.
3406
+ *
3407
+ * @example
3408
+ * ```js
3409
+ * disabledActions: [Action.SpotIQAnalyze]
3410
+ * ```
3411
+ */
3365
3412
  SpotIQAnalyze = "spotIQAnalyze",
3366
3413
  /**
3367
3414
  * @hidden
@@ -3377,89 +3424,98 @@ export declare enum Action {
3377
3424
  */
3378
3425
  ReplaySearch = "replaySearch",
3379
3426
  /**
3380
- * The **Show underlying data** menu action on a visualization or
3381
- * Answer page.
3382
- * @example
3383
- * ```js
3384
- * disabledActions: [Action.ShowUnderlyingData]
3385
- * ```
3386
- */
3427
+ * The **Show underlying data** menu action on a visualization or
3428
+ * Answer page.
3429
+ *
3430
+ * @example
3431
+ * ```js
3432
+ * disabledActions: [Action.ShowUnderlyingData]
3433
+ * ```
3434
+ */
3387
3435
  ShowUnderlyingData = "showUnderlyingData",
3388
3436
  /**
3389
- * The **Download** menu action on Liveboard visualizations
3390
- * and Answers.
3391
- * Allows downloading a visualization or Answer.
3392
- * @example
3393
- * ```js
3394
- * disabledActions: [Action.DownloadAsPng]
3395
- * ```
3396
- */
3437
+ * The **Download** menu action on Liveboard visualizations
3438
+ * and Answers.
3439
+ * Allows downloading a visualization or Answer.
3440
+ *
3441
+ * @example
3442
+ * ```js
3443
+ * disabledActions: [Action.DownloadAsPng]
3444
+ * ```
3445
+ */
3397
3446
  Download = "download",
3398
3447
  /**
3399
- * The **Download** > **PNG** menu action for charts on a Liveboard
3400
- * or Answer page.
3401
- * Downloads a visualization or Answer as a PNG file.
3402
- * @example
3403
- * ```js
3404
- * disabledActions: [Action.DownloadAsPng]
3405
- * ```
3406
- */
3448
+ * The **Download** > **PNG** menu action for charts on a Liveboard
3449
+ * or Answer page.
3450
+ * Downloads a visualization or Answer as a PNG file.
3451
+ *
3452
+ * @example
3453
+ * ```js
3454
+ * disabledActions: [Action.DownloadAsPng]
3455
+ * ```
3456
+ */
3407
3457
  DownloadAsPng = "downloadAsPng",
3408
3458
  /**
3409
- * The **Download** > **PDF** menu action on a Liveboard.
3410
- * Downloads a visualization or Answer as a PDF file.
3411
- * @example
3412
- * ```js
3413
- * disabledActions: [Action.DownloadAsPdf]
3414
- * ```
3415
- */
3459
+ * The **Download** > **PDF** menu action on a Liveboard.
3460
+ * Downloads a visualization or Answer as a PDF file.
3461
+ *
3462
+ * @example
3463
+ * ```js
3464
+ * disabledActions: [Action.DownloadAsPdf]
3465
+ * ```
3466
+ */
3416
3467
  DownloadAsPdf = "downloadAsPdf",
3417
3468
  /**
3418
- * The **Download** > **CSV** menu action for tables on a Liveboard
3419
- * or Answer page.
3420
- * Downloads a visualization or Answer in the XLSX format.
3421
- * @example
3422
- * ```js
3423
- * disabledActions: [Action.DownloadAsCsv]
3424
- * ```
3425
- */
3469
+ * The **Download** > **CSV** menu action for tables on a Liveboard
3470
+ * or Answer page.
3471
+ * Downloads a visualization or Answer in the XLSX format.
3472
+ *
3473
+ * @example
3474
+ * ```js
3475
+ * disabledActions: [Action.DownloadAsCsv]
3476
+ * ```
3477
+ */
3426
3478
  DownloadAsCsv = "downloadAsCSV",
3427
3479
  /**
3428
- * The **Download** > **XLSX** menu action for tables on a Liveboard
3429
- * or Answer page.
3430
- * Downloads a visualization or Answer in the XLSX format.
3431
- * @example
3432
- * ```js
3433
- * disabledActions: [Action.DownloadAsXlsx]
3434
- * ```
3435
- */
3480
+ * The **Download** > **XLSX** menu action for tables on a Liveboard
3481
+ * or Answer page.
3482
+ * Downloads a visualization or Answer in the XLSX format.
3483
+ *
3484
+ * @example
3485
+ * ```js
3486
+ * disabledActions: [Action.DownloadAsXlsx]
3487
+ * ```
3488
+ */
3436
3489
  DownloadAsXlsx = "downloadAsXLSX",
3437
3490
  /**
3438
3491
  * @hidden
3439
3492
  */
3440
3493
  DownloadTrace = "downloadTrace",
3441
3494
  /**
3442
- * The **Export TML** menu action on Liveboard, Answers
3443
- * Worksheets and Data Connections page.
3444
- * Exports an object as a TML file.
3445
- * @example
3446
- * ```js
3447
- * disabledActions: [Action.ExportTML]
3448
- * ```
3449
- */
3495
+ * The **Export TML** menu action on Liveboard, Answers
3496
+ * Worksheets and Data Connections page.
3497
+ * Exports an object as a TML file.
3498
+ *
3499
+ * @example
3500
+ * ```js
3501
+ * disabledActions: [Action.ExportTML]
3502
+ * ```
3503
+ */
3450
3504
  ExportTML = "exportTSL",
3451
3505
  /**
3452
- * The **Import TML** menu action for Liveboards and Answers.
3453
- * Imports TML representation of ThoughtSpot objects.
3454
- * @example
3455
- * ```js
3456
- * disabledActions: [Action.ImportTML]
3457
- * ```
3458
- */
3506
+ * The **Import TML** menu action for Liveboards and Answers.
3507
+ * Imports TML representation of ThoughtSpot objects.
3508
+ *
3509
+ * @example
3510
+ * ```js
3511
+ * disabledActions: [Action.ImportTML]
3512
+ * ```
3513
+ */
3459
3514
  ImportTML = "importTSL",
3460
3515
  /**
3461
3516
  * The **Update TML** menu action for Liveboards and Answers.
3462
3517
  * Update TML representation of ThoughtSpot objects.
3518
+ *
3463
3519
  * @example
3464
3520
  * ```js
3465
3521
  * disabledActions: [Action.UpdateTML]
@@ -3469,6 +3525,7 @@ export declare enum Action {
3469
3525
  /**
3470
3526
  * The **Edit TML** menu action for Liveboards and Answers.
3471
3527
  * Opens the TML editor.
3528
+ *
3472
3529
  * @example
3473
3530
  * ```js
3474
3531
  * disabledActions: [Action.EditTML]
@@ -3476,50 +3533,55 @@ export declare enum Action {
3476
3533
  */
3477
3534
  EditTML = "editTSL",
3478
3535
  /**
3479
- * The **Present** menu action for Liveboards and Answers.
3480
- * Allows presenting a Liveboard or visualization in
3481
- * slideshow mode.
3482
- * @example
3483
- * ```js
3484
- * disabledActions: [Action.Present]
3485
- * ```
3486
- */
3536
+ * The **Present** menu action for Liveboards and Answers.
3537
+ * Allows presenting a Liveboard or visualization in
3538
+ * slideshow mode.
3539
+ *
3540
+ * @example
3541
+ * ```js
3542
+ * disabledActions: [Action.Present]
3543
+ * ```
3544
+ */
3487
3545
  Present = "present",
3488
3546
  /**
3489
- * The tile resize options in the visualization menu.
3490
- * Allows switching between different preset layouts.
3491
- * @example
3492
- * ```js
3493
- * disabledActions: [Action.ToggleSize]
3494
- * ```
3495
- */
3547
+ * The tile resize options in the visualization menu.
3548
+ * Allows switching between different preset layouts.
3549
+ *
3550
+ * @example
3551
+ * ```js
3552
+ * disabledActions: [Action.ToggleSize]
3553
+ * ```
3554
+ */
3496
3555
  ToggleSize = "toggleSize",
3497
3556
  /**
3498
- * The *Edit* action on the Liveboard page and in the
3499
- * visualization menu.
3500
- * Opens a Liveboard or visualization in edit mode.
3501
- * @example
3502
- * ```js
3503
- * disabledActions: [Action.Edit]
3504
- * ```
3505
- */
3557
+ * The *Edit* action on the Liveboard page and in the
3558
+ * visualization menu.
3559
+ * Opens a Liveboard or visualization in edit mode.
3560
+ *
3561
+ * @example
3562
+ * ```js
3563
+ * disabledActions: [Action.Edit]
3564
+ * ```
3565
+ */
3506
3566
  Edit = "edit",
3507
3567
  /**
3508
- * The text edit option for Liveboard and visualization titles.
3509
- * @example
3510
- * ```js
3511
- * disabledActions: [Action.EditTitle]
3512
- * ```
3513
- */
3568
+ * The text edit option for Liveboard and visualization titles.
3569
+ *
3570
+ * @example
3571
+ * ```js
3572
+ * disabledActions: [Action.EditTitle]
3573
+ * ```
3574
+ */
3514
3575
  EditTitle = "editTitle",
3515
3576
  /**
3516
- * The **Delete** menu action on Liveboards and visualizations.
3517
- * Deletes a Liveboard or a visualization from a Liveboard.
3518
- * @example
3519
- * ```js
3520
- * disabledActions: [Action.Remove]
3521
- * ```
3522
- */
3577
+ * The **Delete** menu action on Liveboards and visualizations.
3578
+ * Deletes a Liveboard or a visualization from a Liveboard.
3579
+ *
3580
+ * @example
3581
+ * ```js
3582
+ * disabledActions: [Action.Remove]
3583
+ * ```
3584
+ */
3523
3585
  Remove = "delete",
3524
3586
  /**
3525
3587
  * @hidden
@@ -3542,15 +3604,16 @@ export declare enum Action {
3542
3604
  */
3543
3605
  PinboardInfo = "pinboardInfo",
3544
3606
  /**
3545
- * The **Show Liveboard details** menu action on a Liveboard.
3546
- * Displays details such as the name, description, and
3547
- * author of the Liveboard, and timestamp of Liveboard creation
3548
- * and update.
3549
- * @example
3550
- * ```js
3551
- * disabledActions: [Action.LiveboardInfo]
3552
- * ```
3553
- */
3607
+ * The **Show Liveboard details** menu action on a Liveboard.
3608
+ * Displays details such as the name, description, and
3609
+ * author of the Liveboard, and timestamp of Liveboard creation
3610
+ * and update.
3611
+ *
3612
+ * @example
3613
+ * ```js
3614
+ * disabledActions: [Action.LiveboardInfo]
3615
+ * ```
3616
+ */
3554
3617
  LiveboardInfo = "pinboardInfo",
3555
3618
  /**
3556
3619
  * @hidden
@@ -3561,13 +3624,14 @@ export declare enum Action {
3561
3624
  */
3562
3625
  DownloadEmbraceQueries = "downloadEmbraceQueries",
3563
3626
  /**
3564
- * The **Pin** menu action on an Answer or
3565
- * Search results page.
3566
- * @example
3567
- * ```js
3568
- * disabledActions: [Action.Pin]
3569
- * ```
3570
- */
3627
+ * The **Pin** menu action on an Answer or
3628
+ * Search results page.
3629
+ *
3630
+ * @example
3631
+ * ```js
3632
+ * disabledActions: [Action.Pin]
3633
+ * ```
3634
+ */
3571
3635
  Pin = "pin",
3572
3636
  /**
3573
3637
  * @hidden
@@ -3575,6 +3639,7 @@ export declare enum Action {
3575
3639
  AnalysisInfo = "analysisInfo",
3576
3640
  /**
3577
3641
  * The **Schedule** menu action on a Liveboard.
3642
+ *
3578
3643
  * @example
3579
3644
  * ```js
3580
3645
  * disabledActions: [Action.Subscription]
@@ -3582,25 +3647,28 @@ export declare enum Action {
3582
3647
  */
3583
3648
  Subscription = "subscription",
3584
3649
  /**
3585
- * The **Explore** action on Liveboard visualizations
3586
- * @example
3587
- * ```js
3588
- * disabledActions: [Action.Explore]
3589
- * ```
3590
- */
3650
+ * The **Explore** action on Liveboard visualizations
3651
+ *
3652
+ * @example
3653
+ * ```js
3654
+ * disabledActions: [Action.Explore]
3655
+ * ```
3656
+ */
3591
3657
  Explore = "explore",
3592
3658
  /**
3593
- * The action to include data points on a drilled-down Answer
3594
- * or visualization
3595
- * @example
3596
- * ```js
3597
- * disabledActions: [Action.DrillInclude]
3598
- * ```
3599
- */
3659
+ * The action to include data points on a drilled-down Answer
3660
+ * or visualization
3661
+ *
3662
+ * @example
3663
+ * ```js
3664
+ * disabledActions: [Action.DrillInclude]
3665
+ * ```
3666
+ */
3600
3667
  DrillInclude = "context-menu-item-include",
3601
3668
  /**
3602
3669
  * The action to exclude data points on a drilled-down Answer
3603
3670
  * or visualization
3671
+ *
3604
3672
  * @example
3605
3673
  * ```js
3606
3674
  * disabledActions: [Action.DrillInclude]
@@ -3611,6 +3679,7 @@ export declare enum Action {
3611
3679
  * The **Copy to clipboard** menu action on tables in an Answer
3612
3680
  * or Liveboard.
3613
3681
  * Copies the selected data point.
3682
+ *
3614
3683
  * @example
3615
3684
  * ```js
3616
3685
  * disabledActions: [Action.CopyToClipboard]
@@ -3628,6 +3697,7 @@ export declare enum Action {
3628
3697
  * The **Drill down** menu action on Answers and Liveboard
3629
3698
  * visualizations.
3630
3699
  * Allows drilling down to a specific data point on a chart or table.
3700
+ *
3631
3701
  * @example
3632
3702
  * ```js
3633
3703
  * disabledActions: [Action.DrillDown]
@@ -3637,6 +3707,7 @@ export declare enum Action {
3637
3707
  /**
3638
3708
  * The request access action on Liveboards.
3639
3709
  * Allows users with view permissions to request edit access to a Liveboard.
3710
+ *
3640
3711
  * @example
3641
3712
  * ```js
3642
3713
  * disabledActions: [Action.RequestAccess]
@@ -3646,6 +3717,7 @@ export declare enum Action {
3646
3717
  /**
3647
3718
  * The **Query visualizer** and **Query SQL** buttons in Query details panel
3648
3719
  * of the Answer page
3720
+ *
3649
3721
  * @example
3650
3722
  * ```js
3651
3723
  * disabledActions: [Action.QueryDetailsButtons]
@@ -3654,6 +3726,7 @@ export declare enum Action {
3654
3726
  QueryDetailsButtons = "QueryDetailsButtons",
3655
3727
  /**
3656
3728
  * The **Delete** action for Answers.
3729
+ *
3657
3730
  * @example
3658
3731
  * ```js
3659
3732
  * disabledActions: [Action.AnswerDelete]
@@ -3663,6 +3736,7 @@ export declare enum Action {
3663
3736
  AnswerDelete = "onDeleteAnswer",
3664
3737
  /**
3665
3738
  * The Chart switcher icon on Answer and visualization pages.
3739
+ *
3666
3740
  * @example
3667
3741
  * ```js
3668
3742
  * disabledActions: [Action.AnswerChartSwitcher]
@@ -3672,6 +3746,7 @@ export declare enum Action {
3672
3746
  AnswerChartSwitcher = "answerChartSwitcher",
3673
3747
  /**
3674
3748
  * Favorites icon (*) on Answers, Liveboard, and Data pages
3749
+ *
3675
3750
  * @example
3676
3751
  * ```js
3677
3752
  * disabledActions: [Action.AddToFavorites]
@@ -3681,6 +3756,7 @@ export declare enum Action {
3681
3756
  AddToFavorites = "addToFavorites",
3682
3757
  /**
3683
3758
  * The edit icon on Liveboards (Classic experience).
3759
+ *
3684
3760
  * @example
3685
3761
  * ```js
3686
3762
  * disabledActions: [Action.EditDetails]
@@ -3690,6 +3766,7 @@ export declare enum Action {
3690
3766
  EditDetails = "editDetails",
3691
3767
  /**
3692
3768
  * The Create alert action on KPI charts.
3769
+ *
3693
3770
  * @example
3694
3771
  * ```js
3695
3772
  * disabledActions: [Action.CreateMonitor ]
@@ -3708,6 +3785,7 @@ export declare enum Action {
3708
3785
  /**
3709
3786
  * The **Sync to sheets** action on Answers and Liveboard visualizations.
3710
3787
  * Allows sending data to a Google Sheet.
3788
+ *
3711
3789
  * @example
3712
3790
  * ```js
3713
3791
  * disabledActions: [Action.SyncToSheets]
@@ -3719,6 +3797,7 @@ export declare enum Action {
3719
3797
  * The **Sync to other apps** action on Answers and Liveboard visualizations.
3720
3798
  * Allows sending data to third-party apps like Slack, Salesforce,
3721
3799
  * Microsoft Teams, and so on.
3800
+ *
3722
3801
  * @example
3723
3802
  * ```js
3724
3803
  * disabledActions: [Action.SyncToOtherApps]
@@ -3729,6 +3808,7 @@ export declare enum Action {
3729
3808
  /**
3730
3809
  * The **Manage pipelines** action on Answers and Liveboard visualizations.
3731
3810
  * Allows users to manage data sync pipelines to third-party apps.
3811
+ *
3732
3812
  * @example
3733
3813
  * ```js
3734
3814
  * disabledActions: [Action.SyncToOtherApps]
@@ -3739,6 +3819,7 @@ export declare enum Action {
3739
3819
  /**
3740
3820
  * The **Filter** action on Liveboard visualizations.
3741
3821
  * Allows users to apply cross-filters on a Liveboard.
3822
+ *
3742
3823
  * @example
3743
3824
  * ```js
3744
3825
  * disabledActions: [Action.CrossFilter]
@@ -3750,6 +3831,7 @@ export declare enum Action {
3750
3831
  * The **Remove** action that appears when cross filters are applied
3751
3832
  * on a Liveboard.
3752
3833
  * Removes filters applied o a visualization.
3834
+ *
3753
3835
  * @example
3754
3836
  * ```js
3755
3837
  * disabledActions: [Action.RemoveCrossFilter]
@@ -3761,6 +3843,7 @@ export declare enum Action {
3761
3843
  * The **Aggregate** option in the chart axis or the
3762
3844
  * table column customization menu.
3763
3845
  * Provides aggregation options to analyze the data on a chart or table.
3846
+ *
3764
3847
  * @example
3765
3848
  * ```js
3766
3849
  * disabledActions: [Action.AxisMenuAggregate]
@@ -3772,6 +3855,7 @@ export declare enum Action {
3772
3855
  * The **Time bucket** option in the chart axis or table column
3773
3856
  * customization menu.
3774
3857
  * Allows defining time metric for date comparison.
3858
+ *
3775
3859
  * @example
3776
3860
  * ```js
3777
3861
  * disabledActions: [Action.AxisMenuTimeBucket]
@@ -3782,6 +3866,7 @@ export declare enum Action {
3782
3866
  /**
3783
3867
  * The **Filter** action in the chart axis or table column
3784
3868
  * customization menu.
3869
+ *
3785
3870
  * @example
3786
3871
  * ```js
3787
3872
  * disabledActions: [Action.AxisMenuFilter]
@@ -3793,6 +3878,7 @@ export declare enum Action {
3793
3878
  * The **Conditional formatting** action on chart or table.
3794
3879
  * Allows adding rules for conditional formatting of data
3795
3880
  * points on a chart or table.
3881
+ *
3796
3882
  * @example
3797
3883
  * ```js
3798
3884
  * disabledActions: [Action.AxisMenuConditionalFormat]
@@ -3804,6 +3890,7 @@ export declare enum Action {
3804
3890
  * The **Sort** menu action on a table or chart axis
3805
3891
  * Sorts data in ascending or descending order.
3806
3892
  * Allows adding, editing, or removing filters.
3893
+ *
3807
3894
  * @example
3808
3895
  * ```js
3809
3896
  * disabledActions: [Action.AxisMenuConditionalFormat]
@@ -3816,6 +3903,7 @@ export declare enum Action {
3816
3903
  * customization menu.
3817
3904
  * Allows grouping data points if the axes use the same
3818
3905
  * unit of measurement and a similar scale.
3906
+ *
3819
3907
  * @example
3820
3908
  * ```js
3821
3909
  * disabledActions: [Action.AxisMenuGroup]
@@ -3827,6 +3915,7 @@ export declare enum Action {
3827
3915
  * The **Position** option in the axis customization menu.
3828
3916
  * Allows changing the position of the axis to the
3829
3917
  * left or right side of the chart.
3918
+ *
3830
3919
  * @example
3831
3920
  * ```js
3832
3921
  * disabledActions: [Action.AxisMenuPosition]
@@ -3837,6 +3926,7 @@ export declare enum Action {
3837
3926
  /**
3838
3927
  * The **Rename** option in the chart axis or table column customization menu.
3839
3928
  * Renames the axis label on a chart or the column header on a table.
3929
+ *
3840
3930
  * @example
3841
3931
  * ```js
3842
3932
  * disabledActions: [Action.AxisMenuRename]
@@ -3848,6 +3938,7 @@ export declare enum Action {
3848
3938
  * The **Edit** action in the axis customization menu.
3849
3939
  * Allows editing the axis name, position, minimum and maximum values,
3850
3940
  * and format of a column.
3941
+ *
3851
3942
  * @example
3852
3943
  * ```js
3853
3944
  * disabledActions: [Action.AxisMenuEdit]
@@ -3858,6 +3949,7 @@ export declare enum Action {
3858
3949
  /**
3859
3950
  * The **Number format** action to customize the format of
3860
3951
  * the data labels on a chart or table.
3952
+ *
3861
3953
  * @example
3862
3954
  * ```js
3863
3955
  * disabledActions: [Action.AxisMenuNumberFormat]
@@ -3868,6 +3960,7 @@ export declare enum Action {
3868
3960
  /**
3869
3961
  * The **Text wrapping** action on a table.
3870
3962
  * Wraps or clips column text on a table.
3963
+ *
3871
3964
  * @example
3872
3965
  * ```js
3873
3966
  * disabledActions: [Action.AxisMenuTextWrapping]
@@ -3880,6 +3973,7 @@ export declare enum Action {
3880
3973
  * customization menu.
3881
3974
  * Removes the data labels from a chart or the column of a
3882
3975
  * table visualization.
3976
+ *
3883
3977
  * @example
3884
3978
  * ```js
3885
3979
  * disabledActions: [Action.AxisMenuRemove]
@@ -3894,6 +3988,7 @@ export declare enum Action {
3894
3988
  /**
3895
3989
  * The **Rename** menu action on Liveboards and visualizations.
3896
3990
  * Allows renaming a Liveboard or visualization.
3991
+ *
3897
3992
  * @example
3898
3993
  * ```js
3899
3994
  * disabledActions: [Action.RenameModalTitleDescription]
@@ -3916,7 +4011,23 @@ export declare enum Action {
3916
4011
  /**
3917
4012
  * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
3918
4013
  */
3919
- EnableContextualChangeAnalysis = "enableContextualChangeAnalysis"
4014
+ EnableContextualChangeAnalysis = "enableContextualChangeAnalysis",
4015
+ /**
4016
+ * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
4017
+ */
4018
+ ShowSageQuery = "showSageQuery",
4019
+ /**
4020
+ * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
4021
+ */
4022
+ EditSageAnswer = "editSageAnswer",
4023
+ /**
4024
+ * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
4025
+ */
4026
+ SageAnswerFeedback = "sageAnswerFeedback",
4027
+ /**
4028
+ * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
4029
+ */
4030
+ ModifySageAnswer = "modifySageAnswer"
3920
4031
  }
3921
4032
  export interface SessionInterface {
3922
4033
  sessionId: string;