@scaleway/sdk 1.0.0 → 1.1.0

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

@@ -21,27 +21,58 @@ class API extends API$1 {
     this.pageOfListDNSZones = request => this.client.fetch({
       method: 'GET',
       path: `/domain/v2beta1/dns-zones`,
-      urlParams: urlParams(['dns_zone', request.dnsZone], ['domain', request.domain], ['order_by', request.orderBy ?? 'domain_asc'], ['organization_id', request.organizationId ?? this.client.settings.defaultOrganizationId], ['page', request.page], ['page_size', request.pageSize ?? this.client.settings.defaultPageSize], ['project_id', request.projectId ?? this.client.settings.defaultProjectId])
+      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.
+     *
+     * @param request - The request {@link ListDNSZonesRequest}
+     * @returns A Promise of ListDNSZonesResponse
+     */
     this.listDNSZones = request => enrichForPagination('dnsZones', this.pageOfListDNSZones, request);
+    /**
+     * Create a new DNS zone.
+     *
+     * @param request - The request {@link CreateDNSZoneRequest}
+     * @returns A Promise of DNSZone
+     */
     this.createDNSZone = request => this.client.fetch({
       body: JSON.stringify(marshalCreateDNSZoneRequest(request, this.client.settings)),
       headers: jsonContentHeaders,
       method: 'POST',
       path: `/domain/v2beta1/dns-zones`
     }, unmarshalDNSZone);
+    /**
+     * Update the name and/or the organizations for a DNS zone.
+     *
+     * @param request - The request {@link UpdateDNSZoneRequest}
+     * @returns A Promise of DNSZone
+     */
     this.updateDNSZone = request => this.client.fetch({
       body: JSON.stringify(marshalUpdateDNSZoneRequest(request, this.client.settings)),
       headers: jsonContentHeaders,
       method: 'PATCH',
       path: `/domain/v2beta1/dns-zones/${validatePathParam('dnsZone', request.dnsZone)}`
     }, unmarshalDNSZone);
+    /**
+     * Clone an existed DNS zone with all its records into a new one.
+     *
+     * @param request - The request {@link CloneDNSZoneRequest}
+     * @returns A Promise of DNSZone
+     */
     this.cloneDNSZone = request => this.client.fetch({
       body: JSON.stringify(marshalCloneDNSZoneRequest(request, this.client.settings)),
       headers: jsonContentHeaders,
       method: 'POST',
       path: `/domain/v2beta1/dns-zones/${validatePathParam('dnsZone', request.dnsZone)}/clone`
     }, unmarshalDNSZone);
+    /**
+     * Delete a DNS zone and all it's records.
+     *
+     * @param request - The request {@link DeleteDNSZoneRequest}
+     * @returns A Promise of DeleteDNSZoneResponse
+     */
     this.deleteDNSZone = request => this.client.fetch({
       method: 'DELETE',
       path: `/domain/v2beta1/dns-zones/${validatePathParam('dnsZone', request.dnsZone)}`,
@@ -50,48 +81,122 @@ class API extends API$1 {
     this.pageOfListDNSZoneRecords = request => this.client.fetch({
       method: 'GET',
       path: `/domain/v2beta1/dns-zones/${validatePathParam('dnsZone', request.dnsZone)}/records`,
-      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 ?? this.client.settings.defaultProjectId], ['type', request.type ?? 'unknown'])
+      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.
+     *
+     * @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.
+     *
+     * Action can be:
+     *
+     * - 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
+     *
+     * All edits will be versioned.
+     *
+     * @param request - The request {@link UpdateDNSZoneRecordsRequest}
+     * @returns A Promise of UpdateDNSZoneRecordsResponse
+     */
     this.updateDNSZoneRecords = request => this.client.fetch({
       body: JSON.stringify(marshalUpdateDNSZoneRecordsRequest(request, this.client.settings)),
       headers: jsonContentHeaders,
       method: 'PATCH',
       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.
+     *
+     * @param request - The request {@link ListDNSZoneNameserversRequest}
+     * @returns A Promise of ListDNSZoneNameserversResponse
+     */
     this.listDNSZoneNameservers = request => this.client.fetch({
       method: 'GET',
       path: `/domain/v2beta1/dns-zones/${validatePathParam('dnsZone', request.dnsZone)}/nameservers`,
-      urlParams: urlParams(['project_id', request.projectId ?? this.client.settings.defaultProjectId])
+      urlParams: urlParams(['project_id', request.projectId])
     }, unmarshalListDNSZoneNameserversResponse);
+    /**
+     * Update DNS zone nameservers and set optional glue records.
+     *
+     * @param request - The request {@link UpdateDNSZoneNameserversRequest}
+     * @returns A Promise of UpdateDNSZoneNameserversResponse
+     */
     this.updateDNSZoneNameservers = request => this.client.fetch({
       body: JSON.stringify(marshalUpdateDNSZoneNameserversRequest(request, this.client.settings)),
       headers: jsonContentHeaders,
       method: 'PUT',
       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.
+     *
+     * @param request - The request {@link ClearDNSZoneRecordsRequest}
+     * @returns A Promise of ClearDNSZoneRecordsResponse
+     */
     this.clearDNSZoneRecords = request => this.client.fetch({
       method: 'DELETE',
       path: `/domain/v2beta1/dns-zones/${validatePathParam('dnsZone', request.dnsZone)}/records`
     }, unmarshalClearDNSZoneRecordsResponse);
+    /**
+     * Get a DNS zone in a given format with default NS.
+     *
+     * @param request - The request {@link ExportRawDNSZoneRequest}
+     * @returns A Promise of Blob
+     */
     this.exportRawDNSZone = request => this.client.fetch({
       method: 'GET',
       path: `/domain/v2beta1/dns-zones/${validatePathParam('dnsZone', request.dnsZone)}/raw`,
       urlParams: urlParams(['dl', 1], ['format', request.format ?? 'unknown_raw_format']),
       responseType: 'blob'
     });
+    /**
+     * Import and replace records from a given provider format with default NS.
+     *
+     * @param request - The request {@link ImportRawDNSZoneRequest}
+     * @returns A Promise of ImportRawDNSZoneResponse
+     */
     this.importRawDNSZone = request => this.client.fetch({
       body: JSON.stringify(marshalImportRawDNSZoneRequest(request, this.client.settings)),
       headers: jsonContentHeaders,
       method: 'POST',
       path: `/domain/v2beta1/dns-zones/${validatePathParam('dnsZone', request.dnsZone)}/raw`
     }, unmarshalImportRawDNSZoneResponse);
+    /**
+     * Import and replace records from a given provider format with default NS.
+     *
+     * @param request - The request {@link ImportProviderDNSZoneRequest}
+     * @returns A Promise of ImportProviderDNSZoneResponse
+     */
     this.importProviderDNSZone = request => this.client.fetch({
       body: JSON.stringify(marshalImportProviderDNSZoneRequest(request, this.client.settings)),
       headers: jsonContentHeaders,
       method: 'POST',
       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.
+     *
+     * @param request - The request {@link RefreshDNSZoneRequest}
+     * @returns A Promise of RefreshDNSZoneResponse
+     */
     this.refreshDNSZone = request => this.client.fetch({
       body: JSON.stringify(marshalRefreshDNSZoneRequest(request, this.client.settings)),
       headers: jsonContentHeaders,
@@ -103,28 +208,73 @@ class API extends API$1 {
       path: `/domain/v2beta1/dns-zones/${validatePathParam('dnsZone', request.dnsZone)}/versions`,
       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.
+     *
+     * @param request - The request {@link ListDNSZoneVersionsRequest}
+     * @returns A Promise of ListDNSZoneVersionsResponse
+     */
     this.listDNSZoneVersions = request => enrichForPagination('versions', this.pageOfListDNSZoneVersions, request);
     this.pageOfListDNSZoneVersionRecords = request => this.client.fetch({
       method: 'GET',
       path: `/domain/v2beta1/dns-zones/version/${validatePathParam('dnsZoneVersionId', request.dnsZoneVersionId)}`,
       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.
+     *
+     * @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.
+     *
+     * @param request - The request {@link GetDNSZoneVersionDiffRequest}
+     * @returns A Promise of GetDNSZoneVersionDiffResponse
+     */
     this.getDNSZoneVersionDiff = request => this.client.fetch({
       method: 'GET',
       path: `/domain/v2beta1/dns-zones/version/${validatePathParam('dnsZoneVersionId', request.dnsZoneVersionId)}/diff`
     }, unmarshalGetDNSZoneVersionDiffResponse);
+    /**
+     * Restore and activate a previous DNS zone version.
+     *
+     * @param request - The request {@link RestoreDNSZoneVersionRequest}
+     * @returns A Promise of RestoreDNSZoneVersionResponse
+     */
     this.restoreDNSZoneVersion = request => this.client.fetch({
       body: '{}',
       headers: jsonContentHeaders,
       method: 'POST',
       path: `/domain/v2beta1/dns-zones/version/${validatePathParam('dnsZoneVersionId', request.dnsZoneVersionId)}/restore`
     }, unmarshalRestoreDNSZoneVersionResponse);
+    /**
+     * Get the zone TLS certificate if it exists
+     *
+     * @param request - The request {@link GetSSLCertificateRequest}
+     * @returns A Promise of SSLCertificate
+     */
     this.getSSLCertificate = request => this.client.fetch({
       method: 'GET',
       path: `/domain/v2beta1/ssl-certificates/${validatePathParam('dnsZone', request.dnsZone)}`
     }, unmarshalSSLCertificate);
+    /**
+     * Waits for {@link SSLCertificate} to be in a final state.
+     *
+     * @param request - The request {@link GetSSLCertificateRequest}
+     * @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);
+    /**
+     * Create or return the zone TLS certificate
+     *
+     * @param request - The request {@link CreateSSLCertificateRequest}
+     * @returns A Promise of SSLCertificate
+     */
     this.createSSLCertificate = request => this.client.fetch({
       body: JSON.stringify(marshalCreateSSLCertificateRequest(request, this.client.settings)),
       headers: jsonContentHeaders,
@@ -134,17 +284,40 @@ class API extends API$1 {
     this.pageOfListSSLCertificates = request => this.client.fetch({
       method: 'GET',
       path: `/domain/v2beta1/ssl-certificates`,
-      urlParams: urlParams(['dns_zone', request.dnsZone], ['page', request.page], ['page_size', request.pageSize ?? this.client.settings.defaultPageSize], ['project_id', request.projectId ?? this.client.settings.defaultProjectId])
+      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
+     *
+     * @param request - The request {@link ListSSLCertificatesRequest}
+     * @returns A Promise of ListSSLCertificatesResponse
+     */
     this.listSSLCertificates = request => enrichForPagination('certificates', this.pageOfListSSLCertificates, request);
+    /**
+     * Delete an TLS certificate
+     *
+     * @param request - The request {@link DeleteSSLCertificateRequest}
+     * @returns A Promise of DeleteSSLCertificateResponse
+     */
     this.deleteSSLCertificate = request => this.client.fetch({
       method: 'DELETE',
       path: `/domain/v2beta1/ssl-certificates/${validatePathParam('dnsZone', request.dnsZone)}`
     }, unmarshalDeleteSSLCertificateResponse);
+    /**
+     * Get the DNS zone TSIG Key to allow AXFR request.
+     *
+     * @param request - The request {@link GetDNSZoneTsigKeyRequest}
+     * @returns A Promise of GetDNSZoneTsigKeyResponse
+     */
     this.getDNSZoneTsigKey = request => this.client.fetch({
       method: 'GET',
       path: `/domain/v2beta1/dns-zones/${validatePathParam('dnsZone', request.dnsZone)}/tsig-key`
     }, unmarshalGetDNSZoneTsigKeyResponse);
+    /**
+     * Delete the DNS zone TSIG Key
+     *
+     * @param request - The request {@link DeleteDNSZoneTsigKeyRequest}
+     */
     this.deleteDNSZoneTsigKey = request => this.client.fetch({
       method: 'DELETE',
       path: `/domain/v2beta1/dns-zones/${validatePathParam('dnsZone', request.dnsZone)}/tsig-key`
@@ -169,49 +342,105 @@ class RegistrarAPI extends API$1 {
       return _this.client.fetch({
         method: 'GET',
         path: `/domain/v2beta1/tasks`,
-        urlParams: urlParams(['domain', request.domain], ['order_by', request.orderBy ?? 'domain_desc'], ['organization_id', request.organizationId ?? _this.client.settings.defaultOrganizationId], ['page', request.page], ['page_size', request.pageSize ?? _this.client.settings.defaultPageSize], ['project_id', request.projectId ?? _this.client.settings.defaultProjectId], ['statuses', request.statuses], ['types', request.types])
+        urlParams: urlParams(['domain', request.domain], ['order_by', request.orderBy ?? 'domain_desc'], ['organization_id', request.organizationId], ['page', request.page], ['page_size', request.pageSize ?? _this.client.settings.defaultPageSize], ['project_id', request.projectId], ['statuses', request.statuses], ['types', request.types])
       }, unmarshalListTasksResponse);
     };
+    /**
+     * List all account tasks. You can filter the list by domain name.
+     *
+     * @param request - The request {@link RegistrarApiListTasksRequest}
+     * @returns A Promise of ListTasksResponse
+     */
     this.listTasks = function (request) {
       if (request === void 0) {
         request = {};
       }
       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.
+     *
+     * @param request - The request {@link RegistrarApiBuyDomainsRequest}
+     * @returns A Promise of OrderResponse
+     */
     this.buyDomains = request => this.client.fetch({
       body: JSON.stringify(marshalRegistrarApiBuyDomainsRequest(request, this.client.settings)),
       headers: jsonContentHeaders,
       method: 'POST',
       path: `/domain/v2beta1/buy-domains`
     }, unmarshalOrderResponse);
+    /**
+     * Request the renewal of domain names.
+     *
+     * @param request - The request {@link RegistrarApiRenewDomainsRequest}
+     * @returns A Promise of OrderResponse
+     */
     this.renewDomains = request => this.client.fetch({
       body: JSON.stringify(marshalRegistrarApiRenewDomainsRequest(request, this.client.settings)),
       headers: jsonContentHeaders,
       method: 'POST',
       path: `/domain/v2beta1/renew-domains`
     }, unmarshalOrderResponse);
+    /**
+     * Request the transfer from another registrar domain to Scaleway.
+     *
+     * @param request - The request {@link RegistrarApiTransferInDomainRequest}
+     * @returns A Promise of OrderResponse
+     */
     this.transferInDomain = request => this.client.fetch({
       body: JSON.stringify(marshalRegistrarApiTransferInDomainRequest(request, this.client.settings)),
       headers: jsonContentHeaders,
       method: 'POST',
       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.
+     *
+     * @param request - The request {@link RegistrarApiTradeDomainRequest}
+     * @returns A Promise of OrderResponse
+     */
     this.tradeDomain = request => this.client.fetch({
       body: JSON.stringify(marshalRegistrarApiTradeDomainRequest(request, this.client.settings)),
       headers: jsonContentHeaders,
       method: 'POST',
       path: `/domain/v2beta1/domains/${validatePathParam('domain', request.domain)}/trade`
     }, unmarshalOrderResponse);
+    /**
+     * Request the registration of an external domain name.
+     *
+     * @param request - The request
+     *   {@link RegistrarApiRegisterExternalDomainRequest}
+     * @returns A Promise of RegisterExternalDomainResponse
+     */
     this.registerExternalDomain = request => this.client.fetch({
       body: JSON.stringify(marshalRegistrarApiRegisterExternalDomainRequest(request, this.client.settings)),
       headers: jsonContentHeaders,
       method: 'POST',
       path: `/domain/v2beta1/external-domains`
     }, unmarshalRegisterExternalDomainResponse);
+    /**
+     * Delete an external domain name.
+     *
+     * @param request - The request {@link RegistrarApiDeleteExternalDomainRequest}
+     * @returns A Promise of DeleteExternalDomainResponse
+     */
     this.deleteExternalDomain = request => this.client.fetch({
       method: 'DELETE',
       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.
+     *
+     * @param request - The request
+     *   {@link RegistrarApiCheckContactsCompatibilityRequest}
+     * @returns A Promise of CheckContactsCompatibilityResponse
+     */
     this.checkContactsCompatibility = function (request) {
       if (request === void 0) {
         request = {};
@@ -230,19 +459,39 @@ class RegistrarAPI extends API$1 {
       return _this.client.fetch({
         method: 'GET',
         path: `/domain/v2beta1/contacts`,
-        urlParams: urlParams(['domain', request.domain], ['organization_id', request.organizationId ?? _this.client.settings.defaultOrganizationId], ['page', request.page], ['page_size', request.pageSize ?? _this.client.settings.defaultPageSize], ['project_id', request.projectId ?? _this.client.settings.defaultProjectId])
+        urlParams: urlParams(['domain', request.domain], ['organization_id', request.organizationId], ['page', request.page], ['page_size', request.pageSize ?? _this.client.settings.defaultPageSize], ['project_id', request.projectId])
       }, unmarshalListContactsResponse);
     };
+    /**
+     * 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
+     */
     this.listContacts = function (request) {
       if (request === void 0) {
         request = {};
       }
       return enrichForPagination('contacts', _this.pageOfListContacts, request);
     };
+    /**
+     * Return a contact details retrieved from the registrar using a given contact
+     * ID.
+     *
+     * @param request - The request {@link RegistrarApiGetContactRequest}
+     * @returns A Promise of Contact
+     */
     this.getContact = request => this.client.fetch({
       method: 'GET',
       path: `/domain/v2beta1/contacts/${validatePathParam('contactId', request.contactId)}`
     }, unmarshalContact);
+    /**
+     * You can edit the contact coordinates.
+     *
+     * @param request - The request {@link RegistrarApiUpdateContactRequest}
+     * @returns A Promise of Contact
+     */
     this.updateContact = request => this.client.fetch({
       body: JSON.stringify(marshalRegistrarApiUpdateContactRequest(request, this.client.settings)),
       headers: jsonContentHeaders,
@@ -256,9 +505,15 @@ class RegistrarAPI extends API$1 {
       return _this.client.fetch({
         method: 'GET',
         path: `/domain/v2beta1/domains`,
-        urlParams: urlParams(['domain', request.domain], ['is_external', request.isExternal], ['order_by', request.orderBy ?? 'domain_asc'], ['organization_id', request.organizationId ?? _this.client.settings.defaultOrganizationId], ['page', request.page], ['page_size', request.pageSize ?? _this.client.settings.defaultPageSize], ['project_id', request.projectId ?? _this.client.settings.defaultProjectId], ['registrar', request.registrar], ['status', request.status ?? 'status_unknown'])
+        urlParams: urlParams(['domain', request.domain], ['is_external', request.isExternal], ['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], ['registrar', request.registrar], ['status', request.status ?? 'status_unknown'])
       }, unmarshalListDomainsResponse);
     };
+    /**
+     * Returns a list of domains owned by the user.
+     *
+     * @param request - The request {@link RegistrarApiListDomainsRequest}
+     * @returns A Promise of ListDomainsResponse
+     */
     this.listDomains = function (request) {
       if (request === void 0) {
         request = {};
@@ -272,71 +527,185 @@ class RegistrarAPI extends API$1 {
       return _this.client.fetch({
         method: 'GET',
         path: `/domain/v2beta1/renewable-domains`,
-        urlParams: urlParams(['order_by', request.orderBy ?? 'domain_asc'], ['organization_id', request.organizationId ?? _this.client.settings.defaultOrganizationId], ['page', request.page], ['page_size', request.pageSize ?? _this.client.settings.defaultPageSize], ['project_id', request.projectId ?? _this.client.settings.defaultProjectId])
+        urlParams: urlParams(['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])
       }, unmarshalListRenewableDomainsResponse);
     };
+    /**
+     * 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
+     */
     this.listRenewableDomains = function (request) {
       if (request === void 0) {
         request = {};
       }
       return enrichForPagination('domains', _this.pageOfListRenewableDomains, request);
     };
+    /**
+     * Returns a the domain with more informations.
+     *
+     * @param request - The request {@link RegistrarApiGetDomainRequest}
+     * @returns A Promise of Domain
+     */
     this.getDomain = request => this.client.fetch({
       method: 'GET',
       path: `/domain/v2beta1/domains/${validatePathParam('domain', request.domain)}`
     }, unmarshalDomain);
+    /**
+     * Waits for {@link Domain} to be in a final state.
+     *
+     * @param request - The request {@link GetDomainRequest}
+     * @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);
+    /**
+     * 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
+     */
     this.updateDomain = request => this.client.fetch({
       body: JSON.stringify(marshalRegistrarApiUpdateDomainRequest(request, this.client.settings)),
       headers: jsonContentHeaders,
       method: 'PATCH',
       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.
+     *
+     * @param request - The request {@link RegistrarApiLockDomainTransferRequest}
+     * @returns A Promise of Domain
+     */
     this.lockDomainTransfer = request => this.client.fetch({
       body: '{}',
       headers: jsonContentHeaders,
       method: 'POST',
       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.
+     *
+     * @param request - The request {@link RegistrarApiUnlockDomainTransferRequest}
+     * @returns A Promise of Domain
+     */
     this.unlockDomainTransfer = request => this.client.fetch({
       body: '{}',
       headers: jsonContentHeaders,
       method: 'POST',
       path: `/domain/v2beta1/domains/${validatePathParam('domain', request.domain)}/unlock-transfer`
     }, unmarshalDomain);
+    /**
+     * Enable domain auto renew
+     *
+     * @param request - The request
+     *   {@link RegistrarApiEnableDomainAutoRenewRequest}
+     * @returns A Promise of Domain
+     */
     this.enableDomainAutoRenew = request => this.client.fetch({
       body: '{}',
       headers: jsonContentHeaders,
       method: 'POST',
       path: `/domain/v2beta1/domains/${validatePathParam('domain', request.domain)}/enable-auto-renew`
     }, unmarshalDomain);
+    /**
+     * Disable domain auto renew
+     *
+     * @param request - The request
+     *   {@link RegistrarApiDisableDomainAutoRenewRequest}
+     * @returns A Promise of Domain
+     */
     this.disableDomainAutoRenew = request => this.client.fetch({
       body: '{}',
       headers: jsonContentHeaders,
       method: 'POST',
       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.
+     *
+     * @param request - The request {@link RegistrarApiGetDomainAuthCodeRequest}
+     * @returns A Promise of GetDomainAuthCodeResponse
+     */
     this.getDomainAuthCode = request => this.client.fetch({
       method: 'GET',
       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:
+     *
+     * - 1: RSAMD5
+     * - 2: DIFFIE_HELLMAN
+     * - 3: DSA_SHA1
+     * - 5: RSA_SHA1
+     * - 6: DSA_NSEC3_SHA1
+     * - 7: RSASHA1_NSEC3_SHA1
+     * - 8: RSASHA256
+     * - 10: RSASHA512
+     * - 12: ECC_GOST
+     * - 13: ECDSAP256SHA256
+     * - 14: ECDSAP384SHA384
+     *
+     * And for the digest type:
+     *
+     * - 1: SHA_1
+     * - 2: SHA_256
+     * - 3: GOST_R_34_11_94
+     * - 4: SHA_384
+     *
+     * @param request - The request {@link RegistrarApiEnableDomainDNSSECRequest}
+     * @returns A Promise of Domain
+     */
     this.enableDomainDNSSEC = request => this.client.fetch({
       body: JSON.stringify(marshalRegistrarApiEnableDomainDNSSECRequest(request, this.client.settings)),
       headers: jsonContentHeaders,
       method: 'POST',
       path: `/domain/v2beta1/domains/${validatePathParam('domain', request.domain)}/enable-dnssec`
     }, unmarshalDomain);
+    /**
+     * Disable domain DNSSEC
+     *
+     * @param request - The request {@link RegistrarApiDisableDomainDNSSECRequest}
+     * @returns A Promise of Domain
+     */
     this.disableDomainDNSSEC = request => this.client.fetch({
       body: '{}',
       headers: jsonContentHeaders,
       method: 'POST',
       path: `/domain/v2beta1/domains/${validatePathParam('domain', request.domain)}/disable-dnssec`
     }, unmarshalDomain);
+    /**
+     * 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.
+     *
+     * @param request - The request
+     *   {@link RegistrarApiSearchAvailableDomainsRequest}
+     * @returns A Promise of SearchAvailableDomainsResponse
+     */
     this.searchAvailableDomains = request => this.client.fetch({
       method: 'GET',
       path: `/domain/v2beta1/search-domains`,
       urlParams: urlParams(['domains', request.domains], ['strict_search', request.strictSearch], ['tlds', request.tlds])
     }, unmarshalSearchAvailableDomainsResponse);
+    /**
+     * Create domain hostname with glue IPs
+     *
+     * @param request - The request {@link RegistrarApiCreateDomainHostRequest}
+     * @returns A Promise of Host
+     */
     this.createDomainHost = request => this.client.fetch({
       body: JSON.stringify(marshalRegistrarApiCreateDomainHostRequest(request, this.client.settings)),
       headers: jsonContentHeaders,
@@ -348,13 +717,31 @@ class RegistrarAPI extends API$1 {
       path: `/domain/v2beta1/domains/${validatePathParam('domain', request.domain)}/hosts`,
       urlParams: urlParams(['page', request.page], ['page_size', request.pageSize ?? this.client.settings.defaultPageSize])
     }, unmarshalListDomainHostsResponse);
+    /**
+     * 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
+     *
+     * @param request - The request {@link RegistrarApiUpdateDomainHostRequest}
+     * @returns A Promise of Host
+     */
     this.updateDomainHost = request => this.client.fetch({
       body: JSON.stringify(marshalRegistrarApiUpdateDomainHostRequest(request, this.client.settings)),
       headers: jsonContentHeaders,
       method: 'PATCH',
       path: `/domain/v2beta1/domains/${validatePathParam('domain', request.domain)}/hosts/${validatePathParam('name', request.name)}`
     }, unmarshalHost);
+    /**
+     * Delete domain hostname
+     *
+     * @param request - The request {@link RegistrarApiDeleteDomainHostRequest}
+     * @returns A Promise of Host
+     */
     this.deleteDomainHost = request => this.client.fetch({
       method: 'DELETE',
       path: `/domain/v2beta1/domains/${validatePathParam('domain', request.domain)}/hosts/${validatePathParam('name', request.name)}`