n8n-nodes-mautic-advanced 0.1.0

package/README.md

@@ -0,0 +1,103 @@
+# n8n Mautic Advanced Node
+
+[![Buy Me A Coffee](https://img.shields.io/badge/Buy%20Me%20A%20Coffee-Support-yellow.svg)](https://buymeacoffee.com/msoukhomlinov)
+
+This project is an enhanced Mautic node for n8n, designed to provide more comprehensive support for the Mautic API. It builds upon the standard Mautic node by adding new resources and operations.
+
+## What Makes This "Advanced"?
+
+This enhanced version extends the standard n8n Mautic node with:
+
+- **🏷️ Complete Tag Management**: Full CRUD operations for tags (missing in the standard node)
+- **📊 Campaign Operations**: Create, clone, update, and manage campaigns
+- **📁 Category Management**: Handle categories with bundle and color support
+- **🔗 Advanced Relationship Management**: Sophisticated contact-to-campaign and contact-to-company associations
+- **📧 Enhanced Email Operations**: Segment-based email sending capabilities
+- **👥 Extended Contact Operations**: UTM tag management, activity tracking, device information, and notes
+- **🏢 Complete Company Management**: Full company lifecycle with custom fields and address support
+
+All resources support comprehensive filtering, pagination, and custom field management where applicable.
+
+## Supported Resources and Operations
+
+This enhanced Mautic node provides comprehensive support for the following Mautic API resources:
+
+### 🏢 Companies
+- **Create** a new company with full address and custom field support
+- **Get** a company by ID
+- **Get Many** companies with filtering and pagination
+- **Update** company details
+- **Delete** a company
+
+### 👥 Contacts (Enhanced)
+- **Create** a new contact with extensive field options
+- **Get** a contact by ID
+- **Get Many** contacts with advanced filtering
+- **Update** contact details
+- **Delete** a contact
+- **Send Email** to a contact
+- **Edit Contact Points** (add/subtract points)
+- **Edit Do Not Contact List** (add/remove from DNC)
+- **Add/Remove UTM Tags** for tracking
+- **Get Notes** associated with a contact
+- **Get Activity** history for a contact
+- **Get Companies** associated with a contact
+- **Get Devices** used by a contact
+
+### 🏷️ Tags
+- **Create** a new tag with description
+- **Get** a tag by ID
+- **Get Many** tags with search capabilities
+- **Update** tag name and description
+- **Delete** a tag
+
+### 📊 Campaigns
+- **Create** a new campaign
+- **Get** a campaign by ID
+- **Get All** campaigns
+- **Update** campaign details
+- **Delete** a campaign
+- **Clone** an existing campaign
+- **Get Contacts** in a campaign
+
+### 📁 Categories
+- **Create** a new category with bundle and color settings
+- **Get** a category by ID
+- **Get Many** categories
+- **Update** category details
+- **Delete** a category
+
+### 🔗 Relationship Management
+- **Campaign Contact**: Add/remove contacts to/from campaigns
+- **Company Contact**: Add/remove contacts to/from companies
+- **Contact Segment**: Add/remove contacts to/from segments
+
+### 📧 Email Operations
+- **Segment Email**: Send emails to segments
+
+## Installation
+
+To use this node, you will need to clone this repository and link it to your n8n instance.
+
+1. Clone this repository.
+2. Run `npm install` in the project root.
+3. Run `npm run build` to compile the TypeScript code.
+4. Link the node to your n8n installation by running `npm link` in the project root, and then `npm link n8n-nodes-mautic-advanced` in your n8n installation directory.
+
+## Development
+
+- `npm run dev`: To watch for changes and automatically recompile.
+- `npm run lint`: To check for linting errors.
+- `npm run format`: To format the code with Prettier.
+
+## Support
+
+If you find this node helpful and want to support its ongoing development, you can buy me a coffee:
+
+[![Buy Me A Coffee](https://img.shields.io/badge/Buy%20Me%20A%20Coffee-Support-yellow.svg)](https://buymeacoffee.com/msoukhomlinov)
+
+Your support helps maintain this project and develop new features.
+
+## License
+
+MIT License

package/dist/credentials/MauticAdvancedApi.credentials.js

@@ -0,0 +1,50 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MauticAdvancedApi = void 0;
+class MauticAdvancedApi {
+    constructor() {
+        this.name = 'mauticAdvancedApi';
+        this.displayName = 'Mautic Advanced API';
+        this.documentationUrl = 'mautic';
+        this.properties = [
+            {
+                displayName: 'URL',
+                name: 'url',
+                type: 'string',
+                default: '',
+                placeholder: 'https://name.mautic.net',
+            },
+            {
+                displayName: 'Username',
+                name: 'username',
+                type: 'string',
+                default: '',
+            },
+            {
+                displayName: 'Password',
+                name: 'password',
+                type: 'string',
+                typeOptions: {
+                    password: true,
+                },
+                default: '',
+            },
+        ];
+        this.authenticate = {
+            type: 'generic',
+            properties: {
+                auth: {
+                    username: '={{$credentials.username}}',
+                    password: '={{$credentials.password}}',
+                },
+            },
+        };
+        this.test = {
+            request: {
+                baseURL: '={{$credentials.url.replace(new RegExp("/$"), "")}}',
+                url: '/api/users/self',
+            },
+        };
+    }
+}
+exports.MauticAdvancedApi = MauticAdvancedApi;

package/dist/credentials/MauticAdvancedOAuth2Api.credentials.js

@@ -0,0 +1,59 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MauticAdvancedOAuth2Api = void 0;
+class MauticAdvancedOAuth2Api {
+    constructor() {
+        this.name = 'mauticAdvancedOAuth2Api';
+        this.extends = ['oAuth2Api'];
+        this.displayName = 'Mautic Advanced OAuth2 API';
+        this.documentationUrl = 'mautic';
+        this.properties = [
+            {
+                displayName: 'Grant Type',
+                name: 'grantType',
+                type: 'hidden',
+                default: 'authorizationCode',
+            },
+            {
+                displayName: 'URL',
+                name: 'url',
+                type: 'string',
+                default: '',
+                placeholder: 'https://name.mautic.net',
+            },
+            {
+                displayName: 'Authorization URL',
+                name: 'authUrl',
+                type: 'hidden',
+                default: '={{$self["url"].endsWith("/") ? $self["url"].slice(0, -1) : $self["url"]}}/oauth/v2/authorize',
+                required: true,
+            },
+            {
+                displayName: 'Access Token URL',
+                name: 'accessTokenUrl',
+                type: 'hidden',
+                default: '={{$self["url"].endsWith("/") ? $self["url"].slice(0, -1) : $self["url"]}}/oauth/v2/token',
+                required: true,
+            },
+            {
+                displayName: 'Scope',
+                name: 'scope',
+                type: 'hidden',
+                default: '',
+            },
+            {
+                displayName: 'Auth URI Query Parameters',
+                name: 'authQueryParameters',
+                type: 'hidden',
+                default: '',
+            },
+            {
+                displayName: 'Authentication',
+                name: 'authentication',
+                type: 'hidden',
+                default: 'body',
+            },
+        ];
+    }
+}
+exports.MauticAdvancedOAuth2Api = MauticAdvancedOAuth2Api;

package/dist/nodes/MauticAdvanced/CampaignContactDescription.js

@@ -0,0 +1,66 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.campaignContactFields = exports.campaignContactOperations = void 0;
+exports.campaignContactOperations = [
+    {
+        displayName: 'Operation',
+        name: 'operation',
+        type: 'options',
+        noDataExpression: true,
+        displayOptions: {
+            show: {
+                resource: ['campaignContact'],
+            },
+        },
+        options: [
+            {
+                name: 'Add',
+                value: 'add',
+                description: 'Add contact to a campaign',
+                action: 'Add a campaign contact',
+            },
+            {
+                name: 'Remove',
+                value: 'remove',
+                description: 'Remove contact from a campaign',
+                action: 'Remove a campaign contact',
+            },
+        ],
+        default: 'add',
+    },
+];
+exports.campaignContactFields = [
+    /* -------------------------------------------------------------------------- */
+    /*                               campaignContact:add                           */
+    /* -------------------------------------------------------------------------- */
+    {
+        displayName: 'Contact ID',
+        name: 'contactId',
+        type: 'string',
+        required: true,
+        displayOptions: {
+            show: {
+                resource: ['campaignContact'],
+                operation: ['add', 'remove'],
+            },
+        },
+        default: '',
+    },
+    {
+        displayName: 'Campaign Name or ID',
+        name: 'campaignId',
+        type: 'options',
+        description: 'Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code/expressions/">expression</a>',
+        required: true,
+        displayOptions: {
+            show: {
+                resource: ['campaignContact'],
+                operation: ['add', 'remove'],
+            },
+        },
+        typeOptions: {
+            loadOptionsMethod: 'getCampaigns',
+        },
+        default: '',
+    },
+];

package/dist/nodes/MauticAdvanced/CampaignDescription.js

@@ -0,0 +1,422 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.campaignFields = exports.campaignOperations = void 0;
+exports.campaignOperations = [
+    {
+        displayName: 'Operation',
+        name: 'operation',
+        type: 'options',
+        noDataExpression: true,
+        displayOptions: {
+            show: {
+                resource: ['campaign'],
+            },
+        },
+        options: [
+            {
+                name: 'Clone',
+                value: 'clone',
+                description: 'Clone a campaign',
+                action: 'Clone a campaign',
+            },
+            {
+                name: 'Create',
+                value: 'create',
+                description: 'Create a new campaign',
+                action: 'Create a campaign',
+            },
+            {
+                name: 'Delete',
+                value: 'delete',
+                description: 'Delete a campaign',
+                action: 'Delete a campaign',
+            },
+            {
+                name: 'Get',
+                value: 'get',
+                description: 'Get a campaign',
+                action: 'Get a campaign',
+            },
+            {
+                name: 'Get All',
+                value: 'getAll',
+                description: 'Get all campaigns',
+                action: 'Get all campaigns',
+            },
+            {
+                name: 'Get Contacts',
+                value: 'getContacts',
+                description: "Get a campaign's contacts",
+                action: 'Get a campaigns contacts',
+            },
+            {
+                name: 'Update',
+                value: 'update',
+                description: 'Update a campaign',
+                action: 'Update a campaign',
+            },
+        ],
+        default: 'getAll',
+    },
+];
+exports.campaignFields = [
+    /* -------------------------------------------------------------------------- */
+    /*                                 campaign:create                            */
+    /* -------------------------------------------------------------------------- */
+    {
+        displayName: 'Name',
+        name: 'name',
+        type: 'string',
+        required: true,
+        displayOptions: {
+            show: {
+                resource: ['campaign'],
+                operation: ['create'],
+            },
+        },
+        default: '',
+        description: 'Name of the campaign',
+    },
+    {
+        displayName: 'Additional Fields',
+        name: 'additionalFields',
+        type: 'collection',
+        displayOptions: {
+            show: {
+                resource: ['campaign'],
+                operation: ['create'],
+            },
+        },
+        default: {},
+        placeholder: 'Add Field',
+        options: [
+            {
+                displayName: 'Description',
+                name: 'description',
+                type: 'string',
+                default: '',
+                description: 'Description of the campaign',
+            },
+            {
+                displayName: 'Is Published',
+                name: 'isPublished',
+                type: 'boolean',
+                default: false,
+                description: 'Whether the campaign is published',
+            },
+            {
+                displayName: 'Publish Down',
+                name: 'publishDown',
+                type: 'dateTime',
+                default: '',
+                description: 'Date/time the campaign should be unpublished',
+            },
+            {
+                displayName: 'Publish Up',
+                name: 'publishUp',
+                type: 'dateTime',
+                default: '',
+                description: 'Date/time when the campaign should be published',
+            },
+        ],
+    },
+    /* -------------------------------------------------------------------------- */
+    /*                                 campaign:update                            */
+    /* -------------------------------------------------------------------------- */
+    {
+        displayName: 'Campaign ID',
+        name: 'campaignId',
+        type: 'string',
+        required: true,
+        displayOptions: {
+            show: {
+                resource: ['campaign'],
+                operation: ['update'],
+            },
+        },
+        default: '',
+    },
+    {
+        displayName: 'Update Fields',
+        name: 'updateFields',
+        type: 'collection',
+        displayOptions: {
+            show: {
+                resource: ['campaign'],
+                operation: ['update'],
+            },
+        },
+        default: {},
+        placeholder: 'Add Field',
+        options: [
+            {
+                displayName: 'Description',
+                name: 'description',
+                type: 'string',
+                default: '',
+                description: 'Description of the campaign',
+            },
+            {
+                displayName: 'Name',
+                name: 'name',
+                type: 'string',
+                default: '',
+                description: 'Name of the campaign',
+            },
+            {
+                displayName: 'Is Published',
+                name: 'isPublished',
+                type: 'boolean',
+                default: false,
+                description: 'Whether the campaign is published',
+            },
+            {
+                displayName: 'Publish Down',
+                name: 'publishDown',
+                type: 'dateTime',
+                default: '',
+                description: 'Date/time the campaign should be unpublished',
+            },
+            {
+                displayName: 'Publish Up',
+                name: 'publishUp',
+                type: 'dateTime',
+                default: '',
+                description: 'Date/time when the campaign should be published',
+            },
+        ],
+    },
+    /* -------------------------------------------------------------------------- */
+    /*                                 campaign:clone                             */
+    /* -------------------------------------------------------------------------- */
+    {
+        displayName: 'Campaign ID',
+        name: 'campaignId',
+        type: 'string',
+        required: true,
+        displayOptions: {
+            show: {
+                resource: ['campaign'],
+                operation: ['clone'],
+            },
+        },
+        default: '',
+    },
+    /* -------------------------------------------------------------------------- */
+    /*                                 campaign:get                               */
+    /* -------------------------------------------------------------------------- */
+    {
+        displayName: 'Campaign ID',
+        name: 'campaignId',
+        type: 'string',
+        required: true,
+        displayOptions: {
+            show: {
+                resource: ['campaign'],
+                operation: ['get'],
+            },
+        },
+        default: '',
+    },
+    /* -------------------------------------------------------------------------- */
+    /*                                 campaign:delete                            */
+    /* -------------------------------------------------------------------------- */
+    {
+        displayName: 'Campaign ID',
+        name: 'campaignId',
+        type: 'string',
+        required: true,
+        displayOptions: {
+            show: {
+                resource: ['campaign'],
+                operation: ['delete'],
+            },
+        },
+        default: '',
+    },
+    /* -------------------------------------------------------------------------- */
+    /*                                 campaign:getAll                            */
+    /* -------------------------------------------------------------------------- */
+    {
+        displayName: 'Return All',
+        name: 'returnAll',
+        type: 'boolean',
+        displayOptions: {
+            show: {
+                resource: ['campaign'],
+                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: ['campaign'],
+                operation: ['getAll'],
+                returnAll: [false],
+            },
+        },
+        typeOptions: {
+            minValue: 1,
+        },
+        default: 50,
+        description: 'Max number of results to return',
+    },
+    {
+        displayName: 'Options',
+        name: 'options',
+        type: 'collection',
+        displayOptions: {
+            show: {
+                resource: ['campaign'],
+                operation: ['getAll'],
+            },
+        },
+        default: {},
+        placeholder: 'Add Field',
+        options: [
+            {
+                displayName: 'Minimal',
+                name: 'minimal',
+                type: 'boolean',
+                default: false,
+                description: 'Return only array of entities without additional lists in it',
+            },
+            {
+                displayName: 'Order By',
+                name: 'orderBy',
+                type: 'string',
+                default: '',
+                description: 'Column to sort by. Can use any column listed in the response.',
+            },
+            {
+                displayName: 'Order By Dir',
+                name: 'orderByDir',
+                type: 'options',
+                options: [
+                    {
+                        name: 'ASC',
+                        value: 'asc',
+                    },
+                    {
+                        name: 'DESC',
+                        value: 'desc',
+                    },
+                ],
+                default: 'asc',
+                description: 'Sort direction',
+            },
+            {
+                displayName: 'Published Only',
+                name: 'publishedOnly',
+                type: 'boolean',
+                default: false,
+                description: 'Only return currently published entities',
+            },
+            {
+                displayName: 'Search',
+                name: 'search',
+                type: 'string',
+                default: '',
+                description: 'String or search command to filter entities by',
+            },
+        ],
+    },
+    /* -------------------------------------------------------------------------- */
+    /*                                 campaign:getContacts                       */
+    /* -------------------------------------------------------------------------- */
+    {
+        displayName: 'Campaign ID',
+        name: 'campaignId',
+        type: 'string',
+        required: true,
+        displayOptions: {
+            show: {
+                resource: ['campaign'],
+                operation: ['getContacts'],
+            },
+        },
+        default: '',
+    },
+    {
+        displayName: 'Return All',
+        name: 'returnAll',
+        type: 'boolean',
+        displayOptions: {
+            show: {
+                resource: ['campaign'],
+                operation: ['getContacts'],
+            },
+        },
+        default: false,
+        description: 'Whether to return all results or only up to a given limit',
+    },
+    {
+        displayName: 'Limit',
+        name: 'limit',
+        type: 'number',
+        displayOptions: {
+            show: {
+                resource: ['campaign'],
+                operation: ['getContacts'],
+                returnAll: [false],
+            },
+        },
+        typeOptions: {
+            minValue: 1,
+        },
+        default: 50,
+        description: 'Max number of results to return',
+    },
+    {
+        displayName: 'Options',
+        name: 'options',
+        type: 'collection',
+        displayOptions: {
+            show: {
+                resource: ['campaign'],
+                operation: ['getContacts'],
+            },
+        },
+        default: {},
+        placeholder: 'Add Field',
+        options: [
+            {
+                displayName: 'Order By',
+                name: 'orderBy',
+                type: 'string',
+                default: '',
+                description: 'Column to sort by. Can use any column listed in the response.',
+            },
+            {
+                displayName: 'Order By Dir',
+                name: 'orderByDir',
+                type: 'options',
+                options: [
+                    {
+                        name: 'ASC',
+                        value: 'asc',
+                    },
+                    {
+                        name: 'DESC',
+                        value: 'desc',
+                    },
+                ],
+                default: 'asc',
+                description: 'Sort direction',
+            },
+            {
+                displayName: 'Search',
+                name: 'search',
+                type: 'string',
+                default: '',
+                description: 'String or search command to filter entities by',
+            },
+        ],
+    },
+];