n8n-nodes-didar-crm 0.0.16 → 0.0.17

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 (2) hide show
  1. package/README.md +97 -53
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -1,35 +1,60 @@
1
1
  # n8n-nodes-didar-crm
2
2
 
3
- Custom **n8n nodes** for integrating with **Didar CRM**.
3
+ Custom **n8n nodes** for integrating with **Didar CRM**.
4
4
  This package provides actions and triggers to automate workflows with your Didar CRM account.
5
5
 
6
6
  ---
7
7
 
8
8
  ## ✨ Features
9
9
 
10
- * **Trigger**
10
+ ### Trigger
11
+ - **Didar CRM Trigger** → receive webhook events for entity changes, updates, deletions.
11
12
 
12
- * Receive webhook events from Didar CRM (entity changes, updates, deletions, etc.)
13
+ ### Deal
14
+ - Create a deal
15
+ - Update a deal (by Id)
16
+ - Get deal details (by Id)
13
17
 
14
- * **Deal**
18
+ ### Person (Contact)
19
+ - Create a person
20
+ - Update a person (by Id)
21
+ - Get person details (by Id)
15
22
 
16
- * Create a deal
17
- * Update a deal (by Id)
18
- * Get deal details (by Id)
23
+ ### Company
24
+ - Create a company
25
+ - Update a company (by Id)
26
+ - Get company details (by Id)
19
27
 
20
- * **Person (Contact)**
28
+ ### Activity
29
+ - Create an activity
30
+ - Update an activity (by Id)
21
31
 
22
- * Create a person
23
- * Update a person (by Id)
24
- * Get person details (by Id)
32
+ ### Note
33
+ - Create a note
34
+ - Update a note (by Id)
25
35
 
26
- * **Common**
36
+ ### Case (Card)
37
+ - Create a case
38
+ - Update a case (by Id)
27
39
 
28
- * Dropdown selectors for Pipelines, Pipeline Stages, Owners (Users)
29
- * Manual ID input option for each dropdown field
30
- * Support for additional fields like Source, Lost Reason, Visibility Type, Custom Fields, etc.
31
- * Proper handling of default values (zero-guid where needed)
32
- * Webhook trigger enforces POST requests
40
+ ### Product
41
+ - Create a product
42
+ - Update a product (by Id)
43
+ - Get products by list of codes
44
+
45
+ ---
46
+
47
+ ## 🧩 Common Features
48
+
49
+ - Dropdown selectors for Pipelines, Owners (Users), Activity Types, Product Categories, etc.
50
+ - Manual ID input option for each dropdown field
51
+ - Additional fields for advanced properties:
52
+ - Visibility Type
53
+ - Custom Fields (JSON)
54
+ - Multi-value lists (phones, emails, websites, addresses, bank accounts, labels, users)
55
+ - Correct handling of defaults (zero GUIDs, booleans, etc.)
56
+ - Webhook trigger enforces **POST** requests only
57
+ - Consistent **Owner selection mechanism** (select from list or manual ID) across all resources
33
58
 
34
59
  ---
35
60
 
@@ -39,41 +64,61 @@ This package provides actions and triggers to automate workflows with your Didar
39
64
  npm install n8n-nodes-didar-crm
