@scaleway/sdk 2.64.0 → 2.65.0

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

@@ -1,4 +1,4 @@
-import type { Region } from '../../../bridge';
+import type { Region as ScwRegion } from '../../../bridge';
 export type DataKeyAlgorithmSymmetricEncryption = 'unknown_symmetric_encryption' | 'aes_256_gcm';
 export type KeyAlgorithmSymmetricEncryption = 'unknown_symmetric_encryption' | 'aes_256_gcm';
 export type KeyOrigin = 'unknown_origin' | 'scaleway_kms' | 'external';
@@ -6,11 +6,11 @@ export type KeyState = 'unknown_state' | 'enabled' | 'disabled' | 'pending_key_m
 export type ListKeysRequestOrderBy = 'name_asc' | 'name_desc' | 'created_at_asc' | 'created_at_desc' | 'updated_at_asc' | 'updated_at_desc';
 export interface KeyRotationPolicy {
     /**
-     * Duration between two key rotations. The minimum duration is 24 hours and
-     * the maximum duration is 876000 hours (1 year).
+     * Time interval between two key rotations. The minimum duration is 24 hours
+     * and the maximum duration is 1 year (876000 hours).
      */
     rotationPeriod?: string;
-    /** Date at which the key will be rotated next. */
+    /** Timestamp indicating the next scheduled rotation. */
     nextRotationAt?: Date;
 }
 export interface KeyUsage {
@@ -30,14 +30,14 @@ export interface Key {
     /** Name of the key. */
     name: string;
     /**
-     * Keys with a usage set to `symmetric_encryption` are used to encrypt and
-     * decrypt data. The only key algorithm currently supported by Key Manager is
-     * AES-256-GCM.
+     * Keys with a usage set to `symmetric_encryption` can encrypt and decrypt
+     * data using the `AES-256-GCM` key algorithm. Key Manager currently only
+     * supports `AES-256-GCM`.
      */
     usage?: KeyUsage;
-    /** See the `Key.State` enum for a description of values. */
+    /** See the `Key.State` enum for a description of possible values. */
     state: KeyState;
-    /** The rotation count tracks the amount of times that the key was rotated. */
+    /** The rotation count tracks the number of times the key has been rotated. */
     rotationCount: number;
     /** Key creation date. */
     createdAt?: Date;
@@ -57,15 +57,15 @@ export interface Key {
     rotationPolicy?: KeyRotationPolicy;
     /** Refer to the `Key.Origin` enum for a description of values. */
     origin: KeyOrigin;
-    /** Region of the key. */
-    region: Region;
+    /** Region where the key is stored. */
+    region: ScwRegion;
 }
 export type CreateKeyRequest = {
     /**
      * Region to target. If none is passed will use default region from the
      * config.
      */
-    region?: Region;
+    region?: ScwRegion;
     /** ID of the Project containing the key. */
     projectId?: string;
     /** (Optional) Name of the key. */
@@ -89,7 +89,7 @@ export type CreateKeyRequest = {
 export interface DataKey {
     /** ID of the data encryption key. */
     keyId: string;
-    /** Symmetric encryption algorithm of the data encryption key. */
+    /** Symmetric encryption algorithm of the data encryption key (`AES-256-GCM`). */
     algorithm: DataKeyAlgorithmSymmetricEncryption;
     /**
      * Your data encryption key's ciphertext can be stored safely. It can only be
@@ -110,7 +110,7 @@ export type DecryptRequest = {
      * Region to target. If none is passed will use default region from the
      * config.
      */
-    region?: Region;
+    region?: ScwRegion;
     /** ID of the key to decrypt. */
     keyId: string;
     /** Data size must be between 1 and 131071 bytes. */
@@ -134,7 +134,7 @@ export type DeleteKeyMaterialRequest = {
      * Region to target. If none is passed will use default region from the
      * config.
      */
-    region?: Region;
+    region?: ScwRegion;
     /** ID of the key of which to delete the key material. */
     keyId: string;
 };
@@ -143,7 +143,7 @@ export type DeleteKeyRequest = {
      * Region to target. If none is passed will use default region from the
      * config.
      */
-    region?: Region;
+    region?: ScwRegion;
     /** ID of the key to delete. */
     keyId: string;
 };
@@ -152,7 +152,7 @@ export type DisableKeyRequest = {
      * Region to target. If none is passed will use default region from the
      * config.
      */
-    region?: Region;
+    region?: ScwRegion;
     /** ID of the key to disable. */
     keyId: string;
 };
@@ -161,7 +161,7 @@ export type EnableKeyRequest = {
      * Region to target. If none is passed will use default region from the
      * config.
      */
-    region?: Region;
+    region?: ScwRegion;
     /** ID of the key to enable. */
     keyId: string;
 };
@@ -170,7 +170,7 @@ export type EncryptRequest = {
      * Region to target. If none is passed will use default region from the
      * config.
      */
-    region?: Region;
+    region?: ScwRegion;
     /** ID of the key to encrypt. */
     keyId: string;
     /** Data size must be between 1 and 65535 bytes. */
@@ -192,7 +192,7 @@ export type GenerateDataKeyRequest = {
      * Region to target. If none is passed will use default region from the
      * config.
      */
-    region?: Region;
+    region?: ScwRegion;
     /** ID of the key. */
     keyId: string;
     /**
@@ -212,7 +212,7 @@ export type GetKeyRequest = {
      * Region to target. If none is passed will use default region from the
      * config.
      */
-    region?: Region;
+    region?: ScwRegion;
     /** ID of the key to target. */
     keyId: string;
 };
@@ -221,8 +221,8 @@ export type ImportKeyMaterialRequest = {
      * Region to target. If none is passed will use default region from the
      * config.
      */
-    region?: Region;
-    /** The key's origin must be 'external'. */
+    region?: ScwRegion;
+    /** The key's origin must be `external`. */
     keyId: string;
     /**
      * The key material The key material is a random sequence of bytes used to
@@ -230,8 +230,9 @@ export type ImportKeyMaterialRequest = {
      */
     keyMaterial: string;
     /**
-     * A salt can be used to improve the quality of randomness when the key
-     * material is generated from a low entropy source.
+     * A salt is random data added to key material to ensure unique derived keys,
+     * even if the input is similar. It helps strengthen security when the key
+     * material has low randomness (low entropy).
      */
     salt?: string;
 };
@@ -240,7 +241,7 @@ export type ListKeysRequest = {
      * Region to target. If none is passed will use default region from the
      * config.
      */
-    region?: Region;
+    region?: ScwRegion;
     /** (Optional) Filter by Organization ID. */
     organizationId?: string;
     /** (Optional) Filter by Project ID. */
@@ -264,7 +265,7 @@ export type ProtectKeyRequest = {
      * Region to target. If none is passed will use default region from the
      * config.
      */
-    region?: Region;
+    region?: ScwRegion;
     /** ID of the key to apply key protection to. */
     keyId: string;
 };
@@ -273,7 +274,7 @@ export type RotateKeyRequest = {
      * Region to target. If none is passed will use default region from the
      * config.
      */
-    region?: Region;
+    region?: ScwRegion;
     /** ID of the key to rotate. */
     keyId: string;
 };
@@ -282,7 +283,7 @@ export type UnprotectKeyRequest = {
      * Region to target. If none is passed will use default region from the
      * config.
      */
-    region?: Region;
+    region?: ScwRegion;
     /** ID of the key to remove key protection from. */
     keyId: string;
 };
@@ -291,7 +292,7 @@ export type UpdateKeyRequest = {
      * Region to target. If none is passed will use default region from the
      * config.
      */
-    region?: Region;
+    region?: ScwRegion;
     /** ID of the key to update. */
     keyId: string;
     /** (Optional) Updated name of the key. */

package/dist/api/lb/v1/api.gen.cjs

@@ -1078,7 +1078,11 @@ class ZonedAPI extends api.API {
 }
 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"
+  ];
   pageOfListLbs = (request = {}) => this.client.fetch(
     {
       method: "GET",

package/dist/api/lb/v1/api.gen.d.ts

@@ -1,5 +1,5 @@
 import { API as ParentAPI } from '../../../bridge';
-import type { Region, WaitForOptions, Zone } from '../../../bridge';
+import type { Region as ScwRegion, Zone as ScwZone, WaitForOptions } from '../../../bridge';
 import type { Acl, AddBackendServersRequest, AttachPrivateNetworkRequest, Backend, Certificate, CreateAclRequest, CreateBackendRequest, CreateCertificateRequest, CreateFrontendRequest, CreateIpRequest, CreateLbRequest, CreateRouteRequest, CreateSubscriberRequest, DeleteAclRequest, DeleteBackendRequest, DeleteCertificateRequest, DeleteFrontendRequest, DeleteLbRequest, DeleteRouteRequest, DeleteSubscriberRequest, DetachPrivateNetworkRequest, Frontend, GetAclRequest, GetBackendRequest, GetCertificateRequest, GetFrontendRequest, GetIpRequest, GetLbRequest, GetLbStatsRequest, GetRouteRequest, GetSubscriberRequest, HealthCheck, Ip, Lb, LbStats, ListAclResponse, ListAclsRequest, ListBackendStatsRequest, ListBackendStatsResponse, ListBackendsRequest, ListBackendsResponse, ListCertificatesRequest, ListCertificatesResponse, ListFrontendsRequest, ListFrontendsResponse, ListIPsRequest, ListIpsResponse, ListLbPrivateNetworksRequest, ListLbPrivateNetworksResponse, ListLbTypesRequest, ListLbTypesResponse, ListLbsRequest, ListLbsResponse, ListRoutesRequest, ListRoutesResponse, ListSubscriberRequest, ListSubscriberResponse, MigrateLbRequest, PrivateNetwork, ReleaseIpRequest, RemoveBackendServersRequest, Route, SetAclsResponse, SetBackendServersRequest, SubscribeToLbRequest, Subscriber, UnsubscribeFromLbRequest, UpdateAclRequest, UpdateBackendRequest, UpdateCertificateRequest, UpdateFrontendRequest, UpdateHealthCheckRequest, UpdateIpRequest, UpdateLbRequest, UpdateRouteRequest, UpdateSubscriberRequest, ZonedApiAddBackendServersRequest, ZonedApiAttachPrivateNetworkRequest, ZonedApiCreateAclRequest, ZonedApiCreateBackendRequest, ZonedApiCreateCertificateRequest, ZonedApiCreateFrontendRequest, ZonedApiCreateIpRequest, ZonedApiCreateLbRequest, ZonedApiCreateRouteRequest, ZonedApiCreateSubscriberRequest, ZonedApiDeleteAclRequest, ZonedApiDeleteBackendRequest, ZonedApiDeleteCertificateRequest, ZonedApiDeleteFrontendRequest, ZonedApiDeleteLbRequest, ZonedApiDeleteRouteRequest, ZonedApiDeleteSubscriberRequest, ZonedApiDetachPrivateNetworkRequest, ZonedApiGetAclRequest, ZonedApiGetBackendRequest, ZonedApiGetCertificateRequest, ZonedApiGetFrontendRequest, ZonedApiGetIpRequest, ZonedApiGetLbRequest, ZonedApiGetLbStatsRequest, ZonedApiGetRouteRequest, ZonedApiGetSubscriberRequest, ZonedApiListAclsRequest, ZonedApiListBackendStatsRequest, ZonedApiListBackendsRequest, ZonedApiListCertificatesRequest, ZonedApiListFrontendsRequest, ZonedApiListIPsRequest, ZonedApiListLbPrivateNetworksRequest, ZonedApiListLbTypesRequest, ZonedApiListLbsRequest, ZonedApiListRoutesRequest, ZonedApiListSubscriberRequest, ZonedApiMigrateLbRequest, ZonedApiReleaseIpRequest, ZonedApiRemoveBackendServersRequest, ZonedApiSetAclsRequest, ZonedApiSetBackendServersRequest, ZonedApiSubscribeToLbRequest, ZonedApiUnsubscribeFromLbRequest, ZonedApiUpdateAclRequest, ZonedApiUpdateBackendRequest, ZonedApiUpdateCertificateRequest, ZonedApiUpdateFrontendRequest, ZonedApiUpdateHealthCheckRequest, ZonedApiUpdateIpRequest, ZonedApiUpdateLbRequest, ZonedApiUpdateRouteRequest, ZonedApiUpdateSubscriberRequest } from './types.gen';
 /**
  * Load Balancer API.
@@ -8,7 +8,7 @@ import type { Acl, AddBackendServersRequest, AttachPrivateNetworkRequest, Backen
  */
 export declare class ZonedAPI extends ParentAPI {
     /** Lists the available zones of the API. */
-    static readonly LOCALITIES: Zone[];
+    static readonly LOCALITIES: ScwZone[];
     protected pageOfListLbs: (request?: Readonly<ZonedApiListLbsRequest>) => Promise<ListLbsResponse>;
     /**
      * List Load Balancers. List all Load Balancers in the specified zone, for a
@@ -562,7 +562,7 @@ export declare class ZonedAPI extends ParentAPI {
  */
 export declare class API extends ParentAPI {
     /** Lists the available regions of the API. */
-    static readonly LOCALITIES: Region[];
+    static readonly LOCALITIES: ScwRegion[];
     protected pageOfListLbs: (request?: Readonly<ListLbsRequest>) => Promise<ListLbsResponse>;
     /**
      * List load balancers.

package/dist/api/lb/v1/api.gen.js

@@ -1076,7 +1076,11 @@ class ZonedAPI extends API$1 {
 }
 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"
+  ];
   pageOfListLbs = (request = {}) => this.client.fetch(
     {
       method: "GET",