n8n/packages/nodes-base/nodes/HighLevel/description/OpportunityDescription.ts

741 lines
14 KiB
TypeScript
Raw Normal View History

feat(HighLevel Node): Add HighLevel node * HighLevel Node & Credentials with basic Get/GetAll contacts * moved contact description into subfolder * improving all HighLevel contact crud operations * Get All Contacts request filters and options * Get All Contacts request operation pagination * Get All Contacts pagination with rootProperty * fixing contact operations lint error node-param-options-type-unsorted-items * Get All Contact pagination using response total to terminate loop * Get All Contacts pagination using qs startAfterId and startAfter instead of nextPageUrl * cleanup ContactDescription.ts operations * added OpportunityDescription.ts Get All Operation * added PipelineDescription.ts Get All pipelines (pagination no supported) * GenericFunctions.ts created highLevelApiPagination method * removed returnAll from getAll pipelines because pagination not supported * minor improvement using IPostReceiveRootProperty Interface * added TaskDescription.ts GetAll operation * TaskDescription get operation * task delete operation * ContactDescription fixing duplicate additionalFields * OpportunityDescription.ts adding filters for get all operation * opportunity get and delete operation * opportunity create additional fields * task create with additionalFields * create opportunity added missing status * pagination resource mapping; create opportunity for contact email/phone/id * create task format field dueDate to suppressMilliseconds * opportunity's pipeline options with loadOptions * fixed task dueDate; task update operation * added contact dnd fields * added contact tags * add contact source parameter * using returnAll Tasks with undocumented limit property * add contact customField with loadOptions * task dueDate preSendAction throw required error * opportunity stageId using getPipelineStages method * improve update contacts operation; renaming identifier to contactId * contact tasks renamed contactIdentifier to contactId and identifier to taskId * delete unused postReceiveAction * getTaskPostReceiceAction to inject contactId into items * remove source field from update contact because not supported * renaming opportunities pipelineIdentifier to pipelineId * opportunity parameter reordering * opportunity update operation * opportunity renamed "Identifier" to "Opporituny ID" * create opportunity additional field tags * opportunity create/update additional fields * opportunity update contactIdentifier * deleted pipeline getAll resource; cleanup generic functions; * opportunity getAll option stageId use getPipelineStages * opportunity assignedTo options use loadOptionsMethod getUsers * added loadOptions description ''Choose from the list, or specify an ID [...]' * getAll Tasks removing output maxResults * highLevelApiRequest add IPollFunctions * add HighLevelTriggerNode * add highLevelOAuth2Api credentials * revert from v2 oauth2 back to apiKey v1 (incompatible client-oauth2) * delete run.sh (was commited by accidant) * removed HighLevelTrigger.node.ts (polling) until we support API V2 webhooks * task additionalFields in alphabetical order; task assignedTo using loadOptions getUsers * contact additionalFields/updateFields/filters in alphabetical order * opportunity additionalFields/fields in alphabetical order * :zap: linter fixes, formating * :zap: fixed deprecated auth * :zap: lock file and auth fix * :zap: linter fixes * :zap: requestWithAuthentication in highLevelApiRequest * :zap: timeZones autoload and naming fixes * contact property dnd - improved display name and description * contact property dnd - improved display name and description * contact create/update pre send action to validate email/phone * updated description for contact lookup email and phone parameters * opportunity monetary value - removed getAll filter (doesn't work) - added param description * opportunity getAll startDate and endDate to type dateTime and dateTimeToEpochPreSendAction * loadOption getTimezones() using /timezones and not moment.tz.names() * improved description for opportunity parameter assignedTo * added hint to opportunity param contactIdentifier "there can only be one..." * added contact phone description and placeholder * contact renamed operation "create" to "create or update" and added notice * update opportunity - prefetch fields title/status required by api * create/update task splitting up additionalFields to prep update changes * update task- prefetch fields title/dueDate required by api * linter fixes * :zap: improvements * :zap: updated autoloaded parameters names to follow convention * update opportunity added hint "You cannot update an opportunity's pipeline ID." Co-authored-by: Michael Kret <michael.k@radency.com>
2022-08-30 02:25:06 -07:00
import { INodeProperties } from 'n8n-workflow';
import {
contactIdentifierPreSendAction,
dateTimeToEpochPreSendAction,
opportunityUpdatePreSendAction,
splitTagsPreSendAction,
} from '../GenericFunctions';
export const opportunityOperations: INodeProperties[] = [
{
displayName: 'Operation',
name: 'operation',
type: 'options',
noDataExpression: true,
displayOptions: {
show: {
resource: ['opportunity'],
},
},
options: [
{
name: 'Create',
value: 'create',
routing: {
send: {
preSend: [splitTagsPreSendAction],
},
request: {
method: 'POST',
url: '=/pipelines/{{$parameter.pipelineId}}/opportunities',
},
},
action: 'Create an opportunity',
},
{
name: 'Delete',
value: 'delete',
routing: {
request: {
method: 'DELETE',
url: '=/pipelines/{{$parameter.pipelineId}}/opportunities/{{$parameter.opportunityId}}',
},
output: {
postReceive: [
{
type: 'set',
properties: {
value: '={{ { "success": true } }}',
},
},
],
},
},
action: 'Delete an opportunity',
},
{
name: 'Get',
value: 'get',
routing: {
request: {
method: 'GET',
url: '=/pipelines/{{$parameter.pipelineId}}/opportunities/{{$parameter.opportunityId}}',
},
},
action: 'Get an opportunity',
},
{
name: 'Get All',
value: 'getAll',
routing: {
request: {
method: 'GET',
url: '=/pipelines/{{$parameter.pipelineId}}/opportunities',
},
send: {
paginate: true,
},
},
action: 'Get all opportunities',
},
{
name: 'Update',
value: 'update',
routing: {
request: {
method: 'PUT',
url: '=/pipelines/{{$parameter.pipelineId}}/opportunities/{{$parameter.opportunityId}}',
},
send: {
preSend: [opportunityUpdatePreSendAction, splitTagsPreSendAction],
},
},
action: 'Update an opportunity',
},
],
default: 'create',
},
];
const pipelineId: INodeProperties = {
displayName: 'Pipeline Name or ID',
name: 'pipelineId',
type: 'options',
displayOptions: {
show: {
resource: ['opportunity'],
operation: ['create', 'delete', 'get', 'getAll', 'update'],
},
},
description:
'Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/nodes/expressions.html#expressions">expression</a>',
typeOptions: {
loadOptions: {
routing: {
request: {
url: '/pipelines',
method: 'GET',
},
output: {
postReceive: [
{
type: 'rootProperty',
properties: {
property: 'pipelines',
},
},
{
type: 'setKeyValue',
properties: {
name: '={{$responseItem.name}}',
value: '={{$responseItem.id}}',
},
},
{
type: 'sort',
properties: {
key: 'name',
},
},
],
},
},
},
},
default: '',
};
const createProperties: INodeProperties[] = [
{
displayName: 'Stage Name or ID',
name: 'stageId',
type: 'options',
required: true,
description:
'Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code-examples/expressions/">expression</a>',
displayOptions: {
show: {
resource: ['opportunity'],
operation: ['create'],
},
},
default: '',
typeOptions: {
loadOptionsDependsOn: ['pipelineId'],
loadOptionsMethod: 'getPipelineStages',
},
routing: {
send: {
type: 'body',
property: 'stageId',
},
},
},
{
displayName: 'Contact Identifier',
name: 'contactIdentifier',
required: true,
type: 'string',
description: 'Either Email, Phone or Contact ID',
hint: 'There can only be one opportunity for each contact.',
displayOptions: {
show: {
resource: ['opportunity'],
operation: ['create'],
},
},
default: '',
routing: {
send: {
preSend: [contactIdentifierPreSendAction],
},
},
},
{
displayName: 'Title',
name: 'title',
type: 'string',
required: true,
displayOptions: {
show: {
resource: ['opportunity'],
operation: ['create'],
},
},
default: '',
routing: {
send: {
type: 'body',
property: 'title',
},
},
},
{
displayName: 'Status',
name: 'status',
type: 'options',
required: true,
displayOptions: {
show: {
resource: ['opportunity'],
operation: ['create'],
},
},
options: [
{
name: 'Open',
value: 'open',
},
{
name: 'Won',
value: 'won',
},
{
name: 'Lost',
value: 'lost',
},
{
name: 'Abandoned',
value: 'abandoned',
},
],
default: 'open',
routing: {
send: {
type: 'body',
property: 'status',
},
},
},
{
displayName: 'Additional Fields',
name: 'additionalFields',
type: 'collection',
placeholder: 'Add Field',
default: {},
displayOptions: {
show: {
resource: ['opportunity'],
operation: ['create'],
},
},
options: [
{
// eslint-disable-next-line n8n-nodes-base/node-param-display-name-wrong-for-dynamic-options
displayName: 'Assigned To',
name: 'assignedTo',
type: 'options',
default: '',
// eslint-disable-next-line n8n-nodes-base/node-param-description-wrong-for-dynamic-options
description:
'Choose staff member from the list, or specify an ID using an <a href="https://docs.n8n.io/code-examples/expressions/">expression</a>',
typeOptions: {
loadOptionsMethod: 'getUsers',
},
routing: {
send: {
type: 'body',
property: 'assignedTo',
},
},
},
{
displayName: 'Company Name',
name: 'companyName',
type: 'string',
default: '',
routing: {
send: {
type: 'body',
property: 'companyName',
},
},
},
{
displayName: 'Monetary Value',
name: 'monetaryValue',
type: 'number',
default: '',
description: 'Monetary value of lead opportunity',
routing: {
send: {
type: 'body',
property: 'monetaryValue',
},
},
},
{
displayName: 'Name',
name: 'name',
type: 'string',
default: '',
placeholder: 'e.g. John Deo',
routing: {
send: {
type: 'body',
property: 'name',
},
},
},
{
displayName: 'Tags',
name: 'tags',
type: 'string',
hint: 'Comma separated list of tags, array of strings can be set in expression',
default: '',
routing: {
send: {
type: 'body',
property: 'tags',
},
},
},
],
},
];
const deleteProperties: INodeProperties[] = [
{
displayName: 'Opportunity ID',
name: 'opportunityId',
type: 'string',
required: true,
displayOptions: {
show: {
resource: ['opportunity'],
operation: ['delete'],
},
},
default: '',
},
];
const getProperties: INodeProperties[] = [
{
displayName: 'Opportunity ID',
name: 'opportunityId',
type: 'string',
required: true,
displayOptions: {
show: {
resource: ['opportunity'],
operation: ['get'],
},
},
default: '',
},
];
const getAllProperties: INodeProperties[] = [
{
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: 20,
routing: {
send: {
type: 'query',
property: 'limit',
},
},
description: 'Max number of results to return',
},
{
displayName: 'Filters',
name: 'filters',
type: 'collection',
placeholder: 'Add Filter',
default: {},
displayOptions: {
show: {
resource: ['opportunity'],
operation: ['getAll'],
},
},
options: [
{
// eslint-disable-next-line n8n-nodes-base/node-param-display-name-wrong-for-dynamic-options
displayName: 'Assigned To',
name: 'assignedTo',
type: 'options',
default: '',
// eslint-disable-next-line n8n-nodes-base/node-param-description-wrong-for-dynamic-options
description:
'Choose staff member from the list, or specify an ID using an <a href="https://docs.n8n.io/code-examples/expressions/">expression</a>',
typeOptions: {
loadOptionsMethod: 'getUsers',
},
routing: {
send: {
type: 'query',
property: 'assignedTo',
},
},
},
{
displayName: 'Campaign ID',
name: 'campaignId',
type: 'string',
default: '',
routing: {
send: {
type: 'query',
property: 'campaignId',
},
},
},
{
displayName: 'End Date',
name: 'endDate',
type: 'dateTime',
default: '',
routing: {
send: {
type: 'query',
property: 'endDate',
preSend: [dateTimeToEpochPreSendAction],
},
},
},
// api should filter by monetary value but doesn't
// {
// displayName: 'Monetary Value',
// name: 'monetaryValue',
// type: 'number',
// default: '',
// routing: {
// send: {
// type: 'query',
// property: 'monetaryValue',
// },
// },
// },
{
displayName: 'Stage Name or ID',
name: 'stageId',
type: 'options',
default: '',
description:
'Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code-examples/expressions/">expression</a>',
typeOptions: {
loadOptionsDependsOn: ['pipelineId'],
loadOptionsMethod: 'getPipelineStages',
},
routing: {
send: {
type: 'query',
property: 'stageId',
},
},
},
{
displayName: 'Start Date',
name: 'startDate',
type: 'dateTime',
default: '',
routing: {
send: {
type: 'query',
property: 'startDate',
preSend: [dateTimeToEpochPreSendAction],
},
},
},
{
displayName: 'Status',
name: 'status',
type: 'options',
options: [
{
name: 'Open',
value: 'open',
},
{
name: 'Won',
value: 'won',
},
{
name: 'Lost',
value: 'lost',
},
{
name: 'Abandoned',
value: 'abandoned',
},
],
default: 'open',
routing: {
send: {
type: 'query',
property: 'status',
},
},
},
{
displayName: 'Query',
name: 'query',
type: 'string',
default: '',
description:
'Query will search on these fields: Name, Phone, Email, Tags, and Company Name',
routing: {
send: {
type: 'query',
property: 'query',
},
},
},
],
},
];
const updateProperties: INodeProperties[] = [
{
displayName: 'Opportunity ID',
name: 'opportunityId',
type: 'string',
required: true,
hint: 'You cannot update an opportunity\'s pipeline ID.',
displayOptions: {
show: {
resource: ['opportunity'],
operation: ['update'],
},
},
default: '',
},
{
displayName: 'Update Fields',
name: 'updateFields',
type: 'collection',
placeholder: 'Add Field',
default: {},
displayOptions: {
show: {
resource: ['opportunity'],
operation: ['update'],
},
},
options: [
{
// eslint-disable-next-line n8n-nodes-base/node-param-display-name-wrong-for-dynamic-options
displayName: 'Assigned To',
name: 'assignedTo',
type: 'options',
default: '',
// eslint-disable-next-line n8n-nodes-base/node-param-description-wrong-for-dynamic-options
description:
'Choose staff member from the list, or specify an ID using an <a href="https://docs.n8n.io/code-examples/expressions/">expression</a>',
typeOptions: {
loadOptionsMethod: 'getUsers',
},
routing: {
send: {
type: 'body',
property: 'assignedTo',
},
},
},
{
displayName: 'Company Name',
name: 'companyName',
type: 'string',
default: '',
routing: {
send: {
type: 'body',
property: 'companyName',
},
},
},
{
displayName: 'Contact Identifier',
name: 'contactIdentifier',
type: 'string',
description: 'Either Email, Phone or Contact ID',
hint: 'There can only be one opportunity for each contact.',
default: '',
routing: {
send: {
preSend: [contactIdentifierPreSendAction],
},
},
},
{
displayName: 'Monetary Value',
name: 'monetaryValue',
type: 'number',
default: '',
description: 'Monetary value of lead opportunity',
routing: {
send: {
type: 'body',
property: 'monetaryValue',
},
},
},
{
displayName: 'Name',
name: 'name',
type: 'string',
default: '',
placeholder: 'e.g. John Deo',
routing: {
send: {
type: 'body',
property: 'name',
},
},
},
{
displayName: 'Stage Name or ID',
name: 'stageId',
type: 'options',
default: '',
description:
'Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code-examples/expressions/">expression</a>',
typeOptions: {
loadOptionsDependsOn: ['pipelineId'],
loadOptionsMethod: 'getPipelineStages',
},
routing: {
send: {
type: 'body',
property: 'stageId',
},
},
},
{
displayName: 'Status',
name: 'status',
type: 'options',
options: [
{
name: 'Open',
value: 'open',
},
{
name: 'Won',
value: 'won',
},
{
name: 'Lost',
value: 'lost',
},
{
name: 'Abandoned',
value: 'abandoned',
},
],
default: 'open',
routing: {
send: {
type: 'body',
property: 'status',
},
},
},
{
displayName: 'Title',
name: 'title',
type: 'string',
default: '',
routing: {
send: {
type: 'body',
property: 'title',
},
},
},
{
displayName: 'Tags',
name: 'tags',
type: 'string',
hint: 'Comma separated list of tags, array of strings can be set in expression',
default: '',
routing: {
send: {
type: 'body',
property: 'tags',
},
},
},
],
},
];
export const opportunityFields: INodeProperties[] = [
pipelineId,
...createProperties,
...updateProperties,
...deleteProperties,
...getProperties,
...getAllProperties,
];