@qlik/api 1.26.0 → 1.28.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/api-keys.d.ts +11 -11
- package/api-keys.js +2 -2
- package/apps.d.ts +68 -68
- package/apps.js +2 -2
- package/audits.d.ts +36 -14
- package/audits.js +2 -2
- package/auth.js +2 -2
- package/automations.d.ts +36 -36
- package/automations.js +2 -2
- package/brands.d.ts +23 -23
- package/brands.js +2 -2
- package/chunks/{UV5COPU3.js → 2B7YWDQC.js} +3 -3
- package/chunks/{VX3MQBE7.js → 5MRIMVKS.js} +1 -1
- package/chunks/{7SNOQCIQ.js → 5XNSGPGZ.js} +1 -1
- package/chunks/{HGRF5TX3.js → KYCIMQ4L.js} +1 -1
- package/chunks/{AMO5NATA.js → WQYEWU54.js} +2 -2
- package/collections.d.ts +22 -22
- package/collections.js +2 -2
- package/csp-origins.d.ts +12 -12
- package/csp-origins.js +2 -2
- package/data-assets.d.ts +10 -10
- package/data-assets.js +2 -2
- package/data-connections.d.ts +18 -18
- package/data-connections.js +2 -2
- package/data-credentials.d.ts +10 -10
- package/data-credentials.js +2 -2
- package/data-files.d.ts +24 -24
- package/data-files.js +2 -2
- package/docs/authentication.md +1 -1
- package/extensions.d.ts +11 -11
- package/extensions.js +2 -2
- package/glossaries.d.ts +49 -48
- package/glossaries.js +2 -2
- package/groups.d.ts +16 -16
- package/groups.js +2 -2
- package/identity-providers.d.ts +15 -15
- package/identity-providers.js +2 -2
- package/index.js +4 -4
- package/items.d.ts +16 -16
- package/items.js +2 -2
- package/licenses.d.ts +18 -18
- package/licenses.js +2 -2
- package/package.json +2 -2
- package/qix.d.ts +10 -2
- package/qix.js +2 -2
- package/quotas.d.ts +4 -4
- package/quotas.js +2 -2
- package/reload-tasks.d.ts +10 -10
- package/reload-tasks.js +2 -2
- package/reloads.d.ts +17 -9
- package/reloads.js +2 -2
- package/reports.d.ts +4 -4
- package/reports.js +2 -2
- package/roles.d.ts +10 -10
- package/roles.js +2 -2
- package/spaces.d.ts +59 -25
- package/spaces.js +2 -2
- package/temp-contents.d.ts +6 -6
- package/temp-contents.js +2 -2
- package/tenants.d.ts +9 -9
- package/tenants.js +2 -2
- package/themes.d.ts +11 -11
- package/themes.js +2 -2
- package/transports.d.ts +17 -17
- package/transports.js +2 -2
- package/users.d.ts +19 -19
- package/users.js +2 -2
- package/web-integrations.d.ts +9 -9
- package/web-integrations.js +2 -2
- package/web-notifications.d.ts +12 -12
- package/web-notifications.js +2 -2
- package/webhooks.d.ts +20 -20
- package/webhooks.js +2 -2
package/spaces.d.ts
CHANGED
|
@@ -58,6 +58,32 @@ type Assignments = {
|
|
|
58
58
|
count: number;
|
|
59
59
|
};
|
|
60
60
|
};
|
|
61
|
+
/**
|
|
62
|
+
* An Environment is an environment context simplifying the grouping of spaces into environments by allowing users to control it on the environment instead of on the spaces themselves.
|
|
63
|
+
*/
|
|
64
|
+
type Environment = {
|
|
65
|
+
/** The date and time when the environment was created. */
|
|
66
|
+
readonly createdAt?: string;
|
|
67
|
+
/** The ID of the user who created the environment. */
|
|
68
|
+
readonly createdBy?: string;
|
|
69
|
+
/** The description of the environment. */
|
|
70
|
+
description?: string;
|
|
71
|
+
/** A unique identifier for the environment, for example, 62716f4b39b865ece543cd45. */
|
|
72
|
+
readonly id: string;
|
|
73
|
+
readonly links: {
|
|
74
|
+
self: Link;
|
|
75
|
+
};
|
|
76
|
+
/** The name of the environment. */
|
|
77
|
+
name: string;
|
|
78
|
+
/** The ID for the environment owner. */
|
|
79
|
+
readonly ownerId?: string;
|
|
80
|
+
/** The ID for the tenant, for example, xqGQ0k66vSR8f9G7J-vYtHZQkiYrCpct. */
|
|
81
|
+
readonly tenantId: string;
|
|
82
|
+
/** The date and time when the environment was updated. */
|
|
83
|
+
readonly updatedAt?: string;
|
|
84
|
+
/** The name of the environment. */
|
|
85
|
+
variables?: Variable[];
|
|
86
|
+
};
|
|
61
87
|
/**
|
|
62
88
|
* An error object.
|
|
63
89
|
*/
|
|
@@ -128,6 +154,8 @@ type Space = {
|
|
|
128
154
|
readonly createdBy?: string;
|
|
129
155
|
/** The description of the space. Personal spaces do not have a description. */
|
|
130
156
|
description?: string;
|
|
157
|
+
/** An Environment is an environment context simplifying the grouping of spaces into environments by allowing users to control it on the environment instead of on the spaces themselves. */
|
|
158
|
+
environment?: Environment;
|
|
131
159
|
/** A unique identifier for the space, for example, 62716f4b39b865ece543cd45. */
|
|
132
160
|
readonly id: string;
|
|
133
161
|
readonly links: {
|
|
@@ -210,6 +238,12 @@ type Spaces = {
|
|
|
210
238
|
};
|
|
211
239
|
};
|
|
212
240
|
};
|
|
241
|
+
type Variable = {
|
|
242
|
+
/** The Key */
|
|
243
|
+
readonly key?: string;
|
|
244
|
+
/** The value. */
|
|
245
|
+
readonly value?: string;
|
|
246
|
+
};
|
|
213
247
|
/**
|
|
214
248
|
* Retrieves spaces that the current user has access to and match the query.
|
|
215
249
|
*
|
|
@@ -239,14 +273,14 @@ declare const getSpaces: (query: {
|
|
|
239
273
|
type GetSpacesHttpResponse = {
|
|
240
274
|
data: Spaces;
|
|
241
275
|
headers: Headers;
|
|
242
|
-
status:
|
|
276
|
+
status: 200;
|
|
243
277
|
prev?: (options?: ApiCallOptions) => Promise<GetSpacesHttpResponse>;
|
|
244
278
|
next?: (options?: ApiCallOptions) => Promise<GetSpacesHttpResponse>;
|
|
245
279
|
};
|
|
246
280
|
type GetSpacesHttpError = {
|
|
247
281
|
data: Errors;
|
|
248
282
|
headers: Headers;
|
|
249
|
-
status:
|
|
283
|
+
status: 400 | 401 | 500;
|
|
250
284
|
};
|
|
251
285
|
/**
|
|
252
286
|
* Creates a space. Spaces names must be unique. Spaces of type `data` should only be used for Qlik Talend Data Integration projects.
|
|
@@ -258,12 +292,12 @@ declare const createSpace: (body: SpaceCreate, options?: ApiCallOptions) => Prom
|
|
|
258
292
|
type CreateSpaceHttpResponse = {
|
|
259
293
|
data: Space;
|
|
260
294
|
headers: Headers;
|
|
261
|
-
status:
|
|
295
|
+
status: 201;
|
|
262
296
|
};
|
|
263
297
|
type CreateSpaceHttpError = {
|
|
264
298
|
data: Errors;
|
|
265
299
|
headers: Headers;
|
|
266
|
-
status:
|
|
300
|
+
status: 401 | 403 | 409 | 500;
|
|
267
301
|
};
|
|
268
302
|
/**
|
|
269
303
|
* Gets a list of distinct space types available for use in the tenant.
|
|
@@ -274,12 +308,12 @@ declare const getSpaceTypes: (options?: ApiCallOptions) => Promise<GetSpaceTypes
|
|
|
274
308
|
type GetSpaceTypesHttpResponse = {
|
|
275
309
|
data: SpaceTypes;
|
|
276
310
|
headers: Headers;
|
|
277
|
-
status:
|
|
311
|
+
status: 200;
|
|
278
312
|
};
|
|
279
313
|
type GetSpaceTypesHttpError = {
|
|
280
314
|
data: Errors;
|
|
281
315
|
headers: Headers;
|
|
282
|
-
status:
|
|
316
|
+
status: 401 | 500;
|
|
283
317
|
};
|
|
284
318
|
/**
|
|
285
319
|
* Deletes a space.
|
|
@@ -291,12 +325,12 @@ declare const deleteSpace: (spaceId: string, options?: ApiCallOptions) => Promis
|
|
|
291
325
|
type DeleteSpaceHttpResponse = {
|
|
292
326
|
data: void;
|
|
293
327
|
headers: Headers;
|
|
294
|
-
status:
|
|
328
|
+
status: 204;
|
|
295
329
|
};
|
|
296
330
|
type DeleteSpaceHttpError = {
|
|
297
331
|
data: Errors;
|
|
298
332
|
headers: Headers;
|
|
299
|
-
status:
|
|
333
|
+
status: 401 | 403 | 404 | 412 | 500;
|
|
300
334
|
};
|
|
301
335
|
/**
|
|
302
336
|
* Retrieves a single space by ID.
|
|
@@ -308,12 +342,12 @@ declare const getSpace: (spaceId: string, options?: ApiCallOptions) => Promise<G
|
|
|
308
342
|
type GetSpaceHttpResponse = {
|
|
309
343
|
data: Space;
|
|
310
344
|
headers: Headers;
|
|
311
|
-
status:
|
|
345
|
+
status: 200;
|
|
312
346
|
};
|
|
313
347
|
type GetSpaceHttpError = {
|
|
314
348
|
data: Errors;
|
|
315
349
|
headers: Headers;
|
|
316
|
-
status:
|
|
350
|
+
status: 401 | 404 | 429 | 500;
|
|
317
351
|
};
|
|
318
352
|
/**
|
|
319
353
|
* Updates one or more properties of a space. To update all properties at once, use `PUT /spaces/{spaceId}`.
|
|
@@ -326,12 +360,12 @@ declare const patchSpace: (spaceId: string, body: SpacePatch, options?: ApiCallO
|
|
|
326
360
|
type PatchSpaceHttpResponse = {
|
|
327
361
|
data: Space;
|
|
328
362
|
headers: Headers;
|
|
329
|
-
status:
|
|
363
|
+
status: 200;
|
|
330
364
|
};
|
|
331
365
|
type PatchSpaceHttpError = {
|
|
332
366
|
data: Errors;
|
|
333
367
|
headers: Headers;
|
|
334
|
-
status:
|
|
368
|
+
status: 401 | 403 | 404 | 500;
|
|
335
369
|
};
|
|
336
370
|
/**
|
|
337
371
|
* Updates a space. To update specific properties, use `PATCH /spaces/{spaceId}`.
|
|
@@ -344,12 +378,12 @@ declare const updateSpace: (spaceId: string, body: SpaceUpdate, options?: ApiCal
|
|
|
344
378
|
type UpdateSpaceHttpResponse = {
|
|
345
379
|
data: Space;
|
|
346
380
|
headers: Headers;
|
|
347
|
-
status:
|
|
381
|
+
status: 200;
|
|
348
382
|
};
|
|
349
383
|
type UpdateSpaceHttpError = {
|
|
350
384
|
data: Errors;
|
|
351
385
|
headers: Headers;
|
|
352
|
-
status:
|
|
386
|
+
status: 401 | 403 | 404 | 500;
|
|
353
387
|
};
|
|
354
388
|
/**
|
|
355
389
|
* Retrieves the assignments of the space matching the query. Each assignment represents one user or group and their corresponding roles in the space. Assignments are not shown for the owner of a space, who receive all `assignableRoles` by default.
|
|
@@ -373,14 +407,14 @@ declare const getSpaceAssignments: (spaceId: string, query: {
|
|
|
373
407
|
type GetSpaceAssignmentsHttpResponse = {
|
|
374
408
|
data: Assignments;
|
|
375
409
|
headers: Headers;
|
|
376
|
-
status:
|
|
410
|
+
status: 200;
|
|
377
411
|
prev?: (options?: ApiCallOptions) => Promise<GetSpaceAssignmentsHttpResponse>;
|
|
378
412
|
next?: (options?: ApiCallOptions) => Promise<GetSpaceAssignmentsHttpResponse>;
|
|
379
413
|
};
|
|
380
414
|
type GetSpaceAssignmentsHttpError = {
|
|
381
415
|
data: Errors;
|
|
382
416
|
headers: Headers;
|
|
383
|
-
status:
|
|
417
|
+
status: 401 | 403 | 404 | 500;
|
|
384
418
|
};
|
|
385
419
|
/**
|
|
386
420
|
* Creates an assignment for a user or group (assignee) to a space with the specified roles. Assignments are not required for space owners, who receive all `assignableRoles` by default. Only one assignment can exist per space, per user or group.
|
|
@@ -393,12 +427,12 @@ declare const createSpaceAssignment: (spaceId: string, body: AssignmentCreate, o
|
|
|
393
427
|
type CreateSpaceAssignmentHttpResponse = {
|
|
394
428
|
data: Assignment;
|
|
395
429
|
headers: Headers;
|
|
396
|
-
status:
|
|
430
|
+
status: 201;
|
|
397
431
|
};
|
|
398
432
|
type CreateSpaceAssignmentHttpError = {
|
|
399
433
|
data: Errors;
|
|
400
434
|
headers: Headers;
|
|
401
|
-
status:
|
|
435
|
+
status: 401 | 403 | 404 | 409 | 500;
|
|
402
436
|
};
|
|
403
437
|
/**
|
|
404
438
|
* Deletes an assignment.
|
|
@@ -411,12 +445,12 @@ declare const deleteSpaceAssignment: (spaceId: string, assignmentId: string, opt
|
|
|
411
445
|
type DeleteSpaceAssignmentHttpResponse = {
|
|
412
446
|
data: void;
|
|
413
447
|
headers: Headers;
|
|
414
|
-
status:
|
|
448
|
+
status: 204;
|
|
415
449
|
};
|
|
416
450
|
type DeleteSpaceAssignmentHttpError = {
|
|
417
451
|
data: Errors;
|
|
418
452
|
headers: Headers;
|
|
419
|
-
status:
|
|
453
|
+
status: 401 | 403 | 404 | 500;
|
|
420
454
|
};
|
|
421
455
|
/**
|
|
422
456
|
* Retrieves a single assignment by assignment ID. Use `GET /spaces/{spaceId}/assignments` to list all users and groups assigned to the space and their assignment ID.
|
|
@@ -429,12 +463,12 @@ declare const getSpaceAssignment: (spaceId: string, assignmentId: string, option
|
|
|
429
463
|
type GetSpaceAssignmentHttpResponse = {
|
|
430
464
|
data: Assignment;
|
|
431
465
|
headers: Headers;
|
|
432
|
-
status:
|
|
466
|
+
status: 200;
|
|
433
467
|
};
|
|
434
468
|
type GetSpaceAssignmentHttpError = {
|
|
435
469
|
data: Errors;
|
|
436
470
|
headers: Headers;
|
|
437
|
-
status:
|
|
471
|
+
status: 401 | 403 | 404 | 500;
|
|
438
472
|
};
|
|
439
473
|
/**
|
|
440
474
|
* Updates a single assignment by assignment ID. Use `GET /spaces/{spaceId}/assignments` to list all users and groups assigned to the space and their assignment ID. The complete list of roles must be provided.
|
|
@@ -448,12 +482,12 @@ declare const updateSpaceAssignment: (spaceId: string, assignmentId: string, bod
|
|
|
448
482
|
type UpdateSpaceAssignmentHttpResponse = {
|
|
449
483
|
data: Assignment;
|
|
450
484
|
headers: Headers;
|
|
451
|
-
status:
|
|
485
|
+
status: 200;
|
|
452
486
|
};
|
|
453
487
|
type UpdateSpaceAssignmentHttpError = {
|
|
454
488
|
data: Errors;
|
|
455
489
|
headers: Headers;
|
|
456
|
-
status:
|
|
490
|
+
status: 401 | 403 | 404 | 500;
|
|
457
491
|
};
|
|
458
492
|
/**
|
|
459
493
|
* Clears the cache for spaces api requests.
|
|
@@ -561,4 +595,4 @@ interface SpacesAPI {
|
|
|
561
595
|
*/
|
|
562
596
|
declare const spacesExport: SpacesAPI;
|
|
563
597
|
|
|
564
|
-
export { type ActionName, type Assignment, type AssignmentCreate, type AssignmentType, type AssignmentUpdate, type Assignments, type CreateSpaceAssignmentHttpError, type CreateSpaceAssignmentHttpResponse, type CreateSpaceHttpError, type CreateSpaceHttpResponse, type DeleteSpaceAssignmentHttpError, type DeleteSpaceAssignmentHttpResponse, type DeleteSpaceHttpError, type DeleteSpaceHttpResponse, type Error, type Errors, type GetSpaceAssignmentHttpError, type GetSpaceAssignmentHttpResponse, type GetSpaceAssignmentsHttpError, type GetSpaceAssignmentsHttpResponse, type GetSpaceHttpError, type GetSpaceHttpResponse, type GetSpaceTypesHttpError, type GetSpaceTypesHttpResponse, type GetSpacesHttpError, type GetSpacesHttpResponse, type Link, type PatchSpaceHttpError, type PatchSpaceHttpResponse, type RoleType, type SharedSpaceRoleType, type Space, type SpaceCreate, type SpacePatch, type SpaceType, type SpaceTypes, type SpaceUpdate, type Spaces, type SpacesAPI, type UpdateSpaceAssignmentHttpError, type UpdateSpaceAssignmentHttpResponse, type UpdateSpaceHttpError, type UpdateSpaceHttpResponse, clearCache, createSpace, createSpaceAssignment, spacesExport as default, deleteSpace, deleteSpaceAssignment, getSpace, getSpaceAssignment, getSpaceAssignments, getSpaceTypes, getSpaces, patchSpace, updateSpace, updateSpaceAssignment };
|
|
598
|
+
export { type ActionName, type Assignment, type AssignmentCreate, type AssignmentType, type AssignmentUpdate, type Assignments, type CreateSpaceAssignmentHttpError, type CreateSpaceAssignmentHttpResponse, type CreateSpaceHttpError, type CreateSpaceHttpResponse, type DeleteSpaceAssignmentHttpError, type DeleteSpaceAssignmentHttpResponse, type DeleteSpaceHttpError, type DeleteSpaceHttpResponse, type Environment, type Error, type Errors, type GetSpaceAssignmentHttpError, type GetSpaceAssignmentHttpResponse, type GetSpaceAssignmentsHttpError, type GetSpaceAssignmentsHttpResponse, type GetSpaceHttpError, type GetSpaceHttpResponse, type GetSpaceTypesHttpError, type GetSpaceTypesHttpResponse, type GetSpacesHttpError, type GetSpacesHttpResponse, type Link, type PatchSpaceHttpError, type PatchSpaceHttpResponse, type RoleType, type SharedSpaceRoleType, type Space, type SpaceCreate, type SpacePatch, type SpaceType, type SpaceTypes, type SpaceUpdate, type Spaces, type SpacesAPI, type UpdateSpaceAssignmentHttpError, type UpdateSpaceAssignmentHttpResponse, type UpdateSpaceHttpError, type UpdateSpaceHttpResponse, type Variable, clearCache, createSpace, createSpaceAssignment, spacesExport as default, deleteSpace, deleteSpaceAssignment, getSpace, getSpaceAssignment, getSpaceAssignments, getSpaceTypes, getSpaces, patchSpace, updateSpace, updateSpaceAssignment };
|
package/spaces.js
CHANGED
package/temp-contents.d.ts
CHANGED
|
@@ -64,12 +64,12 @@ declare const uploadTempFile: (query: {
|
|
|
64
64
|
type UploadTempFileHttpResponse = {
|
|
65
65
|
data: void;
|
|
66
66
|
headers: Headers;
|
|
67
|
-
status:
|
|
67
|
+
status: 201;
|
|
68
68
|
};
|
|
69
69
|
type UploadTempFileHttpError = {
|
|
70
70
|
data: Errors;
|
|
71
71
|
headers: Headers;
|
|
72
|
-
status:
|
|
72
|
+
status: 400;
|
|
73
73
|
};
|
|
74
74
|
/**
|
|
75
75
|
* This endpoint is used to retrieve a temporary content file. It returns a valid (`200 OK`) in case the file exists and the user is authorized to view the contents. It returns a `410 Gone` if the file has expired and `404 Not Found` if the criteria is not met.
|
|
@@ -82,6 +82,7 @@ declare const downloadTempFile: (id: string, query: {
|
|
|
82
82
|
/** Set to "1" to download the file in inline mode. Useful for displaying a preview of the file in a browser. */
|
|
83
83
|
inline?: string;
|
|
84
84
|
}, options?: ApiCallOptions) => Promise<DownloadTempFileHttpResponse>;
|
|
85
|
+
type DownloadTempFileHttpResponse = DownloadTempFile200HttpResponse | DownloadTempFile204HttpResponse | DownloadTempFile206HttpResponse;
|
|
85
86
|
type DownloadTempFile200HttpResponse = {
|
|
86
87
|
data: unknown;
|
|
87
88
|
headers: Headers;
|
|
@@ -97,11 +98,10 @@ type DownloadTempFile206HttpResponse = {
|
|
|
97
98
|
headers: Headers;
|
|
98
99
|
status: 206;
|
|
99
100
|
};
|
|
100
|
-
type DownloadTempFileHttpResponse = DownloadTempFile200HttpResponse | DownloadTempFile204HttpResponse | DownloadTempFile206HttpResponse;
|
|
101
101
|
type DownloadTempFileHttpError = {
|
|
102
102
|
data: Errors;
|
|
103
103
|
headers: Headers;
|
|
104
|
-
status:
|
|
104
|
+
status: 400 | 404 | 410 | 416;
|
|
105
105
|
};
|
|
106
106
|
/**
|
|
107
107
|
* Retrieve a summary of the metadata associated with a temporary content resource. It returns a `200 OK` with a model if the temporary resource is valid. It returns a `410 Gone` if the file has expired and `404 Not Found` if the criteria is not met.
|
|
@@ -110,6 +110,7 @@ type DownloadTempFileHttpError = {
|
|
|
110
110
|
* @throws GetTempFileDetailsHttpError
|
|
111
111
|
*/
|
|
112
112
|
declare const getTempFileDetails: (id: string, options?: ApiCallOptions) => Promise<GetTempFileDetailsHttpResponse>;
|
|
113
|
+
type GetTempFileDetailsHttpResponse = GetTempFileDetails200HttpResponse | GetTempFileDetails204HttpResponse;
|
|
113
114
|
type GetTempFileDetails200HttpResponse = {
|
|
114
115
|
data: DetailResponse;
|
|
115
116
|
headers: Headers;
|
|
@@ -120,11 +121,10 @@ type GetTempFileDetails204HttpResponse = {
|
|
|
120
121
|
headers: Headers;
|
|
121
122
|
status: 204;
|
|
122
123
|
};
|
|
123
|
-
type GetTempFileDetailsHttpResponse = GetTempFileDetails200HttpResponse | GetTempFileDetails204HttpResponse;
|
|
124
124
|
type GetTempFileDetailsHttpError = {
|
|
125
125
|
data: Errors;
|
|
126
126
|
headers: Headers;
|
|
127
|
-
status:
|
|
127
|
+
status: 400 | 404 | 410;
|
|
128
128
|
};
|
|
129
129
|
/**
|
|
130
130
|
* Clears the cache for temp-contents api requests.
|
package/temp-contents.js
CHANGED
package/tenants.d.ts
CHANGED
|
@@ -134,7 +134,7 @@ declare const createTenant: (body: TenantCreationRequest, options?: ApiCallOptio
|
|
|
134
134
|
type CreateTenantHttpResponse = {
|
|
135
135
|
data: Tenant;
|
|
136
136
|
headers: Headers;
|
|
137
|
-
status:
|
|
137
|
+
status: 201;
|
|
138
138
|
};
|
|
139
139
|
type CreateTenantHttpError = {
|
|
140
140
|
data: Errors;
|
|
@@ -150,7 +150,7 @@ declare const getMyTenant: (options?: ApiCallOptions) => Promise<GetMyTenantHttp
|
|
|
150
150
|
type GetMyTenantHttpResponse = {
|
|
151
151
|
data: Tenant;
|
|
152
152
|
headers: Headers;
|
|
153
|
-
status:
|
|
153
|
+
status: 200;
|
|
154
154
|
};
|
|
155
155
|
type GetMyTenantHttpError = {
|
|
156
156
|
data: unknown;
|
|
@@ -167,7 +167,7 @@ declare const getTenant: (tenantId: string, options?: ApiCallOptions) => Promise
|
|
|
167
167
|
type GetTenantHttpResponse = {
|
|
168
168
|
data: Tenant;
|
|
169
169
|
headers: Headers;
|
|
170
|
-
status:
|
|
170
|
+
status: 200;
|
|
171
171
|
};
|
|
172
172
|
type GetTenantHttpError = {
|
|
173
173
|
data: Errors;
|
|
@@ -185,8 +185,9 @@ declare const patchTenant: (tenantId: string, body: TenantPatchSchema, options?:
|
|
|
185
185
|
type PatchTenantHttpResponse = {
|
|
186
186
|
data: void;
|
|
187
187
|
headers: Headers;
|
|
188
|
-
status:
|
|
188
|
+
status: 204;
|
|
189
189
|
};
|
|
190
|
+
type PatchTenantHttpError = PatchTenant400HttpError | PatchTenant403HttpError | PatchTenant404HttpError | PatchTenant429HttpError | PatchTenantdefaultHttpError;
|
|
190
191
|
type PatchTenant400HttpError = {
|
|
191
192
|
data: TenantPatchErrors;
|
|
192
193
|
headers: Headers;
|
|
@@ -207,12 +208,11 @@ type PatchTenant429HttpError = {
|
|
|
207
208
|
headers: Headers;
|
|
208
209
|
status: 429;
|
|
209
210
|
};
|
|
210
|
-
type
|
|
211
|
+
type PatchTenantdefaultHttpError = {
|
|
211
212
|
data: Errors;
|
|
212
213
|
headers: Headers;
|
|
213
214
|
status: "default";
|
|
214
215
|
};
|
|
215
|
-
type PatchTenantHttpError = PatchTenant400HttpError | PatchTenant403HttpError | PatchTenant404HttpError | PatchTenant429HttpError | PatchTenantDefaultHttpError;
|
|
216
216
|
/**
|
|
217
217
|
* Deactivates a specific tenant. Once deactivated, tenant will be deleted on or after `estimatedPurgeDate`. Tenant can be reactivated using `/v1/tenants/{tenantId}/actions/reactivate` until this date. You must use a regional OAuth client generated via the [My Qlik portal](https://account.myqlik.qlik.com/account) to call this endpoint. Tenant creation, deactivation, and reactivation requests must be sent to the register endpoint in the relevant Qlik Cloud region, e.g. `https://register.us.qlikcloud.com/api/v1/tenants/{tenantId}/actions/deactivate` if interacting with tenants in the `us` region.
|
|
218
218
|
*
|
|
@@ -224,7 +224,7 @@ declare const deactivateTenant: (tenantId: string, body: TenantDeactivateRequest
|
|
|
224
224
|
type DeactivateTenantHttpResponse = {
|
|
225
225
|
data: TenantDeactivateResponse;
|
|
226
226
|
headers: Headers;
|
|
227
|
-
status:
|
|
227
|
+
status: 200;
|
|
228
228
|
};
|
|
229
229
|
type DeactivateTenantHttpError = {
|
|
230
230
|
data: Errors;
|
|
@@ -242,7 +242,7 @@ declare const reactivateTenant: (tenantId: string, body: unknown, options?: ApiC
|
|
|
242
242
|
type ReactivateTenantHttpResponse = {
|
|
243
243
|
data: unknown;
|
|
244
244
|
headers: Headers;
|
|
245
|
-
status:
|
|
245
|
+
status: 200;
|
|
246
246
|
};
|
|
247
247
|
type ReactivateTenantHttpError = {
|
|
248
248
|
data: Errors;
|
|
@@ -308,4 +308,4 @@ interface TenantsAPI {
|
|
|
308
308
|
*/
|
|
309
309
|
declare const tenantsExport: TenantsAPI;
|
|
310
310
|
|
|
311
|
-
export { type CreateTenantHttpError, type CreateTenantHttpResponse, type DeactivateTenantHttpError, type DeactivateTenantHttpResponse, type Error, type Errors, type GetMyTenantHttpError, type GetMyTenantHttpResponse, type GetTenantHttpError, type GetTenantHttpResponse, type PatchTenant400HttpError, type PatchTenant403HttpError, type PatchTenant404HttpError, type PatchTenant429HttpError, type
|
|
311
|
+
export { type CreateTenantHttpError, type CreateTenantHttpResponse, type DeactivateTenantHttpError, type DeactivateTenantHttpResponse, type Error, type Errors, type GetMyTenantHttpError, type GetMyTenantHttpResponse, type GetTenantHttpError, type GetTenantHttpResponse, type PatchTenant400HttpError, type PatchTenant403HttpError, type PatchTenant404HttpError, type PatchTenant429HttpError, type PatchTenantHttpError, type PatchTenantHttpResponse, type PatchTenantdefaultHttpError, type ReactivateTenantHttpError, type ReactivateTenantHttpResponse, type Tenant, type TenantCreationRequest, type TenantDeactivateRequest, type TenantDeactivateResponse, type TenantPatchErrors, type TenantPatchSchema, type TenantsAPI, clearCache, createTenant, deactivateTenant, tenantsExport as default, getMyTenant, getTenant, patchTenant, reactivateTenant };
|
package/tenants.js
CHANGED
package/themes.d.ts
CHANGED
|
@@ -79,7 +79,7 @@ declare const getThemes: (options?: ApiCallOptions) => Promise<GetThemesHttpResp
|
|
|
79
79
|
type GetThemesHttpResponse = {
|
|
80
80
|
data: Themes;
|
|
81
81
|
headers: Headers;
|
|
82
|
-
status:
|
|
82
|
+
status: 200;
|
|
83
83
|
};
|
|
84
84
|
type GetThemesHttpError = {
|
|
85
85
|
data: unknown;
|
|
@@ -101,7 +101,7 @@ declare const uploadTheme: (body: {
|
|
|
101
101
|
type UploadThemeHttpResponse = {
|
|
102
102
|
data: Theme;
|
|
103
103
|
headers: Headers;
|
|
104
|
-
status:
|
|
104
|
+
status: 201;
|
|
105
105
|
};
|
|
106
106
|
type UploadThemeHttpError = {
|
|
107
107
|
data: Error;
|
|
@@ -118,12 +118,12 @@ declare const deleteTheme: (id: string, options?: ApiCallOptions) => Promise<Del
|
|
|
118
118
|
type DeleteThemeHttpResponse = {
|
|
119
119
|
data: void;
|
|
120
120
|
headers: Headers;
|
|
121
|
-
status:
|
|
121
|
+
status: 204;
|
|
122
122
|
};
|
|
123
123
|
type DeleteThemeHttpError = {
|
|
124
124
|
data: Error;
|
|
125
125
|
headers: Headers;
|
|
126
|
-
status:
|
|
126
|
+
status: 403 | 404 | 410;
|
|
127
127
|
};
|
|
128
128
|
/**
|
|
129
129
|
* Returns a specific theme matching either theme ID or theme name.
|
|
@@ -135,12 +135,12 @@ declare const getTheme: (id: string, options?: ApiCallOptions) => Promise<GetThe
|
|
|
135
135
|
type GetThemeHttpResponse = {
|
|
136
136
|
data: Theme;
|
|
137
137
|
headers: Headers;
|
|
138
|
-
status:
|
|
138
|
+
status: 200;
|
|
139
139
|
};
|
|
140
140
|
type GetThemeHttpError = {
|
|
141
141
|
data: Error;
|
|
142
142
|
headers: Headers;
|
|
143
|
-
status:
|
|
143
|
+
status: 403 | 404 | 410;
|
|
144
144
|
};
|
|
145
145
|
/**
|
|
146
146
|
* Updates a specific theme matching either theme ID or theme name. Accepts either provided file or data object.
|
|
@@ -158,7 +158,7 @@ declare const patchTheme: (id: string, body: {
|
|
|
158
158
|
type PatchThemeHttpResponse = {
|
|
159
159
|
data: Themes;
|
|
160
160
|
headers: Headers;
|
|
161
|
-
status:
|
|
161
|
+
status: 200;
|
|
162
162
|
};
|
|
163
163
|
type PatchThemeHttpError = {
|
|
164
164
|
data: Error;
|
|
@@ -175,12 +175,12 @@ declare const downloadTheme: (id: string, options?: ApiCallOptions) => Promise<D
|
|
|
175
175
|
type DownloadThemeHttpResponse = {
|
|
176
176
|
data: void;
|
|
177
177
|
headers: Headers;
|
|
178
|
-
status:
|
|
178
|
+
status: 200;
|
|
179
179
|
};
|
|
180
180
|
type DownloadThemeHttpError = {
|
|
181
181
|
data: Error;
|
|
182
182
|
headers: Headers;
|
|
183
|
-
status:
|
|
183
|
+
status: 403 | 404 | 410;
|
|
184
184
|
};
|
|
185
185
|
/**
|
|
186
186
|
* Downloads a file from the theme matching either theme ID or theme name, identified by the file path within the imported extension.
|
|
@@ -193,12 +193,12 @@ declare const downloadFileFromTheme: (id: string, filepath: string, options?: Ap
|
|
|
193
193
|
type DownloadFileFromThemeHttpResponse = {
|
|
194
194
|
data: void;
|
|
195
195
|
headers: Headers;
|
|
196
|
-
status:
|
|
196
|
+
status: 200;
|
|
197
197
|
};
|
|
198
198
|
type DownloadFileFromThemeHttpError = {
|
|
199
199
|
data: Error;
|
|
200
200
|
headers: Headers;
|
|
201
|
-
status:
|
|
201
|
+
status: 403 | 404 | 410;
|
|
202
202
|
};
|
|
203
203
|
/**
|
|
204
204
|
* Clears the cache for themes api requests.
|
package/themes.js
CHANGED
package/transports.d.ts
CHANGED
|
@@ -157,8 +157,9 @@ declare const deleteEmailConfig: (options?: ApiCallOptions) => Promise<DeleteEma
|
|
|
157
157
|
type DeleteEmailConfigHttpResponse = {
|
|
158
158
|
data: void;
|
|
159
159
|
headers: Headers;
|
|
160
|
-
status:
|
|
160
|
+
status: 204;
|
|
161
161
|
};
|
|
162
|
+
type DeleteEmailConfigHttpError = DeleteEmailConfig403HttpError | DeleteEmailConfig404HttpError | DeleteEmailConfigdefaultHttpError;
|
|
162
163
|
type DeleteEmailConfig403HttpError = {
|
|
163
164
|
data: TenantAdminError;
|
|
164
165
|
headers: Headers;
|
|
@@ -169,12 +170,11 @@ type DeleteEmailConfig404HttpError = {
|
|
|
169
170
|
headers: Headers;
|
|
170
171
|
status: 404;
|
|
171
172
|
};
|
|
172
|
-
type
|
|
173
|
+
type DeleteEmailConfigdefaultHttpError = {
|
|
173
174
|
data: ErrorsPublic;
|
|
174
175
|
headers: Headers;
|
|
175
176
|
status: "default";
|
|
176
177
|
};
|
|
177
|
-
type DeleteEmailConfigHttpError = DeleteEmailConfig403HttpError | DeleteEmailConfig404HttpError | DeleteEmailConfigDefaultHttpError;
|
|
178
178
|
/**
|
|
179
179
|
* Returns the email configuration for a given tenant id (retrieved from JWT).
|
|
180
180
|
*
|
|
@@ -184,19 +184,19 @@ declare const getEmailConfig: (options?: ApiCallOptions) => Promise<GetEmailConf
|
|
|
184
184
|
type GetEmailConfigHttpResponse = {
|
|
185
185
|
data: GetEmailConfig;
|
|
186
186
|
headers: Headers;
|
|
187
|
-
status:
|
|
187
|
+
status: 200;
|
|
188
188
|
};
|
|
189
|
+
type GetEmailConfigHttpError = GetEmailConfig403HttpError | GetEmailConfigdefaultHttpError;
|
|
189
190
|
type GetEmailConfig403HttpError = {
|
|
190
191
|
data: TenantAdminError;
|
|
191
192
|
headers: Headers;
|
|
192
193
|
status: 403;
|
|
193
194
|
};
|
|
194
|
-
type
|
|
195
|
+
type GetEmailConfigdefaultHttpError = {
|
|
195
196
|
data: ErrorsPublic;
|
|
196
197
|
headers: Headers;
|
|
197
198
|
status: "default";
|
|
198
199
|
};
|
|
199
|
-
type GetEmailConfigHttpError = GetEmailConfig403HttpError | GetEmailConfigDefaultHttpError;
|
|
200
200
|
/**
|
|
201
201
|
* Patch the email configuration for a given tenant id (retrieved from JWT).
|
|
202
202
|
*
|
|
@@ -207,8 +207,9 @@ declare const patchEmailConfig: (body: EmailConfigPatch, options?: ApiCallOption
|
|
|
207
207
|
type PatchEmailConfigHttpResponse = {
|
|
208
208
|
data: void;
|
|
209
209
|
headers: Headers;
|
|
210
|
-
status:
|
|
210
|
+
status: 204;
|
|
211
211
|
};
|
|
212
|
+
type PatchEmailConfigHttpError = PatchEmailConfig400HttpError | PatchEmailConfig403HttpError | PatchEmailConfigdefaultHttpError;
|
|
212
213
|
type PatchEmailConfig400HttpError = {
|
|
213
214
|
data: UpdateEmailConfigError;
|
|
214
215
|
headers: Headers;
|
|
@@ -219,12 +220,11 @@ type PatchEmailConfig403HttpError = {
|
|
|
219
220
|
headers: Headers;
|
|
220
221
|
status: 403;
|
|
221
222
|
};
|
|
222
|
-
type
|
|
223
|
+
type PatchEmailConfigdefaultHttpError = {
|
|
223
224
|
data: ErrorsPublic;
|
|
224
225
|
headers: Headers;
|
|
225
226
|
status: "default";
|
|
226
227
|
};
|
|
227
|
-
type PatchEmailConfigHttpError = PatchEmailConfig400HttpError | PatchEmailConfig403HttpError | PatchEmailConfigDefaultHttpError;
|
|
228
228
|
/**
|
|
229
229
|
* Send a test mail with the supplied email info (subject, body, recipient). Email config from database is used for the connection.
|
|
230
230
|
*
|
|
@@ -235,8 +235,9 @@ declare const sendTestEmail: (body: Email, options?: ApiCallOptions) => Promise<
|
|
|
235
235
|
type SendTestEmailHttpResponse = {
|
|
236
236
|
data: SmtpResult;
|
|
237
237
|
headers: Headers;
|
|
238
|
-
status:
|
|
238
|
+
status: 200;
|
|
239
239
|
};
|
|
240
|
+
type SendTestEmailHttpError = SendTestEmail403HttpError | SendTestEmail404HttpError | SendTestEmaildefaultHttpError;
|
|
240
241
|
type SendTestEmail403HttpError = {
|
|
241
242
|
data: TenantAdminError;
|
|
242
243
|
headers: Headers;
|
|
@@ -247,12 +248,11 @@ type SendTestEmail404HttpError = {
|
|
|
247
248
|
headers: Headers;
|
|
248
249
|
status: 404;
|
|
249
250
|
};
|
|
250
|
-
type
|
|
251
|
+
type SendTestEmaildefaultHttpError = {
|
|
251
252
|
data: ErrorsPublic;
|
|
252
253
|
headers: Headers;
|
|
253
254
|
status: "default";
|
|
254
255
|
};
|
|
255
|
-
type SendTestEmailHttpError = SendTestEmail403HttpError | SendTestEmail404HttpError | SendTestEmailDefaultHttpError;
|
|
256
256
|
/**
|
|
257
257
|
* Returns the isValid value for the email configuration for the tenant. Will return false if no email configuration exists.
|
|
258
258
|
*
|
|
@@ -262,7 +262,7 @@ declare const validateEmailConfig: (options?: ApiCallOptions) => Promise<Validat
|
|
|
262
262
|
type ValidateEmailConfigHttpResponse = {
|
|
263
263
|
data: SmtpCheck;
|
|
264
264
|
headers: Headers;
|
|
265
|
-
status:
|
|
265
|
+
status: 200;
|
|
266
266
|
};
|
|
267
267
|
type ValidateEmailConfigHttpError = {
|
|
268
268
|
data: ErrorsPublic;
|
|
@@ -278,19 +278,19 @@ declare const verifyEmailConfigConnection: (options?: ApiCallOptions) => Promise
|
|
|
278
278
|
type VerifyEmailConfigConnectionHttpResponse = {
|
|
279
279
|
data: SmtpResult;
|
|
280
280
|
headers: Headers;
|
|
281
|
-
status:
|
|
281
|
+
status: 200;
|
|
282
282
|
};
|
|
283
|
+
type VerifyEmailConfigConnectionHttpError = VerifyEmailConfigConnection404HttpError | VerifyEmailConfigConnectiondefaultHttpError;
|
|
283
284
|
type VerifyEmailConfigConnection404HttpError = {
|
|
284
285
|
data: VerifyConnectionConfigNotFoundError;
|
|
285
286
|
headers: Headers;
|
|
286
287
|
status: 404;
|
|
287
288
|
};
|
|
288
|
-
type
|
|
289
|
+
type VerifyEmailConfigConnectiondefaultHttpError = {
|
|
289
290
|
data: ErrorsPublic;
|
|
290
291
|
headers: Headers;
|
|
291
292
|
status: "default";
|
|
292
293
|
};
|
|
293
|
-
type VerifyEmailConfigConnectionHttpError = VerifyEmailConfigConnection404HttpError | VerifyEmailConfigConnectionDefaultHttpError;
|
|
294
294
|
/**
|
|
295
295
|
* Clears the cache for transports api requests.
|
|
296
296
|
*/
|
|
@@ -344,4 +344,4 @@ interface TransportsAPI {
|
|
|
344
344
|
*/
|
|
345
345
|
declare const transportsExport: TransportsAPI;
|
|
346
346
|
|
|
347
|
-
export { type DeleteConfigNotFoundError, type DeleteEmailConfig403HttpError, type DeleteEmailConfig404HttpError, type
|
|
347
|
+
export { type DeleteConfigNotFoundError, type DeleteEmailConfig403HttpError, type DeleteEmailConfig404HttpError, type DeleteEmailConfigHttpError, type DeleteEmailConfigHttpResponse, type DeleteEmailConfigdefaultHttpError, type Email, type EmailConfigFieldPatch, type EmailConfigPatch, type ErrorPublic, type ErrorsPublic, type GetBasicAuthConfig, type GetEmailConfig, type GetEmailConfig403HttpError, type GetEmailConfigHttpError, type GetEmailConfigHttpResponse, type GetEmailConfigdefaultHttpError, type GetMicrosoft365Config, type PatchEmailConfig400HttpError, type PatchEmailConfig403HttpError, type PatchEmailConfigHttpError, type PatchEmailConfigHttpResponse, type PatchEmailConfigdefaultHttpError, type SendTestEmail403HttpError, type SendTestEmail404HttpError, type SendTestEmailHttpError, type SendTestEmailHttpResponse, type SendTestEmaildefaultHttpError, type SendTestMailConfigNotFoundError, type SmtpCheck, type SmtpConfigStatus, type SmtpResult, type TenantAdminError, type TransportsAPI, type UpdateEmailConfigError, type ValidateEmailConfigHttpError, type ValidateEmailConfigHttpResponse, type VerifyConnectionConfigNotFoundError, type VerifyEmailConfigConnection404HttpError, type VerifyEmailConfigConnectionHttpError, type VerifyEmailConfigConnectionHttpResponse, type VerifyEmailConfigConnectiondefaultHttpError, clearCache, transportsExport as default, deleteEmailConfig, getEmailConfig, patchEmailConfig, sendTestEmail, validateEmailConfig, verifyEmailConfigConnection };
|
package/transports.js
CHANGED