@scaleway/sdk 1.2.0 → 1.5.0

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

@@ -11,9 +11,9 @@ const jsonContentHeaders = {
 };
 
 /**
- * Transactional Email API.
+ * Transactional Email API documentation.
  *
- * Tem.
+ * Tem. Transactional Email API documentation.
  */
 class API extends API$1 {
   constructor() {
@@ -21,7 +21,10 @@ class API extends API$1 {
     super(...arguments);
     _this = this;
     /**
-     * Send an email
+     * Send an email. You must specify the `region`, the sender and the
+     * recipient's information and the `project_id` to send an email from a
+     * checked domain. The subject of the email must contain at least 6
+     * characters.
      *
      * @param request - The request {@link CreateEmailRequest}
      * @returns A Promise of CreateEmailResponse
@@ -33,7 +36,8 @@ class API extends API$1 {
       path: `/transactional-email/v1alpha1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/emails`
     }, unmarshalCreateEmailResponse);
     /**
-     * Get information about an email
+     * Get an email. Retrieve information about a specific email using the
+     * `email_id` and `region` parameters.
      *
      * @param request - The request {@link GetEmailRequest}
      * @returns A Promise of Email
@@ -57,12 +61,12 @@ class API extends API$1 {
       return _this.client.fetch({
         method: 'GET',
         path: `/transactional-email/v1alpha1/regions/${validatePathParam('region', request.region ?? _this.client.settings.defaultRegion)}/emails`,
-        urlParams: urlParams(['domain_id', request.domainId], ['mail_from', request.mailFrom], ['mail_to', request.mailTo], ['message_id', request.messageId], ['page', request.page], ['page_size', request.pageSize ?? _this.client.settings.defaultPageSize], ['project_id', request.projectId], ['since', request.since], ['statuses', request.statuses], ['until', request.until])
+        urlParams: urlParams(['domain_id', request.domainId], ['mail_from', request.mailFrom], ['mail_to', request.mailTo], ['message_id', request.messageId], ['page', request.page], ['page_size', request.pageSize ?? _this.client.settings.defaultPageSize], ['project_id', request.projectId], ['since', request.since], ['statuses', request.statuses], ['subject', request.subject], ['until', request.until])
       }, unmarshalListEmailsResponse);
     };
     /**
-     * List emails sent from a domain and/or for a project and/or for an
-     * organization
+     * List emails. Retrieve the list of emails sent from a specific domain or for
+     * a specific Project or Organization. You must specify the `region`.
      *
      * @param request - The request {@link ListEmailsRequest}
      * @returns A Promise of ListEmailsResponse
@@ -74,7 +78,7 @@ class API extends API$1 {
       return enrichForPagination('emails', _this.pageOfListEmails, request);
     };
     /**
-     * Get statistics on the email statuses
+     * Email statuses. Get information on your emails' statuses.
      *
      * @param request - The request {@link GetStatisticsRequest}
      * @returns A Promise of Statistics
@@ -90,7 +94,9 @@ class API extends API$1 {
       }, unmarshalStatistics);
     };
     /**
-     * Try to cancel an email if it has not yet been sent
+     * Cancel an email. You can cancel the sending of an email if it has not been
+     * sent yet. You must specify the `region` and the `email_id` of the email you
+     * want to cancel.
      *
      * @param request - The request {@link CancelEmailRequest}
      * @returns A Promise of Email
@@ -102,7 +108,8 @@ class API extends API$1 {
       path: `/transactional-email/v1alpha1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/emails/${validatePathParam('emailId', request.emailId)}/cancel`
     }, unmarshalEmail);
     /**
-     * Register a domain in a project
+     * Register a domain in a project. You must specify the `region`, `project_id`
+     * and `domain_name` to register a domain in a specific Project.
      *
      * @param request - The request {@link CreateDomainRequest}
      * @returns A Promise of Domain
@@ -114,7 +121,8 @@ class API extends API$1 {
       path: `/transactional-email/v1alpha1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/domains`
     }, unmarshalDomain);
     /**
-     * Get information about a domain
+     * Get information about a domain. Retrieve information about a specific
+     * domain using the `region` and `domain_id` parameters.
      *
      * @param request - The request {@link GetDomainRequest}
      * @returns A Promise of Domain
@@ -142,7 +150,8 @@ class API extends API$1 {
       }, unmarshalListDomainsResponse);
     };
     /**
-     * List domains in a project and/or in an organization
+     * List domains. Retrieve domains in a specific project or in a specific
+     * Organization using the `region` parameter.
      *
      * @param request - The request {@link ListDomainsRequest}
      * @returns A Promise of ListDomainsResponse
@@ -154,7 +163,9 @@ class API extends API$1 {
       return enrichForPagination('domains', _this.pageOfListDomains, request);
     };
     /**
-     * Revoke a domain
+     * Delete a domain. You must specify the domain you want to delete by the
+     * `region` and `domain_id`. Deleting a domain is permanent and cannot be
+     * undone.
      *
      * @param request - The request {@link RevokeDomainRequest}
      * @returns A Promise of Domain
@@ -166,7 +177,8 @@ class API extends API$1 {
       path: `/transactional-email/v1alpha1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/domains/${validatePathParam('domainId', request.domainId)}/revoke`
     }, unmarshalDomain);
     /**
-     * Ask for an immediate check of a domain (DNS check)
+     * Domain DNS check. Perform an immediate DNS check of a domain using the
+     * `region` and `domain_id` parameters.
      *
      * @param request - The request {@link CheckDomainRequest}
      * @returns A Promise of Domain

package/dist/api/tem/v1alpha1/marshalling.gen.js

@@ -60,6 +60,7 @@ const unmarshalEmail = data => {
     rcptType: data.rcpt_type,
     status: data.status,
     statusDetails: data.status_details,
+    subject: data.subject,
     tryCount: data.try_count,
     updatedAt: unmarshalDate(data.updated_at)
   };
@@ -113,6 +114,7 @@ const marshalCreateEmailRequestAttachment = (request, defaults) => ({
   type: request.type
 });
 const marshalCreateDomainRequest = (request, defaults) => ({
+  accept_tos: request.acceptTos,
   domain_name: request.domainName,
   project_id: request.projectId ?? defaults.defaultProjectId
 });

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

@@ -13,8 +13,8 @@ const jsonContentHeaders = {
 /**
  * Fake API.
  *
- * Test is a fake service that aim to manage fake humans. It is used for
- * internal and public end-to-end tests.
+ * No Auth Service for end-to-end testing. Test is a fake service that aim to
+ * manage fake humans. It is used for internal and public end-to-end tests.
  *
  * This service don't use the Scaleway authentication service but a fake one. It
  * allows to use this test service publicly without requiring a Scaleway
@@ -30,8 +30,8 @@ class API extends API$1 {
     super(...arguments);
     _this = this;
     /**
-     * Register a human and return a access-key and a secret-key that must be used
-     * in all other commands.
+     * Register a user. Register a human and return a access-key and a secret-key
+     * that must be used in all other commands.
      *
      * Hint: you can use other test commands by setting the SCW_SECRET_KEY env
      * variable.
@@ -56,7 +56,7 @@ class API extends API$1 {
       }, unmarshalListHumansResponse);
     };
     /**
-     * List all your humans
+     * List all your humans.
      *
      * @param request - The request {@link ListHumansRequest}
      * @returns A Promise of ListHumansResponse
@@ -68,7 +68,7 @@ class API extends API$1 {
       return enrichForPagination('humans', _this.pageOfListHumans, request);
     };
     /**
-     * Get the human details associated with the given id.
+     * Get human details. Get the human details associated with the given id.
      *
      * @param request - The request {@link GetHumanRequest}
      * @returns A Promise of Human
@@ -86,7 +86,7 @@ class API extends API$1 {
      */
     this.waitForHuman = (request, options) => waitForResource((options == null ? void 0 : options.stop) ?? (res => Promise.resolve(!HUMAN_TRANSIENT_STATUSES.includes(res.status))), this.getHuman, request, options);
     /**
-     * Create a new human
+     * Create a new human.
      *
      * @param request - The request {@link CreateHumanRequest}
      * @returns A Promise of Human
@@ -98,7 +98,7 @@ class API extends API$1 {
       path: `/test/v1/humans`
     }, unmarshalHuman);
     /**
-     * Update the human associated with the given id.
+     * Update an existing human. Update the human associated with the given id.
      *
      * @param request - The request {@link UpdateHumanRequest}
      * @returns A Promise of Human
@@ -110,7 +110,7 @@ class API extends API$1 {
       path: `/test/v1/humans/${validatePathParam('humanId', request.humanId)}`
     }, unmarshalHuman);
     /**
-     * Delete the human associated with the given id.
+     * Delete an existing human. Delete the human associated with the given id.
      *
      * @param request - The request {@link DeleteHumanRequest}
      * @returns A Promise of Human
@@ -120,7 +120,8 @@ class API extends API$1 {
       path: `/test/v1/humans/${validatePathParam('humanId', request.humanId)}`
     }, unmarshalHuman);
     /**
-     * Start a one hour running for the given human.
+     * Start a 1h running for the given human. Start a one hour running for the
+     * given human.
      *
      * @param request - The request {@link RunHumanRequest}
      * @returns A Promise of Human

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

@@ -25,7 +25,7 @@ class API extends API$1 {
       }, unmarshalListPrivateNetworksResponse);
     };
     /**
-     * List private networks
+     * List private networks.
      *
      * @param request - The request {@link ListPrivateNetworksRequest}
      * @returns A Promise of ListPrivateNetworksResponse
@@ -37,7 +37,7 @@ class API extends API$1 {
       return enrichForPagination('privateNetworks', _this.pageOfListPrivateNetworks, request);
     };
     /**
-     * Create a private network
+     * Create a private network.
      *
      * @param request - The request {@link CreatePrivateNetworkRequest}
      * @returns A Promise of PrivateNetwork
@@ -54,7 +54,7 @@ class API extends API$1 {
       }, unmarshalPrivateNetwork);
     };
     /**
-     * Get a private network
+     * Get a private network.
      *
      * @param request - The request {@link GetPrivateNetworkRequest}
      * @returns A Promise of PrivateNetwork
@@ -64,7 +64,7 @@ class API extends API$1 {
       path: `/vpc/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/private-networks/${validatePathParam('privateNetworkId', request.privateNetworkId)}`
     }, unmarshalPrivateNetwork);
     /**
-     * Update private network
+     * Update private network.
      *
      * @param request - The request {@link UpdatePrivateNetworkRequest}
      * @returns A Promise of PrivateNetwork
@@ -76,7 +76,7 @@ class API extends API$1 {
       path: `/vpc/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/private-networks/${validatePathParam('privateNetworkId', request.privateNetworkId)}`
     }, unmarshalPrivateNetwork);
     /**
-     * Delete a private network
+     * Delete a private network.
      *
      * @param request - The request {@link DeletePrivateNetworkRequest}
      */

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

@@ -10,7 +10,7 @@ const jsonContentHeaders = {
   'Content-Type': 'application/json; charset=utf-8'
 };
 
-/** VPC Public Gateway API. */
+/** Public Gateways API. */
 class API extends API$1 {
   constructor() {
     var _this;
@@ -27,7 +27,9 @@ class API extends API$1 {
       }, unmarshalListGatewaysResponse);
     };
     /**
-     * List VPC Public Gateways
+     * List Public Gateways. List Public Gateways in a given Scaleway Organization
+     * or Project. By default, results are displayed in ascending order of
+     * creation date.
      *
      * @param request - The request {@link ListGatewaysRequest}
      * @returns A Promise of ListGatewaysResponse
@@ -39,7 +41,9 @@ class API extends API$1 {
       return enrichForPagination('gateways', _this.pageOfListGateways, request);
     };
     /**
-     * Get a VPC Public Gateway
+     * Get a Public Gateway. Get details of a Public Gateway, specified by its
+     * gateway ID. The response object contains full details of the gateway,
+     * including its **name**, **type**, **status** and more.
      *
      * @param request - The request {@link GetGatewayRequest}
      * @returns A Promise of Gateway
@@ -57,7 +61,9 @@ class API extends API$1 {
      */
     this.waitForGateway = (request, options) => waitForResource((options == null ? void 0 : options.stop) ?? (res => Promise.resolve(!GATEWAY_TRANSIENT_STATUSES.includes(res.status))), this.getGateway, request, options);
     /**
-     * Create a VPC Public Gateway
+     * Create a Public Gateway. Create a new Public Gateway in the specified
+     * Scaleway Project, defining its **name**, **type** and other configuration
+     * details such as whether to enable SSH bastion.
      *
      * @param request - The request {@link CreateGatewayRequest}
      * @returns A Promise of Gateway
@@ -69,7 +75,9 @@ class API extends API$1 {
       path: `/vpc-gw/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/gateways`
     }, unmarshalGateway);
     /**
-     * Update a VPC Public Gateway
+     * Update a Public Gateway. Update the parameters of an existing Public
+     * Gateway, for example, its **name**, **tags**, **SSH bastion
+     * configuration**, and **DNS servers**.
      *
      * @param request - The request {@link UpdateGatewayRequest}
      * @returns A Promise of Gateway
@@ -81,7 +89,8 @@ class API extends API$1 {
       path: `/vpc-gw/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/gateways/${validatePathParam('gatewayId', request.gatewayId)}`
     }, unmarshalGateway);
     /**
-     * Delete a VPC Public Gateway
+     * Delete a Public Gateway. Delete an existing Public Gateway, specified by
+     * its gateway ID. This action is irreversible.
      *
      * @param request - The request {@link DeleteGatewayRequest}
      */
@@ -91,7 +100,10 @@ class API extends API$1 {
       urlParams: urlParams(['cleanup_dhcp', request.cleanupDhcp])
     });
     /**
-     * Upgrade a VPC Public Gateway to the latest version
+     * Upgrade a Public Gateway to the latest version. Upgrade a given Public
+     * Gateway to the newest software version. This applies the latest bugfixes
+     * and features to your Public Gateway, but its service will be interrupted
+     * during the update.
      *
      * @param request - The request {@link UpgradeGatewayRequest}
      * @returns A Promise of Gateway
@@ -113,7 +125,14 @@ class API extends API$1 {
       }, unmarshalListGatewayNetworksResponse);
     };
     /**
-     * List gateway connections to Private Networks
+     * List Public Gateway connections to Private Networks. List the connections
+     * between Public Gateways and Private Networks (a connection = a
+     * GatewayNetwork). You can choose to filter by `gateway-id` to list all
+     * Private Networks attached to the specified Public Gateway, or by
+     * `private_network_id` to list all Public Gateways attached to the specified
+     * Private Network. Other query parameters are also available. The result is
+     * an array of GatewayNetwork objects, each giving details of the connection
+     * between a given Public Gateway and a given Private Network.
      *
      * @param request - The request {@link ListGatewayNetworksRequest}
      * @returns A Promise of ListGatewayNetworksResponse
@@ -125,7 +144,12 @@ class API extends API$1 {
       return enrichForPagination('gatewayNetworks', _this.pageOfListGatewayNetworks, request);
     };
     /**
-     * Get a gateway connection to a Private Network
+     * Get a Public Gateway connection to a Private Network. Get details of a
+     * given connection between a Public Gateway and a Private Network (this
+     * connection = a GatewayNetwork), specified by its `gateway_network_id`. The
+     * response object contains details of the connection including the IDs of the
+     * Public Gateway and Private Network, the dates the connection was
+     * created/updated and its configuration settings.
      *
      * @param request - The request {@link GetGatewayNetworkRequest}
      * @returns A Promise of GatewayNetwork
@@ -143,7 +167,10 @@ class API extends API$1 {
      */
     this.waitForGatewayNetwork = (request, options) => waitForResource((options == null ? void 0 : options.stop) ?? (res => Promise.resolve(!GATEWAY_NETWORK_TRANSIENT_STATUSES.includes(res.status))), this.getGatewayNetwork, request, options);
     /**
-     * Attach a gateway to a Private Network
+     * Attach a Public Gateway to a Private Network. Attach a specific Public
+     * Gateway to a specific Private Network (create a GatewayNetwork). You can
+     * configure parameters for the connection including DHCP settings, whether to
+     * enable masquerade (dynamic NAT), and more.
      *
      * @param request - The request {@link CreateGatewayNetworkRequest}
      * @returns A Promise of GatewayNetwork
@@ -155,7 +182,11 @@ class API extends API$1 {
       path: `/vpc-gw/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/gateway-networks`
     }, unmarshalGatewayNetwork);
     /**
-     * Update a gateway connection to a Private Network
+     * Update a Public Gateway's connection to a Private Network. Update the
+     * configuration parameters of a connection between a given Public Gateway and
+     * Private Network (the connection = a GatewayNetwork). Updatable parameters
+     * include DHCP settings and whether to enable traffic masquerade (dynamic
+     * NAT).
      *
      * @param request - The request {@link UpdateGatewayNetworkRequest}
      * @returns A Promise of GatewayNetwork
@@ -167,7 +198,9 @@ class API extends API$1 {
       path: `/vpc-gw/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/gateway-networks/${validatePathParam('gatewayNetworkId', request.gatewayNetworkId)}`
     }, unmarshalGatewayNetwork);
     /**
-     * Detach a gateway from a Private Network
+     * Detach a Public Gateway from a Private Network. Detach a given Public
+     * Gateway from a given Private Network, i.e. delete a GatewayNetwork
+     * specified by a gateway_network_id.
      *
      * @param request - The request {@link DeleteGatewayNetworkRequest}
      */
@@ -187,7 +220,14 @@ class API extends API$1 {
       }, unmarshalListDHCPsResponse);
     };
     /**
-     * List DHCP configurations
+     * List DHCP configurations. List DHCP configurations, optionally filtering by
+     * Organization, Project, Public Gateway IP address or more. The response is
+     * an array of DHCP configuration objects, each identified by a DHCP ID and
+     * containing configuration settings for the assignment of IP addresses to
+     * devices on a Private Network attached to a Public Gateway. Note that the
+     * response does not contain the IDs of any Private Network / Public Gateway
+     * the configuration is attached to. Use the `List Public Gateway connections
+     * to Private Networks` method for that purpose, filtering on DHCP ID.
      *
      * @param request - The request {@link ListDHCPsRequest}
      * @returns A Promise of ListDHCPsResponse
@@ -199,7 +239,13 @@ class API extends API$1 {
       return enrichForPagination('dhcps', _this.pageOfListDHCPs, request);
     };
     /**
-     * Get a DHCP configuration
+     * Get a DHCP configuration. Get a DHCP configuration object, identified by
+     * its DHCP ID. The response object contains configuration settings for the
+     * assignment of IP addresses to devices on a Private Network attached to a
+     * Public Gateway. Note that the response does not contain the IDs of any
+     * Private Network / Public Gateway the configuration is attached to. Use the
+     * `List Public Gateway connections to Private Networks` method for that
+     * purpose, filtering on DHCP ID.
      *
      * @param request - The request {@link GetDHCPRequest}
      * @returns A Promise of DHCP
@@ -209,7 +255,13 @@ class API extends API$1 {
       path: `/vpc-gw/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/dhcps/${validatePathParam('dhcpId', request.dhcpId)}`
     }, unmarshalDHCP);
     /**
-     * Create a DHCP configuration
+     * Create a DHCP configuration. Create a new DHCP configuration object,
+     * containing settings for the assignment of IP addresses to devices on a
+     * Private Network attached to a Public Gateway. The response object includes
+     * the ID of the DHCP configuration object. You can use this ID as part of a
+     * call to `Create a Public Gateway connection to a Private Network` or
+     * `Update a Public Gateway connection to a Private Network` to directly apply
+     * this DHCP configuration.
      *
      * @param request - The request {@link CreateDHCPRequest}
      * @returns A Promise of DHCP
@@ -221,7 +273,8 @@ class API extends API$1 {
       path: `/vpc-gw/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/dhcps`
     }, unmarshalDHCP);
     /**
-     * Update a DHCP configuration
+     * Update a DHCP configuration. Update a DHCP configuration object, identified
+     * by its DHCP ID.
      *
      * @param request - The request {@link UpdateDHCPRequest}
      * @returns A Promise of DHCP
@@ -233,7 +286,9 @@ class API extends API$1 {
       path: `/vpc-gw/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/dhcps/${validatePathParam('dhcpId', request.dhcpId)}`
     }, unmarshalDHCP);
     /**
-     * Delete a DHCP configuration
+     * Delete a DHCP configuration. Delete a DHCP configuration object, identified
+     * by its DHCP ID. Note that you cannot delete a DHCP configuration object
+     * that is currently being used by a Gateway Network.
      *
      * @param request - The request {@link DeleteDHCPRequest}
      */
