first commit

packages/nodes-base/nodes/Vonage/GenericFunctions.ts

@@ -0,0 +1,41 @@
+import type {
+	IExecuteFunctions,
+	ILoadOptionsFunctions,
+	IDataObject,
+	JsonObject,
+	IRequestOptions,
+	IHttpRequestMethods,
+} from 'n8n-workflow';
+import { NodeApiError } from 'n8n-workflow';
+
+export async function vonageApiRequest(
+	this: IExecuteFunctions | ILoadOptionsFunctions,
+	method: IHttpRequestMethods,
+	path: string,
+	body: any = {},
+	qs: IDataObject = {},
+	_option = {},
+): Promise<any> {
+	const credentials = await this.getCredentials('vonageApi');
+
+	body.api_key = credentials.apiKey as string;
+
+	body.api_secret = credentials.apiSecret as string;
+
+	const options: IRequestOptions = {
+		method,
+		form: body,
+		qs,
+		uri: `https://rest.nexmo.com${path}`,
+		json: true,
+	};
+
+	try {
+		if (Object.keys(body as IDataObject).length === 0) {
+			delete options.body;
+		}
+		return await this.helpers.request.call(this, options);
+	} catch (error) {
+		throw new NodeApiError(this.getNode(), error as JsonObject);
+	}
+}

packages/nodes-base/nodes/Vonage/Vonage.node.json

@@ -0,0 +1,26 @@
+{
+	"node": "n8n-nodes-base.vonage",
+	"nodeVersion": "1.0",
+	"codexVersion": "1.0",
+	"categories": ["Communication"],
+	"resources": {
+		"credentialDocumentation": [
+			{
+				"url": "https://docs.n8n.io/integrations/builtin/credentials/vonage/"
+			}
+		],
+		"primaryDocumentation": [
+			{
+				"url": "https://docs.n8n.io/integrations/builtin/app-nodes/n8n-nodes-base.vonage/"
+			}
+		],
+		"generic": [
+			{
+				"label": "2021 Goals: Level Up Your Vocabulary With Vonage and n8n",
+				"icon": "🎯",
+				"url": "https://n8n.io/blog/2021-goals-level-up-your-vocabulary-with-vonage-and-n8n/"
+			}
+		]
+	},
+	"alias": ["SMS"]
+}

packages/nodes-base/nodes/Vonage/Vonage.node.ts

