@scaleway/sdk-file 1.0.3

package/LICENSE

@@ -0,0 +1,191 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        https://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2019 Scaleway.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       https://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/dist/index.gen.cjs

@@ -0,0 +1,4 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const index_gen = require("./v1alpha1/index.gen.cjs");
+exports.Filev1alpha1 = index_gen;

package/dist/index.gen.d.ts

@@ -0,0 +1,5 @@
+/**
+ * This file is automatically generated
+ * PLEASE DO NOT EDIT HERE
+ */
+export * as Filev1alpha1 from './v1alpha1/index.gen';

package/dist/index.gen.js

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

package/dist/v1alpha1/api.gen.cjs

@@ -0,0 +1,137 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const sdkClient = require("@scaleway/sdk-client");
+const content_gen = require("./content.gen.cjs");
+const marshalling_gen = require("./marshalling.gen.cjs");
+const jsonContentHeaders = {
+  "Content-Type": "application/json; charset=utf-8"
+};
+class API extends sdkClient.API {
+  /** Lists the available regions of the API. */
+  static LOCALITIES = ["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/${sdkClient.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/filesystems/${sdkClient.validatePathParam("filesystemId", request.filesystemId)}`
+    },
+    marshalling_gen.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) => sdkClient.waitForResource(
+    options?.stop ?? ((res) => Promise.resolve(
+      !content_gen.FILE_SYSTEM_TRANSIENT_STATUSES.includes(res.status)
+    )),
+    this.getFileSystem,
+    request,
+    options
+  );
+  pageOfListFileSystems = (request = {}) => this.client.fetch(
+    {
+      method: "GET",
+      path: `/file/v1alpha1/regions/${sdkClient.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/filesystems`,
+      urlParams: sdkClient.urlParams(
+        ["name", request.name],
+        ["order_by", request.orderBy],
+        ["page", request.page],
+        [
+          "page_size",
+          request.pageSize ?? this.client.settings.defaultPageSize
+        ],
+        ["project_id", request.projectId],
+        ["tags", request.tags]
+      )
+    },
+    marshalling_gen.unmarshalListFileSystemsResponse
+  );
+  /**
+     * List all filesystems. Retrieve all filesystems in the specified region. Results are ordered by creation date in ascending order by default.
+  Use the order_by parameter to modify the sorting behavior.
+     *
+     * @param request - The request {@link ListFileSystemsRequest}
+     * @returns A Promise of ListFileSystemsResponse
+     */
+  listFileSystems = (request = {}) => sdkClient.enrichForPagination("filesystems", this.pageOfListFileSystems, request);
+  pageOfListAttachments = (request = {}) => this.client.fetch(
+    {
+      method: "GET",
+      path: `/file/v1alpha1/regions/${sdkClient.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/attachments`,
+      urlParams: sdkClient.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]
+      )
+    },
+    marshalling_gen.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 = {}) => sdkClient.enrichForPagination("attachments", this.pageOfListAttachments, request);
+  /**
+   * Create a new filesystem. To create a new filesystem, you need to provide 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(
+        marshalling_gen.marshalCreateFileSystemRequest(request, this.client.settings)
+      ),
+      headers: jsonContentHeaders,
+      method: "POST",
+      path: `/file/v1alpha1/regions/${sdkClient.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/filesystems`
+    },
+    marshalling_gen.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/${sdkClient.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/filesystems/${sdkClient.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(
+        marshalling_gen.marshalUpdateFileSystemRequest(request, this.client.settings)
+      ),
+      headers: jsonContentHeaders,
+      method: "PATCH",
+      path: `/file/v1alpha1/regions/${sdkClient.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/filesystems/${sdkClient.validatePathParam("filesystemId", request.filesystemId)}`
+    },
+    marshalling_gen.unmarshalFileSystem
+  );
+}
+exports.API = API;

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

@@ -0,0 +1,72 @@
+import { API as ParentAPI } from '@scaleway/sdk-client';
+import type { Region as ScwRegion, WaitForOptions } from '@scaleway/sdk-client';
+import type { CreateFileSystemRequest, DeleteFileSystemRequest, FileSystem, GetFileSystemRequest, ListAttachmentsRequest, ListAttachmentsResponse, ListFileSystemsRequest, ListFileSystemsResponse, UpdateFileSystemRequest } from './types.gen';
+/**
+ * File Storage API.
+
+This API allows you to manage your File Storage resources.
+ */
+export declare class API extends ParentAPI {
+    /** Lists the available regions of the API. */
+    static readonly LOCALITIES: ScwRegion[];
+    /**
+     * 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: Readonly<GetFileSystemRequest>) => Promise<FileSystem>;
+    /**
+     * 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: Readonly<GetFileSystemRequest>, options?: Readonly<WaitForOptions<FileSystem>>) => Promise<FileSystem>;
+    protected pageOfListFileSystems: (request?: Readonly<ListFileSystemsRequest>) => Promise<ListFileSystemsResponse>;
+    /**
+     * List all filesystems. Retrieve all filesystems in the specified region. Results are ordered by creation date in ascending order by default.
+  Use the order_by parameter to modify the sorting behavior.
+     *
+     * @param request - The request {@link ListFileSystemsRequest}
+     * @returns A Promise of ListFileSystemsResponse
+     */
+    listFileSystems: (request?: Readonly<ListFileSystemsRequest>) => Promise<ListFileSystemsResponse> & {
+        all: () => Promise<FileSystem[]>;
+        [Symbol.asyncIterator]: () => AsyncGenerator<FileSystem[], void, void>;
+    };
+    protected pageOfListAttachments: (request?: Readonly<ListAttachmentsRequest>) => Promise<ListAttachmentsResponse>;
+    /**
+     * 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?: Readonly<ListAttachmentsRequest>) => Promise<ListAttachmentsResponse> & {
+        all: () => Promise<import("./types.gen").Attachment[]>;
+        [Symbol.asyncIterator]: () => AsyncGenerator<import("./types.gen").Attachment[], void, void>;
+    };
+    /**
+     * Create a new filesystem. To create a new filesystem, you need to provide a name, a size, and a project ID.
+     *
+     * @param request - The request {@link CreateFileSystemRequest}
+     * @returns A Promise of FileSystem
+     */
+    createFileSystem: (request: Readonly<CreateFileSystemRequest>) => Promise<FileSystem>;
+    /**
+     * 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: Readonly<DeleteFileSystemRequest>) => Promise<void>;
+    /**
+     * 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: Readonly<UpdateFileSystemRequest>) => Promise<FileSystem>;
+}

package/dist/v1alpha1/api.gen.js

@@ -0,0 +1,137 @@
+import { API as API$1, 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 {
+  /** Lists the available regions of the API. */
+  static LOCALITIES = ["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],
+        ["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. Results are ordered by creation date in ascending order by default.
+  Use the order_by parameter to modify the sorting behavior.
+     *
+     * @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 need to provide 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
+};

package/dist/v1alpha1/content.gen.cjs

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const FILE_SYSTEM_TRANSIENT_STATUSES = [
+  "creating",
+  "updating"
+];
+exports.FILE_SYSTEM_TRANSIENT_STATUSES = FILE_SYSTEM_TRANSIENT_STATUSES;

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

@@ -0,0 +1,3 @@
+import type { FileSystemStatus } from './types.gen';
+/** Lists transient statutes of the enum {@link FileSystemStatus}. */
+export declare const FILE_SYSTEM_TRANSIENT_STATUSES: FileSystemStatus[];

package/dist/v1alpha1/content.gen.js

@@ -0,0 +1,7 @@
+const FILE_SYSTEM_TRANSIENT_STATUSES = [
+  "creating",
+  "updating"
+];
+export {
+  FILE_SYSTEM_TRANSIENT_STATUSES
+};

package/dist/v1alpha1/index.gen.cjs

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const api_gen = require("./api.gen.cjs");
+const content_gen = require("./content.gen.cjs");
+const marshalling_gen = require("./marshalling.gen.cjs");
+const validationRules_gen = require("./validation-rules.gen.cjs");
+exports.API = api_gen.API;
+exports.FILE_SYSTEM_TRANSIENT_STATUSES = content_gen.FILE_SYSTEM_TRANSIENT_STATUSES;
+exports.marshalCreateFileSystemRequest = marshalling_gen.marshalCreateFileSystemRequest;
+exports.marshalUpdateFileSystemRequest = marshalling_gen.marshalUpdateFileSystemRequest;
+exports.unmarshalFileSystem = marshalling_gen.unmarshalFileSystem;
+exports.unmarshalListAttachmentsResponse = marshalling_gen.unmarshalListAttachmentsResponse;
+exports.unmarshalListFileSystemsResponse = marshalling_gen.unmarshalListFileSystemsResponse;
+exports.ValidationRules = validationRules_gen;

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

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

package/dist/v1alpha1/index.gen.js

@@ -0,0 +1,14 @@
+import { API } from "./api.gen.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
+};

package/dist/v1alpha1/marshalling.gen.cjs

@@ -0,0 +1,75 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const sdkClient = require("@scaleway/sdk-client");
+const unmarshalFileSystem = (data) => {
+  if (!sdkClient.isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'FileSystem' failed as data isn't a dictionary.`
+    );
+  }
+  return {
+    createdAt: sdkClient.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: sdkClient.unmarshalDate(data.updated_at)
+  };
+};
+const unmarshalAttachment = (data) => {
+  if (!sdkClient.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 (!sdkClient.isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'ListAttachmentsResponse' failed as data isn't a dictionary.`
+    );
+  }
+  return {
+    attachments: sdkClient.unmarshalArrayOfObject(data.attachments, unmarshalAttachment),
+    totalCount: data.total_count
+  };
+};
+const unmarshalListFileSystemsResponse = (data) => {
+  if (!sdkClient.isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'ListFileSystemsResponse' failed as data isn't a dictionary.`
+    );
+  }
+  return {
+    filesystems: sdkClient.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
+});
+const marshalUpdateFileSystemRequest = (request, defaults) => ({
+  name: request.name,
+  size: request.size,
+  tags: request.tags
+});
+exports.marshalCreateFileSystemRequest = marshalCreateFileSystemRequest;
+exports.marshalUpdateFileSystemRequest = marshalUpdateFileSystemRequest;
+exports.unmarshalFileSystem = unmarshalFileSystem;
+exports.unmarshalListAttachmentsResponse = unmarshalListAttachmentsResponse;
+exports.unmarshalListFileSystemsResponse = unmarshalListFileSystemsResponse;

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

