@docbrasil/api-systemmanager 1.0.109 → 1.0.111

package/doc/api.md

@@ -1907,6 +1907,9 @@ Class for process, permission user
     * [.getProcessProperties(params, session)](#Process+getProcessProperties) ⇒ <code>Promise</code>
     * [.getOrgProcessSearchInfo(params, session)](#Process+getOrgProcessSearchInfo) ⇒ <code>Promise</code> \| <code>string</code> \| <code>object</code> \| <code>object</code> \| <code>object</code> \| <code>string</code>
     * [.find(params, session)](#Process+find) ⇒ <code>promise</code> \| <code>number</code> \| <code>array.&lt;object&gt;</code> \| <code>number</code> \| <code>number</code>
+    * [.remove(params, session)](#Process+remove)
+    * [.exportStatusData(params, session)](#Process+exportStatusData)
+    * [.exportProcessData(params, session)](#Process+exportProcessData)
 
 <a name="Process+start"></a>
 
@@ -1920,7 +1923,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 +1933,7 @@ Start process
 const API = require('@docbrasil/api-systemmanager');
 const api = new API();
 const params = {
-  processId: '5dadd01dc4af3941d42f8c5c',
+  orgProcessId: '5dadd01dc4af3941d42f8c5c',
   orgId: '5edd11c46b6ce9729c2c297c',
   payload: {}
 }
@@ -2021,6 +2024,87 @@ const params = {
 const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
 const retSearch = await api.user.process.find(params, session);
 ```
+<a name="Process+remove"></a>
+
+### process.remove(params, session)
+Method to remove process
+
+**Kind**: instance method of [<code>Process</code>](#Process)  
+**Access**: public  
+**Author**: CloudBrasil <abernardo.br@gmail.com>  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| params | <code>object</code> | Params to remove process |
+| params.orgId | <code>object</code> | Organization id (_id database) |
+| params.processId | <code>object</code> | Process id (_id database) |
+| session | <code>string</code> | Session, token JWT |
+
+**Example**  
+```js
+const API = require('@docbrasil/api-systemmanager');
+const api = new API();
+const params = {
+ orgId: '55e4a3bd6be6b45210833fae',
+ processId: '55e4a3bd6be6b45210833fae'
+};
+const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
+const retSearch = await api.user.process.remove(params, session);
+```
+<a name="Process+exportStatusData"></a>
+
+### process.exportStatusData(params, session)
+Method to export status data
+
+**Kind**: instance method of [<code>Process</code>](#Process)  
+**Access**: public  
+**Author**: CloudBrasil <abernardo.br@gmail.com>  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| params | <code>object</code> | Params to export status data |
+| params.query | <code>object</code> | Search process query |
+| params.orgId | <code>object</code> | Organization id (_id database) |
+| session | <code>string</code> | Session, token JWT |
+
+**Example**  
+```js
+const API = require('@docbrasil/api-systemmanager');
+const api = new API();
+const params = {
+ query: {"orgProcessId": {"value":"62c2d1cdfb5455c195d1baa1","oper":"=","type":"string"},"s":[{"historyBegin":{"order":"desc"}}],"i":1,"p":20},
+ orgId: '55e4a3bd6be6b45210833fae',
+};
+const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
+const retSearch = await api.user.process.exportStatusData(params, session);
+```
+<a name="Process+exportProcessData"></a>
+
+### process.exportProcessData(params, session)
+Method to export process data
+
+**Kind**: instance method of [<code>Process</code>](#Process)  
+**Access**: public  
+**Author**: CloudBrasil <abernardo.br@gmail.com>  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| params | <code>object</code> | Params to export process data |
+| params.query | <code>object</code> | Search process query |
+| params.orgId | <code>object</code> | Organization id (_id database) |
+| session | <code>string</code> | Session, token JWT |
+
+**Example**  
+```js
+const API = require('@docbrasil/api-systemmanager');
+const api = new API();
+const params = {
+ query: {"orgProcessId": {"value":"62c2d1cdfb5455c195d1baa1","oper":"=","type":"string"},"s":[{"historyBegin":{"order":"desc"}}],"i":1,"p":20},
+ orgId: '55e4a3bd6be6b45210833fae',
+};
+const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
+const retSearch = await api.user.process.exportProcessData(params, session);
+```
 <a name="Register"></a>
 
 ## Register

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.111",
   "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)