@qlik/api 2.3.0 → 2.4.0

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 (167) hide show
  1. package/analytics/change-stores.d.ts +40 -76
  2. package/analytics/change-stores.js +9 -10
  3. package/analytics.d.ts +1 -2
  4. package/analytics.js +5 -6
  5. package/api-keys.d.ts +46 -100
  6. package/api-keys.js +3 -4
  7. package/apps.d.ts +334 -461
  8. package/apps.js +74 -6
  9. package/assistants.d.ts +172 -337
  10. package/assistants.js +3 -4
  11. package/audits.d.ts +41 -85
  12. package/audits.js +3 -4
  13. package/auth-types.d.ts +110 -1
  14. package/auth-types.js +22 -1
  15. package/auth.d.ts +1 -2
  16. package/auth.js +1 -1
  17. package/automation-connections.d.ts +44 -95
  18. package/automation-connections.js +3 -4
  19. package/automation-connectors.d.ts +10 -20
  20. package/automation-connectors.js +3 -4
  21. package/automations.d.ts +54 -112
  22. package/automations.js +3 -4
  23. package/automl-deployments.d.ts +17 -36
  24. package/automl-deployments.js +3 -4
  25. package/automl-predictions.d.ts +12 -24
  26. package/automl-predictions.js +3 -4
  27. package/banners.d.ts +8 -14
  28. package/banners.js +3 -4
  29. package/brands.d.ts +19 -39
  30. package/brands.js +3 -4
  31. package/chunks/auth-B8lJw7rm.js +31 -0
  32. package/chunks/{interceptors-DipDBQQ5.js → boot-interceptors-DqRxTczb.js} +296 -248
  33. package/chunks/{chunk-D3vHIbds.js → chunk-BdHzlgOL.js} +3 -3
  34. package/chunks/{invoke-fetch-B7lGscuQ.js → invoke-fetch-DMAi6Fg3.js} +3 -3
  35. package/chunks/{invoke-fetch-DhdyFZ0F.js → invoke-fetch-pMN6iqup.js} +2 -3
  36. package/chunks/platform-types-CECrZkOF.d.ts +29 -0
  37. package/chunks/{public-runtime-modules-QhLPeQr5.js → public-runtime-modules-2KfyI2qM.js} +5 -5
  38. package/chunks/{qix-RCUslia8.js → qix-BdNrIA4s.js} +19 -20
  39. package/chunks/{qix-chunk-entrypoint-WAS4NVTf.js → qix-chunk-entrypoint-L9RpWwLK.js} +52 -58
  40. package/chunks/{qix-CrqXv44x.d.ts → qix-types-y_di0roE.d.ts} +33 -115
  41. package/collections.d.ts +67 -144
  42. package/collections.js +3 -4
  43. package/conditions.d.ts +87 -190
  44. package/conditions.js +3 -4
  45. package/consumption.d.ts +35 -72
  46. package/consumption.js +3 -4
  47. package/core/ip-policies.d.ts +43 -93
  48. package/core/ip-policies.js +5 -6
  49. package/core.d.ts +1 -2
  50. package/core.js +5 -6
  51. package/csp-origins.d.ts +42 -85
  52. package/csp-origins.js +3 -4
  53. package/csrf-token.d.ts +6 -11
  54. package/csrf-token.js +3 -4
  55. package/data-alerts.d.ts +152 -325
  56. package/data-alerts.js +3 -4
  57. package/data-assets.d.ts +16 -31
  58. package/data-assets.js +3 -4
  59. package/data-connections.d.ts +123 -257
  60. package/data-connections.js +3 -4
  61. package/data-credentials.d.ts +36 -76
  62. package/data-credentials.js +3 -4
  63. package/data-files.d.ts +60 -121
  64. package/data-files.js +3 -4
  65. package/data-governance/data-products.d.ts +429 -0
  66. package/data-governance/data-products.js +212 -0
  67. package/data-governance.d.ts +13 -0
  68. package/data-governance.js +12 -0
  69. package/data-qualities.d.ts +11 -25
  70. package/data-qualities.js +3 -4
  71. package/data-sets.d.ts +28 -57
  72. package/data-sets.js +3 -4
  73. package/data-sources.d.ts +45 -97
  74. package/data-sources.js +3 -4
  75. package/data-stores.d.ts +53 -107
  76. package/data-stores.js +3 -4
  77. package/dcaas.d.ts +32 -67
  78. package/dcaas.js +3 -4
  79. package/di-projects.d.ts +111 -136
  80. package/di-projects.js +25 -4
  81. package/direct-access-agents.d.ts +29 -63
  82. package/direct-access-agents.js +3 -4
  83. package/encryption.d.ts +28 -59
  84. package/encryption.js +3 -4
  85. package/extensions.d.ts +35 -73
  86. package/extensions.js +3 -4
  87. package/global-types.d.ts +139 -1
  88. package/glossaries.d.ts +75 -158
  89. package/glossaries.js +3 -4
  90. package/groups.d.ts +58 -125
  91. package/groups.js +3 -4
  92. package/identity-providers.d.ts +148 -324
  93. package/identity-providers.js +3 -4
  94. package/index.d.ts +18 -4
  95. package/index.js +64 -19
  96. package/interceptors.d.ts +2 -3
  97. package/interceptors.js +104 -2
  98. package/invoke-fetch-types.d.ts +97 -1
  99. package/items.d.ts +85 -181
  100. package/items.js +3 -4
  101. package/knowledgebases.d.ts +137 -270
  102. package/knowledgebases.js +3 -4
  103. package/licenses.d.ts +71 -153
  104. package/licenses.js +3 -4
  105. package/lineage-graphs.d.ts +39 -85
  106. package/lineage-graphs.js +3 -4
  107. package/ml.d.ts +290 -621
  108. package/ml.js +3 -4
  109. package/notes.d.ts +9 -18
  110. package/notes.js +3 -4
  111. package/notifications.d.ts +14 -30
  112. package/notifications.js +3 -4
  113. package/oauth-clients.d.ts +98 -159
  114. package/oauth-clients.js +4 -5
  115. package/oauth-tokens.d.ts +16 -33
  116. package/oauth-tokens.js +3 -4
  117. package/package.json +6 -4
  118. package/qix.d.ts +46 -2
  119. package/qix.js +2 -3
  120. package/questions.d.ts +53 -110
  121. package/questions.js +3 -4
  122. package/quotas.d.ts +13 -26
  123. package/quotas.js +3 -4
  124. package/reload-tasks.d.ts +23 -46
  125. package/reload-tasks.js +3 -4
  126. package/reloads.d.ts +26 -52
  127. package/reloads.js +3 -4
  128. package/report-templates.d.ts +30 -63
  129. package/report-templates.js +3 -4
  130. package/reports.d.ts +111 -238
  131. package/reports.js +3 -4
  132. package/roles.d.ts +36 -77
  133. package/roles.js +3 -4
  134. package/sharing-tasks.d.ts +201 -427
  135. package/sharing-tasks.js +3 -4
  136. package/spaces.d.ts +71 -157
  137. package/spaces.js +3 -4
  138. package/tasks.d.ts +76 -164
  139. package/tasks.js +3 -4
  140. package/temp-contents.d.ts +17 -35
  141. package/temp-contents.js +3 -4
  142. package/tenant-settings.d.ts +298 -0
  143. package/tenant-settings.js +107 -0
  144. package/tenants.d.ts +31 -67
  145. package/tenants.js +3 -4
  146. package/themes.d.ts +27 -55
  147. package/themes.js +3 -4
  148. package/transports.d.ts +46 -106
  149. package/transports.js +3 -4
  150. package/ui-config.d.ts +8 -17
  151. package/ui-config.js +3 -4
  152. package/users.d.ts +80 -170
  153. package/users.js +3 -4
  154. package/web-integrations.d.ts +38 -83
  155. package/web-integrations.js +3 -4
  156. package/web-notifications.d.ts +14 -29
  157. package/web-notifications.js +3 -4
  158. package/webhooks.d.ts +77 -162
  159. package/webhooks.js +3 -4
  160. package/chunks/auth-BowS4SUR.js +0 -28
  161. package/chunks/auth-types-YrlH_R9f.d.ts +0 -416
  162. package/chunks/auth-types-h43TVDpB.js +0 -24
  163. package/chunks/global-types-CEVAJebk.js +0 -1
  164. /package/chunks/{dist-n3iOVn1W.js → dist-DR758NU5.js} +0 -0
  165. /package/chunks/{invoke-fetch-C1Z0RJYU.d.ts → invoke-fetch-DFc3yzaj.d.ts} +0 -0
  166. /package/chunks/{utils-vv-xFm06.js → utils-jkpLuYZR.js} +0 -0
  167. /package/chunks/{websocket-errors-CRTDTtBL.js → websocket-errors-C5U1tba-.js} +0 -0
