n8n/packages/nodes-base/nodes/Vero/UserDescription.ts

376 lines
7.2 KiB
TypeScript
Raw Normal View History

2019-12-17 12:33:28 -08:00
import { INodeProperties } from 'n8n-workflow';
export const userOperations: INodeProperties[] = [
2019-12-17 12:33:28 -08:00
{
displayName: 'Operation',
name: 'operation',
type: 'options',
displayOptions: {
show: {
resource: [
'user',
],
},
},
options: [
{
name: 'Create/Update',
value: 'create',
description: `Create or update a user profile`,
2019-12-17 12:33:28 -08:00
},
{
name: 'Alias',
value: 'alias',
description: 'Change a users identifier',
2019-12-17 12:33:28 -08:00
},
{
name: 'Unsubscribe',
value: 'unsubscribe',
description: 'Unsubscribe a user.',
2019-12-17 12:33:28 -08:00
},
{
name: 'Re-subscribe',
value: 'resubscribe',
description: 'Resubscribe a user.',
2019-12-17 12:33:28 -08:00
},
{
name: 'Delete',
value: 'delete',
description: 'Delete a user.',
2019-12-17 12:33:28 -08:00
},
{
name: 'Add Tags',
value: 'addTags',
description: 'Adds a tag to a users profile.',
2019-12-17 12:33:28 -08:00
},
{
name: 'Remove Tags',
value: 'removeTags',
description: 'Removes a tag from a users profile.',
2019-12-17 12:33:28 -08:00
},
],
default: 'create',
description: 'The operation to perform.',
},
];
2019-12-17 12:33:28 -08:00
export const userFields: INodeProperties[] = [
2019-12-17 12:33:28 -08:00
/* -------------------------------------------------------------------------- */
/* user:create */
/* -------------------------------------------------------------------------- */
{
displayName: 'ID',
name: 'id',
type: 'string',
required: true,
default: '',
displayOptions: {
show: {
resource: [
'user',
],
operation: [
'create',
2020-10-22 06:46:03 -07:00
],
2019-12-17 12:33:28 -08:00
},
},
description: 'The unique identifier of the customer',
},
{
displayName: 'JSON Parameters',
name: 'jsonParameters',
type: 'boolean',
default: false,
description: '',
displayOptions: {
show: {
resource: [
'user',
],
operation: [
'create',
2020-10-22 06:46:03 -07:00
],
2019-12-17 12:33:28 -08:00
},
2020-10-22 06:46:03 -07:00
},
2019-12-17 12:33:28 -08:00
},
{
displayName: 'Additional Fields',
name: 'additionalFields',
type: 'collection',
placeholder: 'Add Field',
default: {},
displayOptions: {
show: {
resource: [
'user',
],
operation: [
'create',
],
},
},
options: [
{
displayName: 'Email',
name: 'email',
type: 'string',
default: '',
description: 'The table to create the row in.',
},
2020-10-22 06:46:03 -07:00
],
2019-12-17 12:33:28 -08:00
},
{
displayName: 'Data',
name: 'dataAttributesUi',
placeholder: 'Add Data',
description: 'key value pairs that represent the custom user properties you want to update',
type: 'fixedCollection',
typeOptions: {
multipleValues: true,
},
default: {},
displayOptions: {
show: {
resource: [
'user',
],
operation: [
'create',
],
jsonParameters: [
2019-12-19 20:33:37 -08:00
false,
2019-12-17 12:33:28 -08:00
],
},
},
options: [
{
name: 'dataAttributesValues',
displayName: 'Data',
values: [
{
displayName: 'Key',
name: 'key',
type: 'string',
default: '',
description: 'Name of the property to set.',
},
{
displayName: 'Value',
name: 'value',
type: 'string',
default: '',
description: 'Value of the property to set.',
},
2020-10-22 06:46:03 -07:00
],
2019-12-17 12:33:28 -08:00
},
],
},
{
displayName: 'Data',
name: 'dataAttributesJson',
type: 'json',
default: '',
required: false,
typeOptions: {
alwaysOpenEditWindow: true,
},
description: 'key value pairs that represent the custom user properties you want to update',
displayOptions: {
show: {
resource: [
'user',
],
operation: [
'create',
],
jsonParameters: [
true,
],
},
},
},
/* -------------------------------------------------------------------------- */
/* user:alias */
/* -------------------------------------------------------------------------- */
{
displayName: 'ID',
name: 'id',
type: 'string',
required: true,
default: '',
displayOptions: {
show: {
resource: [
'user',
],
operation: [
'alias',
2020-10-22 06:46:03 -07:00
],
2019-12-17 12:33:28 -08:00
},
},
description: 'The old unique identifier of the user',
},
{
displayName: 'New ID',
name: 'newId',
type: 'string',
required: true,
default: '',
displayOptions: {
show: {
resource: [
'user',
],
operation: [
'alias',
2020-10-22 06:46:03 -07:00
],
2019-12-17 12:33:28 -08:00
},
},
description: 'The new unique identifier of the user',
},
/* -------------------------------------------------------------------------- */
/* user:unsubscribe */
/* -------------------------------------------------------------------------- */
{
displayName: 'ID',
name: 'id',
type: 'string',
required: true,
default: '',
displayOptions: {
show: {
resource: [
'user',
],
operation: [
'unsubscribe',
2020-10-22 06:46:03 -07:00
],
2019-12-17 12:33:28 -08:00
},
},
description: 'The unique identifier of the user',
},
/* -------------------------------------------------------------------------- */
/* user:resubscribe */
/* -------------------------------------------------------------------------- */
{
displayName: 'ID',
name: 'id',
type: 'string',
required: true,
default: '',
displayOptions: {
show: {
resource: [
'user',
],
operation: [
'resubscribe',
2020-10-22 06:46:03 -07:00
],
2019-12-17 12:33:28 -08:00
},
},
description: 'The unique identifier of the user',
},
/* -------------------------------------------------------------------------- */
/* user:delete */
/* -------------------------------------------------------------------------- */
{
displayName: 'ID',
name: 'id',
type: 'string',
required: true,
default: '',
displayOptions: {
show: {
resource: [
'user',
],
operation: [
'delete',
2020-10-22 06:46:03 -07:00
],
2019-12-17 12:33:28 -08:00
},
},
description: 'The unique identifier of the user',
},
/* -------------------------------------------------------------------------- */
/* user:addTags */
/* -------------------------------------------------------------------------- */
{
displayName: 'ID',
name: 'id',
type: 'string',
required: true,
default: '',
displayOptions: {
show: {
resource: [
'user',
],
operation: [
'addTags',
2020-10-22 06:46:03 -07:00
],
2019-12-17 12:33:28 -08:00
},
},
description: 'The unique identifier of the user',
},
{
displayName: 'Tags',
name: 'tags',
type: 'string',
required: true,
default: '',
displayOptions: {
show: {
resource: [
'user',
],
operation: [
'addTags',
2020-10-22 06:46:03 -07:00
],
2019-12-17 12:33:28 -08:00
},
},
2019-12-19 20:33:37 -08:00
description: 'Tags to add separated by ","',
2019-12-17 12:33:28 -08:00
},
/* -------------------------------------------------------------------------- */
/* user:removeTags */
/* -------------------------------------------------------------------------- */
{
displayName: 'ID',
name: 'id',
type: 'string',
required: true,
default: '',
displayOptions: {
show: {
resource: [
'user',
],
operation: [
'removeTags',
2020-10-22 06:46:03 -07:00
],
2019-12-17 12:33:28 -08:00
},
},
description: 'The unique identifier of the user',
},
{
displayName: 'Tags',
name: 'tags',
type: 'string',
required: true,
default: '',
displayOptions: {
show: {
resource: [
'user',
],
operation: [
'removeTags',
2020-10-22 06:46:03 -07:00
],
2019-12-17 12:33:28 -08:00
},
},
2019-12-19 20:33:37 -08:00
description: 'Tags to remove separated by ","',
2019-12-17 12:33:28 -08:00
},
];