@randock/nameshift-api-client 0.0.459 → 0.0.460

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 (63) hide show
  1. package/.openapi-generator/FILES +10 -0
  2. package/README.md +3 -3
  3. package/dist/apis/DomainsApi.d.ts +43 -9
  4. package/dist/apis/DomainsApi.js +156 -10
  5. package/dist/apis/JobsApi.d.ts +51 -0
  6. package/dist/apis/JobsApi.js +222 -0
  7. package/dist/apis/index.d.ts +1 -0
  8. package/dist/apis/index.js +1 -0
  9. package/dist/models/ApplyDomainEditInput.d.ts +40 -0
  10. package/dist/models/ApplyDomainEditInput.js +53 -0
  11. package/dist/models/BuyerNotificationDto.d.ts +1 -0
  12. package/dist/models/BuyerNotificationDto.js +1 -0
  13. package/dist/models/BuyerNotificationListItemDto.d.ts +1 -0
  14. package/dist/models/BuyerNotificationListItemDto.js +1 -0
  15. package/dist/models/DomainEditPreviewDto.d.ts +83 -0
  16. package/dist/models/DomainEditPreviewDto.js +84 -0
  17. package/dist/models/DomainEditPreviewRowDto.d.ts +60 -0
  18. package/dist/models/DomainEditPreviewRowDto.js +67 -0
  19. package/dist/models/FeatureFlagListItemDto.d.ts +1 -0
  20. package/dist/models/FeatureFlagListItemDto.js +2 -1
  21. package/dist/models/IntersectionAccountDtoWithSettingsDtoWithNotificationsDtoWithFeatureFlagsDto.d.ts +1 -0
  22. package/dist/models/IntersectionAccountDtoWithSettingsDtoWithNotificationsDtoWithFeatureFlagsDto.js +2 -1
  23. package/dist/models/JobDto.d.ts +101 -0
  24. package/dist/models/JobDto.js +98 -0
  25. package/dist/models/JobFailureDto.d.ts +38 -0
  26. package/dist/models/JobFailureDto.js +55 -0
  27. package/dist/models/JobStatus.d.ts +27 -0
  28. package/dist/models/JobStatus.js +53 -0
  29. package/dist/models/JobType.d.ts +24 -0
  30. package/dist/models/JobType.js +50 -0
  31. package/dist/models/ListJobs200Response.d.ts +47 -0
  32. package/dist/models/ListJobs200Response.js +62 -0
  33. package/dist/models/PreviewDomainEditInput.d.ts +38 -0
  34. package/dist/models/PreviewDomainEditInput.js +53 -0
  35. package/dist/models/PrivateAccountGetMeResponse.d.ts +1 -0
  36. package/dist/models/PrivateAccountGetMeResponse.js +2 -1
  37. package/dist/models/UserNotificationDto.d.ts +1 -0
  38. package/dist/models/UserNotificationDto.js +1 -0
  39. package/dist/models/UserNotificationListItemDto.d.ts +1 -0
  40. package/dist/models/UserNotificationListItemDto.js +1 -0
  41. package/dist/models/index.d.ts +9 -0
  42. package/dist/models/index.js +9 -0
  43. package/package.json +1 -1
  44. package/src/apis/DomainsApi.ts +154 -12
  45. package/src/apis/JobsApi.ts +163 -0
  46. package/src/apis/index.ts +1 -0
  47. package/src/models/ApplyDomainEditInput.ts +74 -0
  48. package/src/models/BuyerNotificationDto.ts +1 -0
  49. package/src/models/BuyerNotificationListItemDto.ts +1 -0
  50. package/src/models/DomainEditPreviewDto.ts +146 -0
  51. package/src/models/DomainEditPreviewRowDto.ts +102 -0
  52. package/src/models/FeatureFlagListItemDto.ts +2 -1
  53. package/src/models/IntersectionAccountDtoWithSettingsDtoWithNotificationsDtoWithFeatureFlagsDto.ts +2 -1
  54. package/src/models/JobDto.ts +189 -0
  55. package/src/models/JobFailureDto.ts +75 -0
  56. package/src/models/JobStatus.ts +55 -0
  57. package/src/models/JobType.ts +52 -0
  58. package/src/models/ListJobs200Response.ts +106 -0
  59. package/src/models/PreviewDomainEditInput.ts +74 -0
  60. package/src/models/PrivateAccountGetMeResponse.ts +2 -1
  61. package/src/models/UserNotificationDto.ts +1 -0
  62. package/src/models/UserNotificationListItemDto.ts +1 -0
  63. package/src/models/index.ts +9 -0
