@scaleway/sdk 1.6.0 → 1.8.0

package/dist/api/domain/v2beta1/api.gen.js

@@ -11,9 +11,10 @@ const jsonContentHeaders = {
 };
 
 /**
- * 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.
  */
 class API extends API$1 {
   constructor() {
@@ -24,15 +25,16 @@ class API extends API$1 {
       urlParams: urlParams(['dns_zone', request.dnsZone], ['domain', request.domain], ['order_by', request.orderBy ?? 'domain_asc'], ['organization_id', request.organizationId], ['page', request.page], ['page_size', request.pageSize ?? this.client.settings.defaultPageSize], ['project_id', request.projectId])
     }, 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
      */
     this.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
@@ -44,7 +46,7 @@ class API extends API$1 {
       path: `/domain/v2beta1/dns-zones`
     }, 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
@@ -56,8 +58,8 @@ class API extends API$1 {
       path: `/domain/v2beta1/dns-zones/${validatePathParam('dnsZone', request.dnsZone)}`
     }, 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
@@ -69,7 +71,7 @@ class API extends API$1 {
       path: `/domain/v2beta1/dns-zones/${validatePathParam('dnsZone', request.dnsZone)}/clone`
     }, 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
@@ -85,30 +87,27 @@ class API extends API$1 {
       urlParams: urlParams(['id', request.id], ['name', request.name], ['order_by', request.orderBy ?? 'name_asc'], ['page', request.page], ['page_size', request.pageSize ?? this.client.settings.defaultPageSize], ['project_id', request.projectId], ['type', request.type ?? 'unknown'])
     }, 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
      */
     this.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.
      *
@@ -122,8 +121,8 @@ class API extends API$1 {
       path: `/domain/v2beta1/dns-zones/${validatePathParam('dnsZone', request.dnsZone)}/records`
     }, 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
@@ -134,8 +133,8 @@ class API extends API$1 {
       urlParams: urlParams(['project_id', request.projectId])
     }, 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
@@ -147,8 +146,8 @@ class API extends API$1 {
       path: `/domain/v2beta1/dns-zones/${validatePathParam('dnsZone', request.dnsZone)}/nameservers`
     }, 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
@@ -158,7 +157,8 @@ class API extends API$1 {
       path: `/domain/v2beta1/dns-zones/${validatePathParam('dnsZone', request.dnsZone)}/records`
     }, 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
@@ -170,8 +170,8 @@ class API extends API$1 {
       responseType: 'blob'
     });
     /**
-     * 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
@@ -183,8 +183,8 @@ class API extends API$1 {
       path: `/domain/v2beta1/dns-zones/${validatePathParam('dnsZone', request.dnsZone)}/raw`
     }, 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
@@ -196,8 +196,9 @@ class API extends API$1 {
       path: `/domain/v2beta1/dns-zones/${validatePathParam('dnsZone', request.dnsZone)}/import-provider`
     }, 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
@@ -214,9 +215,9 @@ class API extends API$1 {
       urlParams: urlParams(['page', request.page], ['page_size', request.pageSize ?? this.client.settings.defaultPageSize])
     }, 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
@@ -228,16 +229,16 @@ class API extends API$1 {
       urlParams: urlParams(['page', request.page], ['page_size', request.pageSize ?? this.client.settings.defaultPageSize])
     }, 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
      */
     this.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
@@ -247,7 +248,8 @@ class API extends API$1 {
       path: `/domain/v2beta1/dns-zones/version/${validatePathParam('dnsZoneVersionId', request.dnsZoneVersionId)}/diff`
     }, 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
@@ -259,7 +261,8 @@ class API extends API$1 {
       path: `/domain/v2beta1/dns-zones/version/${validatePathParam('dnsZoneVersionId', request.dnsZoneVersionId)}/restore`
     }, 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
@@ -275,9 +278,10 @@ class API extends API$1 {
      * @param options - The waiting options
      * @returns A Promise of SSLCertificate
      */
-    this.waitForSSLCertificate = (request, options) => waitForResource((options == null ? void 0 : options.stop) ?? (res => Promise.resolve(!SSL_CERTIFICATE_TRANSIENT_STATUSES.includes(res.status))), this.getSSLCertificate, request, options);
+    this.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
@@ -294,14 +298,17 @@ class API extends API$1 {
       urlParams: urlParams(['dns_zone', request.dnsZone], ['page', request.page], ['page_size', request.pageSize ?? this.client.settings.defaultPageSize], ['project_id', request.projectId])
     }, 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
      */
     this.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
@@ -311,7 +318,8 @@ class API extends API$1 {
       path: `/domain/v2beta1/ssl-certificates/${validatePathParam('dnsZone', request.dnsZone)}`
     }, 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
@@ -321,7 +329,8 @@ class API extends API$1 {
       path: `/domain/v2beta1/dns-zones/${validatePathParam('dnsZone', request.dnsZone)}/tsig-key`
     }, 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}
      */
@@ -571,7 +580,7 @@ class RegistrarAPI extends API$1 {
      * @param options - The waiting options
      * @returns A Promise of Domain
      */
-    this.waitForDomain = (request, options) => waitForResource((options == null ? void 0 : options.stop) ?? (res => Promise.resolve(!DOMAIN_TRANSIENT_STATUSES.includes(res.status))), this.getDomain, request, options);
+    this.waitForDomain = (request, options) => waitForResource(options?.stop ?? (res => Promise.resolve(!DOMAIN_TRANSIENT_STATUSES.includes(res.status))), this.getDomain, request, options);
     /**
      * Update a domain. Update the domain contacts or create a new one.<br/> If
      * you add the same contact for multiple roles. Only one ID will be created

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

@@ -10,14 +10,15 @@ const jsonContentHeaders = {
   'Content-Type': 'application/json; charset=utf-8'
 };
 
-/** Flexible IP API. */
+/** Elastic Metal - Flexible IP API. */
 class API extends API$1 {
   constructor() {
     var _this;
     super(...arguments);
     _this = this;
     /**
-     * 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
@@ -29,7 +30,9 @@ class API extends API$1 {
       path: `/flexible-ip/v1alpha1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/fips`
     }, 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
@@ -45,7 +48,7 @@ class API extends API$1 {
      * @param options - The waiting options
      * @returns A Promise of FlexibleIP
      */
-    this.waitForFlexibleIP = (request, options) => waitForResource((options == null ? void 0 : options.stop) ?? (res => Promise.resolve(!FLEXIBLE_IP_TRANSIENT_STATUSES.includes(res.status))), this.getFlexibleIP, request, options);
+    this.waitForFlexibleIP = (request, options) => waitForResource(options?.stop ?? (res => Promise.resolve(!FLEXIBLE_IP_TRANSIENT_STATUSES.includes(res.status))), this.getFlexibleIP, request, options);
     this.pageOfListFlexibleIPs = function (request) {
       if (request === void 0) {
         request = {};
@@ -57,7 +60,7 @@ class API extends API$1 {
       }, 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
@@ -69,7 +72,9 @@ class API extends API$1 {
       return 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
@@ -81,7 +86,9 @@ class API extends API$1 {
       path: `/flexible-ip/v1alpha1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/fips/${validatePathParam('fipId', request.fipId)}`
     }, 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}
      */
@@ -90,7 +97,8 @@ class API extends API$1 {
       path: `/flexible-ip/v1alpha1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/fips/${validatePathParam('fipId', request.fipId)}`
     });
     /**
-     * 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
@@ -102,7 +110,8 @@ class API extends API$1 {
       path: `/flexible-ip/v1alpha1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/fips/attach`
     }, 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
@@ -114,7 +123,8 @@ class API extends API$1 {
       path: `/flexible-ip/v1alpha1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/fips/detach`
     }, 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
@@ -126,8 +136,9 @@ class API extends API$1 {
       path: `/flexible-ip/v1alpha1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/fips/${validatePathParam('fipId', request.fipId)}/mac`
     }, 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
@@ -139,8 +150,9 @@ class API extends API$1 {
       path: `/flexible-ip/v1alpha1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/fips/${validatePathParam('fipId', request.fipId)}/mac/duplicate`
     }, 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
@@ -152,7 +164,8 @@ class API extends API$1 {
       path: `/flexible-ip/v1alpha1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/fips/${validatePathParam('fipId', request.fipId)}/mac/move`
     }, 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}
      */