n8n/packages/nodes-base/nodes/PostBin/RequestDescription.ts

139 lines
2.7 KiB
TypeScript
Raw Normal View History

import { INodeProperties } from 'n8n-workflow';
import { buildBinTestURL, buildRequestURL } from './GenericFunctions';
// Operations for the `Request` resource
export const requestOperations: INodeProperties[] = [
{
displayName: 'Operation',
name: 'operation',
type: '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
noDataExpression: true,
displayOptions: {
show: {
resource: ['request'],
},
},
options: [
{
name: 'Get',
value: 'get',
description: 'Get a request',
routing: {
request: {
method: 'GET',
url: '=/developers/postbin/api/bin/{{$parameter["binId"]}}/req/{{$parameter["requestId"]}}',
},
send: {
preSend: [
// Parse binId before sending to make sure it's in the right format
buildRequestURL,
],
},
},
action: 'Get a request',
},
{
name: 'Remove First',
value: 'removeFirst',
description: 'Remove the first request from bin',
routing: {
request: {
method: 'GET',
url: '=/developers/postbin/api/bin/{{$parameter["binId"]}}/req/shift',
},
send: {
preSend: [
// Parse binId before sending to make sure it's in the right format
buildRequestURL,
],
},
},
action: 'Remove First a request',
},
{
name: 'Send',
value: 'send',
description: 'Send a test request to the bin',
routing: {
request: {
method: 'POST',
},
send: {
preSend: [
// Parse binId before sending to make sure it's in the right format
buildBinTestURL,
],
},
output: {
postReceive: [
{
type: 'set',
properties: {
value: '={{ { "requestId": $response.body } }}',
},
},
],
},
},
action: 'Send a request',
},
],
default: 'get',
},
];
// Properties of the `Request` resource
export const requestFields: INodeProperties[] = [
{
displayName: 'Bin ID',
name: 'binId',
type: 'string',
default: '',
required: true,
displayOptions: {
show: {
resource: ['request'],
operation: ['get', 'removeFirst', 'send'],
},
},
description: 'Unique identifier for each bin',
},
{
displayName: 'Bin Content',
name: 'binContent',
type: 'string',
default: '',
typeOptions: {
rows: 5,
},
displayOptions: {
show: {
resource: ['request'],
operation: ['send'],
},
},
// Content is sent in the body of POST requests
routing: {
send: {
property: 'content',
type: 'body',
},
},
},
{
displayName: 'Request ID',
name: 'requestId',
type: 'string',
default: '',
required: true,
displayOptions: {
show: {
resource: ['request'],
operation: ['get'],
},
},
description: 'Unique identifier for each request',
},
];