@randock/nameshift-api-client 0.0.447 → 0.0.448

package/README.md

@@ -1,4 +1,4 @@
-## @randock/nameshift-api-client@0.0.447
+## @randock/nameshift-api-client@0.0.448
 
 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:
 
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
 _published:_
 
 ```
-npm install @randock/nameshift-api-client@0.0.447 --save
+npm install @randock/nameshift-api-client@0.0.448 --save
 ```
 
 _unPublished (not recommended):_
@@ -44,4 +44,4 @@ _unPublished (not recommended):_
 ```
 npm install PATH_TO_GENERATED_PACKAGE --save
 ```
-b16518573bfed486629257b16565a7436b69e47de57a4687cf2b290774663712d2ca7860ddbea923af3e066d5a2b9b11
+488272701c73a444b279b58c7c8783ee5c4dcf21f2bb6eb821d4943e3b267d359abaa3ba65e920aca8d49177125d90de

package/dist/apis/AdminApi.d.ts

@@ -264,6 +264,9 @@ export interface AdminApiRemoveDomainLockRequest {
     domainId: string;
     lockId: string;
 }
+export interface AdminApiShowcaseDomainRequest {
+    domainId: string;
+}
 export interface AdminApiSimulateCommissionRequest {
     simulateCommissionInput: SimulateCommissionInput;
 }
@@ -276,6 +279,9 @@ export interface AdminApiSyncAllAccountPaymentMethodProfilesRequest {
 export interface AdminApiSyncOwnedDomainFromRegistryRequest {
     id: string;
 }
+export interface AdminApiUnshowcaseDomainRequest {
+    domainId: string;
+}
 export interface AdminApiUpdateAccountChallengeRewardBalancePointsRequest {
     accountId: string;
     updateAccountChallengeRewardBalanceInput: UpdateAccountChallengeRewardBalanceInput;
@@ -832,6 +838,16 @@ export declare class AdminApi extends runtime.BaseAPI {
      * Remove domain lock
      */
     removeDomainLock(requestParameters: AdminApiRemoveDomainLockRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Picks the domain for the public showcase on the website. Idempotent: showcasing an already showcased domain keeps its original position in the showcase.
+     * Showcase domain
+     */
+    showcaseDomainRaw(requestParameters: AdminApiShowcaseDomainRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Picks the domain for the public showcase on the website. Idempotent: showcasing an already showcased domain keeps its original position in the showcase.
+     * Showcase domain
+     */
+    showcaseDomain(requestParameters: AdminApiShowcaseDomainRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
      * Evaluates the commission percentage for a given scenario without persisting any changes.
      * Simulate commission percentage
@@ -872,6 +888,16 @@ export declare class AdminApi extends runtime.BaseAPI {
      * Sync owned domain from registry
      */
     syncOwnedDomainFromRegistry(requestParameters: AdminApiSyncOwnedDomainFromRegistryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Drops the domain from the public showcase on the website. Idempotent.
+     * Remove domain from the showcase
+     */
+    unshowcaseDomainRaw(requestParameters: AdminApiUnshowcaseDomainRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Drops the domain from the public showcase on the website. Idempotent.
+     * Remove domain from the showcase
+     */
+    unshowcaseDomain(requestParameters: AdminApiUnshowcaseDomainRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
      * Sets the absolute challenge reward points balance for an account.
      * Update challenge reward balance

package/dist/apis/AdminApi.js

@@ -3214,6 +3214,59 @@ var AdminApi = /** @class */ (function (_super) {
             });
         });
     };
+    /**
+     * Picks the domain for the public showcase on the website. Idempotent: showcasing an already showcased domain keeps its original position in the showcase.
+     * Showcase domain
+     */
+    AdminApi.prototype.showcaseDomainRaw = function (requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function () {
+            var queryParameters, headerParameters, token, tokenString, response;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        if (requestParameters['domainId'] == null) {
+                            throw new runtime.RequiredError('domainId', 'Required parameter "domainId" was null or undefined when calling showcaseDomain().');
+                        }
+                        queryParameters = {};
+                        headerParameters = {};
+                        if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
+                        token = this.configuration.accessToken;
+                        return [4 /*yield*/, token("bearer", [])];
+                    case 1:
+                        tokenString = _a.sent();
+                        if (tokenString) {
+                            headerParameters["Authorization"] = "Bearer ".concat(tokenString);
+                        }
+                        _a.label = 2;
+                    case 2: return [4 /*yield*/, this.request({
+                            path: "/admin/domains/{domainId}/showcase".replace("{".concat("domainId", "}"), encodeURIComponent(String(requestParameters['domainId']))),
+                            method: 'PUT',
+                            headers: headerParameters,
+                            query: queryParameters,
+                        }, initOverrides)];
+                    case 3:
+                        response = _a.sent();
+                        return [2 /*return*/, new runtime.VoidApiResponse(response)];
+                }
+            });
+        });
+    };
+    /**
+     * Picks the domain for the public showcase on the website. Idempotent: showcasing an already showcased domain keeps its original position in the showcase.
+     * Showcase domain
+     */
+    AdminApi.prototype.showcaseDomain = function (requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.showcaseDomainRaw(requestParameters, initOverrides)];
+                    case 1:
+                        _a.sent();
+                        return [2 /*return*/];
+                }
+            });
+        });
+    };
     /**
      * Evaluates the commission percentage for a given scenario without persisting any changes.
      * Simulate commission percentage
@@ -3430,6 +3483,59 @@ var AdminApi = /** @class */ (function (_super) {
             });
         });
     };
