@randock/nameshift-api-client 0.0.436 → 0.0.437

package/dist/apis/BuyersApi.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. - **Webhook tags** — Payment provider, KYC provider, and email provider callbacks (dev-only in Swagger UI).
  *
  * The version of the OpenAPI document: 1.0
  *
@@ -76,7 +76,8 @@ var BuyersApi = /** @class */ (function (_super) {
         return _super !== null && _super.apply(this, arguments) || this;
     }
     /**
-     *
+     * Accepts the current seller counter-offer on the lead.
+     * Accept seller counter-offer
      */
     BuyersApi.prototype.acceptBuyerLeadOfferRaw = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -112,7 +113,8 @@ var BuyersApi = /** @class */ (function (_super) {
         });
     };
     /**
-     *
+     * Accepts the current seller counter-offer on the lead.
+     * Accept seller counter-offer
      */
     BuyersApi.prototype.acceptBuyerLeadOffer = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -127,7 +129,8 @@ var BuyersApi = /** @class */ (function (_super) {
         });
     };
     /**
-     *
+     * Adds a DNS record to the domain managed by the subscription. NS and SOA records are not allowed.
+     * Add DNS record
      */
     BuyersApi.prototype.addSubscriptionDomainRecordRaw = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -168,7 +171,8 @@ var BuyersApi = /** @class */ (function (_super) {
         });
     };
     /**
-     *
+     * Adds a DNS record to the domain managed by the subscription. NS and SOA records are not allowed.
+     * Add DNS record
      */
     BuyersApi.prototype.addSubscriptionDomainRecord = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -183,7 +187,8 @@ var BuyersApi = /** @class */ (function (_super) {
         });
     };
     /**
-     *
+     * Verifies multiple leads for the buyer in a single request.
+     * Batch verify buyer leads
      */
     BuyersApi.prototype.batchVerifyBuyerLeadsRaw = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -221,7 +226,8 @@ var BuyersApi = /** @class */ (function (_super) {
         });
     };
     /**
-     *
+     * Verifies multiple leads for the buyer in a single request.
+     * Batch verify buyer leads
      */
     BuyersApi.prototype.batchVerifyBuyerLeads = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -236,7 +242,8 @@ var BuyersApi = /** @class */ (function (_super) {
         });
     };
     /**
-     *
+     * Places a bid on the specified auction. Requires phone verification and completed KYC.
+     * Place auction bid
      */
     BuyersApi.prototype.bidRaw = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -277,7 +284,8 @@ var BuyersApi = /** @class */ (function (_super) {
         });
     };
     /**
-     *
+     * Places a bid on the specified auction. Requires phone verification and completed KYC.
+     * Place auction bid
      */
     BuyersApi.prototype.bid = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -292,7 +300,7 @@ var BuyersApi = /** @class */ (function (_super) {
         });
     };
     /**
-     * Mark multiple notifications as read (true) or unread (false) based on the readStatus parameter
+     * Marks multiple buyer notifications as read or unread based on the readStatus parameter.
      * Bulk mark buyer notifications as read or unread
      */
     BuyersApi.prototype.bulkMarkBuyerNotificationsAsReadRaw = function (requestParameters, initOverrides) {
@@ -331,7 +339,7 @@ var BuyersApi = /** @class */ (function (_super) {
         });
     };
     /**
-     * Mark multiple notifications as read (true) or unread (false) based on the readStatus parameter
+     * Marks multiple buyer notifications as read or unread based on the readStatus parameter.
      * Bulk mark buyer notifications as read or unread
      */
     BuyersApi.prototype.bulkMarkBuyerNotificationsAsRead = function (requestParameters, initOverrides) {
@@ -347,7 +355,8 @@ var BuyersApi = /** @class */ (function (_super) {
         });
     };
     /**
-     *
+     * Marks multiple lead messages as read for the buyer.
+     * Mark lead messages as read
      */
     BuyersApi.prototype.bulkReadBuyerLeadMessageRaw = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -388,7 +397,8 @@ var BuyersApi = /** @class */ (function (_super) {
         });
     };
     /**
-     *
+     * Marks multiple lead messages as read for the buyer.
+     * Mark lead messages as read
      */
     BuyersApi.prototype.bulkReadBuyerLeadMessage = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -403,7 +413,8 @@ var BuyersApi = /** @class */ (function (_super) {
         });
     };
     /**
-     *
+     * Returns the current buyer profile.
+     * Get current buyer session
      */
     BuyersApi.prototype.buyerMeRaw = function (initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -436,7 +447,8 @@ var BuyersApi = /** @class */ (function (_super) {
         });
     };
     /**
-     *
+     * Returns the current buyer profile.
+     * Get current buyer session
      */
     BuyersApi.prototype.buyerMe = function (initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -453,7 +465,8 @@ var BuyersApi = /** @class */ (function (_super) {
         });
     };
     /**
-     *
+     * Schedules cancellation of an active buyer subscription.
+     * Cancel subscription
      */
     BuyersApi.prototype.cancelSubscriptionRaw = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -489,7 +502,8 @@ var BuyersApi = /** @class */ (function (_super) {
         });
     };
     /**
-     *
+     * Schedules cancellation of an active buyer subscription.
+     * Cancel subscription
      */
     BuyersApi.prototype.cancelSubscription = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -504,7 +518,8 @@ var BuyersApi = /** @class */ (function (_super) {
         });
     };
     /**
-     *
+     * Creates a new message from the buyer in the lead conversation thread.
+     * Send a lead message
      */
     BuyersApi.prototype.createBuyerLeadMessageRaw = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -545,7 +560,8 @@ var BuyersApi = /** @class */ (function (_super) {
         });
     };
     /**
-     *
+     * Creates a new message from the buyer in the lead conversation thread.
+     * Send a lead message
      */
     BuyersApi.prototype.createBuyerLeadMessage = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -562,7 +578,8 @@ var BuyersApi = /** @class */ (function (_super) {
         });
     };
     /**
-     *
+     * Deletes multiple leads from the buyer account. Only leads in a deletable status are removed.
+     * Delete buyer leads
      */
     BuyersApi.prototype.deleteBuyerLeadsRaw = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -600,7 +617,8 @@ var BuyersApi = /** @class */ (function (_super) {
         });
     };
     /**
-     *
+     * Deletes multiple leads from the buyer account. Only leads in a deletable status are removed.
+     * Delete buyer leads
      */
     BuyersApi.prototype.deleteBuyerLeads = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -615,7 +633,8 @@ var BuyersApi = /** @class */ (function (_super) {
         });
     };
     /**
-     *
+     * Permanently deletes the buyer account and associated data. This action cannot be undone.
+     * Delete buyer account
      */
     BuyersApi.prototype.deleteMeRaw = function (initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -648,7 +667,8 @@ var BuyersApi = /** @class */ (function (_super) {
         });
     };
     /**
-     *
+     * Permanently deletes the buyer account and associated data. This action cannot be undone.
+     * Delete buyer account
      */
     BuyersApi.prototype.deleteMe = function (initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -663,7 +683,8 @@ var BuyersApi = /** @class */ (function (_super) {
         });
     };
     /**
-     *
+     * Downloads the PDF document for a buyer invoice.
+     * Download buyer invoice
      */
     BuyersApi.prototype.downloadBuyerInvoiceRaw = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -699,7 +720,8 @@ var BuyersApi = /** @class */ (function (_super) {
         });
     };
     /**
-     *
+     * Downloads the PDF document for a buyer invoice.
+     * Download buyer invoice
      */
     BuyersApi.prototype.downloadBuyerInvoice = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -716,7 +738,7 @@ var BuyersApi = /** @class */ (function (_super) {
         });
     };
     /**
-     * Download a specific notification attachment by attachment ID
+     * Downloads a file attachment from a buyer notification.
      * Download buyer notification attachment
      */
     BuyersApi.prototype.downloadBuyerNotificationAttachmentRaw = function (requestParameters, initOverrides) {
@@ -756,7 +778,7 @@ var BuyersApi = /** @class */ (function (_super) {
         });
     };
     /**
-     * Download a specific notification attachment by attachment ID
+     * Downloads a file attachment from a buyer notification.
      * Download buyer notification attachment
      */
     BuyersApi.prototype.downloadBuyerNotificationAttachment = function (requestParameters, initOverrides) {
@@ -774,7 +796,8 @@ var BuyersApi = /** @class */ (function (_super) {
         });
     };
     /**
-     *
+     * Generates a new access token for the buyer, typically used for magic-link authentication flows.
+     * Generate buyer access token
      */
     BuyersApi.prototype.generateBuyerAccessTokenRaw = function (initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -807,7 +830,8 @@ var BuyersApi = /** @class */ (function (_super) {
         });
     };
     /**
-     *
+     * Generates a new access token for the buyer, typically used for magic-link authentication flows.
+     * Generate buyer access token
      */
     BuyersApi.prototype.generateBuyerAccessToken = function (initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -824,7 +848,8 @@ var BuyersApi = /** @class */ (function (_super) {
         });
     };
     /**
-     *
+     * Returns auction information for the buyer.
+     * Get buyer auction detail
      */
     BuyersApi.prototype.getBuyerAuctionDetailRaw = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -860,7 +885,8 @@ var BuyersApi = /** @class */ (function (_super) {
         });
     };
     /**
-     *
+     * Returns auction information for the buyer.
+     * Get buyer auction detail
      */
     BuyersApi.prototype.getBuyerAuctionDetail = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -877,7 +903,8 @@ var BuyersApi = /** @class */ (function (_super) {
         });
     };
     /**
-     *
+     * Lists auctions the buyer is participating in.
+     * List buyer auctions
      */
     BuyersApi.prototype.getBuyerAuctionsRaw = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -898,6 +925,9 @@ var BuyersApi = /** @class */ (function (_super) {
                         if (requestParameters['sortBy'] != null) {
                             queryParameters['sortBy'] = requestParameters['sortBy'];
                         }
+                        if (requestParameters['filterStatus'] != null) {
+                            queryParameters['filter[status]'] = requestParameters['filterStatus'];
+                        }
                         headerParameters = {};
                         if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
                         token = this.configuration.accessToken;
@@ -922,7 +952,8 @@ var BuyersApi = /** @class */ (function (_super) {
         });
     };
     /**
-     *
+     * Lists auctions the buyer is participating in.
+     * List buyer auctions
      */
     BuyersApi.prototype.getBuyerAuctions = function () {
         return __awaiter(this, arguments, void 0, function (requestParameters, initOverrides) {
@@ -940,7 +971,8 @@ var BuyersApi = /** @class */ (function (_super) {
         });
     };
     /**
-     *
+     * Lists invoices for the buyer.
+     * List buyer invoices
      */
     BuyersApi.prototype.getBuyerInvoicesRaw = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -961,6 +993,15 @@ var BuyersApi = /** @class */ (function (_super) {
                         if (requestParameters['sortBy'] != null) {
                             queryParameters['sortBy'] = requestParameters['sortBy'];
                         }
+                        if (requestParameters['filterDateFrom'] != null) {
+                            queryParameters['filter[dateFrom]'] = requestParameters['filterDateFrom'];
+                        }
+                        if (requestParameters['filterDateTo'] != null) {
+                            queryParameters['filter[dateTo]'] = requestParameters['filterDateTo'];
+                        }
+                        if (requestParameters['filterStatus'] != null) {
+                            queryParameters['filter[status]'] = requestParameters['filterStatus'];
+                        }
                         headerParameters = {};
                         if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
                         token = this.configuration.accessToken;
@@ -985,7 +1026,8 @@ var BuyersApi = /** @class */ (function (_super) {
         });
     };
     /**
-     *
+     * Lists invoices for the buyer.
+     * List buyer invoices
      */
     BuyersApi.prototype.getBuyerInvoices = function () {
         return __awaiter(this, arguments, void 0, function (requestParameters, initOverrides) {
@@ -1003,7 +1045,8 @@ var BuyersApi = /** @class */ (function (_super) {
         });
     };
     /**
-     *
+     * Returns lead information for the buyer.
+     * Get buyer lead details
      */
     BuyersApi.prototype.getBuyerLeadRaw = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -1039,7 +1082,8 @@ var BuyersApi = /** @class */ (function (_super) {
         });
     };
     /**
-     *
+     * Returns lead information for the buyer.
+     * Get buyer lead details
      */
     BuyersApi.prototype.getBuyerLead = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -1056,7 +1100,8 @@ var BuyersApi = /** @class */ (function (_super) {
         });
     };
     /**
-     *
+     * Lists messages in a lead conversation for the buyer.
+     * List lead messages
      */
     BuyersApi.prototype.getBuyerLeadMessagesRaw = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -1092,7 +1137,8 @@ var BuyersApi = /** @class */ (function (_super) {
         });
     };
     /**
-     *
+     * Lists messages in a lead conversation for the buyer.
+     * List lead messages
      */
     BuyersApi.prototype.getBuyerLeadMessages = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -1109,7 +1155,8 @@ var BuyersApi = /** @class */ (function (_super) {
         });
     };
     /**
-     *
+     * Lists leads for the buyer.
+     * List buyer leads
      */
     BuyersApi.prototype.getBuyerLeadsRaw = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -1130,6 +1177,9 @@ var BuyersApi = /** @class */ (function (_super) {
                         if (requestParameters['sortBy'] != null) {
                             queryParameters['sortBy'] = requestParameters['sortBy'];
                         }
+                        if (requestParameters['filterStatus'] != null) {
+                            queryParameters['filter[status]'] = requestParameters['filterStatus'];
+                        }
                         headerParameters = {};
                         if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
                         token = this.configuration.accessToken;
@@ -1154,7 +1204,8 @@ var BuyersApi = /** @class */ (function (_super) {
         });
     };
     /**
-     *
+     * Lists leads for the buyer.
+     * List buyer leads
      */
     BuyersApi.prototype.getBuyerLeads = function () {
         return __awaiter(this, arguments, void 0, function (requestParameters, initOverrides) {
@@ -1172,7 +1223,8 @@ var BuyersApi = /** @class */ (function (_super) {
         });
     };
     /**
-     *
+     * Returns notification information for the buyer.
+     * Get buyer notification details
      */
     BuyersApi.prototype.getBuyerNotificationByIdRaw = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -1208,7 +1260,8 @@ var BuyersApi = /** @class */ (function (_super) {
         });
     };
     /**
-     *
+     * Returns notification information for the buyer.
+     * Get buyer notification details
      */
     BuyersApi.prototype.getBuyerNotificationById = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -1225,7 +1278,8 @@ var BuyersApi = /** @class */ (function (_super) {
         });
     };
     /**
-     *
+     * Returns the notification preferences for the buyer.
+     * Get notification settings
      */
     BuyersApi.prototype.getBuyerNotificationSettingsRaw = function (initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -1258,7 +1312,8 @@ var BuyersApi = /** @class */ (function (_super) {
         });
     };
     /**
-     *
+     * Returns the notification preferences for the buyer.
+     * Get notification settings
      */
     BuyersApi.prototype.getBuyerNotificationSettings = function (initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -1275,7 +1330,8 @@ var BuyersApi = /** @class */ (function (_super) {
         });
     };
     /**
-     *
+     * Lists subscriptions for the buyer.
+     * List buyer subscriptions
      */
     BuyersApi.prototype.getBuyerSubscriptionsRaw = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -1296,6 +1352,9 @@ var BuyersApi = /** @class */ (function (_super) {
                         if (requestParameters['sortBy'] != null) {
                             queryParameters['sortBy'] = requestParameters['sortBy'];
                         }
+                        if (requestParameters['filterStatus'] != null) {
+                            queryParameters['filter[status]'] = requestParameters['filterStatus'];
+                        }
                         headerParameters = {};
                         if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
                         token = this.configuration.accessToken;
@@ -1320,7 +1379,8 @@ var BuyersApi = /** @class */ (function (_super) {
         });
     };
     /**
-     *
+     * Lists subscriptions for the buyer.
+     * List buyer subscriptions
      */
     BuyersApi.prototype.getBuyerSubscriptions = function () {
         return __awaiter(this, arguments, void 0, function (requestParameters, initOverrides) {
@@ -1338,7 +1398,8 @@ var BuyersApi = /** @class */ (function (_super) {
         });
     };
     /**
-     *
+     * Returns task information for the buyer.
+     * Get buyer task details
      */
     BuyersApi.prototype.getBuyerTaskRaw = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -1374,7 +1435,8 @@ var BuyersApi = /** @class */ (function (_super) {
         });
     };
     /**
-     *
+     * Returns task information for the buyer.
+     * Get buyer task details
      */
     BuyersApi.prototype.getBuyerTask = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -1391,7 +1453,8 @@ var BuyersApi = /** @class */ (function (_super) {
         });
     };
     /**
-     *
+     * Lists domain transfers for the buyer.
+     * List domain transfers
      */
     BuyersApi.prototype.getBuyerTransfersRaw = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -1412,6 +1475,9 @@ var BuyersApi = /** @class */ (function (_super) {
                         if (requestParameters['sortBy'] != null) {
                             queryParameters['sortBy'] = requestParameters['sortBy'];
                         }
+                        if (requestParameters['filterStatus'] != null) {
+                            queryParameters['filter[status]'] = requestParameters['filterStatus'];
+                        }
                         headerParameters = {};
                         if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
                         token = this.configuration.accessToken;
@@ -1436,7 +1502,8 @@ var BuyersApi = /** @class */ (function (_super) {
         });
     };
     /**
-     *
+     * Lists domain transfers for the buyer.
+     * List domain transfers
      */
     BuyersApi.prototype.getBuyerTransfers = function () {
         return __awaiter(this, arguments, void 0, function (requestParameters, initOverrides) {
@@ -1454,7 +1521,8 @@ var BuyersApi = /** @class */ (function (_super) {
         });
     };
     /**
-     *
+     * Returns DNS configuration for a subscription domain.
+     * Get subscription DNS records
      */
     BuyersApi.prototype.getDomainRecordsBySubscriptionIdRaw = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -1490,7 +1558,8 @@ var BuyersApi = /** @class */ (function (_super) {
         });
     };
     /**
-     *
+     * Returns DNS configuration for a subscription domain.
+     * Get subscription DNS records
      */
     BuyersApi.prototype.getDomainRecordsBySubscriptionId = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -1507,7 +1576,8 @@ var BuyersApi = /** @class */ (function (_super) {
         });
     };
     /**
-     *
+     * Returns configuration presets for lead offers.
+     * Get lease-to-own configuration presets
      */
     BuyersApi.prototype.getLeadLeaseToOwnConfigurationPresetsRaw = function (initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -1540,7 +1610,8 @@ var BuyersApi = /** @class */ (function (_super) {
         });
     };
     /**
-     *
+     * Returns configuration presets for lead offers.
+     * Get lease-to-own configuration presets
      */
     BuyersApi.prototype.getLeadLeaseToOwnConfigurationPresets = function (initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -1557,7 +1628,8 @@ var BuyersApi = /** @class */ (function (_super) {
         });
     };
     /**
-     *
+     * Returns the EPP auth code for a domain transfer when the buyer is eligible to retrieve it.
+     * Get domain transfer auth code
      */
     BuyersApi.prototype.getTransferAuthCodeRaw = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -1593,7 +1665,8 @@ var BuyersApi = /** @class */ (function (_super) {
         });
     };
     /**
-     *
+     * Returns the EPP auth code for a domain transfer when the buyer is eligible to retrieve it.
+     * Get domain transfer auth code
      */
     BuyersApi.prototype.getTransferAuthCode = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -1610,7 +1683,8 @@ var BuyersApi = /** @class */ (function (_super) {
         });
     };
     /**
-     *
+     * Lists notifications for the buyer.
+     * List buyer notifications
      */
     BuyersApi.prototype.listBuyerNotificationsRaw = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -1631,6 +1705,9 @@ var BuyersApi = /** @class */ (function (_super) {
                         if (requestParameters['sortBy'] != null) {
                             queryParameters['sortBy'] = requestParameters['sortBy'];
                         }
+                        if (requestParameters['filterRead'] != null) {
+                            queryParameters['filter[read]'] = requestParameters['filterRead'];
+                        }
                         headerParameters = {};
                         if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
                         token = this.configuration.accessToken;
@@ -1655,7 +1732,8 @@ var BuyersApi = /** @class */ (function (_super) {
         });
     };
     /**
-     *
+     * Lists notifications for the buyer.
+     * List buyer notifications
      */
     BuyersApi.prototype.listBuyerNotifications = function () {
         return __awaiter(this, arguments, void 0, function (requestParameters, initOverrides) {
@@ -1673,7 +1751,8 @@ var BuyersApi = /** @class */ (function (_super) {
         });
     };
     /**
-     *
+     * Submits the buyer confirmation or rejection for a domain transfer workflow step.
+     * Confirm or reject domain transfer step
      */
     BuyersApi.prototype.patchDomainTransferConfirmationRaw = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -1714,7 +1793,8 @@ var BuyersApi = /** @class */ (function (_super) {
         });
     };
     /**
-     *
+     * Submits the buyer confirmation or rejection for a domain transfer workflow step.
+     * Confirm or reject domain transfer step
      */
     BuyersApi.prototype.patchDomainTransferConfirmation = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -1729,7 +1809,8 @@ var BuyersApi = /** @class */ (function (_super) {
         });
     };
     /**
-     *
+     * Sets or updates the buyer offer on a lead.
+     * Submit a buyer offer
      */
     BuyersApi.prototype.putBuyerOfferRaw = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -1770,7 +1851,8 @@ var BuyersApi = /** @class */ (function (_super) {
         });
     };
     /**
-     *
+     * Sets or updates the buyer offer on a lead.
+     * Submit a buyer offer
      */
     BuyersApi.prototype.putBuyerOffer = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -1785,7 +1867,8 @@ var BuyersApi = /** @class */ (function (_super) {
         });
     };
     /**
-     *
+     * Registers the buyer as an auction participant.
+     * Register auction buyer
      */
     BuyersApi.prototype.registerRaw = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -1823,7 +1906,8 @@ var BuyersApi = /** @class */ (function (_super) {
         });
     };
     /**
-     *
+     * Registers the buyer as an auction participant.
+     * Register auction buyer
      */
     BuyersApi.prototype.register = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -1838,7 +1922,8 @@ var BuyersApi = /** @class */ (function (_super) {
         });
     };
     /**
-     *
+     * Initiates phone number verification for the auction buyer via SMS or WhatsApp.
+     * Register auction buyer phone
      */
     BuyersApi.prototype.registerPhoneRaw = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -1876,7 +1961,8 @@ var BuyersApi = /** @class */ (function (_super) {
         });
     };
     /**
-     *
+     * Initiates phone number verification for the auction buyer via SMS or WhatsApp.
+     * Register auction buyer phone
      */
     BuyersApi.prototype.registerPhone = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -1891,7 +1977,8 @@ var BuyersApi = /** @class */ (function (_super) {
         });
     };
     /**
-     *
+     * Removes a DNS record from the subscription managed domain.
+     * Remove DNS record
      */
     BuyersApi.prototype.removeSubscriptionDomainRecordRaw = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -1932,7 +2019,8 @@ var BuyersApi = /** @class */ (function (_super) {
         });
     };
     /**
-     *
+     * Removes a DNS record from the subscription managed domain.
+     * Remove DNS record
      */
     BuyersApi.prototype.removeSubscriptionDomainRecord = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -1947,7 +2035,8 @@ var BuyersApi = /** @class */ (function (_super) {
         });
     };
     /**
-     *
+     * Revokes a previously scheduled subscription cancellation, keeping the subscription active.
+     * Revoke scheduled cancellation
      */
     BuyersApi.prototype.revokeScheduledSubscriptionCancellationRaw = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -1983,7 +2072,8 @@ var BuyersApi = /** @class */ (function (_super) {
         });
     };
     /**
-     *
+     * Revokes a previously scheduled subscription cancellation, keeping the subscription active.
+     * Revoke scheduled cancellation
      */
     BuyersApi.prototype.revokeScheduledSubscriptionCancellation = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -1998,7 +2088,8 @@ var BuyersApi = /** @class */ (function (_super) {
         });
     };
     /**
-     *
+     * Stores the preferred locale for the buyer account.
+     * Update buyer locale
      */
     BuyersApi.prototype.setLocaleRaw = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -2036,7 +2127,8 @@ var BuyersApi = /** @class */ (function (_super) {
         });
     };
     /**
-     *
+     * Stores the preferred locale for the buyer account.
+     * Update buyer locale
      */
     BuyersApi.prototype.setLocale = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -2051,7 +2143,8 @@ var BuyersApi = /** @class */ (function (_super) {
         });
     };
     /**
-     *
+     * Mutes or unmutes auction notifications for the buyer.
+     * Update auction mute status
      */
     BuyersApi.prototype.updateAuctionMuteStatusRaw = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -2092,7 +2185,8 @@ var BuyersApi = /** @class */ (function (_super) {
         });
     };
     /**
-     *
+     * Mutes or unmutes auction notifications for the buyer.
+     * Update auction mute status
      */
     BuyersApi.prototype.updateAuctionMuteStatus = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -2107,7 +2201,8 @@ var BuyersApi = /** @class */ (function (_super) {
         });
     };
     /**
-     *
+     * Submits buyer transfer information required for certain domain transfer workflows.
+     * Update transfer buyer info
      */
     BuyersApi.prototype.updateBuyerDomainTransferBuyerInfoRaw = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -2148,7 +2243,8 @@ var BuyersApi = /** @class */ (function (_super) {
         });
     };
     /**
-     *
+     * Submits buyer transfer information required for certain domain transfer workflows.
+     * Update transfer buyer info
      */
     BuyersApi.prototype.updateBuyerDomainTransferBuyerInfo = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -2163,7 +2259,8 @@ var BuyersApi = /** @class */ (function (_super) {
         });
     };
     /**
-     *
+     * Updates notification preferences for the buyer.
+     * Update notification settings
      */
     BuyersApi.prototype.updateBuyerNotificationSettingsRaw = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -2201,7 +2298,8 @@ var BuyersApi = /** @class */ (function (_super) {
         });
     };
     /**
-     *
+     * Updates notification preferences for the buyer.
+     * Update notification settings
      */
     BuyersApi.prototype.updateBuyerNotificationSettings = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -2216,7 +2314,8 @@ var BuyersApi = /** @class */ (function (_super) {
         });
     };
     /**
-     *
+     * Updates the IPS tag for a .uk domain transfer during the buyer workflow step.
+     * Update IPS tag
      */
     BuyersApi.prototype.updateDomainTransferIpsTagRaw = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -2257,7 +2356,8 @@ var BuyersApi = /** @class */ (function (_super) {
         });
     };
     /**
-     *
+     * Updates the IPS tag for a .uk domain transfer during the buyer workflow step.
+     * Update IPS tag
      */
     BuyersApi.prototype.updateDomainTransferIpsTag = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -2272,7 +2372,8 @@ var BuyersApi = /** @class */ (function (_super) {
         });
     };
     /**
-     *
+     * Updates whether the lead is muted for the buyer.
+     * Mute or unmute a lead
      */
     BuyersApi.prototype.updateLeadMuteStatusForBuyerRaw = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -2313,7 +2414,8 @@ var BuyersApi = /** @class */ (function (_super) {
         });
     };
     /**
-     *
+     * Updates whether the lead is muted for the buyer.
+     * Mute or unmute a lead
      */
     BuyersApi.prototype.updateLeadMuteStatusForBuyer = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -2328,7 +2430,8 @@ var BuyersApi = /** @class */ (function (_super) {
         });
     };
     /**
-     *
+     * Replaces the nameserver list for the subscription managed domain.
+     * Update domain nameservers
      */
     BuyersApi.prototype.updateSubscriptionDomainNameserversRaw = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -2369,7 +2472,8 @@ var BuyersApi = /** @class */ (function (_super) {
         });
     };
     /**
-     *
+     * Replaces the nameserver list for the subscription managed domain.
+     * Update domain nameservers
      */
     BuyersApi.prototype.updateSubscriptionDomainNameservers = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -2384,7 +2488,8 @@ var BuyersApi = /** @class */ (function (_super) {
         });
     };
     /**
-     *
+     * Updates an existing DNS record on the subscription managed domain.
+     * Update DNS record
      */
     BuyersApi.prototype.updateSubscriptionDomainRecordRaw = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -2425,7 +2530,8 @@ var BuyersApi = /** @class */ (function (_super) {
         });
     };
     /**
-     *
+     * Updates an existing DNS record on the subscription managed domain.
+     * Update DNS record
      */
     BuyersApi.prototype.updateSubscriptionDomainRecord = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -2440,7 +2546,8 @@ var BuyersApi = /** @class */ (function (_super) {
         });
     };
     /**
-     *
+     * Updates whether a task is muted for the buyer.
+     * Mute or unmute a task
      */
     BuyersApi.prototype.updateTaskMuteStatusForBuyerRaw = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -2481,7 +2588,8 @@ var BuyersApi = /** @class */ (function (_super) {
         });
     };
     /**
-     *
+     * Updates whether a task is muted for the buyer.
+     * Mute or unmute a task
      */
     BuyersApi.prototype.updateTaskMuteStatusForBuyer = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -2496,7 +2604,8 @@ var BuyersApi = /** @class */ (function (_super) {
         });
     };
     /**
-     *
+     * Verifies a single lead for the buyer.
+     * Verify a lead
      */
     BuyersApi.prototype.verifyBuyerLeadRaw = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -2532,7 +2641,8 @@ var BuyersApi = /** @class */ (function (_super) {
         });
     };
     /**
-     *
+     * Verifies a single lead for the buyer.
+     * Verify a lead
      */
     BuyersApi.prototype.verifyBuyerLead = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -2547,7 +2657,8 @@ var BuyersApi = /** @class */ (function (_super) {
         });
     };
     /**
-     *
+     * Verifies the one-time password sent to the auction buyer phone and returns the updated buyer profile.
+     * Verify phone OTP
      */
     BuyersApi.prototype.verifyPhoneOtpRaw = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -2585,7 +2696,8 @@ var BuyersApi = /** @class */ (function (_super) {
         });
     };
     /**
-     *
+     * Verifies the one-time password sent to the auction buyer phone and returns the updated buyer profile.
+     * Verify phone OTP
      */
     BuyersApi.prototype.verifyPhoneOtp = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {