npm - @docbrasil/api-systemmanager - Versions diffs - 1.0.107 → 1.0.108 - Mend

@docbrasil/api-systemmanager 1.0.107 → 1.0.108

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (73) hide show

package/.github/workflows/static.yml +43 -0
package/api/external.js +41 -0
package/dist/bundle.cjs +41 -0
package/dist/bundle.mjs +1 -1
package/doc/api.md +382 -0
package/docs/Admin.html +336 -0
package/docs/AdminDocuments.html +2235 -0
package/docs/AdminForm.html +934 -0
package/docs/AdminLists.html +895 -0
package/docs/AdminMessage.html +1490 -0
package/docs/AdminNotification.html +1636 -0
package/docs/AdminPlugin.html +696 -0
package/docs/AdminPolicy.html +451 -0
package/docs/AdminProcesses.html +692 -0
package/docs/AdminTask.html +740 -0
package/docs/AdminUser.html +1203 -0
package/docs/Datasource.html +660 -0
package/docs/Dispatch.html +624 -0
package/docs/Documents.html +4875 -0
package/docs/External.html +1203 -0
package/docs/GeoLocation.html +503 -0
package/docs/Login.html +1839 -0
package/docs/Notification.html +625 -0
package/docs/Organization.html +2767 -0
package/docs/Process.html +1598 -0
package/docs/Register.html +1604 -0
package/docs/Session.html +482 -0
package/docs/Task.html +1394 -0
package/docs/TaskAvailable.html +893 -0
package/docs/User.html +2002 -0
package/docs/Users.html +569 -0
package/docs/admin_doctypes.js.html +193 -0
package/docs/admin_document.js.html +449 -0
package/docs/admin_form.js.html +268 -0
package/docs/admin_index.js.html +163 -0
package/docs/admin_list.js.html +250 -0
package/docs/admin_message.js.html +311 -0
package/docs/admin_notification.js.html +350 -0
package/docs/admin_organization.js.html +241 -0
package/docs/admin_plugin.js.html +233 -0
package/docs/admin_policy.js.html +195 -0
package/docs/admin_processes.js.html +487 -0
package/docs/admin_task.js.html +242 -0
package/docs/admin_user.js.html +302 -0
package/docs/dispatch.js.html +218 -0
package/docs/external.js.html +333 -0
package/docs/general_geoLocation.js.html +205 -0
package/docs/general_index.js.html +140 -0
package/docs/index.html +129 -0
package/docs/login.js.html +384 -0
package/docs/scripts/app.min.js +1 -0
package/docs/scripts/linenumber.js +26 -0
package/docs/scripts/search.js +39 -0
package/docs/session.js.html +202 -0
package/docs/styles/app.min.css +1 -0
package/docs/styles/iframe.css +13 -0
package/docs/styles/prettify-jsdoc.css +111 -0
package/docs/styles/prettify-tomorrow.css +132 -0
package/docs/styles/reset.css +44 -0
package/docs/user_datasource.js.html +261 -0
package/docs/user_document.js.html +847 -0
package/docs/user_index.js.html +156 -0
package/docs/user_notification.js.html +218 -0
package/docs/user_organization.js.html +347 -0
package/docs/user_process.js.html +352 -0
package/docs/user_register.js.html +322 -0
package/docs/user_task.js.html +319 -0
package/docs/user_task_available.js.html +252 -0
package/docs/user_user.js.html +404 -0
package/docs/utils_promises.js.html +235 -0
package/package.json +7 -4
package/readme.md +7 -8
package/doc.md +0 -653

package/docs/user_process.js.html ADDED Viewed

