@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,93 @@
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 BrokeredLeadBuyerInput
20
+ */
21
+ export interface BrokeredLeadBuyerInput {
22
+ /**
23
+ * Buyer email address.
24
+ * @type {string}
25
+ * @memberof BrokeredLeadBuyerInput
26
+ */
27
+ email: string;
28
+ /**
29
+ * Buyer first name.
30
+ * @type {string}
31
+ * @memberof BrokeredLeadBuyerInput
32
+ */
33
+ firstname: string;
34
+ /**
35
+ * Buyer last name.
36
+ * @type {string}
37
+ * @memberof BrokeredLeadBuyerInput
38
+ */
39
+ lastname: string;
40
+ /**
41
+ * Language the buyer gets their emails and checkout in.
42
+ * @type {string}
43
+ * @memberof BrokeredLeadBuyerInput
44
+ */
45
+ locale: string;
46
+ }
47
+
48
+ /**
49
+ * Check if a given object implements the BrokeredLeadBuyerInput interface.
50
+ */
51
+ export function instanceOfBrokeredLeadBuyerInput(value: object): value is BrokeredLeadBuyerInput {
52
+ if (!('email' in value) || value['email'] === undefined) return false;
53
+ if (!('firstname' in value) || value['firstname'] === undefined) return false;
54
+ if (!('lastname' in value) || value['lastname'] === undefined) return false;
55
+ if (!('locale' in value) || value['locale'] === undefined) return false;
56
+ return true;
57
+ }
58
+
59
+ export function BrokeredLeadBuyerInputFromJSON(json: any): BrokeredLeadBuyerInput {
60
+ return BrokeredLeadBuyerInputFromJSONTyped(json, false);
61
+ }
62
+
63
+ export function BrokeredLeadBuyerInputFromJSONTyped(json: any, ignoreDiscriminator: boolean): BrokeredLeadBuyerInput {
64
+ if (json == null) {
65
+ return json;
66
+ }
67
+ return {
68
+
69
+ 'email': json['email'],
70
+ 'firstname': json['firstname'],
71
+ 'lastname': json['lastname'],
72
+ 'locale': json['locale'],
73
+ };
74
+ }
75
+
76
+ export function BrokeredLeadBuyerInputToJSON(json: any): BrokeredLeadBuyerInput {
77
+ return BrokeredLeadBuyerInputToJSONTyped(json, false);
78
+ }
79
+
80
+ export function BrokeredLeadBuyerInputToJSONTyped(value?: BrokeredLeadBuyerInput | null, ignoreDiscriminator: boolean = false): any {
81
+ if (value == null) {
82
+ return value;
83
+ }
84
+
85
+ return {
86
+
87
+ 'email': value['email'],
88
+ 'firstname': value['firstname'],
89
+ 'lastname': value['lastname'],
90
+ 'locale': value['locale'],
91
+ };
92
+ }
93
+
@@ -0,0 +1,130 @@
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 { MoneyDecimalDto } from './MoneyDecimalDto';
17
+ import {
18
+ MoneyDecimalDtoFromJSON,
19
+ MoneyDecimalDtoFromJSONTyped,
20
+ MoneyDecimalDtoToJSON,
21
+ MoneyDecimalDtoToJSONTyped,
22
+ } from './MoneyDecimalDto';
23
+
24
+ /**
25
+ *
26
+ * @export
27
+ * @interface BrokeredLeadCommissionDto
28
+ */
29
+ export interface BrokeredLeadCommissionDto {
30
+ /**
31
+ *
32
+ * @type {string}
33
+ * @memberof BrokeredLeadCommissionDto
34
+ */
35
+ type: BrokeredLeadCommissionDtoTypeEnum;
36
+ /**
37
+ * Charged to the buyer: percentage points, or an amount in the sale currency.
38
+ * @type {number}
39
+ * @memberof BrokeredLeadCommissionDto
40
+ */
41
+ buyerValue: number | null;
42
+ /**
43
+ * Charged to the seller: percentage points, or an amount in the sale currency.
44
+ * @type {number}
45
+ * @memberof BrokeredLeadCommissionDto
46
+ */
47
+ sellerValue: number | null;
48
+ /**
49
+ *
50
+ * @type {MoneyDecimalDto}
51
+ * @memberof BrokeredLeadCommissionDto
52
+ */
53
+ buyerAmount: MoneyDecimalDto | null;
54
+ /**
55
+ *
56
+ * @type {MoneyDecimalDto}
57
+ * @memberof BrokeredLeadCommissionDto
58
+ */
59
+ sellerAmount: MoneyDecimalDto | null;
60
+ /**
61
+ * Buyer and seller parts together.
62
+ * @type {MoneyDecimalDto}
63
+ * @memberof BrokeredLeadCommissionDto
64
+ */
65
+ totalAmount: MoneyDecimalDto;
66
+ }
67
+
68
+
69
+ /**
70
+ * @export
71
+ */
72
+ export const BrokeredLeadCommissionDtoTypeEnum = {
73
+ FIXED: 'fixed',
74
+ PERCENTAGE: 'percentage'
75
+ } as const;
76
+ export type BrokeredLeadCommissionDtoTypeEnum = typeof BrokeredLeadCommissionDtoTypeEnum[keyof typeof BrokeredLeadCommissionDtoTypeEnum];
77
+
78
+
79
+ /**
80
+ * Check if a given object implements the BrokeredLeadCommissionDto interface.
81
+ */
82
+ export function instanceOfBrokeredLeadCommissionDto(value: object): value is BrokeredLeadCommissionDto {
83
+ if (!('type' in value) || value['type'] === undefined) return false;
84
+ if (!('buyerValue' in value) || value['buyerValue'] === undefined) return false;
85
+ if (!('sellerValue' in value) || value['sellerValue'] === undefined) return false;
86
+ if (!('buyerAmount' in value) || value['buyerAmount'] === undefined) return false;
87
+ if (!('sellerAmount' in value) || value['sellerAmount'] === undefined) return false;
88
+ if (!('totalAmount' in value) || value['totalAmount'] === undefined) return false;
89
+ return true;
90
+ }
91
+
92
+ export function BrokeredLeadCommissionDtoFromJSON(json: any): BrokeredLeadCommissionDto {
93
+ return BrokeredLeadCommissionDtoFromJSONTyped(json, false);
94
+ }
95
+
96
+ export function BrokeredLeadCommissionDtoFromJSONTyped(json: any, ignoreDiscriminator: boolean): BrokeredLeadCommissionDto {
97
+ if (json == null) {
98
+ return json;
99
+ }
100
+ return {
101
+
102
+ 'type': json['type'],
103
+ 'buyerValue': json['buyerValue'],
104
+ 'sellerValue': json['sellerValue'],
105
+ 'buyerAmount': MoneyDecimalDtoFromJSON(json['buyerAmount']),
106
+ 'sellerAmount': MoneyDecimalDtoFromJSON(json['sellerAmount']),
107
+ 'totalAmount': MoneyDecimalDtoFromJSON(json['totalAmount']),
108
+ };
109
+ }
110
+
111
+ export function BrokeredLeadCommissionDtoToJSON(json: any): BrokeredLeadCommissionDto {
112
+ return BrokeredLeadCommissionDtoToJSONTyped(json, false);
113
+ }
114
+
115
+ export function BrokeredLeadCommissionDtoToJSONTyped(value?: BrokeredLeadCommissionDto | null, ignoreDiscriminator: boolean = false): any {
116
+ if (value == null) {
117
+ return value;
118
+ }
119
+
120
+ return {
121
+
122
+ 'type': value['type'],
123
+ 'buyerValue': value['buyerValue'],
124
+ 'sellerValue': value['sellerValue'],
125
+ 'buyerAmount': MoneyDecimalDtoToJSON(value['buyerAmount']),
126
+ 'sellerAmount': MoneyDecimalDtoToJSON(value['sellerAmount']),
127
+ 'totalAmount': MoneyDecimalDtoToJSON(value['totalAmount']),
128
+ };
129
+ }
130
+
@@ -0,0 +1,110 @@
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 { MoneyDto } from './MoneyDto';
17
+ import {
18
+ MoneyDtoFromJSON,
19
+ MoneyDtoFromJSONTyped,
20
+ MoneyDtoToJSON,
21
+ MoneyDtoToJSONTyped,
22
+ } from './MoneyDto';
23
+
24
+ /**
25
+ *
26
+ * @export
27
+ * @interface BrokeredLeadInvitationDto
28
+ */
29
+ export interface BrokeredLeadInvitationDto {
30
+ /**
31
+ *
32
+ * @type {string}
33
+ * @memberof BrokeredLeadInvitationDto
34
+ */
35
+ domainName: string;
36
+ /**
37
+ *
38
+ * @type {string}
39
+ * @memberof BrokeredLeadInvitationDto
40
+ */
41
+ brokerName: string;
42
+ /**
43
+ *
44
+ * @type {MoneyDto}
45
+ * @memberof BrokeredLeadInvitationDto
46
+ */
47
+ askingPrice: MoneyDto;
48
+ /**
49
+ * Whether the link can still be used. An expired or used link cannot; the seller then asks the broker for a new one.
50
+ * @type {boolean}
51
+ * @memberof BrokeredLeadInvitationDto
52
+ */
53
+ valid: boolean;
54
+ /**
55
+ * Whether the link expired.
56
+ * @type {boolean}
57
+ * @memberof BrokeredLeadInvitationDto
58
+ */
59
+ expired: boolean;
60
+ }
61
+
62
+ /**
63
+ * Check if a given object implements the BrokeredLeadInvitationDto interface.
64
+ */
65
+ export function instanceOfBrokeredLeadInvitationDto(value: object): value is BrokeredLeadInvitationDto {
66
+ if (!('domainName' in value) || value['domainName'] === undefined) return false;
67
+ if (!('brokerName' in value) || value['brokerName'] === undefined) return false;
68
+ if (!('askingPrice' in value) || value['askingPrice'] === undefined) return false;
69
+ if (!('valid' in value) || value['valid'] === undefined) return false;
70
+ if (!('expired' in value) || value['expired'] === undefined) return false;
71
+ return true;
72
+ }
73
+
74
+ export function BrokeredLeadInvitationDtoFromJSON(json: any): BrokeredLeadInvitationDto {
75
+ return BrokeredLeadInvitationDtoFromJSONTyped(json, false);
76
+ }
77
+
78
+ export function BrokeredLeadInvitationDtoFromJSONTyped(json: any, ignoreDiscriminator: boolean): BrokeredLeadInvitationDto {
79
+ if (json == null) {
80
+ return json;
81
+ }
82
+ return {
83
+
84
+ 'domainName': json['domainName'],
85
+ 'brokerName': json['brokerName'],
86
+ 'askingPrice': MoneyDtoFromJSON(json['askingPrice']),
87
+ 'valid': json['valid'],
88
+ 'expired': json['expired'],
89
+ };
90
+ }
91
+
92
+ export function BrokeredLeadInvitationDtoToJSON(json: any): BrokeredLeadInvitationDto {
93
+ return BrokeredLeadInvitationDtoToJSONTyped(json, false);
94
+ }
95
+
96
+ export function BrokeredLeadInvitationDtoToJSONTyped(value?: BrokeredLeadInvitationDto | null, ignoreDiscriminator: boolean = false): any {
97
+ if (value == null) {
98
+ return value;
99
+ }
100
+
101
+ return {
102
+
103
+ 'domainName': value['domainName'],
104
+ 'brokerName': value['brokerName'],
105
+ 'askingPrice': MoneyDtoToJSON(value['askingPrice']),
106
+ 'valid': value['valid'],
107
+ 'expired': value['expired'],
108
+ };
109
+ }
110
+
@@ -107,6 +107,12 @@ export interface BuyerInvoiceDto {
107
107
  * @memberof BuyerInvoiceDto
108
108
  */
109
109
  isAffiliateCommission: boolean;
110
+ /**
111
+ * Whether this is the invoice a broker issues for a brokered sale commission.
112
+ * @type {boolean}
113
+ * @memberof BuyerInvoiceDto
114
+ */
115
+ isBrokerCommission: boolean;
110
116
  }
