n8n/packages/nodes-base/nodes/Elastic/ElasticSecurity/descriptions/CaseCommentDescription.ts

351 lines
5.9 KiB
TypeScript
Raw Normal View History

import {
INodeProperties,
} from 'n8n-workflow';
export const caseCommentOperations: INodeProperties[] = [
{
displayName: 'Operation',
name: 'operation',
noDataExpression: true,
type: 'options',
displayOptions: {
show: {
resource: [
'caseComment',
],
},
},
options: [
{
name: 'Add',
value: 'add',
description: 'Add a comment to a case',
action: 'Add a comment to a case',
},
{
name: 'Get',
value: 'get',
description: 'Get a case comment',
action: 'Get a case comment',
},
{
name: 'Get All',
value: 'getAll',
description: 'Retrieve all case comments',
action: 'Get all case comments',
},
{
name: 'Remove',
value: 'remove',
description: 'Remove a comment from a case',
action: 'Remove a comment from a case',
},
{
name: 'Update',
value: 'update',
description: 'Update a comment in a case',
action: 'Update a comment from a case',
},
],
default: 'add',
},
];
export const caseCommentFields: INodeProperties[] = [
// ----------------------------------------
// caseComment: add
// ----------------------------------------
{
displayName: 'Case ID',
name: 'caseId',
description: 'ID of the case containing the comment to retrieve',
type: 'string',
required: true,
default: '',
displayOptions: {
show: {
resource: [
'caseComment',
],
operation: [
'add',
],
},
},
},
{
displayName: 'Comment',
name: 'comment',
type: 'string',
required: true,
default: '',
displayOptions: {
show: {
resource: [
'caseComment',
],
operation: [
'add',
],
},
},
},
{
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
displayName: 'Simplify',
name: 'simple',
type: 'boolean',
displayOptions: {
show: {
resource: [
'caseComment',
],
operation: [
'add',
],
},
},
default: true,
description: 'Whether to return a simplified version of the response instead of the raw data',
},
{
displayName: 'Additional Fields',
name: 'additionalFields',
type: 'collection',
placeholder: 'Add Field',
default: {},
displayOptions: {
show: {
resource: [
'caseComment',
],
operation: [
'add',
],
},
},
options: [
{
displayName: 'Owner',
name: 'owner',
type: 'string',
description: 'Valid application owner registered within the Cases Role Based Access Control system',
default: '',
},
],
},
// ----------------------------------------
// caseComment: get
// ----------------------------------------
{
displayName: 'Case ID',
name: 'caseId',
description: 'ID of the case containing the comment to retrieve',
type: 'string',
required: true,
default: '',
displayOptions: {
show: {
resource: [
'caseComment',
],
operation: [
'get',
],
},
},
},
{
displayName: 'Comment ID',
name: 'commentId',
description: 'ID of the case comment to retrieve',
type: 'string',
required: true,
default: '',
displayOptions: {
show: {
resource: [
'caseComment',
],
operation: [
'get',
],
},
},
},
// ----------------------------------------
// caseComment: getAll
// ----------------------------------------
{
displayName: 'Case ID',
name: 'caseId',
type: 'string',
required: true,
default: '',
displayOptions: {
show: {
resource: [
'caseComment',
],
operation: [
'getAll',
],
},
},
},
{
displayName: 'Return All',
name: 'returnAll',
type: 'boolean',
default: false,
description: 'Whether to return all results or only up to a given limit',
displayOptions: {
show: {
resource: [
'caseComment',
],
operation: [
'getAll',
],
},
},
},
{
displayName: 'Limit',
name: 'limit',
type: 'number',
default: 50,
description: 'Max number of results to return',
typeOptions: {
minValue: 1,
},
displayOptions: {
show: {
resource: [
'caseComment',
],
operation: [
'getAll',
],
returnAll: [
false,
],
},
},
},
// ----------------------------------------
// caseComment: remove
// ----------------------------------------
{
displayName: 'Case ID',
name: 'caseId',
description: 'ID of the case containing the comment to remove',
type: 'string',
required: true,
default: '',
displayOptions: {
show: {
resource: [
'caseComment',
],
operation: [
'remove',
],
},
},
},
{
displayName: 'Comment ID',
name: 'commentId',
type: 'string',
required: true,
default: '',
displayOptions: {
show: {
resource: [
'caseComment',
],
operation: [
'remove',
],
},
},
},
// ----------------------------------------
// caseComment: update
// ----------------------------------------
{
displayName: 'Case ID',
name: 'caseId',
description: 'ID of the case containing the comment to retrieve',
type: 'string',
required: true,
default: '',
displayOptions: {
show: {
resource: [
'caseComment',
],
operation: [
'update',
],
},
},
},
{
displayName: 'Comment ID',
name: 'commentId',
type: 'string',
required: true,
default: '',
displayOptions: {
show: {
resource: [
'caseComment',
],
operation: [
'update',
],
},
},
},
{
displayName: 'Comment',
name: 'comment',
description: 'Text to replace current comment message',
type: 'string',
required: true,
default: '',
displayOptions: {
show: {
resource: [
'caseComment',
],
operation: [
'update',
],
},
},
},
{
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
displayName: 'Simplify',
name: 'simple',
type: 'boolean',
displayOptions: {
show: {
resource: [
'caseComment',
],
operation: [
'update',
],
},
},
default: true,
description: 'Whether to return a simplified version of the response instead of the raw data',
},
];