@@ -19,6 +19,7 @@ src/apis/DomainsApi.ts
19
19
  src/apis/DomainsPublicApi.ts
20
20
  src/apis/EppApi.ts
21
21
  src/apis/InvoicesApi.ts
22
+ src/apis/JobsApi.ts
22
23
  src/apis/LeadsApi.ts
23
24
  src/apis/LeadsPublicApi.ts
24
25
  src/apis/MarketApi.ts
@@ -112,6 +113,7 @@ src/models/AirwallexDepositDto.ts
112
113
  src/models/AirwallexDepositDtoFee.ts
113
114
  src/models/ApiKeyDto.ts
114
115
  src/models/ApiKeyScopeDto.ts
116
+ src/models/ApplyDomainEditInput.ts
115
117
  src/models/AuBankAccountDetails.ts
116
118
  src/models/AuctionBidDto.ts
117
119
  src/models/AuctionBidInput.ts
@@ -220,6 +222,8 @@ src/models/CursorBasedPaginationResponse.ts
220
222
  src/models/DeleteDomainsInput.ts
221
223
  src/models/DomainAuctionDto.ts
222
224
  src/models/DomainCategoryItemDto.ts
225
+ src/models/DomainEditPreviewDto.ts
226
+ src/models/DomainEditPreviewRowDto.ts
223
227
  src/models/DomainExchangeRateDto.ts
224
228
  src/models/DomainFiltersDto.ts
225
229
  src/models/DomainLeadPriceNegotiatorAiAgentConfigurationDto.ts
@@ -307,6 +311,10 @@ src/models/InvoiceItemDto.ts
307
311
  src/models/InvoiceItemTaxDto.ts
308
312
  src/models/InvoiceSellerAccountDto.ts
309
313
  src/models/InvoiceTransactionDto.ts
314
+ src/models/JobDto.ts
315
+ src/models/JobFailureDto.ts
316
+ src/models/JobStatus.ts
317
+ src/models/JobType.ts
310
318
  src/models/LandingPageDesignSettingsDto.ts
311
319
  src/models/LandingPageDesignSettingsInput.ts
312
320
  src/models/LandingPageInput.ts
@@ -357,6 +365,7 @@ src/models/ListBankDeposits200Response.ts
357
365
  src/models/ListBuyerNotifications200Response.ts
358
366
  src/models/ListDomains200Response.ts
359
367
  src/models/ListDomainsWithUpdatedPricing200Response.ts
368
+ src/models/ListJobs200Response.ts
360
369
  src/models/ListLeadMessagesDto.ts
361
370
  src/models/ListLeads200Response.ts
362
371
  src/models/ListLeadsResultItem.ts
@@ -402,6 +411,7 @@ src/models/PartnerDomainFindDto.ts
402
411
  src/models/PayAccountPaymentInput.ts
403
412
  src/models/PaymentMethodsStatsDto.ts
404
413
  src/models/PopularCategoryDto.ts
414
+ src/models/PreviewDomainEditInput.ts
405
415
  src/models/PrivateAccountGetMeResponse.ts
406
416
  src/models/PublicAccountInformationDto.ts
407
417
  src/models/PublicAuctionListItemDto.ts
