n8n/packages/nodes-base/nodes/HelpScout/ThreadDescription.ts

298 lines
5.3 KiB
TypeScript
Raw Normal View History

2020-03-29 10:10:54 -07:00
import { INodeProperties } from 'n8n-workflow';
2020-03-16 19:02:48 -07:00
export const threadOperations = [
{
displayName: 'Operation',
name: 'operation',
type: 'options',
displayOptions: {
show: {
resource: [
'thread',
],
},
},
options: [
{
name: 'Create',
value: 'create',
description: 'Create a new chat thread',
},
{
name: 'Get All',
value: 'getAll',
description: 'Get all chat threads',
},
],
default: 'create',
description: 'The operation to perform.',
},
] as INodeProperties[];
export const threadFields = [
/* -------------------------------------------------------------------------- */
/* thread:create */
/* -------------------------------------------------------------------------- */
{
displayName: 'Conversation ID',
name: 'conversationId',
type: 'string',
default: '',
required: true,
displayOptions: {
show: {
resource: [
'thread',
],
operation: [
'create',
],
},
},
description: 'conversation ID',
},
{
displayName: 'Type',
name: 'type',
type: 'options',
required: true,
displayOptions: {
show: {
resource: [
'thread',
],
operation: [
'create',
],
},
},
options: [
{
name: 'Chat',
2020-10-22 06:46:03 -07:00
value: 'chat',
2020-03-16 19:02:48 -07:00
},
{
name: 'Customer',
2020-10-22 06:46:03 -07:00
value: 'customer',
2020-03-16 19:02:48 -07:00
},
{
name: 'Note',
2020-10-22 06:46:03 -07:00
value: 'note',
2020-03-16 19:02:48 -07:00
},
{
name: 'Phone',
2020-10-22 06:46:03 -07:00
value: 'phone',
2020-03-16 19:02:48 -07:00
},
{
name: 'Reply',
2020-10-22 06:46:03 -07:00
value: 'reply',
2020-03-16 19:02:48 -07:00
},
],
default: '',
},
{
displayName: 'Text',
name: 'text',
type: 'string',
default: '',
typeOptions: {
alwaysOpenEditWindow: true,
},
required: true,
displayOptions: {
show: {
resource: [
'thread',
],
operation: [
'create',
],
},
},
description: 'The chat text',
},
{
displayName: 'Additional Fields',
name: 'additionalFields',
type: 'collection',
placeholder: 'Add Field',
default: {},
displayOptions: {
show: {
operation: [
'create',
],
resource: [
'thread',
],
},
},
options: [
2020-03-29 10:10:54 -07:00
{
displayName: 'Created At',
name: 'createdAt',
type: 'dateTime',
default: '',
},
2020-03-16 19:02:48 -07:00
{
displayName: 'Customer Email',
name: 'customerEmail',
type: 'string',
default: '',
},
{
displayName: 'Customer ID',
name: 'customerId',
type: 'number',
default: 0,
},
{
displayName: 'Draft',
name: 'draft',
type: 'boolean',
default: false,
displayOptions: {
show: {
'/type': [
'note',
],
},
},
description: 'If set to true, a draft reply is created',
},
{
displayName: 'Imported',
name: 'imported',
type: 'boolean',
default: false,
description: 'When imported is set to true, no outgoing emails or notifications will be generated.',
},
2020-10-22 06:46:03 -07:00
],
2020-03-16 19:02:48 -07:00
},
{
displayName: 'Attachments',
name: 'attachmentsUi',
placeholder: 'Add Attachments',
type: 'fixedCollection',
typeOptions: {
multipleValues: true,
},
displayOptions: {
show: {
operation: [
'create',
],
resource: [
'thread',
],
},
},
options: [
{
name: 'attachmentsValues',
displayName: 'Attachments Values',
values: [
{
displayName: 'FileName',
name: 'fileName',
type: 'string',
default: '',
description: 'Attachments file name',
},
{
displayName: 'Mime Type',
name: 'mimeType',
type: 'string',
default: '',
description: 'Attachments mime type',
},
{
displayName: 'Data',
name: 'data',
type: 'string',
default: '',
placeholder: 'ZXhhbXBsZSBmaWxl',
description: 'Base64-encoded stream of data.',
},
],
},
{
name: 'attachmentsBinary',
displayName: 'Attachments Binary',
values: [
{
displayName: 'Property',
name: 'property',
type: 'string',
default: 'data',
description: 'Name of the binary properties which contain data which should be added to email as attachment',
},
],
},
],
default: '',
description: 'Array of supported attachments to add to the message.',
},
/* -------------------------------------------------------------------------- */
/* thread:getAll */
/* -------------------------------------------------------------------------- */
{
displayName: 'Conversation ID',
name: 'conversationId',
type: 'string',
default: '',
required: true,
displayOptions: {
show: {
resource: [
'thread',
],
operation: [
'getAll',
],
},
},
description: 'conversation ID',
},
2020-03-29 19:08:00 -07:00
{
displayName: 'Return All',
name: 'returnAll',
type: 'boolean',
displayOptions: {
show: {
operation: [
'getAll',
],
resource: [
'thread',
],
},
},
default: false,
description: 'If all results should be returned or only up to a given limit.',
},
{
displayName: 'Limit',
name: 'limit',
type: 'number',
displayOptions: {
show: {
operation: [
'getAll',
],
resource: [
'thread',
],
returnAll: [
false,
],
},
},
typeOptions: {
minValue: 1,
},
default: 50,
description: 'How many results to return.',
},
2020-03-16 19:02:48 -07:00
] as INodeProperties[];