@scaleway/sdk 2.72.0 → 2.73.0

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

@@ -7,294 +7,378 @@ export type ListTagsRequestOrderBy = 'created_at_asc' | 'created_at_desc' | 'nam
 export type NamespaceStatus = 'unknown' | 'ready' | 'deleting' | 'error' | 'locked';
 export type TagStatus = 'unknown' | 'ready' | 'deleting' | 'error' | 'locked';
 export interface Image {
-    /** UUID of the image. */
+    /**
+     * UUID of the image.
+     */
     id: string;
-    /** Name of the image, it must be unique within the namespace. */
+    /**
+     * Name of the image, it must be unique within the namespace.
+     */
     name: string;
-    /** UUID of the namespace the image belongs to. */
+    /**
+     * UUID of the namespace the image belongs to.
+     */
     namespaceId: string;
-    /** Status of the image. */
+    /**
+     * Status of the image.
+     */
     status: ImageStatus;
-    /** Details of the image status. */
+    /**
+     * Details of the image status.
+     */
     statusMessage?: string;
     /**
-     * Set to `public` to allow the image to be pulled without authentication.
-     * Else, set to `private`. Set to `inherit` to keep the same visibility
-     * configuration as the namespace.
+     * Set to `public` to allow the image to be pulled without authentication. Else, set to  `private`. Set to `inherit` to keep the same visibility configuration as the namespace.
      */
     visibility: ImageVisibility;
     /**
-     * Image size in bytes, calculated from the size of image layers. One layer
-     * used in two tags of the same image is counted once but one layer used in
-     * two images is counted twice.
+     * Image size in bytes, calculated from the size of image layers. One layer used in two tags of the same image is counted once but one layer used in two images is counted twice.
      */
     size: number;
-    /** Date and time of image creation. */
+    /**
+     * Date and time of image creation.
+     */
     createdAt?: Date;
-    /** Date and time of last update. */
+    /**
+     * Date and time of last update.
+     */
     updatedAt?: Date;
-    /** List of docker tags of the image. */
+    /**
+     * List of docker tags of the image.
+     */
     tags: string[];
 }
 export interface Namespace {
-    /** UUID of the namespace. */
+    /**
+     * UUID of the namespace.
+     */
     id: string;
-    /** Name of the namespace, unique in a region accross all organizations. */
+    /**
+     * Name of the namespace, unique in a region accross all organizations.
+     */
     name: string;
-    /** Description of the namespace. */
+    /**
+     * Description of the namespace.
+     */
     description: string;
-    /** Owner of the namespace. */
+    /**
+     * Owner of the namespace.
+     */
     organizationId: string;
-    /** Project of the namespace. */
+    /**
+     * Project of the namespace.
+     */
     projectId: string;
-    /** Namespace status. */
+    /**
+     * Namespace status.
+     */
     status: NamespaceStatus;
-    /** Namespace status details. */
+    /**
+     * Namespace status details.
+     */
     statusMessage: string;
-    /** Endpoint reachable by docker. */
+    /**
+     * Endpoint reachable by docker.
+     */
     endpoint: string;
-    /** Defines whether or not namespace is public. */
+    /**
+     * Defines whether or not namespace is public.
+     */
     isPublic: boolean;
     /**
-     * Total size of the namespace, calculated as the sum of the size of all
-     * images in the namespace.
+     * Total size of the namespace, calculated as the sum of the size of all images in the namespace.
      */
     size: number;
-    /** Date and time of creation. */
+    /**
+     * Date and time of creation.
+     */
     createdAt?: Date;
-    /** Date and time of last update. */
+    /**
+     * Date and time of last update.
+     */
     updatedAt?: Date;
-    /** Number of images in the namespace. */
+    /**
+     * Number of images in the namespace.
+     */
     imageCount: number;
-    /** Region the namespace belongs to. */
+    /**
+     * Region the namespace belongs to.
+     */
     region: ScwRegion;
 }
 export interface Tag {
-    /** UUID of the tag. */
+    /**
+     * UUID of the tag.
+     */
     id: string;
-    /** Tag name, unique to an image. */
+    /**
+     * Tag name, unique to an image.
+     */
     name: string;
-    /** Image ID the of the image the tag belongs to. */
+    /**
+     * Image ID the of the image the tag belongs to.
+     */
     imageId: string;
-    /** Tag status. */
+    /**
+     * Tag status.
+     */
     status: TagStatus;
     /**
-     * Hash of the tag content. Several tags of a same image may have the same
-     * digest.
+     * Hash of the tag content. Several tags of a same image may have the same digest.
      */
     digest: string;
-    /** Date and time of creation. */
+    /**
+     * Date and time of creation.
+     */
     createdAt?: Date;
-    /** Date and time of last update. */
+    /**
+     * Date and time of last update.
+     */
     updatedAt?: Date;
 }
 export type CreateNamespaceRequest = {
     /**
-     * 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;
-    /** Name of the namespace. */
+    /**
+     * Name of the namespace.
+     */
     name?: string;
-    /** Description of the namespace. */
+    /**
+     * Description of the namespace.
+     */
     description: string;
     /**
      * @deprecated Namespace owner (deprecated).
      *
-     *   One-of ('projectIdentifier'): at most one of 'projectId', 'organizationId'
-     *   could be set.
+     * One-of ('projectIdentifier'): at most one of 'projectId', 'organizationId' could be set.
      */
     organizationId?: string;
     /**
      * Project ID on which the namespace will be created.
      *
-     * One-of ('projectIdentifier'): at most one of 'projectId', 'organizationId'
-     * could be set.
+     * One-of ('projectIdentifier'): at most one of 'projectId', 'organizationId' could be set.
      */
     projectId?: string;
-    /** Defines whether or not namespace is public. */
+    /**
+     * Defines whether or not namespace is public.
+     */
     isPublic: boolean;
 };
 export type DeleteImageRequest = {
     /**
-     * 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 image. */
+    /**
+     * UUID of the image.
+     */
     imageId: string;
 };
 export type DeleteNamespaceRequest = {
     /**
-     * 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 namespace. */
+    /**
+     * UUID of the namespace.
+     */
     namespaceId: string;
 };
 export type DeleteTagRequest = {
     /**
-     * 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 tag. */
+    /**
+     * UUID of the tag.
+     */
     tagId: string;
     /**
-     * @deprecated If two tags share the same digest the deletion will fail unless
-     *   this parameter is set to true (deprecated).
+     * @deprecated If two tags share the same digest the deletion will fail unless this parameter is set to true (deprecated).
      */
     force?: boolean;
 };
 export type GetImageRequest = {
     /**
-     * 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 image. */
+    /**
+     * UUID of the image.
+     */
     imageId: string;
 };
 export type GetNamespaceRequest = {
     /**
-     * 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 namespace. */
+    /**
+     * UUID of the namespace.
+     */
     namespaceId: string;
 };
 export type GetTagRequest = {
     /**
-     * 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 tag. */
+    /**
+     * UUID of the tag.
+     */
     tagId: string;
 };
 export type ListImagesRequest = {
     /**
-     * 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;
-    /** A positive integer to choose the page to display. */
+    /**
+     * A positive integer to choose the page to display.
+     */
     page?: number;
     /**
-     * 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;
     /**
-     * Criteria to use when ordering image listings. Possible values are
-     * `created_at_asc`, `created_at_desc`, `name_asc`, `name_desc`, `region`,
-     * `status_asc` and `status_desc`. The default value is `created_at_asc`.
+     * Criteria to use when ordering image listings. Possible values are `created_at_asc`, `created_at_desc`, `name_asc`, `name_desc`, `region`, `status_asc` and `status_desc`. The default value is `created_at_asc`.
      */
     orderBy?: ListImagesRequestOrderBy;
-    /** Filter by the namespace ID. */
+    /**
+     * Filter by the namespace ID.
+     */
     namespaceId?: string;
-    /** Filter by the image name (exact match). */
+    /**
+     * Filter by the image name (exact match).
+     */
     name?: string;
-    /** Filter by Organization ID. */
+    /**
+     * Filter by Organization ID.
+     */
     organizationId?: string;
-    /** Filter by Project ID. */
+    /**
+     * Filter by Project ID.
+     */
     projectId?: string;
 };
 export interface ListImagesResponse {
-    /** Paginated list of images that match the selected filters. */
+    /**
+     * Paginated list of images that match the selected filters.
+     */
     images: Image[];
-    /** Total number of images that match the selected filters. */
+    /**
+     * Total number of images that match the selected filters.
+     */
     totalCount: number;
 }
 export type ListNamespacesRequest = {
     /**
-     * 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;
-    /** A positive integer to choose the page to display. */
+    /**
+     * A positive integer to choose the page to display.
+     */
     page?: number;
     /**
-     * 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;
     /**
-     * Criteria to use when ordering namespace listings. Possible values are
-     * `created_at_asc`, `created_at_desc`, `name_asc`, `name_desc`, `region`,
-     * `status_asc` and `status_desc`. The default value is `created_at_asc`.
+     * Criteria to use when ordering namespace listings. Possible values are `created_at_asc`, `created_at_desc`, `name_asc`, `name_desc`, `region`, `status_asc` and `status_desc`. The default value is `created_at_asc`.
      */
     orderBy?: ListNamespacesRequestOrderBy;
-    /** Filter by Organization ID. */
+    /**
+     * Filter by Organization ID.
+     */
     organizationId?: string;
-    /** Filter by Project ID. */
+    /**
+     * Filter by Project ID.
+     */
     projectId?: string;
-    /** Filter by the namespace name (exact match). */
+    /**
+     * Filter by the namespace name (exact match).
+     */
     name?: string;
 };
 export interface ListNamespacesResponse {
-    /** Paginated list of namespaces that match the selected filters. */
+    /**
+     * Paginated list of namespaces that match the selected filters.
+     */
     namespaces: Namespace[];
-    /** Total number of namespaces that match the selected filters. */
+    /**
+     * Total number of namespaces that match the selected filters.
+     */
     totalCount: number;
 }
 export type ListTagsRequest = {
     /**
-     * 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 image. */
+    /**
+     * UUID of the image.
+     */
     imageId: string;
-    /** A positive integer to choose the page to display. */
+    /**
+     * A positive integer to choose the page to display.
+     */
     page?: number;
     /**
-     * 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;
     /**
-     * Criteria to use when ordering tag listings. Possible values are
-     * `created_at_asc`, `created_at_desc`, `name_asc`, `name_desc`, `region`,
-     * `status_asc` and `status_desc`. The default value is `created_at_asc`.
+     * Criteria to use when ordering tag listings. Possible values are `created_at_asc`, `created_at_desc`, `name_asc`, `name_desc`, `region`, `status_asc` and `status_desc`. The default value is `created_at_asc`.
      */
     orderBy?: ListTagsRequestOrderBy;
-    /** Filter by the tag name (exact match). */
+    /**
+     * Filter by the tag name (exact match).
+     */
     name?: string;
 };
 export interface ListTagsResponse {
-    /** Paginated list of tags that match the selected filters. */
+    /**
+     * Paginated list of tags that match the selected filters.
+     */
     tags: Tag[];
-    /** Total number of tags that match the selected filters. */
+    /**
+     * Total number of tags that match the selected filters.
+     */
     totalCount: number;
 }
 export type UpdateImageRequest = {
     /**
-     * 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 image to update. */
+    /**
+     * ID of the image to update.
+     */
     imageId: string;
     /**
-     * Set to `public` to allow the image to be pulled without authentication.
-     * Else, set to `private`. Set to `inherit` to keep the same visibility
-     * configuration as the namespace.
+     * Set to `public` to allow the image to be pulled without authentication. Else, set to  `private`. Set to `inherit` to keep the same visibility configuration as the namespace.
      */
     visibility?: ImageVisibility;
 };
 export type UpdateNamespaceRequest = {
     /**
-     * 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 namespace to update. */
+    /**
+     * ID of the namespace to update.
+     */
     namespaceId: string;
-    /** Namespace description. */
+    /**
+     * Namespace description.
+     */
     description?: string;
-    /** Defines whether or not the namespace is public. */
+    /**
+     * Defines whether or not the namespace is public.
+     */
     isPublic?: boolean;
 };

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

