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

297 lines
6.4 KiB
TypeScript
Raw Normal View History

import type { INodeProperties } from 'n8n-workflow';
2020-05-19 04:47:21 -07:00
export const userOperations: INodeProperties[] = [
2020-05-19 04:47:21 -07:00
{
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,
2020-05-19 04:47:21 -07:00
displayOptions: {
show: {
resource: ['user'],
2020-05-19 04:47:21 -07:00
},
},
options: [
2020-05-22 15:59:40 -07:00
{
2020-05-19 04:47:21 -07:00
name: 'Create',
value: 'create',
description: 'Create a user',
action: 'Create a user',
2020-05-19 04:47:21 -07:00
},
{
name: 'Deactivate',
value: 'deactivate',
description: 'Deactivate a user',
action: 'Deactivate a user',
2020-05-22 15:59:40 -07:00
},
{
2020-05-19 04:47:21 -07:00
name: 'Get',
value: 'get',
description: 'Get a user',
action: 'Get a user',
2020-05-22 15:59:40 -07:00
},
2020-05-19 04:47:21 -07:00
{
name: 'Get Many',
2020-05-19 04:47:21 -07:00
value: 'getAll',
description: 'Get many users',
action: 'Get many users',
2020-05-19 04:47:21 -07:00
},
2020-05-31 02:15:45 -07:00
{
name: 'Update',
value: 'update',
description: 'Update a user',
action: 'Update a user',
2020-05-31 02:15:45 -07:00
},
2020-05-19 04:47:21 -07:00
],
default: 'create',
},
];
2020-05-19 04:47:21 -07:00
export const userFields: INodeProperties[] = [
2020-05-22 15:59:40 -07:00
/* -------------------------------------------------------------------------- */
/* user:create */
/* -------------------------------------------------------------------------- */
2020-05-19 04:47:21 -07:00
{
displayName: 'Email',
name: 'email',
type: 'string',
refactor: Apply more `eslint-plugin-n8n-nodes-base` rules (#3534) * :zap: Update `lintfix` script * :zap: Run baseline `lintfix` * :fire: Remove unneeded exceptions (#3538) * :fire: Remove exceptions for `node-param-default-wrong-for-simplify` * :fire: Remove exceptions for `node-param-placeholder-miscased-id` * :zap: Update version * :shirt: Apply `node-param-placeholder-missing` (#3542) * :shirt: Apply `filesystem-wrong-cred-filename` (#3543) * :shirt: Apply `node-param-description-missing-from-dynamic-options` (#3545) Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * :shirt: Apply `node-class-description-empty-string` (#3546) * :shirt: Apply `node-class-description-icon-not-svg` (#3548) * :shirt: Apply `filesystem-wrong-node-filename` (#3549) Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * :shirt: Expand lintings to credentials (#3550) * :shirt: Apply `node-param-multi-options-type-unsorted-items` (#3552) * :zap: fix * :zap: Minor fixes Co-authored-by: Michael Kret <michael.k@radency.com> * :shirt: Apply `node-param-description-wrong-for-dynamic-multi-options` (#3541) * :zap: Add new lint rule, node-param-description-wrong-for-dynamic-multi-options * :zap: Fix with updated linting rules * :zap: Minor fixes Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * :shirt: Apply `node-param-description-boolean-without-whether` (#3553) * :zap: fix * Update packages/nodes-base/nodes/Clockify/ProjectDescription.ts Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * :shirt: Apply node-param-display-name-wrong-for-dynamic-multi-options (#3537) * :shirt: Add exceptions * :shirt: Add exception * :pencil2: Alphabetize rules * :zap: Restore `lintfix` command Co-authored-by: agobrech <45268029+agobrech@users.noreply.github.com> Co-authored-by: Omar Ajoue <krynble@gmail.com> Co-authored-by: Michael Kret <michael.k@radency.com> Co-authored-by: brianinoa <54530642+brianinoa@users.noreply.github.com> Co-authored-by: Michael Kret <88898367+michael-radency@users.noreply.github.com>
2022-06-20 07:54:01 -07:00
placeholder: 'name@email.com',
2020-05-19 04:47:21 -07:00
required: true,
displayOptions: {
show: {
resource: ['user'],
operation: ['create'],
2020-05-19 04:47:21 -07:00
},
},
default: '',
description: 'The email address of the new user',
2020-05-22 15:59:40 -07:00
},
{
2020-05-19 08:40:17 -07:00
displayName: 'Full Name',
name: 'fullName',
2020-05-19 04:47:21 -07:00
type: 'string',
required: true,
displayOptions: {
show: {
resource: ['user'],
operation: ['create'],
2020-05-19 04:47:21 -07:00
},
},
default: '',
description: 'The full name of the new user',
2020-05-22 15:59:40 -07:00
},
{
2020-05-19 08:40:17 -07:00
displayName: 'Password',
name: 'password',
2020-05-19 04:47:21 -07:00
type: 'string',
typeOptions: { password: true },
2020-05-19 04:47:21 -07:00
required: true,
displayOptions: {
show: {
resource: ['user'],
operation: ['create'],
2020-05-19 04:47:21 -07:00
},
},
default: '',
description: 'The password of the new user',
2020-05-22 15:59:40 -07:00
},
{
2020-05-19 04:47:21 -07:00
displayName: 'Short Name',
name: 'shortName',
2020-05-19 04:47:21 -07:00
type: 'string',
required: true,
displayOptions: {
show: {
resource: ['user'],
operation: ['create'],
2020-05-19 04:47:21 -07:00
},
},
default: '',
description: 'The short name of the new user. Not user-visible.',
2020-05-22 15:59:40 -07:00
},
/* -------------------------------------------------------------------------- */
/* user:get / getAll */
/* -------------------------------------------------------------------------- */
2020-05-19 04:47:21 -07:00
{
displayName: 'User ID',
name: 'userId',
type: 'string',
required: true,
displayOptions: {
show: {
resource: ['user'],
operation: ['get'],
2020-05-19 04:47:21 -07:00
},
},
default: '',
description: 'The ID of user to get',
2020-05-22 15:59:40 -07:00
},
{
displayName: 'Additional Fields',
name: 'additionalFields',
type: 'collection',
placeholder: 'Add Field',
default: {},
displayOptions: {
show: {
resource: ['user'],
operation: ['get', 'getAll'],
2020-05-22 15:59:40 -07:00
},
},
options: [
{
displayName: 'Client Gravatar',
name: 'clientGravatar',
type: 'boolean',
default: false,
description:
'Whether the client supports computing gravatars URLs. If enabled, avatar_url will be included in the response only if there is a Zulip avatar, and will be null for users who are using gravatar as their avatar.',
2020-05-22 15:59:40 -07:00
},
{
displayName: 'Custom Profile Fields',
name: 'includeCustomProfileFields',
type: 'boolean',
default: false,
description:
'Whether the client wants custom profile field data to be included in the response',
2020-05-22 15:59:40 -07:00
},
2020-10-22 06:46:03 -07:00
],
2020-05-22 15:59:40 -07:00
},
/* -------------------------------------------------------------------------- */
/* user:update */
/* -------------------------------------------------------------------------- */
{
displayName: 'User ID',
name: 'userId',
type: 'string',
required: true,
displayOptions: {
show: {
resource: ['user'],
operation: ['update'],
2020-05-22 15:59:40 -07:00
},
},
default: '',
description: 'The ID of user to update',
2020-05-22 15:59:40 -07:00
},
{
displayName: 'Additional Fields',
name: 'additionalFields',
type: 'collection',
placeholder: 'Add Field',
default: {},
displayOptions: {
show: {
resource: ['user'],
operation: ['update'],
2020-05-22 15:59:40 -07:00
},
},
options: [
{
displayName: 'Full Name',
name: 'fullName',
type: 'string',
default: '',
description: 'The users full name',
2020-05-22 15:59:40 -07:00
},
{
displayName: 'Is Admin',
name: 'isAdmin',
type: 'boolean',
default: false,
description: 'Whether the target user is an administrator',
2020-05-22 15:59:40 -07:00
},
{
displayName: 'Is Guest',
name: 'isGuest',
type: 'boolean',
default: false,
description: 'Whether the target user is a guest',
2020-05-22 15:59:40 -07:00
},
2020-05-19 04:47:21 -07:00
{
displayName: 'Profile Data',
name: 'profileData',
type: 'fixedCollection',
2020-05-22 15:59:40 -07:00
default: {},
description:
'A dictionary containing the to be updated custom profile field data for the user',
2020-05-19 04:47:21 -07:00
typeOptions: {
multipleValues: true,
},
options: [
{
displayName: 'Property',
name: 'property',
values: [
{
displayName: 'ID',
name: 'id',
type: 'string',
required: true,
default: '',
description: 'ID of custom profile data value',
2020-05-19 04:47:21 -07:00
},
{
displayName: 'Value',
name: 'value',
type: 'string',
default: '',
description: 'Value of custom profile data',
2020-10-22 06:46:03 -07:00
},
2020-05-19 04:47:21 -07:00
],
},
],
},
{
displayName: 'Role',
name: 'role',
type: 'options',
options: [
{
refactor: Apply more `eslint-plugin-n8n-nodes-base` autofixable rules (#3432) * :zap: Update `lintfix` script * :shirt: Remove unneeded lint exceptions * :shirt: Run baseline `lintfix` * :shirt: Apply `node-param-description-miscased-url` (#3441) * :shirt: Apply `rule node-param-placeholder-miscased-id` (#3443) Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * :shirt: Apply `node-param-option-name-wrong-for-upsert` (#3446) * :shirt: Apply `node-param-min-value-wrong-for-limit` (#3442) Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * Apply `node-param-display-name-wrong-for-dynamic-options` (#3454) * :hammer: fix * :zap: Fix `Assigned To` fields Co-authored-by: Michael Kret <michael.k@radency.com> * :shirt: Apply `rule node-param-default-wrong-for-number` (#3453) * :shirt: Apply `node-param-default-wrong-for-string` (#3452) Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * Apply `node-param-display-name-miscased` (#3449) * :hammer: fix * :hammer: exceptions * :zap: review fixes * :shirt: Apply `node-param-description-lowercase-first-char` (#3451) * :zap: fix * :zap: review fixes * :zap: fix Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * :shirt: Apply `node-param-description-wrong-for-dynamic-options` (#3456) * Rule working as intended * Add rule * :fire: Remove repetitions * :shirt: Add exceptions Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * :shirt: Small fix for `node-param-description-wrong-for-dynamic-options` * :shirt: Apply `node-param-default-wrong-for-fixed-collection` (#3460) * :shirt: Apply `node-param-description-line-break-html-tag` (#3462) * :shirt: Run baseline `lintfix` * :shirt: Apply `node-param-options-type-unsorted-items` (#3459) * :zap: fix * :hammer: exceptions * Add exception for Salesmate and Zoom Co-authored-by: Michael Kret <michael.k@radency.com> Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * :zap: Restore `lintfix` command Co-authored-by: Omar Ajoue <krynble@gmail.com> Co-authored-by: Michael Kret <88898367+michael-radency@users.noreply.github.com> Co-authored-by: agobrech <45268029+agobrech@users.noreply.github.com> Co-authored-by: Michael Kret <michael.k@radency.com> Co-authored-by: brianinoa <54530642+brianinoa@users.noreply.github.com>
2022-06-03 10:23:49 -07:00
name: 'Guest',
value: 600,
},
{
name: 'Member',
value: 400,
},
{
name: 'Organization Administrator',
value: 200,
},
{
name: 'Organization Moderator',
value: 300,
},
{
refactor: Apply more `eslint-plugin-n8n-nodes-base` autofixable rules (#3432) * :zap: Update `lintfix` script * :shirt: Remove unneeded lint exceptions * :shirt: Run baseline `lintfix` * :shirt: Apply `node-param-description-miscased-url` (#3441) * :shirt: Apply `rule node-param-placeholder-miscased-id` (#3443) Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * :shirt: Apply `node-param-option-name-wrong-for-upsert` (#3446) * :shirt: Apply `node-param-min-value-wrong-for-limit` (#3442) Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * Apply `node-param-display-name-wrong-for-dynamic-options` (#3454) * :hammer: fix * :zap: Fix `Assigned To` fields Co-authored-by: Michael Kret <michael.k@radency.com> * :shirt: Apply `rule node-param-default-wrong-for-number` (#3453) * :shirt: Apply `node-param-default-wrong-for-string` (#3452) Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * Apply `node-param-display-name-miscased` (#3449) * :hammer: fix * :hammer: exceptions * :zap: review fixes * :shirt: Apply `node-param-description-lowercase-first-char` (#3451) * :zap: fix * :zap: review fixes * :zap: fix Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * :shirt: Apply `node-param-description-wrong-for-dynamic-options` (#3456) * Rule working as intended * Add rule * :fire: Remove repetitions * :shirt: Add exceptions Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * :shirt: Small fix for `node-param-description-wrong-for-dynamic-options` * :shirt: Apply `node-param-default-wrong-for-fixed-collection` (#3460) * :shirt: Apply `node-param-description-line-break-html-tag` (#3462) * :shirt: Run baseline `lintfix` * :shirt: Apply `node-param-options-type-unsorted-items` (#3459) * :zap: fix * :hammer: exceptions * Add exception for Salesmate and Zoom Co-authored-by: Michael Kret <michael.k@radency.com> Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * :zap: Restore `lintfix` command Co-authored-by: Omar Ajoue <krynble@gmail.com> Co-authored-by: Michael Kret <88898367+michael-radency@users.noreply.github.com> Co-authored-by: agobrech <45268029+agobrech@users.noreply.github.com> Co-authored-by: Michael Kret <michael.k@radency.com> Co-authored-by: brianinoa <54530642+brianinoa@users.noreply.github.com>
2022-06-03 10:23:49 -07:00
name: 'Organization Owner',
value: 100,
},
],
default: '',
description: 'Role for the user',
},
2020-10-22 06:46:03 -07:00
],
2020-05-22 15:59:40 -07:00
},
/* -------------------------------------------------------------------------- */
/* user:deactivate */
/* -------------------------------------------------------------------------- */
{
displayName: 'User ID',
name: 'userId',
type: 'string',
required: true,
displayOptions: {
show: {
resource: ['user'],
operation: ['deactivate'],
2020-05-22 15:59:40 -07:00
},
},
default: '',
description: 'The ID of user to deactivate',
2020-05-22 15:59:40 -07:00
},
];