@scaleway/sdk 2.64.0 → 2.66.0

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

@@ -12,7 +12,11 @@ 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"
+  ];
   pageOfListClusters = (request = {}) => this.client.fetch(
     {
       method: "GET",

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

@@ -1,5 +1,5 @@
 import { API as ParentAPI } from '../../../bridge';
-import type { Region, WaitForOptions } from '../../../bridge';
+import type { Region as ScwRegion, WaitForOptions } from '../../../bridge';
 import type { AddClusterACLRulesRequest, AddClusterACLRulesResponse, AuthExternalNodeRequest, Cluster, CreateClusterRequest, CreateExternalNodeRequest, CreatePoolRequest, DeleteACLRuleRequest, DeleteClusterRequest, DeleteNodeRequest, DeletePoolRequest, ExternalNode, ExternalNodeAuth, GetClusterKubeConfigRequest, GetClusterRequest, GetNodeMetadataRequest, GetNodeRequest, GetPoolRequest, GetVersionRequest, ListClusterACLRulesRequest, ListClusterACLRulesResponse, ListClusterAvailableTypesRequest, ListClusterAvailableTypesResponse, ListClusterAvailableVersionsRequest, ListClusterAvailableVersionsResponse, ListClusterTypesRequest, ListClusterTypesResponse, ListClustersRequest, ListClustersResponse, ListNodesRequest, ListNodesResponse, ListPoolsRequest, ListPoolsResponse, ListVersionsRequest, ListVersionsResponse, MigrateClusterToSBSCSIRequest, Node, NodeMetadata, Pool, RebootNodeRequest, ReplaceNodeRequest, ResetClusterAdminTokenRequest, SetClusterACLRulesRequest, SetClusterACLRulesResponse, SetClusterTypeRequest, UpdateClusterRequest, UpdatePoolRequest, UpgradeClusterRequest, UpgradePoolRequest, Version } from './types.gen';
 /**
  * Kubernetes API.
@@ -8,7 +8,7 @@ import type { AddClusterACLRulesRequest, AddClusterACLRulesResponse, AuthExterna
  */
 export declare class API extends ParentAPI {
     /** Lists the available regions of the API. */
-    static readonly LOCALITIES: Region[];
+    static readonly LOCALITIES: ScwRegion[];
     protected pageOfListClusters: (request?: Readonly<ListClustersRequest>) => Promise<ListClustersResponse>;
     /**
      * List Clusters. List all existing Kubernetes clusters in a specific region.

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

@@ -10,7 +10,11 @@ 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"
+  ];
   pageOfListClusters = (request = {}) => this.client.fetch(
     {
       method: "GET",

package/dist/api/k8s/v1/marshalling.gen.cjs

@@ -225,6 +225,7 @@ const unmarshalExternalNode = (data) => {
     cniPluginsVersion: data.cni_plugins_version,
     containerdVersion: data.containerd_version,
     externalIp: data.external_ip,
+    iamToken: data.iam_token,
     id: data.id,
     kubeToken: data.kube_token,
     kubeletConfig: data.kubelet_config,

package/dist/api/k8s/v1/marshalling.gen.js

@@ -223,6 +223,7 @@ const unmarshalExternalNode = (data) => {
     cniPluginsVersion: data.cni_plugins_version,
     containerdVersion: data.containerd_version,
     externalIp: data.external_ip,
+    iamToken: data.iam_token,
     id: data.id,
     kubeToken: data.kube_token,
     kubeletConfig: data.kubelet_config,

package/dist/api/k8s/v1/types.gen.d.ts

@@ -1,4 +1,4 @@
-import type { Region, Zone } from '../../../bridge';
+import type { Region as ScwRegion, Zone as ScwZone } from '../../../bridge';
 export type AutoscalerEstimator = 'unknown_estimator' | 'binpacking';
 export type AutoscalerExpander = 'unknown_expander' | 'random' | 'most_pods' | 'least_waste' | 'priority' | 'price';
 export type CNI = 'unknown_cni' | 'cilium' | 'calico' | 'weave' | 'flannel' | 'kilo' | 'none';
@@ -170,7 +170,7 @@ export interface Pool {
     /** Pool upgrade policy. */
     upgradePolicy?: PoolUpgradePolicy;
     /** Zone in which the pool's nodes will be spawned. */
-    zone: Zone;
+    zone: ScwZone;
     /**
      * - `l_ssd` is a local block storage which means your system is stored locally
      *   on your node's hypervisor. This type is not available for all node types
@@ -192,7 +192,7 @@ export interface Pool {
      */
     publicIpDisabled: boolean;
     /** Cluster region of the pool. */
-    region: Region;
+    region: ScwRegion;
 }
 export interface ACLRuleRequest {
     /**
@@ -357,7 +357,7 @@ export interface CreateClusterRequestPoolConfig {
     /** Pool upgrade policy. */
     upgradePolicy?: CreateClusterRequestPoolConfigUpgradePolicy;
     /** Zone in which the pool's nodes will be spawned. */
-    zone: Zone;
+    zone: ScwZone;
     /**
      * - `l_ssd` is a local block storage which means your system is stored locally
      *   on your node's hypervisor. This type is not available for all node types
@@ -419,7 +419,7 @@ export interface Version {
     /** Label of the Kubernetes version. */
     label: string;
     /** Region in which this version is available. */
-    region: Region;
+    region: ScwRegion;
     /** Supported Container Network Interface (CNI) plugins for this version. */
     availableCnis: CNI[];
     /** Supported container runtimes for this version. */
@@ -443,7 +443,7 @@ export interface Cluster {
     /** Kubernetes version of the cluster. */
     version: string;
     /** Region in which the cluster is deployed. */
-    region: Region;
+    region: ScwRegion;
     /** ID of the Organization owning the cluster. */
     organizationId: string;
     /** ID of the Project owning the cluster. */
@@ -508,7 +508,7 @@ export interface Node {
      */
     providerId: string;
     /** Cluster region of the node. */
-    region: Region;
+    region: ScwRegion;
     /** Name of the node. */
     name: string;
     /** @deprecated Public IPv4 address of the node. */
@@ -626,7 +626,7 @@ export type AddClusterACLRulesRequest = {
      * Region to target. If none is passed will use default region from the
      * config.
      */
-    region?: Region;
+    region?: ScwRegion;
     /** ID of the cluster whose ACLs will be added. */
     clusterId: string;
     /** ACLs to add. */
@@ -641,7 +641,7 @@ export type AuthExternalNodeRequest = {
      * Region to target. If none is passed will use default region from the
      * config.
      */
-    region?: Region;
+    region?: ScwRegion;
     /** Pool the node will be attached to. */
     poolId: string;
 };
@@ -650,7 +650,7 @@ export type CreateClusterRequest = {
      * Region to target. If none is passed will use default region from the
      * config.
      */
-    region?: Region;
+    region?: ScwRegion;
     /**
      * @deprecated Organization ID in which the cluster will be created.
      *
@@ -721,7 +721,7 @@ export type CreateExternalNodeRequest = {
      * Region to target. If none is passed will use default region from the
      * config.
      */
-    region?: Region;
+    region?: ScwRegion;
     poolId: string;
 };
 export type CreatePoolRequest = {
@@ -729,7 +729,7 @@ export type CreatePoolRequest = {
      * Region to target. If none is passed will use default region from the
      * config.
      */
-    region?: Region;
+    region?: ScwRegion;
     /** Cluster ID to which the pool will be attached. */
     clusterId: string;
     /** Pool name. */
@@ -777,7 +777,7 @@ export type CreatePoolRequest = {
     /** Pool upgrade policy. */
     upgradePolicy?: CreatePoolRequestUpgradePolicy;
     /** Zone in which the pool's nodes will be spawned. */
-    zone?: Zone;
+    zone?: ScwZone;
     /**
      * - `l_ssd` is a local block storage which means your system is stored locally
      *   on your node's hypervisor. This type is not available for all node types
@@ -804,7 +804,7 @@ export type DeleteACLRuleRequest = {
      * Region to target. If none is passed will use default region from the
      * config.
      */
-    region?: Region;
+    region?: ScwRegion;
     /** ID of the ACL rule to delete. */
     aclId: string;
 };
@@ -813,7 +813,7 @@ export type DeleteClusterRequest = {
      * Region to target. If none is passed will use default region from the
      * config.
      */
-    region?: Region;
+    region?: ScwRegion;
     /** ID of the cluster to delete. */
     clusterId: string;
     /**
@@ -828,7 +828,7 @@ export type DeleteNodeRequest = {
      * Region to target. If none is passed will use default region from the
      * config.
      */
-    region?: Region;
+    region?: ScwRegion;
     /** ID of the node to replace. */
     nodeId: string;
     /**
@@ -844,7 +844,7 @@ export type DeletePoolRequest = {
      * Region to target. If none is passed will use default region from the
      * config.
      */
-    region?: Region;
+    region?: ScwRegion;
     /** ID of the pool to delete. */
     poolId: string;
 };
@@ -862,6 +862,7 @@ export interface ExternalNode {
     cniPluginsVersion: string;
     nodeLabels: Record<string, string>;
     nodeTaints: ExternalNodeCoreV1Taint[];
+    iamToken: string;
 }
 export interface ExternalNodeAuth {
     nodeSecretKey: string;
@@ -872,7 +873,7 @@ export type GetClusterKubeConfigRequest = {
      * Region to target. If none is passed will use default region from the
      * config.
      */
-    region?: Region;
+    region?: ScwRegion;
     /** Cluster ID for which to download the kubeconfig. */
     clusterId: string;
     /** Hide the legacy token from the kubeconfig. */
@@ -883,7 +884,7 @@ export type GetClusterRequest = {
      * Region to target. If none is passed will use default region from the
      * config.
      */
-    region?: Region;
+    region?: ScwRegion;
     /** ID of the requested cluster. */
     clusterId: string;
 };
@@ -892,14 +893,14 @@ export type GetNodeMetadataRequest = {
      * Region to target. If none is passed will use default region from the
      * config.
      */
-    region?: Region;
+    region?: ScwRegion;
 };
 export type GetNodeRequest = {
     /**
      * Region to target. If none is passed will use default region from the
      * config.
      */
-    region?: Region;
+    region?: ScwRegion;
     /** ID of the requested node. */
     nodeId: string;
 };
@@ -908,7 +909,7 @@ export type GetPoolRequest = {
      * Region to target. If none is passed will use default region from the
      * config.
      */
-    region?: Region;
+    region?: ScwRegion;
     /** ID of the requested pool. */
     poolId: string;
 };
@@ -917,7 +918,7 @@ export type GetVersionRequest = {
      * Region to target. If none is passed will use default region from the
      * config.
      */
-    region?: Region;
+    region?: ScwRegion;
     /** Requested version name. */
     versionName: string;
 };
@@ -926,7 +927,7 @@ export type ListClusterACLRulesRequest = {
      * Region to target. If none is passed will use default region from the
      * config.
      */
-    region?: Region;
+    region?: ScwRegion;
     /** ID of the cluster whose ACLs will be listed. */
     clusterId: string;
     /** Page number for the returned ACLs. */
@@ -945,7 +946,7 @@ export type ListClusterAvailableTypesRequest = {
      * Region to target. If none is passed will use default region from the
      * config.
      */
-    region?: Region;
+    region?: ScwRegion;
     /** Cluster ID for which the available Kubernetes types will be listed. */
     clusterId: string;
 };
@@ -960,7 +961,7 @@ export type ListClusterAvailableVersionsRequest = {
      * Region to target. If none is passed will use default region from the
      * config.
      */
-    region?: Region;
+    region?: ScwRegion;
     /** Cluster ID for which the available Kubernetes versions will be listed. */
     clusterId: string;
 };
@@ -973,7 +974,7 @@ export type ListClusterTypesRequest = {
      * Region to target. If none is passed will use default region from the
      * config.
      */
-    region?: Region;
+    region?: ScwRegion;
     /** Page number, from the paginated results, to return for cluster-types. */
     page?: number;
     /** Maximum number of clusters per page. */
@@ -990,7 +991,7 @@ export type ListClustersRequest = {
      * Region to target. If none is passed will use default region from the
      * config.
      */
-    region?: Region;
+    region?: ScwRegion;
     /** Organization ID on which to filter the returned clusters. */
     organizationId?: string;
     /** Project ID on which to filter the returned clusters. */
@@ -1027,7 +1028,7 @@ export type ListNodesRequest = {
      * Region to target. If none is passed will use default region from the
      * config.
      */
-    region?: Region;
+    region?: ScwRegion;
     /** Cluster ID from which the nodes will be listed from. */
     clusterId: string;
     /** Pool ID on which to filter the returned nodes. */
@@ -1057,7 +1058,7 @@ export type ListPoolsRequest = {
      * Region to target. If none is passed will use default region from the
      * config.
      */
-    region?: Region;
+    region?: ScwRegion;
     /** ID of the cluster whose pools will be listed. */
     clusterId: string;
     /** Sort order of returned pools. */
@@ -1085,7 +1086,7 @@ export type ListVersionsRequest = {
      * Region to target. If none is passed will use default region from the
      * config.
      */
-    region?: Region;
+    region?: ScwRegion;
 };
 export interface ListVersionsResponse {
     /** Available Kubernetes versions. */
@@ -1096,7 +1097,7 @@ export type MigrateClusterToSBSCSIRequest = {
      * Region to target. If none is passed will use default region from the
      * config.
      */
-    region?: Region;
+    region?: ScwRegion;
     /**
      * Cluster ID for which the latest CSI compatible with Scaleway Block Storage
      * will be enabled.
@@ -1122,7 +1123,7 @@ export type RebootNodeRequest = {
      * Region to target. If none is passed will use default region from the
      * config.
      */
-    region?: Region;
+    region?: ScwRegion;
     /** ID of the node to reboot. */
     nodeId: string;
 };
@@ -1131,7 +1132,7 @@ export type ReplaceNodeRequest = {
      * Region to target. If none is passed will use default region from the
      * config.
      */
-    region?: Region;
+    region?: ScwRegion;
     /** ID of the node to replace. */
     nodeId: string;
 };
@@ -1140,7 +1141,7 @@ export type ResetClusterAdminTokenRequest = {
      * Region to target. If none is passed will use default region from the
      * config.
      */
-    region?: Region;
+    region?: ScwRegion;
     /** Cluster ID on which the admin token will be renewed. */
     clusterId: string;
 };
@@ -1149,7 +1150,7 @@ export type SetClusterACLRulesRequest = {
      * Region to target. If none is passed will use default region from the
      * config.
      */
-    region?: Region;
+    region?: ScwRegion;
     /** ID of the cluster whose ACLs will be set. */
     clusterId: string;
     /** ACLs to set. */
@@ -1164,7 +1165,7 @@ export type SetClusterTypeRequest = {
      * Region to target. If none is passed will use default region from the
      * config.
      */
-    region?: Region;
+    region?: ScwRegion;
     /** ID of the cluster to migrate from one type to another. */
     clusterId: string;
     /**
@@ -1178,7 +1179,7 @@ export type UpdateClusterRequest = {
      * Region to target. If none is passed will use default region from the
      * config.
      */
-    region?: Region;
+    region?: ScwRegion;
     /** ID of the cluster to update. */
     clusterId: string;
     /** New external name for the cluster. */
@@ -1214,7 +1215,7 @@ export type UpdatePoolRequest = {
      * Region to target. If none is passed will use default region from the
      * config.
      */
-    region?: Region;
+    region?: ScwRegion;
     /** ID of the pool to update. */
     poolId: string;
     /** New value for the pool autoscaling enablement. */
@@ -1242,7 +1243,7 @@ export type UpgradeClusterRequest = {
      * Region to target. If none is passed will use default region from the
      * config.
      */
-    region?: Region;
+    region?: ScwRegion;
     /** ID of the cluster to upgrade. */
     clusterId: string;
     /**
@@ -1262,7 +1263,7 @@ export type UpgradePoolRequest = {
      * Region to target. If none is passed will use default region from the
      * config.
      */
-    region?: Region;
+    region?: ScwRegion;
     /** ID of the pool to upgrade. */
     poolId: string;
     /** New Kubernetes version for the pool. */

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