@docbrasil/api-systemmanager 1.1.72 → 1.1.75

package/doc/api.md

@@ -2329,6 +2329,7 @@ Class for user registration in a user
 * [Help](#Help)
     * [.getTopics(filter, session)](#Help+getTopics)
     * [.get(params, session)](#Help+get) ⇒ <code>promise</code>
+    * [.listExternalUrls(session)](#Help+listExternalUrls) ⇒ <code>promise.&lt;Array&gt;</code>
 
 <a name="Help+getTopics"></a>
 
@@ -2376,6 +2377,38 @@ const params = {
 const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
 await api.user.help.get(params, session);
 ```
+<a name="Help+listExternalUrls"></a>
+
+### help.listExternalUrls(session) ⇒ <code>promise.&lt;Array&gt;</code>
+Get list of external URL help pages available for the logged user.
+Returns help pages where the user has permission based on their groups or user ID.
+
+**Kind**: instance method of [<code>Help</code>](#Help)  
+**Returns**: <code>promise.&lt;Array&gt;</code> - Array of external URL help pages with permissions  
+**Access**: public  
+**Author**: Myndware <augusto.pissarra@myndware.com>  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| session | <code>string</code> | Session, token JWT |
+
+**Example**  
+```js
+const API = require('@docbrasil/api-systemmanager');
+const api = new API();
+const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
+const externalUrls = await api.user.help.listExternalUrls(session);
+// Returns:
+// [
+//   {
+//     _id: '...',
+//     title: 'Help Page Title',
+//     permissions: ['VIEW', 'CREATE_EXTERNAL_URL'],
+//     showPoweredBy: true,
+//     showCreatedBy: false
+//   }
+// ]
+```
 <a name="Users"></a>
 
 ## Users
@@ -4131,6 +4164,8 @@ Class for task, permission user
     * [.findByIdAndUpdate(params, session)](#Task+findByIdAndUpdate) ⇒ <code>Promise</code>
     * [.executeActionFinalize(params, session)](#Task+executeActionFinalize) ⇒ <code>Promise</code>
     * [.getSummaryByTags(params, session)](#Task+getSummaryByTags) ⇒ <code>Promise.&lt;object&gt;</code> \| <code>Promise.&lt;object&gt;</code> \| <code>Promise.&lt;object&gt;</code>
+    * [.saveTask(params, session)](#Task+saveTask) ⇒ <code>Promise</code>
+    * [.endTask(params, session)](#Task+endTask) ⇒ <code>Promise</code>
 
 <a name="Task+findById"></a>
 
@@ -4254,6 +4289,112 @@ const params = {
 const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
 await api.user.task.getSummaryByTags(params, session);
 ```
+<a name="Task+saveTask"></a>
+
+### task.saveTask(params, session) ⇒ <code>Promise</code>
+Save task progress without completing it
+
+**Kind**: instance method of [<code>Task</code>](#Task)  
+**Access**: public  
+**Author**: Myndware <augusto.pissarra@myndware.com>  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| params | <code>object</code> | Params to save task |
+| params.processId | <code>string</code> | Process id (_id database) |
+| params.taskId | <code>string</code> | Task id (_id database) |
+| params.flowName | <code>string</code> | Flow name |
+| params.orgId | <code>string</code> | Organization id (_id database) |
+| params.formData | <code>array</code> | Form data to save |
+| [params.selectedDocs] | <code>array</code> | Selected documents |
+| [params.selectedAssignees] | <code>array</code> | Selected assignees |
+| [params.selectedBoxes] | <code>array</code> | Selected boxes |
+| [params.advFormData] | <code>object</code> | Advanced form data |
+| [params.advFormSchema] | <code>object</code> | Advanced form schema |
+| [params.status] | <code>string</code> | Task status (empty string for save) |
+| [params.order] | <code>number</code> | Task order |
+| [params.title] | <code>string</code> | Task title |
+| [params.tags] | <code>array</code> | Task tags |
+| [params.dueDate] | <code>string</code> | Due date ISO string |
+| session | <code>string</code> | Session, token JWT |
+
+**Example**  
+```js
+const API = require('@docbrasil/api-systemmanager');
+const api = new API();
+const params = {
+  processId: '5dadd01dc4af3941d42f8c5c',
+  taskId: '5df7f19618430c89a41a19d2',
+  flowName: 'simpleTask',
+  orgId: '55e4a3bd6be6b45210833fae',
+  formData: [{ name: 'Group', fields: [...] }],
+  selectedDocs: [],
+  selectedAssignees: [],
+  selectedBoxes: [],
+  advFormData: {},
+  advFormSchema: {},
+  status: '',
+  order: 0,
+  title: 'My Task',
+  tags: [],
+  dueDate: '2024-01-15T00:00:00Z'
+};
+const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
+await api.user.task.saveTask(params, session);
+```
+<a name="Task+endTask"></a>
+
+### task.endTask(params, session) ⇒ <code>Promise</code>
+End/complete a task and advance the workflow
+
+**Kind**: instance method of [<code>Task</code>](#Task)  
+**Access**: public  
+**Author**: Myndware <augusto.pissarra@myndware.com>  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| params | <code>object</code> | Params to end task |
+| params.processId | <code>string</code> | Process id (_id database) |
+| params.taskId | <code>string</code> | Task id (_id database) |
+| params.flowName | <code>string</code> | Flow name |
+| params.orgId | <code>string</code> | Organization id (_id database) |
+| params.formData | <code>array</code> | Form data to submit |
+| [params.selectedDocs] | <code>array</code> | Selected documents |
+| [params.selectedAssignees] | <code>array</code> | Selected assignees |
+| [params.selectedBoxes] | <code>array</code> | Selected boxes |
+| [params.advFormData] | <code>object</code> | Advanced form data |
+| [params.advFormSchema] | <code>object</code> | Advanced form schema |
+| [params.status] | <code>string</code> | Task status |
+| [params.order] | <code>number</code> | Task order |
+| [params.title] | <code>string</code> | Task title |
+| [params.tags] | <code>array</code> | Task tags |
+| [params.dueDate] | <code>string</code> | Due date ISO string |
+| session | <code>string</code> | Session, token JWT |
+
+**Example**  
+```js
+const API = require('@docbrasil/api-systemmanager');
+const api = new API();
+const params = {
+  processId: '5dadd01dc4af3941d42f8c5c',
+  taskId: '5df7f19618430c89a41a19d2',
+  flowName: 'simpleTask',
+  orgId: '55e4a3bd6be6b45210833fae',
+  formData: [{ name: 'Group', fields: [...] }],
+  selectedDocs: [],
+  selectedAssignees: [],
+  selectedBoxes: [],
+  advFormData: {},
+  advFormSchema: {},
+  status: '',
+  order: 0,
+  title: 'My Task',
+  tags: [],
+  dueDate: '2024-01-15T00:00:00Z'
+};
+const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
+await api.user.task.endTask(params, session);
+```
 <a name="TaskAvailable"></a>
 
 ## TaskAvailable

package/docs/Help.html

@@ -658,6 +658,211 @@ await api.user.help.getTopics({}, session);</code></pre>
     
 
 
+</div>
+            
+                <div class="member">
+
+
+    
+    <h4 class="name" id="listExternalUrls">
+        <a class="href-link" href="#listExternalUrls">#</a>
+        
+            
+                <span class='tag'>async</span>
+            
+        
+        <span class="code-name">
+            
+                listExternalUrls<span class="signature">(session)</span><span class="type-signature"> &rarr; {promise.&lt;Array>}</span>
+            
+        </span>
+    </h4>
+    
+
+    
+    
+    <div class="description">
+        Get list of external URL help pages available for the logged user.
+Returns help pages where the user has permission based on their groups or user ID.
+    </div>
+    
+
+
+
+
+
+
+
+
+
+    <h5>Parameters:</h5>
+    
+<div class="table-container">
+    <table class="params table">
+        <thead>
+        <tr>
+            
+            <th>Name</th>
+            
+
+            <th>Type</th>
+
+            
+
+            
+
+            <th class="last">Description</th>
+        </tr>
+        </thead>
+
+        <tbody>
+        
+
+            
+<tr class="deep-level-0">
+  
+      <td class="name"><code>session</code></td>
+  
+
+  <td class="type">
+  
+      
+<code class="param-type">string</code>
+
+
+  
+  </td>
+
+  
+
+  
+
+  <td class="description last">Session, token JWT</td>
+</tr>
+
+
+        
+        </tbody>
+    </table>
+</div>
+
+
+
+
+
+<dl class="details">
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+    <dt class="tag-author">Author:</dt>
+    <dd class="tag-author">
+        <ul>
+            <li><a href="mailto:augusto.pissarra@myndware.com">Myndware</a></li>
+        </ul>
+    </dd>
+    
+
+    
+
+    
+
+    
+    
+
+    
+
+    
+
+    
+        <p class="tag-source">
+            <a href="user_help.js.html" class="button">View Source</a>
+            <span>
+                <a href="user_help.js.html">user/help.js</a>, <a href="user_help.js.html#line140">line 140</a>
+            </span>
+        </p>
+    
+</dl>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+    <div class='columns method-parameter'>
+        <div class="column is-2"><label>Returns:</label></div>
+        <div class="column is-10">
+            
+                    
+
+<div class="columns">
+    
+    <div class='param-desc column is-7'>Array of external URL help pages with permissions</div>
+    
+    
+    <div class='column is-5 has-text-left'>
+        <label>Type: </label>
+        
+<code class="param-type">promise.&lt;Array></code>
+
+
+    </div>
+    
+</div>
+
+                
+        </div>
+    </div>
+
+
+
+
+    <h5>Example</h5>
+    
+    
+        <pre class="prettyprint"><code>const API = require('@docbrasil/api-systemmanager');
+const api = new API();
+const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
+const externalUrls = await api.user.help.listExternalUrls(session);
+// Returns:
+// [
+//   {
+//     _id: '...',
+//     title: 'Help Page Title',
+//     permissions: ['VIEW', 'CREATE_EXTERNAL_URL'],
+//     showPoweredBy: true,
+//     showCreatedBy: false
+//   }
+// ]</code></pre>
+    
+
+
 </div>
             
             </div>