package/README.md CHANGED
@@ -1,4 +1,4 @@
1
- ## @randock/nameshift-api-client@0.0.459
1
+ ## @randock/nameshift-api-client@0.0.460
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.459 --save
39
+ npm install @randock/nameshift-api-client@0.0.460 --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
- 79a2dcc8fe20c8a5eaad39e69e36cb8057936ee730cff4f19ebced8a1739d87b95d389d804930a70d88e659321015737
47
+ 11c9108154f825a509635e986dea54255b712977ab1f39bdc0349fe7812c709833fa4dfde1a29714bb817adbd12ff4a4
@@ -10,7 +10,14 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  import * as runtime from '../runtime';
13
- import type { BatchImportPreviewDto, BatchUpdateDomainsInput, BulkUpdateDomainsWithFiltersInput, CheckDomainsNsInput, DeleteDomainsInput, DomainExchangeRateDto, DomainFiltersDto, DomainSearchTranslationDto, DomainUrlDto, DomainVerificationStatusDto, GetAllDomainTransfers200Response, IntersectionDomainDtoWithHijackerDtoWithAccountDto, List200Response2, 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, IntersectionDomainDtoWithHijackerDtoWithAccountDto, JobDto, List200Response2, PreviewDomainEditInput, SellerDomainAffiliateCommissionDto, SellerDomainTransferDto, StartAuctionInput, TranslateDomainSearchInput, UpdateDomainInput, UpdateDomainTransferAuthCodeInput, UpdateDomainTransferIpsTagInput } from '../models/index';
14
+ export interface DomainsApiApplyDomainEditRequest {
15
+ applyDomainEditInput: ApplyDomainEditInput;
16
+ searchFilter?: string;
17
+ filter?: {
18
+ [key: string]: string;
19
+ };
20
+ }
14
21
  export interface DomainsApiBatchImportRequest {
15
22
  domains?: Array<string>;
16
23
  file?: Blob | null;
@@ -83,6 +90,13 @@ export interface DomainsApiListRequest {
83
90
  filterVerified?: string;
84
91
  filterName?: string;
85
92
  }
93
+ export interface DomainsApiPreviewDomainEditRequest {
94
+ previewDomainEditInput: PreviewDomainEditInput;
95
+ searchFilter?: string;
96
+ filter?: {
97
+ [key: string]: string;
98
+ };
99
+ }
86
100
  export interface DomainsApiStartAuctionRequest {
87
101
  domainId: string;
88
102
  startAuctionInput: StartAuctionInput;
@@ -106,6 +120,16 @@ export interface DomainsApiUpdateDomainTransferIpsTagRequest {
106
120
  *
107
121
  */
108
122
  export declare class DomainsApi extends runtime.BaseAPI {
123
+ /**
124
+ * Queues the operations a preview returned. Send them back unchanged; they are validated again here. Domains failing validation are skipped and the rest still apply. **API key scope required:** `DOMAINS_WRITE`. Requests authenticated with a seller session do not need any scope.
125
+ * Queue a previewed bulk edit
126
+ */
127
+ applyDomainEditRaw(requestParameters: DomainsApiApplyDomainEditRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<JobDto>>;
128
+ /**
129
+ * Queues the operations a preview returned. Send them back unchanged; they are validated again here. Domains failing validation are skipped and the rest still apply. **API key scope required:** `DOMAINS_WRITE`. Requests authenticated with a seller session do not need any scope.
130
+ * Queue a previewed bulk edit
131
+ */
132
+ applyDomainEdit(requestParameters: DomainsApiApplyDomainEditRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<JobDto>;
109
133
  /**
110
134
  * 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.
111
135
  * Import domains
@@ -127,25 +151,25 @@ export declare class DomainsApi extends runtime.BaseAPI {
127
151
  */
128
152
  batchImportPreview(requestParameters?: DomainsApiBatchImportPreviewRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BatchImportPreviewDto>;
129
153
  /**
130
- * Applies the same settings update to multiple domains by ID. **API key scope required:** `DOMAINS_WRITE`. Requests authenticated with a seller session do not need any scope.
154
+ * Queues the same settings update for multiple domains by ID. Ids belonging to another account match nothing, and domains the update would leave in an invalid state are skipped while the rest still apply. **API key scope required:** `DOMAINS_WRITE`. Requests authenticated with a seller session do not need any scope.
131
155
  * Batch update domains
132
156
  */
133
- batchUpdateRaw(requestParameters: DomainsApiBatchUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
157
+ batchUpdateRaw(requestParameters: DomainsApiBatchUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<JobDto>>;
134
158
  /**
135
- * Applies the same settings update to multiple domains by ID. **API key scope required:** `DOMAINS_WRITE`. Requests authenticated with a seller session do not need any scope.
159
+ * Queues the same settings update for multiple domains by ID. Ids belonging to another account match nothing, and domains the update would leave in an invalid state are skipped while the rest still apply. **API key scope required:** `DOMAINS_WRITE`. Requests authenticated with a seller session do not need any scope.
136
160
  * Batch update domains
137
161
  */
138
- batchUpdate(requestParameters: DomainsApiBatchUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
162
+ batchUpdate(requestParameters: DomainsApiBatchUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<JobDto>;
139
163
  /**
140
- * Applies pricing and configuration updates to all domains matching the provided filter criteria. **API key scope required:** `DOMAINS_WRITE`. Requests authenticated with a seller session do not need any scope.
164
+ * Queues pricing and configuration updates for every domain matching the provided filter criteria. Domains the update would leave in an invalid state are skipped and the rest still apply. **API key scope required:** `DOMAINS_WRITE`. Requests authenticated with a seller session do not need any scope.
141
165
  * Bulk update domains with filters
142
166
  */
143
- bulkUpdateDomainsWithFiltersRaw(requestParameters: DomainsApiBulkUpdateDomainsWithFiltersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
167
+ bulkUpdateDomainsWithFiltersRaw(requestParameters: DomainsApiBulkUpdateDomainsWithFiltersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<JobDto>>;
144
168
  /**
145
- * Applies pricing and configuration updates to all domains matching the provided filter criteria. **API key scope required:** `DOMAINS_WRITE`. Requests authenticated with a seller session do not need any scope.
169
+ * Queues pricing and configuration updates for every domain matching the provided filter criteria. Domains the update would leave in an invalid state are skipped and the rest still apply. **API key scope required:** `DOMAINS_WRITE`. Requests authenticated with a seller session do not need any scope.
146
170
  * Bulk update domains with filters
147
171
  */
148
- bulkUpdateDomainsWithFilters(requestParameters: DomainsApiBulkUpdateDomainsWithFiltersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
172
+ bulkUpdateDomainsWithFilters(requestParameters: DomainsApiBulkUpdateDomainsWithFiltersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<JobDto>;
149
173
  /**
150
174
  * Starts a nameserver verification check for a single domain. **API key scope required:** `DOMAINS_READ`. Requests authenticated with a seller session do not need any scope.
151
175
  * Check domain nameservers
@@ -286,6 +310,16 @@ export declare class DomainsApi extends runtime.BaseAPI {
286
310
  * List domains
287
311
  */
288
312
  list(requestParameters?: DomainsApiListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<List200Response2>;
313
+ /**
314
+ * Turns a sentence into edit operations and returns how many domains it would change, with a sample of before and after values. Nothing is written. **API key scope required:** `DOMAINS_READ`. Requests authenticated with a seller session do not need any scope.
315
+ * Translate a plain-language bulk edit and preview it
316
+ */
317
+ previewDomainEditRaw(requestParameters: DomainsApiPreviewDomainEditRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DomainEditPreviewDto>>;
318
+ /**
319
+ * Turns a sentence into edit operations and returns how many domains it would change, with a sample of before and after values. Nothing is written. **API key scope required:** `DOMAINS_READ`. Requests authenticated with a seller session do not need any scope.
320
+ * Translate a plain-language bulk edit and preview it
321
+ */
322
+ previewDomainEdit(requestParameters: DomainsApiPreviewDomainEditRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DomainEditPreviewDto>;
289
323
  /**
290
324
  * Creates and starts an auction for the specified verified domain. **API key scope required:** `AUCTIONS_WRITE`. Requests authenticated with a seller session do not need any scope.
291
325
  * Start domain auction
@@ -75,6 +75,77 @@ var DomainsApi = /** @class */ (function (_super) {
75
75
  function DomainsApi() {
76
76
  return _super !== null && _super.apply(this, arguments) || this;
77
77
  }
78
+ /**
79
+ * Queues the operations a preview returned. Send them back unchanged; they are validated again here. Domains failing validation are skipped and the rest still apply. **API key scope required:** `DOMAINS_WRITE`. Requests authenticated with a seller session do not need any scope.
80
+ * Queue a previewed bulk edit
81
+ */
82
+ DomainsApi.prototype.applyDomainEditRaw = function (requestParameters, initOverrides) {
83
+ return __awaiter(this, void 0, void 0, function () {
84
+ var queryParameters, headerParameters, _a, _b, token, tokenString, response;
85
+ return __generator(this, function (_c) {
86
+ switch (_c.label) {
87
+ case 0:
88
+ if (requestParameters['applyDomainEditInput'] == null) {
89
+ throw new runtime.RequiredError('applyDomainEditInput', 'Required parameter "applyDomainEditInput" was null or undefined when calling applyDomainEdit().');
90
+ }
91
+ queryParameters = {};
92
+ if (requestParameters['searchFilter'] != null) {
93
+ queryParameters['searchFilter'] = requestParameters['searchFilter'];
94
+ }
95
+ if (requestParameters['filter'] != null) {
96
+ queryParameters['filter'] = requestParameters['filter'];
97
+ }
98
+ headerParameters = {};
99
+ headerParameters['Content-Type'] = 'application/json';
100
+ if (!(this.configuration && this.configuration.apiKey)) return [3 /*break*/, 2];
101
+ _a = headerParameters;
102
+ _b = "apikey";
103
+ return [4 /*yield*/, this.configuration.apiKey("apikey")];
104
+ case 1:
105
+ _a[_b] = _c.sent(); // api_key authentication
106
+ _c.label = 2;
107
+ case 2:
108
+ if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 4];
109
+ token = this.configuration.accessToken;
110
+ return [4 /*yield*/, token("bearer", [])];
111
+ case 3:
112
+ tokenString = _c.sent();
113
+ if (tokenString) {
114
+ headerParameters["Authorization"] = "Bearer ".concat(tokenString);
115
+ }
116
+ _c.label = 4;
117
+ case 4: return [4 /*yield*/, this.request({
118
+ path: "/private/domains/edit",
119
+ method: 'PATCH',
120
+ headers: headerParameters,
121
+ query: queryParameters,
122
+ body: (0, index_1.ApplyDomainEditInputToJSON)(requestParameters['applyDomainEditInput']),
123
+ }, initOverrides)];
124
+ case 5:
125
+ response = _c.sent();
126
+ return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, index_1.JobDtoFromJSON)(jsonValue); })];
127
+ }
128
+ });
129
+ });
130
+ };
131
+ /**
132
+ * Queues the operations a preview returned. Send them back unchanged; they are validated again here. Domains failing validation are skipped and the rest still apply. **API key scope required:** `DOMAINS_WRITE`. Requests authenticated with a seller session do not need any scope.
133
+ * Queue a previewed bulk edit
134
+ */
135
+ DomainsApi.prototype.applyDomainEdit = function (requestParameters, initOverrides) {
136
+ return __awaiter(this, void 0, void 0, function () {
137
+ var response;
138
+ return __generator(this, function (_a) {
139
+ switch (_a.label) {
140
+ case 0: return [4 /*yield*/, this.applyDomainEditRaw(requestParameters, initOverrides)];
141
+ case 1:
142
+ response = _a.sent();
143
+ return [4 /*yield*/, response.value()];
144
+ case 2: return [2 /*return*/, _a.sent()];
145
+ }
146
+ });
147
+ });
148
+ };
78
149
  /**
79
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.
80
151
  * Import domains
@@ -235,7 +306,7 @@ var DomainsApi = /** @class */ (function (_super) {
235
306
  });
236
307
  };
237
308
  /**
238
- * Applies the same settings update to multiple domains by ID. **API key scope required:** `DOMAINS_WRITE`. Requests authenticated with a seller session do not need any scope.
309
+ * Queues the same settings update for multiple domains by ID. Ids belonging to another account match nothing, and domains the update would leave in an invalid state are skipped while the rest still apply. **API key scope required:** `DOMAINS_WRITE`. Requests authenticated with a seller session do not need any scope.
239
310
  * Batch update domains
240
311
  */
241
312
  DomainsApi.prototype.batchUpdateRaw = function (requestParameters, initOverrides) {
@@ -276,29 +347,31 @@ var DomainsApi = /** @class */ (function (_super) {
276
347
  }, initOverrides)];
277
348
  case 5:
278
349
  response = _c.sent();
279
- return [2 /*return*/, new runtime.VoidApiResponse(response)];
350
+ return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, index_1.JobDtoFromJSON)(jsonValue); })];
280
351
  }
281
352
  });
282
353
  });
283
354
  };
284
355
  /**
285
- * Applies the same settings update to multiple domains by ID. **API key scope required:** `DOMAINS_WRITE`. Requests authenticated with a seller session do not need any scope.
356
+ * Queues the same settings update for multiple domains by ID. Ids belonging to another account match nothing, and domains the update would leave in an invalid state are skipped while the rest still apply. **API key scope required:** `DOMAINS_WRITE`. Requests authenticated with a seller session do not need any scope.
286
357
  * Batch update domains
287
358
  */
288
359
  DomainsApi.prototype.batchUpdate = function (requestParameters, initOverrides) {
289
360
  return __awaiter(this, void 0, void 0, function () {
361
+ var response;
290
362
  return __generator(this, function (_a) {
291
363
  switch (_a.label) {
292
364
  case 0: return [4 /*yield*/, this.batchUpdateRaw(requestParameters, initOverrides)];
293
365
  case 1:
294
- _a.sent();
295
- return [2 /*return*/];
366
+ response = _a.sent();
367
+ return [4 /*yield*/, response.value()];
368
+ case 2: return [2 /*return*/, _a.sent()];
296
369
  }
297
370
  });
298
371
  });
299
372
  };
300
373
  /**
301
- * Applies pricing and configuration updates to all domains matching the provided filter criteria. **API key scope required:** `DOMAINS_WRITE`. Requests authenticated with a seller session do not need any scope.
374
+ * Queues pricing and configuration updates for every domain matching the provided filter criteria. Domains the update would leave in an invalid state are skipped and the rest still apply. **API key scope required:** `DOMAINS_WRITE`. Requests authenticated with a seller session do not need any scope.
302
375
  * Bulk update domains with filters
303
376
  */
304
377
  DomainsApi.prototype.bulkUpdateDomainsWithFiltersRaw = function (requestParameters, initOverrides) {
@@ -345,23 +418,25 @@ var DomainsApi = /** @class */ (function (_super) {
345
418
  }, initOverrides)];
346
419
  case 5:
347
420
  response = _c.sent();
348
- return [2 /*return*/, new runtime.VoidApiResponse(response)];
421
+ return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, index_1.JobDtoFromJSON)(jsonValue); })];
349
422
  }
