@apideck/node
Version:
Apideck Node.js SDK
205 lines (204 loc) • 4.76 kB
TypeScript
/**
* Apideck
* The Apideck OpenAPI Spec: SDK Optimized
*
* The version of the OpenAPI document: 10.13.0
* Contact: support@apideck.com
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
import { Address } from './Address';
import { Currency } from './Currency';
import { CustomField } from './CustomField';
import { Email } from './Email';
import { PassThroughBody } from './PassThroughBody';
import { PhoneNumber } from './PhoneNumber';
import { SocialLink } from './SocialLink';
import { Tags } from './Tags';
import { Website } from './Website';
/**
*
* @export
* @interface Lead
*/
export interface Lead {
/**
* Full name of the lead.
* @type {string}
* @memberof Lead
*/
name: string;
/**
* The name of the company the lead is associated with.
* @type {string}
* @memberof Lead
*/
company_name: string | null;
/**
* Unique identifier for the contact.
* @type {string}
* @memberof Lead
*/
readonly id?: string;
/**
* The owner of the lead.
* @type {string}
* @memberof Lead
*/
owner_id?: string | null;
/**
* The name of the owner of the lead.
* @type {string}
* @memberof Lead
*/
owner_name?: string | null;
/**
* The company the lead is associated with.
* @type {string}
* @memberof Lead
*/
company_id?: string | null;
/**
* The identifier of the lead.
* @type {string}
* @memberof Lead
*/
lead_id?: string | null;
/**
* The source of the lead.
* @type {string}
* @memberof Lead
*/
lead_source?: string | null;
/**
* The first name of the lead.
* @type {string}
* @memberof Lead
*/
first_name?: string | null;
/**
* The last name of the lead.
* @type {string}
* @memberof Lead
*/
last_name?: string | null;
/**
* The description of the lead.
* @type {string}
* @memberof Lead
*/
description?: string | null;
/**
* The prefix of the lead.
* @type {string}
* @memberof Lead
*/
prefix?: string | null;
/**
* The job title of the lead.
* @type {string}
* @memberof Lead
*/
title?: string | null;
/**
* language code according to ISO 639-1. For the United States - EN
* @type {string}
* @memberof Lead
*/
language?: string | null;
/**
*
* @type {string}
* @memberof Lead
*/
status?: string | null;
/**
* The monetary amount of the lead.
* @type {number}
* @memberof Lead
*/
monetary_amount?: number | null;
/**
*
* @type {Currency}
* @memberof Lead
*/
currency?: Currency | null;
/**
* The fax number of the lead.
* @type {string}
* @memberof Lead
*/
fax?: string | null;
/**
*
* @type {Array<Website>}
* @memberof Lead
*/
websites?: Array<Website>;
/**
*
* @type {Array<Address>}
* @memberof Lead
*/
addresses?: Array<Address>;
/**
*
* @type {Array<SocialLink>}
* @memberof Lead
*/
social_links?: Array<SocialLink>;
/**
*
* @type {Array<PhoneNumber>}
* @memberof Lead
*/
phone_numbers?: Array<PhoneNumber>;
/**
*
* @type {Array<Email>}
* @memberof Lead
*/
emails?: Array<Email>;
/**
*
* @type {Array<CustomField>}
* @memberof Lead
*/
custom_fields?: Array<CustomField>;
/**
*
* @type {Tags}
* @memberof Lead
*/
tags?: Tags | null;
/**
* When custom mappings are configured on the resource, the result is included here.
* @type {object}
* @memberof Lead
*/
readonly custom_mappings?: object | null;
/**
* Date updated in ISO 8601 format
* @type {string}
* @memberof Lead
*/
readonly updated_at?: string | null;
/**
* Date created in ISO 8601 format
* @type {string}
* @memberof Lead
*/
readonly created_at?: string | null;
/**
*
* @type {PassThroughBody}
* @memberof Lead
*/
pass_through?: PassThroughBody;
}
export declare function LeadFromJSON(json: any): Lead;
export declare function LeadFromJSONTyped(json: any, ignoreDiscriminator: boolean): Lead;
export declare function LeadToJSON(value?: Lead | null): any;