BeeFlow 1

This commit is contained in:
Beedataco 2022-02-11 08:52:24 -05:00
commit 812cdaeace
8 changed files with 446 additions and 92 deletions

View file

@ -0,0 +1,18 @@
import {
ICredentialType,
INodeProperties,
} from 'n8n-workflow';
export class BeeFlowOmniKey implements ICredentialType {
name = 'BeeFlowOmniKey';
displayName = 'BeeFlow Omni API Key';
documentationUrl = 'BeeFlowOmni';
properties: INodeProperties[] = [
{
displayName: 'Authorization',
name: 'apiKey Authorization',
type: 'string',
default: '',
},
];
}

View file

@ -1,27 +0,0 @@
import {
ICredentialType,
NodePropertyTypes,
} from 'n8n-workflow';
export class ExampleCredentials implements ICredentialType {
name = 'exampleCredentials';
displayName = 'Example Credentials';
properties = [
// The credentials to get from user and save encrypted.
// Properties can be defined exactly in the same way
// as node properties.
{
displayName: 'User',
name: 'user',
type: 'string' as NodePropertyTypes,
default: '',
},
{
displayName: 'Access Token',
name: 'accessToken',
type: 'string' as NodePropertyTypes,
default: '',
},
];
}

View file

@ -0,0 +1,20 @@
{
"node": "n8n-nodes-base.BeeFlowOmni",
"nodeVersion": "1.0",
"codexVersion": "1.0",
"categories": [
"Communication"
],
"resources": {
"credentialDocumentation": [
{
"url": "https://docs.n8n.io/credentials/sms77"
}
],
"primaryDocumentation": [
{
"url": "https://docs.n8n.io/nodes/n8n-nodes-base.sms77/"
}
]
}
}

View file

