@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
@@ -253,6 +253,9 @@ export interface CustomStyles {
253
253
  export interface CustomisationsInterface {
254
254
  style?: CustomStyles;
255
255
  content?: {
256
+ /**
257
+ * @version SDK: 1.26.0 | 9.7.0.cl
258
+ */
256
259
  strings?: Record<string, any>;
257
260
  [key: string]: any;
258
261
  };
@@ -660,21 +663,21 @@ export interface ViewConfig {
660
663
  /**
661
664
  * Boolean to hide liveboard header
662
665
  *
663
- * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
666
+ * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
664
667
  * @default false
665
668
  */
666
669
  hideLiveboardHeader?: boolean;
667
670
  /**
668
671
  * Boolean to show liveboard title
669
672
  *
670
- * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
673
+ * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
671
674
  * @default false
672
675
  */
673
676
  showLiveboardTitle?: boolean;
674
677
  /**
675
678
  * Boolean to show liveboard description
676
679
  *
677
- * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
680
+ * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
678
681
  * @default false
679
682
  */
680
683
  showLiveboardDescription?: boolean;
@@ -692,7 +695,7 @@ export interface ViewConfig {
692
695
  * 'f547ec54-2a37-4516-a222-2b06719af726']
693
696
  * });
694
697
  * ```
695
- * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
698
+ * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
696
699
  */
697
700
  hiddenTabs?: string[];
698
701
  /**
@@ -711,7 +714,7 @@ export interface ViewConfig {
711
714
  * 'f547ec54-2a37-4516-a222-2b06719af726']
712
715
  * });
713
716
  * ```
714
- * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
717
+ * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
715
718
  */
716
719
  visibleTabs?: string[];
717
720
  }
@@ -1273,7 +1276,19 @@ export declare enum EmbedEvent {
1273
1276
  *
1274
1277
  * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
1275
1278
  */
1276
- FilterChanged = "filterChanged"
1279
+ FilterChanged = "filterChanged",
1280
+ /**
1281
+ * Emitted when a user click on Go button in Sage Embed
1282
+ *
1283
+ * @version SDK : 1.27.0 | Thoughtspot: 9.7.0.cl
1284
+ */
1285
+ SageEmbedQuery = "sageEmbedQuery",
1286
+ /**
1287
+ * Emitten when a user select data source in Sage Embed
1288
+ *
1289
+ * @version SDK : 1.27.0 | Thoughtspot: 9.7.0.cl
1290
+ */
1291
+ SageWorksheetUpdated = "sageWorksheetUpdated"
1277
1292
  }
1278
1293
  /**
1279
1294
  * Event types that can be triggered by the host application
@@ -1302,6 +1317,7 @@ export declare enum HostEvent {
1302
1317
  * Triggers a search query in AppEmbed and SearchEmbed
1303
1318
  * deployments.
1304
1319
  * Includes the following properties:
1320
+ *
1305
1321
  * @param - dataSourceIds - The data source GUID to Search on
1306
1322
  * - Although an array, only a single source
1307
1323
  * is supported.
@@ -1320,6 +1336,7 @@ export declare enum HostEvent {
1320
1336
  /**
1321
1337
  * Triggers a drill on certain points of the specified column
1322
1338
  * Includes the following properties:
1339
+ *
1323
1340
  * @param - points - an object containing selectedPoints/clickedPoints
1324
1341
  * to drill to. For example, { selectedPoints: []}
1325
1342
  * @param - columnGuid - Optional. GUID of the column to drill
@@ -1384,18 +1401,19 @@ export declare enum HostEvent {
1384
1401
  */
1385
1402
  SetActiveTab = "SetActiveTab",
