@orchesty/connector-nutshell 1.0.1 → 2.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/README.md +82 -0
  2. package/dist/package.json +2 -2
  3. package/package.json +2 -2
package/README.md ADDED
@@ -0,0 +1,82 @@
1
+ # Nutshell Connector
2
+
3
+ [![npm](https://img.shields.io/npm/v/@orchesty/connector-nutshell?color=15ba68)](https://www.npmjs.com/package/@orchesty/connector-nutshell)
4
+ [![License](https://img.shields.io/badge/license-Apache--2.0-15ba68)](https://github.com/Orchesty/orchesty-nodejs-connectors/blob/master/LICENSE)
5
+
6
+ An [Orchesty](https://orchesty.io) connector for Nutshell, an affordable and easy-to-use CRM that helps small-business sales teams win more deals.
7
+
8
+ ## Application Type
9
+
10
+ **Basic**
11
+
12
+ This connector authenticates using a username and API key encoded as HTTP Basic auth (`username:api_key` Base64-encoded). All requests are sent to a single JSON-RPC endpoint (`https://app.nutshell.com/api/v1/json`), with the operation specified via the `method` field in the request body.
13
+
14
+ | Field | Description |
15
+ |---|---|
16
+ | `user` | Your Nutshell account username (email address) |
17
+ | `password` | Your Nutshell API key |
18
+
19
+ ## Components
20
+
21
+ | Class | Type | Description |
22
+ |---|---|---|
23
+ | `NutshellGetAccountConnector` | Connector | Retrieves a single CRM account by ID via JSON-RPC `getAccount` |
24
+ | `NutshellNewAccountConnector` | Connector | Creates a new CRM account via JSON-RPC `newAccount` |
25
+ | `NutshellNewLeadConnector` | Connector | Creates a new sales lead via JSON-RPC `newLead` |
26
+ | `NutshellNewTaskConnector` | Connector | Creates a new task via JSON-RPC `newTask` |
27
+
28
+ ## Setup
29
+
30
+ ### Credentials
31
+
32
+ 1. Log in to [Nutshell](https://app.nutshell.com/).
33
+ 2. Navigate to **Setup → API keys** (or **My Profile → API**).
34
+ 3. Generate a new API key.
35
+ 4. In Orchesty, open the Nutshell application settings and enter your **Username** (email) and **API Key**.
36
+
37
+ ### API Documentation
38
+
39
+ Nutshell Developer Hub: [https://developers.nutshell.com/](https://developers.nutshell.com/)
40
+
41
+ ## Installation & Usage
42
+
43
+ Install the package:
44
+
45
+ ```bash
46
+ npm install @orchesty/connector-nutshell @orchesty/nodejs-sdk
47
+ # or
48
+ pnpm add @orchesty/connector-nutshell @orchesty/nodejs-sdk
49
+ ```
50
+
51
+ Register the application and nodes in your Orchesty DI container:
52
+
53
+ ```typescript
54
+ import { container } from '@orchesty/nodejs-sdk';
55
+ import NutshellApplication from '@orchesty/connector-nutshell/dist/NutshellApplication';
56
+ import NutshellGetAccountConnector from '@orchesty/connector-nutshell/dist/Connector/NutshellGetAccountConnector';
57
+ import NutshellNewAccountConnector from '@orchesty/connector-nutshell/dist/Connector/NutshellNewAccountConnector';
58
+ import NutshellNewLeadConnector from '@orchesty/connector-nutshell/dist/Connector/NutshellNewLeadConnector';
59
+ import NutshellNewTaskConnector from '@orchesty/connector-nutshell/dist/Connector/NutshellNewTaskConnector';
60
+
61
+ const app = new NutshellApplication();
62
+ container.setApplication(app);
63
+ container.setNode(new NutshellGetAccountConnector(), app);
64
+ container.setNode(new NutshellNewAccountConnector(), app);
65
+ container.setNode(new NutshellNewLeadConnector(), app);
66
+ container.setNode(new NutshellNewTaskConnector(), app);
67
+ ```
68
+
69
+ ## License
70
+
71
+ This connector is released under the **Apache License 2.0**. See the [LICENSE](https://github.com/Orchesty/orchesty-nodejs-connectors/blob/master/LICENSE) file for the full license text.
72
+
73
+ ## Contributing
74
+
75
+ Contributions are welcome! This connector is part of the open-source [Orchesty Node.js Connectors](https://github.com/Orchesty/orchesty-nodejs-connectors) monorepo.
76
+
77
+ For guidelines on how to create or update connectors — including project setup, coding conventions, and how to write tests — please refer to the **[Contributing to Connectors](https://orchesty.io/community/contributing-to-connectors)** guide.
78
+
79
+ All contributions should include:
80
+ - Source code in `src/` following the existing connector structure
81
+ - Tests in `src/**/__tests__/` with `input.json`, `mock.json`, and `output.json` fixtures
82
+ - An updated `CHANGELOG.md` entry
package/dist/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@orchesty/connector-nutshell",
3
3
  "description": "",
4
- "version": "1.0.0",
4
+ "version": "1.0.1",
5
5
  "license": "Apache-2.0",
6
6
  "url": "https://github.com/Orchesty/orchesty-nodejs-connectors",
7
7
  "repository": "https://github.com/Orchesty/orchesty-nodejs-connectors",
@@ -17,7 +17,7 @@
17
17
  "keywords": [],
18
18
  "author": "info@hanaboso.com",
19
19
  "dependencies": {
20
- "@orchesty/nodejs-sdk": "^4.3.6"
20
+ "@orchesty/nodejs-sdk": "^5.0.8"
21
21
  },
22
22
  "engines": {
23
23
  "node": ">=24"
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@orchesty/connector-nutshell",
3
3
  "description": "",
4
- "version": "1.0.1",
4
+ "version": "2.0.0",
5
5
  "license": "Apache-2.0",
6
6
  "url": "https://github.com/Orchesty/orchesty-nodejs-connectors",
7
7
  "repository": "https://github.com/Orchesty/orchesty-nodejs-connectors",
@@ -11,7 +11,7 @@
11
11
  "keywords": [],
12
12
  "author": "info@hanaboso.com",
13
13
  "dependencies": {
14
- "@orchesty/nodejs-sdk": "^4.3.6"
14
+ "@orchesty/nodejs-sdk": "^5.0.8"
15
15
  },
16
16
  "engines": {
17
17
  "node": ">=24"