@qlik/api 1.25.0 → 1.27.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 +12 -12
- package/api-keys.js +2 -2
- package/apps.d.ts +69 -69
- package/apps.js +2 -2
- package/audits.d.ts +37 -15
- package/audits.js +2 -2
- package/auth.js +2 -2
- package/automations.d.ts +37 -37
- package/automations.js +2 -2
- package/brands.d.ts +24 -24
- package/brands.js +2 -2
- package/chunks/{3DYV7KOJ.js → 2BRBIRM2.js} +2 -2
- package/chunks/{7BDAXGID.js → 3RGGGGAR.js} +6 -9
- package/chunks/{6DEESTGF.js → 4D5NADHK.js} +4 -4
- package/chunks/{VX3MQBE7.js → 4K3CNR7C.js} +1 -1
- package/chunks/{OIQ5ELGS.js → 55SZVSAG.js} +1 -1
- package/chunks/{BL5PJM4B.js → EOGHK2R4.js} +1 -1
- package/chunks/{N3ZFICDU.js → MGXEGSJC.js} +3 -3
- package/chunks/{I5UOE4ZZ.js → NBW6PHZU.js} +120 -44
- package/chunks/{6QRR5VUM.js → QOOCP2TS.js} +4 -3
- package/chunks/{CZC7KEJN.js → V3TZ54UE.js} +3 -3
- package/chunks/{UA6BE3VB.js → WY7IOA3Q.js} +2 -2
- package/collections.d.ts +23 -23
- package/collections.js +2 -2
- package/csp-origins.d.ts +25 -25
- package/csp-origins.js +2 -2
- package/data-assets.d.ts +12 -12
- package/data-assets.js +2 -2
- package/data-connections.d.ts +19 -19
- package/data-connections.js +2 -2
- package/data-credentials.d.ts +11 -11
- package/data-credentials.js +2 -2
- package/data-files.d.ts +25 -25
- package/data-files.js +2 -2
- package/docs/authentication.md +1 -1
- package/docs/qix.md +28 -8
- package/extensions.d.ts +12 -12
- package/extensions.js +2 -2
- package/glossaries.d.ts +49 -49
- package/glossaries.js +2 -2
- package/groups.d.ts +17 -17
- package/groups.js +2 -2
- package/identity-providers.d.ts +43 -18
- package/identity-providers.js +2 -2
- package/index.d.ts +1 -1
- package/index.js +5 -5
- package/interceptors.d.ts +1 -1
- package/interceptors.js +1 -1
- package/{invoke-fetch-types-BLrpeZOL.d.ts → invoke-fetch-types-BXn-uSF5.d.ts} +27 -1
- package/items.d.ts +17 -17
- package/items.js +2 -2
- package/licenses.d.ts +19 -19
- package/licenses.js +2 -2
- package/package.json +3 -3
- package/qix.d.ts +2 -2
- package/qix.js +2 -2
- package/quotas.d.ts +5 -5
- package/quotas.js +2 -2
- package/reload-tasks.d.ts +11 -11
- package/reload-tasks.js +2 -2
- package/reloads.d.ts +9 -9
- package/reloads.js +2 -2
- package/reports.d.ts +13 -11
- package/reports.js +2 -2
- package/roles.d.ts +12 -12
- package/roles.js +2 -2
- package/spaces.d.ts +60 -26
- package/spaces.js +2 -2
- package/temp-contents.d.ts +7 -7
- package/temp-contents.js +2 -2
- package/tenants.d.ts +10 -10
- package/tenants.js +2 -2
- package/themes.d.ts +12 -12
- package/themes.js +2 -2
- package/transports.d.ts +18 -18
- package/transports.js +2 -2
- package/users.d.ts +20 -20
- package/users.js +2 -2
- package/web-integrations.d.ts +10 -10
- package/web-integrations.js +2 -2
- package/web-notifications.d.ts +13 -13
- package/web-notifications.js +2 -2
- package/webhooks.d.ts +21 -21
- package/webhooks.js +2 -2
package/quotas.js
CHANGED
package/reload-tasks.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { A as ApiCallOptions } from './invoke-fetch-types-
|
|
1
|
+
import { A as ApiCallOptions } from './invoke-fetch-types-BXn-uSF5.js';
|
|
2
2
|
import './auth-types-PkN9CAF_.js';
|
|
3
3
|
|
|
4
4
|
type Error = {
|
|
@@ -97,12 +97,12 @@ declare const getReloadTasks: (query: {
|
|
|
97
97
|
type GetReloadTasksHttpResponse = {
|
|
98
98
|
data: Tasks;
|
|
99
99
|
headers: Headers;
|
|
100
|
-
status:
|
|
100
|
+
status: 200;
|
|
101
101
|
};
|
|
102
102
|
type GetReloadTasksHttpError = {
|
|
103
103
|
data: Errors;
|
|
104
104
|
headers: Headers;
|
|
105
|
-
status:
|
|
105
|
+
status: 400 | 401 | 403 | 404 | 429 | 500 | 503;
|
|
106
106
|
};
|
|
107
107
|
/**
|
|
108
108
|
* Creates a task for a specified app.
|
|
@@ -114,12 +114,12 @@ declare const createReloadTask: (body: PostTaskBody, options?: ApiCallOptions) =
|
|
|
114
114
|
type CreateReloadTaskHttpResponse = {
|
|
115
115
|
data: Task;
|
|
116
116
|
headers: Headers;
|
|
117
|
-
status:
|
|
117
|
+
status: 201;
|
|
118
118
|
};
|
|
119
119
|
type CreateReloadTaskHttpError = {
|
|
120
120
|
data: Errors;
|
|
121
121
|
headers: Headers;
|
|
122
|
-
status:
|
|
122
|
+
status: 400 | 401 | 403 | 404 | 500 | 503;
|
|
123
123
|
};
|
|
124
124
|
/**
|
|
125
125
|
* Deletes a task
|
|
@@ -131,12 +131,12 @@ declare const deleteReloadTask: (taskId: string, options?: ApiCallOptions) => Pr
|
|
|
131
131
|
type DeleteReloadTaskHttpResponse = {
|
|
132
132
|
data: void;
|
|
133
133
|
headers: Headers;
|
|
134
|
-
status:
|
|
134
|
+
status: 204;
|
|
135
135
|
};
|
|
136
136
|
type DeleteReloadTaskHttpError = {
|
|
137
137
|
data: Errors;
|
|
138
138
|
headers: Headers;
|
|
139
|
-
status:
|
|
139
|
+
status: 400 | 401 | 403 | 404 | 500;
|
|
140
140
|
};
|
|
141
141
|
/**
|
|
142
142
|
* Finds and returns a task.
|
|
@@ -148,12 +148,12 @@ declare const getReloadTask: (taskId: string, options?: ApiCallOptions) => Promi
|
|
|
148
148
|
type GetReloadTaskHttpResponse = {
|
|
149
149
|
data: Task;
|
|
150
150
|
headers: Headers;
|
|
151
|
-
status:
|
|
151
|
+
status: 200;
|
|
152
152
|
};
|
|
153
153
|
type GetReloadTaskHttpError = {
|
|
154
154
|
data: Errors;
|
|
155
155
|
headers: Headers;
|
|
156
|
-
status:
|
|
156
|
+
status: 400 | 401 | 403 | 404 | 429 | 500 | 503;
|
|
157
157
|
};
|
|
158
158
|
/**
|
|
159
159
|
* Updates an existing task
|
|
@@ -166,12 +166,12 @@ declare const updateReloadTask: (taskId: string, body: PutTaskBody, options?: Ap
|
|
|
166
166
|
type UpdateReloadTaskHttpResponse = {
|
|
167
167
|
data: Task;
|
|
168
168
|
headers: Headers;
|
|
169
|
-
status:
|
|
169
|
+
status: 200;
|
|
170
170
|
};
|
|
171
171
|
type UpdateReloadTaskHttpError = {
|
|
172
172
|
data: Errors;
|
|
173
173
|
headers: Headers;
|
|
174
|
-
status:
|
|
174
|
+
status: 400 | 401 | 403 | 404 | 500 | 503;
|
|
175
175
|
};
|
|
176
176
|
/**
|
|
177
177
|
* Clears the cache for reload-tasks api requests.
|
package/reload-tasks.js
CHANGED
package/reloads.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { A as ApiCallOptions } from './invoke-fetch-types-
|
|
1
|
+
import { A as ApiCallOptions } from './invoke-fetch-types-BXn-uSF5.js';
|
|
2
2
|
import './auth-types-PkN9CAF_.js';
|
|
3
3
|
|
|
4
4
|
type Error = {
|
|
@@ -107,12 +107,12 @@ declare const getReloads: (query: {
|
|
|
107
107
|
type GetReloadsHttpResponse = {
|
|
108
108
|
data: Reloads;
|
|
109
109
|
headers: Headers;
|
|
110
|
-
status:
|
|
110
|
+
status: 200;
|
|
111
111
|
};
|
|
112
112
|
type GetReloadsHttpError = {
|
|
113
113
|
data: Errors;
|
|
114
114
|
headers: Headers;
|
|
115
|
-
status:
|
|
115
|
+
status: 400 | 401 | 403 | 500;
|
|
116
116
|
};
|
|
117
117
|
/**
|
|
118
118
|
* Reloads an app specified by an app ID.
|
|
@@ -124,12 +124,12 @@ declare const queueReload: (body: ReloadRequest, options?: ApiCallOptions) => Pr
|
|
|
124
124
|
type QueueReloadHttpResponse = {
|
|
125
125
|
data: Reload;
|
|
126
126
|
headers: Headers;
|
|
127
|
-
status:
|
|
127
|
+
status: 201;
|
|
128
128
|
};
|
|
129
129
|
type QueueReloadHttpError = {
|
|
130
130
|
data: Errors;
|
|
131
131
|
headers: Headers;
|
|
132
|
-
status:
|
|
132
|
+
status: 400 | 401 | 403 | 429 | 500;
|
|
133
133
|
};
|
|
134
134
|
/**
|
|
135
135
|
* Finds and returns a reload record.
|
|
@@ -141,12 +141,12 @@ declare const getReload: (reloadId: string, options?: ApiCallOptions) => Promise
|
|
|
141
141
|
type GetReloadHttpResponse = {
|
|
142
142
|
data: Reload;
|
|
143
143
|
headers: Headers;
|
|
144
|
-
status:
|
|
144
|
+
status: 200;
|
|
145
145
|
};
|
|
146
146
|
type GetReloadHttpError = {
|
|
147
147
|
data: Errors;
|
|
148
148
|
headers: Headers;
|
|
149
|
-
status:
|
|
149
|
+
status: 400 | 401 | 403 | 404 | 500;
|
|
150
150
|
};
|
|
151
151
|
/**
|
|
152
152
|
* Cancels a reload that is in progress or has been queued
|
|
@@ -158,12 +158,12 @@ declare const cancelReload: (reloadId: string, options?: ApiCallOptions) => Prom
|
|
|
158
158
|
type CancelReloadHttpResponse = {
|
|
159
159
|
data: void;
|
|
160
160
|
headers: Headers;
|
|
161
|
-
status:
|
|
161
|
+
status: 202 | 204;
|
|
162
162
|
};
|
|
163
163
|
type CancelReloadHttpError = {
|
|
164
164
|
data: Errors;
|
|
165
165
|
headers: Headers;
|
|
166
|
-
status:
|
|
166
|
+
status: 400 | 401 | 403 | 404 | 409 | 500;
|
|
167
167
|
};
|
|
168
168
|
/**
|
|
169
169
|
* Clears the cache for reloads api requests.
|
package/reloads.js
CHANGED
package/reports.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { A as ApiCallOptions } from './invoke-fetch-types-
|
|
1
|
+
import { A as ApiCallOptions } from './invoke-fetch-types-BXn-uSF5.js';
|
|
2
2
|
import './auth-types-PkN9CAF_.js';
|
|
3
3
|
|
|
4
4
|
/**
|
|
@@ -59,10 +59,10 @@ type Error = {
|
|
|
59
59
|
errors?: ExportErrors;
|
|
60
60
|
};
|
|
61
61
|
/**
|
|
62
|
-
* Output to be used to export
|
|
62
|
+
* Output to be used to export an excel template.
|
|
63
63
|
*/
|
|
64
64
|
type ExcelOutput = {
|
|
65
|
-
/** The
|
|
65
|
+
/** The output format of the report to be produced. */
|
|
66
66
|
outFormat?: "xlsx";
|
|
67
67
|
};
|
|
68
68
|
/**
|
|
@@ -207,7 +207,7 @@ type NxPatch = {
|
|
|
207
207
|
type OutputItem = {
|
|
208
208
|
/** The callback to be performed once the report is done. */
|
|
209
209
|
callBackAction?: CallBackAction;
|
|
210
|
-
/** Output to be used to export
|
|
210
|
+
/** Output to be used to export an excel template. */
|
|
211
211
|
excelOutput?: ExcelOutput;
|
|
212
212
|
/** Output to be used to export a single visualization as image. */
|
|
213
213
|
imageOutput?: ImageOutput;
|
|
@@ -239,7 +239,7 @@ type OutputItem = {
|
|
|
239
239
|
* - image requires imageOutput to be set
|
|
240
240
|
* - csv doesn't have csv output
|
|
241
241
|
* - xlsx requires xlsxOutput to be set */
|
|
242
|
-
type: "image" | "pdf" | "xlsx" | "jsondata" | "pdfcomposition" | "excel" | "pptx" | "pptxcomposition" | "csv" | "cycle";
|
|
242
|
+
type: "image" | "pdf" | "xlsx" | "jsondata" | "pdfcomposition" | "excel" | "pptx" | "pptxcomposition" | "csv" | "cycle" | "html";
|
|
243
243
|
};
|
|
244
244
|
/**
|
|
245
245
|
* Output to be used to export a composition of templates as pdf.
|
|
@@ -342,6 +342,8 @@ type ReportRequest = {
|
|
|
342
342
|
senseDataTemplate?: SenseDataTemplate;
|
|
343
343
|
/** Used to produce reports from a template file. */
|
|
344
344
|
senseExcelTemplate?: SenseFileTemplate;
|
|
345
|
+
/** Used to produce reports from a template file. */
|
|
346
|
+
senseHtmlTemplate?: SenseFileTemplate;
|
|
345
347
|
/** Used to export a single visualization as pdf, pptx or png. */
|
|
346
348
|
senseImageTemplate?: SenseImageTemplate;
|
|
347
349
|
/** Used to produce reports from a template file. */
|
|
@@ -349,7 +351,7 @@ type ReportRequest = {
|
|
|
349
351
|
/** Used to export a sheet as pdf or pptx. */
|
|
350
352
|
senseSheetTemplate?: SenseSheetTemplate;
|
|
351
353
|
/** Template type and version using semantic versioning. It must have the following name convention: dashed-separated-template-name-MAJOR.MINOR.
|
|
352
|
-
* Please note that sense-pixel-perfect-template-1.0, sense-story-x.0 and qv-data-x.0 are only for internal use.
|
|
354
|
+
* Please note that sense-pixel-perfect-template-1.0, sense-html-template-1.0, sense-story-x.0 and qv-data-x.0 are only for internal use.
|
|
353
355
|
*
|
|
354
356
|
* Each type requires a specific template to be provided:
|
|
355
357
|
* - composition-1.0 requires compositionTemplates to be set
|
|
@@ -364,7 +366,7 @@ type ReportRequest = {
|
|
|
364
366
|
* - sense-image-1.0 supports pdf, pptx and png output types
|
|
365
367
|
* - sense-sheet-1.0 supports pdf, pptx output type
|
|
366
368
|
* - sense-data-1.0 supports xlsx output type */
|
|
367
|
-
type: "composition-1.0" | "sense-image-1.0" | "sense-data-1.0" | "sense-sheet-1.0" | "sense-story-1.0" | "qv-data-1.0" | "qv-data-2.0" | "sense-excel-template-1.0" | "sense-pixel-perfect-template-1.0";
|
|
369
|
+
type: "composition-1.0" | "sense-image-1.0" | "sense-data-1.0" | "sense-sheet-1.0" | "sense-story-1.0" | "qv-data-1.0" | "qv-data-2.0" | "sense-excel-template-1.0" | "sense-pixel-perfect-template-1.0" | "sense-html-template-1.0";
|
|
368
370
|
};
|
|
369
371
|
type ReportStatus = {
|
|
370
372
|
/** @deprecated
|
|
@@ -556,12 +558,12 @@ declare const createReport: (body: ReportRequest, options?: ApiCallOptions) => P
|
|
|
556
558
|
type CreateReportHttpResponse = {
|
|
557
559
|
data: void;
|
|
558
560
|
headers: Headers;
|
|
559
|
-
status:
|
|
561
|
+
status: 202;
|
|
560
562
|
};
|
|
561
563
|
type CreateReportHttpError = {
|
|
562
564
|
data: Error;
|
|
563
565
|
headers: Headers;
|
|
564
|
-
status:
|
|
566
|
+
status: 400 | 401 | 403 | 404 | 409 | 429 | 500;
|
|
565
567
|
};
|
|
566
568
|
/**
|
|
567
569
|
* Get report request processing status.
|
|
@@ -573,12 +575,12 @@ declare const getReportStatus: (id: string, options?: ApiCallOptions) => Promise
|
|
|
573
575
|
type GetReportStatusHttpResponse = {
|
|
574
576
|
data: ReportStatus;
|
|
575
577
|
headers: Headers;
|
|
576
|
-
status:
|
|
578
|
+
status: 200;
|
|
577
579
|
};
|
|
578
580
|
type GetReportStatusHttpError = {
|
|
579
581
|
data: Error;
|
|
580
582
|
headers: Headers;
|
|
581
|
-
status:
|
|
583
|
+
status: 400 | 401 | 403 | 404 | 409 | 429 | 500;
|
|
582
584
|
};
|
|
583
585
|
/**
|
|
584
586
|
* Clears the cache for reports api requests.
|
package/reports.js
CHANGED
package/roles.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { A as ApiCallOptions } from './invoke-fetch-types-
|
|
1
|
+
import { A as ApiCallOptions } from './invoke-fetch-types-BXn-uSF5.js';
|
|
2
2
|
import './auth-types-PkN9CAF_.js';
|
|
3
3
|
|
|
4
4
|
type CreateRole = {
|
|
@@ -140,14 +140,14 @@ declare const getRoles: (query: {
|
|
|
140
140
|
type GetRolesHttpResponse = {
|
|
141
141
|
data: ListRolesResult;
|
|
142
142
|
headers: Headers;
|
|
143
|
-
status:
|
|
143
|
+
status: 200;
|
|
144
144
|
prev?: (options?: ApiCallOptions) => Promise<GetRolesHttpResponse>;
|
|
145
145
|
next?: (options?: ApiCallOptions) => Promise<GetRolesHttpResponse>;
|
|
146
146
|
};
|
|
147
147
|
type GetRolesHttpError = {
|
|
148
148
|
data: Errors;
|
|
149
149
|
headers: Headers;
|
|
150
|
-
status:
|
|
150
|
+
status: 400 | 401 | 429 | 500;
|
|
151
151
|
};
|
|
152
152
|
/**
|
|
153
153
|
* Creates a custom role. Role names must be unique, and there is a maximum of 500 custom roles per tenant. Requestor must be assigned the `TenantAdmin` role.
|
|
@@ -159,12 +159,12 @@ declare const createRole: (body: CreateRole, options?: ApiCallOptions) => Promis
|
|
|
159
159
|
type CreateRoleHttpResponse = {
|
|
160
160
|
data: Role;
|
|
161
161
|
headers: Headers;
|
|
162
|
-
status:
|
|
162
|
+
status: 201;
|
|
163
163
|
};
|
|
164
164
|
type CreateRoleHttpError = {
|
|
165
165
|
data: Errors;
|
|
166
166
|
headers: Headers;
|
|
167
|
-
status:
|
|
167
|
+
status: 400 | 401 | 403 | 429 | 500;
|
|
168
168
|
};
|
|
169
169
|
/**
|
|
170
170
|
* Deletes the requested role. Role can only be deleted if it has been unassigned from all users and groups. Only applicable to roles of type `custom`. Requestor must be assigned the `TenantAdmin` role.
|
|
@@ -176,12 +176,12 @@ declare const deleteRole: (id: string, options?: ApiCallOptions) => Promise<Dele
|
|
|
176
176
|
type DeleteRoleHttpResponse = {
|
|
177
177
|
data: void;
|
|
178
178
|
headers: Headers;
|
|
179
|
-
status:
|
|
179
|
+
status: 204;
|
|
180
180
|
};
|
|
181
181
|
type DeleteRoleHttpError = {
|
|
182
182
|
data: Errors;
|
|
183
183
|
headers: Headers;
|
|
184
|
-
status:
|
|
184
|
+
status: 400 | 401 | 403 | 429 | 500;
|
|
185
185
|
};
|
|
186
186
|
/**
|
|
187
187
|
* Returns the requested role.
|
|
@@ -193,12 +193,12 @@ declare const getRole: (id: string, options?: ApiCallOptions) => Promise<GetRole
|
|
|
193
193
|
type GetRoleHttpResponse = {
|
|
194
194
|
data: Role;
|
|
195
195
|
headers: Headers;
|
|
196
|
-
status:
|
|
196
|
+
status: 200;
|
|
197
197
|
};
|
|
198
198
|
type GetRoleHttpError = {
|
|
199
199
|
data: Errors;
|
|
200
200
|
headers: Headers;
|
|
201
|
-
status:
|
|
201
|
+
status: 404 | 429 | 500;
|
|
202
202
|
};
|
|
203
203
|
/**
|
|
204
204
|
* Updates the requested role. Only applicable to roles of type `custom`. Requestor must be assigned the `TenantAdmin` role.
|
|
@@ -207,16 +207,16 @@ type GetRoleHttpError = {
|
|
|
207
207
|
* @param body an object with the body content
|
|
208
208
|
* @throws PatchRoleHttpError
|
|
209
209
|
*/
|
|
210
|
-
declare const patchRole: (id: string, body: PatchRoles
|
|
210
|
+
declare const patchRole: (id: string, body: PatchRoles, options?: ApiCallOptions) => Promise<PatchRoleHttpResponse>;
|
|
211
211
|
type PatchRoleHttpResponse = {
|
|
212
212
|
data: void;
|
|
213
213
|
headers: Headers;
|
|
214
|
-
status:
|
|
214
|
+
status: 204;
|
|
215
215
|
};
|
|
216
216
|
type PatchRoleHttpError = {
|
|
217
217
|
data: Errors;
|
|
218
218
|
headers: Headers;
|
|
219
|
-
status:
|
|
219
|
+
status: 400 | 401 | 403 | 404 | 429 | 500;
|
|
220
220
|
};
|
|
221
221
|
/**
|
|
222
222
|
* Clears the cache for roles api requests.
|
package/roles.js
CHANGED
package/spaces.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { A as ApiCallOptions } from './invoke-fetch-types-
|
|
1
|
+
import { A as ApiCallOptions } from './invoke-fetch-types-BXn-uSF5.js';
|
|
2
2
|
import './auth-types-PkN9CAF_.js';
|
|
3
3
|
|
|
4
4
|
/**
|
|
@@ -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