@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.
Files changed (50) hide show
  1. package/.openapi-generator/FILES +1 -0
  2. package/README.md +3 -3
  3. package/dist/apis/AdminApi.d.ts +15 -2
  4. package/dist/apis/AdminApi.js +55 -2
  5. package/dist/apis/DomainsApi.d.ts +6 -5
  6. package/dist/apis/DomainsApi.js +10 -5
  7. package/dist/apis/JobsApi.d.ts +17 -4
  8. package/dist/apis/JobsApi.js +65 -4
  9. package/dist/models/AccountAliasDto.d.ts +18 -3
  10. package/dist/models/AccountAliasDto.js +13 -0
  11. package/dist/models/AccountSettingsAliasDto.d.ts +18 -3
  12. package/dist/models/AccountSettingsAliasDto.js +13 -0
  13. package/dist/models/AdminListAccountDto.d.ts +16 -1
  14. package/dist/models/AdminListAccountDto.js +13 -1
  15. package/dist/models/BuyerNotificationDto.d.ts +2 -0
  16. package/dist/models/BuyerNotificationDto.js +2 -0
  17. package/dist/models/BuyerNotificationListItemDto.d.ts +2 -0
  18. package/dist/models/BuyerNotificationListItemDto.js +2 -0
  19. package/dist/models/CustomerSuccessListAccountDto.d.ts +16 -1
  20. package/dist/models/CustomerSuccessListAccountDto.js +13 -1
  21. package/dist/models/ImportDomainsResponseDto.d.ts +33 -0
  22. package/dist/models/ImportDomainsResponseDto.js +52 -0
  23. package/dist/models/JobDto.d.ts +21 -1
  24. package/dist/models/JobDto.js +11 -0
  25. package/dist/models/JobFailureDto.d.ts +1 -1
  26. package/dist/models/JobType.d.ts +1 -0
  27. package/dist/models/JobType.js +2 -1
  28. package/dist/models/UserNotificationDto.d.ts +2 -0
  29. package/dist/models/UserNotificationDto.js +2 -0
  30. package/dist/models/UserNotificationListItemDto.d.ts +2 -0
  31. package/dist/models/UserNotificationListItemDto.js +2 -0
  32. package/dist/models/index.d.ts +1 -0
  33. package/dist/models/index.js +1 -0
  34. package/package.json +1 -1
  35. package/src/apis/AdminApi.ts +48 -2
  36. package/src/apis/DomainsApi.ts +15 -6
  37. package/src/apis/JobsApi.ts +57 -4
  38. package/src/models/AccountAliasDto.ts +24 -3
  39. package/src/models/AccountSettingsAliasDto.ts +24 -3
  40. package/src/models/AdminListAccountDto.ts +20 -1
  41. package/src/models/BuyerNotificationDto.ts +2 -0
  42. package/src/models/BuyerNotificationListItemDto.ts +2 -0
  43. package/src/models/CustomerSuccessListAccountDto.ts +20 -1
  44. package/src/models/ImportDomainsResponseDto.ts +74 -0
  45. package/src/models/JobDto.ts +27 -1
  46. package/src/models/JobFailureDto.ts +1 -1
  47. package/src/models/JobType.ts +2 -1
  48. package/src/models/UserNotificationDto.ts +2 -0
  49. package/src/models/UserNotificationListItemDto.ts +2 -0
  50. package/src/models/index.ts +1 -0
@@ -15,12 +15,15 @@
15
15
 
16
16
  import * as runtime from '../runtime';
17
17
  import type {
18
+ ConflictException,
18
19
  JobDto,
19
20
  ListJobs200Response,
20
21
  NotFoundException,
21
22
  ValidationException,
22
23
  } from '../models/index';
