n8n/packages/nodes-base/nodes/Salesforce/CustomObjectDescription.ts
Iván Ovejero 0448feec56
refactor: Apply eslint-plugin-n8n-nodes-base autofixable rules (#3174)
*  Initial setup

* 👕 Update `.eslintignore`

* 👕 Autofix node-param-default-missing (#3173)

* 🔥 Remove duplicate key

* 👕 Add exceptions

* 📦 Update package-lock.json

* 👕 Apply `node-class-description-inputs-wrong-trigger-node` (#3176)

* 👕 Apply `node-class-description-inputs-wrong-regular-node` (#3177)

* 👕 Apply `node-class-description-outputs-wrong` (#3178)

* 👕 Apply `node-execute-block-double-assertion-for-items` (#3179)

* 👕 Apply `node-param-default-wrong-for-collection` (#3180)

* 👕 Apply node-param-default-wrong-for-boolean (#3181)

* Autofixed default missing

* Autofixed booleans, worked well

*  Fix params

*  Undo exempted autofixes

* 📦 Update package-lock.json

* 👕 Apply node-class-description-missing-subtitle (#3182)

*  Fix missing comma

* 👕 Apply `node-param-default-wrong-for-fixed-collection` (#3184)

* 👕 Add exception for `node-class-description-missing-subtitle`

* 👕 Apply `node-param-default-wrong-for-multi-options` (#3185)

* 👕 Apply `node-param-collection-type-unsorted-items` (#3186)

* Missing coma

* 👕 Apply `node-param-default-wrong-for-simplify` (#3187)

* 👕 Apply `node-param-description-comma-separated-hyphen` (#3190)

* 👕 Apply `node-param-description-empty-string` (#3189)

* 👕 Apply `node-param-description-excess-inner-whitespace` (#3191)

* Rule looks good

* Add whitespace rule in eslint config

* :zao: fix

* 👕 Apply `node-param-description-identical-to-display-name` (#3193)

* 👕 Apply `node-param-description-missing-for-ignore-ssl-issues` (#3195)

*  Revert ":zao: fix"

This reverts commit ef8a76f3df.

* 👕 Apply `node-param-description-missing-for-simplify`  (#3196)

* 👕 Apply `node-param-description-missing-final-period` (#3194)

* Rule working as intended

* Add rule to eslint

* 👕 Apply node-param-description-missing-for-return-all (#3197)

*  Restore `lintfix` command

Co-authored-by: agobrech <45268029+agobrech@users.noreply.github.com>
Co-authored-by: Omar Ajoue <krynble@gmail.com>
Co-authored-by: agobrech <ael.gobrecht@gmail.com>
Co-authored-by: Michael Kret <michael.k@radency.com>
2022-04-22 18:29:51 +02:00

579 lines
11 KiB
TypeScript

import {
INodeProperties,
} from 'n8n-workflow';
export const customObjectOperations: INodeProperties[] = [
{
displayName: 'Operation',
name: 'operation',
type: 'options',
displayOptions: {
show: {
resource: [
'customObject',
],
},
},
options: [
{
name: 'Create',
value: 'create',
description: 'Create a custom object record',
},
{
name: 'Create or Update',
value: 'upsert',
description: 'Create a new record, or update the current one if it already exists (upsert)',
},
{
name: 'Get',
value: 'get',
description: 'Get a custom object record',
},
{
name: 'Get All',
value: 'getAll',
description: 'Get all custom object records',
},
{
name: 'Delete',
value: 'delete',
description: 'Delete a custom object record',
},
{
name: 'Update',
value: 'update',
description: 'Update a custom object record',
},
],
default: 'create',
description: 'The operation to perform.',
},
];
export const customObjectFields: INodeProperties[] = [
/* -------------------------------------------------------------------------- */
/* customObject:create */
/* -------------------------------------------------------------------------- */
{
displayName: 'Custom Object',
name: 'customObject',
type: 'options',
typeOptions: {
loadOptionsMethod: 'getCustomObjects',
},
required: true,
default: '',
displayOptions: {
show: {
resource: [
'customObject',
],
operation: [
'create',
'upsert',
],
},
},
description: 'Name of the custom object.',
},
{
displayName: 'Match Against',
name: 'externalId',
type: 'options',
typeOptions: {
loadOptionsMethod: 'getExternalIdFields',
loadOptionsDependsOn: [
'customObject',
],
},
required: true,
default: '',
displayOptions: {
show: {
resource: [
'customObject',
],
operation: [
'upsert',
],
},
},
description: `The field to check to see if the object already exists`,
},
{
displayName: 'Value to Match',
name: 'externalIdValue',
type: 'string',
required: true,
default: '',
displayOptions: {
show: {
resource: [
'customObject',
],
operation: [
'upsert',
],
},
},
description: 'If this value exists in the \'match against\' field, update the object. Otherwise create a new one.',
},
{
displayName: 'Fields',
name: 'customFieldsUi',
placeholder: 'Add Field',
type: 'fixedCollection',
typeOptions: {
multipleValues: true,
},
displayOptions: {
show: {
resource: [
'customObject',
],
operation: [
'create',
'upsert',
],
},
},
description: 'Filter by custom fields.',
default: {},
options: [
{
name: 'customFieldsValues',
displayName: 'Custom Field',
values: [
{
displayName: 'Field ID',
name: 'fieldId',
type: 'options',
typeOptions: {
loadOptionsMethod: 'getCustomObjectFields',
loadOptionsDependsOn: [
'customObject',
],
},
default: '',
description: 'The ID of the field.',
},
{
displayName: 'Value',
name: 'value',
type: 'string',
default: '',
description: 'The value to set on custom field.',
},
],
},
],
},
/* -------------------------------------------------------------------------- */
/* customObject:update */
/* -------------------------------------------------------------------------- */
{
displayName: 'Custom Object',
name: 'customObject',
type: 'options',
typeOptions: {
loadOptionsMethod: 'getCustomObjects',
},
required: true,
default: '',
displayOptions: {
show: {
resource: [
'customObject',
],
operation: [
'update',
],
},
},
description: 'Name of the custom object',
},
{
displayName: 'Record ID',
name: 'recordId',
type: 'string',
required: true,
default: '',
displayOptions: {
show: {
resource: [
'customObject',
],
operation: [
'update',
],
},
},
description: 'Record ID to be updated.',
},
{
displayName: 'Fields',
name: 'customFieldsUi',
placeholder: 'Add Field',
type: 'fixedCollection',
typeOptions: {
multipleValues: true,
},
description: 'Filter by custom fields ',
default: {},
displayOptions: {
show: {
resource: [
'customObject',
],
operation: [
'update',
],
},
},
options: [
{
name: 'customFieldsValues',
displayName: 'Custom Field',
values: [
{
displayName: 'Field ID',
name: 'fieldId',
type: 'options',
typeOptions: {
loadOptionsMethod: 'getCustomObjectFields',
loadOptionsDependsOn: [
'customObject',
],
},
default: '',
description: 'The ID of the field.',
},
{
displayName: 'Value',
name: 'value',
type: 'string',
default: '',
description: 'The value to set on custom field.',
},
],
},
],
},
/* -------------------------------------------------------------------------- */
/* customObject:get */
/* -------------------------------------------------------------------------- */
{
displayName: 'Custom Object',
name: 'customObject',
type: 'options',
typeOptions: {
loadOptionsMethod: 'getCustomObjects',
},
required: true,
default: '',
displayOptions: {
show: {
resource: [
'customObject',
],
operation: [
'get',
],
},
},
description: 'Name of the custom object',
},
{
displayName: 'Record ID',
name: 'recordId',
type: 'string',
required: true,
default: '',
displayOptions: {
show: {
resource: [
'customObject',
],
operation: [
'get',
],
},
},
description: 'Record ID to be retrieved.',
},
/* -------------------------------------------------------------------------- */
/* customObject:delete */
/* -------------------------------------------------------------------------- */
{
displayName: 'Custom Object',
name: 'customObject',
type: 'options',
typeOptions: {
loadOptionsMethod: 'getCustomObjects',
},
required: true,
default: '',
displayOptions: {
show: {
resource: [
'customObject',
],
operation: [
'delete',
],
},
},
description: 'Name of the custom object.',
},
{
displayName: 'Record ID',
name: 'recordId',
type: 'string',
required: true,
default: '',
displayOptions: {
show: {
resource: [
'customObject',
],
operation: [
'delete',
],
},
},
description: 'Record ID to be deleted.',
},
/* -------------------------------------------------------------------------- */
/* customObject:getAll */
/* -------------------------------------------------------------------------- */
{
displayName: 'Custom Object',
name: 'customObject',
type: 'options',
typeOptions: {
loadOptionsMethod: 'getCustomObjects',
},
required: true,
default: '',
displayOptions: {
show: {
resource: [
'customObject',
],
operation: [
'getAll',
],
},
},
description: 'Name of the custom object',
},
{
displayName: 'Return All',
name: 'returnAll',
type: 'boolean',
displayOptions: {
show: {
resource: [
'customObject',
],
operation: [
'getAll',
],
},
},
default: false,
description: 'If all results should be returned or only up to a given limit.',
},
{
displayName: 'Limit',
name: 'limit',
type: 'number',
displayOptions: {
show: {
resource: [
'customObject',
],
operation: [
'getAll',
],
returnAll: [
false,
],
},
},
typeOptions: {
minValue: 1,
maxValue: 100,
},
default: 50,
description: 'How many results to return.',
},
{
displayName: 'Options',
name: 'options',
type: 'collection',
placeholder: 'Add Field',
default: {},
displayOptions: {
show: {
resource: [
'customObject',
],
operation: [
'getAll',
],
},
},
options: [
{
displayName: 'Conditions',
name: 'conditionsUi',
placeholder: 'Add Condition',
type: 'fixedCollection',
typeOptions: {
multipleValues: true,
},
description: 'The condition to set.',
default: {},
options: [
{
name: 'conditionValues',
displayName: 'Condition',
values: [
{
displayName: 'Field',
name: 'field',
type: 'options',
typeOptions: {
loadOptionsMethod: 'getCustomObjectFields',
loadOptionsDependsOn: [
'customObject',
],
},
default: '',
description: 'For date, number, or boolean, please use expressions.',
},
{
displayName: 'Operation',
name: 'operation',
type: 'options',
options: [
{
name: '=',
value: 'equal',
},
{
name: '>',
value: '>',
},
{
name: '<',
value: '<',
},
{
name: '>=',
value: '>=',
},
{
name: '<=',
value: '<=',
},
],
default: 'equal',
},
{
displayName: 'Value',
name: 'value',
type: 'string',
default: '',
},
],
},
],
},
{
displayName: 'Fields',
name: 'fields',
type: 'multiOptions',
typeOptions: {
loadOptionsMethod: 'getCustomObjectFields',
loadOptionsDependsOn: [
'customObject',
],
},
default: [],
description: 'Fields to include separated by ,',
},
],
},
{
displayName: 'Additional Fields',
name: 'additionalFields',
type: 'collection',
displayOptions: {
show: {
operation: [
'create',
'upsert',
],
resource: [
'customObject',
],
},
},
default: {},
placeholder: 'Add Field',
options: [
{
displayName: 'Record Type ID',
name: 'recordTypeId',
type: 'options',
typeOptions: {
loadOptionsMethod: 'getRecordTypes',
loadOptionsDependsOn: [
'customObject',
],
},
default: '',
},
],
},
{
displayName: 'Update Fields',
name: 'updateFields',
type: 'collection',
displayOptions: {
show: {
operation: [
'update',
],
resource: [
'customObject',
],
},
},
default: {},
placeholder: 'Add Field',
options: [
{
displayName: 'Record Type ID',
name: 'recordTypeId',
type: 'options',
typeOptions: {
loadOptionsMethod: 'getRecordTypes',
loadOptionsDependsOn: [
'customObject',
],
},
default: '',
},
],
},
];