@scaleway/sdk 2.72.0 → 2.73.0

package/dist/api/marketplace/v2/api.gen.js

@@ -24,16 +24,14 @@ class API extends API$1 {
     unmarshalListImagesResponse
   );
   /**
-   * List marketplace images. List all available images on the marketplace,
-   * their UUID, CPU architecture and description.
+   * List marketplace images. List all available images on the marketplace, their UUID, CPU architecture and description.
    *
    * @param request - The request {@link ListImagesRequest}
    * @returns A Promise of ListImagesResponse
    */
   listImages = (request) => enrichForPagination("images", this.pageOfListImages, request);
   /**
-   * Get a specific marketplace image. Get detailed information about a
-   * marketplace image, specified by its `image_id` (UUID format).
+   * Get a specific marketplace image. Get detailed information about a marketplace image, specified by its `image_id` (UUID format).
    *
    * @param request - The request {@link GetImageRequest}
    * @returns A Promise of Image
@@ -62,17 +60,14 @@ class API extends API$1 {
     unmarshalListVersionsResponse
   );
   /**
-   * List versions of an Image. Get a list of all available version of an image,
-   * specified by its `image_id` (UUID format).
+   * List versions of an Image. Get a list of all available version of an image, specified by its `image_id` (UUID format).
    *
    * @param request - The request {@link ListVersionsRequest}
    * @returns A Promise of ListVersionsResponse
    */
   listVersions = (request) => enrichForPagination("versions", this.pageOfListVersions, request);
   /**
-   * Get a specific image version. Get information such as the name, creation
-   * date, last update and published date for an image version specified by its
-   * `version_id` (UUID format).
+   * Get a specific image version. Get information such as the name, creation date, last update and published date for an image version specified by its `version_id` (UUID format).
    *
    * @param request - The request {@link GetVersionRequest}
    * @returns A Promise of Version
@@ -109,20 +104,14 @@ class API extends API$1 {
     unmarshalListLocalImagesResponse
   );
   /**
-   * List local images from a specific image or version. List information about
-   * local images in a specific Availability Zone, specified by its `image_id`
-   * (UUID format), `version_id` (UUID format) or `image_label`. Only one of
-   * these three parameters may be set.
+   * List local images from a specific image or version. List information about local images in a specific Availability Zone, specified by its `image_id` (UUID format), `version_id` (UUID format) or `image_label`. Only one of these three parameters may be set.
    *
    * @param request - The request {@link ListLocalImagesRequest}
    * @returns A Promise of ListLocalImagesResponse
    */
   listLocalImages = (request = {}) => enrichForPagination("localImages", this.pageOfListLocalImages, request);
   /**
-   * Get a specific local image by ID. Get detailed information about a local
-   * image, including compatible commercial types, supported architecture,
-   * labels and the Availability Zone of the image, specified by its
-   * `local_image_id` (UUID format).
+   * Get a specific local image by ID. Get detailed information about a local image, including compatible commercial types, supported architecture, labels and the Availability Zone of the image, specified by its `local_image_id` (UUID format).
    *
    * @param request - The request {@link GetLocalImageRequest}
    * @returns A Promise of LocalImage
@@ -149,16 +138,14 @@ class API extends API$1 {
     unmarshalListCategoriesResponse
   );
   /**
-   * List existing image categories. Get a list of all existing categories. The
-   * output can be paginated.
+   * List existing image categories. Get a list of all existing categories. The output can be paginated.
    *
    * @param request - The request {@link ListCategoriesRequest}
    * @returns A Promise of ListCategoriesResponse
    */
   listCategories = (request = {}) => enrichForPagination("categories", this.pageOfListCategories, request);
   /**
-   * Get a specific category. Get information about a specific category of the
-   * marketplace catalog, specified by its `category_id` (UUID format).
+   * Get a specific category. Get information about a specific category of the marketplace catalog, specified by its `category_id` (UUID format).
    *
    * @param request - The request {@link GetCategoryRequest}
    * @returns A Promise of Category

package/dist/api/marketplace/v2/types.gen.d.ts

@@ -9,59 +9,99 @@ export interface Category {
     description: string;
 }
 export interface Image {
-    /** UUID of this image. */
+    /**
+     * UUID of this image.
+     */
     id: string;
