@docbrasil/api-systemmanager 1.1.18 → 1.1.20

package/docs/Process.html

@@ -451,7 +451,7 @@
     <dt class="tag-author">Author:</dt>
     <dd class="tag-author">
         <ul>
-            <li><a href="mailto:abernardo.br@gmail.com">CloudBrasil</a></li>
+            <li><a href="mailto:augusto.pissarra@myndware.com">Myndware</a></li>
         </ul>
     </dd>
     
@@ -725,7 +725,7 @@ const result = await api.user.process.downloadDocs(params, session);</code></pre
     <dt class="tag-author">Author:</dt>
     <dd class="tag-author">
         <ul>
-            <li><a href="mailto:abernardo.br@gmail.com">CloudBrasil</a></li>
+            <li><a href="mailto:augusto.pissarra@myndware.com">Myndware</a></li>
         </ul>
     </dd>
     
@@ -972,7 +972,7 @@ const retSearch = await api.user.process.exportProcessData(params, session);</co
     <dt class="tag-author">Author:</dt>
     <dd class="tag-author">
         <ul>
-            <li><a href="mailto:abernardo.br@gmail.com">CloudBrasil</a></li>
+            <li><a href="mailto:augusto.pissarra@myndware.com">Myndware</a></li>
         </ul>
     </dd>
     
@@ -1219,7 +1219,7 @@ const retSearch = await api.user.process.exportStatusData(params, session);</cod
     <dt class="tag-author">Author:</dt>
     <dd class="tag-author">
         <ul>
-            <li><a href="mailto:abernardo.br@gmail.com">CloudBrasil</a></li>
+            <li><a href="mailto:augusto.pissarra@myndware.com">Myndware</a></li>
         </ul>
     </dd>
     
@@ -1563,7 +1563,7 @@ const retSearch = await api.user.process.find(params, session);</code></pre>
     <dt class="tag-author">Author:</dt>
     <dd class="tag-author">
         <ul>
-            <li><a href="mailto:abernardo.br@gmail.com">CloudBrasil</a></li>
+            <li><a href="mailto:augusto.pissarra@myndware.com">Myndware</a></li>
         </ul>
     </dd>
     
