@scaleway/sdk-file 2.2.0 → 2.3.0

package/README.md

@@ -83,6 +83,7 @@ const api = new File.v1.API(client)
 ## Support
 
 We love feedback! Feel free to reach us on:
+
 - [Scaleway Slack community](https://slack.scaleway.com/) - Join us on [#opensource](https://scaleway-community.slack.com/app_redirect?channel=opensource)
 - [GitHub Issues](https://github.com/scaleway/scaleway-sdk-js/issues)
 
@@ -93,4 +94,3 @@ This repository is at its early stage and is still in active development. If you
 ## License
 
 This project is Apache 2.0 licensed. See the [LICENSE](https://github.com/scaleway/scaleway-sdk-js/blob/master/LICENSE) file for details.
-

package/dist/_virtual/_rolldown/runtime.js

@@ -0,0 +1,11 @@
+var __defProp = Object.defineProperty;
+var __exportAll = (all, no_symbols) => {
+	let target = {};
+	for (var name in all) __defProp(target, name, {
+		get: all[name],
+		enumerable: true
+	});
+	if (!no_symbols) __defProp(target, Symbol.toStringTag, { value: "Module" });
+	return target;
+};
+export { __exportAll };

package/dist/index.gen.js

@@ -1,4 +1,2 @@
-import * as index_gen from "./v1alpha1/index.gen.js";
-export {
-  index_gen as Filev1alpha1
-};
+import { index_gen_exports } from "./v1alpha1/index.gen.js";
+export { index_gen_exports as Filev1alpha1 };

package/dist/v1alpha1/api.gen.js

@@ -1,141 +1,93 @@
-import { API as API$1, toApiLocality, validatePathParam, waitForResource, urlParams, enrichForPagination } from "@scaleway/sdk-client";
 import { FILE_SYSTEM_TRANSIENT_STATUSES } from "./content.gen.js";
-import { unmarshalFileSystem, unmarshalListFileSystemsResponse, unmarshalListAttachmentsResponse, marshalCreateFileSystemRequest, marshalUpdateFileSystemRequest } from "./marshalling.gen.js";
-const jsonContentHeaders = {
-  "Content-Type": "application/json; charset=utf-8"
-};
-class API extends API$1 {
-  /**
-   * Locality of this API.
-   * type ∈ {'zone','region','global','unspecified'}
-   */
-  static LOCALITY = toApiLocality({
-    regions: ["fr-par"]
-  });
-  /**
-   * Get filesystem details. Retrieve all properties and current status of a specific filesystem identified by its ID.
-   *
-   * @param request - The request {@link GetFileSystemRequest}
-   * @returns A Promise of FileSystem
-   */
-  getFileSystem = (request) => this.client.fetch(
-    {
-      method: "GET",
-      path: `/file/v1alpha1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/filesystems/${validatePathParam("filesystemId", request.filesystemId)}`
-    },
-    unmarshalFileSystem
-  );
-  /**
-   * Waits for {@link FileSystem} to be in a final state.
-   *
-   * @param request - The request {@link GetFileSystemRequest}
-   * @param options - The waiting options
-   * @returns A Promise of FileSystem
-   */
-  waitForFileSystem = (request, options) => waitForResource(
-    options?.stop ?? ((res) => Promise.resolve(
-      !FILE_SYSTEM_TRANSIENT_STATUSES.includes(res.status)
-    )),
-    this.getFileSystem,
-    request,
-    options
-  );
-  pageOfListFileSystems = (request = {}) => this.client.fetch(
-    {
-      method: "GET",
-      path: `/file/v1alpha1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/filesystems`,
-      urlParams: urlParams(
-        ["name", request.name],
-        ["order_by", request.orderBy],
-        ["organization_id", request.organizationId],
-        ["page", request.page],
-        [
-          "page_size",
-          request.pageSize ?? this.client.settings.defaultPageSize
-        ],
-        ["project_id", request.projectId],
-        ["tags", request.tags]
-      )
-    },
-    unmarshalListFileSystemsResponse
-  );
-  /**
-   * List all filesystems. Retrieve all filesystems in the specified region. By default, the filesystems listed are ordered by creation date in ascending order. This can be modified using the `order_by` field.
-   *
-   * @param request - The request {@link ListFileSystemsRequest}
-   * @returns A Promise of ListFileSystemsResponse
-   */
-  listFileSystems = (request = {}) => enrichForPagination("filesystems", this.pageOfListFileSystems, request);
-  pageOfListAttachments = (request = {}) => this.client.fetch(
-    {
-      method: "GET",
-      path: `/file/v1alpha1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/attachments`,
-      urlParams: urlParams(
-        ["filesystem_id", request.filesystemId],
-        ["page", request.page],
-        [
-          "page_size",
-          request.pageSize ?? this.client.settings.defaultPageSize
-        ],
-        ["resource_id", request.resourceId],
-        ["resource_type", request.resourceType],
-        ["zone", request.zone]
-      )
-    },
-    unmarshalListAttachmentsResponse
-  );
-  /**
-     * List filesystems attachments. List all existing attachments in a specified region.
-  By default, the attachments listed are ordered by creation date in ascending order. This can be modified using the `order_by` field.
-     *
-     * @param request - The request {@link ListAttachmentsRequest}
-     * @returns A Promise of ListAttachmentsResponse
-     */
-  listAttachments = (request = {}) => enrichForPagination("attachments", this.pageOfListAttachments, request);
-  /**
-   * Create a new filesystem. To create a new filesystem, you must specify a name, a size, and a project ID.
-   *
-   * @param request - The request {@link CreateFileSystemRequest}
-   * @returns A Promise of FileSystem
-   */
-  createFileSystem = (request) => this.client.fetch(
-    {
-      body: JSON.stringify(
-        marshalCreateFileSystemRequest(request, this.client.settings)
-      ),
-      headers: jsonContentHeaders,
-      method: "POST",
-      path: `/file/v1alpha1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/filesystems`
-    },
-    unmarshalFileSystem
-  );
-  /**
-   * Delete a detached filesystem. You must specify the `filesystem_id` of the filesystem you want to delete.
-   *
-   * @param request - The request {@link DeleteFileSystemRequest}
-   */
-  deleteFileSystem = (request) => this.client.fetch({
-    method: "DELETE",
-    path: `/file/v1alpha1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/filesystems/${validatePathParam("filesystemId", request.filesystemId)}`
-  });
-  /**
-   * Update filesystem properties. Update the technical details of a filesystem, such as its name, tags or its new size.
-   *
-   * @param request - The request {@link UpdateFileSystemRequest}
-   * @returns A Promise of FileSystem
-   */
-  updateFileSystem = (request) => this.client.fetch(
-    {
-      body: JSON.stringify(
-        marshalUpdateFileSystemRequest(request, this.client.settings)
-      ),
-      headers: jsonContentHeaders,
-      method: "PATCH",
-      path: `/file/v1alpha1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/filesystems/${validatePathParam("filesystemId", request.filesystemId)}`
-    },
-    unmarshalFileSystem
-  );
-}
-export {
-  API
+import { marshalCreateFileSystemRequest, marshalUpdateFileSystemRequest, unmarshalFileSystem, unmarshalListAttachmentsResponse, unmarshalListFileSystemsResponse } from "./marshalling.gen.js";
+import { API, enrichForPagination, toApiLocality, urlParams, validatePathParam, waitForResource } from "@scaleway/sdk-client";
+var jsonContentHeaders = { "Content-Type": "application/json; charset=utf-8" };
+/**
+* File Storage API.
+
+This API allows you to manage your File Storage resources.
+*/
+var API$1 = class extends API {
+	/**
+	* Locality of this API.
+	* type ∈ {'zone','region','global','unspecified'}
+	*/
+	static LOCALITY = toApiLocality({ regions: ["fr-par"] });
+	/**
+	* Get filesystem details. Retrieve all properties and current status of a specific filesystem identified by its ID.
+	*
+	* @param request - The request {@link GetFileSystemRequest}
+	* @returns A Promise of FileSystem
+	*/
+	getFileSystem = (request) => this.client.fetch({
+		method: "GET",
+		path: `/file/v1alpha1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/filesystems/${validatePathParam("filesystemId", request.filesystemId)}`
+	}, unmarshalFileSystem);
+	/**
+	* Waits for {@link FileSystem} to be in a final state.
+	*
+	* @param request - The request {@link GetFileSystemRequest}
+	* @param options - The waiting options
+	* @returns A Promise of FileSystem
+	*/
+	waitForFileSystem = (request, options) => waitForResource(options?.stop ?? ((res) => Promise.resolve(!FILE_SYSTEM_TRANSIENT_STATUSES.includes(res.status))), this.getFileSystem, request, options);
+	pageOfListFileSystems = (request = {}) => this.client.fetch({
+		method: "GET",
+		path: `/file/v1alpha1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/filesystems`,
+		urlParams: urlParams(["filesystem_ids", request.filesystemIds], ["name", request.name], ["order_by", request.orderBy], ["organization_id", request.organizationId], ["page", request.page], ["page_size", request.pageSize ?? this.client.settings.defaultPageSize], ["project_id", request.projectId], ["tags", request.tags])
+	}, unmarshalListFileSystemsResponse);
+	/**
+	* List all filesystems. Retrieve all filesystems in the specified region. By default, the filesystems listed are ordered by creation date in ascending order. This can be modified using the `order_by` field.
+	*
+	* @param request - The request {@link ListFileSystemsRequest}
+	* @returns A Promise of ListFileSystemsResponse
+	*/
+	listFileSystems = (request = {}) => enrichForPagination("filesystems", this.pageOfListFileSystems, request);
+	pageOfListAttachments = (request = {}) => this.client.fetch({
+		method: "GET",
+		path: `/file/v1alpha1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/attachments`,
+		urlParams: urlParams(["filesystem_id", request.filesystemId], ["page", request.page], ["page_size", request.pageSize ?? this.client.settings.defaultPageSize], ["resource_id", request.resourceId], ["resource_type", request.resourceType], ["zone", request.zone])
+	}, unmarshalListAttachmentsResponse);
+	/**
+	* List filesystems attachments. List all existing attachments in a specified region.
+	By default, the attachments listed are ordered by creation date in ascending order. This can be modified using the `order_by` field.
+	*
+	* @param request - The request {@link ListAttachmentsRequest}
+	* @returns A Promise of ListAttachmentsResponse
+	*/
+	listAttachments = (request = {}) => enrichForPagination("attachments", this.pageOfListAttachments, request);
+	/**
+	* Create a new filesystem. To create a new filesystem, you must specify a name, a size, and a project ID.
+	*
+	* @param request - The request {@link CreateFileSystemRequest}
+	* @returns A Promise of FileSystem
+	*/
+	createFileSystem = (request) => this.client.fetch({
+		body: JSON.stringify(marshalCreateFileSystemRequest(request, this.client.settings)),
+		headers: jsonContentHeaders,
+		method: "POST",
+		path: `/file/v1alpha1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/filesystems`
+	}, unmarshalFileSystem);
+	/**
+	* Delete a detached filesystem. You must specify the `filesystem_id` of the filesystem you want to delete.
+	*
+	* @param request - The request {@link DeleteFileSystemRequest}
+	*/
+	deleteFileSystem = (request) => this.client.fetch({
+		method: "DELETE",
+		path: `/file/v1alpha1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/filesystems/${validatePathParam("filesystemId", request.filesystemId)}`
+	});
+	/**
+	* Update filesystem properties. Update the technical details of a filesystem, such as its name, tags or its new size.
+	*
+	* @param request - The request {@link UpdateFileSystemRequest}
+	* @returns A Promise of FileSystem
+	*/
+	updateFileSystem = (request) => this.client.fetch({
+		body: JSON.stringify(marshalUpdateFileSystemRequest(request, this.client.settings)),
+		headers: jsonContentHeaders,
+		method: "PATCH",
+		path: `/file/v1alpha1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/filesystems/${validatePathParam("filesystemId", request.filesystemId)}`
+	}, unmarshalFileSystem);
 };
+export { API$1 as API };

package/dist/v1alpha1/content.gen.js

@@ -1,7 +1,3 @@
-const FILE_SYSTEM_TRANSIENT_STATUSES = [
-  "creating",
-  "updating"
-];
-export {
-  FILE_SYSTEM_TRANSIENT_STATUSES
-};
+/** Lists transient statutes of the enum {@link FileSystemStatus}. */
+const FILE_SYSTEM_TRANSIENT_STATUSES = ["creating", "updating"];
+export { FILE_SYSTEM_TRANSIENT_STATUSES };

package/dist/v1alpha1/index.gen.d.ts

@@ -1,4 +1,4 @@
-export { API } from './api.gen.js';
+export { API, } from './api.gen.js';
 export * from './content.gen.js';
 export * from './marshalling.gen.js';
 export type { Attachment, AttachmentResourceType, CreateFileSystemRequest, DeleteFileSystemRequest, FileSystem, FileSystemStatus, GetFileSystemRequest, ListAttachmentsRequest, ListAttachmentsResponse, ListFileSystemsRequest, ListFileSystemsRequestOrderBy, ListFileSystemsResponse, UpdateFileSystemRequest, } from './types.gen.js';

package/dist/v1alpha1/index.gen.js

@@ -1,14 +1,16 @@
-import { API } from "./api.gen.js";
+import { __exportAll } from "../_virtual/_rolldown/runtime.js";
 import { FILE_SYSTEM_TRANSIENT_STATUSES } from "./content.gen.js";
 import { marshalCreateFileSystemRequest, marshalUpdateFileSystemRequest, unmarshalFileSystem, unmarshalListAttachmentsResponse, unmarshalListFileSystemsResponse } from "./marshalling.gen.js";
-import * as validationRules_gen from "./validation-rules.gen.js";
-export {
-  API,
-  FILE_SYSTEM_TRANSIENT_STATUSES,
-  validationRules_gen as ValidationRules,
-  marshalCreateFileSystemRequest,
-  marshalUpdateFileSystemRequest,
-  unmarshalFileSystem,
-  unmarshalListAttachmentsResponse,
-  unmarshalListFileSystemsResponse
-};
+import { API } from "./api.gen.js";
+import { validation_rules_gen_exports } from "./validation-rules.gen.js";
+var index_gen_exports = /* @__PURE__ */ __exportAll({
+	API: () => API,
+	FILE_SYSTEM_TRANSIENT_STATUSES: () => FILE_SYSTEM_TRANSIENT_STATUSES,
+	ValidationRules: () => validation_rules_gen_exports,
+	marshalCreateFileSystemRequest: () => marshalCreateFileSystemRequest,
+	marshalUpdateFileSystemRequest: () => marshalUpdateFileSystemRequest,
+	unmarshalFileSystem: () => unmarshalFileSystem,
+	unmarshalListAttachmentsResponse: () => unmarshalListAttachmentsResponse,
+	unmarshalListFileSystemsResponse: () => unmarshalListFileSystemsResponse
+});
+export { index_gen_exports };

package/dist/v1alpha1/marshalling.gen.js

@@ -1,75 +1,53 @@
-import { isJSONObject, unmarshalDate, unmarshalArrayOfObject } from "@scaleway/sdk-client";
+import { isJSONObject, unmarshalArrayOfObject, unmarshalDate } from "@scaleway/sdk-client";
 const unmarshalFileSystem = (data) => {
-  if (!isJSONObject(data)) {
-    throw new TypeError(
-      `Unmarshalling the type 'FileSystem' failed as data isn't a dictionary.`
-    );
-  }
-  return {
-    createdAt: unmarshalDate(data.created_at),
-    id: data.id,
-    name: data.name,
-    numberOfAttachments: data.number_of_attachments,
-    organizationId: data.organization_id,
-    projectId: data.project_id,
-    region: data.region,
-    size: data.size,
-    status: data.status,
-    tags: data.tags,
-    updatedAt: unmarshalDate(data.updated_at)
-  };
+	if (!isJSONObject(data)) throw new TypeError(`Unmarshalling the type 'FileSystem' failed as data isn't a dictionary.`);
+	return {
+		createdAt: unmarshalDate(data.created_at),
+		id: data.id,
+		name: data.name,
+		numberOfAttachments: data.number_of_attachments,
+		organizationId: data.organization_id,
+		projectId: data.project_id,
+		region: data.region,
+		size: data.size,
+		status: data.status,
+		tags: data.tags,
+		updatedAt: unmarshalDate(data.updated_at)
+	};
 };
-const unmarshalAttachment = (data) => {
-  if (!isJSONObject(data)) {
-    throw new TypeError(
-      `Unmarshalling the type 'Attachment' failed as data isn't a dictionary.`
-    );
-  }
-  return {
-    filesystemId: data.filesystem_id,
-    id: data.id,
-    resourceId: data.resource_id,
-    resourceType: data.resource_type,
-    zone: data.zone
-  };
+var unmarshalAttachment = (data) => {
+	if (!isJSONObject(data)) throw new TypeError(`Unmarshalling the type 'Attachment' failed as data isn't a dictionary.`);
+	return {
+		filesystemId: data.filesystem_id,
+		id: data.id,
+		resourceId: data.resource_id,
+		resourceType: data.resource_type,
+		zone: data.zone
+	};
 };
 const unmarshalListAttachmentsResponse = (data) => {
-  if (!isJSONObject(data)) {
-    throw new TypeError(
-      `Unmarshalling the type 'ListAttachmentsResponse' failed as data isn't a dictionary.`
-    );
-  }
-  return {
-    attachments: unmarshalArrayOfObject(data.attachments, unmarshalAttachment),
-    totalCount: data.total_count
-  };
+	if (!isJSONObject(data)) throw new TypeError(`Unmarshalling the type 'ListAttachmentsResponse' failed as data isn't a dictionary.`);
+	return {
+		attachments: unmarshalArrayOfObject(data.attachments, unmarshalAttachment),
+		totalCount: data.total_count
+	};
 };
 const unmarshalListFileSystemsResponse = (data) => {
-  if (!isJSONObject(data)) {
-    throw new TypeError(
-      `Unmarshalling the type 'ListFileSystemsResponse' failed as data isn't a dictionary.`
-    );
-  }
-  return {
-    filesystems: unmarshalArrayOfObject(data.filesystems, unmarshalFileSystem),
-    totalCount: data.total_count
-  };
+	if (!isJSONObject(data)) throw new TypeError(`Unmarshalling the type 'ListFileSystemsResponse' failed as data isn't a dictionary.`);
+	return {
+		filesystems: unmarshalArrayOfObject(data.filesystems, unmarshalFileSystem),
+		totalCount: data.total_count
+	};
 };
 const marshalCreateFileSystemRequest = (request, defaults) => ({
-  name: request.name,
-  project_id: request.projectId ?? defaults.defaultProjectId,
-  size: request.size,
-  tags: request.tags
+	name: request.name,
+	project_id: request.projectId ?? defaults.defaultProjectId,
+	size: request.size,
+	tags: request.tags
 });
 const marshalUpdateFileSystemRequest = (request, defaults) => ({
-  name: request.name,
-  size: request.size,
-  tags: request.tags
+	name: request.name,
+	size: request.size,
+	tags: request.tags
 });
-export {
-  marshalCreateFileSystemRequest,
-  marshalUpdateFileSystemRequest,
-  unmarshalFileSystem,
-  unmarshalListAttachmentsResponse,
-  unmarshalListFileSystemsResponse
-};
+export { marshalCreateFileSystemRequest, marshalUpdateFileSystemRequest, unmarshalFileSystem, unmarshalListAttachmentsResponse, unmarshalListFileSystemsResponse };

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

@@ -209,6 +209,10 @@ export type ListFileSystemsRequest = {
      * Filter by tags. Only filesystems with one or more matching tags will be returned.
      */
     tags?: string[];
+    /**
+     * Filter by filesystem IDs. Only filesystems with one or more matching IDs will be returned.
+     */
+    filesystemIds?: string[];
 };
 /**
  * Response containing a list of filesystems and total count.

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

@@ -1,40 +1,30 @@
+import { __exportAll } from "../_virtual/_rolldown/runtime.js";
+var validation_rules_gen_exports = /* @__PURE__ */ __exportAll({
+	CreateFileSystemRequest: () => CreateFileSystemRequest,
+	ListAttachmentsRequest: () => ListAttachmentsRequest,
+	ListFileSystemsRequest: () => ListFileSystemsRequest,
+	UpdateFileSystemRequest: () => UpdateFileSystemRequest
+});
 const CreateFileSystemRequest = {
-  name: {
-    minLength: 1
-  },
-  size: {
-    greaterThan: 0
-  }
+	name: { minLength: 1 },
+	size: { greaterThan: 0 }
 };
 const ListAttachmentsRequest = {
-  page: {
-    greaterThan: 0
-  },
-  pageSize: {
-    greaterThan: 0,
-    lessThanOrEqual: 100
-  }
+	page: { greaterThan: 0 },
+	pageSize: {
+		greaterThan: 0,
+		lessThanOrEqual: 100
+	}
 };
 const ListFileSystemsRequest = {
-  page: {
-    greaterThan: 0
-  },
-  pageSize: {
-    greaterThan: 0,
-    lessThanOrEqual: 100
-  }
+	page: { greaterThan: 0 },
+	pageSize: {
+		greaterThan: 0,
+		lessThanOrEqual: 100
+	}
 };
 const UpdateFileSystemRequest = {
-  name: {
-    minLength: 1
-  },
-  size: {
-    greaterThan: 0
-  }
-};
-export {
-  CreateFileSystemRequest,
-  ListAttachmentsRequest,
-  ListFileSystemsRequest,
-  UpdateFileSystemRequest
+	name: { minLength: 1 },
+	size: { greaterThan: 0 }
 };
+export { validation_rules_gen_exports };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scaleway/sdk-file",
-  "version": "2.2.0",
+  "version": "2.3.0",
   "description": "Scaleway SDK file",
   "license": "Apache-2.0",
   "files": [
@@ -27,13 +27,13 @@
   },
   "dependencies": {
     "@scaleway/random-name": "5.1.2",
-    "@scaleway/sdk-std": "2.1.0"
+    "@scaleway/sdk-std": "2.2.0"
   },
   "peerDependencies": {
-    "@scaleway/sdk-client": "^2.1.0"
+    "@scaleway/sdk-client": "^2.2.0"
   },
   "devDependencies": {
-    "@scaleway/sdk-client": "^2.1.0"
+    "@scaleway/sdk-client": "^2.2.0"
   },
   "scripts": {
     "package:check": "pnpm publint",