@@ -0,0 +1,497 @@
+import type {
+	IExecuteFunctions,
+	IDataObject,
+	INodeExecutionData,
+	INodeType,
+	INodeTypeDescription,
+} from 'n8n-workflow';
+import { NodeConnectionTypes } from 'n8n-workflow';
+
+import { vonageApiRequest } from './GenericFunctions';
+
+export class Vonage implements INodeType {
+	description: INodeTypeDescription = {
+		displayName: 'Vonage',
+		name: 'vonage',
+
+		icon: { light: 'file:vonage.svg', dark: 'file:vonage.dark.svg' },
+		group: ['input'],
+		version: 1,
+		subtitle: '={{$parameter["operation"] + ": " + $parameter["resource"]}}',
+		description: 'Consume Vonage API',
+		defaults: {
+			name: 'Vonage',
+		},
+		usableAsTool: true,
+		inputs: [NodeConnectionTypes.Main],
+		outputs: [NodeConnectionTypes.Main],
+		credentials: [
+			{
+				name: 'vonageApi',
+				required: true,
+			},
+		],
+		properties: [
+			{
+				displayName: 'Resource',
+				name: 'resource',
+				type: 'options',
+				noDataExpression: true,
+				options: [
+					{
+						name: 'SMS',
+						value: 'sms',
+					},
+				],
+				default: 'sms',
+			},
+			{
+				displayName: 'Operation',
+				name: 'operation',
+				type: 'options',
+				noDataExpression: true,
+				options: [
+					{
+						name: 'Send',
+						value: 'send',
+						action: 'Send an SMS',
+					},
+				],
+				displayOptions: {
+					show: {
+						resource: ['sms'],
+					},
+				},
+				default: 'send',
+			},
+			{
+				displayName: 'From',
+				name: 'from',
+				type: 'string',
+				displayOptions: {
+					show: {
+						resource: ['sms'],
+						operation: ['send'],
+					},
+				},
+				default: '',
+				description: 'The name or number the message should be sent from',
+			},
+			{
+				displayName: 'To',
+				name: 'to',
+				type: 'string',
+				displayOptions: {
+					show: {
+						resource: ['sms'],
+						operation: ['send'],
+					},
+				},
+				default: '',
+				description:
+					'The number that the message should be sent to. Numbers are specified in E.164 format.',
+			},
+			// {
+			// 	displayName: 'Type',
+			// 	name: 'type',
+			// 	type: 'options',
+			// 	displayOptions: {
+			// 		show: {
+			// 			resource: [
+			// 				'sms',
+			// 			],
+			// 			operation: [
+			// 				'send',
+			// 			],
+			// 		},
+			// 	},
+			// 	options: [
+			// 		{
+			// 			name: 'Binary',
+			// 			value: 'binary',
+			// 		},
+			// 		{
+			// 			name: 'Text',
+			// 			value: 'text',
+			// 		},
+			// 		{
+			// 			name: 'Wappush',
+			// 			value: 'wappush',
+			// 		},
+			// 		{
+			// 			name: 'Unicode',
+			// 			value: 'unicode',
+			// 		},
+			// 		{
+			// 			name: 'VCAL',
+			// 			value: 'vcal',
+			// 		},
+			// 		{
+			// 			name: 'VCARD',
+			// 			value: 'vcard',
+			// 		},
+			// 	],
+			// 	default: 'text',
+			// 	description: 'The format of the message body',
+			// },
+			// {
+			// 	displayName: 'Input Binary Field',
+			// 	name: 'binaryPropertyName',
+			// 	displayOptions: {
+			// 		show: {
+			// 			resource: [
+			// 				'sms',
+			// 			],
+			// 			operation: [
+			// 				'send',
+			// 			],
+			// 			type: [
+			// 				'binary',
+			// 			],
+			// 		},
+			// 	},
+			// 	type: 'string',
+			// 	default: 'data',
+			// 	description: 'Object property name which holds binary data.',
+			// 	required: true,
+			// },
+			// {
+			// 	displayName: 'Body',
+			// 	name: 'body',
+			// 	type: 'string',
+			// 	displayOptions: {
+			// 		show: {
+			// 			resource: [
+			// 				'sms',
+			// 			],
+			// 			operation: [
+			// 				'send',
+			// 			],
+			// 			type: [
+			// 				'binary',
+			// 			],
+			// 		},
+			// 	},
+			// 	default: '',
+			// 	description: 'Hex encoded binary data',
+			// },
+			// {
+			// 	displayName: 'UDH',
+			// 	name: 'udh',
+			// 	type: 'string',
+			// 	displayOptions: {
+			// 		show: {
+			// 			resource: [
+			// 				'sms',
+			// 			],
+			// 			operation: [
+			// 				'send',
+			// 			],
+			// 			type: [
+			// 				'binary',
+			// 			],
+			// 		},
+			// 	},
+			// 	default: '',
+			// 	description: 'Your custom Hex encoded User Data Header',
+			// },
+			// {
+			// 	displayName: 'Title',
+			// 	name: 'title',
+			// 	displayOptions: {
+			// 		show: {
+			// 			resource: [
+			// 				'sms',
+			// 			],
+			// 			operation: [
+			// 				'send',
+			// 			],
+			// 			type: [
+			// 				'wappush',
+			// 			],
+			// 		},
+			// 	},
+			// 	type: 'string',
+			// 	default: '',
+			// 	description: 'The title for a wappush SMS',
+			// },
+			// {
+			// 	displayName: 'URL',
+			// 	name: 'url',
+			// 	type: 'string',
+			// 	displayOptions: {
+			// 		show: {
+			// 			resource: [
+			// 				'sms',
+			// 			],
+			// 			operation: [
+			// 				'send',
+			// 			],
+			// 			type: [
+			// 				'wappush',
+			// 			],
+			// 		},
+			// 	},
+			// 	default: '',
+			// 	description: 'The URL of your website',
+			// },
+			// {
+			// 	displayName: 'Validity (in minutes)',
+			// 	name: 'validity',
+			// 	type: 'number',
+			// 	default: 0,
+			// 	displayOptions: {
+			// 		show: {
+			// 			resource: [
+			// 				'sms',
+			// 			],
+			// 			operation: [
+			// 				'send',
+			// 			],
+			// 			type: [
+			// 				'wappush',
+			// 			],
+			// 		},
+			// 	},
+			// 	description: 'The availability for an SMS in minutes',
+			// },
+			{
+				displayName: 'Message',
+				name: 'message',
+				type: 'string',
+				displayOptions: {
+					show: {
+						resource: ['sms'],
+						operation: ['send'],
+						// type: [
+						// 	'text',
+						// 	'unicode',
+						// ],
+					},
+				},
+				default: '',
+				description: 'The body of the message being sent',
+			},
+			// {
+			// 	displayName: 'VCard',
+			// 	name: 'vcard',
+			// 	type: 'string',
+			// 	displayOptions: {
+			// 		show: {
+			// 			resource: [
+			// 				'sms',
+			// 			],
+			// 			operation: [
+			// 				'send',
+			// 			],
+			// 			type: [
+			// 				'vcard',
+			// 			],
+			// 		},
+			// 	},
+			// 	default: '',
+			// 	description: 'A business card in vCard format',
+			// },
+			// {
+			// 	displayName: 'VCal',
+			// 	name: 'vcal',
+			// 	type: 'string',
+			// 	displayOptions: {
+			// 		show: {
+			// 			resource: [
+			// 				'sms',
+			// 			],
+			// 			operation: [
+			// 				'send',
+			// 			],
+			// 			type: [
+			// 				'vcal',
+			// 			],
+			// 		},
+			// 	},
+			// 	default: '',
+			// 	description: 'A calendar event in vCal format',
+			// },
+			{
+				displayName: 'Additional Fields',
+				name: 'additionalFields',
+				type: 'collection',
+				placeholder: 'Add Field',
+				displayOptions: {
+					show: {
+						resource: ['sms'],
+						operation: ['send'],
+					},
+				},
+				default: {},
+				options: [
+					{
+						displayName: 'Account Ref',
+						name: 'account-ref',
+						type: 'string',
+						default: '',
+						description:
+							'An optional string used to identify separate accounts using the SMS endpoint for billing purposes. To use this feature, please email support@nexmo.com.',
+					},
+					{
+						displayName: 'Callback',
+						name: 'callback',
+						type: 'string',
+						default: '',
+						description:
+							'The webhook endpoint the delivery receipt for this sms is sent to. This parameter overrides the webhook endpoint you set in Dashboard.',
+					},
+					{
+						displayName: 'Client Ref',
+						name: 'client-ref',
+						type: 'string',
+						default: '',
+						description: 'You can optionally include your own reference of up to 40 characters',
+					},
+					{
+						displayName: 'Message Class',
+						name: 'message-class',
+						type: 'options',
+						options: [
+							{
+								name: '0',
+								value: 0,
+							},
+							{
+								name: '1',
+								value: 1,
+							},
+							{
+								name: '2',
+								value: 2,
+							},
+							{
+								name: '3',
+								value: 3,
+							},
+						],
+						default: '',
+						description: 'The Data Coding Scheme value of the message',
+					},
+					{
+						displayName: 'Protocol ID',
+						name: 'protocol-id',
+						type: 'string',
+						default: '',
+						description:
+							'The value of the protocol identifier to use. Ensure that the value is aligned with udh.',
+					},
+					{
+						displayName: 'Status Report Req',
+						name: 'status-report-req',
+						type: 'boolean',
+						default: false,
+						description: 'Whether to receive a Delivery Receipt',
+					},
+					{
+						displayName: 'TTL (in Minutes)',
+						name: 'ttl',
+						type: 'number',
+						default: 4320,
+						description: 'By default Nexmo attempt delivery for 72 hours',
+					},
+				],
+			},
+		],
+	};
+
+	async execute(this: IExecuteFunctions): Promise<INodeExecutionData[][]> {
+		const items = this.getInputData();
+		const returnData: IDataObject[] = [];
+		const length = items.length;
+		let responseData;
+		const resource = this.getNodeParameter('resource', 0);
+		const operation = this.getNodeParameter('operation', 0);
+		for (let i = 0; i < length; i++) {
+			try {
+				if (resource === 'sms') {
+					if (operation === 'send') {
+						const from = this.getNodeParameter('from', i) as string;
+
+						const to = this.getNodeParameter('to', i) as string;
+
+						const type = this.getNodeParameter('type', i, 'text') as string;
+
+						const body: IDataObject = {
+							from,
+							to,
+							type,
+						};
+
+						if (type === 'text' || type === 'unicode') {
+							const message = this.getNodeParameter('message', i) as string;
+
+							body.text = message;
+						}
+
+						if (type === 'binary') {
+							const data = this.getNodeParameter('body', i) as string;
+
+							const udh = this.getNodeParameter('udh', i) as string;
+
+							body.udh = udh;
+
+							body.body = data;
+						}
+
+						if (type === 'wappush') {
+							const title = this.getNodeParameter('title', i) as string;
+
+							const url = this.getNodeParameter('url', i) as string;
+
+							const validity = this.getNodeParameter('validity', i) as number;
+
+							body.title = title;
+
+							body.url = url;
+
+							body.validity = validity * 60000;
+						}
+
+						if (type === 'vcard') {
+							const vcard = this.getNodeParameter('vcard', i) as string;
+
+							body.vcard = vcard;
+						}
+
+						if (type === 'vcal') {
+							const vcal = this.getNodeParameter('vcal', i) as string;
+
+							body.vcal = vcal;
+						}
+
+						const additionalFields = this.getNodeParameter('additionalFields', i);
+
+						Object.assign(body, additionalFields);
+
+						if (body.ttl) {
+							// transform minutes to milliseconds
+							body.ttl = (body.ttl as number) * 60000;
+						}
+
+						responseData = await vonageApiRequest.call(this, 'POST', '/sms/json', body);
+
+						responseData = responseData.messages;
+					}
+				}
+			} catch (error) {
+				if (this.continueOnFail()) {
+					returnData.push({ error: error.message });
+					continue;
+				}
+				throw error;
+			}
+			if (Array.isArray(responseData)) {
+				returnData.push.apply(returnData, responseData as IDataObject[]);
+			} else if (responseData !== undefined) {
+				returnData.push(responseData as IDataObject);
+			}
+		}
+		return [this.helpers.returnJsonArray(returnData)];
+	}
+}

