@docbrasil/api-systemmanager 1.2.3 → 1.2.4

package/api/user/process.js

@@ -705,6 +705,33 @@ class Process {
     }
   }
 
+  /**
+   * @description End a running process task from a specific flow step.
+   * @param {object} params Params to end the process task
+   * @param {string} params.processId Process id (_id database);
+   * @param {string} params.orgId Organization id (_id database);
+   * @param {string} params.flowName The flow name of the step to end;
+   * @param {string} session Session, token JWT
+   * @return {Promise<object>} { response: 'OK' } on success
+   */
+  async end(params, session) {
+    const self = this;
+
+    try {
+      Joi.assert(params, Joi.object().required(), 'Params to end the process task');
+      Joi.assert(params.processId, Joi.string().required(), 'Process id (_id database)');
+      Joi.assert(params.orgId, Joi.string().required(), 'Organization id (_id database)');
+      Joi.assert(params.flowName, Joi.string().required(), 'Flow name of the step');
+      Joi.assert(session, Joi.string().required(), 'Session token JWT');
+
+      const {processId, orgId, flowName} = params;
+      const apiCall = self._client.post(`/organizations/${orgId}/process/${processId}/task/${flowName}/end`, {}, self._setHeader(session));
+      return self._returnData(await apiCall);
+    } catch (ex) {
+      throw ex;
+    }
+  }
+
   async getStepHistory(params, session) {
     const self = this;
 

package/dist/bundle.cjs

@@ -2780,6 +2780,33 @@ class Process {
     }
   }
 
+  /**
+   * @description End a running process task from a specific flow step.
+   * @param {object} params Params to end the process task
+   * @param {string} params.processId Process id (_id database);
+   * @param {string} params.orgId Organization id (_id database);
+   * @param {string} params.flowName The flow name of the step to end;
+   * @param {string} session Session, token JWT
+   * @return {Promise<object>} { response: 'OK' } on success
+   */
+  async end(params, session) {
+    const self = this;
+
+    try {
+      Joi__default["default"].assert(params, Joi__default["default"].object().required(), 'Params to end the process task');
+      Joi__default["default"].assert(params.processId, Joi__default["default"].string().required(), 'Process id (_id database)');
+      Joi__default["default"].assert(params.orgId, Joi__default["default"].string().required(), 'Organization id (_id database)');
+      Joi__default["default"].assert(params.flowName, Joi__default["default"].string().required(), 'Flow name of the step');
+      Joi__default["default"].assert(session, Joi__default["default"].string().required(), 'Session token JWT');
+
+      const {processId, orgId, flowName} = params;
+      const apiCall = self._client.post(`/organizations/${orgId}/process/${processId}/task/${flowName}/end`, {}, self._setHeader(session));
+      return self._returnData(await apiCall);
+    } catch (ex) {
+      throw ex;
+    }
+  }
+
   async getStepHistory(params, session) {
     const self = this;