@qlik/api 2.2.0 → 2.3.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 (231) hide show
  1. package/analytics/change-stores.d.ts +386 -0
  2. package/analytics/change-stores.js +123 -0
  3. package/analytics.d.ts +14 -0
  4. package/analytics.js +13 -0
  5. package/api-keys.d.ts +362 -3
  6. package/api-keys.js +2 -3
  7. package/apps.d.ts +2673 -3
  8. package/apps.js +2 -3
  9. package/assistants.d.ts +1370 -3
  10. package/assistants.js +2 -3
  11. package/audits.d.ts +318 -3
  12. package/audits.js +4 -4
  13. package/auth-types.d.ts +1 -1
  14. package/auth-types.js +1 -2
  15. package/auth.d.ts +94 -2
  16. package/auth.js +63 -3
  17. package/automation-connections.d.ts +366 -3
  18. package/automation-connections.js +2 -3
  19. package/automation-connectors.d.ts +84 -3
  20. package/automation-connectors.js +2 -3
  21. package/automations.d.ts +805 -3
  22. package/automations.js +2 -3
  23. package/automl-deployments.d.ts +101 -3
  24. package/automl-deployments.js +2 -3
  25. package/automl-predictions.d.ts +238 -3
  26. package/automl-predictions.js +2 -3
  27. package/banners.d.ts +184 -3
  28. package/banners.js +2 -3
  29. package/brands.d.ts +670 -3
  30. package/brands.js +2 -3
  31. package/chunks/{auth-Cle0_tmz.js → auth-BowS4SUR.js} +1 -5
  32. package/chunks/{chunk-EtTptKIv.js → chunk-D3vHIbds.js} +2 -2
  33. package/chunks/{dist-gXLIqDJW.js → dist-n3iOVn1W.js} +4 -4
  34. package/chunks/{auth-functions-BmZgZYSs.js → interceptors-DipDBQQ5.js} +258 -54
  35. package/chunks/{invoke-fetch-PcVIxLW4.js → invoke-fetch-B7lGscuQ.js} +3 -3
  36. package/chunks/{invoke-fetch-CucBpA1C.js → invoke-fetch-DhdyFZ0F.js} +1 -5
  37. package/chunks/{public-runtime-modules-Dwjzb3l8.js → public-runtime-modules-QhLPeQr5.js} +7 -7
  38. package/chunks/{qix-DI5o5XF4.d.ts → qix-CrqXv44x.d.ts} +6 -2
  39. package/chunks/{qix-DjxuPCX0.js → qix-RCUslia8.js} +11 -10
  40. package/chunks/{qix-chunk-entrypoint-tmTo-kpa.js → qix-chunk-entrypoint-WAS4NVTf.js} +48 -50
  41. package/collections.d.ts +582 -3
  42. package/collections.js +2 -3
  43. package/conditions.d.ts +662 -3
  44. package/conditions.js +2 -3
  45. package/consumption.d.ts +182 -3
  46. package/consumption.js +2 -3
  47. package/core/ip-policies.d.ts +328 -4
  48. package/core/ip-policies.js +108 -5
  49. package/core.d.ts +13 -4
  50. package/core.js +3 -4
  51. package/csp-origins.d.ts +273 -3
  52. package/csp-origins.js +2 -3
  53. package/csrf-token.d.ts +62 -3
  54. package/csrf-token.js +2 -3
  55. package/data-alerts.d.ts +1004 -3
  56. package/data-alerts.js +2 -3
  57. package/data-assets.d.ts +207 -3
  58. package/data-assets.js +2 -3
  59. package/data-connections.d.ts +678 -3
  60. package/data-connections.js +2 -3
  61. package/data-credentials.d.ts +292 -3
  62. package/data-credentials.js +2 -3
  63. package/data-files.d.ts +860 -3
  64. package/data-files.js +2 -3
  65. package/data-qualities.d.ts +175 -3
  66. package/data-qualities.js +2 -3
  67. package/data-sets.d.ts +424 -3
  68. package/data-sets.js +2 -3
  69. package/data-sources.d.ts +348 -3
  70. package/data-sources.js +2 -3
  71. package/data-stores.d.ts +537 -3
  72. package/data-stores.js +2 -3
  73. package/dcaas.d.ts +192 -3
  74. package/dcaas.js +2 -3
  75. package/di-projects.d.ts +812 -4
  76. package/di-projects.js +25 -4
  77. package/direct-access-agents.d.ts +710 -4
  78. package/direct-access-agents.js +37 -5
  79. package/docs/authentication.md +1 -1
  80. package/encryption.d.ts +372 -3
  81. package/encryption.js +2 -3
  82. package/extensions.d.ts +295 -3
  83. package/extensions.js +2 -3
  84. package/global-types.d.ts +1 -1
  85. package/global-types.js +0 -2
  86. package/glossaries.d.ts +1223 -3
  87. package/glossaries.js +2 -3
  88. package/groups.d.ts +510 -3
  89. package/groups.js +2 -3
  90. package/identity-providers.d.ts +711 -3
  91. package/identity-providers.js +2 -3
  92. package/index.d.ts +78 -69
  93. package/index.js +28 -10
  94. package/interceptors.d.ts +52 -3
  95. package/interceptors.js +1 -2
  96. package/invoke-fetch-types.d.ts +1 -1
  97. package/items.d.ts +536 -3
  98. package/items.js +2 -3
  99. package/knowledgebases.d.ts +976 -3
  100. package/knowledgebases.js +2 -3
  101. package/licenses.d.ts +663 -3
  102. package/licenses.js +2 -3
  103. package/lineage-graphs.d.ts +704 -3
  104. package/lineage-graphs.js +2 -3
  105. package/ml.d.ts +2808 -3
  106. package/ml.js +2 -3
  107. package/notes.d.ts +110 -3
  108. package/notes.js +2 -3
  109. package/notifications.d.ts +98 -3
  110. package/notifications.js +2 -3
  111. package/oauth-callback.iife.js +1151 -0
  112. package/oauth-clients.d.ts +562 -3
  113. package/oauth-clients.js +2 -3
  114. package/oauth-tokens.d.ts +126 -3
  115. package/oauth-tokens.js +2 -3
  116. package/package.json +6 -4
  117. package/qix.d.ts +3 -3
  118. package/qix.js +38 -3
  119. package/questions.d.ts +364 -3
  120. package/questions.js +2 -3
  121. package/quotas.d.ts +112 -3
  122. package/quotas.js +2 -3
  123. package/reload-tasks.d.ts +249 -3
  124. package/reload-tasks.js +2 -3
  125. package/reloads.d.ts +260 -3
  126. package/reloads.js +2 -3
  127. package/report-templates.d.ts +287 -3
  128. package/report-templates.js +2 -3
  129. package/reports.d.ts +863 -3
  130. package/reports.js +2 -3
  131. package/roles.d.ts +312 -3
  132. package/roles.js +2 -3
  133. package/sharing-tasks.d.ts +1164 -3
  134. package/sharing-tasks.js +2 -3
  135. package/spaces.d.ts +779 -3
  136. package/spaces.js +2 -3
  137. package/tasks.d.ts +564 -3
  138. package/tasks.js +2 -3
  139. package/temp-contents.d.ts +167 -3
  140. package/temp-contents.js +2 -3
  141. package/tenants.d.ts +360 -3
  142. package/tenants.js +2 -3
  143. package/themes.d.ts +270 -3
  144. package/themes.js +2 -3
  145. package/transports.d.ts +435 -4
  146. package/transports.js +20 -5
  147. package/ui-config.d.ts +274 -3
  148. package/ui-config.js +2 -3
  149. package/users.d.ts +674 -3
  150. package/users.js +2 -3
  151. package/web-integrations.d.ts +294 -3
  152. package/web-integrations.js +2 -3
  153. package/web-notifications.d.ts +273 -3
  154. package/web-notifications.js +2 -3
  155. package/webhooks.d.ts +505 -3
  156. package/webhooks.js +2 -3
  157. package/chunks/api-keys-D6Rqaov4.d.ts +0 -365
  158. package/chunks/apps-BwpXUGDb.d.ts +0 -2673
  159. package/chunks/assistants-wh6Qe7l6.d.ts +0 -1366
  160. package/chunks/audits-DakwzT97.d.ts +0 -316
  161. package/chunks/auth-6mptVm5Q.d.ts +0 -95
  162. package/chunks/auth-D11iO7ZV.js +0 -65
  163. package/chunks/automation-connections-k2G_n9rj.d.ts +0 -366
  164. package/chunks/automation-connectors-J5OE-1P0.d.ts +0 -84
  165. package/chunks/automations-BGy83EBO.d.ts +0 -797
  166. package/chunks/automl-deployments-CWEpX2pk.d.ts +0 -101
  167. package/chunks/automl-predictions-BNIjRhBm.d.ts +0 -238
  168. package/chunks/banners-CgBRnZGv.d.ts +0 -184
  169. package/chunks/brands-DCgk6Gqx.d.ts +0 -671
  170. package/chunks/collections-BpYjcpIY.d.ts +0 -582
  171. package/chunks/conditions-CJJG7Uph.d.ts +0 -662
  172. package/chunks/consumption-DerFk437.d.ts +0 -182
  173. package/chunks/core-DQXNZdnf.d.ts +0 -12
  174. package/chunks/csp-origins-3NJlh_n9.d.ts +0 -273
  175. package/chunks/csrf-token-DoaoOQzH.d.ts +0 -63
  176. package/chunks/data-alerts-CILSEFbQ.d.ts +0 -1004
  177. package/chunks/data-assets-CJDcssoX.d.ts +0 -207
  178. package/chunks/data-connections-VSB13K6g.d.ts +0 -678
  179. package/chunks/data-credentials-ChEp_hyU.d.ts +0 -292
  180. package/chunks/data-files-CVzn9M6V.d.ts +0 -860
  181. package/chunks/data-qualities-DBrot957.d.ts +0 -176
  182. package/chunks/data-sets-CFzxgWnO.d.ts +0 -424
  183. package/chunks/data-sources-IsAaof_C.d.ts +0 -346
  184. package/chunks/data-stores-DFOPdgfz.d.ts +0 -537
  185. package/chunks/dcaas-qyv7YlrN.d.ts +0 -192
  186. package/chunks/di-projects-DVQTxASr.d.ts +0 -777
  187. package/chunks/direct-access-agents-B77OhzZi.d.ts +0 -580
  188. package/chunks/encryption-BjA6xbCO.d.ts +0 -372
  189. package/chunks/extensions-OO0WtInj.d.ts +0 -294
  190. package/chunks/glossaries-CIX7-KT_.d.ts +0 -1213
  191. package/chunks/groups-C86-UG7S.d.ts +0 -511
  192. package/chunks/identity-providers-h0dKNxGZ.d.ts +0 -711
  193. package/chunks/interceptors-Csx2tEi5.d.ts +0 -52
  194. package/chunks/interceptors-DTYm37AU.js +0 -104
  195. package/chunks/ip-policies-CKRIlbP7.d.ts +0 -327
  196. package/chunks/ip-policies-DXlf172B.js +0 -108
  197. package/chunks/items-C-jzqvFW.d.ts +0 -536
  198. package/chunks/knowledgebases-CyQtVcZN.d.ts +0 -977
  199. package/chunks/licenses-xzjnkitW.d.ts +0 -663
  200. package/chunks/lineage-graphs-CViCCzKy.d.ts +0 -697
  201. package/chunks/ml-Abt2MUva.d.ts +0 -2809
  202. package/chunks/notes-BZxuyDgt.d.ts +0 -111
  203. package/chunks/notifications-Bd_gp4jU.d.ts +0 -99
  204. package/chunks/oauth-clients-B5QPr4IM.d.ts +0 -563
  205. package/chunks/oauth-tokens-1b7V8182.d.ts +0 -127
  206. package/chunks/qix-CYQsLyGQ.js +0 -40
  207. package/chunks/questions-BVp0tvNs.d.ts +0 -364
  208. package/chunks/quotas-CfAebRJd.d.ts +0 -113
  209. package/chunks/reload-tasks-DfwUTetn.d.ts +0 -249
  210. package/chunks/reloads-CwmagnFx.d.ts +0 -260
  211. package/chunks/report-templates-DjQYj5dn.d.ts +0 -287
  212. package/chunks/reports-DzNC6Uq3.d.ts +0 -861
  213. package/chunks/roles-BYFIY6E7.d.ts +0 -312
  214. package/chunks/sharing-tasks-BMGIQ-FO.d.ts +0 -1164
  215. package/chunks/spaces-BK823t-b.d.ts +0 -780
  216. package/chunks/tasks-COKDfShO.d.ts +0 -564
  217. package/chunks/temp-contents-zDomB-g6.d.ts +0 -168
  218. package/chunks/tenants-Bhn86519.d.ts +0 -361
  219. package/chunks/themes-v9NbhiBo.d.ts +0 -269
  220. package/chunks/transports-CqEiFxD3.d.ts +0 -362
  221. package/chunks/ui-config-Crs0mVMp.d.ts +0 -274
  222. package/chunks/users-BSOBU_fg.d.ts +0 -675
  223. package/chunks/web-integrations-MisPAHod.d.ts +0 -295
  224. package/chunks/web-notifications-DVy6FHYh.d.ts +0 -274
  225. package/chunks/webhooks-Dr4EiXqy.d.ts +0 -505
  226. /package/chunks/{auth-types-E99tzdN0.d.ts → auth-types-YrlH_R9f.d.ts} +0 -0
  227. /package/chunks/{auth-types-JehqruDP.js → auth-types-h43TVDpB.js} +0 -0
  228. /package/chunks/{global-types-CrOvI33z.js → global-types-CEVAJebk.js} +0 -0
  229. /package/chunks/{invoke-fetch-CbU2Dgqr.d.ts → invoke-fetch-C1Z0RJYU.d.ts} +0 -0
  230. /package/chunks/{utils-BnC4lrlq.js → utils-vv-xFm06.js} +0 -0
  231. /package/chunks/{websocket-errors-DSbO6kDZ.js → websocket-errors-CRTDTtBL.js} +0 -0
