@docbrasil/api-systemmanager 1.0.107 → 1.0.109

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 (73) hide show
  1. package/.github/workflows/static.yml +43 -0
  2. package/api/external.js +41 -0
  3. package/dist/bundle.cjs +41 -0
  4. package/dist/bundle.mjs +1 -1
  5. package/doc/api.md +382 -0
  6. package/docs/Admin.html +336 -0
  7. package/docs/AdminDocuments.html +2235 -0
  8. package/docs/AdminForm.html +934 -0
  9. package/docs/AdminLists.html +895 -0
  10. package/docs/AdminMessage.html +1490 -0
  11. package/docs/AdminNotification.html +1636 -0
  12. package/docs/AdminPlugin.html +696 -0
  13. package/docs/AdminPolicy.html +451 -0
  14. package/docs/AdminProcesses.html +692 -0
  15. package/docs/AdminTask.html +740 -0
  16. package/docs/AdminUser.html +1203 -0
  17. package/docs/Datasource.html +660 -0
  18. package/docs/Dispatch.html +624 -0
  19. package/docs/Documents.html +4875 -0
  20. package/docs/External.html +1497 -0
  21. package/docs/GeoLocation.html +503 -0
  22. package/docs/Login.html +1839 -0
  23. package/docs/Notification.html +625 -0
  24. package/docs/Organization.html +2767 -0
  25. package/docs/Process.html +1598 -0
  26. package/docs/Register.html +1604 -0
  27. package/docs/Session.html +482 -0
  28. package/docs/Task.html +1394 -0
  29. package/docs/TaskAvailable.html +893 -0
  30. package/docs/User.html +2002 -0
  31. package/docs/Users.html +569 -0
  32. package/docs/admin_doctypes.js.html +193 -0
  33. package/docs/admin_document.js.html +449 -0
  34. package/docs/admin_form.js.html +268 -0
  35. package/docs/admin_index.js.html +163 -0
  36. package/docs/admin_list.js.html +250 -0
  37. package/docs/admin_message.js.html +311 -0
  38. package/docs/admin_notification.js.html +350 -0
  39. package/docs/admin_organization.js.html +241 -0
  40. package/docs/admin_plugin.js.html +233 -0
  41. package/docs/admin_policy.js.html +195 -0
  42. package/docs/admin_processes.js.html +487 -0
  43. package/docs/admin_task.js.html +242 -0
  44. package/docs/admin_user.js.html +302 -0
  45. package/docs/dispatch.js.html +218 -0
  46. package/docs/external.js.html +333 -0
  47. package/docs/general_geoLocation.js.html +205 -0
  48. package/docs/general_index.js.html +140 -0
  49. package/docs/index.html +129 -0
  50. package/docs/login.js.html +384 -0
  51. package/docs/scripts/app.min.js +1 -0
  52. package/docs/scripts/linenumber.js +26 -0
  53. package/docs/scripts/search.js +39 -0
  54. package/docs/session.js.html +202 -0
  55. package/docs/styles/app.min.css +1 -0
  56. package/docs/styles/iframe.css +13 -0
  57. package/docs/styles/prettify-jsdoc.css +111 -0
  58. package/docs/styles/prettify-tomorrow.css +132 -0
  59. package/docs/styles/reset.css +44 -0
  60. package/docs/user_datasource.js.html +261 -0
  61. package/docs/user_document.js.html +847 -0
  62. package/docs/user_index.js.html +156 -0
  63. package/docs/user_notification.js.html +218 -0
  64. package/docs/user_organization.js.html +347 -0
  65. package/docs/user_process.js.html +352 -0
  66. package/docs/user_register.js.html +322 -0
  67. package/docs/user_task.js.html +319 -0
  68. package/docs/user_task_available.js.html +252 -0
  69. package/docs/user_user.js.html +404 -0
  70. package/docs/utils_promises.js.html +235 -0
  71. package/package.json +7 -4
  72. package/readme.md +7 -8
  73. package/doc.md +0 -653
