@randock/nameshift-api-client 0.0.436 → 0.0.438

package/dist/apis/MarketingApi.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 MarketingApi = /** @class */ (function (_super) {
         return _super !== null && _super.apply(this, arguments) || this;
     }
     /**
-     *
+     * Lists completed orders for marketing and analytics.
+     * List marketing sales orders
      */
     MarketingApi.prototype.getMarketingSalesRaw = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -97,6 +98,12 @@ var MarketingApi = /** @class */ (function (_super) {
                         if (requestParameters['sortBy'] != null) {
                             queryParameters['sortBy'] = requestParameters['sortBy'];
                         }
+                        if (requestParameters['filterSearchTerm'] != null) {
+                            queryParameters['filter[search_term]'] = requestParameters['filterSearchTerm'];
+                        }
+                        if (requestParameters['filterInvoicePaidAt'] != null) {
+                            queryParameters['filter[invoice.paidAt]'] = requestParameters['filterInvoicePaidAt'];
+                        }
                         headerParameters = {};
                         if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
                         token = this.configuration.accessToken;
@@ -121,7 +128,8 @@ var MarketingApi = /** @class */ (function (_super) {
         });
     };
     /**
-     *
+     * Lists completed orders for marketing and analytics.
+     * List marketing sales orders
      */
     MarketingApi.prototype.getMarketingSales = function () {
         return __awaiter(this, arguments, void 0, function (requestParameters, initOverrides) {
@@ -139,7 +147,8 @@ var MarketingApi = /** @class */ (function (_super) {
         });
     };
     /**
-     *
+     * Returns available filter resources used by the marketing sales listing.
+     * Get marketing sales filters
      */
     MarketingApi.prototype.getMarketingSalesFiltersRaw = function (initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -172,7 +181,8 @@ var MarketingApi = /** @class */ (function (_super) {
         });
     };
     /**
-     *
+     * Returns available filter resources used by the marketing sales listing.
+     * Get marketing sales filters
      */
     MarketingApi.prototype.getMarketingSalesFilters = function (initOverrides) {
         return __awaiter(this, void 0, void 0, function () {

package/dist/apis/NotificationsApi.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
  *
@@ -22,49 +22,57 @@ export interface NotificationsApiGetNotificationByIdRequest {
     notificationId: string;
 }
 export interface NotificationsApiListNotificationsRequest {
-    filter?: object;
+    filter?: {
+        [key: string]: string;
+    };
     page?: number;
     limit?: number;
     sortBy?: Array<string>;
+    filterRead?: string;
+    filterType?: string;
 }
 /**
  *
  */
 export declare class NotificationsApi extends runtime.BaseAPI {
     /**
-     * Mark multiple notifications as read (true) or unread (false) based on the readStatus parameter
+     * Marks multiple seller notifications as read or unread based on the readStatus parameter.
      * Bulk mark notifications as read or unread
      */
     bulkMarkNotificationsAsReadRaw(requestParameters: NotificationsApiBulkMarkNotificationsAsReadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
     /**
-     * Mark multiple notifications as read (true) or unread (false) based on the readStatus parameter
+     * Marks multiple seller notifications as read or unread based on the readStatus parameter.
      * Bulk mark notifications as read or unread
      */
     bulkMarkNotificationsAsRead(requestParameters: NotificationsApiBulkMarkNotificationsAsReadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
-     * Download a specific notification attachment by attachment ID
+     * Downloads a file attachment from a seller notification.
      * Download notification attachment
      */
     downloadNotificationAttachmentRaw(requestParameters: NotificationsApiDownloadNotificationAttachmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Blob>>;
     /**
-     * Download a specific notification attachment by attachment ID
+     * Downloads a file attachment from a seller notification.
      * Download notification attachment
      */
     downloadNotificationAttachment(requestParameters: NotificationsApiDownloadNotificationAttachmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Blob>;
     /**
-     *
+     * Returns notification information for the seller user.
+     * Get notification details
      */
     getNotificationByIdRaw(requestParameters: NotificationsApiGetNotificationByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UserNotificationDto>>;
     /**
-     *
+     * Returns notification information for the seller user.
+     * Get notification details
      */
     getNotificationById(requestParameters: NotificationsApiGetNotificationByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserNotificationDto>;
     /**
-     *
+     * Lists notifications for the seller user.
+     * List seller notifications
      */
     listNotificationsRaw(requestParameters: NotificationsApiListNotificationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListNotifications200Response>>;
     /**
-     *
+     * Lists notifications for the seller user.
+     * List seller notifications
      */
     listNotifications(requestParameters?: NotificationsApiListNotificationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListNotifications200Response>;
 }

package/dist/apis/NotificationsApi.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,7 @@ var NotificationsApi = /** @class */ (function (_super) {
         return _super !== null && _super.apply(this, arguments) || this;
     }
     /**
-     * Mark multiple notifications as read (true) or unread (false) based on the readStatus parameter
+     * Marks multiple seller notifications as read or unread based on the readStatus parameter.
      * Bulk mark notifications as read or unread
      */
     NotificationsApi.prototype.bulkMarkNotificationsAsReadRaw = function (requestParameters, initOverrides) {
@@ -115,7 +115,7 @@ var NotificationsApi = /** @class */ (function (_super) {
         });
     };
     /**
-     * Mark multiple notifications as read (true) or unread (false) based on the readStatus parameter
+     * Marks multiple seller notifications as read or unread based on the readStatus parameter.
      * Bulk mark notifications as read or unread
      */
     NotificationsApi.prototype.bulkMarkNotificationsAsRead = function (requestParameters, initOverrides) {
@@ -131,7 +131,7 @@ var NotificationsApi = /** @class */ (function (_super) {
         });
     };
     /**
-     * Download a specific notification attachment by attachment ID
+     * Downloads a file attachment from a seller notification.
      * Download notification attachment
      */
     NotificationsApi.prototype.downloadNotificationAttachmentRaw = function (requestParameters, initOverrides) {
@@ -171,7 +171,7 @@ var NotificationsApi = /** @class */ (function (_super) {
         });
     };
     /**
-     * Download a specific notification attachment by attachment ID
+     * Downloads a file attachment from a seller notification.
      * Download notification attachment
      */
     NotificationsApi.prototype.downloadNotificationAttachment = function (requestParameters, initOverrides) {
@@ -189,7 +189,8 @@ var NotificationsApi = /** @class */ (function (_super) {
         });
     };
     /**
-     *
+     * Returns notification information for the seller user.
+     * Get notification details
      */
     NotificationsApi.prototype.getNotificationByIdRaw = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -225,7 +226,8 @@ var NotificationsApi = /** @class */ (function (_super) {
         });
     };
     /**
-     *
+     * Returns notification information for the seller user.
+     * Get notification details
      */
     NotificationsApi.prototype.getNotificationById = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -242,7 +244,8 @@ var NotificationsApi = /** @class */ (function (_super) {
         });
     };
     /**
-     *
+     * Lists notifications for the seller user.
+     * List seller notifications
      */
     NotificationsApi.prototype.listNotificationsRaw = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -263,6 +266,12 @@ var NotificationsApi = /** @class */ (function (_super) {
                         if (requestParameters['sortBy'] != null) {
                             queryParameters['sortBy'] = requestParameters['sortBy'];
                         }
+                        if (requestParameters['filterRead'] != null) {
+                            queryParameters['filter[read]'] = requestParameters['filterRead'];
+                        }
+                        if (requestParameters['filterType'] != null) {
+                            queryParameters['filter[type]'] = requestParameters['filterType'];
+                        }
                         headerParameters = {};
                         if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
                         token = this.configuration.accessToken;
@@ -287,7 +296,8 @@ var NotificationsApi = /** @class */ (function (_super) {
         });
     };
     /**
-     *
+     * Lists notifications for the seller user.
+     * List seller notifications
      */
     NotificationsApi.prototype.listNotifications = function () {
         return __awaiter(this, arguments, void 0, function (requestParameters, initOverrides) {

package/dist/apis/OrdersPublicApi.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
  *
@@ -34,11 +34,13 @@ export interface OrdersPublicApiUpdateOrderRequest {
  */
 export declare class OrdersPublicApi extends runtime.BaseAPI {
     /**
-     *
+     * Creates a new domain purchase order.
+     * Create order
      */
     createOrderRaw(requestParameters: OrdersPublicApiCreateOrderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ObjectId>>;
     /**
-     *
+     * Creates a new domain purchase order.
+     * Create order
      */
     createOrder(requestParameters: OrdersPublicApiCreateOrderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ObjectId>;
     /**
@@ -52,27 +54,33 @@ export declare class OrdersPublicApi extends runtime.BaseAPI {
      */
     createOrderManualTransaction(requestParameters: OrdersPublicApiCreateOrderManualTransactionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
-     *
+     * Downloads the pro-forma invoice PDF for an order before payment is completed.
+     * Download order pro-forma invoice
      */
     downloadOrderProformaInvoiceRaw(requestParameters: OrdersPublicApiDownloadOrderProformaInvoiceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Blob>>;
     /**
-     *
+     * Downloads the pro-forma invoice PDF for an order before payment is completed.
+     * Download order pro-forma invoice
      */
     downloadOrderProformaInvoice(requestParameters: OrdersPublicApiDownloadOrderProformaInvoiceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Blob>;
     /**
-     *
+     * Returns order information.
+     * Get order
      */
     getOrderRaw(requestParameters: OrdersPublicApiGetOrderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<OrderDto>>;
     /**
-     *
+     * Returns order information.
+     * Get order
      */
     getOrder(requestParameters: OrdersPublicApiGetOrderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OrderDto>;
     /**
-     *
+     * Updates buyer and billing information on an order that is still in an editable status.
+     * Update order
      */
     updateOrderRaw(requestParameters: OrdersPublicApiUpdateOrderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
     /**
-     *
+     * Updates buyer and billing information on an order that is still in an editable status.
+     * Update order
      */
     updateOrder(requestParameters: OrdersPublicApiUpdateOrderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
 }

package/dist/apis/OrdersPublicApi.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 OrdersPublicApi = /** @class */ (function (_super) {
         return _super !== null && _super.apply(this, arguments) || this;
     }
     /**
-     *
+     * Creates a new domain purchase order.
+     * Create order
      */
     OrdersPublicApi.prototype.createOrderRaw = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -105,7 +106,8 @@ var OrdersPublicApi = /** @class */ (function (_super) {
         });
     };
     /**
-     *
+     * Creates a new domain purchase order.
+     * Create order
      */
     OrdersPublicApi.prototype.createOrder = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -171,7 +173,8 @@ var OrdersPublicApi = /** @class */ (function (_super) {
         });
     };
     /**
-     *
+     * Downloads the pro-forma invoice PDF for an order before payment is completed.
+     * Download order pro-forma invoice
      */
     OrdersPublicApi.prototype.downloadOrderProformaInvoiceRaw = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -198,7 +201,8 @@ var OrdersPublicApi = /** @class */ (function (_super) {
         });
     };
     /**
-     *
+     * Downloads the pro-forma invoice PDF for an order before payment is completed.
+     * Download order pro-forma invoice
      */
     OrdersPublicApi.prototype.downloadOrderProformaInvoice = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -215,7 +219,8 @@ var OrdersPublicApi = /** @class */ (function (_super) {
         });
     };
     /**
-     *
+     * Returns order information.
+     * Get order
      */
     OrdersPublicApi.prototype.getOrderRaw = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -245,7 +250,8 @@ var OrdersPublicApi = /** @class */ (function (_super) {
         });
     };
     /**
-     *
+     * Returns order information.
+     * Get order
      */
     OrdersPublicApi.prototype.getOrder = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -262,7 +268,8 @@ var OrdersPublicApi = /** @class */ (function (_super) {
         });
     };
     /**
-     *
+     * Updates buyer and billing information on an order that is still in an editable status.
+     * Update order
      */
     OrdersPublicApi.prototype.updateOrderRaw = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -294,7 +301,8 @@ var OrdersPublicApi = /** @class */ (function (_super) {
         });
     };
     /**
-     *
+     * Updates buyer and billing information on an order that is still in an editable status.
+     * Update order
      */
     OrdersPublicApi.prototype.updateOrder = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {

package/dist/apis/PartnerApi.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
  *
@@ -29,27 +29,33 @@ export interface PartnerApiListDomainsWithUpdatedPricingRequest {
  */
 export declare class PartnerApi extends runtime.BaseAPI {
     /**
-     *
+     * Returns domains matching an exact root name, optionally filtered by TLD.
+     * Find domains by root name
      */
     domainsFindRaw(requestParameters: PartnerApiDomainsFindRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<PartnerDomainFindDto>>>;
     /**
-     *
+     * Returns domains matching an exact root name, optionally filtered by TLD.
+     * Find domains by root name
      */
     domainsFind(requestParameters: PartnerApiDomainsFindRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<PartnerDomainFindDto>>;
     /**
-     *
+     * Lists auctions available to the partner API key.
+     * List partner auctions
      */
     listAuctionsRaw(requestParameters: PartnerApiListAuctionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListAuctions200Response>>;
     /**
-     *
+     * Lists auctions available to the partner API key.
+     * List partner auctions
      */
     listAuctions(requestParameters?: PartnerApiListAuctionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListAuctions200Response>;
     /**
-     *
+     * Lists domains whose buy-now prices changed since the given date.
+     * List domains with updated pricing
      */
     listDomainsWithUpdatedPricingRaw(requestParameters: PartnerApiListDomainsWithUpdatedPricingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListDomainsWithUpdatedPricing200Response>>;
     /**
-     *
+     * Lists domains whose buy-now prices changed since the given date.
+     * List domains with updated pricing
      */
     listDomainsWithUpdatedPricing(requestParameters: PartnerApiListDomainsWithUpdatedPricingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListDomainsWithUpdatedPricing200Response>;
 }

package/dist/apis/PartnerApi.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 PartnerApi = /** @class */ (function (_super) {
         return _super !== null && _super.apply(this, arguments) || this;
     }
     /**
-     *
+     * Returns domains matching an exact root name, optionally filtered by TLD.
+     * Find domains by root name
      */
     PartnerApi.prototype.domainsFindRaw = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -113,7 +114,8 @@ var PartnerApi = /** @class */ (function (_super) {
         });
     };
     /**
-     *
+     * Returns domains matching an exact root name, optionally filtered by TLD.
+     * Find domains by root name
      */
     PartnerApi.prototype.domainsFind = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -130,7 +132,8 @@ var PartnerApi = /** @class */ (function (_super) {
         });
     };
     /**
-     *
+     * Lists auctions available to the partner API key.
+     * List partner auctions
      */
     PartnerApi.prototype.listAuctionsRaw = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -167,7 +170,8 @@ var PartnerApi = /** @class */ (function (_super) {
         });
     };
     /**
-     *
+     * Lists auctions available to the partner API key.
+     * List partner auctions
      */
     PartnerApi.prototype.listAuctions = function () {
         return __awaiter(this, arguments, void 0, function (requestParameters, initOverrides) {
@@ -185,7 +189,8 @@ var PartnerApi = /** @class */ (function (_super) {
         });
     };
     /**
-     *
+     * Lists domains whose buy-now prices changed since the given date.
+     * List domains with updated pricing
      */
     PartnerApi.prototype.listDomainsWithUpdatedPricingRaw = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -228,7 +233,8 @@ var PartnerApi = /** @class */ (function (_super) {
         });
     };
     /**
-     *
+     * Lists domains whose buy-now prices changed since the given date.
+     * List domains with updated pricing
      */
     PartnerApi.prototype.listDomainsWithUpdatedPricing = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {

package/dist/apis/SalesPublicApi.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
  *
@@ -21,10 +21,12 @@ export interface SalesPublicApiGetSalesRequest {
  */
 export declare class SalesPublicApi extends runtime.BaseAPI {
     /**
+     * Returns the latest domain sales, optionally filtered by TLD and formatted as JSON or RSS.
      * Get latest sales
      */
     getSalesRaw(requestParameters: SalesPublicApiGetSalesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PublicSalesDto>>;
     /**
+     * Returns the latest domain sales, optionally filtered by TLD and formatted as JSON or RSS.
      * Get latest sales
      */
     getSales(requestParameters?: SalesPublicApiGetSalesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PublicSalesDto>;

package/dist/apis/SalesPublicApi.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,6 +76,7 @@ var SalesPublicApi = /** @class */ (function (_super) {
         return _super !== null && _super.apply(this, arguments) || this;
     }
     /**
+     * Returns the latest domain sales, optionally filtered by TLD and formatted as JSON or RSS.
      * Get latest sales
      */
     SalesPublicApi.prototype.getSalesRaw = function (requestParameters, initOverrides) {
@@ -109,6 +110,7 @@ var SalesPublicApi = /** @class */ (function (_super) {
         });
     };
     /**
+     * Returns the latest domain sales, optionally filtered by TLD and formatted as JSON or RSS.
      * Get latest sales
      */
     SalesPublicApi.prototype.getSales = function () {

package/dist/apis/StatsApi.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
  *
@@ -29,59 +29,73 @@ export interface StatsApiGetTotalEarningsByCurrencyOverTimeRequest {
  */
 export declare class StatsApi extends runtime.BaseAPI {
     /**
-     *
+     * Returns the total pending payout amounts grouped by currency for the seller.
+     * Get pending payouts by currency
      */
     getPendingPayoutsByCurrencyRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<SellerPendingPayoutsByCurrencyStatsItemDto>>>;
     /**
-     *
+     * Returns the total pending payout amounts grouped by currency for the seller.
+     * Get pending payouts by currency
      */
     getPendingPayoutsByCurrency(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<SellerPendingPayoutsByCurrencyStatsItemDto>>;
     /**
-     *
+     * Returns remaining versus total lease-to-own income grouped by currency for the seller.
+     * Get lease-to-own income comparison
      */
     getRemainingVsTotalLeaseToOwnByCurrencyRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<SellerRemainingAndTotalLeaseToOwnByCurrencyStatsItemDto>>>;
     /**
-     *
+     * Returns remaining versus total lease-to-own income grouped by currency for the seller.
+     * Get lease-to-own income comparison
      */
     getRemainingVsTotalLeaseToOwnByCurrency(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<SellerRemainingAndTotalLeaseToOwnByCurrencyStatsItemDto>>;
     /**
-     *
+     * Returns sales statistics grouped by top-level domain for the seller within the specified date range and currency.
+     * Get sales by TLD
      */
     getSalesByTldRaw(requestParameters: StatsApiGetSalesByTldRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<SellerSalesByTldStatsItemDto>>>;
     /**
-     *
+     * Returns sales statistics grouped by top-level domain for the seller within the specified date range and currency.
+     * Get sales by TLD
      */
     getSalesByTld(requestParameters: StatsApiGetSalesByTldRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<SellerSalesByTldStatsItemDto>>;
     /**
-     *
+     * Returns the number of sales for the current seller account within the specified date range.
+     * Get sales count stats
      */
     getSalesCountRaw(requestParameters: StatsApiGetSalesCountRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<SellerSalesCountStatsItemDto>>>;
     /**
-     *
+     * Returns the number of sales for the current seller account within the specified date range.
+     * Get sales count stats
      */
     getSalesCount(requestParameters?: StatsApiGetSalesCountRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<SellerSalesCountStatsItemDto>>;
     /**
-     *
+     * Returns total earnings grouped by currency for the seller, optionally filtered by date range.
+     * Get total earnings by currency
      */
     getTotalEarningsByCurrencyRaw(requestParameters: StatsApiGetTotalEarningsByCurrencyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<SellerTotalEarningsByCurrencyStatsItemDto>>>;
     /**
-     *
+     * Returns total earnings grouped by currency for the seller, optionally filtered by date range.
+     * Get total earnings by currency
      */
     getTotalEarningsByCurrency(requestParameters?: StatsApiGetTotalEarningsByCurrencyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<SellerTotalEarningsByCurrencyStatsItemDto>>;
     /**
-     *
+     * Returns total earnings over time grouped by currency for the seller within the specified date range.
+     * Get earnings over time by currency
      */
     getTotalEarningsByCurrencyOverTimeRaw(requestParameters: StatsApiGetTotalEarningsByCurrencyOverTimeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<SellerTotalEarningsByCurrencyOverTimeStatsItemDto>>>;
     /**
-     *
+     * Returns total earnings over time grouped by currency for the seller within the specified date range.
+     * Get earnings over time by currency
      */
     getTotalEarningsByCurrencyOverTime(requestParameters?: StatsApiGetTotalEarningsByCurrencyOverTimeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<SellerTotalEarningsByCurrencyOverTimeStatsItemDto>>;
     /**
-     *
+     * Returns the total monthly rent income grouped by currency for the seller.
+     * Get monthly rent income by currency
      */
     getTotalMonthlyRentIncomeByCurrencyRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<SellerTotalRentMonthlyIncomeByCurrencyStatsItemDto>>>;
     /**
-     *
+     * Returns the total monthly rent income grouped by currency for the seller.
+     * Get monthly rent income by currency
      */
     getTotalMonthlyRentIncomeByCurrency(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<SellerTotalRentMonthlyIncomeByCurrencyStatsItemDto>>;
 }