@scaleway/sdk 2.72.0 → 2.73.0

package/dist/api/baremetal/v1/api.gen.d.ts

@@ -3,16 +3,15 @@ import type { Zone as ScwZone, WaitForOptions } from '@scaleway/sdk-client';
 import type { AddOptionServerRequest, BMCAccess, CreateServerRequest, DeleteOptionServerRequest, DeleteServerRequest, GetBMCAccessRequest, GetDefaultPartitioningSchemaRequest, GetOSRequest, GetOfferRequest, GetOptionRequest, GetServerMetricsRequest, GetServerMetricsResponse, GetServerRequest, IP, InstallServerRequest, ListOSRequest, ListOSResponse, ListOffersRequest, ListOffersResponse, ListOptionsRequest, ListOptionsResponse, ListServerEventsRequest, ListServerEventsResponse, ListServerPrivateNetworksResponse, ListServersRequest, ListServersResponse, ListSettingsRequest, ListSettingsResponse, MigrateServerToMonthlyOfferRequest, OS, Offer, Option, PrivateNetworkApiAddServerPrivateNetworkRequest, PrivateNetworkApiDeleteServerPrivateNetworkRequest, PrivateNetworkApiListServerPrivateNetworksRequest, PrivateNetworkApiSetServerPrivateNetworksRequest, RebootServerRequest, Schema, Server, ServerPrivateNetwork, SetServerPrivateNetworksResponse, Setting, StartBMCAccessRequest, StartServerRequest, StopBMCAccessRequest, StopServerRequest, UpdateIPRequest, UpdateServerRequest, UpdateSettingRequest, ValidatePartitioningSchemaRequest } from './types.gen';
 /**
  * Elastic Metal API.
- *
- * This API allows you to manage your Elastic Metal servers.
+
+This API allows you to manage your Elastic Metal servers.
  */
 export declare class API extends ParentAPI {
     /** Lists the available zones of the API. */
     static readonly LOCALITIES: ScwZone[];
     protected pageOfListServers: (request?: Readonly<ListServersRequest>) => Promise<ListServersResponse>;
     /**
-     * List Elastic Metal servers for an Organization. List Elastic Metal servers
-     * for a specific Organization.
+     * List Elastic Metal servers for an Organization. List Elastic Metal servers for a specific Organization.
      *
      * @param request - The request {@link ListServersRequest}
      * @returns A Promise of ListServersResponse
@@ -22,8 +21,7 @@ export declare class API extends ParentAPI {
         [Symbol.asyncIterator]: () => AsyncGenerator<Server[], void, void>;
     };
     /**
-     * Get a specific Elastic Metal server. Get full details of an existing
-     * Elastic Metal server associated with the ID.
+     * Get a specific Elastic Metal server. Get full details of an existing Elastic Metal server associated with the ID.
      *
      * @param request - The request {@link GetServerRequest}
      * @returns A Promise of Server
@@ -38,33 +36,28 @@ export declare class API extends ParentAPI {
      */
     waitForServer: (request: Readonly<GetServerRequest>, options?: Readonly<WaitForOptions<Server>>) => Promise<Server>;
     /**
-     * Create an Elastic Metal server. Create a new Elastic Metal server. Once the
-     * server is created, proceed with the [installation of an OS](#post-3e949e).
+     * Create an Elastic Metal server. Create a new Elastic Metal server. Once the server is created, proceed with the [installation of an OS](#post-3e949e).
      *
      * @param request - The request {@link CreateServerRequest}
      * @returns A Promise of Server
      */
     createServer: (request: Readonly<CreateServerRequest>) => Promise<Server>;
     /**
-     * Update an Elastic Metal server. Update the server associated with the ID.
-     * You can update parameters such as the server's name, tags and description.
-     * Any parameters left null in the request body are not updated.
+     * Update an Elastic Metal server. Update the server associated with the ID. You can update parameters such as the server's name, tags and description. Any parameters left null in the request body are not updated.
      *
      * @param request - The request {@link UpdateServerRequest}
      * @returns A Promise of Server
      */
     updateServer: (request: Readonly<UpdateServerRequest>) => Promise<Server>;
     /**
-     * Install an Elastic Metal server. Install an Operating System (OS) on the
-     * Elastic Metal server with a specific ID.
+     * Install an Elastic Metal server. Install an Operating System (OS) on the Elastic Metal server with a specific ID.
      *
      * @param request - The request {@link InstallServerRequest}
      * @returns A Promise of Server
      */
     installServer: (request: Readonly<InstallServerRequest>) => Promise<Server>;
     /**
-     * Return server metrics. Get the ping status of the server associated with
-     * the ID.
+     * Return server metrics. Get the ping status of the server associated with the ID.
      *
      * @param request - The request {@link GetServerMetricsRequest}
      * @returns A Promise of GetServerMetricsResponse
@@ -78,9 +71,7 @@ export declare class API extends ParentAPI {
      */
     deleteServer: (request: Readonly<DeleteServerRequest>) => Promise<Server>;
     /**
-     * Reboot an Elastic Metal server. Reboot the Elastic Metal server associated
-     * with the ID, use the `boot_type` `rescue` to reboot the server in rescue
-     * mode.
+     * Reboot an Elastic Metal server. Reboot the Elastic Metal server associated with the ID, use the `boot_type` `rescue` to reboot the server in rescue mode.
      *
      * @param request - The request {@link RebootServerRequest}
      * @returns A Promise of Server
@@ -94,9 +85,7 @@ export declare class API extends ParentAPI {
      */
     startServer: (request: Readonly<StartServerRequest>) => Promise<Server>;
     /**
-     * Stop an Elastic Metal server. Stop the server associated with the ID. The
-     * server remains allocated to your account and all data remains on the local
-     * storage of the server.
+     * Stop an Elastic Metal server. Stop the server associated with the ID. The server remains allocated to your account and all data remains on the local storage of the server.
      *
      * @param request - The request {@link StopServerRequest}
      * @returns A Promise of Server
@@ -104,8 +93,7 @@ export declare class API extends ParentAPI {
     stopServer: (request: Readonly<StopServerRequest>) => Promise<Server>;
     protected pageOfListServerEvents: (request: Readonly<ListServerEventsRequest>) => Promise<ListServerEventsResponse>;
     /**
-     * List server events. List event (i.e. start/stop/reboot) associated to the
-     * server ID.
+     * List server events. List event (i.e. start/stop/reboot) associated to the server ID.
      *
      * @param request - The request {@link ListServerEventsRequest}
      * @returns A Promise of ListServerEventsResponse
@@ -115,66 +103,50 @@ export declare class API extends ParentAPI {
         [Symbol.asyncIterator]: () => AsyncGenerator<import("./types.gen").ServerEvent[], void, void>;
     };
     /**
-     * Get default partitioning schema. Get the default partitioning schema for
-     * the given offer ID and OS ID.
+     * Get default partitioning schema. Get the default partitioning schema for the given offer ID and OS ID.
      *
      * @param request - The request {@link GetDefaultPartitioningSchemaRequest}
      * @returns A Promise of Schema
      */
     getDefaultPartitioningSchema: (request: Readonly<GetDefaultPartitioningSchemaRequest>) => Promise<Schema>;
     /**
-     * Validate client partitioning schema. Validate the incoming partitioning
-     * schema from a user before installing the server. Return default ErrorCode
-     * if invalid.
+     * Validate client partitioning schema. Validate the incoming partitioning schema from a user before installing the server. Return default ErrorCode if invalid.
      *
      * @param request - The request {@link ValidatePartitioningSchemaRequest}
      */
     validatePartitioningSchema: (request: Readonly<ValidatePartitioningSchemaRequest>) => Promise<void>;
     /**
-     * Start BMC access. Start BMC (Baseboard Management Controller) access
-     * associated with the 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 add the option
-     * https://developers.scaleway.com/en/products/baremetal/api/#post-b14abd.
-     * After adding the BMC option, you need to Get Remote Access to get the
-     * login/password
-     * https://developers.scaleway.com/en/products/baremetal/api/#get-cefc0f. Do
-     * not forget to delete the Option after use.
+     * Start BMC access. Start BMC (Baseboard Management Controller) access associated with the 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 add the option https://developers.scaleway.com/en/products/baremetal/api/#post-b14abd.
+  After adding the BMC option, you need to Get Remote Access to get the login/password https://developers.scaleway.com/en/products/baremetal/api/#get-cefc0f. Do not forget to delete the Option after use.
      *
      * @param request - The request {@link StartBMCAccessRequest}
      * @returns A Promise of BMCAccess
      */
     startBMCAccess: (request: Readonly<StartBMCAccessRequest>) => Promise<BMCAccess>;
     /**
-     * Get BMC access. Get the BMC (Baseboard Management Controller) access
-     * associated with the ID, including the URL and login information needed to
-     * connect.
+     * Get BMC access. Get the BMC (Baseboard Management Controller) access associated with the ID, including the URL and login information needed to connect.
      *
      * @param request - The request {@link GetBMCAccessRequest}
      * @returns A Promise of BMCAccess
      */
     getBMCAccess: (request: Readonly<GetBMCAccessRequest>) => Promise<BMCAccess>;
     /**
-     * Stop BMC access. Stop BMC (Baseboard Management Controller) access
-     * associated with the ID.
+     * Stop BMC access. Stop BMC (Baseboard Management Controller) access associated with the ID.
      *
      * @param request - The request {@link StopBMCAccessRequest}
      */
     stopBMCAccess: (request: Readonly<StopBMCAccessRequest>) => Promise<void>;
     /**
-     * Update IP. Configure the IP address associated with the server ID and IP
-     * ID. You can use this method to set a reverse DNS for an IP address.
+     * Update IP. Configure the IP address associated with the server ID and IP ID. You can use this method to set a reverse DNS for an IP address.
      *
      * @param request - The request {@link UpdateIPRequest}
      * @returns A Promise of IP
      */
     updateIP: (request: Readonly<UpdateIPRequest>) => Promise<IP>;
     /**
-     * Add server option. Add an option, such as Private Networks, to a specific
-     * server.
+     * Add server option. Add an option, such as Private Networks, to a specific server.
      *
      * @param request - The request {@link AddOptionServerRequest}
      * @returns A Promise of Server
@@ -250,8 +222,7 @@ export declare class API extends ParentAPI {
     updateSetting: (request: Readonly<UpdateSettingRequest>) => Promise<Setting>;
     protected pageOfListOS: (request?: Readonly<ListOSRequest>) => Promise<ListOSResponse>;
     /**
-     * List available OSes. List all OSes that are available for installation on
-     * Elastic Metal servers.
+     * List available OSes. List all OSes that are available for installation on Elastic Metal servers.
      *
      * @param request - The request {@link ListOSRequest}
      * @returns A Promise of ListOSResponse
@@ -268,23 +239,23 @@ export declare class API extends ParentAPI {
      */
     getOS: (request: Readonly<GetOSRequest>) => Promise<OS>;
 }
