@scaleway/sdk 2.72.0 → 2.73.0

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

@@ -6,301 +6,383 @@ 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 {
     /**
-     * Time interval between two key rotations. The minimum duration is 24 hours
-     * and the maximum duration is 1 year (876000 hours).
+     * Time interval between two key rotations. The minimum duration is 24 hours and the maximum duration is 1 year (876000 hours).
      */
     rotationPeriod?: string;
-    /** Timestamp indicating the next scheduled rotation. */
+    /**
+     * Timestamp indicating the next scheduled rotation.
+     */
     nextRotationAt?: Date;
 }
 export interface KeyUsage {
     /**
-     * See the `Key.Algorithm.SymmetricEncryption` enum for a description of
-     * values.
+     * See the `Key.Algorithm.SymmetricEncryption` enum for a description of values.
      *
      * One-of ('usage'): at most one of 'symmetricEncryption' could be set.
      */
     symmetricEncryption?: KeyAlgorithmSymmetricEncryption;
 }
 export interface Key {
-    /** ID of the key. */
+    /**
+     * ID of the key.
+     */
     id: string;
-    /** ID of the Project containing the key. */
+    /**
+     * ID of the Project containing the key.
+     */
     projectId: string;
-    /** Name of the key. */
+    /**
+     * Name of the key.
+     */
     name: string;
     /**
-     * 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`.
+     * 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 possible values. */
+    /**
+     * See the `Key.State` enum for a description of possible values.
+     */
     state: KeyState;
-    /** The rotation count tracks the number of times the key has been rotated. */
+    /**
+     * The rotation count tracks the number of times the key has been rotated.
+     */
     rotationCount: number;
-    /** Key creation date. */
+    /**
+     * Key creation date.
+     */
     createdAt?: Date;
-    /** Key last modification date. */
+    /**
+     * Key last modification date.
+     */
     updatedAt?: Date;
-    /** Returns `true` if key protection is applied to the key. */
+    /**
+     * Returns `true` if key protection is applied to the key.
+     */
     protected: boolean;
-    /** Returns `true` if the key is locked. */
+    /**
+     * Returns `true` if the key is locked.
+     */
     locked: boolean;
-    /** Description of the key. */
+    /**
+     * Description of the key.
+     */
     description?: string;
-    /** List of the key's tags. */
+    /**
+     * List of the key's tags.
+     */
     tags: string[];
-    /** Key last rotation date. */
+    /**
+     * Key last rotation date.
+     */
     rotatedAt?: Date;
-    /** Key rotation policy. */
+    /**
+     * Key rotation policy.
+     */
     rotationPolicy?: KeyRotationPolicy;
-    /** Refer to the `Key.Origin` enum for a description of values. */
+    /**
+     * Refer to the `Key.Origin` enum for a description of values.
+     */
     origin: KeyOrigin;
-    /** Region where the key is stored. */
+    /**
+     * 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 to target. If none is passed will use default region from the config.
      */
     region?: ScwRegion;
-    /** ID of the Project containing the key. */
+    /**
+     * ID of the Project containing the key.
+     */
     projectId?: string;
-    /** (Optional) Name of the key. */
+    /**
+     * (Optional) Name of the key.
+     */
     name?: string;
     /**
-     * See the `Key.Algorithm.SymmetricEncryption` enum for a description of
-     * values.
+     * See the `Key.Algorithm.SymmetricEncryption` enum for a description of values.
      */
     usage?: KeyUsage;
-    /** (Optional) Description of the key. */
+    /**
+     * (Optional) Description of the key.
+     */
     description?: string;
-    /** (Optional) List of the key's tags. */
+    /**
+     * (Optional) List of the key's tags.
+     */
     tags?: string[];
-    /** If not specified, no rotation policy will be applied to the key. */
+    /**
+     * If not specified, no rotation policy will be applied to the key.
+     */
     rotationPolicy?: KeyRotationPolicy;
-    /** Default value is `false`. */
+    /**
+     * Default value is `false`.
+     */
     unprotected: boolean;
-    /** Refer to the `Key.Origin` enum for a description of values. */
+    /**
+     * Refer to the `Key.Origin` enum for a description of values.
+     */
     origin?: KeyOrigin;
 };
 export interface DataKey {
-    /** ID of the data encryption key. */
+    /**
+     * ID of the data encryption key.
+     */
     keyId: string;
-    /** Symmetric encryption algorithm of the data encryption key (`AES-256-GCM`). */
+    /**
+     * 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
-     * decrypted through the keys you create in Key Manager, using the relevant
-     * key ID.
+     * 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.
+     * (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. */
+    /**
+     * 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 to target. If none is passed will use default region from the config.
      */
     region?: ScwRegion;
-    /** ID of the key to decrypt. */
+    /**
+     * ID of the key to decrypt.
+     */
     keyId: string;
-    /** Data size must be between 1 and 131071 bytes. */
+    /**
+     * Data size must be between 1 and 131071 bytes.
+     */
     ciphertext: string;
-    /** The additional data must match the value passed in the encryption request. */
+    /**
+     * The additional data must match the value passed in the encryption request.
+     */
     associatedData?: string;
 };
 export interface DecryptResponse {
-    /** ID of the key used for decryption. */
+    /**
+     * ID of the key used for decryption.
+     */
     keyId: string;
-    /** Key's decrypted data. */
+    /**
+     * 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.
+     * If the data was already encrypted with the latest key rotation, no output will be returned in the response object.
      */
     ciphertext?: string;
 }
 export type DeleteKeyMaterialRequest = {
     /**
-     * Region to target. If none is passed will use default region from the
-     * config.
+     * Region to target. If none is passed will use default region from the config.
      */
     region?: ScwRegion;
-    /** ID of the key of which to delete the key material. */
+    /**
+     * ID of the key of which to delete the key material.
+     */
     keyId: string;
 };
 export type DeleteKeyRequest = {
     /**
-     * Region to target. If none is passed will use default region from the
-     * config.
+     * Region to target. If none is passed will use default region from the config.
      */
     region?: ScwRegion;
-    /** ID of the key to delete. */
+    /**
+     * 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 to target. If none is passed will use default region from the config.
      */
     region?: ScwRegion;
-    /** ID of the key to disable. */
+    /**
+     * 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 to target. If none is passed will use default region from the config.
      */
     region?: ScwRegion;
-    /** ID of the key to enable. */
+    /**
+     * 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 to target. If none is passed will use default region from the config.
      */
     region?: ScwRegion;
-    /** ID of the key to encrypt. */
+    /**
+     * ID of the key to encrypt.
+     */
     keyId: string;
-    /** Data size must be between 1 and 65535 bytes. */
+    /**
+     * 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.
+     * 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. */
+    /**
+     * ID of the key used for encryption.
+     */
     keyId: string;
-    /** Key's encrypted data. */
+    /**
+     * Key's encrypted data.
+     */
     ciphertext: string;
 }
 export type GenerateDataKeyRequest = {
     /**
-     * Region to target. If none is passed will use default region from the
-     * config.
+     * Region to target. If none is passed will use default region from the config.
      */
     region?: ScwRegion;
-    /** ID of the key. */
+    /**
+     * ID of the key.
+     */
     keyId: string;
     /**
-     * See the `DataKey.Algorithm.SymmetricEncryption` enum for a description of
-     * values.
+     * See the `DataKey.Algorithm.SymmetricEncryption` enum for a description of values.
      */
     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.
+     * 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 to target. If none is passed will use default region from the config.
      */
     region?: ScwRegion;
-    /** ID of the key to target. */
+    /**
+     * ID of the key to target.
+     */
     keyId: string;
 };
 export type ImportKeyMaterialRequest = {
     /**
-     * Region to target. If none is passed will use default region from the
-     * config.
+     * Region to target. If none is passed will use default region from the config.
      */
     region?: ScwRegion;
-    /** The key's origin must be `external`. */
+    /**
+     * The key's origin must be `external`.
+     */
     keyId: string;
     /**
-     * The key material The key material is a random sequence of bytes used to
-     * derive a cryptographic key.
+     * The key material The key material is a random sequence of bytes used to derive a cryptographic key.
      */
     keyMaterial: string;
     /**
-     * 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).
+     * 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;
 };
 export type ListKeysRequest = {
     /**
-     * Region to target. If none is passed will use default region from the
-     * config.
+     * Region to target. If none is passed will use default region from the config.
      */
     region?: ScwRegion;
-    /** (Optional) Filter by Organization ID. */
+    /**
+     * (Optional) Filter by Organization ID.
+     */
     organizationId?: string;
-    /** (Optional) Filter by Project ID. */
+    /**
+     * (Optional) Filter by Project ID.
+     */
     projectId?: string;
     orderBy?: ListKeysRequestOrderBy;
     page?: number;
     pageSize?: number;
-    /** (Optional) List of tags to filter on. */
+    /**
+     * (Optional) List of tags to filter on.
+     */
     tags?: string[];
-    /** (Optional) Filter by key name. */
+    /**
+     * (Optional) Filter by key name.
+     */
     name?: string;
 };
 export interface ListKeysResponse {
-    /** Single page of keys matching the requested criteria. */
+    /**
+     * Single page of keys matching the requested criteria.
+     */
     keys: Key[];
-    /** Total count of keys matching the requested criteria. */
+    /**
+     * 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 to target. If none is passed will use default region from the config.
      */
     region?: ScwRegion;
-    /** ID of the key to apply key protection to. */
+    /**
+     * 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 to target. If none is passed will use default region from the config.
      */
     region?: ScwRegion;
-    /** ID of the key to rotate. */
+    /**
+     * 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 to target. If none is passed will use default region from the config.
      */
     region?: ScwRegion;
-    /** ID of the key to remove key protection from. */
+    /**
+     * 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 to target. If none is passed will use default region from the config.
      */
     region?: ScwRegion;
-    /** ID of the key to update. */
+    /**
+     * ID of the key to update.
+     */
     keyId: string;
-    /** (Optional) Updated name of the key. */
+    /**
+     * (Optional) Updated name of the key.
+     */
     name?: string;
-    /** (Optional) Updated description of the key. */
+    /**
+     * (Optional) Updated description of the key.
+     */
     description?: string;
-    /** (Optional) Updated list of the key's tags. */
+    /**
+     * (Optional) Updated list of the key's tags.
+     */
     tags?: string[];
-    /** If not specified, the key's existing rotation policy applies. */
+    /**
+     * If not specified, the key's existing rotation policy applies.
+     */
     rotationPolicy?: KeyRotationPolicy;
 };

