Skip to content

Commit d49928b

Browse files
authored
docs(tem): add missing webhook service documentation (#1374)
1 parent 930cd2c commit d49928b

File tree

1 file changed

+30
-1
lines changed

1 file changed

+30
-1
lines changed

packages/clients/src/api/tem/v1alpha1/api.gen.ts

Lines changed: 30 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -397,11 +397,19 @@ export class API extends ParentAPI {
397397
unmarshalListWebhooksResponse,
398398
)
399399

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+
*/
400407
listWebhooks = (request: Readonly<ListWebhooksRequest> = {}) =>
401408
enrichForPagination('webhooks', this.pageOfListWebhooks, request)
402409

403410
/**
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.
405413
*
406414
* @param request - The request {@link GetWebhookRequest}
407415
* @returns A Promise of Webhook
@@ -415,6 +423,12 @@ export class API extends ParentAPI {
415423
unmarshalWebhook,
416424
)
417425

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+
*/
418432
updateWebhook = (request: Readonly<UpdateWebhookRequest>) =>
419433
this.client.fetch<Webhook>(
420434
{
@@ -428,6 +442,13 @@ export class API extends ParentAPI {
428442
unmarshalWebhook,
429443
)
430444

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+
*/
431452
deleteWebhook = (request: Readonly<DeleteWebhookRequest>) =>
432453
this.client.fetch<void>({
433454
method: 'DELETE',
@@ -459,6 +480,14 @@ export class API extends ParentAPI {
459480
unmarshalListWebhookEventsResponse,
460481
)
461482

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+
*/
462491
listWebhookEvents = (request: Readonly<ListWebhookEventsRequest>) =>
463492
enrichForPagination('webhookEvents', this.pageOfListWebhookEvents, request)
464493
}

0 commit comments

Comments
 (0)