@randock/nameshift-api-client 0.0.459 → 0.0.461

package/src/models/JobDto.ts

@@ -0,0 +1,189 @@
+/* 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 { JobStatus } from './JobStatus';
+import {
+    JobStatusFromJSON,
+    JobStatusFromJSONTyped,
+    JobStatusToJSON,
+    JobStatusToJSONTyped,
+} from './JobStatus';
+import type { JobType } from './JobType';
+import {
+    JobTypeFromJSON,
+    JobTypeFromJSONTyped,
+    JobTypeToJSON,
+    JobTypeToJSONTyped,
+} from './JobType';
+import type { JobFailureDto } from './JobFailureDto';
+import {
+    JobFailureDtoFromJSON,
+    JobFailureDtoFromJSONTyped,
+    JobFailureDtoToJSON,
+    JobFailureDtoToJSONTyped,
+} from './JobFailureDto';
+
+/**
+ * 
+ * @export
+ * @interface JobDto
+ */
+export interface JobDto {
+    /**
+     * 
+     * @type {string}
+     * @memberof JobDto
+     */
+    id: string;
+    /**
+     * 
+     * @type {JobType}
+     * @memberof JobDto
+     */
+    type: JobType;
+    /**
+     * 
+     * @type {JobStatus}
+     * @memberof JobDto
+     */
+    status: JobStatus;
+    /**
+     * How many items the job expects to touch. An estimate while it runs, exact once it has finished.
+     * @type {number}
+     * @memberof JobDto
+     */
+    total: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof JobDto
+     */
+    processed: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof JobDto
+     */
+    succeeded: number;
+    /**
+     * Items the job refused rather than applied, most often because the change would have left them invalid.
+     * @type {number}
+     * @memberof JobDto
+     */
+    failed: number;
+    /**
+     * The first few failures, for showing without a second request.
+     * @type {Array<JobFailureDto>}
+     * @memberof JobDto
+     */
+    failures: Array<JobFailureDto>;
+    /**
+     * Why the job as a whole stopped. Never a per-item problem.
+     * @type {string}
+     * @memberof JobDto
+     */
+    failureReason: string | null;
+    /**
+     * 
+     * @type {Date}
+     * @memberof JobDto
+     */
+    createdAt: Date;
+    /**
+     * 
+     * @type {Date}
+     * @memberof JobDto
+     */
+    startedAt: Date | null;
+    /**
+     * 
+     * @type {Date}
+     * @memberof JobDto
+     */
+    finishedAt: Date | null;
+}
+
+
+
+/**
+ * Check if a given object implements the JobDto interface.
+ */
+export function instanceOfJobDto(value: object): value is JobDto {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('type' in value) || value['type'] === undefined) return false;
+    if (!('status' in value) || value['status'] === undefined) return false;
+    if (!('total' in value) || value['total'] === undefined) return false;
+    if (!('processed' in value) || value['processed'] === undefined) return false;
+    if (!('succeeded' in value) || value['succeeded'] === undefined) return false;
+    if (!('failed' in value) || value['failed'] === undefined) return false;
+    if (!('failures' in value) || value['failures'] === undefined) return false;
+    if (!('failureReason' in value) || value['failureReason'] === undefined) return false;
+    if (!('createdAt' in value) || value['createdAt'] === undefined) return false;
+    if (!('startedAt' in value) || value['startedAt'] === undefined) return false;
+    if (!('finishedAt' in value) || value['finishedAt'] === undefined) return false;
+    return true;
+}
+
+export function JobDtoFromJSON(json: any): JobDto {
+    return JobDtoFromJSONTyped(json, false);
+}
+
+export function JobDtoFromJSONTyped(json: any, ignoreDiscriminator: boolean): JobDto {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'type': JobTypeFromJSON(json['type']),
+        'status': JobStatusFromJSON(json['status']),
+        'total': json['total'],
+        'processed': json['processed'],
+        'succeeded': json['succeeded'],
+        'failed': json['failed'],
+        'failures': ((json['failures'] as Array<any>).map(JobFailureDtoFromJSON)),
+        'failureReason': json['failureReason'],
+        'createdAt': (new Date(json['createdAt'])),
+        'startedAt': (json['startedAt'] == null ? null : new Date(json['startedAt'])),
+        'finishedAt': (json['finishedAt'] == null ? null : new Date(json['finishedAt'])),
+    };
+}
+
+export function JobDtoToJSON(json: any): JobDto {
+    return JobDtoToJSONTyped(json, false);
+}
+
+export function JobDtoToJSONTyped(value?: JobDto | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'type': JobTypeToJSON(value['type']),
+        'status': JobStatusToJSON(value['status']),
+        'total': value['total'],
+        'processed': value['processed'],
+        'succeeded': value['succeeded'],
+        'failed': value['failed'],
+        'failures': ((value['failures'] as Array<any>).map(JobFailureDtoToJSON)),
+        'failureReason': value['failureReason'],
+        'createdAt': ((value['createdAt']).toISOString()),
+        'startedAt': (value['startedAt'] == null ? null : (value['startedAt'] as any).toISOString()),
+        'finishedAt': (value['finishedAt'] == null ? null : (value['finishedAt'] as any).toISOString()),
+    };
+}
+

