n8n/packages/nodes-base/nodes/Salesforce/LeadDescription.ts

987 lines
20 KiB
TypeScript
Raw Normal View History

import {
INodeProperties,
} from 'n8n-workflow';
2020-02-10 12:55:28 -08:00
export const leadOperations: INodeProperties[] = [
2020-02-10 12:55:28 -08:00
{
displayName: 'Operation',
name: 'operation',
type: 'options',
displayOptions: {
show: {
resource: [
'lead',
],
},
},
options: [
{
name: 'Add Lead To Campaign',
value: 'addToCampaign',
description: 'Add lead to a campaign',
},
{
name: 'Add Note',
value: 'addNote',
description: 'Add note to a lead',
},
2020-02-10 12:55:28 -08:00
{
name: 'Create',
value: 'create',
description: 'Create a lead',
},
{
name: 'Create or Update',
value: 'upsert',
description: 'Create a new lead, or update the current one if it already exists (upsert)',
},
2020-02-10 12:55:28 -08:00
{
name: 'Delete',
value: 'delete',
description: 'Delete a lead',
2020-02-10 12:55:28 -08:00
},
{
name: 'Get',
value: 'get',
description: 'Get a lead',
},
{
name: 'Get All',
value: 'getAll',
description: 'Get all leads',
},
{
name: 'Get Summary',
value: 'getSummary',
description: `Returns an overview of Lead's metadata`,
2020-02-10 12:55:28 -08:00
},
{
name: 'Update',
value: 'update',
description: 'Update a lead',
2020-02-10 12:55:28 -08:00
},
],
default: 'create',
description: 'The operation to perform.',
},
];
2020-02-10 12:55:28 -08:00
export const leadFields: INodeProperties[] = [
2020-02-10 12:55:28 -08:00
/* -------------------------------------------------------------------------- */
/* lead:create */
/* -------------------------------------------------------------------------- */
{
displayName: 'Match Against',
name: 'externalId',
type: 'options',
typeOptions: {
loadOptionsMethod: 'getExternalIdFields',
loadOptionsDependsOn: [
'resource',
],
},
required: true,
default: '',
displayOptions: {
show: {
resource: [
'lead',
],
operation: [
'upsert',
],
},
},
description: `The field to check to see if the lead already exists`,
},
{
displayName: 'Value to Match',
name: 'externalIdValue',
type: 'string',
required: true,
default: '',
displayOptions: {
show: {
resource: [
'lead',
],
operation: [
'upsert',
],
},
},
description: `If this value exists in the 'match against' field, update the lead. Otherwise create a new one`,
},
2020-02-10 12:55:28 -08:00
{
displayName: 'Company',
name: 'company',
type: 'string',
required: true,
default: '',
displayOptions: {
show: {
resource: [
'lead',
],
operation: [
'create',
'upsert',
],
2020-02-10 12:55:28 -08:00
},
},
description: 'Company of the lead. If person account record types have been enabled, and if the value of Company is null, the lead converts to a person account.',
},
{
displayName: 'Last Name',
name: 'lastname',
type: 'string',
required: true,
default: '',
displayOptions: {
show: {
resource: [
'lead',
],
operation: [
'create',
'upsert',
],
2020-02-10 12:55:28 -08:00
},
},
description: 'Required. Last name of the lead. Limited to 80 characters.',
},
{
displayName: 'Additional Fields',
name: 'additionalFields',
type: 'collection',
placeholder: 'Add Field',
default: {},
displayOptions: {
show: {
resource: [
'lead',
],
operation: [
'create',
'upsert',
2020-02-10 12:55:28 -08:00
],
},
},
options: [
{
displayName: 'Annual Revenue',
name: 'annualRevenue',
type: 'number',
typeOptions: {
numberPrecision: 2,
numberStepSize: 1,
},
default: '',
description: 'Annual revenue for the company of the lead.',
},
2020-02-10 12:55:28 -08:00
{
displayName: 'City',
name: 'city',
type: 'string',
default: '',
description: 'City for the address of the lead.',
},
{
displayName: 'Custom Fields',
name: 'customFieldsUi',
placeholder: 'Add Custom Field',
type: 'fixedCollection',
typeOptions: {
multipleValues: true,
},
description: 'Filter by custom fields ',
default: {},
options: [
{
name: 'customFieldsValues',
displayName: 'Custom Field',
values: [
{
displayName: 'Field ID',
name: 'fieldId',
type: 'options',
typeOptions: {
loadOptionsMethod: 'getCustomFields',
},
default: '',
description: 'The ID of the field to add custom field to.',
},
{
displayName: 'Value',
name: 'value',
type: 'string',
default: '',
description: 'The value to set on custom field.',
},
],
},
],
},
{
displayName: 'Description',
name: 'description',
type: 'string',
typeOptions: {
alwaysOpenEditWindow: true,
},
default: '',
description: 'Description of the lead.',
},
2020-02-10 12:55:28 -08:00
{
displayName: 'Email',
name: 'email',
type: 'string',
default: '',
description: 'Email address for the lead.',
},
{
displayName: 'Fist Name',
name: 'firstname',
2020-02-10 12:55:28 -08:00
type: 'string',
default: '',
description: 'First name of the lead. Limited to 40 characters.',
2020-02-10 12:55:28 -08:00
},
{
displayName: 'Industry',
name: 'industry',
2020-02-10 12:55:28 -08:00
type: 'string',
default: '',
description: 'Website for the lead.',
2020-02-10 12:55:28 -08:00
},
{
displayName: 'Is Unread By Owner',
name: 'IsUnreadByOwner',
type: 'boolean',
default: false,
description: 'If true, lead has been assigned, but not yet viewed. See Unread Leads for more information. Label is Unread By Owner.',
2020-02-10 12:55:28 -08:00
},
{
displayName: 'Jigsaw',
name: 'jigsaw',
type: 'string',
default: '',
description: `references the ID of a contact in Data.com.
If a lead has a value in this field, it means that a contact was imported as a lead from Data.com.`,
},
{
displayName: 'Lead Source',
name: 'leadSource',
2020-02-10 12:55:28 -08:00
type: 'options',
typeOptions: {
loadOptionsMethod: 'getLeadSources',
2020-02-10 12:55:28 -08:00
},
default: '',
description: 'Source from which the lead was obtained.',
2020-02-10 12:55:28 -08:00
},
{
displayName: 'Mobile Phone',
name: 'mobilePhone',
type: 'string',
default: '',
description: `Contacts mobile phone number.`,
},
2020-02-10 12:55:28 -08:00
{
displayName: 'Number Of Employees',
name: 'numberOfEmployees',
type: 'number',
typeOptions: {
numberStepSize: 1,
},
2020-02-10 12:55:28 -08:00
default: '',
description: 'Number of employees at the leads company. Label is Employees.',
2020-02-10 12:55:28 -08:00
},
{
displayName: 'Owner',
name: 'owner',
type: 'options',
typeOptions: {
loadOptionsMethod: 'getLeadOwners',
2020-02-10 12:55:28 -08:00
},
default: '',
description: 'The owner of the lead.',
},
{
displayName: 'Phone',
name: 'phone',
2020-02-10 12:55:28 -08:00
type: 'string',
default: '',
description: 'Phone number for the lead.',
2020-02-10 12:55:28 -08:00
},
{
displayName: 'Postal Code',
name: 'postalCode',
2020-02-10 12:55:28 -08:00
type: 'string',
default: '',
description: 'Postal code for the address of the lead. Label is Zip/Postal Code.',
2020-02-10 12:55:28 -08:00
},
{
displayName: 'Record Type ID',
name: 'recordTypeId',
type: 'options',
typeOptions: {
loadOptionsMethod: 'getRecordTypes',
},
default: '',
},
2020-02-10 12:55:28 -08:00
{
displayName: 'Rating',
name: 'rating',
2020-02-10 12:55:28 -08:00
type: 'string',
default: '',
description: 'Rating of the lead.',
2020-02-10 12:55:28 -08:00
},
{
displayName: 'Salutation',
name: 'salutation',
type: 'string',
default: '',
description: 'Salutation for the lead.',
},
{
displayName: 'State',
name: 'state',
2020-02-10 12:55:28 -08:00
type: 'string',
default: '',
description: 'State for the address of the lead.',
2020-02-10 12:55:28 -08:00
},
{
displayName: 'Status',
name: 'status',
type: 'options',
2020-02-10 12:55:28 -08:00
typeOptions: {
loadOptionsMethod: 'getLeadStatuses',
2020-02-10 12:55:28 -08:00
},
default: '',
description: 'Status code for this converted lead.',
2020-02-10 12:55:28 -08:00
},
{
displayName: 'Street',
name: 'street',
type: 'string',
2020-02-10 12:55:28 -08:00
default: '',
description: 'Street number and name for the address of the lead.',
2020-02-10 12:55:28 -08:00
},
{
displayName: 'Title',
name: 'title',
type: 'string',
default: '',
description: 'Title for the lead, for example CFO or CEO.',
},
{
displayName: 'Website',
name: 'website',
type: 'string',
default: '',
description: 'Website for the lead.',
2020-02-10 12:55:28 -08:00
},
2020-10-22 06:46:03 -07:00
],
2020-02-10 12:55:28 -08:00
},
/* -------------------------------------------------------------------------- */
/* lead:update */
/* -------------------------------------------------------------------------- */
2020-02-10 12:55:28 -08:00
{
displayName: 'Lead ID',
name: 'leadId',
type: 'string',
required: true,
default: '',
displayOptions: {
show: {
resource: [
'lead',
],
operation: [
'update',
2020-10-22 06:46:03 -07:00
],
2020-02-10 12:55:28 -08:00
},
},
description: 'ID of Lead that needs to be fetched.',
2020-02-10 12:55:28 -08:00
},
{
displayName: 'Update Fields',
name: 'updateFields',
type: 'collection',
placeholder: 'Add Field',
default: {},
displayOptions: {
show: {
resource: [
'lead',
],
operation: [
'update',
],
},
},
options: [
{
displayName: 'Annual Revenue',
name: 'annualRevenue',
type: 'number',
typeOptions: {
numberPrecision: 2,
numberStepSize: 1,
},
default: '',
description: 'Annual revenue for the company of the lead.',
},
{
displayName: 'City',
name: 'city',
2020-02-10 12:55:28 -08:00
type: 'string',
default: '',
description: 'City for the address of the lead.',
2020-02-10 12:55:28 -08:00
},
{
displayName: 'Company',
name: 'company',
2020-02-10 12:55:28 -08:00
type: 'string',
default: '',
description: 'Company of the lead. If person account record types have been enabled, and if the value of Company is null, the lead converts to a person account.',
2020-02-10 12:55:28 -08:00
},
{
displayName: 'Custom Fields',
name: 'customFieldsUi',
placeholder: 'Add Custom Field',
type: 'fixedCollection',
typeOptions: {
multipleValues: true,
},
description: 'Filter by custom fields ',
default: {},
options: [
{
name: 'customFieldsValues',
displayName: 'Custom Field',
values: [
{
displayName: 'Field ID',
name: 'fieldId',
type: 'options',
typeOptions: {
loadOptionsMethod: 'getCustomFields',
},
default: '',
description: 'The ID of the field to add custom field to.',
},
{
displayName: 'Value',
name: 'value',
type: 'string',
default: '',
description: 'The value to set on custom field.',
},
],
},
],
},
2020-02-10 12:55:28 -08:00
{
displayName: 'Description',
name: 'description',
2020-02-10 12:55:28 -08:00
type: 'string',
typeOptions: {
alwaysOpenEditWindow: true,
},
2020-02-10 12:55:28 -08:00
default: '',
description: 'Description of the lead.',
2020-02-10 12:55:28 -08:00
},
{
displayName: 'Email',
name: 'email',
type: 'string',
default: '',
description: 'Email address for the lead.',
},
{
displayName: 'Fist Name',
name: 'firstname',
2020-02-10 12:55:28 -08:00
type: 'string',
default: '',
description: 'First name of the lead. Limited to 40 characters.',
2020-02-10 12:55:28 -08:00
},
{
displayName: 'Industry',
name: 'industry',
2020-02-10 12:55:28 -08:00
type: 'string',
default: '',
description: 'Website for the lead.',
2020-02-10 12:55:28 -08:00
},
{
displayName: 'Is Unread By Owner',
name: 'IsUnreadByOwner',
type: 'boolean',
default: false,
description: 'If true, lead has been assigned, but not yet viewed. See Unread Leads for more information. Label is Unread By Owner.',
2020-02-10 12:55:28 -08:00
},
{
displayName: 'Jigsaw',
name: 'jigsaw',
type: 'string',
default: '',
description: `references the ID of a contact in Data.com.
If a lead has a value in this field, it means that a contact was imported as a lead from Data.com.`,
},
{
displayName: 'Last Name',
name: 'lastname',
2020-02-10 12:55:28 -08:00
type: 'string',
default: '',
description: 'Required. Last name of the lead. Limited to 80 characters.',
2020-02-10 12:55:28 -08:00
},
{
displayName: 'Lead Source',
name: 'leadSource',
2020-02-10 12:55:28 -08:00
type: 'options',
typeOptions: {
loadOptionsMethod: 'getLeadSources',
2020-02-10 12:55:28 -08:00
},
default: '',
description: 'Source from which the lead was obtained.',
2020-02-10 12:55:28 -08:00
},
{
displayName: 'Mobile Phone',
name: 'mobilePhone',
type: 'string',
default: '',
description: `Contacts mobile phone number.`,
},
2020-02-10 12:55:28 -08:00
{
displayName: 'Number Of Employees',
name: 'numberOfEmployees',
type: 'number',
typeOptions: {
numberStepSize: 1,
},
2020-02-10 12:55:28 -08:00
default: '',
description: 'Number of employees at the leads company. Label is Employees.',
2020-02-10 12:55:28 -08:00
},
{
displayName: 'Owner',
name: 'owner',
type: 'options',
typeOptions: {
loadOptionsMethod: 'getLeadOwners',
2020-02-10 12:55:28 -08:00
},
default: '',
description: 'The owner of the lead.',
},
{
displayName: 'Postal Code',
name: 'postalCode',
2020-02-10 12:55:28 -08:00
type: 'string',
default: '',
description: 'Postal code for the address of the lead. Label is Zip/Postal Code.',
2020-02-10 12:55:28 -08:00
},
{
displayName: 'Phone',
name: 'phone',
2020-02-10 12:55:28 -08:00
type: 'string',
default: '',
description: 'Phone number for the lead.',
2020-02-10 12:55:28 -08:00
},
{
displayName: 'Record Type ID',
name: 'recordTypeId',
type: 'options',
typeOptions: {
loadOptionsMethod: 'getRecordTypes',
},
default: '',
},
2020-02-10 12:55:28 -08:00
{
displayName: 'Rating',
name: 'rating',
2020-02-10 12:55:28 -08:00
type: 'string',
default: '',
description: 'Rating of the lead.',
2020-02-10 12:55:28 -08:00
},
{
displayName: 'Salutation',
name: 'salutation',
type: 'string',
default: '',
description: 'Salutation for the lead.',
},
{
displayName: 'State',
name: 'state',
2020-02-10 12:55:28 -08:00
type: 'string',
default: '',
description: 'State for the address of the lead.',
2020-02-10 12:55:28 -08:00
},
{
displayName: 'Status',
name: 'status',
type: 'options',
2020-02-10 12:55:28 -08:00
typeOptions: {
loadOptionsMethod: 'getLeadStatuses',
2020-02-10 12:55:28 -08:00
},
default: '',
description: 'Status code for this converted lead.',
2020-02-10 12:55:28 -08:00
},
{
displayName: 'Street',
name: 'street',
type: 'string',
2020-02-10 12:55:28 -08:00
default: '',
description: 'Street number and name for the address of the lead.',
2020-02-10 12:55:28 -08:00
},
{
displayName: 'Title',
name: 'title',
type: 'string',
default: '',
description: 'Title for the lead, for example CFO or CEO.',
},
{
displayName: 'Website',
name: 'website',
type: 'string',
default: '',
description: 'Website for the lead.',
2020-02-10 12:55:28 -08:00
},
2020-10-22 06:46:03 -07:00
],
2020-02-10 12:55:28 -08:00
},
/* -------------------------------------------------------------------------- */
/* lead:get */
/* -------------------------------------------------------------------------- */
2020-02-10 12:55:28 -08:00
{
displayName: 'Lead ID',
name: 'leadId',
type: 'string',
required: true,
default: '',
displayOptions: {
show: {
resource: [
'lead',
],
operation: [
'get',
2020-10-22 06:46:03 -07:00
],
2020-02-10 12:55:28 -08:00
},
},
description: 'ID of Lead that needs to be fetched.',
2020-02-10 12:55:28 -08:00
},
/* -------------------------------------------------------------------------- */
/* lead:delete */
/* -------------------------------------------------------------------------- */
2020-02-10 12:55:28 -08:00
{
displayName: 'Lead ID',
name: 'leadId',
type: 'string',
required: true,
default: '',
displayOptions: {
show: {
resource: [
'lead',
],
operation: [
'delete',
2020-10-22 06:46:03 -07:00
],
2020-02-10 12:55:28 -08:00
},
},
description: 'ID of Lead that needs to be fetched.',
2020-02-10 12:55:28 -08:00
},
/* -------------------------------------------------------------------------- */
/* lead:getAll */
/* -------------------------------------------------------------------------- */
2020-02-10 12:55:28 -08:00
{
displayName: 'Return All',
name: 'returnAll',
type: 'boolean',
displayOptions: {
show: {
resource: [
'lead',
],
operation: [
'getAll',
],
},
},
default: false,
description: 'If all results should be returned or only up to a given limit.',
},
{
displayName: 'Limit',
name: 'limit',
type: 'number',
displayOptions: {
show: {
resource: [
'lead',
],
operation: [
'getAll',
],
returnAll: [
false,
],
},
},
typeOptions: {
minValue: 1,
maxValue: 100,
},
default: 50,
description: 'How many results to return.',
},
{
displayName: 'Options',
name: 'options',
type: 'collection',
placeholder: 'Add Field',
default: {},
displayOptions: {
show: {
resource: [
'lead',
],
operation: [
'getAll',
],
},
},
options: [
{
displayName: 'Conditions',
name: 'conditionsUi',
placeholder: 'Add Condition',
type: 'fixedCollection',
typeOptions: {
multipleValues: true,
},
description: 'The condition to set.',
default: {},
options: [
{
name: 'conditionValues',
displayName: 'Condition',
values: [
{
displayName: 'Field',
name: 'field',
type: 'options',
typeOptions: {
loadOptionsMethod: 'getLeadFields',
},
default: '',
description: 'For date, number, or boolean, please use expressions.',
},
{
displayName: 'Operation',
name: 'operation',
type: 'options',
options: [
{
name: '=',
value: 'equal',
},
{
name: '>',
value: '>',
},
{
name: '<',
value: '<',
},
{
name: '>=',
value: '>=',
},
{
name: '<=',
value: '<=',
},
],
default: 'equal',
},
{
displayName: 'Value',
name: 'value',
type: 'string',
default: '',
},
],
},
],
},
2020-02-10 12:55:28 -08:00
{
displayName: 'Fields',
name: 'fields',
type: 'string',
default: '',
description: 'Fields to include separated by ,',
},
2020-10-22 06:46:03 -07:00
],
2020-02-10 12:55:28 -08:00
},
/* -------------------------------------------------------------------------- */
/* contact:addToCampaign */
/* -------------------------------------------------------------------------- */
2020-02-10 12:55:28 -08:00
{
displayName: 'Lead ID',
name: 'leadId',
type: 'string',
required: true,
default: '',
displayOptions: {
show: {
resource: [
'lead',
],
operation: [
'addToCampaign',
2020-10-22 06:46:03 -07:00
],
2020-02-10 12:55:28 -08:00
},
},
description: 'ID of contact that needs to be fetched.',
2020-02-10 12:55:28 -08:00
},
{
displayName: 'Campaign',
name: 'campaignId',
type: 'options',
typeOptions: {
loadOptionsMethod: 'getCampaigns',
},
required: true,
default: '',
displayOptions: {
show: {
resource: [
'lead',
],
operation: [
'addToCampaign',
2020-10-22 06:46:03 -07:00
],
2020-02-10 12:55:28 -08:00
},
},
description: 'ID of the campaign that needs to be fetched.',
2020-02-10 12:55:28 -08:00
},
{
displayName: 'Options',
name: 'options',
type: 'collection',
placeholder: 'Add Field',
default: {},
displayOptions: {
show: {
resource: [
'lead',
],
operation: [
'addToCampaign',
],
},
},
options: [
{
displayName: 'Status',
name: 'status',
type: 'string',
default: '',
description: 'Controls the HasResponded flag on this object.',
2020-02-10 12:55:28 -08:00
},
2020-10-22 06:46:03 -07:00
],
2020-02-10 12:55:28 -08:00
},
/* -------------------------------------------------------------------------- */
/* lead:addNote */
/* -------------------------------------------------------------------------- */
2020-02-10 12:55:28 -08:00
{
displayName: 'Lead ID',
name: 'leadId',
type: 'string',
required: true,
default: '',
displayOptions: {
show: {
resource: [
'lead',
],
operation: [
'addNote',
2020-10-22 06:46:03 -07:00
],
2020-02-10 12:55:28 -08:00
},
},
description: 'ID of lead that needs to be fetched.',
2020-02-10 12:55:28 -08:00
},
{
displayName: 'Title',
name: 'title',
type: 'string',
required: true,
default: '',
displayOptions: {
show: {
resource: [
'lead',
],
operation: [
'addNote',
2020-10-22 06:46:03 -07:00
],
2020-02-10 12:55:28 -08:00
},
},
description: 'Title of the note.',
},
{
displayName: 'Options',
name: 'options',
type: 'collection',
placeholder: 'Add Field',
default: {},
displayOptions: {
show: {
resource: [
'lead',
],
operation: [
'addNote',
],
},
},
options: [
{
displayName: 'Body',
name: 'body',
type: 'string',
default: '',
typeOptions: {
alwaysOpenEditWindow: true,
},
description: 'Body of the note. Limited to 32 KB.',
},
{
displayName: 'Is Private',
name: 'isPrivate',
type: 'boolean',
default: false,
description: 'If true, only the note owner or a user with the “Modify All Data” permission can view the note or query it via the API',
},
2020-02-10 12:55:28 -08:00
{
displayName: 'Owner',
name: 'owner',
type: 'options',
typeOptions: {
loadOptionsMethod: 'getUsers',
},
default: '',
description: 'ID of the user who owns the note.',
},
2020-10-22 06:46:03 -07:00
],
2020-02-10 12:55:28 -08:00
},
];