n8n/packages/nodes-base/nodes/Copper/descriptions/CompanyDescription.ts

290 lines
4.9 KiB
TypeScript
Raw Normal View History

import {
INodeProperties,
} from 'n8n-workflow';
import {
isoCountryCodes,
} from '../utils/isoCountryCodes';
import {
addressFixedCollection,
phoneNumbersFixedCollection,
} from '../utils/sharedFields';
export const companyOperations: INodeProperties[] = [
{
displayName: 'Operation',
name: 'operation',
type: 'options',
displayOptions: {
show: {
resource: [
'company',
],
},
},
options: [
{
name: 'Create',
value: 'create',
},
{
name: 'Delete',
value: 'delete',
},
{
name: 'Get',
value: 'get',
},
{
name: 'Get All',
value: 'getAll',
},
{
name: 'Update',
value: 'update',
},
],
default: 'create',
description: 'Operation to perform',
},
];
export const companyFields: INodeProperties[] = [
// ----------------------------------------
// company: create
// ----------------------------------------
{
displayName: 'Name',
name: 'name',
description: 'Name of the company to create.',
type: 'string',
required: true,
default: '',
displayOptions: {
show: {
resource: [
'company',
],
operation: [
'create',
],
},
},
},
{
displayName: 'Additional Fields',
name: 'additionalFields',
type: 'collection',
placeholder: 'Add Field',
default: {},
displayOptions: {
show: {
resource: [
'company',
],
operation: [
'create',
],
},
},
options: [
addressFixedCollection,
{
displayName: 'Details',
name: 'details',
type: 'string',
default: '',
description: 'Description of the company to create.',
},
{
displayName: 'Email Domain',
name: 'email_domain',
type: 'string',
default: '',
},
phoneNumbersFixedCollection,
],
},
// ----------------------------------------
// company: delete
// ----------------------------------------
{
displayName: 'Company ID',
name: 'companyId',
description: 'ID of the company to delete.',
type: 'string',
required: true,
default: '',
displayOptions: {
show: {
resource: [
'company',
],
operation: [
'delete',
],
},
},
},
// ----------------------------------------
// company: get
// ----------------------------------------
{
displayName: 'Company ID',
name: 'companyId',
description: 'ID of the company to retrieve.',
type: 'string',
required: true,
default: '',
displayOptions: {
show: {
resource: [
'company',
],
operation: [
'get',
],
},
},
},
// ----------------------------------------
// company: getAll
// ----------------------------------------
{
displayName: 'Return All',
name: 'returnAll',
type: 'boolean',
default: false,
description: 'Return all results.',
displayOptions: {
show: {
resource: [
'company',
],
operation: [
'getAll',
],
},
},
},
{
displayName: 'Limit',
name: 'limit',
type: 'number',
default: 5,
description: 'The number of results to return.',
typeOptions: {
minValue: 1,
maxValue: 1000,
},
displayOptions: {
show: {
resource: [
'company',
],
operation: [
'getAll',
],
returnAll: [
false,
],
},
},
},
{
displayName: 'Filters',
name: 'filterFields',
type: 'collection',
placeholder: 'Add Filter',
default: {},
displayOptions: {
show: {
resource: [
'company',
],
operation: [
'getAll',
],
},
},
options: [
{
displayName: 'Country',
name: 'country',
type: 'options',
options: isoCountryCodes.map(({ name, alpha2 }) => ({ name, value: alpha2 })),
default: '',
description: 'Country of the company to filter by.',
},
{
displayName: 'Name',
name: 'name',
type: 'string',
default: '',
description: 'Name of the company to filter by.',
},
],
},
// ----------------------------------------
// company: update
// ----------------------------------------
{
displayName: 'Company ID',
name: 'companyId',
description: 'ID of the company to update.',
type: 'string',
required: true,
default: '',
displayOptions: {
show: {
resource: [
'company',
],
operation: [
'update',
],
},
},
},
{
displayName: 'Update Fields',
name: 'updateFields',
type: 'collection',
placeholder: 'Add Field',
default: {},
displayOptions: {
show: {
resource: [
'company',
],
operation: [
'update',
],
},
},
options: [
addressFixedCollection,
{
displayName: 'Details',
name: 'details',
type: 'string',
default: '',
description: 'Description to set for the company.',
},
{
displayName: 'Name',
name: 'name',
type: 'string',
default: '',
description: 'Name to set for the company.',
},
phoneNumbersFixedCollection,
],
},
];