@randock/nameshift-api-client 0.0.538 → 0.0.540

package/src/apis/BrokeredLeadsApi.ts

@@ -0,0 +1,740 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * 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';
+import {
+    BrokerBrokeredLeadDtoFromJSON,
+    BrokerBrokeredLeadDtoToJSON,
+    CreateBrokeredLeadInputFromJSON,
+    CreateBrokeredLeadInputToJSON,
+    DeclineBrokeredLeadInputFromJSON,
+    DeclineBrokeredLeadInputToJSON,
+    ListBrokerLeads200ResponseFromJSON,
+    ListBrokerLeads200ResponseToJSON,
+    ObjectIdFromJSON,
+    ObjectIdToJSON,
+    SellerBrokeredLeadDtoFromJSON,
+    SellerBrokeredLeadDtoToJSON,
+} 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 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
+     */
+    async approveSellerBrokeredLeadRaw(requestParameters: BrokeredLeadsApiApproveSellerBrokeredLeadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        if (requestParameters['brokeredLeadId'] == null) {
+            throw new runtime.RequiredError(
+                'brokeredLeadId',
+                'Required parameter "brokeredLeadId" was null or undefined when calling approveSellerBrokeredLead().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["apikey"] = await this.configuration.apiKey("apikey"); // api_key authentication
+        }
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("bearer", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        const response = await this.request({
+            path: `/private/brokered-leads/{brokeredLeadId}/approve`.replace(`{${"brokeredLeadId"}}`, encodeURIComponent(String(requestParameters['brokeredLeadId']))),
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * 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
+     */
+    async approveSellerBrokeredLead(requestParameters: BrokeredLeadsApiApproveSellerBrokeredLeadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.approveSellerBrokeredLeadRaw(requestParameters, initOverrides);
+    }
+
+    /**
+     * 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
+     */
+    async cancelBrokerLeadRaw(requestParameters: BrokeredLeadsApiCancelBrokerLeadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        if (requestParameters['brokeredLeadId'] == null) {
+            throw new runtime.RequiredError(
+                'brokeredLeadId',
+                'Required parameter "brokeredLeadId" was null or undefined when calling cancelBrokerLead().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["apikey"] = await this.configuration.apiKey("apikey"); // api_key authentication
+        }
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("bearer", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        const response = await this.request({
+            path: `/private/broker/leads/{brokeredLeadId}/cancel`.replace(`{${"brokeredLeadId"}}`, encodeURIComponent(String(requestParameters['brokeredLeadId']))),
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * 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
+     */
+    async cancelBrokerLead(requestParameters: BrokeredLeadsApiCancelBrokerLeadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.cancelBrokerLeadRaw(requestParameters, initOverrides);
+    }
+
+    /**
+     * 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
+     */
+    async claimSellerBrokeredLeadInvitationRaw(requestParameters: BrokeredLeadsApiClaimSellerBrokeredLeadInvitationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        if (requestParameters['token'] == null) {
+            throw new runtime.RequiredError(
+                'token',
+                'Required parameter "token" was null or undefined when calling claimSellerBrokeredLeadInvitation().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["apikey"] = await this.configuration.apiKey("apikey"); // api_key authentication
+        }
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("bearer", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        const response = await this.request({
+            path: `/private/brokered-leads/invitations/{token}/claim`.replace(`{${"token"}}`, encodeURIComponent(String(requestParameters['token']))),
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * 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
+     */
+    async claimSellerBrokeredLeadInvitation(requestParameters: BrokeredLeadsApiClaimSellerBrokeredLeadInvitationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.claimSellerBrokeredLeadInvitationRaw(requestParameters, initOverrides);
+    }
+
+    /**
+     * 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
+     */
+    async createBrokerLeadRaw(requestParameters: BrokeredLeadsApiCreateBrokerLeadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ObjectId>> {
+        if (requestParameters['createBrokeredLeadInput'] == null) {
+            throw new runtime.RequiredError(
+                'createBrokeredLeadInput',
+                'Required parameter "createBrokeredLeadInput" was null or undefined when calling createBrokerLead().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["apikey"] = await this.configuration.apiKey("apikey"); // api_key authentication
+        }
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("bearer", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        const response = await this.request({
+            path: `/private/broker/leads`,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: CreateBrokeredLeadInputToJSON(requestParameters['createBrokeredLeadInput']),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ObjectIdFromJSON(jsonValue));
+    }
+
+    /**
+     * 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
+     */
+    async createBrokerLead(requestParameters: BrokeredLeadsApiCreateBrokerLeadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ObjectId> {
+        const response = await this.createBrokerLeadRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * 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
+     */
+    async declineSellerBrokeredLeadRaw(requestParameters: BrokeredLeadsApiDeclineSellerBrokeredLeadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        if (requestParameters['brokeredLeadId'] == null) {
+            throw new runtime.RequiredError(
+                'brokeredLeadId',
+                'Required parameter "brokeredLeadId" was null or undefined when calling declineSellerBrokeredLead().'
+            );
+        }
+
+        if (requestParameters['declineBrokeredLeadInput'] == null) {
+            throw new runtime.RequiredError(
+                'declineBrokeredLeadInput',
+                'Required parameter "declineBrokeredLeadInput" was null or undefined when calling declineSellerBrokeredLead().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["apikey"] = await this.configuration.apiKey("apikey"); // api_key authentication
+        }
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("bearer", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        const response = await this.request({
+            path: `/private/brokered-leads/{brokeredLeadId}/decline`.replace(`{${"brokeredLeadId"}}`, encodeURIComponent(String(requestParameters['brokeredLeadId']))),
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: DeclineBrokeredLeadInputToJSON(requestParameters['declineBrokeredLeadInput']),
+        }, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * 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
+     */
+    async declineSellerBrokeredLead(requestParameters: BrokeredLeadsApiDeclineSellerBrokeredLeadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.declineSellerBrokeredLeadRaw(requestParameters, initOverrides);
+    }
+
+    /**
+     * **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
+     */
+    async getBrokerLeadRaw(requestParameters: BrokeredLeadsApiGetBrokerLeadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<BrokerBrokeredLeadDto>> {
+        if (requestParameters['brokeredLeadId'] == null) {
+            throw new runtime.RequiredError(
+                'brokeredLeadId',
+                'Required parameter "brokeredLeadId" was null or undefined when calling getBrokerLead().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["apikey"] = await this.configuration.apiKey("apikey"); // api_key authentication
+        }
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("bearer", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        const response = await this.request({
+            path: `/private/broker/leads/{brokeredLeadId}`.replace(`{${"brokeredLeadId"}}`, encodeURIComponent(String(requestParameters['brokeredLeadId']))),
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => BrokerBrokeredLeadDtoFromJSON(jsonValue));
+    }
+
+    /**
+     * **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
+     */
+    async getBrokerLead(requestParameters: BrokeredLeadsApiGetBrokerLeadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BrokerBrokeredLeadDto> {
+        const response = await this.getBrokerLeadRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * **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
+     */
+    async getSellerBrokeredLeadRaw(requestParameters: BrokeredLeadsApiGetSellerBrokeredLeadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SellerBrokeredLeadDto>> {
+        if (requestParameters['brokeredLeadId'] == null) {
+            throw new runtime.RequiredError(
+                'brokeredLeadId',
+                'Required parameter "brokeredLeadId" was null or undefined when calling getSellerBrokeredLead().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["apikey"] = await this.configuration.apiKey("apikey"); // api_key authentication
+        }
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("bearer", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        const response = await this.request({
+            path: `/private/brokered-leads/{brokeredLeadId}`.replace(`{${"brokeredLeadId"}}`, encodeURIComponent(String(requestParameters['brokeredLeadId']))),
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => SellerBrokeredLeadDtoFromJSON(jsonValue));
+    }
+
+    /**
+     * **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
+     */
+    async getSellerBrokeredLead(requestParameters: BrokeredLeadsApiGetSellerBrokeredLeadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SellerBrokeredLeadDto> {
+        const response = await this.getSellerBrokeredLeadRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * 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
+     */
+    async listBrokerLeadsRaw(requestParameters: BrokeredLeadsApiListBrokerLeadsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListBrokerLeads200Response>> {
+        const queryParameters: any = {};
+
+        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'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["apikey"] = await this.configuration.apiKey("apikey"); // api_key authentication
+        }
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("bearer", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        const response = await this.request({
+            path: `/private/broker/leads`,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ListBrokerLeads200ResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * 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
+     */
+    async listBrokerLeads(requestParameters: BrokeredLeadsApiListBrokerLeadsRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListBrokerLeads200Response> {
+        const response = await this.listBrokerLeadsRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * 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
+     */
+    async listSellerBrokeredLeadsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<SellerBrokeredLeadDto>>> {
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["apikey"] = await this.configuration.apiKey("apikey"); // api_key authentication
+        }
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("bearer", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        const response = await this.request({
+            path: `/private/brokered-leads`,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(SellerBrokeredLeadDtoFromJSON));
+    }
+
+    /**
+     * 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
+     */
+    async listSellerBrokeredLeads(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<SellerBrokeredLeadDto>> {
+        const response = await this.listSellerBrokeredLeadsRaw(initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * 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
+     */
+    async notifyBrokerLeadBuyerRaw(requestParameters: BrokeredLeadsApiNotifyBrokerLeadBuyerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        if (requestParameters['brokeredLeadId'] == null) {
+            throw new runtime.RequiredError(
+                'brokeredLeadId',
+                'Required parameter "brokeredLeadId" was null or undefined when calling notifyBrokerLeadBuyer().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["apikey"] = await this.configuration.apiKey("apikey"); // api_key authentication
+        }
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("bearer", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        const response = await this.request({
+            path: `/private/broker/leads/{brokeredLeadId}/notify-buyer`.replace(`{${"brokeredLeadId"}}`, encodeURIComponent(String(requestParameters['brokeredLeadId']))),
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * 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
+     */
+    async notifyBrokerLeadBuyer(requestParameters: BrokeredLeadsApiNotifyBrokerLeadBuyerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.notifyBrokerLeadBuyerRaw(requestParameters, initOverrides);
+    }
+
+    /**
+     * 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
+     */
+    async notifyBrokerLeadSellerRaw(requestParameters: BrokeredLeadsApiNotifyBrokerLeadSellerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        if (requestParameters['brokeredLeadId'] == null) {
+            throw new runtime.RequiredError(
+                'brokeredLeadId',
+                'Required parameter "brokeredLeadId" was null or undefined when calling notifyBrokerLeadSeller().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["apikey"] = await this.configuration.apiKey("apikey"); // api_key authentication
+        }
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("bearer", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        const response = await this.request({
+            path: `/private/broker/leads/{brokeredLeadId}/notify-seller`.replace(`{${"brokeredLeadId"}}`, encodeURIComponent(String(requestParameters['brokeredLeadId']))),
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * 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
+     */
+    async notifyBrokerLeadSeller(requestParameters: BrokeredLeadsApiNotifyBrokerLeadSellerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.notifyBrokerLeadSellerRaw(requestParameters, initOverrides);
+    }
+
+    /**
+     * 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
+     */
+    async recheckSellerBrokeredLeadVerificationRaw(requestParameters: BrokeredLeadsApiRecheckSellerBrokeredLeadVerificationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        if (requestParameters['brokeredLeadId'] == null) {
+            throw new runtime.RequiredError(
+                'brokeredLeadId',
+                'Required parameter "brokeredLeadId" was null or undefined when calling recheckSellerBrokeredLeadVerification().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["apikey"] = await this.configuration.apiKey("apikey"); // api_key authentication
+        }
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("bearer", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        const response = await this.request({
+            path: `/private/brokered-leads/{brokeredLeadId}/verification`.replace(`{${"brokeredLeadId"}}`, encodeURIComponent(String(requestParameters['brokeredLeadId']))),
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * 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
+     */
+    async recheckSellerBrokeredLeadVerification(requestParameters: BrokeredLeadsApiRecheckSellerBrokeredLeadVerificationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.recheckSellerBrokeredLeadVerificationRaw(requestParameters, initOverrides);
+    }
+
+    /**
+     * 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
+     */
+    async renewBrokerLeadSellerLinkRaw(requestParameters: BrokeredLeadsApiRenewBrokerLeadSellerLinkRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        if (requestParameters['brokeredLeadId'] == null) {
+            throw new runtime.RequiredError(
+                'brokeredLeadId',
+                'Required parameter "brokeredLeadId" was null or undefined when calling renewBrokerLeadSellerLink().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["apikey"] = await this.configuration.apiKey("apikey"); // api_key authentication
+        }
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("bearer", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        const response = await this.request({
+            path: `/private/broker/leads/{brokeredLeadId}/seller-link`.replace(`{${"brokeredLeadId"}}`, encodeURIComponent(String(requestParameters['brokeredLeadId']))),
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * 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
+     */
+    async renewBrokerLeadSellerLink(requestParameters: BrokeredLeadsApiRenewBrokerLeadSellerLinkRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.renewBrokerLeadSellerLinkRaw(requestParameters, initOverrides);
+    }
+
+}