n8n/packages/nodes-base/nodes/Onfleet/descriptions/DestinationDescription.ts
Ricardo Espinoza 401e626a64
Add Onfleet Node & Trigger (#2845)
* feat: added Onfleet nodes

Added Onfleet nodes for working with different endpoints like:
organizations, administrators, workers, hubs, teams, destinations, recipients,
containers and webhooks.

* style: fixed typos, arrays uniformity, unnecesary files

* refactor: changed add to create in comments and labels

* feat: added name field to onfleet trigger node

* feat: added team endpoints to onfleet node

Added team auto-dispatch and driver time estimate endpoints to Onfleet
node

* style: remove dots in descriptions and fixed some typos

* feat: added fixes according to comments made on the n8n PR

added new fixed collections, refactored the code according to comments
made on the n8n pr

* fix: fixed recipient and destination cretion

* docs: added docstrings for format some functions

added docstrings for new functions addded for formatting the destination
and recipient objects

* style: formatting the code according to n8n nodelinter

* fix: typos and better descriptions

* [INT-510] n8n: Address additional problems from n8n code review (#5)

* Fixed some error creating a worker, moving some fields under additional fields collection

* Fixed returned values for delete operations, making some changes for style code

* Added operational error since required property is not working for dateTime fields

*  Improvements to #2593

*  Improvements

* 🐛 Fix issue with wrong interface

*  Improvements

*  Improvements

*  Minor improvement

Co-authored-by: Santiago Botero Ruiz <santiago.botero@devsavant.ai>
Co-authored-by: ilsemaj <james.li.upenn@gmail.com>
Co-authored-by: Santiago Botero Ruiz <39206812+YokySantiago@users.noreply.github.com>
Co-authored-by: Jan Oberhauser <jan.oberhauser@gmail.com>
2022-02-28 09:48:17 +01:00

403 lines
6.6 KiB
TypeScript

import {
INodeProperties
} from 'n8n-workflow';
export const destinationOperations: INodeProperties[] = [
{
displayName: 'Operation',
name: 'operation',
type: 'options',
displayOptions: {
show: {
resource: [
'destination',
],
},
},
options: [
{
name: 'Create',
value: 'create',
description: 'Create a new destination',
},
{
name: 'Get',
value: 'get',
description: 'Get a specific destination',
},
],
default: 'get',
},
];
const unparsedField = {
displayName: 'Unparsed Address',
name: 'unparsed',
type: 'boolean',
description: 'Whether or not the address is specified in a single unparsed string',
default: false,
} as INodeProperties;
const unparsedAddressField = {
displayName: 'Destination Address',
name: 'address',
type: 'string',
description: 'The destination\'s street address details',
default: '',
} as INodeProperties;
const unparsedAddressNumberField = {
displayName: 'Number',
name: 'addressNumber',
type: 'string',
description: 'The number component of this address, it may also contain letters',
default: '',
} as INodeProperties;
const unparsedAddressStreetField = {
displayName: 'Street',
name: 'addressStreet',
type: 'string',
description: 'The name of the street',
default: '',
} as INodeProperties;
const unparsedAddressCityField = {
displayName: 'City',
name: 'addressCity',
type: 'string',
description: 'The name of the municipality',
default: '',
} as INodeProperties;
const unparsedAddressCountryField = {
displayName: 'Country',
name: 'addressCountry',
type: 'string',
description: 'The name of the country',
default: '',
} as INodeProperties;
const unparsedAddressStateField = {
displayName: 'State',
name: 'addressState',
type: 'string',
default: '',
} as INodeProperties;
const addressNameField = {
displayName: 'Address Name',
name: 'addressName',
type: 'string',
default: '',
description: 'A name associated with this address',
} as INodeProperties;
const addressApartmentField = {
displayName: 'Apartment',
name: 'addressApartment',
type: 'string',
default: '',
description: 'The suite or apartment number, or any additional relevant information',
} as INodeProperties;
const addressNoteField = {
displayName: 'Address Notes',
name: 'addressNotes',
type: 'string',
default: '',
description: 'Notes about the destination',
} as INodeProperties;
const addressPostalCodeField = {
displayName: 'Postal Code',
name: 'addressPostalCode',
type: 'string',
default: '',
description: 'The postal or zip code',
} as INodeProperties;
export const destinationExternalField = {
displayName: 'Destination',
name: 'destination',
type: 'fixedCollection',
placeholder: 'Add Destination',
default: {},
options: [
{
displayName: 'Destination Properties',
name: 'destinationProperties',
default: {},
values: [
{
...unparsedField,
required: false,
},
{
...unparsedAddressField,
displayOptions: {
show: {
unparsed: [
true,
],
},
},
required: true,
},
{
...unparsedAddressNumberField,
displayOptions: {
show: {
unparsed: [
false,
],
},
},
required: true,
},
{
...unparsedAddressStreetField,
displayOptions: {
show: {
unparsed: [
false,
],
},
},
required: true,
},
{
...unparsedAddressCityField,
displayOptions: {
show: {
unparsed: [
false,
],
},
},
required: true,
},
{
...unparsedAddressStateField,
displayOptions: {
show: {
unparsed: [
false,
],
},
},
required: true,
},
{
...unparsedAddressCountryField,
displayOptions: {
show: {
unparsed: [
false,
],
},
},
required: true,
},
{
displayOptions: {
show: {
unparsed: [
false,
],
},
},
...addressPostalCodeField,
required: false,
},
{
...addressNameField,
required: false,
},
{
...addressApartmentField,
required: false,
},
{
...addressNoteField,
required: false,
},
],
},
],
} as INodeProperties;
export const destinationFields: INodeProperties[] = [
{
displayName: 'Destination ID',
name: 'id',
type: 'string',
displayOptions: {
show: {
resource: [
'destination',
],
},
hide: {
operation: [
'create',
],
},
},
default: '',
required: true,
description: 'The ID of the destination object for lookup',
},
{
...unparsedField,
displayOptions: {
show: {
resource: [
'destination',
],
operation: [
'create',
],
},
},
required: true,
},
{
...unparsedAddressField,
displayOptions: {
show: {
resource: [
'destination',
],
operation: [
'create',
],
unparsed: [
true,
],
},
},
required: true,
},
{
...unparsedAddressNumberField,
displayOptions: {
show: {
resource: [
'destination',
],
operation: [
'create',
],
unparsed: [
false,
],
},
},
required: true,
},
{
...unparsedAddressStreetField,
displayOptions: {
show: {
resource: [
'destination',
],
operation: [
'create',
],
unparsed: [
false,
],
},
},
required: true,
},
{
...unparsedAddressCityField,
displayOptions: {
show: {
resource: [
'destination',
],
operation: [
'create',
],
unparsed: [
false,
],
},
},
required: true,
},
{
...unparsedAddressCountryField,
displayOptions: {
show: {
resource: [
'destination',
],
operation: [
'create',
],
unparsed: [
false,
],
},
},
required: true,
},
{
displayName: 'Additional Fields',
name: 'additionalFields',
type: 'collection',
placeholder: 'Add Field',
default: {},
displayOptions: {
show: {
resource: [
'destination',
],
operation: [
'create',
],
unparsed: [
true,
],
},
},
options: [
addressApartmentField,
addressNameField,
addressNoteField,
],
},
{
displayName: 'Additional Fields',
name: 'additionalFields',
type: 'collection',
placeholder: 'Add Field',
default: {},
displayOptions: {
show: {
resource: [
'destination',
],
operation: [
'create',
],
unparsed: [
false,
],
},
},
options: [
addressApartmentField,
addressNameField,
addressNoteField,
addressPostalCodeField,
],
},
];