@randock/nameshift-api-client 0.0.538 → 0.0.539

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (170) hide show
  1. package/.openapi-generator/FILES +20 -0
  2. package/README.md +3 -3
  3. package/dist/apis/AdminApi.d.ts +36 -1
  4. package/dist/apis/AdminApi.js +136 -0
  5. package/dist/apis/BrokeredLeadsApi.d.ts +195 -0
  6. package/dist/apis/BrokeredLeadsApi.js +912 -0
  7. package/dist/apis/BrokeredLeadsPublicApi.d.ts +31 -0
  8. package/dist/apis/BrokeredLeadsPublicApi.js +126 -0
  9. package/dist/apis/index.d.ts +2 -0
  10. package/dist/apis/index.js +2 -0
  11. package/dist/models/AccountBrokerSettingsInput.d.ts +38 -0
  12. package/dist/models/AccountBrokerSettingsInput.js +51 -0
  13. package/dist/models/AccountDto.d.ts +6 -0
  14. package/dist/models/AccountDto.js +4 -0
  15. package/dist/models/AccountNameshiftCommissionBySubtypeDto.d.ts +1 -0
  16. package/dist/models/AccountNameshiftCommissionBySubtypeDto.js +2 -1
  17. package/dist/models/AccountNameshiftCommissionItemDto.d.ts +1 -0
  18. package/dist/models/AccountNameshiftCommissionItemDto.js +2 -1
  19. package/dist/models/AccountNameshiftCommissionReasonDto.d.ts +1 -0
  20. package/dist/models/AccountNameshiftCommissionReasonDto.js +2 -1
  21. package/dist/models/AccountNotificationDto.d.ts +1 -0
  22. package/dist/models/AccountNotificationDto.js +2 -1
  23. package/dist/models/AccountSettingsBrokerDto.d.ts +38 -0
  24. package/dist/models/AccountSettingsBrokerDto.js +55 -0
  25. package/dist/models/AccountSettingsDto.d.ts +7 -0
  26. package/dist/models/AccountSettingsDto.js +5 -0
  27. package/dist/models/AccountSettingsInput.d.ts +7 -0
  28. package/dist/models/AccountSettingsInput.js +3 -0
  29. package/dist/models/AdminBrokeredLeadDto.d.ts +248 -0
  30. package/dist/models/AdminBrokeredLeadDto.js +204 -0
  31. package/dist/models/AdminListBrokeredLeads200Response.d.ts +47 -0
  32. package/dist/models/AdminListBrokeredLeads200Response.js +62 -0
  33. package/dist/models/ApiKeyDto.d.ts +2 -0
  34. package/dist/models/ApiKeyDto.js +2 -0
  35. package/dist/models/ApiKeyScopeDto.d.ts +2 -0
  36. package/dist/models/ApiKeyScopeDto.js +2 -0
  37. package/dist/models/BrokerBrokeredLeadDto.d.ts +189 -0
  38. package/dist/models/BrokerBrokeredLeadDto.js +162 -0
  39. package/dist/models/BrokerCommissionInput.d.ts +52 -0
  40. package/dist/models/BrokerCommissionInput.js +63 -0
  41. package/dist/models/BrokeredLeadBreakdownDto.d.ts +58 -0
  42. package/dist/models/BrokeredLeadBreakdownDto.js +69 -0
  43. package/dist/models/BrokeredLeadBuyerContactDto.d.ts +50 -0
  44. package/dist/models/BrokeredLeadBuyerContactDto.js +63 -0
  45. package/dist/models/BrokeredLeadBuyerInput.d.ts +50 -0
  46. package/dist/models/BrokeredLeadBuyerInput.js +63 -0
  47. package/dist/models/BrokeredLeadCommissionDto.d.ts +71 -0
  48. package/dist/models/BrokeredLeadCommissionDto.js +80 -0
  49. package/dist/models/BrokeredLeadInvitationDto.d.ts +57 -0
  50. package/dist/models/BrokeredLeadInvitationDto.js +68 -0
  51. package/dist/models/BuyerInvoiceDto.d.ts +6 -0
  52. package/dist/models/BuyerInvoiceDto.js +4 -0
  53. package/dist/models/BuyerNotificationDto.d.ts +6 -0
  54. package/dist/models/BuyerNotificationDto.js +7 -1
  55. package/dist/models/BuyerNotificationListItemDto.d.ts +6 -0
  56. package/dist/models/BuyerNotificationListItemDto.js +7 -1
  57. package/dist/models/CommissionDto.d.ts +1 -0
  58. package/dist/models/CommissionDto.js +2 -1
  59. package/dist/models/CommissionPayloadInput.d.ts +1 -0
  60. package/dist/models/CommissionPayloadInput.js +2 -1
  61. package/dist/models/CommissionReasonDto.d.ts +1 -0
  62. package/dist/models/CommissionReasonDto.js +2 -1
  63. package/dist/models/CommissionSimulationItemInput.d.ts +1 -0
  64. package/dist/models/CommissionSimulationItemInput.js +2 -1
  65. package/dist/models/CreateApiKeyInput.d.ts +2 -0
  66. package/dist/models/CreateApiKeyInput.js +2 -0
  67. package/dist/models/CreateBrokeredLeadInput.d.ts +59 -0
  68. package/dist/models/CreateBrokeredLeadInput.js +68 -0
  69. package/dist/models/CreatedApiKeyDto.d.ts +2 -0
  70. package/dist/models/CreatedApiKeyDto.js +2 -0
  71. package/dist/models/CustomerSuccessListAccountDto.d.ts +6 -0
  72. package/dist/models/CustomerSuccessListAccountDto.js +4 -0
  73. package/dist/models/DeclineBrokeredLeadInput.d.ts +32 -0
  74. package/dist/models/DeclineBrokeredLeadInput.js +49 -0
  75. package/dist/models/FeatureFlagListItemDto.d.ts +1 -0
  76. package/dist/models/FeatureFlagListItemDto.js +1 -0
  77. package/dist/models/IntersectionAccountDtoWithSettingsDtoWithNotificationsDtoWithFeatureFlagsDto.d.ts +7 -0
  78. package/dist/models/IntersectionAccountDtoWithSettingsDtoWithNotificationsDtoWithFeatureFlagsDto.js +5 -0
  79. package/dist/models/IntersectionDomainDtoWithHijackerDtoWithAccountDto.d.ts +1 -1
  80. package/dist/models/InvoiceDto.d.ts +6 -0
  81. package/dist/models/InvoiceDto.js +4 -0
  82. package/dist/models/LeadBrokeredDealDto.d.ts +39 -0
  83. package/dist/models/LeadBrokeredDealDto.js +56 -0
  84. package/dist/models/ListBrokerLeads200Response.d.ts +47 -0
  85. package/dist/models/ListBrokerLeads200Response.js +62 -0
  86. package/dist/models/ListLeadsResultItem.d.ts +7 -0
  87. package/dist/models/ListLeadsResultItem.js +5 -0
  88. package/dist/models/ManualLeadDetails.d.ts +7 -0
  89. package/dist/models/ManualLeadDetails.js +5 -0
  90. package/dist/models/OverrideBrokeredLeadNameshiftCommissionInput.d.ts +38 -0
  91. package/dist/models/OverrideBrokeredLeadNameshiftCommissionInput.js +55 -0
  92. package/dist/models/PrivateAccountGetMeResponse.d.ts +13 -0
  93. package/dist/models/PrivateAccountGetMeResponse.js +9 -0
  94. package/dist/models/RegisterAccountInput.d.ts +6 -0
  95. package/dist/models/RegisterAccountInput.js +2 -0
  96. package/dist/models/SellerBrokeredLeadDto.d.ts +114 -0
  97. package/dist/models/SellerBrokeredLeadDto.js +111 -0
  98. package/dist/models/SellerBrokeredLeadVerificationDto.d.ts +44 -0
  99. package/dist/models/SellerBrokeredLeadVerificationDto.js +59 -0
  100. package/dist/models/SellerInvoiceDto.d.ts +6 -0
  101. package/dist/models/SellerInvoiceDto.js +4 -0
  102. package/dist/models/SimulateCommissionInput.d.ts +1 -0
  103. package/dist/models/SimulateCommissionInput.js +2 -1
  104. package/dist/models/UpdateApiKeyInput.d.ts +2 -0
  105. package/dist/models/UpdateApiKeyInput.js +2 -0
  106. package/dist/models/UserNotificationDto.d.ts +6 -0
  107. package/dist/models/UserNotificationDto.js +7 -1
  108. package/dist/models/UserNotificationListItemDto.d.ts +6 -0
  109. package/dist/models/UserNotificationListItemDto.js +7 -1
  110. package/dist/models/WithSettingsInner.d.ts +11 -4
  111. package/dist/models/WithSettingsInner.js +9 -4
  112. package/dist/models/index.d.ts +18 -0
  113. package/dist/models/index.js +18 -0
  114. package/package.json +1 -1
  115. package/src/apis/AdminApi.ts +145 -0
  116. package/src/apis/BrokeredLeadsApi.ts +740 -0
  117. package/src/apis/BrokeredLeadsPublicApi.ts +69 -0
  118. package/src/apis/index.ts +2 -0
  119. package/src/models/AccountBrokerSettingsInput.ts +73 -0
  120. package/src/models/AccountDto.ts +9 -0
  121. package/src/models/AccountNameshiftCommissionBySubtypeDto.ts +2 -1
  122. package/src/models/AccountNameshiftCommissionItemDto.ts +2 -1
  123. package/src/models/AccountNameshiftCommissionReasonDto.ts +2 -1
  124. package/src/models/AccountNotificationDto.ts +2 -1
  125. package/src/models/AccountSettingsBrokerDto.ts +75 -0
  126. package/src/models/AccountSettingsDto.ts +16 -0
  127. package/src/models/AccountSettingsInput.ts +15 -0
  128. package/src/models/AdminBrokeredLeadDto.ts +404 -0
  129. package/src/models/AdminListBrokeredLeads200Response.ts +106 -0
  130. package/src/models/ApiKeyDto.ts +2 -0
  131. package/src/models/ApiKeyScopeDto.ts +2 -0
  132. package/src/models/BrokerBrokeredLeadDto.ts +320 -0
  133. package/src/models/BrokerCommissionInput.ts +93 -0
  134. package/src/models/BrokeredLeadBreakdownDto.ts +117 -0
  135. package/src/models/BrokeredLeadBuyerContactDto.ts +93 -0
  136. package/src/models/BrokeredLeadBuyerInput.ts +93 -0
  137. package/src/models/BrokeredLeadCommissionDto.ts +130 -0
  138. package/src/models/BrokeredLeadInvitationDto.ts +110 -0
  139. package/src/models/BuyerInvoiceDto.ts +9 -0
  140. package/src/models/BuyerNotificationDto.ts +7 -1
  141. package/src/models/BuyerNotificationListItemDto.ts +7 -1
  142. package/src/models/CommissionDto.ts +2 -1
  143. package/src/models/CommissionPayloadInput.ts +2 -1
  144. package/src/models/CommissionReasonDto.ts +2 -1
  145. package/src/models/CommissionSimulationItemInput.ts +2 -1
  146. package/src/models/CreateApiKeyInput.ts +2 -0
  147. package/src/models/CreateBrokeredLeadInput.ts +123 -0
  148. package/src/models/CreatedApiKeyDto.ts +2 -0
  149. package/src/models/CustomerSuccessListAccountDto.ts +9 -0
  150. package/src/models/DeclineBrokeredLeadInput.ts +65 -0
  151. package/src/models/FeatureFlagListItemDto.ts +1 -0
  152. package/src/models/IntersectionAccountDtoWithSettingsDtoWithNotificationsDtoWithFeatureFlagsDto.ts +10 -0
  153. package/src/models/IntersectionDomainDtoWithHijackerDtoWithAccountDto.ts +1 -1
  154. package/src/models/InvoiceDto.ts +9 -0
  155. package/src/models/LeadBrokeredDealDto.ts +83 -0
  156. package/src/models/ListBrokerLeads200Response.ts +106 -0
  157. package/src/models/ListLeadsResultItem.ts +16 -0
  158. package/src/models/ManualLeadDetails.ts +16 -0
  159. package/src/models/OverrideBrokeredLeadNameshiftCommissionInput.ts +75 -0
  160. package/src/models/PrivateAccountGetMeResponse.ts +19 -0
  161. package/src/models/RegisterAccountInput.ts +8 -0
  162. package/src/models/SellerBrokeredLeadDto.ts +215 -0
  163. package/src/models/SellerBrokeredLeadVerificationDto.ts +84 -0
  164. package/src/models/SellerInvoiceDto.ts +9 -0
  165. package/src/models/SimulateCommissionInput.ts +2 -1
  166. package/src/models/UpdateApiKeyInput.ts +2 -0
  167. package/src/models/UserNotificationDto.ts +7 -1
  168. package/src/models/UserNotificationListItemDto.ts +7 -1
  169. package/src/models/WithSettingsInner.ts +44 -28
  170. package/src/models/index.ts +18 -0
