@virtuoussoftware/n8n-nodes-virtuous-crm 0.1.0

package/LICENSE.md

@@ -0,0 +1,19 @@
+Copyright 2022 n8n
+
+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,45 @@
+![Banner image](https://user-images.githubusercontent.com/10284570/173569848-c624317f-42b1-45a6-ab09-f0ea3c247648.png)
+
+# n8n-nodes-virtuous-crm
+
+This is an n8n community node. It lets you use the [Virtuous CRM API](https://docs.virtuoussoftware.com/) in your n8n workflows.
+
+[n8n](https://n8n.io/) is a [fair-code licensed](https://docs.n8n.io/reference/license/) workflow automation platform.
+
+## Table of Contents
+
+- [Installation](#installation)  
+- [Operations](#operations)  
+- [Credentials](#credentials)
+- [Compatibility](#compatibility)  
+- [Usage](#usage)
+- [Resources](#resources) 
+
+## Installation
+
+Follow the [installation guide](https://docs.n8n.io/integrations/community-nodes/installation/) in the n8n community nodes documentation.
+
+## Operations
+
+This node presently supports operations to create Contact and Gift Transactions:
+- [Create Contact Transaction](https://docs.virtuoussoftware.com/#0b27a920-243c-4f02-a5c3-6e522b926431)
+- [Create Gift Transaction](https://docs.virtuoussoftware.com/#e4a6a1e3-71a4-44f9-bd7c-9466996befac)
+
+## Credentials
+
+An API Key is required to interact with the Virtuous node. Refer to the documentation for API Keys [here](https://docs.virtuoussoftware.com/#authentication)
+
+## Compatibility
+
+Tested locally against n8n 1.115.3
+
+## Usage
+
+The Contact and Gift Transactions allow users to send data to Virtuous CRM+ to create or update Contacts or Gifts. The creation of records is asynchronous and requires user input on CRM+, so responses will be limited only to headers and status codes. See resources for more information
+
+## Resources
+
+* [n8n community nodes documentation](https://docs.n8n.io/integrations/#community-nodes)
+* [Virtuous CRM API Documentation](https://docs.virtuoussoftware.com/)
+* [Gifts Integration Best Practices](https://support.virtuous.org/hc/en-us/articles/21329138310285-Gifts-Integration-Best-Practices)
+* [Contacts Integration Best Practices](https://support.virtuous.org/hc/en-us/articles/21152926831501-Contacts-Integration-Best-Practices)

package/dist/credentials/VirtuousCrmApi.credentials.d.ts

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

package/dist/credentials/VirtuousCrmApi.credentials.js

@@ -0,0 +1,39 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.VirtuousCrmApi = void 0;
+class VirtuousCrmApi {
+    constructor() {
+        this.name = 'virtuousCrmApi';
+        this.displayName = 'Virtuous CRM API';
+        this.icon = { light: 'file:../icons/virtuous-logo-mark.svg', dark: 'file:../icons/virtuous-logo-mark.svg' };
+        this.documentationUrl = 'https://docs.virtuoussoftware.com/#authentication';
+        this.properties = [
+            {
+                displayName: 'API Key',
+                name: 'apiKey',
+                type: 'string',
+                typeOptions: { password: true },
+                default: '',
+                description: 'Your Virtuous CRM API Key',
+                required: true
+            },
+        ];
+        this.authenticate = {
+            type: 'generic',
+            properties: {
+                headers: {
+                    Authorization: '=Bearer {{$credentials?.apiKey}}',
+                },
+            },
+        };
+        this.test = {
+            request: {
+                baseURL: 'https://api.virtuoussoftware.com',
+                url: '/api/Organization',
+                method: 'GET',
+            },
+        };
+    }
+}
+exports.VirtuousCrmApi = VirtuousCrmApi;
+//# sourceMappingURL=VirtuousCrmApi.credentials.js.map

package/dist/credentials/VirtuousCrmApi.credentials.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"VirtuousCrmApi.credentials.js","sourceRoot":"","sources":["../../credentials/VirtuousCrmApi.credentials.ts"],"names":[],"mappings":";;;AAQA,MAAa,cAAc;IAA3B;QACC,SAAI,GAAG,gBAAgB,CAAC;QAExB,gBAAW,GAAG,kBAAkB,CAAC;QAEjC,SAAI,GAAS,EAAE,KAAK,EAAE,sCAAsC,EAAE,IAAI,EAAE,sCAAsC,EAAE,CAAC;QAE7G,qBAAgB,GAAG,mDAAmD,CAAC;QAEvE,eAAU,GAAsB;YAC/B;gBACC,WAAW,EAAE,SAAS;gBACtB,IAAI,EAAE,QAAQ;gBACd,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE;gBAC/B,OAAO,EAAE,EAAE;gBACX,WAAW,EAAE,2BAA2B;gBACxC,QAAQ,EAAE,IAAI;aACd;SACD,CAAC;QAEF,iBAAY,GAAyB;YACpC,IAAI,EAAE,SAAS;YACf,UAAU,EAAE;gBACX,OAAO,EAAE;oBACR,aAAa,EAAE,kCAAkC;iBACjD;aACD;SACD,CAAC;QAEF,SAAI,GAA2B;YAC9B,OAAO,EAAE;gBACR,OAAO,EAAE,kCAAkC;gBAC3C,GAAG,EAAE,mBAAmB;gBACxB,MAAM,EAAE,KAAK;aACb;SACD,CAAC;IACH,CAAC;CAAA;AArCD,wCAqCC"}

package/dist/icons/virtuous-logo-mark.svg

@@ -0,0 +1 @@
+<svg height="27" viewBox="0 0 28 27" width="28" xmlns="http://www.w3.org/2000/svg"><path d="m3 2c11.5729374 9.434699 12.957048 5.81929297 12.957048 17.4598931v9.3682319c-11.57293741-9.4359075-12.957048-5.8209043-12.957048-17.4598931zm27.9186992 0v9.3682319c0 11.6389888-1.3845135 8.0239856-12.9582569 17.4598931v-9.3682319c0-11.64060013 1.3849165-8.0251941 12.9582569-17.4598931z" fill="#00a3e3" transform="translate(-3 -2)"/></svg>

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

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

package/dist/nodes/VirtuousCrm/VirtuousCrm.node.js

@@ -0,0 +1,86 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.VirtuousCrm = void 0;
+const n8n_workflow_1 = require("n8n-workflow");
+const contactTransaction_1 = require("./resources/contactTransaction");
+const giftTransaction_1 = require("./resources/giftTransaction");
+const create_1 = require("./resources/contactTransaction/create");
+const create_2 = require("./resources/giftTransaction/create");
+class VirtuousCrm {
+    constructor() {
+        this.description = {
+            displayName: 'Virtuous CRM',
+            name: 'virtuousCrm',
+            subtitle: '={{ $parameter["operation"] + ": " + $parameter["resource"] }}',
+            icon: { light: 'file:../../icons/virtuous-logo-mark.svg', dark: 'file:../../icons/virtuous-logo-mark.svg' },
+            group: ['input'],
+            version: 1,
+            description: 'Interact with the Virtuous CRM API',
+            codex: {
+                alias: ['CRM', 'Virtuous'],
+                categories: ['AI'],
+                subcategories: {
+                    AI: ['Tools'],
+                    Tools: ['CRM']
+                }
+            },
+            usableAsTool: true,
+            defaults: {
+                name: 'Virtuous CRM Api Endpoints',
+            },
+            inputs: ["main"],
+            outputs: ["main"],
+            credentials: [
+                {
+                    name: 'virtuousCrmApi',
+                    required: true
+                }
+            ],
+            properties: [
+                {
+                    displayName: 'Resource',
+                    name: 'resource',
+                    type: 'options',
+                    options: [
+                        {
+                            name: 'Contact',
+                            value: 'contact'
+                        },
+                        {
+                            name: 'Gift',
+                            value: 'gift',
+                        }
+                    ],
+                    noDataExpression: true,
+                    default: 'contact',
+                },
+                ...contactTransaction_1.ContactDescription,
+                ...giftTransaction_1.GiftDescription
+            ],
+        };
+    }
+    async execute() {
+        const items = this.getInputData();
+        const results = [];
+        for (let itemIndex = 0; itemIndex < items.length; itemIndex++) {
+            const resource = this.getNodeParameter('resource', itemIndex);
+            const operation = this.getNodeParameter('operation', itemIndex);
+            let result;
+            if (resource === 'contact' && operation === 'singleContactTransaction') {
+                result = await create_1.contactTransactionCreateDescription.execute.call(this, itemIndex);
+            }
+            else if (resource === 'gift' && operation === 'singleGiftTransaction') {
+                result = await create_2.giftTransactionCreateDescription.execute.call(this, itemIndex);
+            }
+            else {
+                throw new n8n_workflow_1.NodeOperationError(this.getNode(), `The resource "${resource}" with operation "${operation}" is not supported. Please check your node configuration.`);
+            }
+            results.push({
+                json: result,
+            });
+        }
+        return [results];
+    }
+}
+exports.VirtuousCrm = VirtuousCrm;
+//# sourceMappingURL=VirtuousCrm.node.js.map

package/dist/nodes/VirtuousCrm/VirtuousCrm.node.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"VirtuousCrm.node.js","sourceRoot":"","sources":["../../../nodes/VirtuousCrm/VirtuousCrm.node.ts"],"names":[],"mappings":";;;AAAA,+CAAkK;AAClK,uEAAoE;AACpE,iEAA8D;AAC9D,kEAA4F;AAC5F,+DAAsF;AAEtF,MAAa,WAAW;IAAxB;QACC,gBAAW,GAAyB;YACnC,WAAW,EAAE,cAAc;YAC3B,IAAI,EAAE,aAAa;YACnB,QAAQ,EAAE,gEAAgE;YAC1E,IAAI,EAAE,EAAE,KAAK,EAAE,yCAAyC,EAAE,IAAI,EAAE,yCAAyC,EAAE;YAC3G,KAAK,EAAE,CAAC,OAAO,CAAC;YAChB,OAAO,EAAE,CAAC;YACV,WAAW,EAAE,oCAAoC;YACjD,KAAK,EAAE;gBACN,KAAK,EAAE,CAAC,KAAK,EAAE,UAAU,CAAC;gBAC1B,UAAU,EAAE,CAAC,IAAI,CAAC;gBAClB,aAAa,EAAE;oBACd,EAAE,EAAE,CAAC,OAAO,CAAC;oBACb,KAAK,EAAE,CAAC,KAAK,CAAC;iBACd;aACD;YACD,YAAY,EAAE,IAAI;YAClB,QAAQ,EAAE;gBACT,IAAI,EAAE,4BAA4B;aAClC;YACD,MAAM,EAAE,QAAyB;YACjC,OAAO,EAAE,QAAyB;YAClC,WAAW,EAAE;gBACZ;oBACC,IAAI,EAAE,gBAAgB;oBACtB,QAAQ,EAAE,IAAI;iBACd;aACD;YACD,UAAU,EAAE;gBACX;oBACC,WAAW,EAAE,UAAU;oBACvB,IAAI,EAAE,UAAU;oBAChB,IAAI,EAAE,SAAS;oBACf,OAAO,EAAE;wBACR;4BACC,IAAI,EAAE,SAAS;4BACf,KAAK,EAAE,SAAS;yBAChB;wBACD;4BACC,IAAI,EAAE,MAAM;4BACZ,KAAK,EAAE,MAAM;yBACb;qBACD;oBACD,gBAAgB,EAAE,IAAI;oBACtB,OAAO,EAAE,SAAS;iBAClB;gBACD,GAAG,uCAAkB;gBACrB,GAAG,iCAAe;aAClB;SACD,CAAC;IA2BH,CAAC;IAzBA,KAAK,CAAC,OAAO;QACZ,MAAM,KAAK,GAAG,IAAI,CAAC,YAAY,EAAE,CAAC;QAClC,MAAM,OAAO,GAAyB,EAAE,CAAC;QAEzC,KAAK,IAAI,SAAS,GAAG,CAAC,EAAE,SAAS,GAAG,KAAK,CAAC,MAAM,EAAE,SAAS,EAAE,EAAE,CAAC;YAC/D,MAAM,QAAQ,GAAG,IAAI,CAAC,gBAAgB,CAAC,UAAU,EAAE,SAAS,CAAW,CAAC;YACxE,MAAM,SAAS,GAAG,IAAI,CAAC,gBAAgB,CAAC,WAAW,EAAE,SAAS,CAAW,CAAC;YAE1E,IAAI,MAAW,CAAC;YAEhB,IAAI,QAAQ,KAAK,SAAS,IAAI,SAAS,KAAK,0BAA0B,EAAE,CAAC;gBACxE,MAAM,GAAG,MAAM,4CAAmC,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;YAClF,CAAC;iBAAM,IAAI,QAAQ,KAAK,MAAM,IAAI,SAAS,KAAK,uBAAuB,EAAE,CAAC;gBACzE,MAAM,GAAG,MAAM,yCAAgC,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;YAC/E,CAAC;iBAAM,CAAC;gBACP,MAAM,IAAI,iCAAkB,CAAC,IAAI,CAAC,OAAO,EAAE,EAAE,iBAAiB,QAAQ,qBAAqB,SAAS,2DAA2D,CAAC,CAAC;YAClK,CAAC;YAED,OAAO,CAAC,IAAI,CAAC;gBACZ,IAAI,EAAE,MAAM;aACZ,CAAC,CAAC;QACJ,CAAC;QAED,OAAO,CAAC,OAAO,CAAC,CAAC;IAClB,CAAC;CACD;AA7ED,kCA6EC"}

package/dist/nodes/VirtuousCrm/VirtuousCrm.node.json

@@ -0,0 +1,18 @@
+{
+    "node": "n8n-nodes-base.virtuous-crm",
+    "nodeVersion": "1.0",
+    "codexVersion": "1.0",
+    "categories": ["Development", "Utility"],
+    "resources": {
+        "credentialDocumentation": [
+            {
+                "url": "https://docs.virtuoussoftware.com/#authentication"
+            }
+        ],
+        "primaryDocumentation": [
+            {
+                "url": "https://docs.virtuoussoftware.com/"
+            }
+        ]
+    }
+}

package/dist/nodes/VirtuousCrm/resources/contactTransaction/create.d.ts

@@ -0,0 +1,12 @@
+import { type IExecuteFunctions, type INodeProperties } from 'n8n-workflow';
+export declare const contactTransactionCreateDescription: {
+    description: {
+        properties: INodeProperties[];
+    };
+    cleanFieldsForApi(rawFields: {
+        [key: string]: any;
+    }): {
+        [key: string]: any;
+    };
+    execute(this: IExecuteFunctions, itemIndex: number): Promise<any>;
+};