n8n-nodes-linq 0.1.16 → 3.0.0

package/LICENSE.md

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2025 Alex
-
-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
+MIT License
+
+Copyright (c) 2025 Alex
+
+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

@@ -1,193 +1,194 @@
-# n8n-nodes-linq
-
-Linq Partner API (v2) community node for n8n. This node lets you manage chats, messages, phone numbers, webhooks, and contacts in Linq from your n8n workflows.
-
-- Package: `n8n-nodes-linq`
-- Node icon: included (SVG)
-- API version: v2
-- Auth: Integration Token (`X-LINQ-INTEGRATION-TOKEN`)
-
-## Installation (in n8n)
-
-- Using the n8n UI:
-  1) Settings → Community Nodes → Install
-  2) Enter: `n8n-nodes-linq`
-  3) Restart n8n if prompted
-
-- Headless / environment variable:
-  - Add `n8n-nodes-linq` to `N8N_COMMUNITY_PACKAGES` (or install with npm in your instance) and restart n8n.
-
-## Credentials
-
-Create a new credential of type "Linq API" and set your Integration Token:
-
-- Header used: `X-LINQ-INTEGRATION-TOKEN: <your token>`
-- The field is hidden in the UI (password type).
-
-Where it's defined:
-- [class LinqApi implements ICredentialType](credentials/LinqApi.credentials.ts:1)
-
-## Node usage
-
-Add the "Linq" node to your workflow. The node provides Resources and Operations that map 1:1 to the documented Linq Partner API endpoints.
-
-- Node implementation:
-  - [class Linq implements INodeType](nodes/Linq/Linq.node.ts:1)
-  - Icon is configured at the node-level: `icon: 'file:linq.svg'`
-  - SVG file: [linq.svg](nodes/Linq/linq.svg:1)
-
-### Supported resources and operations
-
-The node implements all endpoints from your Linq Partner API documentation (v2):
-
-- Resource: Chat
-  - Operations:
-    - Get Many → GET `/chats` (with pagination, optional `phone_number`)
-    - Get One → GET `/chats/:id`
-    - Find → GET `/chats/find` (by `phone_number`)
-    - Create → POST `/chats` (supports group chats via `phone_numbers[]`, and optional `send_from`, and initial `message.text`)
-    - Share Contact → POST `/chats/share-contact` (feature must be enabled by Linq)
-
-- Resource: Chat Message
-  - Operations:
-    - Get Many → GET `/chat_messages?chat_id=:chatId`
-    - Get One → GET `/chat_messages/:id`
-    - Create → POST `/chat_messages` (`chat_id`, `text`)
-    - Delete → DELETE `/chat_messages/:id`
-    - Edit → POST `/chat_messages/:id/edit` (`text`)
-    - React → POST `/chat_messages/:id/react` (`reaction`)
-    - Get Reaction → GET `/chat_messages/:id/reaction`
-
-- Resource: Phone Number
-  - Operations:
-    - Get Many → GET `/phone_numbers`
-    - Check iMessage Availability → GET `/phone_numbers/:phoneNumber/check_imessage`
-
-- Resource: Webhook Subscription
-  - Operations:
-    - Get Many → GET `/webhook_subscriptions`
-    - Get One → GET `/webhook_subscriptions/:id`
-    - Create → POST `/webhook_subscriptions`
-    - Update → PUT `/webhook_subscriptions/:id`
-    - Delete → DELETE `/webhook_subscriptions/:id`
-
-- Resource: Contact
-  - Operations:
-    - Create → POST `/contacts`
-    - Get One → GET `/contacts/:id`
-    - Update → PUT `/contacts/:id`
-    - Delete → DELETE `/contacts/:id`
-
-### Linq Trigger Node
-
-Add the "Linq Trigger" node to automatically start workflows when Linq events occur. The node automatically registers a webhook with Linq when the workflow is activated.
-
-- Supported Events:
-  - Message Sent (`message.sent`)
-  - Message Received (`message.received`)
-  - Message Read (`message.read`)
-  - Call Completed (`call.completed`)
-  - Contact Created (`contact.created`)
-  - Contact Updated (`contact.updated`)
-  - Contact Deleted (`contact.deleted`)
-
-- Configuration:
-  1. Add the "Linq Trigger" node to your workflow
-  2. Select which events should trigger the workflow
-  3. Activate the workflow (this registers the webhook with Linq)
-  4. Linq will send events to your workflow when they occur
-
-- Security:
-  - The node verifies the signature of incoming events using HMAC-SHA256
-  - Requires the same Linq API credentials as the main node
-
-### Example workflows
-
-1) Send a group message
-- Resource: Chat
-- Operation: Create
-- Fields:
-  - Send From (optional): `+13175551234`
-  - Display Name (optional): `Project A`
-  - Phone Numbers: `+13341234567, +13347654321`
-  - Message Text: `Hello from n8n!`
-
-2) Check iMessage availability
-- Resource: Phone Number
-- Operation: Check iMessage Availability
-- Field:
-  - Phone Number: `+13341234567`
-
-3) Create a contact
-- Resource: Contact
-- Operation: Create
-- Fields:
-  - First Name: `John`
-  - Last Name: `Doe`
-  - Email: `john@example.com`
-  - Phone Number: `+15551234567`
-
-4) Manage webhook subscriptions
-- Resource: Webhook Subscription
-- Operation: Create
-- Fields:
-  - Webhook URL: `https://example.com/webhooks/linq`
-  - Events: `message.sent, message.received, contact.created`
-  - Version: `2`
-  - Active: `true`
-
-## Development
-
-Requirements:
-- Node.js ≥ 20
-- npm or pnpm (npm commands shown below)
-- n8n local instance if testing end-to-end
-
-Install and build:
-```bash
-cd n8n-nodes-linq
-npm install
-npm run build
-npm run lint
-```
-
-Local link for testing in a local n8n:
-```bash
-# in this folder
-npm link
-# in your n8n folder
-npm link n8n-nodes-linq
-# restart n8n, then add "Linq" node
-```
-
-Project files of interest:
-- Node: [Linq.node.ts](nodes/Linq/Linq.node.ts:1)
-- Credentials: [LinqApi.credentials.ts](credentials/LinqApi.credentials.ts:1)
-- Gulp (copies icons): [gulpfile.js](gulpfile.js:1)
-- TypeScript config: [tsconfig.json](tsconfig.json:1)
-- Index shim: [index.js](index.js:1)
-
-## Publishing to npm
-
-1) Ensure metadata is correct in [package.json](package.json:1)
-   - name: `n8n-nodes-linq`
-   - version: increment for each release, e.g. `0.1.0`
-   - author: `"alexautomates"`
-   - keywords include: `n8n-community-node-package`
-   - `files: ["dist"]` to publish only built files
-   - `n8n` block lists built nodes and credentials in `dist/`
-
-2) Build and publish:
-```bash
-npm run build
-npm publish --access public
-```
-
-3) Users can install from the n8n UI (Community Nodes) by typing `n8n-nodes-linq`.
-
-## Icon / Branding
-
-- Icon file is included at: [nodes/Linq/linq.svg](nodes/Linq/linq.svg:1)
-- Node description references it as `icon: 'file:linq.svg'`, so it renders in the n8n UI.
-
-## License
+# n8n-nodes-linq
+
+Linq Partner API (v2) community node for n8n. This node lets you manage chats, messages (with attachments), phone numbers, webhooks, and contacts in Linq from your n8n workflows.
+
+- Package: `n8n-nodes-linq`
+- Node icon: included (SVG)
+- API version: v2
+- Auth: Integration Token (`X-LINQ-INTEGRATION-TOKEN`)
+
+## Installation (in n8n)
+
+- Using the n8n UI:
+  1) Settings → Community Nodes → Install
+  2) Enter: `n8n-nodes-linq`
+  3) Restart n8n if prompted
+
+- Headless / environment variable:
+  - Add `n8n-nodes-linq` to `N8N_COMMUNITY_PACKAGES` (or install with npm in your instance) and restart n8n.
+
+## Credentials
+
+Create a new credential of type "Linq API" and set your Integration Token:
+
+- Header used: `X-LINQ-INTEGRATION-TOKEN: <your token>`
+- The field is hidden in the UI (password type).
+
+Where it's defined:
+- [class LinqApi implements ICredentialType](credentials/LinqApi.credentials.ts:1)
+
+## Node usage
+
+Add the "Linq" node to your workflow. The node provides Resources and Operations that map 1:1 to the documented Linq Partner API endpoints.
+
+- Node implementation:
+  - [class Linq implements INodeType](nodes/Linq/Linq.node.ts:1)
+  - Icon is configured at the node-level: `icon: 'file:linq.svg'`
+  - SVG file: [linq.svg](nodes/Linq/linq.svg:1)
+
+### Supported resources and operations
+
+The node implements all endpoints from your Linq Partner API documentation (v2):
+
+- Resource: Chat
+  - Operations:
+    - Get Many → GET `/chats` (requires `phone_number`; pagination supported)
+    - Get One → GET `/chats/:id`
+    - Find → GET `/chats/find` (requires your `phone_number` and `phone_numbers[]` of participants)
+    - Create → POST `/chats` (requires `send_from`, supports group chats via `phone_numbers[]`, optional display name, initial `message.text`)
+    - Share Contact → POST `/chats/{chat_id}/share_contact` (chat_id required; feature must be enabled by Linq)
+
+- Resource: Chat Message
+  - Operations:
+    - Get Many → GET `/chats/{chat_id}/chat_messages`
+    - Get One → GET `/chat_messages/:id`
+    - Create → POST `/chats/{chat_id}/chat_messages` (supports `text`, optional `attachment_urls[]`, optional `idempotency_key`)
+    - Delete → DELETE `/chat_messages/:id`
+    - Edit → POST `/chat_messages/:id/edit` (`text`)
+    - React → POST `/chat_messages/:id/reactions` (`reaction`)
+    - Get Reaction → GET `/chat_message_reactions/:reaction_id`
+
+- Resource: Phone Number
+  - Operations:
+    - Get Many → GET `/phone_numbers`
+    - Update → PUT `/phone_numbers/:id` (optional `forward_to`, optional `label`)
+
+- Resource: Webhook Subscription
+  - Operations:
+    - Get Many → GET `/webhook_subscriptions`
+    - Get One → GET `/webhook_subscriptions/:id`
+    - Create → POST `/webhook_subscriptions`
+    - Update → PUT `/webhook_subscriptions/:id`
+    - Delete → DELETE `/webhook_subscriptions/:id`
+
+- Resource: Contact
+  - Operations:
+    - Create → POST `/contacts`
+    - Get One → GET `/contacts/:id`
+    - Update → PUT `/contacts/:id`
+    - Delete → DELETE `/contacts/:id`
+
+### Linq Trigger Node
+
+Add the "Linq Trigger" node to automatically start workflows when Linq events occur. The node automatically registers a webhook with Linq when the workflow is activated.
+
+- Supported Events:
+  - Message Sent (`message.sent`)
+  - Message Received (`message.received`)
+  - Message Read (`message.read`)
+  - Call Completed (`call.completed`)
+  - Contact Created (`contact.created`)
+  - Contact Updated (`contact.updated`)
+  - Contact Deleted (`contact.deleted`)
+
+- Configuration:
+  1. Add the "Linq Trigger" node to your workflow
+  2. Select which events should trigger the workflow
+  3. Activate the workflow (this registers the webhook with Linq)
+  4. Linq will send events to your workflow when they occur
+
+- Security:
+  - The node verifies the signature of incoming events using HMAC-SHA256
+  - Requires the same Linq API credentials as the main node
+
+### Example workflows
+
+1) Send a group message
+- Resource: Chat
+- Operation: Create
+- Fields:
+  - Send From (required): `+13175551234`
+  - Display Name (optional): `Project A`
+  - Phone Numbers: `+13341234567, +13347654321`
+  - Message Text: `Hello from n8n!`
+
+2) Create a contact
+- Resource: Contact
+- Operation: Create
+- Fields:
+  - First Name: `John`
+  - Last Name: `Doe`
+  - Email: `john@example.com`
+  - Phone Number: `+15551234567`
+3) Manage webhook subscriptions
+- Resource: Webhook Subscription
+- Operation: Create
+- Fields:
+  - Webhook URL: `https://example.com/webhooks/linq`
+  - Events: `message.sent, message.received, contact.created`
+  - Version: `2`
+  - Active: `true`
+
+4) Update phone number forwarding
+- Resource: Phone Number
+- Operation: Update
+- Fields:
+  - Phone Number ID: `<id>`
+  - Forward To (optional): `+15551230000`
+  - Label (optional): `Support Line`
+
+## Development
+
+Requirements:
+- Node.js ≥ 20
+- npm or pnpm (npm commands shown below)
+- n8n local instance if testing end-to-end
+
+Install and build:
+```bash
+cd n8n-nodes-linq
+npm install
+npm run build
+npm run lint
+```
+
+Local link for testing in a local n8n:
+```bash
+# in this folder
+npm link
+# in your n8n folder
+npm link n8n-nodes-linq
+# restart n8n, then add "Linq" node
+```
+
+Project files of interest:
+- Node: [Linq.node.ts](nodes/Linq/Linq.node.ts:1)
+- Credentials: [LinqApi.credentials.ts](credentials/LinqApi.credentials.ts:1)
+- Gulp (copies icons): [gulpfile.js](gulpfile.js:1)
+- TypeScript config: [tsconfig.json](tsconfig.json:1)
+- Index shim: [index.js](index.js:1)
+
+## Publishing to npm
+
+1) Ensure metadata is correct in [package.json](package.json:1)
+   - name: `n8n-nodes-linq`
+   - version: increment for each release, e.g. `0.1.0`
+   - author: `"alexautomates"`
+   - keywords include: `n8n-community-node-package`
+   - `files: ["dist"]` to publish only built files
+   - `n8n` block lists built nodes and credentials in `dist/`
+
+2) Build and publish:
+```bash
+npm run build
+npm publish --access public
+```
+
+3) Users can install from the n8n UI (Community Nodes) by typing `n8n-nodes-linq`.
+
+## Icon / Branding
+
+- Icon file is included at: [nodes/Linq/linq.svg](nodes/Linq/linq.svg:1)
+- Node description references it as `icon: 'file:linq.svg'`, so it renders in the n8n UI.
+
+## License