@@ -17,8 +17,7 @@ class API extends api.API {
     "pl-waw"
   ];
   /**
-   * Create a secret. Create a secret in a given region specified by the
-   * `region` parameter.
+   * Create a secret. Create a secret in a given region specified by the `region` parameter.
    *
    * @param request - The request {@link CreateSecretRequest}
    * @returns A Promise of Secret
@@ -35,8 +34,7 @@ class API extends api.API {
     marshalling_gen.unmarshalSecret
   );
   /**
-   * Get metadata using the secret's ID. Retrieve the metadata of a secret
-   * specified by the `region` and `secret_id` parameters.
+   * Get metadata using the secret's ID. Retrieve the metadata of a secret specified by the `region` and `secret_id` parameters.
    *
    * @param request - The request {@link GetSecretRequest}
    * @returns A Promise of Secret
@@ -49,9 +47,7 @@ class API extends api.API {
     marshalling_gen.unmarshalSecret
   );
   /**
-   * Update metadata of a secret. Edit a secret's metadata such as name, tag(s),
-   * description and ephemeral policy. The secret to update is specified by the
-   * `secret_id` and `region` parameters.
+   * Update metadata of a secret. Edit a secret's metadata such as name, tag(s), description and ephemeral policy. The secret to update is specified by the `secret_id` and `region` parameters.
    *
    * @param request - The request {@link UpdateSecretRequest}
    * @returns A Promise of Secret
@@ -68,8 +64,7 @@ class API extends api.API {
     marshalling_gen.unmarshalSecret
   );
   /**
-   * Delete a secret. Delete a given secret specified by the `region` and
-   * `secret_id` parameters.
+   * Delete a secret. Delete a given secret specified by the `region` and `secret_id` parameters.
    *
    * @param request - The request {@link DeleteSecretRequest}
    */