packages/nodes-base/nodes/Vonage/__schema__/v1.0.0/sms/send.json

@@ -0,0 +1,24 @@
+{
+    "type": "object",
+    "properties": {
+        "message-id": {
+            "type": "string"
+        },
+        "message-price": {
+            "type": "string"
+        },
+        "network": {
+            "type": "string"
+        },
+        "remaining-balance": {
+            "type": "string"
+        },
+        "status": {
+            "type": "string"
+        },
+        "to": {
+            "type": "string"
+        }
+    },
+    "version": 1
+}

packages/nodes-base/nodes/Vonage/vonage.dark.svg

@@ -0,0 +1,3 @@
+<svg width="40" height="40" viewBox="0 0 40 40" fill="none" xmlns="http://www.w3.org/2000/svg">
+<path d="M7.89404 3H0L11.2583 28.5894C11.3377 28.7748 11.6291 28.7748 11.7086 28.5894L15.4437 19.7682L7.89404 3ZM31.947 3C31.947 3 19.8411 30.7086 18.2252 33.2781C16.3444 36.245 15.0993 37.3841 12.7682 37.755C12.7417 37.755 12.7417 37.7815 12.7417 37.8079C12.7417 37.8344 12.7682 37.8609 12.7947 37.8609H20.0265C23.1523 37.8609 25.4305 35.2384 26.6755 32.9338C28.106 30.3113 40 3.02649 40 3.02649H31.947V3Z" fill="white"/>
+</svg>

packages/nodes-base/nodes/Vonage/vonage.svg

@@ -0,0 +1,3 @@
+<svg width="40" height="40" viewBox="0 0 40 40" fill="none" xmlns="http://www.w3.org/2000/svg">
+<path d="M7.89404 3H0L11.2583 28.5894C11.3377 28.7748 11.6291 28.7748 11.7086 28.5894L15.4437 19.7682L7.89404 3ZM31.947 3C31.947 3 19.8411 30.7086 18.2252 33.2781C16.3444 36.245 15.0993 37.3841 12.7682 37.755C12.7417 37.755 12.7417 37.7815 12.7417 37.8079C12.7417 37.8344 12.7682 37.8609 12.7947 37.8609H20.0265C23.1523 37.8609 25.4305 35.2384 26.6755 32.9338C28.106 30.3113 40 3.02649 40 3.02649H31.947V3Z" fill="black"/>
+</svg>