n8n/packages/nodes-base/nodes/Wekan/ChecklistDescription.ts
Iván Ovejero d4f858db92
refactor(nodes-base): Apply lint rule node-param-operation-option-action-wrong-for-get-many (#4055)
* 👕 Apply `node-param-operation-option-action-wrong-for-get-many`

* 🔥 Remove `package-lock.json`

* 📦 Re-add `package-lock.json`

*  master update

Co-authored-by: Michael Kret <michael.k@radency.com>
2022-09-08 17:10:13 +02:00

388 lines
9.1 KiB
TypeScript

import { INodeProperties } from 'n8n-workflow';
export const checklistOperations: INodeProperties[] = [
// ----------------------------------
// checklist
// ----------------------------------
{
displayName: 'Operation',
name: 'operation',
type: 'options',
noDataExpression: true,
displayOptions: {
show: {
resource: ['checklist'],
},
},
options: [
{
name: 'Create',
value: 'create',
description: 'Create a new checklist',
action: 'Create a checklist',
},
{
name: 'Delete',
value: 'delete',
description: 'Delete a checklist',
action: 'Delete a checklist',
},
{
name: 'Get',
value: 'get',
description: 'Get the data of a checklist',
action: 'Get a checklist',
},
{
name: 'Get Many',
value: 'getAll',
description: 'Returns all checklists for the card',
action: 'Get many checklists',
},
],
default: 'getAll',
},
];
export const checklistFields: INodeProperties[] = [
// ----------------------------------
// checklist:create
// ----------------------------------
{
displayName: 'Board Name or ID',
name: 'boardId',
type: 'options',
typeOptions: {
loadOptionsMethod: 'getBoards',
},
default: '',
required: true,
displayOptions: {
show: {
operation: ['create'],
resource: ['checklist'],
},
},
description:
'The ID of the board where the card is in. Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code-examples/expressions/">expression</a>.',
},
{
displayName: 'List Name or ID',
name: 'listId',
type: 'options',
typeOptions: {
loadOptionsMethod: 'getLists',
loadOptionsDependsOn: ['boardId'],
},
default: '',
required: true,
displayOptions: {
show: {
operation: ['create'],
resource: ['checklist'],
},
},
description:
'The ID of the list that card belongs to. Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code-examples/expressions/">expression</a>.',
},
{
displayName: 'Card Name or ID',
name: 'cardId',
type: 'options',
typeOptions: {
loadOptionsMethod: 'getCards',
loadOptionsDependsOn: ['boardId', 'listId'],
},
default: '',
required: true,
displayOptions: {
show: {
operation: ['create'],
resource: ['checklist'],
},
},
description:
'The ID of the card to add checklist to. Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code-examples/expressions/">expression</a>.',
},
{
displayName: 'Title',
name: 'title',
type: 'string',
default: '',
required: true,
displayOptions: {
show: {
operation: ['create'],
resource: ['checklist'],
},
},
description: 'The title of the checklist to add',
},
{
displayName: 'Items',
name: 'items',
type: 'string',
typeOptions: {
multipleValues: true,
multipleValueButtonText: 'Add Item',
},
displayOptions: {
show: {
operation: ['create'],
resource: ['checklist'],
},
},
default: [],
description: 'Items to be added to the checklist',
},
// ----------------------------------
// checklist:delete
// ----------------------------------
{
displayName: 'Board Name or ID',
name: 'boardId',
type: 'options',
typeOptions: {
loadOptionsMethod: 'getBoards',
},
default: '',
required: true,
displayOptions: {
show: {
operation: ['delete'],
resource: ['checklist'],
},
},
description:
'The ID of the board that card belongs to. Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code-examples/expressions/">expression</a>.',
},
{
displayName: 'List Name or ID',
name: 'listId',
type: 'options',
typeOptions: {
loadOptionsMethod: 'getLists',
loadOptionsDependsOn: ['boardId'],
},
default: '',
required: true,
displayOptions: {
show: {
operation: ['delete'],
resource: ['checklist'],
},
},
description:
'The ID of the list that card belongs to. Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code-examples/expressions/">expression</a>.',
},
{
displayName: 'Card Name or ID',
name: 'cardId',
type: 'options',
typeOptions: {
loadOptionsMethod: 'getCards',
loadOptionsDependsOn: ['boardId', 'listId'],
},
default: '',
required: true,
displayOptions: {
show: {
operation: ['delete'],
resource: ['checklist'],
},
},
description:
'The ID of the card that checklist belongs to. Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code-examples/expressions/">expression</a>.',
},
{
displayName: 'Checklist Name or ID',
name: 'checklistId',
type: 'options',
typeOptions: {
loadOptionsMethod: 'getChecklists',
loadOptionsDependsOn: ['boardId', 'cardId'],
},
default: '',
required: true,
displayOptions: {
show: {
operation: ['delete'],
resource: ['checklist'],
},
},
description:
'The ID of the checklist to delete. Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code-examples/expressions/">expression</a>.',
},
// ----------------------------------
// checklist:get
// ----------------------------------
{
displayName: 'Board Name or ID',
name: 'boardId',
type: 'options',
typeOptions: {
loadOptionsMethod: 'getBoards',
},
default: '',
required: true,
displayOptions: {
show: {
operation: ['get'],
resource: ['checklist'],
},
},
description:
'The ID of the board that card belongs to. Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code-examples/expressions/">expression</a>.',
},
{
displayName: 'List Name or ID',
name: 'listId',
type: 'options',
typeOptions: {
loadOptionsMethod: 'getLists',
loadOptionsDependsOn: ['boardId'],
},
default: '',
required: true,
displayOptions: {
show: {
operation: ['get'],
resource: ['checklist'],
},
},
description:
'The ID of the list that card belongs to. Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code-examples/expressions/">expression</a>.',
},
{
displayName: 'Card Name or ID',
name: 'cardId',
type: 'options',
typeOptions: {
loadOptionsMethod: 'getCards',
loadOptionsDependsOn: ['boardId', 'listId'],
},
default: '',
required: true,
displayOptions: {
show: {
operation: ['get'],
resource: ['checklist'],
},
},
description:
'The ID of the card that checklist belongs to. Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code-examples/expressions/">expression</a>.',
},
{
displayName: 'Checklist Name or ID',
name: 'checklistId',
type: 'options',
typeOptions: {
loadOptionsMethod: 'getChecklists',
loadOptionsDependsOn: ['boardId', 'cardId'],
},
default: '',
required: true,
displayOptions: {
show: {
operation: ['get'],
resource: ['checklist'],
},
},
description:
'The ID of the checklist to get. Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code-examples/expressions/">expression</a>.',
},
// ----------------------------------
// checklist:getAll
// ----------------------------------
{
displayName: 'Board Name or ID',
name: 'boardId',
type: 'options',
typeOptions: {
loadOptionsMethod: 'getBoards',
},
default: '',
required: true,
displayOptions: {
show: {
operation: ['getAll'],
resource: ['checklist'],
},
},
description:
'The ID of the board that list belongs to. Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code-examples/expressions/">expression</a>.',
},
{
displayName: 'List Name or ID',
name: 'listId',
type: 'options',
typeOptions: {
loadOptionsMethod: 'getLists',
loadOptionsDependsOn: ['boardId'],
},
default: '',
required: true,
displayOptions: {
show: {
operation: ['getAll'],
resource: ['checklist'],
},
},
description:
'The ID of the list that card belongs to. Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code-examples/expressions/">expression</a>.',
},
{
displayName: 'Card Name or ID',
name: 'cardId',
type: 'options',
typeOptions: {
loadOptionsMethod: 'getCards',
loadOptionsDependsOn: ['boardId', 'listId'],
},
default: '',
required: true,
displayOptions: {
show: {
operation: ['getAll'],
resource: ['checklist'],
},
},
description:
'The ID of the card to get checklists. Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code-examples/expressions/">expression</a>.',
},
{
displayName: 'Return All',
name: 'returnAll',
type: 'boolean',
displayOptions: {
show: {
operation: ['getAll'],
resource: ['checklist'],
},
},
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: ['checklist'],
returnAll: [false],
},
},
typeOptions: {
minValue: 1,
maxValue: 200,
},
default: 100,
description: 'Max number of results to return',
},
];