package/banners.js CHANGED
@@ -1,5 +1,5 @@
1
- import "./chunks/public-runtime-modules-QhLPeQr5.js";
2
- import { n as invokeFetch, t as clearApiCache } from "./chunks/invoke-fetch-B7lGscuQ.js";
1
+ import "./chunks/public-runtime-modules-2KfyI2qM.js";
2
+ import { n as invokeFetch, t as clearApiCache } from "./chunks/invoke-fetch-DMAi6Fg3.js";
3
3
 
4
4
  //#region src/public/rest/banners.ts
5
5
  /**
@@ -43,7 +43,6 @@ const bannersExport = {
43
43
  upsertBanners,
44
44
  clearCache
45
45
  };
46
- var banners_default = bannersExport;
47
46
 
48
47
  //#endregion
49
- export { clearCache, banners_default as default, getBanners, upsertBanners };
48
+ export { clearCache, bannersExport as default, getBanners, upsertBanners };
package/brands.d.ts CHANGED
@@ -1,24 +1,19 @@
1
- import { S as DownloadableBlob, y as ApiCallOptions } from "./chunks/auth-types-YrlH_R9f.js";
2
- import "./chunks/invoke-fetch-C1Z0RJYU.js";
1
+ import { ApiCallOptions, DownloadableBlob } from "./invoke-fetch-types.js";
2
+ import "./chunks/invoke-fetch-DFc3yzaj.js";
3
3
 
4
4
  //#region src/public/rest/brands.d.ts
5
5
  /**
6
6
  * A brand is a collection of assets for applying custom branding. Only a single brand can be active in a tenant.
7
7
  */
