n8n-nodes-adapay 0.1.0

package/README.md

@@ -0,0 +1,131 @@
+# n8n-nodes-adapay
+
+This is an n8n community node that provides integration with the AdaPay payment automation API.
+
+[n8n](https://n8n.io/) is a [fair-code licensed](https://docs.n8n.io/reference/license/) workflow automation platform.
+
+[AdaPay](https://adapay.com) is a payment automation platform that allows you to automate charge creation, customer management, bank integration, and more.
+
+## Installation
+
+Follow the [installation guide](https://docs.n8n.io/integrations/community-nodes/installation/) in the n8n community nodes documentation.
+
+## Operations
+
+### AdaPay Trigger (Webhook)
+
+Receive real-time events from AdaPay:
+- Charge events (created, paid, cancelled, refunded, expired)
+- Customer events (created, updated, deleted)
+- Bank integration events (connected, disconnected, error)
+
+### Automations
+
+- **Create** - Create a new automation
+- **Get** - Get an automation by ID
+- **Get All** - Get all automations with pagination
+- **Update** - Update an automation
+- **Toggle Status** - Enable or disable an automation
+- **Delete** - Delete an automation
+
+### Charges
+
+- **Create** - Create a new charge for a customer
+- **Get** - Get charge details by ID
+- **Get Many** - List charges with filters (customer, status, pagination)
+- **Update** - Update charge information
+- **Cancel** - Cancel a pending charge
+- **Refund** - Refund a paid charge (full or partial)
+
+### Customers
+
+- **Create** - Create a new customer with contact and address information
+- **Get** - Get customer details by ID
+- **Get Many** - List customers with filters (email, document, pagination)
+- **Update** - Update customer information
+- **Delete** - Delete a customer
+
+### Bank Integrations
+
+- **Connect** - Connect a new bank account
+- **Get** - Get bank integration details by ID
+- **Get Many** - List bank integrations with filters (bank name, status)
+- **Update** - Update bank integration settings
+- **Disconnect** - Disconnect a bank integration
+- **Sync** - Synchronize transactions from bank
+- **Get Balance** - Get current account balance
+
+## Credentials
+
+To use this node, you need an AdaPay Access Key. You can generate one in your AdaPay dashboard under Automations.
+
+## Usage Examples
+
+### Example 1: Automated Payment Workflow
+
+1. **AdaPay Trigger** - Listen for `charge.created` events
+2. **AdaPay Customer** - Get customer details
+3. **Email** - Send payment confirmation to customer
+
+### Example 2: Customer Onboarding
+
+1. **Webhook** - Receive new user registration
+2. **AdaPay Customer** - Create new customer in AdaPay
+3. **AdaPay Charge** - Create initial charge
+4. **AdaPay Trigger** - Wait for payment confirmation
+
+### Example 3: Bank Reconciliation
+
+1. **Schedule Trigger** - Run daily at midnight
+2. **AdaPay Bank Integration** - Sync transactions
+3. **AdaPay Charge** - Get all charges
+4. **Function** - Match transactions with charges
+5. **Spreadsheet** - Update reconciliation report
+
+### Example 4: Refund Management
+
+1. **AdaPay Trigger** - Listen for refund requests
+2. **AdaPay Charge** - Get charge details
+3. **IF** - Check if refund is eligible
+4. **AdaPay Charge** - Process refund
+5. **Email** - Send refund confirmation
+
+## Compatibility
+
+Tested with n8n version 1.0.0+
+
+## Resources
+
+- [n8n community nodes documentation](https://docs.n8n.io/integrations/community-nodes/)
+- [AdaPay API Documentation](https://api.adapay.com/docs)
+- [Example Workflows](./examples/) - Check the examples folder for sample workflows
+
+## Development
+
+### Build the Project
+
+```bash
+npm run build
+```
+
+### Run in Development Mode
+
+```bash
+npm run dev
+```
+
+### Format Code
+
+```bash
+npm run format
+```
+
+### Lint Code
+
+```bash
+npm run lint
+```
+
+## License
+
+MIT

package/dist/credentials/AdaPayApi.credentials.d.ts

@@ -0,0 +1,9 @@
+import type { IAuthenticateGeneric, ICredentialTestRequest, ICredentialType, INodeProperties } from 'n8n-workflow';
+export declare class AdaPayApi implements ICredentialType {
+    name: string;
+    displayName: string;
+    documentationUrl: string;
+    properties: INodeProperties[];
+    authenticate: IAuthenticateGeneric;
+    test: ICredentialTestRequest;
+}

package/dist/credentials/AdaPayApi.credentials.js

@@ -0,0 +1,54 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AdaPayApi = void 0;
+class AdaPayApi {
+    name = 'adaPayApi';
+    displayName = 'AdaPay API';
+    documentationUrl = 'https://api.adapay.com/docs';
+    properties = [
+        {
+            displayName: 'Access Key',
+            name: 'accessKey',
+            type: 'string',
+            typeOptions: {
+                password: true,
+            },
+            default: '',
+            required: true,
+            description: 'The AdaPay Access Key for authentication. Generate it in your AdaPay dashboard under Automations.',
+        },
+        {
+            displayName: 'Environment',
+            name: 'environment',
+            type: 'options',
+            options: [
+                {
+                    name: 'Production',
+                    value: 'production',
+                },
+                {
+                    name: 'Development',
+                    value: 'development',
+                },
+            ],
+            default: 'production',
+            description: 'The environment to connect to',
+        },
+    ];
+    authenticate = {
+        type: 'generic',
+        properties: {
+            headers: {
+                'X-Access-Key': '={{$credentials.accessKey}}',
+            },
+        },
+    };
+    test = {
+        request: {
+            baseURL: '={{$credentials.environment === "production" ? "https://api.adapay.com" : "http://localhost:3002"}}',
+            url: '/api/plugin/automations',
+            method: 'GET',
+        },
+    };
+}
+exports.AdaPayApi = AdaPayApi;

package/dist/nodes/AdaPay/AdaPay.node.d.ts

@@ -0,0 +1,5 @@
+import type { IExecuteFunctions, INodeExecutionData, INodeType, INodeTypeDescription } from 'n8n-workflow';
+export declare class AdaPay implements INodeType {
+    description: INodeTypeDescription;
+    execute(this: IExecuteFunctions): Promise<INodeExecutionData[][]>;
+}

package/dist/nodes/AdaPay/AdaPay.node.js

@@ -0,0 +1,452 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AdaPay = void 0;
+class AdaPay {
+    description = {
+        displayName: 'AdaPay',
+        name: 'adaPay',
+        icon: 'file:adapay.svg',
+        group: ['transform'],
+        version: 1,
+        subtitle: '={{$parameter["operation"] + ": " + $parameter["resource"]}}',
+        description: 'Interact with AdaPay API',
+        defaults: {
+            name: 'AdaPay',
+        },
+        inputs: ['main'],
+        outputs: ['main'],
+        credentials: [
+            {
+                name: 'adaPayApi',
+                required: true,
+            },
+        ],
+        requestDefaults: {
+            baseURL: '={{$credentials.environment === "production" ? "https://api.adapay.com" : "http://localhost:3002"}}',
+            headers: {
+                Accept: 'application/json',
+                'Content-Type': 'application/json',
+            },
+        },
+        properties: [
+            // Resource selection
+            {
+                displayName: 'Resource',
+                name: 'resource',
+                type: 'options',
+                noDataExpression: true,
+                options: [
+                    {
+                        name: 'Automation',
+                        value: 'automation',
+                    },
+                ],
+                default: 'automation',
+            },
+            // Automation operations
+            {
+                displayName: 'Operation',
+                name: 'operation',
+                type: 'options',
+                noDataExpression: true,
+                displayOptions: {
+                    show: {
+                        resource: ['automation'],
+                    },
+                },
+                options: [
+                    {
+                        name: 'Create',
+                        value: 'create',
+                        description: 'Create a new automation',
+                        action: 'Create an automation',
+                    },
+                    {
+                        name: 'Delete',
+                        value: 'delete',
+                        description: 'Delete an automation',
+                        action: 'Delete an automation',
+                    },
+                    {
+                        name: 'Get',
+                        value: 'get',
+                        description: 'Get an automation by ID',
+                        action: 'Get an automation',
+                    },
+                    {
+                        name: 'Get Many',
+                        value: 'getAll',
+                        description: 'Get all automations',
+                        action: 'Get many automations',
+                    },
+                    {
+                        name: 'Toggle Status',
+                        value: 'toggleStatus',
+                        description: 'Enable or disable an automation',
+                        action: 'Toggle automation status',
+                    },
+                    {
+                        name: 'Update',
+                        value: 'update',
+                        description: 'Update an automation',
+                        action: 'Update an automation',
+                    },
+                ],
+                default: 'create',
+            },
+            // Automation: Create
+            {
+                displayName: 'Name',
+                name: 'name',
+                type: 'string',
+                required: true,
+                displayOptions: {
+                    show: {
+                        resource: ['automation'],
+                        operation: ['create'],
+                    },
+                },
+                default: '',
+                description: 'Name of the automation',
+            },
+            {
+                displayName: 'Description',
+                name: 'description',
+                type: 'string',
+                displayOptions: {
+                    show: {
+                        resource: ['automation'],
+                        operation: ['create'],
+                    },
+                },
+                default: '',
+                description: 'Description of the automation',
+            },
+            {
+                displayName: 'Events',
+                name: 'events',
+                type: 'multiOptions',
+                required: true,
+                displayOptions: {
+                    show: {
+                        resource: ['automation'],
+                        operation: ['create'],
+                    },
+                },
+                options: [
+                    { name: 'Charge Created', value: 'charge.created' },
+                    { name: 'Charge Paid', value: 'charge.paid' },
+                    { name: 'Charge Cancelled', value: 'charge.cancelled' },
+                    { name: 'Customer Created', value: 'customer.created' },
+                    { name: 'Customer Updated', value: 'customer.updated' },
+                    { name: 'Customer Deleted', value: 'customer.deleted' },
+                    { name: 'Bank Integration Connected', value: 'bank_integration.connected' },
+                ],
+                default: [],
+                description: 'Events that trigger this automation',
+            },
+            {
+                displayName: 'Actions',
+                name: 'actions',
+                type: 'multiOptions',
+                required: true,
+                displayOptions: {
+                    show: {
+                        resource: ['automation'],
+                        operation: ['create'],
+                    },
+                },
+                options: [
+                    { name: 'Send Email', value: 'email.send' },
+                    { name: 'Send SMS', value: 'sms.send' },
+                    { name: 'Send Webhook', value: 'webhook.send' },
+                    { name: 'Create Charge', value: 'charge.create' },
+                    { name: 'Update Customer', value: 'customer.update' },
+                    { name: 'Create Tag', value: 'tag.create' },
+                    { name: 'Update Charge', value: 'charge.update' },
+                    { name: 'Create Customer Note', value: 'customer.note.create' },
+                    { name: 'Update Bank Integration', value: 'bank_integration.update' },
+                    { name: 'Send Push Notification', value: 'push.send' },
+                ],
+                default: [],
+                description: 'Actions to execute when triggered',
+            },
+            {
+                displayName: 'Webhook URL',
+                name: 'webhookUrl',
+                type: 'string',
+                displayOptions: {
+                    show: {
+                        resource: ['automation'],
+                        operation: ['create'],
+                    },
+                },
+                default: '',
+                description: 'Optional webhook URL to call when this automation is triggered',
+            },
+            {
+                displayName: 'Is Active',
+                name: 'isActive',
+                type: 'boolean',
+                displayOptions: {
+                    show: {
+                        resource: ['automation'],
+                        operation: ['create'],
+                    },
+                },
+                default: true,
+                description: 'Whether the automation should be active upon creation',
+            },
+            // Automation: Get
+            {
+                displayName: 'Automation ID',
+                name: 'automationId',
+                type: 'string',
+                required: true,
+                displayOptions: {
+                    show: {
+                        resource: ['automation'],
+                        operation: ['get', 'delete', 'update', 'toggleStatus'],
+                    },
+                },
+                default: '',
+                description: 'ID of the automation',
+            },
+            // Automation: Update
+            {
+                displayName: 'Update Fields',
+                name: 'updateFields',
+                type: 'collection',
+                placeholder: 'Add Field',
+                default: {},
+                displayOptions: {
+                    show: {
+                        resource: ['automation'],
+                        operation: ['update'],
+                    },
+                },
+                options: [
+                    {
+                        displayName: 'Name',
+                        name: 'name',
+                        type: 'string',
+                        default: '',
+                        description: 'Name of the automation',
+                    },
+                    {
+                        displayName: 'Description',
+                        name: 'description',
+                        type: 'string',
+                        default: '',
+                        description: 'Description of the automation',
+                    },
+                    {
+                        displayName: 'Events',
+                        name: 'events',
+                        type: 'multiOptions',
+                        options: [
+                            { name: 'Charge Created', value: 'charge.created' },
+                            { name: 'Charge Paid', value: 'charge.paid' },
+                            { name: 'Charge Cancelled', value: 'charge.cancelled' },
+                            { name: 'Customer Created', value: 'customer.created' },
+                            { name: 'Customer Updated', value: 'customer.updated' },
+                            { name: 'Customer Deleted', value: 'customer.deleted' },
+                            { name: 'Bank Integration Connected', value: 'bank_integration.connected' },
+                        ],
+                        default: [],
+                        description: 'Events that trigger this automation',
+                    },
+                    {
+                        displayName: 'Actions',
+                        name: 'actions',
+                        type: 'multiOptions',
+                        options: [
+                            { name: 'Send Email', value: 'email.send' },
+                            { name: 'Send SMS', value: 'sms.send' },
+                            { name: 'Send Webhook', value: 'webhook.send' },
+                            { name: 'Create Charge', value: 'charge.create' },
+                            { name: 'Update Customer', value: 'customer.update' },
+                            { name: 'Create Tag', value: 'tag.create' },
+                            { name: 'Update Charge', value: 'charge.update' },
+                            { name: 'Create Customer Note', value: 'customer.note.create' },
+                            { name: 'Update Bank Integration', value: 'bank_integration.update' },
+                            { name: 'Send Push Notification', value: 'push.send' },
+                        ],
+                        default: [],
+                        description: 'Actions to execute when triggered',
+                    },
+                    {
+                        displayName: 'Webhook URL',
+                        name: 'webhookUrl',
+                        type: 'string',
+                        default: '',
+                        description: 'Webhook URL to call when this automation is triggered',
+                    },
+                ],
+            },
+            // Automation: Get Many
+            {
+                displayName: 'Return All',
+                name: 'returnAll',
+                type: 'boolean',
+                displayOptions: {
+                    show: {
+                        resource: ['automation'],
+                        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: ['automation'],
+                        operation: ['getAll'],
+                        returnAll: [false],
+                    },
+                },
+                typeOptions: {
+                    minValue: 1,
+                    maxValue: 100,
+                },
+                default: 50,
+                description: 'Max number of results to return',
+            },
+            {
+                displayName: 'Additional Fields',
+                name: 'additionalFields',
+                type: 'collection',
+                placeholder: 'Add Field',
+                default: {},
+                displayOptions: {
+                    show: {
+                        resource: ['automation'],
+                        operation: ['getAll'],
+                    },
+                },
+                options: [
+                    {
+                        displayName: 'Page',
+                        name: 'page',
+                        type: 'number',
+                        default: 1,
+                        description: 'Page number to retrieve',
+                    },
+                ],
+            },
+        ],
+    };
+    async execute() {
+        const items = this.getInputData();
+        const returnData = [];
+        const resource = this.getNodeParameter('resource', 0);
+        const operation = this.getNodeParameter('operation', 0);
+        for (let i = 0; i < items.length; i++) {
+            try {
+                if (resource === 'automation') {
+                    if (operation === 'create') {
+                        // Create automation
+                        const name = this.getNodeParameter('name', i);
+                        const description = this.getNodeParameter('description', i);
+                        const events = this.getNodeParameter('events', i);
+                        const actions = this.getNodeParameter('actions', i);
+                        const webhookUrl = this.getNodeParameter('webhookUrl', i, '');
+                        const isActive = this.getNodeParameter('isActive', i);
+                        const body = {
+                            name,
+                            description,
+                            events,
+                            actions,
+                            isActive,
+                        };
+                        if (webhookUrl) {
+                            body.webhookUrl = webhookUrl;
+                        }
+                        const options = {
+                            method: 'POST',
+                            url: '/api/plugin/automations',
+                            body,
+                        };
+                        const responseData = await this.helpers.httpRequestWithAuthentication.call(this, 'adaPayApi', options);
+                        returnData.push({ json: responseData });
+                    }
+                    else if (operation === 'get') {
+                        // Get automation
+                        const automationId = this.getNodeParameter('automationId', i);
+                        const options = {
+                            method: 'GET',
+                            url: `/api/plugin/automations/${automationId}`,
+                        };
+                        const responseData = await this.helpers.httpRequestWithAuthentication.call(this, 'adaPayApi', options);
+                        returnData.push({ json: responseData });
+                    }
+                    else if (operation === 'getAll') {
+                        // Get all automations
+                        const returnAll = this.getNodeParameter('returnAll', i);
+                        const additionalFields = this.getNodeParameter('additionalFields', i);
+                        const qs = {
+                            page: additionalFields.page || 1,
+                        };
+                        if (!returnAll) {
+                            qs.limit = this.getNodeParameter('limit', i);
+                        }
+                        const options = {
+                            method: 'GET',
+                            url: '/api/plugin/automations',
+                            qs,
+                        };
+                        const responseData = await this.helpers.httpRequestWithAuthentication.call(this, 'adaPayApi', options);
+                        const automations = responseData.data;
+                        returnData.push(...automations.map((automation) => ({ json: automation })));
+                    }
+                    else if (operation === 'update') {
+                        // Update automation
+                        const automationId = this.getNodeParameter('automationId', i);
+                        const updateFields = this.getNodeParameter('updateFields', i);
+                        const options = {
+                            method: 'PATCH',
+                            url: `/api/plugin/automations/${automationId}`,
+                            body: updateFields,
+                        };
+                        const responseData = await this.helpers.httpRequestWithAuthentication.call(this, 'adaPayApi', options);
+                        returnData.push({ json: responseData });
+                    }
+                    else if (operation === 'toggleStatus') {
+                        // Toggle automation status
+                        const automationId = this.getNodeParameter('automationId', i);
+                        const options = {
+                            method: 'PATCH',
+                            url: `/api/plugin/automations/${automationId}/toggle-status`,
+                        };
+                        const responseData = await this.helpers.httpRequestWithAuthentication.call(this, 'adaPayApi', options);
+                        returnData.push({ json: responseData });
+                    }
+                    else if (operation === 'delete') {
+                        // Delete automation
+                        const automationId = this.getNodeParameter('automationId', i);
+                        const options = {
+                            method: 'DELETE',
+                            url: `/api/plugin/automations/${automationId}`,
+                        };
+                        const responseData = await this.helpers.httpRequestWithAuthentication.call(this, 'adaPayApi', options);
+                        returnData.push({ json: responseData });
+                    }
+                }
+            }
+            catch (error) {
+                if (this.continueOnFail()) {
+                    const errorMessage = error instanceof Error ? error.message : 'Unknown error';
+                    returnData.push({ json: { error: errorMessage }, pairedItem: { item: i } });
+                    continue;
+                }
+                throw error;
+            }
+        }
+        return [returnData];
+    }
+}
+exports.AdaPay = AdaPay;

package/dist/nodes/AdaPay/AdaPayBankIntegration.node.d.ts

@@ -0,0 +1,5 @@
+import type { IExecuteFunctions, INodeExecutionData, INodeType, INodeTypeDescription } from 'n8n-workflow';
+export declare class AdaPayBankIntegration implements INodeType {
+    description: INodeTypeDescription;
+    execute(this: IExecuteFunctions): Promise<INodeExecutionData[][]>;
+}