@qlik/api 2.2.0 → 2.3.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 (232) hide show
  1. package/analytics/change-stores.d.ts +386 -0
  2. package/analytics/change-stores.js +123 -0
  3. package/analytics.d.ts +14 -0
  4. package/analytics.js +13 -0
  5. package/api-keys.d.ts +362 -3
  6. package/api-keys.js +2 -3
  7. package/apps.d.ts +2673 -3
  8. package/apps.js +2 -3
  9. package/assistants.d.ts +1370 -3
  10. package/assistants.js +2 -3
  11. package/audits.d.ts +318 -3
  12. package/audits.js +4 -4
  13. package/auth-types.d.ts +1 -1
  14. package/auth-types.js +1 -2
  15. package/auth.d.ts +94 -2
  16. package/auth.js +63 -3
  17. package/automation-connections.d.ts +366 -3
  18. package/automation-connections.js +2 -3
  19. package/automation-connectors.d.ts +84 -3
  20. package/automation-connectors.js +2 -3
  21. package/automations.d.ts +805 -3
  22. package/automations.js +2 -3
  23. package/automl-deployments.d.ts +101 -3
  24. package/automl-deployments.js +2 -3
  25. package/automl-predictions.d.ts +238 -3
  26. package/automl-predictions.js +2 -3
  27. package/banners.d.ts +184 -3
  28. package/banners.js +2 -3
  29. package/brands.d.ts +670 -3
  30. package/brands.js +2 -3
  31. package/chunks/auth-XusKk8IA.js +32 -0
  32. package/chunks/{chunk-EtTptKIv.js → chunk-D3vHIbds.js} +2 -2
  33. package/chunks/{dist-gXLIqDJW.js → dist-n3iOVn1W.js} +4 -4
  34. package/chunks/{auth-functions-BmZgZYSs.js → interceptors-2VSXImC9.js} +498 -146
  35. package/chunks/{invoke-fetch-PcVIxLW4.js → invoke-fetch-CckTK7bh.js} +3 -3
  36. package/chunks/{invoke-fetch-CucBpA1C.js → invoke-fetch-D9lpiAb-.js} +1 -5
  37. package/chunks/{public-runtime-modules-Dwjzb3l8.js → public-runtime-modules-BqxAMJ9M.js} +7 -7
  38. package/chunks/{qix-DI5o5XF4.d.ts → qix-CrqXv44x.d.ts} +6 -2
  39. package/chunks/{qix-DjxuPCX0.js → qix-DpvHvpx7.js} +11 -10
  40. package/chunks/{qix-chunk-entrypoint-tmTo-kpa.js → qix-chunk-entrypoint-BXZPnE6J.js} +48 -50
  41. package/collections.d.ts +582 -3
  42. package/collections.js +2 -3
  43. package/conditions.d.ts +662 -3
  44. package/conditions.js +2 -3
  45. package/consumption.d.ts +182 -3
  46. package/consumption.js +2 -3
  47. package/core/ip-policies.d.ts +328 -4
  48. package/core/ip-policies.js +108 -5
  49. package/core.d.ts +13 -4
  50. package/core.js +3 -4
  51. package/csp-origins.d.ts +273 -3
  52. package/csp-origins.js +2 -3
  53. package/csrf-token.d.ts +62 -3
  54. package/csrf-token.js +2 -3
  55. package/data-alerts.d.ts +1004 -3
  56. package/data-alerts.js +2 -3
  57. package/data-assets.d.ts +207 -3
  58. package/data-assets.js +2 -3
  59. package/data-connections.d.ts +678 -3
  60. package/data-connections.js +2 -3
  61. package/data-credentials.d.ts +292 -3
  62. package/data-credentials.js +2 -3
  63. package/data-files.d.ts +860 -3
  64. package/data-files.js +2 -3
  65. package/data-qualities.d.ts +175 -3
  66. package/data-qualities.js +2 -3
  67. package/data-sets.d.ts +424 -3
  68. package/data-sets.js +2 -3
  69. package/data-sources.d.ts +348 -3
  70. package/data-sources.js +2 -3
  71. package/data-stores.d.ts +537 -3
  72. package/data-stores.js +2 -3
  73. package/dcaas.d.ts +192 -3
  74. package/dcaas.js +2 -3
  75. package/di-projects.d.ts +812 -4
  76. package/di-projects.js +25 -4
  77. package/direct-access-agents.d.ts +710 -4
  78. package/direct-access-agents.js +37 -5
  79. package/docs/authentication.md +1 -1
  80. package/encryption.d.ts +372 -3
  81. package/encryption.js +2 -3
  82. package/extensions.d.ts +295 -3
  83. package/extensions.js +2 -3
  84. package/global-types.d.ts +1 -1
  85. package/global-types.js +0 -2
  86. package/glossaries.d.ts +1223 -3
  87. package/glossaries.js +2 -3
  88. package/groups.d.ts +510 -3
  89. package/groups.js +2 -3
  90. package/identity-providers.d.ts +711 -3
  91. package/identity-providers.js +2 -3
  92. package/index.d.ts +78 -69
  93. package/index.js +28 -10
  94. package/interceptors.d.ts +52 -3
  95. package/interceptors.js +1 -2
  96. package/invoke-fetch-types.d.ts +1 -1
  97. package/items.d.ts +536 -3
  98. package/items.js +2 -3
  99. package/knowledgebases.d.ts +976 -3
  100. package/knowledgebases.js +2 -3
  101. package/licenses.d.ts +663 -3
  102. package/licenses.js +2 -3
  103. package/lineage-graphs.d.ts +704 -3
  104. package/lineage-graphs.js +2 -3
  105. package/ml.d.ts +2808 -3
  106. package/ml.js +2 -3
  107. package/notes.d.ts +110 -3
  108. package/notes.js +2 -3
  109. package/notifications.d.ts +98 -3
  110. package/notifications.js +2 -3
  111. package/oauth-callback.iife.js +1151 -0
  112. package/oauth-clients.d.ts +562 -3
  113. package/oauth-clients.js +2 -3
  114. package/oauth-tokens.d.ts +126 -3
  115. package/oauth-tokens.js +2 -3
  116. package/package.json +5 -4
  117. package/qix.d.ts +3 -3
  118. package/qix.js +38 -3
  119. package/questions.d.ts +364 -3
  120. package/questions.js +2 -3
  121. package/quotas.d.ts +112 -3
  122. package/quotas.js +2 -3
  123. package/reload-tasks.d.ts +249 -3
  124. package/reload-tasks.js +2 -3
  125. package/reloads.d.ts +260 -3
  126. package/reloads.js +2 -3
  127. package/report-templates.d.ts +287 -3
  128. package/report-templates.js +2 -3
  129. package/reports.d.ts +863 -3
  130. package/reports.js +2 -3
  131. package/roles.d.ts +312 -3
  132. package/roles.js +2 -3
  133. package/sharing-tasks.d.ts +1164 -3
  134. package/sharing-tasks.js +2 -3
  135. package/spaces.d.ts +779 -3
  136. package/spaces.js +2 -3
  137. package/tasks.d.ts +564 -3
  138. package/tasks.js +2 -3
  139. package/temp-contents.d.ts +167 -3
  140. package/temp-contents.js +2 -3
  141. package/tenants.d.ts +360 -3
  142. package/tenants.js +2 -3
  143. package/themes.d.ts +270 -3
  144. package/themes.js +2 -3
  145. package/transports.d.ts +435 -4
  146. package/transports.js +20 -5
  147. package/ui-config.d.ts +274 -3
  148. package/ui-config.js +2 -3
  149. package/users.d.ts +674 -3
  150. package/users.js +2 -3
  151. package/web-integrations.d.ts +294 -3
  152. package/web-integrations.js +2 -3
  153. package/web-notifications.d.ts +273 -3
  154. package/web-notifications.js +2 -3
  155. package/webhooks.d.ts +505 -3
  156. package/webhooks.js +2 -3
  157. package/chunks/api-keys-D6Rqaov4.d.ts +0 -365
  158. package/chunks/apps-BwpXUGDb.d.ts +0 -2673
  159. package/chunks/assistants-wh6Qe7l6.d.ts +0 -1366
  160. package/chunks/audits-DakwzT97.d.ts +0 -316
  161. package/chunks/auth-6mptVm5Q.d.ts +0 -95
  162. package/chunks/auth-Cle0_tmz.js +0 -32
  163. package/chunks/auth-D11iO7ZV.js +0 -65
  164. package/chunks/automation-connections-k2G_n9rj.d.ts +0 -366
  165. package/chunks/automation-connectors-J5OE-1P0.d.ts +0 -84
  166. package/chunks/automations-BGy83EBO.d.ts +0 -797
  167. package/chunks/automl-deployments-CWEpX2pk.d.ts +0 -101
  168. package/chunks/automl-predictions-BNIjRhBm.d.ts +0 -238
  169. package/chunks/banners-CgBRnZGv.d.ts +0 -184
  170. package/chunks/brands-DCgk6Gqx.d.ts +0 -671
  171. package/chunks/collections-BpYjcpIY.d.ts +0 -582
  172. package/chunks/conditions-CJJG7Uph.d.ts +0 -662
  173. package/chunks/consumption-DerFk437.d.ts +0 -182
  174. package/chunks/core-DQXNZdnf.d.ts +0 -12
  175. package/chunks/csp-origins-3NJlh_n9.d.ts +0 -273
  176. package/chunks/csrf-token-DoaoOQzH.d.ts +0 -63
  177. package/chunks/data-alerts-CILSEFbQ.d.ts +0 -1004
  178. package/chunks/data-assets-CJDcssoX.d.ts +0 -207
  179. package/chunks/data-connections-VSB13K6g.d.ts +0 -678
  180. package/chunks/data-credentials-ChEp_hyU.d.ts +0 -292
  181. package/chunks/data-files-CVzn9M6V.d.ts +0 -860
  182. package/chunks/data-qualities-DBrot957.d.ts +0 -176
  183. package/chunks/data-sets-CFzxgWnO.d.ts +0 -424
  184. package/chunks/data-sources-IsAaof_C.d.ts +0 -346
  185. package/chunks/data-stores-DFOPdgfz.d.ts +0 -537
  186. package/chunks/dcaas-qyv7YlrN.d.ts +0 -192
  187. package/chunks/di-projects-DVQTxASr.d.ts +0 -777
  188. package/chunks/direct-access-agents-B77OhzZi.d.ts +0 -580
  189. package/chunks/encryption-BjA6xbCO.d.ts +0 -372
  190. package/chunks/extensions-OO0WtInj.d.ts +0 -294
  191. package/chunks/glossaries-CIX7-KT_.d.ts +0 -1213
  192. package/chunks/groups-C86-UG7S.d.ts +0 -511
  193. package/chunks/identity-providers-h0dKNxGZ.d.ts +0 -711
  194. package/chunks/interceptors-Csx2tEi5.d.ts +0 -52
  195. package/chunks/interceptors-DTYm37AU.js +0 -104
  196. package/chunks/ip-policies-CKRIlbP7.d.ts +0 -327
  197. package/chunks/ip-policies-DXlf172B.js +0 -108
  198. package/chunks/items-C-jzqvFW.d.ts +0 -536
  199. package/chunks/knowledgebases-CyQtVcZN.d.ts +0 -977
  200. package/chunks/licenses-xzjnkitW.d.ts +0 -663
  201. package/chunks/lineage-graphs-CViCCzKy.d.ts +0 -697
  202. package/chunks/ml-Abt2MUva.d.ts +0 -2809
  203. package/chunks/notes-BZxuyDgt.d.ts +0 -111
  204. package/chunks/notifications-Bd_gp4jU.d.ts +0 -99
  205. package/chunks/oauth-clients-B5QPr4IM.d.ts +0 -563
  206. package/chunks/oauth-tokens-1b7V8182.d.ts +0 -127
  207. package/chunks/qix-CYQsLyGQ.js +0 -40
  208. package/chunks/questions-BVp0tvNs.d.ts +0 -364
  209. package/chunks/quotas-CfAebRJd.d.ts +0 -113
  210. package/chunks/reload-tasks-DfwUTetn.d.ts +0 -249
  211. package/chunks/reloads-CwmagnFx.d.ts +0 -260
  212. package/chunks/report-templates-DjQYj5dn.d.ts +0 -287
  213. package/chunks/reports-DzNC6Uq3.d.ts +0 -861
  214. package/chunks/roles-BYFIY6E7.d.ts +0 -312
  215. package/chunks/sharing-tasks-BMGIQ-FO.d.ts +0 -1164
  216. package/chunks/spaces-BK823t-b.d.ts +0 -780
  217. package/chunks/tasks-COKDfShO.d.ts +0 -564
  218. package/chunks/temp-contents-zDomB-g6.d.ts +0 -168
  219. package/chunks/tenants-Bhn86519.d.ts +0 -361
  220. package/chunks/themes-v9NbhiBo.d.ts +0 -269
  221. package/chunks/transports-CqEiFxD3.d.ts +0 -362
  222. package/chunks/ui-config-Crs0mVMp.d.ts +0 -274
  223. package/chunks/users-BSOBU_fg.d.ts +0 -675
  224. package/chunks/web-integrations-MisPAHod.d.ts +0 -295
  225. package/chunks/web-notifications-DVy6FHYh.d.ts +0 -274
  226. package/chunks/webhooks-Dr4EiXqy.d.ts +0 -505
  227. /package/chunks/{auth-types-E99tzdN0.d.ts → auth-types-YrlH_R9f.d.ts} +0 -0
  228. /package/chunks/{auth-types-JehqruDP.js → auth-types-h43TVDpB.js} +0 -0
  229. /package/chunks/{global-types-CrOvI33z.js → global-types-CEVAJebk.js} +0 -0
  230. /package/chunks/{invoke-fetch-CbU2Dgqr.d.ts → invoke-fetch-C1Z0RJYU.d.ts} +0 -0
  231. /package/chunks/{utils-BnC4lrlq.js → utils-vv-xFm06.js} +0 -0
  232. /package/chunks/{websocket-errors-DSbO6kDZ.js → websocket-errors-CRTDTtBL.js} +0 -0
