@scaleway/sdk 2.72.0 → 2.73.0

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

@@ -44,8 +44,7 @@ class API extends API$1 {
    */
   listServers = (request = {}) => enrichForPagination("servers", this.pageOfListServers, request);
   /**
-   * Get a specific baremetal server. Get the server associated with the given
-   * ID.
+   * Get a specific baremetal server. Get the server associated with the given ID.
    *
    * @param request - The request {@link GetServerRequest}
    * @returns A Promise of Server
@@ -105,8 +104,7 @@ class API extends API$1 {
     unmarshalListSubscribableServerOptionsResponse
   );
   /**
-   * List subscribable server options. List subscribable options associated to
-   * the given server ID.
+   * List subscribable server options. List subscribable options associated to the given server ID.
    *
    * @param request - The request {@link ListSubscribableServerOptionsRequest}
    * @returns A Promise of ListSubscribableServerOptionsResponse
@@ -134,9 +132,7 @@ class API extends API$1 {
     unmarshalService
   );
   /**
-   * Create a baremetal server. Create a new baremetal server. The order return
-   * you a service ID to follow the provisionning status you could call
-   * GetService.
+   * Create a baremetal server. Create a new baremetal server. The order return you a service ID to follow the provisionning status you could call GetService.
    *
    * @param request - The request {@link CreateServerRequest}
    * @returns A Promise of Service
@@ -153,8 +149,7 @@ class API extends API$1 {
     unmarshalService
   );
   /**
-   * Subscribe storage server option. Subscribe storage option for the given
-   * server ID.
+   * Subscribe storage server option. Subscribe storage option for the given server ID.
    *
    * @param request - The request {@link SubscribeStorageOptionsRequest}
    * @returns A Promise of SubscribeStorageOptionsResponse
@@ -199,8 +194,7 @@ class API extends API$1 {
     unmarshalServer
   );
   /**
-   * Reboot a baremetal server. Reboot the server associated with the given ID,
-   * use boot param to reboot in rescue.
+   * Reboot a baremetal server. Reboot the server associated with the given ID, use boot param to reboot in rescue.
    *
    * @param request - The request {@link RebootServerRequest}
    */
@@ -344,8 +338,7 @@ class API extends API$1 {
    */
   listServices = (request = {}) => enrichForPagination("services", this.pageOfListServices, request);
   /**
-   * Install a baremetal server. Install an OS on the server associated with the
-   * given ID.
+   * Install a baremetal server. Install an OS on the server associated with the given ID.
    *
    * @param request - The request {@link InstallServerRequest}
    * @returns A Promise of ServerInstall
@@ -362,8 +355,7 @@ class API extends API$1 {
     unmarshalServerInstall
   );
   /**
-   * Get a specific server installation status. Get the server installation
-   * status associated with the given server ID.
+   * Get a specific server installation status. Get the server installation status associated with the given server ID.
    *
    * @param request - The request {@link GetServerInstallRequest}
    * @returns A Promise of ServerInstall
@@ -391,8 +383,7 @@ class API extends API$1 {
     options
   );
   /**
-   * Cancels the current (running) server installation. Cancels the current
-   * server installation associated with the given server ID.
+   * Cancels the current (running) server installation. Cancels the current server installation associated with the given server ID.
    *
    * @param request - The request {@link CancelServerInstallRequest}
    */
@@ -401,8 +392,7 @@ class API extends API$1 {
     path: `/dedibox/v1/zones/${validatePathParam("zone", request.zone ?? this.client.settings.defaultZone)}/servers/${validatePathParam("serverId", request.serverId)}/cancel-install`
   });
   /**
-   * Get server default partitioning. Get the server default partitioning schema
-   * associated with the given server ID and OS ID.
+   * Get server default partitioning. Get the server default partitioning schema associated with the given server ID and OS ID.
    *
    * @param request - The request {@link GetServerDefaultPartitioningRequest}
    * @returns A Promise of ServerDefaultPartitioning
@@ -415,13 +405,11 @@ class API extends API$1 {
     unmarshalServerDefaultPartitioning
   );
   /**
-   * Start BMC (Baseboard Management Controller) access for a given baremetal
-   * server. 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.
-   *
-   * @param request - The request {@link StartBMCAccessRequest}
-   */
+     * Start BMC (Baseboard Management Controller) access for a given baremetal server. 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.
+     *
+     * @param request - The request {@link StartBMCAccessRequest}
+     */
   startBMCAccess = (request) => this.client.fetch({
     body: JSON.stringify(
       marshalStartBMCAccessRequest(request, this.client.settings)
@@ -431,9 +419,7 @@ class API extends API$1 {
     path: `/dedibox/v1/zones/${validatePathParam("zone", request.zone ?? this.client.settings.defaultZone)}/servers/${validatePathParam("serverId", request.serverId)}/bmc-access`
   });
   /**
-   * Get BMC (Baseboard Management Controller) access for a given baremetal
-   * server. Get the BMC (Baseboard Management Controller) access associated
-   * with the given ID.
+   * Get BMC (Baseboard Management Controller) access for a given baremetal server. Get the BMC (Baseboard Management Controller) access associated with the given ID.
    *
    * @param request - The request {@link GetBMCAccessRequest}
    * @returns A Promise of BMCAccess
@@ -461,9 +447,7 @@ class API extends API$1 {
     options
   );
   /**
-   * Stop BMC (Baseboard Management Controller) access for a given baremetal
-   * server. Stop BMC (Baseboard Management Controller) access associated with
-   * the given ID.
+   * Stop BMC (Baseboard Management Controller) access for a given baremetal server. Stop BMC (Baseboard Management Controller) access associated with the given ID.
    *
    * @param request - The request {@link StopBMCAccessRequest}
    */
@@ -595,8 +579,7 @@ class API extends API$1 {
     unmarshalCreateFailoverIPsResponse
   );
   /**
-   * Attach failovers on baremetal server. Attach failovers on the server
-   * associated with the given ID.
+   * Attach failovers on baremetal server. Attach failovers on the server associated with the given ID.
    *
    * @param request - The request {@link AttachFailoverIPsRequest}
    */
@@ -609,8 +592,7 @@ class API extends API$1 {
     path: `/dedibox/v1/zones/${validatePathParam("zone", request.zone ?? this.client.settings.defaultZone)}/failover-ips/attach`
   });
   /**
-   * Detach failovers on baremetal server. Detach failovers on the server
-   * associated with the given ID.
+   * Detach failovers on baremetal server. Detach failovers on the server associated with the given ID.
    *
    * @param request - The request {@link DetachFailoverIPsRequest}
    */
@@ -695,8 +677,7 @@ class API extends API$1 {
    */
   listFailoverIPs = (request = {}) => enrichForPagination("failoverIps", this.pageOfListFailoverIPs, request);
   /**
-   * Get a specific baremetal server. Get the server associated with the given
-   * ID.
+   * Get a specific baremetal server. Get the server associated with the given ID.
    *
    * @param request - The request {@link GetFailoverIPRequest}
    * @returns A Promise of FailoverIP
@@ -749,8 +730,7 @@ class API extends API$1 {
     path: `/dedibox/v1/zones/${validatePathParam("zone", request.zone ?? this.client.settings.defaultZone)}/servers/${validatePathParam("serverId", request.serverId)}/update-raid`
   });
   /**
-   * Start in rescue baremetal server. Start in rescue the server associated
-   * with the given ID.
+   * Start in rescue baremetal server. Start in rescue the server associated with the given ID.
    *
    * @param request - The request {@link StartRescueRequest}
    * @returns A Promise of Rescue
@@ -780,8 +760,7 @@ class API extends API$1 {
     unmarshalRescue
   );
   /**
-   * Stop rescue on baremetal server. Stop rescue on the server associated with
-   * the given ID.
+   * Stop rescue on baremetal server. Stop rescue on the server associated with the given ID.
    *
    * @param request - The request {@link StopRescueRequest}
    */
@@ -865,13 +844,14 @@ class BillingAPI extends API$1 {
 }
 class IPv6BlockAPI extends API$1 {
   /**
-   * Get IPv6 block quota. Get IPv6 block quota with the given project ID. /48
-   * one per organization. /56 link to your number of server. /64 link to your
-   * number of failover IP.
-   *
-   * @param request - The request {@link IPv6BlockApiGetIPv6BlockQuotasRequest}
-   * @returns A Promise of GetIPv6BlockQuotasResponse
-   */
+     * Get IPv6 block quota. Get IPv6 block quota with the given project ID.
+  /48 one per organization.
+  /56 link to your number of server.
+  /64 link to your number of failover IP.
+     *
+     * @param request - The request {@link IPv6BlockApiGetIPv6BlockQuotasRequest}
+     * @returns A Promise of GetIPv6BlockQuotasResponse
+     */
   getIPv6BlockQuotas = (request = {}) => this.client.fetch(
     {
       method: "GET",
@@ -881,8 +861,7 @@ class IPv6BlockAPI extends API$1 {
     unmarshalGetIPv6BlockQuotasResponse
   );
   /**
-   * Create IPv6 block for baremetal server. Create IPv6 block associated with
-   * the given project ID.
+   * Create IPv6 block for baremetal server. Create IPv6 block associated with the given project ID.
    *
    * @param request - The request {@link IPv6BlockApiCreateIPv6BlockRequest}
    * @returns A Promise of IPv6Block
@@ -916,12 +895,12 @@ class IPv6BlockAPI extends API$1 {
     unmarshalIPv6Block
   );
   /**
-   * Update IPv6 block. Update DNS associated to IPv6 block. If DNS is used,
-   * minimum of 2 is necessary and maximum of 5 (no duplicate).
-   *
-   * @param request - The request {@link IPv6BlockApiUpdateIPv6BlockRequest}
-   * @returns A Promise of IPv6Block
-   */
+     * Update IPv6 block. Update DNS associated to IPv6 block.
+  If DNS is used, minimum of 2 is necessary and maximum of 5 (no duplicate).
+     *
+     * @param request - The request {@link IPv6BlockApiUpdateIPv6BlockRequest}
+     * @returns A Promise of IPv6Block
+     */
   updateIPv6Block = (request) => this.client.fetch(
     {
       body: JSON.stringify(
@@ -946,14 +925,13 @@ class IPv6BlockAPI extends API$1 {
     path: `/dedibox/v1/ipv6-blocks/${validatePathParam("blockId", request.blockId)}`
   });
   /**
-   * Create IPv6 block subnet. Create IPv6 block subnet for the given IP ID. /48
-   * could create subnet in /56 (quota link to your number of server). /56 could
-   * create subnet in /64 (quota link to your number of failover IP).
-   *
-   * @param request - The request
-   *   {@link IPv6BlockApiCreateIPv6BlockSubnetRequest}
-   * @returns A Promise of IPv6Block
-   */
+     * Create IPv6 block subnet. Create IPv6 block subnet for the given IP ID.
+  /48 could create subnet in /56 (quota link to your number of server).
+  /56 could create subnet in /64 (quota link to your number of failover IP).
+     *
+     * @param request - The request {@link IPv6BlockApiCreateIPv6BlockSubnetRequest}
+     * @returns A Promise of IPv6Block
+     */
   createIPv6BlockSubnet = (request) => this.client.fetch(
     {
       body: JSON.stringify(
@@ -969,11 +947,9 @@ class IPv6BlockAPI extends API$1 {
     unmarshalIPv6Block
   );
   /**
-   * List available IPv6 block subnets. List all available IPv6 block subnets
-   * for given IP ID.
+   * List available IPv6 block subnets. List all available IPv6 block subnets for given IP ID.
    *
-   * @param request - The request
-   *   {@link IPv6BlockApiListIPv6BlockSubnetsAvailableRequest}
+   * @param request - The request {@link IPv6BlockApiListIPv6BlockSubnetsAvailableRequest}
    * @returns A Promise of ListIPv6BlockSubnetsAvailableResponse
    */
   listIPv6BlockSubnetsAvailable = (request) => this.client.fetch(