@docbrasil/api-systemmanager 1.0.113 → 1.0.114

package/doc/api.md

@@ -1954,6 +1954,7 @@ Class for process, permission user
     * [.exportStatusData(params, session)](#Process+exportStatusData)
     * [.exportProcessData(params, session)](#Process+exportProcessData)
     * [.processDocs(params, session)](#Process+processDocs) ⇒ <code>promise</code> \| <code>array.&lt;object&gt;</code>
+    * [.downloadDocs(params, session)](#Process+downloadDocs) ⇒ <code>promise</code>
 
 <a name="Process+start"></a>
 
@@ -2179,6 +2180,38 @@ const params = {
 const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
 const retSearch = await api.user.process.processDocs(params, session);
 ```
+<a name="Process+downloadDocs"></a>
+
+### process.downloadDocs(params, session) ⇒ <code>promise</code>
+Method to download the process documents
+
+**Kind**: instance method of [<code>Process</code>](#Process)  
+**Returns**: <code>promise</code> - returned data from the search  
+**Access**: public  
+**Author**: CloudBrasil <abernardo.br@gmail.com>  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| params | <code>object</code> | Params to download the process documents |
+| params.orgId | <code>string</code> | Organization id (_id database) |
+| params.type | <code>string</code> | Document Type |
+| params.docIds | <code>array</code> | Documents Ids |
+| params.footer | <code>string</code> | Documents Footer |
+| session | <code>string</code> | Session, token JWT |
+
+**Example**  
+```js
+const API = require('@docbrasil/api-systemmanager');
+const api = new API();
+const params = {
+ orgId: '55e4a3bd6be6b45210833fae',
+ type: 'Docs',
+ docIds: ['55e4a3bd6be6b45210833fae'],
+ footer: 'Documento - {page} de {pages}'
+};
+const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
+const result = await api.user.process.downloadDocs(params, session);
+```
 <a name="Register"></a>
 
 ## Register

package/docs/Process.html

@@ -224,6 +224,326 @@
 
 
     
+    <h4 class="name" id="downloadDocs">
+        <a class="href-link" href="#downloadDocs">#</a>
+        
+            
+                <span class='tag'>async</span>
+            
+        
+        <span class="code-name">
+            
+                downloadDocs<span class="signature">(params, session)</span><span class="type-signature"> &rarr; {promise}</span>
+            
+        </span>
+    </h4>
+    
+
+    
+    
+    <div class="description">
+        Method to download the process documents
+    </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 download the process documents</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">Organization id (_id database)</td>
+</tr>
+
+  
+    
+<tr class="deep-level-1">
+  
+      <td class="name"><code>type</code></td>
+  
+
+  <td class="type">
+  
+      
+<code class="param-type">string</code>
+
+
+  
+  </td>
+
+  
+
+  
+
+  <td class="description last">Document Type</td>
+</tr>
+
+  
+    
+<tr class="deep-level-1">
+  
+      <td class="name"><code>docIds</code></td>
+  
+
+  <td class="type">
+  
+      
+<code class="param-type">array</code>
+
+
+  
+  </td>
+
+  
+
+  
+
+  <td class="description last">Documents Ids</td>
+</tr>
+
+  
+    
+<tr class="deep-level-1">
+  
+      <td class="name"><code>footer</code></td>
+  
+
+  <td class="type">
+  
+      
+<code class="param-type">string</code>
+
+
+  
+  </td>
+
+  
+
+  
+
+  <td class="description last">Documents Footer</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:abernardo.br@gmail.com">CloudBrasil</a></li>
+        </ul>
+    </dd>
+    
+
+    
+
+    
+
+    
+    
+
+    
+
+    
+
+    
+        <p class="tag-source">
+            <a href="user_process.js.html" class="button">View Source</a>
+            <span>
+                <a href="user_process.js.html">user/process.js</a>, <a href="user_process.js.html#line414">line 414</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'>returned data from the search</div>
+    
+    
+    <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: '55e4a3bd6be6b45210833fae',
+ type: 'Docs',
+ docIds: ['55e4a3bd6be6b45210833fae'],
+ footer: 'Documento - {page} de {pages}'
+};
+const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
+const result = await api.user.process.downloadDocs(params, session);</code></pre>
+    
+
+
+</div>
+            
+                <div class="member">
+
+
+    
     <h4 class="name" id="exportProcessData">
         <a class="href-link" href="#exportProcessData">#</a>
         

package/docs/user_process.js.html

@@ -473,6 +473,59 @@ class Process {
       throw ex;
     }
   }
+
+  /**
+   * @author CloudBrasil <abernardo.br@gmail.com>
+   * @description Method to download the process documents
+   * @param {object} params Params to download the process documents
+   * @param {string} params.orgId Organization id (_id database)
+   * @param {string} params.type Document Type
+   * @param {array} params.docIds Documents Ids
+   * @param {string} params.footer Documents Footer
+   * @param {string} session Session, token JWT
+   * @returns {promise} returned data from the search
+   * @public
+   * @example
+   *
+   * const API = require('@docbrasil/api-systemmanager');
+   * const api = new API();
+   * const params = {
+   *  orgId: '55e4a3bd6be6b45210833fae',
+   *  type: 'Docs',
+   *  docIds: ['55e4a3bd6be6b45210833fae'],
+   *  footer: 'Documento - {page} de {pages}'
+   * };
+   * const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
+   * const result = await api.user.process.downloadDocs(params, session);
+   */
+  async downloadDocs(params, session) {
+    const self = this;
+
+    try {
+      Joi.assert(params, Joi.object().required(), 'Params to download the process documents');
+      Joi.assert(params.orgId, Joi.string().required(), 'Organization id (_id database)');
+      Joi.assert(params.type, Joi.string().required(), 'Document Type');
+      Joi.assert(params.docIds, Joi.array().required(), 'Document Ids');
+      Joi.assert(params.footer, Joi.string(), 'Documents Footer');
+      Joi.assert(session, Joi.string().required(), 'Session token JWT');
+
+      const {orgId, type, docIds, footer} = params;
+      const data = {
+        docIds
+      };
+
+      if (footer) {
+        data.footer = footer
+      }
+
+      const apiCall = self._client
+        .post(`/organizations/${orgId}/documents/download/${type}`, data, self._setHeader(session));
+
+      return self._returnData(await apiCall);
+    } catch (ex) {
+      throw ex;
+    }
+  }
 }
 
 export default Process;

package/package.json

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