@scaleway/sdk 2.72.0 → 2.73.0

package/dist/api/flexibleip/v1alpha1/api.gen.cjs

@@ -22,8 +22,7 @@ class API extends api.API {
     "pl-waw-3"
   ];
   /**
-   * Create a new flexible IP. Generate a new flexible IP within a given zone,
-   * specifying its configuration including Project ID and description.
+   * Create a new flexible IP. Generate a new flexible IP within a given zone, specifying its configuration including Project ID and description.
    *
    * @param request - The request {@link CreateFlexibleIPRequest}
    * @returns A Promise of FlexibleIP
@@ -40,9 +39,7 @@ class API extends api.API {
     marshalling_gen.unmarshalFlexibleIP
   );
   /**
-   * Get an existing flexible IP. Retrieve information about an existing
-   * flexible IP, specified by its ID and zone. Its full details, including
-   * Project ID, description and status, are returned in the response object.
+   * Get an existing flexible IP. Retrieve information about an existing flexible IP, specified by its ID and zone. Its full details, including Project ID, description and status, are returned in the response object.
    *
    * @param request - The request {@link GetFlexibleIPRequest}
    * @returns A Promise of FlexibleIP
@@ -97,9 +94,7 @@ class API extends api.API {
    */
   listFlexibleIPs = (request = {}) => resourcePaginator.enrichForPagination("flexibleIps", this.pageOfListFlexibleIPs, request);
   /**
-   * Update an existing flexible IP. Update the parameters of an existing
-   * flexible IP, specified by its ID and zone. These parameters include tags
-   * and description.
+   * Update an existing flexible IP. Update the parameters of an existing flexible IP, specified by its ID and zone. These parameters include tags and description.
    *
    * @param request - The request {@link UpdateFlexibleIPRequest}
    * @returns A Promise of FlexibleIP
@@ -116,9 +111,7 @@ class API extends api.API {
     marshalling_gen.unmarshalFlexibleIP
   );
   /**
-   * Delete an existing flexible IP. Delete an existing flexible IP, specified
-   * by its ID and zone. Note that deleting a flexible IP is permanent and
-   * cannot be undone.
+   * Delete an existing flexible IP. Delete an existing flexible IP, specified by its ID and zone. Note that deleting a flexible IP is permanent and cannot be undone.
    *
    * @param request - The request {@link DeleteFlexibleIPRequest}
    */
@@ -127,8 +120,7 @@ class API extends api.API {
     path: `/flexible-ip/v1alpha1/zones/${marshalling.validatePathParam("zone", request.zone ?? this.client.settings.defaultZone)}/fips/${marshalling.validatePathParam("fipId", request.fipId)}`
   });
   /**
-   * Attach an existing flexible IP to a server. Attach an existing flexible IP
-   * to a specified Elastic Metal server.
+   * Attach an existing flexible IP to a server. Attach an existing flexible IP to a specified Elastic Metal server.
    *
    * @param request - The request {@link AttachFlexibleIPRequest}
    * @returns A Promise of AttachFlexibleIPsResponse
@@ -145,8 +137,7 @@ class API extends api.API {
     marshalling_gen.unmarshalAttachFlexibleIPsResponse
   );
   /**
-   * Detach an existing flexible IP from a server. Detach an existing flexible
-   * IP from a specified Elastic Metal server.
+   * Detach an existing flexible IP from a server. Detach an existing flexible IP from a specified Elastic Metal server.
    *
    * @param request - The request {@link DetachFlexibleIPRequest}
    * @returns A Promise of DetachFlexibleIPsResponse
@@ -163,8 +154,7 @@ class API extends api.API {
     marshalling_gen.unmarshalDetachFlexibleIPsResponse
   );
   /**
-   * Generate a virtual MAC address on an existing flexible IP. Generate a
-   * virtual MAC (Media Access Control) address on an existing flexible IP.
+   * Generate a virtual MAC address on an existing flexible IP. Generate a virtual MAC (Media Access Control) address on an existing flexible IP.
    *
    * @param request - The request {@link GenerateMACAddrRequest}
    * @returns A Promise of FlexibleIP
@@ -181,9 +171,7 @@ class API extends api.API {
     marshalling_gen.unmarshalFlexibleIP
   );
   /**
-   * Duplicate a virtual MAC address to another flexible IP. Duplicate a virtual
-   * MAC address from a given flexible IP to another flexible IP attached to the
-   * same server.
+   * Duplicate a virtual MAC address to another flexible IP. Duplicate a virtual MAC address from a given flexible IP to another flexible IP attached to the same server.
    *
    * @param request - The request {@link DuplicateMACAddrRequest}
    * @returns A Promise of FlexibleIP
@@ -200,9 +188,7 @@ class API extends api.API {
     marshalling_gen.unmarshalFlexibleIP
   );
   /**
-   * Relocate an existing virtual MAC address to a different flexible IP.
-   * Relocate a virtual MAC (Media Access Control) address from an existing
-   * flexible IP to a different flexible IP.
+   * Relocate an existing virtual MAC address to a different flexible IP. Relocate a virtual MAC (Media Access Control) address from an existing flexible IP to a different flexible IP.
    *
    * @param request - The request {@link MoveMACAddrRequest}
    * @returns A Promise of FlexibleIP
@@ -219,8 +205,7 @@ class API extends api.API {
     marshalling_gen.unmarshalFlexibleIP
   );
   /**
-   * Detach a given virtual MAC address from an existing flexible IP. Detach a
-   * given MAC (Media Access Control) address from an existing flexible IP.
+   * Detach a given virtual MAC address from an existing flexible IP. Detach a given MAC (Media Access Control) address from an existing flexible IP.
    *
    * @param request - The request {@link DeleteMACAddrRequest}
    */

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

