@docbrasil/api-systemmanager 1.1.64 → 1.1.66

package/docs/Kanban.html

@@ -1404,6 +1404,528 @@ Expected response structure (error):
     
 
 
+</div>
+            
+                <div class="member">
+
+
+    
+    <h4 class="name" id="startTask">
+        <a class="href-link" href="#startTask">#</a>
+        
+            
+                <span class='tag'>async</span>
+            
+        
+        <span class="code-name">
+            
+                startTask<span class="signature">(params, session)</span><span class="type-signature"> &rarr; {promise|Object|boolean|string|string}</span>
+            
+        </span>
+    </h4>
+    
+
+    
+    
+    <div class="description">
+        The new task is the full object of the task, like when you search the task
+    </div>
+    
+
+
+
+
+
+
+
+
+
+    <h5>Parameters:</h5>
+    
+<div class="table-container">
+    <table class="params table">
+        <thead>
+        <tr>
+            
+            <th>Name</th>
+            
+
+            <th>Type</th>
+
+            
+            <th>Attributes</th>
+            
+
+            
+
+            <th class="last">Description</th>
+        </tr>
+        </thead>
+
+        <tbody>
+        
+
+            
+<tr class="deep-level-0">
+  
+      <td class="name"><code>params</code></td>
+  
+
+  <td class="type">
+  
+      
+<code class="param-type">Object</code>
+
+
+  
+  </td>
+
+  
+      <td class="attributes">
+      
+
+      
+
+      
+      </td>
+  
+
+  
+
+  <td class="description last">Parameters object</td>
+</tr>
+
+  
+  
+    
+<tr class="deep-level-1">
+  
+      <td class="name"><code>orgId</code></td>
+  
+
+  <td class="type">
+  
+      
+<code class="param-type">string</code>
+
+
+  
+  </td>
+
+  
+      <td class="attributes">
+      
+
+      
+
+      
+      </td>
+  
+
+  
+
+  <td class="description last">Organization id (_id database)</td>
+</tr>
+
+  
+    
+<tr class="deep-level-1">
+  
+      <td class="name"><code>orgProcessName</code></td>
+  
+
+  <td class="type">
+  
+      
+<code class="param-type">string</code>
+
+
+  
+  </td>
+
+  
+      <td class="attributes">
+      
+
+      
+
+      
+      </td>
+  
+
+  
+
+  <td class="description last">The name of the organization process</td>
+</tr>
+
+  
+    
+<tr class="deep-level-1">
+  
+      <td class="name"><code>title</code></td>
+  
+
+  <td class="type">
+  
+      
+<code class="param-type">string</code>
+
+
+  
+  </td>
+
+  
+      <td class="attributes">
+      
+
+      
+
+      
+      </td>
+  
+
+  
+
+  <td class="description last">The title of the new task</td>
+</tr>
+
+  
+    
+<tr class="deep-level-1">
+  
+      <td class="name"><code>status</code></td>
+  
+
+  <td class="type">
+  
+      
+<code class="param-type">string</code>
+
+
+  
+  </td>
+
+  
+      <td class="attributes">
+      
+
+      
+
+      
+      </td>
+  
+
+  
+
+  <td class="description last">The status id of the new task</td>
+</tr>
+
+  
+    
+<tr class="deep-level-1">
+  
+      <td class="name"><code>tags</code></td>
+  
+
+  <td class="type">
+  
+      
+<code class="param-type">Array</code>
+
+
+  
+  </td>
+
+  
+      <td class="attributes">
+      
+          &lt;optional><br>
+      
+
+      
+
+      
+      </td>
+  
+
+  
+
+  <td class="description last">Array of tag ids for the new task (optional)</td>
+</tr>
+
+  
+    
+<tr class="deep-level-1">
+  
+      <td class="name"><code>tasks</code></td>
+  
+
+  <td class="type">
+  
+      
+<code class="param-type">Array</code>
+
+
+  
+  </td>
+
+  
+      <td class="attributes">
+      
+          &lt;optional><br>
+      
+
+      
+
+      
+      </td>
+  
+
+  
+
+  <td class="description last">The task ids, in their current order, of each task inside the same status (optional)</td>
+</tr>
+
+  
+
+
+        
+
+            
+<tr class="deep-level-0">
+  
+      <td class="name"><code>session</code></td>
+  
+
+  <td class="type">
+  
+      
+<code class="param-type">string</code>
+
+
+  
+  </td>
+
+  
+      <td class="attributes">
+      
+
+      
+
+      
+      </td>
+  
+
+  
+
+  <td class="description last">Session, token JWT</td>
+</tr>
+
+
+        
+        </tbody>
+    </table>
+</div>
+
+
+
+
+
+<dl class="details">
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+    <dt class="tag-author">Author:</dt>
+    <dd class="tag-author">
+        <ul>
+            <li><a href="mailto:augusto.pissarra@myndware.com">Myndware</a></li>
+        </ul>
+    </dd>
+    
+
+    
+
+    
+
+    
+    
+
+    
+
+    
+
+    
+        <p class="tag-source">
+            <a href="user_kanban.js.html" class="button">View Source</a>
+            <span>
+                <a href="user_kanban.js.html">user/kanban.js</a>, <a href="user_kanban.js.html#line620">line 620</a>
+            </span>
+        </p>
+    
+</dl>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+    <div class='columns method-parameter'>
+        <div class="column is-2"><label>Returns:</label></div>
+        <div class="column is-10">
+            
+                    
+
+<div class="columns">
+    
+    <div class='param-desc column is-7'>Promise that resolves to operation status</div>
+    
+    
+    <div class='column is-5 has-text-left'>
+        <label>Type: </label>
+        
+<code class="param-type">promise</code>
+
+
+    </div>
+    
+</div>
+
+                
+                    
+
+<div class="columns">
+    
+    <div class='param-desc column is-7'>returns.data - The response data containing:</div>
+    
+    
+    <div class='column is-5 has-text-left'>
+        <label>Type: </label>
+        
+<code class="param-type">Object</code>
+
+
+    </div>
+    
+</div>
+
+                
+                    
+
+<div class="columns">
+    
+    <div class='param-desc column is-7'>returns.data.success - Indicates if the operation was successful</div>
+    
+    
+    <div class='column is-5 has-text-left'>
+        <label>Type: </label>
+        
+<code class="param-type">boolean</code>
+
+
+    </div>
+    
+</div>
+
+                
+                    
+
+<div class="columns">
+    
+    <div class='param-desc column is-7'>[returns.data.task] - The created task and its properties</div>
+    
+    
+    <div class='column is-5 has-text-left'>
+        <label>Type: </label>
+        
+<code class="param-type">string</code>
+
+
+    </div>
+    
+</div>
+
+                
+                    
+
+<div class="columns">
+    
+    <div class='param-desc column is-7'>[returns.data.error] - Error message if operation failed</div>
+    
+    
+    <div class='column is-5 has-text-left'>
+        <label>Type: </label>
+        
+<code class="param-type">string</code>
+
+
+    </div>
+    
+</div>
+
+                
+        </div>
+    </div>
+
+
+
+
+    <h5>Example</h5>
+    
+    
+        <pre class="prettyprint"><code>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,
+  task: { _id: '507f1f77bcf86cd799439013', ... }
+}
+
+Expected response structure (error):
+{
+  success: false,
+  error: "Organization process not found"
+}</code></pre>
+    
+
+
 </div>
             
                 <div class="member">
