@docbrasil/api-systemmanager 1.1.67 → 1.1.69

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
@@ -3431,6 +3458,7 @@ Class for process, permission user
     * [.getOrgDocTypes(params, session)](#Process+getOrgDocTypes) ⇒ <code>Promise</code>
     * [.getOrgGroups(params, session)](#Process+getOrgGroups) ⇒ <code>Promise</code>
     * [.getOrgUsers(params, session)](#Process+getOrgUsers) ⇒ <code>Promise</code>
+    * [.getStepHistory(params, session)](#Process+getStepHistory) ⇒ <code>Promise.&lt;Array&gt;</code>
 
 <a name="Process+start"></a>
 
@@ -3767,6 +3795,36 @@ const params = {
 const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
 await api.user.process.getOrgUsers(params, session);
 ```
+<a name="Process+getStepHistory"></a>
+
+### process.getStepHistory(params, session) ⇒ <code>Promise.&lt;Array&gt;</code>
+Get step history of a process flow
+
+**Kind**: instance method of [<code>Process</code>](#Process)  
+**Returns**: <code>Promise.&lt;Array&gt;</code> - Array of step history entries  
+**Access**: public  
+**Author**: Myndware <augusto.pissarra@myndware.com>  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| params | <code>object</code> | Params to get step history |
+| params.orgId | <code>string</code> | Organization id (_id database); |
+| params.processId | <code>string</code> | Process id (_id database); |
+| params.flowId | <code>string</code> | Flow id; |
+| session | <code>string</code> | Session, token JWT |
+
+**Example**  
+```js
+const API = require('@docbrasil/api-systemmanager');
+const api = new API();
+const params = {
+  orgId: '5edd11c46b6ce9729c2c297c',
+  processId: '5dadd01dc4af3941d42f8c5c',
+  flowId: 'Task_18v1xx7'
+}
+const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
+const stepHistory = await api.user.process.getStepHistory(params, session);
+```
 <a name="Register"></a>
 
 ## Register

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/Process.html

@@ -2795,6 +2795,302 @@ await api.user.process.getProcessProperties(params, session);</code></pre>
     
 
 
+</div>
+            
+                <div class="member">
+
+
+    
+    <h4 class="name" id="getStepHistory">
+        <a class="href-link" href="#getStepHistory">#</a>
+        
+            
+                <span class='tag'>async</span>
+            
+        
+        <span class="code-name">
+            
+                getStepHistory<span class="signature">(params, session)</span><span class="type-signature"> &rarr; {Promise.&lt;Array>}</span>
+            
+        </span>
+    </h4>
+    
+
+    
+    
+    <div class="description">
+        Get step history of a process flow
+    </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 step history</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>processId</code></td>
+  
+
+  <td class="type">
+  
+      
+<code class="param-type">string</code>
+
+
+  
+  </td>
+
+  
+
+  
+
+  <td class="description last">Process id (_id database);</td>
+</tr>
+
+  
+    
+<tr class="deep-level-1">
+  
+      <td class="name"><code>flowId</code></td>
+  
+
+  <td class="type">
+  
+      
+<code class="param-type">string</code>
+
+
+  
+  </td>
+
+  
+
+  
+
+  <td class="description last">Flow id;</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#line580">line 580</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'>Array of step history entries</div>
+    
+    
+    <div class='column is-5 has-text-left'>
+        <label>Type: </label>
+        
+<code class="param-type">Promise.&lt;Array></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: '5edd11c46b6ce9729c2c297c',
+  processId: '5dadd01dc4af3941d42f8c5c',
+  flowId: 'Task_18v1xx7'
+}
+const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
+const stepHistory = await api.user.process.getStepHistory(params, session);</code></pre>
+    
+
+
 </div>
             
                 <div class="member">