@docbrasil/api-systemmanager 1.0.108 → 1.0.110

package/doc/api.md

@@ -1920,7 +1920,7 @@ Start process
 | Param | Type | Default | Description |
 | --- | --- | --- | --- |
 | params | <code>object</code> |  | Params to start process |
-| params.processId | <code>string</code> |  | Process id (_id database); |
+| params.orgProcessId | <code>string</code> |  | The organization process id (_id database); |
 | params.orgId | <code>string</code> |  | Organization id (_id database); |
 | [params.payload] | <code>object</code> | <code>{}</code> | Start process with data |
 | session | <code>string</code> |  | Session, token JWT |
@@ -1930,7 +1930,7 @@ Start process
 const API = require('@docbrasil/api-systemmanager');
 const api = new API();
 const params = {
-  processId: '5dadd01dc4af3941d42f8c5c',
+  orgProcessId: '5dadd01dc4af3941d42f8c5c',
   orgId: '5edd11c46b6ce9729c2c297c',
   payload: {}
 }
@@ -2548,7 +2548,7 @@ Class for documents, permission user
 * [External](#External)
     * [.context(params)](#External+context) ⇒ <code>Promise.&lt;object&gt;</code> \| <code>string</code> \| <code>string</code> \| <code>string</code> \| <code>array.&lt;object&gt;</code>
     * [.getUploadDocumentSignedUrl(mime, authorization)](#External+getUploadDocumentSignedUrl) ⇒ <code>Promise.&lt;object&gt;</code> \| <code>string</code> \| <code>string</code> \| <code>string</code> \| <code>string</code>
-    * [.getUploadDocumentSignedUrl(docs, authorization)](#External+getUploadDocumentSignedUrl) ⇒ <code>Promise.&lt;array&gt;</code> \| <code>string</code> \| <code>string</code> \| <code>string</code> \| <code>string</code>
+    * [.getUploadDocumentsSignedUrl(docs, authorization)](#External+getUploadDocumentsSignedUrl) ⇒ <code>Promise.&lt;array&gt;</code> \| <code>string</code> \| <code>string</code> \| <code>string</code> \| <code>string</code>
     * [.handle(authorization, params)](#External+handle) ⇒ <code>Promise.&lt;boolean&gt;</code>
 
 <a name="External+context"></a>
@@ -2601,9 +2601,9 @@ const doc = {
 };
 const retDoc = await api.external.getUploadDocumentSignedUrl(doc, authorization);
 ```
-<a name="External+getUploadDocumentSignedUrl"></a>
+<a name="External+getUploadDocumentsSignedUrl"></a>
 
-### external.getUploadDocumentSignedUrl(docs, authorization) ⇒ <code>Promise.&lt;array&gt;</code> \| <code>string</code> \| <code>string</code> \| <code>string</code> \| <code>string</code>
+### external.getUploadDocumentsSignedUrl(docs, authorization) ⇒ <code>Promise.&lt;array&gt;</code> \| <code>string</code> \| <code>string</code> \| <code>string</code> \| <code>string</code>
 Get an upload signed url, for many documents. So it will be possible to upload documents temporarily during the use of the external form
 
 **Kind**: instance method of [<code>External</code>](#External)  

package/docs/External.html

@@ -528,7 +528,301 @@ const retForm = await api.external.context(params);</code></pre>
         
         <span class="code-name">
             
-                getUploadDocumentSignedUrl<span class="signature">(docs, authorization)</span><span class="type-signature"> &rarr; {Promise.&lt;array>|string|string|string|string}</span>
+                getUploadDocumentSignedUrl<span class="signature">(mime, authorization)</span><span class="type-signature"> &rarr; {Promise.&lt;object>|string|string|string|string}</span>
+            
+        </span>
+    </h4>
+    
+
+    
+    
+    <div class="description">
+        Get an upload signed url, so it will be possible to upload documents temporarily during the use of the external form
+    </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>mime</code></td>
+  
+
+  <td class="type">
+  
+      
+<code class="param-type">string</code>
+
+
+  
+  </td>
+
+  
+
+  
+
+  <td class="description last">the mime type of the document</td>
+</tr>
+
+
+        
+
+            
+<tr class="deep-level-0">
+  
+      <td class="name"><code>authorization</code></td>
+  
+
+  <td class="type">
+  
+      
+<code class="param-type">string</code>
+
+
+  
+  </td>
+
+  
+
+  
+
+  <td class="description last">a legal authorization</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="external.js.html" class="button">View Source</a>
+            <span>
+                <a href="external.js.html">external.js</a>, <a href="external.js.html#line111">line 111</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'>doc</div>
+    
+    
+    <div class='column is-5 has-text-left'>
+        <label>Type: </label>
+        
+<code class="param-type">Promise.&lt;object></code>
+
+
+    </div>
+    
+</div>
+
+                
+                    
+
+<div class="columns">
+    
+    <div class='param-desc column is-7'>doc.mime the original mime type of the document</div>
+    
+    
+    <div class='column is-5 has-text-left'>
+        <label>Type: </label>
+        
+<code class="param-type">string</code>
+
+
+    </div>
+    
+</div>
+
+                
+                    
+
+<div class="columns">
+    
+    <div class='param-desc column is-7'>doc.signedUrl the signed url to upload the document</div>
+    
+    
+    <div class='column is-5 has-text-left'>
+        <label>Type: </label>
+        
+<code class="param-type">string</code>
+
+
+    </div>
+    
+</div>
+
+                
+                    
+
+<div class="columns">
+    
+    <div class='param-desc column is-7'>doc.filename  the filename of the uploaded file</div>
+    
+    
+    <div class='column is-5 has-text-left'>
+        <label>Type: </label>
+        
+<code class="param-type">string</code>
+
+
+    </div>
+    
+</div>
+
+                
+                    
+
+<div class="columns">
+    
+    <div class='param-desc column is-7'>doc.extension  the extension of the filename, obtained from the mime type</div>
+    
+    
+    <div class='column is-5 has-text-left'>
+        <label>Type: </label>
+        
+<code class="param-type">string</code>
+
+
+    </div>
+    
+</div>
+
+                
+        </div>
+    </div>
+
+
+
+
+    <h5>Example</h5>
+    
+    
+        <pre class="prettyprint"><code>const API = require('@docbrasil/api-systemmanager');
+const api = new API();
+const authorization = '...';
+const doc = {
+ mime: 'application/pdf'
+};
+const retDoc = await api.external.getUploadDocumentSignedUrl(doc, authorization);</code></pre>
+    
+
+
+</div>
+            
+                <div class="member">
+
+
+    
+    <h4 class="name" id="getUploadDocumentsSignedUrl">
+        <a class="href-link" href="#getUploadDocumentsSignedUrl">#</a>
+        
+            
+                <span class='tag'>async</span>
+            
+        
+        <span class="code-name">
+            
+                getUploadDocumentsSignedUrl<span class="signature">(docs, authorization)</span><span class="type-signature"> &rarr; {Promise.&lt;array>|string|string|string|string}</span>
             
         </span>
     </h4>

package/docs/Process.html

@@ -1297,7 +1297,7 @@ await api.user.process.getProcessProperties(params, session);</code></pre>
     
 <tr class="deep-level-1">
   
-      <td class="name"><code>processId</code></td>
+      <td class="name"><code>orgProcessId</code></td>
   
 
   <td class="type">
@@ -1325,7 +1325,7 @@ await api.user.process.getProcessProperties(params, session);</code></pre>
       </td>
   
 
-  <td class="description last">Process id (_id database);</td>
+  <td class="description last">The organization process id (_id database);</td>
 </tr>
 
   
@@ -1548,7 +1548,7 @@ await api.user.process.getProcessProperties(params, session);</code></pre>
         <pre class="prettyprint"><code>const API = require('@docbrasil/api-systemmanager');
 const api = new API();
 const params = {
-  processId: '5dadd01dc4af3941d42f8c5c',
+  orgProcessId: '5dadd01dc4af3941d42f8c5c',
   orgId: '5edd11c46b6ce9729c2c297c',
   payload: {}
 }

package/docs/external.js.html

@@ -236,11 +236,11 @@ class External {
    * ];
    * const retDocs = await api.external.getUploadDocumentsSignedUrl(docs, authorization);
    */
-  async getUploadDocumentSignedUrl(docs, authorization) {
+  async getUploadDocumentsSignedUrl(docs, authorization) {
     const self = this;
 
     try {
-      Joi.assert(docs, Joi.string().array().error(new Error('docs is required')));
+      Joi.assert(docs, Joi.array().required().error(new Error('docs is required')));
       Joi.assert(authorization, Joi.string().required().error(new Error('authorization is required')));
 
       const apiCall = self._client

package/docs/user_process.js.html

@@ -155,7 +155,7 @@ class Process {
    * @author CloudBrasil <abernardo.br@gmail.com>
    * @description Start process
    * @param {object} params Params to start process
-   * @param {string} params.processId Process id (_id database);
+   * @param {string} params.orgProcessId The organization process id (_id database);
    * @param {string} params.orgId Organization id (_id database);
    * @param {object} [params.payload={}] Start process with data
    * @param {string} session Session, token JWT
@@ -167,7 +167,7 @@ class Process {
    * const API = require('@docbrasil/api-systemmanager');
    * const api = new API();
    * const params = {
-   *   processId: '5dadd01dc4af3941d42f8c5c',
+   *   orgProcessId: '5dadd01dc4af3941d42f8c5c',
    *   orgId: '5edd11c46b6ce9729c2c297c',
    *   payload: {}
    * }
@@ -179,13 +179,13 @@ class Process {
 
     try {
       Joi.assert(params, Joi.object().required());
-      Joi.assert(params.processId, Joi.string().required());
+      Joi.assert(params.orgProcessId, Joi.string().required());
       Joi.assert(params.orgId, Joi.string().required());
       Joi.assert(params.payload, Joi.object());
       Joi.assert(session, Joi.string().required());
 
-      const {processId, orgId, payload = {}} = params;
-      const apiCall = self._client.put(`/organizations/${orgId}/process/${processId}`, payload, self._setMaxContentHeader(session));
+      const {orgProcessId, orgId, payload = {}} = params;
+      const apiCall = self._client.put(`/organizations/${orgId}/process/${orgProcessId}`, payload, self._setMaxContentHeader(session));
       return self._returnData(await apiCall);
     } catch (ex) {
       throw ex;

package/package.json

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

package/readme.md

@@ -20,5 +20,5 @@ const api = new APISystemManager();
 
 ### API
 * [API Documentation in HTML](https://cloudbrasil.github.io/api-systemmanager)
-* [API Documentation in Markup](https://github.com/cloudbrasil/api-systemmanager/blob/develop/doc/doc.md)
+* [API Documentation in Markup](https://github.com/cloudbrasil/api-systemmanager/blob/develop/doc/api.md)
 * [API Examples](https://github.com/cloudbrasil/api-systemmanager/wiki)