@scaleway/sdk 2.72.0 → 2.73.0

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

@@ -35,16 +35,14 @@ class API extends API$1 {
     unmarshalListDNSZonesResponse
   );
   /**
-   * List DNS zones. Retrieve the list of DNS zones you can manage and filter
-   * DNS zones associated with specific domain names.
+   * 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
    */
   listDNSZones = (request) => enrichForPagination("dnsZones", this.pageOfListDNSZones, request);
   /**
-   * Create a DNS zone. Create a new DNS zone specified by the domain name, the
-   * subdomain and the Project ID.
+   * 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
@@ -78,8 +76,7 @@ class API extends API$1 {
     unmarshalDNSZone
   );
   /**
-   * Clone a DNS zone. Clone an existing DNS zone with all its records into a
-   * new DNS zone.
+   * 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
@@ -132,33 +129,27 @@ class API extends API$1 {
     unmarshalListDNSZoneRecordsResponse
   );
   /**
-   * 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
-   */
+     * 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
+     */
   listDNSZoneRecords = (request) => enrichForPagination("records", this.pageOfListDNSZoneRecords, request);
   /**
-   * Update records within a DNS zone. Update records within a DNS zone that has
-   * default name servers and perform several actions on your records.
-   *
-   * Actions include:
-   *
-   * - 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.
-   *
-   * @param request - The request {@link UpdateDNSZoneRecordsRequest}
-   * @returns A Promise of UpdateDNSZoneRecordsResponse
-   */
+     * Update records within a DNS zone. Update records within a DNS zone that has default name servers and perform several actions on your records.
+  
+  Actions include:
+   - 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.
+     *
+     * @param request - The request {@link UpdateDNSZoneRecordsRequest}
+     * @returns A Promise of UpdateDNSZoneRecordsResponse
+     */
   updateDNSZoneRecords = (request) => this.client.fetch(
     {
       body: JSON.stringify(
@@ -171,8 +162,7 @@ class API extends API$1 {
     unmarshalUpdateDNSZoneRecordsResponse
   );
   /**
-   * List name servers within a DNS zone. Retrieve a list of name servers within
-   * a DNS zone and their optional glue records.
+   * 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
@@ -186,8 +176,7 @@ class API extends API$1 {
     unmarshalListDNSZoneNameserversResponse
   );
   /**
-   * Update name servers within a DNS zone. Update name servers within a DNS
-   * zone 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
@@ -204,12 +193,12 @@ class API extends API$1 {
     unmarshalUpdateDNSZoneNameserversResponse
   );
   /**
-   * 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
-   */
+     * 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
+     */
   clearDNSZoneRecords = (request) => this.client.fetch(
     {
       method: "DELETE",
@@ -218,8 +207,7 @@ class API extends API$1 {
     unmarshalClearDNSZoneRecordsResponse
   );
   /**
-   * Export a raw DNS zone. Export a DNS zone with default name servers, in a
-   * specific format.
+   * 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
@@ -231,8 +219,7 @@ class API extends API$1 {
     responseType: "blob"
   });
   /**
-   * Import a raw DNS zone. Import and replace the format of records from a
-   * given provider, with default name servers.
+   * 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
@@ -249,8 +236,7 @@ class API extends API$1 {
     unmarshalImportRawDNSZoneResponse
   );
   /**
-   * Import a DNS zone from another provider. Import and replace the format of
-   * records from a given provider, with default name servers.
+   * 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
@@ -267,13 +253,12 @@ class API extends API$1 {
     unmarshalImportProviderDNSZoneResponse
   );
   /**
-   * 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
-   */
+     * 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
+     */
   refreshDNSZone = (request) => this.client.fetch(
     {
       body: JSON.stringify(
@@ -300,13 +285,12 @@ class API extends API$1 {
     unmarshalListDNSZoneVersionsResponse
   );
   /**
-   * 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
-   */
+     * 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
+     */
   listDNSZoneVersions = (request) => enrichForPagination("versions", this.pageOfListDNSZoneVersions, request);
   pageOfListDNSZoneVersionRecords = (request) => this.client.fetch(
     {
@@ -323,8 +307,7 @@ class API extends API$1 {
     unmarshalListDNSZoneVersionRecordsResponse
   );
   /**
-   * List records from a given version of a specific DNS zone. Retrieve a list
-   * of records from a specific 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
@@ -335,8 +318,7 @@ class API extends API$1 {
     request
   );
   /**
-   * Access differences from a specific DNS zone version. Access a previous DNS
-   * zone version to see the differences from another specific 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
@@ -349,8 +331,7 @@ class API extends API$1 {
     unmarshalGetDNSZoneVersionDiffResponse
   );
   /**
-   * Restore a DNS zone version. Restore and activate a version of a specific
-   * DNS zone.
+   * 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
@@ -365,8 +346,7 @@ class API extends API$1 {
     unmarshalRestoreDNSZoneVersionResponse
   );
   /**
-   * 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`.
+   * 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
@@ -394,8 +374,7 @@ class API extends API$1 {
     options
   );
   /**
-   * Create or get the DNS zone's TLS certificate. Create a new TLS certificate
-   * or retrieve information about an existing 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
@@ -428,17 +407,14 @@ class API extends API$1 {
     unmarshalListSSLCertificatesResponse
   );
   /**
-   * 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.
+   * 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
    */
   listSSLCertificates = (request) => enrichForPagination("certificates", this.pageOfListSSLCertificates, request);
   /**
-   * Delete a TLS certificate. Delete an existing TLS certificate specified by
-   * its DNS zone. Deleting a TLS certificate is permanent and cannot be
-   * undone.
+   * 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
@@ -451,8 +427,7 @@ class API extends API$1 {
     unmarshalDeleteSSLCertificateResponse
   );
   /**
-   * Get the DNS zone's TSIG key. Retrieve information about the TSIG key of a
-   * given DNS zone to allow AXFR requests.
+   * 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
@@ -465,8 +440,7 @@ class API extends API$1 {
     unmarshalGetDNSZoneTsigKeyResponse
   );
   /**
-   * 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.
+   * 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}
    */
@@ -497,20 +471,20 @@ class RegistrarAPI extends API$1 {
     unmarshalListTasksResponse
   );
   /**
-   * List tasks. List all operations performed on the account. You can filter
-   * the list of tasks by domain name.
-   *
-   * @param request - The request {@link RegistrarApiListTasksRequest}
-   * @returns A Promise of ListTasksResponse
-   */
+     * List tasks. List all operations performed on the account.
+  You can filter the list of tasks by domain name.
+     *
+     * @param request - The request {@link RegistrarApiListTasksRequest}
+     * @returns A Promise of ListTasksResponse
+     */
   listTasks = (request = {}) => enrichForPagination("tasks", this.pageOfListTasks, request);
   /**
-   * Purchase domains. Request the registration of domain names. You can provide
-   * a domain's already existing contact or a new contact.
-   *
-   * @param request - The request {@link RegistrarApiBuyDomainsRequest}
-   * @returns A Promise of OrderResponse
-   */
+     * Purchase domains. Request the registration of domain names.
+  You can provide a domain's already existing contact or a new contact.
+     *
+     * @param request - The request {@link RegistrarApiBuyDomainsRequest}
+     * @returns A Promise of OrderResponse
+     */
   buyDomains = (request) => this.client.fetch(
     {
       body: JSON.stringify(
@@ -540,8 +514,7 @@ class RegistrarAPI extends API$1 {
     unmarshalOrderResponse
   );
   /**
-   * Transfer a domain. Request the transfer of a domain from another registrar
-   * to Scaleway Domains and DNS.
+   * Transfer a domain. Request the transfer of a domain from another registrar to Scaleway Domains and DNS.
    *
    * @param request - The request {@link RegistrarApiTransferInDomainRequest}
    * @returns A Promise of OrderResponse
@@ -561,18 +534,14 @@ class RegistrarAPI extends API$1 {
     unmarshalOrderResponse
   );
   /**
-   * Trade a domain's contact. Request to change a domain's contact owner.<br/>
-   * If you specify the `organization_id` of the domain's new owner, the contact
-   * will change from the current owner's Scaleway account to the new owner's
-   * Scaleway account.<br/> If the new owner's current contact information is
-   * not available, the first ever contact they have created for previous
-   * domains is taken into account to operate the change.<br/> If the new owner
-   * has never created a contact to register domains before, an error message
-   * displays.
-   *
-   * @param request - The request {@link RegistrarApiTradeDomainRequest}
-   * @returns A Promise of OrderResponse
-   */
+     * Trade a domain's contact. Request to change a domain's contact owner.<br/>
+  If you specify the `organization_id` of the domain's new owner, the contact will change from the current owner's Scaleway account to the new owner's Scaleway account.<br/>
+  If the new owner's current contact information is not available, the first ever contact they have created for previous domains is taken into account to operate the change.<br/>
+  If the new owner has never created a contact to register domains before, an error message displays.
+     *
+     * @param request - The request {@link RegistrarApiTradeDomainRequest}
+     * @returns A Promise of OrderResponse
+     */
   tradeDomain = (request) => this.client.fetch(
     {
       body: JSON.stringify(
@@ -585,11 +554,9 @@ class RegistrarAPI extends API$1 {
     unmarshalOrderResponse
   );
   /**
-   * Register an external domain. 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}
+   * @param request - The request {@link RegistrarApiRegisterExternalDomainRequest}
    * @returns A Promise of RegisterExternalDomainResponse
    */
   registerExternalDomain = (request) => this.client.fetch(
@@ -620,15 +587,12 @@ class RegistrarAPI extends API$1 {
     unmarshalDeleteExternalDomainResponse
   );
   /**
-   * Check if contacts are compatible with a domain or a TLD. Check whether
-   * contacts are compatible with a domain or a TLD. If contacts are not
-   * compatible with either the domain or the TLD, the information that needs to
-   * be corrected is returned.
-   *
-   * @param request - The request
-   *   {@link RegistrarApiCheckContactsCompatibilityRequest}
-   * @returns A Promise of CheckContactsCompatibilityResponse
-   */
+     * Check if contacts are compatible with a domain or a TLD. Check whether contacts are compatible with a domain or a TLD.
+  If contacts are not compatible with either the domain or the TLD, the information that needs to be corrected is returned.
+     *
+     * @param request - The request {@link RegistrarApiCheckContactsCompatibilityRequest}
+     * @returns A Promise of CheckContactsCompatibilityResponse
+     */
   checkContactsCompatibility = (request = {}) => this.client.fetch(
     {
       body: JSON.stringify(
@@ -663,16 +627,15 @@ class RegistrarAPI extends API$1 {
     unmarshalListContactsResponse
   );
   /**
-   * List contacts. Retrieve the list of contacts and their associated domains
-   * and roles. You can filter the list by domain name.
-   *
-   * @param request - The request {@link RegistrarApiListContactsRequest}
-   * @returns A Promise of ListContactsResponse
-   */
+     * List contacts. Retrieve the list of contacts and their associated domains and roles.
+  You can filter the list by domain name.
+     *
+     * @param request - The request {@link RegistrarApiListContactsRequest}
+     * @returns A Promise of ListContactsResponse
+     */
   listContacts = (request = {}) => enrichForPagination("contacts", this.pageOfListContacts, request);
   /**
-   * Get a contact. Retrieve a contact's details from the registrar using the
-   * given contact's ID.
+   * Get a contact. Retrieve a contact's details from the registrar using the given contact's ID.
    *
    * @param request - The request {@link RegistrarApiGetContactRequest}
    * @returns A Promise of Contact
@@ -750,17 +713,14 @@ class RegistrarAPI extends API$1 {
     unmarshalListRenewableDomainsResponse
   );
   /**
-   * List domains that can be renewed. Retrieve the list of domains you own that
-   * can be renewed. You can also see the maximum renewal duration in years for
-   * your domains that are renewable.
+   * List domains that can be renewed. Retrieve the list of domains you own that can be renewed. You can also see the maximum renewal duration in years for your domains that are renewable.
    *
    * @param request - The request {@link RegistrarApiListRenewableDomainsRequest}
    * @returns A Promise of ListRenewableDomainsResponse
    */
   listRenewableDomains = (request = {}) => enrichForPagination("domains", this.pageOfListRenewableDomains, request);
   /**
-   * Get domain. Retrieve a specific domain and display the domain's
-   * information.
+   * Get domain. Retrieve a specific domain and display the domain's information.
    *
    * @param request - The request {@link RegistrarApiGetDomainRequest}
    * @returns A Promise of Domain
@@ -788,14 +748,12 @@ class RegistrarAPI extends API$1 {
     options
   );
   /**
-   * Update a domain's contacts. Update contacts for a specific domain or create
-   * a new contact.<br/> If you add the same contact for multiple roles (owner,
-   * administrative, technical), only one ID will be created and used for all of
-   * the roles.
-   *
-   * @param request - The request {@link RegistrarApiUpdateDomainRequest}
-   * @returns A Promise of Domain
-   */
+     * Update a domain's contacts. Update contacts for a specific domain or create a new contact.<br/>
+  If you add the same contact for multiple roles (owner, administrative, technical), only one ID will be created and used for all of the roles.
+     *
+     * @param request - The request {@link RegistrarApiUpdateDomainRequest}
+     * @returns A Promise of Domain
+     */
   updateDomain = (request) => this.client.fetch(
     {
       body: JSON.stringify(
@@ -808,9 +766,7 @@ class RegistrarAPI extends API$1 {
     unmarshalDomain
   );
   /**
-   * Lock the transfer of a domain. Lock the transfer of a domain. This means
-   * that the domain cannot be transferred and the authorization code cannot be
-   * requested to your current registrar.
+   * Lock the transfer of a domain. Lock the transfer of a domain. This means that the domain cannot be transferred and the authorization code cannot be requested to your current registrar.
    *
    * @param request - The request {@link RegistrarApiLockDomainTransferRequest}
    * @returns A Promise of Domain
@@ -825,9 +781,7 @@ class RegistrarAPI extends API$1 {
     unmarshalDomain
   );
   /**
-   * Unlock the transfer of a domain. Unlock the transfer of a domain. This
-   * means that the domain can be transferred and the authorization code can be
-   * requested to your current registrar.
+   * Unlock the transfer of a domain. Unlock the transfer of a domain. This means that the domain can be transferred and the authorization code can be requested to your current registrar.
    *
    * @param request - The request {@link RegistrarApiUnlockDomainTransferRequest}
    * @returns A Promise of Domain
@@ -842,11 +796,9 @@ class RegistrarAPI extends API$1 {
     unmarshalDomain
   );
   /**
-   * Enable auto renew. Enable the `auto renew` feature for a domain. This means
-   * the domain will be automatically renewed before its expiry date.
+   * Enable auto renew. Enable the `auto renew` feature for a domain. This means the domain will be automatically renewed before its expiry date.
    *
-   * @param request - The request
-   *   {@link RegistrarApiEnableDomainAutoRenewRequest}
+   * @param request - The request {@link RegistrarApiEnableDomainAutoRenewRequest}
    * @returns A Promise of Domain
    */
   enableDomainAutoRenew = (request) => this.client.fetch(
@@ -859,11 +811,9 @@ class RegistrarAPI extends API$1 {
     unmarshalDomain
   );
   /**
-   * Disable auto renew. Disable the `auto renew` feature for a domain. This
-   * means the domain will not be renewed before its expiry date.
+   * Disable auto renew. Disable the `auto renew` feature for a domain. This means the domain will not be renewed before its expiry date.
    *
-   * @param request - The request
-   *   {@link RegistrarApiDisableDomainAutoRenewRequest}
+   * @param request - The request {@link RegistrarApiDisableDomainAutoRenewRequest}
    * @returns A Promise of Domain
    */
   disableDomainAutoRenew = (request) => this.client.fetch(
@@ -876,15 +826,12 @@ class RegistrarAPI extends API$1 {
     unmarshalDomain
   );
   /**
-   * Get a domain's authorization code. Retrieve the authorization code to
-   * tranfer an unlocked domain. The output returns an error if the domain is
-   * locked. Some TLDs may have a different procedure to retrieve the
-   * authorization code. In that case, the information displays in the message
-   * field.
-   *
-   * @param request - The request {@link RegistrarApiGetDomainAuthCodeRequest}
-   * @returns A Promise of GetDomainAuthCodeResponse
-   */
+     * Get a domain's authorization code. Retrieve the authorization code to tranfer an unlocked domain. The output returns an error if the domain is locked.
+  Some TLDs may have a different procedure to retrieve the authorization code. In that case, the information displays in the message field.
+     *
+     * @param request - The request {@link RegistrarApiGetDomainAuthCodeRequest}
+     * @returns A Promise of GetDomainAuthCodeResponse
+     */
   getDomainAuthCode = (request) => this.client.fetch(
     {
       method: "GET",
@@ -893,9 +840,7 @@ class RegistrarAPI extends API$1 {
     unmarshalGetDomainAuthCodeResponse
   );
   /**
-   * Update domain DNSSEC. If your domain uses another registrar and has the
-   * default Scaleway NS, you have to **update the DS record at your
-   * registrar**.
+   * Update domain DNSSEC. If your domain uses another registrar and has the default Scaleway NS, you have to **update the DS record at your registrar**.
    *
    * @param request - The request {@link RegistrarApiEnableDomainDNSSECRequest}
    * @returns A Promise of Domain
@@ -930,16 +875,13 @@ class RegistrarAPI extends API$1 {
     unmarshalDomain
   );
   /**
-   * Search available domains. Search a domain or a maximum of 10 domains that
-   * are available.
-   *
-   * If the TLD list is empty or not set, the search returns the results from
-   * the most popular TLDs.
-   *
-   * @param request - The request
-   *   {@link RegistrarApiSearchAvailableDomainsRequest}
-   * @returns A Promise of SearchAvailableDomainsResponse
-   */
+     * Search available domains. Search a domain or a maximum of 10 domains that are available.
+  
+  If the TLD list is empty or not set, the search returns the results from the most popular TLDs.
+     *
+     * @param request - The request {@link RegistrarApiSearchAvailableDomainsRequest}
+     * @returns A Promise of SearchAvailableDomainsResponse
+     */
   searchAvailableDomains = (request) => this.client.fetch(
     {
       method: "GET",
@@ -976,8 +918,7 @@ class RegistrarAPI extends API$1 {
    */
   listTlds = (request = {}) => enrichForPagination("tlds", this.pageOfListTlds, request);
   /**
-   * Create a hostname for a domain. Create a hostname for a domain with glue
-   * IPs.
+   * Create a hostname for a domain. Create a hostname for a domain with glue IPs.
    *
    * @param request - The request {@link RegistrarApiCreateDomainHostRequest}
    * @returns A Promise of Host

package/dist/api/domain/v2beta1/content.gen.d.ts

@@ -3,10 +3,7 @@ import type { DNSZoneStatus, DomainFeatureStatus, DomainRegistrationStatusTransf
 export declare const DNS_ZONE_TRANSIENT_STATUSES: DNSZoneStatus[];
 /** Lists transient statutes of the enum {@link DomainFeatureStatus}. */
 export declare const DOMAIN_FEATURE_TRANSIENT_STATUSES: DomainFeatureStatus[];
-/**
- * Lists transient statutes of the enum
- * {@link DomainRegistrationStatusTransferStatus}.
- */
+/** Lists transient statutes of the enum {@link DomainRegistrationStatusTransferStatus}. */
 export declare const DOMAIN_REGISTRATION_STATUS_TRANSFER_TRANSIENT_STATUSES: DomainRegistrationStatusTransferStatus[];
 /** Lists transient statutes of the enum {@link DomainStatus}. */
 export declare const DOMAIN_TRANSIENT_STATUSES: DomainStatus[];