@docbrasil/api-systemmanager 1.1.65 → 1.1.67

package/doc/api.md

@@ -1593,6 +1593,7 @@ Class for documents, permission user
 * [Documents](#Documents)
     * [.add(params, session)](#Documents+add) ⇒ <code>Promise</code>
     * [.findByIdAndUpdate(id, params, session)](#Documents+findByIdAndUpdate) ⇒ <code>Promise</code>
+    * [.findByIdsAndUpdate(ids, params, session)](#Documents+findByIdsAndUpdate) ⇒ <code>Promise</code>
     * [.findById(id, session)](#Documents+findById) ⇒ <code>Promise</code>
     * [.find(params, session)](#Documents+find) ⇒ <code>Promise</code>
     * [.findByIdAndRemove(params, session)](#Documents+findByIdAndRemove) ⇒ <code>Promise.&lt;object&gt;</code> \| <code>number</code> \| <code>array.&lt;object&gt;</code> \| <code>string</code> \| <code>string</code> \| <code>string</code>
@@ -1689,6 +1690,31 @@ const params = { ... };
 const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
 await api.user.document.findByIdAndUpdate('5edf9f8ee896b817e45b8dad', params, session);
 ```
+<a name="Documents+findByIdsAndUpdate"></a>
+
+### documents.findByIdsAndUpdate(ids, params, session) ⇒ <code>Promise</code>
+Updates a document
+
+**Kind**: instance method of [<code>Documents</code>](#Documents)  
+**Access**: public  
+**Author**: Myndware <augusto.pissarra@myndware.com>  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| ids | <code>array.&lt;string&gt;</code> | array of document _id |
+| params | <code>object</code> | Object for document payload to update. It has the orgId and areaId (required) and the fields to update.  Partial updates accepted, such as docTypeFieldsData.extraFieldName |
+| params.orgId | <code>string</code> | The orgId of the organization |
+| params.areaId | <code>string</code> | The areaId to update in batch |
+| session | <code>string</code> | Session, token JWT |
+
+**Example**  
+```js
+const API = require('@docbrasil/api-systemmanager');
+const api = new API();
+const params = { orgId: '5edf9f8ee896b817e45b8da7', areaId: '5edf9f8ee896b817e45b8da8', 'docTypeFieldsData.extraName': 'New name' };
+const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
+await api.user.document.findByIdsAndUpdate(['5edf9f8ee896b817e45b8dad'], params, session);
+```
 <a name="Documents+findById"></a>
 
 ### documents.findById(id, session) ⇒ <code>Promise</code>
@@ -2636,10 +2662,10 @@ Expected response structure (error):
 <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
+The new task is the full object of the task, like when you search the task
 
 **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  
+**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.task] - The created task and its properties<code>string</code> - [returns.data.error] - Error message if operation failed  
 **Access**: public  
 **Author**: Myndware <augusto.pissarra@myndware.com>  
 
@@ -2651,7 +2677,7 @@ Starts a new task in the Kanban board for a specific 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) |
+| [params.tasks] | <code>Array</code> | The task ids, in their current order, of each task inside the same status (optional) |
 | session | <code>string</code> | Session, token JWT |
 
 **Example**  
@@ -2672,7 +2698,7 @@ const result = await api.user.kanban.startTask(params, session);
 Expected response structure (success):
 {
   success: true,
-  taskId: '507f1f77bcf86cd799439013'
+  task: { _id: '507f1f77bcf86cd799439013', ... }
 }
 
 Expected response structure (error):

package/docs/Documents.html

@@ -1657,7 +1657,7 @@ Checks if a document can be added and it does not repeat its primary key</li>
         <p class="tag-source">
             <a href="user_document.js.html" class="button">View Source</a>
             <span>
-                <a href="user_document.js.html">user/document.js</a>, <a href="user_document.js.html#line794">line 794</a>
+                <a href="user_document.js.html">user/document.js</a>, <a href="user_document.js.html#line834">line 834</a>
             </span>
         </p>
     
@@ -1950,7 +1950,7 @@ const retDocs = await api.user.document.checkPrimaryKeys(params, session);</code
         <p class="tag-source">
             <a href="user_document.js.html" class="button">View Source</a>
             <span>
-                <a href="user_document.js.html">user/document.js</a>, <a href="user_document.js.html#line882">line 882</a>
+                <a href="user_document.js.html">user/document.js</a>, <a href="user_document.js.html#line922">line 922</a>
             </span>
         </p>
     
@@ -2222,7 +2222,7 @@ const retSearch = await api.user.document.exportExcelForAllPages(params, session
         <p class="tag-source">
             <a href="user_document.js.html" class="button">View Source</a>
             <span>
-                <a href="user_document.js.html">user/document.js</a>, <a href="user_document.js.html#line922">line 922</a>
+                <a href="user_document.js.html">user/document.js</a>, <a href="user_document.js.html#line962">line 962</a>
             </span>
         </p>
     
@@ -2912,7 +2912,7 @@ const retSearch = await api.user.document.exportWmsExcelForAllPages(params, sess
         <p class="tag-source">
             <a href="user_document.js.html" class="button">View Source</a>
             <span>
-                <a href="user_document.js.html">user/document.js</a>, <a href="user_document.js.html#line341">line 341</a>
+                <a href="user_document.js.html">user/document.js</a>, <a href="user_document.js.html#line381">line 381</a>
             </span>
         </p>
     
@@ -3138,7 +3138,7 @@ await api.user.document.findByIdAndRemove(params, session);</code></pre>
         <p class="tag-source">
             <a href="user_document.js.html" class="button">View Source</a>
             <span>
-                <a href="user_document.js.html">user/document.js</a>, <a href="user_document.js.html#line290">line 290</a>
+                <a href="user_document.js.html">user/document.js</a>, <a href="user_document.js.html#line330">line 330</a>
             </span>
         </p>
     
@@ -3404,7 +3404,7 @@ await api.user.document.findById('5edf9f8ee896b817e45b8dad', session);</code></p
         <p class="tag-source">
             <a href="user_document.js.html" class="button">View Source</a>
             <span>
-                <a href="user_document.js.html">user/document.js</a>, <a href="user_document.js.html#line425">line 425</a>
+                <a href="user_document.js.html">user/document.js</a>, <a href="user_document.js.html#line465">line 465</a>
             </span>
         </p>
     
@@ -4032,7 +4032,7 @@ await api.user.document.findByIdAndUpdate('5edf9f8ee896b817e45b8dad', params, se
         <p class="tag-source">
             <a href="user_document.js.html" class="button">View Source</a>
             <span>
-                <a href="user_document.js.html">user/document.js</a>, <a href="user_document.js.html#line470">line 470</a>
+                <a href="user_document.js.html">user/document.js</a>, <a href="user_document.js.html#line510">line 510</a>
             </span>
         </p>
     
@@ -4187,6 +4187,299 @@ await api.user.document.findByIdsAndRemove(params, session);</code></pre>
     
 
 
+</div>
+            
+                <div class="member">
+
+
+    
+    <h4 class="name" id="findByIdsAndUpdate">
+        <a class="href-link" href="#findByIdsAndUpdate">#</a>
+        
+            
+                <span class='tag'>async</span>
+            
+        
+        <span class="code-name">
+            
+                findByIdsAndUpdate<span class="signature">(ids, params, session)</span><span class="type-signature"> &rarr; {Promise}</span>
+            
+        </span>
+    </h4>
+    
+
+    
+    
+    <div class="description">
+        Updates a document
+    </div>
+    
+
+
+
+
+
+
+
+
+
+    <h5>Parameters:</h5>
+    
+<div class="table-container">
+    <table class="params table">
+        <thead>
+        <tr>
+            
+            <th>Name</th>
+            
+
+            <th>Type</th>
+
+            
+
+            
+
+            <th class="last">Description</th>
+        </tr>
+        </thead>
+
+        <tbody>
+        
+
+            
+<tr class="deep-level-0">
+  
+      <td class="name"><code>ids</code></td>
+  
+
+  <td class="type">
+  
+      
+<code class="param-type">array.&lt;string></code>
+
+
+  
+  </td>
+
+  
+
+  
+
+  <td class="description last">array of document _id</td>
+</tr>
+
+
+        
+
+            
+<tr class="deep-level-0">
+  
+      <td class="name"><code>params</code></td>
+  
+
+  <td class="type">
+  
+      
+<code class="param-type">object</code>
+
+
+  
+  </td>
+
+  
+
+  
+
+  <td class="description last">Object for document payload to update. It has the orgId and areaId (required) and the fields to update.
+ Partial updates accepted, such as docTypeFieldsData.extraFieldName</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="description last">The orgId of the organization</td>
+</tr>
+
+  
+    
+<tr class="deep-level-1">
+  
+      <td class="name"><code>areaId</code></td>
+  
+
+  <td class="type">
+  
+      
+<code class="param-type">string</code>
+
+
+  
+  </td>
+
+  
+
+  
+
+  <td class="description last">The areaId to update in batch</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="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_document.js.html" class="button">View Source</a>
+            <span>
+                <a href="user_document.js.html">user/document.js</a>, <a href="user_document.js.html#line294">line 294</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='column is-5 has-text-left'>
+        <label>Type: </label>
+        
+<code class="param-type">Promise</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: '5edf9f8ee896b817e45b8da7', areaId: '5edf9f8ee896b817e45b8da8', 'docTypeFieldsData.extraName': 'New name' };
+const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
+await api.user.document.findByIdsAndUpdate(['5edf9f8ee896b817e45b8dad'], params, session);</code></pre>
+    
+
+
 </div>
             
                 <div class="member">
@@ -4417,7 +4710,7 @@ await api.user.document.findByIdsAndRemove(params, session);</code></pre>
         <p class="tag-source">
             <a href="user_document.js.html" class="button">View Source</a>
             <span>
-                <a href="user_document.js.html">user/document.js</a>, <a href="user_document.js.html#line972">line 972</a>
+                <a href="user_document.js.html">user/document.js</a>, <a href="user_document.js.html#line1012">line 1012</a>
             </span>
         </p>
     
@@ -4698,7 +4991,7 @@ const retSearch = await api.user.document.performDownloadComplete(params, sessio
         <p class="tag-source">
             <a href="user_document.js.html" class="button">View Source</a>
             <span>
-                <a href="user_document.js.html">user/document.js</a>, <a href="user_document.js.html#line842">line 842</a>
+                <a href="user_document.js.html">user/document.js</a>, <a href="user_document.js.html#line882">line 882</a>
             </span>
         </p>
     
@@ -5042,7 +5335,7 @@ const retSearch = await api.user.document.searchDocuments(params, session);</cod
         <p class="tag-source">
             <a href="user_document.js.html" class="button">View Source</a>
             <span>
-                <a href="user_document.js.html">user/document.js</a>, <a href="user_document.js.html#line1017">line 1017</a>
+                <a href="user_document.js.html">user/document.js</a>, <a href="user_document.js.html#line1057">line 1057</a>
             </span>
         </p>
     
@@ -5501,7 +5794,7 @@ const retSearch = await api.user.document.searchDocumentsDirect(params, session)
         <p class="tag-source">
             <a href="user_document.js.html" class="button">View Source</a>
             <span>
-                <a href="user_document.js.html">user/document.js</a>, <a href="user_document.js.html#line536">line 536</a>
+                <a href="user_document.js.html">user/document.js</a>, <a href="user_document.js.html#line576">line 576</a>
             </span>
         </p>
     
@@ -6017,7 +6310,7 @@ const base64Data = await api.user.document.signedUrl(params, session);</code></p
         <p class="tag-source">
             <a href="user_document.js.html" class="button">View Source</a>
             <span>
-                <a href="user_document.js.html">user/document.js</a>, <a href="user_document.js.html#line632">line 632</a>
+                <a href="user_document.js.html">user/document.js</a>, <a href="user_document.js.html#line672">line 672</a>
             </span>
         </p>
     
@@ -6415,7 +6708,7 @@ const base64Data = await api.user.document.signedUrls(params, session);</code></
         <p class="tag-source">
             <a href="user_document.js.html" class="button">View Source</a>
             <span>
-                <a href="user_document.js.html">user/document.js</a>, <a href="user_document.js.html#line736">line 736</a>
+                <a href="user_document.js.html">user/document.js</a>, <a href="user_document.js.html#line776">line 776</a>
             </span>
         </p>
     
@@ -6706,7 +6999,7 @@ onUploadProgress return the progressEvent
         <p class="tag-source">
             <a href="user_document.js.html" class="button">View Source</a>
             <span>
-                <a href="user_document.js.html">user/document.js</a>, <a href="user_document.js.html#line680">line 680</a>
+                <a href="user_document.js.html">user/document.js</a>, <a href="user_document.js.html#line720">line 720</a>
             </span>
         </p>
     

package/docs/Kanban.html

@@ -1428,7 +1428,7 @@ Expected response structure (error):
     
     
     <div class="description">
-        Starts a new task in the Kanban board for a specific organization process
+        The new task is the full object of the task, like when you search the task
     </div>
     
 
@@ -1683,7 +1683,7 @@ Expected response structure (error):
 
   
 
-  <td class="description last">The task ids of each task inside the same status (optional)</td>
+  <td class="description last">The task ids, in their current order, of each task inside the same status (optional)</td>
 </tr>
 
   
@@ -1773,7 +1773,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#line618">line 618</a>
+                <a href="user_kanban.js.html">user/kanban.js</a>, <a href="user_kanban.js.html#line620">line 620</a>
             </span>
         </p>
     
@@ -1858,7 +1858,7 @@ Expected response structure (error):
 
 <div class="columns">
     
-    <div class='param-desc column is-7'>[returns.data.taskId] - The ID of the newly created task</div>
+    <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'>
@@ -1915,7 +1915,7 @@ const result = await api.user.kanban.startTask(params, session);
 Expected response structure (success):
 {
   success: true,
-  taskId: '507f1f77bcf86cd799439013'
+  task: { _id: '507f1f77bcf86cd799439013', ... }
 }
 
 Expected response structure (error):

package/docs/user_document.js.html

@@ -358,6 +358,46 @@ 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 the orgId and areaId (required) and the fields to update.
+   *  Partial updates accepted, such as docTypeFieldsData.extraFieldName
+   * @param {string} params.orgId The orgId of the organization
+   * @param {string} params.areaId The areaId to update in batch
+   * @param {string} session Session, token JWT
+   * @return {Promise}
+   * @public
+   * @async
+   * @example
+   *
+   * const API = require('@docbrasil/api-systemmanager');
+   * const api = new API();
+   * const params = { orgId: '5edf9f8ee896b817e45b8da7', areaId: '5edf9f8ee896b817e45b8da8', 'docTypeFieldsData.extraName': 'New name' };
+   * 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(params.orgId, Joi.string().required().error(new Error('orgId is required')));
+      Joi.assert(params.areaId, Joi.string().required().error(new Error('areaId is required')));
+      Joi.assert(session, Joi.string().required().error(new Error('session is required')));
+      const { areaId, orgId } = params;
+      delete params.areaId;
+      delete params.orgId;
+      const apiCall = self._client
+          .put(`/organizations/${orgId}/areas/${areaId}/documents/batch`, { ids, data: 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

@@ -661,18 +661,20 @@ class Kanban {
   /**
    * @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 of each task inside the same status (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.taskId] - The ID of the newly created task
+   * @returns {string} [returns.data.task] - The created task and its properties
    * @returns {string} [returns.data.error] - Error message if operation failed
    * @public
    * @example
@@ -693,7 +695,7 @@ class Kanban {
    * Expected response structure (success):
    * {
    *   success: true,
-   *   taskId: '507f1f77bcf86cd799439013'
+   *   task: { _id: '507f1f77bcf86cd799439013', ... }
    * }
    *
    * Expected response structure (error):

package/package.json

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