@scaleway/sdk 2.64.0 → 2.65.0

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

@@ -10,12 +10,16 @@ const jsonContentHeaders = {
 };
 class API extends api.API {
   /** Lists the available regions of the API. */
-  static LOCALITIES = ["fr-par", "nl-ams", "pl-waw"];
+  static LOCALITIES = [
+    "fr-par",
+    "nl-ams",
+    "pl-waw"
+  ];
   /**
    * Create a key. Create a key in a given region specified by the `region`
    * parameter. Keys only support symmetric encryption. You can use keys to
-   * encrypt or decrypt arbitrary payloads, or to generate data encryption keys
-   * that can be used without being stored in Key Manager.
+   * encrypt or decrypt arbitrary payloads, or to generate data encryption keys.
+   * **Data encryption keys are not stored in Key Manager**.
    *
    * @param request - The request {@link CreateKeyRequest}
    * @returns A Promise of Key
@@ -32,7 +36,7 @@ class API extends api.API {
     marshalling_gen.unmarshalKey
   );
   /**
-   * Get key metadata. Retrieve the metadata of a key specified by the `region`
+   * Get key metadata. Retrieve metadata for a specified key using the `region`
    * and `key_id` parameters.
    *
    * @param request - The request {@link GetKeyRequest}
@@ -46,7 +50,7 @@ class API extends api.API {
     marshalling_gen.unmarshalKey
   );
   /**
-   * Update a key. Update a key's metadata (name, description and tags),
+   * Update a key. Modify a key's metadata including name, description and tags,
    * specified by the `key_id` and `region` parameters.
    *
    * @param request - The request {@link UpdateKeyRequest}
@@ -64,10 +68,9 @@ class API extends api.API {
     marshalling_gen.unmarshalKey
   );
   /**
-   * Delete a key. Delete an existing key specified by the `region` and `key_id`
-   * parameters. Deleting a key is permanent and cannot be undone. All data
-   * encrypted using this key, including data encryption keys, will become
-   * unusable.
+   * Delete a key. Permanently delete a key specified by the `region` and
+   * `key_id` parameters. This action is irreversible. Any data encrypted with
+   * this key, including data encryption keys, will no longer be decipherable.
    *
    * @param request - The request {@link DeleteKeyRequest}
    */
@@ -76,10 +79,10 @@ class API extends api.API {
     path: `/key-manager/v1alpha1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/keys/${marshalling.validatePathParam("keyId", request.keyId)}`
   });
   /**
-   * Rotate a key. Generate a new version of an existing key with randomly
-   * generated key material. Rotated keys can still be used to decrypt
-   * previously encrypted data. The key's new material will be used for
-   * subsequent encryption operations and data key generation.
+   * Rotate a key. Generate a new version of an existing key with new key
+   * material. Previous key versions remain usable to decrypt previously
+   * encrypted data, but the key's new version will be used for subsequent
+   * encryption operations and data key generation.
    *
    * @param request - The request {@link RotateKeyRequest}
    * @returns A Promise of Key
@@ -94,7 +97,7 @@ class API extends api.API {
     marshalling_gen.unmarshalKey
   );
   /**
-   * Apply key protection. Apply key protection to a given key specified by the
+   * Apply key protection. Apply protection to a given key specified by the
    * `key_id` parameter. Applying key protection means that your key can be used
    * and modified, but it cannot be deleted.
    *
@@ -145,9 +148,9 @@ class API extends api.API {
     marshalling_gen.unmarshalKey
   );
   /**
-   * Disable key. Disable a given key to be used for cryptographic operations.
-   * Disabling a key renders it unusable. You must specify the `region` and
-   * `key_id` parameters.
+   * Disable key. Disable a given key, preventing it to be used for
+   * cryptographic operations. Disabling a key renders it unusable. You must
+   * specify the `region` and `key_id` parameters.
    *
    * @param request - The request {@link DisableKeyRequest}
    * @returns A Promise of Key
@@ -181,25 +184,24 @@ class API extends api.API {
     marshalling_gen.unmarshalListKeysResponse
   );
   /**
-   * List keys. Retrieve the list of keys created within all Projects of an
-   * Organization or in a given Project. You must specify the `region`, and
-   * either the `organization_id` or the `project_id`.
+   * List keys. Retrieve a list of keys across all Projects in an Organization
+   * or within a specific Project. You must specify the `region`, and either the
+   * `organization_id` or the `project_id`.
    *
    * @param request - The request {@link ListKeysRequest}
    * @returns A Promise of ListKeysResponse
    */
   listKeys = (request = {}) => resourcePaginator.enrichForPagination("keys", this.pageOfListKeys, request);
   /**
-   * Generate a data encryption key. Generate a new data encryption key to use
-   * for cryptographic operations outside of Key Manager. Note that Key Manager
-   * does not store your data encryption key. The data encryption key is
+   * Create a data encryption key. Create a new data encryption key for
+   * cryptographic operations outside of Key Manager. The data encryption key is
    * encrypted and must be decrypted using the key you have created in Key
-   * Manager. The data encryption key's plaintext is returned in the response
-   * object, for immediate usage.
+   * Manager.
    *
-   * Always store the data encryption key's ciphertext, rather than its
-   * plaintext, which must not be stored. To retrieve your key's plaintext, call
-   * the Decrypt endpoint with your key's ID and ciphertext.
+   * The data encryption key is returned in plaintext and ciphertext but it
+   * should only be stored in its encrypted form (ciphertext). Key Manager does
+   * not store your data encryption key. To retrieve your key's plaintext, use
+   * the `Decrypt` method with your key's ID and ciphertext.
    *
    * @param request - The request {@link GenerateDataKeyRequest}
    * @returns A Promise of DataKey
@@ -216,10 +218,10 @@ class API extends api.API {
     marshalling_gen.unmarshalDataKey
   );
   /**
-   * Encrypt data. Encrypt data using an existing key, specified by the `key_id`
-   * parameter. Only keys with a usage set to **symmetric_encryption** are
-   * supported by this method. The maximum payload size that can be encrypted is
-   * 64KB of plaintext.
+   * Encrypt a payload. Encrypt a payload using an existing key, specified by
+   * the `key_id` parameter. Only keys with a usage set to
+   * `symmetric_encryption` are supported by this method. The maximum payload
+   * size that can be encrypted is 64 KB of plaintext.
    *
    * @param request - The request {@link EncryptRequest}
    * @returns A Promise of EncryptResponse
@@ -236,9 +238,10 @@ class API extends api.API {
     marshalling_gen.unmarshalEncryptResponse
   );
   /**
-   * Decrypt data. Decrypt data using an existing key, specified by the `key_id`
-   * parameter. The maximum payload size that can be decrypted is the result of
-   * the encryption of 64KB of data (around 131KB).
+   * Decrypt an encrypted payload. Decrypt an encrypted payload using an
+   * existing key, specified by the `key_id` parameter. The maximum payload size
+   * that can be decrypted is equivalent to the encrypted output of 64 KB of
+   * data (around 131 KB).
    *
    * @param request - The request {@link DecryptRequest}
    * @returns A Promise of DecryptResponse
@@ -255,8 +258,9 @@ class API extends api.API {
     marshalling_gen.unmarshalDecryptResponse
   );
   /**
-   * Import key material. Import key material to use to derive a new
-   * cryptographic key. The key's origin must be `external`.
+   * Import key material. Import externally generated key material into Key
+   * Manager to derive a new cryptographic key. The key's origin must be
+   * `external`.
    *
    * @param request - The request {@link ImportKeyMaterialRequest}
    * @returns A Promise of Key

package/dist/api/key_manager/v1alpha1/api.gen.d.ts

@@ -1,5 +1,5 @@
 import { API as ParentAPI } from '../../../bridge';
-import type { Region } from '../../../bridge';
+import type { Region as ScwRegion } from '../../../bridge';
 import type { CreateKeyRequest, DataKey, DecryptRequest, DecryptResponse, DeleteKeyMaterialRequest, DeleteKeyRequest, DisableKeyRequest, EnableKeyRequest, EncryptRequest, EncryptResponse, GenerateDataKeyRequest, GetKeyRequest, ImportKeyMaterialRequest, Key, ListKeysRequest, ListKeysResponse, ProtectKeyRequest, RotateKeyRequest, UnprotectKeyRequest, UpdateKeyRequest } from './types.gen';
 /**
  * Key Manager API.
@@ -9,19 +9,19 @@ import type { CreateKeyRequest, DataKey, DecryptRequest, DecryptResponse, Delete
  */
 export declare class API extends ParentAPI {
     /** Lists the available regions of the API. */
-    static readonly LOCALITIES: Region[];
+    static readonly LOCALITIES: ScwRegion[];
     /**
      * Create a key. Create a key in a given region specified by the `region`
      * parameter. Keys only support symmetric encryption. You can use keys to
-     * encrypt or decrypt arbitrary payloads, or to generate data encryption keys
-     * that can be used without being stored in Key Manager.
+     * encrypt or decrypt arbitrary payloads, or to generate data encryption keys.
+     * **Data encryption keys are not stored in Key Manager**.
      *
      * @param request - The request {@link CreateKeyRequest}
      * @returns A Promise of Key
      */
     createKey: (request: Readonly<CreateKeyRequest>) => Promise<Key>;
     /**
-     * Get key metadata. Retrieve the metadata of a key specified by the `region`
+     * Get key metadata. Retrieve metadata for a specified key using the `region`
      * and `key_id` parameters.
      *
      * @param request - The request {@link GetKeyRequest}
@@ -29,7 +29,7 @@ export declare class API extends ParentAPI {
      */
     getKey: (request: Readonly<GetKeyRequest>) => Promise<Key>;
     /**
-     * Update a key. Update a key's metadata (name, description and tags),
+     * Update a key. Modify a key's metadata including name, description and tags,
      * specified by the `key_id` and `region` parameters.
      *
      * @param request - The request {@link UpdateKeyRequest}
@@ -37,26 +37,25 @@ export declare class API extends ParentAPI {
      */
     updateKey: (request: Readonly<UpdateKeyRequest>) => Promise<Key>;
     /**
-     * Delete a key. Delete an existing key specified by the `region` and `key_id`
-     * parameters. Deleting a key is permanent and cannot be undone. All data
-     * encrypted using this key, including data encryption keys, will become
-     * unusable.
+     * Delete a key. Permanently delete a key specified by the `region` and
+     * `key_id` parameters. This action is irreversible. Any data encrypted with
+     * this key, including data encryption keys, will no longer be decipherable.
      *
      * @param request - The request {@link DeleteKeyRequest}
      */
     deleteKey: (request: Readonly<DeleteKeyRequest>) => Promise<void>;
     /**
-     * Rotate a key. Generate a new version of an existing key with randomly
-     * generated key material. Rotated keys can still be used to decrypt
-     * previously encrypted data. The key's new material will be used for
-     * subsequent encryption operations and data key generation.
+     * Rotate a key. Generate a new version of an existing key with new key
+     * material. Previous key versions remain usable to decrypt previously
+     * encrypted data, but the key's new version will be used for subsequent
+     * encryption operations and data key generation.
      *
      * @param request - The request {@link RotateKeyRequest}
      * @returns A Promise of Key
      */
     rotateKey: (request: Readonly<RotateKeyRequest>) => Promise<Key>;
     /**
-     * Apply key protection. Apply key protection to a given key specified by the
+     * Apply key protection. Apply protection to a given key specified by the
      * `key_id` parameter. Applying key protection means that your key can be used
      * and modified, but it cannot be deleted.
      *
@@ -83,9 +82,9 @@ export declare class API extends ParentAPI {
      */
     enableKey: (request: Readonly<EnableKeyRequest>) => Promise<Key>;
     /**
-     * Disable key. Disable a given key to be used for cryptographic operations.
-     * Disabling a key renders it unusable. You must specify the `region` and
-     * `key_id` parameters.
+     * Disable key. Disable a given key, preventing it to be used for
+     * cryptographic operations. Disabling a key renders it unusable. You must
+     * specify the `region` and `key_id` parameters.
      *
      * @param request - The request {@link DisableKeyRequest}
      * @returns A Promise of Key
@@ -93,9 +92,9 @@ export declare class API extends ParentAPI {
     disableKey: (request: Readonly<DisableKeyRequest>) => Promise<Key>;
     protected pageOfListKeys: (request?: Readonly<ListKeysRequest>) => Promise<ListKeysResponse>;
     /**
-     * List keys. Retrieve the list of keys created within all Projects of an
-     * Organization or in a given Project. You must specify the `region`, and
-     * either the `organization_id` or the `project_id`.
+     * List keys. Retrieve a list of keys across all Projects in an Organization
+     * or within a specific Project. You must specify the `region`, and either the
+     * `organization_id` or the `project_id`.
      *
      * @param request - The request {@link ListKeysRequest}
      * @returns A Promise of ListKeysResponse
@@ -105,43 +104,44 @@ export declare class API extends ParentAPI {
         [Symbol.asyncIterator]: () => AsyncGenerator<Key[], void, void>;
     };
     /**
-     * Generate a data encryption key. Generate a new data encryption key to use
-     * for cryptographic operations outside of Key Manager. Note that Key Manager
-     * does not store your data encryption key. The data encryption key is
+     * Create a data encryption key. Create a new data encryption key for
+     * cryptographic operations outside of Key Manager. The data encryption key is
      * encrypted and must be decrypted using the key you have created in Key
-     * Manager. The data encryption key's plaintext is returned in the response
-     * object, for immediate usage.
+     * Manager.
      *
-     * Always store the data encryption key's ciphertext, rather than its
-     * plaintext, which must not be stored. To retrieve your key's plaintext, call
-     * the Decrypt endpoint with your key's ID and ciphertext.
+     * The data encryption key is returned in plaintext and ciphertext but it
+     * should only be stored in its encrypted form (ciphertext). Key Manager does
+     * not store your data encryption key. To retrieve your key's plaintext, use
+     * the `Decrypt` method with your key's ID and ciphertext.
      *
      * @param request - The request {@link GenerateDataKeyRequest}
      * @returns A Promise of DataKey
      */
     generateDataKey: (request: Readonly<GenerateDataKeyRequest>) => Promise<DataKey>;
     /**
-     * Encrypt data. Encrypt data using an existing key, specified by the `key_id`
-     * parameter. Only keys with a usage set to **symmetric_encryption** are
-     * supported by this method. The maximum payload size that can be encrypted is
-     * 64KB of plaintext.
+     * Encrypt a payload. Encrypt a payload using an existing key, specified by
+     * the `key_id` parameter. Only keys with a usage set to
+     * `symmetric_encryption` are supported by this method. The maximum payload
+     * size that can be encrypted is 64 KB of plaintext.
      *
      * @param request - The request {@link EncryptRequest}
      * @returns A Promise of EncryptResponse
      */
     encrypt: (request: Readonly<EncryptRequest>) => Promise<EncryptResponse>;
     /**
-     * Decrypt data. Decrypt data using an existing key, specified by the `key_id`
-     * parameter. The maximum payload size that can be decrypted is the result of
-     * the encryption of 64KB of data (around 131KB).
+     * Decrypt an encrypted payload. Decrypt an encrypted payload using an
+     * existing key, specified by the `key_id` parameter. The maximum payload size
+     * that can be decrypted is equivalent to the encrypted output of 64 KB of
+     * data (around 131 KB).
      *
      * @param request - The request {@link DecryptRequest}
      * @returns A Promise of DecryptResponse
      */
     decrypt: (request: Readonly<DecryptRequest>) => Promise<DecryptResponse>;
     /**
-     * Import key material. Import key material to use to derive a new
-     * cryptographic key. The key's origin must be `external`.
+     * Import key material. Import externally generated key material into Key
+     * Manager to derive a new cryptographic key. The key's origin must be
+     * `external`.
      *
      * @param request - The request {@link ImportKeyMaterialRequest}
      * @returns A Promise of Key

package/dist/api/key_manager/v1alpha1/api.gen.js

@@ -8,12 +8,16 @@ const jsonContentHeaders = {
 };
 class API extends API$1 {
   /** Lists the available regions of the API. */
-  static LOCALITIES = ["fr-par", "nl-ams", "pl-waw"];
+  static LOCALITIES = [
+    "fr-par",
+    "nl-ams",
+    "pl-waw"
+  ];
   /**
    * Create a key. Create a key in a given region specified by the `region`
    * parameter. Keys only support symmetric encryption. You can use keys to
-   * encrypt or decrypt arbitrary payloads, or to generate data encryption keys
-   * that can be used without being stored in Key Manager.
+   * encrypt or decrypt arbitrary payloads, or to generate data encryption keys.
+   * **Data encryption keys are not stored in Key Manager**.
    *
    * @param request - The request {@link CreateKeyRequest}
    * @returns A Promise of Key
@@ -30,7 +34,7 @@ class API extends API$1 {
     unmarshalKey
   );
   /**
-   * Get key metadata. Retrieve the metadata of a key specified by the `region`
+   * Get key metadata. Retrieve metadata for a specified key using the `region`
    * and `key_id` parameters.
    *
    * @param request - The request {@link GetKeyRequest}
@@ -44,7 +48,7 @@ class API extends API$1 {
     unmarshalKey
   );
   /**
-   * Update a key. Update a key's metadata (name, description and tags),
+   * Update a key. Modify a key's metadata including name, description and tags,
    * specified by the `key_id` and `region` parameters.
    *
    * @param request - The request {@link UpdateKeyRequest}
@@ -62,10 +66,9 @@ class API extends API$1 {
     unmarshalKey
   );
   /**
-   * Delete a key. Delete an existing key specified by the `region` and `key_id`
-   * parameters. Deleting a key is permanent and cannot be undone. All data
-   * encrypted using this key, including data encryption keys, will become
-   * unusable.
+   * Delete a key. Permanently delete a key specified by the `region` and
+   * `key_id` parameters. This action is irreversible. Any data encrypted with
+   * this key, including data encryption keys, will no longer be decipherable.
    *
    * @param request - The request {@link DeleteKeyRequest}
    */
@@ -74,10 +77,10 @@ class API extends API$1 {
     path: `/key-manager/v1alpha1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/keys/${validatePathParam("keyId", request.keyId)}`
   });
   /**
-   * Rotate a key. Generate a new version of an existing key with randomly
-   * generated key material. Rotated keys can still be used to decrypt
-   * previously encrypted data. The key's new material will be used for
-   * subsequent encryption operations and data key generation.
+   * Rotate a key. Generate a new version of an existing key with new key
+   * material. Previous key versions remain usable to decrypt previously
+   * encrypted data, but the key's new version will be used for subsequent
+   * encryption operations and data key generation.
    *
    * @param request - The request {@link RotateKeyRequest}
    * @returns A Promise of Key
@@ -92,7 +95,7 @@ class API extends API$1 {
     unmarshalKey
   );
   /**
-   * Apply key protection. Apply key protection to a given key specified by the
+   * Apply key protection. Apply protection to a given key specified by the
    * `key_id` parameter. Applying key protection means that your key can be used
    * and modified, but it cannot be deleted.
    *
@@ -143,9 +146,9 @@ class API extends API$1 {
     unmarshalKey
   );
   /**
-   * Disable key. Disable a given key to be used for cryptographic operations.
-   * Disabling a key renders it unusable. You must specify the `region` and
-   * `key_id` parameters.
+   * Disable key. Disable a given key, preventing it to be used for
+   * cryptographic operations. Disabling a key renders it unusable. You must
+   * specify the `region` and `key_id` parameters.
    *
    * @param request - The request {@link DisableKeyRequest}
    * @returns A Promise of Key
@@ -179,25 +182,24 @@ class API extends API$1 {
     unmarshalListKeysResponse
   );
   /**
-   * List keys. Retrieve the list of keys created within all Projects of an
-   * Organization or in a given Project. You must specify the `region`, and
-   * either the `organization_id` or the `project_id`.
+   * List keys. Retrieve a list of keys across all Projects in an Organization
+   * or within a specific Project. You must specify the `region`, and either the
+   * `organization_id` or the `project_id`.
    *
    * @param request - The request {@link ListKeysRequest}
    * @returns A Promise of ListKeysResponse
    */
   listKeys = (request = {}) => enrichForPagination("keys", this.pageOfListKeys, request);
   /**
-   * Generate a data encryption key. Generate a new data encryption key to use
-   * for cryptographic operations outside of Key Manager. Note that Key Manager
-   * does not store your data encryption key. The data encryption key is
+   * Create a data encryption key. Create a new data encryption key for
+   * cryptographic operations outside of Key Manager. The data encryption key is
    * encrypted and must be decrypted using the key you have created in Key
-   * Manager. The data encryption key's plaintext is returned in the response
-   * object, for immediate usage.
+   * Manager.
    *
-   * Always store the data encryption key's ciphertext, rather than its
-   * plaintext, which must not be stored. To retrieve your key's plaintext, call
-   * the Decrypt endpoint with your key's ID and ciphertext.
+   * The data encryption key is returned in plaintext and ciphertext but it
+   * should only be stored in its encrypted form (ciphertext). Key Manager does
+   * not store your data encryption key. To retrieve your key's plaintext, use
+   * the `Decrypt` method with your key's ID and ciphertext.
    *
    * @param request - The request {@link GenerateDataKeyRequest}
    * @returns A Promise of DataKey
@@ -214,10 +216,10 @@ class API extends API$1 {
     unmarshalDataKey
   );
   /**
-   * Encrypt data. Encrypt data using an existing key, specified by the `key_id`
-   * parameter. Only keys with a usage set to **symmetric_encryption** are
-   * supported by this method. The maximum payload size that can be encrypted is
-   * 64KB of plaintext.
+   * Encrypt a payload. Encrypt a payload using an existing key, specified by
+   * the `key_id` parameter. Only keys with a usage set to
+   * `symmetric_encryption` are supported by this method. The maximum payload
+   * size that can be encrypted is 64 KB of plaintext.
    *
    * @param request - The request {@link EncryptRequest}
    * @returns A Promise of EncryptResponse
@@ -234,9 +236,10 @@ class API extends API$1 {
     unmarshalEncryptResponse
   );
   /**
-   * Decrypt data. Decrypt data using an existing key, specified by the `key_id`
-   * parameter. The maximum payload size that can be decrypted is the result of
-   * the encryption of 64KB of data (around 131KB).
+   * Decrypt an encrypted payload. Decrypt an encrypted payload using an
+   * existing key, specified by the `key_id` parameter. The maximum payload size
+   * that can be decrypted is equivalent to the encrypted output of 64 KB of
+   * data (around 131 KB).
    *
    * @param request - The request {@link DecryptRequest}
    * @returns A Promise of DecryptResponse
@@ -253,8 +256,9 @@ class API extends API$1 {
     unmarshalDecryptResponse
   );
   /**
-   * Import key material. Import key material to use to derive a new
-   * cryptographic key. The key's origin must be `external`.
+   * Import key material. Import externally generated key material into Key
+   * Manager to derive a new cryptographic key. The key's origin must be
+   * `external`.
    *
    * @param request - The request {@link ImportKeyMaterialRequest}
    * @returns A Promise of Key