package/src/models/JobFailureDto.ts

@@ -0,0 +1,75 @@
+/* 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';
+/**
+ * 
+ * @export
+ * @interface JobFailureDto
+ */
+export interface JobFailureDto {
+    /**
+     * What the failure was about — a domain name, for a bulk edit.
+     * @type {string}
+     * @memberof JobFailureDto
+     */
+    subject: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof JobFailureDto
+     */
+    reason: string;
+}
+
+/**
+ * Check if a given object implements the JobFailureDto interface.
+ */
+export function instanceOfJobFailureDto(value: object): value is JobFailureDto {
+    if (!('subject' in value) || value['subject'] === undefined) return false;
+    if (!('reason' in value) || value['reason'] === undefined) return false;
+    return true;
+}
+
+export function JobFailureDtoFromJSON(json: any): JobFailureDto {
+    return JobFailureDtoFromJSONTyped(json, false);
+}
+
+export function JobFailureDtoFromJSONTyped(json: any, ignoreDiscriminator: boolean): JobFailureDto {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'subject': json['subject'],
+        'reason': json['reason'],
+    };
+}
+
+export function JobFailureDtoToJSON(json: any): JobFailureDto {
+    return JobFailureDtoToJSONTyped(json, false);
+}
+
+export function JobFailureDtoToJSONTyped(value?: JobFailureDto | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'subject': value['subject'],
+        'reason': value['reason'],
+    };
+}
+

package/src/models/JobStatus.ts

