2020-10-23 00:31:32 -07:00
import {
INodeProperties ,
} from 'n8n-workflow' ;
2020-01-15 05:55:46 -08:00
2021-12-03 00:44:16 -08:00
export const contactOperations : INodeProperties [ ] = [
2020-01-15 05:55:46 -08:00
{
displayName : 'Operation' ,
name : 'operation' ,
type : 'options' ,
2022-05-20 14:47:24 -07:00
noDataExpression : true ,
2020-01-15 05:55:46 -08:00
displayOptions : {
show : {
resource : [
'contact' ,
] ,
} ,
} ,
options : [
{
name : 'Create' ,
value : 'create' ,
description : 'Create a new contact' ,
2022-07-10 13:50:51 -07:00
action : 'Create a contact' ,
2020-01-15 05:55:46 -08:00
} ,
{
2020-10-23 00:31:32 -07:00
name : 'Delete' ,
value : 'delete' ,
description : 'Delete a contact' ,
2022-07-10 13:50:51 -07:00
action : 'Delete a contact' ,
2020-01-15 05:55:46 -08:00
} ,
2022-02-28 00:04:55 -08:00
{
name : 'Edit Contact Points' ,
value : 'editContactPoint' ,
description : 'Edit contact\'s points' ,
2022-07-10 13:50:51 -07:00
action : 'Edit a contact\'s points' ,
2022-02-28 00:04:55 -08:00
} ,
{
name : 'Edit Do Not Contact List' ,
value : 'editDoNotContactList' ,
description : 'Add/remove contacts from/to the do not contact list' ,
2022-07-10 13:50:51 -07:00
action : 'Add/remove contacts from/to the do not contact list' ,
2022-02-28 00:04:55 -08:00
} ,
2020-01-15 05:55:46 -08:00
{
name : 'Get' ,
value : 'get' ,
description : 'Get data of a contact' ,
2022-07-10 13:50:51 -07:00
action : 'Get a contact' ,
2020-01-15 05:55:46 -08:00
} ,
{
name : 'Get All' ,
value : 'getAll' ,
description : 'Get data of all contacts' ,
2022-07-10 13:50:51 -07:00
action : 'Get all contacts' ,
2020-01-15 05:55:46 -08:00
} ,
2022-02-28 00:04:55 -08:00
{
name : 'Send Email' ,
value : 'sendEmail' ,
description : 'Send email to contact' ,
2022-07-10 13:50:51 -07:00
action : 'Send email to a contact' ,
2022-02-28 00:04:55 -08:00
} ,
2020-01-15 05:55:46 -08:00
{
2020-10-23 00:31:32 -07:00
name : 'Update' ,
value : 'update' ,
description : 'Update a contact' ,
2022-07-10 13:50:51 -07:00
action : 'Update a contact' ,
2020-01-15 05:55:46 -08:00
} ,
] ,
default : 'create' ,
} ,
2021-12-03 00:44:16 -08:00
] ;
2020-01-15 05:55:46 -08:00
2021-12-03 00:44:16 -08:00
export const contactFields : INodeProperties [ ] = [
2020-01-15 05:55:46 -08:00
2020-10-23 00:31:32 -07:00
/* -------------------------------------------------------------------------- */
/* contact:create */
/* -------------------------------------------------------------------------- */
2020-01-15 05:55:46 -08:00
{
displayName : 'JSON Parameters' ,
name : 'jsonParameters' ,
type : 'boolean' ,
default : false ,
displayOptions : {
show : {
operation : [
'create' ,
] ,
resource : [
'contact' ,
] ,
} ,
} ,
} ,
2020-01-30 11:45:50 -08:00
{
displayName : 'Email' ,
name : 'email' ,
type : 'string' ,
2022-06-20 07:54:01 -07:00
placeholder : 'name@email.com' ,
2020-01-30 11:45:50 -08:00
displayOptions : {
show : {
resource : [
'contact' ,
] ,
operation : [
'create' ,
] ,
jsonParameters : [
false ,
2020-10-22 06:46:03 -07:00
] ,
2020-01-30 11:45:50 -08:00
} ,
} ,
default : '' ,
2022-05-06 14:01:25 -07:00
description : 'Email address of the contact' ,
2020-01-30 11:45:50 -08:00
} ,
2020-01-15 05:55:46 -08:00
{
displayName : 'First Name' ,
name : 'firstName' ,
type : 'string' ,
displayOptions : {
show : {
resource : [
'contact' ,
] ,
operation : [
'create' ,
] ,
jsonParameters : [
false ,
2020-10-22 06:46:03 -07:00
] ,
2020-01-15 05:55:46 -08:00
} ,
} ,
default : '' ,
} ,
{
displayName : 'Last Name' ,
name : 'lastName' ,
type : 'string' ,
displayOptions : {
show : {
resource : [
'contact' ,
] ,
operation : [
'create' ,
] ,
jsonParameters : [
false ,
] ,
} ,
} ,
default : '' ,
} ,
{
2022-06-03 10:23:49 -07:00
displayName : 'Primary Company Name or ID' ,
2020-01-15 05:55:46 -08:00
name : 'company' ,
type : 'options' ,
2022-06-20 07:54:01 -07:00
description : 'Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/nodes/expressions.html#expressions">expression</a>' ,
2020-01-15 05:55:46 -08:00
typeOptions : {
loadOptionsMethod : 'getCompanies' ,
} ,
displayOptions : {
show : {
resource : [
'contact' ,
] ,
operation : [
'create' ,
] ,
jsonParameters : [
false ,
] ,
} ,
} ,
default : '' ,
} ,
{
displayName : 'Position' ,
name : 'position' ,
type : 'string' ,
displayOptions : {
show : {
resource : [
'contact' ,
] ,
operation : [
'create' ,
] ,
jsonParameters : [
false ,
] ,
} ,
} ,
default : '' ,
} ,
{
displayName : 'Title' ,
name : 'title' ,
type : 'string' ,
displayOptions : {
show : {
resource : [
'contact' ,
] ,
operation : [
'create' ,
] ,
jsonParameters : [
false ,
] ,
} ,
} ,
default : '' ,
} ,
{
displayName : 'Body' ,
name : 'bodyJson' ,
type : 'json' ,
displayOptions : {
show : {
operation : [
'create' ,
] ,
resource : [
'contact' ,
] ,
jsonParameters : [
true ,
] ,
} ,
} ,
default : '' ,
description : 'Contact parameters' ,
} ,
{
displayName : 'Additional Fields' ,
name : 'additionalFields' ,
type : 'collection' ,
placeholder : 'Add Field' ,
default : { } ,
displayOptions : {
show : {
resource : [
'contact' ,
] ,
operation : [
'create' ,
] ,
} ,
} ,
options : [
2020-06-10 14:37:01 -07:00
{
displayName : 'Address' ,
name : 'addressUi' ,
placeholder : 'Address' ,
type : 'fixedCollection' ,
typeOptions : {
multipleValues : false ,
} ,
default : { } ,
options : [
{
name : 'addressValues' ,
displayName : 'Address' ,
values : [
{
displayName : 'Address Line 1' ,
name : 'address1' ,
type : 'string' ,
default : '' ,
} ,
{
displayName : 'Address Line 2' ,
name : 'address2' ,
type : 'string' ,
default : '' ,
} ,
{
displayName : 'City' ,
name : 'city' ,
type : 'string' ,
default : '' ,
} ,
{
displayName : 'State' ,
name : 'state' ,
type : 'string' ,
default : '' ,
} ,
{
displayName : 'Country' ,
name : 'country' ,
type : 'string' ,
default : '' ,
} ,
{
displayName : 'Zip Code' ,
name : 'zipCode' ,
type : 'string' ,
default : '' ,
} ,
] ,
} ,
] ,
} ,
{
displayName : 'B2B or B2C' ,
name : 'b2bOrb2c' ,
type : 'options' ,
options : [
{
name : 'B2B' ,
value : 'B2B' ,
} ,
{
name : 'B2C' ,
value : 'B2C' ,
} ,
] ,
default : '' ,
} ,
{
displayName : 'CRM ID' ,
name : 'crmId' ,
type : 'string' ,
default : '' ,
} ,
2021-01-23 10:34:36 -08:00
{
displayName : 'Custom Fields' ,
name : 'customFieldsUi' ,
placeholder : 'Add Custom Fields' ,
2022-05-06 14:01:25 -07:00
description : 'Adds a custom fields to set also values which have not been predefined' ,
2021-01-23 10:34:36 -08:00
type : 'fixedCollection' ,
typeOptions : {
multipleValues : true ,
} ,
default : { } ,
options : [
{
name : 'customFieldValues' ,
displayName : 'Field' ,
values : [
{
2022-06-03 10:23:49 -07:00
displayName : 'Field Name or ID' ,
2021-01-23 10:34:36 -08:00
name : 'fieldId' ,
type : 'options' ,
typeOptions : {
loadOptionsMethod : 'getContactFields' ,
} ,
default : '' ,
2022-06-03 10:23:49 -07:00
description : 'ID of the field to set. Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/nodes/expressions.html#expressions">expression</a>.' ,
2021-01-23 10:34:36 -08:00
} ,
{
displayName : 'Field Value' ,
name : 'fieldValue' ,
type : 'string' ,
default : '' ,
2022-05-06 14:01:25 -07:00
description : 'Value of the field to set' ,
2021-01-23 10:34:36 -08:00
} ,
] ,
} ,
] ,
} ,
2020-06-10 14:37:01 -07:00
{
displayName : 'Fax' ,
name : 'fax' ,
type : 'string' ,
default : '' ,
} ,
{
displayName : 'Has Purchased' ,
name : 'hasPurchased' ,
type : 'boolean' ,
default : false ,
} ,
2020-01-15 05:55:46 -08:00
{
displayName : 'IP Address' ,
name : 'ipAddress' ,
type : 'string' ,
default : '' ,
description : 'IP address to associate with the contact' ,
} ,
{
displayName : 'Last Active' ,
name : 'lastActive' ,
type : 'dateTime' ,
default : '' ,
description : 'Date/time in UTC;' ,
} ,
2020-06-10 14:37:01 -07:00
{
displayName : 'Mobile' ,
name : 'mobile' ,
type : 'string' ,
default : '' ,
} ,
2020-01-15 05:55:46 -08:00
{
displayName : 'Owner ID' ,
name : 'ownerId' ,
type : 'string' ,
default : '' ,
description : 'ID of a Mautic user to assign this contact to' ,
} ,
2020-06-10 14:37:01 -07:00
{
displayName : 'Phone' ,
name : 'phone' ,
type : 'string' ,
default : '' ,
} ,
{
displayName : 'Prospect or Customer' ,
name : 'prospectOrCustomer' ,
type : 'options' ,
options : [
{
name : 'Prospect' ,
value : 'Prospect' ,
} ,
{
name : 'Customer' ,
value : 'Customer' ,
} ,
] ,
default : '' ,
} ,
{
displayName : 'Sandbox' ,
name : 'sandbox' ,
type : 'boolean' ,
default : false ,
} ,
{
2022-06-03 10:23:49 -07:00
displayName : 'Stage Name or ID' ,
2020-06-10 14:37:01 -07:00
name : 'stage' ,
type : 'options' ,
2022-06-20 07:54:01 -07:00
description : 'Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/nodes/expressions.html#expressions">expression</a>' ,
2020-06-10 14:37:01 -07:00
typeOptions : {
loadOptionsMethod : 'getStages' ,
} ,
default : '' ,
} ,
{
2022-06-20 07:54:01 -07:00
displayName : 'Tag Names or IDs' ,
2020-06-10 14:37:01 -07:00
name : 'tags' ,
type : 'multiOptions' ,
2022-07-04 02:12:08 -07:00
description : 'Choose from the list, or specify IDs using an <a href="https://docs.n8n.io/nodes/expressions.html#expressions">expression</a>' ,
2020-06-10 14:37:01 -07:00
typeOptions : {
loadOptionsMethod : 'getTags' ,
} ,
2022-04-22 09:29:51 -07:00
default : [ ] ,
2020-06-10 14:37:01 -07:00
} ,
{
displayName : 'Social Media' ,
name : 'socialMediaUi' ,
placeholder : 'Social Media' ,
type : 'fixedCollection' ,
typeOptions : {
multipleValues : false ,
} ,
default : { } ,
options : [
{
name : 'socialMediaValues' ,
displayName : 'Social Media' ,
values : [
{
displayName : 'Facebook' ,
name : 'facebook' ,
type : 'string' ,
default : '' ,
} ,
{
displayName : 'Foursquare' ,
name : 'foursquare' ,
type : 'string' ,
default : '' ,
} ,
{
displayName : 'Instagram' ,
name : 'instagram' ,
type : 'string' ,
default : '' ,
} ,
{
displayName : 'LinkedIn' ,
name : 'linkedIn' ,
type : 'string' ,
default : '' ,
} ,
{
displayName : 'Skype' ,
name : 'skype' ,
type : 'string' ,
default : '' ,
} ,
{
displayName : 'Twitter' ,
name : 'twitter' ,
type : 'string' ,
default : '' ,
} ,
] ,
} ,
] ,
} ,
{
displayName : 'Website' ,
name : 'website' ,
type : 'string' ,
default : '' ,
} ,
2020-01-15 05:55:46 -08:00
] ,
} ,
2020-10-23 00:31:32 -07:00
/* -------------------------------------------------------------------------- */
/* contact:update */
/* -------------------------------------------------------------------------- */
2020-01-15 05:55:46 -08:00
{
displayName : 'Contact ID' ,
name : 'contactId' ,
type : 'string' ,
displayOptions : {
show : {
operation : [
'update' ,
] ,
resource : [
'contact' ,
] ,
} ,
} ,
default : '' ,
} ,
{
displayName : 'JSON Parameters' ,
name : 'jsonParameters' ,
type : 'boolean' ,
default : false ,
displayOptions : {
show : {
operation : [
'update' ,
] ,
resource : [
'contact' ,
] ,
} ,
} ,
} ,
{
displayName : 'Update Fields' ,
name : 'updateFields' ,
type : 'collection' ,
placeholder : 'Add Field' ,
default : { } ,
displayOptions : {
show : {
resource : [
'contact' ,
] ,
operation : [
'update' ,
] ,
} ,
} ,
options : [
{
displayName : 'Body' ,
name : 'bodyJson' ,
type : 'json' ,
displayOptions : {
show : {
'/jsonParameters' : [
true ,
] ,
} ,
} ,
default : '' ,
description : 'Contact parameters' ,
} ,
2020-06-10 14:37:01 -07:00
{
displayName : 'Address' ,
name : 'addressUi' ,
placeholder : 'Address' ,
type : 'fixedCollection' ,
typeOptions : {
multipleValues : false ,
} ,
displayOptions : {
show : {
'/jsonParameters' : [
false ,
] ,
} ,
} ,
default : { } ,
options : [
{
name : 'addressValues' ,
displayName : 'Address' ,
values : [
{
displayName : 'Address Line 1' ,
name : 'address1' ,
type : 'string' ,
default : '' ,
} ,
{
displayName : 'Address Line 2' ,
name : 'address2' ,
type : 'string' ,
default : '' ,
} ,
{
displayName : 'City' ,
name : 'city' ,
type : 'string' ,
default : '' ,
} ,
{
displayName : 'State' ,
name : 'state' ,
type : 'string' ,
default : '' ,
} ,
{
displayName : 'Country' ,
name : 'country' ,
type : 'string' ,
default : '' ,
} ,
{
displayName : 'Zip Code' ,
name : 'zipCode' ,
type : 'string' ,
default : '' ,
} ,
] ,
} ,
] ,
} ,
{
displayName : 'B2B or B2C' ,
name : 'b2bOrb2c' ,
type : 'options' ,
displayOptions : {
show : {
'/jsonParameters' : [
false ,
] ,
} ,
} ,
options : [
{
name : 'B2B' ,
value : 'B2B' ,
} ,
{
name : 'B2C' ,
value : 'B2C' ,
} ,
] ,
default : '' ,
} ,
{
displayName : 'CRM ID' ,
name : 'crmId' ,
type : 'string' ,
displayOptions : {
show : {
'/jsonParameters' : [
false ,
] ,
} ,
} ,
default : '' ,
} ,
2021-01-23 10:34:36 -08:00
{
displayName : 'Custom Fields' ,
name : 'customFieldsUi' ,
placeholder : 'Add Custom Fields' ,
2022-05-06 14:01:25 -07:00
description : 'Adds a custom fields to set also values which have not been predefined' ,
2021-01-23 10:34:36 -08:00
type : 'fixedCollection' ,
typeOptions : {
multipleValues : true ,
} ,
default : { } ,
options : [
{
name : 'customFieldValues' ,
displayName : 'Field' ,
values : [
{
2022-06-03 10:23:49 -07:00
displayName : 'Field Name or ID' ,
2021-01-23 10:34:36 -08:00
name : 'fieldId' ,
type : 'options' ,
typeOptions : {
loadOptionsMethod : 'getContactFields' ,
} ,
default : '' ,
2022-06-03 10:23:49 -07:00
description : 'ID of the field to set. Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/nodes/expressions.html#expressions">expression</a>.' ,
2021-01-23 10:34:36 -08:00
} ,
{
displayName : 'Field Value' ,
name : 'fieldValue' ,
type : 'string' ,
default : '' ,
2022-05-06 14:01:25 -07:00
description : 'Value of the field to set' ,
2021-01-23 10:34:36 -08:00
} ,
] ,
} ,
] ,
} ,
2020-01-30 11:45:50 -08:00
{
displayName : 'Email' ,
name : 'email' ,
type : 'string' ,
2022-06-20 07:54:01 -07:00
placeholder : 'name@email.com' ,
2020-01-30 11:45:50 -08:00
displayOptions : {
show : {
'/jsonParameters' : [
false ,
] ,
} ,
} ,
default : '' ,
2022-05-06 14:01:25 -07:00
description : 'Email address of the contact' ,
2020-01-30 11:45:50 -08:00
} ,
2020-06-10 14:37:01 -07:00
{
displayName : 'Fax' ,
name : 'fax' ,
type : 'string' ,
displayOptions : {
show : {
'/jsonParameters' : [
false ,
] ,
} ,
} ,
default : '' ,
} ,
2020-01-15 05:55:46 -08:00
{
displayName : 'First Name' ,
name : 'firstName' ,
type : 'string' ,
displayOptions : {
show : {
'/jsonParameters' : [
false ,
] ,
} ,
} ,
default : '' ,
} ,
2020-06-10 14:37:01 -07:00
{
displayName : 'Has Purchased' ,
name : 'hasPurchased' ,
type : 'boolean' ,
displayOptions : {
show : {
'/jsonParameters' : [
false ,
] ,
} ,
} ,
default : false ,
} ,
{
displayName : 'IP Address' ,
name : 'ipAddress' ,
type : 'string' ,
displayOptions : {
show : {
'/jsonParameters' : [
false ,
] ,
} ,
} ,
default : '' ,
description : 'IP address to associate with the contact' ,
} ,
{
displayName : 'Last Active' ,
name : 'lastActive' ,
type : 'dateTime' ,
displayOptions : {
show : {
'/jsonParameters' : [
false ,
] ,
} ,
} ,
default : '' ,
description : 'Date/time in UTC;' ,
} ,
2020-01-15 05:55:46 -08:00
{
displayName : 'Last Name' ,
name : 'lastName' ,
type : 'string' ,
displayOptions : {
show : {
'/jsonParameters' : [
false ,
] ,
} ,
} ,
default : '' ,
description : 'LastName' ,
} ,
2020-06-10 14:37:01 -07:00
{
displayName : 'Mobile' ,
name : 'mobile' ,
type : 'string' ,
displayOptions : {
show : {
'/jsonParameters' : [
false ,
] ,
} ,
} ,
default : '' ,
} ,
{
displayName : 'Owner ID' ,
name : 'ownerId' ,
type : 'string' ,
displayOptions : {
show : {
'/jsonParameters' : [
false ,
] ,
} ,
} ,
default : '' ,
description : 'ID of a Mautic user to assign this contact to' ,
} ,
{
displayName : 'Phone' ,
name : 'phone' ,
type : 'string' ,
displayOptions : {
show : {
'/jsonParameters' : [
false ,
] ,
} ,
} ,
default : '' ,
} ,
{
displayName : 'Position' ,
name : 'position' ,
type : 'string' ,
displayOptions : {
show : {
'/jsonParameters' : [
false ,
] ,
} ,
} ,
default : '' ,
} ,
2020-01-15 05:55:46 -08:00
{
2022-06-03 10:23:49 -07:00
displayName : 'Primary Company Name or ID' ,
2020-01-15 05:55:46 -08:00
name : 'company' ,
type : 'options' ,
2022-06-20 07:54:01 -07:00
description : 'Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/nodes/expressions.html#expressions">expression</a>' ,
2020-01-15 05:55:46 -08:00
typeOptions : {
loadOptionsMethod : 'getCompanies' ,
} ,
displayOptions : {
show : {
'/jsonParameters' : [
false ,
] ,
} ,
} ,
default : '' ,
} ,
{
2020-06-10 14:37:01 -07:00
displayName : 'Prospect or Customer' ,
name : 'prospectOrCustomer' ,
type : 'options' ,
2020-01-15 05:55:46 -08:00
displayOptions : {
show : {
'/jsonParameters' : [
false ,
] ,
} ,
} ,
2020-06-10 14:37:01 -07:00
options : [
{
name : 'Prospect' ,
value : 'Prospect' ,
} ,
{
name : 'Customer' ,
value : 'Customer' ,
} ,
] ,
default : '' ,
} ,
{
displayName : 'Sandbox' ,
name : 'sandbox' ,
type : 'boolean' ,
displayOptions : {
show : {
'/jsonParameters' : [
false ,
] ,
} ,
} ,
default : false ,
} ,
{
2022-06-03 10:23:49 -07:00
displayName : 'Stage Name or ID' ,
2020-06-10 14:37:01 -07:00
name : 'stage' ,
type : 'options' ,
2022-06-20 07:54:01 -07:00
description : 'Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/nodes/expressions.html#expressions">expression</a>' ,
2020-06-10 14:37:01 -07:00
displayOptions : {
show : {
'/jsonParameters' : [
false ,
] ,
} ,
} ,
typeOptions : {
loadOptionsMethod : 'getStages' ,
} ,
default : '' ,
} ,
{
2022-06-20 07:54:01 -07:00
displayName : 'Tag Names or IDs' ,
2020-06-10 14:37:01 -07:00
name : 'tags' ,
type : 'multiOptions' ,
2022-07-04 02:12:08 -07:00
description : 'Choose from the list, or specify IDs using an <a href="https://docs.n8n.io/nodes/expressions.html#expressions">expression</a>' ,
2020-06-10 14:37:01 -07:00
displayOptions : {
show : {
'/jsonParameters' : [
false ,
] ,
} ,
} ,
typeOptions : {
loadOptionsMethod : 'getTags' ,
} ,
2022-04-22 09:29:51 -07:00
default : [ ] ,
2020-01-15 05:55:46 -08:00
} ,
{
displayName : 'Title' ,
name : 'title' ,
type : 'string' ,
displayOptions : {
show : {
'/jsonParameters' : [
false ,
] ,
} ,
} ,
default : '' ,
} ,
{
2020-06-10 14:37:01 -07:00
displayName : 'Social Media' ,
name : 'socialMediaUi' ,
placeholder : 'Social Media' ,
type : 'fixedCollection' ,
displayOptions : {
show : {
'/jsonParameters' : [
false ,
] ,
} ,
} ,
typeOptions : {
multipleValues : false ,
} ,
default : { } ,
options : [
{
name : 'socialMediaValues' ,
displayName : 'Social Media' ,
values : [
{
displayName : 'Facebook' ,
name : 'facebook' ,
type : 'string' ,
default : '' ,
} ,
{
displayName : 'Foursquare' ,
name : 'foursquare' ,
type : 'string' ,
default : '' ,
} ,
{
displayName : 'Instagram' ,
name : 'instagram' ,
type : 'string' ,
default : '' ,
} ,
{
displayName : 'LinkedIn' ,
name : 'linkedIn' ,
type : 'string' ,
default : '' ,
} ,
{
displayName : 'Skype' ,
name : 'skype' ,
type : 'string' ,
default : '' ,
} ,
{
displayName : 'Twitter' ,
name : 'twitter' ,
type : 'string' ,
default : '' ,
} ,
] ,
} ,
] ,
2020-01-15 05:55:46 -08:00
} ,
{
2020-06-10 14:37:01 -07:00
displayName : 'Website' ,
name : 'website' ,
type : 'string' ,
displayOptions : {
show : {
'/jsonParameters' : [
false ,
] ,
} ,
} ,
2020-01-15 05:55:46 -08:00
default : '' ,
} ,
{
2020-06-10 14:37:01 -07:00
displayName : 'IP Address' ,
name : 'ipAddress' ,
2020-01-15 05:55:46 -08:00
type : 'string' ,
2020-06-10 14:37:01 -07:00
displayOptions : {
show : {
'/jsonParameters' : [
false ,
] ,
} ,
} ,
2020-01-15 05:55:46 -08:00
default : '' ,
2020-06-10 14:37:01 -07:00
description : 'IP address to associate with the contact' ,
2020-01-15 05:55:46 -08:00
} ,
] ,
} ,
2020-01-15 18:53:43 -08:00
2022-02-28 00:04:55 -08:00
/* -------------------------------------------------------------------------- */
/* contact:editDoNotContactList */
/* -------------------------------------------------------------------------- */
{
displayName : 'Contact ID' ,
name : 'contactId' ,
type : 'string' ,
displayOptions : {
show : {
operation : [
'editDoNotContactList' ,
] ,
resource : [
'contact' ,
] ,
} ,
} ,
default : '' ,
} ,
{
displayName : 'Action' ,
name : 'action' ,
type : 'options' ,
displayOptions : {
show : {
operation : [
'editDoNotContactList' ,
] ,
resource : [
'contact' ,
] ,
} ,
} ,
options : [
{
name : 'Add' ,
value : 'add' ,
2022-07-10 13:50:51 -07:00
action : 'Add a contact' ,
2022-02-28 00:04:55 -08:00
} ,
{
name : 'Remove' ,
value : 'remove' ,
2022-07-10 13:50:51 -07:00
action : 'Remove a contact' ,
2022-02-28 00:04:55 -08:00
} ,
] ,
default : 'add' ,
} ,
{
displayName : 'Channel' ,
name : 'channel' ,
type : 'options' ,
required : true ,
displayOptions : {
show : {
resource : [
'contact' ,
] ,
operation : [
'editDoNotContactList' ,
] ,
} ,
} ,
options : [
{
name : 'Email' ,
value : 'email' ,
} ,
{
name : 'SMS' ,
value : 'sms' ,
} ,
] ,
default : 'email' ,
} ,
{
displayName : 'Additional Fields' ,
name : 'additionalFields' ,
type : 'collection' ,
placeholder : 'Add Field' ,
default : { } ,
displayOptions : {
show : {
resource : [
'contact' ,
] ,
operation : [
'editDoNotContactList' ,
] ,
} ,
} ,
options : [
{
displayName : 'Reason To Do Not Contact' ,
name : 'reason' ,
type : 'options' ,
options : [
{
name : 'Unsubscribed' ,
value : '1' ,
} ,
{
name : 'Bounced' ,
value : '2' ,
} ,
{
name : 'Manual' ,
value : '3' ,
} ,
] ,
default : '3' ,
} ,
{
displayName : 'Comments' ,
name : 'comments' ,
type : 'string' ,
default : '' ,
description : 'A text describing details of Do Not Contact entry' ,
} ,
] ,
} ,
/* -------------------------------------------------------------------------- */
/* contact:editContactPoint */
/* -------------------------------------------------------------------------- */
{
displayName : 'Contact ID' ,
name : 'contactId' ,
type : 'string' ,
displayOptions : {
show : {
operation : [
'editContactPoint' ,
] ,
resource : [
'contact' ,
] ,
} ,
} ,
default : '' ,
} ,
{
displayName : 'Action' ,
name : 'action' ,
type : 'options' ,
displayOptions : {
show : {
operation : [
'editContactPoint' ,
] ,
resource : [
'contact' ,
] ,
} ,
} ,
options : [
{
name : 'Add' ,
value : 'add' ,
2022-07-10 13:50:51 -07:00
action : 'Add a contact' ,
2022-02-28 00:04:55 -08:00
} ,
{
name : 'Remove' ,
value : 'remove' ,
2022-07-10 13:50:51 -07:00
action : 'Remove a contact' ,
2022-02-28 00:04:55 -08:00
} ,
] ,
default : 'add' ,
} ,
{
displayName : 'Points' ,
name : 'points' ,
type : 'number' ,
displayOptions : {
show : {
operation : [
'editContactPoint' ,
] ,
resource : [
'contact' ,
] ,
} ,
} ,
default : 0 ,
} ,
2020-10-23 00:31:32 -07:00
/* -------------------------------------------------------------------------- */
/* contact:get */
/* -------------------------------------------------------------------------- */
2020-01-15 05:55:46 -08:00
{
displayName : 'Contact ID' ,
name : 'contactId' ,
type : 'string' ,
displayOptions : {
show : {
operation : [
'get' ,
] ,
resource : [
'contact' ,
] ,
} ,
} ,
default : '' ,
} ,
2020-01-15 18:53:43 -08:00
2020-10-23 00:31:32 -07:00
/* -------------------------------------------------------------------------- */
/* contact:getAll */
/* -------------------------------------------------------------------------- */
2020-01-15 05:55:46 -08:00
{
displayName : 'Return All' ,
name : 'returnAll' ,
type : 'boolean' ,
displayOptions : {
show : {
resource : [
'contact' ,
] ,
operation : [
'getAll' ,
] ,
} ,
} ,
default : false ,
2022-05-06 14:01:25 -07:00
description : 'Whether to return all results or only up to a given limit' ,
2020-01-15 05:55:46 -08:00
} ,
{
displayName : 'Limit' ,
name : 'limit' ,
type : 'number' ,
displayOptions : {
show : {
resource : [
'contact' ,
] ,
operation : [
'getAll' ,
] ,
returnAll : [
false ,
] ,
} ,
} ,
typeOptions : {
minValue : 1 ,
maxValue : 30 ,
} ,
default : 30 ,
2022-05-06 14:01:25 -07:00
description : 'Max number of results to return' ,
2020-01-15 05:55:46 -08:00
} ,
2020-01-15 18:53:43 -08:00
2020-10-23 00:31:32 -07:00
/* -------------------------------------------------------------------------- */
/* contact:delete */
/* -------------------------------------------------------------------------- */
2020-01-15 05:55:46 -08:00
{
2020-01-15 18:53:43 -08:00
displayName : 'Contact ID' ,
name : 'contactId' ,
type : 'string' ,
2020-01-15 05:55:46 -08:00
displayOptions : {
show : {
2020-01-15 18:53:43 -08:00
operation : [
'delete' ,
] ,
2020-01-15 05:55:46 -08:00
resource : [
'contact' ,
] ,
2020-01-15 18:53:43 -08:00
} ,
} ,
default : '' ,
} ,
2020-10-23 00:31:32 -07:00
/* -------------------------------------------------------------------------- */
/* contact:all */
/* -------------------------------------------------------------------------- */
2020-01-15 18:53:43 -08:00
{
displayName : 'Options' ,
name : 'options' ,
type : 'collection' ,
displayOptions : {
show : {
'resource' : [
'contact' ,
2020-01-15 05:55:46 -08:00
] ,
} ,
2022-02-28 00:04:55 -08:00
hide : {
operation : [
'sendEmail' ,
'editDoNotContactList' ,
'editContactPoint' ,
] ,
} ,
2020-01-15 05:55:46 -08:00
} ,
2020-01-15 18:53:43 -08:00
placeholder : 'Add Option' ,
default : { } ,
2020-01-15 05:55:46 -08:00
options : [
{
displayName : 'Search' ,
name : 'search' ,
type : 'string' ,
2020-01-15 18:53:43 -08:00
displayOptions : {
show : {
'/resource' : [
'contact' ,
] ,
'/operation' : [
'getAll' ,
] ,
} ,
} ,
2020-01-15 05:55:46 -08:00
default : '' ,
2022-05-06 14:01:25 -07:00
description : 'String or search command to filter entities by' ,
2020-01-15 05:55:46 -08:00
} ,
{
displayName : 'Order By' ,
name : 'orderBy' ,
type : 'string' ,
2020-01-15 18:53:43 -08:00
displayOptions : {
show : {
'/resource' : [
'contact' ,
] ,
'/operation' : [
'getAll' ,
] ,
} ,
} ,
2020-01-15 05:55:46 -08:00
default : '' ,
2020-01-15 18:53:43 -08:00
description : 'Column to sort by. Can use any column listed in the response.' ,
2020-01-15 05:55:46 -08:00
} ,
{
displayName : 'Order By Dir' ,
name : 'orderByDir' ,
type : 'options' ,
2020-01-15 18:53:43 -08:00
displayOptions : {
show : {
'/resource' : [
'contact' ,
] ,
'/operation' : [
'getAll' ,
] ,
} ,
} ,
2020-01-15 05:55:46 -08:00
default : '' ,
options : [
{
name : 'ASC' ,
2020-01-15 18:53:43 -08:00
value : 'asc' ,
2020-01-15 05:55:46 -08:00
} ,
{
2020-01-15 18:53:43 -08:00
name : 'DESC' ,
value : 'desc' ,
2020-01-15 05:55:46 -08:00
} ,
] ,
2022-05-06 14:01:25 -07:00
description : 'Sort direction: ASC or DESC' ,
2020-01-15 05:55:46 -08:00
} ,
{
displayName : 'Published Only' ,
name : 'publishedOnly' ,
type : 'boolean' ,
2020-01-15 18:53:43 -08:00
displayOptions : {
show : {
'/resource' : [
'contact' ,
] ,
'/operation' : [
'getAll' ,
] ,
} ,
} ,
2020-01-15 05:55:46 -08:00
default : false ,
2022-06-20 07:54:01 -07:00
description : 'Whether to return currently published entities' ,
2020-01-15 05:55:46 -08:00
} ,
{
displayName : 'Minimal' ,
name : 'minimal' ,
type : 'boolean' ,
2020-01-15 18:53:43 -08:00
displayOptions : {
show : {
'/resource' : [
'contact' ,
] ,
'/operation' : [
'getAll' ,
] ,
} ,
} ,
2020-01-15 05:55:46 -08:00
default : false ,
2022-06-20 07:54:01 -07:00
description : 'Whether to return array of entities without additional lists in it' ,
2020-01-15 05:55:46 -08:00
} ,
2020-01-15 18:53:43 -08:00
{
displayName : 'RAW Data' ,
name : 'rawData' ,
type : 'boolean' ,
2020-10-23 00:31:32 -07:00
default : true ,
2022-06-20 07:54:01 -07:00
// eslint-disable-next-line n8n-nodes-base/node-param-description-boolean-without-whether
2022-04-22 09:29:51 -07:00
description : 'By default only the data of the fields get returned. If this options gets set the RAW response with all data gets returned.' ,
2020-01-15 05:55:46 -08:00
} ,
2020-10-22 06:46:03 -07:00
] ,
2020-01-15 05:55:46 -08:00
} ,
2022-02-28 00:04:55 -08:00
/* -------------------------------------------------------------------------- */
/* contact:sendEmail */
/* -------------------------------------------------------------------------- */
{
2022-06-03 10:23:49 -07:00
displayName : 'Campaign Email Name or ID' ,
2022-02-28 00:04:55 -08:00
name : 'campaignEmailId' ,
type : 'options' ,
2022-06-20 07:54:01 -07:00
description : 'Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/nodes/expressions.html#expressions">expression</a>' ,
2022-02-28 00:04:55 -08:00
required : true ,
displayOptions : {
show : {
resource : [
'contact' ,
] ,
operation : [
'sendEmail' ,
] ,
} ,
} ,
typeOptions : {
loadOptionsMethod : 'getCampaignEmails' ,
} ,
default : '' ,
} ,
{
displayName : 'Contact ID' ,
name : 'contactId' ,
type : 'string' ,
required : true ,
displayOptions : {
show : {
resource : [
'contact' ,
] ,
operation : [
'sendEmail' ,
] ,
} ,
} ,
default : '' ,
} ,
2021-12-03 00:44:16 -08:00
] ;