@randock/nameshift-api-client 0.0.538 → 0.0.539

package/.openapi-generator/FILES

@@ -11,6 +11,8 @@ src/apis/AdminApi.ts
 src/apis/AuctionsApi.ts
 src/apis/AuctionsPublicApi.ts
 src/apis/BankAccountsApi.ts
+src/apis/BrokeredLeadsApi.ts
+src/apis/BrokeredLeadsPublicApi.ts
 src/apis/BuyersApi.ts
 src/apis/BuyersPublicApi.ts
 src/apis/ChallengesApi.ts
@@ -48,6 +50,7 @@ src/models/AccountAliasInput.ts
 src/models/AccountBankAccountDetailsDto.ts
 src/models/AccountBankAccountDto.ts
 src/models/AccountBankAccountSummaryDto.ts
+src/models/AccountBrokerSettingsInput.ts
 src/models/AccountChallengeRewardUsageListItemDto.ts
 src/models/AccountChallengeRewardUsageListItemDtoMetadata.ts
 src/models/AccountCommissionByDateRangeDto.ts
@@ -79,6 +82,7 @@ src/models/AccountSettingsAffiliateCommissionDto.ts
 src/models/AccountSettingsAffiliateCommissionReferralDuration.ts
 src/models/AccountSettingsAffiliateDto.ts
 src/models/AccountSettingsAliasDto.ts
+src/models/AccountSettingsBrokerDto.ts
 src/models/AccountSettingsDto.ts
 src/models/AccountSettingsInput.ts
 src/models/AccountSettingsLeaseToOwnConfigurationDto.ts
@@ -104,6 +108,7 @@ src/models/AdminBankDepositAccountDto.ts
 src/models/AdminBankDepositDto.ts
 src/models/AdminBankDepositInvoiceDto.ts
 src/models/AdminBankDepositInvoiceTransactionDto.ts
+src/models/AdminBrokeredLeadDto.ts
 src/models/AdminBuyerListItemDto.ts
 src/models/AdminBuyerLoginDto.ts
 src/models/AdminChallengeListDto.ts
@@ -118,6 +123,7 @@ src/models/AdminLeadListItemBuyerDto.ts
 src/models/AdminLeadListItemDomainDto.ts
 src/models/AdminLeadListItemDto.ts
 src/models/AdminListAccountDto.ts
+src/models/AdminListBrokeredLeads200Response.ts
 src/models/AdminMarketplaceDto.ts
 src/models/AdminUserNewsletterInput.ts
 src/models/AdminUserSecurityDto.ts
@@ -162,6 +168,13 @@ src/models/BatchReadSellerLeadMessageInput.ts
 src/models/BatchUpdateDomainsInput.ts
 src/models/BatchVerifyBuyerLeadsInput.ts
 src/models/BillingInformationDto.ts
+src/models/BrokerBrokeredLeadDto.ts
+src/models/BrokerCommissionInput.ts
+src/models/BrokeredLeadBreakdownDto.ts
+src/models/BrokeredLeadBuyerContactDto.ts
+src/models/BrokeredLeadBuyerInput.ts
+src/models/BrokeredLeadCommissionDto.ts
+src/models/BrokeredLeadInvitationDto.ts
 src/models/BulkCommissionActionsInput.ts
 src/models/BulkCommissionActionsInputActionsInner.ts
 src/models/BulkDownloadInvoicesInput.ts
@@ -242,6 +255,7 @@ src/models/CreateAccountPaymentManualTransactionInput.ts
 src/models/CreateApiKeyInput.ts
 src/models/CreateBankAccountDetailsInput.ts
 src/models/CreateBankAccountInput.ts
+src/models/CreateBrokeredLeadInput.ts
 src/models/CreateBuyerDomainAppraisalRequestInput.ts
 src/models/CreateBuyerLeadMessageInput.ts
 src/models/CreateChallengeInput.ts
@@ -266,6 +280,7 @@ src/models/CustomerSuccessListAccountDto.ts
 src/models/CustomerSuccessListAccountMetricsDto.ts
 src/models/CustomerSuccessListAccountPortfolioSizeDto.ts
 src/models/CustomerSuccessListAccountUserDto.ts
+src/models/DeclineBrokeredLeadInput.ts
 src/models/DeleteDomainsInput.ts
 src/models/DomainAppraisalRequestListItemDto.ts
 src/models/DomainAppraisalRequestStatus.ts
