docs(tem): add info about webhooks (#1373)

Author: scaleway-bot

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

@@ -15,6 +15,7 @@ import {
 import {
   marshalCreateDomainRequest,
   marshalCreateEmailRequest,
+  marshalCreateWebhookRequest,
   marshalUpdateWebhookRequest,
   unmarshalCreateEmailResponse,
   unmarshalDomain,
@@ -33,6 +34,7 @@ import type {
   CreateDomainRequest,
   CreateEmailRequest,
   CreateEmailResponse,
+  CreateWebhookRequest,
   DeleteWebhookRequest,
   Domain,
   DomainLastStatus,
@@ -41,6 +43,7 @@ import type {
   GetDomainRequest,
   GetEmailRequest,
   GetStatisticsRequest,
+  GetWebhookRequest,
   ListDomainsRequest,
   ListDomainsResponse,
   ListEmailsRequest,
@@ -352,6 +355,26 @@ export class API extends ParentAPI {
       unmarshalDomainLastStatus,
     )
 
+  /**
+   * Create a Webhook. Create a new Webhook triggered by a list of event types
+   * and pushed to a Scaleway SNS ARN.
+   *
+   * @param request - The request {@link CreateWebhookRequest}
+   * @returns A Promise of Webhook
+   */
+  createWebhook = (request: Readonly<CreateWebhookRequest>) =>
+    this.client.fetch<Webhook>(
+      {
+        body: JSON.stringify(
+          marshalCreateWebhookRequest(request, this.client.settings),
+        ),
+        headers: jsonContentHeaders,
+        method: 'POST',
+        path: `/transactional-email/v1alpha1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/webhooks`,
+      },
+      unmarshalWebhook,
+    )
+
   protected pageOfListWebhooks = (
     request: Readonly<ListWebhooksRequest> = {},
   ) =>
@@ -377,6 +400,21 @@ export class API extends ParentAPI {
   listWebhooks = (request: Readonly<ListWebhooksRequest> = {}) =>
     enrichForPagination('webhooks', this.pageOfListWebhooks, request)
 
+  /**
+   * Get information about a Webhook.
+   *
+   * @param request - The request {@link GetWebhookRequest}
+   * @returns A Promise of Webhook
+   */
+  getWebhook = (request: Readonly<GetWebhookRequest>) =>
+    this.client.fetch<Webhook>(
+      {
+        method: 'GET',
+        path: `/transactional-email/v1alpha1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/webhooks/${validatePathParam('webhookId', request.webhookId)}`,
+      },
+      unmarshalWebhook,
+    )
+
   updateWebhook = (request: Readonly<UpdateWebhookRequest>) =>
     this.client.fetch<Webhook>(
       {

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

@@ -11,6 +11,7 @@ export type {
   CreateEmailRequestAttachment,
   CreateEmailRequestHeader,
   CreateEmailResponse,
+  CreateWebhookRequest,
   DeleteWebhookRequest,
   Domain,
   DomainLastStatus,
@@ -33,6 +34,7 @@ export type {
   GetDomainRequest,
   GetEmailRequest,
   GetStatisticsRequest,
+  GetWebhookRequest,
   ListDomainsRequest,
   ListDomainsResponse,
   ListEmailsRequest,

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

@@ -13,6 +13,7 @@ import type {
   CreateEmailRequestAttachment,
   CreateEmailRequestHeader,
   CreateEmailResponse,
+  CreateWebhookRequest,
   Domain,
   DomainLastStatus,
   DomainLastStatusDkimRecord,
@@ -438,6 +439,18 @@ export const marshalCreateEmailRequest = (
       : undefined,
 })
 
+export const marshalCreateWebhookRequest = (
+  request: CreateWebhookRequest,
+  defaults: DefaultValues,
+): Record<string, unknown> => ({
+  domain_id: request.domainId,
+  event_types:
+    request.eventTypes !== undefined ? request.eventTypes : undefined,
+  name: request.name,
+  project_id: request.projectId ?? defaults.defaultProjectId,
+  sns_arn: request.snsArn,
+})
+
 export const marshalUpdateWebhookRequest = (
   request: UpdateWebhookRequest,
   defaults: DefaultValues,

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

@@ -374,6 +374,24 @@ export interface CreateEmailResponse {
   emails: Email[]
 }
 
+export type CreateWebhookRequest = {
+  /**
+   * Region to target. If none is passed will use default region from the
+   * config.
+   */
+  region?: Region
+  /** ID of the Domain to watch for triggering events. */
+  domainId: string
+  /** ID of the project to which the Webhook belongs. */
+  projectId?: string
+  /** Name of the Webhook. */
+  name: string
+  /** List of event types that will trigger an event. */
+  eventTypes?: WebhookEventType[]
+  /** Scaleway SNS ARN topic to push the events to. */
+  snsArn: string
+}
+
 export type DeleteWebhookRequest = {
   /**
    * Region to target. If none is passed will use default region from the
@@ -448,6 +466,16 @@ export type GetStatisticsRequest = {
   mailFrom?: string
 }
 
+export type GetWebhookRequest = {
+  /**
+   * Region to target. If none is passed will use default region from the
+   * config.
+   */
+  region?: Region
+  /** ID of the Webhook to check. */
+  webhookId: string
+}
+
 export type ListDomainsRequest = {
   /**
    * Region to target. If none is passed will use default region from the

packages/clients/src/api/tem/v1alpha1/validation-rules.gen.ts

@@ -38,6 +38,17 @@ export const CreateEmailRequestHeader = {
   },
 }
 
+export const CreateWebhookRequest = {
+  name: {
+    maxLength: 127,
+    minLength: 3,
+  },
+  snsArn: {
+    maxLength: 127,
+    minLength: 3,
+  },
+}
+
 export const ListDomainsRequest = {
   page: {
     greaterThan: 0,