@@ -0,0 +1,65 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Nameshift
5
+ * 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.
6
+ *
7
+ * The version of the OpenAPI document: 1.0
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+ import { mapValues } from '../runtime';
16
+ /**
17
+ *
18
+ * @export
19
+ * @interface DeclineBrokeredLeadInput
20
+ */
21
+ export interface DeclineBrokeredLeadInput {
22
+ /**
23
+ * Why the seller declines; shared with the broker.
24
+ * @type {string}
25
+ * @memberof DeclineBrokeredLeadInput
26
+ */
27
+ reason?: string | null;
28
+ }
29
+
30
+ /**
31
+ * Check if a given object implements the DeclineBrokeredLeadInput interface.
32
+ */
33
+ export function instanceOfDeclineBrokeredLeadInput(value: object): value is DeclineBrokeredLeadInput {
34
+ return true;
35
+ }
36
+
37
+ export function DeclineBrokeredLeadInputFromJSON(json: any): DeclineBrokeredLeadInput {
38
+ return DeclineBrokeredLeadInputFromJSONTyped(json, false);
39
+ }
40
+
41
+ export function DeclineBrokeredLeadInputFromJSONTyped(json: any, ignoreDiscriminator: boolean): DeclineBrokeredLeadInput {
42
+ if (json == null) {
43
+ return json;
44
+ }
45
+ return {
46
+
47
+ 'reason': json['reason'] == null ? undefined : json['reason'],
48
+ };
49
+ }
50
+
51
+ export function DeclineBrokeredLeadInputToJSON(json: any): DeclineBrokeredLeadInput {
52
+ return DeclineBrokeredLeadInputToJSONTyped(json, false);
53
+ }
54
+
55
+ export function DeclineBrokeredLeadInputToJSONTyped(value?: DeclineBrokeredLeadInput | null, ignoreDiscriminator: boolean = false): any {
56
+ if (value == null) {
57
+ return value;
58
+ }
59
+
60
+ return {
61
+
62
+ 'reason': value['reason'],
63
+ };
64
+ }
65
+
@@ -99,6 +99,7 @@ export const FeatureFlagListItemDtoNameEnum = {
99
99
  LEAD_ENRICHMENT: 'LEAD_ENRICHMENT',
100
100
  LEAD_CREATION_RECAPTCHA: 'LEAD_CREATION_RECAPTCHA',
101
101
  DOMAIN_TRANSFER_HOLDER_CHANGE_FORM_SE_NU: 'DOMAIN_TRANSFER_HOLDER_CHANGE_FORM_SE_NU',
102
+ BROKER_PROGRAM: 'BROKER_PROGRAM',
102
103
  DOMAIN_APPRAISAL: 'DOMAIN_APPRAISAL',
103
104
  BANK_ACCOUNT_NAME_CHECK: 'BANK_ACCOUNT_NAME_CHECK',
104
105
  MFA_ENFORCED_FOR_STAFF: 'MFA_ENFORCED_FOR_STAFF',
@@ -129,6 +129,12 @@ export interface IntersectionAccountDtoWithSettingsDtoWithNotificationsDtoWithFe
129
129
  * @memberof IntersectionAccountDtoWithSettingsDtoWithNotificationsDtoWithFeatureFlagsDto
130
130
  */
131
131
  canSell: boolean;
132
+ /**
133
+ * Whether the account can bring in brokered deals: brokerage is switched on and the account is verified.
134
+ * @type {boolean}
135
+ * @memberof IntersectionAccountDtoWithSettingsDtoWithNotificationsDtoWithFeatureFlagsDto
136
+ */
137
+ canBroker: boolean;
132
138
  /**
133
139
  * Account settings.
134
140
  * @type {WithSettingsInner}
@@ -185,6 +191,7 @@ export const IntersectionAccountDtoWithSettingsDtoWithNotificationsDtoWithFeatur
185
191
  LEAD_ENRICHMENT: 'LEAD_ENRICHMENT',
186
192
  LEAD_CREATION_RECAPTCHA: 'LEAD_CREATION_RECAPTCHA',
187
193
  DOMAIN_TRANSFER_HOLDER_CHANGE_FORM_SE_NU: 'DOMAIN_TRANSFER_HOLDER_CHANGE_FORM_SE_NU',
194
+ BROKER_PROGRAM: 'BROKER_PROGRAM',
188
195
  DOMAIN_APPRAISAL: 'DOMAIN_APPRAISAL',
189
196
  BANK_ACCOUNT_NAME_CHECK: 'BANK_ACCOUNT_NAME_CHECK',
190
197
  MFA_ENFORCED_FOR_STAFF: 'MFA_ENFORCED_FOR_STAFF',
@@ -207,6 +214,7 @@ export function instanceOfIntersectionAccountDtoWithSettingsDtoWithNotifications
207
214
  if (!('leaseToOwnKickbackPercentage' in value) || value['leaseToOwnKickbackPercentage'] === undefined) return false;
208
215
  if (!('challengeRewardBalance' in value) || value['challengeRewardBalance'] === undefined) return false;
209
216
  if (!('canSell' in value) || value['canSell'] === undefined) return false;
217
+ if (!('canBroker' in value) || value['canBroker'] === undefined) return false;
210
218
  if (!('settings' in value) || value['settings'] === undefined) return false;
211
219
  if (!('notifications' in value) || value['notifications'] === undefined) return false;
212
220
  if (!('enabledFeatures' in value) || value['enabledFeatures'] === undefined) return false;
@@ -233,6 +241,7 @@ export function IntersectionAccountDtoWithSettingsDtoWithNotificationsDtoWithFea
233
241
  'leaseToOwnKickbackPercentage': json['leaseToOwnKickbackPercentage'],
234
242
  'challengeRewardBalance': ChallengeRewardBalanceDtoFromJSON(json['challengeRewardBalance']),
235
243
  'canSell': json['canSell'],
244
+ 'canBroker': json['canBroker'],
236
245
  'settings': WithSettingsInnerFromJSON(json['settings']),
237
246
  'notifications': ((json['notifications'] as Array<any>).map(AccountNotificationDtoFromJSON)),
238
247
  'enabledFeatures': json['enabledFeatures'],
@@ -260,6 +269,7 @@ export function IntersectionAccountDtoWithSettingsDtoWithNotificationsDtoWithFea
260
269
  'leaseToOwnKickbackPercentage': value['leaseToOwnKickbackPercentage'],
261
270
  'challengeRewardBalance': ChallengeRewardBalanceDtoToJSON(value['challengeRewardBalance']),
262
271
  'canSell': value['canSell'],
272
+ 'canBroker': value['canBroker'],
263
273
  'settings': WithSettingsInnerToJSON(value['settings']),
264
274
  'notifications': ((value['notifications'] as Array<any>).map(AccountNotificationDtoToJSON)),
265
275
  'enabledFeatures': value['enabledFeatures'],
@@ -275,7 +275,7 @@ export interface IntersectionDomainDtoWithHijackerDtoWithAccountDto {
275
275
  */
276
276
  leadVerification: LeadVerificationSettingsDto;
277
277
  /**
278
- * Account managing the domain on behalf of the owner, when a hijacker is assigned.
278
+ * Always null. Whether another account claims the domain is told by `hijackerId`; that account itself is not shown.
279
279
  * @type {AccountDto}
280
280
  * @memberof IntersectionDomainDtoWithHijackerDtoWithAccountDto
281
281
  */
@@ -121,6 +121,12 @@ export interface InvoiceDto {
121
121
  * @memberof InvoiceDto
122
122
  */
123
123
  isAffiliateCommission: boolean;
124
+ /**
125
+ * Whether this is the invoice a broker issues for a brokered sale commission.
126
+ * @type {boolean}
127
+ * @memberof InvoiceDto
128
+ */
129
+ isBrokerCommission: boolean;
124
130
  /**
125
131
  * Buyer email (only for buyer-target invoices).
126
132
  * @type {string}
@@ -185,6 +191,7 @@ export function instanceOfInvoiceDto(value: object): value is InvoiceDto {
185
191
  if (!('parent' in value) || value['parent'] === undefined) return false;
186
192
  if (!('hasChildren' in value) || value['hasChildren'] === undefined) return false;
187
193
  if (!('isAffiliateCommission' in value) || value['isAffiliateCommission'] === undefined) return false;
194
+ if (!('isBrokerCommission' in value) || value['isBrokerCommission'] === undefined) return false;
188
195
  if (!('buyerEmail' in value) || value['buyerEmail'] === undefined) return false;
189
196
  if (!('transaction' in value) || value['transaction'] === undefined) return false;
190
197
  if (!('payoutDueAt' in value) || value['payoutDueAt'] === undefined) return false;
@@ -213,6 +220,7 @@ export function InvoiceDtoFromJSONTyped(json: any, ignoreDiscriminator: boolean)
213
220
  'parent': json['parent'],
214
221
  'hasChildren': json['hasChildren'],
215
222
  'isAffiliateCommission': json['isAffiliateCommission'],
223
+ 'isBrokerCommission': json['isBrokerCommission'],
216
224
  'buyerEmail': json['buyerEmail'],
217
225
  'transaction': InvoiceDtoTransactionFromJSON(json['transaction']),
218
226
  'payoutDueAt': (json['payoutDueAt'] == null ? null : new Date(json['payoutDueAt'])),
@@ -242,6 +250,7 @@ export function InvoiceDtoToJSONTyped(value?: InvoiceDto | null, ignoreDiscrimin
242
250
  'parent': value['parent'],
243
251
  'hasChildren': value['hasChildren'],
244
252
  'isAffiliateCommission': value['isAffiliateCommission'],
253
+ 'isBrokerCommission': value['isBrokerCommission'],
245
254
  'buyerEmail': value['buyerEmail'],
246
255
  'transaction': InvoiceDtoTransactionToJSON(value['transaction']),
247
256
  'payoutDueAt': (value['payoutDueAt'] == null ? null : (value['payoutDueAt'] as any).toISOString()),
@@ -0,0 +1,83 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Nameshift
5
+ * 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.
6
+ *
7
+ * The version of the OpenAPI document: 1.0
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+ import { mapValues } from '../runtime';
16
+ import type { BrokeredLeadBreakdownDto } from './BrokeredLeadBreakdownDto';
17
+ import {
18
+ BrokeredLeadBreakdownDtoFromJSON,
19
+ BrokeredLeadBreakdownDtoFromJSONTyped,
20
+ BrokeredLeadBreakdownDtoToJSON,
21
+ BrokeredLeadBreakdownDtoToJSONTyped,
22
+ } from './BrokeredLeadBreakdownDto';
23
+
24
+ /**
25
+ *
26
+ * @export
27
+ * @interface LeadBrokeredDealDto
28
+ */
29
+ export interface LeadBrokeredDealDto {
30
+ /**
31
+ * Name of the broker who brought the deal.
32
+ * @type {string}
33
+ * @memberof LeadBrokeredDealDto
34
+ */
35
+ brokerName: string;
36
+ /**
37
+ *
38
+ * @type {BrokeredLeadBreakdownDto}
39
+ * @memberof LeadBrokeredDealDto
40
+ */
41
+ breakdown: BrokeredLeadBreakdownDto;
42
+ }
43
+
44
+ /**
45
+ * Check if a given object implements the LeadBrokeredDealDto interface.
46
+ */
47
+ export function instanceOfLeadBrokeredDealDto(value: object): value is LeadBrokeredDealDto {
48
+ if (!('brokerName' in value) || value['brokerName'] === undefined) return false;
49
+ if (!('breakdown' in value) || value['breakdown'] === undefined) return false;
50
+ return true;
51
+ }
52
+
53
+ export function LeadBrokeredDealDtoFromJSON(json: any): LeadBrokeredDealDto {
54
+ return LeadBrokeredDealDtoFromJSONTyped(json, false);
55
+ }
56
+
57
+ export function LeadBrokeredDealDtoFromJSONTyped(json: any, ignoreDiscriminator: boolean): LeadBrokeredDealDto {
58
+ if (json == null) {
59
+ return json;
60
+ }
61
+ return {
62
+
63
+ 'brokerName': json['brokerName'],
64
+ 'breakdown': BrokeredLeadBreakdownDtoFromJSON(json['breakdown']),
65
+ };
66
+ }
67
+
68
+ export function LeadBrokeredDealDtoToJSON(json: any): LeadBrokeredDealDto {
69
+ return LeadBrokeredDealDtoToJSONTyped(json, false);
70
+ }
71
+
72
+ export function LeadBrokeredDealDtoToJSONTyped(value?: LeadBrokeredDealDto | null, ignoreDiscriminator: boolean = false): any {
73
+ if (value == null) {
74
+ return value;
75
+ }
76
+
77
+ return {
78
+
79
+ 'brokerName': value['brokerName'],
80
+ 'breakdown': BrokeredLeadBreakdownDtoToJSON(value['breakdown']),
81
+ };
82
+ }
83
+
@@ -0,0 +1,106 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Nameshift
5
+ * 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.
6
+ *
7
+ * The version of the OpenAPI document: 1.0
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+ import { mapValues } from '../runtime';
16
+ import type { PaginateResponseLinks } from './PaginateResponseLinks';
17
+ import {
18
+ PaginateResponseLinksFromJSON,
19
+ PaginateResponseLinksFromJSONTyped,
20
+ PaginateResponseLinksToJSON,
21
+ PaginateResponseLinksToJSONTyped,
22
+ } from './PaginateResponseLinks';
23
+ import type { BrokerBrokeredLeadDto } from './BrokerBrokeredLeadDto';
24
+ import {
25
+ BrokerBrokeredLeadDtoFromJSON,
26
+ BrokerBrokeredLeadDtoFromJSONTyped,
27
+ BrokerBrokeredLeadDtoToJSON,
28
+ BrokerBrokeredLeadDtoToJSONTyped,
29
+ } from './BrokerBrokeredLeadDto';
30
+ import type { PaginateResponseMeta } from './PaginateResponseMeta';
31
+ import {
32
+ PaginateResponseMetaFromJSON,
33
+ PaginateResponseMetaFromJSONTyped,
34
+ PaginateResponseMetaToJSON,
35
+ PaginateResponseMetaToJSONTyped,
36
+ } from './PaginateResponseMeta';
37
+
38
+ /**
39
+ *
40
+ * @export
41
+ * @interface ListBrokerLeads200Response
42
+ */
43
+ export interface ListBrokerLeads200Response {
44
+ /**
45
+ *
46
+ * @type {Array<BrokerBrokeredLeadDto>}
47
+ * @memberof ListBrokerLeads200Response
48
+ */
49
+ data: Array<BrokerBrokeredLeadDto>;
50
+ /**
51
+ *
52
+ * @type {PaginateResponseMeta}
53
+ * @memberof ListBrokerLeads200Response
54
+ */
55
+ meta: PaginateResponseMeta;
56
+ /**
57
+ *
58
+ * @type {PaginateResponseLinks}
59
+ * @memberof ListBrokerLeads200Response
60
+ */
61
+ links: PaginateResponseLinks;
62
+ }
63
+
64
+ /**
65
+ * Check if a given object implements the ListBrokerLeads200Response interface.
66
+ */
67
+ export function instanceOfListBrokerLeads200Response(value: object): value is ListBrokerLeads200Response {
68
+ if (!('data' in value) || value['data'] === undefined) return false;
69
+ if (!('meta' in value) || value['meta'] === undefined) return false;
70
+ if (!('links' in value) || value['links'] === undefined) return false;
71
+ return true;
72
+ }
73
+
74
+ export function ListBrokerLeads200ResponseFromJSON(json: any): ListBrokerLeads200Response {
75
+ return ListBrokerLeads200ResponseFromJSONTyped(json, false);
76
+ }
77
+
78
+ export function ListBrokerLeads200ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ListBrokerLeads200Response {
79
+ if (json == null) {
80
+ return json;
81
+ }
82
+ return {
83
+
84
+ 'data': ((json['data'] as Array<any>).map(BrokerBrokeredLeadDtoFromJSON)),
85
+ 'meta': PaginateResponseMetaFromJSON(json['meta']),
86
+ 'links': PaginateResponseLinksFromJSON(json['links']),
87
+ };
88
+ }
89
+
90
+ export function ListBrokerLeads200ResponseToJSON(json: any): ListBrokerLeads200Response {
91
+ return ListBrokerLeads200ResponseToJSONTyped(json, false);
92
+ }
93
+
94
+ export function ListBrokerLeads200ResponseToJSONTyped(value?: ListBrokerLeads200Response | null, ignoreDiscriminator: boolean = false): any {
95
+ if (value == null) {
96
+ return value;
97
+ }
98
+
99
+ return {
100
+
101
+ 'data': ((value['data'] as Array<any>).map(BrokerBrokeredLeadDtoToJSON)),
102
+ 'meta': PaginateResponseMetaToJSON(value['meta']),
103
+ 'links': PaginateResponseLinksToJSON(value['links']),
104
+ };
105
+ }
106
+
@@ -27,6 +27,13 @@ import {
27
27
  LeadMessageDataToJSON,
28
28
  LeadMessageDataToJSONTyped,
29
29
  } from './LeadMessageData';
30
+ import type { LeadBrokeredDealDto } from './LeadBrokeredDealDto';
31
+ import {
32
+ LeadBrokeredDealDtoFromJSON,
33
+ LeadBrokeredDealDtoFromJSONTyped,
34
+ LeadBrokeredDealDtoToJSON,
35
+ LeadBrokeredDealDtoToJSONTyped,
36
+ } from './LeadBrokeredDealDto';
30
37
  import type { LeadDomainDto } from './LeadDomainDto';
31
38
  import {
32
39
  LeadDomainDtoFromJSON,
@@ -261,6 +268,12 @@ export interface ListLeadsResultItem {
261
268
  * @memberof ListLeadsResultItem
262
269
  */
263
270
  isMutedForSeller: boolean;
271
+ /**
272
+ * The broker deal the lead comes from, if any.
273
+ * @type {LeadBrokeredDealDto}
274
+ * @memberof ListLeadsResultItem
275
+ */
276
+ brokeredDeal: LeadBrokeredDealDto | null;
264
277
  }
265
278
 
266
279
 
@@ -371,6 +384,7 @@ export function instanceOfListLeadsResultItem(value: object): value is ListLeads
371
384
  if (!('lastMessageData' in value) || value['lastMessageData'] === undefined) return false;
372
385
  if (!('lastMessageDate' in value) || value['lastMessageDate'] === undefined) return false;
373
386
  if (!('isMutedForSeller' in value) || value['isMutedForSeller'] === undefined) return false;
387
+ if (!('brokeredDeal' in value) || value['brokeredDeal'] === undefined) return false;
374
388
  return true;
375
389
  }
376
390
 
@@ -416,6 +430,7 @@ export function ListLeadsResultItemFromJSONTyped(json: any, ignoreDiscriminator:
416
430
  'lastMessageData': LeadMessageDataFromJSON(json['lastMessageData']),
417
431
  'lastMessageDate': (new Date(json['lastMessageDate'])),
418
432
  'isMutedForSeller': json['isMutedForSeller'],
433
+ 'brokeredDeal': LeadBrokeredDealDtoFromJSON(json['brokeredDeal']),
419
434
  };
420
435
  }
421
436
 
@@ -462,6 +477,7 @@ export function ListLeadsResultItemToJSONTyped(value?: ListLeadsResultItem | nul
462
477
  'lastMessageData': LeadMessageDataToJSON(value['lastMessageData']),
463
478
  'lastMessageDate': ((value['lastMessageDate']).toISOString()),
464
479
  'isMutedForSeller': value['isMutedForSeller'],
480
+ 'brokeredDeal': LeadBrokeredDealDtoToJSON(value['brokeredDeal']),
465
481
  };
466
482
  }
