@qlik/api 2.2.0 → 2.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (231) hide show
  1. package/analytics/change-stores.d.ts +386 -0
  2. package/analytics/change-stores.js +123 -0
  3. package/analytics.d.ts +14 -0
  4. package/analytics.js +13 -0
  5. package/api-keys.d.ts +362 -3
  6. package/api-keys.js +2 -3
  7. package/apps.d.ts +2673 -3
  8. package/apps.js +2 -3
  9. package/assistants.d.ts +1370 -3
  10. package/assistants.js +2 -3
  11. package/audits.d.ts +318 -3
  12. package/audits.js +4 -4
  13. package/auth-types.d.ts +1 -1
  14. package/auth-types.js +1 -2
  15. package/auth.d.ts +94 -2
  16. package/auth.js +63 -3
  17. package/automation-connections.d.ts +366 -3
  18. package/automation-connections.js +2 -3
  19. package/automation-connectors.d.ts +84 -3
  20. package/automation-connectors.js +2 -3
  21. package/automations.d.ts +805 -3
  22. package/automations.js +2 -3
  23. package/automl-deployments.d.ts +101 -3
  24. package/automl-deployments.js +2 -3
  25. package/automl-predictions.d.ts +238 -3
  26. package/automl-predictions.js +2 -3
  27. package/banners.d.ts +184 -3
  28. package/banners.js +2 -3
  29. package/brands.d.ts +670 -3
  30. package/brands.js +2 -3
  31. package/chunks/{auth-Cle0_tmz.js → auth-BowS4SUR.js} +1 -5
  32. package/chunks/{chunk-EtTptKIv.js → chunk-D3vHIbds.js} +2 -2
  33. package/chunks/{dist-gXLIqDJW.js → dist-n3iOVn1W.js} +4 -4
  34. package/chunks/{auth-functions-BmZgZYSs.js → interceptors-DipDBQQ5.js} +258 -54
  35. package/chunks/{invoke-fetch-PcVIxLW4.js → invoke-fetch-B7lGscuQ.js} +3 -3
  36. package/chunks/{invoke-fetch-CucBpA1C.js → invoke-fetch-DhdyFZ0F.js} +1 -5
  37. package/chunks/{public-runtime-modules-Dwjzb3l8.js → public-runtime-modules-QhLPeQr5.js} +7 -7
  38. package/chunks/{qix-DI5o5XF4.d.ts → qix-CrqXv44x.d.ts} +6 -2
  39. package/chunks/{qix-DjxuPCX0.js → qix-RCUslia8.js} +11 -10
  40. package/chunks/{qix-chunk-entrypoint-tmTo-kpa.js → qix-chunk-entrypoint-WAS4NVTf.js} +48 -50
  41. package/collections.d.ts +582 -3
  42. package/collections.js +2 -3
  43. package/conditions.d.ts +662 -3
  44. package/conditions.js +2 -3
  45. package/consumption.d.ts +182 -3
  46. package/consumption.js +2 -3
  47. package/core/ip-policies.d.ts +328 -4
  48. package/core/ip-policies.js +108 -5
  49. package/core.d.ts +13 -4
  50. package/core.js +3 -4
  51. package/csp-origins.d.ts +273 -3
  52. package/csp-origins.js +2 -3
  53. package/csrf-token.d.ts +62 -3
  54. package/csrf-token.js +2 -3
  55. package/data-alerts.d.ts +1004 -3
  56. package/data-alerts.js +2 -3
  57. package/data-assets.d.ts +207 -3
  58. package/data-assets.js +2 -3
  59. package/data-connections.d.ts +678 -3
  60. package/data-connections.js +2 -3
  61. package/data-credentials.d.ts +292 -3
  62. package/data-credentials.js +2 -3
  63. package/data-files.d.ts +860 -3
  64. package/data-files.js +2 -3
  65. package/data-qualities.d.ts +175 -3
  66. package/data-qualities.js +2 -3
  67. package/data-sets.d.ts +424 -3
  68. package/data-sets.js +2 -3
  69. package/data-sources.d.ts +348 -3
  70. package/data-sources.js +2 -3
  71. package/data-stores.d.ts +537 -3
  72. package/data-stores.js +2 -3
  73. package/dcaas.d.ts +192 -3
  74. package/dcaas.js +2 -3
  75. package/di-projects.d.ts +812 -4
  76. package/di-projects.js +25 -4
  77. package/direct-access-agents.d.ts +710 -4
  78. package/direct-access-agents.js +37 -5
  79. package/docs/authentication.md +1 -1
  80. package/encryption.d.ts +372 -3
  81. package/encryption.js +2 -3
  82. package/extensions.d.ts +295 -3
  83. package/extensions.js +2 -3
  84. package/global-types.d.ts +1 -1
  85. package/global-types.js +0 -2
  86. package/glossaries.d.ts +1223 -3
  87. package/glossaries.js +2 -3
  88. package/groups.d.ts +510 -3
  89. package/groups.js +2 -3
  90. package/identity-providers.d.ts +711 -3
  91. package/identity-providers.js +2 -3
  92. package/index.d.ts +78 -69
  93. package/index.js +28 -10
  94. package/interceptors.d.ts +52 -3
  95. package/interceptors.js +1 -2
  96. package/invoke-fetch-types.d.ts +1 -1
  97. package/items.d.ts +536 -3
  98. package/items.js +2 -3
  99. package/knowledgebases.d.ts +976 -3
  100. package/knowledgebases.js +2 -3
  101. package/licenses.d.ts +663 -3
  102. package/licenses.js +2 -3
  103. package/lineage-graphs.d.ts +704 -3
  104. package/lineage-graphs.js +2 -3
  105. package/ml.d.ts +2808 -3
  106. package/ml.js +2 -3
  107. package/notes.d.ts +110 -3
  108. package/notes.js +2 -3
  109. package/notifications.d.ts +98 -3
  110. package/notifications.js +2 -3
  111. package/oauth-callback.iife.js +1151 -0
  112. package/oauth-clients.d.ts +562 -3
  113. package/oauth-clients.js +2 -3
  114. package/oauth-tokens.d.ts +126 -3
  115. package/oauth-tokens.js +2 -3
  116. package/package.json +6 -4
  117. package/qix.d.ts +3 -3
  118. package/qix.js +38 -3
  119. package/questions.d.ts +364 -3
  120. package/questions.js +2 -3
  121. package/quotas.d.ts +112 -3
  122. package/quotas.js +2 -3
  123. package/reload-tasks.d.ts +249 -3
  124. package/reload-tasks.js +2 -3
  125. package/reloads.d.ts +260 -3
  126. package/reloads.js +2 -3
  127. package/report-templates.d.ts +287 -3
  128. package/report-templates.js +2 -3
  129. package/reports.d.ts +863 -3
  130. package/reports.js +2 -3
  131. package/roles.d.ts +312 -3
  132. package/roles.js +2 -3
  133. package/sharing-tasks.d.ts +1164 -3
  134. package/sharing-tasks.js +2 -3
  135. package/spaces.d.ts +779 -3
  136. package/spaces.js +2 -3
  137. package/tasks.d.ts +564 -3
  138. package/tasks.js +2 -3
  139. package/temp-contents.d.ts +167 -3
  140. package/temp-contents.js +2 -3
  141. package/tenants.d.ts +360 -3
  142. package/tenants.js +2 -3
  143. package/themes.d.ts +270 -3
  144. package/themes.js +2 -3
  145. package/transports.d.ts +435 -4
  146. package/transports.js +20 -5
  147. package/ui-config.d.ts +274 -3
  148. package/ui-config.js +2 -3
  149. package/users.d.ts +674 -3
  150. package/users.js +2 -3
  151. package/web-integrations.d.ts +294 -3
  152. package/web-integrations.js +2 -3
  153. package/web-notifications.d.ts +273 -3
  154. package/web-notifications.js +2 -3
  155. package/webhooks.d.ts +505 -3
  156. package/webhooks.js +2 -3
  157. package/chunks/api-keys-D6Rqaov4.d.ts +0 -365
  158. package/chunks/apps-BwpXUGDb.d.ts +0 -2673
  159. package/chunks/assistants-wh6Qe7l6.d.ts +0 -1366
  160. package/chunks/audits-DakwzT97.d.ts +0 -316
  161. package/chunks/auth-6mptVm5Q.d.ts +0 -95
  162. package/chunks/auth-D11iO7ZV.js +0 -65
  163. package/chunks/automation-connections-k2G_n9rj.d.ts +0 -366
  164. package/chunks/automation-connectors-J5OE-1P0.d.ts +0 -84
  165. package/chunks/automations-BGy83EBO.d.ts +0 -797
  166. package/chunks/automl-deployments-CWEpX2pk.d.ts +0 -101
  167. package/chunks/automl-predictions-BNIjRhBm.d.ts +0 -238
  168. package/chunks/banners-CgBRnZGv.d.ts +0 -184
  169. package/chunks/brands-DCgk6Gqx.d.ts +0 -671
  170. package/chunks/collections-BpYjcpIY.d.ts +0 -582
  171. package/chunks/conditions-CJJG7Uph.d.ts +0 -662
  172. package/chunks/consumption-DerFk437.d.ts +0 -182
  173. package/chunks/core-DQXNZdnf.d.ts +0 -12
  174. package/chunks/csp-origins-3NJlh_n9.d.ts +0 -273
  175. package/chunks/csrf-token-DoaoOQzH.d.ts +0 -63
  176. package/chunks/data-alerts-CILSEFbQ.d.ts +0 -1004
  177. package/chunks/data-assets-CJDcssoX.d.ts +0 -207
  178. package/chunks/data-connections-VSB13K6g.d.ts +0 -678
  179. package/chunks/data-credentials-ChEp_hyU.d.ts +0 -292
  180. package/chunks/data-files-CVzn9M6V.d.ts +0 -860
  181. package/chunks/data-qualities-DBrot957.d.ts +0 -176
  182. package/chunks/data-sets-CFzxgWnO.d.ts +0 -424
  183. package/chunks/data-sources-IsAaof_C.d.ts +0 -346
  184. package/chunks/data-stores-DFOPdgfz.d.ts +0 -537
  185. package/chunks/dcaas-qyv7YlrN.d.ts +0 -192
  186. package/chunks/di-projects-DVQTxASr.d.ts +0 -777
  187. package/chunks/direct-access-agents-B77OhzZi.d.ts +0 -580
  188. package/chunks/encryption-BjA6xbCO.d.ts +0 -372
  189. package/chunks/extensions-OO0WtInj.d.ts +0 -294
  190. package/chunks/glossaries-CIX7-KT_.d.ts +0 -1213
  191. package/chunks/groups-C86-UG7S.d.ts +0 -511
  192. package/chunks/identity-providers-h0dKNxGZ.d.ts +0 -711
  193. package/chunks/interceptors-Csx2tEi5.d.ts +0 -52
  194. package/chunks/interceptors-DTYm37AU.js +0 -104
  195. package/chunks/ip-policies-CKRIlbP7.d.ts +0 -327
  196. package/chunks/ip-policies-DXlf172B.js +0 -108
  197. package/chunks/items-C-jzqvFW.d.ts +0 -536
  198. package/chunks/knowledgebases-CyQtVcZN.d.ts +0 -977
  199. package/chunks/licenses-xzjnkitW.d.ts +0 -663
  200. package/chunks/lineage-graphs-CViCCzKy.d.ts +0 -697
  201. package/chunks/ml-Abt2MUva.d.ts +0 -2809
  202. package/chunks/notes-BZxuyDgt.d.ts +0 -111
  203. package/chunks/notifications-Bd_gp4jU.d.ts +0 -99
  204. package/chunks/oauth-clients-B5QPr4IM.d.ts +0 -563
  205. package/chunks/oauth-tokens-1b7V8182.d.ts +0 -127
  206. package/chunks/qix-CYQsLyGQ.js +0 -40
  207. package/chunks/questions-BVp0tvNs.d.ts +0 -364
  208. package/chunks/quotas-CfAebRJd.d.ts +0 -113
  209. package/chunks/reload-tasks-DfwUTetn.d.ts +0 -249
  210. package/chunks/reloads-CwmagnFx.d.ts +0 -260
  211. package/chunks/report-templates-DjQYj5dn.d.ts +0 -287
  212. package/chunks/reports-DzNC6Uq3.d.ts +0 -861
  213. package/chunks/roles-BYFIY6E7.d.ts +0 -312
  214. package/chunks/sharing-tasks-BMGIQ-FO.d.ts +0 -1164
  215. package/chunks/spaces-BK823t-b.d.ts +0 -780
  216. package/chunks/tasks-COKDfShO.d.ts +0 -564
  217. package/chunks/temp-contents-zDomB-g6.d.ts +0 -168
  218. package/chunks/tenants-Bhn86519.d.ts +0 -361
  219. package/chunks/themes-v9NbhiBo.d.ts +0 -269
  220. package/chunks/transports-CqEiFxD3.d.ts +0 -362
  221. package/chunks/ui-config-Crs0mVMp.d.ts +0 -274
  222. package/chunks/users-BSOBU_fg.d.ts +0 -675
  223. package/chunks/web-integrations-MisPAHod.d.ts +0 -295
  224. package/chunks/web-notifications-DVy6FHYh.d.ts +0 -274
  225. package/chunks/webhooks-Dr4EiXqy.d.ts +0 -505
  226. /package/chunks/{auth-types-E99tzdN0.d.ts → auth-types-YrlH_R9f.d.ts} +0 -0
  227. /package/chunks/{auth-types-JehqruDP.js → auth-types-h43TVDpB.js} +0 -0
  228. /package/chunks/{global-types-CrOvI33z.js → global-types-CEVAJebk.js} +0 -0
  229. /package/chunks/{invoke-fetch-CbU2Dgqr.d.ts → invoke-fetch-C1Z0RJYU.d.ts} +0 -0
  230. /package/chunks/{utils-BnC4lrlq.js → utils-vv-xFm06.js} +0 -0
  231. /package/chunks/{websocket-errors-DSbO6kDZ.js → websocket-errors-CRTDTtBL.js} +0 -0
