@scaleway/sdk 2.72.0 → 2.73.0

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

@@ -3,16 +3,15 @@ import type { Zone as ScwZone, WaitForOptions } from '@scaleway/sdk-client';
 import type { CreateSnapshotRequest, CreateVolumeRequest, DeleteSnapshotRequest, DeleteVolumeRequest, ExportSnapshotToObjectStorageRequest, GetSnapshotRequest, GetVolumeRequest, ImportSnapshotFromObjectStorageRequest, ListSnapshotsRequest, ListSnapshotsResponse, ListVolumeTypesRequest, ListVolumeTypesResponse, ListVolumesRequest, ListVolumesResponse, Snapshot, UpdateSnapshotRequest, UpdateVolumeRequest, Volume } from './types.gen';
 /**
  * Block Storage API.
- *
- * This API allows you to manage your Block Storage volumes.
+
+This API allows you to manage your Block Storage volumes.
  */
 export declare class API extends ParentAPI {
     /** Lists the available zones of the API. */
     static readonly LOCALITIES: ScwZone[];
     protected pageOfListVolumeTypes: (request?: Readonly<ListVolumeTypesRequest>) => Promise<ListVolumeTypesResponse>;
     /**
-     * List volume types. List all available volume types in a specified zone. The
-     * volume types listed are ordered by name in ascending order.
+     * List volume types. List all available volume types in a specified zone. The volume types listed are ordered by name in ascending order.
      *
      * @param request - The request {@link ListVolumeTypesRequest}
      * @returns A Promise of ListVolumeTypesResponse
@@ -23,9 +22,7 @@ export declare class API extends ParentAPI {
     };
     protected pageOfListVolumes: (request?: Readonly<ListVolumesRequest>) => Promise<ListVolumesResponse>;
     /**
-     * List volumes. List all existing volumes in a specified zone. By default,
-     * the volumes listed are ordered by creation date in ascending order. This
-     * can be modified via the `order_by` field.
+     * List volumes. List all existing volumes in a specified zone. By default, the volumes listed are ordered by creation date in ascending order. This can be modified via the `order_by` field.
      *
      * @param request - The request {@link ListVolumesRequest}
      * @returns A Promise of ListVolumesResponse
@@ -35,20 +32,15 @@ export declare class API extends ParentAPI {
         [Symbol.asyncIterator]: () => AsyncGenerator<Volume[], void, void>;
     };
     /**
-     * Create a volume. To create a new volume from scratch, you must specify
-     * `from_empty` and the `size`. To create a volume from an existing snapshot,
-     * specify `from_snapshot` and the `snapshot_id` in the request payload
-     * instead, size is optional and can be specified if you need to extend the
-     * original size. The volume will take on the same volume class and underlying
-     * IOPS limitations as the original snapshot.
+     * Create a volume. To create a new volume from scratch, you must specify `from_empty` and the `size`.
+  To create a volume from an existing snapshot, specify `from_snapshot` and the `snapshot_id` in the request payload instead, size is optional and can be specified if you need to extend the original size. The volume will take on the same volume class and underlying IOPS limitations as the original snapshot.
      *
      * @param request - The request {@link CreateVolumeRequest}
      * @returns A Promise of Volume
      */
     createVolume: (request?: Readonly<CreateVolumeRequest>) => Promise<Volume>;
     /**
-     * Get a volume. Retrieve technical information about a specific volume.
-     * Details such as size, type, and status are returned in the response.
+     * Get a volume. Retrieve technical information about a specific volume. Details such as size, type, and status are returned in the response.
      *
      * @param request - The request {@link GetVolumeRequest}
      * @returns A Promise of Volume
@@ -63,17 +55,14 @@ export declare class API extends ParentAPI {
      */
     waitForVolume: (request: Readonly<GetVolumeRequest>, options?: Readonly<WaitForOptions<Volume>>) => Promise<Volume>;
     /**
-     * Delete a detached volume. You must specify the `volume_id` of the volume
-     * you want to delete. The volume must not be in the `in_use` status.
+     * Delete a detached volume. You must specify the `volume_id` of the volume you want to delete. The volume must not be in the `in_use` status.
      *
      * @param request - The request {@link DeleteVolumeRequest}
      */
     deleteVolume: (request: Readonly<DeleteVolumeRequest>) => Promise<void>;
     /**
-     * Update a volume. Update the technical details of a volume, such as its
-     * name, tags, or its new size and `volume_type` (within the same Block
-     * Storage class). You can only resize a volume to a larger size. It is
-     * currently not possible to change your Block Storage Class.
+     * Update a volume. Update the technical details of a volume, such as its name, tags, or its new size and `volume_type` (within the same Block Storage class).
+  You can only resize a volume to a larger size. It is currently not possible to change your Block Storage Class.
      *
      * @param request - The request {@link UpdateVolumeRequest}
      * @returns A Promise of Volume
@@ -81,9 +70,7 @@ export declare class API extends ParentAPI {
     updateVolume: (request: Readonly<UpdateVolumeRequest>) => Promise<Volume>;
     protected pageOfListSnapshots: (request?: Readonly<ListSnapshotsRequest>) => Promise<ListSnapshotsResponse>;
     /**
-     * List all snapshots. List all available snapshots in a specified zone. By
-     * default, the snapshots listed are ordered by creation date in ascending
-     * order. This can be modified via the `order_by` field.
+     * List all snapshots. List all available snapshots in a specified zone. By default, the snapshots listed are ordered by creation date in ascending order. This can be modified via the `order_by` field.
      *
      * @param request - The request {@link ListSnapshotsRequest}
      * @returns A Promise of ListSnapshotsResponse
@@ -93,9 +80,7 @@ export declare class API extends ParentAPI {
         [Symbol.asyncIterator]: () => AsyncGenerator<Snapshot[], void, void>;
     };
     /**
-     * Get a snapshot. Retrieve technical information about a specific snapshot.
-     * Details such as size, volume type, and status are returned in the
-     * response.
+     * Get a snapshot. Retrieve technical information about a specific snapshot. Details such as size, volume type, and status are returned in the response.
      *
      * @param request - The request {@link GetSnapshotRequest}
      * @returns A Promise of Snapshot
@@ -110,34 +95,31 @@ export declare class API extends ParentAPI {
      */
     waitForSnapshot: (request: Readonly<GetSnapshotRequest>, options?: Readonly<WaitForOptions<Snapshot>>) => Promise<Snapshot>;
     /**
-     * Create a snapshot of a volume. To create a snapshot, the volume must be in
-     * the `in_use` or the `available` status. If your volume is in a transient
-     * state, you need to wait until the end of the current operation.
+     * Create a snapshot of a volume. To create a snapshot, the volume must be in the `in_use` or the `available` status.
+  If your volume is in a transient state, you need to wait until the end of the current operation.
      *
      * @param request - The request {@link CreateSnapshotRequest}
      * @returns A Promise of Snapshot
      */
     createSnapshot: (request: Readonly<CreateSnapshotRequest>) => Promise<Snapshot>;
     /**
-     * Import a snapshot from a Scaleway Object Storage bucket. The bucket must
-     * contain a QCOW2 image. The bucket can be imported into any Availability
-     * Zone as long as it is in the same region as the bucket.
+     * Import a snapshot from a Scaleway Object Storage bucket. The bucket must contain a QCOW2 image.
+  The bucket can be imported into any Availability Zone as long as it is in the same region as the bucket.
      *
      * @param request - The request {@link ImportSnapshotFromObjectStorageRequest}
      * @returns A Promise of Snapshot
      */
     importSnapshotFromObjectStorage: (request: Readonly<ImportSnapshotFromObjectStorageRequest>) => Promise<Snapshot>;
     /**
-     * Export a snapshot to a Scaleway Object Storage bucket. The snapshot is
-     * exported in QCOW2 format. The snapshot must not be in transient state.
+     * Export a snapshot to a Scaleway Object Storage bucket. The snapshot is exported in QCOW2 format.
+  The snapshot must not be in transient state.
      *
      * @param request - The request {@link ExportSnapshotToObjectStorageRequest}
      * @returns A Promise of Snapshot
      */
     exportSnapshotToObjectStorage: (request: Readonly<ExportSnapshotToObjectStorageRequest>) => Promise<Snapshot>;
     /**
-     * Delete a snapshot. You must specify the `snapshot_id` of the snapshot you
-     * want to delete. The snapshot must not be in use.
+     * Delete a snapshot. You must specify the `snapshot_id` of the snapshot you want to delete. The snapshot must not be in use.
      *
      * @param request - The request {@link DeleteSnapshotRequest}
      */

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

@@ -37,8 +37,7 @@ class API extends API$1 {
     unmarshalListVolumeTypesResponse
   );
   /**
-   * List volume types. List all available volume types in a specified zone. The
-   * volume types listed are ordered by name in ascending order.
+   * List volume types. List all available volume types in a specified zone. The volume types listed are ordered by name in ascending order.
    *
    * @param request - The request {@link ListVolumeTypesRequest}
    * @returns A Promise of ListVolumeTypesResponse
@@ -65,25 +64,19 @@ class API extends API$1 {
     unmarshalListVolumesResponse
   );
   /**
-   * List volumes. List all existing volumes in a specified zone. By default,
-   * the volumes listed are ordered by creation date in ascending order. This
-   * can be modified via the `order_by` field.
+   * List volumes. List all existing volumes in a specified zone. By default, the volumes listed are ordered by creation date in ascending order. This can be modified via the `order_by` field.
    *
    * @param request - The request {@link ListVolumesRequest}
    * @returns A Promise of ListVolumesResponse
    */
   listVolumes = (request = {}) => enrichForPagination("volumes", this.pageOfListVolumes, request);
   /**
-   * Create a volume. To create a new volume from scratch, you must specify
-   * `from_empty` and the `size`. To create a volume from an existing snapshot,
-   * specify `from_snapshot` and the `snapshot_id` in the request payload
-   * instead, size is optional and can be specified if you need to extend the
-   * original size. The volume will take on the same volume class and underlying
-   * IOPS limitations as the original snapshot.
-   *
-   * @param request - The request {@link CreateVolumeRequest}
-   * @returns A Promise of Volume
-   */
+     * Create a volume. To create a new volume from scratch, you must specify `from_empty` and the `size`.
+  To create a volume from an existing snapshot, specify `from_snapshot` and the `snapshot_id` in the request payload instead, size is optional and can be specified if you need to extend the original size. The volume will take on the same volume class and underlying IOPS limitations as the original snapshot.
+     *
+     * @param request - The request {@link CreateVolumeRequest}
+     * @returns A Promise of Volume
+     */
   createVolume = (request = {}) => this.client.fetch(
     {
       body: JSON.stringify(
@@ -96,8 +89,7 @@ class API extends API$1 {
     unmarshalVolume
   );
   /**
-   * Get a volume. Retrieve technical information about a specific volume.
-   * Details such as size, type, and status are returned in the response.
+   * Get a volume. Retrieve technical information about a specific volume. Details such as size, type, and status are returned in the response.
    *
    * @param request - The request {@link GetVolumeRequest}
    * @returns A Promise of Volume
@@ -125,8 +117,7 @@ class API extends API$1 {
     options
   );
   /**
-   * Delete a detached volume. You must specify the `volume_id` of the volume
-   * you want to delete. The volume must not be in the `in_use` status.
+   * Delete a detached volume. You must specify the `volume_id` of the volume you want to delete. The volume must not be in the `in_use` status.
    *
    * @param request - The request {@link DeleteVolumeRequest}
    */
@@ -135,14 +126,12 @@ class API extends API$1 {
     path: `/block/v1/zones/${validatePathParam("zone", request.zone ?? this.client.settings.defaultZone)}/volumes/${validatePathParam("volumeId", request.volumeId)}`
   });
   /**
-   * Update a volume. Update the technical details of a volume, such as its
-   * name, tags, or its new size and `volume_type` (within the same Block
-   * Storage class). You can only resize a volume to a larger size. It is
-   * currently not possible to change your Block Storage Class.
-   *
-   * @param request - The request {@link UpdateVolumeRequest}
-   * @returns A Promise of Volume
-   */
+     * Update a volume. Update the technical details of a volume, such as its name, tags, or its new size and `volume_type` (within the same Block Storage class).
+  You can only resize a volume to a larger size. It is currently not possible to change your Block Storage Class.
+     *
+     * @param request - The request {@link UpdateVolumeRequest}
+     * @returns A Promise of Volume
+     */
   updateVolume = (request) => this.client.fetch(
     {
       body: JSON.stringify(
@@ -175,18 +164,14 @@ class API extends API$1 {
     unmarshalListSnapshotsResponse
   );
   /**
-   * List all snapshots. List all available snapshots in a specified zone. By
-   * default, the snapshots listed are ordered by creation date in ascending
-   * order. This can be modified via the `order_by` field.
+   * List all snapshots. List all available snapshots in a specified zone. By default, the snapshots listed are ordered by creation date in ascending order. This can be modified via the `order_by` field.
    *
    * @param request - The request {@link ListSnapshotsRequest}
    * @returns A Promise of ListSnapshotsResponse
    */
   listSnapshots = (request = {}) => enrichForPagination("snapshots", this.pageOfListSnapshots, request);
   /**
-   * Get a snapshot. Retrieve technical information about a specific snapshot.
-   * Details such as size, volume type, and status are returned in the
-   * response.
+   * Get a snapshot. Retrieve technical information about a specific snapshot. Details such as size, volume type, and status are returned in the response.
    *
    * @param request - The request {@link GetSnapshotRequest}
    * @returns A Promise of Snapshot
@@ -214,13 +199,12 @@ class API extends API$1 {
     options
   );
   /**
-   * Create a snapshot of a volume. To create a snapshot, the volume must be in
-   * the `in_use` or the `available` status. If your volume is in a transient
-   * state, you need to wait until the end of the current operation.
-   *
-   * @param request - The request {@link CreateSnapshotRequest}
-   * @returns A Promise of Snapshot
-   */
+     * Create a snapshot of a volume. To create a snapshot, the volume must be in the `in_use` or the `available` status.
+  If your volume is in a transient state, you need to wait until the end of the current operation.
+     *
+     * @param request - The request {@link CreateSnapshotRequest}
+     * @returns A Promise of Snapshot
+     */
   createSnapshot = (request) => this.client.fetch(
     {
       body: JSON.stringify(
@@ -233,13 +217,12 @@ class API extends API$1 {
     unmarshalSnapshot
   );
   /**
-   * Import a snapshot from a Scaleway Object Storage bucket. The bucket must
-   * contain a QCOW2 image. The bucket can be imported into any Availability
-   * Zone as long as it is in the same region as the bucket.
-   *
-   * @param request - The request {@link ImportSnapshotFromObjectStorageRequest}
-   * @returns A Promise of Snapshot
-   */
+     * Import a snapshot from a Scaleway Object Storage bucket. The bucket must contain a QCOW2 image.
+  The bucket can be imported into any Availability Zone as long as it is in the same region as the bucket.
+     *
+     * @param request - The request {@link ImportSnapshotFromObjectStorageRequest}
+     * @returns A Promise of Snapshot
+     */
   importSnapshotFromObjectStorage = (request) => this.client.fetch(
     {
       body: JSON.stringify(
@@ -255,12 +238,12 @@ class API extends API$1 {
     unmarshalSnapshot
   );
   /**
-   * Export a snapshot to a Scaleway Object Storage bucket. The snapshot is
-   * exported in QCOW2 format. The snapshot must not be in transient state.
-   *
-   * @param request - The request {@link ExportSnapshotToObjectStorageRequest}
-   * @returns A Promise of Snapshot
-   */
+     * Export a snapshot to a Scaleway Object Storage bucket. The snapshot is exported in QCOW2 format.
+  The snapshot must not be in transient state.
+     *
+     * @param request - The request {@link ExportSnapshotToObjectStorageRequest}
+     * @returns A Promise of Snapshot
+     */
   exportSnapshotToObjectStorage = (request) => this.client.fetch(
     {
       body: JSON.stringify(
@@ -276,8 +259,7 @@ class API extends API$1 {
     unmarshalSnapshot
   );
   /**
-   * Delete a snapshot. You must specify the `snapshot_id` of the snapshot you
-   * want to delete. The snapshot must not be in use.
+   * Delete a snapshot. You must specify the `snapshot_id` of the snapshot you want to delete. The snapshot must not be in use.
    *
    * @param request - The request {@link DeleteSnapshotRequest}
    */