n8n/packages/nodes-base/nodes/KoBoToolbox/HookDescription.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

153 lines
3.5 KiB
TypeScript

import { INodeProperties } from 'n8n-workflow';
export const hookOperations: INodeProperties[] = [
{
displayName: 'Operation',
name: 'operation',
type: 'options',
noDataExpression: true,
displayOptions: {
show: {
resource: ['hook'],
},
},
options: [
{
name: 'Get',
value: 'get',
description: 'Get a single hook definition',
action: 'Get a hook',
},
{
name: 'Get Many',
value: 'getAll',
description: 'List many hooks on a form',
action: 'Get many hooks',
},
{
name: 'Logs',
value: 'getLogs',
description: 'Get hook logs',
action: 'Logs a hook',
},
{
name: 'Retry All',
value: 'retryAll',
description: 'Retry all failed attempts for a given hook',
action: 'Retry all hooks',
},
{
name: 'Retry One',
value: 'retryOne',
description: 'Retry a specific hook',
action: 'Retry one hook',
},
],
default: 'getAll',
},
];
export const hookFields: INodeProperties[] = [
/* -------------------------------------------------------------------------- */
/* hook:get */
/* -------------------------------------------------------------------------- */
{
displayName: 'Form Name or ID',
name: 'formId',
type: 'options',
typeOptions: {
loadOptionsMethod: 'loadForms',
},
required: true,
default: '',
displayOptions: {
show: {
resource: ['hook'],
operation: ['get', 'retryOne', 'retryAll', 'getLogs'],
},
},
description:
'Form ID (e.g. aSAvYreNzVEkrWg5Gdcvg). Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code-examples/expressions/">expression</a>.',
},
{
displayName: 'Hook ID',
name: 'hookId',
type: 'string',
required: true,
displayOptions: {
show: {
resource: ['hook'],
operation: ['get', 'retryOne', 'retryAll', 'getLogs'],
},
},
default: '',
description: 'Hook ID (starts with h, e.g. hVehywQ2oXPYGHJHKtqth4)',
},
/* -------------------------------------------------------------------------- */
/* hook:getAll */
/* -------------------------------------------------------------------------- */
{
displayName: 'Form Name or ID',
name: 'formId',
type: 'options',
typeOptions: {
loadOptionsMethod: 'loadForms',
},
required: true,
default: '',
displayOptions: {
show: {
resource: ['hook'],
operation: ['getAll'],
},
},
description:
'Form ID (e.g. aSAvYreNzVEkrWg5Gdcvg). Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code-examples/expressions/">expression</a>.',
},
{
displayName: 'Hook Log ID',
name: 'logId',
type: 'string',
required: true,
displayOptions: {
show: {
resource: ['hook'],
operation: ['retryOne'],
},
},
default: '',
description: 'Hook log ID (starts with hl, e.g. hlSbGKaUKzTVNoWEVMYbLHe)',
},
{
displayName: 'Return All',
name: 'returnAll',
type: 'boolean',
required: true,
default: false,
displayOptions: {
show: {
resource: ['hook'],
operation: ['getAll', 'getLogs'],
},
},
description: 'Whether to return all results or only up to a given limit',
},
{
displayName: 'Limit',
name: 'limit',
type: 'number',
typeOptions: {
maxValue: 3000,
},
displayOptions: {
show: {
resource: ['hook'],
operation: ['getAll', 'getLogs'],
returnAll: [false],
},
},
default: 1000,
description: 'Max number of results to return',
},
];