@scaleway/sdk-key-manager 1.2.0 → 1.2.2

package/dist/v1alpha1/api.gen.cjs

@@ -6,12 +6,13 @@ const jsonContentHeaders = {
   "Content-Type": "application/json; charset=utf-8"
 };
 class API extends sdkClient.API {
-  /** Lists the available regions of the API. */
-  static LOCALITIES = [
-    "fr-par",
-    "nl-ams",
-    "pl-waw"
-  ];
+  /**
+   * 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. Keys only support symmetric encryption. You can use keys to encrypt or decrypt arbitrary payloads, or to generate data encryption keys. **Data encryption keys are not stored in Key Manager**.
    *
@@ -156,7 +157,7 @@ class API extends sdkClient.API {
     },
     marshalling_gen.unmarshalKey
   );
-  pageOfListKeys = (request = {}) => this.client.fetch(
+  pageOfListKeys = (request) => this.client.fetch(
     {
       method: "GET",
       path: `/key-manager/v1alpha1/regions/${sdkClient.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/keys`,
@@ -170,6 +171,7 @@ class API extends sdkClient.API {
           request.pageSize ?? this.client.settings.defaultPageSize
         ],
         ["project_id", request.projectId],
+        ["scheduled_for_deletion", request.scheduledForDeletion],
         ["tags", request.tags],
         ["usage", request.usage]
       )
@@ -182,7 +184,7 @@ class API extends sdkClient.API {
    * @param request - The request {@link ListKeysRequest}
    * @returns A Promise of ListKeysResponse
    */
-  listKeys = (request = {}) => sdkClient.enrichForPagination("keys", this.pageOfListKeys, request);
+  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.
   
@@ -296,5 +298,20 @@ class API extends sdkClient.API {
     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
+  );
 }
 exports.API = API;

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

@@ -1,14 +1,17 @@
 import { API as ParentAPI } from '@scaleway/sdk-client';