package/knowledgebases.js CHANGED
@@ -1,6 +1,5 @@
1
- import "./chunks/utils-BnC4lrlq.js";
2
- import "./chunks/public-runtime-modules-Dwjzb3l8.js";
3
- import { n as invokeFetch, t as clearApiCache } from "./chunks/invoke-fetch-PcVIxLW4.js";
1
+ import "./chunks/public-runtime-modules-QhLPeQr5.js";
2
+ import { n as invokeFetch, t as clearApiCache } from "./chunks/invoke-fetch-B7lGscuQ.js";
4
3
 
5
4
  //#region src/public/rest/knowledgebases.ts
6
5
  /**
package/licenses.d.ts CHANGED
@@ -1,4 +1,664 @@
1
- import "./chunks/auth-types-E99tzdN0.js";
2
- import "./chunks/invoke-fetch-CbU2Dgqr.js";
3
- import { A as UpdateLicenseAssignmentsHttpResponse, B as getLicenseStatus, C as GetLicenseStatusHttpResponse, D as LicensesAPI, E as LicenseStatus, F as deleteLicenseAssignments, H as updateLicenseAssignments, I as getLicenseAssignments, L as getLicenseConsumption, M as UpdateLicenseSettingsHttpResponse, N as addLicenseAssignments, O as SettingsBody, P as clearCache, R as getLicenseOverview, S as GetLicenseStatusHttpError, T as LicenseOverview, U as updateLicenseSettings, V as licensesExport, _ as GetLicenseConsumptionHttpResponse, a as AssignmentsActionsDeleteRequest, b as GetLicenseSettingsHttpError, c as AssignmentsActionsUpdateResponse, d as DeleteLicenseAssignmentsHttpError, f as DeleteLicenseAssignmentsHttpResponse, g as GetLicenseConsumptionHttpError, h as GetLicenseAssignmentsHttpResponse, i as AssignmentsActionsAddResponse, j as UpdateLicenseSettingsHttpError, k as UpdateLicenseAssignmentsHttpError, l as AssignmentsResponse, m as GetLicenseAssignmentsHttpError, n as AddLicenseAssignmentsHttpResponse, o as AssignmentsActionsDeleteResponse, p as ErrorResponse, r as AssignmentsActionsAddRequest, s as AssignmentsActionsUpdateRequest, t as AddLicenseAssignmentsHttpError, u as ConsumptionEventsResponse, v as GetLicenseOverviewHttpError, w as Href, x as GetLicenseSettingsHttpResponse, y as GetLicenseOverviewHttpResponse, z as getLicenseSettings } from "./chunks/licenses-xzjnkitW.js";
1
+ import { y as ApiCallOptions } from "./chunks/auth-types-YrlH_R9f.js";
2
+ import "./chunks/invoke-fetch-C1Z0RJYU.js";
3
+
4
+ //#region src/public/rest/licenses.d.ts
5
+
6
+ /**
7
+ * @example
8
+ * {
9
+ * add: [
10
+ * {
11
+ * subject: "qlik\kalle",
12
+ * type: "professional"
13
+ * },
14
+ * {
15
+ * subject: "qlik\nalle",
16
+ * type: "analyzer"
17
+ * }
18
+ * ]
19
+ * }
20
+ */
21
+ type AssignmentsActionsAddRequest = {
22
+ add: {
23
+ /** @deprecated
24
+ * User name */
25
+ name?: string;
26
+ /** User subject */
27
+ subject: string;
28
+ /** Allotment type */
29
+ type: string;
30
+ /** @deprecated
31
+ * User ID */
32
+ userId?: string;
33
+ }[];
34
+ };
35
+ /**
36
+ * @example
37
+ * {
38
+ * data: [
39
+ * {
40
+ * status: 201,
41
+ * subject: "qlik\kalle",
42
+ * type: "professional"
43
+ * },
44
+ * {
45
+ * code: "LICENSES-011",
46
+ * status: 403,
47
+ * subject: "qlik\nalle",
48
+ * title: "No available allotment error, No available allotment.",
49
+ * type: "analyzer"
50
+ * }
51
+ * ]
52
+ * }
53
+ */
54
+ type AssignmentsActionsAddResponse = {
55
+ data: {
56
+ /** Error code */
57
+ code?: string;
58
+ /** Response status */
59
+ status: number;
60
+ /** Subject */
61
+ subject: string;
62
+ /** Error title */
63
+ title?: string;
64
+ /** Allotment type */
65
+ type?: string;
66
+ }[];
67
+ };
68
+ /**
69
+ * @example
70
+ * {
71
+ * delete: [
72
+ * {
73
+ * subject: "qlik\malik",
74
+ * type: "analyzer"
75
+ * }
76
+ * ]
77
+ * }
78
+ */
79
+ type AssignmentsActionsDeleteRequest = {
80
+ delete: {
81
+ /** User subject */
82
+ subject: string;
83
+ /** Allotment type */
84
+ type: string;
85
+ }[];
86
+ };
87
+ /**
88
+ * @example
89
+ * {
90
+ * data: [
91
+ * {
92
+ * status: 200,
93
+ * subject: "qlik\malik",
94
+ * type: "professional"
95
+ * },
96
+ * {
97
+ * code: "LICENSES-016",
98
+ * status: 404,
99
+ * subject: "qlik\no",
100
+ * title: "Assignment not found.",
101
+ * type: "analyzer"
102
+ * }
103
+ * ]
104
+ * }
105
+ */
106
+ type AssignmentsActionsDeleteResponse = {
107
+ data: {
108
+ /** Error code */
109
+ code?: string;
110
+ /** Response status */
111
+ status: number;
112
+ /** Subject */
113
+ subject?: string;
114
+ /** Error title */
115
+ title?: string;
116
+ /** Allotment type */
117
+ type?: string;
118
+ }[];
119
+ };
120
+ /**
121
+ * @example
122
+ * {
123
+ * update: [
124
+ * {
125
+ * sourceType: "analyzer",
126
+ * subject: "qlik\malik",
127
+ * type: "professional"
128
+ * }
129
+ * ]
130
+ * }
131
+ */
132
+ type AssignmentsActionsUpdateRequest = {
133
+ update: {
134
+ /** The current user subject, in case that should be patched. */
135
+ sourceSubject?: string;
136
+ /** Current assignment type. */
137
+ sourceType?: string;
138
+ /** User subject, the current or the desired after the patch. */
139
+ subject: string;
140
+ /** Target assignment type. */
141
+ type?: string;
142
+ }[];
143
+ };
144
+ /**
145
+ * @example
146
+ * {
147
+ * data: [
148
+ * {
149
+ * sourceType: "analyzer",
150
+ * status: 200,
151
+ * subject: "qlik\malik",
152
+ * type: "professional"
153
+ * },
154
+ * {
155
+ * code: "LICENSES-016",
156
+ * sourceType: "analyzer",
157
+ * status: 404,
158
+ * subject: "qlik/sara",
159
+ * title: "Assignment not found."
160
+ * }
161
+ * ]
162
+ * }
163
+ */
164
+ type AssignmentsActionsUpdateResponse = {
165
+ data: {
166
+ /** Error code */
167
+ code?: string;
168
+ /** Current subject. */
169
+ sourceSubject?: string;
170
+ /** Current allotment type. */
171
+ sourceType?: string;
172
+ /** HTTP status code indicating the result of the individual assignment operation. A value of 200 represents a successful update, while 201 indicates a new resource was created due to a subject update. Any 400-level status codes indicate an error. */
173
+ status: number;
174
+ /** Target subject. */
175
+ subject?: string;
176
+ /** Error title */
177
+ title?: string;
178
+ /** Target allotment type. */
179
+ type?: string;
180
+ }[];
181
+ };
182
+ /**
183
+ * @example
184
+ * {
185
+ * data: [
186
+ * {
187
+ * created: "2020-12-03T09:24:48.114Z",
188
+ * excess: false,
189
+ * subject: "qlik\kalle",
190
+ * type: "analyzer"
191
+ * },
192
+ * {
193
+ * created: "2020-12-03T09:24:48.114Z",
194
+ * subject: "qlik\nalle"
195
+ * }
196
+ * ],
197
+ * links: {
198
+ * next: {
199
+ * href: "http://license/v1/licenses/assignments?limit=4&page=bmV4dDpGZ0FBQUFkZmFXUUFYOHBUcTlpM1U4UU1YWHZrQUE%3D"
200
+ * },
201
+ * prev: {
202
+ * href: "http://license/v1/licenses/assignments?limit=4&page=cHJldjpGZ0FBQUFkZmFXUUFYOHBUcTlpM1U4UU1YWHZ0QUE%3D"
203
+ * }
204
+ * }
205
+ * }
206
+ */
207
+ type AssignmentsResponse = {
208
+ data: {
209
+ /** Assignment created date. */
210
+ created: string;
211
+ /** Assignment excess status. */
212
+ excess: boolean;
213
+ /** Subject */
214
+ subject: string;
215
+ /** Allotment type */
216
+ type: string;
217
+ }[];
218
+ links: {
219
+ next?: Href;
220
+ prev?: Href;
221
+ };
222
+ };
223
+ type ConsumptionEventsResponse = {
224
+ data: {
225
+ /** Allotment ID */
226
+ allotmentId?: string;
227
+ /** App ID */
228
+ appId?: string;
229
+ /** Analyzer capacity chunks consumed. */
230
+ capacityUsed?: number;
231
+ /** Engine session duration. */
232
+ duration?: string;
233
+ /** Engine session end time. */
234
+ endTime?: string;
235
+ /** ID */
236
+ id?: string;
237
+ /** License usage */
238
+ licenseUsage?: string;
239
+ /** Analyzer capacity minutes consumed. */
240
+ minutesUsed?: number;
241
+ /** Engine session ID. */
242
+ sessionId?: string;
243
+ /** User ID */
244
+ userId?: string;
245
+ }[];
246
+ links: {
247
+ next?: Href;
248
+ prev?: Href;
249
+ };
250
+ };
251
+ /**
252
+ * @example
253
+ * {
254
+ * error: "util.Error",
255
+ * errors: [
256
+ * {
257
+ * code: "LICENSES-123",
258
+ * title: "error title"
259
+ * }
260
+ * ],
261
+ * message: "error message"
262
+ * }
263
+ */
264
+ type ErrorResponse = {
265
+ /** @deprecated
266
+ * Error type */
267
+ error: string;
268
+ errors: {
269
+ /** Error code */
270
+ code: string;
271
+ /** Additional error detail. */
272
+ detail?: string;
273
+ /** Error title */
274
+ title: string;
275
+ }[];
276
+ /** @deprecated
277
+ * Error message */
278
+ message: string;
279
+ };
280
+ type Href = {
281
+ /** link */
282
+ href?: string;
283
+ };
284
+ /**
285
+ * @example
286
+ * {
287
+ * allotments: [
288
+ * {
289
+ * name: "analyzer_time",
290
+ * overage: 100,
291
+ * units: 300,
292
+ * unitsUsed: 242,
293
+ * usageClass: "time"
294
+ * },
295
+ * {
296
+ * name: "professional",
297
+ * units: 200,
298
+ * unitsUsed: 15,
299
+ * usageClass: "assigned"
300
+ * }
301
+ * ],
302
+ * licenseKey: "hejhbGciOiJSUzUxMiIsInR5cCI6IkpXVCIsImtpZCI6IktFWTEifQ.eyJqdGkiOiIxZjZkZTc0Zi04MDcyLTRjMTQtYjc1OS02ZjlkYmJmYWM5MjAiLCJsaWNlbnNlIjoiOTk5OTAwMDAwMDAwMTIzNCJ9.fwa6l6gY1MR_Ja2OMnV65V68fbzQYW5OAKUFnLfG9oZjNAbjhdDkZvS2S2zHaBnSrSva1ARh5iq_S0KTBOKKcJJDTb7jRVURyaAvbCuBDk_0ITrUudHaT9U_Mc9EKkfT8mR6vthhZxVzEhyYPFS7gDw7M6bav2ntpDsoJFPgous",
303
+ * licenseNumber: "9999000000001204",
304
+ * origin: "Internal",
305
+ * parameters: [
306
+ * {
307
+ * name: "qlikAlerting",
308
+ * valid: "./.",
309
+ * values: {
310
+ * "saas_alerting": "FULL"
311
+ * }
312
+ * }
313
+ * ],
314
+ * product: "Qlik Sense Enterprise SaaS",
315
+ * secondaryNumber: "12345",
316
+ * status: "Ok",
317
+ * trial: false,
318
+ * valid: "2018-01-01/2018-12-31"
319
+ * }
320
+ */
321
+ type LicenseOverview = {
322
+ allotments: {
323
+ name: "professional" | "analyzer" | "analyzer_time";
324
+ /** Overage value; -1 means unbounded overage. */
325
+ overage?: number;
326
+ units: number;
327
+ unitsUsed: number;
328
+ usageClass: string;
329
+ }[];
330
+ /** the capability bank id */
331
+ capabilityBankId?: string;
332
+ /** An ISO 8601 timestamp for when the license was last changed. */
333
+ changeTime?: string;
334
+ /** Customer ID */
335
+ customerId?: string;
336
+ /** An ISO 8601 timestamp for when the latest time the license has been known to be valid, a missing value indicates the indefinite future. */
337
+ latestValidTime?: string;
338
+ licenseKey: string;
339
+ licenseNumber: string;
340
+ licenseType?: string;
341
+ /** Origin of license key. */
342
+ origin: "Internal" | "External";
343
+ /** The license parameters. */
344
+ parameters: {
345
+ /** Parameters for licenses to control access to the parameters. */
346
+ access?: {
347
+ /** Name of an allotment that the user must have access to. to */
348
+ allotment?: string;
349
+ };
350
+ /** Parameter set (provision) name. */
351
+ name: string;
352
+ /** Time interval for parameter validity. */
353
+ valid: string;
354
+ /** Parameter values */
355
+ values?: unknown;
356
+ }[];
357
+ /** the parent number of the license. can be shared by multiple license numbers */
358
+ parentLicenseNumber?: string;
359
+ /** The product the license is valid for. */
360
+ product: string;
361
+ /** The secondary number of a definition. */
362
+ secondaryNumber: string;
363
+ /** Enum with status of license. Only status Ok grants license. access. */
364
+ status: "Ok" | "Blacklisted" | "Expired";
365
+ /** Boolean indicating if it is a trial license. */
366
+ trial: boolean;
367
+ /** An ISO 8601 timestamp for when the license was last updated. */
368
+ updated: string;
369
+ /** Period that the license is currently set to be active. Represented as an ISO 8601 time interval with start and end. */
370
+ valid: string;
371
+ };
372
+ /**
373
+ * @example
374
+ * {
375
+ * extensionStatus: "Unavailable",
376
+ * origin: "Internal",
377
+ * product: "Qlik Sense Business",
378
+ * status: "Ok",
379
+ * trial: false,
380
+ * type: "Signed",
381
+ * valid: "2018-01-01/2018-12-31"
382
+ * }
383
+ */
384
+ type LicenseStatus = {
385
+ /** Boolean indicating if the license is deactivated. */
386
+ deactivated: boolean;
387
+ /** Enum with extension status of license. access. */
388
+ extensionStatus: "Unavailable" | "Pending" | "Available";
389
+ /** Origin of license key. */
390
+ origin: "Internal" | "External";
391
+ /** The product the license is valid for. */
392
+ product: string;
393
+ /** Enum with status of license. Only status Ok grants license. access. */
394
+ status: "Ok" | "Blacklisted" | "Expired" | "Missing";
395
+ /** Boolean indicating if it is a trial license. */
396
+ trial: boolean;
397
+ /** Type of license key. */
398
+ type: "Signed" | "Plain" | "2.0";
399
+ /** Period that the license is currently set to be active. Represented as an ISO 8601 time interval with start and end. */
400
+ valid: string;
401
+ };
402
+ /**
403
+ * @example
404
+ * {
405
+ * autoAssignAnalyzer: true,
406
+ * autoAssignProfessional: false
407
+ * }
408
+ */
409
+ type SettingsBody = {
410
+ /** If analyzer users are available, they will be automatically assigned. Otherwise, analyzer capacity will be assigned, if available. */
411
+ autoAssignAnalyzer?: boolean;
412
+ /** If professional users are available, they will be automatically assigned. Otherwise, analyzer capacity will be assigned, if available. */
413
+ autoAssignProfessional?: boolean;
414
+ };
415
+ /**
416
+ * Retrieves assignments for the current tenant
417
+ *
418
+ * @param query an object with query parameters
419
+ * @throws GetLicenseAssignmentsHttpError
420
+ */
421
+ declare function getLicenseAssignments(query: {
422
+ /** The filter for finding entries. */
423
+ filter?: string;
424
+ /** The preferred number of entries to return. */
425
+ limit?: number;
426
+ /** Only return assignments which are 'orphans' in the current tenant. */
427
+ orphans?: boolean;
428
+ /** The requested page. */
429
+ page?: string;
430
+ /** The field to sort on; can be prefixed with +/- for ascending/descending sort order. */
431
+ sort?: string;
432
+ }, options?: ApiCallOptions): Promise<GetLicenseAssignmentsHttpResponse>;
433
+ type GetLicenseAssignmentsHttpResponse = {
434
+ data: AssignmentsResponse;
435
+ headers: Headers;
436
+ status: 200;
437
+ prev?: (options?: ApiCallOptions) => Promise<GetLicenseAssignmentsHttpResponse>;
438
+ next?: (options?: ApiCallOptions) => Promise<GetLicenseAssignmentsHttpResponse>;
439
+ };
440
+ type GetLicenseAssignmentsHttpError = {
441
+ data: ErrorResponse;
442
+ headers: Headers;
443
+ status: 400 | 401 | 403;
444
+ };
445
+ /**
446
+ * Assigns license access to the given users
447
+ *
448
+ * @param body an object with the body content
449
+ * @throws AddLicenseAssignmentsHttpError
450
+ */
451
+ declare function addLicenseAssignments(body: AssignmentsActionsAddRequest, options?: ApiCallOptions): Promise<AddLicenseAssignmentsHttpResponse>;
452
+ type AddLicenseAssignmentsHttpResponse = {
453
+ data: AssignmentsActionsAddResponse;
454
+ headers: Headers;
455
+ status: 207;
456
+ };
457
+ type AddLicenseAssignmentsHttpError = {
458
+ data: ErrorResponse;
459
+ headers: Headers;
460
+ status: 400 | 401 | 403;
461
+ };
462
+ /**
463
+ * Removes license access for the given users
464
+ *
465
+ * @param body an object with the body content
466
+ * @throws DeleteLicenseAssignmentsHttpError
467
+ */
468
+ declare function deleteLicenseAssignments(body: AssignmentsActionsDeleteRequest, options?: ApiCallOptions): Promise<DeleteLicenseAssignmentsHttpResponse>;
469
+ type DeleteLicenseAssignmentsHttpResponse = {
470
+ data: AssignmentsActionsDeleteResponse;
471
+ headers: Headers;
472
+ status: 207;
473
+ };
474
+ type DeleteLicenseAssignmentsHttpError = {
475
+ data: ErrorResponse;
476
+ headers: Headers;
477
+ status: 400 | 401 | 403;
478
+ };
479
+ /**
480
+ * Updates license access for the given users
481
+ *
482
+ * @param body an object with the body content
483
+ * @throws UpdateLicenseAssignmentsHttpError
484
+ */
485
+ declare function updateLicenseAssignments(body: AssignmentsActionsUpdateRequest, options?: ApiCallOptions): Promise<UpdateLicenseAssignmentsHttpResponse>;
486
+ type UpdateLicenseAssignmentsHttpResponse = {
487
+ data: AssignmentsActionsUpdateResponse;
488
+ headers: Headers;
489
+ status: 207;
490
+ };
491
+ type UpdateLicenseAssignmentsHttpError = {
492
+ data: ErrorResponse;
493
+ headers: Headers;
494
+ status: 400 | 401 | 403;
495
+ };
496
+ /**
497
+ * Retrieves license consumption for the current tenant
498
+ *
499
+ * @param query an object with query parameters
500
+ * @throws GetLicenseConsumptionHttpError
501
+ */
502
+ declare function getLicenseConsumption(query: {
503
+ /** The SCIM filter for the query. Filterable property is "endTime". */
504
+ filter?: string;
505
+ /** The preferred number of entries to return. */
506
+ limit?: number;
507
+ /** The requested page. */
508
+ page?: string;
509
+ /** The field to sort on; can be prefixed with +/- for ascending/descending sort order. */
510
+ sort?: string;
511
+ }, options?: ApiCallOptions): Promise<GetLicenseConsumptionHttpResponse>;
512
+ type GetLicenseConsumptionHttpResponse = {
513
+ data: ConsumptionEventsResponse;
514
+ headers: Headers;
515
+ status: 200;
516
+ prev?: (options?: ApiCallOptions) => Promise<GetLicenseConsumptionHttpResponse>;
517
+ next?: (options?: ApiCallOptions) => Promise<GetLicenseConsumptionHttpResponse>;
518
+ };
519
+ type GetLicenseConsumptionHttpError = {
520
+ data: ErrorResponse;
521
+ headers: Headers;
522
+ status: 400 | 401 | 403;
523
+ };
524
+ /**
525
+ * Gets the general information of the license applied to the current tenant
526
+ *
527
+ * @throws GetLicenseOverviewHttpError
528
+ */
529
+ declare function getLicenseOverview(options?: ApiCallOptions): Promise<GetLicenseOverviewHttpResponse>;
530
+ type GetLicenseOverviewHttpResponse = {
531
+ data: LicenseOverview;
532
+ headers: Headers;
533
+ status: 200;
534
+ };
535
+ type GetLicenseOverviewHttpError = {
536
+ data: ErrorResponse;
537
+ headers: Headers;
538
+ status: 400 | 401 | 404;
539
+ };
540
+ /**
541
+ * Get auto assign settings for tenant.
542
+ *
543
+ * @throws GetLicenseSettingsHttpError
544
+ */
545
+ declare function getLicenseSettings(options?: ApiCallOptions): Promise<GetLicenseSettingsHttpResponse>;
546
+ type GetLicenseSettingsHttpResponse = {
547
+ data: SettingsBody;
548
+ headers: Headers;
549
+ status: 200;
550
+ };
551
+ type GetLicenseSettingsHttpError = {
552
+ data: ErrorResponse;
553
+ headers: Headers;
554
+ status: 400 | 401 | 403;
555
+ };
556
+ /**
557
+ * Set auto assign settings for tenant
558
+ *
559
+ * @param body an object with the body content
560
+ * @throws UpdateLicenseSettingsHttpError
561
+ */
562
+ declare function updateLicenseSettings(body: SettingsBody, options?: ApiCallOptions): Promise<UpdateLicenseSettingsHttpResponse>;
563
+ type UpdateLicenseSettingsHttpResponse = {
564
+ data: SettingsBody;
565
+ headers: Headers;
566
+ status: 200;
567
+ };
568
+ type UpdateLicenseSettingsHttpError = {
569
+ data: ErrorResponse;
570
+ headers: Headers;
571
+ status: 400 | 401 | 403;
572
+ };
573
+ /**
574
+ * Gets the license status information of the current tenant
575
+ *
576
+ * @throws GetLicenseStatusHttpError
577
+ */
578
+ declare function getLicenseStatus(options?: ApiCallOptions): Promise<GetLicenseStatusHttpResponse>;
579
+ type GetLicenseStatusHttpResponse = {
580
+ data: LicenseStatus;
581
+ headers: Headers;
582
+ status: 200;
583
+ };
584
+ type GetLicenseStatusHttpError = {
585
+ data: ErrorResponse;
586
+ headers: Headers;
587
+ status: 400 | 401;
588
+ };
589
+ /**
590
+ * Clears the cache for licenses api requests.
591
+ */
592
+ declare function clearCache(): void;
593
+ type LicensesAPI = {
594
+ /**
595
+ * Retrieves assignments for the current tenant
596
+ *
597
+ * @param query an object with query parameters
598
+ * @throws GetLicenseAssignmentsHttpError
599
+ */
600
+ getLicenseAssignments: typeof getLicenseAssignments;
601
+ /**
602
+ * Assigns license access to the given users
603
+ *
604
+ * @param body an object with the body content
605
+ * @throws AddLicenseAssignmentsHttpError
606
+ */
607
+ addLicenseAssignments: typeof addLicenseAssignments;
608
+ /**
609
+ * Removes license access for the given users
610
+ *
611
+ * @param body an object with the body content
612
+ * @throws DeleteLicenseAssignmentsHttpError
613
+ */
614
+ deleteLicenseAssignments: typeof deleteLicenseAssignments;
615
+ /**
616
+ * Updates license access for the given users
617
+ *
618
+ * @param body an object with the body content
619
+ * @throws UpdateLicenseAssignmentsHttpError
620
+ */
621
+ updateLicenseAssignments: typeof updateLicenseAssignments;
622
+ /**
623
+ * Retrieves license consumption for the current tenant
624
+ *
625
+ * @param query an object with query parameters
626
+ * @throws GetLicenseConsumptionHttpError
627
+ */
628
+ getLicenseConsumption: typeof getLicenseConsumption;
629
+ /**
630
+ * Gets the general information of the license applied to the current tenant
631
+ *
632
+ * @throws GetLicenseOverviewHttpError
633
+ */
634
+ getLicenseOverview: typeof getLicenseOverview;
635
+ /**
636
+ * Get auto assign settings for tenant.
637
+ *
638
+ * @throws GetLicenseSettingsHttpError
639
+ */
640
+ getLicenseSettings: typeof getLicenseSettings;
641
+ /**
642
+ * Set auto assign settings for tenant
643
+ *
644
+ * @param body an object with the body content
645
+ * @throws UpdateLicenseSettingsHttpError
646
+ */
647
+ updateLicenseSettings: typeof updateLicenseSettings;
648
+ /**
649
+ * Gets the license status information of the current tenant
650
+ *
651
+ * @throws GetLicenseStatusHttpError
652
+ */
653
+ getLicenseStatus: typeof getLicenseStatus;
654
+ /**
655
+ * Clears the cache for licenses api requests.
656
+ */
657
+ clearCache: typeof clearCache;
658
+ };
659
+ /**
660
+ * Functions for the licenses api
661
+ */
662
+ declare const licensesExport: LicensesAPI;
663
+ //#endregion
4
664
  export { AddLicenseAssignmentsHttpError, AddLicenseAssignmentsHttpResponse, AssignmentsActionsAddRequest, AssignmentsActionsAddResponse, AssignmentsActionsDeleteRequest, AssignmentsActionsDeleteResponse, AssignmentsActionsUpdateRequest, AssignmentsActionsUpdateResponse, AssignmentsResponse, ConsumptionEventsResponse, DeleteLicenseAssignmentsHttpError, DeleteLicenseAssignmentsHttpResponse, ErrorResponse, GetLicenseAssignmentsHttpError, GetLicenseAssignmentsHttpResponse, GetLicenseConsumptionHttpError, GetLicenseConsumptionHttpResponse, GetLicenseOverviewHttpError, GetLicenseOverviewHttpResponse, GetLicenseSettingsHttpError, GetLicenseSettingsHttpResponse, GetLicenseStatusHttpError, GetLicenseStatusHttpResponse, Href, LicenseOverview, LicenseStatus, LicensesAPI, SettingsBody, UpdateLicenseAssignmentsHttpError, UpdateLicenseAssignmentsHttpResponse, UpdateLicenseSettingsHttpError, UpdateLicenseSettingsHttpResponse, addLicenseAssignments, clearCache, licensesExport as default, deleteLicenseAssignments, getLicenseAssignments, getLicenseConsumption, getLicenseOverview, getLicenseSettings, getLicenseStatus, updateLicenseAssignments, updateLicenseSettings };
package/licenses.js CHANGED
@@ -1,6 +1,5 @@
1
- import "./chunks/utils-BnC4lrlq.js";
2
- import "./chunks/public-runtime-modules-Dwjzb3l8.js";
3
- import { n as invokeFetch, t as clearApiCache } from "./chunks/invoke-fetch-PcVIxLW4.js";
1
+ import "./chunks/public-runtime-modules-QhLPeQr5.js";
2
+ import { n as invokeFetch, t as clearApiCache } from "./chunks/invoke-fetch-B7lGscuQ.js";
4
3
 
5
4
  //#region src/public/rest/licenses.ts
6
5
  /**