@qlik/api 2.2.0 → 2.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (231) hide show
  1. package/analytics/change-stores.d.ts +386 -0
  2. package/analytics/change-stores.js +123 -0
  3. package/analytics.d.ts +14 -0
  4. package/analytics.js +13 -0
  5. package/api-keys.d.ts +362 -3
  6. package/api-keys.js +2 -3
  7. package/apps.d.ts +2673 -3
  8. package/apps.js +2 -3
  9. package/assistants.d.ts +1370 -3
  10. package/assistants.js +2 -3
  11. package/audits.d.ts +318 -3
  12. package/audits.js +4 -4
  13. package/auth-types.d.ts +1 -1
  14. package/auth-types.js +1 -2
  15. package/auth.d.ts +94 -2
  16. package/auth.js +63 -3
  17. package/automation-connections.d.ts +366 -3
  18. package/automation-connections.js +2 -3
  19. package/automation-connectors.d.ts +84 -3
  20. package/automation-connectors.js +2 -3
  21. package/automations.d.ts +805 -3
  22. package/automations.js +2 -3
  23. package/automl-deployments.d.ts +101 -3
  24. package/automl-deployments.js +2 -3
  25. package/automl-predictions.d.ts +238 -3
  26. package/automl-predictions.js +2 -3
  27. package/banners.d.ts +184 -3
  28. package/banners.js +2 -3
  29. package/brands.d.ts +670 -3
  30. package/brands.js +2 -3
  31. package/chunks/{auth-Cle0_tmz.js → auth-BowS4SUR.js} +1 -5
  32. package/chunks/{chunk-EtTptKIv.js → chunk-D3vHIbds.js} +2 -2
  33. package/chunks/{dist-gXLIqDJW.js → dist-n3iOVn1W.js} +4 -4
  34. package/chunks/{auth-functions-BmZgZYSs.js → interceptors-DipDBQQ5.js} +258 -54
  35. package/chunks/{invoke-fetch-PcVIxLW4.js → invoke-fetch-B7lGscuQ.js} +3 -3
  36. package/chunks/{invoke-fetch-CucBpA1C.js → invoke-fetch-DhdyFZ0F.js} +1 -5
  37. package/chunks/{public-runtime-modules-Dwjzb3l8.js → public-runtime-modules-QhLPeQr5.js} +7 -7
  38. package/chunks/{qix-DI5o5XF4.d.ts → qix-CrqXv44x.d.ts} +6 -2
  39. package/chunks/{qix-DjxuPCX0.js → qix-RCUslia8.js} +11 -10
  40. package/chunks/{qix-chunk-entrypoint-tmTo-kpa.js → qix-chunk-entrypoint-WAS4NVTf.js} +48 -50
  41. package/collections.d.ts +582 -3
  42. package/collections.js +2 -3
  43. package/conditions.d.ts +662 -3
  44. package/conditions.js +2 -3
  45. package/consumption.d.ts +182 -3
  46. package/consumption.js +2 -3
  47. package/core/ip-policies.d.ts +328 -4
  48. package/core/ip-policies.js +108 -5
  49. package/core.d.ts +13 -4
  50. package/core.js +3 -4
  51. package/csp-origins.d.ts +273 -3
  52. package/csp-origins.js +2 -3
  53. package/csrf-token.d.ts +62 -3
  54. package/csrf-token.js +2 -3
  55. package/data-alerts.d.ts +1004 -3
  56. package/data-alerts.js +2 -3
  57. package/data-assets.d.ts +207 -3
  58. package/data-assets.js +2 -3
  59. package/data-connections.d.ts +678 -3
  60. package/data-connections.js +2 -3
  61. package/data-credentials.d.ts +292 -3
  62. package/data-credentials.js +2 -3
  63. package/data-files.d.ts +860 -3
  64. package/data-files.js +2 -3
  65. package/data-qualities.d.ts +175 -3
  66. package/data-qualities.js +2 -3
  67. package/data-sets.d.ts +424 -3
  68. package/data-sets.js +2 -3
  69. package/data-sources.d.ts +348 -3
  70. package/data-sources.js +2 -3
  71. package/data-stores.d.ts +537 -3
  72. package/data-stores.js +2 -3
  73. package/dcaas.d.ts +192 -3
  74. package/dcaas.js +2 -3
  75. package/di-projects.d.ts +812 -4
  76. package/di-projects.js +25 -4
  77. package/direct-access-agents.d.ts +710 -4
  78. package/direct-access-agents.js +37 -5
  79. package/docs/authentication.md +1 -1
  80. package/encryption.d.ts +372 -3
  81. package/encryption.js +2 -3
  82. package/extensions.d.ts +295 -3
  83. package/extensions.js +2 -3
  84. package/global-types.d.ts +1 -1
  85. package/global-types.js +0 -2
  86. package/glossaries.d.ts +1223 -3
  87. package/glossaries.js +2 -3
  88. package/groups.d.ts +510 -3
  89. package/groups.js +2 -3
  90. package/identity-providers.d.ts +711 -3
  91. package/identity-providers.js +2 -3
  92. package/index.d.ts +78 -69
  93. package/index.js +28 -10
  94. package/interceptors.d.ts +52 -3
  95. package/interceptors.js +1 -2
  96. package/invoke-fetch-types.d.ts +1 -1
  97. package/items.d.ts +536 -3
  98. package/items.js +2 -3
  99. package/knowledgebases.d.ts +976 -3
  100. package/knowledgebases.js +2 -3
  101. package/licenses.d.ts +663 -3
  102. package/licenses.js +2 -3
  103. package/lineage-graphs.d.ts +704 -3
  104. package/lineage-graphs.js +2 -3
  105. package/ml.d.ts +2808 -3
  106. package/ml.js +2 -3
  107. package/notes.d.ts +110 -3
  108. package/notes.js +2 -3
  109. package/notifications.d.ts +98 -3
  110. package/notifications.js +2 -3
  111. package/oauth-callback.iife.js +1151 -0
  112. package/oauth-clients.d.ts +562 -3
  113. package/oauth-clients.js +2 -3
  114. package/oauth-tokens.d.ts +126 -3
  115. package/oauth-tokens.js +2 -3
  116. package/package.json +6 -4
  117. package/qix.d.ts +3 -3
  118. package/qix.js +38 -3
  119. package/questions.d.ts +364 -3
  120. package/questions.js +2 -3
  121. package/quotas.d.ts +112 -3
  122. package/quotas.js +2 -3
  123. package/reload-tasks.d.ts +249 -3
  124. package/reload-tasks.js +2 -3
  125. package/reloads.d.ts +260 -3
  126. package/reloads.js +2 -3
  127. package/report-templates.d.ts +287 -3
  128. package/report-templates.js +2 -3
  129. package/reports.d.ts +863 -3
  130. package/reports.js +2 -3
  131. package/roles.d.ts +312 -3
  132. package/roles.js +2 -3
  133. package/sharing-tasks.d.ts +1164 -3
  134. package/sharing-tasks.js +2 -3
  135. package/spaces.d.ts +779 -3
  136. package/spaces.js +2 -3
  137. package/tasks.d.ts +564 -3
  138. package/tasks.js +2 -3
  139. package/temp-contents.d.ts +167 -3
  140. package/temp-contents.js +2 -3
  141. package/tenants.d.ts +360 -3
  142. package/tenants.js +2 -3
  143. package/themes.d.ts +270 -3
  144. package/themes.js +2 -3
  145. package/transports.d.ts +435 -4
  146. package/transports.js +20 -5
  147. package/ui-config.d.ts +274 -3
  148. package/ui-config.js +2 -3
  149. package/users.d.ts +674 -3
  150. package/users.js +2 -3
  151. package/web-integrations.d.ts +294 -3
  152. package/web-integrations.js +2 -3
  153. package/web-notifications.d.ts +273 -3
  154. package/web-notifications.js +2 -3
  155. package/webhooks.d.ts +505 -3
  156. package/webhooks.js +2 -3
  157. package/chunks/api-keys-D6Rqaov4.d.ts +0 -365
  158. package/chunks/apps-BwpXUGDb.d.ts +0 -2673
  159. package/chunks/assistants-wh6Qe7l6.d.ts +0 -1366
  160. package/chunks/audits-DakwzT97.d.ts +0 -316
  161. package/chunks/auth-6mptVm5Q.d.ts +0 -95
  162. package/chunks/auth-D11iO7ZV.js +0 -65
  163. package/chunks/automation-connections-k2G_n9rj.d.ts +0 -366
  164. package/chunks/automation-connectors-J5OE-1P0.d.ts +0 -84
  165. package/chunks/automations-BGy83EBO.d.ts +0 -797
  166. package/chunks/automl-deployments-CWEpX2pk.d.ts +0 -101
  167. package/chunks/automl-predictions-BNIjRhBm.d.ts +0 -238
  168. package/chunks/banners-CgBRnZGv.d.ts +0 -184
  169. package/chunks/brands-DCgk6Gqx.d.ts +0 -671
  170. package/chunks/collections-BpYjcpIY.d.ts +0 -582
  171. package/chunks/conditions-CJJG7Uph.d.ts +0 -662
  172. package/chunks/consumption-DerFk437.d.ts +0 -182
  173. package/chunks/core-DQXNZdnf.d.ts +0 -12
  174. package/chunks/csp-origins-3NJlh_n9.d.ts +0 -273
  175. package/chunks/csrf-token-DoaoOQzH.d.ts +0 -63
  176. package/chunks/data-alerts-CILSEFbQ.d.ts +0 -1004
  177. package/chunks/data-assets-CJDcssoX.d.ts +0 -207
  178. package/chunks/data-connections-VSB13K6g.d.ts +0 -678
  179. package/chunks/data-credentials-ChEp_hyU.d.ts +0 -292
  180. package/chunks/data-files-CVzn9M6V.d.ts +0 -860
  181. package/chunks/data-qualities-DBrot957.d.ts +0 -176
  182. package/chunks/data-sets-CFzxgWnO.d.ts +0 -424
  183. package/chunks/data-sources-IsAaof_C.d.ts +0 -346
  184. package/chunks/data-stores-DFOPdgfz.d.ts +0 -537
  185. package/chunks/dcaas-qyv7YlrN.d.ts +0 -192
  186. package/chunks/di-projects-DVQTxASr.d.ts +0 -777
  187. package/chunks/direct-access-agents-B77OhzZi.d.ts +0 -580
  188. package/chunks/encryption-BjA6xbCO.d.ts +0 -372
  189. package/chunks/extensions-OO0WtInj.d.ts +0 -294
  190. package/chunks/glossaries-CIX7-KT_.d.ts +0 -1213
  191. package/chunks/groups-C86-UG7S.d.ts +0 -511
  192. package/chunks/identity-providers-h0dKNxGZ.d.ts +0 -711
  193. package/chunks/interceptors-Csx2tEi5.d.ts +0 -52
  194. package/chunks/interceptors-DTYm37AU.js +0 -104
  195. package/chunks/ip-policies-CKRIlbP7.d.ts +0 -327
  196. package/chunks/ip-policies-DXlf172B.js +0 -108
  197. package/chunks/items-C-jzqvFW.d.ts +0 -536
  198. package/chunks/knowledgebases-CyQtVcZN.d.ts +0 -977
  199. package/chunks/licenses-xzjnkitW.d.ts +0 -663
  200. package/chunks/lineage-graphs-CViCCzKy.d.ts +0 -697
  201. package/chunks/ml-Abt2MUva.d.ts +0 -2809
  202. package/chunks/notes-BZxuyDgt.d.ts +0 -111
  203. package/chunks/notifications-Bd_gp4jU.d.ts +0 -99
  204. package/chunks/oauth-clients-B5QPr4IM.d.ts +0 -563
  205. package/chunks/oauth-tokens-1b7V8182.d.ts +0 -127
  206. package/chunks/qix-CYQsLyGQ.js +0 -40
  207. package/chunks/questions-BVp0tvNs.d.ts +0 -364
  208. package/chunks/quotas-CfAebRJd.d.ts +0 -113
  209. package/chunks/reload-tasks-DfwUTetn.d.ts +0 -249
  210. package/chunks/reloads-CwmagnFx.d.ts +0 -260
  211. package/chunks/report-templates-DjQYj5dn.d.ts +0 -287
  212. package/chunks/reports-DzNC6Uq3.d.ts +0 -861
  213. package/chunks/roles-BYFIY6E7.d.ts +0 -312
  214. package/chunks/sharing-tasks-BMGIQ-FO.d.ts +0 -1164
  215. package/chunks/spaces-BK823t-b.d.ts +0 -780
  216. package/chunks/tasks-COKDfShO.d.ts +0 -564
  217. package/chunks/temp-contents-zDomB-g6.d.ts +0 -168
  218. package/chunks/tenants-Bhn86519.d.ts +0 -361
  219. package/chunks/themes-v9NbhiBo.d.ts +0 -269
  220. package/chunks/transports-CqEiFxD3.d.ts +0 -362
  221. package/chunks/ui-config-Crs0mVMp.d.ts +0 -274
  222. package/chunks/users-BSOBU_fg.d.ts +0 -675
  223. package/chunks/web-integrations-MisPAHod.d.ts +0 -295
  224. package/chunks/web-notifications-DVy6FHYh.d.ts +0 -274
  225. package/chunks/webhooks-Dr4EiXqy.d.ts +0 -505
  226. /package/chunks/{auth-types-E99tzdN0.d.ts → auth-types-YrlH_R9f.d.ts} +0 -0
  227. /package/chunks/{auth-types-JehqruDP.js → auth-types-h43TVDpB.js} +0 -0
  228. /package/chunks/{global-types-CrOvI33z.js → global-types-CEVAJebk.js} +0 -0
  229. /package/chunks/{invoke-fetch-CbU2Dgqr.d.ts → invoke-fetch-C1Z0RJYU.d.ts} +0 -0
  230. /package/chunks/{utils-BnC4lrlq.js → utils-vv-xFm06.js} +0 -0
  231. /package/chunks/{websocket-errors-DSbO6kDZ.js → websocket-errors-CRTDTtBL.js} +0 -0
