n8n/packages/nodes-base/nodes/Onfleet/descriptions/AdministratorDescription.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

210 lines
3.3 KiB
TypeScript

import {
INodeProperties
} from 'n8n-workflow';
export const adminOperations: INodeProperties[] = [
{
displayName: 'Operation',
name: 'operation',
type: 'options',
displayOptions: {
show: {
resource: [
'admin',
],
},
},
options: [
{
name: 'Create',
value: 'create',
description: 'Create a new Onfleet admin',
},
{
name: 'Delete',
value: 'delete',
description: 'Delete an Onfleet admin',
},
{
name: 'Get All',
value: 'getAll',
description: 'Get all Onfleet admins',
},
{
name: 'Update',
value: 'update',
description: 'Update an Onfleet admin',
},
],
default: 'getAll',
},
];
const adminNameField = {
displayName: 'Name',
name: 'name',
type: 'string',
default: '',
description: 'The administrator\'s name',
} as INodeProperties;
const adminEmailField = {
displayName: 'Email',
name: 'email',
type: 'string',
default: '',
description: 'The administrator\'s email address',
} as INodeProperties;
const adminPhoneField = {
displayName: 'Phone',
name: 'phone',
type: 'string',
default: '',
description: 'The administrator\'s phone number',
} as INodeProperties;
const adminReadOnlyField = {
displayName: 'Read Only',
name: 'isReadOnly',
type: 'boolean',
default: false,
description: 'Whether this administrator can perform write operations',
} as INodeProperties;
export const adminFields: INodeProperties[] = [
{
displayName: 'Admin ID',
name: 'id',
type: 'string',
displayOptions: {
show: {
resource: [
'admin',
],
},
hide: {
operation: [
'create',
'getAll',
],
},
},
default: '',
required: true,
description: 'The ID of the admin object for lookup',
},
{
displayName: 'Return All',
name: 'returnAll',
type: 'boolean',
displayOptions: {
show: {
resource: [
'admin',
],
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: [
'admin',
],
operation: [
'getAll',
],
returnAll: [
false,
],
},
},
typeOptions: {
minValue: 1,
maxValue: 64,
},
default: 64,
description: 'How many results to return',
},
{
displayOptions: {
show: {
resource: [
'admin',
],
operation: [
'create',
],
},
},
required: true,
...adminNameField,
},
{
displayOptions: {
show: {
resource: [
'admin',
],
operation: [
'create',
],
},
},
required: true,
...adminEmailField,
},
{
displayName: 'Additional Fields',
name: 'additionalFields',
type: 'collection',
placeholder: 'Add Field',
default: {},
displayOptions: {
show: {
resource: [
'admin',
],
operation: [
'create',
],
},
},
options: [
adminPhoneField,
adminReadOnlyField,
],
},
{
displayName: 'Update Fields',
name: 'updateFields',
type: 'collection',
placeholder: 'Add Field',
default: {},
displayOptions: {
show: {
resource: [
'admin',
],
operation: [
'update',
],
},
},
options: [
adminNameField,
adminPhoneField,
adminReadOnlyField,
],
},
];