@scaleway/sdk 0.1.0-alpha.10 → 0.1.0-alpha.11

package/README.md

@@ -1,33 +1,16 @@
 # Scaleway SDK
 
-## ALPHA
-
-The project is in an **early alpha** phase.
-
-* The generated code as well as the distribution is subject to change (i.e. we might have one package per product).
-* The code will be available on GitHub once it enters beta.
-
-**List of available APIs:**
-
-|    **Name**   | **Version** |    **Class**    |
-|:-------------:|:-----------:|:---------------:|
-| Account       |   v2alpha1  |    AccountAPI   |
-| Apple Silicon |   v1alpha1  | ApplesiliconAPI |
-| Baremetal     |      v1     |   BaremetalAPI  |
-| Container     |   v1beta1   |   ContainerAPI  |
-| Domain        |   v2beta1   |    DomainAPI    |
-| Flexible IP   |   v1alpha1  |  FlexibleipAPI  |
-| Function      |   v1beta1   |   FunctionAPI   |
-| IOT           |      v1     |      IotAPI     |
-| K8S           |      v1     |      K8SAPI     |
-| LB            |      v1     |      LbAPI      |
-| Marketplace   |      v1     |  MarketplaceAPI |
-| RDB           |      v1     |      RdbAPI     |
-| Redis         |   v1alpha1  |     RedisAPI    |
-| Registry      |      v1     |   RegistryAPI   |
-| VPC           |      v1     |      VpcAPI     |
-| VPC Gateway   |      v1     |     VpcgwAPI    |
+Scaleway is a single way to create, deploy and scale your infrastructure in the cloud. This SDK enables you to interact with the APIs.
 
