@qlik/api 0.0.1 → 0.0.3

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 (156) hide show
  1. package/.github/CODEOWNERS +2 -0
  2. package/.github/workflows/release.yaml +35 -0
  3. package/README.md +1 -3
  4. package/api-keys.d.mts +27 -13
  5. package/api-keys.d.ts +27 -13
  6. package/api-keys.js +17 -13
  7. package/api-keys.mjs +12 -8
  8. package/apps.d.mts +580 -165
  9. package/apps.d.ts +580 -165
  10. package/apps.js +111 -44
  11. package/apps.mjs +78 -11
  12. package/audits.d.mts +20 -8
  13. package/audits.d.ts +20 -8
  14. package/audits.js +12 -11
  15. package/audits.mjs +7 -6
  16. package/auth-AWZV4DPP.js +41 -0
  17. package/{auth-TE272Q34.mjs → auth-CPBNNC7S.mjs} +8 -3
  18. package/auth.js +4 -3
  19. package/auth.mjs +3 -2
  20. package/automations.d.mts +56 -20
  21. package/automations.d.ts +56 -20
  22. package/automations.js +32 -25
  23. package/automations.mjs +18 -11
  24. package/brands.d.mts +45 -4
  25. package/brands.d.ts +45 -4
  26. package/brands.js +20 -15
  27. package/brands.mjs +7 -2
  28. package/{chunk-ZT4C7KCQ.js → chunk-2STFUQKQ.js} +3 -3
  29. package/{chunk-WM7FQU2U.mjs → chunk-3SVRHJII.mjs} +3 -3
  30. package/{chunk-CKPJE4IA.mjs → chunk-67GJTTPV.mjs} +1 -1
  31. package/{chunk-4ES65KO3.js → chunk-7RY3NO6N.js} +2 -2
  32. package/{chunk-4OMEH5SW.mjs → chunk-CYRLVHU3.mjs} +321 -53
  33. package/{chunk-XASXL2NC.js → chunk-D52VW5UN.js} +323 -55
  34. package/{chunk-GUQBHY3H.mjs → chunk-GNWU6SP2.mjs} +1 -1
  35. package/{chunk-4FLMND6T.js → chunk-GV5SRHY2.js} +4 -4
  36. package/{chunk-OULT3V2U.js → chunk-JNGURO23.js} +3 -3
  37. package/chunk-P57PW2II.js +11 -0
  38. package/{chunk-3YE7EI7I.mjs → chunk-TE7XMBT5.mjs} +1 -1
  39. package/chunk-ZFXKCRJC.mjs +11 -0
  40. package/collections.d.mts +52 -18
  41. package/collections.d.ts +52 -18
  42. package/collections.js +28 -14
  43. package/collections.mjs +16 -2
  44. package/csp-origins.d.mts +12 -0
  45. package/csp-origins.d.ts +12 -0
  46. package/csp-origins.js +12 -9
  47. package/csp-origins.mjs +5 -2
  48. package/data-assets.d.mts +10 -0
  49. package/data-assets.d.ts +10 -0
  50. package/data-assets.js +13 -8
  51. package/data-assets.mjs +7 -2
  52. package/data-connections.d.mts +20 -0
  53. package/data-connections.d.ts +20 -0
  54. package/data-connections.js +19 -12
  55. package/data-connections.mjs +9 -2
  56. package/data-credentials.d.mts +10 -0
  57. package/data-credentials.d.ts +10 -0
  58. package/data-credentials.js +10 -7
  59. package/data-credentials.mjs +5 -2
  60. package/data-files.d.mts +114 -29
  61. package/data-files.d.ts +114 -29
  62. package/data-files.js +25 -18
  63. package/data-files.mjs +15 -8
  64. package/{enigma-session-TEB53FAF.js → enigma-session-XPXDQAIV.js} +12 -7
  65. package/{enigma-session-4L373ALV.mjs → enigma-session-ZH6MYA54.mjs} +10 -5
  66. package/{esm-4X3DKK5D.js → esm-3VXX2GKL.js} +13 -9
  67. package/{esm-SOWVJKOQ.mjs → esm-OY4XVIJB.mjs} +13 -9
  68. package/extensions.d.mts +26 -2
  69. package/extensions.d.ts +26 -2
  70. package/extensions.js +13 -10
  71. package/extensions.mjs +5 -2
  72. package/glossaries.d.mts +55 -20
  73. package/glossaries.d.ts +55 -20
  74. package/glossaries.js +39 -27
  75. package/glossaries.mjs +14 -2
  76. package/groups.d.mts +29 -13
  77. package/groups.d.ts +29 -13
  78. package/groups.js +19 -14
  79. package/groups.mjs +13 -8
  80. package/identity-providers.d.mts +23 -7
  81. package/identity-providers.d.ts +23 -7
  82. package/identity-providers.js +16 -13
  83. package/identity-providers.mjs +8 -5
  84. package/index.js +150 -112
  85. package/index.mjs +146 -108
  86. package/{invoke-fetch-MSSJAZ7K.mjs → invoke-fetch-3WZWAAZH.mjs} +4 -1
  87. package/invoke-fetch-UNTAUR7O.js +17 -0
  88. package/items.d.mts +25 -22
  89. package/items.d.ts +25 -22
  90. package/items.js +17 -14
  91. package/items.mjs +11 -8
  92. package/licenses.d.mts +20 -0
  93. package/licenses.d.ts +20 -0
  94. package/licenses.js +17 -12
  95. package/licenses.mjs +7 -2
  96. package/package.json +7 -18
  97. package/{qix-RLTISYTB.js → qix-UNWXPGMA.js} +9 -8
  98. package/{qix-EU7PXRZ6.mjs → qix-ZSJ4PIK3.mjs} +5 -4
  99. package/qix.d.mts +1066 -1017
  100. package/qix.d.ts +1066 -1017
  101. package/qix.js +4 -3
  102. package/qix.mjs +3 -2
  103. package/quotas.d.mts +4 -0
  104. package/quotas.d.ts +4 -0
  105. package/quotas.js +6 -5
  106. package/quotas.mjs +3 -2
  107. package/reload-tasks.d.mts +2 -0
  108. package/reload-tasks.d.ts +2 -0
  109. package/reload-tasks.js +11 -8
  110. package/reload-tasks.mjs +5 -2
  111. package/reloads.d.mts +20 -11
  112. package/reloads.d.ts +20 -11
  113. package/reloads.js +9 -7
  114. package/reloads.mjs +4 -2
  115. package/roles.d.mts +4 -0
  116. package/roles.d.ts +4 -0
  117. package/roles.js +6 -5
  118. package/roles.mjs +3 -2
  119. package/spaces.d.mts +36 -30
  120. package/spaces.d.ts +36 -30
  121. package/spaces.js +21 -15
  122. package/spaces.mjs +8 -2
  123. package/temp-contents.d.mts +9 -70
  124. package/temp-contents.d.ts +9 -70
  125. package/temp-contents.js +10 -29
  126. package/temp-contents.mjs +5 -24
  127. package/tenants.d.mts +12 -0
  128. package/tenants.d.ts +12 -0
  129. package/tenants.js +14 -9
  130. package/tenants.mjs +7 -2
  131. package/themes.d.mts +26 -2
  132. package/themes.d.ts +26 -2
  133. package/themes.js +13 -10
  134. package/themes.mjs +5 -2
  135. package/transports.d.mts +12 -0
  136. package/transports.d.ts +12 -0
  137. package/transports.js +12 -9
  138. package/transports.mjs +5 -2
  139. package/users.d.mts +48 -29
  140. package/users.d.ts +48 -29
  141. package/users.js +18 -13
  142. package/users.mjs +7 -2
  143. package/web-integrations.d.mts +10 -0
  144. package/web-integrations.d.ts +10 -0
  145. package/web-integrations.js +11 -8
  146. package/web-integrations.mjs +5 -2
  147. package/web-notifications.d.mts +12 -0
  148. package/web-notifications.d.ts +12 -0
  149. package/web-notifications.js +12 -9
  150. package/web-notifications.mjs +5 -2
  151. package/webhooks.d.mts +27 -7
  152. package/webhooks.d.ts +27 -7
  153. package/webhooks.js +17 -13
  154. package/webhooks.mjs +6 -2
  155. package/auth-CSVTXOZX.js +0 -36
  156. package/invoke-fetch-PEI54KZO.js +0 -14
