@docbrasil/api-systemmanager 1.1.14 → 1.1.16
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/user/document.js +7 -5
- package/api/user/my_tasks.js +78 -0
- package/dist/bundle.cjs +85 -5
- package/dist/bundle.mjs +1 -1
- package/doc/api.md +1380 -521
- package/docs/Documents.html +9 -9
- package/docs/MyTasks.html +1252 -148
- package/docs/user_document.js.html +7 -5
- package/docs/user_my_tasks.js.html +161 -2
- package/package.json +1 -1
- package/.vscode/settings.json +0 -1
package/api/user/document.js
CHANGED
|
@@ -287,13 +287,14 @@ class Documents {
|
|
|
287
287
|
* const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
|
|
288
288
|
* await api.user.document.findById('5edf9f8ee896b817e45b8dad', session);
|
|
289
289
|
*/
|
|
290
|
-
async findById(
|
|
290
|
+
async findById(params, session) {
|
|
291
291
|
const self = this;
|
|
292
292
|
try {
|
|
293
|
-
Joi.assert(params._id, Joi.string().required().error(new Error('_id is required')));
|
|
294
293
|
Joi.assert(params, Joi.object().required().error(new Error('params is required')));
|
|
294
|
+
Joi.assert(params.id, Joi.string().required().error(new Error('id is required')));
|
|
295
|
+
Joi.assert(params.orgId, Joi.string().required().error(new Error('orgId is required')));
|
|
295
296
|
Joi.assert(session, Joi.string().required().error(new Error('session is required')));
|
|
296
|
-
const {
|
|
297
|
+
const {id, orgId} = params;
|
|
297
298
|
const apiCall = self._client
|
|
298
299
|
.get(`/organizations/${orgId}/documents/${id}/data/DOC`, params, self._setHeader(session));
|
|
299
300
|
|
|
@@ -416,7 +417,7 @@ class Documents {
|
|
|
416
417
|
* const api = new API();
|
|
417
418
|
* const params - {
|
|
418
419
|
* docId: '5dadd01dc4af3941d42f8c5c',
|
|
419
|
-
*
|
|
420
|
+
* orgId '5df7f19618430c89a41a19d2',
|
|
420
421
|
* };
|
|
421
422
|
* const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
|
|
422
423
|
* await api.user.document.findByIdAndRemove(params, session);
|
|
@@ -792,7 +793,8 @@ class Documents {
|
|
|
792
793
|
Joi.assert(session, Joi.string().required(), 'Session token JWT');
|
|
793
794
|
|
|
794
795
|
const {query, orgId} = params;
|
|
795
|
-
const
|
|
796
|
+
const params = new URLSearchParams(query);
|
|
797
|
+
const queryString = params.toString();
|
|
796
798
|
const apiCall = self._client.get(`/organizations/${orgId}/documents/search?${queryString}`, self._setHeader(session));
|
|
797
799
|
|
|
798
800
|
return self._returnData(await apiCall);
|
package/api/user/my_tasks.js
CHANGED
|
@@ -374,6 +374,84 @@ class MyTasks {
|
|
|
374
374
|
throw ex;
|
|
375
375
|
}
|
|
376
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
|
+
}
|
|
377
455
|
}
|
|
378
456
|
|
|
379
457
|
export default MyTasks;
|
package/dist/bundle.cjs
CHANGED
|
@@ -839,13 +839,14 @@ class Documents {
|
|
|
839
839
|
* const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
|
|
840
840
|
* await api.user.document.findById('5edf9f8ee896b817e45b8dad', session);
|
|
841
841
|
*/
|
|
842
|
-
async findById(
|
|
842
|
+
async findById(params, session) {
|
|
843
843
|
const self = this;
|
|
844
844
|
try {
|
|
845
|
-
Joi__default["default"].assert(params._id, Joi__default["default"].string().required().error(new Error('_id is required')));
|
|
846
845
|
Joi__default["default"].assert(params, Joi__default["default"].object().required().error(new Error('params is required')));
|
|
846
|
+
Joi__default["default"].assert(params.id, Joi__default["default"].string().required().error(new Error('id is required')));
|
|
847
|
+
Joi__default["default"].assert(params.orgId, Joi__default["default"].string().required().error(new Error('orgId is required')));
|
|
847
848
|
Joi__default["default"].assert(session, Joi__default["default"].string().required().error(new Error('session is required')));
|
|
848
|
-
const {
|
|
849
|
+
const {id, orgId} = params;
|
|
849
850
|
const apiCall = self._client
|
|
850
851
|
.get(`/organizations/${orgId}/documents/${id}/data/DOC`, params, self._setHeader(session));
|
|
851
852
|
|
|
@@ -968,7 +969,7 @@ class Documents {
|
|
|
968
969
|
* const api = new API();
|
|
969
970
|
* const params - {
|
|
970
971
|
* docId: '5dadd01dc4af3941d42f8c5c',
|
|
971
|
-
*
|
|
972
|
+
* orgId '5df7f19618430c89a41a19d2',
|
|
972
973
|
* };
|
|
973
974
|
* const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
|
|
974
975
|
* await api.user.document.findByIdAndRemove(params, session);
|
|
@@ -1344,7 +1345,8 @@ class Documents {
|
|
|
1344
1345
|
Joi__default["default"].assert(session, Joi__default["default"].string().required(), 'Session token JWT');
|
|
1345
1346
|
|
|
1346
1347
|
const {query, orgId} = params;
|
|
1347
|
-
const
|
|
1348
|
+
const params = new URLSearchParams(query);
|
|
1349
|
+
const queryString = params.toString();
|
|
1348
1350
|
const apiCall = self._client.get(`/organizations/${orgId}/documents/search?${queryString}`, self._setHeader(session));
|
|
1349
1351
|
|
|
1350
1352
|
return self._returnData(await apiCall);
|
|
@@ -2518,6 +2520,84 @@ class MyTasks {
|
|
|
2518
2520
|
throw ex;
|
|
2519
2521
|
}
|
|
2520
2522
|
}
|
|
2523
|
+
|
|
2524
|
+
/**
|
|
2525
|
+
* @author CloudBrasil <abernardo.br@gmail.com>
|
|
2526
|
+
* @description Unclaim task
|
|
2527
|
+
* @param {object} params The params to unclaim task
|
|
2528
|
+
* @param {string} params.orgName Organization Name
|
|
2529
|
+
* @param {string} params.taskId Task Id
|
|
2530
|
+
* @param {string} session Is token JWT of user
|
|
2531
|
+
* @return {Promise}
|
|
2532
|
+
* @public
|
|
2533
|
+
* @async
|
|
2534
|
+
* @example
|
|
2535
|
+
*
|
|
2536
|
+
* const API = require('@docbrasil/api-systemmanager');
|
|
2537
|
+
* const api = new API();
|
|
2538
|
+
* const params = {
|
|
2539
|
+
* orgName: 'pinkbrain',
|
|
2540
|
+
* taskId: '646386c9583e04a131adc895'
|
|
2541
|
+
* };
|
|
2542
|
+
* const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
|
|
2543
|
+
* await api.user.task.mytasks.unclaim(params, session);
|
|
2544
|
+
*/
|
|
2545
|
+
async unclaim(params, session) {
|
|
2546
|
+
const self = this;
|
|
2547
|
+
|
|
2548
|
+
try {
|
|
2549
|
+
Joi__default["default"].assert(params, Joi__default["default"].object().required());
|
|
2550
|
+
Joi__default["default"].assert(params.orgName, Joi__default["default"].string().required());
|
|
2551
|
+
Joi__default["default"].assert(params.taskId, Joi__default["default"].string().required());
|
|
2552
|
+
Joi__default["default"].assert(session, Joi__default["default"].string().required());
|
|
2553
|
+
|
|
2554
|
+
const {taskId, orgName} = params;
|
|
2555
|
+
|
|
2556
|
+
const apiCall = self._client.put(`/organizations/${orgName}/users/tasks/${taskId}/unclaim`, {}, self._setHeader(session));
|
|
2557
|
+
return self._returnData(await apiCall);
|
|
2558
|
+
} catch (ex) {
|
|
2559
|
+
throw ex;
|
|
2560
|
+
}
|
|
2561
|
+
}
|
|
2562
|
+
|
|
2563
|
+
/**
|
|
2564
|
+
* @author CloudBrasil <abernardo.br@gmail.com>
|
|
2565
|
+
* @description Escalate task
|
|
2566
|
+
* @param {object} params The params to escalate task
|
|
2567
|
+
* @param {string} params.orgName Organization Name
|
|
2568
|
+
* @param {string} params.taskId Task Id
|
|
2569
|
+
* @param {string} session Is token JWT of user
|
|
2570
|
+
* @return {Promise}
|
|
2571
|
+
* @public
|
|
2572
|
+
* @async
|
|
2573
|
+
* @example
|
|
2574
|
+
*
|
|
2575
|
+
* const API = require('@docbrasil/api-systemmanager');
|
|
2576
|
+
* const api = new API();
|
|
2577
|
+
* const params = {
|
|
2578
|
+
* orgName: 'pinkbrain',
|
|
2579
|
+
* taskId: '646386c9583e04a131adc895'
|
|
2580
|
+
* };
|
|
2581
|
+
* const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
|
|
2582
|
+
* await api.user.task.mytasks.escalate(params, session);
|
|
2583
|
+
*/
|
|
2584
|
+
async escalate(params, session) {
|
|
2585
|
+
const self = this;
|
|
2586
|
+
|
|
2587
|
+
try {
|
|
2588
|
+
Joi__default["default"].assert(params, Joi__default["default"].object().required());
|
|
2589
|
+
Joi__default["default"].assert(params.orgName, Joi__default["default"].string().required());
|
|
2590
|
+
Joi__default["default"].assert(params.taskId, Joi__default["default"].string().required());
|
|
2591
|
+
Joi__default["default"].assert(session, Joi__default["default"].string().required());
|
|
2592
|
+
|
|
2593
|
+
const {taskId, orgName} = params;
|
|
2594
|
+
|
|
2595
|
+
const apiCall = self._client.put(`/organizations/${orgName}/users/tasks/${taskId}/escalate`, {}, self._setHeader(session));
|
|
2596
|
+
return self._returnData(await apiCall);
|
|
2597
|
+
} catch (ex) {
|
|
2598
|
+
throw ex;
|
|
2599
|
+
}
|
|
2600
|
+
}
|
|
2521
2601
|
}
|
|
2522
2602
|
|
|
2523
2603
|
/**
|