@scaleway/sdk 2.29.0 → 2.30.0

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

@@ -0,0 +1,268 @@
+import type { Region } from '../../../bridge';
+export type DataKeyAlgorithmSymmetricEncryption = 'unknown_symmetric_encryption' | 'aes_256_gcm';
+export type KeyAlgorithmSymmetricEncryption = 'unknown_symmetric_encryption' | 'aes_256_gcm';
+export type KeyState = 'unknown_state' | 'enabled' | 'disabled' | 'pending_key_material';
+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).
+     */
+    rotationPeriod?: string;
+    /** Date at which the key will be rotated next. */
+    nextRotationAt?: Date;
+}
+export interface KeyUsage {
+    /** One-of ('usage'): at most one of 'symmetricEncryption' could be set. */
+    symmetricEncryption?: KeyAlgorithmSymmetricEncryption;
+}
+export interface Key {
+    /** ID of the key. */
+    id: string;
+    /** ID of the Project containing the key. */
+    projectId: string;
+    /** 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.
+     */
+    usage?: KeyUsage;
+    /**
+     * Current state of the key. Values include: `unknown_state`: key is in an
+     * unknown state. `enabled`: key can be used for cryptographic operations.
+     * `disabled`: key cannot be used for cryptographic operations.
+     */
+    state: KeyState;
+    /** The rotation count tracks the amount of times that the key was rotated. */
+    rotationCount: number;
+    /** Key creation date. */
+    createdAt?: Date;
+    /** Key last modification date. */
+    updatedAt?: Date;
+    /** Returns `true` if key protection is applied to the key. */
+    protected: boolean;
+    /** Returns `true` if the key is locked. */
+    locked: boolean;
+    /** Description of the key. */
+    description?: string;
+    /** List of the key's tags. */
+    tags: string[];
+    /** Key last rotation date. */
+    rotatedAt?: Date;
+    /** Key rotation policy. */
+    rotationPolicy?: KeyRotationPolicy;
+    /** Region of the key. */
+    region: Region;
+}
+export type CreateKeyRequest = {
+    /**
+     * Region to target. If none is passed will use default region from the
+     * config.
+     */
+    region?: Region;
+    /** ID of the Project containing the key. */
+    projectId?: string;
+    /** (Optional) Name of the key. */
+    name?: string;
+    /**
+     * See the `Key.Algorithm.SymmetricEncryption` enum for a description of
+     * values.
+     */
+    usage?: KeyUsage;
+    /** (Optional) Description of the key. */
+    description?: string;
+    /** (Optional) List of the key's tags. */
+    tags?: string[];
+    /** If not specified, no rotation policy will be applied to the key. */
+    rotationPolicy?: KeyRotationPolicy;
+    /** Default value is `false`. */
+    unprotected: boolean;
+};
+export interface DataKey {
+    /** ID of the data encryption key. */
+    keyId: string;
+    /** Symmetric encryption algorithm of the data encryption key. */
+    algorithm: DataKeyAlgorithmSymmetricEncryption;
+    /**
+     * Your data encryption key's ciphertext can be stored safely. It can only be
+     * decrypted through the keys you create in Key Manager, using the relevant
+     * key ID.
+     */
+    ciphertext: string;
+    /**
+     * (Optional) Your data encryption key's plaintext allows you to use the key
+     * immediately upon creation. It must neither be stored or shared.
+     */
+    plaintext?: string;
+    /** Data encryption key creation date. */
+    createdAt?: Date;
+}
+export type DecryptRequest = {
+    /**
+     * Region to target. If none is passed will use default region from the
+     * config.
+     */
+    region?: Region;
+    /** ID of the key to decrypt. */
+    keyId: string;
+    /** Data size must be between 1 and 131071 bytes. */
+    ciphertext: string;
+    /** The additional data must match the value passed in the encryption request. */
+    associatedData?: string;
+};
+export interface DecryptResponse {
+    /** ID of the key used for decryption. */
+    keyId: string;
+    /** Key's decrypted data. */
+    plaintext: string;
+    /**
+     * If the data was already encrypted with the latest key rotation, no output
+     * will be returned in the response object.
+     */
+    ciphertext?: string;
+}
+export type DeleteKeyRequest = {
+    /**
+     * Region to target. If none is passed will use default region from the
+     * config.
+     */
+    region?: Region;
+    /** ID of the key to delete. */
+    keyId: string;
+};
+export type DisableKeyRequest = {
+    /**
+     * Region to target. If none is passed will use default region from the
+     * config.
+     */
+    region?: Region;
+    /** ID of the key to disable. */
+    keyId: string;
+};
+export type EnableKeyRequest = {
+    /**
+     * Region to target. If none is passed will use default region from the
+     * config.
+     */
+    region?: Region;
+    /** ID of the key to enable. */
+    keyId: string;
+};
+export type EncryptRequest = {
+    /**
+     * Region to target. If none is passed will use default region from the
+     * config.
+     */
+    region?: Region;
+    /** ID of the key to encrypt. */
+    keyId: string;
+    /** Data size must be between 1 and 65535 bytes. */
+    plaintext: string;
+    /**
+     * Additional data which will not be encrypted, but authenticated and appended
+     * to the encrypted payload.
+     */
+    associatedData?: string;
+};
+export interface EncryptResponse {
+    /** ID of the key used for encryption. */
+    keyId: string;
+    /** Key's encrypted data. */
+    ciphertext: string;
+}
+export type GenerateDataKeyRequest = {
+    /**
+     * Region to target. If none is passed will use default region from the
+     * config.
+     */
+    region?: Region;
+    /** ID of the key. */
+    keyId: string;
+    /** Symmetric encryption algorithm of the data encryption key. */
+    algorithm?: DataKeyAlgorithmSymmetricEncryption;
+    /**
+     * Default value is `false`, meaning that the plaintext is returned. Set it to
+     * `true` if you do not wish the plaintext to be returned in the response
+     * object.
+     */
+    withoutPlaintext: boolean;
+};
+export type GetKeyRequest = {
+    /**
+     * Region to target. If none is passed will use default region from the
+     * config.
+     */
+    region?: Region;
+    /** ID of the key to target. */
+    keyId: string;
+};
+export type ListKeysRequest = {
+    /**
+     * Region to target. If none is passed will use default region from the
+     * config.
+     */
+    region?: Region;
+    /** (Optional) Filter by Organization ID. */
+    organizationId?: string;
+    /** (Optional) Filter by Project ID. */
+    projectId?: string;
+    orderBy?: ListKeysRequestOrderBy;
+    page?: number;
+    pageSize?: number;
+    /** (Optional) List of tags to filter on. */
+    tags?: string[];
+    /** (Optional) Filter by key name. */
+    name?: string;
+};
+export interface ListKeysResponse {
+    /** Single page of keys matching the requested criteria. */
+    keys: Key[];
+    /** Total count of keys matching the requested criteria. */
+    totalCount: number;
+}
+export type ProtectKeyRequest = {
+    /**
+     * Region to target. If none is passed will use default region from the
+     * config.
+     */
+    region?: Region;
+    /** ID of the key to apply key protection to. */
+    keyId: string;
+};
+export type RotateKeyRequest = {
+    /**
+     * Region to target. If none is passed will use default region from the
+     * config.
+     */
+    region?: Region;
+    /** ID of the key to rotate. */
+    keyId: string;
+};
+export type UnprotectKeyRequest = {
+    /**
+     * Region to target. If none is passed will use default region from the
+     * config.
+     */
+    region?: Region;
+    /** ID of the key to remove key protection from. */
+    keyId: string;
+};
+export type UpdateKeyRequest = {
+    /**
+     * Region to target. If none is passed will use default region from the
+     * config.
+     */
+    region?: Region;
+    /** ID of the key to update. */
+    keyId: string;
+    /** (Optional) Updated name of the key. */
+    name?: string;
+    /** (Optional) Updated description of the key. */
+    description?: string;
+    /** (Optional) Updated list of the key's tags. */
+    tags?: string[];
+    /** If not specified, the key's existing rotation policy applies. */
+    rotationPolicy?: KeyRotationPolicy;
+};