40
65
  ```
41
66
 
42
- Then, place the module inside your n8n custom directory (usually `~/.n8n/custom/`) and restart n8n.
67
+ Place the module inside your n8n custom directory (usually `~/.n8n/custom/`) and restart n8n.
43
68
 
44
69
  ---
45
70
 
46
71
  ## ⚡ Usage
47
72
 
48
73
  ### 1. Trigger node
49
-
50
74
  Add the **Didar CRM Trigger** node to your workflow.
75
+ - Exposes a webhook URL in n8n
76
+ - Accepts **POST** requests only
77
+ - Returns structured payload:
78
+
79
+ ```json
80
+ {
81
+ "data": { ... },
82
+ "changes": [ ... ],
83
+ "meta": { ... },
84
+ "raw": { ... },
85
+ "receivedAt": "timestamp"
86
+ }
87
+ ```
88
+
89
+ ### 2. Resource operations
90
+
91
+ #### Deal
92
+ - **Create** → required fields: `Title`, `OwnerId`, `PipelineId`, `PipelineStageId`
93
+ - **Update** → same as create + `Id`
94
+ - **Get** → requires `Id`
51
95
 
52
- * It exposes a webhook URL in n8n.
53
- * Only **POST** requests are accepted.
54
- * Returns payload structured into:
96
+ #### Person (Contact)
97
+ - **Create** → required fields: `LastName`, `OwnerId`
98
+ - **Update** → same as create + `Id`
99
+ - **Get** → requires `Id`
55
100
 
56
- ```json
57
- {
58
- "data": { ... },
59
- "changes": [ ... ],
60
- "meta": { ... },
61
- "raw": { ... },
62
- "receivedAt": "timestamp"
63
- }
64
- ```
101
+ #### Company
102
+ - **Create** → required fields: `Name`, `OwnerId`
103
+ - **Update** → same as create + `Id`
104
+ - **Get** → requires `Id`
65
105
 
66
- ### 2. Deal operations
106
+ #### Activity
107
+ - **Create Activity** → required fields: `Title`, `OwnerId`, `ActivityTypeId`
108
+ - **Update Activity** → same as create + `Id`
67
109
 
68
- * **Create Deal** → required fields: `Title`, `OwnerId`, `PipelineId`, `PipelineStageId`, `PersonId`, `CompanyId`, `Status`
69
- * **Update Deal** → same as Create, plus required `Id`
70
- * **Get Deal** → requires `Id`
110
+ #### Note
111
+ - **Create Note** → required fields: `ResultNote`, `OwnerId`
112
+ - **Update Note** → same as create + `Id`
71
113
 
72
- ### 3. Person (Contact) operations
114
+ #### Case (Card)
115
+ - **Create Case** → required fields: `Title`, `OwnerId`, `PipelineStageId`, `Status`
116
+ - **Update Case** → same as create + `Id`
73
117
 
74
- * **Create Person** → required fields: `LastName`, `OwnerId`
75
- * **Update Person** → same as Create, plus required `Id`
76
- * **Get Person** → requires `Id`
118
+ #### Product
119
+ - **Create Product** → required fields: `Title`
120
+ - **Update Product** → same as create + `Id`
121
+ - **Get Products by Codes** → required field: `Code[]` (one or more codes)
77
122
 
78
123
  ---
79
124
 
@@ -81,8 +126,8 @@ Add the **Didar CRM Trigger** node to your workflow.
81
126
 
82
127
  A new credential type **Didar API** is provided.
83
128
 
84
- * You must set your **API Key** and (if required) authentication cookies.
85
- * Used across all operations.
129
+ - Set your **API Key** and (if required) authentication cookies.
130
+ - Shared across all nodes.
86
131
 
87
132
  ---
88
133
 
@@ -94,19 +139,18 @@ n8n-nodes-didar-crm/
94
139
  │── README.md
95
140
  │── LICENSE
96
141
  │── nodes/
97
- │ ├── DidarCrm.node.ts # Main entry for resource & operation switch
142
+ │ ├── DidarCrm.node.ts # Main entry for resources & operations
98
143
  │ ├── DidarCrmTrigger.node.ts # Trigger node
99
- │ └── deal/ # Deal operations
100
- │ ├── create.operation.ts
101
- │ ├── update.operation.ts
102
- │ └── get.operation.ts
103
- │ └── person/ # Person operations
104
- │ ├── create.operation.ts
105
- │ ├── update.operation.ts
106
- │ └── get.operation.ts
144
+ │ ├── deal/ # Deal operations
145
+ │ ├── person/ # Person operations
146
+ │ ├── company/ # Company operations
147
+ │ ├── activity/ # Activity operations
148
+ │ ├── note/ # Note operations
149
+ │ ├── case/ # Case operations
150
+ │ └── product/ # Product operations
107
151
  │── lib/
108
- ├── http.ts # Request helper
109
- └── loadOptions.ts # Dropdown population (pipelines, stages, users)
152
+ │ ├── http.ts # Request helper
153
+ │ └── loadOptions.ts # Dropdown population
110
154
  ```
111
155
 
112
156
  ---
@@ -124,7 +168,7 @@ n8n-nodes-didar-crm/
124
168
  ```bash
125
169
  npm run build
126
170
  ```
127
- 4. Link into your n8n custom directory and restart n8n:
171
+ 4. Link into your n8n custom directory and restart:
128
172
 
129
173
  ```bash
130
174
  npm link
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "n8n-nodes-didar-crm",
3
- "version": "0.0.16",
3
+ "version": "0.0.17",
4
4
  "description": "Didar CRM nodes for n8n (Trigger + Deal.create)",
5
5
  "author": "You",
6
6
  "license": "MIT",