8
8
  type Brand = {
9
- readonly active?: boolean;
10
- /** The UTC timestamp when the brand was created. */
11
- readonly createdAt?: string;
12
- /** ID of a user that created the brand. */
9
+ readonly active?: boolean; /** The UTC timestamp when the brand was created. */
10
+ readonly createdAt?: string; /** ID of a user that created the brand. */
13
11
  readonly createdBy?: string;
14
- description: string;
15
- /** Collection of resources that make up the brand. */
12
+ description: string; /** Collection of resources that make up the brand. */
16
13
  files: BrandFile[];
17
14
  readonly id: string;
18
- name: string;
19
- /** The UTC timestamp when the brand was last updated. */
20
- readonly updatedAt?: string;
21
- /** ID of a user that last updated the brand. */
15
+ name: string; /** The UTC timestamp when the brand was last updated. */
16
+ readonly updatedAt?: string; /** ID of a user that last updated the brand. */
22
17
  readonly updatedBy?: string;
23
18
  };
24
19
  /**
@@ -34,11 +29,8 @@ type BrandFile = {
34
29
  * A JSON Patch document as defined in https://datatracker.ietf.org/doc/html/rfc6902.
35
30
  */
36
31
  type BrandPatch = {
37
- /** The operation to be performed. */
38
- op: "add" | "remove" | "replace";
39
- /** The path for the given resource field to patch. */
40
- path: "/name" | "/description";
41
- /** The value to be used for this operation. */
32
+ /** The operation to be performed. */op: "add" | "remove" | "replace"; /** The path for the given resource field to patch. */
33
+ path: "/name" | "/description"; /** The value to be used for this operation. */
42
34
  value?: string;
43
35
  };
