@scaleway/sdk 1.2.0 → 1.5.0

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

@@ -13,7 +13,7 @@ const jsonContentHeaders = {
 /**
  * DNS API.
  *
- * Manage your DNS zones and records.
+ * DNS API. Manage your DNS zones and records.
  */
 class API extends API$1 {
   constructor() {
@@ -24,15 +24,15 @@ 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);
     /**
-     * Returns a list of manageable DNS zones. You can filter the DNS zones by
-     * domain name.
+     * List DNS zones. Returns a list of manageable DNS zones. You can filter the
+     * DNS zones by domain name.
      *
      * @param request - The request {@link ListDNSZonesRequest}
      * @returns A Promise of ListDNSZonesResponse
      */
     this.listDNSZones = request => enrichForPagination('dnsZones', this.pageOfListDNSZones, request);
     /**
-     * Create a new DNS zone.
+     * Create a DNS zone. Create a new DNS zone.
      *
      * @param request - The request {@link CreateDNSZoneRequest}
      * @returns A Promise of DNSZone
@@ -44,7 +44,7 @@ class API extends API$1 {
       path: `/domain/v2beta1/dns-zones`
     }, unmarshalDNSZone);
     /**
-     * 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,7 +56,8 @@ class API extends API$1 {
       path: `/domain/v2beta1/dns-zones/${validatePathParam('dnsZone', request.dnsZone)}`
     }, unmarshalDNSZone);
     /**
-     * Clone an existed DNS zone with all its records into a new one.
+     * Clone a DNS zone. Clone an existed DNS zone with all its records into a new
+     * one.
      *
      * @param request - The request {@link CloneDNSZoneRequest}
      * @returns A Promise of DNSZone
@@ -68,7 +69,7 @@ class API extends API$1 {
       path: `/domain/v2beta1/dns-zones/${validatePathParam('dnsZone', request.dnsZone)}/clone`
     }, unmarshalDNSZone);
     /**
-     * Delete a DNS zone and all it's records.
+     * Delete DNS zone. Delete a DNS zone and all it's records.
      *
      * @param request - The request {@link DeleteDNSZoneRequest}
      * @returns A Promise of DeleteDNSZoneResponse
@@ -84,15 +85,16 @@ 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);
     /**
-     * Returns a list of DNS records of a DNS zone with default NS. You can filter
-     * the records by type and name.
+     * 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.
      *
      * @param request - The request {@link ListDNSZoneRecordsRequest}
      * @returns A Promise of ListDNSZoneRecordsResponse
      */
     this.listDNSZoneRecords = request => enrichForPagination('records', this.pageOfListDNSZoneRecords, request);
     /**
-     * Only available with default NS.<br/> Send a list of actions and records.
+     * Update DNS zone records. Only available with default NS.<br/> Send a list
+     * of actions and records.
      *
      * Action can be:
      *
@@ -120,8 +122,8 @@ class API extends API$1 {
       path: `/domain/v2beta1/dns-zones/${validatePathParam('dnsZone', request.dnsZone)}/records`
     }, unmarshalUpdateDNSZoneRecordsResponse);
     /**
-     * Returns a list of Nameservers and their optional glue records for a DNS
-     * zone.
+     * List DNS zone nameservers. Returns a list of Nameservers and their optional
+     * glue records for a DNS zone.
      *
      * @param request - The request {@link ListDNSZoneNameserversRequest}
      * @returns A Promise of ListDNSZoneNameserversResponse
@@ -132,7 +134,8 @@ class API extends API$1 {
       urlParams: urlParams(['project_id', request.projectId])
     }, unmarshalListDNSZoneNameserversResponse);
     /**
-     * Update DNS zone nameservers and set optional glue records.
+     * Update DNS zone nameservers. Update DNS zone nameservers and set optional
+     * glue records.
      *
      * @param request - The request {@link UpdateDNSZoneNameserversRequest}
      * @returns A Promise of UpdateDNSZoneNameserversResponse
@@ -144,8 +147,8 @@ class API extends API$1 {
       path: `/domain/v2beta1/dns-zones/${validatePathParam('dnsZone', request.dnsZone)}/nameservers`
     }, unmarshalUpdateDNSZoneNameserversResponse);
     /**
-     * Only available with default NS.<br/> Delete all the records from a DNS
-     * zone. All edits will be versioned.
+     * Clear DNS zone records. Only available with default NS.<br/> Delete all the
+     * records from a DNS zone. All edits will be versioned.
      *
      * @param request - The request {@link ClearDNSZoneRecordsRequest}
      * @returns A Promise of ClearDNSZoneRecordsResponse
@@ -155,7 +158,7 @@ class API extends API$1 {
       path: `/domain/v2beta1/dns-zones/${validatePathParam('dnsZone', request.dnsZone)}/records`
     }, unmarshalClearDNSZoneRecordsResponse);
     /**
-     * Get a DNS zone in a given format with default NS.
+     * Export raw DNS zone. Get a DNS zone in a given format with default NS.
      *
      * @param request - The request {@link ExportRawDNSZoneRequest}
      * @returns A Promise of Blob
@@ -167,7 +170,8 @@ class API extends API$1 {
       responseType: 'blob'
     });
     /**
-     * Import and replace records from a given provider format with default NS.
+     * Import raw DNS zone. Import and replace records from a given provider
+     * format with default NS.
      *
      * @param request - The request {@link ImportRawDNSZoneRequest}
      * @returns A Promise of ImportRawDNSZoneResponse
@@ -179,7 +183,8 @@ class API extends API$1 {
       path: `/domain/v2beta1/dns-zones/${validatePathParam('dnsZone', request.dnsZone)}/raw`
     }, unmarshalImportRawDNSZoneResponse);
     /**
-     * Import and replace records from a given provider format with default NS.
+     * Import provider DNS zone. Import and replace records from a given provider
+     * format with default NS.
      *
      * @param request - The request {@link ImportProviderDNSZoneRequest}
      * @returns A Promise of ImportProviderDNSZoneResponse
@@ -191,8 +196,8 @@ class API extends API$1 {
       path: `/domain/v2beta1/dns-zones/${validatePathParam('dnsZone', request.dnsZone)}/import-provider`
     }, unmarshalImportProviderDNSZoneResponse);
     /**
-     * Refresh SOA DNS zone. You can recreate the given DNS zone and its sub DNS
-     * zone if needed.
+     * Refresh DNS zone. Refresh SOA DNS zone. 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
@@ -209,9 +214,9 @@ class API extends API$1 {
       urlParams: urlParams(['page', request.page], ['page_size', request.pageSize ?? this.client.settings.defaultPageSize])
     }, unmarshalListDNSZoneVersionsResponse);
     /**
-     * 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 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.
      *
      * @param request - The request {@link ListDNSZoneVersionsRequest}
      * @returns A Promise of ListDNSZoneVersionsResponse
@@ -223,14 +228,16 @@ class API extends API$1 {
       urlParams: urlParams(['page', request.page], ['page_size', request.pageSize ?? this.client.settings.defaultPageSize])
     }, unmarshalListDNSZoneVersionRecordsResponse);
     /**
-     * Get a list of records from a previous DNS zone version.
+     * List DNS zone version records. Get a list of records from a previous DNS
+     * zone version.
      *
      * @param request - The request {@link ListDNSZoneVersionRecordsRequest}
      * @returns A Promise of ListDNSZoneVersionRecordsResponse
      */
     this.listDNSZoneVersionRecords = request => enrichForPagination('records', this.pageOfListDNSZoneVersionRecords, request);
     /**
-     * Get all differences from a previous DNS zone version.
+     * Get DNS zone version diff. Get all differences from a previous DNS zone
+     * version.
      *
      * @param request - The request {@link GetDNSZoneVersionDiffRequest}
      * @returns A Promise of GetDNSZoneVersionDiffResponse
@@ -240,7 +247,7 @@ class API extends API$1 {
       path: `/domain/v2beta1/dns-zones/version/${validatePathParam('dnsZoneVersionId', request.dnsZoneVersionId)}/diff`
     }, unmarshalGetDNSZoneVersionDiffResponse);
     /**
-     * Restore and activate a previous DNS zone version.
+     * Restore DNS zone version. Restore and activate a previous DNS zone version.
      *
      * @param request - The request {@link RestoreDNSZoneVersionRequest}
      * @returns A Promise of RestoreDNSZoneVersionResponse
@@ -252,7 +259,7 @@ 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 the zone TLS certificate if it exists.
      *
      * @param request - The request {@link GetSSLCertificateRequest}
      * @returns A Promise of SSLCertificate
@@ -270,7 +277,7 @@ class API extends API$1 {
      */
     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);
     /**
-     * Create or return the zone TLS certificate
+     * Create or return the zone TLS certificate.
      *
      * @param request - The request {@link CreateSSLCertificateRequest}
      * @returns A Promise of SSLCertificate
@@ -287,14 +294,14 @@ 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 all user TLS certificates.
      *
      * @param request - The request {@link ListSSLCertificatesRequest}
      * @returns A Promise of ListSSLCertificatesResponse
      */
     this.listSSLCertificates = request => enrichForPagination('certificates', this.pageOfListSSLCertificates, request);
     /**
-     * Delete an TLS certificate
+     * Delete an TLS certificate.
      *
      * @param request - The request {@link DeleteSSLCertificateRequest}
      * @returns A Promise of DeleteSSLCertificateResponse
@@ -304,7 +311,7 @@ class API extends API$1 {
       path: `/domain/v2beta1/ssl-certificates/${validatePathParam('dnsZone', request.dnsZone)}`
     }, unmarshalDeleteSSLCertificateResponse);
     /**
-     * Get the DNS zone TSIG Key to allow AXFR request.
+     * Get the DNS zone TSIG Key. Get the DNS zone TSIG Key to allow AXFR request.
      *
      * @param request - The request {@link GetDNSZoneTsigKeyRequest}
      * @returns A Promise of GetDNSZoneTsigKeyResponse
@@ -314,7 +321,7 @@ 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 TSIG Key.
      *
      * @param request - The request {@link DeleteDNSZoneTsigKeyRequest}
      */
@@ -328,7 +335,7 @@ class API extends API$1 {
 /**
  * Domains registrar API.
  *
- * Manage your domains and contacts.
+ * Domains registrar API. Manage your domains and contacts.
  */
 class RegistrarAPI extends API$1 {
   constructor() {
@@ -346,7 +353,7 @@ class RegistrarAPI extends API$1 {
       }, unmarshalListTasksResponse);
     };
     /**
-     * List all account tasks. You can filter the list by domain name.
+     * List tasks. List all account tasks. You can filter the list by domain name.
      *
      * @param request - The request {@link RegistrarApiListTasksRequest}
      * @returns A Promise of ListTasksResponse
@@ -358,8 +365,8 @@ class RegistrarAPI extends API$1 {
       return enrichForPagination('tasks', _this.pageOfListTasks, request);
     };
     /**
-     * Request the registration of domain names. You can provide an already
-     * existing domain's contact or a new contact.
+     * Buy one or more domains. Request the registration of domain names. You can
+     * provide an already existing domain's contact or a new contact.
      *
      * @param request - The request {@link RegistrarApiBuyDomainsRequest}
      * @returns A Promise of OrderResponse
@@ -371,7 +378,7 @@ class RegistrarAPI extends API$1 {
       path: `/domain/v2beta1/buy-domains`
     }, unmarshalOrderResponse);
     /**
-     * Request the renewal of domain names.
+     * Renew one or more domains. Request the renewal of domain names.
      *
      * @param request - The request {@link RegistrarApiRenewDomainsRequest}
      * @returns A Promise of OrderResponse
@@ -383,7 +390,8 @@ class RegistrarAPI extends API$1 {
       path: `/domain/v2beta1/renew-domains`
     }, unmarshalOrderResponse);
     /**
-     * Request the transfer from another registrar domain to Scaleway.
+     * Transfer a domain. Request the transfer from another registrar domain to
+     * Scaleway.
      *
      * @param request - The request {@link RegistrarApiTransferInDomainRequest}
      * @returns A Promise of OrderResponse
@@ -395,11 +403,11 @@ class RegistrarAPI extends API$1 {
       path: `/domain/v2beta1/domains/transfer-domains`
     }, unmarshalOrderResponse);
     /**
-     * Request a trade for the contact owner.<br/> If an `organization_id` is
-     * given, the change is from the current Scaleway account to another Scaleway
-     * account.<br/> If no contact is given, the first contact of the other
-     * Scaleway account is taken.<br/> If the other Scaleway account has no
-     * contact. An error occurs.
+     * Trade a domain contact. Request a trade for the contact owner.<br/> If an
+     * `organization_id` is given, the change is from the current Scaleway account
+     * to another Scaleway account.<br/> If no contact is given, the first contact
+     * of the other Scaleway account is taken.<br/> If the other Scaleway account
+     * has no contact. An error occurs.
      *
      * @param request - The request {@link RegistrarApiTradeDomainRequest}
      * @returns A Promise of OrderResponse
@@ -411,7 +419,8 @@ class RegistrarAPI extends API$1 {
       path: `/domain/v2beta1/domains/${validatePathParam('domain', request.domain)}/trade`
     }, unmarshalOrderResponse);
     /**
-     * Request the registration of an external domain name.
+     * Register an external domain. Request the registration of an external domain
+     * name.
      *
      * @param request - The request
      *   {@link RegistrarApiRegisterExternalDomainRequest}
@@ -424,7 +433,7 @@ class RegistrarAPI extends API$1 {
       path: `/domain/v2beta1/external-domains`
     }, unmarshalRegisterExternalDomainResponse);
     /**
-     * Delete an external domain name.
+     * Delete an external domain. Delete an external domain name.
      *
      * @param request - The request {@link RegistrarApiDeleteExternalDomainRequest}
      * @returns A Promise of DeleteExternalDomainResponse
@@ -434,8 +443,9 @@ class RegistrarAPI extends API$1 {
       path: `/domain/v2beta1/external-domains/${validatePathParam('domain', request.domain)}`
     }, unmarshalDeleteExternalDomainResponse);
     /**
-     * Check if contacts are compatible against a domain or a tld. If not, it will
-     * return the information requiring a correction.
+     * Check if contacts are compatible against a domain or a tld. Check if
+     * contacts are compatible against a domain or a tld. If not, it will return
+     * the information requiring a correction.
      *
      * @param request - The request
      *   {@link RegistrarApiCheckContactsCompatibilityRequest}
@@ -463,8 +473,8 @@ class RegistrarAPI extends API$1 {
       }, unmarshalListContactsResponse);
     };
     /**
-     * Return a list of contacts with their domains and roles. You can filter the
-     * list by domain name.
+     * List contacts. Return a list of contacts with their domains and roles. You
+     * can filter the list by domain name.
      *
      * @param request - The request {@link RegistrarApiListContactsRequest}
      * @returns A Promise of ListContactsResponse
@@ -476,8 +486,8 @@ class RegistrarAPI extends API$1 {
       return enrichForPagination('contacts', _this.pageOfListContacts, request);
     };
     /**
-     * Return a contact details retrieved from the registrar using a given contact
-     * ID.
+     * Get a contact. Return a contact details retrieved from the registrar using
+     * a given contact ID.
      *
      * @param request - The request {@link RegistrarApiGetContactRequest}
      * @returns A Promise of Contact
@@ -487,7 +497,7 @@ class RegistrarAPI extends API$1 {
       path: `/domain/v2beta1/contacts/${validatePathParam('contactId', request.contactId)}`
     }, unmarshalContact);
     /**
-     * You can edit the contact coordinates.
+     * Update contact. You can edit the contact coordinates.
      *
      * @param request - The request {@link RegistrarApiUpdateContactRequest}
      * @returns A Promise of Contact
@@ -509,7 +519,7 @@ class RegistrarAPI extends API$1 {
       }, unmarshalListDomainsResponse);
     };
     /**
-     * Returns a list of domains owned by the user.
+     * List domains. Returns a list of domains owned by the user.
      *
      * @param request - The request {@link RegistrarApiListDomainsRequest}
      * @returns A Promise of ListDomainsResponse
@@ -531,8 +541,9 @@ class RegistrarAPI extends API$1 {
       }, unmarshalListRenewableDomainsResponse);
     };
     /**
-     * Returns a list of domains owned by the user with a renew status and if
-     * renewable, the maximum renew duration in years.
+     * List scaleway domains that can or not be renewed. Returns a list of domains
+     * owned by the user with a renew status and if renewable, the maximum renew
+     * duration in years.
      *
      * @param request - The request {@link RegistrarApiListRenewableDomainsRequest}
      * @returns A Promise of ListRenewableDomainsResponse
@@ -544,7 +555,7 @@ class RegistrarAPI extends API$1 {
       return enrichForPagination('domains', _this.pageOfListRenewableDomains, request);
     };
     /**
-     * Returns a the domain with more informations.
+     * Get domain. Returns a the domain with more informations.
      *
      * @param request - The request {@link RegistrarApiGetDomainRequest}
      * @returns A Promise of Domain
@@ -562,9 +573,9 @@ class RegistrarAPI extends API$1 {
      */
     this.waitForDomain = (request, options) => waitForResource((options == null ? void 0 : options.stop) ?? (res => Promise.resolve(!DOMAIN_TRANSIENT_STATUSES.includes(res.status))), this.getDomain, request, options);
     /**
-     * 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 and used for all of
-     * them.
+     * 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
+     * and used for all of them.
      *
      * @param request - The request {@link RegistrarApiUpdateDomainRequest}
      * @returns A Promise of Domain
@@ -576,8 +587,8 @@ class RegistrarAPI extends API$1 {
       path: `/domain/v2beta1/domains/${validatePathParam('domain', request.domain)}`
     }, unmarshalDomain);
     /**
-     * Lock domain transfer. A locked domain transfer can't be transferred and the
-     * auth code can't be requested.
+     * Lock domain transfer. Lock domain transfer. A locked domain transfer can't
+     * be transferred and the auth code can't be requested.
      *
      * @param request - The request {@link RegistrarApiLockDomainTransferRequest}
      * @returns A Promise of Domain
@@ -589,8 +600,8 @@ class RegistrarAPI extends API$1 {
       path: `/domain/v2beta1/domains/${validatePathParam('domain', request.domain)}/lock-transfer`
     }, unmarshalDomain);
     /**
-     * Unlock domain transfer. An unlocked domain can be transferred and the auth
-     * code can be requested for this.
+     * Unlock domain transfer. Unlock domain transfer. An unlocked domain can be
+     * transferred and the auth code can be requested for this.
      *
      * @param request - The request {@link RegistrarApiUnlockDomainTransferRequest}
      * @returns A Promise of Domain
@@ -602,7 +613,7 @@ class RegistrarAPI extends API$1 {
       path: `/domain/v2beta1/domains/${validatePathParam('domain', request.domain)}/unlock-transfer`
     }, unmarshalDomain);
     /**
-     * Enable domain auto renew
+     * Enable domain auto renew.
      *
      * @param request - The request
      *   {@link RegistrarApiEnableDomainAutoRenewRequest}
@@ -615,7 +626,7 @@ class RegistrarAPI extends API$1 {
       path: `/domain/v2beta1/domains/${validatePathParam('domain', request.domain)}/enable-auto-renew`
     }, unmarshalDomain);
     /**
-     * Disable domain auto renew
+     * Disable domain auto renew.
      *
      * @param request - The request
      *   {@link RegistrarApiDisableDomainAutoRenewRequest}
@@ -628,10 +639,10 @@ class RegistrarAPI extends API$1 {
       path: `/domain/v2beta1/domains/${validatePathParam('domain', request.domain)}/disable-auto-renew`
     }, unmarshalDomain);
     /**
-     * If possible, return the auth code for an unlocked domain transfer, or an
-     * error if the domain is locked. Some TLD may have a different procedure to
-     * retrieve the auth code, in that case, the information is given in the
-     * message field.
+     * Return domain auth code. If possible, return the auth code for an unlocked
+     * domain transfer, or an error if the domain is locked. Some TLD may have a
+     * different procedure to retrieve the auth code, in that case, the
+     * information is given in the message field.
      *
      * @param request - The request {@link RegistrarApiGetDomainAuthCodeRequest}
      * @returns A Promise of GetDomainAuthCodeResponse
@@ -641,9 +652,9 @@ class RegistrarAPI extends API$1 {
       path: `/domain/v2beta1/domains/${validatePathParam('domain', request.domain)}/auth-code`
     }, unmarshalGetDomainAuthCodeResponse);
     /**
-     * If your domain has the default Scaleway NS and uses another registrar, you
-     * have to update the DS record manually. For the algorithm, here are the code
-     * numbers for each type:
+     * Update domain DNSSEC. If your domain has the default Scaleway NS and uses
+     * another registrar, you have to update the DS record manually. For the
+     * algorithm, here are the code numbers for each type:
      *
      * - 1: RSAMD5
      * - 2: DIFFIE_HELLMAN
@@ -674,7 +685,7 @@ class RegistrarAPI extends API$1 {
       path: `/domain/v2beta1/domains/${validatePathParam('domain', request.domain)}/enable-dnssec`
     }, unmarshalDomain);
     /**
-     * Disable domain DNSSEC
+     * Disable domain DNSSEC.
      *
      * @param request - The request {@link RegistrarApiDisableDomainDNSSECRequest}
      * @returns A Promise of Domain
@@ -686,7 +697,7 @@ class RegistrarAPI extends API$1 {
       path: `/domain/v2beta1/domains/${validatePathParam('domain', request.domain)}/disable-dnssec`
     }, unmarshalDomain);
     /**
-     * Search a domain (or at maximum, 10 domains).
+     * Search available domains. Search a domain (or at maximum, 10 domains).
      *
      * If the TLD list is empty or not set the search returns the results from the
      * most popular TLDs.
@@ -701,7 +712,7 @@ class RegistrarAPI extends API$1 {
       urlParams: urlParams(['domains', request.domains], ['strict_search', request.strictSearch], ['tlds', request.tlds])
     }, unmarshalSearchAvailableDomainsResponse);
     /**
-     * Create domain hostname with glue IPs
+     * Create domain hostname with glue IPs.
      *
      * @param request - The request {@link RegistrarApiCreateDomainHostRequest}
      * @returns A Promise of Host
@@ -718,14 +729,14 @@ class RegistrarAPI extends API$1 {
       urlParams: urlParams(['page', request.page], ['page_size', request.pageSize ?? this.client.settings.defaultPageSize])
     }, unmarshalListDomainHostsResponse);
     /**
-     * List domain hostnames with they glue IPs
+     * List domain hostnames with they glue IPs.
      *
      * @param request - The request {@link RegistrarApiListDomainHostsRequest}
      * @returns A Promise of ListDomainHostsResponse
      */
     this.listDomainHosts = request => enrichForPagination('hosts', this.pageOfListDomainHosts, request);
     /**
-     * Update domain hostname with glue IPs
+     * Update domain hostname with glue IPs.
      *
      * @param request - The request {@link RegistrarApiUpdateDomainHostRequest}
      * @returns A Promise of Host
@@ -737,7 +748,7 @@ class RegistrarAPI extends API$1 {
       path: `/domain/v2beta1/domains/${validatePathParam('domain', request.domain)}/hosts/${validatePathParam('name', request.name)}`
     }, unmarshalHost);
     /**
-     * Delete domain hostname
+     * Delete domain hostname.
      *
      * @param request - The request {@link RegistrarApiDeleteDomainHostRequest}
      * @returns A Promise of Host

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

@@ -17,7 +17,7 @@ class API extends API$1 {
     super(...arguments);
     _this = this;
     /**
-     * Create a Flexible IP
+     * Create a Flexible IP.
      *
      * @param request - The request {@link CreateFlexibleIPRequest}
      * @returns A Promise of FlexibleIP
@@ -29,7 +29,7 @@ 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 a Flexible IP.
      *
      * @param request - The request {@link GetFlexibleIPRequest}
      * @returns A Promise of FlexibleIP
@@ -57,7 +57,7 @@ class API extends API$1 {
       }, unmarshalListFlexibleIPsResponse);
     };
     /**
-     * List Flexible IPs
+     * List Flexible IPs.
      *
      * @param request - The request {@link ListFlexibleIPsRequest}
      * @returns A Promise of ListFlexibleIPsResponse
@@ -69,7 +69,7 @@ class API extends API$1 {
       return enrichForPagination('flexibleIps', _this.pageOfListFlexibleIPs, request);
     };
     /**
-     * Update a Flexible IP
+     * Update a Flexible IP.
      *
      * @param request - The request {@link UpdateFlexibleIPRequest}
      * @returns A Promise of FlexibleIP
@@ -81,7 +81,7 @@ 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 a Flexible IP.
      *
      * @param request - The request {@link DeleteFlexibleIPRequest}
      */
@@ -90,7 +90,7 @@ class API extends API$1 {
       path: `/flexible-ip/v1alpha1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/fips/${validatePathParam('fipId', request.fipId)}`
     });
     /**
-     * Attach a Flexible IP to a server
+     * Attach a Flexible IP to a server.
      *
      * @param request - The request {@link AttachFlexibleIPRequest}
      * @returns A Promise of AttachFlexibleIPsResponse
@@ -102,7 +102,7 @@ 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 a Flexible IP from a server.
      *
      * @param request - The request {@link DetachFlexibleIPRequest}
      * @returns A Promise of DetachFlexibleIPsResponse
@@ -114,7 +114,7 @@ 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 on a given Flexible IP.
      *
      * @param request - The request {@link GenerateMACAddrRequest}
      * @returns A Promise of FlexibleIP
@@ -126,8 +126,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`
     }, unmarshalFlexibleIP);
     /**
-     * Duplicate a Virtual MAC from a given Flexible IP onto another attached on
-     * the same server.
+     * Duplicate a Virtual MAC. Duplicate a Virtual MAC from a given Flexible IP
+     * onto another attached on the same server.
      *
      * @param request - The request {@link DuplicateMACAddrRequest}
      * @returns A Promise of FlexibleIP
@@ -138,6 +138,13 @@ class API extends API$1 {
       method: 'POST',
       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.
+     *
+     * @param request - The request {@link MoveMACAddrRequest}
+     * @returns A Promise of FlexibleIP
+     */
     this.moveMACAddr = request => this.client.fetch({
       body: JSON.stringify(marshalMoveMACAddrRequest(request, this.client.settings)),
       headers: jsonContentHeaders,
@@ -145,7 +152,7 @@ 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
+     * Remove a virtual MAC from a Flexible IP.
      *
      * @param request - The request {@link DeleteMACAddrRequest}
      */