@docbrasil/api-systemmanager 1.0.57 → 1.0.58

package/api/login.js

@@ -231,6 +231,37 @@ class Login {
       throw ex;
     }
   }
+
+  /**
+   * @author CloudBrasil <abernardo.br@gmail.com>
+   * @description Recover the password
+   * @param {string} username The username or email
+   * @return {promise<object>}} data
+   * @return {boolean} data.success true|false
+   * @public
+   * @async
+   * @example
+   *
+   * const API = require('@docbrasil/api-systemmanager');
+   *
+   * // Params of the instance
+   * const params = {...}
+   * const api = new API(params);
+   * const { success } = await api.login.recover('myusername');
+   */
+  async recover(username) {
+    const self = this;
+
+    try {
+      Joi.assert(username, Joi.string().required());
+
+      const url = `users/${username}/sendResetEmail`;
+      const apiCall = self._client.get(url);
+      return self._returnData(await apiCall);
+    } catch (ex) {
+      throw ex;
+    }
+  }
 }
 
 export default Login;

package/doc/api.md

@@ -1250,6 +1250,7 @@ Login manager
     * [.apiKey(apikey)](#Login+apiKey) ⇒ <code>promise.&lt;object&gt;</code> \| <code>object</code> \| <code>object</code>
     * [.userPass(params)](#Login+userPass) ⇒ <code>promise.&lt;object&gt;</code> \| <code>object</code> \| <code>object</code>
     * [.logout(session)](#Login+logout) ⇒ <code>promise.&lt;object&gt;</code> \| <code>boolean</code>
+    * [.recover(username)](#Login+recover) ⇒ <code>promise.&lt;object&gt;</code> \| <code>boolean</code>
 
 <a name="Login+facebook"></a>
 
@@ -1383,6 +1384,29 @@ const api = new API(params);
 const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
 const { success } = await api.login.logout(session);
 ```
+<a name="Login+recover"></a>
+
+### login.recover(username) ⇒ <code>promise.&lt;object&gt;</code> \| <code>boolean</code>
+Recover the password
+
+**Kind**: instance method of [<code>Login</code>](#Login)  
+**Returns**: <code>promise.&lt;object&gt;</code> - } data<code>boolean</code> - data.success true|false  
+**Access**: public  
+**Author**: CloudBrasil <abernardo.br@gmail.com>  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| username | <code>string</code> | The username or email |
+
+**Example**  
+```js
+const API = require('@docbrasil/api-systemmanager');
+
+// Params of the instance
+const params = {...}
+const api = new API(params);
+const { success } = await api.login.recover('myusername');
+```
 <a name="Session"></a>
 
 ## Session

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@docbrasil/api-systemmanager",
   "description": "Module API System Manager",
-  "version": "1.0.57",
+  "version": "1.0.58",
   "scripts": {
     "doc": "rm -f  doc/api.md && jsdoc2md api/**/** > doc/api.md",
     "build": "node bundleRollup.js"