350
423
  });
351
424
  });
352
425
  };
353
426
  /**
354
- * Applies pricing and configuration updates to all domains matching the provided filter criteria. **API key scope required:** `DOMAINS_WRITE`. Requests authenticated with a seller session do not need any scope.
427
+ * Queues pricing and configuration updates for every domain matching the provided filter criteria. Domains the update would leave in an invalid state are skipped and the rest still apply. **API key scope required:** `DOMAINS_WRITE`. Requests authenticated with a seller session do not need any scope.
355
428
  * Bulk update domains with filters
356
429
  */
357
430
  DomainsApi.prototype.bulkUpdateDomainsWithFilters = function (requestParameters, initOverrides) {
358
431
  return __awaiter(this, void 0, void 0, function () {
432
+ var response;
359
433
  return __generator(this, function (_a) {
360
434
  switch (_a.label) {
361
435
  case 0: return [4 /*yield*/, this.bulkUpdateDomainsWithFiltersRaw(requestParameters, initOverrides)];
362
436
  case 1:
363
- _a.sent();
364
- return [2 /*return*/];
437
+ response = _a.sent();
438
+ return [4 /*yield*/, response.value()];
439
+ case 2: return [2 /*return*/, _a.sent()];
365
440
  }
366
441
  });
367
442
  });
@@ -1295,6 +1370,77 @@ var DomainsApi = /** @class */ (function (_super) {
1295
1370
  });
1296
1371
  });