@@ -1,6 +1,5 @@
1
- import "./chunks/utils-BnC4lrlq.js";
2
- import "./chunks/public-runtime-modules-Dwjzb3l8.js";
3
- import { n as invokeFetch, t as clearApiCache } from "./chunks/invoke-fetch-PcVIxLW4.js";
1
+ import "./chunks/public-runtime-modules-QhLPeQr5.js";
2
+ import { n as invokeFetch, t as clearApiCache } from "./chunks/invoke-fetch-B7lGscuQ.js";
4
3
 
5
4
  //#region src/public/rest/direct-access-agents.ts
6
5
  /**
@@ -22,7 +21,7 @@ async function restartDirectAccessAgent(agentId, agentAction, options) {
22
21
  });
23
22
  }
24
23
  /**
25
- * Starts a background benchmark task to measure the performance of a Direct Access agent. Use this endpoint to evaluate agent throughput and latency for capacity planning and performance optiization. Requestor must be assigned the `TenantAdmin` role and needs to be either a Gateway's space owner or a member in the Gateway's space with `Can Consume Data` role. Available in Direct Access Gateway V1.7.8+.
24
+ * Starts a background benchmark task to measure the performance of a Direct Access agent. Use this endpoint to evaluate agent throughput and latency for capacity planning and performance optimization. Requestor must be assigned the `TenantAdmin` role and needs to be either a Gateway's space owner or a member in the Gateway's space with `Can Consume Data` role. Available in Direct Access Gateway V1.7.8+.
26
25
  *
27
26
  * @param agentId The agent ID
28
27
  * @param query an object with query parameters
@@ -275,6 +274,37 @@ async function updateDirectAccessAgentConnectorFileWithoutQuery(agentId, connect
275
274
  });
276
275
  }
277
276
  /**
277
+ * Retrieves the settings for the metrics collector. Requestor must be assigned the `TenantAdmin` role. Available in Direct Access Gateway V1.7.9+.
278
+ *
279
+ * @param agentId The agent ID.
280
+ * @throws GetDirectAccessAgentToolsMetricsCollectorConfigurationHttpError
281
+ */
282
+ async function getDirectAccessAgentToolsMetricsCollectorConfiguration(agentId, options) {
283
+ return invokeFetch("direct-access-agents", {
284
+ method: "get",
285
+ pathTemplate: "/api/v1/direct-access-agents/{agentId}/tools/metrics-collector/configuration",
286
+ pathVariables: { agentId },
287
+ options
288
+ });
289
+ }
290
+ /**
291
+ * Completely replaces the contents of the metrics collector settings configuration file. Partial updates are not supported. Requestor must be assigned the `TenantAdmin` role. Available in Direct Access Gateway V1.7.9+.
292
+ *
293
+ * @param agentId The agent ID.
294
+ * @param body an object with the body content
295
+ * @throws SetDirectAccessAgentToolsMetricsCollectorConfigurationHttpError
296
+ */
297
+ async function setDirectAccessAgentToolsMetricsCollectorConfiguration(agentId, body, options) {
298
+ return invokeFetch("direct-access-agents", {
299
+ method: "put",
300
+ pathTemplate: "/api/v1/direct-access-agents/{agentId}/tools/metrics-collector/configuration",
301
+ pathVariables: { agentId },
302
+ body,
303
+ contentType: "application/json",
304
+ options
305
+ });
306
+ }
307
+ /**
278
308
  * Clears the cache for direct-access-agents api requests.
279
309
  */
