@docbrasil/api-systemmanager 1.1.66 → 1.1.68

package/api/admin/document.js

@@ -183,7 +183,6 @@ class AdminDocuments {
    * const { signedUrl, imageType } = await api.admin.document.signedUrl(params, apiKey);
    */
   async signedUrl(params = {}, apiKey) {
-
     Joi.assert(params, Joi.object().required());
     Joi.assert(params.methodType, Joi.string().required());
     Joi.assert(params.docId, Joi.string().required());
@@ -221,7 +220,6 @@ class AdminDocuments {
    * await api.admin.document.updateContent(params, apiKey);
    */
   async updateContent(params = {}, apiKey) {
-
     Joi.assert(params, Joi.object().required());
     Joi.assert(params.content, Joi.string().required());
     Joi.assert(params.docId, Joi.string().required());
@@ -268,7 +266,6 @@ class AdminDocuments {
    * await api.admin.document.updateContent(params, apiKey);
    */
   async updateAI(params = {}, apiKey) {
-
     Joi.assert(params, Joi.object().required());
     Joi.assert(params.docId, Joi.string().required());
     Joi.assert(apiKey, Joi.string().required());
@@ -313,7 +310,6 @@ class AdminDocuments {
    * await api.admin.document.getContent(params, apiKey);
    */
   async getContent(params = {}, apiKey) {
-
     Joi.assert(params, Joi.object().required());
     Joi.assert(params.docId, Joi.string().required());
     Joi.assert(params.page, Joi.string().required());
@@ -327,6 +323,39 @@ class AdminDocuments {
     return self._returnData(await apiCall);
   }
 
+  /**
+   *
+   * @author Myndware <augusto.pissarra@myndware.com>
+   * @description Get the data of a document
+   * @param {object} params Params to request signed url
+   * @param {string} params.id The unique id of the document
+   * @param {string} apiKey Api Key as permission to use this functionality
+   * @return {Promise<object>} data the document data
+   * @public
+   * @async
+   * @example
+   *
+   * const API = require('@docbrasil/api-systemmanager');
+   * const api = new API();
+   * const params - {
+   *  id: '5dadd01dc4af3941d42f8c5c'
+   * };
+   * const apiKey: '...';
+   * await api.admin.document.getDocumentData(params, apiKey);
+   */
+  async getDocumentData(params = {}, apiKey) {
+    Joi.assert(params, Joi.object().required());
+    Joi.assert(params.id, Joi.string().required());
+    Joi.assert(apiKey, Joi.string().required());
+
+    const self = this;
+    const { id } = params;
+    const url = `/api/documents/${id}?apiKey=${apiKey}`;
+    const apiCall = self._client
+        .get(url);
+    return self._returnData(await apiCall);
+  }
+
 }
 
 export default AdminDocuments;

package/api/user/document.js

@@ -275,7 +275,10 @@ 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 to be the FULL document data, that you can get with findById
+   * @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
@@ -284,7 +287,7 @@ class Documents {
    *
    * const API = require('@docbrasil/api-systemmanager');
    * const api = new API();
-   * const params = { ... };
+   * const params = { orgId: '5edf9f8ee896b817e45b8da7', areaId: '5edf9f8ee896b817e45b8da8', 'docTypeFieldsData.extraName': 'New name' };
    * const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
    * await api.user.document.findByIdsAndUpdate(['5edf9f8ee896b817e45b8dad'], params, session);
    */
@@ -293,11 +296,14 @@ class Documents {
     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;
-      params.ids = ids;
+      delete params.areaId;
+      delete params.orgId;
       const apiCall = self._client
-          .put(`/organizations/${orgId}/areas/${areaId}/documents/batch`, params, self._setHeader(session));
+          .put(`/organizations/${orgId}/areas/${areaId}/documents/batch`, { ids, data: params }, self._setHeader(session));
 
       return self._returnData(await apiCall);
     } catch (ex) {

package/dist/bundle.cjs

@@ -929,7 +929,10 @@ 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 to be the FULL document data, that you can get with findById
+   * @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
@@ -938,7 +941,7 @@ class Documents {
    *
    * const API = require('@docbrasil/api-systemmanager');
    * const api = new API();
-   * const params = { ... };
+   * const params = { orgId: '5edf9f8ee896b817e45b8da7', areaId: '5edf9f8ee896b817e45b8da8', 'docTypeFieldsData.extraName': 'New name' };
    * const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
    * await api.user.document.findByIdsAndUpdate(['5edf9f8ee896b817e45b8dad'], params, session);
    */
@@ -947,11 +950,14 @@ class Documents {
     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;
-      params.ids = ids;
+      delete params.areaId;
+      delete params.orgId;
       const apiCall = self._client
-          .put(`/organizations/${orgId}/areas/${areaId}/documents/batch`, params, self._setHeader(session));
+          .put(`/organizations/${orgId}/areas/${areaId}/documents/batch`, { ids, data: params }, self._setHeader(session));
 
       return self._returnData(await apiCall);
     } catch (ex) {
@@ -12677,7 +12683,6 @@ class AdminDocuments {
    * const { signedUrl, imageType } = await api.admin.document.signedUrl(params, apiKey);
    */
   async signedUrl(params = {}, apiKey) {
-
     Joi__default["default"].assert(params, Joi__default["default"].object().required());
     Joi__default["default"].assert(params.methodType, Joi__default["default"].string().required());
     Joi__default["default"].assert(params.docId, Joi__default["default"].string().required());
@@ -12715,7 +12720,6 @@ class AdminDocuments {
    * await api.admin.document.updateContent(params, apiKey);
    */
   async updateContent(params = {}, apiKey) {
-
     Joi__default["default"].assert(params, Joi__default["default"].object().required());
     Joi__default["default"].assert(params.content, Joi__default["default"].string().required());
     Joi__default["default"].assert(params.docId, Joi__default["default"].string().required());
@@ -12762,7 +12766,6 @@ class AdminDocuments {
    * await api.admin.document.updateContent(params, apiKey);
    */
   async updateAI(params = {}, apiKey) {
-
     Joi__default["default"].assert(params, Joi__default["default"].object().required());
     Joi__default["default"].assert(params.docId, Joi__default["default"].string().required());
     Joi__default["default"].assert(apiKey, Joi__default["default"].string().required());
@@ -12807,7 +12810,6 @@ class AdminDocuments {
    * await api.admin.document.getContent(params, apiKey);
    */
   async getContent(params = {}, apiKey) {
-
     Joi__default["default"].assert(params, Joi__default["default"].object().required());
     Joi__default["default"].assert(params.docId, Joi__default["default"].string().required());
     Joi__default["default"].assert(params.page, Joi__default["default"].string().required());
@@ -12821,6 +12823,39 @@ class AdminDocuments {
     return self._returnData(await apiCall);
   }
 
+  /**
+   *
+   * @author Myndware <augusto.pissarra@myndware.com>
+   * @description Get the data of a document
+   * @param {object} params Params to request signed url
+   * @param {string} params.id The unique id of the document
+   * @param {string} apiKey Api Key as permission to use this functionality
+   * @return {Promise<object>} data the document data
+   * @public
+   * @async
+   * @example
+   *
+   * const API = require('@docbrasil/api-systemmanager');
+   * const api = new API();
+   * const params - {
+   *  id: '5dadd01dc4af3941d42f8c5c'
+   * };
+   * const apiKey: '...';
+   * await api.admin.document.getDocumentData(params, apiKey);
+   */
+  async getDocumentData(params = {}, apiKey) {
+    Joi__default["default"].assert(params, Joi__default["default"].object().required());
+    Joi__default["default"].assert(params.id, Joi__default["default"].string().required());
+    Joi__default["default"].assert(apiKey, Joi__default["default"].string().required());
+
+    const self = this;
+    const { id } = params;
+    const url = `/api/documents/${id}?apiKey=${apiKey}`;
+    const apiCall = self._client
+        .get(url);
+    return self._returnData(await apiCall);
+  }
+
 }
 
 /**