@randock/nameshift-api-client 0.0.538 → 0.0.540

package/src/apis/AdminApi.ts

@@ -27,6 +27,7 @@ import type {
   AdminCompanyStatsDto,
   AdminGetAllDomainTransfers200Response,
   AdminLandingDesignStatsDto,
+  AdminListBrokeredLeads200Response,
   AdminMarketplaceDto,
   AdminUserNewsletterInput,
   AdminUserSecurityDto,
@@ -76,6 +77,7 @@ import type {
   NewsletterDto,
   NewsletterPreviewDto,
   ObjectId,
+  OverrideBrokeredLeadNameshiftCommissionInput,
   PaySellerInvoicesInput,
   PaymentMethodsStatsDto,
   SalesStatsDto,
@@ -124,6 +126,8 @@ import {
     AdminGetAllDomainTransfers200ResponseToJSON,
     AdminLandingDesignStatsDtoFromJSON,
     AdminLandingDesignStatsDtoToJSON,
+    AdminListBrokeredLeads200ResponseFromJSON,
+    AdminListBrokeredLeads200ResponseToJSON,
     AdminMarketplaceDtoFromJSON,
     AdminMarketplaceDtoToJSON,
     AdminUserNewsletterInputFromJSON,
@@ -222,6 +226,8 @@ import {
     NewsletterPreviewDtoToJSON,
     ObjectIdFromJSON,
     ObjectIdToJSON,
+    OverrideBrokeredLeadNameshiftCommissionInputFromJSON,
+    OverrideBrokeredLeadNameshiftCommissionInputToJSON,
     PaySellerInvoicesInputFromJSON,
     PaySellerInvoicesInputToJSON,
     PaymentMethodsStatsDtoFromJSON,
@@ -281,6 +287,23 @@ export interface AdminApiAdminGetAllDomainTransfersRequest {
     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;
@@ -898,6 +921,128 @@ export class AdminApi extends runtime.BaseAPI {
         return await response.value();
     }
 
+    /**
+     * List all brokered deals
+     */
+    async adminListBrokeredLeadsRaw(requestParameters: AdminApiAdminListBrokeredLeadsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AdminListBrokeredLeads200Response>> {
+        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.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("bearer", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        const response = await this.request({
+            path: `/admin/brokered-leads`,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => AdminListBrokeredLeads200ResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * List all brokered deals
+     */
+    async adminListBrokeredLeads(requestParameters: AdminApiAdminListBrokeredLeadsRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AdminListBrokeredLeads200Response> {
+        const response = await this.adminListBrokeredLeadsRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * 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
+     */
+    async adminOverrideBrokeredLeadNameshiftCommissionRaw(requestParameters: AdminApiAdminOverrideBrokeredLeadNameshiftCommissionRequest, 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 adminOverrideBrokeredLeadNameshiftCommission().'
+            );
+        }
+
+        if (requestParameters['overrideBrokeredLeadNameshiftCommissionInput'] == null) {
+            throw new runtime.RequiredError(
+                'overrideBrokeredLeadNameshiftCommissionInput',
+                'Required parameter "overrideBrokeredLeadNameshiftCommissionInput" was null or undefined when calling adminOverrideBrokeredLeadNameshiftCommission().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        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: `/admin/brokered-leads/{brokeredLeadId}/nameshift-commission`.replace(`{${"brokeredLeadId"}}`, encodeURIComponent(String(requestParameters['brokeredLeadId']))),
+            method: 'PUT',
+            headers: headerParameters,
+            query: queryParameters,
+            body: OverrideBrokeredLeadNameshiftCommissionInputToJSON(requestParameters['overrideBrokeredLeadNameshiftCommissionInput']),
+        }, initOverrides);
+
+        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
+     */
+    async adminOverrideBrokeredLeadNameshiftCommission(requestParameters: AdminApiAdminOverrideBrokeredLeadNameshiftCommissionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.adminOverrideBrokeredLeadNameshiftCommissionRaw(requestParameters, initOverrides);
+    }
+
     /**
      * 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