@@ -0,0 +1,7 @@
+import type { DefaultValues } from '@scaleway/sdk-client';
+import type { CreateFileSystemRequest, FileSystem, ListAttachmentsResponse, ListFileSystemsResponse, UpdateFileSystemRequest } from './types.gen';
+export declare const unmarshalFileSystem: (data: unknown) => FileSystem;
+export declare const unmarshalListAttachmentsResponse: (data: unknown) => ListAttachmentsResponse;
+export declare const unmarshalListFileSystemsResponse: (data: unknown) => ListFileSystemsResponse;
+export declare const marshalCreateFileSystemRequest: (request: CreateFileSystemRequest, defaults: DefaultValues) => Record<string, unknown>;
+export declare const marshalUpdateFileSystemRequest: (request: UpdateFileSystemRequest, defaults: DefaultValues) => Record<string, unknown>;

package/dist/v1alpha1/marshalling.gen.js

@@ -0,0 +1,75 @@
+import { isJSONObject, unmarshalDate, unmarshalArrayOfObject } 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)
+  };
+};
+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
+  };
+};
+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
+  };
+};
+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
+  };
+};
+const marshalCreateFileSystemRequest = (request, defaults) => ({
+  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
+});
+export {
+  marshalCreateFileSystemRequest,
+  marshalUpdateFileSystemRequest,
+  unmarshalFileSystem,
+  unmarshalListAttachmentsResponse,
+  unmarshalListFileSystemsResponse
+};

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

