@docbrasil/api-systemmanager 1.1.36 → 1.1.37

package/doc/api.md

@@ -1569,6 +1569,7 @@ Class for documents, permission user
     * [.signedUrl(params, session)](#Documents+signedUrl) ⇒ <code>Promise.&lt;object&gt;</code> \| <code>string</code> \| <code>string</code> \| <code>string</code> \| <code>string</code> \| <code>string</code>
     * [.signedUrls(params, session)](#Documents+signedUrls) ⇒ <code>Promise.&lt;object&gt;</code> \| <code>string</code> \| <code>string</code> \| <code>string</code> \| <code>string</code> \| <code>string</code>
     * [.uploadSignedDocument(params)](#Documents+uploadSignedDocument) ⇒ <code>Promise.&lt;boolean&gt;</code>
+    * [.uploadDocumentS3(params)](#Documents+uploadDocumentS3) ⇒ <code>Promise.&lt;boolean&gt;</code>
     * [.checkPrimaryKeys(params, session)](#Documents+checkPrimaryKeys) ⇒ <code>Promise.&lt;array&gt;</code> \| <code>array.&lt;string&gt;</code>
     * [.searchDocuments(params, session)](#Documents+searchDocuments) ⇒ <code>promise</code> \| <code>number</code> \| <code>array.&lt;object&gt;</code> \| <code>number</code> \| <code>number</code>
     * [.exportExcelForAllPages(params, session)](#Documents+exportExcelForAllPages) ⇒ <code>promise</code>
@@ -1910,6 +1911,39 @@ const params - {
 };
 const retData = await api.user.document.uploadSignedDocument(params);
 
+onUploadProgress return the progressEvent
+ - lengthComputable: A Boolean that indicates whether or not the total number of bytes is known.
+ - loaded: The number of bytes of the file that have been uploaded.
+ - total: The total number of bytes in the file.
+```
+<a name="Documents+uploadDocumentS3"></a>
+
+### documents.uploadDocumentS3(params) ⇒ <code>Promise.&lt;boolean&gt;</code>
+Uploads the file
+
+**Kind**: instance method of [<code>Documents</code>](#Documents)  
+**Returns**: <code>Promise.&lt;boolean&gt;</code> - True if success  
+**Access**: public  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| params | <code>object</code> | Params to upload document S3 |
+| params.data | <code>buffer</code> | The data of the file |
+| params.areaId | <code>string</code> | The docAreaId |
+| params.orgId | <code>string</code> | The orgId |
+| params.onUploadProgress | <code>string</code> | A callback for the upload progress. It will return a progressEvent. |
+
+**Example**  
+```js
+const API = require('@docbrasil/api-systemmanager');
+const api = new API();
+const params - {
+ data: {},
+ areaId: '5dadd01dc4af3941d42f8c5c',
+ orgId: '5dadd01dc4af3941d42f8c5c'
+};
+const retData = await api.user.document.uploadDocumentS3(params);
+
 onUploadProgress return the progressEvent
  - lengthComputable: A Boolean that indicates whether or not the total number of bytes is known.
  - loaded: The number of bytes of the file that have been uploaded.
@@ -2907,6 +2941,7 @@ Class for process, permission user
     * [.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>
+    * [.getOrgDocTypes(params, session)](#Process+getOrgDocTypes) ⇒ <code>Promise</code>
 
 <a name="Process+start"></a>
 
@@ -3164,6 +3199,33 @@ const params = {
 const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
 const result = await api.user.process.downloadDocs(params, session);
 ```
+<a name="Process+getOrgDocTypes"></a>
+
+### process.getOrgDocTypes(params, session) ⇒ <code>Promise</code>
+Get DocType properties of process
+
+**Kind**: instance method of [<code>Process</code>](#Process)  
+**Access**: public  
+**Author**: Myndware <augusto.pissarra@myndware.com>  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| params | <code>object</code> | Params to get document DocType |
+| params.docTypeId | <code>string</code> | Document DocTypeId id (_id database); |
+| params.orgId | <code>string</code> | Organization id (_id database); |
+| session | <code>string</code> | Session, token JWT |
+
+**Example**  
+```js
+const API = require('@docbrasil/api-systemmanager');
+const api = new API();
+const params = {
+  docTypeId: '5dadd01dc4af3941d42f8c5c',
+  orgId: '5edd11c46b6ce9729c2c297c',
+}
+const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
+await api.user.process.getOrgDocTypes(params, session);
+```
 <a name="Register"></a>
 
 ## Register

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#line738">line 738</a>
+                <a href="user_document.js.html">user/document.js</a>, <a href="user_document.js.html#line793">line 793</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#line826">line 826</a>
+                <a href="user_document.js.html">user/document.js</a>, <a href="user_document.js.html#line881">line 881</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#line866">line 866</a>
+                <a href="user_document.js.html">user/document.js</a>, <a href="user_document.js.html#line921">line 921</a>
             </span>
         </p>
     
@@ -4417,7 +4417,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#line916">line 916</a>
+                <a href="user_document.js.html">user/document.js</a>, <a href="user_document.js.html#line971">line 971</a>
             </span>
         </p>
     
@@ -4698,7 +4698,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#line786">line 786</a>
+                <a href="user_document.js.html">user/document.js</a>, <a href="user_document.js.html#line841">line 841</a>
             </span>
         </p>
     
@@ -5042,7 +5042,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#line961">line 961</a>
+                <a href="user_document.js.html">user/document.js</a>, <a href="user_document.js.html#line1016">line 1016</a>
             </span>
         </p>
     
@@ -6194,6 +6194,297 @@ const base64Data = await api.user.document.signedUrls(params, session);</code></
     
 
 
+</div>
+            
+                <div class="member">
+
+
+    
+    <h4 class="name" id="uploadDocumentS3">
+        <a class="href-link" href="#uploadDocumentS3">#</a>
+        
+            
+                <span class='tag'>async</span>
+            
+        
+        <span class="code-name">
+            
+                uploadDocumentS3<span class="signature">(params)</span><span class="type-signature"> &rarr; {Promise.&lt;boolean>}</span>
+            
+        </span>
+    </h4>
+    
+
+    
+    
+    <div class="description">
+        Uploads the file
+    </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 upload document S3</td>
+</tr>
+
+  
+  
+    
+<tr class="deep-level-1">
+  
+      <td class="name"><code>data</code></td>
+  
+
+  <td class="type">
+  
+      
+<code class="param-type">buffer</code>
+
+
+  
+  </td>
+
+  
+
+  
+
+  <td class="description last">The data of the file</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 docAreaId</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</td>
+</tr>
+
+  
+    
+<tr class="deep-level-1">
+  
+      <td class="name"><code>onUploadProgress</code></td>
+  
+
+  <td class="type">
+  
+      
+<code class="param-type">string</code>
+
+
+  
+  </td>
+
+  
+
+  
+
+  <td class="description last">A callback for the upload progress. It will return a progressEvent.</td>
+</tr>
+
+  
+
+
+        
+        </tbody>
+    </table>
+</div>
+
+
+
+
+
+<dl class="details">
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+    
+
+    
+
+    
+
+    
+        <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#line735">line 735</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'>True if success</div>
+    
+    
+    <div class='column is-5 has-text-left'>
+        <label>Type: </label>
+        
+<code class="param-type">Promise.&lt;boolean></code>
+
+
+    </div>
+    
+</div>
+
+                
+        </div>
+    </div>
+
+
+
+
+    <h5>Example</h5>
+    
+    
+        <pre class="prettyprint"><code>const API = require('@docbrasil/api-systemmanager');
+const api = new API();
+const params - {
+ data: {},
+ areaId: '5dadd01dc4af3941d42f8c5c',
+ orgId: '5dadd01dc4af3941d42f8c5c'
+};
+const retData = await api.user.document.uploadDocumentS3(params);
+
+onUploadProgress return the progressEvent
+ - lengthComputable: A Boolean that indicates whether or not the total number of bytes is known.
+ - loaded: The number of bytes of the file that have been uploaded.
+ - total: The total number of bytes in the file.</code></pre>
+    
+
+
 </div>
             
                 <div class="member">

package/docs/Process.html

@@ -1376,6 +1376,276 @@ const retSearch = await api.user.process.find(params, session);</code></pre>
     
 
 
+</div>
+            
+                <div class="member">
+
+
+    
+    <h4 class="name" id="getOrgDocTypes">
+        <a class="href-link" href="#getOrgDocTypes">#</a>
+        
+            
+                <span class='tag'>async</span>
+            
+        
+        <span class="code-name">
+            
+                getOrgDocTypes<span class="signature">(params, session)</span><span class="type-signature"> &rarr; {Promise}</span>
+            
+        </span>
+    </h4>
+    
+
+    
+    
+    <div class="description">
+        Get DocType properties of process
+    </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 get document DocType</td>
+</tr>
+
+  
+  
+    
+<tr class="deep-level-1">
+  
+      <td class="name"><code>docTypeId</code></td>
+  
+
+  <td class="type">
+  
+      
+<code class="param-type">string</code>
+
+
+  
+  </td>
+
+  
+
+  
+
+  <td class="description last">Document DocTypeId id (_id database);</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-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_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#line463">line 463</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 = {
+  docTypeId: '5dadd01dc4af3941d42f8c5c',
+  orgId: '5edd11c46b6ce9729c2c297c',
+}
+const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
+await api.user.process.getOrgDocTypes(params, session);</code></pre>
+    
+
+
 </div>
             
                 <div class="member">