@randock/nameshift-api-client 0.0.454 → 0.0.455
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +2 -0
- package/README.md +3 -3
- package/dist/apis/DomainsApi.d.ts +15 -1
- package/dist/apis/DomainsApi.js +68 -0
- package/dist/models/DomainSearchTranslationDto.d.ts +52 -0
- package/dist/models/DomainSearchTranslationDto.js +63 -0
- package/dist/models/TranslateDomainSearchInput.d.ts +32 -0
- package/dist/models/TranslateDomainSearchInput.js +51 -0
- package/dist/models/index.d.ts +2 -0
- package/dist/models/index.js +2 -0
- package/package.json +1 -1
- package/src/apis/DomainsApi.ts +65 -0
- package/src/models/DomainSearchTranslationDto.ts +93 -0
- package/src/models/TranslateDomainSearchInput.ts +66 -0
- package/src/models/index.ts +2 -0
package/.openapi-generator/FILES
CHANGED
|
@@ -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.
|
|
1
|
+
## @randock/nameshift-api-client@0.0.455
|
|
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.
|
|
39
|
+
npm install @randock/nameshift-api-client@0.0.455 --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
|
-
|
|
47
|
+
e00f04d5045aa291525532755871ef2fa554e6641bf016fc32c99f094629535f40c630c15dd8f09551ca109e23e73ba0
|
|
@@ -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;
|
|
@@ -66,6 +66,7 @@ export interface DomainsApiGetDomainUrlRequest {
|
|
|
66
66
|
domainId: string;
|
|
67
67
|
}
|
|
68
68
|
export interface DomainsApiListRequest {
|
|
69
|
+
searchFilter?: string;
|
|
69
70
|
filter?: {
|
|
70
71
|
[key: string]: string;
|
|
71
72
|
};
|
|
@@ -84,6 +85,9 @@ export interface DomainsApiStartAuctionRequest {
|
|
|
84
85
|
domainId: string;
|
|
85
86
|
startAuctionInput: StartAuctionInput;
|
|
86
87
|
}
|
|
88
|
+
export interface DomainsApiTranslateSearchRequest {
|
|
89
|
+
translateDomainSearchInput: TranslateDomainSearchInput;
|
|
90
|
+
}
|
|
87
91
|
export interface DomainsApiUpdateRequest {
|
|
88
92
|
domainId: string;
|
|
89
93
|
updateDomainInput: UpdateDomainInput;
|
|
@@ -290,6 +294,16 @@ export declare class DomainsApi extends runtime.BaseAPI {
|
|
|
290
294
|
* Start domain auction
|
|
291
295
|
*/
|
|
292
296
|
startAuction(requestParameters: DomainsApiStartAuctionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
297
|
+
/**
|
|
298
|
+
* 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.
|
|
299
|
+
* Translate a natural-language domain search into a filter
|
|
300
|
+
*/
|
|
301
|
+
translateSearchRaw(requestParameters: DomainsApiTranslateSearchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DomainSearchTranslationDto>>;
|
|
302
|
+
/**
|
|
303
|
+
* 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.
|
|
304
|
+
* Translate a natural-language domain search into a filter
|
|
305
|
+
*/
|
|
306
|
+
translateSearch(requestParameters: DomainsApiTranslateSearchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DomainSearchTranslationDto>;
|
|
293
307
|
/**
|
|
294
308
|
* 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
309
|
* Update domain
|
package/dist/apis/DomainsApi.js
CHANGED
|
@@ -1203,6 +1203,9 @@ var DomainsApi = /** @class */ (function (_super) {
|
|
|
1203
1203
|
switch (_c.label) {
|
|
1204
1204
|
case 0:
|
|
1205
1205
|
queryParameters = {};
|
|
1206
|
+
if (requestParameters['searchFilter'] != null) {
|
|
1207
|
+
queryParameters['searchFilter'] = requestParameters['searchFilter'];
|
|
1208
|
+
}
|
|
1206
1209
|
if (requestParameters['filter'] != null) {
|
|
1207
1210
|
queryParameters['filter'] = requestParameters['filter'];
|
|
1208
1211
|
}
|
|
@@ -1352,6 +1355,71 @@ var DomainsApi = /** @class */ (function (_super) {
|
|
|
1352
1355
|
});
|
|
1353
1356
|
});
|
|
1354
1357
|
};
|
|
1358
|
+
/**
|
|
1359
|
+
* 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.
|
|
1360
|
+
* Translate a natural-language domain search into a filter
|
|
1361
|
+
*/
|
|
1362
|
+
DomainsApi.prototype.translateSearchRaw = function (requestParameters, initOverrides) {
|
|
1363
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
1364
|
+
var queryParameters, headerParameters, _a, _b, token, tokenString, response;
|
|
1365
|
+
return __generator(this, function (_c) {
|
|
1366
|
+
switch (_c.label) {
|
|
1367
|
+
case 0:
|
|
1368
|
+
if (requestParameters['translateDomainSearchInput'] == null) {
|
|
1369
|
+
throw new runtime.RequiredError('translateDomainSearchInput', 'Required parameter "translateDomainSearchInput" was null or undefined when calling translateSearch().');
|
|
1370
|
+
}
|
|
1371
|
+
queryParameters = {};
|
|
1372
|
+
headerParameters = {};
|
|
1373
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
1374
|
+
if (!(this.configuration && this.configuration.apiKey)) return [3 /*break*/, 2];
|
|
1375
|
+
_a = headerParameters;
|
|
1376
|
+
_b = "apikey";
|
|
1377
|
+
return [4 /*yield*/, this.configuration.apiKey("apikey")];
|
|
1378
|
+
case 1:
|
|
1379
|
+
_a[_b] = _c.sent(); // api_key authentication
|
|
1380
|
+
_c.label = 2;
|
|
1381
|
+
case 2:
|
|
1382
|
+
if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 4];
|
|
1383
|
+
token = this.configuration.accessToken;
|
|
1384
|
+
return [4 /*yield*/, token("bearer", [])];
|
|
1385
|
+
case 3:
|
|
1386
|
+
tokenString = _c.sent();
|
|
1387
|
+
if (tokenString) {
|
|
1388
|
+
headerParameters["Authorization"] = "Bearer ".concat(tokenString);
|
|
1389
|
+
}
|
|
1390
|
+
_c.label = 4;
|
|
1391
|
+
case 4: return [4 /*yield*/, this.request({
|
|
1392
|
+
path: "/private/domains/search/translate",
|
|
1393
|
+
method: 'POST',
|
|
1394
|
+
headers: headerParameters,
|
|
1395
|
+
query: queryParameters,
|
|
1396
|
+
body: (0, index_1.TranslateDomainSearchInputToJSON)(requestParameters['translateDomainSearchInput']),
|
|
1397
|
+
}, initOverrides)];
|
|
1398
|
+
case 5:
|
|
1399
|
+
response = _c.sent();
|
|
1400
|
+
return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, index_1.DomainSearchTranslationDtoFromJSON)(jsonValue); })];
|
|
1401
|
+
}
|
|
1402
|
+
});
|
|
1403
|
+
});
|
|
1404
|
+
};
|
|
1405
|
+
/**
|
|
1406
|
+
* 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.
|
|
1407
|
+
* Translate a natural-language domain search into a filter
|
|
1408
|
+
*/
|
|
1409
|
+
DomainsApi.prototype.translateSearch = function (requestParameters, initOverrides) {
|
|
1410
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
1411
|
+
var response;
|
|
1412
|
+
return __generator(this, function (_a) {
|
|
1413
|
+
switch (_a.label) {
|
|
1414
|
+
case 0: return [4 /*yield*/, this.translateSearchRaw(requestParameters, initOverrides)];
|
|
1415
|
+
case 1:
|
|
1416
|
+
response = _a.sent();
|
|
1417
|
+
return [4 /*yield*/, response.value()];
|
|
1418
|
+
case 2: return [2 /*return*/, _a.sent()];
|
|
1419
|
+
}
|
|
1420
|
+
});
|
|
1421
|
+
});
|
|
1422
|
+
};
|
|
1355
1423
|
/**
|
|
1356
1424
|
* 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
1425
|
* 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
|
+
}
|
package/dist/models/index.d.ts
CHANGED
|
@@ -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';
|
package/dist/models/index.js
CHANGED
|
@@ -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
package/src/apis/DomainsApi.ts
CHANGED
|
@@ -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,
|
|
@@ -150,6 +156,7 @@ export interface DomainsApiGetDomainUrlRequest {
|
|
|
150
156
|
}
|
|
151
157
|
|
|
152
158
|
export interface DomainsApiListRequest {
|
|
159
|
+
searchFilter?: string;
|
|
153
160
|
filter?: { [key: string]: string; };
|
|
154
161
|
page?: number;
|
|
155
162
|
limit?: number;
|
|
@@ -168,6 +175,10 @@ export interface DomainsApiStartAuctionRequest {
|
|
|
168
175
|
startAuctionInput: StartAuctionInput;
|
|
169
176
|
}
|
|
170
177
|
|
|
178
|
+
export interface DomainsApiTranslateSearchRequest {
|
|
179
|
+
translateDomainSearchInput: TranslateDomainSearchInput;
|
|
180
|
+
}
|
|
181
|
+
|
|
171
182
|
export interface DomainsApiUpdateRequest {
|
|
172
183
|
domainId: string;
|
|
173
184
|
updateDomainInput: UpdateDomainInput;
|
|
@@ -1039,6 +1050,10 @@ export class DomainsApi extends runtime.BaseAPI {
|
|
|
1039
1050
|
async listRaw(requestParameters: DomainsApiListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<List200Response2>> {
|
|
1040
1051
|
const queryParameters: any = {};
|
|
1041
1052
|
|
|
1053
|
+
if (requestParameters['searchFilter'] != null) {
|
|
1054
|
+
queryParameters['searchFilter'] = requestParameters['searchFilter'];
|
|
1055
|
+
}
|
|
1056
|
+
|
|
1042
1057
|
if (requestParameters['filter'] != null) {
|
|
1043
1058
|
queryParameters['filter'] = requestParameters['filter'];
|
|
1044
1059
|
}
|
|
@@ -1172,6 +1187,56 @@ export class DomainsApi extends runtime.BaseAPI {
|
|
|
1172
1187
|
await this.startAuctionRaw(requestParameters, initOverrides);
|
|
1173
1188
|
}
|
|
1174
1189
|
|
|
1190
|
+
/**
|
|
1191
|
+
* 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.
|
|
1192
|
+
* Translate a natural-language domain search into a filter
|
|
1193
|
+
*/
|
|
1194
|
+
async translateSearchRaw(requestParameters: DomainsApiTranslateSearchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DomainSearchTranslationDto>> {
|
|
1195
|
+
if (requestParameters['translateDomainSearchInput'] == null) {
|
|
1196
|
+
throw new runtime.RequiredError(
|
|
1197
|
+
'translateDomainSearchInput',
|
|
1198
|
+
'Required parameter "translateDomainSearchInput" was null or undefined when calling translateSearch().'
|
|
1199
|
+
);
|
|
1200
|
+
}
|
|
1201
|
+
|
|
1202
|
+
const queryParameters: any = {};
|
|
1203
|
+
|
|
1204
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
1205
|
+
|
|
1206
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
1207
|
+
|
|
1208
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
1209
|
+
headerParameters["apikey"] = await this.configuration.apiKey("apikey"); // api_key authentication
|
|
1210
|
+
}
|
|
1211
|
+
|
|
1212
|
+
if (this.configuration && this.configuration.accessToken) {
|
|
1213
|
+
const token = this.configuration.accessToken;
|
|
1214
|
+
const tokenString = await token("bearer", []);
|
|
1215
|
+
|
|
1216
|
+
if (tokenString) {
|
|
1217
|
+
headerParameters["Authorization"] = `Bearer ${tokenString}`;
|
|
1218
|
+
}
|
|
1219
|
+
}
|
|
1220
|
+
const response = await this.request({
|
|
1221
|
+
path: `/private/domains/search/translate`,
|
|
1222
|
+
method: 'POST',
|
|
1223
|
+
headers: headerParameters,
|
|
1224
|
+
query: queryParameters,
|
|
1225
|
+
body: TranslateDomainSearchInputToJSON(requestParameters['translateDomainSearchInput']),
|
|
1226
|
+
}, initOverrides);
|
|
1227
|
+
|
|
1228
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => DomainSearchTranslationDtoFromJSON(jsonValue));
|
|
1229
|
+
}
|
|
1230
|
+
|
|
1231
|
+
/**
|
|
1232
|
+
* 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.
|
|
1233
|
+
* Translate a natural-language domain search into a filter
|
|
1234
|
+
*/
|
|
1235
|
+
async translateSearch(requestParameters: DomainsApiTranslateSearchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DomainSearchTranslationDto> {
|
|
1236
|
+
const response = await this.translateSearchRaw(requestParameters, initOverrides);
|
|
1237
|
+
return await response.value();
|
|
1238
|
+
}
|
|
1239
|
+
|
|
1175
1240
|
/**
|
|
1176
1241
|
* 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
1242
|
* 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
|
+
|
package/src/models/index.ts
CHANGED
|
@@ -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';
|