@scaleway/sdk 2.72.0 → 2.74.0

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

@@ -0,0 +1,8 @@
+import { API } from "./api.gen.js";
+import { FILE_SYSTEM_TRANSIENT_STATUSES } from "./content.gen.js";
+import * as validationRules_gen from "./validation-rules.gen.js";
+export {
+  API,
+  FILE_SYSTEM_TRANSIENT_STATUSES,
+  validationRules_gen as ValidationRules
+};

package/dist/api/file/v1alpha1/marshalling.gen.cjs

@@ -0,0 +1,77 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+require("../../../client/dist/internal/logger/index.cjs");
+const json = require("../../../client/dist/helpers/json.cjs");
+const marshalling = require("../../../client/dist/helpers/marshalling.cjs");
+require("../../../client/dist/vendor/base64/index.cjs");
+const unmarshalFileSystem = (data) => {
+  if (!json.isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'FileSystem' failed as data isn't a dictionary.`
+    );
+  }
+  return {
+    createdAt: marshalling.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: marshalling.unmarshalDate(data.updated_at)
+  };
+};
+const unmarshalAttachment = (data) => {
+  if (!json.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
+  };
+};
+const unmarshalListAttachmentsResponse = (data) => {
+  if (!json.isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'ListAttachmentsResponse' failed as data isn't a dictionary.`
+    );
+  }
+  return {
+    attachments: marshalling.unmarshalArrayOfObject(data.attachments, unmarshalAttachment),
+    totalCount: data.total_count
+  };
+};
+const unmarshalListFileSystemsResponse = (data) => {
+  if (!json.isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'ListFileSystemsResponse' failed as data isn't a dictionary.`
+    );
+  }
+  return {
+    filesystems: marshalling.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/api/file/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/api/file/v1alpha1/marshalling.gen.js

@@ -0,0 +1,77 @@
+import "../../../client/dist/internal/logger/index.js";
+import { isJSONObject } from "../../../client/dist/helpers/json.js";
+import { unmarshalDate, unmarshalArrayOfObject } from "../../../client/dist/helpers/marshalling.js";
+import "../../../client/dist/vendor/base64/index.js";
+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
+  };
+};
+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/api/file/v1alpha1/types.gen.d.ts

@@ -0,0 +1,239 @@
+import type { Region as ScwRegion } 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;
+}
+/**
+ * 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;
+    /**
+     * 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/api/file/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/api/file/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/api/file/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/dist/api/flexibleip/v1alpha1/api.gen.cjs

@@ -22,8 +22,7 @@ class API extends api.API {
     "pl-waw-3"
   ];
   /**
-   * Create a new flexible IP. Generate a new flexible IP within a given zone,
-   * specifying its configuration including Project ID and description.
+   * Create a new flexible IP. Generate a new flexible IP within a given zone, specifying its configuration including Project ID and description.
    *
    * @param request - The request {@link CreateFlexibleIPRequest}
    * @returns A Promise of FlexibleIP
@@ -40,9 +39,7 @@ class API extends api.API {
     marshalling_gen.unmarshalFlexibleIP
   );
   /**
-   * Get an existing flexible IP. Retrieve information about an existing
-   * flexible IP, specified by its ID and zone. Its full details, including
-   * Project ID, description and status, are returned in the response object.
+   * Get an existing flexible IP. Retrieve information about an existing flexible IP, specified by its ID and zone. Its full details, including Project ID, description and status, are returned in the response object.
    *
    * @param request - The request {@link GetFlexibleIPRequest}
    * @returns A Promise of FlexibleIP
@@ -97,9 +94,7 @@ class API extends api.API {
    */
   listFlexibleIPs = (request = {}) => resourcePaginator.enrichForPagination("flexibleIps", this.pageOfListFlexibleIPs, request);
   /**
-   * Update an existing flexible IP. Update the parameters of an existing
-   * flexible IP, specified by its ID and zone. These parameters include tags
-   * and description.
+   * Update an existing flexible IP. Update the parameters of an existing flexible IP, specified by its ID and zone. These parameters include tags and description.
    *
    * @param request - The request {@link UpdateFlexibleIPRequest}
    * @returns A Promise of FlexibleIP
@@ -116,9 +111,7 @@ class API extends api.API {
     marshalling_gen.unmarshalFlexibleIP
   );
   /**
-   * Delete an existing flexible IP. Delete an existing flexible IP, specified
-   * by its ID and zone. Note that deleting a flexible IP is permanent and
-   * cannot be undone.
+   * Delete an existing flexible IP. Delete an existing flexible IP, specified by its ID and zone. Note that deleting a flexible IP is permanent and cannot be undone.
    *
    * @param request - The request {@link DeleteFlexibleIPRequest}
    */
