n8n/packages/nodes-base/nodes/ERPNext/DocumentDescription.ts

464 lines
8 KiB
TypeScript
Raw Normal View History

import {
INodeProperties,
} from 'n8n-workflow';
export const documentOperations = [
{
displayName: 'Operation',
name: 'operation',
type: 'options',
displayOptions: {
show: {
resource: [
'document',
],
},
},
options: [
{
name: 'Create',
value: 'create',
description: 'Create a document.',
},
{
name: 'Delete',
value: 'delete',
description: 'Delete a document.',
},
{
name: 'Get',
value: 'get',
description: 'Retrieve a document.',
},
{
name: 'Get All',
value: 'getAll',
description: 'Retrieve all documents.',
},
{
name: 'Update',
value: 'update',
description: 'Update a document.',
},
],
default: 'create',
description: 'Operation to perform.',
},
] as INodeProperties[];
export const documentFields = [
// ----------------------------------
// document: getAll
// ----------------------------------
{
displayName: 'DocType',
name: 'docType',
type: 'options',
typeOptions: {
loadOptionsMethod: 'getDocTypes',
},
default: '',
description: 'DocType whose documents to retrieve.',
placeholder: 'Customer',
displayOptions: {
show: {
resource: [
'document',
],
operation: [
'getAll',
],
},
},
},
{
displayName: 'Return All',
name: 'returnAll',
type: 'boolean',
default: false,
description: 'Return all items.',
displayOptions: {
show: {
resource: [
'document',
],
operation: [
'getAll',
],
},
},
},
{
displayName: 'Limit',
name: 'limit',
type: 'number',
default: 10,
description: 'The number of results to return.',
displayOptions: {
show: {
resource: [
'document',
],
operation: [
'getAll',
],
returnAll: [
false,
],
},
},
},
{
displayName: 'Options',
name: 'options',
type: 'collection',
placeholder: 'Add Field',
default: {},
displayOptions: {
show: {
resource: [
'document',
],
operation: [
'getAll',
],
},
},
options: [
{
displayName: 'Fields',
name: 'fields',
type: 'multiOptions',
typeOptions: {
loadOptionsMethod: 'getDocFilters',
loadOptionsDependsOn: [
'docType',
],
},
default: '',
description: 'Comma-separated list of fields to return.',
placeholder: 'name,country',
},
{
displayName: 'Filters',
name: 'filters',
type: 'fixedCollection',
placeholder: 'Add Filter',
description: 'Custom Properties',
typeOptions: {
multipleValues: true,
},
options: [
{
displayName: 'Property',
name: 'customProperty',
values: [
{
displayName: 'Field',
name: 'field',
type: 'options',
typeOptions: {
loadOptionsMethod: 'getDocFields',
loadOptionsDependsOn: [
'docType',
],
},
default: '',
},
{
displayName: 'Operator',
name: 'operator',
type: 'options',
default: 'is',
options: [
{
name: 'IS',
value: 'is',
},
{
name: 'IS NOT',
value: 'isNot',
},
{
name: 'IS GREATER',
value: 'greater',
},
{
name: 'IS LESS',
value: 'less',
},
{
name: 'EQUALS, or GREATER',
value: 'equalsGreater',
},
{
name: 'EQUALS, or LESS',
value: 'equalsLess',
},
],
},
{
displayName: 'Value',
name: 'value',
type: 'string',
default: '',
description: 'Value of the operator condition.',
},
],
},
],
},
],
},
// ----------------------------------
// document: create
// ----------------------------------
{
displayName: 'DocType',
name: 'docType',
type: 'options',
default: '',
typeOptions: {
loadOptionsMethod: 'getDocTypes',
},
required: true,
description: 'DocType you would like to create.',
placeholder: 'Customer',
displayOptions: {
show: {
resource: [
'document',
],
operation: [
'create',
],
},
},
},
{
displayName: 'Properties',
name: 'properties',
type: 'fixedCollection',
placeholder: 'Add Property',
required: true,
default: {},
typeOptions: {
multipleValues: true,
},
displayOptions: {
show: {
resource: [
'document',
],
operation: [
'create',
],
},
},
options: [
{
displayName: 'Property',
name: 'customProperty',
placeholder: 'Add Property',
values: [
{
displayName: 'Field',
name: 'field',
type: 'options',
typeOptions: {
loadOptionsMethod: 'getDocFields',
loadOptionsDependsOn: [
'docType',
],
},
default: [],
},
{
displayName: 'Value',
name: 'value',
type: 'string',
default: '',
},
],
},
],
},
// ----------------------------------
// document: get
// ----------------------------------
{
displayName: 'DocType',
name: 'docType',
type: 'options',
typeOptions: {
loadOptionsMethod: 'getDocTypes',
},
default: '',
description: 'The type of document you would like to get.',
displayOptions: {
show: {
resource: [
'document',
],
operation: [
'get',
],
},
},
required: true,
},
{
displayName: 'Document Name',
name: 'documentName',
type: 'string',
default: '',
description: 'The name (ID) of document you would like to get.',
displayOptions: {
show: {
resource: [
'document',
],
operation: [
'get',
],
},
},
required: true,
},
// ----------------------------------
// document: delete
// ----------------------------------
{
displayName: 'DocType',
name: 'docType',
type: 'options',
typeOptions: {
loadOptionsMethod: 'getDocTypes',
},
default: '',
description: 'The type of document you would like to delete.',
displayOptions: {
show: {
resource: [
'document',
],
operation: [
'delete',
],
},
},
required: true,
},
{
displayName: 'Document Name',
name: 'documentName',
type: 'string',
default: '',
description: 'The name (ID) of document you would like to get.',
displayOptions: {
show: {
resource: [
'document',
],
operation: [
'delete',
],
},
},
required: true,
},
// ----------------------------------
// document: update
// ----------------------------------
{
displayName: 'DocType',
name: 'docType',
type: 'options',
typeOptions: {
loadOptionsMethod: 'getDocTypes',
},
default: '',
description: 'The type of document you would like to update',
displayOptions: {
show: {
resource: [
'document',
],
operation: [
'update',
],
},
},
required: true,
},
{
displayName: 'Document Name',
name: 'documentName',
type: 'string',
default: '',
description: 'The name (ID) of document you would like to get.',
displayOptions: {
show: {
resource: [
'document',
],
operation: [
'update',
],
},
},
required: true,
},
{
displayName: 'Properties',
name: 'properties',
type: 'fixedCollection',
placeholder: 'Add Property',
description: 'Properties of request body.',
default: {},
typeOptions: {
multipleValues: true,
},
displayOptions: {
show: {
resource: [
'document',
],
operation: [
'update',
],
},
},
options: [
{
displayName: 'Property',
name: 'customProperty',
values: [
{
displayName: 'Field',
name: 'field',
type: 'options',
typeOptions: {
loadOptionsMethod: 'getDocFields',
loadOptionsDependsOn: [
'docType',
],
},
default: '',
},
{
displayName: 'Value',
name: 'value',
type: 'string',
default: '',
},
],
},
],
},
] as INodeProperties[];