@randock/nameshift-api-client 0.0.436 → 0.0.438

package/src/models/DomainExchangeRateDto.ts

@@ -2,7 +2,7 @@
 /* eslint-disable */
 /**
  * Nameshift
- * Nameshift API
+ * 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.
  *
  * The version of the OpenAPI document: 1.0
  * 
@@ -20,13 +20,13 @@ import { mapValues } from '../runtime';
  */
 export interface DomainExchangeRateDto {
     /**
-     * 
+     * ISO 4217 currency code for the exchange rate.
      * @type {string}
      * @memberof DomainExchangeRateDto
      */
     currencyCode: string;
     /**
-     * 
+     * Exchange rate from the base currency to this currency.
      * @type {number}
      * @memberof DomainExchangeRateDto
      */

package/src/models/DomainFiltersDto.ts

@@ -2,7 +2,7 @@
 /* eslint-disable */
 /**
  * Nameshift
- * Nameshift API
+ * 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.
  *
  * The version of the OpenAPI document: 1.0
  * 

package/src/models/DomainLeadPriceNegotiatorAiAgentConfigurationDto.ts

@@ -2,7 +2,7 @@
 /* eslint-disable */
 /**
  * Nameshift
- * Nameshift API
+ * 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.
  *
  * The version of the OpenAPI document: 1.0
  * 
@@ -28,19 +28,19 @@ import {
  */
 export interface DomainLeadPriceNegotiatorAiAgentConfigurationDto {
     /**
-     * 
+     * Whether the AI price negotiator agent is enabled for this domain.
      * @type {boolean}
      * @memberof DomainLeadPriceNegotiatorAiAgentConfigurationDto
      */
     enabled: boolean;
     /**
-     * 
+     * How aggressively the AI agent prioritizes closing the sale versus maximizing price.
      * @type {string}
      * @memberof DomainLeadPriceNegotiatorAiAgentConfigurationDto
      */
     salesImportance: DomainLeadPriceNegotiatorAiAgentConfigurationDtoSalesImportanceEnum;
     /**
-     * 
+     * Minimum acceptable offer enforced by the AI agent, or null to use domain defaults.
      * @type {MoneyDto}
      * @memberof DomainLeadPriceNegotiatorAiAgentConfigurationDto
      */

package/src/models/DomainLeadPriceNegotiatorAiAgentConfigurationInput.ts

@@ -2,7 +2,7 @@
 /* eslint-disable */
 /**
  * Nameshift
- * Nameshift API
+ * 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.
  *
  * The version of the OpenAPI document: 1.0
  * 
@@ -28,29 +28,29 @@ import {
  */
 export interface DomainLeadPriceNegotiatorAiAgentConfigurationInput {
     /**
-     * 
-     * @type {MoneyDto}
-     * @memberof DomainLeadPriceNegotiatorAiAgentConfigurationInput
-     */
-    minOffer?: MoneyDto | null;
-    /**
-     * 
+     * Whether the lead price negotiator AI agent is enabled
      * @type {boolean}
      * @memberof DomainLeadPriceNegotiatorAiAgentConfigurationInput
      */
     enabled?: boolean;
     /**
-     * 
+     * Whether the AI agent is enabled automatically for new domains
      * @type {boolean}
      * @memberof DomainLeadPriceNegotiatorAiAgentConfigurationInput
      */
     enabledForNewDomains?: boolean;
     /**
-     * 
+     * Sales importance level used by the AI agent
      * @type {string}
      * @memberof DomainLeadPriceNegotiatorAiAgentConfigurationInput
      */
     salesImportance?: DomainLeadPriceNegotiatorAiAgentConfigurationInputSalesImportanceEnum;
+    /**
+     * Minimum offer amount the AI negotiator may accept
+     * @type {MoneyDto}
+     * @memberof DomainLeadPriceNegotiatorAiAgentConfigurationInput
+     */
+    minOffer?: MoneyDto | null;
 }
 
 
@@ -82,10 +82,10 @@ export function DomainLeadPriceNegotiatorAiAgentConfigurationInputFromJSONTyped(
     }
     return {
         
-        'minOffer': json['minOffer'] == null ? undefined : MoneyDtoFromJSON(json['minOffer']),
         'enabled': json['enabled'] == null ? undefined : json['enabled'],
         'enabledForNewDomains': json['enabledForNewDomains'] == null ? undefined : json['enabledForNewDomains'],
         'salesImportance': json['salesImportance'] == null ? undefined : json['salesImportance'],
+        'minOffer': json['minOffer'] == null ? undefined : MoneyDtoFromJSON(json['minOffer']),
     };
 }
 
@@ -100,10 +100,10 @@ export function DomainLeadPriceNegotiatorAiAgentConfigurationInputToJSONTyped(va
 
     return {
         
-        'minOffer': MoneyDtoToJSON(value['minOffer']),
         'enabled': value['enabled'],
         'enabledForNewDomains': value['enabledForNewDomains'],
         'salesImportance': value['salesImportance'],
+        'minOffer': MoneyDtoToJSON(value['minOffer']),
     };
 }
 

package/src/models/DomainLockConfigurationDto.ts

@@ -2,7 +2,7 @@
 /* eslint-disable */
 /**
  * Nameshift
- * Nameshift API
+ * 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.
  *
  * The version of the OpenAPI document: 1.0
  * 
@@ -28,13 +28,13 @@ import {
  */
 export interface DomainLockConfigurationDto {
     /**
-     * 
+     * Whether the domain lock is currently enabled.
      * @type {boolean}
      * @memberof DomainLockConfigurationDto
      */
     enabled: boolean;
     /**
-     * 
+     * Duration for which the domain remains locked.
      * @type {LockDurationDto}
      * @memberof DomainLockConfigurationDto
      */

package/src/models/DomainLockDto.ts

@@ -2,7 +2,7 @@
 /* eslint-disable */
 /**
  * Nameshift
- * Nameshift API
+ * 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.
  *
  * The version of the OpenAPI document: 1.0
  * 

package/src/models/DomainPricesChangeDto.ts

@@ -2,7 +2,7 @@
 /* eslint-disable */
 /**
  * Nameshift
- * Nameshift API
+ * 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.
  *
  * The version of the OpenAPI document: 1.0
  * 
@@ -35,65 +35,65 @@ import {
  */
 export interface DomainPricesChangeDto {
     /**
-     * The uuid for this domain.
+     * Unique identifier of the domain.
      * @type {string}
      * @memberof DomainPricesChangeDto
      */
     id: string;
     /**
-     * The root domain name without TLD
+     * ASCII punycode domain name (e.g. example.com, xn--maana-pta.com).
      * @type {string}
      * @memberof DomainPricesChangeDto
      */
-    rootName: string;
+    name: string;
     /**
-     * The domain TLD
+     * Unicode display domain name (e.g. example.com, mañana.com).
      * @type {string}
      * @memberof DomainPricesChangeDto
      */
-    tld: string;
-    /**
-     * Categories of the domain (parent + subcategory)
-     * @type {Array<DomainCategoryItemDto>}
-     * @memberof DomainPricesChangeDto
-     */
-    categories: Array<DomainCategoryItemDto>;
+    displayName: string;
     /**
-     * The ASCII domain name (example.com, xn--maana-pta.com)
+     * Root domain label without the TLD.
      * @type {string}
      * @memberof DomainPricesChangeDto
      */
-    name: string;
+    rootName: string;
     /**
-     * The unicode domain name (example.com, mañana.com)
+     * Top-level domain suffix.
      * @type {string}
      * @memberof DomainPricesChangeDto
      */
-    displayName: string;
+    tld: string;
     /**
-     * The buy now price
+     * Buy-it-now price, or null when not publicly purchasable.
      * @type {MoneyDto}
      * @memberof DomainPricesChangeDto
      */
     buyNow: MoneyDto | null;
     /**
-     * The minimum offer price
+     * Minimum offer price, or null when not publicly purchasable.
      * @type {MoneyDto}
      * @memberof DomainPricesChangeDto
      */
     minOffer: MoneyDto | null;
     /**
-     * The updated date
+     * Timestamp when domain pricing was last updated.
      * @type {Date}
      * @memberof DomainPricesChangeDto
      */
     updatedAt: Date;
     /**
-     * Whether the domain is available for purchase
+     * Whether the domain is currently available for purchase.
      * @type {boolean}
      * @memberof DomainPricesChangeDto
      */
     available: boolean;
+    /**
+     * Category and subcategory classifications for the domain.
+     * @type {Array<DomainCategoryItemDto>}
+     * @memberof DomainPricesChangeDto
+     */
+    categories: Array<DomainCategoryItemDto>;
 }
 
 /**
@@ -101,15 +101,15 @@ export interface DomainPricesChangeDto {
  */
 export function instanceOfDomainPricesChangeDto(value: object): value is DomainPricesChangeDto {
     if (!('id' in value) || value['id'] === undefined) return false;
-    if (!('rootName' in value) || value['rootName'] === undefined) return false;
-    if (!('tld' in value) || value['tld'] === undefined) return false;
-    if (!('categories' in value) || value['categories'] === undefined) return false;
     if (!('name' in value) || value['name'] === undefined) return false;
     if (!('displayName' in value) || value['displayName'] === undefined) return false;
+    if (!('rootName' in value) || value['rootName'] === undefined) return false;
+    if (!('tld' in value) || value['tld'] === undefined) return false;
     if (!('buyNow' in value) || value['buyNow'] === undefined) return false;
     if (!('minOffer' in value) || value['minOffer'] === undefined) return false;
     if (!('updatedAt' in value) || value['updatedAt'] === undefined) return false;
     if (!('available' in value) || value['available'] === undefined) return false;
+    if (!('categories' in value) || value['categories'] === undefined) return false;
     return true;
 }
 
@@ -124,15 +124,15 @@ export function DomainPricesChangeDtoFromJSONTyped(json: any, ignoreDiscriminato
     return {
         
         'id': json['id'],
-        'rootName': json['rootName'],
-        'tld': json['tld'],
-        'categories': ((json['categories'] as Array<any>).map(DomainCategoryItemDtoFromJSON)),
         'name': json['name'],
         'displayName': json['displayName'],
+        'rootName': json['rootName'],
+        'tld': json['tld'],
         'buyNow': MoneyDtoFromJSON(json['buyNow']),
         'minOffer': MoneyDtoFromJSON(json['minOffer']),
         'updatedAt': (new Date(json['updatedAt'])),
         'available': json['available'],
+        'categories': ((json['categories'] as Array<any>).map(DomainCategoryItemDtoFromJSON)),
     };
 }
 
@@ -148,15 +148,15 @@ export function DomainPricesChangeDtoToJSONTyped(value?: DomainPricesChangeDto |
     return {
         
         'id': value['id'],
-        'rootName': value['rootName'],
-        'tld': value['tld'],
-        'categories': ((value['categories'] as Array<any>).map(DomainCategoryItemDtoToJSON)),
         'name': value['name'],
         'displayName': value['displayName'],
+        'rootName': value['rootName'],
+        'tld': value['tld'],
         'buyNow': MoneyDtoToJSON(value['buyNow']),
         'minOffer': MoneyDtoToJSON(value['minOffer']),
         'updatedAt': ((value['updatedAt']).toISOString()),
         'available': value['available'],
+        'categories': ((value['categories'] as Array<any>).map(DomainCategoryItemDtoToJSON)),
     };
 }
 

package/src/models/DomainSalesInformationDto.ts

@@ -2,7 +2,7 @@
 /* eslint-disable */
 /**
  * Nameshift
- * Nameshift API
+ * 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.
  *
  * The version of the OpenAPI document: 1.0
  * 
@@ -63,115 +63,115 @@ import {
  */
 export interface DomainSalesInformationDto {
     /**
-     * The domain id
-     * @type {object}
+     * Unique identifier of the domain.
+     * @type {string}
      * @memberof DomainSalesInformationDto
      */
-    domainId: object;
+    domainId: string;
     /**
-     * The domain name (example.com, xn--maana-pta.com)
+     * ASCII punycode domain name (e.g. example.com, xn--maana-pta.com).
      * @type {string}
      * @memberof DomainSalesInformationDto
      */
     domain: string;
     /**
-     * The domain display name (example.com, mañana.com)
+     * Unicode display domain name (e.g. example.com, mañana.com).
      * @type {string}
      * @memberof DomainSalesInformationDto
      */
     domainDisplayName: string;
     /**
-     * Buy now price or null if buy now is not enabled
+     * Buy-it-now price, or null if buy now is not enabled.
      * @type {MoneyDto}
      * @memberof DomainSalesInformationDto
      */
     buyNowPrice: MoneyDto | null;
     /**
-     * Lease to own configuration or null if it is not enabled
+     * Lease-to-own configuration, or null if not enabled.
      * @type {DomainSalesInformationLeaseToOwnConfigurationDto}
      * @memberof DomainSalesInformationDto
      */
     leaseToOwn: DomainSalesInformationLeaseToOwnConfigurationDto | null;
     /**
-     * Rent configuration or null if it is not enabled
+     * Rent configuration for the domain.
      * @type {DomainSalesInformationRentConfigurationDto}
      * @memberof DomainSalesInformationDto
      */
     rent: DomainSalesInformationRentConfigurationDto;
     /**
-     * min offer price or null if offers are not enabled
+     * Minimum offer price, or null if offers are disabled.
      * @type {MoneyDto}
      * @memberof DomainSalesInformationDto
      */
     minOfferPrice: MoneyDto | null;
     /**
-     * The domain seller information
+     * Public seller profile information.
      * @type {DomainSellerDto}
      * @memberof DomainSalesInformationDto
      */
     seller: DomainSellerDto | null;
     /**
-     * The domain "sold" status
+     * Whether the domain has already been sold.
      * @type {boolean}
      * @memberof DomainSalesInformationDto
      */
     sold: boolean;
     /**
-     * The domain "isPurchaseable" status
+     * Whether the domain can currently be purchased.
      * @type {boolean}
      * @memberof DomainSalesInformationDto
      */
     isPurchaseable: boolean;
     /**
-     * SEO metrics
+     * SEO metrics shown on the landing page, when enabled.
      * @type {SeoMetricsDto}
      * @memberof DomainSalesInformationDto
      */
     seo: SeoMetricsDto | null;
     /**
-     * Stats enabled
+     * Whether visitor statistics are enabled on the landing page.
      * @type {boolean}
      * @memberof DomainSalesInformationDto
      */
     statsEnabled: boolean;
     /**
-     * Related domains enabled
+     * Whether related domains are shown on the landing page.
      * @type {boolean}
      * @memberof DomainSalesInformationDto
      */
     relatedDomainsEnabled: boolean;
     /**
-     * Trustpilot enabled
+     * Whether the Trustpilot widget is enabled on the landing page.
      * @type {boolean}
      * @memberof DomainSalesInformationDto
      */
     trustpilotEnabled: boolean;
     /**
-     * SEO enabled
+     * Whether SEO metrics are enabled on the landing page.
      * @type {boolean}
      * @memberof DomainSalesInformationDto
      */
     seoEnabled: boolean;
     /**
-     * The domain "isAuctionable" status
+     * Whether the domain currently has an active auction.
      * @type {boolean}
      * @memberof DomainSalesInformationDto
      */
     hasActiveAuction: boolean;
     /**
-     * The domain "auctionId"
+     * Active auction identifier, when an auction is running.
      * @type {string}
      * @memberof DomainSalesInformationDto
      */
     auctionId: string | null;
     /**
-     * The domain "locked" status
+     * Whether the domain is locked from other sales.
      * @type {boolean}
      * @memberof DomainSalesInformationDto
      */
     locked: boolean;
     /**
-     * Lead buyer settings
+     * Lead buyer information requirements for this domain.
      * @type {LeadBuyerConfigDto}
      * @memberof DomainSalesInformationDto
      */

package/src/models/DomainSalesInformationLeaseToOwnConfigurationDto.ts

@@ -2,7 +2,7 @@
 /* eslint-disable */
 /**
  * Nameshift
- * Nameshift API
+ * 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.
  *
  * The version of the OpenAPI document: 1.0
  * 
@@ -28,31 +28,31 @@ import {
  */
 export interface DomainSalesInformationLeaseToOwnConfigurationDto {
     /**
-     * Enabled status of lease to own
+     * Whether lease-to-own is enabled for the domain.
      * @type {boolean}
      * @memberof DomainSalesInformationLeaseToOwnConfigurationDto
      */
     enabled: boolean;
     /**
-     * Minimum months option
+     * Minimum number of installments the buyer may choose.
      * @type {number}
      * @memberof DomainSalesInformationLeaseToOwnConfigurationDto
      */
     minMonths: number;
     /**
-     * Maximum months option
+     * Maximum number of installments the buyer may choose.
      * @type {number}
      * @memberof DomainSalesInformationLeaseToOwnConfigurationDto
      */
     maxMonths: number;
     /**
-     * Total lease to own total subscription price
+     * Total lease-to-own price for the selected installment plan.
      * @type {MoneyDto}
      * @memberof DomainSalesInformationLeaseToOwnConfigurationDto
      */
     basePrice: MoneyDto;
     /**
-     * Total lease to own recurring price
+     * Recurring monthly lease-to-own payment amount.
      * @type {MoneyDto}
      * @memberof DomainSalesInformationLeaseToOwnConfigurationDto
      */

package/src/models/DomainSalesInformationRentConfigurationDto.ts

@@ -2,7 +2,7 @@
 /* eslint-disable */
 /**
  * Nameshift
- * Nameshift API
+ * 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.
  *
  * The version of the OpenAPI document: 1.0
  * 
@@ -28,13 +28,13 @@ import {
  */
 export interface DomainSalesInformationRentConfigurationDto {
     /**
-     * Enabled status of rent
+     * Whether monthly rent is enabled for the domain.
      * @type {boolean}
      * @memberof DomainSalesInformationRentConfigurationDto
      */
     enabled: boolean;
     /**
-     * Rent price
+     * Calculated monthly rent price when rent is enabled.
      * @type {MoneyDto}
      * @memberof DomainSalesInformationRentConfigurationDto
      */