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

290 lines
5.5 KiB
TypeScript
Raw Normal View History

import {
INodeProperties,
2021-01-13 11:20:30 -08:00
} from 'n8n-workflow';
import {
activeCampaignDefaultGetAllProperties,
2021-01-13 11:20:30 -08:00
} from './GenericFunctions';
2019-11-03 13:17:43 -08:00
export const connectionOperations: 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: [
'connection',
],
},
},
options: [
{
name: 'Create',
value: 'create',
description: 'Create a connection',
},
{
name: 'Delete',
value: 'delete',
description: 'Delete a connection',
},
{
name: 'Get',
value: 'get',
description: 'Get data of a connection',
},
{
name: 'Get All',
value: 'getAll',
description: 'Get data of all connections',
},
{
name: 'Update',
value: 'update',
description: 'Update a connection',
},
],
default: 'create',
},
2019-11-03 13:17:43 -08:00
];
2019-11-03 13:17:43 -08:00
export const connectionFields: INodeProperties[] = [
2019-11-07 01:50:02 -08:00
// ----------------------------------
// connection:create
// ----------------------------------
{
displayName: 'Service',
name: 'service',
type: 'string',
default: '',
required: true,
displayOptions: {
show: {
operation: [
'create',
],
resource: [
'connection',
],
},
},
description: 'The name of the service',
2019-11-07 01:50:02 -08:00
},
{
refactor: Apply more `eslint-plugin-n8n-nodes-base` autofixable rules (#3432) * :zap: Update `lintfix` script * :shirt: Remove unneeded lint exceptions * :shirt: Run baseline `lintfix` * :shirt: Apply `node-param-description-miscased-url` (#3441) * :shirt: Apply `rule node-param-placeholder-miscased-id` (#3443) Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * :shirt: Apply `node-param-option-name-wrong-for-upsert` (#3446) * :shirt: Apply `node-param-min-value-wrong-for-limit` (#3442) Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * Apply `node-param-display-name-wrong-for-dynamic-options` (#3454) * :hammer: fix * :zap: Fix `Assigned To` fields Co-authored-by: Michael Kret <michael.k@radency.com> * :shirt: Apply `rule node-param-default-wrong-for-number` (#3453) * :shirt: Apply `node-param-default-wrong-for-string` (#3452) Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * Apply `node-param-display-name-miscased` (#3449) * :hammer: fix * :hammer: exceptions * :zap: review fixes * :shirt: Apply `node-param-description-lowercase-first-char` (#3451) * :zap: fix * :zap: review fixes * :zap: fix Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * :shirt: Apply `node-param-description-wrong-for-dynamic-options` (#3456) * Rule working as intended * Add rule * :fire: Remove repetitions * :shirt: Add exceptions Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * :shirt: Small fix for `node-param-description-wrong-for-dynamic-options` * :shirt: Apply `node-param-default-wrong-for-fixed-collection` (#3460) * :shirt: Apply `node-param-description-line-break-html-tag` (#3462) * :shirt: Run baseline `lintfix` * :shirt: Apply `node-param-options-type-unsorted-items` (#3459) * :zap: fix * :hammer: exceptions * Add exception for Salesmate and Zoom Co-authored-by: Michael Kret <michael.k@radency.com> Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * :zap: Restore `lintfix` command Co-authored-by: Omar Ajoue <krynble@gmail.com> Co-authored-by: Michael Kret <88898367+michael-radency@users.noreply.github.com> Co-authored-by: agobrech <45268029+agobrech@users.noreply.github.com> Co-authored-by: Michael Kret <michael.k@radency.com> Co-authored-by: brianinoa <54530642+brianinoa@users.noreply.github.com>
2022-06-03 10:23:49 -07:00
displayName: 'External Account ID',
2019-11-07 01:50:02 -08:00
name: 'externalid',
type: 'string',
default: '',
required: true,
displayOptions: {
show: {
operation: [
'create',
],
resource: [
'connection',
],
},
},
description: 'The ID of the account in the external service',
2019-11-07 01:50:02 -08:00
},
{
displayName: 'Account Name',
name: 'name',
type: 'string',
default: '',
required: true,
displayOptions: {
show: {
operation: [
'create',
],
resource: [
'connection',
],
},
},
description: 'The name associated with the account in the external service. Often this will be a company name (e.g., "My Toystore, Inc.").',
},
{
displayName: 'Logo URL',
name: 'logoUrl',
type: 'string',
default: '',
required: true,
displayOptions: {
show: {
operation: [
'create',
],
resource: [
'connection',
],
},
},
description: 'The URL to a logo image for the external service',
2019-11-07 01:50:02 -08:00
},
{
displayName: 'Link URL',
name: 'linkUrl',
type: 'string',
default: '',
required: true,
displayOptions: {
show: {
operation: [
'create',
],
resource: [
'connection',
],
},
},
description: 'The URL to a page where the integration with the external service can be managed in the third-party\'s website',
2019-11-07 01:50:02 -08:00
},
2019-11-03 13:17:43 -08:00
2019-11-07 01:50:02 -08:00
// ----------------------------------
// connection:update
// ----------------------------------
{
displayName: 'Connection ID',
name: 'connectionId',
type: 'number',
displayOptions: {
show: {
operation: [
'update',
],
resource: [
'connection',
],
},
},
default: 0,
required: true,
description: 'ID of the connection 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: [
'connection',
],
},
},
default: {},
options: [
{
displayName: 'Service',
name: 'service',
type: 'string',
default: '',
description: 'The name of the service',
2019-11-07 01:50:02 -08:00
},
{
refactor: Apply more `eslint-plugin-n8n-nodes-base` autofixable rules (#3432) * :zap: Update `lintfix` script * :shirt: Remove unneeded lint exceptions * :shirt: Run baseline `lintfix` * :shirt: Apply `node-param-description-miscased-url` (#3441) * :shirt: Apply `rule node-param-placeholder-miscased-id` (#3443) Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * :shirt: Apply `node-param-option-name-wrong-for-upsert` (#3446) * :shirt: Apply `node-param-min-value-wrong-for-limit` (#3442) Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * Apply `node-param-display-name-wrong-for-dynamic-options` (#3454) * :hammer: fix * :zap: Fix `Assigned To` fields Co-authored-by: Michael Kret <michael.k@radency.com> * :shirt: Apply `rule node-param-default-wrong-for-number` (#3453) * :shirt: Apply `node-param-default-wrong-for-string` (#3452) Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * Apply `node-param-display-name-miscased` (#3449) * :hammer: fix * :hammer: exceptions * :zap: review fixes * :shirt: Apply `node-param-description-lowercase-first-char` (#3451) * :zap: fix * :zap: review fixes * :zap: fix Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * :shirt: Apply `node-param-description-wrong-for-dynamic-options` (#3456) * Rule working as intended * Add rule * :fire: Remove repetitions * :shirt: Add exceptions Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * :shirt: Small fix for `node-param-description-wrong-for-dynamic-options` * :shirt: Apply `node-param-default-wrong-for-fixed-collection` (#3460) * :shirt: Apply `node-param-description-line-break-html-tag` (#3462) * :shirt: Run baseline `lintfix` * :shirt: Apply `node-param-options-type-unsorted-items` (#3459) * :zap: fix * :hammer: exceptions * Add exception for Salesmate and Zoom Co-authored-by: Michael Kret <michael.k@radency.com> Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * :zap: Restore `lintfix` command Co-authored-by: Omar Ajoue <krynble@gmail.com> Co-authored-by: Michael Kret <88898367+michael-radency@users.noreply.github.com> Co-authored-by: agobrech <45268029+agobrech@users.noreply.github.com> Co-authored-by: Michael Kret <michael.k@radency.com> Co-authored-by: brianinoa <54530642+brianinoa@users.noreply.github.com>
2022-06-03 10:23:49 -07:00
displayName: 'External Account ID',
2019-11-07 01:50:02 -08:00
name: 'externalid',
type: 'string',
default: '',
description: 'The ID of the account in the external service',
2019-11-07 01:50:02 -08:00
},
{
displayName: 'Account Name',
name: 'name',
type: 'string',
default: '',
description: 'The name associated with the account in the external service. Often this will be a company name (e.g., "My Toystore, Inc.").',
},
{
displayName: 'Logo URL',
name: 'logoUrl',
type: 'string',
default: '',
description: 'The URL to a logo image for the external service',
2019-11-07 01:50:02 -08:00
},
{
displayName: 'Link URL',
name: 'linkUrl',
type: 'string',
default: '',
description: 'The URL to a page where the integration with the external service can be managed in the third-party\'s website',
2019-11-07 01:50:02 -08:00
},
{
displayName: 'Status',
name: 'status',
type: 'number',
default: 1,
description: 'The status of the connection (0 = error; 1 = connected)',
},
{
displayName: 'Syncronisation Status',
name: 'syncStatus',
type: 'number',
default: 1,
description: 'The status of a sync triggered on the connection (0 = sync stopped; 1 = sync running)',
2019-11-07 01:50:02 -08:00
},
2020-10-22 06:46:03 -07:00
],
2019-11-07 01:50:02 -08:00
},
2019-11-03 13:17:43 -08:00
2019-11-07 01:50:02 -08:00
// ----------------------------------
// connection:delete
// ----------------------------------
{
displayName: 'Connection ID',
name: 'connectionId',
type: 'number',
displayOptions: {
show: {
operation: [
'delete',
],
resource: [
'connection',
],
},
},
default: 0,
required: true,
description: 'ID of the connection to delete',
2019-11-07 01:50:02 -08:00
},
2019-11-03 13:17:43 -08:00
2019-11-07 01:50:02 -08:00
// ----------------------------------
// connection:get
// ----------------------------------
{
displayName: 'Connection ID',
name: 'connectionId',
type: 'number',
displayOptions: {
show: {
operation: [
'get',
],
resource: [
'connection',
],
},
},
default: 0,
required: true,
description: 'ID of the connection to get',
2019-11-07 01:50:02 -08:00
},
2019-11-03 13:17:43 -08:00
2019-11-07 01:50:02 -08:00
// ----------------------------------
// connection:getAll
// ----------------------------------
...activeCampaignDefaultGetAllProperties('connection', 'getAll'),
];