@thoughtspot/visual-embed-sdk 1.23.0 → 1.23.1

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 (60) hide show
  1. package/cjs/package.json +1 -1
  2. package/cjs/src/embed/app.d.ts +1 -1
  3. package/cjs/src/embed/app.d.ts.map +1 -1
  4. package/cjs/src/embed/app.js +1 -1
  5. package/cjs/src/embed/app.js.map +1 -1
  6. package/cjs/src/embed/base.d.ts +8 -0
  7. package/cjs/src/embed/base.d.ts.map +1 -1
  8. package/cjs/src/embed/base.js +8 -0
  9. package/cjs/src/embed/base.js.map +1 -1
  10. package/cjs/src/embed/sage.d.ts +14 -0
  11. package/cjs/src/embed/sage.d.ts.map +1 -1
  12. package/cjs/src/embed/sage.js +12 -3
  13. package/cjs/src/embed/sage.js.map +1 -1
  14. package/cjs/src/embed/sage.spec.js +1 -1
  15. package/cjs/src/embed/sage.spec.js.map +1 -1
  16. package/cjs/src/types.d.ts +364 -247
  17. package/cjs/src/types.d.ts.map +1 -1
  18. package/cjs/src/types.js +342 -241
  19. package/cjs/src/types.js.map +1 -1
  20. package/dist/src/embed/app.d.ts +1 -1
  21. package/dist/src/embed/app.d.ts.map +1 -1
  22. package/dist/src/embed/base.d.ts +8 -0
  23. package/dist/src/embed/base.d.ts.map +1 -1
  24. package/dist/src/embed/sage.d.ts +14 -0
  25. package/dist/src/embed/sage.d.ts.map +1 -1
  26. package/dist/src/types.d.ts +364 -247
  27. package/dist/src/types.d.ts.map +1 -1
  28. package/dist/tsembed-react.es.js +356 -246
  29. package/dist/tsembed-react.js +355 -245
  30. package/dist/tsembed.es.js +364 -246
  31. package/dist/tsembed.js +363 -245
  32. package/dist/visual-embed-sdk-react-full.d.ts +387 -248
  33. package/dist/visual-embed-sdk-react.d.ts +387 -248
  34. package/dist/visual-embed-sdk.d.ts +387 -248
  35. package/lib/package.json +1 -1
  36. package/lib/src/embed/app.d.ts +1 -1
  37. package/lib/src/embed/app.d.ts.map +1 -1
  38. package/lib/src/embed/app.js +1 -1
  39. package/lib/src/embed/app.js.map +1 -1
  40. package/lib/src/embed/base.d.ts +8 -0
  41. package/lib/src/embed/base.d.ts.map +1 -1
  42. package/lib/src/embed/base.js +8 -0
  43. package/lib/src/embed/base.js.map +1 -1
  44. package/lib/src/embed/sage.d.ts +14 -0
  45. package/lib/src/embed/sage.d.ts.map +1 -1
  46. package/lib/src/embed/sage.js +12 -3
  47. package/lib/src/embed/sage.js.map +1 -1
  48. package/lib/src/embed/sage.spec.js +1 -1
  49. package/lib/src/embed/sage.spec.js.map +1 -1
  50. package/lib/src/types.d.ts +364 -247
  51. package/lib/src/types.d.ts.map +1 -1
  52. package/lib/src/types.js +342 -241
  53. package/lib/src/types.js.map +1 -1
  54. package/lib/src/visual-embed-sdk.d.ts +387 -248
  55. package/package.json +1 -1
  56. package/src/embed/app.ts +1 -1
  57. package/src/embed/base.ts +8 -0
  58. package/src/embed/sage.spec.ts +1 -1
  59. package/src/embed/sage.ts +24 -2
  60. package/src/types.ts +351 -247
package/src/types.ts CHANGED
@@ -260,6 +260,9 @@ export interface CustomStyles {
260
260
  export interface CustomisationsInterface {
261
261
  style?: CustomStyles;
262
262
  content?: {
263
+ /**
264
+ * @version SDK: 1.26.0 | 9.7.0.cl
265
+ */
263
266
  strings?: Record<string, any>;
264
267
  [key: string]: any;
265
268
  };
@@ -686,21 +689,21 @@ export interface ViewConfig {
686
689
  /**
687
690
  * Boolean to hide liveboard header
688
691
  *
689
- * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
692
+ * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
690
693
  * @default false
691
694
  */
692
695
  hideLiveboardHeader?: boolean;
693
696
  /**
694
697
  * Boolean to show liveboard title
695
698
  *
696
- * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
699
+ * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
697
700
  * @default false
698
701
  */
699
702
  showLiveboardTitle?: boolean;
700
703
  /**
701
704
  * Boolean to show liveboard description
702
705
  *
703
- * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
706
+ * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
704
707
  * @default false
705
708
  */
706
709
  showLiveboardDescription?: boolean;
@@ -718,7 +721,7 @@ export interface ViewConfig {
718
721
  * 'f547ec54-2a37-4516-a222-2b06719af726']
719
722
  * });
720
723
  * ```
721
- * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
724
+ * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
722
725
  */
723
726
  hiddenTabs?: string[];
724
727
  /**
@@ -737,7 +740,7 @@ export interface ViewConfig {
737
740
  * 'f547ec54-2a37-4516-a222-2b06719af726']
738
741
  * });
739
742
  * ```
740
- * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
743
+ * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
741
744
  */
742
745
  visibleTabs?: string[];
743
746
  }
@@ -1315,6 +1318,18 @@ export enum EmbedEvent {
1315
1318
  * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
1316
1319
  */
1317
1320
  FilterChanged = 'filterChanged',
1321
+ /**
1322
+ * Emitted when a user click on Go button in Sage Embed
1323
+ *
1324
+ * @version SDK : 1.27.0 | Thoughtspot: 9.7.0.cl
1325
+ */
1326
+ SageEmbedQuery = 'sageEmbedQuery',
1327
+ /**
1328
+ * Emitten when a user select data source in Sage Embed
1329
+ *
1330
+ * @version SDK : 1.27.0 | Thoughtspot: 9.7.0.cl
1331
+ */
1332
+ SageWorksheetUpdated = 'sageWorksheetUpdated',
1318
1333
  }
