@randock/nameshift-api-client 0.0.538 → 0.0.540

package/src/apis/BrokeredLeadsPublicApi.ts

@@ -0,0 +1,69 @@
+/* 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 {
+  BrokeredLeadInvitationDto,
+} from '../models/index';
+import {
+    BrokeredLeadInvitationDtoFromJSON,
+    BrokeredLeadInvitationDtoToJSON,
+} from '../models/index';
+
+export interface BrokeredLeadsPublicApiGetBrokeredLeadInvitationRequest {
+    token: string;
+}
+
+/**
+ * 
+ */
+export class BrokeredLeadsPublicApi extends runtime.BaseAPI {
+
+    /**
+     * Returns the domain, broker and price of the deal behind a seller signup link, and whether the link can still be used.
+     * Get the deal a seller signup link invites for
+     */
+    async getBrokeredLeadInvitationRaw(requestParameters: BrokeredLeadsPublicApiGetBrokeredLeadInvitationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<BrokeredLeadInvitationDto>> {
+        if (requestParameters['token'] == null) {
+            throw new runtime.RequiredError(
+                'token',
+                'Required parameter "token" was null or undefined when calling getBrokeredLeadInvitation().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        const response = await this.request({
+            path: `/brokered-leads/invitations/{token}`.replace(`{${"token"}}`, encodeURIComponent(String(requestParameters['token']))),
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => BrokeredLeadInvitationDtoFromJSON(jsonValue));
+    }
+
+    /**
+     * Returns the domain, broker and price of the deal behind a seller signup link, and whether the link can still be used.
+     * Get the deal a seller signup link invites for
+     */
+    async getBrokeredLeadInvitation(requestParameters: BrokeredLeadsPublicApiGetBrokeredLeadInvitationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BrokeredLeadInvitationDto> {
+        const response = await this.getBrokeredLeadInvitationRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+}

package/src/apis/index.ts

@@ -8,6 +8,8 @@ export * from './AdminApi';
 export * from './AuctionsApi';
 export * from './AuctionsPublicApi';
 export * from './BankAccountsApi';
+export * from './BrokeredLeadsApi';
+export * from './BrokeredLeadsPublicApi';
 export * from './BuyersApi';
 export * from './BuyersPublicApi';
 export * from './ChallengesApi';

package/src/models/AccountBrokerSettingsInput.ts

@@ -0,0 +1,73 @@
+/* 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 { mapValues } from '../runtime';
+/**
+ * 
+ * @export
+ * @interface AccountBrokerSettingsInput
+ */
+export interface AccountBrokerSettingsInput {
+    /**
+     * Whether the account works as a broker. Brokers still need to complete the account verification before they can bring in deals.
+     * @type {boolean}
+     * @memberof AccountBrokerSettingsInput
+     */
+    enabled?: boolean;
+    /**
+     * ISO 639-1 codes of the languages the broker works in. Replaces the current list.
+     * @type {Array<string>}
+     * @memberof AccountBrokerSettingsInput
+     */
+    spokenLanguages?: Array<string>;
+}
+
+/**
+ * Check if a given object implements the AccountBrokerSettingsInput interface.
+ */
+export function instanceOfAccountBrokerSettingsInput(value: object): value is AccountBrokerSettingsInput {
+    return true;
+}
+
+export function AccountBrokerSettingsInputFromJSON(json: any): AccountBrokerSettingsInput {
+    return AccountBrokerSettingsInputFromJSONTyped(json, false);
+}
+
+export function AccountBrokerSettingsInputFromJSONTyped(json: any, ignoreDiscriminator: boolean): AccountBrokerSettingsInput {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'enabled': json['enabled'] == null ? undefined : json['enabled'],
+        'spokenLanguages': json['spokenLanguages'] == null ? undefined : json['spokenLanguages'],
+    };
+}
+
+export function AccountBrokerSettingsInputToJSON(json: any): AccountBrokerSettingsInput {
+    return AccountBrokerSettingsInputToJSONTyped(json, false);
+}
+
+export function AccountBrokerSettingsInputToJSONTyped(value?: AccountBrokerSettingsInput | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'enabled': value['enabled'],
+        'spokenLanguages': value['spokenLanguages'],
+    };
+}
+

package/src/models/AccountDto.ts

@@ -115,6 +115,18 @@ export interface AccountDto {
      * @memberof AccountDto
      */
     canSell: boolean;
+    /**
+     * Whether the account can bring in brokered deals: brokerage is switched on and the account is verified.
+     * @type {boolean}
+     * @memberof AccountDto
+     */
+    canBroker: boolean;
+    /**
+     * Whether the account can see the onboarding.
+     * @type {boolean}
+     * @memberof AccountDto
+     */
+    canSeeOnboarding: boolean;
 }
 
 /**
@@ -131,6 +143,8 @@ export function instanceOfAccountDto(value: object): value is AccountDto {
     if (!('leaseToOwnKickbackPercentage' in value) || value['leaseToOwnKickbackPercentage'] === undefined) return false;
     if (!('challengeRewardBalance' in value) || value['challengeRewardBalance'] === undefined) return false;
     if (!('canSell' in value) || value['canSell'] === undefined) return false;
+    if (!('canBroker' in value) || value['canBroker'] === undefined) return false;
+    if (!('canSeeOnboarding' in value) || value['canSeeOnboarding'] === undefined) return false;
     return true;
 }
 
@@ -154,6 +168,8 @@ export function AccountDtoFromJSONTyped(json: any, ignoreDiscriminator: boolean)
         'leaseToOwnKickbackPercentage': json['leaseToOwnKickbackPercentage'],
         'challengeRewardBalance': ChallengeRewardBalanceDtoFromJSON(json['challengeRewardBalance']),
         'canSell': json['canSell'],
+        'canBroker': json['canBroker'],
+        'canSeeOnboarding': json['canSeeOnboarding'],
     };
 }
 
@@ -178,6 +194,8 @@ export function AccountDtoToJSONTyped(value?: AccountDto | null, ignoreDiscrimin
         'leaseToOwnKickbackPercentage': value['leaseToOwnKickbackPercentage'],
         'challengeRewardBalance': ChallengeRewardBalanceDtoToJSON(value['challengeRewardBalance']),
         'canSell': value['canSell'],
+        'canBroker': value['canBroker'],
+        'canSeeOnboarding': value['canSeeOnboarding'],
     };
 }
 

package/src/models/AccountNameshiftCommissionBySubtypeDto.ts

@@ -62,7 +62,8 @@ export const AccountNameshiftCommissionBySubtypeDtoSubtypeEnum = {
     NOT_POINTING: 'not_pointing',
     ROUTED: 'routed',
     MANUAL_LEAD: 'manual_lead',
-    AUCTION: 'auction'
+    AUCTION: 'auction',
+    BROKERED_LEAD: 'brokered_lead'
 } as const;
 export type AccountNameshiftCommissionBySubtypeDtoSubtypeEnum = typeof AccountNameshiftCommissionBySubtypeDtoSubtypeEnum[keyof typeof AccountNameshiftCommissionBySubtypeDtoSubtypeEnum];
 

package/src/models/AccountNameshiftCommissionItemDto.ts

@@ -86,7 +86,8 @@ export const AccountNameshiftCommissionItemDtoSubtypeEnum = {
     NOT_POINTING: 'not_pointing',
     ROUTED: 'routed',
     MANUAL_LEAD: 'manual_lead',
-    AUCTION: 'auction'
+    AUCTION: 'auction',
+    BROKERED_LEAD: 'brokered_lead'
 } as const;
 export type AccountNameshiftCommissionItemDtoSubtypeEnum = typeof AccountNameshiftCommissionItemDtoSubtypeEnum[keyof typeof AccountNameshiftCommissionItemDtoSubtypeEnum];
 

package/src/models/AccountNameshiftCommissionReasonDto.ts

@@ -132,7 +132,8 @@ export const AccountNameshiftCommissionReasonDtoSubtypeEnum = {
     NOT_POINTING: 'not_pointing',
     ROUTED: 'routed',
     MANUAL_LEAD: 'manual_lead',
-    AUCTION: 'auction'
+    AUCTION: 'auction',
+    BROKERED_LEAD: 'brokered_lead'
 } as const;
 export type AccountNameshiftCommissionReasonDtoSubtypeEnum = typeof AccountNameshiftCommissionReasonDtoSubtypeEnum[keyof typeof AccountNameshiftCommissionReasonDtoSubtypeEnum];
 

package/src/models/AccountNotificationDto.ts

@@ -73,7 +73,8 @@ export const AccountNotificationDtoTypeEnum = {
     ACCOUNT_PAYMENT_PROVIDER_NOT_ACTIVE: 'account.payment_provider.not_active',
     ACCOUNT_PAYMENT_PROVIDER_WAS_CHANGED: 'account.payment_provider.was_changed',
     ACCOUNT_BANK_ACCOUNT_VERIFICATION_REQUIRED: 'account.bank_account.verification_required',
-    ACCOUNT_BANK_ACCOUNT_REQUIRED_TO_RECEIVE_PAYOUTS: 'account.bank_account.required_to_receive_payouts'
+    ACCOUNT_BANK_ACCOUNT_REQUIRED_TO_RECEIVE_PAYOUTS: 'account.bank_account.required_to_receive_payouts',
+    ACCOUNT_BROKERED_LEAD_APPROVAL_REQUIRED: 'account.brokered_lead.approval_required'
 } as const;
 export type AccountNotificationDtoTypeEnum = typeof AccountNotificationDtoTypeEnum[keyof typeof AccountNotificationDtoTypeEnum];
 

package/src/models/AccountSettingsBrokerDto.ts

@@ -0,0 +1,75 @@
+/* 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 { mapValues } from '../runtime';
+/**
+ * 
+ * @export
+ * @interface AccountSettingsBrokerDto
+ */
+export interface AccountSettingsBrokerDto {
+    /**
+     * Whether the account works as a broker.
+     * @type {boolean}
+     * @memberof AccountSettingsBrokerDto
+     */
+    enabled: boolean;
+    /**
+     * ISO 639-1 codes of the languages the broker works in.
+     * @type {Array<string>}
+     * @memberof AccountSettingsBrokerDto
+     */
+    spokenLanguages: Array<string>;
+}
+
+/**
+ * Check if a given object implements the AccountSettingsBrokerDto interface.
+ */
+export function instanceOfAccountSettingsBrokerDto(value: object): value is AccountSettingsBrokerDto {
+    if (!('enabled' in value) || value['enabled'] === undefined) return false;
+    if (!('spokenLanguages' in value) || value['spokenLanguages'] === undefined) return false;
+    return true;
+}
+
+export function AccountSettingsBrokerDtoFromJSON(json: any): AccountSettingsBrokerDto {
+    return AccountSettingsBrokerDtoFromJSONTyped(json, false);
+}
+
+export function AccountSettingsBrokerDtoFromJSONTyped(json: any, ignoreDiscriminator: boolean): AccountSettingsBrokerDto {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'enabled': json['enabled'],
+        'spokenLanguages': json['spokenLanguages'],
+    };
+}
+
+export function AccountSettingsBrokerDtoToJSON(json: any): AccountSettingsBrokerDto {
+    return AccountSettingsBrokerDtoToJSONTyped(json, false);
+}
+
+export function AccountSettingsBrokerDtoToJSONTyped(value?: AccountSettingsBrokerDto | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'enabled': value['enabled'],
+        'spokenLanguages': value['spokenLanguages'],
+    };
+}
+

