@@ -397,11 +397,19 @@ export class API extends ParentAPI {
397
397
unmarshalListWebhooksResponse ,
398
398
)
399
399
400
+ /**
401
+ * List Webhooks. Retrieve Webhooks in a specific Project or in a specific
402
+ * Organization using the `region` parameter.
403
+ *
404
+ * @param request - The request {@link ListWebhooksRequest}
405
+ * @returns A Promise of ListWebhooksResponse
406
+ */
400
407
listWebhooks = ( request : Readonly < ListWebhooksRequest > = { } ) =>
401
408
enrichForPagination ( 'webhooks' , this . pageOfListWebhooks , request )
402
409
403
410
/**
404
- * Get information about a Webhook.
411
+ * Get information about a Webhook. Retrieve information about a specific
412
+ * Webhook using the `webhook_id` and `region` parameters.
405
413
*
406
414
* @param request - The request {@link GetWebhookRequest}
407
415
* @returns A Promise of Webhook
@@ -415,6 +423,12 @@ export class API extends ParentAPI {
415
423
unmarshalWebhook ,
416
424
)
417
425
426
+ /**
427
+ * Update a Webhook. Update a Webhook events type, SNS ARN or name.
428
+ *
429
+ * @param request - The request {@link UpdateWebhookRequest}
430
+ * @returns A Promise of Webhook
431
+ */
418
432
updateWebhook = ( request : Readonly < UpdateWebhookRequest > ) =>
419
433
this . client . fetch < Webhook > (
420
434
{
@@ -428,6 +442,13 @@ export class API extends ParentAPI {
428
442
unmarshalWebhook ,
429
443
)
430
444
445
+ /**
446
+ * Delete a Webhook. You must specify the Webhook you want to delete by the
447
+ * `region` and `webhook_id`. Deleting a Webhook is permanent and cannot be
448
+ * undone.
449
+ *
450
+ * @param request - The request {@link DeleteWebhookRequest}
451
+ */
431
452
deleteWebhook = ( request : Readonly < DeleteWebhookRequest > ) =>
432
453
this . client . fetch < void > ( {
433
454
method : 'DELETE' ,
@@ -459,6 +480,14 @@ export class API extends ParentAPI {
459
480
unmarshalListWebhookEventsResponse ,
460
481
)
461
482
483
+ /**
484
+ * List Webhook triggered events. Retrieve the list of Webhook events
485
+ * triggered from a specific Webhook or for a specific Project or
486
+ * Organization. You must specify the `region`.
487
+ *
488
+ * @param request - The request {@link ListWebhookEventsRequest}
489
+ * @returns A Promise of ListWebhookEventsResponse
490
+ */
462
491
listWebhookEvents = ( request : Readonly < ListWebhookEventsRequest > ) =>
463
492
enrichForPagination ( 'webhookEvents' , this . pageOfListWebhookEvents , request )
464
493
}
0 commit comments