1319
1334
 
1320
1335
  /**
@@ -1345,6 +1360,7 @@ export enum HostEvent {
1345
1360
  * Triggers a search query in AppEmbed and SearchEmbed
1346
1361
  * deployments.
1347
1362
  * Includes the following properties:
1363
+ *
1348
1364
  * @param - dataSourceIds - The data source GUID to Search on
1349
1365
  * - Although an array, only a single source
1350
1366
  * is supported.
@@ -1363,6 +1379,7 @@ export enum HostEvent {
1363
1379
  /**
1364
1380
  * Triggers a drill on certain points of the specified column
1365
1381
  * Includes the following properties:
1382
+ *
1366
1383
  * @param - points - an object containing selectedPoints/clickedPoints
1367
1384
  * to drill to. For example, { selectedPoints: []}
1368
1385
  * @param - columnGuid - Optional. GUID of the column to drill
@@ -1427,18 +1444,19 @@ export enum HostEvent {
1427
1444
  */
1428
1445
  SetActiveTab = 'SetActiveTab',
1429
1446
  /**
1430
- * Updates runtime filters applied on a Saved Answer or Liveboard. The
1431
- * runtime filters passed here are appended to the existing runtime
1432
- * filters.
1433
- * Pass an array of runtime filters with the following attributes:
1434
- * `columnName`
1435
- * _String_. The name of the column to filter on.
1436
- * `operator`
1437
- * Runtime filter operator to apply. For information,
1438
- * see [Runtime filter operators](https://developers.thoughtspot.com/docs/?pageid=runtime-filters#rtOperator).
1439
- * `values`
1440
- * List of operands. Some operators such as EQ, LE allow a single value, whereas operators
1441
- * such as BW and IN accept multiple operands.
1447
+ * Updates runtime filters applied on a Saved Answer or Liveboard. The
1448
+ * runtime filters passed here are appended to the existing runtime
1449
+ * filters.
1450
+ * Pass an array of runtime filters with the following attributes:
1451
+ * `columnName`
1452
+ * _String_. The name of the column to filter on.
1453
+ * `operator`
1454
+ * Runtime filter operator to apply. For information,
1455
+ * see [Runtime filter operators](https://developers.thoughtspot.com/docs/?pageid=runtime-filters#rtOperator).
1456
+ * `values`
1457
+ * List of operands. Some operators such as EQ, LE allow a single value, whereas
1458
+ * operators such as BW and IN accept multiple operands.
1459
+ *
1442
1460
  * @param - {@link RuntimeFilter}[] an array of {@link RuntimeFilter} Types.
1443
1461
  * @example
1444
1462
  * ```js
@@ -1454,6 +1472,7 @@ export enum HostEvent {
1454
1472
  /**
1455
1473
  * Navigate to a specific page in the embedded application without reloading the page.
1456
1474
  * This is the same as calling `appEmbed.navigateToPage(path, true)`
1475
+ *
1457
1476
  * @param - path - the path to navigate to (can be a number[1/-1] to go forward/back)
1458
1477
  * @example
1459
1478
  * ```js
@@ -1777,6 +1796,7 @@ export enum HostEvent {
1777
1796
  /**
1778
1797
  * Triggers the **SpotIQ analyze** action on visualization
1779
1798
  * or search.
1799
+ *
1780
1800
  * @param - Liveboard embed takes `vizId` as a
1781
1801
  * key. Can be left undefined when embedding Search or
1782
1802
  * visualization.
@@ -1816,6 +1836,7 @@ export enum HostEvent {
1816
1836
  /**
1817
1837
  * Triggers the **Download** > **PNG** action on
1818
1838
  * charts in the embedded view.
1839
+ *
1819
1840
  * @example
1820
1841
  * ```js
1821
1842
  * liveboardEmbed.trigger(HostEvent.DownloadAsPng,
@@ -1849,6 +1870,7 @@ export enum HostEvent {
1849
1870
  /**
1850
1871
  * Triggers the **Download** > **XLSX** action on tables
1851
1872
  * in the embedded view.
1873
+ *
1852
1874
  * @example
1853
1875
  * ```js
1854
1876
  * liveboardEmbed.trigger(HostEvent.DownloadAsXlsx, {vizId:
@@ -1880,6 +1902,7 @@ export enum HostEvent {
1880
1902
  /**
1881
1903
  * Triggers the **Save** action on a Liveboard or Answer.
1882
1904
  * Saves the changes.
1905
+ *
1883
1906
  * @example
1884
1907
  * ```js
1885
1908
  * liveboardEmbed.trigger(HostEvent.Save)
@@ -1893,6 +1916,7 @@ export enum HostEvent {
1893
1916
  /**
1894
1917
  * Triggers the **Sync to Sheets** action on an embedded visualization or Answer
1895
1918
  * Sends data from an Answer or Liveboard visualization to a Google sheet.
1919
+ *
1896
1920
  * @param - an object with `vizId` as a key
1897
1921
  * @example
1898
1922
  * ```js
@@ -1909,6 +1933,7 @@ export enum HostEvent {
1909
1933
  * Triggers the **Sync to Other Apps** action on an embedded visualization or Answer
1910
1934
  * Sends data from an Answer or Liveboard visualization to third-party apps such
1911
1935
  * as Slack, Salesforce, Microsoft Teams, ServiceNow and so on.
1936
+ *
1912
1937
  * @param - an object with vizId as a key
1913
1938
  * @example
1914
1939
  * ```js
@@ -1925,6 +1950,7 @@ export enum HostEvent {
1925
1950
  * Triggers the **Manage pipelines** action on an embedded
1926
1951
  * visualization or Answer.
1927
1952
  * Allows users to manage ThoughtSpot Sync pipelines.
1953
+ *
1928
1954
  * @param - an object with `vizId` as a key
1929
1955
  * @example
1930
1956
  * ```js
@@ -1969,7 +1995,7 @@ export enum HostEvent {
1969
1995
  * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
1970
1996
  */