@@ -127,8 +120,7 @@ class API extends api.API {
     path: `/flexible-ip/v1alpha1/zones/${marshalling.validatePathParam("zone", request.zone ?? this.client.settings.defaultZone)}/fips/${marshalling.validatePathParam("fipId", request.fipId)}`
   });
   /**
-   * Attach an existing flexible IP to a server. Attach an existing flexible IP
-   * to a specified Elastic Metal server.
+   * Attach an existing flexible IP to a server. Attach an existing flexible IP to a specified Elastic Metal server.
    *
    * @param request - The request {@link AttachFlexibleIPRequest}
    * @returns A Promise of AttachFlexibleIPsResponse
@@ -145,8 +137,7 @@ class API extends api.API {
     marshalling_gen.unmarshalAttachFlexibleIPsResponse
   );
   /**
-   * Detach an existing flexible IP from a server. Detach an existing flexible
-   * IP from a specified Elastic Metal server.
+   * Detach an existing flexible IP from a server. Detach an existing flexible IP from a specified Elastic Metal server.
    *
    * @param request - The request {@link DetachFlexibleIPRequest}
    * @returns A Promise of DetachFlexibleIPsResponse
@@ -163,8 +154,7 @@ class API extends api.API {
     marshalling_gen.unmarshalDetachFlexibleIPsResponse
   );
   /**
-   * Generate a virtual MAC address on an existing flexible IP. Generate a
-   * virtual MAC (Media Access Control) address on an existing flexible IP.
+   * Generate a virtual MAC address on an existing flexible IP. Generate a virtual MAC (Media Access Control) address on an existing flexible IP.
    *
    * @param request - The request {@link GenerateMACAddrRequest}
    * @returns A Promise of FlexibleIP
@@ -181,9 +171,7 @@ class API extends api.API {
     marshalling_gen.unmarshalFlexibleIP
   );
   /**
-   * Duplicate a virtual MAC address to another flexible IP. Duplicate a virtual
-   * MAC address from a given flexible IP to another flexible IP attached to the
-   * same server.
+   * Duplicate a virtual MAC address to another flexible IP. Duplicate a virtual MAC address from a given flexible IP to another flexible IP attached to the same server.
    *
    * @param request - The request {@link DuplicateMACAddrRequest}
    * @returns A Promise of FlexibleIP
@@ -200,9 +188,7 @@ class API extends api.API {
     marshalling_gen.unmarshalFlexibleIP
   );
   /**
-   * Relocate an existing virtual MAC address to a different flexible IP.
-   * Relocate a virtual MAC (Media Access Control) address from an existing
-   * flexible IP to a different flexible IP.
+   * Relocate an existing virtual MAC address to a different flexible IP. Relocate a virtual MAC (Media Access Control) address from an existing flexible IP to a different flexible IP.
    *
    * @param request - The request {@link MoveMACAddrRequest}
    * @returns A Promise of FlexibleIP
@@ -219,8 +205,7 @@ class API extends api.API {
     marshalling_gen.unmarshalFlexibleIP
   );
   /**
-   * Detach a given virtual MAC address from an existing flexible IP. Detach a
-   * given MAC (Media Access Control) address from an existing flexible IP.
+   * Detach a given virtual MAC address from an existing flexible IP. Detach a given MAC (Media Access Control) address from an existing flexible IP.
    *
    * @param request - The request {@link DeleteMACAddrRequest}
    */