@@ -1,671 +0,0 @@
1
- import { S as DownloadableBlob, y as ApiCallOptions } from "./auth-types-E99tzdN0.js";
2
-
3
- //#region src/public/rest/brands.d.ts
4
-
5
- /**
6
- * A brand is a collection of assets for applying custom branding. Only a single brand can be active in a tenant.
7
- */
8
- type Brand = {
9
- readonly active?: boolean;
10
- /** The UTC timestamp when the brand was created. */
11
- readonly createdAt?: string;
12
- /** ID of a user that created the brand. */
13
- readonly createdBy?: string;
14
- description: string;
15
- /** Collection of resources that make up the brand. */
16
- files: BrandFile[];
17
- readonly id: string;
18
- name: string;
19
- /** The UTC timestamp when the brand was last updated. */
20
- readonly updatedAt?: string;
21
- /** ID of a user that last updated the brand. */
22
- readonly updatedBy?: string;
23
- };
24
- /**
25
- * Represents one of the assets used as part of the brand. These include logos, favicons, and some styles.
26
- */
27
- type BrandFile = {
28
- contentType?: string;
29
- eTag?: string;
30
- id?: "logo" | "favIcon" | "styles";
31
- path?: string;
32
- };
33
- /**
34
- * A JSON Patch document as defined in https://datatracker.ietf.org/doc/html/rfc6902.
35
- */
36
- type BrandPatch = {
37
- /** The operation to be performed. */
38
- op: "add" | "remove" | "replace";
39
- /** The path for the given resource field to patch. */
40
- path: "/name" | "/description";
41
- /** The value to be used for this operation. */
42
- value?: string;
43
- };
44
- /**
45
- * A collection of brands.
46
- */
47
- type BrandsList = {
48
- data?: Brand[];
49
- links?: {
50
- next?: Link;
51
- prev?: Link;
52
- self?: Link;
53
- };
54
- };
55
- type ErrorResponse400 = {
56
- errors?: {
57
- code?: string;
58
- detail?: string;
59
- title?: string;
60
- }[];
61
- traceId?: string;
62
- };
63
- type ErrorResponse401 = {
64
- errors?: {
65
- code?: string;
66
- detail?: string;
67
- title?: string;
68
- }[];
69
- traceId?: string;
70
- };
71
- type ErrorResponse403 = {
72
- errors?: {
73
- code?: string;
74
- detail?: string;
75
- title?: string;
76
- }[];
77
- traceId?: string;
78
- };
79
- type ErrorResponse404 = {
80
- errors?: {
81
- code?: string;
82
- detail?: string;
83
- title?: string;
84
- }[];
85
- traceId?: string;
86
- };
87
- type ErrorResponse500 = {
88
- errors?: {
89
- code?: string;
90
- detail?: string;
91
- title?: string;
92
- }[];
93
- traceId?: string;
94
- };
95
- type Link = {
96
- /** URL of a resource request. */
97
- href: string;
98
- };
99
- /**
100
- * Empty object inferring lack of active branding.
101
- */
102
- type NoActiveBrand = unknown;
103
- /**
104
- * Lists all brand entries for a tenant.
105
- *
106
- * @param query an object with query parameters
107
- * @throws GetBrandsHttpError
108
- */
109
- declare function getBrands(query: {
110
- /** Cursor to previous. */
111
- endingBefore?: string;
112
- /** Maximum number of brands to retrieve. */
113
- limit?: number;
114
- /** Field to sort by, prefixed with -/+ to indicate the order. */
115
- sort?: "id" | "+id" | "-id" | "createdAt" | "+createdAt" | "-createdAt" | "updatedAt" | "+updatedAt" | "-updatedAt";
116
- /** Cursor to the next page. */
117
- startingAfter?: string;
118
- }, options?: ApiCallOptions): Promise<GetBrandsHttpResponse>;
119
- type GetBrandsHttpResponse = {
120
- data: BrandsList;
121
- headers: Headers;
122
- status: 200;
123
- prev?: (options?: ApiCallOptions) => Promise<GetBrandsHttpResponse>;
124
- next?: (options?: ApiCallOptions) => Promise<GetBrandsHttpResponse>;
125
- };
126
- type GetBrandsHttpError = GetBrands400HttpError | GetBrands401HttpError | GetBrands403HttpError | GetBrands500HttpError;
127
- type GetBrands400HttpError = {
128
- data: ErrorResponse400;
129
- headers: Headers;
130
- status: 400;
131
- };
132
- type GetBrands401HttpError = {
133
- data: ErrorResponse401;
134
- headers: Headers;
135
- status: 401;
136
- };
137
- type GetBrands403HttpError = {
138
- data: ErrorResponse403;
139
- headers: Headers;
140
- status: 403;
141
- };
142
- type GetBrands500HttpError = {
143
- data: ErrorResponse500;
144
- headers: Headers;
145
- status: 500;
146
- };
147
- /**
148
- * Creates a new brand.
149
- *
150
- * @param body an object with the body content
151
- * @throws CreateBrandHttpError
152
- */
153
- declare function createBrand(body: {
154
- /** Description of the brand. */
155
- description?: string;
156
- /** The path and name of a properly formatted ICO file. Maximum size is 100 KB. */
157
- favIcon?: BodyInit;
158
- /** The path and name of a JPG or PNG file that will be adjusted to fit in a 'box' measuring 109px in width and 62 px in height while maintaining aspect ratio. Maximum size of 300 KB, but smaller is recommended. */
159
- logo?: BodyInit;
160
- /** Name of the brand. */
161
- name: string;
162
- /** The path and name of a JSON file to define brand style settings. Maximum size is 100 KB. This property is not currently operational. */
163
- styles?: BodyInit;
164
- }, options?: ApiCallOptions): Promise<CreateBrandHttpResponse>;
165
- type CreateBrandHttpResponse = {
166
- data: Brand;
167
- headers: Headers;
168
- status: 201;
169
- };
170
- type CreateBrandHttpError = CreateBrand400HttpError | CreateBrand401HttpError | CreateBrand403HttpError | CreateBrand500HttpError;
171
- type CreateBrand400HttpError = {
172
- data: ErrorResponse400;
173
- headers: Headers;
174
- status: 400;
175
- };
176
- type CreateBrand401HttpError = {
177
- data: ErrorResponse401;
178
- headers: Headers;
179
- status: 401;
180
- };
181
- type CreateBrand403HttpError = {
182
- data: ErrorResponse403;
183
- headers: Headers;
184
- status: 403;
185
- };
186
- type CreateBrand500HttpError = {
187
- data: ErrorResponse500;
188
- headers: Headers;
189
- status: 500;
190
- };
191
- /**
192
- * Returns the current active brand. If using the Qlik default brand, no value is returned.
193
- *
194
- * @throws GetActiveBrandHttpError
195
- */
196
- declare function getActiveBrand(options?: ApiCallOptions): Promise<GetActiveBrandHttpResponse>;
197
- type GetActiveBrandHttpResponse = {
198
- data: Brand | NoActiveBrand;
199
- headers: Headers;
200
- status: 200;
201
- };
202
- type GetActiveBrandHttpError = {
203
- data: unknown;
204
- headers: Headers;
205
- status: number;
206
- };
207
- /**
208
- * Deletes a specific brand. If the active brand is deleted, the tenant will return to the Qlik default.
209
- *
210
- * @param brandId The brand's unique identifier.
211
- * @throws DeleteBrandHttpError
212
- */
213
- declare function deleteBrand(brandId: string, options?: ApiCallOptions): Promise<DeleteBrandHttpResponse>;
214
- type DeleteBrandHttpResponse = {
215
- data: void;
216
- headers: Headers;
217
- status: 204;
218
- };
219
- type DeleteBrandHttpError = DeleteBrand400HttpError | DeleteBrand401HttpError | DeleteBrand403HttpError | DeleteBrand404HttpError | DeleteBrand500HttpError;
220
- type DeleteBrand400HttpError = {
221
- data: ErrorResponse400;
222
- headers: Headers;
223
- status: 400;
224
- };
225
- type DeleteBrand401HttpError = {
226
- data: ErrorResponse401;
227
- headers: Headers;
228
- status: 401;
229
- };
230
- type DeleteBrand403HttpError = {
231
- data: ErrorResponse403;
232
- headers: Headers;
233
- status: 403;
234
- };
235
- type DeleteBrand404HttpError = {
236
- data: ErrorResponse404;
237
- headers: Headers;
238
- status: 404;
239
- };
240
- type DeleteBrand500HttpError = {
241
- data: ErrorResponse500;
242
- headers: Headers;
243
- status: 500;
244
- };
245
- /**
246
- * Returns a specific brand.
247
- *
248
- * @param brandId The brand's unique identifier.
249
- * @throws GetBrandHttpError
250
- */
251
- declare function getBrand(brandId: string, options?: ApiCallOptions): Promise<GetBrandHttpResponse>;
252
- type GetBrandHttpResponse = {
253
- data: Brand;
254
- headers: Headers;
255
- status: 200;
256
- };
257
- type GetBrandHttpError = GetBrand400HttpError | GetBrand401HttpError | GetBrand403HttpError | GetBrand404HttpError | GetBrand500HttpError;
258
- type GetBrand400HttpError = {
259
- data: ErrorResponse400;
260
- headers: Headers;
261
- status: 400;
262
- };
263
- type GetBrand401HttpError = {
264
- data: ErrorResponse401;
265
- headers: Headers;
266
- status: 401;
267
- };
268
- type GetBrand403HttpError = {
269
- data: ErrorResponse403;
270
- headers: Headers;
271
- status: 403;
272
- };
273
- type GetBrand404HttpError = {
274
- data: ErrorResponse404;
275
- headers: Headers;
276
- status: 404;
277
- };
278
- type GetBrand500HttpError = {
279
- data: ErrorResponse500;
280
- headers: Headers;
281
- status: 500;
282
- };
283
- /**
284
- * Patches a brand.
285
- *
286
- * @param brandId The brand's unique identifier.
287
- * @param body an object with the body content
288
- * @throws PatchBrandHttpError
289
- */
290
- declare function patchBrand(brandId: string, body: BrandPatch[], options?: ApiCallOptions): Promise<PatchBrandHttpResponse>;
291
- type PatchBrandHttpResponse = {
292
- data: void;
293
- headers: Headers;
294
- status: 204;
295
- };
296
- type PatchBrandHttpError = PatchBrand400HttpError | PatchBrand401HttpError | PatchBrand403HttpError | PatchBrand404HttpError | PatchBrand500HttpError;
297
- type PatchBrand400HttpError = {
298
- data: ErrorResponse400;
299
- headers: Headers;
300
- status: 400;
301
- };
302
- type PatchBrand401HttpError = {
303
- data: ErrorResponse401;
304
- headers: Headers;
305
- status: 401;
306
- };
307
- type PatchBrand403HttpError = {
308
- data: ErrorResponse403;
309
- headers: Headers;
310
- status: 403;
311
- };
312
- type PatchBrand404HttpError = {
313
- data: ErrorResponse404;
314
- headers: Headers;
315
- status: 404;
316
- };
317
- type PatchBrand500HttpError = {
318
- data: ErrorResponse500;
319
- headers: Headers;
320
- status: 500;
321
- };
322
- /**
323
- * Sets the brand active and de-activates any other active brand. If the brand is already active, no action is taken.
324
- *
325
- * @param brandId The brand's unique identifier.
326
- * @param body an object with the body content
327
- * @throws ActivateBrandHttpError
328
- */
329
- declare function activateBrand(brandId: string, body: unknown, options?: ApiCallOptions): Promise<ActivateBrandHttpResponse>;
330
- type ActivateBrandHttpResponse = {
331
- data: Brand;
332
- headers: Headers;
333
- status: 200;
334
- };
335
- type ActivateBrandHttpError = ActivateBrand400HttpError | ActivateBrand401HttpError | ActivateBrand403HttpError | ActivateBrand404HttpError | ActivateBrand500HttpError;
336
- type ActivateBrand400HttpError = {
337
- data: ErrorResponse400;
338
- headers: Headers;
339
- status: 400;
340
- };
341
- type ActivateBrand401HttpError = {
342
- data: ErrorResponse401;
343
- headers: Headers;
344
- status: 401;
345
- };
346
- type ActivateBrand403HttpError = {
347
- data: ErrorResponse403;
348
- headers: Headers;
349
- status: 403;
350
- };
351
- type ActivateBrand404HttpError = {
352
- data: ErrorResponse404;
353
- headers: Headers;
354
- status: 404;
355
- };
356
- type ActivateBrand500HttpError = {
357
- data: ErrorResponse500;
358
- headers: Headers;
359
- status: 500;
360
- };
361
- /**
362
- * Sets the brand so it is no longer active, returning the tenant the Qlik default brand. If the brand is already inactive, no action is taken.
363
- *
364
- * @param brandId The brand's unique identifier.
365
- * @param body an object with the body content
366
- * @throws DeactivateBrandHttpError
367
- */
368
- declare function deactivateBrand(brandId: string, body: unknown, options?: ApiCallOptions): Promise<DeactivateBrandHttpResponse>;
369
- type DeactivateBrandHttpResponse = {
370
- data: Brand;
371
- headers: Headers;
372
- status: 200;
373
- };
374
- type DeactivateBrandHttpError = DeactivateBrand400HttpError | DeactivateBrand401HttpError | DeactivateBrand403HttpError | DeactivateBrand404HttpError | DeactivateBrand500HttpError;
375
- type DeactivateBrand400HttpError = {
376
- data: ErrorResponse400;
377
- headers: Headers;
378
- status: 400;
379
- };
380
- type DeactivateBrand401HttpError = {
381
- data: ErrorResponse401;
382
- headers: Headers;
383
- status: 401;
384
- };
385
- type DeactivateBrand403HttpError = {
386
- data: ErrorResponse403;
387
- headers: Headers;
388
- status: 403;
389
- };
390
- type DeactivateBrand404HttpError = {
391
- data: ErrorResponse404;
392
- headers: Headers;
393
- status: 404;
394
- };
395
- type DeactivateBrand500HttpError = {
396
- data: ErrorResponse500;
397
- headers: Headers;
398
- status: 500;
399
- };
400
- /**
401
- * Deletes the specified brand file.
402
- *
403
- * @param brandId The brand's unique identifier.
404
- * @param brandFileId The unique identifier of a file within a brand.
405
- * @throws DeleteBrandFileHttpError
406
- */
407
- declare function deleteBrandFile(brandId: string, brandFileId: string, options?: ApiCallOptions): Promise<DeleteBrandFileHttpResponse>;
408
- type DeleteBrandFileHttpResponse = {
409
- data: void;
410
- headers: Headers;
411
- status: 204;
412
- };
413
- type DeleteBrandFileHttpError = DeleteBrandFile400HttpError | DeleteBrandFile401HttpError | DeleteBrandFile403HttpError | DeleteBrandFile404HttpError | DeleteBrandFile500HttpError;
414
- type DeleteBrandFile400HttpError = {
415
- data: ErrorResponse400;
416
- headers: Headers;
417
- status: 400;
418
- };
419
- type DeleteBrandFile401HttpError = {
420
- data: ErrorResponse401;
421
- headers: Headers;
422
- status: 401;
423
- };
424
- type DeleteBrandFile403HttpError = {
425
- data: ErrorResponse403;
426
- headers: Headers;
427
- status: 403;
428
- };
429
- type DeleteBrandFile404HttpError = {
430
- data: ErrorResponse404;
431
- headers: Headers;
432
- status: 404;
433
- };
434
- type DeleteBrandFile500HttpError = {
435
- data: ErrorResponse500;
436
- headers: Headers;
437
- status: 500;
438
- };
439
- /**
440
- * Downloads the specified brand file.
441
- *
442
- * @param brandId The brand's unique identifier.
443
- * @param brandFileId The unique identifier of a file within a brand.
444
- * @throws GetBrandFileHttpError
445
- */
446
- declare function getBrandFile(brandId: string, brandFileId: string, options?: ApiCallOptions): Promise<GetBrandFileHttpResponse>;
447
- type GetBrandFileHttpResponse = {
448
- data: DownloadableBlob;
449
- headers: Headers;
450
- status: 200;
451
- };
452
- type GetBrandFileHttpError = GetBrandFile400HttpError | GetBrandFile401HttpError | GetBrandFile403HttpError | GetBrandFile404HttpError | GetBrandFile500HttpError;
453
- type GetBrandFile400HttpError = {
454
- data: ErrorResponse400;
455
- headers: Headers;
456
- status: 400;
457
- };
458
- type GetBrandFile401HttpError = {
459
- data: ErrorResponse401;
460
- headers: Headers;
461
- status: 401;
462
- };
463
- type GetBrandFile403HttpError = {
464
- data: ErrorResponse403;
465
- headers: Headers;
466
- status: 403;
467
- };
468
- type GetBrandFile404HttpError = {
469
- data: ErrorResponse404;
470
- headers: Headers;
471
- status: 404;
472
- };
473
- type GetBrandFile500HttpError = {
474
- data: ErrorResponse500;
475
- headers: Headers;
476
- status: 500;
477
- };
478
- /**
479
- * Creates a brand file for the specified identifier.
480
- *
481
- * @param brandId The brand's unique identifier.
482
- * @param brandFileId The unique identifier of a file within a brand.
483
- * @param body an object with the body content
484
- * @throws CreateBrandFileHttpError
485
- */
486
- declare function createBrandFile(brandId: string, brandFileId: string, body: {
487
- /** The path and name of a file to upload. */
488
- file?: BodyInit;
489
- }, options?: ApiCallOptions): Promise<CreateBrandFileHttpResponse>;
490
- type CreateBrandFileHttpResponse = {
491
- data: BrandFile;
492
- headers: Headers;
493
- status: 201;
494
- };
495
- type CreateBrandFileHttpError = CreateBrandFile400HttpError | CreateBrandFile401HttpError | CreateBrandFile403HttpError | CreateBrandFile404HttpError | CreateBrandFile500HttpError;
496
- type CreateBrandFile400HttpError = {
497
- data: ErrorResponse400;
498
- headers: Headers;
499
- status: 400;
500
- };
501
- type CreateBrandFile401HttpError = {
502
- data: ErrorResponse401;
503
- headers: Headers;
504
- status: 401;
505
- };
506
- type CreateBrandFile403HttpError = {
507
- data: ErrorResponse403;
508
- headers: Headers;
509
- status: 403;
510
- };
511
- type CreateBrandFile404HttpError = {
512
- data: ErrorResponse404;
513
- headers: Headers;
514
- status: 404;
515
- };
516
- type CreateBrandFile500HttpError = {
517
- data: ErrorResponse500;
518
- headers: Headers;
519
- status: 500;
520
- };
521
- /**
522
- * Updates the specified brand file.
523
- *
524
- * @param brandId The brand's unique identifier.
525
- * @param brandFileId The unique identifier of a file within a brand.
526
- * @param body an object with the body content
527
- * @throws UpdateBrandFileHttpError
528
- */
529
- declare function updateBrandFile(brandId: string, brandFileId: string, body: {
530
- /** A file to upload. */
531
- file?: BodyInit;
532
- }, options?: ApiCallOptions): Promise<UpdateBrandFileHttpResponse>;
533
- type UpdateBrandFileHttpResponse = {
534
- data: BrandFile;
535
- headers: Headers;
536
- status: 200;
537
- };
538
- type UpdateBrandFileHttpError = UpdateBrandFile400HttpError | UpdateBrandFile401HttpError | UpdateBrandFile403HttpError | UpdateBrandFile404HttpError | UpdateBrandFile500HttpError;
539
- type UpdateBrandFile400HttpError = {
540
- data: ErrorResponse400;
541
- headers: Headers;
542
- status: 400;
543
- };
544
- type UpdateBrandFile401HttpError = {
545
- data: ErrorResponse401;
546
- headers: Headers;
547
- status: 401;
548
- };
549
- type UpdateBrandFile403HttpError = {
550
- data: ErrorResponse403;
551
- headers: Headers;
552
- status: 403;
553
- };
554
- type UpdateBrandFile404HttpError = {
555
- data: ErrorResponse404;
556
- headers: Headers;
557
- status: 404;
558
- };
559
- type UpdateBrandFile500HttpError = {
560
- data: ErrorResponse500;
561
- headers: Headers;
562
- status: 500;
563
- };
564
- /**
565
- * Clears the cache for brands api requests.
566
- */
567
- declare function clearCache(): void;
568
- type BrandsAPI = {
569
- /**
570
- * Lists all brand entries for a tenant.
571
- *
572
- * @param query an object with query parameters
573
- * @throws GetBrandsHttpError
574
- */
575
- getBrands: typeof getBrands;
576
- /**
577
- * Creates a new brand.
578
- *
579
- * @param body an object with the body content
580
- * @throws CreateBrandHttpError
581
- */
582
- createBrand: typeof createBrand;
583
- /**
584
- * Returns the current active brand. If using the Qlik default brand, no value is returned.
585
- *
586
- * @throws GetActiveBrandHttpError
587
- */
588
- getActiveBrand: typeof getActiveBrand;
589
- /**
590
- * Deletes a specific brand. If the active brand is deleted, the tenant will return to the Qlik default.
591
- *
592
- * @param brandId The brand's unique identifier.
593
- * @throws DeleteBrandHttpError
594
- */
595
- deleteBrand: typeof deleteBrand;
596
- /**
597
- * Returns a specific brand.
598
- *
599
- * @param brandId The brand's unique identifier.
600
- * @throws GetBrandHttpError
601
- */
602
- getBrand: typeof getBrand;
603
- /**
604
- * Patches a brand.
605
- *
606
- * @param brandId The brand's unique identifier.
607
- * @param body an object with the body content
608
- * @throws PatchBrandHttpError
609
- */
610
- patchBrand: typeof patchBrand;
611
- /**
612
- * Sets the brand active and de-activates any other active brand. If the brand is already active, no action is taken.
613
- *
614
- * @param brandId The brand's unique identifier.
615
- * @param body an object with the body content
616
- * @throws ActivateBrandHttpError
617
- */
618
- activateBrand: typeof activateBrand;
619
- /**
620
- * Sets the brand so it is no longer active, returning the tenant the Qlik default brand. If the brand is already inactive, no action is taken.
621
- *
622
- * @param brandId The brand's unique identifier.
623
- * @param body an object with the body content
624
- * @throws DeactivateBrandHttpError
625
- */
626
- deactivateBrand: typeof deactivateBrand;
627
- /**
628
- * Deletes the specified brand file.
629
- *
630
- * @param brandId The brand's unique identifier.
631
- * @param brandFileId The unique identifier of a file within a brand.
632
- * @throws DeleteBrandFileHttpError
633
- */
634
- deleteBrandFile: typeof deleteBrandFile;
635
- /**
636
- * Downloads the specified brand file.
637
- *
638
- * @param brandId The brand's unique identifier.
639
- * @param brandFileId The unique identifier of a file within a brand.
640
- * @throws GetBrandFileHttpError
641
- */
642
- getBrandFile: typeof getBrandFile;
643
- /**
644
- * Creates a brand file for the specified identifier.
645
- *
646
- * @param brandId The brand's unique identifier.
647
- * @param brandFileId The unique identifier of a file within a brand.
648
- * @param body an object with the body content
649
- * @throws CreateBrandFileHttpError
650
- */
651
- createBrandFile: typeof createBrandFile;
652
- /**
653
- * Updates the specified brand file.
654
- *
655
- * @param brandId The brand's unique identifier.
656
- * @param brandFileId The unique identifier of a file within a brand.
657
- * @param body an object with the body content
658
- * @throws UpdateBrandFileHttpError
659
- */
660
- updateBrandFile: typeof updateBrandFile;
661
- /**
662
- * Clears the cache for brands api requests.
663
- */
664
- clearCache: typeof clearCache;
665
- };
666
- /**
667
- * Functions for the brands api
668
- */
669
- declare const brandsExport: BrandsAPI;
670
- //#endregion
671
- export { GetActiveBrandHttpResponse as $, DeactivateBrand500HttpError as A, UpdateBrandFile401HttpError as At, DeleteBrandFile403HttpError as B, createBrandFile as Bt, CreateBrandFileHttpResponse as C, PatchBrand401HttpError as Ct, DeactivateBrand401HttpError as D, PatchBrandHttpError as Dt, DeactivateBrand400HttpError as E, PatchBrand500HttpError as Et, DeleteBrand403HttpError as F, UpdateBrandFileHttpResponse as Ft, DeleteBrandHttpError as G, getBrand as Gt, DeleteBrandFile500HttpError as H, deleteBrand as Ht, DeleteBrand404HttpError as I, activateBrand as It, ErrorResponse401 as J, patchBrand as Jt, DeleteBrandHttpResponse as K, getBrandFile as Kt, DeleteBrand500HttpError as L, brandsExport as Lt, DeactivateBrandHttpResponse as M, UpdateBrandFile404HttpError as Mt, DeleteBrand400HttpError as N, UpdateBrandFile500HttpError as Nt, DeactivateBrand403HttpError as O, PatchBrandHttpResponse as Ot, DeleteBrand401HttpError as P, UpdateBrandFileHttpError as Pt, GetActiveBrandHttpError as Q, DeleteBrandFile400HttpError as R, clearCache as Rt, CreateBrandFileHttpError as S, PatchBrand400HttpError as St, CreateBrandHttpResponse as T, PatchBrand404HttpError as Tt, DeleteBrandFileHttpError as U, deleteBrandFile as Ut, DeleteBrandFile404HttpError as V, deactivateBrand as Vt, DeleteBrandFileHttpResponse as W, getActiveBrand as Wt, ErrorResponse404 as X, ErrorResponse403 as Y, updateBrandFile as Yt, ErrorResponse500 as Z, CreateBrandFile400HttpError as _, GetBrands500HttpError as _t, ActivateBrand500HttpError as a, GetBrandFile400HttpError as at, CreateBrandFile404HttpError as b, Link as bt, Brand as c, GetBrandFile404HttpError as ct, BrandsAPI as d, GetBrandFileHttpResponse as dt, GetBrand400HttpError as et, BrandsList as f, GetBrandHttpError as ft, CreateBrand500HttpError as g, GetBrands403HttpError as gt, CreateBrand403HttpError as h, GetBrands401HttpError as ht, ActivateBrand404HttpError as i, GetBrand500HttpError as it, DeactivateBrandHttpError as j, UpdateBrandFile403HttpError as jt, DeactivateBrand404HttpError as k, UpdateBrandFile400HttpError as kt, BrandFile as l, GetBrandFile500HttpError as lt, CreateBrand401HttpError as m, GetBrands400HttpError as mt, ActivateBrand401HttpError as n, GetBrand403HttpError as nt, ActivateBrandHttpError as o, GetBrandFile401HttpError as ot, CreateBrand400HttpError as p, GetBrandHttpResponse as pt, ErrorResponse400 as q, getBrands as qt, ActivateBrand403HttpError as r, GetBrand404HttpError as rt, ActivateBrandHttpResponse as s, GetBrandFile403HttpError as st, ActivateBrand400HttpError as t, GetBrand401HttpError as tt, BrandPatch as u, GetBrandFileHttpError as ut, CreateBrandFile401HttpError as v, GetBrandsHttpError as vt, CreateBrandHttpError as w, PatchBrand403HttpError as wt, CreateBrandFile500HttpError as x, NoActiveBrand as xt, CreateBrandFile403HttpError as y, GetBrandsHttpResponse as yt, DeleteBrandFile401HttpError as z, createBrand as zt };