@scaleway/sdk 2.31.0 → 2.32.0

package/dist/api/tem/v1alpha1/marshalling.gen.js

@@ -110,6 +110,24 @@ const unmarshalDomain = (data) => {
     status: data.status
   };
 };
+const unmarshalWebhook = (data) => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'Webhook' failed as data isn't a dictionary.`
+    );
+  }
+  return {
+    createdAt: unmarshalDate(data.created_at),
+    domainId: data.domain_id,
+    eventTypes: data.event_types,
+    id: data.id,
+    name: data.name,
+    organizationId: data.organization_id,
+    projectId: data.project_id,
+    snsArn: data.sns_arn,
+    updatedAt: unmarshalDate(data.updated_at)
+  };
+};
 const unmarshalCreateEmailResponse = (data) => {
   if (!isJSONObject(data)) {
     throw new TypeError(
@@ -192,6 +210,50 @@ const unmarshalListEmailsResponse = (data) => {
     totalCount: data.total_count
   };
 };
+const unmarshalWebhookEvent = (data) => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'WebhookEvent' failed as data isn't a dictionary.`
+    );
+  }
+  return {
+    createdAt: unmarshalDate(data.created_at),
+    data: data.data,
+    emailId: data.email_id,
+    id: data.id,
+    organizationId: data.organization_id,
+    projectId: data.project_id,
+    status: data.status,
+    type: data.type,
+    updatedAt: unmarshalDate(data.updated_at),
+    webhookId: data.webhook_id
+  };
+};
+const unmarshalListWebhookEventsResponse = (data) => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'ListWebhookEventsResponse' failed as data isn't a dictionary.`
+    );
+  }
+  return {
+    totalCount: data.total_count,
+    webhookEvents: unmarshalArrayOfObject(
+      data.webhook_events,
+      unmarshalWebhookEvent
+    )
+  };
+};
+const unmarshalListWebhooksResponse = (data) => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'ListWebhooksResponse' failed as data isn't a dictionary.`
+    );
+  }
+  return {
+    totalCount: data.total_count,
+    webhooks: unmarshalArrayOfObject(data.webhooks, unmarshalWebhook)
+  };
+};
 const unmarshalStatistics = (data) => {
   if (!isJSONObject(data)) {
     throw new TypeError(
@@ -242,14 +304,23 @@ const marshalCreateEmailRequest = (request, defaults) => ({
   text: request.text,
   to: request.to !== void 0 ? request.to.map((elt) => marshalCreateEmailRequestAddress(elt)) : void 0
 });
+const marshalUpdateWebhookRequest = (request, defaults) => ({
+  event_types: request.eventTypes !== void 0 ? request.eventTypes : void 0,
+  name: request.name,
+  sns_arn: request.snsArn
+});
 export {
   marshalCreateDomainRequest,
   marshalCreateEmailRequest,
+  marshalUpdateWebhookRequest,
   unmarshalCreateEmailResponse,
   unmarshalDomain,
   unmarshalDomainLastStatus,
   unmarshalEmail,
   unmarshalListDomainsResponse,
   unmarshalListEmailsResponse,
-  unmarshalStatistics
+  unmarshalListWebhookEventsResponse,
+  unmarshalListWebhooksResponse,
+  unmarshalStatistics,
+  unmarshalWebhook
 };

package/dist/api/tem/v1alpha1/types.gen.d.ts

@@ -6,6 +6,10 @@ export type EmailFlag = 'unknown_flag' | 'soft_bounce' | 'hard_bounce' | 'spam'
 export type EmailRcptType = 'unknown_rcpt_type' | 'to' | 'cc' | 'bcc';
 export type EmailStatus = 'unknown' | 'new' | 'sending' | 'sent' | 'failed' | 'canceled';
 export type ListEmailsRequestOrderBy = 'created_at_desc' | 'created_at_asc' | 'updated_at_desc' | 'updated_at_asc' | 'status_desc' | 'status_asc' | 'mail_from_desc' | 'mail_from_asc' | 'mail_rcpt_desc' | 'mail_rcpt_asc' | 'subject_desc' | 'subject_asc';
+export type ListWebhookEventsRequestOrderBy = 'created_at_desc' | 'created_at_asc';
+export type ListWebhooksRequestOrderBy = 'created_at_desc' | 'created_at_asc';
+export type WebhookEventStatus = 'unknown_status' | 'waiting' | 'sending' | 'sent' | 'error';
+export type WebhookEventType = 'unknown_type' | 'email_queued' | 'email_dropped' | 'email_deferred' | 'email_delivered' | 'email_spam' | 'email_mailbox_not_found';
 export interface DomainRecordsDMARC {
     /** Name of the DMARC TXT record. */
     name: string;
@@ -173,6 +177,48 @@ export interface Domain {
      */
     region: Region;
 }
+export interface WebhookEvent {
+    /** ID of the Webhook Event. */
+    id: string;
+    /** ID of the Webhook that triggers the Event. */
+    webhookId: string;
+    /** ID of the Webhook Event Organization. */
+    organizationId: string;
+    /** ID of the Webhook Event Project. */
+    projectId: string;
+    /** Type of the Webhook Event. */
+    type: WebhookEventType;
+    /** Status of the Webhook Event. */
+    status: WebhookEventStatus;
+    /** Data sent to the Webhook destination. */
+    data: string;
+    /** Date and time of the Webhook Event creation. */
+    createdAt?: Date;
+    /** Date and time of last Webhook Event updates. */
+    updatedAt?: Date;
+    /** Optional Email ID if the event is triggered by an Email resource. */
+    emailId?: string;
+}
+export interface Webhook {
+    /** ID of the Webhook. */
+    id: string;
+    /** ID of the Domain to watch for triggering events. */
+    domainId: string;
+    /** ID of the Webhook Organization. */
+    organizationId: string;
+    /** ID of the Webhook Project. */
+    projectId: string;
+    /** Name of the Webhook. */
+    name: string;
+    /** List of event types that will trigger a Webhook Event. */
+    eventTypes: WebhookEventType[];
+    /** Scaleway SNS ARN topic to push the events to. */
+    snsArn: string;
+    /** Date and time of the Webhook creation. */
+    createdAt?: Date;
+    /** Date and time of last Webhook updates. */
+    updatedAt?: Date;
+}
 export type CancelEmailRequest = {
     /**
      * Region to target. If none is passed will use default region from the
@@ -237,6 +283,15 @@ export interface CreateEmailResponse {
     /** Single page of emails matching the requested criteria. */
     emails: Email[];
 }
+export type DeleteWebhookRequest = {
+    /**
+     * Region to target. If none is passed will use default region from the
+     * config.
+     */
+    region?: Region;
+    /** ID of the Webhook to delete. */
+    webhookId: string;
+};
 export interface DomainLastStatus {
     /** The ID of the domain. */
     domainId: string;
@@ -318,6 +373,7 @@ export type ListDomainsRequest = {
 export interface ListDomainsResponse {
     /** Number of domains that match the request (without pagination). */
     totalCount: number;
+    /** Single page of domains matching the requested criteria. */
     domains: Domain[];
 }
 export type ListEmailsRequest = {
@@ -361,6 +417,50 @@ export interface ListEmailsResponse {
     /** Single page of emails matching the requested criteria. */
     emails: Email[];
 }
+export type ListWebhookEventsRequest = {
+    /**
+     * Region to target. If none is passed will use default region from the
+     * config.
+     */
+    region?: Region;
+    /** ID of the Webhook linked to the events. */
+    webhookId: string;
+    /** (Optional) List Webhook events corresponding to specific criteria. */
+    orderBy?: ListWebhookEventsRequestOrderBy;
+    /** Requested page number. Value must be greater or equal to 1. */
+    page?: number;
+    /** Requested page size. Value must be between 1 and 100. */
+    pageSize?: number;
+};
+export interface ListWebhookEventsResponse {
+    /** Number of Webhook events matching the requested criteria. */
+    totalCount: number;
+    /** Single page of Webhook events matching the requested criteria. */
+    webhookEvents: WebhookEvent[];
+}
+export type ListWebhooksRequest = {
+    /**
+     * Region to target. If none is passed will use default region from the
+     * config.
+     */
+    region?: Region;
+    /** (Optional) List Webhooks corresponding to specific criteria. */
+    orderBy?: ListWebhooksRequestOrderBy;
+    /** (Optional) Requested page number. Value must be greater or equal to 1. */
+    page?: number;
+    /** (Optional) Requested page size. Value must be between 1 and 100. */
+    pageSize?: number;
+    /** (Optional) ID of the Project for which to list the Webhooks. */
+    projectId?: string;
+    /** (Optional) ID of the Organization for which to list the Webhooks. */
+    organizationId?: string;
+};
+export interface ListWebhooksResponse {
+    /** Number of Webhooks matching the requested criteria. */
+    totalCount: number;
+    /** Single page of Webhooks matching the requested criteria. */
+    webhooks: Webhook[];
+}
 export type RevokeDomainRequest = {
     /**
      * Region to target. If none is passed will use default region from the
@@ -399,3 +499,18 @@ export interface Statistics {
      */
     canceledCount: number;
 }
+export type UpdateWebhookRequest = {
+    /**
+     * Region to target. If none is passed will use default region from the
+     * config.
+     */
+    region?: Region;
+    /** ID of the Webhook to update. */
+    webhookId: string;
+    /** Name of the Webhook to update. */
+    name?: string;
+    /** List of event types to update. */
+    eventTypes?: WebhookEventType[];
+    /** Scaleway SNS ARN topic to update. */
+    snsArn?: string;
+};

package/dist/api/tem/v1alpha1/validation-rules.gen.cjs

@@ -0,0 +1,33 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const ListWebhookEventsRequest = {
+  page: {
+    greaterThan: 0
+  },
+  pageSize: {
+    greaterThanOrEqual: 1,
+    lessThanOrEqual: 100
+  }
+};
+const ListWebhooksRequest = {
+  page: {
+    greaterThan: 0
+  },
+  pageSize: {
+    greaterThanOrEqual: 1,
+    lessThanOrEqual: 100
+  }
+};
+const UpdateWebhookRequest = {
+  name: {
+    maxLength: 127,
+    minLength: 3
+  },
+  snsArn: {
+    maxLength: 127,
+    minLength: 3
+  }
+};
+exports.ListWebhookEventsRequest = ListWebhookEventsRequest;
+exports.ListWebhooksRequest = ListWebhooksRequest;
+exports.UpdateWebhookRequest = UpdateWebhookRequest;

package/dist/api/tem/v1alpha1/validation-rules.gen.d.ts

@@ -0,0 +1,28 @@
+export declare const ListWebhookEventsRequest: {
+    page: {
+        greaterThan: number;
+    };
+    pageSize: {
+        greaterThanOrEqual: number;
+        lessThanOrEqual: number;
+    };
+};
+export declare const ListWebhooksRequest: {
+    page: {
+        greaterThan: number;
+    };
+    pageSize: {
+        greaterThanOrEqual: number;
+        lessThanOrEqual: number;
+    };
+};
+export declare const UpdateWebhookRequest: {
+    name: {
+        maxLength: number;
+        minLength: number;
+    };
+    snsArn: {
+        maxLength: number;
+        minLength: number;
+    };
+};

package/dist/api/tem/v1alpha1/validation-rules.gen.js

@@ -0,0 +1,33 @@
+const ListWebhookEventsRequest = {
+  page: {
+    greaterThan: 0
+  },
+  pageSize: {
+    greaterThanOrEqual: 1,
+    lessThanOrEqual: 100
+  }
+};
+const ListWebhooksRequest = {
+  page: {
+    greaterThan: 0
+  },
+  pageSize: {
+    greaterThanOrEqual: 1,
+    lessThanOrEqual: 100
+  }
+};
+const UpdateWebhookRequest = {
+  name: {
+    maxLength: 127,
+    minLength: 3
+  },
+  snsArn: {
+    maxLength: 127,
+    minLength: 3
+  }
+};
+export {
+  ListWebhookEventsRequest,
+  ListWebhooksRequest,
+  UpdateWebhookRequest
+};

package/dist/scw/constants.cjs

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const version = "v2.30.0";
+const version = "v2.31.0";
 const userAgent = `scaleway-sdk-js/${version}`;
 exports.userAgent = userAgent;
 exports.version = version;

package/dist/scw/constants.d.ts

@@ -1,2 +1,2 @@
-export declare const version = "v2.30.0";
-export declare const userAgent = "scaleway-sdk-js/v2.30.0";
+export declare const version = "v2.31.0";
+export declare const userAgent = "scaleway-sdk-js/v2.31.0";

package/dist/scw/constants.js

@@ -1,4 +1,4 @@
-const version = "v2.30.0";
+const version = "v2.31.0";
 const userAgent = `scaleway-sdk-js/${version}`;
 export {
   userAgent,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scaleway/sdk",
-  "version": "2.31.0",
+  "version": "2.32.0",
   "license": "Apache-2.0",
   "description": "Scaleway SDK.",
   "keywords": [
@@ -39,5 +39,5 @@
   "bundledDependencies": [
     "@scaleway/random-name"
   ],
-  "gitHead": "a9fa1d2c895a7e630dc9d42513df022c3996ae50"
+  "gitHead": "8cdb5b0a6e64ec28b1e39627fb0de8b6ce0ef2e8"
 }