package/apps.d.mts CHANGED
@@ -89,10 +89,10 @@ type AppAttributes = {
89
89
  /** The space ID of the application */
90
90
  spaceId?: string;
91
91
  /** Indicates whether the app is used for Analytics or DataPreparation
92
- //
93
- // One of:
94
- // * ANALYTICS
95
- // * DATA_PREPARATION */
92
+ *
93
+ * One of:
94
+ * * ANALYTICS
95
+ * * DATA_PREPARATION */
96
96
  usage?: "ANALYTICS" | "DATA_PREPARATION";
97
97
  };
98
98
  type AppContentList = {
@@ -142,9 +142,9 @@ type DataModelMetadata = {
142
142
  /** Profiling data of the tables in the app. */
143
143
  tables_profiling_data?: TableProfilingData[];
144
144
  /**
145
- // One of:
146
- // * ANALYTICS
147
- // * DATA_PREPARATION */
145
+ * One of:
146
+ * * ANALYTICS
147
+ * * DATA_PREPARATION */
148
148
  usage?: "ANALYTICS" | "DATA_PREPARATION";
149
149
  };
150
150
  type Error = {
@@ -176,37 +176,37 @@ type EvaluatorError = {
176
176
  };
177
177
  type FieldAttributes = {
178
178
  /** Defines the decimal separator.
179
- // Example: **.** */
179
+ * Example: **.** */
180
180
  Dec?: string;
181
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. */
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
185
  Fmt?: string;
186
186
  /** Defines the thousand separator (if any).
187
- // Is used if **qUseThou** is set to 1.
188
- // Example: **,** */
187
+ * Is used if **qUseThou** is set to 1.
188
+ * Example: **,** */
189
189
  Thou?: string;
190
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 */
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
204
  Type?: "UNKNOWN" | "ASCII" | "INTEGER" | "REAL" | "FIX" | "MONEY" | "DATE" | "TIME" | "TIMESTAMP" | "INTERVAL";
205
205
  /** Defines whether or not a thousands separator must be used.
206
- // Default is 0. */
206
+ * Default is 0. */
207
207
  UseThou?: number;
208
208
  /** Number of decimals.
209
- // Default is 10. */
209
+ * Default is 10. */
210
210
  nDec?: number;
211
211
  };
212
212
  type FieldInTableProfilingData = {
@@ -252,42 +252,42 @@ type FieldInTableProfilingData = {
252
252
  /** Number of null values */
253
253
  NullValues?: number;
254
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. */
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
291
  NumberFormat?: FieldAttributes;
292
292
  /** Number of numeric values */
293
293
  NumericValues?: number;
@@ -310,8 +310,8 @@ type FieldInTableProfilingData = {
310
310
  };
311
311
  type FieldMetadata = {
312
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. */
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
315
  always_one_selected?: boolean;
316
316
  /** Static RAM memory used in bytes. */
317
317
  byte_size?: number;
@@ -320,31 +320,31 @@ type FieldMetadata = {
320
320
  /** Field comment. */
321
321
  comment?: string;
322
322
  /** If set to true, only distinct field values are shown.
323
- // The default value is false. */
323
+ * The default value is false. */
324
324
  distinct_only?: boolean;
325
325
  /** Hash of the data in the field. If the data in a reload is the same, the hash will be consistent. */
326
326
  hash?: string;
327
327
  /** If set to true, the field is hidden.
328
- // The default value is false. */
328
+ * The default value is false. */
329
329
  is_hidden?: boolean;
330
330
  /** If set to true, the field is locked.
331
- // The default value is false. */
331
+ * The default value is false. */
332
332
  is_locked?: boolean;
333
333
  /** Is set to true if the value is a numeric.
334
- // The default value is false. */
334
+ * The default value is false. */
335
335
  is_numeric?: boolean;
336
336
  /** If set to true, the field is semantic.
337
- // The default value is false. */
337
+ * The default value is false. */
338
338
  is_semantic?: boolean;
339
339
  /** If set to true, the field is a system field.
340
- // The default value is false. */
340
+ * The default value is false. */
341
341
  is_system?: boolean;
342
342
  /** Name of the field. */
343
343
  name?: string;
344
344
  /** List of table names. */
345
345
  src_tables?: string[];
346
346
  /** Gives information on a field. For example, it can return the type of the field.
347
- // Examples: key, text, ASCII. */
347
+ * Examples: key, text, ASCII. */
348
348
  tags?: string[];
349
349
  /** Total number of field values. */
350
350
  total_count?: number;
@@ -353,7 +353,113 @@ type FieldOverride = {
353
353
  classifications?: string[];
354
354
  defaultAggregation?: string;
355
355
  };
356
- type FileData = string;
356
+ type FileData = BodyInit;
357
+ type Filter = {
358
+ readonly createdAt?: string;
359
+ /** The filter description. */
360
+ description?: string;
361
+ filterType?: FilterType;
362
+ filterV1_0?: FilterV10;
363
+ filterVersion?: "filter-1.0";
364
+ /** The filter ID (bookmarkId). */
365
+ readonly id?: string;
366
+ /** The filter name. */
367
+ name?: string;
368
+ /** The user that owns the filter, if missing the same as the request user. */
369
+ ownerId?: string;
370
+ readonly updatedAt?: string;
371
+ };
372
+ type FilterError = {
373
+ /** The unique code for the error
374
+ *
375
+ * - "REP-400000" Bad request. The server could not understand the request due to invalid syntax.
376
+ * - "REP-400008" Selections error.
377
+ * - "REP-400015" Bad request in enigma request. The patch value has invalid JSON format.
378
+ * - "REP-401000" Unauthorized. The client must authenticate itself to get the requested response.
379
+ * - "REP-401001" Unauthorized, bad JWT.
380
+ * - "REP-403000" Forbidden. The client does not have access rights to the content.
381
+ * - "REP-403001" App forbidden, the user does not have read permission on the app.
382
+ * - "REP-403002" Chart type not supported.
383
+ * - "REP-404000" Not found. The server can not find the requested resource.
384
+ * - "REP-409043" Filter name conflict. The filter name must be unique.
385
+ * - "REP-429000" Too many request. The user has sent too many requests in a given amount of time ("rate limiting").
386
+ * - "REP-429012" Exceeded max session tenant quota. A tenant has opened too many different sessions at the same time.
387
+ * - "REP-429016" Exceeded max session tenant quota per day.
388
+ * - "REP-500000" Fail to resolve resource.
389
+ * - "REP-503005" Engine unavailable, qix-sessions error no engines available.
390
+ * - "REP-503013" Session unavailable. The engine session used to create the report is unavailable.
391
+ * - "REP-504042" Context deadline exceeded applying selections of the Filter. */
392
+ code: string;
393
+ /** A summary in english explaining what went wrong. */
394
+ title: string;
395
+ };
396
+ type FilterErrors = {
397
+ errors: FilterError[];
398
+ };
399
+ type FilterField = {
400
+ /** Gets the resource description. */
401
+ description?: string;
402
+ name: string;
403
+ overrideValues?: boolean;
404
+ selectExcluded?: boolean;
405
+ /** The filter values. */
406
+ values?: FilterFieldValue[];
407
+ };
408
+ type FilterFieldValue = {
409
+ valueAsNumber?: Float64;
410
+ valueAsText?: string;
411
+ valueType?: "string" | "number" | "evaluate" | "search";
412
+ };
413
+ type FilterList = {
414
+ /** a list of filters containing all the filters properties (like name,description...) except the filter definition (like FilterV1_0) */
415
+ data: FilterListItem[];
416
+ links: LinksResponse;
417
+ };
418
+ type FilterListItem = {
419
+ readonly createdAt?: string;
420
+ /** The filter description. */
421
+ readonly description?: string;
422
+ filterType?: FilterType;
423
+ filterV1_0?: FilterV10;
424
+ readonly filterVersion?: "filter-1.0";
425
+ /** The filter ID (bookmarkId) */
426
+ readonly id?: string;
427
+ /** The filter name. */
428
+ readonly name?: string;
429
+ /** The user that owns the filter, if missing the same as the request user. */
430
+ readonly ownerId?: string;
431
+ readonly updatedAt?: string;
432
+ };
433
+ type FilterRequest = {
434
+ /** The App ID. */
435
+ appId?: string;
436
+ /** The filter description. */
437
+ description?: string;
438
+ filterType: FilterType;
439
+ filterV1_0?: FilterV10;
440
+ filterVersion: "filter-1.0";
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
+ };
446
+ type FilterType = "REP" | "SUB";
447
+ type FilterV10 = {
448
+ /** 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. */
449
+ fieldsByState?: unknown;
450
+ /** The filter variables. */
451
+ variables?: FilterVariable[];
452
+ };
453
+ type FilterVariable = {
454
+ evaluate?: boolean;
455
+ name: string;
456
+ value?: string;
457
+ };
458
+ type FiltersCount = {
459
+ /** The total number of filters. */
460
+ readonly total?: number;
461
+ };
462
+ type Float64 = number;
357
463
  type FrequencyDistributionData = {
358
464
  /** Bins edges. */
359
465
  BinsEdges?: number[];
@@ -381,23 +487,31 @@ type LastReloadMetadata = {
381
487
  };
382
488
  type LineageInfoRest = {
383
489
  /** 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). */
490
+ * * [filename]: the data comes from a local file.
491
+ * * INLINE: the data is entered inline in the load script.
492
+ * * RESIDENT: the data comes from a resident table. The table name is listed.
493
+ * * AUTOGENERATE: the data is generated from the load script (no external table of data source).
494
+ * * Provider: the data comes from a data connection. The connector source name is listed.
495
+ * * [webfile]: the data comes from a web-based file.
496
+ * * STORE: path to QVD or TXT file where data is stored.
497
+ * * EXTENSION: the data comes from a Server Side Extension (SSE). */
392
498
  discriminator?: string;
393
499
  /** The LOAD and SELECT script statements from the data load script. */
394
500
  statement?: string;
395
501
  };
502
+ type LinkResponse = {
503
+ href?: string;
504
+ };
396
505
  type Links = {
397
506
  next?: Href;
398
507
  prev?: Href;
399
508
  self?: Href;
400
509
  };
510
+ type LinksResponse = {
511
+ next: LinkResponse;
512
+ prev: LinkResponse;
513
+ self: LinkResponse;
514
+ };
401
515
  type Log = {
402
516
  /** Provides a link to download the log file. */
403
517
  log?: string;
@@ -415,20 +529,20 @@ type NxApp = {
415
529
  /** Object create privileges. Hints to the client what type of objects the user is allowed to create. */
416
530
  create?: NxAppCreatePrivileges[];
417
531
  /** 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 */
532
+ * Hints to the client what actions the user is allowed to perform.
533
+ * Could be any of:
534
+ * * read
535
+ * * create
536
+ * * update
537
+ * * delete
538
+ * * reload
539
+ * * import
540
+ * * publish
541
+ * * duplicate
542
+ * * export
543
+ * * exportdata
544
+ * * change_owner
545
+ * * change_space */
432
546
  privileges?: string[];
433
547
  };
434
548
  type NxAppCreatePrivileges = {
@@ -441,15 +555,15 @@ type NxAppObject = {
441
555
  /** App object attributes. This structure can also contain extra user-defined attributes. */
442
556
  attributes?: NxObjectAttributes;
443
557
  /** 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 */
558
+ * Hints to the client what actions the user is allowed to perform.
559
+ * Could be any of:
560
+ * * read
561
+ * * create
562
+ * * update
563
+ * * delete
564
+ * * publish
565
+ * * exportdata
566
+ * * change_owner */
453
567
  privileges?: string[];
454
568
  };
455
569
  type NxAttributes = {
@@ -488,9 +602,9 @@ type NxAttributes = {
488
602
  /** App thumbnail. */
489
603
  thumbnail?: string;
490
604
  /**
491
- // One of:
492
- // * ANALYTICS
493
- // * DATA_PREPARATION */
605
+ * One of:
606
+ * * ANALYTICS
607
+ * * DATA_PREPARATION */
494
608
  usage?: "ANALYTICS" | "DATA_PREPARATION";
495
609
  };
496
610
  type NxObjectAttributes = {
@@ -501,13 +615,13 @@ type NxObjectAttributes = {
501
615
  /** Object description. */
502
616
  description?: string;
503
617
  /** The generic type of the object.
504
- //
505
- // One of:
506
- // * genericObject
507
- // * genericBookmark
508
- // * genericMeasure
509
- // * genericDimension
510
- // * genericVariable */
618
+ *
619
+ * One of:
620
+ * * genericObject
621
+ * * genericBookmark
622
+ * * genericMeasure
623
+ * * genericDimension
624
+ * * genericVariable */
511
625
  genericType?: "genericObject" | "genericBookmark" | "genericMeasure" | "genericDimension" | "genericVariable";
512
626
  /** The object Id. */
513
627
  id?: string;
@@ -524,18 +638,18 @@ type NxObjectAttributes = {
524
638
  };
525
639
  type NxPatch = {
526
640
  /** Operation to perform.
527
- //
528
- // One of:
529
- // * add or Add
530
- // * remove or Remove
531
- // * replace or Replace */
641
+ *
642
+ * One of:
643
+ * * add or Add
644
+ * * remove or Remove
645
+ * * replace or Replace */
532
646
  Op?: "Add" | "Remove" | "Replace";
533
647
  /** Path to the property to add, remove or replace. */
534
648
  Path?: string;
535
649
  /** 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\"" */
650
+ * Corresponds to the value of the property to add or to the new value of the property to update.
651
+ * Examples:
652
+ * "false", "2", "\"New title\"" */
539
653
  Value?: string;
540
654
  };
541
655
  type PartialNluInfo = {
@@ -553,10 +667,10 @@ type PartialNluInfo = {
553
667
  type PublishApp = {
554
668
  attributes?: AppUpdateAttributes;
555
669
  /** 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 */
670
+ * The default is source.
671
+ *
672
+ * * source: Publish with source data
673
+ * * target: Publish with target data */
560
674
  data?: "source" | "target";
561
675
  /** The original is moved instead of copied. The current published state of all objects is kept. */
562
676
  moveApp?: boolean;
@@ -600,15 +714,67 @@ type RecommendedAnalysisCore = {
600
714
  /** percentage of selected items in the analysis to the overall items passed to the endpoint */
601
715
  relevance?: number;
602
716
  };
717
+ type ReloadListMetadata = {
718
+ /** Array of ReloadMeta. */
719
+ data?: ReloadMeta[];
720
+ };
721
+ type ReloadMeta = {
722
+ /** Duration of reload (ms). */
723
+ duration?: number;
724
+ /** Time when reload ended. */
725
+ endTime?: string;
726
+ /** True if the reload is a partial reload. */
727
+ isPartialReload?: boolean;
728
+ loadDataFilesBytes?: number;
729
+ loadExternalBytes?: number;
730
+ loadFilesBytes?: number;
731
+ /** Reload identifier. */
732
+ reloadId?: string;
733
+ /** If greater than or equal 0, defines max number of rows loaded from a data source. */
734
+ rowLimit?: number;
735
+ /** Set to true to skip Store statements.
736
+ * The default value is false. */
737
+ skipStore?: boolean;
738
+ /** List of external loaded or stored statements. */
739
+ statements?: ReloadStatements[];
740
+ storeDataFilesBytes?: number;
741
+ storeFilesBytes?: number;
742
+ /** true if the reload was successful. */
743
+ success?: boolean;
744
+ };
745
+ type ReloadStatements = {
746
+ /** The connecton name. */
747
+ connection?: string;
748
+ /** Connection ID. */
749
+ connectionId?: string;
750
+ /** Data loaded from the network (bytes). */
751
+ dataSize?: number;
752
+ /** Duration of data generation (ms). */
753
+ duration?: number;
754
+ /** Label of the resource level node in lineage. */
755
+ label?: string;
756
+ /** Number of fields loaded. */
757
+ nbrOfFields?: number;
758
+ /** Number of rows loaded. */
759
+ nbrOfRows?: number;
760
+ /** Partial load operation. e.g. add/replace/update/merge. n/a when not in partial load mode. */
761
+ partialReloadOperation?: string;
762
+ /** Resource Identifier. */
763
+ qri?: string;
764
+ /** Name of the source table in lineage. */
765
+ tableName?: string;
766
+ /** Type of statement, e.g. Store/Load. */
767
+ type?: string;
768
+ };
603
769
  type RepublishApp = {
604
770
  attributes?: AppUpdateAttributes;
605
771
  /** Validate that source app is same as originally published. */
606
772
  checkOriginAppId?: boolean;
607
773
  /** 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 */
774
+ * The default is source.
775
+ *
776
+ * * source: Publish with source data
777
+ * * target: Publish with target data */
612
778
  data?: "source" | "target";
613
779
  /** The target ID to be republished. */
614
780
  targetId?: string;
@@ -669,13 +835,13 @@ type TableMetadata = {
669
835
  /** Table comment. */
670
836
  comment?: string;
671
837
  /** If set to true, the table is loose due to circular connection.
672
- // The default value is false. */
838
+ * The default value is false. */
673
839
  is_loose?: boolean;
674
840
  /** If set to true, the table is semantic.
675
- // The default value is false. */
841
+ * The default value is false. */
676
842
  is_semantic?: boolean;
677
843
  /** If set to true, the table is a system table.
678
- // The default value is false. */
844
+ * The default value is false. */
679
845
  is_system?: boolean;
680
846
  /** Name of the table. */
681
847
  name?: string;
@@ -924,6 +1090,7 @@ type Sortedcomparisontables = {
924
1090
  };
925
1091
  /**
926
1092
  * Creates a new app.
1093
+ *
927
1094
  * @param body an object with the body content
928
1095
  * @throws CreateAppHttpError
929
1096
  */
@@ -967,15 +1134,15 @@ type GetAppEvaluationComparisonHttpError = {
967
1134
  *
968
1135
  * @param baseid Id of the baseline evaluation
969
1136
  * @param comparisonid Id of the comparison evaluation
970
- * @throws GetAppEvaluationComparisonXMLHttpError
1137
+ * @throws GetAppEvaluationComparisonXmlHttpError
971
1138
  */
972
- declare const getAppEvaluationComparisonXML: (baseid: string, comparisonid: string, options?: ApiCallOptions) => Promise<GetAppEvaluationComparisonXMLHttpResponse>;
973
- type GetAppEvaluationComparisonXMLHttpResponse = {
1139
+ declare const getAppEvaluationComparisonXml: (baseid: string, comparisonid: string, options?: ApiCallOptions) => Promise<GetAppEvaluationComparisonXmlHttpResponse>;
1140
+ type GetAppEvaluationComparisonXmlHttpResponse = {
974
1141
  data: Comparison;
975
1142
  headers: Headers;
976
1143
  status: number;
977
1144
  };
978
- type GetAppEvaluationComparisonXMLHttpError = {
1145
+ type GetAppEvaluationComparisonXmlHttpError = {
979
1146
  data: EvaluatorError;
980
1147
  headers: Headers;
981
1148
  status: number;
@@ -1007,21 +1174,22 @@ type GetAppEvaluationHttpError = {
1007
1174
  * Find and download an evaluation log by a specific evaluation id.
1008
1175
  *
1009
1176
  * @param id Id of the desired evaluation.
1010
- * @throws GetAppEvaluationXMLHttpError
1177
+ * @throws GetAppEvaluationXmlHttpError
1011
1178
  */
1012
- declare const getAppEvaluationXML: (id: string, options?: ApiCallOptions) => Promise<GetAppEvaluationXMLHttpResponse>;
1013
- type GetAppEvaluationXMLHttpResponse = {
1179
+ declare const getAppEvaluationXml: (id: string, options?: ApiCallOptions) => Promise<GetAppEvaluationXmlHttpResponse>;
1180
+ type GetAppEvaluationXmlHttpResponse = {
1014
1181
  data: Evaluation;
1015
1182
  headers: Headers;
1016
1183
  status: number;
1017
1184
  };
1018
- type GetAppEvaluationXMLHttpError = {
1185
+ type GetAppEvaluationXmlHttpError = {
1019
1186
  data: EvaluatorError;
1020
1187
  headers: Headers;
1021
1188
  status: number;
1022
1189
  };
1023
1190
  /**
1024
1191
  * Imports an app into the system.
1192
+ *
1025
1193
  * @param query an object with query parameters
1026
1194
  * @param body an object with the body content
1027
1195
  * @throws ImportAppHttpError
@@ -1036,16 +1204,16 @@ declare const importApp: (query: {
1036
1204
  /** The file ID to be downloaded from Temporary Content Service (TCS) and used during import. */
1037
1205
  fileId?: string;
1038
1206
  /** 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 */
1207
+ *
1208
+ * One of:
1209
+ * * NEW
1210
+ * * AUTOREPLACE */
1043
1211
  mode?: string;
1044
1212
  /** The name of the target app. */
1045
1213
  name?: string;
1046
1214
  /** The space ID of the target app. */
1047
1215
  spaceId?: string;
1048
- }, body: unknown, options?: ApiCallOptions) => Promise<ImportAppHttpResponse>;
1216
+ }, body: FileData, options?: ApiCallOptions) => Promise<ImportAppHttpResponse>;
1049
1217
  type ImportAppHttpResponse = {
1050
1218
  data: NxApp;
1051
1219
  headers: Headers;
@@ -1058,21 +1226,23 @@ type ImportAppHttpError = {
1058
1226
  };
1059
1227
  /**
1060
1228
  * 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
1229
+ *
1230
+ * @throws GetAppsPrivilegesHttpError
1062
1231
  */
1063
- declare const getAppPrivileges: (options?: ApiCallOptions) => Promise<GetAppPrivilegesHttpResponse>;
1064
- type GetAppPrivilegesHttpResponse = {
1232
+ declare const getAppsPrivileges: (options?: ApiCallOptions) => Promise<GetAppsPrivilegesHttpResponse>;
1233
+ type GetAppsPrivilegesHttpResponse = {
1065
1234
  data: string[];
1066
1235
  headers: Headers;
1067
1236
  status: number;
1068
1237
  };
1069
- type GetAppPrivilegesHttpError = {
1238
+ type GetAppsPrivilegesHttpError = {
1070
1239
  data: unknown;
1071
1240
  headers: Headers;
1072
1241
  status: number;
1073
1242
  };
1074
1243
  /**
1075
1244
  * Deletes a specific app.
1245
+ *
1076
1246
  * @param appId Identifier of the app.
1077
1247
  * @throws DeleteAppHttpError
1078
1248
  */
@@ -1089,6 +1259,7 @@ type DeleteAppHttpError = {
1089
1259
  };
1090
1260
  /**
1091
1261
  * Retrieves information for a specific app.
1262
+ *
1092
1263
  * @param appId Identifier of the app.
1093
1264
  * @throws GetAppInfoHttpError
1094
1265
  */
@@ -1105,6 +1276,7 @@ type GetAppInfoHttpError = {
1105
1276
  };
1106
1277
  /**
1107
1278
  * Updates the information for a specific app.
1279
+ *
1108
1280
  * @param appId Identifier of the app.
1109
1281
  * @param body an object with the body content
1110
1282
  * @throws UpdateAppInfoHttpError
@@ -1122,6 +1294,7 @@ type UpdateAppInfoHttpError = {
1122
1294
  };
1123
1295
  /**
1124
1296
  * Copies a specific app.
1297
+ *
1125
1298
  * @param appId Identifier of the app.
1126
1299
  * @param body an object with the body content
1127
1300
  * @throws CopyAppHttpError
@@ -1140,6 +1313,7 @@ type CopyAppHttpError = {
1140
1313
  /**
1141
1314
  * Retrieves the lineage for an app.
1142
1315
  * Returns a JSON-formatted array of strings describing the lineage of the app.
1316
+ *
1143
1317
  * @param appId Identifier of the app.
1144
1318
  * @throws GetAppDataLineageHttpError
1145
1319
  */
@@ -1157,6 +1331,7 @@ type GetAppDataLineageHttpError = {
1157
1331
  /**
1158
1332
  * Retrieves the data model and reload statistics metadata of an app.
1159
1333
  * An empty metadata structure is returned if the metadata is not available in the app.
1334
+ *
1160
1335
  * @param appId Identifier of the app.
1161
1336
  * @throws GetAppDataMetadataHttpError
1162
1337
  */
@@ -1173,6 +1348,7 @@ type GetAppDataMetadataHttpError = {
1173
1348
  };
1174
1349
  /**
1175
1350
  * Exports a specific app.
1351
+ *
1176
1352
  * @param appId Identifier of the app.
1177
1353
  * @param query an object with query parameters
1178
1354
  * @throws ExportAppHttpError
@@ -1193,6 +1369,7 @@ type ExportAppHttpError = {
1193
1369
  };
1194
1370
  /**
1195
1371
  * 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.
1372
+ *
1196
1373
  * @param appId Qlik Sense app identifier
1197
1374
  * @throws GetAppInsightAnalysesHttpError
1198
1375
  */
@@ -1211,6 +1388,7 @@ type GetAppInsightAnalysesHttpError = {
1211
1388
  };
1212
1389
  /**
1213
1390
  * 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.
1391
+ *
1214
1392
  * @param appId Qlik Sense app identifier
1215
1393
  * @param body an object with the body content
1216
1394
  * @throws GetAppInsightAnalysisRecommendationsHttpError
@@ -1228,6 +1406,7 @@ type GetAppInsightAnalysisRecommendationsHttpError = {
1228
1406
  };
1229
1407
  /**
1230
1408
  * 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.
1409
+ *
1231
1410
  * @param appId Qlik Sense app identifier
1232
1411
  * @throws GetAppInsightAnalysisModelHttpError
1233
1412
  */
@@ -1247,6 +1426,7 @@ type GetAppInsightAnalysisModelHttpError = {
1247
1426
  /**
1248
1427
  * Deletes a media content file or complete directory.
1249
1428
  * 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.
1429
+ *
1250
1430
  * @param appId Unique application identifier.
1251
1431
  * @param path Path to file content.
1252
1432
  * @throws DeleteAppMediaHttpError
@@ -1265,6 +1445,7 @@ type DeleteAppMediaHttpError = {
1265
1445
  /**
1266
1446
  * Gets media content from file.
1267
1447
  * Returns a stream of bytes containing the media file content on success, or error if file is not found.
1448
+ *
1268
1449
  * @param appId Unique application identifier.
1269
1450
  * @param path Path to file content.
1270
1451
  * @throws GetAppMediaHttpError
@@ -1283,12 +1464,13 @@ type GetAppMediaHttpError = {
1283
1464
  /**
1284
1465
  * Stores the media content file.
1285
1466
  * 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.
1467
+ *
1286
1468
  * @param appId Unique application identifier.
1287
1469
  * @param path Path to file content.
1288
1470
  * @param body an object with the body content
1289
1471
  * @throws UploadAppMediaHttpError
1290
1472
  */
1291
- declare const uploadAppMedia: (appId: string, path: string, body: unknown, options?: ApiCallOptions) => Promise<UploadAppMediaHttpResponse>;
1473
+ declare const uploadAppMedia: (appId: string, path: string, body: FileData, options?: ApiCallOptions) => Promise<UploadAppMediaHttpResponse>;
1292
1474
  type UploadAppMediaHttpResponse = {
1293
1475
  data: void;
1294
1476
  headers: Headers;
@@ -1302,6 +1484,7 @@ type UploadAppMediaHttpError = {
1302
1484
  /**
1303
1485
  * Lists media content.
1304
1486
  * Returns a JSON formatted array of strings describing the available media content or error if the optional path supplied is not found.
1487
+ *
1305
1488
  * @param appId Unique application identifier.
1306
1489
  * @param path The path to sub folder with static content relative to the root folder. Use empty path to access the root folder.
1307
1490
  * @param query an object with query parameters
@@ -1309,9 +1492,9 @@ type UploadAppMediaHttpError = {
1309
1492
  */
1310
1493
  declare const getAppMediaList: (appId: string, path: string, query: {
1311
1494
  /** 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. */
1495
+ * * 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.
1496
+ * * Recursive(r), use ?show=r or ?show=recursive, results in a recursive output with files, all empty folders are excluded.
1497
+ * * All(a), use ?show=a or ?show=all, results in a recursive output with files and empty directories. */
1315
1498
  show?: string;
1316
1499
  }, options?: ApiCallOptions) => Promise<GetAppMediaListHttpResponse>;
1317
1500
  type GetAppMediaListHttpResponse = {
@@ -1328,6 +1511,7 @@ type GetAppMediaListHttpError = {
1328
1511
  * Gets media content from file currently used as application thumbnail.
1329
1512
  * Returns a stream of bytes containing the media file content on success, or error if file is not found.
1330
1513
  * The image selected as thumbnail is only updated when application is saved.
1514
+ *
1331
1515
  * @param appId Unique application identifier.
1332
1516
  * @throws GetAppThumbnailHttpError
1333
1517
  */
@@ -1344,6 +1528,8 @@ type GetAppThumbnailHttpError = {
1344
1528
  };
1345
1529
  /**
1346
1530
  * Sets owner on an app object.
1531
+ * The user must be the owner of the object.
1532
+ *
1347
1533
  * @param appId Identifier of the app.
1348
1534
  * @param objectId Identifier of the object.
1349
1535
  * @param body an object with the body content
@@ -1362,6 +1548,7 @@ type UpdateAppObjectOwnerHttpError = {
1362
1548
  };
1363
1549
  /**
1364
1550
  * Changes owner of the app.
1551
+ *
1365
1552
  * @param appId Identifier of the app.
1366
1553
  * @param body an object with the body content
1367
1554
  * @throws UpdateAppOwnerHttpError
@@ -1379,6 +1566,7 @@ type UpdateAppOwnerHttpError = {
1379
1566
  };
1380
1567
  /**
1381
1568
  * Publishes a specific app to a managed space.
1569
+ *
1382
1570
  * @param appId Identifier of the app.
1383
1571
  * @param body an object with the body content
1384
1572
  * @throws PublishAppHttpError
@@ -1396,6 +1584,7 @@ type PublishAppHttpError = {
1396
1584
  };
1397
1585
  /**
1398
1586
  * Republishes a published app to a managed space.
1587
+ *
1399
1588
  * @param appId Identifier of the app.
1400
1589
  * @param body an object with the body content
1401
1590
  * @throws RepublishAppHttpError
@@ -1414,6 +1603,7 @@ type RepublishAppHttpError = {
1414
1603
  /**
1415
1604
  * Retrieves the metadata about all script logs stored for an app.
1416
1605
  * Returns an array of ScriptLogMeta objects.
1606
+ *
1417
1607
  * @param appId Identifier of the app.
1418
1608
  * @throws GetAppReloadLogsHttpError
1419
1609
  */
@@ -1431,6 +1621,7 @@ type GetAppReloadLogsHttpError = {
1431
1621
  /**
1432
1622
  * Retrieves the log of a specific reload.
1433
1623
  * Returns the log as "text/plain; charset=UTF-8".
1624
+ *
1434
1625
  * @param appId Identifier of the app.
1435
1626
  * @param reloadId Identifier of the reload.
1436
1627
  * @throws GetAppReloadLogHttpError
@@ -1446,18 +1637,154 @@ type GetAppReloadLogHttpError = {
1446
1637
  headers: Headers;
1447
1638
  status: number;
1448
1639
  };
1640
+ /**
1641
+ * Retrieves the app reload metadata list.
1642
+ * Reload metadata contains reload information, including reload id, duration, endtime and lineage load info.
1643
+ *
1644
+ * @param appId Identifier of the app
1645
+ * @param reloadId Identifier of the reload. Use empty reloadId to get all reloads.
1646
+ * @param query an object with query parameters
1647
+ * @throws GetAppReloadMetadataHttpError
1648
+ */
1649
+ declare const getAppReloadMetadata: (appId: string, reloadId: string, query: {
1650
+ /** Maximum number of records to return from this request. Default: 100 */
1651
+ limit?: string;
1652
+ }, options?: ApiCallOptions) => Promise<GetAppReloadMetadataHttpResponse>;
1653
+ type GetAppReloadMetadataHttpResponse = {
1654
+ data: ReloadListMetadata;
1655
+ headers: Headers;
1656
+ status: number;
1657
+ };
1658
+ type GetAppReloadMetadataHttpError = {
1659
+ data: unknown;
1660
+ headers: Headers;
1661
+ status: number;
1662
+ };
1663
+ /**
1664
+ * 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.
1665
+ *
1666
+ * @param appId Qlik Sense app identifier
1667
+ * @param query an object with query parameters
1668
+ * @throws GetAppReportFiltersHttpError
1669
+ */
1670
+ declare const getAppReportFilters: (appId: string, query: {
1671
+ /** 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.
1672
+ * The following fields support the `co` (contains) operator: `name` , `description`
1673
+ * The following fields support the `eq` (equals) operator: `ownerId`
1674
+ * ```
1675
+ * Example:
1676
+ * ```
1677
+ * (name co "query1" or description co "query2") and ownerId eq "123"
1678
+ * ``` */
1679
+ filter?: string;
1680
+ /** The filter type (REP, SUB). REP stands for report bookmark, SUB for subscription bookmark. */
1681
+ filterTypes?: ("REP" | "SUB")[];
1682
+ /** Limit the returned result set */
1683
+ limit?: number;
1684
+ /** If present, the cursor that starts the page of data that is returned. */
1685
+ page?: string;
1686
+ sort?: ("+ownerId" | "-ownerId" | "-name" | "+name" | "+description" | "-description" | "+createdAt" | "-createdAt" | "+updatedAt" | "-updatedAt")[];
1687
+ }, options?: ApiCallOptions) => Promise<GetAppReportFiltersHttpResponse>;
1688
+ type GetAppReportFiltersHttpResponse = {
1689
+ data: FilterList;
1690
+ headers: Headers;
1691
+ status: number;
1692
+ prev?: (options?: ApiCallOptions) => Promise<GetAppReportFiltersHttpResponse>;
1693
+ next?: (options?: ApiCallOptions) => Promise<GetAppReportFiltersHttpResponse>;
1694
+ };
1695
+ type GetAppReportFiltersHttpError = {
1696
+ data: FilterErrors;
1697
+ headers: Headers;
1698
+ status: number;
1699
+ };
1700
+ /**
1701
+ * Creates a new report filter which is used to re-apply selections, variables, patches to an engine session.
1702
+ *
1703
+ * @param appId Qlik Sense app identifier
1704
+ * @param body an object with the body content
1705
+ * @throws CreateAppReportFilterHttpError
1706
+ */
1707
+ declare const createAppReportFilter: (appId: string, body: FilterRequest, options?: ApiCallOptions) => Promise<CreateAppReportFilterHttpResponse>;
1708
+ type CreateAppReportFilterHttpResponse = {
1709
+ data: Filter;
1710
+ headers: Headers;
1711
+ status: number;
1712
+ };
1713
+ type CreateAppReportFilterHttpError = {
1714
+ data: FilterErrors;
1715
+ headers: Headers;
1716
+ status: number;
1717
+ };
1718
+ /**
1719
+ * Get the number of filters for the given app and filter types
1720
+ *
1721
+ * @param appId Qlik Sense app identifier
1722
+ * @param query an object with query parameters
1723
+ * @throws CountAppReportFiltersHttpError
1724
+ */
1725
+ declare const countAppReportFilters: (appId: string, query: {
1726
+ /** The filter type (REP, SUB). REP stands for report bookmark, SUB for subscription bookmark. */
1727
+ filterTypes?: ("REP" | "SUB")[];
1728
+ }, options?: ApiCallOptions) => Promise<CountAppReportFiltersHttpResponse>;
1729
+ type CountAppReportFiltersHttpResponse = {
1730
+ data: FiltersCount;
1731
+ headers: Headers;
1732
+ status: number;
1733
+ };
1734
+ type CountAppReportFiltersHttpError = {
1735
+ data: FilterErrors;
1736
+ headers: Headers;
1737
+ status: number;
1738
+ };
1739
+ /**
1740
+ * Delete a filter
1741
+ *
1742
+ * @param appId Qlik Sense app identifier
1743
+ * @param id The filter id identifier (bookmarkId).
1744
+ * @throws DeleteAppReportFilterHttpError
1745
+ */
1746
+ declare const deleteAppReportFilter: (appId: string, id: string, options?: ApiCallOptions) => Promise<DeleteAppReportFilterHttpResponse>;
1747
+ type DeleteAppReportFilterHttpResponse = {
1748
+ data: void;
1749
+ headers: Headers;
1750
+ status: number;
1751
+ };
1752
+ type DeleteAppReportFilterHttpError = {
1753
+ data: FilterErrors;
1754
+ headers: Headers;
1755
+ status: number;
1756
+ };
1757
+ /**
1758
+ * Get a filter
1759
+ *
1760
+ * @param appId Qlik Sense app identifier
1761
+ * @param id The filter id identifier (bookmarkId).
1762
+ * @throws GetAppReportFilterHttpError
1763
+ */
1764
+ declare const getAppReportFilter: (appId: string, id: string, options?: ApiCallOptions) => Promise<GetAppReportFilterHttpResponse>;
1765
+ type GetAppReportFilterHttpResponse = {
1766
+ data: Filter;
1767
+ headers: Headers;
1768
+ status: number;
1769
+ };
1770
+ type GetAppReportFilterHttpError = {
1771
+ data: FilterErrors;
1772
+ headers: Headers;
1773
+ status: number;
1774
+ };
1449
1775
  /**
1450
1776
  * Retrieves the script history for an app.
1451
1777
  * Returns information about the saved versions of the script.
1778
+ *
1452
1779
  * @param appId Identifier of the app.
1453
1780
  * @param query an object with query parameters
1454
1781
  * @throws GetAppScriptHistoryHttpError
1455
1782
  */
1456
1783
  declare const getAppScriptHistory: (appId: string, query: {
1457
1784
  /** A scim filter expression defining which script versions should be retrieved. Filterable fields are:
1458
- // * ScriptId
1459
- // * ModifiedTime
1460
- // * ModifierId */
1785
+ * * ScriptId
1786
+ * * ModifiedTime
1787
+ * * ModifierId */
1461
1788
  filter?: string;
1462
1789
  /** Maximum number of records to return from this request. */
1463
1790
  limit?: string;
@@ -1478,6 +1805,7 @@ type GetAppScriptHistoryHttpError = {
1478
1805
  };
1479
1806
  /**
1480
1807
  * Sets script for an app.
1808
+ *
1481
1809
  * @param appId Identifier of the app.
1482
1810
  * @param body an object with the body content
1483
1811
  * @throws UpdateAppScriptHttpError
@@ -1496,6 +1824,7 @@ type UpdateAppScriptHttpError = {
1496
1824
  /**
1497
1825
  * Deletes a specific version of the script for an app.
1498
1826
  * Fails if the version to delete is the current version.
1827
+ *
1499
1828
  * @param appId Identifier of the app.
1500
1829
  * @param version Identifier of the script version
1501
1830
  * @throws DeleteAppScriptHttpError
@@ -1514,6 +1843,7 @@ type DeleteAppScriptHttpError = {
1514
1843
  /**
1515
1844
  * Retrieves a version of the script for an app.
1516
1845
  * Returns the script text.
1846
+ *
1517
1847
  * @param appId Identifier of the app.
1518
1848
  * @param version Identifier of the script version, or 'current' for retrieving the current version.
1519
1849
  * @throws GetAppScriptHttpError
@@ -1531,6 +1861,7 @@ type GetAppScriptHttpError = {
1531
1861
  };
1532
1862
  /**
1533
1863
  * Updates a specific version of the script for an app.
1864
+ *
1534
1865
  * @param appId Identifier of the app.
1535
1866
  * @param version Identifier of the script version.
1536
1867
  * @param body an object with the body content
@@ -1549,6 +1880,7 @@ type PatchAppScriptHttpError = {
1549
1880
  };
1550
1881
  /**
1551
1882
  * Removes space from a specific app.
1883
+ *
1552
1884
  * @param appId Identifier of the app.
1553
1885
  * @throws RemoveAppFromSpaceHttpError
1554
1886
  */
@@ -1565,6 +1897,7 @@ type RemoveAppFromSpaceHttpError = {
1565
1897
  };
1566
1898
  /**
1567
1899
  * Sets space on a specific app.
1900
+ *
1568
1901
  * @param appId Identifier of the app.
1569
1902
  * @param body an object with the body content
1570
1903
  * @throws MoveAppToSpaceHttpError
@@ -1640,6 +1973,7 @@ declare function clearCache(): void;
1640
1973
  interface AppsAPI {
1641
1974
  /**
1642
1975
  * Creates a new app.
1976
+ *
1643
1977
  * @param body an object with the body content
1644
1978
  * @throws CreateAppHttpError
1645
1979
  */
@@ -1658,9 +1992,9 @@ interface AppsAPI {
1658
1992
  *
1659
1993
  * @param baseid Id of the baseline evaluation
1660
1994
  * @param comparisonid Id of the comparison evaluation
1661
- * @throws GetAppEvaluationComparisonXMLHttpError
1995
+ * @throws GetAppEvaluationComparisonXmlHttpError
1662
1996
  */
1663
- getAppEvaluationComparisonXML: typeof getAppEvaluationComparisonXML;
1997
+ getAppEvaluationComparisonXml: typeof getAppEvaluationComparisonXml;
1664
1998
  /**
1665
1999
  * Find an evaluation by a specific id.
1666
2000
  *
@@ -1673,11 +2007,12 @@ interface AppsAPI {
1673
2007
  * Find and download an evaluation log by a specific evaluation id.
1674
2008
  *
1675
2009
  * @param id Id of the desired evaluation.
1676
- * @throws GetAppEvaluationXMLHttpError
2010
+ * @throws GetAppEvaluationXmlHttpError
1677
2011
  */
1678
- getAppEvaluationXML: typeof getAppEvaluationXML;
2012
+ getAppEvaluationXml: typeof getAppEvaluationXml;
1679
2013
  /**
1680
2014
  * Imports an app into the system.
2015
+ *
1681
2016
  * @param query an object with query parameters
1682
2017
  * @param body an object with the body content
1683
2018
  * @throws ImportAppHttpError
@@ -1685,23 +2020,27 @@ interface AppsAPI {
1685
2020
  importApp: typeof importApp;
1686
2021
  /**
1687
2022
  * 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
2023
+ *
2024
+ * @throws GetAppsPrivilegesHttpError
1689
2025
  */
1690
- getAppPrivileges: typeof getAppPrivileges;
2026
+ getAppsPrivileges: typeof getAppsPrivileges;
1691
2027
  /**
1692
2028
  * Deletes a specific app.
2029
+ *
1693
2030
  * @param appId Identifier of the app.
1694
2031
  * @throws DeleteAppHttpError
1695
2032
  */
1696
2033
  deleteApp: typeof deleteApp;
1697
2034
  /**
1698
2035
  * Retrieves information for a specific app.
2036
+ *
1699
2037
  * @param appId Identifier of the app.
1700
2038
  * @throws GetAppInfoHttpError
1701
2039
  */
1702
2040
  getAppInfo: typeof getAppInfo;
1703
2041
  /**
1704
2042
  * Updates the information for a specific app.
2043
+ *
1705
2044
  * @param appId Identifier of the app.
1706
2045
  * @param body an object with the body content
1707
2046
  * @throws UpdateAppInfoHttpError
@@ -1709,6 +2048,7 @@ interface AppsAPI {
1709
2048
  updateAppInfo: typeof updateAppInfo;
1710
2049
  /**
1711
2050
  * Copies a specific app.
2051
+ *
1712
2052
  * @param appId Identifier of the app.
1713
2053
  * @param body an object with the body content
1714
2054
  * @throws CopyAppHttpError
@@ -1717,6 +2057,7 @@ interface AppsAPI {
1717
2057
  /**
1718
2058
  * Retrieves the lineage for an app.
1719
2059
  * Returns a JSON-formatted array of strings describing the lineage of the app.
2060
+ *
1720
2061
  * @param appId Identifier of the app.
1721
2062
  * @throws GetAppDataLineageHttpError
1722
2063
  */
@@ -1724,12 +2065,14 @@ interface AppsAPI {
1724
2065
  /**
1725
2066
  * Retrieves the data model and reload statistics metadata of an app.
1726
2067
  * An empty metadata structure is returned if the metadata is not available in the app.
2068
+ *
1727
2069
  * @param appId Identifier of the app.
1728
2070
  * @throws GetAppDataMetadataHttpError
1729
2071
  */
1730
2072
  getAppDataMetadata: typeof getAppDataMetadata;
1731
2073
  /**
1732
2074
  * Exports a specific app.
2075
+ *
1733
2076
  * @param appId Identifier of the app.
1734
2077
  * @param query an object with query parameters
1735
2078
  * @throws ExportAppHttpError
@@ -1737,12 +2080,14 @@ interface AppsAPI {
1737
2080
  exportApp: typeof exportApp;
1738
2081
  /**
1739
2082
  * 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.
2083
+ *
1740
2084
  * @param appId Qlik Sense app identifier
1741
2085
  * @throws GetAppInsightAnalysesHttpError
1742
2086
  */
1743
2087
  getAppInsightAnalyses: typeof getAppInsightAnalyses;
1744
2088
  /**
1745
2089
  * 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.
2090
+ *
1746
2091
  * @param appId Qlik Sense app identifier
1747
2092
  * @param body an object with the body content
1748
2093
  * @throws GetAppInsightAnalysisRecommendationsHttpError
@@ -1750,6 +2095,7 @@ interface AppsAPI {
1750
2095
  getAppInsightAnalysisRecommendations: typeof getAppInsightAnalysisRecommendations;
1751
2096
  /**
1752
2097
  * 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.
2098
+ *
1753
2099
  * @param appId Qlik Sense app identifier
1754
2100
  * @throws GetAppInsightAnalysisModelHttpError
1755
2101
  */
@@ -1757,6 +2103,7 @@ interface AppsAPI {
1757
2103
  /**
1758
2104
  * Deletes a media content file or complete directory.
1759
2105
  * 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.
2106
+ *
1760
2107
  * @param appId Unique application identifier.
1761
2108
  * @param path Path to file content.
1762
2109
  * @throws DeleteAppMediaHttpError
@@ -1765,6 +2112,7 @@ interface AppsAPI {
1765
2112
  /**
1766
2113
  * Gets media content from file.
1767
2114
  * Returns a stream of bytes containing the media file content on success, or error if file is not found.
2115
+ *
1768
2116
  * @param appId Unique application identifier.
1769
2117
  * @param path Path to file content.
1770
2118
  * @throws GetAppMediaHttpError
@@ -1773,6 +2121,7 @@ interface AppsAPI {
1773
2121
  /**
1774
2122
  * Stores the media content file.
1775
2123
  * 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.
2124
+ *
1776
2125
  * @param appId Unique application identifier.
1777
2126
  * @param path Path to file content.
1778
2127
  * @param body an object with the body content
@@ -1782,6 +2131,7 @@ interface AppsAPI {
1782
2131
  /**
1783
2132
  * Lists media content.
1784
2133
  * Returns a JSON formatted array of strings describing the available media content or error if the optional path supplied is not found.
2134
+ *
1785
2135
  * @param appId Unique application identifier.
1786
2136
  * @param path The path to sub folder with static content relative to the root folder. Use empty path to access the root folder.
1787
2137
  * @param query an object with query parameters
@@ -1792,12 +2142,15 @@ interface AppsAPI {
1792
2142
  * Gets media content from file currently used as application thumbnail.
1793
2143
  * Returns a stream of bytes containing the media file content on success, or error if file is not found.
1794
2144
  * The image selected as thumbnail is only updated when application is saved.
2145
+ *
1795
2146
  * @param appId Unique application identifier.
1796
2147
  * @throws GetAppThumbnailHttpError
1797
2148
  */
1798
2149
  getAppThumbnail: typeof getAppThumbnail;
1799
2150
  /**
1800
2151
  * Sets owner on an app object.
2152
+ * The user must be the owner of the object.
2153
+ *
1801
2154
  * @param appId Identifier of the app.
1802
2155
  * @param objectId Identifier of the object.
1803
2156
  * @param body an object with the body content
@@ -1806,6 +2159,7 @@ interface AppsAPI {
1806
2159
  updateAppObjectOwner: typeof updateAppObjectOwner;
1807
2160
  /**
1808
2161
  * Changes owner of the app.
2162
+ *
1809
2163
  * @param appId Identifier of the app.
1810
2164
  * @param body an object with the body content
1811
2165
  * @throws UpdateAppOwnerHttpError
@@ -1813,6 +2167,7 @@ interface AppsAPI {
1813
2167
  updateAppOwner: typeof updateAppOwner;
1814
2168
  /**
1815
2169
  * Publishes a specific app to a managed space.
2170
+ *
1816
2171
  * @param appId Identifier of the app.
1817
2172
  * @param body an object with the body content
1818
2173
  * @throws PublishAppHttpError
@@ -1820,6 +2175,7 @@ interface AppsAPI {
1820
2175
  publishApp: typeof publishApp;
1821
2176
  /**
1822
2177
  * Republishes a published app to a managed space.
2178
+ *
1823
2179
  * @param appId Identifier of the app.
1824
2180
  * @param body an object with the body content
1825
2181
  * @throws RepublishAppHttpError
@@ -1828,6 +2184,7 @@ interface AppsAPI {
1828
2184
  /**
1829
2185
  * Retrieves the metadata about all script logs stored for an app.
1830
2186
  * Returns an array of ScriptLogMeta objects.
2187
+ *
1831
2188
  * @param appId Identifier of the app.
1832
2189
  * @throws GetAppReloadLogsHttpError
1833
2190
  */
@@ -1835,14 +2192,66 @@ interface AppsAPI {
1835
2192
  /**
1836
2193
  * Retrieves the log of a specific reload.
1837
2194
  * Returns the log as "text/plain; charset=UTF-8".
2195
+ *
1838
2196
  * @param appId Identifier of the app.
1839
2197
  * @param reloadId Identifier of the reload.
1840
2198
  * @throws GetAppReloadLogHttpError
1841
2199
  */
1842
2200
  getAppReloadLog: typeof getAppReloadLog;
2201
+ /**
2202
+ * Retrieves the app reload metadata list.
2203
+ * Reload metadata contains reload information, including reload id, duration, endtime and lineage load info.
2204
+ *
2205
+ * @param appId Identifier of the app
2206
+ * @param reloadId Identifier of the reload. Use empty reloadId to get all reloads.
2207
+ * @param query an object with query parameters
2208
+ * @throws GetAppReloadMetadataHttpError
2209
+ */
2210
+ getAppReloadMetadata: typeof getAppReloadMetadata;
2211
+ /**
2212
+ * 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.
2213
+ *
2214
+ * @param appId Qlik Sense app identifier
2215
+ * @param query an object with query parameters
2216
+ * @throws GetAppReportFiltersHttpError
2217
+ */
2218
+ getAppReportFilters: typeof getAppReportFilters;
2219
+ /**
2220
+ * Creates a new report filter which is used to re-apply selections, variables, patches to an engine session.
2221
+ *
2222
+ * @param appId Qlik Sense app identifier
2223
+ * @param body an object with the body content
2224
+ * @throws CreateAppReportFilterHttpError
2225
+ */
2226
+ createAppReportFilter: typeof createAppReportFilter;
2227
+ /**
2228
+ * Get the number of filters for the given app and filter types
2229
+ *
2230
+ * @param appId Qlik Sense app identifier
2231
+ * @param query an object with query parameters
2232
+ * @throws CountAppReportFiltersHttpError
2233
+ */
2234
+ countAppReportFilters: typeof countAppReportFilters;
2235
+ /**
2236
+ * Delete a filter
2237
+ *
2238
+ * @param appId Qlik Sense app identifier
2239
+ * @param id The filter id identifier (bookmarkId).
2240
+ * @throws DeleteAppReportFilterHttpError
2241
+ */
2242
+ deleteAppReportFilter: typeof deleteAppReportFilter;
2243
+ /**
2244
+ * Get a filter
2245
+ *
2246
+ * @param appId Qlik Sense app identifier
2247
+ * @param id The filter id identifier (bookmarkId).
2248
+ * @throws GetAppReportFilterHttpError
2249
+ */
2250
+ getAppReportFilter: typeof getAppReportFilter;
1843
2251
  /**
1844
2252
  * Retrieves the script history for an app.
1845
2253
  * Returns information about the saved versions of the script.
2254
+ *
1846
2255
  * @param appId Identifier of the app.
1847
2256
  * @param query an object with query parameters
1848
2257
  * @throws GetAppScriptHistoryHttpError
@@ -1850,6 +2259,7 @@ interface AppsAPI {
1850
2259
  getAppScriptHistory: typeof getAppScriptHistory;
1851
2260
  /**
1852
2261
  * Sets script for an app.
2262
+ *
1853
2263
  * @param appId Identifier of the app.
1854
2264
  * @param body an object with the body content
1855
2265
  * @throws UpdateAppScriptHttpError
@@ -1858,6 +2268,7 @@ interface AppsAPI {
1858
2268
  /**
1859
2269
  * Deletes a specific version of the script for an app.
1860
2270
  * Fails if the version to delete is the current version.
2271
+ *
1861
2272
  * @param appId Identifier of the app.
1862
2273
  * @param version Identifier of the script version
1863
2274
  * @throws DeleteAppScriptHttpError
@@ -1866,6 +2277,7 @@ interface AppsAPI {
1866
2277
  /**
1867
2278
  * Retrieves a version of the script for an app.
1868
2279
  * Returns the script text.
2280
+ *
1869
2281
  * @param appId Identifier of the app.
1870
2282
  * @param version Identifier of the script version, or 'current' for retrieving the current version.
1871
2283
  * @throws GetAppScriptHttpError
@@ -1873,6 +2285,7 @@ interface AppsAPI {
1873
2285
  getAppScript: typeof getAppScript;
1874
2286
  /**
1875
2287
  * Updates a specific version of the script for an app.
2288
+ *
1876
2289
  * @param appId Identifier of the app.
1877
2290
  * @param version Identifier of the script version.
1878
2291
  * @param body an object with the body content
@@ -1881,12 +2294,14 @@ interface AppsAPI {
1881
2294
  patchAppScript: typeof patchAppScript;
1882
2295
  /**
1883
2296
  * Removes space from a specific app.
2297
+ *
1884
2298
  * @param appId Identifier of the app.
1885
2299
  * @throws RemoveAppFromSpaceHttpError
1886
2300
  */
1887
2301
  removeAppFromSpace: typeof removeAppFromSpace;
1888
2302
  /**
1889
2303
  * Sets space on a specific app.
2304
+ *
1890
2305
  * @param appId Identifier of the app.
1891
2306
  * @param body an object with the body content
1892
2307
  * @throws MoveAppToSpaceHttpError
@@ -1918,4 +2333,4 @@ interface AppsAPI {
1918
2333
  */
1919
2334
  declare const appsExport: AppsAPI;
1920
2335
 
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 };
2336
+ 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 CountAppReportFiltersHttpError, type CountAppReportFiltersHttpResponse, type CreateApp, type CreateAppHttpError, type CreateAppHttpResponse, type CreateAppReportFilterHttpError, type CreateAppReportFilterHttpResponse, type DataModelMetadata, type DeleteAppHttpError, type DeleteAppHttpResponse, type DeleteAppMediaHttpError, type DeleteAppMediaHttpResponse, type DeleteAppReportFilterHttpError, type DeleteAppReportFilterHttpResponse, 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 Filter, type FilterError, type FilterErrors, type FilterField, type FilterFieldValue, type FilterList, type FilterListItem, type FilterRequest, type FilterType, type FilterV10, type FilterVariable, type FiltersCount, type Float64, 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 GetAppReloadLogHttpError, type GetAppReloadLogHttpResponse, type GetAppReloadLogsHttpError, type GetAppReloadLogsHttpResponse, type GetAppReloadMetadataHttpError, type GetAppReloadMetadataHttpResponse, type GetAppReportFilterHttpError, type GetAppReportFilterHttpResponse, type GetAppReportFiltersHttpError, type GetAppReportFiltersHttpResponse, type GetAppScriptHistoryHttpError, type GetAppScriptHistoryHttpResponse, type GetAppScriptHttpError, type GetAppScriptHttpResponse, type GetAppThumbnailHttpError, type GetAppThumbnailHttpResponse, type GetAppsPrivilegesHttpError, type GetAppsPrivilegesHttpResponse, type HardwareMeta, type Href, type ImportAppHttpError, type ImportAppHttpResponse, type JsonObject, type LastReloadMetadata, type LineageInfoRest, type LinkResponse, type Links, type LinksResponse, 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 ReloadListMetadata, type ReloadMeta, type ReloadStatements, 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, 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, patchAppScript, publishApp, queueAppEvaluation, removeAppFromSpace, republishApp, updateAppInfo, updateAppObjectOwner, updateAppOwner, updateAppScript, uploadAppMedia };