@docbrasil/api-systemmanager 1.1.61 → 1.1.63

package/doc/api.md

@@ -2282,7 +2282,7 @@ Retrieves the Kanban board data for a specified organization process
 | 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.flowName | <code>string</code> | Flow name for the specific kanban flow |
+| params.flowId | <code>string</code> | Flow id for the specific kanban flow |
 | session | <code>string</code> | Session, token JWT |
 
 **Example**  
@@ -2292,7 +2292,7 @@ const api = new API();
 const params = {
   orgId: '55e4a3bd6be6b45210833fae',
   orgProcessName: 'employee-onboarding',
-  flowName: 'approval-flow'
+  flowId: 'Task_16888el'
 };
 const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
 const kanbanData = await api.user.kanban.get(params, session);
@@ -2547,7 +2547,7 @@ Updates the status list order for a specific flow in an organization process on
 | 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.flowName | <code>string</code> | The name of the organization process step flowName |
+| 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[].value | <code>string</code> | The title of the status |
@@ -2562,7 +2562,7 @@ const api = new API();
 const params = {
   orgId: '55e4a3bd6be6b45210833fae',
   orgProcessName: 'employee-onboarding',
-  flowName: 'approval-flow',
+  flowId: 'Task_16888el',
   statusList: [
     { value: 'Pending', expanded: true, color: '#FF6B6B' },
     { value: 'In Progress', expanded: true, color: '#4ECDC4' },

package/docs/Kanban.html

@@ -711,7 +711,7 @@ Expected response structure (error):
     
 <tr class="deep-level-1">
   
-      <td class="name"><code>flowName</code></td>
+      <td class="name"><code>flowId</code></td>
   
 
   <td class="type">
@@ -727,7 +727,7 @@ Expected response structure (error):
 
   
 
-  <td class="description last">Flow name for the specific kanban flow</td>
+  <td class="description last">Flow id for the specific kanban flow</td>
 </tr>
 
   
@@ -1012,7 +1012,7 @@ const api = new API();
 const params = {
   orgId: '55e4a3bd6be6b45210833fae',
   orgProcessName: 'employee-onboarding',
-  flowName: 'approval-flow'
+  flowId: 'Task_16888el'
 };
 const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
 const kanbanData = await api.user.kanban.get(params, session);
@@ -1538,7 +1538,7 @@ Expected response structure (error):
     
 <tr class="deep-level-1">
   
-      <td class="name"><code>flowName</code></td>
+      <td class="name"><code>flowId</code></td>
   
 
   <td class="type">
@@ -1554,7 +1554,7 @@ Expected response structure (error):
 
   
 
-  <td class="description last">The name of the organization process step flowName</td>
+  <td class="description last">The id of the organization process step flowId</td>
 </tr>
 
   
@@ -1864,7 +1864,7 @@ const api = new API();
 const params = {
   orgId: '55e4a3bd6be6b45210833fae',
   orgProcessName: 'employee-onboarding',
-  flowName: 'approval-flow',
+  flowId: 'Task_16888el',
   statusList: [
     { value: 'Pending', expanded: true, color: '#FF6B6B' },
     { value: 'In Progress', expanded: true, color: '#4ECDC4' },

package/docs/user_kanban.js.html

@@ -144,7 +144,7 @@ class Kanban {
    * @param {Object} params - Parameters object
    * @param {string} params.orgId - Organization id (_id database)
    * @param {string} params.orgProcessName - The name of the organization process
-   * @param {string} params.flowName - Flow name for the specific kanban flow
+   * @param {string} params.flowId - Flow id for the specific kanban flow
    * @param {string} session - Session, token JWT
    * @returns {promise} Promise that resolves to Kanban board data
    * @returns {Object} returns.data - The response data containing:
@@ -163,7 +163,7 @@ class Kanban {
    * const params = {
    *   orgId: '55e4a3bd6be6b45210833fae',
    *   orgProcessName: 'employee-onboarding',
-   *   flowName: 'approval-flow'
+   *   flowId: 'Task_16888el'
    * };
    * const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
    * const kanbanData = await api.user.kanban.get(params, session);
@@ -199,13 +199,13 @@ class Kanban {
       Joi.assert(params, Joi.object().required(), 'Params to get task');
       Joi.assert(params.orgId, Joi.string().required(), 'Organization id (_id database)');
       Joi.assert(params.orgProcessName, Joi.string().required(), 'The organization process name');
-      Joi.assert(params.flowName, Joi.string().required(), 'Flow name for the specific kanban flow');
+      Joi.assert(params.flowId, Joi.string().required(), 'Flow id for the specific kanban flow');
       Joi.assert(session, Joi.string().required(), 'Session token JWT');
 
-      const { orgId, orgProcessName, flowName } = params;
+      const { orgId, orgProcessName, flowId } = params;
 
-      // Build API endpoint with flowName as part of the path
-      const endpoint = `/organization/${orgId}/kanban/${orgProcessName}/flow/${flowName}`;
+      // Build API endpoint with flowId as part of the path
+      const endpoint = `/organization/${orgId}/kanban/${orgProcessName}/flow/${flowId}`;
 
       const apiCall = self._client
           .get(endpoint, self._setHeader(session));
@@ -527,7 +527,7 @@ class Kanban {
    * @param {Object} params - Parameters object
    * @param {string} params.orgId - Organization id (_id database)
    * @param {string} params.orgProcessName - The name of the organization process
-   * @param {string} params.flowName - The name of the organization process step flowName
+   * @param {string} params.flowId - The id of the organization process step flowId
    * @param {Array} params.statusList - The status list with new order
    * @param {Object} params.statusList[] - Status object configuration
    * @param {string} params.statusList[].value - The title of the status
@@ -546,7 +546,7 @@ class Kanban {
    * const params = {
    *   orgId: '55e4a3bd6be6b45210833fae',
    *   orgProcessName: 'employee-onboarding',
-   *   flowName: 'approval-flow',
+   *   flowId: 'Task_16888el',
    *   statusList: [
    *     { value: 'Pending', expanded: true, color: '#FF6B6B' },
    *     { value: 'In Progress', expanded: true, color: '#4ECDC4' },
@@ -575,14 +575,14 @@ class Kanban {
       Joi.assert(params, Joi.object().required(), 'Params to update status list');
       Joi.assert(params.orgId, Joi.string().required(), 'Organization id (_id database)');
       Joi.assert(params.orgProcessName, Joi.string().required(), 'The name of the organization process');
-      Joi.assert(params.flowName, Joi.string().required(), 'The name of the organization process step flowName');
+      Joi.assert(params.flowId, Joi.string().required(), 'The id of the organization process step flowId');
       Joi.assert(params.statusList, Joi.array().required(), 'The status list with new order');
       Joi.assert(session, Joi.string().required(), 'Session token JWT');
 
-      const { orgId, orgProcessName, flowName, statusList } = params;
+      const { orgId, orgProcessName, flowId, statusList } = params;
 
       // Build API endpoint for updating status list
-      const endpoint = `/organization/${orgId}/kanban/${orgProcessName}/flow/${flowName}`;
+      const endpoint = `/organization/${orgId}/kanban/${orgProcessName}/flow/${flowId}`;
 
       const apiCall = self._client
           .put(endpoint, { statusList }, self._setHeader(session));

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@docbrasil/api-systemmanager",
   "description": "Module API System Manager",
-  "version": "1.1.61",
+  "version": "1.1.63",
   "scripts": {
     "htmldoc": "rm -rf docs && jsdoc api/** -d docs -t ./node_modules/better-docs",
     "doc": "rm -rf doc && mkdir doc && jsdoc2md api/**/* api/* > doc/api.md",