@randock/nameshift-api-client 0.0.436 → 0.0.438

package/dist/apis/DomainsApi.js

@@ -3,7 +3,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.
  *
  * The version of the OpenAPI document: 1.0
  *
@@ -76,7 +76,8 @@ var DomainsApi = /** @class */ (function (_super) {
         return _super !== null && _super.apply(this, arguments) || this;
     }
     /**
-     *
+     * Imports domains from an uploaded file or a list of domain names and queues them for processing.
+     * Import domains
      */
     DomainsApi.prototype.batchImportRaw = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -109,12 +110,12 @@ var DomainsApi = /** @class */ (function (_super) {
                         else {
                             formParams = new URLSearchParams();
                         }
-                        if (requestParameters['file'] != null) {
-                            formParams.append('file', requestParameters['file']);
-                        }
                         if (requestParameters['domains'] != null) {
                             formParams.append('domains', requestParameters['domains'].join(runtime.COLLECTION_FORMATS["csv"]));
                         }
+                        if (requestParameters['file'] != null) {
+                            formParams.append('file', requestParameters['file']);
+                        }
                         return [4 /*yield*/, this.request({
                                 path: "/private/domains",
                                 method: 'POST',
@@ -130,7 +131,8 @@ var DomainsApi = /** @class */ (function (_super) {
         });
     };
     /**
-     *
+     * Imports domains from an uploaded file or a list of domain names and queues them for processing.
+     * Import domains
      */
     DomainsApi.prototype.batchImport = function () {
         return __awaiter(this, arguments, void 0, function (requestParameters, initOverrides) {
@@ -146,7 +148,8 @@ var DomainsApi = /** @class */ (function (_super) {
         });
     };
     /**
-     *
+     * Uploads a domain import file and returns a preview of parsed domains before import.
+     * Preview domain import
      */
     DomainsApi.prototype.batchImportPreviewRaw = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -197,7 +200,8 @@ var DomainsApi = /** @class */ (function (_super) {
         });
     };
     /**
-     *
+     * Uploads a domain import file and returns a preview of parsed domains before import.
+     * Preview domain import
      */
     DomainsApi.prototype.batchImportPreview = function () {
         return __awaiter(this, arguments, void 0, function (requestParameters, initOverrides) {
@@ -215,7 +219,8 @@ var DomainsApi = /** @class */ (function (_super) {
         });
     };
     /**
-     *
+     * Applies the same settings update to multiple domains by ID.
+     * Batch update domains
      */
     DomainsApi.prototype.batchUpdateRaw = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -253,7 +258,8 @@ var DomainsApi = /** @class */ (function (_super) {
         });
     };
     /**
-     *
+     * Applies the same settings update to multiple domains by ID.
+     * Batch update domains
      */
     DomainsApi.prototype.batchUpdate = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -268,7 +274,8 @@ var DomainsApi = /** @class */ (function (_super) {
         });
     };
     /**
-     *
+     * Applies pricing and configuration updates to all domains matching the provided filter criteria.
+     * Bulk update domains with filters
      */
     DomainsApi.prototype.bulkUpdateDomainsWithFiltersRaw = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -309,7 +316,8 @@ var DomainsApi = /** @class */ (function (_super) {
         });
     };
     /**
-     *
+     * Applies pricing and configuration updates to all domains matching the provided filter criteria.
+     * Bulk update domains with filters
      */
     DomainsApi.prototype.bulkUpdateDomainsWithFilters = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -324,7 +332,8 @@ var DomainsApi = /** @class */ (function (_super) {
         });
     };
     /**
-     *
+     * Starts a nameserver verification check for a single domain.
+     * Check domain nameservers
      */
     DomainsApi.prototype.checkDnsRaw = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -360,7 +369,8 @@ var DomainsApi = /** @class */ (function (_super) {
         });
     };
     /**
-     *
+     * Starts a nameserver verification check for a single domain.
+     * Check domain nameservers
      */
     DomainsApi.prototype.checkDns = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -375,7 +385,8 @@ var DomainsApi = /** @class */ (function (_super) {
         });
     };
     /**
-     *
+     * Starts a nameserver verification check for the specified domain IDs.
+     * Check nameservers for multiple domains
      */
     DomainsApi.prototype.checkDnsBatchRaw = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -413,7 +424,8 @@ var DomainsApi = /** @class */ (function (_super) {
         });
     };
     /**
-     *
+     * Starts a nameserver verification check for the specified domain IDs.
+     * Check nameservers for multiple domains
      */
     DomainsApi.prototype.checkDnsBatch = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -428,7 +440,8 @@ var DomainsApi = /** @class */ (function (_super) {
         });
     };
     /**
-     *
+     * Checks and updates the verification status of a domain owned by the seller.
+     * Check domain verification
      */
     DomainsApi.prototype.checkDomainVerificationRaw = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -464,7 +477,8 @@ var DomainsApi = /** @class */ (function (_super) {
         });
     };
     /**
-     *
+     * Checks and updates the verification status of a domain owned by the seller.
+     * Check domain verification
      */
     DomainsApi.prototype.checkDomainVerification = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -481,7 +495,8 @@ var DomainsApi = /** @class */ (function (_super) {
         });
     };
     /**
-     *
+     * Deletes multiple domains by ID. Domains with open leads or active auctions cannot be deleted.
+     * Delete domains
      */
     DomainsApi.prototype.deleteDomainsRaw = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -519,7 +534,8 @@ var DomainsApi = /** @class */ (function (_super) {
         });
     };
     /**
-     *
+     * Deletes multiple domains by ID. Domains with open leads or active auctions cannot be deleted.
+     * Delete domains
      */
     DomainsApi.prototype.deleteDomains = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -534,7 +550,8 @@ var DomainsApi = /** @class */ (function (_super) {
         });
     };
     /**
-     *
+     * Queues an export of all domains for the current seller account.
+     * Export domains
      */
     DomainsApi.prototype.exportDomainsRaw = function (initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -567,7 +584,8 @@ var DomainsApi = /** @class */ (function (_super) {
         });
     };
     /**
-     *
+     * Queues an export of all domains for the current seller account.
+     * Export domains
      */
     DomainsApi.prototype.exportDomains = function (initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -582,7 +600,8 @@ var DomainsApi = /** @class */ (function (_super) {
         });
     };
     /**
-     *
+     * Returns the affiliate commission information for a domain owned by the seller.
+     * Get domain affiliate commission
      */
     DomainsApi.prototype.getAffiliateCommissionRaw = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -621,7 +640,8 @@ var DomainsApi = /** @class */ (function (_super) {
         });
     };
     /**
-     *
+     * Returns the affiliate commission information for a domain owned by the seller.
+     * Get domain affiliate commission
      */
     DomainsApi.prototype.getAffiliateCommission = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -638,7 +658,8 @@ var DomainsApi = /** @class */ (function (_super) {
         });
     };
     /**
-     *
+     * Lists domain transfers for the seller account.
+     * List domain transfers
      */
     DomainsApi.prototype.getAllDomainTransfersRaw = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -659,6 +680,12 @@ var DomainsApi = /** @class */ (function (_super) {
                         if (requestParameters['sortBy'] != null) {
                             queryParameters['sortBy'] = requestParameters['sortBy'];
                         }
+                        if (requestParameters['filterStatus'] != null) {
+                            queryParameters['filter[status]'] = requestParameters['filterStatus'];
+                        }
+                        if (requestParameters['filterDomainId'] != null) {
+                            queryParameters['filter[domainId]'] = requestParameters['filterDomainId'];
+                        }
                         headerParameters = {};
                         if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
                         token = this.configuration.accessToken;
@@ -683,7 +710,8 @@ var DomainsApi = /** @class */ (function (_super) {
         });
     };
     /**
-     *
+     * Lists domain transfers for the seller account.
+     * List domain transfers
      */
     DomainsApi.prototype.getAllDomainTransfers = function () {
         return __awaiter(this, arguments, void 0, function (requestParameters, initOverrides) {
@@ -701,7 +729,8 @@ var DomainsApi = /** @class */ (function (_super) {
         });
     };
     /**
-     *
+     * Returns domain information.
+     * Get domain
      */
     DomainsApi.prototype.getDomainRaw = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -737,7 +766,8 @@ var DomainsApi = /** @class */ (function (_super) {
         });
     };
     /**
-     *
+     * Returns domain information.
+     * Get domain
      */
     DomainsApi.prototype.getDomain = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -754,7 +784,8 @@ var DomainsApi = /** @class */ (function (_super) {
         });
     };
     /**
-     *
+     * Returns the currency exchange rate applicable to the specified domain.
+     * Get domain exchange rate
      */
     DomainsApi.prototype.getDomainExchangeRateRaw = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -790,7 +821,8 @@ var DomainsApi = /** @class */ (function (_super) {
         });
     };
     /**
-     *
+     * Returns the currency exchange rate applicable to the specified domain.
+     * Get domain exchange rate
      */
     DomainsApi.prototype.getDomainExchangeRate = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -807,7 +839,8 @@ var DomainsApi = /** @class */ (function (_super) {
         });
     };
     /**
-     *
+     * Returns available filter options for the seller domain inventory.
+     * Get domain filters
      */
     DomainsApi.prototype.getDomainFiltersRaw = function (initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -840,7 +873,8 @@ var DomainsApi = /** @class */ (function (_super) {
         });
     };
     /**
-     *
+     * Returns available filter options for the seller domain inventory.
+     * Get domain filters
      */
     DomainsApi.prototype.getDomainFilters = function (initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -857,7 +891,8 @@ var DomainsApi = /** @class */ (function (_super) {
         });
     };
     /**
-     *
+     * Returns the list of currencies available for the current domain filter selection.
+     * Get domain filter currencies
      */
     DomainsApi.prototype.getDomainFiltersCurrenciesRaw = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -893,7 +928,8 @@ var DomainsApi = /** @class */ (function (_super) {
         });
     };
     /**
-     *
+     * Returns the list of currencies available for the current domain filter selection.
+     * Get domain filter currencies
      */
     DomainsApi.prototype.getDomainFiltersCurrencies = function () {
         return __awaiter(this, arguments, void 0, function (requestParameters, initOverrides) {
@@ -911,7 +947,8 @@ var DomainsApi = /** @class */ (function (_super) {
         });
     };
     /**
-     *
+     * Returns domain transfer information.
+     * Get domain transfer
      */
     DomainsApi.prototype.getDomainTransferRaw = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -947,7 +984,8 @@ var DomainsApi = /** @class */ (function (_super) {
         });
     };
     /**
-     *
+     * Returns domain transfer information.
+     * Get domain transfer
      */
     DomainsApi.prototype.getDomainTransfer = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -964,7 +1002,8 @@ var DomainsApi = /** @class */ (function (_super) {
         });
     };
     /**
-     *
+     * Returns the public landing page URL for the specified domain.
+     * Get domain URL
      */
     DomainsApi.prototype.getDomainUrlRaw = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -1000,7 +1039,8 @@ var DomainsApi = /** @class */ (function (_super) {
         });
     };
     /**
-     *
+     * Returns the public landing page URL for the specified domain.
+     * Get domain URL
      */
     DomainsApi.prototype.getDomainUrl = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -1017,7 +1057,8 @@ var DomainsApi = /** @class */ (function (_super) {
         });
     };
     /**
-     *
+     * Lists domains for the seller account.
+     * List domains
      */
     DomainsApi.prototype.listRaw = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -1038,6 +1079,24 @@ var DomainsApi = /** @class */ (function (_super) {
                         if (requestParameters['sortBy'] != null) {
                             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'];
+                        }
                         headerParameters = {};
                         if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
                         token = this.configuration.accessToken;
@@ -1062,7 +1121,8 @@ var DomainsApi = /** @class */ (function (_super) {
         });
     };
     /**
-     *
+     * Lists domains for the seller account.
+     * List domains
      */
     DomainsApi.prototype.list = function () {
         return __awaiter(this, arguments, void 0, function (requestParameters, initOverrides) {
@@ -1080,7 +1140,8 @@ var DomainsApi = /** @class */ (function (_super) {
         });
     };
     /**
-     *
+     * Creates and starts an auction for the specified verified domain.
+     * Start domain auction
      */
     DomainsApi.prototype.startAuctionRaw = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -1121,7 +1182,8 @@ var DomainsApi = /** @class */ (function (_super) {
         });
     };
     /**
-     *
+     * Creates and starts an auction for the specified verified domain.
+     * Start domain auction
      */
     DomainsApi.prototype.startAuction = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -1136,7 +1198,8 @@ var DomainsApi = /** @class */ (function (_super) {
         });
     };
     /**
-     *
+     * Updates pricing, landing page, and other settings for a single domain.
+     * Update domain
      */
     DomainsApi.prototype.updateRaw = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -1177,7 +1240,8 @@ var DomainsApi = /** @class */ (function (_super) {
         });
     };
     /**
-     *
+     * Updates pricing, landing page, and other settings for a single domain.
+     * Update domain
      */
     DomainsApi.prototype.update = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -1192,7 +1256,8 @@ var DomainsApi = /** @class */ (function (_super) {
         });
     };
     /**
-     *
+     * Updates the authorization code for a domain transfer in progress.
+     * Update domain transfer auth code
      */
     DomainsApi.prototype.updateDomainTransferAuthCodeRaw = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -1233,7 +1298,8 @@ var DomainsApi = /** @class */ (function (_super) {
         });
     };
     /**
-     *
+     * Updates the authorization code for a domain transfer in progress.
+     * Update domain transfer auth code
      */
     DomainsApi.prototype.updateDomainTransferAuthCode = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -1248,7 +1314,8 @@ var DomainsApi = /** @class */ (function (_super) {
         });
     };
     /**
-     *
+     * Updates the IPS tag for a .uk domain transfer in progress.
+     * Update domain transfer IPS tag
      */
     DomainsApi.prototype.updateDomainTransferIpsTagRaw = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -1289,7 +1356,8 @@ var DomainsApi = /** @class */ (function (_super) {
         });
     };
     /**
-     *
+     * Updates the IPS tag for a .uk domain transfer in progress.
+     * Update domain transfer IPS tag
      */
     DomainsApi.prototype.updateDomainTransferIpsTag = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {

package/dist/apis/DomainsPublicApi.d.ts

@@ -1,6 +1,6 @@
 /**
  * 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.
  *
  * The version of the OpenAPI document: 1.0
  *
@@ -10,7 +10,7 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-import type { DomainSalesInformationDto, DomainStatsDto, DomainTldsDto, List200Response3, RelatedDomainsDto, SortDto } from '../models/index';
+import type { DomainSalesInformationDto, DomainStatsDto, DomainTldsDto, List200Response3, RelatedDomainsDto } from '../models/index';
 export interface DomainsPublicApiGetAllTldsRequest {
     seller?: string;
 }
@@ -27,55 +27,65 @@ export interface DomainsPublicApiGetDomainStatsRequest {
     domainName: string;
 }
 export interface DomainsPublicApiListRequest {
-    fuzzy: boolean;
+    fuzzy?: boolean;
     limit?: number;
-    sort?: Array<SortDto>;
+    cursor?: string;
+    sort?: Array<string>;
     filter?: string;
     search?: string;
-    cursor?: string;
 }
 /**
  *
  */
 export declare class DomainsPublicApi extends runtime.BaseAPI {
     /**
-     *
+     * Returns all supported top-level domains, optionally filtered by seller.
+     * Get all TLDs
      */
     getAllTldsRaw(requestParameters: DomainsPublicApiGetAllTldsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DomainTldsDto>>;
     /**
-     *
+     * Returns all supported top-level domains, optionally filtered by seller.
+     * Get all TLDs
      */
     getAllTlds(requestParameters?: DomainsPublicApiGetAllTldsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DomainTldsDto>;
     /**
-     *
+     * Returns domains related to the specified domain for cross-selling.
+     * Get related domains
      */
     getDomainRelatedDomainsRaw(requestParameters: DomainsPublicApiGetDomainRelatedDomainsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RelatedDomainsDto>>;
     /**
-     *
+     * Returns domains related to the specified domain for cross-selling.
+     * Get related domains
      */
     getDomainRelatedDomains(requestParameters: DomainsPublicApiGetDomainRelatedDomainsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RelatedDomainsDto>;
     /**
-     *
+     * Returns domain sales information for a domain.
+     * Get domain sales information
      */
     getDomainSalesInformationRaw(requestParameters: DomainsPublicApiGetDomainSalesInformationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DomainSalesInformationDto>>;
     /**
-     *
+     * Returns domain sales information for a domain.
+     * Get domain sales information
      */
     getDomainSalesInformation(requestParameters: DomainsPublicApiGetDomainSalesInformationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DomainSalesInformationDto>;
     /**
-     *
+     * Returns visitor and sales statistics for a publicly listed domain.
+     * Get domain statistics
      */
     getDomainStatsRaw(requestParameters: DomainsPublicApiGetDomainStatsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DomainStatsDto>>;
     /**
-     *
+     * Returns visitor and sales statistics for a publicly listed domain.
+     * Get domain statistics
      */
     getDomainStats(requestParameters: DomainsPublicApiGetDomainStatsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DomainStatsDto>;
     /**
-     *
+     * Lists publicly available domains for sale.
+     * List public domains
      */
     listRaw(requestParameters: DomainsPublicApiListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<List200Response3>>;
     /**
-     *
+     * Lists publicly available domains for sale.
+     * List public domains
      */
-    list(requestParameters: DomainsPublicApiListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<List200Response3>;
+    list(requestParameters?: DomainsPublicApiListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<List200Response3>;
 }