@@ -252,7 +307,9 @@ class API extends API$1 {
       }, unmarshalListDHCPEntriesResponse);
     };
     /**
-     * List DHCP entries
+     * List DHCP entries. List DHCP entries, whether dynamically assigned and/or
+     * statically reserved. DHCP entries can be filtered by the Gateway Network
+     * they are on, their MAC address, IP address, type or hostname.
      *
      * @param request - The request {@link ListDHCPEntriesRequest}
      * @returns A Promise of ListDHCPEntriesResponse
@@ -264,7 +321,7 @@ class API extends API$1 {
       return enrichForPagination('dhcpEntries', _this.pageOfListDHCPEntries, request);
     };
     /**
-     * Get DHCP entries
+     * Get a DHCP entry. Get a DHCP entry, specified by its DHCP entry ID.
      *
      * @param request - The request {@link GetDHCPEntryRequest}
      * @returns A Promise of DHCPEntry
@@ -274,7 +331,11 @@ class API extends API$1 {
       path: `/vpc-gw/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/dhcp-entries/${validatePathParam('dhcpEntryId', request.dhcpEntryId)}`
     }, unmarshalDHCPEntry);
     /**
-     * Create a static DHCP reservation
+     * Create a DHCP entry. Create a static DHCP reservation, specifying the
+     * Gateway Network for the reservation, the MAC address of the target device
+     * and the IP address to assign this device. The response is a DHCP entry
+     * object, confirming the ID and configuration details of the static DHCP
+     * reservation.
      *
      * @param request - The request {@link CreateDHCPEntryRequest}
      * @returns A Promise of DHCPEntry
@@ -286,7 +347,11 @@ class API extends API$1 {
       path: `/vpc-gw/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/dhcp-entries`
     }, unmarshalDHCPEntry);
     /**
-     * Update a DHCP entry
+     * Update a DHCP entry. Update the IP address for a DHCP entry, specified by
+     * its DHCP entry ID. You can update an existing DHCP entry of any type
+     * (`reservation` (static), `lease` (dynamic) or `unknown`), but in manually
+     * updating the IP address the entry will necessarily be of type `reservation`
+     * after the update.
      *
      * @param request - The request {@link UpdateDHCPEntryRequest}
      * @returns A Promise of DHCPEntry
@@ -298,10 +363,10 @@ class API extends API$1 {
       path: `/vpc-gw/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/dhcp-entries/${validatePathParam('dhcpEntryId', request.dhcpEntryId)}`
     }, unmarshalDHCPEntry);
     /**
-     * Set the list of DHCP reservations attached to a Gateway Network.
-     * Reservations are identified by their MAC address, and will sync the current
-     * DHCP entry list to the given list, creating, updating or deleting DHCP
-     * entries.
+     * Set all DHCP reservations on a Gateway Network. Set the list of DHCP
+     * reservations attached to a Gateway Network. Reservations are identified by
+     * their MAC address, and will sync the current DHCP entry list to the given
+     * list, creating, updating or deleting DHCP entries accordingly.
      *
      * @param request - The request {@link SetDHCPEntriesRequest}
      * @returns A Promise of SetDHCPEntriesResponse
@@ -313,7 +378,9 @@ class API extends API$1 {
       path: `/vpc-gw/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/dhcp-entries`
     }, unmarshalSetDHCPEntriesResponse);
     /**
-     * Delete a DHCP reservation
+     * Delete a DHCP entry. Delete a static DHCP reservation, identified by its
+     * DHCP entry ID. Note that you cannot delete DHCP entries of type `lease`,
+     * these are deleted automatically when their time-to-live expires.
      *
      * @param request - The request {@link DeleteDHCPEntryRequest}
      */
