@docbrasil/api-systemmanager 1.1.76 → 1.1.78

package/docs/admin_list.js.html

@@ -215,6 +215,220 @@ class AdminLists {
       throw ex;
     }
   }
+
+  /**
+   * @author Myndware <augusto.pissarra@myndware.com>
+   * @description Filter organization lists by name
+   * @param {object} params Parameters
+   * @param {string} params.orgId Organization ID (required)
+   * @param {array} [params.names=[]] Array of list names to filter (empty = all)
+   * @param {string} session JWT session token
+   * @return {Promise<array>} Array of matching org lists sorted by name
+   * @public
+   * @async
+   * @example
+   *
+   * const API = require('@docbrasil/api-systemmanager');
+   * const api = new API();
+   * const params = { orgId: '5edd11c46b6ce9729c2c297c', names: ['Tags', 'Categorias'] };
+   * const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
+   * const lists = await api.admin.list.filterByName(params, session);
+   */
+  async filterByName(params = {}, session) {
+    const self = this;
+
+    try {
+      Joi.assert(params, Joi.object().required());
+      Joi.assert(params.orgId, Joi.string().required());
+      Joi.assert(session, Joi.string().required());
+
+      const { orgId, names = [] } = params;
+      const payload = { names };
+
+      const apiCall = self._client.post(
+        `/admin/organizations/${orgId}/orgtags/filter`,
+        payload,
+        self._setHeader(session)
+      );
+
+      return self._returnData(await apiCall);
+    } catch (ex) {
+      throw ex;
+    }
+  }
+
+  /**
+   * @author Myndware <augusto.pissarra@myndware.com>
+   * @description Create a new organization list
+   * @param {object} params Parameters
+   * @param {string} params.orgId Organization ID (required)
+   * @param {string} params.name List name (required)
+   * @param {array} [params.list=[]] Initial list items
+   * @param {string} session JWT session token
+   * @return {Promise<object>} Created list document
+   * @public
+   * @async
+   * @example
+   *
+   * const API = require('@docbrasil/api-systemmanager');
+   * const api = new API();
+   * const params = { orgId: '5edd11c46b6ce9729c2c297c', name: 'My List', list: [] };
+   * const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
+   * const list = await api.admin.list.create(params, session);
+   */
+  async create(params = {}, session) {
+    const self = this;
+
+    try {
+      Joi.assert(params, Joi.object().required());
+      Joi.assert(params.orgId, Joi.string().required());
+      Joi.assert(params.name, Joi.string().required());
+      Joi.assert(session, Joi.string().required());
+
+      const { orgId, name, list = [] } = params;
+      const payload = { orgId, name, list };
+
+      const apiCall = self._client.put(
+        `/admin/organizations/${orgId}/orgtags`,
+        payload,
+        self._setHeader(session)
+      );
+
+      return self._returnData(await apiCall);
+    } catch (ex) {
+      throw ex;
+    }
+  }
+
+  /**
+   * @author Myndware <augusto.pissarra@myndware.com>
+   * @description Update an organization list
+   * @param {object} params Parameters
+   * @param {string} params.orgId Organization ID (required)
+   * @param {string} params.id List ID (required)
+   * @param {object} params.data Fields to update (name, list, etc.)
+   * @param {string} session JWT session token
+   * @return {Promise<object>} Updated list document
+   * @public
+   * @async
+   * @example
+   *
+   * const API = require('@docbrasil/api-systemmanager');
+   * const api = new API();
+   * const params = { orgId: '5edd11c46b6ce9729c2c297c', id: '55e4a3bd6be6b45210833fae', data: { name: 'Renamed' } };
+   * const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
+   * const list = await api.admin.list.update(params, session);
+   */
+  async update(params = {}, session) {
+    const self = this;
+
+    try {
+      Joi.assert(params, Joi.object().required());
+      Joi.assert(params.orgId, Joi.string().required());
+      Joi.assert(params.id, Joi.string().required());
+      Joi.assert(params.data, Joi.object().required());
+      Joi.assert(session, Joi.string().required());
+
+      const { orgId, id, data } = params;
+
+      const apiCall = self._client.put(
+        `/admin/organizations/${orgId}/orgtags/${id}`,
+        data,
+        self._setHeader(session)
+      );
+
+      return self._returnData(await apiCall);
+    } catch (ex) {
+      throw ex;
+    }
+  }
+
+  /**
+   * @author Myndware <augusto.pissarra@myndware.com>
+   * @description Remove an organization list
+   * @param {object} params Parameters
+   * @param {string} params.orgId Organization ID (required)
+   * @param {string} params.id List ID to remove (required)
+   * @param {string} session JWT session token
+   * @return {Promise<object>} Removal confirmation
+   * @public
+   * @async
+   * @example
+   *
+   * const API = require('@docbrasil/api-systemmanager');
+   * const api = new API();
+   * const params = { orgId: '5edd11c46b6ce9729c2c297c', id: '55e4a3bd6be6b45210833fae' };
+   * const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
+   * await api.admin.list.remove(params, session);
+   */
+  async remove(params = {}, session) {
+    const self = this;
+
+    try {
+      Joi.assert(params, Joi.object().required());
+      Joi.assert(params.orgId, Joi.string().required());
+      Joi.assert(params.id, Joi.string().required());
+      Joi.assert(session, Joi.string().required());
+
+      const { orgId, id } = params;
+
+      const apiCall = self._client.delete(
+        `/admin/organizations/${orgId}/orgtags/${id}`,
+        self._setHeader(session)
+      );
+
+      return self._returnData(await apiCall);
+    } catch (ex) {
+      throw ex;
+    }
+  }
+
+  /**
+   * @author Myndware <augusto.pissarra@myndware.com>
+   * @description Update list items of an organization list
+   * @param {object} params Parameters
+   * @param {string} params.orgId Organization ID (required)
+   * @param {string} params.id List ID (required)
+   * @param {array} params.list Updated list items array (required)
+   * @param {string} session JWT session token
+   * @return {Promise<object>} Updated list document
+   * @public
+   * @async
+   * @example
+   *
+   * const API = require('@docbrasil/api-systemmanager');
+   * const api = new API();
+   * const params = {
+   *   orgId: '5edd11c46b6ce9729c2c297c',
+   *   id: '55e4a3bd6be6b45210833fae',
+   *   list: [{ _id: '1', value: 'Item 1', filter: '', order: 0 }]
+   * };
+   * const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
+   * const list = await api.admin.list.updateListItems(params, session);
+   */
+  async updateListItems(params = {}, session) {
+    const self = this;
+
+    try {
+      Joi.assert(params, Joi.object().required());
+      Joi.assert(params.orgId, Joi.string().required());
+      Joi.assert(params.id, Joi.string().required());
+      Joi.assert(params.list, Joi.array().required());
+      Joi.assert(session, Joi.string().required());
+
+      const { orgId, id, list } = params;
+
+      const apiCall = self._client.put(
+        `/admin/organizations/${orgId}/orgtags/${id}`,
+        { list },
+        self._setHeader(session)
+      );
+
+      return self._returnData(await apiCall);
+    } catch (ex) {
+      throw ex;
+    }
+  }
 }
 
 export default AdminLists;

