n8n/packages/nodes-base/nodes/Freshservice/descriptions/DepartmentDescription.ts
Iván Ovejero 65820b3b54
Add Freshservice node (#2090)
*  Create Freshservice node

* 👕 Fix lintings

*  Adjust from agent to department

*  Adjust from location to ticket

* 👕 Fix lintings

* ✏️ Improve descriptions

* 🔥 Remove logging

* 🔥 Remove unused helper

* ✏️ Fix helper documentation

*  Simplify roles in agent:create

* 🔥 Remove logging

*  Minor improvements

* ✏️ Adjust dynamic lists descriptions

*  Set default values for problem:create

*  Set default values for change:create

*  Handle deletion with empty response

*  Update getCredentials call to new style

* ✏️ Reword multiOptions descriptions

*  Add special handling for validation errors

* 🔥 Remove concatenated name from filters

*  Fix additional params in announcement:create

* ✏️ Clarify asset display ID vs asset ID

*  Fix asset:update arg typo

*  Fix predefined filters in change:getAll

*  Fix software status options

* ✏️ Reword created_at in ticket:getAll

*  Add status to ticket:update

* 👕 Fix lint

*  Improvements

*  Minor improvements

Co-authored-by: ricardo <ricardoespinoza105@gmail.com>
Co-authored-by: Jan Oberhauser <jan.oberhauser@gmail.com>
2021-09-05 19:24:56 +02:00

276 lines
4.6 KiB
TypeScript

import {
INodeProperties,
} from 'n8n-workflow';
export const departmentOperations = [
{
displayName: 'Operation',
name: 'operation',
type: 'options',
displayOptions: {
show: {
resource: [
'department',
],
},
},
options: [
{
name: 'Create',
value: 'create',
description: 'Create a department',
},
{
name: 'Delete',
value: 'delete',
description: 'Delete a department',
},
{
name: 'Get',
value: 'get',
description: 'Retrieve a department',
},
{
name: 'Get All',
value: 'getAll',
description: 'Retrieve all departments',
},
{
name: 'Update',
value: 'update',
description: 'Update a department',
},
],
default: 'create',
},
] as INodeProperties[];
export const departmentFields = [
// ----------------------------------------
// department: create
// ----------------------------------------
{
displayName: 'Name',
name: 'name',
type: 'string',
required: true,
default: '',
displayOptions: {
show: {
resource: [
'department',
],
operation: [
'create',
],
},
},
},
{
displayName: 'Additional Fields',
name: 'additionalFields',
type: 'collection',
placeholder: 'Add Field',
default: {},
displayOptions: {
show: {
resource: [
'department',
],
operation: [
'create',
],
},
},
options: [
{
displayName: 'Description',
name: 'description',
type: 'string',
default: '',
},
{
displayName: 'Domains',
name: 'domains',
type: 'string',
default: '',
description: 'Comma-separated email domains associated with the department',
},
],
},
// ----------------------------------------
// department: delete
// ----------------------------------------
{
displayName: 'Department ID',
name: 'departmentId',
description: 'ID of the department to delete',
type: 'string',
required: true,
default: '',
displayOptions: {
show: {
resource: [
'department',
],
operation: [
'delete',
],
},
},
},
// ----------------------------------------
// department: get
// ----------------------------------------
{
displayName: 'Department ID',
name: 'departmentId',
description: 'ID of the department to retrieve',
type: 'string',
required: true,
default: '',
displayOptions: {
show: {
resource: [
'department',
],
operation: [
'get',
],
},
},
},
// ----------------------------------------
// department: getAll
// ----------------------------------------
{
displayName: 'Return All',
name: 'returnAll',
type: 'boolean',
default: false,
description: 'Whether to return all results or only up to a given limit',
displayOptions: {
show: {
resource: [
'department',
],
operation: [
'getAll',
],
},
},
},
{
displayName: 'Limit',
name: 'limit',
type: 'number',
default: 50,
description: 'How many results to return',
typeOptions: {
minValue: 1,
},
displayOptions: {
show: {
resource: [
'department',
],
operation: [
'getAll',
],
returnAll: [
false,
],
},
},
},
{
displayName: 'Filters',
name: 'filters',
type: 'collection',
placeholder: 'Add Filter',
default: {},
displayOptions: {
show: {
resource: [
'department',
],
operation: [
'getAll',
],
},
},
options: [
{
displayName: 'Name',
name: 'name',
type: 'string',
default: '',
description: 'Name of the department',
},
],
},
// ----------------------------------------
// department: update
// ----------------------------------------
{
displayName: 'Department ID',
name: 'departmentId',
description: 'ID of the department to update',
type: 'string',
required: true,
default: '',
displayOptions: {
show: {
resource: [
'department',
],
operation: [
'update',
],
},
},
},
{
displayName: 'Update Fields',
name: 'updateFields',
type: 'collection',
placeholder: 'Add Field',
default: {},
displayOptions: {
show: {
resource: [
'department',
],
operation: [
'update',
],
},
},
options: [
{
displayName: 'Description',
name: 'description',
type: 'string',
default: '',
},
{
displayName: 'Domains',
name: 'domains',
type: 'string',
default: '',
description: 'Comma-separated email domains associated with the department',
},
{
displayName: 'Name',
name: 'name',
type: 'string',
default: '',
},
],
},
] as INodeProperties[];