@docbrasil/api-systemmanager 1.1.22 → 1.1.23

package/doc/api.md

@@ -330,9 +330,29 @@ Admin Class for forms, permission admin
 **Kind**: global class  
 
 * [AdminForm](#AdminForm)
+    * [.types](#AdminForm+types) ⇒ <code>Promise</code>
     * [.findById(params, session)](#AdminForm+findById) ⇒ <code>Promise</code>
     * [.getFormList(params, session)](#AdminForm+getFormList) ⇒ <code>Promise</code>
 
+<a name="AdminForm+types"></a>
+
+### adminForm.types ⇒ <code>Promise</code>
+Get the types for forms
+
+**Kind**: instance property of [<code>AdminForm</code>](#AdminForm)  
+**Access**: public  
+**Author**: Myndware <augusto.pissarra@myndware.com>  
+**Example**  
+```js
+const API = require('@docbrasil/api-systemmanager');
+const api = new API();
+const params = {
+ id: '55e4a3bd6be6b45210833fae',
+ orgId: '5edd11c46b6ce9729c2c297c',
+};
+const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
+await api.admin.form.findById(params, session);
+```
 <a name="AdminForm+findById"></a>
 
 ### adminForm.findById(params, session) ⇒ <code>Promise</code>
@@ -1085,6 +1105,7 @@ Admin Class for user, permission admin
     * [.findByIdAndUpdate(userId, payload, session)](#AdminUser+findByIdAndUpdate) ⇒ <code>Promise.&lt;\*&gt;</code>
     * [.getChangePasswordGuid(email)](#AdminUser+getChangePasswordGuid) ⇒ <code>Promise.&lt;\*&gt;</code>
     * [.changePasswordGuid(Payload)](#AdminUser+changePasswordGuid) ⇒ <code>Promise.&lt;\*&gt;</code>
+    * [.getUserList(params, session)](#AdminUser+getUserList) ⇒ <code>Promise</code>
 
 <a name="AdminUser+findById"></a>
 
@@ -1245,6 +1266,34 @@ const payload = {
 };
 const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
 ```
+<a name="AdminUser+getUserList"></a>
+
+### adminUser.getUserList(params, session) ⇒ <code>Promise</code>
+Request signed url url to put or get
+
+**Kind**: instance method of [<code>AdminUser</code>](#AdminUser)  
+**Access**: public  
+**Author**: Myndware <augusto.pissarra@myndware.com>  
+
+| Param | Type | Default | Description |
+| --- | --- | --- | --- |
+| params | <code>object</code> |  | Params to get form list |
+| params.page | <code>number</code> | <code>1</code> | Page of pagination |
+| params.perPage | <code>number</code> | <code>200</code> | Items per page |
+| params.project | <code>object</code> | <code>{_id:</code> | 1, name: 1} - Fields to project |
+| params.sort | <code>object</code> | <code>{name:</code> | 1} - Sort fields |
+| session | <code>string</code> |  | Session, token JWT |
+
+**Example**  
+```js
+const API = require('@docbrasil/api-systemmanager');
+const api = new API();
+const params - {
+ project: {_id: 1, name: 1, orgId: 1, orgIds: 1},
+};
+const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
+await api.user.form.getUserList(params, session);
+```
 <a name="GeoLocation"></a>
 
 ## GeoLocation
@@ -3432,7 +3481,6 @@ Get the Atlas Chart JWT Token, so we can access authorized the created charts
 | query | <code>object</code> | <code>{}</code> | The query, if any, to add to the JWT token |
 | query.orgIds | <code>array.&lt;string&gt;</code> |  | An array of orgIds that we want to filter by |
 | query.orgProcessIds | <code>array.&lt;string&gt;</code> |  | An array of orgProcessId that we want to filter by |
-| query.tags | <code>array.&lt;string&gt;</code> |  | An array of org processes tags that we want to filter by |
 | query.startDate | <code>date</code> |  | The start date in ISO format that we want to filter by |
 | query.endDate | <code>date</code> |  | The start date in ISO format that we want to filter by |
 | session | <code>string</code> |  | Is token JWT of user NOT allow SU |

package/docs/AdminForm.html

@@ -214,6 +214,107 @@
     
 
     
+        <div class='vertical-section'>
+            <h1>Members</h1>
+            <div class="members">
+            
+                <div class="member">
+
+<h4 class="name" id="types">
+    <a class="href-link" href="#types">#</a>
+    
+        
+            <span class='tag'>async</span>
+        
+    
+    <span class="code-name">
+        types
+    </span>
+    
+</h4>
+
+
+
+
+<div class="description">
+    Get the types for forms
+</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_form.js.html" class="button">View Source</a>
+            <span>
+                <a href="admin_form.js.html">admin/form.js</a>, <a href="admin_form.js.html#line67">line 67</a>
+            </span>
+        </p>
+    
+</dl>
+
+
+
+
+
+    <h5>Example</h5>
+    
+    
+        <pre class="prettyprint"><code>const API = require('@docbrasil/api-systemmanager');
+const api = new API();
+const params = {
+ id: '55e4a3bd6be6b45210833fae',
+ orgId: '5edd11c46b6ce9729c2c297c',
+};
+const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
+await api.admin.form.findById(params, session);</code></pre>
+    
+
+
+</div>
+            
+            </div>
+        </div>
+    
 
     
         <div class='vertical-section'>
@@ -425,7 +526,7 @@
         <p class="tag-source">
             <a href="admin_form.js.html" class="button">View Source</a>
             <span>
-                <a href="admin_form.js.html">admin/form.js</a>, <a href="admin_form.js.html#line71">line 71</a>
+                <a href="admin_form.js.html">admin/form.js</a>, <a href="admin_form.js.html#line97">line 97</a>
             </span>
         </p>
     
@@ -831,7 +932,7 @@ await api.admin.form.findById(params, session);</code></pre>
         <p class="tag-source">
             <a href="admin_form.js.html" class="button">View Source</a>
             <span>
-                <a href="admin_form.js.html">admin/form.js</a>, <a href="admin_form.js.html#line112">line 112</a>
+                <a href="admin_form.js.html">admin/form.js</a>, <a href="admin_form.js.html#line138">line 138</a>
             </span>
         </p>
     

package/docs/AdminUser.html

@@ -1800,6 +1800,355 @@ const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';</code></pre>
     
 
 
+</div>
+            
+                <div class="member">
+
+
+    
+    <h4 class="name" id="getUserList">
+        <a class="href-link" href="#getUserList">#</a>
+        
+            
+                <span class='tag'>async</span>
+            
+        
+        <span class="code-name">
+            
+                getUserList<span class="signature">(params, session)</span><span class="type-signature"> &rarr; {Promise}</span>
+            
+        </span>
+    </h4>
+    
+
+    
+    
+    <div class="description">
+        Request signed url url to put or get
+    </div>
+    
+
+
+
+
+
+
+
+
+
+    <h5>Parameters:</h5>
+    
+<div class="table-container">
+    <table class="params table">
+        <thead>
+        <tr>
+            
+            <th>Name</th>
+            
+
+            <th>Type</th>
+
+            
+
+            
+            <th>Default</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="default">
+      
+      </td>
+  
+
+  <td class="description last">Params to get form list</td>
+</tr>
+
+  
+  
+    
+<tr class="deep-level-1">
+  
+      <td class="name"><code>page</code></td>
+  
+
+  <td class="type">
+  
+      
+<code class="param-type">number</code>
+
+
+  
+  </td>
+
+  
+
+  
+      <td class="default">
+      
+          1
+      
+      </td>
+  
+
+  <td class="description last">Page of pagination</td>
+</tr>
+
+  
+    
+<tr class="deep-level-1">
+  
+      <td class="name"><code>perPage</code></td>
+  
+
+  <td class="type">
+  
+      
+<code class="param-type">number</code>
+
+
+  
+  </td>
+
+  
+
+  
+      <td class="default">
+      
+          200
+      
+      </td>
+  
+
+  <td class="description last">Items per page</td>
+</tr>
+
+  
+    
+<tr class="deep-level-1">
+  
+      <td class="name"><code>project</code></td>
+  
+
+  <td class="type">
+  
+      
+<code class="param-type">object</code>
+
+
+  
+  </td>
+
+  
+
+  
+      <td class="default">
+      
+          {_id:
+      
+      </td>
+  
+
+  <td class="description last">1, name: 1} - Fields to project</td>
+</tr>
+
+  
+    
+<tr class="deep-level-1">
+  
+      <td class="name"><code>sort</code></td>
+  
+
+  <td class="type">
+  
+      
+<code class="param-type">object</code>
+
+
+  
+  </td>
+
+  
+
+  
+      <td class="default">
+      
+          {name:
+      
+      </td>
+  
+
+  <td class="description last">1} - Sort fields</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="default">
+      
+      </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="admin_user.js.html" class="button">View Source</a>
+            <span>
+                <a href="admin_user.js.html">admin/user.js</a>, <a href="admin_user.js.html#line298">line 298</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 - {
+ project: {_id: 1, name: 1, orgId: 1, orgIds: 1},
+};
+const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
+await api.user.form.getUserList(params, session);</code></pre>
+    
+
+
 </div>
             
             </div>

package/docs/User.html

@@ -1173,33 +1173,6 @@ await api.user.profile.findByIdAndUpdate(params, session);</code></pre>
 
   
     
-<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="default">
-      
-      </td>
-  
-
-  <td class="description last">An array of org processes tags that we want to filter by</td>
-</tr>
-
-  
-    
 <tr class="deep-level-1">
   
       <td class="name"><code>startDate</code></td>
@@ -1335,7 +1308,7 @@ await api.user.profile.findByIdAndUpdate(params, session);</code></pre>
         <p class="tag-source">
             <a href="user_user.js.html" class="button">View Source</a>
             <span>
-                <a href="user_user.js.html">user/user.js</a>, <a href="user_user.js.html#line307">line 307</a>
+                <a href="user_user.js.html">user/user.js</a>, <a href="user_user.js.html#line306">line 306</a>
             </span>
         </p>
     
@@ -1530,7 +1503,7 @@ const jwtToken = await api.user.getChartJWT(query, session);</code></pre>
         <p class="tag-source">
             <a href="user_user.js.html" class="button">View Source</a>
             <span>
-                <a href="user_user.js.html">user/user.js</a>, <a href="user_user.js.html#line338">line 338</a>
+                <a href="user_user.js.html">user/user.js</a>, <a href="user_user.js.html#line337">line 337</a>
             </span>
         </p>
     
@@ -1813,7 +1786,7 @@ const organizations = await api.user.getChartOrganizations(session);</code></pre
         <p class="tag-source">
             <a href="user_user.js.html" class="button">View Source</a>
             <span>
-                <a href="user_user.js.html">user/user.js</a>, <a href="user_user.js.html#line370">line 370</a>
+                <a href="user_user.js.html">user/user.js</a>, <a href="user_user.js.html#line369">line 369</a>
             </span>
         </p>
     

package/docs/admin_form.js.html

@@ -134,6 +134,32 @@ class AdminForm {
     };
   }
 
+   /**
+   * @author Myndware <augusto.pissarra@myndware.com>
+   * @description Get the types for forms
+   * @return {Promise}
+   * @public
+   * @async
+   * @example
+   *
+   * const API = require('@docbrasil/api-systemmanager');
+   * const api = new API();
+   * const params = {
+   *  id: '55e4a3bd6be6b45210833fae',
+   *  orgId: '5edd11c46b6ce9729c2c297c',
+   * };
+   * const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
+   * await api.admin.form.findById(params, session);
+   */
+   get types() {
+    return {
+       BUSINESS: 1,
+       ADVANCED: 2,
+       CHECKLIST: 3,
+       EXTERNAL: 4
+    };
+   }
+
   /**
    * @author Myndware <augusto.pissarra@myndware.com>
    * @description Get advance form by ID
@@ -209,7 +235,6 @@ class AdminForm {
       Joi.assert(params.sort, Joi.object(), 'Sort fields for');
       Joi.assert(session, Joi.string().required(), 'Session, token JWT');
 
-      const FORM_ADVANCED = 2;
       const PROJECTION_DEFAULT = {_id: 1, name: 1};
       const SORT_DEFAULT = {name: 1};
 
@@ -217,7 +242,7 @@ class AdminForm {
         orgId,
         page = 1,
         perPage = 200,
-        type = FORM_ADVANCED,
+        type = self.types.ADVANCED,
         project = PROJECTION_DEFAULT,
         sort = SORT_DEFAULT
       } = params;