n8n/packages/nodes-base/nodes/CustomerIo/EventDescription.ts

253 lines
5.3 KiB
TypeScript
Raw Normal View History

import { INodeProperties } from 'n8n-workflow';
export const eventOperations: INodeProperties[] = [
{
displayName: 'Operation',
name: 'operation',
type: 'options',
refactor: Apply more nodelinting rules (#3324) * :pencil2: Alphabetize lint rules * :fire: Remove duplicates * :zap: Update `lintfix` script * :shirt: Apply `node-param-operation-without-no-data-expression` (#3329) * :shirt: Apply `node-param-operation-without-no-data-expression` * :shirt: Add exceptions * :shirt: Apply `node-param-description-weak` (#3328) Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * :shirt: Apply `node-param-option-value-duplicate` (#3331) * :shirt: Apply `node-param-description-miscased-json` (#3337) * :shirt: Apply `node-param-display-name-excess-inner-whitespace` (#3335) Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * :shirt: Apply `node-param-type-options-missing-from-limit` (#3336) * Rule workig as intended * :pencil2: Uncomment rules Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * :shirt: Apply `node-param-option-name-duplicate` (#3338) Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * :shirt: Apply `node-param-description-wrong-for-simplify` (#3334) * :zap: fix * :zap: exceptions * :zap: changed rule ignoring from file to line * :shirt: Apply `node-param-resource-without-no-data-expression` (#3339) * :shirt: Apply `node-param-display-name-untrimmed` (#3341) * :shirt: Apply `node-param-display-name-miscased-id` (#3340) Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * :shirt: Apply `node-param-resource-with-plural-option` (#3342) * :shirt: Apply `node-param-description-wrong-for-upsert` (#3333) * :zap: fix * :zap: replaced record with contact in description * :zap: fix Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * :shirt: Apply `node-param-option-description-identical-to-name` (#3343) * :shirt: Apply `node-param-option-name-containing-star` (#3347) * :shirt: Apply `node-param-display-name-wrong-for-update-fields` (#3348) * :shirt: Apply `node-param-option-name-wrong-for-get-all` (#3345) * :zap: fix * :zap: exceptions * :shirt: Apply node-param-display-name-wrong-for-simplify (#3344) * Rule working as intended * Uncomented other rules * :shirt: Undo and add exceptions Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * :zap: Alphabetize lint rules * :zap: Restore `lintfix` script Co-authored-by: Michael Kret <88898367+michael-radency@users.noreply.github.com> Co-authored-by: agobrech <45268029+agobrech@users.noreply.github.com>
2022-05-20 14:47:24 -07:00
noDataExpression: true,
displayOptions: {
show: {
resource: ['event'],
},
},
options: [
{
name: 'Track',
value: 'track',
description: 'Track a customer event',
action: 'Track a customer event',
},
{
name: 'Track Anonymous',
value: 'trackAnonymous',
description: 'Track an anonymous event',
action: 'Track an anonymous event',
},
],
default: 'track',
},
];
export const eventFields: INodeProperties[] = [
/* -------------------------------------------------------------------------- */
/* event:track */
/* -------------------------------------------------------------------------- */
{
displayName: 'Customer ID',
name: 'customerId',
type: 'string',
required: true,
default: '',
displayOptions: {
show: {
resource: ['event'],
operation: ['track'],
},
},
description: 'The unique identifier for the customer',
},
{
displayName: 'Event Name',
name: 'eventName',
type: 'string',
default: '',
displayOptions: {
show: {
resource: ['event'],
operation: ['track'],
},
},
description: 'Name of the event to track',
},
{
displayName: 'JSON Parameters',
name: 'jsonParameters',
type: 'boolean',
default: false,
displayOptions: {
show: {
resource: ['event'],
operation: ['track'],
},
},
},
{
displayName: 'Additional Fields',
name: 'additionalFieldsJson',
type: 'json',
typeOptions: {
alwaysOpenEditWindow: true,
},
default: '',
displayOptions: {
show: {
resource: ['event'],
operation: ['track'],
jsonParameters: [true],
},
},
description:
'Object of values to set as described <a href="https://customer.io/docs/api-triggered-data-format#basic-data-formatting">here</a>',
},
{
displayName: 'Additional Fields',
name: 'additionalFields',
type: 'collection',
placeholder: 'Add Field',
default: {},
displayOptions: {
show: {
resource: ['event'],
operation: ['track'],
jsonParameters: [false],
},
},
options: [
{
displayName: 'Custom Attributes',
name: 'customAttributes',
type: 'fixedCollection',
default: {},
description: 'Custom Properties',
typeOptions: {
multipleValues: true,
},
options: [
{
displayName: 'Attribute',
name: 'customAttribute',
values: [
{
displayName: 'Key',
name: 'key',
type: 'string',
required: true,
default: '',
description: 'Attribute name',
placeholder: 'Price',
},
{
displayName: 'Value',
name: 'value',
type: 'string',
required: true,
default: '',
description: 'Attribute value',
placeholder: '25.50',
},
],
},
2020-10-22 06:46:03 -07:00
],
},
{
displayName: 'Type',
name: 'type',
type: 'string',
default: '',
description: 'Used to change event type. For Page View events set to "page".',
},
],
},
/* -------------------------------------------------------------------------- */
/* event:track anonymous */
/* -------------------------------------------------------------------------- */
{
displayName: 'Event Name',
name: 'eventName',
type: 'string',
required: true,
default: '',
displayOptions: {
show: {
resource: ['event'],
operation: ['trackAnonymous'],
},
},
description: 'The unique identifier for the customer',
},
{
displayName: 'JSON Parameters',
name: 'jsonParameters',
type: 'boolean',
default: false,
displayOptions: {
show: {
resource: ['event'],
operation: ['trackAnonymous'],
},
},
},
{
displayName: 'Additional Fields',
name: 'additionalFieldsJson',
type: 'json',
typeOptions: {
alwaysOpenEditWindow: true,
},
default: '',
displayOptions: {
show: {
resource: ['event'],
operation: ['trackAnonymous'],
jsonParameters: [true],
},
},
description:
'Object of values to set as described <a href="https://customer.io/docs/api-triggered-data-format#basic-data-formatting">here</a>',
},
{
displayName: 'Additional Fields',
name: 'additionalFields',
type: 'collection',
placeholder: 'Add Field',
default: {},
displayOptions: {
show: {
resource: ['event'],
operation: ['trackAnonymous'],
jsonParameters: [false],
},
},
options: [
{
displayName: 'Custom Attributes',
name: 'customAttributes',
type: 'fixedCollection',
default: {},
description: 'Custom Properties',
typeOptions: {
multipleValues: true,
},
options: [
{
displayName: 'Attribute',
name: 'customAttribute',
values: [
{
displayName: 'Key',
name: 'key',
type: 'string',
required: true,
default: '',
description: 'Attribute name',
placeholder: 'Price',
},
{
displayName: 'Value',
name: 'value',
type: 'string',
required: true,
default: '',
description: 'Attribute value',
placeholder: '25.50',
},
],
},
2020-10-22 06:46:03 -07:00
],
},
],
},
];