@qlik/api 1.30.0 → 1.32.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 (138) hide show
  1. package/api-keys.d.ts +2 -2
  2. package/api-keys.js +2 -2
  3. package/apps.d.ts +4 -2
  4. package/apps.js +2 -2
  5. package/assistants.d.ts +1301 -0
  6. package/assistants.js +273 -0
  7. package/audits.d.ts +2 -2
  8. package/audits.js +2 -2
  9. package/{auth-types-PkN9CAF_.d.ts → auth-types-DqfMuSRX.d.ts} +1 -0
  10. package/auth.d.ts +27 -3
  11. package/auth.js +8 -4
  12. package/automation-connections.d.ts +366 -0
  13. package/automation-connections.js +91 -0
  14. package/automations.d.ts +2 -2
  15. package/automations.js +2 -2
  16. package/automl-deployments.d.ts +97 -0
  17. package/automl-deployments.js +27 -0
  18. package/automl-predictions.d.ts +214 -0
  19. package/automl-predictions.js +72 -0
  20. package/brands.d.ts +2 -2
  21. package/brands.js +2 -2
  22. package/chunks/{JIX6RMFP.js → 6ZONDHRN.js} +1 -1
  23. package/chunks/ETNHFALU.js +61 -0
  24. package/chunks/{G6QUM5WQ.js → FKDGGR2O.js} +137 -45
  25. package/chunks/{TXC5XORK.js → LTNGXTXG.js} +3 -3
  26. package/chunks/{OTTC4QSX.js → LY7RP2HA.js} +7 -3
  27. package/chunks/{FKCZFVJL.js → M64RLKVG.js} +2074 -12
  28. package/chunks/{F5UDCCRD.js → PLVPW5IR.js} +1 -1
  29. package/chunks/{QK4TMJ64.js → RCLKKVYB.js} +11 -1
  30. package/chunks/{QWQLGDMI.js → UZTIZ4H5.js} +392 -372
  31. package/chunks/{PTDXR7AY.js → VVD2DPKQ.js} +2 -2
  32. package/chunks/{IQBP2PKS.js → YTT2FEVE.js} +1 -1
  33. package/collections.d.ts +3 -3
  34. package/collections.js +2 -2
  35. package/conditions.d.ts +662 -0
  36. package/conditions.js +113 -0
  37. package/consumption.d.ts +182 -0
  38. package/consumption.js +24 -0
  39. package/csp-origins.d.ts +2 -2
  40. package/csp-origins.js +2 -2
  41. package/csrf-token.d.ts +62 -0
  42. package/csrf-token.js +23 -0
  43. package/data-alerts.d.ts +1004 -0
  44. package/data-alerts.js +155 -0
  45. package/data-assets.d.ts +2 -2
  46. package/data-assets.js +2 -2
  47. package/data-connections.d.ts +7 -7
  48. package/data-connections.js +2 -2
  49. package/data-credentials.d.ts +2 -2
  50. package/data-credentials.js +2 -2
  51. package/data-files.d.ts +2 -2
  52. package/data-files.js +2 -2
  53. package/data-qualities.d.ts +175 -0
  54. package/data-qualities.js +44 -0
  55. package/data-sets.d.ts +424 -0
  56. package/data-sets.js +75 -0
  57. package/data-sources.d.ts +268 -0
  58. package/data-sources.js +39 -0
  59. package/data-stores.d.ts +537 -0
  60. package/data-stores.js +108 -0
  61. package/dcaas.d.ts +192 -0
  62. package/dcaas.js +39 -0
  63. package/di-projects.d.ts +673 -0
  64. package/di-projects.js +164 -0
  65. package/docs/authentication.md +47 -0
  66. package/encryption.d.ts +370 -0
  67. package/encryption.js +98 -0
  68. package/extensions.d.ts +2 -2
  69. package/extensions.js +2 -2
  70. package/glossaries.d.ts +2 -2
  71. package/glossaries.js +2 -2
  72. package/groups.d.ts +5 -4
  73. package/groups.js +2 -2
  74. package/identity-providers.d.ts +2 -2
  75. package/identity-providers.js +2 -2
  76. package/index.d.ts +110 -4
  77. package/index.js +556 -4
  78. package/interceptors.d.ts +2 -2
  79. package/{invoke-fetch-types-BXn-uSF5.d.ts → invoke-fetch-types-Cq7bjkqn.d.ts} +10 -2
  80. package/items.d.ts +3 -3
  81. package/items.js +2 -2
  82. package/knowledgebases.d.ts +890 -0
  83. package/knowledgebases.js +169 -0
  84. package/licenses.d.ts +6 -3
  85. package/licenses.js +2 -2
  86. package/lineage-graphs.d.ts +712 -0
  87. package/lineage-graphs.js +92 -0
  88. package/ml.d.ts +2628 -0
  89. package/ml.js +384 -0
  90. package/notes.d.ts +110 -0
  91. package/notes.js +31 -0
  92. package/notifications.d.ts +98 -0
  93. package/notifications.js +24 -0
  94. package/oauth-clients.d.ts +7 -2
  95. package/oauth-clients.js +2 -2
  96. package/oauth-tokens.d.ts +126 -0
  97. package/oauth-tokens.js +31 -0
  98. package/package.json +29 -2
  99. package/qix.d.ts +421 -26
  100. package/qix.js +2 -2
  101. package/questions.d.ts +364 -0
  102. package/questions.js +34 -0
  103. package/quotas.d.ts +2 -2
  104. package/quotas.js +2 -2
  105. package/reload-tasks.d.ts +4 -2
  106. package/reload-tasks.js +2 -2
  107. package/reloads.d.ts +4 -2
  108. package/reloads.js +2 -2
  109. package/report-templates.d.ts +287 -0
  110. package/report-templates.js +80 -0
  111. package/reports.d.ts +2 -2
  112. package/reports.js +2 -2
  113. package/roles.d.ts +2 -2
  114. package/roles.js +2 -2
  115. package/sharing-tasks.d.ts +952 -0
  116. package/sharing-tasks.js +105 -0
  117. package/spaces.d.ts +3 -7
  118. package/spaces.js +2 -2
  119. package/tasks.d.ts +564 -0
  120. package/tasks.js +106 -0
  121. package/temp-contents.d.ts +2 -2
  122. package/temp-contents.js +2 -2
  123. package/tenants.d.ts +2 -2
  124. package/tenants.js +2 -2
  125. package/themes.d.ts +2 -2
  126. package/themes.js +2 -2
  127. package/transports.d.ts +2 -2
  128. package/transports.js +2 -2
  129. package/ui-config.d.ts +274 -0
  130. package/ui-config.js +77 -0
  131. package/users.d.ts +2 -2
  132. package/users.js +2 -2
  133. package/web-integrations.d.ts +2 -2
  134. package/web-integrations.js +2 -2
  135. package/web-notifications.d.ts +2 -2
  136. package/web-notifications.js +2 -2
  137. package/webhooks.d.ts +2 -2
  138. package/webhooks.js +2 -2
