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

227 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',
refactor: Apply more nodelinting rules (#3324) * :pencil2: Alphabetize lint rules * :fire: Remove duplicates * :zap: Update `lintfix` script * :shirt: Apply `node-param-operation-without-no-data-expression` (#3329) * :shirt: Apply `node-param-operation-without-no-data-expression` * :shirt: Add exceptions * :shirt: Apply `node-param-description-weak` (#3328) Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * :shirt: Apply `node-param-option-value-duplicate` (#3331) * :shirt: Apply `node-param-description-miscased-json` (#3337) * :shirt: Apply `node-param-display-name-excess-inner-whitespace` (#3335) Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * :shirt: Apply `node-param-type-options-missing-from-limit` (#3336) * Rule workig as intended * :pencil2: Uncomment rules Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * :shirt: Apply `node-param-option-name-duplicate` (#3338) Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * :shirt: Apply `node-param-description-wrong-for-simplify` (#3334) * :zap: fix * :zap: exceptions * :zap: changed rule ignoring from file to line * :shirt: Apply `node-param-resource-without-no-data-expression` (#3339) * :shirt: Apply `node-param-display-name-untrimmed` (#3341) * :shirt: Apply `node-param-display-name-miscased-id` (#3340) Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * :shirt: Apply `node-param-resource-with-plural-option` (#3342) * :shirt: Apply `node-param-description-wrong-for-upsert` (#3333) * :zap: fix * :zap: replaced record with contact in description * :zap: fix Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * :shirt: Apply `node-param-option-description-identical-to-name` (#3343) * :shirt: Apply `node-param-option-name-containing-star` (#3347) * :shirt: Apply `node-param-display-name-wrong-for-update-fields` (#3348) * :shirt: Apply `node-param-option-name-wrong-for-get-all` (#3345) * :zap: fix * :zap: exceptions * :shirt: Apply node-param-display-name-wrong-for-simplify (#3344) * Rule working as intended * Uncomented other rules * :shirt: Undo and add exceptions Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * :zap: Alphabetize lint rules * :zap: Restore `lintfix` script Co-authored-by: Michael Kret <88898367+michael-radency@users.noreply.github.com> Co-authored-by: agobrech <45268029+agobrech@users.noreply.github.com>
2022-05-20 14:47:24 -07:00
noDataExpression: true,
2019-11-07 01:50:02 -08:00
displayOptions: {
show: {
resource: ['ecommerceCustomer'],
2019-11-07 01:50:02 -08:00
},
},
options: [
{
name: 'Create',
value: 'create',
description: 'Create a E-commerce Customer',
action: 'Create an e-commerce customer',
2019-11-07 01:50:02 -08:00
},
{
name: 'Delete',
value: 'delete',
description: 'Delete a E-commerce Customer',
action: 'Delete an e-commerce customer',
2019-11-07 01:50:02 -08:00
},
{
name: 'Get',
value: 'get',
description: 'Get data of a E-commerce Customer',
action: 'Get an e-commerce customer',
2019-11-07 01:50:02 -08:00
},
{
name: 'Get Many',
2019-11-07 01:50:02 -08:00
value: 'getAll',
description: 'Get data of all E-commerce Customer',
action: 'Get many e-commerce customers',
2019-11-07 01:50:02 -08:00
},
{
name: 'Update',
value: 'update',
description: 'Update a E-commerce Customer',
action: 'Update an e-commerce customer',
2019-11-07 01:50:02 -08:00
},
],
default: 'create',
},
];
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'],
2019-11-07 01:50:02 -08:00
},
},
description: 'The ID of the connection object for the service where the customer originates',
2019-11-07 01:50:02 -08:00
},
{
displayName: 'Customer ID',
name: 'externalid',
type: 'string',
default: '',
required: true,
displayOptions: {
show: {
operation: ['create'],
resource: ['ecommerceCustomer'],
2019-11-07 01:50:02 -08:00
},
},
description: 'The ID of the customer in the external service',
2019-11-07 01:50:02 -08:00
},
{
displayName: 'Customer Email',
name: 'email',
type: 'string',
refactor: Apply more `eslint-plugin-n8n-nodes-base` rules (#3534) * :zap: Update `lintfix` script * :zap: Run baseline `lintfix` * :fire: Remove unneeded exceptions (#3538) * :fire: Remove exceptions for `node-param-default-wrong-for-simplify` * :fire: Remove exceptions for `node-param-placeholder-miscased-id` * :zap: Update version * :shirt: Apply `node-param-placeholder-missing` (#3542) * :shirt: Apply `filesystem-wrong-cred-filename` (#3543) * :shirt: Apply `node-param-description-missing-from-dynamic-options` (#3545) Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * :shirt: Apply `node-class-description-empty-string` (#3546) * :shirt: Apply `node-class-description-icon-not-svg` (#3548) * :shirt: Apply `filesystem-wrong-node-filename` (#3549) Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * :shirt: Expand lintings to credentials (#3550) * :shirt: Apply `node-param-multi-options-type-unsorted-items` (#3552) * :zap: fix * :zap: Minor fixes Co-authored-by: Michael Kret <michael.k@radency.com> * :shirt: Apply `node-param-description-wrong-for-dynamic-multi-options` (#3541) * :zap: Add new lint rule, node-param-description-wrong-for-dynamic-multi-options * :zap: Fix with updated linting rules * :zap: Minor fixes Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * :shirt: Apply `node-param-description-boolean-without-whether` (#3553) * :zap: fix * Update packages/nodes-base/nodes/Clockify/ProjectDescription.ts Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * :shirt: Apply node-param-display-name-wrong-for-dynamic-multi-options (#3537) * :shirt: Add exceptions * :shirt: Add exception * :pencil2: Alphabetize rules * :zap: Restore `lintfix` command Co-authored-by: agobrech <45268029+agobrech@users.noreply.github.com> Co-authored-by: Omar Ajoue <krynble@gmail.com> Co-authored-by: Michael Kret <michael.k@radency.com> Co-authored-by: brianinoa <54530642+brianinoa@users.noreply.github.com> Co-authored-by: Michael Kret <88898367+michael-radency@users.noreply.github.com>
2022-06-20 07:54:01 -07:00
placeholder: 'name@email.com',
2019-11-07 01:50:02 -08:00
default: '',
required: true,
displayOptions: {
show: {
operation: ['create'],
resource: ['ecommerceCustomer'],
2019-11-07 01:50:02 -08:00
},
},
description: 'The email address of the customer',
2019-11-07 01:50:02 -08:00
},
{
displayName: 'Additional Fields',
name: 'additionalFields',
type: 'collection',
placeholder: 'Add Field',
displayOptions: {
show: {
operation: ['create'],
resource: ['ecommerceCustomer'],
2019-11-07 01:50:02 -08:00
},
},
default: {},
options: [
{
displayName: 'Accepts Marketing',
name: 'acceptsMarketing',
type: 'boolean',
default: false,
refactor: Apply more `eslint-plugin-n8n-nodes-base` rules (#3534) * :zap: Update `lintfix` script * :zap: Run baseline `lintfix` * :fire: Remove unneeded exceptions (#3538) * :fire: Remove exceptions for `node-param-default-wrong-for-simplify` * :fire: Remove exceptions for `node-param-placeholder-miscased-id` * :zap: Update version * :shirt: Apply `node-param-placeholder-missing` (#3542) * :shirt: Apply `filesystem-wrong-cred-filename` (#3543) * :shirt: Apply `node-param-description-missing-from-dynamic-options` (#3545) Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * :shirt: Apply `node-class-description-empty-string` (#3546) * :shirt: Apply `node-class-description-icon-not-svg` (#3548) * :shirt: Apply `filesystem-wrong-node-filename` (#3549) Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * :shirt: Expand lintings to credentials (#3550) * :shirt: Apply `node-param-multi-options-type-unsorted-items` (#3552) * :zap: fix * :zap: Minor fixes Co-authored-by: Michael Kret <michael.k@radency.com> * :shirt: Apply `node-param-description-wrong-for-dynamic-multi-options` (#3541) * :zap: Add new lint rule, node-param-description-wrong-for-dynamic-multi-options * :zap: Fix with updated linting rules * :zap: Minor fixes Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * :shirt: Apply `node-param-description-boolean-without-whether` (#3553) * :zap: fix * Update packages/nodes-base/nodes/Clockify/ProjectDescription.ts Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * :shirt: Apply node-param-display-name-wrong-for-dynamic-multi-options (#3537) * :shirt: Add exceptions * :shirt: Add exception * :pencil2: Alphabetize rules * :zap: Restore `lintfix` command Co-authored-by: agobrech <45268029+agobrech@users.noreply.github.com> Co-authored-by: Omar Ajoue <krynble@gmail.com> Co-authored-by: Michael Kret <michael.k@radency.com> Co-authored-by: brianinoa <54530642+brianinoa@users.noreply.github.com> Co-authored-by: Michael Kret <88898367+michael-radency@users.noreply.github.com>
2022-06-20 07:54:01 -07:00
description: 'Whether customer has opt-ed in to marketing communications',
2019-11-07 01:50:02 -08:00
},
],
},
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'],
2019-11-07 01:50:02 -08:00
},
},
default: 0,
required: true,
description: 'ID of the E-commerce customer to update',
2019-11-07 01:50:02 -08:00
},
{
displayName: 'Update Fields',
name: 'updateFields',
type: 'collection',
description: 'The fields to update',
2019-11-07 01:50:02 -08:00
placeholder: 'Add Field',
displayOptions: {
show: {
operation: ['update'],
resource: ['ecommerceCustomer'],
2019-11-07 01:50:02 -08:00
},
},
default: {},
options: [
{
displayName: 'Service ID',
name: 'connectionid',
type: 'string',
default: '',
description:
'The ID of the connection object for the service where the customer originates',
2019-11-07 01:50:02 -08:00
},
{
displayName: 'Customer ID',
name: 'externalid',
type: 'string',
default: '',
description: 'The ID of the customer in the external service',
2019-11-07 01:50:02 -08:00
},
{
displayName: 'Customer Email',
name: 'email',
type: 'string',
refactor: Apply more `eslint-plugin-n8n-nodes-base` rules (#3534) * :zap: Update `lintfix` script * :zap: Run baseline `lintfix` * :fire: Remove unneeded exceptions (#3538) * :fire: Remove exceptions for `node-param-default-wrong-for-simplify` * :fire: Remove exceptions for `node-param-placeholder-miscased-id` * :zap: Update version * :shirt: Apply `node-param-placeholder-missing` (#3542) * :shirt: Apply `filesystem-wrong-cred-filename` (#3543) * :shirt: Apply `node-param-description-missing-from-dynamic-options` (#3545) Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * :shirt: Apply `node-class-description-empty-string` (#3546) * :shirt: Apply `node-class-description-icon-not-svg` (#3548) * :shirt: Apply `filesystem-wrong-node-filename` (#3549) Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * :shirt: Expand lintings to credentials (#3550) * :shirt: Apply `node-param-multi-options-type-unsorted-items` (#3552) * :zap: fix * :zap: Minor fixes Co-authored-by: Michael Kret <michael.k@radency.com> * :shirt: Apply `node-param-description-wrong-for-dynamic-multi-options` (#3541) * :zap: Add new lint rule, node-param-description-wrong-for-dynamic-multi-options * :zap: Fix with updated linting rules * :zap: Minor fixes Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * :shirt: Apply `node-param-description-boolean-without-whether` (#3553) * :zap: fix * Update packages/nodes-base/nodes/Clockify/ProjectDescription.ts Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * :shirt: Apply node-param-display-name-wrong-for-dynamic-multi-options (#3537) * :shirt: Add exceptions * :shirt: Add exception * :pencil2: Alphabetize rules * :zap: Restore `lintfix` command Co-authored-by: agobrech <45268029+agobrech@users.noreply.github.com> Co-authored-by: Omar Ajoue <krynble@gmail.com> Co-authored-by: Michael Kret <michael.k@radency.com> Co-authored-by: brianinoa <54530642+brianinoa@users.noreply.github.com> Co-authored-by: Michael Kret <88898367+michael-radency@users.noreply.github.com>
2022-06-20 07:54:01 -07:00
placeholder: 'name@email.com',
2019-11-07 01:50:02 -08:00
default: '',
description: 'The email address of the customer',
2019-11-07 01:50:02 -08:00
},
{
displayName: 'Accepts Marketing',
name: 'acceptsMarketing',
type: 'boolean',
default: false,
refactor: Apply more `eslint-plugin-n8n-nodes-base` rules (#3534) * :zap: Update `lintfix` script * :zap: Run baseline `lintfix` * :fire: Remove unneeded exceptions (#3538) * :fire: Remove exceptions for `node-param-default-wrong-for-simplify` * :fire: Remove exceptions for `node-param-placeholder-miscased-id` * :zap: Update version * :shirt: Apply `node-param-placeholder-missing` (#3542) * :shirt: Apply `filesystem-wrong-cred-filename` (#3543) * :shirt: Apply `node-param-description-missing-from-dynamic-options` (#3545) Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * :shirt: Apply `node-class-description-empty-string` (#3546) * :shirt: Apply `node-class-description-icon-not-svg` (#3548) * :shirt: Apply `filesystem-wrong-node-filename` (#3549) Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * :shirt: Expand lintings to credentials (#3550) * :shirt: Apply `node-param-multi-options-type-unsorted-items` (#3552) * :zap: fix * :zap: Minor fixes Co-authored-by: Michael Kret <michael.k@radency.com> * :shirt: Apply `node-param-description-wrong-for-dynamic-multi-options` (#3541) * :zap: Add new lint rule, node-param-description-wrong-for-dynamic-multi-options * :zap: Fix with updated linting rules * :zap: Minor fixes Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * :shirt: Apply `node-param-description-boolean-without-whether` (#3553) * :zap: fix * Update packages/nodes-base/nodes/Clockify/ProjectDescription.ts Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * :shirt: Apply node-param-display-name-wrong-for-dynamic-multi-options (#3537) * :shirt: Add exceptions * :shirt: Add exception * :pencil2: Alphabetize rules * :zap: Restore `lintfix` command Co-authored-by: agobrech <45268029+agobrech@users.noreply.github.com> Co-authored-by: Omar Ajoue <krynble@gmail.com> Co-authored-by: Michael Kret <michael.k@radency.com> Co-authored-by: brianinoa <54530642+brianinoa@users.noreply.github.com> Co-authored-by: Michael Kret <88898367+michael-radency@users.noreply.github.com>
2022-06-20 07:54:01 -07:00
description: 'Whether customer has opt-ed in to marketing communications',
2019-11-07 01:50:02 -08:00
},
],
},
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'],
2019-11-07 01:50:02 -08:00
},
},
default: 0,
required: true,
description: 'ID of the E-commerce customer to delete',
2019-11-07 01:50:02 -08:00
},
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'],
2019-11-07 01:50:02 -08:00
},
},
default: 0,
required: true,
description: 'ID of the E-commerce customer to get',
2019-11-07 01:50:02 -08:00
},
2019-11-03 07:42:18 -08:00
2019-11-07 01:50:02 -08:00
// ----------------------------------
// ecommerceCustomer:getAll
// ----------------------------------
...activeCampaignDefaultGetAllProperties('ecommerceCustomer', 'getAll'),
];