@scaleway/sdk 2.0.0-alpha.13 → 2.0.0-alpha.15

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

@@ -0,0 +1,249 @@
+import { waitForResource } from '../../../internal/async/interval-retrier.js';
+import { API as API$1 } from '../../../scw/api.js';
+import { validatePathParam, urlParams } from '../../../helpers/marshalling.js';
+import { enrichForPagination } from '../../../scw/fetch/resource-paginator.js';
+import { VOLUME_TRANSIENT_STATUSES, SNAPSHOT_TRANSIENT_STATUSES } from './content.gen.js';
+import { unmarshalListVolumeTypesResponse, unmarshalListVolumesResponse, marshalCreateVolumeRequest, unmarshalVolume, marshalUpdateVolumeRequest, unmarshalListSnapshotsResponse, unmarshalSnapshot, marshalCreateSnapshotRequest, marshalImportSnapshotFromS3Request, marshalUpdateSnapshotRequest } from './marshalling.gen.js';
+
+// This file was automatically generated. DO NOT EDIT.
+// If you have any remark or suggestion do not hesitate to open an issue.
+const jsonContentHeaders = {
+  'Content-Type': 'application/json; charset=utf-8'
+};
+
+/**
+ * Scaleway Block Storage API.
+ *
+ * This API allows you to use and manage your Block Storage volumes.
+ */
+class API extends API$1 {
+  /** Lists the available zones of the API. */
+  static LOCALITIES = ['fr-par-1', 'pl-waw-3'];
+  pageOfListVolumeTypes = (() => {
+    var _this = this;
+    return function (request) {
+      if (request === void 0) {
+        request = {};
+      }
+      return _this.client.fetch({
+        method: 'GET',
+        path: `/block/v1alpha1/zones/${validatePathParam('zone', request.zone ?? _this.client.settings.defaultZone)}/volume-types`,
+        urlParams: urlParams(['page', request.page], ['page_size', request.pageSize ?? _this.client.settings.defaultPageSize])
+      }, unmarshalListVolumeTypesResponse);
+    };
+  })();
+
+  /**
+   * 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
+   */
+  listVolumeTypes = (() => {
+    var _this2 = this;
+    return function (request) {
+      if (request === void 0) {
+        request = {};
+      }
+      return enrichForPagination('volumeTypes', _this2.pageOfListVolumeTypes, request);
+    };
+  })();
+  pageOfListVolumes = (() => {
+    var _this3 = this;
+    return function (request) {
+      if (request === void 0) {
+        request = {};
+      }
+      return _this3.client.fetch({
+        method: 'GET',
+        path: `/block/v1alpha1/zones/${validatePathParam('zone', request.zone ?? _this3.client.settings.defaultZone)}/volumes`,
+        urlParams: urlParams(['name', request.name], ['order_by', request.orderBy], ['page', request.page], ['page_size', request.pageSize ?? _this3.client.settings.defaultPageSize], ['product_resource_id', request.productResourceId], ['project_id', request.projectId])
+      }, 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.
+   *
+   * @param request - The request {@link ListVolumesRequest}
+   * @returns A Promise of ListVolumesResponse
+   */
+  listVolumes = (() => {
+    var _this4 = this;
+    return function (request) {
+      if (request === void 0) {
+        request = {};
+      }
+      return enrichForPagination('volumes', _this4.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
+   */
+  createVolume = request => this.client.fetch({
+    body: JSON.stringify(marshalCreateVolumeRequest(request, this.client.settings)),
+    headers: jsonContentHeaders,
+    method: 'POST',
+    path: `/block/v1alpha1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/volumes`
+  }, unmarshalVolume);
+
+  /**
+   * 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
+   */
+  getVolume = request => this.client.fetch({
+    method: 'GET',
+    path: `/block/v1alpha1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/volumes/${validatePathParam('volumeId', request.volumeId)}`
+  }, unmarshalVolume);
+
+  /**
+   * Waits for {@link Volume} to be in a final state.
+   *
+   * @param request - The request {@link GetVolumeRequest}
+   * @param options - The waiting options
+   * @returns A Promise of Volume
+   */
+  waitForVolume = (request, options) => waitForResource(options?.stop ?? (res => Promise.resolve(!VOLUME_TRANSIENT_STATUSES.includes(res.status))), this.getVolume, request, 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.
+   *
+   * @param request - The request {@link DeleteVolumeRequest}
+   */
+  deleteVolume = request => this.client.fetch({
+    method: 'DELETE',
+    path: `/block/v1alpha1/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
+   */
+  updateVolume = request => this.client.fetch({
+    body: JSON.stringify(marshalUpdateVolumeRequest(request, this.client.settings)),
+    headers: jsonContentHeaders,
+    method: 'PATCH',
+    path: `/block/v1alpha1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/volumes/${validatePathParam('volumeId', request.volumeId)}`
+  }, unmarshalVolume);
+  pageOfListSnapshots = (() => {
+    var _this5 = this;
+    return function (request) {
+      if (request === void 0) {
+        request = {};
+      }
+      return _this5.client.fetch({
+        method: 'GET',
+        path: `/block/v1alpha1/zones/${validatePathParam('zone', request.zone ?? _this5.client.settings.defaultZone)}/snapshots`,
+        urlParams: urlParams(['name', request.name], ['order_by', request.orderBy], ['page', request.page], ['page_size', request.pageSize ?? _this5.client.settings.defaultPageSize], ['project_id', request.projectId], ['volume_id', request.volumeId])
+      }, 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.
+   *
+   * @param request - The request {@link ListSnapshotsRequest}
+   * @returns A Promise of ListSnapshotsResponse
+   */
+  listSnapshots = (() => {
+    var _this6 = this;
+    return function (request) {
+      if (request === void 0) {
+        request = {};
+      }
+      return enrichForPagination('snapshots', _this6.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.
+   *
+   * @param request - The request {@link GetSnapshotRequest}
+   * @returns A Promise of Snapshot
+   */
+  getSnapshot = request => this.client.fetch({
+    method: 'GET',
+    path: `/block/v1alpha1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/snapshots/${validatePathParam('snapshotId', request.snapshotId)}`
+  }, unmarshalSnapshot);
+
+  /**
+   * Waits for {@link Snapshot} to be in a final state.
+   *
+   * @param request - The request {@link GetSnapshotRequest}
+   * @param options - The waiting options
+   * @returns A Promise of Snapshot
+   */
+  waitForSnapshot = (request, options) => waitForResource(options?.stop ?? (res => Promise.resolve(!SNAPSHOT_TRANSIENT_STATUSES.includes(res.status))), this.getSnapshot, request, 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
+   */
+  createSnapshot = request => this.client.fetch({
+    body: JSON.stringify(marshalCreateSnapshotRequest(request, this.client.settings)),
+    headers: jsonContentHeaders,
+    method: 'POST',
+    path: `/block/v1alpha1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/snapshots`
+  }, unmarshalSnapshot);
+  importSnapshotFromS3 = request => this.client.fetch({
+    body: JSON.stringify(marshalImportSnapshotFromS3Request(request, this.client.settings)),
+    headers: jsonContentHeaders,
+    method: 'POST',
+    path: `/block/v1alpha1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/snapshots/import-from-s3`
+  }, unmarshalSnapshot);
+
+  /**
+   * 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}
+   */
+  deleteSnapshot = request => this.client.fetch({
+    method: 'DELETE',
+    path: `/block/v1alpha1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/snapshots/${validatePathParam('snapshotId', request.snapshotId)}`
+  });
+
+  /**
+   * Update a snapshot. Update the name or tags of the snapshot.
+   *
+   * @param request - The request {@link UpdateSnapshotRequest}
+   * @returns A Promise of Snapshot
+   */
+  updateSnapshot = request => this.client.fetch({
+    body: JSON.stringify(marshalUpdateSnapshotRequest(request, this.client.settings)),
+    headers: jsonContentHeaders,
+    method: 'PATCH',
+    path: `/block/v1alpha1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/snapshots/${validatePathParam('snapshotId', request.snapshotId)}`
+  }, unmarshalSnapshot);
+}
+
+export { API };

package/dist/api/block/v1alpha1/content.gen.js

@@ -0,0 +1,13 @@
+// This file was automatically generated. DO NOT EDIT.
+// If you have any remark or suggestion do not hesitate to open an issue.
+
+/** Lists transient statutes of the enum {@link ReferenceStatus}. */
+const REFERENCE_TRANSIENT_STATUSES = ['attaching', 'detaching', 'snapshotting'];
+
+/** Lists transient statutes of the enum {@link SnapshotStatus}. */
+const SNAPSHOT_TRANSIENT_STATUSES = ['creating', 'deleting'];
+
+/** Lists transient statutes of the enum {@link VolumeStatus}. */
+const VOLUME_TRANSIENT_STATUSES = ['creating', 'deleting', 'resizing', 'snapshotting'];
+
+export { REFERENCE_TRANSIENT_STATUSES, SNAPSHOT_TRANSIENT_STATUSES, VOLUME_TRANSIENT_STATUSES };

package/dist/api/block/v1alpha1/index.gen.js

@@ -0,0 +1,7 @@
+export { API } from './api.gen.js';
+export { REFERENCE_TRANSIENT_STATUSES, SNAPSHOT_TRANSIENT_STATUSES, VOLUME_TRANSIENT_STATUSES } from './content.gen.js';
+import * as validationRules_gen from './validation-rules.gen.js';
+export { validationRules_gen as ValidationRules };
+
+// This file was automatically generated. DO NOT EDIT.
+// If you have any remark or suggestion do not hesitate to open an issue.

package/dist/api/block/v1alpha1/marshalling.gen.js

@@ -0,0 +1,182 @@
+import { isJSONObject } from '../../../helpers/json.js';
+import { unmarshalMoney } from '../../../scw/custom-marshalling.js';
+import { unmarshalDate, unmarshalArrayOfObject, resolveOneOf } from '../../../helpers/marshalling.js';
+
+// This file was automatically generated. DO NOT EDIT.
+// If you have any remark or suggestion do not hesitate to open an issue.
+const unmarshalReference = data => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(`Unmarshalling the type 'Reference' failed as data isn't a dictionary.`);
+  }
+  return {
+    createdAt: unmarshalDate(data.created_at),
+    id: data.id,
+    productResourceId: data.product_resource_id,
+    productResourceType: data.product_resource_type,
+    status: data.status,
+    type: data.type
+  };
+};
+const unmarshalVolumeSpecifications = data => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(`Unmarshalling the type 'VolumeSpecifications' failed as data isn't a dictionary.`);
+  }
+  return {
+    class: data.class,
+    perfIops: data.perf_iops
+  };
+};
+const unmarshalVolume = data => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(`Unmarshalling the type 'Volume' failed as data isn't a dictionary.`);
+  }
+  return {
+    createdAt: unmarshalDate(data.created_at),
+    id: data.id,
+    name: data.name,
+    parentSnapshotId: data.parent_snapshot_id,
+    projectId: data.project_id,
+    references: unmarshalArrayOfObject(data.references, unmarshalReference),
+    size: data.size,
+    specs: data.specs ? unmarshalVolumeSpecifications(data.specs) : undefined,
+    status: data.status,
+    tags: data.tags,
+    type: data.type,
+    updatedAt: unmarshalDate(data.updated_at),
+    zone: data.zone
+  };
+};
+const unmarshalSnapshotParentVolume = data => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(`Unmarshalling the type 'SnapshotParentVolume' failed as data isn't a dictionary.`);
+  }
+  return {
+    id: data.id,
+    name: data.name,
+    status: data.status,
+    type: data.type
+  };
+};
+const unmarshalSnapshotSummary = data => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(`Unmarshalling the type 'SnapshotSummary' failed as data isn't a dictionary.`);
+  }
+  return {
+    class: data.class,
+    createdAt: unmarshalDate(data.created_at),
+    id: data.id,
+    name: data.name,
+    parentVolume: data.parent_volume ? unmarshalSnapshotParentVolume(data.parent_volume) : undefined,
+    projectId: data.project_id,
+    size: data.size,
+    status: data.status,
+    tags: data.tags,
+    updatedAt: unmarshalDate(data.updated_at),
+    zone: data.zone
+  };
+};
+const unmarshalListSnapshotsResponse = data => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(`Unmarshalling the type 'ListSnapshotsResponse' failed as data isn't a dictionary.`);
+  }
+  return {
+    snapshots: unmarshalArrayOfObject(data.snapshots, unmarshalSnapshotSummary),
+    totalCount: data.total_count
+  };
+};
+const unmarshalVolumeType = data => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(`Unmarshalling the type 'VolumeType' failed as data isn't a dictionary.`);
+  }
+  return {
+    pricing: data.pricing ? unmarshalMoney(data.pricing) : undefined,
+    snapshotPricing: data.snapshot_pricing ? unmarshalMoney(data.snapshot_pricing) : undefined,
+    specs: data.specs ? unmarshalVolumeSpecifications(data.specs) : undefined,
+    type: data.type
+  };
+};
+const unmarshalListVolumeTypesResponse = data => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(`Unmarshalling the type 'ListVolumeTypesResponse' failed as data isn't a dictionary.`);
+  }
+  return {
+    totalCount: data.total_count,
+    volumeTypes: unmarshalArrayOfObject(data.volume_types, unmarshalVolumeType)
+  };
+};
+const unmarshalListVolumesResponse = data => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(`Unmarshalling the type 'ListVolumesResponse' failed as data isn't a dictionary.`);
+  }
+  return {
+    totalCount: data.total_count,
+    volumes: unmarshalArrayOfObject(data.volumes, unmarshalVolume)
+  };
+};
+const unmarshalSnapshot = data => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(`Unmarshalling the type 'Snapshot' failed as data isn't a dictionary.`);
+  }
+  return {
+    class: data.class,
+    createdAt: unmarshalDate(data.created_at),
+    id: data.id,
+    name: data.name,
+    parentVolume: data.parent_volume ? unmarshalSnapshotParentVolume(data.parent_volume) : undefined,
+    projectId: data.project_id,
+    references: unmarshalArrayOfObject(data.references, unmarshalReference),
+    size: data.size,
+    status: data.status,
+    tags: data.tags,
+    updatedAt: unmarshalDate(data.updated_at),
+    zone: data.zone
+  };
+};
+const marshalCreateSnapshotRequest = (request, defaults) => ({
+  name: request.name,
+  project_id: request.projectId ?? defaults.defaultProjectId,
+  tags: request.tags,
+  volume_id: request.volumeId
+});
+const marshalCreateVolumeRequestFromEmpty = (request, defaults) => ({
+  size: request.size
+});
+const marshalCreateVolumeRequestFromSnapshot = (request, defaults) => ({
+  size: request.size,
+  snapshot_id: request.snapshotId
+});
+const marshalCreateVolumeRequest = (request, defaults) => ({
+  name: request.name,
+  project_id: request.projectId ?? defaults.defaultProjectId,
+  tags: request.tags,
+  ...resolveOneOf([{
+    param: 'from_empty',
+    value: request.fromEmpty !== undefined ? marshalCreateVolumeRequestFromEmpty(request.fromEmpty) : undefined
+  }, {
+    param: 'from_snapshot',
+    value: request.fromSnapshot !== undefined ? marshalCreateVolumeRequestFromSnapshot(request.fromSnapshot) : undefined
+  }]),
+  ...resolveOneOf([{
+    param: 'perf_iops',
+    value: request.perfIops
+  }])
+});
+const marshalImportSnapshotFromS3Request = (request, defaults) => ({
+  bucket: request.bucket,
+  key: request.key,
+  name: request.name,
+  project_id: request.projectId ?? defaults.defaultProjectId,
+  tags: request.tags
+});
+const marshalUpdateSnapshotRequest = (request, defaults) => ({
+  name: request.name,
+  tags: request.tags
+});
+const marshalUpdateVolumeRequest = (request, defaults) => ({
+  name: request.name,
+  perf_iops: request.perfIops,
+  size: request.size,
+  tags: request.tags
+});
+
+export { marshalCreateSnapshotRequest, marshalCreateVolumeRequest, marshalImportSnapshotFromS3Request, marshalUpdateSnapshotRequest, marshalUpdateVolumeRequest, unmarshalListSnapshotsResponse, unmarshalListVolumeTypesResponse, unmarshalListVolumesResponse, unmarshalReference, unmarshalSnapshot, unmarshalVolume };