@@ -332,7 +399,9 @@ class API extends API$1 {
       }, unmarshalListPATRulesResponse);
     };
     /**
-     * List PAT rules
+     * List PAT rules. List PAT rules. You can filter by gateway ID to list all
+     * PAT rules for a particular gateway, or filter for PAT rules targeting a
+     * specific IP address or using a specific protocol.
      *
      * @param request - The request {@link ListPATRulesRequest}
      * @returns A Promise of ListPATRulesResponse
@@ -344,7 +413,10 @@ class API extends API$1 {
       return enrichForPagination('patRules', _this.pageOfListPATRules, request);
     };
     /**
-     * Get a PAT rule
+     * Get a PAT rule. Get a PAT rule, specified by its PAT rule ID. The response
+     * object gives full details of the PAT rule, including the Public Gateway it
+     * belongs to and the configuration settings in terms of public / private
+     * ports, private IP and protocol.
      *
      * @param request - The request {@link GetPATRuleRequest}
      * @returns A Promise of PATRule
@@ -354,7 +426,9 @@ class API extends API$1 {
       path: `/vpc-gw/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/pat-rules/${validatePathParam('patRuleId', request.patRuleId)}`
     }, unmarshalPATRule);
     /**
-     * Create a PAT rule
+     * Create a PAT rule. Create a new PAT rule on a specified Public Gateway,
+     * defining the protocol to use, public port to listen on, and private port /
+     * IP address to map to.
      *
      * @param request - The request {@link CreatePATRuleRequest}
      * @returns A Promise of PATRule
@@ -366,7 +440,9 @@ class API extends API$1 {
       path: `/vpc-gw/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/pat-rules`
     }, unmarshalPATRule);
     /**
-     * Update a PAT rule
+     * Update a PAT rule. Update a PAT rule, specified by its PAT rule ID.
+     * Configuration settings including private/public port, private IP address
+     * and protocol can all be updated.
      *
      * @param request - The request {@link UpdatePATRuleRequest}
      * @returns A Promise of PATRule
@@ -378,9 +454,10 @@ class API extends API$1 {
       path: `/vpc-gw/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/pat-rules/${validatePathParam('patRuleId', request.patRuleId)}`
     }, unmarshalPATRule);
     /**
-     * Set the list of PAT rules attached to a Gateway. Rules are identified by
-     * their public port and protocol. This will sync the current PAT rule list
-     * with the givent list, creating, updating or deleting PAT rules.
+     * Set all PAT rules. Set a definitive list of PAT rules attached to a Public
+     * Gateway. Each rule is identified by its public port and protocol. This will
+     * sync the current PAT rule list on the gateway with the new list, creating,
+     * updating or deleting PAT rules accordingly.
      *
      * @param request - The request {@link SetPATRulesRequest}
      * @returns A Promise of SetPATRulesResponse
@@ -392,7 +469,8 @@ class API extends API$1 {
       path: `/vpc-gw/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/pat-rules`
     }, unmarshalSetPATRulesResponse);
     /**
-     * Delete a PAT rule
+     * Delete a PAT rule. Delete a PAT rule, identified by its PAT rule ID. This
+     * action is irreversible.
      *
      * @param request - The request {@link DeletePATRuleRequest}
      */