1386
1403
  /**
1387
- * Updates runtime filters applied on a Saved Answer or Liveboard. The
1388
- * runtime filters passed here are appended to the existing runtime
1389
- * filters.
1390
- * Pass an array of runtime filters with the following attributes:
1391
- * `columnName`
1392
- * _String_. The name of the column to filter on.
1393
- * `operator`
1394
- * Runtime filter operator to apply. For information,
1395
- * see [Runtime filter operators](https://developers.thoughtspot.com/docs/?pageid=runtime-filters#rtOperator).
1396
- * `values`
1397
- * List of operands. Some operators such as EQ, LE allow a single value, whereas operators
1398
- * such as BW and IN accept multiple operands.
1404
+ * Updates runtime filters applied on a Saved Answer or Liveboard. The
1405
+ * runtime filters passed here are appended to the existing runtime
1406
+ * filters.
1407
+ * Pass an array of runtime filters with the following attributes:
1408
+ * `columnName`
1409
+ * _String_. The name of the column to filter on.
1410
+ * `operator`
1411
+ * Runtime filter operator to apply. For information,
1412
+ * see [Runtime filter operators](https://developers.thoughtspot.com/docs/?pageid=runtime-filters#rtOperator).
1413
+ * `values`
1414
+ * List of operands. Some operators such as EQ, LE allow a single value, whereas
1415
+ * operators such as BW and IN accept multiple operands.
1416
+ *
1399
1417
  * @param - {@link RuntimeFilter}[] an array of {@link RuntimeFilter} Types.
1400
1418
  * @example
1401
1419
  * ```js
@@ -1411,6 +1429,7 @@ export declare enum HostEvent {
1411
1429
  /**
1412
1430
  * Navigate to a specific page in the embedded application without reloading the page.
1413
1431
  * This is the same as calling `appEmbed.navigateToPage(path, true)`
1432
+ *
1414
1433
  * @param - path - the path to navigate to (can be a number[1/-1] to go forward/back)
1415
1434
  * @example
1416
1435
  * ```js
@@ -1734,6 +1753,7 @@ export declare enum HostEvent {
1734
1753
  /**
1735
1754
  * Triggers the **SpotIQ analyze** action on visualization
1736
1755
  * or search.
1756
+ *
1737
1757
  * @param - Liveboard embed takes `vizId` as a
1738
1758
  * key. Can be left undefined when embedding Search or
1739
1759
  * visualization.
@@ -1773,6 +1793,7 @@ export declare enum HostEvent {
1773
1793
  /**
1774
1794
  * Triggers the **Download** > **PNG** action on
1775
1795
  * charts in the embedded view.
1796
+ *
1776
1797
  * @example
1777
1798
  * ```js
1778
1799
  * liveboardEmbed.trigger(HostEvent.DownloadAsPng,
@@ -1806,6 +1827,7 @@ export declare enum HostEvent {
1806
1827
  /**
1807
1828
  * Triggers the **Download** > **XLSX** action on tables
1808
1829
  * in the embedded view.
1830
+ *
1809
1831
  * @example
1810
1832
  * ```js
1811
1833
  * liveboardEmbed.trigger(HostEvent.DownloadAsXlsx, {vizId:
@@ -1837,6 +1859,7 @@ export declare enum HostEvent {
1837
1859
  /**
1838
1860
  * Triggers the **Save** action on a Liveboard or Answer.
1839
1861
  * Saves the changes.
1862
+ *
1840
1863
  * @example
1841
1864
  * ```js
1842
1865
  * liveboardEmbed.trigger(HostEvent.Save)
@@ -1850,6 +1873,7 @@ export declare enum HostEvent {
1850
1873
  /**
1851
1874
  * Triggers the **Sync to Sheets** action on an embedded visualization or Answer
1852
1875
  * Sends data from an Answer or Liveboard visualization to a Google sheet.
1876
+ *
1853
1877
  * @param - an object with `vizId` as a key
1854
1878
  * @example
1855
1879
  * ```js
@@ -1866,6 +1890,7 @@ export declare enum HostEvent {
1866
1890
  * Triggers the **Sync to Other Apps** action on an embedded visualization or Answer
1867
1891
  * Sends data from an Answer or Liveboard visualization to third-party apps such
1868
1892
  * as Slack, Salesforce, Microsoft Teams, ServiceNow and so on.
1893
+ *
1869
1894
  * @param - an object with vizId as a key
1870
1895
  * @example
1871
1896
  * ```js
@@ -1882,6 +1907,7 @@ export declare enum HostEvent {
1882
1907
  * Triggers the **Manage pipelines** action on an embedded
1883
1908
  * visualization or Answer.
1884
1909
  * Allows users to manage ThoughtSpot Sync pipelines.
1910
+ *
1885
1911
  * @param - an object with `vizId` as a key
1886
1912
  * @example
1887
1913
  * ```js
@@ -1926,6 +1952,19 @@ export declare enum HostEvent {
1926
1952
  * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
1927
1953
  */
1928
1954
  UpdateFilters = "updateFilters",
1955
+ /**
1956
+ * Get Tab for the current Liveboard.
1957
+ *
1958
+ * @example
1959
+ * ```js
1960
+ * liveboardEmbed.trigger(HostEvent.GetTabs).then((tabDetails) => {
1961
+ * console.log(
1962
+ * tabDetails // TabDetails of current LB
1963
+ * );
1964
+ * })
1965
+ * ```
1966
+ * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl
1967
+ */
1929
1968
  GetTabs = "getTabs",
1930
1969
  /**
1931
1970
  * Set the visible Tabs on a Liveboard.
@@ -1938,7 +1977,7 @@ export declare enum HostEvent {
1938
1977
  * '430496d6-6903-4601-937e-2c691821af3c',
1939
1978
  * 'f547ec54-2a37-4516-a222-2b06719af726'])
1940
1979
  * ```
1941
- * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
1980
+ * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
1942
1981
  */
1943
1982
  SetVisibleTabs = "SetPinboardVisibleTabs",
1944
1983
  /**
@@ -1952,7 +1991,7 @@ export declare enum HostEvent {
1952
1991
  * '630496d6-6903-4601-937e-2c691821af3c',
1953
1992
  * 'i547ec54-2a37-4516-a222-2b06719af726'])
1954
1993
  * ```
1955
- * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
1994
+ * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
1956
1995
  */
1957
1996
  SetHiddenTabs = "SetPinboardHiddenTabs"
1958
1997
  }
@@ -2034,7 +2073,10 @@ export declare enum Param {
2034
2073
  ShowLiveboardTitle = "showLiveboardTitle",
2035
2074
  HiddenTabs = "hideTabs",
2036
2075
  VisibleTabs = "visibleTabs",
2037
- HideTabPanel = "hideTabPanel"
2076
+ HideTabPanel = "hideTabPanel",
2077
+ HideSampleQuestions = "hideSampleQuestions",
2078
+ WorksheetId = "worksheetId",
2079
+ Query = "query,"
2038
2080
  }
2039
2081
  /**
2040
2082
  * ThoughtSpot application pages include actions and menu commands
@@ -2043,6 +2085,7 @@ export declare enum Param {
2043
2085
  * specific actions in the embedded view, define the Action
2044
2086
  * enumeration members in the `disabledActions`, `visibleActions`,
2045
2087
  * or `hiddenActions` array.
2088
+ *
2046
2089
  * @example
2047
2090
  * ```js
2048
2091
  * const embed = new LiveboardEmbed('#embed-container', {
@@ -2061,12 +2104,12 @@ export declare enum Param {
2061
2104
  * hiddenActions: [Action.Edit, ActionAction.Explore],
2062
2105
  * })
2063
2106
  * ```
2064
-
2065
2107
  */
