@randock/nameshift-api-client 0.0.436 → 0.0.437

package/src/apis/DomainsApi.ts

@@ -2,7 +2,7 @@
 /* eslint-disable */
 /**
  * Nameshift
- * Nameshift API
+ * Nameshift domain marketplace and management API.  ## Authentication - **Bearer JWT** — Seller and buyer sessions obtained via login endpoints. - **API key** — Pass the `apikey` header for programmatic seller access.  ## Audiences - **(public)** tags — Unauthenticated or buyer-facing endpoints. - **Accounts / Domains / Leads / Buyers** — Seller or buyer resources. - **Partner** — Partner integrations. - **Webhook tags** — Payment provider, KYC provider, and email provider callbacks (dev-only in Swagger UI).
  *
  * The version of the OpenAPI document: 1.0
  * 
@@ -83,8 +83,8 @@ import {
 } from '../models/index';
 
 export interface DomainsApiBatchImportRequest {
-    file?: Blob | null;
     domains?: Array<string>;
+    file?: Blob | null;
 }
 
 export interface DomainsApiBatchImportPreviewRequest {
@@ -121,10 +121,12 @@ export interface DomainsApiGetAffiliateCommissionRequest {
 }
 
 export interface DomainsApiGetAllDomainTransfersRequest {
-    filter?: object;
+    filter?: { [key: string]: string; };
     page?: number;
     limit?: number;
     sortBy?: Array<string>;
+    filterStatus?: string;
+    filterDomainId?: string;
 }
 
 export interface DomainsApiGetDomainRequest {
@@ -148,10 +150,16 @@ export interface DomainsApiGetDomainUrlRequest {
 }
 
 export interface DomainsApiListRequest {
-    filter?: object;
+    filter?: { [key: string]: string; };
     page?: number;
     limit?: number;
     sortBy?: Array<string>;
+    filterSold?: string;
+    filterHijacked?: string;
+    filterPointingDnsStatus?: string;
+    filterCurrencyCode?: string;
+    filterVerified?: string;
+    filterName?: string;
 }
 
 export interface DomainsApiStartAuctionRequest {
@@ -180,7 +188,8 @@ export interface DomainsApiUpdateDomainTransferIpsTagRequest {
 export class DomainsApi extends runtime.BaseAPI {
 
     /**
-     * 
+     * Imports domains from an uploaded file or a list of domain names and queues them for processing.
+     * Import domains
      */
     async batchImportRaw(requestParameters: DomainsApiBatchImportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
         const queryParameters: any = {};
@@ -211,14 +220,14 @@ export class DomainsApi extends runtime.BaseAPI {
             formParams = new URLSearchParams();
         }
 
-        if (requestParameters['file'] != null) {
-            formParams.append('file', requestParameters['file'] as any);
-        }
-
         if (requestParameters['domains'] != null) {
             formParams.append('domains', requestParameters['domains']!.join(runtime.COLLECTION_FORMATS["csv"]));
         }
 
+        if (requestParameters['file'] != null) {
+            formParams.append('file', requestParameters['file'] as any);
+        }
+
         const response = await this.request({
             path: `/private/domains`,
             method: 'POST',
@@ -231,14 +240,16 @@ export class DomainsApi extends runtime.BaseAPI {
     }
 
     /**
-     * 
+     * Imports domains from an uploaded file or a list of domain names and queues them for processing.
+     * Import domains
      */
     async batchImport(requestParameters: DomainsApiBatchImportRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
         await this.batchImportRaw(requestParameters, initOverrides);
     }
 
     /**
-     * 
+     * Uploads a domain import file and returns a preview of parsed domains before import.
+     * Preview domain import
      */
     async batchImportPreviewRaw(requestParameters: DomainsApiBatchImportPreviewRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<BatchImportPreviewDto>> {
         const queryParameters: any = {};
@@ -285,7 +296,8 @@ export class DomainsApi extends runtime.BaseAPI {
     }
 
     /**
-     * 
+     * Uploads a domain import file and returns a preview of parsed domains before import.
+     * Preview domain import
      */
     async batchImportPreview(requestParameters: DomainsApiBatchImportPreviewRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BatchImportPreviewDto> {
         const response = await this.batchImportPreviewRaw(requestParameters, initOverrides);
@@ -293,7 +305,8 @@ export class DomainsApi extends runtime.BaseAPI {
     }
 
     /**
-     * 
+     * Applies the same settings update to multiple domains by ID.
+     * Batch update domains
      */
     async batchUpdateRaw(requestParameters: DomainsApiBatchUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
         if (requestParameters['batchUpdateDomainsInput'] == null) {
@@ -329,14 +342,16 @@ export class DomainsApi extends runtime.BaseAPI {
     }
 
     /**
-     * 
+     * Applies the same settings update to multiple domains by ID.
+     * Batch update domains
      */
     async batchUpdate(requestParameters: DomainsApiBatchUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
         await this.batchUpdateRaw(requestParameters, initOverrides);
     }
 
     /**
-     * 
+     * Applies pricing and configuration updates to all domains matching the provided filter criteria.
+     * Bulk update domains with filters
      */
     async bulkUpdateDomainsWithFiltersRaw(requestParameters: DomainsApiBulkUpdateDomainsWithFiltersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
         if (requestParameters['bulkUpdateDomainsWithFiltersInput'] == null) {
@@ -376,14 +391,16 @@ export class DomainsApi extends runtime.BaseAPI {
     }
 
     /**
-     * 
+     * Applies pricing and configuration updates to all domains matching the provided filter criteria.
+     * Bulk update domains with filters
      */
     async bulkUpdateDomainsWithFilters(requestParameters: DomainsApiBulkUpdateDomainsWithFiltersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
         await this.bulkUpdateDomainsWithFiltersRaw(requestParameters, initOverrides);
     }
 
     /**
-     * 
+     * Starts a nameserver verification check for a single domain.
+     * Check domain nameservers
      */
     async checkDnsRaw(requestParameters: DomainsApiCheckDnsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
         if (requestParameters['domainId'] == null) {
@@ -416,14 +433,16 @@ export class DomainsApi extends runtime.BaseAPI {
     }
 
     /**
-     * 
+     * Starts a nameserver verification check for a single domain.
+     * Check domain nameservers
      */
     async checkDns(requestParameters: DomainsApiCheckDnsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
         await this.checkDnsRaw(requestParameters, initOverrides);
     }
 
     /**
-     * 
+     * Starts a nameserver verification check for the specified domain IDs.
+     * Check nameservers for multiple domains
      */
     async checkDnsBatchRaw(requestParameters: DomainsApiCheckDnsBatchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
         if (requestParameters['checkDomainsNsInput'] == null) {
@@ -459,14 +478,16 @@ export class DomainsApi extends runtime.BaseAPI {
     }
 
     /**
-     * 
+     * Starts a nameserver verification check for the specified domain IDs.
+     * Check nameservers for multiple domains
      */
     async checkDnsBatch(requestParameters: DomainsApiCheckDnsBatchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
         await this.checkDnsBatchRaw(requestParameters, initOverrides);
     }
 
     /**
-     * 
+     * Checks and updates the verification status of a domain owned by the seller.
+     * Check domain verification
      */
     async checkDomainVerificationRaw(requestParameters: DomainsApiCheckDomainVerificationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DomainVerificationStatusDto>> {
         if (requestParameters['domainId'] == null) {
@@ -499,7 +520,8 @@ export class DomainsApi extends runtime.BaseAPI {
     }
 
     /**
-     * 
+     * Checks and updates the verification status of a domain owned by the seller.
+     * Check domain verification
      */
     async checkDomainVerification(requestParameters: DomainsApiCheckDomainVerificationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DomainVerificationStatusDto> {
         const response = await this.checkDomainVerificationRaw(requestParameters, initOverrides);
@@ -507,7 +529,8 @@ export class DomainsApi extends runtime.BaseAPI {
     }
 
     /**
-     * 
+     * Deletes multiple domains by ID. Domains with open leads or active auctions cannot be deleted.
+     * Delete domains
      */
     async deleteDomainsRaw(requestParameters: DomainsApiDeleteDomainsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
         if (requestParameters['deleteDomainsInput'] == null) {
@@ -543,14 +566,16 @@ export class DomainsApi extends runtime.BaseAPI {
     }
 
     /**
-     * 
+     * Deletes multiple domains by ID. Domains with open leads or active auctions cannot be deleted.
+     * Delete domains
      */
     async deleteDomains(requestParameters: DomainsApiDeleteDomainsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
         await this.deleteDomainsRaw(requestParameters, initOverrides);
     }
 
     /**
-     * 
+     * Queues an export of all domains for the current seller account.
+     * Export domains
      */
     async exportDomainsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
         const queryParameters: any = {};
@@ -576,14 +601,16 @@ export class DomainsApi extends runtime.BaseAPI {
     }
 
     /**
-     * 
+     * Queues an export of all domains for the current seller account.
+     * Export domains
      */
     async exportDomains(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
         await this.exportDomainsRaw(initOverrides);
     }
 
     /**
-     * 
+     * Returns the affiliate commission information for a domain owned by the seller.
+     * Get domain affiliate commission
      */
     async getAffiliateCommissionRaw(requestParameters: DomainsApiGetAffiliateCommissionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SellerDomainAffiliateCommissionDto>> {
         if (requestParameters['domainName'] == null) {
@@ -620,7 +647,8 @@ export class DomainsApi extends runtime.BaseAPI {
     }
 
     /**
-     * 
+     * Returns the affiliate commission information for a domain owned by the seller.
+     * Get domain affiliate commission
      */
     async getAffiliateCommission(requestParameters: DomainsApiGetAffiliateCommissionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SellerDomainAffiliateCommissionDto> {
         const response = await this.getAffiliateCommissionRaw(requestParameters, initOverrides);
@@ -628,7 +656,8 @@ export class DomainsApi extends runtime.BaseAPI {
     }
 
     /**
-     * 
+     * Lists domain transfers for the seller account.
+     * List domain transfers
      */
     async getAllDomainTransfersRaw(requestParameters: DomainsApiGetAllDomainTransfersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetAllDomainTransfers200Response>> {
         const queryParameters: any = {};
@@ -649,6 +678,14 @@ export class DomainsApi extends runtime.BaseAPI {
             queryParameters['sortBy'] = requestParameters['sortBy'];
         }
 
+        if (requestParameters['filterStatus'] != null) {
+            queryParameters['filter[status]'] = requestParameters['filterStatus'];
+        }
+
+        if (requestParameters['filterDomainId'] != null) {
+            queryParameters['filter[domainId]'] = requestParameters['filterDomainId'];
+        }
+
         const headerParameters: runtime.HTTPHeaders = {};
 
         if (this.configuration && this.configuration.accessToken) {
@@ -670,7 +707,8 @@ export class DomainsApi extends runtime.BaseAPI {
     }
 
     /**
-     * 
+     * Lists domain transfers for the seller account.
+     * List domain transfers
      */
     async getAllDomainTransfers(requestParameters: DomainsApiGetAllDomainTransfersRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetAllDomainTransfers200Response> {
         const response = await this.getAllDomainTransfersRaw(requestParameters, initOverrides);
@@ -678,7 +716,8 @@ export class DomainsApi extends runtime.BaseAPI {
     }
 
     /**
-     * 
+     * Returns domain information.
+     * Get domain
      */
     async getDomainRaw(requestParameters: DomainsApiGetDomainRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<IntersectionDomainDtoWithHijackerDtoWithAccountDto>> {
         if (requestParameters['domainId'] == null) {
@@ -711,7 +750,8 @@ export class DomainsApi extends runtime.BaseAPI {
     }
 
     /**
-     * 
+     * Returns domain information.
+     * Get domain
      */
     async getDomain(requestParameters: DomainsApiGetDomainRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<IntersectionDomainDtoWithHijackerDtoWithAccountDto> {
         const response = await this.getDomainRaw(requestParameters, initOverrides);
@@ -719,7 +759,8 @@ export class DomainsApi extends runtime.BaseAPI {
     }
 
     /**
-     * 
+     * Returns the currency exchange rate applicable to the specified domain.
+     * Get domain exchange rate
      */
     async getDomainExchangeRateRaw(requestParameters: DomainsApiGetDomainExchangeRateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DomainExchangeRateDto>> {
         if (requestParameters['domainId'] == null) {
@@ -752,7 +793,8 @@ export class DomainsApi extends runtime.BaseAPI {
     }
 
     /**
-     * 
+     * Returns the currency exchange rate applicable to the specified domain.
+     * Get domain exchange rate
      */
     async getDomainExchangeRate(requestParameters: DomainsApiGetDomainExchangeRateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DomainExchangeRateDto> {
         const response = await this.getDomainExchangeRateRaw(requestParameters, initOverrides);
@@ -760,7 +802,8 @@ export class DomainsApi extends runtime.BaseAPI {
     }
 
     /**
-     * 
+     * Returns available filter options for the seller domain inventory.
+     * Get domain filters
      */
     async getDomainFiltersRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DomainFiltersDto>> {
         const queryParameters: any = {};
@@ -786,7 +829,8 @@ export class DomainsApi extends runtime.BaseAPI {
     }
 
     /**
-     * 
+     * Returns available filter options for the seller domain inventory.
+     * Get domain filters
      */
     async getDomainFilters(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DomainFiltersDto> {
         const response = await this.getDomainFiltersRaw(initOverrides);
@@ -794,7 +838,8 @@ export class DomainsApi extends runtime.BaseAPI {
     }
 
     /**
-     * 
+     * Returns the list of currencies available for the current domain filter selection.
+     * Get domain filter currencies
      */
     async getDomainFiltersCurrenciesRaw(requestParameters: DomainsApiGetDomainFiltersCurrenciesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<string>>> {
         const queryParameters: any = {};
@@ -824,7 +869,8 @@ export class DomainsApi extends runtime.BaseAPI {
     }
 
     /**
-     * 
+     * Returns the list of currencies available for the current domain filter selection.
+     * Get domain filter currencies
      */
     async getDomainFiltersCurrencies(requestParameters: DomainsApiGetDomainFiltersCurrenciesRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<string>> {
         const response = await this.getDomainFiltersCurrenciesRaw(requestParameters, initOverrides);
@@ -832,7 +878,8 @@ export class DomainsApi extends runtime.BaseAPI {
     }
 
     /**
-     * 
+     * Returns domain transfer information.
+     * Get domain transfer
      */
     async getDomainTransferRaw(requestParameters: DomainsApiGetDomainTransferRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SellerDomainTransferDto>> {
         if (requestParameters['transferId'] == null) {
@@ -865,7 +912,8 @@ export class DomainsApi extends runtime.BaseAPI {
     }
 
     /**
-     * 
+     * Returns domain transfer information.
+     * Get domain transfer
      */
     async getDomainTransfer(requestParameters: DomainsApiGetDomainTransferRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SellerDomainTransferDto> {
         const response = await this.getDomainTransferRaw(requestParameters, initOverrides);
@@ -873,7 +921,8 @@ export class DomainsApi extends runtime.BaseAPI {
     }
 
     /**
-     * 
+     * Returns the public landing page URL for the specified domain.
+     * Get domain URL
      */
     async getDomainUrlRaw(requestParameters: DomainsApiGetDomainUrlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DomainUrlDto>> {
         if (requestParameters['domainId'] == null) {
@@ -906,7 +955,8 @@ export class DomainsApi extends runtime.BaseAPI {
     }
 
     /**
-     * 
+     * Returns the public landing page URL for the specified domain.
+     * Get domain URL
      */
     async getDomainUrl(requestParameters: DomainsApiGetDomainUrlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DomainUrlDto> {
         const response = await this.getDomainUrlRaw(requestParameters, initOverrides);
@@ -914,7 +964,8 @@ export class DomainsApi extends runtime.BaseAPI {
     }
 
     /**
-     * 
+     * Lists domains for the seller account.
+     * List domains
      */
     async listRaw(requestParameters: DomainsApiListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<List200Response2>> {
         const queryParameters: any = {};
@@ -935,6 +986,30 @@ export class DomainsApi extends runtime.BaseAPI {
             queryParameters['sortBy'] = requestParameters['sortBy'];
         }
 
+        if (requestParameters['filterSold'] != null) {
+            queryParameters['filter[sold]'] = requestParameters['filterSold'];
+        }
+
+        if (requestParameters['filterHijacked'] != null) {
+            queryParameters['filter[hijacked]'] = requestParameters['filterHijacked'];
+        }
+
+        if (requestParameters['filterPointingDnsStatus'] != null) {
+            queryParameters['filter[pointingDnsStatus]'] = requestParameters['filterPointingDnsStatus'];
+        }
+
+        if (requestParameters['filterCurrencyCode'] != null) {
+            queryParameters['filter[currencyCode]'] = requestParameters['filterCurrencyCode'];
+        }
+
+        if (requestParameters['filterVerified'] != null) {
+            queryParameters['filter[verified]'] = requestParameters['filterVerified'];
+        }
+
+        if (requestParameters['filterName'] != null) {
+            queryParameters['filter[name]'] = requestParameters['filterName'];
+        }
+
         const headerParameters: runtime.HTTPHeaders = {};
 
         if (this.configuration && this.configuration.accessToken) {
@@ -956,7 +1031,8 @@ export class DomainsApi extends runtime.BaseAPI {
     }
 
     /**
-     * 
+     * Lists domains for the seller account.
+     * List domains
      */
     async list(requestParameters: DomainsApiListRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<List200Response2> {
         const response = await this.listRaw(requestParameters, initOverrides);
@@ -964,7 +1040,8 @@ export class DomainsApi extends runtime.BaseAPI {
     }
 
     /**
-     * 
+     * Creates and starts an auction for the specified verified domain.
+     * Start domain auction
      */
     async startAuctionRaw(requestParameters: DomainsApiStartAuctionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
         if (requestParameters['domainId'] == null) {
@@ -1007,14 +1084,16 @@ export class DomainsApi extends runtime.BaseAPI {
     }
 
     /**
-     * 
+     * Creates and starts an auction for the specified verified domain.
+     * Start domain auction
      */
     async startAuction(requestParameters: DomainsApiStartAuctionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
         await this.startAuctionRaw(requestParameters, initOverrides);
     }
 
     /**
-     * 
+     * Updates pricing, landing page, and other settings for a single domain.
+     * Update domain
      */
     async updateRaw(requestParameters: DomainsApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
         if (requestParameters['domainId'] == null) {
@@ -1057,14 +1136,16 @@ export class DomainsApi extends runtime.BaseAPI {
     }
 
     /**
-     * 
+     * Updates pricing, landing page, and other settings for a single domain.
+     * Update domain
      */
     async update(requestParameters: DomainsApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
         await this.updateRaw(requestParameters, initOverrides);
     }
 
     /**
-     * 
+     * Updates the authorization code for a domain transfer in progress.
+     * Update domain transfer auth code
      */
     async updateDomainTransferAuthCodeRaw(requestParameters: DomainsApiUpdateDomainTransferAuthCodeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
         if (requestParameters['transferId'] == null) {
@@ -1107,14 +1188,16 @@ export class DomainsApi extends runtime.BaseAPI {
     }
 
     /**
-     * 
+     * Updates the authorization code for a domain transfer in progress.
+     * Update domain transfer auth code
      */
     async updateDomainTransferAuthCode(requestParameters: DomainsApiUpdateDomainTransferAuthCodeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
         await this.updateDomainTransferAuthCodeRaw(requestParameters, initOverrides);
     }
 
     /**
-     * 
+     * Updates the IPS tag for a .uk domain transfer in progress.
+     * Update domain transfer IPS tag
      */
     async updateDomainTransferIpsTagRaw(requestParameters: DomainsApiUpdateDomainTransferIpsTagRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
         if (requestParameters['transferId'] == null) {
@@ -1157,7 +1240,8 @@ export class DomainsApi extends runtime.BaseAPI {
     }
 
     /**
-     * 
+     * Updates the IPS tag for a .uk domain transfer in progress.
+     * Update domain transfer IPS tag
      */
     async updateDomainTransferIpsTag(requestParameters: DomainsApiUpdateDomainTransferIpsTagRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
         await this.updateDomainTransferIpsTagRaw(requestParameters, initOverrides);