@@ -101,18 +96,14 @@ class API extends api.API {
     marshalling_gen.unmarshalListSecretsResponse
   );
   /**
-   * List secrets. Retrieve the list of secrets created within an Organization
-   * and/or Project. You must specify either the `organization_id` or the
-   * `project_id` and the `region`.
+   * List secrets. Retrieve the list of secrets created within an Organization and/or Project. You must specify either the `organization_id` or the `project_id` and the `region`.
    *
    * @param request - The request {@link ListSecretsRequest}
    * @returns A Promise of ListSecretsResponse
    */
   listSecrets = (request) => resourcePaginator.enrichForPagination("secrets", this.pageOfListSecrets, request);
   /**
-   * Browse secrets. Retrieve the list of secrets and folders for the given
-   * prefix. You must specify either the `organization_id` or the `project_id`
-   * and the `region`.
+   * Browse secrets. Retrieve the list of secrets and folders for the given prefix. You must specify either the `organization_id` or the `project_id` and the `region`.
    *
    * @param request - The request {@link BrowseSecretsRequest}
    * @returns A Promise of BrowseSecretsResponse
@@ -137,9 +128,7 @@ class API extends api.API {
     marshalling_gen.unmarshalBrowseSecretsResponse
   );
   /**
-   * Enable secret protection. Enable secret protection for a given secret
-   * specified by the `secret_id` parameter. Enabling secret protection means
-   * that your secret can be read and modified, but it cannot be deleted.
+   * Enable secret protection. Enable secret protection for a given secret specified by the `secret_id` parameter. Enabling secret protection means that your secret can be read and modified, but it cannot be deleted.
    *
    * @param request - The request {@link ProtectSecretRequest}
    * @returns A Promise of Secret
@@ -154,9 +143,7 @@ class API extends api.API {
     marshalling_gen.unmarshalSecret
   );
   /**
-   * Disable secret protection. Disable secret protection for a given secret
-   * specified by the `secret_id` parameter. Disabling secret protection means
-   * that your secret can be read, modified and deleted.
+   * Disable secret protection. Disable secret protection for a given secret specified by the `secret_id` parameter. Disabling secret protection means that your secret can be read, modified and deleted.
    *
    * @param request - The request {@link UnprotectSecretRequest}
    * @returns A Promise of Secret
@@ -184,8 +171,7 @@ class API extends api.API {
     path: `/secret-manager/v1beta1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/secrets/${marshalling.validatePathParam("secretId", request.secretId)}/add-owner`
   });
   /**
-   * Create a version. Create a version of a given secret specified by the
-   * `region` and `secret_id` parameters.
+   * Create a version. Create a version of a given secret specified by the `region` and `secret_id` parameters.
    *
    * @param request - The request {@link CreateSecretVersionRequest}
    * @returns A Promise of SecretVersion
@@ -202,9 +188,7 @@ class API extends api.API {
     marshalling_gen.unmarshalSecretVersion
   );
   /**
-   * Get metadata of a secret's version using the secret's ID. Retrieve the
-   * metadata of a secret's given version specified by the `region`, `secret_id`
-   * and `revision` parameters.
+   * Get metadata of a secret's version using the secret's ID. Retrieve the metadata of a secret's given version specified by the `region`, `secret_id` and `revision` parameters.
    *
    * @param request - The request {@link GetSecretVersionRequest}
    * @returns A Promise of SecretVersion
@@ -217,8 +201,7 @@ class API extends api.API {
     marshalling_gen.unmarshalSecretVersion
   );
   /**
-   * Update metadata of a version. Edit the metadata of a secret's given
-   * version, specified by the `region`, `secret_id` and `revision` parameters.
+   * Update metadata of a version. Edit the metadata of a secret's given version, specified by the `region`, `secret_id` and `revision` parameters.
    *
    * @param request - The request {@link UpdateSecretVersionRequest}
    * @returns A Promise of SecretVersion
@@ -235,8 +218,7 @@ class API extends api.API {
     marshalling_gen.unmarshalSecretVersion
   );
   /**
-   * Delete a version. Delete a secret's version and the sensitive data
-   * contained in it. Deleting a version is permanent and cannot be undone.
+   * Delete a version. Delete a secret's version and the sensitive data contained in it. Deleting a version is permanent and cannot be undone.
    *
    * @param request - The request {@link DeleteSecretVersionRequest}
    */