44
36
  /**
@@ -93,8 +85,7 @@ type ErrorResponse500 = {
93
85
  traceId?: string;
94
86
  };
95
87
  type Link = {
96
- /** URL of a resource request. */
97
- href: string;
88
+ /** URL of a resource request. */href: string;
98
89
  };
99
90
  /**
100
91
  * Empty object inferring lack of active branding.
@@ -107,13 +98,9 @@ type NoActiveBrand = unknown;
107
98
  * @throws GetBrandsHttpError
108
99
  */
109
100
  declare function getBrands(query: {
110
- /** Cursor to previous. */
111
- endingBefore?: string;
112
- /** Maximum number of brands to retrieve. */
113
- limit?: number;
114
- /** Field to sort by, prefixed with -/+ to indicate the order. */
115
- sort?: "id" | "+id" | "-id" | "createdAt" | "+createdAt" | "-createdAt" | "updatedAt" | "+updatedAt" | "-updatedAt";
116
- /** Cursor to the next page. */
101
+ /** Cursor to previous. */endingBefore?: string; /** Maximum number of brands to retrieve. */
102
+ limit?: number; /** Field to sort by, prefixed with -/+ to indicate the order. */
103
+ sort?: "id" | "+id" | "-id" | "createdAt" | "+createdAt" | "-createdAt" | "updatedAt" | "+updatedAt" | "-updatedAt"; /** Cursor to the next page. */
117
104
  startingAfter?: string;
118
105
  }, options?: ApiCallOptions): Promise<GetBrandsHttpResponse>;
