n8n/packages/nodes-base/credentials/RedditOAuth2Api.credentials.ts

76 lines
1.5 KiB
TypeScript
Raw Normal View History

:sparkles: 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 * :zap: 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 72548d952378a2f899517522b5ba4950a940c6e4. * Turn user:get (gilded) into listing * :zap: Small improvement * :zap: Improve Reddit-Node Co-authored-by: ricardo <ricardoespinoza105@gmail.com> Co-authored-by: Jan Oberhauser <jan.oberhauser@gmail.com>
2021-02-04 00:37:03 -08:00
import {
ICredentialType,
INodeProperties,
:sparkles: 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 * :zap: 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 72548d952378a2f899517522b5ba4950a940c6e4. * Turn user:get (gilded) into listing * :zap: Small improvement * :zap: Improve Reddit-Node Co-authored-by: ricardo <ricardoespinoza105@gmail.com> Co-authored-by: Jan Oberhauser <jan.oberhauser@gmail.com>
2021-02-04 00:37:03 -08:00
} from 'n8n-workflow';
const scopes = [
'identity',
'edit',
'history',
'mysubreddits',
'read',
'save',
'submit',
];
// https://github.com/reddit-archive/reddit/wiki/OAuth2
export class RedditOAuth2Api implements ICredentialType {
name = 'redditOAuth2Api';
extends = [
'oAuth2Api',
];
displayName = 'Reddit OAuth2 API';
documentationUrl = 'reddit';
properties: INodeProperties[] = [
{
displayName: 'Grant Type',
name: 'grantType',
type: 'hidden',
default: 'authorizationCode',
},
:sparkles: 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 * :zap: 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 72548d952378a2f899517522b5ba4950a940c6e4. * Turn user:get (gilded) into listing * :zap: Small improvement * :zap: Improve Reddit-Node Co-authored-by: ricardo <ricardoespinoza105@gmail.com> Co-authored-by: Jan Oberhauser <jan.oberhauser@gmail.com>
2021-02-04 00:37:03 -08:00
{
displayName: 'Auth URI Query Parameters',
name: 'authQueryParameters',
type: 'hidden',
:sparkles: 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 * :zap: 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 72548d952378a2f899517522b5ba4950a940c6e4. * Turn user:get (gilded) into listing * :zap: Small improvement * :zap: Improve Reddit-Node Co-authored-by: ricardo <ricardoespinoza105@gmail.com> Co-authored-by: Jan Oberhauser <jan.oberhauser@gmail.com>
2021-02-04 00:37:03 -08:00
default: 'response_type=code',
},
{
displayName: 'Auth URI Query Parameters',
name: 'authQueryParameters',
type: 'hidden',
:sparkles: 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 * :zap: 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 72548d952378a2f899517522b5ba4950a940c6e4. * Turn user:get (gilded) into listing * :zap: Small improvement * :zap: Improve Reddit-Node Co-authored-by: ricardo <ricardoespinoza105@gmail.com> Co-authored-by: Jan Oberhauser <jan.oberhauser@gmail.com>
2021-02-04 00:37:03 -08:00
default: 'grant_type=authorization_code',
},
{
displayName: 'Auth URI Query Parameters',
name: 'authQueryParameters',
type: 'hidden',
:sparkles: 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 * :zap: 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 72548d952378a2f899517522b5ba4950a940c6e4. * Turn user:get (gilded) into listing * :zap: Small improvement * :zap: Improve Reddit-Node Co-authored-by: ricardo <ricardoespinoza105@gmail.com> Co-authored-by: Jan Oberhauser <jan.oberhauser@gmail.com>
2021-02-04 00:37:03 -08:00
default: 'duration=permanent',
},
{
displayName: 'Authorization URL',
name: 'authUrl',
type: 'hidden',
:sparkles: 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 * :zap: 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 72548d952378a2f899517522b5ba4950a940c6e4. * Turn user:get (gilded) into listing * :zap: Small improvement * :zap: Improve Reddit-Node Co-authored-by: ricardo <ricardoespinoza105@gmail.com> Co-authored-by: Jan Oberhauser <jan.oberhauser@gmail.com>
2021-02-04 00:37:03 -08:00
default: 'https://www.reddit.com/api/v1/authorize',
},
{
displayName: 'Access Token URL',
name: 'accessTokenUrl',
type: 'hidden',
:sparkles: 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 * :zap: 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 72548d952378a2f899517522b5ba4950a940c6e4. * Turn user:get (gilded) into listing * :zap: Small improvement * :zap: Improve Reddit-Node Co-authored-by: ricardo <ricardoespinoza105@gmail.com> Co-authored-by: Jan Oberhauser <jan.oberhauser@gmail.com>
2021-02-04 00:37:03 -08:00
default: 'https://www.reddit.com/api/v1/access_token',
},
{
displayName: 'Scope',
name: 'scope',
type: 'hidden',
:sparkles: 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 * :zap: 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 72548d952378a2f899517522b5ba4950a940c6e4. * Turn user:get (gilded) into listing * :zap: Small improvement * :zap: Improve Reddit-Node Co-authored-by: ricardo <ricardoespinoza105@gmail.com> Co-authored-by: Jan Oberhauser <jan.oberhauser@gmail.com>
2021-02-04 00:37:03 -08:00
default: scopes.join(' '),
},
{
displayName: 'Authentication',
name: 'authentication',
type: 'hidden',
:sparkles: 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 * :zap: 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 72548d952378a2f899517522b5ba4950a940c6e4. * Turn user:get (gilded) into listing * :zap: Small improvement * :zap: Improve Reddit-Node Co-authored-by: ricardo <ricardoespinoza105@gmail.com> Co-authored-by: Jan Oberhauser <jan.oberhauser@gmail.com>
2021-02-04 00:37:03 -08:00
default: 'header',
},
];
}