package/dist/api/llm_inference/v1beta1/api.gen.cjs

@@ -251,7 +251,7 @@ class API extends api.API {
     marshalling_gen.unmarshalListModelsResponse
   );
   /**
-   * List models. List all available LLM models.
+   * List models. List all available models.
    *
    * @param request - The request {@link ListModelsRequest}
    * @returns A Promise of ListModelsResponse

package/dist/api/llm_inference/v1beta1/api.gen.d.ts

@@ -2,9 +2,9 @@ import { API as ParentAPI } from '../../../bridge';
 import type { Region, WaitForOptions } from '../../../bridge';
 import type { AddDeploymentACLRulesRequest, AddDeploymentACLRulesResponse, CreateDeploymentRequest, CreateEndpointRequest, DeleteDeploymentACLRuleRequest, DeleteDeploymentRequest, DeleteEndpointRequest, Deployment, Endpoint, Eula, GetDeploymentCertificateRequest, GetDeploymentRequest, GetModelEulaRequest, GetModelRequest, ListDeploymentACLRulesRequest, ListDeploymentACLRulesResponse, ListDeploymentsRequest, ListDeploymentsResponse, ListModelsRequest, ListModelsResponse, ListNodeTypesRequest, ListNodeTypesResponse, Model, SetDeploymentACLRulesRequest, SetDeploymentACLRulesResponse, UpdateDeploymentRequest, UpdateEndpointRequest } from './types.gen';
 /**
- * LLM Inference API.
+ * Managed Inference API.
  *
- * This API allows you to manage your LLM Inference services.
+ * This API allows you to manage your Inference services.
  */
 export declare class API extends ParentAPI {
     /** Lists the available regions of the API. */
@@ -118,7 +118,7 @@ export declare class API extends ParentAPI {
     deleteDeploymentACLRule: (request: Readonly<DeleteDeploymentACLRuleRequest>) => Promise<void>;
     protected pageOfListModels: (request?: Readonly<ListModelsRequest>) => Promise<ListModelsResponse>;
     /**
-     * List models. List all available LLM models.
+     * List models. List all available models.
      *
      * @param request - The request {@link ListModelsRequest}
      * @returns A Promise of ListModelsResponse

package/dist/api/llm_inference/v1beta1/api.gen.js

@@ -249,7 +249,7 @@ class API extends API$1 {
     unmarshalListModelsResponse
   );
   /**
-   * List models. List all available LLM models.
+   * List models. List all available models.
    *
    * @param request - The request {@link ListModelsRequest}
    * @returns A Promise of ListModelsResponse

package/dist/api/llm_inference/v1beta1/types.gen.d.ts

@@ -79,8 +79,8 @@ export interface EndpointSpec {
      */
     privateNetwork?: EndpointSpecPrivateNetwork;
     /**
-     * By default, LLM deployments are protected by IAM authentication. When
-     * setting this field to true, the authentication will be disabled.
+     * By default, deployments are protected by IAM authentication. When setting
+     * this field to true, the authentication will be disabled.
      */
     disableAuth: boolean;
 }
@@ -426,8 +426,8 @@ export type UpdateEndpointRequest = {
     /** ID of the endpoint to update. */
     endpointId: string;
     /**
-     * By default, LLM deployments are protected by IAM authentication. When
-     * setting this field to true, the authentication will be disabled.
+     * By default, deployments are protected by IAM authentication. When setting
+     * this field to true, the authentication will be disabled.
      */
     disableAuth?: boolean;
 };

package/dist/index.cjs

@@ -31,21 +31,22 @@ const index$h = require("./api/ipam/index.cjs");
 const index$i = require("./api/ipfs/index.cjs");
 const index$j = require("./api/jobs/index.cjs");
 const index$k = require("./api/k8s/index.cjs");
-const index$l = require("./api/lb/index.cjs");
-const index$m = require("./api/llm_inference/index.cjs");
-const index$n = require("./api/marketplace/index.cjs");
-const index$o = require("./api/mnq/index.cjs");
-const index$p = require("./api/rdb/index.cjs");
-const index$q = require("./api/redis/index.cjs");
-const index$r = require("./api/registry/index.cjs");
-const index$s = require("./api/secret/index.cjs");
-const index$t = require("./api/serverless_sqldb/index.cjs");
+const index$l = require("./api/key_manager/index.cjs");
+const index$m = require("./api/lb/index.cjs");
+const index$n = require("./api/llm_inference/index.cjs");
+const index$o = require("./api/marketplace/index.cjs");
+const index$p = require("./api/mnq/index.cjs");
+const index$q = require("./api/rdb/index.cjs");
+const index$r = require("./api/redis/index.cjs");
+const index$s = require("./api/registry/index.cjs");
+const index$t = require("./api/secret/index.cjs");
+const index$u = require("./api/serverless_sqldb/index.cjs");
 const index_gen = require("./api/std/index.gen.cjs");
-const index$u = require("./api/test/index.cjs");
-const index$v = require("./api/tem/index.cjs");
-const index$w = require("./api/vpc/index.cjs");
-const index$x = require("./api/vpcgw/index.cjs");
-const index$y = require("./api/webhosting/index.cjs");
+const index$v = require("./api/test/index.cjs");
+const index$w = require("./api/tem/index.cjs");
+const index$x = require("./api/vpc/index.cjs");
+const index$y = require("./api/vpcgw/index.cjs");
+const index$z = require("./api/webhosting/index.cjs");
 exports.enableConsoleLogger = index.enableConsoleLogger;
 exports.setLogger = index.setLogger;
 exports.createAdvancedClient = client.createAdvancedClient;
@@ -98,18 +99,19 @@ exports.IPAM = index$h;
 exports.IPFS = index$i;
 exports.Jobs = index$j;
 exports.K8S = index$k;
-exports.LB = index$l;
-exports.LLMInference = index$m;
-exports.Marketplace = index$n;
-exports.MNQ = index$o;
-exports.RDB = index$p;
-exports.Redis = index$q;
-exports.Registry = index$r;
-exports.Secret = index$s;
-exports.ServerlessSQLDB = index$t;
+exports.KeyManager = index$l;
+exports.LB = index$m;
+exports.LLMInference = index$n;
+exports.Marketplace = index$o;
+exports.MNQ = index$p;
+exports.RDB = index$q;
+exports.Redis = index$r;
+exports.Registry = index$s;
+exports.Secret = index$t;
+exports.ServerlessSQLDB = index$u;
 exports.Std = index_gen;
-exports.Test = index$u;
-exports.TransactionalEmail = index$v;
-exports.VPC = index$w;
-exports.VPCGW = index$x;
-exports.Webhosting = index$y;
+exports.Test = index$v;
+exports.TransactionalEmail = index$w;
+exports.VPC = index$x;
+exports.VPCGW = index$y;
+exports.Webhosting = index$z;

package/dist/index.js

@@ -29,21 +29,22 @@ import * as index$g from "./api/ipam/index.js";
 import * as index$h from "./api/ipfs/index.js";
 import * as index$i from "./api/jobs/index.js";
 import * as index$j from "./api/k8s/index.js";
-import * as index$k from "./api/lb/index.js";
-import * as index$l from "./api/llm_inference/index.js";
-import * as index$m from "./api/marketplace/index.js";
-import * as index$n from "./api/mnq/index.js";
-import * as index$o from "./api/rdb/index.js";
-import * as index$p from "./api/redis/index.js";
-import * as index$q from "./api/registry/index.js";
-import * as index$r from "./api/secret/index.js";
-import * as index$s from "./api/serverless_sqldb/index.js";
+import * as index$k from "./api/key_manager/index.js";
+import * as index$l from "./api/lb/index.js";
+import * as index$m from "./api/llm_inference/index.js";
+import * as index$n from "./api/marketplace/index.js";
+import * as index$o from "./api/mnq/index.js";
+import * as index$p from "./api/rdb/index.js";
+import * as index$q from "./api/redis/index.js";
+import * as index$r from "./api/registry/index.js";
+import * as index$s from "./api/secret/index.js";
+import * as index$t from "./api/serverless_sqldb/index.js";
 import * as index_gen from "./api/std/index.gen.js";
-import * as index$t from "./api/test/index.js";
-import * as index$u from "./api/tem/index.js";
-import * as index$v from "./api/vpc/index.js";
-import * as index$w from "./api/vpcgw/index.js";
-import * as index$x from "./api/webhosting/index.js";
+import * as index$u from "./api/test/index.js";
+import * as index$v from "./api/tem/index.js";
+import * as index$w from "./api/vpc/index.js";
+import * as index$x from "./api/vpcgw/index.js";
+import * as index$y from "./api/webhosting/index.js";
 export {
   API,
   index$1 as Account,
@@ -66,21 +67,22 @@ export {
   index$e as Instance,
   index$i as Jobs,
   index$j as K8S,
-  index$k as LB,
-  index$l as LLMInference,
-  index$n as MNQ,
-  index$m as Marketplace,
-  index$o as RDB,
-  index$p as Redis,
-  index$q as Registry,
-  index$r as Secret,
-  index$s as ServerlessSQLDB,
+  index$k as KeyManager,
+  index$l as LB,
+  index$m as LLMInference,
+  index$o as MNQ,
+  index$n as Marketplace,
+  index$p as RDB,
+  index$q as Redis,
+  index$r as Registry,
+  index$s as Secret,
+  index$t as ServerlessSQLDB,
   index_gen as Std,
-  index$t as Test,
-  index$u as TransactionalEmail,
-  index$v as VPC,
-  index$w as VPCGW,
-  index$x as Webhosting,
+  index$u as Test,
+  index$v as TransactionalEmail,
+  index$w as VPC,
+  index$x as VPCGW,
+  index$y as Webhosting,
   addAsyncHeaderInterceptor,
   authenticateWithSessionToken,
   createAdvancedClient,

package/dist/scw/constants.cjs

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const version = "v2.28.0";
+const version = "v2.29.0";
 const userAgent = `scaleway-sdk-js/${version}`;
 exports.userAgent = userAgent;
 exports.version = version;

package/dist/scw/constants.d.ts

@@ -1,2 +1,2 @@
-export declare const version = "v2.28.0";
-export declare const userAgent = "scaleway-sdk-js/v2.28.0";
+export declare const version = "v2.29.0";
+export declare const userAgent = "scaleway-sdk-js/v2.29.0";

package/dist/scw/constants.js

@@ -1,4 +1,4 @@
-const version = "v2.28.0";
+const version = "v2.29.0";
 const userAgent = `scaleway-sdk-js/${version}`;
 export {
   userAgent,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scaleway/sdk",
-  "version": "2.29.0",
+  "version": "2.30.0",
   "license": "Apache-2.0",
   "description": "Scaleway SDK.",
   "keywords": [
@@ -39,5 +39,5 @@
   "bundledDependencies": [
     "@scaleway/random-name"
   ],
-  "gitHead": "2383bfeab75618f0d4a774d7722cbd11530e422c"
+  "gitHead": "da7490af39a0c2a5d2d8a7c3f7bad276eb6660e3"
 }