@qlik/api 1.26.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 +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/{VX3MQBE7.js → 4K3CNR7C.js} +1 -1
- package/chunks/{7SNOQCIQ.js → 55SZVSAG.js} +1 -1
- package/chunks/{HGRF5TX3.js → EOGHK2R4.js} +1 -1
- package/chunks/{UV5COPU3.js → V3TZ54UE.js} +3 -3
- package/chunks/{AMO5NATA.js → WY7IOA3Q.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 +48 -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 +1 -1
- 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 +8 -8
- 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/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
package/users.d.ts
CHANGED
|
@@ -127,8 +127,8 @@ type InviteRequestData = {
|
|
|
127
127
|
* A JSON Patch document as defined in http://tools.ietf.org/html/rfc6902.
|
|
128
128
|
*/
|
|
129
129
|
type JSONPatch = {
|
|
130
|
-
/** The operation to be performed. The fields `set
|
|
131
|
-
op: "replace" | "set" | "unset" | "add" | "renew";
|
|
130
|
+
/** The operation to be performed. The fields `set` and `unset` are deprecated. */
|
|
131
|
+
op: "replace" | "set" | "unset" | "add" | "renew" | "remove-value";
|
|
132
132
|
/** A JSON Pointer. The field `roles` is deprecated. */
|
|
133
133
|
path: "/name" | "/roles" | "/assignedRoles" | "/inviteExpiry" | "/preferredZoneinfo" | "/preferredLocale" | "/status" | "/assignedGroups";
|
|
134
134
|
/** The value to be used for this operation. */
|
|
@@ -351,14 +351,14 @@ declare const getUsers: (query: {
|
|
|
351
351
|
type GetUsersHttpResponse = {
|
|
352
352
|
data: Users;
|
|
353
353
|
headers: Headers;
|
|
354
|
-
status:
|
|
354
|
+
status: 200;
|
|
355
355
|
prev?: (options?: ApiCallOptions) => Promise<GetUsersHttpResponse>;
|
|
356
356
|
next?: (options?: ApiCallOptions) => Promise<GetUsersHttpResponse>;
|
|
357
357
|
};
|
|
358
358
|
type GetUsersHttpError = {
|
|
359
359
|
data: Errors;
|
|
360
360
|
headers: Headers;
|
|
361
|
-
status:
|
|
361
|
+
status: 400 | 401 | 429 | 500;
|
|
362
362
|
};
|
|
363
363
|
/**
|
|
364
364
|
* Creates an invited user.
|
|
@@ -370,12 +370,12 @@ declare const createUser: (body: UserPostSchema, options?: ApiCallOptions) => Pr
|
|
|
370
370
|
type CreateUserHttpResponse = {
|
|
371
371
|
data: User;
|
|
372
372
|
headers: Headers;
|
|
373
|
-
status:
|
|
373
|
+
status: 201;
|
|
374
374
|
};
|
|
375
375
|
type CreateUserHttpError = {
|
|
376
376
|
data: Errors;
|
|
377
377
|
headers: Headers;
|
|
378
|
-
status:
|
|
378
|
+
status: 400 | 401 | 403 | 409 | 413 | 429 | 500;
|
|
379
379
|
};
|
|
380
380
|
/**
|
|
381
381
|
* Returns the number of users in a given tenant
|
|
@@ -391,12 +391,12 @@ declare const countUsers: (query: {
|
|
|
391
391
|
type CountUsersHttpResponse = {
|
|
392
392
|
data: UserCount;
|
|
393
393
|
headers: Headers;
|
|
394
|
-
status:
|
|
394
|
+
status: 200;
|
|
395
395
|
};
|
|
396
396
|
type CountUsersHttpError = {
|
|
397
397
|
data: Errors;
|
|
398
398
|
headers: Headers;
|
|
399
|
-
status:
|
|
399
|
+
status: 403 | 404 | 429;
|
|
400
400
|
};
|
|
401
401
|
/**
|
|
402
402
|
* Retrieves a list of users matching the filter using an advanced query string.
|
|
@@ -420,14 +420,14 @@ declare const filterUsers: (query: {
|
|
|
420
420
|
type FilterUsersHttpResponse = {
|
|
421
421
|
data: Users;
|
|
422
422
|
headers: Headers;
|
|
423
|
-
status:
|
|
423
|
+
status: 200;
|
|
424
424
|
prev?: (options?: ApiCallOptions) => Promise<FilterUsersHttpResponse>;
|
|
425
425
|
next?: (options?: ApiCallOptions) => Promise<FilterUsersHttpResponse>;
|
|
426
426
|
};
|
|
427
427
|
type FilterUsersHttpError = {
|
|
428
428
|
data: Errors;
|
|
429
429
|
headers: Headers;
|
|
430
|
-
status:
|
|
430
|
+
status: 400 | 401 | 403 | 429 | 500;
|
|
431
431
|
};
|
|
432
432
|
/**
|
|
433
433
|
* Invite one or more users by email address.
|
|
@@ -439,7 +439,7 @@ declare const inviteUsers: (body: InviteRequestData, options?: ApiCallOptions) =
|
|
|
439
439
|
type InviteUsersHttpResponse = {
|
|
440
440
|
data: InviteDataResponse;
|
|
441
441
|
headers: Headers;
|
|
442
|
-
status:
|
|
442
|
+
status: 207;
|
|
443
443
|
};
|
|
444
444
|
type InviteUsersHttpError = {
|
|
445
445
|
data: ErrorsResponse;
|
|
@@ -455,12 +455,12 @@ declare const getMyUser: (options?: ApiCallOptions) => Promise<GetMyUserHttpResp
|
|
|
455
455
|
type GetMyUserHttpResponse = {
|
|
456
456
|
data: User;
|
|
457
457
|
headers: Headers;
|
|
458
|
-
status:
|
|
458
|
+
status: 200;
|
|
459
459
|
};
|
|
460
460
|
type GetMyUserHttpError = {
|
|
461
461
|
data: Errors;
|
|
462
462
|
headers: Headers;
|
|
463
|
-
status:
|
|
463
|
+
status: 429;
|
|
464
464
|
};
|
|
465
465
|
/**
|
|
466
466
|
* Deletes the requested user.
|
|
@@ -472,12 +472,12 @@ declare const deleteUser: (userId: string, options?: ApiCallOptions) => Promise<
|
|
|
472
472
|
type DeleteUserHttpResponse = {
|
|
473
473
|
data: void;
|
|
474
474
|
headers: Headers;
|
|
475
|
-
status:
|
|
475
|
+
status: 204;
|
|
476
476
|
};
|
|
477
477
|
type DeleteUserHttpError = {
|
|
478
478
|
data: Errors;
|
|
479
479
|
headers: Headers;
|
|
480
|
-
status:
|
|
480
|
+
status: 400 | 403 | 404 | 429;
|
|
481
481
|
};
|
|
482
482
|
/**
|
|
483
483
|
* Returns the requested user.
|
|
@@ -493,12 +493,12 @@ declare const getUser: (userId: string, query: {
|
|
|
493
493
|
type GetUserHttpResponse = {
|
|
494
494
|
data: User & unknown;
|
|
495
495
|
headers: Headers;
|
|
496
|
-
status:
|
|
496
|
+
status: 200;
|
|
497
497
|
};
|
|
498
498
|
type GetUserHttpError = {
|
|
499
499
|
data: Errors;
|
|
500
500
|
headers: Headers;
|
|
501
|
-
status:
|
|
501
|
+
status: 403 | 404 | 429 | 500;
|
|
502
502
|
};
|
|
503
503
|
/**
|
|
504
504
|
* Updates fields for a user resource
|
|
@@ -508,6 +508,7 @@ type GetUserHttpError = {
|
|
|
508
508
|
* @throws PatchUserHttpError
|
|
509
509
|
*/
|
|
510
510
|
declare const patchUser: (userId: string, body: JSONPatchArray, options?: ApiCallOptions) => Promise<PatchUserHttpResponse>;
|
|
511
|
+
type PatchUserHttpResponse = PatchUser204HttpResponse | PatchUser207HttpResponse;
|
|
511
512
|
type PatchUser204HttpResponse = {
|
|
512
513
|
data: void;
|
|
513
514
|
headers: Headers;
|
|
@@ -518,11 +519,10 @@ type PatchUser207HttpResponse = {
|
|
|
518
519
|
headers: Headers;
|
|
519
520
|
status: 207;
|
|
520
521
|
};
|
|
521
|
-
type PatchUserHttpResponse = PatchUser204HttpResponse | PatchUser207HttpResponse;
|
|
522
522
|
type PatchUserHttpError = {
|
|
523
523
|
data: Errors;
|
|
524
524
|
headers: Headers;
|
|
525
|
-
status:
|
|
525
|
+
status: 400 | 403 | 404 | 429;
|
|
526
526
|
};
|
|
527
527
|
/**
|
|
528
528
|
* Clears the cache for users api requests.
|
package/users.js
CHANGED
package/web-integrations.d.ts
CHANGED
|
@@ -142,7 +142,7 @@ declare const getWebIntegrations: (query: {
|
|
|
142
142
|
type GetWebIntegrationsHttpResponse = {
|
|
143
143
|
data: WebIntegrations;
|
|
144
144
|
headers: Headers;
|
|
145
|
-
status:
|
|
145
|
+
status: 200;
|
|
146
146
|
prev?: (options?: ApiCallOptions) => Promise<GetWebIntegrationsHttpResponse>;
|
|
147
147
|
next?: (options?: ApiCallOptions) => Promise<GetWebIntegrationsHttpResponse>;
|
|
148
148
|
};
|
|
@@ -161,12 +161,12 @@ declare const createWebIntegration: (body: WebIntegrationPostSchema, options?: A
|
|
|
161
161
|
type CreateWebIntegrationHttpResponse = {
|
|
162
162
|
data: WebIntegrationPost;
|
|
163
163
|
headers: Headers;
|
|
164
|
-
status:
|
|
164
|
+
status: 201;
|
|
165
165
|
};
|
|
166
166
|
type CreateWebIntegrationHttpError = {
|
|
167
167
|
data: Errors;
|
|
168
168
|
headers: Headers;
|
|
169
|
-
status:
|
|
169
|
+
status: 400 | 403;
|
|
170
170
|
};
|
|
171
171
|
/**
|
|
172
172
|
* Deletes a single web integration by ID.
|
|
@@ -178,12 +178,12 @@ declare const deleteWebIntegration: (id: string, options?: ApiCallOptions) => Pr
|
|
|
178
178
|
type DeleteWebIntegrationHttpResponse = {
|
|
179
179
|
data: void;
|
|
180
180
|
headers: Headers;
|
|
181
|
-
status:
|
|
181
|
+
status: 204;
|
|
182
182
|
};
|
|
183
183
|
type DeleteWebIntegrationHttpError = {
|
|
184
184
|
data: Errors;
|
|
185
185
|
headers: Headers;
|
|
186
|
-
status:
|
|
186
|
+
status: 404;
|
|
187
187
|
};
|
|
188
188
|
/**
|
|
189
189
|
* Retrieves a single web integration by ID.
|
|
@@ -195,12 +195,12 @@ declare const getWebIntegration: (id: string, options?: ApiCallOptions) => Promi
|
|
|
195
195
|
type GetWebIntegrationHttpResponse = {
|
|
196
196
|
data: WebIntegration;
|
|
197
197
|
headers: Headers;
|
|
198
|
-
status:
|
|
198
|
+
status: 200;
|
|
199
199
|
};
|
|
200
200
|
type GetWebIntegrationHttpError = {
|
|
201
201
|
data: Errors;
|
|
202
202
|
headers: Headers;
|
|
203
|
-
status:
|
|
203
|
+
status: 404;
|
|
204
204
|
};
|
|
205
205
|
/**
|
|
206
206
|
* Updates a single web integration by ID.
|
|
@@ -213,12 +213,12 @@ declare const patchWebIntegration: (id: string, body: WebIntegrationPatchSchema,
|
|
|
213
213
|
type PatchWebIntegrationHttpResponse = {
|
|
214
214
|
data: void;
|
|
215
215
|
headers: Headers;
|
|
216
|
-
status:
|
|
216
|
+
status: 204;
|
|
217
217
|
};
|
|
218
218
|
type PatchWebIntegrationHttpError = {
|
|
219
219
|
data: Errors;
|
|
220
220
|
headers: Headers;
|
|
221
|
-
status:
|
|
221
|
+
status: 400 | 404;
|
|
222
222
|
};
|
|
223
223
|
/**
|
|
224
224
|
* Clears the cache for web-integrations api requests.
|
package/web-integrations.js
CHANGED
package/web-notifications.d.ts
CHANGED
|
@@ -100,14 +100,14 @@ declare const getNotifications: (query: {
|
|
|
100
100
|
type GetNotificationsHttpResponse = {
|
|
101
101
|
data: Notifications;
|
|
102
102
|
headers: Headers;
|
|
103
|
-
status:
|
|
103
|
+
status: 200;
|
|
104
104
|
prev?: (options?: ApiCallOptions) => Promise<GetNotificationsHttpResponse>;
|
|
105
105
|
next?: (options?: ApiCallOptions) => Promise<GetNotificationsHttpResponse>;
|
|
106
106
|
};
|
|
107
107
|
type GetNotificationsHttpError = {
|
|
108
108
|
data: Errors;
|
|
109
109
|
headers: Headers;
|
|
110
|
-
status:
|
|
110
|
+
status: 400 | 401 | 500;
|
|
111
111
|
};
|
|
112
112
|
/**
|
|
113
113
|
* Delete all notifications.
|
|
@@ -118,12 +118,12 @@ declare const deleteNotifications: (options?: ApiCallOptions) => Promise<DeleteN
|
|
|
118
118
|
type DeleteNotificationsHttpResponse = {
|
|
119
119
|
data: Meta;
|
|
120
120
|
headers: Headers;
|
|
121
|
-
status:
|
|
121
|
+
status: 204;
|
|
122
122
|
};
|
|
123
123
|
type DeleteNotificationsHttpError = {
|
|
124
124
|
data: Errors;
|
|
125
125
|
headers: Headers;
|
|
126
|
-
status:
|
|
126
|
+
status: 401 | 500;
|
|
127
127
|
};
|
|
128
128
|
/**
|
|
129
129
|
* Patch all notifications.
|
|
@@ -135,12 +135,12 @@ declare const patchNotifications: (body: NotificationPatchSchema, options?: ApiC
|
|
|
135
135
|
type PatchNotificationsHttpResponse = {
|
|
136
136
|
data: Meta;
|
|
137
137
|
headers: Headers;
|
|
138
|
-
status:
|
|
138
|
+
status: 204;
|
|
139
139
|
};
|
|
140
140
|
type PatchNotificationsHttpError = {
|
|
141
141
|
data: Errors;
|
|
142
142
|
headers: Headers;
|
|
143
|
-
status:
|
|
143
|
+
status: 400 | 401 | 500;
|
|
144
144
|
};
|
|
145
145
|
/**
|
|
146
146
|
* Delete a notification.
|
|
@@ -152,12 +152,12 @@ declare const deleteNotification: (notificationId: string, options?: ApiCallOpti
|
|
|
152
152
|
type DeleteNotificationHttpResponse = {
|
|
153
153
|
data: Meta;
|
|
154
154
|
headers: Headers;
|
|
155
|
-
status:
|
|
155
|
+
status: 204;
|
|
156
156
|
};
|
|
157
157
|
type DeleteNotificationHttpError = {
|
|
158
158
|
data: Errors;
|
|
159
159
|
headers: Headers;
|
|
160
|
-
status:
|
|
160
|
+
status: 401 | 404 | 500;
|
|
161
161
|
};
|
|
162
162
|
/**
|
|
163
163
|
* Retrieve a single notification by Id.
|
|
@@ -169,12 +169,12 @@ declare const getNotification: (notificationId: string, options?: ApiCallOptions
|
|
|
169
169
|
type GetNotificationHttpResponse = {
|
|
170
170
|
data: Notification;
|
|
171
171
|
headers: Headers;
|
|
172
|
-
status:
|
|
172
|
+
status: 200;
|
|
173
173
|
};
|
|
174
174
|
type GetNotificationHttpError = {
|
|
175
175
|
data: Errors;
|
|
176
176
|
headers: Headers;
|
|
177
|
-
status:
|
|
177
|
+
status: 401 | 404 | 500;
|
|
178
178
|
};
|
|
179
179
|
/**
|
|
180
180
|
* Patch a notification.
|
|
@@ -187,12 +187,12 @@ declare const patchNotification: (notificationId: string, body: NotificationPatc
|
|
|
187
187
|
type PatchNotificationHttpResponse = {
|
|
188
188
|
data: Meta;
|
|
189
189
|
headers: Headers;
|
|
190
|
-
status:
|
|
190
|
+
status: 204;
|
|
191
191
|
};
|
|
192
192
|
type PatchNotificationHttpError = {
|
|
193
193
|
data: Errors;
|
|
194
194
|
headers: Headers;
|
|
195
|
-
status:
|
|
195
|
+
status: 400 | 401 | 404 | 500;
|
|
196
196
|
};
|
|
197
197
|
/**
|
|
198
198
|
* Clears the cache for web-notifications api requests.
|
package/web-notifications.js
CHANGED