@scaleway/sdk 1.7.0 → 1.8.0

package/dist/index.cjs

@@ -426,7 +426,7 @@ const assertValidSettings = obj => {
   }
 };
 
-const version = 'v1.6.0';
+const version = 'v1.7.0';
 const userAgent = `scaleway-sdk-js/${version}`;
 
 const isBrowser = () => typeof window !== 'undefined' && typeof window.document !== 'undefined';
@@ -2144,7 +2144,7 @@ const jsonContentHeaders$l = {
 };
 
 /**
- * Apple silicon.
+ * Apple silicon API.
  *
  * Apple Mac mini as a service. Scaleway Apple silicon as-a-Service is built
  * using the latest generation of Apple Mac mini hardware (fifth generation).
@@ -2182,7 +2182,8 @@ let API$o = class API extends API$q {
   }, unmarshalListServerTypesResponse);
 
   /**
-   * Get a server type. Get a server technical details.
+   * 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
@@ -2227,7 +2228,7 @@ let API$o = class API extends API$q {
   }, unmarshalListOSResponse$1);
 
   /**
-   * List all Operating System (OS). List all Operating System (OS). The
+   * 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.
    *
@@ -2772,8 +2773,8 @@ let API$n = class API extends API$q {
   }, unmarshalListServersResponse$1);
 
   /**
-   * 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
@@ -3065,7 +3066,7 @@ let API$n = class API extends API$q {
   }, unmarshalListSettingsResponse);
 
   /**
-   * List all settings. Return all settings for a project ID.
+   * List all settings. Return all settings for a Project ID.
    *
    * @param request - The request {@link ListSettingsRequest}
    * @returns A Promise of ListSettingsResponse
@@ -3073,7 +3074,7 @@ let API$n = class API extends API$q {
   listSettings = (request = {}) => enrichForPagination('settings', this.pageOfListSettings, request);
 
   /**
-   * Update setting. Update a setting for a project ID (enable or disable).
+   * Update setting. Update a setting for a Project ID (enable or disable).
    *
    * @param request - The request {@link UpdateSettingRequest}
    * @returns A Promise of Setting
@@ -3100,7 +3101,7 @@ let API$n = class API extends API$q {
   listOS = (request = {}) => enrichForPagination('os', this.pageOfListOS, request);
 
   /**
-   * Get an OS with an ID. Return specific OS for the ID.
+   * Get OS with an ID. Return the specific OS for the ID.
    *
    * @param request - The request {@link GetOSRequest}
    * @returns A Promise of OS
@@ -3638,10 +3639,9 @@ const jsonContentHeaders$j = {
 };
 
 /**
- * Cockpit API documentation.
+ * Cockpit API.
  *
- * Cockpit's API allows you to monitor your applications and their
- * infrastructure. Cockpit's API allows you to activate your Cockpit on your
+ * Cockpit API. Cockpit's API allows you to activate your Cockpit on your
  * Projects. Scaleway's Cockpit stores metrics and logs and provides a dedicated
  * Grafana for dashboarding to visualize them.
  */