467
483
 
@@ -13,6 +13,13 @@
13
13
  */
14
14
 
15
15
  import { mapValues } from '../runtime';
16
+ import type { LeadBrokeredDealDto } from './LeadBrokeredDealDto';
17
+ import {
18
+ LeadBrokeredDealDtoFromJSON,
19
+ LeadBrokeredDealDtoFromJSONTyped,
20
+ LeadBrokeredDealDtoToJSON,
21
+ LeadBrokeredDealDtoToJSONTyped,
22
+ } from './LeadBrokeredDealDto';
16
23
  import type { ManualLeadBuyerDto } from './ManualLeadBuyerDto';
17
24
  import {
18
25
  ManualLeadBuyerDtoFromJSON,
@@ -232,6 +239,12 @@ export interface ManualLeadDetails {
232
239
  * @memberof ManualLeadDetails
233
240
  */
234
241
  domainLockConfiguration: DomainLockConfigurationDto;
242
+ /**
243
+ * The broker deal the lead comes from, if any.
244
+ * @type {LeadBrokeredDealDto}
245
+ * @memberof ManualLeadDetails
246
+ */
247
+ brokeredDeal: LeadBrokeredDealDto | null;
235
248
  }
236
249
 
237
250
 
@@ -312,6 +325,7 @@ export function instanceOfManualLeadDetails(value: object): value is ManualLeadD
312
325
  if (!('awaitingSellerFirstMessage' in value) || value['awaitingSellerFirstMessage'] === undefined) return false;
313
326
  if (!('buyer' in value) || value['buyer'] === undefined) return false;
314
327
  if (!('domainLockConfiguration' in value) || value['domainLockConfiguration'] === undefined) return false;
328
+ if (!('brokeredDeal' in value) || value['brokeredDeal'] === undefined) return false;
315
329
  return true;
316
330
  }
