@docbrasil/api-systemmanager 1.1.8 → 1.1.10

package/api/user/index.js

@@ -12,6 +12,7 @@ import Updates from './updates.js';
 import Help from './help.js';
 import Datasource from './datasource.js';
 import Application from './application.js';
+import Settings from './settings.js';
 
 /**
  * @class API request, user permission level
@@ -34,6 +35,7 @@ class Users {
     self.process = new Process(options);
     self.task = new Task(options);
     self.user = self.profile = new User(options);
+    self.settings = new Settings(options);
     self.register = new Register(options);
     self.notification = new Notification(options);
     self.updates = new Updates(options);

package/api/user/settings.js

@@ -0,0 +1,142 @@
+import _ from 'lodash';
+import Boom from '@hapi/boom';
+import Joi from 'joi';
+
+/**
+ * Class for user settings
+ * @class
+ */
+class Settings {
+
+  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();
+    self.gender = {
+      male: 1,
+      female: 2,
+      nonBinary: 3
+    };
+  }
+
+  /**
+   * @author CloudBrasil <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 CloudBrasil <abernardo.br@gmail.com>
+   * @description Adds/updates a user settings
+   * @param {object} settings Full user settings
+   * @param {string} session Is token JWT of user NOT allow SU
+   * @return {Promise}
+   * @public
+   * @async
+   * @example
+   *
+   * const API = require('@docbrasil/api-systemmanager');
+   * const api = new API();
+   * const settings = {
+   *  areaId: '55e4a3bd6be6b45210833fae'
+   * };
+   * const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
+   * await api.user.settings.upsert(settings, session);
+   */
+  async upsert(settings, session) {
+    const self = this;
+
+    try {
+      Joi.assert(settings, Joi.object().required());
+      Joi.assert(session, Joi.string().required());
+
+      const apiCall = self._client.put(`/users/settings`, settings, self._setHeader(session));
+      return self._returnData(await apiCall);
+    } catch (ex) {
+      throw ex;
+    }
+  }
+
+  /**
+   * @author CloudBrasil <abernardo.br@gmail.com>
+   * @description Gets the user settings. Returns an array of settings.
+   * @param {string} session Is token JWT of user NOT allow SU
+   * @return {Promise}
+   * @public
+   * @async
+   * @example
+   *
+   * const API = require('@docbrasil/api-systemmanager');
+   * const api = new API();
+   * const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
+   * ret settings = await api.user.settings.get(session);
+   */
+  async get(session) {
+    const self = this;
+
+    try {
+      Joi.assert(session, Joi.string().required());
+
+      const apiCall = self._client.get(`/users/settings`, self._setHeader(session));
+      return self._returnData(await apiCall);
+    } catch (ex) {
+      throw ex;
+    }
+  }
+
+  /**
+   * @author CloudBrasil <abernardo.br@gmail.com>
+   * @description Removes the user settings
+   * @param {string} session Is token JWT of user NOT allow SU
+   * @return {Promise}
+   * @public
+   * @async
+   * @example
+   *
+   * const API = require('@docbrasil/api-systemmanager');
+   * const api = new API();
+   * const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
+   * await api.user.settings.remove(session);
+   */
+  async remove(session) {
+    const self = this;
+
+    try {
+      Joi.assert(session, Joi.string().required());
+
+      const apiCall = self._client.del(`/users/settings`, self._setHeader(session));
+      return self._returnData(await apiCall);
+    } catch (ex) {
+      throw ex;
+    }
+  }
+}
+
+export default Settings;

package/dist/bundle.cjs

@@ -10361,6 +10361,143 @@ class Application {
   }
 }
 
+/**
+ * Class for user settings
+ * @class
+ */
+class Settings {
+
+  constructor(options) {
+    Joi__default["default"].assert(options, Joi__default["default"].object().required());
+    Joi__default["default"].assert(options.parent, Joi__default["default"].object().required());
+
+    const self = this;
+    self._parent = options.parent;
+    self._client = self._parent.dispatch.getClient();
+    self.gender = {
+      male: 1,
+      female: 2,
+      nonBinary: 3
+    };
+  }
+
+  /**
+   * @author CloudBrasil <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__default["default"].badRequest(___default["default"].get(retData, 'message', 'No error message reported!'))
+    } else {
+      return ___default["default"].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 CloudBrasil <abernardo.br@gmail.com>
+   * @description Adds/updates a user settings
+   * @param {object} settings Full user settings
+   * @param {string} session Is token JWT of user NOT allow SU
+   * @return {Promise}
+   * @public
+   * @async
+   * @example
+   *
+   * const API = require('@docbrasil/api-systemmanager');
+   * const api = new API();
+   * const settings = {
+   *  areaId: '55e4a3bd6be6b45210833fae'
+   * };
+   * const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
+   * await api.user.settings.upsert(settings, session);
+   */
+  async upsert(settings, session) {
+    const self = this;
+
+    try {
+      Joi__default["default"].assert(settings, Joi__default["default"].object().required());
+      Joi__default["default"].assert(session, Joi__default["default"].string().required());
+
+      const apiCall = self._client.put(`/users/settings`, settings, self._setHeader(session));
+      return self._returnData(await apiCall);
+    } catch (ex) {
+      throw ex;
+    }
+  }
+
+  /**
+   * @author CloudBrasil <abernardo.br@gmail.com>
+   * @description Gets the user settings. Returns an array of settings.
+   * @param {string} session Is token JWT of user NOT allow SU
+   * @return {Promise}
+   * @public
+   * @async
+   * @example
+   *
+   * const API = require('@docbrasil/api-systemmanager');
+   * const api = new API();
+   * const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
+   * ret settings = await api.user.settings.get(session);
+   */
+  async get(session) {
+    const self = this;
+
+    try {
+      Joi__default["default"].assert(session, Joi__default["default"].string().required());
+
+      const apiCall = self._client.get(`/users/settings`, self._setHeader(session));
+      return self._returnData(await apiCall);
+    } catch (ex) {
+      throw ex;
+    }
+  }
+
+  /**
+   * @author CloudBrasil <abernardo.br@gmail.com>
+   * @description Removes the user settings
+   * @param {string} session Is token JWT of user NOT allow SU
+   * @return {Promise}
+   * @public
+   * @async
+   * @example
+   *
+   * const API = require('@docbrasil/api-systemmanager');
+   * const api = new API();
+   * const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
+   * await api.user.settings.remove(session);
+   */
+  async remove(session) {
+    const self = this;
+
+    try {
+      Joi__default["default"].assert(session, Joi__default["default"].string().required());
+
+      const apiCall = self._client.del(`/users/settings`, self._setHeader(session));
+      return self._returnData(await apiCall);
+    } catch (ex) {
+      throw ex;
+    }
+  }
+}
+
 /**
  * @class API request, user permission level
  */
@@ -10382,6 +10519,7 @@ class Users {
     self.process = new Process(options);
     self.task = new Task(options);
     self.user = self.profile = new User(options);
+    self.settings = new Settings(options);
     self.register = new Register(options);
     self.notification = new Notification(options);
     self.updates = new Updates(options);