@scaleway/sdk-file 2.3.2 → 2.5.0

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

@@ -1,6 +1,6 @@
 import type { ApiLocality, WaitForOptions } from '@scaleway/sdk-client';
 import { API as ParentAPI } from '@scaleway/sdk-client';
-import type { CreateFileSystemRequest, DeleteFileSystemRequest, FileSystem, GetFileSystemRequest, ListAttachmentsRequest, ListAttachmentsResponse, ListFileSystemsRequest, ListFileSystemsResponse, UpdateFileSystemRequest } from './types.gen.js';
+import type { CreateFileSystemRequest, DeleteFileSystemRequest, FileSystem, GetFileSystemRequest, ListAttachmentsRequest, ListAttachmentsResponse, ListFileSystemsRequest, ListFileSystemsResponse, ListFileSystemTypesRequest, ListFileSystemTypesResponse, UpdateFileSystemRequest } from './types.gen.js';
 /**
  * File Storage API.
 
@@ -12,6 +12,17 @@ export declare class API extends ParentAPI {
      * type ∈ {'zone','region','global','unspecified'}
      */
     static readonly LOCALITY: ApiLocality;
+    protected pageOfListFileSystemTypes: (request?: Readonly<ListFileSystemTypesRequest>) => Promise<ListFileSystemTypesResponse>;
+    /**
+     * List filesystems types.
+     *
+     * @param request - The request {@link ListFileSystemTypesRequest}
+     * @returns A Promise of ListFileSystemTypesResponse
+     */
+    listFileSystemTypes: (request?: Readonly<ListFileSystemTypesRequest>) => Promise<ListFileSystemTypesResponse> & {
+        all: () => Promise<import("./types.gen.js").FileSystemType[]>;
+        [Symbol.asyncIterator]: () => AsyncGenerator<import("./types.gen.js").FileSystemType[], void, void>;
+    };
     /**
      * Get filesystem details. Retrieve all properties and current status of a specific filesystem identified by its ID.
      *

package/dist/v1alpha1/api.gen.js

@@ -1,5 +1,5 @@
 import { FILE_SYSTEM_TRANSIENT_STATUSES } from "./content.gen.js";
-import { marshalCreateFileSystemRequest, marshalUpdateFileSystemRequest, unmarshalFileSystem, unmarshalListAttachmentsResponse, unmarshalListFileSystemsResponse } from "./marshalling.gen.js";
+import { marshalCreateFileSystemRequest, marshalUpdateFileSystemRequest, unmarshalFileSystem, unmarshalListAttachmentsResponse, unmarshalListFileSystemTypesResponse, unmarshalListFileSystemsResponse } from "./marshalling.gen.js";
 import { API as API$1, enrichForPagination, toApiLocality, urlParams, validatePathParam, waitForResource } from "@scaleway/sdk-client";
 //#region src/v1alpha1/api.gen.ts
 var jsonContentHeaders = { "Content-Type": "application/json; charset=utf-8" };
@@ -14,6 +14,18 @@ var API = class extends API$1 {
 	* type ∈ {'zone','region','global','unspecified'}
 	*/
 	static LOCALITY = toApiLocality({ regions: ["fr-par"] });
+	pageOfListFileSystemTypes = (request = {}) => this.client.fetch({
+		method: "GET",
+		path: `/file/v1alpha1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/filesystem-types`,
+		urlParams: urlParams(["page", request.page], ["page_size", request.pageSize ?? this.client.settings.defaultPageSize])
+	}, unmarshalListFileSystemTypesResponse);
+	/**
+	* List filesystems types.
+	*
+	* @param request - The request {@link ListFileSystemTypesRequest}
+	* @returns A Promise of ListFileSystemTypesResponse
+	*/
+	listFileSystemTypes = (request = {}) => enrichForPagination("filesystemTypes", this.pageOfListFileSystemTypes, request);
 	/**
 	* Get filesystem details. Retrieve all properties and current status of a specific filesystem identified by its ID.
 	*
@@ -35,7 +47,7 @@ var API = class extends API$1 {
 	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])
+		urlParams: urlParams(["filesystem_ids", request.filesystemIds], ["filesystem_type", request.filesystemType], ["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.

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

@@ -1,5 +1,5 @@
 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';
+export type { Attachment, AttachmentResourceType, CreateFileSystemRequest, DeleteFileSystemRequest, FileSystem, FileSystemStatus, FileSystemType, GetFileSystemRequest, ListAttachmentsRequest, ListAttachmentsResponse, ListFileSystemsRequest, ListFileSystemsRequestOrderBy, ListFileSystemsResponse, ListFileSystemTypesRequest, ListFileSystemTypesResponse, UpdateFileSystemRequest, } from './types.gen.js';
 export * as ValidationRules from './validation-rules.gen.js';

package/dist/v1alpha1/index.gen.js

@@ -1,6 +1,6 @@
 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 { marshalCreateFileSystemRequest, marshalUpdateFileSystemRequest, unmarshalFileSystem, unmarshalListAttachmentsResponse, unmarshalListFileSystemTypesResponse, unmarshalListFileSystemsResponse } from "./marshalling.gen.js";
 import { API } from "./api.gen.js";
 import { validation_rules_gen_exports } from "./validation-rules.gen.js";
 //#region src/v1alpha1/index.gen.ts
@@ -12,7 +12,8 @@ var index_gen_exports = /* @__PURE__ */ __exportAll({
 	marshalUpdateFileSystemRequest: () => marshalUpdateFileSystemRequest,
 	unmarshalFileSystem: () => unmarshalFileSystem,
 	unmarshalListAttachmentsResponse: () => unmarshalListAttachmentsResponse,
+	unmarshalListFileSystemTypesResponse: () => unmarshalListFileSystemTypesResponse,
 	unmarshalListFileSystemsResponse: () => unmarshalListFileSystemsResponse
 });
 //#endregion
