n8n/packages/nodes-base/nodes/ActiveCampaign/EcomCustomerDescription.ts

257 lines
5 KiB
TypeScript
Raw Normal View History

import {
INodeProperties,
} from 'n8n-workflow';
import {
activeCampaignDefaultGetAllProperties,
} from './GenericFunctions';
2019-11-03 07:42:18 -08:00
export const ecomCustomerOperations: INodeProperties[] = [
2019-11-07 01:50:02 -08:00
{
displayName: 'Operation',
name: 'operation',
type: 'options',
displayOptions: {
show: {
resource: [
'ecommerceCustomer',
],
},
},
options: [
{
name: 'Create',
value: 'create',
description: 'Create a E-commerce Customer',
},
{
name: 'Delete',
value: 'delete',
description: 'Delete a E-commerce Customer',
},
{
name: 'Get',
value: 'get',
description: 'Get data of a E-commerce Customer',
},
{
name: 'Get All',
value: 'getAll',
description: 'Get data of all E-commerce Customer',
},
{
name: 'Update',
value: 'update',
description: 'Update a E-commerce Customer',
},
],
default: 'create',
description: 'The operation to perform.',
},
];
2019-11-03 07:42:18 -08:00
export const ecomCustomerFields: INodeProperties[] = [
2019-11-07 01:50:02 -08:00
// ----------------------------------
// ecommerceCustomer:create
// ----------------------------------
{
displayName: 'Service ID',
name: 'connectionid',
type: 'string',
default: '',
required: true,
displayOptions: {
show: {
operation: [
'create',
],
resource: [
'ecommerceCustomer',
],
},
},
description: 'The id of the connection object for the service where the customer originates.',
},
{
displayName: 'Customer ID',
name: 'externalid',
type: 'string',
default: '',
required: true,
displayOptions: {
show: {
operation: [
'create',
],
resource: [
'ecommerceCustomer',
],
},
},
description: 'The id of the customer in the external service.',
},
{
displayName: 'Customer Email',
name: 'email',
type: 'string',
default: '',
required: true,
displayOptions: {
show: {
operation: [
'create',
],
resource: [
'ecommerceCustomer',
],
},
},
description: 'The email address of the customer.',
},
{
displayName: 'Additional Fields',
name: 'additionalFields',
type: 'collection',
placeholder: 'Add Field',
displayOptions: {
show: {
operation: [
'create',
],
resource: [
'ecommerceCustomer',
],
},
},
default: {},
options: [
{
displayName: 'Accepts Marketing',
name: 'acceptsMarketing',
type: 'boolean',
default: false,
description: 'Indication of whether customer has opt-ed in to marketing communications.',
},
],
},
2019-11-03 07:42:18 -08:00
2019-11-07 01:50:02 -08:00
// ----------------------------------
// ecommerceCustomer:update
// ----------------------------------
{
displayName: 'Customer ID',
name: 'ecommerceCustomerId',
type: 'number',
displayOptions: {
show: {
operation: [
'update',
],
resource: [
'ecommerceCustomer',
],
},
},
default: 0,
required: true,
description: 'ID of the E-commerce customer to update.',
},
{
displayName: 'Update Fields',
name: 'updateFields',
type: 'collection',
description: 'The fields to update.',
placeholder: 'Add Field',
displayOptions: {
show: {
operation: [
'update',
],
resource: [
'ecommerceCustomer',
],
},
},
default: {},
options: [
{
displayName: 'Service ID',
name: 'connectionid',
type: 'string',
default: '',
description: 'The id of the connection object for the service where the customer originates.',
},
{
displayName: 'Customer ID',
name: 'externalid',
type: 'string',
default: '',
description: 'The id of the customer in the external service.',
},
{
displayName: 'Customer Email',
name: 'email',
type: 'string',
default: '',
description: 'The email address of the customer.',
},
{
displayName: 'Accepts Marketing',
name: 'acceptsMarketing',
type: 'boolean',
default: false,
description: 'Indication of whether customer has opt-ed in to marketing communications.',
},
],
},
2019-11-03 07:42:18 -08:00
2019-11-07 01:50:02 -08:00
// ----------------------------------
// ecommerceCustomer:delete
// ----------------------------------
{
displayName: 'Customer ID',
name: 'ecommerceCustomerId',
type: 'number',
displayOptions: {
show: {
operation: [
'delete',
],
resource: [
'ecommerceCustomer',
],
},
},
default: 0,
required: true,
description: 'ID of the E-commerce customer to delete.',
},
2019-11-03 07:42:18 -08:00
2019-11-07 01:50:02 -08:00
// ----------------------------------
// ecommerceCustomer:get
// ----------------------------------
{
displayName: 'Customer ID',
name: 'ecommerceCustomerId',
type: 'number',
displayOptions: {
show: {
operation: [
'get',
],
resource: [
'ecommerceCustomer',
],
},
},
default: 0,
required: true,
description: 'ID of the E-commerce customer to get.',
},
2019-11-03 07:42:18 -08:00
2019-11-07 01:50:02 -08:00
// ----------------------------------
// ecommerceCustomer:getAll
// ----------------------------------
...activeCampaignDefaultGetAllProperties('ecommerceCustomer', 'getAll'),
];