mirror of
https://github.com/n8n-io/n8n.git
synced 2024-09-21 15:27:32 -07:00
0764c49dcf
* 🔥 Remove line breaks from param descriptions * 🔥 Remove more line breaks * 🎨 Fix spacing for list item in tooltip * ⚡ Apply multiline with <p> tags * ⚡ Improve <code> and <a> tags * ✏️ Improve grammar and spelling * ⚡ Add missing <p> tags * ✏️ Make "multiple" phrasing consistent * ⚡ Fix unneeded quote escapes * ⚡ Encode angle brackets * ⚡ Fix typo and copy-paste artifact
549 lines
12 KiB
TypeScript
549 lines
12 KiB
TypeScript
import {
|
|
INodeProperties,
|
|
} from 'n8n-workflow';
|
|
|
|
export const ticketOperations = [
|
|
{
|
|
displayName: 'Operation',
|
|
name: 'operation',
|
|
type: 'options',
|
|
displayOptions: {
|
|
show: {
|
|
resource: [
|
|
'ticket',
|
|
],
|
|
},
|
|
},
|
|
options: [
|
|
{
|
|
name: 'Create',
|
|
value: 'create',
|
|
description: 'Create a ticket',
|
|
},
|
|
{
|
|
name: 'Delete',
|
|
value: 'delete',
|
|
description: 'Delete a ticket',
|
|
},
|
|
{
|
|
name: 'Get',
|
|
value: 'get',
|
|
description: 'Get a ticket',
|
|
},
|
|
{
|
|
name: 'Get All',
|
|
value: 'getAll',
|
|
description: 'Get all tickets',
|
|
},
|
|
{
|
|
name: 'Update',
|
|
value: 'update',
|
|
description: 'Update a ticket',
|
|
},
|
|
],
|
|
default: 'create',
|
|
description: 'The operation to perform.',
|
|
},
|
|
] as INodeProperties[];
|
|
|
|
export const ticketFields = [
|
|
|
|
/* -------------------------------------------------------------------------- */
|
|
/* ticket:create */
|
|
/* -------------------------------------------------------------------------- */
|
|
{
|
|
displayName: 'Pipeline ID',
|
|
name: 'pipelineId',
|
|
type: 'options',
|
|
required: true,
|
|
typeOptions: {
|
|
loadOptionsMethod: 'getTicketPipelines',
|
|
},
|
|
displayOptions: {
|
|
show: {
|
|
resource: [
|
|
'ticket',
|
|
],
|
|
operation: [
|
|
'create',
|
|
],
|
|
},
|
|
},
|
|
default: '',
|
|
description: 'The ID of the pipeline the ticket is in.',
|
|
},
|
|
{
|
|
displayName: 'Stage ID',
|
|
name: 'stageId',
|
|
type: 'options',
|
|
required: true,
|
|
typeOptions: {
|
|
loadOptionsMethod: 'getTicketStages',
|
|
loadOptionsDependsOn: [
|
|
'pipelineId',
|
|
],
|
|
},
|
|
displayOptions: {
|
|
show: {
|
|
resource: [
|
|
'ticket',
|
|
],
|
|
operation: [
|
|
'create',
|
|
],
|
|
},
|
|
},
|
|
default: '',
|
|
description: 'The ID of the pipeline the ticket is in.',
|
|
},
|
|
{
|
|
displayName: 'Ticket Name',
|
|
name: 'ticketName',
|
|
type: 'string',
|
|
required: true,
|
|
displayOptions: {
|
|
show: {
|
|
resource: [
|
|
'ticket',
|
|
],
|
|
operation: [
|
|
'create',
|
|
],
|
|
},
|
|
},
|
|
default: '',
|
|
description: 'The ID of the pipeline the ticket is in.',
|
|
},
|
|
{
|
|
displayName: 'Additional Fields',
|
|
name: 'additionalFields',
|
|
type: 'collection',
|
|
placeholder: 'Add Field',
|
|
default: {},
|
|
displayOptions: {
|
|
show: {
|
|
resource: [
|
|
'ticket',
|
|
],
|
|
operation: [
|
|
'create',
|
|
],
|
|
},
|
|
},
|
|
options: [
|
|
{
|
|
displayName: 'Company Ids',
|
|
name: 'associatedCompanyIds',
|
|
type: 'multiOptions',
|
|
typeOptions: {
|
|
loadOptionsMethod: 'getCompanies',
|
|
},
|
|
default: [],
|
|
description: 'Companies associated with the ticket',
|
|
},
|
|
{
|
|
displayName: 'Contact Ids',
|
|
name: 'associatedContactIds',
|
|
type: 'multiOptions',
|
|
typeOptions: {
|
|
loadOptionsMethod: 'getContacts',
|
|
},
|
|
default: [],
|
|
description: 'Contacts associated with the ticket',
|
|
},
|
|
{
|
|
displayName: 'Category',
|
|
name: 'category',
|
|
type: 'options',
|
|
typeOptions: {
|
|
loadOptionsMethod: 'getTicketCategories',
|
|
},
|
|
default: '',
|
|
description: 'Main reason customer reached out for help',
|
|
},
|
|
{
|
|
displayName: 'Close Date',
|
|
name: 'closeDate',
|
|
type: 'dateTime',
|
|
default: '',
|
|
description: 'The date the ticket was closed',
|
|
},
|
|
{
|
|
displayName: 'Create Date',
|
|
name: 'createDate',
|
|
type: 'dateTime',
|
|
default: '',
|
|
description: 'the date the ticket was created',
|
|
},
|
|
{
|
|
displayName: 'Description',
|
|
name: 'description',
|
|
type: 'string',
|
|
typeOptions: {
|
|
alwaysOpenEditWindow: true,
|
|
},
|
|
default: '',
|
|
description: 'Description of the ticket',
|
|
},
|
|
{
|
|
displayName: 'Priority',
|
|
name: 'priority',
|
|
type: 'options',
|
|
typeOptions: {
|
|
loadOptionsMethod: 'getTicketPriorities',
|
|
},
|
|
default: '',
|
|
description: 'The level of attention needed on the ticket',
|
|
},
|
|
{
|
|
displayName: 'Resolution',
|
|
name: 'resolution',
|
|
type: 'options',
|
|
typeOptions: {
|
|
loadOptionsMethod: 'getTicketResolutions',
|
|
},
|
|
default: '',
|
|
description: 'The action taken to resolve the ticket',
|
|
},
|
|
{
|
|
displayName: 'Source',
|
|
name: 'source',
|
|
type: 'options',
|
|
typeOptions: {
|
|
loadOptionsMethod: 'getTicketSources',
|
|
},
|
|
default: '',
|
|
description: 'Channel where ticket was originally submitted',
|
|
},
|
|
{
|
|
displayName: 'Ticket Owner ID',
|
|
name: 'ticketOwnerId',
|
|
type: 'options',
|
|
typeOptions: {
|
|
loadOptionsMethod: 'getOwners',
|
|
},
|
|
default: '',
|
|
description: `The user from your team that the ticket is assigned to. You can assign additional users to a ticket record by creating a custom HubSpot user property`,
|
|
},
|
|
],
|
|
},
|
|
/* -------------------------------------------------------------------------- */
|
|
/* ticket:update */
|
|
/* -------------------------------------------------------------------------- */
|
|
{
|
|
displayName: 'Ticket ID',
|
|
name: 'ticketId',
|
|
type: 'string',
|
|
required: true,
|
|
displayOptions: {
|
|
show: {
|
|
resource: [
|
|
'ticket',
|
|
],
|
|
operation: [
|
|
'update',
|
|
],
|
|
},
|
|
},
|
|
default: '',
|
|
description: 'Unique identifier for a particular ticket.',
|
|
},
|
|
{
|
|
displayName: 'Update Fields',
|
|
name: 'updateFields',
|
|
type: 'collection',
|
|
placeholder: 'Add Field',
|
|
default: {},
|
|
displayOptions: {
|
|
show: {
|
|
resource: [
|
|
'ticket',
|
|
],
|
|
operation: [
|
|
'update',
|
|
],
|
|
},
|
|
},
|
|
options: [
|
|
{
|
|
displayName: 'Company Ids',
|
|
name: 'associatedCompanyIds',
|
|
type: 'multiOptions',
|
|
typeOptions: {
|
|
loadOptionsMethod: 'getCompanies',
|
|
},
|
|
default: [],
|
|
description: 'Companies associated with the ticket.',
|
|
},
|
|
{
|
|
displayName: 'Contact Ids',
|
|
name: 'associatedContactIds',
|
|
type: 'multiOptions',
|
|
typeOptions: {
|
|
loadOptionsMethod: 'getContacts',
|
|
},
|
|
default: [],
|
|
description: 'Contact associated with the ticket.',
|
|
},
|
|
{
|
|
displayName: 'Category',
|
|
name: 'category',
|
|
type: 'options',
|
|
typeOptions: {
|
|
loadOptionsMethod: 'getTicketCategories',
|
|
},
|
|
default: '',
|
|
description: 'Main reason customer reached out for help.',
|
|
},
|
|
{
|
|
displayName: 'Close Date',
|
|
name: 'closeDate',
|
|
type: 'dateTime',
|
|
default: '',
|
|
description: 'The date the ticket was closed.',
|
|
},
|
|
{
|
|
displayName: 'Create Date',
|
|
name: 'createDate',
|
|
type: 'dateTime',
|
|
default: '',
|
|
description: 'The date the ticket was created.',
|
|
},
|
|
{
|
|
displayName: 'Description',
|
|
name: 'description',
|
|
type: 'string',
|
|
typeOptions: {
|
|
alwaysOpenEditWindow: true,
|
|
},
|
|
default: '',
|
|
description: 'Description of the ticket',
|
|
},
|
|
{
|
|
displayName: 'Pipeline ID',
|
|
name: 'pipelineId',
|
|
type: 'options',
|
|
typeOptions: {
|
|
loadOptionsMethod: 'getTicketPipelines',
|
|
},
|
|
default: '',
|
|
description: 'The ID of the pipeline the ticket is in.',
|
|
},
|
|
{
|
|
displayName: 'Priority',
|
|
name: 'priority',
|
|
type: 'options',
|
|
typeOptions: {
|
|
loadOptionsMethod: 'getTicketPriorities',
|
|
},
|
|
default: '',
|
|
description: 'The level of attention needed on the ticket',
|
|
},
|
|
{
|
|
displayName: 'Resolution',
|
|
name: 'resolution',
|
|
type: 'options',
|
|
typeOptions: {
|
|
loadOptionsMethod: 'getTicketResolutions',
|
|
},
|
|
default: '',
|
|
description: 'The action taken to resolve the ticket',
|
|
},
|
|
{
|
|
displayName: 'Source',
|
|
name: 'source',
|
|
type: 'options',
|
|
typeOptions: {
|
|
loadOptionsMethod: 'getTicketSources',
|
|
},
|
|
default: '',
|
|
description: 'Channel where ticket was originally submitted.',
|
|
},
|
|
{
|
|
displayName: 'Ticket Name',
|
|
name: 'ticketName',
|
|
type: 'string',
|
|
default: '',
|
|
description: 'The ID of the pipeline the ticket is in. ',
|
|
},
|
|
{
|
|
displayName: 'Ticket Owner ID',
|
|
name: 'ticketOwnerId',
|
|
type: 'options',
|
|
typeOptions: {
|
|
loadOptionsMethod: 'getOwners',
|
|
},
|
|
default: '',
|
|
description: `The user from your team that the ticket is assigned to. You can assign additional users to a ticket record by creating a custom HubSpot user property`,
|
|
},
|
|
],
|
|
},
|
|
|
|
/* -------------------------------------------------------------------------- */
|
|
/* ticket:get */
|
|
/* -------------------------------------------------------------------------- */
|
|
{
|
|
displayName: 'Ticket ID',
|
|
name: 'ticketId',
|
|
type: 'string',
|
|
required: true,
|
|
displayOptions: {
|
|
show: {
|
|
resource: [
|
|
'ticket',
|
|
],
|
|
operation: [
|
|
'get',
|
|
],
|
|
},
|
|
},
|
|
default: '',
|
|
description: 'Unique identifier for a particular ticket',
|
|
},
|
|
{
|
|
displayName: 'Additional Fields',
|
|
name: 'additionalFields',
|
|
type: 'collection',
|
|
placeholder: 'Add Field',
|
|
default: {},
|
|
displayOptions: {
|
|
show: {
|
|
resource: [
|
|
'ticket',
|
|
],
|
|
operation: [
|
|
'get',
|
|
],
|
|
},
|
|
},
|
|
options: [
|
|
{
|
|
displayName: 'Include Deleted',
|
|
name: 'includeDeleted',
|
|
type: 'boolean',
|
|
default: false,
|
|
},
|
|
{
|
|
displayName: 'Properties',
|
|
name: 'properties',
|
|
type: 'multiOptions',
|
|
typeOptions: {
|
|
loadOptionsMethod: 'getTicketProperties',
|
|
},
|
|
default: [],
|
|
description: `<p>Used to include specific ticket properties in the results. By default, the results will only include ticket ID and will not include the values for any properties for your tickets.</p><p>Including this parameter will include the data for the specified property in the results. You can include this parameter multiple times to request multiple properties separated by a comma: <code>,</code>.</p>`,
|
|
},
|
|
{
|
|
displayName: 'Properties With History',
|
|
name: 'propertiesWithHistory',
|
|
type: 'string',
|
|
default: '',
|
|
description: `Works similarly to properties=, but this parameter will include the history for the specified property, instead of just including the current value. Use this parameter when you need the full history of changes to a property's value.`,
|
|
},
|
|
],
|
|
},
|
|
|
|
/* -------------------------------------------------------------------------- */
|
|
/* ticket:getAll */
|
|
/* -------------------------------------------------------------------------- */
|
|
{
|
|
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: 250,
|
|
},
|
|
default: 100,
|
|
description: 'How many results to return.',
|
|
},
|
|
{
|
|
displayName: 'Additional Fields',
|
|
name: 'additionalFields',
|
|
type: 'collection',
|
|
placeholder: 'Add Field',
|
|
default: {},
|
|
displayOptions: {
|
|
show: {
|
|
resource: [
|
|
'ticket',
|
|
],
|
|
operation: [
|
|
'getAll',
|
|
],
|
|
},
|
|
},
|
|
options: [
|
|
{
|
|
displayName: 'Properties',
|
|
name: 'properties',
|
|
type: 'multiOptions',
|
|
typeOptions: {
|
|
loadOptionsMethod: 'getTicketProperties',
|
|
},
|
|
default: [],
|
|
description: `<p>Used to include specific ticket properties in the results. By default, the results will only include ticket ID and will not include the values for any properties for your company.</p><p>Including this parameter will include the data for the specified property in the results. You can include this parameter multiple times to request multiple properties separated by a comma: <code>,</code>.</p>`,
|
|
},
|
|
{
|
|
displayName: 'Properties With History',
|
|
name: 'propertiesWithHistory',
|
|
type: 'string',
|
|
default: '',
|
|
description: `Works similarly to properties=, but this parameter will include the history for the specified property, instead of just including the current value. Use this parameter when you need the full history of changes to a property's value.`,
|
|
},
|
|
],
|
|
},
|
|
|
|
/* -------------------------------------------------------------------------- */
|
|
/* ticket:delete */
|
|
/* -------------------------------------------------------------------------- */
|
|
{
|
|
displayName: 'Ticket ID',
|
|
name: 'ticketId',
|
|
type: 'string',
|
|
required: true,
|
|
displayOptions: {
|
|
show: {
|
|
resource: [
|
|
'ticket',
|
|
],
|
|
operation: [
|
|
'delete',
|
|
],
|
|
},
|
|
},
|
|
default: '',
|
|
description: 'Unique identifier for a particular ticket',
|
|
},
|
|
] as INodeProperties[];
|