@scaleway/sdk 0.1.0-beta.9 → 1.1.0

package/README.md

@@ -9,7 +9,7 @@ This SDK enables you to interact with Scaleway APIs.
 
 ## Getting Started
 
-You'll need a pair of access and secret keys to connect to Scaleway API. Please check the [documentation](https://www.scaleway.com/docs/console/my-project/how-to/generate-api-key) on how to retrieve them.
+You'll need a pair of access and secret keys to connect to Scaleway API. Please check the [documentation](https://www.scaleway.com/en/docs/console/my-project/how-to/generate-api-key/) on how to retrieve them.
 
 **A minimal setup** would look like this:
 

package/dist/api/account/index.js

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

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

@@ -1,4 +1,4 @@
-import { API } from '../../../scw/api.js';
+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 { marshalCreateProjectRequest, unmarshalProject, unmarshalListProjectsResponse, marshalUpdateProjectRequest } from './marshalling.gen.js';
@@ -7,73 +7,90 @@ import { marshalCreateProjectRequest, unmarshalProject, unmarshalListProjectsRes
 const jsonContentHeaders = {
   'Content-Type': 'application/json; charset=utf-8'
 };
+
 /**
  * Account API.
  *
  * This API allows you to manage projects.
  */
-
-class AccountV2GenAPI extends API {
+class API extends API$1 {
   constructor() {
     var _this;
-
     super(...arguments);
     _this = this;
-
+    /**
+     * Create project
+     *
+     * @param request - The request {@link CreateProjectRequest}
+     * @returns A Promise of Project
+     */
     this.createProject = request => this.client.fetch({
       body: JSON.stringify(marshalCreateProjectRequest(request, this.client.settings)),
       headers: jsonContentHeaders,
       method: 'POST',
       path: `/account/v2/projects`
     }, unmarshalProject);
-
     this.pageOfListProjects = function (request) {
       if (request === void 0) {
         request = {};
       }
-
       return _this.client.fetch({
         method: 'GET',
         path: `/account/v2/projects`,
-        urlParams: urlParams(['name', request.name], ['order_by', request.orderBy ?? 'created_at_asc'], ['organization_id', request.organizationId ?? _this.client.settings.defaultOrganizationId], ['page', request.page], ['page_size', request.pageSize ?? _this.client.settings.defaultPageSize])
+        urlParams: urlParams(['name', request.name], ['order_by', request.orderBy ?? 'created_at_asc'], ['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 projects
+     *
+     * @param request - The request {@link ListProjectsRequest}
+     * @returns A Promise of ListProjectsResponse
+     */
     this.listProjects = function (request) {
       if (request === void 0) {
         request = {};
       }
-
       return enrichForPagination('projects', _this.pageOfListProjects, request);
     };
-
+    /**
+     * Get project
+     *
+     * @param request - The request {@link GetProjectRequest}
+     * @returns A Promise of Project
+     */
     this.getProject = function (request) {
       if (request === void 0) {
         request = {};
       }
-
       return _this.client.fetch({
         method: 'GET',
         path: `/account/v2/projects/${validatePathParam('projectId', request.projectId ?? _this.client.settings.defaultProjectId)}`
       }, unmarshalProject);
     };
-
+    /**
+     * Delete project
+     *
+     * @param request - The request {@link DeleteProjectRequest}
+     */
     this.deleteProject = function (request) {
       if (request === void 0) {
         request = {};
       }
-
       return _this.client.fetch({
         method: 'DELETE',
         path: `/account/v2/projects/${validatePathParam('projectId', request.projectId ?? _this.client.settings.defaultProjectId)}`
       });
     };
-
+    /**
+     * Update project
+     *
+     * @param request - The request {@link UpdateProjectRequest}
+     * @returns A Promise of Project
+     */
     this.updateProject = function (request) {
       if (request === void 0) {
         request = {};
       }
-
       return _this.client.fetch({
         body: JSON.stringify(marshalUpdateProjectRequest(request, _this.client.settings)),
         headers: jsonContentHeaders,
@@ -82,7 +99,6 @@ class AccountV2GenAPI extends API {
       }, unmarshalProject);
     };
   }
-
 }
 
-export { AccountV2GenAPI };
+export { API };

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

@@ -0,0 +1,3 @@
+export { API } from './api.gen.js';
+
+// This file was automatically generated. DO NOT EDIT.

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

@@ -6,7 +6,6 @@ const unmarshalProject = data => {
   if (!isJSONObject(data)) {
     throw new TypeError(`Unmarshalling the type 'Project' failed as data isn't a dictionary.`);
   }
-
   return {
     createdAt: unmarshalDate(data.created_at),
     description: data.description,
@@ -20,7 +19,6 @@ const unmarshalListProjectsResponse = data => {
   if (!isJSONObject(data)) {
     throw new TypeError(`Unmarshalling the type 'ListProjectsResponse' failed as data isn't a dictionary.`);
   }
-
   return {
     projects: unmarshalArrayOfObject(data.projects, unmarshalProject),
     totalCount: data.total_count

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

@@ -1,4 +1,4 @@
-import { API } from '../../../scw/api.js';
+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 { unmarshalListSSHKeysResponse, marshalCreateSSHKeyRequest, unmarshalSSHKey, marshalUpdateSSHKeyRequest } from './marshalling.gen.js';
@@ -7,60 +7,79 @@ import { unmarshalListSSHKeysResponse, marshalCreateSSHKeyRequest, unmarshalSSHK
 const jsonContentHeaders = {
   'Content-Type': 'application/json; charset=utf-8'
 };
-/** Account API. */
 
-class AccountV2Alpha1GenAPI extends API {
+/** Account API. */
+class AccountV2Alpha1GenAPI extends API$1 {
   constructor() {
     var _this;
-
     super(...arguments);
     _this = this;
-
     this.pageOfListSSHKeys = function (request) {
       if (request === void 0) {
         request = {};
       }
-
       return _this.client.fetch({
         method: 'GET',
         path: `/account/v2alpha1/ssh-keys`,
         urlParams: urlParams(['name', request.name], ['order_by', request.orderBy ?? 'created_at_asc'], ['organization_id', request.organizationId ?? _this.client.settings.defaultOrganizationId], ['page', request.page], ['page_size', request.pageSize ?? _this.client.settings.defaultPageSize], ['project_id', request.projectId ?? _this.client.settings.defaultProjectId])
       }, unmarshalListSSHKeysResponse);
     };
-
+    /**
+     * List all SSH keys of your project
+     *
+     * @param request - The request {@link ListSSHKeysRequest}
+     * @returns A Promise of ListSSHKeysResponse
+     */
     this.listSSHKeys = function (request) {
       if (request === void 0) {
         request = {};
       }
-
       return enrichForPagination('sshKeys', _this.pageOfListSSHKeys, request);
     };
-
+    /**
+     * Add an SSH key to your project
+     *
+     * @param request - The request {@link CreateSSHKeyRequest}
+     * @returns A Promise of SSHKey
+     */
     this.createSSHKey = request => this.client.fetch({
       body: JSON.stringify(marshalCreateSSHKeyRequest(request, this.client.settings)),
       headers: jsonContentHeaders,
       method: 'POST',
       path: `/account/v2alpha1/ssh-keys`
     }, unmarshalSSHKey);
-
+    /**
+     * Get an SSH key from your project
+     *
+     * @param request - The request {@link GetSSHKeyRequest}
+     * @returns A Promise of SSHKey
+     */
     this.getSSHKey = request => this.client.fetch({
       method: 'GET',
       path: `/account/v2alpha1/ssh-key/${validatePathParam('sshKeyId', request.sshKeyId)}`
     }, unmarshalSSHKey);
-
+    /**
+     * Update an SSH key on your project
+     *
+     * @param request - The request {@link UpdateSSHKeyRequest}
+     * @returns A Promise of SSHKey
+     */
     this.updateSSHKey = request => this.client.fetch({
       body: JSON.stringify(marshalUpdateSSHKeyRequest(request, this.client.settings)),
       headers: jsonContentHeaders,
       method: 'PATCH',
       path: `/account/v2alpha1/ssh-key/${validatePathParam('sshKeyId', request.sshKeyId)}`
     }, unmarshalSSHKey);
-
+    /**
+     * Remove an SSH key from your project
+     *
+     * @param request - The request {@link DeleteSSHKeyRequest}
+     */
     this.deleteSSHKey = request => this.client.fetch({
       method: 'DELETE',
       path: `/account/v2alpha1/ssh-key/${validatePathParam('sshKeyId', request.sshKeyId)}`
     });
   }
-
 }
 
 export { AccountV2Alpha1GenAPI };

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

@@ -2,24 +2,20 @@ import { isJSONObject } from '../../../helpers/json.js';
 import { unmarshalDate, unmarshalArrayOfObject, resolveOneOf } from '../../../helpers/marshalling.js';
 
 // This file was automatically generated. DO NOT EDIT.
-
 const unmarshalSSHKeyCreationInfo = data => {
   if (!isJSONObject(data)) {
     throw new TypeError(`Unmarshalling the type 'SSHKeyCreationInfo' failed as data isn't a dictionary.`);
   }
-
   return {
     address: data.address,
     countryCode: data.country_code,
     userAgent: data.user_agent
   };
 };
-
 const unmarshalSSHKey = data => {
   if (!isJSONObject(data)) {
     throw new TypeError(`Unmarshalling the type 'SSHKey' failed as data isn't a dictionary.`);
   }
-
   return {
     createdAt: unmarshalDate(data.created_at),
     creationInfo: data.creation_info ? unmarshalSSHKeyCreationInfo(data.creation_info) : undefined,
@@ -36,7 +32,6 @@ const unmarshalListSSHKeysResponse = data => {
   if (!isJSONObject(data)) {
     throw new TypeError(`Unmarshalling the type 'ListSSHKeysResponse' failed as data isn't a dictionary.`);
   }
-
   return {
     sshKeys: unmarshalArrayOfObject(data.ssh_keys, unmarshalSSHKey),
     totalCount: data.total_count

package/dist/api/applesilicon/index.js

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

package/dist/api/applesilicon/v1alpha1/api.gen.js

@@ -1,5 +1,5 @@
 import { waitForResource } from '../../../internal/async/interval-retrier.js';
-import { API } from '../../../scw/api.js';
+import { API as API$1 } from '../../../scw/api.js';
 import { validatePathParam, urlParams } from '../../../helpers/marshalling.js';
 import { enrichForPagination } from '../../../scw/fetch/resource-paginator.js';
 import { SERVER_TRANSIENT_STATUSES } from './content.gen.js';
@@ -9,6 +9,7 @@ import { unmarshalListServerTypesResponse, unmarshalServerType, marshalCreateSer
 const jsonContentHeaders = {
   'Content-Type': 'application/json; charset=utf-8'
 };
+
 /**
  * Apple silicon.
  *
@@ -22,115 +23,167 @@ const jsonContentHeaders = {
  * Get set to explore, learn and build on a dedicated Mac mini M1 with more
  * performance and speed than you ever thought possible.
  *
- * _Apple silicon as a Service comes with a minimum allocation period of 24 hours_*.
+ * _Apple silicon as a Service comes with a minimum allocation period of 24
+ * hours_*.
  *
  * Mac mini and macOS are trademarks of Apple Inc., registered in the U.S. and
  * other countries and regions. IOS is a trademark or registered trademark of
  * Cisco in the U.S. and other countries and is used by Apple under license.
  * Scaleway is not affiliated with Apple Inc.
  */
-
-class ApplesiliconV1Alpha1GenAPI extends API {
+class API extends API$1 {
   constructor() {
     var _this;
-
     super(...arguments);
     _this = this;
-
+    /**
+     * List all server types technical details.
+     *
+     * @param request - The request {@link ListServerTypesRequest}
+     * @returns A Promise of ListServerTypesResponse
+     */
     this.listServerTypes = function (request) {
       if (request === void 0) {
         request = {};
       }
-
       return _this.client.fetch({
         method: 'GET',
         path: `/apple-silicon/v1alpha1/zones/${validatePathParam('zone', request.zone ?? _this.client.settings.defaultZone)}/server-types`
       }, unmarshalListServerTypesResponse);
     };
-
+    /**
+     * Get a server technical details.
+     *
+     * @param request - The request {@link GetServerTypeRequest}
+     * @returns A Promise of ServerType
+     */
     this.getServerType = request => this.client.fetch({
       method: 'GET',
       path: `/apple-silicon/v1alpha1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/server-type/${validatePathParam('serverType', request.serverType)}`
     }, unmarshalServerType);
-
+    /**
+     * Create a server.
+     *
+     * @param request - The request {@link CreateServerRequest}
+     * @returns A Promise of Server
+     */
     this.createServer = request => this.client.fetch({
       body: JSON.stringify(marshalCreateServerRequest(request, this.client.settings)),
       headers: jsonContentHeaders,
       method: 'POST',
       path: `/apple-silicon/v1alpha1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/servers`
     }, unmarshalServer);
-
     this.pageOfListServers = function (request) {
       if (request === void 0) {
         request = {};
       }
-
       return _this.client.fetch({
         method: 'GET',
         path: `/apple-silicon/v1alpha1/zones/${validatePathParam('zone', request.zone ?? _this.client.settings.defaultZone)}/servers`,
-        urlParams: urlParams(['order_by', request.orderBy ?? 'created_at_asc'], ['organization_id', request.organizationId ?? _this.client.settings.defaultOrganizationId], ['page', request.page], ['page_size', request.pageSize ?? _this.client.settings.defaultPageSize], ['project_id', request.projectId ?? _this.client.settings.defaultProjectId])
+        urlParams: urlParams(['order_by', request.orderBy ?? 'created_at_asc'], ['organization_id', request.organizationId], ['page', request.page], ['page_size', request.pageSize ?? _this.client.settings.defaultPageSize], ['project_id', request.projectId])
       }, unmarshalListServersResponse);
     };
-
+    /**
+     * List all servers.
+     *
+     * @param request - The request {@link ListServersRequest}
+     * @returns A Promise of ListServersResponse
+     */
     this.listServers = function (request) {
       if (request === void 0) {
         request = {};
       }
-
       return enrichForPagination('servers', _this.pageOfListServers, request);
     };
-
     this.pageOfListOS = function (request) {
       if (request === void 0) {
         request = {};
       }
-
       return _this.client.fetch({
         method: 'GET',
         path: `/apple-silicon/v1alpha1/zones/${validatePathParam('zone', request.zone ?? _this.client.settings.defaultZone)}/os`,
         urlParams: urlParams(['name', request.name], ['page', request.page], ['page_size', request.pageSize ?? _this.client.settings.defaultPageSize], ['server_type', request.serverType])
       }, unmarshalListOSResponse);
     };
-
+    /**
+     * List all Operating System (OS).
+     *
+     * @param request - The request {@link ListOSRequest}
+     * @returns A Promise of ListOSResponse
+     */
     this.listOS = function (request) {
       if (request === void 0) {
         request = {};
       }
-
       return enrichForPagination('os', _this.pageOfListOS, request);
     };
-
+    /**
+     * Get an Operating System (OS).
+     *
+     * @param request - The request {@link GetOSRequest}
+     * @returns A Promise of OS
+     */
     this.getOS = request => this.client.fetch({
       method: 'GET',
       path: `/apple-silicon/v1alpha1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/os/${validatePathParam('osId', request.osId)}`
     }, unmarshalOS);
-
+    /**
+     * Get a server.
+     *
+     * @param request - The request {@link GetServerRequest}
+     * @returns A Promise of Server
+     */
     this.getServer = request => this.client.fetch({
       method: 'GET',
       path: `/apple-silicon/v1alpha1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/servers/${validatePathParam('serverId', request.serverId)}`
     }, unmarshalServer);
-
+    /**
+     * Waits for {@link Server} to be in a final state.
+     *
+     * @param request - The request {@link GetServerRequest}
+     * @param options - The waiting options
+     * @returns A Promise of Server
+     */
     this.waitForServer = (request, options) => waitForResource((options == null ? void 0 : options.stop) ?? (res => Promise.resolve(!SERVER_TRANSIENT_STATUSES.includes(res.status))), this.getServer, request, options);
-
+    /**
+     * Update a server.
+     *
+     * @param request - The request {@link UpdateServerRequest}
+     * @returns A Promise of Server
+     */
     this.updateServer = request => this.client.fetch({
       body: JSON.stringify(marshalUpdateServerRequest(request, this.client.settings)),
       headers: jsonContentHeaders,
       method: 'PATCH',
       path: `/apple-silicon/v1alpha1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/servers/${validatePathParam('serverId', request.serverId)}`
     }, unmarshalServer);
-
+    /**
+     * Delete a server.
+     *
+     * @param request - The request {@link DeleteServerRequest}
+     */
     this.deleteServer = request => this.client.fetch({
       method: 'DELETE',
       path: `/apple-silicon/v1alpha1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/servers/${validatePathParam('serverId', request.serverId)}`
     });
-
+    /**
+     * Reboot a server.
+     *
+     * @param request - The request {@link RebootServerRequest}
+     * @returns A Promise of Server
+     */
     this.rebootServer = request => this.client.fetch({
       body: '{}',
       headers: jsonContentHeaders,
       method: 'POST',
       path: `/apple-silicon/v1alpha1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/servers/${validatePathParam('serverId', request.serverId)}/reboot`
     }, unmarshalServer);
-
+    /**
+     * Reinstall a server.
+     *
+     * @param request - The request {@link ReinstallServerRequest}
+     * @returns A Promise of Server
+     */
     this.reinstallServer = request => this.client.fetch({
       body: '{}',
       headers: jsonContentHeaders,
@@ -138,8 +191,8 @@ class ApplesiliconV1Alpha1GenAPI extends API {
       path: `/apple-silicon/v1alpha1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/servers/${validatePathParam('serverId', request.serverId)}/reinstall`
     }, unmarshalServer);
   }
-
 }
-ApplesiliconV1Alpha1GenAPI.LOCALITIES = ['fr-par-3'];
+/** Lists the available zones of the API. */
+API.LOCALITIES = ['fr-par-3'];
 
-export { ApplesiliconV1Alpha1GenAPI };
+export { API };

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

@@ -0,0 +1,4 @@
+export { API } from './api.gen.js';
+export { SERVER_TRANSIENT_STATUSES } from './content.gen.js';
+
+// This file was automatically generated. DO NOT EDIT.

package/dist/api/applesilicon/v1alpha1/marshalling.gen.js

@@ -1,47 +1,39 @@
-import randomName from '../../../node_modules/.pnpm/@scaleway_random-name@3.0.2/node_modules/@scaleway/random-name/dist/index.js';
+import randomName from '../../../node_modules/.pnpm/@scaleway_random-name@4.0.1/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.
-
 const unmarshalServerTypeCPU = data => {
   if (!isJSONObject(data)) {
     throw new TypeError(`Unmarshalling the type 'ServerTypeCPU' failed as data isn't a dictionary.`);
   }
-
   return {
     coreCount: data.core_count,
     name: data.name
   };
 };
-
 const unmarshalServerTypeDisk = data => {
   if (!isJSONObject(data)) {
     throw new TypeError(`Unmarshalling the type 'ServerTypeDisk' failed as data isn't a dictionary.`);
   }
-
   return {
     capacity: data.capacity,
     type: data.type
   };
 };
-
 const unmarshalServerTypeMemory = data => {
   if (!isJSONObject(data)) {
     throw new TypeError(`Unmarshalling the type 'ServerTypeMemory' failed as data isn't a dictionary.`);
   }
-
   return {
     capacity: data.capacity,
     type: data.type
   };
 };
-
 const unmarshalOS = data => {
   if (!isJSONObject(data)) {
     throw new TypeError(`Unmarshalling the type 'OS' failed as data isn't a dictionary.`);
   }
-
   return {
     compatibleServerTypes: data.compatible_server_types,
     id: data.id,
@@ -54,7 +46,6 @@ const unmarshalServer = data => {
   if (!isJSONObject(data)) {
     throw new TypeError(`Unmarshalling the type 'Server' failed as data isn't a dictionary.`);
   }
-
   return {
     createdAt: unmarshalDate(data.created_at),
     deletableAt: unmarshalDate(data.deletable_at),
@@ -74,7 +65,6 @@ const unmarshalServerType = data => {
   if (!isJSONObject(data)) {
     throw new TypeError(`Unmarshalling the type 'ServerType' failed as data isn't a dictionary.`);
   }
-
   return {
     cpu: data.cpu ? unmarshalServerTypeCPU(data.cpu) : undefined,
     disk: data.disk ? unmarshalServerTypeDisk(data.disk) : undefined,
@@ -88,7 +78,6 @@ const unmarshalListOSResponse = data => {
   if (!isJSONObject(data)) {
     throw new TypeError(`Unmarshalling the type 'ListOSResponse' failed as data isn't a dictionary.`);
   }
-
   return {
     os: unmarshalArrayOfObject(data.os, unmarshalOS),
     totalCount: data.total_count
@@ -98,7 +87,6 @@ const unmarshalListServerTypesResponse = data => {
   if (!isJSONObject(data)) {
     throw new TypeError(`Unmarshalling the type 'ListServerTypesResponse' failed as data isn't a dictionary.`);
   }
-
   return {
     serverTypes: unmarshalArrayOfObject(data.server_types, unmarshalServerType)
   };
@@ -107,7 +95,6 @@ const unmarshalListServersResponse = data => {
   if (!isJSONObject(data)) {
     throw new TypeError(`Unmarshalling the type 'ListServersResponse' failed as data isn't a dictionary.`);
   }
-
   return {
     servers: unmarshalArrayOfObject(data.servers, unmarshalServer),
     totalCount: data.total_count