280
310
  function clearCache() {
@@ -299,9 +329,11 @@ const directAccessAgentsExport = {
299
329
  getDirectAccessAgentConnectorFile,
300
330
  updateDirectAccessAgentConnectorFile,
301
331
  updateDirectAccessAgentConnectorFileWithoutQuery,
332
+ getDirectAccessAgentToolsMetricsCollectorConfiguration,
333
+ setDirectAccessAgentToolsMetricsCollectorConfiguration,
302
334
  clearCache
303
335
  };
304
336
  var direct_access_agents_default = directAccessAgentsExport;
305
337
 
306
338
  //#endregion
307
- export { clearCache, createDirectAccessAgentBenchmark, createDirectAccessAgentBenchmarkCancel, direct_access_agents_default as default, getDirectAccessAgentBenchmark, getDirectAccessAgentConfiguration, getDirectAccessAgentConnectorFile, getDirectAccessAgentConnectorFiles, getDirectAccessAgentConnectorFilesWithoutQuery, getDirectAccessAgentConnectorsFileConnectorFilesAllowedPaths, getDirectAccessAgentConnectorsOdbcConnectorFilesCustomDataTypeMappings, patchDirectAccessAgentConfiguration, putDirectAccessAgentConnectorsFileConnectorFilesAllowedPaths, putDirectAccessAgentConnectorsOdbcConnectorFilesCustomDataTypeMappings, restartDirectAccessAgent, updateDirectAccessAgentConnectorFile, updateDirectAccessAgentConnectorFileWithoutQuery };
339
+ export { clearCache, createDirectAccessAgentBenchmark, createDirectAccessAgentBenchmarkCancel, direct_access_agents_default as default, getDirectAccessAgentBenchmark, getDirectAccessAgentConfiguration, getDirectAccessAgentConnectorFile, getDirectAccessAgentConnectorFiles, getDirectAccessAgentConnectorFilesWithoutQuery, getDirectAccessAgentConnectorsFileConnectorFilesAllowedPaths, getDirectAccessAgentConnectorsOdbcConnectorFilesCustomDataTypeMappings, getDirectAccessAgentToolsMetricsCollectorConfiguration, patchDirectAccessAgentConfiguration, putDirectAccessAgentConnectorsFileConnectorFilesAllowedPaths, putDirectAccessAgentConnectorsOdbcConnectorFilesCustomDataTypeMappings, restartDirectAccessAgent, setDirectAccessAgentToolsMetricsCollectorConfiguration, updateDirectAccessAgentConnectorFile, updateDirectAccessAgentConnectorFileWithoutQuery };
@@ -38,7 +38,7 @@ const hostConfig = {
38
38
  apiKey: "<api-key>",
39
39
  }
40
40
 
41
- const { data: mySpaces } = spaces.getSpaces({}, {
41
+ const { data: mySpaces } = await spaces.getSpaces({}, {
42
42
  hostConfig,
43
43
  });
44
44
 
package/encryption.d.ts CHANGED
@@ -1,4 +1,373 @@
1
- import "./chunks/auth-types-E99tzdN0.js";
2
- import "./chunks/invoke-fetch-CbU2Dgqr.js";
3
- import { A as StandardError, B as getEncryptionKeyprovidersMigrationDetails, C as PatchEncryptionKeyproviderHttpError, D as ResetEncryptionKeyprovidersHttpError, E as ResetEncryptionKeyproviders205HttpResponse, F as createEncryptionKeyprovider, G as testEncryptionKeyprovider, H as migrateEncryptionKeyprovider, I as deleteEncryptionKeyprovider, L as encryptionExport, M as TestEncryptionKeyproviderHttpError, N as TestEncryptionKeyproviderHttpResponse, O as ResetEncryptionKeyprovidersHttpResponse, P as clearCache, R as getEncryptionKeyprovider, S as MigrationInformation, T as ResetEncryptionKeyproviders200HttpResponse, U as patchEncryptionKeyprovider, V as listEncryptionKeyproviders, W as resetEncryptionKeyproviders, _ as ListEncryptionKeyprovidersHttpError, a as EncryptionAPI, b as MigrateEncryptionKeyproviderHttpError, c as GetEncryptionKeyprovidersHttpError, d as GetEncryptionKeyprovidersMigrationDetailsHttpResponse, f as KeyProvider, g as KeyProvidersDeleteResponseBody, h as KeyProviders, i as DeleteEncryptionKeyproviderHttpResponse, j as StandardErrorItem, k as ResetMigrationNotNeeded, l as GetEncryptionKeyprovidersHttpResponse, m as KeyProviderPatchSchema, n as CreateEncryptionKeyproviderHttpResponse, o as GetEncryptionKeyproviderHttpError, p as KeyProviderPatchBase, r as DeleteEncryptionKeyproviderHttpError, s as GetEncryptionKeyproviderHttpResponse, t as CreateEncryptionKeyproviderHttpError, u as GetEncryptionKeyprovidersMigrationDetailsHttpError, v as ListEncryptionKeyprovidersHttpResponse, w as PatchEncryptionKeyproviderHttpResponse, x as MigrateEncryptionKeyproviderHttpResponse, y as ListKeyProviders, z as getEncryptionKeyproviders } from "./chunks/encryption-BjA6xbCO.js";
1
+ import { y as ApiCallOptions } from "./chunks/auth-types-YrlH_R9f.js";
2
+ import "./chunks/invoke-fetch-C1Z0RJYU.js";
3
+
4
+ //#region src/public/rest/encryption.d.ts
5
+
6
+ /**
7
+ * @example
8
+ * {
9
+ * arn: "arn:aws:kms:eu-west-1:111222334455:key/mrk-1237c011a37erft67ei987c7612q456",
10
+ * current: false,
11
+ * description: "test description",
12
+ * keyprovider: "AWS-KMS",
13
+ * multiRegion: true,
14
+ * name: "test name",
15
+ * replicaKeys: [
16
+ * {
17
+ * arn: "arn:aws:kms:eu-west-3:111222334455:key/mrk-1237c011a37erft67ei987c7612q456",
18
+ * region: "eu-west-3"
19
+ * }
20
+ * ]
21
+ * }
22
+ */
23
+ type KeyProvider = {
24
+ /** The provider resource notation for the key. */
25
+ arn: string;
26
+ /** The ARN fingerprint. */
27
+ readonly arnFingerPrint?: string;
28
+ /** When key entry was created. */
29
+ readonly createdAt?: string;
30
+ /** Indicates whether the key is being used to encrypt/decrypt secrets. */
31
+ readonly current?: boolean;
32
+ /** When the key was demoted from being current to non active. */
33
+ readonly demotedFromCurrentAt?: string;
34
+ /** Description of key provider entry. */
35
+ description?: string;
36
+ /** Key Provider type. */
37
+ keyprovider: "AWS-KMS";
38
+ /** Indicates whether the key has multi-region configurations and has replica key in qcs secondary region. */
39
+ readonly multiRegion?: boolean;
40
+ /** Name of key provider entry. */
41
+ name: string;
42
+ /** When the key was promoted to being the current active one. */
43
+ readonly promotedToCurrentAt?: string;
44
+ readonly replicaKeys?: {
45
+ /** Replica key keeps list of backup keys from the supported qcs secondary region. */
46
+ arn?: string;
47
+ /** Region indicates the backup qcs-region link to the primary region. */
48
+ region?: string;
49
+ }[];
50
+ /** Tenant ID. */
51
+ readonly tenantId?: string;
52
+ };
53
+ /**
54
+ * A JSON Patch document as defined in https://datatracker.ietf.org/doc/html/rfc6902.
55
+ * @example
56
+ * {
57
+ * op: "replace",
58
+ * path: "/name",
59
+ * value: "New Encryption Key"
60
+ * }
61
+ */
62
+ type KeyProviderPatchBase = {
63
+ /** The operation to be performed. */
64
+ op: "replace";
65
+ /** The property path. */
66
+ path: string;
67
+ /** The value to be used for this operation. */
68
+ value: string;
69
+ };
70
+ type KeyProviderPatchSchema = KeyProviderPatchBase[];
71
+ type KeyProviders = {
72
+ errors?: KeyProvider[];
73
+ };
74
+ type KeyProvidersDeleteResponseBody = {
75
+ /** Successful response message. */
76
+ response?: string;
77
+ };
78
+ type ListKeyProviders = {
79
+ errors?: KeyProvider[];
80
+ };
81
+ type MigrationInformation = {
82
+ completedAt?: string;
83
+ /** Migration operation ID. */
84
+ id?: string;
85
+ initiatedAt?: string;
86
+ /** The key ARN being migrated from (in case of QlikVault, could be a short name only). */
87
+ migratingFrom?: string;
88
+ /** The new key ARN that keys should be migrated to. */
89
+ migratingTo?: string;
90
+ /** The new key ARN fingerprint. */
91
+ migratingToFingerprint?: string;
92
+ /** The new key prefix (to help services know which prefix should NOT be migrated). */
93
+ migratingToPrefix?: string;
94
+ /** Progress in percentage. */
95
+ progress?: number;
96
+ /** Migration operation state. */
97
+ state?: "New" | "InProgress" | "Completed";
98
+ /** Tenant ID. */
99
+ tenantId?: string;
100
+ };
101
+ type ResetMigrationNotNeeded = {
102
+ /** Tenant is already using Qlik KMS, no migration is required. */
103
+ message?: string;
104
+ };
105
+ type StandardError = {
106
+ errors: StandardErrorItem[];
107
+ };
108
+ type StandardErrorItem = {
109
+ /** The error code. */
110
+ code: string;
111
+ /** Extra information about the error. */
112
+ detail?: string;
113
+ /** Additional error object metadata. */
114
+ meta?: unknown;
115
+ /** Description of the error. */
116
+ title: string;
117
+ };
118
+ /**
119
+ * Returns a list of AWS key providers in the tenant. Use /actions/list to return all key providers.
120
+ *
121
+ * @throws GetEncryptionKeyprovidersHttpError
122
+ */
123
+ declare function getEncryptionKeyproviders(options?: ApiCallOptions): Promise<GetEncryptionKeyprovidersHttpResponse>;
124
+ type GetEncryptionKeyprovidersHttpResponse = {
125
+ data: KeyProviders;
126
+ headers: Headers;
127
+ status: 200;
128
+ };
129
+ type GetEncryptionKeyprovidersHttpError = {
130
+ data: StandardError;
131
+ headers: Headers;
132
+ status: 400 | 417;
133
+ };
134
+ /**
135
+ * The AWS-KMS key configuration must match the Qlik Cloud region configuration requirements. Most regions should have a key deployed to the same AWS region as the Qlik Cloud tenant, with a replica key in the relevant Qlik Cloud DR region. Consult the documentation for DR region mappings.
136
+ *
137
+ * @param body an object with the body content
138
+ * @throws CreateEncryptionKeyproviderHttpError
139
+ */
140
+ declare function createEncryptionKeyprovider(body: KeyProvider, options?: ApiCallOptions): Promise<CreateEncryptionKeyproviderHttpResponse>;
141
+ type CreateEncryptionKeyproviderHttpResponse = {
142
+ data: KeyProvider;
143
+ headers: Headers;
144
+ status: 201;
145
+ };
146
+ type CreateEncryptionKeyproviderHttpError = {
147
+ data: StandardError;
148
+ headers: Headers;
149
+ status: 400 | 401 | 403 | 406 | 408 | 409 | 417;
150
+ };
151
+ /**
152
+ * Returns a list of all key providers in the tenant, including the default Qlik key provider.
153
+ *
154
+ * @throws ListEncryptionKeyprovidersHttpError
155
+ */
156
+ declare function listEncryptionKeyproviders(options?: ApiCallOptions): Promise<ListEncryptionKeyprovidersHttpResponse>;
157
+ type ListEncryptionKeyprovidersHttpResponse = {
158
+ data: ListKeyProviders;
159
+ headers: Headers;
160
+ status: 200;
161
+ };
162
+ type ListEncryptionKeyprovidersHttpError = {
163
+ data: StandardError;
164
+ headers: Headers;
165
+ status: 400 | 417;
166
+ };
167
+ /**
168
+ * Reset the encryption key back to the default Qlik managed provider. No action will be taken if tenant is already using the Qlik provider.
169
+ *
170
+ * @throws ResetEncryptionKeyprovidersHttpError
171
+ */
172
+ declare function resetEncryptionKeyproviders(options?: ApiCallOptions): Promise<ResetEncryptionKeyprovidersHttpResponse>;
173
+ type ResetEncryptionKeyprovidersHttpResponse = ResetEncryptionKeyproviders200HttpResponse | ResetEncryptionKeyproviders205HttpResponse;
174
+ type ResetEncryptionKeyproviders200HttpResponse = {
175
+ data: ResetMigrationNotNeeded;
176
+ headers: Headers;
177
+ status: 200;
178
+ };
179
+ type ResetEncryptionKeyproviders205HttpResponse = {
180
+ data: MigrationInformation;
181
+ headers: Headers;
182
+ status: 205;
183
+ };
184
+ type ResetEncryptionKeyprovidersHttpError = {
185
+ data: StandardError;
186
+ headers: Headers;
187
+ status: 401 | 406 | 412 | 424;
188
+ };
189
+ /**
190
+ * Retrieve details for the ongoing or last completed migration for the tenant.
191
+ *
192
+ * @throws GetEncryptionKeyprovidersMigrationDetailsHttpError
193
+ */
194
+ declare function getEncryptionKeyprovidersMigrationDetails(options?: ApiCallOptions): Promise<GetEncryptionKeyprovidersMigrationDetailsHttpResponse>;
195
+ type GetEncryptionKeyprovidersMigrationDetailsHttpResponse = {
196
+ data: MigrationInformation;
197
+ headers: Headers;
198
+ status: 200;
199
+ };
200
+ type GetEncryptionKeyprovidersMigrationDetailsHttpError = {
201
+ data: StandardError;
202
+ headers: Headers;
203
+ status: 400 | 401 | 404 | 417;
204
+ };
205
+ /**
206
+ * Delete a key configuration from the tenant. Not supported for the default Qlik managed key provider. Key must not be in use.
207
+ *
208
+ * @param arnFingerPrint The fingerprint of the key provider you wish to delete.
209
+ * @throws DeleteEncryptionKeyproviderHttpError
210
+ */
211
+ declare function deleteEncryptionKeyprovider(arnFingerPrint: string, options?: ApiCallOptions): Promise<DeleteEncryptionKeyproviderHttpResponse>;
212
+ type DeleteEncryptionKeyproviderHttpResponse = {
213
+ data: KeyProvidersDeleteResponseBody;
214
+ headers: Headers;
215
+ status: 204;
216
+ };
217
+ type DeleteEncryptionKeyproviderHttpError = {
218
+ data: StandardError;
219
+ headers: Headers;
220
+ status: 400 | 404 | 417 | 424;
221
+ };
222
+ /**
223
+ * Retrieve key provider detail by passing the ARN fingerprint as parameter.
224
+ *
225
+ * @param arnFingerPrint The fingerprint of the requested provider key.
226
+ * @throws GetEncryptionKeyproviderHttpError
227
+ */
228
+ declare function getEncryptionKeyprovider(arnFingerPrint: string, options?: ApiCallOptions): Promise<GetEncryptionKeyproviderHttpResponse>;
229
+ type GetEncryptionKeyproviderHttpResponse = {
230
+ data: KeyProvider;
231
+ headers: Headers;
232
+ status: 200;
233
+ };
234
+ type GetEncryptionKeyproviderHttpError = {
235
+ data: StandardError;
236
+ headers: Headers;
237
+ status: 400 | 404 | 414;
238
+ };
239
+ /**
240
+ * Update the name and/or description of a key provider.
241
+ *
242
+ * @param arnFingerPrint The ARN fingerprint of an existing key provider key.
243
+ * @param body an object with the body content
244
+ * @throws PatchEncryptionKeyproviderHttpError
245
+ */
246
+ declare function patchEncryptionKeyprovider(arnFingerPrint: string, body: KeyProviderPatchSchema, options?: ApiCallOptions): Promise<PatchEncryptionKeyproviderHttpResponse>;
247
+ type PatchEncryptionKeyproviderHttpResponse = {
248
+ data: void;
249
+ headers: Headers;
250
+ status: 204;
251
+ };
252
+ type PatchEncryptionKeyproviderHttpError = {
253
+ data: StandardError;
254
+ headers: Headers;
255
+ status: 400 | 401 | 404 | 417;
256
+ };
257
+ /**
258
+ * Migrate the active key from one provider to another. The migration process may take some time to complete, however this process will not impact users, and the tenant will continue to function normally during the migration. Use the migration details endpoint to monitor migration progress.
259
+ *
260
+ * @param arnFingerPrint The fingerprint of an existing key provider key.
261
+ * @throws MigrateEncryptionKeyproviderHttpError
262
+ */
263
+ declare function migrateEncryptionKeyprovider(arnFingerPrint: string, options?: ApiCallOptions): Promise<MigrateEncryptionKeyproviderHttpResponse>;
264
+ type MigrateEncryptionKeyproviderHttpResponse = {
265
+ data: MigrationInformation;
266
+ headers: Headers;
267
+ status: 200;
268
+ };
269
+ type MigrateEncryptionKeyproviderHttpError = {
270
+ data: StandardError;
271
+ headers: Headers;
272
+ status: 400 | 401 | 404 | 412 | 424 | 428;
273
+ };
274
+ /**
275
+ * Validate a key to check if Qlik Cloud has required access to your AWS account and key policy, and the key configuration. If the key policy or configuration are changed from the required configuration, this may impact your ability to access your tenant.
276
+ *
277
+ * @param arnFingerPrint The fingerprint of an existing key provider key.
278
+ * @throws TestEncryptionKeyproviderHttpError
279
+ */
280
+ declare function testEncryptionKeyprovider(arnFingerPrint: string, options?: ApiCallOptions): Promise<TestEncryptionKeyproviderHttpResponse>;
281
+ type TestEncryptionKeyproviderHttpResponse = {
282
+ data: KeyProvider;
283
+ headers: Headers;
284
+ status: 201;
285
+ };
286
+ type TestEncryptionKeyproviderHttpError = {
287
+ data: StandardError;
288
+ headers: Headers;
289
+ status: 400 | 401 | 404 | 408;
290
+ };
291
+ /**
292
+ * Clears the cache for encryption api requests.
293
+ */
294
+ declare function clearCache(): void;
295
+ type EncryptionAPI = {
296
+ /**
297
+ * Returns a list of AWS key providers in the tenant. Use /actions/list to return all key providers.
298
+ *
299
+ * @throws GetEncryptionKeyprovidersHttpError
300
+ */
301
+ getEncryptionKeyproviders: typeof getEncryptionKeyproviders;
302
+ /**
303
+ * The AWS-KMS key configuration must match the Qlik Cloud region configuration requirements. Most regions should have a key deployed to the same AWS region as the Qlik Cloud tenant, with a replica key in the relevant Qlik Cloud DR region. Consult the documentation for DR region mappings.
304
+ *
305
+ * @param body an object with the body content
306
+ * @throws CreateEncryptionKeyproviderHttpError
307
+ */
308
+ createEncryptionKeyprovider: typeof createEncryptionKeyprovider;
309
+ /**
310
+ * Returns a list of all key providers in the tenant, including the default Qlik key provider.
311
+ *
312
+ * @throws ListEncryptionKeyprovidersHttpError
313
+ */
314
+ listEncryptionKeyproviders: typeof listEncryptionKeyproviders;
315
+ /**
316
+ * Reset the encryption key back to the default Qlik managed provider. No action will be taken if tenant is already using the Qlik provider.
317
+ *
318
+ * @throws ResetEncryptionKeyprovidersHttpError
319
+ */
320
+ resetEncryptionKeyproviders: typeof resetEncryptionKeyproviders;
321
+ /**
322
+ * Retrieve details for the ongoing or last completed migration for the tenant.
323
+ *
324
+ * @throws GetEncryptionKeyprovidersMigrationDetailsHttpError
325
+ */
326
+ getEncryptionKeyprovidersMigrationDetails: typeof getEncryptionKeyprovidersMigrationDetails;
327
+ /**
328
+ * Delete a key configuration from the tenant. Not supported for the default Qlik managed key provider. Key must not be in use.
329
+ *
330
+ * @param arnFingerPrint The fingerprint of the key provider you wish to delete.
331
+ * @throws DeleteEncryptionKeyproviderHttpError
332
+ */
333
+ deleteEncryptionKeyprovider: typeof deleteEncryptionKeyprovider;
334
+ /**
335
+ * Retrieve key provider detail by passing the ARN fingerprint as parameter.
336
+ *
337
+ * @param arnFingerPrint The fingerprint of the requested provider key.
338
+ * @throws GetEncryptionKeyproviderHttpError
339
+ */
340
+ getEncryptionKeyprovider: typeof getEncryptionKeyprovider;
341
+ /**
342
+ * Update the name and/or description of a key provider.
343
+ *
344
+ * @param arnFingerPrint The ARN fingerprint of an existing key provider key.
345
+ * @param body an object with the body content
346
+ * @throws PatchEncryptionKeyproviderHttpError
347
+ */
348
+ patchEncryptionKeyprovider: typeof patchEncryptionKeyprovider;
349
+ /**
350
+ * Migrate the active key from one provider to another. The migration process may take some time to complete, however this process will not impact users, and the tenant will continue to function normally during the migration. Use the migration details endpoint to monitor migration progress.
351
+ *
352
+ * @param arnFingerPrint The fingerprint of an existing key provider key.
353
+ * @throws MigrateEncryptionKeyproviderHttpError
354
+ */
355
+ migrateEncryptionKeyprovider: typeof migrateEncryptionKeyprovider;
356
+ /**
357
+ * Validate a key to check if Qlik Cloud has required access to your AWS account and key policy, and the key configuration. If the key policy or configuration are changed from the required configuration, this may impact your ability to access your tenant.
358
+ *
359
+ * @param arnFingerPrint The fingerprint of an existing key provider key.
360
+ * @throws TestEncryptionKeyproviderHttpError
361
+ */
362
+ testEncryptionKeyprovider: typeof testEncryptionKeyprovider;
363
+ /**
364
+ * Clears the cache for encryption api requests.
365
+ */
366
+ clearCache: typeof clearCache;
367
+ };
368
+ /**
369
+ * Functions for the encryption api
370
+ */
371
+ declare const encryptionExport: EncryptionAPI;
372
+ //#endregion
4
373
  export { CreateEncryptionKeyproviderHttpError, CreateEncryptionKeyproviderHttpResponse, DeleteEncryptionKeyproviderHttpError, DeleteEncryptionKeyproviderHttpResponse, EncryptionAPI, GetEncryptionKeyproviderHttpError, GetEncryptionKeyproviderHttpResponse, GetEncryptionKeyprovidersHttpError, GetEncryptionKeyprovidersHttpResponse, GetEncryptionKeyprovidersMigrationDetailsHttpError, GetEncryptionKeyprovidersMigrationDetailsHttpResponse, KeyProvider, KeyProviderPatchBase, KeyProviderPatchSchema, KeyProviders, KeyProvidersDeleteResponseBody, ListEncryptionKeyprovidersHttpError, ListEncryptionKeyprovidersHttpResponse, ListKeyProviders, MigrateEncryptionKeyproviderHttpError, MigrateEncryptionKeyproviderHttpResponse, MigrationInformation, PatchEncryptionKeyproviderHttpError, PatchEncryptionKeyproviderHttpResponse, ResetEncryptionKeyproviders200HttpResponse, ResetEncryptionKeyproviders205HttpResponse, ResetEncryptionKeyprovidersHttpError, ResetEncryptionKeyprovidersHttpResponse, ResetMigrationNotNeeded, StandardError, StandardErrorItem, TestEncryptionKeyproviderHttpError, TestEncryptionKeyproviderHttpResponse, clearCache, createEncryptionKeyprovider, encryptionExport as default, deleteEncryptionKeyprovider, getEncryptionKeyprovider, getEncryptionKeyproviders, getEncryptionKeyprovidersMigrationDetails, listEncryptionKeyproviders, migrateEncryptionKeyprovider, patchEncryptionKeyprovider, resetEncryptionKeyproviders, testEncryptionKeyprovider };
package/encryption.js CHANGED
@@ -1,6 +1,5 @@
1
- import "./chunks/utils-BnC4lrlq.js";
2
- import "./chunks/public-runtime-modules-Dwjzb3l8.js";
3
- import { n as invokeFetch, t as clearApiCache } from "./chunks/invoke-fetch-PcVIxLW4.js";
1
+ import "./chunks/public-runtime-modules-QhLPeQr5.js";
2
+ import { n as invokeFetch, t as clearApiCache } from "./chunks/invoke-fetch-B7lGscuQ.js";
4
3
 
5
4
  //#region src/public/rest/encryption.ts
6
5
  /**