-import type { Region as ScwRegion } from '@scaleway/sdk-client';
-import type { CreateKeyRequest, DataKey, DecryptRequest, DecryptResponse, DeleteKeyMaterialRequest, DeleteKeyRequest, DisableKeyRequest, EnableKeyRequest, EncryptRequest, EncryptResponse, GenerateDataKeyRequest, GetKeyRequest, GetPublicKeyRequest, ImportKeyMaterialRequest, Key, ListKeysRequest, ListKeysResponse, ProtectKeyRequest, PublicKey, RotateKeyRequest, SignRequest, SignResponse, UnprotectKeyRequest, UpdateKeyRequest, VerifyRequest, VerifyResponse } from './types.gen';
+import type { ApiLocality } from '@scaleway/sdk-client';
+import type { CreateKeyRequest, DataKey, DecryptRequest, DecryptResponse, DeleteKeyMaterialRequest, DeleteKeyRequest, DisableKeyRequest, EnableKeyRequest, EncryptRequest, EncryptResponse, GenerateDataKeyRequest, GetKeyRequest, GetPublicKeyRequest, ImportKeyMaterialRequest, Key, ListKeysRequest, ListKeysResponse, ProtectKeyRequest, PublicKey, RestoreKeyRequest, RotateKeyRequest, SignRequest, SignResponse, UnprotectKeyRequest, UpdateKeyRequest, VerifyRequest, VerifyResponse } from './types.gen';
 /**
  * Key Manager API.
 
 This API allows you to create, manage and use cryptographic keys in a centralized and secure service.
  */
 export declare class API extends ParentAPI {
-    /** Lists the available regions of the API. */
-    static readonly LOCALITIES: ScwRegion[];
+    /**
+     * Locality of this API.
+     * type ∈ {'zone','region','global','unspecified'}
+     */
+    static readonly LOCALITY: ApiLocality;
     /**
      * 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. **Data encryption keys are not stored in Key Manager**.
      *
@@ -78,14 +81,14 @@ export declare class API extends ParentAPI {
      * @returns A Promise of Key
      */
     disableKey: (request: Readonly<DisableKeyRequest>) => Promise<Key>;
-    protected pageOfListKeys: (request?: Readonly<ListKeysRequest>) => Promise<ListKeysResponse>;
+    protected pageOfListKeys: (request: Readonly<ListKeysRequest>) => Promise<ListKeysResponse>;
     /**
      * 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?: Readonly<ListKeysRequest>) => Promise<ListKeysResponse> & {
+    listKeys: (request: Readonly<ListKeysRequest>) => Promise<ListKeysResponse> & {
         all: () => Promise<Key[]>;
         [Symbol.asyncIterator]: () => AsyncGenerator<Key[], void, void>;
     };
@@ -139,4 +142,11 @@ export declare class API extends ParentAPI {
      * @param request - The request {@link DeleteKeyMaterialRequest}
      */
     deleteKeyMaterial: (request: Readonly<DeleteKeyMaterialRequest>) => Promise<void>;
+    /**
+     * 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: Readonly<RestoreKeyRequest>) => Promise<Key>;
 }

package/dist/v1alpha1/api.gen.js

@@ -1,15 +1,16 @@
-import { API as API$1, validatePathParam, urlParams, enrichForPagination } from "@scaleway/sdk-client";
+import { API as API$1, toApiLocality, validatePathParam, urlParams, enrichForPagination } from "@scaleway/sdk-client";
 import { marshalCreateKeyRequest, unmarshalKey, unmarshalPublicKey, marshalUpdateKeyRequest, unmarshalListKeysResponse, marshalGenerateDataKeyRequest, unmarshalDataKey, marshalEncryptRequest, unmarshalEncryptResponse, marshalDecryptRequest, unmarshalDecryptResponse, marshalSignRequest, unmarshalSignResponse, marshalVerifyRequest, unmarshalVerifyResponse, marshalImportKeyMaterialRequest } from "./marshalling.gen.js";
 const jsonContentHeaders = {
   "Content-Type": "application/json; charset=utf-8"
 };
 class API extends API$1 {
-  /** Lists the available regions of the API. */
-  static LOCALITIES = [
-    "fr-par",
-    "nl-ams",
-    "pl-waw"
-  ];
+  /**
+   * Locality of this API.
+   * type ∈ {'zone','region','global','unspecified'}
+   */
+  static LOCALITY = toApiLocality({
+    regions: ["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. **Data encryption keys are not stored in Key Manager**.
    *
@@ -154,7 +155,7 @@ class API extends API$1 {
     },
     unmarshalKey
   );
-  pageOfListKeys = (request = {}) => this.client.fetch(
+  pageOfListKeys = (request) => this.client.fetch(
     {
       method: "GET",
       path: `/key-manager/v1alpha1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/keys`,
@@ -168,6 +169,7 @@ class API extends API$1 {
           request.pageSize ?? this.client.settings.defaultPageSize
         ],
         ["project_id", request.projectId],
+        ["scheduled_for_deletion", request.scheduledForDeletion],
         ["tags", request.tags],
         ["usage", request.usage]
       )
@@ -180,7 +182,7 @@ class API extends API$1 {
    * @param request - The request {@link ListKeysRequest}
    * @returns A Promise of ListKeysResponse
    */
-  listKeys = (request = {}) => enrichForPagination("keys", this.pageOfListKeys, request);
+  listKeys = (request) => 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.
   
@@ -294,6 +296,21 @@ class API extends API$1 {
     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.
+   *
+   * @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/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/keys/${validatePathParam("keyId", request.keyId)}/restore`
+    },
+    unmarshalKey
+  );
 }
 export {
   API

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

@@ -1,3 +1,3 @@
 export { API } from './api.gen';
 export * from './marshalling.gen';
-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, ListKeysRequest, ListKeysRequestOrderBy, ListKeysRequestUsage, ListKeysResponse, ProtectKeyRequest, PublicKey, RotateKeyRequest, SignRequest, SignResponse, UnprotectKeyRequest, UpdateKeyRequest, VerifyRequest, VerifyResponse, } from './types.gen';
+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, ListKeysRequest, ListKeysRequestOrderBy, ListKeysRequestUsage, ListKeysResponse, ProtectKeyRequest, PublicKey, RestoreKeyRequest, RotateKeyRequest, SignRequest, SignResponse, UnprotectKeyRequest, UpdateKeyRequest, VerifyRequest, VerifyResponse, } from './types.gen';

package/dist/v1alpha1/marshalling.gen.cjs

@@ -32,6 +32,7 @@ const unmarshalKey = (data) => {
   }
   return {
     createdAt: sdkClient.unmarshalDate(data.created_at),
+    deletionRequestedAt: sdkClient.unmarshalDate(data.deletion_requested_at),
     description: data.description,
     id: data.id,
     locked: data.locked,

package/dist/v1alpha1/marshalling.gen.js

@@ -30,6 +30,7 @@ const unmarshalKey = (data) => {
   }
   return {
     createdAt: unmarshalDate(data.created_at),
+    deletionRequestedAt: unmarshalDate(data.deletion_requested_at),
     description: data.description,
     id: data.id,
     locked: data.locked,

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

@@ -96,6 +96,10 @@ export interface Key {
      * Refer to the `Key.Origin` enum for a description of values.
      */
     origin: KeyOrigin;
+    /**
+     * Returns the time at which deletion was requested.
+     */
+    deletionRequestedAt?: Date;
     /**
      * Region where the key is stored.
      */
@@ -346,6 +350,10 @@ export type ListKeysRequest = {
      * Select from symmetric encryption, asymmetric encryption, or asymmetric signing.
      */
     usage?: ListKeysRequestUsage;
+    /**
+     * Filter keys based on their deletion status. By default, only keys not scheduled for deletion are returned in the output.
+     */
+    scheduledForDeletion: boolean;
 };
 export interface ListKeysResponse {
     /**
@@ -370,6 +378,13 @@ export type ProtectKeyRequest = {
 export interface PublicKey {
     pem: string;
 }
+export type RestoreKeyRequest = {
+    /**
+     * Region to target. If none is passed will use default region from the config.
+     */
+    region?: ScwRegion;
+    keyId: string;
+};
 export type RotateKeyRequest = {
     /**
      * Region to target. If none is passed will use default region from the config.

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@scaleway/sdk-key-manager",
-  "version": "1.2.0",
+  "version": "1.2.2",
   "description": "Scaleway SDK key-manager",
-  "types": "dist/index.d.ts",
+  "license": "Apache-2.0",
   "files": [
     "dist"
   ],
@@ -30,13 +30,13 @@
   },
   "dependencies": {
     "@scaleway/random-name": "5.1.1",
-    "@scaleway/sdk-std": "1.0.3"
+    "@scaleway/sdk-std": "1.0.5"
   },
   "peerDependencies": {
-    "@scaleway/sdk-client": "^1.2.2"
+    "@scaleway/sdk-client": "^1.3.0"
   },
   "devDependencies": {
-    "@scaleway/sdk-client": "^1.2.2"
+    "@scaleway/sdk-client": "^1.3.0"
   },
   "scripts": {
     "package:check": "pnpm publint",