n8n/packages/nodes-base/nodes/Zoho/descriptions/ContactDescription.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

562 lines
10 KiB
TypeScript
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

import { INodeProperties } from 'n8n-workflow';
import {
currencies,
mailingAddress,
makeCustomFieldsFixedCollection,
makeGetAllFields,
otherAddress,
} from './SharedFields';
export const contactOperations: INodeProperties[] = [
{
displayName: 'Operation',
name: 'operation',
type: 'options',
noDataExpression: true,
displayOptions: {
show: {
resource: ['contact'],
},
},
options: [
{
name: 'Create',
value: 'create',
description: 'Create a contact',
action: 'Create a contact',
},
{
name: 'Create or Update',
value: 'upsert',
description: 'Create a new record, or update the current one if it already exists (upsert)',
action: 'Create or Update a contact',
},
{
name: 'Delete',
value: 'delete',
description: 'Delete a contact',
action: 'Delete a contact',
},
{
name: 'Get',
value: 'get',
description: 'Get a contact',
action: 'Get a contact',
},
{
name: 'Get Many',
value: 'getAll',
description: 'Get many contacts',
action: 'Get many contacts',
},
{
name: 'Update',
value: 'update',
description: 'Update a contact',
action: 'Update a contact',
},
],
default: 'create',
},
];
export const contactFields: INodeProperties[] = [
// ----------------------------------------
// contact: create
// ----------------------------------------
{
displayName: 'Last Name',
name: 'lastName',
type: 'string',
required: true,
default: '',
displayOptions: {
show: {
resource: ['contact'],
operation: ['create'],
},
},
},
{
displayName: 'Additional Fields',
name: 'additionalFields',
type: 'collection',
placeholder: 'Add Field',
default: {},
displayOptions: {
show: {
resource: ['contact'],
operation: ['create'],
},
},
options: [
{
displayName: 'Assistant',
name: 'Assistant',
type: 'string',
default: '',
description: 'Name of the contacts assistant',
},
makeCustomFieldsFixedCollection('contact'),
{
displayName: 'Date of Birth',
name: 'Date_of_Birth',
type: 'dateTime',
default: '',
},
{
displayName: 'Department',
name: 'Department',
type: 'string',
default: '',
description: 'Company department to which the contact belongs',
},
{
displayName: 'Description',
name: 'Description',
type: 'string',
default: '',
},
{
displayName: 'Email (Primary)',
name: 'Email',
type: 'string',
default: '',
},
{
displayName: 'Email (Secondary)',
name: 'Secondary_Email',
type: 'string',
default: '',
},
{
displayName: 'Fax',
name: 'Fax',
type: 'string',
default: '',
},
{
displayName: 'First Name',
name: 'First_Name',
type: 'string',
default: '',
},
{
displayName: 'Full Name',
name: 'Full_Name',
type: 'string',
default: '',
},
mailingAddress,
{
displayName: 'Mobile',
name: 'Mobile',
type: 'string',
default: '',
},
otherAddress,
{
displayName: 'Phone',
name: 'Phone',
type: 'string',
default: '',
},
{
displayName: 'Phone (Assistant)',
name: 'Asst_Phone',
type: 'string',
default: '',
description: 'Phone number of the contacts assistant',
},
{
displayName: 'Phone (Home)',
name: 'Home_Phone',
type: 'string',
default: '',
},
{
displayName: 'Phone (Other)',
name: 'Other_Phone',
type: 'string',
default: '',
},
{
displayName: 'Salutation',
name: 'Salutation',
type: 'string',
default: '',
},
{
displayName: 'Skype ID',
name: 'Skype_ID',
type: 'string',
default: '',
},
{
displayName: 'Title',
name: 'Title',
type: 'string',
default: '',
description: 'Position of the contact at their company',
},
{
displayName: 'Twitter',
name: 'Twitter',
type: 'string',
default: '',
},
],
},
// ----------------------------------------
// contact: upsert
// ----------------------------------------
{
displayName: 'Last Name',
name: 'lastName',
type: 'string',
required: true,
default: '',
displayOptions: {
show: {
resource: ['contact'],
operation: ['upsert'],
},
},
},
{
displayName: 'Additional Fields',
name: 'additionalFields',
type: 'collection',
placeholder: 'Add Field',
default: {},
displayOptions: {
show: {
resource: ['contact'],
operation: ['upsert'],
},
},
options: [
{
displayName: 'Assistant',
name: 'Assistant',
type: 'string',
default: '',
description: 'Name of the contacts assistant',
},
makeCustomFieldsFixedCollection('contact'),
{
displayName: 'Date of Birth',
name: 'Date_of_Birth',
type: 'dateTime',
default: '',
},
{
displayName: 'Department',
name: 'Department',
type: 'string',
default: '',
description: 'Company department to which the contact belongs',
},
{
displayName: 'Description',
name: 'Description',
type: 'string',
default: '',
},
{
displayName: 'Email (Primary)',
name: 'Email',
type: 'string',
default: '',
description:
'Email of the contact. If a record with this email exists it will be updated, otherwise a new one will be created.',
},
{
displayName: 'Email (Secondary)',
name: 'Secondary_Email',
type: 'string',
default: '',
},
{
displayName: 'Fax',
name: 'Fax',
type: 'string',
default: '',
},
{
displayName: 'First Name',
name: 'First_Name',
type: 'string',
default: '',
},
{
displayName: 'Full Name',
name: 'Full_Name',
type: 'string',
default: '',
},
mailingAddress,
{
displayName: 'Mobile',
name: 'Mobile',
type: 'string',
default: '',
},
otherAddress,
{
displayName: 'Phone',
name: 'Phone',
type: 'string',
default: '',
},
{
displayName: 'Phone (Assistant)',
name: 'Asst_Phone',
type: 'string',
default: '',
description: 'Phone number of the contacts assistant',
},
{
displayName: 'Phone (Home)',
name: 'Home_Phone',
type: 'string',
default: '',
},
{
displayName: 'Phone (Other)',
name: 'Other_Phone',
type: 'string',
default: '',
},
{
displayName: 'Salutation',
name: 'Salutation',
type: 'string',
default: '',
},
{
displayName: 'Skype ID',
name: 'Skype_ID',
type: 'string',
default: '',
},
{
displayName: 'Title',
name: 'Title',
type: 'string',
default: '',
description: 'Position of the contact at their company',
},
{
displayName: 'Twitter',
name: 'Twitter',
type: 'string',
default: '',
},
],
},
// ----------------------------------------
// contact: delete
// ----------------------------------------
{
displayName: 'Contact ID',
name: 'contactId',
description: 'ID of the contact to delete',
type: 'string',
required: true,
default: '',
displayOptions: {
show: {
resource: ['contact'],
operation: ['delete'],
},
},
},
// ----------------------------------------
// contact: get
// ----------------------------------------
{
displayName: 'Contact ID',
name: 'contactId',
description: 'ID of the contact to retrieve',
type: 'string',
required: true,
default: '',
displayOptions: {
show: {
resource: ['contact'],
operation: ['get'],
},
},
},
// ----------------------------------------
// contact: getAll
// ----------------------------------------
...makeGetAllFields('contact'),
// ----------------------------------------
// contact: update
// ----------------------------------------
{
displayName: 'Contact ID',
name: 'contactId',
description: 'ID of the contact to update',
type: 'string',
required: true,
default: '',
displayOptions: {
show: {
resource: ['contact'],
operation: ['update'],
},
},
},
{
displayName: 'Update Fields',
name: 'updateFields',
type: 'collection',
placeholder: 'Add Field',
default: {},
displayOptions: {
show: {
resource: ['contact'],
operation: ['update'],
},
},
options: [
{
displayName: 'Assistant',
name: 'Assistant',
type: 'string',
default: '',
},
{
displayName: 'Assistants Phone',
name: 'Asst_Phone',
type: 'string',
default: '',
description: 'Phone number of the contacts assistant',
},
{
displayName: 'Currency',
name: 'Currency',
type: 'options',
default: 'USD',
description: 'Symbol of the currency in which revenue is generated',
options: currencies,
},
makeCustomFieldsFixedCollection('contact'),
{
displayName: 'Date of Birth',
name: 'Date_of_Birth',
type: 'dateTime',
default: '',
},
{
displayName: 'Department',
name: 'Department',
type: 'string',
default: '',
},
{
displayName: 'Description',
name: 'Description',
type: 'string',
default: '',
},
{
displayName: 'Email (Primary)',
name: 'Email',
type: 'string',
default: '',
},
{
displayName: 'Email (Secondary)',
name: 'Secondary_Email',
type: 'string',
default: '',
},
{
displayName: 'Fax',
name: 'Fax',
type: 'string',
default: '',
},
{
displayName: 'First Name',
name: 'First_Name',
type: 'string',
default: '',
},
{
displayName: 'Full Name',
name: 'Full_Name',
type: 'string',
default: '',
},
{
displayName: 'Home Phone',
name: 'Home_Phone',
type: 'string',
default: '',
},
{
displayName: 'Last Name',
name: 'Last_Name',
type: 'string',
default: '',
},
mailingAddress,
{
displayName: 'Mobile',
name: 'Mobile',
type: 'string',
default: '',
},
otherAddress,
{
displayName: 'Other Phone',
name: 'Other_Phone',
type: 'string',
default: '',
},
{
displayName: 'Phone',
name: 'Phone',
type: 'string',
default: '',
},
{
displayName: 'Salutation',
name: 'Salutation',
type: 'string',
default: '',
},
{
displayName: 'Skype ID',
name: 'Skype_ID',
type: 'string',
default: '',
},
{
displayName: 'Title',
name: 'Title',
type: 'string',
default: '',
description: 'Position of the contact at their company',
},
{
displayName: 'Twitter',
name: 'Twitter',
type: 'string',
default: '',
},
],
},
];