@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
@@ -315,6 +315,7 @@ src/models/GetSellerChallengesListDto.ts
315
315
  src/models/GetSellerChallengesListDtoChallengesInner.ts
316
316
  src/models/HistoricalMetrics.ts
317
317
  src/models/HttpException.ts
318
+ src/models/ImportDomainsResponseDto.ts
318
319
  src/models/IntersectionAccountDtoWithSettingsDtoWithNotificationsDtoWithFeatureFlagsDto.ts
319
320
  src/models/IntersectionDomainDtoWithAccountDtoWithAuctionInfoDto.ts
320
321
  src/models/IntersectionDomainDtoWithHijackerDtoWithAccountDto.ts
package/README.md CHANGED
@@ -1,4 +1,4 @@
1
- ## @randock/nameshift-api-client@0.0.485
1
+ ## @randock/nameshift-api-client@0.0.487
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.485 --save
39
+ npm install @randock/nameshift-api-client@0.0.487 --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
- b341a19b31c15865c8f475c67ff6b199f5ae86c79742266463fb285c8ff53ec84c2d9d9be8c392df664c51fd787f993a
47
+ 5320f7be02b6f9e34f1833de86db2dc45c99c152d643189c44b1a8737a46d5baca7f0eced39dbd7c991da695efaf088b
@@ -298,6 +298,9 @@ export interface AdminApiPostAiPriceNegotiatorAgentChatMessageRequest {
298
298
  export interface AdminApiPurgeDomainCdnCacheRequest {
299
299
  domainId: string;
300
300
  }
301
+ export interface AdminApiRejectAccountAliasRequest {
302
+ accountId: string;
303
+ }
301
304
  export interface AdminApiRemoveDomainLockRequest {
302
305
  domainId: string;
303
306
  lockId: string;
@@ -982,6 +985,16 @@ export declare class AdminApi extends runtime.BaseAPI {
982
985
  * Purge domain CDN cache
983
986
  */
984
987
  purgeDomainCdnCache(requestParameters: AdminApiPurgeDomainCdnCacheRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
988
+ /**
989
+ * 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.
990
+ * Reject account alias
991
+ */
992
+ rejectAccountAliasRaw(requestParameters: AdminApiRejectAccountAliasRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
993
+ /**
994
+ * 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.
995
+ * Reject account alias
996
+ */
997
+ rejectAccountAlias(requestParameters: AdminApiRejectAccountAliasRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
985
998
  /**
986
999
  * Removes a specific lock from a domain.
987
1000
  * Remove domain lock
@@ -1133,12 +1146,12 @@ export declare class AdminApi extends runtime.BaseAPI {
1133
1146
  */
1134
1147
  updateSubscriptionBuyerInformation(requestParameters: AdminApiUpdateSubscriptionBuyerInformationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
1135
1148
  /**
1136
- * Marks the account alias as verified.
1149
+ * Marks the account alias as verified, so it is shown on the landing pages instead of the official name. Also lifts a previous rejection.
1137
1150
  * Verify account alias
1138
1151
  */
1139
1152
  verifyAccountAliasRaw(requestParameters: AdminApiVerifyAccountAliasRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
1140
1153
  /**
1141
- * Marks the account alias as verified.
1154
+ * Marks the account alias as verified, so it is shown on the landing pages instead of the official name. Also lifts a previous rejection.
1142
1155
  * Verify account alias
1143
1156
  */
1144
1157
  verifyAccountAlias(requestParameters: AdminApiVerifyAccountAliasRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
@@ -3730,6 +3730,59 @@ var AdminApi = /** @class */ (function (_super) {
3730
3730
  });
3731
3731
  });
3732
3732
  };
3733
+ /**
3734
+ * 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.
3735
+ * Reject account alias
3736
+ */
3737
+ AdminApi.prototype.rejectAccountAliasRaw = function (requestParameters, initOverrides) {
3738
+ return __awaiter(this, void 0, void 0, function () {
3739
+ var queryParameters, headerParameters, token, tokenString, response;
3740
+ return __generator(this, function (_a) {
3741
+ switch (_a.label) {
3742
+ case 0:
3743
+ if (requestParameters['accountId'] == null) {
3744
+ throw new runtime.RequiredError('accountId', 'Required parameter "accountId" was null or undefined when calling rejectAccountAlias().');
3745
+ }
3746
+ queryParameters = {};
3747
+ headerParameters = {};
3748
+ if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
3749
+ token = this.configuration.accessToken;
3750
+ return [4 /*yield*/, token("bearer", [])];
3751
+ case 1:
3752
+ tokenString = _a.sent();
3753
+ if (tokenString) {
3754
+ headerParameters["Authorization"] = "Bearer ".concat(tokenString);
3755
+ }
3756
+ _a.label = 2;
3757
+ case 2: return [4 /*yield*/, this.request({
3758
+ path: "/admin/accounts/{accountId}/alias/reject".replace("{".concat("accountId", "}"), encodeURIComponent(String(requestParameters['accountId']))),
3759
+ method: 'POST',
3760
+ headers: headerParameters,
3761
+ query: queryParameters,
3762
+ }, initOverrides)];
3763
+ case 3:
3764
+ response = _a.sent();
3765
+ return [2 /*return*/, new runtime.VoidApiResponse(response)];
3766
+ }
3767
+ });
3768
+ });
3769
+ };
3770
+ /**
3771
+ * 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.
3772
+ * Reject account alias
3773
+ */
3774
+ AdminApi.prototype.rejectAccountAlias = function (requestParameters, initOverrides) {
3775
+ return __awaiter(this, void 0, void 0, function () {
3776
+ return __generator(this, function (_a) {
3777
+ switch (_a.label) {
3778
+ case 0: return [4 /*yield*/, this.rejectAccountAliasRaw(requestParameters, initOverrides)];
3779
+ case 1:
3780
+ _a.sent();
3781
+ return [2 /*return*/];
3782
+ }
3783
+ });
3784
+ });
3785
+ };
3733
3786
  /**
3734
3787
  * Removes a specific lock from a domain.
3735
3788
  * Remove domain lock
@@ -4571,7 +4624,7 @@ var AdminApi = /** @class */ (function (_super) {
4571
4624
  });
4572
4625
  };
4573
4626
  /**
4574
- * Marks the account alias as verified.
4627
+ * Marks the account alias as verified, so it is shown on the landing pages instead of the official name. Also lifts a previous rejection.
4575
4628
  * Verify account alias
4576
4629
  */
4577
4630
  AdminApi.prototype.verifyAccountAliasRaw = function (requestParameters, initOverrides) {
@@ -4608,7 +4661,7 @@ var AdminApi = /** @class */ (function (_super) {
4608
4661
  });
4609
4662
  };
4610
4663
  /**
4611
- * Marks the account alias as verified.
4664
+ * Marks the account alias as verified, so it is shown on the landing pages instead of the official name. Also lifts a previous rejection.
4612
4665
  * Verify account alias
4613
4666
  */
4614
4667
  AdminApi.prototype.verifyAccountAlias = function (requestParameters, initOverrides) {
@@ -10,7 +10,7 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  import * as runtime from '../runtime';
13
- import type { ApplyDomainEditInput, BatchImportPreviewDto, BatchUpdateDomainsInput, BulkUpdateDomainsWithFiltersInput, CheckDomainsNsInput, DeleteDomainsInput, DomainEditPreviewDto, DomainExchangeRateDto, DomainFiltersDto, DomainSearchTranslationDto, DomainUrlDto, DomainVerificationStatusDto, GetAllDomainTransfers200Response, IntersectionDomainDtoWithHijackerDtoWithAccountDto, JobDto, List200Response2, PreviewDomainEditInput, SellerDomainAffiliateCommissionDto, SellerDomainTransferDto, StartAuctionInput, TranslateDomainSearchInput, UpdateDomainInput, UpdateDomainTransferAuthCodeInput, UpdateDomainTransferIpsTagInput } from '../models/index';
13
+ import type { ApplyDomainEditInput, BatchImportPreviewDto, BatchUpdateDomainsInput, BulkUpdateDomainsWithFiltersInput, CheckDomainsNsInput, DeleteDomainsInput, DomainEditPreviewDto, DomainExchangeRateDto, DomainFiltersDto, DomainSearchTranslationDto, DomainUrlDto, DomainVerificationStatusDto, GetAllDomainTransfers200Response, ImportDomainsResponseDto, IntersectionDomainDtoWithHijackerDtoWithAccountDto, JobDto, List200Response2, PreviewDomainEditInput, SellerDomainAffiliateCommissionDto, SellerDomainTransferDto, StartAuctionInput, TranslateDomainSearchInput, UpdateDomainInput, UpdateDomainTransferAuthCodeInput, UpdateDomainTransferIpsTagInput } from '../models/index';
14
14
  export interface DomainsApiApplyDomainEditRequest {
15
15
  applyDomainEditInput: ApplyDomainEditInput;
16
16
  searchFilter?: string;
@@ -21,6 +21,7 @@ export interface DomainsApiApplyDomainEditRequest {
21
21
  export interface DomainsApiBatchImportRequest {
22
22
  domains?: Array<string>;
23
23
  file?: Blob | null;
24
+ notifyByEmail?: boolean;
24
25
  }
25
26
  export interface DomainsApiBatchImportPreviewRequest {
26
27
  file?: Blob | null;
@@ -135,15 +136,15 @@ export declare class DomainsApi extends runtime.BaseAPI {
135
136
  */
136
137
  applyDomainEdit(requestParameters: DomainsApiApplyDomainEditRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<JobDto>;
137
138
  /**
138
- * Imports domains from an uploaded file or a list of domain names and queues them for processing. **API key scope required:** `DOMAINS_WRITE`. Requests authenticated with a seller session do not need any scope.
139
+ * 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.
139
140
  * Import domains
140
141
  */
141
- batchImportRaw(requestParameters: DomainsApiBatchImportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
142
+ batchImportRaw(requestParameters: DomainsApiBatchImportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ImportDomainsResponseDto>>;
142
143
  /**
143
- * Imports domains from an uploaded file or a list of domain names and queues them for processing. **API key scope required:** `DOMAINS_WRITE`. Requests authenticated with a seller session do not need any scope.
144
+ * 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.
144
145
  * Import domains
145
146
  */
146
- batchImport(requestParameters?: DomainsApiBatchImportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
147
+ batchImport(requestParameters?: DomainsApiBatchImportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ImportDomainsResponseDto>;
147
148
  /**
148
149
  * Uploads a domain import file and returns a preview of parsed domains before import. **API key scope required:** `DOMAINS_READ`. Requests authenticated with a seller session do not need any scope.
149
150
  * Preview domain import
@@ -147,7 +147,7 @@ var DomainsApi = /** @class */ (function (_super) {
147
147
  });
148
148
  };
149
149
  /**
150
- * Imports domains from an uploaded file or a list of domain names and queues them for processing. **API key scope required:** `DOMAINS_WRITE`. Requests authenticated with a seller session do not need any scope.
150
+ * 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.
151
151
  * Import domains
152
152
  */
153
153
  DomainsApi.prototype.batchImportRaw = function (requestParameters, initOverrides) {
@@ -195,6 +195,9 @@ var DomainsApi = /** @class */ (function (_super) {
195
195
  if (requestParameters['file'] != null) {
196
196
  formParams.append('file', requestParameters['file']);
197
197
  }
198
+ if (requestParameters['notifyByEmail'] != null) {
199
+ formParams.append('notifyByEmail', requestParameters['notifyByEmail']);
200
+ }
198
201
  return [4 /*yield*/, this.request({
199
202
  path: "/private/domains",
200
203
  method: 'POST',
@@ -204,24 +207,26 @@ var DomainsApi = /** @class */ (function (_super) {
204
207
  }, initOverrides)];
205
208
  case 5:
206
209
  response = _c.sent();
207
- return [2 /*return*/, new runtime.VoidApiResponse(response)];
210
+ return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, index_1.ImportDomainsResponseDtoFromJSON)(jsonValue); })];
208
211
  }
209
212
  });
210
213
  });
211
214
  };
212
215
  /**
213
- * Imports domains from an uploaded file or a list of domain names and queues them for processing. **API key scope required:** `DOMAINS_WRITE`. Requests authenticated with a seller session do not need any scope.
216
+ * 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.
214
217
  * Import domains
215
218
  */
216
219
  DomainsApi.prototype.batchImport = function () {
217
220
  return __awaiter(this, arguments, void 0, function (requestParameters, initOverrides) {
221
+ var response;
218
222
  if (requestParameters === void 0) { requestParameters = {}; }
219
223
  return __generator(this, function (_a) {
220
224
  switch (_a.label) {
221
225
  case 0: return [4 /*yield*/, this.batchImportRaw(requestParameters, initOverrides)];
222
226
  case 1:
223
- _a.sent();
224
- return [2 /*return*/];
227
+ response = _a.sent();
228
+ return [4 /*yield*/, response.value()];
229
+ case 2: return [2 /*return*/, _a.sent()];
225
230
  }
226
231
  });
227
232
  });
@@ -14,6 +14,9 @@ import type { JobDto, ListJobs200Response } from '../models/index';
14
14
  export interface JobsApiGetJobRequest {
15
15
  jobId: string;
16
16
  }
17
+ export interface JobsApiGetJobResultRequest {
18
+ jobId: string;
19
+ }
17
20
  export interface JobsApiListJobsRequest {
18
21
  filter?: {
19
22
  [key: string]: string;
@@ -29,22 +32,32 @@ export interface JobsApiListJobsRequest {
29
32
  */
30
33
  export declare class JobsApi extends runtime.BaseAPI {
31
34
  /**
32
- * 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.
35
+ * 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.
33
36
  * Get a background job
34
37
  */
35
38
  getJobRaw(requestParameters: JobsApiGetJobRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<JobDto>>;
36
39
  /**
37
- * 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.
40
+ * 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.
38
41
  * Get a background job
39
42
  */
40
43
  getJob(requestParameters: JobsApiGetJobRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<JobDto>;
41
44
  /**
42
- * 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.
45
+ * 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.
46
+ * Download the result file of a background job
47
+ */
48
+ getJobResultRaw(requestParameters: JobsApiGetJobResultRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
49
+ /**
50
+ * 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.
51
+ * Download the result file of a background job
52
+ */
53
+ getJobResult(requestParameters: JobsApiGetJobResultRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
54
+ /**
55
+ * 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.
43
56
  * List background jobs
44
57
  */
45
58
  listJobsRaw(requestParameters: JobsApiListJobsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListJobs200Response>>;
46
59
  /**
47
- * 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.
60
+ * 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.
48
61
  * List background jobs
49
62
  */
50
63
  listJobs(requestParameters?: JobsApiListJobsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListJobs200Response>;
@@ -76,7 +76,7 @@ var JobsApi = /** @class */ (function (_super) {
76
76
  return _super !== null && _super.apply(this, arguments) || this;
77
77
  }
78
78
  /**
79
- * 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.
79
+ * 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.
80
80
  * Get a background job
81
81
  */
82
82
  JobsApi.prototype.getJobRaw = function (requestParameters, initOverrides) {
@@ -121,7 +121,7 @@ var JobsApi = /** @class */ (function (_super) {
121
121
  });
122
122
  };
123
123
  /**
124
- * 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.
124
+ * 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.
125
125
  * Get a background job
126
126
  */
127
127
  JobsApi.prototype.getJob = function (requestParameters, initOverrides) {
@@ -139,7 +139,68 @@ var JobsApi = /** @class */ (function (_super) {
139
139
  });
140
140
  };
141
141
  /**
142
- * 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.
142
+ * 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.
143
+ * Download the result file of a background job
144
+ */
145
+ JobsApi.prototype.getJobResultRaw = function (requestParameters, initOverrides) {
146
+ return __awaiter(this, void 0, void 0, function () {
147
+ var queryParameters, headerParameters, _a, _b, token, tokenString, response;
148
+ return __generator(this, function (_c) {
149
+ switch (_c.label) {
150
+ case 0:
151
+ if (requestParameters['jobId'] == null) {
152
+ throw new runtime.RequiredError('jobId', 'Required parameter "jobId" was null or undefined when calling getJobResult().');
153
+ }
154
+ queryParameters = {};
155
+ headerParameters = {};
156
+ if (!(this.configuration && this.configuration.apiKey)) return [3 /*break*/, 2];
157
+ _a = headerParameters;
158
+ _b = "apikey";
159
+ return [4 /*yield*/, this.configuration.apiKey("apikey")];
160
+ case 1:
161
+ _a[_b] = _c.sent(); // api_key authentication
162
+ _c.label = 2;
163
+ case 2:
164
+ if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 4];
165
+ token = this.configuration.accessToken;
166
+ return [4 /*yield*/, token("bearer", [])];
167
+ case 3:
168
+ tokenString = _c.sent();
169
+ if (tokenString) {
170
+ headerParameters["Authorization"] = "Bearer ".concat(tokenString);
171
+ }
172
+ _c.label = 4;
173
+ case 4: return [4 /*yield*/, this.request({
174
+ path: "/private/jobs/{jobId}/result".replace("{".concat("jobId", "}"), encodeURIComponent(String(requestParameters['jobId']))),
175
+ method: 'GET',
176
+ headers: headerParameters,
177
+ query: queryParameters,
178
+ }, initOverrides)];
179
+ case 5:
180
+ response = _c.sent();
181
+ return [2 /*return*/, new runtime.VoidApiResponse(response)];
182
+ }
183
+ });
184
+ });
185
+ };
186
+ /**
187
+ * 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.
188
+ * Download the result file of a background job
189
+ */
190
+ JobsApi.prototype.getJobResult = function (requestParameters, initOverrides) {
191
+ return __awaiter(this, void 0, void 0, function () {
192
+ return __generator(this, function (_a) {
193
+ switch (_a.label) {
194
+ case 0: return [4 /*yield*/, this.getJobResultRaw(requestParameters, initOverrides)];
195
+ case 1:
196
+ _a.sent();
197
+ return [2 /*return*/];
198
+ }
199
+ });
200
+ });
201
+ };
202
+ /**
203
+ * 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.
143
204
  * List background jobs
144
205
  */
145
206
  JobsApi.prototype.listJobsRaw = function (requestParameters, initOverrides) {
@@ -199,7 +260,7 @@ var JobsApi = /** @class */ (function (_super) {
199
260
  });
200
261
  };
201
262
  /**
202
- * 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.
263
+ * 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.
203
264
  * List background jobs
204
265
  */
205
266
  JobsApi.prototype.listJobs = function () {
@@ -16,18 +16,33 @@
16
16
  */
17
17
  export interface AccountAliasDto {
18
18
  /**
19
- * Account alias string.
19
+ * Account alias string; null when no alias is set.
20
20
  * @type {string}
21
21
  * @memberof AccountAliasDto
22
22
  */
23
- alias: string;
23
+ alias: string | null;
24
24
  /**
25
- * Whether the alias has been verified.
25
+ * Deprecated, use status. Whether the alias has been verified.
26
26
  * @type {boolean}
27
27
  * @memberof AccountAliasDto
28
28
  */
29
29
  verified: boolean;
30
+ /**
31
+ * Review status of the alias: pending review, verified (shown on the landing pages) or rejected by an admin. Null when no alias is set.
32
+ * @type {string}
33
+ * @memberof AccountAliasDto
34
+ */
35
+ status: AccountAliasDtoStatusEnum | null;
30
36
  }
37
+ /**
38
+ * @export
39
+ */
40
+ export declare const AccountAliasDtoStatusEnum: {
41
+ readonly PENDING: "pending";
42
+ readonly VERIFIED: "verified";
43
+ readonly REJECTED: "rejected";
44
+ };
45
+ export type AccountAliasDtoStatusEnum = typeof AccountAliasDtoStatusEnum[keyof typeof AccountAliasDtoStatusEnum];
31
46
  /**
32
47
  * Check if a given object implements the AccountAliasDto interface.
33
48
  */
@@ -13,11 +13,20 @@
13
13
  * Do not edit the class manually.
14
14
  */
15
15
  Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.AccountAliasDtoStatusEnum = void 0;
16
17
  exports.instanceOfAccountAliasDto = instanceOfAccountAliasDto;
17
18
  exports.AccountAliasDtoFromJSON = AccountAliasDtoFromJSON;
18
19
  exports.AccountAliasDtoFromJSONTyped = AccountAliasDtoFromJSONTyped;
19
20
  exports.AccountAliasDtoToJSON = AccountAliasDtoToJSON;
20
21
  exports.AccountAliasDtoToJSONTyped = AccountAliasDtoToJSONTyped;
22
+ /**
23
+ * @export
24
+ */
25
+ exports.AccountAliasDtoStatusEnum = {
26
+ PENDING: 'pending',
27
+ VERIFIED: 'verified',
28
+ REJECTED: 'rejected'
29
+ };
21
30
  /**
22
31
  * Check if a given object implements the AccountAliasDto interface.
23
32
  */
@@ -26,6 +35,8 @@ function instanceOfAccountAliasDto(value) {
26
35
  return false;
27
36
  if (!('verified' in value) || value['verified'] === undefined)
28
37
  return false;
38
+ if (!('status' in value) || value['status'] === undefined)
39
+ return false;
29
40
  return true;
30
41
  }
31
42
  function AccountAliasDtoFromJSON(json) {
@@ -38,6 +49,7 @@ function AccountAliasDtoFromJSONTyped(json, ignoreDiscriminator) {
38
49
  return {
39
50
  'alias': json['alias'],
40
51
  'verified': json['verified'],
52
+ 'status': json['status'],
41
53
  };
42
54
  }
43
55
  function AccountAliasDtoToJSON(json) {
@@ -51,5 +63,6 @@ function AccountAliasDtoToJSONTyped(value, ignoreDiscriminator) {
51
63
  return {
52
64
  'alias': value['alias'],
53
65
  'verified': value['verified'],
66
+ 'status': value['status'],
54
67
  };
55
68
  }
@@ -16,18 +16,33 @@
16
16
  */
17
17
  export interface AccountSettingsAliasDto {
18
18
  /**
19
- * Account alias string.
19
+ * Account alias string; null when no alias is set.
20
20
  * @type {string}
21
21
  * @memberof AccountSettingsAliasDto
22
22
  */
23
- alias: string;
23
+ alias: string | null;
24
24
  /**
25
- * Whether the alias has been verified.
25
+ * Deprecated, use status. Whether the alias has been verified.
26
26
  * @type {boolean}
27
27
  * @memberof AccountSettingsAliasDto
28
28
  */
29
29
  verified: boolean;
30
+ /**
31
+ * Review status of the alias: pending review, verified (shown on the landing pages) or rejected by an admin. Null when no alias is set.
32
+ * @type {string}
33
+ * @memberof AccountSettingsAliasDto
34
+ */
35
+ status: AccountSettingsAliasDtoStatusEnum | null;
30
36
  }
37
+ /**
38
+ * @export
39
+ */
40
+ export declare const AccountSettingsAliasDtoStatusEnum: {
41
+ readonly PENDING: "pending";
42
+ readonly VERIFIED: "verified";
43
+ readonly REJECTED: "rejected";
44
+ };
45
+ export type AccountSettingsAliasDtoStatusEnum = typeof AccountSettingsAliasDtoStatusEnum[keyof typeof AccountSettingsAliasDtoStatusEnum];
31
46
  /**
32
47
  * Check if a given object implements the AccountSettingsAliasDto interface.
33
48
  */
@@ -13,11 +13,20 @@
13
13
  * Do not edit the class manually.
14
14
  */
15
15
  Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.AccountSettingsAliasDtoStatusEnum = void 0;
16
17
  exports.instanceOfAccountSettingsAliasDto = instanceOfAccountSettingsAliasDto;
17
18
  exports.AccountSettingsAliasDtoFromJSON = AccountSettingsAliasDtoFromJSON;
18
19
  exports.AccountSettingsAliasDtoFromJSONTyped = AccountSettingsAliasDtoFromJSONTyped;
19
20
  exports.AccountSettingsAliasDtoToJSON = AccountSettingsAliasDtoToJSON;
20
21
  exports.AccountSettingsAliasDtoToJSONTyped = AccountSettingsAliasDtoToJSONTyped;
22
+ /**
23
+ * @export
24
+ */
25
+ exports.AccountSettingsAliasDtoStatusEnum = {
26
+ PENDING: 'pending',
27
+ VERIFIED: 'verified',
28
+ REJECTED: 'rejected'
29
+ };
21
30
  /**
22
31
  * Check if a given object implements the AccountSettingsAliasDto interface.
23
32
  */
@@ -26,6 +35,8 @@ function instanceOfAccountSettingsAliasDto(value) {
26
35
  return false;
27
36
  if (!('verified' in value) || value['verified'] === undefined)
28
37
  return false;
38
+ if (!('status' in value) || value['status'] === undefined)
39
+ return false;
29
40
  return true;
30
41
  }
31
42
  function AccountSettingsAliasDtoFromJSON(json) {
@@ -38,6 +49,7 @@ function AccountSettingsAliasDtoFromJSONTyped(json, ignoreDiscriminator) {
38
49
  return {
39
50
  'alias': json['alias'],
40
51
  'verified': json['verified'],
52
+ 'status': json['status'],
41
53
  };
42
54
  }
43
55
  function AccountSettingsAliasDtoToJSON(json) {
@@ -51,5 +63,6 @@ function AccountSettingsAliasDtoToJSONTyped(value, ignoreDiscriminator) {
51
63
  return {
52
64
  'alias': value['alias'],
53
65
  'verified': value['verified'],
66
+ 'status': value['status'],
54
67
  };
55
68
  }
@@ -75,11 +75,17 @@ export interface AdminListAccountDto {
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 AdminListAccountDto
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 AdminListAccountDto
87
+ */
88
+ aliasStatus: AdminListAccountDtoAliasStatusEnum | null;
83
89
  /**
84
90
  * Account metrics.
85
91
  * @type {ListAccountMetricsDto}
@@ -147,6 +153,15 @@ export interface AdminListAccountDto {
147
153
  */
148
154
  challengeRewardBalance: ChallengeRewardBalanceDto;
149
155
  }
156
+ /**
157
+ * @export
158
+ */
159
+ export declare const AdminListAccountDtoAliasStatusEnum: {
160
+ readonly PENDING: "pending";
161
+ readonly VERIFIED: "verified";
162
+ readonly REJECTED: "rejected";
163
+ };
164
+ export type AdminListAccountDtoAliasStatusEnum = typeof AdminListAccountDtoAliasStatusEnum[keyof typeof AdminListAccountDtoAliasStatusEnum];
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.AdminListAccountDtoPayoutProviderEnum = exports.AdminListAccountDtoOnboardingStatusEnum = exports.AdminListAccountDtoOnboardingProviderEnum = void 0;
16
+ exports.AdminListAccountDtoPayoutProviderEnum = exports.AdminListAccountDtoOnboardingStatusEnum = exports.AdminListAccountDtoOnboardingProviderEnum = exports.AdminListAccountDtoAliasStatusEnum = void 0;
17
17
  exports.instanceOfAdminListAccountDto = instanceOfAdminListAccountDto;
18
18
  exports.AdminListAccountDtoFromJSON = AdminListAccountDtoFromJSON;
19
19
  exports.AdminListAccountDtoFromJSONTyped = AdminListAccountDtoFromJSONTyped;
@@ -24,6 +24,14 @@ var ChallengeRewardBalanceDto_1 = require("./ChallengeRewardBalanceDto");
24
24
  var AccountBankAccountSummaryDto_1 = require("./AccountBankAccountSummaryDto");
25
25
  var ListAccountPortfolioSizeDto_1 = require("./ListAccountPortfolioSizeDto");
26
26
  var ListAccountUserDto_1 = require("./ListAccountUserDto");
27
+ /**
28
+ * @export
29
+ */
30
+ exports.AdminListAccountDtoAliasStatusEnum = {
31
+ PENDING: 'pending',
32
+ VERIFIED: 'verified',
33
+ REJECTED: 'rejected'
34
+ };
27
35
  /**
28
36
  * @export
29
37
  */
@@ -70,6 +78,8 @@ function instanceOfAdminListAccountDto(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 AdminListAccountDtoFromJSONTyped(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, ListAccountMetricsDto_1.ListAccountMetricsDtoFromJSON)(json['metrics']),
116
127
  'lastOnline': (new Date(json['lastOnline'])),
117
128
  'users': (json['users'].map(ListAccountUserDto_1.ListAccountUserDtoFromJSON)),
@@ -144,6 +155,7 @@ function AdminListAccountDtoToJSONTyped(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, ListAccountMetricsDto_1.ListAccountMetricsDtoToJSON)(value['metrics']),
148
160
  'lastOnline': ((value['lastOnline']).toISOString()),
149
161
  'users': (value['users'].map(ListAccountUserDto_1.ListAccountUserDtoToJSON)),