@qlik/api 0.0.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 (160) hide show
  1. package/LICENSE +17 -0
  2. package/README.md +8 -0
  3. package/api-keys.d.mts +313 -0
  4. package/api-keys.d.ts +313 -0
  5. package/api-keys.js +76 -0
  6. package/api-keys.mjs +76 -0
  7. package/apps.d.mts +1921 -0
  8. package/apps.d.ts +1921 -0
  9. package/apps.js +331 -0
  10. package/apps.mjs +331 -0
  11. package/audits.d.mts +262 -0
  12. package/audits.d.ts +262 -0
  13. package/audits.js +63 -0
  14. package/audits.mjs +63 -0
  15. package/auth-CSVTXOZX.js +36 -0
  16. package/auth-TE272Q34.mjs +36 -0
  17. package/auth-types-nnUcWhuU.d.mts +98 -0
  18. package/auth-types-nnUcWhuU.d.ts +98 -0
  19. package/auth.d.mts +26 -0
  20. package/auth.d.ts +26 -0
  21. package/auth.js +13 -0
  22. package/auth.mjs +13 -0
  23. package/automations.d.mts +638 -0
  24. package/automations.d.ts +638 -0
  25. package/automations.js +166 -0
  26. package/automations.mjs +166 -0
  27. package/brands.d.mts +614 -0
  28. package/brands.d.ts +614 -0
  29. package/brands.js +118 -0
  30. package/brands.mjs +118 -0
  31. package/chunk-3YE7EI7I.mjs +17 -0
  32. package/chunk-4ES65KO3.js +57 -0
  33. package/chunk-4FLMND6T.js +25 -0
  34. package/chunk-4OMEH5SW.mjs +1337 -0
  35. package/chunk-CKPJE4IA.mjs +57 -0
  36. package/chunk-GUQBHY3H.mjs +25 -0
  37. package/chunk-OULT3V2U.js +17 -0
  38. package/chunk-WM7FQU2U.mjs +21 -0
  39. package/chunk-XASXL2NC.js +1337 -0
  40. package/chunk-ZT4C7KCQ.js +21 -0
  41. package/collections.d.mts +535 -0
  42. package/collections.d.ts +535 -0
  43. package/collections.js +100 -0
  44. package/collections.mjs +100 -0
  45. package/csp-origins.d.mts +258 -0
  46. package/csp-origins.d.ts +258 -0
  47. package/csp-origins.js +66 -0
  48. package/csp-origins.mjs +66 -0
  49. package/data-assets.d.mts +195 -0
  50. package/data-assets.d.ts +195 -0
  51. package/data-assets.js +61 -0
  52. package/data-assets.mjs +61 -0
  53. package/data-connections.d.mts +527 -0
  54. package/data-connections.d.ts +527 -0
  55. package/data-connections.js +96 -0
  56. package/data-connections.mjs +96 -0
  57. package/data-credentials.d.mts +188 -0
  58. package/data-credentials.d.ts +188 -0
  59. package/data-credentials.js +56 -0
  60. package/data-credentials.mjs +56 -0
  61. package/data-files.d.mts +471 -0
  62. package/data-files.d.ts +471 -0
  63. package/data-files.js +116 -0
  64. package/data-files.mjs +116 -0
  65. package/docs/examples.md +4 -0
  66. package/enigma-session-4L373ALV.mjs +10196 -0
  67. package/enigma-session-TEB53FAF.js +10196 -0
  68. package/esm-4X3DKK5D.js +63 -0
  69. package/esm-SOWVJKOQ.mjs +63 -0
  70. package/extensions.d.mts +257 -0
  71. package/extensions.d.ts +257 -0
  72. package/extensions.js +74 -0
  73. package/extensions.mjs +74 -0
  74. package/global.types-Eto4uYwy.d.mts +102 -0
  75. package/global.types-hIvp-WdX.d.ts +102 -0
  76. package/glossaries.d.mts +1041 -0
  77. package/glossaries.d.ts +1041 -0
  78. package/glossaries.js +225 -0
  79. package/glossaries.mjs +225 -0
  80. package/groups.d.mts +379 -0
  81. package/groups.d.ts +379 -0
  82. package/groups.js +83 -0
  83. package/groups.mjs +83 -0
  84. package/identity-providers.d.mts +492 -0
  85. package/identity-providers.d.ts +492 -0
  86. package/identity-providers.js +80 -0
  87. package/identity-providers.mjs +80 -0
  88. package/index.d.mts +142 -0
  89. package/index.d.ts +142 -0
  90. package/index.js +678 -0
  91. package/index.mjs +678 -0
  92. package/invoke-fetch-MSSJAZ7K.mjs +14 -0
  93. package/invoke-fetch-PEI54KZO.js +14 -0
  94. package/items.d.mts +501 -0
  95. package/items.d.ts +501 -0
  96. package/items.js +84 -0
  97. package/items.mjs +84 -0
  98. package/licenses.d.mts +436 -0
  99. package/licenses.d.ts +436 -0
  100. package/licenses.js +87 -0
  101. package/licenses.mjs +87 -0
  102. package/package.json +264 -0
  103. package/qix-EU7PXRZ6.mjs +573 -0
  104. package/qix-RLTISYTB.js +573 -0
  105. package/qix.d.mts +11543 -0
  106. package/qix.d.ts +11543 -0
  107. package/qix.js +9 -0
  108. package/qix.mjs +9 -0
  109. package/quotas.d.mts +105 -0
  110. package/quotas.d.ts +105 -0
  111. package/quotas.js +31 -0
  112. package/quotas.mjs +31 -0
  113. package/reload-tasks.d.mts +222 -0
  114. package/reload-tasks.d.ts +222 -0
  115. package/reload-tasks.js +59 -0
  116. package/reload-tasks.mjs +59 -0
  117. package/reloads.d.mts +189 -0
  118. package/reloads.d.ts +189 -0
  119. package/reloads.js +44 -0
  120. package/reloads.mjs +44 -0
  121. package/roles.d.mts +150 -0
  122. package/roles.d.ts +150 -0
  123. package/roles.js +30 -0
  124. package/roles.mjs +30 -0
  125. package/spaces.d.mts +524 -0
  126. package/spaces.d.ts +524 -0
  127. package/spaces.js +118 -0
  128. package/spaces.mjs +118 -0
  129. package/temp-contents.d.mts +222 -0
  130. package/temp-contents.d.ts +222 -0
  131. package/temp-contents.js +60 -0
  132. package/temp-contents.mjs +60 -0
  133. package/tenants.d.mts +276 -0
  134. package/tenants.d.ts +276 -0
  135. package/tenants.js +68 -0
  136. package/tenants.mjs +68 -0
  137. package/themes.d.mts +235 -0
  138. package/themes.d.ts +235 -0
  139. package/themes.js +74 -0
  140. package/themes.mjs +74 -0
  141. package/transports.d.mts +298 -0
  142. package/transports.d.ts +298 -0
  143. package/transports.js +62 -0
  144. package/transports.mjs +62 -0
  145. package/users.d.mts +544 -0
  146. package/users.d.ts +544 -0
  147. package/users.js +99 -0
  148. package/users.mjs +99 -0
  149. package/web-integrations.d.mts +246 -0
  150. package/web-integrations.d.ts +246 -0
  151. package/web-integrations.js +59 -0
  152. package/web-integrations.mjs +59 -0
  153. package/web-notifications.d.mts +220 -0
  154. package/web-notifications.d.ts +220 -0
  155. package/web-notifications.js +66 -0
  156. package/web-notifications.mjs +66 -0
  157. package/webhooks.d.mts +422 -0
  158. package/webhooks.d.ts +422 -0
  159. package/webhooks.js +100 -0
  160. package/webhooks.mjs +100 -0
