@docbrasil/api-systemmanager 1.1.18 → 1.1.20

package/api/user/document.js

@@ -47,7 +47,7 @@ class Documents {
   }
 
   /**
-   * @author CloudBrasil <abernardo.br@gmail.com>
+   * @author Myndware <augusto.pissarra@myndware.com>
    * @description Set header with new session
    * @param {string} session Session, token JWT
    * @return {object} header with new session
@@ -62,7 +62,7 @@ class Documents {
   }
 
   /**
-   * @author CloudBrasil <abernardo.br@gmail.com>
+   * @author Myndware <augusto.pissarra@myndware.com>
    * @description Create document with informed data
    * @param {object} params Object for add new document
    * @param {string} params.orgname Organization name
@@ -126,7 +126,7 @@ class Documents {
   }
 
   /**
-   * @author CloudBrasil <abernardo.br@gmail.com>
+   * @author Myndware <augusto.pissarra@myndware.com>
    * @description Transform objtect query in query string
    * @param {object} searchQuery object wicth query
    * @return {string} Retutn string query
@@ -150,7 +150,7 @@ class Documents {
   }
 
   /**
-   * @author CloudBrasil <abernardo.br@gmail.com>
+   * @author Myndware <augusto.pissarra@myndware.com>
    * @description Create new document
    * @param {object} params Object for add new document
    * @param {string} params.orgname Organization name
@@ -239,7 +239,7 @@ class Documents {
   }
 
   /**
-   * @author CloudBrasil <abernardo.br@gmail.com>
+   * @author Myndware <augusto.pissarra@myndware.com>
    * @description Updates a document
    * @param {string} id Document _id
    * @param {object} params Object for document payload to update. It has to be the FULL document data, that you can get with findById
@@ -272,7 +272,7 @@ class Documents {
   }
 
   /**
-   * @author CloudBrasil <abernardo.br@gmail.com>
+   * @author Myndware <augusto.pissarra@myndware.com>
    * @description Updates a document.
    *  IMPORTANT: if your document has a content, it will NOT bring the content.
    * @param {string} id Document _id
@@ -305,7 +305,7 @@ class Documents {
   }
 
   /**
-   * @author CloudBrasil <abernardo.br@gmail.com>
+   * @author Myndware <augusto.pissarra@myndware.com>
    * @param {object} params Object with params
    * @param {string} params.index Field to search
    * @param {string} params.txtToSearch Text to search
@@ -397,7 +397,7 @@ class Documents {
   }
 
   /**
-   * @author CloudBrasil <abernardo.br@gmail.com>
+   * @author Myndware <augusto.pissarra@myndware.com>
    * @description Remove document by id
    * @param {object} params Params to remove document
    * @param {string} params.docId Document Id (_id database)
@@ -441,7 +441,7 @@ class Documents {
   }
 
   /**
-   * @author CloudBrasil <abernardo.br@gmail.com>
+   * @author Myndware <augusto.pissarra@myndware.com>
    * @description Remove documents
    * @param {object} params Params to remove document
    * @param {array<string>} params.documents An array ids of documents (_id database)
@@ -487,7 +487,7 @@ class Documents {
 
   /**
    *
-   * @author CloudBrasil <abernardo.br@gmail.com>
+   * @author Myndware <augusto.pissarra@myndware.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
@@ -576,7 +576,7 @@ class Documents {
 
   /**
    *
-   * @author CloudBrasil <abernardo.br@gmail.com>
+   * @author Myndware <augusto.pissarra@myndware.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
@@ -706,7 +706,7 @@ class Documents {
   }
 
   /**
-   * @author CloudBrasil <abernardo.br@gmail.com>
+   * @author Myndware <augusto.pissarra@myndware.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
@@ -760,7 +760,7 @@ class Documents {
   }
 
   /**
-   * @author CloudBrasil <abernardo.br@gmail.com>
+   * @author Myndware <augusto.pissarra@myndware.com>
    * @description Method to search documents for
    * @param {object} params Params to search the documents
    * @param {object} params.query Search documents query

package/api/user/help.js

@@ -33,7 +33,7 @@ class Help {
   }
 
   /**
-   * @author CloudBrasil <abernardo.br@gmail.com>
+   * @author Myndware <augusto.pissarra@myndware.com>
    * @description Set header with new session
    * @param {string} session Session, token JWT
    * @return {object} header with new session
@@ -79,7 +79,7 @@ class Help {
   }
 
   /**
-   * @author CloudBrasil <abernardo.br@gmail.com>
+   * @author Myndware <augusto.pissarra@myndware.com>
    * @description Method to find helps from a topic
    * @param {object} params Params to get helps from topic
    * @param {object} params.id Topic id (_id database)

package/api/user/index.js

@@ -19,7 +19,7 @@ import Settings from './settings.js';
  */
 class Users {
   /**
-   * @author CloudBrasil <abernardo.br@gmail.com>
+   * @author Myndware <augusto.pissarra@myndware.com>
    * @constructor
    * @param {object} options Params of the constructor
    * @param {object} options.parent This of the pararent

package/api/user/my_tasks.js

@@ -33,7 +33,7 @@ class MyTasks {
   }
 
   /**
-   * @author CloudBrasil <abernardo.br@gmail.com>
+   * @author Myndware <augusto.pissarra@myndware.com>
    * @description Set header with new session
    * @param {string} session Session, token JWT
    * @return {object} header with new session
@@ -48,7 +48,7 @@ class MyTasks {
   }
 
   /**
-   * @author CloudBrasil <abernardo.br@gmail.com>
+   * @author Myndware <augusto.pissarra@myndware.com>
    * @description Method to find my tasks for a user
    * @param {object} params Params to get tasks
    * @param {object} params.query Search my tasks query
@@ -92,7 +92,7 @@ class MyTasks {
   }
 
   /**
-   * @author CloudBrasil <abernardo.br@gmail.com>
+   * @author Myndware <augusto.pissarra@myndware.com>
    * @description Update task dueDate
    * @param {object} params The Date to save
    * @param {string} params.dueDate DueDate
@@ -134,7 +134,7 @@ class MyTasks {
   }
 
   /**
-   * @author CloudBrasil <abernardo.br@gmail.com>
+   * @author Myndware <augusto.pissarra@myndware.com>
    * @description Update task dueDate
    * @param {string} data.orgId Organization id
    * @param {string} data.taskId Task Id
@@ -172,7 +172,7 @@ class MyTasks {
   }
 
   /**
-   * @author CloudBrasil <abernardo.br@gmail.com>
+   * @author Myndware <augusto.pissarra@myndware.com>
    * @description Method to get task multi users
    * @param {object} params Params to get task
    * @param {object} params.taskId Task id (_id database)
@@ -211,7 +211,7 @@ class MyTasks {
   }
 
   /**
-   * @author CloudBrasil <abernardo.br@gmail.com>
+   * @author Myndware <augusto.pissarra@myndware.com>
    * @description remove multi task user
    * @param {object} params Params of the user to be removed 
    * @param {string} params.userId User id
@@ -253,7 +253,7 @@ class MyTasks {
   }
 
   /**
-   * @author CloudBrasil <abernardo.br@gmail.com>
+   * @author Myndware <augusto.pissarra@myndware.com>
    * @description Add Multi Task User
    * @param {object} params Params for adding multi task user
    * @param {string} params.userId User id
@@ -295,7 +295,7 @@ class MyTasks {
   }
 
   /**
-   * @author CloudBrasil <abernardo.br@gmail.com>
+   * @author Myndware <augusto.pissarra@myndware.com>
    * @description Method to get assign task users
    * @param {object} params Params to get task
    * @param {object} params.taskId Task id (_id database)
@@ -334,7 +334,7 @@ class MyTasks {
   }
 
   /**
-   * @author CloudBrasil <abernardo.br@gmail.com>
+   * @author Myndware <augusto.pissarra@myndware.com>
    * @description Assign Task user
    * @param {object} params The params to assign task to user
    * @param {string} params.orgName Organization Name
@@ -376,7 +376,7 @@ class MyTasks {
   }
 
   /**
-   * @author CloudBrasil <abernardo.br@gmail.com>
+   * @author Myndware <augusto.pissarra@myndware.com>
    * @description Unclaim task
    * @param {object} params The params to unclaim task
    * @param {string} params.orgName Organization Name
@@ -415,7 +415,7 @@ class MyTasks {
   }
 
   /**
-   * @author CloudBrasil <abernardo.br@gmail.com>
+   * @author Myndware <augusto.pissarra@myndware.com>
    * @description Escalate task
    * @param {object} params The params to escalate task
    * @param {string} params.orgName Organization Name

package/api/user/notification.js

@@ -33,7 +33,7 @@ class Notification {
   }
 
   /**
-   * @author CloudBrasil <abernardo.br@gmail.com>
+   * @author Myndware <augusto.pissarra@myndware.com>
    * @description Set header with new session
    * @param {string} session Session, token JWT
    * @return {object} header with new session
@@ -59,7 +59,7 @@ class Notification {
   }
 
   /**
-   * @author CloudBrasil <abernardo.br@gmail.com>
+   * @author Myndware <augusto.pissarra@myndware.com>
    * @description Method to add a notification token
    * @param {object} params Params to add notification token
    * @param {string} params.token The token
@@ -150,7 +150,7 @@ class Notification {
   }
 
    /**
-   * @author CloudBrasil <abernardo.br@gmail.com>
+   * @author Myndware <augusto.pissarra@myndware.com>
    * @description Set notification as readed
    * @param {object} params Params to update the notification
    * @param {string} params.id Notification Id
@@ -186,7 +186,7 @@ class Notification {
     }
 
     /**
-   * @author CloudBrasil <abernardo.br@gmail.com>
+   * @author Myndware <augusto.pissarra@myndware.com>
    * @description Set notification as unreaded
    * @param {object} params Params to update the notification
    * @param {string} params.id Notification Id

package/api/user/organization.js

@@ -34,7 +34,7 @@ class Organization {
   }
 
   /**
-   * @author CloudBrasil <abernardo.br@gmail.com>
+   * @author Myndware <augusto.pissarra@myndware.com>
    * @description Set header with new session
    * @param {string} session Session, token JWT
    * @return {object} header with new session
@@ -107,7 +107,7 @@ class Organization {
   }
 
   /**
-   * @author CloudBrasil <abernardo.br@gmail.com>
+   * @author Myndware <augusto.pissarra@myndware.com>
    * @description Update avatar of organization by session of user not allow session user SU
    * @param {object} params Params to update avatar
    * @param {string} params.avatar Image in base64 to update
@@ -147,7 +147,7 @@ class Organization {
   }
 
   /**
-   * @author CloudBrasil <abernardo.br@gmail.com>
+   * @author Myndware <augusto.pissarra@myndware.com>
    * @description Remove avatar of user by session of user not allow session user SU
    * @param {string} session Is token JWT of user NOT allow SU
    * @return {Promise}
@@ -174,7 +174,7 @@ class Organization {
   }
 
   /**
-   * @author Thiago Anselmo <thiagoo.anselmoo@gmail.com>
+   * @author Myndware <augusto.pissarra@myndware.com>
    * @description Call URL internal, need auth JWT (session)
    * @param {!object} params Params to call fectch (URL internal)
    * @param {!string} params.url URL to call

package/api/user/page.js

@@ -33,7 +33,7 @@ class Page {
   }
 
   /**
-   * @author CloudBrasil <abernardo.br@gmail.com>
+   * @author Myndware <augusto.pissarra@myndware.com>
    * @description Set header with new session
    * @param {string} session Session, token JWT
    * @return {object} header with new session
@@ -48,7 +48,7 @@ class Page {
   }
 
   /**
-   * @author CloudBrasil <abernardo.br@gmail.com>
+   * @author Myndware <augusto.pissarra@myndware.com>
    * @description Get the available page for an application inside an organization
    * @param {object} params Params to get task
    * @param {object} params.orgId Organization id (_id database)

package/api/user/process.js

@@ -18,7 +18,7 @@ class Process {
   }
 
   /**
-   * @author CloudBrasil <abernardo.br@gmail.com>
+   * @author Myndware <augusto.pissarra@myndware.com>
    * @description Get the return data and check for errors
    * @param {object} retData Response HTTP
    * @return {*}
@@ -33,7 +33,7 @@ class Process {
   }
 
   /**
-   * @author CloudBrasil <abernardo.br@gmail.com>
+   * @author Myndware <augusto.pissarra@myndware.com>
    * @description Set header with new session
    * @param {string} session Session, token JWT
    * @return {object} header with new session
@@ -48,7 +48,7 @@ class Process {
   }
 
   /**
-   * @author CloudBrasil <abernardo.br@gmail.com>
+   * @author Myndware <augusto.pissarra@myndware.com>
    * @description Set header for a bigger payload
    * @param {string} session Session, token JWT
    * @return {object} header with new session
@@ -65,7 +65,7 @@ class Process {
   }
 
   /**
-   * @author CloudBrasil <abernardo.br@gmail.com>
+   * @author Myndware <augusto.pissarra@myndware.com>
    * @description Start process
    * @param {object} params Params to start process
    * @param {string} params.orgProcessId The organization process id (_id database);
@@ -106,7 +106,7 @@ class Process {
   }
 
   /**
-   * @author CloudBrasil <abernardo.br@gmail.com>
+   * @author Myndware <augusto.pissarra@myndware.com>
    * @description Get process properties of process
    * @param {object} params Params to get process properties
    * @param {string} params.processId Process id (_id database);
@@ -144,7 +144,7 @@ class Process {
   }
 
   /**
-   * @author CloudBrasil <abernardo.br@gmail.com>
+   * @author Myndware <augusto.pissarra@myndware.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);
@@ -188,7 +188,7 @@ class Process {
   }
 
   /**
-   * @author CloudBrasil <abernardo.br@gmail.com>
+   * @author Myndware <augusto.pissarra@myndware.com>
    * @description Method to search processes
    * @param {object} params Params to search processes
    * @param {object} params.query Search process query
@@ -232,7 +232,7 @@ class Process {
   }
 
   /**
-   * @author CloudBrasil <abernardo.br@gmail.com>
+   * @author Myndware <augusto.pissarra@myndware.com>
    * @description Method to remove process
    * @param {object} params Params to remove process
    * @param {object} params.orgId Organization id (_id database)
@@ -269,7 +269,7 @@ class Process {
   }
 
     /**
-   * @author CloudBrasil <abernardo.br@gmail.com>
+   * @author Myndware <augusto.pissarra@myndware.com>
    * @description Method to export status data
    * @param {object} params Params to export status data
    * @param {object} params.query Search process query
@@ -308,7 +308,7 @@ class Process {
     }
 
     /**
-   * @author CloudBrasil <abernardo.br@gmail.com>
+   * @author Myndware <augusto.pissarra@myndware.com>
    * @description Method to export process data
    * @param {object} params Params to export process data
    * @param {object} params.query Search process query
@@ -347,7 +347,7 @@ class Process {
     }
 
    /**
-   * @author CloudBrasil <abernardo.br@gmail.com>
+   * @author Myndware <augusto.pissarra@myndware.com>
    * @description Method to get Process Docs
    * @param {object} params Params to get process docs
    * @param {string} params.orgProcessId Organization Process Id
@@ -388,7 +388,7 @@ class Process {
   }
 
   /**
-   * @author CloudBrasil <abernardo.br@gmail.com>
+   * @author Myndware <augusto.pissarra@myndware.com>
    * @description Method to download the process documents
    * @param {object} params Params to download the process documents
    * @param {string} params.orgId Organization id (_id database)

package/api/user/register.js

@@ -34,7 +34,7 @@ class Register {
   }
 
   /**
-   * @author CloudBrasil <abernardo.br@gmail.com>
+   * @author Myndware <augusto.pissarra@myndware.com>
    * @description Set header with new session
    * @param {string} session Session, token JWT
    * @return {object} header with new session
@@ -49,7 +49,7 @@ class Register {
   }
 
   /**
-   * @author CloudBrasil <abernardo.br@gmail.com>
+   * @author Myndware <augusto.pissarra@myndware.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
@@ -68,7 +68,7 @@ class Register {
   }
 
   /**
-   * @author CloudBrasil <abernardo.br@gmail.com>
+   * @author Myndware <augusto.pissarra@myndware.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
@@ -119,7 +119,7 @@ class Register {
   }
 
   /**
-   * @author CloudBrasil <abernardo.br@gmail.com>
+   * @author Myndware <augusto.pissarra@myndware.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

package/api/user/settings.js

@@ -23,7 +23,7 @@ class Settings {
   }
 
   /**
-   * @author CloudBrasil <abernardo.br@gmail.com>
+   * @author Myndware <augusto.pissarra@myndware.com>
    * @description Get the return data and check for errors
    * @param {object} retData Response HTTP
    * @return {*}
@@ -38,7 +38,7 @@ class Settings {
   }
 
   /**
-   * @author CloudBrasil <abernardo.br@gmail.com>
+   * @author Myndware <augusto.pissarra@myndware.com>
    * @description Set header with new session
    * @param {string} session Session, token JWT
    * @return {object} header with new session
@@ -53,7 +53,7 @@ class Settings {
   }
 
   /**
-   * @author CloudBrasil <abernardo.br@gmail.com>
+   * @author Myndware <augusto.pissarra@myndware.com>
    * @description Adds/updates a user settings
    * @param {object} settings Full user settings
    * @param {string} session Is token JWT of user NOT allow SU
@@ -85,7 +85,7 @@ class Settings {
   }
 
   /**
-   * @author CloudBrasil <abernardo.br@gmail.com>
+   * @author Myndware <augusto.pissarra@myndware.com>
    * @description Gets the user settings. Returns an array of settings.
    * @param {string} session Is token JWT of user NOT allow SU
    * @return {Promise}
@@ -112,7 +112,7 @@ class Settings {
   }
 
   /**
-   * @author CloudBrasil <abernardo.br@gmail.com>
+   * @author Myndware <augusto.pissarra@myndware.com>
    * @description Removes the user settings
    * @param {string} session Is token JWT of user NOT allow SU
    * @return {Promise}

package/api/user/task.js

@@ -37,7 +37,7 @@ class Task {
   }
 
   /**
-   * @author CloudBrasil <abernardo.br@gmail.com>
+   * @author Myndware <augusto.pissarra@myndware.com>
    * @description Set header with new session
    * @param {string} session Session, token JWT
    * @return {object} header with new session
@@ -52,7 +52,7 @@ class Task {
   }
 
   /**
-   * @author CloudBrasil <abernardo.br@gmail.com>
+   * @author Myndware <augusto.pissarra@myndware.com>
    * @description Method to find task by id
    * @param {object} params Params to get task
    * @param {object} params.processId Proccess id (_id database)
@@ -94,7 +94,7 @@ class Task {
   }
 
   /**
-   * @author CloudBrasil <abernardo.br@gmail.com>
+   * @author Myndware <augusto.pissarra@myndware.com>
    * @description Find task by id and update
    * @param {object} params Params to update task
    * @param {object} params.userId User id (_id database)
@@ -156,7 +156,7 @@ class Task {
   }
 
   /**
-   * @author CloudBrasil <abernardo.br@gmail.com>
+   * @author Myndware <augusto.pissarra@myndware.com>
    * @description Find task by id and update
    * @param {!object} params Params - to update task
    * @param {!string} params.taskId - Task id (_id database)
@@ -199,6 +199,43 @@ class Task {
       throw ex;
     }
   }
+
+  /**
+   * @author Myndware <augusto.pissarra@myndware.com>
+   * @description Get the tasks and available tasks summary (totals) for specific tags
+   * @param {object} params Params - to update task
+   * @param {array<string>} params.tags - The tags to get task summaries
+   * @param {string} session Session, token JWT
+   * @return {Promise<object>} data
+   * @return {Promise<object>} data.tasks - the total tasks
+   * @return {Promise<object>} data.availableTasks - the total available tasks
+   * @public
+   * @async
+   * @example
+   *
+   * const API = require('@docbrasil/api-systemmanager');
+   * const api = new API();
+   * const params = {
+   *  tags: ['INCIDENTS']
+   * };
+   * const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
+   * await api.user.task.getSummaryByTags(params, session);
+   */
+  async getSummaryByTags(params, session) {
+    const self = this;
+
+    try {
+      Joi.assert(params, Joi.object().required());
+      Joi.assert(params.tags, Joi.array().required(), 'Tags is required');
+
+      const url = `/organizations/tasks/summary`;
+      const apiCall = self._client.post(url, params, self._setHeader(session));
+
+      return self._returnData(await apiCall);
+    } catch (ex) {
+      throw ex;
+    }
+  }
 }
 
 export default Task;

