@scaleway/sdk-key-manager 1.4.0 → 2.1.1

package/README.md

@@ -0,0 +1,96 @@
+# @scaleway/sdk-key-manager
+
+[![npm version](https://img.shields.io/npm/v/@scaleway/sdk-key-manager.svg)](https://www.npmjs.com/package/@scaleway/sdk-key-manager)
+[![npm downloads](https://img.shields.io/npm/dm/@scaleway/sdk-key-manager.svg)](https://www.npmjs.com/package/@scaleway/sdk-key-manager)
+[![license](https://img.shields.io/npm/l/@scaleway/sdk-key-manager.svg)](https://github.com/scaleway/scaleway-sdk-js/blob/master/LICENSE)
+
+Scaleway SDK for Key Manager API.
+
+> **Note**  
+> This is an automatically generated package that is part of the [Scaleway SDK for JavaScript](https://github.com/scaleway/scaleway-sdk-js).
+
+## Installation
+
+```bash
+npm install @scaleway/sdk-key-manager @scaleway/sdk-client
+```
+
+or with pnpm:
+
+```bash
+pnpm add @scaleway/sdk-key-manager @scaleway/sdk-client
+```
+
+or with yarn:
+
+```bash
+yarn add @scaleway/sdk-key-manager @scaleway/sdk-client
+```
+
+## Getting Started
+
+You'll need a pair of access and secret keys to connect to Scaleway API. Please check the [documentation](https://www.scaleway.com/en/docs/identity-and-access-management/iam/how-to/create-api-keys/) on how to retrieve them.
+
+### Basic Usage
+
+```typescript
+import { createClient } from '@scaleway/sdk-client'
+import { KeyManager } from '@scaleway/sdk-key-manager'
+
+const client = createClient({
+  accessKey: 'SCWXXXXXXXXXXXXXXXXX',
+  secretKey: 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx',
+  defaultProjectId: 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx',
+  defaultRegion: 'fr-par',
+  defaultZone: 'fr-par-1',
+})
+
+const api = new KeyManager.v1.API(client)
+
+// Use the API
+// Example: await api.listServers()
+```
+
+### Using Configuration Loader
+
+For a simpler setup, you can load credentials from the configuration file or environment variables:
+
+```typescript
+import { createClient } from '@scaleway/sdk-client'
+import { loadProfileFromConfigurationFile } from '@scaleway/configuration-loader'
+import { KeyManager } from '@scaleway/sdk-key-manager'
+
+const profile = loadProfileFromConfigurationFile()
+const client = createClient(profile)
+const api = new KeyManager.v1.API(client)
+```
+
+## Documentation
+
+- 📚 [Scaleway SDK Reference Documentation](https://scaleway.github.io/scaleway-sdk-js)
+- 🌐 [Scaleway Key Manager API Documentation](https://www.scaleway.com/en/developers/api/key-manager/)
+- 📖 [Main Repository](https://github.com/scaleway/scaleway-sdk-js)
+- 💡 [Example Projects](https://github.com/scaleway/scaleway-sdk-js/tree/master/examples)
+
+## Features
+
+- ✅ Full TypeScript support with complete type definitions
+- ✅ Promise-based API
+- ✅ Automatic pagination helpers
+- ✅ Built-in error handling
+- ✅ Compatible with Node.js ≥ 20
+
+## Support
+
+We love feedback! Feel free to reach us on:
+- [Scaleway Slack community](https://slack.scaleway.com/) - Join us on [#opensource](https://scaleway-community.slack.com/app_redirect?channel=opensource)
+- [GitHub Issues](https://github.com/scaleway/scaleway-sdk-js/issues)
+
+## Contributing
+
+This repository is at its early stage and is still in active development. If you are looking for a way to contribute, please read [CONTRIBUTING.md](https://github.com/scaleway/scaleway-sdk-js/blob/master/CONTRIBUTING.md).
+
+## License
+
+This project is Apache 2.0 licensed. See the [LICENSE](https://github.com/scaleway/scaleway-sdk-js/blob/master/LICENSE) file for details.
+

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

@@ -1,5 +1,5 @@
-import { API as ParentAPI } from '@scaleway/sdk-client';
 import type { ApiLocality } from '@scaleway/sdk-client';
+import { API as ParentAPI } from '@scaleway/sdk-client';
 import type { CreateKeyRequest, DataKey, DecryptRequest, DecryptResponse, DeleteKeyMaterialRequest, DeleteKeyRequest, DisableKeyRequest, EnableKeyRequest, EncryptRequest, EncryptResponse, GenerateDataKeyRequest, GetKeyRequest, GetPublicKeyRequest, ImportKeyMaterialRequest, Key, ListAlgorithmsRequest, ListAlgorithmsResponse, ListKeysRequest, ListKeysResponse, ProtectKeyRequest, PublicKey, RestoreKeyRequest, RotateKeyRequest, SignRequest, SignResponse, UnprotectKeyRequest, UpdateKeyRequest, VerifyRequest, VerifyResponse } from './types.gen.js';
 /**
  * Key Manager API.

package/dist/v1alpha1/api.gen.js

@@ -9,7 +9,11 @@ class API extends API$1 {
    * type ∈ {'zone','region','global','unspecified'}
    */
   static LOCALITY = toApiLocality({
-    regions: ["fr-par", "nl-ams", "pl-waw"]
+    regions: [
+      "fr-par",
+      "nl-ams",
+      "pl-waw"
+    ]
   });
   /**
    * Create a key. Create a key in a given region specified by the `region` parameter. You can use keys to encrypt or decrypt arbitrary payloads, to sign and verify messages or to generate data encryption keys. **Data encryption keys are not stored in Key Manager**.
@@ -76,10 +80,12 @@ class API extends API$1 {
    *
    * @param request - The request {@link DeleteKeyRequest}
    */
-  deleteKey = (request) => this.client.fetch({
-    method: "DELETE",
-    path: `/key-manager/v1alpha1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/keys/${validatePathParam("keyId", request.keyId)}`
-  });
+  deleteKey = (request) => this.client.fetch(
+    {
+      method: "DELETE",
+      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 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.
    *
@@ -164,10 +170,7 @@ class API extends API$1 {
         ["order_by", request.orderBy],
         ["organization_id", request.organizationId],
         ["page", request.page],
-        [
-          "page_size",
-          request.pageSize ?? this.client.settings.defaultPageSize
-        ],
+        ["page_size", request.pageSize ?? this.client.settings.defaultPageSize],
         ["project_id", request.projectId],
         ["scheduled_for_deletion", request.scheduledForDeletion],
         ["tags", request.tags],
@@ -244,7 +247,9 @@ class API extends API$1 {
    */
   sign = (request) => this.client.fetch(
     {
-      body: JSON.stringify(marshalSignRequest(request, this.client.settings)),
+      body: JSON.stringify(
+        marshalSignRequest(request, this.client.settings)
+      ),
       headers: jsonContentHeaders,
       method: "POST",
       path: `/key-manager/v1alpha1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/keys/${validatePathParam("keyId", request.keyId)}/sign`
@@ -290,12 +295,14 @@ class API extends API$1 {
    *
    * @param request - The request {@link DeleteKeyMaterialRequest}
    */
-  deleteKeyMaterial = (request) => this.client.fetch({
-    body: "{}",
-    headers: jsonContentHeaders,
-    method: "POST",
-    path: `/key-manager/v1alpha1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/keys/${validatePathParam("keyId", request.keyId)}/delete-key-material`
-  });
+  deleteKeyMaterial = (request) => this.client.fetch(
+    {
+      body: "{}",
+      headers: jsonContentHeaders,
+      method: "POST",
+      path: `/key-manager/v1alpha1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/keys/${validatePathParam("keyId", request.keyId)}/delete-key-material`
+    }
+  );
   /**
    * Restore a key. Restore a key and all its rotations scheduled for deletion specified by the `region` and `key_id` parameters.
    *
@@ -321,7 +328,9 @@ class API extends API$1 {
     {
       method: "GET",
       path: `/key-manager/v1alpha1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/algorithms`,
-      urlParams: urlParams(["usages", request.usages])
+      urlParams: urlParams(
+        ["usages", request.usages]
+      )
     },
     unmarshalListAlgorithmsResponse
   );

package/dist/v1alpha1/index.gen.d.ts

@@ -1,3 +1,3 @@
-export { API } from './api.gen.js';
+export { API, } from './api.gen.js';
 export * from './marshalling.gen.js';
 export type { CreateKeyRequest, DataKey, DataKeyAlgorithmSymmetricEncryption, DecryptRequest, DecryptResponse, DeleteKeyMaterialRequest, DeleteKeyRequest, DisableKeyRequest, EnableKeyRequest, EncryptRequest, EncryptResponse, GenerateDataKeyRequest, GetKeyRequest, GetPublicKeyRequest, ImportKeyMaterialRequest, Key, KeyAlgorithmAsymmetricEncryption, KeyAlgorithmAsymmetricSigning, KeyAlgorithmSymmetricEncryption, KeyOrigin, KeyRotationPolicy, KeyState, KeyUsage, ListAlgorithmsRequest, ListAlgorithmsRequestUsage, ListAlgorithmsResponse, ListAlgorithmsResponseAlgorithm, ListKeysRequest, ListKeysRequestOrderBy, ListKeysRequestUsage, ListKeysResponse, ProtectKeyRequest, PublicKey, RestoreKeyRequest, RotateKeyRequest, SignRequest, SignResponse, UnprotectKeyRequest, UpdateKeyRequest, VerifyRequest, VerifyResponse, } from './types.gen.js';

package/dist/v1alpha1/marshalling.gen.js

@@ -104,10 +104,7 @@ const unmarshalListAlgorithmsResponse = (data) => {
     );
   }
   return {
-    algorithms: unmarshalArrayOfObject(
-      data.algorithms,
-      unmarshalListAlgorithmsResponseAlgorithm
-    )
+    algorithms: unmarshalArrayOfObject(data.algorithms, unmarshalListAlgorithmsResponseAlgorithm)
   };
 };
 const unmarshalListKeysResponse = (data) => {
@@ -159,9 +156,18 @@ const marshalKeyRotationPolicy = (request, defaults) => ({
 });
 const marshalKeyUsage = (request, defaults) => ({
   ...resolveOneOf([
-    { param: "symmetric_encryption", value: request.symmetricEncryption },
-    { param: "asymmetric_encryption", value: request.asymmetricEncryption },
-    { param: "asymmetric_signing", value: request.asymmetricSigning }
+    {
+      param: "symmetric_encryption",
+      value: request.symmetricEncryption
+    },
+    {
+      param: "asymmetric_encryption",
+      value: request.asymmetricEncryption
+    },
+    {
+      param: "asymmetric_signing",
+      value: request.asymmetricSigning
+    }
   ])
 });
 const marshalCreateKeyRequest = (request, defaults) => ({

package/package.json

@@ -1,23 +1,20 @@
 {
   "name": "@scaleway/sdk-key-manager",
-  "version": "1.4.0",
+  "version": "2.1.1",
   "description": "Scaleway SDK key-manager",
   "license": "Apache-2.0",
   "files": [
+    "README.md",
     "dist"
   ],
   "type": "module",
   "exports": {
     ".": {
       "types": "./dist/index.gen.d.ts",
-      "import": "./dist/index.gen.js",
-      "require": "./dist/index.gen.cjs",
       "default": "./dist/index.gen.js"
     },
     "./*": {
       "types": "./dist/*/index.gen.d.ts",
-      "import": "./dist/*/index.gen.js",
-      "require": "./dist/*/index.gen.cjs",
       "default": "./dist/*/index.gen.js"
     }
   },
@@ -26,17 +23,17 @@
     "directory": "packages_generated/key-manager"
   },
   "engines": {
-    "node": ">=20.19.4"
+    "node": ">=20.19.6"
   },
   "dependencies": {
     "@scaleway/random-name": "5.1.2",
-    "@scaleway/sdk-std": "1.1.0"
+    "@scaleway/sdk-std": "2.1.0"
   },
   "peerDependencies": {
-    "@scaleway/sdk-client": "^1.3.2"
+    "@scaleway/sdk-client": "^2.1.0"
   },
   "devDependencies": {
-    "@scaleway/sdk-client": "^1.3.2"
+    "@scaleway/sdk-client": "^2.1.0"
   },
   "scripts": {
     "package:check": "pnpm publint",

package/dist/index.gen.cjs

@@ -1,4 +0,0 @@
-"use strict";
-Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const index_gen = require("./v1alpha1/index.gen.cjs");
-exports.KeyManagerv1alpha1 = index_gen;

package/dist/v1alpha1/api.gen.cjs

@@ -1,331 +0,0 @@
-"use strict";
-Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const sdkClient = require("@scaleway/sdk-client");
-const marshalling_gen = require("./marshalling.gen.cjs");
-const jsonContentHeaders = {
-  "Content-Type": "application/json; charset=utf-8"
-};
-class API extends sdkClient.API {
-  /**
-   * Locality of this API.
-   * type ∈ {'zone','region','global','unspecified'}
-   */
-  static LOCALITY = sdkClient.toApiLocality({
-    regions: ["fr-par", "nl-ams", "pl-waw"]
-  });
-  /**
-   * Create a key. Create a key in a given region specified by the `region` parameter. You can use keys to encrypt or decrypt arbitrary payloads, to sign and verify messages 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) => this.client.fetch(
-    {
-      body: JSON.stringify(
-        marshalling_gen.marshalCreateKeyRequest(request, this.client.settings)
-      ),
-      headers: jsonContentHeaders,
-      method: "POST",
-      path: `/key-manager/v1alpha1/regions/${sdkClient.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/keys`
-    },
-    marshalling_gen.unmarshalKey
-  );
-  /**
-   * Get key metadata. Retrieve metadata for a specified key using the `region` and `key_id` parameters.
-   *
-   * @param request - The request {@link GetKeyRequest}
-   * @returns A Promise of Key
-   */
-  getKey = (request) => this.client.fetch(
-    {
-      method: "GET",
-      path: `/key-manager/v1alpha1/regions/${sdkClient.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/keys/${sdkClient.validatePathParam("keyId", request.keyId)}`
-    },
-    marshalling_gen.unmarshalKey
-  );
-  /**
-   * Get the public key in PEM format.. Retrieves the public portion of an asymmetric cryptographic key in PEM format.
-   *
-   * @param request - The request {@link GetPublicKeyRequest}
-   * @returns A Promise of PublicKey
-   */
-  getPublicKey = (request) => this.client.fetch(
-    {
-      method: "GET",
-      path: `/key-manager/v1alpha1/regions/${sdkClient.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/keys/${sdkClient.validatePathParam("keyId", request.keyId)}/public-key`
-    },
-    marshalling_gen.unmarshalPublicKey
-  );
-  /**
-   * 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}
-   * @returns A Promise of Key
-   */
-  updateKey = (request) => this.client.fetch(
-    {
-      body: JSON.stringify(
-        marshalling_gen.marshalUpdateKeyRequest(request, this.client.settings)
-      ),
-      headers: jsonContentHeaders,
-      method: "PATCH",
-      path: `/key-manager/v1alpha1/regions/${sdkClient.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/keys/${sdkClient.validatePathParam("keyId", request.keyId)}`
-    },
-    marshalling_gen.unmarshalKey
-  );
-  /**
-   * 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) => this.client.fetch({
-    method: "DELETE",
-    path: `/key-manager/v1alpha1/regions/${sdkClient.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/keys/${sdkClient.validatePathParam("keyId", request.keyId)}`
-  });
-  /**
-   * 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) => this.client.fetch(
-    {
-      body: "{}",
-      headers: jsonContentHeaders,
-      method: "POST",
-      path: `/key-manager/v1alpha1/regions/${sdkClient.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/keys/${sdkClient.validatePathParam("keyId", request.keyId)}/rotate`
-    },
-    marshalling_gen.unmarshalKey
-  );
-  /**
-   * 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.
-   *
-   * @param request - The request {@link ProtectKeyRequest}
-   * @returns A Promise of Key
-   */
-  protectKey = (request) => this.client.fetch(
-    {
-      body: "{}",
-      headers: jsonContentHeaders,
-      method: "POST",
-      path: `/key-manager/v1alpha1/regions/${sdkClient.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/keys/${sdkClient.validatePathParam("keyId", request.keyId)}/protect`
-    },
-    marshalling_gen.unmarshalKey
-  );
-  /**
-   * Remove key protection. Remove key protection from a given key specified by the `key_id` parameter. Removing key protection means that your key can be deleted anytime.
-   *
-   * @param request - The request {@link UnprotectKeyRequest}
-   * @returns A Promise of Key
-   */
-  unprotectKey = (request) => this.client.fetch(
-    {
-      body: "{}",
-      headers: jsonContentHeaders,
-      method: "POST",
-      path: `/key-manager/v1alpha1/regions/${sdkClient.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/keys/${sdkClient.validatePathParam("keyId", request.keyId)}/unprotect`
-    },
-    marshalling_gen.unmarshalKey
-  );
-  /**
-   * Enable key. Enable a given key to be used for cryptographic operations. Enabling a key allows you to make a disabled key usable again. You must specify the `region` and `key_id` parameters.
-   *
-   * @param request - The request {@link EnableKeyRequest}
-   * @returns A Promise of Key
-   */
-  enableKey = (request) => this.client.fetch(
-    {
-      body: "{}",
-      headers: jsonContentHeaders,
-      method: "POST",
-      path: `/key-manager/v1alpha1/regions/${sdkClient.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/keys/${sdkClient.validatePathParam("keyId", request.keyId)}/enable`
-    },
-    marshalling_gen.unmarshalKey
-  );
-  /**
-   * 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
-   */
-  disableKey = (request) => this.client.fetch(
-    {
-      body: "{}",
-      headers: jsonContentHeaders,
-      method: "POST",
-      path: `/key-manager/v1alpha1/regions/${sdkClient.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/keys/${sdkClient.validatePathParam("keyId", request.keyId)}/disable`
-    },
-    marshalling_gen.unmarshalKey
-  );
-  pageOfListKeys = (request) => this.client.fetch(
-    {
-      method: "GET",
-      path: `/key-manager/v1alpha1/regions/${sdkClient.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/keys`,
-      urlParams: sdkClient.urlParams(
-        ["name", request.name],
-        ["order_by", request.orderBy],
-        ["organization_id", request.organizationId],
-        ["page", request.page],
-        [
-          "page_size",
-          request.pageSize ?? this.client.settings.defaultPageSize
-        ],
-        ["project_id", request.projectId],
-        ["scheduled_for_deletion", request.scheduledForDeletion],
-        ["tags", request.tags],
-        ["usage", request.usage]
-      )
-    },
-    marshalling_gen.unmarshalListKeysResponse
-  );
-  /**
-   * 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) => sdkClient.enrichForPagination("keys", this.pageOfListKeys, request);
-  /**
-     * 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 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) => this.client.fetch(
-    {
-      body: JSON.stringify(
-        marshalling_gen.marshalGenerateDataKeyRequest(request, this.client.settings)
-      ),
-      headers: jsonContentHeaders,
-      method: "POST",
-      path: `/key-manager/v1alpha1/regions/${sdkClient.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/keys/${sdkClient.validatePathParam("keyId", request.keyId)}/generate-data-key`
-    },
-    marshalling_gen.unmarshalDataKey
-  );
-  /**
-   * Encrypt a payload. Encrypt a payload using an existing key, specified by the `key_id` parameter. 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) => this.client.fetch(
-    {
-      body: JSON.stringify(
-        marshalling_gen.marshalEncryptRequest(request, this.client.settings)
-      ),
-      headers: jsonContentHeaders,
-      method: "POST",
-      path: `/key-manager/v1alpha1/regions/${sdkClient.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/keys/${sdkClient.validatePathParam("keyId", request.keyId)}/encrypt`
-    },
-    marshalling_gen.unmarshalEncryptResponse
-  );
-  /**
-   * 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) => this.client.fetch(
-    {
-      body: JSON.stringify(
-        marshalling_gen.marshalDecryptRequest(request, this.client.settings)
-      ),
-      headers: jsonContentHeaders,
-      method: "POST",
-      path: `/key-manager/v1alpha1/regions/${sdkClient.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/keys/${sdkClient.validatePathParam("keyId", request.keyId)}/decrypt`
-    },
-    marshalling_gen.unmarshalDecryptResponse
-  );
-  /**
-   * Sign a message digest. Use a given key to sign a message digest. The key must have its usage set to `asymmetric_signing`. The digest must be created using the same digest algorithm that is defined in the key's algorithm configuration.
-   *
-   * @param request - The request {@link SignRequest}
-   * @returns A Promise of SignResponse
-   */
-  sign = (request) => this.client.fetch(
-    {
-      body: JSON.stringify(marshalling_gen.marshalSignRequest(request, this.client.settings)),
-      headers: jsonContentHeaders,
-      method: "POST",
-      path: `/key-manager/v1alpha1/regions/${sdkClient.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/keys/${sdkClient.validatePathParam("keyId", request.keyId)}/sign`
-    },
-    marshalling_gen.unmarshalSignResponse
-  );
-  /**
-   * Verify a message signature. Use a given key to verify a message signature against a message digest. The key must have its usage set to `asymmetric_signing`. The message digest must be generated using the same digest algorithm that is defined in the key's algorithm configuration.
-   *
-   * @param request - The request {@link VerifyRequest}
-   * @returns A Promise of VerifyResponse
-   */
-  verify = (request) => this.client.fetch(
-    {
-      body: JSON.stringify(
-        marshalling_gen.marshalVerifyRequest(request, this.client.settings)
-      ),
-      headers: jsonContentHeaders,
-      method: "POST",
-      path: `/key-manager/v1alpha1/regions/${sdkClient.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/keys/${sdkClient.validatePathParam("keyId", request.keyId)}/verify`
-    },
-    marshalling_gen.unmarshalVerifyResponse
-  );
-  /**
-   * 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
-   */
-  importKeyMaterial = (request) => this.client.fetch(
-    {
-      body: JSON.stringify(
-        marshalling_gen.marshalImportKeyMaterialRequest(request, this.client.settings)
-      ),
-      headers: jsonContentHeaders,
-      method: "POST",
-      path: `/key-manager/v1alpha1/regions/${sdkClient.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/keys/${sdkClient.validatePathParam("keyId", request.keyId)}/import-key-material`
-    },
-    marshalling_gen.unmarshalKey
-  );
-  /**
-   * Delete key material. Delete previously imported key material. This renders the associated cryptographic key unusable for any operation. The key's origin must be `external`.
-   *
-   * @param request - The request {@link DeleteKeyMaterialRequest}
-   */
-  deleteKeyMaterial = (request) => this.client.fetch({
-    body: "{}",
-    headers: jsonContentHeaders,
-    method: "POST",
-    path: `/key-manager/v1alpha1/regions/${sdkClient.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/keys/${sdkClient.validatePathParam("keyId", request.keyId)}/delete-key-material`
-  });
-  /**
-   * Restore a key. Restore a key and all its rotations scheduled for deletion specified by the `region` and `key_id` parameters.
-   *
-   * @param request - The request {@link RestoreKeyRequest}
-   * @returns A Promise of Key
-   */
-  restoreKey = (request) => this.client.fetch(
-    {
-      body: "{}",
-      headers: jsonContentHeaders,
-      method: "POST",
-      path: `/key-manager/v1alpha1/regions/${sdkClient.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/keys/${sdkClient.validatePathParam("keyId", request.keyId)}/restore`
-    },
-    marshalling_gen.unmarshalKey
-  );
-  /**
-   * List all available algorithms. Lists all cryptographic algorithms supported by the Key Manager service.
-   *
-   * @param request - The request {@link ListAlgorithmsRequest}
-   * @returns A Promise of ListAlgorithmsResponse
-   */
-  listAlgorithms = (request = {}) => this.client.fetch(
-    {
-      method: "GET",
-      path: `/key-manager/v1alpha1/regions/${sdkClient.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/algorithms`,
-      urlParams: sdkClient.urlParams(["usages", request.usages])
-    },
-    marshalling_gen.unmarshalListAlgorithmsResponse
-  );
-}
-exports.API = API;

package/dist/v1alpha1/index.gen.cjs

@@ -1,22 +0,0 @@
-"use strict";
-Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const api_gen = require("./api.gen.cjs");
-const marshalling_gen = require("./marshalling.gen.cjs");
-exports.API = api_gen.API;
-exports.marshalCreateKeyRequest = marshalling_gen.marshalCreateKeyRequest;
-exports.marshalDecryptRequest = marshalling_gen.marshalDecryptRequest;
-exports.marshalEncryptRequest = marshalling_gen.marshalEncryptRequest;
-exports.marshalGenerateDataKeyRequest = marshalling_gen.marshalGenerateDataKeyRequest;
-exports.marshalImportKeyMaterialRequest = marshalling_gen.marshalImportKeyMaterialRequest;
-exports.marshalSignRequest = marshalling_gen.marshalSignRequest;
-exports.marshalUpdateKeyRequest = marshalling_gen.marshalUpdateKeyRequest;
-exports.marshalVerifyRequest = marshalling_gen.marshalVerifyRequest;
-exports.unmarshalDataKey = marshalling_gen.unmarshalDataKey;
-exports.unmarshalDecryptResponse = marshalling_gen.unmarshalDecryptResponse;
-exports.unmarshalEncryptResponse = marshalling_gen.unmarshalEncryptResponse;
-exports.unmarshalKey = marshalling_gen.unmarshalKey;
-exports.unmarshalListAlgorithmsResponse = marshalling_gen.unmarshalListAlgorithmsResponse;
-exports.unmarshalListKeysResponse = marshalling_gen.unmarshalListKeysResponse;
-exports.unmarshalPublicKey = marshalling_gen.unmarshalPublicKey;
-exports.unmarshalSignResponse = marshalling_gen.unmarshalSignResponse;
-exports.unmarshalVerifyResponse = marshalling_gen.unmarshalVerifyResponse;

package/dist/v1alpha1/marshalling.gen.cjs

@@ -1,224 +0,0 @@
-"use strict";
-Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const sdkClient = require("@scaleway/sdk-client");
-const unmarshalKeyRotationPolicy = (data) => {
-  if (!sdkClient.isJSONObject(data)) {
-    throw new TypeError(
-      `Unmarshalling the type 'KeyRotationPolicy' failed as data isn't a dictionary.`
-    );
-  }
-  return {
-    nextRotationAt: sdkClient.unmarshalDate(data.next_rotation_at),
-    rotationPeriod: data.rotation_period
-  };
-};
-const unmarshalKeyUsage = (data) => {
-  if (!sdkClient.isJSONObject(data)) {
-    throw new TypeError(
-      `Unmarshalling the type 'KeyUsage' failed as data isn't a dictionary.`
-    );
-  }
-  return {
-    asymmetricEncryption: data.asymmetric_encryption ? data.asymmetric_encryption : void 0,
-    asymmetricSigning: data.asymmetric_signing ? data.asymmetric_signing : void 0,
-    symmetricEncryption: data.symmetric_encryption ? data.symmetric_encryption : void 0
-  };
-};
-const unmarshalKey = (data) => {
-  if (!sdkClient.isJSONObject(data)) {
-    throw new TypeError(
-      `Unmarshalling the type 'Key' failed as data isn't a dictionary.`
-    );
-  }
-  return {
-    createdAt: sdkClient.unmarshalDate(data.created_at),
-    deletionRequestedAt: sdkClient.unmarshalDate(data.deletion_requested_at),
-    description: data.description,
-    id: data.id,
-    locked: data.locked,
-    name: data.name,
-    origin: data.origin,
-    projectId: data.project_id,
-    protected: data.protected,
-    region: data.region,
-    rotatedAt: sdkClient.unmarshalDate(data.rotated_at),
-    rotationCount: data.rotation_count,
-    rotationPolicy: data.rotation_policy ? unmarshalKeyRotationPolicy(data.rotation_policy) : void 0,
-    state: data.state,
-    tags: data.tags,
-    updatedAt: sdkClient.unmarshalDate(data.updated_at),
-    usage: data.usage ? unmarshalKeyUsage(data.usage) : void 0
-  };
-};
-const unmarshalDataKey = (data) => {
-  if (!sdkClient.isJSONObject(data)) {
-    throw new TypeError(
-      `Unmarshalling the type 'DataKey' failed as data isn't a dictionary.`
-    );
-  }
-  return {
-    algorithm: data.algorithm,
-    ciphertext: data.ciphertext,
-    createdAt: sdkClient.unmarshalDate(data.created_at),
-    keyId: data.key_id,
-    plaintext: data.plaintext
-  };
-};
-const unmarshalDecryptResponse = (data) => {
-  if (!sdkClient.isJSONObject(data)) {
-    throw new TypeError(
-      `Unmarshalling the type 'DecryptResponse' failed as data isn't a dictionary.`
-    );
-  }
-  return {
-    ciphertext: data.ciphertext,
-    keyId: data.key_id,
-    plaintext: data.plaintext
-  };
-};
-const unmarshalEncryptResponse = (data) => {
-  if (!sdkClient.isJSONObject(data)) {
-    throw new TypeError(
-      `Unmarshalling the type 'EncryptResponse' failed as data isn't a dictionary.`
-    );
-  }
-  return {
-    ciphertext: data.ciphertext,
-    keyId: data.key_id
-  };
-};
-const unmarshalListAlgorithmsResponseAlgorithm = (data) => {
-  if (!sdkClient.isJSONObject(data)) {
-    throw new TypeError(
-      `Unmarshalling the type 'ListAlgorithmsResponseAlgorithm' failed as data isn't a dictionary.`
-    );
-  }
-  return {
-    name: data.name,
-    recommended: data.recommended,
-    usage: data.usage
-  };
-};
-const unmarshalListAlgorithmsResponse = (data) => {
-  if (!sdkClient.isJSONObject(data)) {
-    throw new TypeError(
-      `Unmarshalling the type 'ListAlgorithmsResponse' failed as data isn't a dictionary.`
-    );
-  }
-  return {
-    algorithms: sdkClient.unmarshalArrayOfObject(
-      data.algorithms,
-      unmarshalListAlgorithmsResponseAlgorithm
-    )
-  };
-};
-const unmarshalListKeysResponse = (data) => {
-  if (!sdkClient.isJSONObject(data)) {
-    throw new TypeError(
-      `Unmarshalling the type 'ListKeysResponse' failed as data isn't a dictionary.`
-    );
-  }
-  return {
-    keys: sdkClient.unmarshalArrayOfObject(data.keys, unmarshalKey),
-    totalCount: data.total_count
-  };
-};
-const unmarshalPublicKey = (data) => {
-  if (!sdkClient.isJSONObject(data)) {
-    throw new TypeError(
-      `Unmarshalling the type 'PublicKey' failed as data isn't a dictionary.`
-    );
-  }
-  return {
-    pem: data.pem
-  };
-};
-const unmarshalSignResponse = (data) => {
-  if (!sdkClient.isJSONObject(data)) {
-    throw new TypeError(
-      `Unmarshalling the type 'SignResponse' failed as data isn't a dictionary.`
-    );
-  }
-  return {
-    keyId: data.key_id,
-    signature: data.signature
-  };
-};
-const unmarshalVerifyResponse = (data) => {
-  if (!sdkClient.isJSONObject(data)) {
-    throw new TypeError(
-      `Unmarshalling the type 'VerifyResponse' failed as data isn't a dictionary.`
-    );
-  }
-  return {
-    keyId: data.key_id,
-    valid: data.valid
-  };
-};
-const marshalKeyRotationPolicy = (request, defaults) => ({
-  next_rotation_at: request.nextRotationAt,
-  rotation_period: request.rotationPeriod
-});
-const marshalKeyUsage = (request, defaults) => ({
-  ...sdkClient.resolveOneOf([
-    { param: "symmetric_encryption", value: request.symmetricEncryption },
-    { param: "asymmetric_encryption", value: request.asymmetricEncryption },
-    { param: "asymmetric_signing", value: request.asymmetricSigning }
-  ])
-});
-const marshalCreateKeyRequest = (request, defaults) => ({
-  description: request.description,
-  name: request.name,
-  origin: request.origin,
-  project_id: request.projectId ?? defaults.defaultProjectId,
-  rotation_policy: request.rotationPolicy !== void 0 ? marshalKeyRotationPolicy(request.rotationPolicy) : void 0,
-  tags: request.tags,
-  unprotected: request.unprotected,
-  usage: request.usage !== void 0 ? marshalKeyUsage(request.usage) : void 0
-});
-const marshalDecryptRequest = (request, defaults) => ({
-  associated_data: request.associatedData,
-  ciphertext: request.ciphertext
-});
-const marshalEncryptRequest = (request, defaults) => ({
-  associated_data: request.associatedData,
-  plaintext: request.plaintext
-});
-const marshalGenerateDataKeyRequest = (request, defaults) => ({
-  algorithm: request.algorithm,
-  without_plaintext: request.withoutPlaintext
-});
-const marshalImportKeyMaterialRequest = (request, defaults) => ({
-  key_material: request.keyMaterial,
-  salt: request.salt
-});
-const marshalSignRequest = (request, defaults) => ({
-  digest: request.digest
-});
-const marshalUpdateKeyRequest = (request, defaults) => ({
-  description: request.description,
-  name: request.name,
-  rotation_policy: request.rotationPolicy !== void 0 ? marshalKeyRotationPolicy(request.rotationPolicy) : void 0,
-  tags: request.tags
-});
-const marshalVerifyRequest = (request, defaults) => ({
-  digest: request.digest,
-  signature: request.signature
-});
-exports.marshalCreateKeyRequest = marshalCreateKeyRequest;
-exports.marshalDecryptRequest = marshalDecryptRequest;
-exports.marshalEncryptRequest = marshalEncryptRequest;
-exports.marshalGenerateDataKeyRequest = marshalGenerateDataKeyRequest;
-exports.marshalImportKeyMaterialRequest = marshalImportKeyMaterialRequest;
-exports.marshalSignRequest = marshalSignRequest;
-exports.marshalUpdateKeyRequest = marshalUpdateKeyRequest;
-exports.marshalVerifyRequest = marshalVerifyRequest;
-exports.unmarshalDataKey = unmarshalDataKey;
-exports.unmarshalDecryptResponse = unmarshalDecryptResponse;
-exports.unmarshalEncryptResponse = unmarshalEncryptResponse;
-exports.unmarshalKey = unmarshalKey;
-exports.unmarshalListAlgorithmsResponse = unmarshalListAlgorithmsResponse;
-exports.unmarshalListKeysResponse = unmarshalListKeysResponse;
-exports.unmarshalPublicKey = unmarshalPublicKey;
-exports.unmarshalSignResponse = unmarshalSignResponse;
-exports.unmarshalVerifyResponse = unmarshalVerifyResponse;