@ -0,0 +1,346 @@
import {
IExecuteFunctions,
} from 'n8n-core';
import {
IDataObject,
INodeExecutionData,
INodeType,
INodeTypeDescription,
NodeOperationError,
} from 'n8n-workflow';
import {
BeeFlowOmniRequest,
} from './GenericFunctions';
export class BeeFlowOmni implements INodeType {
description: INodeTypeDescription = {
displayName: 'BeeFlowOmni',
name: 'BeeFlowOmni',
icon: 'file:BeeFlowOmni.png',
group: ['transform'],
version: 1,
subtitle: '={{$parameter["operation"] + ": " + $parameter["resource"]}}',
description: 'Send SMS and make text-to-speech calls',
defaults: {
name: 'BeeFlowOmni',
},
inputs: ['main'],
outputs: ['main'],
credentials: [
{
name: 'BeeFlowOmniKey',
required: true,
},
],
properties: [
{
displayName: 'Resource',
name: 'resource',
type: 'options',
options: [
{
name: 'SMS',
value: 'sms',
},
{
name: 'Voice Call',
value: 'voice',
},
],
default: 'sms',
description: 'The resource to operate on.',
},
// operations
{
displayName: 'Operation',
name: 'operation',
type: 'options',
displayOptions: {
show: {
resource: [
'sms',
],
},
},
options: [
{
name: 'Send',
value: 'send',
description: 'Send SMS',
},
],
default: 'send',
description: 'The operation to perform',
},
{
displayName: 'Operation',
name: 'operation',
type: 'options',
displayOptions: {
show: {
resource: [
'voice',
],
},
},
options: [
{
name: 'Send',
value: 'send',
description: 'Converts text to voice and calls a given number',
},
],
default: 'send',
description: 'The operation to perform',
},
{
displayName: 'From',
name: 'from',
type: 'string',
default: '',
placeholder: '+573459876543',
required: false,
displayOptions: {
show: {
operation: [
'send',
],
resource: [
'sms',
],
},
},
description: 'The caller ID displayed in the receivers display. Max 16 numeric or 11 alphanumeric characters',
},
{
displayName: 'To',
name: 'to',
type: 'string',
default: '',
placeholder: '+573459876543, MyGroup',
required: true,
displayOptions: {
show: {
operation: [
'send',
],
resource: [
'sms',
'voice',
],
},
},
description: 'The number of your recipient(s) separated by comma. Can be regular numbers or contact/groups from BeeFlowOmni',
},
{
displayName: 'Message',
name: 'message',
type: 'string',
default: '',
required: true,
typeOptions: {
alwaysOpenEditWindow: true,
},
displayOptions: {
show: {
operation: [
'send',
],
resource: [
'sms',
'voice',
],
},
},
description: 'The message to send. Max. 1520 characters',
},
{
displayName: 'Options',
name: 'options',
type: 'collection',
placeholder: 'Add Opton',
default: {},
displayOptions: {
show: {
operation: [
'send',
],
resource: [
'sms',
],
},
},
options: [
{
displayName: 'Debug',
name: 'debug',
type: 'boolean',
default: false,
description: 'If enabled, the API returns fake responses like in a sandbox',
},
{
displayName: 'Delay',
name: 'delay',
type: 'dateTime',
default: '',
description: 'Pick a date for time delayed dispatch',
},
{
displayName: 'Foreign ID',
name: 'foreign_id',
type: 'string',
default: '',
placeholder: 'MyCustomForeignID',
description: 'Custom foreign ID returned in DLR callbacks',
},
{
displayName: 'Flash',
name: 'flash',
type: 'boolean',
default: false,
description: 'Send as flash message being displayed directly the receiver\'s display',
},
{
displayName: 'Label',
name: 'label',
type: 'string',
default: '',
placeholder: 'MyCustomLabel',
description: 'Custom label used to group analytics',
},
{
displayName: 'No Reload',
name: 'no_reload',
type: 'boolean',
default: false,
description: 'Disable reload lock to allow sending duplicate messages',
},
{
displayName: 'Performance Tracking',
name: 'performance_tracking',
type: 'boolean',
default: false,
description: 'Enable performance tracking for URLs found in the message text',
},
{
displayName: 'TTL',
name: 'ttl',
type: 'number',
default: 2880,
typeOptions: {
minValue: 1,
},
description: 'Custom time to live specifying the validity period of a message in minutes',
},
],
},
{
displayName: 'Options',
name: 'options',
type: 'collection',
placeholder: 'Add Opton',
default: {},
displayOptions: {
show: {
operation: [
'send',
],
resource: [
'voice',
],
},
},
options: [
{
displayName: 'Debug',
name: 'debug',
type: 'boolean',
default: false,
description: 'If enabled, the API returns fake responses like in a sandbox',
},
{
displayName: 'From',
name: 'from',
type: 'string',
default: '',
placeholder: '+4901234567890',
description: 'The caller ID. Please use only verified sender IDs, one of your virtual inbound numbers or one of our shared virtual numbers',
},
{
displayName: 'XML',
name: 'xml',
type: 'boolean',
default: false,
description: 'Enable if text is of XML format',
},
],
},
],
};
async execute(this: IExecuteFunctions): Promise<INodeExecutionData[][]> {
const returnData: IDataObject[] = [];
for (let i = 0; i < this.getInputData().length; i++) {
const resource = this.getNodeParameter('resource', i);
const operation = this.getNodeParameter('operation', i);
let responseData;
try {
if (resource === 'sms') {
if (operation === 'send') {
const from = this.getNodeParameter('from', i) as string;
const to = this.getNodeParameter('to', i) as string;
const text = this.getNodeParameter('message', i) as string;
const options = this.getNodeParameter('options', i) as IDataObject;
const body = {
"messages": [
{
"from": from,
"destinations": [
{
"to": to
}
],
"text": text
}
]
};
responseData = await BeeFlowOmniRequest.call(this, 'POST', '/sms/2/text/advanced', body);
}
}
if (resource === 'voice') {
if (operation === 'send') {
const to = this.getNodeParameter('to', i) as string;
const text = this.getNodeParameter('message', i) as string;
const options = this.getNodeParameter('options', i) as IDataObject;
const body = {
to,
text,
...options,
};
responseData = await BeeFlowOmniRequest.call(this, 'POST', '/voice', body);
}
}
if (Array.isArray(responseData)) {
returnData.push.apply(returnData, responseData as IDataObject[]);
} else if (responseData !== undefined) {
returnData.push(responseData as IDataObject);
}
} catch (error) {
if (this.continueOnFail()) {
returnData.push({ error: error.message });
continue;
}
throw error;
}
}
return [this.helpers.returnJsonArray(returnData)];
}
}

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.2 KiB

