n8n-nodes-perfexcrm 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 OBS Technologies
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,119 @@
+# n8n-nodes-perfexcrm
+
+This is an n8n community node. It lets you use PerfexCRM in your n8n workflows.
+
+PerfexCRM is a powerful customer relationship management system. This node allows you to interact with the PerfexCRM API and receive webhooks for real-time events.
+
+[n8n](https://n8n.io/) is a [fair-code licensed](https://docs.n8n.io/reference/license/) workflow automation platform.
+
+## Installation
+
+Follow the [installation guide](https://docs.n8n.io/integrations/community-nodes/installation/) in the n8n community nodes documentation.
+
+### Manual Installation
+
+1. Clone or download this repository
+2. In your n8n installation folder, navigate to `~/.n8n/nodes/`
+3. Create a folder called `n8n-nodes-perfexcrm`
+4. Copy all files from this repository into that folder
+5. Build the node:
+   ```bash
+   cd ~/.n8n/nodes/n8n-nodes-perfexcrm
+   npm install
+   npm run build
+   ```
+6. Restart n8n
+
+## Operations
+
+### PerfexCRM Node
+
+This node allows you to perform CRUD operations on various PerfexCRM resources:
+
+#### Customers
+- Create a new customer
+- Get a customer by ID
+- Get all customers with filters
+- Update a customer
+- Delete a customer
+
+#### Tickets
+- Create a new ticket
+- Get a ticket by ID
+- Get all tickets with filters
+- Update a ticket
+- Delete a ticket
+- Add a reply to a ticket
+
+#### Invoices
+- Create a new invoice
+- Get an invoice by ID
+- Get all invoices with filters
+
+#### Leads
+- Create a new lead
+- Get a lead by ID
+- Convert a lead to customer
+
+#### Projects
+- Create a new project
+- Get a project by ID
+
+#### Contracts
+- Create a new contract
+- Get a contract by ID
+
+### PerfexCRM Trigger Node
+
+This trigger node listens for webhooks from PerfexCRM and starts workflows when events occur:
+
+#### Supported Events
+- Customer events (created, updated, deleted)
+- Contact events (created, updated, deleted)
+- Lead events (created, updated, converted, deleted)
+- Invoice events (created, updated, paid, overdue, deleted)
+- Payment events (recorded, failed)
+- Proposal events (created, sent, accepted, declined)
+- Estimate events (created, sent, accepted, declined, converted)
+- Contract events (created, signed, expiring, expired)
+- Project events (created, updated, completed)
+- Task events (created, updated, completed, comment added)
+- Ticket events (created, updated, status changed, reply added, assigned, closed)
+- Staff events (created, login)
+- Expense events (created, updated)
+
+## Credentials
+
+You'll need to enter the following credentials to use this node:
+
+1. **Base URL**: The URL of your PerfexCRM installation (e.g., `https://your-perfex.com`)
+2. **API Key**: Your PerfexCRM API key (starts with `pk_`)
+3. **API Version**: The API version to use (currently only `v1` is supported)
+
+### Getting your API Key
+
+1. Log in to your PerfexCRM admin panel
+2. Navigate to **Setup** → **API & Webhooks**
+3. Click on **API Keys**
+4. Create a new API key with the appropriate permissions
+5. Copy the API key (you'll only see it once!)
+
+## Compatibility
+
+- Requires n8n version 0.180.0 or later
+- Tested with PerfexCRM 2.3.x and later
+
+## Resources
+
+* [n8n community nodes documentation](https://docs.n8n.io/integrations/community-nodes/)
+* [PerfexCRM API Documentation](https://your-perfex.com/admin/api_webhooks/documentation)
+
+## Support
+
+For issues specific to this node, please create an issue in this repository.
+
+For general n8n support, visit the [n8n community forum](https://community.n8n.io/).
+
+## License
+
+[MIT](https://github.com/your-org/n8n-nodes-perfexcrm/blob/master/LICENSE.md)

package/dist/credentials/PerfexCrmApi.credentials.d.ts

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

package/dist/credentials/PerfexCrmApi.credentials.js

@@ -0,0 +1,71 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PerfexCrmApi = void 0;
+class PerfexCrmApi {
+    constructor() {
+        this.name = 'perfexCrmApi';
+        this.displayName = 'PerfexCRM API';
+        this.documentationUrl = 'https://github.com/your-org/n8n-nodes-perfexcrm';
+        this.properties = [
+            {
+                displayName: 'Base URL',
+                name: 'baseUrl',
+                type: 'string',
+                default: '',
+                placeholder: 'https://your-perfex-instance.com',
+                required: true,
+                description: 'The base URL of your PerfexCRM instance',
+            },
+            {
+                displayName: 'API Key',
+                name: 'apiKey',
+                type: 'string',
+                typeOptions: {
+                    password: true,
+                },
+                default: '',
+                required: true,
+                description: 'Your PerfexCRM API key (starts with pk_)',
+            },
+            {
+                displayName: 'API Version',
+                name: 'apiVersion',
+                type: 'options',
+                options: [
+                    {
+                        name: 'V1',
+                        value: 'v1',
+                    },
+                ],
+                default: 'v1',
+                description: 'The API version to use',
+            },
+        ];
+        this.authenticate = {
+            type: 'generic',
+            properties: {
+                headers: {
+                    'X-API-KEY': '={{$credentials.apiKey}}',
+                },
+            },
+        };
+        this.test = {
+            request: {
+                baseURL: '={{$credentials.baseUrl}}',
+                url: '/api/{{$credentials.apiVersion}}/customers?limit=1',
+                method: 'GET',
+            },
+            rules: [
+                {
+                    type: 'responseSuccessBody',
+                    properties: {
+                        key: 'success',
+                        value: true,
+                        message: 'Authentication successful!',
+                    },
+                },
+            ],
+        };
+    }
+}
+exports.PerfexCrmApi = PerfexCrmApi;

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

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

package/dist/nodes/PerfexCrm/PerfexCrm.node.js

@@ -0,0 +1,409 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PerfexCrm = void 0;
+const CustomerDescription_1 = require("./descriptions/CustomerDescription");
+const TicketDescription_1 = require("./descriptions/TicketDescription");
+const InvoiceDescription_1 = require("./descriptions/InvoiceDescription");
+const LeadDescription_1 = require("./descriptions/LeadDescription");
+const ProjectDescription_1 = require("./descriptions/ProjectDescription");
+const ContractDescription_1 = require("./descriptions/ContractDescription");
+class PerfexCrm {
+    constructor() {
+        this.description = {
+            displayName: 'PerfexCRM',
+            name: 'perfexCrm',
+            icon: 'file:perfexcrm.svg',
+            group: ['transform'],
+            version: 1,
+            subtitle: '={{$parameter["operation"] + ": " + $parameter["resource"]}}',
+            description: 'Interact with PerfexCRM API',
+            defaults: {
+                name: 'PerfexCRM',
+            },
+            inputs: ["main" /* NodeConnectionType.Main */],
+            outputs: ["main" /* NodeConnectionType.Main */],
+            credentials: [
+                {
+                    name: 'perfexCrmApi',
+                    required: true,
+                },
+            ],
+            properties: [
+                {
+                    displayName: 'Resource',
+                    name: 'resource',
+                    type: 'options',
+                    noDataExpression: true,
+                    options: [
+                        {
+                            name: 'Customer',
+                            value: 'customer',
+                        },
+                        {
+                            name: 'Ticket',
+                            value: 'ticket',
+                        },
+                        {
+                            name: 'Invoice',
+                            value: 'invoice',
+                        },
+                        {
+                            name: 'Lead',
+                            value: 'lead',
+                        },
+                        {
+                            name: 'Project',
+                            value: 'project',
+                        },
+                        {
+                            name: 'Contract',
+                            value: 'contract',
+                        },
+                    ],
+                    default: 'customer',
+                },
+                ...CustomerDescription_1.customerOperations,
+                ...CustomerDescription_1.customerFields,
+                ...TicketDescription_1.ticketOperations,
+                ...TicketDescription_1.ticketFields,
+                ...InvoiceDescription_1.invoiceOperations,
+                ...InvoiceDescription_1.invoiceFields,
+                ...LeadDescription_1.leadOperations,
+                ...LeadDescription_1.leadFields,
+                ...ProjectDescription_1.projectOperations,
+                ...ProjectDescription_1.projectFields,
+                ...ContractDescription_1.contractOperations,
+                ...ContractDescription_1.contractFields,
+            ],
+        };
+    }
+    async execute() {
+        const items = this.getInputData();
+        const returnData = [];
+        const credentials = await this.getCredentials('perfexCrmApi');
+        const resource = this.getNodeParameter('resource', 0);
+        const operation = this.getNodeParameter('operation', 0);
+        let responseData;
+        const baseUrl = credentials.baseUrl;
+        const apiVersion = credentials.apiVersion;
+        for (let i = 0; i < items.length; i++) {
+            try {
+                if (resource === 'customer') {
+                    if (operation === 'create') {
+                        const company = this.getNodeParameter('company', i);
+                        const additionalFields = this.getNodeParameter('additionalFields', i);
+                        const body = {
+                            company,
+                            ...additionalFields,
+                        };
+                        responseData = await this.helpers.request({
+                            method: 'POST',
+                            url: `${baseUrl}/api/${apiVersion}/customers`,
+                            body,
+                            json: true,
+                        });
+                    }
+                    else if (operation === 'get') {
+                        const customerId = this.getNodeParameter('customerId', i);
+                        responseData = await this.helpers.request({
+                            method: 'GET',
+                            url: `${baseUrl}/api/${apiVersion}/customers/${customerId}`,
+                            json: true,
+                        });
+                    }
+                    else if (operation === 'getAll') {
+                        const returnAll = this.getNodeParameter('returnAll', i);
+                        const filters = this.getNodeParameter('filters', i);
+                        const qs = {};
+                        if (!returnAll) {
+                            qs.limit = this.getNodeParameter('limit', i);
+                        }
+                        else {
+                            qs.limit = 1000;
+                        }
+                        Object.assign(qs, filters);
+                        responseData = await this.helpers.request({
+                            method: 'GET',
+                            url: `${baseUrl}/api/${apiVersion}/customers`,
+                            qs,
+                            json: true,
+                        });
+                        if (responseData.data) {
+                            responseData = responseData.data;
+                        }
+                    }
+                    else if (operation === 'update') {
+                        const customerId = this.getNodeParameter('customerId', i);
+                        const updateFields = this.getNodeParameter('updateFields', i);
+                        const body = updateFields;
+                        responseData = await this.helpers.request({
+                            method: 'PUT',
+                            url: `${baseUrl}/api/${apiVersion}/customers/${customerId}`,
+                            body,
+                            json: true,
+                        });
+                    }
+                    else if (operation === 'delete') {
+                        const customerId = this.getNodeParameter('customerId', i);
+                        responseData = await this.helpers.request({
+                            method: 'DELETE',
+                            url: `${baseUrl}/api/${apiVersion}/customers/${customerId}`,
+                            json: true,
+                        });
+                    }
+                }
+                else if (resource === 'ticket') {
+                    if (operation === 'create') {
+                        const subject = this.getNodeParameter('subject', i);
+                        const department = this.getNodeParameter('department', i);
+                        const additionalFields = this.getNodeParameter('additionalFields', i);
+                        const body = {
+                            subject,
+                            department,
+                            ...additionalFields,
+                        };
+                        responseData = await this.helpers.request({
+                            method: 'POST',
+                            url: `${baseUrl}/api/${apiVersion}/tickets`,
+                            body,
+                            json: true,
+                        });
+                    }
+                    else if (operation === 'get') {
+                        const ticketId = this.getNodeParameter('ticketId', i);
+                        const options = this.getNodeParameter('options', i);
+                        const qs = {};
+                        if (options.includeReplies) {
+                            qs.include = 'replies';
+                        }
+                        responseData = await this.helpers.request({
+                            method: 'GET',
+                            url: `${baseUrl}/api/${apiVersion}/tickets/${ticketId}`,
+                            qs,
+                            json: true,
+                        });
+                    }
+                    else if (operation === 'getAll') {
+                        const returnAll = this.getNodeParameter('returnAll', i);
+                        const filters = this.getNodeParameter('filters', i);
+                        const qs = {};
+                        if (!returnAll) {
+                            qs.limit = this.getNodeParameter('limit', i);
+                        }
+                        else {
+                            qs.limit = 1000;
+                        }
+                        // Handle status filter
+                        if (filters.status) {
+                            qs.status = filters.status;
+                        }
+                        if (filters.department) {
+                            qs.department = filters.department;
+                        }
+                        if (filters.priority) {
+                            qs.priority = filters.priority;
+                        }
+                        responseData = await this.helpers.request({
+                            method: 'GET',
+                            url: `${baseUrl}/api/${apiVersion}/tickets`,
+                            qs,
+                            json: true,
+                        });
+                        if (responseData.data) {
+                            responseData = responseData.data;
+                        }
+                    }
+                    else if (operation === 'update') {
+                        const ticketId = this.getNodeParameter('ticketId', i);
+                        const updateFields = this.getNodeParameter('updateFields', i);
+                        const body = updateFields;
+                        responseData = await this.helpers.request({
+                            method: 'PUT',
+                            url: `${baseUrl}/api/${apiVersion}/tickets/${ticketId}`,
+                            body,
+                            json: true,
+                        });
+                    }
+                    else if (operation === 'delete') {
+                        const ticketId = this.getNodeParameter('ticketId', i);
+                        responseData = await this.helpers.request({
+                            method: 'DELETE',
+                            url: `${baseUrl}/api/${apiVersion}/tickets/${ticketId}`,
+                            json: true,
+                        });
+                    }
+                    else if (operation === 'addReply') {
+                        const ticketId = this.getNodeParameter('ticketId', i);
+                        const message = this.getNodeParameter('message', i);
+                        const additionalFields = this.getNodeParameter('additionalFields', i);
+                        const body = {
+                            message,
+                            ...additionalFields,
+                        };
+                        responseData = await this.helpers.request({
+                            method: 'POST',
+                            url: `${baseUrl}/api/${apiVersion}/tickets/${ticketId}/replies`,
+                            body,
+                            json: true,
+                        });
+                    }
+                }
+                else if (resource === 'invoice') {
+                    if (operation === 'create') {
+                        const clientId = this.getNodeParameter('clientId', i);
+                        const number = this.getNodeParameter('number', i);
+                        const date = this.getNodeParameter('date', i);
+                        const duedate = this.getNodeParameter('duedate', i);
+                        const additionalFields = this.getNodeParameter('additionalFields', i);
+                        const body = {
+                            clientid: clientId,
+                            number,
+                            date,
+                            duedate,
+                            ...additionalFields,
+                        };
+                        responseData = await this.helpers.request({
+                            method: 'POST',
+                            url: `${baseUrl}/api/${apiVersion}/invoices`,
+                            body,
+                            json: true,
+                        });
+                    }
+                    else if (operation === 'get') {
+                        const invoiceId = this.getNodeParameter('invoiceId', i);
+                        responseData = await this.helpers.request({
+                            method: 'GET',
+                            url: `${baseUrl}/api/${apiVersion}/invoices/${invoiceId}`,
+                            json: true,
+                        });
+                    }
+                    else if (operation === 'getAll') {
+                        const returnAll = this.getNodeParameter('returnAll', i);
+                        const filters = this.getNodeParameter('filters', i);
+                        const qs = {};
+                        if (!returnAll) {
+                            qs.limit = this.getNodeParameter('limit', i);
+                        }
+                        else {
+                            qs.limit = 1000;
+                        }
+                        Object.assign(qs, filters);
+                        responseData = await this.helpers.request({
+                            method: 'GET',
+                            url: `${baseUrl}/api/${apiVersion}/invoices`,
+                            qs,
+                            json: true,
+                        });
+                        if (responseData.data) {
+                            responseData = responseData.data;
+                        }
+                    }
+                }
+                else if (resource === 'lead') {
+                    if (operation === 'create') {
+                        const name = this.getNodeParameter('name', i);
+                        const additionalFields = this.getNodeParameter('additionalFields', i);
+                        const body = {
+                            name,
+                            ...additionalFields,
+                        };
+                        responseData = await this.helpers.request({
+                            method: 'POST',
+                            url: `${baseUrl}/api/${apiVersion}/leads`,
+                            body,
+                            json: true,
+                        });
+                    }
+                    else if (operation === 'get') {
+                        const leadId = this.getNodeParameter('leadId', i);
+                        responseData = await this.helpers.request({
+                            method: 'GET',
+                            url: `${baseUrl}/api/${apiVersion}/leads/${leadId}`,
+                            json: true,
+                        });
+                    }
+                    else if (operation === 'convert') {
+                        const leadId = this.getNodeParameter('leadId', i);
+                        responseData = await this.helpers.request({
+                            method: 'POST',
+                            url: `${baseUrl}/api/${apiVersion}/leads/${leadId}/convert`,
+                            json: true,
+                        });
+                    }
+                }
+                else if (resource === 'project') {
+                    if (operation === 'create') {
+                        const name = this.getNodeParameter('name', i);
+                        const clientId = this.getNodeParameter('clientId', i);
+                        const additionalFields = this.getNodeParameter('additionalFields', i);
+                        const body = {
+                            name,
+                            clientid: clientId,
+                            ...additionalFields,
+                        };
+                        responseData = await this.helpers.request({
+                            method: 'POST',
+                            url: `${baseUrl}/api/${apiVersion}/projects`,
+                            body,
+                            json: true,
+                        });
+                    }
+                    else if (operation === 'get') {
+                        const projectId = this.getNodeParameter('projectId', i);
+                        responseData = await this.helpers.request({
+                            method: 'GET',
+                            url: `${baseUrl}/api/${apiVersion}/projects/${projectId}`,
+                            json: true,
+                        });
+                    }
+                }
+                else if (resource === 'contract') {
+                    if (operation === 'create') {
+                        const subject = this.getNodeParameter('subject', i);
+                        const client = this.getNodeParameter('client', i);
+                        const datestart = this.getNodeParameter('datestart', i);
+                        const dateend = this.getNodeParameter('dateend', i);
+                        const additionalFields = this.getNodeParameter('additionalFields', i);
+                        const body = {
+                            subject,
+                            client,
+                            datestart,
+                            dateend,
+                            ...additionalFields,
+                        };
+                        responseData = await this.helpers.request({
+                            method: 'POST',
+                            url: `${baseUrl}/api/${apiVersion}/contracts`,
+                            body,
+                            json: true,
+                        });
+                    }
+                    else if (operation === 'get') {
+                        const contractId = this.getNodeParameter('contractId', i);
+                        responseData = await this.helpers.request({
+                            method: 'GET',
+                            url: `${baseUrl}/api/${apiVersion}/contracts/${contractId}`,
+                            json: true,
+                        });
+                    }
+                }
+                if (Array.isArray(responseData)) {
+                    returnData.push(...responseData.map((item) => ({ json: item })));
+                }
+                else {
+                    returnData.push({ json: responseData });
+                }
+            }
+            catch (error) {
+                if (this.continueOnFail()) {
+                    const errorMessage = error instanceof Error ? error.message : 'Unknown error';
+                    returnData.push({ json: { error: errorMessage } });
+                    continue;
+                }
+                throw error;
+            }
+        }
+        return [returnData];
+    }
+}
+exports.PerfexCrm = PerfexCrm;

package/dist/nodes/PerfexCrm/PerfexCrmTrigger.node.d.ts

@@ -0,0 +1,12 @@
+import { IHookFunctions, IWebhookFunctions, INodeType, INodeTypeDescription, IWebhookResponseData } from 'n8n-workflow';
+export declare class PerfexCrmTrigger implements INodeType {
+    description: INodeTypeDescription;
+    webhookMethods: {
+        default: {
+            checkExists(this: IHookFunctions): Promise<boolean>;
+            create(this: IHookFunctions): Promise<boolean>;
+            delete(this: IHookFunctions): Promise<boolean>;
+        };
+    };
+    webhook(this: IWebhookFunctions): Promise<IWebhookResponseData>;
+}