@easy8/n8n-nodes-easy8 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Easy Software
+
+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,310 @@
+# Easy8 credentials and node for n8n
+
+This repo contains n8n node for communication with Easy8.
+
+## How to install
+
+### ⚙️ Requirements
+
+To use our community node, you need to have the following requirements:
+
+- n8n 1.54.4 or newer
+
+### 🛠️ Installation in n8n
+
+Follow the [installation guide](https://docs.n8n.io/integrations/community-nodes/installation/) to install the Easy
+8 node in n8n.
+
+### 🔑 Setup credentials
+
+You need to set up credentials for the Easy8 node.
+You can do this by going to the credentials section in n8n and adding a new credential of type "Easy8".
+
+In the newly created credential, you need to fill in domain, and user api key.
+
+The domain should be, for example, `https://instance.easyproject.com`.
+
+To find the API key, go to your Easy8 instance, click on your profile in the top right corner.
+
+![Go to profile](images/cred-guide-1.png)
+
+Your profile window will open. Click on the "Edit" button.
+
+![Profile window](images/cred-guide-2.png)
+
+Your profile edit page will open. Scroll down to the Preferences section. Here just copy the API access key.
+
+![Preferences section with API key](images/cred-guide-3.png)
+
+Now, your credentials are ready to use.
+
+# Easy8 node
+
+The custom node is created to handle all aspects of Easy8 integration with n8n.
+Currently available operations and resources are:
+
+## Easy8 Entities
+
+A list of all available entities in Easy8 node.
+
+- Accounts
+- Issues
+- Leads
+- Opportunities
+- Personal contacts
+- Users
+
+## Accounts
+
+Account entity is used to manage company contacts. It has identifier `easy_contacts`
+
+**Operations**
+
+- **Get one** - returns a detailed view of a single entity. The entity is specified by its ID.
+- **Get many** - returns a list of entities. You should use easy query id to specify the filter.
+- **Add comment** - adds a comment to the entity.
+- **Create** - creates a new account.
+  - Custom fields
+  - Industry ID
+  - Name (known as `firstname` in the entity schema)
+  - Type ID
+  - Account Manager ID
+  - External Account Manager ID
+  - Account Status ID
+  - Account Level ID
+  - Author ID
+  - Account Opened
+  - Account Closed
+  - Customer Left Reason ID
+  - Primary Billing Information (see below)
+  - Contact Information (see below)
+- **Update** - updates some fields of the entity.
+  - Custom fields
+  - Industry ID
+  - Name (known as `firstname` in the entity schema)
+  - Type ID
+  - Account Manager ID
+  - External Account Manager ID
+  - Account Status ID
+  - Account Level ID
+  - Author ID
+  - Account Opened
+  - Account Closed
+  - Customer Left Reason ID
+  - Primary Billing Information (see below)
+  - Contact Information (see below)
+
+### Primary Billing and Contact Information
+
+This is a complex field that contains information about the account's billing and contact details. The structure
+is the same for both cases.
+
+- Company Name
+- Street
+- City
+- Country Code
+- Country Division
+- Postal Code
+- Email
+- Telephone
+- VAT Number
+- VAT Rate
+- Bank Account Number
+- IBAN
+- Variable Symbol
+- SWIFT
+- BIC
+
+## Attendance
+
+Attendance is used to track user attendance. The entity name is `easy_attendance`.
+
+**Operations**
+
+- **Get one** - returns a detailed view of a single attendance record. The entity is specified by its ID.
+- **Get many** - returns a list of attendance records. You should use easy query id to specify the filter.
+- **Create** - creates a new attendance record.
+  - Arrival (required)
+  - Departure
+  - Description
+  - Activity ID
+- **Update** - updates some fields of the attendance record.
+  - Arrival
+  - Departure
+  - Description
+  - Activity ID
+
+## Issues
+
+Issues are mostly Redmine issues. The identifier is `issue`.
+
+**Operations**
+
+- **Get one** - returns a detailed view of a single entity. The entity is specified by its ID.
+- **Get many** - returns a list of entities. You should use easy query id to specify the filter.
+- **Add comment** - adds a comment to the entity.
+- **Create** - creates a new issue.
+  - Subject (required)
+  - Project ID (required)
+  - Assigned To ID
+  - Custom fields
+  - Description
+  - Done Ratio
+  - Due Date
+  - Estimated Hours
+  - Is Private
+  - Parent Issue ID
+  - Priority ID
+  - Start Date
+  - Status ID
+  - Tracker ID
+- **Update** - updates some fields of the entity.
+  - Assigned To ID
+  - Custom fields
+  - Description
+  - Done Ratio
+  - Due Date
+  - Estimated Hours
+  - Is Private
+  - Parent Issue ID
+  - Priority ID
+  - Project ID
+  - Start Date
+  - Subject
+  - Tracker ID
+  - Status ID
+- **Add Comment** - adds a comment to the issue.
+  - Comment (required)
+  - Private Note
+
+## Leads
+
+Leads are CRM entities that refer to potential custom.
+The identifier is `easy_lead`.
+
+**Operations**
+
+- **Get one** - returns a detailed view of a single lead. The entity is specified by its ID.
+- **Get many** - returns a list of leads. You should use easy query id to specify the filter.
+- **Add comment** - adds a comment to the lead.
+- **Create** - creates a new lead.
+  - Company Name
+  - Description
+  - Custom fields
+- **Update** - updates some fields of the leads.
+  - Company Name
+  - Description
+  - Custom fields
+
+## Opportunities
+
+Opportunities are CRM entities that represent a potential sale. The entity name is `easy_crm_case`.
+
+**Operations**
+
+- **Get one** - returns a detailed view of a single opportunity. The entity is specified by its ID.
+- **Get many** - returns a list of entities. You should use easy query id to specify the filter.
+- **Add comment** - adds a comment to the opportunity.
+- **Create** - creates a new opportunity.
+  - Name (required)
+  - Project ID (required)
+  - Account ID (required)
+  - Status ID
+  - Assigned To ID
+  - External Assigned To ID
+  - Price
+  - Contract Date
+  - Custom fields
+- **Update** - updates some fields of the opportunity.
+  - Name
+  - Description
+  - Project ID
+  - Status ID
+  - Assigned To ID
+  - External Assigned To ID
+  - Price
+  - Contract Date
+  - Custom fields
+
+## Personal contacts
+
+Personal contacts are CRM entities that represent a person. The entity name is `easy_personal_contacts`.
+
+**Operations**
+
+- **Get one** - returns a detailed view of a single personal contact. The entity is specified by its ID.
+- **Get many** - returns a list of entities. You should use easy query id to specify the filter.
+- **Create** - creates a new personal contact.
+  - Account ID (required or partner ID)
+  - Partner ID (required or account ID)
+  - First name (required)
+  - Last name (required)
+  - Email (required)
+  - Job title
+  - Custom fields
+- **Update** - updates some fields of the personal contact.
+  - Account ID
+  - Partner ID
+  - First name
+  - Last name
+  - Email
+  - Job title
+  - Custom fields
+
+## Projects
+
+Projects are used to manage project tasks. The entity name is `project`.
+
+**Operations**
+
+- **Get one** - returns a detailed view of a single project. The entity is specified by its ID.
+- **Get many** - returns a list of projects. You should use easy query id to specify the filter.
+
+## Time entries
+
+Time entries are used to track time spent on issues. The entity name is `time_entry`.
+
+**Operations**
+
+- **Get one** - returns a detailed view of a single time entry. The entity is specified by its ID.
+- **Get many** - returns a list of time entries. You should use easy query id to specify the filter.
+- **Create** - creates a new time entry.
+  - Hours (required)
+  - Activity ID
+  - Comment
+  - Project ID
+  - Spent On
+  - User ID
+  - Custom Fields
+- **Update** - updates some fields of the time entry.
+  - Activity ID
+  - Comment
+  - Hours
+  - Project ID
+  - Spent On
+  - User ID
+  - Custom Fields
+
+## Users
+
+Users are Easy8 users. The entity name is `user`.
+
+**Operations**
+
+- **Get one** - returns a detailed view of a single user. The entity is specified by its ID.
+- **Get many** - returns a list of entities. You should use easy query id to specify the filter.
+- **Create** - creates a new user
+  - Login (required)
+  - First name (required)
+  - Last name (required)
+  - Email (required)
+  - Phone
+  - Custom fields
+- **Update** - updates some fields of the user.
+  - ID (required)
+  - Login
+  - First name
+  - Last name
+  - Email
+  - Phone
+  - Custom Fields

package/dist/credentials/Easy8.dark.svg

@@ -0,0 +1,17 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<svg id="Vrstva_1" xmlns="http://www.w3.org/2000/svg" version="1.1" viewBox="0 0 182.85 182.8">
+  <defs>
+    <style>
+      .st0 {
+        fill: none;
+        stroke: #FFF;
+        stroke-width: 14px;
+      }
+      .st1 {
+        fill: #FFF;
+      }
+    </style>
+  </defs>
+  <path class="st0" d="M41.53,6.96h99.81c22.34,0,34.52,12.04,34.52,34.52v99.81c0,22.48-12.17,34.52-34.52,34.52H41.53c-22.34,0-34.52-12.04-34.52-34.52V41.48C7.01,19,19.18,6.96,41.53,6.96Z"/>
+  <path class="st1" d="M137.65,114.39c0-11.24-4.42-17.93-9.9-21.54-1.61-1.07-1.61-1.87,0-2.94,5.49-3.61,9.9-10.3,9.9-21.54,0-19.93-15.52-31.17-30.77-31.17h-30.1c-15.25,0-30.77,11.24-30.77,31.17,0,11.24,4.42,17.93,9.9,21.54,1.61,1.07,1.61,1.87,0,2.94-5.49,3.61-9.9,10.3-9.9,21.54,0,19.93,15.52,31.17,30.77,31.17h30.1c15.25,0,30.77-11.24,30.77-31.17ZM121.06,59.67v17.39c0,3.61-2.54,6.15-6.02,6.15h-46.42c-3.48,0-6.02-2.54-6.02-6.15v-17.39c0-3.61,2.54-6.02,6.02-6.02h46.42c3.48,0,6.02,2.41,6.02,6.02ZM121.06,105.7v17.39c0,3.61-2.54,6.02-6.02,6.02h-46.42c-3.48,0-6.02-2.41-6.02-6.02v-17.39c0-3.61,2.54-6.15,6.02-6.15h46.42c3.48,0,6.02,2.54,6.02,6.15Z"/>
+</svg>

package/dist/credentials/Easy8.svg

@@ -0,0 +1,16 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<svg id="Vrstva_1" xmlns="http://www.w3.org/2000/svg" version="1.1" viewBox="0 0 168.85 168.85">
+  <defs>
+    <style>
+      .st0 {
+        fill: #fff;
+      }
+
+      .st1 {
+        fill: #0d65f2;
+      }
+    </style>
+  </defs>
+  <path class="st1" d="M34.52,0h99.81c22.34,0,34.52,12.04,34.52,34.52v99.81c0,22.48-12.17,34.52-34.52,34.52H34.52c-22.34,0-34.52-12.04-34.52-34.52V34.52C0,12.04,12.17,0,34.52,0Z"/>
+  <path class="st0" d="M130.64,107.43c0-11.24-4.42-17.93-9.9-21.54-1.61-1.07-1.61-1.87,0-2.94,5.49-3.61,9.9-10.3,9.9-21.54,0-19.93-15.52-31.17-30.77-31.17h-30.1c-15.25,0-30.77,11.24-30.77,31.17,0,11.24,4.42,17.93,9.9,21.54,1.61,1.07,1.61,1.87,0,2.94-5.49,3.61-9.9,10.3-9.9,21.54,0,19.93,15.52,31.17,30.77,31.17h30.1c15.25,0,30.77-11.24,30.77-31.17ZM114.05,52.71v17.39c0,3.61-2.54,6.15-6.02,6.15h-46.42c-3.48,0-6.02-2.54-6.02-6.15v-17.39c0-3.61,2.54-6.02,6.02-6.02h46.42c3.48,0,6.02,2.41,6.02,6.02ZM114.05,98.74v17.39c0,3.61-2.54,6.02-6.02,6.02h-46.42c-3.48,0-6.02-2.41-6.02-6.02v-17.39c0-3.61,2.54-6.15,6.02-6.15h46.42c3.48,0,6.02,2.54,6.02,6.15Z"/>
+</svg>

package/dist/credentials/Easy8Api.credentials.d.ts

@@ -0,0 +1,13 @@
+import { IAuthenticateGeneric, ICredentialTestRequest, ICredentialType, INodeProperties } from 'n8n-workflow';
+export declare class Easy8Api implements ICredentialType {
+    name: string;
+    icon: {
+        readonly light: "file:Easy8.svg";
+        readonly dark: "file:Easy8.dark.svg";
+    };
+    displayName: string;
+    documentationUrl: string;
+    properties: INodeProperties[];
+    authenticate: IAuthenticateGeneric;
+    test: ICredentialTestRequest;
+}

package/dist/credentials/Easy8Api.credentials.js

@@ -0,0 +1,47 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Easy8Api = void 0;
+class Easy8Api {
+    constructor() {
+        this.name = 'easy8Api';
+        this.icon = {
+            light: 'file:Easy8.svg',
+            dark: 'file:Easy8.dark.svg',
+        };
+        this.displayName = 'Easy8 API';
+        this.documentationUrl = 'https://easyredmine.com/documentation/';
+        this.properties = [
+            {
+                displayName: 'API Token',
+                name: 'token',
+                type: 'string',
+                default: '',
+                typeOptions: {
+                    password: true,
+                },
+            },
+            {
+                displayName: 'Domain',
+                name: 'domain',
+                type: 'string',
+                default: '',
+            },
+        ];
+        this.authenticate = {
+            type: 'generic',
+            properties: {
+                headers: {
+                    'X-Redmine-API-Key': '={{$credentials.token}}',
+                },
+            },
+        };
+        this.test = {
+            request: {
+                baseURL: '={{$credentials?.domain}}',
+                url: '/issues.json',
+            },
+        };
+    }
+}
+exports.Easy8Api = Easy8Api;
+//# sourceMappingURL=Easy8Api.credentials.js.map

package/dist/credentials/Easy8Api.credentials.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Easy8Api.credentials.js","sourceRoot":"","sources":["../../credentials/Easy8Api.credentials.ts"],"names":[],"mappings":";;;AAOA,MAAa,QAAQ;IAArB;QACE,SAAI,GAAG,UAAU,CAAC;QAElB,SAAI,GAAG;YACL,KAAK,EAAE,gBAAgB;YACvB,IAAI,EAAE,qBAAqB;SACnB,CAAC;QAEX,gBAAW,GAAG,WAAW,CAAC;QAC1B,qBAAgB,GAAG,wCAAwC,CAAC;QAE5D,eAAU,GAAsB;YAC9B;gBACE,WAAW,EAAE,WAAW;gBACxB,IAAI,EAAE,OAAO;gBACb,IAAI,EAAE,QAAQ;gBACd,OAAO,EAAE,EAAE;gBACX,WAAW,EAAE;oBACX,QAAQ,EAAE,IAAI;iBACf;aACF;YACD;gBACE,WAAW,EAAE,QAAQ;gBACrB,IAAI,EAAE,QAAQ;gBACd,IAAI,EAAE,QAAQ;gBACd,OAAO,EAAE,EAAE;aACZ;SACF,CAAC;QAMF,iBAAY,GAAyB;YACnC,IAAI,EAAE,SAAS;YACf,UAAU,EAAE;gBACV,OAAO,EAAE;oBACP,mBAAmB,EAAE,yBAAyB;iBAC/C;aACF;SACF,CAAC;QAGF,SAAI,GAA2B;YAC7B,OAAO,EAAE;gBACP,OAAO,EAAE,2BAA2B;gBACpC,GAAG,EAAE,cAAc;aACpB;SACF,CAAC;IACJ,CAAC;CAAA;AAjDD,4BAiDC"}

package/dist/nodes/Easy8/Easy8.dark.svg

@@ -0,0 +1,17 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<svg id="Vrstva_1" xmlns="http://www.w3.org/2000/svg" version="1.1" viewBox="0 0 182.85 182.8">
+  <defs>
+    <style>
+      .st0 {
+        fill: none;
+        stroke: #FFF;
+        stroke-width: 14px;
+      }
+      .st1 {
+        fill: #FFF;
+      }
+    </style>
+  </defs>
+  <path class="st0" d="M41.53,6.96h99.81c22.34,0,34.52,12.04,34.52,34.52v99.81c0,22.48-12.17,34.52-34.52,34.52H41.53c-22.34,0-34.52-12.04-34.52-34.52V41.48C7.01,19,19.18,6.96,41.53,6.96Z"/>
+  <path class="st1" d="M137.65,114.39c0-11.24-4.42-17.93-9.9-21.54-1.61-1.07-1.61-1.87,0-2.94,5.49-3.61,9.9-10.3,9.9-21.54,0-19.93-15.52-31.17-30.77-31.17h-30.1c-15.25,0-30.77,11.24-30.77,31.17,0,11.24,4.42,17.93,9.9,21.54,1.61,1.07,1.61,1.87,0,2.94-5.49,3.61-9.9,10.3-9.9,21.54,0,19.93,15.52,31.17,30.77,31.17h30.1c15.25,0,30.77-11.24,30.77-31.17ZM121.06,59.67v17.39c0,3.61-2.54,6.15-6.02,6.15h-46.42c-3.48,0-6.02-2.54-6.02-6.15v-17.39c0-3.61,2.54-6.02,6.02-6.02h46.42c3.48,0,6.02,2.41,6.02,6.02ZM121.06,105.7v17.39c0,3.61-2.54,6.02-6.02,6.02h-46.42c-3.48,0-6.02-2.41-6.02-6.02v-17.39c0-3.61,2.54-6.15,6.02-6.15h46.42c3.48,0,6.02,2.54,6.02,6.15Z"/>
+</svg>

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

@@ -0,0 +1,10 @@
+import { IExecuteFunctions, INodeExecutionData, INodeType, INodeTypeDescription } from 'n8n-workflow';
+export declare class Easy8 implements INodeType {
+    description: INodeTypeDescription;
+    methods: {
+        loadOptions: {
+            [key: string]: (this: import("n8n-workflow").ILoadOptionsFunctions) => Promise<import("n8n-workflow").INodePropertyOptions[]>;
+        };
+    };
+    execute(this: IExecuteFunctions): Promise<INodeExecutionData[][]>;
+}