@randock/nameshift-api-client 0.0.538 → 0.0.540

package/src/models/AdminBrokeredLeadDto.ts

@@ -0,0 +1,404 @@
+/* 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 { BrokeredLeadCommissionDto } from './BrokeredLeadCommissionDto';
+import {
+    BrokeredLeadCommissionDtoFromJSON,
+    BrokeredLeadCommissionDtoFromJSONTyped,
+    BrokeredLeadCommissionDtoToJSON,
+    BrokeredLeadCommissionDtoToJSONTyped,
+} from './BrokeredLeadCommissionDto';
+import type { MoneyDto } from './MoneyDto';
+import {
+    MoneyDtoFromJSON,
+    MoneyDtoFromJSONTyped,
+    MoneyDtoToJSON,
+    MoneyDtoToJSONTyped,
+} from './MoneyDto';
+import type { MoneyDecimalDto } from './MoneyDecimalDto';
+import {
+    MoneyDecimalDtoFromJSON,
+    MoneyDecimalDtoFromJSONTyped,
+    MoneyDecimalDtoToJSON,
+    MoneyDecimalDtoToJSONTyped,
+} from './MoneyDecimalDto';
+import type { BrokeredLeadBuyerContactDto } from './BrokeredLeadBuyerContactDto';
+import {
+    BrokeredLeadBuyerContactDtoFromJSON,
+    BrokeredLeadBuyerContactDtoFromJSONTyped,
+    BrokeredLeadBuyerContactDtoToJSON,
+    BrokeredLeadBuyerContactDtoToJSONTyped,
+} from './BrokeredLeadBuyerContactDto';
+
+/**
+ * 
+ * @export
+ * @interface AdminBrokeredLeadDto
+ */
+export interface AdminBrokeredLeadDto {
+    /**
+     * 
+     * @type {string}
+     * @memberof AdminBrokeredLeadDto
+     */
+    id: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof AdminBrokeredLeadDto
+     */
+    domainName: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof AdminBrokeredLeadDto
+     */
+    status: AdminBrokeredLeadDtoStatusEnum;
+    /**
+     * 
+     * @type {MoneyDto}
+     * @memberof AdminBrokeredLeadDto
+     */
+    askingPrice: MoneyDto;
+    /**
+     * 
+     * @type {BrokeredLeadCommissionDto}
+     * @memberof AdminBrokeredLeadDto
+     */
+    commission: BrokeredLeadCommissionDto;
+    /**
+     * Nameshift platform fee charged to the broker, as a percentage of the sale price.
+     * @type {number}
+     * @memberof AdminBrokeredLeadDto
+     */
+    nameshiftCommissionPercentage: number;
+    /**
+     * 
+     * @type {MoneyDecimalDto}
+     * @memberof AdminBrokeredLeadDto
+     */
+    nameshiftFee: MoneyDecimalDto;
+    /**
+     * What the broker is paid: the commission less the fee.
+     * @type {MoneyDecimalDto}
+     * @memberof AdminBrokeredLeadDto
+     */
+    netPayout: MoneyDecimalDto;
+    /**
+     * 
+     * @type {BrokeredLeadBuyerContactDto}
+     * @memberof AdminBrokeredLeadDto
+     */
+    buyer: BrokeredLeadBuyerContactDto;
+    /**
+     * 
+     * @type {string}
+     * @memberof AdminBrokeredLeadDto
+     */
+    sellerEmail: string | null;
+    /**
+     * Whether the deal waits in a seller account: the one that verified the domain, or the one that took up the link.
+     * @type {boolean}
+     * @memberof AdminBrokeredLeadDto
+     */
+    sellerLinked: boolean;
+    /**
+     * The link for a seller who has not taken up the deal yet, while it is valid: a new seller signs up through it, one with an account takes it up.
+     * @type {string}
+     * @memberof AdminBrokeredLeadDto
+     */
+    sellerSignupUrl: string | null;
+    /**
+     * 
+     * @type {Date}
+     * @memberof AdminBrokeredLeadDto
+     */
+    sellerSignupUrlExpiresAt: Date | null;
+    /**
+     * Where a seller with an account reviews the deal.
+     * @type {string}
+     * @memberof AdminBrokeredLeadDto
+     */
+    sellerReviewUrl: string | null;
+    /**
+     * Where the buyer pays, once the deal is ready for payment.
+     * @type {string}
+     * @memberof AdminBrokeredLeadDto
+     */
+    paymentUrl: string | null;
+    /**
+     * 
+     * @type {Date}
+     * @memberof AdminBrokeredLeadDto
+     */
+    sellerNotifiedAt: Date | null;
+    /**
+     * When the seller can be emailed again.
+     * @type {Date}
+     * @memberof AdminBrokeredLeadDto
+     */
+    nextSellerNotificationAt: Date | null;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof AdminBrokeredLeadDto
+     */
+    canNotifySeller: boolean;
+    /**
+     * 
+     * @type {Date}
+     * @memberof AdminBrokeredLeadDto
+     */
+    buyerNotifiedAt: Date | null;
+    /**
+     * When the buyer can be emailed again.
+     * @type {Date}
+     * @memberof AdminBrokeredLeadDto
+     */
+    nextBuyerNotificationAt: Date | null;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof AdminBrokeredLeadDto
+     */
+    canNotifyBuyer: boolean;
+    /**
+     * 
+     * @type {string}
+     * @memberof AdminBrokeredLeadDto
+     */
+    declineReason: string | null;
+    /**
+     * 
+     * @type {Date}
+     * @memberof AdminBrokeredLeadDto
+     */
+    createdAt: Date;
+    /**
+     * 
+     * @type {Date}
+     * @memberof AdminBrokeredLeadDto
+     */
+    updatedAt: Date;
+    /**
+     * 
+     * @type {string}
+     * @memberof AdminBrokeredLeadDto
+     */
+    internalStatus: AdminBrokeredLeadDtoInternalStatusEnum;
+    /**
+     * 
+     * @type {string}
+     * @memberof AdminBrokeredLeadDto
+     */
+    brokerAccountId: string;
+    /**
+     * Null once the broker deleted their account.
+     * @type {string}
+     * @memberof AdminBrokeredLeadDto
+     */
+    brokerName: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof AdminBrokeredLeadDto
+     */
+    sellerAccountId: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof AdminBrokeredLeadDto
+     */
+    sellerName: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof AdminBrokeredLeadDto
+     */
+    leadId: string | null;
+    /**
+     * Where the platform fee percentage comes from.
+     * @type {object}
+     * @memberof AdminBrokeredLeadDto
+     */
+    nameshiftCommissionReason: object | null;
+    /**
+     * Whether the platform fee can still be overridden.
+     * @type {boolean}
+     * @memberof AdminBrokeredLeadDto
+     */
+    nameshiftCommissionOverridable: boolean;
+}
+
+
+/**
+ * @export
+ */
+export const AdminBrokeredLeadDtoStatusEnum = {
+    PENDING_SELLER: 'pending_seller',
+    PENDING_SELLER_VERIFICATION: 'pending_seller_verification',
+    AWAITING_PAYMENT: 'awaiting_payment',
+    PAYMENT_EXPIRED: 'payment_expired',
+    TRANSFER_IN_PROGRESS: 'transfer_in_progress',
+    COMPLETED: 'completed',
+    CLOSED: 'closed',
+    DECLINED: 'declined',
+    CANCELLED: 'cancelled'
+} as const;
+export type AdminBrokeredLeadDtoStatusEnum = typeof AdminBrokeredLeadDtoStatusEnum[keyof typeof AdminBrokeredLeadDtoStatusEnum];
+
+/**
+ * @export
+ */
+export const AdminBrokeredLeadDtoInternalStatusEnum = {
+    PENDING_SELLER: 'pending_seller',
+    PENDING_SELLER_VERIFICATION: 'pending_seller_verification',
+    APPROVED: 'approved',
+    DECLINED: 'declined',
+    CANCELLED: 'cancelled'
+} as const;
+export type AdminBrokeredLeadDtoInternalStatusEnum = typeof AdminBrokeredLeadDtoInternalStatusEnum[keyof typeof AdminBrokeredLeadDtoInternalStatusEnum];
+
+
+/**
+ * Check if a given object implements the AdminBrokeredLeadDto interface.
+ */
+export function instanceOfAdminBrokeredLeadDto(value: object): value is AdminBrokeredLeadDto {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('domainName' in value) || value['domainName'] === undefined) return false;
+    if (!('status' in value) || value['status'] === undefined) return false;
+    if (!('askingPrice' in value) || value['askingPrice'] === undefined) return false;
+    if (!('commission' in value) || value['commission'] === undefined) return false;
+    if (!('nameshiftCommissionPercentage' in value) || value['nameshiftCommissionPercentage'] === undefined) return false;
+    if (!('nameshiftFee' in value) || value['nameshiftFee'] === undefined) return false;
+    if (!('netPayout' in value) || value['netPayout'] === undefined) return false;
+    if (!('buyer' in value) || value['buyer'] === undefined) return false;
+    if (!('sellerEmail' in value) || value['sellerEmail'] === undefined) return false;
+    if (!('sellerLinked' in value) || value['sellerLinked'] === undefined) return false;
+    if (!('sellerSignupUrl' in value) || value['sellerSignupUrl'] === undefined) return false;
+    if (!('sellerSignupUrlExpiresAt' in value) || value['sellerSignupUrlExpiresAt'] === undefined) return false;
+    if (!('sellerReviewUrl' in value) || value['sellerReviewUrl'] === undefined) return false;
+    if (!('paymentUrl' in value) || value['paymentUrl'] === undefined) return false;
+    if (!('sellerNotifiedAt' in value) || value['sellerNotifiedAt'] === undefined) return false;
+    if (!('nextSellerNotificationAt' in value) || value['nextSellerNotificationAt'] === undefined) return false;
+    if (!('canNotifySeller' in value) || value['canNotifySeller'] === undefined) return false;
+    if (!('buyerNotifiedAt' in value) || value['buyerNotifiedAt'] === undefined) return false;
+    if (!('nextBuyerNotificationAt' in value) || value['nextBuyerNotificationAt'] === undefined) return false;
+    if (!('canNotifyBuyer' in value) || value['canNotifyBuyer'] === undefined) return false;
+    if (!('declineReason' in value) || value['declineReason'] === undefined) return false;
+    if (!('createdAt' in value) || value['createdAt'] === undefined) return false;
+    if (!('updatedAt' in value) || value['updatedAt'] === undefined) return false;
+    if (!('internalStatus' in value) || value['internalStatus'] === undefined) return false;
+    if (!('brokerAccountId' in value) || value['brokerAccountId'] === undefined) return false;
+    if (!('brokerName' in value) || value['brokerName'] === undefined) return false;
+    if (!('sellerAccountId' in value) || value['sellerAccountId'] === undefined) return false;
+    if (!('sellerName' in value) || value['sellerName'] === undefined) return false;
+    if (!('leadId' in value) || value['leadId'] === undefined) return false;
+    if (!('nameshiftCommissionReason' in value) || value['nameshiftCommissionReason'] === undefined) return false;
+    if (!('nameshiftCommissionOverridable' in value) || value['nameshiftCommissionOverridable'] === undefined) return false;
+    return true;
+}
+
+export function AdminBrokeredLeadDtoFromJSON(json: any): AdminBrokeredLeadDto {
+    return AdminBrokeredLeadDtoFromJSONTyped(json, false);
+}
+
+export function AdminBrokeredLeadDtoFromJSONTyped(json: any, ignoreDiscriminator: boolean): AdminBrokeredLeadDto {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'domainName': json['domainName'],
+        'status': json['status'],
+        'askingPrice': MoneyDtoFromJSON(json['askingPrice']),
+        'commission': BrokeredLeadCommissionDtoFromJSON(json['commission']),
+        'nameshiftCommissionPercentage': json['nameshiftCommissionPercentage'],
+        'nameshiftFee': MoneyDecimalDtoFromJSON(json['nameshiftFee']),
+        'netPayout': MoneyDecimalDtoFromJSON(json['netPayout']),
+        'buyer': BrokeredLeadBuyerContactDtoFromJSON(json['buyer']),
+        'sellerEmail': json['sellerEmail'],
+        'sellerLinked': json['sellerLinked'],
+        'sellerSignupUrl': json['sellerSignupUrl'],
+        'sellerSignupUrlExpiresAt': (json['sellerSignupUrlExpiresAt'] == null ? null : new Date(json['sellerSignupUrlExpiresAt'])),
+        'sellerReviewUrl': json['sellerReviewUrl'],
+        'paymentUrl': json['paymentUrl'],
+        'sellerNotifiedAt': (json['sellerNotifiedAt'] == null ? null : new Date(json['sellerNotifiedAt'])),
+        'nextSellerNotificationAt': (json['nextSellerNotificationAt'] == null ? null : new Date(json['nextSellerNotificationAt'])),
+        'canNotifySeller': json['canNotifySeller'],
+        'buyerNotifiedAt': (json['buyerNotifiedAt'] == null ? null : new Date(json['buyerNotifiedAt'])),
+        'nextBuyerNotificationAt': (json['nextBuyerNotificationAt'] == null ? null : new Date(json['nextBuyerNotificationAt'])),
+        'canNotifyBuyer': json['canNotifyBuyer'],
+        'declineReason': json['declineReason'],
+        'createdAt': (new Date(json['createdAt'])),
+        'updatedAt': (new Date(json['updatedAt'])),
+        'internalStatus': json['internalStatus'],
+        'brokerAccountId': json['brokerAccountId'],
+        'brokerName': json['brokerName'],
+        'sellerAccountId': json['sellerAccountId'],
+        'sellerName': json['sellerName'],
+        'leadId': json['leadId'],
+        'nameshiftCommissionReason': json['nameshiftCommissionReason'],
+        'nameshiftCommissionOverridable': json['nameshiftCommissionOverridable'],
+    };
+}
+
+export function AdminBrokeredLeadDtoToJSON(json: any): AdminBrokeredLeadDto {
+    return AdminBrokeredLeadDtoToJSONTyped(json, false);
+}
+
+export function AdminBrokeredLeadDtoToJSONTyped(value?: AdminBrokeredLeadDto | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'domainName': value['domainName'],
+        'status': value['status'],
+        'askingPrice': MoneyDtoToJSON(value['askingPrice']),
+        'commission': BrokeredLeadCommissionDtoToJSON(value['commission']),
+        'nameshiftCommissionPercentage': value['nameshiftCommissionPercentage'],
+        'nameshiftFee': MoneyDecimalDtoToJSON(value['nameshiftFee']),
+        'netPayout': MoneyDecimalDtoToJSON(value['netPayout']),
+        'buyer': BrokeredLeadBuyerContactDtoToJSON(value['buyer']),
+        'sellerEmail': value['sellerEmail'],
+        'sellerLinked': value['sellerLinked'],
+        'sellerSignupUrl': value['sellerSignupUrl'],
+        'sellerSignupUrlExpiresAt': (value['sellerSignupUrlExpiresAt'] == null ? null : (value['sellerSignupUrlExpiresAt'] as any).toISOString()),
+        'sellerReviewUrl': value['sellerReviewUrl'],
+        'paymentUrl': value['paymentUrl'],
+        'sellerNotifiedAt': (value['sellerNotifiedAt'] == null ? null : (value['sellerNotifiedAt'] as any).toISOString()),
+        'nextSellerNotificationAt': (value['nextSellerNotificationAt'] == null ? null : (value['nextSellerNotificationAt'] as any).toISOString()),
+        'canNotifySeller': value['canNotifySeller'],
+        'buyerNotifiedAt': (value['buyerNotifiedAt'] == null ? null : (value['buyerNotifiedAt'] as any).toISOString()),
+        'nextBuyerNotificationAt': (value['nextBuyerNotificationAt'] == null ? null : (value['nextBuyerNotificationAt'] as any).toISOString()),
+        'canNotifyBuyer': value['canNotifyBuyer'],
+        'declineReason': value['declineReason'],
+        'createdAt': ((value['createdAt']).toISOString()),
+        'updatedAt': ((value['updatedAt']).toISOString()),
+        'internalStatus': value['internalStatus'],
+        'brokerAccountId': value['brokerAccountId'],
+        'brokerName': value['brokerName'],
+        'sellerAccountId': value['sellerAccountId'],
+        'sellerName': value['sellerName'],
+        'leadId': value['leadId'],
+        'nameshiftCommissionReason': value['nameshiftCommissionReason'],
+        'nameshiftCommissionOverridable': value['nameshiftCommissionOverridable'],
+    };
+}
+

