mudhorn/n8n
1
0
Fork 0
mirror of https://github.com/n8n-io/n8n.git synced 2024-12-25 12:44:07 -08:00
Code Issues Actions Packages Projects Releases Wiki Activity

⚡ Some improvements to Customer.io Node

Browse source
This commit is contained in:
Jan Oberhauser 2020-09-02 12:32:12 +02:00
parent e5a5e1ed11
commit 512fe4ea70
7 changed files with 180 additions and 348 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
packages/nodes-base/credentials/CustomerIoApi.credentials.ts
View file

@ -15,21 +15,21 @@ export class CustomerIoApi implements ICredentialType {
type: 'string' as NodePropertyTypes, type: 'string' as NodePropertyTypes,
default: '', default: '',
description: 'Required for tracking API.', description: 'Required for tracking API.',
required: true required: true,
}, },
{ {
displayName: 'Tracking Site ID', displayName: 'Tracking Site ID',
name: 'trackingSiteId', name: 'trackingSiteId',
type: 'string' as NodePropertyTypes, type: 'string' as NodePropertyTypes,
default: '', default: '',
description: 'Required for tracking API.' description: 'Required for tracking API.',
}, },
{ {
displayName: 'App API Key', displayName: 'App API Key',
name: 'appApiKey', name: 'appApiKey',
type: 'string' as NodePropertyTypes, type: 'string' as NodePropertyTypes,
default: '', default: '',
description: 'Required for App API.' description: 'Required for App API.',
}, },
]; ];
} }

56
packages/nodes-base/nodes/CustomerIo/CampaignDescription.ts
View file