@@ -0,0 +1,55 @@
+/* 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.
+ */
+
+
+/**
+ * 
+ * @export
+ */
+export const JobStatus = {
+    QUEUED: 'queued',
+    RUNNING: 'running',
+    FINISHED: 'finished',
+    FAILED: 'failed'
+} as const;
+export type JobStatus = typeof JobStatus[keyof typeof JobStatus];
+
+
+export function instanceOfJobStatus(value: any): boolean {
+    for (const key in JobStatus) {
+        if (Object.prototype.hasOwnProperty.call(JobStatus, key)) {
+            if (JobStatus[key as keyof typeof JobStatus] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+
+export function JobStatusFromJSON(json: any): JobStatus {
+    return JobStatusFromJSONTyped(json, false);
+}
+
+export function JobStatusFromJSONTyped(json: any, ignoreDiscriminator: boolean): JobStatus {
+    return json as JobStatus;
+}
+
+export function JobStatusToJSON(value?: JobStatus | null): any {
+    return value as any;
+}
+
+export function JobStatusToJSONTyped(value: any, ignoreDiscriminator: boolean): JobStatus {
+    return value as JobStatus;
+}
+

package/src/models/JobType.ts

@@ -0,0 +1,52 @@
+/* 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.
+ */
+
+
+/**
+ * 
+ * @export
+ */
+export const JobType = {
+    BULK_EDIT_DOMAINS: 'bulk_edit_domains'
+} as const;
+export type JobType = typeof JobType[keyof typeof JobType];
+
+
+export function instanceOfJobType(value: any): boolean {
+    for (const key in JobType) {
+        if (Object.prototype.hasOwnProperty.call(JobType, key)) {
+            if (JobType[key as keyof typeof JobType] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+
+export function JobTypeFromJSON(json: any): JobType {
+    return JobTypeFromJSONTyped(json, false);
+}
+
+export function JobTypeFromJSONTyped(json: any, ignoreDiscriminator: boolean): JobType {
+    return json as JobType;
+}
+
+export function JobTypeToJSON(value?: JobType | null): any {
+    return value as any;
+}
+
+export function JobTypeToJSONTyped(value: any, ignoreDiscriminator: boolean): JobType {
+    return value as JobType;
+}
+

package/src/models/LeadEnrichmentCompanyDto.ts

@@ -0,0 +1,120 @@
+/* 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';
+/**
+ * 
+ * @export
+ * @interface LeadEnrichmentCompanyDto
+ */
+export interface LeadEnrichmentCompanyDto {
+    /**
+     * 
+     * @type {string}
+     * @memberof LeadEnrichmentCompanyDto
+     */
+    status: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof LeadEnrichmentCompanyDto
+     */
+    legalName: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof LeadEnrichmentCompanyDto
+     */
+    tradeName: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof LeadEnrichmentCompanyDto
+     */
+    countryCode: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof LeadEnrichmentCompanyDto
+     */
+    vatId: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof LeadEnrichmentCompanyDto
+     */
+    registryId: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof LeadEnrichmentCompanyDto
+     */
+    domainRegisteredAt: string | null;
+}
+
+/**
+ * Check if a given object implements the LeadEnrichmentCompanyDto interface.
+ */
+export function instanceOfLeadEnrichmentCompanyDto(value: object): value is LeadEnrichmentCompanyDto {
+    if (!('status' in value) || value['status'] === undefined) return false;
+    if (!('legalName' in value) || value['legalName'] === undefined) return false;
+    if (!('tradeName' in value) || value['tradeName'] === undefined) return false;
+    if (!('countryCode' in value) || value['countryCode'] === undefined) return false;
+    if (!('vatId' in value) || value['vatId'] === undefined) return false;
+    if (!('registryId' in value) || value['registryId'] === undefined) return false;
+    if (!('domainRegisteredAt' in value) || value['domainRegisteredAt'] === undefined) return false;
+    return true;
+}
+
+export function LeadEnrichmentCompanyDtoFromJSON(json: any): LeadEnrichmentCompanyDto {
+    return LeadEnrichmentCompanyDtoFromJSONTyped(json, false);
+}
+
+export function LeadEnrichmentCompanyDtoFromJSONTyped(json: any, ignoreDiscriminator: boolean): LeadEnrichmentCompanyDto {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'status': json['status'],
+        'legalName': json['legalName'],
+        'tradeName': json['tradeName'],
+        'countryCode': json['countryCode'],
+        'vatId': json['vatId'],
+        'registryId': json['registryId'],
+        'domainRegisteredAt': json['domainRegisteredAt'],
+    };
+}
+
+export function LeadEnrichmentCompanyDtoToJSON(json: any): LeadEnrichmentCompanyDto {
+    return LeadEnrichmentCompanyDtoToJSONTyped(json, false);
+}
+
+export function LeadEnrichmentCompanyDtoToJSONTyped(value?: LeadEnrichmentCompanyDto | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'status': value['status'],
+        'legalName': value['legalName'],
+        'tradeName': value['tradeName'],
+        'countryCode': value['countryCode'],
+        'vatId': value['vatId'],
+        'registryId': value['registryId'],
+        'domainRegisteredAt': value['domainRegisteredAt'],
+    };
+}
+

package/src/models/LeadEnrichmentDto.ts

@@ -0,0 +1,149 @@
+/* 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 { LeadEnrichmentIpDto } from './LeadEnrichmentIpDto';
+import {
+    LeadEnrichmentIpDtoFromJSON,
+    LeadEnrichmentIpDtoFromJSONTyped,
+    LeadEnrichmentIpDtoToJSON,
+    LeadEnrichmentIpDtoToJSONTyped,
+} from './LeadEnrichmentIpDto';
+import type { LeadEnrichmentEmailDto } from './LeadEnrichmentEmailDto';
+import {
+    LeadEnrichmentEmailDtoFromJSON,
+    LeadEnrichmentEmailDtoFromJSONTyped,
+    LeadEnrichmentEmailDtoToJSON,
+    LeadEnrichmentEmailDtoToJSONTyped,
+} from './LeadEnrichmentEmailDto';
+import type { LeadEnrichmentWebResultDto } from './LeadEnrichmentWebResultDto';
+import {
+    LeadEnrichmentWebResultDtoFromJSON,
+    LeadEnrichmentWebResultDtoFromJSONTyped,
+    LeadEnrichmentWebResultDtoToJSON,
+    LeadEnrichmentWebResultDtoToJSONTyped,
+} from './LeadEnrichmentWebResultDto';
+import type { LeadEnrichmentCompanyDto } from './LeadEnrichmentCompanyDto';
+import {
+    LeadEnrichmentCompanyDtoFromJSON,
+    LeadEnrichmentCompanyDtoFromJSONTyped,
+    LeadEnrichmentCompanyDtoToJSON,
+    LeadEnrichmentCompanyDtoToJSONTyped,
+} from './LeadEnrichmentCompanyDto';
+
+/**
+ * 
+ * @export
+ * @interface LeadEnrichmentDto
+ */
+export interface LeadEnrichmentDto {
+    /**
+     * Whether any enrichment is held for this lead yet.
+     * @type {boolean}
+     * @memberof LeadEnrichmentDto
+     */
+    available: boolean;
+    /**
+     * Enrichment lifecycle status of the lead record.
+     * @type {string}
+     * @memberof LeadEnrichmentDto
+     */
+    status: string | null;
+    /**
+     * Summary of the buyer's public web footprint.
+     * @type {string}
+     * @memberof LeadEnrichmentDto
+     */
+    webSummary: string | null;
+    /**
+     * 
+     * @type {Array<LeadEnrichmentWebResultDto>}
+     * @memberof LeadEnrichmentDto
+     */
+    webResults: Array<LeadEnrichmentWebResultDto>;
+    /**
+     * 
+     * @type {LeadEnrichmentEmailDto}
+     * @memberof LeadEnrichmentDto
+     */
+    email: LeadEnrichmentEmailDto | null;
+    /**
+     * 
+     * @type {LeadEnrichmentCompanyDto}
+     * @memberof LeadEnrichmentDto
+     */
+    company: LeadEnrichmentCompanyDto | null;
+    /**
+     * 
+     * @type {LeadEnrichmentIpDto}
+     * @memberof LeadEnrichmentDto
+     */
+    ip: LeadEnrichmentIpDto | null;
+}
+
+/**
+ * Check if a given object implements the LeadEnrichmentDto interface.
+ */
+export function instanceOfLeadEnrichmentDto(value: object): value is LeadEnrichmentDto {
+    if (!('available' in value) || value['available'] === undefined) return false;
+    if (!('status' in value) || value['status'] === undefined) return false;
+    if (!('webSummary' in value) || value['webSummary'] === undefined) return false;
+    if (!('webResults' in value) || value['webResults'] === undefined) return false;
+    if (!('email' in value) || value['email'] === undefined) return false;
+    if (!('company' in value) || value['company'] === undefined) return false;
+    if (!('ip' in value) || value['ip'] === undefined) return false;
+    return true;
+}
+
+export function LeadEnrichmentDtoFromJSON(json: any): LeadEnrichmentDto {
+    return LeadEnrichmentDtoFromJSONTyped(json, false);
+}
+
+export function LeadEnrichmentDtoFromJSONTyped(json: any, ignoreDiscriminator: boolean): LeadEnrichmentDto {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'available': json['available'],
+        'status': json['status'],
+        'webSummary': json['webSummary'],
+        'webResults': ((json['webResults'] as Array<any>).map(LeadEnrichmentWebResultDtoFromJSON)),
+        'email': LeadEnrichmentEmailDtoFromJSON(json['email']),
+        'company': LeadEnrichmentCompanyDtoFromJSON(json['company']),
+        'ip': LeadEnrichmentIpDtoFromJSON(json['ip']),
+    };
+}
+
+export function LeadEnrichmentDtoToJSON(json: any): LeadEnrichmentDto {
+    return LeadEnrichmentDtoToJSONTyped(json, false);
+}
+
+export function LeadEnrichmentDtoToJSONTyped(value?: LeadEnrichmentDto | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'available': value['available'],
+        'status': value['status'],
+        'webSummary': value['webSummary'],
+        'webResults': ((value['webResults'] as Array<any>).map(LeadEnrichmentWebResultDtoToJSON)),
+        'email': LeadEnrichmentEmailDtoToJSON(value['email']),
+        'company': LeadEnrichmentCompanyDtoToJSON(value['company']),
+        'ip': LeadEnrichmentIpDtoToJSON(value['ip']),
+    };
+}
+