@scaleway/sdk 1.0.0 → 1.1.0

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

@@ -18,6 +18,12 @@ class API extends API$1 {
     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,
@@ -34,12 +40,24 @@ class API extends API$1 {
         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 = {};
@@ -49,6 +67,11 @@ class API extends API$1 {
         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 = {};
@@ -58,6 +81,12 @@ class API extends API$1 {
         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 = {};

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

@@ -24,28 +24,57 @@ class AccountV2Alpha1GenAPI extends API$1 {
         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)}`

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

@@ -36,6 +36,12 @@ class API extends API$1 {
     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 = {};
@@ -45,10 +51,22 @@ class API extends API$1 {
         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,
@@ -62,9 +80,15 @@ class API extends API$1 {
       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 = {};
@@ -81,37 +105,85 @@ class API extends API$1 {
         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,
@@ -120,6 +192,7 @@ class API extends API$1 {
     }, unmarshalServer);
   }
 }
+/** Lists the available zones of the API. */
 API.LOCALITIES = ['fr-par-3'];
 
 export { API };

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

@@ -27,58 +27,127 @@ class API extends API$1 {
       return _this.client.fetch({
         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])
+        urlParams: urlParams(['name', request.name], ['option_id', request.optionId], ['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], ['status', request.status], ['tags', request.tags])
       }, unmarshalListServersResponse);
     };
+    /**
+     * List elastic metal servers for organization.
+     *
+     * @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);
     };
+    /**
+     * Get the server associated with the given ID.
+     *
+     * @param request - The request {@link GetServerRequest}
+     * @returns A Promise of Server
+     */
     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)}`
     }, 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);
+    /**
+     * Create a new elastic metal server. Once the server is created, you probably
+     * want to install an OS.
+     *
+     * @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: `/baremetal/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/servers`
     }, unmarshalServer);
+    /**
+     * Update the server associated with the given ID.
+     *
+     * @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: `/baremetal/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/servers/${validatePathParam('serverId', request.serverId)}`
     }, unmarshalServer);
+    /**
+     * Install an OS on the server associated with the given ID.
+     *
+     * @param request - The request {@link InstallServerRequest}
+     * @returns A Promise of Server
+     */
     this.installServer = request => this.client.fetch({
       body: JSON.stringify(marshalInstallServerRequest(request, this.client.settings)),
       headers: jsonContentHeaders,
       method: 'POST',
       path: `/baremetal/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/servers/${validatePathParam('serverId', request.serverId)}/install`
     }, unmarshalServer);
+    /**
+     * Give the ping status on the server associated with the given ID.
+     *
+     * @param request - The request {@link GetServerMetricsRequest}
+     * @returns A Promise of GetServerMetricsResponse
+     */
     this.getServerMetrics = request => this.client.fetch({
       method: 'GET',
       path: `/baremetal/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/servers/${validatePathParam('serverId', request.serverId)}/metrics`
     }, unmarshalGetServerMetricsResponse);
+    /**
+     * Delete the server associated with the given ID.
+     *
+     * @param request - The request {@link DeleteServerRequest}
+     * @returns A Promise of Server
+     */
     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)}`
     }, unmarshalServer);
+    /**
+     * Reboot the server associated with the given ID, use boot param to reboot in
+     * rescue.
+     *
+     * @param request - The request {@link RebootServerRequest}
+     * @returns A Promise of Server
+     */
     this.rebootServer = request => this.client.fetch({
       body: JSON.stringify(marshalRebootServerRequest(request, this.client.settings)),
       headers: jsonContentHeaders,
       method: 'POST',
       path: `/baremetal/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/servers/${validatePathParam('serverId', request.serverId)}/reboot`
     }, unmarshalServer);
+    /**
+     * Start the server associated with the given ID.
+     *
+     * @param request - The request {@link StartServerRequest}
+     * @returns A Promise of Server
+     */
     this.startServer = request => this.client.fetch({
       body: JSON.stringify(marshalStartServerRequest(request, this.client.settings)),
       headers: jsonContentHeaders,
       method: 'POST',
       path: `/baremetal/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/servers/${validatePathParam('serverId', request.serverId)}/start`
     }, unmarshalServer);
+    /**
+     * Stop the server associated with the given ID.
+     *
+     * @param request - The request {@link StopServerRequest}
+     * @returns A Promise of Server
+     */
     this.stopServer = request => this.client.fetch({
       body: '{}',
       headers: jsonContentHeaders,
@@ -90,33 +159,87 @@ class API extends API$1 {
       path: `/baremetal/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/servers/${validatePathParam('serverId', request.serverId)}/events`,
       urlParams: urlParams(['order_by', request.orderBy ?? 'created_at_asc'], ['page', request.page], ['page_size', request.pageSize ?? this.client.settings.defaultPageSize])
     }, unmarshalListServerEventsResponse);
+    /**
+     * List events associated to the given server ID.
+     *
+     * @param request - The request {@link ListServerEventsRequest}
+     * @returns A Promise of ListServerEventsResponse
+     */
     this.listServerEvents = request => enrichForPagination('events', this.pageOfListServerEvents, request);
+    /**
+     * Start BMC (Baseboard Management Controller) access associated with the
+     * given ID. The BMC (Baseboard Management Controller) access is available one
+     * hour after the installation of the server. You need first to create an
+     * option Remote Access. You will find the ID and the price with a call to
+     * listOffers
+     * (https://developers.scaleway.com/en/products/baremetal/api/#get-78db92).
+     * Then you can add the option
+     * https://developers.scaleway.com/en/products/baremetal/api/#post-b14abd. Do
+     * not forget to delete the Option. After start BMC, you need to Get Remote
+     * Access to get the login/password
+     * https://developers.scaleway.com/en/products/baremetal/api/#get-cefc0f.
+     *
+     * @param request - The request {@link StartBMCAccessRequest}
+     * @returns A Promise of BMCAccess
+     */
     this.startBMCAccess = request => this.client.fetch({
       body: JSON.stringify(marshalStartBMCAccessRequest(request, this.client.settings)),
       headers: jsonContentHeaders,
       method: 'POST',
       path: `/baremetal/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/servers/${validatePathParam('serverId', request.serverId)}/bmc-access`
     }, unmarshalBMCAccess);
+    /**
+     * Get the BMC (Baseboard Management Controller) access associated with the
+     * given ID.
+     *
+     * @param request - The request {@link GetBMCAccessRequest}
+     * @returns A Promise of BMCAccess
+     */
     this.getBMCAccess = request => this.client.fetch({
       method: 'GET',
       path: `/baremetal/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/servers/${validatePathParam('serverId', request.serverId)}/bmc-access`
     }, unmarshalBMCAccess);
+    /**
+     * Stop BMC (Baseboard Management Controller) access associated with the given
+     * ID.
+     *
+     * @param request - The request {@link StopBMCAccessRequest}
+     */
     this.stopBMCAccess = request => this.client.fetch({
       method: 'DELETE',
       path: `/baremetal/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/servers/${validatePathParam('serverId', request.serverId)}/bmc-access`
     });
+    /**
+     * Configure ip associated with the given server ID and ipID. You can use this
+     * method to set a reverse dns for an IP.
+     *
+     * @param request - The request {@link UpdateIPRequest}
+     * @returns A Promise of IP
+     */
     this.updateIP = request => this.client.fetch({
       body: JSON.stringify(marshalUpdateIPRequest(request, this.client.settings)),
       headers: jsonContentHeaders,
       method: 'PATCH',
       path: `/baremetal/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/servers/${validatePathParam('serverId', request.serverId)}/ips/${validatePathParam('ipId', request.ipId)}`
     }, unmarshalIP);
+    /**
+     * Add an option to a specific server.
+     *
+     * @param request - The request {@link AddOptionServerRequest}
+     * @returns A Promise of Server
+     */
     this.addOptionServer = request => this.client.fetch({
       body: JSON.stringify(marshalAddOptionServerRequest(request, this.client.settings)),
       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)}`
     }, unmarshalServer);
