@docbrasil/api-systemmanager 1.1.11 → 1.1.13

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 (7) hide show
  1. package/api/user/my_tasks.js +141 -18
  2. package/dist/bundle.cjs +141 -18
  3. package/dist/bundle.mjs +1 -1
  4. package/doc/api.md +1371 -518
  5. package/docs/MyTasks.html +1457 -59
  6. package/docs/user_my_tasks.js.html +203 -0
  7. package/package.json +1 -1
package/api/user/my_tasks.js CHANGED
@@ -94,10 +94,10 @@ class MyTasks {
94
94
  /**
95
95
  * @author CloudBrasil <abernardo.br@gmail.com>
96
96
  * @description Update task dueDate
97
- * @param {object} data The Date to save
98
- * @param {string} data.dueDate DueDate
99
- * @param {string} data.orgId Organization id
100
- * @param {string} data.taskId Task Id
97
+ * @param {object} params The Date to save
98
+ * @param {string} params.dueDate DueDate
99
+ * @param {string} params.orgId Organization id
100
+ * @param {string} params.taskId Task Id
101
101
  * @param {string} session Is token JWT of user
102
102
  * @return {Promise}
103
103
  * @public
@@ -106,27 +106,27 @@ class MyTasks {
106
106
  *
107
107
  * const API = require('@docbrasil/api-systemmanager');
108
108
  * const api = new API();
109
- * const data = {
109
+ * const params = {
110
110
  * dueDate: '2011-10-05T14:48:00.000Z',
111
111
  * orgId: '646386c9583e04a131adc894',
112
112
  * taskId: '646386c9583e04a131adc895'
113
113
  * };
114
114
  * const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
115
- * await api.user.task.mytasks.saveDueDate(data, session);
115
+ * await api.user.task.mytasks.saveDueDate(params, session);
116
116
  */
117
- async saveDueDate(data, session) {
117
+ async saveDueDate(params, session) {
118
118
  const self = this;
119
119
 
120
120
  try {
121
- Joi.assert(data, Joi.object().required());
122
- Joi.assert(data.dueDate, Joi.string().required());
123
- Joi.assert(data.orgId, Joi.string().required());
124
- Joi.assert(data.taskId, Joi.string().required());
121
+ Joi.assert(params, Joi.object().required());
122
+ Joi.assert(params.dueDate, Joi.string().required());
123
+ Joi.assert(params.orgId, Joi.string().required());
124
+ Joi.assert(params.taskId, Joi.string().required());
125
125
  Joi.assert(session, Joi.string().required());
126
126
 
127
127
  const {taskId, orgId} = params;
128
128
 
129
- const apiCall = self._client.put(`/organizations/${orgId}/users/tasks/${taskId}/duedate`, data, self._setHeader(session));
129
+ const apiCall = self._client.put(`/organizations/${orgId}/users/tasks/${taskId}/duedate`, params, self._setHeader(session));
130
130
  return self._returnData(await apiCall);
131
131
  } catch (ex) {
132
132
  throw ex;
@@ -146,20 +146,20 @@ class MyTasks {
146
146
  *
147
147
  * const API = require('@docbrasil/api-systemmanager');
148
148
  * const api = new API();
149
- * const data = {
149
+ * const params = {
150
150
  * orgId: '646386c9583e04a131adc894',
151
151
  * taskId: '646386c9583e04a131adc895'
152
152
  * };
153
153
  * const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
154
- * await api.user.task.mytasks.removeDueDate(data, session);
154
+ * await api.user.task.mytasks.removeDueDate(params, session);
155
155
  */
156
- async removeDueDate(data, session) {
156
+ async removeDueDate(params, session) {
157
157
  const self = this;
158
158
 
159
159
  try {
160
- Joi.assert(data, Joi.object().required());
161
- Joi.assert(data.orgId, Joi.string().required());
162
- Joi.assert(data.taskId, Joi.string().required());
160
+ Joi.assert(params, Joi.object().required());
161
+ Joi.assert(params.orgId, Joi.string().required());
162
+ Joi.assert(params.taskId, Joi.string().required());
163
163
  Joi.assert(session, Joi.string().required());
164
164
 
165
165
  const {taskId, orgId} = params;
@@ -170,6 +170,129 @@ class MyTasks {
170
170
  throw ex;
171
171
  }
172
172
  }
173
+
174
+ /**
175
+ * @author CloudBrasil <abernardo.br@gmail.com>
176
+ * @description Method to get task multi users
177
+ * @param {object} params Params to get task
178
+ * @param {object} params.taskId Task id (_id database)
179
+ * @param {object} params.orgId Organization id (_id database)
180
+ * @param {string} session Session, token JWT
181
+ * @returns {promise}
182
+ * @public
183
+ * @example
184
+ *
185
+ * const API = require('@docbrasil/api-systemmanager');
186
+ * const api = new API();
187
+ * const params = {
188
+ * taskId: '5df7f19618430c89a41a19d2',
189
+ * orgId: '55e4a3bd6be6b45210833fae',
190
+ * };
191
+ * const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
192
+ * await api.user.task.mytasks.getTaskMultiUsers(params, session);
193
+ */
194
+ async getTaskMultiUsers(params, session) {
195
+ const self = this;
196
+
197
+ try {
198
+ Joi.assert(params, Joi.object().required(), 'Params to get task multi users');
199
+ Joi.assert(params.taskId, Joi.string().required(), ' Task id (_id database)');
200
+ Joi.assert(params.orgId, Joi.string().required(), 'Organization id (_id database)');
201
+ Joi.assert(session, Joi.string().required(), 'Session token JWT');
202
+
203
+ const {taskId, orgId} = params;
204
+ const apiCall = self._client
205
+ .get(`/organizations/${orgId}/users/tasks/${taskId}/multi/assign`, self._setHeader(session));
206
+
207
+ return self._returnData(await apiCall);
208
+ } catch (ex) {
209
+ throw ex;
210
+ }
211
+ }
212
+
213
+ /**
214
+ * @author CloudBrasil <abernardo.br@gmail.com>
215
+ * @description remove multi task user
216
+ * @param {object} params Params of the user to be removed
217
+ * @param {string} params.userId User id
218
+ * @param {string} params.orgId Organization id
219
+ * @param {string} params.taskId Task Id
220
+ * @param {string} session Is token JWT of user
221
+ * @return {Promise}
222
+ * @public
223
+ * @async
224
+ * @example
225
+ *
226
+ * const API = require('@docbrasil/api-systemmanager');
227
+ * const api = new API();
228
+ * const params = {
229
+ * userId: '646386c9583e04a131adc896',
230
+ * orgId: '646386c9583e04a131adc894',
231
+ * taskId: '646386c9583e04a131adc895'
232
+ * };
233
+ * const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
234
+ * await api.user.task.mytasks.removeMultiTaskUser(params, session);
235
+ */
236
+ async removeMultiTaskUser(params, session) {
237
+ const self = this;
238
+
239
+ try {
240
+ Joi.assert(params, Joi.object().required());
241
+ Joi.assert(params.userId, Joi.string().required());
242
+ Joi.assert(params.orgId, Joi.string().required());
243
+ Joi.assert(params.taskId, Joi.string().required());
244
+ Joi.assert(session, Joi.string().required());
245
+
246
+ const {taskId, orgId, userId} = params;
247
+
248
+ const apiCall = self._client.delete(`/organizations/${orgId}/tasks/${taskId}/users/${userId}`, self._setHeader(session));
249
+ return self._returnData(await apiCall);
250
+ } catch (ex) {
251
+ throw ex;
252
+ }
253
+ }
254
+
255
+ /**
256
+ * @author CloudBrasil <abernardo.br@gmail.com>
257
+ * @description Add Multi Task User
258
+ * @param {object} params Params for adding multi task user
259
+ * @param {string} params.userId User id
260
+ * @param {string} params.orgId Organization id
261
+ * @param {string} params.taskId Task Id
262
+ * @param {string} session Is token JWT of user
263
+ * @return {Promise}
264
+ * @public
265
+ * @async
266
+ * @example
267
+ *
268
+ * const API = require('@docbrasil/api-systemmanager');
269
+ * const api = new API();
270
+ * const params = {
271
+ * userId: '646386c9583e04a131adc8946',
272
+ * orgId: '646386c9583e04a131adc894',
273
+ * taskId: '646386c9583e04a131adc895'
274
+ * };
275
+ * const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
276
+ * await api.user.task.mytasks.addMultiTaskUser(params, session);
277
+ */
278
+ async addMultiTaskUser(params, session) {
279
+ const self = this;
280
+
281
+ try {
282
+ Joi.assert(params, Joi.object().required());
283
+ Joi.assert(params.userId, Joi.string().required());
284
+ Joi.assert(params.orgId, Joi.string().required());
285
+ Joi.assert(params.taskId, Joi.string().required());
286
+ Joi.assert(session, Joi.string().required());
287
+
288
+ const {taskId, orgId, userId} = params;
289
+
290
+ const apiCall = self._client.put(`/organizations/${orgId}/tasks/${taskId}/users`, { userIdToAdd: userId }, self._setHeader(session));
291
+ return self._returnData(await apiCall);
292
+ } catch (ex) {
293
+ throw ex;
294
+ }
295
+ }
173
296
  }
174
297
 
175
298
  export default MyTasks;
package/dist/bundle.cjs CHANGED
@@ -2238,10 +2238,10 @@ class MyTasks {
2238
2238
  /**
2239
2239
  * @author CloudBrasil <abernardo.br@gmail.com>
2240
2240
  * @description Update task dueDate
2241
- * @param {object} data The Date to save
2242
- * @param {string} data.dueDate DueDate
2243
- * @param {string} data.orgId Organization id
2244
- * @param {string} data.taskId Task Id
2241
+ * @param {object} params The Date to save
2242
+ * @param {string} params.dueDate DueDate
2243
+ * @param {string} params.orgId Organization id
2244
+ * @param {string} params.taskId Task Id
2245
2245
  * @param {string} session Is token JWT of user
2246
2246
  * @return {Promise}
2247
2247
  * @public
@@ -2250,27 +2250,27 @@ class MyTasks {
2250
2250
  *
2251
2251
  * const API = require('@docbrasil/api-systemmanager');
2252
2252
  * const api = new API();
2253
- * const data = {
2253
+ * const params = {
2254
2254
  * dueDate: '2011-10-05T14:48:00.000Z',
2255
2255
  * orgId: '646386c9583e04a131adc894',
2256
2256
  * taskId: '646386c9583e04a131adc895'
2257
2257
  * };
2258
2258
  * const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
2259
- * await api.user.task.mytasks.saveDueDate(data, session);
2259
+ * await api.user.task.mytasks.saveDueDate(params, session);
2260
2260
  */
2261
- async saveDueDate(data, session) {
2261
+ async saveDueDate(params, session) {
2262
2262
  const self = this;
2263
2263
 
2264
2264
  try {
2265
- Joi__default["default"].assert(data, Joi__default["default"].object().required());
2266
- Joi__default["default"].assert(data.dueDate, Joi__default["default"].string().required());
2267
- Joi__default["default"].assert(data.orgId, Joi__default["default"].string().required());
2268
- Joi__default["default"].assert(data.taskId, Joi__default["default"].string().required());
2265
+ Joi__default["default"].assert(params, Joi__default["default"].object().required());
2266
+ Joi__default["default"].assert(params.dueDate, Joi__default["default"].string().required());
2267
+ Joi__default["default"].assert(params.orgId, Joi__default["default"].string().required());
2268
+ Joi__default["default"].assert(params.taskId, Joi__default["default"].string().required());
2269
2269
  Joi__default["default"].assert(session, Joi__default["default"].string().required());
2270
2270
 
2271
2271
  const {taskId, orgId} = params;
2272
2272
 
2273
- const apiCall = self._client.put(`/organizations/${orgId}/users/tasks/${taskId}/duedate`, data, self._setHeader(session));
2273
+ const apiCall = self._client.put(`/organizations/${orgId}/users/tasks/${taskId}/duedate`, params, self._setHeader(session));
2274
2274
  return self._returnData(await apiCall);
2275
2275
  } catch (ex) {
2276
2276
  throw ex;
@@ -2290,20 +2290,20 @@ class MyTasks {
2290
2290
  *
2291
2291
  * const API = require('@docbrasil/api-systemmanager');
2292
2292
  * const api = new API();
2293
- * const data = {
2293
+ * const params = {
2294
2294
  * orgId: '646386c9583e04a131adc894',
2295
2295
  * taskId: '646386c9583e04a131adc895'
2296
2296
  * };
2297
2297
  * const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
2298
- * await api.user.task.mytasks.removeDueDate(data, session);
2298
+ * await api.user.task.mytasks.removeDueDate(params, session);
2299
2299
  */
2300
- async removeDueDate(data, session) {
2300
+ async removeDueDate(params, session) {
2301
2301
  const self = this;
2302
2302
 
2303
2303
  try {
2304
- Joi__default["default"].assert(data, Joi__default["default"].object().required());
2305
- Joi__default["default"].assert(data.orgId, Joi__default["default"].string().required());
2306
- Joi__default["default"].assert(data.taskId, Joi__default["default"].string().required());
2304
+ Joi__default["default"].assert(params, Joi__default["default"].object().required());
2305
+ Joi__default["default"].assert(params.orgId, Joi__default["default"].string().required());
2306
+ Joi__default["default"].assert(params.taskId, Joi__default["default"].string().required());
2307
2307
  Joi__default["default"].assert(session, Joi__default["default"].string().required());
2308
2308
 
2309
2309
  const {taskId, orgId} = params;
@@ -2314,6 +2314,129 @@ class MyTasks {
2314
2314
  throw ex;
2315
2315
  }
2316
2316
  }
2317
+
2318
+ /**
2319
+ * @author CloudBrasil <abernardo.br@gmail.com>
2320
+ * @description Method to get task multi users
2321
+ * @param {object} params Params to get task
2322
+ * @param {object} params.taskId Task id (_id database)
2323
+ * @param {object} params.orgId Organization id (_id database)
2324
+ * @param {string} session Session, token JWT
2325
+ * @returns {promise}
2326
+ * @public
2327
+ * @example
2328
+ *
2329
+ * const API = require('@docbrasil/api-systemmanager');
2330
+ * const api = new API();
2331
+ * const params = {
2332
+ * taskId: '5df7f19618430c89a41a19d2',
2333
+ * orgId: '55e4a3bd6be6b45210833fae',
2334
+ * };
2335
+ * const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
2336
+ * await api.user.task.mytasks.getTaskMultiUsers(params, session);
2337
+ */
2338
+ async getTaskMultiUsers(params, session) {
2339
+ const self = this;
2340
+
2341
+ try {
2342
+ Joi__default["default"].assert(params, Joi__default["default"].object().required(), 'Params to get task multi users');
2343
+ Joi__default["default"].assert(params.taskId, Joi__default["default"].string().required(), ' Task id (_id database)');
2344
+ Joi__default["default"].assert(params.orgId, Joi__default["default"].string().required(), 'Organization id (_id database)');
2345
+ Joi__default["default"].assert(session, Joi__default["default"].string().required(), 'Session token JWT');
2346
+
2347
+ const {taskId, orgId} = params;
2348
+ const apiCall = self._client
2349
+ .get(`/organizations/${orgId}/users/tasks/${taskId}/multi/assign`, self._setHeader(session));
2350
+
2351
+ return self._returnData(await apiCall);
2352
+ } catch (ex) {
2353
+ throw ex;
2354
+ }
2355
+ }
2356
+
2357
+ /**
2358
+ * @author CloudBrasil <abernardo.br@gmail.com>
2359
+ * @description remove multi task user
2360
+ * @param {object} params Params of the user to be removed
2361
+ * @param {string} params.userId User id
2362
+ * @param {string} params.orgId Organization id
2363
+ * @param {string} params.taskId Task Id
2364
+ * @param {string} session Is token JWT of user
2365
+ * @return {Promise}
2366
+ * @public
2367
+ * @async
2368
+ * @example
2369
+ *
2370
+ * const API = require('@docbrasil/api-systemmanager');
2371
+ * const api = new API();
2372
+ * const params = {
2373
+ * userId: '646386c9583e04a131adc896',
2374
+ * orgId: '646386c9583e04a131adc894',
2375
+ * taskId: '646386c9583e04a131adc895'
2376
+ * };
2377
+ * const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
2378
+ * await api.user.task.mytasks.removeMultiTaskUser(params, session);
2379
+ */
2380
+ async removeMultiTaskUser(params, session) {
2381
+ const self = this;
2382
+
2383
+ try {
2384
+ Joi__default["default"].assert(params, Joi__default["default"].object().required());
2385
+ Joi__default["default"].assert(params.userId, Joi__default["default"].string().required());
2386
+ Joi__default["default"].assert(params.orgId, Joi__default["default"].string().required());
2387
+ Joi__default["default"].assert(params.taskId, Joi__default["default"].string().required());
2388
+ Joi__default["default"].assert(session, Joi__default["default"].string().required());
2389
+
2390
+ const {taskId, orgId, userId} = params;
2391
+
2392
+ const apiCall = self._client.delete(`/organizations/${orgId}/tasks/${taskId}/users/${userId}`, self._setHeader(session));
2393
+ return self._returnData(await apiCall);
2394
+ } catch (ex) {
2395
+ throw ex;
2396
+ }
2397
+ }
2398
+
2399
+ /**
2400
+ * @author CloudBrasil <abernardo.br@gmail.com>
2401
+ * @description Add Multi Task User
2402
+ * @param {object} params Params for adding multi task user
2403
+ * @param {string} params.userId User id
2404
+ * @param {string} params.orgId Organization id
2405
+ * @param {string} params.taskId Task Id
2406
+ * @param {string} session Is token JWT of user
2407
+ * @return {Promise}
2408
+ * @public
2409
+ * @async
2410
+ * @example
2411
+ *
2412
+ * const API = require('@docbrasil/api-systemmanager');
2413
+ * const api = new API();
2414
+ * const params = {
2415
+ * userId: '646386c9583e04a131adc8946',
2416
+ * orgId: '646386c9583e04a131adc894',
2417
+ * taskId: '646386c9583e04a131adc895'
2418
+ * };
2419
+ * const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
2420
+ * await api.user.task.mytasks.addMultiTaskUser(params, session);
2421
+ */
2422
+ async addMultiTaskUser(params, session) {
2423
+ const self = this;
2424
+
2425
+ try {
2426
+ Joi__default["default"].assert(params, Joi__default["default"].object().required());
2427
+ Joi__default["default"].assert(params.userId, Joi__default["default"].string().required());
2428
+ Joi__default["default"].assert(params.orgId, Joi__default["default"].string().required());
2429
+ Joi__default["default"].assert(params.taskId, Joi__default["default"].string().required());
2430
+ Joi__default["default"].assert(session, Joi__default["default"].string().required());
2431
+
2432
+ const {taskId, orgId, userId} = params;
2433
+
2434
+ const apiCall = self._client.put(`/organizations/${orgId}/tasks/${taskId}/users`, { userIdToAdd: userId }, self._setHeader(session));
2435
+ return self._returnData(await apiCall);
2436
+ } catch (ex) {
2437
+ throw ex;
2438
+ }
2439
+ }
2317
2440
  }
2318
2441
 
2319
2442
  /**