2066
2108
  export declare enum Action {
2067
2109
  /**
2068
2110
  * The **Save** action on an Answer or Liveboard.
2069
2111
  * Allows users to save the changes.
2112
+ *
2070
2113
  * @example
2071
2114
  * ```js
2072
2115
  * disabledActions: [Action.SaveAsView]
@@ -2082,136 +2125,146 @@ export declare enum Action {
2082
2125
  */
2083
2126
  SaveUntitled = "saveUntitled",
2084
2127
  /**
2085
- * The **Save as View** action on the Answer
2086
- * page. Saves an Answer as a View object.
2087
- *
2088
- * @example
2089
- * ```js
2090
- * disabledActions: [Action.SaveAsView]
2091
- * ```
2092
- */
2128
+ * The **Save as View** action on the Answer
2129
+ * page. Saves an Answer as a View object.
2130
+ *
2131
+ * @example
2132
+ * ```js
2133
+ * disabledActions: [Action.SaveAsView]
2134
+ * ```
2135
+ */
2093
2136
  SaveAsView = "saveAsView",
2094
2137
  /**
2095
- * The **Make a copy** action on a Liveboard or Answer
2096
- * page.
2097
- * Creates a copy of the Liveboard, visualization,
2098
- * or Answer.
2099
- *
2100
- * @example
2101
- * ```js
2102
- * disabledActions: [Action.MakeACopy]
2103
- * ```
2104
- */
2138
+ * The **Make a copy** action on a Liveboard or Answer
2139
+ * page.
2140
+ * Creates a copy of the Liveboard, visualization,
2141
+ * or Answer.
2142
+ *
2143
+ * @example
2144
+ * ```js
2145
+ * disabledActions: [Action.MakeACopy]
2146
+ * ```
2147
+ */
2105
2148
  MakeACopy = "makeACopy",
2106
2149
  /**
2107
- * The **Copy and Edit** action on a Liveboard.
2108
- * This action is now replaced with `Action.MakeACopy`.
2109
- *
2110
- * @example
2111
- * ```js
2112
- * disabledActions: [Action.EditACopy]
2113
- * ```
2114
- */
2150
+ * The **Copy and Edit** action on a Liveboard.
2151
+ * This action is now replaced with `Action.MakeACopy`.
2152
+ *
2153
+ * @example
2154
+ * ```js
2155
+ * disabledActions: [Action.EditACopy]
2156
+ * ```
2157
+ */
2115
2158
  EditACopy = "editACopy",
2116
2159
  /**
2117
- * The **Copy link** menu action on a Liveboard visualization.
2118
- * Copies the visualization URL
2119
- * @example
2120
- * ```js
2121
- * disabledActions: [Action.CopyLink]
2122
- * ```
2123
- */
2160
+ * The **Copy link** menu action on a Liveboard visualization.
2161
+ * Copies the visualization URL
2162
+ *
2163
+ * @example
2164
+ * ```js
2165
+ * disabledActions: [Action.CopyLink]
2166
+ * ```
2167
+ */
2124
2168
  CopyLink = "embedDocument",
2125
2169
  /**
2126
2170
  * @hidden
2127
2171
  */
2128
2172
  ResetLayout = "resetLayout",
2129
2173
  /**
2130
- * The **Schedule** menu action on a Liveboard.
2131
- * Allows scheduling a Liveboard notification.
2132
- * @example
2133
- * ```js
2134
- * disabledActions: [Action.Schedule]
2135
- * ```
2136
- */
2174
+ * The **Schedule** menu action on a Liveboard.
2175
+ * Allows scheduling a Liveboard notification.
2176
+ *
2177
+ * @example
2178
+ * ```js
2179
+ * disabledActions: [Action.Schedule]
2180
+ * ```
2181
+ */
2137
2182
  Schedule = "subscription",
2138
2183
  /**
2139
- * The **Manage schedules** menu action on a Liveboard.
2140
- * Allows users to manage scheduled Liveboard jobs.
2141
- * @example
2142
- * ```js
2143
- * disabledActions: [Action.SchedulesList]
2144
- * ```
2145
- */
2184
+ * The **Manage schedules** menu action on a Liveboard.
2185
+ * Allows users to manage scheduled Liveboard jobs.
2186
+ *
2187
+ * @example
2188
+ * ```js
2189
+ * disabledActions: [Action.SchedulesList]
2190
+ * ```
2191
+ */
2146
2192
  SchedulesList = "schedule-list",
2147
2193
  /**
2148
- * The **Share** action on a Liveboard, Answer, or Worksheet.
2149
- * Allows users to share an object with other users and groups.
2150
- * @example
2151
- * ```js
2152
- * disabledActions: [Action.Share]
2153
- * ```
2154
- */
2194
+ * The **Share** action on a Liveboard, Answer, or Worksheet.
2195
+ * Allows users to share an object with other users and groups.
2196
+ *
2197
+ * @example
2198
+ * ```js
2199
+ * disabledActions: [Action.Share]
2200
+ * ```
2201
+ */
2155
2202
  Share = "share",
2156
2203
  /**
2157
- * The **Add filter** action on a Liveboard and Search page.
2158
- * Allows adding filters to Answers and visualizations on a Liveboard.
2159
- * @example
2160
- * ```js
2161
- * disabledActions: [Action.AddFilter]
2162
- * ```
2163
- */
2204
+ * The **Add filter** action on a Liveboard and Search page.
2205
+ * Allows adding filters to Answers and visualizations on a Liveboard.
2206
+ *
2207
+ * @example
2208
+ * ```js
2209
+ * disabledActions: [Action.AddFilter]
2210
+ * ```
2211
+ */
2164
2212
  AddFilter = "addFilter",
2165
2213
  /**
2166
- * Filter configuration options on a Liveboard and Search page.
2167
- * Allows configuring filter options when adding filters to a
2168
- * Liveboard or Answer.
2169
- * @example
2170
- * ```js
2171
- * disabledActions: [Action.ConfigureFilter]
2172
- * ```
2173
- */
2214
+ * Filter configuration options on a Liveboard and Search page.
2215
+ * Allows configuring filter options when adding filters to a
2216
+ * Liveboard or Answer.
2217
+ *
2218
+ * @example
2219
+ * ```js
2220
+ * disabledActions: [Action.ConfigureFilter]
2221
+ * ```
2222
+ */
2174
2223
  ConfigureFilter = "configureFilter",
2175
2224
  CollapseDataSources = "collapseDataSources",
2176
2225
  /**
2177
- * The **Choose sources** button on Search page.
2178
- * Allows selecting data sources for search queries.
2179
- * @example
2180
- * ```js
2181
- * disabledActions: [Action.ChooseDataSources]
2182
- * ```
2183
- */
2226
+ * The **Choose sources** button on Search page.
2227
+ * Allows selecting data sources for search queries.
2228
+ *
2229
+ * @example
2230
+ * ```js
2231
+ * disabledActions: [Action.ChooseDataSources]
2232
+ * ```
2233
+ */
2184
2234
  ChooseDataSources = "chooseDataSources",
2185
2235
  /**
2186
- * The **Create formula** action on a Search or Answer page.
2187
- * Allows adding formulas to an Answer.
2188
- * @example
2189
- * ```js
2190
- * disabledActions: [Action.AddFormula]
2191
- * ```
2192
- */
2236
+ * The **Create formula** action on a Search or Answer page.
2237
+ * Allows adding formulas to an Answer.
2238
+ *
2239
+ * @example
2240
+ * ```js
2241
+ * disabledActions: [Action.AddFormula]
2242
+ * ```
2243
+ */
2193
2244
  AddFormula = "addFormula",
2194
2245
  /**
2195
- * The **Add parameter** action on a Liveboard or Answer.
2196
- * Allows adding Parameters to a Liveboard or Answer.
2197
- * @example
2198
- * ```js
2199
- * disabledActions: [Action.AddParameter]
2200
- * ```
2201
- */
2246
+ * The **Add parameter** action on a Liveboard or Answer.
2247
+ * Allows adding Parameters to a Liveboard or Answer.
2248
+ *
2249
+ * @example
2250
+ * ```js
2251
+ * disabledActions: [Action.AddParameter]
2252
+ * ```
2253
+ */
2202
2254
  AddParameter = "addParameter",
2203
2255
  /**
2204
2256
  * @hidden
2205
2257
  */
2206
2258
  SearchOnTop = "searchOnTop",
2207
2259
  /**
2208
- * The **SpotIQ analyze** menu action on a visualization or
2209
- * Answer page.
2210
- * @example
2211
- * ```js
2212
- * disabledActions: [Action.SpotIQAnalyze]
2213
- * ```
2214
- */
2260
+ * The **SpotIQ analyze** menu action on a visualization or
2261
+ * Answer page.
2262
+ *
2263
+ * @example
2264
+ * ```js
2265
+ * disabledActions: [Action.SpotIQAnalyze]
2266
+ * ```
2267
+ */
2215
2268
  SpotIQAnalyze = "spotIQAnalyze",
2216
2269
  /**
2217
2270
  * @hidden
@@ -2227,89 +2280,98 @@ export declare enum Action {
2227
2280
  */
2228
2281
  ReplaySearch = "replaySearch",
2229
2282
  /**
2230
- * The **Show underlying data** menu action on a visualization or
2231
- * Answer page.
2232
- * @example
2233
- * ```js
2234
- * disabledActions: [Action.ShowUnderlyingData]
2235
- * ```
2236
- */
2283
+ * The **Show underlying data** menu action on a visualization or
2284
+ * Answer page.
2285
+ *
2286
+ * @example
2287
+ * ```js
2288
+ * disabledActions: [Action.ShowUnderlyingData]
2289
+ * ```
2290
+ */
2237
2291
  ShowUnderlyingData = "showUnderlyingData",
2238
2292
  /**
2239
- * The **Download** menu action on Liveboard visualizations
2240
- * and Answers.
2241
- * Allows downloading a visualization or Answer.
2242
- * @example
2243
- * ```js
2244
- * disabledActions: [Action.DownloadAsPng]
2245
- * ```
2246
- */
2293
+ * The **Download** menu action on Liveboard visualizations
2294
+ * and Answers.
2295
+ * Allows downloading a visualization or Answer.
2296
+ *
2297
+ * @example
2298
+ * ```js
2299
+ * disabledActions: [Action.DownloadAsPng]
2300
+ * ```
2301
+ */
2247
2302
  Download = "download",
2248
2303
  /**
2249
- * The **Download** > **PNG** menu action for charts on a Liveboard
2250
- * or Answer page.
2251
- * Downloads a visualization or Answer as a PNG file.
2252
- * @example
2253
- * ```js
2254
- * disabledActions: [Action.DownloadAsPng]
2255
- * ```
2256
- */
2304
+ * The **Download** > **PNG** menu action for charts on a Liveboard
2305
+ * or Answer page.
2306
+ * Downloads a visualization or Answer as a PNG file.
2307
+ *
2308
+ * @example
2309
+ * ```js
2310
+ * disabledActions: [Action.DownloadAsPng]
2311
+ * ```
2312
+ */
2257
2313
  DownloadAsPng = "downloadAsPng",
2258
2314
  /**
2259
- * The **Download** > **PDF** menu action on a Liveboard.
2260
- * Downloads a visualization or Answer as a PDF file.
2261
- * @example
2262
- * ```js
2263
- * disabledActions: [Action.DownloadAsPdf]
2264
- * ```
2265
- */
2315
+ * The **Download** > **PDF** menu action on a Liveboard.
2316
+ * Downloads a visualization or Answer as a PDF file.
2317
+ *
2318
+ * @example
2319
+ * ```js
2320
+ * disabledActions: [Action.DownloadAsPdf]
2321
+ * ```
2322
+ */
2266
2323
  DownloadAsPdf = "downloadAsPdf",
2267
2324
  /**
2268
- * The **Download** > **CSV** menu action for tables on a Liveboard
2269
- * or Answer page.
2270
- * Downloads a visualization or Answer in the XLSX format.
2271
- * @example
2272
- * ```js
2273
- * disabledActions: [Action.DownloadAsCsv]
2274
- * ```
2275
- */
2325
+ * The **Download** > **CSV** menu action for tables on a Liveboard
2326
+ * or Answer page.
2327
+ * Downloads a visualization or Answer in the XLSX format.
2328
+ *
2329
+ * @example
2330
+ * ```js
2331
+ * disabledActions: [Action.DownloadAsCsv]
2332
+ * ```
2333
+ */
2276
2334
  DownloadAsCsv = "downloadAsCSV",
2277
2335
  /**
2278
- * The **Download** > **XLSX** menu action for tables on a Liveboard
2279
- * or Answer page.
2280
- * Downloads a visualization or Answer in the XLSX format.
2281
- * @example
2282
- * ```js
2283
- * disabledActions: [Action.DownloadAsXlsx]
2284
- * ```
2285
- */
2336
+ * The **Download** > **XLSX** menu action for tables on a Liveboard
2337
+ * or Answer page.
2338
+ * Downloads a visualization or Answer in the XLSX format.
2339
+ *
2340
+ * @example
2341
+ * ```js
2342
+ * disabledActions: [Action.DownloadAsXlsx]
2343
+ * ```
2344
+ */
2286
2345
  DownloadAsXlsx = "downloadAsXLSX",
2287
2346
  /**
2288
2347
  * @hidden
2289
2348
  */
2290
2349
  DownloadTrace = "downloadTrace",
2291
2350
  /**
2292
- * The **Export TML** menu action on Liveboard, Answers
2293
- * Worksheets and Data Connections page.
2294
- * Exports an object as a TML file.
2295
- * @example
2296
- * ```js
2297
- * disabledActions: [Action.ExportTML]
2298
- * ```
2299
- */
2351
+ * The **Export TML** menu action on Liveboard, Answers
2352
+ * Worksheets and Data Connections page.
2353
+ * Exports an object as a TML file.
2354
+ *
2355
+ * @example
2356
+ * ```js
2357
+ * disabledActions: [Action.ExportTML]
2358
+ * ```
2359
+ */
2300
2360
  ExportTML = "exportTSL",
2301
2361
  /**
2302
- * The **Import TML** menu action for Liveboards and Answers.
2303
- * Imports TML representation of ThoughtSpot objects.
2304
- * @example
2305
- * ```js
2306
- * disabledActions: [Action.ImportTML]
2307
- * ```
2308
- */
2362
+ * The **Import TML** menu action for Liveboards and Answers.
2363
+ * Imports TML representation of ThoughtSpot objects.
2364
+ *
2365
+ * @example
2366
+ * ```js
2367
+ * disabledActions: [Action.ImportTML]
2368
+ * ```
2369
+ */
2309
2370
  ImportTML = "importTSL",
2310
2371
  /**
2311
2372
  * The **Update TML** menu action for Liveboards and Answers.
2312
2373
  * Update TML representation of ThoughtSpot objects.
2374
+ *
2313
2375
  * @example
2314
2376
  * ```js
2315
2377
  * disabledActions: [Action.UpdateTML]
@@ -2319,6 +2381,7 @@ export declare enum Action {
2319
2381
  /**
2320
2382
  * The **Edit TML** menu action for Liveboards and Answers.
2321
2383
  * Opens the TML editor.
2384
+ *
2322
2385
  * @example
2323
2386
  * ```js
2324
2387
  * disabledActions: [Action.EditTML]
@@ -2326,50 +2389,55 @@ export declare enum Action {
2326
2389
  */
2327
2390
  EditTML = "editTSL",
2328
2391
  /**
2329
- * The **Present** menu action for Liveboards and Answers.
2330
- * Allows presenting a Liveboard or visualization in
2331
- * slideshow mode.
2332
- * @example
2333
- * ```js
2334
- * disabledActions: [Action.Present]
2335
- * ```
2336
- */
2392
+ * The **Present** menu action for Liveboards and Answers.
2393
+ * Allows presenting a Liveboard or visualization in
2394
+ * slideshow mode.
2395
+ *
2396
+ * @example
2397
+ * ```js
2398
+ * disabledActions: [Action.Present]
2399
+ * ```
2400
+ */
2337
2401
  Present = "present",
2338
2402
  /**
2339
- * The tile resize options in the visualization menu.
2340
- * Allows switching between different preset layouts.
2341
- * @example
2342
- * ```js
2343
- * disabledActions: [Action.ToggleSize]
2344
- * ```
2345
- */
2403
+ * The tile resize options in the visualization menu.
2404
+ * Allows switching between different preset layouts.
2405
+ *
2406
+ * @example
2407
+ * ```js
2408
+ * disabledActions: [Action.ToggleSize]
2409
+ * ```
2410
+ */
2346
2411
  ToggleSize = "toggleSize",
2347
2412
  /**
2348
- * The *Edit* action on the Liveboard page and in the
2349
- * visualization menu.
2350
- * Opens a Liveboard or visualization in edit mode.
2351
- * @example
2352
- * ```js
2353
- * disabledActions: [Action.Edit]
2354
- * ```
2355
- */
2413
+ * The *Edit* action on the Liveboard page and in the
2414
+ * visualization menu.
2415
+ * Opens a Liveboard or visualization in edit mode.
2416
+ *
2417
+ * @example
2418
+ * ```js
2419
+ * disabledActions: [Action.Edit]
2420
+ * ```
2421
+ */
2356
2422
  Edit = "edit",
2357
2423
  /**
2358
- * The text edit option for Liveboard and visualization titles.
2359
- * @example
2360
- * ```js
2361
- * disabledActions: [Action.EditTitle]
2362
- * ```
2363
- */
2424
+ * The text edit option for Liveboard and visualization titles.
2425
+ *
2426
+ * @example
2427
+ * ```js
2428
+ * disabledActions: [Action.EditTitle]
2429
+ * ```
2430
+ */
2364
2431
  EditTitle = "editTitle",
2365
2432
  /**
2366
- * The **Delete** menu action on Liveboards and visualizations.
2367
- * Deletes a Liveboard or a visualization from a Liveboard.
2368
- * @example
2369
- * ```js
2370
- * disabledActions: [Action.Remove]
2371
- * ```
2372
- */
2433
+ * The **Delete** menu action on Liveboards and visualizations.
2434
+ * Deletes a Liveboard or a visualization from a Liveboard.
2435
+ *
2436
+ * @example
2437
+ * ```js
2438
+ * disabledActions: [Action.Remove]
2439
+ * ```
2440
+ */
2373
2441
  Remove = "delete",
2374
2442
  /**
2375
2443
  * @hidden
@@ -2392,15 +2460,16 @@ export declare enum Action {
2392
2460
  */
2393
2461
  PinboardInfo = "pinboardInfo",
2394
2462
  /**
2395
- * The **Show Liveboard details** menu action on a Liveboard.
2396
- * Displays details such as the name, description, and
2397
- * author of the Liveboard, and timestamp of Liveboard creation
2398
- * and update.
2399
- * @example
2400
- * ```js
2401
- * disabledActions: [Action.LiveboardInfo]
2402
- * ```
2403
- */
2463
+ * The **Show Liveboard details** menu action on a Liveboard.
2464
+ * Displays details such as the name, description, and
2465
+ * author of the Liveboard, and timestamp of Liveboard creation
2466
+ * and update.
2467
+ *
2468
+ * @example
2469
+ * ```js
2470
+ * disabledActions: [Action.LiveboardInfo]
2471
+ * ```
2472
+ */
2404
2473
  LiveboardInfo = "pinboardInfo",
2405
2474
  /**
2406
2475
  * @hidden
@@ -2411,13 +2480,14 @@ export declare enum Action {
2411
2480
  */
2412
2481
  DownloadEmbraceQueries = "downloadEmbraceQueries",
2413
2482
  /**
2414
- * The **Pin** menu action on an Answer or
2415
- * Search results page.
2416
- * @example
2417
- * ```js
2418
- * disabledActions: [Action.Pin]
2419
- * ```
2420
- */
2483
+ * The **Pin** menu action on an Answer or
2484
+ * Search results page.
2485
+ *
2486
+ * @example
2487
+ * ```js
2488
+ * disabledActions: [Action.Pin]
2489
+ * ```
2490
+ */
2421
2491
  Pin = "pin",
2422
2492
  /**
2423
2493
  * @hidden
@@ -2425,6 +2495,7 @@ export declare enum Action {
2425
2495
  AnalysisInfo = "analysisInfo",
2426
2496
  /**
2427
2497
  * The **Schedule** menu action on a Liveboard.
2498
+ *
2428
2499
  * @example
2429
2500
  * ```js
2430
2501
  * disabledActions: [Action.Subscription]
@@ -2432,25 +2503,28 @@ export declare enum Action {
2432
2503
  */
2433
2504
  Subscription = "subscription",
2434
2505
  /**
2435
- * The **Explore** action on Liveboard visualizations
2436
- * @example
2437
- * ```js
2438
- * disabledActions: [Action.Explore]
2439
- * ```
2440
- */
2506
+ * The **Explore** action on Liveboard visualizations
2507
+ *
2508
+ * @example
2509
+ * ```js
2510
+ * disabledActions: [Action.Explore]
2511
+ * ```
2512
+ */
2441
2513
  Explore = "explore",
2442
2514
  /**
2443
- * The action to include data points on a drilled-down Answer
2444
- * or visualization
2445
- * @example
2446
- * ```js
2447
- * disabledActions: [Action.DrillInclude]
2448
- * ```
2449
- */
2515
+ * The action to include data points on a drilled-down Answer
2516
+ * or visualization
2517
+ *
2518
+ * @example
2519
+ * ```js
2520
+ * disabledActions: [Action.DrillInclude]
2521
+ * ```
2522
+ */
2450
2523
  DrillInclude = "context-menu-item-include",
2451
2524
  /**
2452
2525
  * The action to exclude data points on a drilled-down Answer
2453
2526
  * or visualization
2527
+ *
2454
2528
  * @example
2455
2529
  * ```js
2456
2530
  * disabledActions: [Action.DrillInclude]
@@ -2461,6 +2535,7 @@ export declare enum Action {
2461
2535
  * The **Copy to clipboard** menu action on tables in an Answer
2462
2536
  * or Liveboard.
2463
2537
  * Copies the selected data point.
2538
+ *
2464
2539
  * @example
2465
2540
  * ```js
2466
2541
  * disabledActions: [Action.CopyToClipboard]
@@ -2478,6 +2553,7 @@ export declare enum Action {
2478
2553
  * The **Drill down** menu action on Answers and Liveboard
2479
2554
  * visualizations.
2480
2555
  * Allows drilling down to a specific data point on a chart or table.
2556
+ *
2481
2557
  * @example
2482
2558
  * ```js
2483
2559
  * disabledActions: [Action.DrillDown]
@@ -2487,6 +2563,7 @@ export declare enum Action {
2487
2563
  /**
2488
2564
  * The request access action on Liveboards.
2489
2565
  * Allows users with view permissions to request edit access to a Liveboard.
2566
+ *
2490
2567
  * @example
2491
2568
  * ```js
2492
2569
  * disabledActions: [Action.RequestAccess]
@@ -2496,6 +2573,7 @@ export declare enum Action {
2496
2573
  /**
2497
2574
  * The **Query visualizer** and **Query SQL** buttons in Query details panel
2498
2575
  * of the Answer page
2576
+ *
2499
2577
  * @example
2500
2578
  * ```js
2501
2579
  * disabledActions: [Action.QueryDetailsButtons]
@@ -2504,6 +2582,7 @@ export declare enum Action {
2504
2582
  QueryDetailsButtons = "QueryDetailsButtons",
2505
2583
  /**
2506
2584
  * The **Delete** action for Answers.
2585
+ *
2507
2586
  * @example
2508
2587
  * ```js
2509
2588
  * disabledActions: [Action.AnswerDelete]
@@ -2513,6 +2592,7 @@ export declare enum Action {
2513
2592
  AnswerDelete = "onDeleteAnswer",
2514
2593
  /**
2515
2594
  * The Chart switcher icon on Answer and visualization pages.
2595
+ *
2516
2596
  * @example
2517
2597
  * ```js
2518
2598
  * disabledActions: [Action.AnswerChartSwitcher]
@@ -2522,6 +2602,7 @@ export declare enum Action {
2522
2602
  AnswerChartSwitcher = "answerChartSwitcher",
2523
2603
  /**
2524
2604
  * Favorites icon (*) on Answers, Liveboard, and Data pages
2605
+ *
2525
2606
  * @example
2526
2607
  * ```js
2527
2608
  * disabledActions: [Action.AddToFavorites]
@@ -2531,6 +2612,7 @@ export declare enum Action {
2531
2612
  AddToFavorites = "addToFavorites",
2532
2613
  /**
2533
2614
  * The edit icon on Liveboards (Classic experience).
2615
+ *
2534
2616
  * @example
2535
2617
  * ```js
2536
2618
  * disabledActions: [Action.EditDetails]
@@ -2540,6 +2622,7 @@ export declare enum Action {
2540
2622
  EditDetails = "editDetails",
2541
2623
  /**
2542
2624
  * The Create alert action on KPI charts.
2625
+ *
2543
2626
  * @example
2544
2627
  * ```js
2545
2628
  * disabledActions: [Action.CreateMonitor ]
@@ -2558,6 +2641,7 @@ export declare enum Action {
2558
2641
  /**
2559
2642
  * The **Sync to sheets** action on Answers and Liveboard visualizations.
2560
2643
  * Allows sending data to a Google Sheet.
2644
+ *
2561
2645
  * @example
2562
2646
  * ```js
2563
2647
  * disabledActions: [Action.SyncToSheets]
@@ -2569,6 +2653,7 @@ export declare enum Action {
2569
2653
  * The **Sync to other apps** action on Answers and Liveboard visualizations.
2570
2654
  * Allows sending data to third-party apps like Slack, Salesforce,
2571
2655
  * Microsoft Teams, and so on.
2656
+ *
2572
2657
  * @example
2573
2658
  * ```js
2574
2659
  * disabledActions: [Action.SyncToOtherApps]
@@ -2579,6 +2664,7 @@ export declare enum Action {
2579
2664
  /**
2580
2665
  * The **Manage pipelines** action on Answers and Liveboard visualizations.
2581
2666
  * Allows users to manage data sync pipelines to third-party apps.
2667
+ *
2582
2668
  * @example
2583
2669
  * ```js
2584
2670
  * disabledActions: [Action.SyncToOtherApps]
@@ -2589,6 +2675,7 @@ export declare enum Action {
2589
2675
  /**
2590
2676
  * The **Filter** action on Liveboard visualizations.
2591
2677
  * Allows users to apply cross-filters on a Liveboard.
2678
+ *
2592
2679
  * @example
2593
2680
  * ```js
2594
2681
  * disabledActions: [Action.CrossFilter]
@@ -2600,6 +2687,7 @@ export declare enum Action {
2600
2687
  * The **Remove** action that appears when cross filters are applied
2601
2688
  * on a Liveboard.
2602
2689
  * Removes filters applied o a visualization.
2690
+ *
2603
2691
  * @example
2604
2692
  * ```js
2605
2693
  * disabledActions: [Action.RemoveCrossFilter]
@@ -2611,6 +2699,7 @@ export declare enum Action {
2611
2699
  * The **Aggregate** option in the chart axis or the
2612
2700
  * table column customization menu.
2613
2701
  * Provides aggregation options to analyze the data on a chart or table.
2702
+ *
2614
2703
  * @example
2615
2704
  * ```js
2616
2705
  * disabledActions: [Action.AxisMenuAggregate]
@@ -2622,6 +2711,7 @@ export declare enum Action {
2622
2711
  * The **Time bucket** option in the chart axis or table column
2623
2712
  * customization menu.
2624
2713
  * Allows defining time metric for date comparison.
2714
+ *
2625
2715
  * @example
2626
2716
  * ```js
2627
2717
  * disabledActions: [Action.AxisMenuTimeBucket]
@@ -2632,6 +2722,7 @@ export declare enum Action {
2632
2722
  /**
2633
2723
  * The **Filter** action in the chart axis or table column
2634
2724
  * customization menu.
2725
+ *
2635
2726
  * @example
2636
2727
  * ```js
2637
2728
  * disabledActions: [Action.AxisMenuFilter]
@@ -2643,6 +2734,7 @@ export declare enum Action {
2643
2734
  * The **Conditional formatting** action on chart or table.
2644
2735
  * Allows adding rules for conditional formatting of data
2645
2736
  * points on a chart or table.
2737
+ *
2646
2738
  * @example
2647
2739
  * ```js
2648
2740
  * disabledActions: [Action.AxisMenuConditionalFormat]
@@ -2654,6 +2746,7 @@ export declare enum Action {
2654
2746
  * The **Sort** menu action on a table or chart axis
2655
2747
  * Sorts data in ascending or descending order.
2656
2748
  * Allows adding, editing, or removing filters.
2749
+ *
2657
2750
  * @example
2658
2751
  * ```js
2659
2752
  * disabledActions: [Action.AxisMenuConditionalFormat]
@@ -2666,6 +2759,7 @@ export declare enum Action {
2666
2759
  * customization menu.
2667
2760
  * Allows grouping data points if the axes use the same
2668
2761
  * unit of measurement and a similar scale.
2762
+ *
2669
2763
  * @example
2670
2764
  * ```js
2671
2765
  * disabledActions: [Action.AxisMenuGroup]
@@ -2677,6 +2771,7 @@ export declare enum Action {
2677
2771
  * The **Position** option in the axis customization menu.
2678
2772
  * Allows changing the position of the axis to the
2679
2773
  * left or right side of the chart.
2774
+ *
2680
2775
  * @example
2681
2776
  * ```js
2682
2777
  * disabledActions: [Action.AxisMenuPosition]
@@ -2687,6 +2782,7 @@ export declare enum Action {
2687
2782
  /**
2688
2783
  * The **Rename** option in the chart axis or table column customization menu.
2689
2784
  * Renames the axis label on a chart or the column header on a table.
2785
+ *
2690
2786
  * @example
2691
2787
  * ```js
2692
2788
  * disabledActions: [Action.AxisMenuRename]
@@ -2698,6 +2794,7 @@ export declare enum Action {
2698
2794
  * The **Edit** action in the axis customization menu.
2699
2795
  * Allows editing the axis name, position, minimum and maximum values,
2700
2796
  * and format of a column.
2797
+ *
2701
2798
  * @example
2702
2799
  * ```js
2703
2800
  * disabledActions: [Action.AxisMenuEdit]
@@ -2708,6 +2805,7 @@ export declare enum Action {
2708
2805
  /**
2709
2806
  * The **Number format** action to customize the format of
2710
2807
  * the data labels on a chart or table.
2808
+ *
2711
2809
  * @example
2712
2810
  * ```js
2713
2811
  * disabledActions: [Action.AxisMenuNumberFormat]
@@ -2718,6 +2816,7 @@ export declare enum Action {
2718
2816
  /**
2719
2817
  * The **Text wrapping** action on a table.
2720
2818
  * Wraps or clips column text on a table.
2819
+ *
2721
2820
  * @example
2722
2821
  * ```js
2723
2822
  * disabledActions: [Action.AxisMenuTextWrapping]
@@ -2730,6 +2829,7 @@ export declare enum Action {
2730
2829
  * customization menu.
2731
2830
  * Removes the data labels from a chart or the column of a
2732
2831
  * table visualization.
2832
+ *
2733
2833
  * @example
2734
2834
  * ```js
2735
2835
  * disabledActions: [Action.AxisMenuRemove]
@@ -2744,6 +2844,7 @@ export declare enum Action {
2744
2844
  /**
2745
2845
  * The **Rename** menu action on Liveboards and visualizations.
2746
2846
  * Allows renaming a Liveboard or visualization.
2847
+ *
2747
2848
  * @example
2748
2849
  * ```js
2749
2850
  * disabledActions: [Action.RenameModalTitleDescription]
@@ -2760,13 +2861,29 @@ export declare enum Action {
2760
2861
  */
2761
2862
  MarkAsVerified = "markAsVerified",
2762
2863
  /**
2763
- * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
2864
+ * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
2764
2865
  */
2765
2866
  AddTab = "addTab",
2766
2867
  /**
2767
2868
  * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
2768
2869
  */
2769
- EnableContextualChangeAnalysis = "enableContextualChangeAnalysis"
2870
+ EnableContextualChangeAnalysis = "enableContextualChangeAnalysis",
2871
+ /**
2872
+ * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
2873
+ */
2874
+ ShowSageQuery = "showSageQuery",
2875
+ /**
2876
+ * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
2877
+ */
2878
+ EditSageAnswer = "editSageAnswer",
2879
+ /**
2880
+ * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
2881
+ */
2882
+ SageAnswerFeedback = "sageAnswerFeedback",
2883
+ /**
2884
+ * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
2885
+ */
2886
+ ModifySageAnswer = "modifySageAnswer"
2770
2887
  }
2771
2888
  export interface SessionInterface {
2772
2889
  sessionId: string;