mirror of
https://github.com/n8n-io/n8n.git
synced 2024-12-30 15:07:28 -08:00
b03e358a12
* 👕 Enable `consistent-type-imports` for nodes-base
* 👕 Apply to nodes-base
* ⏪ Undo unrelated changes
* 🚚 Move to `.eslintrc.js` in nodes-base
* ⏪ Revert "Enable `consistent-type-imports` for nodes-base"
This reverts commit 529ad72b05.
* 👕 Fix severity
853 lines
17 KiB
TypeScript
853 lines
17 KiB
TypeScript
import type { INodeProperties } from 'n8n-workflow';
|
|
|
|
export const companyOperations: INodeProperties[] = [
|
|
{
|
|
displayName: 'Operation',
|
|
name: 'operation',
|
|
type: 'options',
|
|
noDataExpression: true,
|
|
displayOptions: {
|
|
show: {
|
|
resource: ['company'],
|
|
},
|
|
},
|
|
options: [
|
|
{
|
|
name: 'Create',
|
|
value: 'create',
|
|
description: 'Create a new company',
|
|
action: 'Create a company',
|
|
},
|
|
{
|
|
name: 'Delete',
|
|
value: 'delete',
|
|
description: 'Delete a company',
|
|
action: 'Delete a company',
|
|
},
|
|
{
|
|
name: 'Get',
|
|
value: 'get',
|
|
description: 'Get a company',
|
|
action: 'Get a company',
|
|
},
|
|
{
|
|
name: 'Get Many',
|
|
value: 'getAll',
|
|
description: 'Get many companies',
|
|
action: 'Get many companies',
|
|
},
|
|
{
|
|
name: 'Update',
|
|
value: 'update',
|
|
description: 'Update company properties',
|
|
action: 'Update a company',
|
|
},
|
|
],
|
|
default: 'get',
|
|
},
|
|
];
|
|
|
|
export const companyFields: INodeProperties[] = [
|
|
/* -------------------------------------------------------------------------- */
|
|
/* company:get */
|
|
/* -------------------------------------------------------------------------- */
|
|
{
|
|
displayName: 'Company ID',
|
|
name: 'companyId',
|
|
type: 'string',
|
|
required: true,
|
|
displayOptions: {
|
|
show: {
|
|
resource: ['company'],
|
|
operation: ['get'],
|
|
},
|
|
},
|
|
default: '',
|
|
description: 'Unique identifier for a particular company',
|
|
},
|
|
|
|
/* -------------------------------------------------------------------------- */
|
|
/* company:get all */
|
|
/* -------------------------------------------------------------------------- */
|
|
{
|
|
displayName: 'Return All',
|
|
name: 'returnAll',
|
|
type: 'boolean',
|
|
displayOptions: {
|
|
show: {
|
|
resource: ['company'],
|
|
operation: ['getAll'],
|
|
},
|
|
},
|
|
default: false,
|
|
description: 'Whether to return all results or only up to a given limit',
|
|
},
|
|
{
|
|
displayName: 'Limit',
|
|
name: 'limit',
|
|
type: 'number',
|
|
typeOptions: {
|
|
minValue: 1,
|
|
},
|
|
displayOptions: {
|
|
show: {
|
|
resource: ['company'],
|
|
operation: ['getAll'],
|
|
returnAll: [false],
|
|
},
|
|
},
|
|
default: 20,
|
|
description: 'Max number of results to return',
|
|
},
|
|
|
|
{
|
|
displayName: 'Filter',
|
|
name: 'filterType',
|
|
type: 'options',
|
|
options: [
|
|
{
|
|
name: 'None',
|
|
value: 'none',
|
|
},
|
|
{
|
|
name: 'Build Manually',
|
|
value: 'manual',
|
|
},
|
|
{
|
|
name: 'JSON',
|
|
value: 'json',
|
|
},
|
|
],
|
|
displayOptions: {
|
|
show: {
|
|
resource: ['company'],
|
|
operation: ['getAll'],
|
|
},
|
|
},
|
|
default: 'none',
|
|
},
|
|
{
|
|
displayName: 'Must Match',
|
|
name: 'matchType',
|
|
type: 'options',
|
|
options: [
|
|
{
|
|
name: 'Any Filter',
|
|
value: 'anyFilter',
|
|
},
|
|
{
|
|
name: 'All Filters',
|
|
value: 'allFilters',
|
|
},
|
|
],
|
|
displayOptions: {
|
|
show: {
|
|
resource: ['company'],
|
|
operation: ['getAll'],
|
|
filterType: ['manual'],
|
|
},
|
|
},
|
|
default: 'anyFilter',
|
|
},
|
|
{
|
|
displayName: 'Simplify',
|
|
name: 'simple',
|
|
type: 'boolean',
|
|
displayOptions: {
|
|
show: {
|
|
resource: ['company'],
|
|
operation: ['getAll'],
|
|
},
|
|
},
|
|
// eslint-disable-next-line n8n-nodes-base/node-param-default-wrong-for-simplify
|
|
default: false,
|
|
description: 'Whether to return a simplified version of the response instead of the raw data',
|
|
},
|
|
{
|
|
displayName: 'Filters',
|
|
name: 'filters',
|
|
type: 'fixedCollection',
|
|
typeOptions: {
|
|
multipleValues: true,
|
|
},
|
|
displayOptions: {
|
|
show: {
|
|
resource: ['company'],
|
|
operation: ['getAll'],
|
|
filterType: ['manual'],
|
|
},
|
|
},
|
|
default: {},
|
|
placeholder: 'Add Condition',
|
|
options: [
|
|
{
|
|
displayName: 'Conditions',
|
|
name: 'conditions',
|
|
values: [
|
|
{
|
|
displayName: 'Field',
|
|
name: 'field',
|
|
type: 'string',
|
|
default: '',
|
|
description: 'Any searchable field',
|
|
},
|
|
{
|
|
displayName: 'Condition Type',
|
|
name: 'condition_type',
|
|
type: 'options',
|
|
options: [
|
|
{
|
|
name: 'After',
|
|
value: 'AFTER',
|
|
},
|
|
{
|
|
name: 'Before',
|
|
value: 'BEFORE',
|
|
},
|
|
{
|
|
name: 'Between',
|
|
value: 'BETWEEN',
|
|
},
|
|
{
|
|
name: 'Equals',
|
|
value: 'EQUALS',
|
|
},
|
|
{
|
|
name: 'Last',
|
|
value: 'LAST',
|
|
},
|
|
{
|
|
name: 'Not Equal',
|
|
value: 'NOTEQUALS',
|
|
},
|
|
{
|
|
name: 'On',
|
|
value: 'ON',
|
|
},
|
|
],
|
|
default: 'EQUALS',
|
|
},
|
|
{
|
|
displayName: 'Value',
|
|
name: 'value',
|
|
type: 'string',
|
|
default: '',
|
|
},
|
|
{
|
|
displayName: 'Value 2',
|
|
name: 'value2',
|
|
type: 'string',
|
|
displayOptions: {
|
|
show: {
|
|
condition_type: ['BETWEEN'],
|
|
},
|
|
},
|
|
default: '',
|
|
},
|
|
],
|
|
},
|
|
],
|
|
},
|
|
{
|
|
displayName:
|
|
'See <a href="https://github.com/agilecrm/rest-api#121-get-contacts-by-dynamic-filter" target="_blank">Agile CRM guide</a> to creating filters',
|
|
name: 'jsonNotice',
|
|
type: 'notice',
|
|
displayOptions: {
|
|
show: {
|
|
resource: ['company'],
|
|
operation: ['getAll'],
|
|
filterType: ['json'],
|
|
},
|
|
},
|
|
default: '',
|
|
},
|
|
{
|
|
displayName: 'Filters (JSON)',
|
|
name: 'filterJson',
|
|
type: 'string',
|
|
displayOptions: {
|
|
show: {
|
|
resource: ['company'],
|
|
operation: ['getAll'],
|
|
filterType: ['json'],
|
|
},
|
|
},
|
|
default: '',
|
|
},
|
|
{
|
|
displayName: 'Options',
|
|
name: 'options',
|
|
type: 'collection',
|
|
placeholder: 'Add Option',
|
|
default: {},
|
|
displayOptions: {
|
|
show: {
|
|
resource: ['company'],
|
|
operation: ['getAll'],
|
|
},
|
|
},
|
|
options: [
|
|
{
|
|
displayName: 'Sort',
|
|
name: 'sort',
|
|
type: 'fixedCollection',
|
|
placeholder: 'Add Sort',
|
|
default: [],
|
|
options: [
|
|
{
|
|
displayName: 'Sort',
|
|
name: 'sort',
|
|
values: [
|
|
{
|
|
displayName: 'Direction',
|
|
name: 'direction',
|
|
type: 'options',
|
|
options: [
|
|
{
|
|
name: 'Ascending',
|
|
value: 'ASC',
|
|
},
|
|
{
|
|
name: 'Descending',
|
|
value: 'DESC',
|
|
},
|
|
],
|
|
default: 'ASC',
|
|
description: 'The sorting direction',
|
|
},
|
|
{
|
|
displayName: 'Field',
|
|
name: 'field',
|
|
type: 'string',
|
|
default: '',
|
|
description: 'The sorting field',
|
|
},
|
|
],
|
|
},
|
|
],
|
|
},
|
|
],
|
|
},
|
|
|
|
/* -------------------------------------------------------------------------- */
|
|
/* company:create */
|
|
/* -------------------------------------------------------------------------- */
|
|
{
|
|
displayName: 'JSON Parameters',
|
|
name: 'jsonParameters',
|
|
type: 'boolean',
|
|
default: false,
|
|
displayOptions: {
|
|
show: {
|
|
resource: ['company'],
|
|
operation: ['create'],
|
|
},
|
|
},
|
|
},
|
|
{
|
|
displayName: 'Additional Fields',
|
|
name: 'additionalFieldsJson',
|
|
type: 'json',
|
|
typeOptions: {
|
|
alwaysOpenEditWindow: true,
|
|
},
|
|
default: '',
|
|
displayOptions: {
|
|
show: {
|
|
resource: ['company'],
|
|
operation: ['create'],
|
|
jsonParameters: [true],
|
|
},
|
|
},
|
|
description:
|
|
'Object of values to set as described <a href="https://github.com/agilecrm/rest-api#1-companys---companies-api">here</a>',
|
|
},
|
|
{
|
|
displayName: 'Additional Fields',
|
|
name: 'additionalFields',
|
|
type: 'collection',
|
|
placeholder: 'Add Field',
|
|
default: {},
|
|
displayOptions: {
|
|
show: {
|
|
resource: ['company'],
|
|
operation: ['create'],
|
|
jsonParameters: [false],
|
|
},
|
|
},
|
|
options: [
|
|
{
|
|
displayName: 'Address',
|
|
name: 'email',
|
|
type: 'string',
|
|
placeholder: 'name@email.com',
|
|
default: '',
|
|
description: 'Company address',
|
|
},
|
|
{
|
|
displayName: 'Email',
|
|
name: 'email',
|
|
type: 'string',
|
|
placeholder: 'name@email.com',
|
|
default: '',
|
|
description: 'Company email',
|
|
},
|
|
{
|
|
displayName: 'Name',
|
|
name: 'name',
|
|
type: 'string',
|
|
default: '',
|
|
description: 'Company name',
|
|
},
|
|
{
|
|
displayName: 'Phone',
|
|
name: 'phone',
|
|
type: 'string',
|
|
default: '',
|
|
description: 'Company phone',
|
|
},
|
|
{
|
|
displayName: 'Star Value',
|
|
name: 'starValue',
|
|
type: 'options',
|
|
default: '',
|
|
description: 'Rating of company (Max value 5). This is not applicable for companies.',
|
|
options: [
|
|
{
|
|
name: '0',
|
|
value: 0,
|
|
},
|
|
{
|
|
name: '1',
|
|
value: 1,
|
|
},
|
|
{
|
|
name: '2',
|
|
value: 2,
|
|
},
|
|
{
|
|
name: '3',
|
|
value: 3,
|
|
},
|
|
{
|
|
name: '4',
|
|
value: 4,
|
|
},
|
|
{
|
|
name: '5',
|
|
value: 5,
|
|
},
|
|
],
|
|
},
|
|
{
|
|
displayName: 'Tags',
|
|
name: 'tags',
|
|
type: 'string',
|
|
typeOptions: {
|
|
multipleValues: true,
|
|
multipleValueButtonText: 'Add Tag',
|
|
},
|
|
default: [],
|
|
description:
|
|
'Unique identifiers added to company, for easy management of companys. This is not applicable for companies.',
|
|
},
|
|
{
|
|
displayName: 'Website',
|
|
name: 'websiteOptions',
|
|
type: 'fixedCollection',
|
|
description: 'Companies websites',
|
|
default: {},
|
|
typeOptions: {
|
|
multipleValues: true,
|
|
},
|
|
options: [
|
|
{
|
|
displayName: 'Website Properties.',
|
|
name: 'websiteProperties',
|
|
values: [
|
|
{
|
|
displayName: 'Type',
|
|
name: 'subtype',
|
|
type: 'options',
|
|
required: true,
|
|
default: '',
|
|
description: 'Type of website',
|
|
options: [
|
|
{
|
|
name: 'Facebook',
|
|
value: 'facebook',
|
|
},
|
|
{
|
|
name: 'Feed',
|
|
value: 'feed',
|
|
},
|
|
{
|
|
name: 'Flickr',
|
|
value: 'flickr',
|
|
},
|
|
{
|
|
name: 'Github',
|
|
value: 'github',
|
|
},
|
|
{
|
|
name: 'Google Plus',
|
|
value: 'googlePlus',
|
|
},
|
|
{
|
|
name: 'LinkedIn',
|
|
value: 'linkedin',
|
|
},
|
|
{
|
|
name: 'Skype',
|
|
value: 'skype',
|
|
},
|
|
{
|
|
name: 'Twitter',
|
|
value: 'twitter',
|
|
},
|
|
{
|
|
name: 'URL',
|
|
value: 'url',
|
|
},
|
|
{
|
|
name: 'Xing',
|
|
value: 'xing',
|
|
},
|
|
{
|
|
name: 'YouTube',
|
|
value: 'youtube',
|
|
},
|
|
],
|
|
},
|
|
{
|
|
displayName: 'URL',
|
|
name: 'url',
|
|
type: 'string',
|
|
required: true,
|
|
default: '',
|
|
description: 'Website URL',
|
|
},
|
|
],
|
|
},
|
|
],
|
|
},
|
|
{
|
|
displayName: 'Custom Properties',
|
|
name: 'customProperties',
|
|
type: 'fixedCollection',
|
|
default: {},
|
|
typeOptions: {
|
|
multipleValues: true,
|
|
},
|
|
options: [
|
|
{
|
|
displayName: 'Property',
|
|
name: 'customProperty',
|
|
values: [
|
|
{
|
|
displayName: 'Name',
|
|
name: 'name',
|
|
type: 'string',
|
|
required: true,
|
|
default: '',
|
|
description: 'Property name',
|
|
},
|
|
{
|
|
displayName: 'Sub Type',
|
|
name: 'subtype',
|
|
type: 'string',
|
|
default: '',
|
|
description: 'Property sub type',
|
|
},
|
|
{
|
|
displayName: 'Value',
|
|
name: 'value',
|
|
type: 'string',
|
|
default: '',
|
|
description: 'Property value',
|
|
},
|
|
],
|
|
},
|
|
],
|
|
},
|
|
],
|
|
},
|
|
|
|
/* -------------------------------------------------------------------------- */
|
|
/* company:delete */
|
|
/* -------------------------------------------------------------------------- */
|
|
{
|
|
displayName: 'Company ID',
|
|
name: 'companyId',
|
|
type: 'string',
|
|
required: true,
|
|
displayOptions: {
|
|
show: {
|
|
resource: ['company'],
|
|
operation: ['delete'],
|
|
},
|
|
},
|
|
default: '',
|
|
description: 'ID of company to delete',
|
|
},
|
|
|
|
/* -------------------------------------------------------------------------- */
|
|
/* company:update */
|
|
/* -------------------------------------------------------------------------- */
|
|
{
|
|
displayName: 'Company ID',
|
|
name: 'companyId',
|
|
type: 'string',
|
|
required: true,
|
|
displayOptions: {
|
|
show: {
|
|
resource: ['company'],
|
|
operation: ['update'],
|
|
},
|
|
},
|
|
default: '',
|
|
description: 'Unique identifier for a particular company',
|
|
},
|
|
{
|
|
displayName: 'JSON Parameters',
|
|
name: 'jsonParameters',
|
|
type: 'boolean',
|
|
default: false,
|
|
displayOptions: {
|
|
show: {
|
|
resource: ['company'],
|
|
operation: ['update'],
|
|
},
|
|
},
|
|
},
|
|
{
|
|
displayName: 'Additional Fields',
|
|
name: 'additionalFieldsJson',
|
|
type: 'json',
|
|
typeOptions: {
|
|
alwaysOpenEditWindow: true,
|
|
},
|
|
default: '',
|
|
displayOptions: {
|
|
show: {
|
|
resource: ['company'],
|
|
operation: ['update'],
|
|
jsonParameters: [true],
|
|
},
|
|
},
|
|
description:
|
|
'Object of values to set as described <a href="https://github.com/agilecrm/rest-api#1-companys---companies-api">here</a>',
|
|
},
|
|
{
|
|
displayName: 'Additional Fields',
|
|
name: 'additionalFields',
|
|
type: 'collection',
|
|
placeholder: 'Add Field',
|
|
default: {},
|
|
displayOptions: {
|
|
show: {
|
|
resource: ['company'],
|
|
operation: ['update'],
|
|
jsonParameters: [false],
|
|
},
|
|
},
|
|
options: [
|
|
{
|
|
displayName: 'Address',
|
|
name: 'email',
|
|
type: 'string',
|
|
placeholder: 'name@email.com',
|
|
default: '',
|
|
description: 'Company address',
|
|
},
|
|
{
|
|
displayName: 'Email',
|
|
name: 'email',
|
|
type: 'string',
|
|
placeholder: 'name@email.com',
|
|
default: '',
|
|
description: 'Company email',
|
|
},
|
|
{
|
|
displayName: 'Star Value',
|
|
name: 'starValue',
|
|
type: 'options',
|
|
default: '',
|
|
description: 'Rating of company (Max value 5). This is not applicable for companies.',
|
|
options: [
|
|
{
|
|
name: '0',
|
|
value: 0,
|
|
},
|
|
{
|
|
name: '1',
|
|
value: 1,
|
|
},
|
|
{
|
|
name: '2',
|
|
value: 2,
|
|
},
|
|
{
|
|
name: '3',
|
|
value: 3,
|
|
},
|
|
{
|
|
name: '4',
|
|
value: 4,
|
|
},
|
|
{
|
|
name: '5',
|
|
value: 5,
|
|
},
|
|
],
|
|
},
|
|
{
|
|
displayName: 'Tags',
|
|
name: 'tags',
|
|
type: 'string',
|
|
typeOptions: {
|
|
multipleValues: true,
|
|
multipleValueButtonText: 'Add Tag',
|
|
},
|
|
default: [],
|
|
description:
|
|
'Unique identifiers added to company, for easy management of companys. This is not applicable for companies.',
|
|
},
|
|
{
|
|
displayName: 'Name',
|
|
name: 'name',
|
|
type: 'string',
|
|
default: '',
|
|
description: 'Company name',
|
|
},
|
|
{
|
|
displayName: 'Phone',
|
|
name: 'phone',
|
|
type: 'string',
|
|
default: '',
|
|
description: 'Company phone',
|
|
},
|
|
{
|
|
displayName: 'Website',
|
|
name: 'websiteOptions',
|
|
type: 'fixedCollection',
|
|
default: {},
|
|
description: 'Companys websites',
|
|
typeOptions: {
|
|
multipleValues: true,
|
|
},
|
|
options: [
|
|
{
|
|
displayName: 'Website Properties.',
|
|
name: 'websiteProperties',
|
|
values: [
|
|
{
|
|
displayName: 'Type',
|
|
name: 'subtype',
|
|
type: 'options',
|
|
required: true,
|
|
default: '',
|
|
description: 'Type of website',
|
|
options: [
|
|
{
|
|
name: 'Facebook',
|
|
value: 'facebook',
|
|
},
|
|
{
|
|
name: 'Feed',
|
|
value: 'feed',
|
|
},
|
|
{
|
|
name: 'Flickr',
|
|
value: 'flickr',
|
|
},
|
|
{
|
|
name: 'Github',
|
|
value: 'github',
|
|
},
|
|
{
|
|
name: 'Google Plus',
|
|
value: 'googlePlus',
|
|
},
|
|
{
|
|
name: 'LinkedIn',
|
|
value: 'linkedin',
|
|
},
|
|
{
|
|
name: 'Skype',
|
|
value: 'skype',
|
|
},
|
|
{
|
|
name: 'Twitter',
|
|
value: 'twitter',
|
|
},
|
|
{
|
|
name: 'URL',
|
|
value: 'url',
|
|
},
|
|
{
|
|
name: 'Xing',
|
|
value: 'xing',
|
|
},
|
|
{
|
|
name: 'YouTube',
|
|
value: 'youtube',
|
|
},
|
|
],
|
|
},
|
|
{
|
|
displayName: 'URL',
|
|
name: 'url',
|
|
type: 'string',
|
|
required: true,
|
|
default: '',
|
|
description: 'Website URL',
|
|
},
|
|
],
|
|
},
|
|
],
|
|
},
|
|
{
|
|
displayName: 'Custom Properties',
|
|
name: 'customProperties',
|
|
type: 'fixedCollection',
|
|
default: {},
|
|
typeOptions: {
|
|
multipleValues: true,
|
|
},
|
|
options: [
|
|
{
|
|
displayName: 'Property',
|
|
name: 'customProperty',
|
|
values: [
|
|
{
|
|
displayName: 'Name',
|
|
name: 'name',
|
|
type: 'string',
|
|
required: true,
|
|
default: '',
|
|
description: 'Property name',
|
|
},
|
|
{
|
|
displayName: 'Sub Type',
|
|
name: 'subtype',
|
|
type: 'string',
|
|
default: '',
|
|
description: 'Property sub type',
|
|
},
|
|
{
|
|
displayName: 'Value',
|
|
name: 'value',
|
|
type: 'string',
|
|
default: '',
|
|
description: 'Property value',
|
|
},
|
|
],
|
|
},
|
|
],
|
|
},
|
|
],
|
|
},
|
|
];
|