@scaleway/sdk 2.25.0 → 2.27.0

package/dist/api/account/v3/api.gen.d.ts

@@ -0,0 +1,57 @@
+import { API as ParentAPI } from '../../../bridge';
+import type { ListProjectsResponse, Project, ProjectApiCreateProjectRequest, ProjectApiDeleteProjectRequest, ProjectApiGetProjectRequest, ProjectApiListProjectsRequest, ProjectApiUpdateProjectRequest } from './types.gen';
+/**
+ * Account API.
+ *
+ * This API allows you to manage projects.
+ */
+export declare class ProjectAPI extends ParentAPI {
+    /**
+     * Create a new Project for an Organization. Generate a new Project for an
+     * Organization, specifying its configuration including name and description.
+     *
+     * @param request - The request {@link ProjectApiCreateProjectRequest}
+     * @returns A Promise of Project
+     */
+    createProject: (request: Readonly<ProjectApiCreateProjectRequest>) => Promise<Project>;
+    protected pageOfListProjects: (request?: Readonly<ProjectApiListProjectsRequest>) => Promise<ListProjectsResponse>;
+    /**
+     * List all Projects of an Organization. List all Projects of an Organization.
+     * The response will include the total number of Projects as well as their
+     * associated Organizations, names, and IDs. Other information includes the
+     * creation and update date of the Project.
+     *
+     * @param request - The request {@link ProjectApiListProjectsRequest}
+     * @returns A Promise of ListProjectsResponse
+     */
+    listProjects: (request?: Readonly<ProjectApiListProjectsRequest>) => Promise<ListProjectsResponse> & {
+        all: () => Promise<Project[]>;
+        [Symbol.asyncIterator]: () => AsyncGenerator<Project[], void, void>;
+    };
+    /**
+     * Get an existing Project. Retrieve information about an existing Project,
+     * specified by its Project ID. Its full details, including ID, name and
+     * description, are returned in the response object.
+     *
+     * @param request - The request {@link ProjectApiGetProjectRequest}
+     * @returns A Promise of Project
+     */
+    getProject: (request?: Readonly<ProjectApiGetProjectRequest>) => Promise<Project>;
+    /**
+     * Delete an existing Project. Delete an existing Project, specified by its
+     * Project ID. The Project needs to be empty (meaning there are no resources
+     * left in it) to be deleted effectively. Note that deleting a Project is
+     * permanent, and cannot be undone.
+     *
+     * @param request - The request {@link ProjectApiDeleteProjectRequest}
+     */
+    deleteProject: (request?: Readonly<ProjectApiDeleteProjectRequest>) => Promise<void>;
+    /**
+     * Update Project. Update the parameters of an existing Project, specified by
+     * its Project ID. These parameters include the name and description.
+     *
+     * @param request - The request {@link ProjectApiUpdateProjectRequest}
+     * @returns A Promise of Project
+     */
+    updateProject: (request?: Readonly<ProjectApiUpdateProjectRequest>) => Promise<Project>;
+}

package/dist/api/account/v3/api.gen.js

@@ -1,19 +1,10 @@
-import { API as API$1 } from '../../../scw/api.js';
-import { urlParams, validatePathParam } from '../../../helpers/marshalling.js';
-import { enrichForPagination } from '../../../scw/fetch/resource-paginator.js';
-import { marshalProjectApiCreateProjectRequest, unmarshalProject, unmarshalListProjectsResponse, marshalProjectApiUpdateProjectRequest } from './marshalling.gen.js';
-
-// This file was automatically generated. DO NOT EDIT.
-// If you have any remark or suggestion do not hesitate to open an issue.
+import { API as API$1 } from "../../../scw/api.js";
+import { urlParams, validatePathParam } from "../../../helpers/marshalling.js";
+import { enrichForPagination } from "../../../scw/fetch/resource-paginator.js";
+import { marshalProjectApiCreateProjectRequest, unmarshalProject, unmarshalListProjectsResponse, marshalProjectApiUpdateProjectRequest } from "./marshalling.gen.js";
 const jsonContentHeaders = {
-  'Content-Type': 'application/json; charset=utf-8'
+  "Content-Type": "application/json; charset=utf-8"
 };