-/** Elastic Metal - Private Network API. */
+/**
+ * Elastic Metal - Private Network API.
+ */
 export declare class PrivateNetworkAPI extends ParentAPI {
     /** Lists the available zones of the API. */
     static readonly LOCALITIES: ScwZone[];
     /**
      * Add a server to a Private Network.
      *
-     * @param request - The request
-     *   {@link PrivateNetworkApiAddServerPrivateNetworkRequest}
+     * @param request - The request {@link PrivateNetworkApiAddServerPrivateNetworkRequest}
      * @returns A Promise of ServerPrivateNetwork
      */
     addServerPrivateNetwork: (request: Readonly<PrivateNetworkApiAddServerPrivateNetworkRequest>) => Promise<ServerPrivateNetwork>;
     /**
      * Set multiple Private Networks on a server.
      *
-     * @param request - The request
-     *   {@link PrivateNetworkApiSetServerPrivateNetworksRequest}
+     * @param request - The request {@link PrivateNetworkApiSetServerPrivateNetworksRequest}
      * @returns A Promise of SetServerPrivateNetworksResponse
      */
     setServerPrivateNetworks: (request: Readonly<PrivateNetworkApiSetServerPrivateNetworksRequest>) => Promise<SetServerPrivateNetworksResponse>;
@@ -292,8 +263,7 @@ export declare class PrivateNetworkAPI extends ParentAPI {
     /**
      * List the Private Networks of a server.
      *
-     * @param request - The request
-     *   {@link PrivateNetworkApiListServerPrivateNetworksRequest}
+     * @param request - The request {@link PrivateNetworkApiListServerPrivateNetworksRequest}
      * @returns A Promise of ListServerPrivateNetworksResponse
      */
     listServerPrivateNetworks: (request?: Readonly<PrivateNetworkApiListServerPrivateNetworksRequest>) => Promise<ListServerPrivateNetworksResponse> & {
@@ -303,8 +273,7 @@ export declare class PrivateNetworkAPI extends ParentAPI {
     /**
      * Delete a Private Network.
      *
-     * @param request - The request
-     *   {@link PrivateNetworkApiDeleteServerPrivateNetworkRequest}
+     * @param request - The request {@link PrivateNetworkApiDeleteServerPrivateNetworkRequest}
      */
     deleteServerPrivateNetwork: (request: Readonly<PrivateNetworkApiDeleteServerPrivateNetworkRequest>) => Promise<void>;
 }

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

@@ -41,16 +41,14 @@ class API extends API$1 {
     unmarshalListServersResponse
   );
   /**
-   * List Elastic Metal servers for an Organization. List Elastic Metal servers
-   * for a specific Organization.
+   * List Elastic Metal servers for an Organization. List Elastic Metal servers for a specific Organization.
    *
    * @param request - The request {@link ListServersRequest}
    * @returns A Promise of ListServersResponse
    */
   listServers = (request = {}) => enrichForPagination("servers", this.pageOfListServers, request);
   /**
-   * Get a specific Elastic Metal server. Get full details of an existing
-   * Elastic Metal server associated with the ID.
+   * Get a specific Elastic Metal server. Get full details of an existing Elastic Metal server associated with the ID.
    *
    * @param request - The request {@link GetServerRequest}
    * @returns A Promise of Server
@@ -78,8 +76,7 @@ class API extends API$1 {
     options
   );
   /**
-   * Create an Elastic Metal server. Create a new Elastic Metal server. Once the
-   * server is created, proceed with the [installation of an OS](#post-3e949e).
+   * Create an Elastic Metal server. Create a new Elastic Metal server. Once the server is created, proceed with the [installation of an OS](#post-3e949e).
    *
    * @param request - The request {@link CreateServerRequest}
    * @returns A Promise of Server
@@ -96,9 +93,7 @@ class API extends API$1 {
     unmarshalServer
   );
   /**
-   * Update an Elastic Metal server. Update the server associated with the ID.
-   * You can update parameters such as the server's name, tags and description.
-   * Any parameters left null in the request body are not updated.
+   * Update an Elastic Metal server. Update the server associated with the ID. You can update parameters such as the server's name, tags and description. Any parameters left null in the request body are not updated.
    *
    * @param request - The request {@link UpdateServerRequest}
    * @returns A Promise of Server
@@ -115,8 +110,7 @@ class API extends API$1 {
     unmarshalServer
   );
   /**
-   * Install an Elastic Metal server. Install an Operating System (OS) on the
-   * Elastic Metal server with a specific ID.
+   * Install an Elastic Metal server. Install an Operating System (OS) on the Elastic Metal server with a specific ID.
    *
    * @param request - The request {@link InstallServerRequest}
    * @returns A Promise of Server
@@ -133,8 +127,7 @@ class API extends API$1 {
     unmarshalServer
   );
   /**
-   * Return server metrics. Get the ping status of the server associated with
-   * the ID.
+   * Return server metrics. Get the ping status of the server associated with the ID.
    *
    * @param request - The request {@link GetServerMetricsRequest}
    * @returns A Promise of GetServerMetricsResponse
@@ -160,9 +153,7 @@ class API extends API$1 {
     unmarshalServer
   );
   /**
-   * Reboot an Elastic Metal server. Reboot the Elastic Metal server associated
-   * with the ID, use the `boot_type` `rescue` to reboot the server in rescue
-   * mode.
+   * Reboot an Elastic Metal server. Reboot the Elastic Metal server associated with the ID, use the `boot_type` `rescue` to reboot the server in rescue mode.
    *
    * @param request - The request {@link RebootServerRequest}
    * @returns A Promise of Server
@@ -196,9 +187,7 @@ class API extends API$1 {
     unmarshalServer
   );
   /**
-   * Stop an Elastic Metal server. Stop the server associated with the ID. The
-   * server remains allocated to your account and all data remains on the local
-   * storage of the server.
+   * Stop an Elastic Metal server. Stop the server associated with the ID. The server remains allocated to your account and all data remains on the local storage of the server.
    *
    * @param request - The request {@link StopServerRequest}
    * @returns A Promise of Server
@@ -228,16 +217,14 @@ class API extends API$1 {
     unmarshalListServerEventsResponse
   );
   /**
-   * List server events. List event (i.e. start/stop/reboot) associated to the
-   * server ID.
+   * List server events. List event (i.e. start/stop/reboot) associated to the server ID.
    *
    * @param request - The request {@link ListServerEventsRequest}
    * @returns A Promise of ListServerEventsResponse
    */
   listServerEvents = (request) => enrichForPagination("events", this.pageOfListServerEvents, request);
   /**
-   * Get default partitioning schema. Get the default partitioning schema for
-   * the given offer ID and OS ID.
+   * Get default partitioning schema. Get the default partitioning schema for the given offer ID and OS ID.
    *
    * @param request - The request {@link GetDefaultPartitioningSchemaRequest}
    * @returns A Promise of Schema
@@ -254,9 +241,7 @@ class API extends API$1 {
     unmarshalSchema
   );
   /**
-   * Validate client partitioning schema. Validate the incoming partitioning
-   * schema from a user before installing the server. Return default ErrorCode
-   * if invalid.
+   * Validate client partitioning schema. Validate the incoming partitioning schema from a user before installing the server. Return default ErrorCode if invalid.
    *
    * @param request - The request {@link ValidatePartitioningSchemaRequest}
    */
@@ -269,22 +254,14 @@ class API extends API$1 {
     path: `/baremetal/v1/zones/${validatePathParam("zone", request.zone ?? this.client.settings.defaultZone)}/partitioning-schemas/validate`
   });
   /**
-   * Start BMC access. Start BMC (Baseboard Management Controller) access
-   * associated with the 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 add the option
-   * https://developers.scaleway.com/en/products/baremetal/api/#post-b14abd.
-   * After adding the BMC option, you need to Get Remote Access to get the
-   * login/password
-   * https://developers.scaleway.com/en/products/baremetal/api/#get-cefc0f. Do
-   * not forget to delete the Option after use.
-   *
-   * @param request - The request {@link StartBMCAccessRequest}
-   * @returns A Promise of BMCAccess
-   */
+     * Start BMC access. Start BMC (Baseboard Management Controller) access associated with the 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 add the option https://developers.scaleway.com/en/products/baremetal/api/#post-b14abd.
+  After adding the BMC option, you need to Get Remote Access to get the login/password https://developers.scaleway.com/en/products/baremetal/api/#get-cefc0f. Do not forget to delete the Option after use.
+     *
+     * @param request - The request {@link StartBMCAccessRequest}
+     * @returns A Promise of BMCAccess
+     */
   startBMCAccess = (request) => this.client.fetch(
     {
       body: JSON.stringify(
@@ -297,9 +274,7 @@ class API extends API$1 {
     unmarshalBMCAccess
   );
   /**
-   * Get BMC access. Get the BMC (Baseboard Management Controller) access
-   * associated with the ID, including the URL and login information needed to
-   * connect.
+   * Get BMC access. Get the BMC (Baseboard Management Controller) access associated with the ID, including the URL and login information needed to connect.
    *
    * @param request - The request {@link GetBMCAccessRequest}
    * @returns A Promise of BMCAccess
@@ -312,8 +287,7 @@ class API extends API$1 {
     unmarshalBMCAccess
   );
   /**
-   * Stop BMC access. Stop BMC (Baseboard Management Controller) access
-   * associated with the ID.
+   * Stop BMC access. Stop BMC (Baseboard Management Controller) access associated with the ID.
    *
    * @param request - The request {@link StopBMCAccessRequest}
    */
@@ -322,8 +296,7 @@ class API extends API$1 {
     path: `/baremetal/v1/zones/${validatePathParam("zone", request.zone ?? this.client.settings.defaultZone)}/servers/${validatePathParam("serverId", request.serverId)}/bmc-access`
   });
   /**
-   * Update IP. Configure the IP address associated with the server ID and IP
-   * ID. You can use this method to set a reverse DNS for an IP address.
+   * Update IP. Configure the IP address associated with the server ID and IP ID. You can use this method to set a reverse DNS for an IP address.
    *
    * @param request - The request {@link UpdateIPRequest}
    * @returns A Promise of IP
@@ -340,8 +313,7 @@ class API extends API$1 {
     unmarshalIP
   );
   /**
-   * Add server option. Add an option, such as Private Networks, to a specific
-   * server.
+   * Add server option. Add an option, such as Private Networks, to a specific server.
    *
    * @param request - The request {@link AddOptionServerRequest}
    * @returns A Promise of Server
@@ -514,8 +486,7 @@ class API extends API$1 {
     unmarshalListOSResponse
   );
   /**
-   * List available OSes. List all OSes that are available for installation on
-   * Elastic Metal servers.
+   * List available OSes. List all OSes that are available for installation on Elastic Metal servers.
    *
    * @param request - The request {@link ListOSRequest}
    * @returns A Promise of ListOSResponse
@@ -541,8 +512,7 @@ class PrivateNetworkAPI extends API$1 {
   /**
    * Add a server to a Private Network.
    *
-   * @param request - The request
-   *   {@link PrivateNetworkApiAddServerPrivateNetworkRequest}
+   * @param request - The request {@link PrivateNetworkApiAddServerPrivateNetworkRequest}
    * @returns A Promise of ServerPrivateNetwork
    */
   addServerPrivateNetwork = (request) => this.client.fetch(
@@ -562,8 +532,7 @@ class PrivateNetworkAPI extends API$1 {
   /**
    * Set multiple Private Networks on a server.
    *
-   * @param request - The request
-   *   {@link PrivateNetworkApiSetServerPrivateNetworksRequest}
+   * @param request - The request {@link PrivateNetworkApiSetServerPrivateNetworksRequest}
    * @returns A Promise of SetServerPrivateNetworksResponse
    */
   setServerPrivateNetworks = (request) => this.client.fetch(
@@ -602,8 +571,7 @@ class PrivateNetworkAPI extends API$1 {
   /**
    * List the Private Networks of a server.
    *
-   * @param request - The request
-   *   {@link PrivateNetworkApiListServerPrivateNetworksRequest}
+   * @param request - The request {@link PrivateNetworkApiListServerPrivateNetworksRequest}
    * @returns A Promise of ListServerPrivateNetworksResponse
    */
   listServerPrivateNetworks = (request = {}) => enrichForPagination(
@@ -614,8 +582,7 @@ class PrivateNetworkAPI extends API$1 {
   /**
    * Delete a Private Network.
    *
-   * @param request - The request
-   *   {@link PrivateNetworkApiDeleteServerPrivateNetworkRequest}
+   * @param request - The request {@link PrivateNetworkApiDeleteServerPrivateNetworkRequest}
    */
   deleteServerPrivateNetwork = (request) => this.client.fetch({
     method: "DELETE",