111
117
 
112
118
 
@@ -147,6 +153,7 @@ export function instanceOfBuyerInvoiceDto(value: object): value is BuyerInvoiceD
147
153
  if (!('parent' in value) || value['parent'] === undefined) return false;
148
154
  if (!('hasChildren' in value) || value['hasChildren'] === undefined) return false;
149
155
  if (!('isAffiliateCommission' in value) || value['isAffiliateCommission'] === undefined) return false;
156
+ if (!('isBrokerCommission' in value) || value['isBrokerCommission'] === undefined) return false;
150
157
  return true;
151
158
  }
152
159
 
@@ -171,6 +178,7 @@ export function BuyerInvoiceDtoFromJSONTyped(json: any, ignoreDiscriminator: boo
171
178
  'parent': json['parent'],
172
179
  'hasChildren': json['hasChildren'],
173
180
  'isAffiliateCommission': json['isAffiliateCommission'],
181
+ 'isBrokerCommission': json['isBrokerCommission'],
174
182
  };
175
183
  }
176
184
 
@@ -196,6 +204,7 @@ export function BuyerInvoiceDtoToJSONTyped(value?: BuyerInvoiceDto | null, ignor
196
204
  'parent': value['parent'],
197
205
  'hasChildren': value['hasChildren'],
198
206
  'isAffiliateCommission': value['isAffiliateCommission'],
207
+ 'isBrokerCommission': value['isBrokerCommission'],
199
208
  };
