@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
@@ -161,6 +161,7 @@ export declare class SearchBarEmbed extends TsEmbed {
161
161
  * The configuration attributes for the embedded Natural language search view. Based on
162
162
  * GPT and LLM.
163
163
  *
164
+ * @version: SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl, 9.5.1-sw
164
165
  * @group Embed components
165
166
  */
166
167
  export interface SageViewConfig extends ViewConfig {
@@ -181,6 +182,19 @@ export interface SageViewConfig extends ViewConfig {
181
182
  *
182
183
  */
183
184
  showObjectSuggestions?: boolean;
185
+ /**
186
+ * The query string to pre-fill in natual language search bar
187
+ */
188
+ searchQuery?: string;
189
+ /**
190
+ * If set to true, sample questions would be hidden to user.
191
+ * These sample questions are autogenerated based on selected datasource.
192
+ */
193
+ hideSampleQuestions?: boolean;
194
+ /**
195
+ * The data source GUID to set on load.
196
+ */
197
+ dataSource?: string;
184
198
  }
185
199
  export declare const HiddenActionItemByDefaultForSageEmbed: Action[];
186
200
  /**
@@ -256,10 +270,6 @@ export interface SearchViewConfig extends ViewConfig {
256
270
  * using raw answer data.
257
271
  */
258
272
  hideResults?: boolean;
259
- /**
260
- * If set to true, expands all the data sources panel.
261
- */
262
- expandAllDataSource?: boolean;
263
273
  /**
264
274
  * If set to true, the Search Assist feature is enabled.
265
275
  *
@@ -2147,7 +2157,19 @@ export declare enum EmbedEvent {
2147
2157
  *
2148
2158
  * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
2149
2159
  */
2150
- FilterChanged = "filterChanged"
2160
+ FilterChanged = "filterChanged",
2161
+ /**
2162
+ * Emitted when a user click on Go button in Sage Embed
2163
+ *
2164
+ * @version SDK : 1.27.0 | Thoughtspot: 9.7.0.cl
2165
+ */
2166
+ SageEmbedQuery = "sageEmbedQuery",
2167
+ /**
2168
+ * Emitten when a user select data source in Sage Embed
2169
+ *
2170
+ * @version SDK : 1.27.0 | Thoughtspot: 9.7.0.cl
2171
+ */
2172
+ SageWorksheetUpdated = "sageWorksheetUpdated"
2151
2173
  }
2152
2174
  /**
2153
2175
  * Event types that can be triggered by the host application
@@ -2176,6 +2198,7 @@ export declare enum HostEvent {
2176
2198
  * Triggers a search query in AppEmbed and SearchEmbed
2177
2199
  * deployments.
2178
2200
  * Includes the following properties:
2201
+ *
2179
2202
  * @param - dataSourceIds - The data source GUID to Search on
2180
2203
  * - Although an array, only a single source
2181
2204
  * is supported.
@@ -2194,6 +2217,7 @@ export declare enum HostEvent {
2194
2217
  /**
2195
2218
  * Triggers a drill on certain points of the specified column
2196
2219
  * Includes the following properties:
2220
+ *
2197
2221
  * @param - points - an object containing selectedPoints/clickedPoints
2198
2222
  * to drill to. For example, { selectedPoints: []}
2199
2223
  * @param - columnGuid - Optional. GUID of the column to drill
@@ -2258,18 +2282,19 @@ export declare enum HostEvent {
2258
2282
  */
2259
2283
  SetActiveTab = "SetActiveTab",
2260
2284
  /**
2261
- * Updates runtime filters applied on a Saved Answer or Liveboard. The
2262
- * runtime filters passed here are appended to the existing runtime
2263
- * filters.
2264
- * Pass an array of runtime filters with the following attributes:
2265
- * `columnName`
2266
- * _String_. The name of the column to filter on.
2267
- * `operator`
2268
- * Runtime filter operator to apply. For information,
2269
- * see [Runtime filter operators](https://developers.thoughtspot.com/docs/?pageid=runtime-filters#rtOperator).
2270
- * `values`
2271
- * List of operands. Some operators such as EQ, LE allow a single value, whereas operators
2272
- * such as BW and IN accept multiple operands.
2285
+ * Updates runtime filters applied on a Saved Answer or Liveboard. The
2286
+ * runtime filters passed here are appended to the existing runtime
2287
+ * filters.
2288
+ * Pass an array of runtime filters with the following attributes:
2289
+ * `columnName`
2290
+ * _String_. The name of the column to filter on.
2291
+ * `operator`
2292
+ * Runtime filter operator to apply. For information,
2293
+ * see [Runtime filter operators](https://developers.thoughtspot.com/docs/?pageid=runtime-filters#rtOperator).
2294
+ * `values`
2295
+ * List of operands. Some operators such as EQ, LE allow a single value, whereas
2296
+ * operators such as BW and IN accept multiple operands.
2297
+ *
2273
2298
  * @param - {@link RuntimeFilter}[] an array of {@link RuntimeFilter} Types.
2274
2299
  * @example
2275
2300
  * ```js
@@ -2285,6 +2310,7 @@ export declare enum HostEvent {
2285
2310
  /**
2286
2311
  * Navigate to a specific page in the embedded application without reloading the page.
2287
2312
  * This is the same as calling `appEmbed.navigateToPage(path, true)`
2313
+ *
2288
2314
  * @param - path - the path to navigate to (can be a number[1/-1] to go forward/back)
2289
2315
  * @example
2290
2316
  * ```js
@@ -2608,6 +2634,7 @@ export declare enum HostEvent {
2608
2634
  /**
2609
2635
  * Triggers the **SpotIQ analyze** action on visualization
2610
2636
  * or search.
2637
+ *
2611
2638
  * @param - Liveboard embed takes `vizId` as a
2612
2639
  * key. Can be left undefined when embedding Search or
2613
2640
  * visualization.
@@ -2647,6 +2674,7 @@ export declare enum HostEvent {
2647
2674
  /**
2648
2675
  * Triggers the **Download** > **PNG** action on
2649
2676
  * charts in the embedded view.
2677
+ *
2650
2678
  * @example
2651
2679
  * ```js
2652
2680
  * liveboardEmbed.trigger(HostEvent.DownloadAsPng,
@@ -2680,6 +2708,7 @@ export declare enum HostEvent {
2680
2708
  /**
2681
2709
  * Triggers the **Download** > **XLSX** action on tables
2682
2710
  * in the embedded view.
2711
+ *
2683
2712
  * @example
2684
2713
  * ```js
2685
2714
  * liveboardEmbed.trigger(HostEvent.DownloadAsXlsx, {vizId:
@@ -2711,6 +2740,7 @@ export declare enum HostEvent {
2711
2740
  /**
2712
2741
  * Triggers the **Save** action on a Liveboard or Answer.
2713
2742
  * Saves the changes.
2743
+ *
2714
2744
  * @example
2715
2745
  * ```js
2716
2746
  * liveboardEmbed.trigger(HostEvent.Save)
@@ -2724,6 +2754,7 @@ export declare enum HostEvent {
2724
2754
  /**
2725
2755
  * Triggers the **Sync to Sheets** action on an embedded visualization or Answer
2726
2756
  * Sends data from an Answer or Liveboard visualization to a Google sheet.
2757
+ *
2727
2758
  * @param - an object with `vizId` as a key
2728
2759
  * @example
2729
2760
  * ```js
@@ -2740,6 +2771,7 @@ export declare enum HostEvent {
2740
2771
  * Triggers the **Sync to Other Apps** action on an embedded visualization or Answer
2741
2772
  * Sends data from an Answer or Liveboard visualization to third-party apps such
2742
2773
  * as Slack, Salesforce, Microsoft Teams, ServiceNow and so on.
2774
+ *
2743
2775
  * @param - an object with vizId as a key
2744
2776
  * @example
2745
2777
  * ```js
@@ -2756,6 +2788,7 @@ export declare enum HostEvent {
2756
2788
  * Triggers the **Manage pipelines** action on an embedded
2757
2789
  * visualization or Answer.
2758
2790
  * Allows users to manage ThoughtSpot Sync pipelines.
2791
+ *
2759
2792
  * @param - an object with `vizId` as a key
2760
2793
  * @example
2761
2794
  * ```js
@@ -2908,7 +2941,10 @@ export declare enum Param {
2908
2941
  ShowLiveboardTitle = "showLiveboardTitle",
2909
2942
  HiddenTabs = "hideTabs",
2910
2943
  VisibleTabs = "visibleTabs",
2911
- HideTabPanel = "hideTabPanel"
2944
+ HideTabPanel = "hideTabPanel",
2945
+ HideSampleQuestions = "hideSampleQuestions",
2946
+ WorksheetId = "worksheetId",
2947
+ Query = "query,"
2912
2948
  }
2913
2949
  /**
2914
2950
  * ThoughtSpot application pages include actions and menu commands
@@ -2917,6 +2953,7 @@ export declare enum Param {
2917
2953
  * specific actions in the embedded view, define the Action
2918
2954
  * enumeration members in the `disabledActions`, `visibleActions`,
2919
2955
  * or `hiddenActions` array.
2956
+ *
2920
2957
  * @example
2921
2958
  * ```js
2922
2959
  * const embed = new LiveboardEmbed('#embed-container', {
@@ -2935,12 +2972,12 @@ export declare enum Param {
2935
2972
  * hiddenActions: [Action.Edit, ActionAction.Explore],
2936
2973
  * })
2937
2974
  * ```
2938
-
2939
2975
  */
2940
2976
  export declare enum Action {
2941
2977
  /**
2942
2978
  * The **Save** action on an Answer or Liveboard.
2943
2979
  * Allows users to save the changes.
2980
+ *
2944
2981
  * @example
2945
2982
  * ```js
2946
2983
  * disabledActions: [Action.SaveAsView]
@@ -2956,136 +2993,146 @@ export declare enum Action {
2956
2993
  */
2957
2994
  SaveUntitled = "saveUntitled",
2958
2995
  /**
2959
- * The **Save as View** action on the Answer
2960
- * page. Saves an Answer as a View object.
2961
- *
2962
- * @example
2963
- * ```js
2964
- * disabledActions: [Action.SaveAsView]
2965
- * ```
2966
- */
2996
+ * The **Save as View** action on the Answer
2997
+ * page. Saves an Answer as a View object.
2998
+ *
2999
+ * @example
3000
+ * ```js
3001
+ * disabledActions: [Action.SaveAsView]
3002
+ * ```
3003
+ */
2967
3004
  SaveAsView = "saveAsView",
2968
3005
  /**
2969
- * The **Make a copy** action on a Liveboard or Answer
2970
- * page.
2971
- * Creates a copy of the Liveboard, visualization,
2972
- * or Answer.
2973
- *
2974
- * @example
2975
- * ```js
2976
- * disabledActions: [Action.MakeACopy]
2977
- * ```
2978
- */
3006
+ * The **Make a copy** action on a Liveboard or Answer
3007
+ * page.
3008
+ * Creates a copy of the Liveboard, visualization,
3009
+ * or Answer.
3010
+ *
3011
+ * @example
3012
+ * ```js
3013
+ * disabledActions: [Action.MakeACopy]
3014
+ * ```
3015
+ */
2979
3016
  MakeACopy = "makeACopy",
2980
3017
  /**
2981
- * The **Copy and Edit** action on a Liveboard.
2982
- * This action is now replaced with `Action.MakeACopy`.
2983
- *
2984
- * @example
2985
- * ```js
2986
- * disabledActions: [Action.EditACopy]
2987
- * ```
2988
- */
3018
+ * The **Copy and Edit** action on a Liveboard.
3019
+ * This action is now replaced with `Action.MakeACopy`.
3020
+ *
3021
+ * @example
3022
+ * ```js
3023
+ * disabledActions: [Action.EditACopy]
3024
+ * ```
3025
+ */
2989
3026
  EditACopy = "editACopy",
2990
3027
  /**
2991
- * The **Copy link** menu action on a Liveboard visualization.
2992
- * Copies the visualization URL
2993
- * @example
2994
- * ```js
2995
- * disabledActions: [Action.CopyLink]
2996
- * ```
2997
- */
3028
+ * The **Copy link** menu action on a Liveboard visualization.
3029
+ * Copies the visualization URL
3030
+ *
3031
+ * @example
3032
+ * ```js
3033
+ * disabledActions: [Action.CopyLink]
3034
+ * ```
3035
+ */
2998
3036
  CopyLink = "embedDocument",
2999
3037
  /**
3000
3038
  * @hidden
3001
3039
  */
3002
3040
  ResetLayout = "resetLayout",
3003
3041
  /**
3004
- * The **Schedule** menu action on a Liveboard.
3005
- * Allows scheduling a Liveboard notification.
3006
- * @example
3007
- * ```js
3008
- * disabledActions: [Action.Schedule]
3009
- * ```
3010
- */
3042
+ * The **Schedule** menu action on a Liveboard.
3043
+ * Allows scheduling a Liveboard notification.
3044
+ *
3045
+ * @example
3046
+ * ```js
3047
+ * disabledActions: [Action.Schedule]
3048
+ * ```
3049
+ */
3011
3050
  Schedule = "subscription",
3012
3051
  /**
3013
- * The **Manage schedules** menu action on a Liveboard.
3014
- * Allows users to manage scheduled Liveboard jobs.
3015
- * @example
3016
- * ```js
3017
- * disabledActions: [Action.SchedulesList]
3018
- * ```
3019
- */
3052
+ * The **Manage schedules** menu action on a Liveboard.
3053
+ * Allows users to manage scheduled Liveboard jobs.
3054
+ *
3055
+ * @example
3056
+ * ```js
3057
+ * disabledActions: [Action.SchedulesList]
3058
+ * ```
3059
+ */
3020
3060
  SchedulesList = "schedule-list",
3021
3061
  /**
3022
- * The **Share** action on a Liveboard, Answer, or Worksheet.
3023
- * Allows users to share an object with other users and groups.
3024
- * @example
3025
- * ```js
3026
- * disabledActions: [Action.Share]
3027
- * ```
3028
- */
3062
+ * The **Share** action on a Liveboard, Answer, or Worksheet.
3063
+ * Allows users to share an object with other users and groups.
3064
+ *
3065
+ * @example
3066
+ * ```js
3067
+ * disabledActions: [Action.Share]
3068
+ * ```
3069
+ */
3029
3070
  Share = "share",
3030
3071
  /**
3031
- * The **Add filter** action on a Liveboard and Search page.
3032
- * Allows adding filters to Answers and visualizations on a Liveboard.
3033
- * @example
3034
- * ```js
3035
- * disabledActions: [Action.AddFilter]
3036
- * ```
3037
- */
3072
+ * The **Add filter** action on a Liveboard and Search page.
3073
+ * Allows adding filters to Answers and visualizations on a Liveboard.
3074
+ *
3075
+ * @example
3076
+ * ```js
3077
+ * disabledActions: [Action.AddFilter]
3078
+ * ```
3079
+ */
3038
3080
  AddFilter = "addFilter",
3039
3081
  /**
3040
- * Filter configuration options on a Liveboard and Search page.
3041
- * Allows configuring filter options when adding filters to a
3042
- * Liveboard or Answer.
3043
- * @example
3044
- * ```js
3045
- * disabledActions: [Action.ConfigureFilter]
3046
- * ```
3047
- */
3082
+ * Filter configuration options on a Liveboard and Search page.
3083
+ * Allows configuring filter options when adding filters to a
3084
+ * Liveboard or Answer.
3085
+ *
3086
+ * @example
3087
+ * ```js
3088
+ * disabledActions: [Action.ConfigureFilter]
3089
+ * ```
3090
+ */
3048
3091
  ConfigureFilter = "configureFilter",
3049
3092
  CollapseDataSources = "collapseDataSources",
3050
3093
  /**
3051
- * The **Choose sources** button on Search page.
3052
- * Allows selecting data sources for search queries.
3053
- * @example
3054
- * ```js
3055
- * disabledActions: [Action.ChooseDataSources]
3056
- * ```
3057
- */
3094
+ * The **Choose sources** button on Search page.
3095
+ * Allows selecting data sources for search queries.
3096
+ *
3097
+ * @example
3098
+ * ```js
3099
+ * disabledActions: [Action.ChooseDataSources]
3100
+ * ```
3101
+ */
3058
3102
  ChooseDataSources = "chooseDataSources",
3059
3103
  /**
3060
- * The **Create formula** action on a Search or Answer page.
3061
- * Allows adding formulas to an Answer.
3062
- * @example
3063
- * ```js
3064
- * disabledActions: [Action.AddFormula]
3065
- * ```
3066
- */
3104
+ * The **Create formula** action on a Search or Answer page.
3105
+ * Allows adding formulas to an Answer.
3106
+ *
3107
+ * @example
3108
+ * ```js
3109
+ * disabledActions: [Action.AddFormula]
3110
+ * ```
3111
+ */
3067
3112
  AddFormula = "addFormula",
3068
3113
  /**
3069
- * The **Add parameter** action on a Liveboard or Answer.
3070
- * Allows adding Parameters to a Liveboard or Answer.
3071
- * @example
3072
- * ```js
3073
- * disabledActions: [Action.AddParameter]
3074
- * ```
3075
- */
3114
+ * The **Add parameter** action on a Liveboard or Answer.
3115
+ * Allows adding Parameters to a Liveboard or Answer.
3116
+ *
3117
+ * @example
3118
+ * ```js
3119
+ * disabledActions: [Action.AddParameter]
3120
+ * ```
3121
+ */
3076
3122
  AddParameter = "addParameter",
3077
3123
  /**
3078
3124
  * @hidden
3079
3125
  */
3080
3126
  SearchOnTop = "searchOnTop",
3081
3127
  /**
3082
- * The **SpotIQ analyze** menu action on a visualization or
3083
- * Answer page.
3084
- * @example
3085
- * ```js
3086
- * disabledActions: [Action.SpotIQAnalyze]
3087
- * ```
3088
- */
3128
+ * The **SpotIQ analyze** menu action on a visualization or
3129
+ * Answer page.
3130
+ *
3131
+ * @example
3132
+ * ```js
3133
+ * disabledActions: [Action.SpotIQAnalyze]
3134
+ * ```
3135
+ */
3089
3136
  SpotIQAnalyze = "spotIQAnalyze",
3090
3137
  /**
3091
3138
  * @hidden
@@ -3101,89 +3148,98 @@ export declare enum Action {
3101
3148
  */
3102
3149
  ReplaySearch = "replaySearch",
3103
3150
  /**
3104
- * The **Show underlying data** menu action on a visualization or
3105
- * Answer page.
3106
- * @example
3107
- * ```js
3108
- * disabledActions: [Action.ShowUnderlyingData]
3109
- * ```
3110
- */
3151
+ * The **Show underlying data** menu action on a visualization or
3152
+ * Answer page.
3153
+ *
3154
+ * @example
3155
+ * ```js
3156
+ * disabledActions: [Action.ShowUnderlyingData]
3157
+ * ```
3158
+ */
3111
3159
  ShowUnderlyingData = "showUnderlyingData",
3112
3160
  /**
3113
- * The **Download** menu action on Liveboard visualizations
3114
- * and Answers.
3115
- * Allows downloading a visualization or Answer.
3116
- * @example
3117
- * ```js
3118
- * disabledActions: [Action.DownloadAsPng]
3119
- * ```
3120
- */
3161
+ * The **Download** menu action on Liveboard visualizations
3162
+ * and Answers.
3163
+ * Allows downloading a visualization or Answer.
3164
+ *
3165
+ * @example
3166
+ * ```js
3167
+ * disabledActions: [Action.DownloadAsPng]
3168
+ * ```
3169
+ */
3121
3170
  Download = "download",
3122
3171
  /**
3123
- * The **Download** > **PNG** menu action for charts on a Liveboard
3124
- * or Answer page.
3125
- * Downloads a visualization or Answer as a PNG file.
3126
- * @example
3127
- * ```js
3128
- * disabledActions: [Action.DownloadAsPng]
3129
- * ```
3130
- */
3172
+ * The **Download** > **PNG** menu action for charts on a Liveboard
3173
+ * or Answer page.
3174
+ * Downloads a visualization or Answer as a PNG file.
3175
+ *
3176
+ * @example
3177
+ * ```js
3178
+ * disabledActions: [Action.DownloadAsPng]
3179
+ * ```
3180
+ */
3131
3181
  DownloadAsPng = "downloadAsPng",
3132
3182
  /**
3133
- * The **Download** > **PDF** menu action on a Liveboard.
3134
- * Downloads a visualization or Answer as a PDF file.
3135
- * @example
3136
- * ```js
3137
- * disabledActions: [Action.DownloadAsPdf]
3138
- * ```
3139
- */
3183
+ * The **Download** > **PDF** menu action on a Liveboard.
3184
+ * Downloads a visualization or Answer as a PDF file.
3185
+ *
3186
+ * @example
3187
+ * ```js
3188
+ * disabledActions: [Action.DownloadAsPdf]
3189
+ * ```
3190
+ */
3140
3191
  DownloadAsPdf = "downloadAsPdf",
3141
3192
  /**
3142
- * The **Download** > **CSV** menu action for tables on a Liveboard
3143
- * or Answer page.
3144
- * Downloads a visualization or Answer in the XLSX format.
3145
- * @example
3146
- * ```js
3147
- * disabledActions: [Action.DownloadAsCsv]
3148
- * ```
3149
- */
3193
+ * The **Download** > **CSV** menu action for tables on a Liveboard
3194
+ * or Answer page.
3195
+ * Downloads a visualization or Answer in the XLSX format.
3196
+ *
3197
+ * @example
3198
+ * ```js
3199
+ * disabledActions: [Action.DownloadAsCsv]
3200
+ * ```
3201
+ */
3150
3202
  DownloadAsCsv = "downloadAsCSV",
3151
3203
  /**
3152
- * The **Download** > **XLSX** menu action for tables on a Liveboard
3153
- * or Answer page.
3154
- * Downloads a visualization or Answer in the XLSX format.
3155
- * @example
3156
- * ```js
3157
- * disabledActions: [Action.DownloadAsXlsx]
3158
- * ```
3159
- */
3204
+ * The **Download** > **XLSX** menu action for tables on a Liveboard
3205
+ * or Answer page.
3206
+ * Downloads a visualization or Answer in the XLSX format.
3207
+ *
3208
+ * @example
3209
+ * ```js
3210
+ * disabledActions: [Action.DownloadAsXlsx]
3211
+ * ```
3212
+ */
3160
3213
  DownloadAsXlsx = "downloadAsXLSX",
3161
3214
  /**
3162
3215
  * @hidden
3163
3216
  */
3164
3217
  DownloadTrace = "downloadTrace",
3165
3218
  /**
3166
- * The **Export TML** menu action on Liveboard, Answers
3167
- * Worksheets and Data Connections page.
3168
- * Exports an object as a TML file.
3169
- * @example
3170
- * ```js
3171
- * disabledActions: [Action.ExportTML]
3172
- * ```
3173
- */
3219
+ * The **Export TML** menu action on Liveboard, Answers
3220
+ * Worksheets and Data Connections page.
3221
+ * Exports an object as a TML file.
3222
+ *
3223
+ * @example
3224
+ * ```js
3225
+ * disabledActions: [Action.ExportTML]
3226
+ * ```
3227
+ */
3174
3228
  ExportTML = "exportTSL",
3175
3229
  /**
3176
- * The **Import TML** menu action for Liveboards and Answers.
3177
- * Imports TML representation of ThoughtSpot objects.
3178
- * @example
3179
- * ```js
3180
- * disabledActions: [Action.ImportTML]
3181
- * ```
3182
- */
3230
+ * The **Import TML** menu action for Liveboards and Answers.
3231
+ * Imports TML representation of ThoughtSpot objects.
3232
+ *
3233
+ * @example
3234
+ * ```js
3235
+ * disabledActions: [Action.ImportTML]
3236
+ * ```
3237
+ */
3183
3238
  ImportTML = "importTSL",
3184
3239
  /**
3185
3240
  * The **Update TML** menu action for Liveboards and Answers.
3186
3241
  * Update TML representation of ThoughtSpot objects.
3242
+ *
3187
3243
  * @example
3188
3244
  * ```js
3189
3245
  * disabledActions: [Action.UpdateTML]
@@ -3193,6 +3249,7 @@ export declare enum Action {
3193
3249
  /**
3194
3250
  * The **Edit TML** menu action for Liveboards and Answers.
3195
3251
  * Opens the TML editor.
3252
+ *
3196
3253
  * @example
3197
3254
  * ```js
3198
3255
  * disabledActions: [Action.EditTML]
@@ -3200,50 +3257,55 @@ export declare enum Action {
3200
3257
  */
3201
3258
  EditTML = "editTSL",
3202
3259
  /**
3203
- * The **Present** menu action for Liveboards and Answers.
3204
- * Allows presenting a Liveboard or visualization in
3205
- * slideshow mode.
3206
- * @example
3207
- * ```js
3208
- * disabledActions: [Action.Present]
3209
- * ```
3210
- */
3260
+ * The **Present** menu action for Liveboards and Answers.
3261
+ * Allows presenting a Liveboard or visualization in
3262
+ * slideshow mode.
3263
+ *
3264
+ * @example
3265
+ * ```js
3266
+ * disabledActions: [Action.Present]
3267
+ * ```
3268
+ */
3211
3269
  Present = "present",
3212
3270
  /**
3213
- * The tile resize options in the visualization menu.
3214
- * Allows switching between different preset layouts.
3215
- * @example
3216
- * ```js
3217
- * disabledActions: [Action.ToggleSize]
3218
- * ```
3219
- */
3271
+ * The tile resize options in the visualization menu.
3272
+ * Allows switching between different preset layouts.
3273
+ *
3274
+ * @example
3275
+ * ```js
3276
+ * disabledActions: [Action.ToggleSize]
3277
+ * ```
3278
+ */
3220
3279
  ToggleSize = "toggleSize",
3221
3280
  /**
3222
- * The *Edit* action on the Liveboard page and in the
3223
- * visualization menu.
3224
- * Opens a Liveboard or visualization in edit mode.
3225
- * @example
3226
- * ```js
3227
- * disabledActions: [Action.Edit]
3228
- * ```
3229
- */
3281
+ * The *Edit* action on the Liveboard page and in the
3282
+ * visualization menu.
3283
+ * Opens a Liveboard or visualization in edit mode.
3284
+ *
3285
+ * @example
3286
+ * ```js
3287
+ * disabledActions: [Action.Edit]
3288
+ * ```
3289
+ */
3230
3290
  Edit = "edit",
3231
3291
  /**
3232
- * The text edit option for Liveboard and visualization titles.
3233
- * @example
3234
- * ```js
3235
- * disabledActions: [Action.EditTitle]
3236
- * ```
3237
- */
3292
+ * The text edit option for Liveboard and visualization titles.
3293
+ *
3294
+ * @example
3295
+ * ```js
3296
+ * disabledActions: [Action.EditTitle]
3297
+ * ```
3298
+ */
3238
3299
  EditTitle = "editTitle",
3239
3300
  /**
3240
- * The **Delete** menu action on Liveboards and visualizations.
3241
- * Deletes a Liveboard or a visualization from a Liveboard.
3242
- * @example
3243
- * ```js
3244
- * disabledActions: [Action.Remove]
3245
- * ```
3246
- */
3301
+ * The **Delete** menu action on Liveboards and visualizations.
3302
+ * Deletes a Liveboard or a visualization from a Liveboard.
3303
+ *
3304
+ * @example
3305
+ * ```js
3306
+ * disabledActions: [Action.Remove]
3307
+ * ```
3308
+ */
3247
3309
  Remove = "delete",
3248
3310
  /**
3249
3311
  * @hidden
@@ -3266,15 +3328,16 @@ export declare enum Action {
3266
3328
  */
3267
3329
  PinboardInfo = "pinboardInfo",
3268
3330
  /**
3269
- * The **Show Liveboard details** menu action on a Liveboard.
3270
- * Displays details such as the name, description, and
3271
- * author of the Liveboard, and timestamp of Liveboard creation
3272
- * and update.
3273
- * @example
3274
- * ```js
3275
- * disabledActions: [Action.LiveboardInfo]
3276
- * ```
3277
- */
3331
+ * The **Show Liveboard details** menu action on a Liveboard.
3332
+ * Displays details such as the name, description, and
3333
+ * author of the Liveboard, and timestamp of Liveboard creation
3334
+ * and update.
3335
+ *
3336
+ * @example
3337
+ * ```js
3338
+ * disabledActions: [Action.LiveboardInfo]
3339
+ * ```
3340
+ */
3278
3341
  LiveboardInfo = "pinboardInfo",
3279
3342
  /**
3280
3343
  * @hidden
@@ -3285,13 +3348,14 @@ export declare enum Action {
3285
3348
  */
3286
3349
  DownloadEmbraceQueries = "downloadEmbraceQueries",
3287
3350
  /**
3288
- * The **Pin** menu action on an Answer or
3289
- * Search results page.
3290
- * @example
3291
- * ```js
3292
- * disabledActions: [Action.Pin]
3293
- * ```
3294
- */
3351
+ * The **Pin** menu action on an Answer or
3352
+ * Search results page.
3353
+ *
3354
+ * @example
3355
+ * ```js
3356
+ * disabledActions: [Action.Pin]
3357
+ * ```
3358
+ */
3295
3359
  Pin = "pin",
3296
3360
  /**
3297
3361
  * @hidden
@@ -3299,6 +3363,7 @@ export declare enum Action {
3299
3363
  AnalysisInfo = "analysisInfo",
3300
3364
  /**
3301
3365
  * The **Schedule** menu action on a Liveboard.
3366
+ *
3302
3367
  * @example
3303
3368
  * ```js
3304
3369
  * disabledActions: [Action.Subscription]
@@ -3306,25 +3371,28 @@ export declare enum Action {
3306
3371
  */
3307
3372
  Subscription = "subscription",
3308
3373
  /**
3309
- * The **Explore** action on Liveboard visualizations
3310
- * @example
3311
- * ```js
3312
- * disabledActions: [Action.Explore]
3313
- * ```
3314
- */
3374
+ * The **Explore** action on Liveboard visualizations
3375
+ *
3376
+ * @example
3377
+ * ```js
3378
+ * disabledActions: [Action.Explore]
3379
+ * ```
3380
+ */
3315
3381
  Explore = "explore",
3316
3382
  /**
3317
- * The action to include data points on a drilled-down Answer
3318
- * or visualization
3319
- * @example
3320
- * ```js
3321
- * disabledActions: [Action.DrillInclude]
3322
- * ```
3323
- */
3383
+ * The action to include data points on a drilled-down Answer
3384
+ * or visualization
3385
+ *
3386
+ * @example
3387
+ * ```js
3388
+ * disabledActions: [Action.DrillInclude]
3389
+ * ```
3390
+ */
3324
3391
  DrillInclude = "context-menu-item-include",
3325
3392
  /**
3326
3393
  * The action to exclude data points on a drilled-down Answer
3327
3394
  * or visualization
3395
+ *
3328
3396
  * @example
3329
3397
  * ```js
3330
3398
  * disabledActions: [Action.DrillInclude]
@@ -3335,6 +3403,7 @@ export declare enum Action {
3335
3403
  * The **Copy to clipboard** menu action on tables in an Answer
3336
3404
  * or Liveboard.
3337
3405
  * Copies the selected data point.
3406
+ *
3338
3407
  * @example
3339
3408
  * ```js
3340
3409
  * disabledActions: [Action.CopyToClipboard]
@@ -3352,6 +3421,7 @@ export declare enum Action {
3352
3421
  * The **Drill down** menu action on Answers and Liveboard
3353
3422
  * visualizations.
3354
3423
  * Allows drilling down to a specific data point on a chart or table.
3424
+ *
3355
3425
  * @example
3356
3426
  * ```js
3357
3427
  * disabledActions: [Action.DrillDown]
@@ -3361,6 +3431,7 @@ export declare enum Action {
3361
3431
  /**
3362
3432
  * The request access action on Liveboards.
3363
3433
  * Allows users with view permissions to request edit access to a Liveboard.
3434
+ *
3364
3435
  * @example
3365
3436
  * ```js
3366
3437
  * disabledActions: [Action.RequestAccess]
@@ -3370,6 +3441,7 @@ export declare enum Action {
3370
3441
  /**
3371
3442
  * The **Query visualizer** and **Query SQL** buttons in Query details panel
3372
3443
  * of the Answer page
3444
+ *
3373
3445
  * @example
3374
3446
  * ```js
3375
3447
  * disabledActions: [Action.QueryDetailsButtons]
@@ -3378,6 +3450,7 @@ export declare enum Action {
3378
3450
  QueryDetailsButtons = "QueryDetailsButtons",
3379
3451
  /**
3380
3452
  * The **Delete** action for Answers.
3453
+ *
3381
3454
  * @example
3382
3455
  * ```js
3383
3456
  * disabledActions: [Action.AnswerDelete]
@@ -3387,6 +3460,7 @@ export declare enum Action {
3387
3460
  AnswerDelete = "onDeleteAnswer",
3388
3461
  /**
3389
3462
  * The Chart switcher icon on Answer and visualization pages.
3463
+ *
3390
3464
  * @example
3391
3465
  * ```js
3392
3466
  * disabledActions: [Action.AnswerChartSwitcher]
@@ -3396,6 +3470,7 @@ export declare enum Action {
3396
3470
  AnswerChartSwitcher = "answerChartSwitcher",
3397
3471
  /**
3398
3472
  * Favorites icon (*) on Answers, Liveboard, and Data pages
3473
+ *
3399
3474
  * @example
3400
3475
  * ```js
3401
3476
  * disabledActions: [Action.AddToFavorites]
@@ -3405,6 +3480,7 @@ export declare enum Action {
3405
3480
  AddToFavorites = "addToFavorites",
3406
3481
  /**
3407
3482
  * The edit icon on Liveboards (Classic experience).
3483
+ *
3408
3484
  * @example
3409
3485
  * ```js
3410
3486
  * disabledActions: [Action.EditDetails]
@@ -3414,6 +3490,7 @@ export declare enum Action {
3414
3490
  EditDetails = "editDetails",
3415
3491
  /**
3416
3492
  * The Create alert action on KPI charts.
3493
+ *
3417
3494
  * @example
3418
3495
  * ```js
3419
3496
  * disabledActions: [Action.CreateMonitor ]
@@ -3432,6 +3509,7 @@ export declare enum Action {
3432
3509
  /**
3433
3510
  * The **Sync to sheets** action on Answers and Liveboard visualizations.
3434
3511
  * Allows sending data to a Google Sheet.
3512
+ *
3435
3513
  * @example
3436
3514
  * ```js
3437
3515
  * disabledActions: [Action.SyncToSheets]
@@ -3443,6 +3521,7 @@ export declare enum Action {
3443
3521
  * The **Sync to other apps** action on Answers and Liveboard visualizations.
3444
3522
  * Allows sending data to third-party apps like Slack, Salesforce,
3445
3523
  * Microsoft Teams, and so on.
3524
+ *
3446
3525
  * @example
3447
3526
  * ```js
3448
3527
  * disabledActions: [Action.SyncToOtherApps]
@@ -3453,6 +3532,7 @@ export declare enum Action {
3453
3532
  /**
3454
3533
  * The **Manage pipelines** action on Answers and Liveboard visualizations.
3455
3534
  * Allows users to manage data sync pipelines to third-party apps.
3535
+ *
3456
3536
  * @example
3457
3537
  * ```js
3458
3538
  * disabledActions: [Action.SyncToOtherApps]
@@ -3463,6 +3543,7 @@ export declare enum Action {
3463
3543
  /**
3464
3544
  * The **Filter** action on Liveboard visualizations.
3465
3545
  * Allows users to apply cross-filters on a Liveboard.
3546
+ *
3466
3547
  * @example
3467
3548
  * ```js
3468
3549
  * disabledActions: [Action.CrossFilter]
@@ -3474,6 +3555,7 @@ export declare enum Action {
3474
3555
  * The **Remove** action that appears when cross filters are applied
3475
3556
  * on a Liveboard.
3476
3557
  * Removes filters applied o a visualization.
3558
+ *
3477
3559
  * @example
3478
3560
  * ```js
3479
3561
  * disabledActions: [Action.RemoveCrossFilter]
@@ -3485,6 +3567,7 @@ export declare enum Action {
3485
3567
  * The **Aggregate** option in the chart axis or the
3486
3568
  * table column customization menu.
3487
3569
  * Provides aggregation options to analyze the data on a chart or table.
3570
+ *
3488
3571
  * @example
3489
3572
  * ```js
3490
3573
  * disabledActions: [Action.AxisMenuAggregate]
@@ -3496,6 +3579,7 @@ export declare enum Action {
3496
3579
  * The **Time bucket** option in the chart axis or table column
3497
3580
  * customization menu.
3498
3581
  * Allows defining time metric for date comparison.
3582
+ *
3499
3583
  * @example
3500
3584
  * ```js
3501
3585
  * disabledActions: [Action.AxisMenuTimeBucket]
@@ -3506,6 +3590,7 @@ export declare enum Action {
3506
3590
  /**
3507
3591
  * The **Filter** action in the chart axis or table column
3508
3592
  * customization menu.
3593
+ *
3509
3594
  * @example
3510
3595
  * ```js
3511
3596
  * disabledActions: [Action.AxisMenuFilter]
@@ -3517,6 +3602,7 @@ export declare enum Action {
3517
3602
  * The **Conditional formatting** action on chart or table.
3518
3603
  * Allows adding rules for conditional formatting of data
3519
3604
  * points on a chart or table.
3605
+ *
3520
3606
  * @example
3521
3607
  * ```js
3522
3608
  * disabledActions: [Action.AxisMenuConditionalFormat]
@@ -3528,6 +3614,7 @@ export declare enum Action {
3528
3614
  * The **Sort** menu action on a table or chart axis
3529
3615
  * Sorts data in ascending or descending order.
3530
3616
  * Allows adding, editing, or removing filters.
3617
+ *
3531
3618
  * @example
3532
3619
  * ```js
3533
3620
  * disabledActions: [Action.AxisMenuConditionalFormat]
@@ -3540,6 +3627,7 @@ export declare enum Action {
3540
3627
  * customization menu.
3541
3628
  * Allows grouping data points if the axes use the same
3542
3629
  * unit of measurement and a similar scale.
3630
+ *
3543
3631
  * @example
3544
3632
  * ```js
3545
3633
  * disabledActions: [Action.AxisMenuGroup]
@@ -3551,6 +3639,7 @@ export declare enum Action {
3551
3639
  * The **Position** option in the axis customization menu.
3552
3640
  * Allows changing the position of the axis to the
3553
3641
  * left or right side of the chart.
3642
+ *
3554
3643
  * @example
3555
3644
  * ```js
3556
3645
  * disabledActions: [Action.AxisMenuPosition]
@@ -3561,6 +3650,7 @@ export declare enum Action {
3561
3650
  /**
3562
3651
  * The **Rename** option in the chart axis or table column customization menu.
3563
3652
  * Renames the axis label on a chart or the column header on a table.
3653
+ *
3564
3654
  * @example
3565
3655
  * ```js
3566
3656
  * disabledActions: [Action.AxisMenuRename]
@@ -3572,6 +3662,7 @@ export declare enum Action {
3572
3662
  * The **Edit** action in the axis customization menu.
3573
3663
  * Allows editing the axis name, position, minimum and maximum values,
3574
3664
  * and format of a column.
3665
+ *
3575
3666
  * @example
3576
3667
  * ```js
3577
3668
  * disabledActions: [Action.AxisMenuEdit]
@@ -3582,6 +3673,7 @@ export declare enum Action {
3582
3673
  /**
3583
3674
  * The **Number format** action to customize the format of
3584
3675
  * the data labels on a chart or table.
3676
+ *
3585
3677
  * @example
3586
3678
  * ```js
3587
3679
  * disabledActions: [Action.AxisMenuNumberFormat]
@@ -3592,6 +3684,7 @@ export declare enum Action {
3592
3684
  /**
3593
3685
  * The **Text wrapping** action on a table.
3594
3686
  * Wraps or clips column text on a table.
3687
+ *
3595
3688
  * @example
3596
3689
  * ```js
3597
3690
  * disabledActions: [Action.AxisMenuTextWrapping]
@@ -3604,6 +3697,7 @@ export declare enum Action {
3604
3697
  * customization menu.
3605
3698
  * Removes the data labels from a chart or the column of a
3606
3699
  * table visualization.
3700
+ *
3607
3701
  * @example
3608
3702
  * ```js
3609
3703
  * disabledActions: [Action.AxisMenuRemove]
@@ -3618,6 +3712,7 @@ export declare enum Action {
3618
3712
  /**
3619
3713
  * The **Rename** menu action on Liveboards and visualizations.
3620
3714
  * Allows renaming a Liveboard or visualization.
3715
+ *
3621
3716
  * @example
3622
3717
  * ```js
3623
3718
  * disabledActions: [Action.RenameModalTitleDescription]
@@ -3640,7 +3735,23 @@ export declare enum Action {
3640
3735
  /**
3641
3736
  * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
3642
3737
  */
3643
- EnableContextualChangeAnalysis = "enableContextualChangeAnalysis"
3738
+ EnableContextualChangeAnalysis = "enableContextualChangeAnalysis",
3739
+ /**
3740
+ * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
3741
+ */
3742
+ ShowSageQuery = "showSageQuery",
3743
+ /**
3744
+ * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
3745
+ */
3746
+ EditSageAnswer = "editSageAnswer",
3747
+ /**
3748
+ * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
3749
+ */
3750
+ SageAnswerFeedback = "sageAnswerFeedback",
3751
+ /**
3752
+ * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
3753
+ */
3754
+ ModifySageAnswer = "modifySageAnswer"
3644
3755
  }
3645
3756
  export interface SessionInterface {
3646
3757
  sessionId: string;