n8n/packages/nodes-base/nodes/Autopilot/ContactListDescription.ts
Iván Ovejero 3a9c7acb04
refactor(nodes-base): Apply lint rule node-param-operation-option-description-wrong-for-get-many (#4064)
* 👕 Enable rule

* ⬆️ Upgrade linter

* 📦 Update `package-lock.json`

* 👕 Apply rule

* ✏️ Fix plurals

* ✏️ More typos

* ✏️ Final typos
2022-09-13 12:36:36 +02:00

116 lines
2.7 KiB
TypeScript

import { INodeProperties } from 'n8n-workflow';
export const contactListOperations: INodeProperties[] = [
{
displayName: 'Operation',
name: 'operation',
type: 'options',
noDataExpression: true,
displayOptions: {
show: {
resource: ['contactList'],
},
},
options: [
{
name: 'Add',
value: 'add',
description: 'Add contact to list',
action: 'Add a contact to a list',
},
{
name: 'Exist',
value: 'exist',
description: 'Check if contact is on list',
action: 'Check if a contact list exists',
},
{
name: 'Get Many',
value: 'getAll',
description: 'Get many contacts from a list',
action: 'Get many contact lists',
},
{
name: 'Remove',
value: 'remove',
description: 'Remove a contact from a list',
action: 'Remove a contact from a list',
},
],
default: 'add',
},
];
export const contactListFields: INodeProperties[] = [
/* -------------------------------------------------------------------------- */
/* contactList:add */
/* -------------------------------------------------------------------------- */
{
displayName: 'List Name or ID',
name: 'listId',
required: true,
typeOptions: {
loadOptionsMethod: 'getLists',
},
type: 'options',
displayOptions: {
show: {
operation: ['add', 'remove', 'exist', 'getAll'],
resource: ['contactList'],
},
},
default: '',
description:
'ID of the list to operate on. Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code-examples/expressions/">expression</a>.',
},
{
displayName: 'Contact ID',
name: 'contactId',
required: true,
type: 'string',
displayOptions: {
show: {
operation: ['add', 'remove', 'exist'],
resource: ['contactList'],
},
},
default: '',
description: 'Can be ID or email',
},
/* -------------------------------------------------------------------------- */
/* contactList:getAll */
/* -------------------------------------------------------------------------- */
{
displayName: 'Return All',
name: 'returnAll',
type: 'boolean',
displayOptions: {
show: {
operation: ['getAll'],
resource: ['contactList'],
},
},
default: false,
description: 'Whether to return all results or only up to a given limit',
},
{
displayName: 'Limit',
name: 'limit',
type: 'number',
displayOptions: {
show: {
operation: ['getAll'],
resource: ['contactList'],
returnAll: [false],
},
},
typeOptions: {
minValue: 1,
maxValue: 500,
},
default: 100,
description: 'Max number of results to return',
},
];