@@ -0,0 +1,352 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="utf-8">
+  <meta name="viewport" content="width=device-width, initial-scale=1">
+  <title> user/process.js</title>
+  <script src="https://cdn.jsdelivr.net/gh/google/code-prettify@master/loader/run_prettify.js"></script>
+  <script src="https://unpkg.com/@babel/standalone/babel.min.js"></script>
+  <script src="./build/entry.js"></script>
+  <script src="https://ajax.googleapis.com/ajax/libs/jquery/3.3.1/jquery.min.js"></script>
+  <!--[if lt IE 9]>
+    <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
+  <![endif]-->
+  <link href="https://fonts.googleapis.com/css?family=Roboto:100,400,700|Inconsolata,700" rel="stylesheet">
+  <link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.6.3/css/all.css" integrity="sha384-UHRtZLI+pbxtHCWp1t77Bi1L4ZtiqrqD80Kn4Z8NTSRyMA2Fd33n5dQ8lWUE00s/" crossorigin="anonymous">
+  <link type="text/css" rel="stylesheet" href="https://jmblog.github.io/color-themes-for-google-code-prettify/themes/tomorrow-night.min.css">
+  <link type="text/css" rel="stylesheet" href="styles/app.min.css">
+  <link type="text/css" rel="stylesheet" href="styles/iframe.css">
+  <link type="text/css" rel="stylesheet" href="">
+  <script async defer src="https://buttons.github.io/buttons.js"></script>
+</head>
+<body class="layout small-header">
+    <div id="stickyNavbarOverlay"></div>
+<div class="top-nav">
+    <div class="inner">
+        <a id="hamburger" role="button" class="navbar-burger" aria-label="menu" aria-expanded="false">
+            <span aria-hidden="true"></span>
+            <span aria-hidden="true"></span>
+            <span aria-hidden="true"></span>
+        </a>
+        <div class="logo">
+        </div>
+        <div class="menu">
+            <div class="navigation">
+                <a
+                    href="index.html"
+                    class="link"
+                >
+                    Documentation
+                </a>
+            </div>
+        </div>
+    </div>
+</div>
+    <div id="main">
+        <div
+            class="sidebar "
+            id="sidebarNav"
+        >
+            <nav>
+                    <h2><a href="index.html">Documentation</a></h2><div class="category"><h3>Classes</h3><ul><li><a href="Admin.html">Admin</a></li><li><a href="AdminDocuments.html">AdminDocuments</a></li><li><a href="AdminForm.html">AdminForm</a></li><li><a href="AdminLists.html">AdminLists</a></li><li><a href="AdminMessage.html">AdminMessage</a></li><li><a href="AdminNotification.html">AdminNotification</a></li><li><a href="AdminPlugin.html">AdminPlugin</a></li><li><a href="AdminPolicy.html">AdminPolicy</a></li><li><a href="AdminProcesses.html">AdminProcesses</a></li><li><a href="AdminTask.html">AdminTask</a></li><li><a href="AdminUser.html">AdminUser</a></li><li><a href="Datasource.html">Datasource</a></li><li><a href="Dispatch.html">Dispatch</a></li><li><a href="Documents.html">Documents</a></li><li><a href="External.html">External</a></li><li><a href="GeoLocation.html">GeoLocation</a></li><li><a href="Login.html">Login</a></li><li><a href="Notification.html">Notification</a></li><li><a href="Organization.html">Organization</a></li><li><a href="Process.html">Process</a></li><li><a href="Register.html">Register</a></li><li><a href="Session.html">Session</a></li><li><a href="Task.html">Task</a></li><li><a href="TaskAvailable.html">TaskAvailable</a></li><li><a href="User.html">User</a></li><li><a href="Users.html">Users</a></li></ul></div>
+            </nav>
+        </div>
+        <div class="core" id="main-content-wrapper">
+            <div class="content">
+                <header class="page-title">
+                    <p>Source</p>
+                    <h1>user/process.js</h1>
+                </header>
+    <section>
+        <article>
+            <pre class="prettyprint source linenums"><code>import _ from 'lodash';
+import Boom from '@hapi/boom';
+import Joi from 'joi';
+/**
+ * Class for process, permission user
+ * @class
+ */
+class Process {
+  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 CloudBrasil &lt;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 &lt;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 &lt;abernardo.br@gmail.com>
+   * @description Set header for a bigger payload
+   * @param {string} session Session, token JWT
+   * @return {object} header with new session
+   * @private
+   */
+  _setMaxContentHeader(session) {
+    return {
+      headers: {
+        authorization: session
+      },
+      maxContentLength: Infinity,
+      maxBodyLength: Infinity
+    };
+  }
+  /**
+   * @author CloudBrasil &lt;abernardo.br@gmail.com>
+   * @description Start process
+   * @param {object} params Params to start process
+   * @param {string} params.processId Process id (_id database);
+   * @param {string} params.orgId Organization id (_id database);
+   * @param {object} [params.payload={}] Start process with data
+   * @param {string} session Session, token JWT
+   * @return {Promise}
+   * @public
+   * @async
+   * @example
+   *
+   * const API = require('@docbrasil/api-systemmanager');
+   * const api = new API();
+   * const params = {
+   *   processId: '5dadd01dc4af3941d42f8c5c',
+   *   orgId: '5edd11c46b6ce9729c2c297c',
+   *   payload: {}
+   * }
+   * const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
+   * await api.user.process.start(params, session);
+   */
+  async start(params, session) {
+    const self = this;
+    try {
+      Joi.assert(params, Joi.object().required());
+      Joi.assert(params.processId, Joi.string().required());
+      Joi.assert(params.orgId, Joi.string().required());
+      Joi.assert(params.payload, Joi.object());
+      Joi.assert(session, Joi.string().required());
+      const {processId, orgId, payload = {}} = params;
+      const apiCall = self._client.put(`/organizations/${orgId}/process/${processId}`, payload, self._setMaxContentHeader(session));
+      return self._returnData(await apiCall);
+    } catch (ex) {
+      throw ex;
+    }
+  }
+  /**
+   * @author CloudBrasil &lt;abernardo.br@gmail.com>
+   * @description Get process properties of process
+   * @param {object} params Params to get process properties
+   * @param {string} params.processId Process id (_id database);
+   * @param {string} params.orgId Organization id (_id database);
+   * @param {string} session Session, token JWT
+   * @return {Promise}
+   * @public
+   * @async
+   * @example
+   *
+   * const API = require('@docbrasil/api-systemmanager');
+   * const api = new API();
+   * const params = {
+   *   processId: '5dadd01dc4af3941d42f8c5c',
+   *   orgId: '5edd11c46b6ce9729c2c297c',
+   * }
+   * const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
+   * await api.user.process.getProcessProperties(params, session);
+   */
+  async getProcessProperties(params, session) {
+    const self = this;
+    try {
+      Joi.assert(params, Joi.object().required());
+      Joi.assert(params.processId, Joi.string().required());
+      Joi.assert(params.orgId, Joi.string().required());
+      Joi.assert(session, Joi.string().required());
+      const {processId, orgId} = params;
+      const apiCall = self._client.get(`/organizations/${orgId}/process/${processId}/properties`, self._setHeader(session));
+      return self._returnData(await apiCall);
+    } catch (ex) {
+      throw ex;
+    }
+  }
+  /**
+   * @author CloudBrasil &lt;abernardo.br@gmail.com>
+   * @description Get the search info of a organization process
+   * @param {object} params Params to get search info
+   * @param {string} params.orgProcessId The id of an organization process (_id database);
+   * @param {string} params.orgId Organization id (_id database);
+   * @param {string} session Session, token JWT
+   * @return {Promise} the search info result
+   * @return {string} name the name of the organization process
+   * @return {object} processIndexFields the list of fields to index
+   * @return {object} processParticipantsGroup the permissions in this organization process
+   * @return {object} stepsProperties the organization process steps properties
+   * @return {string} _id the same organization id
+   * @
+   * @public
+   * @async
+   * @example
+   *
+   * const API = require('@docbrasil/api-systemmanager');
+   * const api = new API();
+   * const params = {
+   *   orgProcessId: '5dadd01dc4af3941d42f8c67',
+   *   orgId: '5edd11c46b6ce9729c2c297c',
+   * }
+   * const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
+   * const retSearchInfo = await api.user.process.getOrgProcessSearchInfo(params, session);
+   */
+  async getOrgProcessSearchInfo(params, session) {
+    const self = this;
+    try {
+      Joi.assert(params, Joi.object().required());
+      Joi.assert(params.orgProcessId, Joi.string().required());
+      Joi.assert(params.orgId, Joi.string().required());
+      Joi.assert(session, Joi.string().required());
+      const {orgProcessId, orgId} = params;
+      const apiCall = self._client.get(`/organizations/${orgId}/orgprocess/${orgProcessId}/search/info`, self._setHeader(session));
+      return self._returnData(await apiCall);
+    } catch (ex) {
+      throw ex;
+    }
+  }
+  /**
+   * @author CloudBrasil &lt;abernardo.br@gmail.com>
+   * @description Method to search processes
+   * @param {object} params Params to search processes
+   * @param {object} params.query Search process query
+   * @param {object} params.orgId Organization id (_id database)
+   * @param {string} session Session, token JWT
+   * @returns {promise} returned data from the search
+   * @returns {number} count the count of items searched
+   * @returns {array&lt;object>} items the items returned from search
+   * @returns {number} page the page of the search (on pagination), zero indexed
+   * @returns {number} perPage how many items per page
+   * @public
+   * @example
+   *
+   * const API = require('@docbrasil/api-systemmanager');
+   * const api = new API();
+   * const params = {
+   *  query: {"orgProcessId": {"value":"62c2d1cdfb5455c195d1baa1","oper":"=","type":"string"},"s":[{"historyBegin":{"order":"desc"}}],"i":1,"p":20},
+   *  orgId: '55e4a3bd6be6b45210833fae',
+   * };
+   * const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
+   * const retSearch = await api.user.process.find(params, session);
+   */
+  async find(params, session) {
+    const self = this;
+    try {
+      Joi.assert(params, Joi.object().required(), 'Params to search processes');
+      Joi.assert(params.query, Joi.object().required(), 'The query for the search');
+      Joi.assert(params.orgId, Joi.string().required(), 'Organization id (_id database)');
+      Joi.assert(session, Joi.string().required(), 'Session token JWT');
+      const {query, orgId} = params;
+      const queryString = JSON.stringify(query);
+      const apiCall = self._client
+        .post(`/organizations/${orgId}/process/advsearch?query=${queryString}`, {}, self._setHeader(session));
+      return self._returnData(await apiCall);
+    } catch (ex) {
+      throw ex;
+    }
+  }
+}
+export default Process;
+</code></pre>
+        </article>
+    </section>
+            </div>
+            <footer class="footer">
+                <div class="content has-text-centered">
+                    <p>Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a></p>
+                    <p class="sidebar-created-by">
+                        <a href="https://github.com/SoftwareBrothers/better-docs" target="_blank">BetterDocs theme</a> provided with <i class="fas fa-heart"></i> by
+                        <a href="http://softwarebrothers.co" target="_blank">SoftwareBrothers - JavaScript Development Agency</a>
+                    </p>
+                </div>
+            </footer>
+        </div>
+        <div id="side-nav" class="side-nav">
+        </div>
+    </div>
+<script src="scripts/app.min.js"></script>
+<script>PR.prettyPrint();</script>
+<script src="scripts/linenumber.js"> </script>
+</body>
+</html>

