@docbrasil/api-systemmanager 1.1.78 → 1.1.79

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/admin/user.js +61 -20
  2. package/dist/bundle.cjs +61 -20
  3. package/dist/bundle.mjs +1 -1
  4. package/doc/api.md +14 -0
  5. package/docs/AdminUser.html +192 -19
  6. package/docs/admin_user.js.html +61 -20
  7. package/package.json +1 -1
package/api/admin/user.js CHANGED
@@ -15,6 +15,46 @@ class AdminUser {
15
15
  const self = this;
16
16
  self.parent = options.parent;
17
17
  self.client = self.parent.dispatch.getClient();
18
+ self._orgId = null;
19
+ }
20
+
21
+ /**
22
+ * @description Set the organization ID for org-scoped API calls
23
+ * @param {string} orgId - Organization ID
24
+ * @return {AdminUser} this instance for chaining
25
+ * @public
26
+ */
27
+ setOrgId(orgId) {
28
+ this._orgId = orgId;
29
+ return this;
30
+ }
31
+
32
+ /**
33
+ * @description Get the base path for user admin API calls.
34
+ * When orgId is set, uses org-scoped endpoints.
35
+ * When orgId is not set, falls back to legacy admin endpoints.
36
+ * @return {string} base path
37
+ * @private
38
+ */
39
+ _basePath() {
40
+ if (this._orgId) {
41
+ return `/api/organizations/${this._orgId}/adminusers`;
42
+ }
43
+ return '/admin/users';
44
+ }
45
+
46
+ /**
47
+ * @description Get the base path for org-specific operations (groups, orgchart).
48
+ * When orgId is set, uses org-scoped endpoints.
49
+ * @param {string} orgId - Organization ID for the operation
50
+ * @return {string} base path
51
+ * @private
52
+ */
53
+ _orgPath(orgId) {
54
+ if (this._orgId) {
55
+ return `/api/organizations/${orgId}/adminusers`;
56
+ }
57
+ return `/admin/organizations/${orgId}`;
18
58
  }
19
59
 
