@docbrasil/api-systemmanager 1.1.13 → 1.1.15
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/.project +11 -0
- package/api/user/my_tasks.js +161 -2
- package/dist/bundle.cjs +161 -2
- package/dist/bundle.mjs +1 -1
- package/doc/api.md +114 -0
- package/package.json +1 -1
- package/.vscode/settings.json +0 -1
package/.project
ADDED
package/api/user/my_tasks.js
CHANGED
|
@@ -252,7 +252,7 @@ class MyTasks {
|
|
|
252
252
|
}
|
|
253
253
|
}
|
|
254
254
|
|
|
255
|
-
|
|
255
|
+
/**
|
|
256
256
|
* @author CloudBrasil <abernardo.br@gmail.com>
|
|
257
257
|
* @description Add Multi Task User
|
|
258
258
|
* @param {object} params Params for adding multi task user
|
|
@@ -275,7 +275,7 @@ class MyTasks {
|
|
|
275
275
|
* const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
|
|
276
276
|
* await api.user.task.mytasks.addMultiTaskUser(params, session);
|
|
277
277
|
*/
|
|
278
|
-
|
|
278
|
+
async addMultiTaskUser(params, session) {
|
|
279
279
|
const self = this;
|
|
280
280
|
|
|
281
281
|
try {
|
|
@@ -292,7 +292,166 @@ class MyTasks {
|
|
|
292
292
|
} catch (ex) {
|
|
293
293
|
throw ex;
|
|
294
294
|
}
|
|
295
|
+
}
|
|
296
|
+
|
|
297
|
+
/**
|
|
298
|
+
* @author CloudBrasil <abernardo.br@gmail.com>
|
|
299
|
+
* @description Method to get assign task users
|
|
300
|
+
* @param {object} params Params to get task
|
|
301
|
+
* @param {object} params.taskId Task id (_id database)
|
|
302
|
+
* @param {object} params.orgId Organization id (_id database)
|
|
303
|
+
* @param {string} session Session, token JWT
|
|
304
|
+
* @returns {promise}
|
|
305
|
+
* @public
|
|
306
|
+
* @example
|
|
307
|
+
*
|
|
308
|
+
* const API = require('@docbrasil/api-systemmanager');
|
|
309
|
+
* const api = new API();
|
|
310
|
+
* const params = {
|
|
311
|
+
* taskId: '5df7f19618430c89a41a19d2',
|
|
312
|
+
* orgId: '55e4a3bd6be6b45210833fae',
|
|
313
|
+
* };
|
|
314
|
+
* const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
|
|
315
|
+
* await api.user.task.mytasks.getAssignTaskUsers(params, session);
|
|
316
|
+
*/
|
|
317
|
+
async getAssignTaskUsers(params, session) {
|
|
318
|
+
const self = this;
|
|
319
|
+
|
|
320
|
+
try {
|
|
321
|
+
Joi.assert(params, Joi.object().required(), 'Params to get assign task users');
|
|
322
|
+
Joi.assert(params.taskId, Joi.string().required(), ' Task id (_id database)');
|
|
323
|
+
Joi.assert(params.orgId, Joi.string().required(), 'Organization id (_id database)');
|
|
324
|
+
Joi.assert(session, Joi.string().required(), 'Session token JWT');
|
|
325
|
+
|
|
326
|
+
const {taskId, orgId} = params;
|
|
327
|
+
const apiCall = self._client
|
|
328
|
+
.get(`/organizations/${orgId}/users/tasks/${taskId}/assign`, self._setHeader(session));
|
|
329
|
+
|
|
330
|
+
return self._returnData(await apiCall);
|
|
331
|
+
} catch (ex) {
|
|
332
|
+
throw ex;
|
|
295
333
|
}
|
|
334
|
+
}
|
|
335
|
+
|
|
336
|
+
/**
|
|
337
|
+
* @author CloudBrasil <abernardo.br@gmail.com>
|
|
338
|
+
* @description Assign Task user
|
|
339
|
+
* @param {object} params The params to assign task to user
|
|
340
|
+
* @param {string} params.orgName Organization Name
|
|
341
|
+
* @param {string} params.userId User id that will be assigned the task
|
|
342
|
+
* @param {string} params.taskId Task Id
|
|
343
|
+
* @param {string} session Is token JWT of user
|
|
344
|
+
* @return {Promise}
|
|
345
|
+
* @public
|
|
346
|
+
* @async
|
|
347
|
+
* @example
|
|
348
|
+
*
|
|
349
|
+
* const API = require('@docbrasil/api-systemmanager');
|
|
350
|
+
* const api = new API();
|
|
351
|
+
* const params = {
|
|
352
|
+
* orgName: 'pinkbrain',
|
|
353
|
+
* userId: '646386c9583e04a131adc894',
|
|
354
|
+
* taskId: '646386c9583e04a131adc895'
|
|
355
|
+
* };
|
|
356
|
+
* const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
|
|
357
|
+
* await api.user.task.mytasks.assignTaskUser(params, session);
|
|
358
|
+
*/
|
|
359
|
+
async assignTaskUsers(params, session) {
|
|
360
|
+
const self = this;
|
|
361
|
+
|
|
362
|
+
try {
|
|
363
|
+
Joi.assert(params, Joi.object().required());
|
|
364
|
+
Joi.assert(params.orgName, Joi.string().required());
|
|
365
|
+
Joi.assert(params.userId, Joi.string().required());
|
|
366
|
+
Joi.assert(params.taskId, Joi.string().required());
|
|
367
|
+
Joi.assert(session, Joi.string().required());
|
|
368
|
+
|
|
369
|
+
const {taskId, userId, orgName} = params;
|
|
370
|
+
|
|
371
|
+
const apiCall = self._client.put(`/organizations/${orgName}/users/tasks/${taskId}/assign/${userId}`, {}, self._setHeader(session));
|
|
372
|
+
return self._returnData(await apiCall);
|
|
373
|
+
} catch (ex) {
|
|
374
|
+
throw ex;
|
|
375
|
+
}
|
|
376
|
+
}
|
|
377
|
+
|
|
378
|
+
/**
|
|
379
|
+
* @author CloudBrasil <abernardo.br@gmail.com>
|
|
380
|
+
* @description Unclaim task
|
|
381
|
+
* @param {object} params The params to unclaim task
|
|
382
|
+
* @param {string} params.orgName Organization Name
|
|
383
|
+
* @param {string} params.taskId Task Id
|
|
384
|
+
* @param {string} session Is token JWT of user
|
|
385
|
+
* @return {Promise}
|
|
386
|
+
* @public
|
|
387
|
+
* @async
|
|
388
|
+
* @example
|
|
389
|
+
*
|
|
390
|
+
* const API = require('@docbrasil/api-systemmanager');
|
|
391
|
+
* const api = new API();
|
|
392
|
+
* const params = {
|
|
393
|
+
* orgName: 'pinkbrain',
|
|
394
|
+
* taskId: '646386c9583e04a131adc895'
|
|
395
|
+
* };
|
|
396
|
+
* const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
|
|
397
|
+
* await api.user.task.mytasks.unclaim(params, session);
|
|
398
|
+
*/
|
|
399
|
+
async unclaim(params, session) {
|
|
400
|
+
const self = this;
|
|
401
|
+
|
|
402
|
+
try {
|
|
403
|
+
Joi.assert(params, Joi.object().required());
|
|
404
|
+
Joi.assert(params.orgName, Joi.string().required());
|
|
405
|
+
Joi.assert(params.taskId, Joi.string().required());
|
|
406
|
+
Joi.assert(session, Joi.string().required());
|
|
407
|
+
|
|
408
|
+
const {taskId, orgName} = params;
|
|
409
|
+
|
|
410
|
+
const apiCall = self._client.put(`/organizations/${orgName}/users/tasks/${taskId}/unclaim`, {}, self._setHeader(session));
|
|
411
|
+
return self._returnData(await apiCall);
|
|
412
|
+
} catch (ex) {
|
|
413
|
+
throw ex;
|
|
414
|
+
}
|
|
415
|
+
}
|
|
416
|
+
|
|
417
|
+
/**
|
|
418
|
+
* @author CloudBrasil <abernardo.br@gmail.com>
|
|
419
|
+
* @description Escalate task
|
|
420
|
+
* @param {object} params The params to escalate task
|
|
421
|
+
* @param {string} params.orgName Organization Name
|
|
422
|
+
* @param {string} params.taskId Task Id
|
|
423
|
+
* @param {string} session Is token JWT of user
|
|
424
|
+
* @return {Promise}
|
|
425
|
+
* @public
|
|
426
|
+
* @async
|
|
427
|
+
* @example
|
|
428
|
+
*
|
|
429
|
+
* const API = require('@docbrasil/api-systemmanager');
|
|
430
|
+
* const api = new API();
|
|
431
|
+
* const params = {
|
|
432
|
+
* orgName: 'pinkbrain',
|
|
433
|
+
* taskId: '646386c9583e04a131adc895'
|
|
434
|
+
* };
|
|
435
|
+
* const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
|
|
436
|
+
* await api.user.task.mytasks.escalate(params, session);
|
|
437
|
+
*/
|
|
438
|
+
async escalate(params, session) {
|
|
439
|
+
const self = this;
|
|
440
|
+
|
|
441
|
+
try {
|
|
442
|
+
Joi.assert(params, Joi.object().required());
|
|
443
|
+
Joi.assert(params.orgName, Joi.string().required());
|
|
444
|
+
Joi.assert(params.taskId, Joi.string().required());
|
|
445
|
+
Joi.assert(session, Joi.string().required());
|
|
446
|
+
|
|
447
|
+
const {taskId, orgName} = params;
|
|
448
|
+
|
|
449
|
+
const apiCall = self._client.put(`/organizations/${orgName}/users/tasks/${taskId}/escalate`, {}, self._setHeader(session));
|
|
450
|
+
return self._returnData(await apiCall);
|
|
451
|
+
} catch (ex) {
|
|
452
|
+
throw ex;
|
|
453
|
+
}
|
|
454
|
+
}
|
|
296
455
|
}
|
|
297
456
|
|
|
298
457
|
export default MyTasks;
|
package/dist/bundle.cjs
CHANGED
|
@@ -2396,7 +2396,7 @@ class MyTasks {
|
|
|
2396
2396
|
}
|
|
2397
2397
|
}
|
|
2398
2398
|
|
|
2399
|
-
|
|
2399
|
+
/**
|
|
2400
2400
|
* @author CloudBrasil <abernardo.br@gmail.com>
|
|
2401
2401
|
* @description Add Multi Task User
|
|
2402
2402
|
* @param {object} params Params for adding multi task user
|
|
@@ -2419,7 +2419,7 @@ class MyTasks {
|
|
|
2419
2419
|
* const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
|
|
2420
2420
|
* await api.user.task.mytasks.addMultiTaskUser(params, session);
|
|
2421
2421
|
*/
|
|
2422
|
-
|
|
2422
|
+
async addMultiTaskUser(params, session) {
|
|
2423
2423
|
const self = this;
|
|
2424
2424
|
|
|
2425
2425
|
try {
|
|
@@ -2436,7 +2436,166 @@ class MyTasks {
|
|
|
2436
2436
|
} catch (ex) {
|
|
2437
2437
|
throw ex;
|
|
2438
2438
|
}
|
|
2439
|
+
}
|
|
2440
|
+
|
|
2441
|
+
/**
|
|
2442
|
+
* @author CloudBrasil <abernardo.br@gmail.com>
|
|
2443
|
+
* @description Method to get assign task users
|
|
2444
|
+
* @param {object} params Params to get task
|
|
2445
|
+
* @param {object} params.taskId Task id (_id database)
|
|
2446
|
+
* @param {object} params.orgId Organization id (_id database)
|
|
2447
|
+
* @param {string} session Session, token JWT
|
|
2448
|
+
* @returns {promise}
|
|
2449
|
+
* @public
|
|
2450
|
+
* @example
|
|
2451
|
+
*
|
|
2452
|
+
* const API = require('@docbrasil/api-systemmanager');
|
|
2453
|
+
* const api = new API();
|
|
2454
|
+
* const params = {
|
|
2455
|
+
* taskId: '5df7f19618430c89a41a19d2',
|
|
2456
|
+
* orgId: '55e4a3bd6be6b45210833fae',
|
|
2457
|
+
* };
|
|
2458
|
+
* const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
|
|
2459
|
+
* await api.user.task.mytasks.getAssignTaskUsers(params, session);
|
|
2460
|
+
*/
|
|
2461
|
+
async getAssignTaskUsers(params, session) {
|
|
2462
|
+
const self = this;
|
|
2463
|
+
|
|
2464
|
+
try {
|
|
2465
|
+
Joi__default["default"].assert(params, Joi__default["default"].object().required(), 'Params to get assign task users');
|
|
2466
|
+
Joi__default["default"].assert(params.taskId, Joi__default["default"].string().required(), ' Task id (_id database)');
|
|
2467
|
+
Joi__default["default"].assert(params.orgId, Joi__default["default"].string().required(), 'Organization id (_id database)');
|
|
2468
|
+
Joi__default["default"].assert(session, Joi__default["default"].string().required(), 'Session token JWT');
|
|
2469
|
+
|
|
2470
|
+
const {taskId, orgId} = params;
|
|
2471
|
+
const apiCall = self._client
|
|
2472
|
+
.get(`/organizations/${orgId}/users/tasks/${taskId}/assign`, self._setHeader(session));
|
|
2473
|
+
|
|
2474
|
+
return self._returnData(await apiCall);
|
|
2475
|
+
} catch (ex) {
|
|
2476
|
+
throw ex;
|
|
2439
2477
|
}
|
|
2478
|
+
}
|
|
2479
|
+
|
|
2480
|
+
/**
|
|
2481
|
+
* @author CloudBrasil <abernardo.br@gmail.com>
|
|
2482
|
+
* @description Assign Task user
|
|
2483
|
+
* @param {object} params The params to assign task to user
|
|
2484
|
+
* @param {string} params.orgName Organization Name
|
|
2485
|
+
* @param {string} params.userId User id that will be assigned the task
|
|
2486
|
+
* @param {string} params.taskId Task Id
|
|
2487
|
+
* @param {string} session Is token JWT of user
|
|
2488
|
+
* @return {Promise}
|
|
2489
|
+
* @public
|
|
2490
|
+
* @async
|
|
2491
|
+
* @example
|
|
2492
|
+
*
|
|
2493
|
+
* const API = require('@docbrasil/api-systemmanager');
|
|
2494
|
+
* const api = new API();
|
|
2495
|
+
* const params = {
|
|
2496
|
+
* orgName: 'pinkbrain',
|
|
2497
|
+
* userId: '646386c9583e04a131adc894',
|
|
2498
|
+
* taskId: '646386c9583e04a131adc895'
|
|
2499
|
+
* };
|
|
2500
|
+
* const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
|
|
2501
|
+
* await api.user.task.mytasks.assignTaskUser(params, session);
|
|
2502
|
+
*/
|
|
2503
|
+
async assignTaskUsers(params, session) {
|
|
2504
|
+
const self = this;
|
|
2505
|
+
|
|
2506
|
+
try {
|
|
2507
|
+
Joi__default["default"].assert(params, Joi__default["default"].object().required());
|
|
2508
|
+
Joi__default["default"].assert(params.orgName, Joi__default["default"].string().required());
|
|
2509
|
+
Joi__default["default"].assert(params.userId, Joi__default["default"].string().required());
|
|
2510
|
+
Joi__default["default"].assert(params.taskId, Joi__default["default"].string().required());
|
|
2511
|
+
Joi__default["default"].assert(session, Joi__default["default"].string().required());
|
|
2512
|
+
|
|
2513
|
+
const {taskId, userId, orgName} = params;
|
|
2514
|
+
|
|
2515
|
+
const apiCall = self._client.put(`/organizations/${orgName}/users/tasks/${taskId}/assign/${userId}`, {}, self._setHeader(session));
|
|
2516
|
+
return self._returnData(await apiCall);
|
|
2517
|
+
} catch (ex) {
|
|
2518
|
+
throw ex;
|
|
2519
|
+
}
|
|
2520
|
+
}
|
|
2521
|
+
|
|
2522
|
+
/**
|
|
2523
|
+
* @author CloudBrasil <abernardo.br@gmail.com>
|
|
2524
|
+
* @description Unclaim task
|
|
2525
|
+
* @param {object} params The params to unclaim task
|
|
2526
|
+
* @param {string} params.orgName Organization Name
|
|
2527
|
+
* @param {string} params.taskId Task Id
|
|
2528
|
+
* @param {string} session Is token JWT of user
|
|
2529
|
+
* @return {Promise}
|
|
2530
|
+
* @public
|
|
2531
|
+
* @async
|
|
2532
|
+
* @example
|
|
2533
|
+
*
|
|
2534
|
+
* const API = require('@docbrasil/api-systemmanager');
|
|
2535
|
+
* const api = new API();
|
|
2536
|
+
* const params = {
|
|
2537
|
+
* orgName: 'pinkbrain',
|
|
2538
|
+
* taskId: '646386c9583e04a131adc895'
|
|
2539
|
+
* };
|
|
2540
|
+
* const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
|
|
2541
|
+
* await api.user.task.mytasks.unclaim(params, session);
|
|
2542
|
+
*/
|
|
2543
|
+
async unclaim(params, session) {
|
|
2544
|
+
const self = this;
|
|
2545
|
+
|
|
2546
|
+
try {
|
|
2547
|
+
Joi__default["default"].assert(params, Joi__default["default"].object().required());
|
|
2548
|
+
Joi__default["default"].assert(params.orgName, Joi__default["default"].string().required());
|
|
2549
|
+
Joi__default["default"].assert(params.taskId, Joi__default["default"].string().required());
|
|
2550
|
+
Joi__default["default"].assert(session, Joi__default["default"].string().required());
|
|
2551
|
+
|
|
2552
|
+
const {taskId, orgName} = params;
|
|
2553
|
+
|
|
2554
|
+
const apiCall = self._client.put(`/organizations/${orgName}/users/tasks/${taskId}/unclaim`, {}, self._setHeader(session));
|
|
2555
|
+
return self._returnData(await apiCall);
|
|
2556
|
+
} catch (ex) {
|
|
2557
|
+
throw ex;
|
|
2558
|
+
}
|
|
2559
|
+
}
|
|
2560
|
+
|
|
2561
|
+
/**
|
|
2562
|
+
* @author CloudBrasil <abernardo.br@gmail.com>
|
|
2563
|
+
* @description Escalate task
|
|
2564
|
+
* @param {object} params The params to escalate task
|
|
2565
|
+
* @param {string} params.orgName Organization Name
|
|
2566
|
+
* @param {string} params.taskId Task Id
|
|
2567
|
+
* @param {string} session Is token JWT of user
|
|
2568
|
+
* @return {Promise}
|
|
2569
|
+
* @public
|
|
2570
|
+
* @async
|
|
2571
|
+
* @example
|
|
2572
|
+
*
|
|
2573
|
+
* const API = require('@docbrasil/api-systemmanager');
|
|
2574
|
+
* const api = new API();
|
|
2575
|
+
* const params = {
|
|
2576
|
+
* orgName: 'pinkbrain',
|
|
2577
|
+
* taskId: '646386c9583e04a131adc895'
|
|
2578
|
+
* };
|
|
2579
|
+
* const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
|
|
2580
|
+
* await api.user.task.mytasks.escalate(params, session);
|
|
2581
|
+
*/
|
|
2582
|
+
async escalate(params, session) {
|
|
2583
|
+
const self = this;
|
|
2584
|
+
|
|
2585
|
+
try {
|
|
2586
|
+
Joi__default["default"].assert(params, Joi__default["default"].object().required());
|
|
2587
|
+
Joi__default["default"].assert(params.orgName, Joi__default["default"].string().required());
|
|
2588
|
+
Joi__default["default"].assert(params.taskId, Joi__default["default"].string().required());
|
|
2589
|
+
Joi__default["default"].assert(session, Joi__default["default"].string().required());
|
|
2590
|
+
|
|
2591
|
+
const {taskId, orgName} = params;
|
|
2592
|
+
|
|
2593
|
+
const apiCall = self._client.put(`/organizations/${orgName}/users/tasks/${taskId}/escalate`, {}, self._setHeader(session));
|
|
2594
|
+
return self._returnData(await apiCall);
|
|
2595
|
+
} catch (ex) {
|
|
2596
|
+
throw ex;
|
|
2597
|
+
}
|
|
2598
|
+
}
|
|
2440
2599
|
}
|
|
2441
2600
|
|
|
2442
2601
|
/**
|