@scaleway/sdk 2.71.1 → 2.73.0

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

@@ -1,195 +1,287 @@
-import type { Region as ScwRegion } from '../../../bridge';
+import type { Region as ScwRegion } from '@scaleway/sdk-client';
 export type DatabaseBackupStatus = 'unknown_status' | 'error' | 'ready' | 'locked';
 export type DatabaseStatus = 'unknown_status' | 'error' | 'creating' | 'ready' | 'deleting' | 'restoring' | 'locked';
 export type ListDatabaseBackupsRequestOrderBy = 'created_at_desc' | 'created_at_asc';
 export type ListDatabasesRequestOrderBy = 'created_at_asc' | 'created_at_desc' | 'name_asc' | 'name_desc';
 export interface DatabaseBackup {
-    /** UUID that uniquely identifies a Serverless SQL Database backup. */
+    /**
+     * UUID that uniquely identifies a Serverless SQL Database backup.
+     */
     id: string;
     /**
-     * Status of the Serverless SQL Database backup. One of `unknown_status` |
-     * `error` | `ready` | `locked`.
+     * Status of the Serverless SQL Database backup. One of `unknown_status` | `error` | `ready` | `locked`.
      */
     status: DatabaseBackupStatus;
-    /** The ID of your Scaleway organization. */
+    /**
+     * The ID of your Scaleway organization.
+     */
     organizationId: string;
-    /** UUID of the Scaleway project. */
+    /**
+     * UUID of the Scaleway project.
+     */
     projectId: string;
-    /** UUID of the source Serverless SQL Database the backup is created from. */
+    /**
+     * UUID of the source Serverless SQL Database the backup is created from.
+     */
     databaseId: string;
-    /** Creation date. */
+    /**
+     * Creation date.
+     */
     createdAt?: Date;
-    /** Expiration date. */
+    /**
+     * Expiration date.
+     */
     expiresAt?: Date;
-    /** Size (in bytes) of the database backup file. */
+    /**
+     * Size (in bytes) of the database backup file.
+     */
     size?: number;
-    /** Size (in bytes) of the database when backup has been done. */
+    /**
+     * Size (in bytes) of the database when backup has been done.
+     */
     dbSize?: number;
-    /** Download URL of the exported database backup. */
+    /**
+     * Download URL of the exported database backup.
+     */
     downloadUrl?: string;
-    /** Expiration date of the download URL. */
+    /**
+     * Expiration date of the download URL.
+     */
     downloadUrlExpiresAt?: Date;
-    /** Region of the database backup. */
+    /**
+     * Region of the database backup.
+     */
     region: ScwRegion;
 }
 export interface Database {
-    /** UUID that uniquely identifies your Serverless SQL DB Database. */
+    /**
+     * UUID that uniquely identifies your Serverless SQL DB Database.
+     */
     id: string;
-    /** Name of the database. */
+    /**
+     * Name of the database.
+     */
     name: string;
     /**
-     * Status of the Serverless SQL Ddatabase. One of `unknown_status` | `ready` |
-     * `creating` | `deleting` | `error` | `restoring` | `locked`.
+     * Status of the Serverless SQL Ddatabase. One of `unknown_status` | `ready` | `creating` | `deleting` | `error` | `restoring` | `locked`.
      */
     status: DatabaseStatus;
-    /** Endpoint of the database. */
+    /**
+     * Endpoint of the database.
+     */
     endpoint: string;
-    /** The ID of your Scaleway organization. */
+    /**
+     * The ID of your Scaleway organization.
+     */
     organizationId: string;
-    /** Project ID the database belongs to. */
+    /**
+     * Project ID the database belongs to.
+     */
     projectId: string;
-    /** Region of the database. */
+    /**
+     * Region of the database.
+     */
     region: ScwRegion;
-    /** Creation date. */
+    /**
+     * Creation date.
+     */
     createdAt?: Date;
-    /** The minimum number of CPU units for your Serverless SQL Database. */
+    /**
+     * The minimum number of CPU units for your Serverless SQL Database.
+     */
     cpuMin: number;
-    /** The maximum number of CPU units for your Serverless SQL Database. */
+    /**
+     * The maximum number of CPU units for your Serverless SQL Database.
+     */
     cpuMax: number;
-    /** The current number of CPU units allocated to your Serverless SQL Database. */
+    /**
+     * The current number of CPU units allocated to your Serverless SQL Database.
+     */
     cpuCurrent: number;
-    /** Whether your Serverless SQL Database is running or not. */
+    /**
+     * Whether your Serverless SQL Database is running or not.
+     */
     started: boolean;
-    /** The major version of the underlying database engine. */
+    /**
+     * The major version of the underlying database engine.
+     */
     engineMajorVersion: number;
 }
 export type CreateDatabaseRequest = {
     /**
-     * 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;
-    /** The ID of your Scaleway project. */
+    /**
+     * The ID of your Scaleway project.
+     */
     projectId?: string;
-    /** The name of the Serverless SQL Database to be created. */
+    /**
+     * The name of the Serverless SQL Database to be created.
+     */
     name: string;
-    /** The minimum number of CPU units for your Serverless SQL Database. */
+    /**
+     * The minimum number of CPU units for your Serverless SQL Database.
+     */
     cpuMin: number;
-    /** The maximum number of CPU units for your Serverless SQL Database. */
+    /**
+     * The maximum number of CPU units for your Serverless SQL Database.
+     */
     cpuMax: number;
-    /** The ID of the backup to create the database from. */
+    /**
+     * The ID of the backup to create the database from.
+     */
     fromBackupId?: string;
 };
 export type DeleteDatabaseRequest = {
     /**
-     * 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;
-    /** UUID of the Serverless SQL Database. */
+    /**
+     * UUID of the Serverless SQL Database.
+     */
     databaseId: string;
 };
 export type ExportDatabaseBackupRequest = {
     /**
-     * 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;
-    /** UUID of the Serverless SQL Database backup. */
+    /**
+     * UUID of the Serverless SQL Database backup.
+     */
     backupId: string;
 };
 export type GetDatabaseBackupRequest = {
     /**
-     * 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;
-    /** UUID of the Serverless SQL Database backup. */
+    /**
+     * UUID of the Serverless SQL Database backup.
+     */
     backupId: string;
 };
 export type GetDatabaseRequest = {
     /**
-     * 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;
-    /** UUID of the Serverless SQL DB database. */
+    /**
+     * UUID of the Serverless SQL DB database.
+     */
     databaseId: string;
 };
 export type ListDatabaseBackupsRequest = {
     /**
-     * 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;
-    /** Filter by the UUID of the Scaleway organization. */
+    /**
+     * Filter by the UUID of the Scaleway organization.
+     */
     organizationId?: string;
-    /** Filter by the UUID of the Scaleway project. */
+    /**
+     * Filter by the UUID of the Scaleway project.
+     */
     projectId?: string;
-    /** Filter by the UUID of the Serverless SQL Database. */
+    /**
+     * Filter by the UUID of the Serverless SQL Database.
+     */
     databaseId: string;
-    /** Page number. */
+    /**
+     * Page number.
+     */
     page?: number;
-    /** Page size. */
+    /**
+     * Page size.
+     */
     pageSize?: number;
-    /** Sorting criteria. One of `created_at_asc`, `created_at_desc`. */
+    /**
+     * Sorting criteria. One of `created_at_asc`, `created_at_desc`.
+     */
     orderBy?: ListDatabaseBackupsRequestOrderBy;
 };
 export interface ListDatabaseBackupsResponse {
-    /** List of the backups. */
+    /**
+     * List of the backups.
+     */
     backups: DatabaseBackup[];
-    /** Length of the backups list. */
+    /**
+     * Length of the backups list.
+     */
     totalCount: number;
 }
 export type ListDatabasesRequest = {
     /**
-     * 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;
-    /** Filter by the UUID of the Scaleway organization. */
+    /**
+     * Filter by the UUID of the Scaleway organization.
+     */
     organizationId?: string;
-    /** UUID of the Scaleway project. */
+    /**
+     * UUID of the Scaleway project.
+     */
     projectId?: string;
-    /** Page number. */
+    /**
+     * Page number.
+     */
     page?: number;
-    /** Page size. */
+    /**
+     * Page size.
+     */
     pageSize?: number;
-    /** Filter by the name of the database. */
+    /**
+     * Filter by the name of the database.
+     */
     name?: string;
     /**
-     * Sorting criteria. One of `created_at_asc`, `created_at_desc`, `name_asc`,
-     * `name_desc`.
+     * Sorting criteria. One of `created_at_asc`, `created_at_desc`, `name_asc`, `name_desc`.
      */
     orderBy?: ListDatabasesRequestOrderBy;
 };
 export interface ListDatabasesResponse {
-    /** List of the databases. */
+    /**
+     * List of the databases.
+     */
     databases: Database[];
-    /** Total count of Serverless SQL Databases. */
+    /**
+     * Total count of Serverless SQL Databases.
+     */
     totalCount: number;
 }
 export type RestoreDatabaseFromBackupRequest = {
     /**
-     * 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;
-    /** UUID of the Serverless SQL Database. */
+    /**
+     * UUID of the Serverless SQL Database.
+     */
     databaseId: string;
-    /** UUID of the Serverless SQL Database backup to restore. */
+    /**
+     * UUID of the Serverless SQL Database backup to restore.
+     */
     backupId: string;
 };
 export type UpdateDatabaseRequest = {
     /**
-     * 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;
-    /** UUID of the Serverless SQL Database. */
+    /**
+     * UUID of the Serverless SQL Database.
+     */
     databaseId: string;
-    /** The minimum number of CPU units for your Serverless SQL Database. */
+    /**
+     * The minimum number of CPU units for your Serverless SQL Database.
+     */
     cpuMin?: number;
-    /** The maximum number of CPU units for your Serverless SQL Database. */
+    /**
+     * The maximum number of CPU units for your Serverless SQL Database.
+     */
     cpuMax?: number;
 };

