@docbrasil/api-systemmanager 1.1.66 → 1.1.68

package/doc/api.md

@@ -131,6 +131,7 @@ Admin Class for documents, permission admin
     * [.updateContent(params, apiKey)](#AdminDocuments+updateContent) ⇒ <code>Promise.&lt;object&gt;</code>
     * [.updateAI(params, apiKey)](#AdminDocuments+updateAI) ⇒ <code>Promise.&lt;object&gt;</code>
     * [.getContent(params, apiKey)](#AdminDocuments+getContent) ⇒ <code>Promise.&lt;object&gt;</code> \| <code>string</code> \| <code>string</code> \| <code>string</code> \| <code>string</code> \| <code>number</code>
+    * [.getDocumentData(params, apiKey)](#AdminDocuments+getDocumentData) ⇒ <code>Promise.&lt;object&gt;</code>
 
 <a name="AdminDocuments+advancedSearch"></a>
 
@@ -334,6 +335,32 @@ const params - {
 const apiKey: '...';
 await api.admin.document.getContent(params, apiKey);
 ```
+<a name="AdminDocuments+getDocumentData"></a>
+
+### adminDocuments.getDocumentData(params, apiKey) ⇒ <code>Promise.&lt;object&gt;</code>
+Get the data of a document
+
+**Kind**: instance method of [<code>AdminDocuments</code>](#AdminDocuments)  
+**Returns**: <code>Promise.&lt;object&gt;</code> - data the document data  
+**Access**: public  
+**Author**: Myndware <augusto.pissarra@myndware.com>  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| params | <code>object</code> | Params to request signed url |
+| params.id | <code>string</code> | The unique id of the document |
+| apiKey | <code>string</code> | Api Key as permission to use this functionality |
+
+**Example**  
+```js
+const API = require('@docbrasil/api-systemmanager');
+const api = new API();
+const params - {
+ id: '5dadd01dc4af3941d42f8c5c'
+};
+const apiKey: '...';
+await api.admin.document.getDocumentData(params, apiKey);
+```
 <a name="AdminForm"></a>
 
 ## AdminForm
@@ -1702,14 +1729,16 @@ Updates a document
 | 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 to be the FULL document data, that you can get with findById |
+| 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 = { ... };
+const params = { orgId: '5edf9f8ee896b817e45b8da7', areaId: '5edf9f8ee896b817e45b8da8', 'docTypeFieldsData.extraName': 'New name' };
 const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
 await api.user.document.findByIdsAndUpdate(['5edf9f8ee896b817e45b8dad'], params, session);
 ```

package/docs/AdminDocuments.html

@@ -984,7 +984,7 @@ await api.admin.document.findById(params, session);</code></pre>
         <p class="tag-source">
             <a href="admin_document.js.html" class="button">View Source</a>
             <span>
-                <a href="admin_document.js.html">admin/document.js</a>, <a href="admin_document.js.html#line315">line 315</a>
+                <a href="admin_document.js.html">admin/document.js</a>, <a href="admin_document.js.html#line312">line 312</a>
             </span>
         </p>
     
@@ -1139,6 +1139,254 @@ await api.admin.document.getContent(params, apiKey);</code></pre>
     
 
 
+</div>
+            
+                <div class="member">
+
+
+    
+    <h4 class="name" id="getDocumentData">
+        <a class="href-link" href="#getDocumentData">#</a>
+        
+            
+                <span class='tag'>async</span>
+            
+        
+        <span class="code-name">
+            
+                getDocumentData<span class="signature">(params, apiKey)</span><span class="type-signature"> &rarr; {Promise.&lt;object>}</span>
+            
+        </span>
+    </h4>
+    
+
+    
+    
+    <div class="description">
+        Get the data of 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>params</code></td>
+  
+
+  <td class="type">
+  
+      
+<code class="param-type">object</code>
+
+
+  
+  </td>
+
+  
+
+  
+
+  <td class="description last">Params to request signed url</td>
+</tr>
+
+  
+  
+    
+<tr class="deep-level-1">
+  
+      <td class="name"><code>id</code></td>
+  
+
+  <td class="type">
+  
+      
+<code class="param-type">string</code>
+
+
+  
+  </td>
+
+  
+
+  
+
+  <td class="description last">The unique id of the document</td>
+</tr>
+
+  
+
+
+        
+
+            
+<tr class="deep-level-0">
+  
+      <td class="name"><code>apiKey</code></td>
+  
+
+  <td class="type">
+  
+      
+<code class="param-type">string</code>
+
+
+  
+  </td>
+
+  
+
+  
+
+  <td class="description last">Api Key as permission to use this functionality</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="admin_document.js.html" class="button">View Source</a>
+            <span>
+                <a href="admin_document.js.html">admin/document.js</a>, <a href="admin_document.js.html#line346">line 346</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'>data the document data</div>
+    
+    
+    <div class='column is-5 has-text-left'>
+        <label>Type: </label>
+        
+<code class="param-type">Promise.&lt;object></code>
+
+
+    </div>
+    
+</div>
+
+                
+        </div>
+    </div>
+
+
+
+
+    <h5>Example</h5>
+    
+    
+        <pre class="prettyprint"><code>const API = require('@docbrasil/api-systemmanager');
+const api = new API();
+const params - {
+ id: '5dadd01dc4af3941d42f8c5c'
+};
+const apiKey: '...';
+await api.admin.document.getDocumentData(params, apiKey);</code></pre>
+    
+
+
 </div>
             
                 <div class="member">
@@ -1857,7 +2105,7 @@ const { signedUrl, imageType } = await api.admin.document.signedUrl(params, apiK
         <p class="tag-source">
             <a href="admin_document.js.html" class="button">View Source</a>
             <span>
-                <a href="admin_document.js.html">admin/document.js</a>, <a href="admin_document.js.html#line270">line 270</a>
+                <a href="admin_document.js.html">admin/document.js</a>, <a href="admin_document.js.html#line268">line 268</a>
             </span>
         </p>
     
@@ -2129,7 +2377,7 @@ await api.admin.document.updateContent(params, apiKey);</code></pre>
         <p class="tag-source">
             <a href="admin_document.js.html" class="button">View Source</a>
             <span>
-                <a href="admin_document.js.html">admin/document.js</a>, <a href="admin_document.js.html#line223">line 223</a>
+                <a href="admin_document.js.html">admin/document.js</a>, <a href="admin_document.js.html#line222">line 222</a>
             </span>
         </p>
     

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#line828">line 828</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#line916">line 916</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#line956">line 956</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#line375">line 375</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#line324">line 324</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#line459">line 459</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#line504">line 504</a>
+                <a href="user_document.js.html">user/document.js</a>, <a href="user_document.js.html#line510">line 510</a>
             </span>
         </p>
     
@@ -4290,9 +4290,59 @@ await api.user.document.findByIdsAndRemove(params, session);</code></pre>
 
   
 
-  <td class="description last">Object for document payload to update. It has to be the FULL document data, that you can get with findById</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>
+
+  
+
 
         
 
@@ -4370,7 +4420,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#line291">line 291</a>
+                <a href="user_document.js.html">user/document.js</a>, <a href="user_document.js.html#line294">line 294</a>
             </span>
         </p>
     
@@ -4424,7 +4474,7 @@ await api.user.document.findByIdsAndRemove(params, session);</code></pre>
     
         <pre class="prettyprint"><code>const API = require('@docbrasil/api-systemmanager');
 const api = new API();
-const params = { ... };
+const params = { orgId: '5edf9f8ee896b817e45b8da7', areaId: '5edf9f8ee896b817e45b8da8', 'docTypeFieldsData.extraName': 'New name' };
 const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
 await api.user.document.findByIdsAndUpdate(['5edf9f8ee896b817e45b8dad'], params, session);</code></pre>
     
@@ -4660,7 +4710,7 @@ await api.user.document.findByIdsAndUpdate(['5edf9f8ee896b817e45b8dad'], params,
         <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#line1006">line 1006</a>
+                <a href="user_document.js.html">user/document.js</a>, <a href="user_document.js.html#line1012">line 1012</a>
             </span>
         </p>
     
@@ -4941,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#line876">line 876</a>
+                <a href="user_document.js.html">user/document.js</a>, <a href="user_document.js.html#line882">line 882</a>
             </span>
         </p>
     
@@ -5285,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#line1051">line 1051</a>
+                <a href="user_document.js.html">user/document.js</a>, <a href="user_document.js.html#line1057">line 1057</a>
             </span>
         </p>
     
@@ -5744,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#line570">line 570</a>
+                <a href="user_document.js.html">user/document.js</a>, <a href="user_document.js.html#line576">line 576</a>
             </span>
         </p>
     
@@ -6260,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#line666">line 666</a>
+                <a href="user_document.js.html">user/document.js</a>, <a href="user_document.js.html#line672">line 672</a>
             </span>
         </p>
     
@@ -6658,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#line770">line 770</a>
+                <a href="user_document.js.html">user/document.js</a>, <a href="user_document.js.html#line776">line 776</a>
             </span>
         </p>
     
@@ -6949,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#line714">line 714</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/admin_document.js.html

@@ -270,7 +270,6 @@ class AdminDocuments {
    * const { signedUrl, imageType } = await api.admin.document.signedUrl(params, apiKey);
    */
   async signedUrl(params = {}, apiKey) {
-
     Joi.assert(params, Joi.object().required());
     Joi.assert(params.methodType, Joi.string().required());
     Joi.assert(params.docId, Joi.string().required());
@@ -308,7 +307,6 @@ class AdminDocuments {
    * await api.admin.document.updateContent(params, apiKey);
    */
   async updateContent(params = {}, apiKey) {
-
     Joi.assert(params, Joi.object().required());
     Joi.assert(params.content, Joi.string().required());
     Joi.assert(params.docId, Joi.string().required());
@@ -355,7 +353,6 @@ class AdminDocuments {
    * await api.admin.document.updateContent(params, apiKey);
    */
   async updateAI(params = {}, apiKey) {
-
     Joi.assert(params, Joi.object().required());
     Joi.assert(params.docId, Joi.string().required());
     Joi.assert(apiKey, Joi.string().required());
@@ -400,7 +397,6 @@ class AdminDocuments {
    * await api.admin.document.getContent(params, apiKey);
    */
   async getContent(params = {}, apiKey) {
-
     Joi.assert(params, Joi.object().required());
     Joi.assert(params.docId, Joi.string().required());
     Joi.assert(params.page, Joi.string().required());
@@ -414,6 +410,39 @@ class AdminDocuments {
     return self._returnData(await apiCall);
   }
 
+  /**
+   *
+   * @author Myndware <augusto.pissarra@myndware.com>
+   * @description Get the data of a document
+   * @param {object} params Params to request signed url
+   * @param {string} params.id The unique id of the document
+   * @param {string} apiKey Api Key as permission to use this functionality
+   * @return {Promise<object>} data the document data
+   * @public
+   * @async
+   * @example
+   *
+   * const API = require('@docbrasil/api-systemmanager');
+   * const api = new API();
+   * const params - {
+   *  id: '5dadd01dc4af3941d42f8c5c'
+   * };
+   * const apiKey: '...';
+   * await api.admin.document.getDocumentData(params, apiKey);
+   */
+  async getDocumentData(params = {}, apiKey) {
+    Joi.assert(params, Joi.object().required());
+    Joi.assert(params.id, Joi.string().required());
+    Joi.assert(apiKey, Joi.string().required());
+
+    const self = this;
+    const { id } = params;
+    const url = `/api/documents/${id}?apiKey=${apiKey}`;
+    const apiCall = self._client
+        .get(url);
+    return self._returnData(await apiCall);
+  }
+
 }
 
 export default AdminDocuments;

package/docs/user_document.js.html

@@ -362,7 +362,10 @@ 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 {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
@@ -371,7 +374,7 @@ class Documents {
    *
    * const API = require('@docbrasil/api-systemmanager');
    * const api = new API();
-   * const params = { ... };
+   * const params = { orgId: '5edf9f8ee896b817e45b8da7', areaId: '5edf9f8ee896b817e45b8da8', 'docTypeFieldsData.extraName': 'New name' };
    * const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
    * await api.user.document.findByIdsAndUpdate(['5edf9f8ee896b817e45b8dad'], params, session);
    */
@@ -380,11 +383,14 @@ class Documents {
     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;
-      params.ids = ids;
+      delete params.areaId;
+      delete params.orgId;
       const apiCall = self._client
-          .put(`/organizations/${orgId}/areas/${areaId}/documents/batch`, params, self._setHeader(session));
+          .put(`/organizations/${orgId}/areas/${areaId}/documents/batch`, { ids, data: params }, self._setHeader(session));
 
       return self._returnData(await apiCall);
     } catch (ex) {

package/package.json

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