n8n/packages/nodes-base/nodes/Mautic/ContactDescription.ts

1243 lines
22 KiB
TypeScript
Raw Normal View History

import {
INodeProperties,
} from 'n8n-workflow';
2020-01-15 05:55:46 -08:00
export const contactOperations = [
{
displayName: 'Operation',
name: 'operation',
type: 'options',
displayOptions: {
show: {
resource: [
'contact',
],
},
},
options: [
{
name: 'Create',
value: 'create',
description: 'Create a new contact',
},
{
name: 'Delete',
value: 'delete',
description: 'Delete a contact',
2020-01-15 05:55:46 -08:00
},
{
name: 'Get',
value: 'get',
description: 'Get data of a contact',
},
{
name: 'Get All',
value: 'getAll',
description: 'Get data of all contacts',
},
{
name: 'Update',
value: 'update',
description: 'Update a contact',
2020-01-15 05:55:46 -08:00
},
],
default: 'create',
description: 'The operation to perform.',
},
] as INodeProperties[];
export const contactFields = [
/* -------------------------------------------------------------------------- */
/* contact:create */
/* -------------------------------------------------------------------------- */
2020-01-15 05:55:46 -08:00
{
displayName: 'JSON Parameters',
name: 'jsonParameters',
type: 'boolean',
default: false,
description: '',
displayOptions: {
show: {
operation: [
'create',
],
resource: [
'contact',
],
},
},
},
2020-01-30 11:45:50 -08:00
{
displayName: 'Email',
name: 'email',
type: 'string',
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: '',
description: 'Email address of the contact.',
},
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: '',
description: 'First Name',
},
{
displayName: 'Last Name',
name: 'lastName',
type: 'string',
displayOptions: {
show: {
resource: [
'contact',
],
operation: [
'create',
],
jsonParameters: [
false,
],
},
},
default: '',
description: 'Last Name',
2020-01-15 05:55:46 -08:00
},
{
displayName: 'Primary Company',
name: 'company',
type: 'options',
typeOptions: {
loadOptionsMethod: 'getCompanies',
},
displayOptions: {
show: {
resource: [
'contact',
],
operation: [
'create',
],
jsonParameters: [
false,
],
},
},
default: '',
description: 'Primary company',
},
{
displayName: 'Position',
name: 'position',
type: 'string',
displayOptions: {
show: {
resource: [
'contact',
],
operation: [
'create',
],
jsonParameters: [
false,
],
},
},
default: '',
description: 'Position',
},
{
displayName: 'Title',
name: 'title',
type: 'string',
displayOptions: {
show: {
resource: [
'contact',
],
operation: [
'create',
],
jsonParameters: [
false,
],
},
},
default: '',
description: 'Title',
},
{
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: '',
},
{
displayName: 'Custom Fields',
name: 'customFieldsUi',
placeholder: 'Add Custom Fields',
description: 'Adds a custom fields to set also values which have not been predefined.',
type: 'fixedCollection',
typeOptions: {
multipleValues: true,
},
default: {},
options: [
{
name: 'customFieldValues',
displayName: 'Field',
values: [
{
displayName: 'Field ID',
name: 'fieldId',
type: 'options',
typeOptions: {
loadOptionsMethod: 'getContactFields',
},
default: '',
description: 'ID of the field to set.',
},
{
displayName: 'Field Value',
name: 'fieldValue',
type: 'string',
default: '',
description: 'Value of the field to set.',
},
],
},
],
},
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,
},
{
displayName: 'Stage',
name: 'stage',
type: 'options',
typeOptions: {
loadOptionsMethod: 'getStages',
},
default: '',
},
{
displayName: 'Tags',
name: 'tags',
type: 'multiOptions',
typeOptions: {
loadOptionsMethod: 'getTags',
},
default: '',
},
{
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
],
},
/* -------------------------------------------------------------------------- */
/* contact:update */
/* -------------------------------------------------------------------------- */
2020-01-15 05:55:46 -08:00
{
displayName: 'Contact ID',
name: 'contactId',
type: 'string',
displayOptions: {
show: {
operation: [
'update',
],
resource: [
'contact',
],
},
},
default: '',
description: 'Contact ID',
},
{
displayName: 'JSON Parameters',
name: 'jsonParameters',
type: 'boolean',
default: false,
description: '',
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: '',
},
{
displayName: 'Custom Fields',
name: 'customFieldsUi',
placeholder: 'Add Custom Fields',
description: 'Adds a custom fields to set also values which have not been predefined.',
type: 'fixedCollection',
typeOptions: {
multipleValues: true,
},
default: {},
options: [
{
name: 'customFieldValues',
displayName: 'Field',
values: [
{
displayName: 'Field ID',
name: 'fieldId',
type: 'options',
typeOptions: {
loadOptionsMethod: 'getContactFields',
},
default: '',
description: 'ID of the field to set.',
},
{
displayName: 'Field Value',
name: 'fieldValue',
type: 'string',
default: '',
description: 'Value of the field to set.',
},
],
},
],
},
2020-01-30 11:45:50 -08:00
{
displayName: 'Email',
name: 'email',
type: 'string',
displayOptions: {
show: {
'/jsonParameters': [
false,
],
},
},
default: '',
description: 'Email address of the contact.',
},
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: '',
description: 'First Name',
},
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: '',
description: 'Position',
},
2020-01-15 05:55:46 -08:00
{
displayName: 'Primary Company',
name: 'company',
type: 'options',
typeOptions: {
loadOptionsMethod: 'getCompanies',
},
displayOptions: {
show: {
'/jsonParameters': [
false,
],
},
},
default: '',
description: 'Primary company',
},
{
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,
},
{
displayName: 'Stage',
name: 'stage',
type: 'options',
displayOptions: {
show: {
'/jsonParameters': [
false,
],
},
},
typeOptions: {
loadOptionsMethod: 'getStages',
},
default: '',
},
{
displayName: 'Tags',
name: 'tags',
type: 'multiOptions',
displayOptions: {
show: {
'/jsonParameters': [
false,
],
},
},
typeOptions: {
loadOptionsMethod: 'getTags',
},
2020-01-15 05:55:46 -08:00
default: '',
},
{
displayName: 'Title',
name: 'title',
type: 'string',
displayOptions: {
show: {
'/jsonParameters': [
false,
],
},
},
default: '',
description: 'Title',
},
{
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
},
],
},
/* -------------------------------------------------------------------------- */
/* contact:get */
/* -------------------------------------------------------------------------- */
2020-01-15 05:55:46 -08:00
{
displayName: 'Contact ID',
name: 'contactId',
type: 'string',
displayOptions: {
show: {
operation: [
'get',
],
resource: [
'contact',
],
},
},
default: '',
description: 'Contact ID',
},
/* -------------------------------------------------------------------------- */
/* 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,
description: 'If all results should be returned or only up to a given limit.',
},
{
displayName: 'Limit',
name: 'limit',
type: 'number',
displayOptions: {
show: {
resource: [
'contact',
],
operation: [
'getAll',
],
returnAll: [
false,
],
},
},
typeOptions: {
minValue: 1,
maxValue: 30,
},
default: 30,
description: 'How many results to return.',
},
/* -------------------------------------------------------------------------- */
/* contact:delete */
/* -------------------------------------------------------------------------- */
2020-01-15 05:55:46 -08:00
{
displayName: 'Contact ID',
name: 'contactId',
type: 'string',
2020-01-15 05:55:46 -08:00
displayOptions: {
show: {
operation: [
'delete',
],
2020-01-15 05:55:46 -08:00
resource: [
'contact',
],
},
},
default: '',
description: 'Contact ID',
},
/* -------------------------------------------------------------------------- */
/* contact:all */
/* -------------------------------------------------------------------------- */
{
displayName: 'Options',
name: 'options',
type: 'collection',
displayOptions: {
show: {
'resource': [
'contact',
2020-01-15 05:55:46 -08:00
],
},
},
placeholder: 'Add Option',
default: {},
2020-01-15 05:55:46 -08:00
options: [
{
displayName: 'Search',
name: 'search',
type: 'string',
displayOptions: {
show: {
'/resource': [
'contact',
],
'/operation': [
'getAll',
],
},
},
2020-01-15 05:55:46 -08:00
default: '',
description: 'String or search command to filter entities by.',
},
{
displayName: 'Order By',
name: 'orderBy',
type: 'string',
displayOptions: {
show: {
'/resource': [
'contact',
],
'/operation': [
'getAll',
],
},
},
2020-01-15 05:55:46 -08:00
default: '',
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',
displayOptions: {
show: {
'/resource': [
'contact',
],
'/operation': [
'getAll',
],
},
},
2020-01-15 05:55:46 -08:00
default: '',
options: [
{
name: 'ASC',
value: 'asc',
2020-01-15 05:55:46 -08:00
},
{
name: 'DESC',
value: 'desc',
2020-01-15 05:55:46 -08:00
},
],
description: 'Sort direction: ASC or DESC.',
2020-01-15 05:55:46 -08:00
},
{
displayName: 'Published Only',
name: 'publishedOnly',
type: 'boolean',
displayOptions: {
show: {
'/resource': [
'contact',
],
'/operation': [
'getAll',
],
},
},
2020-01-15 05:55:46 -08:00
default: false,
description: 'Only return currently published entities.',
},
{
displayName: 'Minimal',
name: 'minimal',
type: 'boolean',
displayOptions: {
show: {
'/resource': [
'contact',
],
'/operation': [
'getAll',
],
},
},
2020-01-15 05:55:46 -08:00
default: false,
description: 'Return only array of entities without additional lists in it.',
},
{
displayName: 'RAW Data',
name: 'rawData',
type: 'boolean',
default: true,
description: `By default only the data of the fields get returned. If this<br />
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
},
2020-01-15 05:55:46 -08:00
] as INodeProperties[];