@randock/nameshift-api-client 0.0.463 → 0.0.465

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 (30) hide show
  1. package/.openapi-generator/FILES +4 -0
  2. package/README.md +3 -3
  3. package/dist/apis/LeadsPublicApi.d.ts +15 -1
  4. package/dist/apis/LeadsPublicApi.js +49 -0
  5. package/dist/models/AdminLeadListItemBuyerDto.d.ts +6 -0
  6. package/dist/models/AdminLeadListItemBuyerDto.js +4 -0
  7. package/dist/models/AssociateLeadVisitorInput.d.ts +32 -0
  8. package/dist/models/AssociateLeadVisitorInput.js +51 -0
  9. package/dist/models/LeadEnrichmentDomainDto.d.ts +39 -0
  10. package/dist/models/LeadEnrichmentDomainDto.js +56 -0
  11. package/dist/models/LeadEnrichmentDomainVariantDto.d.ts +74 -0
  12. package/dist/models/LeadEnrichmentDomainVariantDto.js +79 -0
  13. package/dist/models/LeadEnrichmentDto.d.ts +16 -2
  14. package/dist/models/LeadEnrichmentDto.js +10 -0
  15. package/dist/models/LeadEnrichmentEmailDto.d.ts +0 -6
  16. package/dist/models/LeadEnrichmentEmailDto.js +0 -4
  17. package/dist/models/LeadEnrichmentPersonDto.d.ts +69 -0
  18. package/dist/models/LeadEnrichmentPersonDto.js +80 -0
  19. package/dist/models/index.d.ts +4 -0
  20. package/dist/models/index.js +4 -0
  21. package/package.json +1 -1
  22. package/src/apis/LeadsPublicApi.ts +52 -0
  23. package/src/models/AdminLeadListItemBuyerDto.ts +9 -0
  24. package/src/models/AssociateLeadVisitorInput.ts +66 -0
  25. package/src/models/LeadEnrichmentDomainDto.ts +83 -0
  26. package/src/models/LeadEnrichmentDomainVariantDto.ts +129 -0
  27. package/src/models/LeadEnrichmentDto.ts +34 -2
  28. package/src/models/LeadEnrichmentEmailDto.ts +0 -9
  29. package/src/models/LeadEnrichmentPersonDto.ts +125 -0
  30. package/src/models/index.ts +4 -0
@@ -13,6 +13,13 @@
13
13
  */
14
14
 
15
15
  import { mapValues } from '../runtime';
16
+ import type { LeadEnrichmentPersonDto } from './LeadEnrichmentPersonDto';
17
+ import {
18
+ LeadEnrichmentPersonDtoFromJSON,
19
+ LeadEnrichmentPersonDtoFromJSONTyped,
20
+ LeadEnrichmentPersonDtoToJSON,
21
+ LeadEnrichmentPersonDtoToJSONTyped,
22
+ } from './LeadEnrichmentPersonDto';
16
23
  import type { LeadEnrichmentIpDto } from './LeadEnrichmentIpDto';
