@docbrasil/api-systemmanager 1.1.19 → 1.1.21

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (104) hide show
  1. package/api/admin/doctypes.js +3 -3
  2. package/api/admin/document.js +7 -7
  3. package/api/admin/form.js +3 -3
  4. package/api/admin/index.js +1 -1
  5. package/api/admin/list.js +3 -3
  6. package/api/admin/message.js +2 -2
  7. package/api/admin/notification.js +5 -5
  8. package/api/admin/organization.js +3 -3
  9. package/api/admin/plugin.js +2 -2
  10. package/api/admin/policy.js +3 -3
  11. package/api/admin/processes.js +4 -4
  12. package/api/admin/task.js +3 -3
  13. package/api/admin/user.js +6 -6
  14. package/api/dispatch.js +2 -2
  15. package/api/external.js +5 -5
  16. package/api/general/geoLocation.js +3 -3
  17. package/api/general/index.js +1 -1
  18. package/api/login.js +7 -7
  19. package/api/session.js +1 -1
  20. package/api/user/application.js +2 -2
  21. package/api/user/datasource.js +2 -2
  22. package/api/user/document.js +13 -13
  23. package/api/user/help.js +2 -2
  24. package/api/user/index.js +1 -1
  25. package/api/user/my_tasks.js +11 -11
  26. package/api/user/notification.js +4 -4
  27. package/api/user/organization.js +4 -4
  28. package/api/user/page.js +2 -2
  29. package/api/user/process.js +12 -12
  30. package/api/user/register.js +4 -4
  31. package/api/user/settings.js +5 -5
  32. package/api/user/task.js +41 -4
  33. package/api/user/task_available.js +3 -3
  34. package/api/user/updates.js +1 -1
  35. package/api/user/user.js +108 -9
  36. package/dist/bundle.cjs +279 -143
  37. package/dist/bundle.mjs +1 -1
  38. package/doc/api.md +202 -102
  39. package/docs/Admin.html +1 -1
  40. package/docs/AdminDocuments.html +6 -6
  41. package/docs/AdminForm.html +2 -2
  42. package/docs/AdminLists.html +2 -2
  43. package/docs/AdminNotification.html +4 -4
  44. package/docs/AdminPlugin.html +1 -1
  45. package/docs/AdminPolicy.html +1 -1
  46. package/docs/AdminProcesses.html +2 -2
  47. package/docs/AdminTask.html +1 -1
  48. package/docs/AdminUser.html +4 -4
  49. package/docs/Application.html +1 -1
  50. package/docs/Datasource.html +1 -1
  51. package/docs/Dispatch.html +1 -1
  52. package/docs/Documents.html +10 -10
  53. package/docs/External.html +4 -4
  54. package/docs/GeoLocation.html +1 -1
  55. package/docs/Help.html +1 -1
  56. package/docs/Login.html +6 -6
  57. package/docs/MyTasks.html +11 -11
  58. package/docs/Notification.html +3 -3
  59. package/docs/Organization.html +6 -6
  60. package/docs/Page.html +1 -1
  61. package/docs/Process.html +9 -9
  62. package/docs/Register.html +3 -3
  63. package/docs/Settings.html +3 -3
  64. package/docs/Task.html +287 -3
  65. package/docs/TaskAvailable.html +2 -2
  66. package/docs/User.html +925 -7
  67. package/docs/Users.html +2 -2
  68. package/docs/admin_doctypes.js.html +3 -3
  69. package/docs/admin_document.js.html +7 -7
  70. package/docs/admin_form.js.html +3 -3
  71. package/docs/admin_index.js.html +1 -1
  72. package/docs/admin_list.js.html +3 -3
  73. package/docs/admin_message.js.html +2 -2
  74. package/docs/admin_notification.js.html +5 -5
  75. package/docs/admin_organization.js.html +3 -3
  76. package/docs/admin_plugin.js.html +2 -2
  77. package/docs/admin_policy.js.html +3 -3
  78. package/docs/admin_processes.js.html +4 -4
  79. package/docs/admin_task.js.html +3 -3
  80. package/docs/admin_user.js.html +6 -6
  81. package/docs/dispatch.js.html +2 -2
  82. package/docs/external.js.html +5 -5
  83. package/docs/general_geoLocation.js.html +3 -3
  84. package/docs/general_index.js.html +1 -1
  85. package/docs/login.js.html +7 -7
  86. package/docs/session.js.html +1 -1
  87. package/docs/user_application.js.html +2 -2
  88. package/docs/user_datasource.js.html +2 -2
  89. package/docs/user_document.js.html +13 -13
  90. package/docs/user_help.js.html +2 -2
  91. package/docs/user_index.js.html +1 -1
  92. package/docs/user_my_tasks.js.html +12 -12
  93. package/docs/user_notification.js.html +4 -4
  94. package/docs/user_organization.js.html +4 -4
  95. package/docs/user_page.js.html +2 -2
  96. package/docs/user_process.js.html +12 -12
  97. package/docs/user_register.js.html +4 -4
  98. package/docs/user_settings.js.html +5 -5
  99. package/docs/user_task.js.html +41 -4
  100. package/docs/user_task_available.js.html +3 -3
  101. package/docs/user_updates.js.html +1 -1
  102. package/docs/user_user.js.html +108 -9
  103. package/package.json +1 -1
  104. package/.project +0 -11
