@docbrasil/api-systemmanager 1.1.65 → 1.1.67

package/api/user/document.js

@@ -271,6 +271,46 @@ class Documents {
     }
   }
 
+  /**
+   * @author Myndware <augusto.pissarra@myndware.com>
+   * @description Updates a document
+   * @param {array<string>} ids array of document _id
+   * @param {object} params Object for document payload to update. It has the orgId and areaId (required) and the fields to update.
+   *  Partial updates accepted, such as docTypeFieldsData.extraFieldName
+   * @param {string} params.orgId The orgId of the organization
+   * @param {string} params.areaId The areaId to update in batch
+   * @param {string} session Session, token JWT
+   * @return {Promise}
+   * @public
+   * @async
+   * @example
+   *
+   * const API = require('@docbrasil/api-systemmanager');
+   * const api = new API();
+   * const params = { orgId: '5edf9f8ee896b817e45b8da7', areaId: '5edf9f8ee896b817e45b8da8', 'docTypeFieldsData.extraName': 'New name' };
+   * const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
+   * await api.user.document.findByIdsAndUpdate(['5edf9f8ee896b817e45b8dad'], params, session);
+   */
+  async findByIdsAndUpdate(ids, params, session) {
+    const self = this;
+    try {
+      Joi.assert(ids, Joi.array().required().error(new Error('ids is required')));
+      Joi.assert(params, Joi.object().required().error(new Error('params is required')));
+      Joi.assert(params.orgId, Joi.string().required().error(new Error('orgId is required')));
+      Joi.assert(params.areaId, Joi.string().required().error(new Error('areaId is required')));
+      Joi.assert(session, Joi.string().required().error(new Error('session is required')));
+      const { areaId, orgId } = params;
+      delete params.areaId;
+      delete params.orgId;
+      const apiCall = self._client
+          .put(`/organizations/${orgId}/areas/${areaId}/documents/batch`, { ids, data: params }, self._setHeader(session));
+
+      return self._returnData(await apiCall);
+    } catch (ex) {
+      throw ex;
+    }
+  }
+
   /**
    * @author Myndware <augusto.pissarra@myndware.com>
    * @description Updates a document.

package/api/user/kanban.js

@@ -574,18 +574,20 @@ class Kanban {
   /**
    * @author Myndware <augusto.pissarra@myndware.com>
    * @description Starts a new task in the Kanban board for a specific organization process
+   * @description It will create the task, set the new order for all tasks (if you send them) and return the the task
+   * @description The new task is the full object of the task, like when you search the task
    * @param {Object} params - Parameters object
    * @param {string} params.orgId - Organization id (_id database)
    * @param {string} params.orgProcessName - The name of the organization process
    * @param {string} params.title - The title of the new task
    * @param {string} params.status - The status id of the new task
    * @param {Array} [params.tags] - Array of tag ids for the new task (optional)
-   * @param {Array} [params.tasks] - The task ids of each task inside the same status (optional)
+   * @param {Array} [params.tasks] - The task ids, in their current order, of each task inside the same status (optional)
    * @param {string} session - Session, token JWT
    * @returns {promise} Promise that resolves to operation status
    * @returns {Object} returns.data - The response data containing:
    * @returns {boolean} returns.data.success - Indicates if the operation was successful
-   * @returns {string} [returns.data.taskId] - The ID of the newly created task
+   * @returns {string} [returns.data.task] - The created task and its properties
    * @returns {string} [returns.data.error] - Error message if operation failed
    * @public
    * @example
@@ -606,7 +608,7 @@ class Kanban {
    * Expected response structure (success):
    * {
    *   success: true,
-   *   taskId: '507f1f77bcf86cd799439013'
+   *   task: { _id: '507f1f77bcf86cd799439013', ... }
    * }
    *
    * Expected response structure (error):

package/dist/bundle.cjs

@@ -925,6 +925,46 @@ class Documents {
     }
   }
 
+  /**
+   * @author Myndware <augusto.pissarra@myndware.com>
+   * @description Updates a document
+   * @param {array<string>} ids array of document _id
+   * @param {object} params Object for document payload to update. It has the orgId and areaId (required) and the fields to update.
+   *  Partial updates accepted, such as docTypeFieldsData.extraFieldName
+   * @param {string} params.orgId The orgId of the organization
+   * @param {string} params.areaId The areaId to update in batch
+   * @param {string} session Session, token JWT
+   * @return {Promise}
+   * @public
+   * @async
+   * @example
+   *
+   * const API = require('@docbrasil/api-systemmanager');
+   * const api = new API();
+   * const params = { orgId: '5edf9f8ee896b817e45b8da7', areaId: '5edf9f8ee896b817e45b8da8', 'docTypeFieldsData.extraName': 'New name' };
+   * const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
+   * await api.user.document.findByIdsAndUpdate(['5edf9f8ee896b817e45b8dad'], params, session);
+   */
+  async findByIdsAndUpdate(ids, params, session) {
+    const self = this;
+    try {
+      Joi__default["default"].assert(ids, Joi__default["default"].array().required().error(new Error('ids is required')));
+      Joi__default["default"].assert(params, Joi__default["default"].object().required().error(new Error('params is required')));
+      Joi__default["default"].assert(params.orgId, Joi__default["default"].string().required().error(new Error('orgId is required')));
+      Joi__default["default"].assert(params.areaId, Joi__default["default"].string().required().error(new Error('areaId is required')));
+      Joi__default["default"].assert(session, Joi__default["default"].string().required().error(new Error('session is required')));
+      const { areaId, orgId } = params;
+      delete params.areaId;
+      delete params.orgId;
+      const apiCall = self._client
+          .put(`/organizations/${orgId}/areas/${areaId}/documents/batch`, { ids, data: params }, self._setHeader(session));
+
+      return self._returnData(await apiCall);
+    } catch (ex) {
+      throw ex;
+    }
+  }
+
   /**
    * @author Myndware <augusto.pissarra@myndware.com>
    * @description Updates a document.
@@ -12347,18 +12387,20 @@ class Kanban {
   /**
    * @author Myndware <augusto.pissarra@myndware.com>
    * @description Starts a new task in the Kanban board for a specific organization process
+   * @description It will create the task, set the new order for all tasks (if you send them) and return the the task
+   * @description The new task is the full object of the task, like when you search the task
    * @param {Object} params - Parameters object
    * @param {string} params.orgId - Organization id (_id database)
    * @param {string} params.orgProcessName - The name of the organization process
    * @param {string} params.title - The title of the new task
    * @param {string} params.status - The status id of the new task
    * @param {Array} [params.tags] - Array of tag ids for the new task (optional)
-   * @param {Array} [params.tasks] - The task ids of each task inside the same status (optional)
+   * @param {Array} [params.tasks] - The task ids, in their current order, of each task inside the same status (optional)
    * @param {string} session - Session, token JWT
    * @returns {promise} Promise that resolves to operation status
    * @returns {Object} returns.data - The response data containing:
    * @returns {boolean} returns.data.success - Indicates if the operation was successful
-   * @returns {string} [returns.data.taskId] - The ID of the newly created task
+   * @returns {string} [returns.data.task] - The created task and its properties
    * @returns {string} [returns.data.error] - Error message if operation failed
    * @public
    * @example
@@ -12379,7 +12421,7 @@ class Kanban {
    * Expected response structure (success):
    * {
    *   success: true,
-   *   taskId: '507f1f77bcf86cd799439013'
+   *   task: { _id: '507f1f77bcf86cd799439013', ... }
    * }
    *
    * Expected response structure (error):