-export { API, FILE_SYSTEM_TRANSIENT_STATUSES, validation_rules_gen_exports as ValidationRules, index_gen_exports, marshalCreateFileSystemRequest, marshalUpdateFileSystemRequest, unmarshalFileSystem, unmarshalListAttachmentsResponse, unmarshalListFileSystemsResponse };
+export { API, FILE_SYSTEM_TRANSIENT_STATUSES, validation_rules_gen_exports as ValidationRules, index_gen_exports, marshalCreateFileSystemRequest, marshalUpdateFileSystemRequest, unmarshalFileSystem, unmarshalListAttachmentsResponse, unmarshalListFileSystemTypesResponse, unmarshalListFileSystemsResponse };

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

@@ -1,7 +1,8 @@
 import type { DefaultValues } from '@scaleway/sdk-client';
-import type { CreateFileSystemRequest, FileSystem, ListAttachmentsResponse, ListFileSystemsResponse, UpdateFileSystemRequest } from './types.gen.js';
+import type { CreateFileSystemRequest, FileSystem, ListAttachmentsResponse, ListFileSystemsResponse, ListFileSystemTypesResponse, UpdateFileSystemRequest } from './types.gen.js';
 export declare const unmarshalFileSystem: (data: unknown) => FileSystem;
 export declare const unmarshalListAttachmentsResponse: (data: unknown) => ListAttachmentsResponse;
+export declare const unmarshalListFileSystemTypesResponse: (data: unknown) => ListFileSystemTypesResponse;
 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

@@ -1,9 +1,10 @@
-import { isJSONObject, unmarshalArrayOfObject, unmarshalDate } from "@scaleway/sdk-client";
+import { isJSONObject, unmarshalArrayOfObject, unmarshalDate, unmarshalMoney } from "@scaleway/sdk-client";
 //#region src/v1alpha1/marshalling.gen.ts
 var 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),
+		filesystemTypeId: data.filesystem_type_id,
 		id: data.id,
 		name: data.name,
 		numberOfAttachments: data.number_of_attachments,
@@ -33,6 +34,21 @@ var unmarshalListAttachmentsResponse = (data) => {
 		totalCount: data.total_count
 	};
 };