317
331
 
@@ -351,6 +365,7 @@ export function ManualLeadDetailsFromJSONTyped(json: any, ignoreDiscriminator: b
351
365
  'awaitingSellerFirstMessage': json['awaitingSellerFirstMessage'],
352
366
  'buyer': ManualLeadBuyerDtoFromJSON(json['buyer']),
353
367
  'domainLockConfiguration': DomainLockConfigurationDtoFromJSON(json['domainLockConfiguration']),
368
+ 'brokeredDeal': LeadBrokeredDealDtoFromJSON(json['brokeredDeal']),
354
369
  };
355
370
  }
356
371
 
@@ -391,6 +406,7 @@ export function ManualLeadDetailsToJSONTyped(value?: ManualLeadDetails | null, i
391
406
  'awaitingSellerFirstMessage': value['awaitingSellerFirstMessage'],
392
407
  'buyer': ManualLeadBuyerDtoToJSON(value['buyer']),
393
408
  'domainLockConfiguration': DomainLockConfigurationDtoToJSON(value['domainLockConfiguration']),
409
+ 'brokeredDeal': LeadBrokeredDealDtoToJSON(value['brokeredDeal']),
394
410
  };
395
411
  }
396
412
 
@@ -0,0 +1,75 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Nameshift
5
+ * 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.
6
+ *
7
+ * The version of the OpenAPI document: 1.0
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+ import { mapValues } from '../runtime';
16
+ /**
17
+ *
18
+ * @export
19
+ * @interface OverrideBrokeredLeadNameshiftCommissionInput
20
+ */
21
+ export interface OverrideBrokeredLeadNameshiftCommissionInput {
22
+ /**
23
+ * Platform fee charged to the broker, as a percentage of the sale price.
24
+ * @type {number}
25
+ * @memberof OverrideBrokeredLeadNameshiftCommissionInput
26
+ */
27
+ percentage: number;
28
+ /**
29
+ * Why this deal gets a custom fee; kept with the deal.
30
+ * @type {string}
31
+ * @memberof OverrideBrokeredLeadNameshiftCommissionInput
32
+ */
33
+ reason: string;
34
+ }
35
+
36
+ /**
37
+ * Check if a given object implements the OverrideBrokeredLeadNameshiftCommissionInput interface.
38
+ */
39
+ export function instanceOfOverrideBrokeredLeadNameshiftCommissionInput(value: object): value is OverrideBrokeredLeadNameshiftCommissionInput {
40
+ if (!('percentage' in value) || value['percentage'] === undefined) return false;
41
+ if (!('reason' in value) || value['reason'] === undefined) return false;
42
+ return true;
43
+ }
44
+
45
+ export function OverrideBrokeredLeadNameshiftCommissionInputFromJSON(json: any): OverrideBrokeredLeadNameshiftCommissionInput {
46
+ return OverrideBrokeredLeadNameshiftCommissionInputFromJSONTyped(json, false);
47
+ }
48
+
49
+ export function OverrideBrokeredLeadNameshiftCommissionInputFromJSONTyped(json: any, ignoreDiscriminator: boolean): OverrideBrokeredLeadNameshiftCommissionInput {
50
+ if (json == null) {
51
+ return json;
52
+ }
53
+ return {
54
+
55
+ 'percentage': json['percentage'],
56
+ 'reason': json['reason'],
57
+ };
58
+ }
59
+
60
+ export function OverrideBrokeredLeadNameshiftCommissionInputToJSON(json: any): OverrideBrokeredLeadNameshiftCommissionInput {
61
+ return OverrideBrokeredLeadNameshiftCommissionInputToJSONTyped(json, false);
62
+ }
63
+
64
+ export function OverrideBrokeredLeadNameshiftCommissionInputToJSONTyped(value?: OverrideBrokeredLeadNameshiftCommissionInput | null, ignoreDiscriminator: boolean = false): any {
65
+ if (value == null) {
66
+ return value;
67
+ }
68
+
69
+ return {
70
+
71
+ 'percentage': value['percentage'],
72
+ 'reason': value['reason'],
73
+ };
74
+ }
75
+
@@ -129,6 +129,12 @@ export interface PrivateAccountGetMeResponse {
129
129
  * @memberof PrivateAccountGetMeResponse
130
130
  */
131
131
  canSell: boolean;
132
+ /**
133
+ * Whether the account can bring in brokered deals: brokerage is switched on and the account is verified.
134
+ * @type {boolean}
135
+ * @memberof PrivateAccountGetMeResponse
136
+ */
137
+ canBroker: boolean;
132
138
  /**
133
139
  * Account settings.
134
140
  * @type {WithSettingsInner}
@@ -153,6 +159,12 @@ export interface PrivateAccountGetMeResponse {
153
159
  * @memberof PrivateAccountGetMeResponse
154
160
  */
155
161
  unreadNotificationsNumber: number;
162
+ /**
163
+ * Whether the account brought in deals as a broker. Their deals stay reachable after brokerage is switched off.
164
+ * @type {boolean}
165
+ * @memberof PrivateAccountGetMeResponse
166
+ */
167
+ hasBrokerLeads: boolean;
156
168
  }
