n8n/packages/nodes-base/nodes/MonicaCrm/descriptions/ReminderDescription.ts

339 lines
6.5 KiB
TypeScript
Raw Normal View History

import { INodeProperties } from 'n8n-workflow';
export const reminderOperations: INodeProperties[] = [
{
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,
displayOptions: {
show: {
resource: ['reminder'],
},
},
options: [
{
name: 'Create',
value: 'create',
description: 'Create a reminder',
action: 'Create a reminder',
},
{
name: 'Delete',
value: 'delete',
description: 'Delete a reminder',
action: 'Delete a reminder',
},
{
name: 'Get',
value: 'get',
description: 'Retrieve a reminder',
action: 'Get a reminder',
},
{
name: 'Get All',
value: 'getAll',
description: 'Retrieve all reminders',
action: 'Get all reminders',
},
{
name: 'Update',
value: 'update',
description: 'Update a reminder',
action: 'Update a reminder',
},
],
default: 'create',
},
];
export const reminderFields: INodeProperties[] = [
// ----------------------------------------
// reminder: create
// ----------------------------------------
{
displayName: 'Contact ID',
name: 'contactId',
type: 'string',
default: '',
description: 'ID of the contact to associate the reminder with',
displayOptions: {
show: {
resource: ['reminder'],
operation: ['create'],
},
},
},
{
displayName: 'Frequency Type',
name: 'frequencyType',
description: 'Type of frequency of the reminder',
type: 'options',
required: true,
default: 'one_time',
options: [
{
name: 'Once',
value: 'one_time',
},
{
name: 'Weekly',
value: 'week',
},
{
name: 'Monthly',
value: 'month',
},
{
name: 'Yearly',
value: 'year',
},
],
displayOptions: {
show: {
resource: ['reminder'],
operation: ['create'],
},
},
},
{
displayName: 'Recurring Interval',
name: 'frequencyNumber',
type: 'number',
default: 0,
description: 'Interval for the reminder',
displayOptions: {
show: {
resource: ['reminder'],
operation: ['create'],
frequencyType: ['week', 'month', 'year'],
},
},
},
{
displayName: 'Initial Date',
name: 'initialDate',
description: 'Date of the reminder',
type: 'dateTime',
required: true,
default: '',
displayOptions: {
show: {
resource: ['reminder'],
operation: ['create'],
},
},
},
{
displayName: 'Title',
name: 'title',
description: 'Title of the reminder - max 100,000 characters',
type: 'string',
required: true,
default: '',
displayOptions: {
show: {
resource: ['reminder'],
operation: ['create'],
},
},
},
{
displayName: 'Additional Fields',
name: 'additionalFields',
type: 'collection',
placeholder: 'Add Field',
default: {},
displayOptions: {
show: {
resource: ['reminder'],
operation: ['create'],
},
},
options: [
{
displayName: 'Description',
name: 'description',
type: 'string',
default: '',
description: 'Description about the reminder - Max 100,000 characters',
typeOptions: {
alwaysOpenEditWindow: true,
},
},
],
},
// ----------------------------------------
// reminder: delete
// ----------------------------------------
{
displayName: 'Reminder ID',
name: 'reminderId',
description: 'ID of the reminder to delete',
type: 'string',
required: true,
default: '',
displayOptions: {
show: {
resource: ['reminder'],
operation: ['delete'],
},
},
},
// ----------------------------------------
// reminder: get
// ----------------------------------------
{
displayName: 'Reminder ID',
name: 'reminderId',
description: 'ID of the reminder to retrieve',
type: 'string',
required: true,
default: '',
displayOptions: {
show: {
resource: ['reminder'],
operation: ['get'],
},
},
},
// ----------------------------------------
// reminder: getAll
// ----------------------------------------
{
displayName: 'Return All',
name: 'returnAll',
type: 'boolean',
default: false,
description: 'Whether to return all results or only up to a given limit',
displayOptions: {
show: {
resource: ['reminder'],
operation: ['getAll'],
},
},
},
{
displayName: 'Limit',
name: 'limit',
type: 'number',
default: 50,
description: 'Max number of results to return',
typeOptions: {
minValue: 1,
},
displayOptions: {
show: {
resource: ['reminder'],
operation: ['getAll'],
returnAll: [false],
},
},
},
// ----------------------------------------
// reminder: update
// ----------------------------------------
{
displayName: 'Reminder ID',
name: 'reminderId',
description: 'ID of the reminder to update',
type: 'string',
required: true,
default: '',
displayOptions: {
show: {
resource: ['reminder'],
operation: ['update'],
},
},
},
{
displayName: 'Update Fields',
name: 'updateFields',
type: 'collection',
placeholder: 'Add Field',
default: {},
displayOptions: {
show: {
resource: ['reminder'],
operation: ['update'],
},
},
options: [
{
displayName: 'Contact ID',
name: 'contact_id',
type: 'string',
default: '',
description: 'ID of the contact to associate the reminder with',
},
{
displayName: 'Description',
name: 'description',
type: 'string',
default: '',
description: 'Description about the reminder - Max 100,000 characters',
typeOptions: {
alwaysOpenEditWindow: true,
},
},
{
displayName: 'Frequency Type',
name: 'frequency_type',
description: 'Frequency of the reminder',
type: 'options',
default: 'one_time',
options: [
{
name: 'One Time',
value: 'one_time',
},
{
name: 'Week',
value: 'week',
},
{
name: 'Month',
value: 'month',
},
{
name: 'Year',
value: 'year',
},
],
},
{
displayName: 'Initial Date',
name: 'initial_data',
description: 'Date of the reminder',
type: 'dateTime',
default: '',
},
{
displayName: 'Recurring Interval',
name: 'frequency_number',
type: 'number',
default: 0,
description: 'Interval for the reminder',
displayOptions: {
show: {
frequency_type: ['week', 'month', 'year'],
},
},
},
{
displayName: 'Title',
name: 'title',
description: 'Title of the reminder - max 100,000 characters',
type: 'string',
default: '',
},
],
},
];