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

@docbrasil/api-systemmanager 1.0.106 → 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 (76) hide show

package/.github/workflows/static.yml +43 -0
package/api/external.js +41 -0
package/api/user/process.js +44 -0
package/api/user/task.js +1 -0
package/api/user/task_available.js +1 -1
package/dist/bundle.cjs +87 -1
package/dist/bundle.mjs +1 -1
package/doc/api.md +412 -1
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_document.js.html ADDED Viewed

@@ -0,0 +1,847 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="utf-8">
+  <meta name="viewport" content="width=device-width, initial-scale=1">
+  <title> user/document.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/document.js</h1>
+                </header>
+    <section>
+        <article>
+            <pre class="prettyprint source linenums"><code>import _ from 'lodash';
+import Boom from '@hapi/boom';
+import Joi from 'joi';
+import Moment from 'moment';
+/**
+ * Class for documents, permission user
+ * @class
+ */
+class Documents {
+  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) {
+      throw 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 Create document with informed data
+   * @param {object} params Object for add new document
+   * @param {string} params.orgname Organization name
+   * @param {string} params.areaId Doc area id (_id database)
+   * @param {string} params.docId Document id (_id database)
+   * @param {string} [params.documentDate=new\ Date()] Date of document
+   * @param {string} params.filename File name
+   * @param {string} params.type Mimetype of the document (image/png)
+   * @param {string} params.name Doument name
+   * @param {string} [params.content=''] Content of document
+   * @param {string} [params.description=''] Description of document
+   * @param {string} [params.category=''] Category of document
+   * @param {array} [params.tags=[]] Tags of document
+   * @param {string} params.docTypeId Document type id (_id database)
+   * @param {boolean} [params.hasPhisicalStorage=false] Has Phisical Storage
+   * @param {string} [params.boxId=''] Box ID
+   * @param {string} [params.storageStatus=''] Storage status
+   * @param {boolean} [params.ocrDocumentBackend=false] Ocr document backend
+   * @param {number} params.bytes Size document in bytes
+   * @param {object} [params.docAreaPermission={}] Permission to doc area
+   * @param {object} [params.docTypeFieldsData={}] Fields data "extraField'
+   * @param {string} params.signedUrl SIgned URL
+   * @param {string} [params.urlType='S3'] URL type
+   * @param {string} [params.addType='S3_SIGNED'] Add type
+   * @return {{documentDate: *, docId: *, docAreaPermission: *, document: *, docTypeFieldsData: *, description: *, storageStatus: *, type: *, content: *, tags: *, addType: *, urlType: *, areaId: *, orgname: *, docTypeId: *, bytes: *, name: *, category: *, hasPhisicalStorage: *, signedUrl: *, ocrDocumentBackend: *, boxId: *}}
+   * @private
+   */
+  _formatDocument(params) {
+    try {
+      return {
+        orgname: _.get(params, 'orgname'),
+        areaId: _.get(params, 'areaId'),
+        docId: _.get(params, 'docId'),
+        documentDate: _.get(params, 'documentDate', Moment().format()),
+        document: _.get(params, 'document'),
+        type: _.get(params, 'type'),
+        name: _.get(params, 'name'),
+        content: _.get(params, 'content', ''),
+        description: _.get(params, 'description', ''),
+        category: _.get(params, 'category', ''),
+        tags: _.get(params, 'tags', []),
+        docTypeId: _.get(params, 'docTypeId'),
+        hasPhisicalStorage: _.get(params, 'hasPhisicalStorage', false),
+        boxId: _.get(params, 'boxId', ''),
+        storageStatus: _.get(params, 'storageStatus', ''),
+        ocrDocumentBackend: _.get(params, 'ocrDocumentBackend', false),
+        bytes: _.get(params, 'bytes'),
+        docAreaPermission: _.get(params, 'docAreaPermission', {}),
+        docTypeFields: _.get(params, 'docTypeFields', []), // {"extraId": userId},
+        docTypeFieldsData: _.get(params, 'docTypeFieldsData', {}), // {"extraId": userId},
+        signedUrl: _.get(params, 'signedUrl', ''),
+        urlType: _.get(params, 'urlType', 'S3'),
+        addType: _.get(params, 'addType', 'S3_SIGNED'),
+      };
+    } catch (ex) {
+      throw ex;
+    }
+  }
+  /**
+   * @author CloudBrasil &lt;abernardo.br@gmail.com>
+   * @description Transform objtect query in query string
+   * @param {object} searchQuery object wicth query
+   * @return {string} Retutn string query
+   * @private
+   */
+  _queryReducer(searchQuery) {
+    return Object.keys(searchQuery).reduce((query, key, idx, sourceList) => {
+      idx++;
+      const data = key === 'ix'
+        ? JSON.stringify(searchQuery[key])
+        : searchQuery[key];
+      const querySearch = sourceList.length === idx
+        ? `${key}=${data}`
+        : `${key}=${data}&amp;`;
+      query += querySearch;
+      return query;
+    }, '');
+  }
+  /**
+   * @author CloudBrasil &lt;abernardo.br@gmail.com>
+   * @description Create new document
+   * @param {object} params Object for add new document
+   * @param {string} params.orgname Organization name
+   * @param {string} params.areaId Doc area id (_id database)
+   * @param {string} params.docId Document id (_id database)
+   * @param {string} [params.documentDate=new Date()] Date of document
+   * @param {string} params.document The path to the file. If S3, the key to S3, gotten after getting a signed URL
+   * @param {string} params.filename File name
+   * @param {string} params.type Mimetype of the document (image/png)
+   * @param {string} params.name Document name
+   * @param {string} [params.content=''] Content of document
+   * @param {string} [params.description=''] Description of document
+   * @param {string} [params.category=''] Category of document
+   * @param {array} [params.tags=[]] Tags of document
+   * @param {string} params.docTypeId Document type id (_id database)
+   * @param {boolean} [params.hasPhisicalStorage=false] Has Phisical Storage
+   * @param {string} [params.boxId=''] Box ID
+   * @param {string} [params.storageStatus=''] Storage status
+   * @param {boolean} [params.ocrDocumentBackend=false] Ocr document backend
+   * @param {number} params.bytes Size document in bytes
+   * @param {object} [params.docAreaPermission={}] Permission to doc area
+   * @param {object} [params.docTypeFieldsData={}] Fields data "extraField'
+   * @param {string} params.signedUrl SIgned URL
+   * @param {string} [params.urlType='S3'] URL type
+   * @param {string} [params.addType='S3_SIGNED'] Add type
+   * @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 = {
+   *  orgname: 'cloundbrasil',
+   *  areaId: '5edf9f8ee896b817e45b8dac',
+   *  docId: '5edf86fbe896b817e45b8da6',
+   *  fileName: 'foto',
+   *  type: 'image/png',
+   *  name: 'Fotografia',
+   *  docTypeId = '5edf9f8ee896b817e45b8dac',
+   *  bytes: 12345,
+   *  signedUrl: 'https://s3.amazonaws.com...'
+   *  docTypeFieldsData: {extraUser: '12349f8ee896b817e45b8dac'},
+   *  orgId: '5df7f19618430c89a41a19d2',
+   * };
+   * const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
+   * await api.user.document.add(params, session);
+   */
+  async add(params, session) {
+    const self = this;
+    try {
+      Joi.assert(params, Joi.object().required().error(new Error('params is required')));
+      Joi.assert(params.orgname, Joi.string().required().error(new Error('orgname is required')));
+      Joi.assert(params.areaId, Joi.string().required().error(new Error('areaId is required')));
+      Joi.assert(params.docId, Joi.string().required().error(new Error('docId is required')));
+      Joi.assert(params.type, Joi.string().required().error(new Error('type is required')));
+      Joi.assert(params.name, Joi.string().required().error(new Error('name is required')));
+      Joi.assert(params.docTypeId, Joi.string().required().error(new Error('docTypeId is required')));
+      Joi.assert(params.bytes, Joi.number().required().error(new Error('bytes is required')));
+      Joi.assert(params.orgId, Joi.string().required().error(new Error('orgId is required')));
+      Joi.assert(session, Joi.string().required().error(new Error('session is required')));
+      // Get fields required, and set data default to create document
+      const payloadToSend = self._formatDocument(params);
+      Joi.assert(payloadToSend.documentDate, Joi.string().allow('').error(new Error('documentData is required after formatting payload')));
+      Joi.assert(payloadToSend.content, Joi.string().allow('').error(new Error('content is required after formatting payload')));
+      Joi.assert(payloadToSend.description, Joi.string().allow('').error(new Error('description is required after formatting payload')));
+      Joi.assert(payloadToSend.category, Joi.string().allow('').error(new Error('catetory is required after formatting payload')));
+      Joi.assert(payloadToSend.tags, Joi.array().error(new Error('tags is required after formatting payload')));
+      Joi.assert(payloadToSend.hasPhisicalStorage, Joi.boolean().error(new Error('hasPhisicalStorage is required after formatting payload')));
+      Joi.assert(payloadToSend.boxId, Joi.string().allow('').error(new Error('boxId is required after formatting payload')));
+      Joi.assert(payloadToSend.storageStatus, Joi.string().allow('').error(new Error('storageStatus is required after formatting payload')));
+      Joi.assert(payloadToSend.ocrDocumentBackend, Joi.boolean().error(new Error('ocrDocumentBackend is required after formatting payload')));
+      Joi.assert(payloadToSend.docAreaPermission, Joi.object().allow({}).error(new Error('docAreaPermission is required after formatting payload')));
+      Joi.assert(payloadToSend.docTypeFieldsData, Joi.object().allow({}).error(new Error('docTypeFieldsData is required after formatting payload')));
+      Joi.assert(payloadToSend.urlType, Joi.string().allow('').error(new Error('urlType is required after formatting payload')));
+      Joi.assert(payloadToSend.addType, Joi.string().allow('').error(new Error('addType is required after formatting payload')));
+      const {areaId, orgId} = params;
+      const apiCall = self._client
+        .put(`/organizations/${orgId}/areas/${areaId}/documents`, payloadToSend, self._setHeader(session));
+      return self._returnData(await apiCall);
+    } catch (ex) {
+      throw ex;
+    }
+  }
+  /**
+   * @author CloudBrasil &lt;abernardo.br@gmail.com>
+   * @param {object} params Object with params
+   * @param {string} params.index Field to search
+   * @param {string} params.txtToSearch Text to search
+   * @param {string} [params.compare=*] Filter to search (=, ~, *, =*, *=, *?)
+   * @param {string} params.docId Document id for serach
+   * @param {string} params.docAreaId Doc area id
+   * @param {string} params.tag Tag of the document
+   * @param {string} [params.projection=""] Projection to return fields
+   * @param {string} [params.sort="Mais+recentes"] Sort data
+   * @param {string} params.orgId Organization id (_id database)
+   * @param {string} params.pagination Set pagination
+   * @param {number} [params.pagination.page=1] Page
+   * @param {number} [params.pagination.perPage=100] perPage Itens per page
+   * @param {string} session Session, token JWT
+   * @return {Promise}
+   * @public
+   * @async
+   * @example
+   *
+   * const API = require('@docbrasil/api-systemmanager');
+   * const api = new API();
+   * const params - {
+   *  index: 'extraCity',
+   *  txtToSearch: 'São',
+   *  docId: '5df7f19618430c89a41a19d2',
+   *  docAreaId: '5edd11c46b6ce9729c2c297c',
+   *  tag: 'Nome da cidade',
+   *  orgId: '1234d01dc4af3941d42f8c5c'
+   * };
+   * const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
+   * await api.user.document.findByIdAndRemove(params, session);
+   */
+  async find(params, session) {
+    const self = this;
+    try {
+      Joi.assert(params, Joi.object().required());
+      Joi.assert(params.index, Joi.string().required());
+      Joi.assert(params.txtToSearch, Joi.string().allow(null));
+      Joi.assert(params.compare, Joi.string().allow(null));
+      Joi.assert(params.docId, Joi.string().required());
+      Joi.assert(params.docAreaId, Joi.string().required());
+      Joi.assert(params.tag, Joi.string().required());
+      Joi.assert(params.projection, Joi.string());
+      Joi.assert(params.orgId, Joi.string().required());
+      Joi.assert(params.sort, Joi.string());
+      if (_.hasIn(params, 'pagination')) {
+        Joi.assert(params.pagination, Joi.object());
+        Joi.assert(params.pagination.page, Joi.number());
+        Joi.assert(params.pagination.perPage, Joi.number());
+      }
+      Joi.assert(session, Joi.string().required());
+      const orgId = _.get(params, 'orgId');
+      const index = _.get(params, 'index');
+      const txtToSearch = _.get(params, 'txtToSearch', null);
+      const compare = _.get(params, 'compare', '*');
+      const tag = _.get(params, 'tag');
+      const defaultSearch = {
+        p: 100,             // Per page
+        i: 1,               // Initial page
+        s: 'Mais+recentes', // Sort to search
+        ai: '',             // Doc Area Id lists emprego_net
+        di: '',             // Document Type Id
+        m: 'w',             // Default
+        pj: ''              // Projection
+      };
+      // Mount query to search autocomplete
+      defaultSearch.p = _.get(params, 'pagination.perPage', 100);
+      defaultSearch.i = _.get(params, 'pagination.page', 1);
+      defaultSearch.s = _.get(params, 'sort', 'Mais+recentes');
+      defaultSearch.ai = _.get(params, 'docAreaId');
+      defaultSearch.di = _.get(params, 'docId');
+      defaultSearch.pj = `_id,${_.get(params, 'projection', '')}`;
+      if (!_.isNull(txtToSearch)) {
+        defaultSearch.ix = {ix: [[index, txtToSearch, compare, 'string', tag]]};
+      }
+      const query = self._queryReducer(defaultSearch);
+      const apiCall = self._client.get(`/organizations/${orgId}/documents/search?${query}`, self._setHeader(session));
+      return self._returnData(await apiCall);
+    } catch (ex) {
+      throw ex;
+    }
+  }
+  /**
+   * @author CloudBrasil &lt;abernardo.br@gmail.com>
+   * @description Remove document by id
+   * @param {object} params Params to remove document
+   * @param {string} params.docId Document Id (_id database)
+   * @param {string} params.orgId Organizarion id (_id database)
+   * @param {string} session Session, token JWT
+   * @return {Promise&lt;object>} data The returned data
+   * @return {number} data.removed The quantity of removed documents
+   * @return {array&lt;object>} data.errors Array of errors
+   * @return {string} data.errors.id Id of the document that had an error
+   * @return {string} data.errors.code Error code
+   * @return {string} data.errors.message Error message
+   * @public
+   * @async
+   * @example
+   *
+   * const API = require('@docbrasil/api-systemmanager');
+   * const api = new API();
+   * const params - {
+   *  docId: '5dadd01dc4af3941d42f8c5c',
+   *  orgIdId: '5df7f19618430c89a41a19d2',
+   * };
+   * const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
+   * await api.user.document.findByIdAndRemove(params, session);
+   */
+  async findByIdAndRemove(params, session) {
+    const self = this;
+    try {
+      Joi.assert(params, Joi.object().required());
+      Joi.assert(params.docId, Joi.string().required());
+      Joi.assert(params.orgId, Joi.string().required());
+      Joi.assert(session, Joi.string().required());
+      const {docId, orgId} = params;
+      const payloadToSend = {documents: [{_id: docId}]};
+      const apiCall = self._client.post(`/organizations/${orgId}/documents/remove`, payloadToSend, self._setHeader(session));
+      return self._returnData(await apiCall);
+    } catch (ex) {
+      throw ex;
+    }
+  }
+  /**
+   * @author CloudBrasil &lt;abernardo.br@gmail.com>
+   * @description Remove documents
+   * @param {object} params Params to remove document
+   * @param {array&lt;string>} params.documents An array ids of documents (_id database)
+   * @param {array&lt;string>} params.documents._id The document id (_id database)
+   * @param {string} params.orgId Organizarion id (_id database)
+   * @param {string} session Session, token JWT
+   * @return {Promise&lt;object>} data The returned data
+   * @return {number} data.removed The quantity of removed documents
+   * @return {array&lt;object>} data.errors Array of errors
+   * @return {string} data.errors.id Id of the document that had an error
+   * @return {string} data.errors.code Error code
+   * @return {string} data.errors.message Error message
+   * @public
+   * @async
+   * @example
+   *
+   * const API = require('@docbrasil/api-systemmanager');
+   * const api = new API();
+   * const params - {
+   *  documents: [{ _id: '5dadd01dc4af3941d42f8c5c' }],
+   *  orgId: '5df7f19618430c89a41a19d2',
+   * };
+   * const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
+   * await api.user.document.findByIdsAndRemove(params, session);
+   */
+  async findByIdsAndRemove(params, session) {
+    const self = this;
+    try {
+      Joi.assert(params, Joi.object().required());
+      Joi.assert(params.documents, Joi.array().required());
+      Joi.assert(params.orgId, Joi.string().required());
+      Joi.assert(session, Joi.string().required());
+      const {documents, orgId} = params;
+      const payloadToSend = { documents };
+      const apiCall = self._client.post(`/organizations/${orgId}/documents/remove`, payloadToSend, self._setHeader(session));
+      return self._returnData(await apiCall);
+    } catch (ex) {
+      throw ex;
+    }
+  }
+  /**
+   *
+   * @author CloudBrasil &lt;abernardo.br@gmail.com>
+   * @description Request signed url url to put or get
+   * @param {object} params Params to request signed url
+   * @param {string} params.methodType Method type HTTP get or put
+   * @param {string} params.docId Document id
+   * @param {string} params.fileName File name
+   * @param {string} params.docAreaId docAreaId of the document
+   * @param {string} params.type mimeType image/png image/jpg others
+   * @param {string} params.document Name document to request if method type is get
+   * @param {string} params.orgId Organization id (_id database)
+   * @param {string} session Session, token JWT
+   * @return {Promise&lt;object>} doc Returned document data with the signed url
+   * @return {string} doc.docId Document id
+   * @return {string} doc.name The name of the document, which is the fileName
+   * @return {string} doc.areaId docAreaId of the document
+   * @return {string} doc.type the document mimi type
+   * @return {string} doc.signedUrl the signed URL to upload
+   * @public
+   * @async
+   * @example
+   *
+   * const API = require('@docbrasil/api-systemmanager');
+   * const api = new API();
+   * const params - {
+   *  methodType: 'put',
+   *  docId: '5dadd01dc4af3941d42f8c5c',
+   *  docAreaId: '5df7f19618430c89a41a19d2',
+   *  fileName: 'Foto',
+   *  type: 'image/png'
+   *  orgId: '5df7f19618430c89a41a19f8'
+   * };
+   * const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
+   * // each doc: { docId, name, areaId, type, signedUrl }
+   * const { docs } = await api.user.document.signedUrl(params, session);
+   *
+   * @example
+   *
+   * const API = require('@docbrasil/api-systemmanager');
+   * const api = new API();
+   * const params - {
+   *  methodType: 'get',
+   *  document: 'pinkandthebrain/5df7f19618430c89a41a19d2/5dadd01dc4af3941d42f8c5c/9dadd01dc4af3941d42f6dd4.pdf',
+   * };
+   * const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
+   * const base64Data = await api.user.document.signedUrl(params, session);
+   */
+  async signedUrl(params, session) {
+    const self = this;
+    try {
+      Joi.assert(params, Joi.object().required());
+      Joi.assert(params.methodType, Joi.string().required());
+      Joi.assert(params.orgId, Joi.string().required());
+      Joi.assert(session, Joi.string().required());
+      const {methodType} = params;
+      if (methodType === 'put') {
+        Joi.assert(params, Joi.object().required());
+        Joi.assert(params.docId, Joi.string().required());
+        Joi.assert(params.docAreaId, Joi.string().required());
+        Joi.assert(params.fileName, Joi.string().required());
+        Joi.assert(params.type, Joi.string().required());
+      } else {
+        Joi.assert(params.document, Joi.string().required());
+      }
+      const {orgId} = params;
+      let payloadToSend;
+      if (params.methodType === 'put') {
+        const {docId, fileName: name, docAreaId: areaId, type} = params;
+        payloadToSend = {docs: [{docId, name, areaId, type}]};
+      } else {
+        const {document} = params;
+        payloadToSend = {docs: [{document}]};
+      }
+      const apiCall = self._client
+        .post(`/organizations/${orgId}/documents/getDocumentSignedUrl/${methodType}`, payloadToSend, self._setHeader(session));
+      return self._returnData(await apiCall);
+    } catch (ex) {
+      throw ex;
+    }
+  }
+  /**
+   *
+   * @author CloudBrasil &lt;abernardo.br@gmail.com>
+   * @description Request signed url url to put or get
+   * @param {object} params Params to request signed url
+   * @param {array} params.docs the list of documents to get the signed urls
+   * @param {string} params.docs.docId Document id
+   * @param {string} params.docs.name File name
+   * @param {string} params.docs.areaId docAreaId of the document
+   * @param {string} params.docs.type mimeType image/png image/jpg others
+   * @param {string} params.docs.document Name document to request if method type is get
+   * @param {string} params.methodType Method type HTTP get or put
+   * @param {string} params.orgId Organization id (_id database)
+   * @param {string} session Session, token JWT
+   * @return {Promise&lt;object>} doc Returned document data with the signed url
+   * @return {string} doc.docId Document id
+   * @return {string} doc.name The name of the document, which is the fileName
+   * @return {string} doc.areaId docAreaId of the document
+   * @return {string} doc.type the document mimi type
+   * @return {string} doc.signedUrl the signed URL to upload
+   * @public
+   * @async
+   * @example
+   *
+   * const API = require('@docbrasil/api-systemmanager');
+   * const api = new API();
+   * const params - {
+   *  methodType: 'put',
+   *  orgId: '5df7f19618430c89a41a19f8'
+   *  docs: [
+   *      {
+   *        docId: '5dadd01dc4af3941d42f8c5c',
+   *        areaId: '5df7f19618430c89a41a19d2',
+   *        name: 'Foto.png',
+   *        type: 'image/png'
+   *      }
+   *  ]
+   * };
+   * const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
+   * // each doc: { docId, name, areaId, type, signedUrl }
+   * const { docs } = await api.user.document.signedUrls(params, session);
+   *
+   * @example
+   *
+   * const API = require('@docbrasil/api-systemmanager');
+   * const api = new API();
+   * const params - {
+   *  methodType: 'get',
+   *  docs: [
+   *      { document: 'pinkandthebrain/5df7f19618430c89a41a19d2/5dadd01dc4af3941d42f8c5c/9dadd01dc4af3941d42f6dd4.pdf' }
+   *  ],
+   * };
+   * const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
+   * const base64Data = await api.user.document.signedUrls(params, session);
+   */
+  async signedUrls(params, session) {
+    const self = this;
+    try {
+      Joi.assert(params, Joi.object().required());
+      Joi.assert(params.docs, Joi.array().required());
+      Joi.assert(params.orgId, Joi.string().required());
+      Joi.assert(session, Joi.string().required());
+      const {orgId, methodType = 'put', docs = []} = params;
+      const apiCall = self._client
+          .post(`/organizations/${orgId}/documents/getDocumentSignedUrl/${methodType}`, { docs }, self._setHeader(session));
+      return self._returnData(await apiCall);
+    } catch (ex) {
+      throw ex;
+    }
+  }
+  /**
+   * Uploads the file
+   * @param {object} params Params to upload document
+   * @param {buffer} params.content The content of the file (Buffer)
+   * @param {string} params.signedUrl The signed URL
+   * @param {string} params.type The file mime type
+   * @param {string} params.onUploadProgress A callback for the upload progress. It will return a progressEvent.
+   * @return {Promise&lt;boolean>} True if success
+   *
+   * @public
+   * @async
+   * @example
+   *
+   * const FS = require('fs');
+   * const Path = require('path');
+   * const API = require('@docbrasil/api-systemmanager');
+   * const api = new API();
+   * const params - {
+   *  content: FS.readFileSync(Path.join(__dirname, '.mypdf.pdf')),
+   *  signedUrl: 'https://signedurl.com/token...',
+   *  type: 'application/pdf'
+   * };
+   * const retData = await api.user.document.uploadSignedDocument(params);
+   *
+   * onUploadProgress return the progressEvent
+   *  - lengthComputable: A Boolean that indicates whether or not the total number of bytes is known.
+   *  - loaded: The number of bytes of the file that have been uploaded.
+   *  - total: The total number of bytes in the file.
+   */
+  async uploadSignedDocument(params= {}) {
+    const { content, signedUrl, type } = params;
+    Joi.assert(params, Joi.object().required());
+    Joi.assert(params.content, Joi.required());
+    Joi.assert(params.signedUrl, Joi.string().required());
+    Joi.assert(params.type, Joi.string().required());
+    const self = this;
+    const reqOpts = {
+      headers: {
+        'Content-Type': type
+      },
+      maxContentLength: Infinity,
+      maxBodyLength: Infinity
+    };
+    const onUploadProgress = params.onUploadProgress;
+    if(onUploadProgress) {
+      reqOpts.onUploadProgress = onUploadProgress;
+    }
+    const apiCall = self._client
+        .put(signedUrl, content, reqOpts);
+    self._returnData(await apiCall);
+    return true;
+  }
+  /**
+   * @author CloudBrasil &lt;abernardo.br@gmail.com>
+   * Checks if a document can be added and it does not repeat its primary key
+   * @param params
+   * @param params.orgId {string} the organization id
+   * @param params.docTypeId {string} the id of the doc type
+   * @param params.docs {array&lt;object>} an array of documents
+   * @param params.docs.id {string} an unique id representing the document
+   * @param params.docs.docTypeFields {object} thje docTypeFields of the document
+   * @param params.docs.docTypeFieldsData {object} thje docTypeFieldsData of the document
+   * @param session
+   * @return {Promise&lt;array>} Return the array of the documents that are repeated. If not document is repeaded, then if returns an empty array.
+   * @return id {array&lt;string>} the id of the repeated document
+   * @public
+   * @async
+   * @example
+   *
+   * const API = require('@docbrasil/api-systemmanager');
+   * const api = new API();
+   * const docTypeFields = [...];   // the doc type fields array
+   * const docTypeFieldsData = {...};   // the data of this fields
+   * const params - {
+   *  docs: [{ id: '5dadd01dc4af3941d42f8c5c', docTypeFields, docTypeFieldsData }],
+   *  orgId: '5df7f19618430c89a41a19d2',
+   *  docTypeId: '5df7f19618430c89a41a19d5',
+   * };
+   * const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
+   * const retDocs = await api.user.document.checkPrimaryKeys(params, session);
+   *
+   */
+  async checkPrimaryKeys(params, session) {
+    Joi.assert(params, Joi.object().required().label('params'));
+    Joi.assert(params.orgId, Joi.string().required().label('orgId'));
+    Joi.assert(params.docTypeId, Joi.string().required().label('docTypeId'));
+    Joi.assert(params.docs, Joi.array().required().label('docs'));
+    Joi.assert(session, Joi.string().required().label('session'));
+    const { docs = [], orgId = '',  docTypeId = '' } = params;
+    if(docs.length === 0) return;
+    try {
+      const self = this;
+      const payloadToSend = {
+        docs,
+        docTypeId
+      };
+      const apiCall = self._client.post(`/organizations/${orgId}/documents/can/add`, payloadToSend, self._setHeader(session));
+      return self._returnData(await apiCall);
+    } catch (ex) {
+      throw ex;
+    }
+  }
+  /**
+   * @author CloudBrasil &lt;abernardo.br@gmail.com>
+   * @description Method to search documents for
+   * @param {object} params Params to search the documents
+   * @param {object} params.query Search documents 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} took the number of documents taken
+   * @returns {number} totalCount the total count of all documents
+   * @public
+   * @example
+   *
+   * const API = require('@docbrasil/api-systemmanager');
+   * const api = new API();
+   * const params = {
+   *  query: {p: 20, i: 1, s: 'Mais recentes', as: '', m: 'w', ai: '57e6a3bd6be6b45210833fae'},
+   *  orgId: '55e4a3bd6be6b45210833fae',
+   * };
+   * const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
+   * const retSearch = await api.user.document.searchDocuments(params, session);
+   */
+  async searchDocuments(params, session) {
+    const self = this;
+    try {
+      Joi.assert(params, Joi.object().required(), 'Params to search the documents');
+      Joi.assert(params.query, Joi.object().required(), 'The query for the search documents');
+      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 = encodeURIComponent(JSON.stringify(query));
+      const apiCall = self._client.get(`/organizations/${orgId}/documents/search?${queryString}`, self._setHeader(session));
+      return self._returnData(await apiCall);
+    } catch (ex) {
+      throw ex;
+    }
+  }
+}
+export default Documents;
+</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>