@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,215 @@
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
+ import type { BrokeredLeadCommissionDto } from './BrokeredLeadCommissionDto';
24
+ import {
25
+ BrokeredLeadCommissionDtoFromJSON,
26
+ BrokeredLeadCommissionDtoFromJSONTyped,
27
+ BrokeredLeadCommissionDtoToJSON,
28
+ BrokeredLeadCommissionDtoToJSONTyped,
29
+ } from './BrokeredLeadCommissionDto';
30
+ import type { MoneyDto } from './MoneyDto';
31
+ import {
32
+ MoneyDtoFromJSON,
33
+ MoneyDtoFromJSONTyped,
34
+ MoneyDtoToJSON,
35
+ MoneyDtoToJSONTyped,
36
+ } from './MoneyDto';
37
+ import type { SellerBrokeredLeadVerificationDto } from './SellerBrokeredLeadVerificationDto';
38
+ import {
39
+ SellerBrokeredLeadVerificationDtoFromJSON,
40
+ SellerBrokeredLeadVerificationDtoFromJSONTyped,
41
+ SellerBrokeredLeadVerificationDtoToJSON,
42
+ SellerBrokeredLeadVerificationDtoToJSONTyped,
43
+ } from './SellerBrokeredLeadVerificationDto';
44
+ import type { MoneyDecimalDto } from './MoneyDecimalDto';
45
+ import {
46
+ MoneyDecimalDtoFromJSON,
47
+ MoneyDecimalDtoFromJSONTyped,
48
+ MoneyDecimalDtoToJSON,
49
+ MoneyDecimalDtoToJSONTyped,
50
+ } from './MoneyDecimalDto';
51
+
52
+ /**
53
+ *
54
+ * @export
55
+ * @interface SellerBrokeredLeadDto
56
+ */
57
+ export interface SellerBrokeredLeadDto {
58
+ /**
59
+ *
60
+ * @type {string}
61
+ * @memberof SellerBrokeredLeadDto
62
+ */
63
+ id: string;
64
+ /**
65
+ *
66
+ * @type {string}
67
+ * @memberof SellerBrokeredLeadDto
68
+ */
69
+ domainName: string;
70
+ /**
71
+ *
72
+ * @type {string}
73
+ * @memberof SellerBrokeredLeadDto
74
+ */
75
+ status: SellerBrokeredLeadDtoStatusEnum;
76
+ /**
77
+ * Name of the broker who brought the deal.
78
+ * @type {string}
79
+ * @memberof SellerBrokeredLeadDto
80
+ */
81
+ brokerName: string;
82
+ /**
83
+ *
84
+ * @type {MoneyDto}
85
+ * @memberof SellerBrokeredLeadDto
86
+ */
87
+ askingPrice: MoneyDto;
88
+ /**
89
+ *
90
+ * @type {BrokeredLeadCommissionDto}
91
+ * @memberof SellerBrokeredLeadDto
92
+ */
93
+ commission: BrokeredLeadCommissionDto;
94
+ /**
95
+ * The sale price less the broker commission charged to the seller. Nameshift charges no commission on a brokered sale.
96
+ * @type {MoneyDecimalDto}
97
+ * @memberof SellerBrokeredLeadDto
98
+ */
99
+ sellerProceeds: MoneyDecimalDto;
100
+ /**
101
+ *
102
+ * @type {BrokeredLeadBreakdownDto}
103
+ * @memberof SellerBrokeredLeadDto
104
+ */
105
+ breakdown: BrokeredLeadBreakdownDto;
106
+ /**
107
+ *
108
+ * @type {SellerBrokeredLeadVerificationDto}
109
+ * @memberof SellerBrokeredLeadDto
110
+ */
111
+ verification: SellerBrokeredLeadVerificationDto;
112
+ /**
113
+ *
114
+ * @type {string}
115
+ * @memberof SellerBrokeredLeadDto
116
+ */
117
+ declineReason: string | null;
118
+ /**
119
+ *
120
+ * @type {Date}
121
+ * @memberof SellerBrokeredLeadDto
122
+ */
123
+ createdAt: Date;
124
+ /**
125
+ *
126
+ * @type {Date}
127
+ * @memberof SellerBrokeredLeadDto
128
+ */
129
+ approvedAt: Date | null;
130
+ }
131
+
132
+
133
+ /**
134
+ * @export
135
+ */
136
+ export const SellerBrokeredLeadDtoStatusEnum = {
137
+ PENDING_SELLER: 'pending_seller',
138
+ PENDING_SELLER_VERIFICATION: 'pending_seller_verification',
139
+ APPROVED: 'approved',
140
+ DECLINED: 'declined',
141
+ CANCELLED: 'cancelled'
142
+ } as const;
143
+ export type SellerBrokeredLeadDtoStatusEnum = typeof SellerBrokeredLeadDtoStatusEnum[keyof typeof SellerBrokeredLeadDtoStatusEnum];
144
+
145
+
146
+ /**
147
+ * Check if a given object implements the SellerBrokeredLeadDto interface.
148
+ */
149
+ export function instanceOfSellerBrokeredLeadDto(value: object): value is SellerBrokeredLeadDto {
150
+ if (!('id' in value) || value['id'] === undefined) return false;
151
+ if (!('domainName' in value) || value['domainName'] === undefined) return false;
152
+ if (!('status' in value) || value['status'] === undefined) return false;
153
+ if (!('brokerName' in value) || value['brokerName'] === undefined) return false;
154
+ if (!('askingPrice' in value) || value['askingPrice'] === undefined) return false;
155
+ if (!('commission' in value) || value['commission'] === undefined) return false;
156
+ if (!('sellerProceeds' in value) || value['sellerProceeds'] === undefined) return false;
157
+ if (!('breakdown' in value) || value['breakdown'] === undefined) return false;
158
+ if (!('verification' in value) || value['verification'] === undefined) return false;
159
+ if (!('declineReason' in value) || value['declineReason'] === undefined) return false;
160
+ if (!('createdAt' in value) || value['createdAt'] === undefined) return false;
161
+ if (!('approvedAt' in value) || value['approvedAt'] === undefined) return false;
162
+ return true;
163
+ }
164
+
165
+ export function SellerBrokeredLeadDtoFromJSON(json: any): SellerBrokeredLeadDto {
166
+ return SellerBrokeredLeadDtoFromJSONTyped(json, false);
167
+ }
168
+
169
+ export function SellerBrokeredLeadDtoFromJSONTyped(json: any, ignoreDiscriminator: boolean): SellerBrokeredLeadDto {
170
+ if (json == null) {
171
+ return json;
172
+ }
173
+ return {
174
+
175
+ 'id': json['id'],
176
+ 'domainName': json['domainName'],
177
+ 'status': json['status'],
178
+ 'brokerName': json['brokerName'],
179
+ 'askingPrice': MoneyDtoFromJSON(json['askingPrice']),
180
+ 'commission': BrokeredLeadCommissionDtoFromJSON(json['commission']),
181
+ 'sellerProceeds': MoneyDecimalDtoFromJSON(json['sellerProceeds']),
182
+ 'breakdown': BrokeredLeadBreakdownDtoFromJSON(json['breakdown']),
183
+ 'verification': SellerBrokeredLeadVerificationDtoFromJSON(json['verification']),
184
+ 'declineReason': json['declineReason'],
185
+ 'createdAt': (new Date(json['createdAt'])),
186
+ 'approvedAt': (json['approvedAt'] == null ? null : new Date(json['approvedAt'])),
187
+ };
188
+ }
189
+
190
+ export function SellerBrokeredLeadDtoToJSON(json: any): SellerBrokeredLeadDto {
191
+ return SellerBrokeredLeadDtoToJSONTyped(json, false);
192
+ }
193
+
194
+ export function SellerBrokeredLeadDtoToJSONTyped(value?: SellerBrokeredLeadDto | null, ignoreDiscriminator: boolean = false): any {
195
+ if (value == null) {
196
+ return value;
197
+ }
198
+
199
+ return {
200
+
201
+ 'id': value['id'],
202
+ 'domainName': value['domainName'],
203
+ 'status': value['status'],
204
+ 'brokerName': value['brokerName'],
205
+ 'askingPrice': MoneyDtoToJSON(value['askingPrice']),
206
+ 'commission': BrokeredLeadCommissionDtoToJSON(value['commission']),
207
+ 'sellerProceeds': MoneyDecimalDtoToJSON(value['sellerProceeds']),
208
+ 'breakdown': BrokeredLeadBreakdownDtoToJSON(value['breakdown']),
209
+ 'verification': SellerBrokeredLeadVerificationDtoToJSON(value['verification']),
210
+ 'declineReason': value['declineReason'],
211
+ 'createdAt': ((value['createdAt']).toISOString()),
212
+ 'approvedAt': (value['approvedAt'] == null ? null : (value['approvedAt'] as any).toISOString()),
213
+ };
214
+ }
215
+
@@ -0,0 +1,84 @@
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 SellerBrokeredLeadVerificationDto
20
+ */
21
+ export interface SellerBrokeredLeadVerificationDto {
22
+ /**
23
+ * The domain, once it is in the account.
24
+ * @type {string}
25
+ * @memberof SellerBrokeredLeadVerificationDto
26
+ */
27
+ domainId: string | null;
28
+ /**
29
+ * Whether the domain is verified as the account’s.
30
+ * @type {boolean}
31
+ * @memberof SellerBrokeredLeadVerificationDto
32
+ */
33
+ domainVerified: boolean;
34
+ /**
35
+ * Whether the account is verified and has its billing details complete.
36
+ * @type {boolean}
37
+ * @memberof SellerBrokeredLeadVerificationDto
38
+ */
39
+ accountVerified: boolean;
40
+ }
41
+
42
+ /**
43
+ * Check if a given object implements the SellerBrokeredLeadVerificationDto interface.
44
+ */
45
+ export function instanceOfSellerBrokeredLeadVerificationDto(value: object): value is SellerBrokeredLeadVerificationDto {
46
+ if (!('domainId' in value) || value['domainId'] === undefined) return false;
47
+ if (!('domainVerified' in value) || value['domainVerified'] === undefined) return false;
48
+ if (!('accountVerified' in value) || value['accountVerified'] === undefined) return false;
49
+ return true;
50
+ }
51
+
52
+ export function SellerBrokeredLeadVerificationDtoFromJSON(json: any): SellerBrokeredLeadVerificationDto {
53
+ return SellerBrokeredLeadVerificationDtoFromJSONTyped(json, false);
54
+ }
55
+
56
+ export function SellerBrokeredLeadVerificationDtoFromJSONTyped(json: any, ignoreDiscriminator: boolean): SellerBrokeredLeadVerificationDto {
57
+ if (json == null) {
58
+ return json;
59
+ }
60
+ return {
61
+
62
+ 'domainId': json['domainId'],
63
+ 'domainVerified': json['domainVerified'],
64
+ 'accountVerified': json['accountVerified'],
65
+ };
66
+ }
67
+
68
+ export function SellerBrokeredLeadVerificationDtoToJSON(json: any): SellerBrokeredLeadVerificationDto {
69
+ return SellerBrokeredLeadVerificationDtoToJSONTyped(json, false);
70
+ }
71
+
72
+ export function SellerBrokeredLeadVerificationDtoToJSONTyped(value?: SellerBrokeredLeadVerificationDto | null, ignoreDiscriminator: boolean = false): any {
73
+ if (value == null) {
74
+ return value;
75
+ }
76
+
77
+ return {
78
+
79
+ 'domainId': value['domainId'],
80
+ 'domainVerified': value['domainVerified'],
81
+ 'accountVerified': value['accountVerified'],
82
+ };
83
+ }
84
+
@@ -114,6 +114,12 @@ export interface SellerInvoiceDto {
114
114
  * @memberof SellerInvoiceDto
115
115
  */
116
116
  isAffiliateCommission: boolean;
117
+ /**
118
+ * Whether this is the invoice a broker issues for a brokered sale commission.
119
+ * @type {boolean}
120
+ * @memberof SellerInvoiceDto
121
+ */
122
+ isBrokerCommission: boolean;
117
123
  /**
118
124
  * For an invoice awaiting its payout: when it is due, by the payout frequency of the account. A payout that costs the account nothing is due right away, unless it wants those to wait too, and so is every invoice of an account that is not paid out automatically. Null when it awaits no payout.
119
125
  * @type {Date}
@@ -166,6 +172,7 @@ export function instanceOfSellerInvoiceDto(value: object): value is SellerInvoic
166
172
  if (!('parent' in value) || value['parent'] === undefined) return false;
167
173
  if (!('hasChildren' in value) || value['hasChildren'] === undefined) return false;
168
174
  if (!('isAffiliateCommission' in value) || value['isAffiliateCommission'] === undefined) return false;
175
+ if (!('isBrokerCommission' in value) || value['isBrokerCommission'] === undefined) return false;
169
176
  if (!('payoutDueAt' in value) || value['payoutDueAt'] === undefined) return false;
170
177
  if (!('payout' in value) || value['payout'] === undefined) return false;
171
178
  return true;
@@ -192,6 +199,7 @@ export function SellerInvoiceDtoFromJSONTyped(json: any, ignoreDiscriminator: bo
192
199
  'parent': json['parent'],
193
200
  'hasChildren': json['hasChildren'],
194
201
  'isAffiliateCommission': json['isAffiliateCommission'],
202
+ 'isBrokerCommission': json['isBrokerCommission'],
195
203
  'payoutDueAt': (json['payoutDueAt'] == null ? null : new Date(json['payoutDueAt'])),
196
204
  'payout': InvoicePayoutDtoFromJSON(json['payout']),
197
205
  };
@@ -219,6 +227,7 @@ export function SellerInvoiceDtoToJSONTyped(value?: SellerInvoiceDto | null, ign
219
227
  'parent': value['parent'],
220
228
  'hasChildren': value['hasChildren'],
221
229
  'isAffiliateCommission': value['isAffiliateCommission'],
230
+ 'isBrokerCommission': value['isBrokerCommission'],
222
231
  'payoutDueAt': (value['payoutDueAt'] == null ? null : (value['payoutDueAt'] as any).toISOString()),
223
232
  'payout': InvoicePayoutDtoToJSON(value['payout']),
224
233
  };
@@ -68,7 +68,8 @@ export const SimulateCommissionInputSubtypeEnum = {
68
68
  NOT_POINTING: 'not_pointing',
69
69
  ROUTED: 'routed',
70
70
  MANUAL_LEAD: 'manual_lead',
71
- AUCTION: 'auction'
71
+ AUCTION: 'auction',
72
+ BROKERED_LEAD: 'brokered_lead'
72
73
  } as const;
73
74
  export type SimulateCommissionInputSubtypeEnum = typeof SimulateCommissionInputSubtypeEnum[keyof typeof SimulateCommissionInputSubtypeEnum];
74
75
 
@@ -51,6 +51,8 @@ export const UpdateApiKeyInputScopeEnum = {
51
51
  TRANSFERS_WRITE: 'TRANSFERS_WRITE',
52
52
  LEADS_READ: 'LEADS_READ',
53
53
  LEADS_WRITE: 'LEADS_WRITE',
54
+ BROKERED_LEADS_READ: 'BROKERED_LEADS_READ',
55
+ BROKERED_LEADS_WRITE: 'BROKERED_LEADS_WRITE',
54
56
  AUCTIONS_READ: 'AUCTIONS_READ',
55
57
  AUCTIONS_WRITE: 'AUCTIONS_WRITE',
56
58
  STATS_READ: 'STATS_READ',
@@ -157,6 +157,7 @@ export const UserNotificationDtoTypeEnum = {
157
157
  SELLER_LEASE_TO_OWN_INSTALLMENT_INVOICE: 'seller_lease_to_own_installment_invoice',
158
158
  SELLER_RENT_INSTALLMENT_INVOICE: 'seller_rent_installment_invoice',
159
159
  AFFILIATE_COMMISSIONS_INVOICE: 'affiliate_commissions_invoice',
160
+ BROKER_COMMISSION_INVOICE: 'broker_commission_invoice',
160
161
  LEAD_MESSAGE_BATCH: 'lead_message.batch',
161
162
  TASKS_REMINDER_BATCH: 'tasks.reminder.batch',
162
163
  LEAD_MESSAGE_OFFER: 'lead_message.offer',
@@ -174,7 +175,12 @@ export const UserNotificationDtoTypeEnum = {
174
175
  AUCTION_FINISHED_RESERVE_PRICE_NOT_REACHED_BIDDER_NOTIFICATION: 'auction.finished_reserve_price_not_reached_bidder_notification',
175
176
  AUCTION_FINISHED_WITH_WINNER_SELLER_NOTIFICATION: 'auction.finished_with_winner_seller_notification',
176
177
  AUCTION_FINISHED_WITHOUT_WINNER_SELLER_NOTIFICATION: 'auction.finished_without_winner_seller_notification',
177
- AUCTION_FINISHED_RESERVE_PRICE_NOT_REACHED_SELLER_NOTIFICATION: 'auction.finished_reserve_price_not_reached_seller_notification'
178
+ AUCTION_FINISHED_RESERVE_PRICE_NOT_REACHED_SELLER_NOTIFICATION: 'auction.finished_reserve_price_not_reached_seller_notification',
179
+ BROKERED_LEAD_SELLER_APPROVAL_REQUEST: 'brokered_lead.seller_approval_request',
180
+ BROKERED_LEAD_SELLER_INVITATION: 'brokered_lead.seller_invitation',
181
+ BROKERED_LEAD_BUYER_PAYMENT_REMINDER: 'brokered_lead.buyer_payment_reminder',
182
+ BROKERED_LEAD_READY_FOR_PAYMENT: 'brokered_lead.ready_for_payment',
183
+ BROKERED_LEAD_DECLINED: 'brokered_lead.declined'
178
184
  } as const;
179
185
  export type UserNotificationDtoTypeEnum = typeof UserNotificationDtoTypeEnum[keyof typeof UserNotificationDtoTypeEnum];
180
186
 
@@ -143,6 +143,7 @@ export const UserNotificationListItemDtoTypeEnum = {
143
143
  SELLER_LEASE_TO_OWN_INSTALLMENT_INVOICE: 'seller_lease_to_own_installment_invoice',
144
144
  SELLER_RENT_INSTALLMENT_INVOICE: 'seller_rent_installment_invoice',
145
145
  AFFILIATE_COMMISSIONS_INVOICE: 'affiliate_commissions_invoice',
146
+ BROKER_COMMISSION_INVOICE: 'broker_commission_invoice',
146
147
  LEAD_MESSAGE_BATCH: 'lead_message.batch',
147
148
  TASKS_REMINDER_BATCH: 'tasks.reminder.batch',
148
149
  LEAD_MESSAGE_OFFER: 'lead_message.offer',
@@ -160,7 +161,12 @@ export const UserNotificationListItemDtoTypeEnum = {
160
161
  AUCTION_FINISHED_RESERVE_PRICE_NOT_REACHED_BIDDER_NOTIFICATION: 'auction.finished_reserve_price_not_reached_bidder_notification',
161
162
  AUCTION_FINISHED_WITH_WINNER_SELLER_NOTIFICATION: 'auction.finished_with_winner_seller_notification',
162
163
  AUCTION_FINISHED_WITHOUT_WINNER_SELLER_NOTIFICATION: 'auction.finished_without_winner_seller_notification',
163
- AUCTION_FINISHED_RESERVE_PRICE_NOT_REACHED_SELLER_NOTIFICATION: 'auction.finished_reserve_price_not_reached_seller_notification'
164
+ AUCTION_FINISHED_RESERVE_PRICE_NOT_REACHED_SELLER_NOTIFICATION: 'auction.finished_reserve_price_not_reached_seller_notification',
165
+ BROKERED_LEAD_SELLER_APPROVAL_REQUEST: 'brokered_lead.seller_approval_request',
166
+ BROKERED_LEAD_SELLER_INVITATION: 'brokered_lead.seller_invitation',
167
+ BROKERED_LEAD_BUYER_PAYMENT_REMINDER: 'brokered_lead.buyer_payment_reminder',
168
+ BROKERED_LEAD_READY_FOR_PAYMENT: 'brokered_lead.ready_for_payment',
169
+ BROKERED_LEAD_DECLINED: 'brokered_lead.declined'
164
170
  } as const;
165
171
  export type UserNotificationListItemDtoTypeEnum = typeof UserNotificationListItemDtoTypeEnum[keyof typeof UserNotificationListItemDtoTypeEnum];
166
172
 
@@ -20,6 +20,41 @@ import {
20
20
  LeadVerificationSettingsDtoToJSON,
21
21
  LeadVerificationSettingsDtoToJSONTyped,
22
22
  } from './LeadVerificationSettingsDto';
23
+ import type { AccountSettingsBrokerDto } from './AccountSettingsBrokerDto';
24
+ import {
25
+ AccountSettingsBrokerDtoFromJSON,
26
+ AccountSettingsBrokerDtoFromJSONTyped,
27
+ AccountSettingsBrokerDtoToJSON,
28
+ AccountSettingsBrokerDtoToJSONTyped,
29
+ } from './AccountSettingsBrokerDto';
30
+ import type { AccountSettingsLeaseToOwnConfigurationDto } from './AccountSettingsLeaseToOwnConfigurationDto';
31
+ import {
32
+ AccountSettingsLeaseToOwnConfigurationDtoFromJSON,
33
+ AccountSettingsLeaseToOwnConfigurationDtoFromJSONTyped,
34
+ AccountSettingsLeaseToOwnConfigurationDtoToJSON,
35
+ AccountSettingsLeaseToOwnConfigurationDtoToJSONTyped,
36
+ } from './AccountSettingsLeaseToOwnConfigurationDto';
37
+ import type { LeadOfferExpirationConfigurationDto } from './LeadOfferExpirationConfigurationDto';
38
+ import {
39
+ LeadOfferExpirationConfigurationDtoFromJSON,
40
+ LeadOfferExpirationConfigurationDtoFromJSONTyped,
41
+ LeadOfferExpirationConfigurationDtoToJSON,
42
+ LeadOfferExpirationConfigurationDtoToJSONTyped,
43
+ } from './LeadOfferExpirationConfigurationDto';
44
+ import type { TimeTableConfigurationDto } from './TimeTableConfigurationDto';
45
+ import {
46
+ TimeTableConfigurationDtoFromJSON,
47
+ TimeTableConfigurationDtoFromJSONTyped,
48
+ TimeTableConfigurationDtoToJSON,
49
+ TimeTableConfigurationDtoToJSONTyped,
50
+ } from './TimeTableConfigurationDto';
51
+ import type { AccountSettingsRentConfigurationDto } from './AccountSettingsRentConfigurationDto';
52
+ import {
53
+ AccountSettingsRentConfigurationDtoFromJSON,
54
+ AccountSettingsRentConfigurationDtoFromJSONTyped,
55
+ AccountSettingsRentConfigurationDtoToJSON,
56
+ AccountSettingsRentConfigurationDtoToJSONTyped,
57
+ } from './AccountSettingsRentConfigurationDto';
23
58
  import type { LeadPriceNegotiatorAiAgentConfigurationDto } from './LeadPriceNegotiatorAiAgentConfigurationDto';
24
59
  import {
25
60
  LeadPriceNegotiatorAiAgentConfigurationDtoFromJSON,
@@ -48,20 +83,6 @@ import {
48
83
  AccountAliasDtoToJSON,
49
84
  AccountAliasDtoToJSONTyped,
50
85
  } from './AccountAliasDto';
51
- import type { AccountSettingsLeaseToOwnConfigurationDto } from './AccountSettingsLeaseToOwnConfigurationDto';
52
- import {
53
- AccountSettingsLeaseToOwnConfigurationDtoFromJSON,
54
- AccountSettingsLeaseToOwnConfigurationDtoFromJSONTyped,
55
- AccountSettingsLeaseToOwnConfigurationDtoToJSON,
56
- AccountSettingsLeaseToOwnConfigurationDtoToJSONTyped,
57
- } from './AccountSettingsLeaseToOwnConfigurationDto';
58
- import type { LeadOfferExpirationConfigurationDto } from './LeadOfferExpirationConfigurationDto';
59
- import {
60
- LeadOfferExpirationConfigurationDtoFromJSON,
61
- LeadOfferExpirationConfigurationDtoFromJSONTyped,
62
- LeadOfferExpirationConfigurationDtoToJSON,
63
- LeadOfferExpirationConfigurationDtoToJSONTyped,
64
- } from './LeadOfferExpirationConfigurationDto';
65
86
  import type { AuctionConfigurationDto } from './AuctionConfigurationDto';
66
87
  import {
67
88
  AuctionConfigurationDtoFromJSON,
@@ -76,13 +97,6 @@ import {
76
97
  AccountCommissionByDateRangeDtoToJSON,
77
98
  AccountCommissionByDateRangeDtoToJSONTyped,
78
99
  } from './AccountCommissionByDateRangeDto';
79
- import type { TimeTableConfigurationDto } from './TimeTableConfigurationDto';
80
- import {
81
- TimeTableConfigurationDtoFromJSON,
82
- TimeTableConfigurationDtoFromJSONTyped,
83
- TimeTableConfigurationDtoToJSON,
84
- TimeTableConfigurationDtoToJSONTyped,
85
- } from './TimeTableConfigurationDto';
86
100
  import type { DomainLockConfigurationDto } from './DomainLockConfigurationDto';
87
101
  import {
88
102
  DomainLockConfigurationDtoFromJSON,
@@ -90,13 +104,6 @@ import {
90
104
  DomainLockConfigurationDtoToJSON,
91
105
  DomainLockConfigurationDtoToJSONTyped,
92
106
  } from './DomainLockConfigurationDto';
93
- import type { AccountSettingsRentConfigurationDto } from './AccountSettingsRentConfigurationDto';
94
- import {
95
- AccountSettingsRentConfigurationDtoFromJSON,
96
- AccountSettingsRentConfigurationDtoFromJSONTyped,
97
- AccountSettingsRentConfigurationDtoToJSON,
98
- AccountSettingsRentConfigurationDtoToJSONTyped,
99
- } from './AccountSettingsRentConfigurationDto';
100
107
 
101
108
  /**
102
109
  *
@@ -230,6 +237,12 @@ export interface WithSettingsInner {
230
237
  * @memberof WithSettingsInner
231
238
  */
232
239
  leadVerification: LeadVerificationSettingsDto;
240
+ /**
241
+ * Brokerage settings: whether the account works as a broker.
242
+ * @type {AccountSettingsBrokerDto}
243
+ * @memberof WithSettingsInner
244
+ */
245
+ broker: AccountSettingsBrokerDto;
233
246
  }