-
-/**
- * Account API.
- *
- * This API allows you to manage projects.
- */
 class ProjectAPI extends API$1 {
   /**
    * Create a new Project for an Organization. Generate a new Project for an
@@ -22,18 +13,38 @@ class ProjectAPI extends API$1 {
    * @param request - The request {@link ProjectApiCreateProjectRequest}
    * @returns A Promise of Project
    */
-  createProject = request => this.client.fetch({
-    body: JSON.stringify(marshalProjectApiCreateProjectRequest(request, this.client.settings)),
-    headers: jsonContentHeaders,
-    method: 'POST',
-    path: `/account/v3/projects`
-  }, unmarshalProject);
-  pageOfListProjects = (request = {}) => this.client.fetch({
-    method: 'GET',
-    path: `/account/v3/projects`,
-    urlParams: urlParams(['name', request.name], ['order_by', request.orderBy], ['organization_id', request.organizationId ?? this.client.settings.defaultOrganizationId], ['page', request.page], ['page_size', request.pageSize ?? this.client.settings.defaultPageSize], ['project_ids', request.projectIds])
-  }, unmarshalListProjectsResponse);
-
+  createProject = (request) => this.client.fetch(
+    {
+      body: JSON.stringify(
+        marshalProjectApiCreateProjectRequest(request, this.client.settings)
+      ),
+      headers: jsonContentHeaders,
+      method: "POST",
+      path: `/account/v3/projects`
+    },
+    unmarshalProject
+  );
+  pageOfListProjects = (request = {}) => this.client.fetch(
+    {
+      method: "GET",
+      path: `/account/v3/projects`,
+      urlParams: urlParams(
+        ["name", request.name],
+        ["order_by", request.orderBy],
+        [
+          "organization_id",
+          request.organizationId ?? this.client.settings.defaultOrganizationId
+        ],
+        ["page", request.page],
+        [
+          "page_size",
+          request.pageSize ?? this.client.settings.defaultPageSize
+        ],
+        ["project_ids", request.projectIds]
+      )
+    },
+    unmarshalListProjectsResponse
+  );
   /**
    * List all Projects of an Organization. List all Projects of an Organization.
    * The response will include the total number of Projects as well as their
@@ -43,8 +54,7 @@ class ProjectAPI extends API$1 {
    * @param request - The request {@link ProjectApiListProjectsRequest}
    * @returns A Promise of ListProjectsResponse
    */
-  listProjects = (request = {}) => enrichForPagination('projects', this.pageOfListProjects, request);
-
+  listProjects = (request = {}) => enrichForPagination("projects", this.pageOfListProjects, request);
   /**
    * Get an existing Project. Retrieve information about an existing Project,
    * specified by its Project ID. Its full details, including ID, name and
@@ -53,11 +63,13 @@ class ProjectAPI extends API$1 {
    * @param request - The request {@link ProjectApiGetProjectRequest}
    * @returns A Promise of Project
    */
-  getProject = (request = {}) => this.client.fetch({
-    method: 'GET',
-    path: `/account/v3/projects/${validatePathParam('projectId', request.projectId ?? this.client.settings.defaultProjectId)}`
-  }, unmarshalProject);
-
+  getProject = (request = {}) => this.client.fetch(
+    {
+      method: "GET",
+      path: `/account/v3/projects/${validatePathParam("projectId", request.projectId ?? this.client.settings.defaultProjectId)}`
+    },
+    unmarshalProject
+  );
   /**
    * Delete an existing Project. Delete an existing Project, specified by its
    * Project ID. The Project needs to be empty (meaning there are no resources
@@ -67,10 +79,9 @@ class ProjectAPI extends API$1 {
    * @param request - The request {@link ProjectApiDeleteProjectRequest}
    */
   deleteProject = (request = {}) => this.client.fetch({
-    method: 'DELETE',
-    path: `/account/v3/projects/${validatePathParam('projectId', request.projectId ?? this.client.settings.defaultProjectId)}`
+    method: "DELETE",
+    path: `/account/v3/projects/${validatePathParam("projectId", request.projectId ?? this.client.settings.defaultProjectId)}`
   });
-
   /**
    * Update Project. Update the parameters of an existing Project, specified by
    * its Project ID. These parameters include the name and description.
@@ -78,12 +89,18 @@ class ProjectAPI extends API$1 {
    * @param request - The request {@link ProjectApiUpdateProjectRequest}
    * @returns A Promise of Project
    */
-  updateProject = (request = {}) => this.client.fetch({
-    body: JSON.stringify(marshalProjectApiUpdateProjectRequest(request, this.client.settings)),
-    headers: jsonContentHeaders,
-    method: 'PATCH',
-    path: `/account/v3/projects/${validatePathParam('projectId', request.projectId ?? this.client.settings.defaultProjectId)}`
-  }, unmarshalProject);
+  updateProject = (request = {}) => this.client.fetch(
+    {
+      body: JSON.stringify(
+        marshalProjectApiUpdateProjectRequest(request, this.client.settings)
+      ),
+      headers: jsonContentHeaders,
+      method: "PATCH",
+      path: `/account/v3/projects/${validatePathParam("projectId", request.projectId ?? this.client.settings.defaultProjectId)}`
+    },
+    unmarshalProject
+  );
 }
