n8n-nodes-base
Version:
Base nodes of n8n
465 lines • 16.5 kB
JavaScript
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.ticketDescription = void 0;
exports.ticketDescription = [
// ----------------------------------
// operations
// ----------------------------------
{
displayName: 'Operation',
name: 'operation',
type: 'options',
noDataExpression: true,
displayOptions: {
show: {
resource: ['ticket'],
},
},
options: [
{
name: 'Create',
value: 'create',
description: 'Create a ticket',
action: 'Create a ticket',
},
{
name: 'Delete',
value: 'delete',
description: 'Delete a ticket',
action: 'Delete a ticket',
},
{
name: 'Get',
value: 'get',
description: 'Retrieve a ticket',
action: 'Get a ticket',
},
{
name: 'Get Many',
value: 'getAll',
description: 'Retrieve many tickets',
action: 'Get many tickets',
},
{
name: 'Update',
value: 'update',
description: 'Update a ticket',
action: 'Update a ticket',
},
],
default: 'create',
},
// ----------------------------------
// fields
// ----------------------------------
{
displayName: 'Title',
name: 'title',
type: 'string',
description: 'Title of the ticket to create',
default: '',
required: true,
displayOptions: {
show: {
resource: ['ticket'],
operation: ['create'],
},
},
},
{
displayName: 'Group Name or ID',
name: 'group',
type: 'options',
typeOptions: {
loadOptionsMethod: 'loadGroupNames',
},
placeholder: 'First-Level Helpdesk',
description: 'Group that will own the ticket to create. Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code/expressions/">expression</a>.',
default: '',
required: true,
displayOptions: {
show: {
resource: ['ticket'],
operation: ['create'],
},
},
},
{
displayName: 'Customer Email Name or ID',
name: 'customer',
type: 'options',
typeOptions: {
loadOptionsMethod: 'loadCustomerEmails',
},
description: 'Email address of the customer concerned in the ticket to create. Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code/expressions/">expression</a>.',
default: '',
placeholder: 'hello@n8n.io',
required: true,
displayOptions: {
show: {
resource: ['ticket'],
operation: ['create'],
},
},
},
{
displayName: 'Ticket ID',
name: 'id',
type: 'string',
description: 'Ticket to retrieve. Specify an ID using an <a href="https://docs.n8n.io/code/expressions/">expression</a>.',
default: '',
required: true,
displayOptions: {
show: {
resource: ['ticket'],
operation: ['get'],
},
},
},
{
displayName: 'Ticket ID',
name: 'id',
type: 'string',
default: '',
description: 'Ticket to delete. Specify an ID using an <a href="https://docs.n8n.io/code/expressions/">expression</a>.',
required: true,
displayOptions: {
show: {
resource: ['ticket'],
operation: ['delete'],
},
},
},
{
displayName: 'Ticket ID',
name: 'id',
type: 'string',
default: '',
description: 'Ticket to update. Specify an ID using an <a href="https://docs.n8n.io/code/expressions/">expression</a>.',
required: true,
displayOptions: {
show: {
resource: ['ticket'],
operation: ['update'],
},
},
},
{
displayName: 'Article',
name: 'article',
type: 'fixedCollection',
placeholder: 'Add Article',
required: true,
default: {},
displayOptions: {
show: {
resource: ['ticket'],
operation: ['create'],
},
},
options: [
{
displayName: 'Article Details',
name: 'articleDetails',
values: [
{
displayName: 'Subject',
name: 'subject',
type: 'string',
default: '',
},
{
displayName: 'Body',
name: 'body',
type: 'string',
default: '',
},
{
displayName: 'Visibility',
name: 'visibility',
type: 'options',
default: 'internal',
options: [
{
name: 'External',
value: 'external',
description: 'Visible to customers',
},
{
name: 'Internal',
value: 'internal',
description: 'Visible to help desk',
},
],
},
{
displayName: 'Sender',
name: 'sender',
type: 'options',
// https://docs.zammad.org/en/latest/api/ticket/articles.html
options: [
{
name: 'Agent',
value: 'Agent',
},
{
name: 'Customer',
value: 'Customer',
},
{
name: 'System',
value: 'System',
description: 'Only subject will be displayed in Zammad',
},
],
default: 'Agent',
},
{
displayName: 'Article Type',
name: 'type',
type: 'options',
// https://docs.zammad.org/en/latest/api/ticket/articles.html
options: [
{
name: 'Chat',
value: 'chat',
},
{
name: 'Email',
value: 'email',
},
{
name: 'Fax',
value: 'fax',
},
{
name: 'Note',
value: 'note',
},
{
name: 'Phone',
value: 'phone',
},
{
name: 'SMS',
value: 'sms',
},
],
default: 'note',
},
{
displayName: 'Reply To',
name: 'reply_to',
type: 'string',
default: '',
},
],
},
],
},
{
displayName: 'Additional Fields',
name: 'additionalFields',
type: 'collection',
displayOptions: {
show: {
resource: ['ticket'],
operation: ['create'],
},
},
default: {},
placeholder: 'Add Field',
options: [
{
/* eslint-disable n8n-nodes-base/node-param-description-wrong-for-dynamic-options, n8n-nodes-base/node-param-display-name-wrong-for-dynamic-options */
displayName: 'Custom Fields',
name: 'customFieldsUi',
type: 'fixedCollection',
default: {},
placeholder: 'Add Custom Field',
typeOptions: {
multipleValues: true,
},
options: [
{
name: 'customFieldPairs',
displayName: 'Custom Field',
values: [
{
displayName: 'Field Name',
name: 'name',
type: 'options',
typeOptions: {
loadOptionsMethod: 'loadTicketCustomFields',
},
default: '',
description: 'Internal name of the custom field to set. Choose from the list, or specify a name using an <a href="https://docs.n8n.io/code/expressions/">expression</a>.',
},
{
displayName: 'Value',
name: 'value',
type: 'string',
default: '',
description: 'Value to set on the custom field',
},
],
},
],
},
],
},
{
displayName: 'Update Fields',
name: 'updateFields',
type: 'collection',
displayOptions: {
show: {
resource: ['ticket'],
operation: ['update'],
},
},
default: {},
placeholder: 'Add Field',
options: [
{
displayName: 'Title',
name: 'title',
type: 'string',
default: '',
description: 'Title of the ticket',
},
{
displayName: 'Group',
name: 'group',
type: 'options',
typeOptions: {
loadOptionsMethod: 'loadGroupNames',
},
default: '',
description: 'Group that will own the ticket. Choose from the list, or specify a name using an <a href="https://docs.n8n.io/code/expressions/">expression</a>.',
},
{
displayName: 'State',
name: 'state_id',
type: 'options',
typeOptions: {
loadOptionsMethod: 'loadTicketStates',
},
default: '',
description: 'State of the ticket. Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code/expressions/">expression</a>.',
},
{
displayName: 'Pending Time',
name: 'pending_time',
type: 'dateTime',
default: '',
description: 'Date and time when the pending ticket should be activated (required for pending reminder, pending close, and snooze states)',
},
{
displayName: 'Priority',
name: 'priority_id',
type: 'options',
typeOptions: {
loadOptionsMethod: 'loadTicketPriorities',
},
default: '',
description: 'Priority of the ticket. Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code/expressions/">expression</a>.',
},
{
displayName: 'Owner',
name: 'owner_id',
type: 'options',
typeOptions: {
loadOptionsMethod: 'loadUsers',
},
default: '',
description: 'Agent responsible for the ticket. Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code/expressions/">expression</a>.',
},
{
displayName: 'Customer',
name: 'customer_id',
type: 'options',
typeOptions: {
loadOptionsMethod: 'loadCustomerIds',
},
default: '',
description: 'Customer associated with the ticket. Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code/expressions/">expression</a>.',
},
{
displayName: 'Note',
name: 'note',
type: 'string',
typeOptions: { editor: 'htmlEditor' },
default: '',
description: 'Internal note for the ticket',
},
{
/* eslint-disable n8n-nodes-base/node-param-description-wrong-for-dynamic-options, n8n-nodes-base/node-param-display-name-wrong-for-dynamic-options */
displayName: 'Custom Fields',
name: 'customFieldsUi',
type: 'fixedCollection',
default: {},
placeholder: 'Add Custom Field',
typeOptions: {
multipleValues: true,
},
options: [
{
name: 'customFieldPairs',
displayName: 'Custom Field',
values: [
{
displayName: 'Field Name',
name: 'name',
type: 'options',
typeOptions: {
loadOptionsMethod: 'loadTicketCustomFields',
},
default: '',
description: 'Internal name of the custom field to set. Choose from the list, or specify a name using an <a href="https://docs.n8n.io/code/expressions/">expression</a>.',
},
{
displayName: 'Value',
name: 'value',
type: 'string',
default: '',
description: 'Value to set on the custom field',
},
],
},
],
},
],
},
{
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: ['ticket'],
operation: ['getAll'],
},
},
},
{
displayName: 'Limit',
name: 'limit',
type: 'number',
default: 50,
description: 'Max number of results to return',
typeOptions: {
minValue: 1,
},
displayOptions: {
show: {
resource: ['ticket'],
operation: ['getAll'],
returnAll: [false],
},
},
},
];
//# sourceMappingURL=TicketDescription.js.map