@scaleway/sdk 2.72.0 → 2.74.0

package/dist/api/secret/v1beta1/api.gen.d.ts

@@ -3,51 +3,42 @@ import type { Region as ScwRegion } from '@scaleway/sdk-client';
 import type { AccessSecretVersionByPathRequest, AccessSecretVersionRequest, AccessSecretVersionResponse, AddSecretOwnerRequest, BrowseSecretsRequest, BrowseSecretsResponse, CreateSecretRequest, CreateSecretVersionRequest, DeleteSecretRequest, DeleteSecretVersionRequest, DisableSecretVersionRequest, EnableSecretVersionRequest, GetSecretRequest, GetSecretVersionRequest, ListSecretTypesRequest, ListSecretTypesResponse, ListSecretVersionsRequest, ListSecretVersionsResponse, ListSecretsRequest, ListSecretsResponse, ListTagsRequest, ListTagsResponse, ProtectSecretRequest, RestoreSecretRequest, RestoreSecretVersionRequest, Secret, SecretVersion, UnprotectSecretRequest, UpdateSecretRequest, UpdateSecretVersionRequest } from './types.gen';
 /**
  * Secret Manager API.
- *
- * This API allows you to manage your Secret Manager services, for storing,
- * accessing and sharing sensitive data such as passwords, API keys and
- * certificates.
+
+This API allows you to manage your Secret Manager services, for storing, accessing and sharing sensitive data such as passwords, API keys and certificates.
  */
 export declare class API extends ParentAPI {
     /** Lists the available regions of the API. */
     static readonly LOCALITIES: ScwRegion[];
     /**
-     * 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
      */
     createSecret: (request: Readonly<CreateSecretRequest>) => Promise<Secret>;
     /**
-     * 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
      */
     getSecret: (request: Readonly<GetSecretRequest>) => Promise<Secret>;
     /**
-     * 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
      */
     updateSecret: (request: Readonly<UpdateSecretRequest>) => Promise<Secret>;
     /**
-     * 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}
      */
     deleteSecret: (request: Readonly<DeleteSecretRequest>) => Promise<void>;
     protected pageOfListSecrets: (request: Readonly<ListSecretsRequest>) => Promise<ListSecretsResponse>;
     /**
-     * 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
@@ -57,27 +48,21 @@ export declare class API extends ParentAPI {
         [Symbol.asyncIterator]: () => AsyncGenerator<Secret[], void, void>;
     };
     /**
-     * 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
      */
     browseSecrets: (request: Readonly<BrowseSecretsRequest>) => Promise<BrowseSecretsResponse>;
     /**
-     * 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
      */
     protectSecret: (request: Readonly<ProtectSecretRequest>) => Promise<Secret>;
     /**
-     * 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
@@ -90,42 +75,35 @@ export declare class API extends ParentAPI {
      */
     addSecretOwner: (request: Readonly<AddSecretOwnerRequest>) => Promise<void>;
     /**
-     * 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
      */
     createSecretVersion: (request: Readonly<CreateSecretVersionRequest>) => Promise<SecretVersion>;
     /**
-     * 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
      */
     getSecretVersion: (request: Readonly<GetSecretVersionRequest>) => Promise<SecretVersion>;
     /**
-     * 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
      */
     updateSecretVersion: (request: Readonly<UpdateSecretVersionRequest>) => Promise<SecretVersion>;
     /**
-     * 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}
      */
     deleteSecretVersion: (request: Readonly<DeleteSecretVersionRequest>) => Promise<void>;
     protected pageOfListSecretVersions: (request: Readonly<ListSecretVersionsRequest>) => Promise<ListSecretVersionsResponse>;
     /**
-     * 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
@@ -135,34 +113,28 @@ export declare class API extends ParentAPI {
         [Symbol.asyncIterator]: () => AsyncGenerator<SecretVersion[], void, void>;
     };
     /**
-     * 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
      */
     accessSecretVersion: (request: Readonly<AccessSecretVersionRequest>) => Promise<AccessSecretVersionResponse>;
     /**
-     * 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
      */
     accessSecretVersionByPath: (request: Readonly<AccessSecretVersionByPathRequest>) => Promise<AccessSecretVersionResponse>;
     /**
-     * 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
      */
     enableSecretVersion: (request: Readonly<EnableSecretVersionRequest>) => Promise<SecretVersion>;
     /**
-     * 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
@@ -191,16 +163,14 @@ export declare class API extends ParentAPI {
         [Symbol.asyncIterator]: () => AsyncGenerator<import("./types.gen").SecretType[], void, void>;
     };
     /**
-     * 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
      */
     restoreSecretVersion: (request: Readonly<RestoreSecretVersionRequest>) => Promise<SecretVersion>;
     /**
-     * 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

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

@@ -15,8 +15,7 @@ class API extends API$1 {
     "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
@@ -33,8 +32,7 @@ class API extends API$1 {
     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
@@ -47,9 +45,7 @@ class API extends API$1 {
     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
@@ -66,8 +62,7 @@ class API extends API$1 {
     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}
    */
@@ -99,18 +94,14 @@ class API extends API$1 {
     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) => 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
@@ -135,9 +126,7 @@ class API extends API$1 {
     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
@@ -152,9 +141,7 @@ class API extends API$1 {
     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
@@ -182,8 +169,7 @@ class API extends API$1 {
     path: `/secret-manager/v1beta1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/secrets/${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
@@ -200,9 +186,7 @@ class API extends API$1 {
     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
@@ -215,8 +199,7 @@ class API extends API$1 {
     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
@@ -233,8 +216,7 @@ class API extends API$1 {
     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}
    */
@@ -258,18 +240,14 @@ class API extends API$1 {
     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) => 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
@@ -282,9 +260,7 @@ class API extends API$1 {
     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
@@ -305,8 +281,7 @@ class API extends API$1 {
     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
@@ -321,8 +296,7 @@ class API extends API$1 {
     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
@@ -387,8 +361,7 @@ class API extends API$1 {
    */
   listSecretTypes = (request = {}) => 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
@@ -403,8 +376,7 @@ class API extends API$1 {
     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