1297
1372
  };
1373
+ /**
1374
+ * Turns a sentence into edit operations and returns how many domains it would change, with a sample of before and after values. Nothing is written. **API key scope required:** `DOMAINS_READ`. Requests authenticated with a seller session do not need any scope.
1375
+ * Translate a plain-language bulk edit and preview it
1376
+ */
1377
+ DomainsApi.prototype.previewDomainEditRaw = function (requestParameters, initOverrides) {
1378
+ return __awaiter(this, void 0, void 0, function () {
1379
+ var queryParameters, headerParameters, _a, _b, token, tokenString, response;
1380
+ return __generator(this, function (_c) {
1381
+ switch (_c.label) {
1382
+ case 0:
1383
+ if (requestParameters['previewDomainEditInput'] == null) {
1384
+ throw new runtime.RequiredError('previewDomainEditInput', 'Required parameter "previewDomainEditInput" was null or undefined when calling previewDomainEdit().');
1385
+ }
1386
+ queryParameters = {};
1387
+ if (requestParameters['searchFilter'] != null) {
1388
+ queryParameters['searchFilter'] = requestParameters['searchFilter'];
1389
+ }
1390
+ if (requestParameters['filter'] != null) {
1391
+ queryParameters['filter'] = requestParameters['filter'];
1392
+ }
1393
+ headerParameters = {};
1394
+ headerParameters['Content-Type'] = 'application/json';
1395
+ if (!(this.configuration && this.configuration.apiKey)) return [3 /*break*/, 2];
1396
+ _a = headerParameters;
1397
+ _b = "apikey";
1398
+ return [4 /*yield*/, this.configuration.apiKey("apikey")];
1399
+ case 1:
1400
+ _a[_b] = _c.sent(); // api_key authentication
1401
+ _c.label = 2;
1402
+ case 2:
1403
+ if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 4];
1404
+ token = this.configuration.accessToken;
1405
+ return [4 /*yield*/, token("bearer", [])];
1406
+ case 3:
1407
+ tokenString = _c.sent();
1408
+ if (tokenString) {
1409
+ headerParameters["Authorization"] = "Bearer ".concat(tokenString);
1410
+ }
1411
+ _c.label = 4;
1412
+ case 4: return [4 /*yield*/, this.request({
1413
+ path: "/private/domains/edit/preview",
1414
+ method: 'POST',
1415
+ headers: headerParameters,
1416
+ query: queryParameters,
1417
+ body: (0, index_1.PreviewDomainEditInputToJSON)(requestParameters['previewDomainEditInput']),
1418
+ }, initOverrides)];
1419
+ case 5:
1420
+ response = _c.sent();
1421
+ return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, index_1.DomainEditPreviewDtoFromJSON)(jsonValue); })];
1422
+ }
1423
+ });
1424
+ });
1425
+ };
1426
+ /**
1427
+ * Turns a sentence into edit operations and returns how many domains it would change, with a sample of before and after values. Nothing is written. **API key scope required:** `DOMAINS_READ`. Requests authenticated with a seller session do not need any scope.
1428
+ * Translate a plain-language bulk edit and preview it
1429
+ */
1430
+ DomainsApi.prototype.previewDomainEdit = function (requestParameters, initOverrides) {
1431
+ return __awaiter(this, void 0, void 0, function () {
1432
+ var response;
1433
+ return __generator(this, function (_a) {
1434
+ switch (_a.label) {
1435
+ case 0: return [4 /*yield*/, this.previewDomainEditRaw(requestParameters, initOverrides)];
1436
+ case 1:
1437
+ response = _a.sent();
1438
+ return [4 /*yield*/, response.value()];
1439
+ case 2: return [2 /*return*/, _a.sent()];
1440
+ }
1441
+ });
1442
+ });
1443
+ };
1298
1444
  /**
1299
1445
  * Creates and starts an auction for the specified verified domain. **API key scope required:** `AUCTIONS_WRITE`. Requests authenticated with a seller session do not need any scope.
1300
1446
  * Start domain auction
@@ -0,0 +1,51 @@
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 * as runtime from '../runtime';
13
+ import type { JobDto, ListJobs200Response } from '../models/index';
14
+ export interface JobsApiGetJobRequest {
15
+ jobId: string;
16
+ }
17
+ export interface JobsApiListJobsRequest {
18
+ filter?: {
19
+ [key: string]: string;
20
+ };
21
+ page?: number;
22
+ limit?: number;
23
+ sortBy?: Array<string>;
24
+ filterStatus?: string;
25
+ filterType?: string;
26
+ }
27
+ /**
28
+ *
29
+ */
30
+ export declare class JobsApi extends runtime.BaseAPI {
31
+ /**
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.
33
+ * Get a background job
34
+ */
35
+ getJobRaw(requestParameters: JobsApiGetJobRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<JobDto>>;
36
+ /**
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.
38
+ * Get a background job
39
+ */
40
+ getJob(requestParameters: JobsApiGetJobRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<JobDto>;
41
+ /**
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.
43
+ * List background jobs
44
+ */
45
+ listJobsRaw(requestParameters: JobsApiListJobsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListJobs200Response>>;
46
+ /**
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.
48
+ * List background jobs
49
+ */
50
+ listJobs(requestParameters?: JobsApiListJobsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListJobs200Response>;
51
+ }