@randock/nameshift-api-client 0.0.436 → 0.0.438

package/dist/apis/BuyersApi.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
  *
@@ -53,16 +53,24 @@ export interface BuyersApiGetBuyerAuctionDetailRequest {
     auctionId: string;
 }
 export interface BuyersApiGetBuyerAuctionsRequest {
-    filter?: object;
+    filter?: {
+        [key: string]: string;
+    };
     page?: number;
     limit?: number;
     sortBy?: Array<string>;
+    filterStatus?: string;
 }
 export interface BuyersApiGetBuyerInvoicesRequest {
-    filter?: object;
+    filter?: {
+        [key: string]: string;
+    };
     page?: number;
     limit?: number;
     sortBy?: Array<string>;
+    filterDateFrom?: string;
+    filterDateTo?: string;
+    filterStatus?: string;
 }
 export interface BuyersApiGetBuyerLeadRequest {
     leadId: string;
@@ -71,28 +79,37 @@ export interface BuyersApiGetBuyerLeadMessagesRequest {
     leadId: string;
 }
 export interface BuyersApiGetBuyerLeadsRequest {
-    filter?: object;
+    filter?: {
+        [key: string]: string;
+    };
     page?: number;
     limit?: number;
     sortBy?: Array<string>;
+    filterStatus?: string;
 }
 export interface BuyersApiGetBuyerNotificationByIdRequest {
     notificationId: string;
 }
 export interface BuyersApiGetBuyerSubscriptionsRequest {
-    filter?: object;
+    filter?: {
+        [key: string]: string;
+    };
     page?: number;
     limit?: number;
     sortBy?: Array<string>;
+    filterStatus?: string;
 }
 export interface BuyersApiGetBuyerTaskRequest {
     taskId: string;
 }
 export interface BuyersApiGetBuyerTransfersRequest {
-    filter?: object;
+    filter?: {
+        [key: string]: string;
+    };
     page?: number;
     limit?: number;
     sortBy?: Array<string>;
+    filterStatus?: string;
 }
 export interface BuyersApiGetDomainRecordsBySubscriptionIdRequest {
     subscriptionId: string;
@@ -101,10 +118,13 @@ export interface BuyersApiGetTransferAuthCodeRequest {
     transferId: string;
 }
 export interface BuyersApiListBuyerNotificationsRequest {
-    filter?: object;
+    filter?: {
+        [key: string]: string;
+    };
     page?: number;
     limit?: number;
     sortBy?: Array<string>;
+    filterRead?: string;
 }
 export interface BuyersApiPatchDomainTransferConfirmationRequest {
     transferId: string;
@@ -172,375 +192,463 @@ export interface BuyersApiVerifyPhoneOtpRequest {
  */
 export declare class BuyersApi extends runtime.BaseAPI {
     /**
-     *
+     * Accepts the current seller counter-offer on the lead.
+     * Accept seller counter-offer
      */
     acceptBuyerLeadOfferRaw(requestParameters: BuyersApiAcceptBuyerLeadOfferRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
     /**
-     *
+     * Accepts the current seller counter-offer on the lead.
+     * Accept seller counter-offer
      */
     acceptBuyerLeadOffer(requestParameters: BuyersApiAcceptBuyerLeadOfferRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
-     *
+     * Adds a DNS record to the domain managed by the subscription. NS and SOA records are not allowed.
+     * Add DNS record
      */
     addSubscriptionDomainRecordRaw(requestParameters: BuyersApiAddSubscriptionDomainRecordRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
     /**
-     *
+     * Adds a DNS record to the domain managed by the subscription. NS and SOA records are not allowed.
+     * Add DNS record
      */
     addSubscriptionDomainRecord(requestParameters: BuyersApiAddSubscriptionDomainRecordRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
-     *
+     * Verifies multiple leads for the buyer in a single request.
+     * Batch verify buyer leads
      */
     batchVerifyBuyerLeadsRaw(requestParameters: BuyersApiBatchVerifyBuyerLeadsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
     /**
-     *
+     * Verifies multiple leads for the buyer in a single request.
+     * Batch verify buyer leads
      */
     batchVerifyBuyerLeads(requestParameters: BuyersApiBatchVerifyBuyerLeadsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
-     *
+     * Places a bid on the specified auction. Requires phone verification and completed KYC.
+     * Place auction bid
      */
     bidRaw(requestParameters: BuyersApiBidRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
     /**
-     *
+     * Places a bid on the specified auction. Requires phone verification and completed KYC.
+     * Place auction bid
      */
     bid(requestParameters: BuyersApiBidRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
-     * 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
      */
     bulkMarkBuyerNotificationsAsReadRaw(requestParameters: BuyersApiBulkMarkBuyerNotificationsAsReadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
     /**
-     * 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
      */
     bulkMarkBuyerNotificationsAsRead(requestParameters: BuyersApiBulkMarkBuyerNotificationsAsReadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
-     *
+     * Marks multiple lead messages as read for the buyer.
+     * Mark lead messages as read
      */
     bulkReadBuyerLeadMessageRaw(requestParameters: BuyersApiBulkReadBuyerLeadMessageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
     /**
-     *
+     * Marks multiple lead messages as read for the buyer.
+     * Mark lead messages as read
      */
     bulkReadBuyerLeadMessage(requestParameters: BuyersApiBulkReadBuyerLeadMessageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
-     *
+     * Returns the current buyer profile.
+     * Get current buyer session
      */
     buyerMeRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<BuyerSessionDto>>;
     /**
-     *
+     * Returns the current buyer profile.
+     * Get current buyer session
      */
     buyerMe(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BuyerSessionDto>;
     /**
-     *
+     * Schedules cancellation of an active buyer subscription.
+     * Cancel subscription
      */
     cancelSubscriptionRaw(requestParameters: BuyersApiCancelSubscriptionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
     /**
-     *
+     * Schedules cancellation of an active buyer subscription.
+     * Cancel subscription
      */
     cancelSubscription(requestParameters: BuyersApiCancelSubscriptionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
-     *
+     * Creates a new message from the buyer in the lead conversation thread.
+     * Send a lead message
      */
     createBuyerLeadMessageRaw(requestParameters: BuyersApiCreateBuyerLeadMessageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ObjectId>>;
     /**
-     *
+     * Creates a new message from the buyer in the lead conversation thread.
+     * Send a lead message
      */
     createBuyerLeadMessage(requestParameters: BuyersApiCreateBuyerLeadMessageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ObjectId>;
     /**
-     *
+     * Deletes multiple leads from the buyer account. Only leads in a deletable status are removed.
+     * Delete buyer leads
      */
     deleteBuyerLeadsRaw(requestParameters: BuyersApiDeleteBuyerLeadsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
     /**
-     *
+     * Deletes multiple leads from the buyer account. Only leads in a deletable status are removed.
+     * Delete buyer leads
      */
     deleteBuyerLeads(requestParameters: BuyersApiDeleteBuyerLeadsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
-     *
+     * Permanently deletes the buyer account and associated data. This action cannot be undone.
+     * Delete buyer account
      */
     deleteMeRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
     /**
-     *
+     * Permanently deletes the buyer account and associated data. This action cannot be undone.
+     * Delete buyer account
      */
     deleteMe(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
-     *
+     * Downloads the PDF document for a buyer invoice.
+     * Download buyer invoice
      */
     downloadBuyerInvoiceRaw(requestParameters: BuyersApiDownloadBuyerInvoiceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Blob>>;
     /**
-     *
+     * Downloads the PDF document for a buyer invoice.
+     * Download buyer invoice
      */
     downloadBuyerInvoice(requestParameters: BuyersApiDownloadBuyerInvoiceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Blob>;
     /**
-     * Download a specific notification attachment by attachment ID
+     * Downloads a file attachment from a buyer notification.
      * Download buyer notification attachment
      */
     downloadBuyerNotificationAttachmentRaw(requestParameters: BuyersApiDownloadBuyerNotificationAttachmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Blob>>;
     /**
-     * Download a specific notification attachment by attachment ID
+     * Downloads a file attachment from a buyer notification.
      * Download buyer notification attachment
      */
     downloadBuyerNotificationAttachment(requestParameters: BuyersApiDownloadBuyerNotificationAttachmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Blob>;
     /**
-     *
+     * Generates a new access token for the buyer, typically used for magic-link authentication flows.
+     * Generate buyer access token
      */
     generateBuyerAccessTokenRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<BuyerAccessTokenDto>>;
     /**
-     *
+     * Generates a new access token for the buyer, typically used for magic-link authentication flows.
+     * Generate buyer access token
      */
     generateBuyerAccessToken(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BuyerAccessTokenDto>;
     /**
-     *
+     * Returns auction information for the buyer.
+     * Get buyer auction detail
      */
     getBuyerAuctionDetailRaw(requestParameters: BuyersApiGetBuyerAuctionDetailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<BuyerAuctionDetailDto>>;
     /**
-     *
+     * Returns auction information for the buyer.
+     * Get buyer auction detail
      */
     getBuyerAuctionDetail(requestParameters: BuyersApiGetBuyerAuctionDetailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BuyerAuctionDetailDto>;
     /**
-     *
+     * Lists auctions the buyer is participating in.
+     * List buyer auctions
      */
     getBuyerAuctionsRaw(requestParameters: BuyersApiGetBuyerAuctionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetBuyerAuctions200Response>>;
     /**
-     *
+     * Lists auctions the buyer is participating in.
+     * List buyer auctions
      */
     getBuyerAuctions(requestParameters?: BuyersApiGetBuyerAuctionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetBuyerAuctions200Response>;
     /**
-     *
+     * Lists invoices for the buyer.
+     * List buyer invoices
      */
     getBuyerInvoicesRaw(requestParameters: BuyersApiGetBuyerInvoicesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetBuyerInvoices200Response>>;
     /**
-     *
+     * Lists invoices for the buyer.
+     * List buyer invoices
      */
     getBuyerInvoices(requestParameters?: BuyersApiGetBuyerInvoicesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetBuyerInvoices200Response>;
     /**
-     *
+     * Returns lead information for the buyer.
+     * Get buyer lead details
      */
     getBuyerLeadRaw(requestParameters: BuyersApiGetBuyerLeadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<LeadDto>>;
     /**
-     *
+     * Returns lead information for the buyer.
+     * Get buyer lead details
      */
     getBuyerLead(requestParameters: BuyersApiGetBuyerLeadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<LeadDto>;
     /**
-     *
+     * Lists messages in a lead conversation for the buyer.
+     * List lead messages
      */
     getBuyerLeadMessagesRaw(requestParameters: BuyersApiGetBuyerLeadMessagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<LeadMessageDto>>>;
     /**
-     *
+     * Lists messages in a lead conversation for the buyer.
+     * List lead messages
      */
     getBuyerLeadMessages(requestParameters: BuyersApiGetBuyerLeadMessagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<LeadMessageDto>>;
     /**
-     *
+     * Lists leads for the buyer.
+     * List buyer leads
      */
     getBuyerLeadsRaw(requestParameters: BuyersApiGetBuyerLeadsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetBuyerLeads200Response>>;
     /**
-     *
+     * Lists leads for the buyer.
+     * List buyer leads
      */
     getBuyerLeads(requestParameters?: BuyersApiGetBuyerLeadsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetBuyerLeads200Response>;
     /**
-     *
+     * Returns notification information for the buyer.
+     * Get buyer notification details
      */
     getBuyerNotificationByIdRaw(requestParameters: BuyersApiGetBuyerNotificationByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<BuyerNotificationDto>>;
     /**
-     *
+     * Returns notification information for the buyer.
+     * Get buyer notification details
      */
     getBuyerNotificationById(requestParameters: BuyersApiGetBuyerNotificationByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BuyerNotificationDto>;
     /**
-     *
+     * Returns the notification preferences for the buyer.
+     * Get notification settings
      */
     getBuyerNotificationSettingsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<BuyerNotificationSettingsDto>>;
     /**
-     *
+     * Returns the notification preferences for the buyer.
+     * Get notification settings
      */
     getBuyerNotificationSettings(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BuyerNotificationSettingsDto>;
     /**
-     *
+     * Lists subscriptions for the buyer.
+     * List buyer subscriptions
      */
     getBuyerSubscriptionsRaw(requestParameters: BuyersApiGetBuyerSubscriptionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetBuyerSubscriptions200Response>>;
     /**
-     *
+     * Lists subscriptions for the buyer.
+     * List buyer subscriptions
      */
     getBuyerSubscriptions(requestParameters?: BuyersApiGetBuyerSubscriptionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetBuyerSubscriptions200Response>;
     /**
-     *
+     * Returns task information for the buyer.
+     * Get buyer task details
      */
     getBuyerTaskRaw(requestParameters: BuyersApiGetBuyerTaskRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<BuyerTaskDetailsDto>>;
     /**
-     *
+     * Returns task information for the buyer.
+     * Get buyer task details
      */
     getBuyerTask(requestParameters: BuyersApiGetBuyerTaskRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BuyerTaskDetailsDto>;
     /**
-     *
+     * Lists domain transfers for the buyer.
+     * List domain transfers
      */
     getBuyerTransfersRaw(requestParameters: BuyersApiGetBuyerTransfersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetBuyerTransfers200Response>>;
     /**
-     *
+     * Lists domain transfers for the buyer.
+     * List domain transfers
      */
     getBuyerTransfers(requestParameters?: BuyersApiGetBuyerTransfersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetBuyerTransfers200Response>;
     /**
-     *
+     * Returns DNS configuration for a subscription domain.
+     * Get subscription DNS records
      */
     getDomainRecordsBySubscriptionIdRaw(requestParameters: BuyersApiGetDomainRecordsBySubscriptionIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<BuyerDomainRecordsDto>>;
     /**
-     *
+     * Returns DNS configuration for a subscription domain.
+     * Get subscription DNS records
      */
     getDomainRecordsBySubscriptionId(requestParameters: BuyersApiGetDomainRecordsBySubscriptionIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BuyerDomainRecordsDto>;
     /**
-     *
+     * Returns configuration presets for lead offers.
+     * Get lease-to-own configuration presets
      */
     getLeadLeaseToOwnConfigurationPresetsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<LeadLeaseToOwnAndRentConfigurationPresetsDto>>;
     /**
-     *
+     * Returns configuration presets for lead offers.
+     * Get lease-to-own configuration presets
      */
     getLeadLeaseToOwnConfigurationPresets(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<LeadLeaseToOwnAndRentConfigurationPresetsDto>;
     /**
-     *
+     * Returns the EPP auth code for a domain transfer when the buyer is eligible to retrieve it.
+     * Get domain transfer auth code
      */
     getTransferAuthCodeRaw(requestParameters: BuyersApiGetTransferAuthCodeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<BuyerDomainTransferAuthCodeDto>>;
     /**
-     *
+     * Returns the EPP auth code for a domain transfer when the buyer is eligible to retrieve it.
+     * Get domain transfer auth code
      */
     getTransferAuthCode(requestParameters: BuyersApiGetTransferAuthCodeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BuyerDomainTransferAuthCodeDto>;
     /**
-     *
+     * Lists notifications for the buyer.
+     * List buyer notifications
      */
     listBuyerNotificationsRaw(requestParameters: BuyersApiListBuyerNotificationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListBuyerNotifications200Response>>;
     /**
-     *
+     * Lists notifications for the buyer.
+     * List buyer notifications
      */
     listBuyerNotifications(requestParameters?: BuyersApiListBuyerNotificationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListBuyerNotifications200Response>;
     /**
-     *
+     * Submits the buyer confirmation or rejection for a domain transfer workflow step.
+     * Confirm or reject domain transfer step
      */
     patchDomainTransferConfirmationRaw(requestParameters: BuyersApiPatchDomainTransferConfirmationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
     /**
-     *
+     * Submits the buyer confirmation or rejection for a domain transfer workflow step.
+     * Confirm or reject domain transfer step
      */
     patchDomainTransferConfirmation(requestParameters: BuyersApiPatchDomainTransferConfirmationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
-     *
+     * Sets or updates the buyer offer on a lead.
+     * Submit a buyer offer
      */
     putBuyerOfferRaw(requestParameters: BuyersApiPutBuyerOfferRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
     /**
-     *
+     * Sets or updates the buyer offer on a lead.
+     * Submit a buyer offer
      */
     putBuyerOffer(requestParameters: BuyersApiPutBuyerOfferRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
-     *
+     * Registers the buyer as an auction participant.
+     * Register auction buyer
      */
     registerRaw(requestParameters: BuyersApiRegisterRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
     /**
-     *
+     * Registers the buyer as an auction participant.
+     * Register auction buyer
      */
     register(requestParameters: BuyersApiRegisterRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
-     *
+     * Initiates phone number verification for the auction buyer via SMS or WhatsApp.
+     * Register auction buyer phone
      */
     registerPhoneRaw(requestParameters: BuyersApiRegisterPhoneRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
     /**
-     *
+     * Initiates phone number verification for the auction buyer via SMS or WhatsApp.
+     * Register auction buyer phone
      */
     registerPhone(requestParameters: BuyersApiRegisterPhoneRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
-     *
+     * Removes a DNS record from the subscription managed domain.
+     * Remove DNS record
      */
     removeSubscriptionDomainRecordRaw(requestParameters: BuyersApiRemoveSubscriptionDomainRecordRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
     /**
-     *
+     * Removes a DNS record from the subscription managed domain.
+     * Remove DNS record
      */
     removeSubscriptionDomainRecord(requestParameters: BuyersApiRemoveSubscriptionDomainRecordRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
-     *
+     * Revokes a previously scheduled subscription cancellation, keeping the subscription active.
+     * Revoke scheduled cancellation
      */
     revokeScheduledSubscriptionCancellationRaw(requestParameters: BuyersApiRevokeScheduledSubscriptionCancellationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
     /**
-     *
+     * Revokes a previously scheduled subscription cancellation, keeping the subscription active.
+     * Revoke scheduled cancellation
      */
     revokeScheduledSubscriptionCancellation(requestParameters: BuyersApiRevokeScheduledSubscriptionCancellationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
-     *
+     * Stores the preferred locale for the buyer account.
+     * Update buyer locale
      */
     setLocaleRaw(requestParameters: BuyersApiSetLocaleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
     /**
-     *
+     * Stores the preferred locale for the buyer account.
+     * Update buyer locale
      */
     setLocale(requestParameters: BuyersApiSetLocaleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
-     *
+     * Mutes or unmutes auction notifications for the buyer.
+     * Update auction mute status
      */
     updateAuctionMuteStatusRaw(requestParameters: BuyersApiUpdateAuctionMuteStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
     /**
-     *
+     * Mutes or unmutes auction notifications for the buyer.
+     * Update auction mute status
      */
     updateAuctionMuteStatus(requestParameters: BuyersApiUpdateAuctionMuteStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
-     *
+     * Submits buyer transfer information required for certain domain transfer workflows.
+     * Update transfer buyer info
      */
     updateBuyerDomainTransferBuyerInfoRaw(requestParameters: BuyersApiUpdateBuyerDomainTransferBuyerInfoRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
     /**
-     *
+     * Submits buyer transfer information required for certain domain transfer workflows.
+     * Update transfer buyer info
      */
     updateBuyerDomainTransferBuyerInfo(requestParameters: BuyersApiUpdateBuyerDomainTransferBuyerInfoRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
-     *
+     * Updates notification preferences for the buyer.
+     * Update notification settings
      */
     updateBuyerNotificationSettingsRaw(requestParameters: BuyersApiUpdateBuyerNotificationSettingsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
     /**
-     *
+     * Updates notification preferences for the buyer.
+     * Update notification settings
      */
     updateBuyerNotificationSettings(requestParameters: BuyersApiUpdateBuyerNotificationSettingsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
-     *
+     * Updates the IPS tag for a .uk domain transfer during the buyer workflow step.
+     * Update IPS tag
      */
     updateDomainTransferIpsTagRaw(requestParameters: BuyersApiUpdateDomainTransferIpsTagRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
     /**
-     *
+     * Updates the IPS tag for a .uk domain transfer during the buyer workflow step.
+     * Update IPS tag
      */
     updateDomainTransferIpsTag(requestParameters: BuyersApiUpdateDomainTransferIpsTagRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
-     *
+     * Updates whether the lead is muted for the buyer.
+     * Mute or unmute a lead
      */
     updateLeadMuteStatusForBuyerRaw(requestParameters: BuyersApiUpdateLeadMuteStatusForBuyerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
     /**
-     *
+     * Updates whether the lead is muted for the buyer.
+     * Mute or unmute a lead
      */
     updateLeadMuteStatusForBuyer(requestParameters: BuyersApiUpdateLeadMuteStatusForBuyerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
-     *
+     * Replaces the nameserver list for the subscription managed domain.
+     * Update domain nameservers
      */
     updateSubscriptionDomainNameserversRaw(requestParameters: BuyersApiUpdateSubscriptionDomainNameserversRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
     /**
-     *
+     * Replaces the nameserver list for the subscription managed domain.
+     * Update domain nameservers
      */
     updateSubscriptionDomainNameservers(requestParameters: BuyersApiUpdateSubscriptionDomainNameserversRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
-     *
+     * Updates an existing DNS record on the subscription managed domain.
+     * Update DNS record
      */
     updateSubscriptionDomainRecordRaw(requestParameters: BuyersApiUpdateSubscriptionDomainRecordRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
     /**
-     *
+     * Updates an existing DNS record on the subscription managed domain.
+     * Update DNS record
      */
     updateSubscriptionDomainRecord(requestParameters: BuyersApiUpdateSubscriptionDomainRecordRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
-     *
+     * Updates whether a task is muted for the buyer.
+     * Mute or unmute a task
      */
     updateTaskMuteStatusForBuyerRaw(requestParameters: BuyersApiUpdateTaskMuteStatusForBuyerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
     /**
-     *
+     * Updates whether a task is muted for the buyer.
+     * Mute or unmute a task
      */
     updateTaskMuteStatusForBuyer(requestParameters: BuyersApiUpdateTaskMuteStatusForBuyerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
-     *
+     * Verifies a single lead for the buyer.
+     * Verify a lead
      */
     verifyBuyerLeadRaw(requestParameters: BuyersApiVerifyBuyerLeadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
     /**
-     *
+     * Verifies a single lead for the buyer.
+     * Verify a lead
      */
     verifyBuyerLead(requestParameters: BuyersApiVerifyBuyerLeadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
-     *
+     * Verifies the one-time password sent to the auction buyer phone and returns the updated buyer profile.
+     * Verify phone OTP
      */
     verifyPhoneOtpRaw(requestParameters: BuyersApiVerifyPhoneOtpRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AuctionBuyerDto>>;
     /**
-     *
+     * Verifies the one-time password sent to the auction buyer phone and returns the updated buyer profile.
+     * Verify phone OTP
      */
     verifyPhoneOtp(requestParameters: BuyersApiVerifyPhoneOtpRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AuctionBuyerDto>;
 }