@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/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
package/webhooks.d.ts
CHANGED
|
@@ -176,14 +176,14 @@ declare const getWebhooks: (query: {
|
|
|
176
176
|
type GetWebhooksHttpResponse = {
|
|
177
177
|
data: WebhookList;
|
|
178
178
|
headers: Headers;
|
|
179
|
-
status:
|
|
179
|
+
status: 200;
|
|
180
180
|
prev?: (options?: ApiCallOptions) => Promise<GetWebhooksHttpResponse>;
|
|
181
181
|
next?: (options?: ApiCallOptions) => Promise<GetWebhooksHttpResponse>;
|
|
182
182
|
};
|
|
183
183
|
type GetWebhooksHttpError = {
|
|
184
184
|
data: ErrorResponse;
|
|
185
185
|
headers: Headers;
|
|
186
|
-
status:
|
|
186
|
+
status: 400 | 401 | 403 | 500 | 503;
|
|
187
187
|
};
|
|
188
188
|
/**
|
|
189
189
|
* Creates a new webhook. User must be assigned the `TenantAdmin` role to create `tenant` level webhooks.
|
|
@@ -195,12 +195,12 @@ declare const createWebhook: (body: WebhookPost, options?: ApiCallOptions) => Pr
|
|
|
195
195
|
type CreateWebhookHttpResponse = {
|
|
196
196
|
data: WebhookResponse;
|
|
197
197
|
headers: Headers;
|
|
198
|
-
status:
|
|
198
|
+
status: 201;
|
|
199
199
|
};
|
|
200
200
|
type CreateWebhookHttpError = {
|
|
201
201
|
data: ErrorResponse;
|
|
202
202
|
headers: Headers;
|
|
203
|
-
status:
|
|
203
|
+
status: 400 | 401 | 403 | 500 | 503;
|
|
204
204
|
};
|
|
205
205
|
/**
|
|
206
206
|
* Lists event-types that are possible to subscribe to.
|
|
@@ -211,12 +211,12 @@ declare const getWebhookEventTypes: (options?: ApiCallOptions) => Promise<GetWeb
|
|
|
211
211
|
type GetWebhookEventTypesHttpResponse = {
|
|
212
212
|
data: EventTypes;
|
|
213
213
|
headers: Headers;
|
|
214
|
-
status:
|
|
214
|
+
status: 200;
|
|
215
215
|
};
|
|
216
216
|
type GetWebhookEventTypesHttpError = {
|
|
217
217
|
data: ErrorResponse;
|
|
218
218
|
headers: Headers;
|
|
219
|
-
status:
|
|
219
|
+
status: 401 | 500 | 503;
|
|
220
220
|
};
|
|
221
221
|
/**
|
|
222
222
|
* Deletes a specific webhook.
|
|
@@ -228,12 +228,12 @@ declare const deleteWebhook: (id: string, options?: ApiCallOptions) => Promise<D
|
|
|
228
228
|
type DeleteWebhookHttpResponse = {
|
|
229
229
|
data: void;
|
|
230
230
|
headers: Headers;
|
|
231
|
-
status:
|
|
231
|
+
status: 204;
|
|
232
232
|
};
|
|
233
233
|
type DeleteWebhookHttpError = {
|
|
234
234
|
data: ErrorResponse;
|
|
235
235
|
headers: Headers;
|
|
236
|
-
status:
|
|
236
|
+
status: 400 | 401 | 403 | 404 | 500 | 503;
|
|
237
237
|
};
|
|
238
238
|
/**
|
|
239
239
|
* Returns details for a specific webhook.
|
|
@@ -245,12 +245,12 @@ declare const getWebhook: (id: string, options?: ApiCallOptions) => Promise<GetW
|
|
|
245
245
|
type GetWebhookHttpResponse = {
|
|
246
246
|
data: WebhookResponse;
|
|
247
247
|
headers: Headers;
|
|
248
|
-
status:
|
|
248
|
+
status: 200;
|
|
249
249
|
};
|
|
250
250
|
type GetWebhookHttpError = {
|
|
251
251
|
data: ErrorResponse;
|
|
252
252
|
headers: Headers;
|
|
253
|
-
status:
|
|
253
|
+
status: 400 | 401 | 403 | 404 | 500 | 503;
|
|
254
254
|
};
|
|
255
255
|
/**
|
|
256
256
|
* Patches a webhook to update one or more properties.
|
|
@@ -263,12 +263,12 @@ declare const patchWebhook: (id: string, body: WebhookPatch[], options?: ApiCall
|
|
|
263
263
|
type PatchWebhookHttpResponse = {
|
|
264
264
|
data: void;
|
|
265
265
|
headers: Headers;
|
|
266
|
-
status:
|
|
266
|
+
status: 204;
|
|
267
267
|
};
|
|
268
268
|
type PatchWebhookHttpError = {
|
|
269
269
|
data: ErrorResponse;
|
|
270
270
|
headers: Headers;
|
|
271
|
-
status:
|
|
271
|
+
status: 400 | 401 | 403 | 404 | 500 | 503;
|
|
272
272
|
};
|
|
273
273
|
/**
|
|
274
274
|
* Updates a webhook, any omitted fields will be cleared, returns updated webhook.
|
|
@@ -281,12 +281,12 @@ declare const updateWebhook: (id: string, body: WebhookBase, options?: ApiCallOp
|
|
|
281
281
|
type UpdateWebhookHttpResponse = {
|
|
282
282
|
data: WebhookResponse;
|
|
283
283
|
headers: Headers;
|
|
284
|
-
status:
|
|
284
|
+
status: 200;
|
|
285
285
|
};
|
|
286
286
|
type UpdateWebhookHttpError = {
|
|
287
287
|
data: ErrorResponse;
|
|
288
288
|
headers: Headers;
|
|
289
|
-
status:
|
|
289
|
+
status: 400 | 401 | 403 | 404 | 500 | 503;
|
|
290
290
|
};
|
|
291
291
|
/**
|
|
292
292
|
* Returns deliveries for a specific webhook. Delivery history is stored for 1 week.
|
|
@@ -312,14 +312,14 @@ declare const getWebhookDeliveries: (id: string, query: {
|
|
|
312
312
|
type GetWebhookDeliveriesHttpResponse = {
|
|
313
313
|
data: DeliveryList;
|
|
314
314
|
headers: Headers;
|
|
315
|
-
status:
|
|
315
|
+
status: 200;
|
|
316
316
|
prev?: (options?: ApiCallOptions) => Promise<GetWebhookDeliveriesHttpResponse>;
|
|
317
317
|
next?: (options?: ApiCallOptions) => Promise<GetWebhookDeliveriesHttpResponse>;
|
|
318
318
|
};
|
|
319
319
|
type GetWebhookDeliveriesHttpError = {
|
|
320
320
|
data: ErrorResponse;
|
|
321
321
|
headers: Headers;
|
|
322
|
-
status:
|
|
322
|
+
status: 400 | 401 | 403 | 404 | 500 | 503;
|
|
323
323
|
};
|
|
324
324
|
/**
|
|
325
325
|
* Returns details for a specific delivery.
|
|
@@ -332,12 +332,12 @@ declare const getWebhookDelivery: (id: string, deliveryId: string, options?: Api
|
|
|
332
332
|
type GetWebhookDeliveryHttpResponse = {
|
|
333
333
|
data: Delivery;
|
|
334
334
|
headers: Headers;
|
|
335
|
-
status:
|
|
335
|
+
status: 200;
|
|
336
336
|
};
|
|
337
337
|
type GetWebhookDeliveryHttpError = {
|
|
338
338
|
data: ErrorResponse;
|
|
339
339
|
headers: Headers;
|
|
340
|
-
status:
|
|
340
|
+
status: 400 | 401 | 403 | 404 | 500 | 503;
|
|
341
341
|
};
|
|
342
342
|
/**
|
|
343
343
|
* Resends the delivery with the same payload.
|
|
@@ -350,12 +350,12 @@ declare const resendWebhookDelivery: (id: string, deliveryId: string, options?:
|
|
|
350
350
|
type ResendWebhookDeliveryHttpResponse = {
|
|
351
351
|
data: Delivery;
|
|
352
352
|
headers: Headers;
|
|
353
|
-
status:
|
|
353
|
+
status: 201;
|
|
354
354
|
};
|
|
355
355
|
type ResendWebhookDeliveryHttpError = {
|
|
356
356
|
data: ErrorResponse;
|
|
357
357
|
headers: Headers;
|
|
358
|
-
status:
|
|
358
|
+
status: 401 | 404 | 500 | 503;
|
|
359
359
|
};
|
|
360
360
|
/**
|
|
361
361
|
* Clears the cache for webhooks api requests.
|
package/webhooks.js
CHANGED