@docbrasil/api-systemmanager 1.1.63 → 1.1.65

package/doc/api.md

@@ -2260,12 +2260,14 @@ Class for task, permission user
 
 * [Kanban](#Kanban)
     * [.get(params, session)](#Kanban+get) ⇒ <code>promise</code> \| <code>Object</code> \| <code>boolean</code> \| <code>Array</code> \| <code>string</code> \| <code>string</code> \| <code>boolean</code> \| <code>Array</code> \| <code>Array</code>
+    * [.update(params, session)](#Kanban+update) ⇒ <code>promise</code> \| <code>Object</code> \| <code>boolean</code> \| <code>string</code>
     * [.updateTaskOrder(params, session)](#Kanban+updateTaskOrder) ⇒ <code>promise</code> \| <code>Object</code> \| <code>boolean</code> \| <code>string</code>
     * [.updateTasksOrder(params, session)](#Kanban+updateTasksOrder) ⇒ <code>promise</code> \| <code>Object</code> \| <code>boolean</code> \| <code>string</code>
     * [.updateTaskStatus(params, session)](#Kanban+updateTaskStatus) ⇒ <code>promise</code> \| <code>Object</code> \| <code>boolean</code> \| <code>string</code>
     * [.addTaskTag(params, session)](#Kanban+addTaskTag) ⇒ <code>promise</code> \| <code>Object</code> \| <code>boolean</code> \| <code>string</code>
     * [.removeTaskTag(params, session)](#Kanban+removeTaskTag) ⇒ <code>promise</code> \| <code>Object</code> \| <code>boolean</code> \| <code>string</code>
     * [.updateStatusList(params, session)](#Kanban+updateStatusList) ⇒ <code>promise</code> \| <code>Object</code> \| <code>boolean</code> \| <code>string</code>
+    * [.startTask(params, session)](#Kanban+startTask) ⇒ <code>promise</code> \| <code>Object</code> \| <code>boolean</code> \| <code>string</code> \| <code>string</code>
 
 <a name="Kanban+get"></a>
 
@@ -2321,6 +2323,52 @@ Expected response structure:
   ]
 }
 ```
+<a name="Kanban+update"></a>
+
+### kanban.update(params, session) ⇒ <code>promise</code> \| <code>Object</code> \| <code>boolean</code> \| <code>string</code>
+Updates the tasks order and status
+
+**Kind**: instance method of [<code>Kanban</code>](#Kanban)  
+**Returns**: <code>promise</code> - Promise that resolves to operation status<code>Object</code> - returns.data - The response data containing:<code>boolean</code> - returns.data.success - Indicates if the operation was successful<code>string</code> - [returns.data.error] - Error message if operation failed  
+**Access**: public  
+**Author**: Myndware <augusto.pissarra@myndware.com>  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| params | <code>Object</code> | Parameters object |
+| params.orgId | <code>string</code> | Organization id (_id database) |
+| params.tasks | <code>Array</code> | Array of task objects containing taskId and order |
+| params.tasks[].taskId | <code>string</code> | The unique identifier of the task to update |
+| params.tasks[].order | <code>number</code> | The new order position for the task |
+| params.tasks[].status | <code>string</code> | The status of the task |
+| session | <code>string</code> | Session, token JWT |
+
+**Example**  
+```js
+const API = require('@docbrasil/api-systemmanager');
+const api = new API();
+const params = {
+  orgId: '55e4a3bd6be6b45210833fae',
+  tasks: [
+    { taskId: '507f1f77bcf86cd799439011', order: 0, status: '507f1f77bcf86cd799439012' },
+    { taskId: '507f1f77bcf86cd799439012', order: 1, status: '507f1f77bcf86cd799439012' },
+    { taskId: '507f1f77bcf86cd799439013', order: 0, status: '507f1f77bcf86cd799439013' }
+  ]
+};
+const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
+const result = await api.user.kanban.updateTasksOrder(params, session);
+
+Expected response structure (success):
+{
+  success: true
+}
+
+Expected response structure (error):
+{
+  success: false,
+  error: "One or more tasks not found"
+}
+```
 <a name="Kanban+updateTaskOrder"></a>
 
 ### kanban.updateTaskOrder(params, session) ⇒ <code>promise</code> \| <code>Object</code> \| <code>boolean</code> \| <code>string</code>
@@ -2550,6 +2598,7 @@ Updates the status list order for a specific flow in an organization process on
 | params.flowId | <code>string</code> | The id of the organization process step flowId |
 | params.statusList | <code>Array</code> | The status list with new order |
 | params.statusList[ | <code>Object</code> | Status object configuration |
+| params.statusList[].guid | <code>string</code> | The guid of the status (the id) |
 | params.statusList[].value | <code>string</code> | The title of the status |
 | params.statusList[].expanded | <code>boolean</code> | If the status column is expanded or not |
 | params.statusList[].color | <code>string</code> | The hexadecimal color code for the status |
@@ -2578,6 +2627,54 @@ Expected response structure (success):
   success: true
 }
 
+Expected response structure (error):
+{
+  success: false,
+  error: "Organization process not found"
+}
+```
+<a name="Kanban+startTask"></a>
+
+### kanban.startTask(params, session) ⇒ <code>promise</code> \| <code>Object</code> \| <code>boolean</code> \| <code>string</code> \| <code>string</code>
+Starts a new task in the Kanban board for a specific organization process
+
+**Kind**: instance method of [<code>Kanban</code>](#Kanban)  
+**Returns**: <code>promise</code> - Promise that resolves to operation status<code>Object</code> - returns.data - The response data containing:<code>boolean</code> - returns.data.success - Indicates if the operation was successful<code>string</code> - [returns.data.taskId] - The ID of the newly created task<code>string</code> - [returns.data.error] - Error message if operation failed  
+**Access**: public  
+**Author**: Myndware <augusto.pissarra@myndware.com>  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| params | <code>Object</code> | Parameters object |
+| params.orgId | <code>string</code> | Organization id (_id database) |
+| params.orgProcessName | <code>string</code> | The name of the organization process |
+| params.title | <code>string</code> | The title of the new task |
+| params.status | <code>string</code> | The status id of the new task |
+| [params.tags] | <code>Array</code> | Array of tag ids for the new task (optional) |
+| [params.tasks] | <code>Array</code> | The task ids of each task inside the same status (optional) |
+| session | <code>string</code> | Session, token JWT |
+
+**Example**  
+```js
+const API = require('@docbrasil/api-systemmanager');
+const api = new API();
+const params = {
+  orgId: '55e4a3bd6be6b45210833fae',
+  orgProcessName: 'employee-onboarding',
+  title: 'Complete employee documentation',
+  status: '507f1f77bcf86cd799439014',
+  tags: ['507f1f77bcf86cd799439015', '507f1f77bcf86cd799439016'],
+  tasks: ['507f1f77bcf86cd799439011', '507f1f77bcf86cd799439012']
+};
+const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
+const result = await api.user.kanban.startTask(params, session);
+
+Expected response structure (success):
+{
+  success: true,
+  taskId: '507f1f77bcf86cd799439013'
+}
+
 Expected response structure (error):
 {
   success: false,