157
169
 
158
170
 
@@ -191,6 +203,7 @@ export const PrivateAccountGetMeResponseEnabledFeaturesEnum = {
191
203
  LEAD_ENRICHMENT: 'LEAD_ENRICHMENT',
192
204
  LEAD_CREATION_RECAPTCHA: 'LEAD_CREATION_RECAPTCHA',
193
205
  DOMAIN_TRANSFER_HOLDER_CHANGE_FORM_SE_NU: 'DOMAIN_TRANSFER_HOLDER_CHANGE_FORM_SE_NU',
206
+ BROKER_PROGRAM: 'BROKER_PROGRAM',
194
207
  DOMAIN_APPRAISAL: 'DOMAIN_APPRAISAL',
195
208
  BANK_ACCOUNT_NAME_CHECK: 'BANK_ACCOUNT_NAME_CHECK',
196
209
  MFA_ENFORCED_FOR_STAFF: 'MFA_ENFORCED_FOR_STAFF',
@@ -213,10 +226,12 @@ export function instanceOfPrivateAccountGetMeResponse(value: object): value is P
213
226
  if (!('leaseToOwnKickbackPercentage' in value) || value['leaseToOwnKickbackPercentage'] === undefined) return false;
214
227
  if (!('challengeRewardBalance' in value) || value['challengeRewardBalance'] === undefined) return false;
215
228
  if (!('canSell' in value) || value['canSell'] === undefined) return false;
229
+ if (!('canBroker' in value) || value['canBroker'] === undefined) return false;
216
230
  if (!('settings' in value) || value['settings'] === undefined) return false;
217
231
  if (!('notifications' in value) || value['notifications'] === undefined) return false;
218
232
  if (!('enabledFeatures' in value) || value['enabledFeatures'] === undefined) return false;
219
233
  if (!('unreadNotificationsNumber' in value) || value['unreadNotificationsNumber'] === undefined) return false;
234
+ if (!('hasBrokerLeads' in value) || value['hasBrokerLeads'] === undefined) return false;
220
235
  return true;
221
236
  }