@@ -0,0 +1,692 @@
1
+ <!DOCTYPE html>
2
+ <html lang="en">
3
+
4
+ <head>
5
+
6
+ <meta charset="utf-8">
7
+ <meta name="viewport" content="width=device-width, initial-scale=1">
8
+ <title> AdminProcesses</title>
9
+
10
+ <script src="https://cdn.jsdelivr.net/gh/google/code-prettify@master/loader/run_prettify.js"></script>
11
+ <script src="https://unpkg.com/@babel/standalone/babel.min.js"></script>
12
+ <script src="./build/entry.js"></script>
13
+ <script src="https://ajax.googleapis.com/ajax/libs/jquery/3.3.1/jquery.min.js"></script>
14
+ <!--[if lt IE 9]>
15
+ <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
16
+ <![endif]-->
17
+ <link href="https://fonts.googleapis.com/css?family=Roboto:100,400,700|Inconsolata,700" rel="stylesheet">
18
+ <link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.6.3/css/all.css" integrity="sha384-UHRtZLI+pbxtHCWp1t77Bi1L4ZtiqrqD80Kn4Z8NTSRyMA2Fd33n5dQ8lWUE00s/" crossorigin="anonymous">
19
+ <link type="text/css" rel="stylesheet" href="https://jmblog.github.io/color-themes-for-google-code-prettify/themes/tomorrow-night.min.css">
20
+ <link type="text/css" rel="stylesheet" href="styles/app.min.css">
21
+ <link type="text/css" rel="stylesheet" href="styles/iframe.css">
22
+ <link type="text/css" rel="stylesheet" href="">
23
+ <script async defer src="https://buttons.github.io/buttons.js"></script>
24
+
25
+
26
+ </head>
27
+
28
+
29
+
30
+ <body class="layout small-header">
31
+ <div id="stickyNavbarOverlay"></div>
32
+
33
+
34
+ <div class="top-nav">
35
+ <div class="inner">
36
+ <a id="hamburger" role="button" class="navbar-burger" aria-label="menu" aria-expanded="false">
37
+ <span aria-hidden="true"></span>
38
+ <span aria-hidden="true"></span>
39
+ <span aria-hidden="true"></span>
40
+ </a>
41
+ <div class="logo">
42
+
43
+
44
+ </div>
45
+ <div class="menu">
46
+
47
+ <div class="navigation">
48
+ <a
49
+ href="index.html"
50
+ class="link"
51
+ >
52
+ Documentation
53
+ </a>
54
+
55
+
56
+
57
+ </div>
58
+ </div>
59
+ </div>
60
+ </div>
61
+ <div id="main">
62
+ <div
63
+ class="sidebar "
64
+ id="sidebarNav"
65
+ >
66
+
67
+ <nav>
68
+
69
+ <h2><a href="index.html">Documentation</a></h2><div class="category"><h3>Classes</h3><ul><li><a href="Admin.html">Admin</a></li><li><a href="AdminDocuments.html">AdminDocuments</a></li><li><a href="AdminForm.html">AdminForm</a></li><li><a href="AdminLists.html">AdminLists</a></li><li><a href="AdminMessage.html">AdminMessage</a></li><li><a href="AdminNotification.html">AdminNotification</a></li><li><a href="AdminPlugin.html">AdminPlugin</a></li><li><a href="AdminPolicy.html">AdminPolicy</a></li><li><a href="AdminProcesses.html">AdminProcesses</a></li><li><a href="AdminTask.html">AdminTask</a></li><li><a href="AdminUser.html">AdminUser</a></li><li><a href="Datasource.html">Datasource</a></li><li><a href="Dispatch.html">Dispatch</a></li><li><a href="Documents.html">Documents</a></li><li><a href="External.html">External</a></li><li><a href="GeoLocation.html">GeoLocation</a></li><li><a href="Login.html">Login</a></li><li><a href="Notification.html">Notification</a></li><li><a href="Organization.html">Organization</a></li><li><a href="Process.html">Process</a></li><li><a href="Register.html">Register</a></li><li><a href="Session.html">Session</a></li><li><a href="Task.html">Task</a></li><li><a href="TaskAvailable.html">TaskAvailable</a></li><li><a href="User.html">User</a></li><li><a href="Users.html">Users</a></li></ul></div>
70
+
71
+ </nav>
72
+ </div>
73
+ <div class="core" id="main-content-wrapper">
74
+ <div class="content">
75
+ <header class="page-title">
76
+ <p>Class</p>
77
+ <h1>AdminProcesses</h1>
78
+ </header>
79
+
80
+
81
+
82
+
83
+
84
+ <section>
85
+
86
+ <header>
87
+
88
+ <h2><span class="attribs"><span class="type-signature"></span></span>AdminProcesses<span class="signature">()</span><span class="type-signature"></span></h2>
89
+
90
+ <div class="class-description">Admin Class for processes, permission admin</div>
91
+
92
+
93
+ </header>
94
+
95
+ <article>
96
+ <div class="container-overview">
97
+
98
+
99
+ <div class='vertical-section'>
100
+ <div class="members">
101
+ <div class="member">
102
+ <div class=name>
103
+ <span class="tag">Constructor</span>
104
+ </div>
105
+
106
+
107
+
108
+
109
+ <h4 class="name" id="AdminProcesses">
110
+ <a class="href-link" href="#AdminProcesses">#</a>
111
+
112
+ <span class="code-name">
113
+
114
+ new AdminProcesses<span class="signature">()</span><span class="type-signature"></span>
115
+
116
+ </span>
117
+ </h4>
118
+
119
+
120
+
121
+
122
+
123
+
124
+
125
+
126
+
127
+
128
+
129
+
130
+
131
+
132
+
133
+
134
+
135
+ <dl class="details">
136
+
137
+
138
+
139
+
140
+
141
+
142
+
143
+
144
+
145
+
146
+
147
+
148
+
149
+
150
+
151
+
152
+
153
+
154
+
155
+
156
+
157
+
158
+
159
+
160
+
161
+
162
+
163
+
164
+
165
+
166
+
167
+ <p class="tag-source">
168
+ <a href="admin_processes.js.html" class="button">View Source</a>
169
+ <span>
170
+ <a href="admin_processes.js.html">admin/processes.js</a>, <a href="admin_processes.js.html#line9">line 9</a>
171
+ </span>
172
+ </p>
173
+
174
+ </dl>
175
+
176
+
177
+
178
+
179
+
180
+
181
+
182
+
183
+
184
+
185
+
186
+
187
+
188
+
189
+
190
+
191
+
192
+
193
+
194
+
195
+
196
+
197
+ </div>
198
+ </div>
199
+ </div>
200
+
201
+
202
+ </div>
203
+
204
+
205
+
206
+
207
+
208
+
209
+
210
+
211
+
212
+
213
+
214
+
215
+
216
+
217
+
218
+
219
+ <div class='vertical-section'>
220
+ <h1>Methods</h1>
221
+ <div class="members">
222
+
223
+ <div class="member">
224
+
225
+
226
+
227
+ <h4 class="name" id="advancedSearch">
228
+ <a class="href-link" href="#advancedSearch">#</a>
229
+
230
+
231
+ <span class='tag'>async</span>
232
+
233
+
234
+ <span class="code-name">
235
+
236
+ advancedSearch<span class="signature">(params<span class="signature-attributes">non-null</span>, session<span class="signature-attributes">non-null</span>)</span><span class="type-signature"> &rarr; {Promise}</span>
237
+
238
+ </span>
239
+ </h4>
240
+
241
+
242
+
243
+
244
+ <div class="description">
245
+ Advanced search of process in elastic search ussing system manager
246
+ </div>
247
+
248
+
249
+
250
+
251
+
252
+
253
+
254
+
255
+
256
+
257
+ <h5>Parameters:</h5>
258
+
259
+ <div class="table-container">
260
+ <table class="params table">
261
+ <thead>
262
+ <tr>
263
+
264
+ <th>Name</th>
265
+
266
+
267
+ <th>Type</th>
268
+
269
+
270
+
271
+
272
+
273
+ <th class="last">Description</th>
274
+ </tr>
275
+ </thead>
276
+
277
+ <tbody>
278
+
279
+
280
+
281
+ <tr class="deep-level-0">
282
+
283
+ <td class="name"><code>params</code></td>
284
+
285
+
286
+ <td class="type">
287
+
288
+
289
+ <code class="param-type">object</code>
290
+
291
+
292
+
293
+ </td>
294
+
295
+
296
+
297
+
298
+
299
+ <td class="description last">Params to search document</td>
300
+ </tr>
301
+
302
+
303
+
304
+
305
+ <tr class="deep-level-1">
306
+
307
+ <td class="name"><code>orgProcessId</code></td>
308
+
309
+
310
+ <td class="type">
311
+
312
+
313
+ <code class="param-type">string</code>
314
+
315
+
316
+
317
+ </td>
318
+
319
+
320
+
321
+
322
+
323
+ <td class="description last">Document id (_id database) of the process</td>
324
+ </tr>
325
+
326
+
327
+
328
+ <tr class="deep-level-1">
329
+
330
+ <td class="name"><code>query</code></td>
331
+
332
+
333
+ <td class="type">
334
+
335
+
336
+ <code class="param-type">object</code>
337
+
338
+
339
+
340
+ </td>
341
+
342
+
343
+
344
+
345
+
346
+ <td class="description last">Query to search in elastic search</td>
347
+ </tr>
348
+
349
+
350
+
351
+
352
+
353
+
354
+
355
+ <tr class="deep-level-0">
356
+
357
+ <td class="name"><code>session</code></td>
358
+
359
+
360
+ <td class="type">
361
+
362
+
363
+ <code class="param-type">string</code>
364
+
365
+
366
+
367
+ </td>
368
+
369
+
370
+
371
+
372
+
373
+ <td class="description last">Session, token JWT</td>
374
+ </tr>
375
+
376
+
377
+
378
+ </tbody>
379
+ </table>
380
+ </div>
381
+
382
+
383
+
384
+
385
+
386
+ <dl class="details">
387
+
388
+
389
+
390
+
391
+
392
+
393
+
394
+
395
+
396
+
397
+
398
+
399
+
400
+
401
+
402
+
403
+
404
+
405
+ <dt class="tag-author">Author:</dt>
406
+ <dd class="tag-author">
407
+ <ul>
408
+ <li><a href="mailto:abernardo.br@gmail.com">CloudBrasil</a></li>
409
+ </ul>
410
+ </dd>
411
+
412
+
413
+
414
+
415
+
416
+
417
+
418
+
419
+
420
+
421
+
422
+
423
+
424
+
425
+ <p class="tag-source">
426
+ <a href="admin_processes.js.html" class="button">View Source</a>
427
+ <span>
428
+ <a href="admin_processes.js.html">admin/processes.js</a>, <a href="admin_processes.js.html#line350">line 350</a>
429
+ </span>
430
+ </p>
431
+
432
+ </dl>
433
+
434
+
435
+
436
+
437
+
438
+
439
+
440
+
441
+
442
+
443
+
444
+
445
+
446
+
447
+
448
+
449
+
450
+
451
+ <div class='columns method-parameter'>
452
+ <div class="column is-2"><label>Returns:</label></div>
453
+ <div class="column is-10">
454
+
455
+
456
+
457
+ <div class="columns">
458
+
459
+
460
+ <div class='column is-5 has-text-left'>
461
+ <label>Type: </label>
462
+
463
+ <code class="param-type">Promise</code>
464
+
465
+
466
+ </div>
467
+
468
+ </div>
469
+
470
+
471
+ </div>
472
+ </div>
473
+
474
+
475
+
476
+
477
+ <h5>Example</h5>
478
+
479
+
480
+ <pre class="prettyprint"><code>const API = require('@docbrasil/api-systemmanager');
481
+ const api = new API();
482
+ const params = {
483
+ orgProcessId: '5edd11c46b6ce9729c2c297c',
484
+ query: {
485
+ "_source": "processData.properties.processProperties",
486
+ "query": {
487
+ "term": {
488
+ "initParams.email.keyword": {
489
+ "value": "clintes001@gmail.com"
490
+ }
491
+ }
492
+ }
493
+ }
494
+ }
495
+ const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
496
+ await api.admin.processes.advancedSearch(params, session);</code></pre>
497
+
498
+
499
+
500
+ </div>
501
+
502
+ <div class="member">
503
+
504
+
505
+
506
+ <h4 class="name" id="search">
507
+ <a class="href-link" href="#search">#</a>
508
+
509
+
510
+ <span class='tag'>async</span>
511
+
512
+
513
+ <span class="code-name">
514
+
515
+ search<span class="signature">()</span><span class="type-signature"> &rarr; {Promise}</span>
516
+
517
+ </span>
518
+ </h4>
519
+
520
+
521
+
522
+
523
+ <div class="description">
524
+ Advanced search of processes, check documentation, to verify all params, pass to method search
525
+ </div>
526
+
527
+
528
+
529
+
530
+
531
+
532
+
533
+
534
+
535
+
536
+
537
+
538
+
539
+
540
+ <dl class="details">
541
+
542
+
543
+
544
+
545
+
546
+
547
+
548
+
549
+
550
+
551
+
552
+
553
+
554
+
555
+
556
+
557
+
558
+
559
+ <dt class="tag-author">Author:</dt>
560
+ <dd class="tag-author">
561
+ <ul>
562
+ <li><a href="mailto:abernardo.br@gmail.com">CloudBrasil</a></li>
563
+ </ul>
564
+ </dd>
565
+
566
+
567
+
568
+
569
+
570
+
571
+
572
+
573
+
574
+
575
+ <dt class="tag-see">See:</dt>
576
+ <dd class="tag-see">
577
+ <ul>
578
+ <li><a href="https://confluence.external-share.com/content/7450b014-52c6-4d9e-b30e-a062b57453b5/17104899/17694721/532545537">https://confluence.external-share.com/content/7450b014-52c6-4d9e-b30e-a062b57453b5/17104899/17694721/532545537</a></li>
579
+ </ul>
580
+ </dd>
581
+
582
+
583
+
584
+
585
+
586
+ <p class="tag-source">
587
+ <a href="admin_processes.js.html" class="button">View Source</a>
588
+ <span>
589
+ <a href="admin_processes.js.html">admin/processes.js</a>, <a href="admin_processes.js.html#line277">line 277</a>
590
+ </span>
591
+ </p>
592
+
593
+ </dl>
594
+
595
+
596
+
597
+
598
+
599
+
600
+
601
+
602
+
603
+
604
+
605
+
606
+
607
+
608
+
609
+
610
+
611
+
612
+ <div class='columns method-parameter'>
613
+ <div class="column is-2"><label>Returns:</label></div>
614
+ <div class="column is-10">
615
+
616
+
617
+
618
+ <div class="columns">
619
+
620
+
621
+ <div class='column is-5 has-text-left'>
622
+ <label>Type: </label>
623
+
624
+ <code class="param-type">Promise</code>
625
+
626
+
627
+ </div>
628
+
629
+ </div>
630
+
631
+
632
+ </div>
633
+ </div>
634
+
635
+
636
+
637
+
638
+ <h5>Example</h5>
639
+
640
+
641
+ <pre class="prettyprint"><code>const API = require('@docbrasil/api-systemmanager');
642
+ const api = new API();
643
+ const params = {
644
+ orgId: '5edd11c46b6ce9729c2c297c',
645
+ ...
646
+ ...
647
+ ...
648
+ };
649
+ const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
650
+ await api.admin.processes.search(params, session);</code></pre>
651
+
652
+
653
+
654
+ </div>
655
+
656
+ </div>
657
+ </div>
658
+
659
+
660
+
661
+
662
+
663
+ </article>
664
+
665
+ </section>
666
+
667
+
668
+
669
+
670
+ </div>
671
+
672
+ <footer class="footer">
673
+ <div class="content has-text-centered">
674
+ <p>Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a></p>
675
+ <p class="sidebar-created-by">
676
+ <a href="https://github.com/SoftwareBrothers/better-docs" target="_blank">BetterDocs theme</a> provided with <i class="fas fa-heart"></i> by
677
+ <a href="http://softwarebrothers.co" target="_blank">SoftwareBrothers - JavaScript Development Agency</a>
678
+ </p>
679
+ </div>
680
+ </footer>
681
+
682
+ </div>
683
+ <div id="side-nav" class="side-nav">
684
+ </div>
685
+ </div>
686
+ <script src="scripts/app.min.js"></script>
687
+ <script>PR.prettyPrint();</script>
688
+ <script src="scripts/linenumber.js"> </script>
689
+
690
+
691
+ </body>
692
+ </html>