234
247
 
235
248
  /**
@@ -257,6 +270,7 @@ export function instanceOfWithSettingsInner(value: object): value is WithSetting
257
270
  if (!('domainLockConfiguration' in value) || value['domainLockConfiguration'] === undefined) return false;
258
271
  if (!('leadOfferExpirationConfiguration' in value) || value['leadOfferExpirationConfiguration'] === undefined) return false;
259
272
  if (!('leadVerification' in value) || value['leadVerification'] === undefined) return false;
273
+ if (!('broker' in value) || value['broker'] === undefined) return false;
260
274
  return true;
261
275
  }
262
276
 
@@ -291,6 +305,7 @@ export function WithSettingsInnerFromJSONTyped(json: any, ignoreDiscriminator: b
291
305
  'domainLockConfiguration': DomainLockConfigurationDtoFromJSON(json['domainLockConfiguration']),
292
306
  'leadOfferExpirationConfiguration': LeadOfferExpirationConfigurationDtoFromJSON(json['leadOfferExpirationConfiguration']),
293
307
  'leadVerification': LeadVerificationSettingsDtoFromJSON(json['leadVerification']),
308
+ 'broker': AccountSettingsBrokerDtoFromJSON(json['broker']),
294
309
  };
295
310
  }
296
311
 
@@ -326,6 +341,7 @@ export function WithSettingsInnerToJSONTyped(value?: WithSettingsInner | null, i
326
341
  'domainLockConfiguration': DomainLockConfigurationDtoToJSON(value['domainLockConfiguration']),
327
342
  'leadOfferExpirationConfiguration': LeadOfferExpirationConfigurationDtoToJSON(value['leadOfferExpirationConfiguration']),
328
343
  'leadVerification': LeadVerificationSettingsDtoToJSON(value['leadVerification']),
344
+ 'broker': AccountSettingsBrokerDtoToJSON(value['broker']),
329
345
  };
330
346
  }
331
347
 
@@ -5,6 +5,7 @@ export * from './AccountAliasInput';
5
5
  export * from './AccountBankAccountDetailsDto';
6
6
  export * from './AccountBankAccountDto';
7
7
  export * from './AccountBankAccountSummaryDto';
8
+ export * from './AccountBrokerSettingsInput';
8
9
  export * from './AccountChallengeRewardUsageListItemDto';
9
10
  export * from './AccountChallengeRewardUsageListItemDtoMetadata';
10
11
  export * from './AccountCommissionByDateRangeDto';
@@ -36,6 +37,7 @@ export * from './AccountSettingsAffiliateCommissionDto';
36
37
  export * from './AccountSettingsAffiliateCommissionReferralDuration';
37
38
  export * from './AccountSettingsAffiliateDto';
38
39
  export * from './AccountSettingsAliasDto';
40
+ export * from './AccountSettingsBrokerDto';
39
41
  export * from './AccountSettingsDto';
40
42
  export * from './AccountSettingsInput';
41
43
  export * from './AccountSettingsLeaseToOwnConfigurationDto';
@@ -61,6 +63,7 @@ export * from './AdminBankDepositAccountDto';
61
63
  export * from './AdminBankDepositDto';
62
64
  export * from './AdminBankDepositInvoiceDto';
63
65
  export * from './AdminBankDepositInvoiceTransactionDto';
66
+ export * from './AdminBrokeredLeadDto';
64
67
  export * from './AdminBuyerListItemDto';
65
68
  export * from './AdminBuyerLoginDto';
66
69
  export * from './AdminChallengeListDto';
@@ -75,6 +78,7 @@ export * from './AdminLeadListItemBuyerDto';
75
78
  export * from './AdminLeadListItemDomainDto';
76
79
  export * from './AdminLeadListItemDto';
77
80
  export * from './AdminListAccountDto';
81
+ export * from './AdminListBrokeredLeads200Response';
78
82
  export * from './AdminMarketplaceDto';
79
83
  export * from './AdminUserNewsletterInput';
80
84
  export * from './AdminUserSecurityDto';
@@ -119,6 +123,13 @@ export * from './BatchReadSellerLeadMessageInput';
119
123
  export * from './BatchUpdateDomainsInput';
120
124
  export * from './BatchVerifyBuyerLeadsInput';
121
125
  export * from './BillingInformationDto';
126
+ export * from './BrokerBrokeredLeadDto';
127
+ export * from './BrokerCommissionInput';
128
+ export * from './BrokeredLeadBreakdownDto';
129
+ export * from './BrokeredLeadBuyerContactDto';
130
+ export * from './BrokeredLeadBuyerInput';
131
+ export * from './BrokeredLeadCommissionDto';
132
+ export * from './BrokeredLeadInvitationDto';
122
133
  export * from './BulkCommissionActionsInput';
123
134
  export * from './BulkCommissionActionsInputActionsInner';
124
135
  export * from './BulkDownloadInvoicesInput';
@@ -199,6 +210,7 @@ export * from './CreateAccountPaymentManualTransactionInput';
199
210
  export * from './CreateApiKeyInput';
200
211
  export * from './CreateBankAccountDetailsInput';
201
212
  export * from './CreateBankAccountInput';
213
+ export * from './CreateBrokeredLeadInput';
202
214
  export * from './CreateBuyerDomainAppraisalRequestInput';
203
215
  export * from './CreateBuyerLeadMessageInput';
204
216
  export * from './CreateChallengeInput';
@@ -223,6 +235,7 @@ export * from './CustomerSuccessListAccountDto';
223
235
  export * from './CustomerSuccessListAccountMetricsDto';
224
236
  export * from './CustomerSuccessListAccountPortfolioSizeDto';
225
237
  export * from './CustomerSuccessListAccountUserDto';
238
+ export * from './DeclineBrokeredLeadInput';
226
239
  export * from './DeleteDomainsInput';
227
240
  export * from './DomainAppraisalRequestListItemDto';
228
241
  export * from './DomainAppraisalRequestStatus';
@@ -341,6 +354,7 @@ export * from './LandingPageOriginalDesignSettingsDto';
341
354
  export * from './LandingPageOriginalDesignSettingsInput';
342
355
  export * from './LandingPageSettingsDto';
343
356
  export * from './LatestDomainAppraisalRequestDto';
357
+ export * from './LeadBrokeredDealDto';
344
358
  export * from './LeadBuyerConfigDto';
345
359
  export * from './LeadDomainDto';
346
360
  export * from './LeadDto';
@@ -397,6 +411,7 @@ export * from './ListAdminRelatedLeads200Response';
397
411
  export * from './ListAuctions200Response';
398
412
  export * from './ListBankAccounts200Response';
399
413
  export * from './ListBankDeposits200Response';
414
+ export * from './ListBrokerLeads200Response';
400
415
  export * from './ListBuyerNotifications200Response';
401
416
  export * from './ListBuyers200Response';
402
417
  export * from './ListCustomerSuccessAccountDomains200Response';
@@ -452,6 +467,7 @@ export * from './OrderListItemDtoBuyerInformation';
452
467
  export * from './OrderListItemDtoDomainInformation';
453
468
  export * from './OrderListItemDtoSellerAccount';
454
469
  export * from './OrderListItemDtoTransaction';
470
+ export * from './OverrideBrokeredLeadNameshiftCommissionInput';
455
471
  export * from './OwnedDomainDto';
456
472
  export * from './PageBasedPageInfo';
457
473
  export * from './PageBasedPaginationResponse';
@@ -530,6 +546,8 @@ export * from './SellerAffiliateCommissionDto';
530
546
  export * from './SellerAuctionListItemDto';
531
547
  export * from './SellerAuctionListItemDtoDomainInformation';
532
548
  export * from './SellerAuctionListItemDtoSellerAccount';
549
+ export * from './SellerBrokeredLeadDto';
550
+ export * from './SellerBrokeredLeadVerificationDto';
533
551
  export * from './SellerDomainAffiliateCommissionDto';
534
552
  export * from './SellerDomainAffiliateCommissionDtoDomain';
535
553
  export * from './SellerDomainTransferAuthCodeDto';