@docbrasil/api-systemmanager 1.1.62 → 1.1.63
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.
- package/api/user/kanban.js +6 -6
- package/dist/bundle.cjs +6 -6
- package/dist/bundle.mjs +1 -1
- package/doc/api.md +2 -2
- package/docs/Kanban.html +3 -3
- package/docs/user_kanban.js.html +6 -6
- package/package.json +1 -1
package/doc/api.md
CHANGED
|
@@ -2547,7 +2547,7 @@ Updates the status list order for a specific flow in an organization process on
|
|
|
2547
2547
|
| params | <code>Object</code> | Parameters object |
|
|
2548
2548
|
| params.orgId | <code>string</code> | Organization id (_id database) |
|
|
2549
2549
|
| params.orgProcessName | <code>string</code> | The name of the organization process |
|
|
2550
|
-
| params.
|
|
2550
|
+
| params.flowId | <code>string</code> | The id of the organization process step flowId |
|
|
2551
2551
|
| params.statusList | <code>Array</code> | The status list with new order |
|
|
2552
2552
|
| params.statusList[ | <code>Object</code> | Status object configuration |
|
|
2553
2553
|
| params.statusList[].value | <code>string</code> | The title of the status |
|
|
@@ -2562,7 +2562,7 @@ const api = new API();
|
|
|
2562
2562
|
const params = {
|
|
2563
2563
|
orgId: '55e4a3bd6be6b45210833fae',
|
|
2564
2564
|
orgProcessName: 'employee-onboarding',
|
|
2565
|
-
|
|
2565
|
+
flowId: 'Task_16888el',
|
|
2566
2566
|
statusList: [
|
|
2567
2567
|
{ value: 'Pending', expanded: true, color: '#FF6B6B' },
|
|
2568
2568
|
{ value: 'In Progress', expanded: true, color: '#4ECDC4' },
|
package/docs/Kanban.html
CHANGED
|
@@ -1538,7 +1538,7 @@ Expected response structure (error):
|
|
|
1538
1538
|
|
|
1539
1539
|
<tr class="deep-level-1">
|
|
1540
1540
|
|
|
1541
|
-
<td class="name"><code>
|
|
1541
|
+
<td class="name"><code>flowId</code></td>
|
|
1542
1542
|
|
|
1543
1543
|
|
|
1544
1544
|
<td class="type">
|
|
@@ -1554,7 +1554,7 @@ Expected response structure (error):
|
|
|
1554
1554
|
|
|
1555
1555
|
|
|
1556
1556
|
|
|
1557
|
-
<td class="description last">The
|
|
1557
|
+
<td class="description last">The id of the organization process step flowId</td>
|
|
1558
1558
|
</tr>
|
|
1559
1559
|
|
|
1560
1560
|
|
|
@@ -1864,7 +1864,7 @@ const api = new API();
|
|
|
1864
1864
|
const params = {
|
|
1865
1865
|
orgId: '55e4a3bd6be6b45210833fae',
|
|
1866
1866
|
orgProcessName: 'employee-onboarding',
|
|
1867
|
-
|
|
1867
|
+
flowId: 'Task_16888el',
|
|
1868
1868
|
statusList: [
|
|
1869
1869
|
{ value: 'Pending', expanded: true, color: '#FF6B6B' },
|
|
1870
1870
|
{ value: 'In Progress', expanded: true, color: '#4ECDC4' },
|
package/docs/user_kanban.js.html
CHANGED
|
@@ -204,7 +204,7 @@ class Kanban {
|
|
|
204
204
|
|
|
205
205
|
const { orgId, orgProcessName, flowId } = params;
|
|
206
206
|
|
|
207
|
-
// Build API endpoint with
|
|
207
|
+
// Build API endpoint with flowId as part of the path
|
|
208
208
|
const endpoint = `/organization/${orgId}/kanban/${orgProcessName}/flow/${flowId}`;
|
|
209
209
|
|
|
210
210
|
const apiCall = self._client
|
|
@@ -527,7 +527,7 @@ class Kanban {
|
|
|
527
527
|
* @param {Object} params - Parameters object
|
|
528
528
|
* @param {string} params.orgId - Organization id (_id database)
|
|
529
529
|
* @param {string} params.orgProcessName - The name of the organization process
|
|
530
|
-
* @param {string} params.
|
|
530
|
+
* @param {string} params.flowId - The id of the organization process step flowId
|
|
531
531
|
* @param {Array} params.statusList - The status list with new order
|
|
532
532
|
* @param {Object} params.statusList[] - Status object configuration
|
|
533
533
|
* @param {string} params.statusList[].value - The title of the status
|
|
@@ -546,7 +546,7 @@ class Kanban {
|
|
|
546
546
|
* const params = {
|
|
547
547
|
* orgId: '55e4a3bd6be6b45210833fae',
|
|
548
548
|
* orgProcessName: 'employee-onboarding',
|
|
549
|
-
*
|
|
549
|
+
* flowId: 'Task_16888el',
|
|
550
550
|
* statusList: [
|
|
551
551
|
* { value: 'Pending', expanded: true, color: '#FF6B6B' },
|
|
552
552
|
* { value: 'In Progress', expanded: true, color: '#4ECDC4' },
|
|
@@ -575,14 +575,14 @@ class Kanban {
|
|
|
575
575
|
Joi.assert(params, Joi.object().required(), 'Params to update status list');
|
|
576
576
|
Joi.assert(params.orgId, Joi.string().required(), 'Organization id (_id database)');
|
|
577
577
|
Joi.assert(params.orgProcessName, Joi.string().required(), 'The name of the organization process');
|
|
578
|
-
Joi.assert(params.
|
|
578
|
+
Joi.assert(params.flowId, Joi.string().required(), 'The id of the organization process step flowId');
|
|
579
579
|
Joi.assert(params.statusList, Joi.array().required(), 'The status list with new order');
|
|
580
580
|
Joi.assert(session, Joi.string().required(), 'Session token JWT');
|
|
581
581
|
|
|
582
|
-
const { orgId, orgProcessName,
|
|
582
|
+
const { orgId, orgProcessName, flowId, statusList } = params;
|
|
583
583
|
|
|
584
584
|
// Build API endpoint for updating status list
|
|
585
|
-
const endpoint = `/organization/${orgId}/kanban/${orgProcessName}/flow/${
|
|
585
|
+
const endpoint = `/organization/${orgId}/kanban/${orgProcessName}/flow/${flowId}`;
|
|
586
586
|
|
|
587
587
|
const apiCall = self._client
|
|
588
588
|
.put(endpoint, { statusList }, self._setHeader(session));
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@docbrasil/api-systemmanager",
|
|
3
3
|
"description": "Module API System Manager",
|
|
4
|
-
"version": "1.1.
|
|
4
|
+
"version": "1.1.63",
|
|
5
5
|
"scripts": {
|
|
6
6
|
"htmldoc": "rm -rf docs && jsdoc api/** -d docs -t ./node_modules/better-docs",
|
|
7
7
|
"doc": "rm -rf doc && mkdir doc && jsdoc2md api/**/* api/* > doc/api.md",
|