mirror of
https://github.com/n8n-io/n8n.git
synced 2024-11-16 01:24:05 -08:00
827 lines
19 KiB
TypeScript
827 lines
19 KiB
TypeScript
import {
|
|
INodeProperties,
|
|
} from 'n8n-workflow';
|
|
|
|
export const opportunityOperations: INodeProperties[] = [
|
|
{
|
|
displayName: 'Operation',
|
|
name: 'operation',
|
|
type: 'options',
|
|
noDataExpression: true,
|
|
displayOptions: {
|
|
show: {
|
|
resource: [
|
|
'opportunity',
|
|
],
|
|
},
|
|
},
|
|
options: [
|
|
{
|
|
name: 'Add Note',
|
|
value: 'addNote',
|
|
description: 'Add note to an opportunity',
|
|
action: 'Add a note to an opportunity',
|
|
},
|
|
{
|
|
name: 'Create',
|
|
value: 'create',
|
|
description: 'Create an opportunity',
|
|
action: 'Create an opportunity',
|
|
},
|
|
{
|
|
name: 'Create or Update',
|
|
value: 'upsert',
|
|
description: 'Create a new opportunity, or update the current one if it already exists (upsert)',
|
|
action: 'Create or update an opportunity',
|
|
},
|
|
{
|
|
name: 'Delete',
|
|
value: 'delete',
|
|
description: 'Delete an opportunity',
|
|
action: 'Delete an opportunity',
|
|
},
|
|
{
|
|
name: 'Get',
|
|
value: 'get',
|
|
description: 'Get an opportunity',
|
|
action: 'Get an opportunity',
|
|
},
|
|
{
|
|
name: 'Get All',
|
|
value: 'getAll',
|
|
description: 'Get all opportunities',
|
|
action: 'Get all opportunities',
|
|
},
|
|
{
|
|
name: 'Get Summary',
|
|
value: 'getSummary',
|
|
description: 'Returns an overview of opportunity\'s metadata',
|
|
action: 'Get an opportunity summary',
|
|
},
|
|
{
|
|
name: 'Update',
|
|
value: 'update',
|
|
description: 'Update an opportunity',
|
|
action: 'Update an opportunity',
|
|
},
|
|
],
|
|
default: 'create',
|
|
},
|
|
];
|
|
|
|
export const opportunityFields: INodeProperties[] = [
|
|
|
|
/* -------------------------------------------------------------------------- */
|
|
/* opportunity:create */
|
|
/* -------------------------------------------------------------------------- */
|
|
{
|
|
// eslint-disable-next-line n8n-nodes-base/node-param-display-name-wrong-for-dynamic-options
|
|
displayName: 'Match Against',
|
|
name: 'externalId',
|
|
type: 'options',
|
|
typeOptions: {
|
|
loadOptionsMethod: 'getExternalIdFields',
|
|
loadOptionsDependsOn: [
|
|
'resource',
|
|
],
|
|
},
|
|
required: true,
|
|
default: '',
|
|
displayOptions: {
|
|
show: {
|
|
resource: [
|
|
'opportunity',
|
|
],
|
|
operation: [
|
|
'upsert',
|
|
],
|
|
},
|
|
},
|
|
description: 'The field to check to see if the opportunity already exists. Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code-examples/expressions/">expression</a>.',
|
|
},
|
|
{
|
|
displayName: 'Value to Match',
|
|
name: 'externalIdValue',
|
|
type: 'string',
|
|
required: true,
|
|
default: '',
|
|
displayOptions: {
|
|
show: {
|
|
resource: [
|
|
'opportunity',
|
|
],
|
|
operation: [
|
|
'upsert',
|
|
],
|
|
},
|
|
},
|
|
description: 'If this value exists in the \'match against\' field, update the opportunity. Otherwise create a new one.',
|
|
},
|
|
{
|
|
displayName: 'Name',
|
|
name: 'name',
|
|
type: 'string',
|
|
required: true,
|
|
default: '',
|
|
displayOptions: {
|
|
show: {
|
|
resource: [
|
|
'opportunity',
|
|
],
|
|
operation: [
|
|
'create',
|
|
'upsert',
|
|
],
|
|
},
|
|
},
|
|
description: 'Required. Last name of the opportunity. Limited to 80 characters.',
|
|
},
|
|
{
|
|
displayName: 'Close Date',
|
|
name: 'closeDate',
|
|
type: 'dateTime',
|
|
required: true,
|
|
default: '',
|
|
displayOptions: {
|
|
show: {
|
|
resource: [
|
|
'opportunity',
|
|
],
|
|
operation: [
|
|
'create',
|
|
'upsert',
|
|
],
|
|
},
|
|
},
|
|
description: 'Required. Date when the opportunity is expected to close.',
|
|
},
|
|
{
|
|
displayName: 'Stage Name or ID',
|
|
name: 'stageName',
|
|
type: 'options',
|
|
typeOptions: {
|
|
loadOptionsMethod: 'getStages',
|
|
},
|
|
required: true,
|
|
default: '',
|
|
displayOptions: {
|
|
show: {
|
|
resource: [
|
|
'opportunity',
|
|
],
|
|
operation: [
|
|
'create',
|
|
'upsert',
|
|
],
|
|
},
|
|
},
|
|
description: 'Required. Date when the opportunity is expected to close. Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code-examples/expressions/">expression</a>.',
|
|
},
|
|
{
|
|
displayName: 'Additional Fields',
|
|
name: 'additionalFields',
|
|
type: 'collection',
|
|
placeholder: 'Add Field',
|
|
default: {},
|
|
displayOptions: {
|
|
show: {
|
|
resource: [
|
|
'opportunity',
|
|
],
|
|
operation: [
|
|
'create',
|
|
'upsert',
|
|
],
|
|
},
|
|
},
|
|
options: [
|
|
{
|
|
displayName: 'Account Name or ID',
|
|
name: 'accountId',
|
|
type: 'options',
|
|
default: '',
|
|
typeOptions: {
|
|
loadOptionsMethod: 'getAccounts',
|
|
},
|
|
description: 'ID of the account associated with this opportunity. Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code-examples/expressions/">expression</a>.',
|
|
},
|
|
{
|
|
displayName: 'Amount',
|
|
name: 'amount',
|
|
type: 'number',
|
|
typeOptions: {
|
|
numberPrecision: 2,
|
|
},
|
|
default: '',
|
|
description: 'Estimated total sale amount',
|
|
},
|
|
{
|
|
displayName: 'Campaign Name or ID',
|
|
name: 'campaignId',
|
|
type: 'options',
|
|
typeOptions: {
|
|
loadOptionsMethod: 'getCampaigns',
|
|
},
|
|
default: '',
|
|
description: 'ID of the campaign that needs to be fetched. Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code-examples/expressions/">expression</a>.',
|
|
},
|
|
{
|
|
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 Name or ID',
|
|
name: 'fieldId',
|
|
type: 'options',
|
|
typeOptions: {
|
|
loadOptionsMethod: 'getCustomFields',
|
|
},
|
|
default: '',
|
|
description: 'The ID of the field to add custom field to. Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code-examples/expressions/">expression</a>.',
|
|
},
|
|
{
|
|
displayName: 'Value',
|
|
name: 'value',
|
|
type: 'string',
|
|
default: '',
|
|
description: 'The value to set on custom field',
|
|
},
|
|
],
|
|
},
|
|
],
|
|
},
|
|
{
|
|
displayName: 'Description',
|
|
name: 'description',
|
|
type: 'string',
|
|
default: '',
|
|
description: 'A description of the opportunity. Label is Contact Description. Limit: 32 KB.',
|
|
},
|
|
{
|
|
displayName: 'Forecast Category Name',
|
|
name: 'forecastCategoryName',
|
|
type: 'string',
|
|
default: '',
|
|
description: 'It is implied, but not directly controlled, by the StageName field',
|
|
},
|
|
{
|
|
displayName: 'Lead Source Name or ID',
|
|
name: 'leadSource',
|
|
type: 'options',
|
|
typeOptions: {
|
|
loadOptionsMethod: 'getLeadSources',
|
|
},
|
|
default: '',
|
|
description: 'Source from which the lead was obtained. Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code-examples/expressions/">expression</a>.',
|
|
},
|
|
{
|
|
displayName: 'Next Step',
|
|
name: 'nextStep',
|
|
type: 'string',
|
|
default: '',
|
|
description: 'Description of next task in closing opportunity. Limit: 255 characters.',
|
|
},
|
|
{
|
|
displayName: 'Owner Name or ID',
|
|
name: 'owner',
|
|
type: 'options',
|
|
typeOptions: {
|
|
loadOptionsMethod: 'getUsers',
|
|
},
|
|
default: '',
|
|
description: 'The owner of the opportunity. Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code-examples/expressions/">expression</a>.',
|
|
},
|
|
{
|
|
displayName: 'Phone',
|
|
name: 'phone',
|
|
type: 'string',
|
|
default: '',
|
|
description: 'Phone number for the opportunity',
|
|
},
|
|
{
|
|
displayName: 'Pricebook2 ID',
|
|
name: 'pricebook2Id',
|
|
type: 'string',
|
|
default: '',
|
|
description: 'ID of a related Pricebook2 object',
|
|
},
|
|
{
|
|
displayName: 'Probability',
|
|
name: 'probability',
|
|
type: 'number',
|
|
typeOptions: {
|
|
numberPrecision: 1,
|
|
},
|
|
default: '',
|
|
description: 'Percentage of estimated confidence in closing the opportunity',
|
|
},
|
|
{
|
|
displayName: 'Type',
|
|
name: 'type',
|
|
type: 'options',
|
|
default: '',
|
|
options: [
|
|
{
|
|
name: 'Business',
|
|
value: 'Business',
|
|
},
|
|
{
|
|
name: 'New Business',
|
|
value: 'New Business',
|
|
},
|
|
],
|
|
description: 'Type of opportunity. For example, Existing Business or New Business. Label is Opportunity Type.',
|
|
},
|
|
],
|
|
},
|
|
|
|
/* -------------------------------------------------------------------------- */
|
|
/* opportunity:update */
|
|
/* -------------------------------------------------------------------------- */
|
|
{
|
|
displayName: 'Opportunity ID',
|
|
name: 'opportunityId',
|
|
type: 'string',
|
|
required: true,
|
|
default: '',
|
|
displayOptions: {
|
|
show: {
|
|
resource: [
|
|
'opportunity',
|
|
],
|
|
operation: [
|
|
'update',
|
|
],
|
|
},
|
|
},
|
|
description: 'ID of opportunity that needs to be fetched',
|
|
},
|
|
{
|
|
displayName: 'Update Fields',
|
|
name: 'updateFields',
|
|
type: 'collection',
|
|
placeholder: 'Add Field',
|
|
default: {},
|
|
displayOptions: {
|
|
show: {
|
|
resource: [
|
|
'opportunity',
|
|
],
|
|
operation: [
|
|
'update',
|
|
],
|
|
},
|
|
},
|
|
options: [
|
|
{
|
|
displayName: 'Account Name or ID',
|
|
name: 'accountId',
|
|
type: 'options',
|
|
default: '',
|
|
typeOptions: {
|
|
loadOptionsMethod: 'getAccounts',
|
|
},
|
|
description: 'ID of the account associated with this opportunity. Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code-examples/expressions/">expression</a>.',
|
|
},
|
|
{
|
|
displayName: 'Amount',
|
|
name: 'amount',
|
|
type: 'number',
|
|
typeOptions: {
|
|
numberPrecision: 2,
|
|
},
|
|
default: '',
|
|
description: 'Estimated total sale amount',
|
|
},
|
|
{
|
|
displayName: 'Campaign Name or ID',
|
|
name: 'campaignId',
|
|
type: 'options',
|
|
typeOptions: {
|
|
loadOptionsMethod: 'getCampaigns',
|
|
},
|
|
default: '',
|
|
description: 'ID of the campaign that needs to be fetched. Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code-examples/expressions/">expression</a>.',
|
|
},
|
|
{
|
|
displayName: 'Close Date',
|
|
name: 'closeDate',
|
|
type: 'dateTime',
|
|
default: '',
|
|
description: 'Required. Date when the opportunity is expected to close.',
|
|
},
|
|
{
|
|
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 Name or ID',
|
|
name: 'fieldId',
|
|
type: 'options',
|
|
typeOptions: {
|
|
loadOptionsMethod: 'getCustomFields',
|
|
},
|
|
default: '',
|
|
description: 'The ID of the field to add custom field to. Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code-examples/expressions/">expression</a>.',
|
|
},
|
|
{
|
|
displayName: 'Value',
|
|
name: 'value',
|
|
type: 'string',
|
|
default: '',
|
|
description: 'The value to set on custom field',
|
|
},
|
|
],
|
|
},
|
|
],
|
|
},
|
|
{
|
|
displayName: 'Description',
|
|
name: 'description',
|
|
type: 'string',
|
|
default: '',
|
|
description: 'A description of the opportunity. Label is Contact Description. Limit: 32 KB.',
|
|
},
|
|
{
|
|
displayName: 'Forecast Category Name',
|
|
name: 'forecastCategoryName',
|
|
type: 'string',
|
|
default: '',
|
|
description: 'It is implied, but not directly controlled, by the StageName field',
|
|
},
|
|
{
|
|
displayName: 'Lead Source Name or ID',
|
|
name: 'leadSource',
|
|
type: 'options',
|
|
typeOptions: {
|
|
loadOptionsMethod: 'getLeadSources',
|
|
},
|
|
default: '',
|
|
description: 'Source from which the lead was obtained. Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code-examples/expressions/">expression</a>.',
|
|
},
|
|
{
|
|
displayName: 'Name',
|
|
name: 'name',
|
|
type: 'string',
|
|
default: '',
|
|
description: 'Required. Last name of the opportunity. Limited to 80 characters.',
|
|
},
|
|
{
|
|
displayName: 'Next Step',
|
|
name: 'nextStep',
|
|
type: 'string',
|
|
default: '',
|
|
description: 'Description of next task in closing opportunity. Limit: 255 characters.',
|
|
},
|
|
{
|
|
displayName: 'Owner Name or ID',
|
|
name: 'owner',
|
|
type: 'options',
|
|
typeOptions: {
|
|
loadOptionsMethod: 'getUsers',
|
|
},
|
|
default: '',
|
|
description: 'The owner of the opportunity. Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code-examples/expressions/">expression</a>.',
|
|
},
|
|
{
|
|
displayName: 'Phone',
|
|
name: 'phone',
|
|
type: 'string',
|
|
default: '',
|
|
description: 'Phone number for the opportunity',
|
|
},
|
|
{
|
|
displayName: 'Pricebook2 ID',
|
|
name: 'pricebook2Id',
|
|
type: 'string',
|
|
default: '',
|
|
description: 'ID of a related Pricebook2 object',
|
|
},
|
|
{
|
|
displayName: 'Probability',
|
|
name: 'probability',
|
|
type: 'number',
|
|
typeOptions: {
|
|
numberPrecision: 1,
|
|
},
|
|
default: '',
|
|
description: 'Percentage of estimated confidence in closing the opportunity',
|
|
},
|
|
{
|
|
displayName: 'Stage Name or ID',
|
|
name: 'stageName',
|
|
type: 'options',
|
|
typeOptions: {
|
|
loadOptionsMethod: 'getStages',
|
|
},
|
|
default: '',
|
|
description: 'Required. Date when the opportunity is expected to close. Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code-examples/expressions/">expression</a>.',
|
|
},
|
|
{
|
|
displayName: 'Type',
|
|
name: 'type',
|
|
type: 'options',
|
|
default: '',
|
|
options: [
|
|
{
|
|
name: 'Business',
|
|
value: 'Business',
|
|
},
|
|
{
|
|
name: 'New Business',
|
|
value: 'New Business',
|
|
},
|
|
],
|
|
description: 'Type of opportunity. For example, Existing Business or New Business. Label is Opportunity Type.',
|
|
},
|
|
],
|
|
},
|
|
|
|
/* -------------------------------------------------------------------------- */
|
|
/* opportunity:get */
|
|
/* -------------------------------------------------------------------------- */
|
|
{
|
|
displayName: 'Opportunity ID',
|
|
name: 'opportunityId',
|
|
type: 'string',
|
|
required: true,
|
|
default: '',
|
|
displayOptions: {
|
|
show: {
|
|
resource: [
|
|
'opportunity',
|
|
],
|
|
operation: [
|
|
'get',
|
|
],
|
|
},
|
|
},
|
|
description: 'ID of opportunity that needs to be fetched',
|
|
},
|
|
|
|
/* -------------------------------------------------------------------------- */
|
|
/* opportunity:delete */
|
|
/* -------------------------------------------------------------------------- */
|
|
{
|
|
displayName: 'Opportunity ID',
|
|
name: 'opportunityId',
|
|
type: 'string',
|
|
required: true,
|
|
default: '',
|
|
displayOptions: {
|
|
show: {
|
|
resource: [
|
|
'opportunity',
|
|
],
|
|
operation: [
|
|
'delete',
|
|
],
|
|
},
|
|
},
|
|
description: 'ID of opportunity that needs to be fetched',
|
|
},
|
|
|
|
/* -------------------------------------------------------------------------- */
|
|
/* opportunity:getAll */
|
|
/* -------------------------------------------------------------------------- */
|
|
{
|
|
displayName: 'Return All',
|
|
name: 'returnAll',
|
|
type: 'boolean',
|
|
displayOptions: {
|
|
show: {
|
|
resource: [
|
|
'opportunity',
|
|
],
|
|
operation: [
|
|
'getAll',
|
|
],
|
|
},
|
|
},
|
|
default: false,
|
|
description: 'Whether to return all results or only up to a given limit',
|
|
},
|
|
{
|
|
displayName: 'Limit',
|
|
name: 'limit',
|
|
type: 'number',
|
|
displayOptions: {
|
|
show: {
|
|
resource: [
|
|
'opportunity',
|
|
],
|
|
operation: [
|
|
'getAll',
|
|
],
|
|
returnAll: [
|
|
false,
|
|
],
|
|
},
|
|
},
|
|
typeOptions: {
|
|
minValue: 1,
|
|
maxValue: 100,
|
|
},
|
|
default: 50,
|
|
description: 'Max number of results to return',
|
|
},
|
|
{
|
|
displayName: 'Options',
|
|
name: 'options',
|
|
type: 'collection',
|
|
placeholder: 'Add Field',
|
|
default: {},
|
|
displayOptions: {
|
|
show: {
|
|
resource: [
|
|
'opportunity',
|
|
],
|
|
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 or ID',
|
|
name: 'field',
|
|
type: 'options',
|
|
typeOptions: {
|
|
loadOptionsMethod: 'getOpportunityFields',
|
|
},
|
|
default: '',
|
|
description: 'For date, number, or boolean, please use expressions. Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code-examples/expressions/">expression</a>.',
|
|
},
|
|
// eslint-disable-next-line n8n-nodes-base/node-param-operation-without-no-data-expression
|
|
{
|
|
displayName: 'Operation',
|
|
name: 'operation',
|
|
type: 'options',
|
|
options: [
|
|
{
|
|
name: '<',
|
|
value: '<',
|
|
},
|
|
{
|
|
name: '<=',
|
|
value: '<=',
|
|
},
|
|
{
|
|
name: '=',
|
|
value: 'equal',
|
|
},
|
|
{
|
|
name: '>',
|
|
value: '>',
|
|
},
|
|
{
|
|
name: '>=',
|
|
value: '>=',
|
|
},
|
|
],
|
|
default: 'equal',
|
|
},
|
|
{
|
|
displayName: 'Value',
|
|
name: 'value',
|
|
type: 'string',
|
|
default: '',
|
|
},
|
|
],
|
|
},
|
|
],
|
|
},
|
|
{
|
|
displayName: 'Fields',
|
|
name: 'fields',
|
|
type: 'string',
|
|
default: '',
|
|
description: 'Fields to include separated by ,',
|
|
},
|
|
],
|
|
},
|
|
|
|
/* -------------------------------------------------------------------------- */
|
|
/* opportunity:addNote */
|
|
/* -------------------------------------------------------------------------- */
|
|
{
|
|
displayName: 'Opportunity ID',
|
|
name: 'opportunityId',
|
|
type: 'string',
|
|
required: true,
|
|
default: '',
|
|
displayOptions: {
|
|
show: {
|
|
resource: [
|
|
'opportunity',
|
|
],
|
|
operation: [
|
|
'addNote',
|
|
],
|
|
},
|
|
},
|
|
description: 'ID of opportunity that needs to be fetched',
|
|
},
|
|
{
|
|
displayName: 'Title',
|
|
name: 'title',
|
|
type: 'string',
|
|
required: true,
|
|
default: '',
|
|
displayOptions: {
|
|
show: {
|
|
resource: [
|
|
'opportunity',
|
|
],
|
|
operation: [
|
|
'addNote',
|
|
],
|
|
},
|
|
},
|
|
description: 'Title of the note',
|
|
},
|
|
{
|
|
displayName: 'Options',
|
|
name: 'options',
|
|
type: 'collection',
|
|
placeholder: 'Add Field',
|
|
default: {},
|
|
displayOptions: {
|
|
show: {
|
|
resource: [
|
|
'opportunity',
|
|
],
|
|
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: 'Whether true, only the note owner or a user with the “Modify All Data” permission can view the note or query it via the API',
|
|
},
|
|
{
|
|
displayName: 'Owner Name or ID',
|
|
name: 'owner',
|
|
type: 'options',
|
|
typeOptions: {
|
|
loadOptionsMethod: 'getUsers',
|
|
},
|
|
default: '',
|
|
description: 'ID of the user who owns the note. Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code-examples/expressions/">expression</a>.',
|
|
},
|
|
],
|
|
},
|
|
];
|