n8n/packages/nodes-base/nodes/Magento/CustomerDescription.ts

314 lines
5.3 KiB
TypeScript
Raw Normal View History

import {
INodeProperties,
} from 'n8n-workflow';
import {
getCustomerOptionalFields,
getSearchFilters,
} from './GenericFunctions';
export const customerOperations: INodeProperties[] = [
{
displayName: 'Operation',
name: 'operation',
type: 'options',
displayOptions: {
show: {
resource: [
'customer',
],
},
},
options: [
{
name: 'Create',
value: 'create',
description: 'Create a new customer',
},
{
name: 'Delete',
value: 'delete',
description: 'Delete a customer',
},
{
name: 'Get',
value: 'get',
description: 'Get a customer',
},
{
name: 'Get All',
value: 'getAll',
description: 'Get all customers',
},
{
name: 'Update',
value: 'update',
description: 'Update a customer',
},
],
default: 'create',
description: 'The operation to perform',
},
];
export const customerFields: INodeProperties[] = [
/* -------------------------------------------------------------------------- */
/* customer:create */
/* -------------------------------------------------------------------------- */
{
displayName: 'Email',
name: 'email',
type: 'string',
required: true,
default: '',
displayOptions: {
show: {
resource: [
'customer',
],
operation: [
'create',
],
},
},
description: 'Email address of the user to create',
},
{
displayName: 'First Name',
name: 'firstname',
type: 'string',
required: true,
default: '',
displayOptions: {
show: {
resource: [
'customer',
],
operation: [
'create',
],
},
},
description: 'First name of the user to create',
},
{
displayName: 'Last Name',
name: 'lastname',
type: 'string',
required: true,
default: '',
displayOptions: {
show: {
resource: [
'customer',
],
operation: [
'create',
],
},
},
description: 'Last name of the user to create',
},
{
displayName: 'Additional Fields',
name: 'additionalFields',
type: 'collection',
placeholder: 'Add Field',
default: {},
displayOptions: {
show: {
resource: [
'customer',
],
operation: [
'create',
],
},
},
options: [
...getCustomerOptionalFields(),
],
},
/* -------------------------------------------------------------------------- */
/* customer:update */
/* -------------------------------------------------------------------------- */
{
displayName: 'Customer ID',
name: 'customerId',
type: 'string',
default: '',
displayOptions: {
show: {
resource: [
'customer',
],
operation: [
'update',
],
},
},
description: 'ID of the customer to update',
},
{
displayName: 'Email',
name: 'email',
type: 'string',
default: '',
displayOptions: {
show: {
resource: [
'customer',
],
operation: [
'update',
],
},
},
},
{
displayName: 'First Name',
name: 'firstName',
type: 'string',
default: '',
displayOptions: {
show: {
resource: [
'customer',
],
operation: [
'update',
],
},
},
},
{
displayName: 'Last Name',
name: 'lastName',
type: 'string',
default: '',
displayOptions: {
show: {
resource: [
'customer',
],
operation: [
'update',
],
},
},
},
{
displayName: 'Website Name/ID',
name: 'website_id',
type: 'options',
displayOptions: {
show: {
resource: [
'customer',
],
operation: [
'update',
],
},
},
typeOptions: {
loadOptionsMethod: 'getWebsites',
},
default: '',
},
{
displayName: 'Update Fields',
name: 'updateFields',
type: 'collection',
placeholder: 'Add Field',
default: {},
displayOptions: {
show: {
resource: [
'customer',
],
operation: [
'update',
],
},
},
options: [
...getCustomerOptionalFields(),
],
},
/* -------------------------------------------------------------------------- */
/* customer:delete */
/* -------------------------------------------------------------------------- */
{
displayName: 'Customer ID',
name: 'customerId',
type: 'string',
required: true,
default: '',
displayOptions: {
show: {
resource: [
'customer',
],
operation: [
'delete',
'get',
],
},
},
},
/* -------------------------------------------------------------------------- */
/* customer:getAll */
/* -------------------------------------------------------------------------- */
{
displayName: 'Return All',
name: 'returnAll',
type: 'boolean',
displayOptions: {
show: {
resource: [
'customer',
],
operation: [
'getAll',
],
},
},
default: false,
description: 'Whether all results should be returned or only up to a given limit',
},
{
displayName: 'Limit',
name: 'limit',
type: 'number',
displayOptions: {
show: {
resource: [
'customer',
],
operation: [
'getAll',
],
returnAll: [
false,
],
},
},
typeOptions: {
minValue: 1,
maxValue: 10,
},
default: 5,
description: 'How many results to return',
},
...getSearchFilters(
'customer',
'getSystemAttributes',
'getSystemAttributes',
),
];