@docbrasil/api-systemmanager 1.0.109 → 1.0.110

package/api/user/process.js

@@ -68,7 +68,7 @@ class Process {
    * @author CloudBrasil <abernardo.br@gmail.com>
    * @description Start process
    * @param {object} params Params to start process
-   * @param {string} params.processId Process id (_id database);
+   * @param {string} params.orgProcessId The organization process id (_id database);
    * @param {string} params.orgId Organization id (_id database);
    * @param {object} [params.payload={}] Start process with data
    * @param {string} session Session, token JWT
@@ -80,7 +80,7 @@ class Process {
    * const API = require('@docbrasil/api-systemmanager');
    * const api = new API();
    * const params = {
-   *   processId: '5dadd01dc4af3941d42f8c5c',
+   *   orgProcessId: '5dadd01dc4af3941d42f8c5c',
    *   orgId: '5edd11c46b6ce9729c2c297c',
    *   payload: {}
    * }
@@ -92,13 +92,13 @@ class Process {
 
     try {
       Joi.assert(params, Joi.object().required());
-      Joi.assert(params.processId, Joi.string().required());
+      Joi.assert(params.orgProcessId, Joi.string().required());
       Joi.assert(params.orgId, Joi.string().required());
       Joi.assert(params.payload, Joi.object());
       Joi.assert(session, Joi.string().required());
 
-      const {processId, orgId, payload = {}} = params;
-      const apiCall = self._client.put(`/organizations/${orgId}/process/${processId}`, payload, self._setMaxContentHeader(session));
+      const {orgProcessId, orgId, payload = {}} = params;
+      const apiCall = self._client.put(`/organizations/${orgId}/process/${orgProcessId}`, payload, self._setMaxContentHeader(session));
       return self._returnData(await apiCall);
     } catch (ex) {
       throw ex;

package/doc/api.md

@@ -1920,7 +1920,7 @@ Start process
 | Param | Type | Default | Description |
 | --- | --- | --- | --- |
 | params | <code>object</code> |  | Params to start process |
-| params.processId | <code>string</code> |  | Process id (_id database); |
+| params.orgProcessId | <code>string</code> |  | The organization process id (_id database); |
 | params.orgId | <code>string</code> |  | Organization id (_id database); |
 | [params.payload] | <code>object</code> | <code>{}</code> | Start process with data |
 | session | <code>string</code> |  | Session, token JWT |
@@ -1930,7 +1930,7 @@ Start process
 const API = require('@docbrasil/api-systemmanager');
 const api = new API();
 const params = {
-  processId: '5dadd01dc4af3941d42f8c5c',
+  orgProcessId: '5dadd01dc4af3941d42f8c5c',
   orgId: '5edd11c46b6ce9729c2c297c',
   payload: {}
 }

package/docs/Process.html

@@ -1297,7 +1297,7 @@ await api.user.process.getProcessProperties(params, session);</code></pre>
     
 <tr class="deep-level-1">
   
-      <td class="name"><code>processId</code></td>
+      <td class="name"><code>orgProcessId</code></td>
   
 
   <td class="type">
@@ -1325,7 +1325,7 @@ await api.user.process.getProcessProperties(params, session);</code></pre>
       </td>
   
 
-  <td class="description last">Process id (_id database);</td>
+  <td class="description last">The organization process id (_id database);</td>
 </tr>
 
   
@@ -1548,7 +1548,7 @@ await api.user.process.getProcessProperties(params, session);</code></pre>
         <pre class="prettyprint"><code>const API = require('@docbrasil/api-systemmanager');
 const api = new API();
 const params = {
-  processId: '5dadd01dc4af3941d42f8c5c',
+  orgProcessId: '5dadd01dc4af3941d42f8c5c',
   orgId: '5edd11c46b6ce9729c2c297c',
   payload: {}
 }

package/docs/user_process.js.html

@@ -155,7 +155,7 @@ class Process {
    * @author CloudBrasil <abernardo.br@gmail.com>
    * @description Start process
    * @param {object} params Params to start process
-   * @param {string} params.processId Process id (_id database);
+   * @param {string} params.orgProcessId The organization process id (_id database);
    * @param {string} params.orgId Organization id (_id database);
    * @param {object} [params.payload={}] Start process with data
    * @param {string} session Session, token JWT
@@ -167,7 +167,7 @@ class Process {
    * const API = require('@docbrasil/api-systemmanager');
    * const api = new API();
    * const params = {
-   *   processId: '5dadd01dc4af3941d42f8c5c',
+   *   orgProcessId: '5dadd01dc4af3941d42f8c5c',
    *   orgId: '5edd11c46b6ce9729c2c297c',
    *   payload: {}
    * }
@@ -179,13 +179,13 @@ class Process {
 
     try {
       Joi.assert(params, Joi.object().required());
-      Joi.assert(params.processId, Joi.string().required());
+      Joi.assert(params.orgProcessId, Joi.string().required());
       Joi.assert(params.orgId, Joi.string().required());
       Joi.assert(params.payload, Joi.object());
       Joi.assert(session, Joi.string().required());
 
-      const {processId, orgId, payload = {}} = params;
-      const apiCall = self._client.put(`/organizations/${orgId}/process/${processId}`, payload, self._setMaxContentHeader(session));
+      const {orgProcessId, orgId, payload = {}} = params;
+      const apiCall = self._client.put(`/organizations/${orgId}/process/${orgProcessId}`, payload, self._setMaxContentHeader(session));
       return self._returnData(await apiCall);
     } catch (ex) {
       throw ex;

package/package.json

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

package/readme.md

@@ -20,5 +20,5 @@ const api = new APISystemManager();
 
 ### API
 * [API Documentation in HTML](https://cloudbrasil.github.io/api-systemmanager)
-* [API Documentation in Markup](https://github.com/cloudbrasil/api-systemmanager/blob/develop/doc/doc.md)
+* [API Documentation in Markup](https://github.com/cloudbrasil/api-systemmanager/blob/develop/doc/api.md)
 * [API Examples](https://github.com/cloudbrasil/api-systemmanager/wiki)