package/src/models/AdminListBrokeredLeads200Response.ts

@@ -0,0 +1,106 @@
+/* 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 { PaginateResponseLinks } from './PaginateResponseLinks';
+import {
+    PaginateResponseLinksFromJSON,
+    PaginateResponseLinksFromJSONTyped,
+    PaginateResponseLinksToJSON,
+    PaginateResponseLinksToJSONTyped,
+} from './PaginateResponseLinks';
+import type { AdminBrokeredLeadDto } from './AdminBrokeredLeadDto';
+import {
+    AdminBrokeredLeadDtoFromJSON,
+    AdminBrokeredLeadDtoFromJSONTyped,
+    AdminBrokeredLeadDtoToJSON,
+    AdminBrokeredLeadDtoToJSONTyped,
+} from './AdminBrokeredLeadDto';
+import type { PaginateResponseMeta } from './PaginateResponseMeta';
+import {
+    PaginateResponseMetaFromJSON,
+    PaginateResponseMetaFromJSONTyped,
+    PaginateResponseMetaToJSON,
+    PaginateResponseMetaToJSONTyped,
+} from './PaginateResponseMeta';
+
+/**
+ * 
+ * @export
+ * @interface AdminListBrokeredLeads200Response
+ */
+export interface AdminListBrokeredLeads200Response {
+    /**
+     * 
+     * @type {Array<AdminBrokeredLeadDto>}
+     * @memberof AdminListBrokeredLeads200Response
+     */
+    data: Array<AdminBrokeredLeadDto>;
+    /**
+     * 
+     * @type {PaginateResponseMeta}
+     * @memberof AdminListBrokeredLeads200Response
+     */
+    meta: PaginateResponseMeta;
+    /**
+     * 
+     * @type {PaginateResponseLinks}
+     * @memberof AdminListBrokeredLeads200Response
+     */
+    links: PaginateResponseLinks;
+}
+
+/**
+ * Check if a given object implements the AdminListBrokeredLeads200Response interface.
+ */
+export function instanceOfAdminListBrokeredLeads200Response(value: object): value is AdminListBrokeredLeads200Response {
+    if (!('data' in value) || value['data'] === undefined) return false;
+    if (!('meta' in value) || value['meta'] === undefined) return false;
+    if (!('links' in value) || value['links'] === undefined) return false;
+    return true;
+}
+
+export function AdminListBrokeredLeads200ResponseFromJSON(json: any): AdminListBrokeredLeads200Response {
+    return AdminListBrokeredLeads200ResponseFromJSONTyped(json, false);
+}
+
+export function AdminListBrokeredLeads200ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): AdminListBrokeredLeads200Response {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'data': ((json['data'] as Array<any>).map(AdminBrokeredLeadDtoFromJSON)),
+        'meta': PaginateResponseMetaFromJSON(json['meta']),
+        'links': PaginateResponseLinksFromJSON(json['links']),
+    };
+}
+
+export function AdminListBrokeredLeads200ResponseToJSON(json: any): AdminListBrokeredLeads200Response {
+    return AdminListBrokeredLeads200ResponseToJSONTyped(json, false);
+}
+
+export function AdminListBrokeredLeads200ResponseToJSONTyped(value?: AdminListBrokeredLeads200Response | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'data': ((value['data'] as Array<any>).map(AdminBrokeredLeadDtoToJSON)),
+        'meta': PaginateResponseMetaToJSON(value['meta']),
+        'links': PaginateResponseLinksToJSON(value['links']),
+    };
+}
+