@@ -1926,7 +1926,7 @@ const retSearchInfo = await api.user.process.getOrgProcessSearchInfo(params, ses
     <dt class="tag-author">Author:</dt>
     <dd class="tag-author">
         <ul>
-            <li><a href="mailto:abernardo.br@gmail.com">CloudBrasil</a></li>
+            <li><a href="mailto:augusto.pissarra@myndware.com">Myndware</a></li>
         </ul>
     </dd>
     
@@ -2219,7 +2219,7 @@ await api.user.process.getProcessProperties(params, session);</code></pre>
     <dt class="tag-author">Author:</dt>
     <dd class="tag-author">
         <ul>
-            <li><a href="mailto:abernardo.br@gmail.com">CloudBrasil</a></li>
+            <li><a href="mailto:augusto.pissarra@myndware.com">Myndware</a></li>
         </ul>
     </dd>
     
@@ -2510,7 +2510,7 @@ const retSearch = await api.user.process.processDocs(params, session);</code></p
     <dt class="tag-author">Author:</dt>
     <dd class="tag-author">
         <ul>
-            <li><a href="mailto:abernardo.br@gmail.com">CloudBrasil</a></li>
+            <li><a href="mailto:augusto.pissarra@myndware.com">Myndware</a></li>
         </ul>
     </dd>
     
@@ -2848,7 +2848,7 @@ const retSearch = await api.user.process.remove(params, session);</code></pre>
     <dt class="tag-author">Author:</dt>
     <dd class="tag-author">
         <ul>
-            <li><a href="mailto:abernardo.br@gmail.com">CloudBrasil</a></li>
+            <li><a href="mailto:augusto.pissarra@myndware.com">Myndware</a></li>
         </ul>
     </dd>
     

package/docs/Register.html

@@ -776,7 +776,7 @@
     <dt class="tag-author">Author:</dt>
     <dd class="tag-author">
         <ul>
-            <li><a href="mailto:abernardo.br@gmail.com">CloudBrasil</a></li>
+            <li><a href="mailto:augusto.pissarra@myndware.com">Myndware</a></li>
         </ul>
     </dd>
     
@@ -1054,7 +1054,7 @@ const retData = await api.user.register.execute(params);</code></pre>
     <dt class="tag-author">Author:</dt>
     <dd class="tag-author">
         <ul>
-            <li><a href="mailto:abernardo.br@gmail.com">CloudBrasil</a></li>
+            <li><a href="mailto:augusto.pissarra@myndware.com">Myndware</a></li>
         </ul>
     </dd>
     
@@ -1299,7 +1299,7 @@ const orgname = await api.user.register.getOrgname(params);</code></pre>
     <dt class="tag-author">Author:</dt>
     <dd class="tag-author">
         <ul>
-            <li><a href="mailto:abernardo.br@gmail.com">CloudBrasil</a></li>
+            <li><a href="mailto:augusto.pissarra@myndware.com">Myndware</a></li>
         </ul>
     </dd>
     

package/docs/Settings.html

@@ -331,7 +331,7 @@
     <dt class="tag-author">Author:</dt>
     <dd class="tag-author">
         <ul>
-            <li><a href="mailto:abernardo.br@gmail.com">CloudBrasil</a></li>
+            <li><a href="mailto:augusto.pissarra@myndware.com">Myndware</a></li>
         </ul>
     </dd>
     
@@ -523,7 +523,7 @@ ret settings = await api.user.settings.get(session);</code></pre>
     <dt class="tag-author">Author:</dt>
     <dd class="tag-author">
         <ul>
-            <li><a href="mailto:abernardo.br@gmail.com">CloudBrasil</a></li>
+            <li><a href="mailto:augusto.pissarra@myndware.com">Myndware</a></li>
         </ul>
     </dd>
     
@@ -740,7 +740,7 @@ await api.user.settings.remove(session);</code></pre>
     <dt class="tag-author">Author:</dt>
     <dd class="tag-author">
         <ul>
-            <li><a href="mailto:abernardo.br@gmail.com">CloudBrasil</a></li>
+            <li><a href="mailto:augusto.pissarra@myndware.com">Myndware</a></li>
         </ul>
     </dd>
     

package/docs/Task.html

@@ -479,7 +479,7 @@
     <dt class="tag-author">Author:</dt>
     <dd class="tag-author">
         <ul>
-            <li><a href="mailto:abernardo.br@gmail.com">CloudBrasil</a></li>
+            <li><a href="mailto:augusto.pissarra@myndware.com">Myndware</a></li>
         </ul>
     </dd>
     
@@ -774,7 +774,7 @@ await api.user.task.executeActionFinalize(params, session);</code></pre>
     <dt class="tag-author">Author:</dt>
     <dd class="tag-author">
         <ul>
-            <li><a href="mailto:abernardo.br@gmail.com">CloudBrasil</a></li>
+            <li><a href="mailto:augusto.pissarra@myndware.com">Myndware</a></li>
         </ul>
     </dd>
     
@@ -1267,7 +1267,7 @@ await api.user.task.findById(params, session);</code></pre>
     <dt class="tag-author">Author:</dt>
     <dd class="tag-author">
         <ul>
-            <li><a href="mailto:abernardo.br@gmail.com">CloudBrasil</a></li>
+            <li><a href="mailto:augusto.pissarra@myndware.com">Myndware</a></li>
         </ul>
     </dd>
     
@@ -1353,6 +1353,290 @@ await api.user.task.findByIdAndUpdate(params, session);</code></pre>
     
 
 
+</div>
+            
+                <div class="member">
+
+
+    
+    <h4 class="name" id="getSummaryByTags">
+        <a class="href-link" href="#getSummaryByTags">#</a>
+        
+            
+                <span class='tag'>async</span>
+            
+        
+        <span class="code-name">
+            
+                getSummaryByTags<span class="signature">(params, session)</span><span class="type-signature"> &rarr; {Promise.&lt;object>|Promise.&lt;object>|Promise.&lt;object>}</span>
+            
+        </span>
+    </h4>
+    
+
+    
+    
+    <div class="description">
+        Get the tasks and available tasks summary (totals) for specific tags
+    </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 update task</td>
+</tr>
+
+  
+  
+    
+<tr class="deep-level-1">
+  
+      <td class="name"><code>tags</code></td>
+  
+
+  <td class="type">
+  
+      
+<code class="param-type">array.&lt;string></code>
+
+
+  
+  </td>
+
+  
+
+  
+
+  <td class="description last">The tags to get task summaries</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_task.js.html" class="button">View Source</a>
+            <span>
+                <a href="user_task.js.html">user/task.js</a>, <a href="user_task.js.html#line224">line 224</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</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'>data.tasks - the total tasks</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'>data.availableTasks - the total available tasks</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 = {
+ tags: ['INCIDENTS']
+};
+const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
+await api.user.task.getSummaryByTags(params, session);</code></pre>
+    
+
+
 </div>
             
             </div>

package/docs/TaskAvailable.html

@@ -405,7 +405,7 @@
     <dt class="tag-author">Author:</dt>
     <dd class="tag-author">
         <ul>
-            <li><a href="mailto:abernardo.br@gmail.com">CloudBrasil</a></li>
+            <li><a href="mailto:augusto.pissarra@myndware.com">Myndware</a></li>
         </ul>
     </dd>
     
@@ -695,7 +695,7 @@ const success = await api.user.task.available.claim(params, session);</code></pr
     <dt class="tag-author">Author:</dt>
     <dd class="tag-author">
         <ul>
-            <li><a href="mailto:abernardo.br@gmail.com">CloudBrasil</a></li>
+            <li><a href="mailto:augusto.pissarra@myndware.com">Myndware</a></li>
         </ul>
     </dd>
     

package/docs/User.html

@@ -356,7 +356,7 @@
     <dt class="tag-author">Author:</dt>
     <dd class="tag-author">
         <ul>
-            <li><a href="mailto:abernardo.br@gmail.com">CloudBrasil</a></li>
+            <li><a href="mailto:augusto.pissarra@myndware.com">Myndware</a></li>
         </ul>
     </dd>
     
@@ -945,7 +945,7 @@ await api.user.changeOrganization.updateAvatar(id, session);</code></pre>
     <dt class="tag-author">Author:</dt>
     <dd class="tag-author">
         <ul>
-            <li><a href="mailto:abernardo.br@gmail.com">CloudBrasil</a></li>
+            <li><a href="mailto:augusto.pissarra@myndware.com">Myndware</a></li>
         </ul>
     </dd>
     
@@ -1140,7 +1140,7 @@ await api.user.profile.findByIdAndUpdate(params, session);</code></pre>
     <dt class="tag-author">Author:</dt>
     <dd class="tag-author">
         <ul>
-            <li><a href="mailto:abernardo.br@gmail.com">CloudBrasil</a></li>
+            <li><a href="mailto:augusto.pissarra@myndware.com">Myndware</a></li>
         </ul>
     </dd>
     
@@ -1332,7 +1332,7 @@ await api.user.profile.removeAvatar(session);</code></pre>
     <dt class="tag-author">Author:</dt>
     <dd class="tag-author">
         <ul>
-            <li><a href="mailto:abernardo.br@gmail.com">CloudBrasil</a></li>
+            <li><a href="mailto:augusto.pissarra@myndware.com">Myndware</a></li>
         </ul>
     </dd>
     
@@ -1599,7 +1599,7 @@ await api.user.profile.removeSignature(session);</code></pre>
     <dt class="tag-author">Author:</dt>
     <dd class="tag-author">
         <ul>
-            <li><a href="mailto:abernardo.br@gmail.com">CloudBrasil</a></li>
+            <li><a href="mailto:augusto.pissarra@myndware.com">Myndware</a></li>
         </ul>
     </dd>
     
@@ -1878,7 +1878,7 @@ await api.user.profile.saveSignature(session);</code></pre>
     <dt class="tag-author">Author:</dt>
     <dd class="tag-author">
         <ul>
-            <li><a href="mailto:abernardo.br@gmail.com">CloudBrasil</a></li>
+            <li><a href="mailto:augusto.pissarra@myndware.com">Myndware</a></li>
         </ul>
     </dd>
     

package/docs/Users.html

@@ -231,7 +231,7 @@
     <dt class="tag-author">Author:</dt>
     <dd class="tag-author">
         <ul>
-            <li><a href="mailto:abernardo.br@gmail.com">CloudBrasil</a></li>
+            <li><a href="mailto:augusto.pissarra@myndware.com">Myndware</a></li>
         </ul>
     </dd>
     
@@ -464,7 +464,7 @@
     <dt class="tag-author">Author:</dt>
     <dd class="tag-author">
         <ul>
-            <li><a href="mailto:abernardo.br@gmail.com">CloudBrasil</a></li>
+            <li><a href="mailto:augusto.pissarra@myndware.com">Myndware</a></li>
         </ul>
     </dd>
     

package/docs/admin_doctypes.js.html

@@ -100,7 +100,7 @@ class AdminDocTypes {
     }
 
     /**
-     * @author CloudBrasil <abernardo.br@gmail.com>
+     * @author Myndware <augusto.pissarra@myndware.com>
      * @description Get the return data and check for errors
      * @param {object} retData Response HTTP
      * @return {*}
@@ -115,7 +115,7 @@ class AdminDocTypes {
     }
 
     /**
-     * @author CloudBrasil <abernardo.br@gmail.com>
+     * @author Myndware <augusto.pissarra@myndware.com>
      * @description Set header with new session
      * @param {string} session Session, token JWT
      * @return {object} header with new session
@@ -130,7 +130,7 @@ class AdminDocTypes {
     }
 
     /**
-     * @author CloudBrasil <abernardo.br@gmail.com>
+     * @author Myndware <augusto.pissarra@myndware.com>
      * @description Request profile by userId
      * @param {object} params The params
      * @param {string} params.id The organization document type id (_id database)

package/docs/admin_document.js.html

@@ -120,7 +120,7 @@ class AdminDocuments {
   }
 
   /**
-   * @author CloudBrasil <abernardo.br@gmail.com>
+   * @author Myndware <augusto.pissarra@myndware.com>
    * @description Set header with new session
    * @param {string} session Session, token JWT
    * @return {object} header with new session
@@ -135,7 +135,7 @@ class AdminDocuments {
   }
 
   /**
-   * @author CloudBrasil <abernardo.br@gmail.com>
+   * @author Myndware <augusto.pissarra@myndware.com>
    * @description Advanced search of document in elastic search ussing system manager
    * @param {!object} params - Params to search document
    * @param {!string} params.docId - Document id (_id database)
@@ -194,7 +194,7 @@ class AdminDocuments {
   }
 
   /**
-   * @author CloudBrasil <abernardo.br@gmail.com>
+   * @author Myndware <augusto.pissarra@myndware.com>
    * @description Get document by id
    * @param {object} params - Params to get document by id
    * @param {string} params.docId - Document id (_id database)
@@ -233,7 +233,7 @@ class AdminDocuments {
 
   /**
    *
-   * @author CloudBrasil <abernardo.br@gmail.com>
+   * @author Myndware <augusto.pissarra@myndware.com>
    * @description Request signed url url to put or get
    * @param {object} params Params to request signed url
    * @param {string} params.methodType Method type HTTP get or put
@@ -287,7 +287,7 @@ class AdminDocuments {
 
   /**
    *
-   * @author CloudBrasil <abernardo.br@gmail.com>
+   * @author Myndware <augusto.pissarra@myndware.com>
    * @description Update a document content
    * @param {object} params Params to request signed url
    * @param {string} params.content The content text
@@ -328,7 +328,7 @@ class AdminDocuments {
 
   /**
    *
-   * @author CloudBrasil <abernardo.br@gmail.com>
+   * @author Myndware <augusto.pissarra@myndware.com>
    * @description Update a document content
    * @param {object} params Params to request signed url
    * @param {string} params.content The content text
@@ -374,7 +374,7 @@ class AdminDocuments {
 
   /**
    *
-   * @author CloudBrasil <abernardo.br@gmail.com>
+   * @author Myndware <augusto.pissarra@myndware.com>
    * @description Get the content of a document
    * @param {object} params Params to request signed url
    * @param {string} params.docId The unique id of the document

package/docs/admin_form.js.html

@@ -120,7 +120,7 @@ class AdminForm {
   }
 
   /**
-   * @author CloudBrasil <abernardo.br@gmail.com>
+   * @author Myndware <augusto.pissarra@myndware.com>
    * @description Set header with new session
    * @param {string} session Session, token JWT
    * @return {object} header with new session
@@ -135,7 +135,7 @@ class AdminForm {
   }
 
   /**
-   * @author CloudBrasil <abernardo.br@gmail.com>
+   * @author Myndware <augusto.pissarra@myndware.com>
    * @description Get advance form by ID
    * @param {object} params Params to find form by id
    * @param {string} params.id Formulary Id (_id database)
@@ -173,7 +173,7 @@ class AdminForm {
   }
 
    /**
-   * @author CloudBrasil <abernardo.br@gmail.com>
+   * @author Myndware <augusto.pissarra@myndware.com>
    * @description Request signed url url to put or get
    * @param {object} params - Params to get form list
    * @param {string} params.orgId - Organization id (_id database)

package/docs/admin_index.js.html

@@ -105,7 +105,7 @@ import AdminOrganizations from './organization.js';
  */
 class Admin {
   /**
-   * @author CloudBrasil <abernardo.br@gmail.com>
+   * @author Myndware <augusto.pissarra@myndware.com>
    * @constructor
    * @param {object} options Params of the constructor
    * @param {object} options.parent This of the pararent