@randock/nameshift-api-client 0.0.454 → 0.0.456

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.
@@ -234,6 +234,7 @@ src/models/DomainSalesInformationDto.ts
234
234
  src/models/DomainSalesInformationDtoLandingPageDesign.ts
235
235
  src/models/DomainSalesInformationLeaseToOwnConfigurationDto.ts
236
236
  src/models/DomainSalesInformationRentConfigurationDto.ts
237
+ src/models/DomainSearchTranslationDto.ts
237
238
  src/models/DomainSellerDto.ts
238
239
  src/models/DomainStatsDto.ts
239
240
  src/models/DomainTldsDto.ts
@@ -513,6 +514,7 @@ src/models/TimeTableConfigurationDto.ts
513
514
  src/models/TimeTableConfigurationInput.ts
514
515
  src/models/TopAffiliateSellerDto.ts
515
516
  src/models/TopSellerAccountDto.ts
517
+ src/models/TranslateDomainSearchInput.ts
516
518
  src/models/UkBankAccountDetails.ts
517
519
  src/models/UpdateAccountBillingInformationInput.ts
518
520
  src/models/UpdateAccountChallengeRewardBalanceInput.ts
package/README.md CHANGED
@@ -1,4 +1,4 @@
1
- ## @randock/nameshift-api-client@0.0.454
1
+ ## @randock/nameshift-api-client@0.0.456
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.454 --save
39
+ npm install @randock/nameshift-api-client@0.0.456 --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
- 5b8bb0cacdf2e5c77d1ab6862de7d940e23828cfaaa2d961ae97b216e6a11166444598d7f51511251452ee730ca22924
47
+ 1178fc7a7898c3e3b621b0d438673bc41fa7c502b93b2edcb52c643266cad88143250963b6ec7a44357f91dfa2ec1807
@@ -10,7 +10,7 @@
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, DomainUrlDto, DomainVerificationStatusDto, GetAllDomainTransfers200Response, IntersectionDomainDtoWithHijackerDtoWithAccountDto, List200Response2, SellerDomainAffiliateCommissionDto, SellerDomainTransferDto, StartAuctionInput, UpdateDomainInput, UpdateDomainTransferAuthCodeInput, UpdateDomainTransferIpsTagInput } from '../models/index';
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';
14
14
  export interface DomainsApiBatchImportRequest {
15
15
  domains?: Array<string>;
16
16
  file?: Blob | null;
@@ -23,6 +23,7 @@ export interface DomainsApiBatchUpdateRequest {
23
23
  }
24
24
  export interface DomainsApiBulkUpdateDomainsWithFiltersRequest {
25
25
  bulkUpdateDomainsWithFiltersInput: BulkUpdateDomainsWithFiltersInput;
26
+ searchFilter?: string;
26
27
  filter?: object;
27
28
  }
28
29
  export interface DomainsApiCheckDnsRequest {
@@ -57,6 +58,7 @@ export interface DomainsApiGetDomainExchangeRateRequest {
57
58
  domainId: string;
58
59
  }
59
60
  export interface DomainsApiGetDomainFiltersCurrenciesRequest {
61
+ searchFilter?: string;
60
62
  filter?: object;
61
63
  }
62
64
  export interface DomainsApiGetDomainTransferRequest {
@@ -66,6 +68,7 @@ export interface DomainsApiGetDomainUrlRequest {
66
68
  domainId: string;
67
69
  }
68
70
  export interface DomainsApiListRequest {
71
+ searchFilter?: string;
69
72
  filter?: {
70
73
  [key: string]: string;
71
74
  };
@@ -84,6 +87,9 @@ export interface DomainsApiStartAuctionRequest {
84
87
  domainId: string;
85
88
  startAuctionInput: StartAuctionInput;
86
89
  }
90
+ export interface DomainsApiTranslateSearchRequest {
91
+ translateDomainSearchInput: TranslateDomainSearchInput;
92
+ }
87
93
  export interface DomainsApiUpdateRequest {
88
94
  domainId: string;
89
95
  updateDomainInput: UpdateDomainInput;
@@ -290,6 +296,16 @@ export declare class DomainsApi extends runtime.BaseAPI {
290
296
  * Start domain auction
291
297
  */
292
298
  startAuction(requestParameters: DomainsApiStartAuctionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
299
+ /**
300
+ * Turns a sentence into a filter over the account\'s own domains, with a plain-language summary of what it means. Single-word queries are name searches and should be handled client-side rather than sent here. **API key scope required:** `DOMAINS_READ`. Requests authenticated with a seller session do not need any scope.
301
+ * Translate a natural-language domain search into a filter
302
+ */
303
+ translateSearchRaw(requestParameters: DomainsApiTranslateSearchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DomainSearchTranslationDto>>;
304
+ /**
305
+ * Turns a sentence into a filter over the account\'s own domains, with a plain-language summary of what it means. Single-word queries are name searches and should be handled client-side rather than sent here. **API key scope required:** `DOMAINS_READ`. Requests authenticated with a seller session do not need any scope.
306
+ * Translate a natural-language domain search into a filter
307
+ */
308
+ translateSearch(requestParameters: DomainsApiTranslateSearchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DomainSearchTranslationDto>;
293
309
  /**
294
310
  * Updates pricing, landing page, and other settings for a single domain. **API key scope required:** `DOMAINS_WRITE`. Requests authenticated with a seller session do not need any scope.
295
311
  * Update domain
@@ -311,6 +311,9 @@ var DomainsApi = /** @class */ (function (_super) {
311
311
  throw new runtime.RequiredError('bulkUpdateDomainsWithFiltersInput', 'Required parameter "bulkUpdateDomainsWithFiltersInput" was null or undefined when calling bulkUpdateDomainsWithFilters().');
312
312
  }
313
313
  queryParameters = {};
314
+ if (requestParameters['searchFilter'] != null) {
315
+ queryParameters['searchFilter'] = requestParameters['searchFilter'];
316
+ }
314
317
  if (requestParameters['filter'] != null) {
315
318
  queryParameters['filter'] = requestParameters['filter'];
316
319
  }
@@ -1013,6 +1016,9 @@ var DomainsApi = /** @class */ (function (_super) {
1013
1016
  switch (_c.label) {
1014
1017
  case 0:
1015
1018
  queryParameters = {};
1019
+ if (requestParameters['searchFilter'] != null) {
1020
+ queryParameters['searchFilter'] = requestParameters['searchFilter'];
1021
+ }
1016
1022
  if (requestParameters['filter'] != null) {
1017
1023
  queryParameters['filter'] = requestParameters['filter'];
1018
1024
  }
@@ -1203,6 +1209,9 @@ var DomainsApi = /** @class */ (function (_super) {
1203
1209
  switch (_c.label) {
1204
1210
  case 0:
1205
1211
  queryParameters = {};
1212
+ if (requestParameters['searchFilter'] != null) {
1213
+ queryParameters['searchFilter'] = requestParameters['searchFilter'];
1214
+ }
1206
1215
  if (requestParameters['filter'] != null) {
1207
1216
  queryParameters['filter'] = requestParameters['filter'];
1208
1217
  }
@@ -1352,6 +1361,71 @@ var DomainsApi = /** @class */ (function (_super) {
1352
1361
  });
1353
1362
  });
1354
1363
  };
1364
+ /**
1365
+ * Turns a sentence into a filter over the account\'s own domains, with a plain-language summary of what it means. Single-word queries are name searches and should be handled client-side rather than sent here. **API key scope required:** `DOMAINS_READ`. Requests authenticated with a seller session do not need any scope.
1366
+ * Translate a natural-language domain search into a filter
1367
+ */
1368
+ DomainsApi.prototype.translateSearchRaw = function (requestParameters, initOverrides) {
1369
+ return __awaiter(this, void 0, void 0, function () {
1370
+ var queryParameters, headerParameters, _a, _b, token, tokenString, response;
1371
+ return __generator(this, function (_c) {
1372
+ switch (_c.label) {
1373
+ case 0:
1374
+ if (requestParameters['translateDomainSearchInput'] == null) {
1375
+ throw new runtime.RequiredError('translateDomainSearchInput', 'Required parameter "translateDomainSearchInput" was null or undefined when calling translateSearch().');
1376
+ }
1377
+ queryParameters = {};
1378
+ headerParameters = {};
1379
+ headerParameters['Content-Type'] = 'application/json';
1380
+ if (!(this.configuration && this.configuration.apiKey)) return [3 /*break*/, 2];
1381
+ _a = headerParameters;
1382
+ _b = "apikey";
1383
+ return [4 /*yield*/, this.configuration.apiKey("apikey")];
1384
+ case 1:
1385
+ _a[_b] = _c.sent(); // api_key authentication
1386
+ _c.label = 2;
1387
+ case 2:
1388
+ if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 4];
1389
+ token = this.configuration.accessToken;
1390
+ return [4 /*yield*/, token("bearer", [])];
1391
+ case 3:
1392
+ tokenString = _c.sent();
1393
+ if (tokenString) {
1394
+ headerParameters["Authorization"] = "Bearer ".concat(tokenString);
1395
+ }
1396
+ _c.label = 4;
1397
+ case 4: return [4 /*yield*/, this.request({
1398
+ path: "/private/domains/search/translate",
1399
+ method: 'POST',
1400
+ headers: headerParameters,
1401
+ query: queryParameters,
1402
+ body: (0, index_1.TranslateDomainSearchInputToJSON)(requestParameters['translateDomainSearchInput']),
1403
+ }, initOverrides)];
1404
+ case 5:
1405
+ response = _c.sent();
1406
+ return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, index_1.DomainSearchTranslationDtoFromJSON)(jsonValue); })];
1407
+ }
1408
+ });
1409
+ });
1410
+ };
1411
+ /**
1412
+ * Turns a sentence into a filter over the account\'s own domains, with a plain-language summary of what it means. Single-word queries are name searches and should be handled client-side rather than sent here. **API key scope required:** `DOMAINS_READ`. Requests authenticated with a seller session do not need any scope.
1413
+ * Translate a natural-language domain search into a filter
1414
+ */
1415
+ DomainsApi.prototype.translateSearch = function (requestParameters, initOverrides) {
1416
+ return __awaiter(this, void 0, void 0, function () {
1417
+ var response;
1418
+ return __generator(this, function (_a) {
1419
+ switch (_a.label) {
1420
+ case 0: return [4 /*yield*/, this.translateSearchRaw(requestParameters, initOverrides)];
1421
+ case 1:
1422
+ response = _a.sent();
1423
+ return [4 /*yield*/, response.value()];
1424
+ case 2: return [2 /*return*/, _a.sent()];
1425
+ }
1426
+ });
1427
+ });
1428
+ };
1355
1429
  /**
1356
1430
  * Updates pricing, landing page, and other settings for a single domain. **API key scope required:** `DOMAINS_WRITE`. Requests authenticated with a seller session do not need any scope.
1357
1431
  * Update domain
@@ -0,0 +1,52 @@
1
+ /**
2
+ * Nameshift
3
+ * Nameshift domain marketplace and management API. ## Authentication - **Bearer JWT** — Seller and buyer sessions obtained via login endpoints. - **API key** — Pass the `apikey` header for programmatic seller access. ## Audiences - **(public)** tags — Unauthenticated or buyer-facing endpoints. - **Accounts / Domains / Leads / Buyers** — Seller or buyer resources. - **Partner** — Partner integrations.
4
+ *
5
+ * The version of the OpenAPI document: 1.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ /**
13
+ *
14
+ * @export
15
+ * @interface DomainSearchTranslationDto
16
+ */
17
+ export interface DomainSearchTranslationDto {
18
+ /**
19
+ * False when the request could not be expressed as a filter. The filter is empty in that case and must not be applied — show the summary instead.
20
+ * @type {boolean}
21
+ * @memberof DomainSearchTranslationDto
22
+ */
23
+ understood: boolean;
24
+ /**
25
+ * Opaque filter to send back on the domain list request. Its shape is an implementation detail and may change; clients should pass it through unmodified rather than reading it.
26
+ * @type {{ [key: string]: any; }}
27
+ * @memberof DomainSearchTranslationDto
28
+ */
29
+ filter: {
30
+ [key: string]: any;
31
+ };
32
+ /**
33
+ * One sentence describing what is being shown, for display above the results.
34
+ * @type {string}
35
+ * @memberof DomainSearchTranslationDto
36
+ */
37
+ summary: string;
38
+ /**
39
+ * Parts of the request that could not be expressed as a filter. Empty when everything was.
40
+ * @type {Array<string>}
41
+ * @memberof DomainSearchTranslationDto
42
+ */
43
+ unresolved: Array<string>;
44
+ }
45
+ /**
46
+ * Check if a given object implements the DomainSearchTranslationDto interface.
47
+ */
48
+ export declare function instanceOfDomainSearchTranslationDto(value: object): value is DomainSearchTranslationDto;
49
+ export declare function DomainSearchTranslationDtoFromJSON(json: any): DomainSearchTranslationDto;
50
+ export declare function DomainSearchTranslationDtoFromJSONTyped(json: any, ignoreDiscriminator: boolean): DomainSearchTranslationDto;
51
+ export declare function DomainSearchTranslationDtoToJSON(json: any): DomainSearchTranslationDto;
52
+ export declare function DomainSearchTranslationDtoToJSONTyped(value?: DomainSearchTranslationDto | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,63 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * Nameshift
6
+ * Nameshift domain marketplace and management API. ## Authentication - **Bearer JWT** — Seller and buyer sessions obtained via login endpoints. - **API key** — Pass the `apikey` header for programmatic seller access. ## Audiences - **(public)** tags — Unauthenticated or buyer-facing endpoints. - **Accounts / Domains / Leads / Buyers** — Seller or buyer resources. - **Partner** — Partner integrations.
7
+ *
8
+ * The version of the OpenAPI document: 1.0
9
+ *
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.instanceOfDomainSearchTranslationDto = instanceOfDomainSearchTranslationDto;
17
+ exports.DomainSearchTranslationDtoFromJSON = DomainSearchTranslationDtoFromJSON;
18
+ exports.DomainSearchTranslationDtoFromJSONTyped = DomainSearchTranslationDtoFromJSONTyped;
19
+ exports.DomainSearchTranslationDtoToJSON = DomainSearchTranslationDtoToJSON;
20
+ exports.DomainSearchTranslationDtoToJSONTyped = DomainSearchTranslationDtoToJSONTyped;
21
+ /**
22
+ * Check if a given object implements the DomainSearchTranslationDto interface.
23
+ */
24
+ function instanceOfDomainSearchTranslationDto(value) {
25
+ if (!('understood' in value) || value['understood'] === undefined)
26
+ return false;
27
+ if (!('filter' in value) || value['filter'] === undefined)
28
+ return false;
29
+ if (!('summary' in value) || value['summary'] === undefined)
30
+ return false;
31
+ if (!('unresolved' in value) || value['unresolved'] === undefined)
32
+ return false;
33
+ return true;
34
+ }
35
+ function DomainSearchTranslationDtoFromJSON(json) {
36
+ return DomainSearchTranslationDtoFromJSONTyped(json, false);
37
+ }
38
+ function DomainSearchTranslationDtoFromJSONTyped(json, ignoreDiscriminator) {
39
+ if (json == null) {
40
+ return json;
41
+ }
42
+ return {
43
+ 'understood': json['understood'],
44
+ 'filter': json['filter'],
45
+ 'summary': json['summary'],
46
+ 'unresolved': json['unresolved'],
47
+ };
48
+ }
49
+ function DomainSearchTranslationDtoToJSON(json) {
50
+ return DomainSearchTranslationDtoToJSONTyped(json, false);
51
+ }
52
+ function DomainSearchTranslationDtoToJSONTyped(value, ignoreDiscriminator) {
53
+ if (ignoreDiscriminator === void 0) { ignoreDiscriminator = false; }
54
+ if (value == null) {
55
+ return value;
56
+ }
57
+ return {
58
+ 'understood': value['understood'],
59
+ 'filter': value['filter'],
60
+ 'summary': value['summary'],
61
+ 'unresolved': value['unresolved'],
62
+ };
63
+ }
@@ -0,0 +1,32 @@
1
+ /**
2
+ * Nameshift
3
+ * Nameshift domain marketplace and management API. ## Authentication - **Bearer JWT** — Seller and buyer sessions obtained via login endpoints. - **API key** — Pass the `apikey` header for programmatic seller access. ## Audiences - **(public)** tags — Unauthenticated or buyer-facing endpoints. - **Accounts / Domains / Leads / Buyers** — Seller or buyer resources. - **Partner** — Partner integrations.
4
+ *
5
+ * The version of the OpenAPI document: 1.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ /**
13
+ *
14
+ * @export
15
+ * @interface TranslateDomainSearchInput
16
+ */
17
+ export interface TranslateDomainSearchInput {
18
+ /**
19
+ * What the seller is looking for, in their own words. A single word is handled client-side as a name search and should not reach this endpoint.
20
+ * @type {string}
21
+ * @memberof TranslateDomainSearchInput
22
+ */
23
+ query: string;
24
+ }
25
+ /**
26
+ * Check if a given object implements the TranslateDomainSearchInput interface.
27
+ */
28
+ export declare function instanceOfTranslateDomainSearchInput(value: object): value is TranslateDomainSearchInput;
29
+ export declare function TranslateDomainSearchInputFromJSON(json: any): TranslateDomainSearchInput;
30
+ export declare function TranslateDomainSearchInputFromJSONTyped(json: any, ignoreDiscriminator: boolean): TranslateDomainSearchInput;
31
+ export declare function TranslateDomainSearchInputToJSON(json: any): TranslateDomainSearchInput;
32
+ export declare function TranslateDomainSearchInputToJSONTyped(value?: TranslateDomainSearchInput | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,51 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * Nameshift
6
+ * Nameshift domain marketplace and management API. ## Authentication - **Bearer JWT** — Seller and buyer sessions obtained via login endpoints. - **API key** — Pass the `apikey` header for programmatic seller access. ## Audiences - **(public)** tags — Unauthenticated or buyer-facing endpoints. - **Accounts / Domains / Leads / Buyers** — Seller or buyer resources. - **Partner** — Partner integrations.
7
+ *
8
+ * The version of the OpenAPI document: 1.0
9
+ *
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.instanceOfTranslateDomainSearchInput = instanceOfTranslateDomainSearchInput;
17
+ exports.TranslateDomainSearchInputFromJSON = TranslateDomainSearchInputFromJSON;
18
+ exports.TranslateDomainSearchInputFromJSONTyped = TranslateDomainSearchInputFromJSONTyped;
19
+ exports.TranslateDomainSearchInputToJSON = TranslateDomainSearchInputToJSON;
20
+ exports.TranslateDomainSearchInputToJSONTyped = TranslateDomainSearchInputToJSONTyped;
21
+ /**
22
+ * Check if a given object implements the TranslateDomainSearchInput interface.
23
+ */
24
+ function instanceOfTranslateDomainSearchInput(value) {
25
+ if (!('query' in value) || value['query'] === undefined)
26
+ return false;
27
+ return true;
28
+ }
29
+ function TranslateDomainSearchInputFromJSON(json) {
30
+ return TranslateDomainSearchInputFromJSONTyped(json, false);
31
+ }
32
+ function TranslateDomainSearchInputFromJSONTyped(json, ignoreDiscriminator) {
33
+ if (json == null) {
34
+ return json;
35
+ }
36
+ return {
37
+ 'query': json['query'],
38
+ };
39
+ }
40
+ function TranslateDomainSearchInputToJSON(json) {
41
+ return TranslateDomainSearchInputToJSONTyped(json, false);
42
+ }
43
+ function TranslateDomainSearchInputToJSONTyped(value, ignoreDiscriminator) {
44
+ if (ignoreDiscriminator === void 0) { ignoreDiscriminator = false; }
45
+ if (value == null) {
46
+ return value;
47
+ }
48
+ return {
49
+ 'query': value['query'],
50
+ };
51
+ }
@@ -195,6 +195,7 @@ export * from './DomainSalesInformationDto';
195
195
  export * from './DomainSalesInformationDtoLandingPageDesign';
196
196
  export * from './DomainSalesInformationLeaseToOwnConfigurationDto';
197
197
  export * from './DomainSalesInformationRentConfigurationDto';
198
+ export * from './DomainSearchTranslationDto';
198
199
  export * from './DomainSellerDto';
199
200
  export * from './DomainStatsDto';
200
201
  export * from './DomainTldsDto';
@@ -474,6 +475,7 @@ export * from './TimeTableConfigurationDto';
474
475
  export * from './TimeTableConfigurationInput';
475
476
  export * from './TopAffiliateSellerDto';
476
477
  export * from './TopSellerAccountDto';
478
+ export * from './TranslateDomainSearchInput';
477
479
  export * from './UkBankAccountDetails';
478
480
  export * from './UpdateAccountBillingInformationInput';
479
481
  export * from './UpdateAccountChallengeRewardBalanceInput';
@@ -213,6 +213,7 @@ __exportStar(require("./DomainSalesInformationDto"), exports);
213
213
  __exportStar(require("./DomainSalesInformationDtoLandingPageDesign"), exports);
214
214
  __exportStar(require("./DomainSalesInformationLeaseToOwnConfigurationDto"), exports);
215
215
  __exportStar(require("./DomainSalesInformationRentConfigurationDto"), exports);
216
+ __exportStar(require("./DomainSearchTranslationDto"), exports);
216
217
  __exportStar(require("./DomainSellerDto"), exports);
217
218
  __exportStar(require("./DomainStatsDto"), exports);
218
219
  __exportStar(require("./DomainTldsDto"), exports);
@@ -492,6 +493,7 @@ __exportStar(require("./TimeTableConfigurationDto"), exports);
492
493
  __exportStar(require("./TimeTableConfigurationInput"), exports);
493
494
  __exportStar(require("./TopAffiliateSellerDto"), exports);
494
495
  __exportStar(require("./TopSellerAccountDto"), exports);
496
+ __exportStar(require("./TranslateDomainSearchInput"), exports);
495
497
  __exportStar(require("./UkBankAccountDetails"), exports);
496
498
  __exportStar(require("./UpdateAccountBillingInformationInput"), exports);
497
499
  __exportStar(require("./UpdateAccountChallengeRewardBalanceInput"), exports);
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@randock/nameshift-api-client",
3
- "version": "0.0.454",
3
+ "version": "0.0.456",
4
4
  "description": "OpenAPI client for @randock/nameshift-api-client",
5
5
  "author": "OpenAPI-Generator",
6
6
  "repository": {
@@ -23,6 +23,7 @@ import type {
23
23
  DeleteDomainsInput,
24
24
  DomainExchangeRateDto,
25
25
  DomainFiltersDto,
26
+ DomainSearchTranslationDto,
26
27
  DomainUrlDto,
27
28
  DomainVerificationStatusDto,
28
29
  GetAllDomainTransfers200Response,
@@ -32,6 +33,7 @@ import type {
32
33
  SellerDomainAffiliateCommissionDto,
33
34
  SellerDomainTransferDto,
34
35
  StartAuctionInput,
36
+ TranslateDomainSearchInput,
35
37
  UpdateDomainInput,
36
38
  UpdateDomainTransferAuthCodeInput,
37
39
  UpdateDomainTransferIpsTagInput,
@@ -54,6 +56,8 @@ import {
54
56
  DomainExchangeRateDtoToJSON,
55
57
  DomainFiltersDtoFromJSON,
56
58
  DomainFiltersDtoToJSON,
59
+ DomainSearchTranslationDtoFromJSON,
60
+ DomainSearchTranslationDtoToJSON,
57
61
  DomainUrlDtoFromJSON,
58
62
  DomainUrlDtoToJSON,
59
63
  DomainVerificationStatusDtoFromJSON,
@@ -72,6 +76,8 @@ import {
72
76
  SellerDomainTransferDtoToJSON,
73
77
  StartAuctionInputFromJSON,
74
78
  StartAuctionInputToJSON,
79
+ TranslateDomainSearchInputFromJSON,
80
+ TranslateDomainSearchInputToJSON,
75
81
  UpdateDomainInputFromJSON,
76
82
  UpdateDomainInputToJSON,
77
83
  UpdateDomainTransferAuthCodeInputFromJSON,
@@ -97,6 +103,7 @@ export interface DomainsApiBatchUpdateRequest {
97
103
 
98
104
  export interface DomainsApiBulkUpdateDomainsWithFiltersRequest {
99
105
  bulkUpdateDomainsWithFiltersInput: BulkUpdateDomainsWithFiltersInput;
106
+ searchFilter?: string;
100
107
  filter?: object;
101
108
  }
102
109
 
@@ -138,6 +145,7 @@ export interface DomainsApiGetDomainExchangeRateRequest {
138
145
  }
139
146
 
140
147
  export interface DomainsApiGetDomainFiltersCurrenciesRequest {
148
+ searchFilter?: string;
141
149
  filter?: object;
142
150
  }
143
151
 
@@ -150,6 +158,7 @@ export interface DomainsApiGetDomainUrlRequest {
150
158
  }
151
159
 
152
160
  export interface DomainsApiListRequest {
161
+ searchFilter?: string;
153
162
  filter?: { [key: string]: string; };
154
163
  page?: number;
155
164
  limit?: number;
@@ -168,6 +177,10 @@ export interface DomainsApiStartAuctionRequest {
168
177
  startAuctionInput: StartAuctionInput;
169
178
  }
170
179
 
180
+ export interface DomainsApiTranslateSearchRequest {
181
+ translateDomainSearchInput: TranslateDomainSearchInput;
182
+ }
183
+
171
184
  export interface DomainsApiUpdateRequest {
172
185
  domainId: string;
173
186
  updateDomainInput: UpdateDomainInput;
@@ -376,6 +389,10 @@ export class DomainsApi extends runtime.BaseAPI {
376
389
 
377
390
  const queryParameters: any = {};
378
391
 
392
+ if (requestParameters['searchFilter'] != null) {
393
+ queryParameters['searchFilter'] = requestParameters['searchFilter'];
394
+ }
395
+
379
396
  if (requestParameters['filter'] != null) {
380
397
  queryParameters['filter'] = requestParameters['filter'];
381
398
  }
@@ -901,6 +918,10 @@ export class DomainsApi extends runtime.BaseAPI {
901
918
  async getDomainFiltersCurrenciesRaw(requestParameters: DomainsApiGetDomainFiltersCurrenciesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<string>>> {
902
919
  const queryParameters: any = {};
903
920
 
921
+ if (requestParameters['searchFilter'] != null) {
922
+ queryParameters['searchFilter'] = requestParameters['searchFilter'];
923
+ }
924
+
904
925
  if (requestParameters['filter'] != null) {
905
926
  queryParameters['filter'] = requestParameters['filter'];
906
927
  }
@@ -1039,6 +1060,10 @@ export class DomainsApi extends runtime.BaseAPI {
1039
1060
  async listRaw(requestParameters: DomainsApiListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<List200Response2>> {
1040
1061
  const queryParameters: any = {};
1041
1062
 
1063
+ if (requestParameters['searchFilter'] != null) {
1064
+ queryParameters['searchFilter'] = requestParameters['searchFilter'];
1065
+ }
1066
+
1042
1067
  if (requestParameters['filter'] != null) {
1043
1068
  queryParameters['filter'] = requestParameters['filter'];
1044
1069
  }
@@ -1172,6 +1197,56 @@ export class DomainsApi extends runtime.BaseAPI {
1172
1197
  await this.startAuctionRaw(requestParameters, initOverrides);
1173
1198
  }
1174
1199
 
1200
+ /**
1201
+ * Turns a sentence into a filter over the account\'s own domains, with a plain-language summary of what it means. Single-word queries are name searches and should be handled client-side rather than sent here. **API key scope required:** `DOMAINS_READ`. Requests authenticated with a seller session do not need any scope.
1202
+ * Translate a natural-language domain search into a filter
1203
+ */
1204
+ async translateSearchRaw(requestParameters: DomainsApiTranslateSearchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DomainSearchTranslationDto>> {
1205
+ if (requestParameters['translateDomainSearchInput'] == null) {
1206
+ throw new runtime.RequiredError(
1207
+ 'translateDomainSearchInput',
1208
+ 'Required parameter "translateDomainSearchInput" was null or undefined when calling translateSearch().'
1209
+ );
1210
+ }
1211
+
1212
+ const queryParameters: any = {};
1213
+
1214
+ const headerParameters: runtime.HTTPHeaders = {};
1215
+
1216
+ headerParameters['Content-Type'] = 'application/json';
1217
+
1218
+ if (this.configuration && this.configuration.apiKey) {
1219
+ headerParameters["apikey"] = await this.configuration.apiKey("apikey"); // api_key authentication
1220
+ }
1221
+
1222
+ if (this.configuration && this.configuration.accessToken) {
1223
+ const token = this.configuration.accessToken;
1224
+ const tokenString = await token("bearer", []);
1225
+
1226
+ if (tokenString) {
1227
+ headerParameters["Authorization"] = `Bearer ${tokenString}`;
1228
+ }
1229
+ }
1230
+ const response = await this.request({
1231
+ path: `/private/domains/search/translate`,
1232
+ method: 'POST',
1233
+ headers: headerParameters,
1234
+ query: queryParameters,
1235
+ body: TranslateDomainSearchInputToJSON(requestParameters['translateDomainSearchInput']),
1236
+ }, initOverrides);
1237
+
1238
+ return new runtime.JSONApiResponse(response, (jsonValue) => DomainSearchTranslationDtoFromJSON(jsonValue));
1239
+ }
1240
+
1241
+ /**
1242
+ * Turns a sentence into a filter over the account\'s own domains, with a plain-language summary of what it means. Single-word queries are name searches and should be handled client-side rather than sent here. **API key scope required:** `DOMAINS_READ`. Requests authenticated with a seller session do not need any scope.
1243
+ * Translate a natural-language domain search into a filter
1244
+ */
1245
+ async translateSearch(requestParameters: DomainsApiTranslateSearchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DomainSearchTranslationDto> {
1246
+ const response = await this.translateSearchRaw(requestParameters, initOverrides);
1247
+ return await response.value();
1248
+ }
1249
+
1175
1250
  /**
1176
1251
  * Updates pricing, landing page, and other settings for a single domain. **API key scope required:** `DOMAINS_WRITE`. Requests authenticated with a seller session do not need any scope.
1177
1252
  * Update domain
@@ -0,0 +1,93 @@
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
+ /**
17
+ *
18
+ * @export
19
+ * @interface DomainSearchTranslationDto
20
+ */
21
+ export interface DomainSearchTranslationDto {
22
+ /**
23
+ * False when the request could not be expressed as a filter. The filter is empty in that case and must not be applied — show the summary instead.
24
+ * @type {boolean}
25
+ * @memberof DomainSearchTranslationDto
26
+ */
27
+ understood: boolean;
28
+ /**
29
+ * Opaque filter to send back on the domain list request. Its shape is an implementation detail and may change; clients should pass it through unmodified rather than reading it.
30
+ * @type {{ [key: string]: any; }}
31
+ * @memberof DomainSearchTranslationDto
32
+ */
33
+ filter: { [key: string]: any; };
34
+ /**
35
+ * One sentence describing what is being shown, for display above the results.
36
+ * @type {string}
37
+ * @memberof DomainSearchTranslationDto
38
+ */
39
+ summary: string;
40
+ /**
41
+ * Parts of the request that could not be expressed as a filter. Empty when everything was.
42
+ * @type {Array<string>}
43
+ * @memberof DomainSearchTranslationDto
44
+ */
45
+ unresolved: Array<string>;
46
+ }
47
+
48
+ /**
49
+ * Check if a given object implements the DomainSearchTranslationDto interface.
50
+ */
51
+ export function instanceOfDomainSearchTranslationDto(value: object): value is DomainSearchTranslationDto {
52
+ if (!('understood' in value) || value['understood'] === undefined) return false;
53
+ if (!('filter' in value) || value['filter'] === undefined) return false;
54
+ if (!('summary' in value) || value['summary'] === undefined) return false;
55
+ if (!('unresolved' in value) || value['unresolved'] === undefined) return false;
56
+ return true;
57
+ }
58
+
59
+ export function DomainSearchTranslationDtoFromJSON(json: any): DomainSearchTranslationDto {
60
+ return DomainSearchTranslationDtoFromJSONTyped(json, false);
61
+ }
62
+
63
+ export function DomainSearchTranslationDtoFromJSONTyped(json: any, ignoreDiscriminator: boolean): DomainSearchTranslationDto {
64
+ if (json == null) {
65
+ return json;
66
+ }
67
+ return {
68
+
69
+ 'understood': json['understood'],
70
+ 'filter': json['filter'],
71
+ 'summary': json['summary'],
72
+ 'unresolved': json['unresolved'],
73
+ };
74
+ }
75
+
76
+ export function DomainSearchTranslationDtoToJSON(json: any): DomainSearchTranslationDto {
77
+ return DomainSearchTranslationDtoToJSONTyped(json, false);
78
+ }
79
+
80
+ export function DomainSearchTranslationDtoToJSONTyped(value?: DomainSearchTranslationDto | null, ignoreDiscriminator: boolean = false): any {
81
+ if (value == null) {
82
+ return value;
83
+ }
84
+
85
+ return {
86
+
87
+ 'understood': value['understood'],
88
+ 'filter': value['filter'],
89
+ 'summary': value['summary'],
90
+ 'unresolved': value['unresolved'],
91
+ };
92
+ }
93
+
@@ -0,0 +1,66 @@
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
+ /**
17
+ *
18
+ * @export
19
+ * @interface TranslateDomainSearchInput
20
+ */
21
+ export interface TranslateDomainSearchInput {
22
+ /**
23
+ * What the seller is looking for, in their own words. A single word is handled client-side as a name search and should not reach this endpoint.
24
+ * @type {string}
25
+ * @memberof TranslateDomainSearchInput
26
+ */
27
+ query: string;
28
+ }
29
+
30
+ /**
31
+ * Check if a given object implements the TranslateDomainSearchInput interface.
32
+ */
33
+ export function instanceOfTranslateDomainSearchInput(value: object): value is TranslateDomainSearchInput {
34
+ if (!('query' in value) || value['query'] === undefined) return false;
35
+ return true;
36
+ }
37
+
38
+ export function TranslateDomainSearchInputFromJSON(json: any): TranslateDomainSearchInput {
39
+ return TranslateDomainSearchInputFromJSONTyped(json, false);
40
+ }
41
+
42
+ export function TranslateDomainSearchInputFromJSONTyped(json: any, ignoreDiscriminator: boolean): TranslateDomainSearchInput {
43
+ if (json == null) {
44
+ return json;
45
+ }
46
+ return {
47
+
48
+ 'query': json['query'],
49
+ };
50
+ }
51
+
52
+ export function TranslateDomainSearchInputToJSON(json: any): TranslateDomainSearchInput {
53
+ return TranslateDomainSearchInputToJSONTyped(json, false);
54
+ }
55
+
56
+ export function TranslateDomainSearchInputToJSONTyped(value?: TranslateDomainSearchInput | null, ignoreDiscriminator: boolean = false): any {
57
+ if (value == null) {
58
+ return value;
59
+ }
60
+
61
+ return {
62
+
63
+ 'query': value['query'],
64
+ };
65
+ }
66
+
@@ -197,6 +197,7 @@ export * from './DomainSalesInformationDto';
197
197
  export * from './DomainSalesInformationDtoLandingPageDesign';
198
198
  export * from './DomainSalesInformationLeaseToOwnConfigurationDto';
199
199
  export * from './DomainSalesInformationRentConfigurationDto';
200
+ export * from './DomainSearchTranslationDto';
200
201
  export * from './DomainSellerDto';
201
202
  export * from './DomainStatsDto';
202
203
  export * from './DomainTldsDto';
@@ -476,6 +477,7 @@ export * from './TimeTableConfigurationDto';
476
477
  export * from './TimeTableConfigurationInput';
477
478
  export * from './TopAffiliateSellerDto';
478
479
  export * from './TopSellerAccountDto';
480
+ export * from './TranslateDomainSearchInput';
479
481
  export * from './UkBankAccountDetails';
480
482
  export * from './UpdateAccountBillingInformationInput';
481
483
  export * from './UpdateAccountChallengeRewardBalanceInput';