package/dist/api/marketplace/v2/api.gen.cjs

@@ -26,16 +26,14 @@ class API extends api.API {
     marshalling_gen.unmarshalListImagesResponse
   );
   /**
-   * List marketplace images. List all available images on the marketplace,
-   * their UUID, CPU architecture and description.
+   * List marketplace images. List all available images on the marketplace, their UUID, CPU architecture and description.
    *
    * @param request - The request {@link ListImagesRequest}
    * @returns A Promise of ListImagesResponse
    */
   listImages = (request) => resourcePaginator.enrichForPagination("images", this.pageOfListImages, request);
   /**
-   * Get a specific marketplace image. Get detailed information about a
-   * marketplace image, specified by its `image_id` (UUID format).
+   * Get a specific marketplace image. Get detailed information about a marketplace image, specified by its `image_id` (UUID format).
    *
    * @param request - The request {@link GetImageRequest}
    * @returns A Promise of Image
@@ -64,17 +62,14 @@ class API extends api.API {
     marshalling_gen.unmarshalListVersionsResponse
   );
   /**
-   * List versions of an Image. Get a list of all available version of an image,
-   * specified by its `image_id` (UUID format).
+   * List versions of an Image. Get a list of all available version of an image, specified by its `image_id` (UUID format).
    *
    * @param request - The request {@link ListVersionsRequest}
    * @returns A Promise of ListVersionsResponse
    */
   listVersions = (request) => resourcePaginator.enrichForPagination("versions", this.pageOfListVersions, request);
   /**
-   * Get a specific image version. Get information such as the name, creation
-   * date, last update and published date for an image version specified by its
-   * `version_id` (UUID format).
+   * Get a specific image version. Get information such as the name, creation date, last update and published date for an image version specified by its `version_id` (UUID format).
    *
    * @param request - The request {@link GetVersionRequest}
    * @returns A Promise of Version
@@ -111,20 +106,14 @@ class API extends api.API {
     marshalling_gen.unmarshalListLocalImagesResponse
   );
   /**
-   * List local images from a specific image or version. List information about
-   * local images in a specific Availability Zone, specified by its `image_id`
-   * (UUID format), `version_id` (UUID format) or `image_label`. Only one of
-   * these three parameters may be set.
+   * List local images from a specific image or version. List information about local images in a specific Availability Zone, specified by its `image_id` (UUID format), `version_id` (UUID format) or `image_label`. Only one of these three parameters may be set.
    *
    * @param request - The request {@link ListLocalImagesRequest}
    * @returns A Promise of ListLocalImagesResponse
    */
   listLocalImages = (request = {}) => resourcePaginator.enrichForPagination("localImages", this.pageOfListLocalImages, request);
   /**
-   * Get a specific local image by ID. Get detailed information about a local
-   * image, including compatible commercial types, supported architecture,
-   * labels and the Availability Zone of the image, specified by its
-   * `local_image_id` (UUID format).
+   * Get a specific local image by ID. Get detailed information about a local image, including compatible commercial types, supported architecture, labels and the Availability Zone of the image, specified by its `local_image_id` (UUID format).
    *
    * @param request - The request {@link GetLocalImageRequest}
    * @returns A Promise of LocalImage
@@ -151,16 +140,14 @@ class API extends api.API {
     marshalling_gen.unmarshalListCategoriesResponse
   );
   /**
-   * List existing image categories. Get a list of all existing categories. The
-   * output can be paginated.
+   * List existing image categories. Get a list of all existing categories. The output can be paginated.
    *
    * @param request - The request {@link ListCategoriesRequest}
    * @returns A Promise of ListCategoriesResponse
    */
   listCategories = (request = {}) => resourcePaginator.enrichForPagination("categories", this.pageOfListCategories, request);
   /**
-   * Get a specific category. Get information about a specific category of the
-   * marketplace catalog, specified by its `category_id` (UUID format).
+   * Get a specific category. Get information about a specific category of the marketplace catalog, specified by its `category_id` (UUID format).
    *
    * @param request - The request {@link GetCategoryRequest}
    * @returns A Promise of Category

package/dist/api/marketplace/v2/api.gen.d.ts

@@ -2,15 +2,13 @@ import { API as ParentAPI } from '@scaleway/sdk-client';
 import type { Category, GetCategoryRequest, GetImageRequest, GetLocalImageRequest, GetVersionRequest, Image, ListCategoriesRequest, ListCategoriesResponse, ListImagesRequest, ListImagesResponse, ListLocalImagesRequest, ListLocalImagesResponse, ListVersionsRequest, ListVersionsResponse, LocalImage, Version } from './types.gen';
 /**
  * Marketplace API.
- *
- * This API allows you to find available images for use when launching a
- * Scaleway Instance.
+
+This API allows you to find available images for use when launching a Scaleway Instance.
  */
 export declare class API extends ParentAPI {
     protected pageOfListImages: (request: Readonly<ListImagesRequest>) => Promise<ListImagesResponse>;
     /**
-     * List marketplace images. List all available images on the marketplace,
-     * their UUID, CPU architecture and description.
+     * List marketplace images. List all available images on the marketplace, their UUID, CPU architecture and description.
      *
      * @param request - The request {@link ListImagesRequest}
      * @returns A Promise of ListImagesResponse
@@ -20,8 +18,7 @@ export declare class API extends ParentAPI {
         [Symbol.asyncIterator]: () => AsyncGenerator<Image[], void, void>;
     };
     /**
-     * Get a specific marketplace image. Get detailed information about a
-     * marketplace image, specified by its `image_id` (UUID format).
+     * Get a specific marketplace image. Get detailed information about a marketplace image, specified by its `image_id` (UUID format).
      *
      * @param request - The request {@link GetImageRequest}
      * @returns A Promise of Image
@@ -29,8 +26,7 @@ export declare class API extends ParentAPI {
     getImage: (request: Readonly<GetImageRequest>) => Promise<Image>;
     protected pageOfListVersions: (request: Readonly<ListVersionsRequest>) => Promise<ListVersionsResponse>;
     /**
-     * List versions of an Image. Get a list of all available version of an image,
-     * specified by its `image_id` (UUID format).
+     * List versions of an Image. Get a list of all available version of an image, specified by its `image_id` (UUID format).
      *
      * @param request - The request {@link ListVersionsRequest}
      * @returns A Promise of ListVersionsResponse
@@ -40,9 +36,7 @@ export declare class API extends ParentAPI {
         [Symbol.asyncIterator]: () => AsyncGenerator<Version[], void, void>;
     };
     /**
-     * Get a specific image version. Get information such as the name, creation
-     * date, last update and published date for an image version specified by its
-     * `version_id` (UUID format).
+     * Get a specific image version. Get information such as the name, creation date, last update and published date for an image version specified by its `version_id` (UUID format).
      *
      * @param request - The request {@link GetVersionRequest}
      * @returns A Promise of Version
@@ -50,10 +44,7 @@ export declare class API extends ParentAPI {
     getVersion: (request: Readonly<GetVersionRequest>) => Promise<Version>;
     protected pageOfListLocalImages: (request?: Readonly<ListLocalImagesRequest>) => Promise<ListLocalImagesResponse>;
     /**
-     * List local images from a specific image or version. List information about
-     * local images in a specific Availability Zone, specified by its `image_id`
-     * (UUID format), `version_id` (UUID format) or `image_label`. Only one of
-     * these three parameters may be set.
+     * List local images from a specific image or version. List information about local images in a specific Availability Zone, specified by its `image_id` (UUID format), `version_id` (UUID format) or `image_label`. Only one of these three parameters may be set.
      *
      * @param request - The request {@link ListLocalImagesRequest}
      * @returns A Promise of ListLocalImagesResponse
@@ -63,10 +54,7 @@ export declare class API extends ParentAPI {
         [Symbol.asyncIterator]: () => AsyncGenerator<LocalImage[], void, void>;
     };
     /**
-     * Get a specific local image by ID. Get detailed information about a local
-     * image, including compatible commercial types, supported architecture,
-     * labels and the Availability Zone of the image, specified by its
-     * `local_image_id` (UUID format).
+     * Get a specific local image by ID. Get detailed information about a local image, including compatible commercial types, supported architecture, labels and the Availability Zone of the image, specified by its `local_image_id` (UUID format).
      *
      * @param request - The request {@link GetLocalImageRequest}
      * @returns A Promise of LocalImage
@@ -74,8 +62,7 @@ export declare class API extends ParentAPI {
     getLocalImage: (request: Readonly<GetLocalImageRequest>) => Promise<LocalImage>;
     protected pageOfListCategories: (request?: Readonly<ListCategoriesRequest>) => Promise<ListCategoriesResponse>;
     /**
-     * List existing image categories. Get a list of all existing categories. The
-     * output can be paginated.
+     * List existing image categories. Get a list of all existing categories. The output can be paginated.
      *
      * @param request - The request {@link ListCategoriesRequest}
      * @returns A Promise of ListCategoriesResponse
@@ -85,8 +72,7 @@ export declare class API extends ParentAPI {
         [Symbol.asyncIterator]: () => AsyncGenerator<Category[], void, void>;
     };
     /**
-     * Get a specific category. Get information about a specific category of the
-     * marketplace catalog, specified by its `category_id` (UUID format).
+     * Get a specific category. Get information about a specific category of the marketplace catalog, specified by its `category_id` (UUID format).
      *
      * @param request - The request {@link GetCategoryRequest}
      * @returns A Promise of Category