@randock/nameshift-api-client 0.0.485 → 0.0.487
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 +1 -0
- package/README.md +3 -3
- package/dist/apis/AdminApi.d.ts +15 -2
- package/dist/apis/AdminApi.js +55 -2
- package/dist/apis/DomainsApi.d.ts +6 -5
- package/dist/apis/DomainsApi.js +10 -5
- package/dist/apis/JobsApi.d.ts +17 -4
- package/dist/apis/JobsApi.js +65 -4
- package/dist/models/AccountAliasDto.d.ts +18 -3
- package/dist/models/AccountAliasDto.js +13 -0
- package/dist/models/AccountSettingsAliasDto.d.ts +18 -3
- package/dist/models/AccountSettingsAliasDto.js +13 -0
- package/dist/models/AdminListAccountDto.d.ts +16 -1
- package/dist/models/AdminListAccountDto.js +13 -1
- package/dist/models/BuyerNotificationDto.d.ts +2 -0
- package/dist/models/BuyerNotificationDto.js +2 -0
- package/dist/models/BuyerNotificationListItemDto.d.ts +2 -0
- package/dist/models/BuyerNotificationListItemDto.js +2 -0
- package/dist/models/CustomerSuccessListAccountDto.d.ts +16 -1
- package/dist/models/CustomerSuccessListAccountDto.js +13 -1
- package/dist/models/ImportDomainsResponseDto.d.ts +33 -0
- package/dist/models/ImportDomainsResponseDto.js +52 -0
- package/dist/models/JobDto.d.ts +21 -1
- package/dist/models/JobDto.js +11 -0
- package/dist/models/JobFailureDto.d.ts +1 -1
- package/dist/models/JobType.d.ts +1 -0
- package/dist/models/JobType.js +2 -1
- package/dist/models/UserNotificationDto.d.ts +2 -0
- package/dist/models/UserNotificationDto.js +2 -0
- package/dist/models/UserNotificationListItemDto.d.ts +2 -0
- package/dist/models/UserNotificationListItemDto.js +2 -0
- package/dist/models/index.d.ts +1 -0
- package/dist/models/index.js +1 -0
- package/package.json +1 -1
- package/src/apis/AdminApi.ts +48 -2
- package/src/apis/DomainsApi.ts +15 -6
- package/src/apis/JobsApi.ts +57 -4
- package/src/models/AccountAliasDto.ts +24 -3
- package/src/models/AccountSettingsAliasDto.ts +24 -3
- package/src/models/AdminListAccountDto.ts +20 -1
- package/src/models/BuyerNotificationDto.ts +2 -0
- package/src/models/BuyerNotificationListItemDto.ts +2 -0
- package/src/models/CustomerSuccessListAccountDto.ts +20 -1
- package/src/models/ImportDomainsResponseDto.ts +74 -0
- package/src/models/JobDto.ts +27 -1
- package/src/models/JobFailureDto.ts +1 -1
- package/src/models/JobType.ts +2 -1
- package/src/models/UserNotificationDto.ts +2 -0
- package/src/models/UserNotificationListItemDto.ts +2 -0
- package/src/models/index.ts +1 -0
|
@@ -68,6 +68,7 @@ export declare const BuyerNotificationDtoTypeEnum: {
|
|
|
68
68
|
readonly ACCOUNT_ONBOARDING_FINISHED: "account_onboarding_finished";
|
|
69
69
|
readonly ACCOUNT_ONBOARDING_REJECTED: "account_onboarding_rejected";
|
|
70
70
|
readonly ACCOUNT_BANK_ACCOUNT_VERIFICATION_SUCCEEDED: "account_bank_account_verification_succeeded";
|
|
71
|
+
readonly ACCOUNT_ALIAS_REJECTED: "account_alias_rejected";
|
|
71
72
|
readonly BUYER_ACCESS_TOKEN: "buyer_access_token";
|
|
72
73
|
readonly DOMAIN_TRANSFER_REQUEST_AUTH_CODE_TO_SELLER: "domain_transfer.request_auth_code_to_seller";
|
|
73
74
|
readonly DOMAIN_TRANSFER_VALIDATION_REQUIRED_BY_BUYER_EMAIL: "domain_transfer_validation_required_by_buyer_email";
|
|
@@ -95,6 +96,7 @@ export declare const BuyerNotificationDtoTypeEnum: {
|
|
|
95
96
|
readonly REQUEST_IPS_TAG_TO_SELLER_IPS_TAG_INVALID: "request_ips_tag_to_seller_ips_tag_invalid";
|
|
96
97
|
readonly EXPORT_COMPLETED: "export_completed";
|
|
97
98
|
readonly DOMAIN_IMPORT_FINISHED: "domain_import_finished";
|
|
99
|
+
readonly DOMAIN_IMPORT_FAILED: "domain_import_failed";
|
|
98
100
|
readonly DOMAIN_OFFER_VERIFIED_BUYER_ACCESS_LINK_EMAIL: "domain_offer_verified_buyer_access_link_email";
|
|
99
101
|
readonly DOMAIN_OFFER_RECEIVED_BUYER_ACCESS_LINK_EMAIL: "domain_offer_received_buyer_access_link_email";
|
|
100
102
|
readonly DOMAIN_OFFER_ACCEPTED_CONTINUE_ORDER_EMAIL: "domain_offer_accepted_continue_order_email";
|
|
@@ -29,6 +29,7 @@ exports.BuyerNotificationDtoTypeEnum = {
|
|
|
29
29
|
ACCOUNT_ONBOARDING_FINISHED: 'account_onboarding_finished',
|
|
30
30
|
ACCOUNT_ONBOARDING_REJECTED: 'account_onboarding_rejected',
|
|
31
31
|
ACCOUNT_BANK_ACCOUNT_VERIFICATION_SUCCEEDED: 'account_bank_account_verification_succeeded',
|
|
32
|
+
ACCOUNT_ALIAS_REJECTED: 'account_alias_rejected',
|
|
32
33
|
BUYER_ACCESS_TOKEN: 'buyer_access_token',
|
|
33
34
|
DOMAIN_TRANSFER_REQUEST_AUTH_CODE_TO_SELLER: 'domain_transfer.request_auth_code_to_seller',
|
|
34
35
|
DOMAIN_TRANSFER_VALIDATION_REQUIRED_BY_BUYER_EMAIL: 'domain_transfer_validation_required_by_buyer_email',
|
|
@@ -56,6 +57,7 @@ exports.BuyerNotificationDtoTypeEnum = {
|
|
|
56
57
|
REQUEST_IPS_TAG_TO_SELLER_IPS_TAG_INVALID: 'request_ips_tag_to_seller_ips_tag_invalid',
|
|
57
58
|
EXPORT_COMPLETED: 'export_completed',
|
|
58
59
|
DOMAIN_IMPORT_FINISHED: 'domain_import_finished',
|
|
60
|
+
DOMAIN_IMPORT_FAILED: 'domain_import_failed',
|
|
59
61
|
DOMAIN_OFFER_VERIFIED_BUYER_ACCESS_LINK_EMAIL: 'domain_offer_verified_buyer_access_link_email',
|
|
60
62
|
DOMAIN_OFFER_RECEIVED_BUYER_ACCESS_LINK_EMAIL: 'domain_offer_received_buyer_access_link_email',
|
|
61
63
|
DOMAIN_OFFER_ACCEPTED_CONTINUE_ORDER_EMAIL: 'domain_offer_accepted_continue_order_email',
|
|
@@ -61,6 +61,7 @@ export declare const BuyerNotificationListItemDtoTypeEnum: {
|
|
|
61
61
|
readonly ACCOUNT_ONBOARDING_FINISHED: "account_onboarding_finished";
|
|
62
62
|
readonly ACCOUNT_ONBOARDING_REJECTED: "account_onboarding_rejected";
|
|
63
63
|
readonly ACCOUNT_BANK_ACCOUNT_VERIFICATION_SUCCEEDED: "account_bank_account_verification_succeeded";
|
|
64
|
+
readonly ACCOUNT_ALIAS_REJECTED: "account_alias_rejected";
|
|
64
65
|
readonly BUYER_ACCESS_TOKEN: "buyer_access_token";
|
|
65
66
|
readonly DOMAIN_TRANSFER_REQUEST_AUTH_CODE_TO_SELLER: "domain_transfer.request_auth_code_to_seller";
|
|
66
67
|
readonly DOMAIN_TRANSFER_VALIDATION_REQUIRED_BY_BUYER_EMAIL: "domain_transfer_validation_required_by_buyer_email";
|
|
@@ -88,6 +89,7 @@ export declare const BuyerNotificationListItemDtoTypeEnum: {
|
|
|
88
89
|
readonly REQUEST_IPS_TAG_TO_SELLER_IPS_TAG_INVALID: "request_ips_tag_to_seller_ips_tag_invalid";
|
|
89
90
|
readonly EXPORT_COMPLETED: "export_completed";
|
|
90
91
|
readonly DOMAIN_IMPORT_FINISHED: "domain_import_finished";
|
|
92
|
+
readonly DOMAIN_IMPORT_FAILED: "domain_import_failed";
|
|
91
93
|
readonly DOMAIN_OFFER_VERIFIED_BUYER_ACCESS_LINK_EMAIL: "domain_offer_verified_buyer_access_link_email";
|
|
92
94
|
readonly DOMAIN_OFFER_RECEIVED_BUYER_ACCESS_LINK_EMAIL: "domain_offer_received_buyer_access_link_email";
|
|
93
95
|
readonly DOMAIN_OFFER_ACCEPTED_CONTINUE_ORDER_EMAIL: "domain_offer_accepted_continue_order_email";
|
|
@@ -28,6 +28,7 @@ exports.BuyerNotificationListItemDtoTypeEnum = {
|
|
|
28
28
|
ACCOUNT_ONBOARDING_FINISHED: 'account_onboarding_finished',
|
|
29
29
|
ACCOUNT_ONBOARDING_REJECTED: 'account_onboarding_rejected',
|
|
30
30
|
ACCOUNT_BANK_ACCOUNT_VERIFICATION_SUCCEEDED: 'account_bank_account_verification_succeeded',
|
|
31
|
+
ACCOUNT_ALIAS_REJECTED: 'account_alias_rejected',
|
|
31
32
|
BUYER_ACCESS_TOKEN: 'buyer_access_token',
|
|
32
33
|
DOMAIN_TRANSFER_REQUEST_AUTH_CODE_TO_SELLER: 'domain_transfer.request_auth_code_to_seller',
|
|
33
34
|
DOMAIN_TRANSFER_VALIDATION_REQUIRED_BY_BUYER_EMAIL: 'domain_transfer_validation_required_by_buyer_email',
|
|
@@ -55,6 +56,7 @@ exports.BuyerNotificationListItemDtoTypeEnum = {
|
|
|
55
56
|
REQUEST_IPS_TAG_TO_SELLER_IPS_TAG_INVALID: 'request_ips_tag_to_seller_ips_tag_invalid',
|
|
56
57
|
EXPORT_COMPLETED: 'export_completed',
|
|
57
58
|
DOMAIN_IMPORT_FINISHED: 'domain_import_finished',
|
|
59
|
+
DOMAIN_IMPORT_FAILED: 'domain_import_failed',
|
|
58
60
|
DOMAIN_OFFER_VERIFIED_BUYER_ACCESS_LINK_EMAIL: 'domain_offer_verified_buyer_access_link_email',
|
|
59
61
|
DOMAIN_OFFER_RECEIVED_BUYER_ACCESS_LINK_EMAIL: 'domain_offer_received_buyer_access_link_email',
|
|
60
62
|
DOMAIN_OFFER_ACCEPTED_CONTINUE_ORDER_EMAIL: 'domain_offer_accepted_continue_order_email',
|
|
@@ -75,11 +75,17 @@ export interface CustomerSuccessListAccountDto {
|
|
|
75
75
|
*/
|
|
76
76
|
alias: string | null;
|
|
77
77
|
/**
|
|
78
|
-
* Whether the alias is verified.
|
|
78
|
+
* Deprecated, use aliasStatus. Whether the alias is verified.
|
|
79
79
|
* @type {boolean}
|
|
80
80
|
* @memberof CustomerSuccessListAccountDto
|
|
81
81
|
*/
|
|
82
82
|
aliasVerified: boolean;
|
|
83
|
+
/**
|
|
84
|
+
* Review status of the alias: pending review, verified or rejected. Null when no alias is set.
|
|
85
|
+
* @type {string}
|
|
86
|
+
* @memberof CustomerSuccessListAccountDto
|
|
87
|
+
*/
|
|
88
|
+
aliasStatus: CustomerSuccessListAccountDtoAliasStatusEnum | null;
|
|
83
89
|
/**
|
|
84
90
|
* Account metrics.
|
|
85
91
|
* @type {CustomerSuccessListAccountMetricsDto}
|
|
@@ -147,6 +153,15 @@ export interface CustomerSuccessListAccountDto {
|
|
|
147
153
|
*/
|
|
148
154
|
challengeRewardBalance: ChallengeRewardBalanceDto;
|
|
149
155
|
}
|
|
156
|
+
/**
|
|
157
|
+
* @export
|
|
158
|
+
*/
|
|
159
|
+
export declare const CustomerSuccessListAccountDtoAliasStatusEnum: {
|
|
160
|
+
readonly PENDING: "pending";
|
|
161
|
+
readonly VERIFIED: "verified";
|
|
162
|
+
readonly REJECTED: "rejected";
|
|
163
|
+
};
|
|
164
|
+
export type CustomerSuccessListAccountDtoAliasStatusEnum = typeof CustomerSuccessListAccountDtoAliasStatusEnum[keyof typeof CustomerSuccessListAccountDtoAliasStatusEnum];
|
|
150
165
|
/**
|
|
151
166
|
* @export
|
|
152
167
|
*/
|
|
@@ -13,7 +13,7 @@
|
|
|
13
13
|
* Do not edit the class manually.
|
|
14
14
|
*/
|
|
15
15
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
16
|
-
exports.CustomerSuccessListAccountDtoPayoutProviderEnum = exports.CustomerSuccessListAccountDtoOnboardingStatusEnum = exports.CustomerSuccessListAccountDtoOnboardingProviderEnum = void 0;
|
|
16
|
+
exports.CustomerSuccessListAccountDtoPayoutProviderEnum = exports.CustomerSuccessListAccountDtoOnboardingStatusEnum = exports.CustomerSuccessListAccountDtoOnboardingProviderEnum = exports.CustomerSuccessListAccountDtoAliasStatusEnum = void 0;
|
|
17
17
|
exports.instanceOfCustomerSuccessListAccountDto = instanceOfCustomerSuccessListAccountDto;
|
|
18
18
|
exports.CustomerSuccessListAccountDtoFromJSON = CustomerSuccessListAccountDtoFromJSON;
|
|
19
19
|
exports.CustomerSuccessListAccountDtoFromJSONTyped = CustomerSuccessListAccountDtoFromJSONTyped;
|
|
@@ -24,6 +24,14 @@ var ChallengeRewardBalanceDto_1 = require("./ChallengeRewardBalanceDto");
|
|
|
24
24
|
var CustomerSuccessListAccountMetricsDto_1 = require("./CustomerSuccessListAccountMetricsDto");
|
|
25
25
|
var CustomerSuccessListAccountPortfolioSizeDto_1 = require("./CustomerSuccessListAccountPortfolioSizeDto");
|
|
26
26
|
var AccountBankAccountSummaryDto_1 = require("./AccountBankAccountSummaryDto");
|
|
27
|
+
/**
|
|
28
|
+
* @export
|
|
29
|
+
*/
|
|
30
|
+
exports.CustomerSuccessListAccountDtoAliasStatusEnum = {
|
|
31
|
+
PENDING: 'pending',
|
|
32
|
+
VERIFIED: 'verified',
|
|
33
|
+
REJECTED: 'rejected'
|
|
34
|
+
};
|
|
27
35
|
/**
|
|
28
36
|
* @export
|
|
29
37
|
*/
|
|
@@ -70,6 +78,8 @@ function instanceOfCustomerSuccessListAccountDto(value) {
|
|
|
70
78
|
return false;
|
|
71
79
|
if (!('aliasVerified' in value) || value['aliasVerified'] === undefined)
|
|
72
80
|
return false;
|
|
81
|
+
if (!('aliasStatus' in value) || value['aliasStatus'] === undefined)
|
|
82
|
+
return false;
|
|
73
83
|
if (!('metrics' in value) || value['metrics'] === undefined)
|
|
74
84
|
return false;
|
|
75
85
|
if (!('lastOnline' in value) || value['lastOnline'] === undefined)
|
|
@@ -112,6 +122,7 @@ function CustomerSuccessListAccountDtoFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
112
122
|
'type': json['type'],
|
|
113
123
|
'alias': json['alias'],
|
|
114
124
|
'aliasVerified': json['aliasVerified'],
|
|
125
|
+
'aliasStatus': json['aliasStatus'],
|
|
115
126
|
'metrics': (0, CustomerSuccessListAccountMetricsDto_1.CustomerSuccessListAccountMetricsDtoFromJSON)(json['metrics']),
|
|
116
127
|
'lastOnline': (new Date(json['lastOnline'])),
|
|
117
128
|
'users': (json['users'].map(CustomerSuccessListAccountUserDto_1.CustomerSuccessListAccountUserDtoFromJSON)),
|
|
@@ -144,6 +155,7 @@ function CustomerSuccessListAccountDtoToJSONTyped(value, ignoreDiscriminator) {
|
|
|
144
155
|
'type': value['type'],
|
|
145
156
|
'alias': value['alias'],
|
|
146
157
|
'aliasVerified': value['aliasVerified'],
|
|
158
|
+
'aliasStatus': value['aliasStatus'],
|
|
147
159
|
'metrics': (0, CustomerSuccessListAccountMetricsDto_1.CustomerSuccessListAccountMetricsDtoToJSON)(value['metrics']),
|
|
148
160
|
'lastOnline': ((value['lastOnline']).toISOString()),
|
|
149
161
|
'users': (value['users'].map(CustomerSuccessListAccountUserDto_1.CustomerSuccessListAccountUserDtoToJSON)),
|
|
@@ -0,0 +1,33 @@
|
|
|
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 { JobDto } from './JobDto';
|
|
13
|
+
/**
|
|
14
|
+
*
|
|
15
|
+
* @export
|
|
16
|
+
* @interface ImportDomainsResponseDto
|
|
17
|
+
*/
|
|
18
|
+
export interface ImportDomainsResponseDto {
|
|
19
|
+
/**
|
|
20
|
+
* The background job importing the uploaded file. Null for a list of domain names, which is imported before the response is sent.
|
|
21
|
+
* @type {JobDto}
|
|
22
|
+
* @memberof ImportDomainsResponseDto
|
|
23
|
+
*/
|
|
24
|
+
job: JobDto | null;
|
|
25
|
+
}
|
|
26
|
+
/**
|
|
27
|
+
* Check if a given object implements the ImportDomainsResponseDto interface.
|
|
28
|
+
*/
|
|
29
|
+
export declare function instanceOfImportDomainsResponseDto(value: object): value is ImportDomainsResponseDto;
|
|
30
|
+
export declare function ImportDomainsResponseDtoFromJSON(json: any): ImportDomainsResponseDto;
|
|
31
|
+
export declare function ImportDomainsResponseDtoFromJSONTyped(json: any, ignoreDiscriminator: boolean): ImportDomainsResponseDto;
|
|
32
|
+
export declare function ImportDomainsResponseDtoToJSON(json: any): ImportDomainsResponseDto;
|
|
33
|
+
export declare function ImportDomainsResponseDtoToJSONTyped(value?: ImportDomainsResponseDto | null, ignoreDiscriminator?: boolean): any;
|
|
@@ -0,0 +1,52 @@
|
|
|
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.instanceOfImportDomainsResponseDto = instanceOfImportDomainsResponseDto;
|
|
17
|
+
exports.ImportDomainsResponseDtoFromJSON = ImportDomainsResponseDtoFromJSON;
|
|
18
|
+
exports.ImportDomainsResponseDtoFromJSONTyped = ImportDomainsResponseDtoFromJSONTyped;
|
|
19
|
+
exports.ImportDomainsResponseDtoToJSON = ImportDomainsResponseDtoToJSON;
|
|
20
|
+
exports.ImportDomainsResponseDtoToJSONTyped = ImportDomainsResponseDtoToJSONTyped;
|
|
21
|
+
var JobDto_1 = require("./JobDto");
|
|
22
|
+
/**
|
|
23
|
+
* Check if a given object implements the ImportDomainsResponseDto interface.
|
|
24
|
+
*/
|
|
25
|
+
function instanceOfImportDomainsResponseDto(value) {
|
|
26
|
+
if (!('job' in value) || value['job'] === undefined)
|
|
27
|
+
return false;
|
|
28
|
+
return true;
|
|
29
|
+
}
|
|
30
|
+
function ImportDomainsResponseDtoFromJSON(json) {
|
|
31
|
+
return ImportDomainsResponseDtoFromJSONTyped(json, false);
|
|
32
|
+
}
|
|
33
|
+
function ImportDomainsResponseDtoFromJSONTyped(json, ignoreDiscriminator) {
|
|
34
|
+
if (json == null) {
|
|
35
|
+
return json;
|
|
36
|
+
}
|
|
37
|
+
return {
|
|
38
|
+
'job': (0, JobDto_1.JobDtoFromJSON)(json['job']),
|
|
39
|
+
};
|
|
40
|
+
}
|
|
41
|
+
function ImportDomainsResponseDtoToJSON(json) {
|
|
42
|
+
return ImportDomainsResponseDtoToJSONTyped(json, false);
|
|
43
|
+
}
|
|
44
|
+
function ImportDomainsResponseDtoToJSONTyped(value, ignoreDiscriminator) {
|
|
45
|
+
if (ignoreDiscriminator === void 0) { ignoreDiscriminator = false; }
|
|
46
|
+
if (value == null) {
|
|
47
|
+
return value;
|
|
48
|
+
}
|
|
49
|
+
return {
|
|
50
|
+
'job': (0, JobDto_1.JobDtoToJSON)(value['job']),
|
|
51
|
+
};
|
|
52
|
+
}
|
package/dist/models/JobDto.d.ts
CHANGED
|
@@ -66,12 +66,32 @@ export interface JobDto {
|
|
|
66
66
|
* @memberof JobDto
|
|
67
67
|
*/
|
|
68
68
|
failures: Array<JobFailureDto>;
|
|
69
|
+
/**
|
|
70
|
+
* How many items ended which way, for a kind of job whose items can end in more than two ways. An import counts created, updated, unchanged, deleted, hijack, ignored and error. Unchanged is a domain the account already had exactly as its row describes it, which the import leaves as it was. Null for a job that keeps no breakdown.
|
|
71
|
+
* @type {{ [key: string]: number; }}
|
|
72
|
+
* @memberof JobDto
|
|
73
|
+
*/
|
|
74
|
+
result: {
|
|
75
|
+
[key: string]: number;
|
|
76
|
+
} | null;
|
|
77
|
+
/**
|
|
78
|
+
* A CSV with the outcome of every item, once a job that writes one has finished. The link is public: anyone who has it can download the file.
|
|
79
|
+
* @type {string}
|
|
80
|
+
* @memberof JobDto
|
|
81
|
+
*/
|
|
82
|
+
resultFileUrl: string | null;
|
|
69
83
|
/**
|
|
70
84
|
* Why the job as a whole stopped. Never a per-item problem.
|
|
71
85
|
* @type {string}
|
|
72
86
|
* @memberof JobDto
|
|
73
87
|
*/
|
|
74
88
|
failureReason: string | null;
|
|
89
|
+
/**
|
|
90
|
+
* Whether the user who started the job is emailed when it has failed, or when it has finished after running for longer than 30 seconds. False for a file import started with `notifyByEmail` set to false; true for every other job.
|
|
91
|
+
* @type {boolean}
|
|
92
|
+
* @memberof JobDto
|
|
93
|
+
*/
|
|
94
|
+
readonly notifyByEmail: boolean;
|
|
75
95
|
/**
|
|
76
96
|
*
|
|
77
97
|
* @type {Date}
|
|
@@ -98,4 +118,4 @@ export declare function instanceOfJobDto(value: object): value is JobDto;
|
|
|
98
118
|
export declare function JobDtoFromJSON(json: any): JobDto;
|
|
99
119
|
export declare function JobDtoFromJSONTyped(json: any, ignoreDiscriminator: boolean): JobDto;
|
|
100
120
|
export declare function JobDtoToJSON(json: any): JobDto;
|
|
101
|
-
export declare function JobDtoToJSONTyped(value?: JobDto | null, ignoreDiscriminator?: boolean): any;
|
|
121
|
+
export declare function JobDtoToJSONTyped(value?: Omit<JobDto, 'notifyByEmail'> | null, ignoreDiscriminator?: boolean): any;
|
package/dist/models/JobDto.js
CHANGED
|
@@ -41,8 +41,14 @@ function instanceOfJobDto(value) {
|
|
|
41
41
|
return false;
|
|
42
42
|
if (!('failures' in value) || value['failures'] === undefined)
|
|
43
43
|
return false;
|
|
44
|
+
if (!('result' in value) || value['result'] === undefined)
|
|
45
|
+
return false;
|
|
46
|
+
if (!('resultFileUrl' in value) || value['resultFileUrl'] === undefined)
|
|
47
|
+
return false;
|
|
44
48
|
if (!('failureReason' in value) || value['failureReason'] === undefined)
|
|
45
49
|
return false;
|
|
50
|
+
if (!('notifyByEmail' in value) || value['notifyByEmail'] === undefined)
|
|
51
|
+
return false;
|
|
46
52
|
if (!('createdAt' in value) || value['createdAt'] === undefined)
|
|
47
53
|
return false;
|
|
48
54
|
if (!('startedAt' in value) || value['startedAt'] === undefined)
|
|
@@ -67,7 +73,10 @@ function JobDtoFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
67
73
|
'succeeded': json['succeeded'],
|
|
68
74
|
'failed': json['failed'],
|
|
69
75
|
'failures': (json['failures'].map(JobFailureDto_1.JobFailureDtoFromJSON)),
|
|
76
|
+
'result': json['result'],
|
|
77
|
+
'resultFileUrl': json['resultFileUrl'],
|
|
70
78
|
'failureReason': json['failureReason'],
|
|
79
|
+
'notifyByEmail': json['notifyByEmail'],
|
|
71
80
|
'createdAt': (new Date(json['createdAt'])),
|
|
72
81
|
'startedAt': (json['startedAt'] == null ? null : new Date(json['startedAt'])),
|
|
73
82
|
'finishedAt': (json['finishedAt'] == null ? null : new Date(json['finishedAt'])),
|
|
@@ -90,6 +99,8 @@ function JobDtoToJSONTyped(value, ignoreDiscriminator) {
|
|
|
90
99
|
'succeeded': value['succeeded'],
|
|
91
100
|
'failed': value['failed'],
|
|
92
101
|
'failures': (value['failures'].map(JobFailureDto_1.JobFailureDtoToJSON)),
|
|
102
|
+
'result': value['result'],
|
|
103
|
+
'resultFileUrl': value['resultFileUrl'],
|
|
93
104
|
'failureReason': value['failureReason'],
|
|
94
105
|
'createdAt': ((value['createdAt']).toISOString()),
|
|
95
106
|
'startedAt': (value['startedAt'] == null ? null : value['startedAt'].toISOString()),
|
|
@@ -16,7 +16,7 @@
|
|
|
16
16
|
*/
|
|
17
17
|
export interface JobFailureDto {
|
|
18
18
|
/**
|
|
19
|
-
* What the failure was about
|
|
19
|
+
* What the failure was about, usually a domain name: the domain a bulk edit refused, or an import row as it was uploaded.
|
|
20
20
|
* @type {string}
|
|
21
21
|
* @memberof JobFailureDto
|
|
22
22
|
*/
|
package/dist/models/JobType.d.ts
CHANGED
|
@@ -15,6 +15,7 @@
|
|
|
15
15
|
*/
|
|
16
16
|
export declare const JobType: {
|
|
17
17
|
readonly BULK_EDIT_DOMAINS: "bulk_edit_domains";
|
|
18
|
+
readonly IMPORT_DOMAINS: "import_domains";
|
|
18
19
|
};
|
|
19
20
|
export type JobType = typeof JobType[keyof typeof JobType];
|
|
20
21
|
export declare function instanceOfJobType(value: any): boolean;
|
package/dist/models/JobType.js
CHANGED
|
@@ -24,7 +24,8 @@ exports.JobTypeToJSONTyped = JobTypeToJSONTyped;
|
|
|
24
24
|
* @export
|
|
25
25
|
*/
|
|
26
26
|
exports.JobType = {
|
|
27
|
-
BULK_EDIT_DOMAINS: 'bulk_edit_domains'
|
|
27
|
+
BULK_EDIT_DOMAINS: 'bulk_edit_domains',
|
|
28
|
+
IMPORT_DOMAINS: 'import_domains'
|
|
28
29
|
};
|
|
29
30
|
function instanceOfJobType(value) {
|
|
30
31
|
for (var key in exports.JobType) {
|
|
@@ -68,6 +68,7 @@ export declare const UserNotificationDtoTypeEnum: {
|
|
|
68
68
|
readonly ACCOUNT_ONBOARDING_FINISHED: "account_onboarding_finished";
|
|
69
69
|
readonly ACCOUNT_ONBOARDING_REJECTED: "account_onboarding_rejected";
|
|
70
70
|
readonly ACCOUNT_BANK_ACCOUNT_VERIFICATION_SUCCEEDED: "account_bank_account_verification_succeeded";
|
|
71
|
+
readonly ACCOUNT_ALIAS_REJECTED: "account_alias_rejected";
|
|
71
72
|
readonly BUYER_ACCESS_TOKEN: "buyer_access_token";
|
|
72
73
|
readonly DOMAIN_TRANSFER_REQUEST_AUTH_CODE_TO_SELLER: "domain_transfer.request_auth_code_to_seller";
|
|
73
74
|
readonly DOMAIN_TRANSFER_VALIDATION_REQUIRED_BY_BUYER_EMAIL: "domain_transfer_validation_required_by_buyer_email";
|
|
@@ -95,6 +96,7 @@ export declare const UserNotificationDtoTypeEnum: {
|
|
|
95
96
|
readonly REQUEST_IPS_TAG_TO_SELLER_IPS_TAG_INVALID: "request_ips_tag_to_seller_ips_tag_invalid";
|
|
96
97
|
readonly EXPORT_COMPLETED: "export_completed";
|
|
97
98
|
readonly DOMAIN_IMPORT_FINISHED: "domain_import_finished";
|
|
99
|
+
readonly DOMAIN_IMPORT_FAILED: "domain_import_failed";
|
|
98
100
|
readonly DOMAIN_OFFER_VERIFIED_BUYER_ACCESS_LINK_EMAIL: "domain_offer_verified_buyer_access_link_email";
|
|
99
101
|
readonly DOMAIN_OFFER_RECEIVED_BUYER_ACCESS_LINK_EMAIL: "domain_offer_received_buyer_access_link_email";
|
|
100
102
|
readonly DOMAIN_OFFER_ACCEPTED_CONTINUE_ORDER_EMAIL: "domain_offer_accepted_continue_order_email";
|
|
@@ -29,6 +29,7 @@ exports.UserNotificationDtoTypeEnum = {
|
|
|
29
29
|
ACCOUNT_ONBOARDING_FINISHED: 'account_onboarding_finished',
|
|
30
30
|
ACCOUNT_ONBOARDING_REJECTED: 'account_onboarding_rejected',
|
|
31
31
|
ACCOUNT_BANK_ACCOUNT_VERIFICATION_SUCCEEDED: 'account_bank_account_verification_succeeded',
|
|
32
|
+
ACCOUNT_ALIAS_REJECTED: 'account_alias_rejected',
|
|
32
33
|
BUYER_ACCESS_TOKEN: 'buyer_access_token',
|
|
33
34
|
DOMAIN_TRANSFER_REQUEST_AUTH_CODE_TO_SELLER: 'domain_transfer.request_auth_code_to_seller',
|
|
34
35
|
DOMAIN_TRANSFER_VALIDATION_REQUIRED_BY_BUYER_EMAIL: 'domain_transfer_validation_required_by_buyer_email',
|
|
@@ -56,6 +57,7 @@ exports.UserNotificationDtoTypeEnum = {
|
|
|
56
57
|
REQUEST_IPS_TAG_TO_SELLER_IPS_TAG_INVALID: 'request_ips_tag_to_seller_ips_tag_invalid',
|
|
57
58
|
EXPORT_COMPLETED: 'export_completed',
|
|
58
59
|
DOMAIN_IMPORT_FINISHED: 'domain_import_finished',
|
|
60
|
+
DOMAIN_IMPORT_FAILED: 'domain_import_failed',
|
|
59
61
|
DOMAIN_OFFER_VERIFIED_BUYER_ACCESS_LINK_EMAIL: 'domain_offer_verified_buyer_access_link_email',
|
|
60
62
|
DOMAIN_OFFER_RECEIVED_BUYER_ACCESS_LINK_EMAIL: 'domain_offer_received_buyer_access_link_email',
|
|
61
63
|
DOMAIN_OFFER_ACCEPTED_CONTINUE_ORDER_EMAIL: 'domain_offer_accepted_continue_order_email',
|
|
@@ -61,6 +61,7 @@ export declare const UserNotificationListItemDtoTypeEnum: {
|
|
|
61
61
|
readonly ACCOUNT_ONBOARDING_FINISHED: "account_onboarding_finished";
|
|
62
62
|
readonly ACCOUNT_ONBOARDING_REJECTED: "account_onboarding_rejected";
|
|
63
63
|
readonly ACCOUNT_BANK_ACCOUNT_VERIFICATION_SUCCEEDED: "account_bank_account_verification_succeeded";
|
|
64
|
+
readonly ACCOUNT_ALIAS_REJECTED: "account_alias_rejected";
|
|
64
65
|
readonly BUYER_ACCESS_TOKEN: "buyer_access_token";
|
|
65
66
|
readonly DOMAIN_TRANSFER_REQUEST_AUTH_CODE_TO_SELLER: "domain_transfer.request_auth_code_to_seller";
|
|
66
67
|
readonly DOMAIN_TRANSFER_VALIDATION_REQUIRED_BY_BUYER_EMAIL: "domain_transfer_validation_required_by_buyer_email";
|
|
@@ -88,6 +89,7 @@ export declare const UserNotificationListItemDtoTypeEnum: {
|
|
|
88
89
|
readonly REQUEST_IPS_TAG_TO_SELLER_IPS_TAG_INVALID: "request_ips_tag_to_seller_ips_tag_invalid";
|
|
89
90
|
readonly EXPORT_COMPLETED: "export_completed";
|
|
90
91
|
readonly DOMAIN_IMPORT_FINISHED: "domain_import_finished";
|
|
92
|
+
readonly DOMAIN_IMPORT_FAILED: "domain_import_failed";
|
|
91
93
|
readonly DOMAIN_OFFER_VERIFIED_BUYER_ACCESS_LINK_EMAIL: "domain_offer_verified_buyer_access_link_email";
|
|
92
94
|
readonly DOMAIN_OFFER_RECEIVED_BUYER_ACCESS_LINK_EMAIL: "domain_offer_received_buyer_access_link_email";
|
|
93
95
|
readonly DOMAIN_OFFER_ACCEPTED_CONTINUE_ORDER_EMAIL: "domain_offer_accepted_continue_order_email";
|
|
@@ -28,6 +28,7 @@ exports.UserNotificationListItemDtoTypeEnum = {
|
|
|
28
28
|
ACCOUNT_ONBOARDING_FINISHED: 'account_onboarding_finished',
|
|
29
29
|
ACCOUNT_ONBOARDING_REJECTED: 'account_onboarding_rejected',
|
|
30
30
|
ACCOUNT_BANK_ACCOUNT_VERIFICATION_SUCCEEDED: 'account_bank_account_verification_succeeded',
|
|
31
|
+
ACCOUNT_ALIAS_REJECTED: 'account_alias_rejected',
|
|
31
32
|
BUYER_ACCESS_TOKEN: 'buyer_access_token',
|
|
32
33
|
DOMAIN_TRANSFER_REQUEST_AUTH_CODE_TO_SELLER: 'domain_transfer.request_auth_code_to_seller',
|
|
33
34
|
DOMAIN_TRANSFER_VALIDATION_REQUIRED_BY_BUYER_EMAIL: 'domain_transfer_validation_required_by_buyer_email',
|
|
@@ -55,6 +56,7 @@ exports.UserNotificationListItemDtoTypeEnum = {
|
|
|
55
56
|
REQUEST_IPS_TAG_TO_SELLER_IPS_TAG_INVALID: 'request_ips_tag_to_seller_ips_tag_invalid',
|
|
56
57
|
EXPORT_COMPLETED: 'export_completed',
|
|
57
58
|
DOMAIN_IMPORT_FINISHED: 'domain_import_finished',
|
|
59
|
+
DOMAIN_IMPORT_FAILED: 'domain_import_failed',
|
|
58
60
|
DOMAIN_OFFER_VERIFIED_BUYER_ACCESS_LINK_EMAIL: 'domain_offer_verified_buyer_access_link_email',
|
|
59
61
|
DOMAIN_OFFER_RECEIVED_BUYER_ACCESS_LINK_EMAIL: 'domain_offer_received_buyer_access_link_email',
|
|
60
62
|
DOMAIN_OFFER_ACCEPTED_CONTINUE_ORDER_EMAIL: 'domain_offer_accepted_continue_order_email',
|
package/dist/models/index.d.ts
CHANGED
|
@@ -274,6 +274,7 @@ export * from './GetSellerChallengesListDto';
|
|
|
274
274
|
export * from './GetSellerChallengesListDtoChallengesInner';
|
|
275
275
|
export * from './HistoricalMetrics';
|
|
276
276
|
export * from './HttpException';
|
|
277
|
+
export * from './ImportDomainsResponseDto';
|
|
277
278
|
export * from './IntersectionAccountDtoWithSettingsDtoWithNotificationsDtoWithFeatureFlagsDto';
|
|
278
279
|
export * from './IntersectionDomainDtoWithAccountDtoWithAuctionInfoDto';
|
|
279
280
|
export * from './IntersectionDomainDtoWithHijackerDtoWithAccountDto';
|
package/dist/models/index.js
CHANGED
|
@@ -292,6 +292,7 @@ __exportStar(require("./GetSellerChallengesListDto"), exports);
|
|
|
292
292
|
__exportStar(require("./GetSellerChallengesListDtoChallengesInner"), exports);
|
|
293
293
|
__exportStar(require("./HistoricalMetrics"), exports);
|
|
294
294
|
__exportStar(require("./HttpException"), exports);
|
|
295
|
+
__exportStar(require("./ImportDomainsResponseDto"), exports);
|
|
295
296
|
__exportStar(require("./IntersectionAccountDtoWithSettingsDtoWithNotificationsDtoWithFeatureFlagsDto"), exports);
|
|
296
297
|
__exportStar(require("./IntersectionDomainDtoWithAccountDtoWithAuctionInfoDto"), exports);
|
|
297
298
|
__exportStar(require("./IntersectionDomainDtoWithHijackerDtoWithAccountDto"), exports);
|
package/package.json
CHANGED
package/src/apis/AdminApi.ts
CHANGED
|
@@ -534,6 +534,10 @@ export interface AdminApiPurgeDomainCdnCacheRequest {
|
|
|
534
534
|
domainId: string;
|
|
535
535
|
}
|
|
536
536
|
|
|
537
|
+
export interface AdminApiRejectAccountAliasRequest {
|
|
538
|
+
accountId: string;
|
|
539
|
+
}
|
|
540
|
+
|
|
537
541
|
export interface AdminApiRemoveDomainLockRequest {
|
|
538
542
|
domainId: string;
|
|
539
543
|
lockId: string;
|
|
@@ -3605,6 +3609,48 @@ export class AdminApi extends runtime.BaseAPI {
|
|
|
3605
3609
|
await this.purgeDomainCdnCacheRaw(requestParameters, initOverrides);
|
|
3606
3610
|
}
|
|
3607
3611
|
|
|
3612
|
+
/**
|
|
3613
|
+
* Marks the account alias as rejected, so the landing pages keep the official name, and notifies the account users by email. Rejecting an already rejected alias does nothing.
|
|
3614
|
+
* Reject account alias
|
|
3615
|
+
*/
|
|
3616
|
+
async rejectAccountAliasRaw(requestParameters: AdminApiRejectAccountAliasRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
|
|
3617
|
+
if (requestParameters['accountId'] == null) {
|
|
3618
|
+
throw new runtime.RequiredError(
|
|
3619
|
+
'accountId',
|
|
3620
|
+
'Required parameter "accountId" was null or undefined when calling rejectAccountAlias().'
|
|
3621
|
+
);
|
|
3622
|
+
}
|
|
3623
|
+
|
|
3624
|
+
const queryParameters: any = {};
|
|
3625
|
+
|
|
3626
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
3627
|
+
|
|
3628
|
+
if (this.configuration && this.configuration.accessToken) {
|
|
3629
|
+
const token = this.configuration.accessToken;
|
|
3630
|
+
const tokenString = await token("bearer", []);
|
|
3631
|
+
|
|
3632
|
+
if (tokenString) {
|
|
3633
|
+
headerParameters["Authorization"] = `Bearer ${tokenString}`;
|
|
3634
|
+
}
|
|
3635
|
+
}
|
|
3636
|
+
const response = await this.request({
|
|
3637
|
+
path: `/admin/accounts/{accountId}/alias/reject`.replace(`{${"accountId"}}`, encodeURIComponent(String(requestParameters['accountId']))),
|
|
3638
|
+
method: 'POST',
|
|
3639
|
+
headers: headerParameters,
|
|
3640
|
+
query: queryParameters,
|
|
3641
|
+
}, initOverrides);
|
|
3642
|
+
|
|
3643
|
+
return new runtime.VoidApiResponse(response);
|
|
3644
|
+
}
|
|
3645
|
+
|
|
3646
|
+
/**
|
|
3647
|
+
* Marks the account alias as rejected, so the landing pages keep the official name, and notifies the account users by email. Rejecting an already rejected alias does nothing.
|
|
3648
|
+
* Reject account alias
|
|
3649
|
+
*/
|
|
3650
|
+
async rejectAccountAlias(requestParameters: AdminApiRejectAccountAliasRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
|
|
3651
|
+
await this.rejectAccountAliasRaw(requestParameters, initOverrides);
|
|
3652
|
+
}
|
|
3653
|
+
|
|
3608
3654
|
/**
|
|
3609
3655
|
* Removes a specific lock from a domain.
|
|
3610
3656
|
* Remove domain lock
|
|
@@ -4324,7 +4370,7 @@ export class AdminApi extends runtime.BaseAPI {
|
|
|
4324
4370
|
}
|
|
4325
4371
|
|
|
4326
4372
|
/**
|
|
4327
|
-
* Marks the account alias as verified.
|
|
4373
|
+
* Marks the account alias as verified, so it is shown on the landing pages instead of the official name. Also lifts a previous rejection.
|
|
4328
4374
|
* Verify account alias
|
|
4329
4375
|
*/
|
|
4330
4376
|
async verifyAccountAliasRaw(requestParameters: AdminApiVerifyAccountAliasRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
|
|
@@ -4358,7 +4404,7 @@ export class AdminApi extends runtime.BaseAPI {
|
|
|
4358
4404
|
}
|
|
4359
4405
|
|
|
4360
4406
|
/**
|
|
4361
|
-
* Marks the account alias as verified.
|
|
4407
|
+
* Marks the account alias as verified, so it is shown on the landing pages instead of the official name. Also lifts a previous rejection.
|
|
4362
4408
|
* Verify account alias
|
|
4363
4409
|
*/
|
|
4364
4410
|
async verifyAccountAlias(requestParameters: AdminApiVerifyAccountAliasRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
|
package/src/apis/DomainsApi.ts
CHANGED
|
@@ -30,6 +30,7 @@ import type {
|
|
|
30
30
|
DomainVerificationStatusDto,
|
|
31
31
|
ForbiddenException,
|
|
32
32
|
GetAllDomainTransfers200Response,
|
|
33
|
+
ImportDomainsResponseDto,
|
|
33
34
|
IntersectionDomainDtoWithHijackerDtoWithAccountDto,
|
|
34
35
|
JobDto,
|
|
35
36
|
List200Response2,
|
|
@@ -75,6 +76,8 @@ import {
|
|
|
75
76
|
ForbiddenExceptionToJSON,
|
|
76
77
|
GetAllDomainTransfers200ResponseFromJSON,
|
|
77
78
|
GetAllDomainTransfers200ResponseToJSON,
|
|
79
|
+
ImportDomainsResponseDtoFromJSON,
|
|
80
|
+
ImportDomainsResponseDtoToJSON,
|
|
78
81
|
IntersectionDomainDtoWithHijackerDtoWithAccountDtoFromJSON,
|
|
79
82
|
IntersectionDomainDtoWithHijackerDtoWithAccountDtoToJSON,
|
|
80
83
|
JobDtoFromJSON,
|
|
@@ -112,6 +115,7 @@ export interface DomainsApiApplyDomainEditRequest {
|
|
|
112
115
|
export interface DomainsApiBatchImportRequest {
|
|
113
116
|
domains?: Array<string>;
|
|
114
117
|
file?: Blob | null;
|
|
118
|
+
notifyByEmail?: boolean;
|
|
115
119
|
}
|
|
116
120
|
|
|
117
121
|
export interface DomainsApiBatchImportPreviewRequest {
|
|
@@ -292,10 +296,10 @@ export class DomainsApi extends runtime.BaseAPI {
|
|
|
292
296
|
}
|
|
293
297
|
|
|
294
298
|
/**
|
|
295
|
-
* Imports domains from an uploaded file or a list of domain names and
|
|
299
|
+
* Imports domains from an uploaded file or a list of domain names. A list is imported before the response is sent, and answered with 201. A file is imported in the background: 1. The upload is answered with 202 and the job, which the `Location` header points at as well. The id to poll is at `job.id`. 2. Poll `GET /private/jobs/{jobId}` until its `status` is `finished` or `failed`. 3. Download the outcome of every row from `GET /private/jobs/{jobId}/result`, which redirects to a CSV on a public host. Follow the redirect without the `apikey` header, which the file does not need. With an API key, starting an import needs the `DOMAINS_WRITE` scope, while polling the job and downloading its result need `DOMAINS_READ`. Scopes are matched exactly, so a key that imports files needs both. `notifyByEmail` decides whether the user who started a file import is emailed about how it ended: when it has failed, or when it has finished after running for longer than 30 seconds. It defaults to true. An integration that polls the job usually sets it to false, which skips both emails. **API key scope required:** `DOMAINS_WRITE`. Requests authenticated with a seller session do not need any scope.
|
|
296
300
|
* Import domains
|
|
297
301
|
*/
|
|
298
|
-
async batchImportRaw(requestParameters: DomainsApiBatchImportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<
|
|
302
|
+
async batchImportRaw(requestParameters: DomainsApiBatchImportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ImportDomainsResponseDto>> {
|
|
299
303
|
const queryParameters: any = {};
|
|
300
304
|
|
|
301
305
|
const headerParameters: runtime.HTTPHeaders = {};
|
|
@@ -336,6 +340,10 @@ export class DomainsApi extends runtime.BaseAPI {
|
|
|
336
340
|
formParams.append('file', requestParameters['file'] as any);
|
|
337
341
|
}
|
|
338
342
|
|
|
343
|
+
if (requestParameters['notifyByEmail'] != null) {
|
|
344
|
+
formParams.append('notifyByEmail', requestParameters['notifyByEmail'] as any);
|
|
345
|
+
}
|
|
346
|
+
|
|
339
347
|
const response = await this.request({
|
|
340
348
|
path: `/private/domains`,
|
|
341
349
|
method: 'POST',
|
|
@@ -344,15 +352,16 @@ export class DomainsApi extends runtime.BaseAPI {
|
|
|
344
352
|
body: formParams,
|
|
345
353
|
}, initOverrides);
|
|
346
354
|
|
|
347
|
-
return new runtime.
|
|
355
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => ImportDomainsResponseDtoFromJSON(jsonValue));
|
|
348
356
|
}
|
|
349
357
|
|
|
350
358
|
/**
|
|
351
|
-
* Imports domains from an uploaded file or a list of domain names and
|
|
359
|
+
* Imports domains from an uploaded file or a list of domain names. A list is imported before the response is sent, and answered with 201. A file is imported in the background: 1. The upload is answered with 202 and the job, which the `Location` header points at as well. The id to poll is at `job.id`. 2. Poll `GET /private/jobs/{jobId}` until its `status` is `finished` or `failed`. 3. Download the outcome of every row from `GET /private/jobs/{jobId}/result`, which redirects to a CSV on a public host. Follow the redirect without the `apikey` header, which the file does not need. With an API key, starting an import needs the `DOMAINS_WRITE` scope, while polling the job and downloading its result need `DOMAINS_READ`. Scopes are matched exactly, so a key that imports files needs both. `notifyByEmail` decides whether the user who started a file import is emailed about how it ended: when it has failed, or when it has finished after running for longer than 30 seconds. It defaults to true. An integration that polls the job usually sets it to false, which skips both emails. **API key scope required:** `DOMAINS_WRITE`. Requests authenticated with a seller session do not need any scope.
|
|
352
360
|
* Import domains
|
|
353
361
|
*/
|
|
354
|
-
async batchImport(requestParameters: DomainsApiBatchImportRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<
|
|
355
|
-
await this.batchImportRaw(requestParameters, initOverrides);
|
|
362
|
+
async batchImport(requestParameters: DomainsApiBatchImportRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ImportDomainsResponseDto> {
|
|
363
|
+
const response = await this.batchImportRaw(requestParameters, initOverrides);
|
|
364
|
+
return await response.value();
|
|
356
365
|
}
|
|
357
366
|
|
|
358
367
|
/**
|