@docbrasil/api-systemmanager 1.1.31 → 1.1.32

package/doc/api.md

@@ -2493,6 +2493,7 @@ Class for user registration in a user
 * [Notification](#Notification)
     * [.tokenTypes](#Notification+tokenTypes) ⇒ <code>Object</code>
     * [.addToken(params, session)](#Notification+addToken) ⇒ <code>promise.&lt;object&gt;</code> \| <code>boolean</code>
+    * [.removeToken(params, session)](#Notification+removeToken) ⇒ <code>promise.&lt;object&gt;</code> \| <code>boolean</code>
     * [.getNew(session)](#Notification+getNew)
     * [.getOld(session)](#Notification+getOld)
     * [.setRead(params, session)](#Notification+setRead) ⇒ <code>Promise</code>
@@ -2518,8 +2519,10 @@ Method to add a notification token
 | Param | Type | Description |
 | --- | --- | --- |
 | params | <code>object</code> | Params to add notification token |
-| params.token | <code>string</code> | The token |
-| params.type | <code>object</code> | The token type |
+| params.token | <code>obhect</code> | The token |
+| params.token.value | <code>object</code> | The token value |
+| params.token.type | <code>object</code> | The token type |
+| params.token.data | <code>object</code> | The extra data of a token, if there is. |
 | session | <code>string</code> | Is token JWT of user NOT allow SU |
 
 **Example**  
@@ -2528,11 +2531,39 @@ const API = require('@docbrasil/api-systemmanager');
 const api = new API();
 const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
 const params = {
- token: 'V6OSBr4aEVoiE9H1b4xzLe+vqmXB+ShVNc/FvJGxnIz4tZv6jBJkk4aQzz2',
- type: 'FCM_WEB'
+ token: {
+   value: 'V6OSBr4aEVoiE9H1b4xzLe+vqmXB+ShVNc/FvJGxnIz4tZv6jBJkk4aQzz2',
+   type: 'FCM_CAPACITOR'
+   }
 };
 const retData = await api.user.notification.addToken(params, session);
 ```
+<a name="Notification+removeToken"></a>
+
+### notification.removeToken(params, session) ⇒ <code>promise.&lt;object&gt;</code> \| <code>boolean</code>
+Method to remove a notification token
+
+**Kind**: instance method of [<code>Notification</code>](#Notification)  
+**Returns**: <code>promise.&lt;object&gt;</code> - data<code>boolean</code> - data._id the id of the added token  
+**Access**: public  
+**Author**: Myndware <augusto.pissarra@myndware.com>  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| params | <code>object</code> | Params to add notification token |
+| params.token | <code>obhect</code> | The token value |
+| session | <code>string</code> | Is token JWT of user NOT allow SU |
+
+**Example**  
+```js
+const API = require('@docbrasil/api-systemmanager');
+const api = new API();
+const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
+const params = {
+ token:'V6OSBr4aEVoiE9H1b4xzLe+vqmXB+ShVNc/FvJGxnIz4tZv6jBJkk4aQzz2'
+};
+const retData = await api.user.notification.removeToken(params, session);
+```
 <a name="Notification+getNew"></a>
 
 ### notification.getNew(session)

package/docs/Dispatch.html

@@ -300,7 +300,7 @@
         <p class="tag-source">
             <a href="dispatch.js.html" class="button">View Source</a>
             <span>
-                <a href="dispatch.js.html">dispatch.js</a>, <a href="dispatch.js.html#line96">line 96</a>
+                <a href="dispatch.js.html">dispatch.js</a>, <a href="dispatch.js.html#line91">line 91</a>
             </span>
         </p>
     
@@ -523,7 +523,7 @@ await api.dispatch.getClient();</code></pre>
         <p class="tag-source">
             <a href="dispatch.js.html" class="button">View Source</a>
             <span>
-                <a href="dispatch.js.html">dispatch.js</a>, <a href="dispatch.js.html#line69">line 69</a>
+                <a href="dispatch.js.html">dispatch.js</a>, <a href="dispatch.js.html#line64">line 64</a>
             </span>
         </p>
     

package/docs/Notification.html

@@ -386,7 +386,7 @@
   <td class="type">
   
       
-<code class="param-type">string</code>
+<code class="param-type">obhect</code>
 
 
   
@@ -403,7 +403,30 @@
     
 <tr class="deep-level-1">
   
-      <td class="name"><code>type</code></td>
+      <td class="name"><code>token.value</code></td>
+  
+
+  <td class="type">
+  
+      
+<code class="param-type">object</code>
+
+
+  
+  </td>
+
+  
+
+  
+
+  <td class="description last">The token value</td>
+</tr>
+
+  
+    
+<tr class="deep-level-1">
+  
+      <td class="name"><code>token.type</code></td>
   
 
   <td class="type">
@@ -423,6 +446,29 @@
 </tr>
 
   
+    
+<tr class="deep-level-1">
+  
+      <td class="name"><code>token.data</code></td>
+  
+
+  <td class="type">
+  
+      
+<code class="param-type">object</code>
+
+
+  
+  </td>
+
+  
+
+  
+
+  <td class="description last">The extra data of a token, if there is.</td>
+</tr>
+
+  
 
 
         
@@ -501,7 +547,7 @@
         <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#line82">line 82</a>
+                <a href="user_notification.js.html">user/notification.js</a>, <a href="user_notification.js.html#line86">line 86</a>
             </span>
         </p>
     
@@ -577,8 +623,10 @@
 const api = new API();
 const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
 const params = {
- token: 'V6OSBr4aEVoiE9H1b4xzLe+vqmXB+ShVNc/FvJGxnIz4tZv6jBJkk4aQzz2',
- type: 'FCM_WEB'
+ token: {
+   value: 'V6OSBr4aEVoiE9H1b4xzLe+vqmXB+ShVNc/FvJGxnIz4tZv6jBJkk4aQzz2',
+   type: 'FCM_CAPACITOR'
+   }
 };
 const retData = await api.user.notification.addToken(params, session);</code></pre>
     
@@ -717,7 +765,7 @@ const retData = await api.user.notification.addToken(params, session);</code></p
         <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#line113">line 113</a>
+                <a href="user_notification.js.html">user/notification.js</a>, <a href="user_notification.js.html#line154">line 154</a>
             </span>
         </p>
     
@@ -886,7 +934,7 @@ await api.user.notification.getNew(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#line139">line 139</a>
+                <a href="user_notification.js.html">user/notification.js</a>, <a href="user_notification.js.html#line180">line 180</a>
             </span>
         </p>
     
@@ -922,6 +970,272 @@ await api.user.notification.getOld(session);</code></pre>
     
 
 
+</div>
+            
+                <div class="member">
+
+
+    
+    <h4 class="name" id="removeToken">
+        <a class="href-link" href="#removeToken">#</a>
+        
+            
+                <span class='tag'>async</span>
+            
+        
+        <span class="code-name">
+            
+                removeToken<span class="signature">(params, session)</span><span class="type-signature"> &rarr; {promise.&lt;object>|boolean}</span>
+            
+        </span>
+    </h4>
+    
+
+    
+    
+    <div class="description">
+        Method to remove a notification token
+    </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 add notification token</td>
+</tr>
+
+  
+  
+    
+<tr class="deep-level-1">
+  
+      <td class="name"><code>token</code></td>
+  
+
+  <td class="type">
+  
+      
+<code class="param-type">obhect</code>
+
+
+  
+  </td>
+
+  
+
+  
+
+  <td class="description last">The token value</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">Is token JWT of user NOT allow SU</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#line124">line 124</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._id the id of the added token</div>
+    
+    
+    <div class='column is-5 has-text-left'>
+        <label>Type: </label>
+        
+<code class="param-type">boolean</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...';
+const params = {
+ token:'V6OSBr4aEVoiE9H1b4xzLe+vqmXB+ShVNc/FvJGxnIz4tZv6jBJkk4aQzz2'
+};
+const retData = await api.user.notification.removeToken(params, session);</code></pre>
+    
+
+
 </div>
             
                 <div class="member">
@@ -1106,7 +1420,7 @@ await api.user.notification.getOld(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#line171">line 171</a>
+                <a href="user_notification.js.html">user/notification.js</a>, <a href="user_notification.js.html#line212">line 212</a>
             </span>
         </p>
     
@@ -1301,7 +1615,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#line202">line 202</a>
+                <a href="user_notification.js.html">user/notification.js</a>, <a href="user_notification.js.html#line243">line 243</a>
             </span>
         </p>
     
@@ -1544,7 +1858,7 @@ await api.user.notification.setReadAll(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#line238">line 238</a>
+                <a href="user_notification.js.html">user/notification.js</a>, <a href="user_notification.js.html#line279">line 279</a>
             </span>
         </p>
     

package/docs/dispatch.js.html

@@ -101,12 +101,7 @@ class Dispatch {
 
     const self = this;
     self.parent = options.parent;
-    self._client = Axios.create({
-      baseURL: self.parent.options.uri,
-      headers: {
-        'Referer': self.parent.options.uri,  // Default Referer header
-      }
-    });
+    self._client = Axios.create({baseURL: self.parent.options.uri});
   }
 
   /**

package/docs/user_notification.js.html

@@ -149,8 +149,10 @@ class Notification {
    * @author Myndware <augusto.pissarra@myndware.com>
    * @description Method to add a notification token
    * @param {object} params Params to add notification token
-   * @param {string} params.token The token
-   * @param {object} params.type The token type
+   * @param {obhect} params.token The token
+   * @param {object} params.token.value The token value
+   * @param {object} params.token.type The token type
+   * @param {object} params.token.data The extra data of a token, if there is.
    * @param {string} session Is token JWT of user NOT allow SU
    * @returns {promise<object>} data
    * @returns {boolean} data._id the id of the added token
@@ -161,21 +163,60 @@ class Notification {
    * const api = new API();
    * const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
    * const params = {
-   *  token: 'V6OSBr4aEVoiE9H1b4xzLe+vqmXB+ShVNc/FvJGxnIz4tZv6jBJkk4aQzz2',
-   *  type: 'FCM_WEB'
+   *  token: {
+   *    value: 'V6OSBr4aEVoiE9H1b4xzLe+vqmXB+ShVNc/FvJGxnIz4tZv6jBJkk4aQzz2',
+   *    type: 'FCM_CAPACITOR'
+ *    }
    * };
    * const retData = await api.user.notification.addToken(params, session);
    */
   async addToken(params = {}, session) {
     const self = this;
 
+    try {
+      Joi.assert(params, Joi.object().required(), 'Params to get task');
+      Joi.assert(params.token, Joi.object().required(), 'Token information to add');
+      Joi.assert(params.token.value, Joi.string().required(), 'Token token value');
+      Joi.assert(params.token.type, Joi.string().required(), 'The type of the token');
+
+      const apiCall = self._client
+        .put(`/notifications/token`, params, self._setHeader(session));
+
+      const retData = self._returnData(await apiCall);
+      return retData;
+    } catch (ex) {
+      throw ex;
+    }
+  }
+
+  /**
+   * @author Myndware <augusto.pissarra@myndware.com>
+   * @description Method to remove a notification token
+   * @param {object} params Params to add notification token
+   * @param {obhect} params.token The token value
+   * @param {string} session Is token JWT of user NOT allow SU
+   * @returns {promise<object>} data
+   * @returns {boolean} data._id the id of the added token
+   * @public
+   * @example
+   *
+   * const API = require('@docbrasil/api-systemmanager');
+   * const api = new API();
+   * const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
+   * const params = {
+   *  token:'V6OSBr4aEVoiE9H1b4xzLe+vqmXB+ShVNc/FvJGxnIz4tZv6jBJkk4aQzz2'
+   * };
+   * const retData = await api.user.notification.removeToken(params, session);
+   */
+  async removeToken(params = {}, session) {
+    const self = this;
+
     try {
       Joi.assert(params, Joi.object().required(), 'Params to get task');
       Joi.assert(params.token, Joi.string().required(), 'Token is required');
-      Joi.assert(params.type, Joi.string().required(), ' The token type');
 
       const apiCall = self._client
-        .put(`/users/notifications/token`, params, self._setHeader(session));
+          .delete(`/notifications/token/${params.token}`, self._setHeader(session));
 
       const retData = self._returnData(await apiCall);
       return retData;

package/package.json

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