20
60
  /**
@@ -71,7 +111,7 @@ class AdminUser {
71
111
  Joi.assert(userId, Joi.string().required());
72
112
  Joi.assert(session, Joi.string().required());
73
113
 
74
- const apiCall = self.client.get(`/admin/users/${userId}`, self._setHeader(session));
114
+ const apiCall = self.client.get(`${self._basePath()}/${userId}`, self._setHeader(session));
75
115
  return self._returnData(await apiCall);
76
116
  } catch (ex) {
77
117
  throw ex;
@@ -142,7 +182,7 @@ class AdminUser {
142
182
  Joi.assert(session, Joi.string().required());
143
183
 
144
184
  const { userId, ...payload } = params;
145
- const apiCall = self.client.put(`/admin/users/${userId}/password`, payload, self._setHeader(session));
185
+ const apiCall = self.client.put(`${self._basePath()}/${userId}/password`, payload, self._setHeader(session));
146
186
  return self._returnData(await apiCall);
147
187
  } catch (ex) {
148
188
  throw ex;
@@ -172,7 +212,7 @@ class AdminUser {
172
212
  Joi.assert(session, Joi.string().required());
173
213
 
174
214
  const payload = { email };
175
- const apiCall = self.client.post(`/admin/users/email/exist`, payload, self._setHeader(session));
215
+ const apiCall = self.client.post(`${self._basePath()}/email/exist`, payload, self._setHeader(session));
176
216
  return self._returnData(await apiCall);
177
217
  } catch (ex) {
178
218
  throw ex;
@@ -204,7 +244,7 @@ class AdminUser {
204
244
  Joi.assert(payload, Joi.object().required(), 'Payload to update');
205
245
  Joi.assert(session, Joi.string().required(), 'Session user admin');
206
246
 
207
- const apiCall = self.client.put(`/admin/users/${userId}`, payload, self._setHeader(session));
247
+ const apiCall = self.client.put(`${self._basePath()}/${userId}`, payload, self._setHeader(session));
208
248
  return self._returnData(await apiCall);
209
249
  } catch (ex) {
210
250
  throw ex;
@@ -251,7 +291,7 @@ class AdminUser {
251
291
  Joi.assert(payload.orgId, Joi.string().required(), 'Primary organization ID');
252
292
  Joi.assert(session, Joi.string().required(), 'Session token');
253
293
 
254
- const apiCall = self.client.post('/admin/users', payload, self._setHeader(session));
294
+ const apiCall = self.client.put(self._basePath(), payload, self._setHeader(session));
255
295
  return self._returnData(await apiCall);
256
296
  } catch (ex) {
257
297
  throw ex;
@@ -281,7 +321,7 @@ class AdminUser {
281
321
  Joi.assert(userId, Joi.string().required(), 'User ID');
282
322
  Joi.assert(session, Joi.string().required(), 'Session token');
283
323
 
284
- const apiCall = self.client.delete(`/admin/users/${userId}`, self._setHeader(session));
324
+ const apiCall = self.client.delete(`${self._basePath()}/${userId}`, self._setHeader(session));
285
325
  return self._returnData(await apiCall);
286
326
  } catch (ex) {
287
327
  throw ex;
@@ -309,7 +349,7 @@ class AdminUser {
309
349
  Joi.assert(session, Joi.string().required(), 'Session user admin');
310
350
 
311
351
  const payload = { email };
312
- const apiCall = self.client.post('/admin/users/change/password', payload, self._setHeader(session));
352
+ const apiCall = self.client.post(`${self._basePath()}/change/password`, payload, self._setHeader(session));
313
353
 
314
354
  return self._returnData(await apiCall);
315
355
  } catch (ex) {
@@ -342,7 +382,7 @@ class AdminUser {
342
382
  Joi.assert(payload.newPassword, Joi.string().required(), 'New password');
343
383
  Joi.assert(session, Joi.string().required(), 'Session user admin');
344
384
 
345
- const apiCall = self.client.put('/admin/users/change/password', payload, self._setHeader(session));
385
+ const apiCall = self.client.put(`${self._basePath()}/change/password`, payload, self._setHeader(session));
346
386
 
347
387
  return self._returnData(await apiCall);
348
388
  } catch (ex) {
@@ -390,13 +430,14 @@ class AdminUser {
390
430
  page = 1,
391
431
  perPage = 200,
392
432
  project = PROJECTION_DEFAULT,
393
- sort = SORT_DEFAULT
433
+ sort = SORT_DEFAULT,
434
+ filter = {}
394
435
  } = params;
395
436
 
396
- const payloadToSend = {$project: project, sort};
437
+ const payloadToSend = {$project: project, sort, ...filter};
397
438
 
398
439
  const apiCall = self.client
399
- .post(`/admin/users?page=${page}&perPage=${perPage}`, payloadToSend, self._setHeader(session));
440
+ .post(`${self._basePath()}?page=${page}&perPage=${perPage}`, payloadToSend, self._setHeader(session));
400
441
 
401
442
  return self._returnData(await apiCall);
402
443
 
@@ -428,7 +469,7 @@ class AdminUser {
428
469
  Joi.assert(userId, Joi.string().required(), 'User ID');
429
470
  Joi.assert(session, Joi.string().required(), 'Session token');
430
471
 
431
- const apiCall = self.client.put(`/admin/users/${userId}/block`, {}, self._setHeader(session));
472
+ const apiCall = self.client.put(`${self._basePath()}/${userId}/block`, {}, self._setHeader(session));
432
473
  return self._returnData(await apiCall);
433
474
  } catch (ex) {
434
475
  throw ex;
@@ -458,7 +499,7 @@ class AdminUser {
458
499
  Joi.assert(userId, Joi.string().required(), 'User ID');
459
500
  Joi.assert(session, Joi.string().required(), 'Session token');
460
501
 
461
- const apiCall = self.client.put(`/admin/users/${userId}/unblock`, {}, self._setHeader(session));
502
+ const apiCall = self.client.put(`${self._basePath()}/${userId}/unblock`, {}, self._setHeader(session));
462
503
  return self._returnData(await apiCall);
463
504
  } catch (ex) {
464
505
  throw ex;
@@ -481,7 +522,7 @@ class AdminUser {
481
522
  Joi.assert(userId, Joi.string().required(), 'User ID');
482
523
  Joi.assert(session, Joi.string().required(), 'Session token');
483
524
 
484
- const apiCall = self.client.put(`/admin/users/${userId}/blockemail`, {}, self._setHeader(session));
525
+ const apiCall = self.client.put(`${self._basePath()}/${userId}/blockemail`, {}, self._setHeader(session));
485
526
  return self._returnData(await apiCall);
486
527
  } catch (ex) {
487
528
  throw ex;
@@ -504,7 +545,7 @@ class AdminUser {
504
545
  Joi.assert(userId, Joi.string().required(), 'User ID');
505
546
  Joi.assert(session, Joi.string().required(), 'Session token');
506
547
 
507
- const apiCall = self.client.put(`/admin/users/${userId}/unblockemail`, {}, self._setHeader(session));
548
+ const apiCall = self.client.put(`${self._basePath()}/${userId}/unblockemail`, {}, self._setHeader(session));
508
549
  return self._returnData(await apiCall);
509
550
  } catch (ex) {
510
551
  throw ex;
@@ -539,7 +580,7 @@ class AdminUser {
539
580
  Joi.assert(session, Joi.string().required(), 'Session token');
540
581
 
541
582
  const { userId, userType } = params;
542
- const apiCall = self.client.put(`/admin/users/${userId}/type/${userType}`, {}, self._setHeader(session));
583
+ const apiCall = self.client.put(`${self._basePath()}/${userId}/type/${userType}`, {}, self._setHeader(session));
543
584
  return self._returnData(await apiCall);
544
585
  } catch (ex) {
545
586
  throw ex;
@@ -570,7 +611,7 @@ class AdminUser {
570
611
  Joi.assert(session, Joi.string().required(), 'Session token');
571
612
 
572
613
  const apiCall = self.client.get(
573
- `/admin/organizations/${orgId}/orgchart/groups/permissions`,
614
+ `${self._orgPath(orgId)}/groups/permissions`,
574
615
  self._setHeader(session)
575
616
  );
576
617
  return self._returnData(await apiCall);
@@ -614,7 +655,7 @@ class AdminUser {
614
655
 
615
656
  const { orgId, userId, groups } = params;
616
657
  const apiCall = self.client.put(
617
- `/admin/organizations/${orgId}/orgchart/groups/${userId}`,
658
+ `${self._orgPath(orgId)}/groups/${userId}`,
618
659
  { groups },
619
660
  self._setHeader(session)
620
661
  );
@@ -644,7 +685,7 @@ class AdminUser {
644
685
  try {
645
686
  Joi.assert(session, Joi.string().required(), 'Session token');
646
687
 
647
- const apiCall = self.client.get('/admin/users/organizations', self._setHeader(session));
688
+ const apiCall = self.client.get(`${self._basePath()}/organizations`, self._setHeader(session));
648
689
  return self._returnData(await apiCall);
649
690
  } catch (ex) {
650
691
  throw ex;
@@ -678,7 +719,7 @@ class AdminUser {
678
719
  Joi.assert(session, Joi.string().required(), 'Session token');
679
720
 
680
721
  const { orgId, userIds } = params;
681
- let url = `/admin/organizations/${orgId}/orgusers`;
722
+ let url = this._orgId ? `${self._orgPath(orgId)}/orgusers` : `/admin/organizations/${orgId}/orgusers`;
682
723
  if (userIds && userIds.length > 0) {
683
724
  url += `?userIds=${JSON.stringify(userIds)}`;
684
725
  }
package/dist/bundle.cjs CHANGED
@@ -14416,6 +14416,46 @@ class AdminUser {
14416
14416
  const self = this;
14417
14417
  self.parent = options.parent;
14418
14418
  self.client = self.parent.dispatch.getClient();
14419
+ self._orgId = null;
14420
+ }
14421
+
14422
+ /**
14423
+ * @description Set the organization ID for org-scoped API calls
14424
+ * @param {string} orgId - Organization ID
14425
+ * @return {AdminUser} this instance for chaining
14426
+ * @public
14427
+ */
14428
+ setOrgId(orgId) {
14429
+ this._orgId = orgId;
14430
+ return this;
14431
+ }
14432
+
14433
+ /**
14434
+ * @description Get the base path for user admin API calls.
14435
+ * When orgId is set, uses org-scoped endpoints.
14436
+ * When orgId is not set, falls back to legacy admin endpoints.
14437
+ * @return {string} base path
14438
+ * @private
14439
+ */
14440
+ _basePath() {
14441
+ if (this._orgId) {
14442
+ return `/api/organizations/${this._orgId}/adminusers`;
14443
+ }
14444
+ return '/admin/users';
14445
+ }
14446
+
14447
+ /**
14448
+ * @description Get the base path for org-specific operations (groups, orgchart).
14449
+ * When orgId is set, uses org-scoped endpoints.
14450
+ * @param {string} orgId - Organization ID for the operation
14451
+ * @return {string} base path
14452
+ * @private
14453
+ */
14454
+ _orgPath(orgId) {
14455
+ if (this._orgId) {
14456
+ return `/api/organizations/${orgId}/adminusers`;
14457
+ }
14458
+ return `/admin/organizations/${orgId}`;
14419
14459
  }