package/src/models/AccountSettingsDto.ts

@@ -41,6 +41,13 @@ import {
     AccountSettingsAliasDtoToJSON,
     AccountSettingsAliasDtoToJSONTyped,
 } from './AccountSettingsAliasDto';
+import type { AccountSettingsBrokerDto } from './AccountSettingsBrokerDto';
+import {
+    AccountSettingsBrokerDtoFromJSON,
+    AccountSettingsBrokerDtoFromJSONTyped,
+    AccountSettingsBrokerDtoToJSON,
+    AccountSettingsBrokerDtoToJSONTyped,
+} from './AccountSettingsBrokerDto';
 import type { AccountSettingsLeaseToOwnConfigurationDto } from './AccountSettingsLeaseToOwnConfigurationDto';
 import {
     AccountSettingsLeaseToOwnConfigurationDtoFromJSON,
@@ -173,6 +180,12 @@ export interface AccountSettingsDto {
      * @memberof AccountSettingsDto
      */
     leadVerification: LeadVerificationSettingsDto;
+    /**
+     * Brokerage settings: whether the account works as a broker.
+     * @type {AccountSettingsBrokerDto}
+     * @memberof AccountSettingsDto
+     */
+    broker: AccountSettingsBrokerDto;
     /**
      * When the buyer of an information request (a lead opened to ask for the price) may write and make offers: immediately, or only after the seller has written or made an offer.
      * @type {string}
@@ -224,6 +237,7 @@ export function instanceOfAccountSettingsDto(value: object): value is AccountSet
     if (!('leadOfferExpirationConfiguration' in value) || value['leadOfferExpirationConfiguration'] === undefined) return false;
     if (!('marketplace' in value) || value['marketplace'] === undefined) return false;
     if (!('leadVerification' in value) || value['leadVerification'] === undefined) return false;
+    if (!('broker' in value) || value['broker'] === undefined) return false;
     if (!('informationRequestCommunication' in value) || value['informationRequestCommunication'] === undefined) return false;
     return true;
 }
@@ -253,6 +267,7 @@ export function AccountSettingsDtoFromJSONTyped(json: any, ignoreDiscriminator:
         'leadOfferExpirationConfiguration': LeadOfferExpirationConfigurationDtoFromJSON(json['leadOfferExpirationConfiguration']),
         'marketplace': json['marketplace'],
         'leadVerification': LeadVerificationSettingsDtoFromJSON(json['leadVerification']),
+        'broker': AccountSettingsBrokerDtoFromJSON(json['broker']),
         'informationRequestCommunication': json['informationRequestCommunication'],
     };
 }
@@ -283,6 +298,7 @@ export function AccountSettingsDtoToJSONTyped(value?: AccountSettingsDto | null,
         'leadOfferExpirationConfiguration': LeadOfferExpirationConfigurationDtoToJSON(value['leadOfferExpirationConfiguration']),
         'marketplace': value['marketplace'],
         'leadVerification': LeadVerificationSettingsDtoToJSON(value['leadVerification']),
+        'broker': AccountSettingsBrokerDtoToJSON(value['broker']),
         'informationRequestCommunication': value['informationRequestCommunication'],
     };
 }

package/src/models/AccountSettingsInput.ts

@@ -13,6 +13,13 @@
  */
 
 import { mapValues } from '../runtime';
+import type { AccountBrokerSettingsInput } from './AccountBrokerSettingsInput';
+import {
+    AccountBrokerSettingsInputFromJSON,
+    AccountBrokerSettingsInputFromJSONTyped,
+    AccountBrokerSettingsInputToJSON,
+    AccountBrokerSettingsInputToJSONTyped,
+} from './AccountBrokerSettingsInput';
 import type { LockConfigurationInput } from './LockConfigurationInput';
 import {
     LockConfigurationInputFromJSON,
@@ -172,6 +179,12 @@ export interface AccountSettingsInput {
      * @memberof AccountSettingsInput
      */
     leadVerification?: LeadVerificationInput;
+    /**
+     * Brokerage settings: whether the account works as a broker.
+     * @type {AccountBrokerSettingsInput}
+     * @memberof AccountSettingsInput
+     */
+    broker?: AccountBrokerSettingsInput;
     /**
      * When the buyer of an information request (a lead opened to ask for the price) may write and make offers: immediately, or only after the seller has written or made an offer. Applies to information requests opened after the change.
      * @type {string}
@@ -237,6 +250,7 @@ export function AccountSettingsInputFromJSONTyped(json: any, ignoreDiscriminator
         'domainLockConfiguration': json['domainLockConfiguration'] == null ? undefined : LockConfigurationInputFromJSON(json['domainLockConfiguration']),
         'leadOfferExpirationConfiguration': json['leadOfferExpirationConfiguration'] == null ? undefined : LockConfigurationInputFromJSON(json['leadOfferExpirationConfiguration']),
         'leadVerification': json['leadVerification'] == null ? undefined : LeadVerificationInputFromJSON(json['leadVerification']),
+        'broker': json['broker'] == null ? undefined : AccountBrokerSettingsInputFromJSON(json['broker']),
         'informationRequestCommunication': json['informationRequestCommunication'] == null ? undefined : json['informationRequestCommunication'],
     };
 }
@@ -268,6 +282,7 @@ export function AccountSettingsInputToJSONTyped(value?: AccountSettingsInput | n
         'domainLockConfiguration': LockConfigurationInputToJSON(value['domainLockConfiguration']),
         'leadOfferExpirationConfiguration': LockConfigurationInputToJSON(value['leadOfferExpirationConfiguration']),
         'leadVerification': LeadVerificationInputToJSON(value['leadVerification']),
+        'broker': AccountBrokerSettingsInputToJSON(value['broker']),
         'informationRequestCommunication': value['informationRequestCommunication'],
     };
 }