@randock/nameshift-api-client 0.0.469 → 0.0.471

package/src/models/CustomerSuccessDomainListItemDto.ts

@@ -0,0 +1,426 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Nameshift
+ * 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
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+import type { CustomerSuccessDomainAuctionDto } from './CustomerSuccessDomainAuctionDto';
+import {
+    CustomerSuccessDomainAuctionDtoFromJSON,
+    CustomerSuccessDomainAuctionDtoFromJSONTyped,
+    CustomerSuccessDomainAuctionDtoToJSON,
+    CustomerSuccessDomainAuctionDtoToJSONTyped,
+} from './CustomerSuccessDomainAuctionDto';
+import type { MoneyDto } from './MoneyDto';
+import {
+    MoneyDtoFromJSON,
+    MoneyDtoFromJSONTyped,
+    MoneyDtoToJSON,
+    MoneyDtoToJSONTyped,
+} from './MoneyDto';
+import type { RentConfigurationDto } from './RentConfigurationDto';
+import {
+    RentConfigurationDtoFromJSON,
+    RentConfigurationDtoFromJSONTyped,
+    RentConfigurationDtoToJSON,
+    RentConfigurationDtoToJSONTyped,
+} from './RentConfigurationDto';
+import type { LeaseToOwnConfigurationDto } from './LeaseToOwnConfigurationDto';
+import {
+    LeaseToOwnConfigurationDtoFromJSON,
+    LeaseToOwnConfigurationDtoFromJSONTyped,
+    LeaseToOwnConfigurationDtoToJSON,
+    LeaseToOwnConfigurationDtoToJSONTyped,
+} from './LeaseToOwnConfigurationDto';
+import type { LandingPageSettingsDto } from './LandingPageSettingsDto';
+import {
+    LandingPageSettingsDtoFromJSON,
+    LandingPageSettingsDtoFromJSONTyped,
+    LandingPageSettingsDtoToJSON,
+    LandingPageSettingsDtoToJSONTyped,
+} from './LandingPageSettingsDto';
+import type { DomainLeadPriceNegotiatorAiAgentConfigurationDto } from './DomainLeadPriceNegotiatorAiAgentConfigurationDto';
+import {
+    DomainLeadPriceNegotiatorAiAgentConfigurationDtoFromJSON,
+    DomainLeadPriceNegotiatorAiAgentConfigurationDtoFromJSONTyped,
+    DomainLeadPriceNegotiatorAiAgentConfigurationDtoToJSON,
+    DomainLeadPriceNegotiatorAiAgentConfigurationDtoToJSONTyped,
+} from './DomainLeadPriceNegotiatorAiAgentConfigurationDto';
+
+/**
+ * 
+ * @export
+ * @interface CustomerSuccessDomainListItemDto
+ */
+export interface CustomerSuccessDomainListItemDto {
+    /**
+     * Unique identifier of the domain.
+     * @type {string}
+     * @memberof CustomerSuccessDomainListItemDto
+     */
+    id: string;
+    /**
+     * Account ID of the domain owner.
+     * @type {string}
+     * @memberof CustomerSuccessDomainListItemDto
+     */
+    accountId: string;
+    /**
+     * Account ID of the hijacker managing the domain on behalf of the owner, if any.
+     * @type {string}
+     * @memberof CustomerSuccessDomainListItemDto
+     */
+    hijackerId: string | null;
+    /**
+     * Top-level domain suffix (e.g. com, nl).
+     * @type {string}
+     * @memberof CustomerSuccessDomainListItemDto
+     */
+    tld: string;
+    /**
+     * Whether the domain ownership is verified by the owner (via NS3 or TXT record).
+     * @type {boolean}
+     * @memberof CustomerSuccessDomainListItemDto
+     */
+    verified: boolean;
+    /**
+     * Whether the required nameservers (NS1, NS2) are configured.
+     * @type {boolean}
+     * @memberof CustomerSuccessDomainListItemDto
+     */
+    nameservers: boolean;
+    /**
+     * Timestamp of the last nameserver verification check.
+     * @type {Date}
+     * @memberof CustomerSuccessDomainListItemDto
+     */
+    nameserversUpdatedAt: Date | null;
+    /**
+     * Whether the domain currently points to the platform server.
+     * @type {boolean}
+     * @memberof CustomerSuccessDomainListItemDto
+     */
+    pointsToOurServer: boolean | null;
+    /**
+     * Timestamp of the last check whether the domain points to the platform server.
+     * @type {Date}
+     * @memberof CustomerSuccessDomainListItemDto
+     */
+    pointsToOurServerUpdatedAt: Date | null;
+    /**
+     * Reason explaining the domain pointing status, when the check has been performed.
+     * @type {string}
+     * @memberof CustomerSuccessDomainListItemDto
+     */
+    pointsToOurServerReason: CustomerSuccessDomainListItemDtoPointsToOurServerReasonEnum | null;
+    /**
+     * ASCII punycode domain name (e.g. example.com, xn--maana-pta.com).
+     * @type {string}
+     * @memberof CustomerSuccessDomainListItemDto
+     */
+    name: string;
+    /**
+     * Unicode display domain name (e.g. example.com, mañana.com).
+     * @type {string}
+     * @memberof CustomerSuccessDomainListItemDto
+     */
+    displayName: string;
+    /**
+     * ISO 4217 currency code used for domain pricing.
+     * @type {string}
+     * @memberof CustomerSuccessDomainListItemDto
+     */
+    currencyCode: string;
+    /**
+     * Buy-it-now (BIN) price for immediate purchase.
+     * @type {MoneyDto}
+     * @memberof CustomerSuccessDomainListItemDto
+     */
+    buyNow: MoneyDto;
+    /**
+     * Lease-to-own payment plan configuration.
+     * @type {LeaseToOwnConfigurationDto}
+     * @memberof CustomerSuccessDomainListItemDto
+     */
+    leaseToOwn: LeaseToOwnConfigurationDto;
+    /**
+     * Monthly rent subscription configuration.
+     * @type {RentConfigurationDto}
+     * @memberof CustomerSuccessDomainListItemDto
+     */
+    rent: RentConfigurationDto;
+    /**
+     * Public landing page display and lead capture settings.
+     * @type {LandingPageSettingsDto}
+     * @memberof CustomerSuccessDomainListItemDto
+     */
+    landingPageSettings: LandingPageSettingsDto;
+    /**
+     * Minimum offer amount buyers may submit.
+     * @type {MoneyDto}
+     * @memberof CustomerSuccessDomainListItemDto
+     */
+    minOffer: MoneyDto;
+    /**
+     * Timestamp when the domain was created in the platform.
+     * @type {Date}
+     * @memberof CustomerSuccessDomainListItemDto
+     */
+    createdAt: Date;
+    /**
+     * Timestamp when the domain was deleted, if applicable.
+     * @type {Date}
+     * @memberof CustomerSuccessDomainListItemDto
+     */
+    deletedAt: Date | null;
+    /**
+     * Whether the domain has been sold.
+     * @type {boolean}
+     * @memberof CustomerSuccessDomainListItemDto
+     */
+    sold: boolean;
+    /**
+     * Total pageviews tracked for this domain, or zero if none are tracked.
+     * @type {number}
+     * @memberof CustomerSuccessDomainListItemDto
+     */
+    pageviews: number;
+    /**
+     * Whether third-party sales data sharing is enabled for this domain.
+     * @type {boolean}
+     * @memberof CustomerSuccessDomainListItemDto
+     */
+    allowThirdPartySalesDataSharing: boolean | null;
+    /**
+     * Per-domain AI price negotiator agent configuration.
+     * @type {DomainLeadPriceNegotiatorAiAgentConfigurationDto}
+     * @memberof CustomerSuccessDomainListItemDto
+     */
+    leadPriceNegotiator: DomainLeadPriceNegotiatorAiAgentConfigurationDto | null;
+    /**
+     * Active or most recent auction details, when present.
+     * @type {CustomerSuccessDomainAuctionDto}
+     * @memberof CustomerSuccessDomainListItemDto
+     */
+    auction: CustomerSuccessDomainAuctionDto | null;
+    /**
+     * Fee charged to the seller for running a paid auction.
+     * @type {MoneyDto}
+     * @memberof CustomerSuccessDomainListItemDto
+     */
+    paidAuctionPrice: MoneyDto;
+    /**
+     * Whether the domain currently has an accepted lead.
+     * @type {boolean}
+     * @memberof CustomerSuccessDomainListItemDto
+     */
+    hasAcceptedLead: boolean;
+    /**
+     * Whether a new auction can be created for this domain.
+     * @type {boolean}
+     * @memberof CustomerSuccessDomainListItemDto
+     */
+    canCreateAuction: boolean;
+    /**
+     * Whether the domain can be deleted by the seller.
+     * @type {boolean}
+     * @memberof CustomerSuccessDomainListItemDto
+     */
+    isDeleteable: boolean;
+    /**
+     * Whether the domain is currently locked from other sales.
+     * @type {boolean}
+     * @memberof CustomerSuccessDomainListItemDto
+     */
+    isLocked: boolean;
+    /**
+     * End date of the current continuous lock period, or null if not locked.
+     * @type {Date}
+     * @memberof CustomerSuccessDomainListItemDto
+     */
+    lockedUntil: Date | null;
+    /**
+     * Whether an admin picked this domain for the public showcase on the website.
+     * @type {boolean}
+     * @memberof CustomerSuccessDomainListItemDto
+     */
+    showcased: boolean;
+    /**
+     * Marketplace this domain resolves to on our nameservers, overriding the account default. Null means the account default applies; "nameshift" means the domain opts out of it and stays on our own landing page.
+     * @type {string}
+     * @memberof CustomerSuccessDomainListItemDto
+     */
+    marketplace: CustomerSuccessDomainListItemDtoMarketplaceEnum | null;
+}
+
+
+/**
+ * @export
+ */
+export const CustomerSuccessDomainListItemDtoPointsToOurServerReasonEnum = {
+    VALID_CNAME: 'valid_cname',
+    VALID_A_RECORDS: 'valid_a_records',
+    NO_A_RECORDS: 'no_a_records',
+    INVALID_A_RECORDS: 'invalid_a_records',
+    ROUTED_TO_MARKETPLACE: 'routed_to_marketplace',
+    NX_DOMAIN: 'nx_domain',
+    DNS_LOOKUP_ERROR: 'dns_lookup_error'
+} as const;
+export type CustomerSuccessDomainListItemDtoPointsToOurServerReasonEnum = typeof CustomerSuccessDomainListItemDtoPointsToOurServerReasonEnum[keyof typeof CustomerSuccessDomainListItemDtoPointsToOurServerReasonEnum];
+
+/**
+ * @export
+ */
+export const CustomerSuccessDomainListItemDtoMarketplaceEnum = {
+    NAMESHIFT: 'nameshift',
+    SEDO: 'sedo',
+    AFTERNIC: 'afternic',
+    ATOM: 'atom',
+    SPACESHIP: 'spaceship',
+    NAMECLUB: 'nameclub'
+} as const;
+export type CustomerSuccessDomainListItemDtoMarketplaceEnum = typeof CustomerSuccessDomainListItemDtoMarketplaceEnum[keyof typeof CustomerSuccessDomainListItemDtoMarketplaceEnum];
+
+
+/**
+ * Check if a given object implements the CustomerSuccessDomainListItemDto interface.
+ */
+export function instanceOfCustomerSuccessDomainListItemDto(value: object): value is CustomerSuccessDomainListItemDto {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('accountId' in value) || value['accountId'] === undefined) return false;
+    if (!('hijackerId' in value) || value['hijackerId'] === undefined) return false;
+    if (!('tld' in value) || value['tld'] === undefined) return false;
+    if (!('verified' in value) || value['verified'] === undefined) return false;
+    if (!('nameservers' in value) || value['nameservers'] === undefined) return false;
+    if (!('nameserversUpdatedAt' in value) || value['nameserversUpdatedAt'] === undefined) return false;
+    if (!('pointsToOurServer' in value) || value['pointsToOurServer'] === undefined) return false;
+    if (!('pointsToOurServerUpdatedAt' in value) || value['pointsToOurServerUpdatedAt'] === undefined) return false;
+    if (!('pointsToOurServerReason' in value) || value['pointsToOurServerReason'] === undefined) return false;
+    if (!('name' in value) || value['name'] === undefined) return false;
+    if (!('displayName' in value) || value['displayName'] === undefined) return false;
+    if (!('currencyCode' in value) || value['currencyCode'] === undefined) return false;
+    if (!('buyNow' in value) || value['buyNow'] === undefined) return false;
+    if (!('leaseToOwn' in value) || value['leaseToOwn'] === undefined) return false;
+    if (!('rent' in value) || value['rent'] === undefined) return false;
+    if (!('landingPageSettings' in value) || value['landingPageSettings'] === undefined) return false;
+    if (!('minOffer' in value) || value['minOffer'] === undefined) return false;
+    if (!('createdAt' in value) || value['createdAt'] === undefined) return false;
+    if (!('deletedAt' in value) || value['deletedAt'] === undefined) return false;
+    if (!('sold' in value) || value['sold'] === undefined) return false;
+    if (!('pageviews' in value) || value['pageviews'] === undefined) return false;
+    if (!('allowThirdPartySalesDataSharing' in value) || value['allowThirdPartySalesDataSharing'] === undefined) return false;
+    if (!('leadPriceNegotiator' in value) || value['leadPriceNegotiator'] === undefined) return false;
+    if (!('auction' in value) || value['auction'] === undefined) return false;
+    if (!('paidAuctionPrice' in value) || value['paidAuctionPrice'] === undefined) return false;
+    if (!('hasAcceptedLead' in value) || value['hasAcceptedLead'] === undefined) return false;
+    if (!('canCreateAuction' in value) || value['canCreateAuction'] === undefined) return false;
+    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 (!('marketplace' in value) || value['marketplace'] === undefined) return false;
+    return true;
+}
+
+export function CustomerSuccessDomainListItemDtoFromJSON(json: any): CustomerSuccessDomainListItemDto {
+    return CustomerSuccessDomainListItemDtoFromJSONTyped(json, false);
+}
+
+export function CustomerSuccessDomainListItemDtoFromJSONTyped(json: any, ignoreDiscriminator: boolean): CustomerSuccessDomainListItemDto {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'accountId': json['accountId'],
+        'hijackerId': json['hijackerId'],
+        'tld': json['tld'],
+        'verified': json['verified'],
+        'nameservers': json['nameservers'],
+        'nameserversUpdatedAt': (json['nameserversUpdatedAt'] == null ? null : new Date(json['nameserversUpdatedAt'])),
+        'pointsToOurServer': json['pointsToOurServer'],
+        'pointsToOurServerUpdatedAt': (json['pointsToOurServerUpdatedAt'] == null ? null : new Date(json['pointsToOurServerUpdatedAt'])),
+        'pointsToOurServerReason': json['pointsToOurServerReason'],
+        'name': json['name'],
+        'displayName': json['displayName'],
+        'currencyCode': json['currencyCode'],
+        'buyNow': MoneyDtoFromJSON(json['buyNow']),
+        'leaseToOwn': LeaseToOwnConfigurationDtoFromJSON(json['leaseToOwn']),
+        'rent': RentConfigurationDtoFromJSON(json['rent']),
+        'landingPageSettings': LandingPageSettingsDtoFromJSON(json['landingPageSettings']),
+        'minOffer': MoneyDtoFromJSON(json['minOffer']),
+        'createdAt': (new Date(json['createdAt'])),
+        'deletedAt': (json['deletedAt'] == null ? null : new Date(json['deletedAt'])),
+        'sold': json['sold'],
+        'pageviews': json['pageviews'],
+        'allowThirdPartySalesDataSharing': json['allowThirdPartySalesDataSharing'],
+        'leadPriceNegotiator': DomainLeadPriceNegotiatorAiAgentConfigurationDtoFromJSON(json['leadPriceNegotiator']),
+        'auction': CustomerSuccessDomainAuctionDtoFromJSON(json['auction']),
+        'paidAuctionPrice': MoneyDtoFromJSON(json['paidAuctionPrice']),
+        'hasAcceptedLead': json['hasAcceptedLead'],
+        'canCreateAuction': json['canCreateAuction'],
+        'isDeleteable': json['isDeleteable'],
+        'isLocked': json['isLocked'],
+        'lockedUntil': (json['lockedUntil'] == null ? null : new Date(json['lockedUntil'])),
+        'showcased': json['showcased'],
+        'marketplace': json['marketplace'],
+    };
+}
+
+export function CustomerSuccessDomainListItemDtoToJSON(json: any): CustomerSuccessDomainListItemDto {
+    return CustomerSuccessDomainListItemDtoToJSONTyped(json, false);
+}
+
+export function CustomerSuccessDomainListItemDtoToJSONTyped(value?: CustomerSuccessDomainListItemDto | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'accountId': value['accountId'],
+        'hijackerId': value['hijackerId'],
+        'tld': value['tld'],
+        'verified': value['verified'],
+        'nameservers': value['nameservers'],
+        'nameserversUpdatedAt': (value['nameserversUpdatedAt'] == null ? null : (value['nameserversUpdatedAt'] as any).toISOString()),
+        'pointsToOurServer': value['pointsToOurServer'],
+        'pointsToOurServerUpdatedAt': (value['pointsToOurServerUpdatedAt'] == null ? null : (value['pointsToOurServerUpdatedAt'] as any).toISOString()),
+        'pointsToOurServerReason': value['pointsToOurServerReason'],
+        'name': value['name'],
+        'displayName': value['displayName'],
+        'currencyCode': value['currencyCode'],
+        'buyNow': MoneyDtoToJSON(value['buyNow']),
+        'leaseToOwn': LeaseToOwnConfigurationDtoToJSON(value['leaseToOwn']),
+        'rent': RentConfigurationDtoToJSON(value['rent']),
+        'landingPageSettings': LandingPageSettingsDtoToJSON(value['landingPageSettings']),
+        'minOffer': MoneyDtoToJSON(value['minOffer']),
+        'createdAt': ((value['createdAt']).toISOString()),
+        'deletedAt': (value['deletedAt'] == null ? null : (value['deletedAt'] as any).toISOString()),
+        'sold': value['sold'],
+        'pageviews': value['pageviews'],
+        'allowThirdPartySalesDataSharing': value['allowThirdPartySalesDataSharing'],
+        'leadPriceNegotiator': DomainLeadPriceNegotiatorAiAgentConfigurationDtoToJSON(value['leadPriceNegotiator']),
+        'auction': CustomerSuccessDomainAuctionDtoToJSON(value['auction']),
+        'paidAuctionPrice': MoneyDtoToJSON(value['paidAuctionPrice']),
+        'hasAcceptedLead': value['hasAcceptedLead'],
+        'canCreateAuction': value['canCreateAuction'],
+        'isDeleteable': value['isDeleteable'],
+        'isLocked': value['isLocked'],
+        'lockedUntil': (value['lockedUntil'] == null ? null : (value['lockedUntil'] as any).toISOString()),
+        'showcased': value['showcased'],
+        'marketplace': value['marketplace'],
+    };
+}
+