@scaleway/sdk 2.72.0 → 2.73.0

package/dist/api/registry/v1/api.gen.cjs

@@ -37,21 +37,14 @@ class API extends api.API {
     marshalling_gen.unmarshalListNamespacesResponse
   );
   /**
-   * List namespaces. List all namespaces in a specified region. By default, the
-   * namespaces listed are ordered by creation date in ascending order. This can
-   * be modified via the order_by field. You can also define additional
-   * parameters for your query, such as the `instance_id` and `project_id`
-   * parameters.
+   * List namespaces. List all namespaces in a specified region. By default, the namespaces listed are ordered by creation date in ascending order. This can be modified via the order_by field. You can also define additional parameters for your query, such as the `instance_id` and `project_id` parameters.
    *
    * @param request - The request {@link ListNamespacesRequest}
    * @returns A Promise of ListNamespacesResponse
    */
   listNamespaces = (request = {}) => resourcePaginator.enrichForPagination("namespaces", this.pageOfListNamespaces, request);
   /**
-   * Get a namespace. Retrieve information about a given namespace, specified by
-   * its `namespace_id` and region. Full details about the namespace, such as
-   * `description`, `project_id`, `status`, `endpoint`, `is_public`, `size`, and
-   * `image_count` are returned in the response.
+   * Get a namespace. Retrieve information about a given namespace, specified by its `namespace_id` and region. Full details about the namespace, such as `description`, `project_id`, `status`, `endpoint`, `is_public`, `size`, and `image_count` are returned in the response.
    *
    * @param request - The request {@link GetNamespaceRequest}
    * @returns A Promise of Namespace
@@ -79,10 +72,7 @@ class API extends api.API {
     options
   );
   /**
-   * Create a namespace. Create a new Container Registry namespace. You must
-   * specify the namespace name and region in which you want it to be created.
-   * Optionally, you can specify the `project_id` and `is_public` in the request
-   * payload.
+   * Create a namespace. Create a new Container Registry namespace. You must specify the namespace name and region in which you want it to be created. Optionally, you can specify the `project_id` and `is_public` in the request payload.
    *
    * @param request - The request {@link CreateNamespaceRequest}
    * @returns A Promise of Namespace
@@ -99,9 +89,7 @@ class API extends api.API {
     marshalling_gen.unmarshalNamespace
   );
   /**
-   * Update a namespace. Update the parameters of a given namespace, specified
-   * by its `namespace_id` and `region`. You can update the `description` and
-   * `is_public` parameters.
+   * Update a namespace. Update the parameters of a given namespace, specified by its `namespace_id` and `region`. You can update the `description` and `is_public` parameters.
    *
    * @param request - The request {@link UpdateNamespaceRequest}
    * @returns A Promise of Namespace
@@ -118,9 +106,7 @@ class API extends api.API {
     marshalling_gen.unmarshalNamespace
   );
   /**
-   * Delete a namespace. Delete a given namespace. You must specify, in the
-   * endpoint, the `region` and `namespace_id` parameters of the namespace you
-   * want to delete.
+   * Delete a namespace. Delete a given namespace. You must specify, in the endpoint, the `region` and `namespace_id` parameters of the namespace you want to delete.
    *
    * @param request - The request {@link DeleteNamespaceRequest}
    * @returns A Promise of Namespace
@@ -152,20 +138,14 @@ class API extends api.API {
     marshalling_gen.unmarshalListImagesResponse
   );
   /**
-   * List images. List all images in a specified region. By default, the images
-   * listed are ordered by creation date in ascending order. This can be
-   * modified via the order_by field. You can also define additional parameters
-   * for your query, such as the `namespace_id` and `project_id` parameters.
+   * List images. List all images in a specified region. By default, the images listed are ordered by creation date in ascending order. This can be modified via the order_by field. You can also define additional parameters for your query, such as the `namespace_id` and `project_id` parameters.
    *
    * @param request - The request {@link ListImagesRequest}
    * @returns A Promise of ListImagesResponse
    */
   listImages = (request = {}) => resourcePaginator.enrichForPagination("images", this.pageOfListImages, request);
   /**
-   * Get an image. Retrieve information about a given container image, specified
-   * by its `image_id` and region. Full details about the image, such as `name`,
-   * `namespace_id`, `status`, `visibility`, and `size` are returned in the
-   * response.
+   * Get an image. Retrieve information about a given container image, specified by its `image_id` and region. Full details about the image, such as `name`, `namespace_id`, `status`, `visibility`, and `size` are returned in the response.
    *
    * @param request - The request {@link GetImageRequest}
    * @returns A Promise of Image
@@ -193,8 +173,7 @@ class API extends api.API {
     options
   );
   /**
-   * Update an image. Update the parameters of a given image, specified by its
-   * `image_id` and `region`. You can update the `visibility` parameter.
+   * Update an image. Update the parameters of a given image, specified by its `image_id` and `region`. You can update the `visibility` parameter.
    *
    * @param request - The request {@link UpdateImageRequest}
    * @returns A Promise of Image
@@ -211,8 +190,7 @@ class API extends api.API {
     marshalling_gen.unmarshalImage
   );
   /**
-   * Delete an image. Delete a given image. You must specify, in the endpoint,
-   * the `region` and `image_id` parameters of the image you want to delete.
+   * Delete an image. Delete a given image. You must specify, in the endpoint, the `region` and `image_id` parameters of the image you want to delete.
    *
    * @param request - The request {@link DeleteImageRequest}
    * @returns A Promise of Image
@@ -241,19 +219,14 @@ class API extends api.API {
     marshalling_gen.unmarshalListTagsResponse
   );
   /**
-   * List tags. List all tags for a given image, specified by region. By
-   * default, the tags listed are ordered by creation date in ascending order.
-   * This can be modified via the order_by field. You can also define additional
-   * parameters for your query, such as the `name`.
+   * List tags. List all tags for a given image, specified by region. By default, the tags listed are ordered by creation date in ascending order. This can be modified via the order_by field. You can also define additional parameters for your query, such as the `name`.
    *
    * @param request - The request {@link ListTagsRequest}
    * @returns A Promise of ListTagsResponse
    */
   listTags = (request) => resourcePaginator.enrichForPagination("tags", this.pageOfListTags, request);
   /**
-   * Get a tag. Retrieve information about a given image tag, specified by its
-   * `tag_id` and region. Full details about the tag, such as `name`,
-   * `image_id`, `status`, and `digest` are returned in the response.
+   * Get a tag. Retrieve information about a given image tag, specified by its `tag_id` and region. Full details about the tag, such as `name`, `image_id`, `status`, and `digest` are returned in the response.
    *
    * @param request - The request {@link GetTagRequest}
    * @returns A Promise of Tag
@@ -281,8 +254,7 @@ class API extends api.API {
     options
   );
   /**
-   * Delete a tag. Delete a given image tag. You must specify, in the endpoint,
-   * the `region` and `tag_id` parameters of the tag you want to delete.
+   * Delete a tag. Delete a given image tag. You must specify, in the endpoint, the `region` and `tag_id` parameters of the tag you want to delete.
    *
    * @param request - The request {@link DeleteTagRequest}
    * @returns A Promise of Tag

package/dist/api/registry/v1/api.gen.d.ts

@@ -3,19 +3,15 @@ import type { Region as ScwRegion, WaitForOptions } from '@scaleway/sdk-client';
 import type { CreateNamespaceRequest, DeleteImageRequest, DeleteNamespaceRequest, DeleteTagRequest, GetImageRequest, GetNamespaceRequest, GetTagRequest, Image, ListImagesRequest, ListImagesResponse, ListNamespacesRequest, ListNamespacesResponse, ListTagsRequest, ListTagsResponse, Namespace, Tag, UpdateImageRequest, UpdateNamespaceRequest } from './types.gen';
 /**
  * Container Registry API.
- *
- * This API allows you to manage your Container Registry resources.
+
+This API allows you to manage your Container Registry resources.
  */
 export declare class API extends ParentAPI {
     /** Lists the available regions of the API. */
     static readonly LOCALITIES: ScwRegion[];
     protected pageOfListNamespaces: (request?: Readonly<ListNamespacesRequest>) => Promise<ListNamespacesResponse>;
     /**
-     * List namespaces. List all namespaces in a specified region. By default, the
-     * namespaces listed are ordered by creation date in ascending order. This can
-     * be modified via the order_by field. You can also define additional
-     * parameters for your query, such as the `instance_id` and `project_id`
-     * parameters.
+     * List namespaces. List all namespaces in a specified region. By default, the namespaces listed are ordered by creation date in ascending order. This can be modified via the order_by field. You can also define additional parameters for your query, such as the `instance_id` and `project_id` parameters.
      *
      * @param request - The request {@link ListNamespacesRequest}
      * @returns A Promise of ListNamespacesResponse
@@ -25,10 +21,7 @@ export declare class API extends ParentAPI {
         [Symbol.asyncIterator]: () => AsyncGenerator<Namespace[], void, void>;
     };
     /**
-     * Get a namespace. Retrieve information about a given namespace, specified by
-     * its `namespace_id` and region. Full details about the namespace, such as
-     * `description`, `project_id`, `status`, `endpoint`, `is_public`, `size`, and
-     * `image_count` are returned in the response.
+     * Get a namespace. Retrieve information about a given namespace, specified by its `namespace_id` and region. Full details about the namespace, such as `description`, `project_id`, `status`, `endpoint`, `is_public`, `size`, and `image_count` are returned in the response.
      *
      * @param request - The request {@link GetNamespaceRequest}
      * @returns A Promise of Namespace
@@ -43,28 +36,21 @@ export declare class API extends ParentAPI {
      */
     waitForNamespace: (request: Readonly<GetNamespaceRequest>, options?: Readonly<WaitForOptions<Namespace>>) => Promise<Namespace>;
     /**
-     * Create a namespace. Create a new Container Registry namespace. You must
-     * specify the namespace name and region in which you want it to be created.
-     * Optionally, you can specify the `project_id` and `is_public` in the request
-     * payload.
+     * Create a namespace. Create a new Container Registry namespace. You must specify the namespace name and region in which you want it to be created. Optionally, you can specify the `project_id` and `is_public` in the request payload.
      *
      * @param request - The request {@link CreateNamespaceRequest}
      * @returns A Promise of Namespace
      */
     createNamespace: (request: Readonly<CreateNamespaceRequest>) => Promise<Namespace>;
     /**
-     * Update a namespace. Update the parameters of a given namespace, specified
-     * by its `namespace_id` and `region`. You can update the `description` and
-     * `is_public` parameters.
+     * Update a namespace. Update the parameters of a given namespace, specified by its `namespace_id` and `region`. You can update the `description` and `is_public` parameters.
      *
      * @param request - The request {@link UpdateNamespaceRequest}
      * @returns A Promise of Namespace
      */
     updateNamespace: (request: Readonly<UpdateNamespaceRequest>) => Promise<Namespace>;
     /**
-     * Delete a namespace. Delete a given namespace. You must specify, in the
-     * endpoint, the `region` and `namespace_id` parameters of the namespace you
-     * want to delete.
+     * Delete a namespace. Delete a given namespace. You must specify, in the endpoint, the `region` and `namespace_id` parameters of the namespace you want to delete.
      *
      * @param request - The request {@link DeleteNamespaceRequest}
      * @returns A Promise of Namespace
@@ -72,10 +58,7 @@ export declare class API extends ParentAPI {
     deleteNamespace: (request: Readonly<DeleteNamespaceRequest>) => Promise<Namespace>;
     protected pageOfListImages: (request?: Readonly<ListImagesRequest>) => Promise<ListImagesResponse>;
     /**
-     * List images. List all images in a specified region. By default, the images
-     * listed are ordered by creation date in ascending order. This can be
-     * modified via the order_by field. You can also define additional parameters
-     * for your query, such as the `namespace_id` and `project_id` parameters.
+     * List images. List all images in a specified region. By default, the images listed are ordered by creation date in ascending order. This can be modified via the order_by field. You can also define additional parameters for your query, such as the `namespace_id` and `project_id` parameters.
      *
      * @param request - The request {@link ListImagesRequest}
      * @returns A Promise of ListImagesResponse
@@ -85,10 +68,7 @@ export declare class API extends ParentAPI {
         [Symbol.asyncIterator]: () => AsyncGenerator<Image[], void, void>;
     };
     /**
-     * Get an image. Retrieve information about a given container image, specified
-     * by its `image_id` and region. Full details about the image, such as `name`,
-     * `namespace_id`, `status`, `visibility`, and `size` are returned in the
-     * response.
+     * Get an image. Retrieve information about a given container image, specified by its `image_id` and region. Full details about the image, such as `name`, `namespace_id`, `status`, `visibility`, and `size` are returned in the response.
      *
      * @param request - The request {@link GetImageRequest}
      * @returns A Promise of Image
@@ -103,16 +83,14 @@ export declare class API extends ParentAPI {
      */
     waitForImage: (request: Readonly<GetImageRequest>, options?: Readonly<WaitForOptions<Image>>) => Promise<Image>;
     /**
-     * Update an image. Update the parameters of a given image, specified by its
-     * `image_id` and `region`. You can update the `visibility` parameter.
+     * Update an image. Update the parameters of a given image, specified by its `image_id` and `region`. You can update the `visibility` parameter.
      *
      * @param request - The request {@link UpdateImageRequest}
      * @returns A Promise of Image
      */
     updateImage: (request: Readonly<UpdateImageRequest>) => Promise<Image>;
     /**
-     * Delete an image. Delete a given image. You must specify, in the endpoint,
-     * the `region` and `image_id` parameters of the image you want to delete.
+     * Delete an image. Delete a given image. You must specify, in the endpoint, the `region` and `image_id` parameters of the image you want to delete.
      *
      * @param request - The request {@link DeleteImageRequest}
      * @returns A Promise of Image
@@ -120,10 +98,7 @@ export declare class API extends ParentAPI {
     deleteImage: (request: Readonly<DeleteImageRequest>) => Promise<Image>;
     protected pageOfListTags: (request: Readonly<ListTagsRequest>) => Promise<ListTagsResponse>;
     /**
-     * List tags. List all tags for a given image, specified by region. By
-     * default, the tags listed are ordered by creation date in ascending order.
-     * This can be modified via the order_by field. You can also define additional
-     * parameters for your query, such as the `name`.
+     * List tags. List all tags for a given image, specified by region. By default, the tags listed are ordered by creation date in ascending order. This can be modified via the order_by field. You can also define additional parameters for your query, such as the `name`.
      *
      * @param request - The request {@link ListTagsRequest}
      * @returns A Promise of ListTagsResponse
@@ -133,9 +108,7 @@ export declare class API extends ParentAPI {
         [Symbol.asyncIterator]: () => AsyncGenerator<Tag[], void, void>;
     };
     /**
-     * Get a tag. Retrieve information about a given image tag, specified by its
-     * `tag_id` and region. Full details about the tag, such as `name`,
-     * `image_id`, `status`, and `digest` are returned in the response.
+     * Get a tag. Retrieve information about a given image tag, specified by its `tag_id` and region. Full details about the tag, such as `name`, `image_id`, `status`, and `digest` are returned in the response.
      *
      * @param request - The request {@link GetTagRequest}
      * @returns A Promise of Tag
@@ -150,8 +123,7 @@ export declare class API extends ParentAPI {
      */
     waitForTag: (request: Readonly<GetTagRequest>, options?: Readonly<WaitForOptions<Tag>>) => Promise<Tag>;
     /**
-     * Delete a tag. Delete a given image tag. You must specify, in the endpoint,
-     * the `region` and `tag_id` parameters of the tag you want to delete.
+     * Delete a tag. Delete a given image tag. You must specify, in the endpoint, the `region` and `tag_id` parameters of the tag you want to delete.
      *
      * @param request - The request {@link DeleteTagRequest}
      * @returns A Promise of Tag

package/dist/api/registry/v1/api.gen.js

@@ -35,21 +35,14 @@ class API extends API$1 {
     unmarshalListNamespacesResponse
   );
   /**
-   * List namespaces. List all namespaces in a specified region. By default, the
-   * namespaces listed are ordered by creation date in ascending order. This can
-   * be modified via the order_by field. You can also define additional
-   * parameters for your query, such as the `instance_id` and `project_id`
-   * parameters.
+   * List namespaces. List all namespaces in a specified region. By default, the namespaces listed are ordered by creation date in ascending order. This can be modified via the order_by field. You can also define additional parameters for your query, such as the `instance_id` and `project_id` parameters.
    *
    * @param request - The request {@link ListNamespacesRequest}
    * @returns A Promise of ListNamespacesResponse
    */
   listNamespaces = (request = {}) => enrichForPagination("namespaces", this.pageOfListNamespaces, request);
   /**
-   * Get a namespace. Retrieve information about a given namespace, specified by
-   * its `namespace_id` and region. Full details about the namespace, such as
-   * `description`, `project_id`, `status`, `endpoint`, `is_public`, `size`, and
-   * `image_count` are returned in the response.
+   * Get a namespace. Retrieve information about a given namespace, specified by its `namespace_id` and region. Full details about the namespace, such as `description`, `project_id`, `status`, `endpoint`, `is_public`, `size`, and `image_count` are returned in the response.
    *
    * @param request - The request {@link GetNamespaceRequest}
    * @returns A Promise of Namespace
@@ -77,10 +70,7 @@ class API extends API$1 {
     options
   );
   /**
-   * Create a namespace. Create a new Container Registry namespace. You must
-   * specify the namespace name and region in which you want it to be created.
-   * Optionally, you can specify the `project_id` and `is_public` in the request
-   * payload.
+   * Create a namespace. Create a new Container Registry namespace. You must specify the namespace name and region in which you want it to be created. Optionally, you can specify the `project_id` and `is_public` in the request payload.
    *
    * @param request - The request {@link CreateNamespaceRequest}
    * @returns A Promise of Namespace
@@ -97,9 +87,7 @@ class API extends API$1 {
     unmarshalNamespace
   );
   /**
-   * Update a namespace. Update the parameters of a given namespace, specified
-   * by its `namespace_id` and `region`. You can update the `description` and
-   * `is_public` parameters.
+   * Update a namespace. Update the parameters of a given namespace, specified by its `namespace_id` and `region`. You can update the `description` and `is_public` parameters.
    *
    * @param request - The request {@link UpdateNamespaceRequest}
    * @returns A Promise of Namespace
@@ -116,9 +104,7 @@ class API extends API$1 {
     unmarshalNamespace
   );
   /**
-   * Delete a namespace. Delete a given namespace. You must specify, in the
-   * endpoint, the `region` and `namespace_id` parameters of the namespace you
-   * want to delete.
+   * Delete a namespace. Delete a given namespace. You must specify, in the endpoint, the `region` and `namespace_id` parameters of the namespace you want to delete.
    *
    * @param request - The request {@link DeleteNamespaceRequest}
    * @returns A Promise of Namespace
@@ -150,20 +136,14 @@ class API extends API$1 {
     unmarshalListImagesResponse
   );
   /**
-   * List images. List all images in a specified region. By default, the images
-   * listed are ordered by creation date in ascending order. This can be
-   * modified via the order_by field. You can also define additional parameters
-   * for your query, such as the `namespace_id` and `project_id` parameters.
+   * List images. List all images in a specified region. By default, the images listed are ordered by creation date in ascending order. This can be modified via the order_by field. You can also define additional parameters for your query, such as the `namespace_id` and `project_id` parameters.
    *
    * @param request - The request {@link ListImagesRequest}
    * @returns A Promise of ListImagesResponse
    */
   listImages = (request = {}) => enrichForPagination("images", this.pageOfListImages, request);
   /**
-   * Get an image. Retrieve information about a given container image, specified
-   * by its `image_id` and region. Full details about the image, such as `name`,
-   * `namespace_id`, `status`, `visibility`, and `size` are returned in the
-   * response.
+   * Get an image. Retrieve information about a given container image, specified by its `image_id` and region. Full details about the image, such as `name`, `namespace_id`, `status`, `visibility`, and `size` are returned in the response.
    *
    * @param request - The request {@link GetImageRequest}
    * @returns A Promise of Image
@@ -191,8 +171,7 @@ class API extends API$1 {
     options
   );
   /**
-   * Update an image. Update the parameters of a given image, specified by its
-   * `image_id` and `region`. You can update the `visibility` parameter.
+   * Update an image. Update the parameters of a given image, specified by its `image_id` and `region`. You can update the `visibility` parameter.
    *
    * @param request - The request {@link UpdateImageRequest}
    * @returns A Promise of Image
@@ -209,8 +188,7 @@ class API extends API$1 {
     unmarshalImage
   );
   /**
-   * Delete an image. Delete a given image. You must specify, in the endpoint,
-   * the `region` and `image_id` parameters of the image you want to delete.
+   * Delete an image. Delete a given image. You must specify, in the endpoint, the `region` and `image_id` parameters of the image you want to delete.
    *
    * @param request - The request {@link DeleteImageRequest}
    * @returns A Promise of Image
@@ -239,19 +217,14 @@ class API extends API$1 {
     unmarshalListTagsResponse
   );
   /**
-   * List tags. List all tags for a given image, specified by region. By
-   * default, the tags listed are ordered by creation date in ascending order.
-   * This can be modified via the order_by field. You can also define additional
-   * parameters for your query, such as the `name`.
+   * List tags. List all tags for a given image, specified by region. By default, the tags listed are ordered by creation date in ascending order. This can be modified via the order_by field. You can also define additional parameters for your query, such as the `name`.
    *
    * @param request - The request {@link ListTagsRequest}
    * @returns A Promise of ListTagsResponse
    */
   listTags = (request) => enrichForPagination("tags", this.pageOfListTags, request);
   /**
-   * Get a tag. Retrieve information about a given image tag, specified by its
-   * `tag_id` and region. Full details about the tag, such as `name`,
-   * `image_id`, `status`, and `digest` are returned in the response.
+   * Get a tag. Retrieve information about a given image tag, specified by its `tag_id` and region. Full details about the tag, such as `name`, `image_id`, `status`, and `digest` are returned in the response.
    *
    * @param request - The request {@link GetTagRequest}
    * @returns A Promise of Tag
@@ -279,8 +252,7 @@ class API extends API$1 {
     options
   );
   /**
-   * Delete a tag. Delete a given image tag. You must specify, in the endpoint,
-   * the `region` and `tag_id` parameters of the tag you want to delete.
+   * Delete a tag. Delete a given image tag. You must specify, in the endpoint, the `region` and `tag_id` parameters of the tag you want to delete.
    *
    * @param request - The request {@link DeleteTagRequest}
    * @returns A Promise of Tag