package/apps.d.mts ADDED
@@ -0,0 +1,1921 @@
1
+ import { A as ApiCallOptions } from './global.types-Eto4uYwy.mjs';
2
+ import './auth-types-nnUcWhuU.mjs';
3
+
4
+ type Analysis = "breakdown" | "changePoint" | "comparison" | "contribution" | "correlation" | "fact" | "mutualInfo" | "rank" | "spike" | "trend" | "values";
5
+ type AnalysisComposition = {
6
+ description?: {
7
+ long?: string;
8
+ short?: string;
9
+ };
10
+ /** Upper and lower bounds for items of specific classification types */
11
+ dims?: CompositionMinMax;
12
+ /** Upper and lower bounds for items of specific classification types */
13
+ geos?: CompositionMinMax;
14
+ /** Upper and lower bounds for items of specific classification types */
15
+ items?: CompositionMinMax;
16
+ /** Upper and lower bounds for items of specific classification types */
17
+ msrs?: CompositionMinMax;
18
+ /** Upper and lower bounds for items of specific classification types */
19
+ temporals?: CompositionMinMax;
20
+ };
21
+ type AnalysisDescriptor = {
22
+ compositions?: AnalysisComposition[];
23
+ id?: string;
24
+ /** Used for period-specific analyses to indicate the defined or available calendar period must be of type autoCalendar */
25
+ requiresAutoCalendarPeriod?: boolean;
26
+ /** Used for period-specific analyses to indicate the temporal dimension must be associated with one or more analysis periods */
27
+ requiresAvailableAnalysisPeriod?: boolean;
28
+ /** Used for period-specific analyses to indicate the measure must be associated with one or more analysis periods */
29
+ requiresDefinedAnalysisPeriod?: boolean;
30
+ /** If analysis can work with master items (default is true) */
31
+ supportsMasterItems?: boolean;
32
+ };
33
+ type AnalysisDescriptorResponse = {
34
+ data?: AnalysisDescriptor[];
35
+ links?: Links;
36
+ };
37
+ type AnalysisDetails = {
38
+ analysis?: Analysis;
39
+ analysisGroup?: AnalysisGroup;
40
+ title?: string;
41
+ };
42
+ type AnalysisGroup = "anomaly" | "brekadown" | "comparison" | "correl" | "fact" | "list" | "mutualInfo" | "rank";
43
+ type AnalysisModelItemField = {
44
+ /** classification defines the default role that attribute can play in an analysis */
45
+ classifications?: Classifications;
46
+ /** whether the field is hidden in business logic */
47
+ isHidden?: boolean;
48
+ /** populated only for fields */
49
+ name?: string;
50
+ simplifiedClassifications?: SimplifiedClassifications;
51
+ };
52
+ type AnalysisModelItemMasterItem = {
53
+ caption?: string;
54
+ /** classification defines the default role that attribute can play in an analysis */
55
+ classifications?: Classifications;
56
+ /** whether the master item is hidden in business logic */
57
+ isHidden?: boolean;
58
+ /** only available for master items */
59
+ libId?: string;
60
+ simplifiedClassifications?: SimplifiedClassifications;
61
+ };
62
+ type AnalysisModelResponse = {
63
+ data?: AnalysisModelResponseDetail[];
64
+ links?: Links;
65
+ };
66
+ type AnalysisModelResponseDetail = {
67
+ fields?: AnalysisModelItemField[];
68
+ /** set only if previous property is true, to indicate if the business logic passes validation */
69
+ isDefinedLogicalModelValid?: boolean;
70
+ /** if the analysis model is constructed based on a user-defined business-logic (as opposed to a default one) */
71
+ isLogicalModelEnabled?: boolean;
72
+ masterItems?: AnalysisModelItemMasterItem[];
73
+ };
74
+ type AnalysisRecommendRequest = unknown;
75
+ type AnalysisRecommendationResponse = {
76
+ data?: AnalysisRecommendationResponseDetail[];
77
+ };
78
+ type AnalysisRecommendationResponseDetail = {
79
+ nluInfo?: PartialNluInfo[];
80
+ recAnalyses: RecommendedAnalysis[];
81
+ };
82
+ type AppAttributes = {
83
+ /** The description of the application */
84
+ description?: string;
85
+ /** Set custom locale instead of the system default */
86
+ locale?: string;
87
+ /** The name (title) of the application */
88
+ name?: string;
89
+ /** The space ID of the application */
90
+ spaceId?: string;
91
+ /** Indicates whether the app is used for Analytics or DataPreparation
92
+ //
93
+ // One of:
94
+ // * ANALYTICS
95
+ // * DATA_PREPARATION */
96
+ usage?: "ANALYTICS" | "DATA_PREPARATION";
97
+ };
98
+ type AppContentList = {
99
+ /** Content list items. */
100
+ data?: AppContentListItem[];
101
+ /** Content library name. */
102
+ library?: string;
103
+ /** Content library relative listing path. Empty in case of root listed or representing actual subpath listed. */
104
+ subpath?: string;
105
+ };
106
+ type AppContentListItem = {
107
+ /** Unique content identifier. */
108
+ id?: string;
109
+ /** Unique content link. */
110
+ link?: string;
111
+ /** Content name. */
112
+ name?: string;
113
+ /** Content type. */
114
+ type?: string;
115
+ };
116
+ type AppUpdateAttributes = {
117
+ /** The description of the application. */
118
+ description?: string;
119
+ /** The name (title) of the application. */
120
+ name?: string;
121
+ };
122
+ type ChartType = "barchart" | "combochart" | "distributionplot" | "kpi" | "linechart" | "map" | "scatterplot" | "table";
123
+ 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")[];
124
+ type CompositionMinMax = {
125
+ max?: number;
126
+ min?: number;
127
+ };
128
+ type CreateApp = {
129
+ attributes?: AppAttributes;
130
+ };
131
+ type DataModelMetadata = {
132
+ /** List of field descriptions. */
133
+ fields?: FieldMetadata[];
134
+ /** If set to true, the app has section access configured. */
135
+ has_section_access?: boolean;
136
+ is_direct_query_mode?: boolean;
137
+ reload_meta?: LastReloadMetadata;
138
+ /** Static memory usage for the app. */
139
+ static_byte_size?: number;
140
+ /** List of table descriptions. */
141
+ tables?: TableMetadata[];
142
+ /** Profiling data of the tables in the app. */
143
+ tables_profiling_data?: TableProfilingData[];
144
+ /**
145
+ // One of:
146
+ // * ANALYTICS
147
+ // * DATA_PREPARATION */
148
+ usage?: "ANALYTICS" | "DATA_PREPARATION";
149
+ };
150
+ type Error = {
151
+ /** The error code. */
152
+ code: string;
153
+ /** A human-readable explanation specific to this occurrence of the problem. */
154
+ detail?: string;
155
+ /** Additional properties relating to the error. */
156
+ meta?: unknown;
157
+ /** References to the source of the error. */
158
+ source?: {
159
+ /** The URI query parameter that caused the error. */
160
+ parameter?: string;
161
+ /** A JSON Pointer to the property that caused the error. */
162
+ pointer?: string;
163
+ };
164
+ /** Summary of the problem. */
165
+ title: string;
166
+ };
167
+ type Errors = {
168
+ errors?: Error[];
169
+ };
170
+ type EvaluatorError = {
171
+ errors?: {
172
+ code?: string;
173
+ status?: number;
174
+ title?: string;
175
+ }[];
176
+ };
177
+ type FieldAttributes = {
178
+ /** Defines the decimal separator.
179
+ // Example: **.** */
180
+ Dec?: string;
181
+ /** Defines the format pattern that applies to _qText_ .
182
+ // Is used in connection to the type of the field (parameter **qType** ).
183
+ // For more information, see _Formatting mechanism_.
184
+ // Example: _YYYY-MM-DD_ for a date. */
185
+ Fmt?: string;
186
+ /** Defines the thousand separator (if any).
187
+ // Is used if **qUseThou** is set to 1.
188
+ // Example: **,** */
189
+ Thou?: string;
190
+ /** Type of the field.
191
+ // Default is U.
192
+ //
193
+ // One of:
194
+ // * U or UNKNOWN
195
+ // * A or ASCII
196
+ // * I or INTEGER
197
+ // * R or REAL
198
+ // * F or FIX
199
+ // * M or MONEY
200
+ // * D or DATE
201
+ // * T or TIME
202
+ // * TS or TIMESTAMP
203
+ // * IV or INTERVAL */
204
+ Type?: "UNKNOWN" | "ASCII" | "INTEGER" | "REAL" | "FIX" | "MONEY" | "DATE" | "TIME" | "TIMESTAMP" | "INTERVAL";
205
+ /** Defines whether or not a thousands separator must be used.
206
+ // Default is 0. */
207
+ UseThou?: number;
208
+ /** Number of decimals.
209
+ // Default is 10. */
210
+ nDec?: number;
211
+ };
212
+ type FieldInTableProfilingData = {
213
+ /** Average of all numerical values. NaN otherwise. */
214
+ Average?: number;
215
+ /** Average string length of textual values. 0 otherwise. */
216
+ AvgStringLen?: number;
217
+ /** Number of distinct numeric values */
218
+ DistinctNumericValues?: number;
219
+ /** Number of distinct text values */
220
+ DistinctTextValues?: number;
221
+ /** Number of distinct values */
222
+ DistinctValues?: number;
223
+ /** Number of empty strings */
224
+ EmptyStrings?: number;
225
+ /** List of tags related to the field. */
226
+ FieldTags?: string[];
227
+ /** For textual values the first sorted string. */
228
+ FirstSorted?: string;
229
+ /** The .01, .05, .1, .25, .5, .75, .9, .95, .99 fractiles. Array of NaN otherwise. */
230
+ Fractiles?: number[];
231
+ FrequencyDistribution?: FrequencyDistributionData;
232
+ /** Kurtosis of the numerical values. NaN otherwise. */
233
+ Kurtosis?: number;
234
+ /** For textual values the last sorted string. */
235
+ LastSorted?: string;
236
+ /** Maximum value of numerical values. NaN otherwise. */
237
+ Max?: number;
238
+ /** Maximum string length of textual values. 0 otherwise. */
239
+ MaxStringLen?: number;
240
+ /** Median of all numerical values. NaN otherwise. */
241
+ Median?: number;
242
+ /** Minimum value of numerical values. NaN otherwise. */
243
+ Min?: number;
244
+ /** Minimum string length of textual values. 0 otherwise. */
245
+ MinStringLen?: number;
246
+ /** Three most frequent values and their frequencies */
247
+ MostFrequent?: SymbolFrequency[];
248
+ /** Name of the field. */
249
+ Name?: string;
250
+ /** Number of negative values */
251
+ NegValues?: number;
252
+ /** Number of null values */
253
+ NullValues?: number;
254
+ /** Sets the formatting of a field.
255
+ // The properties of _qFieldAttributes_ and the formatting mechanism are described below.
256
+ //
257
+ // ### Formatting mechanism
258
+ // The formatting mechanism depends on the type set in _qType,_ as shown below:
259
+ // <div class=note>In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.</div>
260
+ //
261
+ // ### Type is DATE, TIME, TIMESTAMP or INTERVAL
262
+ // The following applies:
263
+ // * If a format pattern is defined in _qFmt_ , the formatting is as defined in _qFmt_ .
264
+ // * If _qFmt_ is empty, the formatting is defined by the number interpretation variables included at the top of the script ( _TimeFormat_ , _DateFormat_ , _TimeStampFormat_ ).
265
+ // * The properties _qDec_ , _qThou_ , _qnDec_ , _qUseThou_ are not used.
266
+ //
267
+ // ### Type is INTEGER
268
+ // The following applies:
269
+ // * 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_ ).
270
+ // * 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 .
271
+ //
272
+ // ### Type is REAL
273
+ // The following applies:
274
+ // * 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_ ).
275
+ // * 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.
276
+ // * 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.
277
+ // * 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.
278
+ //
279
+ // ### Type is FIX
280
+ // The following applies:
281
+ // * 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_ ).
282
+ // * 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.
283
+ //
284
+ // ### Type is MONEY
285
+ // The following applies:
286
+ // * 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_ ).
287
+ // * 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_ ).
288
+ //
289
+ // ### Type is ASCII
290
+ // No formatting, _qFmt_ is ignored. */
291
+ NumberFormat?: FieldAttributes;
292
+ /** Number of numeric values */
293
+ NumericValues?: number;
294
+ /** Number of positive values */
295
+ PosValues?: number;
296
+ /** Skewness of the numerical values. NaN otherwise. */
297
+ Skewness?: number;
298
+ /** Standard deviation of numerical values. NaN otherwise. */
299
+ Std?: number;
300
+ /** Sum of all numerical values. NaN otherwise. */
301
+ Sum?: number;
302
+ /** Squared sum of all numerical values. NaN otherwise. */
303
+ Sum2?: number;
304
+ /** Sum of all characters in strings in the field */
305
+ SumStringLen?: number;
306
+ /** Number of textual values */
307
+ TextValues?: number;
308
+ /** Number of zero values for numerical values */
309
+ ZeroValues?: number;
310
+ };
311
+ type FieldMetadata = {
312
+ /** If set to true, the field has one and only one selection (not 0 and not more than 1).
313
+ // If this property is set to true, the field cannot be cleared anymore and no more selections can be performed in that field.
314
+ // The default value is false. */
315
+ always_one_selected?: boolean;
316
+ /** Static RAM memory used in bytes. */
317
+ byte_size?: number;
318
+ /** Number of distinct field values. */
319
+ cardinal?: number;
320
+ /** Field comment. */
321
+ comment?: string;
322
+ /** If set to true, only distinct field values are shown.
323
+ // The default value is false. */
324
+ distinct_only?: boolean;
325
+ /** Hash of the data in the field. If the data in a reload is the same, the hash will be consistent. */
326
+ hash?: string;
327
+ /** If set to true, the field is hidden.
328
+ // The default value is false. */
329
+ is_hidden?: boolean;
330
+ /** If set to true, the field is locked.
331
+ // The default value is false. */
332
+ is_locked?: boolean;
333
+ /** Is set to true if the value is a numeric.
334
+ // The default value is false. */
335
+ is_numeric?: boolean;
336
+ /** If set to true, the field is semantic.
337
+ // The default value is false. */
338
+ is_semantic?: boolean;
339
+ /** If set to true, the field is a system field.
340
+ // The default value is false. */
341
+ is_system?: boolean;
342
+ /** Name of the field. */
343
+ name?: string;
344
+ /** List of table names. */
345
+ src_tables?: string[];
346
+ /** Gives information on a field. For example, it can return the type of the field.
347
+ // Examples: key, text, ASCII. */
348
+ tags?: string[];
349
+ /** Total number of field values. */
350
+ total_count?: number;
351
+ };
352
+ type FieldOverride = {
353
+ classifications?: string[];
354
+ defaultAggregation?: string;
355
+ };
356
+ type FileData = string;
357
+ type FrequencyDistributionData = {
358
+ /** Bins edges. */
359
+ BinsEdges?: number[];
360
+ /** Bins frequencies. */
361
+ Frequencies?: number[];
362
+ /** Number of bins. */
363
+ NumberOfBins?: number;
364
+ };
365
+ type HardwareMeta = {
366
+ /** Number of logical cores available. */
367
+ logical_cores?: number;
368
+ /** RAM available. */
369
+ total_memory?: number;
370
+ };
371
+ type Href = {
372
+ href?: string;
373
+ };
374
+ type JsonObject = unknown;
375
+ type LastReloadMetadata = {
376
+ /** Number of CPU milliseconds it took to reload the app. */
377
+ cpu_time_spent_ms?: number;
378
+ hardware?: HardwareMeta;
379
+ /** Maximum number of bytes used during reload of the app. */
380
+ peak_memory_bytes?: number;
381
+ };
382
+ type LineageInfoRest = {
383
+ /** A string indicating the origin of the data:
384
+ // * [filename]: the data comes from a local file.
385
+ // * INLINE: the data is entered inline in the load script.
386
+ // * RESIDENT: the data comes from a resident table. The table name is listed.
387
+ // * AUTOGENERATE: the data is generated from the load script (no external table of data source).
388
+ // * Provider: the data comes from a data connection. The connector source name is listed.
389
+ // * [webfile]: the data comes from a web-based file.
390
+ // * STORE: path to QVD or TXT file where data is stored.
391
+ // * EXTENSION: the data comes from a Server Side Extension (SSE). */
392
+ discriminator?: string;
393
+ /** The LOAD and SELECT script statements from the data load script. */
394
+ statement?: string;
395
+ };
396
+ type Links = {
397
+ next?: Href;
398
+ prev?: Href;
399
+ self?: Href;
400
+ };
401
+ type Log = {
402
+ /** Provides a link to download the log file. */
403
+ log?: string;
404
+ };
405
+ type NavigationLink = {
406
+ href?: string;
407
+ };
408
+ type NavigationLinks = {
409
+ next?: NavigationLink;
410
+ prev?: NavigationLink;
411
+ };
412
+ type NxApp = {
413
+ /** App attributes. This structure can also contain extra user-defined attributes. */
414
+ attributes?: NxAttributes;
415
+ /** Object create privileges. Hints to the client what type of objects the user is allowed to create. */
416
+ create?: NxAppCreatePrivileges[];
417
+ /** Application privileges.
418
+ // Hints to the client what actions the user is allowed to perform.
419
+ // Could be any of:
420
+ // * read
421
+ // * create
422
+ // * update
423
+ // * delete
424
+ // * reload
425
+ // * import
426
+ // * publish
427
+ // * duplicate
428
+ // * export
429
+ // * exportdata
430
+ // * change_owner
431
+ // * change_space */
432
+ privileges?: string[];
433
+ };
434
+ type NxAppCreatePrivileges = {
435
+ /** Is set to true if the user has privileges to create the resource. */
436
+ canCreate?: boolean;
437
+ /** Type of resource. For example, sheet, story, bookmark, etc. */
438
+ resource?: string;
439
+ };
440
+ type NxAppObject = {
441
+ /** App object attributes. This structure can also contain extra user-defined attributes. */
442
+ attributes?: NxObjectAttributes;
443
+ /** Application object privileges.
444
+ // Hints to the client what actions the user is allowed to perform.
445
+ // Could be any of:
446
+ // * read
447
+ // * create
448
+ // * update
449
+ // * delete
450
+ // * publish
451
+ // * exportdata
452
+ // * change_owner */
453
+ privileges?: string[];
454
+ };
455
+ type NxAttributes = {
456
+ /** The date and time when the app was created. */
457
+ createdDate?: string;
458
+ /** Contains dynamic JSON data specified by the client. */
459
+ custom?: JsonObject;
460
+ /** App description. */
461
+ description?: string;
462
+ /** The dynamic color of the app. */
463
+ dynamicColor?: string;
464
+ /** If set to true, the app is encrypted. */
465
+ encrypted?: boolean;
466
+ /** If set to true, the app has section access configured, */
467
+ hasSectionAccess?: boolean;
468
+ /** The App ID. */
469
+ id?: string;
470
+ /** True if the app is a Direct Query app, false if not */
471
+ isDirectQueryMode?: boolean;
472
+ /** Date and time of the last reload of the app. */
473
+ lastReloadTime?: string;
474
+ /** The date and time when the app was modified. */
475
+ modifiedDate?: string;
476
+ /** App name. */
477
+ name?: string;
478
+ /** The Origin App ID for published apps. */
479
+ originAppId?: string;
480
+ /** Deprecated. Use user api to fetch user metadata. */
481
+ owner?: string;
482
+ /** Identifier of the app owner. */
483
+ ownerId?: string;
484
+ /** The date and time when the app was published, empty if unpublished. */
485
+ publishTime?: string;
486
+ /** True if the app is published on-prem, distributed in QCS, false if not. */
487
+ published?: boolean;
488
+ /** App thumbnail. */
489
+ thumbnail?: string;
490
+ /**
491
+ // One of:
492
+ // * ANALYTICS
493
+ // * DATA_PREPARATION */
494
+ usage?: "ANALYTICS" | "DATA_PREPARATION";
495
+ };
496
+ type NxObjectAttributes = {
497
+ /** True if the object is approved. */
498
+ approved?: boolean;
499
+ /** The date and time when the object was created. */
500
+ createdAt?: string;
501
+ /** Object description. */
502
+ description?: string;
503
+ /** The generic type of the object.
504
+ //
505
+ // One of:
506
+ // * genericObject
507
+ // * genericBookmark
508
+ // * genericMeasure
509
+ // * genericDimension
510
+ // * genericVariable */
511
+ genericType?: "genericObject" | "genericBookmark" | "genericMeasure" | "genericDimension" | "genericVariable";
512
+ /** The object Id. */
513
+ id?: string;
514
+ /** Object name. */
515
+ name?: string;
516
+ /** The type of the object. */
517
+ objectType?: string;
518
+ /** The object owner's Id. */
519
+ ownerId?: string;
520
+ /** The date and time when the object was published, empty if unpublished. */
521
+ publishedAt?: string;
522
+ /** The date and time when the object was modified. */
523
+ updatedAt?: string;
524
+ };
525
+ type NxPatch = {
526
+ /** Operation to perform.
527
+ //
528
+ // One of:
529
+ // * add or Add
530
+ // * remove or Remove
531
+ // * replace or Replace */
532
+ Op?: "Add" | "Remove" | "Replace";
533
+ /** Path to the property to add, remove or replace. */
534
+ Path?: string;
535
+ /** This parameter is not used in a remove operation.
536
+ // Corresponds to the value of the property to add or to the new value of the property to update.
537
+ // Examples:
538
+ // "false", "2", "\"New title\"" */
539
+ Value?: string;
540
+ };
541
+ type PartialNluInfo = {
542
+ /** Qlik sense application field selected for given token or phrase */
543
+ fieldName?: string;
544
+ /** Filter value found from query */
545
+ fieldValue?: string;
546
+ /** Role of the token or phrase from query */
547
+ role?: "dimension" | "measure" | "date";
548
+ /** Matching token or phrase from query */
549
+ text?: string;
550
+ /** Type of token from query */
551
+ type?: "field" | "filter" | "master_dimension" | "master_measure" | "custom_analysis";
552
+ };
553
+ type PublishApp = {
554
+ attributes?: AppUpdateAttributes;
555
+ /** The published app will have data from source or target app.
556
+ // The default is source.
557
+ //
558
+ // * source: Publish with source data
559
+ // * target: Publish with target data */
560
+ data?: "source" | "target";
561
+ /** The original is moved instead of copied. The current published state of all objects is kept. */
562
+ moveApp?: boolean;
563
+ /** If app is moved, originAppId needs to be provided. */
564
+ originAppId?: string;
565
+ /** The managed space ID where the app will be published. */
566
+ spaceId?: string;
567
+ };
568
+ type RecommendFieldItem = {
569
+ name?: string;
570
+ overrides?: FieldOverride;
571
+ };
572
+ type RecommendItems = {
573
+ fields?: RecommendFieldItem[];
574
+ libItems?: RecommendMasterItem[];
575
+ targetAnalysis?: {
576
+ /** id of the target analysis, returned by the GET insight-analyses endpoint */
577
+ id?: string;
578
+ };
579
+ };
580
+ type RecommendMasterItem = {
581
+ libId?: string;
582
+ overrides?: {
583
+ format?: NumberFormat;
584
+ };
585
+ };
586
+ type RecommendNaturalLangQuery = {
587
+ /** The NL query. */
588
+ text: string;
589
+ };
590
+ type RecommendedAnalysis = RecommendedAnalysisCore & {
591
+ /** part analyses (only for macro analyses) */
592
+ parts?: RecommendedAnalysisCore[];
593
+ };
594
+ type RecommendedAnalysisCore = {
595
+ analysis?: AnalysisDetails;
596
+ /** Chart type given to current recommendation */
597
+ chartType?: ChartType;
598
+ /** (chart options + hypercube definition) */
599
+ options?: unknown;
600
+ /** percentage of selected items in the analysis to the overall items passed to the endpoint */
601
+ relevance?: number;
602
+ };
603
+ type RepublishApp = {
604
+ attributes?: AppUpdateAttributes;
605
+ /** Validate that source app is same as originally published. */
606
+ checkOriginAppId?: boolean;
607
+ /** The republished app will have data from source or target app.
608
+ // The default is source.
609
+ //
610
+ // * source: Publish with source data
611
+ // * target: Publish with target data */
612
+ data?: "source" | "target";
613
+ /** The target ID to be republished. */
614
+ targetId?: string;
615
+ };
616
+ type ScriptLogList = {
617
+ /** Array of scriptLogMeta. */
618
+ data?: ScriptLogMeta[];
619
+ };
620
+ type ScriptLogMeta = {
621
+ /** Duration of reload (ms). */
622
+ duration?: number;
623
+ /** Time when reload ended. */
624
+ endTime?: string;
625
+ links?: Log;
626
+ /** Reload identifier. */
627
+ reloadId?: string;
628
+ /** True if the reload was successful. */
629
+ success?: boolean;
630
+ };
631
+ type ScriptMeta = {
632
+ /** Script version last modification time. */
633
+ modifiedTime?: string;
634
+ /** User last modifying script version. */
635
+ modifierId?: string;
636
+ /** Script id. */
637
+ scriptId?: string;
638
+ /** Script size. */
639
+ size?: number;
640
+ /** Description of this script version */
641
+ versionMessage?: string;
642
+ };
643
+ type ScriptMetaList = {
644
+ links?: NavigationLinks;
645
+ /** Script versions metadata. */
646
+ scripts?: ScriptMeta[];
647
+ };
648
+ type ScriptVersion = {
649
+ /** Script text. */
650
+ script?: string;
651
+ /** Description of this script version */
652
+ versionMessage?: string;
653
+ };
654
+ type SimplifiedClassifications = ("dimension" | "measure" | "temporal" | "geographical")[];
655
+ type SymbolFrequency = {
656
+ /** Frequency of the above symbol in the field */
657
+ Frequency?: number;
658
+ Symbol?: SymbolValue;
659
+ };
660
+ type SymbolValue = {
661
+ /** Numeric value of the symbol. NaN otherwise. */
662
+ Number?: number;
663
+ /** String value of the symbol. This parameter is optional and present only if Symbol is a string. */
664
+ Text?: string;
665
+ };
666
+ type TableMetadata = {
667
+ /** Static RAM memory used in bytes. */
668
+ byte_size?: number;
669
+ /** Table comment. */
670
+ comment?: string;
671
+ /** If set to true, the table is loose due to circular connection.
672
+ // The default value is false. */
673
+ is_loose?: boolean;
674
+ /** If set to true, the table is semantic.
675
+ // The default value is false. */
676
+ is_semantic?: boolean;
677
+ /** If set to true, the table is a system table.
678
+ // The default value is false. */
679
+ is_system?: boolean;
680
+ /** Name of the table. */
681
+ name?: string;
682
+ /** Number of fields. */
683
+ no_of_fields?: number;
684
+ /** Number of key fields. */
685
+ no_of_key_fields?: number;
686
+ /** Number of rows. */
687
+ no_of_rows?: number;
688
+ };
689
+ type TableProfilingData = {
690
+ /** Field values profiling info */
691
+ FieldProfiling?: FieldInTableProfilingData[];
692
+ /** Number of rows in the table. */
693
+ NoOfRows?: number;
694
+ };
695
+ type UpdateApp = {
696
+ attributes?: AppUpdateAttributes;
697
+ };
698
+ type UpdateOwner = {
699
+ ownerId?: string;
700
+ };
701
+ type UpdateSpace = {
702
+ spaceId?: string;
703
+ };
704
+ type Classification = {
705
+ absoluteDiff?: number;
706
+ diff?: number;
707
+ trend?: string;
708
+ };
709
+ type Cmpbool = Classification & {
710
+ baseline?: boolean;
711
+ comparison?: boolean;
712
+ };
713
+ type Cmpfloat = Classification & {
714
+ baseline?: number;
715
+ comparison?: number;
716
+ };
717
+ type Cmpint = Classification & {
718
+ baseline?: number;
719
+ comparison?: number;
720
+ };
721
+ type Comparison = {
722
+ appOpenTimeSeconds?: Cmpfloat;
723
+ dataModelSizeMib?: Cmpfloat;
724
+ documentSizeMib?: Cmpfloat;
725
+ fileSizeMib?: Cmpfloat;
726
+ hasSectionAccess?: Cmpbool;
727
+ maxMemoryMib?: Cmpfloat;
728
+ objHeavy?: Sortedcomparisonoobjheavy;
729
+ objNoCache?: Sortedcomparisonobjresponsetime;
730
+ objSingleThreaded?: Sortedcomparisonobjresponsetime;
731
+ objSlowCached?: Sortedcomparisonobjresponsetime;
732
+ objSlowUncached?: Sortedcomparisonobjresponsetime;
733
+ objectCount?: Cmpint;
734
+ rowCount?: Cmpint;
735
+ sheetCount?: Cmpint;
736
+ sheetsCached?: Sortedcomparisonobjresponsetime;
737
+ sheetsUncached?: Sortedcomparisonobjresponsetime;
738
+ topFieldsByBytes?: Sortedcomparisonfields;
739
+ topTablesByBytes?: Sortedcomparisontables;
740
+ };
741
+ type Comparisonfields = (Objecttopspec & {
742
+ byte_size?: Cmpint;
743
+ cardinal?: Cmpint;
744
+ dataSourceStatus?: "full" | "none" | "baselinemissing" | "comparisonmissing";
745
+ is_system?: Cmpbool;
746
+ name?: string;
747
+ total_count?: Cmpint;
748
+ })[];
749
+ type Comparisonobjresponsetime = (Objectspec & {
750
+ dataSourceStatus?: "full" | "none" | "baselinemissing" | "comparisonmissing";
751
+ responseTimeSeconds1?: Cmpfloat;
752
+ responseTimeSeconds2?: Cmpfloat;
753
+ })[];
754
+ type Comparisonoobjheavy = (Objectspec & {
755
+ cpuQuotient1?: Cmpfloat;
756
+ cpuQuotient2?: Cmpfloat;
757
+ cpuSeconds1?: Cmpfloat;
758
+ cpuSeconds2?: Cmpfloat;
759
+ dataSourceStatus?: "full" | "none" | "baselinemissing" | "comparisonmissing";
760
+ })[];
761
+ type Comparisontables = (Objecttopspec & {
762
+ byte_size?: Cmpint;
763
+ dataSourceStatus?: "full" | "none" | "baselinemissing" | "comparisonmissing";
764
+ is_system?: Cmpbool;
765
+ name?: string;
766
+ no_of_rows?: Cmpint;
767
+ })[];
768
+ type Evaluation = {
769
+ appId?: string;
770
+ appItemId?: string;
771
+ appName?: string;
772
+ details?: {
773
+ concurrentReload?: boolean;
774
+ dedicated?: boolean;
775
+ engineHasCache?: boolean;
776
+ errors?: string[];
777
+ objectMetrics?: unknown;
778
+ warnings?: string[];
779
+ };
780
+ ended?: string;
781
+ events?: Event[];
782
+ id?: string;
783
+ metadata?: Metadata;
784
+ result?: Result;
785
+ sheetId?: string;
786
+ sheetTitle?: string;
787
+ started?: string;
788
+ status?: string;
789
+ tenantId?: string;
790
+ timestamp?: string;
791
+ version?: number;
792
+ };
793
+ type Evaluations = {
794
+ data?: Evaluation[];
795
+ links?: {
796
+ next?: {
797
+ href?: Href;
798
+ };
799
+ prev?: {
800
+ href?: Href;
801
+ };
802
+ };
803
+ };
804
+ type Event = {
805
+ details?: string;
806
+ errorCode?: string;
807
+ objectId?: string;
808
+ objectTitle?: string;
809
+ objectType?: string;
810
+ objectVisualization?: string;
811
+ severity?: string;
812
+ sheetId?: string;
813
+ sheetTitle?: string;
814
+ };
815
+ type Metadata = {
816
+ amountofcardinalfieldvalues?: number;
817
+ amountoffields?: number;
818
+ amountoffieldvalues?: number;
819
+ amountofrows?: number;
820
+ amountoftables?: number;
821
+ hassectionaccess?: boolean;
822
+ reloadmeta?: {
823
+ cpuspent?: number;
824
+ peakmemorybytes?: number;
825
+ };
826
+ staticbytesize?: number;
827
+ };
828
+ type NumberFormat = {
829
+ qDec?: string;
830
+ qFmt?: string;
831
+ qThou?: string;
832
+ qType?: string;
833
+ qUseThou?: number;
834
+ qnDec?: number;
835
+ };
836
+ type Objectmetrics = {
837
+ cpuQuotients?: number[];
838
+ cpuSeconds?: number[];
839
+ responseTimeSeconds?: number;
840
+ };
841
+ type Objectspec = {
842
+ id?: string;
843
+ objectType?: number;
844
+ sheetId?: string;
845
+ title?: string;
846
+ };
847
+ type Objecttopspec = {
848
+ byte_size?: number;
849
+ is_system?: boolean;
850
+ name?: string;
851
+ };
852
+ type Result = {
853
+ documentSizeMiB?: number;
854
+ hasSectionAccess?: boolean;
855
+ objNoCache?: Resultobjresponsetime[];
856
+ objSingleThreaded?: Resultsingle[];
857
+ objSlowCached?: Resultobjsinglethreaded[];
858
+ objSlowUncached?: Resultobjresponsetime[];
859
+ objectCount?: number;
860
+ rowCount?: number;
861
+ sheetCount?: number;
862
+ sheets?: Resultobjsheet[];
863
+ topFieldsByBytes?: Resultmetadatatopfields[];
864
+ topTablesByBytes?: Resultmetadatatoptables[];
865
+ };
866
+ type Resultentry = Objectspec & {
867
+ passes?: Objectmetrics[];
868
+ };
869
+ type Resultmetadatatopfields = Objecttopspec & {
870
+ byte_size?: number;
871
+ name?: string;
872
+ };
873
+ type Resultmetadatatoptables = Objecttopspec & {
874
+ byte_size?: number;
875
+ name?: string;
876
+ };
877
+ type Resultobjresponsetime = Objectspec & {
878
+ responseTimeSeconds?: number;
879
+ };
880
+ type Resultobjsheet = {
881
+ objectCount?: number;
882
+ sheet?: Resultobjresponsetime;
883
+ sheetObjects?: Resultobjresponsetime[];
884
+ };
885
+ type Resultobjsinglethreaded = Objectspec & {
886
+ cpuQuotients?: number[];
887
+ responseTimeSeconds?: number;
888
+ schema?: Objectspec;
889
+ };
890
+ type Resultsingle = Objectspec & {
891
+ cpuQuotient1?: number;
892
+ };
893
+ type Sortedcomparisonfields = {
894
+ absoluteDiffAsc?: Comparisonfields;
895
+ absoluteDiffDesc?: Comparisonfields;
896
+ dataSourceStatus?: "full" | "none" | "baselinemissing" | "comparisonmissing";
897
+ list?: Comparisonfields;
898
+ relativeDiffAsc?: Comparisonfields;
899
+ relativeDiffDesc?: Comparisonfields;
900
+ };
901
+ type Sortedcomparisonobjresponsetime = {
902
+ absoluteDiffAsc?: Comparisonobjresponsetime;
903
+ absoluteDiffDesc?: Comparisonobjresponsetime;
904
+ dataSourceStatus?: "full" | "none" | "baselinemissing" | "comparisonmissing";
905
+ list?: Comparisonobjresponsetime;
906
+ relativeDiffAsc?: Comparisonobjresponsetime;
907
+ relativeDiffDesc?: Comparisonobjresponsetime;
908
+ };
909
+ type Sortedcomparisonoobjheavy = {
910
+ absoluteDiffAsc?: Comparisonoobjheavy;
911
+ absoluteDiffDesc?: Comparisonoobjheavy;
912
+ dataSourceStatus?: "full" | "none" | "baselinemissing" | "comparisonmissing";
913
+ list?: Comparisonoobjheavy;
914
+ relativeDiffAsc?: Comparisonoobjheavy;
915
+ relativeDiffDesc?: Comparisonoobjheavy;
916
+ };
917
+ type Sortedcomparisontables = {
918
+ absoluteDiffAsc?: Comparisontables;
919
+ absoluteDiffDesc?: Comparisontables;
920
+ dataSourceStatus?: "full" | "none" | "baselinemissing" | "comparisonmissing";
921
+ list?: Comparisontables;
922
+ relativeDiffAsc?: Comparisontables;
923
+ relativeDiffDesc?: Comparisontables;
924
+ };
925
+ /**
926
+ * Creates a new app.
927
+ * @param body an object with the body content
928
+ * @throws CreateAppHttpError
929
+ */
930
+ declare const createApp: (body: CreateApp, options?: ApiCallOptions) => Promise<CreateAppHttpResponse>;
931
+ type CreateAppHttpResponse = {
932
+ data: NxApp;
933
+ headers: Headers;
934
+ status: number;
935
+ };
936
+ type CreateAppHttpError = {
937
+ data: unknown;
938
+ headers: Headers;
939
+ status: number;
940
+ };
941
+ /**
942
+ * Accepts two evaluation ids and returns a comparison denoting the differences between the two.
943
+ *
944
+ * @param baseid Id of the baseline evaluation
945
+ * @param comparisonid Id of the comparison evaluation
946
+ * @param query an object with query parameters
947
+ * @throws GetAppEvaluationComparisonHttpError
948
+ */
949
+ declare const getAppEvaluationComparison: (baseid: string, comparisonid: string, query: {
950
+ /** Get the full list of comparisons including non-significant diffs */
951
+ all?: boolean;
952
+ /** Specify output format, currently supported are 'json' and 'xml' */
953
+ format?: string;
954
+ }, options?: ApiCallOptions) => Promise<GetAppEvaluationComparisonHttpResponse>;
955
+ type GetAppEvaluationComparisonHttpResponse = {
956
+ data: Comparison;
957
+ headers: Headers;
958
+ status: number;
959
+ };
960
+ type GetAppEvaluationComparisonHttpError = {
961
+ data: EvaluatorError;
962
+ headers: Headers;
963
+ status: number;
964
+ };
965
+ /**
966
+ * Accepts two evaluation ids and downloads a log, in XML format, denoting the differences between the two.
967
+ *
968
+ * @param baseid Id of the baseline evaluation
969
+ * @param comparisonid Id of the comparison evaluation
970
+ * @throws GetAppEvaluationComparisonXMLHttpError
971
+ */
972
+ declare const getAppEvaluationComparisonXML: (baseid: string, comparisonid: string, options?: ApiCallOptions) => Promise<GetAppEvaluationComparisonXMLHttpResponse>;
973
+ type GetAppEvaluationComparisonXMLHttpResponse = {
974
+ data: Comparison;
975
+ headers: Headers;
976
+ status: number;
977
+ };
978
+ type GetAppEvaluationComparisonXMLHttpError = {
979
+ data: EvaluatorError;
980
+ headers: Headers;
981
+ status: number;
982
+ };
983
+ /**
984
+ * Find an evaluation by a specific id.
985
+ *
986
+ * @param id Id of the desired evaluation.
987
+ * @param query an object with query parameters
988
+ * @throws GetAppEvaluationHttpError
989
+ */
990
+ declare const getAppEvaluation: (id: string, query: {
991
+ /** Get the full data of the evaluation */
992
+ all?: boolean;
993
+ /** Specify output format, currently supported are 'json' and 'xml' */
994
+ format?: string;
995
+ }, options?: ApiCallOptions) => Promise<GetAppEvaluationHttpResponse>;
996
+ type GetAppEvaluationHttpResponse = {
997
+ data: Evaluation;
998
+ headers: Headers;
999
+ status: number;
1000
+ };
1001
+ type GetAppEvaluationHttpError = {
1002
+ data: EvaluatorError;
1003
+ headers: Headers;
1004
+ status: number;
1005
+ };
1006
+ /**
1007
+ * Find and download an evaluation log by a specific evaluation id.
1008
+ *
1009
+ * @param id Id of the desired evaluation.
1010
+ * @throws GetAppEvaluationXMLHttpError
1011
+ */
1012
+ declare const getAppEvaluationXML: (id: string, options?: ApiCallOptions) => Promise<GetAppEvaluationXMLHttpResponse>;
1013
+ type GetAppEvaluationXMLHttpResponse = {
1014
+ data: Evaluation;
1015
+ headers: Headers;
1016
+ status: number;
1017
+ };
1018
+ type GetAppEvaluationXMLHttpError = {
1019
+ data: EvaluatorError;
1020
+ headers: Headers;
1021
+ status: number;
1022
+ };
1023
+ /**
1024
+ * Imports an app into the system.
1025
+ * @param query an object with query parameters
1026
+ * @param body an object with the body content
1027
+ * @throws ImportAppHttpError
1028
+ */
1029
+ declare const importApp: (query: {
1030
+ /** 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. */
1031
+ NoData?: boolean;
1032
+ /** The app ID of the target app when source is qvw file. */
1033
+ appId?: string;
1034
+ /** The name of the target app when source does not have a specified name, applicable if source is qvw file. */
1035
+ fallbackName?: string;
1036
+ /** The file ID to be downloaded from Temporary Content Service (TCS) and used during import. */
1037
+ fileId?: string;
1038
+ /** 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>
1039
+ //
1040
+ // One of:
1041
+ // * NEW
1042
+ // * AUTOREPLACE */
1043
+ mode?: string;
1044
+ /** The name of the target app. */
1045
+ name?: string;
1046
+ /** The space ID of the target app. */
1047
+ spaceId?: string;
1048
+ }, body: unknown, options?: ApiCallOptions) => Promise<ImportAppHttpResponse>;
1049
+ type ImportAppHttpResponse = {
1050
+ data: NxApp;
1051
+ headers: Headers;
1052
+ status: number;
1053
+ };
1054
+ type ImportAppHttpError = {
1055
+ data: void;
1056
+ headers: Headers;
1057
+ status: number;
1058
+ };
1059
+ /**
1060
+ * 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.
1061
+ * @throws GetAppPrivilegesHttpError
1062
+ */
1063
+ declare const getAppPrivileges: (options?: ApiCallOptions) => Promise<GetAppPrivilegesHttpResponse>;
1064
+ type GetAppPrivilegesHttpResponse = {
1065
+ data: string[];
1066
+ headers: Headers;
1067
+ status: number;
1068
+ };
1069
+ type GetAppPrivilegesHttpError = {
1070
+ data: unknown;
1071
+ headers: Headers;
1072
+ status: number;
1073
+ };
1074
+ /**
1075
+ * Deletes a specific app.
1076
+ * @param appId Identifier of the app.
1077
+ * @throws DeleteAppHttpError
1078
+ */
1079
+ declare const deleteApp: (appId: string, options?: ApiCallOptions) => Promise<DeleteAppHttpResponse>;
1080
+ type DeleteAppHttpResponse = {
1081
+ data: void;
1082
+ headers: Headers;
1083
+ status: number;
1084
+ };
1085
+ type DeleteAppHttpError = {
1086
+ data: unknown;
1087
+ headers: Headers;
1088
+ status: number;
1089
+ };
1090
+ /**
1091
+ * Retrieves information for a specific app.
1092
+ * @param appId Identifier of the app.
1093
+ * @throws GetAppInfoHttpError
1094
+ */
1095
+ declare const getAppInfo: (appId: string, options?: ApiCallOptions) => Promise<GetAppInfoHttpResponse>;
1096
+ type GetAppInfoHttpResponse = {
1097
+ data: NxApp;
1098
+ headers: Headers;
1099
+ status: number;
1100
+ };
1101
+ type GetAppInfoHttpError = {
1102
+ data: unknown;
1103
+ headers: Headers;
1104
+ status: number;
1105
+ };
1106
+ /**
1107
+ * Updates the information for a specific app.
1108
+ * @param appId Identifier of the app.
1109
+ * @param body an object with the body content
1110
+ * @throws UpdateAppInfoHttpError
1111
+ */
1112
+ declare const updateAppInfo: (appId: string, body: UpdateApp, options?: ApiCallOptions) => Promise<UpdateAppInfoHttpResponse>;
1113
+ type UpdateAppInfoHttpResponse = {
1114
+ data: NxApp;
1115
+ headers: Headers;
1116
+ status: number;
1117
+ };
1118
+ type UpdateAppInfoHttpError = {
1119
+ data: unknown;
1120
+ headers: Headers;
1121
+ status: number;
1122
+ };
1123
+ /**
1124
+ * Copies a specific app.
1125
+ * @param appId Identifier of the app.
1126
+ * @param body an object with the body content
1127
+ * @throws CopyAppHttpError
1128
+ */
1129
+ declare const copyApp: (appId: string, body: CreateApp, options?: ApiCallOptions) => Promise<CopyAppHttpResponse>;
1130
+ type CopyAppHttpResponse = {
1131
+ data: NxApp;
1132
+ headers: Headers;
1133
+ status: number;
1134
+ };
1135
+ type CopyAppHttpError = {
1136
+ data: unknown;
1137
+ headers: Headers;
1138
+ status: number;
1139
+ };
1140
+ /**
1141
+ * Retrieves the lineage for an app.
1142
+ * Returns a JSON-formatted array of strings describing the lineage of the app.
1143
+ * @param appId Identifier of the app.
1144
+ * @throws GetAppDataLineageHttpError
1145
+ */
1146
+ declare const getAppDataLineage: (appId: string, options?: ApiCallOptions) => Promise<GetAppDataLineageHttpResponse>;
1147
+ type GetAppDataLineageHttpResponse = {
1148
+ data: LineageInfoRest[];
1149
+ headers: Headers;
1150
+ status: number;
1151
+ };
1152
+ type GetAppDataLineageHttpError = {
1153
+ data: unknown;
1154
+ headers: Headers;
1155
+ status: number;
1156
+ };
1157
+ /**
1158
+ * Retrieves the data model and reload statistics metadata of an app.
1159
+ * An empty metadata structure is returned if the metadata is not available in the app.
1160
+ * @param appId Identifier of the app.
1161
+ * @throws GetAppDataMetadataHttpError
1162
+ */
1163
+ declare const getAppDataMetadata: (appId: string, options?: ApiCallOptions) => Promise<GetAppDataMetadataHttpResponse>;
1164
+ type GetAppDataMetadataHttpResponse = {
1165
+ data: DataModelMetadata;
1166
+ headers: Headers;
1167
+ status: number;
1168
+ };
1169
+ type GetAppDataMetadataHttpError = {
1170
+ data: unknown;
1171
+ headers: Headers;
1172
+ status: number;
1173
+ };
1174
+ /**
1175
+ * Exports a specific app.
1176
+ * @param appId Identifier of the app.
1177
+ * @param query an object with query parameters
1178
+ * @throws ExportAppHttpError
1179
+ */
1180
+ declare const exportApp: (appId: string, query: {
1181
+ /** The flag indicating if only object contents should be exported. */
1182
+ NoData?: boolean;
1183
+ }, options?: ApiCallOptions) => Promise<ExportAppHttpResponse>;
1184
+ type ExportAppHttpResponse = {
1185
+ data: void;
1186
+ headers: Headers;
1187
+ status: number;
1188
+ };
1189
+ type ExportAppHttpError = {
1190
+ data: void;
1191
+ headers: Headers;
1192
+ status: number;
1193
+ };
1194
+ /**
1195
+ * 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.
1196
+ * @param appId Qlik Sense app identifier
1197
+ * @throws GetAppInsightAnalysesHttpError
1198
+ */
1199
+ declare const getAppInsightAnalyses: (appId: string, options?: ApiCallOptions) => Promise<GetAppInsightAnalysesHttpResponse>;
1200
+ type GetAppInsightAnalysesHttpResponse = {
1201
+ data: AnalysisDescriptorResponse;
1202
+ headers: Headers;
1203
+ status: number;
1204
+ prev?: (options?: ApiCallOptions) => Promise<GetAppInsightAnalysesHttpResponse>;
1205
+ next?: (options?: ApiCallOptions) => Promise<GetAppInsightAnalysesHttpResponse>;
1206
+ };
1207
+ type GetAppInsightAnalysesHttpError = {
1208
+ data: Errors;
1209
+ headers: Headers;
1210
+ status: number;
1211
+ };
1212
+ /**
1213
+ * 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.
1214
+ * @param appId Qlik Sense app identifier
1215
+ * @param body an object with the body content
1216
+ * @throws GetAppInsightAnalysisRecommendationsHttpError
1217
+ */
1218
+ declare const getAppInsightAnalysisRecommendations: (appId: string, body: AnalysisRecommendRequest, options?: ApiCallOptions) => Promise<GetAppInsightAnalysisRecommendationsHttpResponse>;
1219
+ type GetAppInsightAnalysisRecommendationsHttpResponse = {
1220
+ data: AnalysisRecommendationResponse;
1221
+ headers: Headers;
1222
+ status: number;
1223
+ };
1224
+ type GetAppInsightAnalysisRecommendationsHttpError = {
1225
+ data: Errors;
1226
+ headers: Headers;
1227
+ status: number;
1228
+ };
1229
+ /**
1230
+ * 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.
1231
+ * @param appId Qlik Sense app identifier
1232
+ * @throws GetAppInsightAnalysisModelHttpError
1233
+ */
1234
+ declare const getAppInsightAnalysisModel: (appId: string, options?: ApiCallOptions) => Promise<GetAppInsightAnalysisModelHttpResponse>;
1235
+ type GetAppInsightAnalysisModelHttpResponse = {
1236
+ data: AnalysisModelResponse;
1237
+ headers: Headers;
1238
+ status: number;
1239
+ prev?: (options?: ApiCallOptions) => Promise<GetAppInsightAnalysisModelHttpResponse>;
1240
+ next?: (options?: ApiCallOptions) => Promise<GetAppInsightAnalysisModelHttpResponse>;
1241
+ };
1242
+ type GetAppInsightAnalysisModelHttpError = {
1243
+ data: Errors;
1244
+ headers: Headers;
1245
+ status: number;
1246
+ };
1247
+ /**
1248
+ * Deletes a media content file or complete directory.
1249
+ * 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.
1250
+ * @param appId Unique application identifier.
1251
+ * @param path Path to file content.
1252
+ * @throws DeleteAppMediaHttpError
1253
+ */
1254
+ declare const deleteAppMedia: (appId: string, path: string, options?: ApiCallOptions) => Promise<DeleteAppMediaHttpResponse>;
1255
+ type DeleteAppMediaHttpResponse = {
1256
+ data: void;
1257
+ headers: Headers;
1258
+ status: number;
1259
+ };
1260
+ type DeleteAppMediaHttpError = {
1261
+ data: void;
1262
+ headers: Headers;
1263
+ status: number;
1264
+ };
1265
+ /**
1266
+ * Gets media content from file.
1267
+ * Returns a stream of bytes containing the media file content on success, or error if file is not found.
1268
+ * @param appId Unique application identifier.
1269
+ * @param path Path to file content.
1270
+ * @throws GetAppMediaHttpError
1271
+ */
1272
+ declare const getAppMedia: (appId: string, path: string, options?: ApiCallOptions) => Promise<GetAppMediaHttpResponse>;
1273
+ type GetAppMediaHttpResponse = {
1274
+ data: void;
1275
+ headers: Headers;
1276
+ status: number;
1277
+ };
1278
+ type GetAppMediaHttpError = {
1279
+ data: void;
1280
+ headers: Headers;
1281
+ status: number;
1282
+ };
1283
+ /**
1284
+ * Stores the media content file.
1285
+ * 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.
1286
+ * @param appId Unique application identifier.
1287
+ * @param path Path to file content.
1288
+ * @param body an object with the body content
1289
+ * @throws UploadAppMediaHttpError
1290
+ */
1291
+ declare const uploadAppMedia: (appId: string, path: string, body: unknown, options?: ApiCallOptions) => Promise<UploadAppMediaHttpResponse>;
1292
+ type UploadAppMediaHttpResponse = {
1293
+ data: void;
1294
+ headers: Headers;
1295
+ status: number;
1296
+ };
1297
+ type UploadAppMediaHttpError = {
1298
+ data: void;
1299
+ headers: Headers;
1300
+ status: number;
1301
+ };
1302
+ /**
1303
+ * Lists media content.
1304
+ * Returns a JSON formatted array of strings describing the available media content or error if the optional path supplied is not found.
1305
+ * @param appId Unique application identifier.
1306
+ * @param path The path to sub folder with static content relative to the root folder. Use empty path to access the root folder.
1307
+ * @param query an object with query parameters
1308
+ * @throws GetAppMediaListHttpError
1309
+ */
1310
+ declare const getAppMediaList: (appId: string, path: string, query: {
1311
+ /** Optional. List output can include files and folders in different ways:
1312
+ // * 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.
1313
+ // * Recursive(r), use ?show=r or ?show=recursive, results in a recursive output with files, all empty folders are excluded.
1314
+ // * All(a), use ?show=a or ?show=all, results in a recursive output with files and empty directories. */
1315
+ show?: string;
1316
+ }, options?: ApiCallOptions) => Promise<GetAppMediaListHttpResponse>;
1317
+ type GetAppMediaListHttpResponse = {
1318
+ data: AppContentList;
1319
+ headers: Headers;
1320
+ status: number;
1321
+ };
1322
+ type GetAppMediaListHttpError = {
1323
+ data: void;
1324
+ headers: Headers;
1325
+ status: number;
1326
+ };
1327
+ /**
1328
+ * Gets media content from file currently used as application thumbnail.
1329
+ * Returns a stream of bytes containing the media file content on success, or error if file is not found.
1330
+ * The image selected as thumbnail is only updated when application is saved.
1331
+ * @param appId Unique application identifier.
1332
+ * @throws GetAppThumbnailHttpError
1333
+ */
1334
+ declare const getAppThumbnail: (appId: string, options?: ApiCallOptions) => Promise<GetAppThumbnailHttpResponse>;
1335
+ type GetAppThumbnailHttpResponse = {
1336
+ data: void;
1337
+ headers: Headers;
1338
+ status: number;
1339
+ };
1340
+ type GetAppThumbnailHttpError = {
1341
+ data: void;
1342
+ headers: Headers;
1343
+ status: number;
1344
+ };
1345
+ /**
1346
+ * Sets owner on an app object.
1347
+ * @param appId Identifier of the app.
1348
+ * @param objectId Identifier of the object.
1349
+ * @param body an object with the body content
1350
+ * @throws UpdateAppObjectOwnerHttpError
1351
+ */
1352
+ declare const updateAppObjectOwner: (appId: string, objectId: string, body: UpdateOwner, options?: ApiCallOptions) => Promise<UpdateAppObjectOwnerHttpResponse>;
1353
+ type UpdateAppObjectOwnerHttpResponse = {
1354
+ data: NxAppObject;
1355
+ headers: Headers;
1356
+ status: number;
1357
+ };
1358
+ type UpdateAppObjectOwnerHttpError = {
1359
+ data: void;
1360
+ headers: Headers;
1361
+ status: number;
1362
+ };
1363
+ /**
1364
+ * Changes owner of the app.
1365
+ * @param appId Identifier of the app.
1366
+ * @param body an object with the body content
1367
+ * @throws UpdateAppOwnerHttpError
1368
+ */
1369
+ declare const updateAppOwner: (appId: string, body: UpdateOwner, options?: ApiCallOptions) => Promise<UpdateAppOwnerHttpResponse>;
1370
+ type UpdateAppOwnerHttpResponse = {
1371
+ data: NxApp;
1372
+ headers: Headers;
1373
+ status: number;
1374
+ };
1375
+ type UpdateAppOwnerHttpError = {
1376
+ data: void;
1377
+ headers: Headers;
1378
+ status: number;
1379
+ };
1380
+ /**
1381
+ * Publishes a specific app to a managed space.
1382
+ * @param appId Identifier of the app.
1383
+ * @param body an object with the body content
1384
+ * @throws PublishAppHttpError
1385
+ */
1386
+ declare const publishApp: (appId: string, body: PublishApp, options?: ApiCallOptions) => Promise<PublishAppHttpResponse>;
1387
+ type PublishAppHttpResponse = {
1388
+ data: NxApp;
1389
+ headers: Headers;
1390
+ status: number;
1391
+ };
1392
+ type PublishAppHttpError = {
1393
+ data: unknown;
1394
+ headers: Headers;
1395
+ status: number;
1396
+ };
1397
+ /**
1398
+ * Republishes a published app to a managed space.
1399
+ * @param appId Identifier of the app.
1400
+ * @param body an object with the body content
1401
+ * @throws RepublishAppHttpError
1402
+ */
1403
+ declare const republishApp: (appId: string, body: RepublishApp, options?: ApiCallOptions) => Promise<RepublishAppHttpResponse>;
1404
+ type RepublishAppHttpResponse = {
1405
+ data: NxApp;
1406
+ headers: Headers;
1407
+ status: number;
1408
+ };
1409
+ type RepublishAppHttpError = {
1410
+ data: unknown;
1411
+ headers: Headers;
1412
+ status: number;
1413
+ };
1414
+ /**
1415
+ * Retrieves the metadata about all script logs stored for an app.
1416
+ * Returns an array of ScriptLogMeta objects.
1417
+ * @param appId Identifier of the app.
1418
+ * @throws GetAppReloadLogsHttpError
1419
+ */
1420
+ declare const getAppReloadLogs: (appId: string, options?: ApiCallOptions) => Promise<GetAppReloadLogsHttpResponse>;
1421
+ type GetAppReloadLogsHttpResponse = {
1422
+ data: ScriptLogList;
1423
+ headers: Headers;
1424
+ status: number;
1425
+ };
1426
+ type GetAppReloadLogsHttpError = {
1427
+ data: unknown;
1428
+ headers: Headers;
1429
+ status: number;
1430
+ };
1431
+ /**
1432
+ * Retrieves the log of a specific reload.
1433
+ * Returns the log as "text/plain; charset=UTF-8".
1434
+ * @param appId Identifier of the app.
1435
+ * @param reloadId Identifier of the reload.
1436
+ * @throws GetAppReloadLogHttpError
1437
+ */
1438
+ declare const getAppReloadLog: (appId: string, reloadId: string, options?: ApiCallOptions) => Promise<GetAppReloadLogHttpResponse>;
1439
+ type GetAppReloadLogHttpResponse = {
1440
+ data: void;
1441
+ headers: Headers;
1442
+ status: number;
1443
+ };
1444
+ type GetAppReloadLogHttpError = {
1445
+ data: unknown;
1446
+ headers: Headers;
1447
+ status: number;
1448
+ };
1449
+ /**
1450
+ * Retrieves the script history for an app.
1451
+ * Returns information about the saved versions of the script.
1452
+ * @param appId Identifier of the app.
1453
+ * @param query an object with query parameters
1454
+ * @throws GetAppScriptHistoryHttpError
1455
+ */
1456
+ declare const getAppScriptHistory: (appId: string, query: {
1457
+ /** A scim filter expression defining which script versions should be retrieved. Filterable fields are:
1458
+ // * ScriptId
1459
+ // * ModifiedTime
1460
+ // * ModifierId */
1461
+ filter?: string;
1462
+ /** Maximum number of records to return from this request. */
1463
+ limit?: string;
1464
+ /** Opaque definition of which page of the result set to return. Returned from a previous call using the same filter. Not yet supported. */
1465
+ page?: string;
1466
+ }, options?: ApiCallOptions) => Promise<GetAppScriptHistoryHttpResponse>;
1467
+ type GetAppScriptHistoryHttpResponse = {
1468
+ data: ScriptMetaList;
1469
+ headers: Headers;
1470
+ status: number;
1471
+ prev?: (options?: ApiCallOptions) => Promise<GetAppScriptHistoryHttpResponse>;
1472
+ next?: (options?: ApiCallOptions) => Promise<GetAppScriptHistoryHttpResponse>;
1473
+ };
1474
+ type GetAppScriptHistoryHttpError = {
1475
+ data: unknown;
1476
+ headers: Headers;
1477
+ status: number;
1478
+ };
1479
+ /**
1480
+ * Sets script for an app.
1481
+ * @param appId Identifier of the app.
1482
+ * @param body an object with the body content
1483
+ * @throws UpdateAppScriptHttpError
1484
+ */
1485
+ declare const updateAppScript: (appId: string, body: ScriptVersion, options?: ApiCallOptions) => Promise<UpdateAppScriptHttpResponse>;
1486
+ type UpdateAppScriptHttpResponse = {
1487
+ data: void;
1488
+ headers: Headers;
1489
+ status: number;
1490
+ };
1491
+ type UpdateAppScriptHttpError = {
1492
+ data: unknown;
1493
+ headers: Headers;
1494
+ status: number;
1495
+ };
1496
+ /**
1497
+ * Deletes a specific version of the script for an app.
1498
+ * Fails if the version to delete is the current version.
1499
+ * @param appId Identifier of the app.
1500
+ * @param version Identifier of the script version
1501
+ * @throws DeleteAppScriptHttpError
1502
+ */
1503
+ declare const deleteAppScript: (appId: string, version: string, options?: ApiCallOptions) => Promise<DeleteAppScriptHttpResponse>;
1504
+ type DeleteAppScriptHttpResponse = {
1505
+ data: void;
1506
+ headers: Headers;
1507
+ status: number;
1508
+ };
1509
+ type DeleteAppScriptHttpError = {
1510
+ data: unknown;
1511
+ headers: Headers;
1512
+ status: number;
1513
+ };
1514
+ /**
1515
+ * Retrieves a version of the script for an app.
1516
+ * Returns the script text.
1517
+ * @param appId Identifier of the app.
1518
+ * @param version Identifier of the script version, or 'current' for retrieving the current version.
1519
+ * @throws GetAppScriptHttpError
1520
+ */
1521
+ declare const getAppScript: (appId: string, version: string, options?: ApiCallOptions) => Promise<GetAppScriptHttpResponse>;
1522
+ type GetAppScriptHttpResponse = {
1523
+ data: ScriptVersion;
1524
+ headers: Headers;
1525
+ status: number;
1526
+ };
1527
+ type GetAppScriptHttpError = {
1528
+ data: unknown;
1529
+ headers: Headers;
1530
+ status: number;
1531
+ };
1532
+ /**
1533
+ * Updates a specific version of the script for an app.
1534
+ * @param appId Identifier of the app.
1535
+ * @param version Identifier of the script version.
1536
+ * @param body an object with the body content
1537
+ * @throws PatchAppScriptHttpError
1538
+ */
1539
+ declare const patchAppScript: (appId: string, version: string, body: NxPatch, options?: ApiCallOptions) => Promise<PatchAppScriptHttpResponse>;
1540
+ type PatchAppScriptHttpResponse = {
1541
+ data: void;
1542
+ headers: Headers;
1543
+ status: number;
1544
+ };
1545
+ type PatchAppScriptHttpError = {
1546
+ data: unknown;
1547
+ headers: Headers;
1548
+ status: number;
1549
+ };
1550
+ /**
1551
+ * Removes space from a specific app.
1552
+ * @param appId Identifier of the app.
1553
+ * @throws RemoveAppFromSpaceHttpError
1554
+ */
1555
+ declare const removeAppFromSpace: (appId: string, options?: ApiCallOptions) => Promise<RemoveAppFromSpaceHttpResponse>;
1556
+ type RemoveAppFromSpaceHttpResponse = {
1557
+ data: NxApp;
1558
+ headers: Headers;
1559
+ status: number;
1560
+ };
1561
+ type RemoveAppFromSpaceHttpError = {
1562
+ data: unknown;
1563
+ headers: Headers;
1564
+ status: number;
1565
+ };
1566
+ /**
1567
+ * Sets space on a specific app.
1568
+ * @param appId Identifier of the app.
1569
+ * @param body an object with the body content
1570
+ * @throws MoveAppToSpaceHttpError
1571
+ */
1572
+ declare const moveAppToSpace: (appId: string, body: UpdateSpace, options?: ApiCallOptions) => Promise<MoveAppToSpaceHttpResponse>;
1573
+ type MoveAppToSpaceHttpResponse = {
1574
+ data: NxApp;
1575
+ headers: Headers;
1576
+ status: number;
1577
+ };
1578
+ type MoveAppToSpaceHttpError = {
1579
+ data: unknown;
1580
+ headers: Headers;
1581
+ status: number;
1582
+ };
1583
+ /**
1584
+ * Find all evaluations for an app GUID.
1585
+ * Supports paging via next, prev which are sent in the response body
1586
+ *
1587
+ * @param guid The app guid.
1588
+ * @param query an object with query parameters
1589
+ * @throws GetAppEvaluationsHttpError
1590
+ */
1591
+ declare const getAppEvaluations: (guid: string, query: {
1592
+ /** Get the full data of the evaluation */
1593
+ all?: boolean;
1594
+ /** Add file transfer headers to response */
1595
+ fileMode?: boolean;
1596
+ /** Specify output format, currently supported are 'json' and 'xml' */
1597
+ format?: string;
1598
+ /** Number of results to return per page. */
1599
+ limit?: number;
1600
+ /** The app evaluation id to get next page from */
1601
+ next?: string;
1602
+ /** The app evaluation id to get previous page from */
1603
+ prev?: string;
1604
+ /** Property to sort list on */
1605
+ sort?: string;
1606
+ }, options?: ApiCallOptions) => Promise<GetAppEvaluationsHttpResponse>;
1607
+ type GetAppEvaluationsHttpResponse = {
1608
+ data: Evaluations;
1609
+ headers: Headers;
1610
+ status: number;
1611
+ prev?: (options?: ApiCallOptions) => Promise<GetAppEvaluationsHttpResponse>;
1612
+ next?: (options?: ApiCallOptions) => Promise<GetAppEvaluationsHttpResponse>;
1613
+ };
1614
+ type GetAppEvaluationsHttpError = {
1615
+ data: EvaluatorError;
1616
+ headers: Headers;
1617
+ status: number;
1618
+ };
1619
+ /**
1620
+ * Queue an app evaluation by its app guid.
1621
+ *
1622
+ * @param guid Guid of the app.
1623
+ * @throws QueueAppEvaluationHttpError
1624
+ */
1625
+ declare const queueAppEvaluation: (guid: string, options?: ApiCallOptions) => Promise<QueueAppEvaluationHttpResponse>;
1626
+ type QueueAppEvaluationHttpResponse = {
1627
+ data: Evaluation;
1628
+ headers: Headers;
1629
+ status: number;
1630
+ };
1631
+ type QueueAppEvaluationHttpError = {
1632
+ data: EvaluatorError;
1633
+ headers: Headers;
1634
+ status: number;
1635
+ };
1636
+ /**
1637
+ * Clears the cache for apps api requests.
1638
+ */
1639
+ declare function clearCache(): void;
1640
+ interface AppsAPI {
1641
+ /**
1642
+ * Creates a new app.
1643
+ * @param body an object with the body content
1644
+ * @throws CreateAppHttpError
1645
+ */
1646
+ createApp: typeof createApp;
1647
+ /**
1648
+ * Accepts two evaluation ids and returns a comparison denoting the differences between the two.
1649
+ *
1650
+ * @param baseid Id of the baseline evaluation
1651
+ * @param comparisonid Id of the comparison evaluation
1652
+ * @param query an object with query parameters
1653
+ * @throws GetAppEvaluationComparisonHttpError
1654
+ */
1655
+ getAppEvaluationComparison: typeof getAppEvaluationComparison;
1656
+ /**
1657
+ * Accepts two evaluation ids and downloads a log, in XML format, denoting the differences between the two.
1658
+ *
1659
+ * @param baseid Id of the baseline evaluation
1660
+ * @param comparisonid Id of the comparison evaluation
1661
+ * @throws GetAppEvaluationComparisonXMLHttpError
1662
+ */
1663
+ getAppEvaluationComparisonXML: typeof getAppEvaluationComparisonXML;
1664
+ /**
1665
+ * Find an evaluation by a specific id.
1666
+ *
1667
+ * @param id Id of the desired evaluation.
1668
+ * @param query an object with query parameters
1669
+ * @throws GetAppEvaluationHttpError
1670
+ */
1671
+ getAppEvaluation: typeof getAppEvaluation;
1672
+ /**
1673
+ * Find and download an evaluation log by a specific evaluation id.
1674
+ *
1675
+ * @param id Id of the desired evaluation.
1676
+ * @throws GetAppEvaluationXMLHttpError
1677
+ */
1678
+ getAppEvaluationXML: typeof getAppEvaluationXML;
1679
+ /**
1680
+ * Imports an app into the system.
1681
+ * @param query an object with query parameters
1682
+ * @param body an object with the body content
1683
+ * @throws ImportAppHttpError
1684
+ */
1685
+ importApp: typeof importApp;
1686
+ /**
1687
+ * 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.
1688
+ * @throws GetAppPrivilegesHttpError
1689
+ */
1690
+ getAppPrivileges: typeof getAppPrivileges;
1691
+ /**
1692
+ * Deletes a specific app.
1693
+ * @param appId Identifier of the app.
1694
+ * @throws DeleteAppHttpError
1695
+ */
1696
+ deleteApp: typeof deleteApp;
1697
+ /**
1698
+ * Retrieves information for a specific app.
1699
+ * @param appId Identifier of the app.
1700
+ * @throws GetAppInfoHttpError
1701
+ */
1702
+ getAppInfo: typeof getAppInfo;
1703
+ /**
1704
+ * Updates the information for a specific app.
1705
+ * @param appId Identifier of the app.
1706
+ * @param body an object with the body content
1707
+ * @throws UpdateAppInfoHttpError
1708
+ */
1709
+ updateAppInfo: typeof updateAppInfo;
1710
+ /**
1711
+ * Copies a specific app.
1712
+ * @param appId Identifier of the app.
1713
+ * @param body an object with the body content
1714
+ * @throws CopyAppHttpError
1715
+ */
1716
+ copyApp: typeof copyApp;
1717
+ /**
1718
+ * Retrieves the lineage for an app.
1719
+ * Returns a JSON-formatted array of strings describing the lineage of the app.
1720
+ * @param appId Identifier of the app.
1721
+ * @throws GetAppDataLineageHttpError
1722
+ */
1723
+ getAppDataLineage: typeof getAppDataLineage;
1724
+ /**
1725
+ * Retrieves the data model and reload statistics metadata of an app.
1726
+ * An empty metadata structure is returned if the metadata is not available in the app.
1727
+ * @param appId Identifier of the app.
1728
+ * @throws GetAppDataMetadataHttpError
1729
+ */
1730
+ getAppDataMetadata: typeof getAppDataMetadata;
1731
+ /**
1732
+ * Exports a specific app.
1733
+ * @param appId Identifier of the app.
1734
+ * @param query an object with query parameters
1735
+ * @throws ExportAppHttpError
1736
+ */
1737
+ exportApp: typeof exportApp;
1738
+ /**
1739
+ * 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.
1740
+ * @param appId Qlik Sense app identifier
1741
+ * @throws GetAppInsightAnalysesHttpError
1742
+ */
1743
+ getAppInsightAnalyses: typeof getAppInsightAnalyses;
1744
+ /**
1745
+ * 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.
1746
+ * @param appId Qlik Sense app identifier
1747
+ * @param body an object with the body content
1748
+ * @throws GetAppInsightAnalysisRecommendationsHttpError
1749
+ */
1750
+ getAppInsightAnalysisRecommendations: typeof getAppInsightAnalysisRecommendations;
1751
+ /**
1752
+ * 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.
1753
+ * @param appId Qlik Sense app identifier
1754
+ * @throws GetAppInsightAnalysisModelHttpError
1755
+ */
1756
+ getAppInsightAnalysisModel: typeof getAppInsightAnalysisModel;
1757
+ /**
1758
+ * Deletes a media content file or complete directory.
1759
+ * 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.
1760
+ * @param appId Unique application identifier.
1761
+ * @param path Path to file content.
1762
+ * @throws DeleteAppMediaHttpError
1763
+ */
1764
+ deleteAppMedia: typeof deleteAppMedia;
1765
+ /**
1766
+ * Gets media content from file.
1767
+ * Returns a stream of bytes containing the media file content on success, or error if file is not found.
1768
+ * @param appId Unique application identifier.
1769
+ * @param path Path to file content.
1770
+ * @throws GetAppMediaHttpError
1771
+ */
1772
+ getAppMedia: typeof getAppMedia;
1773
+ /**
1774
+ * Stores the media content file.
1775
+ * 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.
1776
+ * @param appId Unique application identifier.
1777
+ * @param path Path to file content.
1778
+ * @param body an object with the body content
1779
+ * @throws UploadAppMediaHttpError
1780
+ */
1781
+ uploadAppMedia: typeof uploadAppMedia;
1782
+ /**
1783
+ * Lists media content.
1784
+ * Returns a JSON formatted array of strings describing the available media content or error if the optional path supplied is not found.
1785
+ * @param appId Unique application identifier.
1786
+ * @param path The path to sub folder with static content relative to the root folder. Use empty path to access the root folder.
1787
+ * @param query an object with query parameters
1788
+ * @throws GetAppMediaListHttpError
1789
+ */
1790
+ getAppMediaList: typeof getAppMediaList;
1791
+ /**
1792
+ * Gets media content from file currently used as application thumbnail.
1793
+ * Returns a stream of bytes containing the media file content on success, or error if file is not found.
1794
+ * The image selected as thumbnail is only updated when application is saved.
1795
+ * @param appId Unique application identifier.
1796
+ * @throws GetAppThumbnailHttpError
1797
+ */
1798
+ getAppThumbnail: typeof getAppThumbnail;
1799
+ /**
1800
+ * Sets owner on an app object.
1801
+ * @param appId Identifier of the app.
1802
+ * @param objectId Identifier of the object.
1803
+ * @param body an object with the body content
1804
+ * @throws UpdateAppObjectOwnerHttpError
1805
+ */
1806
+ updateAppObjectOwner: typeof updateAppObjectOwner;
1807
+ /**
1808
+ * Changes owner of the app.
1809
+ * @param appId Identifier of the app.
1810
+ * @param body an object with the body content
1811
+ * @throws UpdateAppOwnerHttpError
1812
+ */
1813
+ updateAppOwner: typeof updateAppOwner;
1814
+ /**
1815
+ * Publishes a specific app to a managed space.
1816
+ * @param appId Identifier of the app.
1817
+ * @param body an object with the body content
1818
+ * @throws PublishAppHttpError
1819
+ */
1820
+ publishApp: typeof publishApp;
1821
+ /**
1822
+ * Republishes a published app to a managed space.
1823
+ * @param appId Identifier of the app.
1824
+ * @param body an object with the body content
1825
+ * @throws RepublishAppHttpError
1826
+ */
1827
+ republishApp: typeof republishApp;
1828
+ /**
1829
+ * Retrieves the metadata about all script logs stored for an app.
1830
+ * Returns an array of ScriptLogMeta objects.
1831
+ * @param appId Identifier of the app.
1832
+ * @throws GetAppReloadLogsHttpError
1833
+ */
1834
+ getAppReloadLogs: typeof getAppReloadLogs;
1835
+ /**
1836
+ * Retrieves the log of a specific reload.
1837
+ * Returns the log as "text/plain; charset=UTF-8".
1838
+ * @param appId Identifier of the app.
1839
+ * @param reloadId Identifier of the reload.
1840
+ * @throws GetAppReloadLogHttpError
1841
+ */
1842
+ getAppReloadLog: typeof getAppReloadLog;
1843
+ /**
1844
+ * Retrieves the script history for an app.
1845
+ * Returns information about the saved versions of the script.
1846
+ * @param appId Identifier of the app.
1847
+ * @param query an object with query parameters
1848
+ * @throws GetAppScriptHistoryHttpError
1849
+ */
1850
+ getAppScriptHistory: typeof getAppScriptHistory;
1851
+ /**
1852
+ * Sets script for an app.
1853
+ * @param appId Identifier of the app.
1854
+ * @param body an object with the body content
1855
+ * @throws UpdateAppScriptHttpError
1856
+ */
1857
+ updateAppScript: typeof updateAppScript;
1858
+ /**
1859
+ * Deletes a specific version of the script for an app.
1860
+ * Fails if the version to delete is the current version.
1861
+ * @param appId Identifier of the app.
1862
+ * @param version Identifier of the script version
1863
+ * @throws DeleteAppScriptHttpError
1864
+ */
1865
+ deleteAppScript: typeof deleteAppScript;
1866
+ /**
1867
+ * Retrieves a version of the script for an app.
1868
+ * Returns the script text.
1869
+ * @param appId Identifier of the app.
1870
+ * @param version Identifier of the script version, or 'current' for retrieving the current version.
1871
+ * @throws GetAppScriptHttpError
1872
+ */
1873
+ getAppScript: typeof getAppScript;
1874
+ /**
1875
+ * Updates a specific version of the script for an app.
1876
+ * @param appId Identifier of the app.
1877
+ * @param version Identifier of the script version.
1878
+ * @param body an object with the body content
1879
+ * @throws PatchAppScriptHttpError
1880
+ */
1881
+ patchAppScript: typeof patchAppScript;
1882
+ /**
1883
+ * Removes space from a specific app.
1884
+ * @param appId Identifier of the app.
1885
+ * @throws RemoveAppFromSpaceHttpError
1886
+ */
1887
+ removeAppFromSpace: typeof removeAppFromSpace;
1888
+ /**
1889
+ * Sets space on a specific app.
1890
+ * @param appId Identifier of the app.
1891
+ * @param body an object with the body content
1892
+ * @throws MoveAppToSpaceHttpError
1893
+ */
1894
+ moveAppToSpace: typeof moveAppToSpace;
1895
+ /**
1896
+ * Find all evaluations for an app GUID.
1897
+ * Supports paging via next, prev which are sent in the response body
1898
+ *
1899
+ * @param guid The app guid.
1900
+ * @param query an object with query parameters
1901
+ * @throws GetAppEvaluationsHttpError
1902
+ */
1903
+ getAppEvaluations: typeof getAppEvaluations;
1904
+ /**
1905
+ * Queue an app evaluation by its app guid.
1906
+ *
1907
+ * @param guid Guid of the app.
1908
+ * @throws QueueAppEvaluationHttpError
1909
+ */
1910
+ queueAppEvaluation: typeof queueAppEvaluation;
1911
+ /**
1912
+ * Clears the cache for apps api requests.
1913
+ */
1914
+ clearCache: typeof clearCache;
1915
+ }
1916
+ /**
1917
+ * Functions for the apps api
1918
+ */
1919
+ declare const appsExport: AppsAPI;
1920
+
1921
+ export { type Analysis, type AnalysisComposition, type AnalysisDescriptor, type AnalysisDescriptorResponse, type AnalysisDetails, type AnalysisGroup, type AnalysisModelItemField, type AnalysisModelItemMasterItem, type AnalysisModelResponse, type AnalysisModelResponseDetail, type AnalysisRecommendRequest, type AnalysisRecommendationResponse, type AnalysisRecommendationResponseDetail, type AppAttributes, type AppContentList, type AppContentListItem, type AppUpdateAttributes, type AppsAPI, type ChartType, type Classification, type Classifications, type Cmpbool, type Cmpfloat, type Cmpint, type Comparison, type Comparisonfields, type Comparisonobjresponsetime, type Comparisonoobjheavy, type Comparisontables, type CompositionMinMax, type CopyAppHttpError, type CopyAppHttpResponse, type CreateApp, type CreateAppHttpError, type CreateAppHttpResponse, type DataModelMetadata, type DeleteAppHttpError, type DeleteAppHttpResponse, type DeleteAppMediaHttpError, type DeleteAppMediaHttpResponse, type DeleteAppScriptHttpError, type DeleteAppScriptHttpResponse, type Error, type Errors, type Evaluation, type Evaluations, type EvaluatorError, type Event, type ExportAppHttpError, type ExportAppHttpResponse, type FieldAttributes, type FieldInTableProfilingData, type FieldMetadata, type FieldOverride, type FileData, type FrequencyDistributionData, type GetAppDataLineageHttpError, type GetAppDataLineageHttpResponse, type GetAppDataMetadataHttpError, type GetAppDataMetadataHttpResponse, type GetAppEvaluationComparisonHttpError, type GetAppEvaluationComparisonHttpResponse, type GetAppEvaluationComparisonXMLHttpError, type GetAppEvaluationComparisonXMLHttpResponse, type GetAppEvaluationHttpError, type GetAppEvaluationHttpResponse, type GetAppEvaluationXMLHttpError, type GetAppEvaluationXMLHttpResponse, type GetAppEvaluationsHttpError, type GetAppEvaluationsHttpResponse, type GetAppInfoHttpError, type GetAppInfoHttpResponse, type GetAppInsightAnalysesHttpError, type GetAppInsightAnalysesHttpResponse, type GetAppInsightAnalysisModelHttpError, type GetAppInsightAnalysisModelHttpResponse, type GetAppInsightAnalysisRecommendationsHttpError, type GetAppInsightAnalysisRecommendationsHttpResponse, type GetAppMediaHttpError, type GetAppMediaHttpResponse, type GetAppMediaListHttpError, type GetAppMediaListHttpResponse, type GetAppPrivilegesHttpError, type GetAppPrivilegesHttpResponse, type GetAppReloadLogHttpError, type GetAppReloadLogHttpResponse, type GetAppReloadLogsHttpError, type GetAppReloadLogsHttpResponse, type GetAppScriptHistoryHttpError, type GetAppScriptHistoryHttpResponse, type GetAppScriptHttpError, type GetAppScriptHttpResponse, type GetAppThumbnailHttpError, type GetAppThumbnailHttpResponse, type HardwareMeta, type Href, type ImportAppHttpError, type ImportAppHttpResponse, type JsonObject, type LastReloadMetadata, type LineageInfoRest, type Links, type Log, type Metadata, type MoveAppToSpaceHttpError, type MoveAppToSpaceHttpResponse, type NavigationLink, type NavigationLinks, type NumberFormat, type NxApp, type NxAppCreatePrivileges, type NxAppObject, type NxAttributes, type NxObjectAttributes, type NxPatch, type Objectmetrics, type Objectspec, type Objecttopspec, type PartialNluInfo, type PatchAppScriptHttpError, type PatchAppScriptHttpResponse, type PublishApp, type PublishAppHttpError, type PublishAppHttpResponse, type QueueAppEvaluationHttpError, type QueueAppEvaluationHttpResponse, type RecommendFieldItem, type RecommendItems, type RecommendMasterItem, type RecommendNaturalLangQuery, type RecommendedAnalysis, type RecommendedAnalysisCore, type RemoveAppFromSpaceHttpError, type RemoveAppFromSpaceHttpResponse, type RepublishApp, type RepublishAppHttpError, type RepublishAppHttpResponse, type Result, type Resultentry, type Resultmetadatatopfields, type Resultmetadatatoptables, type Resultobjresponsetime, type Resultobjsheet, type Resultobjsinglethreaded, type Resultsingle, type ScriptLogList, type ScriptLogMeta, type ScriptMeta, type ScriptMetaList, type ScriptVersion, type SimplifiedClassifications, type Sortedcomparisonfields, type Sortedcomparisonobjresponsetime, type Sortedcomparisonoobjheavy, type Sortedcomparisontables, type SymbolFrequency, type SymbolValue, type TableMetadata, type TableProfilingData, type UpdateApp, type UpdateAppInfoHttpError, type UpdateAppInfoHttpResponse, type UpdateAppObjectOwnerHttpError, type UpdateAppObjectOwnerHttpResponse, type UpdateAppOwnerHttpError, type UpdateAppOwnerHttpResponse, type UpdateAppScriptHttpError, type UpdateAppScriptHttpResponse, type UpdateOwner, type UpdateSpace, type UploadAppMediaHttpError, type UploadAppMediaHttpResponse, clearCache, copyApp, createApp, appsExport as default, deleteApp, deleteAppMedia, deleteAppScript, exportApp, getAppDataLineage, getAppDataMetadata, getAppEvaluation, getAppEvaluationComparison, getAppEvaluationComparisonXML, getAppEvaluationXML, getAppEvaluations, getAppInfo, getAppInsightAnalyses, getAppInsightAnalysisModel, getAppInsightAnalysisRecommendations, getAppMedia, getAppMediaList, getAppPrivileges, getAppReloadLog, getAppReloadLogs, getAppScript, getAppScriptHistory, getAppThumbnail, importApp, moveAppToSpace, patchAppScript, publishApp, queueAppEvaluation, removeAppFromSpace, republishApp, updateAppInfo, updateAppObjectOwner, updateAppOwner, updateAppScript, uploadAppMedia };