n8n/packages/nodes-base/nodes/Reddit/PostCommentDescription.ts
Iván Ovejero eb2f14d06d
Add Reddit Node (#1345)
* Set up initial scaffolding and auth

* Add grant type to credentials

* Add Account operations and OAuth2 request

* Add post submission functionality

* Refactor resources into resource descriptions

* Refactor request for no auth URL

* Refactor submission description for consistency

* Add listing resource

* Refactor My Account resource into details

* Add request for all items

* Add listings for specific subreddits

* Fix minor linting details

* Add subreddit resource

* Add All-Reddit and Subreddit resource descriptions

* Adjust display options for credentials

* Add subreddit search functionality

* Clean up auth parameter

* Add user resource with GET endpoint

* Add user description

* Add submission search and commenting functionality

* Clean up logging and comments

* Fix minor details

* Fix casing in properties

* Add dividers to execute() method

* Refactor per feedback

* Remove unused description

* Add punctuation to property descriptions

* Fix resources indentation

* Add resource dividers

* Remove deprecated sidebar option

* Make subreddit:get responses consistent

* Remove returnAll and limit from subreddit:get

* Flatten user:get response for about

* Rename comment target property

* Remove best property from post:getAll

* Enrich subreddit search by keyword operation

* Remove unneeded scopes

* Add endpoint documentation

* Add scaffolding for post comment

* Add all operations for postComment resource

* Add all operations for post resource

* Refactor subreddit:getAll

* Fix postComment:getAll

* Flatten responses for profile:get

*  Improvements

* Fix response traversal for postComment:add

* Flatten response for postComment:reply

* Fix subreddit:getAll with keyword search

* Fix pagination to enforce limit

* Wrap unauthenticated API call in try-catch block

* Add 404 error for empty array responses

* Revert "Fix pagination to enforce limit"

This reverts commit 72548d9523.

* Turn user:get (gilded) into listing

*  Small improvement

*  Improve Reddit-Node

Co-authored-by: ricardo <ricardoespinoza105@gmail.com>
Co-authored-by: Jan Oberhauser <jan.oberhauser@gmail.com>
2021-02-04 09:37:03 +01:00

232 lines
4.3 KiB
TypeScript

import {
INodeProperties,
} from 'n8n-workflow';
export const postCommentOperations = [
{
displayName: 'Operation',
name: 'operation',
type: 'options',
default: 'create',
description: 'Operation to perform',
options: [
{
name: 'Create',
value: 'create',
description: 'Create a top-level comment in a post',
},
{
name: 'Get All',
value: 'getAll',
description: 'Retrieve all comments in a post',
},
{
name: 'Delete',
value: 'delete',
description: 'Remove a comment from a post',
},
{
name: 'Reply',
value: 'reply',
description: 'Write a reply to a comment in a post',
},
],
displayOptions: {
show: {
resource: [
'postComment',
],
},
},
},
] as INodeProperties[];
export const postCommentFields = [
// ----------------------------------
// postComment: create
// ----------------------------------
{
displayName: 'Post ID',
name: 'postId',
type: 'string',
required: true,
default: '',
description: 'ID of the post to write the comment to. Found in the post URL:<br><code>/r/[subreddit_name]/comments/[post_id]/[post_title]</code>',
placeholder: 'l0me7x',
displayOptions: {
show: {
resource: [
'postComment',
],
operation: [
'create',
],
},
},
},
{
displayName: 'Comment Text',
name: 'commentText',
type: 'string',
required: true,
default: '',
description: 'Text of the comment. Markdown supported.',
displayOptions: {
show: {
resource: [
'postComment',
],
operation: [
'create',
],
},
},
},
// ----------------------------------
// postComment: getAll
// ----------------------------------
{
displayName: 'Subreddit',
name: 'subreddit',
type: 'string',
required: true,
default: '',
description: 'The name of subreddit where the post is.',
displayOptions: {
show: {
resource: [
'postComment',
],
operation: [
'getAll',
],
},
},
},
{
displayName: 'Post ID',
name: 'postId',
type: 'string',
required: true,
default: '',
description: 'ID of the post to get all comments from. Found in the post URL:<br><code>/r/[subreddit_name]/comments/[post_id]/[post_title]</code>',
placeholder: 'l0me7x',
displayOptions: {
show: {
resource: [
'postComment',
],
operation: [
'getAll',
],
},
},
},
{
displayName: 'Return All',
name: 'returnAll',
type: 'boolean',
default: false,
description: 'Return all results.',
displayOptions: {
show: {
resource: [
'postComment',
],
operation: [
'getAll',
],
},
},
},
{
displayName: 'Limit',
name: 'limit',
type: 'number',
default: 100,
description: 'The number of results to return.',
typeOptions: {
minValue: 1,
maxValue: 100,
},
displayOptions: {
show: {
resource: [
'postComment',
],
operation: [
'getAll',
],
returnAll: [
false,
],
},
},
},
// ----------------------------------
// postComment: delete
// ----------------------------------
{
displayName: 'Comment ID',
name: 'commentId',
type: 'string',
required: true,
default: '',
description: 'ID of the comment to remove. Found in the comment URL:<br><code>/r/[subreddit_name]/comments/[post_id]/[post_title]/[comment_id]</code>',
placeholder: 'gla7fmt',
displayOptions: {
show: {
resource: [
'postComment',
],
operation: [
'delete',
],
},
},
},
// ----------------------------------
// postComment: reply
// ----------------------------------
{
displayName: 'Comment ID',
name: 'commentId',
type: 'string',
required: true,
default: '',
description: 'ID of the comment to reply to. To be found in the comment URL:<br><code>www.reddit.com/r/[subreddit_name]/comments/[post_id]/[post_title]/[comment_id]</code>',
placeholder: 'gl9iroa',
displayOptions: {
show: {
resource: [
'postComment',
],
operation: [
'reply',
],
},
},
},
{
displayName: 'Reply Text',
name: 'replyText',
type: 'string',
required: true,
default: '',
description: 'Text of the reply. Markdown supported.',
displayOptions: {
show: {
resource: [
'postComment',
],
operation: [
'reply',
],
},
},
},
] as INodeProperties[];