n8n/packages/nodes-base/nodes/Freshservice/descriptions/ChangeDescription.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

703 lines
12 KiB
TypeScript

import {
INodeProperties,
} from 'n8n-workflow';
export const changeOperations = [
{
displayName: 'Operation',
name: 'operation',
type: 'options',
displayOptions: {
show: {
resource: [
'change',
],
},
},
options: [
{
name: 'Create',
value: 'create',
description: 'Create a change',
},
{
name: 'Delete',
value: 'delete',
description: 'Delete a change',
},
{
name: 'Get',
value: 'get',
description: 'Retrieve a change',
},
{
name: 'Get All',
value: 'getAll',
description: 'Retrieve all changes',
},
{
name: 'Update',
value: 'update',
description: 'Update a change',
},
],
default: 'create',
},
] as INodeProperties[];
export const changeFields = [
// ----------------------------------------
// change: create
// ----------------------------------------
{
displayName: 'Requester Name/ID',
name: 'requesterId',
description: 'ID of the requester of the change. Choose from the list or specify an ID. You can also specify the ID using an <a href="https://docs.n8n.io/nodes/expressions.html#expressions">expression</a>.',
type: 'options',
required: true,
default: '',
typeOptions: {
loadOptionsMethod: [
'getRequesters',
],
},
displayOptions: {
show: {
resource: [
'change',
],
operation: [
'create',
],
},
},
},
{
displayName: 'Subject',
name: 'subject',
type: 'string',
required: true,
default: '',
displayOptions: {
show: {
resource: [
'change',
],
operation: [
'create',
],
},
},
},
{
displayName: 'Planned Start Date',
name: 'plannedStartDate',
type: 'dateTime',
required: true,
default: '',
displayOptions: {
show: {
resource: [
'change',
],
operation: [
'create',
],
},
},
},
{
displayName: 'Planned End Date',
name: 'plannedEndDate',
type: 'dateTime',
required: true,
default: '',
displayOptions: {
show: {
resource: [
'change',
],
operation: [
'create',
],
},
},
},
{
displayName: 'Additional Fields',
name: 'additionalFields',
type: 'collection',
placeholder: 'Add Field',
default: {},
displayOptions: {
show: {
resource: [
'change',
],
operation: [
'create',
],
},
},
options: [
{
displayName: 'Agent Name/ID',
name: 'agent_id',
type: 'options',
default: '',
description: 'ID of the agent to whom the change is assigned. Choose from the list or specify an ID. You can also specify the ID using an <a href="https://docs.n8n.io/nodes/expressions.html#expressions">expression</a>.',
typeOptions: {
loadOptionsMethod: [
'getAgents',
],
},
},
{
displayName: 'Change Type',
name: 'change_type',
type: 'options',
default: 1,
options: [
{
name: 'Minor',
value: 1,
},
{
name: 'Standard',
value: 2,
},
{
name: 'Major',
value: 3,
},
{
name: 'Emergency',
value: 4,
},
],
},
{
displayName: 'Department Name/ID',
name: 'department_id',
type: 'options',
default: '',
description: 'ID of the department requesting the change. Choose from the list or specify an ID. You can also specify the ID using an <a href="https://docs.n8n.io/nodes/expressions.html#expressions">expression</a>.',
typeOptions: {
loadOptionsMethod: [
'getDepartments',
],
},
},
{
displayName: 'Description',
name: 'description',
type: 'string',
default: '',
description: 'HTML supported',
},
{
displayName: 'Group Name/ID',
name: 'group_id',
type: 'options',
default: '',
description: 'ID of the agent group to which the change is assigned. Choose from the list or specify an ID. You can also specify the ID using an <a href="https://docs.n8n.io/nodes/expressions.html#expressions">expression</a>.',
typeOptions: {
loadOptionsMethod: [
'getAgentGroups',
],
},
},
{
displayName: 'Impact',
name: 'impact',
type: 'options',
default: 1,
options: [
{
name: 'Low',
value: 1,
},
{
name: 'Medium',
value: 2,
},
{
name: 'High',
value: 3,
},
],
},
{
displayName: 'Priority',
name: 'priority',
type: 'options',
default: 1,
options: [
{
name: 'Low',
value: 1,
},
{
name: 'Medium',
value: 2,
},
{
name: 'High',
value: 3,
},
{
name: 'Urgent',
value: 4,
},
],
},
{
displayName: 'Risk',
name: 'risk',
type: 'options',
default: 1,
options: [
{
name: 'Low',
value: 1,
},
{
name: 'Medium',
value: 2,
},
{
name: 'High',
value: 3,
},
{
name: 'Very High',
value: 4,
},
],
},
{
displayName: 'Status',
name: 'status',
type: 'options',
default: 1,
options: [
{
name: 'Open',
value: 1,
},
{
name: 'Planning',
value: 2,
},
{
name: 'Approval',
value: 3,
},
{
name: 'Pending Release',
value: 4,
},
{
name: 'Pending Review',
value: 5,
},
{
name: 'Closed',
value: 6,
},
],
},
{
displayName: 'Subject',
name: 'subject',
type: 'string',
default: '',
},
],
},
// ----------------------------------------
// change: delete
// ----------------------------------------
{
displayName: 'Change ID',
name: 'changeId',
description: 'ID of the change to delete',
type: 'string',
required: true,
default: '',
displayOptions: {
show: {
resource: [
'change',
],
operation: [
'delete',
],
},
},
},
// ----------------------------------------
// change: get
// ----------------------------------------
{
displayName: 'Change ID',
name: 'changeId',
description: 'ID of the change to retrieve',
type: 'string',
required: true,
default: '',
displayOptions: {
show: {
resource: [
'change',
],
operation: [
'get',
],
},
},
},
// ----------------------------------------
// change: 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: [
'change',
],
operation: [
'getAll',
],
},
},
},
{
displayName: 'Limit',
name: 'limit',
type: 'number',
default: 50,
description: 'How many results to return',
typeOptions: {
minValue: 1,
},
displayOptions: {
show: {
resource: [
'change',
],
operation: [
'getAll',
],
returnAll: [
false,
],
},
},
},
{
displayName: 'Filters',
name: 'filters',
type: 'collection',
placeholder: 'Add Filter',
default: {},
displayOptions: {
show: {
resource: [
'change',
],
operation: [
'getAll',
],
},
},
options: [
{
displayName: 'Predefined Filters',
name: 'filter',
type: 'options',
default: 'my_open',
options: [
{
name: 'Closed',
value: 'closed',
},
{
name: 'My Open',
value: 'my_open',
},
{
name: 'Release Requested',
value: 'release_requested',
},
{
name: 'Requester ID',
value: 'requester_id',
},
{
name: 'Unassigned',
value: 'unassigned',
},
],
},
{
displayName: 'Sort Order',
name: 'sort_by',
type: 'options',
options: [
{
name: 'Ascending',
value: 'asc',
},
{
name: 'Descending',
value: 'desc',
},
],
default: 'asc',
},
{
displayName: 'Updated Since',
name: 'updated_since',
type: 'dateTime',
default: '',
},
],
},
// ----------------------------------------
// change: update
// ----------------------------------------
{
displayName: 'Change ID',
name: 'changeId',
description: 'ID of the change to update',
type: 'string',
required: true,
default: '',
displayOptions: {
show: {
resource: [
'change',
],
operation: [
'update',
],
},
},
},
{
displayName: 'Update Fields',
name: 'updateFields',
type: 'collection',
placeholder: 'Add Field',
default: {},
displayOptions: {
show: {
resource: [
'change',
],
operation: [
'update',
],
},
},
options: [
{
displayName: 'Agent Name/ID',
name: 'agent_id',
type: 'options',
default: '',
description: 'ID of the agent to whom the change is assigned. Choose from the list or specify an ID. You can also specify the ID using an <a href="https://docs.n8n.io/nodes/expressions.html#expressions">expression</a>.',
typeOptions: {
loadOptionsMethod: [
'getAgents',
],
},
},
{
displayName: 'Change Type',
name: 'change_type',
type: 'options',
default: 1,
options: [
{
name: 'Minor',
value: 1,
},
{
name: 'Standard',
value: 2,
},
{
name: 'Major',
value: 3,
},
{
name: 'Emergency',
value: 4,
},
],
},
{
displayName: 'Department Name/ID',
name: 'department_id',
type: 'options',
default: '',
description: 'ID of the department requesting the change. Choose from the list or specify an ID. You can also specify the ID using an <a href="https://docs.n8n.io/nodes/expressions.html#expressions">expression</a>.',
typeOptions: {
loadOptionsMethod: [
'getDepartments',
],
},
},
{
displayName: 'Description',
name: 'description',
type: 'string',
default: '',
description: 'HTML supported',
},
{
displayName: 'Group Name/ID',
name: 'group_id',
type: 'options',
default: '',
description: 'ID of the agent group to which the change is assigned. Choose from the list or specify an ID. You can also specify the ID using an <a href="https://docs.n8n.io/nodes/expressions.html#expressions">expression</a>.',
typeOptions: {
loadOptionsMethod: [
'getAgentGroups',
],
},
},
{
displayName: 'Impact',
name: 'impact',
type: 'options',
default: 1,
description: 'Impact of the change',
options: [
{
name: 'Low',
value: 1,
},
{
name: 'Medium',
value: 2,
},
{
name: 'High',
value: 3,
},
],
},
{
displayName: 'Priority',
name: 'priority',
type: 'options',
default: 1,
options: [
{
name: 'Low',
value: 1,
},
{
name: 'Medium',
value: 2,
},
{
name: 'High',
value: 3,
},
{
name: 'Urgent',
value: 4,
},
],
},
{
displayName: 'Requester Name/ID',
name: 'requester_id',
type: 'options',
default: '',
description: 'ID of the requester of the change. Choose from the list or specify an ID. You can also specify the ID using an <a href="https://docs.n8n.io/nodes/expressions.html#expressions">expression</a>.',
typeOptions: {
loadOptionsMethod: [
'getRequesters',
],
},
},
{
displayName: 'Risk',
name: 'risk',
type: 'options',
default: 1,
options: [
{
name: 'Low',
value: 1,
},
{
name: 'Medium',
value: 2,
},
{
name: 'High',
value: 3,
},
{
name: 'Very High',
value: 4,
},
],
},
{
displayName: 'Status',
name: 'status',
type: 'options',
default: 1,
options: [
{
name: 'Open',
value: 1,
},
{
name: 'Planning',
value: 2,
},
{
name: 'Approval',
value: 3,
},
{
name: 'Pending Release',
value: 4,
},
{
name: 'Pending Review',
value: 5,
},
{
name: 'Closed',
value: 6,
},
],
},
{
displayName: 'Subject',
name: 'subject',
type: 'string',
default: '',
},
],
},
] as INodeProperties[];