@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/docs/admin_list.js.html
CHANGED
|
@@ -120,7 +120,7 @@ class AdminLists {
|
|
|
120
120
|
}
|
|
121
121
|
|
|
122
122
|
/**
|
|
123
|
-
* @author
|
|
123
|
+
* @author Myndware <augusto.pissarra@myndware.com>
|
|
124
124
|
* @description Set header with new session
|
|
125
125
|
* @param {string} session Session, token JWT
|
|
126
126
|
* @return {object} header with new session
|
|
@@ -135,7 +135,7 @@ class AdminLists {
|
|
|
135
135
|
}
|
|
136
136
|
|
|
137
137
|
/**
|
|
138
|
-
* @author
|
|
138
|
+
* @author Myndware <augusto.pissarra@myndware.com>
|
|
139
139
|
* @description Get list by ID
|
|
140
140
|
* @param {object} params Params to find list by id
|
|
141
141
|
* @param {string} params.id List Id (_id database)
|
|
@@ -173,7 +173,7 @@ class AdminLists {
|
|
|
173
173
|
}
|
|
174
174
|
|
|
175
175
|
/**
|
|
176
|
-
* @author
|
|
176
|
+
* @author Myndware <augusto.pissarra@myndware.com>
|
|
177
177
|
* @description Get all lists
|
|
178
178
|
* @param {object} params={} Params to pagination and orgId
|
|
179
179
|
* @param {number} [params.page=0] Current page to pagination
|
|
@@ -105,7 +105,7 @@ class AdminMessage {
|
|
|
105
105
|
}
|
|
106
106
|
|
|
107
107
|
/**
|
|
108
|
-
* @author
|
|
108
|
+
* @author Myndware <augusto.pissarra@myndware.com>
|
|
109
109
|
* @description Get the return data and check for errors
|
|
110
110
|
* @param {object} retData Response HTTP
|
|
111
111
|
* @return {*}
|
|
@@ -120,7 +120,7 @@ class AdminMessage {
|
|
|
120
120
|
}
|
|
121
121
|
|
|
122
122
|
/**
|
|
123
|
-
* @author
|
|
123
|
+
* @author Myndware <augusto.pissarra@myndware.com>
|
|
124
124
|
* @description Set header with new session
|
|
125
125
|
* @param {string} session Session, token JWT
|
|
126
126
|
* @return {object} header with new session
|
|
@@ -120,7 +120,7 @@ class AdminNotification {
|
|
|
120
120
|
}
|
|
121
121
|
|
|
122
122
|
/**
|
|
123
|
-
* @author
|
|
123
|
+
* @author Myndware <augusto.pissarra@myndware.com>
|
|
124
124
|
* @description Set header with new session
|
|
125
125
|
* @param {string} session Session, token JWT
|
|
126
126
|
* @return {object} header with new session
|
|
@@ -159,7 +159,7 @@ class AdminNotification {
|
|
|
159
159
|
}
|
|
160
160
|
|
|
161
161
|
/**
|
|
162
|
-
* @author
|
|
162
|
+
* @author Myndware <augusto.pissarra@myndware.com>
|
|
163
163
|
* @description Create notification
|
|
164
164
|
* @param {object} params Params to create notification
|
|
165
165
|
* @param {string} params.orgId OrgId of the user SU
|
|
@@ -200,7 +200,7 @@ class AdminNotification {
|
|
|
200
200
|
}
|
|
201
201
|
|
|
202
202
|
/**
|
|
203
|
-
* @author
|
|
203
|
+
* @author Myndware <augusto.pissarra@myndware.com>
|
|
204
204
|
* @description Search notification using (notificationId or userId)
|
|
205
205
|
* @param {object} params Params to create notification
|
|
206
206
|
* @param {string} params.orgId OrgId of the user SU
|
|
@@ -238,7 +238,7 @@ class AdminNotification {
|
|
|
238
238
|
}
|
|
239
239
|
|
|
240
240
|
/**
|
|
241
|
-
* @author
|
|
241
|
+
* @author Myndware <augusto.pissarra@myndware.com>
|
|
242
242
|
* @description Update notification using (notificationId or userId)
|
|
243
243
|
* @param {object} params Params to create notification
|
|
244
244
|
* @param {string} params.orgId OrgId of the user SU
|
|
@@ -279,7 +279,7 @@ class AdminNotification {
|
|
|
279
279
|
}
|
|
280
280
|
|
|
281
281
|
/**
|
|
282
|
-
* @author
|
|
282
|
+
* @author Myndware <augusto.pissarra@myndware.com>
|
|
283
283
|
* @description Delete notification using (notificationId or userId)
|
|
284
284
|
* @param {object} params Params to create notification
|
|
285
285
|
* @param {string} params.orgId OrgId of the user SU
|
|
@@ -120,7 +120,7 @@ class Organization {
|
|
|
120
120
|
}
|
|
121
121
|
|
|
122
122
|
/**
|
|
123
|
-
* @author
|
|
123
|
+
* @author Myndware <augusto.pissarra@myndware.com>
|
|
124
124
|
* @description Set header with new session
|
|
125
125
|
* @param {string} session Session, token JWT
|
|
126
126
|
* @return {object} header with new session
|
|
@@ -135,7 +135,7 @@ class Organization {
|
|
|
135
135
|
}
|
|
136
136
|
|
|
137
137
|
/**
|
|
138
|
-
* @author
|
|
138
|
+
* @author Myndware <augusto.pissarra@myndware.com>
|
|
139
139
|
* @description Update avatar of organization by session of user not allow session user SU
|
|
140
140
|
* @param {object} params Params to update avatar
|
|
141
141
|
* @param {string} params.orgId - Organization id
|
|
@@ -178,7 +178,7 @@ class Organization {
|
|
|
178
178
|
}
|
|
179
179
|
|
|
180
180
|
/**
|
|
181
|
-
* @author
|
|
181
|
+
* @author Myndware <augusto.pissarra@myndware.com>
|
|
182
182
|
* @description Remove avatar of user by session of user not allow session user SU
|
|
183
183
|
* @param {string} params.orgId - Organization id
|
|
184
184
|
* @param {string} session - Is token JWT of user SU
|
|
@@ -120,7 +120,7 @@ class AdminPlugin {
|
|
|
120
120
|
}
|
|
121
121
|
|
|
122
122
|
/**
|
|
123
|
-
* @author
|
|
123
|
+
* @author Myndware <augusto.pissarra@myndware.com>
|
|
124
124
|
* @description Set header with new session
|
|
125
125
|
* @param {string} session Session, token JWT
|
|
126
126
|
* @return {object} header with new session
|
|
@@ -170,7 +170,7 @@ class AdminPlugin {
|
|
|
170
170
|
}
|
|
171
171
|
|
|
172
172
|
/**
|
|
173
|
-
* @author
|
|
173
|
+
* @author Myndware <augusto.pissarra@myndware.com>
|
|
174
174
|
* @description Get plugin by ID
|
|
175
175
|
* @param {string} id Plugin Id (_id database)
|
|
176
176
|
* @param {string} session Session, token JWT
|
|
@@ -105,7 +105,7 @@ class AdminPolicy {
|
|
|
105
105
|
}
|
|
106
106
|
|
|
107
107
|
/**
|
|
108
|
-
* @author
|
|
108
|
+
* @author Myndware <augusto.pissarra@myndware.com>
|
|
109
109
|
* @description Get the return data and check for errors
|
|
110
110
|
* @param {object} retData Response HTTP
|
|
111
111
|
* @return {*}
|
|
@@ -120,7 +120,7 @@ class AdminPolicy {
|
|
|
120
120
|
}
|
|
121
121
|
|
|
122
122
|
/**
|
|
123
|
-
* @author
|
|
123
|
+
* @author Myndware <augusto.pissarra@myndware.com>
|
|
124
124
|
* @description Set header with new session
|
|
125
125
|
* @param {string} session Session, token JWT
|
|
126
126
|
* @return {object} header with new session
|
|
@@ -135,7 +135,7 @@ class AdminPolicy {
|
|
|
135
135
|
}
|
|
136
136
|
|
|
137
137
|
/**
|
|
138
|
-
* @author
|
|
138
|
+
* @author Myndware <augusto.pissarra@myndware.com>
|
|
139
139
|
* @description Find all policies
|
|
140
140
|
* @param {string} session Session, token JWT
|
|
141
141
|
* @return {Promise}
|
|
@@ -293,7 +293,7 @@ class AdminProcesses {
|
|
|
293
293
|
}
|
|
294
294
|
|
|
295
295
|
/**
|
|
296
|
-
* @author
|
|
296
|
+
* @author Myndware <augusto.pissarra@myndware.com>
|
|
297
297
|
* @description Set header with new session
|
|
298
298
|
* @param {string} session Session, token JWT
|
|
299
299
|
* @return {object} header with new session
|
|
@@ -308,7 +308,7 @@ class AdminProcesses {
|
|
|
308
308
|
}
|
|
309
309
|
|
|
310
310
|
/**
|
|
311
|
-
* @author
|
|
311
|
+
* @author Myndware <augusto.pissarra@myndware.com>
|
|
312
312
|
* @description Mount query string to send in URL
|
|
313
313
|
* @param {object} params Params to mount query string
|
|
314
314
|
* @private
|
|
@@ -343,7 +343,7 @@ class AdminProcesses {
|
|
|
343
343
|
|
|
344
344
|
/**
|
|
345
345
|
* @see https://confluence.external-share.com/content/7450b014-52c6-4d9e-b30e-a062b57453b5/17104899/17694721/532545537
|
|
346
|
-
* @author
|
|
346
|
+
* @author Myndware <augusto.pissarra@myndware.com>
|
|
347
347
|
* @description Advanced search of processes, check documentation, to verify all params, pass to method search
|
|
348
348
|
* @return {Promise}
|
|
349
349
|
* @public
|
|
@@ -405,7 +405,7 @@ class AdminProcesses {
|
|
|
405
405
|
}
|
|
406
406
|
|
|
407
407
|
/**
|
|
408
|
-
* @author
|
|
408
|
+
* @author Myndware <augusto.pissarra@myndware.com>
|
|
409
409
|
* @description Advanced search of process in elastic search ussing system manager
|
|
410
410
|
* @param {!object} params - Params to search document
|
|
411
411
|
* @param {!string} params.orgProcessId - Document id (_id database) of the process
|
package/docs/admin_task.js.html
CHANGED
|
@@ -120,7 +120,7 @@ class AdminTask {
|
|
|
120
120
|
}
|
|
121
121
|
|
|
122
122
|
/**
|
|
123
|
-
* @author
|
|
123
|
+
* @author Myndware <augusto.pissarra@myndware.com>
|
|
124
124
|
* @description Set header with new session
|
|
125
125
|
* @param {string} session Session, token JWT
|
|
126
126
|
* @return {object} header with new session
|
|
@@ -135,7 +135,7 @@ class AdminTask {
|
|
|
135
135
|
}
|
|
136
136
|
|
|
137
137
|
/**
|
|
138
|
-
* @author
|
|
138
|
+
* @author Myndware <augusto.pissarra@myndware.com>
|
|
139
139
|
* @description Get filter to search tasks
|
|
140
140
|
* @param {string} filter Filter type
|
|
141
141
|
* @return {*}
|
|
@@ -154,7 +154,7 @@ class AdminTask {
|
|
|
154
154
|
}
|
|
155
155
|
|
|
156
156
|
/**
|
|
157
|
-
* @author
|
|
157
|
+
* @author Myndware <augusto.pissarra@myndware.com>
|
|
158
158
|
* @description Get task by user Id
|
|
159
159
|
* @param {object} params Params to get task
|
|
160
160
|
* @param {string} params.userId User id (_id database)
|
package/docs/admin_user.js.html
CHANGED
|
@@ -105,7 +105,7 @@ class AdminUser {
|
|
|
105
105
|
}
|
|
106
106
|
|
|
107
107
|
/**
|
|
108
|
-
* @author
|
|
108
|
+
* @author Myndware <augusto.pissarra@myndware.com>
|
|
109
109
|
* @description Get the return data and check for errors
|
|
110
110
|
* @param {object} retData Response HTTP
|
|
111
111
|
* @return {*}
|
|
@@ -120,7 +120,7 @@ class AdminUser {
|
|
|
120
120
|
}
|
|
121
121
|
|
|
122
122
|
/**
|
|
123
|
-
* @author
|
|
123
|
+
* @author Myndware <augusto.pissarra@myndware.com>
|
|
124
124
|
* @description Set header with new session
|
|
125
125
|
* @param {string} session Session, token JWT
|
|
126
126
|
* @return {object} header with new session
|
|
@@ -135,7 +135,7 @@ class AdminUser {
|
|
|
135
135
|
}
|
|
136
136
|
|
|
137
137
|
/**
|
|
138
|
-
* @author
|
|
138
|
+
* @author Myndware <augusto.pissarra@myndware.com>
|
|
139
139
|
* @description Request profile by userId
|
|
140
140
|
* @param {string} userId User identifier (_id database)
|
|
141
141
|
* @param {string} session Is token JWT
|
|
@@ -166,7 +166,7 @@ class AdminUser {
|
|
|
166
166
|
}
|
|
167
167
|
|
|
168
168
|
/**
|
|
169
|
-
* @author
|
|
169
|
+
* @author Myndware <augusto.pissarra@myndware.com>
|
|
170
170
|
* @description Request profile by userId
|
|
171
171
|
* @param {string} userIds Users identifier (_id database)
|
|
172
172
|
* @param {string} apiKey Api to use to search users
|
|
@@ -196,7 +196,7 @@ class AdminUser {
|
|
|
196
196
|
}
|
|
197
197
|
|
|
198
198
|
/**
|
|
199
|
-
* @author
|
|
199
|
+
* @author Myndware <augusto.pissarra@myndware.com>
|
|
200
200
|
* @description Update password by userId
|
|
201
201
|
* @param {object} params Params to update password
|
|
202
202
|
* @param {string} params.userId Id of the user
|
|
@@ -237,7 +237,7 @@ class AdminUser {
|
|
|
237
237
|
}
|
|
238
238
|
|
|
239
239
|
/**
|
|
240
|
-
* @author
|
|
240
|
+
* @author Myndware <augusto.pissarra@myndware.com>
|
|
241
241
|
* @description Check if email is unique
|
|
242
242
|
* @param {string} email Check if email is unique
|
|
243
243
|
* @param {string} session Is token JWT
|
package/docs/dispatch.js.html
CHANGED
|
@@ -120,7 +120,7 @@ class Dispatch {
|
|
|
120
120
|
}
|
|
121
121
|
|
|
122
122
|
/**
|
|
123
|
-
* @author
|
|
123
|
+
* @author Myndware <augusto.pissarra@myndware.com>
|
|
124
124
|
* @description Set header with new session
|
|
125
125
|
* @param {string} session Session, token JWT
|
|
126
126
|
* @return {object} header with new session
|
|
@@ -164,7 +164,7 @@ class Dispatch {
|
|
|
164
164
|
}
|
|
165
165
|
|
|
166
166
|
/**
|
|
167
|
-
* @author
|
|
167
|
+
* @author Myndware <augusto.pissarra@myndware.com>
|
|
168
168
|
* @description Get client Axios
|
|
169
169
|
* @return {promise} return client axios
|
|
170
170
|
* @public
|
package/docs/external.js.html
CHANGED
|
@@ -120,7 +120,7 @@ class External {
|
|
|
120
120
|
}
|
|
121
121
|
|
|
122
122
|
/**
|
|
123
|
-
* @author
|
|
123
|
+
* @author Myndware <augusto.pissarra@myndware.com>
|
|
124
124
|
* @description Set header with new session
|
|
125
125
|
* @param {string} session Session, token JWT
|
|
126
126
|
* @return {object} header with new session
|
|
@@ -135,7 +135,7 @@ class External {
|
|
|
135
135
|
}
|
|
136
136
|
|
|
137
137
|
/**
|
|
138
|
-
* @author
|
|
138
|
+
* @author Myndware <augusto.pissarra@myndware.com>
|
|
139
139
|
* @description Create new document
|
|
140
140
|
* @param {object} params Object for add new document
|
|
141
141
|
* @param {string} params.id Organization form id
|
|
@@ -174,7 +174,7 @@ class External {
|
|
|
174
174
|
}
|
|
175
175
|
|
|
176
176
|
/**
|
|
177
|
-
* @author
|
|
177
|
+
* @author Myndware <augusto.pissarra@myndware.com>
|
|
178
178
|
* @description Get an upload signed url, so it will be possible to upload documents temporarily during the use of the external form
|
|
179
179
|
* @param {string} mime the mime type of the document
|
|
180
180
|
* @param {string} authorization a legal authorization
|
|
@@ -212,7 +212,7 @@ class External {
|
|
|
212
212
|
}
|
|
213
213
|
|
|
214
214
|
/**
|
|
215
|
-
* @author
|
|
215
|
+
* @author Myndware <augusto.pissarra@myndware.com>
|
|
216
216
|
* @description Get an upload signed url, for many documents. So it will be possible to upload documents temporarily during the use of the external form
|
|
217
217
|
* @param {array<object>} docs the list of documents
|
|
218
218
|
* @param {string} docs.mime the mime type of the document
|
|
@@ -253,7 +253,7 @@ class External {
|
|
|
253
253
|
}
|
|
254
254
|
|
|
255
255
|
/**
|
|
256
|
-
* @author
|
|
256
|
+
* @author Myndware <augusto.pissarra@myndware.com>
|
|
257
257
|
* @description Handles the execution of an external form
|
|
258
258
|
* @param {string} authorization a legal authorization
|
|
259
259
|
* @param {object} params the parameters to handle the execution of an external form
|
|
@@ -105,7 +105,7 @@ class GeoLocation {
|
|
|
105
105
|
}
|
|
106
106
|
|
|
107
107
|
/**
|
|
108
|
-
* @author
|
|
108
|
+
* @author Myndware <augusto.pissarra@myndware.com>
|
|
109
109
|
* @description Get the return data and check for errors
|
|
110
110
|
* @param {object} retData Response HTTP
|
|
111
111
|
* @return {*}
|
|
@@ -120,7 +120,7 @@ class GeoLocation {
|
|
|
120
120
|
}
|
|
121
121
|
|
|
122
122
|
/**
|
|
123
|
-
* @author
|
|
123
|
+
* @author Myndware <augusto.pissarra@myndware.com>
|
|
124
124
|
* @description Set header with new session
|
|
125
125
|
* @param {string} session Session, token JWT
|
|
126
126
|
* @return {object} header with new session
|
|
@@ -135,7 +135,7 @@ class GeoLocation {
|
|
|
135
135
|
}
|
|
136
136
|
|
|
137
137
|
/**
|
|
138
|
-
* @author
|
|
138
|
+
* @author Myndware <augusto.pissarra@myndware.com>
|
|
139
139
|
* @description Get geo location of the address
|
|
140
140
|
* @param {!object} params - Params to get geo location
|
|
141
141
|
* @param {!string} params.address - The address to get the location for
|
|
@@ -93,7 +93,7 @@ import Geo from './geoLocation.js';
|
|
|
93
93
|
*/
|
|
94
94
|
class Users {
|
|
95
95
|
/**
|
|
96
|
-
* @author
|
|
96
|
+
* @author Myndware <augusto.pissarra@myndware.com>
|
|
97
97
|
* @constructor
|
|
98
98
|
* @param {object} options Params of the constructor
|
|
99
99
|
* @param {object} options.parent This of the pararent
|
package/docs/login.js.html
CHANGED
|
@@ -119,7 +119,7 @@ class Login {
|
|
|
119
119
|
}
|
|
120
120
|
|
|
121
121
|
/**
|
|
122
|
-
* @author
|
|
122
|
+
* @author Myndware <augusto.pissarra@myndware.com>
|
|
123
123
|
* @description Set header with new session
|
|
124
124
|
* @param {string} session Session, token JWT
|
|
125
125
|
* @return {object} header with new session
|
|
@@ -134,7 +134,7 @@ class Login {
|
|
|
134
134
|
}
|
|
135
135
|
|
|
136
136
|
/**
|
|
137
|
-
* @author
|
|
137
|
+
* @author Myndware <augusto.pissarra@myndware.com>
|
|
138
138
|
* @description Login with social login Facebook
|
|
139
139
|
* @param {object} params Params to login Facebook
|
|
140
140
|
* @param {string} params.accessToken Access token of the system manager
|
|
@@ -174,7 +174,7 @@ class Login {
|
|
|
174
174
|
}
|
|
175
175
|
|
|
176
176
|
/**
|
|
177
|
-
* @author
|
|
177
|
+
* @author Myndware <augusto.pissarra@myndware.com>
|
|
178
178
|
* @description Login with social login Google
|
|
179
179
|
* @param {object} params Params to login Google
|
|
180
180
|
* @param {string} params.accessToken Access token of the system manager
|
|
@@ -214,7 +214,7 @@ class Login {
|
|
|
214
214
|
}
|
|
215
215
|
|
|
216
216
|
/**
|
|
217
|
-
* @author
|
|
217
|
+
* @author Myndware <augusto.pissarra@myndware.com>
|
|
218
218
|
* @description Login with apikey
|
|
219
219
|
* @param {string} apikey Access key
|
|
220
220
|
* @return {promise<object>} data
|
|
@@ -245,7 +245,7 @@ class Login {
|
|
|
245
245
|
}
|
|
246
246
|
|
|
247
247
|
/**
|
|
248
|
-
* @author
|
|
248
|
+
* @author Myndware <augusto.pissarra@myndware.com>
|
|
249
249
|
* @description Login with user and password
|
|
250
250
|
* @param {object} params Object with user and password
|
|
251
251
|
* @param {string} params.username Username or email of the user
|
|
@@ -289,7 +289,7 @@ class Login {
|
|
|
289
289
|
}
|
|
290
290
|
|
|
291
291
|
/**
|
|
292
|
-
* @author
|
|
292
|
+
* @author Myndware <augusto.pissarra@myndware.com>
|
|
293
293
|
* @description Logout user system manager
|
|
294
294
|
* @param {string} session Session, token JWT
|
|
295
295
|
* @return {promise<object>}} data
|
|
@@ -320,7 +320,7 @@ class Login {
|
|
|
320
320
|
}
|
|
321
321
|
|
|
322
322
|
/**
|
|
323
|
-
* @author
|
|
323
|
+
* @author Myndware <augusto.pissarra@myndware.com>
|
|
324
324
|
* @description Recover the password
|
|
325
325
|
* @param {string} username The username or email
|
|
326
326
|
* @return {promise<object>}} data
|
package/docs/session.js.html
CHANGED
|
@@ -122,7 +122,7 @@ class Session {
|
|
|
122
122
|
}
|
|
123
123
|
|
|
124
124
|
/**
|
|
125
|
-
* @author
|
|
125
|
+
* @author Myndware <augusto.pissarra@myndware.com>
|
|
126
126
|
* @description Set header with new session
|
|
127
127
|
* @param {string} session Session, token JWT
|
|
128
128
|
* @return {object} header with new session
|
|
@@ -122,7 +122,7 @@ class Application {
|
|
|
122
122
|
}
|
|
123
123
|
|
|
124
124
|
/**
|
|
125
|
-
* @author
|
|
125
|
+
* @author Myndware <augusto.pissarra@myndware.com>
|
|
126
126
|
* @description Set header with new session
|
|
127
127
|
* @param {string} session Session, token JWT
|
|
128
128
|
* @return {object} header with new session
|
|
@@ -137,7 +137,7 @@ class Application {
|
|
|
137
137
|
}
|
|
138
138
|
|
|
139
139
|
/**
|
|
140
|
-
* @author
|
|
140
|
+
* @author Myndware <augusto.pissarra@myndware.com>
|
|
141
141
|
* @description Get the available applications for this user in this organizations
|
|
142
142
|
* @param {object} params Params to get task
|
|
143
143
|
* @param {object} params.orgId Organization id (_id database)
|
|
@@ -120,7 +120,7 @@ class Datasource {
|
|
|
120
120
|
}
|
|
121
121
|
|
|
122
122
|
/**
|
|
123
|
-
* @author
|
|
123
|
+
* @author Myndware <augusto.pissarra@myndware.com>
|
|
124
124
|
* @description Set header with new session
|
|
125
125
|
* @param {string} session Session, token JWT
|
|
126
126
|
* @return {object} header with new session
|
|
@@ -139,7 +139,7 @@ class Datasource {
|
|
|
139
139
|
}
|
|
140
140
|
|
|
141
141
|
/**
|
|
142
|
-
* @author
|
|
142
|
+
* @author Myndware <augusto.pissarra@myndware.com>
|
|
143
143
|
* @description Method to get autocomplete data from a datasource
|
|
144
144
|
* @param {object} params Params to add notification token
|
|
145
145
|
* @param {string} params.orgId The user organization _id
|
|
@@ -134,7 +134,7 @@ class Documents {
|
|
|
134
134
|
}
|
|
135
135
|
|
|
136
136
|
/**
|
|
137
|
-
* @author
|
|
137
|
+
* @author Myndware <augusto.pissarra@myndware.com>
|
|
138
138
|
* @description Set header with new session
|
|
139
139
|
* @param {string} session Session, token JWT
|
|
140
140
|
* @return {object} header with new session
|
|
@@ -149,7 +149,7 @@ class Documents {
|
|
|
149
149
|
}
|
|
150
150
|
|
|
151
151
|
/**
|
|
152
|
-
* @author
|
|
152
|
+
* @author Myndware <augusto.pissarra@myndware.com>
|
|
153
153
|
* @description Create document with informed data
|
|
154
154
|
* @param {object} params Object for add new document
|
|
155
155
|
* @param {string} params.orgname Organization name
|
|
@@ -213,7 +213,7 @@ class Documents {
|
|
|
213
213
|
}
|
|
214
214
|
|
|
215
215
|
/**
|
|
216
|
-
* @author
|
|
216
|
+
* @author Myndware <augusto.pissarra@myndware.com>
|
|
217
217
|
* @description Transform objtect query in query string
|
|
218
218
|
* @param {object} searchQuery object wicth query
|
|
219
219
|
* @return {string} Retutn string query
|
|
@@ -237,7 +237,7 @@ class Documents {
|
|
|
237
237
|
}
|
|
238
238
|
|
|
239
239
|
/**
|
|
240
|
-
* @author
|
|
240
|
+
* @author Myndware <augusto.pissarra@myndware.com>
|
|
241
241
|
* @description Create new document
|
|
242
242
|
* @param {object} params Object for add new document
|
|
243
243
|
* @param {string} params.orgname Organization name
|
|
@@ -326,7 +326,7 @@ class Documents {
|
|
|
326
326
|
}
|
|
327
327
|
|
|
328
328
|
/**
|
|
329
|
-
* @author
|
|
329
|
+
* @author Myndware <augusto.pissarra@myndware.com>
|
|
330
330
|
* @description Updates a document
|
|
331
331
|
* @param {string} id Document _id
|
|
332
332
|
* @param {object} params Object for document payload to update. It has to be the FULL document data, that you can get with findById
|
|
@@ -359,7 +359,7 @@ class Documents {
|
|
|
359
359
|
}
|
|
360
360
|
|
|
361
361
|
/**
|
|
362
|
-
* @author
|
|
362
|
+
* @author Myndware <augusto.pissarra@myndware.com>
|
|
363
363
|
* @description Updates a document.
|
|
364
364
|
* IMPORTANT: if your document has a content, it will NOT bring the content.
|
|
365
365
|
* @param {string} id Document _id
|
|
@@ -392,7 +392,7 @@ class Documents {
|
|
|
392
392
|
}
|
|
393
393
|
|
|
394
394
|
/**
|
|
395
|
-
* @author
|
|
395
|
+
* @author Myndware <augusto.pissarra@myndware.com>
|
|
396
396
|
* @param {object} params Object with params
|
|
397
397
|
* @param {string} params.index Field to search
|
|
398
398
|
* @param {string} params.txtToSearch Text to search
|
|
@@ -484,7 +484,7 @@ class Documents {
|
|
|
484
484
|
}
|
|
485
485
|
|
|
486
486
|
/**
|
|
487
|
-
* @author
|
|
487
|
+
* @author Myndware <augusto.pissarra@myndware.com>
|
|
488
488
|
* @description Remove document by id
|
|
489
489
|
* @param {object} params Params to remove document
|
|
490
490
|
* @param {string} params.docId Document Id (_id database)
|
|
@@ -528,7 +528,7 @@ class Documents {
|
|
|
528
528
|
}
|
|
529
529
|
|
|
530
530
|
/**
|
|
531
|
-
* @author
|
|
531
|
+
* @author Myndware <augusto.pissarra@myndware.com>
|
|
532
532
|
* @description Remove documents
|
|
533
533
|
* @param {object} params Params to remove document
|
|
534
534
|
* @param {array<string>} params.documents An array ids of documents (_id database)
|
|
@@ -574,7 +574,7 @@ class Documents {
|
|
|
574
574
|
|
|
575
575
|
/**
|
|
576
576
|
*
|
|
577
|
-
* @author
|
|
577
|
+
* @author Myndware <augusto.pissarra@myndware.com>
|
|
578
578
|
* @description Request signed url url to put or get
|
|
579
579
|
* @param {object} params Params to request signed url
|
|
580
580
|
* @param {string} params.methodType Method type HTTP get or put
|
|
@@ -663,7 +663,7 @@ class Documents {
|
|
|
663
663
|
|
|
664
664
|
/**
|
|
665
665
|
*
|
|
666
|
-
* @author
|
|
666
|
+
* @author Myndware <augusto.pissarra@myndware.com>
|
|
667
667
|
* @description Request signed url url to put or get
|
|
668
668
|
* @param {object} params Params to request signed url
|
|
669
669
|
* @param {array} params.docs the list of documents to get the signed urls
|
|
@@ -793,7 +793,7 @@ class Documents {
|
|
|
793
793
|
}
|
|
794
794
|
|
|
795
795
|
/**
|
|
796
|
-
* @author
|
|
796
|
+
* @author Myndware <augusto.pissarra@myndware.com>
|
|
797
797
|
* Checks if a document can be added and it does not repeat its primary key
|
|
798
798
|
* @param params
|
|
799
799
|
* @param params.orgId {string} the organization id
|
|
@@ -847,7 +847,7 @@ class Documents {
|
|
|
847
847
|
}
|
|
848
848
|
|
|
849
849
|
/**
|
|
850
|
-
* @author
|
|
850
|
+
* @author Myndware <augusto.pissarra@myndware.com>
|
|
851
851
|
* @description Method to search documents for
|
|
852
852
|
* @param {object} params Params to search the documents
|
|
853
853
|
* @param {object} params.query Search documents query
|
package/docs/user_help.js.html
CHANGED
|
@@ -120,7 +120,7 @@ class Help {
|
|
|
120
120
|
}
|
|
121
121
|
|
|
122
122
|
/**
|
|
123
|
-
* @author
|
|
123
|
+
* @author Myndware <augusto.pissarra@myndware.com>
|
|
124
124
|
* @description Set header with new session
|
|
125
125
|
* @param {string} session Session, token JWT
|
|
126
126
|
* @return {object} header with new session
|
|
@@ -166,7 +166,7 @@ class Help {
|
|
|
166
166
|
}
|
|
167
167
|
|
|
168
168
|
/**
|
|
169
|
-
* @author
|
|
169
|
+
* @author Myndware <augusto.pissarra@myndware.com>
|
|
170
170
|
* @description Method to find helps from a topic
|
|
171
171
|
* @param {object} params Params to get helps from topic
|
|
172
172
|
* @param {object} params.id Topic id (_id database)
|
package/docs/user_index.js.html
CHANGED
|
@@ -106,7 +106,7 @@ import Settings from './settings.js';
|
|
|
106
106
|
*/
|
|
107
107
|
class Users {
|
|
108
108
|
/**
|
|
109
|
-
* @author
|
|
109
|
+
* @author Myndware <augusto.pissarra@myndware.com>
|
|
110
110
|
* @constructor
|
|
111
111
|
* @param {object} options Params of the constructor
|
|
112
112
|
* @param {object} options.parent This of the pararent
|