-
-export { ProjectAPI };
+export {
+  ProjectAPI
+};

package/dist/api/account/v3/index.gen.cjs

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const api_gen = require("./api.gen.cjs");
+const validationRules_gen = require("./validation-rules.gen.cjs");
+exports.ProjectAPI = api_gen.ProjectAPI;
+exports.ValidationRules = validationRules_gen;

package/dist/api/account/v3/index.gen.d.ts

@@ -0,0 +1,3 @@
+export { ProjectAPI } from './api.gen';
+export type { ListProjectsRequestOrderBy, ListProjectsResponse, Project, ProjectApiCreateProjectRequest, ProjectApiDeleteProjectRequest, ProjectApiGetProjectRequest, ProjectApiListProjectsRequest, ProjectApiUpdateProjectRequest, } from './types.gen';
+export * as ValidationRules from './validation-rules.gen';

package/dist/api/account/v3/index.gen.js

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

package/dist/api/account/v3/marshalling.gen.cjs

@@ -0,0 +1,44 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const randomName = require("@scaleway/random-name");
+const json = require("../../../helpers/json.cjs");
+const marshalling = require("../../../helpers/marshalling.cjs");
+const unmarshalProject = (data) => {
+  if (!json.isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'Project' failed as data isn't a dictionary.`
+    );
+  }
+  return {
+    createdAt: marshalling.unmarshalDate(data.created_at),
+    description: data.description,
+    id: data.id,
+    name: data.name,
+    organizationId: data.organization_id,
+    updatedAt: marshalling.unmarshalDate(data.updated_at)
+  };
+};
+const unmarshalListProjectsResponse = (data) => {
+  if (!json.isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'ListProjectsResponse' failed as data isn't a dictionary.`
+    );
+  }
+  return {
+    projects: marshalling.unmarshalArrayOfObject(data.projects, unmarshalProject),
+    totalCount: data.total_count
+  };
+};
+const marshalProjectApiCreateProjectRequest = (request, defaults) => ({
+  description: request.description,
+  name: request.name || randomName("proj"),
+  organization_id: request.organizationId ?? defaults.defaultOrganizationId
+});
+const marshalProjectApiUpdateProjectRequest = (request, defaults) => ({
+  description: request.description,
+  name: request.name
+});
+exports.marshalProjectApiCreateProjectRequest = marshalProjectApiCreateProjectRequest;
+exports.marshalProjectApiUpdateProjectRequest = marshalProjectApiUpdateProjectRequest;
+exports.unmarshalListProjectsResponse = unmarshalListProjectsResponse;
+exports.unmarshalProject = unmarshalProject;

package/dist/api/account/v3/marshalling.gen.d.ts