package/docs/user_register.js.html ADDED Viewed

@@ -0,0 +1,322 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="utf-8">
+  <meta name="viewport" content="width=device-width, initial-scale=1">
+  <title> user/register.js</title>
+  <script src="https://cdn.jsdelivr.net/gh/google/code-prettify@master/loader/run_prettify.js"></script>
+  <script src="https://unpkg.com/@babel/standalone/babel.min.js"></script>
+  <script src="./build/entry.js"></script>
+  <script src="https://ajax.googleapis.com/ajax/libs/jquery/3.3.1/jquery.min.js"></script>
+  <!--[if lt IE 9]>
+    <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
+  <![endif]-->
+  <link href="https://fonts.googleapis.com/css?family=Roboto:100,400,700|Inconsolata,700" rel="stylesheet">
+  <link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.6.3/css/all.css" integrity="sha384-UHRtZLI+pbxtHCWp1t77Bi1L4ZtiqrqD80Kn4Z8NTSRyMA2Fd33n5dQ8lWUE00s/" crossorigin="anonymous">
+  <link type="text/css" rel="stylesheet" href="https://jmblog.github.io/color-themes-for-google-code-prettify/themes/tomorrow-night.min.css">
+  <link type="text/css" rel="stylesheet" href="styles/app.min.css">
+  <link type="text/css" rel="stylesheet" href="styles/iframe.css">
+  <link type="text/css" rel="stylesheet" href="">
+  <script async defer src="https://buttons.github.io/buttons.js"></script>
+</head>
+<body class="layout small-header">
+    <div id="stickyNavbarOverlay"></div>
+<div class="top-nav">
+    <div class="inner">
+        <a id="hamburger" role="button" class="navbar-burger" aria-label="menu" aria-expanded="false">
+            <span aria-hidden="true"></span>
+            <span aria-hidden="true"></span>
+            <span aria-hidden="true"></span>
+        </a>
+        <div class="logo">
+        </div>
+        <div class="menu">
+            <div class="navigation">
+                <a
+                    href="index.html"
+                    class="link"
+                >
+                    Documentation
+                </a>
+            </div>
+        </div>
+    </div>
+</div>
+    <div id="main">
+        <div
+            class="sidebar "
+            id="sidebarNav"
+        >
+            <nav>
+                    <h2><a href="index.html">Documentation</a></h2><div class="category"><h3>Classes</h3><ul><li><a href="Admin.html">Admin</a></li><li><a href="AdminDocuments.html">AdminDocuments</a></li><li><a href="AdminForm.html">AdminForm</a></li><li><a href="AdminLists.html">AdminLists</a></li><li><a href="AdminMessage.html">AdminMessage</a></li><li><a href="AdminNotification.html">AdminNotification</a></li><li><a href="AdminPlugin.html">AdminPlugin</a></li><li><a href="AdminPolicy.html">AdminPolicy</a></li><li><a href="AdminProcesses.html">AdminProcesses</a></li><li><a href="AdminTask.html">AdminTask</a></li><li><a href="AdminUser.html">AdminUser</a></li><li><a href="Datasource.html">Datasource</a></li><li><a href="Dispatch.html">Dispatch</a></li><li><a href="Documents.html">Documents</a></li><li><a href="External.html">External</a></li><li><a href="GeoLocation.html">GeoLocation</a></li><li><a href="Login.html">Login</a></li><li><a href="Notification.html">Notification</a></li><li><a href="Organization.html">Organization</a></li><li><a href="Process.html">Process</a></li><li><a href="Register.html">Register</a></li><li><a href="Session.html">Session</a></li><li><a href="Task.html">Task</a></li><li><a href="TaskAvailable.html">TaskAvailable</a></li><li><a href="User.html">User</a></li><li><a href="Users.html">Users</a></li></ul></div>
+            </nav>
+        </div>
+        <div class="core" id="main-content-wrapper">
+            <div class="content">
+                <header class="page-title">
+                    <p>Source</p>
+                    <h1>user/register.js</h1>
+                </header>
+    <section>
+        <article>
+            <pre class="prettyprint source linenums"><code>import _ from 'lodash';
+import Boom from '@hapi/boom';
+import Joi from 'joi';
+import Cypher from '../utils/cypher.js';
+/**
+ * Class for user registration in a user
+ * @class
+ */
+class Register {
+  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 &lt;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 &lt;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 &lt;abernardo.br@gmail.com>
+   * @param {object} params.registerId The registerId that comes with the registration page context
+   * @return {string} orgname The orgname of the organization in the registerId
+   * @public
+   * @example
+   *
+   * const API = require('@docbrasil/api-systemmanager');
+   * const api = new API();
+   * const params = {
+   *  registerId: 'U2FsdGVkX1+xEq+sV6OSBr4aEVoiE9H1b4xzLe+vqmXB+ShVNc/FvJGxnIz4tZv6jBJkk4aQzz24O5koH+rGmdl/DjqfyWfENe5NFuQ+6xXhuOSN24Z+Topo87+e+CrRO8ox...'
+   * };
+   * const orgname = await api.user.register.getOrgname(params);
+   */
+  getOrgname(registerId) {
+    const { orgname = '' } = Cypher.get(registerId) || {};
+    return orgname;
+  }
+  /**
+   * @author CloudBrasil &lt;abernardo.br@gmail.com>
+   * @description Method to find task by id
+   * @param {object} params Params to get task
+   * @param {string} params.registerId The registerId that comes with the registration page context
+   * @param {object} params.email The email to validate
+   * @returns {promise&lt;object>} data
+   * @returns {boolean} data.success If the operation was successfully done (true|false)
+   * @returns {boolean} data.userAlreadyExists If the user already exists (true|false), if true, then the other information is not returned
+   * @returns {string} data.registrationEmailInfoRaw The fully cryptographed registration information
+   * @returns {object} data.registrationEmailInfo The registration information
+   * @returns {string} data.registrationEmailInfo.orgname The orgname
+   * @returns {string} data.registrationEmailInfo.orgId The orgId of the organization
+   * @returns {string} data.registrationEmailInfo.guid The unique id for the registration
+   * @returns {object} data.registrationEmailInfo.emailValidation The email validation information
+   * @returns {string} data.registrationEmailInfo.emailValidation.email The email that the code was sent to
+   * @returns {string} data.registrationEmailInfo.emailValidation.code The 4 digit code to validate the email
+   * @public
+   * @example
+   *
+   * const API = require('@docbrasil/api-systemmanager');
+   * const api = new API();
+   * const params = {
+   *  registerId: 'U2FsdGVkX1+xEq+sV6OSBr4aEVoiE9H1b4xzLe+vqmXB+ShVNc/FvJGxnIz4tZv6jBJkk4aQzz24O5koH+rGmdl/DjqfyWfENe5NFuQ+6xXhuOSN24Z+Topo87+e+CrRO8ox...',
+   *  email: 'myemail@company.com'
+   * };
+   * const retData = await api.user.register.validateEmail(params);
+   */
+  async validateEmail(params = {}) {
+    const self = this;
+    try {
+      Joi.assert(params, Joi.object().required(), 'Params to get task');
+      Joi.assert(params.registerId, Joi.string().required(), ' RegisterId for registration');
+      Joi.assert(params.email, Joi.string().required(), ' The emnail to register');
+      const { registerId = '', email = '' } = params;
+      const registerInfo = Cypher.get(registerId) || {};
+      const infoData = { ...registerInfo, email };
+      const payload = { info: Cypher.set(infoData) };
+      const apiCall = self._client
+        .post(`/users/validate/email`, payload);
+      const { success = false, info = '', userAlreadyExists = false } = self._returnData(await apiCall);
+      const retData = { success, userAlreadyExists, registrationEmailInfoRaw: info, registrationEmailInfo: Cypher.get(info) };
+      return retData;
+    } catch (ex) {
+      throw ex;
+    }
+  }
+  /**
+   * @author CloudBrasil &lt;abernardo.br@gmail.com>
+   * @description Method to register a user
+   * @param {object} params Params to get task
+   * @param {string} params.registerId The registerId that comes with the registration page context
+   * @param {string} params.type=sign The type of the registration. By defailt,
+   * @param {boolean} params.login=false If we want to login the user directly after registering the user successfully. If you have a redirect, the best option is to login automatically.
+   * @param {object} params.emailInfo The information for the email validation
+   * @param {string} params.emailInfo.email The email validation information
+   * @param {string} params.emailInfo.code The 4 digit code to validate the email
+   * @param {object} params.registerData The registration data
+   * @param {string} params.registerData.name The name if the user
+   * @param {string} params.registerData.registerEmail The email of the user
+   * @param {string} params.registerData.phone The phone of the user
+   * @param {string} params.registerData.idcard The ID card of the user
+   * @param {string} params.registerData.registerPassword The user password in open text
+   * @param {string} params.registerData.emailValidationCode The code used to validate the email
+   * @param {string} params.registerData.phoneValidationCode The code used to validate the phone
+   * @param {string} params.registerData.language The defaulf navigator language (i.e.: navigator.language)
+   * @param {string} params.registerData.timezone The defaulf navigator timezone (i.e.: Intl.DateTimeFormat().resolvedOptions().timeZone)
+   * @returns {promise&lt;object>} data
+   * @returns {boolean} data.success If the operation was successfully done (true|false)
+   * @returns {boolean} data.userAlreadyExists If the user already exists (true|false), if true, then the other information is not returned
+   * @returns {object} auth The full authentication data with session, if login is true.
+   * @returns {string} auth.redirectUrl The url to redirect.
+   * @public
+   * @example
+   *
+   * const API = require('@docbrasil/api-systemmanager');
+   * const api = new API();
+   * const params ={
+   *     "registerId": 'U2FsdGVkX1+xEq+sV6OSBr4aEVoiE9H1b4xzLe+vqmXB+ShVNc/FvJGxnIz4tZv6jBJkk4aQzz24O5koH+rGmdl/DjqfyWfENe5NFuQ+6xXhuOSN24Z+Topo87+e+CrRO8ox...',
+   *     "type": 'sign',
+   *     "login": false,
+   *     "emailInfo": {
+   *       "code": "5974",
+   *       "email": "cbtoto_1@mailinator.com"
+   *     },
+   *     "registerData": {
+   *       "name": "Augusto Totlo",
+   *       "registerEmail": "cbtoto_1@mailinator.com",
+   *       "phone": "",
+   *       "idcard": "",
+   *       "dob": "1978-01-12T03:00:00.000Z",
+   *       "registerPassword": "123456",
+   *       "emailValidationCode": "5974",
+   *       "phoneValidationCode": "",
+   *       "language": "en-US",
+   *       "timezone": "Europe/Dublin"
+   *     }
+   *   };
+   * const retData = await api.user.register.execute(params);
+   */
+  async execute(params = {}) {
+    const self = this;
+    try {
+      Joi.assert(params, Joi.object().required(), 'Params to get task');
+      Joi.assert(params.registerId, Joi.string().required(), ' RegisterId for registration');
+      Joi.assert(params.emailInfo, Joi.object().required(), ' The email info');
+      Joi.assert(params.registerData, Joi.object().required(), ' The registerData');
+      const {
+        type = 'sign',
+        registerId = '',
+        emailInfo = {},
+        registerData = {},
+        login = false
+      } = params;
+      const registerInfo = Cypher.get(registerId) || {};
+      const payload = { ...registerInfo, type, login, emailInfo, registerData };
+      const payloadInfo = { info: Cypher.set(payload) };
+      const apiCall = self._client
+          .put(`/users/register`, payloadInfo);
+      const { success = false, userAlreadyExists = false, auth } = self._returnData(await apiCall);
+      const retData = { success, userAlreadyExists, auth };
+      return retData;
+    } catch (ex) {
+      throw ex;
+    }
+  }
+}
+export default Register;
+</code></pre>
+        </article>
+    </section>
+            </div>
+            <footer class="footer">
+                <div class="content has-text-centered">
+                    <p>Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a></p>
+                    <p class="sidebar-created-by">
+                        <a href="https://github.com/SoftwareBrothers/better-docs" target="_blank">BetterDocs theme</a> provided with <i class="fas fa-heart"></i> by
+                        <a href="http://softwarebrothers.co" target="_blank">SoftwareBrothers - JavaScript Development Agency</a>
+                    </p>
+                </div>
+            </footer>
+        </div>
+        <div id="side-nav" class="side-nav">
+        </div>
+    </div>
+<script src="scripts/app.min.js"></script>
+<script>PR.prettyPrint();</script>
+<script src="scripts/linenumber.js"> </script>
+</body>
+</html>