+var unmarshalFileSystemType = (data) => {
+	if (!isJSONObject(data)) throw new TypeError(`Unmarshalling the type 'FileSystemType' failed as data isn't a dictionary.`);
+	return {
+		filesystemPriceGbPerHour: data.filesystem_price_gb_per_hour ? unmarshalMoney(data.filesystem_price_gb_per_hour) : void 0,
+		name: data.name,
+		snapshotPriceGbPerHour: data.snapshot_price_gb_per_hour ? unmarshalMoney(data.snapshot_price_gb_per_hour) : void 0
+	};
+};
+var unmarshalListFileSystemTypesResponse = (data) => {
+	if (!isJSONObject(data)) throw new TypeError(`Unmarshalling the type 'ListFileSystemTypesResponse' failed as data isn't a dictionary.`);
+	return {
+		filesystemTypes: unmarshalArrayOfObject(data.filesystem_types, unmarshalFileSystemType),
+		totalCount: data.total_count
+	};
+};
 var unmarshalListFileSystemsResponse = (data) => {
 	if (!isJSONObject(data)) throw new TypeError(`Unmarshalling the type 'ListFileSystemsResponse' failed as data isn't a dictionary.`);
 	return {
@@ -44,7 +60,8 @@ var marshalCreateFileSystemRequest = (request, defaults) => ({
 	name: request.name,
 	project_id: request.projectId ?? defaults.defaultProjectId,
 	size: request.size,
-	tags: request.tags
+	tags: request.tags,
+	type: request.type
 });
 var marshalUpdateFileSystemRequest = (request, defaults) => ({
 	name: request.name,
@@ -52,4 +69,4 @@ var marshalUpdateFileSystemRequest = (request, defaults) => ({
 	tags: request.tags
 });
 //#endregion
-export { marshalCreateFileSystemRequest, marshalUpdateFileSystemRequest, unmarshalFileSystem, unmarshalListAttachmentsResponse, unmarshalListFileSystemsResponse };
+export { marshalCreateFileSystemRequest, marshalUpdateFileSystemRequest, unmarshalFileSystem, unmarshalListAttachmentsResponse, unmarshalListFileSystemTypesResponse, unmarshalListFileSystemsResponse };

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

@@ -0,0 +1,53 @@
+export declare const queriesMetadata: {
+    readonly namespace: "file";
+    readonly version: "v1alpha1";
+    readonly folderName: "filev1alpha1";
+    readonly services: readonly [{
+        readonly apiClass: "API";
+        readonly methods: readonly [{
+            readonly methodName: "listFileSystemTypes";
+            readonly protoName: "ListFileSystemTypes";
+            readonly paramsType: "ListFileSystemTypesRequest";
+            readonly returnType: "ListFileSystemTypesResponse";
+            readonly isList: true;
+            readonly paginationType: "offset";
+            readonly pageParamKey: "page";
+            readonly listItemType: "FileSystemType";
+            readonly isPrivate: false;
+            readonly description: "\"";
+        }, {
+            readonly methodName: "getFileSystem";
+            readonly protoName: "GetFileSystem";
+            readonly paramsType: "GetFileSystemRequest";
+            readonly returnType: "FileSystem";
+            readonly isList: false;
+            readonly paginationType: "none";
+            readonly isPrivate: false;
+            readonly description: "\"";
+            readonly hasWaiter: true;
+        }, {
+            readonly methodName: "listFileSystems";
+            readonly protoName: "ListFileSystems";
+            readonly paramsType: "ListFileSystemsRequest";
+            readonly returnType: "ListFileSystemsResponse";
+            readonly isList: true;
+            readonly paginationType: "offset";
+            readonly pageParamKey: "page";
+            readonly listItemType: "FileSystem";
+            readonly isPrivate: false;
+            readonly description: "\"";
+        }, {
+            readonly methodName: "listAttachments";
+            readonly protoName: "ListAttachments";
+            readonly paramsType: "ListAttachmentsRequest";
+            readonly returnType: "ListAttachmentsResponse";
+            readonly isList: true;
+            readonly paginationType: "offset";
+            readonly pageParamKey: "page";
+            readonly listItemType: "Attachment";
+            readonly isPrivate: false;
+            readonly description: "\"";
+        }];
+    }];
+};
+export type QueriesMetadata = typeof queriesMetadata;

package/dist/v1alpha1/metadata.gen.js

@@ -0,0 +1,60 @@
+//#region src/v1alpha1/metadata.gen.ts
+var queriesMetadata = {
+	namespace: "file",
+	version: "v1alpha1",
+	folderName: "filev1alpha1",
+	services: [{
+		apiClass: "API",
+		methods: [
+			{
+				methodName: "listFileSystemTypes",
+				protoName: "ListFileSystemTypes",
+				paramsType: "ListFileSystemTypesRequest",
+				returnType: "ListFileSystemTypesResponse",
+				isList: true,
+				paginationType: "offset",
+				pageParamKey: "page",
+				listItemType: "FileSystemType",
+				isPrivate: false,
+				description: "\""
+			},
+			{
+				methodName: "getFileSystem",
+				protoName: "GetFileSystem",
+				paramsType: "GetFileSystemRequest",
+				returnType: "FileSystem",
+				isList: false,
+				paginationType: "none",
+				isPrivate: false,
+				description: "\"",
+				hasWaiter: true
+			},
+			{
+				methodName: "listFileSystems",
+				protoName: "ListFileSystems",
+				paramsType: "ListFileSystemsRequest",
+				returnType: "ListFileSystemsResponse",
+				isList: true,
+				paginationType: "offset",
+				pageParamKey: "page",
+				listItemType: "FileSystem",
+				isPrivate: false,
+				description: "\""
+			},
+			{
+				methodName: "listAttachments",
+				protoName: "ListAttachments",
+				paramsType: "ListAttachmentsRequest",
+				returnType: "ListAttachmentsResponse",
+				isList: true,
+				paginationType: "offset",
+				pageParamKey: "page",
+				listItemType: "Attachment",
+				isPrivate: false,
+				description: "\""
+			}
+		]
+	}]
+};
+//#endregion
+export { queriesMetadata };

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

@@ -1,4 +1,4 @@
-import type { Region as ScwRegion, Zone as ScwZone } from '@scaleway/sdk-client';
+import type { Money, 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';
@@ -27,6 +27,20 @@ export interface Attachment {
      */
     zone?: ScwZone;
 }
+export interface FileSystemType {
+    /**
+     * Filesystem type name.
+     */
+    name: string;
+    /**
+     * Price of the filesystem billed in GB/hour.
+     */
+    filesystemPriceGbPerHour?: Money;
+    /**
+     * Price of the snapshot billed in GB/hour.
+     */
+    snapshotPriceGbPerHour?: Money;
+}
 /**
  * Represents a filesystem resource and its properties.
  */
@@ -75,6 +89,10 @@ export interface FileSystem {
      * Last update date of the properties of the filesystem.
      */
     updatedAt?: Date;
+    /**
+     * UUID of the filesystem type.
+     */
+    filesystemTypeId: string;
 }
 /**
  * Request to create a new filesystem.
@@ -96,6 +114,10 @@ export type CreateFileSystemRequest = {
      * Must be compliant with the minimum (100 GB) and maximum (10 TB) allowed size.
      */
     size: number;
+    /**
+     * Type of the filesystem.
+     */
+    type?: string;
     /**
      * List of tags assigned to the filesystem.
      */
@@ -173,6 +195,33 @@ export interface ListAttachmentsResponse {
      */
     totalCount: number;
 }
+/**
+ * Request to list filesystem types with pagination options.
+ */
+export type ListFileSystemTypesRequest = {
+    /**
+     * Region to target. If none is passed will use default region from the config.
+     */
+    region?: ScwRegion;
+    /**
+     * Page number (starts at 1).
+     */
+    page?: number;
+    /**
+     * Number of entries per page (default: 50, max: 100).
+     */
+    pageSize?: number;
+};
+export interface ListFileSystemTypesResponse {
+    /**
+     * Returns paginated list of filesystem-types.
+     */
+    filesystemTypes: FileSystemType[];
+    /**
+     * Total number of file system types.
+     */
+    totalCount: number;
+}
 /**
  * Request to list filesystems with filtering and pagination options.
  */
@@ -205,6 +254,10 @@ export type ListFileSystemsRequest = {
      * Filter the returned filesystems by their names.
      */
     name?: string;
+    /**
+     * Type of the filesystem.
+     */
+    filesystemType?: string;
     /**
      * Filter by tags. Only filesystems with one or more matching tags will be returned.
      */

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

@@ -15,6 +15,15 @@ export declare const ListAttachmentsRequest: {
         lessThanOrEqual: number;
     };
 };
+export declare const ListFileSystemTypesRequest: {
+    page: {
+        greaterThan: number;
+    };
+    pageSize: {
+        greaterThan: number;
+        lessThanOrEqual: number;
+    };
+};
 export declare const ListFileSystemsRequest: {
     page: {
         greaterThan: number;

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

@@ -3,6 +3,7 @@ import { __exportAll } from "../_virtual/_rolldown/runtime.js";
 var validation_rules_gen_exports = /* @__PURE__ */ __exportAll({
 	CreateFileSystemRequest: () => CreateFileSystemRequest,
 	ListAttachmentsRequest: () => ListAttachmentsRequest,
+	ListFileSystemTypesRequest: () => ListFileSystemTypesRequest,
 	ListFileSystemsRequest: () => ListFileSystemsRequest,
 	UpdateFileSystemRequest: () => UpdateFileSystemRequest
 });
@@ -17,6 +18,13 @@ var ListAttachmentsRequest = {
 		lessThanOrEqual: 100
 	}
 };
+var ListFileSystemTypesRequest = {
+	page: { greaterThan: 0 },
+	pageSize: {
+		greaterThan: 0,
+		lessThanOrEqual: 100
+	}
+};
 var ListFileSystemsRequest = {
 	page: { greaterThan: 0 },
 	pageSize: {
@@ -29,4 +37,4 @@ var UpdateFileSystemRequest = {
 	size: { greaterThan: 0 }
 };
 //#endregion
-export { CreateFileSystemRequest, ListAttachmentsRequest, ListFileSystemsRequest, UpdateFileSystemRequest, validation_rules_gen_exports };
+export { CreateFileSystemRequest, ListAttachmentsRequest, ListFileSystemTypesRequest, ListFileSystemsRequest, UpdateFileSystemRequest, validation_rules_gen_exports };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scaleway/sdk-file",
-  "version": "2.3.2",
+  "version": "2.5.0",
   "description": "Scaleway SDK file",
   "license": "Apache-2.0",
   "files": [