n8n/packages/nodes-base/nodes/Zendesk/TicketDescription.ts

836 lines
15 KiB
TypeScript
Raw Normal View History

2020-04-06 16:11:50 -07:00
import {
INodeProperties,
} from 'n8n-workflow';
2020-01-07 11:56:42 -08:00
export const ticketOperations: INodeProperties[] = [
2020-01-07 11:56:42 -08:00
{
displayName: 'Operation',
name: 'operation',
type: 'options',
displayOptions: {
show: {
resource: [
'ticket',
],
},
},
options: [
{
name: 'Create',
value: 'create',
description: 'Create a ticket',
},
{
2020-04-09 13:13:14 -07:00
name: 'Delete',
value: 'delete',
description: 'Delete a ticket',
2020-01-07 11:56:42 -08:00
},
{
name: 'Get',
value: 'get',
description: 'Get a ticket',
2020-01-07 11:56:42 -08:00
},
{
name: 'Get All',
value: 'getAll',
description: 'Get all tickets',
2020-01-07 11:56:42 -08:00
},
{
name: 'Recover',
value: 'recover',
description: 'Recover a suspended ticket',
},
2020-01-07 11:56:42 -08:00
{
2020-04-09 13:13:14 -07:00
name: 'Update',
value: 'update',
description: 'Update a ticket',
2020-01-07 11:56:42 -08:00
},
],
default: 'create',
description: 'The operation to perform.',
},
];
2020-01-07 11:56:42 -08:00
export const ticketFields: INodeProperties[] = [
2020-01-07 11:56:42 -08:00
/* -------------------------------------------------------------------------- */
/* ticket:create */
/* -------------------------------------------------------------------------- */
2020-01-07 11:56:42 -08:00
{
displayName: 'Description',
name: 'description',
type: 'string',
typeOptions: {
alwaysOpenEditWindow: true,
},
default: '',
displayOptions: {
show: {
resource: [
'ticket',
],
operation: [
'create',
],
},
},
required: true,
description: 'The first comment on the ticket',
},
2020-04-06 16:11:50 -07:00
{
displayName: 'JSON Parameters',
name: 'jsonParameters',
type: 'boolean',
default: false,
description: '',
displayOptions: {
show: {
resource: [
2020-04-09 13:13:14 -07:00
'ticket',
2020-04-06 16:11:50 -07:00
],
operation: [
'create',
],
},
},
},
2020-01-07 11:56:42 -08:00
{
displayName: 'Additional Fields',
name: 'additionalFields',
type: 'collection',
placeholder: 'Add Field',
default: {},
displayOptions: {
show: {
resource: [
'ticket',
],
operation: [
'create',
],
2020-04-09 13:13:14 -07:00
jsonParameters: [
false,
],
2020-01-07 11:56:42 -08:00
},
},
options: [
{
displayName: 'Custom Fields',
name: 'customFieldsUi',
placeholder: 'Add Custom Field',
type: 'fixedCollection',
typeOptions: {
multipleValues: true,
},
default: {},
options: [
{
displayName: 'Custom Field',
name: 'customFieldsValues',
values: [
{
displayName: 'ID',
name: 'id',
type: 'options',
typeOptions: {
loadOptionsMethod: 'getCustomFields',
},
default: '',
description: 'Custom field ID',
},
{
displayName: 'Value',
name: 'value',
type: 'string',
default: '',
description: 'Custom field Value.',
},
],
},
],
},
2020-01-07 11:56:42 -08:00
{
displayName: 'External ID',
name: 'externalId',
type: 'string',
default: '',
description: 'An id you can use to link Zendesk Support tickets to local records',
},
{
2020-04-09 13:13:14 -07:00
displayName: 'Group',
name: 'group',
type: 'options',
typeOptions: {
loadOptionsMethod: 'getGroups',
},
2020-01-07 11:56:42 -08:00
default: '',
2020-04-09 13:13:14 -07:00
description: 'The group this ticket is assigned to',
2020-01-07 11:56:42 -08:00
},
{
displayName: 'Recipient',
name: 'recipient',
type: 'string',
default: '',
description: 'The original recipient e-mail address of the ticket',
},
{
2020-04-09 13:13:14 -07:00
displayName: 'Status',
name: 'status',
2020-01-07 11:56:42 -08:00
type: 'options',
2020-04-09 13:13:14 -07:00
options: [
{
name: 'Closed',
value: 'closed',
2020-04-09 13:13:14 -07:00
},
{
name: 'New',
value: 'new',
},
{
name: 'On-hold',
value: 'hold',
},
{
name: 'Open',
value: 'open',
},
2020-04-09 13:13:14 -07:00
{
name: 'Pending',
value: 'pending',
},
{
name: 'Solved',
value: 'solved',
},
],
2020-01-07 11:56:42 -08:00
default: '',
2020-04-09 13:13:14 -07:00
description: 'The state of the ticket',
},
{
displayName: 'Subject',
name: 'subject',
type: 'string',
default: '',
description: 'The value of the subject field for this ticket',
2020-01-07 11:56:42 -08:00
},
{
displayName: 'Tags',
name: 'tags',
type: 'multiOptions',
typeOptions: {
loadOptionsMethod: 'getTags',
},
default: [],
description: 'The array of tags applied to this ticket',
},
{
displayName: 'Type',
name: 'type',
type: 'options',
options: [
{
name: 'Question',
value: 'question',
},
{
name: 'Incident',
value: 'incident',
},
{
name: 'Problem',
value: 'problem',
},
{
name: 'Task',
value: 'task',
},
],
default: '',
description: 'The type of this ticket',
},
2020-04-09 13:13:14 -07:00
],
},
{
displayName: ' Additional Fields',
name: 'additionalFieldsJson',
type: 'json',
typeOptions: {
alwaysOpenEditWindow: true,
},
default: '',
displayOptions: {
show: {
resource: [
'ticket',
],
operation: [
'create',
],
jsonParameters: [
true,
],
},
},
description: `Object of values to set as described <a href="https://developer.zendesk.com/rest_api/docs/support/tickets">here</a>.`,
2020-04-09 13:13:14 -07:00
},
/* -------------------------------------------------------------------------- */
/* ticket:update */
/* -------------------------------------------------------------------------- */
2020-01-07 11:56:42 -08:00
{
2020-04-09 13:13:14 -07:00
displayName: 'Ticket ID',
2020-01-07 11:56:42 -08:00
name: 'id',
type: 'string',
default: '',
required: true,
displayOptions: {
show: {
resource: [
'ticket',
],
operation: [
'update',
],
},
},
description: 'Ticket ID',
},
2020-04-06 16:11:50 -07:00
{
displayName: 'JSON Parameters',
name: 'jsonParameters',
type: 'boolean',
default: false,
description: '',
displayOptions: {
show: {
resource: [
2020-10-22 06:46:03 -07:00
'ticket',
2020-04-06 16:11:50 -07:00
],
operation: [
'update',
],
},
},
},
2020-01-07 11:56:42 -08:00
{
displayName: 'Update Fields',
name: 'updateFields',
type: 'collection',
placeholder: 'Add Field',
default: {},
displayOptions: {
show: {
resource: [
'ticket',
],
operation: [
'update',
],
2020-04-09 13:13:14 -07:00
jsonParameters: [
false,
],
2020-01-07 11:56:42 -08:00
},
},
options: [
{
displayName: 'Assignee Email',
name: 'assigneeEmail',
type: 'string',
default: '',
description: 'The e-mail address of the assignee',
},
{
displayName: 'Custom Fields',
name: 'customFieldsUi',
placeholder: 'Add Custom Field',
type: 'fixedCollection',
typeOptions: {
multipleValues: true,
},
default: {},
options: [
{
displayName: 'Custom Field',
name: 'customFieldsValues',
values: [
{
displayName: 'ID',
name: 'id',
type: 'options',
typeOptions: {
loadOptionsMethod: 'getCustomFields',
},
default: '',
description: 'Custom field ID',
},
{
displayName: 'Value',
name: 'value',
type: 'string',
default: '',
description: 'Custom field Value.',
},
],
},
],
},
2020-01-07 11:56:42 -08:00
{
displayName: 'External ID',
name: 'externalId',
type: 'string',
default: '',
description: 'An id you can use to link Zendesk Support tickets to local records',
},
{
2020-04-09 13:13:14 -07:00
displayName: 'Group',
name: 'group',
type: 'options',
typeOptions: {
loadOptionsMethod: 'getGroups',
},
2020-01-07 11:56:42 -08:00
default: '',
2020-04-09 13:13:14 -07:00
description: 'The group this ticket is assigned to',
2020-01-07 11:56:42 -08:00
},
{
displayName: 'Internal Note',
name: 'internalNote',
type: 'string',
default: '',
description: 'Internal Ticket Note (Accepts HTML)',
},
{
displayName: 'Public Reply',
name: 'publicReply',
type: 'string',
default: '',
description: 'Public ticket reply',
},
2020-01-07 11:56:42 -08:00
{
displayName: 'Recipient',
name: 'recipient',
type: 'string',
default: '',
description: 'The original recipient e-mail address of the ticket',
},
{
2020-04-09 13:13:14 -07:00
displayName: 'Status',
name: 'status',
2020-01-07 11:56:42 -08:00
type: 'options',
2020-04-09 13:13:14 -07:00
options: [
{
name: 'Closed',
value: 'closed',
2020-04-09 13:13:14 -07:00
},
{
name: 'New',
value: 'new',
},
{
name: 'On-hold',
value: 'hold',
},
{
name: 'Open',
value: 'open',
},
2020-04-09 13:13:14 -07:00
{
name: 'Pending',
value: 'pending',
},
{
name: 'Solved',
value: 'solved',
},
],
2020-01-07 11:56:42 -08:00
default: '',
2020-04-09 13:13:14 -07:00
description: 'The state of the ticket',
},
{
displayName: 'Subject',
name: 'subject',
type: 'string',
default: '',
description: 'The value of the subject field for this ticket',
2020-01-07 11:56:42 -08:00
},
{
displayName: 'Tags',
name: 'tags',
type: 'multiOptions',
typeOptions: {
loadOptionsMethod: 'getTags',
},
default: [],
description: 'The array of tags applied to this ticket',
},
{
displayName: 'Type',
name: 'type',
type: 'options',
options: [
{
name: 'Question',
value: 'question',
},
{
name: 'Incident',
value: 'incident',
},
{
name: 'Problem',
value: 'problem',
},
{
name: 'Task',
value: 'task',
},
],
default: '',
description: 'The type of this ticket',
},
2020-04-09 13:13:14 -07:00
],
},
{
displayName: ' Update Fields',
name: 'updateFieldsJson',
type: 'json',
typeOptions: {
alwaysOpenEditWindow: true,
},
default: '',
displayOptions: {
show: {
resource: [
'ticket',
],
operation: [
'update',
],
jsonParameters: [
true,
],
},
},
description: `Object of values to update as described <a href="https://developer.zendesk.com/rest_api/docs/support/tickets">here</a>.`,
2020-04-09 13:13:14 -07:00
},
{
displayName: 'Ticket Type',
name: 'ticketType',
type: 'options',
options: [
{
name: 'Regular',
value: 'regular',
},
{
name: 'Suspended',
value: 'suspended',
},
],
default: 'regular',
required: true,
displayOptions: {
show: {
resource: [
'ticket',
],
operation: [
'get',
'delete',
'getAll',
],
},
},
},
/* -------------------------------------------------------------------------- */
/* ticket:get */
/* -------------------------------------------------------------------------- */
2020-01-07 11:56:42 -08:00
{
2020-04-09 13:13:14 -07:00
displayName: 'Ticket ID',
2020-01-07 11:56:42 -08:00
name: 'id',
type: 'string',
default: '',
required: true,
displayOptions: {
show: {
resource: [
'ticket',
],
operation: [
'get',
],
ticketType: [
'regular',
],
},
},
description: 'Ticket ID',
},
{
displayName: 'Suspended Ticket ID',
name: 'id',
type: 'string',
default: '',
required: true,
displayOptions: {
show: {
resource: [
'ticket',
],
operation: [
'get',
],
ticketType: [
'suspended',
],
2020-01-07 11:56:42 -08:00
},
},
description: 'Ticket ID',
},
/* -------------------------------------------------------------------------- */
/* ticket:getAll */
/* -------------------------------------------------------------------------- */
2020-01-07 11:56:42 -08:00
{
displayName: 'Return All',
name: 'returnAll',
type: 'boolean',
displayOptions: {
show: {
resource: [
'ticket',
],
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: [
'ticket',
],
operation: [
'getAll',
],
returnAll: [
false,
],
},
},
typeOptions: {
minValue: 1,
maxValue: 100,
},
default: 100,
description: 'How many results to return.',
},
{
displayName: 'Options',
name: 'options',
type: 'collection',
placeholder: 'Add Option',
default: {},
displayOptions: {
show: {
resource: [
'ticket',
],
operation: [
'getAll',
],
},
},
options: [
{
displayName: 'Group',
name: 'group',
type: 'options',
typeOptions: {
loadOptionsMethod: 'getGroups',
},
displayOptions: {
show: {
'/ticketType': [
'regular',
],
},
},
default: '',
description: 'The group to search',
},
{
displayName: 'Query',
name: 'query',
type: 'string',
displayOptions: {
show: {
'/ticketType': [
'regular',
],
},
},
default: '',
description: '<a href="https://developer.zendesk.com/api-reference/ticketing/ticket-management/search/#syntax-examples">Query syntax</a> to search tickets',
},
2020-01-07 11:56:42 -08:00
{
displayName: 'Sort By',
name: 'sortBy',
type: 'options',
options: [
{
name: 'Updated At',
value: 'updated_at',
},
{
name: 'Created At',
value: 'created_at',
},
{
name: 'Priority',
value: 'priority',
},
{
name: 'Status',
value: 'status',
},
{
name: 'Ticket Type',
value: 'ticket_type',
},
],
default: 'updated_at',
description: 'Defaults to sorting by relevance',
},
{
displayName: 'Sort Order',
name: 'sortOrder',
type: 'options',
options: [
{
name: 'Ascending',
2020-01-07 11:56:42 -08:00
value: 'asc',
},
{
name: 'Descending',
2020-01-07 11:56:42 -08:00
value: 'desc',
},
],
default: 'asc',
2020-01-07 11:56:42 -08:00
description: 'Sort order',
2020-04-09 13:13:14 -07:00
},
{
displayName: 'Status',
name: 'status',
type: 'options',
displayOptions: {
show: {
'/ticketType': [
'regular',
],
},
},
2020-04-09 13:13:14 -07:00
options: [
{
name: 'Closed',
value: 'closed',
2020-04-09 13:13:14 -07:00
},
{
name: 'New',
value: 'new',
},
{
name: 'On-hold',
value: 'hold',
},
{
name: 'Open',
value: 'open',
},
2020-04-09 13:13:14 -07:00
{
name: 'Pending',
value: 'pending',
},
{
name: 'Solved',
value: 'solved',
},
],
default: '',
description: 'The state of the ticket',
},
2020-01-07 11:56:42 -08:00
],
},
/* -------------------------------------------------------------------------- */
/* ticket:delete */
/* -------------------------------------------------------------------------- */
2020-01-07 11:56:42 -08:00
{
2020-04-09 13:13:14 -07:00
displayName: 'Ticket ID',
2020-01-07 11:56:42 -08:00
name: 'id',
type: 'string',
default: '',
required: true,
displayOptions: {
show: {
resource: [
'ticket',
],
operation: [
'delete',
],
ticketType: [
'regular',
],
},
},
description: 'Ticket ID',
},
{
displayName: 'Suspended Ticket ID',
name: 'id',
type: 'string',
default: '',
required: true,
displayOptions: {
show: {
resource: [
'ticket',
],
operation: [
'delete',
],
ticketType: [
'suspended',
],
2020-01-07 11:56:42 -08:00
},
},
description: 'Ticket ID',
},
/* -------------------------------------------------------------------------- */
/* ticket:recover */
/* -------------------------------------------------------------------------- */
{
displayName: 'Suspended Ticket ID',
name: 'id',
type: 'string',
default: '',
required: true,
displayOptions: {
show: {
resource: [
'ticket',
],
operation: [
'recover',
],
},
},
},
];