package/apps.d.ts CHANGED
@@ -1,4 +1,2674 @@
1
- import "./chunks/auth-types-E99tzdN0.js";
2
- import "./chunks/invoke-fetch-CbU2Dgqr.js";
3
- import { $ as Errors, $i as validateScript, $n as PublishAppHttpError, $r as UpdateOwner, $t as GetAppReloadLogHttpError, A as Comparisonobjresponsetime, Ai as getAppMediaList, An as MoveAppToSpaceHttpError, Ar as ScriptLogList, At as GetAppDataMetadataHttpResponse, B as CreateAppHttpResponse, Bi as importApp, Bn as NxPatch, Br as SymbolFrequency, Bt as GetAppEvaluationsHttpResponse, C as Cmpbool, Ci as getAppEvaluationXml, Cn as LastReloadMetadata, Cr as ResultobjMemoryLimit, Ct as FilterVariable, D as Comparison, Di as getAppInsightAnalysisModel, Dn as LinksResponse, Dr as Script, Dt as GetAppDataLineageHttpError, E as Cmpint, Ei as getAppInsightAnalyses, En as Links, Er as Resultsingle, Et as FrequencyDistributionData, F as CopyAppHttpResponse, Fi as getAppReportFilters, Fn as NxApp, Fr as SimplifiedClassifications, Ft as GetAppEvaluationHttpError, G as DeleteAppHttpResponse, Gi as queueAppEvaluation, Gn as PartialNluInfo, Gr as UpdateAppInfoHttpError, Gt as GetAppInsightAnalysisModelHttpError, H as CreateAppReportFilterHttpResponse, Hi as patchAppReportFilter, Hn as Objectmetrics, Hr as TableMetadata, Ht as GetAppInfoHttpResponse, I as CountAppReportFiltersHttpError, Ii as getAppScript, In as NxAppCreatePrivileges, Ir as Sortedcomparisonfields, It as GetAppEvaluationHttpResponse, J as DeleteAppReportFilterHttpError, Ji as updateAppInfo, Jn as PatchAppScriptHttpError, Jr as UpdateAppObjectOwnerHttpResponse, Jt as GetAppInsightAnalysisRecommendationsHttpResponse, K as DeleteAppMediaHttpError, Ki as removeAppFromSpace, Kn as PatchAppReportFilterHttpError, Kr as UpdateAppInfoHttpResponse, Kt as GetAppInsightAnalysisModelHttpResponse, L as CountAppReportFiltersHttpResponse, Li as getAppScriptHistory, Ln as NxAppObject, Lr as Sortedcomparisonobjresponsetime, Lt as GetAppEvaluationXmlHttpError, M as Comparisontables, Mi as getAppReloadLogs, Mn as NavigationLink, Mr as ScriptMeta, Mt as GetAppEvaluationComparisonHttpResponse, N as CompositionMinMax, Ni as getAppReloadMetadata, Nn as NavigationLinks, Nr as ScriptMetaList, Nt as GetAppEvaluationComparisonXmlHttpError, O as Comparisonfields, Oi as getAppInsightAnalysisRecommendations, On as Log, Or as ScriptIssue, Ot as GetAppDataLineageHttpResponse, P as CopyAppHttpError, Pi as getAppReportFilter, Pn as NumberFormat, Pr as ScriptVersion, Pt as GetAppEvaluationComparisonXmlHttpResponse, Q as Error, Qi as uploadAppMedia, Qn as PublishApp, Qr as UpdateAppScriptHttpResponse, Qt as GetAppMediaListHttpResponse, R as CreateApp, Ri as getAppThumbnail, Rn as NxAttributes, Rr as Sortedcomparisonoobjheavy, Rt as GetAppEvaluationXmlHttpResponse, S as Classifications, Si as getAppEvaluationComparisonXml, Sn as JsonObject, Sr as Resultmetadatatoptables, St as FilterV10, T as CmpfloatWithTimeout, Ti as getAppInfo, Tn as LinkResponse, Tr as Resultobjsheet, Tt as Float64, U as DataModelMetadata, Ui as patchAppScript, Un as Objectspec, Ur as TableProfilingData, Ut as GetAppInsightAnalysesHttpError, V as CreateAppReportFilterHttpError, Vi as moveAppToSpace, Vn as NxPatchOperationType, Vr as SymbolValue, Vt as GetAppInfoHttpError, W as DeleteAppHttpError, Wi as publishApp, Wn as Objecttopspec, Wr as UpdateApp, Wt as GetAppInsightAnalysesHttpResponse, X as DeleteAppScriptHttpError, Xi as updateAppOwner, Xn as PatchFilter, Xr as UpdateAppOwnerHttpResponse, Xt as GetAppMediaHttpResponse, Y as DeleteAppReportFilterHttpResponse, Yi as updateAppObjectOwner, Yn as PatchAppScriptHttpResponse, Yr as UpdateAppOwnerHttpError, Yt as GetAppMediaHttpError, Z as DeleteAppScriptHttpResponse, Zi as updateAppScript, Zn as PatchFilterItem, Zr as UpdateAppScriptHttpError, Zt as GetAppMediaListHttpError, _ as AppObjectGenericType, _i as exportApp, _n as HardwareMeta, _r as RepublishAppHttpError, _t as FilterItemPatch, a as AnalysisDetails, ai as ValidateScriptHttpError, an as GetAppReportFilterHttpError, ar as RecommendItems, at as ExportAppHttpResponse, b as ChartType, bi as getAppEvaluation, bn as ImportAppHttpError, br as Resultentry, bt as FilterRequest, c as AnalysisModelItemMasterItem, ci as clearCache, cn as GetAppReportFiltersHttpResponse, cr as RecommendedAnalysis, ct as FieldInTableProfilingData, d as AnalysisRecommendRequest, di as createApp, dn as GetAppScriptHttpError, dr as ReloadListMetadata, dt as FileData, ei as UpdateSpace, en as GetAppReloadLogHttpResponse, er as PublishAppHttpResponse, et as Evaluation, f as AnalysisRecommendationResponse, fi as createAppReportFilter, fn as GetAppScriptHttpResponse, fr as ReloadMeta, ft as Filter, g as AppContentListItem, gi as deleteAppScript, gn as GetAppsPrivilegesHttpResponse, gr as RepublishApp, gt as FilterFieldValue, h as AppContentList, hi as deleteAppReportFilter, hn as GetAppsPrivilegesHttpError, hr as RemoveAppFromSpaceHttpResponse, ht as FilterField, i as AnalysisDescriptorResponse, ii as UserPrivileges, in as GetAppReloadMetadataHttpResponse, ir as RecommendFieldItem, it as ExportAppHttpError, j as Comparisonoobjheavy, ji as getAppReloadLog, jn as MoveAppToSpaceHttpResponse, jr as ScriptLogMeta, jt as GetAppEvaluationComparisonHttpError, k as ComparisonobjMemoryLimit, ki as getAppMedia, kn as Metadata, kr as ScriptIssues, kt as GetAppDataMetadataHttpError, l as AnalysisModelResponse, li as copyApp, ln as GetAppScriptHistoryHttpError, lr as RecommendedAnalysisCore, lt as FieldMetadata, m as AppAttributes, mi as deleteAppMedia, mn as GetAppThumbnailHttpResponse, mr as RemoveAppFromSpaceHttpError, mt as FilterErrors, n as AnalysisComposition, ni as UploadAppMediaHttpResponse, nn as GetAppReloadLogsHttpResponse, nr as QueueAppEvaluationHttpError, nt as EvaluatorError, o as AnalysisGroup, oi as ValidateScriptHttpResponse, on as GetAppReportFilterHttpResponse, or as RecommendMasterItem, ot as FieldAttrType, p as AnalysisRecommendationResponseDetail, pi as deleteApp, pn as GetAppThumbnailHttpError, pr as ReloadStatements, pt as FilterError, q as DeleteAppMediaHttpResponse, qi as republishApp, qn as PatchAppReportFilterHttpResponse, qr as UpdateAppObjectOwnerHttpError, qt as GetAppInsightAnalysisRecommendationsHttpError, r as AnalysisDescriptor, ri as UsageEnum, rn as GetAppReloadMetadataHttpError, rr as QueueAppEvaluationHttpResponse, rt as Event, s as AnalysisModelItemField, si as appsExport, sn as GetAppReportFiltersHttpError, sr as RecommendNaturalLangQuery, st as FieldAttributes, t as Analysis, ti as UploadAppMediaHttpError, tn as GetAppReloadLogsHttpError, tr as PublishData, tt as Evaluations, u as AnalysisModelResponseDetail, ui as countAppReportFilters, un as GetAppScriptHistoryHttpResponse, ur as ReloadIncludeFile, ut as FieldOverride, v as AppUpdateAttributes, vi as getAppDataLineage, vn as Href, vr as RepublishAppHttpResponse, vt as FilterList, w as Cmpfloat, wi as getAppEvaluations, wn as LineageInfoRest, wr as Resultobjresponsetime, wt as FiltersCount, x as Classification, xi as getAppEvaluationComparison, xn as ImportAppHttpResponse, xr as Resultmetadatatopfields, xt as FilterType, y as AppsAPI, yi as getAppDataMetadata, yn as Href2, yr as Result, yt as FilterListItem, z as CreateAppHttpError, zi as getAppsPrivileges, zn as NxObjectAttributes, zr as Sortedcomparisontables, zt as GetAppEvaluationsHttpError } from "./chunks/apps-BwpXUGDb.js";
1
+ import { S as DownloadableBlob, y as ApiCallOptions } from "./chunks/auth-types-YrlH_R9f.js";
2
+ import "./chunks/invoke-fetch-C1Z0RJYU.js";
3
+
4
+ //#region src/public/rest/apps.d.ts
5
+ type Analysis = "breakdown" | "changePoint" | "comparison" | "contribution" | "correlation" | "fact" | "mutualInfo" | "rank" | "spike" | "trend" | "values";
6
+ type AnalysisComposition = {
7
+ description?: {
8
+ long?: string;
9
+ short?: string;
10
+ };
11
+ /** Upper and lower bounds for items of specific classification types */
12
+ dims?: CompositionMinMax;
13
+ /** Upper and lower bounds for items of specific classification types */
14
+ geos?: CompositionMinMax;
15
+ /** Upper and lower bounds for items of specific classification types */
16
+ items?: CompositionMinMax;
17
+ /** Upper and lower bounds for items of specific classification types */
18
+ msrs?: CompositionMinMax;
19
+ /** Upper and lower bounds for items of specific classification types */
20
+ temporals?: CompositionMinMax;
21
+ };
22
+ type AnalysisDescriptor = {
23
+ compositions?: AnalysisComposition[];
24
+ id?: string;
25
+ /** Used for period-specific analyses to indicate the defined or available calendar period must be of type autoCalendar */
26
+ requiresAutoCalendarPeriod?: boolean;
27
+ /** Used for period-specific analyses to indicate the temporal dimension must be associated with one or more analysis periods */
28
+ requiresAvailableAnalysisPeriod?: boolean;
29
+ /** Used for period-specific analyses to indicate the measure must be associated with one or more analysis periods */
30
+ requiresDefinedAnalysisPeriod?: boolean;
31
+ /** If analysis can work with master items (default is true) */
32
+ supportsMasterItems?: boolean;
33
+ };
34
+ type AnalysisDescriptorResponse = {
35
+ data?: AnalysisDescriptor[];
36
+ links?: Links;
37
+ };
38
+ type AnalysisDetails = {
39
+ analysis?: Analysis;
40
+ analysisGroup?: AnalysisGroup;
41
+ title?: string;
42
+ };
43
+ type AnalysisGroup = "anomaly" | "brekadown" | "comparison" | "correl" | "fact" | "list" | "mutualInfo" | "rank";
44
+ type AnalysisModelItemField = {
45
+ /** classification defines the default role that attribute can play in an analysis */
46
+ classifications?: Classifications;
47
+ /** whether the field is hidden in business logic */
48
+ isHidden?: boolean;
49
+ /** populated only for fields */
50
+ name?: string;
51
+ simplifiedClassifications?: SimplifiedClassifications;
52
+ };
53
+ type AnalysisModelItemMasterItem = {
54
+ caption?: string;
55
+ /** classification defines the default role that attribute can play in an analysis */
56
+ classifications?: Classifications;
57
+ /** whether the master item is hidden in business logic */
58
+ isHidden?: boolean;
59
+ /** only available for master items */
60
+ libId?: string;
61
+ simplifiedClassifications?: SimplifiedClassifications;
62
+ };
63
+ type AnalysisModelResponse = {
64
+ data?: AnalysisModelResponseDetail[];
65
+ links?: Links;
66
+ };
67
+ type AnalysisModelResponseDetail = {
68
+ fields?: AnalysisModelItemField[];
69
+ /** set only if previous property is true, to indicate if the business logic passes validation */
70
+ isDefinedLogicalModelValid?: boolean;
71
+ /** if the analysis model is constructed based on a user-defined business-logic (as opposed to a default one) */
72
+ isLogicalModelEnabled?: boolean;
73
+ masterItems?: AnalysisModelItemMasterItem[];
74
+ };
75
+ /**
76
+ * Request payload can be of two types, using natural language query or consist of fields or master items and optional target analysis.
77
+ * In below examples, consider sales as a master item and product as field, so to get recommendations using sales and product,
78
+ * you can utilize below three approaches, also you can set language parameter in headers as part of accept-language.
79
+ * Examples:
80
+ * ```
81
+ * {
82
+ * 'text': 'show me sales by product'
83
+ * }
84
+ * ```
85
+ * ```
86
+ * {
87
+ * 'fields': [
88
+ * {
89
+ * 'name': 'product'
90
+ * }
91
+ * ],
92
+ * 'libItems': [
93
+ * {
94
+ * libId: 'NwQfJ'
95
+ * }
96
+ * ]
97
+ * }
98
+ * ```
99
+ * ```
100
+ * {
101
+ * 'fields': [
102
+ * {
103
+ * 'name': 'product'
104
+ * }
105
+ * ],
106
+ * 'libItems': [
107
+ * {
108
+ * 'libId': 'NwQfJ'
109
+ * }
110
+ * ],
111
+ * 'targetAnalysis': {
112
+ * 'id': 'rank-rank'
113
+ * }
114
+ * }
115
+ * ```
116
+ */
117
+ type AnalysisRecommendRequest = RecommendNaturalLangQuery | RecommendItems;
118
+ type AnalysisRecommendationResponse = {
119
+ data?: AnalysisRecommendationResponseDetail[];
120
+ };
121
+ type AnalysisRecommendationResponseDetail = {
122
+ nluInfo?: PartialNluInfo[];
123
+ recAnalyses: RecommendedAnalysis[];
124
+ };
125
+ type AppAttributes = {
126
+ /** The description of the application */
127
+ description?: string;
128
+ /** Set custom locale instead of the system default */
129
+ locale?: string;
130
+ /** The name (title) of the application */
131
+ name?: string;
132
+ /** The space ID of the application */
133
+ spaceId?: string;
134
+ usage?: UsageEnum;
135
+ };
136
+ type AppContentList = {
137
+ /** Content list items. */
138
+ data?: AppContentListItem[];
139
+ /** Content library name. */
140
+ library?: string;
141
+ /** Content library relative listing path. Empty in case of root listed or representing actual subpath listed. */
142
+ subpath?: string;
143
+ };
144
+ type AppContentListItem = {
145
+ /** Unique content identifier. */
146
+ id?: string;
147
+ /** Unique content link. */
148
+ link?: string;
149
+ /** Content name. */
150
+ name?: string;
151
+ /** Content type. */
152
+ type?: string;
153
+ };
154
+ type AppObjectGenericType = "genericObject" | "genericBookmark" | "genericMeasure" | "genericDimension" | "genericVariable";
155
+ type AppUpdateAttributes = {
156
+ /** The description of the application. */
157
+ description?: string;
158
+ /** The name (title) of the application. */
159
+ name?: string;
160
+ };
161
+ /**
162
+ * Chart type given to current recommendation
163
+ */
164
+ type ChartType = "barchart" | "combochart" | "distributionplot" | "kpi" | "linechart" | "map" | "scatterplot" | "table";
165
+ /**
166
+ * classification defines the default role that attribute can play in an analysis
167
+ */
168
+ type Classifications = ("dimension" | "measure" | "temporal" | "city" | "address" | "boolean" | "country" | "date" | "email" | "geographical" | "geoPoint" | "geoPolygon" | "hour" | "latitude" | "monetary" | "ordinal" | "percentage" | "postalCode" | "quarter" | "stateProvince" | "timestamp" | "week" | "weekDay" | "year" | "yearDay")[];
169
+ /**
170
+ * Upper and lower bounds for items of specific classification types
171
+ */
172
+ type CompositionMinMax = {
173
+ max?: number;
174
+ min?: number;
175
+ };
176
+ type CreateApp = {
177
+ attributes?: AppAttributes;
178
+ };
179
+ type DataModelMetadata = {
180
+ /** List of field descriptions. */
181
+ fields?: FieldMetadata[];
182
+ /** If set to true, the app has section access configured. */
183
+ has_section_access?: boolean;
184
+ is_direct_query_mode?: boolean;
185
+ reload_meta?: LastReloadMetadata;
186
+ /** Static memory usage for the app. */
187
+ static_byte_size?: number;
188
+ /** List of table descriptions. */
189
+ tables?: TableMetadata[];
190
+ /** Profiling data of the tables in the app. */
191
+ tables_profiling_data?: TableProfilingData[];
192
+ usage?: UsageEnum;
193
+ };
194
+ /**
195
+ * An error object.
196
+ */
197
+ type Error = {
198
+ /** The error code. */
199
+ code: string;
200
+ /** A human-readable explanation specific to this occurrence of the problem. */
201
+ detail?: string;
202
+ /** Additional properties relating to the error. */
203
+ meta?: unknown;
204
+ /** References to the source of the error. */
205
+ source?: {
206
+ /** The URI query parameter that caused the error. */
207
+ parameter?: string;
208
+ /** A JSON Pointer to the property that caused the error. */
209
+ pointer?: string;
210
+ };
211
+ /** Summary of the problem. */
212
+ title: string;
213
+ };
214
+ type Errors = {
215
+ errors?: Error[];
216
+ };
217
+ type EvaluatorError = {
218
+ errors?: {
219
+ code?: string;
220
+ status?: number;
221
+ title?: string;
222
+ }[];
223
+ };
224
+ type FieldAttrType = "U" | "A" | "I" | "R" | "F" | "M" | "D" | "T" | "TS" | "IV";
225
+ /**
226
+ * Sets the formatting of a field.
227
+ * The properties of _qFieldAttributes_ and the formatting mechanism are described below.
228
+ *
229
+ * ### Formatting mechanism
230
+ * The formatting mechanism depends on the type set in _qType,_ as shown below:
231
+ * <div class=note>In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.</div>
232
+ *
233
+ * ### Type is DATE, TIME, TIMESTAMP or INTERVAL
234
+ * The following applies:
235
+ * * If a format pattern is defined in _qFmt_ , the formatting is as defined in _qFmt_ .
236
+ * * If _qFmt_ is empty, the formatting is defined by the number interpretation variables included at the top of the script ( _TimeFormat_ , _DateFormat_ , _TimeStampFormat_ ).
237
+ * * The properties _qDec_ , _qThou_ , _qnDec_ , _qUseThou_ are not used.
238
+ *
239
+ * ### Type is INTEGER
240
+ * The following applies:
241
+ * * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( _DecimalSep_ and _ThousandSep_ ).
242
+ * * If no format pattern is defined in _qFmt_ , no formatting is applied. The properties _qDec_ , _qThou_ , _qnDec_ , _qUseThou_ and the number interpretation variables defined in the script are not used .
243
+ *
244
+ * ### Type is REAL
245
+ * The following applies:
246
+ * * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( _DecimalSep_ and _ThousandSep_ ).
247
+ * * If no format pattern is defined in _qFmt_ , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties _qDec_ , _qThou_ , _qnDec_ , _qUseThou_ are not used.
248
+ * * If no format pattern is defined in _qFmt_ , and if _qnDec_ is defined and not 0, the property _qDec_ is used. If _qDec_ is not defined, the variable _DecimalSep_ defined at the top of the script is used.
249
+ * * If no format pattern is defined in _qFmt_ , and if _qnDec_ is 0, the number of decimals is 14 and the property _qDec_ is used. If _qDec_ is not defined, the variable _DecimalSep_ defined at the top of the script is used.
250
+ *
251
+ * ### Type is FIX
252
+ * The following applies:
253
+ * * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( _DecimalSep_ and _ThousandSep_ ).
254
+ * * If no format pattern is defined in _qFmt_ , the properties _qDec_ and _qnDec_ are used. If _qDec_ is not defined, the variable _DecimalSep_ defined at the top of the script is used.
255
+ *
256
+ * ### Type is MONEY
257
+ * The following applies:
258
+ * * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( _MoneyDecimalSep_ and _MoneyThousandSep_ ).
259
+ * * If no format pattern is defined in _qFmt_ , the engine uses the number interpretation variables included at the top of the script ( _MoneyDecimalSep_ and _MoneyThousandSep_ ).
260
+ *
261
+ * ### Type is ASCII
262
+ * No formatting, _qFmt_ is ignored.
263
+ */
264
+ type FieldAttributes = {
265
+ /** Defines the decimal separator.
266
+ * Example: **.** */
267
+ Dec?: string;
268
+ /** Defines the format pattern that applies to _qText_ .
269
+ * Is used in connection to the type of the field (parameter **qType** ).
270
+ * For more information, see _Formatting mechanism_.
271
+ * Example: _YYYY-MM-DD_ for a date. */
272
+ Fmt?: string;
273
+ /** Defines the thousand separator (if any).
274
+ * Is used if **qUseThou** is set to 1.
275
+ * Example: **,** */
276
+ Thou?: string;
277
+ Type?: FieldAttrType;
278
+ /** Defines whether or not a thousands separator must be used.
279
+ * Default is 0. */
280
+ UseThou?: number;
281
+ /** Number of decimals.
282
+ * Default is 10. */
283
+ nDec?: number;
284
+ };
285
+ type FieldInTableProfilingData = {
286
+ /** Average of all numerical values. NaN otherwise. */
287
+ Average?: number;
288
+ /** Average string length of textual values. 0 otherwise. */
289
+ AvgStringLen?: number;
290
+ /** Data evenness aka Shannon's entropy normalized to [0,1] */
291
+ DataEvenness?: number;
292
+ /** Number of distinct numeric values */
293
+ DistinctNumericValues?: number;
294
+ /** Number of distinct text values */
295
+ DistinctTextValues?: number;
296
+ /** Number of distinct values */
297
+ DistinctValues?: number;
298
+ /** Number of empty strings */
299
+ EmptyStrings?: number;
300
+ /** List of tags related to the field. */
301
+ FieldTags?: string[];
302
+ /** For textual values the first sorted string. */
303
+ FirstSorted?: string;
304
+ /** The .01, .05, .1, .25, .5, .75, .9, .95, .99 fractiles. Array of NaN otherwise. */
305
+ Fractiles?: number[];
306
+ FrequencyDistribution?: FrequencyDistributionData;
307
+ /** Kurtosis of the numerical values. NaN otherwise. */
308
+ Kurtosis?: number;
309
+ /** For textual values the last sorted string. */
310
+ LastSorted?: string;
311
+ /** Maximum value of numerical values. NaN otherwise. */
312
+ Max?: number;
313
+ /** Maximum string length of textual values. 0 otherwise. */
314
+ MaxStringLen?: number;
315
+ /** Median of all numerical values. NaN otherwise. */
316
+ Median?: number;
317
+ /** Minimum value of numerical values. NaN otherwise. */
318
+ Min?: number;
319
+ /** Minimum string length of textual values. 0 otherwise. */
320
+ MinStringLen?: number;
321
+ /** Three most frequent values and their frequencies */
322
+ MostFrequent?: SymbolFrequency[];
323
+ /** Name of the field. */
324
+ Name?: string;
325
+ /** Number of negative values */
326
+ NegValues?: number;
327
+ /** Number of null values */
328
+ NullValues?: number;
329
+ /** Sets the formatting of a field.
330
+ * The properties of _qFieldAttributes_ and the formatting mechanism are described below.
331
+ *
332
+ * ### Formatting mechanism
333
+ * The formatting mechanism depends on the type set in _qType,_ as shown below:
334
+ * <div class=note>In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.</div>
335
+ *
336
+ * ### Type is DATE, TIME, TIMESTAMP or INTERVAL
337
+ * The following applies:
338
+ * * If a format pattern is defined in _qFmt_ , the formatting is as defined in _qFmt_ .
339
+ * * If _qFmt_ is empty, the formatting is defined by the number interpretation variables included at the top of the script ( _TimeFormat_ , _DateFormat_ , _TimeStampFormat_ ).
340
+ * * The properties _qDec_ , _qThou_ , _qnDec_ , _qUseThou_ are not used.
341
+ *
342
+ * ### Type is INTEGER
343
+ * The following applies:
344
+ * * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( _DecimalSep_ and _ThousandSep_ ).
345
+ * * If no format pattern is defined in _qFmt_ , no formatting is applied. The properties _qDec_ , _qThou_ , _qnDec_ , _qUseThou_ and the number interpretation variables defined in the script are not used .
346
+ *
347
+ * ### Type is REAL
348
+ * The following applies:
349
+ * * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( _DecimalSep_ and _ThousandSep_ ).
350
+ * * If no format pattern is defined in _qFmt_ , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties _qDec_ , _qThou_ , _qnDec_ , _qUseThou_ are not used.
351
+ * * If no format pattern is defined in _qFmt_ , and if _qnDec_ is defined and not 0, the property _qDec_ is used. If _qDec_ is not defined, the variable _DecimalSep_ defined at the top of the script is used.
352
+ * * If no format pattern is defined in _qFmt_ , and if _qnDec_ is 0, the number of decimals is 14 and the property _qDec_ is used. If _qDec_ is not defined, the variable _DecimalSep_ defined at the top of the script is used.
353
+ *
354
+ * ### Type is FIX
355
+ * The following applies:
356
+ * * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( _DecimalSep_ and _ThousandSep_ ).
357
+ * * If no format pattern is defined in _qFmt_ , the properties _qDec_ and _qnDec_ are used. If _qDec_ is not defined, the variable _DecimalSep_ defined at the top of the script is used.
358
+ *
359
+ * ### Type is MONEY
360
+ * The following applies:
361
+ * * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( _MoneyDecimalSep_ and _MoneyThousandSep_ ).
362
+ * * If no format pattern is defined in _qFmt_ , the engine uses the number interpretation variables included at the top of the script ( _MoneyDecimalSep_ and _MoneyThousandSep_ ).
363
+ *
364
+ * ### Type is ASCII
365
+ * No formatting, _qFmt_ is ignored. */
366
+ NumberFormat?: FieldAttributes;
367
+ /** Number of numeric values */
368
+ NumericValues?: number;
369
+ /** Number of positive values */
370
+ PosValues?: number;
371
+ /** Skewness of the numerical values. NaN otherwise. */
372
+ Skewness?: number;
373
+ /** Standard deviation of numerical values. NaN otherwise. */
374
+ Std?: number;
375
+ /** Sum of all numerical values. NaN otherwise. */
376
+ Sum?: number;
377
+ /** Squared sum of all numerical values. NaN otherwise. */
378
+ Sum2?: number;
379
+ /** Sum of all characters in strings in the field */
380
+ SumStringLen?: number;
381
+ /** Number of textual values */
382
+ TextValues?: number;
383
+ /** Number of zero values for numerical values */
384
+ ZeroValues?: number;
385
+ };
386
+ type FieldMetadata = {
387
+ /** If set to true, the field has one and only one selection (not 0 and not more than 1).
388
+ * If this property is set to true, the field cannot be cleared anymore and no more selections can be performed in that field.
389
+ * The default value is false. */
390
+ always_one_selected?: boolean;
391
+ /** Static RAM memory used in bytes. */
392
+ byte_size?: number;
393
+ /** Number of distinct field values. */
394
+ cardinal?: number;
395
+ /** Field comment. */
396
+ comment?: string;
397
+ /** If set to true, only distinct field values are shown.
398
+ * The default value is false. */
399
+ distinct_only?: boolean;
400
+ /** Hash of the data in the field. If the data in a reload is the same, the hash will be consistent. */
401
+ hash?: string;
402
+ /** If set to true, the field is hidden.
403
+ * The default value is false. */
404
+ is_hidden?: boolean;
405
+ /** If set to true, the field is locked.
406
+ * The default value is false. */
407
+ is_locked?: boolean;
408
+ /** Is set to true if the value is a numeric.
409
+ * The default value is false. */
410
+ is_numeric?: boolean;
411
+ /** If set to true, the field is semantic.
412
+ * The default value is false. */
413
+ is_semantic?: boolean;
414
+ /** If set to true, the field is a system field.
415
+ * The default value is false. */
416
+ is_system?: boolean;
417
+ /** Name of the field. */
418
+ name?: string;
419
+ /** List of table names. */
420
+ src_tables?: string[];
421
+ /** Gives information on a field. For example, it can return the type of the field.
422
+ * Examples: key, text, ASCII. */
423
+ tags?: string[];
424
+ /** Total number of field values. */
425
+ total_count?: number;
426
+ };
427
+ type FieldOverride = {
428
+ classifications?: string[];
429
+ defaultAggregation?: string;
430
+ };
431
+ type FileData = BodyInit;
432
+ type Filter = {
433
+ readonly createdAt?: string;
434
+ /** The filter description. */
435
+ description?: string;
436
+ filterType?: FilterType;
437
+ filterV1_0?: FilterV10;
438
+ filterVersion?: "filter-1.0" | "filter-2.0";
439
+ /** The filter ID (bookmarkId). */
440
+ readonly id?: string;
441
+ /** The filter name. */
442
+ name?: string;
443
+ /** The user that owns the filter, if missing the same as the request user. */
444
+ ownerId?: string;
445
+ readonly updatedAt?: string;
446
+ };
447
+ /**
448
+ * Error occured during the Filter creation.
449
+ */
450
+ type FilterError = {
451
+ /** The unique code for the error
452
+ *
453
+ * - "REP-400000" Bad request. The server could not understand the request due to invalid syntax.
454
+ * - "REP-400008" Selections error.
455
+ * - "REP-400015" Bad request in enigma request. The patch value has invalid JSON format.
456
+ * - "REP-401000" Unauthorized. The client must authenticate itself to get the requested response.
457
+ * - "REP-401001" Unauthorized, bad JWT.
458
+ * - "REP-403000" Forbidden. The client does not have access rights to the content.
459
+ * - "REP-403001" App forbidden, the user does not have read permission on the app.
460
+ * - "REP-403002" Chart type not supported.
461
+ * - "REP-404000" Not found. The server can not find the requested resource.
462
+ * - "REP-409043" Filter name conflict. The filter name must be unique.
463
+ * - "REP-429000" Too many request. The user has sent too many requests in a given amount of time ("rate limiting").
464
+ * - "REP-429012" Exceeded max session tenant quota. A tenant has opened too many different sessions at the same time.
465
+ * - "REP-429016" Exceeded max session tenant quota per day.
466
+ * - "REP-500000" Fail to resolve resource.
467
+ * - "REP-503005" Engine unavailable, qix-sessions error no engines available.
468
+ * - "REP-503013" Session unavailable. The engine session used to create the report is unavailable.
469
+ * - "REP-504042" Context deadline exceeded applying selections of the Filter.
470
+ * - "REP-500031" Error creating bookmark.
471
+ * - "REP-404032" Bookmark not found after creating the bookmark.
472
+ * - "REP-500033" Error destroying bookmark.
473
+ * - "REP-404033" Bookmark not found destroying the bookmark.
474
+ * - "REP-409043" Dupliacate bookmark name.
475
+ * - "REP-429034" Filters quota exceeded.
476
+ * - "REP-400044" Missing or renamed field.
477
+ * - "REP-403049" Report filter access not allowed. */
478
+ code: string;
479
+ /** A summary in english explaining what went wrong. */
480
+ title: string;
481
+ };
482
+ /**
483
+ * Errors occured during the Filter creation.
484
+ */
485
+ type FilterErrors = {
486
+ errors: FilterError[];
487
+ };
488
+ type FilterField = {
489
+ /** Gets the resource description. */
490
+ description?: string;
491
+ name: string;
492
+ overrideValues?: boolean;
493
+ selectExcluded?: boolean;
494
+ /** The filter values. */
495
+ values?: FilterFieldValue[];
496
+ };
497
+ type FilterFieldValue = {
498
+ valueAsNumber?: Float64;
499
+ valueAsText?: string;
500
+ valueType?: "string" | "number" | "evaluate" | "search";
501
+ };
502
+ type FilterItemPatch = {
503
+ /** The filter description. */
504
+ description?: string;
505
+ filterV1_0?: FilterV10;
506
+ filterVersion?: "filter-1.0" | "filter-2.0";
507
+ /** The filter name. */
508
+ name?: string;
509
+ /** The user that owns the filter, if missing the same as the request user. */
510
+ ownerId?: string;
511
+ };
512
+ type FilterList = {
513
+ /** a list of filters containing all the filters properties (like name,description...) except the filter definition (like FilterV1_0) */
514
+ data: FilterListItem[];
515
+ links: LinksResponse;
516
+ };
517
+ type FilterListItem = {
518
+ readonly createdAt?: string;
519
+ /** The filter description. */
520
+ readonly description?: string;
521
+ filterType?: FilterType;
522
+ filterV1_0?: FilterV10;
523
+ readonly filterVersion?: "filter-1.0" | "filter-2.0";
524
+ /** The filter ID (bookmarkId) */
525
+ readonly id?: string;
526
+ /** The filter name. */
527
+ readonly name?: string;
528
+ /** The user that owns the filter, if missing the same as the request user. */
529
+ readonly ownerId?: string;
530
+ readonly updatedAt?: string;
531
+ };
532
+ /**
533
+ * @example
534
+ * {
535
+ * description: "this is a filter sample",
536
+ * filterType: "REP",
537
+ * filterV1_0: {
538
+ * fieldsByState: {
539
+ * "$": [
540
+ * {
541
+ * name: "Country",
542
+ * overrideValues: false,
543
+ * selectExcluded: false,
544
+ * values: [
545
+ * {
546
+ * valueAsText: "1-Argentina",
547
+ * valueType: "string"
548
+ * },
549
+ * {
550
+ * valueAsText: "4-Brazil",
551
+ * valueType: "string"
552
+ * }
553
+ * ]
554
+ * },
555
+ * {
556
+ * name: "Order number",
557
+ * overrideValues: false,
558
+ * selectExcluded: false,
559
+ * values: [
560
+ * {
561
+ * valueAsNumber: 61300,
562
+ * valueAsText: "61300",
563
+ * valueType: "number"
564
+ * }
565
+ * ]
566
+ * }
567
+ * ]
568
+ * }
569
+ * },
570
+ * filterVersion: "filter-1.0",
571
+ * name: "Filter sample"
572
+ * }
573
+ */
574
+ type FilterRequest = {
575
+ /** The App ID. */
576
+ appId?: string;
577
+ /** The filter description. */
578
+ description?: string;
579
+ filterType: FilterType;
580
+ filterV1_0?: FilterV10;
581
+ filterVersion: "filter-1.0" | "filter-2.0";
582
+ /** The filter name. */
583
+ name: string;
584
+ /** The user that owns the filter, if missing the same as the request user. */
585
+ ownerId?: string;
586
+ };
587
+ type FilterType = "REP" | "SUB";
588
+ /**
589
+ * @example
590
+ * {
591
+ * fieldsByState: {
592
+ * "$": [
593
+ * {
594
+ * name: "Country",
595
+ * overrideValues: false,
596
+ * selectExcluded: false,
597
+ * values: [
598
+ * {
599
+ * valueAsText: "1-Argentina",
600
+ * valueType: "string"
601
+ * },
602
+ * {
603
+ * valueAsText: "4-Brazil",
604
+ * valueType: "string"
605
+ * }
606
+ * ]
607
+ * },
608
+ * {
609
+ * name: "Order number",
610
+ * overrideValues: false,
611
+ * selectExcluded: false,
612
+ * values: [
613
+ * {
614
+ * valueAsNumber: 61300,
615
+ * valueAsText: "61300",
616
+ * valueType: "number"
617
+ * }
618
+ * ]
619
+ * }
620
+ * ]
621
+ * }
622
+ * }
623
+ */
624
+ type FilterV10 = {
625
+ /** Map of fields to apply by state. Maximum number of states allowed is 125. Maximum number of fields allowed is 125 and maximum number of overall field values allowed is 150000. */
626
+ fieldsByState?: Record<string, FilterField[]>;
627
+ /** The filter variables. */
628
+ variables?: FilterVariable[];
629
+ };
630
+ type FilterVariable = {
631
+ evaluate?: boolean;
632
+ name: string;
633
+ value?: string;
634
+ };
635
+ type FiltersCount = {
636
+ /** The total number of filters. */
637
+ readonly total?: number;
638
+ };
639
+ type Float64 = number;
640
+ type FrequencyDistributionData = {
641
+ /** Bins edges. */
642
+ BinsEdges?: number[];
643
+ /** Bins frequencies. */
644
+ Frequencies?: number[];
645
+ /** Number of bins. */
646
+ NumberOfBins?: number;
647
+ };
648
+ type HardwareMeta = {
649
+ /** Number of logical cores available. */
650
+ logical_cores?: number;
651
+ /** RAM available. */
652
+ total_memory?: number;
653
+ };
654
+ type Href = {
655
+ href?: string;
656
+ };
657
+ /**
658
+ * Contains dynamic JSON data specified by the client.
659
+ */
660
+ type JsonObject = unknown;
661
+ type LastReloadMetadata = {
662
+ /** Number of CPU milliseconds it took to reload the app. */
663
+ cpu_time_spent_ms?: number;
664
+ /** Maximum number of bytes used during full reload of the app. */
665
+ fullReloadPeakMemoryBytes?: number;
666
+ hardware?: HardwareMeta;
667
+ /** Maximum number of bytes used during partial reload of the app. */
668
+ partialReloadPeakMemoryBytes?: number;
669
+ /** Maximum number of bytes used during reload of the app. */
670
+ peak_memory_bytes?: number;
671
+ };
672
+ type LineageInfoRest = {
673
+ /** A string indicating the origin of the data:
674
+ * * [filename]: the data comes from a local file.
675
+ * * INLINE: the data is entered inline in the load script.
676
+ * * RESIDENT: the data comes from a resident table. The table name is listed.
677
+ * * AUTOGENERATE: the data is generated from the load script (no external table of data source).
678
+ * * Provider: the data comes from a data connection. The connector source name is listed.
679
+ * * [webfile]: the data comes from a web-based file.
680
+ * * STORE: path to QVD or TXT file where data is stored.
681
+ * * EXTENSION: the data comes from a Server Side Extension (SSE). */
682
+ discriminator?: string;
683
+ /** The LOAD and SELECT script statements from the data load script. */
684
+ statement?: string;
685
+ };
686
+ type LinkResponse = {
687
+ href?: string;
688
+ };
689
+ type Links = {
690
+ next?: Href;
691
+ prev?: Href;
692
+ self?: Href;
693
+ };
694
+ /**
695
+ * @example
696
+ * {
697
+ * next: {
698
+ * href: "https://tenant.qlik-cloud.com:443/api/v1/apps/816e23e1-03d2-446b-8721-cdee6b5e59cf/report-filters?filter=&filterTypes=REP&filterTypes=REP&limit=20&page=0&sort=%2Bname"
699
+ * },
700
+ * prev: {
701
+ * href: "https://tenant.qlik-cloud.com:443/api/v1/apps/816e23e1-03d2-446b-8721-cdee6b5e59cf/report-filters?filter=&filterTypes=REP&filterTypes=REP&limit=20&page=0&sort=%2Bname"
702
+ * },
703
+ * self: {
704
+ * href: "https://tenant.qlik-cloud.com:443/api/v1/apps/816e23e1-03d2-446b-8721-cdee6b5e59cf/report-filters?filter=&filterTypes=REP&filterTypes=REP&limit=20&page=0&sort=%2Bname"
705
+ * }
706
+ * }
707
+ */
708
+ type LinksResponse = {
709
+ next: LinkResponse;
710
+ prev: LinkResponse;
711
+ self: LinkResponse;
712
+ };
713
+ type Log = {
714
+ /** Provides a link to download the log file. */
715
+ log?: string;
716
+ };
717
+ type NavigationLink = {
718
+ href?: string;
719
+ };
720
+ type NavigationLinks = {
721
+ next?: NavigationLink;
722
+ prev?: NavigationLink;
723
+ };
724
+ /**
725
+ * Application attributes and user privileges.
726
+ */
727
+ type NxApp = {
728
+ /** App attributes. This structure can also contain extra user-defined attributes. */
729
+ attributes?: NxAttributes;
730
+ /** Object create privileges. Hints to the client what type of objects the user is allowed to create. */
731
+ create?: NxAppCreatePrivileges[];
732
+ /** Application privileges.
733
+ * Hints to the client what actions the user is allowed to perform.
734
+ * Could be any of:
735
+ * * read
736
+ * * create
737
+ * * update
738
+ * * delete
739
+ * * reload
740
+ * * import
741
+ * * publish
742
+ * * duplicate
743
+ * * export
744
+ * * exportdata
745
+ * * change_owner
746
+ * * change_space */
747
+ privileges?: string[];
748
+ };
749
+ type NxAppCreatePrivileges = {
750
+ /** Is set to true if the user has privileges to create the resource. */
751
+ canCreate?: boolean;
752
+ /** Type of resource. For example, sheet, story, bookmark, etc. */
753
+ resource?: string;
754
+ };
755
+ /**
756
+ * Application object attributes and user privileges.
757
+ */
758
+ type NxAppObject = {
759
+ /** App object attributes. This structure can also contain extra user-defined attributes. */
760
+ attributes?: NxObjectAttributes;
761
+ /** Application object privileges.
762
+ * Hints to the client what actions the user is allowed to perform.
763
+ * Could be any of:
764
+ * * read
765
+ * * create
766
+ * * update
767
+ * * delete
768
+ * * publish
769
+ * * exportdata
770
+ * * change_owner */
771
+ privileges?: string[];
772
+ };
773
+ /**
774
+ * App attributes. This structure can also contain extra user-defined attributes.
775
+ */
776
+ type NxAttributes = {
777
+ /** The date and time when the app was created. */
778
+ createdDate?: string;
779
+ /** Contains dynamic JSON data specified by the client. */
780
+ custom?: JsonObject;
781
+ /** App description. */
782
+ description?: string;
783
+ /** The dynamic color of the app. */
784
+ dynamicColor?: string;
785
+ /** If set to true, the app is encrypted. */
786
+ encrypted?: boolean;
787
+ /** If set to true, the app has section access configured, */
788
+ hasSectionAccess?: boolean;
789
+ /** The App ID. */
790
+ id?: string;
791
+ /** True if the app is a Direct Query app, false if not */
792
+ isDirectQueryMode?: boolean;
793
+ /** Date and time of the last reload of the app. */
794
+ lastReloadTime?: string;
795
+ /** The date and time when the app was modified. */
796
+ modifiedDate?: string;
797
+ /** App name. */
798
+ name?: string;
799
+ /** The Origin App ID for published apps. */
800
+ originAppId?: string;
801
+ /** @deprecated
802
+ * Deprecated. Use the Users API to fetch user metadata. */
803
+ owner?: string;
804
+ /** Identifier of the app owner. */
805
+ ownerId?: string;
806
+ /** The date and time when the app was published, empty if unpublished. Use to determine if an app is published in Qlik Cloud. */
807
+ publishTime?: string;
808
+ /** For Qlik Cloud, indicates whether the app has been distributed from client-managed, not whether it has been published. To determine
809
+ * if the app is published in Qlik Cloud, check for a non-empty value in the publishTime field. For client-managed, determines if the app is published. */
810
+ published?: boolean;
811
+ /** App thumbnail. */
812
+ thumbnail?: string;
813
+ usage?: UsageEnum;
814
+ };
815
+ /**
816
+ * App object attributes. This structure can also contain extra user-defined attributes.
817
+ */
818
+ type NxObjectAttributes = {
819
+ /** True if the object is approved. */
820
+ approved?: boolean;
821
+ /** The date and time when the object was created. */
822
+ createdAt?: string;
823
+ /** Object description. */
824
+ description?: string;
825
+ genericType?: AppObjectGenericType;
826
+ /** The object Id. */
827
+ id?: string;
828
+ /** Object name. */
829
+ name?: string;
830
+ /** The type of the object. */
831
+ objectType?: string;
832
+ /** The object owner's Id. */
833
+ ownerId?: string;
834
+ /** The date and time when the object was published, empty if unpublished. */
835
+ publishedAt?: string;
836
+ /** The date and time when the object was modified. */
837
+ updatedAt?: string;
838
+ };
839
+ type NxPatch = {
840
+ Op?: NxPatchOperationType;
841
+ /** Path to the property to add, remove or replace. */
842
+ Path?: string;
843
+ /** This parameter is not used in a remove operation.
844
+ * Corresponds to the value of the property to add or to the new value of the property to update.
845
+ * Examples:
846
+ * "false", "2", "\"New title\"" */
847
+ Value?: string;
848
+ };
849
+ type NxPatchOperationType = "add" | "remove" | "replace";
850
+ /**
851
+ * Contains break down of the asked question in the form of tokens with their classification.
852
+ */
853
+ type PartialNluInfo = {
854
+ /** Qlik sense application field selected for given token or phrase */
855
+ fieldName?: string;
856
+ /** Filter value found from query */
857
+ fieldValue?: string;
858
+ /** Role of the token or phrase from query */
859
+ role?: "dimension" | "measure" | "date";
860
+ /** Matching token or phrase from query */
861
+ text?: string;
862
+ /** Type of token from query */
863
+ type?: "field" | "filter" | "master_dimension" | "master_measure" | "custom_analysis";
864
+ };
865
+ type PatchFilter = PatchFilterItem[];
866
+ type PatchFilterItem = {
867
+ /** operation (replace). */
868
+ op: "replace";
869
+ /** A JSON Pointer path (/). */
870
+ path: "/filter";
871
+ /** The value to be used for this operation. The properties that cannot be patched include id, filterType, appId */
872
+ value: {
873
+ Filter?: FilterItemPatch;
874
+ };
875
+ };
876
+ type PublishApp = {
877
+ attributes?: AppUpdateAttributes;
878
+ data?: PublishData;
879
+ /** The original is moved instead of copied. The current published state of all objects is kept. */
880
+ moveApp?: boolean;
881
+ /** If app is moved, originAppId needs to be provided. */
882
+ originAppId?: string;
883
+ /** The managed space ID where the app will be published. */
884
+ spaceId?: string;
885
+ };
886
+ type PublishData = "source" | "target";
887
+ /**
888
+ * structure for providing fields in recommendation request, user can retrieve the fields using insight-analyses/model endpoint
889
+ */
890
+ type RecommendFieldItem = {
891
+ name?: string;
892
+ overrides?: FieldOverride;
893
+ };
894
+ type RecommendItems = {
895
+ fields?: RecommendFieldItem[];
896
+ libItems?: RecommendMasterItem[];
897
+ targetAnalysis?: {
898
+ /** id of the target analysis, returned by the GET insight-analyses endpoint */
899
+ id?: string;
900
+ };
901
+ };
902
+ /**
903
+ * structure for providing master items in recommendation request, user can retrieve the libId of master item using insight-analyses/model endpoint
904
+ */
905
+ type RecommendMasterItem = {
906
+ libId?: string;
907
+ overrides?: {
908
+ format?: NumberFormat;
909
+ };
910
+ };
911
+ type RecommendNaturalLangQuery = {
912
+ /** The NL query. */
913
+ text: string;
914
+ };
915
+ type RecommendedAnalysis = RecommendedAnalysisCore & {
916
+ /** part analyses (only for macro analyses) */
917
+ parts?: RecommendedAnalysisCore[];
918
+ };
919
+ type RecommendedAnalysisCore = {
920
+ analysis?: AnalysisDetails;
921
+ /** Chart type given to current recommendation */
922
+ chartType?: ChartType;
923
+ /** (chart options + hypercube definition) */
924
+ options?: unknown;
925
+ /** percentage of selected items in the analysis to the overall items passed to the endpoint */
926
+ relevance?: number;
927
+ };
928
+ type ReloadIncludeFile = {
929
+ /** The connection name. */
930
+ connection?: string;
931
+ /** File location within the connection. */
932
+ path?: string;
933
+ /** File QRI resource identifier. */
934
+ qri?: string;
935
+ };
936
+ type ReloadListMetadata = {
937
+ /** Array of ReloadMeta. */
938
+ data?: ReloadMeta[];
939
+ };
940
+ type ReloadMeta = {
941
+ /** A Base64-encoded hash value of the new section access database. */
942
+ accessDbHash?: string;
943
+ /** A Base64-encoded hash value of the new app database. */
944
+ appDbHash?: string;
945
+ /** Duration of reload (ms). */
946
+ duration?: number;
947
+ /** Time when reload ended. */
948
+ endTime?: string;
949
+ /** Files brought into the script via include/mustInclude macros. */
950
+ includeFiles?: ReloadIncludeFile[];
951
+ /** True if the reload is a partial reload. */
952
+ isPartialReload?: boolean;
953
+ loadDataFilesBytes?: number;
954
+ loadExternalBytes?: number;
955
+ loadFilesBytes?: number;
956
+ /** Reload identifier. */
957
+ reloadId?: string;
958
+ /** If greater than or equal 0, defines max number of rows loaded from a data source. */
959
+ rowLimit?: number;
960
+ /** Set to true to skip Store statements.
961
+ * The default value is false. */
962
+ skipStore?: boolean;
963
+ /** List of external loaded or stored statements. */
964
+ statements?: ReloadStatements[];
965
+ storeDataFilesBytes?: number;
966
+ storeFilesBytes?: number;
967
+ /** A Base64-encoded hash value of all fields stored via the store statements. */
968
+ storeHash?: string;
969
+ /** true if the reload was successful. */
970
+ success?: boolean;
971
+ };
972
+ type ReloadStatements = {
973
+ /** The connection name. */
974
+ connection?: string;
975
+ /** Connection ID. */
976
+ connectionId?: string;
977
+ /** Data loaded from the network (bytes). */
978
+ dataSize?: number;
979
+ /** Duration of data generation (ms). */
980
+ duration?: number;
981
+ /** Label of the resource level node in lineage. */
982
+ label?: string;
983
+ /** Number of fields loaded. */
984
+ nbrOfFields?: number;
985
+ /** Number of rows loaded. */
986
+ nbrOfRows?: number;
987
+ /** Partial load operation. e.g. add/replace/update/merge. n/a when not in partial load mode. */
988
+ partialReloadOperation?: string;
989
+ /** Resource Identifier. */
990
+ qri?: string;
991
+ /** Name of the source table in lineage. */
992
+ tableName?: string;
993
+ /** Type of statement, e.g. Store/Load. */
994
+ type?: string;
995
+ };
996
+ type RepublishApp = {
997
+ attributes?: AppUpdateAttributes;
998
+ /** Validate that source app is same as originally published. */
999
+ checkOriginAppId?: boolean;
1000
+ data?: PublishData;
1001
+ /** The target ID to be republished. */
1002
+ targetId?: string;
1003
+ };
1004
+ type Script = {
1005
+ script?: string;
1006
+ };
1007
+ type ScriptIssue = {
1008
+ /** UTF-8 byte column of the issue. */
1009
+ Column?: number;
1010
+ /** Additional information like workarounds or clarifications. */
1011
+ Info?: string;
1012
+ /** Line in the tab of the issue. */
1013
+ Line?: number;
1014
+ /** Error or warning string. What is the problem. */
1015
+ Msg?: string;
1016
+ /** The index of the tab for the issue. */
1017
+ Tab?: number;
1018
+ };
1019
+ type ScriptIssues = {
1020
+ Errors?: ScriptIssue[];
1021
+ Warnings?: ScriptIssue[];
1022
+ };
1023
+ type ScriptLogList = {
1024
+ /** Array of scriptLogMeta. */
1025
+ data?: ScriptLogMeta[];
1026
+ };
1027
+ type ScriptLogMeta = {
1028
+ /** Duration of reload (ms). */
1029
+ duration?: number;
1030
+ /** Time when reload ended. */
1031
+ endTime?: string;
1032
+ links?: Log;
1033
+ /** Reload identifier. */
1034
+ reloadId?: string;
1035
+ /** True if the reload was successful. */
1036
+ success?: boolean;
1037
+ };
1038
+ type ScriptMeta = {
1039
+ /** Script version last modification time. */
1040
+ modifiedTime?: string;
1041
+ /** User last modifying script version. */
1042
+ modifierId?: string;
1043
+ /** Script id. */
1044
+ scriptId?: string;
1045
+ /** Script size. */
1046
+ size?: number;
1047
+ /** Description of this script version */
1048
+ versionMessage?: string;
1049
+ };
1050
+ type ScriptMetaList = {
1051
+ links?: NavigationLinks;
1052
+ privileges?: string[];
1053
+ /** Script versions metadata. */
1054
+ scripts?: ScriptMeta[];
1055
+ };
1056
+ type ScriptVersion = {
1057
+ /** Script text. */
1058
+ script?: string;
1059
+ /** Description of this script version */
1060
+ versionMessage?: string;
1061
+ };
1062
+ type SimplifiedClassifications = ("dimension" | "measure" | "temporal" | "geographical")[];
1063
+ type SymbolFrequency = {
1064
+ /** Frequency of the above symbol in the field */
1065
+ Frequency?: number;
1066
+ Symbol?: SymbolValue;
1067
+ };
1068
+ type SymbolValue = {
1069
+ /** Numeric value of the symbol. NaN otherwise. */
1070
+ Number?: number;
1071
+ /** String value of the symbol. This parameter is optional and present only if Symbol is a string. */
1072
+ Text?: string;
1073
+ };
1074
+ type TableMetadata = {
1075
+ /** Static RAM memory used in bytes. */
1076
+ byte_size?: number;
1077
+ /** Table comment. */
1078
+ comment?: string;
1079
+ /** If set to true, the table is loose due to circular connection.
1080
+ * The default value is false. */
1081
+ is_loose?: boolean;
1082
+ /** If set to true, the table is semantic.
1083
+ * The default value is false. */
1084
+ is_semantic?: boolean;
1085
+ /** If set to true, the table is a system table.
1086
+ * The default value is false. */
1087
+ is_system?: boolean;
1088
+ /** Name of the table. */
1089
+ name?: string;
1090
+ /** Number of fields. */
1091
+ no_of_fields?: number;
1092
+ /** Number of key fields. */
1093
+ no_of_key_fields?: number;
1094
+ /** Number of rows. */
1095
+ no_of_rows?: number;
1096
+ };
1097
+ type TableProfilingData = {
1098
+ /** Field values profiling info */
1099
+ FieldProfiling?: FieldInTableProfilingData[];
1100
+ /** Number of rows in the table. */
1101
+ NoOfRows?: number;
1102
+ };
1103
+ type UpdateApp = {
1104
+ attributes?: AppUpdateAttributes;
1105
+ };
1106
+ type UpdateOwner = {
1107
+ ownerId?: string;
1108
+ };
1109
+ type UpdateSpace = {
1110
+ spaceId?: string;
1111
+ };
1112
+ type UsageEnum = "ANALYTICS" | "DATA_PREPARATION" | "DATAFLOW_PREP" | "SINGLE_TABLE_PREP";
1113
+ type UserPrivileges = "can_create_app" | "can_import_app" | "can_create_session_app";
1114
+ type Classification = {
1115
+ absoluteDiff?: number;
1116
+ diff?: number;
1117
+ trend?: string;
1118
+ };
1119
+ type Cmpbool = Classification & {
1120
+ baseline?: boolean;
1121
+ comparison?: boolean;
1122
+ };
1123
+ type Cmpfloat = Classification & {
1124
+ baseline?: number;
1125
+ comparison?: number;
1126
+ };
1127
+ type CmpfloatWithTimeout = Cmpfloat & {
1128
+ baselineTimeoutStatusCode?: string;
1129
+ comparisonTimeoutStatusCode?: string;
1130
+ };
1131
+ type Cmpint = Classification & {
1132
+ baseline?: number;
1133
+ comparison?: number;
1134
+ };
1135
+ type Comparison = {
1136
+ appOpenTimeSeconds?: Cmpfloat;
1137
+ dataModelSizeMib?: Cmpfloat;
1138
+ documentSizeMib?: Cmpfloat;
1139
+ fileSizeMib?: Cmpfloat;
1140
+ hasSectionAccess?: Cmpbool;
1141
+ maxMemoryMib?: Cmpfloat;
1142
+ objHeavy?: Sortedcomparisonoobjheavy;
1143
+ objMemoryLimit?: ComparisonobjMemoryLimit;
1144
+ objNoCache?: Sortedcomparisonobjresponsetime;
1145
+ objSingleThreaded?: Sortedcomparisonobjresponsetime;
1146
+ objSlowCached?: Sortedcomparisonobjresponsetime;
1147
+ objSlowUncached?: Sortedcomparisonobjresponsetime;
1148
+ objectCount?: Cmpint;
1149
+ rowCount?: Cmpint;
1150
+ sheetCount?: Cmpint;
1151
+ sheetsCached?: Sortedcomparisonobjresponsetime;
1152
+ sheetsUncached?: Sortedcomparisonobjresponsetime;
1153
+ topFieldsByBytes?: Sortedcomparisonfields;
1154
+ topTablesByBytes?: Sortedcomparisontables;
1155
+ };
1156
+ type Comparisonfields = (Objecttopspec & {
1157
+ byte_size?: Cmpint;
1158
+ cardinal?: Cmpint;
1159
+ dataSourceStatus?: "full" | "none" | "baselinemissing" | "comparisonmissing";
1160
+ is_system?: Cmpbool;
1161
+ name?: string;
1162
+ total_count?: Cmpint;
1163
+ })[];
1164
+ type ComparisonobjMemoryLimit = (Objectspec & {
1165
+ baselineMemoryLimitStatusCode?: string;
1166
+ comparisonMemoryLimitStatusCode?: string;
1167
+ dataSourceStatus?: "full" | "none" | "baselinemissing" | "comparisonmissing";
1168
+ })[];
1169
+ type Comparisonobjresponsetime = (Objectspec & {
1170
+ dataSourceStatus?: "full" | "none" | "baselinemissing" | "comparisonmissing";
1171
+ responseTimeSeconds1?: CmpfloatWithTimeout;
1172
+ responseTimeSeconds2?: CmpfloatWithTimeout;
1173
+ })[];
1174
+ type Comparisonoobjheavy = (Objectspec & {
1175
+ cpuQuotient1?: Cmpfloat;
1176
+ cpuQuotient2?: Cmpfloat;
1177
+ cpuSeconds1?: Cmpfloat;
1178
+ cpuSeconds2?: Cmpfloat;
1179
+ dataSourceStatus?: "full" | "none" | "baselinemissing" | "comparisonmissing";
1180
+ })[];
1181
+ type Comparisontables = (Objecttopspec & {
1182
+ byte_size?: Cmpint;
1183
+ dataSourceStatus?: "full" | "none" | "baselinemissing" | "comparisonmissing";
1184
+ is_system?: Cmpbool;
1185
+ name?: string;
1186
+ no_of_rows?: Cmpint;
1187
+ })[];
1188
+ type Evaluation = {
1189
+ appId?: string;
1190
+ appItemId?: string;
1191
+ appName?: string;
1192
+ details?: {
1193
+ concurrentReload?: boolean;
1194
+ /** @deprecated */
1195
+ dedicated?: boolean;
1196
+ engineHasCache?: boolean;
1197
+ errors?: string[];
1198
+ objectMetrics?: Record<string, Resultentry>;
1199
+ warnings?: string[];
1200
+ };
1201
+ ended?: string;
1202
+ events?: Event[];
1203
+ id?: string;
1204
+ metadata?: Metadata;
1205
+ result?: Result;
1206
+ sheetId?: string;
1207
+ sheetTitle?: string;
1208
+ started?: string;
1209
+ status?: string;
1210
+ tenantId?: string;
1211
+ timestamp?: string;
1212
+ version?: number;
1213
+ };
1214
+ type Evaluations = {
1215
+ data?: Evaluation[];
1216
+ links?: {
1217
+ next?: {
1218
+ href?: Href;
1219
+ };
1220
+ prev?: {
1221
+ href?: Href;
1222
+ };
1223
+ };
1224
+ };
1225
+ type Event = {
1226
+ details?: string;
1227
+ errorCode?: string;
1228
+ objectId?: string;
1229
+ objectTitle?: string;
1230
+ objectType?: string;
1231
+ objectVisualization?: string;
1232
+ severity?: string;
1233
+ sheetId?: string;
1234
+ sheetTitle?: string;
1235
+ };
1236
+ /**
1237
+ * @example
1238
+ * "/api/v1/evaluations/appId=a84c22cf-31e5-41fe-9e8f-544b85513484&prev=5f5201908b3fc5fc132dbd35"
1239
+ */
1240
+ type Href2 = string;
1241
+ type Metadata = {
1242
+ amountofcardinalfieldvalues?: number;
1243
+ amountoffields?: number;
1244
+ amountoffieldvalues?: number;
1245
+ amountofrows?: number;
1246
+ amountoftables?: number;
1247
+ hassectionaccess?: boolean;
1248
+ reloadmeta?: {
1249
+ cpuspent?: number;
1250
+ peakmemorybytes?: number;
1251
+ };
1252
+ staticbytesize?: number;
1253
+ };
1254
+ type NumberFormat = {
1255
+ qDec?: string;
1256
+ qFmt?: string;
1257
+ qThou?: string;
1258
+ qType?: string;
1259
+ qUseThou?: number;
1260
+ qnDec?: number;
1261
+ };
1262
+ type Objectmetrics = {
1263
+ cpuQuotients?: number[];
1264
+ cpuSeconds?: number[];
1265
+ responseTimeSeconds?: number;
1266
+ };
1267
+ type Objectspec = {
1268
+ id?: string;
1269
+ objectType?: string;
1270
+ sheetId?: string;
1271
+ title?: string;
1272
+ };
1273
+ type Objecttopspec = {
1274
+ byte_size?: number;
1275
+ is_system?: boolean;
1276
+ name?: string;
1277
+ };
1278
+ type Result = {
1279
+ documentSizeMiB?: number;
1280
+ hasSectionAccess?: boolean;
1281
+ objMemoryLimit?: ResultobjMemoryLimit[];
1282
+ objNoCache?: Resultobjresponsetime[];
1283
+ objSingleThreaded?: Resultsingle[];
1284
+ objSlowCached?: Resultobjresponsetime[];
1285
+ objSlowUncached?: Resultobjresponsetime[];
1286
+ objectCount?: number;
1287
+ rowCount?: number;
1288
+ sheetCount?: number;
1289
+ sheets?: Resultobjsheet[];
1290
+ topFieldsByBytes?: Resultmetadatatopfields[];
1291
+ topTablesByBytes?: Resultmetadatatoptables[];
1292
+ };
1293
+ type Resultentry = Objectspec & {
1294
+ passes?: Objectmetrics[];
1295
+ };
1296
+ type Resultmetadatatopfields = Objecttopspec & {
1297
+ byte_size?: number;
1298
+ name?: string;
1299
+ };
1300
+ type Resultmetadatatoptables = Objecttopspec & {
1301
+ byte_size?: number;
1302
+ name?: string;
1303
+ };
1304
+ type ResultobjMemoryLimit = Objectspec & {
1305
+ memoryLimitStatusCode?: string;
1306
+ };
1307
+ type Resultobjresponsetime = Objectspec & {
1308
+ responseTimeSeconds?: number;
1309
+ timeoutStatusCode?: string;
1310
+ };
1311
+ type Resultobjsheet = {
1312
+ objectCount?: number;
1313
+ sheet?: Resultobjresponsetime;
1314
+ sheetObjects?: Resultobjresponsetime[];
1315
+ };
1316
+ type Resultsingle = Objectspec & {
1317
+ cpuQuotient1?: number;
1318
+ };
1319
+ type Sortedcomparisonfields = {
1320
+ absoluteDiffAsc?: Comparisonfields;
1321
+ absoluteDiffDesc?: Comparisonfields;
1322
+ dataSourceStatus?: "full" | "none" | "baselinemissing" | "comparisonmissing";
1323
+ list?: Comparisonfields;
1324
+ relativeDiffAsc?: Comparisonfields;
1325
+ relativeDiffDesc?: Comparisonfields;
1326
+ };
1327
+ type Sortedcomparisonobjresponsetime = {
1328
+ absoluteDiffAsc?: Comparisonobjresponsetime;
1329
+ absoluteDiffDesc?: Comparisonobjresponsetime;
1330
+ dataSourceStatus?: "full" | "none" | "baselinemissing" | "comparisonmissing";
1331
+ list?: Comparisonobjresponsetime;
1332
+ relativeDiffAsc?: Comparisonobjresponsetime;
1333
+ relativeDiffDesc?: Comparisonobjresponsetime;
1334
+ };
1335
+ type Sortedcomparisonoobjheavy = {
1336
+ absoluteDiffAsc?: Comparisonoobjheavy;
1337
+ absoluteDiffDesc?: Comparisonoobjheavy;
1338
+ dataSourceStatus?: "full" | "none" | "baselinemissing" | "comparisonmissing";
1339
+ list?: Comparisonoobjheavy;
1340
+ relativeDiffAsc?: Comparisonoobjheavy;
1341
+ relativeDiffDesc?: Comparisonoobjheavy;
1342
+ };
1343
+ type Sortedcomparisontables = {
1344
+ absoluteDiffAsc?: Comparisontables;
1345
+ absoluteDiffDesc?: Comparisontables;
1346
+ dataSourceStatus?: "full" | "none" | "baselinemissing" | "comparisonmissing";
1347
+ list?: Comparisontables;
1348
+ relativeDiffAsc?: Comparisontables;
1349
+ relativeDiffDesc?: Comparisontables;
1350
+ };
1351
+ /**
1352
+ * Creates a new app.
1353
+ *
1354
+ * @param body an object with the body content
1355
+ * @throws CreateAppHttpError
1356
+ */
1357
+ declare function createApp(body: CreateApp, options?: ApiCallOptions): Promise<CreateAppHttpResponse>;
1358
+ type CreateAppHttpResponse = {
1359
+ data: NxApp;
1360
+ headers: Headers;
1361
+ status: 200;
1362
+ };
1363
+ type CreateAppHttpError = {
1364
+ data: unknown;
1365
+ headers: Headers;
1366
+ status: number;
1367
+ };
1368
+ /**
1369
+ * Accepts two evaluation ids and returns a comparison denoting the differences between the two.
1370
+ *
1371
+ * @param baseid Id of the baseline evaluation
1372
+ * @param comparisonid Id of the comparison evaluation
1373
+ * @param query an object with query parameters
1374
+ * @throws GetAppEvaluationComparisonHttpError
1375
+ */
1376
+ declare function getAppEvaluationComparison(baseid: string, comparisonid: string, query: {
1377
+ /** Get the full list of comparisons including non-significant diffs */
1378
+ all?: boolean;
1379
+ /** Specify output format, currently supported are 'json' and 'xml' */
1380
+ format?: string;
1381
+ }, options?: ApiCallOptions): Promise<GetAppEvaluationComparisonHttpResponse>;
1382
+ type GetAppEvaluationComparisonHttpResponse = {
1383
+ data: Comparison;
1384
+ headers: Headers;
1385
+ status: 200;
1386
+ };
1387
+ type GetAppEvaluationComparisonHttpError = {
1388
+ data: EvaluatorError;
1389
+ headers: Headers;
1390
+ status: 404 | 500;
1391
+ };
1392
+ /**
1393
+ * Accepts two evaluation ids and downloads a log, in XML format, denoting the differences between the two.
1394
+ * @example
1395
+ * getAppEvaluationComparisonXml(
1396
+ * "abcdefghijklmnopq",
1397
+ * "abcdefghijklmnopq"
1398
+ * )
1399
+ *
1400
+ * @param baseid Id of the baseline evaluation
1401
+ * @param comparisonid Id of the comparison evaluation
1402
+ * @throws GetAppEvaluationComparisonXmlHttpError
1403
+ */
1404
+ declare function getAppEvaluationComparisonXml(baseid: string, comparisonid: string, options?: ApiCallOptions): Promise<GetAppEvaluationComparisonXmlHttpResponse>;
1405
+ type GetAppEvaluationComparisonXmlHttpResponse = {
1406
+ data: Comparison;
1407
+ headers: Headers;
1408
+ status: 200;
1409
+ };
1410
+ type GetAppEvaluationComparisonXmlHttpError = {
1411
+ data: EvaluatorError;
1412
+ headers: Headers;
1413
+ status: 404 | 500;
1414
+ };
1415
+ /**
1416
+ * Find an evaluation by a specific id.
1417
+ *
1418
+ * @param id Id of the desired evaluation.
1419
+ * @param query an object with query parameters
1420
+ * @throws GetAppEvaluationHttpError
1421
+ */
1422
+ declare function getAppEvaluation(id: string, query: {
1423
+ /** Get the full data of the evaluation */
1424
+ all?: boolean;
1425
+ /** Specify output format, currently supported are 'json' and 'xml' */
1426
+ format?: string;
1427
+ }, options?: ApiCallOptions): Promise<GetAppEvaluationHttpResponse>;
1428
+ type GetAppEvaluationHttpResponse = {
1429
+ data: Evaluation;
1430
+ headers: Headers;
1431
+ status: 200;
1432
+ };
1433
+ type GetAppEvaluationHttpError = {
1434
+ data: EvaluatorError;
1435
+ headers: Headers;
1436
+ status: 404 | 500;
1437
+ };
1438
+ /**
1439
+ * Find and download an evaluation log by a specific evaluation id.
1440
+ * @example
1441
+ * getAppEvaluationXml(
1442
+ * "abcdefghijklmnopq"
1443
+ * )
1444
+ *
1445
+ * @param id Id of the desired evaluation.
1446
+ * @throws GetAppEvaluationXmlHttpError
1447
+ */
1448
+ declare function getAppEvaluationXml(id: string, options?: ApiCallOptions): Promise<GetAppEvaluationXmlHttpResponse>;
1449
+ type GetAppEvaluationXmlHttpResponse = {
1450
+ data: Evaluation;
1451
+ headers: Headers;
1452
+ status: 200;
1453
+ };
1454
+ type GetAppEvaluationXmlHttpError = {
1455
+ data: EvaluatorError;
1456
+ headers: Headers;
1457
+ status: 404 | 500;
1458
+ };
1459
+ /**
1460
+ * Imports an app into the system.
1461
+ *
1462
+ * @param query an object with query parameters
1463
+ * @param body an object with the body content
1464
+ * @throws ImportAppHttpError
1465
+ */
1466
+ declare function importApp(query: {
1467
+ /** If NoData is true, the data of the existing app will be kept as is, otherwise it will be replaced by the new incoming data. */
1468
+ NoData?: boolean;
1469
+ /** The app ID of the target app when source is qvw file. */
1470
+ appId?: string;
1471
+ /** The name of the target app when source does not have a specified name, applicable if source is qvw file. */
1472
+ fallbackName?: string;
1473
+ /** The file ID to be downloaded from Temporary Content Service (TCS) and used during import. */
1474
+ fileId?: string;
1475
+ /** The import mode. In `new` mode (default), the source app will be imported as a new app.<div class=note>The `autoreplace` mode is an internal mode only and is not permitted for external use.</div>
1476
+ *
1477
+ * One of:
1478
+ * * NEW
1479
+ * * AUTOREPLACE */
1480
+ mode?: string;
1481
+ /** The name of the target app. */
1482
+ name?: string;
1483
+ /** The space ID of the target app. */
1484
+ spaceId?: string;
1485
+ }, body: BodyInit, options?: ApiCallOptions): Promise<ImportAppHttpResponse>;
1486
+ type ImportAppHttpResponse = {
1487
+ data: NxApp;
1488
+ headers: Headers;
1489
+ status: 200;
1490
+ };
1491
+ type ImportAppHttpError = {
1492
+ data: void;
1493
+ headers: Headers;
1494
+ status: 404;
1495
+ };
1496
+ /**
1497
+ * Gets the app privileges for the current user, such as create app and import app. Empty means that the current user has no app privileges.
1498
+ *
1499
+ * @throws GetAppsPrivilegesHttpError
1500
+ */
1501
+ declare function getAppsPrivileges(options?: ApiCallOptions): Promise<GetAppsPrivilegesHttpResponse>;
1502
+ type GetAppsPrivilegesHttpResponse = {
1503
+ data: UserPrivileges[];
1504
+ headers: Headers;
1505
+ status: 200;
1506
+ };
1507
+ type GetAppsPrivilegesHttpError = {
1508
+ data: unknown;
1509
+ headers: Headers;
1510
+ status: number;
1511
+ };
1512
+ /**
1513
+ * Validates the script.
1514
+ *
1515
+ * @param body an object with the body content
1516
+ * @throws ValidateScriptHttpError
1517
+ */
1518
+ declare function validateScript(body: Script, options?: ApiCallOptions): Promise<ValidateScriptHttpResponse>;
1519
+ type ValidateScriptHttpResponse = {
1520
+ data: ScriptIssues;
1521
+ headers: Headers;
1522
+ status: 200;
1523
+ };
1524
+ type ValidateScriptHttpError = {
1525
+ data: void;
1526
+ headers: Headers;
1527
+ status: 403;
1528
+ };
1529
+ /**
1530
+ * Deletes a specific app.
1531
+ *
1532
+ * @param appId Identifier of the app.
1533
+ * @throws DeleteAppHttpError
1534
+ */
1535
+ declare function deleteApp(appId: string, options?: ApiCallOptions): Promise<DeleteAppHttpResponse>;
1536
+ type DeleteAppHttpResponse = {
1537
+ data: void;
1538
+ headers: Headers;
1539
+ status: 200;
1540
+ };
1541
+ type DeleteAppHttpError = {
1542
+ data: unknown;
1543
+ headers: Headers;
1544
+ status: number;
1545
+ };
1546
+ /**
1547
+ * Retrieves information for a specific app.
1548
+ *
1549
+ * @param appId Identifier of the app.
1550
+ * @throws GetAppInfoHttpError
1551
+ */
1552
+ declare function getAppInfo(appId: string, options?: ApiCallOptions): Promise<GetAppInfoHttpResponse>;
1553
+ type GetAppInfoHttpResponse = {
1554
+ data: NxApp;
1555
+ headers: Headers;
1556
+ status: 200;
1557
+ };
1558
+ type GetAppInfoHttpError = {
1559
+ data: unknown;
1560
+ headers: Headers;
1561
+ status: number;
1562
+ };
1563
+ /**
1564
+ * Updates the information for a specific app.
1565
+ *
1566
+ * @param appId Identifier of the app.
1567
+ * @param body an object with the body content
1568
+ * @throws UpdateAppInfoHttpError
1569
+ */
1570
+ declare function updateAppInfo(appId: string, body: UpdateApp, options?: ApiCallOptions): Promise<UpdateAppInfoHttpResponse>;
1571
+ type UpdateAppInfoHttpResponse = {
1572
+ data: NxApp;
1573
+ headers: Headers;
1574
+ status: 200;
1575
+ };
1576
+ type UpdateAppInfoHttpError = {
1577
+ data: unknown;
1578
+ headers: Headers;
1579
+ status: number;
1580
+ };
1581
+ /**
1582
+ * Copies a specific app.
1583
+ *
1584
+ * @param appId Identifier of the app.
1585
+ * @param body an object with the body content
1586
+ * @throws CopyAppHttpError
1587
+ */
1588
+ declare function copyApp(appId: string, body: CreateApp, options?: ApiCallOptions): Promise<CopyAppHttpResponse>;
1589
+ type CopyAppHttpResponse = {
1590
+ data: NxApp;
1591
+ headers: Headers;
1592
+ status: 200;
1593
+ };
1594
+ type CopyAppHttpError = {
1595
+ data: unknown;
1596
+ headers: Headers;
1597
+ status: number;
1598
+ };
1599
+ /**
1600
+ * Retrieves the lineage for an app.
1601
+ * Returns a JSON-formatted array of strings describing the lineage of the app.
1602
+ *
1603
+ * @param appId Identifier of the app.
1604
+ * @throws GetAppDataLineageHttpError
1605
+ */
1606
+ declare function getAppDataLineage(appId: string, options?: ApiCallOptions): Promise<GetAppDataLineageHttpResponse>;
1607
+ type GetAppDataLineageHttpResponse = {
1608
+ data: LineageInfoRest[];
1609
+ headers: Headers;
1610
+ status: 200;
1611
+ };
1612
+ type GetAppDataLineageHttpError = {
1613
+ data: unknown;
1614
+ headers: Headers;
1615
+ status: number;
1616
+ };
1617
+ /**
1618
+ * Retrieves the data model and reload statistics metadata of an app.
1619
+ * An empty metadata structure is returned if the metadata is not available in the app.
1620
+ *
1621
+ * @param appId Identifier of the app.
1622
+ * @throws GetAppDataMetadataHttpError
1623
+ */
1624
+ declare function getAppDataMetadata(appId: string, options?: ApiCallOptions): Promise<GetAppDataMetadataHttpResponse>;
1625
+ type GetAppDataMetadataHttpResponse = {
1626
+ data: DataModelMetadata;
1627
+ headers: Headers;
1628
+ status: 200;
1629
+ };
1630
+ type GetAppDataMetadataHttpError = {
1631
+ data: unknown;
1632
+ headers: Headers;
1633
+ status: number;
1634
+ };
1635
+ /**
1636
+ * Exports a specific app.
1637
+ *
1638
+ * @param appId Identifier of the app.
1639
+ * @param query an object with query parameters
1640
+ * @throws ExportAppHttpError
1641
+ */
1642
+ declare function exportApp(appId: string, query: {
1643
+ /** The flag indicating if only object contents should be exported. */
1644
+ NoData?: boolean;
1645
+ }, options?: ApiCallOptions): Promise<ExportAppHttpResponse>;
1646
+ type ExportAppHttpResponse = {
1647
+ data: DownloadableBlob;
1648
+ headers: Headers;
1649
+ status: 200;
1650
+ };
1651
+ type ExportAppHttpError = {
1652
+ data: void;
1653
+ headers: Headers;
1654
+ status: 400 | 403 | 404;
1655
+ };
1656
+ /**
1657
+ * Returns information about supported analyses for the app's data model. Lists available analysis types, along with minimum and maximum number of dimensions, measures, and fields.
1658
+ *
1659
+ * @param appId Qlik Sense app identifier
1660
+ * @throws GetAppInsightAnalysesHttpError
1661
+ */
1662
+ declare function getAppInsightAnalyses(appId: string, options?: ApiCallOptions): Promise<GetAppInsightAnalysesHttpResponse>;
1663
+ type GetAppInsightAnalysesHttpResponse = {
1664
+ data: AnalysisDescriptorResponse;
1665
+ headers: Headers;
1666
+ status: 200;
1667
+ prev?: (options?: ApiCallOptions) => Promise<GetAppInsightAnalysesHttpResponse>;
1668
+ next?: (options?: ApiCallOptions) => Promise<GetAppInsightAnalysesHttpResponse>;
1669
+ };
1670
+ type GetAppInsightAnalysesHttpError = {
1671
+ data: Errors;
1672
+ headers: Headers;
1673
+ status: 400 | 401 | 404 | 422 | 500;
1674
+ };
1675
+ /**
1676
+ * Returns analysis recommendations in response to a natural language question, a set of fields and master items, or a set of fields and master items with an optional target analysis.
1677
+ *
1678
+ * @param appId Qlik Sense app identifier
1679
+ * @param body an object with the body content
1680
+ * @throws GetAppInsightAnalysisRecommendationsHttpError
1681
+ */
1682
+ declare function getAppInsightAnalysisRecommendations(appId: string, body: AnalysisRecommendRequest, options?: ApiCallOptions): Promise<GetAppInsightAnalysisRecommendationsHttpResponse>;
1683
+ type GetAppInsightAnalysisRecommendationsHttpResponse = {
1684
+ data: AnalysisRecommendationResponse;
1685
+ headers: Headers;
1686
+ status: 200;
1687
+ };
1688
+ type GetAppInsightAnalysisRecommendationsHttpError = {
1689
+ data: Errors;
1690
+ headers: Headers;
1691
+ status: 400 | 401 | 404 | 409 | 422 | 500;
1692
+ };
1693
+ /**
1694
+ * Returns information about model used to make analysis recommendations. Lists all fields and master items in the logical model, along with an indication of the validity of the logical model if the default is not used.
1695
+ *
1696
+ * @param appId Qlik Sense app identifier
1697
+ * @throws GetAppInsightAnalysisModelHttpError
1698
+ */
1699
+ declare function getAppInsightAnalysisModel(appId: string, options?: ApiCallOptions): Promise<GetAppInsightAnalysisModelHttpResponse>;
1700
+ type GetAppInsightAnalysisModelHttpResponse = {
1701
+ data: AnalysisModelResponse;
1702
+ headers: Headers;
1703
+ status: 200;
1704
+ prev?: (options?: ApiCallOptions) => Promise<GetAppInsightAnalysisModelHttpResponse>;
1705
+ next?: (options?: ApiCallOptions) => Promise<GetAppInsightAnalysisModelHttpResponse>;
1706
+ };
1707
+ type GetAppInsightAnalysisModelHttpError = {
1708
+ data: Errors;
1709
+ headers: Headers;
1710
+ status: 400 | 401 | 404 | 409 | 422 | 500;
1711
+ };
1712
+ /**
1713
+ * Deletes a media content file or complete directory.
1714
+ * Returns OK if the bytes containing the media file (or the complete content of a directory) were successfully deleted, or error in case of failure or lack of permission.
1715
+ *
1716
+ * @param appId Unique application identifier.
1717
+ * @param path Path to file content.
1718
+ * @throws DeleteAppMediaHttpError
1719
+ */
1720
+ declare function deleteAppMedia(appId: string, path: string, options?: ApiCallOptions): Promise<DeleteAppMediaHttpResponse>;
1721
+ type DeleteAppMediaHttpResponse = {
1722
+ data: void;
1723
+ headers: Headers;
1724
+ status: 200;
1725
+ };
1726
+ type DeleteAppMediaHttpError = {
1727
+ data: void;
1728
+ headers: Headers;
1729
+ status: 403 | 404;
1730
+ };
1731
+ /**
1732
+ * Gets media content from file.
1733
+ * Returns a stream of bytes containing the media file content on success, or error if file is not found.
1734
+ *
1735
+ * @param appId Unique application identifier.
1736
+ * @param path Path to file content.
1737
+ * @throws GetAppMediaHttpError
1738
+ */
1739
+ declare function getAppMedia(appId: string, path: string, options?: ApiCallOptions): Promise<GetAppMediaHttpResponse>;
1740
+ type GetAppMediaHttpResponse = {
1741
+ data: DownloadableBlob;
1742
+ headers: Headers;
1743
+ status: 200;
1744
+ };
1745
+ type GetAppMediaHttpError = {
1746
+ data: void;
1747
+ headers: Headers;
1748
+ status: 403 | 404;
1749
+ };
1750
+ /**
1751
+ * Stores the media content file.
1752
+ * Returns OK if the bytes containing the media file content were successfully stored, or error in case of failure, lack of permission or file already exists on the supplied path.
1753
+ *
1754
+ * @param appId Unique application identifier.
1755
+ * @param path Path to file content.
1756
+ * @param body an object with the body content
1757
+ * @throws UploadAppMediaHttpError
1758
+ */
1759
+ declare function uploadAppMedia(appId: string, path: string, body: BodyInit, options?: ApiCallOptions): Promise<UploadAppMediaHttpResponse>;
1760
+ type UploadAppMediaHttpResponse = {
1761
+ data: void;
1762
+ headers: Headers;
1763
+ status: 200;
1764
+ };
1765
+ type UploadAppMediaHttpError = {
1766
+ data: void;
1767
+ headers: Headers;
1768
+ status: 403 | 404;
1769
+ };
1770
+ /**
1771
+ * Lists media content.
1772
+ * Returns a JSON formatted array of strings describing the available media content or error if the optional path supplied is not found.
1773
+ *
1774
+ * @param appId Unique application identifier.
1775
+ * @param path The path to sub folder with static content relative to the root folder. Use empty path to access the root folder.
1776
+ * @param query an object with query parameters
1777
+ * @throws GetAppMediaListHttpError
1778
+ */
1779
+ declare function getAppMediaList(appId: string, path: string, query: {
1780
+ /** Optional. List output can include files and folders in different ways:
1781
+ * * Not recursive, default if show option is not supplied or incorrectly specified, results in output with files and empty directories for the path specified only.
1782
+ * * Recursive(r), use ?show=r or ?show=recursive, results in a recursive output with files, all empty folders are excluded.
1783
+ * * All(a), use ?show=a or ?show=all, results in a recursive output with files and empty directories. */
1784
+ show?: string;
1785
+ }, options?: ApiCallOptions): Promise<GetAppMediaListHttpResponse>;
1786
+ type GetAppMediaListHttpResponse = {
1787
+ data: AppContentList;
1788
+ headers: Headers;
1789
+ status: 200;
1790
+ };
1791
+ type GetAppMediaListHttpError = {
1792
+ data: void;
1793
+ headers: Headers;
1794
+ status: 403 | 404;
1795
+ };
1796
+ /**
1797
+ * Gets media content from file currently used as application thumbnail.
1798
+ * Returns a stream of bytes containing the media file content on success, or error if file is not found.
1799
+ * The image selected as thumbnail is only updated when application is saved.
1800
+ *
1801
+ * @param appId Unique application identifier.
1802
+ * @throws GetAppThumbnailHttpError
1803
+ */
1804
+ declare function getAppThumbnail(appId: string, options?: ApiCallOptions): Promise<GetAppThumbnailHttpResponse>;
1805
+ type GetAppThumbnailHttpResponse = {
1806
+ data: DownloadableBlob;
1807
+ headers: Headers;
1808
+ status: 200;
1809
+ };
1810
+ type GetAppThumbnailHttpError = {
1811
+ data: void;
1812
+ headers: Headers;
1813
+ status: 403 | 404;
1814
+ };
1815
+ /**
1816
+ * Sets owner on an app object.
1817
+ * The user must be the owner of the object.
1818
+ *
1819
+ * @param appId Identifier of the app.
1820
+ * @param objectId Identifier of the object.
1821
+ * @param body an object with the body content
1822
+ * @throws UpdateAppObjectOwnerHttpError
1823
+ */
1824
+ declare function updateAppObjectOwner(appId: string, objectId: string, body: UpdateOwner, options?: ApiCallOptions): Promise<UpdateAppObjectOwnerHttpResponse>;
1825
+ type UpdateAppObjectOwnerHttpResponse = {
1826
+ data: NxAppObject;
1827
+ headers: Headers;
1828
+ status: 200;
1829
+ };
1830
+ type UpdateAppObjectOwnerHttpError = {
1831
+ data: void;
1832
+ headers: Headers;
1833
+ status: 400 | 404;
1834
+ };
1835
+ /**
1836
+ * Changes owner of the app.
1837
+ *
1838
+ * @param appId Identifier of the app.
1839
+ * @param body an object with the body content
1840
+ * @throws UpdateAppOwnerHttpError
1841
+ */
1842
+ declare function updateAppOwner(appId: string, body: UpdateOwner, options?: ApiCallOptions): Promise<UpdateAppOwnerHttpResponse>;
1843
+ type UpdateAppOwnerHttpResponse = {
1844
+ data: NxApp;
1845
+ headers: Headers;
1846
+ status: 200;
1847
+ };
1848
+ type UpdateAppOwnerHttpError = {
1849
+ data: void;
1850
+ headers: Headers;
1851
+ status: 403 | 404;
1852
+ };
1853
+ /**
1854
+ * Publishes a specific app to a managed space.
1855
+ *
1856
+ * @param appId Identifier of the app.
1857
+ * @param body an object with the body content
1858
+ * @throws PublishAppHttpError
1859
+ */
1860
+ declare function publishApp(appId: string, body: PublishApp, options?: ApiCallOptions): Promise<PublishAppHttpResponse>;
1861
+ type PublishAppHttpResponse = {
1862
+ data: NxApp;
1863
+ headers: Headers;
1864
+ status: 200;
1865
+ };
1866
+ type PublishAppHttpError = {
1867
+ data: unknown;
1868
+ headers: Headers;
1869
+ status: number;
1870
+ };
1871
+ /**
1872
+ * Republishes a published app to a managed space.
1873
+ *
1874
+ * @param appId Identifier of the app.
1875
+ * @param body an object with the body content
1876
+ * @throws RepublishAppHttpError
1877
+ */
1878
+ declare function republishApp(appId: string, body: RepublishApp, options?: ApiCallOptions): Promise<RepublishAppHttpResponse>;
1879
+ type RepublishAppHttpResponse = {
1880
+ data: NxApp;
1881
+ headers: Headers;
1882
+ status: 200;
1883
+ };
1884
+ type RepublishAppHttpError = {
1885
+ data: unknown;
1886
+ headers: Headers;
1887
+ status: number;
1888
+ };
1889
+ /**
1890
+ * Retrieves the metadata about all script logs stored for an app.
1891
+ * Returns an array of ScriptLogMeta objects.
1892
+ *
1893
+ * @param appId Identifier of the app.
1894
+ * @throws GetAppReloadLogsHttpError
1895
+ */
1896
+ declare function getAppReloadLogs(appId: string, options?: ApiCallOptions): Promise<GetAppReloadLogsHttpResponse>;
1897
+ type GetAppReloadLogsHttpResponse = {
1898
+ data: ScriptLogList;
1899
+ headers: Headers;
1900
+ status: 200;
1901
+ };
1902
+ type GetAppReloadLogsHttpError = {
1903
+ data: unknown;
1904
+ headers: Headers;
1905
+ status: number;
1906
+ };
1907
+ /**
1908
+ * Retrieves the log of a specific reload.
1909
+ * Returns the log as "text/plain; charset=UTF-8".
1910
+ *
1911
+ * @param appId Identifier of the app.
1912
+ * @param reloadId Identifier of the reload.
1913
+ * @throws GetAppReloadLogHttpError
1914
+ */
1915
+ declare function getAppReloadLog(appId: string, reloadId: string, options?: ApiCallOptions): Promise<GetAppReloadLogHttpResponse>;
1916
+ type GetAppReloadLogHttpResponse = {
1917
+ data: DownloadableBlob;
1918
+ headers: Headers;
1919
+ status: 200;
1920
+ };
1921
+ type GetAppReloadLogHttpError = {
1922
+ data: unknown;
1923
+ headers: Headers;
1924
+ status: number;
1925
+ };
1926
+ /**
1927
+ * Retrieves the app reload metadata list.
1928
+ * Reload metadata contains reload information, including reload id, duration, endtime and lineage load info.
1929
+ *
1930
+ * @param appId Identifier of the app
1931
+ * @param reloadId Identifier of the reload. Use empty reloadId to get all reloads.
1932
+ * @param query an object with query parameters
1933
+ * @throws GetAppReloadMetadataHttpError
1934
+ */
1935
+ declare function getAppReloadMetadata(appId: string, reloadId: string, query: {
1936
+ /** Include metadata for reloads ran with SkipStore flag set to true. Default: false */
1937
+ includeSkipStoreReloads?: boolean;
1938
+ /** Maximum number of records to return from this request. Default: 100 */
1939
+ limit?: string;
1940
+ }, options?: ApiCallOptions): Promise<GetAppReloadMetadataHttpResponse>;
1941
+ type GetAppReloadMetadataHttpResponse = {
1942
+ data: ReloadListMetadata;
1943
+ headers: Headers;
1944
+ status: 200;
1945
+ };
1946
+ type GetAppReloadMetadataHttpError = {
1947
+ data: unknown;
1948
+ headers: Headers;
1949
+ status: number;
1950
+ };
1951
+ /**
1952
+ * List all filters that are present in the given app. Filters allow to reduce the app data visible in a report output. Each filter can contain definitions on one or multiple fields.
1953
+ *
1954
+ * @param appId Qlik Sense app identifier
1955
+ * @param query an object with query parameters
1956
+ * @throws GetAppReportFiltersHttpError
1957
+ */
1958
+ declare function getAppReportFilters(appId: string, query: {
1959
+ /** The advanced filtering to use for the query. Refer to [RFC 7644](https://datatracker.ietf.org/doc/rfc7644/) for the syntax. Cannot be combined with any of the fields marked as deprecated. All conditional statements within this query parameter are case insensitive.
1960
+ * The following fields support the `co` (contains) operator: `name`, `description`
1961
+ * The following fields support the `eq` (equals) operator: `ownerId`
1962
+ * Example:
1963
+ * (name co "query1" or description co "query2") and ownerId eq "123" */
1964
+ filter?: string;
1965
+ /** The filter type (REP, SUB). REP stands for report bookmark, SUB for subscription bookmark. */
1966
+ filterTypes: ("REP" | "SUB")[];
1967
+ /** Limit the returned result set */
1968
+ limit?: number;
1969
+ /** If present, the cursor that starts the page of data that is returned. */
1970
+ page?: string;
1971
+ /** Sorting parameters. */
1972
+ sort?: ("+ownerId" | "-ownerId" | "-name" | "+name" | "+description" | "-description" | "+createdAt" | "-createdAt" | "+updatedAt" | "-updatedAt")[];
1973
+ }, options?: ApiCallOptions): Promise<GetAppReportFiltersHttpResponse>;
1974
+ type GetAppReportFiltersHttpResponse = {
1975
+ data: FilterList;
1976
+ headers: Headers;
1977
+ status: 200;
1978
+ prev?: (options?: ApiCallOptions) => Promise<GetAppReportFiltersHttpResponse>;
1979
+ next?: (options?: ApiCallOptions) => Promise<GetAppReportFiltersHttpResponse>;
1980
+ };
1981
+ type GetAppReportFiltersHttpError = {
1982
+ data: FilterErrors;
1983
+ headers: Headers;
1984
+ status: 400 | 401 | 403 | 404 | 429 | 500;
1985
+ };
1986
+ /**
1987
+ * Creates a new report filter which is used to re-apply selections, variables, patches to an engine session.
1988
+ *
1989
+ * @param appId Qlik Sense app identifier
1990
+ * @param body an object with the body content
1991
+ * @throws CreateAppReportFilterHttpError
1992
+ */
1993
+ declare function createAppReportFilter(appId: string, body: FilterRequest, options?: ApiCallOptions): Promise<CreateAppReportFilterHttpResponse>;
1994
+ type CreateAppReportFilterHttpResponse = {
1995
+ data: Filter;
1996
+ headers: Headers;
1997
+ status: 201;
1998
+ };
1999
+ type CreateAppReportFilterHttpError = {
2000
+ data: FilterErrors;
2001
+ headers: Headers;
2002
+ status: 400 | 401 | 403 | 404 | 409 | 429 | 500;
2003
+ };
2004
+ /**
2005
+ * Get the number of filters for the given app and filter types
2006
+ *
2007
+ * @param appId Qlik Sense app identifier
2008
+ * @param query an object with query parameters
2009
+ * @throws CountAppReportFiltersHttpError
2010
+ */
2011
+ declare function countAppReportFilters(appId: string, query: {
2012
+ /** The filter type (REP, SUB). REP stands for report bookmark, SUB for subscription bookmark. */
2013
+ filterTypes: ("REP" | "SUB")[];
2014
+ }, options?: ApiCallOptions): Promise<CountAppReportFiltersHttpResponse>;
2015
+ type CountAppReportFiltersHttpResponse = {
2016
+ data: FiltersCount;
2017
+ headers: Headers;
2018
+ status: 200;
2019
+ };
2020
+ type CountAppReportFiltersHttpError = {
2021
+ data: FilterErrors;
2022
+ headers: Headers;
2023
+ status: 400 | 401 | 403 | 404 | 429 | 500;
2024
+ };
2025
+ /**
2026
+ * Delete a filter
2027
+ *
2028
+ * @param appId Qlik Sense app identifier
2029
+ * @param id The filter id identifier (bookmarkId).
2030
+ * @throws DeleteAppReportFilterHttpError
2031
+ */
2032
+ declare function deleteAppReportFilter(appId: string, id: string, options?: ApiCallOptions): Promise<DeleteAppReportFilterHttpResponse>;
2033
+ type DeleteAppReportFilterHttpResponse = {
2034
+ data: void;
2035
+ headers: Headers;
2036
+ status: 204;
2037
+ };
2038
+ type DeleteAppReportFilterHttpError = {
2039
+ data: FilterErrors;
2040
+ headers: Headers;
2041
+ status: 400 | 401 | 403 | 404 | 429 | 500;
2042
+ };
2043
+ /**
2044
+ * Get a filter
2045
+ *
2046
+ * @param appId Qlik Sense app identifier
2047
+ * @param id The filter id identifier (bookmarkId).
2048
+ * @throws GetAppReportFilterHttpError
2049
+ */
2050
+ declare function getAppReportFilter(appId: string, id: string, options?: ApiCallOptions): Promise<GetAppReportFilterHttpResponse>;
2051
+ type GetAppReportFilterHttpResponse = {
2052
+ data: Filter;
2053
+ headers: Headers;
2054
+ status: 200;
2055
+ };
2056
+ type GetAppReportFilterHttpError = {
2057
+ data: FilterErrors;
2058
+ headers: Headers;
2059
+ status: 400 | 401 | 403 | 404 | 429 | 500;
2060
+ };
2061
+ /**
2062
+ * Update a filter
2063
+ *
2064
+ * @param appId Qlik Sense app identifier
2065
+ * @param id The filter id identifier (bookmarkId).
2066
+ * @param body an object with the body content
2067
+ * @throws PatchAppReportFilterHttpError
2068
+ */
2069
+ declare function patchAppReportFilter(appId: string, id: string, body: PatchFilter, options?: ApiCallOptions): Promise<PatchAppReportFilterHttpResponse>;
2070
+ type PatchAppReportFilterHttpResponse = {
2071
+ data: void;
2072
+ headers: Headers;
2073
+ status: 204;
2074
+ };
2075
+ type PatchAppReportFilterHttpError = {
2076
+ data: FilterErrors;
2077
+ headers: Headers;
2078
+ status: 400 | 401 | 403 | 404 | 409 | 429 | 500;
2079
+ };
2080
+ /**
2081
+ * Retrieves the script history for an app.
2082
+ * Returns information about the saved versions of the script in a list sorted with latest first.
2083
+ *
2084
+ * @param appId Identifier of the app.
2085
+ * @param query an object with query parameters
2086
+ * @throws GetAppScriptHistoryHttpError
2087
+ */
2088
+ declare function getAppScriptHistory(appId: string, query: {
2089
+ /** A scim filter expression defining which script versions should be retrieved. Filterable fields are:
2090
+ * * ScriptId
2091
+ * * ModifiedTime
2092
+ * * ModifierId */
2093
+ filter?: string;
2094
+ /** Maximum number of records to return from this request. */
2095
+ limit?: string;
2096
+ /** Opaque definition of which page of the result set to return. Returned from a previous call using the same filter. Not yet supported. */
2097
+ page?: string;
2098
+ }, options?: ApiCallOptions): Promise<GetAppScriptHistoryHttpResponse>;
2099
+ type GetAppScriptHistoryHttpResponse = {
2100
+ data: ScriptMetaList;
2101
+ headers: Headers;
2102
+ status: 200;
2103
+ prev?: (options?: ApiCallOptions) => Promise<GetAppScriptHistoryHttpResponse>;
2104
+ next?: (options?: ApiCallOptions) => Promise<GetAppScriptHistoryHttpResponse>;
2105
+ };
2106
+ type GetAppScriptHistoryHttpError = {
2107
+ data: unknown;
2108
+ headers: Headers;
2109
+ status: number;
2110
+ };
2111
+ /**
2112
+ * Sets script for an app.
2113
+ *
2114
+ * @param appId Identifier of the app.
2115
+ * @param body an object with the body content
2116
+ * @throws UpdateAppScriptHttpError
2117
+ */
2118
+ declare function updateAppScript(appId: string, body: ScriptVersion, options?: ApiCallOptions): Promise<UpdateAppScriptHttpResponse>;
2119
+ type UpdateAppScriptHttpResponse = {
2120
+ data: void;
2121
+ headers: Headers;
2122
+ status: 200;
2123
+ };
2124
+ type UpdateAppScriptHttpError = {
2125
+ data: unknown;
2126
+ headers: Headers;
2127
+ status: number;
2128
+ };
2129
+ /**
2130
+ * Deletes a specific version of the script for an app.
2131
+ * Fails if the supplied id is the current version.
2132
+ *
2133
+ * @param appId Identifier of the app.
2134
+ * @param id Identifier of the script version
2135
+ * @throws DeleteAppScriptHttpError
2136
+ */
2137
+ declare function deleteAppScript(appId: string, id: string, options?: ApiCallOptions): Promise<DeleteAppScriptHttpResponse>;
2138
+ type DeleteAppScriptHttpResponse = {
2139
+ data: void;
2140
+ headers: Headers;
2141
+ status: 200;
2142
+ };
2143
+ type DeleteAppScriptHttpError = {
2144
+ data: unknown;
2145
+ headers: Headers;
2146
+ status: number;
2147
+ };
2148
+ /**
2149
+ * Retrieves a version of the script for an app.
2150
+ * Returns the script text.
2151
+ *
2152
+ * @param appId Identifier of the app.
2153
+ * @param id Identifier of the script version, or 'current' for retrieving the current version.
2154
+ * @throws GetAppScriptHttpError
2155
+ */
2156
+ declare function getAppScript(appId: string, id: string, options?: ApiCallOptions): Promise<GetAppScriptHttpResponse>;
2157
+ type GetAppScriptHttpResponse = {
2158
+ data: ScriptVersion;
2159
+ headers: Headers;
2160
+ status: 200;
2161
+ };
2162
+ type GetAppScriptHttpError = {
2163
+ data: unknown;
2164
+ headers: Headers;
2165
+ status: number;
2166
+ };
2167
+ /**
2168
+ * Updates a specific version of the script for an app.
2169
+ *
2170
+ * @param appId Identifier of the app.
2171
+ * @param id Identifier of the script version.
2172
+ * @param body an object with the body content
2173
+ * @throws PatchAppScriptHttpError
2174
+ */
2175
+ declare function patchAppScript(appId: string, id: string, body: NxPatch[], options?: ApiCallOptions): Promise<PatchAppScriptHttpResponse>;
2176
+ type PatchAppScriptHttpResponse = {
2177
+ data: void;
2178
+ headers: Headers;
2179
+ status: 200;
2180
+ };
2181
+ type PatchAppScriptHttpError = {
2182
+ data: unknown;
2183
+ headers: Headers;
2184
+ status: number;
2185
+ };
2186
+ /**
2187
+ * Removes space from a specific app.
2188
+ *
2189
+ * @param appId Identifier of the app.
2190
+ * @throws RemoveAppFromSpaceHttpError
2191
+ */
2192
+ declare function removeAppFromSpace(appId: string, options?: ApiCallOptions): Promise<RemoveAppFromSpaceHttpResponse>;
2193
+ type RemoveAppFromSpaceHttpResponse = {
2194
+ data: NxApp;
2195
+ headers: Headers;
2196
+ status: 200;
2197
+ };
2198
+ type RemoveAppFromSpaceHttpError = {
2199
+ data: unknown;
2200
+ headers: Headers;
2201
+ status: number;
2202
+ };
2203
+ /**
2204
+ * Sets space on a specific app.
2205
+ *
2206
+ * @param appId Identifier of the app.
2207
+ * @param body an object with the body content
2208
+ * @throws MoveAppToSpaceHttpError
2209
+ */
2210
+ declare function moveAppToSpace(appId: string, body: UpdateSpace, options?: ApiCallOptions): Promise<MoveAppToSpaceHttpResponse>;
2211
+ type MoveAppToSpaceHttpResponse = {
2212
+ data: NxApp;
2213
+ headers: Headers;
2214
+ status: 200;
2215
+ };
2216
+ type MoveAppToSpaceHttpError = {
2217
+ data: unknown;
2218
+ headers: Headers;
2219
+ status: number;
2220
+ };
2221
+ /**
2222
+ * Find all evaluations for an app GUID.
2223
+ * Supports paging via next, prev which are sent in the response body
2224
+ *
2225
+ * @param guid The app guid.
2226
+ * @param query an object with query parameters
2227
+ * @throws GetAppEvaluationsHttpError
2228
+ */
2229
+ declare function getAppEvaluations(guid: string, query: {
2230
+ /** Get the full data of the evaluation */
2231
+ all?: boolean;
2232
+ /** Add file transfer headers to response */
2233
+ fileMode?: boolean;
2234
+ /** Specify output format, currently supported are 'json' and 'xml' */
2235
+ format?: string;
2236
+ /** Number of results to return per page. */
2237
+ limit?: number;
2238
+ /** The app evaluation id to get next page from */
2239
+ next?: string;
2240
+ /** The app evaluation id to get previous page from */
2241
+ prev?: string;
2242
+ /** Property to sort list on */
2243
+ sort?: string;
2244
+ }, options?: ApiCallOptions): Promise<GetAppEvaluationsHttpResponse>;
2245
+ type GetAppEvaluationsHttpResponse = {
2246
+ data: Evaluations;
2247
+ headers: Headers;
2248
+ status: 200;
2249
+ prev?: (options?: ApiCallOptions) => Promise<GetAppEvaluationsHttpResponse>;
2250
+ next?: (options?: ApiCallOptions) => Promise<GetAppEvaluationsHttpResponse>;
2251
+ };
2252
+ type GetAppEvaluationsHttpError = {
2253
+ data: EvaluatorError;
2254
+ headers: Headers;
2255
+ status: 400 | 404 | 500;
2256
+ };
2257
+ /**
2258
+ * Queue an app evaluation by its app guid.
2259
+ * @example
2260
+ * queueAppEvaluation(
2261
+ * "abcdefghijklmnopq"
2262
+ * )
2263
+ *
2264
+ * @param guid Guid of the app.
2265
+ * @throws QueueAppEvaluationHttpError
2266
+ */
2267
+ declare function queueAppEvaluation(guid: string, options?: ApiCallOptions): Promise<QueueAppEvaluationHttpResponse>;
2268
+ type QueueAppEvaluationHttpResponse = {
2269
+ data: Evaluation;
2270
+ headers: Headers;
2271
+ status: 201;
2272
+ };
2273
+ type QueueAppEvaluationHttpError = {
2274
+ data: EvaluatorError;
2275
+ headers: Headers;
2276
+ status: 400 | 403 | 404 | 500;
2277
+ };
2278
+ /**
2279
+ * Clears the cache for apps api requests.
2280
+ */
2281
+ declare function clearCache(): void;
2282
+ type AppsAPI = {
2283
+ /**
2284
+ * Creates a new app.
2285
+ *
2286
+ * @param body an object with the body content
2287
+ * @throws CreateAppHttpError
2288
+ */
2289
+ createApp: typeof createApp;
2290
+ /**
2291
+ * Accepts two evaluation ids and returns a comparison denoting the differences between the two.
2292
+ *
2293
+ * @param baseid Id of the baseline evaluation
2294
+ * @param comparisonid Id of the comparison evaluation
2295
+ * @param query an object with query parameters
2296
+ * @throws GetAppEvaluationComparisonHttpError
2297
+ */
2298
+ getAppEvaluationComparison: typeof getAppEvaluationComparison;
2299
+ /**
2300
+ * Accepts two evaluation ids and downloads a log, in XML format, denoting the differences between the two.
2301
+ * @example
2302
+ * getAppEvaluationComparisonXml(
2303
+ * "abcdefghijklmnopq",
2304
+ * "abcdefghijklmnopq"
2305
+ * )
2306
+ *
2307
+ * @param baseid Id of the baseline evaluation
2308
+ * @param comparisonid Id of the comparison evaluation
2309
+ * @throws GetAppEvaluationComparisonXmlHttpError
2310
+ */
2311
+ getAppEvaluationComparisonXml: typeof getAppEvaluationComparisonXml;
2312
+ /**
2313
+ * Find an evaluation by a specific id.
2314
+ *
2315
+ * @param id Id of the desired evaluation.
2316
+ * @param query an object with query parameters
2317
+ * @throws GetAppEvaluationHttpError
2318
+ */
2319
+ getAppEvaluation: typeof getAppEvaluation;
2320
+ /**
2321
+ * Find and download an evaluation log by a specific evaluation id.
2322
+ * @example
2323
+ * getAppEvaluationXml(
2324
+ * "abcdefghijklmnopq"
2325
+ * )
2326
+ *
2327
+ * @param id Id of the desired evaluation.
2328
+ * @throws GetAppEvaluationXmlHttpError
2329
+ */
2330
+ getAppEvaluationXml: typeof getAppEvaluationXml;
2331
+ /**
2332
+ * Imports an app into the system.
2333
+ *
2334
+ * @param query an object with query parameters
2335
+ * @param body an object with the body content
2336
+ * @throws ImportAppHttpError
2337
+ */
2338
+ importApp: typeof importApp;
2339
+ /**
2340
+ * Gets the app privileges for the current user, such as create app and import app. Empty means that the current user has no app privileges.
2341
+ *
2342
+ * @throws GetAppsPrivilegesHttpError
2343
+ */
2344
+ getAppsPrivileges: typeof getAppsPrivileges;
2345
+ /**
2346
+ * Validates the script.
2347
+ *
2348
+ * @param body an object with the body content
2349
+ * @throws ValidateScriptHttpError
2350
+ */
2351
+ validateScript: typeof validateScript;
2352
+ /**
2353
+ * Deletes a specific app.
2354
+ *
2355
+ * @param appId Identifier of the app.
2356
+ * @throws DeleteAppHttpError
2357
+ */
2358
+ deleteApp: typeof deleteApp;
2359
+ /**
2360
+ * Retrieves information for a specific app.
2361
+ *
2362
+ * @param appId Identifier of the app.
2363
+ * @throws GetAppInfoHttpError
2364
+ */
2365
+ getAppInfo: typeof getAppInfo;
2366
+ /**
2367
+ * Updates the information for a specific app.
2368
+ *
2369
+ * @param appId Identifier of the app.
2370
+ * @param body an object with the body content
2371
+ * @throws UpdateAppInfoHttpError
2372
+ */
2373
+ updateAppInfo: typeof updateAppInfo;
2374
+ /**
2375
+ * Copies a specific app.
2376
+ *
2377
+ * @param appId Identifier of the app.
2378
+ * @param body an object with the body content
2379
+ * @throws CopyAppHttpError
2380
+ */
2381
+ copyApp: typeof copyApp;
2382
+ /**
2383
+ * Retrieves the lineage for an app.
2384
+ * Returns a JSON-formatted array of strings describing the lineage of the app.
2385
+ *
2386
+ * @param appId Identifier of the app.
2387
+ * @throws GetAppDataLineageHttpError
2388
+ */
2389
+ getAppDataLineage: typeof getAppDataLineage;
2390
+ /**
2391
+ * Retrieves the data model and reload statistics metadata of an app.
2392
+ * An empty metadata structure is returned if the metadata is not available in the app.
2393
+ *
2394
+ * @param appId Identifier of the app.
2395
+ * @throws GetAppDataMetadataHttpError
2396
+ */
2397
+ getAppDataMetadata: typeof getAppDataMetadata;
2398
+ /**
2399
+ * Exports a specific app.
2400
+ *
2401
+ * @param appId Identifier of the app.
2402
+ * @param query an object with query parameters
2403
+ * @throws ExportAppHttpError
2404
+ */
2405
+ exportApp: typeof exportApp;
2406
+ /**
2407
+ * Returns information about supported analyses for the app's data model. Lists available analysis types, along with minimum and maximum number of dimensions, measures, and fields.
2408
+ *
2409
+ * @param appId Qlik Sense app identifier
2410
+ * @throws GetAppInsightAnalysesHttpError
2411
+ */
2412
+ getAppInsightAnalyses: typeof getAppInsightAnalyses;
2413
+ /**
2414
+ * Returns analysis recommendations in response to a natural language question, a set of fields and master items, or a set of fields and master items with an optional target analysis.
2415
+ *
2416
+ * @param appId Qlik Sense app identifier
2417
+ * @param body an object with the body content
2418
+ * @throws GetAppInsightAnalysisRecommendationsHttpError
2419
+ */
2420
+ getAppInsightAnalysisRecommendations: typeof getAppInsightAnalysisRecommendations;
2421
+ /**
2422
+ * Returns information about model used to make analysis recommendations. Lists all fields and master items in the logical model, along with an indication of the validity of the logical model if the default is not used.
2423
+ *
2424
+ * @param appId Qlik Sense app identifier
2425
+ * @throws GetAppInsightAnalysisModelHttpError
2426
+ */
2427
+ getAppInsightAnalysisModel: typeof getAppInsightAnalysisModel;
2428
+ /**
2429
+ * Deletes a media content file or complete directory.
2430
+ * Returns OK if the bytes containing the media file (or the complete content of a directory) were successfully deleted, or error in case of failure or lack of permission.
2431
+ *
2432
+ * @param appId Unique application identifier.
2433
+ * @param path Path to file content.
2434
+ * @throws DeleteAppMediaHttpError
2435
+ */
2436
+ deleteAppMedia: typeof deleteAppMedia;
2437
+ /**
2438
+ * Gets media content from file.
2439
+ * Returns a stream of bytes containing the media file content on success, or error if file is not found.
2440
+ *
2441
+ * @param appId Unique application identifier.
2442
+ * @param path Path to file content.
2443
+ * @throws GetAppMediaHttpError
2444
+ */
2445
+ getAppMedia: typeof getAppMedia;
2446
+ /**
2447
+ * Stores the media content file.
2448
+ * Returns OK if the bytes containing the media file content were successfully stored, or error in case of failure, lack of permission or file already exists on the supplied path.
2449
+ *
2450
+ * @param appId Unique application identifier.
2451
+ * @param path Path to file content.
2452
+ * @param body an object with the body content
2453
+ * @throws UploadAppMediaHttpError
2454
+ */
2455
+ uploadAppMedia: typeof uploadAppMedia;
2456
+ /**
2457
+ * Lists media content.
2458
+ * Returns a JSON formatted array of strings describing the available media content or error if the optional path supplied is not found.
2459
+ *
2460
+ * @param appId Unique application identifier.
2461
+ * @param path The path to sub folder with static content relative to the root folder. Use empty path to access the root folder.
2462
+ * @param query an object with query parameters
2463
+ * @throws GetAppMediaListHttpError
2464
+ */
2465
+ getAppMediaList: typeof getAppMediaList;
2466
+ /**
2467
+ * Gets media content from file currently used as application thumbnail.
2468
+ * Returns a stream of bytes containing the media file content on success, or error if file is not found.
2469
+ * The image selected as thumbnail is only updated when application is saved.
2470
+ *
2471
+ * @param appId Unique application identifier.
2472
+ * @throws GetAppThumbnailHttpError
2473
+ */
2474
+ getAppThumbnail: typeof getAppThumbnail;
2475
+ /**
2476
+ * Sets owner on an app object.
2477
+ * The user must be the owner of the object.
2478
+ *
2479
+ * @param appId Identifier of the app.
2480
+ * @param objectId Identifier of the object.
2481
+ * @param body an object with the body content
2482
+ * @throws UpdateAppObjectOwnerHttpError
2483
+ */
2484
+ updateAppObjectOwner: typeof updateAppObjectOwner;
2485
+ /**
2486
+ * Changes owner of the app.
2487
+ *
2488
+ * @param appId Identifier of the app.
2489
+ * @param body an object with the body content
2490
+ * @throws UpdateAppOwnerHttpError
2491
+ */
2492
+ updateAppOwner: typeof updateAppOwner;
2493
+ /**
2494
+ * Publishes a specific app to a managed space.
2495
+ *
2496
+ * @param appId Identifier of the app.
2497
+ * @param body an object with the body content
2498
+ * @throws PublishAppHttpError
2499
+ */
2500
+ publishApp: typeof publishApp;
2501
+ /**
2502
+ * Republishes a published app to a managed space.
2503
+ *
2504
+ * @param appId Identifier of the app.
2505
+ * @param body an object with the body content
2506
+ * @throws RepublishAppHttpError
2507
+ */
2508
+ republishApp: typeof republishApp;
2509
+ /**
2510
+ * Retrieves the metadata about all script logs stored for an app.
2511
+ * Returns an array of ScriptLogMeta objects.
2512
+ *
2513
+ * @param appId Identifier of the app.
2514
+ * @throws GetAppReloadLogsHttpError
2515
+ */
2516
+ getAppReloadLogs: typeof getAppReloadLogs;
2517
+ /**
2518
+ * Retrieves the log of a specific reload.
2519
+ * Returns the log as "text/plain; charset=UTF-8".
2520
+ *
2521
+ * @param appId Identifier of the app.
2522
+ * @param reloadId Identifier of the reload.
2523
+ * @throws GetAppReloadLogHttpError
2524
+ */
2525
+ getAppReloadLog: typeof getAppReloadLog;
2526
+ /**
2527
+ * Retrieves the app reload metadata list.
2528
+ * Reload metadata contains reload information, including reload id, duration, endtime and lineage load info.
2529
+ *
2530
+ * @param appId Identifier of the app
2531
+ * @param reloadId Identifier of the reload. Use empty reloadId to get all reloads.
2532
+ * @param query an object with query parameters
2533
+ * @throws GetAppReloadMetadataHttpError
2534
+ */
2535
+ getAppReloadMetadata: typeof getAppReloadMetadata;
2536
+ /**
2537
+ * List all filters that are present in the given app. Filters allow to reduce the app data visible in a report output. Each filter can contain definitions on one or multiple fields.
2538
+ *
2539
+ * @param appId Qlik Sense app identifier
2540
+ * @param query an object with query parameters
2541
+ * @throws GetAppReportFiltersHttpError
2542
+ */
2543
+ getAppReportFilters: typeof getAppReportFilters;
2544
+ /**
2545
+ * Creates a new report filter which is used to re-apply selections, variables, patches to an engine session.
2546
+ *
2547
+ * @param appId Qlik Sense app identifier
2548
+ * @param body an object with the body content
2549
+ * @throws CreateAppReportFilterHttpError
2550
+ */
2551
+ createAppReportFilter: typeof createAppReportFilter;
2552
+ /**
2553
+ * Get the number of filters for the given app and filter types
2554
+ *
2555
+ * @param appId Qlik Sense app identifier
2556
+ * @param query an object with query parameters
2557
+ * @throws CountAppReportFiltersHttpError
2558
+ */
2559
+ countAppReportFilters: typeof countAppReportFilters;
2560
+ /**
2561
+ * Delete a filter
2562
+ *
2563
+ * @param appId Qlik Sense app identifier
2564
+ * @param id The filter id identifier (bookmarkId).
2565
+ * @throws DeleteAppReportFilterHttpError
2566
+ */
2567
+ deleteAppReportFilter: typeof deleteAppReportFilter;
2568
+ /**
2569
+ * Get a filter
2570
+ *
2571
+ * @param appId Qlik Sense app identifier
2572
+ * @param id The filter id identifier (bookmarkId).
2573
+ * @throws GetAppReportFilterHttpError
2574
+ */
2575
+ getAppReportFilter: typeof getAppReportFilter;
2576
+ /**
2577
+ * Update a filter
2578
+ *
2579
+ * @param appId Qlik Sense app identifier
2580
+ * @param id The filter id identifier (bookmarkId).
2581
+ * @param body an object with the body content
2582
+ * @throws PatchAppReportFilterHttpError
2583
+ */
2584
+ patchAppReportFilter: typeof patchAppReportFilter;
2585
+ /**
2586
+ * Retrieves the script history for an app.
2587
+ * Returns information about the saved versions of the script in a list sorted with latest first.
2588
+ *
2589
+ * @param appId Identifier of the app.
2590
+ * @param query an object with query parameters
2591
+ * @throws GetAppScriptHistoryHttpError
2592
+ */
2593
+ getAppScriptHistory: typeof getAppScriptHistory;
2594
+ /**
2595
+ * Sets script for an app.
2596
+ *
2597
+ * @param appId Identifier of the app.
2598
+ * @param body an object with the body content
2599
+ * @throws UpdateAppScriptHttpError
2600
+ */
2601
+ updateAppScript: typeof updateAppScript;
2602
+ /**
2603
+ * Deletes a specific version of the script for an app.
2604
+ * Fails if the supplied id is the current version.
2605
+ *
2606
+ * @param appId Identifier of the app.
2607
+ * @param id Identifier of the script version
2608
+ * @throws DeleteAppScriptHttpError
2609
+ */
2610
+ deleteAppScript: typeof deleteAppScript;
2611
+ /**
2612
+ * Retrieves a version of the script for an app.
2613
+ * Returns the script text.
2614
+ *
2615
+ * @param appId Identifier of the app.
2616
+ * @param id Identifier of the script version, or 'current' for retrieving the current version.
2617
+ * @throws GetAppScriptHttpError
2618
+ */
2619
+ getAppScript: typeof getAppScript;
2620
+ /**
2621
+ * Updates a specific version of the script for an app.
2622
+ *
2623
+ * @param appId Identifier of the app.
2624
+ * @param id Identifier of the script version.
2625
+ * @param body an object with the body content
2626
+ * @throws PatchAppScriptHttpError
2627
+ */
2628
+ patchAppScript: typeof patchAppScript;
2629
+ /**
2630
+ * Removes space from a specific app.
2631
+ *
2632
+ * @param appId Identifier of the app.
2633
+ * @throws RemoveAppFromSpaceHttpError
2634
+ */
2635
+ removeAppFromSpace: typeof removeAppFromSpace;
2636
+ /**
2637
+ * Sets space on a specific app.
2638
+ *
2639
+ * @param appId Identifier of the app.
2640
+ * @param body an object with the body content
2641
+ * @throws MoveAppToSpaceHttpError
2642
+ */
2643
+ moveAppToSpace: typeof moveAppToSpace;
2644
+ /**
2645
+ * Find all evaluations for an app GUID.
2646
+ * Supports paging via next, prev which are sent in the response body
2647
+ *
2648
+ * @param guid The app guid.
2649
+ * @param query an object with query parameters
2650
+ * @throws GetAppEvaluationsHttpError
2651
+ */
2652
+ getAppEvaluations: typeof getAppEvaluations;
2653
+ /**
2654
+ * Queue an app evaluation by its app guid.
2655
+ * @example
2656
+ * queueAppEvaluation(
2657
+ * "abcdefghijklmnopq"
2658
+ * )
2659
+ *
2660
+ * @param guid Guid of the app.
2661
+ * @throws QueueAppEvaluationHttpError
2662
+ */
2663
+ queueAppEvaluation: typeof queueAppEvaluation;
2664
+ /**
2665
+ * Clears the cache for apps api requests.
2666
+ */
2667
+ clearCache: typeof clearCache;
2668
+ };
2669
+ /**
2670
+ * Functions for the apps api
2671
+ */
2672
+ declare const appsExport: AppsAPI;
2673
+ //#endregion
4
2674
  export { Analysis, AnalysisComposition, AnalysisDescriptor, AnalysisDescriptorResponse, AnalysisDetails, AnalysisGroup, AnalysisModelItemField, AnalysisModelItemMasterItem, AnalysisModelResponse, AnalysisModelResponseDetail, AnalysisRecommendRequest, AnalysisRecommendationResponse, AnalysisRecommendationResponseDetail, AppAttributes, AppContentList, AppContentListItem, AppObjectGenericType, AppUpdateAttributes, AppsAPI, ChartType, Classification, Classifications, Cmpbool, Cmpfloat, CmpfloatWithTimeout, Cmpint, Comparison, Comparisonfields, ComparisonobjMemoryLimit, Comparisonobjresponsetime, Comparisonoobjheavy, Comparisontables, CompositionMinMax, CopyAppHttpError, CopyAppHttpResponse, CountAppReportFiltersHttpError, CountAppReportFiltersHttpResponse, CreateApp, CreateAppHttpError, CreateAppHttpResponse, CreateAppReportFilterHttpError, CreateAppReportFilterHttpResponse, DataModelMetadata, DeleteAppHttpError, DeleteAppHttpResponse, DeleteAppMediaHttpError, DeleteAppMediaHttpResponse, DeleteAppReportFilterHttpError, DeleteAppReportFilterHttpResponse, DeleteAppScriptHttpError, DeleteAppScriptHttpResponse, Error, Errors, Evaluation, Evaluations, EvaluatorError, Event, ExportAppHttpError, ExportAppHttpResponse, FieldAttrType, FieldAttributes, FieldInTableProfilingData, FieldMetadata, FieldOverride, FileData, Filter, FilterError, FilterErrors, FilterField, FilterFieldValue, FilterItemPatch, FilterList, FilterListItem, FilterRequest, FilterType, FilterV10, FilterVariable, FiltersCount, Float64, FrequencyDistributionData, GetAppDataLineageHttpError, GetAppDataLineageHttpResponse, GetAppDataMetadataHttpError, GetAppDataMetadataHttpResponse, GetAppEvaluationComparisonHttpError, GetAppEvaluationComparisonHttpResponse, GetAppEvaluationComparisonXmlHttpError, GetAppEvaluationComparisonXmlHttpResponse, GetAppEvaluationHttpError, GetAppEvaluationHttpResponse, GetAppEvaluationXmlHttpError, GetAppEvaluationXmlHttpResponse, GetAppEvaluationsHttpError, GetAppEvaluationsHttpResponse, GetAppInfoHttpError, GetAppInfoHttpResponse, GetAppInsightAnalysesHttpError, GetAppInsightAnalysesHttpResponse, GetAppInsightAnalysisModelHttpError, GetAppInsightAnalysisModelHttpResponse, GetAppInsightAnalysisRecommendationsHttpError, GetAppInsightAnalysisRecommendationsHttpResponse, GetAppMediaHttpError, GetAppMediaHttpResponse, GetAppMediaListHttpError, GetAppMediaListHttpResponse, GetAppReloadLogHttpError, GetAppReloadLogHttpResponse, GetAppReloadLogsHttpError, GetAppReloadLogsHttpResponse, GetAppReloadMetadataHttpError, GetAppReloadMetadataHttpResponse, GetAppReportFilterHttpError, GetAppReportFilterHttpResponse, GetAppReportFiltersHttpError, GetAppReportFiltersHttpResponse, GetAppScriptHistoryHttpError, GetAppScriptHistoryHttpResponse, GetAppScriptHttpError, GetAppScriptHttpResponse, GetAppThumbnailHttpError, GetAppThumbnailHttpResponse, GetAppsPrivilegesHttpError, GetAppsPrivilegesHttpResponse, HardwareMeta, Href, Href2, ImportAppHttpError, ImportAppHttpResponse, JsonObject, LastReloadMetadata, LineageInfoRest, LinkResponse, Links, LinksResponse, Log, Metadata, MoveAppToSpaceHttpError, MoveAppToSpaceHttpResponse, NavigationLink, NavigationLinks, NumberFormat, NxApp, NxAppCreatePrivileges, NxAppObject, NxAttributes, NxObjectAttributes, NxPatch, NxPatchOperationType, Objectmetrics, Objectspec, Objecttopspec, PartialNluInfo, PatchAppReportFilterHttpError, PatchAppReportFilterHttpResponse, PatchAppScriptHttpError, PatchAppScriptHttpResponse, PatchFilter, PatchFilterItem, PublishApp, PublishAppHttpError, PublishAppHttpResponse, PublishData, QueueAppEvaluationHttpError, QueueAppEvaluationHttpResponse, RecommendFieldItem, RecommendItems, RecommendMasterItem, RecommendNaturalLangQuery, RecommendedAnalysis, RecommendedAnalysisCore, ReloadIncludeFile, ReloadListMetadata, ReloadMeta, ReloadStatements, RemoveAppFromSpaceHttpError, RemoveAppFromSpaceHttpResponse, RepublishApp, RepublishAppHttpError, RepublishAppHttpResponse, Result, Resultentry, Resultmetadatatopfields, Resultmetadatatoptables, ResultobjMemoryLimit, Resultobjresponsetime, Resultobjsheet, Resultsingle, Script, ScriptIssue, ScriptIssues, ScriptLogList, ScriptLogMeta, ScriptMeta, ScriptMetaList, ScriptVersion, SimplifiedClassifications, Sortedcomparisonfields, Sortedcomparisonobjresponsetime, Sortedcomparisonoobjheavy, Sortedcomparisontables, SymbolFrequency, SymbolValue, TableMetadata, TableProfilingData, UpdateApp, UpdateAppInfoHttpError, UpdateAppInfoHttpResponse, UpdateAppObjectOwnerHttpError, UpdateAppObjectOwnerHttpResponse, UpdateAppOwnerHttpError, UpdateAppOwnerHttpResponse, UpdateAppScriptHttpError, UpdateAppScriptHttpResponse, UpdateOwner, UpdateSpace, UploadAppMediaHttpError, UploadAppMediaHttpResponse, UsageEnum, UserPrivileges, ValidateScriptHttpError, ValidateScriptHttpResponse, clearCache, copyApp, countAppReportFilters, createApp, createAppReportFilter, appsExport as default, deleteApp, deleteAppMedia, deleteAppReportFilter, deleteAppScript, exportApp, getAppDataLineage, getAppDataMetadata, getAppEvaluation, getAppEvaluationComparison, getAppEvaluationComparisonXml, getAppEvaluationXml, getAppEvaluations, getAppInfo, getAppInsightAnalyses, getAppInsightAnalysisModel, getAppInsightAnalysisRecommendations, getAppMedia, getAppMediaList, getAppReloadLog, getAppReloadLogs, getAppReloadMetadata, getAppReportFilter, getAppReportFilters, getAppScript, getAppScriptHistory, getAppThumbnail, getAppsPrivileges, importApp, moveAppToSpace, patchAppReportFilter, patchAppScript, publishApp, queueAppEvaluation, removeAppFromSpace, republishApp, updateAppInfo, updateAppObjectOwner, updateAppOwner, updateAppScript, uploadAppMedia, validateScript };