222
237
 
@@ -240,10 +255,12 @@ export function PrivateAccountGetMeResponseFromJSONTyped(json: any, ignoreDiscri
240
255
  'leaseToOwnKickbackPercentage': json['leaseToOwnKickbackPercentage'],
241
256
  'challengeRewardBalance': ChallengeRewardBalanceDtoFromJSON(json['challengeRewardBalance']),
242
257
  'canSell': json['canSell'],
258
+ 'canBroker': json['canBroker'],
243
259
  'settings': WithSettingsInnerFromJSON(json['settings']),
244
260
  'notifications': ((json['notifications'] as Array<any>).map(AccountNotificationDtoFromJSON)),
245
261
  'enabledFeatures': json['enabledFeatures'],
246
262
  'unreadNotificationsNumber': json['unreadNotificationsNumber'],
263
+ 'hasBrokerLeads': json['hasBrokerLeads'],
247
264
  };
248
265
  }
249
266
 
@@ -268,10 +285,12 @@ export function PrivateAccountGetMeResponseToJSONTyped(value?: PrivateAccountGet
268
285
  'leaseToOwnKickbackPercentage': value['leaseToOwnKickbackPercentage'],
269
286
  'challengeRewardBalance': ChallengeRewardBalanceDtoToJSON(value['challengeRewardBalance']),
270
287
  'canSell': value['canSell'],
288
+ 'canBroker': value['canBroker'],
271
289
  'settings': WithSettingsInnerToJSON(value['settings']),
272
290
  'notifications': ((value['notifications'] as Array<any>).map(AccountNotificationDtoToJSON)),
273
291
  'enabledFeatures': value['enabledFeatures'],
274
292
  'unreadNotificationsNumber': value['unreadNotificationsNumber'],
293
+ 'hasBrokerLeads': value['hasBrokerLeads'],
275
294
  };