17
24
  import {
18
25
  LeadEnrichmentIpDtoFromJSON,
@@ -41,6 +48,13 @@ import {
41
48
  LeadEnrichmentCompanyDtoToJSON,
42
49
  LeadEnrichmentCompanyDtoToJSONTyped,
43
50
  } from './LeadEnrichmentCompanyDto';
51
+ import type { LeadEnrichmentDomainDto } from './LeadEnrichmentDomainDto';
52
+ import {
53
+ LeadEnrichmentDomainDtoFromJSON,
54
+ LeadEnrichmentDomainDtoFromJSONTyped,
55
+ LeadEnrichmentDomainDtoToJSON,
56
+ LeadEnrichmentDomainDtoToJSONTyped,
57
+ } from './LeadEnrichmentDomainDto';
44
58
 
45
59
  /**
46
60
  *
@@ -61,13 +75,13 @@ export interface LeadEnrichmentDto {
61
75
  */
62
76
  status: string | null;
63
77
  /**
64
- * Summary of the buyer's public web footprint.
78
+ * What publicly ties this buyer to the domain they want. Who the buyer is lives on `person`.
65
79
  * @type {string}
66
80
  * @memberof LeadEnrichmentDto
67
81
  */
68
82
  webSummary: string | null;
69
83
  /**
70
- *
84
+ * Sources behind `webSummary`.
71
85
  * @type {Array<LeadEnrichmentWebResultDto>}
72
86
  * @memberof LeadEnrichmentDto
73
87
  */
@@ -78,6 +92,12 @@ export interface LeadEnrichmentDto {
78
92
  * @memberof LeadEnrichmentDto
79
93
  */
80
94
  email: LeadEnrichmentEmailDto | null;
95
+ /**
96
+ *
97
+ * @type {LeadEnrichmentPersonDto}
98
+ * @memberof LeadEnrichmentDto
99
+ */
100
+ person: LeadEnrichmentPersonDto | null;
81
101
  /**
82
102
  *
83
103
  * @type {LeadEnrichmentCompanyDto}
@@ -90,6 +110,12 @@ export interface LeadEnrichmentDto {
90
110
  * @memberof LeadEnrichmentDto
91
111
  */
92
112
  ip: LeadEnrichmentIpDto | null;
113
+ /**
114
+ *
115
+ * @type {LeadEnrichmentDomainDto}
116
+ * @memberof LeadEnrichmentDto
117
+ */
118
+ domain: LeadEnrichmentDomainDto | null;
93
119
  }
94
120
 
95
121
  /**
@@ -101,8 +127,10 @@ export function instanceOfLeadEnrichmentDto(value: object): value is LeadEnrichm
101
127
  if (!('webSummary' in value) || value['webSummary'] === undefined) return false;
102
128
  if (!('webResults' in value) || value['webResults'] === undefined) return false;
103
129
  if (!('email' in value) || value['email'] === undefined) return false;
130
+ if (!('person' in value) || value['person'] === undefined) return false;
104
131
  if (!('company' in value) || value['company'] === undefined) return false;
105
132
  if (!('ip' in value) || value['ip'] === undefined) return false;
133
+ if (!('domain' in value) || value['domain'] === undefined) return false;
106
134
  return true;
107
135
  }
108
136
 
@@ -121,8 +149,10 @@ export function LeadEnrichmentDtoFromJSONTyped(json: any, ignoreDiscriminator: b
121
149
  'webSummary': json['webSummary'],
122
150
  'webResults': ((json['webResults'] as Array<any>).map(LeadEnrichmentWebResultDtoFromJSON)),
123
151
  'email': LeadEnrichmentEmailDtoFromJSON(json['email']),
152
+ 'person': LeadEnrichmentPersonDtoFromJSON(json['person']),
124
153
  'company': LeadEnrichmentCompanyDtoFromJSON(json['company']),
125
154
  'ip': LeadEnrichmentIpDtoFromJSON(json['ip']),
155
+ 'domain': LeadEnrichmentDomainDtoFromJSON(json['domain']),
126
156
  };
127
157
  }
128
158
 
@@ -142,8 +172,10 @@ export function LeadEnrichmentDtoToJSONTyped(value?: LeadEnrichmentDto | null, i
142
172
  'webSummary': value['webSummary'],
143
173
  'webResults': ((value['webResults'] as Array<any>).map(LeadEnrichmentWebResultDtoToJSON)),
144
174
  'email': LeadEnrichmentEmailDtoToJSON(value['email']),
175
+ 'person': LeadEnrichmentPersonDtoToJSON(value['person']),
145
176
  'company': LeadEnrichmentCompanyDtoToJSON(value['company']),
146
177
  'ip': LeadEnrichmentIpDtoToJSON(value['ip']),
178
+ 'domain': LeadEnrichmentDomainDtoToJSON(value['domain']),
147
179
  };
148
180
  }
149
181
 
@@ -31,12 +31,6 @@ export interface LeadEnrichmentEmailDto {
31
31
  * @memberof LeadEnrichmentEmailDto
32
32
  */
33
33
  isDisposable: boolean | null;
34
- /**
35
- *
36
- * @type {string}
37
- * @memberof LeadEnrichmentEmailDto
38
- */
39
- webSummary: string | null;
40
34
  }