200
209
  }
201
210
 
@@ -157,6 +157,7 @@ export const BuyerNotificationDtoTypeEnum = {
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 BuyerNotificationDtoTypeEnum = {
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 BuyerNotificationDtoTypeEnum = typeof BuyerNotificationDtoTypeEnum[keyof typeof BuyerNotificationDtoTypeEnum];
180
186
 
@@ -143,6 +143,7 @@ export const BuyerNotificationListItemDtoTypeEnum = {
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 BuyerNotificationListItemDtoTypeEnum = {
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 BuyerNotificationListItemDtoTypeEnum = typeof BuyerNotificationListItemDtoTypeEnum[keyof typeof BuyerNotificationListItemDtoTypeEnum];
166
172
 
@@ -132,7 +132,8 @@ export const CommissionDtoSubtypeEnum = {
132
132
  NOT_POINTING: 'not_pointing',
133
133
  ROUTED: 'routed',
134
134
  MANUAL_LEAD: 'manual_lead',
135
- AUCTION: 'auction'
135
+ AUCTION: 'auction',
136
+ BROKERED_LEAD: 'brokered_lead'
136
137
  } as const;
137
138
  export type CommissionDtoSubtypeEnum = typeof CommissionDtoSubtypeEnum[keyof typeof CommissionDtoSubtypeEnum];
138
139
 
@@ -113,7 +113,8 @@ export const CommissionPayloadInputSubtypeEnum = {
113
113
  NOT_POINTING: 'not_pointing',
114
114
  ROUTED: 'routed',
115
115
  MANUAL_LEAD: 'manual_lead',
116
- AUCTION: 'auction'
116
+ AUCTION: 'auction',
117
+ BROKERED_LEAD: 'brokered_lead'
117
118
  } as const;
118
119
  export type CommissionPayloadInputSubtypeEnum = typeof CommissionPayloadInputSubtypeEnum[keyof typeof CommissionPayloadInputSubtypeEnum];
119
120
 
@@ -150,7 +150,8 @@ export const CommissionReasonDtoSubtypeEnum = {
150
150
  NOT_POINTING: 'not_pointing',
151
151
  ROUTED: 'routed',
152
152
  MANUAL_LEAD: 'manual_lead',
153
- AUCTION: 'auction'
153
+ AUCTION: 'auction',
154
+ BROKERED_LEAD: 'brokered_lead'
154
155
  } as const;
155
156
  export type CommissionReasonDtoSubtypeEnum = typeof CommissionReasonDtoSubtypeEnum[keyof typeof CommissionReasonDtoSubtypeEnum];
156
157
 
@@ -125,7 +125,8 @@ export const CommissionSimulationItemInputSubtypeEnum = {
125
125
  NOT_POINTING: 'not_pointing',
126
126
  ROUTED: 'routed',
127
127
  MANUAL_LEAD: 'manual_lead',
128
- AUCTION: 'auction'
128
+ AUCTION: 'auction',
129
+ BROKERED_LEAD: 'brokered_lead'
129
130
  } as const;
130
131
  export type CommissionSimulationItemInputSubtypeEnum = typeof CommissionSimulationItemInputSubtypeEnum[keyof typeof CommissionSimulationItemInputSubtypeEnum];
131
132
 
@@ -57,6 +57,8 @@ export const CreateApiKeyInputScopeEnum = {
57
57
  TRANSFERS_WRITE: 'TRANSFERS_WRITE',
58
58
  LEADS_READ: 'LEADS_READ',
59
59
  LEADS_WRITE: 'LEADS_WRITE',
60
+ BROKERED_LEADS_READ: 'BROKERED_LEADS_READ',
61
+ BROKERED_LEADS_WRITE: 'BROKERED_LEADS_WRITE',
60
62
  AUCTIONS_READ: 'AUCTIONS_READ',
61
63
  AUCTIONS_WRITE: 'AUCTIONS_WRITE',
62
64
  STATS_READ: 'STATS_READ',
@@ -0,0 +1,123 @@
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 { BrokeredLeadBuyerInput } from './BrokeredLeadBuyerInput';
17
+ import {
18
+ BrokeredLeadBuyerInputFromJSON,
19
+ BrokeredLeadBuyerInputFromJSONTyped,
20
+ BrokeredLeadBuyerInputToJSON,
21
+ BrokeredLeadBuyerInputToJSONTyped,
22
+ } from './BrokeredLeadBuyerInput';
23
+ import type { MoneyDto } from './MoneyDto';
24
+ import {
25
+ MoneyDtoFromJSON,
26
+ MoneyDtoFromJSONTyped,
27
+ MoneyDtoToJSON,
28
+ MoneyDtoToJSONTyped,
29
+ } from './MoneyDto';
30
+ import type { BrokerCommissionInput } from './BrokerCommissionInput';
31
+ import {
32
+ BrokerCommissionInputFromJSON,
33
+ BrokerCommissionInputFromJSONTyped,
34
+ BrokerCommissionInputToJSON,
35
+ BrokerCommissionInputToJSONTyped,
36
+ } from './BrokerCommissionInput';
37
+
38
+ /**
39
+ *
40
+ * @export
41
+ * @interface CreateBrokeredLeadInput
42
+ */
43
+ export interface CreateBrokeredLeadInput {
44
+ /**
45
+ * Domain being sold.
46
+ * @type {string}
47
+ * @memberof CreateBrokeredLeadInput
48
+ */
49
+ domainName: string;
50
+ /**
51
+ * Agreed sale price, excluding any broker commission.
52
+ * @type {MoneyDto}
53
+ * @memberof CreateBrokeredLeadInput
54
+ */
55
+ askingPrice: MoneyDto;
56
+ /**
57
+ * Broker commission, split between the buyer and the seller.
58
+ * @type {BrokerCommissionInput}
59
+ * @memberof CreateBrokeredLeadInput
60
+ */
61
+ commission: BrokerCommissionInput;
62
+ /**
63
+ *
64
+ * @type {BrokeredLeadBuyerInput}
65
+ * @memberof CreateBrokeredLeadInput
66
+ */
67
+ buyer: BrokeredLeadBuyerInput;
68
+ /**
69
+ * Seller email, needed to email the seller their link. Not used when the deal goes straight to the account that verified the domain.
70
+ * @type {string}
71
+ * @memberof CreateBrokeredLeadInput
72
+ */
73
+ sellerEmail?: string | null;
74
+ }
75
+
76
+ /**
77
+ * Check if a given object implements the CreateBrokeredLeadInput interface.
78
+ */
79
+ export function instanceOfCreateBrokeredLeadInput(value: object): value is CreateBrokeredLeadInput {
80
+ if (!('domainName' in value) || value['domainName'] === undefined) return false;
81
+ if (!('askingPrice' in value) || value['askingPrice'] === undefined) return false;
82
+ if (!('commission' in value) || value['commission'] === undefined) return false;
83
+ if (!('buyer' in value) || value['buyer'] === undefined) return false;
84
+ return true;
85
+ }
86
+
87
+ export function CreateBrokeredLeadInputFromJSON(json: any): CreateBrokeredLeadInput {
88
+ return CreateBrokeredLeadInputFromJSONTyped(json, false);
89
+ }
90
+
91
+ export function CreateBrokeredLeadInputFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateBrokeredLeadInput {
92
+ if (json == null) {
93
+ return json;
94
+ }
95
+ return {
96
+
97
+ 'domainName': json['domainName'],
98
+ 'askingPrice': MoneyDtoFromJSON(json['askingPrice']),
99
+ 'commission': BrokerCommissionInputFromJSON(json['commission']),
100
+ 'buyer': BrokeredLeadBuyerInputFromJSON(json['buyer']),
101
+ 'sellerEmail': json['sellerEmail'] == null ? undefined : json['sellerEmail'],
102
+ };
103
+ }
104
+
105
+ export function CreateBrokeredLeadInputToJSON(json: any): CreateBrokeredLeadInput {
106
+ return CreateBrokeredLeadInputToJSONTyped(json, false);
107
+ }
108
+
109
+ export function CreateBrokeredLeadInputToJSONTyped(value?: CreateBrokeredLeadInput | null, ignoreDiscriminator: boolean = false): any {
110
+ if (value == null) {
111
+ return value;
112
+ }
113
+
114
+ return {
115
+
116
+ 'domainName': value['domainName'],
117
+ 'askingPrice': MoneyDtoToJSON(value['askingPrice']),
118
+ 'commission': BrokerCommissionInputToJSON(value['commission']),
119
+ 'buyer': BrokeredLeadBuyerInputToJSON(value['buyer']),
120
+ 'sellerEmail': value['sellerEmail'],
121
+ };
122
+ }
123
+
@@ -87,6 +87,8 @@ export const CreatedApiKeyDtoScopeEnum = {
87
87
  TRANSFERS_WRITE: 'TRANSFERS_WRITE',
88
88
  LEADS_READ: 'LEADS_READ',
89
89
  LEADS_WRITE: 'LEADS_WRITE',
90
+ BROKERED_LEADS_READ: 'BROKERED_LEADS_READ',
91
+ BROKERED_LEADS_WRITE: 'BROKERED_LEADS_WRITE',
90
92
  AUCTIONS_READ: 'AUCTIONS_READ',
91
93
  AUCTIONS_WRITE: 'AUCTIONS_WRITE',
92
94
  STATS_READ: 'STATS_READ',
@@ -151,6 +151,12 @@ export interface CustomerSuccessListAccountDto {
151
151
  * @memberof CustomerSuccessListAccountDto
152
152
  */
153
153
  onboardingStatus: CustomerSuccessListAccountDtoOnboardingStatusEnum;
154
+ /**
155
+ * When the onboarding first finished.
156
+ * @type {Date}
157
+ * @memberof CustomerSuccessListAccountDto
158
+ */
159
+ onboardingFinishedAt: Date | null;
154
160
  /**
155
161
  * Payout provider.
156
162
  * @type {string}
@@ -264,6 +270,7 @@ export function instanceOfCustomerSuccessListAccountDto(value: object): value is
264
270
  if (!('users' in value) || value['users'] === undefined) return false;
265
271
  if (!('onboardingProvider' in value) || value['onboardingProvider'] === undefined) return false;
266
272
  if (!('onboardingStatus' in value) || value['onboardingStatus'] === undefined) return false;
273
+ if (!('onboardingFinishedAt' in value) || value['onboardingFinishedAt'] === undefined) return false;
267
274
  if (!('payoutProvider' in value) || value['payoutProvider'] === undefined) return false;
268
275
  if (!('affiliateId' in value) || value['affiliateId'] === undefined) return false;
269
276
  if (!('portfolioSize' in value) || value['portfolioSize'] === undefined) return false;
@@ -300,6 +307,7 @@ export function CustomerSuccessListAccountDtoFromJSONTyped(json: any, ignoreDisc
300
307
  'users': ((json['users'] as Array<any>).map(CustomerSuccessListAccountUserDtoFromJSON)),
301
308
  'onboardingProvider': json['onboardingProvider'],
302
309
  'onboardingStatus': json['onboardingStatus'],
310
+ 'onboardingFinishedAt': (json['onboardingFinishedAt'] == null ? null : new Date(json['onboardingFinishedAt'])),
303
311
  'payoutProvider': json['payoutProvider'],
304
312
  'affiliateId': json['affiliateId'],
305
313
  'portfolioSize': CustomerSuccessListAccountPortfolioSizeDtoFromJSON(json['portfolioSize']),
@@ -337,6 +345,7 @@ export function CustomerSuccessListAccountDtoToJSONTyped(value?: CustomerSuccess
337
345
  'users': ((value['users'] as Array<any>).map(CustomerSuccessListAccountUserDtoToJSON)),
338
346
  'onboardingProvider': value['onboardingProvider'],
339
347
  'onboardingStatus': value['onboardingStatus'],
348
+ 'onboardingFinishedAt': (value['onboardingFinishedAt'] == null ? null : (value['onboardingFinishedAt'] as any).toISOString()),
340
349
  'payoutProvider': value['payoutProvider'],
341
350
  'affiliateId': value['affiliateId'],
342
351
  'portfolioSize': CustomerSuccessListAccountPortfolioSizeDtoToJSON(value['portfolioSize']),