View file

@ -0,0 +1,54 @@
import {
IExecuteFunctions,
IHookFunctions,
} from 'n8n-core';
import {
IDataObject,
NodeApiError,
NodeOperationError,
} from 'n8n-workflow';
import {
OptionsWithUri,
} from 'request';
/**
* Make an API request to BeeFlowOmni
*
* @param {IHookFunctions | IExecuteFunctions} this
* @param {string} method
* @param {Endpoint} endpoint
* @param {object | undefined} data
* @returns {Promise<any>}
*/
export async function BeeFlowOmniRequest(this: IHookFunctions | IExecuteFunctions, method: string, endpoint: string, body: IDataObject, qs: IDataObject = {}): Promise<any> { // tslint:disable-line:no-any
const credentials = await this.getCredentials('BeeFlowOmniKey');
if (credentials === undefined) {
throw new NodeOperationError(this.getNode(), 'No credentials got returned!');
}
const options: OptionsWithUri = {
headers: {
SentWith: 'n8n',
'X-Api-Key': credentials.apiKey,
},
qs,
uri: `https://api2.iatechsas.com/${endpoint}`,
json: true,
method,
};
if (Object.keys(body).length) {
options.form = body;
body.json = 1;
}
const response = await this.helpers.request(options);
if (response.success !== '100') {
throw new NodeApiError(this.getNode(), response, { message: 'Invalid BeeFlowOmni credentials or API error!' });
}
return response;
}

View file

@ -1,57 +0,0 @@
import { IExecuteFunctions } from 'n8n-core';
import {
INodeExecutionData,
INodeType,
INodeTypeDescription,
} from 'n8n-workflow';
export class ExampleNode implements INodeType {
description: INodeTypeDescription = {
displayName: 'Example Node',
name: 'exampleNode',
group: ['transform'],
version: 1,
description: 'Basic Example Node',
defaults: {
name: 'Example Node',
color: '#772244',
},
inputs: ['main'],
outputs: ['main'],
properties: [
// Node properties which the user gets displayed and
// can change on the node.
{
displayName: 'My String',
name: 'myString',
type: 'string',
default: '',
placeholder: 'Placeholder value',
description: 'The description text',
},
],
};
async execute(this: IExecuteFunctions): Promise<INodeExecutionData[][]> {
const items = this.getInputData();
let item: INodeExecutionData;
let myString: string;
// Itterates over all input items and add the key "myString" with the
// value the parameter "myString" resolves to.
// (This could be a different value for each item in case it contains an expression)
for (let itemIndex = 0; itemIndex < items.length; itemIndex++) {
myString = this.getNodeParameter('myString', itemIndex, '') as string;
item = items[itemIndex];
item.json['myString'] = myString;
}
return this.prepareOutputData(items);
}
}

View file

@ -1,16 +1,16 @@
{
"name": "n8n-nodes-starter",
"name": "n8n-nodes",
"version": "0.1.0",
"description": "Example starter module for custom n8n nodes.",
"description": "Módulos BEE",
"license": "SEE LICENSE IN LICENSE.md",
"homepage": "https://n8n.io",
"homepage": "beedata.co",
"author": {
"name": "Jan Oberhauser",
"email": "jan@n8n.io"
"name": "Santiago Pino",
"email": "info@beedata.co"
},
"repository": {
"type": "git",
"url": "git+https://github.com/n8n-io/n8n-nodes-starter.git"
"url": "git+https://github.com/Beedataco/n8n-nodes.git"
},
"main": "index.js",
"scripts": {
@ -27,10 +27,10 @@
],
"n8n": {
"credentials": [
"dist/credentials/ExampleCredentials.credentials.js"
"dist/credentials/BeeFlowOmni.credentials.js"
],
"nodes": [
"dist/nodes/ExampleNode/ExampleNode.node.js"
"dist/nodes/BeeFlowOmni/BeeFlowOmni.node.js"
]
},
"devDependencies": {