package/docs/Page.html CHANGED
@@ -428,7 +428,7 @@
428
428
  <dt class="tag-author">Author:</dt>
429
429
  <dd class="tag-author">
430
430
  <ul>
431
- <li><a href="mailto:abernardo.br@gmail.com">CloudBrasil</a></li>
431
+ <li><a href="mailto:augusto.pissarra@myndware.com">Myndware</a></li>
432
432
  </ul>
433
433
  </dd>
434
434
 
package/docs/Process.html CHANGED
@@ -451,7 +451,7 @@
451
451
  <dt class="tag-author">Author:</dt>
452
452
  <dd class="tag-author">
453
453
  <ul>
454
- <li><a href="mailto:abernardo.br@gmail.com">CloudBrasil</a></li>
454
+ <li><a href="mailto:augusto.pissarra@myndware.com">Myndware</a></li>
455
455
  </ul>
456
456
  </dd>
457
457
 
@@ -725,7 +725,7 @@ const result = await api.user.process.downloadDocs(params, session);</code></pre
725
725
  <dt class="tag-author">Author:</dt>
726
726
  <dd class="tag-author">
727
727
  <ul>
728
- <li><a href="mailto:abernardo.br@gmail.com">CloudBrasil</a></li>
728
+ <li><a href="mailto:augusto.pissarra@myndware.com">Myndware</a></li>
729
729
  </ul>
730
730
  </dd>
731
731
 
@@ -972,7 +972,7 @@ const retSearch = await api.user.process.exportProcessData(params, session);</co
972
972
  <dt class="tag-author">Author:</dt>
973
973
  <dd class="tag-author">
974
974
  <ul>
975
- <li><a href="mailto:abernardo.br@gmail.com">CloudBrasil</a></li>
975
+ <li><a href="mailto:augusto.pissarra@myndware.com">Myndware</a></li>
976
976
  </ul>
977
977
  </dd>
978
978
 
@@ -1219,7 +1219,7 @@ const retSearch = await api.user.process.exportStatusData(params, session);</cod
1219
1219
  <dt class="tag-author">Author:</dt>
1220
1220
  <dd class="tag-author">
1221
1221
  <ul>
1222
- <li><a href="mailto:abernardo.br@gmail.com">CloudBrasil</a></li>
1222
+ <li><a href="mailto:augusto.pissarra@myndware.com">Myndware</a></li>
1223
1223
  </ul>
1224
1224
  </dd>
1225
1225
 
@@ -1563,7 +1563,7 @@ const retSearch = await api.user.process.find(params, session);</code></pre>
1563
1563
  <dt class="tag-author">Author:</dt>
1564
1564
  <dd class="tag-author">
1565
1565
  <ul>
1566
- <li><a href="mailto:abernardo.br@gmail.com">CloudBrasil</a></li>
1566
+ <li><a href="mailto:augusto.pissarra@myndware.com">Myndware</a></li>
1567
1567
  </ul>
1568
1568
  </dd>
1569
1569
 
