@docbrasil/api-systemmanager 1.1.67 → 1.1.69

package/docs/admin_document.js.html

@@ -270,7 +270,6 @@ class AdminDocuments {
    * const { signedUrl, imageType } = await api.admin.document.signedUrl(params, apiKey);
    */
   async signedUrl(params = {}, apiKey) {
-
     Joi.assert(params, Joi.object().required());
     Joi.assert(params.methodType, Joi.string().required());
     Joi.assert(params.docId, Joi.string().required());
@@ -308,7 +307,6 @@ class AdminDocuments {
    * await api.admin.document.updateContent(params, apiKey);
    */
   async updateContent(params = {}, apiKey) {
-
     Joi.assert(params, Joi.object().required());
     Joi.assert(params.content, Joi.string().required());
     Joi.assert(params.docId, Joi.string().required());
@@ -355,7 +353,6 @@ class AdminDocuments {
    * await api.admin.document.updateContent(params, apiKey);
    */
   async updateAI(params = {}, apiKey) {
-
     Joi.assert(params, Joi.object().required());
     Joi.assert(params.docId, Joi.string().required());
     Joi.assert(apiKey, Joi.string().required());
@@ -400,7 +397,6 @@ class AdminDocuments {
    * await api.admin.document.getContent(params, apiKey);
    */
   async getContent(params = {}, apiKey) {
-
     Joi.assert(params, Joi.object().required());
     Joi.assert(params.docId, Joi.string().required());
     Joi.assert(params.page, Joi.string().required());
@@ -414,6 +410,39 @@ class AdminDocuments {
     return self._returnData(await apiCall);
   }
 
+  /**
+   *
+   * @author Myndware <augusto.pissarra@myndware.com>
+   * @description Get the data of a document
+   * @param {object} params Params to request signed url
+   * @param {string} params.id The unique id of the document
+   * @param {string} apiKey Api Key as permission to use this functionality
+   * @return {Promise<object>} data the document data
+   * @public
+   * @async
+   * @example
+   *
+   * const API = require('@docbrasil/api-systemmanager');
+   * const api = new API();
+   * const params - {
+   *  id: '5dadd01dc4af3941d42f8c5c'
+   * };
+   * const apiKey: '...';
+   * await api.admin.document.getDocumentData(params, apiKey);
+   */
+  async getDocumentData(params = {}, apiKey) {
+    Joi.assert(params, Joi.object().required());
+    Joi.assert(params.id, Joi.string().required());
+    Joi.assert(apiKey, Joi.string().required());
+
+    const self = this;
+    const { id } = params;
+    const url = `/api/documents/${id}?apiKey=${apiKey}`;
+    const apiCall = self._client
+        .get(url);
+    return self._returnData(await apiCall);
+  }
+
 }
 
 export default AdminDocuments;

package/docs/user_process.js.html

@@ -640,6 +640,47 @@ class Process {
         throw ex;
       }
     }
+
+    /**
+   * @author Myndware <augusto.pissarra@myndware.com>
+   * @description Get step history of a process flow
+   * @param {object} params Params to get step history
+   * @param {string} params.orgId Organization id (_id database);
+   * @param {string} params.processId Process id (_id database);
+   * @param {string} params.flowId Flow id;
+   * @param {string} session Session, token JWT
+   * @return {Promise<Array>} Array of step history entries
+   * @public
+   * @async
+   * @example
+   *
+   * const API = require('@docbrasil/api-systemmanager');
+   * const api = new API();
+   * const params = {
+   *   orgId: '5edd11c46b6ce9729c2c297c',
+   *   processId: '5dadd01dc4af3941d42f8c5c',
+   *   flowId: 'Task_18v1xx7'
+   * }
+   * const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
+   * const stepHistory = await api.user.process.getStepHistory(params, session);
+   */
+    async getStepHistory(params, session) {
+      const self = this;
+
+      try {
+        Joi.assert(params, Joi.object().required());
+        Joi.assert(params.orgId, Joi.string().required());
+        Joi.assert(params.processId, Joi.string().required());
+        Joi.assert(params.flowId, Joi.string().required());
+        Joi.assert(session, Joi.string().required());
+
+        const {orgId, processId, flowId} = params;
+        const apiCall = self._client.get(`/organizations/${orgId}/process/${processId}/flow/${flowId}/history`, self._setHeader(session));
+        return self._returnData(await apiCall, []);
+      } catch (ex) {
+        throw ex;
+      }
+    }
 }
 
 export default Process;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@docbrasil/api-systemmanager",
   "description": "Module API System Manager",
-  "version": "1.1.67",
+  "version": "1.1.69",
   "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",