23
24
  import {
25
+ ConflictExceptionFromJSON,
26
+ ConflictExceptionToJSON,
24
27
  JobDtoFromJSON,
25
28
  JobDtoToJSON,
26
29
  ListJobs200ResponseFromJSON,
@@ -35,6 +38,10 @@ export interface JobsApiGetJobRequest {
35
38
  jobId: string;
36
39
  }
37
40
 
41
+ export interface JobsApiGetJobResultRequest {
42
+ jobId: string;
43
+ }
44
+
38
45
  export interface JobsApiListJobsRequest {
39
46
  filter?: { [key: string]: string; };
40
47
  page?: number;
@@ -50,7 +57,7 @@ export interface JobsApiListJobsRequest {
50
57
  export class JobsApi extends runtime.BaseAPI {
51
58
 
52
59
  /**
53
- * Progress and result of one job belonging to the account. **API key scope required:** `DOMAINS_READ`. Requests authenticated with a seller session do not need any scope.
60
+ * Progress and result of one job belonging to the account. A finished import links the outcome of every row in `resultFileUrl`. **API key scope required:** `DOMAINS_READ`. Requests authenticated with a seller session do not need any scope.
54
61
  * Get a background job
55
62
  */
56
63
  async getJobRaw(requestParameters: JobsApiGetJobRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<JobDto>> {
@@ -88,7 +95,7 @@ export class JobsApi extends runtime.BaseAPI {
88
95
  }
89
96
 
90
97
  /**
91
- * Progress and result of one job belonging to the account. **API key scope required:** `DOMAINS_READ`. Requests authenticated with a seller session do not need any scope.
98
+ * Progress and result of one job belonging to the account. A finished import links the outcome of every row in `resultFileUrl`. **API key scope required:** `DOMAINS_READ`. Requests authenticated with a seller session do not need any scope.
92
99
  * Get a background job
93
100
  */
94
101
  async getJob(requestParameters: JobsApiGetJobRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<JobDto> {
@@ -97,7 +104,53 @@ export class JobsApi extends runtime.BaseAPI {
97
104
  }
98
105
 
99
106
  /**
100
- * The account\'s own background jobs, newest first. Filter on status while polling, so watching a run costs nothing however long the history is. **API key scope required:** `DOMAINS_READ`. Requests authenticated with a seller session do not need any scope.
107
+ * Redirects to the CSV with the outcome of every row of a finished import: the file the job\'s `resultFileUrl` links, which anyone who has the link can download. Follow the redirect without the `apikey` header: the file does not need it, and most HTTP clients, `curl -L` among them, keep sending a custom header when a redirect takes them to another host. Downloading `resultFileUrl` itself avoids the redirect altogether. The file can expire: when the bucket has a retention rule, the file is removed once it has run out, and the link then answers 404. **API key scope required:** `DOMAINS_READ`. Requests authenticated with a seller session do not need any scope.
108
+ * Download the result file of a background job
109
+ */
110
+ async getJobResultRaw(requestParameters: JobsApiGetJobResultRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
111
+ if (requestParameters['jobId'] == null) {
112
+ throw new runtime.RequiredError(
113
+ 'jobId',
114
+ 'Required parameter "jobId" was null or undefined when calling getJobResult().'
115
+ );
116
+ }
117
+
118
+ const queryParameters: any = {};
119
+
120
+ const headerParameters: runtime.HTTPHeaders = {};
121
+
122
+ if (this.configuration && this.configuration.apiKey) {
123
+ headerParameters["apikey"] = await this.configuration.apiKey("apikey"); // api_key authentication
124
+ }
125
+
126
+ if (this.configuration && this.configuration.accessToken) {
127
+ const token = this.configuration.accessToken;
128
+ const tokenString = await token("bearer", []);
129
+
130
+ if (tokenString) {
131
+ headerParameters["Authorization"] = `Bearer ${tokenString}`;
132
+ }
133
+ }
134
+ const response = await this.request({
135
+ path: `/private/jobs/{jobId}/result`.replace(`{${"jobId"}}`, encodeURIComponent(String(requestParameters['jobId']))),
136
+ method: 'GET',
137
+ headers: headerParameters,
138
+ query: queryParameters,
139
+ }, initOverrides);
140
+
141
+ return new runtime.VoidApiResponse(response);
142
+ }
143
+
144
+ /**
145
+ * Redirects to the CSV with the outcome of every row of a finished import: the file the job\'s `resultFileUrl` links, which anyone who has the link can download. Follow the redirect without the `apikey` header: the file does not need it, and most HTTP clients, `curl -L` among them, keep sending a custom header when a redirect takes them to another host. Downloading `resultFileUrl` itself avoids the redirect altogether. The file can expire: when the bucket has a retention rule, the file is removed once it has run out, and the link then answers 404. **API key scope required:** `DOMAINS_READ`. Requests authenticated with a seller session do not need any scope.
146
+ * Download the result file of a background job
147
+ */
148
+ async getJobResult(requestParameters: JobsApiGetJobResultRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
149
+ await this.getJobResultRaw(requestParameters, initOverrides);
150
+ }
151
+
152
+ /**
153
+ * The account\'s own background jobs, newest first. Filter on status while polling, so watching a run costs nothing however long the history is. A finished job that wrote a result file links it in `resultFileUrl`. **API key scope required:** `DOMAINS_READ`. Requests authenticated with a seller session do not need any scope.
101
154
  * List background jobs
102
155
  */
103
156
  async listJobsRaw(requestParameters: JobsApiListJobsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListJobs200Response>> {
@@ -152,7 +205,7 @@ export class JobsApi extends runtime.BaseAPI {
152
205
  }
153
206
 
154
207
  /**
155
- * The account\'s own background jobs, newest first. Filter on status while polling, so watching a run costs nothing however long the history is. **API key scope required:** `DOMAINS_READ`. Requests authenticated with a seller session do not need any scope.
208
+ * The account\'s own background jobs, newest first. Filter on status while polling, so watching a run costs nothing however long the history is. A finished job that wrote a result file links it in `resultFileUrl`. **API key scope required:** `DOMAINS_READ`. Requests authenticated with a seller session do not need any scope.
156
209
  * List background jobs
157
210
  */
158
211
  async listJobs(requestParameters: JobsApiListJobsRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListJobs200Response> {
@@ -20,25 +20,44 @@ import { mapValues } from '../runtime';
20
20
  */
21
21
  export interface AccountAliasDto {
22
22
  /**
23
- * Account alias string.
23
+ * Account alias string; null when no alias is set.
24
24
  * @type {string}
25
25
  * @memberof AccountAliasDto
26
26
  */
27
- alias: string;
27
+ alias: string | null;
28
28
  /**
29
- * Whether the alias has been verified.
29
+ * Deprecated, use status. Whether the alias has been verified.
30
30
  * @type {boolean}
31
31
  * @memberof AccountAliasDto
32
32
  */
33
33
  verified: boolean;
34
+ /**
35
+ * Review status of the alias: pending review, verified (shown on the landing pages) or rejected by an admin. Null when no alias is set.
36
+ * @type {string}
37
+ * @memberof AccountAliasDto
38
+ */
39
+ status: AccountAliasDtoStatusEnum | null;
34
40
  }
35
41
 
42
+
43
+ /**
44
+ * @export
45
+ */
46
+ export const AccountAliasDtoStatusEnum = {
47
+ PENDING: 'pending',
48
+ VERIFIED: 'verified',
49
+ REJECTED: 'rejected'
50
+ } as const;
51
+ export type AccountAliasDtoStatusEnum = typeof AccountAliasDtoStatusEnum[keyof typeof AccountAliasDtoStatusEnum];
52
+
53
+
36
54
  /**
37
55
  * Check if a given object implements the AccountAliasDto interface.
38
56
  */
39
57
  export function instanceOfAccountAliasDto(value: object): value is AccountAliasDto {
40
58
  if (!('alias' in value) || value['alias'] === undefined) return false;
41
59
  if (!('verified' in value) || value['verified'] === undefined) return false;
60
+ if (!('status' in value) || value['status'] === undefined) return false;
42
61
  return true;
43
62
  }
44
63
 
@@ -54,6 +73,7 @@ export function AccountAliasDtoFromJSONTyped(json: any, ignoreDiscriminator: boo
54
73
 
55
74
  'alias': json['alias'],
56
75
  'verified': json['verified'],
76
+ 'status': json['status'],
57
77
  };
58
78
  }
59
79
 
@@ -70,6 +90,7 @@ export function AccountAliasDtoToJSONTyped(value?: AccountAliasDto | null, ignor
70
90
 
71
91
  'alias': value['alias'],
72
92
  'verified': value['verified'],
93
+ 'status': value['status'],
73
94
  };
74
95
  }
75
96
 
@@ -20,25 +20,44 @@ import { mapValues } from '../runtime';
20
20
  */
21
21
  export interface AccountSettingsAliasDto {
22
22
  /**
23
- * Account alias string.
23
+ * Account alias string; null when no alias is set.
24
24
  * @type {string}
25
25
  * @memberof AccountSettingsAliasDto
26
26
  */
27
- alias: string;
27
+ alias: string | null;
28
28
  /**
29
- * Whether the alias has been verified.
29
+ * Deprecated, use status. Whether the alias has been verified.
30
30
  * @type {boolean}
31
31
  * @memberof AccountSettingsAliasDto
32
32
  */
33
33
  verified: boolean;
34
+ /**
35
+ * Review status of the alias: pending review, verified (shown on the landing pages) or rejected by an admin. Null when no alias is set.
36
+ * @type {string}
37
+ * @memberof AccountSettingsAliasDto
38
+ */
39
+ status: AccountSettingsAliasDtoStatusEnum | null;
34
40
  }
35
41
 
42
+
43
+ /**
44
+ * @export
45
+ */
46
+ export const AccountSettingsAliasDtoStatusEnum = {
47
+ PENDING: 'pending',
48
+ VERIFIED: 'verified',
49
+ REJECTED: 'rejected'
50
+ } as const;
51
+ export type AccountSettingsAliasDtoStatusEnum = typeof AccountSettingsAliasDtoStatusEnum[keyof typeof AccountSettingsAliasDtoStatusEnum];
52
+
53
+
36
54
  /**
37
55
  * Check if a given object implements the AccountSettingsAliasDto interface.
38
56
  */
39
57
  export function instanceOfAccountSettingsAliasDto(value: object): value is AccountSettingsAliasDto {
40
58
  if (!('alias' in value) || value['alias'] === undefined) return false;
41
59
  if (!('verified' in value) || value['verified'] === undefined) return false;
60
+ if (!('status' in value) || value['status'] === undefined) return false;
42
61
  return true;
43
62
  }
44
63
 
@@ -54,6 +73,7 @@ export function AccountSettingsAliasDtoFromJSONTyped(json: any, ignoreDiscrimina
54
73
 
55
74
  'alias': json['alias'],
56
75
  'verified': json['verified'],
76
+ 'status': json['status'],
57
77
  };
58
78
  }
59
79
 
@@ -70,6 +90,7 @@ export function AccountSettingsAliasDtoToJSONTyped(value?: AccountSettingsAliasD
70
90
 
71
91
  'alias': value['alias'],
72
92
  'verified': value['verified'],
93
+ 'status': value['status'],
73
94
  };
74
95
  }
75
96
 
@@ -110,11 +110,17 @@ export interface AdminListAccountDto {
110
110
  */
111
111
  alias: string | null;
112
112
  /**
113
- * Whether the alias is verified.
113
+ * Deprecated, use aliasStatus. Whether the alias is verified.
114
114
  * @type {boolean}
115
115
  * @memberof AdminListAccountDto
116
116
  */
117
117
  aliasVerified: boolean;
118
+ /**
119
+ * Review status of the alias: pending review, verified or rejected. Null when no alias is set.
120
+ * @type {string}
121
+ * @memberof AdminListAccountDto
122
+ */
123
+ aliasStatus: AdminListAccountDtoAliasStatusEnum | null;
118
124
  /**
119
125
  * Account metrics.
120
126
  * @type {ListAccountMetricsDto}
@@ -184,6 +190,16 @@ export interface AdminListAccountDto {
184
190
  }
185
191
 
186
192
 
193
+ /**
194
+ * @export
195
+ */
196
+ export const AdminListAccountDtoAliasStatusEnum = {
197
+ PENDING: 'pending',
198
+ VERIFIED: 'verified',
199
+ REJECTED: 'rejected'
200
+ } as const;
201
+ export type AdminListAccountDtoAliasStatusEnum = typeof AdminListAccountDtoAliasStatusEnum[keyof typeof AdminListAccountDtoAliasStatusEnum];
202
+
187
203
  /**
188
204
  * @export
189
205
  */
@@ -227,6 +243,7 @@ export function instanceOfAdminListAccountDto(value: object): value is AdminList
227
243
  if (!('type' in value) || value['type'] === undefined) return false;
228
244
  if (!('alias' in value) || value['alias'] === undefined) return false;
229
245
  if (!('aliasVerified' in value) || value['aliasVerified'] === undefined) return false;
246
+ if (!('aliasStatus' in value) || value['aliasStatus'] === undefined) return false;
230
247
  if (!('metrics' in value) || value['metrics'] === undefined) return false;
231
248
  if (!('lastOnline' in value) || value['lastOnline'] === undefined) return false;
232
249
  if (!('users' in value) || value['users'] === undefined) return false;
@@ -261,6 +278,7 @@ export function AdminListAccountDtoFromJSONTyped(json: any, ignoreDiscriminator:
261
278
  'type': json['type'],
262
279
  'alias': json['alias'],
263
280
  'aliasVerified': json['aliasVerified'],
281
+ 'aliasStatus': json['aliasStatus'],
264
282
  'metrics': ListAccountMetricsDtoFromJSON(json['metrics']),
265
283
  'lastOnline': (new Date(json['lastOnline'])),
266
284
  'users': ((json['users'] as Array<any>).map(ListAccountUserDtoFromJSON)),
@@ -296,6 +314,7 @@ export function AdminListAccountDtoToJSONTyped(value?: AdminListAccountDto | nul
296
314
  'type': value['type'],
297
315
  'alias': value['alias'],
298
316
  'aliasVerified': value['aliasVerified'],
317
+ 'aliasStatus': value['aliasStatus'],
299
318
  'metrics': ListAccountMetricsDtoToJSON(value['metrics']),
300
319
  'lastOnline': ((value['lastOnline']).toISOString()),
301
320
  'users': ((value['users'] as Array<any>).map(ListAccountUserDtoToJSON)),
@@ -81,6 +81,7 @@ export const BuyerNotificationDtoTypeEnum = {
81
81
  ACCOUNT_ONBOARDING_FINISHED: 'account_onboarding_finished',
82
82
  ACCOUNT_ONBOARDING_REJECTED: 'account_onboarding_rejected',
83
83
  ACCOUNT_BANK_ACCOUNT_VERIFICATION_SUCCEEDED: 'account_bank_account_verification_succeeded',
84
+ ACCOUNT_ALIAS_REJECTED: 'account_alias_rejected',
84
85
  BUYER_ACCESS_TOKEN: 'buyer_access_token',
85
86
  DOMAIN_TRANSFER_REQUEST_AUTH_CODE_TO_SELLER: 'domain_transfer.request_auth_code_to_seller',
86
87
  DOMAIN_TRANSFER_VALIDATION_REQUIRED_BY_BUYER_EMAIL: 'domain_transfer_validation_required_by_buyer_email',
@@ -108,6 +109,7 @@ export const BuyerNotificationDtoTypeEnum = {
108
109
  REQUEST_IPS_TAG_TO_SELLER_IPS_TAG_INVALID: 'request_ips_tag_to_seller_ips_tag_invalid',
109
110
  EXPORT_COMPLETED: 'export_completed',
110
111
  DOMAIN_IMPORT_FINISHED: 'domain_import_finished',
112
+ DOMAIN_IMPORT_FAILED: 'domain_import_failed',
111
113
  DOMAIN_OFFER_VERIFIED_BUYER_ACCESS_LINK_EMAIL: 'domain_offer_verified_buyer_access_link_email',
112
114
  DOMAIN_OFFER_RECEIVED_BUYER_ACCESS_LINK_EMAIL: 'domain_offer_received_buyer_access_link_email',
113
115
  DOMAIN_OFFER_ACCEPTED_CONTINUE_ORDER_EMAIL: 'domain_offer_accepted_continue_order_email',
@@ -67,6 +67,7 @@ export const BuyerNotificationListItemDtoTypeEnum = {
67
67
  ACCOUNT_ONBOARDING_FINISHED: 'account_onboarding_finished',
68
68
  ACCOUNT_ONBOARDING_REJECTED: 'account_onboarding_rejected',
69
69
  ACCOUNT_BANK_ACCOUNT_VERIFICATION_SUCCEEDED: 'account_bank_account_verification_succeeded',
70
+ ACCOUNT_ALIAS_REJECTED: 'account_alias_rejected',
70
71
  BUYER_ACCESS_TOKEN: 'buyer_access_token',
71
72
  DOMAIN_TRANSFER_REQUEST_AUTH_CODE_TO_SELLER: 'domain_transfer.request_auth_code_to_seller',
72
73
  DOMAIN_TRANSFER_VALIDATION_REQUIRED_BY_BUYER_EMAIL: 'domain_transfer_validation_required_by_buyer_email',
@@ -94,6 +95,7 @@ export const BuyerNotificationListItemDtoTypeEnum = {
94
95
  REQUEST_IPS_TAG_TO_SELLER_IPS_TAG_INVALID: 'request_ips_tag_to_seller_ips_tag_invalid',
95
96
  EXPORT_COMPLETED: 'export_completed',
96
97
  DOMAIN_IMPORT_FINISHED: 'domain_import_finished',
98
+ DOMAIN_IMPORT_FAILED: 'domain_import_failed',
97
99
  DOMAIN_OFFER_VERIFIED_BUYER_ACCESS_LINK_EMAIL: 'domain_offer_verified_buyer_access_link_email',
98
100
  DOMAIN_OFFER_RECEIVED_BUYER_ACCESS_LINK_EMAIL: 'domain_offer_received_buyer_access_link_email',
99
101
  DOMAIN_OFFER_ACCEPTED_CONTINUE_ORDER_EMAIL: 'domain_offer_accepted_continue_order_email',
@@ -110,11 +110,17 @@ export interface CustomerSuccessListAccountDto {
110
110
  */
111
111
  alias: string | null;
112
112
  /**
113
- * Whether the alias is verified.
113
+ * Deprecated, use aliasStatus. Whether the alias is verified.
114
114
  * @type {boolean}
115
115
  * @memberof CustomerSuccessListAccountDto
116
116
  */
117
117
  aliasVerified: boolean;
118
+ /**
119
+ * Review status of the alias: pending review, verified or rejected. Null when no alias is set.
120
+ * @type {string}
121
+ * @memberof CustomerSuccessListAccountDto
122
+ */
123
+ aliasStatus: CustomerSuccessListAccountDtoAliasStatusEnum | null;
118
124
  /**
119
125
  * Account metrics.
120
126
  * @type {CustomerSuccessListAccountMetricsDto}
@@ -184,6 +190,16 @@ export interface CustomerSuccessListAccountDto {
184
190
  }
185
191
 
186
192
 
193
+ /**
194
+ * @export
195
+ */
196
+ export const CustomerSuccessListAccountDtoAliasStatusEnum = {
197
+ PENDING: 'pending',
198
+ VERIFIED: 'verified',
199
+ REJECTED: 'rejected'
200
+ } as const;
201
+ export type CustomerSuccessListAccountDtoAliasStatusEnum = typeof CustomerSuccessListAccountDtoAliasStatusEnum[keyof typeof CustomerSuccessListAccountDtoAliasStatusEnum];
202
+
187
203
  /**
188
204
  * @export
189
205
  */
@@ -227,6 +243,7 @@ export function instanceOfCustomerSuccessListAccountDto(value: object): value is
227
243
  if (!('type' in value) || value['type'] === undefined) return false;
228
244
  if (!('alias' in value) || value['alias'] === undefined) return false;
229
245
  if (!('aliasVerified' in value) || value['aliasVerified'] === undefined) return false;
246
+ if (!('aliasStatus' in value) || value['aliasStatus'] === undefined) return false;
230
247
  if (!('metrics' in value) || value['metrics'] === undefined) return false;
231
248
  if (!('lastOnline' in value) || value['lastOnline'] === undefined) return false;
232
249
  if (!('users' in value) || value['users'] === undefined) return false;
@@ -261,6 +278,7 @@ export function CustomerSuccessListAccountDtoFromJSONTyped(json: any, ignoreDisc
261
278
  'type': json['type'],
262
279
  'alias': json['alias'],
263
280
  'aliasVerified': json['aliasVerified'],
281
+ 'aliasStatus': json['aliasStatus'],
264
282
  'metrics': CustomerSuccessListAccountMetricsDtoFromJSON(json['metrics']),
265
283
  'lastOnline': (new Date(json['lastOnline'])),
266
284
  'users': ((json['users'] as Array<any>).map(CustomerSuccessListAccountUserDtoFromJSON)),
@@ -296,6 +314,7 @@ export function CustomerSuccessListAccountDtoToJSONTyped(value?: CustomerSuccess
296
314
  'type': value['type'],
297
315
  'alias': value['alias'],
298
316
  'aliasVerified': value['aliasVerified'],
317
+ 'aliasStatus': value['aliasStatus'],
299
318
  'metrics': CustomerSuccessListAccountMetricsDtoToJSON(value['metrics']),
300
319
  'lastOnline': ((value['lastOnline']).toISOString()),
301
320
  'users': ((value['users'] as Array<any>).map(CustomerSuccessListAccountUserDtoToJSON)),
@@ -0,0 +1,74 @@
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 { JobDto } from './JobDto';
17
+ import {
18
+ JobDtoFromJSON,
19
+ JobDtoFromJSONTyped,
20
+ JobDtoToJSON,
21
+ JobDtoToJSONTyped,
22
+ } from './JobDto';
23
+
24
+ /**
25
+ *
26
+ * @export
27
+ * @interface ImportDomainsResponseDto
28
+ */
29
+ export interface ImportDomainsResponseDto {
30
+ /**
31
+ * The background job importing the uploaded file. Null for a list of domain names, which is imported before the response is sent.
32
+ * @type {JobDto}
33
+ * @memberof ImportDomainsResponseDto
34
+ */
35
+ job: JobDto | null;
36
+ }
37
+
38
+ /**
39
+ * Check if a given object implements the ImportDomainsResponseDto interface.
40
+ */
41
+ export function instanceOfImportDomainsResponseDto(value: object): value is ImportDomainsResponseDto {
42
+ if (!('job' in value) || value['job'] === undefined) return false;
43
+ return true;
44
+ }
45
+
46
+ export function ImportDomainsResponseDtoFromJSON(json: any): ImportDomainsResponseDto {
47
+ return ImportDomainsResponseDtoFromJSONTyped(json, false);
48
+ }
49
+
50
+ export function ImportDomainsResponseDtoFromJSONTyped(json: any, ignoreDiscriminator: boolean): ImportDomainsResponseDto {
51
+ if (json == null) {
52
+ return json;
53
+ }
54
+ return {
55
+
56
+ 'job': JobDtoFromJSON(json['job']),
57
+ };
58
+ }
59
+
60
+ export function ImportDomainsResponseDtoToJSON(json: any): ImportDomainsResponseDto {
61
+ return ImportDomainsResponseDtoToJSONTyped(json, false);
62
+ }
63
+
64
+ export function ImportDomainsResponseDtoToJSONTyped(value?: ImportDomainsResponseDto | null, ignoreDiscriminator: boolean = false): any {
65
+ if (value == null) {
66
+ return value;
67
+ }
68
+
69
+ return {
70
+
71
+ 'job': JobDtoToJSON(value['job']),
72
+ };
73
+ }
74
+
@@ -89,12 +89,30 @@ export interface JobDto {
89
89
  * @memberof JobDto
90
90
  */
91
91
  failures: Array<JobFailureDto>;
92
+ /**
93
+ * 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.
94
+ * @type {{ [key: string]: number; }}
95
+ * @memberof JobDto
96
+ */
97
+ result: { [key: string]: number; } | null;
98
+ /**
99
+ * 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.
100
+ * @type {string}
101
+ * @memberof JobDto
102
+ */
103
+ resultFileUrl: string | null;
92
104
  /**
93
105
  * Why the job as a whole stopped. Never a per-item problem.
94
106
  * @type {string}
95
107
  * @memberof JobDto
96
108
  */
97
109
  failureReason: string | null;
110
+ /**
111
+ * 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.
112
+ * @type {boolean}
113
+ * @memberof JobDto
114
+ */
115
+ readonly notifyByEmail: boolean;
98
116
  /**
99
117
  *
100
118
  * @type {Date}
@@ -129,7 +147,10 @@ export function instanceOfJobDto(value: object): value is JobDto {
129
147
  if (!('succeeded' in value) || value['succeeded'] === undefined) return false;
130
148
  if (!('failed' in value) || value['failed'] === undefined) return false;
131
149
  if (!('failures' in value) || value['failures'] === undefined) return false;
150
+ if (!('result' in value) || value['result'] === undefined) return false;
151
+ if (!('resultFileUrl' in value) || value['resultFileUrl'] === undefined) return false;
132
152
  if (!('failureReason' in value) || value['failureReason'] === undefined) return false;
153
+ if (!('notifyByEmail' in value) || value['notifyByEmail'] === undefined) return false;
133
154
  if (!('createdAt' in value) || value['createdAt'] === undefined) return false;
134
155
  if (!('startedAt' in value) || value['startedAt'] === undefined) return false;
135
156
  if (!('finishedAt' in value) || value['finishedAt'] === undefined) return false;
@@ -154,7 +175,10 @@ export function JobDtoFromJSONTyped(json: any, ignoreDiscriminator: boolean): Jo
154
175
  'succeeded': json['succeeded'],
155
176
  'failed': json['failed'],
156
177
  'failures': ((json['failures'] as Array<any>).map(JobFailureDtoFromJSON)),
178
+ 'result': json['result'],
179
+ 'resultFileUrl': json['resultFileUrl'],
157
180
  'failureReason': json['failureReason'],
181
+ 'notifyByEmail': json['notifyByEmail'],
158
182
  'createdAt': (new Date(json['createdAt'])),
159
183
  'startedAt': (json['startedAt'] == null ? null : new Date(json['startedAt'])),
160
184
  'finishedAt': (json['finishedAt'] == null ? null : new Date(json['finishedAt'])),
@@ -165,7 +189,7 @@ export function JobDtoToJSON(json: any): JobDto {
165
189
  return JobDtoToJSONTyped(json, false);
166
190
  }
167
191
 
168
- export function JobDtoToJSONTyped(value?: JobDto | null, ignoreDiscriminator: boolean = false): any {
192
+ export function JobDtoToJSONTyped(value?: Omit<JobDto, 'notifyByEmail'> | null, ignoreDiscriminator: boolean = false): any {
169
193
  if (value == null) {
170
194
  return value;
171
195
  }
@@ -180,6 +204,8 @@ export function JobDtoToJSONTyped(value?: JobDto | null, ignoreDiscriminator: bo
180
204
  'succeeded': value['succeeded'],
181
205
  'failed': value['failed'],
182
206
  'failures': ((value['failures'] as Array<any>).map(JobFailureDtoToJSON)),
207
+ 'result': value['result'],
208
+ 'resultFileUrl': value['resultFileUrl'],
183
209
  'failureReason': value['failureReason'],
184
210
  'createdAt': ((value['createdAt']).toISOString()),
185
211
  'startedAt': (value['startedAt'] == null ? null : (value['startedAt'] as any).toISOString()),
@@ -20,7 +20,7 @@ import { mapValues } from '../runtime';
20
20
  */
21
21
  export interface JobFailureDto {
22
22
  /**
23
- * What the failure was about — a domain name, for a bulk edit.
23
+ * What the failure was about, usually a domain name: the domain a bulk edit refused, or an import row as it was uploaded.
24
24
  * @type {string}
25
25
  * @memberof JobFailureDto
26
26
  */
@@ -18,7 +18,8 @@
18
18
  * @export
19
19
  */
20
20
  export const JobType = {
21
- BULK_EDIT_DOMAINS: 'bulk_edit_domains'
21
+ BULK_EDIT_DOMAINS: 'bulk_edit_domains',
22
+ IMPORT_DOMAINS: 'import_domains'
22
23
  } as const;
23
24
  export type JobType = typeof JobType[keyof typeof JobType];
24
25
 
@@ -81,6 +81,7 @@ export const UserNotificationDtoTypeEnum = {
81
81
  ACCOUNT_ONBOARDING_FINISHED: 'account_onboarding_finished',
82
82
  ACCOUNT_ONBOARDING_REJECTED: 'account_onboarding_rejected',
83
83
  ACCOUNT_BANK_ACCOUNT_VERIFICATION_SUCCEEDED: 'account_bank_account_verification_succeeded',
84
+ ACCOUNT_ALIAS_REJECTED: 'account_alias_rejected',
84
85
  BUYER_ACCESS_TOKEN: 'buyer_access_token',
85
86
  DOMAIN_TRANSFER_REQUEST_AUTH_CODE_TO_SELLER: 'domain_transfer.request_auth_code_to_seller',
86
87
  DOMAIN_TRANSFER_VALIDATION_REQUIRED_BY_BUYER_EMAIL: 'domain_transfer_validation_required_by_buyer_email',
@@ -108,6 +109,7 @@ export const UserNotificationDtoTypeEnum = {
108
109
  REQUEST_IPS_TAG_TO_SELLER_IPS_TAG_INVALID: 'request_ips_tag_to_seller_ips_tag_invalid',
109
110
  EXPORT_COMPLETED: 'export_completed',
110
111
  DOMAIN_IMPORT_FINISHED: 'domain_import_finished',
112
+ DOMAIN_IMPORT_FAILED: 'domain_import_failed',
111
113
  DOMAIN_OFFER_VERIFIED_BUYER_ACCESS_LINK_EMAIL: 'domain_offer_verified_buyer_access_link_email',
112
114
  DOMAIN_OFFER_RECEIVED_BUYER_ACCESS_LINK_EMAIL: 'domain_offer_received_buyer_access_link_email',
113
115
  DOMAIN_OFFER_ACCEPTED_CONTINUE_ORDER_EMAIL: 'domain_offer_accepted_continue_order_email',
@@ -67,6 +67,7 @@ export const UserNotificationListItemDtoTypeEnum = {
67
67
  ACCOUNT_ONBOARDING_FINISHED: 'account_onboarding_finished',
68
68
  ACCOUNT_ONBOARDING_REJECTED: 'account_onboarding_rejected',
69
69
  ACCOUNT_BANK_ACCOUNT_VERIFICATION_SUCCEEDED: 'account_bank_account_verification_succeeded',
70
+ ACCOUNT_ALIAS_REJECTED: 'account_alias_rejected',
70
71
  BUYER_ACCESS_TOKEN: 'buyer_access_token',
71
72
  DOMAIN_TRANSFER_REQUEST_AUTH_CODE_TO_SELLER: 'domain_transfer.request_auth_code_to_seller',
72
73
  DOMAIN_TRANSFER_VALIDATION_REQUIRED_BY_BUYER_EMAIL: 'domain_transfer_validation_required_by_buyer_email',
@@ -94,6 +95,7 @@ export const UserNotificationListItemDtoTypeEnum = {
94
95
  REQUEST_IPS_TAG_TO_SELLER_IPS_TAG_INVALID: 'request_ips_tag_to_seller_ips_tag_invalid',
95
96
  EXPORT_COMPLETED: 'export_completed',
96
97
  DOMAIN_IMPORT_FINISHED: 'domain_import_finished',
98
+ DOMAIN_IMPORT_FAILED: 'domain_import_failed',
97
99
  DOMAIN_OFFER_VERIFIED_BUYER_ACCESS_LINK_EMAIL: 'domain_offer_verified_buyer_access_link_email',
98
100
  DOMAIN_OFFER_RECEIVED_BUYER_ACCESS_LINK_EMAIL: 'domain_offer_received_buyer_access_link_email',
99
101
  DOMAIN_OFFER_ACCEPTED_CONTINUE_ORDER_EMAIL: 'domain_offer_accepted_continue_order_email',
@@ -276,6 +276,7 @@ export * from './GetSellerChallengesListDto';
276
276
  export * from './GetSellerChallengesListDtoChallengesInner';
277
277
  export * from './HistoricalMetrics';
278
278
  export * from './HttpException';
279
+ export * from './ImportDomainsResponseDto';
279
280
  export * from './IntersectionAccountDtoWithSettingsDtoWithNotificationsDtoWithFeatureFlagsDto';
280
281
  export * from './IntersectionDomainDtoWithAccountDtoWithAuctionInfoDto';
281
282
  export * from './IntersectionDomainDtoWithHijackerDtoWithAccountDto';