@@ -0,0 +1,247 @@
+import type { Region as ScwRegion, Zone as ScwZone } from '@scaleway/sdk-client';
+export type AttachmentResourceType = 'unknown_resource_type' | 'instance_server';
+export type FileSystemStatus = 'unknown_status' | 'available' | 'error' | 'creating' | 'updating';
+export type ListFileSystemsRequestOrderBy = 'created_at_asc' | 'created_at_desc' | 'name_asc' | 'name_desc';
+/**
+ * Represents an attachment between a filesystem and a resource.
+ */
+export interface Attachment {
+    /**
+     * UUID of the attachment.
+     */
+    id: string;
+    /**
+     * UUID of the filesystem.
+     */
+    filesystemId: string;
+    /**
+     * UUID of the attached resource.
+     */
+    resourceId: string;
+    /**
+     * The type of the attached resource.
+     */
+    resourceType: AttachmentResourceType;
+    /**
+     * The zone where the resource is located.
+     */
+    zone?: ScwZone;
+}
+/**
+ * Represents a filesystem resource and its properties.
+ */
+export interface FileSystem {
+    /**
+     * UUID of the filesystem.
+     */
+    id: string;
+    /**
+     * Name of the filesystem.
+     */
+    name: string;
+    /**
+     * Filesystem size in bytes.
+     */
+    size: number;
+    /**
+     * Current status of the filesystem (e.g. creating, available, ...).
+     */
+    status: FileSystemStatus;
+    /**
+     * UUID of the project to which the filesystem belongs.
+     */
+    projectId: string;
+    /**
+     * UUID of the organization to which the filesystem belongs.
+     */
+    organizationId: string;
+    /**
+     * List of tags assigned to the filesystem.
+     */
+    tags: string[];
+    /**
+     * The current number of attachments (mounts) that the filesystem has.
+     */
+    numberOfAttachments: number;
+    /**
+     * Region where the filesystem is located.
+     */
+    region: ScwRegion;
+    /**
+     * Creation date of the filesystem.
+     */
+    createdAt?: Date;
+    /**
+     * Last update date of the properties of the filesystem.
+     */
+    updatedAt?: Date;
+}
+/**
+ * Request to create a new filesystem.
+ */
+export type CreateFileSystemRequest = {
+    /**
+     * Region to target. If none is passed will use default region from the config.
+     */
+    region?: ScwRegion;
+    /**
+     * Name of the filesystem.
+     */
+    name: string;
+    /**
+     * UUID of the project the filesystem belongs to.
+     */
+    projectId?: string;
+    /**
+     * Must be compliant with the minimum (100 GB) and maximum (10 TB) allowed size.
+     */
+    size: number;
+    /**
+     * List of tags assigned to the filesystem.
+     */
+    tags?: string[];
+};
+/**
+ * Request to delete a specific filesystem.
+ */
+export type DeleteFileSystemRequest = {
+    /**
+     * Region to target. If none is passed will use default region from the config.
+     */
+    region?: ScwRegion;
+    /**
+     * UUID of the filesystem.
+     */
+    filesystemId: string;
+};
+/**
+ * Request to retrieve a specific filesystem.
+ */
+export type GetFileSystemRequest = {
+    /**
+     * Region to target. If none is passed will use default region from the config.
+     */
+    region?: ScwRegion;
+    /**
+     * UUID of the filesystem.
+     */
+    filesystemId: string;
+};
+/**
+ * Request to list filesystem attachments with filtering and pagination options.
+ */
+export type ListAttachmentsRequest = {
+    /**
+     * Region to target. If none is passed will use default region from the config.
+     */
+    region?: ScwRegion;
+    /**
+     * UUID of the File Storage volume.
+     */
+    filesystemId?: string;
+    /**
+     * Filter by resource ID.
+     */
+    resourceId?: string;
+    /**
+     * Filter by resource type.
+     */
+    resourceType?: AttachmentResourceType;
+    /**
+     * Filter by resource zone.
+     */
+    zone?: ScwZone;
+    /**
+     * Page number (starting at 1).
+     */
+    page?: number;
+    /**
+     * Number of entries per page (default: 20, max: 100).
+     */
+    pageSize?: number;
+};
+/**
+ * Response containing a list of filesystem attachments and total count.
+ */
+export interface ListAttachmentsResponse {
+    /**
+     * List of filesystem attachments matching the request criteria.
+     */
+    attachments: Attachment[];
+    /**
+     * Total number of filesystem attachments matching the criteria.
+     */
+    totalCount: number;
+}
+/**
+ * Request to list filesystems with filtering and pagination options.
+ */
+export type ListFileSystemsRequest = {
+    /**
+     * Region to target. If none is passed will use default region from the config.
+     */
+    region?: ScwRegion;
+    /**
+     * Criteria to use when ordering the list.
+     */
+    orderBy?: ListFileSystemsRequestOrderBy;
+    /**
+     * Filter by project ID.
+     */
+    projectId?: string;
+    /**
+     * Page number (starting at 1).
+     */
+    page?: number;
+    /**
+     * Number of entries per page (default: 20, max: 100).
+     */
+    pageSize?: number;
+    /**
+     * Filter the return filesystems by their names.
+     */
+    name?: string;
+    /**
+     * Filter by tags. Only filesystems with one or more matching tags will be returned.
+     */
+    tags?: string[];
+};
+/**
+ * Response containing a list of filesystems and total count.
+ */
+export interface ListFileSystemsResponse {
+    /**
+     * List of filesystems matching the request criteria.
+     */
+    filesystems: FileSystem[];
+    /**
+     * Total number of filesystems matching the criteria.
+     */
+    totalCount: number;
+}
+/**
+ * Request to update a specific filesystem.
+ */
+export type UpdateFileSystemRequest = {
+    /**
+     * Region to target. If none is passed will use default region from the config.
+     */
+    region?: ScwRegion;
+    /**
+     * UUID of the filesystem.
+     */
+    filesystemId: string;
+    /**
+     * When defined, is the new name of the filesystem.
+     */
+    name?: string;
+    /**
+     * Size in bytes, with a granularity of 100 GB (10^11 bytes).
+  Must be compliant with the minimum (100 GB) and maximum (10 TB) allowed size.
+     */
+    size?: number;
+    /**
+     * List of tags assigned to the filesystem.
+     */
+    tags?: string[];
+};

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

