n8n-nodes-linq 0.1.1 → 0.1.2

package/README.md

@@ -0,0 +1,182 @@
+# 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 → POST `/i_message_availability/check` (`phone_number`)
+
+- Resource: Webhook Subscription
+  - Operations:
+    - Get Many → GET `/webhook_subscriptions`
+    - Get One → GET `/webhook_subscriptions/:id`
+    - Create → POST `/webhook_subscriptions` (`webhook_url`, `events[]`, `version`, `active`)
+    - Update → PUT `/webhook_subscriptions/:id` (update any subset of: `webhook_url`, `events[]`, `version`, `active`)
+    - Delete → DELETE `/webhook_subscriptions/:id`
+
+- Resource: Contact
+  - Operations:
+    - Create → POST `/contacts` (`contact{ first_name, last_name, email, phone_number, company, title, location }`)
+    - Get One → GET `/contacts/:id`
+    - Update → PUT `/contacts/:id` (any subset of contact fields)
+    - Delete → DELETE `/contacts/:id`
+
+### Common parameters
+
+- Pagination (chats): `page`, `perPage`
+- Filtering (chats, find): `phoneNumber`
+- IDs: `chatId`, `chatMessageId`, `contactId`, `webhookSubscriptionId`
+
+## Examples
+
+1) Create a chat and send an initial 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
+
+MIT — see [LICENSE.md](LICENSE.md:1)
+
+## Support
+
+Issues and suggestions are welcome. Please open an issue in your repository once you push the source (see `repository` field in [package.json](package.json:1)).

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "n8n-nodes-linq",
-  "version": "0.1.1",
+  "version": "0.1.2",
   "description": "Linq API integration for n8n",
   "keywords": [
     "n8n-community-node-package",