@docbrasil/api-systemmanager 1.1.68 → 1.1.70

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">

package/docs/user_document.js.html

@@ -325,6 +325,81 @@ class Documents {
     }
   }
 
+  /**
+   * @author Myndware <augusto.pissarra@myndware.com>
+   * @description Add multiple documents to a doc area under a doc type
+   * @param {object} params Object for adding documents
+   * @param {string} params.orgId Organization id (_id database)
+   * @param {string} params.userId User id (_id database)
+   * @param {string} params.docAreaName The name of the doc area
+   * @param {string} params.docTypeName The name of the doc type
+   * @param {array<object>} params.docs Array of documents to add
+   * @param {string} [params.docs.document=''] The url to the document on S3, an external URL or a base64 representation of the document
+   * @param {string} [params.docs.type=''] The mime type of the document
+   * @param {string} [params.docs.name=''] The name of the document
+   * @param {string} [params.docs.content=''] The content of the document
+   * @param {number} [params.docs.bytes=0] The bytes (in kb) of the document
+   * @param {string} [params.docs.urlType=''] The urlType of the document
+   * @param {string} [params.docs.description=''] The description of the document
+   * @param {string} [params.docs.category=''] The category of the document
+   * @param {array<string>} [params.docs.tags=[]] The tags of the document
+   * @param {object} [params.docs.docTypeFieldsData={}] The data related to this document
+   * @param {boolean} [params.docs.hasPhisicalStorage=false] The flag to define if the document has physical storage or not
+   * @param {string} [params.docs.boxId=''] The boxId if we define the document has physical storage
+   * @param {number} [params.docs.status] The document status
+   * @param {string} [params.docs.storageStatus=''] The storageStatus if we define the document has physical storage
+   * @param {string} session Session, token JWT
+   * @return {Promise<object>} The result of the operation
+   * @return {boolean} return.success True if the operation was successful
+   * @return {array<object>} return.added Array of added documents
+   * @return {array<object>} return.notAdded Array of documents that could not be added
+   * @public
+   * @async
+   * @example
+   *
+   * const API = require('@docbrasil/api-systemmanager');
+   * const api = new API();
+   * const params = {
+   *   orgId: '5df7f19618430c89a41a19d2',
+   *   userId: '5df7f19618430c89a41a19d3',
+   *   docAreaName: 'My Doc Area',
+   *   docTypeName: 'My Doc Type',
+   *   docs: [
+   *     {
+   *       document: 'https://s3.amazonaws.com/...',
+   *       type: 'application/pdf',
+   *       name: 'Document 1',
+   *       description: 'First document',
+   *       category: 'Category 1',
+   *       tags: ['tag1', 'tag2'],
+   *       docTypeFieldsData: { extraField: 'value' },
+   *       bytes: 12345
+   *     }
+   *   ]
+   * };
+   * const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
+   * const result = await api.user.document.addDocuments(params, session);
+   */
+  async addDocuments(params, session) {
+    const self = this;
+    try {
+      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.userId, Joi.string().required().error(new Error('userId is required')));
+      Joi.assert(params.docAreaName, Joi.string().required().error(new Error('docAreaName is required')));
+      Joi.assert(params.docTypeName, Joi.string().required().error(new Error('docTypeName is required')));
+      Joi.assert(params.docs, Joi.array().required().error(new Error('docs is required')));
+      Joi.assert(session, Joi.string().required().error(new Error('session is required')));
+
+      const apiCall = self._client
+        .put('/organizations/documents', 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_process.js.html

@@ -640,6 +640,47 @@ class Process {
         throw ex;
       }
     }
+
+    /**
+   * @author Myndware <augusto.pissarra@myndware.com>
+   * @description Get step history of a process flow
+   * @param {object} params Params to get step history
+   * @param {string} params.orgId Organization id (_id database);
+   * @param {string} params.processId Process id (_id database);
+   * @param {string} params.flowId Flow id;
+   * @param {string} session Session, token JWT
+   * @return {Promise<Array>} Array of step history entries
+   * @public
+   * @async
+   * @example
+   *
+   * 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);
+   */
+    async getStepHistory(params, session) {
+      const self = this;
+
+      try {
+        Joi.assert(params, Joi.object().required());
+        Joi.assert(params.orgId, Joi.string().required());
+        Joi.assert(params.processId, Joi.string().required());
+        Joi.assert(params.flowId, Joi.string().required());
+        Joi.assert(session, Joi.string().required());
+
+        const {orgId, processId, flowId} = params;
+        const apiCall = self._client.get(`/organizations/${orgId}/process/${processId}/flow/${flowId}/history`, 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.1.68",
+  "version": "1.1.70",
   "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",