mirror of
https://github.com/n8n-io/n8n.git
synced 2024-11-10 14:44:05 -08:00
0448feec56
* ⚡ Initial setup
* 👕 Update `.eslintignore`
* 👕 Autofix node-param-default-missing (#3173)
* 🔥 Remove duplicate key
* 👕 Add exceptions
* 📦 Update package-lock.json
* 👕 Apply `node-class-description-inputs-wrong-trigger-node` (#3176)
* 👕 Apply `node-class-description-inputs-wrong-regular-node` (#3177)
* 👕 Apply `node-class-description-outputs-wrong` (#3178)
* 👕 Apply `node-execute-block-double-assertion-for-items` (#3179)
* 👕 Apply `node-param-default-wrong-for-collection` (#3180)
* 👕 Apply node-param-default-wrong-for-boolean (#3181)
* Autofixed default missing
* Autofixed booleans, worked well
* ⚡ Fix params
* ⏪ Undo exempted autofixes
* 📦 Update package-lock.json
* 👕 Apply node-class-description-missing-subtitle (#3182)
* ⚡ Fix missing comma
* 👕 Apply `node-param-default-wrong-for-fixed-collection` (#3184)
* 👕 Add exception for `node-class-description-missing-subtitle`
* 👕 Apply `node-param-default-wrong-for-multi-options` (#3185)
* 👕 Apply `node-param-collection-type-unsorted-items` (#3186)
* Missing coma
* 👕 Apply `node-param-default-wrong-for-simplify` (#3187)
* 👕 Apply `node-param-description-comma-separated-hyphen` (#3190)
* 👕 Apply `node-param-description-empty-string` (#3189)
* 👕 Apply `node-param-description-excess-inner-whitespace` (#3191)
* Rule looks good
* Add whitespace rule in eslint config
* :zao: fix
* 👕 Apply `node-param-description-identical-to-display-name` (#3193)
* 👕 Apply `node-param-description-missing-for-ignore-ssl-issues` (#3195)
* ⏪ Revert ":zao: fix"
This reverts commit ef8a76f3df.
* 👕 Apply `node-param-description-missing-for-simplify` (#3196)
* 👕 Apply `node-param-description-missing-final-period` (#3194)
* Rule working as intended
* Add rule to eslint
* 👕 Apply node-param-description-missing-for-return-all (#3197)
* ⚡ Restore `lintfix` command
Co-authored-by: agobrech <45268029+agobrech@users.noreply.github.com>
Co-authored-by: Omar Ajoue <krynble@gmail.com>
Co-authored-by: agobrech <ael.gobrecht@gmail.com>
Co-authored-by: Michael Kret <michael.k@radency.com>
720 lines
16 KiB
TypeScript
720 lines
16 KiB
TypeScript
import { INodeProperties } from 'n8n-workflow';
|
||
|
||
export const caseOperations: INodeProperties[] = [
|
||
{
|
||
displayName: 'Operation',
|
||
name: 'operation',
|
||
type: 'options',
|
||
displayOptions: {
|
||
show: {
|
||
resource: [
|
||
'case',
|
||
],
|
||
},
|
||
},
|
||
options: [
|
||
{
|
||
name: 'Add Comment',
|
||
value: 'addComment',
|
||
description: 'Add a comment to a case',
|
||
},
|
||
{
|
||
name: 'Create',
|
||
value: 'create',
|
||
description: 'Create a case',
|
||
},
|
||
{
|
||
name: 'Get',
|
||
value: 'get',
|
||
description: 'Get a case',
|
||
},
|
||
{
|
||
name: 'Get All',
|
||
value: 'getAll',
|
||
description: 'Get all cases',
|
||
},
|
||
{
|
||
name: 'Get Summary',
|
||
value: 'getSummary',
|
||
description: `Returns an overview of case's metadata`,
|
||
},
|
||
{
|
||
name: 'Delete',
|
||
value: 'delete',
|
||
description: 'Delete a case',
|
||
},
|
||
{
|
||
name: 'Update',
|
||
value: 'update',
|
||
description: 'Update a case',
|
||
},
|
||
],
|
||
default: 'create',
|
||
description: 'The operation to perform.',
|
||
},
|
||
];
|
||
|
||
export const caseFields: INodeProperties[] = [
|
||
|
||
/* -------------------------------------------------------------------------- */
|
||
/* case:create */
|
||
/* -------------------------------------------------------------------------- */
|
||
{
|
||
displayName: 'Type',
|
||
name: 'type',
|
||
type: 'options',
|
||
required: true,
|
||
typeOptions: {
|
||
loadOptionsMethod: 'getCaseTypes',
|
||
},
|
||
displayOptions: {
|
||
show: {
|
||
resource: [
|
||
'case',
|
||
],
|
||
operation: [
|
||
'create',
|
||
],
|
||
},
|
||
},
|
||
default: '',
|
||
description: 'The type of case',
|
||
},
|
||
{
|
||
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 ID',
|
||
name: 'fieldId',
|
||
type: 'options',
|
||
typeOptions: {
|
||
loadOptionsMethod: 'getCustomFields',
|
||
},
|
||
default: '',
|
||
description: 'The ID of the field to add custom field to.',
|
||
},
|
||
{
|
||
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: 'Indicates whether the case has been escalated (true) or not.',
|
||
},
|
||
{
|
||
displayName: 'Origin',
|
||
name: 'origin',
|
||
type: 'options',
|
||
typeOptions: {
|
||
loadOptionsMethod: 'getCaseOrigins',
|
||
},
|
||
default: '',
|
||
description: 'The source of the case, such as Email, Phone, or Web. Label is Case Origin.',
|
||
},
|
||
{
|
||
displayName: 'Owner',
|
||
name: 'owner',
|
||
type: 'options',
|
||
typeOptions: {
|
||
loadOptionsMethod: 'getCaseOwners',
|
||
},
|
||
default: '',
|
||
description: 'The owner of the case.',
|
||
},
|
||
{
|
||
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: 'priority',
|
||
type: 'options',
|
||
typeOptions: {
|
||
loadOptionsMethod: 'getCasePriorities',
|
||
},
|
||
default: '',
|
||
description: 'The importance or urgency of the case, such as High, Medium, or Low.',
|
||
},
|
||
{
|
||
displayName: 'Reason',
|
||
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.',
|
||
},
|
||
{
|
||
displayName: 'Record Type ID',
|
||
name: 'recordTypeId',
|
||
type: 'options',
|
||
typeOptions: {
|
||
loadOptionsMethod: 'getRecordTypes',
|
||
},
|
||
default: '',
|
||
},
|
||
{
|
||
displayName: 'Status',
|
||
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',
|
||
},
|
||
{
|
||
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 ID',
|
||
name: 'fieldId',
|
||
type: 'options',
|
||
typeOptions: {
|
||
loadOptionsMethod: 'getCustomFields',
|
||
},
|
||
default: '',
|
||
description: 'The ID of the field to add custom field to.',
|
||
},
|
||
{
|
||
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: 'Indicates whether the case has been escalated (true) or not.',
|
||
},
|
||
{
|
||
displayName: 'Origin',
|
||
name: 'origin',
|
||
type: 'options',
|
||
typeOptions: {
|
||
loadOptionsMethod: 'getCaseOrigins',
|
||
},
|
||
default: '',
|
||
description: 'The source of the case, such as Email, Phone, or Web. Label is Case Origin.',
|
||
},
|
||
{
|
||
displayName: 'Owner',
|
||
name: 'owner',
|
||
type: 'options',
|
||
typeOptions: {
|
||
loadOptionsMethod: 'getCaseOwners',
|
||
},
|
||
default: '',
|
||
description: 'The owner of the case.',
|
||
},
|
||
{
|
||
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: 'priority',
|
||
type: 'options',
|
||
typeOptions: {
|
||
loadOptionsMethod: 'getCasePriorities',
|
||
},
|
||
default: '',
|
||
description: 'The importance or urgency of the case, such as High, Medium, or Low.',
|
||
},
|
||
{
|
||
displayName: 'Reason',
|
||
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.',
|
||
},
|
||
{
|
||
displayName: 'Record Type ID',
|
||
name: 'recordTypeId',
|
||
type: 'options',
|
||
typeOptions: {
|
||
loadOptionsMethod: 'getRecordTypes',
|
||
},
|
||
default: '',
|
||
},
|
||
{
|
||
displayName: 'Status',
|
||
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',
|
||
},
|
||
{
|
||
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: 'type',
|
||
type: 'options',
|
||
typeOptions: {
|
||
loadOptionsMethod: 'getCaseTypes',
|
||
},
|
||
default: '',
|
||
description: 'The type of case',
|
||
},
|
||
],
|
||
},
|
||
|
||
/* -------------------------------------------------------------------------- */
|
||
/* 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: 'If all results should be returned 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: 'How many 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: 'field',
|
||
type: 'options',
|
||
typeOptions: {
|
||
loadOptionsMethod: 'getCaseFields',
|
||
},
|
||
default: '',
|
||
description: 'For date, number, or boolean, please use expressions.',
|
||
},
|
||
{
|
||
displayName: 'Operation',
|
||
name: 'operation',
|
||
type: 'options',
|
||
options: [
|
||
{
|
||
name: '=',
|
||
value: 'equal',
|
||
},
|
||
{
|
||
name: '>',
|
||
value: '>',
|
||
},
|
||
{
|
||
name: '<',
|
||
value: '<',
|
||
},
|
||
{
|
||
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: 'Indicates whether the CaseComment is visible to customers in the Self-Service portal (true) or not (false). ',
|
||
},
|
||
],
|
||
},
|
||
];
|