@@ -384,6 +399,7 @@ src/models/LandingPageOriginalDesignSettingsDto.ts
 src/models/LandingPageOriginalDesignSettingsInput.ts
 src/models/LandingPageSettingsDto.ts
 src/models/LatestDomainAppraisalRequestDto.ts
+src/models/LeadBrokeredDealDto.ts
 src/models/LeadBuyerConfigDto.ts
 src/models/LeadDomainDto.ts
 src/models/LeadDto.ts
@@ -440,6 +456,7 @@ src/models/ListAdminRelatedLeads200Response.ts
 src/models/ListAuctions200Response.ts
 src/models/ListBankAccounts200Response.ts
 src/models/ListBankDeposits200Response.ts
+src/models/ListBrokerLeads200Response.ts
 src/models/ListBuyerNotifications200Response.ts
 src/models/ListBuyers200Response.ts
 src/models/ListCustomerSuccessAccountDomains200Response.ts
@@ -495,6 +512,7 @@ src/models/OrderListItemDtoBuyerInformation.ts
 src/models/OrderListItemDtoDomainInformation.ts
 src/models/OrderListItemDtoSellerAccount.ts
 src/models/OrderListItemDtoTransaction.ts
+src/models/OverrideBrokeredLeadNameshiftCommissionInput.ts
 src/models/OwnedDomainDto.ts
 src/models/PageBasedPageInfo.ts
 src/models/PageBasedPaginationResponse.ts
@@ -573,6 +591,8 @@ src/models/SellerAffiliateCommissionDto.ts
 src/models/SellerAuctionListItemDto.ts
 src/models/SellerAuctionListItemDtoDomainInformation.ts
 src/models/SellerAuctionListItemDtoSellerAccount.ts
+src/models/SellerBrokeredLeadDto.ts
+src/models/SellerBrokeredLeadVerificationDto.ts
 src/models/SellerDomainAffiliateCommissionDto.ts
 src/models/SellerDomainAffiliateCommissionDtoDomain.ts
 src/models/SellerDomainTransferAuthCodeDto.ts

package/README.md

