@docbrasil/api-systemmanager 1.1.77 → 1.1.78

package/dist/bundle.cjs

@@ -14612,6 +14612,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__default["default"].assert(payload, Joi__default["default"].object().required(), 'User data to create');
+      Joi__default["default"].assert(payload.name, Joi__default["default"].string().required(), 'Full name');
+      Joi__default["default"].assert(payload.username, Joi__default["default"].string().required(), 'Username');
+      Joi__default["default"].assert(payload.email, Joi__default["default"].string().email().required(), 'Email');
+      Joi__default["default"].assert(payload.orgId, Joi__default["default"].string().required(), 'Primary organization ID');
+      Joi__default["default"].assert(session, Joi__default["default"].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__default["default"].assert(userId, Joi__default["default"].string().required(), 'User ID');
+      Joi__default["default"].assert(session, Joi__default["default"].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
@@ -14719,7 +14796,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);
@@ -14728,6 +14805,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__default["default"].assert(userId, Joi__default["default"].string().required(), 'User ID');
+      Joi__default["default"].assert(session, Joi__default["default"].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__default["default"].assert(userId, Joi__default["default"].string().required(), 'User ID');
+      Joi__default["default"].assert(session, Joi__default["default"].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__default["default"].assert(userId, Joi__default["default"].string().required(), 'User ID');
+      Joi__default["default"].assert(session, Joi__default["default"].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__default["default"].assert(userId, Joi__default["default"].string().required(), 'User ID');
+      Joi__default["default"].assert(session, Joi__default["default"].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__default["default"].assert(params, Joi__default["default"].object().required(), 'Parameters');
+      Joi__default["default"].assert(params.userId, Joi__default["default"].string().required(), 'User ID');
+      Joi__default["default"].assert(params.userType, Joi__default["default"].string().required(), 'User type');
+      Joi__default["default"].assert(session, Joi__default["default"].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__default["default"].assert(orgId, Joi__default["default"].string().required(), 'Organization ID');
+      Joi__default["default"].assert(session, Joi__default["default"].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__default["default"].assert(params, Joi__default["default"].object().required(), 'Parameters');
+      Joi__default["default"].assert(params.orgId, Joi__default["default"].string().required(), 'Organization ID');
+      Joi__default["default"].assert(params.userId, Joi__default["default"].string().required(), 'User ID');
+      Joi__default["default"].assert(params.groups, Joi__default["default"].array().required(), 'Group IDs');
+      Joi__default["default"].assert(session, Joi__default["default"].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__default["default"].assert(session, Joi__default["default"].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__default["default"].assert(params, Joi__default["default"].object().required(), 'Parameters');
+      Joi__default["default"].assert(params.orgId, Joi__default["default"].string().required(), 'Organization ID');
+      Joi__default["default"].assert(session, Joi__default["default"].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;
+    }
+  }
 }
 
 /**