package/src/models/ApiKeyDto.ts

@@ -81,6 +81,8 @@ export const ApiKeyDtoScopeEnum = {
     TRANSFERS_WRITE: 'TRANSFERS_WRITE',
     LEADS_READ: 'LEADS_READ',
     LEADS_WRITE: 'LEADS_WRITE',
+    BROKERED_LEADS_READ: 'BROKERED_LEADS_READ',
+    BROKERED_LEADS_WRITE: 'BROKERED_LEADS_WRITE',
     AUCTIONS_READ: 'AUCTIONS_READ',
     AUCTIONS_WRITE: 'AUCTIONS_WRITE',
     STATS_READ: 'STATS_READ',

package/src/models/ApiKeyScopeDto.ts

@@ -57,6 +57,8 @@ export const ApiKeyScopeDtoScopeEnum = {
     TRANSFERS_WRITE: 'TRANSFERS_WRITE',
     LEADS_READ: 'LEADS_READ',
     LEADS_WRITE: 'LEADS_WRITE',
+    BROKERED_LEADS_READ: 'BROKERED_LEADS_READ',
+    BROKERED_LEADS_WRITE: 'BROKERED_LEADS_WRITE',
     AUCTIONS_READ: 'AUCTIONS_READ',
     AUCTIONS_WRITE: 'AUCTIONS_WRITE',
     STATS_READ: 'STATS_READ',