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

@docbrasil/api-systemmanager 1.0.107 → 1.0.109

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 +1497 -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/admin_message.js.html ADDED Viewed

@@ -0,0 +1,311 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="utf-8">
+  <meta name="viewport" content="width=device-width, initial-scale=1">
+  <title> admin/message.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>admin/message.js</h1>
+                </header>
+    <section>
+        <article>
+            <pre class="prettyprint source linenums"><code>import _ from 'lodash';
+import Boom from '@hapi/boom';
+import Joi from 'joi';
+/**
+ * Admin Class for user, permission admin
+ * @class
+ */
+class AdminMessage {
+  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,
+      }
+    };
+  }
+  /**
+   * @description Pagination SMS texts
+   * @param {!object} params - Params to pagintion SMS
+   * @param {!string} params.message - Message to pagination
+   * @param {!number} params.limitSize=130 - Limit of the start pagination
+   * @param {!number} params.continueText=continua... - Text to continue other SMS
+   */
+  _paginationOfTheSMS(params) {
+    const self = this;
+    try {
+      Joi.assert(params, Joi.object().required(), 'Params to paginate SMS');
+      Joi.assert(params.message, Joi.string(), 'Message to pagination');
+      Joi.assert(params.limitSize, Joi.number(), 'Limit of the start pagination');
+      Joi.assert(params.continueText, Joi.string(), 'Text to continue other SMS');
+      const defaultSize = 130;
+      const defaultContinue = 'continua...';
+      const { message, limitSize = defaultSize, continueText = defaultContinue } = params;
+      const size = limitSize - continueText.length;
+      const regex = new RegExp(`.{1,${size}}`, 'g');
+      const smsData = message.match(regex).map(item => item.trim());
+      const smsDataWithContinue = smsData.map((message, index, arr) => {
+        return index !== (arr.length - 1)
+          ? `${message} ${continueText}`
+          : message;
+      });
+      return smsDataWithContinue;
+    } catch (ex) {
+      throw ex;
+    }
+  }
+  /**
+   * @description Validation struct to send email
+   * @param {!object} params - Params to send email
+   * @param {!string} params.subject - Subject of the email
+   * @param {!string} params.message - Body of the email
+   * @param {!string} params.to - Destination email
+   * @param {?string} params.from - Source email
+   */
+  _validItemToSendEmail(params) {
+    try {
+      Joi.assert(params, Joi.object().required(), 'Params to send email');
+      Joi.assert(params.subject, Joi.string().required(), 'Subject of the email');
+      Joi.assert(params.message, Joi.string().required(), 'Body of the email');
+      Joi.assert(params.to, Joi.string().required(), 'Destination email');
+      Joi.assert(params.from, Joi.string(), 'Source email');
+      return true;
+    } catch (ex) {
+      throw ex;
+    }
+  }
+  /**
+   * @description Send an SMS message
+   * @param {!object} params - Params to send SMS
+   * @param {!string} params.apiKey - Organization API key
+   * @param {!string} params.message - The text message to send
+   * @param {!string} params.recipient - The telephone number without with only numbers
+   * @param {?number} params.limitSize=130 - Size limit to send SMS
+   * @return {Promise&lt;{}>}
+   */
+  async sendSMS(params) {
+    const self = this;
+    try {
+      Joi.assert(params, Joi.object().required(), 'Params to send SMS');
+      Joi.assert(params.apiKey, Joi.string().required(), 'Organization API key');
+      Joi.assert(params.message, Joi.string().required(), 'The text message to send');
+      Joi.assert(params.recipient, Joi.string().required(), 'The telephone number without with only numbers');
+      Joi.assert(params.limitSize, Joi.number(), 'Size limit to send SMS');
+      const defaultSize = 130;
+      const { apiKey, message, recipient, limitSize = defaultSize } = params;
+      const paramsOfThePagination = { message, limitSize };
+      const smsData = self._paginationOfTheSMS(paramsOfThePagination);
+      for await (const smsText of smsData) {
+        const payload = { apiKey, data: { message: smsText }, recipient };
+        await self.client.post('/sms/send', payload);
+      }
+      return { success: true, send: smsData.length };
+    } catch (ex) {
+      throw ex;
+    }
+  }
+  /**
+   * @description Send email, array with email list or send one email
+   * @param {!object} params - Params to send email
+   * @param {!string} params.subject - Subject of the email
+   * @param {!string} params.message - Body of the email
+   * @param {!string} params.to - Destination email
+   * @param {?string} params.from - Source email
+   * @param {string} session - Session, token JWT
+   * @return {Promise&lt;{success: boolean, sent: object[]}>} - Success and email sent
+   * @example
+   *
+   * const API = require('@docbrasil/api-systemmanager');
+   * const api = new API();
+   * const params = {
+   *  subject: 'Test email',
+   *  message: '&lt;h1>Hi!&lt;/h1>',
+   *  to: 'destination@gmail.com'
+   * };
+   * const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
+   * await api.admin.message.sendEmail(params, session);
+   */
+  async sendEmail(params, session) {
+    const self = this;
+    try {
+      Joi.assert(session, Joi.string().required(), 'Session, token JWT');
+      let emailList = [];
+      const emailSent = [];
+      if (Array.isArray(params)) {
+        params.forEach(element => self._validItemToSendEmail(element));
+        emailList = [...params];
+      } else {
+        self._validItemToSendEmail(params);
+        emailList = [params];
+      }
+      for await (const email of emailList) {
+        await self.client.post('/admin/email', email, self._setHeader(session));
+        emailSent.push(email);
+      }
+      return { success: true, sent: emailSent };
+    } catch (ex) {
+      throw ex;
+    }
+  }
+}
+export default AdminMessage;
+</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/admin_notification.js.html ADDED Viewed