1971
1997
  UpdateFilters = 'updateFilters',
1972
- /*
1998
+ /**
1973
1999
  * Get Tab for the current Liveboard.
1974
2000
  *
1975
2001
  * @example
@@ -1980,7 +2006,7 @@ export enum HostEvent {
1980
2006
  * );
1981
2007
  * })
1982
2008
  * ```
1983
- * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
2009
+ * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl
1984
2010
  */
1985
2011
  GetTabs = 'getTabs',
1986
2012
  /**
@@ -1994,7 +2020,7 @@ export enum HostEvent {
1994
2020
  * '430496d6-6903-4601-937e-2c691821af3c',
1995
2021
  * 'f547ec54-2a37-4516-a222-2b06719af726'])
1996
2022
  * ```
1997
- * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
2023
+ * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
1998
2024
  */
1999
2025
  SetVisibleTabs = 'SetPinboardVisibleTabs',
2000
2026
  /**
@@ -2008,7 +2034,7 @@ export enum HostEvent {
2008
2034
  * '630496d6-6903-4601-937e-2c691821af3c',
2009
2035
  * 'i547ec54-2a37-4516-a222-2b06719af726'])
2010
2036
  * ```
2011
- * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
2037
+ * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
2012
2038
  */
2013
2039
  SetHiddenTabs = 'SetPinboardHiddenTabs',
2014
2040
  }
@@ -2095,7 +2121,10 @@ export enum Param {
2095
2121
  ShowLiveboardTitle = 'showLiveboardTitle',
2096
2122
  HiddenTabs = 'hideTabs',
2097
2123
  VisibleTabs = 'visibleTabs',
2098
- HideTabPanel = 'hideTabPanel'
2124
+ HideTabPanel = 'hideTabPanel',
2125
+ HideSampleQuestions = 'hideSampleQuestions',
2126
+ WorksheetId = 'worksheetId',
2127
+ Query = 'query,'
2099
2128
  }
2100
2129
 
2101
2130
  /**
@@ -2105,6 +2134,7 @@ export enum Param {
2105
2134
  * specific actions in the embedded view, define the Action
2106
2135
  * enumeration members in the `disabledActions`, `visibleActions`,
2107
2136
  * or `hiddenActions` array.
2137
+ *
2108
2138
  * @example
2109
2139
  * ```js
2110
2140
  * const embed = new LiveboardEmbed('#embed-container', {
@@ -2123,13 +2153,13 @@ export enum Param {
2123
2153
  * hiddenActions: [Action.Edit, ActionAction.Explore],
2124
2154
  * })
2125
2155
  * ```
2126
-
2127
2156
  */
2128
2157
  // eslint-disable-next-line no-shadow