@@ -3,25 +3,21 @@ import type { Zone as ScwZone, WaitForOptions } from '@scaleway/sdk-client';
 import type { AttachFlexibleIPRequest, AttachFlexibleIPsResponse, CreateFlexibleIPRequest, DeleteFlexibleIPRequest, DeleteMACAddrRequest, DetachFlexibleIPRequest, DetachFlexibleIPsResponse, DuplicateMACAddrRequest, FlexibleIP, GenerateMACAddrRequest, GetFlexibleIPRequest, ListFlexibleIPsRequest, ListFlexibleIPsResponse, MoveMACAddrRequest, UpdateFlexibleIPRequest } from './types.gen';
 /**
  * Elastic Metal - Flexible IP API.
- *
- * This API allows you to manage your Elastic Metal servers' flexible public IP
- * addresses.
+
+This API allows you to manage your Elastic Metal servers' flexible public IP addresses.
  */
 export declare class API extends ParentAPI {
     /** Lists the available zones of the API. */
     static readonly LOCALITIES: ScwZone[];
     /**
-     * Create a new flexible IP. Generate a new flexible IP within a given zone,
-     * specifying its configuration including Project ID and description.
+     * Create a new flexible IP. Generate a new flexible IP within a given zone, specifying its configuration including Project ID and description.
      *
      * @param request - The request {@link CreateFlexibleIPRequest}
      * @returns A Promise of FlexibleIP
      */
     createFlexibleIP: (request: Readonly<CreateFlexibleIPRequest>) => Promise<FlexibleIP>;
     /**
-     * Get an existing flexible IP. Retrieve information about an existing
-     * flexible IP, specified by its ID and zone. Its full details, including
-     * Project ID, description and status, are returned in the response object.
+     * Get an existing flexible IP. Retrieve information about an existing flexible IP, specified by its ID and zone. Its full details, including Project ID, description and status, are returned in the response object.
      *
      * @param request - The request {@link GetFlexibleIPRequest}
      * @returns A Promise of FlexibleIP
@@ -47,67 +43,55 @@ export declare class API extends ParentAPI {
         [Symbol.asyncIterator]: () => AsyncGenerator<FlexibleIP[], void, void>;
     };
     /**
-     * Update an existing flexible IP. Update the parameters of an existing
-     * flexible IP, specified by its ID and zone. These parameters include tags
-     * and description.
+     * Update an existing flexible IP. Update the parameters of an existing flexible IP, specified by its ID and zone. These parameters include tags and description.
      *
      * @param request - The request {@link UpdateFlexibleIPRequest}
      * @returns A Promise of FlexibleIP
      */
     updateFlexibleIP: (request: Readonly<UpdateFlexibleIPRequest>) => Promise<FlexibleIP>;
     /**
-     * Delete an existing flexible IP. Delete an existing flexible IP, specified
-     * by its ID and zone. Note that deleting a flexible IP is permanent and
-     * cannot be undone.
+     * Delete an existing flexible IP. Delete an existing flexible IP, specified by its ID and zone. Note that deleting a flexible IP is permanent and cannot be undone.
      *
      * @param request - The request {@link DeleteFlexibleIPRequest}
      */
     deleteFlexibleIP: (request: Readonly<DeleteFlexibleIPRequest>) => Promise<void>;
     /**
-     * Attach an existing flexible IP to a server. Attach an existing flexible IP
-     * to a specified Elastic Metal server.
+     * Attach an existing flexible IP to a server. Attach an existing flexible IP to a specified Elastic Metal server.
      *
      * @param request - The request {@link AttachFlexibleIPRequest}
      * @returns A Promise of AttachFlexibleIPsResponse
      */
     attachFlexibleIP: (request: Readonly<AttachFlexibleIPRequest>) => Promise<AttachFlexibleIPsResponse>;
     /**
-     * Detach an existing flexible IP from a server. Detach an existing flexible
-     * IP from a specified Elastic Metal server.
+     * Detach an existing flexible IP from a server. Detach an existing flexible IP from a specified Elastic Metal server.
      *
      * @param request - The request {@link DetachFlexibleIPRequest}
      * @returns A Promise of DetachFlexibleIPsResponse
      */
     detachFlexibleIP: (request: Readonly<DetachFlexibleIPRequest>) => Promise<DetachFlexibleIPsResponse>;
     /**
-     * Generate a virtual MAC address on an existing flexible IP. Generate a
-     * virtual MAC (Media Access Control) address on an existing flexible IP.
+     * Generate a virtual MAC address on an existing flexible IP. Generate a virtual MAC (Media Access Control) address on an existing flexible IP.
      *
      * @param request - The request {@link GenerateMACAddrRequest}
      * @returns A Promise of FlexibleIP
      */
     generateMACAddr: (request: Readonly<GenerateMACAddrRequest>) => Promise<FlexibleIP>;
     /**
-     * Duplicate a virtual MAC address to another flexible IP. Duplicate a virtual
-     * MAC address from a given flexible IP to another flexible IP attached to the
-     * same server.
+     * Duplicate a virtual MAC address to another flexible IP. Duplicate a virtual MAC address from a given flexible IP to another flexible IP attached to the same server.
      *
      * @param request - The request {@link DuplicateMACAddrRequest}
      * @returns A Promise of FlexibleIP
      */
     duplicateMACAddr: (request: Readonly<DuplicateMACAddrRequest>) => Promise<FlexibleIP>;
     /**
-     * Relocate an existing virtual MAC address to a different flexible IP.
-     * Relocate a virtual MAC (Media Access Control) address from an existing
-     * flexible IP to a different flexible IP.
+     * Relocate an existing virtual MAC address to a different flexible IP. Relocate a virtual MAC (Media Access Control) address from an existing flexible IP to a different flexible IP.
      *
      * @param request - The request {@link MoveMACAddrRequest}
      * @returns A Promise of FlexibleIP
      */
     moveMACAddr: (request: Readonly<MoveMACAddrRequest>) => Promise<FlexibleIP>;
     /**
-     * Detach a given virtual MAC address from an existing flexible IP. Detach a
-     * given MAC (Media Access Control) address from an existing flexible IP.
+     * Detach a given virtual MAC address from an existing flexible IP. Detach a given MAC (Media Access Control) address from an existing flexible IP.
      *
      * @param request - The request {@link DeleteMACAddrRequest}
      */

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

@@ -20,8 +20,7 @@ class API extends API$1 {
     "pl-waw-3"
   ];
   /**
-   * Create a new flexible IP. Generate a new flexible IP within a given zone,
-   * specifying its configuration including Project ID and description.
+   * Create a new flexible IP. Generate a new flexible IP within a given zone, specifying its configuration including Project ID and description.
    *
    * @param request - The request {@link CreateFlexibleIPRequest}
    * @returns A Promise of FlexibleIP
@@ -38,9 +37,7 @@ class API extends API$1 {
     unmarshalFlexibleIP
   );
   /**
-   * Get an existing flexible IP. Retrieve information about an existing
-   * flexible IP, specified by its ID and zone. Its full details, including
-   * Project ID, description and status, are returned in the response object.
+   * Get an existing flexible IP. Retrieve information about an existing flexible IP, specified by its ID and zone. Its full details, including Project ID, description and status, are returned in the response object.
    *
    * @param request - The request {@link GetFlexibleIPRequest}
    * @returns A Promise of FlexibleIP
@@ -95,9 +92,7 @@ class API extends API$1 {
    */
   listFlexibleIPs = (request = {}) => enrichForPagination("flexibleIps", this.pageOfListFlexibleIPs, request);
   /**
-   * Update an existing flexible IP. Update the parameters of an existing
-   * flexible IP, specified by its ID and zone. These parameters include tags
-   * and description.
+   * Update an existing flexible IP. Update the parameters of an existing flexible IP, specified by its ID and zone. These parameters include tags and description.
    *
    * @param request - The request {@link UpdateFlexibleIPRequest}
    * @returns A Promise of FlexibleIP
@@ -114,9 +109,7 @@ class API extends API$1 {
     unmarshalFlexibleIP
   );
   /**
-   * Delete an existing flexible IP. Delete an existing flexible IP, specified
-   * by its ID and zone. Note that deleting a flexible IP is permanent and
-   * cannot be undone.
+   * Delete an existing flexible IP. Delete an existing flexible IP, specified by its ID and zone. Note that deleting a flexible IP is permanent and cannot be undone.
    *
    * @param request - The request {@link DeleteFlexibleIPRequest}
    */
@@ -125,8 +118,7 @@ class API extends API$1 {
     path: `/flexible-ip/v1alpha1/zones/${validatePathParam("zone", request.zone ?? this.client.settings.defaultZone)}/fips/${validatePathParam("fipId", request.fipId)}`
   });
   /**
-   * Attach an existing flexible IP to a server. Attach an existing flexible IP
-   * to a specified Elastic Metal server.
+   * Attach an existing flexible IP to a server. Attach an existing flexible IP to a specified Elastic Metal server.
    *
    * @param request - The request {@link AttachFlexibleIPRequest}
    * @returns A Promise of AttachFlexibleIPsResponse
@@ -143,8 +135,7 @@ class API extends API$1 {
     unmarshalAttachFlexibleIPsResponse
   );
   /**
-   * Detach an existing flexible IP from a server. Detach an existing flexible
-   * IP from a specified Elastic Metal server.
+   * Detach an existing flexible IP from a server. Detach an existing flexible IP from a specified Elastic Metal server.
    *
    * @param request - The request {@link DetachFlexibleIPRequest}
    * @returns A Promise of DetachFlexibleIPsResponse
@@ -161,8 +152,7 @@ class API extends API$1 {
     unmarshalDetachFlexibleIPsResponse
   );
   /**
-   * Generate a virtual MAC address on an existing flexible IP. Generate a
-   * virtual MAC (Media Access Control) address on an existing flexible IP.
+   * Generate a virtual MAC address on an existing flexible IP. Generate a virtual MAC (Media Access Control) address on an existing flexible IP.
    *
    * @param request - The request {@link GenerateMACAddrRequest}
    * @returns A Promise of FlexibleIP
@@ -179,9 +169,7 @@ class API extends API$1 {
     unmarshalFlexibleIP
   );
   /**
-   * Duplicate a virtual MAC address to another flexible IP. Duplicate a virtual
-   * MAC address from a given flexible IP to another flexible IP attached to the
-   * same server.
+   * Duplicate a virtual MAC address to another flexible IP. Duplicate a virtual MAC address from a given flexible IP to another flexible IP attached to the same server.
    *
    * @param request - The request {@link DuplicateMACAddrRequest}
    * @returns A Promise of FlexibleIP
@@ -198,9 +186,7 @@ class API extends API$1 {
     unmarshalFlexibleIP
   );
   /**
-   * Relocate an existing virtual MAC address to a different flexible IP.
-   * Relocate a virtual MAC (Media Access Control) address from an existing
-   * flexible IP to a different flexible IP.
+   * Relocate an existing virtual MAC address to a different flexible IP. Relocate a virtual MAC (Media Access Control) address from an existing flexible IP to a different flexible IP.
    *
    * @param request - The request {@link MoveMACAddrRequest}
    * @returns A Promise of FlexibleIP
@@ -217,8 +203,7 @@ class API extends API$1 {
     unmarshalFlexibleIP
   );
   /**
-   * Detach a given virtual MAC address from an existing flexible IP. Detach a
-   * given MAC (Media Access Control) address from an existing flexible IP.
+   * Detach a given virtual MAC address from an existing flexible IP. Detach a given MAC (Media Access Control) address from an existing flexible IP.
    *
    * @param request - The request {@link DeleteMACAddrRequest}
    */