@ -47,7 +47,7 @@ export const campaignFields = [
'campaign', 'campaign',
], ],
operation: [ operation: [
'get' 'get',
] ]
}, },
}, },
@ -68,7 +68,7 @@ export const campaignFields = [
'campaign', 'campaign',
], ],
operation: [ operation: [
'getMetrics' 'getMetrics',
] ]
}, },
}, },
@ -85,7 +85,7 @@ export const campaignFields = [
'campaign', 'campaign',
], ],
operation: [ operation: [
'getMetrics' 'getMetrics',
] ]
}, },
}, },
@ -93,19 +93,19 @@ export const campaignFields = [
options: [ options: [
{ {
name: 'Hours', name: 'Hours',
value: 'hours' value: 'hours',
}, },
{ {
name: 'Days', name: 'Days',
value: 'days' value: 'days',
}, },
{ {
name: 'Weeks', name: 'Weeks',
value: 'weeks' value: 'weeks',
}, },
{ {
name: 'Months', name: 'Months',
value: 'months' value: 'months',
}, },
] ]
}, },
@ -121,7 +121,7 @@ export const campaignFields = [
'campaign', 'campaign',
], ],
operation: [ operation: [
'getMetrics' 'getMetrics',
], ],
}, },
}, },
@ -154,7 +154,7 @@ export const campaignFields = [
description: 'Integer specifying how many steps to return. Defaults to the maximum number of timeperiods available, or 12 when using the months period. Maximum timeperiods available are 24 hours, 45 days, 12 weeks and 120 months', description: 'Integer specifying how many steps to return. Defaults to the maximum number of timeperiods available, or 12 when using the months period. Maximum timeperiods available are 24 hours, 45 days, 12 weeks and 120 months',
typeOptions: { typeOptions: {
minValue: 0, minValue: 0,
maxValue: 120 maxValue: 120,
} }
}, },
{ {
@ -166,31 +166,31 @@ export const campaignFields = [
options: [ options: [
{ {
name: 'Empty', name: 'Empty',
value: 'empty' value: 'empty',
}, },
{ {
name: 'Email', name: 'Email',
value: 'email' value: 'email',
},
{
name: 'Webhook',
value: 'webhook'
},
{
name: 'twilio',
value: 'twilio'
},
{
name: 'Urban Airship',
value: 'urbanAirship'
},
{
name: 'Slack',
value: 'slack'
}, },
{ {
name: 'Push', name: 'Push',
value: 'push' value: 'push',
},
{
name: 'Slack',
value: 'slack',
},
{
name: 'twilio',
value: 'twilio',
},
{
name: 'Urban Airship',
value: 'urbanAirship',
},
{
name: 'Webhook',
value: 'webhook',
}, },
] ]
}, },

181
packages/nodes-base/nodes/CustomerIo/CustomerDescription.ts
View file

@ -14,22 +14,17 @@ export const customerOperations = [
}, },
options: [ options: [
{ {
name: 'Create', name: 'Create/Update',
value: 'create', value: 'upsert',
description: 'Create a customer.', description: 'Create/Update a customer.',
}, },
{ {
name: 'Delete', name: 'Delete',
value: 'delete', value: 'delete',
description: 'Delete a customer.', description: 'Delete a customer.',
}, },
{
name: 'Update',
value: 'update',
description: 'Update a customer.',
},
], ],
default: 'create', default: 'upsert',
description: 'The operation to perform.', description: 'The operation to perform.',
}, },
] as INodeProperties[]; ] as INodeProperties[];
@ -37,30 +32,35 @@ export const customerOperations = [
export const customerFields = [ export const customerFields = [
/* -------------------------------------------------------------------------- */ /* -------------------------------------------------------------------------- */
/* customer:create/delete */ /* customer:delete */
/* -------------------------------------------------------------------------- */ /* -------------------------------------------------------------------------- */
{ {
displayName: 'ID', displayName: 'ID',
name: 'id', name: 'id',
type: 'number', type: 'string',
required: true, required: true,
default: 0, default: '',
displayOptions: { displayOptions: {
show: { show: {
resource: [ resource: [
'customer', 'customer',
], ],
operation: [ operation: [
'create', 'delete' 'delete',
] ]
}, },
}, },
description: 'The unique identifier for the customer.', description: 'The unique identifier for the customer.',
}, },
/* -------------------------------------------------------------------------- */
/* customer:upsert */
/* -------------------------------------------------------------------------- */
{ {
displayName: 'Email', displayName: 'ID',
name: 'email', name: 'id',
type: 'string', type: 'string',
required: true,
default: '', default: '',
displayOptions: { displayOptions: {
show: { show: {
@ -68,28 +68,11 @@ export const customerFields = [
'customer', 'customer',
], ],
operation: [ operation: [
'create' 'upsert',
] ]
}, },
}, },
description: 'The email address of the user.', description: 'The unique identifier for the customer.',
},
{
displayName: 'Created at',
name: 'createdAt',
type: 'dateTime',
default: '',
displayOptions: {
show: {
resource: [
'customer',
],
operation: [
'create'
]
},
},
description: 'The UNIX timestamp from when the user was created.',
}, },
{ {
displayName: 'JSON Parameters', displayName: 'JSON Parameters',
@ -103,7 +86,7 @@ export const customerFields = [
'customer', 'customer',
], ],
operation: [ operation: [
'create' 'upsert',
], ],
}, },
}, },
@ -122,7 +105,7 @@ export const customerFields = [
'customer', 'customer',
], ],
operation: [ operation: [
'create' 'upsert',
], ],
jsonParameters: [ jsonParameters: [
true, true,
@ -143,7 +126,7 @@ export const customerFields = [
'customer', 'customer',
], ],
operation: [ operation: [
'create' 'upsert',
], ],
jsonParameters: [ jsonParameters: [
false, false,
@ -171,7 +154,7 @@ export const customerFields = [
required: true, required: true,
default: '', default: '',
description: 'Property name.', description: 'Property name.',
placeholder: 'Plan' placeholder: 'Plan',
}, },
{ {
@ -181,127 +164,7 @@ export const customerFields = [
required: true, required: true,
default: '', default: '',
description: 'Property value.', description: 'Property value.',
placeholder: 'Basic' placeholder: 'Basic',
},
],
},
]
},
],
},
/* -------------------------------------------------------------------------- */
/* customer:update */
/* -------------------------------------------------------------------------- */
{
displayName: 'ID',
name: 'id',
type: 'number',
required: true,
default: 0,
displayOptions: {
show: {
resource: [
'customer',
],
operation: [
'update'
]
},
},
description: 'The unique identifier for the customer.',
},
{
displayName: 'JSON Parameters',
name: 'jsonParameters',
type: 'boolean',
default: false,
description: '',
displayOptions: {
show: {
resource: [
'customer',
],
operation: [
'update'
],
},
},
},
{
displayName: ' Additional Fields',
name: 'additionalFieldsJson',
type: 'json',
typeOptions: {
alwaysOpenEditWindow: true,
},
default: '',
displayOptions: {
show: {
resource: [
'customer',
],
operation: [
'update'
],
jsonParameters: [
true,
],
},
},
description: 'Object of values to set as described <a href="https://github.com/agilecrm/rest-api#1-companys---companies-api" target="_blank">here</a>.',
},
{
displayName: 'Additional Fields',
name: 'additionalFields',
type: 'collection',
placeholder: 'Add Field',
default: {},
displayOptions: {
show: {
resource: [
'customer',
],
operation: [
'update'
],
jsonParameters: [
false,
],
},
},
options: [
{
displayName: 'Custom Properties',
name: 'customProperties',
type: 'fixedCollection',
description: 'Custom Properties',
typeOptions: {
multipleValues: true,
},
options: [
{
displayName: 'Property',
name: 'customProperty',
values: [
{
displayName: 'Key',
name: 'key',
type: 'string',
required: true,
default: '',
description: 'Property name.',
placeholder: 'Plan'
},
{
displayName: 'Value',
name: 'value',
type: 'string',
required: true,
default: '',
description: 'Property value.',
placeholder: 'Basic'
}, },
], ],
}, },

112
packages/nodes-base/nodes/CustomerIo/CustomerIo.node.ts
View file

@ -6,21 +6,18 @@ import {
INodeTypeDescription, INodeTypeDescription,
INodeExecutionData, INodeExecutionData,
INodeType, INodeType,
ILoadOptionsFunctions,
INodePropertyOptions,
} from 'n8n-workflow'; } from 'n8n-workflow';
import { customerIoApiRequest, validateJSON } from './GenericFunctions'; import { customerIoApiRequest, validateJSON } from './GenericFunctions';
import { campaignOperations, campaignFields } from './CampaignDescription'; import { campaignOperations, campaignFields } from './CampaignDescription';
import { customerOperations, customerFields } from './CustomerDescription'; import { customerOperations, customerFields } from './CustomerDescription';
import { eventOperations, eventFields } from './EventDescription'; import { eventOperations, eventFields } from './EventDescription';
import { segmentOperations, segmentFields } from './SegmentDescription'; import { segmentOperations, segmentFields } from './SegmentDescription';
import { DateTime } from '../DateTime.node';
export class CustomerIo implements INodeType { export class CustomerIo implements INodeType {
description: INodeTypeDescription = { description: INodeTypeDescription = {
displayName: 'Customer.io', displayName: 'Customer.io',
name: 'customerio', name: 'customerIo',
icon: 'file:customerio.png', icon: 'file:customerio.png',
group: ['output'], group: ['output'],
version: 1, version: 1,
@ -82,11 +79,11 @@ export class CustomerIo implements INodeType {
async execute(this: IExecuteFunctions): Promise<INodeExecutionData[][]> { async execute(this: IExecuteFunctions): Promise<INodeExecutionData[][]> {
const returnData: IDataObject[] = []; const returnData: IDataObject[] = [];
const items = this.getInputData(); const items = this.getInputData();
let responseData;
const resource = this.getNodeParameter('resource', 0) as string; const resource = this.getNodeParameter('resource', 0) as string;
const operation = this.getNodeParameter('operation', 0) as string; const operation = this.getNodeParameter('operation', 0) as string;
const body: IDataObject = {}; const body: IDataObject = {};
let responseData;
for (let i = 0; i < items.length; i++) { for (let i = 0; i < items.length; i++) {
if (resource === 'campaign') { if (resource === 'campaign') {
@ -95,6 +92,7 @@ export class CustomerIo implements INodeType {
const endpoint = `/campaigns/${campaignId}`; const endpoint = `/campaigns/${campaignId}`;
responseData = await customerIoApiRequest.call(this, 'GET', endpoint, body, 'beta'); responseData = await customerIoApiRequest.call(this, 'GET', endpoint, body, 'beta');
responseData = responseData.campaign;
} }
if (operation === 'getAll') { if (operation === 'getAll') {
@ -147,48 +145,8 @@ export class CustomerIo implements INodeType {
} }
if (resource === 'customer') { if (resource === 'customer') {
if (operation === 'create') {
const id = this.getNodeParameter('id', i) as number;
const email = this.getNodeParameter('email', i) as string;
const createdAt = this.getNodeParameter('createdAt', i) as string;
const jsonParameters = this.getNodeParameter('jsonParameters', i) as boolean;
body.email = email; if (operation === 'upsert') {
body.created_at = new Date(createdAt).getTime() / 1000;
if (jsonParameters) {
const additionalFieldsJson = this.getNodeParameter('additionalFieldsJson', i) as string;
if (additionalFieldsJson !== '') {
if (validateJSON(additionalFieldsJson) !== undefined) {
Object.assign(body, JSON.parse(additionalFieldsJson));
} else {
throw new Error('Additional fields must be a valid JSON');
}
}
} else {
const additionalFields = this.getNodeParameter('additionalFields', i) as IDataObject;
if (additionalFields.customProperties) {
const data : any = {};
//@ts-ignore
additionalFields.customProperties.customProperty.map(property => {
data[property.key] = property.value;
});
body.data = data;
}
}
const endpoint = `/customers/${id}`;
responseData = await customerIoApiRequest.call(this, 'PUT', endpoint, body, 'tracking');
}
if (operation === 'update') {
const id = this.getNodeParameter('id', i) as number; const id = this.getNodeParameter('id', i) as number;
const jsonParameters = this.getNodeParameter('jsonParameters', i) as boolean; const jsonParameters = this.getNodeParameter('jsonParameters', i) as boolean;
@ -209,7 +167,7 @@ export class CustomerIo implements INodeType {
const additionalFields = this.getNodeParameter('additionalFields', i) as IDataObject; const additionalFields = this.getNodeParameter('additionalFields', i) as IDataObject;
if (additionalFields.customProperties) { if (additionalFields.customProperties) {
const data : any = {}; const data: any = {}; // tslint:disable-line:no-any
//@ts-ignore //@ts-ignore
additionalFields.customProperties.customProperty.map(property => { additionalFields.customProperties.customProperty.map(property => {
data[property.key] = property.value; data[property.key] = property.value;
@ -230,6 +188,8 @@ export class CustomerIo implements INodeType {
const endpoint = `/customers/${id}`; const endpoint = `/customers/${id}`;
responseData = await customerIoApiRequest.call(this, 'PUT', endpoint, body, 'tracking'); responseData = await customerIoApiRequest.call(this, 'PUT', endpoint, body, 'tracking');
responseData = Object.assign({ id }, body);
} }
if (operation === 'delete') { if (operation === 'delete') {
@ -239,17 +199,21 @@ export class CustomerIo implements INodeType {
const endpoint = `/customers/${id}`; const endpoint = `/customers/${id}`;
responseData = await customerIoApiRequest.call(this, 'DELETE', endpoint, body, 'tracking'); await customerIoApiRequest.call(this, 'DELETE', endpoint, body, 'tracking');
responseData = {
success: true,
};
} }
} }
if (resource === 'event') { if (resource === 'event') {
if (operation === 'track') { if (operation === 'track') {
const id = this.getNodeParameter('id', i) as number; const customerId = this.getNodeParameter('customerId', i) as number;
const name = this.getNodeParameter('name', i) as string; const eventName = this.getNodeParameter('eventName', i) as string;
const jsonParameters = this.getNodeParameter('jsonParameters', i) as boolean; const jsonParameters = this.getNodeParameter('jsonParameters', i) as boolean;
body.name = name; body.name = eventName;
if (jsonParameters) { if (jsonParameters) {
const additionalFieldsJson = this.getNodeParameter('additionalFieldsJson', i) as string; const additionalFieldsJson = this.getNodeParameter('additionalFieldsJson', i) as string;
@ -257,16 +221,14 @@ export class CustomerIo implements INodeType {
if (additionalFieldsJson !== '') { if (additionalFieldsJson !== '') {
if (validateJSON(additionalFieldsJson) !== undefined) { if (validateJSON(additionalFieldsJson) !== undefined) {
Object.assign(body, JSON.parse(additionalFieldsJson)); Object.assign(body, JSON.parse(additionalFieldsJson));
} else { } else {
throw new Error('Additional fields must be a valid JSON'); throw new Error('Additional fields must be a valid JSON');
} }
} }
} else { } else {
const additionalFields = this.getNodeParameter('additionalFields', i) as IDataObject; const additionalFields = this.getNodeParameter('additionalFields', i) as IDataObject;
const data : any = {}; const data: any = {}; // tslint:disable-line:no-any
if (additionalFields.customAttributes) { if (additionalFields.customAttributes) {
//@ts-ignore //@ts-ignore
@ -282,16 +244,19 @@ export class CustomerIo implements INodeType {
body.data = data; body.data = data;
} }
const endpoint = `/customers/${id}/events`; const endpoint = `/customers/${customerId}/events`;
responseData = await customerIoApiRequest.call(this, 'POST', endpoint, body, 'tracking'); await customerIoApiRequest.call(this, 'POST', endpoint, body, 'tracking');
responseData = {
success: true,
};
} }
if (operation === 'trackAnonymous') { if (operation === 'trackAnonymous') {
const name = this.getNodeParameter('name', i) as string; const eventName = this.getNodeParameter('eventName', i) as string;
const jsonParameters = this.getNodeParameter('jsonParameters', i) as boolean; const jsonParameters = this.getNodeParameter('jsonParameters', i) as boolean;
body.name = name; body.name = eventName;
if (jsonParameters) { if (jsonParameters) {
const additionalFieldsJson = this.getNodeParameter('additionalFieldsJson', i) as string; const additionalFieldsJson = this.getNodeParameter('additionalFieldsJson', i) as string;
@ -308,7 +273,7 @@ export class CustomerIo implements INodeType {
} }
} else { } else {
const additionalFields = this.getNodeParameter('additionalFields', i) as IDataObject; const additionalFields = this.getNodeParameter('additionalFields', i) as IDataObject;
const data : any = {}; const data: any = {}; // tslint:disable-line:no-any
if (additionalFields.customAttributes) { if (additionalFields.customAttributes) {
//@ts-ignore //@ts-ignore
@ -320,31 +285,34 @@ export class CustomerIo implements INodeType {
} }
const endpoint = `/events`; const endpoint = `/events`;
responseData = await customerIoApiRequest.call(this, 'POST', endpoint, body, 'tracking'); await customerIoApiRequest.call(this, 'POST', endpoint, body, 'tracking');
responseData = {
success: true,
};
} }
} }
if (resource === 'segment') { if (resource === 'segment') {
const id = this.getNodeParameter('id', i) as number; const segmentId = this.getNodeParameter('segmentId', i) as number;
const ids = this.getNodeParameter('ids', i) as string; const customerIds = this.getNodeParameter('customerIds', i) as string;
const idArray : string[] = [];
ids.split(',').map(id => { body.id = segmentId;
idArray.push(id); body.ids = customerIds.split(',');
});
body.id = id; let endpoint = '';
body.ids = idArray;
let endpoint = ``;
if (operation === 'add') { if (operation === 'add') {
endpoint = `/segments/${id}/add_customers`; endpoint = `/segments/${segmentId}/add_customers`;
} else { } else {
endpoint = `/segments/${id}/remove_customers`; endpoint = `/segments/${segmentId}/remove_customers`;
} }
responseData = await customerIoApiRequest.call(this, 'POST', endpoint, body, 'tracking'); responseData = await customerIoApiRequest.call(this, 'POST', endpoint, body, 'tracking');
responseData = {
success: true,
};
} }
if (Array.isArray(responseData)) { if (Array.isArray(responseData)) {

47
packages/nodes-base/nodes/CustomerIo/EventDescription.ts
View file

@ -35,26 +35,26 @@ export const eventFields = [
/* event:track */ /* event:track */
/* -------------------------------------------------------------------------- */ /* -------------------------------------------------------------------------- */
{ {
displayName: 'ID', displayName: 'Customer ID',
name: 'id', name: 'customerId',
type: 'number', type: 'string',
required: true, required: true,
default: 0, default: '',
displayOptions: { displayOptions: {
show: { show: {
resource: [ resource: [
'event', 'event',
], ],
operation: [ operation: [
'track' 'track',
] ]
}, },
}, },
description: 'The unique identifier for the customer.', description: 'The unique identifier for the customer.',
}, },
{ {
displayName: 'Name', displayName: 'Event Name',
name: 'name', name: 'eventName',
type: 'string', type: 'string',
default: '', default: '',
displayOptions: { displayOptions: {
@ -63,7 +63,7 @@ export const eventFields = [
'event', 'event',
], ],
operation: [ operation: [
'track' 'track',
] ]
}, },
}, },
@ -81,7 +81,7 @@ export const eventFields = [
'event', 'event',
], ],
operation: [ operation: [
'track' 'track',
], ],
}, },
}, },
@ -100,7 +100,7 @@ export const eventFields = [
'event', 'event',
], ],
operation: [ operation: [
'track' 'track',
], ],
jsonParameters: [ jsonParameters: [
true, true,
@ -121,10 +121,10 @@ export const eventFields = [
'event', 'event',
], ],
operation: [ operation: [
'track' 'track',
], ],
jsonParameters: [ jsonParameters: [
false false,
] ]
}, },
}, },
@ -149,7 +149,7 @@ export const eventFields = [
required: true, required: true,
default: '', default: '',
description: 'Attribute name.', description: 'Attribute name.',
placeholder: 'Price' placeholder: 'Price',
}, },
{ {
@ -159,7 +159,7 @@ export const eventFields = [
required: true, required: true,
default: '', default: '',
description: 'Attribute value.', description: 'Attribute value.',
placeholder: '25.50' placeholder: '25.50',
}, },
], ],
}, },
@ -178,8 +178,8 @@ export const eventFields = [
/* event:track anonymous */ /* event:track anonymous */
/* -------------------------------------------------------------------------- */ /* -------------------------------------------------------------------------- */
{ {
displayName: 'Name', displayName: 'Event Name',
name: 'name', name: 'eventName',
type: 'string', type: 'string',
required: true, required: true,
default: '', default: '',
@ -189,7 +189,7 @@ export const eventFields = [
'event', 'event',
], ],
operation: [ operation: [
'trackAnonymous' 'trackAnonymous',
] ]
}, },
}, },
@ -207,7 +207,7 @@ export const eventFields = [
'event', 'event',
], ],
operation: [ operation: [
'trackAnonymous' 'trackAnonymous',
], ],
}, },
}, },
@ -226,7 +226,7 @@ export const eventFields = [
'event', 'event',
], ],
operation: [ operation: [
'trackAnonymous' 'trackAnonymous',
], ],
jsonParameters: [ jsonParameters: [
true, true,
@ -247,10 +247,10 @@ export const eventFields = [
'event', 'event',
], ],
operation: [ operation: [
'trackAnonymous' 'trackAnonymous',
], ],
jsonParameters: [ jsonParameters: [
false false,
] ]
}, },
}, },
@ -275,9 +275,8 @@ export const eventFields = [
required: true, required: true,
default: '', default: '',
description: 'Attribute name.', description: 'Attribute name.',
placeholder: 'Price' placeholder: 'Price',
}, },
{ {
displayName: 'Value', displayName: 'Value',
name: 'value', name: 'value',
@ -285,7 +284,7 @@ export const eventFields = [
required: true, required: true,
default: '', default: '',
description: 'Attribute value.', description: 'Attribute value.',
placeholder: '25.50' placeholder: '25.50',
}, },
], ],
}, },

14
packages/nodes-base/nodes/CustomerIo/SegmentDescription.ts
View file

@ -33,8 +33,8 @@ export const segmentFields = [
/* segment:add */ /* segment:add */
/* -------------------------------------------------------------------------- */ /* -------------------------------------------------------------------------- */
{ {
displayName: 'ID', displayName: 'Segment ID',
name: 'id', name: 'segmentId',
type: 'number', type: 'number',
required: true, required: true,
default: 0, default: 0,
@ -44,15 +44,16 @@ export const segmentFields = [
'segment', 'segment',
], ],
operation: [ operation: [
'add', 'remove' 'add',
'remove',
] ]
}, },
}, },
description: 'The unique identifier of the segment.', description: 'The unique identifier of the segment.',
}, },
{ {
displayName: 'IDs', displayName: 'Customer IDs',
name: 'ids', name: 'customerIds',
type: 'string', type: 'string',
required: true, required: true,
default: '', default: '',
@ -62,7 +63,8 @@ export const segmentFields = [
'segment', 'segment',
], ],
operation: [ operation: [
'add', 'remove' 'add',
'remove',
] ]
}, },
}, },