+    /**
+     * Drops the domain from the public showcase on the website. Idempotent.
+     * Remove domain from the showcase
+     */
+    AdminApi.prototype.unshowcaseDomainRaw = function (requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function () {
+            var queryParameters, headerParameters, token, tokenString, response;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        if (requestParameters['domainId'] == null) {
+                            throw new runtime.RequiredError('domainId', 'Required parameter "domainId" was null or undefined when calling unshowcaseDomain().');
+                        }
+                        queryParameters = {};
+                        headerParameters = {};
+                        if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
+                        token = this.configuration.accessToken;
+                        return [4 /*yield*/, token("bearer", [])];
+                    case 1:
+                        tokenString = _a.sent();
+                        if (tokenString) {
+                            headerParameters["Authorization"] = "Bearer ".concat(tokenString);
+                        }
+                        _a.label = 2;
+                    case 2: return [4 /*yield*/, this.request({
+                            path: "/admin/domains/{domainId}/showcase".replace("{".concat("domainId", "}"), encodeURIComponent(String(requestParameters['domainId']))),
+                            method: 'DELETE',
+                            headers: headerParameters,
+                            query: queryParameters,
+                        }, initOverrides)];
+                    case 3:
+                        response = _a.sent();
+                        return [2 /*return*/, new runtime.VoidApiResponse(response)];
+                }
+            });
+        });
+    };
+    /**
+     * Drops the domain from the public showcase on the website. Idempotent.
+     * Remove domain from the showcase
+     */
+    AdminApi.prototype.unshowcaseDomain = function (requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.unshowcaseDomainRaw(requestParameters, initOverrides)];
+                    case 1:
+                        _a.sent();
+                        return [2 /*return*/];
+                }
+            });
+        });
+    };
     /**
      * Sets the absolute challenge reward points balance for an account.
      * Update challenge reward balance

package/dist/apis/MarketApi.d.ts

@@ -49,12 +49,12 @@ export declare class MarketApi extends runtime.BaseAPI {
      */
     listRecentSales(requestParameters?: MarketApiListRecentSalesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<PublicSaleDto>>;
     /**
-     * Returns a showcase of listed domains: the public catalogue in its default ranking (domain authority).
+     * Returns the domains an admin picked for the showcase, most recently picked first. Sold and deleted domains are left out; an empty array means nothing is picked.
      * List showcase domains
      */
     listShowcaseDomainsRaw(requestParameters: MarketApiListShowcaseDomainsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<PublicDomainDto>>>;
     /**
-     * Returns a showcase of listed domains: the public catalogue in its default ranking (domain authority).
+     * Returns the domains an admin picked for the showcase, most recently picked first. Sold and deleted domains are left out; an empty array means nothing is picked.
      * List showcase domains
      */
     listShowcaseDomains(requestParameters?: MarketApiListShowcaseDomainsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<PublicDomainDto>>;

package/dist/apis/MarketApi.js

@@ -184,7 +184,7 @@ var MarketApi = /** @class */ (function (_super) {
         });
     };
     /**
-     * Returns a showcase of listed domains: the public catalogue in its default ranking (domain authority).
+     * Returns the domains an admin picked for the showcase, most recently picked first. Sold and deleted domains are left out; an empty array means nothing is picked.
      * List showcase domains
      */
     MarketApi.prototype.listShowcaseDomainsRaw = function (requestParameters, initOverrides) {
@@ -219,7 +219,7 @@ var MarketApi = /** @class */ (function (_super) {
         });
     };
     /**
-     * Returns a showcase of listed domains: the public catalogue in its default ranking (domain authority).
+     * Returns the domains an admin picked for the showcase, most recently picked first. Sold and deleted domains are left out; an empty array means nothing is picked.
      * List showcase domains
      */
     MarketApi.prototype.listShowcaseDomains = function () {

package/dist/models/AdminDomainListItemDto.d.ts

@@ -196,6 +196,12 @@ export interface AdminDomainListItemDto {
      * @memberof AdminDomainListItemDto
      */
     lockedUntil: Date | null;
+    /**
+     * Whether an admin picked this domain for the public showcase on the website.
+     * @type {boolean}
+     * @memberof AdminDomainListItemDto
+     */
+    showcased: boolean;
     /**
      * Account that owns the domain.
      * @type {AccountDto}

package/dist/models/AdminDomainListItemDto.js

@@ -99,6 +99,8 @@ function instanceOfAdminDomainListItemDto(value) {
         return false;
     if (!('lockedUntil' in value) || value['lockedUntil'] === undefined)
         return false;
+    if (!('showcased' in value) || value['showcased'] === undefined)
+        return false;
     if (!('account' in value) || value['account'] === undefined)
         return false;
     if (!('pointsToOurServerReason' in value) || value['pointsToOurServerReason'] === undefined)
@@ -142,6 +144,7 @@ function AdminDomainListItemDtoFromJSONTyped(json, ignoreDiscriminator) {
         'isDeleteable': json['isDeleteable'],
         'isLocked': json['isLocked'],
         'lockedUntil': (json['lockedUntil'] == null ? null : new Date(json['lockedUntil'])),
+        'showcased': json['showcased'],
         'account': (0, AccountDto_1.AccountDtoFromJSON)(json['account']),
         'pointsToOurServerReason': json['pointsToOurServerReason'],
     };
@@ -184,6 +187,7 @@ function AdminDomainListItemDtoToJSONTyped(value, ignoreDiscriminator) {
         'isDeleteable': value['isDeleteable'],
         'isLocked': value['isLocked'],
         'lockedUntil': (value['lockedUntil'] == null ? null : value['lockedUntil'].toISOString()),
+        'showcased': value['showcased'],
         'account': (0, AccountDto_1.AccountDtoToJSON)(value['account']),
         'pointsToOurServerReason': value['pointsToOurServerReason'],
     };

package/dist/models/IntersectionDomainDtoWithAccountDtoWithAuctionInfoDto.d.ts

@@ -196,6 +196,12 @@ export interface IntersectionDomainDtoWithAccountDtoWithAuctionInfoDto {
      * @memberof IntersectionDomainDtoWithAccountDtoWithAuctionInfoDto
      */
     lockedUntil: Date | null;
+    /**
+     * Whether an admin picked this domain for the public showcase on the website.
+     * @type {boolean}
+     * @memberof IntersectionDomainDtoWithAccountDtoWithAuctionInfoDto
+     */
+    showcased: boolean;
     /**
      * Account that owns the domain.
      * @type {AccountDto}

package/dist/models/IntersectionDomainDtoWithAccountDtoWithAuctionInfoDto.js

@@ -87,6 +87,8 @@ function instanceOfIntersectionDomainDtoWithAccountDtoWithAuctionInfoDto(value)
         return false;
     if (!('lockedUntil' in value) || value['lockedUntil'] === undefined)
         return false;
+    if (!('showcased' in value) || value['showcased'] === undefined)
+        return false;
     if (!('account' in value) || value['account'] === undefined)
         return false;
     if (!('hasAuction' in value) || value['hasAuction'] === undefined)
@@ -130,6 +132,7 @@ function IntersectionDomainDtoWithAccountDtoWithAuctionInfoDtoFromJSONTyped(json
         'isDeleteable': json['isDeleteable'],
         'isLocked': json['isLocked'],
         'lockedUntil': (json['lockedUntil'] == null ? null : new Date(json['lockedUntil'])),
+        'showcased': json['showcased'],
         'account': (0, AccountDto_1.AccountDtoFromJSON)(json['account']),
         'hasAuction': json['hasAuction'],
     };
@@ -172,6 +175,7 @@ function IntersectionDomainDtoWithAccountDtoWithAuctionInfoDtoToJSONTyped(value,
         'isDeleteable': value['isDeleteable'],
         'isLocked': value['isLocked'],
         'lockedUntil': (value['lockedUntil'] == null ? null : value['lockedUntil'].toISOString()),
+        'showcased': value['showcased'],
         'account': (0, AccountDto_1.AccountDtoToJSON)(value['account']),
         'hasAuction': value['hasAuction'],
     };

package/dist/models/IntersectionDomainDtoWithHijackerDtoWithAccountDto.d.ts

@@ -196,6 +196,12 @@ export interface IntersectionDomainDtoWithHijackerDtoWithAccountDto {
      * @memberof IntersectionDomainDtoWithHijackerDtoWithAccountDto
      */
     lockedUntil: Date | null;
+    /**
+     * Whether an admin picked this domain for the public showcase on the website.
+     * @type {boolean}
+     * @memberof IntersectionDomainDtoWithHijackerDtoWithAccountDto
+     */
+    showcased: boolean;
     /**
      * Account managing the domain on behalf of the owner, when a hijacker is assigned.
      * @type {AccountDto}

package/dist/models/IntersectionDomainDtoWithHijackerDtoWithAccountDto.js

@@ -87,6 +87,8 @@ function instanceOfIntersectionDomainDtoWithHijackerDtoWithAccountDto(value) {
         return false;
     if (!('lockedUntil' in value) || value['lockedUntil'] === undefined)
         return false;
+    if (!('showcased' in value) || value['showcased'] === undefined)
+        return false;
     if (!('hijacker' in value) || value['hijacker'] === undefined)
         return false;
     if (!('account' in value) || value['account'] === undefined)
@@ -130,6 +132,7 @@ function IntersectionDomainDtoWithHijackerDtoWithAccountDtoFromJSONTyped(json, i
         'isDeleteable': json['isDeleteable'],
         'isLocked': json['isLocked'],
         'lockedUntil': (json['lockedUntil'] == null ? null : new Date(json['lockedUntil'])),
+        'showcased': json['showcased'],
         'hijacker': (0, AccountDto_1.AccountDtoFromJSON)(json['hijacker']),
         'account': (0, AccountDto_1.AccountDtoFromJSON)(json['account']),
     };
@@ -172,6 +175,7 @@ function IntersectionDomainDtoWithHijackerDtoWithAccountDtoToJSONTyped(value, ig
         'isDeleteable': value['isDeleteable'],
         'isLocked': value['isLocked'],
         'lockedUntil': (value['lockedUntil'] == null ? null : value['lockedUntil'].toISOString()),
+        'showcased': value['showcased'],
         'hijacker': (0, AccountDto_1.AccountDtoToJSON)(value['hijacker']),
         'account': (0, AccountDto_1.AccountDtoToJSON)(value['account']),
     };

package/dist/models/IntersectionDomainDtoWithSeoMetricsDto.d.ts

@@ -196,6 +196,12 @@ export interface IntersectionDomainDtoWithSeoMetricsDto {
      * @memberof IntersectionDomainDtoWithSeoMetricsDto
      */
     lockedUntil: Date | null;
+    /**
+     * Whether an admin picked this domain for the public showcase on the website.
+     * @type {boolean}
+     * @memberof IntersectionDomainDtoWithSeoMetricsDto
+     */
+    showcased: boolean;
     /**
      * SEO metrics for the domain from Moz, Majestic, and historical sources.
      * @type {SeoMetricsDto}

package/dist/models/IntersectionDomainDtoWithSeoMetricsDto.js

@@ -87,6 +87,8 @@ function instanceOfIntersectionDomainDtoWithSeoMetricsDto(value) {
         return false;
     if (!('lockedUntil' in value) || value['lockedUntil'] === undefined)
         return false;
+    if (!('showcased' in value) || value['showcased'] === undefined)
+        return false;
     if (!('seoMetrics' in value) || value['seoMetrics'] === undefined)
         return false;
     return true;
@@ -128,6 +130,7 @@ function IntersectionDomainDtoWithSeoMetricsDtoFromJSONTyped(json, ignoreDiscrim
         'isDeleteable': json['isDeleteable'],
         'isLocked': json['isLocked'],
         'lockedUntil': (json['lockedUntil'] == null ? null : new Date(json['lockedUntil'])),
+        'showcased': json['showcased'],
         'seoMetrics': (0, SeoMetricsDto_1.SeoMetricsDtoFromJSON)(json['seoMetrics']),
     };
 }
@@ -169,6 +172,7 @@ function IntersectionDomainDtoWithSeoMetricsDtoToJSONTyped(value, ignoreDiscrimi
         'isDeleteable': value['isDeleteable'],
         'isLocked': value['isLocked'],
         'lockedUntil': (value['lockedUntil'] == null ? null : value['lockedUntil'].toISOString()),
+        'showcased': value['showcased'],
         'seoMetrics': (0, SeoMetricsDto_1.SeoMetricsDtoToJSON)(value['seoMetrics']),
     };
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@randock/nameshift-api-client",
-  "version": "0.0.447",
+  "version": "0.0.448",
   "description": "OpenAPI client for @randock/nameshift-api-client",
   "author": "OpenAPI-Generator",
   "repository": {

package/src/apis/AdminApi.ts

@@ -452,6 +452,10 @@ export interface AdminApiRemoveDomainLockRequest {
     lockId: string;
 }
 
+export interface AdminApiShowcaseDomainRequest {
+    domainId: string;
+}
+
 export interface AdminApiSimulateCommissionRequest {
     simulateCommissionInput: SimulateCommissionInput;
 }
@@ -468,6 +472,10 @@ export interface AdminApiSyncOwnedDomainFromRegistryRequest {
     id: string;
 }
 
+export interface AdminApiUnshowcaseDomainRequest {
+    domainId: string;
+}
+
 export interface AdminApiUpdateAccountChallengeRewardBalancePointsRequest {
     accountId: string;
     updateAccountChallengeRewardBalanceInput: UpdateAccountChallengeRewardBalanceInput;
@@ -3063,6 +3071,48 @@ export class AdminApi extends runtime.BaseAPI {
         await this.removeDomainLockRaw(requestParameters, initOverrides);
     }
 
+    /**
+     * Picks the domain for the public showcase on the website. Idempotent: showcasing an already showcased domain keeps its original position in the showcase.
+     * Showcase domain
+     */
+    async showcaseDomainRaw(requestParameters: AdminApiShowcaseDomainRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        if (requestParameters['domainId'] == null) {
+            throw new runtime.RequiredError(
+                'domainId',
+                'Required parameter "domainId" was null or undefined when calling showcaseDomain().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("bearer", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        const response = await this.request({
+            path: `/admin/domains/{domainId}/showcase`.replace(`{${"domainId"}}`, encodeURIComponent(String(requestParameters['domainId']))),
+            method: 'PUT',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * Picks the domain for the public showcase on the website. Idempotent: showcasing an already showcased domain keeps its original position in the showcase.
+     * Showcase domain
+     */
+    async showcaseDomain(requestParameters: AdminApiShowcaseDomainRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.showcaseDomainRaw(requestParameters, initOverrides);
+    }
+
     /**
      * Evaluates the commission percentage for a given scenario without persisting any changes.
      * Simulate commission percentage
@@ -3235,6 +3285,48 @@ export class AdminApi extends runtime.BaseAPI {
         await this.syncOwnedDomainFromRegistryRaw(requestParameters, initOverrides);
     }
 
+    /**
+     * Drops the domain from the public showcase on the website. Idempotent.
+     * Remove domain from the showcase
+     */
+    async unshowcaseDomainRaw(requestParameters: AdminApiUnshowcaseDomainRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        if (requestParameters['domainId'] == null) {
+            throw new runtime.RequiredError(
+                'domainId',
+                'Required parameter "domainId" was null or undefined when calling unshowcaseDomain().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("bearer", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        const response = await this.request({
+            path: `/admin/domains/{domainId}/showcase`.replace(`{${"domainId"}}`, encodeURIComponent(String(requestParameters['domainId']))),
+            method: 'DELETE',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * Drops the domain from the public showcase on the website. Idempotent.
+     * Remove domain from the showcase
+     */
+    async unshowcaseDomain(requestParameters: AdminApiUnshowcaseDomainRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.unshowcaseDomainRaw(requestParameters, initOverrides);
+    }
+
     /**
      * Sets the absolute challenge reward points balance for an account.
      * Update challenge reward balance

package/src/apis/MarketApi.ts

@@ -126,7 +126,7 @@ export class MarketApi extends runtime.BaseAPI {
     }
 
     /**
-     * Returns a showcase of listed domains: the public catalogue in its default ranking (domain authority).
+     * Returns the domains an admin picked for the showcase, most recently picked first. Sold and deleted domains are left out; an empty array means nothing is picked.
      * List showcase domains
      */
     async listShowcaseDomainsRaw(requestParameters: MarketApiListShowcaseDomainsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<PublicDomainDto>>> {
@@ -153,7 +153,7 @@ export class MarketApi extends runtime.BaseAPI {
     }
 
     /**
-     * Returns a showcase of listed domains: the public catalogue in its default ranking (domain authority).
+     * Returns the domains an admin picked for the showcase, most recently picked first. Sold and deleted domains are left out; an empty array means nothing is picked.
      * List showcase domains
      */
     async listShowcaseDomains(requestParameters: MarketApiListShowcaseDomainsRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<PublicDomainDto>> {

package/src/models/AdminDomainListItemDto.ts

@@ -243,6 +243,12 @@ export interface AdminDomainListItemDto {
      * @memberof AdminDomainListItemDto
      */
     lockedUntil: Date | null;
+    /**
+     * Whether an admin picked this domain for the public showcase on the website.
+     * @type {boolean}
+     * @memberof AdminDomainListItemDto
+     */
+    showcased: boolean;
     /**
      * Account that owns the domain.
      * @type {AccountDto}
@@ -305,6 +311,7 @@ export function instanceOfAdminDomainListItemDto(value: object): value is AdminD
     if (!('isDeleteable' in value) || value['isDeleteable'] === undefined) return false;
     if (!('isLocked' in value) || value['isLocked'] === undefined) return false;
     if (!('lockedUntil' in value) || value['lockedUntil'] === undefined) return false;
+    if (!('showcased' in value) || value['showcased'] === undefined) return false;
     if (!('account' in value) || value['account'] === undefined) return false;
     if (!('pointsToOurServerReason' in value) || value['pointsToOurServerReason'] === undefined) return false;
     return true;
@@ -349,6 +356,7 @@ export function AdminDomainListItemDtoFromJSONTyped(json: any, ignoreDiscriminat
         'isDeleteable': json['isDeleteable'],
         'isLocked': json['isLocked'],
         'lockedUntil': (json['lockedUntil'] == null ? null : new Date(json['lockedUntil'])),
+        'showcased': json['showcased'],
         'account': AccountDtoFromJSON(json['account']),
         'pointsToOurServerReason': json['pointsToOurServerReason'],
     };
@@ -394,6 +402,7 @@ export function AdminDomainListItemDtoToJSONTyped(value?: AdminDomainListItemDto
         'isDeleteable': value['isDeleteable'],
         'isLocked': value['isLocked'],
         'lockedUntil': (value['lockedUntil'] == null ? null : (value['lockedUntil'] as any).toISOString()),
+        'showcased': value['showcased'],
         'account': AccountDtoToJSON(value['account']),
         'pointsToOurServerReason': value['pointsToOurServerReason'],
     };

package/src/models/IntersectionDomainDtoWithAccountDtoWithAuctionInfoDto.ts

@@ -243,6 +243,12 @@ export interface IntersectionDomainDtoWithAccountDtoWithAuctionInfoDto {
      * @memberof IntersectionDomainDtoWithAccountDtoWithAuctionInfoDto
      */
     lockedUntil: Date | null;
+    /**
+     * Whether an admin picked this domain for the public showcase on the website.
+     * @type {boolean}
+     * @memberof IntersectionDomainDtoWithAccountDtoWithAuctionInfoDto
+     */
+    showcased: boolean;
     /**
      * Account that owns the domain.
      * @type {AccountDto}
@@ -290,6 +296,7 @@ export function instanceOfIntersectionDomainDtoWithAccountDtoWithAuctionInfoDto(
     if (!('isDeleteable' in value) || value['isDeleteable'] === undefined) return false;
     if (!('isLocked' in value) || value['isLocked'] === undefined) return false;
     if (!('lockedUntil' in value) || value['lockedUntil'] === undefined) return false;
+    if (!('showcased' in value) || value['showcased'] === undefined) return false;
     if (!('account' in value) || value['account'] === undefined) return false;
     if (!('hasAuction' in value) || value['hasAuction'] === undefined) return false;
     return true;
@@ -334,6 +341,7 @@ export function IntersectionDomainDtoWithAccountDtoWithAuctionInfoDtoFromJSONTyp
         'isDeleteable': json['isDeleteable'],
         'isLocked': json['isLocked'],
         'lockedUntil': (json['lockedUntil'] == null ? null : new Date(json['lockedUntil'])),
+        'showcased': json['showcased'],
         'account': AccountDtoFromJSON(json['account']),
         'hasAuction': json['hasAuction'],
     };
@@ -379,6 +387,7 @@ export function IntersectionDomainDtoWithAccountDtoWithAuctionInfoDtoToJSONTyped
         'isDeleteable': value['isDeleteable'],
         'isLocked': value['isLocked'],
         'lockedUntil': (value['lockedUntil'] == null ? null : (value['lockedUntil'] as any).toISOString()),
+        'showcased': value['showcased'],
         'account': AccountDtoToJSON(value['account']),
         'hasAuction': value['hasAuction'],
     };

package/src/models/IntersectionDomainDtoWithHijackerDtoWithAccountDto.ts

@@ -243,6 +243,12 @@ export interface IntersectionDomainDtoWithHijackerDtoWithAccountDto {
      * @memberof IntersectionDomainDtoWithHijackerDtoWithAccountDto
      */
     lockedUntil: Date | null;
+    /**
+     * Whether an admin picked this domain for the public showcase on the website.
+     * @type {boolean}
+     * @memberof IntersectionDomainDtoWithHijackerDtoWithAccountDto
+     */
+    showcased: boolean;
     /**
      * Account managing the domain on behalf of the owner, when a hijacker is assigned.
      * @type {AccountDto}
@@ -290,6 +296,7 @@ export function instanceOfIntersectionDomainDtoWithHijackerDtoWithAccountDto(val
     if (!('isDeleteable' in value) || value['isDeleteable'] === undefined) return false;
     if (!('isLocked' in value) || value['isLocked'] === undefined) return false;
     if (!('lockedUntil' in value) || value['lockedUntil'] === undefined) return false;
+    if (!('showcased' in value) || value['showcased'] === undefined) return false;
     if (!('hijacker' in value) || value['hijacker'] === undefined) return false;
     if (!('account' in value) || value['account'] === undefined) return false;
     return true;
@@ -334,6 +341,7 @@ export function IntersectionDomainDtoWithHijackerDtoWithAccountDtoFromJSONTyped(
         'isDeleteable': json['isDeleteable'],
         'isLocked': json['isLocked'],
         'lockedUntil': (json['lockedUntil'] == null ? null : new Date(json['lockedUntil'])),
+        'showcased': json['showcased'],
         'hijacker': AccountDtoFromJSON(json['hijacker']),
         'account': AccountDtoFromJSON(json['account']),
     };
@@ -379,6 +387,7 @@ export function IntersectionDomainDtoWithHijackerDtoWithAccountDtoToJSONTyped(va
         'isDeleteable': value['isDeleteable'],
         'isLocked': value['isLocked'],
         'lockedUntil': (value['lockedUntil'] == null ? null : (value['lockedUntil'] as any).toISOString()),
+        'showcased': value['showcased'],
         'hijacker': AccountDtoToJSON(value['hijacker']),
         'account': AccountDtoToJSON(value['account']),
     };

package/src/models/IntersectionDomainDtoWithSeoMetricsDto.ts

@@ -243,6 +243,12 @@ export interface IntersectionDomainDtoWithSeoMetricsDto {
      * @memberof IntersectionDomainDtoWithSeoMetricsDto
      */
     lockedUntil: Date | null;
+    /**
+     * Whether an admin picked this domain for the public showcase on the website.
+     * @type {boolean}
+     * @memberof IntersectionDomainDtoWithSeoMetricsDto
+     */
+    showcased: boolean;
     /**
      * SEO metrics for the domain from Moz, Majestic, and historical sources.
      * @type {SeoMetricsDto}
@@ -284,6 +290,7 @@ export function instanceOfIntersectionDomainDtoWithSeoMetricsDto(value: object):
     if (!('isDeleteable' in value) || value['isDeleteable'] === undefined) return false;
     if (!('isLocked' in value) || value['isLocked'] === undefined) return false;
     if (!('lockedUntil' in value) || value['lockedUntil'] === undefined) return false;
+    if (!('showcased' in value) || value['showcased'] === undefined) return false;
     if (!('seoMetrics' in value) || value['seoMetrics'] === undefined) return false;
     return true;
 }
@@ -327,6 +334,7 @@ export function IntersectionDomainDtoWithSeoMetricsDtoFromJSONTyped(json: any, i
         'isDeleteable': json['isDeleteable'],
         'isLocked': json['isLocked'],
         'lockedUntil': (json['lockedUntil'] == null ? null : new Date(json['lockedUntil'])),
+        'showcased': json['showcased'],
         'seoMetrics': SeoMetricsDtoFromJSON(json['seoMetrics']),
     };
 }
@@ -371,6 +379,7 @@ export function IntersectionDomainDtoWithSeoMetricsDtoToJSONTyped(value?: Inters
         'isDeleteable': value['isDeleteable'],
         'isLocked': value['isLocked'],
         'lockedUntil': (value['lockedUntil'] == null ? null : (value['lockedUntil'] as any).toISOString()),
+        'showcased': value['showcased'],
         'seoMetrics': SeoMetricsDtoToJSON(value['seoMetrics']),
     };
 }