n8n/packages/nodes-base/nodes/SendInBlue/SenderDescrition.ts

196 lines
3.8 KiB
TypeScript
Raw Normal View History

feat(SendInBlue Node): Add SendInBlue Regular + Trigger Node (#3746) * add sendinblue svg icon * Add code and required files for new sendinblue node * Add node to package.json * Update credentials to display API Key instead of Access Token * Use new svg found in brandfetch * :zap: Improvements * :recycle: Moved descriptions for email to it's own file * :zap: Added support for contact get * :zap: moved email descriptions to it's own file * :zap: Add logic to conditionally remove/format sms,email * :zap: Improvements * :zap: Refactor Sender descriptions to it's own file * :zap: Fix urls * :zap: Improvements attempt * :zap: Refactor remove inline descriptions * :zap: Minor improvement * :art: Learn a nice way to send options as key-value * :zap: Improvements * :recycle: Fix Create Operation structure * :recycle: Refactor create functionality for attribute :recycle: Introduce override for createAttribute selectedCategory :recycle: Add delete functionality * :fire: Remove preSend from delete * :zap: Implement override for body types * :zap: Cleanup node file * :zap: Update response for contact update :zap: Update request url for contact delete * :zap: Add presend check for optional properties that are empty :zap: Add Model file and TransactionalEmail interface * :zap: formatting * :recycle: Remove requestOperations from Node Description level * :recycle: Cleanup routing for Get All :recycle: Make Identifier required * :zap: Formatting * :recycle: Add Options Collection * :recycle: Add Filters area * :recycle: Formatting * :recycle: Handle empty return * :recycle: Remove unused code * :recycle: Fix pagination :recycle: Fix empty return for delete * :zap: Add pagination * :zap: Fix Modified Since * :recycle: Reorder send operation ui * :zap: Remove no longer needed presend :zap: Add send html template operation * :recycle: Make Contact Attribute name and type required * :recycle: Rename Attribute to Contact Attribute * :recycle: Rename Identifier to Contact Identifier * :recycle: Remove SMS from root level because it can exist in Contact Attributes * :recycle: Fix Array type using 'Array<T>' :recycle: Fix double quotes should be single quotes * :tshirt: Lint Fix * :zap: Add email attachment functionality :zap: Add attachment data validation * :zap: Add dynamic loading of Email Template IDs * :recycle: Cleanup validation method * :zap: Introduce workaround and use binary data for attachments * feat: Migrated to npm release of riot-tmpl fork. * :tshirt: Lint fix rules * :shirt: Lint fix rules * fix: Updated imports to use @n8n_io/riot-tmpl * fix: Fixed Logger.ts types. * :zap: Fix mixmatch of filename and package.json credentials list * :zap: fix mixmatch in nodes list * feat(core): Give access to getBinaryDataBuffer in preSend method * :zap: clean up mixmatches in node naming * :recycle: Refactor code to use newly exposed getBinaryDataBuffer method * :zap: Improvements * :fire: Remove unnecessary lines * :shirt: Fix linting issues * :zap: Fix issues with up to date APIs and improve readability * :zap: update naming of files * :recycle: Move sendHtml boolean above subject :recycle: Update naming from Parameters to Fields * :recycle: Move sendHtml boolean above subject :recycle: Update naming from Parameters to Fields * :recycle: Add attribute name url encoding :recycle: Change limit's default to 50 * :zap: Fix default for templateId * :zap: Fix display name for attribute list * :recycle: Add clarity to attribute value display name * :recycle: Add tags and attachments for emails * :recycle: Add use of item's binary data fileName * :shirt: Fix action lint rule * :shirt: Remove deprecated lint rule * :arrow_up: Update eslint-plugin-n8n-nodes-base * :shirt: Fix lint rule for file name * :zap: Fix update attribute * :recycle: Add upsert capabilites * :fire: Remove create or update operation * :recycle: Add sendInBlueWebhookApi namespace * :recycle: Add Webhook API functionality * :zap: Add SendInBlue Trigger * :zap: Return correct webhookId data * :zap: Add placeholder for receiving data * :shirt: Fixing existing linting issues * :rotating_light: Enable namespacing in tslint file * :shirt: Fix linting issues * :zap: Rename exported WebhookApi * :fire: Remove unused Model.ts file * :recycle: Update node to use SendInBlue namespace * :zap: Revert back to allowing upsert functionality * :recycle: Fix options to better describe events * Remove update flag for create operation * :recycle: Fix discrepancies for contact resource * remove no-namespace lint rule * :shirt: Fix linting issues * :recycle: Add sendInBlueWebhookApi namespace * :recycle: Add Webhook API functionality * :zap: Add SendInBlue Trigger * :zap: Return correct webhookId data * :zap: Add placeholder for receiving data * :shirt: Fix linting issues * :zap: Rename exported WebhookApi * :recycle: Fix options to better describe events * Add optionswithuri import that was lost * :zap: Fix details from janober's review * :zap: Fix order of displayName and name properties * :zap: Fix default value and improve loadOptions * :zap: Introduce support for comma separated attribute values * :zap: Introduce support for comma separated attribute values * :shirt: Fix linting issues * Update defaults and required props * :zap: Fix copy paste issue Upsert was not using correct endpoint * :zap: Fix upsert email field display name * :zap: Last update, upsert email description * :zap: Add PostReceived type limit Co-authored-by: ricardo <ricardoespinoza105@gmail.com> Co-authored-by: Alex Grozav <alex@grozav.com> Co-authored-by: Jan Oberhauser <jan.oberhauser@gmail.com>
2022-08-03 09:08:51 -07:00
import { IExecuteSingleFunctions, INodeExecutionData, INodeProperties } from 'n8n-workflow';
export const senderOperations: INodeProperties[] = [
{
displayName: 'Operation',
name: 'operation',
type: 'options',
noDataExpression: true,
displayOptions: {
show: {
resource: ['sender'],
},
},
options: [
{
name: 'Create',
value: 'create',
action: 'Create a sender',
},
{
name: 'Delete',
value: 'delete',
routing: {
request: {
method: 'DELETE',
url: '=/v3/senders/{{$parameter.id}}',
},
output: {
postReceive: [
{
type: 'set',
properties: {
value: '={{ { "success": true } }}',
},
},
],
},
},
action: 'Delete a sender',
},
{
name: 'Get All',
value: 'getAll',
routing: {
request: {
method: 'GET',
url: '/v3/senders',
},
send: {
paginate: false,
},
output: {
postReceive: [
{
type: 'rootProperty',
properties: {
property: 'senders',
},
},
],
},
},
action: 'Get all senders',
},
],
default: 'create',
},
];
const senderCreateOperation: INodeProperties[] = [
{
displayName: 'Name',
name: 'name',
type: 'string',
default: '',
displayOptions: {
show: {
resource: ['sender'],
operation: ['create'],
},
},
routing: {
request: {
method: 'POST',
url: '/v3/senders',
},
send: {
property: 'name',
type: 'body',
},
},
required: true,
description: 'Name of the sender',
},
{
displayName: 'Email',
name: 'email',
type: 'string',
placeholder: 'name@email.com',
default: '',
displayOptions: {
show: {
resource: ['sender'],
operation: ['create'],
},
},
routing: {
send: {
property: 'email',
type: 'body',
},
},
required: true,
description: 'Email of the sender',
},
];
const senderDeleteOperation: INodeProperties[] = [
{
displayName: 'Sender ID',
name: 'id',
type: 'string',
default: '',
displayOptions: {
show: {
resource: ['sender'],
operation: ['delete'],
},
},
description: 'ID of the sender to delete',
},
];
const senderGetAllOperation: INodeProperties[] = [
{
displayName: 'Return All',
name: 'returnAll',
type: 'boolean',
displayOptions: {
show: {
resource: ['sender'],
operation: ['getAll'],
},
},
default: false,
description: 'Whether to return all results or only up to a given limit',
},
{
displayName: 'Limit',
name: 'limit',
type: 'number',
displayOptions: {
show: {
resource: ['sender'],
operation: ['getAll'],
returnAll: [false],
},
},
typeOptions: {
minValue: 1,
maxValue: 1000,
},
routing: {
output: {
postReceive: [
{
type: 'limit',
properties: {
maxResults: '={{$value}}',
},
},
],
},
},
default: 10,
description: 'Max number of results to return',
},
];
export const senderFields: INodeProperties[] = [
/* -------------------------------------------------------------------------- */
/* sender:create */
/* -------------------------------------------------------------------------- */
...senderCreateOperation,
/* -------------------------------------------------------------------------- */
/* sender:delete */
/* -------------------------------------------------------------------------- */
...senderDeleteOperation,
/* -------------------------------------------------------------------------- */
/* sender:getAll */
/* -------------------------------------------------------------------------- */
...senderGetAllOperation,
];