@randock/nameshift-api-client 0.0.467 → 0.0.469
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.
- package/.openapi-generator/FILES +5 -0
- package/README.md +3 -3
- package/dist/models/LeadEnrichmentActivityDto.d.ts +52 -0
- package/dist/models/LeadEnrichmentActivityDto.js +65 -0
- package/dist/models/LeadEnrichmentCompanyDto.d.ts +0 -6
- package/dist/models/LeadEnrichmentCompanyDto.js +0 -4
- package/dist/models/LeadEnrichmentDomainDto.d.ts +6 -0
- package/dist/models/LeadEnrichmentDomainDto.js +4 -0
- package/dist/models/LeadEnrichmentDomainFactsDto.d.ts +72 -0
- package/dist/models/LeadEnrichmentDomainFactsDto.js +81 -0
- package/dist/models/LeadEnrichmentDomainVariantDto.d.ts +0 -6
- package/dist/models/LeadEnrichmentDomainVariantDto.js +0 -4
- package/dist/models/LeadEnrichmentDto.d.ts +33 -0
- package/dist/models/LeadEnrichmentDto.js +23 -0
- package/dist/models/LeadEnrichmentEmailDto.d.ts +6 -0
- package/dist/models/LeadEnrichmentEmailDto.js +4 -0
- package/dist/models/LeadEnrichmentIpDto.d.ts +42 -0
- package/dist/models/LeadEnrichmentIpDto.js +28 -0
- package/dist/models/LeadEnrichmentNamesakeDto.d.ts +68 -0
- package/dist/models/LeadEnrichmentNamesakeDto.js +75 -0
- package/dist/models/LeadEnrichmentOfferDto.d.ts +44 -0
- package/dist/models/LeadEnrichmentOfferDto.js +59 -0
- package/dist/models/LeadEnrichmentPersonDto.d.ts +6 -0
- package/dist/models/LeadEnrichmentPersonDto.js +4 -0
- package/dist/models/LeadEnrichmentVisitedDomainDto.d.ts +44 -0
- package/dist/models/LeadEnrichmentVisitedDomainDto.js +59 -0
- package/dist/models/index.d.ts +5 -0
- package/dist/models/index.js +5 -0
- package/package.json +1 -1
- package/src/models/LeadEnrichmentActivityDto.ts +108 -0
- package/src/models/LeadEnrichmentCompanyDto.ts +0 -9
- package/src/models/LeadEnrichmentDomainDto.ts +9 -0
- package/src/models/LeadEnrichmentDomainFactsDto.ts +124 -0
- package/src/models/LeadEnrichmentDomainVariantDto.ts +0 -9
- package/src/models/LeadEnrichmentDto.ts +66 -0
- package/src/models/LeadEnrichmentEmailDto.ts +9 -0
- package/src/models/LeadEnrichmentIpDto.ts +63 -0
- package/src/models/LeadEnrichmentNamesakeDto.ts +120 -0
- package/src/models/LeadEnrichmentOfferDto.ts +84 -0
- package/src/models/LeadEnrichmentPersonDto.ts +9 -0
- package/src/models/LeadEnrichmentVisitedDomainDto.ts +84 -0
- package/src/models/index.ts +5 -0
package/.openapi-generator/FILES
CHANGED
|
@@ -332,13 +332,18 @@ src/models/LandingPageSettingsDto.ts
|
|
|
332
332
|
src/models/LeadBuyerConfigDto.ts
|
|
333
333
|
src/models/LeadDomainDto.ts
|
|
334
334
|
src/models/LeadDto.ts
|
|
335
|
+
src/models/LeadEnrichmentActivityDto.ts
|
|
335
336
|
src/models/LeadEnrichmentCompanyDto.ts
|
|
336
337
|
src/models/LeadEnrichmentDomainDto.ts
|
|
338
|
+
src/models/LeadEnrichmentDomainFactsDto.ts
|
|
337
339
|
src/models/LeadEnrichmentDomainVariantDto.ts
|
|
338
340
|
src/models/LeadEnrichmentDto.ts
|
|
339
341
|
src/models/LeadEnrichmentEmailDto.ts
|
|
340
342
|
src/models/LeadEnrichmentIpDto.ts
|
|
343
|
+
src/models/LeadEnrichmentNamesakeDto.ts
|
|
344
|
+
src/models/LeadEnrichmentOfferDto.ts
|
|
341
345
|
src/models/LeadEnrichmentPersonDto.ts
|
|
346
|
+
src/models/LeadEnrichmentVisitedDomainDto.ts
|
|
342
347
|
src/models/LeadEnrichmentWebResultDto.ts
|
|
343
348
|
src/models/LeadLeaseToOwnAndRentConfigurationPresetsDto.ts
|
|
344
349
|
src/models/LeadLeaseToOwnConfigurationDto.ts
|
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
## @randock/nameshift-api-client@0.0.
|
|
1
|
+
## @randock/nameshift-api-client@0.0.469
|
|
2
2
|
|
|
3
3
|
This generator creates TypeScript/JavaScript client that utilizes [Fetch API](https://fetch.spec.whatwg.org/). The generated Node module can be used in the following environments:
|
|
4
4
|
|
|
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
|
|
|
36
36
|
_published:_
|
|
37
37
|
|
|
38
38
|
```
|
|
39
|
-
npm install @randock/nameshift-api-client@0.0.
|
|
39
|
+
npm install @randock/nameshift-api-client@0.0.469 --save
|
|
40
40
|
```
|
|
41
41
|
|
|
42
42
|
_unPublished (not recommended):_
|
|
@@ -44,4 +44,4 @@ _unPublished (not recommended):_
|
|
|
44
44
|
```
|
|
45
45
|
npm install PATH_TO_GENERATED_PACKAGE --save
|
|
46
46
|
```
|
|
47
|
-
|
|
47
|
+
59b10950130e79723395fbb034a4f3797821f955fc68520694222c8685ce3fae94a3243c3203aa757ea512bffee338e3
|
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Nameshift
|
|
3
|
+
* 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.
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 1.0
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import type { LeadEnrichmentVisitedDomainDto } from './LeadEnrichmentVisitedDomainDto';
|
|
13
|
+
import type { LeadEnrichmentOfferDto } from './LeadEnrichmentOfferDto';
|
|
14
|
+
/**
|
|
15
|
+
*
|
|
16
|
+
* @export
|
|
17
|
+
* @interface LeadEnrichmentActivityDto
|
|
18
|
+
*/
|
|
19
|
+
export interface LeadEnrichmentActivityDto {
|
|
20
|
+
/**
|
|
21
|
+
* Total pageviews across every session attributed to the buyer.
|
|
22
|
+
* @type {number}
|
|
23
|
+
* @memberof LeadEnrichmentActivityDto
|
|
24
|
+
*/
|
|
25
|
+
pageviews: number;
|
|
26
|
+
/**
|
|
27
|
+
* How many different pages of the domain they looked at.
|
|
28
|
+
* @type {number}
|
|
29
|
+
* @memberof LeadEnrichmentActivityDto
|
|
30
|
+
*/
|
|
31
|
+
distinctPages: number;
|
|
32
|
+
/**
|
|
33
|
+
* Offer amounts entered on the buy box, newest first.
|
|
34
|
+
* @type {Array<LeadEnrichmentOfferDto>}
|
|
35
|
+
* @memberof LeadEnrichmentActivityDto
|
|
36
|
+
*/
|
|
37
|
+
offers: Array<LeadEnrichmentOfferDto>;
|
|
38
|
+
/**
|
|
39
|
+
* Other domains of ours this buyer looked at, busiest first. Covers everything after they were identified, plus what they did while still anonymous on a domain they submitted something on — submitting is what captured that domain's session id. Anonymous browsing on domains they never engaged with is not visible.
|
|
40
|
+
* @type {Array<LeadEnrichmentVisitedDomainDto>}
|
|
41
|
+
* @memberof LeadEnrichmentActivityDto
|
|
42
|
+
*/
|
|
43
|
+
otherDomains: Array<LeadEnrichmentVisitedDomainDto>;
|
|
44
|
+
}
|
|
45
|
+
/**
|
|
46
|
+
* Check if a given object implements the LeadEnrichmentActivityDto interface.
|
|
47
|
+
*/
|
|
48
|
+
export declare function instanceOfLeadEnrichmentActivityDto(value: object): value is LeadEnrichmentActivityDto;
|
|
49
|
+
export declare function LeadEnrichmentActivityDtoFromJSON(json: any): LeadEnrichmentActivityDto;
|
|
50
|
+
export declare function LeadEnrichmentActivityDtoFromJSONTyped(json: any, ignoreDiscriminator: boolean): LeadEnrichmentActivityDto;
|
|
51
|
+
export declare function LeadEnrichmentActivityDtoToJSON(json: any): LeadEnrichmentActivityDto;
|
|
52
|
+
export declare function LeadEnrichmentActivityDtoToJSONTyped(value?: LeadEnrichmentActivityDto | null, ignoreDiscriminator?: boolean): any;
|
|
@@ -0,0 +1,65 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* Nameshift
|
|
6
|
+
* 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.
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: 1.0
|
|
9
|
+
*
|
|
10
|
+
*
|
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
+
* https://openapi-generator.tech
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*/
|
|
15
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
16
|
+
exports.instanceOfLeadEnrichmentActivityDto = instanceOfLeadEnrichmentActivityDto;
|
|
17
|
+
exports.LeadEnrichmentActivityDtoFromJSON = LeadEnrichmentActivityDtoFromJSON;
|
|
18
|
+
exports.LeadEnrichmentActivityDtoFromJSONTyped = LeadEnrichmentActivityDtoFromJSONTyped;
|
|
19
|
+
exports.LeadEnrichmentActivityDtoToJSON = LeadEnrichmentActivityDtoToJSON;
|
|
20
|
+
exports.LeadEnrichmentActivityDtoToJSONTyped = LeadEnrichmentActivityDtoToJSONTyped;
|
|
21
|
+
var LeadEnrichmentVisitedDomainDto_1 = require("./LeadEnrichmentVisitedDomainDto");
|
|
22
|
+
var LeadEnrichmentOfferDto_1 = require("./LeadEnrichmentOfferDto");
|
|
23
|
+
/**
|
|
24
|
+
* Check if a given object implements the LeadEnrichmentActivityDto interface.
|
|
25
|
+
*/
|
|
26
|
+
function instanceOfLeadEnrichmentActivityDto(value) {
|
|
27
|
+
if (!('pageviews' in value) || value['pageviews'] === undefined)
|
|
28
|
+
return false;
|
|
29
|
+
if (!('distinctPages' in value) || value['distinctPages'] === undefined)
|
|
30
|
+
return false;
|
|
31
|
+
if (!('offers' in value) || value['offers'] === undefined)
|
|
32
|
+
return false;
|
|
33
|
+
if (!('otherDomains' in value) || value['otherDomains'] === undefined)
|
|
34
|
+
return false;
|
|
35
|
+
return true;
|
|
36
|
+
}
|
|
37
|
+
function LeadEnrichmentActivityDtoFromJSON(json) {
|
|
38
|
+
return LeadEnrichmentActivityDtoFromJSONTyped(json, false);
|
|
39
|
+
}
|
|
40
|
+
function LeadEnrichmentActivityDtoFromJSONTyped(json, ignoreDiscriminator) {
|
|
41
|
+
if (json == null) {
|
|
42
|
+
return json;
|
|
43
|
+
}
|
|
44
|
+
return {
|
|
45
|
+
'pageviews': json['pageviews'],
|
|
46
|
+
'distinctPages': json['distinctPages'],
|
|
47
|
+
'offers': (json['offers'].map(LeadEnrichmentOfferDto_1.LeadEnrichmentOfferDtoFromJSON)),
|
|
48
|
+
'otherDomains': (json['otherDomains'].map(LeadEnrichmentVisitedDomainDto_1.LeadEnrichmentVisitedDomainDtoFromJSON)),
|
|
49
|
+
};
|
|
50
|
+
}
|
|
51
|
+
function LeadEnrichmentActivityDtoToJSON(json) {
|
|
52
|
+
return LeadEnrichmentActivityDtoToJSONTyped(json, false);
|
|
53
|
+
}
|
|
54
|
+
function LeadEnrichmentActivityDtoToJSONTyped(value, ignoreDiscriminator) {
|
|
55
|
+
if (ignoreDiscriminator === void 0) { ignoreDiscriminator = false; }
|
|
56
|
+
if (value == null) {
|
|
57
|
+
return value;
|
|
58
|
+
}
|
|
59
|
+
return {
|
|
60
|
+
'pageviews': value['pageviews'],
|
|
61
|
+
'distinctPages': value['distinctPages'],
|
|
62
|
+
'offers': (value['offers'].map(LeadEnrichmentOfferDto_1.LeadEnrichmentOfferDtoToJSON)),
|
|
63
|
+
'otherDomains': (value['otherDomains'].map(LeadEnrichmentVisitedDomainDto_1.LeadEnrichmentVisitedDomainDtoToJSON)),
|
|
64
|
+
};
|
|
65
|
+
}
|
|
@@ -51,12 +51,6 @@ export interface LeadEnrichmentCompanyDto {
|
|
|
51
51
|
* @memberof LeadEnrichmentCompanyDto
|
|
52
52
|
*/
|
|
53
53
|
registryId: string | null;
|
|
54
|
-
/**
|
|
55
|
-
*
|
|
56
|
-
* @type {string}
|
|
57
|
-
* @memberof LeadEnrichmentCompanyDto
|
|
58
|
-
*/
|
|
59
|
-
domainRegisteredAt: string | null;
|
|
60
54
|
}
|
|
61
55
|
/**
|
|
62
56
|
* Check if a given object implements the LeadEnrichmentCompanyDto interface.
|
|
@@ -34,8 +34,6 @@ function instanceOfLeadEnrichmentCompanyDto(value) {
|
|
|
34
34
|
return false;
|
|
35
35
|
if (!('registryId' in value) || value['registryId'] === undefined)
|
|
36
36
|
return false;
|
|
37
|
-
if (!('domainRegisteredAt' in value) || value['domainRegisteredAt'] === undefined)
|
|
38
|
-
return false;
|
|
39
37
|
return true;
|
|
40
38
|
}
|
|
41
39
|
function LeadEnrichmentCompanyDtoFromJSON(json) {
|
|
@@ -52,7 +50,6 @@ function LeadEnrichmentCompanyDtoFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
52
50
|
'countryCode': json['countryCode'],
|
|
53
51
|
'vatId': json['vatId'],
|
|
54
52
|
'registryId': json['registryId'],
|
|
55
|
-
'domainRegisteredAt': json['domainRegisteredAt'],
|
|
56
53
|
};
|
|
57
54
|
}
|
|
58
55
|
function LeadEnrichmentCompanyDtoToJSON(json) {
|
|
@@ -70,6 +67,5 @@ function LeadEnrichmentCompanyDtoToJSONTyped(value, ignoreDiscriminator) {
|
|
|
70
67
|
'countryCode': value['countryCode'],
|
|
71
68
|
'vatId': value['vatId'],
|
|
72
69
|
'registryId': value['registryId'],
|
|
73
|
-
'domainRegisteredAt': value['domainRegisteredAt'],
|
|
74
70
|
};
|
|
75
71
|
}
|
|
@@ -28,6 +28,12 @@ export interface LeadEnrichmentDomainDto {
|
|
|
28
28
|
* @memberof LeadEnrichmentDomainDto
|
|
29
29
|
*/
|
|
30
30
|
variants: Array<LeadEnrichmentDomainVariantDto>;
|
|
31
|
+
/**
|
|
32
|
+
* When this record was last enriched.
|
|
33
|
+
* @type {string}
|
|
34
|
+
* @memberof LeadEnrichmentDomainDto
|
|
35
|
+
*/
|
|
36
|
+
enrichedAt: string | null;
|
|
31
37
|
}
|
|
32
38
|
/**
|
|
33
39
|
* Check if a given object implements the LeadEnrichmentDomainDto interface.
|
|
@@ -27,6 +27,8 @@ function instanceOfLeadEnrichmentDomainDto(value) {
|
|
|
27
27
|
return false;
|
|
28
28
|
if (!('variants' in value) || value['variants'] === undefined)
|
|
29
29
|
return false;
|
|
30
|
+
if (!('enrichedAt' in value) || value['enrichedAt'] === undefined)
|
|
31
|
+
return false;
|
|
30
32
|
return true;
|
|
31
33
|
}
|
|
32
34
|
function LeadEnrichmentDomainDtoFromJSON(json) {
|
|
@@ -39,6 +41,7 @@ function LeadEnrichmentDomainDtoFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
39
41
|
return {
|
|
40
42
|
'status': json['status'],
|
|
41
43
|
'variants': (json['variants'].map(LeadEnrichmentDomainVariantDto_1.LeadEnrichmentDomainVariantDtoFromJSON)),
|
|
44
|
+
'enrichedAt': json['enrichedAt'],
|
|
42
45
|
};
|
|
43
46
|
}
|
|
44
47
|
function LeadEnrichmentDomainDtoToJSON(json) {
|
|
@@ -52,5 +55,6 @@ function LeadEnrichmentDomainDtoToJSONTyped(value, ignoreDiscriminator) {
|
|
|
52
55
|
return {
|
|
53
56
|
'status': value['status'],
|
|
54
57
|
'variants': (value['variants'].map(LeadEnrichmentDomainVariantDto_1.LeadEnrichmentDomainVariantDtoToJSON)),
|
|
58
|
+
'enrichedAt': value['enrichedAt'],
|
|
55
59
|
};
|
|
56
60
|
}
|
|
@@ -0,0 +1,72 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Nameshift
|
|
3
|
+
* 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.
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 1.0
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
/**
|
|
13
|
+
*
|
|
14
|
+
* @export
|
|
15
|
+
* @interface LeadEnrichmentDomainFactsDto
|
|
16
|
+
*/
|
|
17
|
+
export interface LeadEnrichmentDomainFactsDto {
|
|
18
|
+
/**
|
|
19
|
+
*
|
|
20
|
+
* @type {string}
|
|
21
|
+
* @memberof LeadEnrichmentDomainFactsDto
|
|
22
|
+
*/
|
|
23
|
+
status: string;
|
|
24
|
+
/**
|
|
25
|
+
* Mail-setup classification: corporate MX is the strongest cheap signal a real organization operates the domain.
|
|
26
|
+
* @type {string}
|
|
27
|
+
* @memberof LeadEnrichmentDomainFactsDto
|
|
28
|
+
*/
|
|
29
|
+
domainType: LeadEnrichmentDomainFactsDtoDomainTypeEnum | null;
|
|
30
|
+
/**
|
|
31
|
+
*
|
|
32
|
+
* @type {string}
|
|
33
|
+
* @memberof LeadEnrichmentDomainFactsDto
|
|
34
|
+
*/
|
|
35
|
+
registeredAt: string | null;
|
|
36
|
+
/**
|
|
37
|
+
* Registry nameservers, normalized.
|
|
38
|
+
* @type {Array<string>}
|
|
39
|
+
* @memberof LeadEnrichmentDomainFactsDto
|
|
40
|
+
*/
|
|
41
|
+
nameservers: Array<string>;
|
|
42
|
+
/**
|
|
43
|
+
*
|
|
44
|
+
* @type {boolean}
|
|
45
|
+
* @memberof LeadEnrichmentDomainFactsDto
|
|
46
|
+
*/
|
|
47
|
+
websiteReachable: boolean | null;
|
|
48
|
+
/**
|
|
49
|
+
* When this record was last enriched.
|
|
50
|
+
* @type {string}
|
|
51
|
+
* @memberof LeadEnrichmentDomainFactsDto
|
|
52
|
+
*/
|
|
53
|
+
enrichedAt: string | null;
|
|
54
|
+
}
|
|
55
|
+
/**
|
|
56
|
+
* @export
|
|
57
|
+
*/
|
|
58
|
+
export declare const LeadEnrichmentDomainFactsDtoDomainTypeEnum: {
|
|
59
|
+
readonly CORPORATE: "corporate";
|
|
60
|
+
readonly FREE_MAIL: "free_mail";
|
|
61
|
+
readonly DISPOSABLE: "disposable";
|
|
62
|
+
readonly UNKNOWN: "unknown";
|
|
63
|
+
};
|
|
64
|
+
export type LeadEnrichmentDomainFactsDtoDomainTypeEnum = typeof LeadEnrichmentDomainFactsDtoDomainTypeEnum[keyof typeof LeadEnrichmentDomainFactsDtoDomainTypeEnum];
|
|
65
|
+
/**
|
|
66
|
+
* Check if a given object implements the LeadEnrichmentDomainFactsDto interface.
|
|
67
|
+
*/
|
|
68
|
+
export declare function instanceOfLeadEnrichmentDomainFactsDto(value: object): value is LeadEnrichmentDomainFactsDto;
|
|
69
|
+
export declare function LeadEnrichmentDomainFactsDtoFromJSON(json: any): LeadEnrichmentDomainFactsDto;
|
|
70
|
+
export declare function LeadEnrichmentDomainFactsDtoFromJSONTyped(json: any, ignoreDiscriminator: boolean): LeadEnrichmentDomainFactsDto;
|
|
71
|
+
export declare function LeadEnrichmentDomainFactsDtoToJSON(json: any): LeadEnrichmentDomainFactsDto;
|
|
72
|
+
export declare function LeadEnrichmentDomainFactsDtoToJSONTyped(value?: LeadEnrichmentDomainFactsDto | null, ignoreDiscriminator?: boolean): any;
|
|
@@ -0,0 +1,81 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* Nameshift
|
|
6
|
+
* 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.
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: 1.0
|
|
9
|
+
*
|
|
10
|
+
*
|
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
+
* https://openapi-generator.tech
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*/
|
|
15
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
16
|
+
exports.LeadEnrichmentDomainFactsDtoDomainTypeEnum = void 0;
|
|
17
|
+
exports.instanceOfLeadEnrichmentDomainFactsDto = instanceOfLeadEnrichmentDomainFactsDto;
|
|
18
|
+
exports.LeadEnrichmentDomainFactsDtoFromJSON = LeadEnrichmentDomainFactsDtoFromJSON;
|
|
19
|
+
exports.LeadEnrichmentDomainFactsDtoFromJSONTyped = LeadEnrichmentDomainFactsDtoFromJSONTyped;
|
|
20
|
+
exports.LeadEnrichmentDomainFactsDtoToJSON = LeadEnrichmentDomainFactsDtoToJSON;
|
|
21
|
+
exports.LeadEnrichmentDomainFactsDtoToJSONTyped = LeadEnrichmentDomainFactsDtoToJSONTyped;
|
|
22
|
+
/**
|
|
23
|
+
* @export
|
|
24
|
+
*/
|
|
25
|
+
exports.LeadEnrichmentDomainFactsDtoDomainTypeEnum = {
|
|
26
|
+
CORPORATE: 'corporate',
|
|
27
|
+
FREE_MAIL: 'free_mail',
|
|
28
|
+
DISPOSABLE: 'disposable',
|
|
29
|
+
UNKNOWN: 'unknown'
|
|
30
|
+
};
|
|
31
|
+
/**
|
|
32
|
+
* Check if a given object implements the LeadEnrichmentDomainFactsDto interface.
|
|
33
|
+
*/
|
|
34
|
+
function instanceOfLeadEnrichmentDomainFactsDto(value) {
|
|
35
|
+
if (!('status' in value) || value['status'] === undefined)
|
|
36
|
+
return false;
|
|
37
|
+
if (!('domainType' in value) || value['domainType'] === undefined)
|
|
38
|
+
return false;
|
|
39
|
+
if (!('registeredAt' in value) || value['registeredAt'] === undefined)
|
|
40
|
+
return false;
|
|
41
|
+
if (!('nameservers' in value) || value['nameservers'] === undefined)
|
|
42
|
+
return false;
|
|
43
|
+
if (!('websiteReachable' in value) || value['websiteReachable'] === undefined)
|
|
44
|
+
return false;
|
|
45
|
+
if (!('enrichedAt' in value) || value['enrichedAt'] === undefined)
|
|
46
|
+
return false;
|
|
47
|
+
return true;
|
|
48
|
+
}
|
|
49
|
+
function LeadEnrichmentDomainFactsDtoFromJSON(json) {
|
|
50
|
+
return LeadEnrichmentDomainFactsDtoFromJSONTyped(json, false);
|
|
51
|
+
}
|
|
52
|
+
function LeadEnrichmentDomainFactsDtoFromJSONTyped(json, ignoreDiscriminator) {
|
|
53
|
+
if (json == null) {
|
|
54
|
+
return json;
|
|
55
|
+
}
|
|
56
|
+
return {
|
|
57
|
+
'status': json['status'],
|
|
58
|
+
'domainType': json['domainType'],
|
|
59
|
+
'registeredAt': json['registeredAt'],
|
|
60
|
+
'nameservers': json['nameservers'],
|
|
61
|
+
'websiteReachable': json['websiteReachable'],
|
|
62
|
+
'enrichedAt': json['enrichedAt'],
|
|
63
|
+
};
|
|
64
|
+
}
|
|
65
|
+
function LeadEnrichmentDomainFactsDtoToJSON(json) {
|
|
66
|
+
return LeadEnrichmentDomainFactsDtoToJSONTyped(json, false);
|
|
67
|
+
}
|
|
68
|
+
function LeadEnrichmentDomainFactsDtoToJSONTyped(value, ignoreDiscriminator) {
|
|
69
|
+
if (ignoreDiscriminator === void 0) { ignoreDiscriminator = false; }
|
|
70
|
+
if (value == null) {
|
|
71
|
+
return value;
|
|
72
|
+
}
|
|
73
|
+
return {
|
|
74
|
+
'status': value['status'],
|
|
75
|
+
'domainType': value['domainType'],
|
|
76
|
+
'registeredAt': value['registeredAt'],
|
|
77
|
+
'nameservers': value['nameservers'],
|
|
78
|
+
'websiteReachable': value['websiteReachable'],
|
|
79
|
+
'enrichedAt': value['enrichedAt'],
|
|
80
|
+
};
|
|
81
|
+
}
|
|
@@ -33,12 +33,6 @@ export interface LeadEnrichmentDomainVariantDto {
|
|
|
33
33
|
* @memberof LeadEnrichmentDomainVariantDto
|
|
34
34
|
*/
|
|
35
35
|
websiteReachable: boolean;
|
|
36
|
-
/**
|
|
37
|
-
* Whether the variant's nameservers match the sale domain's.
|
|
38
|
-
* @type {boolean}
|
|
39
|
-
* @memberof LeadEnrichmentDomainVariantDto
|
|
40
|
-
*/
|
|
41
|
-
sameNameservers: boolean | null;
|
|
42
36
|
/**
|
|
43
37
|
* Whether the variant is openly for sale (marketplace parking or a _for-sale record).
|
|
44
38
|
* @type {boolean}
|
|
@@ -28,8 +28,6 @@ function instanceOfLeadEnrichmentDomainVariantDto(value) {
|
|
|
28
28
|
return false;
|
|
29
29
|
if (!('websiteReachable' in value) || value['websiteReachable'] === undefined)
|
|
30
30
|
return false;
|
|
31
|
-
if (!('sameNameservers' in value) || value['sameNameservers'] === undefined)
|
|
32
|
-
return false;
|
|
33
31
|
if (!('forSale' in value) || value['forSale'] === undefined)
|
|
34
32
|
return false;
|
|
35
33
|
if (!('forSaleMarketplace' in value) || value['forSaleMarketplace'] === undefined)
|
|
@@ -51,7 +49,6 @@ function LeadEnrichmentDomainVariantDtoFromJSONTyped(json, ignoreDiscriminator)
|
|
|
51
49
|
'domain': json['domain'],
|
|
52
50
|
'registered': json['registered'],
|
|
53
51
|
'websiteReachable': json['websiteReachable'],
|
|
54
|
-
'sameNameservers': json['sameNameservers'],
|
|
55
52
|
'forSale': json['forSale'],
|
|
56
53
|
'forSaleMarketplace': json['forSaleMarketplace'],
|
|
57
54
|
'forSalePriceAmount': json['forSalePriceAmount'],
|
|
@@ -70,7 +67,6 @@ function LeadEnrichmentDomainVariantDtoToJSONTyped(value, ignoreDiscriminator) {
|
|
|
70
67
|
'domain': value['domain'],
|
|
71
68
|
'registered': value['registered'],
|
|
72
69
|
'websiteReachable': value['websiteReachable'],
|
|
73
|
-
'sameNameservers': value['sameNameservers'],
|
|
74
70
|
'forSale': value['forSale'],
|
|
75
71
|
'forSaleMarketplace': value['forSaleMarketplace'],
|
|
76
72
|
'forSalePriceAmount': value['forSalePriceAmount'],
|
|
@@ -15,6 +15,9 @@ import type { LeadEnrichmentEmailDto } from './LeadEnrichmentEmailDto';
|
|
|
15
15
|
import type { LeadEnrichmentWebResultDto } from './LeadEnrichmentWebResultDto';
|
|
16
16
|
import type { LeadEnrichmentCompanyDto } from './LeadEnrichmentCompanyDto';
|
|
17
17
|
import type { LeadEnrichmentDomainDto } from './LeadEnrichmentDomainDto';
|
|
18
|
+
import type { LeadEnrichmentDomainFactsDto } from './LeadEnrichmentDomainFactsDto';
|
|
19
|
+
import type { LeadEnrichmentActivityDto } from './LeadEnrichmentActivityDto';
|
|
20
|
+
import type { LeadEnrichmentNamesakeDto } from './LeadEnrichmentNamesakeDto';
|
|
18
21
|
/**
|
|
19
22
|
*
|
|
20
23
|
* @export
|
|
@@ -45,6 +48,12 @@ export interface LeadEnrichmentDto {
|
|
|
45
48
|
* @memberof LeadEnrichmentDto
|
|
46
49
|
*/
|
|
47
50
|
webResults: Array<LeadEnrichmentWebResultDto>;
|
|
51
|
+
/**
|
|
52
|
+
* When the lead-scoped search last completed.
|
|
53
|
+
* @type {string}
|
|
54
|
+
* @memberof LeadEnrichmentDto
|
|
55
|
+
*/
|
|
56
|
+
enrichedAt: string | null;
|
|
48
57
|
/**
|
|
49
58
|
*
|
|
50
59
|
* @type {LeadEnrichmentEmailDto}
|
|
@@ -63,6 +72,18 @@ export interface LeadEnrichmentDto {
|
|
|
63
72
|
* @memberof LeadEnrichmentDto
|
|
64
73
|
*/
|
|
65
74
|
company: LeadEnrichmentCompanyDto | null;
|
|
75
|
+
/**
|
|
76
|
+
* The company, if any, using the sale domain's name — keyed by its registrable label, so every domain carrying the name shares the answer. A likely buyer signal and context on the name being sold.
|
|
77
|
+
* @type {LeadEnrichmentNamesakeDto}
|
|
78
|
+
* @memberof LeadEnrichmentDto
|
|
79
|
+
*/
|
|
80
|
+
namesake: LeadEnrichmentNamesakeDto | null;
|
|
81
|
+
/**
|
|
82
|
+
* The buyer email domain's infrastructure facts: mail classification, registration date, nameservers.
|
|
83
|
+
* @type {LeadEnrichmentDomainFactsDto}
|
|
84
|
+
* @memberof LeadEnrichmentDto
|
|
85
|
+
*/
|
|
86
|
+
domainFacts: LeadEnrichmentDomainFactsDto | null;
|
|
66
87
|
/**
|
|
67
88
|
*
|
|
68
89
|
* @type {LeadEnrichmentIpDto}
|
|
@@ -75,6 +96,18 @@ export interface LeadEnrichmentDto {
|
|
|
75
96
|
* @memberof LeadEnrichmentDto
|
|
76
97
|
*/
|
|
77
98
|
domain: LeadEnrichmentDomainDto | null;
|
|
99
|
+
/**
|
|
100
|
+
* Sale-domain variants whose registry nameservers equal the buyer's email-domain nameservers — a hint the buyer already holds them. Empty when nothing matches or either side's nameservers are unknown; shared hosting makes it a hint, not proof.
|
|
101
|
+
* @type {Array<string>}
|
|
102
|
+
* @memberof LeadEnrichmentDto
|
|
103
|
+
*/
|
|
104
|
+
buyerNameserverMatches: Array<string>;
|
|
105
|
+
/**
|
|
106
|
+
* On-site behaviour from analytics. Independent of `available`, which only reflects the enrichment service.
|
|
107
|
+
* @type {LeadEnrichmentActivityDto}
|
|
108
|
+
* @memberof LeadEnrichmentDto
|
|
109
|
+
*/
|
|
110
|
+
activity: LeadEnrichmentActivityDto | null;
|
|
78
111
|
}
|
|
79
112
|
/**
|
|
80
113
|
* Check if a given object implements the LeadEnrichmentDto interface.
|
|
@@ -24,6 +24,9 @@ var LeadEnrichmentEmailDto_1 = require("./LeadEnrichmentEmailDto");
|
|
|
24
24
|
var LeadEnrichmentWebResultDto_1 = require("./LeadEnrichmentWebResultDto");
|
|
25
25
|
var LeadEnrichmentCompanyDto_1 = require("./LeadEnrichmentCompanyDto");
|
|
26
26
|
var LeadEnrichmentDomainDto_1 = require("./LeadEnrichmentDomainDto");
|
|
27
|
+
var LeadEnrichmentDomainFactsDto_1 = require("./LeadEnrichmentDomainFactsDto");
|
|
28
|
+
var LeadEnrichmentActivityDto_1 = require("./LeadEnrichmentActivityDto");
|
|
29
|
+
var LeadEnrichmentNamesakeDto_1 = require("./LeadEnrichmentNamesakeDto");
|
|
27
30
|
/**
|
|
28
31
|
* Check if a given object implements the LeadEnrichmentDto interface.
|
|
29
32
|
*/
|
|
@@ -36,16 +39,26 @@ function instanceOfLeadEnrichmentDto(value) {
|
|
|
36
39
|
return false;
|
|
37
40
|
if (!('webResults' in value) || value['webResults'] === undefined)
|
|
38
41
|
return false;
|
|
42
|
+
if (!('enrichedAt' in value) || value['enrichedAt'] === undefined)
|
|
43
|
+
return false;
|
|
39
44
|
if (!('email' in value) || value['email'] === undefined)
|
|
40
45
|
return false;
|
|
41
46
|
if (!('person' in value) || value['person'] === undefined)
|
|
42
47
|
return false;
|
|
43
48
|
if (!('company' in value) || value['company'] === undefined)
|
|
44
49
|
return false;
|
|
50
|
+
if (!('namesake' in value) || value['namesake'] === undefined)
|
|
51
|
+
return false;
|
|
52
|
+
if (!('domainFacts' in value) || value['domainFacts'] === undefined)
|
|
53
|
+
return false;
|
|
45
54
|
if (!('ip' in value) || value['ip'] === undefined)
|
|
46
55
|
return false;
|
|
47
56
|
if (!('domain' in value) || value['domain'] === undefined)
|
|
48
57
|
return false;
|
|
58
|
+
if (!('buyerNameserverMatches' in value) || value['buyerNameserverMatches'] === undefined)
|
|
59
|
+
return false;
|
|
60
|
+
if (!('activity' in value) || value['activity'] === undefined)
|
|
61
|
+
return false;
|
|
49
62
|
return true;
|
|
50
63
|
}
|
|
51
64
|
function LeadEnrichmentDtoFromJSON(json) {
|
|
@@ -60,11 +73,16 @@ function LeadEnrichmentDtoFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
60
73
|
'status': json['status'],
|
|
61
74
|
'webSummary': json['webSummary'],
|
|
62
75
|
'webResults': (json['webResults'].map(LeadEnrichmentWebResultDto_1.LeadEnrichmentWebResultDtoFromJSON)),
|
|
76
|
+
'enrichedAt': json['enrichedAt'],
|
|
63
77
|
'email': (0, LeadEnrichmentEmailDto_1.LeadEnrichmentEmailDtoFromJSON)(json['email']),
|
|
64
78
|
'person': (0, LeadEnrichmentPersonDto_1.LeadEnrichmentPersonDtoFromJSON)(json['person']),
|
|
65
79
|
'company': (0, LeadEnrichmentCompanyDto_1.LeadEnrichmentCompanyDtoFromJSON)(json['company']),
|
|
80
|
+
'namesake': (0, LeadEnrichmentNamesakeDto_1.LeadEnrichmentNamesakeDtoFromJSON)(json['namesake']),
|
|
81
|
+
'domainFacts': (0, LeadEnrichmentDomainFactsDto_1.LeadEnrichmentDomainFactsDtoFromJSON)(json['domainFacts']),
|
|
66
82
|
'ip': (0, LeadEnrichmentIpDto_1.LeadEnrichmentIpDtoFromJSON)(json['ip']),
|
|
67
83
|
'domain': (0, LeadEnrichmentDomainDto_1.LeadEnrichmentDomainDtoFromJSON)(json['domain']),
|
|
84
|
+
'buyerNameserverMatches': json['buyerNameserverMatches'],
|
|
85
|
+
'activity': (0, LeadEnrichmentActivityDto_1.LeadEnrichmentActivityDtoFromJSON)(json['activity']),
|
|
68
86
|
};
|
|
69
87
|
}
|
|
70
88
|
function LeadEnrichmentDtoToJSON(json) {
|
|
@@ -80,10 +98,15 @@ function LeadEnrichmentDtoToJSONTyped(value, ignoreDiscriminator) {
|
|
|
80
98
|
'status': value['status'],
|
|
81
99
|
'webSummary': value['webSummary'],
|
|
82
100
|
'webResults': (value['webResults'].map(LeadEnrichmentWebResultDto_1.LeadEnrichmentWebResultDtoToJSON)),
|
|
101
|
+
'enrichedAt': value['enrichedAt'],
|
|
83
102
|
'email': (0, LeadEnrichmentEmailDto_1.LeadEnrichmentEmailDtoToJSON)(value['email']),
|
|
84
103
|
'person': (0, LeadEnrichmentPersonDto_1.LeadEnrichmentPersonDtoToJSON)(value['person']),
|
|
85
104
|
'company': (0, LeadEnrichmentCompanyDto_1.LeadEnrichmentCompanyDtoToJSON)(value['company']),
|
|
105
|
+
'namesake': (0, LeadEnrichmentNamesakeDto_1.LeadEnrichmentNamesakeDtoToJSON)(value['namesake']),
|
|
106
|
+
'domainFacts': (0, LeadEnrichmentDomainFactsDto_1.LeadEnrichmentDomainFactsDtoToJSON)(value['domainFacts']),
|
|
86
107
|
'ip': (0, LeadEnrichmentIpDto_1.LeadEnrichmentIpDtoToJSON)(value['ip']),
|
|
87
108
|
'domain': (0, LeadEnrichmentDomainDto_1.LeadEnrichmentDomainDtoToJSON)(value['domain']),
|
|
109
|
+
'buyerNameserverMatches': value['buyerNameserverMatches'],
|
|
110
|
+
'activity': (0, LeadEnrichmentActivityDto_1.LeadEnrichmentActivityDtoToJSON)(value['activity']),
|
|
88
111
|
};
|
|
89
112
|
}
|
|
@@ -27,6 +27,12 @@ export interface LeadEnrichmentEmailDto {
|
|
|
27
27
|
* @memberof LeadEnrichmentEmailDto
|
|
28
28
|
*/
|
|
29
29
|
isDisposable: boolean | null;
|
|
30
|
+
/**
|
|
31
|
+
* When this record was last enriched.
|
|
32
|
+
* @type {string}
|
|
33
|
+
* @memberof LeadEnrichmentEmailDto
|
|
34
|
+
*/
|
|
35
|
+
enrichedAt: string | null;
|
|
30
36
|
}
|
|
31
37
|
/**
|
|
32
38
|
* Check if a given object implements the LeadEnrichmentEmailDto interface.
|
|
@@ -26,6 +26,8 @@ function instanceOfLeadEnrichmentEmailDto(value) {
|
|
|
26
26
|
return false;
|
|
27
27
|
if (!('isDisposable' in value) || value['isDisposable'] === undefined)
|
|
28
28
|
return false;
|
|
29
|
+
if (!('enrichedAt' in value) || value['enrichedAt'] === undefined)
|
|
30
|
+
return false;
|
|
29
31
|
return true;
|
|
30
32
|
}
|
|
31
33
|
function LeadEnrichmentEmailDtoFromJSON(json) {
|
|
@@ -38,6 +40,7 @@ function LeadEnrichmentEmailDtoFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
38
40
|
return {
|
|
39
41
|
'isFreeMail': json['isFreeMail'],
|
|
40
42
|
'isDisposable': json['isDisposable'],
|
|
43
|
+
'enrichedAt': json['enrichedAt'],
|
|
41
44
|
};
|
|
42
45
|
}
|
|
43
46
|
function LeadEnrichmentEmailDtoToJSON(json) {
|
|
@@ -51,5 +54,6 @@ function LeadEnrichmentEmailDtoToJSONTyped(value, ignoreDiscriminator) {
|
|
|
51
54
|
return {
|
|
52
55
|
'isFreeMail': value['isFreeMail'],
|
|
53
56
|
'isDisposable': value['isDisposable'],
|
|
57
|
+
'enrichedAt': value['enrichedAt'],
|
|
54
58
|
};
|
|
55
59
|
}
|
|
@@ -21,6 +21,12 @@ export interface LeadEnrichmentIpDto {
|
|
|
21
21
|
* @memberof LeadEnrichmentIpDto
|
|
22
22
|
*/
|
|
23
23
|
org: string | null;
|
|
24
|
+
/**
|
|
25
|
+
*
|
|
26
|
+
* @type {number}
|
|
27
|
+
* @memberof LeadEnrichmentIpDto
|
|
28
|
+
*/
|
|
29
|
+
asn: number | null;
|
|
24
30
|
/**
|
|
25
31
|
*
|
|
26
32
|
* @type {string}
|
|
@@ -33,6 +39,30 @@ export interface LeadEnrichmentIpDto {
|
|
|
33
39
|
* @memberof LeadEnrichmentIpDto
|
|
34
40
|
*/
|
|
35
41
|
countryCode: string | null;
|
|
42
|
+
/**
|
|
43
|
+
* City the buyer's IP address resolves to. Null when that address has not been located; it is never inferred from neighbouring addresses on the same network.
|
|
44
|
+
* @type {string}
|
|
45
|
+
* @memberof LeadEnrichmentIpDto
|
|
46
|
+
*/
|
|
47
|
+
city: string | null;
|
|
48
|
+
/**
|
|
49
|
+
* State or province containing `city`.
|
|
50
|
+
* @type {string}
|
|
51
|
+
* @memberof LeadEnrichmentIpDto
|
|
52
|
+
*/
|
|
53
|
+
region: string | null;
|
|
54
|
+
/**
|
|
55
|
+
* Latitude of the buyer's IP address; null unless `longitude` is set too. Accurate to city level at best.
|
|
56
|
+
* @type {number}
|
|
57
|
+
* @memberof LeadEnrichmentIpDto
|
|
58
|
+
*/
|
|
59
|
+
latitude: number | null;
|
|
60
|
+
/**
|
|
61
|
+
* Longitude of the buyer's IP address, always paired with `latitude`.
|
|
62
|
+
* @type {number}
|
|
63
|
+
* @memberof LeadEnrichmentIpDto
|
|
64
|
+
*/
|
|
65
|
+
longitude: number | null;
|
|
36
66
|
/**
|
|
37
67
|
*
|
|
38
68
|
* @type {boolean}
|
|
@@ -51,6 +81,18 @@ export interface LeadEnrichmentIpDto {
|
|
|
51
81
|
* @memberof LeadEnrichmentIpDto
|
|
52
82
|
*/
|
|
53
83
|
isTor: boolean | null;
|
|
84
|
+
/**
|
|
85
|
+
* Whether the address belongs to a mobile carrier network.
|
|
86
|
+
* @type {boolean}
|
|
87
|
+
* @memberof LeadEnrichmentIpDto
|
|
88
|
+
*/
|
|
89
|
+
isMobile: boolean | null;
|
|
90
|
+
/**
|
|
91
|
+
* When this record was last enriched.
|
|
92
|
+
* @type {string}
|
|
93
|
+
* @memberof LeadEnrichmentIpDto
|
|
94
|
+
*/
|
|
95
|
+
enrichedAt: string | null;
|
|
54
96
|
}
|
|
55
97
|
/**
|
|
56
98
|
* Check if a given object implements the LeadEnrichmentIpDto interface.
|