@docbrasil/api-systemmanager 1.1.29 → 1.1.30

package/doc/api.md

@@ -1367,6 +1367,11 @@ API request, user permission level
 Class for Applications, permission user
 
 **Kind**: global class  
+
+* [Application](#Application)
+    * [.list(params, session)](#Application+list) ⇒ <code>promise</code>
+    * [.changeApplication(params, session)](#Application+changeApplication) ⇒ <code>promise</code>
+
 <a name="Application+list"></a>
 
 ### application.list(params, session) ⇒ <code>promise</code>
@@ -1392,6 +1397,31 @@ const params = {
 const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
 await api.user.application.list(params, session);
 ```
+<a name="Application+changeApplication"></a>
+
+### application.changeApplication(params, session) ⇒ <code>promise</code>
+Changes the application for a user in an organization
+
+**Kind**: instance method of [<code>Application</code>](#Application)  
+**Access**: public  
+**Author**: Myndware <augusto.pissarra@myndware.com>  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| params | <code>object</code> | Params to get task |
+| params.applicationId | <code>object</code> | The application id to change to |
+| session | <code>string</code> | Session, token JWT |
+
+**Example**  
+```js
+const API = require('@docbrasil/api-systemmanager');
+const api = new API();
+const params = {
+ applicationId: '55e4a3bd6be6b45210833fae',
+};
+const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
+await api.user.application.changeApplication(params, session);
+```
 <a name="Chart"></a>
 
 ## Chart
@@ -2463,6 +2493,7 @@ Class for user registration in a user
     * [.getNew(session)](#Notification+getNew)
     * [.getOld(session)](#Notification+getOld)
     * [.setRead(params, session)](#Notification+setRead) ⇒ <code>Promise</code>
+    * [.setReadAll(session)](#Notification+setReadAll) ⇒ <code>Promise</code>
     * [.setUnread(params, session)](#Notification+setUnread) ⇒ <code>Promise</code>
 
 <a name="Notification+tokenTypes"></a>
@@ -2542,7 +2573,7 @@ await api.user.notification.getOld(session);
 <a name="Notification+setRead"></a>
 
 ### notification.setRead(params, session) ⇒ <code>Promise</code>
-Set notification as readed
+Set notification as read
 
 **Kind**: instance method of [<code>Notification</code>](#Notification)  
 **Access**: public  
@@ -2564,6 +2595,26 @@ const params = {
 const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
 await api.user.notification.setRead(params, session);
 ```
+<a name="Notification+setReadAll"></a>
+
+### notification.setReadAll(session) ⇒ <code>Promise</code>
+Set all notification of the logged user as read
+
+**Kind**: instance method of [<code>Notification</code>](#Notification)  
+**Access**: public  
+**Author**: Myndware <augusto.pissarra@myndware.com>  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| session | <code>string</code> | JWT Token |
+
+**Example**  
+```js
+const API = require('@docbrasil/api-systemmanager');
+const api = new API();
+const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
+await api.user.notification.setReadAll(session);
+```
 <a name="Notification+setUnread"></a>
 
 ### notification.setUnread(params, session) ⇒ <code>Promise</code>

package/docs/Application.html

@@ -224,6 +224,252 @@
 
 
     
+    <h4 class="name" id="changeApplication">
+        <a class="href-link" href="#changeApplication">#</a>
+        
+            
+                <span class='tag'>async</span>
+            
+        
+        <span class="code-name">
+            
+                changeApplication<span class="signature">(params, session)</span><span class="type-signature"> &rarr; {promise}</span>
+            
+        </span>
+    </h4>
+    
+
+    
+    
+    <div class="description">
+        Changes the application for a user in an organization
+    </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 task</td>
+</tr>
+
+  
+  
+    
+<tr class="deep-level-1">
+  
+      <td class="name"><code>applicationId</code></td>
+  
+
+  <td class="type">
+  
+      
+<code class="param-type">object</code>
+
+
+  
+  </td>
+
+  
+
+  
+
+  <td class="description last">The application id to change to</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_application.js.html" class="button">View Source</a>
+            <span>
+                <a href="user_application.js.html">user/application.js</a>, <a href="user_application.js.html#line106">line 106</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 = {
+ applicationId: '55e4a3bd6be6b45210833fae',
+};
+const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
+await api.user.application.changeApplication(params, session);</code></pre>
+    
+
+
+</div>
+            
+                <div class="member">
+
+
+    
     <h4 class="name" id="list">
         <a class="href-link" href="#list">#</a>
         

package/docs/Notification.html

@@ -946,7 +946,7 @@ await api.user.notification.getOld(session);</code></pre>
     
     
     <div class="description">
-        Set notification as readed
+        Set notification as read
     </div>
     
 
@@ -1168,6 +1168,198 @@ await api.user.notification.setRead(params, session);</code></pre>
     
 
 
+</div>
+            
+                <div class="member">
+
+
+    
+    <h4 class="name" id="setReadAll">
+        <a class="href-link" href="#setReadAll">#</a>
+        
+            
+                <span class='tag'>async</span>
+            
+        
+        <span class="code-name">
+            
+                setReadAll<span class="signature">(session)</span><span class="type-signature"> &rarr; {Promise}</span>
+            
+        </span>
+    </h4>
+    
+
+    
+    
+    <div class="description">
+        Set all notification of the logged user as read
+    </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>session</code></td>
+  
+
+  <td class="type">
+  
+      
+<code class="param-type">string</code>
+
+
+  
+  </td>
+
+  
+
+  
+
+  <td class="description last">JWT Token</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_notification.js.html" class="button">View Source</a>
+            <span>
+                <a href="user_notification.js.html">user/notification.js</a>, <a href="user_notification.js.html#line202">line 202</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 session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
+await api.user.notification.setReadAll(session);</code></pre>
+    
+
+
 </div>
             
                 <div class="member">
@@ -1352,7 +1544,7 @@ await api.user.notification.setRead(params, session);</code></pre>
         <p class="tag-source">
             <a href="user_notification.js.html" class="button">View Source</a>
             <span>
-                <a href="user_notification.js.html">user/notification.js</a>, <a href="user_notification.js.html#line207">line 207</a>
+                <a href="user_notification.js.html">user/notification.js</a>, <a href="user_notification.js.html#line238">line 238</a>
             </span>
         </p>
     

package/docs/user_application.js.html

@@ -171,6 +171,42 @@ class Application {
       throw ex;
     }
   }
+
+  /**
+   * @author Myndware <augusto.pissarra@myndware.com>
+   * @description Changes the application for a user in an organization
+   * @param {object} params Params to get task
+   * @param {object} params.applicationId The application id to change to
+   * @param {string} session Session, token JWT
+   * @returns {promise}
+   * @public
+   * @example
+   *
+   * const API = require('@docbrasil/api-systemmanager');
+   * const api = new API();
+   * const params = {
+   *  applicationId: '55e4a3bd6be6b45210833fae',
+   * };
+   * const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
+   * await api.user.application.changeApplication(params, session);
+   */
+  async changeApplication(params, session) {
+    const self = this;
+
+    try {
+      Joi.assert(params, Joi.object().required(), 'Params to get task');
+      Joi.assert(params.applicationId, Joi.string().required(), 'The application id');
+      Joi.assert(session, Joi.string().required(), 'Session token JWT');
+
+      const { orgId} = params;
+      const apiCall = self._client
+          .put('/organizations/applications/change', { applicationId: params.applicationId  }, self._setHeader(session));
+
+      return self._returnData(await apiCall);
+    } catch (ex) {
+      throw ex;
+    }
+  }
 }
 
 export default Application;

package/docs/user_notification.js.html

@@ -238,7 +238,7 @@ class Notification {
 
    /**
    * @author Myndware <augusto.pissarra@myndware.com>
-   * @description Set notification as readed
+   * @description Set notification as read
    * @param {object} params Params to update the notification
    * @param {string} params.id Notification Id
    * @param {string} session JWT Token
@@ -257,14 +257,14 @@ class Notification {
    */
     async setRead(params = {}, session) {
       const self = this;
-  
+
       try {
         Joi.assert(params, Joi.object().required());
         Joi.assert(params.id, Joi.string().required());
         Joi.assert(session, Joi.string().required());
-  
+
         const {id} = params;
-  
+
         const apiCall = self._client.put(`/organizations/notifications/${id}/read`, {}, self._setHeader(session));
         return self._returnData(await apiCall);
       } catch (ex) {
@@ -272,6 +272,37 @@ class Notification {
       }
     }
 
+  /**
+   * @author Myndware <augusto.pissarra@myndware.com>
+   * @description Set all notification of the logged user as read
+   * @param {string} session JWT Token
+   * @return {Promise}
+   * @public
+   * @async
+   * @example
+   *
+   * const API = require('@docbrasil/api-systemmanager');
+   * const api = new API();
+   * const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
+   * await api.user.notification.setReadAll(session);
+   */
+  async setReadAll(session) {
+    const self = this;
+
+    try {
+      Joi.assert(params, Joi.object().required());
+      Joi.assert(params.id, Joi.string().required());
+      Joi.assert(session, Joi.string().required());
+
+      const {id} = params;
+
+      const apiCall = self._client.put(`/organizations/notifications/read/all`, {}, self._setHeader(session));
+      return self._returnData(await apiCall);
+    } catch (ex) {
+      throw ex;
+    }
+  }
+
     /**
    * @author Myndware <augusto.pissarra@myndware.com>
    * @description Set notification as unreaded
@@ -293,14 +324,14 @@ class Notification {
    */
     async setUnread(params = {}, session) {
       const self = this;
-  
+
       try {
         Joi.assert(params, Joi.object().required());
         Joi.assert(params.id, Joi.string().required());
         Joi.assert(session, Joi.string().required());
-  
+
         const {id} = params;
-  
+
         const apiCall = self._client.put(`/organizations/notifications/${id}/unread`, {}, self._setHeader(session));
         return self._returnData(await apiCall);
       } catch (ex) {

package/package.json

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