@docbrasil/api-systemmanager 1.1.21 → 1.1.23

package/docs/admin_form.js.html

@@ -134,6 +134,32 @@ class AdminForm {
     };
   }
 
+   /**
+   * @author Myndware <augusto.pissarra@myndware.com>
+   * @description Get the types for forms
+   * @return {Promise}
+   * @public
+   * @async
+   * @example
+   *
+   * const API = require('@docbrasil/api-systemmanager');
+   * const api = new API();
+   * const params = {
+   *  id: '55e4a3bd6be6b45210833fae',
+   *  orgId: '5edd11c46b6ce9729c2c297c',
+   * };
+   * const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
+   * await api.admin.form.findById(params, session);
+   */
+   get types() {
+    return {
+       BUSINESS: 1,
+       ADVANCED: 2,
+       CHECKLIST: 3,
+       EXTERNAL: 4
+    };
+   }
+
   /**
    * @author Myndware <augusto.pissarra@myndware.com>
    * @description Get advance form by ID
@@ -209,7 +235,6 @@ class AdminForm {
       Joi.assert(params.sort, Joi.object(), 'Sort fields for');
       Joi.assert(session, Joi.string().required(), 'Session, token JWT');
 
-      const FORM_ADVANCED = 2;
       const PROJECTION_DEFAULT = {_id: 1, name: 1};
       const SORT_DEFAULT = {name: 1};
 
@@ -217,7 +242,7 @@ class AdminForm {
         orgId,
         page = 1,
         perPage = 200,
-        type = FORM_ADVANCED,
+        type = self.types.ADVANCED,
         project = PROJECTION_DEFAULT,
         sort = SORT_DEFAULT
       } = params;

package/docs/admin_user.js.html

@@ -359,6 +359,61 @@ class AdminUser {
       throw ex;
     }
   }
+
+  /**
+   * @author Myndware <augusto.pissarra@myndware.com>
+   * @description Request signed url url to put or get
+   * @param {object} params - Params to get form list
+   * @param {number} params.page=1 - Page of pagination
+   * @param {number} params.perPage=200 - Items per page
+   * @param {object} params.project={_id: 1, name: 1} - Fields to project
+   * @param {object} params.sort={name: 1} - Sort fields
+   * @param {string} session - Session, token JWT
+   * @return {Promise}
+   * @public
+   * @async
+   * @example
+   *
+   * const API = require('@docbrasil/api-systemmanager');
+   * const api = new API();
+   * const params - {
+   *  project: {_id: 1, name: 1, orgId: 1, orgIds: 1},
+   * };
+   * const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
+   * await api.user.form.getUserList(params, session);
+   */
+  async getUserList(params, session) {
+    const self = this;
+
+    try {
+      Joi.assert(params, Joi.object().required(), 'Params to get form list');
+      Joi.assert(params.page, Joi.number(), 'Page of pagination');
+      Joi.assert(params.perPage, Joi.number(), 'Items per page');
+      Joi.assert(params.project, Joi.object(), 'Fields to project');
+      Joi.assert(params.sort, Joi.object(), 'Sort fields for');
+      Joi.assert(session, Joi.string().required(), 'Session, token JWT');
+
+      const PROJECTION_DEFAULT = {_id: 1, name: 1};
+      const SORT_DEFAULT = {name: 1};
+
+      const {
+        page = 1,
+        perPage = 200,
+        project = PROJECTION_DEFAULT,
+        sort = SORT_DEFAULT
+      } = params;
+
+      const payloadToSend = {$project: project, sort};
+
+      const apiCall = self._client
+          .post(`/admin/users?page=${page}&perPage=${perPage}`, payloadToSend, self._setHeader(session));
+
+      return self._returnData(await apiCall);
+
+    } catch (ex) {
+      throw ex;
+    }
+  }
 }
 
 export default AdminUser;

package/docs/user_user.js.html

@@ -376,7 +376,6 @@ class User {
    * @param {object} query={} The query, if any, to add to the JWT token
    * @param {array<string>} query.orgIds An array of orgIds that we want to filter by
    * @param {array<string>} query.orgProcessIds An array of orgProcessId that we want to filter by
-   * @param {array<string>} query.tags An array of org processes tags that we want to filter by
    * @param {date} query.startDate The start date in ISO format that we want to filter by
    * @param {date} query.endDate The start date in ISO format that we want to filter by
    * @param {string} session Is token JWT of user NOT allow SU
@@ -389,7 +388,7 @@ class User {
    * const api = new API();
    * const query = { orgIds: ['616eccaaa9360a05293b10fe'] };
    * const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
-   * const jwtToken = await api.user.changeOrganization.getChartJWT(query, session);
+   * const jwtToken = await api.user.getChartJWT(query, session);
    */
   async getChartJWT(query = {}, session) {
     const self = this;
@@ -420,7 +419,7 @@ class User {
    * const API = require('@docbrasil/api-systemmanager');
    * const api = new API();
    * const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
-   * const organizations = await api.user.changeOrganization.getChartOrganizations(session);
+   * const organizations = await api.user.getChartOrganizations(session);
    */
   async getChartOrganizations(session) {
     const self = this;
@@ -452,7 +451,7 @@ class User {
    * const api = new API();
    * const orgIds: ['616eccaaa9360a05293b10fe'];
    * const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
-   * const jwtToken = await api.user.changeOrganization.getChartTags(orgIds, session);
+   * const jwtToken = await api.user.getChartTags(orgIds, session);
    */
   async getChartTags(orgIds = [], session) {
     const self = this;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@docbrasil/api-systemmanager",
   "description": "Module API System Manager",
-  "version": "1.1.21",
+  "version": "1.1.23",
   "scripts": {
     "htmldoc": "rm -rf docs && jsdoc api/** -d docs -t ./node_modules/better-docs",
     "doc": "rm -rf doc && mkdir doc && jsdoc2md api/**/* api/* > doc/api.md",