@@ -401,7 +479,9 @@ class API extends API$1 {
       path: `/vpc-gw/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/pat-rules/${validatePathParam('patRuleId', request.patRuleId)}`
     });
     /**
-     * List VPC Public Gateway types
+     * List Public Gateway types. List the different Public Gateway commercial
+     * offer types available at Scaleway. The response is an array of objects
+     * describing the name and technical details of each available gateway type.
      *
      * @param request - The request {@link ListGatewayTypesRequest}
      * @returns A Promise of ListGatewayTypesResponse
@@ -426,7 +506,8 @@ class API extends API$1 {
       }, unmarshalListIPsResponse);
     };
     /**
-     * List IPs
+     * List IPs. List Public Gateway flexible IP addresses. A number of filter
+     * options are available for limiting results in the response.
      *
      * @param request - The request {@link ListIPsRequest}
      * @returns A Promise of ListIPsResponse
@@ -438,7 +519,10 @@ class API extends API$1 {
       return enrichForPagination('ips', _this.pageOfListIPs, request);
     };
     /**
-     * Get an IP
+     * Get an IP. Get details of a Public Gateway flexible IP address, identified
+     * by its IP ID. The response object contains information including which (if
+     * any) Public Gateway using this IP address, the reverse and various other
+     * metadata.
      *
      * @param request - The request {@link GetIPRequest}
      * @returns A Promise of IP
@@ -448,7 +532,8 @@ class API extends API$1 {
       path: `/vpc-gw/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/ips/${validatePathParam('ipId', request.ipId)}`
     }, unmarshalIP);
     /**
-     * Reserve an IP
+     * Reserve an IP. Create (reserve) a new flexible IP address that can be used
+     * for a Public Gateway in a specified Scaleway Project.
      *
      * @param request - The request {@link CreateIPRequest}
      * @returns A Promise of IP
@@ -465,7 +550,8 @@ class API extends API$1 {
       }, unmarshalIP);
     };
     /**
-     * Update an IP
+     * Update an IP. Update details of an existing flexible IP address, including
+     * its tags, reverse and the Public Gateway it is assigned to.
      *
      * @param request - The request {@link UpdateIPRequest}
      * @returns A Promise of IP
@@ -477,7 +563,8 @@ class API extends API$1 {
       path: `/vpc-gw/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/ips/${validatePathParam('ipId', request.ipId)}`
     }, unmarshalIP);
     /**
-     * Delete an IP
+     * Delete an IP. Delete a flexible IP address from your account. This action
+     * is irreversible.
      *
      * @param request - The request {@link DeleteIPRequest}
      */
@@ -486,7 +573,9 @@ class API extends API$1 {
       path: `/vpc-gw/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/ips/${validatePathParam('ipId', request.ipId)}`
     });
     /**
-     * Refresh SSH keys of a VPC Public Gateway
+     * Refresh a Public Gateway's SSH keys. Refresh the SSH keys of a given Public
+     * Gateway, specified by its gateway ID. This adds any new SSH keys in the
+     * gateway's Scaleway Project to the gateway itself.
      *
      * @param request - The request {@link RefreshSSHKeysRequest}
      * @returns A Promise of Gateway