@qlik/api 2.2.0 → 2.3.1

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 (232) 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-XusKk8IA.js +32 -0
  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-2VSXImC9.js} +498 -146
  35. package/chunks/{invoke-fetch-PcVIxLW4.js → invoke-fetch-CckTK7bh.js} +3 -3
  36. package/chunks/{invoke-fetch-CucBpA1C.js → invoke-fetch-D9lpiAb-.js} +1 -5
  37. package/chunks/{public-runtime-modules-Dwjzb3l8.js → public-runtime-modules-BqxAMJ9M.js} +7 -7
  38. package/chunks/{qix-DI5o5XF4.d.ts → qix-CrqXv44x.d.ts} +6 -2
  39. package/chunks/{qix-DjxuPCX0.js → qix-DpvHvpx7.js} +11 -10
  40. package/chunks/{qix-chunk-entrypoint-tmTo-kpa.js → qix-chunk-entrypoint-BXZPnE6J.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 +5 -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-Cle0_tmz.js +0 -32
  163. package/chunks/auth-D11iO7ZV.js +0 -65
  164. package/chunks/automation-connections-k2G_n9rj.d.ts +0 -366
  165. package/chunks/automation-connectors-J5OE-1P0.d.ts +0 -84
  166. package/chunks/automations-BGy83EBO.d.ts +0 -797
  167. package/chunks/automl-deployments-CWEpX2pk.d.ts +0 -101
  168. package/chunks/automl-predictions-BNIjRhBm.d.ts +0 -238
  169. package/chunks/banners-CgBRnZGv.d.ts +0 -184
  170. package/chunks/brands-DCgk6Gqx.d.ts +0 -671
  171. package/chunks/collections-BpYjcpIY.d.ts +0 -582
  172. package/chunks/conditions-CJJG7Uph.d.ts +0 -662
  173. package/chunks/consumption-DerFk437.d.ts +0 -182
  174. package/chunks/core-DQXNZdnf.d.ts +0 -12
  175. package/chunks/csp-origins-3NJlh_n9.d.ts +0 -273
  176. package/chunks/csrf-token-DoaoOQzH.d.ts +0 -63
  177. package/chunks/data-alerts-CILSEFbQ.d.ts +0 -1004
  178. package/chunks/data-assets-CJDcssoX.d.ts +0 -207
  179. package/chunks/data-connections-VSB13K6g.d.ts +0 -678
  180. package/chunks/data-credentials-ChEp_hyU.d.ts +0 -292
  181. package/chunks/data-files-CVzn9M6V.d.ts +0 -860
  182. package/chunks/data-qualities-DBrot957.d.ts +0 -176
  183. package/chunks/data-sets-CFzxgWnO.d.ts +0 -424
  184. package/chunks/data-sources-IsAaof_C.d.ts +0 -346
  185. package/chunks/data-stores-DFOPdgfz.d.ts +0 -537
  186. package/chunks/dcaas-qyv7YlrN.d.ts +0 -192
  187. package/chunks/di-projects-DVQTxASr.d.ts +0 -777
  188. package/chunks/direct-access-agents-B77OhzZi.d.ts +0 -580
  189. package/chunks/encryption-BjA6xbCO.d.ts +0 -372
  190. package/chunks/extensions-OO0WtInj.d.ts +0 -294
  191. package/chunks/glossaries-CIX7-KT_.d.ts +0 -1213
  192. package/chunks/groups-C86-UG7S.d.ts +0 -511
  193. package/chunks/identity-providers-h0dKNxGZ.d.ts +0 -711
  194. package/chunks/interceptors-Csx2tEi5.d.ts +0 -52
  195. package/chunks/interceptors-DTYm37AU.js +0 -104
  196. package/chunks/ip-policies-CKRIlbP7.d.ts +0 -327
  197. package/chunks/ip-policies-DXlf172B.js +0 -108
  198. package/chunks/items-C-jzqvFW.d.ts +0 -536
  199. package/chunks/knowledgebases-CyQtVcZN.d.ts +0 -977
  200. package/chunks/licenses-xzjnkitW.d.ts +0 -663
  201. package/chunks/lineage-graphs-CViCCzKy.d.ts +0 -697
  202. package/chunks/ml-Abt2MUva.d.ts +0 -2809
  203. package/chunks/notes-BZxuyDgt.d.ts +0 -111
  204. package/chunks/notifications-Bd_gp4jU.d.ts +0 -99
  205. package/chunks/oauth-clients-B5QPr4IM.d.ts +0 -563
  206. package/chunks/oauth-tokens-1b7V8182.d.ts +0 -127
  207. package/chunks/qix-CYQsLyGQ.js +0 -40
  208. package/chunks/questions-BVp0tvNs.d.ts +0 -364
  209. package/chunks/quotas-CfAebRJd.d.ts +0 -113
  210. package/chunks/reload-tasks-DfwUTetn.d.ts +0 -249
  211. package/chunks/reloads-CwmagnFx.d.ts +0 -260
  212. package/chunks/report-templates-DjQYj5dn.d.ts +0 -287
  213. package/chunks/reports-DzNC6Uq3.d.ts +0 -861
  214. package/chunks/roles-BYFIY6E7.d.ts +0 -312
  215. package/chunks/sharing-tasks-BMGIQ-FO.d.ts +0 -1164
  216. package/chunks/spaces-BK823t-b.d.ts +0 -780
  217. package/chunks/tasks-COKDfShO.d.ts +0 -564
  218. package/chunks/temp-contents-zDomB-g6.d.ts +0 -168
  219. package/chunks/tenants-Bhn86519.d.ts +0 -361
  220. package/chunks/themes-v9NbhiBo.d.ts +0 -269
  221. package/chunks/transports-CqEiFxD3.d.ts +0 -362
  222. package/chunks/ui-config-Crs0mVMp.d.ts +0 -274
  223. package/chunks/users-BSOBU_fg.d.ts +0 -675
  224. package/chunks/web-integrations-MisPAHod.d.ts +0 -295
  225. package/chunks/web-notifications-DVy6FHYh.d.ts +0 -274
  226. package/chunks/webhooks-Dr4EiXqy.d.ts +0 -505
  227. /package/chunks/{auth-types-E99tzdN0.d.ts → auth-types-YrlH_R9f.d.ts} +0 -0
  228. /package/chunks/{auth-types-JehqruDP.js → auth-types-h43TVDpB.js} +0 -0
  229. /package/chunks/{global-types-CrOvI33z.js → global-types-CEVAJebk.js} +0 -0
  230. /package/chunks/{invoke-fetch-CbU2Dgqr.d.ts → invoke-fetch-C1Z0RJYU.d.ts} +0 -0
  231. /package/chunks/{utils-BnC4lrlq.js → utils-vv-xFm06.js} +0 -0
  232. /package/chunks/{websocket-errors-DSbO6kDZ.js → websocket-errors-CRTDTtBL.js} +0 -0
@@ -1,372 +0,0 @@
1
- import { y as ApiCallOptions } from "./auth-types-E99tzdN0.js";
2
-
3
- //#region src/public/rest/encryption.d.ts
4
-
5
- /**
6
- * @example
7
- * {
8
- * arn: "arn:aws:kms:eu-west-1:111222334455:key/mrk-1237c011a37erft67ei987c7612q456",
9
- * current: false,
10
- * description: "test description",
11
- * keyprovider: "AWS-KMS",
12
- * multiRegion: true,
13
- * name: "test name",
14
- * replicaKeys: [
15
- * {
16
- * arn: "arn:aws:kms:eu-west-3:111222334455:key/mrk-1237c011a37erft67ei987c7612q456",
17
- * region: "eu-west-3"
18
- * }
19
- * ]
20
- * }
21
- */
22
- type KeyProvider = {
23
- /** The provider resource notation for the key. */
24
- arn: string;
25
- /** The ARN fingerprint. */
26
- readonly arnFingerPrint?: string;
27
- /** When key entry was created. */
28
- readonly createdAt?: string;
29
- /** Indicates whether the key is being used to encrypt/decrypt secrets. */
30
- readonly current?: boolean;
31
- /** When the key was demoted from being current to non active. */
32
- readonly demotedFromCurrentAt?: string;
33
- /** Description of key provider entry. */
34
- description?: string;
35
- /** Key Provider type. */
36
- keyprovider: "AWS-KMS";
37
- /** Indicates whether the key has multi-region configurations and has replica key in qcs secondary region. */
38
- readonly multiRegion?: boolean;
39
- /** Name of key provider entry. */
40
- name: string;
41
- /** When the key was promoted to being the current active one. */
42
- readonly promotedToCurrentAt?: string;
43
- readonly replicaKeys?: {
44
- /** Replica key keeps list of backup keys from the supported qcs secondary region. */
45
- arn?: string;
46
- /** Region indicates the backup qcs-region link to the primary region. */
47
- region?: string;
48
- }[];
49
- /** Tenant ID. */
50
- readonly tenantId?: string;
51
- };
52
- /**
53
- * A JSON Patch document as defined in https://datatracker.ietf.org/doc/html/rfc6902.
54
- * @example
55
- * {
56
- * op: "replace",
57
- * path: "/name",
58
- * value: "New Encryption Key"
59
- * }
60
- */
61
- type KeyProviderPatchBase = {
62
- /** The operation to be performed. */
63
- op: "replace";
64
- /** The property path. */
65
- path: string;
66
- /** The value to be used for this operation. */
67
- value: string;
68
- };
69
- type KeyProviderPatchSchema = KeyProviderPatchBase[];
70
- type KeyProviders = {
71
- errors?: KeyProvider[];
72
- };
73
- type KeyProvidersDeleteResponseBody = {
74
- /** Successful response message. */
75
- response?: string;
76
- };
77
- type ListKeyProviders = {
78
- errors?: KeyProvider[];
79
- };
80
- type MigrationInformation = {
81
- completedAt?: string;
82
- /** Migration operation ID. */
83
- id?: string;
84
- initiatedAt?: string;
85
- /** The key ARN being migrated from (in case of QlikVault, could be a short name only). */
86
- migratingFrom?: string;
87
- /** The new key ARN that keys should be migrated to. */
88
- migratingTo?: string;
89
- /** The new key ARN fingerprint. */
90
- migratingToFingerprint?: string;
91
- /** The new key prefix (to help services know which prefix should NOT be migrated). */
92
- migratingToPrefix?: string;
93
- /** Progress in percentage. */
94
- progress?: number;
95
- /** Migration operation state. */
96
- state?: "New" | "InProgress" | "Completed";
97
- /** Tenant ID. */
98
- tenantId?: string;
99
- };
100
- type ResetMigrationNotNeeded = {
101
- /** Tenant is already using Qlik KMS, no migration is required. */
102
- message?: string;
103
- };
104
- type StandardError = {
105
- errors: StandardErrorItem[];
106
- };
107
- type StandardErrorItem = {
108
- /** The error code. */
109
- code: string;
110
- /** Extra information about the error. */
111
- detail?: string;
112
- /** Additional error object metadata. */
113
- meta?: unknown;
114
- /** Description of the error. */
115
- title: string;
116
- };
117
- /**
118
- * Returns a list of AWS key providers in the tenant. Use /actions/list to return all key providers.
119
- *
120
- * @throws GetEncryptionKeyprovidersHttpError
121
- */
122
- declare function getEncryptionKeyproviders(options?: ApiCallOptions): Promise<GetEncryptionKeyprovidersHttpResponse>;
123
- type GetEncryptionKeyprovidersHttpResponse = {
124
- data: KeyProviders;
125
- headers: Headers;
126
- status: 200;
127
- };
128
- type GetEncryptionKeyprovidersHttpError = {
129
- data: StandardError;
130
- headers: Headers;
131
- status: 400 | 417;
132
- };
133
- /**
134
- * 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.
135
- *
136
- * @param body an object with the body content
137
- * @throws CreateEncryptionKeyproviderHttpError
138
- */
139
- declare function createEncryptionKeyprovider(body: KeyProvider, options?: ApiCallOptions): Promise<CreateEncryptionKeyproviderHttpResponse>;
140
- type CreateEncryptionKeyproviderHttpResponse = {
141
- data: KeyProvider;
142
- headers: Headers;
143
- status: 201;
144
- };
145
- type CreateEncryptionKeyproviderHttpError = {
146
- data: StandardError;
147
- headers: Headers;
148
- status: 400 | 401 | 403 | 406 | 408 | 409 | 417;
149
- };
150
- /**
151
- * Returns a list of all key providers in the tenant, including the default Qlik key provider.
152
- *
153
- * @throws ListEncryptionKeyprovidersHttpError
154
- */
155
- declare function listEncryptionKeyproviders(options?: ApiCallOptions): Promise<ListEncryptionKeyprovidersHttpResponse>;
156
- type ListEncryptionKeyprovidersHttpResponse = {
157
- data: ListKeyProviders;
158
- headers: Headers;
159
- status: 200;
160
- };
161
- type ListEncryptionKeyprovidersHttpError = {
162
- data: StandardError;
163
- headers: Headers;
164
- status: 400 | 417;
165
- };
166
- /**
167
- * Reset the encryption key back to the default Qlik managed provider. No action will be taken if tenant is already using the Qlik provider.
168
- *
169
- * @throws ResetEncryptionKeyprovidersHttpError
170
- */
171
- declare function resetEncryptionKeyproviders(options?: ApiCallOptions): Promise<ResetEncryptionKeyprovidersHttpResponse>;
172
- type ResetEncryptionKeyprovidersHttpResponse = ResetEncryptionKeyproviders200HttpResponse | ResetEncryptionKeyproviders205HttpResponse;
173
- type ResetEncryptionKeyproviders200HttpResponse = {
174
- data: ResetMigrationNotNeeded;
175
- headers: Headers;
176
- status: 200;
177
- };
178
- type ResetEncryptionKeyproviders205HttpResponse = {
179
- data: MigrationInformation;
180
- headers: Headers;
181
- status: 205;
182
- };
183
- type ResetEncryptionKeyprovidersHttpError = {
184
- data: StandardError;
185
- headers: Headers;
186
- status: 401 | 406 | 412 | 424;
187
- };
188
- /**
189
- * Retrieve details for the ongoing or last completed migration for the tenant.
190
- *
191
- * @throws GetEncryptionKeyprovidersMigrationDetailsHttpError
192
- */
193
- declare function getEncryptionKeyprovidersMigrationDetails(options?: ApiCallOptions): Promise<GetEncryptionKeyprovidersMigrationDetailsHttpResponse>;
194
- type GetEncryptionKeyprovidersMigrationDetailsHttpResponse = {
195
- data: MigrationInformation;
196
- headers: Headers;
197
- status: 200;
198
- };
199
- type GetEncryptionKeyprovidersMigrationDetailsHttpError = {
200
- data: StandardError;
201
- headers: Headers;
202
- status: 400 | 401 | 404 | 417;
203
- };
204
- /**
205
- * Delete a key configuration from the tenant. Not supported for the default Qlik managed key provider. Key must not be in use.
206
- *
207
- * @param arnFingerPrint The fingerprint of the key provider you wish to delete.
208
- * @throws DeleteEncryptionKeyproviderHttpError
209
- */
210
- declare function deleteEncryptionKeyprovider(arnFingerPrint: string, options?: ApiCallOptions): Promise<DeleteEncryptionKeyproviderHttpResponse>;
211
- type DeleteEncryptionKeyproviderHttpResponse = {
212
- data: KeyProvidersDeleteResponseBody;
213
- headers: Headers;
214
- status: 204;
215
- };
216
- type DeleteEncryptionKeyproviderHttpError = {
217
- data: StandardError;
218
- headers: Headers;
219
- status: 400 | 404 | 417 | 424;
220
- };
221
- /**
222
- * Retrieve key provider detail by passing the ARN fingerprint as parameter.
223
- *
224
- * @param arnFingerPrint The fingerprint of the requested provider key.
225
- * @throws GetEncryptionKeyproviderHttpError
226
- */
227
- declare function getEncryptionKeyprovider(arnFingerPrint: string, options?: ApiCallOptions): Promise<GetEncryptionKeyproviderHttpResponse>;
228
- type GetEncryptionKeyproviderHttpResponse = {
229
- data: KeyProvider;
230
- headers: Headers;
231
- status: 200;
232
- };
233
- type GetEncryptionKeyproviderHttpError = {
234
- data: StandardError;
235
- headers: Headers;
236
- status: 400 | 404 | 414;
237
- };
238
- /**
239
- * Update the name and/or description of a key provider.
240
- *
241
- * @param arnFingerPrint The ARN fingerprint of an existing key provider key.
242
- * @param body an object with the body content
243
- * @throws PatchEncryptionKeyproviderHttpError
244
- */
245
- declare function patchEncryptionKeyprovider(arnFingerPrint: string, body: KeyProviderPatchSchema, options?: ApiCallOptions): Promise<PatchEncryptionKeyproviderHttpResponse>;
246
- type PatchEncryptionKeyproviderHttpResponse = {
247
- data: void;
248
- headers: Headers;
249
- status: 204;
250
- };
251
- type PatchEncryptionKeyproviderHttpError = {
252
- data: StandardError;
253
- headers: Headers;
254
- status: 400 | 401 | 404 | 417;
255
- };
256
- /**
257
- * 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.
258
- *
259
- * @param arnFingerPrint The fingerprint of an existing key provider key.
260
- * @throws MigrateEncryptionKeyproviderHttpError
261
- */
262
- declare function migrateEncryptionKeyprovider(arnFingerPrint: string, options?: ApiCallOptions): Promise<MigrateEncryptionKeyproviderHttpResponse>;
263
- type MigrateEncryptionKeyproviderHttpResponse = {
264
- data: MigrationInformation;
265
- headers: Headers;
266
- status: 200;
267
- };
268
- type MigrateEncryptionKeyproviderHttpError = {
269
- data: StandardError;
270
- headers: Headers;
271
- status: 400 | 401 | 404 | 412 | 424 | 428;
272
- };
273
- /**
274
- * 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.
275
- *
276
- * @param arnFingerPrint The fingerprint of an existing key provider key.
277
- * @throws TestEncryptionKeyproviderHttpError
278
- */
279
- declare function testEncryptionKeyprovider(arnFingerPrint: string, options?: ApiCallOptions): Promise<TestEncryptionKeyproviderHttpResponse>;
280
- type TestEncryptionKeyproviderHttpResponse = {
281
- data: KeyProvider;
282
- headers: Headers;
283
- status: 201;
284
- };
285
- type TestEncryptionKeyproviderHttpError = {
286
- data: StandardError;
287
- headers: Headers;
288
- status: 400 | 401 | 404 | 408;
289
- };
290
- /**
291
- * Clears the cache for encryption api requests.
292
- */
293
- declare function clearCache(): void;
294
- type EncryptionAPI = {
295
- /**
296
- * Returns a list of AWS key providers in the tenant. Use /actions/list to return all key providers.
297
- *
298
- * @throws GetEncryptionKeyprovidersHttpError
299
- */
300
- getEncryptionKeyproviders: typeof getEncryptionKeyproviders;
301
- /**
302
- * 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.
303
- *
304
- * @param body an object with the body content
305
- * @throws CreateEncryptionKeyproviderHttpError
306
- */
307
- createEncryptionKeyprovider: typeof createEncryptionKeyprovider;
308
- /**
309
- * Returns a list of all key providers in the tenant, including the default Qlik key provider.
310
- *
311
- * @throws ListEncryptionKeyprovidersHttpError
312
- */
313
- listEncryptionKeyproviders: typeof listEncryptionKeyproviders;
314
- /**
315
- * Reset the encryption key back to the default Qlik managed provider. No action will be taken if tenant is already using the Qlik provider.
316
- *
317
- * @throws ResetEncryptionKeyprovidersHttpError
318
- */
319
- resetEncryptionKeyproviders: typeof resetEncryptionKeyproviders;
320
- /**
321
- * Retrieve details for the ongoing or last completed migration for the tenant.
322
- *
323
- * @throws GetEncryptionKeyprovidersMigrationDetailsHttpError
324
- */
325
- getEncryptionKeyprovidersMigrationDetails: typeof getEncryptionKeyprovidersMigrationDetails;
326
- /**
327
- * Delete a key configuration from the tenant. Not supported for the default Qlik managed key provider. Key must not be in use.
328
- *
329
- * @param arnFingerPrint The fingerprint of the key provider you wish to delete.
330
- * @throws DeleteEncryptionKeyproviderHttpError
331
- */
332
- deleteEncryptionKeyprovider: typeof deleteEncryptionKeyprovider;
333
- /**
334
- * Retrieve key provider detail by passing the ARN fingerprint as parameter.
335
- *
336
- * @param arnFingerPrint The fingerprint of the requested provider key.
337
- * @throws GetEncryptionKeyproviderHttpError
338
- */
339
- getEncryptionKeyprovider: typeof getEncryptionKeyprovider;
340
- /**
341
- * Update the name and/or description of a key provider.
342
- *
343
- * @param arnFingerPrint The ARN fingerprint of an existing key provider key.
344
- * @param body an object with the body content
345
- * @throws PatchEncryptionKeyproviderHttpError
346
- */
347
- patchEncryptionKeyprovider: typeof patchEncryptionKeyprovider;
348
- /**
349
- * 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.
350
- *
351
- * @param arnFingerPrint The fingerprint of an existing key provider key.
352
- * @throws MigrateEncryptionKeyproviderHttpError
353
- */
354
- migrateEncryptionKeyprovider: typeof migrateEncryptionKeyprovider;
355
- /**
356
- * 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.
357
- *
358
- * @param arnFingerPrint The fingerprint of an existing key provider key.
359
- * @throws TestEncryptionKeyproviderHttpError
360
- */
361
- testEncryptionKeyprovider: typeof testEncryptionKeyprovider;
362
- /**
363
- * Clears the cache for encryption api requests.
364
- */
365
- clearCache: typeof clearCache;
366
- };
367
- /**
368
- * Functions for the encryption api
369
- */
370
- declare const encryptionExport: EncryptionAPI;
371
- //#endregion
372
- export { StandardError as A, getEncryptionKeyprovidersMigrationDetails as B, PatchEncryptionKeyproviderHttpError as C, ResetEncryptionKeyprovidersHttpError as D, ResetEncryptionKeyproviders205HttpResponse as E, createEncryptionKeyprovider as F, testEncryptionKeyprovider as G, migrateEncryptionKeyprovider as H, deleteEncryptionKeyprovider as I, encryptionExport as L, TestEncryptionKeyproviderHttpError as M, TestEncryptionKeyproviderHttpResponse as N, ResetEncryptionKeyprovidersHttpResponse as O, clearCache as P, getEncryptionKeyprovider as R, MigrationInformation as S, ResetEncryptionKeyproviders200HttpResponse as T, patchEncryptionKeyprovider as U, listEncryptionKeyproviders as V, resetEncryptionKeyproviders as W, ListEncryptionKeyprovidersHttpError as _, EncryptionAPI as a, MigrateEncryptionKeyproviderHttpError as b, GetEncryptionKeyprovidersHttpError as c, GetEncryptionKeyprovidersMigrationDetailsHttpResponse as d, KeyProvider as f, KeyProvidersDeleteResponseBody as g, KeyProviders as h, DeleteEncryptionKeyproviderHttpResponse as i, StandardErrorItem as j, ResetMigrationNotNeeded as k, GetEncryptionKeyprovidersHttpResponse as l, KeyProviderPatchSchema as m, CreateEncryptionKeyproviderHttpResponse as n, GetEncryptionKeyproviderHttpError as o, KeyProviderPatchBase as p, DeleteEncryptionKeyproviderHttpError as r, GetEncryptionKeyproviderHttpResponse as s, CreateEncryptionKeyproviderHttpError as t, GetEncryptionKeyprovidersMigrationDetailsHttpError as u, ListEncryptionKeyprovidersHttpResponse as v, PatchEncryptionKeyproviderHttpResponse as w, MigrateEncryptionKeyproviderHttpResponse as x, ListKeyProviders as y, getEncryptionKeyproviders as z };
@@ -1,294 +0,0 @@
1
- import { y as ApiCallOptions } from "./auth-types-E99tzdN0.js";
2
-
3
- //#region src/public/rest/extensions.d.ts
4
-
5
- /**
6
- * Object containing meta data regarding the bundle the extension belongs to. If it does not belong to a bundle, this object is not defined.
7
- */
8
- type BundleMeta = {
9
- /** Description of the bundle. */
10
- description?: string;
11
- /** Unique identifier of the bundle. */
12
- id?: string;
13
- /** Name of the bundle. */
14
- name?: string;
15
- };
16
- /**
17
- * An error object.
18
- */
19
- type Error = {
20
- /** Object containing meta data regarding an error. It does not necessarily contain all the properties. */
21
- meta?: Meta;
22
- /** Optional JSON patch object pointing to an invalid property. */
23
- source?: unknown;
24
- /** The HTTP status code. */
25
- status?: number;
26
- /** Title of the HTTP status code. */
27
- title: string;
28
- };
29
- /**
30
- * The extension model.
31
- */
32
- type Extension = {
33
- /** Author of the extension. */
34
- author?: string;
35
- /** Object containing meta data regarding the bundle the extension belongs to. If it does not belong to a bundle, this object is not defined. */
36
- bundle?: BundleMeta;
37
- /** If the extension is part of an extension bundle. */
38
- bundled?: boolean;
39
- /** Checksum of the extension contents. */
40
- checksum?: string;
41
- readonly createdAt?: string;
42
- /** Map of dependencies describing version of the component it requires. */
43
- dependencies?: unknown;
44
- /** A date noting when the extension was deprecated. */
45
- deprecated?: string;
46
- /** Description of the extension. */
47
- description?: string;
48
- /** The file that was uploaded with the extension. */
49
- file?: unknown;
50
- /** Home page of the extension. */
51
- homepage?: string;
52
- /** Icon to show in the client. */
53
- icon?: string;
54
- readonly id?: string;
55
- /** Keywords for the extension. */
56
- keywords?: string;
57
- /** Under which license this extension is published. */
58
- license?: string;
59
- /** Relative path to the extension's entry file, defaults to `filename` from the qext file. */
60
- loadpath?: string;
61
- /** The display name of this extension. */
62
- name?: string;
63
- /** Path to an image that enables users to preview the extension. */
64
- preview?: string;
65
- /** The name of the qext file that was uploaded with this extension. */
66
- qextFilename?: string;
67
- /** The version from the qext file that was uploaded with this extension. */
68
- qextVersion?: string;
69
- /** Link to the extension source code. */
70
- repository?: string;
71
- /** If the extension is a supernova extension or not. */
72
- supernova?: boolean;
73
- /** Supplier of the extension. */
74
- supplier?: string;
75
- /** List of tags. */
76
- tags?: string[];
77
- readonly tenantId?: string;
78
- /** The type of this extension (visualization, etc.). */
79
- type?: string;
80
- readonly updateAt?: string;
81
- readonly userId?: string;
82
- /** Version of the extension. */
83
- version?: string;
84
- };
85
- type Extensions = {
86
- data: Extension[];
87
- };
88
- /**
89
- * Object containing meta data regarding an error. It does not necessarily contain all the properties.
90
- */
91
- type Meta = {
92
- /** A more detailed message explaining the error. */
93
- message?: string;
94
- /** Name of the resource related to the error. If there is a conflict, it is the name of the model attempting to be created. */
95
- resourceName?: string;
96
- /** Full stack trace of the error that was raised. */
97
- stack?: string;
98
- };
99
- /**
100
- * Lists all imported extensions in the tenant.
101
- *
102
- * @throws GetExtensionsHttpError
103
- */
104
- declare function getExtensions(options?: ApiCallOptions): Promise<GetExtensionsHttpResponse>;
105
- type GetExtensionsHttpResponse = {
106
- data: Extensions;
107
- headers: Headers;
108
- status: 200;
109
- };
110
- type GetExtensionsHttpError = {
111
- data: unknown;
112
- headers: Headers;
113
- status: number;
114
- };
115
- /**
116
- * Creates a new extension. Accepts either provided file or data object. The name of the new extension must be different to any existing extensions.
117
- *
118
- * @param body an object with the body content
119
- * @throws UploadExtensionHttpError
120
- */
121
- declare function uploadExtension(body: {
122
- /** The extension model. */
123
- data?: Extension;
124
- /** Extension archive. */
125
- file?: BodyInit;
126
- }, options?: ApiCallOptions): Promise<UploadExtensionHttpResponse>;
127
- type UploadExtensionHttpResponse = {
128
- data: Extension;
129
- headers: Headers;
130
- status: 201;
131
- };
132
- type UploadExtensionHttpError = {
133
- data: Error;
134
- headers: Headers;
135
- status: number;
136
- };
137
- /**
138
- * Deletes a specific extension matching either extension ID or extension name.
139
- *
140
- * @param id Extension identifier or its qextFilename.
141
- * @throws DeleteExtensionHttpError
142
- */
143
- declare function deleteExtension(id: string, options?: ApiCallOptions): Promise<DeleteExtensionHttpResponse>;
144
- type DeleteExtensionHttpResponse = {
145
- data: void;
146
- headers: Headers;
147
- status: 204;
148
- };
149
- type DeleteExtensionHttpError = {
150
- data: Error;
151
- headers: Headers;
152
- status: 403 | 404 | 410;
153
- };
154
- /**
155
- * Returns a specific extension matching either extension ID or extension name.
156
- *
157
- * @param id Extension identifier or its qextFilename.
158
- * @throws GetExtensionHttpError
159
- */
160
- declare function getExtension(id: string, options?: ApiCallOptions): Promise<GetExtensionHttpResponse>;
161
- type GetExtensionHttpResponse = {
162
- data: Extension;
163
- headers: Headers;
164
- status: 200;
165
- };
166
- type GetExtensionHttpError = {
167
- data: Error;
168
- headers: Headers;
169
- status: 403 | 404 | 410;
170
- };
171
- /**
172
- * Updates a specific extension matching either extension ID or extension name. Accepts either provided file or data object.
173
- *
174
- * @param id Extension identifier or its qextFilename.
175
- * @param body an object with the body content
176
- * @throws PatchExtensionHttpError
177
- */
178
- declare function patchExtension(id: string, body: {
179
- /** The extension model. */
180
- data?: Extension;
181
- /** Extension archive. */
182
- file?: BodyInit;
183
- }, options?: ApiCallOptions): Promise<PatchExtensionHttpResponse>;
184
- type PatchExtensionHttpResponse = {
185
- data: Extension;
186
- headers: Headers;
187
- status: 200;
188
- };
189
- type PatchExtensionHttpError = {
190
- data: Error;
191
- headers: Headers;
192
- status: number;
193
- };
194
- /**
195
- * Downloads all files in the extension matching either extension ID or extension name as a `.zip` archive.
196
- *
197
- * @param id Extension identifier or its qextFilename.
198
- * @throws DownloadExtensionHttpError
199
- */
200
- declare function downloadExtension(id: string, options?: ApiCallOptions): Promise<DownloadExtensionHttpResponse>;
201
- type DownloadExtensionHttpResponse = {
202
- data: void;
203
- headers: Headers;
204
- status: 200;
205
- };
206
- type DownloadExtensionHttpError = {
207
- data: Error;
208
- headers: Headers;
209
- status: 403 | 404 | 410;
210
- };
211
- /**
212
- * Downloads a specific file from the extension matching either extension ID or extension name, identified by the file path within the imported extension.
213
- *
214
- * @param id Extension identifier or its qextFilename.
215
- * @param filepath Path to the file location within the specified extension archive. Folders separated with forward slashes.
216
- * @throws DownloadFileFromExtensionHttpError
217
- */
218
- declare function downloadFileFromExtension(id: string, filepath: string, options?: ApiCallOptions): Promise<DownloadFileFromExtensionHttpResponse>;
219
- type DownloadFileFromExtensionHttpResponse = {
220
- data: void;
221
- headers: Headers;
222
- status: 200;
223
- };
224
- type DownloadFileFromExtensionHttpError = {
225
- data: Error;
226
- headers: Headers;
227
- status: 403 | 404 | 410;
228
- };
229
- /**
230
- * Clears the cache for extensions api requests.
231
- */
232
- declare function clearCache(): void;
233
- type ExtensionsAPI = {
234
- /**
235
- * Lists all imported extensions in the tenant.
236
- *
237
- * @throws GetExtensionsHttpError
238
- */
239
- getExtensions: typeof getExtensions;
240
- /**
241
- * Creates a new extension. Accepts either provided file or data object. The name of the new extension must be different to any existing extensions.
242
- *
243
- * @param body an object with the body content
244
- * @throws UploadExtensionHttpError
245
- */
246
- uploadExtension: typeof uploadExtension;
247
- /**
248
- * Deletes a specific extension matching either extension ID or extension name.
249
- *
250
- * @param id Extension identifier or its qextFilename.
251
- * @throws DeleteExtensionHttpError
252
- */
253
- deleteExtension: typeof deleteExtension;
254
- /**
255
- * Returns a specific extension matching either extension ID or extension name.
256
- *
257
- * @param id Extension identifier or its qextFilename.
258
- * @throws GetExtensionHttpError
259
- */
260
- getExtension: typeof getExtension;
261
- /**
262
- * Updates a specific extension matching either extension ID or extension name. Accepts either provided file or data object.
263
- *
264
- * @param id Extension identifier or its qextFilename.
265
- * @param body an object with the body content
266
- * @throws PatchExtensionHttpError
267
- */
268
- patchExtension: typeof patchExtension;
269
- /**
270
- * Downloads all files in the extension matching either extension ID or extension name as a `.zip` archive.
271
- *
272
- * @param id Extension identifier or its qextFilename.
273
- * @throws DownloadExtensionHttpError
274
- */
275
- downloadExtension: typeof downloadExtension;
276
- /**
277
- * Downloads a specific file from the extension matching either extension ID or extension name, identified by the file path within the imported extension.
278
- *
279
- * @param id Extension identifier or its qextFilename.
280
- * @param filepath Path to the file location within the specified extension archive. Folders separated with forward slashes.
281
- * @throws DownloadFileFromExtensionHttpError
282
- */
283
- downloadFileFromExtension: typeof downloadFileFromExtension;
284
- /**
285
- * Clears the cache for extensions api requests.
286
- */
287
- clearCache: typeof clearCache;
288
- };
289
- /**
290
- * Functions for the extensions api
291
- */
292
- declare const extensionsExport: ExtensionsAPI;
293
- //#endregion
294
- export { downloadExtension as C, getExtensions as D, getExtension as E, patchExtension as O, deleteExtension as S, extensionsExport as T, PatchExtensionHttpError as _, DownloadExtensionHttpResponse as a, UploadExtensionHttpResponse as b, Error as c, ExtensionsAPI as d, GetExtensionHttpError as f, Meta as g, GetExtensionsHttpResponse as h, DownloadExtensionHttpError as i, uploadExtension as k, Extension as l, GetExtensionsHttpError as m, DeleteExtensionHttpError as n, DownloadFileFromExtensionHttpError as o, GetExtensionHttpResponse as p, DeleteExtensionHttpResponse as r, DownloadFileFromExtensionHttpResponse as s, BundleMeta as t, Extensions as u, PatchExtensionHttpResponse as v, downloadFileFromExtension as w, clearCache as x, UploadExtensionHttpError as y };