@@ -0,0 +1,40 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const CreateFileSystemRequest = {
+  name: {
+    minLength: 1
+  },
+  size: {
+    greaterThan: 0
+  }
+};
+const ListAttachmentsRequest = {
+  page: {
+    greaterThan: 0
+  },
+  pageSize: {
+    greaterThan: 0,
+    lessThanOrEqual: 100
+  }
+};
+const ListFileSystemsRequest = {
+  page: {
+    greaterThan: 0
+  },
+  pageSize: {
+    greaterThan: 0,
+    lessThanOrEqual: 100
+  }
+};
+const UpdateFileSystemRequest = {
+  name: {
+    minLength: 1
+  },
+  size: {
+    greaterThan: 0
+  }
+};
+exports.CreateFileSystemRequest = CreateFileSystemRequest;
+exports.ListAttachmentsRequest = ListAttachmentsRequest;
+exports.ListFileSystemsRequest = ListFileSystemsRequest;
+exports.UpdateFileSystemRequest = UpdateFileSystemRequest;

package/dist/v1alpha1/validation-rules.gen.d.ts

@@ -0,0 +1,34 @@
+export declare const CreateFileSystemRequest: {
+    name: {
+        minLength: number;
+    };
+    size: {
+        greaterThan: number;
+    };
+};
+export declare const ListAttachmentsRequest: {
+    page: {
+        greaterThan: number;
+    };
+    pageSize: {
+        greaterThan: number;
+        lessThanOrEqual: number;
+    };
+};
+export declare const ListFileSystemsRequest: {
+    page: {
+        greaterThan: number;
+    };
+    pageSize: {
+        greaterThan: number;
+        lessThanOrEqual: number;
+    };
+};
+export declare const UpdateFileSystemRequest: {
+    name: {
+        minLength: number;
+    };
+    size: {
+        greaterThan: number;
+    };
+};

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