14420
14460
 
14421
14461
  /**
@@ -14472,7 +14512,7 @@ class AdminUser {
14472
14512
  Joi__default["default"].assert(userId, Joi__default["default"].string().required());
14473
14513
  Joi__default["default"].assert(session, Joi__default["default"].string().required());
14474
14514
 
14475
- const apiCall = self.client.get(`/admin/users/${userId}`, self._setHeader(session));
14515
+ const apiCall = self.client.get(`${self._basePath()}/${userId}`, self._setHeader(session));
14476
14516
  return self._returnData(await apiCall);
14477
14517
  } catch (ex) {
14478
14518
  throw ex;
@@ -14543,7 +14583,7 @@ class AdminUser {
14543
14583
  Joi__default["default"].assert(session, Joi__default["default"].string().required());
14544
14584
 
14545
14585
  const { userId, ...payload } = params;
14546
- const apiCall = self.client.put(`/admin/users/${userId}/password`, payload, self._setHeader(session));
14586
+ const apiCall = self.client.put(`${self._basePath()}/${userId}/password`, payload, self._setHeader(session));
14547
14587
  return self._returnData(await apiCall);
14548
14588
  } catch (ex) {
14549
14589
  throw ex;
@@ -14573,7 +14613,7 @@ class AdminUser {
14573
14613
  Joi__default["default"].assert(session, Joi__default["default"].string().required());
14574
14614
 
14575
14615
  const payload = { email };
14576
- const apiCall = self.client.post(`/admin/users/email/exist`, payload, self._setHeader(session));
14616
+ const apiCall = self.client.post(`${self._basePath()}/email/exist`, payload, self._setHeader(session));
14577
14617
  return self._returnData(await apiCall);
14578
14618
  } catch (ex) {
14579
14619
  throw ex;
@@ -14605,7 +14645,7 @@ class AdminUser {
14605
14645
  Joi__default["default"].assert(payload, Joi__default["default"].object().required(), 'Payload to update');
14606
14646
  Joi__default["default"].assert(session, Joi__default["default"].string().required(), 'Session user admin');
14607
14647
 
14608
- const apiCall = self.client.put(`/admin/users/${userId}`, payload, self._setHeader(session));
14648
+ const apiCall = self.client.put(`${self._basePath()}/${userId}`, payload, self._setHeader(session));
14609
14649
  return self._returnData(await apiCall);
14610
14650
  } catch (ex) {
14611
14651
  throw ex;
@@ -14652,7 +14692,7 @@ class AdminUser {
14652
14692
  Joi__default["default"].assert(payload.orgId, Joi__default["default"].string().required(), 'Primary organization ID');
14653
14693
  Joi__default["default"].assert(session, Joi__default["default"].string().required(), 'Session token');
14654
14694
 
14655
- const apiCall = self.client.post('/admin/users', payload, self._setHeader(session));
14695
+ const apiCall = self.client.put(self._basePath(), payload, self._setHeader(session));
14656
14696
  return self._returnData(await apiCall);
14657
14697
  } catch (ex) {
14658
14698
  throw ex;
@@ -14682,7 +14722,7 @@ class AdminUser {
14682
14722
  Joi__default["default"].assert(userId, Joi__default["default"].string().required(), 'User ID');
14683
14723
  Joi__default["default"].assert(session, Joi__default["default"].string().required(), 'Session token');
14684
14724
 
14685
- const apiCall = self.client.delete(`/admin/users/${userId}`, self._setHeader(session));
14725
+ const apiCall = self.client.delete(`${self._basePath()}/${userId}`, self._setHeader(session));
14686
14726
  return self._returnData(await apiCall);
14687
14727
  } catch (ex) {
14688
14728
  throw ex;
@@ -14710,7 +14750,7 @@ class AdminUser {
14710
14750
  Joi__default["default"].assert(session, Joi__default["default"].string().required(), 'Session user admin');
14711
14751
 
14712
14752
  const payload = { email };
14713
- const apiCall = self.client.post('/admin/users/change/password', payload, self._setHeader(session));
14753
+ const apiCall = self.client.post(`${self._basePath()}/change/password`, payload, self._setHeader(session));
14714
14754
 
14715
14755
  return self._returnData(await apiCall);
14716
14756
  } catch (ex) {
@@ -14743,7 +14783,7 @@ class AdminUser {
14743
14783
  Joi__default["default"].assert(payload.newPassword, Joi__default["default"].string().required(), 'New password');
14744
14784
  Joi__default["default"].assert(session, Joi__default["default"].string().required(), 'Session user admin');
14745
14785
 
14746
- const apiCall = self.client.put('/admin/users/change/password', payload, self._setHeader(session));
14786
+ const apiCall = self.client.put(`${self._basePath()}/change/password`, payload, self._setHeader(session));
14747
14787
 
14748
14788
  return self._returnData(await apiCall);
14749
14789
  } catch (ex) {
@@ -14791,13 +14831,14 @@ class AdminUser {
14791
14831
  page = 1,
14792
14832
  perPage = 200,
14793
14833
  project = PROJECTION_DEFAULT,
14794
- sort = SORT_DEFAULT
14834
+ sort = SORT_DEFAULT,
14835
+ filter = {}
14795
14836
  } = params;
14796
14837
 
14797
- const payloadToSend = {$project: project, sort};
14838
+ const payloadToSend = {$project: project, sort, ...filter};
14798
14839
 
14799
14840
  const apiCall = self.client
14800
- .post(`/admin/users?page=${page}&perPage=${perPage}`, payloadToSend, self._setHeader(session));
14841
+ .post(`${self._basePath()}?page=${page}&perPage=${perPage}`, payloadToSend, self._setHeader(session));
14801
14842
 
14802
14843
  return self._returnData(await apiCall);
14803
14844
 
@@ -14829,7 +14870,7 @@ class AdminUser {
14829
14870
  Joi__default["default"].assert(userId, Joi__default["default"].string().required(), 'User ID');
14830
14871
  Joi__default["default"].assert(session, Joi__default["default"].string().required(), 'Session token');
14831
14872
 
14832
- const apiCall = self.client.put(`/admin/users/${userId}/block`, {}, self._setHeader(session));
14873
+ const apiCall = self.client.put(`${self._basePath()}/${userId}/block`, {}, self._setHeader(session));
14833
14874
  return self._returnData(await apiCall);
14834
14875
  } catch (ex) {
14835
14876
  throw ex;
@@ -14859,7 +14900,7 @@ class AdminUser {
14859
14900
  Joi__default["default"].assert(userId, Joi__default["default"].string().required(), 'User ID');
14860
14901
  Joi__default["default"].assert(session, Joi__default["default"].string().required(), 'Session token');
14861
14902
 
14862
- const apiCall = self.client.put(`/admin/users/${userId}/unblock`, {}, self._setHeader(session));
14903
+ const apiCall = self.client.put(`${self._basePath()}/${userId}/unblock`, {}, self._setHeader(session));
14863
14904
  return self._returnData(await apiCall);
14864
14905
  } catch (ex) {
14865
14906
  throw ex;
@@ -14882,7 +14923,7 @@ class AdminUser {
14882
14923
  Joi__default["default"].assert(userId, Joi__default["default"].string().required(), 'User ID');
14883
14924
  Joi__default["default"].assert(session, Joi__default["default"].string().required(), 'Session token');
14884
14925
 
14885
- const apiCall = self.client.put(`/admin/users/${userId}/blockemail`, {}, self._setHeader(session));
14926
+ const apiCall = self.client.put(`${self._basePath()}/${userId}/blockemail`, {}, self._setHeader(session));
14886
14927
  return self._returnData(await apiCall);
14887
14928
  } catch (ex) {
14888
14929
  throw ex;
@@ -14905,7 +14946,7 @@ class AdminUser {
14905
14946
  Joi__default["default"].assert(userId, Joi__default["default"].string().required(), 'User ID');
14906
14947
  Joi__default["default"].assert(session, Joi__default["default"].string().required(), 'Session token');
14907
14948
 
14908
- const apiCall = self.client.put(`/admin/users/${userId}/unblockemail`, {}, self._setHeader(session));
14949
+ const apiCall = self.client.put(`${self._basePath()}/${userId}/unblockemail`, {}, self._setHeader(session));
14909
14950
  return self._returnData(await apiCall);
14910
14951
  } catch (ex) {
14911
14952
  throw ex;
@@ -14940,7 +14981,7 @@ class AdminUser {
14940
14981
  Joi__default["default"].assert(session, Joi__default["default"].string().required(), 'Session token');
14941
14982
 
14942
14983
  const { userId, userType } = params;
14943
- const apiCall = self.client.put(`/admin/users/${userId}/type/${userType}`, {}, self._setHeader(session));
14984
+ const apiCall = self.client.put(`${self._basePath()}/${userId}/type/${userType}`, {}, self._setHeader(session));
14944
14985
  return self._returnData(await apiCall);
14945
14986
  } catch (ex) {
14946
14987
  throw ex;
@@ -14971,7 +15012,7 @@ class AdminUser {
14971
15012
  Joi__default["default"].assert(session, Joi__default["default"].string().required(), 'Session token');
14972
15013
 
14973
15014
  const apiCall = self.client.get(
14974
- `/admin/organizations/${orgId}/orgchart/groups/permissions`,
15015
+ `${self._orgPath(orgId)}/groups/permissions`,
14975
15016
  self._setHeader(session)
14976
15017
  );
14977
15018
  return self._returnData(await apiCall);
@@ -15015,7 +15056,7 @@ class AdminUser {
15015
15056
 
15016
15057
  const { orgId, userId, groups } = params;
15017
15058
  const apiCall = self.client.put(
15018
- `/admin/organizations/${orgId}/orgchart/groups/${userId}`,
15059
+ `${self._orgPath(orgId)}/groups/${userId}`,
15019
15060
  { groups },
15020
15061
  self._setHeader(session)
15021
15062
  );
@@ -15045,7 +15086,7 @@ class AdminUser {
15045
15086
  try {
15046
15087
  Joi__default["default"].assert(session, Joi__default["default"].string().required(), 'Session token');
15047
15088
 
15048
- const apiCall = self.client.get('/admin/users/organizations', self._setHeader(session));
15089
+ const apiCall = self.client.get(`${self._basePath()}/organizations`, self._setHeader(session));
15049
15090
  return self._returnData(await apiCall);
15050
15091
  } catch (ex) {
15051
15092
  throw ex;
@@ -15079,7 +15120,7 @@ class AdminUser {
15079
15120
  Joi__default["default"].assert(session, Joi__default["default"].string().required(), 'Session token');
15080
15121
 
15081
15122
  const { orgId, userIds } = params;
15082
- let url = `/admin/organizations/${orgId}/orgusers`;
15123
+ let url = this._orgId ? `${self._orgPath(orgId)}/orgusers` : `/admin/organizations/${orgId}/orgusers`;
15083
15124
  if (userIds && userIds.length > 0) {
15084
15125
  url += `?userIds=${JSON.stringify(userIds)}`;
15085
15126
  }