@scaleway/sdk 2.72.0 → 2.73.0

package/dist/api/applesilicon/v1alpha1/api.gen.d.ts

@@ -3,32 +3,28 @@ import type { Zone as ScwZone, WaitForOptions } from '@scaleway/sdk-client';
 import type { ConnectivityDiagnostic, CreateServerRequest, DeleteServerRequest, GetConnectivityDiagnosticRequest, GetOSRequest, GetServerRequest, GetServerTypeRequest, ListOSRequest, ListOSResponse, ListServerPrivateNetworksResponse, ListServerTypesRequest, ListServerTypesResponse, ListServersRequest, ListServersResponse, OS, PrivateNetworkApiAddServerPrivateNetworkRequest, PrivateNetworkApiDeleteServerPrivateNetworkRequest, PrivateNetworkApiGetServerPrivateNetworkRequest, PrivateNetworkApiListServerPrivateNetworksRequest, PrivateNetworkApiSetServerPrivateNetworksRequest, RebootServerRequest, ReinstallServerRequest, Server, ServerPrivateNetwork, ServerType, SetServerPrivateNetworksResponse, StartConnectivityDiagnosticRequest, StartConnectivityDiagnosticResponse, UpdateServerRequest } from './types.gen';
 /**
  * Apple silicon API.
- *
- * This API allows you to manage your Apple silicon machines.
+
+This API allows you to manage your Apple silicon machines.
  */
 export declare class API extends ParentAPI {
     /** Lists the available zones of the API. */
     static readonly LOCALITIES: ScwZone[];
     /**
-     * List server types. List all technical details about Apple silicon server
-     * types available in the specified zone. Since there is only one Availability
-     * Zone for Apple silicon servers, the targeted value is `fr-par-3`.
+     * List server types. List all technical details about Apple silicon server types available in the specified zone. Since there is only one Availability Zone for Apple silicon servers, the targeted value is `fr-par-3`.
      *
      * @param request - The request {@link ListServerTypesRequest}
      * @returns A Promise of ListServerTypesResponse
      */
     listServerTypes: (request?: Readonly<ListServerTypesRequest>) => Promise<ListServerTypesResponse>;
     /**
-     * Get a server type. Get technical details (CPU, disk size etc.) of a server
-     * type.
+     * Get a server type. Get technical details (CPU, disk size etc.) of a server type.
      *
      * @param request - The request {@link GetServerTypeRequest}
      * @returns A Promise of ServerType
      */
     getServerType: (request: Readonly<GetServerTypeRequest>) => Promise<ServerType>;
     /**
-     * Create a server. Create a new server in the targeted zone, specifying its
-     * configuration including name and type.
+     * Create a server. Create a new server in the targeted zone, specifying its configuration including name and type.
      *
      * @param request - The request {@link CreateServerRequest}
      * @returns A Promise of Server
@@ -36,9 +32,7 @@ export declare class API extends ParentAPI {
     createServer: (request: Readonly<CreateServerRequest>) => Promise<Server>;
     protected pageOfListServers: (request?: Readonly<ListServersRequest>) => Promise<ListServersResponse>;
     /**
-     * List all servers. List all servers in the specified zone. By default,
-     * returned servers in the list are ordered by creation date in ascending
-     * order, though this can be modified via the `order_by` field.
+     * List all servers. List all servers in the specified zone. By default, returned servers in the list are ordered by creation date in ascending order, though this can be modified via the `order_by` field.
      *
      * @param request - The request {@link ListServersRequest}
      * @returns A Promise of ListServersResponse
@@ -49,9 +43,7 @@ export declare class API extends ParentAPI {
     };
     protected pageOfListOS: (request?: Readonly<ListOSRequest>) => Promise<ListOSResponse>;
     /**
-     * List all Operating Systems (OS). List all Operating Systems (OS). The
-     * response will include the total number of OS as well as their associated
-     * IDs, names and labels.
+     * List all Operating Systems (OS). List all Operating Systems (OS). The response will include the total number of OS as well as their associated IDs, names and labels.
      *
      * @param request - The request {@link ListOSRequest}
      * @returns A Promise of ListOSResponse
@@ -61,17 +53,14 @@ export declare class API extends ParentAPI {
         [Symbol.asyncIterator]: () => AsyncGenerator<OS[], void, void>;
     };
     /**
-     * Get an Operating System (OS). Get an Operating System (OS). The response
-     * will include the OS's unique ID as well as its name and label.
+     * Get an Operating System (OS). Get an Operating System (OS).  The response will include the OS's unique ID as well as its name and label.
      *
      * @param request - The request {@link GetOSRequest}
      * @returns A Promise of OS
      */
     getOS: (request: Readonly<GetOSRequest>) => Promise<OS>;
     /**
-     * Get a server. Retrieve information about an existing Apple silicon server,
-     * specified by its server ID. Its full details, including name, status and IP
-     * address, are returned in the response object.
+     * Get a server. Retrieve information about an existing Apple silicon server, specified by its server ID. Its full details, including name, status and IP address, are returned in the response object.
      *
      * @param request - The request {@link GetServerRequest}
      * @returns A Promise of Server
@@ -86,35 +75,27 @@ export declare class API extends ParentAPI {
      */
     waitForServer: (request: Readonly<GetServerRequest>, options?: Readonly<WaitForOptions<Server>>) => Promise<Server>;
     /**
-     * Update a server. Update the parameters of an existing Apple silicon server,
-     * specified by its server ID.
+     * Update a server. Update the parameters of an existing Apple silicon server, specified by its server ID.
      *
      * @param request - The request {@link UpdateServerRequest}
      * @returns A Promise of Server
      */
     updateServer: (request: Readonly<UpdateServerRequest>) => Promise<Server>;
     /**
-     * Delete a server. Delete an existing Apple silicon server, specified by its
-     * server ID. Deleting a server is permanent, and cannot be undone. Note that
-     * the minimum allocation period for Apple silicon-as-a-service is 24 hours,
-     * meaning you cannot delete your server prior to that.
+     * Delete a server. Delete an existing Apple silicon server, specified by its server ID. Deleting a server is permanent, and cannot be undone. Note that the minimum allocation period for Apple silicon-as-a-service is 24 hours, meaning you cannot delete your server prior to that.
      *
      * @param request - The request {@link DeleteServerRequest}
      */
     deleteServer: (request: Readonly<DeleteServerRequest>) => Promise<void>;
     /**
-     * Reboot a server. Reboot an existing Apple silicon server, specified by its
-     * server ID.
+     * Reboot a server. Reboot an existing Apple silicon server, specified by its server ID.
      *
      * @param request - The request {@link RebootServerRequest}
      * @returns A Promise of Server
      */
     rebootServer: (request: Readonly<RebootServerRequest>) => Promise<Server>;
     /**
-     * Reinstall a server. Reinstall an existing Apple silicon server (specified
-     * by its server ID) from a new image (OS). All the data on the disk is
-     * deleted and all configuration is reset to the defailt configuration values
-     * of the image (OS).
+     * Reinstall a server. Reinstall an existing Apple silicon server (specified by its server ID) from a new image (OS). All the data on the disk is deleted and all configuration is reset to the defailt configuration values of the image (OS).
      *
      * @param request - The request {@link ReinstallServerRequest}
      * @returns A Promise of Server
@@ -123,7 +104,9 @@ export declare class API extends ParentAPI {
     startConnectivityDiagnostic: (request: Readonly<StartConnectivityDiagnosticRequest>) => Promise<StartConnectivityDiagnosticResponse>;
     getConnectivityDiagnostic: (request: Readonly<GetConnectivityDiagnosticRequest>) => Promise<ConnectivityDiagnostic>;
 }
-/** Apple silicon - Private Networks API. */
+/**
+ * Apple silicon - Private Networks API.
+ */
 export declare class PrivateNetworkAPI extends ParentAPI {
     /** Lists the available zones of the API. */
     static readonly LOCALITIES: ScwZone[];
@@ -131,37 +114,30 @@ export declare class PrivateNetworkAPI extends ParentAPI {
     /**
      * Waits for {@link ServerPrivateNetwork} to be in a final state.
      *
-     * @param request - The request
-     *   {@link PrivateNetworkApiGetServerPrivateNetworkRequest}
+     * @param request - The request {@link PrivateNetworkApiGetServerPrivateNetworkRequest}
      * @param options - The waiting options
      * @returns A Promise of ServerPrivateNetwork
      */
     waitForServerPrivateNetwork: (request: Readonly<PrivateNetworkApiGetServerPrivateNetworkRequest>, options?: Readonly<WaitForOptions<ServerPrivateNetwork>>) => Promise<ServerPrivateNetwork>;
     /**
-     * Add a server to a Private Network. Add an Apple silicon server to a Private
-     * Network.
+     * Add a server to a Private Network. Add an Apple silicon 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. Configure multiple Private
-     * Networks on an Apple silicon server.
+     * Set multiple Private Networks on a server. Configure multiple Private Networks on an Apple silicon server.
      *
-     * @param request - The request
-     *   {@link PrivateNetworkApiSetServerPrivateNetworksRequest}
+     * @param request - The request {@link PrivateNetworkApiSetServerPrivateNetworksRequest}
      * @returns A Promise of SetServerPrivateNetworksResponse
      */
     setServerPrivateNetworks: (request: Readonly<PrivateNetworkApiSetServerPrivateNetworksRequest>) => Promise<SetServerPrivateNetworksResponse>;
     protected pageOfListServerPrivateNetworks: (request?: Readonly<PrivateNetworkApiListServerPrivateNetworksRequest>) => Promise<ListServerPrivateNetworksResponse>;
     /**
-     * List the Private Networks of a server. List the Private Networks of an
-     * Apple silicon server.
+     * List the Private Networks of a server. List the Private Networks of an Apple silicon server.
      *
-     * @param request - The request
-     *   {@link PrivateNetworkApiListServerPrivateNetworksRequest}
+     * @param request - The request {@link PrivateNetworkApiListServerPrivateNetworksRequest}
      * @returns A Promise of ListServerPrivateNetworksResponse
      */
     listServerPrivateNetworks: (request?: Readonly<PrivateNetworkApiListServerPrivateNetworksRequest>) => Promise<ListServerPrivateNetworksResponse> & {
@@ -171,8 +147,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/applesilicon/v1alpha1/api.gen.js

@@ -13,9 +13,7 @@ class API extends API$1 {
   /** Lists the available zones of the API. */
   static LOCALITIES = ["fr-par-3"];
   /**
-   * List server types. List all technical details about Apple silicon server
-   * types available in the specified zone. Since there is only one Availability
-   * Zone for Apple silicon servers, the targeted value is `fr-par-3`.
+   * List server types. List all technical details about Apple silicon server types available in the specified zone. Since there is only one Availability Zone for Apple silicon servers, the targeted value is `fr-par-3`.
    *
    * @param request - The request {@link ListServerTypesRequest}
    * @returns A Promise of ListServerTypesResponse
@@ -28,8 +26,7 @@ class API extends API$1 {
     unmarshalListServerTypesResponse
   );
   /**
-   * Get a server type. Get technical details (CPU, disk size etc.) of a server
-   * type.
+   * Get a server type. Get technical details (CPU, disk size etc.) of a server type.
    *
    * @param request - The request {@link GetServerTypeRequest}
    * @returns A Promise of ServerType
@@ -42,8 +39,7 @@ class API extends API$1 {
     unmarshalServerType
   );
   /**
-   * Create a server. Create a new server in the targeted zone, specifying its
-   * configuration including name and type.
+   * Create a server. Create a new server in the targeted zone, specifying its configuration including name and type.
    *
    * @param request - The request {@link CreateServerRequest}
    * @returns A Promise of Server
@@ -77,9 +73,7 @@ class API extends API$1 {
     unmarshalListServersResponse
   );
   /**
-   * List all servers. List all servers in the specified zone. By default,
-   * returned servers in the list are ordered by creation date in ascending
-   * order, though this can be modified via the `order_by` field.
+   * List all servers. List all servers in the specified zone. By default, returned servers in the list are ordered by creation date in ascending order, though this can be modified via the `order_by` field.
    *
    * @param request - The request {@link ListServersRequest}
    * @returns A Promise of ListServersResponse
@@ -102,17 +96,14 @@ class API extends API$1 {
     unmarshalListOSResponse
   );
   /**
-   * List all Operating Systems (OS). List all Operating Systems (OS). The
-   * response will include the total number of OS as well as their associated
-   * IDs, names and labels.
+   * List all Operating Systems (OS). List all Operating Systems (OS). The response will include the total number of OS as well as their associated IDs, names and labels.
    *
    * @param request - The request {@link ListOSRequest}
    * @returns A Promise of ListOSResponse
    */
   listOS = (request = {}) => enrichForPagination("os", this.pageOfListOS, request);
   /**
-   * Get an Operating System (OS). Get an Operating System (OS). The response
-   * will include the OS's unique ID as well as its name and label.
+   * Get an Operating System (OS). Get an Operating System (OS).  The response will include the OS's unique ID as well as its name and label.
    *
    * @param request - The request {@link GetOSRequest}
    * @returns A Promise of OS
@@ -125,9 +116,7 @@ class API extends API$1 {
     unmarshalOS
   );
   /**
-   * Get a server. Retrieve information about an existing Apple silicon server,
-   * specified by its server ID. Its full details, including name, status and IP
-   * address, are returned in the response object.
+   * Get a server. Retrieve information about an existing Apple silicon server, specified by its server ID. Its full details, including name, status and IP address, are returned in the response object.
    *
    * @param request - The request {@link GetServerRequest}
    * @returns A Promise of Server
@@ -155,8 +144,7 @@ class API extends API$1 {
     options
   );
   /**
-   * Update a server. Update the parameters of an existing Apple silicon server,
-   * specified by its server ID.
+   * Update a server. Update the parameters of an existing Apple silicon server, specified by its server ID.
    *
    * @param request - The request {@link UpdateServerRequest}
    * @returns A Promise of Server
@@ -173,10 +161,7 @@ class API extends API$1 {
     unmarshalServer
   );
   /**
-   * Delete a server. Delete an existing Apple silicon server, specified by its
-   * server ID. Deleting a server is permanent, and cannot be undone. Note that
-   * the minimum allocation period for Apple silicon-as-a-service is 24 hours,
-   * meaning you cannot delete your server prior to that.
+   * Delete a server. Delete an existing Apple silicon server, specified by its server ID. Deleting a server is permanent, and cannot be undone. Note that the minimum allocation period for Apple silicon-as-a-service is 24 hours, meaning you cannot delete your server prior to that.
    *
    * @param request - The request {@link DeleteServerRequest}
    */
@@ -185,8 +170,7 @@ class API extends API$1 {
     path: `/apple-silicon/v1alpha1/zones/${validatePathParam("zone", request.zone ?? this.client.settings.defaultZone)}/servers/${validatePathParam("serverId", request.serverId)}`
   });
   /**
-   * Reboot a server. Reboot an existing Apple silicon server, specified by its
-   * server ID.
+   * Reboot a server. Reboot an existing Apple silicon server, specified by its server ID.
    *
    * @param request - The request {@link RebootServerRequest}
    * @returns A Promise of Server
@@ -201,10 +185,7 @@ class API extends API$1 {
     unmarshalServer
   );
   /**
-   * Reinstall a server. Reinstall an existing Apple silicon server (specified
-   * by its server ID) from a new image (OS). All the data on the disk is
-   * deleted and all configuration is reset to the defailt configuration values
-   * of the image (OS).
+   * Reinstall a server. Reinstall an existing Apple silicon server (specified by its server ID) from a new image (OS). All the data on the disk is deleted and all configuration is reset to the defailt configuration values of the image (OS).
    *
    * @param request - The request {@link ReinstallServerRequest}
    * @returns A Promise of Server
@@ -255,8 +236,7 @@ class PrivateNetworkAPI extends API$1 {
   /**
    * Waits for {@link ServerPrivateNetwork} to be in a final state.
    *
-   * @param request - The request
-   *   {@link PrivateNetworkApiGetServerPrivateNetworkRequest}
+   * @param request - The request {@link PrivateNetworkApiGetServerPrivateNetworkRequest}
    * @param options - The waiting options
    * @returns A Promise of ServerPrivateNetwork
    */
@@ -271,11 +251,9 @@ class PrivateNetworkAPI extends API$1 {
     options
   );
   /**
-   * Add a server to a Private Network. Add an Apple silicon server to a Private
-   * Network.
+   * Add a server to a Private Network. Add an Apple silicon 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(
@@ -293,11 +271,9 @@ class PrivateNetworkAPI extends API$1 {
     unmarshalServerPrivateNetwork
   );
   /**
-   * Set multiple Private Networks on a server. Configure multiple Private
-   * Networks on an Apple silicon server.
+   * Set multiple Private Networks on a server. Configure multiple Private Networks on an Apple silicon server.
    *
-   * @param request - The request
-   *   {@link PrivateNetworkApiSetServerPrivateNetworksRequest}
+   * @param request - The request {@link PrivateNetworkApiSetServerPrivateNetworksRequest}
    * @returns A Promise of SetServerPrivateNetworksResponse
    */
   setServerPrivateNetworks = (request) => this.client.fetch(
@@ -335,11 +311,9 @@ class PrivateNetworkAPI extends API$1 {
     unmarshalListServerPrivateNetworksResponse
   );
   /**
-   * List the Private Networks of a server. List the Private Networks of an
-   * Apple silicon server.
+   * List the Private Networks of a server. List the Private Networks of an Apple silicon server.
    *
-   * @param request - The request
-   *   {@link PrivateNetworkApiListServerPrivateNetworksRequest}
+   * @param request - The request {@link PrivateNetworkApiListServerPrivateNetworksRequest}
    * @returns A Promise of ListServerPrivateNetworksResponse
    */
   listServerPrivateNetworks = (request = {}) => enrichForPagination(
@@ -350,8 +324,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",