mirror of
https://github.com/n8n-io/n8n.git
synced 2024-11-14 00:24:07 -08:00
708 lines
18 KiB
TypeScript
708 lines
18 KiB
TypeScript
import { INodeProperties } from 'n8n-workflow';
|
||
|
||
export const caseOperations: INodeProperties[] = [
|
||
{
|
||
displayName: 'Operation',
|
||
name: 'operation',
|
||
type: 'options',
|
||
noDataExpression: true,
|
||
displayOptions: {
|
||
show: {
|
||
resource: ['case'],
|
||
},
|
||
},
|
||
options: [
|
||
{
|
||
name: 'Add Comment',
|
||
value: 'addComment',
|
||
description: 'Add a comment to a case',
|
||
action: 'Add a comment to a case',
|
||
},
|
||
{
|
||
name: 'Create',
|
||
value: 'create',
|
||
description: 'Create a case',
|
||
action: 'Create a case',
|
||
},
|
||
{
|
||
name: 'Delete',
|
||
value: 'delete',
|
||
description: 'Delete a case',
|
||
action: 'Delete a case',
|
||
},
|
||
{
|
||
name: 'Get',
|
||
value: 'get',
|
||
description: 'Get a case',
|
||
action: 'Get a case',
|
||
},
|
||
{
|
||
name: 'Get All',
|
||
value: 'getAll',
|
||
description: 'Get all cases',
|
||
action: 'Get all cases',
|
||
},
|
||
{
|
||
name: 'Get Summary',
|
||
value: 'getSummary',
|
||
description: "Returns an overview of case's metadata",
|
||
action: 'Get a case summary',
|
||
},
|
||
{
|
||
name: 'Update',
|
||
value: 'update',
|
||
description: 'Update a case',
|
||
action: 'Update a case',
|
||
},
|
||
],
|
||
default: 'create',
|
||
},
|
||
];
|
||
|
||
export const caseFields: INodeProperties[] = [
|
||
/* -------------------------------------------------------------------------- */
|
||
/* case:create */
|
||
/* -------------------------------------------------------------------------- */
|
||
{
|
||
displayName: 'Type Name or ID',
|
||
name: 'type',
|
||
type: 'options',
|
||
required: true,
|
||
typeOptions: {
|
||
loadOptionsMethod: 'getCaseTypes',
|
||
},
|
||
displayOptions: {
|
||
show: {
|
||
resource: ['case'],
|
||
operation: ['create'],
|
||
},
|
||
},
|
||
default: '',
|
||
description:
|
||
'The type of case. Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code-examples/expressions/">expression</a>.',
|
||
},
|
||
{
|
||
displayName: 'Additional Fields',
|
||
name: 'additionalFields',
|
||
type: 'collection',
|
||
placeholder: 'Add Field',
|
||
default: {},
|
||
displayOptions: {
|
||
show: {
|
||
resource: ['case'],
|
||
operation: ['create'],
|
||
},
|
||
},
|
||
options: [
|
||
{
|
||
displayName: 'Account ID',
|
||
name: 'accountId',
|
||
type: 'string',
|
||
default: '',
|
||
description: 'ID of the account associated with this case',
|
||
},
|
||
{
|
||
displayName: 'Contact ID',
|
||
name: 'contactId',
|
||
type: 'string',
|
||
default: '',
|
||
description: 'ID of the associated Contact',
|
||
},
|
||
{
|
||
displayName: 'Custom Fields',
|
||
name: 'customFieldsUi',
|
||
placeholder: 'Add Custom Field',
|
||
type: 'fixedCollection',
|
||
typeOptions: {
|
||
multipleValues: true,
|
||
},
|
||
description: 'Filter by custom fields',
|
||
default: {},
|
||
options: [
|
||
{
|
||
name: 'customFieldsValues',
|
||
displayName: 'Custom Field',
|
||
values: [
|
||
{
|
||
displayName: 'Field Name or ID',
|
||
name: 'fieldId',
|
||
type: 'options',
|
||
typeOptions: {
|
||
loadOptionsMethod: 'getCustomFields',
|
||
},
|
||
default: '',
|
||
description:
|
||
'The ID of the field to add custom field to. Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code-examples/expressions/">expression</a>.',
|
||
},
|
||
{
|
||
displayName: 'Value',
|
||
name: 'value',
|
||
type: 'string',
|
||
default: '',
|
||
description: 'The value to set on custom field',
|
||
},
|
||
],
|
||
},
|
||
],
|
||
},
|
||
{
|
||
displayName: 'Description',
|
||
name: 'description',
|
||
type: 'string',
|
||
default: '',
|
||
description: 'A text description of the case. Limit: 32 KB.',
|
||
},
|
||
{
|
||
displayName: 'Is Escalated',
|
||
name: 'isEscalated',
|
||
type: 'boolean',
|
||
default: false,
|
||
description: 'Whether indicates whether the case has been escalated (true) or not',
|
||
},
|
||
{
|
||
displayName: 'Origin Name or ID',
|
||
name: 'origin',
|
||
type: 'options',
|
||
typeOptions: {
|
||
loadOptionsMethod: 'getCaseOrigins',
|
||
},
|
||
default: '',
|
||
description:
|
||
'The source of the case, such as Email, Phone, or Web. Label is Case Origin. Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code-examples/expressions/">expression</a>.',
|
||
},
|
||
{
|
||
displayName: 'Owner Name or ID',
|
||
name: 'owner',
|
||
type: 'options',
|
||
typeOptions: {
|
||
loadOptionsMethod: 'getCaseOwners',
|
||
},
|
||
default: '',
|
||
description:
|
||
'The owner of the case. Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code-examples/expressions/">expression</a>.',
|
||
},
|
||
{
|
||
displayName: 'Parent ID',
|
||
name: 'ParentId',
|
||
type: 'string',
|
||
default: '',
|
||
description: 'The ID of the parent case in the hierarchy. The label is Parent Case.',
|
||
},
|
||
{
|
||
displayName: 'Priority Name or ID',
|
||
name: 'priority',
|
||
type: 'options',
|
||
typeOptions: {
|
||
loadOptionsMethod: 'getCasePriorities',
|
||
},
|
||
default: '',
|
||
description:
|
||
'The importance or urgency of the case, such as High, Medium, or Low. Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code-examples/expressions/">expression</a>.',
|
||
},
|
||
{
|
||
displayName: 'Reason Name or ID',
|
||
name: 'reason',
|
||
type: 'options',
|
||
typeOptions: {
|
||
loadOptionsMethod: 'getCaseReasons',
|
||
},
|
||
default: '',
|
||
description:
|
||
'The reason why the case was created, such as Instructions not clear, or User didn’t attend training. Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code-examples/expressions/">expression</a>.',
|
||
},
|
||
{
|
||
displayName: 'Record Type Name or ID',
|
||
name: 'recordTypeId',
|
||
type: 'options',
|
||
description:
|
||
'Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code-examples/expressions/">expression</a>',
|
||
typeOptions: {
|
||
loadOptionsMethod: 'getRecordTypes',
|
||
},
|
||
default: '',
|
||
},
|
||
{
|
||
displayName: 'Status Name or ID',
|
||
name: 'status',
|
||
type: 'options',
|
||
typeOptions: {
|
||
loadOptionsMethod: 'getCaseStatuses',
|
||
},
|
||
default: '',
|
||
description:
|
||
'The status of the case, such as “New,” “Closed,” or “Escalated.” This field directly controls the IsClosed flag. Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code-examples/expressions/">expression</a>.',
|
||
},
|
||
{
|
||
displayName: 'Subject',
|
||
name: 'subject',
|
||
type: 'string',
|
||
default: '',
|
||
description: 'The subject of the case. Limit: 255 characters.',
|
||
},
|
||
{
|
||
displayName: 'Supplied Company',
|
||
name: 'suppliedCompany',
|
||
type: 'string',
|
||
default: '',
|
||
description:
|
||
"The company name that was entered when the case was created. This field can't be updated after the case has been created..",
|
||
},
|
||
{
|
||
displayName: 'Supplied Email',
|
||
name: 'suppliedEmail',
|
||
type: 'string',
|
||
default: '',
|
||
description:
|
||
"The email address that was entered when the case was created. This field can't be updated after the case has been created.",
|
||
},
|
||
{
|
||
displayName: 'Supplied Name',
|
||
name: 'suppliedName',
|
||
type: 'string',
|
||
default: '',
|
||
description:
|
||
"The name that was entered when the case was created. This field can't be updated after the case has been created.",
|
||
},
|
||
{
|
||
displayName: 'Supplied Phone',
|
||
name: 'suppliedPhone',
|
||
type: 'string',
|
||
default: '',
|
||
description:
|
||
"The phone number that was entered when the case was created. This field can't be updated after the case has been created.",
|
||
},
|
||
],
|
||
},
|
||
|
||
/* -------------------------------------------------------------------------- */
|
||
/* case:update */
|
||
/* -------------------------------------------------------------------------- */
|
||
{
|
||
displayName: 'Case ID',
|
||
name: 'caseId',
|
||
type: 'string',
|
||
required: true,
|
||
default: '',
|
||
displayOptions: {
|
||
show: {
|
||
resource: ['case'],
|
||
operation: ['update'],
|
||
},
|
||
},
|
||
description: 'ID of case that needs to be fetched',
|
||
},
|
||
{
|
||
displayName: 'Update Fields',
|
||
name: 'updateFields',
|
||
type: 'collection',
|
||
placeholder: 'Add Field',
|
||
default: {},
|
||
displayOptions: {
|
||
show: {
|
||
resource: ['case'],
|
||
operation: ['update'],
|
||
},
|
||
},
|
||
options: [
|
||
{
|
||
displayName: 'Account ID',
|
||
name: 'accountId',
|
||
type: 'string',
|
||
default: '',
|
||
description: 'ID of the account associated with this case',
|
||
},
|
||
{
|
||
displayName: 'Contact ID',
|
||
name: 'contactId',
|
||
type: 'string',
|
||
default: '',
|
||
description: 'ID of the associated Contact',
|
||
},
|
||
{
|
||
displayName: 'Custom Fields',
|
||
name: 'customFieldsUi',
|
||
placeholder: 'Add Custom Field',
|
||
type: 'fixedCollection',
|
||
typeOptions: {
|
||
multipleValues: true,
|
||
},
|
||
description: 'Filter by custom fields',
|
||
default: {},
|
||
options: [
|
||
{
|
||
name: 'customFieldsValues',
|
||
displayName: 'Custom Field',
|
||
values: [
|
||
{
|
||
displayName: 'Field Name or ID',
|
||
name: 'fieldId',
|
||
type: 'options',
|
||
typeOptions: {
|
||
loadOptionsMethod: 'getCustomFields',
|
||
},
|
||
default: '',
|
||
description:
|
||
'The ID of the field to add custom field to. Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code-examples/expressions/">expression</a>.',
|
||
},
|
||
{
|
||
displayName: 'Value',
|
||
name: 'value',
|
||
type: 'string',
|
||
default: '',
|
||
description: 'The value to set on custom field',
|
||
},
|
||
],
|
||
},
|
||
],
|
||
},
|
||
{
|
||
displayName: 'Description',
|
||
name: 'description',
|
||
type: 'string',
|
||
default: '',
|
||
description: 'A text description of the case. Limit: 32 KB.',
|
||
},
|
||
{
|
||
displayName: 'Is Escalated',
|
||
name: 'isEscalated',
|
||
type: 'boolean',
|
||
default: false,
|
||
description: 'Whether the case has been escalated (true) or not',
|
||
},
|
||
{
|
||
displayName: 'Origin Name or ID',
|
||
name: 'origin',
|
||
type: 'options',
|
||
typeOptions: {
|
||
loadOptionsMethod: 'getCaseOrigins',
|
||
},
|
||
default: '',
|
||
description:
|
||
'The source of the case, such as Email, Phone, or Web. Label is Case Origin. Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code-examples/expressions/">expression</a>.',
|
||
},
|
||
{
|
||
displayName: 'Owner Name or ID',
|
||
name: 'owner',
|
||
type: 'options',
|
||
typeOptions: {
|
||
loadOptionsMethod: 'getCaseOwners',
|
||
},
|
||
default: '',
|
||
description:
|
||
'The owner of the case. Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code-examples/expressions/">expression</a>.',
|
||
},
|
||
{
|
||
displayName: 'Parent ID',
|
||
name: 'ParentId',
|
||
type: 'string',
|
||
default: '',
|
||
description: 'The ID of the parent case in the hierarchy. The label is Parent Case.',
|
||
},
|
||
{
|
||
displayName: 'Priority Name or ID',
|
||
name: 'priority',
|
||
type: 'options',
|
||
typeOptions: {
|
||
loadOptionsMethod: 'getCasePriorities',
|
||
},
|
||
default: '',
|
||
description:
|
||
'The importance or urgency of the case, such as High, Medium, or Low. Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code-examples/expressions/">expression</a>.',
|
||
},
|
||
{
|
||
displayName: 'Reason Name or ID',
|
||
name: 'reason',
|
||
type: 'options',
|
||
typeOptions: {
|
||
loadOptionsMethod: 'getCaseReasons',
|
||
},
|
||
default: '',
|
||
description:
|
||
'The reason why the case was created, such as Instructions not clear, or User didn’t attend training. Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code-examples/expressions/">expression</a>.',
|
||
},
|
||
{
|
||
displayName: 'Record Type Name or ID',
|
||
name: 'recordTypeId',
|
||
type: 'options',
|
||
description:
|
||
'Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code-examples/expressions/">expression</a>',
|
||
typeOptions: {
|
||
loadOptionsMethod: 'getRecordTypes',
|
||
},
|
||
default: '',
|
||
},
|
||
{
|
||
displayName: 'Status Name or ID',
|
||
name: 'status',
|
||
type: 'options',
|
||
typeOptions: {
|
||
loadOptionsMethod: 'getCaseStatuses',
|
||
},
|
||
default: '',
|
||
description:
|
||
'The status of the case, such as “New,” “Closed,” or “Escalated.” This field directly controls the IsClosed flag. Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code-examples/expressions/">expression</a>.',
|
||
},
|
||
{
|
||
displayName: 'Subject',
|
||
name: 'subject',
|
||
type: 'string',
|
||
default: '',
|
||
description: 'The subject of the case. Limit: 255 characters.',
|
||
},
|
||
{
|
||
displayName: 'Supplied Company',
|
||
name: 'suppliedCompany',
|
||
type: 'string',
|
||
default: '',
|
||
description:
|
||
"The company name that was entered when the case was created. This field can't be updated after the case has been created..",
|
||
},
|
||
{
|
||
displayName: 'Supplied Email',
|
||
name: 'suppliedEmail',
|
||
type: 'string',
|
||
default: '',
|
||
description:
|
||
"The email address that was entered when the case was created. This field can't be updated after the case has been created.",
|
||
},
|
||
{
|
||
displayName: 'Supplied Name',
|
||
name: 'suppliedName',
|
||
type: 'string',
|
||
default: '',
|
||
description:
|
||
"The name that was entered when the case was created. This field can't be updated after the case has been created.",
|
||
},
|
||
{
|
||
displayName: 'Supplied Phone',
|
||
name: 'suppliedPhone',
|
||
type: 'string',
|
||
default: '',
|
||
description:
|
||
"The phone number that was entered when the case was created. This field can't be updated after the case has been created.",
|
||
},
|
||
{
|
||
displayName: 'Type Name or ID',
|
||
name: 'type',
|
||
type: 'options',
|
||
typeOptions: {
|
||
loadOptionsMethod: 'getCaseTypes',
|
||
},
|
||
default: '',
|
||
description:
|
||
'The type of case. Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code-examples/expressions/">expression</a>.',
|
||
},
|
||
],
|
||
},
|
||
|
||
/* -------------------------------------------------------------------------- */
|
||
/* case:get */
|
||
/* -------------------------------------------------------------------------- */
|
||
{
|
||
displayName: 'Case ID',
|
||
name: 'caseId',
|
||
type: 'string',
|
||
required: true,
|
||
default: '',
|
||
displayOptions: {
|
||
show: {
|
||
resource: ['case'],
|
||
operation: ['get'],
|
||
},
|
||
},
|
||
description: 'ID of case that needs to be fetched',
|
||
},
|
||
|
||
/* -------------------------------------------------------------------------- */
|
||
/* case:delete */
|
||
/* -------------------------------------------------------------------------- */
|
||
{
|
||
displayName: 'Case ID',
|
||
name: 'caseId',
|
||
type: 'string',
|
||
required: true,
|
||
default: '',
|
||
displayOptions: {
|
||
show: {
|
||
resource: ['case'],
|
||
operation: ['delete'],
|
||
},
|
||
},
|
||
description: 'ID of case that needs to be fetched',
|
||
},
|
||
|
||
/* -------------------------------------------------------------------------- */
|
||
/* case:getAll */
|
||
/* -------------------------------------------------------------------------- */
|
||
{
|
||
displayName: 'Return All',
|
||
name: 'returnAll',
|
||
type: 'boolean',
|
||
displayOptions: {
|
||
show: {
|
||
resource: ['case'],
|
||
operation: ['getAll'],
|
||
},
|
||
},
|
||
default: false,
|
||
description: 'Whether to return all results or only up to a given limit',
|
||
},
|
||
{
|
||
displayName: 'Limit',
|
||
name: 'limit',
|
||
type: 'number',
|
||
displayOptions: {
|
||
show: {
|
||
resource: ['case'],
|
||
operation: ['getAll'],
|
||
returnAll: [false],
|
||
},
|
||
},
|
||
typeOptions: {
|
||
minValue: 1,
|
||
maxValue: 100,
|
||
},
|
||
default: 50,
|
||
description: 'Max number of results to return',
|
||
},
|
||
{
|
||
displayName: 'Options',
|
||
name: 'options',
|
||
type: 'collection',
|
||
placeholder: 'Add Field',
|
||
default: {},
|
||
displayOptions: {
|
||
show: {
|
||
resource: ['case'],
|
||
operation: ['getAll'],
|
||
},
|
||
},
|
||
options: [
|
||
{
|
||
displayName: 'Conditions',
|
||
name: 'conditionsUi',
|
||
placeholder: 'Add Condition',
|
||
type: 'fixedCollection',
|
||
typeOptions: {
|
||
multipleValues: true,
|
||
},
|
||
description: 'The condition to set',
|
||
default: {},
|
||
options: [
|
||
{
|
||
name: 'conditionValues',
|
||
displayName: 'Condition',
|
||
values: [
|
||
{
|
||
displayName: 'Field Name or ID',
|
||
name: 'field',
|
||
type: 'options',
|
||
typeOptions: {
|
||
loadOptionsMethod: 'getCaseFields',
|
||
},
|
||
default: '',
|
||
description:
|
||
'For date, number, or boolean, please use expressions. Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code-examples/expressions/">expression</a>.',
|
||
},
|
||
// eslint-disable-next-line n8n-nodes-base/node-param-operation-without-no-data-expression
|
||
{
|
||
displayName: 'Operation',
|
||
name: 'operation',
|
||
type: 'options',
|
||
options: [
|
||
{
|
||
name: '<',
|
||
value: '<',
|
||
},
|
||
{
|
||
name: '<=',
|
||
value: '<=',
|
||
},
|
||
{
|
||
name: '=',
|
||
value: 'equal',
|
||
},
|
||
{
|
||
name: '>',
|
||
value: '>',
|
||
},
|
||
{
|
||
name: '>=',
|
||
value: '>=',
|
||
},
|
||
],
|
||
default: 'equal',
|
||
},
|
||
{
|
||
displayName: 'Value',
|
||
name: 'value',
|
||
type: 'string',
|
||
default: '',
|
||
},
|
||
],
|
||
},
|
||
],
|
||
},
|
||
{
|
||
displayName: 'Fields',
|
||
name: 'fields',
|
||
type: 'string',
|
||
default: '',
|
||
description: 'Fields to include separated by ,',
|
||
},
|
||
],
|
||
},
|
||
|
||
/* -------------------------------------------------------------------------- */
|
||
/* case:addComment */
|
||
/* -------------------------------------------------------------------------- */
|
||
{
|
||
displayName: 'Case ID',
|
||
name: 'caseId',
|
||
type: 'string',
|
||
required: true,
|
||
default: '',
|
||
displayOptions: {
|
||
show: {
|
||
resource: ['case'],
|
||
operation: ['addComment'],
|
||
},
|
||
},
|
||
description: 'ID of case that needs to be fetched',
|
||
},
|
||
{
|
||
displayName: 'Options',
|
||
name: 'options',
|
||
type: 'collection',
|
||
placeholder: 'Add Field',
|
||
default: {},
|
||
displayOptions: {
|
||
show: {
|
||
resource: ['case'],
|
||
operation: ['addComment'],
|
||
},
|
||
},
|
||
options: [
|
||
{
|
||
displayName: 'Comment Body',
|
||
name: 'commentBody',
|
||
type: 'string',
|
||
typeOptions: {
|
||
alwaysOpenEditWindow: true,
|
||
},
|
||
default: '',
|
||
description:
|
||
'Text of the CaseComment. The maximum size of the comment body is 4,000 bytes. Label is Body.',
|
||
},
|
||
{
|
||
displayName: 'Is Published',
|
||
name: 'isPublished',
|
||
type: 'boolean',
|
||
default: false,
|
||
description:
|
||
'Whether the CaseComment is visible to customers in the Self-Service portal (true) or not (false)',
|
||
},
|
||
],
|
||
},
|
||
];
|