n8n/packages/nodes-base/nodes/Raindrop/descriptions/BookmarkDescription.ts
Iván Ovejero 9dba8b866a
Add Raindrop node (#1464)
*  Register node and credentials

*  Implement OAuth2 flow

* 🎨 Add SVG icon

*  Add preliminary node stub

*  Add preliminary generic functions

*  Add resource description stubs

*  Implement collection:getAll

*  Implement collection:get

*  Implement collection:create

*  Implement collection:delete

*  Implement collection:update

*  Implement raindrop:create

*  Implement raindrop:delete and update

*  Implement user:get

*  Improvements

* 🎨 Touch up resource descriptions

* 🎨 Rename resource description files

*  Remove params for uneditable properties

*  Remove unneeded success response assignment

*  Update raindrop params

*  Minor improvements

*  Small improvement

*  Minor improvements

Co-authored-by: ricardo <ricardoespinoza105@gmail.com>
Co-authored-by: Jan Oberhauser <jan.oberhauser@gmail.com>
2021-02-22 13:11:51 +01:00

321 lines
5.5 KiB
TypeScript

import {
INodeProperties,
} from 'n8n-workflow';
export const bookmarkOperations = [
{
displayName: 'Operation',
name: 'operation',
type: 'options',
default: 'get',
description: 'Operation to perform',
options: [
{
name: 'Create',
value: 'create',
},
{
name: 'Delete',
value: 'delete',
},
{
name: 'Get',
value: 'get',
},
{
name: 'Get All',
value: 'getAll',
},
{
name: 'Update',
value: 'update',
},
],
displayOptions: {
show: {
resource: [
'bookmark',
],
},
},
},
] as INodeProperties[];
export const bookmarkFields = [
// ----------------------------------
// bookmark: create
// ----------------------------------
{
displayName: 'Collection ID',
name: 'collectionId',
type: 'options',
displayOptions: {
show: {
resource: [
'bookmark',
],
operation: [
'create',
],
},
},
typeOptions: {
loadOptionsMethod: 'getCollections',
},
default: '',
},
{
displayName: 'Link',
name: 'link',
type: 'string',
required: true,
default: '',
description: 'Link of the bookmark to be created.',
displayOptions: {
show: {
resource: [
'bookmark',
],
operation: [
'create',
],
},
},
},
{
displayName: 'Additional Fields',
name: 'additionalFields',
type: 'collection',
placeholder: 'Add Field',
default: {},
displayOptions: {
show: {
resource: [
'bookmark',
],
operation: [
'create',
],
},
},
options: [
{
displayName: 'Important',
name: 'important',
type: 'boolean',
default: false,
description: 'Whether this bookmark is marked as favorite.',
},
{
displayName: 'Order',
name: 'order',
type: 'number',
default: 0,
description: 'Sort order for the bookmark. For example, to move it to first place, enter 0.',
},
{
displayName: 'Tags',
name: 'tags',
type: 'string',
default: '',
description: 'Bookmark tags. Multiple can be set separated by comma.',
},
{
displayName: 'Title',
name: 'title',
type: 'string',
default: '',
description: 'Title of the bookmark to create.',
},
],
},
// ----------------------------------
// bookmark: delete
// ----------------------------------
{
displayName: 'Bookmark ID',
name: 'bookmarkId',
type: 'string',
default: '',
required: true,
description: 'The ID of the bookmark to delete.',
displayOptions: {
show: {
resource: [
'bookmark',
],
operation: [
'delete',
],
},
},
},
// ----------------------------------
// bookmark: get
// ----------------------------------
{
displayName: 'Bookmark ID',
name: 'bookmarkId',
type: 'string',
default: '',
required: true,
description: 'The ID of the bookmark to retrieve.',
displayOptions: {
show: {
resource: [
'bookmark',
],
operation: [
'get',
],
},
},
},
// ----------------------------------
// bookmark: getAll
// ----------------------------------
{
displayName: 'Collection ID',
name: 'collectionId',
type: 'options',
typeOptions: {
loadOptionsMethod: 'getCollections',
},
default: [],
required: true,
description: 'The ID of the collection from which to retrieve all bookmarks.',
displayOptions: {
show: {
resource: [
'bookmark',
],
operation: [
'getAll',
],
},
},
},
{
displayName: 'Return All',
name: 'returnAll',
type: 'boolean',
displayOptions: {
show: {
resource: [
'bookmark',
],
operation: [
'getAll',
],
},
},
default: false,
description: 'If all results should be returned or only up to a given limit.',
},
{
displayName: 'Limit',
name: 'limit',
type: 'number',
displayOptions: {
show: {
resource: [
'bookmark',
],
operation: [
'getAll',
],
returnAll: [
false,
],
},
},
typeOptions: {
minValue: 1,
maxValue: 10,
},
default: 5,
description: 'How many results to return.',
},
// ----------------------------------
// bookmark: update
// ----------------------------------
{
displayName: 'Bookmark ID',
name: 'bookmarkId',
type: 'string',
default: '',
required: true,
description: 'The ID of the bookmark to update.',
displayOptions: {
show: {
resource: [
'bookmark',
],
operation: [
'update',
],
},
},
},
{
displayName: 'Update Fields',
name: 'updateFields',
type: 'collection',
placeholder: 'Add Field',
default: {},
displayOptions: {
show: {
resource: [
'bookmark',
],
operation: [
'update',
],
},
},
options: [
{
displayName: 'Collection ID',
name: 'collectionId',
type: 'options',
typeOptions: {
loadOptionsMethod: 'getCollections',
},
default: '',
},
{
displayName: 'Important',
name: 'important',
type: 'boolean',
default: false,
description: 'Whether this bookmark is marked as favorite.',
},
{
displayName: 'Order',
name: 'order',
type: 'number',
default: 0,
description: 'For example if you want to move bookmark to the first place set this field to 0',
},
{
displayName: 'Tags',
name: 'tags',
type: 'string',
default: '',
description: 'Bookmark tags. Multiple can be set separated by comma.',
},
{
displayName: 'Title',
name: 'title',
type: 'string',
default: '',
description: 'Title of the bookmark to be created.',
},
],
},
] as INodeProperties[];