@docbrasil/api-systemmanager 1.1.19 → 1.1.20
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.
- package/api/admin/doctypes.js +3 -3
- package/api/admin/document.js +7 -7
- package/api/admin/form.js +3 -3
- package/api/admin/index.js +1 -1
- package/api/admin/list.js +3 -3
- package/api/admin/message.js +2 -2
- package/api/admin/notification.js +5 -5
- package/api/admin/organization.js +3 -3
- package/api/admin/plugin.js +2 -2
- package/api/admin/policy.js +3 -3
- package/api/admin/processes.js +4 -4
- package/api/admin/task.js +3 -3
- package/api/admin/user.js +6 -6
- package/api/dispatch.js +2 -2
- package/api/external.js +5 -5
- package/api/general/geoLocation.js +3 -3
- package/api/general/index.js +1 -1
- package/api/login.js +7 -7
- package/api/session.js +1 -1
- package/api/user/application.js +2 -2
- package/api/user/datasource.js +2 -2
- package/api/user/document.js +13 -13
- package/api/user/help.js +2 -2
- package/api/user/index.js +1 -1
- package/api/user/my_tasks.js +12 -12
- package/api/user/notification.js +4 -4
- package/api/user/organization.js +4 -4
- package/api/user/page.js +2 -2
- package/api/user/process.js +12 -12
- package/api/user/register.js +4 -4
- package/api/user/settings.js +5 -5
- package/api/user/task.js +41 -4
- package/api/user/task_available.js +3 -3
- package/api/user/updates.js +1 -1
- package/api/user/user.js +8 -8
- package/dist/bundle.cjs +180 -143
- package/dist/bundle.mjs +1 -1
- package/doc/api.md +129 -102
- package/docs/Admin.html +1 -1
- package/docs/AdminDocuments.html +6 -6
- package/docs/AdminForm.html +2 -2
- package/docs/AdminLists.html +2 -2
- package/docs/AdminNotification.html +4 -4
- package/docs/AdminPlugin.html +1 -1
- package/docs/AdminPolicy.html +1 -1
- package/docs/AdminProcesses.html +2 -2
- package/docs/AdminTask.html +1 -1
- package/docs/AdminUser.html +4 -4
- package/docs/Application.html +1 -1
- package/docs/Datasource.html +1 -1
- package/docs/Dispatch.html +1 -1
- package/docs/Documents.html +10 -10
- package/docs/External.html +4 -4
- package/docs/GeoLocation.html +1 -1
- package/docs/Help.html +1 -1
- package/docs/Login.html +6 -6
- package/docs/MyTasks.html +10 -10
- package/docs/Notification.html +3 -3
- package/docs/Organization.html +6 -6
- package/docs/Page.html +1 -1
- package/docs/Process.html +9 -9
- package/docs/Register.html +3 -3
- package/docs/Settings.html +3 -3
- package/docs/Task.html +287 -3
- package/docs/TaskAvailable.html +2 -2
- package/docs/User.html +6 -6
- package/docs/Users.html +2 -2
- package/docs/admin_doctypes.js.html +3 -3
- package/docs/admin_document.js.html +7 -7
- package/docs/admin_form.js.html +3 -3
- package/docs/admin_index.js.html +1 -1
- package/docs/admin_list.js.html +3 -3
- package/docs/admin_message.js.html +2 -2
- package/docs/admin_notification.js.html +5 -5
- package/docs/admin_organization.js.html +3 -3
- package/docs/admin_plugin.js.html +2 -2
- package/docs/admin_policy.js.html +3 -3
- package/docs/admin_processes.js.html +4 -4
- package/docs/admin_task.js.html +3 -3
- package/docs/admin_user.js.html +6 -6
- package/docs/dispatch.js.html +2 -2
- package/docs/external.js.html +5 -5
- package/docs/general_geoLocation.js.html +3 -3
- package/docs/general_index.js.html +1 -1
- package/docs/login.js.html +7 -7
- package/docs/session.js.html +1 -1
- package/docs/user_application.js.html +2 -2
- package/docs/user_datasource.js.html +2 -2
- package/docs/user_document.js.html +13 -13
- package/docs/user_help.js.html +2 -2
- package/docs/user_index.js.html +1 -1
- package/docs/user_my_tasks.js.html +11 -11
- package/docs/user_notification.js.html +4 -4
- package/docs/user_organization.js.html +4 -4
- package/docs/user_page.js.html +2 -2
- package/docs/user_process.js.html +12 -12
- package/docs/user_register.js.html +4 -4
- package/docs/user_settings.js.html +5 -5
- package/docs/user_task.js.html +41 -4
- package/docs/user_task_available.js.html +3 -3
- package/docs/user_updates.js.html +1 -1
- package/docs/user_user.js.html +8 -8
- package/package.json +1 -1
- package/.project +0 -11
package/doc/api.md
CHANGED
|
@@ -127,7 +127,7 @@ Advanced search of document in elastic search ussing system manager
|
|
|
127
127
|
|
|
128
128
|
**Kind**: instance method of [<code>AdminDocuments</code>](#AdminDocuments)
|
|
129
129
|
**Access**: public
|
|
130
|
-
**Author**:
|
|
130
|
+
**Author**: Myndware <augusto.pissarra@myndware.com>
|
|
131
131
|
|
|
132
132
|
| Param | Type | Description |
|
|
133
133
|
| --- | --- | --- |
|
|
@@ -173,7 +173,7 @@ Get document by id
|
|
|
173
173
|
|
|
174
174
|
**Kind**: instance method of [<code>AdminDocuments</code>](#AdminDocuments)
|
|
175
175
|
**Access**: public
|
|
176
|
-
**Author**:
|
|
176
|
+
**Author**: Myndware <augusto.pissarra@myndware.com>
|
|
177
177
|
|
|
178
178
|
| Param | Type | Description |
|
|
179
179
|
| --- | --- | --- |
|
|
@@ -201,7 +201,7 @@ Request signed url url to put or get
|
|
|
201
201
|
**Kind**: instance method of [<code>AdminDocuments</code>](#AdminDocuments)
|
|
202
202
|
**Returns**: <code>Promise.<object></code> - doc Returned document data with the signed url<code>string</code> - doc.docId Document id<code>string</code> - doc.name The name of the document, which is the fileName<code>string</code> - doc.areaId docAreaId of the document<code>string</code> - doc.type the document mimi type<code>string</code> - doc.signedUrl the signed URL to upload
|
|
203
203
|
**Access**: public
|
|
204
|
-
**Author**:
|
|
204
|
+
**Author**: Myndware <augusto.pissarra@myndware.com>
|
|
205
205
|
|
|
206
206
|
| Param | Type | Description |
|
|
207
207
|
| --- | --- | --- |
|
|
@@ -240,7 +240,7 @@ Update a document content
|
|
|
240
240
|
**Kind**: instance method of [<code>AdminDocuments</code>](#AdminDocuments)
|
|
241
241
|
**Returns**: <code>Promise.<object></code> - doc Returned document data with the signed url
|
|
242
242
|
**Access**: public
|
|
243
|
-
**Author**:
|
|
243
|
+
**Author**: Myndware <augusto.pissarra@myndware.com>
|
|
244
244
|
|
|
245
245
|
| Param | Type | Description |
|
|
246
246
|
| --- | --- | --- |
|
|
@@ -268,7 +268,7 @@ Update a document content
|
|
|
268
268
|
**Kind**: instance method of [<code>AdminDocuments</code>](#AdminDocuments)
|
|
269
269
|
**Returns**: <code>Promise.<object></code> - doc Returned document data with the signed url
|
|
270
270
|
**Access**: public
|
|
271
|
-
**Author**:
|
|
271
|
+
**Author**: Myndware <augusto.pissarra@myndware.com>
|
|
272
272
|
|
|
273
273
|
| Param | Type | Description |
|
|
274
274
|
| --- | --- | --- |
|
|
@@ -302,7 +302,7 @@ Get the content of a document
|
|
|
302
302
|
**Kind**: instance method of [<code>AdminDocuments</code>](#AdminDocuments)
|
|
303
303
|
**Returns**: <code>Promise.<object></code> - data the document content<code>string</code> - data._id the _id of the document<code>string</code> - data.content all the pages or if asked by page, just one page, the one requested<code>string</code> - data.content.TextOverlay the overlay text if requested<code>string</code> - data.content.ParsedText the page text content<code>number</code> - data.total the total number of pages
|
|
304
304
|
**Access**: public
|
|
305
|
-
**Author**:
|
|
305
|
+
**Author**: Myndware <augusto.pissarra@myndware.com>
|
|
306
306
|
|
|
307
307
|
| Param | Type | Description |
|
|
308
308
|
| --- | --- | --- |
|
|
@@ -340,7 +340,7 @@ Get advance form by ID
|
|
|
340
340
|
|
|
341
341
|
**Kind**: instance method of [<code>AdminForm</code>](#AdminForm)
|
|
342
342
|
**Access**: public
|
|
343
|
-
**Author**:
|
|
343
|
+
**Author**: Myndware <augusto.pissarra@myndware.com>
|
|
344
344
|
|
|
345
345
|
| Param | Type | Description |
|
|
346
346
|
| --- | --- | --- |
|
|
@@ -367,7 +367,7 @@ Request signed url url to put or get
|
|
|
367
367
|
|
|
368
368
|
**Kind**: instance method of [<code>AdminForm</code>](#AdminForm)
|
|
369
369
|
**Access**: public
|
|
370
|
-
**Author**:
|
|
370
|
+
**Author**: Myndware <augusto.pissarra@myndware.com>
|
|
371
371
|
|
|
372
372
|
| Param | Type | Default | Description |
|
|
373
373
|
| --- | --- | --- | --- |
|
|
@@ -396,7 +396,7 @@ await api.user.form.getFormList(params, session);
|
|
|
396
396
|
API request, admin permission level
|
|
397
397
|
|
|
398
398
|
**Kind**: global class
|
|
399
|
-
**Author**:
|
|
399
|
+
**Author**: Myndware <augusto.pissarra@myndware.com>
|
|
400
400
|
<a name="new_Admin_new"></a>
|
|
401
401
|
|
|
402
402
|
### new Admin(options)
|
|
@@ -424,7 +424,7 @@ Get list by ID
|
|
|
424
424
|
|
|
425
425
|
**Kind**: instance method of [<code>AdminLists</code>](#AdminLists)
|
|
426
426
|
**Access**: public
|
|
427
|
-
**Author**:
|
|
427
|
+
**Author**: Myndware <augusto.pissarra@myndware.com>
|
|
428
428
|
|
|
429
429
|
| Param | Type | Description |
|
|
430
430
|
| --- | --- | --- |
|
|
@@ -451,7 +451,7 @@ Get all lists
|
|
|
451
451
|
|
|
452
452
|
**Kind**: instance method of [<code>AdminLists</code>](#AdminLists)
|
|
453
453
|
**Access**: public
|
|
454
|
-
**Author**:
|
|
454
|
+
**Author**: Myndware <augusto.pissarra@myndware.com>
|
|
455
455
|
|
|
456
456
|
| Param | Type | Default | Description |
|
|
457
457
|
| --- | --- | --- | --- |
|
|
@@ -592,7 +592,7 @@ Create notification
|
|
|
592
592
|
|
|
593
593
|
**Kind**: instance method of [<code>AdminNotification</code>](#AdminNotification)
|
|
594
594
|
**Access**: public
|
|
595
|
-
**Author**:
|
|
595
|
+
**Author**: Myndware <augusto.pissarra@myndware.com>
|
|
596
596
|
|
|
597
597
|
| Param | Type | Description |
|
|
598
598
|
| --- | --- | --- |
|
|
@@ -621,7 +621,7 @@ Search notification using (notificationId or userId)
|
|
|
621
621
|
|
|
622
622
|
**Kind**: instance method of [<code>AdminNotification</code>](#AdminNotification)
|
|
623
623
|
**Access**: public
|
|
624
|
-
**Author**:
|
|
624
|
+
**Author**: Myndware <augusto.pissarra@myndware.com>
|
|
625
625
|
|
|
626
626
|
| Param | Type | Description |
|
|
627
627
|
| --- | --- | --- |
|
|
@@ -648,7 +648,7 @@ Update notification using (notificationId or userId)
|
|
|
648
648
|
|
|
649
649
|
**Kind**: instance method of [<code>AdminNotification</code>](#AdminNotification)
|
|
650
650
|
**Access**: public
|
|
651
|
-
**Author**:
|
|
651
|
+
**Author**: Myndware <augusto.pissarra@myndware.com>
|
|
652
652
|
|
|
653
653
|
| Param | Type | Description |
|
|
654
654
|
| --- | --- | --- |
|
|
@@ -677,7 +677,7 @@ Delete notification using (notificationId or userId)
|
|
|
677
677
|
|
|
678
678
|
**Kind**: instance method of [<code>AdminNotification</code>](#AdminNotification)
|
|
679
679
|
**Access**: public
|
|
680
|
-
**Author**:
|
|
680
|
+
**Author**: Myndware <augusto.pissarra@myndware.com>
|
|
681
681
|
|
|
682
682
|
| Param | Type | Description |
|
|
683
683
|
| --- | --- | --- |
|
|
@@ -720,7 +720,7 @@ Update avatar of organization by session of user not allow session user SU
|
|
|
720
720
|
|
|
721
721
|
**Kind**: instance method of [<code>Organization</code>](#Organization)
|
|
722
722
|
**Access**: public
|
|
723
|
-
**Author**:
|
|
723
|
+
**Author**: Myndware <augusto.pissarra@myndware.com>
|
|
724
724
|
|
|
725
725
|
| Param | Type | Description |
|
|
726
726
|
| --- | --- | --- |
|
|
@@ -749,7 +749,7 @@ Remove avatar of user by session of user not allow session user SU
|
|
|
749
749
|
|
|
750
750
|
**Kind**: instance method of [<code>Organization</code>](#Organization)
|
|
751
751
|
**Access**: public
|
|
752
|
-
**Author**:
|
|
752
|
+
**Author**: Myndware <augusto.pissarra@myndware.com>
|
|
753
753
|
|
|
754
754
|
| Param | Type | Description |
|
|
755
755
|
| --- | --- | --- |
|
|
@@ -815,7 +815,7 @@ Update avatar of organization by session of user not allow session user SU
|
|
|
815
815
|
|
|
816
816
|
**Kind**: instance method of [<code>Organization</code>](#Organization)
|
|
817
817
|
**Access**: public
|
|
818
|
-
**Author**:
|
|
818
|
+
**Author**: Myndware <augusto.pissarra@myndware.com>
|
|
819
819
|
|
|
820
820
|
| Param | Type | Description |
|
|
821
821
|
| --- | --- | --- |
|
|
@@ -842,7 +842,7 @@ Remove avatar of user by session of user not allow session user SU
|
|
|
842
842
|
|
|
843
843
|
**Kind**: instance method of [<code>Organization</code>](#Organization)
|
|
844
844
|
**Access**: public
|
|
845
|
-
**Author**:
|
|
845
|
+
**Author**: Myndware <augusto.pissarra@myndware.com>
|
|
846
846
|
|
|
847
847
|
| Param | Type | Description |
|
|
848
848
|
| --- | --- | --- |
|
|
@@ -862,7 +862,7 @@ Call URL internal, need auth JWT (session)
|
|
|
862
862
|
|
|
863
863
|
**Kind**: instance method of [<code>Organization</code>](#Organization)
|
|
864
864
|
**Access**: public
|
|
865
|
-
**Author**:
|
|
865
|
+
**Author**: Myndware <augusto.pissarra@myndware.com>
|
|
866
866
|
|
|
867
867
|
| Param | Type | Default | Description |
|
|
868
868
|
| --- | --- | --- | --- |
|
|
@@ -923,7 +923,7 @@ Get plugin by ID
|
|
|
923
923
|
|
|
924
924
|
**Kind**: instance method of [<code>AdminPlugin</code>](#AdminPlugin)
|
|
925
925
|
**Access**: public
|
|
926
|
-
**Author**:
|
|
926
|
+
**Author**: Myndware <augusto.pissarra@myndware.com>
|
|
927
927
|
|
|
928
928
|
| Param | Type | Description |
|
|
929
929
|
| --- | --- | --- |
|
|
@@ -951,7 +951,7 @@ Find all policies
|
|
|
951
951
|
|
|
952
952
|
**Kind**: instance method of [<code>AdminPolicy</code>](#AdminPolicy)
|
|
953
953
|
**Access**: public
|
|
954
|
-
**Author**:
|
|
954
|
+
**Author**: Myndware <augusto.pissarra@myndware.com>
|
|
955
955
|
|
|
956
956
|
| Param | Type | Description |
|
|
957
957
|
| --- | --- | --- |
|
|
@@ -983,7 +983,7 @@ Advanced search of processes, check documentation, to verify all params, pass to
|
|
|
983
983
|
**Kind**: instance method of [<code>AdminProcesses</code>](#AdminProcesses)
|
|
984
984
|
**Access**: public
|
|
985
985
|
**See**: https://confluence.external-share.com/content/7450b014-52c6-4d9e-b30e-a062b57453b5/17104899/17694721/532545537
|
|
986
|
-
**Author**:
|
|
986
|
+
**Author**: Myndware <augusto.pissarra@myndware.com>
|
|
987
987
|
**Example**
|
|
988
988
|
```js
|
|
989
989
|
const API = require('@docbrasil/api-systemmanager');
|
|
@@ -1004,7 +1004,7 @@ Advanced search of process in elastic search ussing system manager
|
|
|
1004
1004
|
|
|
1005
1005
|
**Kind**: instance method of [<code>AdminProcesses</code>](#AdminProcesses)
|
|
1006
1006
|
**Access**: public
|
|
1007
|
-
**Author**:
|
|
1007
|
+
**Author**: Myndware <augusto.pissarra@myndware.com>
|
|
1008
1008
|
|
|
1009
1009
|
| Param | Type | Description |
|
|
1010
1010
|
| --- | --- | --- |
|
|
@@ -1046,7 +1046,7 @@ Get task by user Id
|
|
|
1046
1046
|
|
|
1047
1047
|
**Kind**: instance method of [<code>AdminTask</code>](#AdminTask)
|
|
1048
1048
|
**Access**: public
|
|
1049
|
-
**Author**:
|
|
1049
|
+
**Author**: Myndware <augusto.pissarra@myndware.com>
|
|
1050
1050
|
|
|
1051
1051
|
| Param | Type | Default | Description |
|
|
1052
1052
|
| --- | --- | --- | --- |
|
|
@@ -1093,7 +1093,7 @@ Request profile by userId
|
|
|
1093
1093
|
|
|
1094
1094
|
**Kind**: instance method of [<code>AdminUser</code>](#AdminUser)
|
|
1095
1095
|
**Access**: public
|
|
1096
|
-
**Author**:
|
|
1096
|
+
**Author**: Myndware <augusto.pissarra@myndware.com>
|
|
1097
1097
|
|
|
1098
1098
|
| Param | Type | Description |
|
|
1099
1099
|
| --- | --- | --- |
|
|
@@ -1115,7 +1115,7 @@ Request profile by userId
|
|
|
1115
1115
|
|
|
1116
1116
|
**Kind**: instance method of [<code>AdminUser</code>](#AdminUser)
|
|
1117
1117
|
**Access**: public
|
|
1118
|
-
**Author**:
|
|
1118
|
+
**Author**: Myndware <augusto.pissarra@myndware.com>
|
|
1119
1119
|
|
|
1120
1120
|
| Param | Type | Description |
|
|
1121
1121
|
| --- | --- | --- |
|
|
@@ -1137,7 +1137,7 @@ Update password by userId
|
|
|
1137
1137
|
|
|
1138
1138
|
**Kind**: instance method of [<code>AdminUser</code>](#AdminUser)
|
|
1139
1139
|
**Access**: public
|
|
1140
|
-
**Author**:
|
|
1140
|
+
**Author**: Myndware <augusto.pissarra@myndware.com>
|
|
1141
1141
|
|
|
1142
1142
|
| Param | Type | Description |
|
|
1143
1143
|
| --- | --- | --- |
|
|
@@ -1166,7 +1166,7 @@ Check if email is unique
|
|
|
1166
1166
|
|
|
1167
1167
|
**Kind**: instance method of [<code>AdminUser</code>](#AdminUser)
|
|
1168
1168
|
**Access**: public
|
|
1169
|
-
**Author**:
|
|
1169
|
+
**Author**: Myndware <augusto.pissarra@myndware.com>
|
|
1170
1170
|
|
|
1171
1171
|
| Param | Type | Description |
|
|
1172
1172
|
| --- | --- | --- |
|
|
@@ -1258,7 +1258,7 @@ Get geo location of the address
|
|
|
1258
1258
|
|
|
1259
1259
|
**Kind**: instance method of [<code>GeoLocation</code>](#GeoLocation)
|
|
1260
1260
|
**Access**: public
|
|
1261
|
-
**Author**:
|
|
1261
|
+
**Author**: Myndware <augusto.pissarra@myndware.com>
|
|
1262
1262
|
|
|
1263
1263
|
| Param | Type | Description |
|
|
1264
1264
|
| --- | --- | --- |
|
|
@@ -1282,7 +1282,7 @@ await api.general.geo.location(params);
|
|
|
1282
1282
|
API request, user permission level
|
|
1283
1283
|
|
|
1284
1284
|
**Kind**: global class
|
|
1285
|
-
**Author**:
|
|
1285
|
+
**Author**: Myndware <augusto.pissarra@myndware.com>
|
|
1286
1286
|
|
|
1287
1287
|
* [Users](#Users)
|
|
1288
1288
|
* [new Users(options)](#new_Users_new)
|
|
@@ -1319,7 +1319,7 @@ Get the available applications for this user in this organizations
|
|
|
1319
1319
|
|
|
1320
1320
|
**Kind**: instance method of [<code>Application</code>](#Application)
|
|
1321
1321
|
**Access**: public
|
|
1322
|
-
**Author**:
|
|
1322
|
+
**Author**: Myndware <augusto.pissarra@myndware.com>
|
|
1323
1323
|
|
|
1324
1324
|
| Param | Type | Description |
|
|
1325
1325
|
| --- | --- | --- |
|
|
@@ -1351,7 +1351,7 @@ Method to get autocomplete data from a datasource
|
|
|
1351
1351
|
**Kind**: instance method of [<code>Datasource</code>](#Datasource)
|
|
1352
1352
|
**Returns**: <code>promise.<array></code> - docs The returned documents field with autocomplete<code>string</code> - docs._id the _id of the document<code>object</code> - data.docTypeFieldsData the field values
|
|
1353
1353
|
**Access**: public
|
|
1354
|
-
**Author**:
|
|
1354
|
+
**Author**: Myndware <augusto.pissarra@myndware.com>
|
|
1355
1355
|
|
|
1356
1356
|
| Param | Type | Description |
|
|
1357
1357
|
| --- | --- | --- |
|
|
@@ -1403,7 +1403,7 @@ Create new document
|
|
|
1403
1403
|
|
|
1404
1404
|
**Kind**: instance method of [<code>Documents</code>](#Documents)
|
|
1405
1405
|
**Access**: public
|
|
1406
|
-
**Author**:
|
|
1406
|
+
**Author**: Myndware <augusto.pissarra@myndware.com>
|
|
1407
1407
|
|
|
1408
1408
|
| Param | Type | Default | Description |
|
|
1409
1409
|
| --- | --- | --- | --- |
|
|
@@ -1461,7 +1461,7 @@ Updates a document
|
|
|
1461
1461
|
|
|
1462
1462
|
**Kind**: instance method of [<code>Documents</code>](#Documents)
|
|
1463
1463
|
**Access**: public
|
|
1464
|
-
**Author**:
|
|
1464
|
+
**Author**: Myndware <augusto.pissarra@myndware.com>
|
|
1465
1465
|
|
|
1466
1466
|
| Param | Type | Description |
|
|
1467
1467
|
| --- | --- | --- |
|
|
@@ -1485,7 +1485,7 @@ Updates a document.
|
|
|
1485
1485
|
|
|
1486
1486
|
**Kind**: instance method of [<code>Documents</code>](#Documents)
|
|
1487
1487
|
**Access**: public
|
|
1488
|
-
**Author**:
|
|
1488
|
+
**Author**: Myndware <augusto.pissarra@myndware.com>
|
|
1489
1489
|
|
|
1490
1490
|
| Param | Type | Description |
|
|
1491
1491
|
| --- | --- | --- |
|
|
@@ -1504,7 +1504,7 @@ await api.user.document.findById('5edf9f8ee896b817e45b8dad', session);
|
|
|
1504
1504
|
### documents.find(params, session) ⇒ <code>Promise</code>
|
|
1505
1505
|
**Kind**: instance method of [<code>Documents</code>](#Documents)
|
|
1506
1506
|
**Access**: public
|
|
1507
|
-
**Author**:
|
|
1507
|
+
**Author**: Myndware <augusto.pissarra@myndware.com>
|
|
1508
1508
|
|
|
1509
1509
|
| Param | Type | Default | Description |
|
|
1510
1510
|
| --- | --- | --- | --- |
|
|
@@ -1546,7 +1546,7 @@ Remove document by id
|
|
|
1546
1546
|
**Kind**: instance method of [<code>Documents</code>](#Documents)
|
|
1547
1547
|
**Returns**: <code>Promise.<object></code> - data The returned data<code>number</code> - data.removed The quantity of removed documents<code>array.<object></code> - data.errors Array of errors<code>string</code> - data.errors.id Id of the document that had an error<code>string</code> - data.errors.code Error code<code>string</code> - data.errors.message Error message
|
|
1548
1548
|
**Access**: public
|
|
1549
|
-
**Author**:
|
|
1549
|
+
**Author**: Myndware <augusto.pissarra@myndware.com>
|
|
1550
1550
|
|
|
1551
1551
|
| Param | Type | Description |
|
|
1552
1552
|
| --- | --- | --- |
|
|
@@ -1574,7 +1574,7 @@ Remove documents
|
|
|
1574
1574
|
**Kind**: instance method of [<code>Documents</code>](#Documents)
|
|
1575
1575
|
**Returns**: <code>Promise.<object></code> - data The returned data<code>number</code> - data.removed The quantity of removed documents<code>array.<object></code> - data.errors Array of errors<code>string</code> - data.errors.id Id of the document that had an error<code>string</code> - data.errors.code Error code<code>string</code> - data.errors.message Error message
|
|
1576
1576
|
**Access**: public
|
|
1577
|
-
**Author**:
|
|
1577
|
+
**Author**: Myndware <augusto.pissarra@myndware.com>
|
|
1578
1578
|
|
|
1579
1579
|
| Param | Type | Description |
|
|
1580
1580
|
| --- | --- | --- |
|
|
@@ -1603,7 +1603,7 @@ Request signed url url to put or get
|
|
|
1603
1603
|
**Kind**: instance method of [<code>Documents</code>](#Documents)
|
|
1604
1604
|
**Returns**: <code>Promise.<object></code> - doc Returned document data with the signed url<code>string</code> - doc.docId Document id<code>string</code> - doc.name The name of the document, which is the fileName<code>string</code> - doc.areaId docAreaId of the document<code>string</code> - doc.type the document mimi type<code>string</code> - doc.signedUrl the signed URL to upload
|
|
1605
1605
|
**Access**: public
|
|
1606
|
-
**Author**:
|
|
1606
|
+
**Author**: Myndware <augusto.pissarra@myndware.com>
|
|
1607
1607
|
|
|
1608
1608
|
| Param | Type | Description |
|
|
1609
1609
|
| --- | --- | --- |
|
|
@@ -1652,7 +1652,7 @@ Request signed url url to put or get
|
|
|
1652
1652
|
**Kind**: instance method of [<code>Documents</code>](#Documents)
|
|
1653
1653
|
**Returns**: <code>Promise.<object></code> - doc Returned document data with the signed url<code>string</code> - doc.docId Document id<code>string</code> - doc.name The name of the document, which is the fileName<code>string</code> - doc.areaId docAreaId of the document<code>string</code> - doc.type the document mimi type<code>string</code> - doc.signedUrl the signed URL to upload
|
|
1654
1654
|
**Access**: public
|
|
1655
|
-
**Author**:
|
|
1655
|
+
**Author**: Myndware <augusto.pissarra@myndware.com>
|
|
1656
1656
|
|
|
1657
1657
|
| Param | Type | Description |
|
|
1658
1658
|
| --- | --- | --- |
|
|
@@ -1741,7 +1741,7 @@ onUploadProgress return the progressEvent
|
|
|
1741
1741
|
**Kind**: instance method of [<code>Documents</code>](#Documents)
|
|
1742
1742
|
**Returns**: <code>Promise.<array></code> - Return the array of the documents that are repeated. If not document is repeaded, then if returns an empty array.<code>array.<string></code> - id the id of the repeated document
|
|
1743
1743
|
**Access**: public
|
|
1744
|
-
**Author**:
|
|
1744
|
+
**Author**: Myndware <augusto.pissarra@myndware.com>
|
|
1745
1745
|
Checks if a document can be added and it does not repeat its primary key
|
|
1746
1746
|
|
|
1747
1747
|
| Param | Type | Description |
|
|
@@ -1777,7 +1777,7 @@ Method to search documents for
|
|
|
1777
1777
|
**Kind**: instance method of [<code>Documents</code>](#Documents)
|
|
1778
1778
|
**Returns**: <code>promise</code> - returned data from the search<code>number</code> - count the count of items searched<code>array.<object></code> - items the items returned from search<code>number</code> - took the number of documents taken<code>number</code> - totalCount the total count of all documents
|
|
1779
1779
|
**Access**: public
|
|
1780
|
-
**Author**:
|
|
1780
|
+
**Author**: Myndware <augusto.pissarra@myndware.com>
|
|
1781
1781
|
|
|
1782
1782
|
| Param | Type | Description |
|
|
1783
1783
|
| --- | --- | --- |
|
|
@@ -1836,7 +1836,7 @@ Method to find helps from a topic
|
|
|
1836
1836
|
|
|
1837
1837
|
**Kind**: instance method of [<code>Help</code>](#Help)
|
|
1838
1838
|
**Access**: public
|
|
1839
|
-
**Author**:
|
|
1839
|
+
**Author**: Myndware <augusto.pissarra@myndware.com>
|
|
1840
1840
|
|
|
1841
1841
|
| Param | Type | Description |
|
|
1842
1842
|
| --- | --- | --- |
|
|
@@ -1860,7 +1860,7 @@ await api.user.help.get(params, session);
|
|
|
1860
1860
|
API request, user permission level
|
|
1861
1861
|
|
|
1862
1862
|
**Kind**: global class
|
|
1863
|
-
**Author**:
|
|
1863
|
+
**Author**: Myndware <augusto.pissarra@myndware.com>
|
|
1864
1864
|
|
|
1865
1865
|
* [Users](#Users)
|
|
1866
1866
|
* [new Users(options)](#new_Users_new)
|
|
@@ -1911,7 +1911,7 @@ Method to find my tasks for a user
|
|
|
1911
1911
|
**Kind**: instance method of [<code>MyTasks</code>](#MyTasks)
|
|
1912
1912
|
**Returns**: <code>promise</code> - returned data from the search<code>number</code> - count the count of items searched<code>array.<object></code> - items the items returned from search<code>number</code> - page the page of the search (on pagination), zero indexed<code>number</code> - perPage how many items per page
|
|
1913
1913
|
**Access**: public
|
|
1914
|
-
**Author**:
|
|
1914
|
+
**Author**: Myndware <augusto.pissarra@myndware.com>
|
|
1915
1915
|
|
|
1916
1916
|
| Param | Type | Description |
|
|
1917
1917
|
| --- | --- | --- |
|
|
@@ -1925,7 +1925,7 @@ Method to find my tasks for a user
|
|
|
1925
1925
|
const API = require('@docbrasil/api-systemmanager');
|
|
1926
1926
|
const api = new API();
|
|
1927
1927
|
const params = {
|
|
1928
|
-
query: {"s":[{"historyBegin":{"order":"desc"}}],"i":1,"p":20
|
|
1928
|
+
query: {"s":[{"historyBegin":{"order":"desc"}}],"i":1,"p":20},
|
|
1929
1929
|
orgId: '55e4a3bd6be6b45210833fae',
|
|
1930
1930
|
};
|
|
1931
1931
|
const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
|
|
@@ -1938,7 +1938,7 @@ Update task dueDate
|
|
|
1938
1938
|
|
|
1939
1939
|
**Kind**: instance method of [<code>MyTasks</code>](#MyTasks)
|
|
1940
1940
|
**Access**: public
|
|
1941
|
-
**Author**:
|
|
1941
|
+
**Author**: Myndware <augusto.pissarra@myndware.com>
|
|
1942
1942
|
|
|
1943
1943
|
| Param | Type | Description |
|
|
1944
1944
|
| --- | --- | --- |
|
|
@@ -1967,7 +1967,7 @@ Update task dueDate
|
|
|
1967
1967
|
|
|
1968
1968
|
**Kind**: instance method of [<code>MyTasks</code>](#MyTasks)
|
|
1969
1969
|
**Access**: public
|
|
1970
|
-
**Author**:
|
|
1970
|
+
**Author**: Myndware <augusto.pissarra@myndware.com>
|
|
1971
1971
|
|
|
1972
1972
|
| Param | Type | Description |
|
|
1973
1973
|
| --- | --- | --- |
|
|
@@ -1993,7 +1993,7 @@ Method to get task multi users
|
|
|
1993
1993
|
|
|
1994
1994
|
**Kind**: instance method of [<code>MyTasks</code>](#MyTasks)
|
|
1995
1995
|
**Access**: public
|
|
1996
|
-
**Author**:
|
|
1996
|
+
**Author**: Myndware <augusto.pissarra@myndware.com>
|
|
1997
1997
|
|
|
1998
1998
|
| Param | Type | Description |
|
|
1999
1999
|
| --- | --- | --- |
|
|
@@ -2020,7 +2020,7 @@ remove multi task user
|
|
|
2020
2020
|
|
|
2021
2021
|
**Kind**: instance method of [<code>MyTasks</code>](#MyTasks)
|
|
2022
2022
|
**Access**: public
|
|
2023
|
-
**Author**:
|
|
2023
|
+
**Author**: Myndware <augusto.pissarra@myndware.com>
|
|
2024
2024
|
|
|
2025
2025
|
| Param | Type | Description |
|
|
2026
2026
|
| --- | --- | --- |
|
|
@@ -2049,7 +2049,7 @@ Add Multi Task User
|
|
|
2049
2049
|
|
|
2050
2050
|
**Kind**: instance method of [<code>MyTasks</code>](#MyTasks)
|
|
2051
2051
|
**Access**: public
|
|
2052
|
-
**Author**:
|
|
2052
|
+
**Author**: Myndware <augusto.pissarra@myndware.com>
|
|
2053
2053
|
|
|
2054
2054
|
| Param | Type | Description |
|
|
2055
2055
|
| --- | --- | --- |
|
|
@@ -2078,7 +2078,7 @@ Method to get assign task users
|
|
|
2078
2078
|
|
|
2079
2079
|
**Kind**: instance method of [<code>MyTasks</code>](#MyTasks)
|
|
2080
2080
|
**Access**: public
|
|
2081
|
-
**Author**:
|
|
2081
|
+
**Author**: Myndware <augusto.pissarra@myndware.com>
|
|
2082
2082
|
|
|
2083
2083
|
| Param | Type | Description |
|
|
2084
2084
|
| --- | --- | --- |
|
|
@@ -2105,7 +2105,7 @@ Assign Task user
|
|
|
2105
2105
|
|
|
2106
2106
|
**Kind**: instance method of [<code>MyTasks</code>](#MyTasks)
|
|
2107
2107
|
**Access**: public
|
|
2108
|
-
**Author**:
|
|
2108
|
+
**Author**: Myndware <augusto.pissarra@myndware.com>
|
|
2109
2109
|
|
|
2110
2110
|
| Param | Type | Description |
|
|
2111
2111
|
| --- | --- | --- |
|
|
@@ -2134,7 +2134,7 @@ Unclaim task
|
|
|
2134
2134
|
|
|
2135
2135
|
**Kind**: instance method of [<code>MyTasks</code>](#MyTasks)
|
|
2136
2136
|
**Access**: public
|
|
2137
|
-
**Author**:
|
|
2137
|
+
**Author**: Myndware <augusto.pissarra@myndware.com>
|
|
2138
2138
|
|
|
2139
2139
|
| Param | Type | Description |
|
|
2140
2140
|
| --- | --- | --- |
|
|
@@ -2161,7 +2161,7 @@ Escalate task
|
|
|
2161
2161
|
|
|
2162
2162
|
**Kind**: instance method of [<code>MyTasks</code>](#MyTasks)
|
|
2163
2163
|
**Access**: public
|
|
2164
|
-
**Author**:
|
|
2164
|
+
**Author**: Myndware <augusto.pissarra@myndware.com>
|
|
2165
2165
|
|
|
2166
2166
|
| Param | Type | Description |
|
|
2167
2167
|
| --- | --- | --- |
|
|
@@ -2210,7 +2210,7 @@ Method to add a notification token
|
|
|
2210
2210
|
**Kind**: instance method of [<code>Notification</code>](#Notification)
|
|
2211
2211
|
**Returns**: <code>promise.<object></code> - data<code>boolean</code> - data._id the id of the added token
|
|
2212
2212
|
**Access**: public
|
|
2213
|
-
**Author**:
|
|
2213
|
+
**Author**: Myndware <augusto.pissarra@myndware.com>
|
|
2214
2214
|
|
|
2215
2215
|
| Param | Type | Description |
|
|
2216
2216
|
| --- | --- | --- |
|
|
@@ -2277,7 +2277,7 @@ Set notification as readed
|
|
|
2277
2277
|
|
|
2278
2278
|
**Kind**: instance method of [<code>Notification</code>](#Notification)
|
|
2279
2279
|
**Access**: public
|
|
2280
|
-
**Author**:
|
|
2280
|
+
**Author**: Myndware <augusto.pissarra@myndware.com>
|
|
2281
2281
|
|
|
2282
2282
|
| Param | Type | Description |
|
|
2283
2283
|
| --- | --- | --- |
|
|
@@ -2302,7 +2302,7 @@ Set notification as unreaded
|
|
|
2302
2302
|
|
|
2303
2303
|
**Kind**: instance method of [<code>Notification</code>](#Notification)
|
|
2304
2304
|
**Access**: public
|
|
2305
|
-
**Author**:
|
|
2305
|
+
**Author**: Myndware <augusto.pissarra@myndware.com>
|
|
2306
2306
|
|
|
2307
2307
|
| Param | Type | Description |
|
|
2308
2308
|
| --- | --- | --- |
|
|
@@ -2343,7 +2343,7 @@ Update avatar of organization by session of user not allow session user SU
|
|
|
2343
2343
|
|
|
2344
2344
|
**Kind**: instance method of [<code>Organization</code>](#Organization)
|
|
2345
2345
|
**Access**: public
|
|
2346
|
-
**Author**:
|
|
2346
|
+
**Author**: Myndware <augusto.pissarra@myndware.com>
|
|
2347
2347
|
|
|
2348
2348
|
| Param | Type | Description |
|
|
2349
2349
|
| --- | --- | --- |
|
|
@@ -2372,7 +2372,7 @@ Remove avatar of user by session of user not allow session user SU
|
|
|
2372
2372
|
|
|
2373
2373
|
**Kind**: instance method of [<code>Organization</code>](#Organization)
|
|
2374
2374
|
**Access**: public
|
|
2375
|
-
**Author**:
|
|
2375
|
+
**Author**: Myndware <augusto.pissarra@myndware.com>
|
|
2376
2376
|
|
|
2377
2377
|
| Param | Type | Description |
|
|
2378
2378
|
| --- | --- | --- |
|
|
@@ -2438,7 +2438,7 @@ Update avatar of organization by session of user not allow session user SU
|
|
|
2438
2438
|
|
|
2439
2439
|
**Kind**: instance method of [<code>Organization</code>](#Organization)
|
|
2440
2440
|
**Access**: public
|
|
2441
|
-
**Author**:
|
|
2441
|
+
**Author**: Myndware <augusto.pissarra@myndware.com>
|
|
2442
2442
|
|
|
2443
2443
|
| Param | Type | Description |
|
|
2444
2444
|
| --- | --- | --- |
|
|
@@ -2465,7 +2465,7 @@ Remove avatar of user by session of user not allow session user SU
|
|
|
2465
2465
|
|
|
2466
2466
|
**Kind**: instance method of [<code>Organization</code>](#Organization)
|
|
2467
2467
|
**Access**: public
|
|
2468
|
-
**Author**:
|
|
2468
|
+
**Author**: Myndware <augusto.pissarra@myndware.com>
|
|
2469
2469
|
|
|
2470
2470
|
| Param | Type | Description |
|
|
2471
2471
|
| --- | --- | --- |
|
|
@@ -2485,7 +2485,7 @@ Call URL internal, need auth JWT (session)
|
|
|
2485
2485
|
|
|
2486
2486
|
**Kind**: instance method of [<code>Organization</code>](#Organization)
|
|
2487
2487
|
**Access**: public
|
|
2488
|
-
**Author**:
|
|
2488
|
+
**Author**: Myndware <augusto.pissarra@myndware.com>
|
|
2489
2489
|
|
|
2490
2490
|
| Param | Type | Default | Description |
|
|
2491
2491
|
| --- | --- | --- | --- |
|
|
@@ -2518,7 +2518,7 @@ Get the available page for an application inside an organization
|
|
|
2518
2518
|
|
|
2519
2519
|
**Kind**: instance method of [<code>Page</code>](#Page)
|
|
2520
2520
|
**Access**: public
|
|
2521
|
-
**Author**:
|
|
2521
|
+
**Author**: Myndware <augusto.pissarra@myndware.com>
|
|
2522
2522
|
|
|
2523
2523
|
| Param | Type | Description |
|
|
2524
2524
|
| --- | --- | --- |
|
|
@@ -2565,7 +2565,7 @@ Start process
|
|
|
2565
2565
|
|
|
2566
2566
|
**Kind**: instance method of [<code>Process</code>](#Process)
|
|
2567
2567
|
**Access**: public
|
|
2568
|
-
**Author**:
|
|
2568
|
+
**Author**: Myndware <augusto.pissarra@myndware.com>
|
|
2569
2569
|
|
|
2570
2570
|
| Param | Type | Default | Description |
|
|
2571
2571
|
| --- | --- | --- | --- |
|
|
@@ -2594,7 +2594,7 @@ Get process properties of process
|
|
|
2594
2594
|
|
|
2595
2595
|
**Kind**: instance method of [<code>Process</code>](#Process)
|
|
2596
2596
|
**Access**: public
|
|
2597
|
-
**Author**:
|
|
2597
|
+
**Author**: Myndware <augusto.pissarra@myndware.com>
|
|
2598
2598
|
|
|
2599
2599
|
| Param | Type | Description |
|
|
2600
2600
|
| --- | --- | --- |
|
|
@@ -2623,7 +2623,7 @@ Get the search info of a organization process
|
|
|
2623
2623
|
**Returns**: <code>Promise</code> - the search info result<code>string</code> - name the name of the organization process<code>object</code> - processIndexFields the list of fields to index<code>object</code> - processParticipantsGroup the permissions in this organization process<code>object</code> - stepsProperties the organization process steps properties<code>string</code> - _id the same organization id
|
|
2624
2624
|
@
|
|
2625
2625
|
**Access**: public
|
|
2626
|
-
**Author**:
|
|
2626
|
+
**Author**: Myndware <augusto.pissarra@myndware.com>
|
|
2627
2627
|
|
|
2628
2628
|
| Param | Type | Description |
|
|
2629
2629
|
| --- | --- | --- |
|
|
@@ -2651,7 +2651,7 @@ Method to search processes
|
|
|
2651
2651
|
**Kind**: instance method of [<code>Process</code>](#Process)
|
|
2652
2652
|
**Returns**: <code>promise</code> - returned data from the search<code>number</code> - count the count of items searched<code>array.<object></code> - items the items returned from search<code>number</code> - page the page of the search (on pagination), zero indexed<code>number</code> - perPage how many items per page
|
|
2653
2653
|
**Access**: public
|
|
2654
|
-
**Author**:
|
|
2654
|
+
**Author**: Myndware <augusto.pissarra@myndware.com>
|
|
2655
2655
|
|
|
2656
2656
|
| Param | Type | Description |
|
|
2657
2657
|
| --- | --- | --- |
|
|
@@ -2678,7 +2678,7 @@ Method to remove process
|
|
|
2678
2678
|
|
|
2679
2679
|
**Kind**: instance method of [<code>Process</code>](#Process)
|
|
2680
2680
|
**Access**: public
|
|
2681
|
-
**Author**:
|
|
2681
|
+
**Author**: Myndware <augusto.pissarra@myndware.com>
|
|
2682
2682
|
|
|
2683
2683
|
| Param | Type | Description |
|
|
2684
2684
|
| --- | --- | --- |
|
|
@@ -2705,7 +2705,7 @@ Method to export status data
|
|
|
2705
2705
|
|
|
2706
2706
|
**Kind**: instance method of [<code>Process</code>](#Process)
|
|
2707
2707
|
**Access**: public
|
|
2708
|
-
**Author**:
|
|
2708
|
+
**Author**: Myndware <augusto.pissarra@myndware.com>
|
|
2709
2709
|
|
|
2710
2710
|
| Param | Type | Description |
|
|
2711
2711
|
| --- | --- | --- |
|
|
@@ -2732,7 +2732,7 @@ Method to export process data
|
|
|
2732
2732
|
|
|
2733
2733
|
**Kind**: instance method of [<code>Process</code>](#Process)
|
|
2734
2734
|
**Access**: public
|
|
2735
|
-
**Author**:
|
|
2735
|
+
**Author**: Myndware <augusto.pissarra@myndware.com>
|
|
2736
2736
|
|
|
2737
2737
|
| Param | Type | Description |
|
|
2738
2738
|
| --- | --- | --- |
|
|
@@ -2760,7 +2760,7 @@ Method to get Process Docs
|
|
|
2760
2760
|
**Kind**: instance method of [<code>Process</code>](#Process)
|
|
2761
2761
|
**Returns**: <code>promise</code> - returned data from the get process docs<code>array.<object></code> - Docs returned from process
|
|
2762
2762
|
**Access**: public
|
|
2763
|
-
**Author**:
|
|
2763
|
+
**Author**: Myndware <augusto.pissarra@myndware.com>
|
|
2764
2764
|
|
|
2765
2765
|
| Param | Type | Description |
|
|
2766
2766
|
| --- | --- | --- |
|
|
@@ -2790,7 +2790,7 @@ Method to download the process documents
|
|
|
2790
2790
|
**Kind**: instance method of [<code>Process</code>](#Process)
|
|
2791
2791
|
**Returns**: <code>promise</code> - returned data from the search
|
|
2792
2792
|
**Access**: public
|
|
2793
|
-
**Author**:
|
|
2793
|
+
**Author**: Myndware <augusto.pissarra@myndware.com>
|
|
2794
2794
|
|
|
2795
2795
|
| Param | Type | Description |
|
|
2796
2796
|
| --- | --- | --- |
|
|
@@ -2832,7 +2832,7 @@ Class for user registration in a user
|
|
|
2832
2832
|
**Kind**: instance method of [<code>Register</code>](#Register)
|
|
2833
2833
|
**Returns**: <code>string</code> - orgname The orgname of the organization in the registerId
|
|
2834
2834
|
**Access**: public
|
|
2835
|
-
**Author**:
|
|
2835
|
+
**Author**: Myndware <augusto.pissarra@myndware.com>
|
|
2836
2836
|
|
|
2837
2837
|
| Param | Type | Description |
|
|
2838
2838
|
| --- | --- | --- |
|
|
@@ -2855,7 +2855,7 @@ Method to find task by id
|
|
|
2855
2855
|
**Kind**: instance method of [<code>Register</code>](#Register)
|
|
2856
2856
|
**Returns**: <code>promise.<object></code> - data<code>boolean</code> - data.success If the operation was successfully done (true|false)<code>boolean</code> - data.userAlreadyExists If the user already exists (true|false), if true, then the other information is not returned<code>string</code> - data.registrationEmailInfoRaw The fully cryptographed registration information<code>object</code> - data.registrationEmailInfo The registration information<code>string</code> - data.registrationEmailInfo.orgname The orgname<code>string</code> - data.registrationEmailInfo.orgId The orgId of the organization<code>string</code> - data.registrationEmailInfo.guid The unique id for the registration<code>object</code> - data.registrationEmailInfo.emailValidation The email validation information<code>string</code> - data.registrationEmailInfo.emailValidation.email The email that the code was sent to<code>string</code> - data.registrationEmailInfo.emailValidation.code The 4 digit code to validate the email
|
|
2857
2857
|
**Access**: public
|
|
2858
|
-
**Author**:
|
|
2858
|
+
**Author**: Myndware <augusto.pissarra@myndware.com>
|
|
2859
2859
|
|
|
2860
2860
|
| Param | Type | Description |
|
|
2861
2861
|
| --- | --- | --- |
|
|
@@ -2881,7 +2881,7 @@ Method to register a user
|
|
|
2881
2881
|
**Kind**: instance method of [<code>Register</code>](#Register)
|
|
2882
2882
|
**Returns**: <code>promise.<object></code> - data<code>boolean</code> - data.success If the operation was successfully done (true|false)<code>boolean</code> - data.userAlreadyExists If the user already exists (true|false), if true, then the other information is not returned<code>object</code> - auth The full authentication data with session, if login is true.<code>string</code> - auth.redirectUrl The url to redirect.
|
|
2883
2883
|
**Access**: public
|
|
2884
|
-
**Author**:
|
|
2884
|
+
**Author**: Myndware <augusto.pissarra@myndware.com>
|
|
2885
2885
|
|
|
2886
2886
|
| Param | Type | Default | Description |
|
|
2887
2887
|
| --- | --- | --- | --- |
|
|
@@ -2949,7 +2949,7 @@ Adds/updates a user settings
|
|
|
2949
2949
|
|
|
2950
2950
|
**Kind**: instance method of [<code>Settings</code>](#Settings)
|
|
2951
2951
|
**Access**: public
|
|
2952
|
-
**Author**:
|
|
2952
|
+
**Author**: Myndware <augusto.pissarra@myndware.com>
|
|
2953
2953
|
|
|
2954
2954
|
| Param | Type | Description |
|
|
2955
2955
|
| --- | --- | --- |
|
|
@@ -2973,7 +2973,7 @@ Gets the user settings. Returns an array of settings.
|
|
|
2973
2973
|
|
|
2974
2974
|
**Kind**: instance method of [<code>Settings</code>](#Settings)
|
|
2975
2975
|
**Access**: public
|
|
2976
|
-
**Author**:
|
|
2976
|
+
**Author**: Myndware <augusto.pissarra@myndware.com>
|
|
2977
2977
|
|
|
2978
2978
|
| Param | Type | Description |
|
|
2979
2979
|
| --- | --- | --- |
|
|
@@ -2993,7 +2993,7 @@ Removes the user settings
|
|
|
2993
2993
|
|
|
2994
2994
|
**Kind**: instance method of [<code>Settings</code>](#Settings)
|
|
2995
2995
|
**Access**: public
|
|
2996
|
-
**Author**:
|
|
2996
|
+
**Author**: Myndware <augusto.pissarra@myndware.com>
|
|
2997
2997
|
|
|
2998
2998
|
| Param | Type | Description |
|
|
2999
2999
|
| --- | --- | --- |
|
|
@@ -3017,6 +3017,7 @@ Class for task, permission user
|
|
|
3017
3017
|
* [.findById(params, session)](#Task+findById) ⇒ <code>promise</code>
|
|
3018
3018
|
* [.findByIdAndUpdate(params, session)](#Task+findByIdAndUpdate) ⇒ <code>Promise</code>
|
|
3019
3019
|
* [.executeActionFinalize(params, session)](#Task+executeActionFinalize) ⇒ <code>Promise</code>
|
|
3020
|
+
* [.getSummaryByTags(params, session)](#Task+getSummaryByTags) ⇒ <code>Promise.<object></code> \| <code>Promise.<object></code> \| <code>Promise.<object></code>
|
|
3020
3021
|
|
|
3021
3022
|
<a name="Task+findById"></a>
|
|
3022
3023
|
|
|
@@ -3025,7 +3026,7 @@ Method to find task by id
|
|
|
3025
3026
|
|
|
3026
3027
|
**Kind**: instance method of [<code>Task</code>](#Task)
|
|
3027
3028
|
**Access**: public
|
|
3028
|
-
**Author**:
|
|
3029
|
+
**Author**: Myndware <augusto.pissarra@myndware.com>
|
|
3029
3030
|
|
|
3030
3031
|
| Param | Type | Description |
|
|
3031
3032
|
| --- | --- | --- |
|
|
@@ -3054,7 +3055,7 @@ Find task by id and update
|
|
|
3054
3055
|
|
|
3055
3056
|
**Kind**: instance method of [<code>Task</code>](#Task)
|
|
3056
3057
|
**Access**: public
|
|
3057
|
-
**Author**:
|
|
3058
|
+
**Author**: Myndware <augusto.pissarra@myndware.com>
|
|
3058
3059
|
|
|
3059
3060
|
| Param | Type | Description |
|
|
3060
3061
|
| --- | --- | --- |
|
|
@@ -3090,7 +3091,7 @@ Find task by id and update
|
|
|
3090
3091
|
|
|
3091
3092
|
**Kind**: instance method of [<code>Task</code>](#Task)
|
|
3092
3093
|
**Access**: public
|
|
3093
|
-
**Author**:
|
|
3094
|
+
**Author**: Myndware <augusto.pissarra@myndware.com>
|
|
3094
3095
|
|
|
3095
3096
|
| Param | Type | Default | Description |
|
|
3096
3097
|
| --- | --- | --- | --- |
|
|
@@ -3114,6 +3115,32 @@ const params = {
|
|
|
3114
3115
|
const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
|
|
3115
3116
|
await api.user.task.executeActionFinalize(params, session);
|
|
3116
3117
|
```
|
|
3118
|
+
<a name="Task+getSummaryByTags"></a>
|
|
3119
|
+
|
|
3120
|
+
### task.getSummaryByTags(params, session) ⇒ <code>Promise.<object></code> \| <code>Promise.<object></code> \| <code>Promise.<object></code>
|
|
3121
|
+
Get the tasks and available tasks summary (totals) for specific tags
|
|
3122
|
+
|
|
3123
|
+
**Kind**: instance method of [<code>Task</code>](#Task)
|
|
3124
|
+
**Returns**: <code>Promise.<object></code> - data<code>Promise.<object></code> - data.tasks - the total tasks<code>Promise.<object></code> - data.availableTasks - the total available tasks
|
|
3125
|
+
**Access**: public
|
|
3126
|
+
**Author**: Myndware <augusto.pissarra@myndware.com>
|
|
3127
|
+
|
|
3128
|
+
| Param | Type | Description |
|
|
3129
|
+
| --- | --- | --- |
|
|
3130
|
+
| params | <code>object</code> | Params - to update task |
|
|
3131
|
+
| params.tags | <code>array.<string></code> | The tags to get task summaries |
|
|
3132
|
+
| session | <code>string</code> | Session, token JWT |
|
|
3133
|
+
|
|
3134
|
+
**Example**
|
|
3135
|
+
```js
|
|
3136
|
+
const API = require('@docbrasil/api-systemmanager');
|
|
3137
|
+
const api = new API();
|
|
3138
|
+
const params = {
|
|
3139
|
+
tags: ['INCIDENTS']
|
|
3140
|
+
};
|
|
3141
|
+
const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
|
|
3142
|
+
await api.user.task.getSummaryByTags(params, session);
|
|
3143
|
+
```
|
|
3117
3144
|
<a name="TaskAvailable"></a>
|
|
3118
3145
|
|
|
3119
3146
|
## TaskAvailable
|
|
@@ -3133,7 +3160,7 @@ Method to find available tasks for a user
|
|
|
3133
3160
|
**Kind**: instance method of [<code>TaskAvailable</code>](#TaskAvailable)
|
|
3134
3161
|
**Returns**: <code>promise</code> - returned data from the search<code>number</code> - count the count of items searched<code>array.<object></code> - items the items returned from search<code>number</code> - page the page of the search (on pagination), zero indexed<code>number</code> - perPage how many items per page
|
|
3135
3162
|
**Access**: public
|
|
3136
|
-
**Author**:
|
|
3163
|
+
**Author**: Myndware <augusto.pissarra@myndware.com>
|
|
3137
3164
|
|
|
3138
3165
|
| Param | Type | Description |
|
|
3139
3166
|
| --- | --- | --- |
|
|
@@ -3161,7 +3188,7 @@ Method for a user to claim an available task
|
|
|
3161
3188
|
**Kind**: instance method of [<code>TaskAvailable</code>](#TaskAvailable)
|
|
3162
3189
|
**Returns**: <code>promise</code> - returned data from the method call<code>boolean</code> - success true|false if the method was successful
|
|
3163
3190
|
**Access**: public
|
|
3164
|
-
**Author**:
|
|
3191
|
+
**Author**: Myndware <augusto.pissarra@myndware.com>
|
|
3165
3192
|
|
|
3166
3193
|
| Param | Type | Description |
|
|
3167
3194
|
| --- | --- | --- |
|
|
@@ -3229,7 +3256,7 @@ Update avatar of user by session of user not allow session user SU
|
|
|
3229
3256
|
|
|
3230
3257
|
**Kind**: instance method of [<code>User</code>](#User)
|
|
3231
3258
|
**Access**: public
|
|
3232
|
-
**Author**:
|
|
3259
|
+
**Author**: Myndware <augusto.pissarra@myndware.com>
|
|
3233
3260
|
|
|
3234
3261
|
| Param | Type | Description |
|
|
3235
3262
|
| --- | --- | --- |
|
|
@@ -3256,7 +3283,7 @@ Remove avatar of user by session of user not allow session user SU
|
|
|
3256
3283
|
|
|
3257
3284
|
**Kind**: instance method of [<code>User</code>](#User)
|
|
3258
3285
|
**Access**: public
|
|
3259
|
-
**Author**:
|
|
3286
|
+
**Author**: Myndware <augusto.pissarra@myndware.com>
|
|
3260
3287
|
|
|
3261
3288
|
| Param | Type | Description |
|
|
3262
3289
|
| --- | --- | --- |
|
|
@@ -3276,7 +3303,7 @@ Remove the signature of user by session
|
|
|
3276
3303
|
|
|
3277
3304
|
**Kind**: instance method of [<code>User</code>](#User)
|
|
3278
3305
|
**Access**: public
|
|
3279
|
-
**Author**:
|
|
3306
|
+
**Author**: Myndware <augusto.pissarra@myndware.com>
|
|
3280
3307
|
|
|
3281
3308
|
| Param | Type | Description |
|
|
3282
3309
|
| --- | --- | --- |
|
|
@@ -3296,7 +3323,7 @@ Sava a new signature of user by session
|
|
|
3296
3323
|
|
|
3297
3324
|
**Kind**: instance method of [<code>User</code>](#User)
|
|
3298
3325
|
**Access**: public
|
|
3299
|
-
**Author**:
|
|
3326
|
+
**Author**: Myndware <augusto.pissarra@myndware.com>
|
|
3300
3327
|
|
|
3301
3328
|
| Param | Type | Description |
|
|
3302
3329
|
| --- | --- | --- |
|
|
@@ -3332,7 +3359,7 @@ Update a user profile by id
|
|
|
3332
3359
|
|
|
3333
3360
|
**Kind**: instance method of [<code>User</code>](#User)
|
|
3334
3361
|
**Access**: public
|
|
3335
|
-
**Author**:
|
|
3362
|
+
**Author**: Myndware <augusto.pissarra@myndware.com>
|
|
3336
3363
|
|
|
3337
3364
|
| Param | Type | Description |
|
|
3338
3365
|
| --- | --- | --- |
|
|
@@ -3372,7 +3399,7 @@ Change a user's organization
|
|
|
3372
3399
|
|
|
3373
3400
|
**Kind**: instance method of [<code>User</code>](#User)
|
|
3374
3401
|
**Access**: public
|
|
3375
|
-
**Author**:
|
|
3402
|
+
**Author**: Myndware <augusto.pissarra@myndware.com>
|
|
3376
3403
|
|
|
3377
3404
|
| Param | Type | Description |
|
|
3378
3405
|
| --- | --- | --- |
|
|
@@ -3426,7 +3453,7 @@ Get client Axios
|
|
|
3426
3453
|
**Kind**: instance method of [<code>Dispatch</code>](#Dispatch)
|
|
3427
3454
|
**Returns**: <code>promise</code> - return client axios
|
|
3428
3455
|
**Access**: public
|
|
3429
|
-
**Author**:
|
|
3456
|
+
**Author**: Myndware <augusto.pissarra@myndware.com>
|
|
3430
3457
|
**Example**
|
|
3431
3458
|
```js
|
|
3432
3459
|
const API = require('@docbrasil/api-systemmanager');
|
|
@@ -3455,7 +3482,7 @@ Create new document
|
|
|
3455
3482
|
**Returns**: <code>Promise.<object></code> - data<code>string</code> - _id the id of the form<code>string</code> - orgId the organization id of the form<code>string</code> - authorization the unique token registered internally by the system for all the next calls to the external form APIs
|
|
3456
3483
|
The authorization is unique and is ONLY valid for this session.<code>array.<object></code> - groups the form groups to render
|
|
3457
3484
|
**Access**: public
|
|
3458
|
-
**Author**:
|
|
3485
|
+
**Author**: Myndware <augusto.pissarra@myndware.com>
|
|
3459
3486
|
|
|
3460
3487
|
| Param | Type | Description |
|
|
3461
3488
|
| --- | --- | --- |
|
|
@@ -3479,7 +3506,7 @@ Get an upload signed url, so it will be possible to upload documents temporarily
|
|
|
3479
3506
|
**Kind**: instance method of [<code>External</code>](#External)
|
|
3480
3507
|
**Returns**: <code>Promise.<object></code> - doc<code>string</code> - doc.mime the original mime type of the document<code>string</code> - doc.signedUrl the signed url to upload the document<code>string</code> - doc.filename the filename of the uploaded file<code>string</code> - doc.extension the extension of the filename, obtained from the mime type
|
|
3481
3508
|
**Access**: public
|
|
3482
|
-
**Author**:
|
|
3509
|
+
**Author**: Myndware <augusto.pissarra@myndware.com>
|
|
3483
3510
|
|
|
3484
3511
|
| Param | Type | Description |
|
|
3485
3512
|
| --- | --- | --- |
|
|
@@ -3504,7 +3531,7 @@ Get an upload signed url, for many documents. So it will be possible to upload d
|
|
|
3504
3531
|
**Kind**: instance method of [<code>External</code>](#External)
|
|
3505
3532
|
**Returns**: <code>Promise.<array></code> - docs<code>string</code> - docs.mime the original mime type of the document<code>string</code> - docs.signedUrl the signed url to upload the document<code>string</code> - docs.filename the filename of the uploaded file<code>string</code> - docs.extension the extension of the filename, obtained from the mime type
|
|
3506
3533
|
**Access**: public
|
|
3507
|
-
**Author**:
|
|
3534
|
+
**Author**: Myndware <augusto.pissarra@myndware.com>
|
|
3508
3535
|
|
|
3509
3536
|
| Param | Type | Description |
|
|
3510
3537
|
| --- | --- | --- |
|
|
@@ -3532,7 +3559,7 @@ Handles the execution of an external form
|
|
|
3532
3559
|
**Kind**: instance method of [<code>External</code>](#External)
|
|
3533
3560
|
**Returns**: <code>Promise.<boolean></code> - true|false if success
|
|
3534
3561
|
**Access**: public
|
|
3535
|
-
**Author**:
|
|
3562
|
+
**Author**: Myndware <augusto.pissarra@myndware.com>
|
|
3536
3563
|
|
|
3537
3564
|
| Param | Type | Description |
|
|
3538
3565
|
| --- | --- | --- |
|
|
@@ -3583,7 +3610,7 @@ Login with social login Facebook
|
|
|
3583
3610
|
**Kind**: instance method of [<code>Login</code>](#Login)
|
|
3584
3611
|
**Returns**: <code>promise.<object></code> - data<code>object</code> - data.auth true or false if we have the user authenticaited correctly<code>object</code> - data.user the logged user
|
|
3585
3612
|
**Access**: public
|
|
3586
|
-
**Author**:
|
|
3613
|
+
**Author**: Myndware <augusto.pissarra@myndware.com>
|
|
3587
3614
|
|
|
3588
3615
|
| Param | Type | Description |
|
|
3589
3616
|
| --- | --- | --- |
|
|
@@ -3610,7 +3637,7 @@ Login with social login Google
|
|
|
3610
3637
|
**Kind**: instance method of [<code>Login</code>](#Login)
|
|
3611
3638
|
**Returns**: <code>promise.<object></code> - data<code>object</code> - data.auth true or false if we have the user authenticaited correctly<code>object</code> - data.user the logged user
|
|
3612
3639
|
**Access**: public
|
|
3613
|
-
**Author**:
|
|
3640
|
+
**Author**: Myndware <augusto.pissarra@myndware.com>
|
|
3614
3641
|
|
|
3615
3642
|
| Param | Type | Description |
|
|
3616
3643
|
| --- | --- | --- |
|
|
@@ -3637,7 +3664,7 @@ Login with apikey
|
|
|
3637
3664
|
**Kind**: instance method of [<code>Login</code>](#Login)
|
|
3638
3665
|
**Returns**: <code>promise.<object></code> - data<code>object</code> - data.auth true or false if we have the user authenticaited correctly<code>object</code> - data.user the logged user
|
|
3639
3666
|
**Access**: public
|
|
3640
|
-
**Author**:
|
|
3667
|
+
**Author**: Myndware <augusto.pissarra@myndware.com>
|
|
3641
3668
|
|
|
3642
3669
|
| Param | Type | Description |
|
|
3643
3670
|
| --- | --- | --- |
|
|
@@ -3661,7 +3688,7 @@ Login with user and password
|
|
|
3661
3688
|
**Kind**: instance method of [<code>Login</code>](#Login)
|
|
3662
3689
|
**Returns**: <code>promise.<object></code> - data<code>object</code> - data.auth true or false if we have the user authenticaited correctly<code>object</code> - data.user the logged user
|
|
3663
3690
|
**Access**: public
|
|
3664
|
-
**Author**:
|
|
3691
|
+
**Author**: Myndware <augusto.pissarra@myndware.com>
|
|
3665
3692
|
|
|
3666
3693
|
| Param | Type | Description |
|
|
3667
3694
|
| --- | --- | --- |
|
|
@@ -3691,7 +3718,7 @@ Logout user system manager
|
|
|
3691
3718
|
**Kind**: instance method of [<code>Login</code>](#Login)
|
|
3692
3719
|
**Returns**: <code>promise.<object></code> - } data<code>boolean</code> - data.success true|false
|
|
3693
3720
|
**Access**: public
|
|
3694
|
-
**Author**:
|
|
3721
|
+
**Author**: Myndware <augusto.pissarra@myndware.com>
|
|
3695
3722
|
|
|
3696
3723
|
| Param | Type | Description |
|
|
3697
3724
|
| --- | --- | --- |
|
|
@@ -3715,7 +3742,7 @@ Recover the password
|
|
|
3715
3742
|
**Kind**: instance method of [<code>Login</code>](#Login)
|
|
3716
3743
|
**Returns**: <code>promise.<object></code> - } data<code>boolean</code> - data.success true|false
|
|
3717
3744
|
**Access**: public
|
|
3718
|
-
**Author**:
|
|
3745
|
+
**Author**: Myndware <augusto.pissarra@myndware.com>
|
|
3719
3746
|
|
|
3720
3747
|
| Param | Type | Description |
|
|
3721
3748
|
| --- | --- | --- |
|