+    /**
+     * Delete an option from a specific server.
+     *
+     * @param request - The request {@link DeleteOptionServerRequest}
+     * @returns A Promise of Server
+     */
     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)}`
@@ -131,16 +254,34 @@ class API extends API$1 {
         urlParams: urlParams(['page', request.page], ['page_size', request.pageSize ?? _this.client.settings.defaultPageSize], ['subscription_period', request.subscriptionPeriod ?? 'unknown_subscription_period'])
       }, unmarshalListOffersResponse);
     };
+    /**
+     * List all available server offers.
+     *
+     * @param request - The request {@link ListOffersRequest}
+     * @returns A Promise of ListOffersResponse
+     */
     this.listOffers = function (request) {
       if (request === void 0) {
         request = {};
       }
       return enrichForPagination('offers', _this.pageOfListOffers, request);
     };
+    /**
+     * Return specific offer for the given ID.
+     *
+     * @param request - The request {@link GetOfferRequest}
+     * @returns A Promise of Offer
+     */
     this.getOffer = request => this.client.fetch({
       method: 'GET',
       path: `/baremetal/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/offers/${validatePathParam('offerId', request.offerId)}`
     }, unmarshalOffer);
+    /**
+     * Return specific option for the given ID.
+     *
+     * @param request - The request {@link GetOptionRequest}
+     * @returns A Promise of Option
+     */
     this.getOption = request => this.client.fetch({
       method: 'GET',
       path: `/baremetal/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/options/${validatePathParam('optionId', request.optionId)}`
@@ -155,6 +296,12 @@ class API extends API$1 {
         urlParams: urlParams(['name', request.name], ['offer_id', request.offerId], ['page', request.page], ['page_size', request.pageSize ?? _this.client.settings.defaultPageSize])
       }, unmarshalListOptionsResponse);
     };
+    /**
+     * List all options matching with filters.
+     *
+     * @param request - The request {@link ListOptionsRequest}
+     * @returns A Promise of ListOptionsResponse
+     */
     this.listOptions = function (request) {
       if (request === void 0) {
         request = {};
@@ -171,12 +318,24 @@ class API extends API$1 {
         urlParams: urlParams(['order_by', request.orderBy ?? 'created_at_asc'], ['page', request.page], ['page_size', request.pageSize ?? _this.client.settings.defaultPageSize], ['project_id', request.projectId ?? _this.client.settings.defaultProjectId])
       }, unmarshalListSettingsResponse);
     };
+    /**
+     * Return all settings for a project ID.
+     *
+     * @param request - The request {@link ListSettingsRequest}
+     * @returns A Promise of ListSettingsResponse
+     */
     this.listSettings = function (request) {
       if (request === void 0) {
         request = {};
       }
       return enrichForPagination('settings', _this.pageOfListSettings, request);
     };
+    /**
+     * Update a setting for a project ID (enable or disable).
+     *
+     * @param request - The request {@link UpdateSettingRequest}
+     * @returns A Promise of Setting
+     */
     this.updateSetting = request => this.client.fetch({
       body: JSON.stringify(marshalUpdateSettingRequest(request, this.client.settings)),
       headers: jsonContentHeaders,
@@ -193,12 +352,24 @@ class API extends API$1 {
         urlParams: urlParams(['offer_id', request.offerId], ['page', request.page], ['page_size', request.pageSize ?? _this.client.settings.defaultPageSize])
       }, unmarshalListOSResponse);
     };
+    /**
+     * List all available OS that can be install on an elastic metal server.
+     *
+     * @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);
     };
+    /**
+     * Return specific OS for the given ID.
+     *
+     * @param request - The request {@link GetOSRequest}
+     * @returns A Promise of OS
+     */
     this.getOS = request => this.client.fetch({
       method: 'GET',
       path: `/baremetal/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/os/${validatePathParam('osId', request.osId)}`
@@ -207,18 +378,33 @@ class API extends API$1 {
 }
 
 /** Elastic Metal Private Network API. */
+/** Lists the available zones of the API. */
 API.LOCALITIES = ['fr-par-1', 'fr-par-2', 'nl-ams-1'];
 class PrivateNetworkAPI extends API$1 {
   constructor() {
     var _this2;
     super(...arguments);
     _this2 = this;
+    /**
+     * Add a server to a private network
+     *
+     * @param request - The request
+     *   {@link PrivateNetworkApiAddServerPrivateNetworkRequest}
+     * @returns A Promise of ServerPrivateNetwork
+     */
     this.addServerPrivateNetwork = request => this.client.fetch({
       body: JSON.stringify(marshalPrivateNetworkApiAddServerPrivateNetworkRequest(request, this.client.settings)),
       headers: jsonContentHeaders,
       method: 'POST',
       path: `/baremetal/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/servers/${validatePathParam('serverId', request.serverId)}/private-networks`
     }, unmarshalServerPrivateNetwork);
+    /**
+     * Set multiple private networks on a server
+     *
+     * @param request - The request
+     *   {@link PrivateNetworkApiSetServerPrivateNetworksRequest}
+     * @returns A Promise of SetServerPrivateNetworksResponse
+     */
     this.setServerPrivateNetworks = request => this.client.fetch({
       body: JSON.stringify(marshalPrivateNetworkApiSetServerPrivateNetworksRequest(request, this.client.settings)),
       headers: jsonContentHeaders,
@@ -232,21 +418,35 @@ class PrivateNetworkAPI extends API$1 {
       return _this2.client.fetch({
         method: 'GET',
         path: `/baremetal/v1/zones/${validatePathParam('zone', request.zone ?? _this2.client.settings.defaultZone)}/server-private-networks`,
-        urlParams: urlParams(['order_by', request.orderBy ?? 'created_at_asc'], ['organization_id', request.organizationId ?? _this2.client.settings.defaultOrganizationId], ['page', request.page], ['page_size', request.pageSize ?? _this2.client.settings.defaultPageSize], ['private_network_id', request.privateNetworkId], ['project_id', request.projectId ?? _this2.client.settings.defaultProjectId], ['server_id', request.serverId])
+        urlParams: urlParams(['order_by', request.orderBy ?? 'created_at_asc'], ['organization_id', request.organizationId], ['page', request.page], ['page_size', request.pageSize ?? _this2.client.settings.defaultPageSize], ['private_network_id', request.privateNetworkId], ['project_id', request.projectId], ['server_id', request.serverId])
       }, unmarshalListServerPrivateNetworksResponse);
     };
+    /**
+     * List the private networks of a server
+     *
+     * @param request - The request
+     *   {@link PrivateNetworkApiListServerPrivateNetworksRequest}
+     * @returns A Promise of ListServerPrivateNetworksResponse
+     */
     this.listServerPrivateNetworks = function (request) {
       if (request === void 0) {
         request = {};
       }
       return enrichForPagination('serverPrivateNetworks', _this2.pageOfListServerPrivateNetworks, request);
     };
+    /**
+     * Delete a private network
+     *
+     * @param request - The request
+     *   {@link PrivateNetworkApiDeleteServerPrivateNetworkRequest}
+     */
     this.deleteServerPrivateNetwork = request => this.client.fetch({
       method: 'DELETE',
       path: `/baremetal/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/servers/${validatePathParam('serverId', request.serverId)}/private-networks/${validatePathParam('privateNetworkId', request.privateNetworkId)}`
     });
   }
 }
+/** Lists the available zones of the API. */
 PrivateNetworkAPI.LOCALITIES = ['fr-par-2'];
 
 export { API, PrivateNetworkAPI };

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

@@ -5,6 +5,13 @@ import { SERVER_INSTALL_TRANSIENT_STATUSES } from './content.gen.js';
 class BaremetalV1UtilsAPI extends API {
   constructor() {
     super(...arguments);
+    /**
+     * Waits for {@link ServerInstall} to be in a final state.
+     *
+     * @param request - The request {@link GetServerRequest}
+     * @param options - The waiting options
+     * @returns A Promise of ServerInstall
+     */
     this.waitForServerInstall = (request, options) => tryAtIntervals(async () => {
       const value = await this.getServer(request).then(server => {
         if (!server.install) {