mirror of
https://github.com/n8n-io/n8n.git
synced 2024-09-21 15:27:32 -07:00
6f95121fac
* 👕 Add `action` to `INodePropertyOptions` * 👕 Apply `node-param-operation-option-without-action` * ✏️ Fix add/remove phrasing * ✏️ Fix email template phrasing * ✏️ Fix add/remove phrasing * ✏️ Fix custom fields phrasing * ✏️ Fix job report phrasing * ✏️ Fix query phrasing * ✏️ Various phrasing fixes * ✏️ Fix final phrasings * ✏️ Remove `conversation` * ✏️ Fix plural
892 lines
16 KiB
TypeScript
892 lines
16 KiB
TypeScript
import {
|
|
INodeProperties,
|
|
} from 'n8n-workflow';
|
|
|
|
export const memberOperations: INodeProperties[] = [
|
|
{
|
|
displayName: 'Operation',
|
|
name: 'operation',
|
|
type: 'options',
|
|
noDataExpression: true,
|
|
displayOptions: {
|
|
show: {
|
|
resource: [
|
|
'member',
|
|
],
|
|
},
|
|
},
|
|
options: [
|
|
{
|
|
name: 'Create or Update',
|
|
value: 'upsert',
|
|
description: 'Create a new member, or update the current one if it already exists (upsert)',
|
|
action: 'Create or update a member',
|
|
},
|
|
{
|
|
name: 'Delete',
|
|
value: 'delete',
|
|
description: 'Delete a member',
|
|
action: 'Delete a member',
|
|
},
|
|
{
|
|
name: 'Get',
|
|
value: 'get',
|
|
description: 'Get a member',
|
|
action: 'Get a member',
|
|
},
|
|
{
|
|
name: 'Get All',
|
|
value: 'getAll',
|
|
description: 'Get all members in a workspace',
|
|
action: 'Get all members',
|
|
},
|
|
{
|
|
name: 'Lookup',
|
|
value: 'lookup',
|
|
description: 'Lookup a member by identity',
|
|
action: 'Lookup a member',
|
|
},
|
|
{
|
|
name: 'Update',
|
|
value: 'update',
|
|
description: 'Update a member',
|
|
action: 'Update a member',
|
|
},
|
|
],
|
|
default: 'get',
|
|
},
|
|
];
|
|
|
|
export const memberFields: INodeProperties[] = [
|
|
|
|
/* -------------------------------------------------------------------------- */
|
|
/* member:delete */
|
|
/* -------------------------------------------------------------------------- */
|
|
{
|
|
displayName: 'Workspace Name or ID',
|
|
name: 'workspaceId',
|
|
type: 'options',
|
|
description: 'Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/nodes/expressions.html#expressions">expression</a>',
|
|
typeOptions: {
|
|
loadOptionsMethod: 'getWorkspaces',
|
|
},
|
|
default: '',
|
|
required: true,
|
|
displayOptions: {
|
|
show: {
|
|
resource: [
|
|
'member',
|
|
],
|
|
operation: [
|
|
'delete',
|
|
],
|
|
},
|
|
},
|
|
},
|
|
{
|
|
displayName: 'Member ID',
|
|
name: 'memberId',
|
|
type: 'string',
|
|
default: '',
|
|
required: true,
|
|
displayOptions: {
|
|
show: {
|
|
resource: [
|
|
'member',
|
|
],
|
|
operation: [
|
|
'delete',
|
|
],
|
|
},
|
|
},
|
|
},
|
|
|
|
|
|
/* -------------------------------------------------------------------------- */
|
|
/* member:get */
|
|
/* -------------------------------------------------------------------------- */
|
|
{
|
|
displayName: 'Workspace Name or ID',
|
|
name: 'workspaceId',
|
|
type: 'options',
|
|
description: 'Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/nodes/expressions.html#expressions">expression</a>',
|
|
typeOptions: {
|
|
loadOptionsMethod: 'getWorkspaces',
|
|
},
|
|
default: '',
|
|
required: true,
|
|
displayOptions: {
|
|
show: {
|
|
resource: [
|
|
'member',
|
|
],
|
|
operation: [
|
|
'get',
|
|
],
|
|
},
|
|
},
|
|
},
|
|
{
|
|
displayName: 'Member ID',
|
|
name: 'memberId',
|
|
type: 'string',
|
|
default: '',
|
|
required: true,
|
|
displayOptions: {
|
|
show: {
|
|
resource: [
|
|
'member',
|
|
],
|
|
operation: [
|
|
'get',
|
|
],
|
|
},
|
|
},
|
|
},
|
|
{
|
|
displayName: 'Resolve Identities',
|
|
name: 'resolveIdentities',
|
|
type: 'boolean',
|
|
displayOptions: {
|
|
show: {
|
|
operation: [
|
|
'get',
|
|
],
|
|
resource: [
|
|
'member',
|
|
],
|
|
},
|
|
},
|
|
default: false,
|
|
// eslint-disable-next-line n8n-nodes-base/node-param-description-boolean-without-whether
|
|
description: 'By default, the response just includes the reference of the identity. When set to true the identities will be resolved automatically.',
|
|
},
|
|
|
|
/* -------------------------------------------------------------------------- */
|
|
/* member:getAll */
|
|
/* -------------------------------------------------------------------------- */
|
|
{
|
|
displayName: 'Workspace Name or ID',
|
|
name: 'workspaceId',
|
|
type: 'options',
|
|
description: 'Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/nodes/expressions.html#expressions">expression</a>',
|
|
typeOptions: {
|
|
loadOptionsMethod: 'getWorkspaces',
|
|
},
|
|
default: '',
|
|
required: true,
|
|
displayOptions: {
|
|
show: {
|
|
resource: [
|
|
'member',
|
|
],
|
|
operation: [
|
|
'getAll',
|
|
],
|
|
},
|
|
},
|
|
},
|
|
{
|
|
displayName: 'Return All',
|
|
name: 'returnAll',
|
|
type: 'boolean',
|
|
displayOptions: {
|
|
show: {
|
|
operation: [
|
|
'getAll',
|
|
],
|
|
resource: [
|
|
'member',
|
|
],
|
|
},
|
|
},
|
|
default: false,
|
|
description: 'Whether to return all results or only up to a given limit',
|
|
},
|
|
{
|
|
displayName: 'Limit',
|
|
name: 'limit',
|
|
type: 'number',
|
|
displayOptions: {
|
|
show: {
|
|
operation: [
|
|
'getAll',
|
|
],
|
|
resource: [
|
|
'member',
|
|
],
|
|
returnAll: [
|
|
false,
|
|
],
|
|
},
|
|
},
|
|
typeOptions: {
|
|
minValue: 1,
|
|
maxValue: 500,
|
|
},
|
|
default: 100,
|
|
description: 'Max number of results to return',
|
|
},
|
|
{
|
|
displayName: 'Resolve Identities',
|
|
name: 'resolveIdentities',
|
|
type: 'boolean',
|
|
displayOptions: {
|
|
show: {
|
|
operation: [
|
|
'getAll',
|
|
],
|
|
resource: [
|
|
'member',
|
|
],
|
|
},
|
|
},
|
|
default: false,
|
|
// eslint-disable-next-line n8n-nodes-base/node-param-description-boolean-without-whether
|
|
description: 'By default, the response just includes the reference of the identity. When set to true the identities will be resolved automatically.',
|
|
},
|
|
{
|
|
displayName: 'Options',
|
|
name: 'options',
|
|
type: 'collection',
|
|
placeholder: 'Add Option',
|
|
default: {},
|
|
displayOptions: {
|
|
show: {
|
|
resource: [
|
|
'member',
|
|
],
|
|
operation: [
|
|
'getAll',
|
|
],
|
|
},
|
|
},
|
|
options: [
|
|
{
|
|
displayName: 'Sort By',
|
|
name: 'sort',
|
|
type: 'string',
|
|
default: '',
|
|
description: 'Name of the field the response will be sorted by',
|
|
},
|
|
{
|
|
displayName: 'Sort Direction',
|
|
name: 'direction',
|
|
type: 'options',
|
|
options: [
|
|
{
|
|
name: 'ASC',
|
|
value: 'ASC',
|
|
},
|
|
{
|
|
name: 'DESC',
|
|
value: 'DESC',
|
|
},
|
|
],
|
|
default: '',
|
|
},
|
|
],
|
|
},
|
|
|
|
/* -------------------------------------------------------------------------- */
|
|
/* member:lookup */
|
|
/* -------------------------------------------------------------------------- */
|
|
{
|
|
displayName: 'Workspace Name or ID',
|
|
name: 'workspaceId',
|
|
type: 'options',
|
|
description: 'Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/nodes/expressions.html#expressions">expression</a>',
|
|
typeOptions: {
|
|
loadOptionsMethod: 'getWorkspaces',
|
|
},
|
|
default: '',
|
|
required: true,
|
|
displayOptions: {
|
|
show: {
|
|
resource: [
|
|
'member',
|
|
],
|
|
operation: [
|
|
'lookup',
|
|
],
|
|
},
|
|
},
|
|
},
|
|
{
|
|
displayName: 'Source',
|
|
name: 'source',
|
|
type: 'options',
|
|
options: [
|
|
{
|
|
name: 'Discourse',
|
|
value: 'discourse',
|
|
},
|
|
{
|
|
name: 'Email',
|
|
value: 'email',
|
|
},
|
|
{
|
|
name: 'GitHub',
|
|
value: 'github',
|
|
},
|
|
{
|
|
name: 'Twitter',
|
|
value: 'twitter',
|
|
},
|
|
],
|
|
default: '',
|
|
required: true,
|
|
displayOptions: {
|
|
show: {
|
|
resource: [
|
|
'member',
|
|
],
|
|
operation: [
|
|
'lookup',
|
|
],
|
|
},
|
|
},
|
|
description: 'Set to github, twitter, email, discourse or the source of any identities you\'ve manually created',
|
|
},
|
|
{
|
|
displayName: 'Search By',
|
|
name: 'searchBy',
|
|
type: 'options',
|
|
options: [
|
|
{
|
|
name: 'Username',
|
|
value: 'username',
|
|
},
|
|
{
|
|
name: 'ID',
|
|
value: 'id',
|
|
},
|
|
],
|
|
default: '',
|
|
required: true,
|
|
displayOptions: {
|
|
show: {
|
|
resource: [
|
|
'member',
|
|
],
|
|
operation: [
|
|
'lookup',
|
|
],
|
|
source: [
|
|
'discourse',
|
|
'github',
|
|
'twitter',
|
|
],
|
|
},
|
|
},
|
|
},
|
|
{
|
|
displayName: 'ID',
|
|
name: 'id',
|
|
type: 'string',
|
|
default: '',
|
|
required: true,
|
|
displayOptions: {
|
|
show: {
|
|
resource: [
|
|
'member',
|
|
],
|
|
operation: [
|
|
'lookup',
|
|
],
|
|
searchBy: [
|
|
'id',
|
|
],
|
|
source: [
|
|
'discourse',
|
|
'github',
|
|
'twitter',
|
|
],
|
|
},
|
|
},
|
|
description: 'The username at the source',
|
|
},
|
|
{
|
|
displayName: 'Username',
|
|
name: 'username',
|
|
type: 'string',
|
|
default: '',
|
|
required: true,
|
|
displayOptions: {
|
|
show: {
|
|
resource: [
|
|
'member',
|
|
],
|
|
operation: [
|
|
'lookup',
|
|
],
|
|
searchBy: [
|
|
'username',
|
|
],
|
|
source: [
|
|
'discourse',
|
|
'github',
|
|
'twitter',
|
|
],
|
|
},
|
|
},
|
|
description: 'The username at the source',
|
|
},
|
|
{
|
|
displayName: 'Email',
|
|
name: 'email',
|
|
type: 'string',
|
|
placeholder: 'name@email.com',
|
|
default: '',
|
|
required: true,
|
|
displayOptions: {
|
|
show: {
|
|
resource: [
|
|
'member',
|
|
],
|
|
operation: [
|
|
'lookup',
|
|
],
|
|
source: [
|
|
'email',
|
|
],
|
|
},
|
|
},
|
|
description: 'The email address',
|
|
},
|
|
{
|
|
displayName: 'Host',
|
|
name: 'host',
|
|
type: 'string',
|
|
default: '',
|
|
required: true,
|
|
displayOptions: {
|
|
show: {
|
|
resource: [
|
|
'member',
|
|
],
|
|
operation: [
|
|
'lookup',
|
|
],
|
|
source: [
|
|
'discourse',
|
|
],
|
|
},
|
|
},
|
|
},
|
|
|
|
/* -------------------------------------------------------------------------- */
|
|
/* member:update */
|
|
/* -------------------------------------------------------------------------- */
|
|
{
|
|
displayName: 'Workspace Name or ID',
|
|
name: 'workspaceId',
|
|
type: 'options',
|
|
description: 'Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/nodes/expressions.html#expressions">expression</a>',
|
|
typeOptions: {
|
|
loadOptionsMethod: 'getWorkspaces',
|
|
},
|
|
default: '',
|
|
required: true,
|
|
displayOptions: {
|
|
show: {
|
|
resource: [
|
|
'member',
|
|
],
|
|
operation: [
|
|
'update',
|
|
],
|
|
},
|
|
},
|
|
},
|
|
{
|
|
displayName: 'Member ID',
|
|
name: 'memberId',
|
|
type: 'string',
|
|
default: '',
|
|
required: true,
|
|
displayOptions: {
|
|
show: {
|
|
resource: [
|
|
'member',
|
|
],
|
|
operation: [
|
|
'update',
|
|
],
|
|
},
|
|
},
|
|
},
|
|
{
|
|
displayName: 'Update Fields',
|
|
name: 'updateFields',
|
|
type: 'collection',
|
|
placeholder: 'Add Field',
|
|
displayOptions: {
|
|
show: {
|
|
resource: [
|
|
'member',
|
|
],
|
|
operation: [
|
|
'update',
|
|
],
|
|
},
|
|
},
|
|
default: {},
|
|
options: [
|
|
{
|
|
displayName: 'Bio',
|
|
name: 'bio',
|
|
type: 'string',
|
|
default: '',
|
|
},
|
|
{
|
|
displayName: 'Birthday',
|
|
name: 'birthday',
|
|
type: 'dateTime',
|
|
default: '',
|
|
},
|
|
{
|
|
displayName: 'Company',
|
|
name: 'company',
|
|
type: 'string',
|
|
default: '',
|
|
},
|
|
{
|
|
displayName: 'Location',
|
|
name: 'location',
|
|
type: 'string',
|
|
default: '',
|
|
},
|
|
{
|
|
displayName: 'Name',
|
|
name: 'name',
|
|
type: 'string',
|
|
default: '',
|
|
},
|
|
{
|
|
displayName: 'Pronouns',
|
|
name: 'pronouns',
|
|
type: 'string',
|
|
default: '',
|
|
},
|
|
{
|
|
displayName: 'Shipping Address',
|
|
name: 'shippingAddress',
|
|
type: 'string',
|
|
default: '',
|
|
},
|
|
{
|
|
displayName: 'Slug',
|
|
name: 'slug',
|
|
type: 'string',
|
|
default: '',
|
|
},
|
|
{
|
|
displayName: 'Tags to Add',
|
|
name: 'tagsToAdd',
|
|
type: 'string',
|
|
default: '',
|
|
description: 'Adds tags to member; comma-separated string or array',
|
|
},
|
|
{
|
|
displayName: 'Tag List',
|
|
name: 'tagList',
|
|
type: 'string',
|
|
default: '',
|
|
description: 'Replaces all tags for the member; comma-separated string or array',
|
|
},
|
|
{
|
|
displayName: 'T-Shirt',
|
|
name: 'tShirt',
|
|
type: 'string',
|
|
default: '',
|
|
},
|
|
{
|
|
displayName: 'Teammate',
|
|
name: 'teammate',
|
|
type: 'boolean',
|
|
default: false,
|
|
},
|
|
{
|
|
displayName: 'URL',
|
|
name: 'url',
|
|
type: 'string',
|
|
default: '',
|
|
},
|
|
],
|
|
},
|
|
|
|
/* -------------------------------------------------------------------------- */
|
|
/* member:upsert */
|
|
/* -------------------------------------------------------------------------- */
|
|
{
|
|
displayName: 'Workspace Name or ID',
|
|
name: 'workspaceId',
|
|
type: 'options',
|
|
description: 'Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/nodes/expressions.html#expressions">expression</a>',
|
|
typeOptions: {
|
|
loadOptionsMethod: 'getWorkspaces',
|
|
},
|
|
default: '',
|
|
required: true,
|
|
displayOptions: {
|
|
show: {
|
|
resource: [
|
|
'member',
|
|
],
|
|
operation: [
|
|
'upsert',
|
|
],
|
|
},
|
|
},
|
|
},
|
|
{
|
|
displayName: 'Identity',
|
|
name: 'identityUi',
|
|
type: 'fixedCollection',
|
|
description: 'The identity is used to find the member. If no member exists, a new member will be created and linked to the provided identity.',
|
|
typeOptions: {
|
|
multipleValues: false,
|
|
},
|
|
placeholder: 'Add Identity',
|
|
default: {},
|
|
displayOptions: {
|
|
show: {
|
|
resource: [
|
|
'member',
|
|
],
|
|
operation: [
|
|
'upsert',
|
|
],
|
|
},
|
|
},
|
|
options: [
|
|
{
|
|
displayName: 'Identity',
|
|
name: 'identityValue',
|
|
values: [
|
|
{
|
|
displayName: 'Source',
|
|
name: 'source',
|
|
type: 'options',
|
|
options: [
|
|
{
|
|
name: 'Discourse',
|
|
value: 'discourse',
|
|
},
|
|
{
|
|
name: 'Email',
|
|
value: 'email',
|
|
},
|
|
{
|
|
name: 'GitHub',
|
|
value: 'github',
|
|
},
|
|
{
|
|
name: 'Twitter',
|
|
value: 'twitter',
|
|
},
|
|
],
|
|
default: '',
|
|
description: 'Set to github, twitter, email, discourse or the source of any identities you\'ve manually created',
|
|
},
|
|
{
|
|
displayName: 'Search By',
|
|
name: 'searchBy',
|
|
type: 'options',
|
|
options: [
|
|
{
|
|
name: 'Username',
|
|
value: 'username',
|
|
},
|
|
{
|
|
name: 'ID',
|
|
value: 'id',
|
|
},
|
|
],
|
|
default: '',
|
|
required: true,
|
|
displayOptions: {
|
|
show: {
|
|
source: [
|
|
'discourse',
|
|
'github',
|
|
'twitter',
|
|
],
|
|
},
|
|
},
|
|
},
|
|
{
|
|
displayName: 'ID',
|
|
name: 'id',
|
|
type: 'string',
|
|
default: '',
|
|
required: true,
|
|
displayOptions: {
|
|
show: {
|
|
searchBy: [
|
|
'id',
|
|
],
|
|
source: [
|
|
'discourse',
|
|
'github',
|
|
'twitter',
|
|
],
|
|
},
|
|
},
|
|
description: 'The username at the source',
|
|
},
|
|
{
|
|
displayName: 'Username',
|
|
name: 'username',
|
|
type: 'string',
|
|
default: '',
|
|
required: true,
|
|
displayOptions: {
|
|
show: {
|
|
searchBy: [
|
|
'username',
|
|
],
|
|
source: [
|
|
'discourse',
|
|
'github',
|
|
'twitter',
|
|
],
|
|
},
|
|
},
|
|
description: 'The username at the source',
|
|
},
|
|
{
|
|
displayName: 'Email',
|
|
name: 'email',
|
|
type: 'string',
|
|
placeholder: 'name@email.com',
|
|
default: '',
|
|
required: true,
|
|
displayOptions: {
|
|
show: {
|
|
source: [
|
|
'email',
|
|
],
|
|
},
|
|
},
|
|
},
|
|
{
|
|
displayName: 'Host',
|
|
name: 'host',
|
|
type: 'string',
|
|
default: '',
|
|
required: true,
|
|
displayOptions: {
|
|
show: {
|
|
source: [
|
|
'discourse',
|
|
],
|
|
},
|
|
},
|
|
},
|
|
],
|
|
},
|
|
],
|
|
},
|
|
{
|
|
displayName: 'Additional Fields',
|
|
name: 'additionalFields',
|
|
type: 'collection',
|
|
placeholder: 'Add Field',
|
|
displayOptions: {
|
|
show: {
|
|
resource: [
|
|
'member',
|
|
],
|
|
operation: [
|
|
'upsert',
|
|
],
|
|
},
|
|
},
|
|
default: {},
|
|
options: [
|
|
{
|
|
displayName: 'Bio',
|
|
name: 'bio',
|
|
type: 'string',
|
|
default: '',
|
|
},
|
|
{
|
|
displayName: 'Birthday',
|
|
name: 'birthday',
|
|
type: 'dateTime',
|
|
default: '',
|
|
},
|
|
{
|
|
displayName: 'Company',
|
|
name: 'company',
|
|
type: 'string',
|
|
default: '',
|
|
},
|
|
{
|
|
displayName: 'Location',
|
|
name: 'location',
|
|
type: 'string',
|
|
default: '',
|
|
},
|
|
{
|
|
displayName: 'Name',
|
|
name: 'name',
|
|
type: 'string',
|
|
default: '',
|
|
},
|
|
{
|
|
displayName: 'Pronouns',
|
|
name: 'pronouns',
|
|
type: 'string',
|
|
default: '',
|
|
},
|
|
{
|
|
displayName: 'Shipping Address',
|
|
name: 'shippingAddress',
|
|
type: 'string',
|
|
default: '',
|
|
},
|
|
{
|
|
displayName: 'Slug',
|
|
name: 'slug',
|
|
type: 'string',
|
|
default: '',
|
|
},
|
|
{
|
|
displayName: 'Tags to Add',
|
|
name: 'tagsToAdd',
|
|
type: 'string',
|
|
default: '',
|
|
description: 'Adds tags to member; comma-separated string or array',
|
|
},
|
|
{
|
|
displayName: 'Tag List',
|
|
name: 'tagList',
|
|
type: 'string',
|
|
default: '',
|
|
description: 'Replaces all tags for the member; comma-separated string or array',
|
|
},
|
|
{
|
|
displayName: 'T-Shirt',
|
|
name: 'tShirt',
|
|
type: 'string',
|
|
default: '',
|
|
},
|
|
{
|
|
displayName: 'Teammate',
|
|
name: 'teammate',
|
|
type: 'boolean',
|
|
default: false,
|
|
},
|
|
{
|
|
displayName: 'URL',
|
|
name: 'url',
|
|
type: 'string',
|
|
default: '',
|
|
},
|
|
],
|
|
},
|
|
];
|