2129
2158
  export enum Action {
2130
2159
  /**
2131
2160
  * The **Save** action on an Answer or Liveboard.
2132
2161
  * Allows users to save the changes.
2162
+ *
2133
2163
  * @example
2134
2164
  * ```js
2135
2165
  * disabledActions: [Action.SaveAsView]
@@ -2145,136 +2175,146 @@ export enum Action {
2145
2175
  */
2146
2176
  SaveUntitled = 'saveUntitled',
2147
2177
  /**
2148
- * The **Save as View** action on the Answer
2149
- * page. Saves an Answer as a View object.
2150
- *
2151
- * @example
2152
- * ```js
2153
- * disabledActions: [Action.SaveAsView]
2154
- * ```
2155
- */
2178
+ * The **Save as View** action on the Answer
2179
+ * page. Saves an Answer as a View object.
2180
+ *
2181
+ * @example
2182
+ * ```js
2183
+ * disabledActions: [Action.SaveAsView]
2184
+ * ```
2185
+ */
2156
2186
  SaveAsView = 'saveAsView',
2157
2187
  /**
2158
- * The **Make a copy** action on a Liveboard or Answer
2159
- * page.
2160
- * Creates a copy of the Liveboard, visualization,
2161
- * or Answer.
2162
- *
2163
- * @example
2164
- * ```js
2165
- * disabledActions: [Action.MakeACopy]
2166
- * ```
2167
- */
2188
+ * The **Make a copy** action on a Liveboard or Answer
2189
+ * page.
2190
+ * Creates a copy of the Liveboard, visualization,
2191
+ * or Answer.
2192
+ *
2193
+ * @example
2194
+ * ```js
2195
+ * disabledActions: [Action.MakeACopy]
2196
+ * ```
2197
+ */
2168
2198
  MakeACopy = 'makeACopy',
2169
2199
  /**
2170
- * The **Copy and Edit** action on a Liveboard.
2171
- * This action is now replaced with `Action.MakeACopy`.
2172
- *
2173
- * @example
2174
- * ```js
2175
- * disabledActions: [Action.EditACopy]
2176
- * ```
2177
- */
2200
+ * The **Copy and Edit** action on a Liveboard.
2201
+ * This action is now replaced with `Action.MakeACopy`.
2202
+ *
2203
+ * @example
2204
+ * ```js
2205
+ * disabledActions: [Action.EditACopy]
2206
+ * ```
2207
+ */
2178
2208
  EditACopy = 'editACopy',
2179
2209
  /**
2180
- * The **Copy link** menu action on a Liveboard visualization.
2181
- * Copies the visualization URL
2182
- * @example
2183
- * ```js
2184
- * disabledActions: [Action.CopyLink]
2185
- * ```
2186
- */
2210
+ * The **Copy link** menu action on a Liveboard visualization.
2211
+ * Copies the visualization URL
2212
+ *
2213
+ * @example
2214
+ * ```js
2215
+ * disabledActions: [Action.CopyLink]
2216
+ * ```
2217
+ */
2187
2218
  CopyLink = 'embedDocument',
2188
2219
  /**
2189
2220
  * @hidden
2190
2221
  */
2191
2222
  ResetLayout = 'resetLayout',
2192
2223
  /**
2193
- * The **Schedule** menu action on a Liveboard.
2194
- * Allows scheduling a Liveboard notification.
2195
- * @example
2196
- * ```js
2197
- * disabledActions: [Action.Schedule]
2198
- * ```
2199
- */
2224
+ * The **Schedule** menu action on a Liveboard.
2225
+ * Allows scheduling a Liveboard notification.
2226
+ *
2227
+ * @example
2228
+ * ```js
2229
+ * disabledActions: [Action.Schedule]
2230
+ * ```
2231
+ */
2200
2232
  Schedule = 'subscription',
2201
2233
  /**
2202
- * The **Manage schedules** menu action on a Liveboard.
2203
- * Allows users to manage scheduled Liveboard jobs.
2204
- * @example
2205
- * ```js
2206
- * disabledActions: [Action.SchedulesList]
2207
- * ```
2208
- */
2234
+ * The **Manage schedules** menu action on a Liveboard.
2235
+ * Allows users to manage scheduled Liveboard jobs.
2236
+ *
2237
+ * @example
2238
+ * ```js
2239
+ * disabledActions: [Action.SchedulesList]
2240
+ * ```
2241
+ */
2209
2242
  SchedulesList = 'schedule-list',
2210
2243
  /**
2211
- * The **Share** action on a Liveboard, Answer, or Worksheet.
2212
- * Allows users to share an object with other users and groups.
2213
- * @example
2214
- * ```js
2215
- * disabledActions: [Action.Share]
2216
- * ```
2217
- */
2244
+ * The **Share** action on a Liveboard, Answer, or Worksheet.
2245
+ * Allows users to share an object with other users and groups.
2246
+ *
2247
+ * @example
2248
+ * ```js
2249
+ * disabledActions: [Action.Share]
2250
+ * ```
2251
+ */
2218
2252
  Share = 'share',
2219
2253
  /**
2220
- * The **Add filter** action on a Liveboard and Search page.
2221
- * Allows adding filters to Answers and visualizations on a Liveboard.
2222
- * @example
2223
- * ```js
2224
- * disabledActions: [Action.AddFilter]
2225
- * ```
2226
- */
2254
+ * The **Add filter** action on a Liveboard and Search page.
2255
+ * Allows adding filters to Answers and visualizations on a Liveboard.
2256
+ *
2257
+ * @example
2258
+ * ```js
2259
+ * disabledActions: [Action.AddFilter]
2260
+ * ```
2261
+ */
2227
2262
  AddFilter = 'addFilter',
2228
2263
  /**
2229
- * Filter configuration options on a Liveboard and Search page.
2230
- * Allows configuring filter options when adding filters to a
2231
- * Liveboard or Answer.
2232
- * @example
2233
- * ```js
2234
- * disabledActions: [Action.ConfigureFilter]
2235
- * ```
2236
- */
2264
+ * Filter configuration options on a Liveboard and Search page.
2265
+ * Allows configuring filter options when adding filters to a
2266
+ * Liveboard or Answer.
2267
+ *
2268
+ * @example
2269
+ * ```js
2270
+ * disabledActions: [Action.ConfigureFilter]
2271
+ * ```
2272
+ */
2237
2273
  ConfigureFilter = 'configureFilter',
2238
2274
  CollapseDataSources = 'collapseDataSources',
2239
2275
  /**
2240
- * The **Choose sources** button on Search page.
2241
- * Allows selecting data sources for search queries.
2242
- * @example
2243
- * ```js
2244
- * disabledActions: [Action.ChooseDataSources]
2245
- * ```
2246
- */
2276
+ * The **Choose sources** button on Search page.
2277
+ * Allows selecting data sources for search queries.
2278
+ *
2279
+ * @example
2280
+ * ```js
2281
+ * disabledActions: [Action.ChooseDataSources]
2282
+ * ```
2283
+ */
2247
2284
  ChooseDataSources = 'chooseDataSources',
2248
2285
  /**
2249
- * The **Create formula** action on a Search or Answer page.
2250
- * Allows adding formulas to an Answer.
2251
- * @example
2252
- * ```js
2253
- * disabledActions: [Action.AddFormula]
2254
- * ```
2255
- */
2286
+ * The **Create formula** action on a Search or Answer page.
2287
+ * Allows adding formulas to an Answer.
2288
+ *
2289
+ * @example
2290
+ * ```js
2291
+ * disabledActions: [Action.AddFormula]
2292
+ * ```
2293
+ */
2256
2294
  AddFormula = 'addFormula',
2257
2295
  /**
2258
- * The **Add parameter** action on a Liveboard or Answer.
2259
- * Allows adding Parameters to a Liveboard or Answer.
2260
- * @example
2261
- * ```js
2262
- * disabledActions: [Action.AddParameter]
2263
- * ```
2264
- */
2296
+ * The **Add parameter** action on a Liveboard or Answer.
2297
+ * Allows adding Parameters to a Liveboard or Answer.
2298
+ *
2299
+ * @example
2300
+ * ```js
2301
+ * disabledActions: [Action.AddParameter]
2302
+ * ```
2303
+ */
2265
2304
  AddParameter = 'addParameter',
2266
2305
  /**
2267
2306
  * @hidden
2268
2307
  */
2269
2308
  SearchOnTop = 'searchOnTop',
2270
2309
  /**
2271
- * The **SpotIQ analyze** menu action on a visualization or
2272
- * Answer page.
2273
- * @example
2274
- * ```js
2275
- * disabledActions: [Action.SpotIQAnalyze]
2276
- * ```
2277
- */
2310
+ * The **SpotIQ analyze** menu action on a visualization or
2311
+ * Answer page.
2312
+ *
2313
+ * @example
2314
+ * ```js
2315
+ * disabledActions: [Action.SpotIQAnalyze]
2316
+ * ```
2317
+ */
2278
2318
  SpotIQAnalyze = 'spotIQAnalyze',
2279
2319
  /**
2280
2320
  * @hidden
@@ -2290,89 +2330,98 @@ export enum Action {
2290
2330
  */
2291
2331
  ReplaySearch = 'replaySearch',
2292
2332
  /**
2293
- * The **Show underlying data** menu action on a visualization or
2294
- * Answer page.
2295
- * @example
2296
- * ```js
2297
- * disabledActions: [Action.ShowUnderlyingData]
2298
- * ```
2299
- */
2333
+ * The **Show underlying data** menu action on a visualization or
2334
+ * Answer page.
2335
+ *
2336
+ * @example
2337
+ * ```js
2338
+ * disabledActions: [Action.ShowUnderlyingData]
2339
+ * ```
2340
+ */
2300
2341
  ShowUnderlyingData = 'showUnderlyingData',
2301
2342
  /**
2302
- * The **Download** menu action on Liveboard visualizations
2303
- * and Answers.
2304
- * Allows downloading a visualization or Answer.
2305
- * @example
2306
- * ```js
2307
- * disabledActions: [Action.DownloadAsPng]
2308
- * ```
2309
- */
2343
+ * The **Download** menu action on Liveboard visualizations
2344
+ * and Answers.
2345
+ * Allows downloading a visualization or Answer.
2346
+ *
2347
+ * @example
2348
+ * ```js
2349
+ * disabledActions: [Action.DownloadAsPng]
2350
+ * ```
2351
+ */
2310
2352
  Download = 'download',
2311
2353
  /**
2312
- * The **Download** > **PNG** menu action for charts on a Liveboard
2313
- * or Answer page.
2314
- * Downloads a visualization or Answer as a PNG file.
2315
- * @example
2316
- * ```js
2317
- * disabledActions: [Action.DownloadAsPng]
2318
- * ```
2319
- */
2354
+ * The **Download** > **PNG** menu action for charts on a Liveboard
2355
+ * or Answer page.
2356
+ * Downloads a visualization or Answer as a PNG file.
2357
+ *
2358
+ * @example
2359
+ * ```js
2360
+ * disabledActions: [Action.DownloadAsPng]
2361
+ * ```
2362
+ */
2320
2363
  DownloadAsPng = 'downloadAsPng',
2321
2364
  /**
2322
- * The **Download** > **PDF** menu action on a Liveboard.
2323
- * Downloads a visualization or Answer as a PDF file.
2324
- * @example
2325
- * ```js
2326
- * disabledActions: [Action.DownloadAsPdf]
2327
- * ```
2328
- */
2365
+ * The **Download** > **PDF** menu action on a Liveboard.
2366
+ * Downloads a visualization or Answer as a PDF file.
2367
+ *
2368
+ * @example
2369
+ * ```js
2370
+ * disabledActions: [Action.DownloadAsPdf]
2371
+ * ```
2372
+ */
2329
2373
  DownloadAsPdf = 'downloadAsPdf',
2330
2374
  /**
2331
- * The **Download** > **CSV** menu action for tables on a Liveboard
2332
- * or Answer page.
2333
- * Downloads a visualization or Answer in the XLSX format.
2334
- * @example
2335
- * ```js
2336
- * disabledActions: [Action.DownloadAsCsv]
2337
- * ```
2338
- */
2375
+ * The **Download** > **CSV** menu action for tables on a Liveboard
2376
+ * or Answer page.
2377
+ * Downloads a visualization or Answer in the XLSX format.
2378
+ *
2379
+ * @example
2380
+ * ```js
2381
+ * disabledActions: [Action.DownloadAsCsv]
2382
+ * ```
2383
+ */
2339
2384
  DownloadAsCsv = 'downloadAsCSV',
2340
2385
  /**
2341
- * The **Download** > **XLSX** menu action for tables on a Liveboard
2342
- * or Answer page.
2343
- * Downloads a visualization or Answer in the XLSX format.
2344
- * @example
2345
- * ```js
2346
- * disabledActions: [Action.DownloadAsXlsx]
2347
- * ```
2348
- */
2386
+ * The **Download** > **XLSX** menu action for tables on a Liveboard
2387
+ * or Answer page.
2388
+ * Downloads a visualization or Answer in the XLSX format.
2389
+ *
2390
+ * @example
2391
+ * ```js
2392
+ * disabledActions: [Action.DownloadAsXlsx]
2393
+ * ```
2394
+ */
2349
2395
  DownloadAsXlsx = 'downloadAsXLSX',
2350
2396
  /**
2351
2397
  * @hidden
2352
2398
  */
2353
2399
  DownloadTrace = 'downloadTrace',
2354
2400
  /**
2355
- * The **Export TML** menu action on Liveboard, Answers
2356
- * Worksheets and Data Connections page.
2357
- * Exports an object as a TML file.
2358
- * @example
2359
- * ```js
2360
- * disabledActions: [Action.ExportTML]
2361
- * ```
2362
- */
2401
+ * The **Export TML** menu action on Liveboard, Answers
2402
+ * Worksheets and Data Connections page.
2403
+ * Exports an object as a TML file.
2404
+ *
2405
+ * @example
2406
+ * ```js
2407
+ * disabledActions: [Action.ExportTML]
2408
+ * ```
2409
+ */
2363
2410
  ExportTML = 'exportTSL',
2364
2411
  /**
2365
- * The **Import TML** menu action for Liveboards and Answers.
2366
- * Imports TML representation of ThoughtSpot objects.
2367
- * @example
2368
- * ```js
2369
- * disabledActions: [Action.ImportTML]
2370
- * ```
2371
- */
2412
+ * The **Import TML** menu action for Liveboards and Answers.
2413
+ * Imports TML representation of ThoughtSpot objects.
2414
+ *
2415
+ * @example
2416
+ * ```js
2417
+ * disabledActions: [Action.ImportTML]
2418
+ * ```
2419
+ */
2372
2420
  ImportTML = 'importTSL',
2373
2421
  /**
2374
2422
  * The **Update TML** menu action for Liveboards and Answers.
2375
2423
  * Update TML representation of ThoughtSpot objects.
2424
+ *
2376
2425
  * @example
2377
2426
  * ```js
2378
2427
  * disabledActions: [Action.UpdateTML]
@@ -2382,6 +2431,7 @@ export enum Action {
2382
2431
  /**
2383
2432
  * The **Edit TML** menu action for Liveboards and Answers.
2384
2433
  * Opens the TML editor.
2434
+ *
2385
2435
  * @example
2386
2436
  * ```js
2387
2437
  * disabledActions: [Action.EditTML]
@@ -2389,50 +2439,55 @@ export enum Action {
2389
2439
  */
2390
2440
  EditTML = 'editTSL',
2391
2441
  /**
2392
- * The **Present** menu action for Liveboards and Answers.
2393
- * Allows presenting a Liveboard or visualization in
2394
- * slideshow mode.
2395
- * @example
2396
- * ```js
2397
- * disabledActions: [Action.Present]
2398
- * ```
2399
- */
2442
+ * The **Present** menu action for Liveboards and Answers.
2443
+ * Allows presenting a Liveboard or visualization in
2444
+ * slideshow mode.
2445
+ *
2446
+ * @example
2447
+ * ```js
2448
+ * disabledActions: [Action.Present]
2449
+ * ```
2450
+ */
2400
2451
  Present = 'present',
2401
2452
  /**
2402
- * The tile resize options in the visualization menu.
2403
- * Allows switching between different preset layouts.
2404
- * @example
2405
- * ```js
2406
- * disabledActions: [Action.ToggleSize]
2407
- * ```
2408
- */
2453
+ * The tile resize options in the visualization menu.
2454
+ * Allows switching between different preset layouts.
2455
+ *
2456
+ * @example
2457
+ * ```js
2458
+ * disabledActions: [Action.ToggleSize]
2459
+ * ```
2460
+ */
2409
2461
  ToggleSize = 'toggleSize',
2410
2462
  /**
2411
- * The *Edit* action on the Liveboard page and in the
2412
- * visualization menu.
2413
- * Opens a Liveboard or visualization in edit mode.
2414
- * @example
2415
- * ```js
2416
- * disabledActions: [Action.Edit]
2417
- * ```
2418
- */
2463
+ * The *Edit* action on the Liveboard page and in the
2464
+ * visualization menu.
2465
+ * Opens a Liveboard or visualization in edit mode.
2466
+ *
2467
+ * @example
2468
+ * ```js
2469
+ * disabledActions: [Action.Edit]
2470
+ * ```
2471
+ */
2419
2472
  Edit = 'edit',
2420
2473
  /**
2421
- * The text edit option for Liveboard and visualization titles.
2422
- * @example
2423
- * ```js
2424
- * disabledActions: [Action.EditTitle]
2425
- * ```
2426
- */
2474
+ * The text edit option for Liveboard and visualization titles.
2475
+ *
2476
+ * @example
2477
+ * ```js
2478
+ * disabledActions: [Action.EditTitle]
2479
+ * ```
2480
+ */
2427
2481
  EditTitle = 'editTitle',
2428
2482
  /**
2429
- * The **Delete** menu action on Liveboards and visualizations.
2430
- * Deletes a Liveboard or a visualization from a Liveboard.
2431
- * @example
2432
- * ```js
2433
- * disabledActions: [Action.Remove]
2434
- * ```
2435
- */
2483
+ * The **Delete** menu action on Liveboards and visualizations.
2484
+ * Deletes a Liveboard or a visualization from a Liveboard.
2485
+ *
2486
+ * @example
2487
+ * ```js
2488
+ * disabledActions: [Action.Remove]
2489
+ * ```
2490
+ */
2436
2491
  Remove = 'delete',
2437
2492
  /**
2438
2493
  * @hidden
@@ -2455,15 +2510,16 @@ export enum Action {
2455
2510
  */
2456
2511
  PinboardInfo = 'pinboardInfo',
2457
2512
  /**
2458
- * The **Show Liveboard details** menu action on a Liveboard.
2459
- * Displays details such as the name, description, and
2460
- * author of the Liveboard, and timestamp of Liveboard creation
2461
- * and update.
2462
- * @example
2463
- * ```js
2464
- * disabledActions: [Action.LiveboardInfo]
2465
- * ```
2466
- */
2513
+ * The **Show Liveboard details** menu action on a Liveboard.
2514
+ * Displays details such as the name, description, and
2515
+ * author of the Liveboard, and timestamp of Liveboard creation
2516
+ * and update.
2517
+ *
2518
+ * @example
2519
+ * ```js
2520
+ * disabledActions: [Action.LiveboardInfo]
2521
+ * ```
2522
+ */
2467
2523
  LiveboardInfo = 'pinboardInfo',
2468
2524
  /**
2469
2525
  * @hidden
@@ -2474,13 +2530,14 @@ export enum Action {
2474
2530
  */
2475
2531
  DownloadEmbraceQueries = 'downloadEmbraceQueries',
2476
2532
  /**
2477
- * The **Pin** menu action on an Answer or
2478
- * Search results page.
2479
- * @example
2480
- * ```js
2481
- * disabledActions: [Action.Pin]
2482
- * ```
2483
- */
2533
+ * The **Pin** menu action on an Answer or
2534
+ * Search results page.
2535
+ *
2536
+ * @example
2537
+ * ```js
2538
+ * disabledActions: [Action.Pin]
2539
+ * ```
2540
+ */
2484
2541
  Pin = 'pin',
2485
2542
  /**
2486
2543
  * @hidden
@@ -2488,6 +2545,7 @@ export enum Action {
2488
2545
  AnalysisInfo = 'analysisInfo',
2489
2546
  /**
2490
2547
  * The **Schedule** menu action on a Liveboard.
2548
+ *
2491
2549
  * @example
2492
2550
  * ```js
2493
2551
  * disabledActions: [Action.Subscription]
@@ -2495,26 +2553,29 @@ export enum Action {
2495
2553
  */
2496
2554
  Subscription = 'subscription',
2497
2555
  /**
2498
- * The **Explore** action on Liveboard visualizations
2499
- * @example
2500
- * ```js
2501
- * disabledActions: [Action.Explore]
2502
- * ```
2503
- */
2556
+ * The **Explore** action on Liveboard visualizations
2557
+ *
2558
+ * @example
2559
+ * ```js
2560
+ * disabledActions: [Action.Explore]
2561
+ * ```
2562
+ */
2504
2563
  Explore = 'explore',
2505
2564
  /**
2506
- * The action to include data points on a drilled-down Answer
2507
- * or visualization
2508
- * @example
2509
- * ```js
2510
- * disabledActions: [Action.DrillInclude]
2511
- * ```
2512
- */
2565
+ * The action to include data points on a drilled-down Answer
2566
+ * or visualization
2567
+ *
2568
+ * @example
2569
+ * ```js
2570
+ * disabledActions: [Action.DrillInclude]
2571
+ * ```
2572
+ */
2513
2573
 
2514
2574
  DrillInclude = 'context-menu-item-include',
2515
2575
  /**
2516
2576
  * The action to exclude data points on a drilled-down Answer
2517
2577
  * or visualization
2578
+ *
2518
2579
  * @example
2519
2580
  * ```js
2520
2581
  * disabledActions: [Action.DrillInclude]
@@ -2525,6 +2586,7 @@ export enum Action {
2525
2586
  * The **Copy to clipboard** menu action on tables in an Answer
2526
2587
  * or Liveboard.
2527
2588
  * Copies the selected data point.
2589
+ *
2528
2590
  * @example
2529
2591
  * ```js
2530
2592
  * disabledActions: [Action.CopyToClipboard]
@@ -2542,6 +2604,7 @@ export enum Action {
2542
2604
  * The **Drill down** menu action on Answers and Liveboard
2543
2605
  * visualizations.
2544
2606
  * Allows drilling down to a specific data point on a chart or table.
2607
+ *
2545
2608
  * @example
2546
2609
  * ```js
2547
2610
  * disabledActions: [Action.DrillDown]
@@ -2551,6 +2614,7 @@ export enum Action {
2551
2614
  /**
2552
2615
  * The request access action on Liveboards.
2553
2616
  * Allows users with view permissions to request edit access to a Liveboard.
2617
+ *
2554
2618
  * @example
2555
2619
  * ```js
2556
2620
  * disabledActions: [Action.RequestAccess]
@@ -2560,6 +2624,7 @@ export enum Action {
2560
2624
  /**
2561
2625
  * The **Query visualizer** and **Query SQL** buttons in Query details panel
2562
2626
  * of the Answer page
2627
+ *
2563
2628
  * @example
2564
2629
  * ```js
2565
2630
  * disabledActions: [Action.QueryDetailsButtons]
@@ -2568,6 +2633,7 @@ export enum Action {
2568
2633
  QueryDetailsButtons = 'QueryDetailsButtons',
2569
2634
  /**
2570
2635
  * The **Delete** action for Answers.
2636
+ *
2571
2637
  * @example
2572
2638
  * ```js
2573
2639
  * disabledActions: [Action.AnswerDelete]
@@ -2577,6 +2643,7 @@ export enum Action {
2577
2643
  AnswerDelete = 'onDeleteAnswer',
2578
2644
  /**
2579
2645
  * The Chart switcher icon on Answer and visualization pages.
2646
+ *
2580
2647
  * @example
2581
2648
  * ```js
2582
2649
  * disabledActions: [Action.AnswerChartSwitcher]
@@ -2586,6 +2653,7 @@ export enum Action {
2586
2653
  AnswerChartSwitcher = 'answerChartSwitcher',
2587
2654
  /**
2588
2655
  * Favorites icon (*) on Answers, Liveboard, and Data pages
2656
+ *
2589
2657
  * @example
2590
2658
  * ```js
2591
2659
  * disabledActions: [Action.AddToFavorites]
@@ -2595,6 +2663,7 @@ export enum Action {
2595
2663
  AddToFavorites = 'addToFavorites',
2596
2664
  /**
2597
2665
  * The edit icon on Liveboards (Classic experience).
2666
+ *
2598
2667
  * @example
2599
2668
  * ```js
2600
2669
  * disabledActions: [Action.EditDetails]
@@ -2604,6 +2673,7 @@ export enum Action {
2604
2673
  EditDetails = 'editDetails',
2605
2674
  /**
2606
2675
  * The Create alert action on KPI charts.
2676
+ *
2607
2677
  * @example
2608
2678
  * ```js
2609
2679
  * disabledActions: [Action.CreateMonitor ]
@@ -2622,6 +2692,7 @@ export enum Action {
2622
2692
  /**
2623
2693
  * The **Sync to sheets** action on Answers and Liveboard visualizations.
2624
2694
  * Allows sending data to a Google Sheet.
2695
+ *
2625
2696
  * @example
2626
2697
  * ```js
2627
2698
  * disabledActions: [Action.SyncToSheets]
@@ -2633,6 +2704,7 @@ export enum Action {
2633
2704
  * The **Sync to other apps** action on Answers and Liveboard visualizations.
2634
2705
  * Allows sending data to third-party apps like Slack, Salesforce,
2635
2706
  * Microsoft Teams, and so on.
2707
+ *
2636
2708
  * @example
2637
2709
  * ```js
2638
2710
  * disabledActions: [Action.SyncToOtherApps]
@@ -2643,6 +2715,7 @@ export enum Action {
2643
2715
  /**
2644
2716
  * The **Manage pipelines** action on Answers and Liveboard visualizations.
2645
2717
  * Allows users to manage data sync pipelines to third-party apps.
2718
+ *
2646
2719
  * @example
2647
2720
  * ```js
2648
2721
  * disabledActions: [Action.SyncToOtherApps]
@@ -2653,6 +2726,7 @@ export enum Action {
2653
2726
  /**
2654
2727
  * The **Filter** action on Liveboard visualizations.
2655
2728
  * Allows users to apply cross-filters on a Liveboard.
2729
+ *
2656
2730
  * @example
2657
2731
  * ```js
2658
2732
  * disabledActions: [Action.CrossFilter]
@@ -2664,6 +2738,7 @@ export enum Action {
2664
2738
  * The **Remove** action that appears when cross filters are applied
2665
2739
  * on a Liveboard.
2666
2740
  * Removes filters applied o a visualization.
2741
+ *
2667
2742
  * @example
2668
2743
  * ```js
2669
2744
  * disabledActions: [Action.RemoveCrossFilter]
@@ -2675,6 +2750,7 @@ export enum Action {
2675
2750
  * The **Aggregate** option in the chart axis or the
2676
2751
  * table column customization menu.
2677
2752
  * Provides aggregation options to analyze the data on a chart or table.
2753
+ *
2678
2754
  * @example
2679
2755
  * ```js
2680
2756
  * disabledActions: [Action.AxisMenuAggregate]
@@ -2686,6 +2762,7 @@ export enum Action {
2686
2762
  * The **Time bucket** option in the chart axis or table column
2687
2763
  * customization menu.
2688
2764
  * Allows defining time metric for date comparison.
2765
+ *
2689
2766
  * @example
2690
2767
  * ```js
2691
2768
  * disabledActions: [Action.AxisMenuTimeBucket]
@@ -2696,6 +2773,7 @@ export enum Action {
2696
2773
  /**
2697
2774
  * The **Filter** action in the chart axis or table column
2698
2775
  * customization menu.
2776
+ *
2699
2777
  * @example
2700
2778
  * ```js
2701
2779
  * disabledActions: [Action.AxisMenuFilter]
@@ -2707,6 +2785,7 @@ export enum Action {
2707
2785
  * The **Conditional formatting** action on chart or table.
2708
2786
  * Allows adding rules for conditional formatting of data
2709
2787
  * points on a chart or table.
2788
+ *
2710
2789
  * @example
2711
2790
  * ```js
2712
2791
  * disabledActions: [Action.AxisMenuConditionalFormat]
@@ -2718,6 +2797,7 @@ export enum Action {
2718
2797
  * The **Sort** menu action on a table or chart axis
2719
2798
  * Sorts data in ascending or descending order.
2720
2799
  * Allows adding, editing, or removing filters.
2800
+ *
2721
2801
  * @example
2722
2802
  * ```js
2723
2803
  * disabledActions: [Action.AxisMenuConditionalFormat]
@@ -2730,6 +2810,7 @@ export enum Action {
2730
2810
  * customization menu.
2731
2811
  * Allows grouping data points if the axes use the same
2732
2812
  * unit of measurement and a similar scale.
2813
+ *
2733
2814
  * @example
2734
2815
  * ```js
2735
2816
  * disabledActions: [Action.AxisMenuGroup]
@@ -2741,6 +2822,7 @@ export enum Action {
2741
2822
  * The **Position** option in the axis customization menu.
2742
2823
  * Allows changing the position of the axis to the
2743
2824
  * left or right side of the chart.
2825
+ *
2744
2826
  * @example
2745
2827
  * ```js
2746
2828
  * disabledActions: [Action.AxisMenuPosition]
@@ -2751,6 +2833,7 @@ export enum Action {
2751
2833
  /**
2752
2834
  * The **Rename** option in the chart axis or table column customization menu.
2753
2835
  * Renames the axis label on a chart or the column header on a table.
2836
+ *
2754
2837
  * @example
2755
2838
  * ```js
2756
2839
  * disabledActions: [Action.AxisMenuRename]
@@ -2762,6 +2845,7 @@ export enum Action {
2762
2845
  * The **Edit** action in the axis customization menu.
2763
2846
  * Allows editing the axis name, position, minimum and maximum values,
2764
2847
  * and format of a column.
2848
+ *
2765
2849
  * @example
2766
2850
  * ```js
2767
2851
  * disabledActions: [Action.AxisMenuEdit]
@@ -2772,6 +2856,7 @@ export enum Action {
2772
2856
  /**
2773
2857
  * The **Number format** action to customize the format of
2774
2858
  * the data labels on a chart or table.
2859
+ *
2775
2860
  * @example
2776
2861
  * ```js
2777
2862
  * disabledActions: [Action.AxisMenuNumberFormat]
@@ -2782,6 +2867,7 @@ export enum Action {
2782
2867
  /**
2783
2868
  * The **Text wrapping** action on a table.
2784
2869
  * Wraps or clips column text on a table.
2870
+ *
2785
2871
  * @example
2786
2872
  * ```js
2787
2873
  * disabledActions: [Action.AxisMenuTextWrapping]
@@ -2794,6 +2880,7 @@ export enum Action {
2794
2880
  * customization menu.
2795
2881
  * Removes the data labels from a chart or the column of a
2796
2882
  * table visualization.
2883
+ *
2797
2884
  * @example
2798
2885
  * ```js
2799
2886
  * disabledActions: [Action.AxisMenuRemove]
@@ -2808,6 +2895,7 @@ export enum Action {
2808
2895
  /**
2809
2896
  * The **Rename** menu action on Liveboards and visualizations.
2810
2897
  * Allows renaming a Liveboard or visualization.
2898
+ *
2811
2899
  * @example
2812
2900
  * ```js
2813
2901
  * disabledActions: [Action.RenameModalTitleDescription]
@@ -2824,13 +2912,29 @@ export enum Action {
2824
2912
  */
2825
2913
  MarkAsVerified = 'markAsVerified',
2826
2914
  /**
2827
- * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
2915
+ * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
2828
2916
  */
2829
2917
  AddTab = 'addTab',
2830
2918
  /**
2831
2919
  * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
2832
2920
  */
2833
2921
  EnableContextualChangeAnalysis = 'enableContextualChangeAnalysis',
2922
+ /**
2923
+ * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
2924
+ */
2925
+ ShowSageQuery = 'showSageQuery',
2926
+ /**
2927
+ * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
2928
+ */
2929
+ EditSageAnswer = 'editSageAnswer',
2930
+ /**
2931
+ * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
2932
+ */
2933
+ SageAnswerFeedback = 'sageAnswerFeedback',
2934
+ /**
2935
+ * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
2936
+ */
2937
+ ModifySageAnswer = 'modifySageAnswer',
2834
2938
  }
2835
2939
 
2836
2940
  export interface SessionInterface {