@@ -0,0 +1,40 @@
+const CreateFileSystemRequest = {
+  name: {
+    minLength: 1
+  },
+  size: {
+    greaterThan: 0
+  }
+};
+const ListAttachmentsRequest = {
+  page: {
+    greaterThan: 0
+  },
+  pageSize: {
+    greaterThan: 0,
+    lessThanOrEqual: 100
+  }
+};
+const ListFileSystemsRequest = {
+  page: {
+    greaterThan: 0
+  },
+  pageSize: {
+    greaterThan: 0,
+    lessThanOrEqual: 100
+  }
+};
+const UpdateFileSystemRequest = {
+  name: {
+    minLength: 1
+  },
+  size: {
+    greaterThan: 0
+  }
+};
+export {
+  CreateFileSystemRequest,
+  ListAttachmentsRequest,
+  ListFileSystemsRequest,
+  UpdateFileSystemRequest
+};

package/package.json

@@ -0,0 +1,51 @@
+{
+  "name": "@scaleway/sdk-file",
+  "version": "1.0.3",
+  "description": "Scaleway SDK file",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./dist/index.gen.d.ts",
+      "import": "./dist/index.gen.js",
+      "require": "./dist/index.gen.cjs",
+      "default": "./dist/index.gen.js"
+    },
+    "./*": {
+      "types": "./dist/*/index.gen.d.ts",
+      "import": "./dist/*/index.gen.js",
+      "require": "./dist/*/index.gen.cjs",
+      "default": "./dist/*/index.gen.js"
+    }
+  },
+  "repository": {
+    "type": "git",
+    "directory": "packages_generated/file"
+  },
+  "engines": {
+    "node": ">=20.18.3"
+  },
+  "dependencies": {
+    "@scaleway/random-name": "5.1.1",
+    "@scaleway/sdk-std": "1.0.1"
+  },
+  "peerDependencies": {
+    "@scaleway/sdk-client": "^1.2.1"
+  },
+  "devDependencies": {
+    "@scaleway/sdk-client": "^1.2.1"
+  },
+  "bundledDependencies": [
+    "@scaleway/random-name"
+  ],
+  "scripts": {
+    "package:check": "pnpm publint",
+    "typecheck": "tsc --noEmit",
+    "type:generate": "tsc --declaration -p tsconfig.build.json",
+    "build": "vite build --config vite.config.ts && pnpm run type:generate",
+    "build:profile": "npx vite-bundle-visualizer -c vite.config.ts"
+  }
+}