@@ -0,0 +1,6 @@
+import type { DefaultValues } from '../../../bridge';
+import type { ListProjectsResponse, Project, ProjectApiCreateProjectRequest, ProjectApiUpdateProjectRequest } from './types.gen';
+export declare const unmarshalProject: (data: unknown) => Project;
+export declare const unmarshalListProjectsResponse: (data: unknown) => ListProjectsResponse;
+export declare const marshalProjectApiCreateProjectRequest: (request: ProjectApiCreateProjectRequest, defaults: DefaultValues) => Record<string, unknown>;
+export declare const marshalProjectApiUpdateProjectRequest: (request: ProjectApiUpdateProjectRequest, defaults: DefaultValues) => Record<string, unknown>;

package/dist/api/account/v3/marshalling.gen.js

@@ -1,12 +1,11 @@
-import randomName from '../../../node_modules/.pnpm/@scaleway_random-name@4.0.3/node_modules/@scaleway/random-name/dist/index.js';
-import { isJSONObject } from '../../../helpers/json.js';
-import { unmarshalDate, unmarshalArrayOfObject } from '../../../helpers/marshalling.js';
-
-// This file was automatically generated. DO NOT EDIT.
-// If you have any remark or suggestion do not hesitate to open an issue.
-const unmarshalProject = data => {
+import randomName from "@scaleway/random-name";
+import { isJSONObject } from "../../../helpers/json.js";
+import { unmarshalDate, unmarshalArrayOfObject } from "../../../helpers/marshalling.js";
+const unmarshalProject = (data) => {
   if (!isJSONObject(data)) {
-    throw new TypeError(`Unmarshalling the type 'Project' failed as data isn't a dictionary.`);
+    throw new TypeError(
+      `Unmarshalling the type 'Project' failed as data isn't a dictionary.`
+    );
   }
   return {
     createdAt: unmarshalDate(data.created_at),
@@ -17,9 +16,11 @@ const unmarshalProject = data => {
     updatedAt: unmarshalDate(data.updated_at)
   };
 };
-const unmarshalListProjectsResponse = data => {
+const unmarshalListProjectsResponse = (data) => {
   if (!isJSONObject(data)) {
-    throw new TypeError(`Unmarshalling the type 'ListProjectsResponse' failed as data isn't a dictionary.`);
+    throw new TypeError(
+      `Unmarshalling the type 'ListProjectsResponse' failed as data isn't a dictionary.`
+    );
   }
   return {
     projects: unmarshalArrayOfObject(data.projects, unmarshalProject),
@@ -28,12 +29,16 @@ const unmarshalListProjectsResponse = data => {
 };
 const marshalProjectApiCreateProjectRequest = (request, defaults) => ({
   description: request.description,
-  name: request.name || randomName('proj'),
+  name: request.name || randomName("proj"),
   organization_id: request.organizationId ?? defaults.defaultOrganizationId
 });
 const marshalProjectApiUpdateProjectRequest = (request, defaults) => ({
   description: request.description,
   name: request.name
 });
-
-export { marshalProjectApiCreateProjectRequest, marshalProjectApiUpdateProjectRequest, unmarshalListProjectsResponse, unmarshalProject };
+export {
+  marshalProjectApiCreateProjectRequest,
+  marshalProjectApiUpdateProjectRequest,
+  unmarshalListProjectsResponse,
+  unmarshalProject
+};

package/dist/api/account/v3/types.gen.d.ts

@@ -0,0 +1,62 @@
+export type ListProjectsRequestOrderBy = 'created_at_asc' | 'created_at_desc' | 'name_asc' | 'name_desc';
+export interface Project {
+    /** ID of the Project. */
+    id: string;
+    /** Name of the Project. */
+    name: string;
+    /** Organization ID of the Project. */
+    organizationId: string;
+    /** Creation date of the Project. */
+    createdAt?: Date;
+    /** Update date of the Project. */
+    updatedAt?: Date;
+    /** Description of the Project. */
+    description: string;
+}
+export interface ListProjectsResponse {
+    /** Total number of Projects. */
+    totalCount: number;
+    /** Paginated returned Projects. */
+    projects: Project[];
+}
+export type ProjectApiCreateProjectRequest = {
+    /** Name of the Project. */
+    name?: string;
+    /** Organization ID of the Project. */
+    organizationId?: string;
+    /** Description of the Project. */
+    description: string;
+};
+export type ProjectApiDeleteProjectRequest = {
+    /** Project ID of the Project. */
+    projectId?: string;
+};
+export type ProjectApiGetProjectRequest = {
+    /** Project ID of the Project. */
+    projectId?: string;
+};
+export type ProjectApiListProjectsRequest = {
+    /** Organization ID of the Project. */
+    organizationId?: string;
+    /** Name of the Project. */
+    name?: string;
+    /** Page number for the returned Projects. */
+    page?: number;
+    /** Maximum number of Project per page. */
+    pageSize?: number;
+    /** Sort order of the returned Projects. */
+    orderBy?: ListProjectsRequestOrderBy;
+    /**
+     * Project IDs to filter for. The results will be limited to any Projects with
+     * an ID in this array.
+     */
+    projectIds?: string[];
+};
+export type ProjectApiUpdateProjectRequest = {
+    /** Project ID of the Project. */
+    projectId?: string;
+    /** Name of the Project. */
+    name?: string;
+    /** Description of the Project. */
+    description?: string;
+};

package/dist/api/account/v3/validation-rules.gen.cjs

@@ -0,0 +1,39 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const ProjectApiCreateProjectRequest = {
+  description: {
+    maxLength: 200
+  },
+  name: {
+    maxLength: 64,
+    minLength: 1,
+    pattern: /^[a-zA-Z0-9\._\- ]+$/
+  }
+};
+const ProjectApiListProjectsRequest = {
+  name: {
+    maxLength: 64,
+    minLength: 1,
+    pattern: /^[a-zA-Z0-9\._\- ]+$/
+  },
+  page: {
+    greaterThan: 0
+  },
+  pageSize: {
+    greaterThanOrEqual: 1,
+    lessThanOrEqual: 100
+  }
+};
+const ProjectApiUpdateProjectRequest = {
+  description: {
+    maxLength: 200
+  },
+  name: {
+    maxLength: 64,
+    minLength: 1,
+    pattern: /^[a-zA-Z0-9\._\- ]+$/
+  }
+};
+exports.ProjectApiCreateProjectRequest = ProjectApiCreateProjectRequest;
+exports.ProjectApiListProjectsRequest = ProjectApiListProjectsRequest;
+exports.ProjectApiUpdateProjectRequest = ProjectApiUpdateProjectRequest;

package/dist/api/account/v3/validation-rules.gen.d.ts

@@ -0,0 +1,34 @@
+export declare const ProjectApiCreateProjectRequest: {
+    description: {
+        maxLength: number;
+    };
+    name: {
+        maxLength: number;
+        minLength: number;
+        pattern: RegExp;
+    };
+};
+export declare const ProjectApiListProjectsRequest: {
+    name: {
+        maxLength: number;
+        minLength: number;
+        pattern: RegExp;
+    };
+    page: {
+        greaterThan: number;
+    };
+    pageSize: {
+        greaterThanOrEqual: number;
+        lessThanOrEqual: number;
+    };
+};
+export declare const ProjectApiUpdateProjectRequest: {
+    description: {
+        maxLength: number;
+    };
+    name: {
+        maxLength: number;
+        minLength: number;
+        pattern: RegExp;
+    };
+};

package/dist/api/account/v3/validation-rules.gen.js

@@ -1,6 +1,3 @@
-// This file was automatically generated. DO NOT EDIT.
-// If you have any remark or suggestion do not hesitate to open an issue.
-
 const ProjectApiCreateProjectRequest = {
   description: {
     maxLength: 200
@@ -35,5 +32,8 @@ const ProjectApiUpdateProjectRequest = {
     pattern: /^[a-zA-Z0-9\._\- ]+$/
   }
 };
-
-export { ProjectApiCreateProjectRequest, ProjectApiListProjectsRequest, ProjectApiUpdateProjectRequest };
+export {
+  ProjectApiCreateProjectRequest,
+  ProjectApiListProjectsRequest,
+  ProjectApiUpdateProjectRequest
+};

package/dist/api/applesilicon/index.cjs

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

package/dist/api/applesilicon/index.d.ts

@@ -0,0 +1 @@
+export * as v1alpha1 from './v1alpha1/index.gen';

package/dist/api/applesilicon/index.js

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