@qlik/api 1.31.0 → 1.33.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.
- package/api-keys.d.ts +10 -10
- package/api-keys.js +64 -50
- package/apps.d.ts +56 -56
- package/apps.js +392 -304
- package/assistants.d.ts +1301 -0
- package/assistants.js +329 -0
- package/audits.d.ts +10 -10
- package/audits.js +48 -36
- package/{auth-types-DqfMuSRX.d.ts → auth-types-Cj5bM3Yk.d.ts} +29 -9
- package/auth.d.ts +17 -4
- package/auth.js +4 -2
- package/automation-connections.d.ts +366 -0
- package/automation-connections.js +107 -0
- package/automations.d.ts +27 -27
- package/automations.js +159 -123
- package/automl-deployments.d.ts +97 -0
- package/automl-deployments.js +29 -0
- package/automl-predictions.d.ts +214 -0
- package/automl-predictions.js +84 -0
- package/brands.d.ts +18 -18
- package/brands.js +107 -83
- package/chunks/{KBSD75QL.js → 33GQY7N7.js} +1 -1
- package/chunks/{M64RLKVG.js → 62DXIH3S.js} +7 -5
- package/chunks/7MMXU6EL.js +86 -0
- package/chunks/{DLKLPD7T.js → GPRUNZV4.js} +3 -3
- package/chunks/{YKZ2QYHN.js → LIEZG7IM.js} +3 -3
- package/chunks/{FKDGGR2O.js → OTIO4SEJ.js} +698 -708
- package/chunks/{UZTIZ4H5.js → RP3EJGHG.js} +74 -74
- package/chunks/{GUU3KZGK.js → SPATCXXU.js} +9 -2
- package/chunks/{LY7RP2HA.js → XF3TPZKZ.js} +23 -8
- package/chunks/{6ZONDHRN.js → YYZCS5PW.js} +11 -4
- package/chunks/{3RGGGGAR.js → ZCTVPXGO.js} +1 -1
- package/collections.d.ts +16 -15
- package/collections.js +98 -76
- package/conditions.d.ts +662 -0
- package/conditions.js +135 -0
- package/consumption.d.ts +182 -0
- package/consumption.js +26 -0
- package/csp-origins.d.ts +9 -9
- package/csp-origins.js +53 -41
- package/csrf-token.d.ts +62 -0
- package/csrf-token.js +25 -0
- package/data-alerts.d.ts +1004 -0
- package/data-alerts.js +187 -0
- package/data-assets.d.ts +8 -8
- package/data-assets.js +50 -40
- package/data-connections.d.ts +16 -16
- package/data-connections.js +87 -69
- package/data-credentials.d.ts +11 -11
- package/data-credentials.js +52 -42
- package/data-files.d.ts +18 -18
- package/data-files.js +107 -83
- package/data-qualities.d.ts +175 -0
- package/data-qualities.js +50 -0
- package/data-sets.d.ts +424 -0
- package/data-sets.js +87 -0
- package/data-sources.d.ts +268 -0
- package/data-sources.js +45 -0
- package/data-stores.d.ts +537 -0
- package/data-stores.js +128 -0
- package/dcaas.d.ts +192 -0
- package/dcaas.js +45 -0
- package/di-projects.d.ts +673 -0
- package/di-projects.js +196 -0
- package/direct-access-agents.d.ts +328 -0
- package/direct-access-agents.js +108 -0
- package/encryption.d.ts +370 -0
- package/encryption.js +118 -0
- package/extensions.d.ts +11 -11
- package/extensions.js +61 -47
- package/glossaries.d.ts +33 -33
- package/glossaries.js +221 -173
- package/groups.d.ts +12 -12
- package/groups.js +72 -56
- package/identity-providers.d.ts +11 -11
- package/identity-providers.js +67 -51
- package/index.d.ts +113 -4
- package/index.js +626 -40
- package/interceptors.d.ts +9 -2
- package/interceptors.js +2 -2
- package/invoke-fetch-types-BYCD4pc9.d.ts +98 -0
- package/items.d.ts +14 -13
- package/items.js +71 -55
- package/knowledgebases.d.ts +890 -0
- package/knowledgebases.js +203 -0
- package/licenses.d.ts +14 -14
- package/licenses.js +76 -58
- package/lineage-graphs.d.ts +712 -0
- package/lineage-graphs.js +108 -0
- package/ml.d.ts +2676 -0
- package/ml.js +477 -0
- package/notes.d.ts +110 -0
- package/notes.js +35 -0
- package/notifications.d.ts +98 -0
- package/notifications.js +26 -0
- package/oauth-clients.d.ts +14 -14
- package/oauth-clients.js +96 -74
- package/oauth-tokens.d.ts +126 -0
- package/oauth-tokens.js +35 -0
- package/package.json +34 -6
- package/qix.d.ts +145 -4
- package/qix.js +2 -2
- package/questions.d.ts +364 -0
- package/questions.js +38 -0
- package/quotas.d.ts +6 -6
- package/quotas.js +20 -16
- package/reload-tasks.d.ts +8 -8
- package/reload-tasks.js +46 -36
- package/reloads.d.ts +7 -7
- package/reloads.js +36 -28
- package/report-templates.d.ts +287 -0
- package/report-templates.js +94 -0
- package/reports.d.ts +4 -4
- package/reports.js +20 -16
- package/roles.d.ts +8 -8
- package/roles.js +46 -36
- package/sharing-tasks.d.ts +952 -0
- package/sharing-tasks.js +125 -0
- package/spaces.d.ts +22 -22
- package/spaces.js +153 -119
- package/tasks.d.ts +564 -0
- package/tasks.js +126 -0
- package/temp-contents.d.ts +7 -7
- package/temp-contents.js +30 -24
- package/tenants.d.ts +8 -8
- package/tenants.js +57 -45
- package/themes.d.ts +11 -11
- package/themes.js +61 -47
- package/transports.d.ts +8 -8
- package/transports.js +49 -37
- package/ui-config.d.ts +274 -0
- package/ui-config.js +91 -0
- package/users.d.ts +15 -15
- package/users.js +81 -63
- package/web-integrations.d.ts +8 -8
- package/web-integrations.js +46 -36
- package/web-notifications.d.ts +9 -9
- package/web-notifications.js +53 -41
- package/webhooks.d.ts +14 -14
- package/webhooks.js +88 -68
- package/chunks/2ZQ3ZX7F.js +0 -33
- package/invoke-fetch-types-Cq7bjkqn.d.ts +0 -243
package/encryption.d.ts
ADDED
|
@@ -0,0 +1,370 @@
|
|
|
1
|
+
import { A as ApiCallOptions } from './invoke-fetch-types-BYCD4pc9.js';
|
|
2
|
+
import './auth-types-Cj5bM3Yk.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 function 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 function 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 function 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 function 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 function 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 function 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 function 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 function 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 function 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 function 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,118 @@
|
|
|
1
|
+
import {
|
|
2
|
+
clearApiCache,
|
|
3
|
+
invokeFetch
|
|
4
|
+
} from "./chunks/LIEZG7IM.js";
|
|
5
|
+
import "./chunks/GPRUNZV4.js";
|
|
6
|
+
import "./chunks/7MMXU6EL.js";
|
|
7
|
+
|
|
8
|
+
// src/public/rest/encryption.ts
|
|
9
|
+
async function getEncryptionKeyproviders(options) {
|
|
10
|
+
return invokeFetch("encryption", {
|
|
11
|
+
method: "get",
|
|
12
|
+
pathTemplate: "/api/v1/encryption/keyproviders",
|
|
13
|
+
options
|
|
14
|
+
});
|
|
15
|
+
}
|
|
16
|
+
async function createEncryptionKeyprovider(body, options) {
|
|
17
|
+
return invokeFetch("encryption", {
|
|
18
|
+
method: "post",
|
|
19
|
+
pathTemplate: "/api/v1/encryption/keyproviders",
|
|
20
|
+
body,
|
|
21
|
+
contentType: "application/json",
|
|
22
|
+
options
|
|
23
|
+
});
|
|
24
|
+
}
|
|
25
|
+
async function listEncryptionKeyproviders(options) {
|
|
26
|
+
return invokeFetch("encryption", {
|
|
27
|
+
method: "get",
|
|
28
|
+
pathTemplate: "/api/v1/encryption/keyproviders/actions/list",
|
|
29
|
+
options
|
|
30
|
+
});
|
|
31
|
+
}
|
|
32
|
+
async function resetEncryptionKeyproviders(options) {
|
|
33
|
+
return invokeFetch("encryption", {
|
|
34
|
+
method: "post",
|
|
35
|
+
pathTemplate: "/api/v1/encryption/keyproviders/actions/reset-to-default-provider",
|
|
36
|
+
options
|
|
37
|
+
});
|
|
38
|
+
}
|
|
39
|
+
async function getEncryptionKeyprovidersMigrationDetails(options) {
|
|
40
|
+
return invokeFetch("encryption", {
|
|
41
|
+
method: "get",
|
|
42
|
+
pathTemplate: "/api/v1/encryption/keyproviders/migration/actions/details",
|
|
43
|
+
options
|
|
44
|
+
});
|
|
45
|
+
}
|
|
46
|
+
async function deleteEncryptionKeyprovider(arnFingerPrint, options) {
|
|
47
|
+
return invokeFetch("encryption", {
|
|
48
|
+
method: "delete",
|
|
49
|
+
pathTemplate: "/api/v1/encryption/keyproviders/{arnFingerPrint}",
|
|
50
|
+
pathVariables: { arnFingerPrint },
|
|
51
|
+
options
|
|
52
|
+
});
|
|
53
|
+
}
|
|
54
|
+
async function getEncryptionKeyprovider(arnFingerPrint, options) {
|
|
55
|
+
return invokeFetch("encryption", {
|
|
56
|
+
method: "get",
|
|
57
|
+
pathTemplate: "/api/v1/encryption/keyproviders/{arnFingerPrint}",
|
|
58
|
+
pathVariables: { arnFingerPrint },
|
|
59
|
+
options
|
|
60
|
+
});
|
|
61
|
+
}
|
|
62
|
+
async function patchEncryptionKeyprovider(arnFingerPrint, body, options) {
|
|
63
|
+
return invokeFetch("encryption", {
|
|
64
|
+
method: "patch",
|
|
65
|
+
pathTemplate: "/api/v1/encryption/keyproviders/{arnFingerPrint}",
|
|
66
|
+
pathVariables: { arnFingerPrint },
|
|
67
|
+
body,
|
|
68
|
+
contentType: "application/json",
|
|
69
|
+
options
|
|
70
|
+
});
|
|
71
|
+
}
|
|
72
|
+
async function migrateEncryptionKeyprovider(arnFingerPrint, options) {
|
|
73
|
+
return invokeFetch("encryption", {
|
|
74
|
+
method: "post",
|
|
75
|
+
pathTemplate: "/api/v1/encryption/keyproviders/{arnFingerPrint}/actions/migrate",
|
|
76
|
+
pathVariables: { arnFingerPrint },
|
|
77
|
+
options
|
|
78
|
+
});
|
|
79
|
+
}
|
|
80
|
+
async function testEncryptionKeyprovider(arnFingerPrint, options) {
|
|
81
|
+
return invokeFetch("encryption", {
|
|
82
|
+
method: "post",
|
|
83
|
+
pathTemplate: "/api/v1/encryption/keyproviders/{arnFingerPrint}/actions/test",
|
|
84
|
+
pathVariables: { arnFingerPrint },
|
|
85
|
+
options
|
|
86
|
+
});
|
|
87
|
+
}
|
|
88
|
+
function clearCache() {
|
|
89
|
+
return clearApiCache("encryption");
|
|
90
|
+
}
|
|
91
|
+
var encryptionExport = {
|
|
92
|
+
getEncryptionKeyproviders,
|
|
93
|
+
createEncryptionKeyprovider,
|
|
94
|
+
listEncryptionKeyproviders,
|
|
95
|
+
resetEncryptionKeyproviders,
|
|
96
|
+
getEncryptionKeyprovidersMigrationDetails,
|
|
97
|
+
deleteEncryptionKeyprovider,
|
|
98
|
+
getEncryptionKeyprovider,
|
|
99
|
+
patchEncryptionKeyprovider,
|
|
100
|
+
migrateEncryptionKeyprovider,
|
|
101
|
+
testEncryptionKeyprovider,
|
|
102
|
+
clearCache
|
|
103
|
+
};
|
|
104
|
+
var encryption_default = encryptionExport;
|
|
105
|
+
export {
|
|
106
|
+
clearCache,
|
|
107
|
+
createEncryptionKeyprovider,
|
|
108
|
+
encryption_default as default,
|
|
109
|
+
deleteEncryptionKeyprovider,
|
|
110
|
+
getEncryptionKeyprovider,
|
|
111
|
+
getEncryptionKeyproviders,
|
|
112
|
+
getEncryptionKeyprovidersMigrationDetails,
|
|
113
|
+
listEncryptionKeyproviders,
|
|
114
|
+
migrateEncryptionKeyprovider,
|
|
115
|
+
patchEncryptionKeyprovider,
|
|
116
|
+
resetEncryptionKeyproviders,
|
|
117
|
+
testEncryptionKeyprovider
|
|
118
|
+
};
|
package/extensions.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import { A as ApiCallOptions } from './invoke-fetch-types-
|
|
2
|
-
import './auth-types-
|
|
1
|
+
import { A as ApiCallOptions } from './invoke-fetch-types-BYCD4pc9.js';
|
|
2
|
+
import './auth-types-Cj5bM3Yk.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.
|
|
@@ -100,7 +100,7 @@ type Meta = {
|
|
|
100
100
|
*
|
|
101
101
|
* @throws GetExtensionsHttpError
|
|
102
102
|
*/
|
|
103
|
-
declare
|
|
103
|
+
declare function getExtensions(options?: ApiCallOptions): Promise<GetExtensionsHttpResponse>;
|
|
104
104
|
type GetExtensionsHttpResponse = {
|
|
105
105
|
data: Extensions;
|
|
106
106
|
headers: Headers;
|
|
@@ -117,12 +117,12 @@ type GetExtensionsHttpError = {
|
|
|
117
117
|
* @param body an object with the body content
|
|
118
118
|
* @throws UploadExtensionHttpError
|
|
119
119
|
*/
|
|
120
|
-
declare
|
|
120
|
+
declare function uploadExtension(body: {
|
|
121
121
|
/** The extension model. */
|
|
122
122
|
data?: Extension;
|
|
123
123
|
/** Extension archive. */
|
|
124
124
|
file?: BodyInit;
|
|
125
|
-
}, options?: ApiCallOptions)
|
|
125
|
+
}, options?: ApiCallOptions): Promise<UploadExtensionHttpResponse>;
|
|
126
126
|
type UploadExtensionHttpResponse = {
|
|
127
127
|
data: Extension;
|
|
128
128
|
headers: Headers;
|
|
@@ -139,7 +139,7 @@ type UploadExtensionHttpError = {
|
|
|
139
139
|
* @param id Extension identifier or its qextFilename.
|
|
140
140
|
* @throws DeleteExtensionHttpError
|
|
141
141
|
*/
|
|
142
|
-
declare
|
|
142
|
+
declare function deleteExtension(id: string, options?: ApiCallOptions): Promise<DeleteExtensionHttpResponse>;
|
|
143
143
|
type DeleteExtensionHttpResponse = {
|
|
144
144
|
data: void;
|
|
145
145
|
headers: Headers;
|
|
@@ -156,7 +156,7 @@ type DeleteExtensionHttpError = {
|
|
|
156
156
|
* @param id Extension identifier or its qextFilename.
|
|
157
157
|
* @throws GetExtensionHttpError
|
|
158
158
|
*/
|
|
159
|
-
declare
|
|
159
|
+
declare function getExtension(id: string, options?: ApiCallOptions): Promise<GetExtensionHttpResponse>;
|
|
160
160
|
type GetExtensionHttpResponse = {
|
|
161
161
|
data: Extension;
|
|
162
162
|
headers: Headers;
|
|
@@ -174,12 +174,12 @@ type GetExtensionHttpError = {
|
|
|
174
174
|
* @param body an object with the body content
|
|
175
175
|
* @throws PatchExtensionHttpError
|
|
176
176
|
*/
|
|
177
|
-
declare
|
|
177
|
+
declare function patchExtension(id: string, body: {
|
|
178
178
|
/** The extension model. */
|
|
179
179
|
data?: Extension;
|
|
180
180
|
/** Extension archive. */
|
|
181
181
|
file?: BodyInit;
|
|
182
|
-
}, options?: ApiCallOptions)
|
|
182
|
+
}, options?: ApiCallOptions): Promise<PatchExtensionHttpResponse>;
|
|
183
183
|
type PatchExtensionHttpResponse = {
|
|
184
184
|
data: Extension;
|
|
185
185
|
headers: Headers;
|
|
@@ -196,7 +196,7 @@ type PatchExtensionHttpError = {
|
|
|
196
196
|
* @param id Extension identifier or its qextFilename.
|
|
197
197
|
* @throws DownloadExtensionHttpError
|
|
198
198
|
*/
|
|
199
|
-
declare
|
|
199
|
+
declare function downloadExtension(id: string, options?: ApiCallOptions): Promise<DownloadExtensionHttpResponse>;
|
|
200
200
|
type DownloadExtensionHttpResponse = {
|
|
201
201
|
data: void;
|
|
202
202
|
headers: Headers;
|
|
@@ -214,7 +214,7 @@ type DownloadExtensionHttpError = {
|
|
|
214
214
|
* @param filepath Path to the file location within the specified extension archive. Folders separated with forward slashes.
|
|
215
215
|
* @throws DownloadFileFromExtensionHttpError
|
|
216
216
|
*/
|
|
217
|
-
declare
|
|
217
|
+
declare function downloadFileFromExtension(id: string, filepath: string, options?: ApiCallOptions): Promise<DownloadFileFromExtensionHttpResponse>;
|
|
218
218
|
type DownloadFileFromExtensionHttpResponse = {
|
|
219
219
|
data: void;
|
|
220
220
|
headers: Headers;
|
package/extensions.js
CHANGED
|
@@ -1,55 +1,69 @@
|
|
|
1
1
|
import {
|
|
2
2
|
clearApiCache,
|
|
3
3
|
invokeFetch
|
|
4
|
-
} from "./chunks/
|
|
5
|
-
import "./chunks/
|
|
6
|
-
import "./chunks/
|
|
4
|
+
} from "./chunks/LIEZG7IM.js";
|
|
5
|
+
import "./chunks/GPRUNZV4.js";
|
|
6
|
+
import "./chunks/7MMXU6EL.js";
|
|
7
7
|
|
|
8
8
|
// src/public/rest/extensions.ts
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
}
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
}
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
9
|
+
async function getExtensions(options) {
|
|
10
|
+
return invokeFetch("extensions", {
|
|
11
|
+
method: "get",
|
|
12
|
+
pathTemplate: "/api/v1/extensions",
|
|
13
|
+
options
|
|
14
|
+
});
|
|
15
|
+
}
|
|
16
|
+
async function uploadExtension(body, options) {
|
|
17
|
+
return invokeFetch("extensions", {
|
|
18
|
+
method: "post",
|
|
19
|
+
pathTemplate: "/api/v1/extensions",
|
|
20
|
+
body,
|
|
21
|
+
contentType: "multipart/form-data",
|
|
22
|
+
options
|
|
23
|
+
});
|
|
24
|
+
}
|
|
25
|
+
async function deleteExtension(id, options) {
|
|
26
|
+
return invokeFetch("extensions", {
|
|
27
|
+
method: "delete",
|
|
28
|
+
pathTemplate: "/api/v1/extensions/{id}",
|
|
29
|
+
pathVariables: { id },
|
|
30
|
+
options
|
|
31
|
+
});
|
|
32
|
+
}
|
|
33
|
+
async function getExtension(id, options) {
|
|
34
|
+
return invokeFetch("extensions", {
|
|
35
|
+
method: "get",
|
|
36
|
+
pathTemplate: "/api/v1/extensions/{id}",
|
|
37
|
+
pathVariables: { id },
|
|
38
|
+
options
|
|
39
|
+
});
|
|
40
|
+
}
|
|
41
|
+
async function patchExtension(id, body, options) {
|
|
42
|
+
return invokeFetch("extensions", {
|
|
43
|
+
method: "patch",
|
|
44
|
+
pathTemplate: "/api/v1/extensions/{id}",
|
|
45
|
+
pathVariables: { id },
|
|
46
|
+
body,
|
|
47
|
+
contentType: "multipart/form-data",
|
|
48
|
+
options
|
|
49
|
+
});
|
|
50
|
+
}
|
|
51
|
+
async function downloadExtension(id, options) {
|
|
52
|
+
return invokeFetch("extensions", {
|
|
53
|
+
method: "get",
|
|
54
|
+
pathTemplate: "/api/v1/extensions/{id}/file",
|
|
55
|
+
pathVariables: { id },
|
|
56
|
+
options
|
|
57
|
+
});
|
|
58
|
+
}
|
|
59
|
+
async function downloadFileFromExtension(id, filepath, options) {
|
|
60
|
+
return invokeFetch("extensions", {
|
|
61
|
+
method: "get",
|
|
62
|
+
pathTemplate: "/api/v1/extensions/{id}/file/{filepath}",
|
|
63
|
+
pathVariables: { id, filepath },
|
|
64
|
+
options
|
|
65
|
+
});
|
|
66
|
+
}
|
|
53
67
|
function clearCache() {
|
|
54
68
|
return clearApiCache("extensions");
|
|
55
69
|
}
|