mudhorn/n8n
1
0
Fork 0
mirror of https://github.com/n8n-io/n8n.git synced 2024-11-10 14:44:05 -08:00
Code Issues Actions Packages Projects Releases Wiki Activity
n8n/packages/nodes-base/nodes/Pipedrive/Pipedrive.node.ts

4980 lines
127 KiB
TypeScript
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

import type {
IDataObject,
IExecuteFunctions,
IHttpRequestMethods,
ILoadOptionsFunctions,
INodeExecutionData,
INodePropertyOptions,
INodeType,
INodeTypeDescription,
} from 'n8n-workflow';
import { NodeOperationError } from 'n8n-workflow';
import type { ICustomProperties } from './GenericFunctions';
import {
pipedriveApiRequest,
pipedriveApiRequestAllItems,
pipedriveEncodeCustomProperties,
pipedriveGetCustomProperties,
pipedriveResolveCustomProperties,
sortOptionParameters,
} from './GenericFunctions';
import { currencies } from './utils';
interface CustomProperty {
name: string;
value: string;
}
/**
* Add the additional fields to the body
*
* @param {IDataObject} body The body object to add fields to
* @param {IDataObject} additionalFields The fields to add
*/
function addAdditionalFields(body: IDataObject, additionalFields: IDataObject) {
for (const key of Object.keys(additionalFields)) {
if (
key === 'customProperties' &&
(additionalFields.customProperties as IDataObject).property !== undefined
) {
for (const customProperty of (additionalFields.customProperties as IDataObject)
.property! as CustomProperty[]) {
body[customProperty.name] = customProperty.value;
}
} else {
body[key] = additionalFields[key];
}
}
}
export class Pipedrive implements INodeType {
description: INodeTypeDescription = {
displayName: 'Pipedrive',
name: 'pipedrive',
icon: 'file:pipedrive.svg',
group: ['transform'],
version: 1,
subtitle: '={{$parameter["operation"] + ": " + $parameter["resource"]}}',
description: 'Create and edit data in Pipedrive',
defaults: {
name: 'Pipedrive',
},
inputs: ['main'],
outputs: ['main'],
credentials: [
{
name: 'pipedriveApi',
required: true,
displayOptions: {
show: {
authentication: ['apiToken'],
},
},
testedBy: {
request: {
method: 'GET',
url: '/users/me',
},
},
},
{
name: 'pipedriveOAuth2Api',
required: true,
displayOptions: {
show: {
authentication: ['oAuth2'],
},
},
},
],
requestDefaults: {
baseURL: 'https://api.pipedrive.com/v1',
url: '',
},
properties: [
{
displayName: 'Authentication',
name: 'authentication',
type: 'options',
options: [
{
name: 'API Token',
value: 'apiToken',
},
{
name: 'OAuth2',
value: 'oAuth2',
},
],
default: 'apiToken',
},
{
displayName: 'Resource',
name: 'resource',
type: 'options',
noDataExpression: true,
options: [
{
name: 'Activity',
value: 'activity',
},
{
name: 'Deal',
value: 'deal',
},
{
name: 'Deal Activity',
value: 'dealActivity',
},
{
name: 'Deal Product',
value: 'dealProduct',
},
{
name: 'File',
value: 'file',
},
{
name: 'Lead',
value: 'lead',
},
{
name: 'Note',
value: 'note',
},
{
name: 'Organization',
value: 'organization',
},
{
name: 'Person',
value: 'person',
},
{
name: 'Product',
value: 'product',
},
],
default: 'deal',
},
// ----------------------------------
// operations
// ----------------------------------
{
displayName: 'Operation',
name: 'operation',
type: 'options',
noDataExpression: true,
displayOptions: {
show: {
resource: ['activity'],
},
},
options: [
{
name: 'Create',
value: 'create',
description: 'Create an activity',
action: 'Create an activity',
},
{
name: 'Delete',
value: 'delete',
description: 'Delete an activity',
action: 'Delete an activity',
},
{
name: 'Get',
value: 'get',
description: 'Get data of an activity',
action: 'Get an activity',
},
{
name: 'Get Many',
value: 'getAll',
description: 'Get data of many activities',
action: 'Get many activities',
},
{
name: 'Update',
value: 'update',
description: 'Update an activity',
action: 'Update an activity',
},
],
default: 'create',
},
{
displayName: 'Operation',
name: 'operation',
type: 'options',
noDataExpression: true,
displayOptions: {
show: {
resource: ['deal'],
},
},
options: [
{
name: 'Create',
value: 'create',
description: 'Create a deal',
action: 'Create a deal',
},
{
name: 'Delete',
value: 'delete',
description: 'Delete a deal',
action: 'Delete a deal',
},
{
name: 'Duplicate',
value: 'duplicate',
description: 'Duplicate a deal',
action: 'Duplicate a deal',
},
{
name: 'Get',
value: 'get',
description: 'Get data of a deal',
action: 'Get a deal',
},
{
name: 'Get Many',
value: 'getAll',
description: 'Get data of many deals',
action: 'Get many deals',
},
{
name: 'Search',
value: 'search',
description: 'Search a deal',
action: 'Search a deal',
},
{
name: 'Update',
value: 'update',
description: 'Update a deal',
action: 'Update a deal',
},
],
default: 'create',
},
{
displayName: 'Operation',
name: 'operation',
type: 'options',
noDataExpression: true,
displayOptions: {
show: {
resource: ['dealActivity'],
},
},
options: [
{
name: 'Get Many',
value: 'getAll',
description: 'Get many activities of a deal',
action: 'Get many deal activities',
},
],
default: 'getAll',
},
{
displayName: 'Operation',
name: 'operation',
type: 'options',
noDataExpression: true,
displayOptions: {
show: {
resource: ['dealProduct'],
},
},
options: [
{
name: 'Add',
value: 'add',
description: 'Add a product to a deal',
action: 'Add a deal product',
},
{
name: 'Get Many',
value: 'getAll',
description: 'Get many products in a deal',
action: 'Get many deal products',
},
{
name: 'Remove',
value: 'remove',
description: 'Remove a product from a deal',
action: 'Remove a deal product',
},
{
name: 'Update',
value: 'update',
description: 'Update a product in a deal',
action: 'Update a deal product',
},
],
default: 'add',
},
{
displayName: 'Operation',
name: 'operation',
type: 'options',
noDataExpression: true,
displayOptions: {
show: {
resource: ['file'],
},
},
options: [
{
name: 'Create',
value: 'create',
description: 'Create a file',
action: 'Create a file',
},
{
name: 'Delete',
value: 'delete',
description: 'Delete a file',
action: 'Delete a file',
},
{
name: 'Download',
value: 'download',
description: 'Download a file',
action: 'Download a file',
},
{
name: 'Get',
value: 'get',
description: 'Get data of a file',
action: 'Get a file',
},
{
name: 'Update',
value: 'update',
description: 'Update file details',
action: 'update details of a file',
},
// {
// name: 'Get All',
// value: 'getAll',
// description: 'Get data of all file',
// },
// {
// name: 'Update',
// value: 'update',
// description: 'Update a file',
// },
],
default: 'create',
},
{
displayName: 'Operation',
name: 'operation',
type: 'options',
noDataExpression: true,
displayOptions: {
show: {
resource: ['lead'],
},
},
options: [
{
name: 'Create',
value: 'create',
description: 'Create a lead',
action: 'Create a lead',
},
{
name: 'Delete',
value: 'delete',
description: 'Delete a lead',
action: 'Delete a lead',
},
{
name: 'Get',
value: 'get',
description: 'Get data of a lead',
action: 'Get a lead',
},
{
name: 'Get Many',
value: 'getAll',
description: 'Get data of many leads',
action: 'Get many leads',
},
{
name: 'Update',
value: 'update',
description: 'Update a lead',
action: 'Update a lead',
},
],
default: 'create',
},
{
displayName: 'Operation',
name: 'operation',
type: 'options',
noDataExpression: true,
displayOptions: {
show: {
resource: ['note'],
},
},
options: [
{
name: 'Create',
value: 'create',
description: 'Create a note',
action: 'Create a note',
},
{
name: 'Delete',
value: 'delete',
description: 'Delete a note',
action: 'Delete a note',
},
{
name: 'Get',
value: 'get',
description: 'Get data of a note',
action: 'Get a note',
},
{
name: 'Get Many',
value: 'getAll',
description: 'Get data of many notes',
action: 'Get many notes',
},
{
name: 'Update',
value: 'update',
description: 'Update a note',
action: 'Update a note',
},
],
default: 'create',
},
{
displayName: 'Operation',
name: 'operation',
type: 'options',
noDataExpression: true,
displayOptions: {
show: {
resource: ['organization'],
},
},
options: [
{
name: 'Create',
value: 'create',
description: 'Create an organization',
action: 'Create an organization',
},
{
name: 'Delete',
value: 'delete',
description: 'Delete an organization',
action: 'Delete an organization',
},
{
name: 'Get',
value: 'get',
description: 'Get data of an organization',
action: 'Get an organization',
},
{
name: 'Get Many',
value: 'getAll',
description: 'Get data of many organizations',
action: 'Get many organizations',
},
{
name: 'Search',
value: 'search',
description: 'Search organizations',
action: 'Search an organization',
},
{
name: 'Update',
value: 'update',
description: 'Update an organization',
action: 'Update an organization',
},
],
default: 'create',
},
{
displayName: 'Operation',
name: 'operation',
type: 'options',
noDataExpression: true,
displayOptions: {
show: {
resource: ['person'],
},
},
options: [
{
name: 'Create',
value: 'create',
description: 'Create a person',
action: 'Create a person',
},
{
name: 'Delete',
value: 'delete',
description: 'Delete a person',
action: 'Delete a person',
},
{
name: 'Get',
value: 'get',
description: 'Get data of a person',
action: 'Get a person',
},
{
name: 'Get Many',
value: 'getAll',
description: 'Get data of many persons',
action: 'Get many people',
},
{
name: 'Search',
value: 'search',
description: 'Search all persons',
action: 'Search a person',
},
{
name: 'Update',
value: 'update',
description: 'Update a person',
action: 'Update a person',
},
],
default: 'create',
},
{
displayName: 'Operation',
name: 'operation',
type: 'options',
noDataExpression: true,
displayOptions: {
show: {
resource: ['product'],
},
},
options: [
{
name: 'Get Many',
value: 'getAll',
description: 'Get data of many products',
action: 'Get many products',
},
],
default: 'getAll',
},
// ----------------------------------
// Activity
// ----------------------------------
// ----------------------------------
// activity:create
// ----------------------------------
{
displayName: 'Subject',
name: 'subject',
type: 'string',
default: '',
required: true,
displayOptions: {
show: {
operation: ['create'],
resource: ['activity'],
},
},
description: 'The subject of the activity to create',
},
{
displayName: 'Done',
name: 'done',
type: 'options',
displayOptions: {
show: {
operation: ['create'],
resource: ['activity'],
},
},
options: [
{
name: 'Not Done',
value: '0',
},
{
name: 'Done',
value: '1',
},
],
default: '0',
description: 'Whether the activity is done or not',
},
{
displayName: 'Type',
name: 'type',
type: 'string',
default: '',
required: true,
displayOptions: {
show: {
operation: ['create'],
resource: ['activity'],
},
},
placeholder: 'call',
description: 'Type of the activity like "call", "meeting", etc',
},
{
displayName: 'Additional Fields',
name: 'additionalFields',
type: 'collection',
placeholder: 'Add Field',
displayOptions: {
show: {
operation: ['create'],
resource: ['activity'],
},
},
default: {},
options: [
{
displayName: 'Deal ID',
name: 'deal_id',
type: 'number',
default: 0,
description: 'ID of the deal this activity will be associated with',
},
{
displayName: 'Due Date',
name: 'due_date',
type: 'dateTime',
default: '',
description: 'Due Date to activity be done YYYY-MM-DD',
},
{
displayName: 'Note',
name: 'note',
type: 'string',
typeOptions: {
rows: 5,
},
default: '',
description: 'Note of the activity (HTML format)',
},
{
displayName: 'Organization Name or ID',
name: 'org_id',
type: 'options',
typeOptions: {
loadOptionsMethod: 'getOrganizationIds',
},
default: '',
description:
'ID of the organization this activity will be associated with. Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code-examples/expressions/">expression</a>.',
},
{
displayName: 'Person ID',
name: 'person_id',
type: 'number',
default: 0,
description: 'ID of the person this activity will be associated with',
},
{
displayName: 'User Name or ID',
name: 'user_id',
type: 'options',
typeOptions: {
loadOptionsMethod: 'getUserIds',
},
default: '',
description:
'ID of the active user whom the activity will be assigned to. If omitted, the activity will be assigned to the authorized user. Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code-examples/expressions/">expression</a>.',
},
{
displayName: 'Custom Properties',
name: 'customProperties',
placeholder: 'Add Custom Property',
description: 'Adds a custom property to set also values which have not been predefined',
type: 'fixedCollection',
typeOptions: {
multipleValues: true,
},
default: {},
options: [
{
name: 'property',
displayName: 'Property',
values: [
{
displayName: 'Property Name',
name: 'name',
type: 'string',
default: '',
description: 'Name of the property to set',
},
{
displayName: 'Property Value',
name: 'value',
type: 'string',
default: '',
description: 'Value of the property to set',
},
],
},
],
},
],
},
// ----------------------------------
// activity:delete
// ----------------------------------
{
displayName: 'Activity ID',
name: 'activityId',
type: 'number',
displayOptions: {
show: {
operation: ['delete'],
resource: ['activity'],
},
},
default: 0,
required: true,
description: 'ID of the activity to delete',
},
// ----------------------------------
// activity:get
// ----------------------------------
{
displayName: 'Activity ID',
name: 'activityId',
type: 'number',
displayOptions: {
show: {
operation: ['get'],
resource: ['activity'],
},
},
default: 0,
required: true,
description: 'ID of the activity to get',
},
// ----------------------------------
// activity:update
// ----------------------------------
{
displayName: 'Activity ID',
name: 'activityId',
type: 'number',
displayOptions: {
show: {
operation: ['update'],
resource: ['activity'],
},
},
default: 0,
required: true,
description: 'ID of the activity to update',
},
{
displayName: 'Update Fields',
name: 'updateFields',
type: 'collection',
placeholder: 'Add Field',
displayOptions: {
show: {
operation: ['update'],
resource: ['activity'],
},
},
default: {},
options: [
{
displayName: 'Busy Flag',
name: 'busy_flag',
type: 'boolean',
default: false,
description: 'Whether the user is set to busy during the activity',
},
{
displayName: 'Deal ID',
name: 'deal_id',
type: 'number',
default: 0,
description: 'ID of the deal this activity will be associated with',
},
{
displayName: 'Due Date',
name: 'due_date',
type: 'dateTime',
default: '',
description: 'Due Date to activity be done YYYY-MM-DD',
},
{
displayName: 'Done',
name: 'done',
type: 'options',
options: [
{
name: 'Not Done',
value: '0',
},
{
name: 'Done',
value: '1',
},
],
default: '0',
description: 'Whether the activity is done or not',
},
{
displayName: 'Note',
name: 'note',
type: 'string',
typeOptions: {
rows: 5,
},
default: '',
description: 'Note of the activity (HTML format)',
},
{
displayName: 'Organization Name or ID',
name: 'org_id',
type: 'options',
typeOptions: {
loadOptionsMethod: 'getOrganizationIds',
},
default: '',
description:
'ID of the organization this activity will be associated with. Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code-examples/expressions/">expression</a>.',
},
{
displayName: 'Person ID',
name: 'person_id',
type: 'number',
default: 0,
description: 'ID of the person this activity will be associated with',
},
{
displayName: 'Public Description',
name: 'public_description',
type: 'string',
default: '',
description:
'Additional details about the activity that is synced to your external calendar',
},
{
displayName: 'Subject',
name: 'subject',
type: 'string',
default: '',
description: 'The subject of the activity',
},
{
displayName: 'Type',
name: 'type',
type: 'string',
default: '',
placeholder: 'call',
description: 'Type of the activity like "call", "meeting", etc',
},
{
displayName: 'User Name or ID',
name: 'user_id',
type: 'options',
typeOptions: {
loadOptionsMethod: 'getUserIds',
},
default: '',
description:
'ID of the active user whom the activity will be assigned to. If omitted, the activity will be assigned to the authorized user. Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code-examples/expressions/">expression</a>.',
},
{
displayName: 'Custom Properties',
name: 'customProperties',
placeholder: 'Add Custom Property',
description: 'Adds a custom property to set also values which have not been predefined',
type: 'fixedCollection',
typeOptions: {
multipleValues: true,
},
default: {},
options: [
{
name: 'property',
displayName: 'Property',
values: [
{
displayName: 'Property Name',
name: 'name',
type: 'string',
default: '',
description: 'Name of the property to set',
},
{
displayName: 'Property Value',
name: 'value',
type: 'string',
default: '',
description: 'Value of the property to set',
},
],
},
],
},
],
},
// ----------------------------------
// deal
// ----------------------------------
// ----------------------------------
// deal:create
// ----------------------------------
{
displayName: 'Title',
name: 'title',
type: 'string',
default: '',
required: true,
displayOptions: {
show: {
operation: ['create'],
resource: ['deal'],
},
},
description: 'The title of the deal to create',
},
{
displayName: 'Associate With',
name: 'associateWith',
type: 'options',
options: [
{
name: 'Organization',
value: 'organization',
},
{
name: 'Person',
value: 'person',
},
],
default: 'organization',
description: 'Type of entity to link to this deal',
required: true,
displayOptions: {
show: {
resource: ['deal'],
operation: ['create'],
},
},
},
{
displayName: 'Organization ID',
name: 'org_id',
type: 'number',
default: 0,
description: 'ID of the organization this deal will be associated with',
required: true,
displayOptions: {
show: {
operation: ['create'],
resource: ['deal'],
associateWith: ['organization'],
},
},
},
{
displayName: 'Person ID',
name: 'person_id',
type: 'number',
default: 0,
description: 'ID of the person this deal will be associated with',
displayOptions: {
show: {
operation: ['create'],
resource: ['deal'],
associateWith: ['person'],
},
},
},
{
displayName: 'Additional Fields',
name: 'additionalFields',
type: 'collection',
placeholder: 'Add Field',
displayOptions: {
show: {
operation: ['create'],
resource: ['deal'],
},
},
default: {},
options: [
{
displayName: 'Currency',
name: 'currency',
type: 'string',
default: 'USD',
description:
'Currency of the deal. Accepts a 3-character currency code. Like EUR, USD, ...',
},
{
displayName: 'Custom Properties',
name: 'customProperties',
placeholder: 'Add Custom Property',
description: 'Adds a custom property to set also values which have not been predefined',
type: 'fixedCollection',
typeOptions: {
multipleValues: true,
},
default: {},
options: [
{
name: 'property',
displayName: 'Property',
values: [
{
displayName: 'Property Name or ID',
name: 'name',
type: 'options',
typeOptions: {
loadOptionsMethod: 'getDealCustomFields',
},
default: '',
description:
'Name of the property to set. Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code-examples/expressions/">expression</a>.',
},
{
displayName: 'Property Value',
name: 'value',
type: 'string',
default: '',
description: 'Value of the property to set',
},
],
},
],
},
{
displayName: 'Label Name or ID',
name: 'label',
type: 'options',
description:
'Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code-examples/expressions/">expression</a>',
typeOptions: {
loadOptionsMethod: 'getDealLabels',
},
default: '',
},
{
displayName: 'Lost Reason',
name: 'lost_reason',
type: 'string',
default: '',
description: 'Reason why the deal was lost',
},
{
displayName: 'Organization ID',
name: 'org_id',
type: 'number',
default: 0,
displayOptions: {
show: {
'/associateWith': ['person'],
},
},
description: 'ID of the organization this deal will be associated with',
},
{
displayName: 'Person ID',
name: 'person_id',
type: 'number',
default: 0,
displayOptions: {
show: {
'/associateWith': ['organization'],
},
},
description: 'ID of the person this deal will be associated with',
},
{
displayName: 'Probability',
name: 'probability',
type: 'number',
typeOptions: {
minValue: 0,
maxValue: 100,
},
default: 0,
description: 'Deal success probability percentage',
},
{
displayName: 'Stage Name or ID',
name: 'stage_id',
type: 'options',
typeOptions: {
loadOptionsMethod: 'getStageIds',
},
default: '',
description:
'ID of the stage this deal will be placed in a pipeline. If omitted, the deal will be placed in the first stage of the default pipeline. (PIPELINE > STAGE). Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code-examples/expressions/">expression</a>.',
},
{
displayName: 'Status',
name: 'status',
type: 'options',
options: [
{
name: 'Open',
value: 'open',
},
{
name: 'Won',
value: 'won',
},
{
name: 'Lost',
value: 'lost',
},
{
name: 'Deleted',
value: 'deleted',
},
],
default: 'open',
description:
'The status of the deal. If not provided it will automatically be set to "open".',
},
{
displayName: 'User Name or ID',
name: 'user_id',
type: 'options',
typeOptions: {
loadOptionsMethod: 'getUserIds',
},
default: '',
description:
'ID of the active user whom the activity will be assigned to. If omitted, the activity will be assigned to the authorized user. 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: 'number',
default: 0,
description: 'Value of the deal. If not set it will automatically be set to 0.',
},
{
displayName: 'Visible To',
name: 'visible_to',
type: 'options',
options: [
{
name: 'Owner & Followers (Private)',
value: '1',
},
{
name: 'Entire Company (Shared)',
value: '3',
},
],
default: '3',
description:
'Visibility of the deal. If omitted, visibility will be set to the default visibility setting of this item type for the authorized user.',
},
],
},
// ----------------------------------
// deal:delete
// ----------------------------------
{
displayName: 'Deal ID',
name: 'dealId',
type: 'number',
displayOptions: {
show: {
operation: ['delete'],
resource: ['deal'],
},
},
default: 0,
required: true,
description: 'ID of the deal to delete',
},
// ----------------------------------
// deal:duplicate
// ----------------------------------
{
displayName: 'Deal ID',
name: 'dealId',
type: 'number',
displayOptions: {
show: {
operation: ['duplicate'],
resource: ['deal'],
},
},
default: 0,
required: true,
description: 'ID of the deal to duplicate',
},
// ----------------------------------
// deal:get
// ----------------------------------
{
displayName: 'Deal ID',
name: 'dealId',
type: 'number',
displayOptions: {
show: {
operation: ['get'],
resource: ['deal'],
},
},
default: 0,
required: true,
description: 'ID of the deal to get',
},
// ----------------------------------
// deal:update
// ----------------------------------
{
displayName: 'Deal ID',
name: 'dealId',
type: 'number',
displayOptions: {
show: {
operation: ['update'],
resource: ['deal'],
},
},
default: 0,
required: true,
description: 'ID of the deal to update',
},
{
displayName: 'Update Fields',
name: 'updateFields',
type: 'collection',
placeholder: 'Add Field',
displayOptions: {
show: {
operation: ['update'],
resource: ['deal'],
},
},
default: {},
options: [
{
displayName: 'Currency',
name: 'currency',
type: 'string',
default: 'USD',
description:
'Currency of the deal. Accepts a 3-character currency code. Like EUR, USD, ...',
},
{
displayName: 'Custom Properties',
name: 'customProperties',
placeholder: 'Add Custom Property',
description: 'Adds a custom property to set also values which have not been predefined',
type: 'fixedCollection',
typeOptions: {
multipleValues: true,
},
default: {},
options: [
{
name: 'property',
displayName: 'Property',
values: [
{
displayName: 'Property Name or ID',
name: 'name',
type: 'options',
typeOptions: {
loadOptionsMethod: 'getDealCustomFields',
},
default: '',
description:
'Name of the custom field to set. Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code-examples/expressions/">expression</a>.',
},
{
displayName: 'Property Value',
name: 'value',
type: 'string',
default: '',
description: 'Value of the property to set',
},
],
},
],
},
{
displayName: 'User Name or ID',
name: 'user_id',
type: 'options',
typeOptions: {
loadOptionsMethod: 'getUserIds',
},
default: '',
description:
'ID of the active user whom the activity will be assigned to. If omitted, the activity will be assigned to the authorized user. Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code-examples/expressions/">expression</a>.',
},
{
displayName: 'Label Name or ID',
name: 'label',
type: 'options',
description:
'Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code-examples/expressions/">expression</a>',
typeOptions: {
loadOptionsMethod: 'getDealLabels',
},
default: '',
},
{
displayName: 'Lost Reason',
name: 'lost_reason',
type: 'string',
default: '',
description: 'Reason why the deal was lost',
},
{
displayName: 'Organization Name or ID',
name: 'org_id',
type: 'options',
typeOptions: {
loadOptionsMethod: 'getOrganizationIds',
},
default: '',
description:
'ID of the organization this deal will be associated with. Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code-examples/expressions/">expression</a>.',
},
{
displayName: 'Person ID',
name: 'person_id',
type: 'number',
default: 0,
description: 'ID of the person this deal will be associated with',
},
{
displayName: 'Probability',
name: 'probability',
type: 'number',
typeOptions: {
minValue: 0,
maxValue: 100,
},
default: 0,
description: 'Deal success probability percentage',
},
{
displayName: 'Stage Name or ID',
name: 'stage_id',
type: 'options',
typeOptions: {
loadOptionsMethod: 'getStageIds',
},
default: '',
description:
'ID of the stage this deal will be placed in a pipeline. If omitted, the deal will be placed in the first stage of the default pipeline. (PIPELINE > STAGE). Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code-examples/expressions/">expression</a>.',
},
{
displayName: 'Status',
name: 'status',
type: 'options',
options: [
{
name: 'Open',
value: 'open',
},
{
name: 'Won',
value: 'won',
},
{
name: 'Lost',
value: 'lost',
},
{
name: 'Deleted',
value: 'deleted',
},
],
default: 'open',
description:
'The status of the deal. If not provided it will automatically be set to "open".',
},
{
displayName: 'Title',
name: 'title',
type: 'string',
default: '',
description: 'The title of the deal',
},
{
displayName: 'Value',
name: 'value',
type: 'number',
default: 0,
description: 'Value of the deal. If not set it will automatically be set to 0.',
},
{
displayName: 'Visible To',
name: 'visible_to',
type: 'options',
options: [
{
name: 'Owner & Followers (Private)',
value: '1',
},
{
name: 'Entire Company (Shared)',
value: '3',
},
],
default: '3',
description:
'Visibility of the deal. If omitted, visibility will be set to the default visibility setting of this item type for the authorized user.',
},
],
},
// ----------------------------------
// dealProduct:add
// ----------------------------------
{
displayName: 'Deal Name or ID',
name: 'dealId',
type: 'options',
default: '',
typeOptions: {
loadOptionsMethod: 'getDeals',
},
required: true,
displayOptions: {
show: {
operation: ['add'],
resource: ['dealProduct'],
},
},
description:
'The ID of the deal to add a product to. Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code-examples/expressions/">expression</a>.',
},
{
displayName: 'Product Name or ID',
name: 'productId',
type: 'options',
default: '',
typeOptions: {
loadOptionsMethod: 'getProducts',
},
required: true,
displayOptions: {
show: {
operation: ['add'],
resource: ['dealProduct'],
},
},
description:
'The ID of the product to add to a deal. Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code-examples/expressions/">expression</a>.',
},
{
displayName: 'Item Price',
name: 'item_price',
type: 'number',
typeOptions: {
numberPrecision: 2,
},
default: 0.0,
required: true,
description: 'Price at which to add or update this product in a deal',
displayOptions: {
show: {
operation: ['add'],
resource: ['dealProduct'],
},
},
},
{
displayName: 'Quantity',
name: 'quantity',
type: 'number',
default: 1,
typeOptions: {
minValue: 1,
},
required: true,
description: 'How many items of this product to add/update in a deal',
displayOptions: {
show: {
operation: ['add'],
resource: ['dealProduct'],
},
},
},
{
displayName: 'Additional Fields',
name: 'additionalFields',
type: 'collection',
placeholder: 'Add Field',
displayOptions: {
show: {
operation: ['add'],
resource: ['dealProduct'],
},
},
default: {},
options: [
{
displayName: 'Comments',
name: 'comments',
type: 'string',
typeOptions: {
rows: 4,
},
default: '',
description: 'Text to describe this product-deal attachment',
},
{
displayName: 'Discount Percentage',
name: 'discount_percentage',
type: 'number',
default: 0,
typeOptions: {
minValue: 0,
maxValue: 100,
},
description: 'Percentage of discount to apply',
},
{
displayName: 'Product Variation ID',
name: 'product_variation_id',
type: 'string',
default: '',
description: 'ID of the product variation to use',
},
],
},
// ----------------------------------
// dealProduct:update
// ----------------------------------
{
displayName: 'Deal Name or ID',
name: 'dealId',
type: 'options',
default: '',
typeOptions: {
loadOptionsMethod: 'getDeals',
},
required: true,
displayOptions: {
show: {
operation: ['update'],
resource: ['dealProduct'],
},
},
description:
'The ID of the deal whose product to update. Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code-examples/expressions/">expression</a>.',
},
{
displayName: 'Product Attachment Name or ID',
name: 'productAttachmentId',
type: 'options',
default: '',
typeOptions: {
loadOptionsMethod: 'getProductsDeal',
loadOptionsDependsOn: ['dealId'],
},
required: true,
displayOptions: {
show: {
operation: ['update'],
resource: ['dealProduct'],
},
},
description:
'ID of the deal-product (the ID of the product attached to the deal). Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code-examples/expressions/">expression</a>.',
},
{
displayName: 'Update Fields',
name: 'updateFields',
type: 'collection',
placeholder: 'Add Field',
displayOptions: {
show: {
operation: ['update'],
resource: ['dealProduct'],
},
},
default: {},
options: [
{
displayName: 'Comments',
name: 'comments',
type: 'string',
typeOptions: {
rows: 4,
},
default: '',
description: 'Text to describe this product-deal attachment',
},
{
displayName: 'Discount Percentage',
name: 'discount_percentage',
type: 'number',
default: 0,
typeOptions: {
minValue: 0,
maxValue: 100,
},
description: 'Percentage of discount to apply',
},
{
displayName: 'Item Price',
name: 'item_price',
type: 'number',
typeOptions: {
numberPrecision: 2,
},
default: 0.0,
description: 'Price at which to add or update this product in a deal',
},
{
displayName: 'Quantity',
name: 'quantity',
type: 'number',
default: 1,
typeOptions: {
minValue: 1,
},
description: 'How many items of this product to add/update in a deal',
},
{
displayName: 'Product Variation ID',
name: 'product_variation_id',
type: 'string',
default: '',
description: 'ID of the product variation to use',
},
],
},
// ----------------------------------
// dealProduct:remove
// ----------------------------------
{
displayName: 'Deal Name or ID',
name: 'dealId',
type: 'options',
default: '',
typeOptions: {
loadOptionsMethod: 'getDeals',
},
required: true,
displayOptions: {
show: {
operation: ['remove'],
resource: ['dealProduct'],
},
},
description:
'The ID of the deal whose product to remove. Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code-examples/expressions/">expression</a>.',
},
{
displayName: 'Product Attachment Name or ID',
name: 'productAttachmentId',
type: 'options',
default: '',
typeOptions: {
loadOptionsMethod: 'getProductsDeal',
loadOptionsDependsOn: ['dealId'],
},
required: true,
displayOptions: {
show: {
operation: ['remove'],
resource: ['dealProduct'],
},
},
description:
'ID of the deal-product (the ID of the product attached to the deal). Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code-examples/expressions/">expression</a>.',
},
// ----------------------------------
// dealProduct:getAll
// ----------------------------------
{
displayName: 'Deal Name or ID',
name: 'dealId',
type: 'options',
default: '',
typeOptions: {
loadOptionsMethod: 'getDeals',
},
required: true,
displayOptions: {
show: {
operation: ['getAll'],
resource: ['dealProduct'],
},
},
description:
'The ID of the deal whose products to retrieve. Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code-examples/expressions/">expression</a>.',
},
// ----------------------------------
// deal:search
// ----------------------------------
{
displayName: 'Term',
name: 'term',
type: 'string',
required: true,
displayOptions: {
show: {
operation: ['search'],
resource: ['deal'],
},
},
default: '',
description:
'The search term to look for. Minimum 2 characters (or 1 if using exact_match).',
},
{
displayName: 'Exact Match',
name: 'exactMatch',
type: 'boolean',
displayOptions: {
show: {
operation: ['search'],
resource: ['deal'],
},
},
default: false,
description:
'Whether only full exact matches against the given term are returned. It is not case sensitive.',
},
{
displayName: 'Return All',
name: 'returnAll',
type: 'boolean',
displayOptions: {
show: {
operation: ['search'],
},
},
default: false,
description: 'Whether to return all results or only up to a given limit',
},
{
displayName: 'Limit',
name: 'limit',
type: 'number',
displayOptions: {
show: {
operation: ['search'],
returnAll: [false],
},
},
typeOptions: {
minValue: 1,
maxValue: 500,
},
default: 100,
description: 'Max number of results to return',
},
{
displayName: 'Additional Fields',
name: 'additionalFields',
type: 'collection',
placeholder: 'Add Field',
displayOptions: {
show: {
operation: ['search'],
resource: ['deal'],
},
},
default: {},
options: [
{
displayName: 'Include Fields',
name: 'includeFields',
type: 'string',
default: '',
description:
'Supports including optional fields in the results which are not provided by default. Example: deal.cc_email.',
},
{
displayName: 'Organization ID',
name: 'organizationId',
type: 'string',
default: '',
description: 'Will filter Deals by the provided Organization ID',
},
{
displayName: 'Person ID',
name: 'personId',
type: 'string',
default: '',
description: 'Will filter Deals by the provided Person ID',
},
{
displayName: 'Search Fields',
name: 'fields',
type: 'multiOptions',
options: [
{
name: 'Custom Fields',
value: 'custom_fields',
},
{
name: 'Notes',
value: 'notes',
},
{
name: 'Title',
value: 'title',
},
],
default: ['custom_fields', 'notes', 'title'],
description:
'A comma-separated string array. The fields to perform the search from. Defaults to all of them.',
},
{
displayName: 'Status',
name: 'status',
type: 'options',
options: [
{
name: 'Open',
value: 'open',
},
{
name: 'Won',
value: 'won',
},
{
name: 'Lost',
value: 'lost',
},
],
default: 'open',
description:
'The status of the deal. If not provided it will automatically be set to "open".',
},
],
},
// ----------------------------------
// file
// ----------------------------------
// ----------------------------------
// file:create
// ----------------------------------
{
displayName: 'Input Binary Field',
name: 'binaryPropertyName',
type: 'string',
default: 'data',
required: true,
displayOptions: {
show: {
operation: ['create'],
resource: ['file'],
},
},
placeholder: '',
hint: 'The name of the input binary field containing the file to be written',
},
{
displayName: 'Additional Fields',
name: 'additionalFields',
type: 'collection',
placeholder: 'Add Field',
displayOptions: {
show: {
operation: ['create'],
resource: ['file'],
},
},
default: {},
options: [
{
displayName: 'Activity ID',
name: 'activity_id',
type: 'number',
default: 0,
description: 'ID of the activite this file will be associated with',
},
{
displayName: 'Deal ID',
name: 'deal_id',
type: 'number',
default: 0,
description: 'ID of the deal this file will be associated with',
},
{
displayName: 'Organization Name or ID',
name: 'org_id',
type: 'options',
typeOptions: {
loadOptionsMethod: 'getOrganizationIds',
},
default: '',
description:
'ID of the organization this deal will be associated with. Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code-examples/expressions/">expression</a>.',
},
{
displayName: 'Person ID',
name: 'person_id',
type: 'number',
default: 0,
description: 'ID of the person this file will be associated with',
},
{
displayName: 'Product ID',
name: 'product_id',
type: 'number',
default: 0,
description: 'ID of the person this file will be associated with',
},
],
},
// ----------------------------------
// file:delete
// ----------------------------------
{
displayName: 'File ID',
name: 'fileId',
type: 'number',
displayOptions: {
show: {
operation: ['delete'],
resource: ['file'],
},
},
default: 0,
required: true,
description: 'ID of the file to delete',
},
// ----------------------------------
// file:download
// ----------------------------------
{
displayName: 'File ID',
name: 'fileId',
type: 'number',
displayOptions: {
show: {
operation: ['download'],
resource: ['file'],
},
},
default: 0,
required: true,
description: 'ID of the file to download',
},
{
displayName: 'Put Output File in Field',
name: 'binaryPropertyName',
type: 'string',
required: true,
default: 'data',
displayOptions: {
show: {
operation: ['download'],
resource: ['file'],
},
},
hint: 'The name of the output binary field to put the file in',
},
// ----------------------------------
// file:get
// ----------------------------------
{
displayName: 'File ID',
name: 'fileId',
type: 'number',
displayOptions: {
show: {
operation: ['get'],
resource: ['file'],
},
},
default: 0,
required: true,
description: 'ID of the file to get',
},
// ----------------------------------
// file:update
// ----------------------------------
{
displayName: 'File ID',
name: 'fileId',
type: 'number',
displayOptions: {
show: {
operation: ['update'],
resource: ['file'],
},
},
default: 0,
required: true,
description: 'ID of the file to update',
},
{
displayName: 'Update Fields',
name: 'updateFields',
type: 'collection',
placeholder: 'Add Field',
displayOptions: {
show: {
operation: ['update'],
resource: ['file'],
},
},
default: {},
options: [
{
displayName: 'Name',
name: 'name',
type: 'string',
default: '',
description: 'The updated visible name of the file',
},
{
displayName: 'Description',
name: 'description',
type: 'string',
default: '',
description: 'The updated description of the file',
},
],
},
// ----------------------------------
// lead
// ----------------------------------
// ----------------------------------------
// lead: create
// ----------------------------------------
{
displayName: 'Title',
name: 'title',
description: 'Name of the lead to create',
type: 'string',
required: true,
default: '',
displayOptions: {
show: {
resource: ['lead'],
operation: ['create'],
},
},
},
{
displayName: 'Associate With',
name: 'associateWith',
type: 'options',
options: [
{
name: 'Organization',
value: 'organization',
},
{
name: 'Person',
value: 'person',
},
],
default: 'organization',
description: 'Type of entity to link to this lead',
required: true,
displayOptions: {
show: {
resource: ['lead'],
operation: ['create'],
},
},
},
{
displayName: 'Organization ID',
name: 'organization_id',
type: 'number',
default: 0,
description: 'ID of the organization to link to this lead',
required: true,
displayOptions: {
show: {
resource: ['lead'],
operation: ['create'],
associateWith: ['organization'],
},
},
},
{
displayName: 'Person ID',
name: 'person_id',
type: 'number',
default: 0,
description: 'ID of the person to link to this lead',
required: true,
displayOptions: {
show: {
resource: ['lead'],
operation: ['create'],
associateWith: ['person'],
},
},
},
{
displayName: 'Additional Fields',
name: 'additionalFields',
type: 'collection',
placeholder: 'Add Field',
default: {},
displayOptions: {
show: {
resource: ['lead'],
operation: ['create'],
},
},
options: [
{
displayName: 'Expected Close Date',
name: 'expected_close_date',
type: 'dateTime',
default: '',
description: 'Date when the lead’s deal is expected to be closed, in ISO-8601 format',
},
{
displayName: 'Label Names or IDs',
name: 'label_ids',
type: 'multiOptions',
typeOptions: {
loadOptionsMethod: 'getLeadLabels',
},
default: [],
description:
'ID of the labels to attach to the lead to create. Choose from the list, or specify IDs using an <a href="https://docs.n8n.io/code-examples/expressions/">expression</a>.',
},
{
displayName: 'Organization ID',
name: 'organization_id',
type: 'number',
default: 0,
description: 'ID of the organization to link to this lead',
displayOptions: {
show: {
'/associateWith': ['person'],
},
},
},
{
displayName: 'Owner Name or ID',
name: 'owner_id',
type: 'options',
typeOptions: {
loadOptionsMethod: 'getUserIds',
},
default: '',
description:
'ID of the user who will own the lead to create. Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code-examples/expressions/">expression</a>.',
},
{
displayName: 'Person ID',
name: 'person_id',
type: 'number',
default: 0,
description: 'ID of the person to link to this lead',
displayOptions: {
show: {
'/associateWith': ['organization'],
},
},
},
{
displayName: 'Value',
name: 'value',
type: 'fixedCollection',
description: 'Potential monetary value associated with the lead',
default: {},
options: [
{
displayName: 'Value Properties',
name: 'valueProperties',
values: [
{
displayName: 'Amount',
name: 'amount',
type: 'number',
default: '',
},
{
displayName: 'Currency',
name: 'currency',
type: 'options',
default: 'USD',
options: currencies.sort((a, b) => a.name.localeCompare(b.name)),
},
],
},
],
},
],
},
// ----------------------------------------
// lead: delete
// ----------------------------------------
{
displayName: 'Lead ID',
name: 'leadId',
description: 'ID of the lead to delete',
type: 'string',
required: true,
default: '',
displayOptions: {
show: {
resource: ['lead'],
operation: ['delete'],
},
},
},
// ----------------------------------------
// lead: get
// ----------------------------------------
{
displayName: 'Lead ID',
name: 'leadId',
description: 'ID of the lead to retrieve',
type: 'string',
required: true,
default: '',
displayOptions: {
show: {
resource: ['lead'],
operation: ['get'],
},
},
},
// ----------------------------------------
// lead: update
// ----------------------------------------
{
displayName: 'Lead ID',
name: 'leadId',
description: 'ID of the lead to update',
type: 'string',
required: true,
default: '',
displayOptions: {
show: {
resource: ['lead'],
operation: ['update'],
},
},
},
{
displayName: 'Update Fields',
name: 'updateFields',
type: 'collection',
placeholder: 'Add Field',
default: {},
displayOptions: {
show: {
resource: ['lead'],
operation: ['update'],
},
},
options: [
{
displayName: 'Title',
name: 'title',
type: 'string',
default: '',
description: 'Name of the lead to update',
},
{
displayName: 'Owner Name or ID',
name: 'owner_id',
type: 'options',
typeOptions: {
loadOptionsMethod: 'getUserIds',
},
default: '',
description:
'ID of the user who will own the lead to update. Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code-examples/expressions/">expression</a>.',
},
{
displayName: 'Label Names or IDs',
name: 'label_ids',
type: 'multiOptions',
typeOptions: {
loadOptionsMethod: 'getLeadLabels',
},
default: [],
description:
'ID of the labels to attach to the lead to update. Choose from the list, or specify IDs using an <a href="https://docs.n8n.io/code-examples/expressions/">expression</a>.',
},
{
displayName: 'Person Name or ID',
name: 'person_id',
type: 'options',
typeOptions: {
loadOptionsMethod: 'getPersons',
},
default: '',
description:
'ID of the person to link to this lead. 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: 'fixedCollection',
description: 'Potential monetary value associated with the lead',
default: {},
options: [
{
displayName: 'Value Properties',
name: 'valueProperties',
values: [
{
displayName: 'Amount',
name: 'amount',
type: 'number',
default: '',
},
{
displayName: 'Currency',
name: 'currency',
type: 'options',
default: 'USD',
options: currencies.sort((a, b) => a.name.localeCompare(b.name)),
},
],
},
],
},
{
displayName: 'Expected Close Date',
name: 'expected_close_date',
type: 'dateTime',
default: '',
description: 'Date when the lead’s deal is expected to be closed, in ISO-8601 format',
},
],
},
// ----------------------------------
// note
// ----------------------------------
// ----------------------------------
// note:create
// ----------------------------------
{
displayName: 'Content',
name: 'content',
typeOptions: {
rows: 5,
},
type: 'string',
default: '',
required: true,
displayOptions: {
show: {
operation: ['create'],
resource: ['note'],
},
},
description: 'The content of the note to create',
},
// {
// displayName: 'Additional Fields',
// name: 'additionalFields',
// type: 'collection',
// placeholder: 'Add Field',
// displayOptions: {
// show: {
// operation: [
// 'create',
// 'getAll',
// ],
// resource: [
// 'note',
// ],
// },
// },
// default: {},
// options: [
// {
// displayName: 'Deal ID',
// name: 'deal_id',
// type: 'number',
// default: 0,
// description: 'ID of the deal this note will be associated with',
// },
// {
// displayName: 'Organization ID',
// name: 'org_id',
// type: 'options',
// typeOptions: {
// loadOptionsMethod: 'getOrganizationIds',
// },
// default: '',
// description: 'ID of the organization this deal will be associated with.',
// },
// {
// displayName: 'Person ID',
// name: 'person_id',
// type: 'number',
// default: 0,
// description: 'ID of the person this note will be associated with.',
// },
// ],
// },
// ----------------------------------
// note:delete
// ----------------------------------
{
displayName: 'Note ID',
name: 'noteId',
type: 'number',
displayOptions: {
show: {
operation: ['delete'],
resource: ['note'],
},
},
default: 0,
required: true,
description: 'ID of the note to delete',
},
// ----------------------------------
// note:get
// ----------------------------------
{
displayName: 'Note ID',
name: 'noteId',
type: 'number',
displayOptions: {
show: {
operation: ['get'],
resource: ['note'],
},
},
default: 0,
required: true,
description: 'ID of the note to get',
},
// ----------------------------------
// note:update
// ----------------------------------
{
displayName: 'Note ID',
name: 'noteId',
type: 'number',
displayOptions: {
show: {
operation: ['update'],
resource: ['note'],
},
},
default: 0,
required: true,
description: 'ID of the note to update',
},
{
displayName: 'Update Fields',
name: 'updateFields',
type: 'collection',
placeholder: 'Add Field',
displayOptions: {
show: {
operation: ['update'],
resource: ['note'],
},
},
default: {},
options: [
{
displayName: 'Content',
name: 'content',
typeOptions: {
rows: 5,
},
type: 'string',
default: '',
description: 'The content of the note',
},
{
displayName: 'Deal ID',
name: 'deal_id',
type: 'number',
default: 0,
description: 'ID of the deal this note will be associated with',
},
{
displayName: 'Lead ID',
name: 'lead_id',
type: 'number',
default: 0,
description: 'ID of the lead this note will be associated with',
},
{
displayName: 'Organization Name or ID',
name: 'org_id',
type: 'options',
typeOptions: {
loadOptionsMethod: 'getOrganizationIds',
},
default: '',
description:
'ID of the organization this deal will be associated with. Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code-examples/expressions/">expression</a>.',
},
{
displayName: 'Person ID',
name: 'person_id',
type: 'number',
default: 0,
description: 'ID of the person this note will be associated with',
},
],
},
// ----------------------------------
// organization
// ----------------------------------
// ----------------------------------
// organization:create
// ----------------------------------
{
displayName: 'Name',
name: 'name',
type: 'string',
default: '',
required: true,
displayOptions: {
show: {
operation: ['create'],
resource: ['organization'],
},
},
description: 'The name of the organization to create',
},
{
displayName: 'Additional Fields',
name: 'additionalFields',
type: 'collection',
placeholder: 'Add Field',
displayOptions: {
show: {
operation: ['create'],
resource: ['organization'],
},
},
default: {},
options: [
{
displayName: 'Custom Properties',
name: 'customProperties',
placeholder: 'Add Custom Property',
description: 'Adds a custom property to set also values which have not been predefined',
type: 'fixedCollection',
typeOptions: {
multipleValues: true,
},
default: {},
options: [
{
name: 'property',
displayName: 'Property',
values: [
{
displayName: 'Property Name',
name: 'name',
type: 'string',
default: '',
description: 'Name of the property to set',
},
{
displayName: 'Property Value',
name: 'value',
type: 'string',
default: '',
description: 'Value of the property to set',
},
],
},
],
},
{
displayName: 'Label Name or ID',
name: 'label',
type: 'options',
description:
'Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code-examples/expressions/">expression</a>',
typeOptions: {
loadOptionsMethod: 'getOrganizationLabels',
},
default: '',
},
{
displayName: 'Visible To',
name: 'visible_to',
type: 'options',
options: [
{
name: 'Owner & Followers (Private)',
value: '1',
},
{
name: 'Entire Company (Shared)',
value: '3',
},
],
default: '3',
description:
'Visibility of the person. If omitted, visibility will be set to the default visibility setting of this item type for the authorized user.',
},
],
},
// ----------------------------------
// organization:delete
// ----------------------------------
{
displayName: 'Organization ID',
name: 'organizationId',
type: 'number',
displayOptions: {
show: {
operation: ['delete'],
resource: ['organization'],
},
},
default: 0,
required: true,
description: 'ID of the organization to delete',
},
// ----------------------------------
// organization:get
// ----------------------------------
{
displayName: 'Organization ID',
name: 'organizationId',
type: 'number',
displayOptions: {
show: {
operation: ['get'],
resource: ['organization'],
},
},
default: 0,
required: true,
description: 'ID of the organization to get',
},
// ----------------------------------
// organization:search
// ----------------------------------
{
displayName: 'Term',
name: 'term',
type: 'string',
required: true,
displayOptions: {
show: {
operation: ['search'],
resource: ['organization'],
},
},
default: '',
description:
'The search term to look for. Minimum 2 characters (or 1 if using exact_match).',
},
{
displayName: 'Additional Fields',
name: 'additionalFields',
type: 'collection',
placeholder: 'Add Field',
displayOptions: {
show: {
operation: ['search'],
resource: ['organization'],
},
},
default: {},
options: [
{
displayName: 'Exact Match',
name: 'exactMatch',
type: 'boolean',
default: false,
description:
'Whether only full exact matches against the given term are returned. It is not case sensitive.',
},
{
displayName: 'Fields',
name: 'fields',
type: 'multiOptions',
default: [],
description: 'Fields to the search in. Defaults to all of them.',
options: [
{
name: 'Address',
value: 'address',
},
{
name: 'Custom Fields',
value: 'custom_fields',
},
{
name: 'Name',
value: 'name',
},
{
name: 'Notes',
value: 'notes',
},
],
},
{
displayName: 'RAW Data',
name: 'rawData',
type: 'boolean',
default: false,
description:
'Whether to return the data exactly in the way it got received from the API',
},
],
},
// ----------------------------------
// organization:update
// ----------------------------------
{
displayName: 'Organization ID',
name: 'organizationId',
type: 'number',
default: '',
required: true,
displayOptions: {
show: {
operation: ['update'],
resource: ['organization'],
},
},
description: 'The ID of the organization to create',
},
{
displayName: 'Update Fields',
name: 'updateFields',
type: 'collection',
placeholder: 'Add Field',
displayOptions: {
show: {
operation: ['update'],
resource: ['organization'],
},
},
default: {},
options: [
{
displayName: 'Custom Properties',
name: 'customProperties',
placeholder: 'Add Custom Property',
description: 'Adds a custom property to set also values which have not been predefined',
type: 'fixedCollection',
typeOptions: {
multipleValues: true,
},
default: {},
options: [
{
name: 'property',
displayName: 'Property',
values: [
{
displayName: 'Property Name',
name: 'name',
type: 'string',
default: '',
description: 'Name of the property to set',
},
{
displayName: 'Property Value',
name: 'value',
type: 'string',
default: '',
description: 'Value of the property to set',
},
],
},
],
},
{
displayName: 'Label Name or ID',
name: 'label',
type: 'options',
description:
'Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code-examples/expressions/">expression</a>',
typeOptions: {
loadOptionsMethod: 'getOrganizationLabels',
},
default: '',
},
{
displayName: 'Name',
name: 'name',
type: 'string',
default: '',
description: 'Organization name',
},
{
displayName: 'Owner ID',
name: 'owner_id',
type: 'number',
default: 0,
description:
'The ID of the user who will be marked as the owner of this Organization. When omitted, the authorized User ID will be used.',
},
{
displayName: 'Visible To',
name: 'visible_to',
type: 'options',
options: [
{
name: 'Owner & Followers (Private)',
value: '1',
},
{
name: 'Entire Company (Shared)',
value: '3',
},
],
default: '3',
description:
'Visibility of the person. If omitted, visibility will be set to the default visibility setting of this item type for the authorized user.',
},
],
},
// ----------------------------------
// person
// ----------------------------------
// ----------------------------------
// person:create
// ----------------------------------
{
displayName: 'Name',
name: 'name',
type: 'string',
default: '',
required: true,
displayOptions: {
show: {
operation: ['create'],
resource: ['person'],
},
},
description: 'The name of the person to create',
},
{
displayName: 'Additional Fields',
name: 'additionalFields',
type: 'collection',
placeholder: 'Add Field',
displayOptions: {
show: {
operation: ['create'],
resource: ['person'],
},
},
default: {},
options: [
{
displayName: 'Custom Properties',
name: 'customProperties',
placeholder: 'Add Custom Property',
description: 'Adds a custom property to set also values which have not been predefined',
type: 'fixedCollection',
typeOptions: {
multipleValues: true,
},
default: {},
options: [
{
name: 'property',
displayName: 'Property',
values: [
{
displayName: 'Property Name or ID',
name: 'name',
type: 'options',
typeOptions: {
loadOptionsMethod: 'getPersonCustomFields',
},
default: '',
description:
'Name of the custom field to set. Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code-examples/expressions/">expression</a>.',
},
{
displayName: 'Property Value',
name: 'value',
type: 'string',
default: '',
description: 'Value of the property to set',
},
],
},
],
},
{
displayName: 'Email',
name: 'email',
type: 'string',
placeholder: 'name@email.com',
typeOptions: {
multipleValues: true,
},
default: '',
description: 'Email of the person',
},
{
displayName: 'Label Name or ID',
name: 'label',
type: 'options',
description:
'Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code-examples/expressions/">expression</a>',
typeOptions: {
loadOptionsMethod: 'getPersonLabels',
},
default: '',
},
{
displayName: 'Marketing Status',
name: 'marketing_status',
type: 'options',
options: [
{
name: 'No Consent',
value: 'no_consent',
},
{
name: 'Unsubscribed',
value: 'unsubscribed',
},
{
name: 'Subscribed',
value: 'subscribed',
},
{
name: 'Archived',
value: 'archived',
},
],
default: 'subscribed',
description:
'Please be aware that it is only allowed once to change the marketing status from an old status to a new one',
},
{
displayName: 'Organization Name or ID',
name: 'org_id',
type: 'options',
typeOptions: {
loadOptionsMethod: 'getOrganizationIds',
},
default: '',
description:
'ID of the organization this deal will be associated with. 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',
typeOptions: {
multipleValues: true,
},
default: '',
description: 'Phone number of the person',
},
{
displayName: 'Visible To',
name: 'visible_to',
type: 'options',
options: [
{
name: 'Owner & Followers (Private)',
value: '1',
},
{
name: 'Entire Company (Shared)',
value: '3',
},
],
default: '3',
description:
'Visibility of the person. If omitted, visibility will be set to the default visibility setting of this item type for the authorized user.',
},
{
displayName: 'User Name or ID',
name: 'owner_id',
type: 'options',
typeOptions: {
loadOptionsMethod: 'getUserIds',
},
default: '',
description:
'ID of the User this deal will be associated with. Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code-examples/expressions/">expression</a>.',
},
],
},
// ----------------------------------
// person:delete
// ----------------------------------
{
displayName: 'Person ID',
name: 'personId',
type: 'number',
displayOptions: {
show: {
operation: ['delete'],
resource: ['person'],
},
},
default: 0,
required: true,
description: 'ID of the person to delete',
},
// ----------------------------------
// person:get
// ----------------------------------
{
displayName: 'Person ID',
name: 'personId',
type: 'number',
displayOptions: {
show: {
operation: ['get'],
resource: ['person'],
},
},
default: 0,
required: true,
description: 'ID of the person to get',
},
// ----------------------------------
// person:update
// ----------------------------------
{
displayName: 'Person ID',
name: 'personId',
type: 'number',
displayOptions: {
show: {
operation: ['update'],
resource: ['person'],
},
},
default: 0,
required: true,
description: 'ID of the person to update',
},
{
displayName: 'Update Fields',
name: 'updateFields',
type: 'collection',
description: 'The fields to update',
placeholder: 'Add Field',
displayOptions: {
show: {
operation: ['update'],
resource: ['person'],
},
},
default: {},
options: [
{
displayName: 'Custom Properties',
name: 'customProperties',
placeholder: 'Add Custom Property',
description: 'Adds a custom property to set also values which have not been predefined',
type: 'fixedCollection',
typeOptions: {
multipleValues: true,
},
default: {},
options: [
{
name: 'property',
displayName: 'Property',
values: [
{
displayName: 'Property Name or ID',
name: 'name',
type: 'options',
typeOptions: {
loadOptionsMethod: 'getPersonCustomFields',
},
default: '',
description:
'Name of the custom field to set. Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code-examples/expressions/">expression</a>.',
},
{
displayName: 'Property Value',
name: 'value',
type: 'string',
default: '',
description: 'Value of the property to set',
},
],
},
],
},
{
displayName: 'Email',
name: 'email',
type: 'string',
placeholder: 'name@email.com',
typeOptions: {
multipleValues: true,
},
default: '',
description: 'Email of the person',
},
{
displayName: 'Label Name or ID',
name: 'label',
type: 'options',
description:
'Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code-examples/expressions/">expression</a>',
typeOptions: {
loadOptionsMethod: 'getPersonLabels',
},
default: '',
},
{
displayName: 'Marketing Status',
name: 'marketing_status',
type: 'options',
options: [
{
name: 'No Consent',
value: 'no_consent',
},
{
name: 'Unsubscribed',
value: 'unsubscribed',
},
{
name: 'Subscribed',
value: 'subscribed',
},
{
name: 'Archived',
value: 'archived',
},
],
default: 'subscribed',
description:
'Please be aware that it is only allowed once to change the marketing status from an old status to a new one',
},
{
displayName: 'Name',
name: 'name',
type: 'string',
default: '',
description: 'The name of the person',
},
{
displayName: 'Organization Name or ID',
name: 'org_id',
type: 'options',
typeOptions: {
loadOptionsMethod: 'getOrganizationIds',
},
default: '',
description:
'ID of the organization this deal will be associated with. 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',
typeOptions: {
multipleValues: true,
},
default: '',
description: 'Phone number of the person',
},
{
displayName: 'User Name or ID',
name: 'owner_id',
type: 'options',
typeOptions: {
loadOptionsMethod: 'getUserIds',
},
default: '',
description:
'ID of the User this person will be associated with. Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code-examples/expressions/">expression</a>.',
},
{
displayName: 'Visible To',
name: 'visible_to',
type: 'options',
options: [
{
name: 'Owner & Followers (Private)',
value: '1',
},
{
name: 'Entire Company (Shared)',
value: '3',
},
],
default: '3',
description:
'Visibility of the deal. If omitted, visibility will be set to the default visibility setting of this item type for the authorized user.',
},
],
},
// ----------------------------------
// activity / deal / note / organization / person / product
// ----------------------------------
{
displayName: 'Resolve Properties',
name: 'resolveProperties',
type: 'boolean',
displayOptions: {
show: {
resource: ['activity', 'deal', 'organization', 'person', 'product'],
operation: ['get', 'getAll'],
},
},
default: false,
// eslint-disable-next-line n8n-nodes-base/node-param-description-boolean-without-whether
description:
'By default do custom properties get returned only as ID instead of their actual name. Also option fields contain only the ID instead of their actual value. If this option gets set they get automatically resolved.',
},
{
displayName: 'Encode Properties',
name: 'encodeProperties',
type: 'boolean',
displayOptions: {
show: {
resource: ['activity', 'deal', 'organization', 'person', 'product'],
operation: ['update'],
},
},
default: false,
// eslint-disable-next-line n8n-nodes-base/node-param-description-boolean-without-whether
description:
'By default do custom properties have to be set as ID instead of their actual name. Also option fields have to be set as ID instead of their actual value. If this option gets set they get automatically encoded.',
},
{
displayName: 'Return All',
name: 'returnAll',
type: 'boolean',
displayOptions: {
show: {
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: {
operation: ['getAll'],
returnAll: [false],
},
},
typeOptions: {
minValue: 1,
maxValue: 500,
},
default: 100,
description: 'Max number of results to return',
},
// ----------------------------------
// dealActivities:getAll
// ----------------------------------
{
displayName: 'Deal Name or ID',
name: 'dealId',
type: 'options',
default: '',
typeOptions: {
loadOptionsMethod: 'getDeals',
},
required: true,
displayOptions: {
show: {
operation: ['getAll'],
resource: ['dealActivity'],
},
},
description:
'The ID of the deal whose activity to retrieve. 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',
displayOptions: {
show: {
operation: ['getAll'],
resource: ['dealActivity'],
},
},
default: {},
options: [
{
displayName: 'Done',
name: 'done',
type: 'boolean',
default: false,
description: 'Whether the activity is done or not',
},
{
displayName: 'Exclude Activity IDs',
name: 'exclude',
type: 'string',
default: '',
description:
'A comma-separated Activity IDs, to exclude from result. Ex. 4, 9, 11, ...',
},
],
},
// ----------------------------------------
// lead: getAll
// ----------------------------------------
{
displayName: 'Filters',
name: 'filters',
type: 'collection',
placeholder: 'Add Filter',
default: {},
displayOptions: {
show: {
resource: ['lead'],
operation: ['getAll'],
},
},
options: [
{
displayName: 'Archived Status',
name: 'archived_status',
type: 'options',
default: 'all',
options: [
{
name: 'Archived',
value: 'archived',
},
{
name: 'All',
value: 'all',
},
{
name: 'Not Archived',
value: 'not_archived',
},
],
},
],
},
// ----------------------------------
// organization:getAll
// ----------------------------------
{
displayName: 'Filters',
name: 'filters',
type: 'collection',
placeholder: 'Add Field',
displayOptions: {
show: {
operation: ['getAll'],
resource: ['organization'],
},
},
default: {},
options: [
{
displayName: 'First Char',
name: 'firstChar',
type: 'string',
default: '',
description:
'If supplied, only organizations whose name starts with the specified letter will be returned',
},
{
displayName: 'Predefined Filter Name or ID',
name: 'filterId',
type: 'options',
typeOptions: {
loadOptionsMethod: 'getFilters',
},
default: '',
description:
'ID of the filter to use. Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code-examples/expressions/">expression</a>.',
},
],
},
// ----------------------------------
// person:getAll
// ----------------------------------
{
displayName: 'Additional Fields',
name: 'additionalFields',
type: 'collection',
placeholder: 'Add Field',
displayOptions: {
show: {
operation: ['getAll'],
resource: ['person'],
},
},
default: {},
options: [
{
displayName: 'Predefined Filter Name or ID',
name: 'filterId',
type: 'options',
typeOptions: {
loadOptionsMethod: 'getFilters',
},
default: '',
description:
'ID of the filter to use. Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code-examples/expressions/">expression</a>.',
},
{
displayName: 'First Char',
name: 'firstChar',
type: 'string',
default: '',
description:
'If supplied, only persons whose name starts with the specified letter will be returned',
},
],
},
// ----------------------------------
// person:search
// ----------------------------------
{
displayName: 'Term',
name: 'term',
type: 'string',
required: true,
displayOptions: {
show: {
operation: ['search'],
resource: ['person'],
},
},
default: '',
description:
'The search term to look for. Minimum 2 characters (or 1 if using exact_match).',
},
{
displayName: 'Additional Fields',
name: 'additionalFields',
type: 'collection',
placeholder: 'Add Field',
displayOptions: {
show: {
operation: ['search'],
resource: ['person'],
},
},
default: {},
options: [
{
displayName: 'Exact Match',
name: 'exactMatch',
type: 'boolean',
default: false,
description:
'Whether only full exact matches against the given term are returned. It is not case sensitive.',
},
{
displayName: 'Fields',
name: 'fields',
type: 'string',
default: '',
description:
'A comma-separated string array. The fields to perform the search from. Defaults to all of them.',
},
{
displayName: 'Include Fields',
name: 'includeFields',
type: 'string',
default: '',
description:
'Supports including optional fields in the results which are not provided by default',
},
{
displayName: 'Organization ID',
name: 'organizationId',
type: 'string',
default: '',
description: 'Will filter Deals by the provided Organization ID',
},
{
displayName: 'RAW Data',
name: 'rawData',
type: 'boolean',
default: false,
description:
'Whether to return the data exactly in the way it got received from the API',
},
],
},
// ----------------------------------
// note:create/getAll
// ----------------------------------
{
displayName: 'Additional Fields',
name: 'additionalFields',
type: 'collection',
placeholder: 'Add Field',
displayOptions: {
show: {
operation: ['create', 'getAll'],
resource: ['note'],
},
},
default: {},
options: [
{
displayName: 'Deal ID',
name: 'deal_id',
type: 'number',
default: 0,
description: 'ID of the deal this note will be associated with',
},
{
displayName: 'Lead ID',
name: 'lead_id',
type: 'number',
default: 0,
description: 'ID of the lead this note will be associated with',
},
{
displayName: 'Organization Name or ID',
name: 'org_id',
type: 'options',
typeOptions: {
loadOptionsMethod: 'getOrganizationIds',
},
default: '',
description:
'ID of the organization this deal will be associated with. Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code-examples/expressions/">expression</a>.',
},
{
displayName: 'Person ID',
name: 'person_id',
type: 'number',
default: 0,
description: 'ID of the person this note will be associated with',
},
],
},
// ----------------------------------
// activity:getAll
// ----------------------------------
{
displayName: 'Additional Fields',
name: 'additionalFields',
type: 'collection',
placeholder: 'Add Field',
displayOptions: {
show: {
operation: ['getAll'],
resource: ['activity'],
},
},
default: {},
options: [
{
displayName: 'Done',
name: 'done',
type: 'boolean',
default: false,
description:
'Whether the Activity is done or not. 0 = Not done, 1 = Done. If omitted returns both Done and Not done activities.',
},
{
displayName: 'End Date',
name: 'end_date',
type: 'dateTime',
default: '',
description:
'Use the Activity due date where you wish to stop fetching Activities from. Insert due date in YYYY-MM-DD format.',
},
{
displayName: 'Predefined Filter Name or ID',
name: 'filterId',
type: 'options',
typeOptions: {
loadOptionsMethod: 'getFilters',
},
default: '',
description:
'The ID of the Filter to use (will narrow down results if used together with user_id parameter). Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code-examples/expressions/">expression</a>.',
},
{
displayName: 'Star Date',
name: 'start_date',
type: 'dateTime',
default: '',
description:
'Use the Activity due date where you wish to begin fetching Activities from. Insert due date in YYYY-MM-DD format.',
},
{
displayName: 'Type Names or IDs',
name: 'type',
type: 'multiOptions',
typeOptions: {
loadOptionsMethod: 'getActivityTypes',
},
default: [],
description:
'Type of the Activity. Choose from the list, or specify IDs using an <a href="https://docs.n8n.io/code-examples/expressions/">expression</a>.',
},
{
displayName: 'User Name or ID',
name: 'user_id',
type: 'options',
typeOptions: {
loadOptionsMethod: 'getUserIds',
},
default: '',
description:
'The ID of the User whose Activities will be fetched. If omitted, the User associated with the API token will be used. If 0, Activities for all company Users will be fetched based on the permission sets. Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code-examples/expressions/">expression</a>.',
},
],
},
// ----------------------------------
// deal: getAll
// ----------------------------------
{
displayName: 'Filters',
name: 'filters',
type: 'collection',
placeholder: 'Add Filter',
displayOptions: {
show: {
operation: ['getAll'],
resource: ['deal'],
},
},
default: {},
options: [
{
displayName: 'Predefined Filter Name or ID',
name: 'filter_id',
type: 'options',
typeOptions: {
loadOptionsMethod: 'getFilters',
},
default: '',
description:
'Predefined filter to apply to the deals to retrieve. Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code-examples/expressions/">expression</a>.',
},
{
displayName: 'Stage Name or ID',
name: 'stage_id',
type: 'options',
typeOptions: {
loadOptionsMethod: 'getStageIds',
},
default: '',
description:
'ID of the stage to filter deals by. Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code-examples/expressions/">expression</a>.',
},
{
displayName: 'Status',
name: 'status',
type: 'options',
options: [
{
name: 'All Not Deleted',
value: 'all_not_deleted',
},
{
name: 'Deleted',
value: 'deleted',
},
{
name: 'Lost',
value: 'lost',
},
{
name: 'Open',
value: 'open',
},
{
name: 'Won',
value: 'won',
},
],
default: 'all_not_deleted',
description: 'Status to filter deals by. Defaults to <code>all_not_deleted</code>',
},
{
displayName: 'User Name or ID',
name: 'user_id',
type: 'options',
typeOptions: {
loadOptionsMethod: 'getUserIds',
},
default: '',
description:
'ID of the user to filter deals by. Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code-examples/expressions/">expression</a>.',
},
],
},
],
};
methods = {
loadOptions: {
// Get all Organizations to display them to user so that they can
// select them easily
async getActivityTypes(this: ILoadOptionsFunctions): Promise<INodePropertyOptions[]> {
const returnData: INodePropertyOptions[] = [];
const { data } = await pipedriveApiRequest.call(this, 'GET', '/activityTypes', {});
for (const activity of data) {
returnData.push({
name: activity.name,
value: activity.key_string,
});
}
return sortOptionParameters(returnData);
},
// Get all Filters to display them to user so that they can
// select them easily
async getFilters(this: ILoadOptionsFunctions): Promise<INodePropertyOptions[]> {
const returnData: INodePropertyOptions[] = [];
const resource = this.getNodeParameter('resource') as string;
const type = {
deal: 'deals',
activity: 'activity',
person: 'people',
organization: 'org',
} as { [id: string]: string };
const { data } = await pipedriveApiRequest.call(
this,
'GET',
'/filters',
{},
{ type: type[resource] },
);
for (const filter of data) {
returnData.push({
name: filter.name,
value: filter.id,
});
}
return sortOptionParameters(returnData);
},
// Get all Organizations to display them to user so that they can
// select them easily
async getOrganizationIds(this: ILoadOptionsFunctions): Promise<INodePropertyOptions[]> {
const returnData: INodePropertyOptions[] = [];
const { data } = await pipedriveApiRequest.call(this, 'GET', '/organizations', {});
for (const org of data) {
returnData.push({
name: org.name,
value: org.id,
});
}
return sortOptionParameters(returnData);
},
// Get all Users to display them to user so that they can
// select them easily
async getUserIds(this: ILoadOptionsFunctions): Promise<INodePropertyOptions[]> {
const returnData: INodePropertyOptions[] = [];
const resource = this.getCurrentNodeParameter('resource');
const { data } = await pipedriveApiRequest.call(this, 'GET', '/users', {});
for (const user of data) {
if (user.active_flag === true) {
returnData.push({
name: user.name,
value: user.id,
});
}
}
if (resource === 'activity') {
returnData.push({
name: 'All Users',
value: 0,
});
}
return sortOptionParameters(returnData);
},
// Get all Deals to display them to user so that they can
// select them easily
async getDeals(this: ILoadOptionsFunctions): Promise<INodePropertyOptions[]> {
const { data } = (await pipedriveApiRequest.call(this, 'GET', '/deals', {})) as {
data: Array<{ id: string; title: string }>;
};
return sortOptionParameters(data.map(({ id, title }) => ({ value: id, name: title })));
},
// Get all Products to display them to user so that they can
// select them easily
async getProducts(this: ILoadOptionsFunctions): Promise<INodePropertyOptions[]> {
const { data } = (await pipedriveApiRequest.call(this, 'GET', '/products', {})) as {
data: Array<{ id: string; name: string }>;
};
return sortOptionParameters(data.map(({ id, name }) => ({ value: id, name })));
},
// Get all Products related to a deal and display them to user so that they can
// select them easily
async getProductsDeal(this: ILoadOptionsFunctions): Promise<INodePropertyOptions[]> {
const dealId = this.getCurrentNodeParameter('dealId');
const { data } = (await pipedriveApiRequest.call(
this,
'GET',
`/deals/${dealId}/products`,
{},
)) as {
data: Array<{ id: string; name: string }>;
};
return sortOptionParameters(data.map(({ id, name }) => ({ value: id, name })));
},
// Get all Stages to display them to user so that they can
// select them easily
async getStageIds(this: ILoadOptionsFunctions): Promise<INodePropertyOptions[]> {
const returnData: INodePropertyOptions[] = [];
const { data } = await pipedriveApiRequest.call(this, 'GET', '/stages', {});
for (const stage of data) {
returnData.push({
name: `${stage.pipeline_name} > ${stage.name}`,
value: stage.id,
});
}
return sortOptionParameters(returnData);
},
// Get all the Organization Custom Fields to display them to user so that they can
// select them easily
async getOrganizationCustomFields(
this: ILoadOptionsFunctions,
): Promise<INodePropertyOptions[]> {
const returnData: INodePropertyOptions[] = [];
const { data } = await pipedriveApiRequest.call(this, 'GET', '/organizationFields', {});
for (const field of data) {
if (field.key.length === 40) {
returnData.push({
name: field.name,
value: field.key,
});
}
}
return sortOptionParameters(returnData);
},
// Get all the Deal Custom Fields to display them to user so that they can
// select them easily
async getDealCustomFields(this: ILoadOptionsFunctions): Promise<INodePropertyOptions[]> {
const returnData: INodePropertyOptions[] = [];
const { data } = await pipedriveApiRequest.call(this, 'GET', '/dealFields', {});
for (const field of data) {
if (field.key.length === 40) {
returnData.push({
name: field.name,
value: field.key,
});
}
}
return sortOptionParameters(returnData);
},
// Get all the Person Custom Fields to display them to user so that they can
// select them easily
async getPersonCustomFields(this: ILoadOptionsFunctions): Promise<INodePropertyOptions[]> {
const returnData: INodePropertyOptions[] = [];
const { data } = await pipedriveApiRequest.call(this, 'GET', '/personFields', {});
for (const field of data) {
if (field.key.length === 40) {
returnData.push({
name: field.name,
value: field.key,
});
}
}
return sortOptionParameters(returnData);
},
// Get all the person labels to display them to user so that they can
// select them easily
async getPersonLabels(this: ILoadOptionsFunctions): Promise<INodePropertyOptions[]> {
const returnData: INodePropertyOptions[] = [];
const operation = this.getCurrentNodeParameter('operation') as string;
const { data } = await pipedriveApiRequest.call(this, 'GET', '/personFields', {});
for (const field of data) {
if (field.key === 'label') {
if (field.options) {
for (const option of field.options) {
returnData.push({
name: option.label,
value: option.id,
});
}
}
}
}
sortOptionParameters(returnData);
if (operation === 'update') {
returnData.push({
name: 'No Label',
value: 'null',
});
}
return returnData;
},
// Get all the labels to display them to user so that they can
// select them easily
async getOrganizationLabels(this: ILoadOptionsFunctions): Promise<INodePropertyOptions[]> {
const returnData: INodePropertyOptions[] = [];
const operation = this.getCurrentNodeParameter('operation') as string;
const { data } = await pipedriveApiRequest.call(this, 'GET', '/organizationFields', {});
for (const field of data) {
if (field.key === 'label') {
if (field.options) {
for (const option of field.options) {
returnData.push({
name: option.label,
value: option.id,
});
}
}
}
}
sortOptionParameters(returnData);
if (operation === 'update') {
returnData.push({
name: 'No Label',
value: 'null',
});
}
return returnData;
},
// Get all the persons to display them to user so that they can
// select them easily
async getPersons(this: ILoadOptionsFunctions): Promise<INodePropertyOptions[]> {
const { data } = (await pipedriveApiRequest.call(this, 'GET', '/persons', {})) as {
data: Array<{ id: string; name: string }>;
};
return sortOptionParameters(data.map(({ id, name }) => ({ value: id, name })));
},
// Get all the lead labels to display them to user so that they can
// select them easily
async getLeadLabels(this: ILoadOptionsFunctions): Promise<INodePropertyOptions[]> {
const { data } = (await pipedriveApiRequest.call(this, 'GET', '/leadLabels', {})) as {
data: Array<{ id: string; name: string }>;
};
return sortOptionParameters(data.map(({ id, name }) => ({ value: id, name })));
},
// Get all the labels to display them to user so that they can
// select them easily
async getDealLabels(this: ILoadOptionsFunctions): Promise<INodePropertyOptions[]> {
const returnData: INodePropertyOptions[] = [];
const operation = this.getCurrentNodeParameter('operation') as string;
const { data } = await pipedriveApiRequest.call(this, 'GET', '/dealFields', {});
for (const field of data) {
if (field.key === 'label') {
if (field.options) {
for (const option of field.options) {
returnData.push({
name: option.label,
value: option.id,
});
}
}
}
}
sortOptionParameters(returnData);
if (operation === 'update') {
returnData.push({
name: 'No Label',
value: 'null',
});
}
return returnData;
},
},
};
async execute(this: IExecuteFunctions): Promise<INodeExecutionData[][]> {
const items = this.getInputData();
const returnData: INodeExecutionData[] = [];
// For Post
let body: IDataObject;
// For FormData
let formData: IDataObject;
// For Query string
let qs: IDataObject;
let downloadFile: boolean;
let requestMethod: IHttpRequestMethods;
let endpoint: string;
let returnAll = false;
const resource = this.getNodeParameter('resource', 0);
const operation = this.getNodeParameter('operation', 0);
let customProperties: ICustomProperties | undefined;
if (
['get', 'getAll', 'update'].includes(operation) &&
['activity', 'deal', 'organization', 'person', 'product'].includes(resource)
) {
// Request the custom properties once in the beginning to not query it multiple
// times if multiple items get updated
let getCustomProperties = false;
if (['update'].includes(operation)) {
getCustomProperties = this.getNodeParameter('encodeProperties', 0, false) as boolean;
} else {
getCustomProperties = this.getNodeParameter('resolveProperties', 0, false) as boolean;
}
if (getCustomProperties) {
customProperties = await pipedriveGetCustomProperties.call(this, resource);
}
}
for (let i = 0; i < items.length; i++) {
requestMethod = 'GET';
endpoint = '';
downloadFile = false;
body = {};
formData = {};
qs = {};
try {
if (resource === 'activity') {
if (operation === 'create') {
// ----------------------------------
// activity:create
// ----------------------------------
requestMethod = 'POST';
endpoint = '/activities';
body.subject = this.getNodeParameter('subject', i) as string;
body.done = this.getNodeParameter('done', i) as string;
body.type = this.getNodeParameter('type', i) as string;
const additionalFields = this.getNodeParameter('additionalFields', i);
addAdditionalFields(body, additionalFields);
} else if (operation === 'delete') {
// ----------------------------------
// activity:delete
// ----------------------------------
requestMethod = 'DELETE';
const activityId = this.getNodeParameter('activityId', i) as number;
endpoint = `/activities/${activityId}`;
} else if (operation === 'get') {
// ----------------------------------
// activity:get
// ----------------------------------
requestMethod = 'GET';
const activityId = this.getNodeParameter('activityId', i) as number;
endpoint = `/activities/${activityId}`;
} else if (operation === 'getAll') {
// ----------------------------------
// activity:getAll
// ----------------------------------
requestMethod = 'GET';
returnAll = this.getNodeParameter('returnAll', i);
if (!returnAll) {
qs.limit = this.getNodeParameter('limit', i);
}
const additionalFields = this.getNodeParameter('additionalFields', i);
addAdditionalFields(qs, additionalFields);
if (qs.filterId) {
qs.filter_id = qs.filterId;
delete qs.filterId;
}
if (qs.type) {
qs.type = (qs.type as string[]).join(',');
}
endpoint = '/activities';
} else if (operation === 'update') {
// ----------------------------------
// activity:update
// ----------------------------------
requestMethod = 'PUT';
const activityId = this.getNodeParameter('activityId', i) as number;
endpoint = `/activities/${activityId}`;
const updateFields = this.getNodeParameter('updateFields', i);
addAdditionalFields(body, updateFields);
}
} else if (resource === 'deal') {
if (operation === 'create') {
// ----------------------------------
// deal:create
// ----------------------------------
requestMethod = 'POST';
endpoint = '/deals';
body.title = this.getNodeParameter('title', i) as string;
const associateWith = this.getNodeParameter('associateWith', i) as
| 'organization'
| 'person';
if (associateWith === 'organization') {
body.org_id = this.getNodeParameter('org_id', i) as string;
} else {
body.person_id = this.getNodeParameter('person_id', i) as string;
}
const additionalFields = this.getNodeParameter('additionalFields', i);
addAdditionalFields(body, additionalFields);
} else if (operation === 'delete') {
// ----------------------------------
// deal:delete
// ----------------------------------
requestMethod = 'DELETE';
const dealId = this.getNodeParameter('dealId', i) as number;
endpoint = `/deals/${dealId}`;
} else if (operation === 'duplicate') {
// ----------------------------------
// deal:duplicate
// ----------------------------------
requestMethod = 'POST';
const dealId = this.getNodeParameter('dealId', i) as number;
endpoint = `/deals/${dealId}/duplicate`;
} else if (operation === 'get') {
// ----------------------------------
// deal:get
// ----------------------------------
requestMethod = 'GET';
const dealId = this.getNodeParameter('dealId', i) as number;
endpoint = `/deals/${dealId}`;
} else if (operation === 'getAll') {
// ----------------------------------
// deal:getAll
// ----------------------------------
requestMethod = 'GET';
returnAll = this.getNodeParameter('returnAll', i);
if (!returnAll) {
qs.limit = this.getNodeParameter('limit', i);
}
const filters = this.getNodeParameter('filters', i);
addAdditionalFields(qs, filters);
endpoint = '/deals';
} else if (operation === 'update') {
// ----------------------------------
// deal:update
// ----------------------------------
requestMethod = 'PUT';
const dealId = this.getNodeParameter('dealId', i) as number;
endpoint = `/deals/${dealId}`;
const updateFields = this.getNodeParameter('updateFields', i);
addAdditionalFields(body, updateFields);
if (body.label === 'null') {
body.label = null;
}
} else if (operation === 'search') {
// ----------------------------------
// deal:search
// ----------------------------------
requestMethod = 'GET';
qs.term = this.getNodeParameter('term', i) as string;
returnAll = this.getNodeParameter('returnAll', i);
qs.exact_match = this.getNodeParameter('exactMatch', i) as boolean;
if (!returnAll) {
qs.limit = this.getNodeParameter('limit', i);
}
const additionalFields = this.getNodeParameter('additionalFields', i);
if (additionalFields.fields) {
qs.fields = (additionalFields.fields as string[]).join(',');
}
if (additionalFields.organizationId) {
qs.organization_id = parseInt(additionalFields.organizationId as string, 10);
}
if (additionalFields.includeFields) {
qs.include_fields = additionalFields.includeFields as string;
}
if (additionalFields.personId) {
qs.person_id = parseInt(additionalFields.personId as string, 10);
}
if (additionalFields.status) {
qs.status = additionalFields.status as string;
}
endpoint = '/deals/search';
}
} else if (resource === 'dealActivity') {
if (operation === 'getAll') {
// ----------------------------------
// dealActivity: getAll
// ----------------------------------
requestMethod = 'GET';
const dealId = this.getNodeParameter('dealId', i) as string;
returnAll = this.getNodeParameter('returnAll', i);
if (!returnAll) {
qs.limit = this.getNodeParameter('limit', i);
}
const additionalFields = this.getNodeParameter('additionalFields', i);
if (additionalFields.exclude) {
qs.exclude = additionalFields.exclude as string;
}
if (additionalFields?.done !== undefined) {
qs.done = additionalFields.done === true ? 1 : 0;
}
endpoint = `/deals/${dealId}/activities`;
}
} else if (resource === 'dealProduct') {
if (operation === 'add') {
// ----------------------------------
// dealProduct: add
// ----------------------------------
requestMethod = 'POST';
const dealId = this.getNodeParameter('dealId', i) as string;
endpoint = `/deals/${dealId}/products`;
body.product_id = this.getNodeParameter('productId', i) as string;
body.item_price = this.getNodeParameter('item_price', i) as string;
body.quantity = this.getNodeParameter('quantity', i) as string;
const additionalFields = this.getNodeParameter('additionalFields', i);
addAdditionalFields(body, additionalFields);
} else if (operation === 'getAll') {
// ----------------------------------
// dealProduct: getAll
// ----------------------------------
requestMethod = 'GET';
const dealId = this.getNodeParameter('dealId', i) as string;
endpoint = `/deals/${dealId}/products`;
} else if (operation === 'remove') {
// ----------------------------------
// dealProduct: remove
// ----------------------------------
requestMethod = 'DELETE';
const dealId = this.getNodeParameter('dealId', i) as string;
const productAttachmentId = this.getNodeParameter('productAttachmentId', i) as string;
endpoint = `/deals/${dealId}/products/${productAttachmentId}`;
} else if (operation === 'update') {
// ----------------------------------
// dealProduct: update
// ----------------------------------
requestMethod = 'PUT';
const dealId = this.getNodeParameter('dealId', i) as string;
const productAttachmentId = this.getNodeParameter('productAttachmentId', i) as string;
endpoint = `/deals/${dealId}/products/${productAttachmentId}`;
const updateFields = this.getNodeParameter('updateFields', i);
addAdditionalFields(body, updateFields);
}
} else if (resource === 'file') {
if (operation === 'create') {
// ----------------------------------
// file:create
// ----------------------------------
requestMethod = 'POST';
endpoint = '/files';
const binaryPropertyName = this.getNodeParameter('binaryPropertyName', i);
const binaryData = this.helpers.assertBinaryData(i, binaryPropertyName);
const fileBufferData = await this.helpers.getBinaryDataBuffer(i, binaryPropertyName);
formData.file = {
value: fileBufferData,
options: {
contentType: binaryData.mimeType,
filename: binaryData.fileName,
},
};
const additionalFields = this.getNodeParameter('additionalFields', i);
addAdditionalFields(formData, additionalFields);
} else if (operation === 'delete') {
// ----------------------------------
// file:delete
// ----------------------------------
requestMethod = 'DELETE';
const fileId = this.getNodeParameter('fileId', i) as number;
endpoint = `/files/${fileId}`;
} else if (operation === 'download') {
// ----------------------------------
// file:download
// ----------------------------------
requestMethod = 'GET';
downloadFile = true;
const fileId = this.getNodeParameter('fileId', i) as number;
endpoint = `/files/${fileId}/download`;
} else if (operation === 'get') {
// ----------------------------------
// file:get
// ----------------------------------
requestMethod = 'GET';
const fileId = this.getNodeParameter('fileId', i) as number;
endpoint = `/files/${fileId}`;
} else if (operation === 'update') {
// ----------------------------------
// file:update
// ----------------------------------
requestMethod = 'PUT';
const fileId = this.getNodeParameter('fileId', i) as number;
const updateFields = this.getNodeParameter('updateFields', i);
endpoint = `/files/${fileId}`;
addAdditionalFields(body, updateFields);
}
} else if (resource === 'note') {
if (operation === 'create') {
// ----------------------------------
// note:create
// ----------------------------------
requestMethod = 'POST';
endpoint = '/notes';
body.content = this.getNodeParameter('content', i) as string;
const additionalFields = this.getNodeParameter('additionalFields', i);
addAdditionalFields(body, additionalFields);
} else if (operation === 'delete') {
// ----------------------------------
// note:delete
// ----------------------------------
requestMethod = 'DELETE';
const noteId = this.getNodeParameter('noteId', i) as number;
endpoint = `/notes/${noteId}`;
} else if (operation === 'get') {
// ----------------------------------
// note:get
// ----------------------------------
requestMethod = 'GET';
const noteId = this.getNodeParameter('noteId', i) as number;
endpoint = `/notes/${noteId}`;
} else if (operation === 'getAll') {
// ----------------------------------
// note:getAll
// ----------------------------------
requestMethod = 'GET';
endpoint = '/notes';
returnAll = this.getNodeParameter('returnAll', i);
if (!returnAll) {
qs.limit = this.getNodeParameter('limit', i);
}
const additionalFields = this.getNodeParameter('additionalFields', i);
addAdditionalFields(qs, additionalFields);
} else if (operation === 'update') {
// ----------------------------------
// note:update
// ----------------------------------
requestMethod = 'PUT';
const noteId = this.getNodeParameter('noteId', i) as number;
endpoint = `/notes/${noteId}`;
const updateFields = this.getNodeParameter('updateFields', i);
addAdditionalFields(body, updateFields);
}
} else if (resource === 'lead') {
if (operation === 'create') {
// ----------------------------------------
// lead: create
// ----------------------------------------
// https://developers.pipedrive.com/docs/api/v1/Leads#addLead
body = {
title: this.getNodeParameter('title', i),
} as IDataObject;
const associateWith = this.getNodeParameter('associateWith', i) as
| 'organization'
| 'person';
if (associateWith === 'organization') {
body.organization_id = this.getNodeParameter('organization_id', i) as number;
} else {
body.person_id = this.getNodeParameter('person_id', i) as number;
}
const { value, expected_close_date, ...rest } = this.getNodeParameter(
'additionalFields',
i,
) as {
value: {
valueProperties: {
amount: number;
currency: string;
};
};
expected_close_date: string;
person_id: number;
organization_id: number;
};
if (Object.keys(rest).length) {
Object.assign(body, rest);
}
if (value) {
Object.assign(body, { value: value.valueProperties });
}
if (expected_close_date) {
body.expected_close_date = expected_close_date.split('T')[0];
}
requestMethod = 'POST';
endpoint = '/leads';
} else if (operation === 'delete') {
// ----------------------------------------
// lead: delete
// ----------------------------------------
// https://developers.pipedrive.com/docs/api/v1/Leads#deleteLead
const leadId = this.getNodeParameter('leadId', i);
requestMethod = 'DELETE';
endpoint = `/leads/${leadId}`;
} else if (operation === 'get') {
// ----------------------------------------
// lead: get
// ----------------------------------------
// https://developers.pipedrive.com/docs/api/v1/Leads#getLead
const leadId = this.getNodeParameter('leadId', i);
requestMethod = 'GET';
endpoint = `/leads/${leadId}`;
} else if (operation === 'getAll') {
// ----------------------------------------
// lead: getAll
// ----------------------------------------
// https://developers.pipedrive.com/docs/api/v1/Leads#getLeads
returnAll = this.getNodeParameter('returnAll', i);
if (!returnAll) {
qs.limit = this.getNodeParameter('limit', i);
}
const filters = this.getNodeParameter('filters', i);
if (Object.keys(filters).length) {
Object.assign(qs, filters);
}
requestMethod = 'GET';
endpoint = '/leads';
} else if (operation === 'update') {
// ----------------------------------------
// lead: update
// ----------------------------------------
// https://developers.pipedrive.com/docs/api/v1/Leads#updateLead
const { value, expected_close_date, ...rest } = this.getNodeParameter(
'updateFields',
i,
) as {
value: {
valueProperties: {
amount: number;
currency: string;
};
};
expected_close_date: string;
};
if (Object.keys(rest).length) {
Object.assign(body, rest);
}
if (value) {
Object.assign(body, { value: value.valueProperties });
}
if (expected_close_date) {
body.expected_close_date = expected_close_date.split('T')[0];
}
if (Object.keys(rest).length) {
Object.assign(body, rest);
}
const leadId = this.getNodeParameter('leadId', i);
requestMethod = 'PATCH';
endpoint = `/leads/${leadId}`;
}
} else if (resource === 'organization') {
if (operation === 'create') {
// ----------------------------------
// organization:create
// ----------------------------------
requestMethod = 'POST';
endpoint = '/organizations';
body.name = this.getNodeParameter('name', i) as string;
const additionalFields = this.getNodeParameter('additionalFields', i);
addAdditionalFields(body, additionalFields);
} else if (operation === 'delete') {
// ----------------------------------
// organization:delete
// ----------------------------------
requestMethod = 'DELETE';
const organizationId = this.getNodeParameter('organizationId', i) as number;
endpoint = `/organizations/${organizationId}`;
} else if (operation === 'get') {
// ----------------------------------
// organization:get
// ----------------------------------
requestMethod = 'GET';
const organizationId = this.getNodeParameter('organizationId', i) as number;
endpoint = `/organizations/${organizationId}`;
} else if (operation === 'getAll') {
// ----------------------------------
// organization:getAll
// ----------------------------------
requestMethod = 'GET';
returnAll = this.getNodeParameter('returnAll', i);
if (!returnAll) {
qs.limit = this.getNodeParameter('limit', i);
}
const filters = this.getNodeParameter('filters', i);
if (filters.filterId) {
qs.filter_id = filters.filterId as string;
}
if (filters.firstChar) {
qs.first_char = filters.firstChar as string;
qs.first_char = qs.first_char.substring(0, 1);
}
endpoint = '/organizations';
} else if (operation === 'update') {
// ----------------------------------
// organization:update
// ----------------------------------
const id = this.getNodeParameter('organizationId', i) as string;
requestMethod = 'PUT';
endpoint = `/organizations/${id}`;
const updateFields = this.getNodeParameter('updateFields', i);
addAdditionalFields(body, updateFields);
if (body.label === 'null') {
body.label = null;
}
} else if (operation === 'search') {
// ----------------------------------
// organization:search
// ----------------------------------
requestMethod = 'GET';
qs.term = this.getNodeParameter('term', i) as string;
returnAll = this.getNodeParameter('returnAll', i);
if (!returnAll) {
qs.limit = this.getNodeParameter('limit', i);
}
const additionalFields = this.getNodeParameter('additionalFields', i) as IDataObject & {
fields?: string[];
};
if (additionalFields?.fields?.length) {
qs.fields = additionalFields.fields.join(',');
}
if (additionalFields.exactMatch) {
qs.exact_match = additionalFields.exactMatch as boolean;
}
endpoint = '/organizations/search';
}
} else if (resource === 'person') {
if (operation === 'create') {
// ----------------------------------
// person:create
// ----------------------------------
requestMethod = 'POST';
endpoint = '/persons';
body.name = this.getNodeParameter('name', i) as string;
const additionalFields = this.getNodeParameter('additionalFields', i);
addAdditionalFields(body, additionalFields);
} else if (operation === 'delete') {
// ----------------------------------
// person:delete
// ----------------------------------
requestMethod = 'DELETE';
const personId = this.getNodeParameter('personId', i) as number;
endpoint = `/persons/${personId}`;
} else if (operation === 'get') {
// ----------------------------------
// person:get
// ----------------------------------
requestMethod = 'GET';
const personId = this.getNodeParameter('personId', i) as number;
endpoint = `/persons/${personId}`;
} else if (operation === 'getAll') {
// ----------------------------------
// person:getAll
// ----------------------------------
requestMethod = 'GET';
returnAll = this.getNodeParameter('returnAll', i);
if (!returnAll) {
qs.limit = this.getNodeParameter('limit', i);
}
const additionalFields = this.getNodeParameter('additionalFields', i);
if (additionalFields.filterId) {
qs.filter_id = additionalFields.filterId as string;
}
if (additionalFields.firstChar) {
qs.first_char = additionalFields.firstChar as string;
}
endpoint = '/persons';
} else if (operation === 'search') {
// ----------------------------------
// persons:search
// ----------------------------------
requestMethod = 'GET';
qs.term = this.getNodeParameter('term', i) as string;
returnAll = this.getNodeParameter('returnAll', i);
if (!returnAll) {
qs.limit = this.getNodeParameter('limit', i);
}
const additionalFields = this.getNodeParameter('additionalFields', i);
if (additionalFields.fields) {
qs.fields = additionalFields.fields as string;
}
if (additionalFields.exactMatch) {
qs.exact_match = additionalFields.exactMatch as boolean;
}
if (additionalFields.organizationId) {
qs.organization_id = parseInt(additionalFields.organizationId as string, 10);
}
if (additionalFields.includeFields) {
qs.include_fields = additionalFields.includeFields as string;
}
endpoint = '/persons/search';
} else if (operation === 'update') {
// ----------------------------------
// person:update
// ----------------------------------
requestMethod = 'PUT';
const personId = this.getNodeParameter('personId', i) as number;
endpoint = `/persons/${personId}`;
const updateFields = this.getNodeParameter('updateFields', i);
addAdditionalFields(body, updateFields);
if (body.label === 'null') {
body.label = null;
}
}
} else if (resource === 'product') {
if (operation === 'getAll') {
// ----------------------------------
// product:getAll
// ----------------------------------
requestMethod = 'GET';
returnAll = this.getNodeParameter('returnAll', i);
if (!returnAll) {
qs.limit = this.getNodeParameter('limit', i);
}
endpoint = '/products';
}
} else {
throw new NodeOperationError(this.getNode(), `The resource "${resource}" is not known!`, {
itemIndex: i,
});
}
let responseData;
if (returnAll) {
responseData = await pipedriveApiRequestAllItems.call(
this,
requestMethod,
endpoint,
body,
qs,
);
} else {
if (customProperties !== undefined) {
pipedriveEncodeCustomProperties(customProperties, body);
}
responseData = await pipedriveApiRequest.call(
this,
requestMethod,
endpoint,
body,
qs,
formData,
downloadFile,
);
}
if (resource === 'file' && operation === 'download') {
const newItem: INodeExecutionData = {
json: items[i].json,
pairedItem: { item: i },
binary: {},
};
if (items[i].binary !== undefined) {
// Create a shallow copy of the binary data so that the old
// data references which do not get changed still stay behind
// but the incoming data does not get changed.
Object.assign(newItem.binary!, items[i].binary);
}
items[i] = newItem;
const binaryPropertyName = this.getNodeParameter('binaryPropertyName', i);
items[i].binary![binaryPropertyName] = await this.helpers.prepareBinaryData(
responseData.data as Buffer,
);
} else {
if (responseData.data === null) {
responseData.data = [];
}
if (operation === 'search' && responseData.data?.items) {
responseData.data = responseData.data.items;
const additionalFields = this.getNodeParameter('additionalFields', i);
if (additionalFields.rawData !== true) {
responseData.data = responseData.data.map(
(item: { result_score: number; item: object }) => {
return {
result_score: item.result_score,
...item.item,
};
},
);
}
}
responseData = responseData.data;
if (responseData.data === true) {
responseData = { success: true };
}
const executionData = this.helpers.constructExecutionMetaData(
this.helpers.returnJsonArray(responseData as IDataObject[]),
{ itemData: { item: i } },
);
returnData.push(...executionData);
}
} catch (error) {
if (this.continueOnFail()) {
if (resource === 'file' && operation === 'download') {
items[i].json = { error: error.message };
} else {
returnData.push({ json: { error: error.message }, pairedItem: { item: i } });
}
continue;
}
throw error;
}
}
if (customProperties !== undefined) {
for (const item of returnData) {
pipedriveResolveCustomProperties(customProperties, item);
}
}
if (resource === 'file' && operation === 'download') {
// For file downloads the files get attached to the existing items
return [items];
} else {
// For all other ones does the output items get replaced
return [returnData];
}
}
}
Reference in a new issue View git blame Copy permalink