41
35
 
42
36
  /**
@@ -45,7 +39,6 @@ export interface LeadEnrichmentEmailDto {
45
39
  export function instanceOfLeadEnrichmentEmailDto(value: object): value is LeadEnrichmentEmailDto {
46
40
  if (!('isFreeMail' in value) || value['isFreeMail'] === undefined) return false;
47
41
  if (!('isDisposable' in value) || value['isDisposable'] === undefined) return false;
48
- if (!('webSummary' in value) || value['webSummary'] === undefined) return false;
49
42
  return true;
50
43
  }
51
44
 
@@ -61,7 +54,6 @@ export function LeadEnrichmentEmailDtoFromJSONTyped(json: any, ignoreDiscriminat
61
54
 
62
55
  'isFreeMail': json['isFreeMail'],
63
56
  'isDisposable': json['isDisposable'],
64
- 'webSummary': json['webSummary'],
65
57
  };
66
58
  }
67
59
 
@@ -78,7 +70,6 @@ export function LeadEnrichmentEmailDtoToJSONTyped(value?: LeadEnrichmentEmailDto
78
70
 
79
71
  'isFreeMail': value['isFreeMail'],
80
72
  'isDisposable': value['isDisposable'],
81
- 'webSummary': value['webSummary'],
82
73
  };
83
74
  }
84
75
 
@@ -0,0 +1,125 @@
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 { LeadEnrichmentWebResultDto } from './LeadEnrichmentWebResultDto';
17
+ import {
18
+ LeadEnrichmentWebResultDtoFromJSON,
19
+ LeadEnrichmentWebResultDtoFromJSONTyped,
20
+ LeadEnrichmentWebResultDtoToJSON,
21
+ LeadEnrichmentWebResultDtoToJSONTyped,
22
+ } from './LeadEnrichmentWebResultDto';
23
+
24
+ /**
25
+ *
26
+ * @export
27
+ * @interface LeadEnrichmentPersonDto
28
+ */
29
+ export interface LeadEnrichmentPersonDto {
30
+ /**
31
+ * Lifecycle of the person record. "awaiting" means the mailbox classification has not yet settled whether this buyer is worth researching — not a failure. "not_found" covers both a search that surfaced nothing and a mailbox skipped as disposable.
32
+ * @type {string}
33
+ * @memberof LeadEnrichmentPersonDto
34
+ */
35
+ status: LeadEnrichmentPersonDtoStatusEnum;
36
+ /**
37
+ * Buyer-stated name the search ran on; unverified.
38
+ * @type {string}
39
+ * @memberof LeadEnrichmentPersonDto
40
+ */
41
+ statedName: string | null;
42
+ /**
43
+ * Buyer-stated company; unverified.
44
+ * @type {string}
45
+ * @memberof LeadEnrichmentPersonDto
46
+ */
47
+ statedCompany: string | null;
48
+ /**
49
+ * Summary of the buyer's public web footprint; null until researched, or when nothing surfaced.
50
+ * @type {string}
51
+ * @memberof LeadEnrichmentPersonDto
52
+ */
53
+ webSummary: string | null;
54
+ /**
55
+ * Sources behind `webSummary`.
56
+ * @type {Array<LeadEnrichmentWebResultDto>}
57
+ * @memberof LeadEnrichmentPersonDto
58
+ */
59
+ webResults: Array<LeadEnrichmentWebResultDto>;
60
+ }
61
+
62
+
63
+ /**
64
+ * @export
65
+ */
66
+ export const LeadEnrichmentPersonDtoStatusEnum = {
67
+ AWAITING: 'awaiting',
68
+ PENDING: 'pending',
69
+ ENRICHING: 'enriching',
70
+ ENRICHED: 'enriched',
71
+ NOT_FOUND: 'not_found',
72
+ FAILED: 'failed'
73
+ } as const;
74
+ export type LeadEnrichmentPersonDtoStatusEnum = typeof LeadEnrichmentPersonDtoStatusEnum[keyof typeof LeadEnrichmentPersonDtoStatusEnum];
75
+
76
+
77
+ /**
78
+ * Check if a given object implements the LeadEnrichmentPersonDto interface.
79
+ */
80
+ export function instanceOfLeadEnrichmentPersonDto(value: object): value is LeadEnrichmentPersonDto {
81
+ if (!('status' in value) || value['status'] === undefined) return false;
82
+ if (!('statedName' in value) || value['statedName'] === undefined) return false;
83
+ if (!('statedCompany' in value) || value['statedCompany'] === undefined) return false;
84
+ if (!('webSummary' in value) || value['webSummary'] === undefined) return false;
85
+ if (!('webResults' in value) || value['webResults'] === undefined) return false;
86
+ return true;
87
+ }
88
+
89
+ export function LeadEnrichmentPersonDtoFromJSON(json: any): LeadEnrichmentPersonDto {
90
+ return LeadEnrichmentPersonDtoFromJSONTyped(json, false);
91
+ }
92
+
93
+ export function LeadEnrichmentPersonDtoFromJSONTyped(json: any, ignoreDiscriminator: boolean): LeadEnrichmentPersonDto {
94
+ if (json == null) {
95
+ return json;
96
+ }
97
+ return {
98
+
99
+ 'status': json['status'],
100
+ 'statedName': json['statedName'],
101
+ 'statedCompany': json['statedCompany'],
102
+ 'webSummary': json['webSummary'],
103
+ 'webResults': ((json['webResults'] as Array<any>).map(LeadEnrichmentWebResultDtoFromJSON)),
104
+ };
105
+ }
106
+
107
+ export function LeadEnrichmentPersonDtoToJSON(json: any): LeadEnrichmentPersonDto {
108
+ return LeadEnrichmentPersonDtoToJSONTyped(json, false);
109
+ }
110
+
111
+ export function LeadEnrichmentPersonDtoToJSONTyped(value?: LeadEnrichmentPersonDto | null, ignoreDiscriminator: boolean = false): any {
112
+ if (value == null) {
113
+ return value;
114
+ }
115
+
116
+ return {
117
+
118
+ 'status': value['status'],
119
+ 'statedName': value['statedName'],
120
+ 'statedCompany': value['statedCompany'],
121
+ 'webSummary': value['webSummary'],
122
+ 'webResults': ((value['webResults'] as Array<any>).map(LeadEnrichmentWebResultDtoToJSON)),
123
+ };
124
+ }
125
+
@@ -76,6 +76,7 @@ export * from './AirwallexDepositDtoFee';
76
76
  export * from './ApiKeyDto';
77
77
  export * from './ApiKeyScopeDto';
78
78
  export * from './ApplyDomainEditInput';
79
+ export * from './AssociateLeadVisitorInput';
79
80
  export * from './AuBankAccountDetails';
80
81
  export * from './AuctionBidDto';
81
82
  export * from './AuctionBidInput';
@@ -294,9 +295,12 @@ export * from './LeadBuyerConfigDto';
294
295
  export * from './LeadDomainDto';
295
296
  export * from './LeadDto';
296
297
  export * from './LeadEnrichmentCompanyDto';
298
+ export * from './LeadEnrichmentDomainDto';
299
+ export * from './LeadEnrichmentDomainVariantDto';
297
300
  export * from './LeadEnrichmentDto';
298
301
  export * from './LeadEnrichmentEmailDto';
299
302
  export * from './LeadEnrichmentIpDto';
303
+ export * from './LeadEnrichmentPersonDto';
300
304
  export * from './LeadEnrichmentWebResultDto';
301
305
  export * from './LeadLeaseToOwnAndRentConfigurationPresetsDto';
302
306
  export * from './LeadLeaseToOwnConfigurationDto';