package/dist/credentials/LinqApi.credentials.d.ts

@@ -4,4 +4,12 @@ export declare class LinqApi implements ICredentialType {
     displayName: string;
     documentationUrl: string;
     properties: INodeProperties[];
+    authenticate: {
+        readonly type: "generic";
+        readonly properties: {
+            readonly headers: {
+                readonly Authorization: "Bearer {{$credentials.integrationToken}}";
+            };
+        };
+    };
 }

package/dist/credentials/LinqApi.credentials.js

@@ -5,19 +5,27 @@ class LinqApi {
     constructor() {
         this.name = 'linqApi';
         this.displayName = 'Linq API';
-        this.documentationUrl = 'https://docs.linqapp.com';
+        this.documentationUrl = 'https://apidocs.linqapp.com/reference/';
         this.properties = [
             {
                 displayName: 'Integration Token',
                 name: 'integrationToken',
                 type: 'string',
                 default: '',
-                description: 'Your X-LINQ-INTEGRATION-TOKEN',
+                description: 'Your Linq Integration Token',
                 typeOptions: {
                     password: true,
                 },
             },
         ];
+        this.authenticate = {
+            type: 'generic',
+            properties: {
+                headers: {
+                    Authorization: 'Bearer {{$credentials.integrationToken}}',
+                },
+            },
+        };
     }
 }
 exports.LinqApi = LinqApi;