@docbrasil/api-systemmanager 1.0.120 → 1.0.121

package/api/user/help.js

@@ -0,0 +1,113 @@
+import _ from 'lodash';
+import Boom from '@hapi/boom';
+import Joi from 'joi';
+
+/**
+ * Class for user registration in a user
+ * @class
+ */
+class Help {
+
+  constructor(options) {
+    Joi.assert(options, Joi.object().required());
+    Joi.assert(options.parent, Joi.object().required());
+
+    const self = this;
+    self.parent = options.parent;
+    self._client = self.parent.dispatch.getClient();
+  }
+
+  /**
+   * @author Augusto Pissarra <abernardo.br@gmail.com>
+   * @description Get the return data and check for errors
+   * @param {object} retData Response HTTP
+   * @return {*}
+   * @private
+   */
+  _returnData(retData, def = {}) {
+    if (retData.status !== 200) {
+      return Boom.badRequest(_.get(retData, 'message', 'No error message reported!'))
+    } else {
+      return _.get(retData, 'data', def);
+    }
+  }
+
+  /**
+   * @author CloudBrasil <abernardo.br@gmail.com>
+   * @description Set header with new session
+   * @param {string} session Session, token JWT
+   * @return {object} header with new session
+   * @private
+   */
+  _setHeader(session) {
+    return {
+      headers: {
+        authorization: session,
+      }
+    };
+  }
+
+  /**
+   * @author Augusto Pissarra <abernardo.br@gmail.com>
+   * @description get heps topics
+   * @param {string} session JWT token
+   * @public
+   * @async
+   * @example
+   *
+   * const API = require('@docbrasil/api-systemmanager');
+   * const api = new API();
+   * const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
+   * await api.user.help.getTopics(session);
+   */
+  async getTopics(session) {
+    const self = this;
+
+    try {
+      Joi.assert(session, Joi.string().required(), 'SM session (JWT) to call API');
+
+      const apiCall = self._client.get('/help/topics', self._setHeader(session));
+      return self._returnData(await apiCall);
+    } catch (ex) {
+      throw ex;
+    }
+  }
+
+  /**
+   * @author CloudBrasil <abernardo.br@gmail.com>
+   * @description Method to find helps from a topic
+   * @param {object} params Params to get helps from topic
+   * @param {object} params.id Topic id (_id database)
+   * @param {string} session Session, token JWT
+   * @returns {promise}
+   * @public
+   * @example
+   *
+   * const API = require('@docbrasil/api-systemmanager');
+   * const api = new API();
+   * const params = {
+   *  id: '5dadd01dc4af3941d42f8c5c'
+   * };
+   * const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
+   * await api.user.help.get(params, session);
+   */
+  async get(params, session) {
+    const self = this;
+
+    try {
+      Joi.assert(params, Joi.object().required(), 'Params to helps from a topic');
+      Joi.assert(params.id, Joi.string().required(), 'Topic id (_id database)');
+      Joi.assert(session, Joi.string().required(), 'Session token JWT');
+
+      const {id} = params;
+      const apiCall = self._client.get(`/help/topic/${id}`, self._setHeader(session));
+
+      return self._returnData(await apiCall);
+    } catch (ex) {
+      throw ex;
+    }
+  }
+
+}
+
+export default Help;

package/doc/api.md

@@ -49,6 +49,9 @@
 <dt><a href="#Documents">Documents</a></dt>
 <dd><p>Class for documents, permission user</p>
 </dd>
+<dt><a href="#Help">Help</a></dt>
+<dd><p>Class for user registration in a user</p>
+</dd>
 <dt><a href="#Users">Users</a></dt>
 <dd><p>API request, user permission level</p>
 </dd>
@@ -1681,6 +1684,62 @@ const params = {
 const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
 const retSearch = await api.user.document.searchDocuments(params, session);
 ```
+<a name="Help"></a>
+
+## Help
+Class for user registration in a user
+
+**Kind**: global class  
+
+* [Help](#Help)
+    * [.getTopics(session)](#Help+getTopics)
+    * [.get(params, session)](#Help+get) ⇒ <code>promise</code>
+
+<a name="Help+getTopics"></a>
+
+### help.getTopics(session)
+get heps topics
+
+**Kind**: instance method of [<code>Help</code>](#Help)  
+**Access**: public  
+**Author**: Augusto Pissarra <abernardo.br@gmail.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.help.getTopics(session);
+```
+<a name="Help+get"></a>
+
+### help.get(params, session) ⇒ <code>promise</code>
+Method to find helps from a topic
+
+**Kind**: instance method of [<code>Help</code>](#Help)  
+**Access**: public  
+**Author**: CloudBrasil <abernardo.br@gmail.com>  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| params | <code>object</code> | Params to get helps from topic |
+| params.id | <code>object</code> | Topic id (_id database) |
+| session | <code>string</code> | Session, token JWT |
+
+**Example**  
+```js
+const API = require('@docbrasil/api-systemmanager');
+const api = new API();
+const params = {
+ id: '5dadd01dc4af3941d42f8c5c'
+};
+const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
+await api.user.help.get(params, session);
+```
 <a name="Users"></a>
 
 ## Users

package/package.json

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