119
106
  type GetBrandsHttpResponse = {
@@ -151,15 +138,10 @@ type GetBrands500HttpError = {
151
138
  * @throws CreateBrandHttpError
152
139
  */
153
140
  declare function createBrand(body: {
154
- /** Description of the brand. */
155
- description?: string;
156
- /** The path and name of a properly formatted ICO file. Maximum size is 100 KB. */
157
- favIcon?: BodyInit;
158
- /** The path and name of a JPG or PNG file that will be adjusted to fit in a 'box' measuring 109px in width and 62 px in height while maintaining aspect ratio. Maximum size of 300 KB, but smaller is recommended. */
159
- logo?: BodyInit;
160
- /** Name of the brand. */
161
- name: string;
162
- /** The path and name of a JSON file to define brand style settings. Maximum size is 100 KB. This property is not currently operational. */
141
+ /** Description of the brand. */description?: string; /** The path and name of a properly formatted ICO file. Maximum size is 100 KB. */
142
+ favIcon?: BodyInit; /** The path and name of a JPG or PNG file that will be adjusted to fit in a 'box' measuring 109px in width and 62 px in height while maintaining aspect ratio. Maximum size of 300 KB, but smaller is recommended. */
143
+ logo?: BodyInit; /** Name of the brand. */
144
+ name: string; /** The path and name of a JSON file to define brand style settings. Maximum size is 100 KB. This property is not currently operational. */
163
145
  styles?: BodyInit;
164
146
  }, options?: ApiCallOptions): Promise<CreateBrandHttpResponse>;
165
147
  type CreateBrandHttpResponse = {
@@ -484,8 +466,7 @@ type GetBrandFile500HttpError = {
484
466
  * @throws CreateBrandFileHttpError
485
467
  */
486
468
  declare function createBrandFile(brandId: string, brandFileId: string, body: {
487
- /** The path and name of a file to upload. */
488
- file?: BodyInit;
469
+ /** The path and name of a file to upload. */file?: BodyInit;
489
470
  }, options?: ApiCallOptions): Promise<CreateBrandFileHttpResponse>;
490
471
  type CreateBrandFileHttpResponse = {
491
472
  data: BrandFile;
@@ -527,8 +508,7 @@ type CreateBrandFile500HttpError = {
527
508
  * @throws UpdateBrandFileHttpError
528
509
  */
529
510
  declare function updateBrandFile(brandId: string, brandFileId: string, body: {
530
- /** A file to upload. */
531
- file?: BodyInit;
511
+ /** A file to upload. */file?: BodyInit;
532
512
  }, options?: ApiCallOptions): Promise<UpdateBrandFileHttpResponse>;
533
513
  type UpdateBrandFileHttpResponse = {
534
514
  data: BrandFile;
package/brands.js CHANGED
@@ -1,5 +1,5 @@
1
- import "./chunks/public-runtime-modules-QhLPeQr5.js";
2
- import { n as invokeFetch, t as clearApiCache } from "./chunks/invoke-fetch-B7lGscuQ.js";
1
+ import "./chunks/public-runtime-modules-2KfyI2qM.js";
2
+ import { n as invokeFetch, t as clearApiCache } from "./chunks/invoke-fetch-DMAi6Fg3.js";
3
3
 
4
4
  //#region src/public/rest/brands.ts
5
5
  /**
@@ -222,7 +222,6 @@ const brandsExport = {
222
222
  updateBrandFile,
223
223
  clearCache
224
224
  };
225
- var brands_default = brandsExport;
226
225
 
227
226
  //#endregion
228
- export { activateBrand, clearCache, createBrand, createBrandFile, deactivateBrand, brands_default as default, deleteBrand, deleteBrandFile, getActiveBrand, getBrand, getBrandFile, getBrands, patchBrand, updateBrandFile };
227
+ export { activateBrand, clearCache, createBrand, createBrandFile, deactivateBrand, brandsExport as default, deleteBrand, deleteBrandFile, getActiveBrand, getBrand, getBrandFile, getBrands, patchBrand, updateBrandFile };
@@ -0,0 +1,31 @@
1
+ import { C as AuthorizationError, E as UnexpectedAuthTypeError, S as unregisterHostConfig, T as InvalidHostConfigError, _ as registerHostConfig, a as getRestCallAuthParams, b as toValidLocationUrl, c as handleAuthenticationError, d as logout, f as normalizeHostConfig, g as registerAuthModule, h as onPageRedirectStarted, i as getDefaultHostConfig, l as isHostCrossOrigin, m as onPageRedirectRequested, n as determineAuthType, o as getWebResourceAuthParams, p as onFatalAuthError, r as getAccessToken, s as getWebSocketAuthParams, u as isWindows, v as serializeHostConfig, w as InvalidAuthTypeError, x as toValidWebsocketLocationUrl, y as setDefaultHostConfig } from "./boot-interceptors-DqRxTczb.js";
2
+
3
+ //#region src/auth/auth.ts
4
+ /**
5
+ * Provides functionalities for authentication with Qlik backends.
6
+ */
7
+ const auth = {
8
+ determineAuthType,
9
+ getDefaultHostConfig,
10
+ getRestCallAuthParams,
11
+ getWebResourceAuthParams,
12
+ getWebSocketAuthParams,
13
+ handleAuthenticationError,
14
+ isHostCrossOrigin,
15
+ isWindows,
16
+ logout,
17
+ registerAuthModule,
18
+ registerHostConfig,
19
+ serializeHostConfig,
20
+ setDefaultHostConfig,
21
+ toValidLocationUrl,
22
+ toValidWebsocketLocationUrl,
23
+ unregisterHostConfig,
24
+ normalizeHostConfig,
25
+ onFatalAuthError,
26
+ onPageRedirectRequested,
27
+ onPageRedirectStarted
28
+ };
29
+
30
+ //#endregion
31
+ export { AuthorizationError, InvalidAuthTypeError, InvalidHostConfigError, UnexpectedAuthTypeError, auth as default, determineAuthType, getAccessToken, getDefaultHostConfig, getRestCallAuthParams, getWebResourceAuthParams, getWebSocketAuthParams, handleAuthenticationError, isHostCrossOrigin, isWindows, logout, normalizeHostConfig, onFatalAuthError, onPageRedirectRequested, onPageRedirectStarted, registerAuthModule, registerHostConfig, serializeHostConfig, setDefaultHostConfig, toValidLocationUrl, toValidWebsocketLocationUrl, unregisterHostConfig };