@@ -1926,7 +1926,7 @@ const retSearchInfo = await api.user.process.getOrgProcessSearchInfo(params, ses
1926
1926
  <dt class="tag-author">Author:</dt>
1927
1927
  <dd class="tag-author">
1928
1928
  <ul>
1929
- <li><a href="mailto:abernardo.br@gmail.com">CloudBrasil</a></li>
1929
+ <li><a href="mailto:augusto.pissarra@myndware.com">Myndware</a></li>
1930
1930
  </ul>
1931
1931
  </dd>
1932
1932
 
@@ -2219,7 +2219,7 @@ await api.user.process.getProcessProperties(params, session);</code></pre>
2219
2219
  <dt class="tag-author">Author:</dt>
2220
2220
  <dd class="tag-author">
2221
2221
  <ul>
2222
- <li><a href="mailto:abernardo.br@gmail.com">CloudBrasil</a></li>
2222
+ <li><a href="mailto:augusto.pissarra@myndware.com">Myndware</a></li>
2223
2223
  </ul>
2224
2224
  </dd>
2225
2225
 
@@ -2510,7 +2510,7 @@ const retSearch = await api.user.process.processDocs(params, session);</code></p
2510
2510
  <dt class="tag-author">Author:</dt>
2511
2511
  <dd class="tag-author">
2512
2512
  <ul>
2513
- <li><a href="mailto:abernardo.br@gmail.com">CloudBrasil</a></li>
2513
+ <li><a href="mailto:augusto.pissarra@myndware.com">Myndware</a></li>
2514
2514
  </ul>
2515
2515
  </dd>
2516
2516
 
@@ -2848,7 +2848,7 @@ const retSearch = await api.user.process.remove(params, session);</code></pre>
2848
2848
  <dt class="tag-author">Author:</dt>
2849
2849
  <dd class="tag-author">
2850
2850
  <ul>
2851
- <li><a href="mailto:abernardo.br@gmail.com">CloudBrasil</a></li>
2851
+ <li><a href="mailto:augusto.pissarra@myndware.com">Myndware</a></li>
2852
2852
  </ul>
2853
2853
  </dd>
2854
2854
 
@@ -776,7 +776,7 @@
776
776
  <dt class="tag-author">Author:</dt>
777
777
  <dd class="tag-author">
778
778
  <ul>
779
- <li><a href="mailto:abernardo.br@gmail.com">CloudBrasil</a></li>
779
+ <li><a href="mailto:augusto.pissarra@myndware.com">Myndware</a></li>
780
780
  </ul>
781
781
  </dd>
782
782
 
@@ -1054,7 +1054,7 @@ const retData = await api.user.register.execute(params);</code></pre>
1054
1054
  <dt class="tag-author">Author:</dt>
1055
1055
  <dd class="tag-author">
1056
1056
  <ul>
1057
- <li><a href="mailto:abernardo.br@gmail.com">CloudBrasil</a></li>
1057
+ <li><a href="mailto:augusto.pissarra@myndware.com">Myndware</a></li>
1058
1058
  </ul>
1059
1059
  </dd>
1060
1060
 
@@ -1299,7 +1299,7 @@ const orgname = await api.user.register.getOrgname(params);</code></pre>
1299
1299
  <dt class="tag-author">Author:</dt>
1300
1300
  <dd class="tag-author">
1301
1301
  <ul>
1302
- <li><a href="mailto:abernardo.br@gmail.com">CloudBrasil</a></li>
1302
+ <li><a href="mailto:augusto.pissarra@myndware.com">Myndware</a></li>
1303
1303
  </ul>
1304
1304
  </dd>
1305
1305
 
@@ -331,7 +331,7 @@
331
331
  <dt class="tag-author">Author:</dt>
332
332
  <dd class="tag-author">
333
333
  <ul>
334
- <li><a href="mailto:abernardo.br@gmail.com">CloudBrasil</a></li>
334
+ <li><a href="mailto:augusto.pissarra@myndware.com">Myndware</a></li>
335
335
  </ul>
336
336
  </dd>
337
337
 
@@ -523,7 +523,7 @@ ret settings = await api.user.settings.get(session);</code></pre>
523
523
  <dt class="tag-author">Author:</dt>
524
524
  <dd class="tag-author">
525
525
  <ul>
526
- <li><a href="mailto:abernardo.br@gmail.com">CloudBrasil</a></li>
526
+ <li><a href="mailto:augusto.pissarra@myndware.com">Myndware</a></li>
527
527
  </ul>
528
528
  </dd>
529
529
 
@@ -740,7 +740,7 @@ await api.user.settings.remove(session);</code></pre>
740
740
  <dt class="tag-author">Author:</dt>
741
741
  <dd class="tag-author">
742
742
  <ul>
743
- <li><a href="mailto:abernardo.br@gmail.com">CloudBrasil</a></li>
743
+ <li><a href="mailto:augusto.pissarra@myndware.com">Myndware</a></li>
744
744
  </ul>
745
745
  </dd>
746
746
 
package/docs/Task.html CHANGED
@@ -479,7 +479,7 @@
479
479
  <dt class="tag-author">Author:</dt>
480
480
  <dd class="tag-author">
481
481
  <ul>
482
- <li><a href="mailto:abernardo.br@gmail.com">CloudBrasil</a></li>
482
+ <li><a href="mailto:augusto.pissarra@myndware.com">Myndware</a></li>
483
483
  </ul>
484
484
  </dd>
485
485
 
@@ -774,7 +774,7 @@ await api.user.task.executeActionFinalize(params, session);</code></pre>
774
774
  <dt class="tag-author">Author:</dt>
775
775
  <dd class="tag-author">
776
776
  <ul>
777
- <li><a href="mailto:abernardo.br@gmail.com">CloudBrasil</a></li>
777
+ <li><a href="mailto:augusto.pissarra@myndware.com">Myndware</a></li>
778
778
  </ul>
779
779
  </dd>
780
780
 
@@ -1267,7 +1267,7 @@ await api.user.task.findById(params, session);</code></pre>
1267
1267
  <dt class="tag-author">Author:</dt>
1268
1268
  <dd class="tag-author">
1269
1269
  <ul>
1270
- <li><a href="mailto:abernardo.br@gmail.com">CloudBrasil</a></li>
1270
+ <li><a href="mailto:augusto.pissarra@myndware.com">Myndware</a></li>
1271
1271
  </ul>
1272
1272
  </dd>
1273
1273
 
@@ -1353,6 +1353,290 @@ await api.user.task.findByIdAndUpdate(params, session);</code></pre>
1353
1353
 
1354
1354
 
1355
1355
 
1356
+ </div>
1357
+
1358
+ <div class="member">
1359
+
1360
+
1361
+
1362
+ <h4 class="name" id="getSummaryByTags">
1363
+ <a class="href-link" href="#getSummaryByTags">#</a>
1364
+
1365
+
1366
+ <span class='tag'>async</span>
1367
+
1368
+
1369
+ <span class="code-name">
1370
+
1371
+ getSummaryByTags<span class="signature">(params, session)</span><span class="type-signature"> &rarr; {Promise.&lt;object>|Promise.&lt;object>|Promise.&lt;object>}</span>
1372
+
1373
+ </span>
1374
+ </h4>
1375
+
1376
+
1377
+
1378
+
1379
+ <div class="description">
1380
+ Get the tasks and available tasks summary (totals) for specific tags
1381
+ </div>
1382
+
1383
+
1384
+
1385
+
1386
+
1387
+
1388
+
1389
+
1390
+
1391
+
1392
+ <h5>Parameters:</h5>
1393
+
1394
+ <div class="table-container">
1395
+ <table class="params table">
1396
+ <thead>
1397
+ <tr>
1398
+
1399
+ <th>Name</th>
1400
+
1401
+
1402
+ <th>Type</th>
1403
+
1404
+
1405
+
1406
+
1407
+
1408
+ <th class="last">Description</th>
1409
+ </tr>
1410
+ </thead>
1411
+
1412
+ <tbody>
1413
+
1414
+
1415
+
1416
+ <tr class="deep-level-0">
1417
+
1418
+ <td class="name"><code>params</code></td>
1419
+
1420
+
1421
+ <td class="type">
1422
+
1423
+
1424
+ <code class="param-type">object</code>
1425
+
1426
+
1427
+
1428
+ </td>
1429
+
1430
+
1431
+
1432
+
1433
+
1434
+ <td class="description last">Params - to update task</td>
1435
+ </tr>
1436
+
1437
+
1438
+
1439
+
1440
+ <tr class="deep-level-1">
1441
+
1442
+ <td class="name"><code>tags</code></td>
1443
+
1444
+
1445
+ <td class="type">
1446
+
1447
+
1448
+ <code class="param-type">array.&lt;string></code>
1449
+
1450
+
1451
+
1452
+ </td>
1453
+
1454
+
1455
+
1456
+
1457
+
1458
+ <td class="description last">The tags to get task summaries</td>
1459
+ </tr>
1460
+
1461
+
1462
+
1463
+
1464
+
1465
+
1466
+
1467
+ <tr class="deep-level-0">
1468
+
1469
+ <td class="name"><code>session</code></td>
1470
+
1471
+
1472
+ <td class="type">
1473
+
1474
+
1475
+ <code class="param-type">string</code>
1476
+
1477
+
1478
+
1479
+ </td>
1480
+
1481
+
1482
+
1483
+
1484
+
1485
+ <td class="description last">Session, token JWT</td>
1486
+ </tr>
1487
+
1488
+
1489
+
1490
+ </tbody>
1491
+ </table>
1492
+ </div>
1493
+
1494
+
1495
+
1496
+
1497
+
1498
+ <dl class="details">
1499
+
1500
+
1501
+
1502
+
1503
+
1504
+
1505
+
1506
+
1507
+
1508
+
1509
+
1510
+
1511
+
1512
+
1513
+
1514
+
1515
+
1516
+
1517
+ <dt class="tag-author">Author:</dt>
1518
+ <dd class="tag-author">
1519
+ <ul>
1520
+ <li><a href="mailto:augusto.pissarra@myndware.com">Myndware</a></li>
1521
+ </ul>
1522
+ </dd>
1523
+
1524
+
1525
+
1526
+
1527
+
1528
+
1529
+
1530
+
1531
+
1532
+
1533
+
1534
+
1535
+
1536
+
1537
+ <p class="tag-source">
1538
+ <a href="user_task.js.html" class="button">View Source</a>
1539
+ <span>
1540
+ <a href="user_task.js.html">user/task.js</a>, <a href="user_task.js.html#line224">line 224</a>
1541
+ </span>
1542
+ </p>
1543
+
1544
+ </dl>
1545
+
1546
+
1547
+
1548
+
1549
+
1550
+
1551
+
1552
+
1553
+
1554
+
1555
+
1556
+
1557
+
1558
+
1559
+
1560
+
1561
+
1562
+
1563
+ <div class='columns method-parameter'>
1564
+ <div class="column is-2"><label>Returns:</label></div>
1565
+ <div class="column is-10">
1566
+
1567
+
1568
+
1569
+ <div class="columns">
1570
+
1571
+ <div class='param-desc column is-7'>data</div>
1572
+
1573
+
1574
+ <div class='column is-5 has-text-left'>
1575
+ <label>Type: </label>
1576
+
1577
+ <code class="param-type">Promise.&lt;object></code>
1578
+
1579
+
1580
+ </div>
1581
+
1582
+ </div>
1583
+
1584
+
1585
+
1586
+
1587
+ <div class="columns">
1588
+
1589
+ <div class='param-desc column is-7'>data.tasks - the total tasks</div>
1590
+
1591
+
1592
+ <div class='column is-5 has-text-left'>
1593
+ <label>Type: </label>
1594
+
1595
+ <code class="param-type">Promise.&lt;object></code>
1596
+
1597
+
1598
+ </div>
1599
+
1600
+ </div>
1601
+
1602
+
1603
+
1604
+
1605
+ <div class="columns">
1606
+
1607
+ <div class='param-desc column is-7'>data.availableTasks - the total available tasks</div>
1608
+
1609
+
1610
+ <div class='column is-5 has-text-left'>
1611
+ <label>Type: </label>
1612
+
1613
+ <code class="param-type">Promise.&lt;object></code>
1614
+
1615
+
1616
+ </div>
1617
+
1618
+ </div>
1619
+
1620
+
1621
+ </div>
1622
+ </div>
1623
+
1624
+
1625
+
1626
+
1627
+ <h5>Example</h5>
1628
+
1629
+
1630
+ <pre class="prettyprint"><code>const API = require('@docbrasil/api-systemmanager');
1631
+ const api = new API();
1632
+ const params = {
1633
+ tags: ['INCIDENTS']
1634
+ };
1635
+ const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
1636
+ await api.user.task.getSummaryByTags(params, session);</code></pre>
1637
+
1638
+
1639
+
1356
1640
  </div>
1357
1641
 
1358
1642
  </div>
@@ -405,7 +405,7 @@
405
405
  <dt class="tag-author">Author:</dt>
406
406
  <dd class="tag-author">
407
407
  <ul>
408
- <li><a href="mailto:abernardo.br@gmail.com">CloudBrasil</a></li>
408
+ <li><a href="mailto:augusto.pissarra@myndware.com">Myndware</a></li>
409
409
  </ul>
410
410
  </dd>
411
411
 
@@ -695,7 +695,7 @@ const success = await api.user.task.available.claim(params, session);</code></pr
695
695
  <dt class="tag-author">Author:</dt>
696
696
  <dd class="tag-author">
697
697
  <ul>
698
- <li><a href="mailto:abernardo.br@gmail.com">CloudBrasil</a></li>
698
+ <li><a href="mailto:augusto.pissarra@myndware.com">Myndware</a></li>
699
699
  </ul>
700
700
  </dd>
701
701