+**⚠️  The project is in alpha:**
+* Code is subject to breaking changes.
+* Sources will be available on GitHub once the SDK enters beta.
+* SDK only works from a server, browser calls aren't supported yet.
+
+**🔗  Important links:**
+* Reference documentation (soon)
+* Example projects (soon)
+* [Developers website](https://developers.scaleway.com) (API documentation)
 
 ## Getting Started
 
@@ -46,29 +29,52 @@ const client = createClient({
   defaultZone: 'fr-par-1',
 })
 
-const registryAPI = new RegistryAPI(client)
+const api = new RegistryAPI(client)
 ```
 
 **In case of a NodeJS environment**, you could retrieve the profile from either the configuration file or the environment variables:
 
 ```ts
-import { loadProfileFromConfigurationFile } from '@scaleway/configuration-loader'
-// import { loadProfileFromEnvironmentValues } from '@scaleway/configuration-loader'
+import { 
+  loadProfileFromConfigurationFile, 
+  // loadProfileFromEnvironmentValues,
+} from '@scaleway/configuration-loader'
 
-const profile = loadProfileFromConfigurationFile()
-// const profile = loadProfileFromEnvironmentValues()
+const profile = loadProfileFromConfigurationFile() // loadProfileFromEnvironmentValues()
 const client = createClient(profile)
 ```
 
 **For more advanced needs**, please check the examples.
 
-## Usage
+## Pagination
+
+We included some pagination helpers for the methods supporting the feature. Let's take `listNamespaces()` (Registry product) as an example:
+
+Retrieve the **first page**:
+
+```ts
+const namespaces = await api.listNamespaces(/*{ page: 1 }*/)
+```
+
+Retrieve **all the pages**:
+```ts
+const allNamespaces = await api.listNamespaces().all()
+```
+
+**Iterate** over the pages:
+```ts
+for await (const page of listNamespaces()) {
+  // 
+}
+```
+
+## Dependencies
 
 This SDK is based on the [fetch](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API) API and use `Request`, `Response` & `Headers` interfaces. Those interfaces are native in modern browsers, node >=18 & deno environments.
 
 For `node` < 18 & `React Native` environments, the commonJS build requires [cross-fetch](https://www.npmjs.com/package/cross-fetch) package, it is listed in `dependencies` but not used in esm build.
 
-## Troubleshooting
+**Troubleshooting**
 
 In node environment, the commonJS module defined in `dist/index.cjs` entry file is used by default, thanks to the "main" `package.json` field.
 

package/dist/api/baremetal/v1/api.gen.js

@@ -6,6 +6,8 @@ import { enrichForPagination } from '../../../scw/fetch/resource-paginator.js';
 
 const unmarshal0ECB = data => unmarshalAnyRes(data, [], ['created_at', 'updated_at']);
 
+const unmarshal23C1 = data => unmarshalAnyRes(data, [], ['created_at', 'expires_at', 'updated_at']);
+
 const unmarshal41B8 = data => unmarshalAnyRes(data, [], ['expires_at']);
 
 const jsonContentHeaders = {
@@ -22,14 +24,14 @@ class BaremetalV1GenAPI extends API {
       method: 'GET',
       path: `/baremetal/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/servers`,
       urlParams: urlParams(['name', request.name], ['option_id', request.optionId], ['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], ['status', request.status], ['tags', request.tags])
-    }, unmarshal0ECB);
+    }, unmarshal23C1);
 
     this.listServers = request => enrichForPagination('servers', this.pageOfListServers, request);
 
     this.getServer = request => this.client.fetch({
       method: 'GET',
       path: `/baremetal/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/servers/${validatePathParam('serverId', request.serverId)}`
-    }, unmarshal0ECB);
+    }, unmarshal23C1);
 
     this.createServer = request => {
       const projectIdentifier = resolveOneOf([{
@@ -54,7 +56,7 @@ class BaremetalV1GenAPI extends API {
         headers: jsonContentHeaders,
         method: 'POST',
         path: `/baremetal/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/servers`
-      }, unmarshal0ECB);
+      }, unmarshal23C1);
     };
 
     this.updateServer = request => this.client.fetch({
@@ -66,7 +68,7 @@ class BaremetalV1GenAPI extends API {
       headers: jsonContentHeaders,
       method: 'PATCH',
       path: `/baremetal/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/servers/${validatePathParam('serverId', request.serverId)}`
-    }, unmarshal0ECB);
+    }, unmarshal23C1);
 
     this.installServer = request => this.client.fetch({
       body: JSON.stringify({
@@ -81,7 +83,7 @@ class BaremetalV1GenAPI extends API {
       headers: jsonContentHeaders,
       method: 'POST',
       path: `/baremetal/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/servers/${validatePathParam('serverId', request.serverId)}/install`
-    }, unmarshal0ECB);
+    }, unmarshal23C1);
 
     this.getServerMetrics = request => this.client.fetch({
       method: 'GET',
@@ -91,7 +93,7 @@ class BaremetalV1GenAPI extends API {
     this.deleteServer = request => this.client.fetch({
       method: 'DELETE',
       path: `/baremetal/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/servers/${validatePathParam('serverId', request.serverId)}`
-    }, unmarshal0ECB);
+    }, unmarshal23C1);
 
     this.rebootServer = request => this.client.fetch({
       body: JSON.stringify({
@@ -100,7 +102,7 @@ class BaremetalV1GenAPI extends API {
       headers: jsonContentHeaders,
       method: 'POST',
       path: `/baremetal/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/servers/${validatePathParam('serverId', request.serverId)}/reboot`
-    }, unmarshal0ECB);
+    }, unmarshal23C1);
 
     this.startServer = request => this.client.fetch({
       body: JSON.stringify({
@@ -109,14 +111,14 @@ class BaremetalV1GenAPI extends API {
       headers: jsonContentHeaders,
       method: 'POST',
       path: `/baremetal/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/servers/${validatePathParam('serverId', request.serverId)}/start`
-    }, unmarshal0ECB);
+    }, unmarshal23C1);
 
     this.stopServer = request => this.client.fetch({
       body: '{}',
       headers: jsonContentHeaders,
       method: 'POST',
       path: `/baremetal/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/servers/${validatePathParam('serverId', request.serverId)}/stop`
-    }, unmarshal0ECB);
+    }, unmarshal23C1);
 
     this.pageOfListServerEvents = request => this.client.fetch({
       method: 'GET',
@@ -155,16 +157,18 @@ class BaremetalV1GenAPI extends API {
     }, unmarshalAnyRes);
 
     this.addOptionServer = request => this.client.fetch({
-      body: '{}',
+      body: JSON.stringify({
+        expires_at: request.expiresAt
+      }),
       headers: jsonContentHeaders,
       method: 'POST',
       path: `/baremetal/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/servers/${validatePathParam('serverId', request.serverId)}/options/${validatePathParam('optionId', request.optionId)}`
-    }, unmarshal0ECB);
+    }, unmarshal23C1);
 
     this.deleteOptionServer = request => this.client.fetch({
       method: 'DELETE',
       path: `/baremetal/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/servers/${validatePathParam('serverId', request.serverId)}/options/${validatePathParam('optionId', request.optionId)}`
-    }, unmarshal0ECB);
+    }, unmarshal23C1);
 
     this.pageOfListOffers = function (request) {
       if (request === void 0) {

package/dist/api/dedibox/v1/api.gen.js

@@ -4,6 +4,8 @@ import { enrichForPagination } from '../../../scw/fetch/resource-paginator.js';
 
 // This file was automatically generated. DO NOT EDIT.
 
+const unmarshal07B0 = data => unmarshalAnyRes(data, [], ['created_at']);
+
 const unmarshal3AEB = data => unmarshalAnyRes(data, [], ['created_at', 'expired_at', 'finished_at', 'rebooted_at', 'updated_at']);
 
 const unmarshal41B8 = data => unmarshalAnyRes(data, [], ['expires_at']);
@@ -617,22 +619,156 @@ class DediboxRpnV1GenAPI extends API {
   }
 
 }
-class DediboxRpnV2V1GenAPI extends API {
+class DediboxRpnV1V1GenAPI extends API {
   constructor() {
     var _this5;
 
     super(...arguments);
     _this5 = this;
 
-    this.pageOfListRpnV2Groups = function (request) {
+    this.pageOfListRpnGroups = function (request) {
       if (request === void 0) {
         request = {};
       }
 
       return _this5.client.fetch({
         method: 'GET',
-        path: `/dedibox/v1/rpnv2/groups`,
+        path: `/dedibox/v1/rpnv1/groups`,
+        urlParams: urlParams(['order_by', request.orderBy ?? 'created_at_asc'], ['page', request.page], ['page_size', request.pageSize ?? _this5.client.settings.defaultPageSize], ['project_id', request.projectId ?? _this5.client.settings.defaultProjectId])
+      }, unmarshal07B0);
+    };
+
+    this.listRpnGroups = function (request) {
+      if (request === void 0) {
+        request = {};
+      }
+
+      return enrichForPagination('rpnGroups', _this5.pageOfListRpnGroups, request);
+    };
+
+    this.getRpnGroup = request => this.client.fetch({
+      method: 'GET',
+      path: `/dedibox/v1/rpnv1/groups/${validatePathParam('groupId', request.groupId)}`
+    }, unmarshal07B0);
+
+    this.createRpnGroup = request => this.client.fetch({
+      body: JSON.stringify({
+        name: request.name,
+        project_id: request.projectId ?? this.client.settings.defaultProjectId,
+        san_server_ids: request.sanServerIds,
+        server_ids: request.serverIds
+      }),
+      headers: jsonContentHeaders,
+      method: 'POST',
+      path: `/dedibox/v1/rpnv1/groups`
+    }, unmarshal07B0);
+
+    this.deleteRpnGroup = request => this.client.fetch({
+      method: 'DELETE',
+      path: `/dedibox/v1/rpnv1/groups/${validatePathParam('groupId', request.groupId)}`
+    });
+
+    this.updateRpnGroupName = request => this.client.fetch({
+      body: JSON.stringify({
+        name: request.name
+      }),
+      headers: jsonContentHeaders,
+      method: 'PATCH',
+      path: `/dedibox/v1/rpnv1/groups/${validatePathParam('groupId', request.groupId)}`
+    }, unmarshal07B0);
+
+    this.pageOfListRpnGroupMembers = request => this.client.fetch({
+      method: 'GET',
+      path: `/dedibox/v1/rpnv1/groups/${validatePathParam('groupId', request.groupId)}/members`,
+      urlParams: urlParams(['order_by', request.orderBy ?? 'created_at_asc'], ['page', request.page], ['page_size', request.pageSize ?? this.client.settings.defaultPageSize], ['pending_invitations_only', request.pendingInvitationsOnly])
+    }, unmarshal847D);
+
+    this.listRpnGroupMembers = request => enrichForPagination('members', this.pageOfListRpnGroupMembers, request);
+
+    this.addRpnGroupMembers = request => this.client.fetch({
+      body: JSON.stringify({
+        san_server_ids: request.sanServerIds,
+        server_ids: request.serverIds
+      }),
+      headers: jsonContentHeaders,
+      method: 'POST',
+      path: `/dedibox/v1/rpnv1/groups/${validatePathParam('groupId', request.groupId)}/members`
+    }, unmarshal07B0);
+
+    this.deleteRpnGroupMembers = request => this.client.fetch({
+      method: 'DELETE',
+      path: `/dedibox/v1/rpnv1/groups/${validatePathParam('groupId', request.groupId)}/members`,
+      urlParams: urlParams(['members_ids', request.membersIds])
+    }, unmarshal07B0);
+
+    this.pageOfListRpnCapableServers = function (request) {
+      if (request === void 0) {
+        request = {};
+      }
+
+      return _this5.client.fetch({
+        method: 'GET',
+        path: `/dedibox/v1/rpnv1/capable-servers`,
+        urlParams: urlParams(['order_by', request.orderBy ?? 'created_at_asc'], ['page', request.page], ['page_size', request.pageSize ?? _this5.client.settings.defaultPageSize], ['project_id', request.projectId ?? _this5.client.settings.defaultProjectId])
+      }, unmarshal847D);
+    };
+
+    this.listRpnCapableServers = function (request) {
+      if (request === void 0) {
+        request = {};
+      }
+
+      return enrichForPagination('servers', _this5.pageOfListRpnCapableServers, request);
+    };
+
+    this.pageOfListRpnCapableSanServers = function (request) {
+      if (request === void 0) {
+        request = {};
+      }
+
+      return _this5.client.fetch({
+        method: 'GET',
+        path: `/dedibox/v1/rpnv1/capable-san-servers`,
         urlParams: urlParams(['order_by', request.orderBy ?? 'created_at_asc'], ['page', request.page], ['page_size', request.pageSize ?? _this5.client.settings.defaultPageSize], ['project_id', request.projectId ?? _this5.client.settings.defaultProjectId])
+      }, unmarshal07B0);
+    };
+
+    this.listRpnCapableSanServers = function (request) {
+      if (request === void 0) {
+        request = {};
+      }
+
+      return enrichForPagination('sanServers', _this5.pageOfListRpnCapableSanServers, request);
+    };
+
+    this.acceptRpnInvite = request => this.client.fetch({
+      method: 'POST',
+      path: `/dedibox/v1/rpnv1/invites/${validatePathParam('memberId', request.memberId)}/accept`
+    });
+
+    this.refuseRpnInvite = request => this.client.fetch({
+      method: 'POST',
+      path: `/dedibox/v1/rpnv1/invites/${validatePathParam('memberId', request.memberId)}/refuse`
+    });
+  }
+
+}
+class DediboxRpnV2V1GenAPI extends API {
+  constructor() {
+    var _this6;
+
+    super(...arguments);
+    _this6 = this;
+
+    this.pageOfListRpnV2Groups = function (request) {
+      if (request === void 0) {
+        request = {};
+      }
+
+      return _this6.client.fetch({
+        method: 'GET',
+        path: `/dedibox/v1/rpnv2/groups`,
+        urlParams: urlParams(['order_by', request.orderBy ?? 'created_at_asc'], ['page', request.page], ['page_size', request.pageSize ?? _this6.client.settings.defaultPageSize], ['project_id', request.projectId ?? _this6.client.settings.defaultProjectId])
       }, unmarshalAnyRes);
     };
 
@@ -641,7 +777,7 @@ class DediboxRpnV2V1GenAPI extends API {
         request = {};
       }
 
-      return enrichForPagination('rpnGroups', _this5.pageOfListRpnV2Groups, request);
+      return enrichForPagination('rpnGroups', _this6.pageOfListRpnV2Groups, request);
     };
 
     this.pageOfListRpnV2Members = request => this.client.fetch({
@@ -703,10 +839,10 @@ class DediboxRpnV2V1GenAPI extends API {
         request = {};
       }
 
-      return _this5.client.fetch({
+      return _this6.client.fetch({
         method: 'GET',
         path: `/dedibox/v1/rpnv2/groups/capable`,
-        urlParams: urlParams(['order_by', request.orderBy ?? 'created_at_asc'], ['page', request.page], ['page_size', request.pageSize ?? _this5.client.settings.defaultPageSize], ['project_id', request.projectId ?? _this5.client.settings.defaultProjectId])
+        urlParams: urlParams(['order_by', request.orderBy ?? 'created_at_asc'], ['page', request.page], ['page_size', request.pageSize ?? _this6.client.settings.defaultPageSize], ['project_id', request.projectId ?? _this6.client.settings.defaultProjectId])
       }, unmarshal847D);
     };
 
@@ -715,7 +851,7 @@ class DediboxRpnV2V1GenAPI extends API {
         request = {};
       }
 
-      return enrichForPagination('servers', _this5.pageOfListRpnV2CapableResources, request);
+      return enrichForPagination('servers', _this6.pageOfListRpnV2CapableResources, request);
     };
 
     this.pageOfListRpnV2GroupLogs = request => this.client.fetch({
@@ -754,4 +890,4 @@ class DediboxRpnV2V1GenAPI extends API {
 
 }
 
-export { DediboxBillingV1GenAPI, DediboxIPv6BlockV1GenAPI, DediboxRpnV1GenAPI, DediboxRpnV2V1GenAPI, DediboxV1GenAPI };
+export { DediboxBillingV1GenAPI, DediboxIPv6BlockV1GenAPI, DediboxRpnV1GenAPI, DediboxRpnV1V1GenAPI, DediboxRpnV2V1GenAPI, DediboxV1GenAPI };