@@ -1,4 +1,4 @@
-## @randock/nameshift-api-client@0.0.538
+## @randock/nameshift-api-client@0.0.539
 
 This generator creates TypeScript/JavaScript client that utilizes [Fetch API](https://fetch.spec.whatwg.org/). The generated Node module can be used in the following environments:
 
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
 _published:_
 
 ```
-npm install @randock/nameshift-api-client@0.0.538 --save
+npm install @randock/nameshift-api-client@0.0.539 --save
 ```
 
 _unPublished (not recommended):_
@@ -44,4 +44,4 @@ _unPublished (not recommended):_
 ```
 npm install PATH_TO_GENERATED_PACKAGE --save
 ```
-8f789cae6f9e9cbbaee8de7296d7e0dc708e553a2c5190bdb02ee67c9b4af7eda67603651f65a505b2107310a76b1f81
+9b28f51be2464cf02d020ea7f562e00b6cbc317c5b1a1d54bd086b465fad926998ca2421338fd152daf67bef43809e02

package/dist/apis/AdminApi.d.ts

@@ -10,7 +10,7 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-import type { AccountNameshiftCommissionByTypeDto, AccountNoteListDto, AccountPaymentMethodProfileDto, AccountSettingsDto, AccountsStatsDto, AdminAccountLoginDto, AdminAccountSettingsInput, AdminBuyerLoginDto, AdminChallengeListDto, AdminCompanyStatsDto, AdminGetAllDomainTransfers200Response, AdminLandingDesignStatsDto, AdminMarketplaceDto, AdminUserNewsletterInput, AdminUserSecurityDto, AffiliatesStatsDto, AuctionsStatsDto, BulkCommissionActionsInput, ChangeInvoiceStatusInput, ChangeOrderStatusInput, ChangeSubscriptionStatusInput, CommissionListDto, CommissionSimulationResultDto, CommissionsStatsDto, CreateAccountNoteInput, CreateChallengeInput, CreateNewsletterInput, DomainLockDto, DomainStatsDto, DomainTldsDto, DomainTransferDetailsDto, GetAccountChallengeRewardUsagesListDto, GetAdminDomainAppraisalRequests200Response, GetAllAuctions200Response, GetAllFeatureFlags200Response, GetAllInvoices200Response, GetAllOrders200Response, GetAllOwnedDomains200Response, GetAllSubscriptions200Response, IntersectionAccountDtoWithSettingsDtoWithNotificationsDtoWithFeatureFlagsDto, LeadEnrichmentDto, LeadMessageDto, LedgerMutationsDto, LinkBankDepositToBankAccountInput, LinkBankDepositToInvoiceInput, ListAccounts200Response, ListAdminLandingDesignAccounts200Response, ListAdminRelatedLeads200Response, ListBankAccounts200Response, ListBankDeposits200Response, ListBuyers200Response, ListDomains200Response, ListLeadMessagesDto, ListLeads200Response, ListUserLoginAttempts200Response, NewsStoryDto, NewsletterDto, NewsletterPreviewDto, ObjectId, PaySellerInvoicesInput, PaymentMethodsStatsDto, SalesStatsDto, SellerLeadDetails, SellerPayoutPreviewDto, SellerSalesByTldStatsItemDto, SellerSalesCountStatsItemDto, SendAdminLeadAiPriceNegotiatorAgentChatMessageInput, SendNewsletterPreviewInput, SimulateCommissionInput, StatsFilterInputDateRange, SubscriptionDetailsDto, UpdateAccountChallengeRewardBalanceInput, UpdateAccountNoteInput, UpdateAdminDomainTransferBuyerCompanyInfoInput, UpdateAdminDomainTransferBuyerInfoInput, UpdateChallengeInput, UpdateFeatureFlagInput, UpdateMarketplaceInput, UpdateNewsletterInput, UpdateSubscriptionBuyerInformationInput } from '../models/index';
+import type { AccountNameshiftCommissionByTypeDto, AccountNoteListDto, AccountPaymentMethodProfileDto, AccountSettingsDto, AccountsStatsDto, AdminAccountLoginDto, AdminAccountSettingsInput, AdminBuyerLoginDto, AdminChallengeListDto, AdminCompanyStatsDto, AdminGetAllDomainTransfers200Response, AdminLandingDesignStatsDto, AdminListBrokeredLeads200Response, AdminMarketplaceDto, AdminUserNewsletterInput, AdminUserSecurityDto, AffiliatesStatsDto, AuctionsStatsDto, BulkCommissionActionsInput, ChangeInvoiceStatusInput, ChangeOrderStatusInput, ChangeSubscriptionStatusInput, CommissionListDto, CommissionSimulationResultDto, CommissionsStatsDto, CreateAccountNoteInput, CreateChallengeInput, CreateNewsletterInput, DomainLockDto, DomainStatsDto, DomainTldsDto, DomainTransferDetailsDto, GetAccountChallengeRewardUsagesListDto, GetAdminDomainAppraisalRequests200Response, GetAllAuctions200Response, GetAllFeatureFlags200Response, GetAllInvoices200Response, GetAllOrders200Response, GetAllOwnedDomains200Response, GetAllSubscriptions200Response, IntersectionAccountDtoWithSettingsDtoWithNotificationsDtoWithFeatureFlagsDto, LeadEnrichmentDto, LeadMessageDto, LedgerMutationsDto, LinkBankDepositToBankAccountInput, LinkBankDepositToInvoiceInput, ListAccounts200Response, ListAdminLandingDesignAccounts200Response, ListAdminRelatedLeads200Response, ListBankAccounts200Response, ListBankDeposits200Response, ListBuyers200Response, ListDomains200Response, ListLeadMessagesDto, ListLeads200Response, ListUserLoginAttempts200Response, NewsStoryDto, NewsletterDto, NewsletterPreviewDto, ObjectId, OverrideBrokeredLeadNameshiftCommissionInput, PaySellerInvoicesInput, PaymentMethodsStatsDto, SalesStatsDto, SellerLeadDetails, SellerPayoutPreviewDto, SellerSalesByTldStatsItemDto, SellerSalesCountStatsItemDto, SendAdminLeadAiPriceNegotiatorAgentChatMessageInput, SendNewsletterPreviewInput, SimulateCommissionInput, StatsFilterInputDateRange, SubscriptionDetailsDto, UpdateAccountChallengeRewardBalanceInput, UpdateAccountNoteInput, UpdateAdminDomainTransferBuyerCompanyInfoInput, UpdateAdminDomainTransferBuyerInfoInput, UpdateChallengeInput, UpdateFeatureFlagInput, UpdateMarketplaceInput, UpdateNewsletterInput, UpdateSubscriptionBuyerInformationInput } from '../models/index';
 export interface AdminApiAdminDeleteAuctionRequest {
     auctionId: string;
 }
@@ -24,6 +24,23 @@ export interface AdminApiAdminGetAllDomainTransfersRequest {
     filterSearchTerm?: string;
     filterStatus?: string;
 }
+export interface AdminApiAdminListBrokeredLeadsRequest {
+    filter?: {
+        [key: string]: string;
+    };
+    page?: number;
+    limit?: number;
+    sortBy?: Array<string>;
+    filterStatus?: string;
+    filterBrokerStatus?: string;
+    filterSearchTerm?: string;
+    filterCreatedAtFrom?: string;
+    filterCreatedAtTo?: string;
+}
+export interface AdminApiAdminOverrideBrokeredLeadNameshiftCommissionRequest {
+    brokeredLeadId: string;
+    overrideBrokeredLeadNameshiftCommissionInput: OverrideBrokeredLeadNameshiftCommissionInput;
+}
 export interface AdminApiAdminUpdateDomainTransferBuyerCompanyInfoRequest {
     transferId: string;
     updateAdminDomainTransferBuyerCompanyInfoInput: UpdateAdminDomainTransferBuyerCompanyInfoInput;
@@ -492,6 +509,24 @@ export declare class AdminApi extends runtime.BaseAPI {
      * List all domain transfers
      */
     adminGetAllDomainTransfers(requestParameters?: AdminApiAdminGetAllDomainTransfersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AdminGetAllDomainTransfers200Response>;
+    /**
+     * List all brokered deals
+     */
+    adminListBrokeredLeadsRaw(requestParameters: AdminApiAdminListBrokeredLeadsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AdminListBrokeredLeads200Response>>;
+    /**
+     * List all brokered deals
+     */
+    adminListBrokeredLeads(requestParameters?: AdminApiAdminListBrokeredLeadsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AdminListBrokeredLeads200Response>;
+    /**
+     * Overrides the platform fee charged to the broker, e.g. for a high value deal. Only until the buyer has paid, and never above the broker commission.
+     * Set a custom platform fee for a brokered deal
+     */
+    adminOverrideBrokeredLeadNameshiftCommissionRaw(requestParameters: AdminApiAdminOverrideBrokeredLeadNameshiftCommissionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Overrides the platform fee charged to the broker, e.g. for a high value deal. Only until the buyer has paid, and never above the broker commission.
+     * Set a custom platform fee for a brokered deal
+     */
+    adminOverrideBrokeredLeadNameshiftCommission(requestParameters: AdminApiAdminOverrideBrokeredLeadNameshiftCommissionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
      * Corrects the company registration id stored on the active buyer invoice of the domain transfer. The registry contact of the transfer is built from it; the issued invoice and its taxes are left untouched.
      * Update the company id of the buyer

package/dist/apis/AdminApi.js

@@ -199,6 +199,142 @@ var AdminApi = /** @class */ (function (_super) {
             });
         });
     };
+    /**
+     * List all brokered deals
+     */
+    AdminApi.prototype.adminListBrokeredLeadsRaw = function (requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function () {
+            var queryParameters, headerParameters, token, tokenString, response;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        queryParameters = {};
+                        if (requestParameters['filter'] != null) {
+                            queryParameters['filter'] = requestParameters['filter'];
+                        }
+                        if (requestParameters['page'] != null) {
+                            queryParameters['page'] = requestParameters['page'];
+                        }
+                        if (requestParameters['limit'] != null) {
+                            queryParameters['limit'] = requestParameters['limit'];
+                        }
+                        if (requestParameters['sortBy'] != null) {
+                            queryParameters['sortBy'] = requestParameters['sortBy'];
+                        }
+                        if (requestParameters['filterStatus'] != null) {
+                            queryParameters['filter[status]'] = requestParameters['filterStatus'];
+                        }
+                        if (requestParameters['filterBrokerStatus'] != null) {
+                            queryParameters['filter[broker_status]'] = requestParameters['filterBrokerStatus'];
+                        }
+                        if (requestParameters['filterSearchTerm'] != null) {
+                            queryParameters['filter[search_term]'] = requestParameters['filterSearchTerm'];
+                        }
+                        if (requestParameters['filterCreatedAtFrom'] != null) {
+                            queryParameters['filter[createdAtFrom]'] = requestParameters['filterCreatedAtFrom'];
+                        }
+                        if (requestParameters['filterCreatedAtTo'] != null) {
+                            queryParameters['filter[createdAtTo]'] = requestParameters['filterCreatedAtTo'];
+                        }
+                        headerParameters = {};
+                        if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
+                        token = this.configuration.accessToken;
+                        return [4 /*yield*/, token("bearer", [])];
+                    case 1:
+                        tokenString = _a.sent();
+                        if (tokenString) {
+                            headerParameters["Authorization"] = "Bearer ".concat(tokenString);
+                        }
+                        _a.label = 2;
+                    case 2: return [4 /*yield*/, this.request({
+                            path: "/admin/brokered-leads",
+                            method: 'GET',
+                            headers: headerParameters,
+                            query: queryParameters,
+                        }, initOverrides)];
+                    case 3:
+                        response = _a.sent();
+                        return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, index_1.AdminListBrokeredLeads200ResponseFromJSON)(jsonValue); })];
+                }
+            });
+        });
+    };
+    /**
+     * List all brokered deals
+     */
+    AdminApi.prototype.adminListBrokeredLeads = function () {
+        return __awaiter(this, arguments, void 0, function (requestParameters, initOverrides) {
+            var response;
+            if (requestParameters === void 0) { requestParameters = {}; }
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.adminListBrokeredLeadsRaw(requestParameters, initOverrides)];
+                    case 1:
+                        response = _a.sent();
+                        return [4 /*yield*/, response.value()];
+                    case 2: return [2 /*return*/, _a.sent()];
+                }
+            });
+        });
+    };
+    /**
+     * Overrides the platform fee charged to the broker, e.g. for a high value deal. Only until the buyer has paid, and never above the broker commission.
+     * Set a custom platform fee for a brokered deal
+     */
+    AdminApi.prototype.adminOverrideBrokeredLeadNameshiftCommissionRaw = function (requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function () {
+            var queryParameters, headerParameters, token, tokenString, response;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        if (requestParameters['brokeredLeadId'] == null) {
+                            throw new runtime.RequiredError('brokeredLeadId', 'Required parameter "brokeredLeadId" was null or undefined when calling adminOverrideBrokeredLeadNameshiftCommission().');
+                        }
+                        if (requestParameters['overrideBrokeredLeadNameshiftCommissionInput'] == null) {
+                            throw new runtime.RequiredError('overrideBrokeredLeadNameshiftCommissionInput', 'Required parameter "overrideBrokeredLeadNameshiftCommissionInput" was null or undefined when calling adminOverrideBrokeredLeadNameshiftCommission().');
+                        }
+                        queryParameters = {};
+                        headerParameters = {};
+                        headerParameters['Content-Type'] = 'application/json';
+                        if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
+                        token = this.configuration.accessToken;
+                        return [4 /*yield*/, token("bearer", [])];
+                    case 1:
+                        tokenString = _a.sent();
+                        if (tokenString) {
+                            headerParameters["Authorization"] = "Bearer ".concat(tokenString);
+                        }
+                        _a.label = 2;
+                    case 2: return [4 /*yield*/, this.request({
+                            path: "/admin/brokered-leads/{brokeredLeadId}/nameshift-commission".replace("{".concat("brokeredLeadId", "}"), encodeURIComponent(String(requestParameters['brokeredLeadId']))),
+                            method: 'PUT',
+                            headers: headerParameters,
+                            query: queryParameters,
+                            body: (0, index_1.OverrideBrokeredLeadNameshiftCommissionInputToJSON)(requestParameters['overrideBrokeredLeadNameshiftCommissionInput']),
+                        }, initOverrides)];
+                    case 3:
+                        response = _a.sent();
+                        return [2 /*return*/, new runtime.VoidApiResponse(response)];
+                }
+            });
+        });
+    };
+    /**
+     * Overrides the platform fee charged to the broker, e.g. for a high value deal. Only until the buyer has paid, and never above the broker commission.
+     * Set a custom platform fee for a brokered deal
+     */
+    AdminApi.prototype.adminOverrideBrokeredLeadNameshiftCommission = function (requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.adminOverrideBrokeredLeadNameshiftCommissionRaw(requestParameters, initOverrides)];
+                    case 1:
+                        _a.sent();
+                        return [2 /*return*/];
+                }
+            });
+        });
+    };
     /**
      * Corrects the company registration id stored on the active buyer invoice of the domain transfer. The registry contact of the transfer is built from it; the issued invoice and its taxes are left untouched.
      * Update the company id of the buyer

package/dist/apis/BrokeredLeadsApi.d.ts

@@ -0,0 +1,195 @@
+/**
+ * Nameshift
+ * 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
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import * as runtime from '../runtime';
+import type { BrokerBrokeredLeadDto, CreateBrokeredLeadInput, DeclineBrokeredLeadInput, ListBrokerLeads200Response, ObjectId, SellerBrokeredLeadDto } from '../models/index';
+export interface BrokeredLeadsApiApproveSellerBrokeredLeadRequest {
+    brokeredLeadId: string;
+}
+export interface BrokeredLeadsApiCancelBrokerLeadRequest {
+    brokeredLeadId: string;
+}
+export interface BrokeredLeadsApiClaimSellerBrokeredLeadInvitationRequest {
+    token: string;
+}
+export interface BrokeredLeadsApiCreateBrokerLeadRequest {
+    createBrokeredLeadInput: CreateBrokeredLeadInput;
+}
+export interface BrokeredLeadsApiDeclineSellerBrokeredLeadRequest {
+    brokeredLeadId: string;
+    declineBrokeredLeadInput: DeclineBrokeredLeadInput;
+}
+export interface BrokeredLeadsApiGetBrokerLeadRequest {
+    brokeredLeadId: string;
+}
+export interface BrokeredLeadsApiGetSellerBrokeredLeadRequest {
+    brokeredLeadId: string;
+}
+export interface BrokeredLeadsApiListBrokerLeadsRequest {
+    filter?: {
+        [key: string]: string;
+    };
+    page?: number;
+    limit?: number;
+    sortBy?: Array<string>;
+    filterStatus?: string;
+    filterBrokerStatus?: string;
+    filterSearchTerm?: string;
+    filterCreatedAtFrom?: string;
+    filterCreatedAtTo?: string;
+}
+export interface BrokeredLeadsApiNotifyBrokerLeadBuyerRequest {
+    brokeredLeadId: string;
+}
+export interface BrokeredLeadsApiNotifyBrokerLeadSellerRequest {
+    brokeredLeadId: string;
+}
+export interface BrokeredLeadsApiRecheckSellerBrokeredLeadVerificationRequest {
+    brokeredLeadId: string;
+}
+export interface BrokeredLeadsApiRenewBrokerLeadSellerLinkRequest {
+    brokeredLeadId: string;
+}
+/**
+ *
+ */
+export declare class BrokeredLeadsApi extends runtime.BaseAPI {
+    /**
+     * The seller agrees to the deal. It becomes a lead the buyer can pay as soon as the domain is verified as the seller’s and the seller account is verified; the domain is checked right away.  **API key scope required:** `BROKERED_LEADS_WRITE`. Requests authenticated with a seller session do not need any scope.
+     * Approve a brokered deal
+     */
+    approveSellerBrokeredLeadRaw(requestParameters: BrokeredLeadsApiApproveSellerBrokeredLeadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * The seller agrees to the deal. It becomes a lead the buyer can pay as soon as the domain is verified as the seller’s and the seller account is verified; the domain is checked right away.  **API key scope required:** `BROKERED_LEADS_WRITE`. Requests authenticated with a seller session do not need any scope.
+     * Approve a brokered deal
+     */
+    approveSellerBrokeredLead(requestParameters: BrokeredLeadsApiApproveSellerBrokeredLeadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Withdraws a deal the seller has not completed yet. The seller signup link stops working.  **API key scope required:** `BROKERED_LEADS_WRITE`. Requests authenticated with a seller session do not need any scope.
+     * Cancel a deal
+     */
+    cancelBrokerLeadRaw(requestParameters: BrokeredLeadsApiCancelBrokerLeadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Withdraws a deal the seller has not completed yet. The seller signup link stops working.  **API key scope required:** `BROKERED_LEADS_WRITE`. Requests authenticated with a seller session do not need any scope.
+     * Cancel a deal
+     */
+    cancelBrokerLead(requestParameters: BrokeredLeadsApiCancelBrokerLeadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * For a seller who already has an account: the deal behind the link joins this account’s brokered deals and waits for the seller’s review. The domain is added to the account when no account has it. When another account holds it, this account claims it, and the domain moves over once its DNS names this account.  **API key scope required:** `BROKERED_LEADS_WRITE`. Requests authenticated with a seller session do not need any scope.
+     * Take up a broker’s signup link with this account
+     */
+    claimSellerBrokeredLeadInvitationRaw(requestParameters: BrokeredLeadsApiClaimSellerBrokeredLeadInvitationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * For a seller who already has an account: the deal behind the link joins this account’s brokered deals and waits for the seller’s review. The domain is added to the account when no account has it. When another account holds it, this account claims it, and the domain moves over once its DNS names this account.  **API key scope required:** `BROKERED_LEADS_WRITE`. Requests authenticated with a seller session do not need any scope.
+     * Take up a broker’s signup link with this account
+     */
+    claimSellerBrokeredLeadInvitation(requestParameters: BrokeredLeadsApiClaimSellerBrokeredLeadInvitationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Records a sale the broker arranged. When the account that holds the domain has verified it through DNS, that seller finds the deal waiting for review. For any other domain the deal carries a link for the seller: whoever takes it up has to show through DNS that the domain is theirs. Nobody is emailed until the broker asks for it.  **API key scope required:** `BROKERED_LEADS_WRITE`. Requests authenticated with a seller session do not need any scope.
+     * Bring in a deal as a broker
+     */
+    createBrokerLeadRaw(requestParameters: BrokeredLeadsApiCreateBrokerLeadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ObjectId>>;
+    /**
+     * Records a sale the broker arranged. When the account that holds the domain has verified it through DNS, that seller finds the deal waiting for review. For any other domain the deal carries a link for the seller: whoever takes it up has to show through DNS that the domain is theirs. Nobody is emailed until the broker asks for it.  **API key scope required:** `BROKERED_LEADS_WRITE`. Requests authenticated with a seller session do not need any scope.
+     * Bring in a deal as a broker
+     */
+    createBrokerLead(requestParameters: BrokeredLeadsApiCreateBrokerLeadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ObjectId>;
+    /**
+     * Declines a deal under review, or backs out of an approved deal that still waits for verification. The broker is told, along with the reason if given.  **API key scope required:** `BROKERED_LEADS_WRITE`. Requests authenticated with a seller session do not need any scope.
+     * Decline a brokered deal
+     */
+    declineSellerBrokeredLeadRaw(requestParameters: BrokeredLeadsApiDeclineSellerBrokeredLeadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Declines a deal under review, or backs out of an approved deal that still waits for verification. The broker is told, along with the reason if given.  **API key scope required:** `BROKERED_LEADS_WRITE`. Requests authenticated with a seller session do not need any scope.
+     * Decline a brokered deal
+     */
+    declineSellerBrokeredLead(requestParameters: BrokeredLeadsApiDeclineSellerBrokeredLeadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * **API key scope required:** `BROKERED_LEADS_READ`. Requests authenticated with a seller session do not need any scope.
+     * Get a deal brought in as a broker
+     */
+    getBrokerLeadRaw(requestParameters: BrokeredLeadsApiGetBrokerLeadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<BrokerBrokeredLeadDto>>;
+    /**
+     * **API key scope required:** `BROKERED_LEADS_READ`. Requests authenticated with a seller session do not need any scope.
+     * Get a deal brought in as a broker
+     */
+    getBrokerLead(requestParameters: BrokeredLeadsApiGetBrokerLeadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BrokerBrokeredLeadDto>;
+    /**
+     * **API key scope required:** `BROKERED_LEADS_READ`. Requests authenticated with a seller session do not need any scope.
+     * Get a brokered deal on one of the seller’s domains
+     */
+    getSellerBrokeredLeadRaw(requestParameters: BrokeredLeadsApiGetSellerBrokeredLeadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SellerBrokeredLeadDto>>;
+    /**
+     * **API key scope required:** `BROKERED_LEADS_READ`. Requests authenticated with a seller session do not need any scope.
+     * Get a brokered deal on one of the seller’s domains
+     */
+    getSellerBrokeredLead(requestParameters: BrokeredLeadsApiGetSellerBrokeredLeadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SellerBrokeredLeadDto>;
+    /**
+     * Lists the deals this account brought in as a broker, newest first, with their status, commission and the links to share.  **API key scope required:** `BROKERED_LEADS_READ`. Requests authenticated with a seller session do not need any scope.
+     * List the deals brought in as a broker
+     */
+    listBrokerLeadsRaw(requestParameters: BrokeredLeadsApiListBrokerLeadsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListBrokerLeads200Response>>;
+    /**
+     * Lists the deals this account brought in as a broker, newest first, with their status, commission and the links to share.  **API key scope required:** `BROKERED_LEADS_READ`. Requests authenticated with a seller session do not need any scope.
+     * List the deals brought in as a broker
+     */
+    listBrokerLeads(requestParameters?: BrokeredLeadsApiListBrokerLeadsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListBrokerLeads200Response>;
+    /**
+     * Deals brokers brought in for this account’s domains that wait for approval or for the domain and account to be verified.  **API key scope required:** `BROKERED_LEADS_READ`. Requests authenticated with a seller session do not need any scope.
+     * List the brokered deals waiting on the seller
+     */
+    listSellerBrokeredLeadsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<SellerBrokeredLeadDto>>>;
+    /**
+     * Deals brokers brought in for this account’s domains that wait for approval or for the domain and account to be verified.  **API key scope required:** `BROKERED_LEADS_READ`. Requests authenticated with a seller session do not need any scope.
+     * List the brokered deals waiting on the seller
+     */
+    listSellerBrokeredLeads(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<SellerBrokeredLeadDto>>;
+    /**
+     * Emails the buyer a reminder with the payment link, while the deal waits for payment. Once a week at most.  **API key scope required:** `BROKERED_LEADS_WRITE`. Requests authenticated with a seller session do not need any scope.
+     * Email the buyer the payment link
+     */
+    notifyBrokerLeadBuyerRaw(requestParameters: BrokeredLeadsApiNotifyBrokerLeadBuyerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Emails the buyer a reminder with the payment link, while the deal waits for payment. Once a week at most.  **API key scope required:** `BROKERED_LEADS_WRITE`. Requests authenticated with a seller session do not need any scope.
+     * Email the buyer the payment link
+     */
+    notifyBrokerLeadBuyer(requestParameters: BrokeredLeadsApiNotifyBrokerLeadBuyerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Emails a seller with an account to review the deal, or invites a seller without one to sign up. Once a week at most.  **API key scope required:** `BROKERED_LEADS_WRITE`. Requests authenticated with a seller session do not need any scope.
+     * Email the seller about the deal
+     */
+    notifyBrokerLeadSellerRaw(requestParameters: BrokeredLeadsApiNotifyBrokerLeadSellerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Emails a seller with an account to review the deal, or invites a seller without one to sign up. Once a week at most.  **API key scope required:** `BROKERED_LEADS_WRITE`. Requests authenticated with a seller session do not need any scope.
+     * Email the seller about the deal
+     */
+    notifyBrokerLeadSeller(requestParameters: BrokeredLeadsApiNotifyBrokerLeadSellerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Checks the domain DNS again and completes the deal if the domain and the account are verified by now.  **API key scope required:** `BROKERED_LEADS_WRITE`. Requests authenticated with a seller session do not need any scope.
+     * Check the verification of an approved brokered deal again
+     */
+    recheckSellerBrokeredLeadVerificationRaw(requestParameters: BrokeredLeadsApiRecheckSellerBrokeredLeadVerificationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Checks the domain DNS again and completes the deal if the domain and the account are verified by now.  **API key scope required:** `BROKERED_LEADS_WRITE`. Requests authenticated with a seller session do not need any scope.
+     * Check the verification of an approved brokered deal again
+     */
+    recheckSellerBrokeredLeadVerification(requestParameters: BrokeredLeadsApiRecheckSellerBrokeredLeadVerificationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Issues a new link for a seller who has not taken up the deal yet, e.g. once the previous one expired. The previous link stops working.  **API key scope required:** `BROKERED_LEADS_WRITE`. Requests authenticated with a seller session do not need any scope.
+     * Renew the seller signup link
+     */
+    renewBrokerLeadSellerLinkRaw(requestParameters: BrokeredLeadsApiRenewBrokerLeadSellerLinkRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Issues a new link for a seller who has not taken up the deal yet, e.g. once the previous one expired. The previous link stops working.  **API key scope required:** `BROKERED_LEADS_WRITE`. Requests authenticated with a seller session do not need any scope.
+     * Renew the seller signup link
+     */
+    renewBrokerLeadSellerLink(requestParameters: BrokeredLeadsApiRenewBrokerLeadSellerLinkRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+}