import type { INodeProperties } from 'n8n-workflow'; export const dealOperations: INodeProperties[] = [ { 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: 'Get', value: 'get', description: 'Get a deal', action: 'Get a deal', }, { name: 'Get Many', value: 'getAll', description: 'Get many deals', action: 'Get many deals', }, { name: 'Get Recently Created/Updated', value: 'getRecentlyCreatedUpdated', description: 'Get recently created/updated deals', action: 'Get recently created/updated deals', }, { name: 'Search', value: 'search', description: 'Search deals', action: 'Search for deals', }, { name: 'Update', value: 'update', description: 'Update a deal', action: 'Update a deal', }, ], default: 'create', }, ]; export const dealFields: INodeProperties[] = [ /* -------------------------------------------------------------------------- */ /* deal:create */ /* -------------------------------------------------------------------------- */ { displayName: 'Deal Stage Name or ID', name: 'stage', type: 'options', required: true, typeOptions: { loadOptionsMethod: 'getDealStages', }, displayOptions: { show: { resource: ['deal'], operation: ['create'], }, }, default: '', options: [], description: 'The deal stage is required when creating a deal. See the CRM Pipelines API for details on managing pipelines and stages. Choose from the list, or specify an ID using an expression.', }, { displayName: 'Deal Properties', name: 'additionalFields', type: 'collection', placeholder: 'Add Field', default: {}, displayOptions: { show: { resource: ['deal'], operation: ['create'], }, }, options: [ { displayName: 'Amount', name: 'amount', type: 'string', default: '', }, { displayName: 'Associated Company Names or IDs', name: 'associatedCompany', type: 'multiOptions', description: 'Whether to include specific Associated Company properties in the returned results. Choose from a list, or specify IDs using an expression. Choose from the list, or specify IDs using an expression.', typeOptions: { loadOptionsMethod: 'getCompanies', }, default: [], }, { displayName: 'Associated Vid Names or IDs', name: 'associatedVids', type: 'multiOptions', description: 'Whether to include specific Associated Vid in the returned results. Choose from a list, or specify IDs using an expression. Choose from the list, or specify IDs using an expression.', typeOptions: { loadOptionsMethod: 'getContacts', }, default: [], }, { displayName: 'Close Date', name: 'closeDate', type: 'dateTime', default: '', description: 'When using expressions, the time should be specified in YYYY-MM-DD hh-mm-ss format', }, { displayName: 'Custom Properties', name: 'customPropertiesUi', placeholder: 'Add Custom Property', type: 'fixedCollection', typeOptions: { multipleValues: true, }, default: {}, options: [ { name: 'customPropertiesValues', displayName: 'Custom Property', values: [ { displayName: 'Property Name or ID', name: 'property', type: 'options', typeOptions: { loadOptionsMethod: 'getDealCustomProperties', }, default: '', description: 'Name of the property. Choose from the list, or specify an ID using an expression.', }, { displayName: 'Value', name: 'value', type: 'string', default: '', required: true, description: 'Value of the property', }, ], }, ], }, { displayName: 'Deal Description', name: 'description', type: 'string', default: '', }, { displayName: 'Deal Name', name: 'dealName', type: 'string', default: '', }, { displayName: 'Deal Owner', name: 'dealOwner', type: 'resourceLocator', default: { mode: 'list', value: '' }, modes: [ { displayName: 'From List', name: 'list', type: 'list', placeholder: 'Select from the list', typeOptions: { searchListMethod: 'searchOwners', }, }, { displayName: 'By Id', name: 'id', type: 'string', placeholder: '58539222', validation: [ { type: 'regex', properties: { regex: '[0-9]+', errorMessage: 'Not a valid HubSpot Owner ID', }, }, ], }, ], description: 'The HubSpot user to be assigned to the deal', }, { displayName: 'Deal Type Name or ID', name: 'dealType', type: 'options', description: 'Choose from the list, or specify an ID using an expression', typeOptions: { loadOptionsMethod: 'getDealTypes', }, default: '', }, { displayName: 'Pipeline Name or ID', name: 'pipeline', type: 'options', description: 'Choose from the list, or specify an ID using an expression', typeOptions: { loadOptionsMethod: 'getDealPipelines', }, default: '', }, ], }, /* -------------------------------------------------------------------------- */ /* deal:update */ /* -------------------------------------------------------------------------- */ { displayName: 'Deal to Update', name: 'dealId', type: 'resourceLocator', default: { mode: 'list', value: '' }, required: true, displayOptions: { show: { resource: ['deal'], operation: ['update'], }, }, modes: [ { displayName: 'From List', name: 'list', type: 'list', placeholder: 'Select from the list', typeOptions: { searchListMethod: 'searchDeals', searchable: true, }, }, { displayName: 'By Id', name: 'id', type: 'string', placeholder: '58539222', validation: [ { type: 'regex', properties: { regex: '[0-9]+', errorMessage: 'Not a valid HubSpot Deal ID', }, }, ], }, ], }, { displayName: 'Update Fields', name: 'updateFields', type: 'collection', placeholder: 'Add Update Field', default: {}, displayOptions: { show: { resource: ['deal'], operation: ['update'], }, }, options: [ { displayName: 'Amount', name: 'amount', type: 'string', default: '', }, { displayName: 'Close Date', name: 'closeDate', type: 'dateTime', default: '', description: 'When using expressions, the time should be specified in YYYY-MM-DD hh-mm-ss format', }, { displayName: 'Custom Properties', name: 'customPropertiesUi', placeholder: 'Add Custom Property', type: 'fixedCollection', typeOptions: { multipleValues: true, }, default: {}, options: [ { name: 'customPropertiesValues', displayName: 'Custom Property', values: [ { displayName: 'Property Name or ID', name: 'property', type: 'options', typeOptions: { loadOptionsMethod: 'getDealCustomProperties', }, default: '', description: 'Name of the property. Choose from the list, or specify an ID using an expression.', }, { displayName: 'Value', name: 'value', type: 'string', default: '', required: true, description: 'Value of the property', }, ], }, ], }, { displayName: 'Deal Description', name: 'description', type: 'string', default: '', }, { displayName: 'Deal Name', name: 'dealName', type: 'string', default: '', }, { displayName: 'Deal Owner', name: 'dealOwner', type: 'resourceLocator', default: { mode: 'list', value: '' }, modes: [ { displayName: 'From List', name: 'list', type: 'list', placeholder: 'Select from the list', typeOptions: { searchListMethod: 'searchOwners', }, }, { displayName: 'By Id', name: 'id', type: 'string', placeholder: '58539222', validation: [ { type: 'regex', properties: { regex: '[0-9]+', errorMessage: 'Not a valid HubSpot Owner ID', }, }, ], }, ], description: 'The HubSpot user to be assigned to the deal', }, { displayName: 'Deal Stage Name or ID', name: 'stage', type: 'options', typeOptions: { loadOptionsMethod: 'getDealStages', }, default: '', description: 'The deal stage is required when creating a deal. See the CRM Pipelines API for details on managing pipelines and stages. Choose from the list, or specify an ID using an expression.', }, { displayName: 'Deal Type Name or ID', name: 'dealType', type: 'options', description: 'Choose from the list, or specify an ID using an expression', typeOptions: { loadOptionsMethod: 'getDealTypes', }, default: '', }, { displayName: 'Pipeline', name: 'pipeline', type: 'string', default: '', }, ], }, /* -------------------------------------------------------------------------- */ /* deal:get */ /* -------------------------------------------------------------------------- */ { displayName: 'Deal to Get', name: 'dealId', type: 'resourceLocator', default: { mode: 'list', value: '' }, required: true, displayOptions: { show: { resource: ['deal'], operation: ['get'], }, }, modes: [ { displayName: 'From List', name: 'list', type: 'list', placeholder: 'Select from the list', typeOptions: { searchListMethod: 'searchDeals', searchable: true, }, }, { displayName: 'By Id', name: 'id', type: 'string', placeholder: '58539222', validation: [ { type: 'regex', properties: { regex: '[0-9]+', errorMessage: 'Not a valid HubSpot Deal ID', }, }, ], }, ], }, { displayName: 'Filters', name: 'filters', type: 'collection', placeholder: 'Add Filter', default: {}, displayOptions: { show: { resource: ['deal'], operation: ['get'], }, }, options: [ { displayName: 'Include Property Versions', name: 'includePropertyVersions', type: 'boolean', default: false, // eslint-disable-next-line n8n-nodes-base/node-param-description-boolean-without-whether description: 'By default, you will only get data for the most recent version of a property in the "versions" data. If you include this parameter, you will get data for all previous versions.', }, { displayName: 'Deal Properties to Include', name: 'propertiesCollection', type: 'fixedCollection', default: {}, options: [ { name: 'propertiesValues', displayName: 'Deal Properties to Include', values: [ { displayName: 'Deal Properties to Include', name: 'properties', type: 'multiOptions', typeOptions: { loadOptionsMethod: 'getDealProperties', }, default: [], description: 'Whether to include specific Deal properties in the returned results. Choose from a list, or specify IDs using an expression. Choose from the list, or specify IDs using an expression.', }, { displayName: 'Include', name: 'propertyMode', type: 'options', options: [ { name: 'Value And History', value: 'valueAndHistory', }, { name: 'Value Only', value: 'valueOnly', }, ], default: 'valueAndHistory', description: 'Specify if the current value for a property should be fetched, or the value and all the historical values for that property', }, ], }, ], description: '
Used to include specific deal properties in the results. By default, the results will only include Deal ID and will not include the values for any properties for your Deals.
Including this parameter will include the data for the specified property in the results. You can include this parameter multiple times to request multiple properties separated by a comma: ,
.
Used to include specific deal properties in the results. By default, the results will only include Deal ID and will not include the values for any properties for your Deals.
Including this parameter will include the data for the specified property in the results. You can include this parameter multiple times to request multiple properties separated by a comma: ,
.