@@ -4133,6 +4133,7 @@ const marshalSecret$1 = (request, defaults) => ({
   value: request.value
 });
 const marshalCreateContainerRequest = (request, defaults) => ({
+  cpu_limit: request.cpuLimit,
   description: request.description,
   environment_variables: request.environmentVariables,
   http_option: request.httpOption ?? 'unknown_http_option',
@@ -4178,6 +4179,7 @@ const marshalCreateTokenRequest$1 = (request, defaults) => ({
   }])
 });
 const marshalUpdateContainerRequest = (request, defaults) => ({
+  cpu_limit: request.cpuLimit,
   description: request.description,
   environment_variables: request.environmentVariables,
   http_option: request.httpOption ?? 'unknown_http_option',
@@ -4210,11 +4212,7 @@ const jsonContentHeaders$i = {
   'Content-Type': 'application/json; charset=utf-8'
 };
 
-/**
- * Containers API.
- *
- * Serverless Containers API. Containers API.
- */
+/** Serverless Containers API. */
 let API$k = class API extends API$q {
   /** Lists the available regions of the API. */
   static LOCALITIES = ['fr-par', 'nl-ams', 'pl-waw'];
@@ -5803,9 +5801,10 @@ const jsonContentHeaders$h = {
 };
 
 /**
- * DNS API.
+ * Domains and DNS API.
  *
- * DNS API. Manage your DNS zones and records.
+ * Domains and DNS API. Manage your domains, DNS zones and records with the
+ * Domains and DNS API.
  */
 let API$j = class API extends API$q {
   pageOfListDNSZones = request => this.client.fetch({
@@ -5815,8 +5814,8 @@ let API$j = class API extends API$q {
   }, unmarshalListDNSZonesResponse);
 
   /**
-   * List DNS zones. Returns a list of manageable DNS zones. You can filter the
-   * DNS zones by domain name.
+   * List DNS zones. Retrieve the list of DNS zones you can manage and filter
+   * DNS zones associated with specific domain names.
    *
    * @param request - The request {@link ListDNSZonesRequest}
    * @returns A Promise of ListDNSZonesResponse
@@ -5824,7 +5823,8 @@ let API$j = class API extends API$q {
   listDNSZones = request => enrichForPagination('dnsZones', this.pageOfListDNSZones, request);
 
   /**
-   * Create a DNS zone. Create a new DNS zone.
+   * Create a DNS zone. Create a new DNS zone specified by the domain name, the
+   * subdomain and the Project ID.
    *
    * @param request - The request {@link CreateDNSZoneRequest}
    * @returns A Promise of DNSZone
@@ -5837,7 +5837,7 @@ let API$j = class API extends API$q {
   }, unmarshalDNSZone);
 
   /**
-   * Update a DNS zone. Update the name and/or the organizations for a DNS zone.
+   * Update a DNS zone. Update the name and/or the Organizations for a DNS zone.
    *
    * @param request - The request {@link UpdateDNSZoneRequest}
    * @returns A Promise of DNSZone
@@ -5850,8 +5850,8 @@ let API$j = class API extends API$q {
   }, unmarshalDNSZone);
 
   /**
-   * Clone a DNS zone. Clone an existed DNS zone with all its records into a new
-   * one.
+   * Clone a DNS zone. Clone an existing DNS zone with all its records into a
+   * new DNS zone.
    *
    * @param request - The request {@link CloneDNSZoneRequest}
    * @returns A Promise of DNSZone
@@ -5864,7 +5864,7 @@ let API$j = class API extends API$q {
   }, unmarshalDNSZone);
 
   /**
-   * Delete DNS zone. Delete a DNS zone and all it's records.
+   * Delete a DNS zone. Delete a DNS zone and all its records.
    *
    * @param request - The request {@link DeleteDNSZoneRequest}
    * @returns A Promise of DeleteDNSZoneResponse
@@ -5881,8 +5881,9 @@ let API$j = class API extends API$q {
   }, unmarshalListDNSZoneRecordsResponse);
 
   /**
-   * List DNS zone records. Returns a list of DNS records of a DNS zone with
-   * default NS. You can filter the records by type and name.
+   * List records within a DNS zone. Retrieve a list of DNS records within a DNS
+   * zone that has default name servers. You can filter records by type and
+   * name.
    *
    * @param request - The request {@link ListDNSZoneRecordsRequest}
    * @returns A Promise of ListDNSZoneRecordsResponse
@@ -5890,22 +5891,18 @@ let API$j = class API extends API$q {
   listDNSZoneRecords = request => enrichForPagination('records', this.pageOfListDNSZoneRecords, request);
 
   /**
-   * Update DNS zone records. Only available with default NS.<br/> Send a list
-   * of actions and records.
+   * Update records within a DNS zone. Update records within a DNS zone that has
+   * default name servers and perform several actions on your records.
    *
-   * Action can be:
+   * Actions include:
    *
-   * - Add:
-   * - Add new record
-   * - Can be more specific and add a new IP to an existing A record for example
-   * - Set:
-   * - Edit a record
-   * - Can be more specific and edit an IP from an existing A record for example
-   * - Delete:
-   * - Delete a record
-   * - Can be more specific and delete an IP from an existing A record for example
-   * - Clear:
-   * - Delete all records from a DNS zone
+   * - Add: allows you to add a new record or add a new IP to an existing A
+   *   record, for example
+   * - Set: allows you to edit a record or edit an IP from an existing A record,
+   *   for example
+   * - Delete: allows you to delete a record or delete an IP from an existing A
+   *   record, for example
+   * - Clear: allows you to delete all records from a DNS zone
    *
    * All edits will be versioned.
    *
@@ -5920,8 +5917,8 @@ let API$j = class API extends API$q {
   }, unmarshalUpdateDNSZoneRecordsResponse);
 
   /**
-   * List DNS zone nameservers. Returns a list of Nameservers and their optional
-   * glue records for a DNS zone.
+   * List name servers within a DNS zone. Retrieve a list of name servers within
+   * a DNS zone and their optional glue records.
    *
    * @param request - The request {@link ListDNSZoneNameserversRequest}
    * @returns A Promise of ListDNSZoneNameserversResponse
@@ -5933,8 +5930,8 @@ let API$j = class API extends API$q {
   }, unmarshalListDNSZoneNameserversResponse);
 
   /**
-   * Update DNS zone nameservers. Update DNS zone nameservers and set optional
-   * glue records.
+   * Update name servers within a DNS zone. Update name servers within a DNS
+   * zone and set optional glue records.
    *
    * @param request - The request {@link UpdateDNSZoneNameserversRequest}
    * @returns A Promise of UpdateDNSZoneNameserversResponse
@@ -5947,8 +5944,8 @@ let API$j = class API extends API$q {
   }, unmarshalUpdateDNSZoneNameserversResponse);
 
   /**
-   * Clear DNS zone records. Only available with default NS.<br/> Delete all the
-   * records from a DNS zone. All edits will be versioned.
+   * Clear records within a DNS zone. Delete all records within a DNS zone that
+   * has default name servers.<br/> All edits will be versioned.
    *
    * @param request - The request {@link ClearDNSZoneRecordsRequest}
    * @returns A Promise of ClearDNSZoneRecordsResponse
@@ -5959,7 +5956,8 @@ let API$j = class API extends API$q {
   }, unmarshalClearDNSZoneRecordsResponse);
 
   /**
-   * Export raw DNS zone. Get a DNS zone in a given format with default NS.
+   * Export a raw DNS zone. Export a DNS zone with default name servers, in a
+   * specific format.
    *
    * @param request - The request {@link ExportRawDNSZoneRequest}
    * @returns A Promise of Blob
@@ -5972,8 +5970,8 @@ let API$j = class API extends API$q {
   });
 
   /**
-   * Import raw DNS zone. Import and replace records from a given provider
-   * format with default NS.
+   * Import a raw DNS zone. Import and replace the format of records from a
+   * given provider, with default name servers.
    *
    * @param request - The request {@link ImportRawDNSZoneRequest}
    * @returns A Promise of ImportRawDNSZoneResponse
@@ -5986,8 +5984,8 @@ let API$j = class API extends API$q {
   }, unmarshalImportRawDNSZoneResponse);
 
   /**
-   * Import provider DNS zone. Import and replace records from a given provider
-   * format with default NS.
+   * Import a DNS zone from another provider. Import and replace the format of
+   * records from a given provider, with default name servers.
    *
    * @param request - The request {@link ImportProviderDNSZoneRequest}
    * @returns A Promise of ImportProviderDNSZoneResponse
@@ -6000,8 +5998,9 @@ let API$j = class API extends API$q {
   }, unmarshalImportProviderDNSZoneResponse);
 
   /**
-   * Refresh DNS zone. Refresh SOA DNS zone. You can recreate the given DNS zone
-   * and its sub DNS zone if needed.
+   * Refresh a DNS zone. Refresh an SOA DNS zone to reload the records in the
+   * DNS zone and update the SOA serial. You can recreate the given DNS zone and
+   * its sub DNS zone if needed.
    *
    * @param request - The request {@link RefreshDNSZoneRequest}
    * @returns A Promise of RefreshDNSZoneResponse
@@ -6019,9 +6018,9 @@ let API$j = class API extends API$q {
   }, unmarshalListDNSZoneVersionsResponse);
 
   /**
-   * List DNS zone versions. Get a list of DNS zone versions.<br/> The maximum
-   * version count is 100.<br/> If the count reaches this limit, the oldest
-   * version will be deleted after each new modification.
+   * List versions of a DNS zone. Retrieve a list of a DNS zone's versions.<br/>
+   * The maximum version count is 100. If the count reaches this limit, the
+   * oldest version will be deleted after each new modification.
    *
    * @param request - The request {@link ListDNSZoneVersionsRequest}
    * @returns A Promise of ListDNSZoneVersionsResponse
@@ -6034,8 +6033,8 @@ let API$j = class API extends API$q {
   }, unmarshalListDNSZoneVersionRecordsResponse);
 
   /**
-   * List DNS zone version records. Get a list of records from a previous DNS
-   * zone version.
+   * List records from a given version of a specific DNS zone. Retrieve a list
+   * of records from a specific DNS zone version.
    *
    * @param request - The request {@link ListDNSZoneVersionRecordsRequest}
    * @returns A Promise of ListDNSZoneVersionRecordsResponse
@@ -6043,8 +6042,8 @@ let API$j = class API extends API$q {
   listDNSZoneVersionRecords = request => enrichForPagination('records', this.pageOfListDNSZoneVersionRecords, request);
 
   /**
-   * Get DNS zone version diff. Get all differences from a previous DNS zone
-   * version.
+   * Access differences from a specific DNS zone version. Access a previous DNS
+   * zone version to see the differences from another specific version.
    *
    * @param request - The request {@link GetDNSZoneVersionDiffRequest}
    * @returns A Promise of GetDNSZoneVersionDiffResponse
@@ -6055,7 +6054,8 @@ let API$j = class API extends API$q {
   }, unmarshalGetDNSZoneVersionDiffResponse);
 
   /**
-   * Restore DNS zone version. Restore and activate a previous DNS zone version.
+   * Restore a DNS zone version. Restore and activate a version of a specific
+   * DNS zone.
    *
    * @param request - The request {@link RestoreDNSZoneVersionRequest}
    * @returns A Promise of RestoreDNSZoneVersionResponse
@@ -6068,7 +6068,8 @@ let API$j = class API extends API$q {
   }, unmarshalRestoreDNSZoneVersionResponse);
 
   /**
-   * Get the zone TLS certificate if it exists.
+   * Get a DNS zone's TLS certificate. Get the DNS zone's TLS certificate. If
+   * you do not have a certificate, the ouptut returns `no certificate found`.
    *
    * @param request - The request {@link GetSSLCertificateRequest}
    * @returns A Promise of SSLCertificate
@@ -6088,7 +6089,8 @@ let API$j = class API extends API$q {
   waitForSSLCertificate = (request, options) => waitForResource(options?.stop ?? (res => Promise.resolve(!SSL_CERTIFICATE_TRANSIENT_STATUSES.includes(res.status))), this.getSSLCertificate, request, options);
 
   /**
-   * Create or return the zone TLS certificate.
+   * Create or get the DNS zone's TLS certificate. Create a new TLS certificate
+   * or retrieve information about an existing TLS certificate.
    *
    * @param request - The request {@link CreateSSLCertificateRequest}
    * @returns A Promise of SSLCertificate
@@ -6106,7 +6108,8 @@ let API$j = class API extends API$q {
   }, unmarshalListSSLCertificatesResponse);
 
   /**
-   * List all user TLS certificates.
+   * List a user's TLS certificates. List all the TLS certificates a user has
+   * created, specified by the user's Project ID and the DNS zone.
    *
    * @param request - The request {@link ListSSLCertificatesRequest}
    * @returns A Promise of ListSSLCertificatesResponse
@@ -6114,7 +6117,9 @@ let API$j = class API extends API$q {
   listSSLCertificates = request => enrichForPagination('certificates', this.pageOfListSSLCertificates, request);
 
   /**
-   * Delete an TLS certificate.
+   * Delete a TLS certificate. Delete an existing TLS certificate specified by
+   * its DNS zone. Deleting a TLS certificate is permanent and cannot be
+   * undone.
    *
    * @param request - The request {@link DeleteSSLCertificateRequest}
    * @returns A Promise of DeleteSSLCertificateResponse
@@ -6125,7 +6130,8 @@ let API$j = class API extends API$q {
   }, unmarshalDeleteSSLCertificateResponse);
 
   /**
-   * Get the DNS zone TSIG Key. Get the DNS zone TSIG Key to allow AXFR request.
+   * Get the DNS zone's TSIG key. Retrieve information about the TSIG key of a
+   * given DNS zone to allow AXFR requests.
    *
    * @param request - The request {@link GetDNSZoneTsigKeyRequest}
    * @returns A Promise of GetDNSZoneTsigKeyResponse
@@ -6136,7 +6142,8 @@ let API$j = class API extends API$q {
   }, unmarshalGetDNSZoneTsigKeyResponse);
 
   /**
-   * Delete the DNS zone TSIG Key.
+   * Delete the DNS zone's TSIG key. Delete an existing TSIG key specified by
+   * its DNS zone. Deleting a TSIG key is permanent and cannot be undone.
    *
    * @param request - The request {@link DeleteDNSZoneTsigKeyRequest}
    */
@@ -6678,13 +6685,14 @@ const jsonContentHeaders$g = {
   'Content-Type': 'application/json; charset=utf-8'
 };
 
-/** Flexible IP API. */
+/** Elastic Metal - Flexible IP API. */
 let API$i = class API extends API$q {
   /** Lists the available zones of the API. */
   static LOCALITIES = ['fr-par-1', 'fr-par-2', 'nl-ams-1'];
 
   /**
-   * Create a Flexible IP.
+   * 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
@@ -6697,7 +6705,9 @@ let API$i = class API extends API$q {
   }, unmarshalFlexibleIP);
 
   /**
-   * Get a Flexible IP.
+   * 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
@@ -6722,7 +6732,7 @@ let API$i = class API extends API$q {
   }, unmarshalListFlexibleIPsResponse);
 
   /**
-   * List Flexible IPs.
+   * List flexible IPs. List all flexible IPs within a given zone.
    *
    * @param request - The request {@link ListFlexibleIPsRequest}
    * @returns A Promise of ListFlexibleIPsResponse
@@ -6730,7 +6740,9 @@ let API$i = class API extends API$q {
   listFlexibleIPs = (request = {}) => enrichForPagination('flexibleIps', this.pageOfListFlexibleIPs, request);
 
   /**
-   * Update a Flexible IP.
+   * 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
@@ -6743,7 +6755,9 @@ let API$i = class API extends API$q {
   }, unmarshalFlexibleIP);
 
   /**
-   * Delete a Flexible IP.
+   * 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}
    */
@@ -6753,7 +6767,8 @@ let API$i = class API extends API$q {
   });
 
   /**
-   * Attach a Flexible IP to a 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
@@ -6766,7 +6781,8 @@ let API$i = class API extends API$q {
   }, unmarshalAttachFlexibleIPsResponse);
 
   /**
-   * Detach a Flexible IP from a 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
@@ -6779,7 +6795,8 @@ let API$i = class API extends API$q {
   }, unmarshalDetachFlexibleIPsResponse);
 
   /**
-   * Generate a virtual MAC on a given 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
@@ -6792,8 +6809,9 @@ let API$i = class API extends API$q {
   }, unmarshalFlexibleIP);
 
   /**
-   * Duplicate a Virtual MAC. Duplicate a Virtual MAC from a given Flexible IP
-   * onto another attached on 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
@@ -6806,8 +6824,9 @@ let API$i = class API extends API$q {
   }, unmarshalFlexibleIP);
 
   /**
-   * Move a virtual MAC. Move a Virtual MAC from a given Flexible IP onto
-   * another 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
@@ -6820,7 +6839,8 @@ let API$i = class API extends API$q {
   }, unmarshalFlexibleIP);
 
   /**
-   * Remove a virtual MAC from a 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}
    */
@@ -10342,7 +10362,7 @@ let API$f = class API extends API$q {
   }, unmarshalListServersTypesResponse);
 
   /**
-   * List volumes types. List all volume types and their technical details.
+   * List volume types. List all volume types and their technical details.
    *
    * @param request - The request {@link ListVolumesTypesRequest}
    * @returns A Promise of ListVolumesTypesResponse
@@ -10431,7 +10451,7 @@ let API$f = class API extends API$q {
    * preserve your local volumes, you should use the `archive` action instead of
    * `terminate`. Similarly, if you want to keep your block storage volumes, you
    * must first detach them before issuing the `terminate` command. For more
-   * information, read the [Volumes](#volumes-7e8a39) documentation.
+   * information, read the [Volumes](#path-volumes-list-volumes) documentation.
    *
    * @param request - The request {@link ServerActionRequest}
    * @returns A Promise of ServerActionResponse
@@ -11968,9 +11988,9 @@ const jsonContentHeaders$c = {
 };
 
 /**
- * IoT API.
+ * IoT Hub API.
  *
- * This API allows you to manage IoT hubs and devices. IoT API.
+ * This API allows you to manage IoT hubs and devices. IoT Hub API.
  */
 let API$e = class API extends API$q {
   /** Lists the available regions of the API. */
@@ -11982,7 +12002,9 @@ let API$e = class API extends API$q {
   }, unmarshalListHubsResponse);
 
   /**
-   * List hubs.
+   * List hubs. List all Hubs in the specified zone. By default, returned Hubs
+   * are ordered by creation date in ascending order, though this can be
+   * modified via the `order_by` field.
    *
    * @param request - The request {@link ListHubsRequest}
    * @returns A Promise of ListHubsResponse
@@ -11990,7 +12012,8 @@ let API$e = class API extends API$q {
   listHubs = (request = {}) => enrichForPagination('hubs', this.pageOfListHubs, request);
 
   /**
-   * Create a hub.
+   * Create a hub. Create a new Hub in the targeted region, specifying its
+   * configuration including name and product plan.
    *
    * @param request - The request {@link CreateHubRequest}
    * @returns A Promise of Hub
@@ -12003,7 +12026,9 @@ let API$e = class API extends API$q {
   }, unmarshalHub);
 
   /**
-   * Get a hub.
+   * Get a hub. Retrieve information about an existing IoT Hub, specified by its
+   * Hub ID. Its full details, including name, status and endpoint, are returned
+   * in the response object.
    *
    * @param request - The request {@link GetHubRequest}
    * @returns A Promise of Hub
@@ -12023,7 +12048,8 @@ let API$e = class API extends API$q {
   waitForHub = (request, options) => waitForResource(options?.stop ?? (res => Promise.resolve(!HUB_TRANSIENT_STATUSES.includes(res.status))), this.getHub, request, options);
 
   /**
-   * Update a hub.
+   * Update a hub. Update the parameters of an existing IoT Hub, specified by
+   * its Hub ID.
    *
    * @param request - The request {@link UpdateHubRequest}
    * @returns A Promise of Hub
@@ -12036,7 +12062,7 @@ let API$e = class API extends API$q {
   }, unmarshalHub);
 
   /**
-   * Enable a hub.
+   * Enable a hub. Enable an existing IoT Hub, specified by its Hub ID.
    *
    * @param request - The request {@link EnableHubRequest}
    * @returns A Promise of Hub
@@ -12049,7 +12075,7 @@ let API$e = class API extends API$q {
   }, unmarshalHub);
 
   /**
-   * Disable a hub.
+   * Disable a hub. Disable an existing IoT Hub, specified by its Hub ID.
    *
    * @param request - The request {@link DisableHubRequest}
    * @returns A Promise of Hub
@@ -12062,7 +12088,8 @@ let API$e = class API extends API$q {
   }, unmarshalHub);
 
   /**
-   * Delete a hub.
+   * Delete a hub. Delete an existing IoT Hub, specified by its Hub ID. Deleting
+   * a Hub is permanent, and cannot be undone.
    *
    * @param request - The request {@link DeleteHubRequest}
    */
@@ -12073,7 +12100,8 @@ let API$e = class API extends API$q {
   });
 
   /**
-   * Get a hub's metrics.
+   * Get a hub's metrics. Get the metrics of an existing IoT Hub, specified by
+   * its Hub ID.
    *
    * @deprecated
    * @param request - The request {@link GetHubMetricsRequest}
@@ -12086,7 +12114,8 @@ let API$e = class API extends API$q {
   }, unmarshalGetHubMetricsResponse);
 
   /**
-   * Set the certificate authority of a hub.
+   * Set the certificate authority of a hub. Set a particular PEM-encoded
+   * certificate, specified by the Hub ID.
    *
    * @param request - The request {@link SetHubCARequest}
    * @returns A Promise of Hub
@@ -12099,7 +12128,8 @@ let API$e = class API extends API$q {
   }, unmarshalHub);
 
   /**
-   * Get the certificate authority of a hub.
+   * Get the certificate authority of a hub. Get information for a particular
+   * PEM-encoded certificate, specified by the Hub ID.
    *
    * @param request - The request {@link GetHubCARequest}
    * @returns A Promise of GetHubCAResponse
@@ -12115,7 +12145,9 @@ let API$e = class API extends API$q {
   }, unmarshalListDevicesResponse);
 
   /**
-   * List devices.
+   * List devices. List all devices in the specified region. By default,
+   * returned devices are ordered by creation date in ascending order, though
+   * this can be modified via the `order_by` field.
    *
    * @param request - The request {@link ListDevicesRequest}
    * @returns A Promise of ListDevicesResponse
@@ -12123,7 +12155,7 @@ let API$e = class API extends API$q {
   listDevices = (request = {}) => enrichForPagination('devices', this.pageOfListDevices, request);
 
   /**
-   * Add a device.
+   * Add a device. Attach a device to a given Hub.
    *
    * @param request - The request {@link CreateDeviceRequest}
    * @returns A Promise of CreateDeviceResponse
@@ -12136,7 +12168,9 @@ let API$e = class API extends API$q {
   }, unmarshalCreateDeviceResponse);
 
   /**
-   * Get a device.
+   * Get a device. Retrieve information about an existing device, specified by
+   * its device ID. Its full details, including name, status and ID, are
+   * returned in the response object.
    *
    * @param request - The request {@link GetDeviceRequest}
    * @returns A Promise of Device
@@ -12147,7 +12181,8 @@ let API$e = class API extends API$q {
   }, unmarshalDevice);
 
   /**
-   * Update a device.
+   * Update a device. Update the parameters of an existing device, specified by
+   * its device ID.
    *
    * @param request - The request {@link UpdateDeviceRequest}
    * @returns A Promise of Device
@@ -12160,7 +12195,7 @@ let API$e = class API extends API$q {
   }, unmarshalDevice);
 
   /**
-   * Enable a device.
+   * Enable a device. Enable a specific device, specified by its device ID.
    *
    * @param request - The request {@link EnableDeviceRequest}
    * @returns A Promise of Device
@@ -12173,7 +12208,7 @@ let API$e = class API extends API$q {
   }, unmarshalDevice);
 
   /**
-   * Disable a device.
+   * Disable a device. Disable an existing device, specified by its device ID.
    *
    * @param request - The request {@link DisableDeviceRequest}
    * @returns A Promise of Device
@@ -12186,7 +12221,8 @@ let API$e = class API extends API$q {
   }, unmarshalDevice);
 
   /**
-   * Renew a device certificate.
+   * Renew a device certificate. Renew the certificate of an existing device,
+   * specified by its device ID.
    *
    * @param request - The request {@link RenewDeviceCertificateRequest}
    * @returns A Promise of RenewDeviceCertificateResponse
@@ -12199,7 +12235,8 @@ let API$e = class API extends API$q {
   }, unmarshalRenewDeviceCertificateResponse);
 
   /**
-   * Set a custom certificate on a device.
+   * Set a custom certificate on a device. Switch the existing certificate of a
+   * given device with an EM-encoded custom certificate.
    *
    * @param request - The request {@link SetDeviceCertificateRequest}
    * @returns A Promise of SetDeviceCertificateResponse
@@ -12212,7 +12249,9 @@ let API$e = class API extends API$q {
   }, unmarshalSetDeviceCertificateResponse);
 
   /**
-   * Get a device's certificate.
+   * Get a device's certificate. Get information for a particular PEM-encoded
+   * certificate, specified by the device ID. The response returns full details
+   * of the device, including its type of certificate.
    *
    * @param request - The request {@link GetDeviceCertificateRequest}
    * @returns A Promise of GetDeviceCertificateResponse
@@ -12223,7 +12262,8 @@ let API$e = class API extends API$q {
   }, unmarshalGetDeviceCertificateResponse);
 
   /**
-   * Remove a device.
+   * Remove a device. Remove a specific device from the specific Hub it is
+   * attached to.
    *
    * @param request - The request {@link DeleteDeviceRequest}
    */
@@ -12233,7 +12273,8 @@ let API$e = class API extends API$q {
   });
 
   /**
-   * Get a device's metrics.
+   * Get a device's metrics. Get the metrics of an existing device, specified by
+   * its device ID.
    *
    * @deprecated
    * @param request - The request {@link GetDeviceMetricsRequest}
@@ -12251,7 +12292,9 @@ let API$e = class API extends API$q {
   }, unmarshalListRoutesResponse$1);
 
   /**
-   * List routes.
+   * List routes. List all routes in the specified region. By default, returned
+   * routes are ordered by creation date in ascending order, though this can be
+   * modified via the `order_by` field.
    *
    * @param request - The request {@link ListRoutesRequest}
    * @returns A Promise of ListRoutesResponse
@@ -12259,15 +12302,15 @@ let API$e = class API extends API$q {
   listRoutes = (request = {}) => enrichForPagination('routes', this.pageOfListRoutes, request);
 
   /**
-   * Create a route. Multiple route kinds can be created:
+   * Create a route. Multiple kinds of routes can be created, such as:
    *
-   * - Database Route. Create a route that will record subscribed MQTT messages
+   * - Database Route Create a route that will record subscribed MQTT messages
    *   into your database. <b>You need to manage the database by yourself</b>.
    * - REST Route. Create a route that will call a REST API on received subscribed
    *   MQTT messages.
    * - S3 Routes. Create a route that will put subscribed MQTT messages into an S3
-   *   bucket. You need to create the bucket yourself and grant us write access.
-   *   The grant can be done with s3cmd (`s3cmd setacl s3://&lt;my-bucket&gt;
+   *   bucket. You need to create the bucket yourself and grant write access.
+   *   Granting can be done with s3cmd (`s3cmd setacl s3://&lt;my-bucket&gt;
    *   --acl-grant=write:555c69c3-87d0-4bf8-80f1-99a2f757d031:555c69c3-87d0-4bf8-80f1-99a2f757d031`).
    *
    * @param request - The request {@link CreateRouteRequest}
@@ -12281,7 +12324,8 @@ let API$e = class API extends API$q {
   }, unmarshalRoute$1);
 
   /**
-   * Update a route.
+   * Update a route. Update the parameters of an existing route, specified by
+   * its route ID.
    *
    * @param request - The request {@link UpdateRouteRequest}
    * @returns A Promise of Route
@@ -12294,7 +12338,9 @@ let API$e = class API extends API$q {
   }, unmarshalRoute$1);
 
   /**
-   * Get a route.
+   * Get a route. Get information for a particular route, specified by the route
+   * ID. The response returns full details of the route, including its type, the
+   * topic it subscribes to and its configuration.
    *
    * @param request - The request {@link GetRouteRequest}
    * @returns A Promise of Route
@@ -12305,7 +12351,8 @@ let API$e = class API extends API$q {
   }, unmarshalRoute$1);
 
   /**
-   * Delete a route.
+   * Delete a route. Delete an existing route, specified by its route ID.
+   * Deleting a route is permanent, and cannot be undone.
    *
    * @param request - The request {@link DeleteRouteRequest}
    */
@@ -12320,7 +12367,7 @@ let API$e = class API extends API$q {
   }, unmarshalListNetworksResponse);
 
   /**
-   * List the Networks.
+   * List the networks.
    *
    * @param request - The request {@link ListNetworksRequest}
    * @returns A Promise of ListNetworksResponse
@@ -12328,7 +12375,9 @@ let API$e = class API extends API$q {
   listNetworks = (request = {}) => enrichForPagination('networks', this.pageOfListNetworks, request);
 
   /**
-   * Create a new Network.
+   * Create a new network. Create a new network for an existing hub. Beside the
+   * default network, you can add networks for different data providers.
+   * Possible network types are Sigfox and REST.
    *
    * @param request - The request {@link CreateNetworkRequest}
    * @returns A Promise of CreateNetworkResponse
@@ -12341,7 +12390,9 @@ let API$e = class API extends API$q {
   }, unmarshalCreateNetworkResponse);
 
   /**
-   * Retrieve a specific Network.
+   * Retrieve a specific network. Retrieve an existing network, specified by its
+   * network ID. The response returns full details of the network, including its
+   * type, the topic prefix and its endpoint.
    *
    * @param request - The request {@link GetNetworkRequest}
    * @returns A Promise of Network
@@ -12352,7 +12403,8 @@ let API$e = class API extends API$q {
   }, unmarshalNetwork);
 
   /**
-   * Delete a Network.
+   * Delete a Network. Delete an existing network, specified by its network ID.
+   * Deleting a network is permanent, and cannot be undone.
    *
    * @param request - The request {@link DeleteNetworkRequest}
    */
@@ -12834,7 +12886,7 @@ const jsonContentHeaders$b = {
   'Content-Type': 'application/json; charset=utf-8'
 };
 
-/** Kapsule API. */
+/** Kubernetes API. */
 let API$d = class API extends API$q {
   /** Lists the available regions of the API. */
   static LOCALITIES = ['fr-par', 'nl-ams', 'pl-waw'];
@@ -16384,10 +16436,7 @@ const marshalPermissions = (request, defaults) => ({
 const marshalCreateCredentialRequest = (request, defaults) => ({
   name: request.name || randomName('mnq'),
   namespace_id: request.namespaceId,
-  ...resolveOneOf([{
-    param: 'permissions',
-    value: request.permissions ? marshalPermissions(request.permissions) : undefined
-  }])
+  permissions: request.permissions ? marshalPermissions(request.permissions) : undefined
 });
 const marshalCreateNamespaceRequest$1 = (request, defaults) => ({
   name: request.name || randomName('mnq'),
@@ -16396,10 +16445,7 @@ const marshalCreateNamespaceRequest$1 = (request, defaults) => ({
 });
 const marshalUpdateCredentialRequest = (request, defaults) => ({
   name: request.name,
-  ...resolveOneOf([{
-    param: 'permissions',
-    value: request.permissions ? marshalPermissions(request.permissions) : undefined
-  }])
+  permissions: request.permissions ? marshalPermissions(request.permissions) : undefined
 });
 const marshalUpdateNamespaceRequest$1 = (request, defaults) => ({
   name: request.name,
@@ -16412,10 +16458,10 @@ const jsonContentHeaders$9 = {
 };
 
 /**
- * MnQ API (beta).
+ * Messaging and Queuing API.
  *
- * This API allows you to manage Scaleway Messaging and Queueing brokers. MnQ
- * API (beta).
+ * This API allows you to manage Scaleway Messaging and Queueing brokers.
+ * Messaging and Queuing API.
  */
 let API$9 = class API extends API$q {
   /** Lists the available regions of the API. */
@@ -18960,11 +19006,7 @@ const jsonContentHeaders$6 = {
   'Content-Type': 'application/json; charset=utf-8'
 };
 
-/**
- * Registry API.
- *
- * Container registry API. Registry API.
- */
+/** Container Registry API. */
 let API$6 = class API extends API$q {
   /** Lists the available regions of the API. */
   static LOCALITIES = ['fr-par', 'nl-ams', 'pl-waw'];
@@ -18975,7 +19017,11 @@ let API$6 = class API extends API$q {
   }, unmarshalListNamespacesResponse);
 
   /**
-   * List all your namespaces.
+   * List namespaces. List all namespaces in a specified region. By default, the
+   * namespaces listed are ordered by creation date in ascending order. This can
+   * be modified via the order_by field. You can also define additional
+   * parameters for your query, such as the `instance_id` and `project_id`
+   * parameters.
    *
    * @param request - The request {@link ListNamespacesRequest}
    * @returns A Promise of ListNamespacesResponse
@@ -18983,7 +19029,10 @@ let API$6 = class API extends API$q {
   listNamespaces = (request = {}) => enrichForPagination('namespaces', this.pageOfListNamespaces, request);
 
   /**
-   * Get a namespace. Get the namespace associated with the given id.
+   * Get a namespace. Retrieve information about a given namespace, specified by
+   * its `namespace_id` and region. Full details about the namespace, such as
+   * `description`, `project_id`, `status`, `endpoint`, `is_public`, `size`, and
+   * `image_count` are returned in the response.
    *
    * @param request - The request {@link GetNamespaceRequest}
    * @returns A Promise of Namespace
@@ -19003,7 +19052,10 @@ let API$6 = class API extends API$q {
   waitForNamespace = (request, options) => waitForResource(options?.stop ?? (res => Promise.resolve(!NAMESPACE_TRANSIENT_STATUSES.includes(res.status))), this.getNamespace, request, options);
 
   /**
-   * Create a new namespace.
+   * Create a namespace. Create a new Container Registry namespace. You must
+   * specify the namespace name and region in which you want it to be created.
+   * Optionally, you can specify the `project_id` and `is_public` in the request
+   * payload.
    *
    * @param request - The request {@link CreateNamespaceRequest}
    * @returns A Promise of Namespace
@@ -19016,8 +19068,9 @@ let API$6 = class API extends API$q {
   }, unmarshalNamespace);
 
   /**
-   * Update an existing namespace. Update the namespace associated with the
-   * given id.
+   * Update a namespace. Update the parameters of a given namespace, specified
+   * by its `namespace_id` and `region`. You can update the `description` and
+   * `is_public` parameters.
    *
    * @param request - The request {@link UpdateNamespaceRequest}
    * @returns A Promise of Namespace
@@ -19030,8 +19083,9 @@ let API$6 = class API extends API$q {
   }, unmarshalNamespace);
 
   /**
-   * Delete an existing namespace. Delete the namespace associated with the
-   * given id.
+   * Delete a namespace. Delete a given namespace. You must specify, in the
+   * endpoint, the `region` and `namespace_id` parameters of the namespace you
+   * want to delete.
    *
    * @param request - The request {@link DeleteNamespaceRequest}
    * @returns A Promise of Namespace
@@ -19047,7 +19101,10 @@ let API$6 = class API extends API$q {
   }, unmarshalListImagesResponse);
 
   /**
-   * List all your images.
+   * List images. List all images in a specified region. By default, the images
+   * listed are ordered by creation date in ascending order. This can be
+   * modified via the order_by field. You can also define additional parameters
+   * for your query, such as the `namespace_id` and `project_id` parameters.
    *
    * @param request - The request {@link ListImagesRequest}
    * @returns A Promise of ListImagesResponse
@@ -19055,7 +19112,10 @@ let API$6 = class API extends API$q {
   listImages = (request = {}) => enrichForPagination('images', this.pageOfListImages, request);
 
   /**
-   * Get a image. Get the image associated with the given id.
+   * Get an image. Retrieve information about a given container image, specified
+   * by its `image_id` and region. Full details about the image, such as `name`,
+   * `namespace_id`, `status`, `visibility`, and `size` are returned in the
+   * response.
    *
    * @param request - The request {@link GetImageRequest}
    * @returns A Promise of Image
@@ -19075,7 +19135,8 @@ let API$6 = class API extends API$q {
   waitForImage = (request, options) => waitForResource(options?.stop ?? (res => Promise.resolve(!IMAGE_TRANSIENT_STATUSES.includes(res.status))), this.getImage, request, options);
 
   /**
-   * Update an existing image. Update the image associated with the given id.
+   * Update an image. Update the parameters of a given image, specified by its
+   * `image_id` and `region`. You can update the `visibility` parameter.
    *
    * @param request - The request {@link UpdateImageRequest}
    * @returns A Promise of Image
@@ -19088,7 +19149,8 @@ let API$6 = class API extends API$q {
   }, unmarshalImage);
 
   /**
-   * Delete an image. Delete the image associated with the given id.
+   * Delete an image. Delete a given image. You must specify, in the endpoint,
+   * the `region` and `image_id` parameters of the image you want to delete.
    *
    * @param request - The request {@link DeleteImageRequest}
    * @returns A Promise of Image
@@ -19104,7 +19166,10 @@ let API$6 = class API extends API$q {
   }, unmarshalListTagsResponse);
 
   /**
-   * List all your tags.
+   * List tags. List all tags for a given image, specified by region. By
+   * default, the tags listed are ordered by creation date in ascending order.
+   * This can be modified via the order_by field. You can also define additional
+   * parameters for your query, such as the `name`.
    *
    * @param request - The request {@link ListTagsRequest}
    * @returns A Promise of ListTagsResponse
@@ -19112,7 +19177,9 @@ let API$6 = class API extends API$q {
   listTags = request => enrichForPagination('tags', this.pageOfListTags, request);
 
   /**
-   * Get a tag. Get the tag associated with the given id.
+   * Get a tag. Retrieve information about a given image tag, specified by its
+   * `tag_id` and region. Full details about the tag, such as `name`,
+   * `image_id`, `status`, and `digest` are returned in the response.
    *
    * @param request - The request {@link GetTagRequest}
    * @returns A Promise of Tag
@@ -19132,7 +19199,8 @@ let API$6 = class API extends API$q {
   waitForTag = (request, options) => waitForResource(options?.stop ?? (res => Promise.resolve(!TAG_TRANSIENT_STATUSES.includes(res.status))), this.getTag, request, options);
 
   /**
-   * Delete a tag. Delete the tag associated with the given id.
+   * Delete a tag. Delete a given image tag. You must specify, in the endpoint,
+   * the `region` and `tag_id` parameters of the tag you want to delete.
    *
    * @param request - The request {@link DeleteTagRequest}
    * @returns A Promise of Tag
@@ -19262,10 +19330,10 @@ const jsonContentHeaders$5 = {
 };
 
 /**
- * Secret Manager API documentation.
+ * Secret Manager API.
  *
- * This API allows you to conveniently store, access and share sensitive data.
- * Secret Manager API documentation.
+ * Secret Manager API. This API allows you to conveniently store, access and
+ * share sensitive data.
  */
 let API$5 = class API extends API$q {
   /** Lists the available regions of the API. */
@@ -19901,11 +19969,7 @@ const jsonContentHeaders$3 = {
   'Content-Type': 'application/json; charset=utf-8'
 };
 
-/**
- * Transactional Email API documentation.
- *
- * Tem. Transactional Email API documentation.
- */
+/** Transactional Email API. */
 let API$3 = class API extends API$q {
   /** Lists the available regions of the API. */
   static LOCALITIES = ['fr-par'];