@docbrasil/api-systemmanager 1.1.78 → 1.1.80

package/doc/api.md

@@ -1277,6 +1277,7 @@ Admin Class for user, permission admin
 **Kind**: global class  
 
 * [AdminUser](#AdminUser)
+    * [.setOrgId(orgId)](#AdminUser+setOrgId) ⇒ [<code>AdminUser</code>](#AdminUser)
     * [.findById(userId, session)](#AdminUser+findById) ⇒ <code>Promise</code>
     * [.findByIds(userIds, apiKey)](#AdminUser+findByIds) ⇒ <code>Promise</code>
     * [.findByIdAndUpdatePassword(params, session)](#AdminUser+findByIdAndUpdatePassword) ⇒ <code>Promise.&lt;unknown&gt;</code>
@@ -1297,6 +1298,19 @@ Admin Class for user, permission admin
     * [.getOrganizations(session)](#AdminUser+getOrganizations) ⇒ <code>Promise.&lt;array&gt;</code>
     * [.getOrgUsers(params, session)](#AdminUser+getOrgUsers) ⇒ <code>Promise.&lt;array&gt;</code>
 
+<a name="AdminUser+setOrgId"></a>
+
+### adminUser.setOrgId(orgId) ⇒ [<code>AdminUser</code>](#AdminUser)
+Set the organization ID for org-scoped API calls
+
+**Kind**: instance method of [<code>AdminUser</code>](#AdminUser)  
+**Returns**: [<code>AdminUser</code>](#AdminUser) - this instance for chaining  
+**Access**: public  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| orgId | <code>string</code> | Organization ID |
+
 <a name="AdminUser+findById"></a>
 
 ### adminUser.findById(userId, session) ⇒ <code>Promise</code>

package/docs/AdminUser.html

@@ -376,7 +376,7 @@
         <p class="tag-source">
             <a href="admin_user.js.html" class="button">View Source</a>
             <span>
-                <a href="admin_user.js.html">admin/user.js</a>, <a href="admin_user.js.html#line424">line 424</a>
+                <a href="admin_user.js.html">admin/user.js</a>, <a href="admin_user.js.html#line465">line 465</a>
             </span>
         </p>
     
@@ -596,7 +596,7 @@ await api.admin.user.block(userId, session);</code></pre>
         <p class="tag-source">
             <a href="admin_user.js.html" class="button">View Source</a>
             <span>
-                <a href="admin_user.js.html">admin/user.js</a>, <a href="admin_user.js.html#line477">line 477</a>
+                <a href="admin_user.js.html">admin/user.js</a>, <a href="admin_user.js.html#line518">line 518</a>
             </span>
         </p>
     
@@ -822,7 +822,7 @@ await api.admin.user.block(userId, session);</code></pre>
         <p class="tag-source">
             <a href="admin_user.js.html" class="button">View Source</a>
             <span>
-                <a href="admin_user.js.html">admin/user.js</a>, <a href="admin_user.js.html#line336">line 336</a>
+                <a href="admin_user.js.html">admin/user.js</a>, <a href="admin_user.js.html#line376">line 376</a>
             </span>
         </p>
     
@@ -1324,7 +1324,7 @@ const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';</code></pre>
         <p class="tag-source">
             <a href="admin_user.js.html" class="button">View Source</a>
             <span>
-                <a href="admin_user.js.html">admin/user.js</a>, <a href="admin_user.js.html#line243">line 243</a>
+                <a href="admin_user.js.html">admin/user.js</a>, <a href="admin_user.js.html#line283">line 283</a>
             </span>
         </p>
     
@@ -1550,7 +1550,7 @@ await api.admin.user.create(payload, session);</code></pre>
         <p class="tag-source">
             <a href="admin_user.js.html" class="button">View Source</a>
             <span>
-                <a href="admin_user.js.html">admin/user.js</a>, <a href="admin_user.js.html#line167">line 167</a>
+                <a href="admin_user.js.html">admin/user.js</a>, <a href="admin_user.js.html#line207">line 207</a>
             </span>
         </p>
     
@@ -1745,7 +1745,7 @@ await api.admin.user.emailExist(email, session);</code></pre>
         <p class="tag-source">
             <a href="admin_user.js.html" class="button">View Source</a>
             <span>
-                <a href="admin_user.js.html">admin/user.js</a>, <a href="admin_user.js.html#line66">line 66</a>
+                <a href="admin_user.js.html">admin/user.js</a>, <a href="admin_user.js.html#line106">line 106</a>
             </span>
         </p>
     
@@ -1981,7 +1981,7 @@ await api.admin.user.findById(userId, session);</code></pre>
         <p class="tag-source">
             <a href="admin_user.js.html" class="button">View Source</a>
             <span>
-                <a href="admin_user.js.html">admin/user.js</a>, <a href="admin_user.js.html#line199">line 199</a>
+                <a href="admin_user.js.html">admin/user.js</a>, <a href="admin_user.js.html#line239">line 239</a>
             </span>
         </p>
     
@@ -2272,7 +2272,7 @@ const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';</code></pre>
         <p class="tag-source">
             <a href="admin_user.js.html" class="button">View Source</a>
             <span>
-                <a href="admin_user.js.html">admin/user.js</a>, <a href="admin_user.js.html#line134">line 134</a>
+                <a href="admin_user.js.html">admin/user.js</a>, <a href="admin_user.js.html#line174">line 174</a>
             </span>
         </p>
     
@@ -2494,7 +2494,7 @@ await api.admin.user.findByIdAndUpdatePassword(params, session);</code></pre>
         <p class="tag-source">
             <a href="admin_user.js.html" class="button">View Source</a>
             <span>
-                <a href="admin_user.js.html">admin/user.js</a>, <a href="admin_user.js.html#line97">line 97</a>
+                <a href="admin_user.js.html">admin/user.js</a>, <a href="admin_user.js.html#line137">line 137</a>
             </span>
         </p>
     
@@ -2680,7 +2680,7 @@ await api.admin.user.findByIds(userIds, apiKey);</code></pre>
         <p class="tag-source">
             <a href="admin_user.js.html" class="button">View Source</a>
             <span>
-                <a href="admin_user.js.html">admin/user.js</a>, <a href="admin_user.js.html#line304">line 304</a>
+                <a href="admin_user.js.html">admin/user.js</a>, <a href="admin_user.js.html#line344">line 344</a>
             </span>
         </p>
     
@@ -2897,7 +2897,7 @@ const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';</code></pre>
         <p class="tag-source">
             <a href="admin_user.js.html" class="button">View Source</a>
             <span>
-                <a href="admin_user.js.html">admin/user.js</a>, <a href="admin_user.js.html#line565">line 565</a>
+                <a href="admin_user.js.html">admin/user.js</a>, <a href="admin_user.js.html#line606">line 606</a>
             </span>
         </p>
     
@@ -3202,7 +3202,7 @@ const groups = await api.admin.user.getGroupsPermissions(orgId, session);</code>
         <p class="tag-source">
             <a href="admin_user.js.html" class="button">View Source</a>
             <span>
-                <a href="admin_user.js.html">admin/user.js</a>, <a href="admin_user.js.html#line672">line 672</a>
+                <a href="admin_user.js.html">admin/user.js</a>, <a href="admin_user.js.html#line713">line 713</a>
             </span>
         </p>
     
@@ -3397,7 +3397,7 @@ const users = await api.admin.user.getOrgUsers(params, session);</code></pre>
         <p class="tag-source">
             <a href="admin_user.js.html" class="button">View Source</a>
             <span>
-                <a href="admin_user.js.html">admin/user.js</a>, <a href="admin_user.js.html#line641">line 641</a>
+                <a href="admin_user.js.html">admin/user.js</a>, <a href="admin_user.js.html#line682">line 682</a>
             </span>
         </p>
     
@@ -3745,7 +3745,7 @@ const orgs = await api.admin.user.getOrganizations(session);</code></pre>
         <p class="tag-source">
             <a href="admin_user.js.html" class="button">View Source</a>
             <span>
-                <a href="admin_user.js.html">admin/user.js</a>, <a href="admin_user.js.html#line375">line 375</a>
+                <a href="admin_user.js.html">admin/user.js</a>, <a href="admin_user.js.html#line415">line 415</a>
             </span>
         </p>
     
@@ -3965,7 +3965,7 @@ await api.user.form.getUserList(params, session);</code></pre>
         <p class="tag-source">
             <a href="admin_user.js.html" class="button">View Source</a>
             <span>
-                <a href="admin_user.js.html">admin/user.js</a>, <a href="admin_user.js.html#line277">line 277</a>
+                <a href="admin_user.js.html">admin/user.js</a>, <a href="admin_user.js.html#line317">line 317</a>
             </span>
         </p>
     
@@ -4027,6 +4027,179 @@ await api.admin.user.remove(userId, session);</code></pre>
     
 
 
+</div>
+            
+                <div class="member">
+
+
+    
+    <h4 class="name" id="setOrgId">
+        <a class="href-link" href="#setOrgId">#</a>
+        
+        <span class="code-name">
+            
+                setOrgId<span class="signature">(orgId)</span><span class="type-signature"> &rarr; {<a href="AdminUser.html">AdminUser</a>}</span>
+            
+        </span>
+    </h4>
+    
+
+    
+    
+    <div class="description">
+        Set the organization ID for org-scoped API calls
+    </div>
+    
+
+
+
+
+
+
+
+
+
+    <h5>Parameters:</h5>
+    
+<div class="table-container">
+    <table class="params table">
+        <thead>
+        <tr>
+            
+            <th>Name</th>
+            
+
+            <th>Type</th>
+
+            
+
+            
+
+            <th class="last">Description</th>
+        </tr>
+        </thead>
+
+        <tbody>
+        
+
+            
+<tr class="deep-level-0">
+  
+      <td class="name"><code>orgId</code></td>
+  
+
+  <td class="type">
+  
+      
+<code class="param-type">string</code>
+
+
+  
+  </td>
+
+  
+
+  
+
+  <td class="description last">Organization ID</td>
+</tr>
+
+
+        
+        </tbody>
+    </table>
+</div>
+
+
+
+
+
+<dl class="details">
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+    
+
+    
+
+    
+
+    
+        <p class="tag-source">
+            <a href="admin_user.js.html" class="button">View Source</a>
+            <span>
+                <a href="admin_user.js.html">admin/user.js</a>, <a href="admin_user.js.html#line27">line 27</a>
+            </span>
+        </p>
+    
+</dl>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+    <div class='columns method-parameter'>
+        <div class="column is-2"><label>Returns:</label></div>
+        <div class="column is-10">
+            
+                    
+
+<div class="columns">
+    
+    <div class='param-desc column is-7'>this instance for chaining</div>
+    
+    
+    <div class='column is-5 has-text-left'>
+        <label>Type: </label>
+        
+<code class="param-type"><a href="AdminUser.html">AdminUser</a></code>
+
+
+    </div>
+    
+</div>
+
+                
+        </div>
+    </div>
+
+
+
+
 </div>
             
                 <div class="member">
@@ -4185,7 +4358,7 @@ await api.admin.user.remove(userId, session);</code></pre>
         <p class="tag-source">
             <a href="admin_user.js.html" class="button">View Source</a>
             <span>
-                <a href="admin_user.js.html">admin/user.js</a>, <a href="admin_user.js.html#line454">line 454</a>
+                <a href="admin_user.js.html">admin/user.js</a>, <a href="admin_user.js.html#line495">line 495</a>
             </span>
         </p>
     
@@ -4405,7 +4578,7 @@ await api.admin.user.unblock(userId, session);</code></pre>
         <p class="tag-source">
             <a href="admin_user.js.html" class="button">View Source</a>
             <span>
-                <a href="admin_user.js.html">admin/user.js</a>, <a href="admin_user.js.html#line500">line 500</a>
+                <a href="admin_user.js.html">admin/user.js</a>, <a href="admin_user.js.html#line541">line 541</a>
             </span>
         </p>
     
@@ -4686,7 +4859,7 @@ await api.admin.user.unblock(userId, session);</code></pre>
         <p class="tag-source">
             <a href="admin_user.js.html" class="button">View Source</a>
             <span>
-                <a href="admin_user.js.html">admin/user.js</a>, <a href="admin_user.js.html#line605">line 605</a>
+                <a href="admin_user.js.html">admin/user.js</a>, <a href="admin_user.js.html#line646">line 646</a>
             </span>
         </p>
     
@@ -4959,7 +5132,7 @@ await api.admin.user.updateUserGroups(params, session);</code></pre>
         <p class="tag-source">
             <a href="admin_user.js.html" class="button">View Source</a>
             <span>
-                <a href="admin_user.js.html">admin/user.js</a>, <a href="admin_user.js.html#line532">line 532</a>
+                <a href="admin_user.js.html">admin/user.js</a>, <a href="admin_user.js.html#line573">line 573</a>
             </span>
         </p>
     

package/docs/admin_user.js.html

@@ -102,6 +102,46 @@ class AdminUser {
     const self = this;
     self.parent = options.parent;
     self.client = self.parent.dispatch.getClient();
+    self._orgId = null;
+  }
+
+  /**
+   * @description Set the organization ID for org-scoped API calls
+   * @param {string} orgId - Organization ID
+   * @return {AdminUser} this instance for chaining
+   * @public
+   */
+  setOrgId(orgId) {
+    this._orgId = orgId;
+    return this;
+  }
+
+  /**
+   * @description Get the base path for user admin API calls.
+   * When orgId is set, uses org-scoped endpoints.
+   * When orgId is not set, falls back to legacy admin endpoints.
+   * @return {string} base path
+   * @private
+   */
+  _basePath() {
+    if (this._orgId) {
+      return `/organizations/${this._orgId}/adminusers`;
+    }
+    return '/admin/users';
+  }
+
+  /**
+   * @description Get the base path for org-specific operations (groups, orgchart).
+   * When orgId is set, uses org-scoped endpoints.
+   * @param {string} orgId - Organization ID for the operation
+   * @return {string} base path
+   * @private
+   */
+  _orgPath(orgId) {
+    if (this._orgId) {
+      return `/organizations/${orgId}/adminusers`;
+    }
+    return `/admin/organizations/${orgId}`;
   }
 
   /**
@@ -158,7 +198,7 @@ class AdminUser {
       Joi.assert(userId, Joi.string().required());
       Joi.assert(session, Joi.string().required());
 
-      const apiCall = self.client.get(`/admin/users/${userId}`, self._setHeader(session));
+      const apiCall = self.client.get(`${self._basePath()}/${userId}`, self._setHeader(session));
       return self._returnData(await apiCall);
     } catch (ex) {
       throw ex;
@@ -229,7 +269,7 @@ class AdminUser {
       Joi.assert(session, Joi.string().required());
 
       const { userId, ...payload } = params;
-      const apiCall = self.client.put(`/admin/users/${userId}/password`, payload, self._setHeader(session));
+      const apiCall = self.client.put(`${self._basePath()}/${userId}/password`, payload, self._setHeader(session));
       return self._returnData(await apiCall);
     } catch (ex) {
       throw ex;
@@ -259,7 +299,7 @@ class AdminUser {
       Joi.assert(session, Joi.string().required());
 
       const payload = { email };
-      const apiCall = self.client.post(`/admin/users/email/exist`, payload, self._setHeader(session));
+      const apiCall = self.client.post(`${self._basePath()}/email/exist`, payload, self._setHeader(session));
       return self._returnData(await apiCall);
     } catch (ex) {
       throw ex;
@@ -291,7 +331,7 @@ class AdminUser {
       Joi.assert(payload, Joi.object().required(), 'Payload to update');
       Joi.assert(session, Joi.string().required(), 'Session user admin');
 
-      const apiCall = self.client.put(`/admin/users/${userId}`, payload, self._setHeader(session));
+      const apiCall = self.client.put(`${self._basePath()}/${userId}`, payload, self._setHeader(session));
       return self._returnData(await apiCall);
     } catch (ex) {
       throw ex;
@@ -338,7 +378,7 @@ class AdminUser {
       Joi.assert(payload.orgId, Joi.string().required(), 'Primary organization ID');
       Joi.assert(session, Joi.string().required(), 'Session token');
 
-      const apiCall = self.client.post('/admin/users', payload, self._setHeader(session));
+      const apiCall = self.client.put(self._basePath(), payload, self._setHeader(session));
       return self._returnData(await apiCall);
     } catch (ex) {
       throw ex;
@@ -368,7 +408,7 @@ class AdminUser {
       Joi.assert(userId, Joi.string().required(), 'User ID');
       Joi.assert(session, Joi.string().required(), 'Session token');
 
-      const apiCall = self.client.delete(`/admin/users/${userId}`, self._setHeader(session));
+      const apiCall = self.client.delete(`${self._basePath()}/${userId}`, self._setHeader(session));
       return self._returnData(await apiCall);
     } catch (ex) {
       throw ex;
@@ -396,7 +436,7 @@ class AdminUser {
       Joi.assert(session, Joi.string().required(), 'Session user admin');
 
       const payload = { email };
-      const apiCall = self.client.post('/admin/users/change/password', payload, self._setHeader(session));
+      const apiCall = self.client.post(`${self._basePath()}/change/password`, payload, self._setHeader(session));
 
       return self._returnData(await apiCall);
     } catch (ex) {
@@ -429,7 +469,7 @@ class AdminUser {
       Joi.assert(payload.newPassword, Joi.string().required(), 'New password');
       Joi.assert(session, Joi.string().required(), 'Session user admin');
 
-      const apiCall = self.client.put('/admin/users/change/password', payload, self._setHeader(session));
+      const apiCall = self.client.put(`${self._basePath()}/change/password`, payload, self._setHeader(session));
 
       return self._returnData(await apiCall);
     } catch (ex) {
@@ -477,13 +517,14 @@ class AdminUser {
         page = 1,
         perPage = 200,
         project = PROJECTION_DEFAULT,
-        sort = SORT_DEFAULT
+        sort = SORT_DEFAULT,
+        filter = {}
       } = params;
 
-      const payloadToSend = {$project: project, sort};
+      const payloadToSend = {$project: project, sort, ...filter};
 
       const apiCall = self.client
-          .post(`/admin/users?page=${page}&perPage=${perPage}`, payloadToSend, self._setHeader(session));
+          .post(`${self._basePath()}?page=${page}&perPage=${perPage}`, payloadToSend, self._setHeader(session));
 
       return self._returnData(await apiCall);
 
@@ -515,7 +556,7 @@ class AdminUser {
       Joi.assert(userId, Joi.string().required(), 'User ID');
       Joi.assert(session, Joi.string().required(), 'Session token');
 
-      const apiCall = self.client.put(`/admin/users/${userId}/block`, {}, self._setHeader(session));
+      const apiCall = self.client.put(`${self._basePath()}/${userId}/block`, {}, self._setHeader(session));
       return self._returnData(await apiCall);
     } catch (ex) {
       throw ex;
@@ -545,7 +586,7 @@ class AdminUser {
       Joi.assert(userId, Joi.string().required(), 'User ID');
       Joi.assert(session, Joi.string().required(), 'Session token');
 
-      const apiCall = self.client.put(`/admin/users/${userId}/unblock`, {}, self._setHeader(session));
+      const apiCall = self.client.put(`${self._basePath()}/${userId}/unblock`, {}, self._setHeader(session));
       return self._returnData(await apiCall);
     } catch (ex) {
       throw ex;
@@ -568,7 +609,7 @@ class AdminUser {
       Joi.assert(userId, Joi.string().required(), 'User ID');
       Joi.assert(session, Joi.string().required(), 'Session token');
 
-      const apiCall = self.client.put(`/admin/users/${userId}/blockemail`, {}, self._setHeader(session));
+      const apiCall = self.client.put(`${self._basePath()}/${userId}/blockemail`, {}, self._setHeader(session));
       return self._returnData(await apiCall);
     } catch (ex) {
       throw ex;
@@ -591,7 +632,7 @@ class AdminUser {
       Joi.assert(userId, Joi.string().required(), 'User ID');
       Joi.assert(session, Joi.string().required(), 'Session token');
 
-      const apiCall = self.client.put(`/admin/users/${userId}/unblockemail`, {}, self._setHeader(session));
+      const apiCall = self.client.put(`${self._basePath()}/${userId}/unblockemail`, {}, self._setHeader(session));
       return self._returnData(await apiCall);
     } catch (ex) {
       throw ex;
@@ -626,7 +667,7 @@ class AdminUser {
       Joi.assert(session, Joi.string().required(), 'Session token');
 
       const { userId, userType } = params;
-      const apiCall = self.client.put(`/admin/users/${userId}/type/${userType}`, {}, self._setHeader(session));
+      const apiCall = self.client.put(`${self._basePath()}/${userId}/type/${userType}`, {}, self._setHeader(session));
       return self._returnData(await apiCall);
     } catch (ex) {
       throw ex;
@@ -657,7 +698,7 @@ class AdminUser {
       Joi.assert(session, Joi.string().required(), 'Session token');
 
       const apiCall = self.client.get(
-        `/admin/organizations/${orgId}/orgchart/groups/permissions`,
+        `${self._orgPath(orgId)}/groups/permissions`,
         self._setHeader(session)
       );
       return self._returnData(await apiCall);
@@ -701,7 +742,7 @@ class AdminUser {
 
       const { orgId, userId, groups } = params;
       const apiCall = self.client.put(
-        `/admin/organizations/${orgId}/orgchart/groups/${userId}`,
+        `${self._orgPath(orgId)}/groups/${userId}`,
         { groups },
         self._setHeader(session)
       );
@@ -731,7 +772,7 @@ class AdminUser {
     try {
       Joi.assert(session, Joi.string().required(), 'Session token');
 
-      const apiCall = self.client.get('/admin/users/organizations', self._setHeader(session));
+      const apiCall = self.client.get(`${self._basePath()}/organizations`, self._setHeader(session));
       return self._returnData(await apiCall);
     } catch (ex) {
       throw ex;
@@ -765,7 +806,7 @@ class AdminUser {
       Joi.assert(session, Joi.string().required(), 'Session token');
 
       const { orgId, userIds } = params;
-      let url = `/admin/organizations/${orgId}/orgusers`;
+      let url = this._orgId ? `${self._orgPath(orgId)}/orgusers` : `/admin/organizations/${orgId}/orgusers`;
       if (userIds && userIds.length > 0) {
         url += `?userIds=${JSON.stringify(userIds)}`;
       }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@docbrasil/api-systemmanager",
   "description": "Module API System Manager",
-  "version": "1.1.78",
+  "version": "1.1.80",
   "scripts": {
     "htmldoc": "rm -rf docs && jsdoc api/** -d docs -t ./node_modules/better-docs",
     "doc": "rm -rf doc && mkdir doc && jsdoc2md api/**/* api/* > doc/api.md",