package/di-projects.js ADDED
@@ -0,0 +1,164 @@
1
+ import {
2
+ clearApiCache,
3
+ invokeFetch
4
+ } from "./chunks/VVD2DPKQ.js";
5
+ import "./chunks/LTNGXTXG.js";
6
+ import "./chunks/2ZQ3ZX7F.js";
7
+
8
+ // src/public/rest/di-projects.ts
9
+ var getDiProjects = async (query, options) => invokeFetch("di-projects", {
10
+ method: "get",
11
+ pathTemplate: "/api/v1/di-projects",
12
+ query,
13
+ options
14
+ });
15
+ var createDiProject = async (body, options) => invokeFetch("di-projects", {
16
+ method: "post",
17
+ pathTemplate: "/api/v1/di-projects",
18
+ body,
19
+ contentType: "application/json",
20
+ options
21
+ });
22
+ var getDiProject = async (actionId, query, options) => invokeFetch("di-projects", {
23
+ method: "get",
24
+ pathTemplate: "/api/v1/di-projects/actions/{actionId}",
25
+ pathVariables: { actionId },
26
+ query,
27
+ options
28
+ });
29
+ var exportDiProject = async (projectId, body, options) => invokeFetch("di-projects", {
30
+ method: "post",
31
+ pathTemplate: "/api/v1/di-projects/{projectId}/actions/export",
32
+ pathVariables: { projectId },
33
+ body,
34
+ contentType: "application/json",
35
+ options
36
+ });
37
+ var importDiProject = async (projectId, body, options) => invokeFetch("di-projects", {
38
+ method: "post",
39
+ pathTemplate: "/api/v1/di-projects/{projectId}/actions/import",
40
+ pathVariables: { projectId },
41
+ body,
42
+ contentType: "multipart/form-data",
43
+ options
44
+ });
45
+ var prepareDiProject = async (projectId, body, options) => invokeFetch("di-projects", {
46
+ method: "post",
47
+ pathTemplate: "/api/v1/di-projects/{projectId}/actions/prepare",
48
+ pathVariables: { projectId },
49
+ body,
50
+ contentType: "application/json",
51
+ options
52
+ });
53
+ var validateDiProject = async (projectId, body, options) => invokeFetch("di-projects", {
54
+ method: "post",
55
+ pathTemplate: "/api/v1/di-projects/{projectId}/actions/validate",
56
+ pathVariables: { projectId },
57
+ body,
58
+ contentType: "application/json",
59
+ options
60
+ });
61
+ var getDiProjectExportVariables = async (projectId, query, options) => invokeFetch("di-projects", {
62
+ method: "get",
63
+ pathTemplate: "/api/v1/di-projects/{projectId}/bindings",
64
+ pathVariables: { projectId },
65
+ query,
66
+ options
67
+ });
68
+ var setDiProjectExportVariables = async (projectId, body, options) => invokeFetch("di-projects", {
69
+ method: "put",
70
+ pathTemplate: "/api/v1/di-projects/{projectId}/bindings",
71
+ pathVariables: { projectId },
72
+ body,
73
+ contentType: "application/json",
74
+ options
75
+ });
76
+ var getDiProjectDiTasks = async (projectId, options) => invokeFetch("di-projects", {
77
+ method: "get",
78
+ pathTemplate: "/api/v1/di-projects/{projectId}/di-tasks",
79
+ pathVariables: { projectId },
80
+ options
81
+ });
82
+ var getDiProjectDiTask = async (projectId, dataTaskId, options) => invokeFetch("di-projects", {
83
+ method: "get",
84
+ pathTemplate: "/api/v1/di-projects/{projectId}/di-tasks/{dataTaskId}",
85
+ pathVariables: { projectId, dataTaskId },
86
+ options
87
+ });
88
+ var prepareDiProjectDiTask = async (projectId, dataTaskId, body, options) => invokeFetch("di-projects", {
89
+ method: "post",
90
+ pathTemplate: "/api/v1/di-projects/{projectId}/di-tasks/{dataTaskId}/actions/prepare",
91
+ pathVariables: { projectId, dataTaskId },
92
+ body,
93
+ contentType: "application/json",
94
+ options
95
+ });
96
+ var validateDiProjectDiTask = async (projectId, dataTaskId, body, options) => invokeFetch("di-projects", {
97
+ method: "post",
98
+ pathTemplate: "/api/v1/di-projects/{projectId}/di-tasks/{dataTaskId}/actions/validate",
99
+ pathVariables: { projectId, dataTaskId },
100
+ body,
101
+ contentType: "application/json",
102
+ options
103
+ });
104
+ var startDiProjectDiTaskRuntime = async (projectId, dataTaskId, options) => invokeFetch("di-projects", {
105
+ method: "post",
106
+ pathTemplate: "/api/v1/di-projects/{projectId}/di-tasks/{dataTaskId}/runtime/actions/start",
107
+ pathVariables: { projectId, dataTaskId },
108
+ options
109
+ });
110
+ var stopDiProjectDiTaskRuntime = async (projectId, dataTaskId, options) => invokeFetch("di-projects", {
111
+ method: "post",
112
+ pathTemplate: "/api/v1/di-projects/{projectId}/di-tasks/{dataTaskId}/runtime/actions/stop",
113
+ pathVariables: { projectId, dataTaskId },
114
+ options
115
+ });
116
+ var getDiProjectDiTaskRuntimeState = async (projectId, dataTaskId, options) => invokeFetch("di-projects", {
117
+ method: "get",
118
+ pathTemplate: "/api/v1/di-projects/{projectId}/di-tasks/{dataTaskId}/runtime/state",
119
+ pathVariables: { projectId, dataTaskId },
120
+ options
121
+ });
122
+ function clearCache() {
123
+ return clearApiCache("di-projects");
124
+ }
125
+ var diProjectsExport = {
126
+ getDiProjects,
127
+ createDiProject,
128
+ getDiProject,
129
+ exportDiProject,
130
+ importDiProject,
131
+ prepareDiProject,
132
+ validateDiProject,
133
+ getDiProjectExportVariables,
134
+ setDiProjectExportVariables,
135
+ getDiProjectDiTasks,
136
+ getDiProjectDiTask,
137
+ prepareDiProjectDiTask,
138
+ validateDiProjectDiTask,
139
+ startDiProjectDiTaskRuntime,
140
+ stopDiProjectDiTaskRuntime,
141
+ getDiProjectDiTaskRuntimeState,
142
+ clearCache
143
+ };
144
+ var di_projects_default = diProjectsExport;
145
+ export {
146
+ clearCache,
147
+ createDiProject,
148
+ di_projects_default as default,
149
+ exportDiProject,
150
+ getDiProject,
151
+ getDiProjectDiTask,
152
+ getDiProjectDiTaskRuntimeState,
153
+ getDiProjectDiTasks,
154
+ getDiProjectExportVariables,
155
+ getDiProjects,
156
+ importDiProject,
157
+ prepareDiProject,
158
+ prepareDiProjectDiTask,
159
+ setDiProjectExportVariables,
160
+ startDiProjectDiTaskRuntime,
161
+ stopDiProjectDiTaskRuntime,
162
+ validateDiProject,
163
+ validateDiProjectDiTask
164
+ };
@@ -246,4 +246,51 @@ const hostConfig: HostConfig = {
246
246
  setDefaultHostConfig(hostConfig);
247
247
  ```
248
248
 
249
+ ## Registering a Host Config
250
+
251
+ It is possible to register a named host config and reference it when making api-calls.
252
+
253
+ When referencing a registered host config we use a special host config type with the auth type `reference` which only
254
+ takes one property with the same name (`.reference`). There is no need to specify the auth type in the host config
255
+ when using this host config type.
256
+
257
+ This example shows how to use the `registerHostConfig` function and how to reference it.
258
+
259
+ ```ts
260
+ import { auth, spaces } from "@qlik/api";
261
+
262
+ auth.registerHostConfig("tenant 1", {
263
+ host: "tenant1.eu.qlikcloud.com",
264
+ authType: "apikey",
265
+ apiKey: "<api-key>",
266
+ });
267
+
268
+ auth.registerHostConfig("tenant 2", {
269
+ host: "tenant2.eu.qlikcloud.com",
270
+ authType: "apikey",
271
+ apiKey: "<api-key>",
272
+ });
273
+
274
+ const response = await spaces.getSpaces({}, { hostConfig: { reference: "tenant 1" } });
275
+ console.log(`Tenant 1 has ${response.data.data.length} spaces`);
276
+ const response2 = await spaces.getSpaces({}, { hostConfig: { reference: "tenant 2" } });
277
+ console.log(`Tenant 2 has ${response2.data.data.length} spaces`);
278
+ ```
279
+
280
+ This works equally well when using it in the `createQlikApi` function.
281
+
282
+ ```ts
283
+ import { auth, createQlikApi } from "@qlik/api";
284
+
285
+ auth.registerHostConfig("tenant 1", {
286
+ host: "tenant1.eu.qlikcloud.com",
287
+ authType: "apikey",
288
+ apiKey: "<api-key>",
289
+ });
290
+
291
+ const api = createQlikApi({ reference: "tenant 1" });
292
+
293
+ // api is now bound to the registered host config "tenant 1"
294
+ ```
295
+
249
296
  ◁ [Back to overview](../README.md)
@@ -0,0 +1,370 @@
1
+ import { A as ApiCallOptions } from './invoke-fetch-types-Cq7bjkqn.js';
2
+ import './auth-types-DqfMuSRX.js';
3
+
4
+ /**
5
+ * @example
6
+ * {
7
+ * arn: "arn:aws:kms:eu-west-1:111222334455:key/mrk-1237c011a37erft67ei987c7612q456",
8
+ * current: false,
9
+ * description: "test description",
10
+ * multiRegion: true,
11
+ * name: "test name",
12
+ * replicaKeys: [
13
+ * {
14
+ * arn: "arn:aws:kms:eu-west-3:111222334455:key/mrk-1237c011a37erft67ei987c7612q456",
15
+ * region: "eu-west-3"
16
+ * }
17
+ * ]
18
+ * }
19
+ */
20
+ type KeyProvider = {
21
+ /** The provider resource notation for the key. */
22
+ arn: string;
23
+ /** The ARN fingerprint. */
24
+ readonly arnFingerPrint?: string;
25
+ /** When key entry was created. */
26
+ readonly createdAt?: string;
27
+ /** Indicates whether the key is being used to encrypt/decrypt secrets. */
28
+ readonly current?: boolean;
29
+ /** When the key was demoted from being current to non active. */
30
+ readonly demotedFromCurrentAt?: string;
31
+ /** Description of key provider entry. */
32
+ description?: string;
33
+ /** Key Provider type. */
34
+ keyProvider?: "AWS-KMS";
35
+ /** Indicates whether the key has multi-region configurations and has replica key in qcs secondary region. */
36
+ readonly multiRegion?: boolean;
37
+ /** Name of key provider entry. */
38
+ name: string;
39
+ /** When the key was promoted to being the current active one. */
40
+ readonly promotedToCurrentAt?: string;
41
+ readonly replicaKeys?: {
42
+ /** Replica key keeps list of backup keys from the supported qcs secondary region. */
43
+ arn?: string;
44
+ /** Region indicates the backup qcs-region link to the primary region. */
45
+ region?: string;
46
+ }[];
47
+ /** Tenant ID. */
48
+ readonly tenantId?: string;
49
+ };
50
+ /**
51
+ * A JSON Patch document as defined in https://datatracker.ietf.org/doc/html/rfc6902.
52
+ * @example
53
+ * {
54
+ * op: "replace",
55
+ * path: "/name",
56
+ * value: "New Encryption Key"
57
+ * }
58
+ */
59
+ type KeyProviderPatchBase = {
60
+ /** The operation to be performed. */
61
+ op: "replace";
62
+ /** The property path. */
63
+ path: string;
64
+ /** The value to be used for this operation. */
65
+ value: string;
66
+ };
67
+ type KeyProviderPatchSchema = KeyProviderPatchBase[];
68
+ type KeyProviders = {
69
+ errors?: KeyProvider[];
70
+ };
71
+ type KeyProvidersDeleteResponseBody = {
72
+ /** Successful response message. */
73
+ response?: string;
74
+ };
75
+ type ListKeyProviders = {
76
+ errors?: KeyProvider[];
77
+ };
78
+ type MigrationInformation = {
79
+ completedAt?: string;
80
+ /** Migration operation ID. */
81
+ id?: string;
82
+ initiatedAt?: string;
83
+ /** The key ARN being migrated from (in case of QlikVault, could be a short name only). */
84
+ migratingFrom?: string;
85
+ /** The new key ARN that keys should be migrated to. */
86
+ migratingTo?: string;
87
+ /** The new key ARN fingerprint. */
88
+ migratingToFingerprint?: string;
89
+ /** The new key prefix (to help services know which prefix should NOT be migrated). */
90
+ migratingToPrefix?: string;
91
+ /** Progress in percentage. */
92
+ progress?: number;
93
+ /** Migration operation state. */
94
+ state?: "New" | "InProgress" | "Completed";
95
+ /** Tenant ID. */
96
+ tenantId?: string;
97
+ };
98
+ type ResetMigrationNotNeeded = {
99
+ /** Tenant is already using Qlik KMS, no migration is required. */
100
+ message?: string;
101
+ };
102
+ type StandardError = {
103
+ errors: StandardErrorItem[];
104
+ };
105
+ type StandardErrorItem = {
106
+ /** The error code. */
107
+ code: string;
108
+ /** Extra information about the error. */
109
+ detail?: string;
110
+ /** Additional error object metadata. */
111
+ meta?: unknown;
112
+ /** Description of the error. */
113
+ title: string;
114
+ };
115
+ /**
116
+ * Returns a list of AWS key providers in the tenant. Use /actions/list to return all key providers.
117
+ *
118
+ * @throws GetEncryptionKeyprovidersHttpError
119
+ */
120
+ declare const getEncryptionKeyproviders: (options?: ApiCallOptions) => Promise<GetEncryptionKeyprovidersHttpResponse>;
121
+ type GetEncryptionKeyprovidersHttpResponse = {
122
+ data: KeyProviders;
123
+ headers: Headers;
124
+ status: 200;
125
+ };
126
+ type GetEncryptionKeyprovidersHttpError = {
127
+ data: StandardError;
128
+ headers: Headers;
129
+ status: 400 | 417;
130
+ };
131
+ /**
132
+ * 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.
133
+ *
134
+ * @param body an object with the body content
135
+ * @throws CreateEncryptionKeyproviderHttpError
136
+ */
137
+ declare const createEncryptionKeyprovider: (body: KeyProvider, options?: ApiCallOptions) => Promise<CreateEncryptionKeyproviderHttpResponse>;
138
+ type CreateEncryptionKeyproviderHttpResponse = {
139
+ data: KeyProvider;
140
+ headers: Headers;
141
+ status: 201;
142
+ };
143
+ type CreateEncryptionKeyproviderHttpError = {
144
+ data: StandardError;
145
+ headers: Headers;
146
+ status: 400 | 401 | 403 | 406 | 408 | 409 | 417;
147
+ };
148
+ /**
149
+ * Returns a list of all key providers in the tenant, including the default Qlik key provider.
150
+ *
151
+ * @throws ListEncryptionKeyprovidersHttpError
152
+ */
153
+ declare const listEncryptionKeyproviders: (options?: ApiCallOptions) => Promise<ListEncryptionKeyprovidersHttpResponse>;
154
+ type ListEncryptionKeyprovidersHttpResponse = {
155
+ data: ListKeyProviders;
156
+ headers: Headers;
157
+ status: 200;
158
+ };
159
+ type ListEncryptionKeyprovidersHttpError = {
160
+ data: StandardError;
161
+ headers: Headers;
162
+ status: 400 | 417;
163
+ };
164
+ /**
165
+ * Reset the encryption key back to the default Qlik managed provider. No action will be taken if tenant is already using the Qlik provider.
166
+ *
167
+ * @throws ResetEncryptionKeyprovidersHttpError
168
+ */
169
+ declare const resetEncryptionKeyproviders: (options?: ApiCallOptions) => Promise<ResetEncryptionKeyprovidersHttpResponse>;
170
+ type ResetEncryptionKeyprovidersHttpResponse = ResetEncryptionKeyproviders200HttpResponse | ResetEncryptionKeyproviders205HttpResponse;
171
+ type ResetEncryptionKeyproviders200HttpResponse = {
172
+ data: ResetMigrationNotNeeded;
173
+ headers: Headers;
174
+ status: 200;
175
+ };
176
+ type ResetEncryptionKeyproviders205HttpResponse = {
177
+ data: MigrationInformation;
178
+ headers: Headers;
179
+ status: 205;
180
+ };
181
+ type ResetEncryptionKeyprovidersHttpError = {
182
+ data: StandardError;
183
+ headers: Headers;
184
+ status: 401 | 406 | 412 | 424;
185
+ };
186
+ /**
187
+ * Retrieve details for the ongoing or last completed migration for the tenant.
188
+ *
189
+ * @throws GetEncryptionKeyprovidersMigrationDetailsHttpError
190
+ */
191
+ declare const getEncryptionKeyprovidersMigrationDetails: (options?: ApiCallOptions) => Promise<GetEncryptionKeyprovidersMigrationDetailsHttpResponse>;
192
+ type GetEncryptionKeyprovidersMigrationDetailsHttpResponse = {
193
+ data: MigrationInformation;
194
+ headers: Headers;
195
+ status: 200;
196
+ };
197
+ type GetEncryptionKeyprovidersMigrationDetailsHttpError = {
198
+ data: StandardError;
199
+ headers: Headers;
200
+ status: 400 | 401 | 404 | 417;
201
+ };
202
+ /**
203
+ * Delete a key configuration from the tenant. Not supported for the default Qlik managed key provider. Key must not be in use.
204
+ *
205
+ * @param arnFingerPrint The fingerprint of the key provider you wish to delete.
206
+ * @throws DeleteEncryptionKeyproviderHttpError
207
+ */
208
+ declare const deleteEncryptionKeyprovider: (arnFingerPrint: string, options?: ApiCallOptions) => Promise<DeleteEncryptionKeyproviderHttpResponse>;
209
+ type DeleteEncryptionKeyproviderHttpResponse = {
210
+ data: KeyProvidersDeleteResponseBody;
211
+ headers: Headers;
212
+ status: 204;
213
+ };
214
+ type DeleteEncryptionKeyproviderHttpError = {
215
+ data: StandardError;
216
+ headers: Headers;
217
+ status: 400 | 404 | 417 | 424;
218
+ };
219
+ /**
220
+ * Retrieve key provider detail by passing the ARN fingerprint as parameter.
221
+ *
222
+ * @param arnFingerPrint The fingerprint of the requested provider key.
223
+ * @throws GetEncryptionKeyproviderHttpError
224
+ */
225
+ declare const getEncryptionKeyprovider: (arnFingerPrint: string, options?: ApiCallOptions) => Promise<GetEncryptionKeyproviderHttpResponse>;
226
+ type GetEncryptionKeyproviderHttpResponse = {
227
+ data: KeyProvider;
228
+ headers: Headers;
229
+ status: 200;
230
+ };
231
+ type GetEncryptionKeyproviderHttpError = {
232
+ data: StandardError;
233
+ headers: Headers;
234
+ status: 400 | 404 | 414;
235
+ };
236
+ /**
237
+ * Update the name and/or description of a key provider.
238
+ *
239
+ * @param arnFingerPrint The ARN fingerprint of an existing key provider key.
240
+ * @param body an object with the body content
241
+ * @throws PatchEncryptionKeyproviderHttpError
242
+ */
243
+ declare const patchEncryptionKeyprovider: (arnFingerPrint: string, body: KeyProviderPatchSchema, options?: ApiCallOptions) => Promise<PatchEncryptionKeyproviderHttpResponse>;
244
+ type PatchEncryptionKeyproviderHttpResponse = {
245
+ data: void;
246
+ headers: Headers;
247
+ status: 204;
248
+ };
249
+ type PatchEncryptionKeyproviderHttpError = {
250
+ data: StandardError;
251
+ headers: Headers;
252
+ status: 400 | 401 | 404 | 417;
253
+ };
254
+ /**
255
+ * 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.
256
+ *
257
+ * @param arnFingerPrint The fingerprint of an existing key provider key.
258
+ * @throws MigrateEncryptionKeyproviderHttpError
259
+ */
260
+ declare const migrateEncryptionKeyprovider: (arnFingerPrint: string, options?: ApiCallOptions) => Promise<MigrateEncryptionKeyproviderHttpResponse>;
261
+ type MigrateEncryptionKeyproviderHttpResponse = {
262
+ data: MigrationInformation;
263
+ headers: Headers;
264
+ status: 200;
265
+ };
266
+ type MigrateEncryptionKeyproviderHttpError = {
267
+ data: StandardError;
268
+ headers: Headers;
269
+ status: 400 | 401 | 404 | 412 | 424 | 428;
270
+ };
271
+ /**
272
+ * 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.
273
+ *
274
+ * @param arnFingerPrint The fingerprint of an existing key provider key.
275
+ * @throws TestEncryptionKeyproviderHttpError
276
+ */
277
+ declare const testEncryptionKeyprovider: (arnFingerPrint: string, options?: ApiCallOptions) => Promise<TestEncryptionKeyproviderHttpResponse>;
278
+ type TestEncryptionKeyproviderHttpResponse = {
279
+ data: KeyProvider;
280
+ headers: Headers;
281
+ status: 201;
282
+ };
283
+ type TestEncryptionKeyproviderHttpError = {
284
+ data: StandardError;
285
+ headers: Headers;
286
+ status: 400 | 401 | 404 | 408;
287
+ };
288
+ /**
289
+ * Clears the cache for encryption api requests.
290
+ */
291
+ declare function clearCache(): void;
292
+ interface EncryptionAPI {
293
+ /**
294
+ * Returns a list of AWS key providers in the tenant. Use /actions/list to return all key providers.
295
+ *
296
+ * @throws GetEncryptionKeyprovidersHttpError
297
+ */
298
+ getEncryptionKeyproviders: typeof getEncryptionKeyproviders;
299
+ /**
300
+ * 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.
301
+ *
302
+ * @param body an object with the body content
303
+ * @throws CreateEncryptionKeyproviderHttpError
304
+ */
305
+ createEncryptionKeyprovider: typeof createEncryptionKeyprovider;
306
+ /**
307
+ * Returns a list of all key providers in the tenant, including the default Qlik key provider.
308
+ *
309
+ * @throws ListEncryptionKeyprovidersHttpError
310
+ */
311
+ listEncryptionKeyproviders: typeof listEncryptionKeyproviders;
312
+ /**
313
+ * Reset the encryption key back to the default Qlik managed provider. No action will be taken if tenant is already using the Qlik provider.
314
+ *
315
+ * @throws ResetEncryptionKeyprovidersHttpError
316
+ */
317
+ resetEncryptionKeyproviders: typeof resetEncryptionKeyproviders;
318
+ /**
319
+ * Retrieve details for the ongoing or last completed migration for the tenant.
320
+ *
321
+ * @throws GetEncryptionKeyprovidersMigrationDetailsHttpError
322
+ */
323
+ getEncryptionKeyprovidersMigrationDetails: typeof getEncryptionKeyprovidersMigrationDetails;
324
+ /**
325
+ * Delete a key configuration from the tenant. Not supported for the default Qlik managed key provider. Key must not be in use.
326
+ *
327
+ * @param arnFingerPrint The fingerprint of the key provider you wish to delete.
328
+ * @throws DeleteEncryptionKeyproviderHttpError
329
+ */
330
+ deleteEncryptionKeyprovider: typeof deleteEncryptionKeyprovider;
331
+ /**
332
+ * Retrieve key provider detail by passing the ARN fingerprint as parameter.
333
+ *
334
+ * @param arnFingerPrint The fingerprint of the requested provider key.
335
+ * @throws GetEncryptionKeyproviderHttpError
336
+ */
337
+ getEncryptionKeyprovider: typeof getEncryptionKeyprovider;
338
+ /**
339
+ * Update the name and/or description of a key provider.
340
+ *
341
+ * @param arnFingerPrint The ARN fingerprint of an existing key provider key.
342
+ * @param body an object with the body content
343
+ * @throws PatchEncryptionKeyproviderHttpError
344
+ */
345
+ patchEncryptionKeyprovider: typeof patchEncryptionKeyprovider;
346
+ /**
347
+ * 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.
348
+ *
349
+ * @param arnFingerPrint The fingerprint of an existing key provider key.
350
+ * @throws MigrateEncryptionKeyproviderHttpError
351
+ */
352
+ migrateEncryptionKeyprovider: typeof migrateEncryptionKeyprovider;
353
+ /**
354
+ * 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.
355
+ *
356
+ * @param arnFingerPrint The fingerprint of an existing key provider key.
357
+ * @throws TestEncryptionKeyproviderHttpError
358
+ */
359
+ testEncryptionKeyprovider: typeof testEncryptionKeyprovider;
360
+ /**
361
+ * Clears the cache for encryption api requests.
362
+ */
363
+ clearCache: typeof clearCache;
364
+ }
365
+ /**
366
+ * Functions for the encryption api
367
+ */
368
+ declare const encryptionExport: EncryptionAPI;
369
+
370
+ export { type CreateEncryptionKeyproviderHttpError, type CreateEncryptionKeyproviderHttpResponse, type DeleteEncryptionKeyproviderHttpError, type DeleteEncryptionKeyproviderHttpResponse, type EncryptionAPI, type GetEncryptionKeyproviderHttpError, type GetEncryptionKeyproviderHttpResponse, type GetEncryptionKeyprovidersHttpError, type GetEncryptionKeyprovidersHttpResponse, type GetEncryptionKeyprovidersMigrationDetailsHttpError, type GetEncryptionKeyprovidersMigrationDetailsHttpResponse, type KeyProvider, type KeyProviderPatchBase, type KeyProviderPatchSchema, type KeyProviders, type KeyProvidersDeleteResponseBody, type ListEncryptionKeyprovidersHttpError, type ListEncryptionKeyprovidersHttpResponse, type ListKeyProviders, type MigrateEncryptionKeyproviderHttpError, type MigrateEncryptionKeyproviderHttpResponse, type MigrationInformation, type PatchEncryptionKeyproviderHttpError, type PatchEncryptionKeyproviderHttpResponse, type ResetEncryptionKeyproviders200HttpResponse, type ResetEncryptionKeyproviders205HttpResponse, type ResetEncryptionKeyprovidersHttpError, type ResetEncryptionKeyprovidersHttpResponse, type ResetMigrationNotNeeded, type StandardError, type StandardErrorItem, type TestEncryptionKeyproviderHttpError, type TestEncryptionKeyproviderHttpResponse, clearCache, createEncryptionKeyprovider, encryptionExport as default, deleteEncryptionKeyprovider, getEncryptionKeyprovider, getEncryptionKeyproviders, getEncryptionKeyprovidersMigrationDetails, listEncryptionKeyproviders, migrateEncryptionKeyprovider, patchEncryptionKeyprovider, resetEncryptionKeyproviders, testEncryptionKeyprovider };
package/encryption.js ADDED
@@ -0,0 +1,98 @@
1
+ import {
2
+ clearApiCache,
3
+ invokeFetch
4
+ } from "./chunks/VVD2DPKQ.js";
5
+ import "./chunks/LTNGXTXG.js";
6
+ import "./chunks/2ZQ3ZX7F.js";
7
+
8
+ // src/public/rest/encryption.ts
9
+ var getEncryptionKeyproviders = async (options) => invokeFetch("encryption", {
10
+ method: "get",
11
+ pathTemplate: "/api/v1/encryption/keyproviders",
12
+ options
13
+ });
14
+ var createEncryptionKeyprovider = async (body, options) => invokeFetch("encryption", {
15
+ method: "post",
16
+ pathTemplate: "/api/v1/encryption/keyproviders",
17
+ body,
18
+ contentType: "application/json",
19
+ options
20
+ });
21
+ var listEncryptionKeyproviders = async (options) => invokeFetch("encryption", {
22
+ method: "get",
23
+ pathTemplate: "/api/v1/encryption/keyproviders/actions/list",
24
+ options
25
+ });
26
+ var resetEncryptionKeyproviders = async (options) => invokeFetch("encryption", {
27
+ method: "post",
28
+ pathTemplate: "/api/v1/encryption/keyproviders/actions/reset-to-default-provider",
29
+ options
30
+ });
31
+ var getEncryptionKeyprovidersMigrationDetails = async (options) => invokeFetch("encryption", {
32
+ method: "get",
33
+ pathTemplate: "/api/v1/encryption/keyproviders/migration/actions/details",
34
+ options
35
+ });
36
+ var deleteEncryptionKeyprovider = async (arnFingerPrint, options) => invokeFetch("encryption", {
37
+ method: "delete",
38
+ pathTemplate: "/api/v1/encryption/keyproviders/{arnFingerPrint}",
39
+ pathVariables: { arnFingerPrint },
40
+ options
41
+ });
42
+ var getEncryptionKeyprovider = async (arnFingerPrint, options) => invokeFetch("encryption", {
43
+ method: "get",
44
+ pathTemplate: "/api/v1/encryption/keyproviders/{arnFingerPrint}",
45
+ pathVariables: { arnFingerPrint },
46
+ options
47
+ });
48
+ var patchEncryptionKeyprovider = async (arnFingerPrint, body, options) => invokeFetch("encryption", {
49
+ method: "patch",
50
+ pathTemplate: "/api/v1/encryption/keyproviders/{arnFingerPrint}",
51
+ pathVariables: { arnFingerPrint },
52
+ body,
53
+ contentType: "application/json",
54
+ options
55
+ });
56
+ var migrateEncryptionKeyprovider = async (arnFingerPrint, options) => invokeFetch("encryption", {
57
+ method: "post",
58
+ pathTemplate: "/api/v1/encryption/keyproviders/{arnFingerPrint}/actions/migrate",
59
+ pathVariables: { arnFingerPrint },
60
+ options
61
+ });
62
+ var testEncryptionKeyprovider = async (arnFingerPrint, options) => invokeFetch("encryption", {
63
+ method: "post",
64
+ pathTemplate: "/api/v1/encryption/keyproviders/{arnFingerPrint}/actions/test",
65
+ pathVariables: { arnFingerPrint },
66
+ options
67
+ });
68
+ function clearCache() {
69
+ return clearApiCache("encryption");
70
+ }
71
+ var encryptionExport = {
72
+ getEncryptionKeyproviders,
73
+ createEncryptionKeyprovider,
74
+ listEncryptionKeyproviders,
75
+ resetEncryptionKeyproviders,
76
+ getEncryptionKeyprovidersMigrationDetails,
77
+ deleteEncryptionKeyprovider,
78
+ getEncryptionKeyprovider,
79
+ patchEncryptionKeyprovider,
80
+ migrateEncryptionKeyprovider,
81
+ testEncryptionKeyprovider,
82
+ clearCache
83
+ };
84
+ var encryption_default = encryptionExport;
85
+ export {
86
+ clearCache,
87
+ createEncryptionKeyprovider,
88
+ encryption_default as default,
89
+ deleteEncryptionKeyprovider,
90
+ getEncryptionKeyprovider,
91
+ getEncryptionKeyproviders,
92
+ getEncryptionKeyprovidersMigrationDetails,
93
+ listEncryptionKeyproviders,
94
+ migrateEncryptionKeyprovider,
95
+ patchEncryptionKeyprovider,
96
+ resetEncryptionKeyproviders,
97
+ testEncryptionKeyprovider
98
+ };
package/extensions.d.ts CHANGED
@@ -1,5 +1,5 @@
1
- import { A as ApiCallOptions } from './invoke-fetch-types-BXn-uSF5.js';
2
- import './auth-types-PkN9CAF_.js';
1
+ import { A as ApiCallOptions } from './invoke-fetch-types-Cq7bjkqn.js';
2
+ import './auth-types-DqfMuSRX.js';
3
3
 
4
4
  /**
5
5
  * Object containing meta data regarding the bundle the extension belongs to. If it does not belong to a bundle, this object is not defined.