@@ -2015,6 +2537,29 @@ Expected response structure (error):
 
   
     
+<tr class="deep-level-1">
+  
+      <td class="name"><code>statusList[].guid</code></td>
+  
+
+  <td class="type">
+  
+      
+<code class="param-type">string</code>
+
+
+  
+  </td>
+
+  
+
+  
+
+  <td class="description last">The guid of the status (the id)</td>
+</tr>
+
+  
+    
 <tr class="deep-level-1">
   
       <td class="name"><code>statusList[].value</code></td>
@@ -2161,7 +2706,7 @@ Expected response structure (error):
         <p class="tag-source">
             <a href="user_kanban.js.html" class="button">View Source</a>
             <span>
-                <a href="user_kanban.js.html">user/kanban.js</a>, <a href="user_kanban.js.html#line548">line 548</a>
+                <a href="user_kanban.js.html">user/kanban.js</a>, <a href="user_kanban.js.html#line549">line 549</a>
             </span>
         </p>
     

package/docs/user_document.js.html

@@ -358,6 +358,40 @@ class Documents {
     }
   }
 
+  /**
+   * @author Myndware <augusto.pissarra@myndware.com>
+   * @description Updates a document
+   * @param {array<string>} ids array of document _id
+   * @param {object} params Object for document payload to update. It has to be the FULL document data, that you can get with findById
+   * @param {string} session Session, token JWT
+   * @return {Promise}
+   * @public
+   * @async
+   * @example
+   *
+   * const API = require('@docbrasil/api-systemmanager');
+   * const api = new API();
+   * const params = { ... };
+   * const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
+   * await api.user.document.findByIdsAndUpdate(['5edf9f8ee896b817e45b8dad'], params, session);
+   */
+  async findByIdsAndUpdate(ids, params, session) {
+    const self = this;
+    try {
+      Joi.assert(ids, Joi.array().required().error(new Error('ids is required')));
+      Joi.assert(params, Joi.object().required().error(new Error('params is required')));
+      Joi.assert(session, Joi.string().required().error(new Error('session is required')));
+      const { areaId, orgId } = params;
+      params.ids = ids;
+      const apiCall = self._client
+          .put(`/organizations/${orgId}/areas/${areaId}/documents/batch`, params, self._setHeader(session));
+
+      return self._returnData(await apiCall);
+    } catch (ex) {
+      throw ex;
+    }
+  }
+
   /**
    * @author Myndware <augusto.pissarra@myndware.com>
    * @description Updates a document.

package/docs/user_kanban.js.html

@@ -594,6 +594,7 @@ class Kanban {
    * @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[].guid - The guid of the status (the id)
    * @param {string} params.statusList[].value - The title of the status
    * @param {boolean} params.statusList[].expanded - If the status column is expanded or not
    * @param {string} params.statusList[].color - The hexadecimal color code for the status
@@ -656,6 +657,91 @@ class Kanban {
       throw ex;
     }
   }
+
+  /**
+   * @author Myndware <augusto.pissarra@myndware.com>
+   * @description Starts a new task in the Kanban board for a specific organization process
+   * @description It will create the task, set the new order for all tasks (if you send them) and return the the task
+   * @description The new task is the full object of the task, like when you search the task
+   * @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.title - The title of the new task
+   * @param {string} params.status - The status id of the new task
+   * @param {Array} [params.tags] - Array of tag ids for the new task (optional)
+   * @param {Array} [params.tasks] - The task ids, in their current order, of each task inside the same status (optional)
+   * @param {string} session - Session, token JWT
+   * @returns {promise} Promise that resolves to operation status
+   * @returns {Object} returns.data - The response data containing:
+   * @returns {boolean} returns.data.success - Indicates if the operation was successful
+   * @returns {string} [returns.data.task] - The created task and its properties
+   * @returns {string} [returns.data.error] - Error message if operation failed
+   * @public
+   * @example
+   *
+   * 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,
+   *   task: { _id: '507f1f77bcf86cd799439013', ... }
+   * }
+   *
+   * Expected response structure (error):
+   * {
+   *   success: false,
+   *   error: "Organization process not found"
+   * }
+   */
+  async startTask(params, session) {
+    const self = this;
+
+    try {
+      Joi.assert(params, Joi.object().required(), 'Params to start task');
+      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.title, Joi.string().required(), 'The title of the new task');
+      Joi.assert(params.status, Joi.string().required(), 'The status id of the new task');
+      Joi.assert(session, Joi.string().required(), 'Session token JWT');
+
+      const {
+        orgId,
+        orgProcessName,
+        title,
+        status,
+        tags = [],
+        tasks = []
+      } = params;
+
+      // Build API endpoint for starting a new task
+      const endpoint = `/organization/${orgId}/kanban/${orgProcessName}/tasks`;
+
+      const payload = {
+        title,
+        status,
+        tags,
+        tasks
+      };
+
+      const apiCall = self._client
+          .put(endpoint, payload, self._setHeader(session));
+
+      return self._returnData(await apiCall);
+    } catch (ex) {
+      throw ex;
+    }
+  }
 }
 
 export default Kanban;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@docbrasil/api-systemmanager",
   "description": "Module API System Manager",
-  "version": "1.1.64",
+  "version": "1.1.66",
   "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",