@fedotovteam/n8n-nodes-chatwoot 1.0.3

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,149 @@
+# @fedotovteam/n8n-nodes-chatwoot
+
+<p align="center">
+  <img src="./chatwoot.png" width='150px'/>
+  <img src="./n8n.png" width='150px'/>
+</p>
+
+Автоматизируйте ваши рабочие процессы [**ChatWoot**](https://www.chatwoot.com/) с помощью [**n8n**](https://n8n.io/)!
+
+![screenshot](node.png)
+
+[![npm version](https://img.shields.io/npm/v/@fedotovteam/n8n-nodes-chatwoot.svg)](https://www.npmjs.com/package/@fedotovteam/n8n-nodes-chatwoot)
+
+- GitHub: [fedotovteam/n8n-nodes-chatwoot](http://github.com/fedotovteam/n8n-nodes-chatwoot)
+- npm: [@fedotovteam/n8n-nodes-chatwoot](https://www.npmjs.com/package/@fedotovteam/n8n-nodes-chatwoot)
+- Справочник ChatWoot API: [https://www.chatwoot.com/developers/api/](https://www.chatwoot.com/developers/api/)
+- 👉 Сгенерировано из [ChatWoot OpenAPI](https://www.chatwoot.com/developers/api/) с использованием [**devlikeapro/n8n-openapi-node**](https://github.com/devlikeapro/n8n-openapi-node)
+
+# Содержание
+
+<!-- toc -->
+
+- [Установка](#установка)
+- [Использование](#использование)
+  * [Учетные data](#учетные-данные)
+    + [Платформа](#платформа)
+    + [Пользователь](#пользователь)
+    + [Входящие](#входящие)
+- [Узел ChatWoot File](#узел-chatwoot-file)
+- [Разработка](#разработка)
+- [Поддержка проекта](#поддержка-проекта)
+
+<!-- tocstop -->
+
+## 🚀 Помощь в разработке проекта
+
+Если этот проект экономит ваше время или помогает в работе, рассмотрите возможность поддержки его разработки 🙌
+
+**Ваша поддержка помогает быстрее выпускать новые функции и поддерживать стабильность проекта.**
+
+# Установка
+
+Установите [пакет сообщества в вашем экземпляре n8n](https://docs.n8n.io/integrations/community-nodes/installation/gui-install/):
+
+```
+@fedotovteam/n8n-nodes-chatwoot
+```
+
+# Использование
+
+1. Установите пакет сообщества в ваш экземпляр n8n.
+2. Добавьте **учетные данные ChatWoot API** в **n8n**.
+3. Создайте новый рабочий процесс с узлом **ChatWoot**.
+
+## Учетные данные
+
+Существует несколько типов учетных данных (аккаунтов), которые вы можете использовать для аутентификации в ChatWoot API.
+
+Для разных конечных точек ChatWoot API вам потребуются разные учетные данные - пожалуйста, обратитесь к [документации ChatWoot API](https://www.chatwoot.com/developers/api/) для получения дополнительной информации.
+
+Мы рекомендуем создать учетные данные **ChatWoot API** в **n8n** для каждого типа аккаунта и назвать их `ChatWoot - {ТИП}` для лучшей понятности.
+
+![](./screenshots/n8n-credentials.png)
+
+### Платформа
+
+Этот токен может быть получен системным администратором после создания platformApp. Этот токен следует использовать для предоставления агент-ботов, аккаунтов, пользователей и их ролей.
+
+![](./screenshots/chatwoot-platform-token.png)
+
+### Пользователь
+
+Этот токен можно получить, посетив страницу профиля или через консоль rails.
+
+![](./screenshots/chatwoot-profile-token.png)
+
+или токен **Super Admin** в некоторых случаях
+
+![](./screenshots/chatwoot-admin-token.png)
+
+### Входящие
+
+Этот токен можно получить, посетив страницу настроек входящих.
+
+![](./screenshots/chatwoot-inbox-token.png)
+
+# Узел ChatWoot File
+
+Отдельный узел для отправки файлов и изображений в разговоры ChatWoot.
+
+## Установка
+
+Пакет уже содержит оба узла. После установки `@fedotovteam/n8n-nodes-chatwoot` вам будут доступны:
+- **ChatWoot** - основной узел для работы с API ChatWoot
+- **ChatWoot File** - узел для отправки файлов
+
+## Использование ChatWoot File
+
+1. Добавьте узел **ChatWoot File** в ваш рабочий процесс
+2. Настройте учетные data ChatWoot API
+3. Укажите параметры:
+   - **Inbox ID** - ID входящего, в котором находится разговор
+   - **Contact ID** - ID контакта
+   - **Conversation ID** - ID разговора, в который отправляется файл
+   - **Источник файла** - выберите "Бинарные data n8n" или "URL"
+   - Если выбран URL - укажите ссылку на файл
+4. (Опционально) Добавьте текст сообщения
+
+## Примеры использования
+
+### Отправка файла из предыдущего шага n8n
+
+```
+[Скачать файл] → [ChatWoot File] → [Результат]
+```
+
+Настройте ChatWoot File:
+- Источник файла: "Бинарные data n8n"
+- Имя свойства с файлом: `data` (или другое, в зависимости от предыдущего узла)
+
+### Отправка файла по URL
+
+```
+[HTTP Request] → [ChatWoot File] → [Результат]
+```
+
+Настройте ChatWoot File:
+- Источник файла: "URL"
+- URL файла: `https://example.com/file.pdf`
+
+## Возвращаемые data
+
+Узел возвращает:
+- `success` - статус отправки
+- `messageId` - ID созданного сообщения
+- `fileName` - имя файла
+- `fileSize` - размер файла в байтах
+- `mimeType` - MIME-тип файла
+- `attachmentUrl` - URL загруженного файла в ChatWoot
+
+# Разработка
+
+Узел сгенерирован из [ChatWoot OpenAPI](https://www.chatwoot.com/developers/api/) с использованием [**devlikeapro/n8n-openapi-node**](https://github.com/devlikeapro/n8n-openapi-node).
+
+Вероятно, исправления следует вносить в файл спецификации OpenAPI или в сам генератор.
+
+# Поддержка проекта
+
+Вы можете поддержать проект, чтобы помочь нам улучшить его еще больше.

package/dist/credentials/ChatWootApi.credentials.d.ts

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

package/dist/credentials/ChatWootApi.credentials.js

@@ -0,0 +1,53 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ChatWootApi = void 0;
+class ChatWootApi {
+    constructor() {
+        this.name = 'chatwootApi';
+        this.displayName = 'ChatWoot API';
+        this.documentationUrl = 'https://www.chatwoot.com/docs/contributing-guide/chatwoot-apis';
+        this.properties = [
+            {
+                displayName: 'ChatWoot API URL',
+                name: 'url',
+                placeholder: "https://www.chatwoot.com",
+                type: 'string',
+                default: '',
+                required: true,
+            },
+            {
+                displayName: "There's many " +
+                    "<a href='https://www.chatwoot.com/docs/contributing-guide/chatwoot-apis' target='_blank'></a><b>Access Token Types</b> in <b>ChatWoot</b></a>," +
+                    " so we just check that <code>{{url}}/api</code> is accessible without token.",
+                default: '',
+                name: 'operation',
+                type: 'notice',
+            },
+            {
+                displayName: 'Access Token',
+                name: 'accessToken',
+                type: 'string',
+                placeholder: "00000000-0000-0000-0000-000000000000",
+                default: '',
+                required: true,
+                typeOptions: { password: true },
+            },
+        ];
+        this.authenticate = {
+            type: 'generic',
+            properties: {
+                headers: {
+                    'Api-Access-Token': '={{$credentials.accessToken}}',
+                },
+            },
+        };
+        this.test = {
+            request: {
+                baseURL: '={{$credentials.url}}',
+                url: '/api',
+            },
+        };
+    }
+}
+exports.ChatWootApi = ChatWootApi;
+//# sourceMappingURL=ChatWootApi.credentials.js.map

package/dist/credentials/ChatWootApi.credentials.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ChatWootApi.credentials.js","sourceRoot":"","sources":["../../credentials/ChatWootApi.credentials.ts"],"names":[],"mappings":";;;AAMA,MAAa,WAAW;IAAxB;QACI,SAAI,GAAG,aAAa,CAAC;QACrB,gBAAW,GAAG,cAAc,CAAC;QAC7B,qBAAgB,GAAG,gEAAgE,CAAC;QACpF,eAAU,GAAsB;YAC5B;gBACI,WAAW,EAAE,kBAAkB;gBAC/B,IAAI,EAAE,KAAK;gBACX,WAAW,EAAE,0BAA0B;gBACvC,IAAI,EAAE,QAAQ;gBACd,OAAO,EAAE,EAAE;gBACX,QAAQ,EAAE,IAAI;aACjB;YACD;gBACI,WAAW,EACP,eAAe;oBACf,gJAAgJ;oBAChJ,8EAA8E;gBAClF,OAAO,EAAE,EAAE;gBACX,IAAI,EAAE,WAAW;gBACjB,IAAI,EAAE,QAAQ;aACjB;YACD;gBACI,WAAW,EAAE,cAAc;gBAC3B,IAAI,EAAE,aAAa;gBACnB,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE,sCAAsC;gBACnD,OAAO,EAAE,EAAE;gBACX,QAAQ,EAAE,IAAI;gBACd,WAAW,EAAE,EAAC,QAAQ,EAAE,IAAI,EAAC;aAChC;SACJ,CAAC;QAEF,iBAAY,GAAyB;YACjC,IAAI,EAAE,SAAS;YACf,UAAU,EAAE;gBACR,OAAO,EAAE;oBACL,kBAAkB,EAAE,+BAA+B;iBACtD;aACJ;SACJ,CAAC;QAEF,SAAI,GAA2B;YAC3B,OAAO,EAAE;gBACL,OAAO,EAAE,uBAAuB;gBAChC,GAAG,EAAE,MAAM;aACd;SACJ,CAAC;IACN,CAAC;CAAA;AAhDD,kCAgDC"}

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

@@ -0,0 +1,4 @@
+import { INodeType, INodeTypeDescription } from 'n8n-workflow';
+export declare class ChatWoot implements INodeType {
+    description: INodeTypeDescription;
+}

package/dist/nodes/ChatWoot/ChatWoot.node.js

@@ -0,0 +1,43 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ChatWoot = void 0;
+const n8n_workflow_1 = require("n8n-workflow");
+const resources_1 = __importDefault(require("./openapi/resources"));
+class ChatWoot {
+    constructor() {
+        this.description = {
+            displayName: 'ChatWoot',
+            name: 'chatWoot',
+            icon: { light: 'file:chatwoot.svg', dark: 'file:chatwoot.dark.svg' },
+            group: ['transform'],
+            usableAsTool: true,
+            version: 1,
+            subtitle: '={{$parameter["operation"] + ": " + $parameter["resource"]}}',
+            description: 'Interact with ChatWoot API',
+            defaults: {
+                name: 'ChatWoot',
+            },
+            inputs: [n8n_workflow_1.NodeConnectionTypes.Main],
+            outputs: [n8n_workflow_1.NodeConnectionTypes.Main],
+            credentials: [
+                {
+                    name: 'chatwootApi',
+                    required: true,
+                },
+            ],
+            requestDefaults: {
+                headers: {
+                    Accept: 'application/json',
+                    'Content-Type': 'application/json',
+                },
+                baseURL: '={{$credentials.url}}',
+            },
+            properties: resources_1.default,
+        };
+    }
+}
+exports.ChatWoot = ChatWoot;
+//# sourceMappingURL=ChatWoot.node.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ChatWoot.node.js","sourceRoot":"","sources":["../../../nodes/ChatWoot/ChatWoot.node.ts"],"names":[],"mappings":";;;;;;AAAA,+CAAkF;AAClF,oEAA6C;AAE7C,MAAa,QAAQ;IAArB;QACI,gBAAW,GAAyB;YAChC,WAAW,EAAE,UAAU;YACvB,IAAI,EAAE,UAAU;YAChB,IAAI,EAAE,EAAE,KAAK,EAAE,mBAAmB,EAAE,IAAI,EAAE,wBAAwB,EAAE;YACpE,KAAK,EAAE,CAAC,WAAW,CAAC;YACpB,YAAY,EAAE,IAAI;YAClB,OAAO,EAAE,CAAC;YACV,QAAQ,EAAE,8DAA8D;YACxE,WAAW,EAAE,4BAA4B;YACzC,QAAQ,EAAE;gBACN,IAAI,EAAE,UAAU;aACnB;YACD,MAAM,EAAE,CAAC,kCAAmB,CAAC,IAAI,CAAC;YAClC,OAAO,EAAE,CAAC,kCAAmB,CAAC,IAAI,CAAC;YACnC,WAAW,EAAE;gBACT;oBACI,IAAI,EAAE,aAAa;oBACnB,QAAQ,EAAE,IAAI;iBACjB;aACJ;YACD,eAAe,EAAE;gBACb,OAAO,EAAE;oBACL,MAAM,EAAE,kBAAkB;oBAC1B,cAAc,EAAE,kBAAkB;iBACrC;gBACD,OAAO,EAAE,uBAAuB;aACnC;YACD,UAAU,EAAE,mBAAU;SACzB,CAAC;IACN,CAAC;CAAA;AA9BD,4BA8BC"}

package/dist/nodes/ChatWoot/ChatWoot.node.json

@@ -0,0 +1,18 @@
+{
+    "node": "n8n-nodes-base.chatwoot",
+    "nodeVersion": "1.0",
+    "codexVersion": "1.0",
+    "categories": ["Development", "Developer Tools"],
+    "resources": {
+        "credentialDocumentation": [
+            {
+                "url": "https://www.chatwoot.com/docs/contributing-guide/chatwoot-apis"
+            }
+        ],
+        "primaryDocumentation": [
+            {
+                "url": "https://www.chatwoot.com/developers/api/"
+            }
+        ]
+    }
+}

package/dist/nodes/ChatWoot/openapi/resources.d.ts

@@ -0,0 +1,3 @@
+import { INodeProperties } from 'n8n-workflow';
+declare const properties: INodeProperties[];
+export default properties;