-    /** Name of the image. */
+    /**
+     * Name of the image.
+     */
     name: string;
-    /** Text description of this image. */
+    /**
+     * Text description of this image.
+     */
     description: string;
-    /** URL of this image's logo. */
+    /**
+     * URL of this image's logo.
+     */
     logo: string;
-    /** List of categories this image belongs to. */
+    /**
+     * List of categories this image belongs to.
+     */
     categories: string[];
-    /** Creation date of this image. */
+    /**
+     * Creation date of this image.
+     */
     createdAt?: Date;
-    /** Date of the last modification of this image. */
+    /**
+     * Date of the last modification of this image.
+     */
     updatedAt?: Date;
-    /** Expiration date of this image. */
+    /**
+     * Expiration date of this image.
+     */
     validUntil?: Date;
     /**
-     * Typically an identifier for a distribution (ex. "ubuntu_focal"). This label
-     * can be used in the image field of the server creation request.
+     * Typically an identifier for a distribution (ex. "ubuntu_focal").
+  This label can be used in the image field of the server creation request.
      */
     label: string;
 }
 export interface LocalImage {
-    /** Version you will typically use to define an image in an API call. */
+    /**
+     * Version you will typically use to define an image in an API call.
+     */
     id: string;
-    /** List of all commercial types that are compatible with this local image. */
+    /**
+     * List of all commercial types that are compatible with this local image.
+     */
     compatibleCommercialTypes: string[];
-    /** Supported architecture for this local image. */
+    /**
+     * Supported architecture for this local image.
+     */
     arch: string;
-    /** Availability Zone where this local image is available. */
+    /**
+     * Availability Zone where this local image is available.
+     */
     zone: ScwZone;
-    /** This label can be used in the image field of the server creation request. */
+    /**
+     * This label can be used in the image field of the server creation request.
+     */
     label: string;
-    /** Type of this local image. */
+    /**
+     * Type of this local image.
+     */
     type: LocalImageType;
 }
 export interface Version {
-    /** UUID of this version. */
+    /**
+     * UUID of this version.
+     */
     id: string;
-    /** Name of this version. */
+    /**
+     * Name of this version.
+     */
     name: string;
-    /** Creation date of this image version. */
+    /**
+     * Creation date of this image version.
+     */
     createdAt?: Date;
-    /** Date of the last modification of this version. */
+    /**
+     * Date of the last modification of this version.
+     */
     updatedAt?: Date;
-    /** Date this version was officially published. */
+    /**
+     * Date this version was officially published.
+     */
     publishedAt?: Date;
 }
 export type GetCategoryRequest = {
     categoryId: string;
 };
 export type GetImageRequest = {
-    /** Display the image name. */
+    /**
+     * Display the image name.
+     */
     imageId: string;
 };
 export type GetLocalImageRequest = {
@@ -80,19 +120,28 @@ export interface ListCategoriesResponse {
 }
 export type ListImagesRequest = {
     /**
-     * A positive integer lower or equal to 100 to select the number of items to
-     * display.
+     * A positive integer lower or equal to 100 to select the number of items to display.
      */
     pageSize?: number;
-    /** A positive integer to choose the page to display. */
+    /**
+     * A positive integer to choose the page to display.
+     */
     page?: number;
-    /** Ordering to use. */
+    /**
+     * Ordering to use.
+     */
     orderBy?: ListImagesRequestOrderBy;
-    /** Choose for which machine architecture to return images. */
+    /**
+     * Choose for which machine architecture to return images.
+     */
     arch?: string;
-    /** Choose the category of images to get. */
+    /**
+     * Choose the category of images to get.
+     */
     category?: string;
-    /** Choose to include end-of-life images. */
+    /**
+     * Choose to include end-of-life images.
+     */
     includeEol: boolean;
 };
 export interface ListImagesResponse {
@@ -101,38 +150,42 @@ export interface ListImagesResponse {
 }
 export type ListLocalImagesRequest = {
     /**
-     * A positive integer lower or equal to 100 to select the number of items to
-     * display.
+     * A positive integer lower or equal to 100 to select the number of items to display.
      */
     pageSize?: number;
-    /** A positive integer to choose the page to display. */
+    /**
+     * A positive integer to choose the page to display.
+     */
     page?: number;
-    /** Ordering to use. */
+    /**
+     * Ordering to use.
+     */
     orderBy?: ListLocalImagesRequestOrderBy;
-    /** Filter local images available on this Availability Zone. */
+    /**
+     * Filter local images available on this Availability Zone.
+     */
     zone?: ScwZone;
     /**
      * Filter by image id.
      *
-     * One-of ('scope'): at most one of 'imageId', 'versionId', 'imageLabel' could
-     * be set.
+     * One-of ('scope'): at most one of 'imageId', 'versionId', 'imageLabel' could be set.
      */
     imageId?: string;
     /**
      * Filter by version id.
      *
-     * One-of ('scope'): at most one of 'imageId', 'versionId', 'imageLabel' could
-     * be set.
+     * One-of ('scope'): at most one of 'imageId', 'versionId', 'imageLabel' could be set.
      */
     versionId?: string;
     /**
      * Filter by image label.
      *
-     * One-of ('scope'): at most one of 'imageId', 'versionId', 'imageLabel' could
-     * be set.
+     * One-of ('scope'): at most one of 'imageId', 'versionId', 'imageLabel' could be set.
      */
     imageLabel?: string;
-    /** Filter by type. */
+    /**
+     * Filter by type.
+     */
     type?: LocalImageType;
 };
 export interface ListLocalImagesResponse {

package/dist/api/mnq/v1beta1/api.gen.cjs

@@ -30,10 +30,7 @@ class NatsAPI extends api.API {
     marshalling_gen.unmarshalNatsAccount
   );
   /**
-   * Delete a NATS account. Delete a NATS account, specified by its NATS account
-   * ID. Note that deleting a NATS account is irreversible, and any credentials,
-   * streams, consumer and stored messages belonging to this NATS account will
-   * also be deleted.
+   * Delete a NATS account. Delete a NATS account, specified by its NATS account ID. Note that deleting a NATS account is irreversible, and any credentials, streams, consumer and stored messages belonging to this NATS account will also be deleted.
    *
    * @param request - The request {@link NatsApiDeleteNatsAccountRequest}
    */
@@ -42,8 +39,7 @@ class NatsAPI extends api.API {
     path: `/mnq/v1beta1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/nats-accounts/${marshalling.validatePathParam("natsAccountId", request.natsAccountId)}`
   });
   /**
-   * Update the name of a NATS account. Update the name of a NATS account,
-   * specified by its NATS account ID.
+   * Update the name of a NATS account. Update the name of a NATS account, specified by its NATS account ID.
    *
    * @param request - The request {@link NatsApiUpdateNatsAccountRequest}
    * @returns A Promise of NatsAccount
@@ -60,9 +56,7 @@ class NatsAPI extends api.API {
     marshalling_gen.unmarshalNatsAccount
   );
   /**
-   * Get a NATS account. Retrieve information about an existing NATS account
-   * identified by its NATS account ID. Its full details, including name and
-   * endpoint, are returned in the response.
+   * Get a NATS account. Retrieve information about an existing NATS account identified by its NATS account ID. Its full details, including name and endpoint, are returned in the response.
    *
    * @param request - The request {@link NatsApiGetNatsAccountRequest}
    * @returns A Promise of NatsAccount
@@ -91,18 +85,14 @@ class NatsAPI extends api.API {
     marshalling_gen.unmarshalListNatsAccountsResponse
   );
   /**
-   * List NATS accounts. List all NATS accounts in the specified region, for a
-   * Scaleway Organization or Project. By default, the NATS accounts returned in
-   * the list are ordered by creation date in ascending order, though this can
-   * be modified via the `order_by` field.
+   * List NATS accounts. List all NATS accounts in the specified region, for a Scaleway Organization or Project. By default, the NATS accounts returned in the list are ordered by creation date in ascending order, though this can be modified via the `order_by` field.
    *
    * @param request - The request {@link NatsApiListNatsAccountsRequest}
    * @returns A Promise of ListNatsAccountsResponse
    */
   listNatsAccounts = (request = {}) => resourcePaginator.enrichForPagination("natsAccounts", this.pageOfListNatsAccounts, request);
   /**
-   * Create NATS credentials. Create a set of credentials for a NATS account,
-   * specified by its NATS account ID.
+   * Create NATS credentials. Create a set of credentials for a NATS account, specified by its NATS account ID.
    *
    * @param request - The request {@link NatsApiCreateNatsCredentialsRequest}
    * @returns A Promise of NatsCredentials
@@ -122,10 +112,7 @@ class NatsAPI extends api.API {
     marshalling_gen.unmarshalNatsCredentials
   );
   /**
-   * Delete NATS credentials. Delete a set of credentials, specified by their
-   * credentials ID. Deleting credentials is irreversible and cannot be undone.
-   * The credentials can no longer be used to access the NATS account, and
-   * active connections using this credentials will be closed.
+   * Delete NATS credentials. Delete a set of credentials, specified by their credentials ID. Deleting credentials is irreversible and cannot be undone. The credentials can no longer be used to access the NATS account, and active connections using this credentials will be closed.
    *
    * @param request - The request {@link NatsApiDeleteNatsCredentialsRequest}
    */
@@ -134,10 +121,7 @@ class NatsAPI extends api.API {
     path: `/mnq/v1beta1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/nats-credentials/${marshalling.validatePathParam("natsCredentialsId", request.natsCredentialsId)}`
   });
   /**
-   * Get NATS credentials. Retrieve an existing set of credentials, identified
-   * by the `nats_credentials_id`. The credentials themselves are NOT returned,
-   * only their metadata (NATS account ID, credentials name, etc), are returned
-   * in the response.
+   * Get NATS credentials. Retrieve an existing set of credentials, identified by the `nats_credentials_id`. The credentials themselves are NOT returned, only their metadata (NATS account ID, credentials name, etc), are returned in the response.
    *
    * @param request - The request {@link NatsApiGetNatsCredentialsRequest}
    * @returns A Promise of NatsCredentials
@@ -167,10 +151,7 @@ class NatsAPI extends api.API {
     marshalling_gen.unmarshalListNatsCredentialsResponse
   );
   /**
-   * List NATS credentials. List existing credentials in the specified NATS
-   * account. The response contains only the metadata for the credentials, not
-   * the credentials themselves, which are only returned after a **Create
-   * Credentials** call.
+   * List NATS credentials. List existing credentials in the specified NATS account. The response contains only the metadata for the credentials, not the credentials themselves, which are only returned after a **Create Credentials** call.
    *
    * @param request - The request {@link NatsApiListNatsCredentialsRequest}
    * @returns A Promise of ListNatsCredentialsResponse
@@ -185,10 +166,7 @@ class SnsAPI extends api.API {
   /** Lists the available regions of the API. */
   static LOCALITIES = ["fr-par", "nl-ams"];
   /**
-   * Activate Topics and Events. Activate Topics and Events for the specified
-   * Project ID. Topics and Events must be activated before any usage.
-   * Activating Topics and Events does not trigger any billing, and you can
-   * deactivate at any time.
+   * Activate Topics and Events. Activate Topics and Events for the specified Project ID. Topics and Events must be activated before any usage. Activating Topics and Events does not trigger any billing, and you can deactivate at any time.
    *
    * @param request - The request {@link SnsApiActivateSnsRequest}
    * @returns A Promise of SnsInfo
@@ -205,9 +183,7 @@ class SnsAPI extends api.API {
     marshalling_gen.unmarshalSnsInfo
   );
   /**
-   * Get Topics and Events info. Retrieve the Topics and Events information of
-   * the specified Project ID. Informations include the activation status and
-   * the Topics and Events API endpoint URL.
+   * Get Topics and Events info. Retrieve the Topics and Events information of the specified Project ID. Informations include the activation status and the Topics and Events API endpoint URL.
    *
    * @param request - The request {@link SnsApiGetSnsInfoRequest}
    * @returns A Promise of SnsInfo
@@ -224,9 +200,7 @@ class SnsAPI extends api.API {
     marshalling_gen.unmarshalSnsInfo
   );
   /**
-   * Deactivate Topics and Events. Deactivate Topics and Events for the
-   * specified Project ID. You must delete all topics and credentials before
-   * this call or you need to set the force_delete parameter.
+   * Deactivate Topics and Events. Deactivate Topics and Events for the specified Project ID. You must delete all topics and credentials before this call or you need to set the force_delete parameter.
    *
    * @param request - The request {@link SnsApiDeactivateSnsRequest}
    * @returns A Promise of SnsInfo
@@ -243,9 +217,7 @@ class SnsAPI extends api.API {
     marshalling_gen.unmarshalSnsInfo
   );
   /**
-   * Create Topics and Events credentials. Create a set of credentials for
-   * Topics and Events, specified by a Project ID. Credentials give the bearer
-   * access to topics, and the level of permissions can be defined granularly.
+   * Create Topics and Events credentials. Create a set of credentials for Topics and Events, specified by a Project ID. Credentials give the bearer access to topics, and the level of permissions can be defined granularly.
    *
    * @param request - The request {@link SnsApiCreateSnsCredentialsRequest}
    * @returns A Promise of SnsCredentials
@@ -265,10 +237,7 @@ class SnsAPI extends api.API {
     marshalling_gen.unmarshalSnsCredentials
   );
   /**
-   * Delete Topics and Events credentials. Delete a set of Topics and Events
-   * credentials, specified by their credentials ID. Deleting credentials is
-   * irreversible and cannot be undone. The credentials can then no longer be
-   * used to access Topics and Events.
+   * Delete Topics and Events credentials. Delete a set of Topics and Events credentials, specified by their credentials ID. Deleting credentials is irreversible and cannot be undone. The credentials can then no longer be used to access Topics and Events.
    *
    * @param request - The request {@link SnsApiDeleteSnsCredentialsRequest}
    */
@@ -277,8 +246,7 @@ class SnsAPI extends api.API {
     path: `/mnq/v1beta1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/sns-credentials/${marshalling.validatePathParam("snsCredentialsId", request.snsCredentialsId)}`
   });
   /**
-   * Update Topics and Events credentials. Update a set of Topics and Events
-   * credentials. You can update the credentials' name, or their permissions.
+   * Update Topics and Events credentials. Update a set of Topics and Events credentials. You can update the credentials' name, or their permissions.
    *
    * @param request - The request {@link SnsApiUpdateSnsCredentialsRequest}
    * @returns A Promise of SnsCredentials
@@ -298,9 +266,7 @@ class SnsAPI extends api.API {
     marshalling_gen.unmarshalSnsCredentials
   );
   /**
-   * Get Topics and Events credentials. Retrieve an existing set of credentials,
-   * identified by the `credentials_id`. The credentials themselves, as well as
-   * their metadata (name, project ID etc), are returned in the response.
+   * Get Topics and Events credentials. Retrieve an existing set of credentials, identified by the `credentials_id`. The credentials themselves, as well as their metadata (name, project ID etc), are returned in the response.
    *
    * @param request - The request {@link SnsApiGetSnsCredentialsRequest}
    * @returns A Promise of SnsCredentials
@@ -329,9 +295,7 @@ class SnsAPI extends api.API {
     marshalling_gen.unmarshalListSnsCredentialsResponse
   );
   /**
-   * List Topics and Events credentials. List existing Topics and Events
-   * credentials in the specified region. The response contains only the
-   * metadata for the credentials, not the credentials themselves.
+   * List Topics and Events credentials. List existing Topics and Events credentials in the specified region. The response contains only the metadata for the credentials, not the credentials themselves.
    *
    * @param request - The request {@link SnsApiListSnsCredentialsRequest}
    * @returns A Promise of ListSnsCredentialsResponse
@@ -346,10 +310,7 @@ class SqsAPI extends api.API {
   /** Lists the available regions of the API. */
   static LOCALITIES = ["fr-par", "nl-ams"];
   /**
-   * Activate Queues. Activate Queues for the specified Project ID. Queues must
-   * be activated before any usage such as creating credentials and queues.
-   * Activating Queues does not trigger any billing, and you can deactivate at
-   * any time.
+   * Activate Queues. Activate Queues for the specified Project ID. Queues must be activated before any usage such as creating credentials and queues. Activating Queues does not trigger any billing, and you can deactivate at any time.
    *
    * @param request - The request {@link SqsApiActivateSqsRequest}
    * @returns A Promise of SqsInfo
@@ -366,9 +327,7 @@ class SqsAPI extends api.API {
     marshalling_gen.unmarshalSqsInfo
   );
   /**
-   * Get Queues info. Retrieve the Queues information of the specified Project
-   * ID. Informations include the activation status and the Queues API endpoint
-   * URL.
+   * Get Queues info. Retrieve the Queues information of the specified Project ID. Informations include the activation status and the Queues API endpoint URL.
    *
    * @param request - The request {@link SqsApiGetSqsInfoRequest}
    * @returns A Promise of SqsInfo
@@ -385,9 +344,7 @@ class SqsAPI extends api.API {
     marshalling_gen.unmarshalSqsInfo
   );
   /**
-   * Deactivate Queues. Deactivate Queues for the specified Project ID. You must
-   * delete all queues and credentials before this call or you need to set the
-   * force_delete parameter.
+   * Deactivate Queues. Deactivate Queues for the specified Project ID. You must delete all queues and credentials before this call or you need to set the force_delete parameter.
    *
    * @param request - The request {@link SqsApiDeactivateSqsRequest}
    * @returns A Promise of SqsInfo
@@ -404,9 +361,7 @@ class SqsAPI extends api.API {
     marshalling_gen.unmarshalSqsInfo
   );
   /**
-   * Create Queues credentials. Create a set of credentials for Queues,
-   * specified by a Project ID. Credentials give the bearer access to queues,
-   * and the level of permissions can be defined granularly.
+   * Create Queues credentials. Create a set of credentials for Queues, specified by a Project ID. Credentials give the bearer access to queues, and the level of permissions can be defined granularly.
    *
    * @param request - The request {@link SqsApiCreateSqsCredentialsRequest}
    * @returns A Promise of SqsCredentials
@@ -426,9 +381,7 @@ class SqsAPI extends api.API {
     marshalling_gen.unmarshalSqsCredentials
   );
   /**
-   * Delete Queues credentials. Delete a set of Queues credentials, specified by
-   * their credentials ID. Deleting credentials is irreversible and cannot be
-   * undone. The credentials can then no longer be used to access Queues.
+   * Delete Queues credentials. Delete a set of Queues credentials, specified by their credentials ID. Deleting credentials is irreversible and cannot be undone. The credentials can then no longer be used to access Queues.
    *
    * @param request - The request {@link SqsApiDeleteSqsCredentialsRequest}
    */