package/dist/api/tem/index.gen.d.ts

@@ -1,5 +1,5 @@
 /**
- * This file is automatically generated from /scripts/generate.js PLEASE DO NOT
- * EDIT HERE
+ * This file is automatically generated from /scripts/generate.js
+ * PLEASE DO NOT EDIT HERE
  */
 export * as v1alpha1 from './v1alpha1/index.gen.js';

package/dist/api/tem/v1alpha1/api.gen.cjs

@@ -1,10 +1,11 @@
 "use strict";
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const intervalRetrier = require("../../../internal/async/interval-retrier.cjs");
-const api = require("../../../scw/api.cjs");
-const marshalling = require("../../../helpers/marshalling.cjs");
-require("../../../vendor/base64/index.cjs");
-const resourcePaginator = require("../../../scw/fetch/resource-paginator.cjs");
+require("../../../client/dist/internal/logger/index.cjs");
+const intervalRetrier = require("../../../client/dist/internal/async/interval-retrier.cjs");
+const api = require("../../../client/dist/scw/api.cjs");
+const marshalling = require("../../../client/dist/helpers/marshalling.cjs");
+require("../../../client/dist/vendor/base64/index.cjs");
+const resourcePaginator = require("../../../client/dist/scw/fetch/resource-paginator.cjs");
 const content_gen = require("./content.gen.cjs");
 const marshalling_gen = require("./marshalling.gen.cjs");
 const jsonContentHeaders = {
@@ -14,10 +15,7 @@ class API extends api.API {
   /** Lists the available regions of the API. */
   static LOCALITIES = ["fr-par"];
   /**
-   * Send an email. You must specify the `region`, the sender and the
-   * recipient's information and the `project_id` to send an email from a
-   * checked domain. The subject of the email must contain at least 6
-   * characters.
+   * Send an email. You must specify the `region`, the sender and the recipient's information and the `project_id` to send an email from a checked domain. The subject of the email must contain at least 6 characters.
    *
    * @param request - The request {@link CreateEmailRequest}
    * @returns A Promise of CreateEmailResponse
@@ -34,8 +32,7 @@ class API extends api.API {
     marshalling_gen.unmarshalCreateEmailResponse
   );
   /**
-   * Get an email. Retrieve information about a specific email using the
-   * `email_id` and `region` parameters.
+   * Get an email. Retrieve information about a specific email using the `email_id` and `region` parameters.
    *
    * @param request - The request {@link GetEmailRequest}
    * @returns A Promise of Email
@@ -88,8 +85,7 @@ class API extends api.API {
     marshalling_gen.unmarshalListEmailsResponse
   );
   /**
-   * List emails. Retrieve the list of emails sent from a specific domain or for
-   * a specific Project or Organization. You must specify the `region`.
+   * List emails. Retrieve the list of emails sent from a specific domain or for a specific Project or Organization. You must specify the `region`.
    *
    * @param request - The request {@link ListEmailsRequest}
    * @returns A Promise of ListEmailsResponse
@@ -116,9 +112,7 @@ class API extends api.API {
     marshalling_gen.unmarshalStatistics
   );
   /**
-   * Cancel an email. You can cancel the sending of an email if it has not been
-   * sent yet. You must specify the `region` and the `email_id` of the email you
-   * want to cancel.
+   * Cancel an email. You can cancel the sending of an email if it has not been sent yet. You must specify the `region` and the `email_id` of the email you want to cancel.
    *
    * @param request - The request {@link CancelEmailRequest}
    * @returns A Promise of Email
@@ -133,8 +127,7 @@ class API extends api.API {
     marshalling_gen.unmarshalEmail
   );
   /**
-   * Register a domain in a project. You must specify the `region`, `project_id`
-   * and `domain_name` to register a domain in a specific Project.
+   * Register a domain in a project. You must specify the `region`, `project_id` and `domain_name` to register a domain in a specific Project.
    *
    * @param request - The request {@link CreateDomainRequest}
    * @returns A Promise of Domain
@@ -151,14 +144,7 @@ class API extends api.API {
     marshalling_gen.unmarshalDomain
   );
   /**
-   * Get information about a domain. Retrieve information about a specific
-   * domain using the `region` and `domain_id` parameters. Monitor your domain's
-   * reputation and improve **average** and **bad** reputation statuses, using
-   * your domain's **Email activity** tab on the [Scaleway
-   * console](https://console.scaleway.com/transactional-email/domains) to get a
-   * more detailed report. Check out our [dedicated
-   * documentation](https://www.scaleway.com/en/docs/managed-services/transactional-email/reference-content/understanding-tem-reputation-score/)
-   * to improve your domain's reputation.
+   * Get information about a domain. Retrieve information about a specific domain using the `region` and `domain_id` parameters. Monitor your domain's reputation and improve **average** and **bad** reputation statuses, using your domain's **Email activity** tab on the [Scaleway console](https://console.scaleway.com/transactional-email/domains) to get a more detailed report. Check out our [dedicated documentation](https://www.scaleway.com/en/docs/managed-services/transactional-email/reference-content/understanding-tem-reputation-score/) to improve your domain's reputation.
    *
    * @param request - The request {@link GetDomainRequest}
    * @returns A Promise of Domain
@@ -202,17 +188,14 @@ class API extends api.API {
     marshalling_gen.unmarshalListDomainsResponse
   );
   /**
-   * List domains. Retrieve domains in a specific Project or in a specific
-   * Organization using the `region` parameter.
+   * List domains. Retrieve domains in a specific Project or in a specific Organization using the `region` parameter.
    *
    * @param request - The request {@link ListDomainsRequest}
    * @returns A Promise of ListDomainsResponse
    */
   listDomains = (request = {}) => resourcePaginator.enrichForPagination("domains", this.pageOfListDomains, request);
   /**
-   * Delete a domain. You must specify the domain you want to delete by the
-   * `region` and `domain_id`. Deleting a domain is permanent and cannot be
-   * undone.
+   * Delete a domain. You must specify the domain you want to delete by the `region` and `domain_id`. Deleting a domain is permanent and cannot be undone.
    *
    * @param request - The request {@link RevokeDomainRequest}
    * @returns A Promise of Domain
@@ -227,8 +210,7 @@ class API extends api.API {
     marshalling_gen.unmarshalDomain
   );
   /**
-   * Domain DNS check. Perform an immediate DNS check of a domain using the
-   * `region` and `domain_id` parameters.
+   * Domain DNS check. Perform an immediate DNS check of a domain using the `region` and `domain_id` parameters.
    *
    * @param request - The request {@link CheckDomainRequest}
    * @returns A Promise of Domain
@@ -243,9 +225,7 @@ class API extends api.API {
     marshalling_gen.unmarshalDomain
   );
   /**
-   * Display SPF and DKIM records status and potential errors. Display SPF and
-   * DKIM records status and potential errors, including the found records to
-   * make debugging easier.
+   * Display SPF and DKIM records status and potential errors. Display SPF and DKIM records status and potential errors, including the found records to make debugging easier.
    *
    * @param request - The request {@link GetDomainLastStatusRequest}
    * @returns A Promise of DomainLastStatus
@@ -275,8 +255,7 @@ class API extends api.API {
     marshalling_gen.unmarshalDomain
   );
   /**
-   * Create a Webhook. Create a new Webhook triggered by a list of event types
-   * and pushed to a Scaleway SNS ARN.
+   * 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
@@ -311,16 +290,14 @@ class API extends api.API {
     marshalling_gen.unmarshalListWebhooksResponse
   );
   /**
-   * List Webhooks. Retrieve Webhooks in a specific Project or in a specific
-   * Organization using the `region` parameter.
+   * List Webhooks. Retrieve Webhooks in a specific Project or in a specific Organization using the `region` parameter.
    *
    * @param request - The request {@link ListWebhooksRequest}
    * @returns A Promise of ListWebhooksResponse
    */
   listWebhooks = (request = {}) => resourcePaginator.enrichForPagination("webhooks", this.pageOfListWebhooks, request);
   /**
-   * Get information about a Webhook. Retrieve information about a specific
-   * Webhook using the `webhook_id` and `region` parameters.
+   * Get information about a Webhook. Retrieve information about a specific Webhook using the `webhook_id` and `region` parameters.
    *
    * @param request - The request {@link GetWebhookRequest}
    * @returns A Promise of Webhook
@@ -350,9 +327,7 @@ class API extends api.API {
     marshalling_gen.unmarshalWebhook
   );
   /**
-   * Delete a Webhook. You must specify the Webhook you want to delete by the
-   * `region` and `webhook_id`. Deleting a Webhook is permanent and cannot be
-   * undone.
+   * Delete a Webhook. You must specify the Webhook you want to delete by the `region` and `webhook_id`. Deleting a Webhook is permanent and cannot be undone.
    *
    * @param request - The request {@link DeleteWebhookRequest}
    */
@@ -382,17 +357,14 @@ class API extends api.API {
     marshalling_gen.unmarshalListWebhookEventsResponse
   );
   /**
-   * List Webhook triggered events. Retrieve the list of Webhook events
-   * triggered from a specific Webhook or for a specific Project or
-   * Organization. You must specify the `region`.
+   * List Webhook triggered events. Retrieve the list of Webhook events triggered from a specific Webhook or for a specific Project or Organization. You must specify the `region`.
    *
    * @param request - The request {@link ListWebhookEventsRequest}
    * @returns A Promise of ListWebhookEventsResponse
    */
   listWebhookEvents = (request) => resourcePaginator.enrichForPagination("webhookEvents", this.pageOfListWebhookEvents, request);
   /**
-   * List project settings. Retrieve the project settings including periodic
-   * reports.
+   * List project settings. Retrieve the project settings including periodic reports.
    *
    * @param request - The request {@link GetProjectSettingsRequest}
    * @returns A Promise of ProjectSettings
@@ -405,8 +377,7 @@ class API extends api.API {
     marshalling_gen.unmarshalProjectSettings
   );
   /**
-   * Update project settings. Update the project settings including periodic
-   * reports.
+   * Update project settings. Update the project settings including periodic reports.
    *
    * @param request - The request {@link UpdateProjectSettingsRequest}
    * @returns A Promise of ProjectSettings
@@ -449,8 +420,7 @@ class API extends api.API {
    */
   listBlocklists = (request) => resourcePaginator.enrichForPagination("blocklists", this.pageOfListBlocklists, request);
   /**
-   * Bulk create blocklists. Create multiple blocklists in a specific Project or
-   * Organization using the `region` parameter.
+   * Bulk create blocklists. Create multiple blocklists in a specific Project or Organization using the `region` parameter.
    *
    * @param request - The request {@link BulkCreateBlocklistsRequest}
    * @returns A Promise of BulkCreateBlocklistsResponse
@@ -467,8 +437,7 @@ class API extends api.API {
     marshalling_gen.unmarshalBulkCreateBlocklistsResponse
   );
   /**
-   * Delete a blocklist. You must specify the blocklist you want to delete by
-   * the `region` and `blocklist_id`.
+   * Delete a blocklist. You must specify the blocklist you want to delete by the `region` and `blocklist_id`.
    *
    * @param request - The request {@link DeleteBlocklistRequest}
    */
@@ -477,9 +446,7 @@ class API extends api.API {
     path: `/transactional-email/v1alpha1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/blocklists/${marshalling.validatePathParam("blocklistId", request.blocklistId)}`
   });
   /**
-   * Get information about subscribed offers. Retrieve information about the
-   * offers you are subscribed to using the `project_id` and `region`
-   * parameters.
+   * Get information about subscribed offers. Retrieve information about the offers you are subscribed to using the `project_id` and `region` parameters.
    *
    * @param request - The request {@link ListOfferSubscriptionsRequest}
    * @returns A Promise of ListOfferSubscriptionsResponse
@@ -513,8 +480,7 @@ class API extends api.API {
     marshalling_gen.unmarshalOfferSubscription
   );
   /**
-   * List the available offers.. Retrieve the list of the available and
-   * free-of-charge offers you can subscribe to.
+   * List the available offers.. Retrieve the list of the available and free-of-charge offers you can subscribe to.
    *
    * @param request - The request {@link ListOffersRequest}
    * @returns A Promise of ListOffersResponse
@@ -545,8 +511,7 @@ class API extends api.API {
     marshalling_gen.unmarshalListPoolsResponse
   );
   /**
-   * Get information about a sending pool.. Retrieve information about a sending
-   * pool, including its creation status and configuration parameters.
+   * Get information about a sending pool.. Retrieve information about a sending pool, including its creation status and configuration parameters.
    *
    * @param request - The request {@link ListPoolsRequest}
    * @returns A Promise of ListPoolsResponse