@@ -0,0 +1,350 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="utf-8">
+  <meta name="viewport" content="width=device-width, initial-scale=1">
+  <title> admin/notification.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>admin/notification.js</h1>
+                </header>
+    <section>
+        <article>
+            <pre class="prettyprint source linenums"><code>import _ from 'lodash';
+import Boom from '@hapi/boom';
+import Joi from 'joi';
+/**
+ * Admin Class for notification, permission admin
+ * @class
+ */
+class AdminNotification {
+  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,
+      }
+    };
+  }
+  /**
+   * @description Send real time notification
+   * @param {object} params Params to send notification
+   * @param {string} params.userIds Users to send notification
+   * @param {object} params.message Object with data to send user
+   * @param {object} session Session, token JWT
+   * @returns {Promise&lt;*>}
+   */
+  async realTime(params, session) {
+    const self = this;
+    try {
+      Joi.assert(params, Joi.object().required(), 'Object with params to add notifications');
+      Joi.assert(params.userIds, Joi.array().required(), 'OrgId of the user SU');
+      Joi.assert(params.message, Joi.object().required(), 'Object with data to send user');
+      Joi.assert(session, Joi.string().required(), 'Session, token JWT');
+      const apiCall = self.client.post(`/admin/send/notifications`, params, self._setHeader(session));
+      return self._returnData(await apiCall);
+    } catch (ex) {
+      throw ex;
+    }
+  }
+  /**
+   * @author CloudBrasil &lt;abernardo.br@gmail.com>
+   * @description Create notification
+   * @param {object} params Params to create notification
+   * @param {string} params.orgId OrgId of the user SU
+   * @param {string} params.userId User to create notification
+   * @param {object} params.message Object with data to send user
+   * @param {string} session Session, token JWT
+   * @return {Promise}
+   * @public
+   * @async
+   * @example
+   *
+   * const API = require('@docbrasil/api-systemmanager');
+   * const api = new API();
+   * const params = {
+   *  orgId: '5edd11c46b6ce9729c2c297c',
+   *  userId: '55e4a3bd6be6b45210833fae',
+   *  message: 'Olá como vai tudo bem?'
+   * };
+   * const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
+   * await api.admin.notifications.add(params, session);
+   */
+  async add(params, session) {
+    const self = this;
+    try {
+      Joi.assert(params, Joi.object().required(), 'Object with params to add notifications');
+      Joi.assert(params.orgId, Joi.string().required(), 'OrgId of the user SU');
+      Joi.assert(params.userId, Joi.string().required(), 'User to create notification');
+      Joi.assert(params.message, Joi.object().required(), 'Object with data to send user');
+      Joi.assert(session, Joi.string().required(), 'Session, token JWT');
+      const {orgId, ...notificationPayload} = params;
+      const apiCall = self.client.post(`/admin/organizations/${orgId}/notifications`, notificationPayload, self._setHeader(session));
+      return self._returnData(await apiCall);
+    } catch (ex) {
+      throw ex;
+    }
+  }
+  /**
+   * @author CloudBrasil &lt;abernardo.br@gmail.com>
+   * @description Search notification using (notificationId or userId)
+   * @param {object} params Params to create notification
+   * @param {string} params.orgId OrgId of the user SU
+   * @param {string} params.id ALERT! Id is userId or id is notificationId
+   * @param {string} session Session, token JWT
+   * @return {Promise}
+   * @public
+   * @async
+   * @example
+   *
+   * const API = require('@docbrasil/api-systemmanager');
+   * const api = new API();
+   * const params = {
+   *  orgId: '5edd11c46b6ce9729c2c297c',
+   *  id: '55e4a3bd6be6b45210833fae',
+   * };
+   * const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
+   * await api.admin.notifications.findById(params, session);
+   */
+  async findById(params, session) {
+    const self = this;
+    try {
+      Joi.assert(params, Joi.object().required(), 'Object with params to add notifications');
+      Joi.assert(params.orgId, Joi.string().required(), 'OrgId of the user SU');
+      Joi.assert(params.id, Joi.string().required(), 'ALERT! Id is userId or id is notificationId');
+      Joi.assert(session, Joi.string().required(), 'Session, token JWT');
+      const {orgId, id} = params;
+      const apiCall = self.client.get(`/admin/organizations/${orgId}/notifications/${id}`, self._setHeader(session));
+      return self._returnData(await apiCall);
+    } catch (ex) {
+      throw ex;
+    }
+  }
+  /**
+   * @author CloudBrasil &lt;abernardo.br@gmail.com>
+   * @description Update notification using (notificationId or userId)
+   * @param {object} params Params to create notification
+   * @param {string} params.orgId OrgId of the user SU
+   * @param {string} params.id ALERT! Id is userId or id is notificationId
+   * @param {boolean} params.read If message is read true or false
+   * @param {string} session Session, token JWT
+   * @return {Promise}
+   * @public
+   * @async
+   * @example
+   *
+   * const API = require('@docbrasil/api-systemmanager');
+   * const api = new API();
+   * const params = {
+   *  orgId: '5edd11c46b6ce9729c2c297c',
+   *  id: '55e4a3bd6be6b45210833fae',
+   *  read: true
+   * };
+   * const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
+   * await api.admin.notifications.findByIdAndUpdate(params, session);
+   */
+  async findByIdAndUpdate(params, session) {
+    const self = this;
+    try {
+      Joi.assert(params, Joi.object().required(), 'Object with params to add notifications');
+      Joi.assert(params.orgId, Joi.string().required(), 'OrgId of the user SU');
+      Joi.assert(params.id, Joi.string().required(), 'ALERT! Id is userId or id is notificationId');
+      Joi.assert(params.read, Joi.boolean().required(), 'If message is read true or false');
+      Joi.assert(session, Joi.string().required(), 'Session, token JWT');
+      const {orgId, id, ...statusPayload} = params;
+      const apiCall = self.client.put(`/admin/organizations/${orgId}/notifications/${id}`, statusPayload, self._setHeader(session));
+      return self._returnData(await apiCall);
+    } catch (ex) {
+      throw ex;
+    }
+  }
+  /**
+   * @author CloudBrasil &lt;abernardo.br@gmail.com>
+   * @description Delete notification using (notificationId or userId)
+   * @param {object} params Params to create notification
+   * @param {string} params.orgId OrgId of the user SU
+   * @param {string} params.id ALERT! Id is userId or id is notificationId
+   * @param {string} session Session, token JWT
+   * @return {Promise}
+   * @public
+   * @async
+   * @example
+   *
+   * const API = require('@docbrasil/api-systemmanager');
+   * const api = new API();
+   * const params = {
+   *  orgId: '5edd11c46b6ce9729c2c297c',
+   *  id: '55e4a3bd6be6b45210833fae',
+   * };
+   * const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
+   * await api.admin.notifications.findByIdAndDelete(params, session);
+   */
+  async findByIdAndRemove(params, session) {
+    const self = this;
+    try {
+      Joi.assert(params, Joi.object().required(), 'Object with params to add notifications');
+      Joi.assert(params.orgId, Joi.string().required(), 'OrgId of the user SU');
+      Joi.assert(params.id, Joi.string().required(), 'ALERT! Id is userId or id is notificationId');
+      Joi.assert(session, Joi.string().required(), 'Session, token JWT');
+      const {orgId, id} = params;
+      const apiCall = self.client.delete(`/admin/organizations/${orgId}/notifications/${id}`, self._setHeader(session));
+      return self._returnData(await apiCall);
+    } catch (ex) {
+      throw ex;
+    }
+  }
+}
+export default AdminNotification;
+</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>