@@ -437,8 +390,7 @@ class SqsAPI extends api.API {
     path: `/mnq/v1beta1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/sqs-credentials/${marshalling.validatePathParam("sqsCredentialsId", request.sqsCredentialsId)}`
   });
   /**
-   * Update Queues credentials. Update a set of Queues credentials. You can
-   * update the credentials' name, or their permissions.
+   * Update Queues credentials. Update a set of Queues credentials. You can update the credentials' name, or their permissions.
    *
    * @param request - The request {@link SqsApiUpdateSqsCredentialsRequest}
    * @returns A Promise of SqsCredentials
@@ -458,9 +410,7 @@ class SqsAPI extends api.API {
     marshalling_gen.unmarshalSqsCredentials
   );
   /**
-   * Get Queues credentials. Retrieve an existing set of credentials, identified
-   * by the `credentials_id`. The credentials themselves, as well as their
-   * metadata (name, project ID etc), are returned in the response.
+   * Get Queues credentials. Retrieve an existing set of credentials, identified by the `credentials_id`. The credentials themselves, as well as their metadata (name, project ID etc), are returned in the response.
    *
    * @param request - The request {@link SqsApiGetSqsCredentialsRequest}
    * @returns A Promise of SqsCredentials
@@ -489,9 +439,7 @@ class SqsAPI extends api.API {
     marshalling_gen.unmarshalListSqsCredentialsResponse
   );
   /**
-   * List Queues credentials. List existing Queues credentials in the specified
-   * region. The response contains only the metadata for the credentials, not
-   * the credentials themselves.
+   * List Queues credentials. List existing Queues credentials in the specified region. The response contains only the metadata for the credentials, not the credentials themselves.
    *
    * @param request - The request {@link SqsApiListSqsCredentialsRequest}
    * @returns A Promise of ListSqsCredentialsResponse