@@ -260,18 +242,14 @@ class API extends api.API {
     marshalling_gen.unmarshalListSecretVersionsResponse
   );
   /**
-   * List versions of a secret using the secret's ID. Retrieve the list of a
-   * given secret's versions specified by the `secret_id` and `region`
-   * parameters.
+   * List versions of a secret using the secret's ID. Retrieve the list of a given secret's versions specified by the `secret_id` and `region` parameters.
    *
    * @param request - The request {@link ListSecretVersionsRequest}
    * @returns A Promise of ListSecretVersionsResponse
    */
   listSecretVersions = (request) => resourcePaginator.enrichForPagination("versions", this.pageOfListSecretVersions, request);
   /**
-   * Access a secret's version using the secret's ID. Access sensitive data in a
-   * secret's version specified by the `region`, `secret_id` and `revision`
-   * parameters.
+   * Access a secret's version using the secret's ID. Access sensitive data in a secret's version specified by the `region`, `secret_id` and `revision` parameters.
    *
    * @param request - The request {@link AccessSecretVersionRequest}
    * @returns A Promise of AccessSecretVersionResponse
@@ -284,9 +262,7 @@ class API extends api.API {
     marshalling_gen.unmarshalAccessSecretVersionResponse
   );
   /**
-   * Access a secret's version using the secret's name and path. Access
-   * sensitive data in a secret's version specified by the `region`,
-   * `secret_name`, `secret_path` and `revision` parameters.
+   * Access a secret's version using the secret's name and path. Access sensitive data in a secret's version specified by the `region`, `secret_name`, `secret_path` and `revision` parameters.
    *
    * @param request - The request {@link AccessSecretVersionByPathRequest}
    * @returns A Promise of AccessSecretVersionResponse
@@ -307,8 +283,7 @@ class API extends api.API {
     marshalling_gen.unmarshalAccessSecretVersionResponse
   );
   /**
-   * Enable a version. Make a specific version accessible. You must specify the
-   * `region`, `secret_id` and `revision` parameters.
+   * Enable a version. Make a specific version accessible. You must specify the `region`, `secret_id` and `revision` parameters.
    *
    * @param request - The request {@link EnableSecretVersionRequest}
    * @returns A Promise of SecretVersion
@@ -323,8 +298,7 @@ class API extends api.API {
     marshalling_gen.unmarshalSecretVersion
   );
   /**
-   * Disable a version. Make a specific version inaccessible. You must specify
-   * the `region`, `secret_id` and `revision` parameters.
+   * Disable a version. Make a specific version inaccessible. You must specify the `region`, `secret_id` and `revision` parameters.
    *
    * @param request - The request {@link DisableSecretVersionRequest}
    * @returns A Promise of SecretVersion
@@ -389,8 +363,7 @@ class API extends api.API {
    */
   listSecretTypes = (request = {}) => resourcePaginator.enrichForPagination("types", this.pageOfListSecretTypes, request);
   /**
-   * Restore a version. Restore a secret's version specified by the `region`,
-   * `secret_id` and `revision` parameters.
+   * Restore a version. Restore a secret's version specified by the `region`, `secret_id` and `revision` parameters.
    *
    * @param request - The request {@link RestoreSecretVersionRequest}
    * @returns A Promise of SecretVersion
@@ -405,8 +378,7 @@ class API extends api.API {
     marshalling_gen.unmarshalSecretVersion
   );
   /**
-   * Restore a secret. Restore a secret and all its versions scheduled for
-   * deletion specified by the `region` and `secret_id` parameters.
+   * Restore a secret. Restore a secret and all its versions scheduled for deletion specified by the `region` and `secret_id` parameters.
    *
    * @param request - The request {@link RestoreSecretRequest}
    * @returns A Promise of Secret