package/docs/admin_user.js.html

@@ -298,6 +298,83 @@ class AdminUser {
     }
   }
 
+  /**
+   * @author Myndware <augusto.pissarra@myndware.com>
+   * @description Create a new user
+   * @param {object} payload User data to create
+   * @param {string} payload.name Full name (required)
+   * @param {string} payload.username Username (required)
+   * @param {string} payload.email Email (required)
+   * @param {string} payload.orgId Primary organization ID (required)
+   * @param {array} [payload.orgIds] Organization IDs
+   * @param {array} [payload.role=[2]] Security roles
+   * @param {string} [payload.password] Initial password
+   * @param {string} session JWT session token
+   * @return {Promise<object>} Created user document
+   * @public
+   * @async
+   * @example
+   *
+   * const API = require('@docbrasil/api-systemmanager');
+   * const api = new API();
+   * const payload = {
+   *   name: 'Maria Silva',
+   *   username: 'maria.silva',
+   *   email: 'maria@example.com',
+   *   orgId: '5edd11c46b6ce9729c2c297c',
+   *   role: [2]
+   * };
+   * const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
+   * await api.admin.user.create(payload, session);
+   */
+  async create(payload, session) {
+    const self = this;
+
+    try {
+      Joi.assert(payload, Joi.object().required(), 'User data to create');
+      Joi.assert(payload.name, Joi.string().required(), 'Full name');
+      Joi.assert(payload.username, Joi.string().required(), 'Username');
+      Joi.assert(payload.email, Joi.string().email().required(), 'Email');
+      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));
+      return self._returnData(await apiCall);
+    } catch (ex) {
+      throw ex;
+    }
+  }
+
+  /**
+   * @author Myndware <augusto.pissarra@myndware.com>
+   * @description Remove a user
+   * @param {string} userId User ID to remove (required)
+   * @param {string} session JWT session token
+   * @return {Promise<object>} Removal confirmation
+   * @public
+   * @async
+   * @example
+   *
+   * const API = require('@docbrasil/api-systemmanager');
+   * const api = new API();
+   * const userId = '55e4a3bd6be6b45210833fae';
+   * const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
+   * await api.admin.user.remove(userId, session);
+   */
+  async remove(userId, session) {
+    const self = this;
+
+    try {
+      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));
+      return self._returnData(await apiCall);
+    } catch (ex) {
+      throw ex;
+    }
+  }
+
   /**
    * @description Request GUID to change the password
    * @param {string} email - User email
@@ -405,7 +482,7 @@ class AdminUser {
 
       const payloadToSend = {$project: project, sort};
 
-      const apiCall = self._client
+      const apiCall = self.client
           .post(`/admin/users?page=${page}&perPage=${perPage}`, payloadToSend, self._setHeader(session));
 
       return self._returnData(await apiCall);
@@ -414,6 +491,291 @@ class AdminUser {
       throw ex;
     }
   }
+
+  /**
+   * @author Myndware <augusto.pissarra@myndware.com>
+   * @description Block a user (prevent login)
+   * @param {string} userId User ID to block (required)
+   * @param {string} session JWT session token
+   * @return {Promise<object>} Updated user
+   * @public
+   * @async
+   * @example
+   *
+   * const API = require('@docbrasil/api-systemmanager');
+   * const api = new API();
+   * const userId = '55e4a3bd6be6b45210833fae';
+   * const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
+   * await api.admin.user.block(userId, session);
+   */
+  async block(userId, session) {
+    const self = this;
+
+    try {
+      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));
+      return self._returnData(await apiCall);
+    } catch (ex) {
+      throw ex;
+    }
+  }
+
+  /**
+   * @author Myndware <augusto.pissarra@myndware.com>
+   * @description Unblock a user (allow login)
+   * @param {string} userId User ID to unblock (required)
+   * @param {string} session JWT session token
+   * @return {Promise<object>} Updated user
+   * @public
+   * @async
+   * @example
+   *
+   * const API = require('@docbrasil/api-systemmanager');
+   * const api = new API();
+   * const userId = '55e4a3bd6be6b45210833fae';
+   * const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
+   * await api.admin.user.unblock(userId, session);
+   */
+  async unblock(userId, session) {
+    const self = this;
+
+    try {
+      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));
+      return self._returnData(await apiCall);
+    } catch (ex) {
+      throw ex;
+    }
+  }
+
+  /**
+   * @author Myndware <augusto.pissarra@myndware.com>
+   * @description Block email notifications for a user
+   * @param {string} userId User ID (required)
+   * @param {string} session JWT session token
+   * @return {Promise<object>} Updated user
+   * @public
+   * @async
+   */
+  async blockEmail(userId, session) {
+    const self = this;
+
+    try {
+      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));
+      return self._returnData(await apiCall);
+    } catch (ex) {
+      throw ex;
+    }
+  }
+
+  /**
+   * @author Myndware <augusto.pissarra@myndware.com>
+   * @description Unblock email notifications for a user
+   * @param {string} userId User ID (required)
+   * @param {string} session JWT session token
+   * @return {Promise<object>} Updated user
+   * @public
+   * @async
+   */
+  async unblockEmail(userId, session) {
+    const self = this;
+
+    try {
+      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));
+      return self._returnData(await apiCall);
+    } catch (ex) {
+      throw ex;
+    }
+  }
+
+  /**
+   * @author Myndware <augusto.pissarra@myndware.com>
+   * @description Update user type classification
+   * @param {object} params Parameters
+   * @param {string} params.userId User ID (required)
+   * @param {string} params.userType New user type (required)
+   * @param {string} session JWT session token
+   * @return {Promise<object>} Updated user
+   * @public
+   * @async
+   * @example
+   *
+   * const API = require('@docbrasil/api-systemmanager');
+   * const api = new API();
+   * const params = { userId: '55e4a3bd6be6b45210833fae', userType: 'USER' };
+   * const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
+   * await api.admin.user.updateUserType(params, session);
+   */
+  async updateUserType(params, session) {
+    const self = this;
+
+    try {
+      Joi.assert(params, Joi.object().required(), 'Parameters');
+      Joi.assert(params.userId, Joi.string().required(), 'User ID');
+      Joi.assert(params.userType, Joi.string().required(), 'User type');
+      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));
+      return self._returnData(await apiCall);
+    } catch (ex) {
+      throw ex;
+    }
+  }
+
+  /**
+   * @author Myndware <augusto.pissarra@myndware.com>
+   * @description Get organization groups with their permissions
+   * @param {string} orgId Organization ID (required)
+   * @param {string} session JWT session token
+   * @return {Promise<array>} Array of groups with permissions
+   * @public
+   * @async
+   * @example
+   *
+   * const API = require('@docbrasil/api-systemmanager');
+   * const api = new API();
+   * const orgId = '5edd11c46b6ce9729c2c297c';
+   * const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
+   * const groups = await api.admin.user.getGroupsPermissions(orgId, session);
+   */
+  async getGroupsPermissions(orgId, session) {
+    const self = this;
+
+    try {
+      Joi.assert(orgId, Joi.string().required(), 'Organization ID');
+      Joi.assert(session, Joi.string().required(), 'Session token');
+
+      const apiCall = self.client.get(
+        `/admin/organizations/${orgId}/orgchart/groups/permissions`,
+        self._setHeader(session)
+      );
+      return self._returnData(await apiCall);
+    } catch (ex) {
+      throw ex;
+    }
+  }
+
+  /**
+   * @author Myndware <augusto.pissarra@myndware.com>
+   * @description Update user's group memberships in an organization
+   * @param {object} params Parameters
+   * @param {string} params.orgId Organization ID (required)
+   * @param {string} params.userId User ID (required)
+   * @param {array} params.groups Array of group IDs (required)
+   * @param {string} session JWT session token
+   * @return {Promise<object>} Updated groups
+   * @public
+   * @async
+   * @example
+   *
+   * const API = require('@docbrasil/api-systemmanager');
+   * const api = new API();
+   * const params = {
+   *   orgId: '5edd11c46b6ce9729c2c297c',
+   *   userId: '55e4a3bd6be6b45210833fae',
+   *   groups: ['groupId1', 'groupId2']
+   * };
+   * const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
+   * await api.admin.user.updateUserGroups(params, session);
+   */
+  async updateUserGroups(params, session) {
+    const self = this;
+
+    try {
+      Joi.assert(params, Joi.object().required(), 'Parameters');
+      Joi.assert(params.orgId, Joi.string().required(), 'Organization ID');
+      Joi.assert(params.userId, Joi.string().required(), 'User ID');
+      Joi.assert(params.groups, Joi.array().required(), 'Group IDs');
+      Joi.assert(session, Joi.string().required(), 'Session token');
+
+      const { orgId, userId, groups } = params;
+      const apiCall = self.client.put(
+        `/admin/organizations/${orgId}/orgchart/groups/${userId}`,
+        { groups },
+        self._setHeader(session)
+      );
+      return self._returnData(await apiCall);
+    } catch (ex) {
+      throw ex;
+    }
+  }
+
+  /**
+   * @author Myndware <augusto.pissarra@myndware.com>
+   * @description Get organizations the admin user can manage
+   * @param {string} session JWT session token
+   * @return {Promise<array>} Array of organizations
+   * @public
+   * @async
+   * @example
+   *
+   * const API = require('@docbrasil/api-systemmanager');
+   * const api = new API();
+   * const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
+   * const orgs = await api.admin.user.getOrganizations(session);
+   */
+  async getOrganizations(session) {
+    const self = this;
+
+    try {
+      Joi.assert(session, Joi.string().required(), 'Session token');
+
+      const apiCall = self.client.get('/admin/users/organizations', self._setHeader(session));
+      return self._returnData(await apiCall);
+    } catch (ex) {
+      throw ex;
+    }
+  }
+
+  /**
+   * @author Myndware <augusto.pissarra@myndware.com>
+   * @description Get users belonging to an organization
+   * @param {object} params Parameters
+   * @param {string} params.orgId Organization ID (required)
+   * @param {array} [params.userIds] Optional array of user IDs to filter
+   * @param {string} session JWT session token
+   * @return {Promise<array>} Array of users with id, name, email, title
+   * @public
+   * @async
+   * @example
+   *
+   * const API = require('@docbrasil/api-systemmanager');
+   * const api = new API();
+   * const params = { orgId: '5edd11c46b6ce9729c2c297c' };
+   * const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
+   * const users = await api.admin.user.getOrgUsers(params, session);
+   */
+  async getOrgUsers(params, session) {
+    const self = this;
+
+    try {
+      Joi.assert(params, Joi.object().required(), 'Parameters');
+      Joi.assert(params.orgId, Joi.string().required(), 'Organization ID');
+      Joi.assert(session, Joi.string().required(), 'Session token');
+
+      const { orgId, userIds } = params;
+      let url = `/admin/organizations/${orgId}/orgusers`;
+      if (userIds && userIds.length > 0) {
+        url += `?userIds=${JSON.stringify(userIds)}`;
+      }
+
+      const apiCall = self.client.get(url, self._setHeader(session));
+      return self._returnData(await apiCall);
+    } catch (ex) {
+      throw ex;
+    }
+  }
 }
 
 export default AdminUser;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@docbrasil/api-systemmanager",
   "description": "Module API System Manager",
-  "version": "1.1.76",
+  "version": "1.1.78",
   "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",