package/api/user/task_available.js

@@ -33,7 +33,7 @@ class TaskAvailable {
   }
 
   /**
-   * @author CloudBrasil <abernardo.br@gmail.com>
+   * @author Myndware <augusto.pissarra@myndware.com>
    * @description Set header with new session
    * @param {string} session Session, token JWT
    * @return {object} header with new session
@@ -48,7 +48,7 @@ class TaskAvailable {
   }
 
   /**
-   * @author CloudBrasil <abernardo.br@gmail.com>
+   * @author Myndware <augusto.pissarra@myndware.com>
    * @description Method to find available tasks for a user
    * @param {object} params Params to get task
    * @param {object} params.query Search available tasks query
@@ -92,7 +92,7 @@ class TaskAvailable {
   }
 
   /**
-   * @author CloudBrasil <abernardo.br@gmail.com>
+   * @author Myndware <augusto.pissarra@myndware.com>
    * @description Method for a user to claim an available task
    * @param {object} params Params to get task
    * @param {object} params.taskId the task id to claim

package/api/user/updates.js

@@ -33,7 +33,7 @@ class Updates {
   }
 
   /**
-   * @author CloudBrasil <abernardo.br@gmail.com>
+   * @author Myndware <augusto.pissarra@myndware.com>
    * @description Set header with new session
    * @param {string} session Session, token JWT
    * @return {object} header with new session