276
295
  }
277
296
 
@@ -99,6 +99,12 @@ export interface RegisterAccountInput {
99
99
  * @memberof RegisterAccountInput
100
100
  */
101
101
  portfolioSize?: RegisterAccountPortfolioSizeInput | null;
102
+ /**
103
+ * Token from the signup link a broker shares with a seller. The domain of the brokered deal is added to the new account, and the deal waits there for review.
104
+ * @type {string}
105
+ * @memberof RegisterAccountInput
106
+ */
107
+ brokeredLeadToken?: string | null;
102
108
  }
103
109
 
104
110
 
@@ -147,6 +153,7 @@ export function RegisterAccountInputFromJSONTyped(json: any, ignoreDiscriminator
147
153
  'affiliateIdentifier': json['affiliateIdentifier'] == null ? undefined : json['affiliateIdentifier'],
148
154
  'companyName': json['companyName'] == null ? undefined : json['companyName'],
149
155
  'portfolioSize': json['portfolioSize'] == null ? undefined : RegisterAccountPortfolioSizeInputFromJSON(json['portfolioSize']),
156
+ 'brokeredLeadToken': json['brokeredLeadToken'] == null ? undefined : json['brokeredLeadToken'],
150
157
  };
151
158
  }
152
159
 
@@ -173,6 +180,7 @@ export function RegisterAccountInputToJSONTyped(value?: RegisterAccountInput | n
173
180
  'affiliateIdentifier': value['affiliateIdentifier'],
174
181
  'companyName': value['companyName'],
175
182
  'portfolioSize': RegisterAccountPortfolioSizeInputToJSON(value['portfolioSize']),
183
+ 'brokeredLeadToken': value['brokeredLeadToken'],
176
184
  };
177
185
  }
178
186