package/dist/api/block/v1alpha1/validation-rules.gen.js

@@ -0,0 +1,52 @@
+// This file was automatically generated. DO NOT EDIT.
+// If you have any remark or suggestion do not hesitate to open an issue.
+
+const CreateSnapshotRequest = {
+  name: {
+    minLength: 1
+  }
+};
+const CreateVolumeRequest = {
+  name: {
+    minLength: 1
+  }
+};
+const ImportSnapshotFromS3Request = {
+  name: {
+    minLength: 1
+  }
+};
+const ListSnapshotsRequest = {
+  page: {
+    greaterThan: 0
+  },
+  pageSize: {
+    greaterThan: 0,
+    lessThanOrEqual: 100
+  }
+};
+const ListVolumeTypesRequest = {
+  page: {
+    greaterThan: 0
+  },
+  pageSize: {
+    greaterThan: 0,
+    lessThanOrEqual: 100
+  }
+};
+const ListVolumesRequest = {
+  page: {
+    greaterThan: 0
+  },
+  pageSize: {
+    greaterThan: 0,
+    lessThanOrEqual: 100
+  }
+};
+const Reference = {
+  productResourceType: {
+    minLength: 1
+  }
+};
+
+export { CreateSnapshotRequest, CreateVolumeRequest, ImportSnapshotFromS3Request, ListSnapshotsRequest, ListVolumeTypesRequest, ListVolumesRequest, Reference };

package/dist/api/cockpit/index.js

@@ -0,0 +1,2 @@
+import * as index_gen from './v1beta1/index.gen.js';
+export { index_gen as v1beta1 };