@scaleway/sdk 2.72.0 → 2.73.0

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

@@ -17,45 +17,59 @@ export type ProjectSettingsPeriodicReportFrequency = 'unknown_frequency' | 'mont
 export type WebhookEventStatus = 'unknown_status' | 'sending' | 'sent' | 'failed';
 export type WebhookEventType = 'unknown_type' | 'email_queued' | 'email_dropped' | 'email_deferred' | 'email_delivered' | 'email_spam' | 'email_mailbox_not_found' | 'email_blocklisted' | 'blocklist_created';
 export interface DomainRecordsDMARC {
-    /** Name of the DMARC TXT record. */
+    /**
+     * Name of the DMARC TXT record.
+     */
     name: string;
-    /** Value of the DMARC TXT record. */
+    /**
+     * Value of the DMARC TXT record.
+     */
     value: string;
 }
 export interface EmailTry {
-    /** Rank number of this attempt to send the email. */
+    /**
+     * Rank number of this attempt to send the email.
+     */
     rank: number;
-    /** Date of the attempt to send the email. */
+    /**
+     * Date of the attempt to send the email.
+     */
     triedAt?: Date;
     /**
-     * The SMTP status code received after the attempt. 0 if the attempt did not
-     * reach an SMTP server.
+     * The SMTP status code received after the attempt. 0 if the attempt did not reach an SMTP server.
      */
     code: number;
     /**
-     * The SMTP message received. If the attempt did not reach an SMTP server, the
-     * message returned explains what happened.
+     * The SMTP message received. If the attempt did not reach an SMTP server, the message returned explains what happened.
      */
     message: string;
 }
 export interface DomainRecords {
-    /** DMARC TXT record specification. */
+    /**
+     * DMARC TXT record specification.
+     */
     dmarc?: DomainRecordsDMARC;
 }
 export interface DomainReputation {
-    /** Status of your domain's reputation. */
+    /**
+     * Status of your domain's reputation.
+     */
     status: DomainReputationStatus;
     /**
-     * A range from 0 to 100 that determines your domain's reputation score. A
-     * score of `0` means a bad domain reputation and a score of `100` means an
-     * excellent domain reputation.
+     * A range from 0 to 100 that determines your domain's reputation score. A score of `0` means a bad domain reputation and a score of `100` means an excellent domain reputation.
      */
     score: number;
-    /** Time and date the score was calculated. */
+    /**
+     * Time and date the score was calculated.
+     */
     scoredAt?: Date;
-    /** The previously-calculated domain's reputation score. */
+    /**
+     * The previously-calculated domain's reputation score.
+     */
     previousScore?: number;
-    /** Time and date the previous reputation score was calculated. */
+    /**
+     * Time and date the previous reputation score was calculated.
+     */
     previousScoredAt?: Date;
 }
 export interface DomainStatistics {
@@ -65,813 +79,1222 @@ export interface DomainStatistics {
     canceledCount: number;
 }
 export interface Blocklist {
-    /** ID of the blocklist. */
+    /**
+     * ID of the blocklist.
+     */
     id: string;
-    /** Domain ID linked to the blocklist. */
+    /**
+     * Domain ID linked to the blocklist.
+     */
     domainId: string;
-    /** Date and time of the blocklist creation. */
+    /**
+     * Date and time of the blocklist creation.
+     */
     createdAt?: Date;
-    /** Date and time of the blocklist's last update. */
+    /**
+     * Date and time of the blocklist's last update.
+     */
     updatedAt?: Date;
-    /** Date and time when the blocklist ends. Empty if the blocklist has no end. */
+    /**
+     * Date and time when the blocklist ends. Empty if the blocklist has no end.
+     */
     endsAt?: Date;
-    /** Email blocked by the blocklist. */
+    /**
+     * Email blocked by the blocklist.
+     */
     email: string;
-    /** Type of block for this email. */
+    /**
+     * Type of block for this email.
+     */
     type: BlocklistType;
-    /** Reason to block this email. */
+    /**
+     * Reason to block this email.
+     */
     reason: string;
     /**
-     * True if this blocklist was created manually. False for an automatic
-     * Transactional Email blocklist.
+     * True if this blocklist was created manually. False for an automatic Transactional Email blocklist.
      */
     custom: boolean;
 }
 export interface CreateEmailRequestAddress {
-    /** Email address. */
+    /**
+     * Email address.
+     */
     email: string;
-    /** (Optional) Name displayed. */
+    /**
+     * (Optional) Name displayed.
+     */
     name?: string;
 }
 export interface CreateEmailRequestAttachment {
-    /** Filename of the attachment. */
+    /**
+     * Filename of the attachment.
+     */
     name: string;
-    /** MIME type of the attachment. */
+    /**
+     * MIME type of the attachment.
+     */
     type: string;
-    /** Content of the attachment encoded in base64. */
+    /**
+     * Content of the attachment encoded in base64.
+     */
     content: string;
 }
 export interface CreateEmailRequestHeader {
-    /** Email header key. */
+    /**
+     * Email header key.
+     */
     key: string;
-    /** Email header value. */
+    /**
+     * Email header value.
+     */
     value: string;
 }
 export interface Email {
-    /** Technical ID of the email. */
+    /**
+     * Technical ID of the email.
+     */
     id: string;
-    /** Message ID of the email. */
+    /**
+     * Message ID of the email.
+     */
     messageId: string;
-    /** ID of the Project to which the email belongs. */
+    /**
+     * ID of the Project to which the email belongs.
+     */
     projectId: string;
-    /** Email address of the sender. */
+    /**
+     * Email address of the sender.
+     */
     mailFrom: string;
-    /** @deprecated Deprecated. Email address of the recipient. */
+    /**
+     * @deprecated Deprecated. Email address of the recipient.
+     */
     rcptTo?: string;
-    /** Email address of the recipient. */
+    /**
+     * Email address of the recipient.
+     */
     mailRcpt: string;
-    /** Type of recipient. */
+    /**
+     * Type of recipient.
+     */
     rcptType: EmailRcptType;
-    /** Subject of the email. */
+    /**
+     * Subject of the email.
+     */
     subject: string;
-    /** Creation date of the email object. */
+    /**
+     * Creation date of the email object.
+     */
     createdAt?: Date;
-    /** Last update of the email object. */
+    /**
+     * Last update of the email object.
+     */
     updatedAt?: Date;
-    /** Status of the email. */
+    /**
+     * Status of the email.
+     */
     status: EmailStatus;
-    /** Additional status information. */
+    /**
+     * Additional status information.
+     */
     statusDetails?: string;
-    /** Number of attempts to send the email. */
+    /**
+     * Number of attempts to send the email.
+     */
     tryCount: number;
-    /** Information about the last three attempts to send the email. */
+    /**
+     * Information about the last three attempts to send the email.
+     */
     lastTries: EmailTry[];
     /**
-     * Flags categorize emails. They allow you to obtain more information about
-     * recurring errors, for example.
+     * Flags categorize emails. They allow you to obtain more information about recurring errors, for example.
      */
     flags: EmailFlag[];
 }
 export interface DomainLastStatusAutoconfigState {
-    /** Enable or disable the auto-configuration of domain DNS records. */
+    /**
+     * Enable or disable the auto-configuration of domain DNS records.
+     */
     enabled: boolean;
-    /** Whether the domain can be auto-configured or not. */
+    /**
+     * Whether the domain can be auto-configured or not.
+     */
     autoconfigurable: boolean;
-    /** The reason that the domain cannot be auto-configurable. */
+    /**
+     * The reason that the domain cannot be auto-configurable.
+     */
     reason?: DomainLastStatusAutoconfigStateReason;
 }
 export interface DomainLastStatusDkimRecord {
-    /** Status of the DKIM record's configuration. */
+    /**
+     * Status of the DKIM record's configuration.
+     */
     status: DomainLastStatusRecordStatus;
-    /** Time and date the DKIM record was last valid. */
+    /**
+     * Time and date the DKIM record was last valid.
+     */
     lastValidAt?: Date;
-    /** An error text displays in case the record is not valid. */
+    /**
+     * An error text displays in case the record is not valid.
+     */
     error?: string;
 }
 export interface DomainLastStatusDmarcRecord {
-    /** Status of the DMARC record's configuration. */
+    /**
+     * Status of the DMARC record's configuration.
+     */
     status: DomainLastStatusRecordStatus;
-    /** Time and date the DMARC record was last valid. */
+    /**
+     * Time and date the DMARC record was last valid.
+     */
     lastValidAt?: Date;
-    /** An error text displays in case the record is not valid. */
+    /**
+     * An error text displays in case the record is not valid.
+     */
     error?: string;
 }
 export interface DomainLastStatusSpfRecord {
-    /** Status of the SPF record's configuration. */
+    /**
+     * Status of the SPF record's configuration.
+     */
     status: DomainLastStatusRecordStatus;
-    /** Time and date the SPF record was last valid. */
+    /**
+     * Time and date the SPF record was last valid.
+     */
     lastValidAt?: Date;
-    /** An error text displays in case the record is not valid. */
+    /**
+     * An error text displays in case the record is not valid.
+     */
     error?: string;
 }
 export interface Domain {
-    /** ID of the domain. */
+    /**
+     * ID of the domain.
+     */
     id: string;
-    /** ID of the domain's Organization. */
+    /**
+     * ID of the domain's Organization.
+     */
     organizationId: string;
-    /** ID of the domain's Project. */
+    /**
+     * ID of the domain's Project.
+     */
     projectId: string;
-    /** Domain name (example.com). */
+    /**
+     * Domain name (example.com).
+     */
     name: string;
-    /** Status of the domain. */
+    /**
+     * Status of the domain.
+     */
     status: DomainStatus;
-    /** Date and time of domain creation. */
+    /**
+     * Date and time of domain creation.
+     */
     createdAt?: Date;
-    /** Date and time of the next scheduled check. */
+    /**
+     * Date and time of the next scheduled check.
+     */
     nextCheckAt?: Date;
-    /** Date and time the domain was last valid. */
+    /**
+     * Date and time the domain was last valid.
+     */
     lastValidAt?: Date;
-    /** Date and time of the domain's deletion. */
+    /**
+     * Date and time of the domain's deletion.
+     */
     revokedAt?: Date;
-    /** @deprecated Deprecated. Error message returned if the last check failed. */
+    /**
+     * @deprecated Deprecated. Error message returned if the last check failed.
+     */
     lastError?: string;
-    /** Snippet of the SPF record to register in the DNS zone. */
+    /**
+     * Snippet of the SPF record to register in the DNS zone.
+     */
     spfConfig: string;
-    /** DKIM public key to record in the DNS zone. */
+    /**
+     * DKIM public key to record in the DNS zone.
+     */
     dkimConfig: string;
-    /** Domain's statistics. */
+    /**
+     * Domain's statistics.
+     */
     statistics?: DomainStatistics;
     /**
-     * The domain's reputation is available when your domain is checked and has
-     * sent enough emails.
+     * The domain's reputation is available when your domain is checked and has sent enough emails.
      */
     reputation?: DomainReputation;
-    /** List of records to configure to validate a domain. */
+    /**
+     * List of records to configure to validate a domain.
+     */
     records?: DomainRecords;
-    /** Status of auto-configuration for the domain's DNS zone. */
+    /**
+     * Status of auto-configuration for the domain's DNS zone.
+     */
     autoconfig: boolean;
     /**
-     * Region to target. If none is passed will use default region from the
-     * config.
+     * Region to target. If none is passed will use default region from the config.
      */
     region: ScwRegion;
 }
 export interface OfferSubscription {
-    /** ID of the offer-subscription Organization. */
+    /**
+     * ID of the offer-subscription Organization.
+     */
     organizationId: string;
-    /** ID of the offer-subscription Project. */
+    /**
+     * ID of the offer-subscription Project.
+     */
     projectId: string;
-    /** Name of the offer associated with the Project. */
+    /**
+     * Name of the offer associated with the Project.
+     */
     offerName: OfferName;
-    /** Date and time of the subscription. */
+    /**
+     * Date and time of the subscription.
+     */
     subscribedAt?: Date;
-    /** Date and time of the end of the offer-subscription commitment. */
+    /**
+     * Date and time of the end of the offer-subscription commitment.
+     */
     cancellationAvailableAt?: Date;
-    /** Service Level Agreement percentage of the offer-subscription. */
+    /**
+     * Service Level Agreement percentage of the offer-subscription.
+     */
     sla: number;
     /**
-     * Max number of domains that can be associated with the offer-subscription
-     * for a particular Project.
+     * Max number of domains that can be associated with the offer-subscription for a particular Project.
      */
     maxDomains: number;
     /**
-     * Max number of dedicated IPs that can be associated with the
-     * offer-subscription for a particular Project.
+     * Max number of dedicated IPs that can be associated with the offer-subscription for a particular Project.
      */
     maxDedicatedIps: number;
     /**
-     * Max number of webhooks that can be associated with the offer-subscription
-     * for a particular Project.
+     * Max number of webhooks that can be associated with the offer-subscription for a particular Project.
      */
     maxWebhooksPerDomain: number;
     /**
-     * Max number of custom blocklists that can be associated with the
-     * offer-subscription for a particular Project.
+     * Max number of custom blocklists that can be associated with the offer-subscription for a particular Project.
      */
     maxCustomBlocklistsPerDomain: number;
-    /** Number of emails included in the offer-subscription per month. */
+    /**
+     * Number of emails included in the offer-subscription per month.
+     */
     includedMonthlyEmails: number;
 }
 export interface Offer {
-    /** Name of the offer. */
+    /**
+     * Name of the offer.
+     */
     name: OfferName;
-    /** Date and time of the offer creation. */
+    /**
+     * Date and time of the offer creation.
+     */
     createdAt?: Date;
-    /** Period of commitment. */
+    /**
+     * Period of commitment.
+     */
     commitmentPeriod?: string;
-    /** Service Level Agreement percentage of the offer. */
+    /**
+     * Service Level Agreement percentage of the offer.
+     */
     sla: number;
-    /** Max number of checked domains that can be associated with the offer. */
+    /**
+     * Max number of checked domains that can be associated with the offer.
+     */
     maxDomains: number;
-    /** Max number of dedicated IPs that can be associated with the offer. */
+    /**
+     * Max number of dedicated IPs that can be associated with the offer.
+     */
     maxDedicatedIps: number;
-    /** Number of emails included in the offer per month. */
+    /**
+     * Number of emails included in the offer per month.
+     */
     includedMonthlyEmails: number;
-    /** Max number of webhooks that can be associated with the offer. */
+    /**
+     * Max number of webhooks that can be associated with the offer.
+     */
     maxWebhooksPerDomain: number;
     /**
-     * Max number of active custom blocklists that can be associated with the
-     * offer.
+     * Max number of active custom blocklists that can be associated with the offer.
      */
     maxCustomBlocklistsPerDomain: number;
 }
 export interface Pool {
-    /** ID of the Project. */
+    /**
+     * ID of the Project.
+     */
     projectId: string;
-    /** Status of the pool. */
+    /**
+     * Status of the pool.
+     */
     status: PoolStatus;
-    /** Details of the pool. */
+    /**
+     * Details of the pool.
+     */
     details?: string;
-    /** Zone of the pool. */
+    /**
+     * Zone of the pool.
+     */
     zone?: ScwZone;
-    /** IPs of the pool. */
+    /**
+     * IPs of the pool.
+     */
     ips: string[];
-    /** Reverse hostname of all IPs of the pool. */
+    /**
+     * Reverse hostname of all IPs of the pool.
+     */
     reverse?: string;
 }
 export interface WebhookEvent {
-    /** ID of the Webhook Event. */
+    /**
+     * ID of the Webhook Event.
+     */
     id: string;
-    /** ID of the Webhook that triggers the Event. */
+    /**
+     * ID of the Webhook that triggers the Event.
+     */
     webhookId: string;
-    /** ID of the Webhook Event Organization. */
+    /**
+     * ID of the Webhook Event Organization.
+     */
     organizationId: string;
-    /** ID of the Webhook Event Project. */
+    /**
+     * ID of the Webhook Event Project.
+     */
     projectId: string;
-    /** ID of the webhook event domain. */
+    /**
+     * ID of the webhook event domain.
+     */
     domainId: string;
-    /** Type of the Webhook Event. */
+    /**
+     * Type of the Webhook Event.
+     */
     type: WebhookEventType;
-    /** Status of the Webhook Event. */
+    /**
+     * Status of the Webhook Event.
+     */
     status: WebhookEventStatus;
-    /** Data sent to the Webhook destination. */
+    /**
+     * Data sent to the Webhook destination.
+     */
     data: string;
-    /** Date and time of the Webhook Event creation. */
+    /**
+     * Date and time of the Webhook Event creation.
+     */
     createdAt?: Date;
-    /** Date and time of last Webhook Event updates. */
+    /**
+     * Date and time of last Webhook Event updates.
+     */
     updatedAt?: Date;
-    /** Optional Email ID if the event is triggered by an Email resource. */
+    /**
+     * Optional Email ID if the event is triggered by an Email resource.
+     */
     emailId?: string;
 }
 export interface Webhook {
-    /** ID of the Webhook. */
+    /**
+     * ID of the Webhook.
+     */
     id: string;
-    /** ID of the Domain to watch for triggering events. */
+    /**
+     * ID of the Domain to watch for triggering events.
+     */
     domainId: string;
-    /** ID of the Webhook Organization. */
+    /**
+     * ID of the Webhook Organization.
+     */
     organizationId: string;
-    /** ID of the Webhook Project. */
+    /**
+     * ID of the Webhook Project.
+     */
     projectId: string;
-    /** Name of the Webhook. */
+    /**
+     * Name of the Webhook.
+     */
     name: string;
-    /** List of event types that will trigger a Webhook Event. */
+    /**
+     * List of event types that will trigger a Webhook Event.
+     */
     eventTypes: WebhookEventType[];
-    /** Scaleway SNS ARN topic to push the events to. */
+    /**
+     * Scaleway SNS ARN topic to push the events to.
+     */
     snsArn: string;
-    /** Date and time of the Webhook creation. */
+    /**
+     * Date and time of the Webhook creation.
+     */
     createdAt?: Date;
-    /** Date and time of last Webhook updates. */
+    /**
+     * Date and time of last Webhook updates.
+     */
     updatedAt?: Date;
 }
 export interface ProjectSettingsPeriodicReport {
-    /** Enable or disable periodic report notifications. */
+    /**
+     * Enable or disable periodic report notifications.
+     */
     enabled: boolean;
-    /** At which frequency you receive periodic report notifications. */
+    /**
+     * At which frequency you receive periodic report notifications.
+     */
     frequency: ProjectSettingsPeriodicReportFrequency;
-    /** At which hour you receive periodic report notifications. */
+    /**
+     * At which hour you receive periodic report notifications.
+     */
     sendingHour: number;
     /**
-     * On which day you receive periodic report notifications (1-7 weekly, 1-28
-     * monthly).
+     * On which day you receive periodic report notifications (1-7 weekly, 1-28 monthly).
      */
     sendingDay: number;
 }
 export interface UpdateProjectSettingsRequestUpdatePeriodicReport {
-    /** (Optional) Enable or disable periodic report notifications. */
+    /**
+     * (Optional) Enable or disable periodic report notifications.
+     */
     enabled?: boolean;
-    /** (Optional) Frequency at which you receive periodic report notifications. */
+    /**
+     * (Optional) Frequency at which you receive periodic report notifications.
+     */
     frequency?: ProjectSettingsPeriodicReportFrequency;
-    /** (Optional) Hour at which you receive periodic report notifications. */
+    /**
+     * (Optional) Hour at which you receive periodic report notifications.
+     */
     sendingHour?: number;
     /**
-     * (Optional) On which day you receive periodic report notifications (1-7
-     * weekly, 1-28 monthly).
+     * (Optional) On which day you receive periodic report notifications (1-7 weekly, 1-28 monthly).
      */
     sendingDay?: number;
 }
 export type BulkCreateBlocklistsRequest = {
     /**
-     * Region to target. If none is passed will use default region from the
-     * config.
+     * Region to target. If none is passed will use default region from the config.
      */
     region?: ScwRegion;
-    /** Domain ID linked to the blocklist. */
+    /**
+     * Domain ID linked to the blocklist.
+     */
     domainId: string;
-    /** Email blocked by the blocklist. */
+    /**
+     * Email blocked by the blocklist.
+     */
     emails?: string[];
-    /** Type of blocklist. */
+    /**
+     * Type of blocklist.
+     */
     type?: BlocklistType;
-    /** Reason to block the email. */
+    /**
+     * Reason to block the email.
+     */
     reason?: string;
 };
 export interface BulkCreateBlocklistsResponse {
-    /** List of blocklist created. */
+    /**
+     * List of blocklist created.
+     */
     blocklists: Blocklist[];
 }
 export type CancelEmailRequest = {
     /**
-     * Region to target. If none is passed will use default region from the
-     * config.
+     * Region to target. If none is passed will use default region from the config.
      */
     region?: ScwRegion;
-    /** ID of the email to cancel. */
+    /**
+     * ID of the email to cancel.
+     */
     emailId: string;
 };
 export type CheckDomainRequest = {
     /**
-     * Region to target. If none is passed will use default region from the
-     * config.
+     * Region to target. If none is passed will use default region from the config.
      */
     region?: ScwRegion;
-    /** ID of the domain to check. */
+    /**
+     * ID of the domain to check.
+     */
     domainId: string;
 };
 export type CreateDomainRequest = {
     /**
-     * Region to target. If none is passed will use default region from the
-     * config.
+     * Region to target. If none is passed will use default region from the config.
      */
     region?: ScwRegion;
-    /** ID of the project to which the domain belongs. */
+    /**
+     * ID of the project to which the domain belongs.
+     */
     projectId?: string;
-    /** Fully qualified domain dame. */
+    /**
+     * Fully qualified domain dame.
+     */
     domainName: string;
-    /** @deprecated Deprecated. Accept Scaleway's Terms of Service. */
+    /**
+     * @deprecated Deprecated. Accept Scaleway's Terms of Service.
+     */
     acceptTos?: boolean;
-    /** Activate auto-configuration of the domain's DNS zone. */
+    /**
+     * Activate auto-configuration of the domain's DNS zone.
+     */
     autoconfig: boolean;
 };
 export type CreateEmailRequest = {
     /**
-     * Region to target. If none is passed will use default region from the
-     * config.
+     * Region to target. If none is passed will use default region from the config.
      */
     region?: ScwRegion;
-    /** Sender information. Must be from a checked domain declared in the Project. */
+    /**
+     * Sender information. Must be from a checked domain declared in the Project.
+     */
     from: CreateEmailRequestAddress;
-    /** An array of the primary recipient's information. */
+    /**
+     * An array of the primary recipient's information.
+     */
     to?: CreateEmailRequestAddress[];
-    /** An array of the carbon copy recipient's information. */
+    /**
+     * An array of the carbon copy recipient's information.
+     */
     cc?: CreateEmailRequestAddress[];
-    /** An array of the blind carbon copy recipient's information. */
+    /**
+     * An array of the blind carbon copy recipient's information.
+     */
     bcc?: CreateEmailRequestAddress[];
-    /** Subject of the email. */
+    /**
+     * Subject of the email.
+     */
     subject: string;
-    /** Text content. */
+    /**
+     * Text content.
+     */
     text: string;
-    /** HTML content. */
+    /**
+     * HTML content.
+     */
     html: string;
-    /** ID of the Project in which to create the email. */
+    /**
+     * ID of the Project in which to create the email.
+     */
     projectId?: string;
-    /** Array of attachments. */
+    /**
+     * Array of attachments.
+     */
     attachments?: CreateEmailRequestAttachment[];
-    /** Maximum date to deliver the email. */
+    /**
+     * Maximum date to deliver the email.
+     */
     sendBefore?: Date;
-    /** Array of additional headers as key-value. */
+    /**
+     * Array of additional headers as key-value.
+     */
     additionalHeaders?: CreateEmailRequestHeader[];
 };
 export interface CreateEmailResponse {
-    /** Single page of emails matching the requested criteria. */
+    /**
+     * Single page of emails matching the requested criteria.
+     */
     emails: Email[];
 }
 export type CreateWebhookRequest = {
     /**
-     * Region to target. If none is passed will use default region from the
-     * config.
+     * Region to target. If none is passed will use default region from the config.
      */
     region?: ScwRegion;
-    /** ID of the Domain to watch for triggering events. */
+    /**
+     * ID of the Domain to watch for triggering events.
+     */
     domainId: string;
-    /** ID of the project to which the Webhook belongs. */
+    /**
+     * ID of the project to which the Webhook belongs.
+     */
     projectId?: string;
-    /** Name of the Webhook. */
+    /**
+     * Name of the Webhook.
+     */
     name: string;
-    /** List of event types that will trigger an event. */
+    /**
+     * List of event types that will trigger an event.
+     */
     eventTypes?: WebhookEventType[];
-    /** Scaleway SNS ARN topic to push the events to. */
+    /**
+     * Scaleway SNS ARN topic to push the events to.
+     */
     snsArn: string;
 };
 export type DeleteBlocklistRequest = {
     /**
-     * Region to target. If none is passed will use default region from the
-     * config.
+     * Region to target. If none is passed will use default region from the config.
      */
     region?: ScwRegion;
-    /** ID of the blocklist to delete. */
+    /**
+     * ID of the blocklist to delete.
+     */
     blocklistId: string;
 };
 export type DeleteWebhookRequest = {
     /**
-     * Region to target. If none is passed will use default region from the
-     * config.
+     * Region to target. If none is passed will use default region from the config.
      */
     region?: ScwRegion;
-    /** ID of the Webhook to delete. */
+    /**
+     * ID of the Webhook to delete.
+     */
     webhookId: string;
 };
 export interface DomainLastStatus {
-    /** The ID of the domain. */
+    /**
+     * The ID of the domain.
+     */
     domainId: string;
-    /** The domain name (example.com). */
+    /**
+     * The domain name (example.com).
+     */
     domainName: string;
-    /** The SPF record verification data. */
+    /**
+     * The SPF record verification data.
+     */
     spfRecord?: DomainLastStatusSpfRecord;
-    /** The DKIM record verification data. */
+    /**
+     * The DKIM record verification data.
+     */
     dkimRecord?: DomainLastStatusDkimRecord;
-    /** The DMARC record verification data. */
+    /**
+     * The DMARC record verification data.
+     */
     dmarcRecord?: DomainLastStatusDmarcRecord;
-    /** The verification state of domain auto-configuration. */
+    /**
+     * The verification state of domain auto-configuration.
+     */
     autoconfigState?: DomainLastStatusAutoconfigState;
 }
 export type GetDomainLastStatusRequest = {
     /**
-     * Region to target. If none is passed will use default region from the
-     * config.
+     * Region to target. If none is passed will use default region from the config.
      */
     region?: ScwRegion;
-    /** ID of the domain to delete. */
+    /**
+     * ID of the domain to delete.
+     */
     domainId: string;
 };
 export type GetDomainRequest = {
     /**
-     * Region to target. If none is passed will use default region from the
-     * config.
+     * Region to target. If none is passed will use default region from the config.
      */
     region?: ScwRegion;
-    /** ID of the domain. */
+    /**
+     * ID of the domain.
+     */
     domainId: string;
 };
 export type GetEmailRequest = {
     /**
-     * Region to target. If none is passed will use default region from the
-     * config.
+     * Region to target. If none is passed will use default region from the config.
      */
     region?: ScwRegion;
-    /** ID of the email to retrieve. */
+    /**
+     * ID of the email to retrieve.
+     */
     emailId: string;
 };
 export type GetProjectConsumptionRequest = {
     /**
-     * Region to target. If none is passed will use default region from the
-     * config.
+     * Region to target. If none is passed will use default region from the config.
      */
     region?: ScwRegion;
-    /** ID of the project. */
+    /**
+     * ID of the project.
+     */
     projectId?: string;
 };
 export type GetProjectSettingsRequest = {
     /**
-     * Region to target. If none is passed will use default region from the
-     * config.
+     * Region to target. If none is passed will use default region from the config.
      */
     region?: ScwRegion;
-    /** ID of the project. */
+    /**
+     * ID of the project.
+     */
     projectId?: string;
 };
 export type GetStatisticsRequest = {
     /**
-     * Region to target. If none is passed will use default region from the
-     * config.
+     * Region to target. If none is passed will use default region from the config.
      */
     region?: ScwRegion;
-    /** (Optional) Number of emails for this Project. */
+    /**
+     * (Optional) Number of emails for this Project.
+     */
     projectId?: string;
     /**
-     * (Optional) Number of emails sent from this domain (must be coherent with
-     * the `project_id` and the `organization_id`).
+     * (Optional) Number of emails sent from this domain (must be coherent with the `project_id` and the `organization_id`).
      */
     domainId?: string;
-    /** (Optional) Number of emails created after this date. */
+    /**
+     * (Optional) Number of emails created after this date.
+     */
     since?: Date;
-    /** (Optional) Number of emails created before this date. */
+    /**
+     * (Optional) Number of emails created before this date.
+     */
     until?: Date;
-    /** (Optional) Number of emails sent with this sender's email address. */
+    /**
+     * (Optional) Number of emails sent with this sender's email address.
+     */
     mailFrom?: string;
 };
 export type GetWebhookRequest = {
     /**
-     * Region to target. If none is passed will use default region from the
-     * config.
+     * Region to target. If none is passed will use default region from the config.
      */
     region?: ScwRegion;
-    /** ID of the Webhook to check. */
+    /**
+     * ID of the Webhook to check.
+     */
     webhookId: string;
 };
 export type ListBlocklistsRequest = {
     /**
-     * Region to target. If none is passed will use default region from the
-     * config.
+     * Region to target. If none is passed will use default region from the config.
      */
     region?: ScwRegion;
-    /** (Optional) List blocklist corresponding to specific criteria. */
+    /**
+     * (Optional) List blocklist corresponding to specific criteria.
+     */
     orderBy?: ListBlocklistsRequestOrderBy;
-    /** (Optional) Requested page number. Value must be greater or equal to 1. */
+    /**
+     * (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. */
+    /**
+     * (Optional) Requested page size. Value must be between 1 and 100.
+     */
     pageSize?: number;
-    /** (Optional) Filter by a domain ID. */
+    /**
+     * (Optional) Filter by a domain ID.
+     */
     domainId: string;
-    /** (Optional) Filter by an email address. */
+    /**
+     * (Optional) Filter by an email address.
+     */
     email?: string;
-    /** (Optional) Filter by a blocklist type. */
+    /**
+     * (Optional) Filter by a blocklist type.
+     */
     type?: BlocklistType;
     /**
-     * (Optional) Filter by custom blocklist (true) or automatic Transactional
-     * Email blocklist (false).
+     * (Optional) Filter by custom blocklist (true) or automatic Transactional Email blocklist (false).
      */
     custom?: boolean;
 };
 export interface ListBlocklistsResponse {
-    /** Number of blocklists matching the requested criteria. */
+    /**
+     * Number of blocklists matching the requested criteria.
+     */
     totalCount: number;
-    /** Single page of blocklists matching the requested criteria. */
+    /**
+     * Single page of blocklists matching the requested criteria.
+     */
     blocklists: Blocklist[];
 }
 export type ListDomainsRequest = {
     /**
-     * Region to target. If none is passed will use default region from the
-     * config.
+     * Region to target. If none is passed will use default region from the config.
      */
     region?: ScwRegion;
-    /** Requested page number. Value must be greater or equal to 1. */
+    /**
+     * Requested page number. Value must be greater or equal to 1.
+     */
     page?: number;
-    /** Requested page size. Value must be between 1 and 1000. */
+    /**
+     * Requested page size. Value must be between 1 and 1000.
+     */
     pageSize?: number;
-    /** (Optional) ID of the Project in which to list the domains. */
+    /**
+     * (Optional) ID of the Project in which to list the domains.
+     */
     projectId?: string;
-    /** (Optional) List domains under specific statuses. */
+    /**
+     * (Optional) List domains under specific statuses.
+     */
     status?: DomainStatus[];
-    /** (Optional) ID of the Organization in which to list the domains. */
+    /**
+     * (Optional) ID of the Organization in which to list the domains.
+     */
     organizationId?: string;
-    /** (Optional) Names of the domains to list. */
+    /**
+     * (Optional) Names of the domains to list.
+     */
     name?: string;
 };
 export interface ListDomainsResponse {
-    /** Number of domains that match the request (without pagination). */
+    /**
+     * Number of domains that match the request (without pagination).
+     */
     totalCount: number;
-    /** Single page of domains matching the requested criteria. */
+    /**
+     * Single page of domains matching the requested criteria.
+     */
     domains: Domain[];
 }
 export type ListEmailsRequest = {
     /**
-     * Region to target. If none is passed will use default region from the
-     * config.
+     * Region to target. If none is passed will use default region from the config.
      */
     region?: ScwRegion;
     page?: number;
     pageSize?: number;
-    /** (Optional) ID of the Project in which to list the emails. */
+    /**
+     * (Optional) ID of the Project in which to list the emails.
+     */
     projectId?: string;
-    /** (Optional) ID of the domain for which to list the emails. */
+    /**
+     * (Optional) ID of the domain for which to list the emails.
+     */
     domainId?: string;
-    /** (Optional) ID of the message for which to list the emails. */
+    /**
+     * (Optional) ID of the message for which to list the emails.
+     */
     messageId?: string;
-    /** (Optional) List emails created after this date. */
+    /**
+     * (Optional) List emails created after this date.
+     */
     since?: Date;
-    /** (Optional) List emails created before this date. */
+    /**
+     * (Optional) List emails created before this date.
+     */
     until?: Date;
-    /** (Optional) List emails sent with this sender's email address. */
+    /**
+     * (Optional) List emails sent with this sender's email address.
+     */
     mailFrom?: string;
-    /** @deprecated Deprecated. List emails sent to this recipient's email address. */
+    /**
+     * @deprecated Deprecated. List emails sent to this recipient's email address.
+     */
     mailTo?: string;
-    /** (Optional) List emails sent to this recipient's email address. */
+    /**
+     * (Optional) List emails sent to this recipient's email address.
+     */
     mailRcpt?: string;
-    /** (Optional) List emails with any of these statuses. */
+    /**
+     * (Optional) List emails with any of these statuses.
+     */
     statuses?: EmailStatus[];
-    /** (Optional) List emails with this subject. */
+    /**
+     * (Optional) List emails with this subject.
+     */
     subject?: string;
-    /** (Optional) List emails by searching to all fields. */
+    /**
+     * (Optional) List emails by searching to all fields.
+     */
     search?: string;
-    /** (Optional) List emails corresponding to specific criteria. */
+    /**
+     * (Optional) List emails corresponding to specific criteria.
+     */
     orderBy?: ListEmailsRequestOrderBy;
-    /** (Optional) List emails containing only specific flags. */
+    /**
+     * (Optional) List emails containing only specific flags.
+     */
     flags?: EmailFlag[];
 };
 export interface ListEmailsResponse {
-    /** Number of emails matching the requested criteria. */
+    /**
+     * Number of emails matching the requested criteria.
+     */
     totalCount: number;
-    /** Single page of emails matching the requested criteria. */
+    /**
+     * Single page of emails matching the requested criteria.
+     */
     emails: Email[];
 }
 export type ListOfferSubscriptionsRequest = {
     /**
-     * Region to target. If none is passed will use default region from the
-     * config.
+     * Region to target. If none is passed will use default region from the config.
      */
     region?: ScwRegion;
-    /** ID of the Project. */
+    /**
+     * ID of the Project.
+     */
     projectId?: string;
 };
 export interface ListOfferSubscriptionsResponse {
-    /** Number of offer-subscriptions matching the requested criteria. */
+    /**
+     * Number of offer-subscriptions matching the requested criteria.
+     */
     totalCount: number;
-    /** Single page of offer-subscriptions matching the requested criteria. */
+    /**
+     * Single page of offer-subscriptions matching the requested criteria.
+     */
     offerSubscriptions: OfferSubscription[];
 }
 export type ListOffersRequest = {
     /**
-     * Region to target. If none is passed will use default region from the
-     * config.
+     * Region to target. If none is passed will use default region from the config.
      */
     region?: ScwRegion;
 };
 export interface ListOffersResponse {
-    /** Number of offers matching the requested criteria. */
+    /**
+     * Number of offers matching the requested criteria.
+     */
     totalCount: number;
-    /** Single page of offers matching the requested criteria. */
+    /**
+     * Single page of offers matching the requested criteria.
+     */
     offers: Offer[];
 }
 export type ListPoolsRequest = {
     /**
-     * Region to target. If none is passed will use default region from the
-     * config.
+     * Region to target. If none is passed will use default region from the config.
      */
     region?: ScwRegion;
-    /** Requested page number. Value must be greater or equal to 1. */
+    /**
+     * Requested page number. Value must be greater or equal to 1.
+     */
     page?: number;
-    /** Requested page size. Value must be between 1 and 1000. */
+    /**
+     * Requested page size. Value must be between 1 and 1000.
+     */
     pageSize?: number;
-    /** ID of the Project. */
+    /**
+     * ID of the Project.
+     */
     projectId?: string;
 };
 export interface ListPoolsResponse {
-    /** Number of pools matching the requested criteria. */
+    /**
+     * Number of pools matching the requested criteria.
+     */
     totalCount: number;
-    /** Single page of pools matching the requested criteria. */
+    /**
+     * Single page of pools matching the requested criteria.
+     */
     pools: Pool[];
 }
 export type ListWebhookEventsRequest = {
     /**
-     * Region to target. If none is passed will use default region from the
-     * config.
+     * Region to target. If none is passed will use default region from the config.
      */
     region?: ScwRegion;
-    /** ID of the Webhook linked to the events. */
+    /**
+     * ID of the Webhook linked to the events.
+     */
     webhookId: string;
-    /** (Optional) List Webhook events corresponding to specific criteria. */
+    /**
+     * (Optional) List Webhook events corresponding to specific criteria.
+     */
     orderBy?: ListWebhookEventsRequestOrderBy;
-    /** Requested page number. Value must be greater or equal to 1. */
+    /**
+     * Requested page number. Value must be greater or equal to 1.
+     */
     page?: number;
-    /** Requested page size. Value must be between 1 and 100. */
+    /**
+     * Requested page size. Value must be between 1 and 100.
+     */
     pageSize?: number;
-    /** ID of the email linked to the events. */
+    /**
+     * ID of the email linked to the events.
+     */
     emailId?: string;
-    /** List of event types linked to the events. */
+    /**
+     * List of event types linked to the events.
+     */
     eventTypes?: WebhookEventType[];
-    /** List of event statuses. */
+    /**
+     * List of event statuses.
+     */
     statuses?: WebhookEventStatus[];
-    /** ID of the webhook Project. */
+    /**
+     * ID of the webhook Project.
+     */
     projectId?: string;
-    /** ID of the webhook Organization. */
+    /**
+     * ID of the webhook Organization.
+     */
     organizationId?: string;
-    /** ID of the domain to watch for triggering events. */
+    /**
+     * ID of the domain to watch for triggering events.
+     */
     domainId?: string;
 };
 export interface ListWebhookEventsResponse {
-    /** Number of Webhook events matching the requested criteria. */
+    /**
+     * Number of Webhook events matching the requested criteria.
+     */
     totalCount: number;
-    /** Single page of Webhook events matching the requested criteria. */
+    /**
+     * 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 to target. If none is passed will use default region from the config.
      */
     region?: ScwRegion;
-    /** (Optional) List Webhooks corresponding to specific criteria. */
+    /**
+     * (Optional) List Webhooks corresponding to specific criteria.
+     */
     orderBy?: ListWebhooksRequestOrderBy;
-    /** (Optional) Requested page number. Value must be greater or equal to 1. */
+    /**
+     * (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. */
+    /**
+     * (Optional) Requested page size. Value must be between 1 and 100.
+     */
     pageSize?: number;
-    /** (Optional) ID of the Project for which to list the Webhooks. */
+    /**
+     * (Optional) ID of the Project for which to list the Webhooks.
+     */
     projectId?: string;
-    /** (Optional) ID of the Organization for which to list the Webhooks. */
+    /**
+     * (Optional) ID of the Organization for which to list the Webhooks.
+     */
     organizationId?: string;
-    /** (Optional) ID of the Domain for which to list the Webhooks. */
+    /**
+     * (Optional) ID of the Domain for which to list the Webhooks.
+     */
     domainId?: string;
 };
 export interface ListWebhooksResponse {
-    /** Number of Webhooks matching the requested criteria. */
+    /**
+     * Number of Webhooks matching the requested criteria.
+     */
     totalCount: number;
-    /** Single page of Webhooks matching the requested criteria. */
+    /**
+     * Single page of Webhooks matching the requested criteria.
+     */
     webhooks: Webhook[];
 }
 export interface ProjectConsumption {
-    /** ID of the project. */
+    /**
+     * ID of the project.
+     */
     projectId: string;
-    /** Number of domains in the project. */
+    /**
+     * Number of domains in the project.
+     */
     domainsCount: number;
-    /** Number of dedicated IP in the project. */
+    /**
+     * Number of dedicated IP in the project.
+     */
     dedicatedIpsCount: number;
-    /** Number of emails sent during the current month in the project. */
+    /**
+     * Number of emails sent during the current month in the project.
+     */
     monthlyEmailsCount: number;
-    /** Number of webhooks in the project. */
+    /**
+     * Number of webhooks in the project.
+     */
     webhooksCount: number;
-    /** Number of custom blocklists in the project. */
+    /**
+     * Number of custom blocklists in the project.
+     */
     customBlocklistsCount: number;
 }
 export interface ProjectSettings {
-    /** Information about your periodic report. */
+    /**
+     * Information about your periodic report.
+     */
     periodicReport?: ProjectSettingsPeriodicReport;
 }
 export type RevokeDomainRequest = {
     /**
-     * Region to target. If none is passed will use default region from the
-     * config.
+     * Region to target. If none is passed will use default region from the config.
      */
     region?: ScwRegion;
-    /** ID of the domain to delete. */
+    /**
+     * ID of the domain to delete.
+     */
     domainId: string;
 };
 export interface Statistics {
-    /** Total number of emails matching the requested criteria. */
+    /**
+     * Total number of emails matching the requested criteria.
+     */
     totalCount: number;
     /**
-     * Number of emails still in the `new` transient state. This means emails
-     * received from the API but not yet processed.
+     * Number of emails still in the `new` transient state. This means emails received from the API but not yet processed.
      */
     newCount: number;
     /**
-     * Number of emails still in the `sending` transient state. This means emails
-     * received from the API but not yet in their final status.
+     * Number of emails still in the `sending` transient state. This means emails received from the API but not yet in their final status.
      */
     sendingCount: number;
     /**
-     * Number of emails in the final `sent` state. This means emails that have
-     * been delivered to the target mail system.
+     * Number of emails in the final `sent` state. This means emails that have been delivered to the target mail system.
      */
     sentCount: number;
     /**
-     * Number of emails in the final `failed` state. This means emails that have
-     * been refused by the target mail system with a final error status.
+     * Number of emails in the final `failed` state. This means emails that have been refused by the target mail system with a final error status.
      */
     failedCount: number;
     /**
-     * Number of emails in the final `canceled` state. This means emails that have
-     * been canceled upon request.
+     * Number of emails in the final `canceled` state. This means emails that have been canceled upon request.
      */
     canceledCount: number;
 }
 export type UpdateDomainRequest = {
     /**
-     * Region to target. If none is passed will use default region from the
-     * config.
+     * Region to target. If none is passed will use default region from the config.
      */
     region?: ScwRegion;
-    /** ID of the domain to update. */
+    /**
+     * ID of the domain to update.
+     */
     domainId: string;
     /**
-     * (Optional) If set to true, activate auto-configuration of the domain's DNS
-     * zone.
+     * (Optional) If set to true, activate auto-configuration of the domain's DNS zone.
      */
     autoconfig?: boolean;
 };
 export type UpdateOfferSubscriptionRequest = {
     /**
-     * Region to target. If none is passed will use default region from the
-     * config.
+     * Region to target. If none is passed will use default region from the config.
      */
     region?: ScwRegion;
-    /** ID of the Project. */
+    /**
+     * ID of the Project.
+     */
     projectId?: string;
-    /** Name of the offer-subscription. */
+    /**
+     * Name of the offer-subscription.
+     */
     name?: OfferName;
 };
 export type UpdateProjectSettingsRequest = {
     /**
-     * Region to target. If none is passed will use default region from the
-     * config.
+     * Region to target. If none is passed will use default region from the config.
      */
     region?: ScwRegion;
-    /** ID of the project. */
+    /**
+     * ID of the project.
+     */
     projectId?: string;
-    /** Periodic report update details - all fields are optional. */
+    /**
+     * Periodic report update details - all fields are optional.
+     */
     periodicReport?: UpdateProjectSettingsRequestUpdatePeriodicReport;
 };
 export type UpdateWebhookRequest = {
     /**
-     * Region to target. If none is passed will use default region from the
-     * config.
+     * Region to target. If none is passed will use default region from the config.
      */
     region?: ScwRegion;
-    /** ID of the Webhook to update. */
+    /**
+     * ID of the Webhook to update.
+     */
     webhookId: string;
-    /** Name of the Webhook to update. */
+    /**
+     * Name of the Webhook to update.
+     */
     name?: string;
-    /** List of event types to update. */
+    /**
+     * List of event types to update.
+     */
     eventTypes?: WebhookEventType[];
-    /** Scaleway SNS ARN topic to update. */
+    /**
+     * Scaleway SNS ARN topic to update.
+     */
     snsArn?: string;
 };