@docbrasil/api-systemmanager 1.0.105 → 1.0.106

package/api/external.js

@@ -124,6 +124,52 @@ class External {
     }
   }
 
+  /**
+   * @author CloudBrasil <abernardo.br@gmail.com>
+   * @description Handles the execution of an external form
+   * @param {string} authorization a legal authorization
+   * @param {object} params the parameters to handle the execution of an external form
+   * @param {array<object>} params.payload the payload of the external form. It should represent the form groups of the external form
+   * @param {string} params.payload.name the name of the group
+   * @param {array<object>} params.payload.fields the fields that belong to each group
+   * @param {*|{}} params.payload.fields.value besides all the data inside a field, it should have the value of the the field
+   * @returns {Promise<boolean>} true|false if success
+   * @public
+   * @async
+   * @example
+   *
+   * const API = require('@docbrasil/api-systemmanager');
+   * const api = new API();
+   * const authorization = '...';
+   * const params = {
+   *  payload: [
+   *      {
+   *          name: 'My Group One',
+   *          fields: [
+   *              {}
+   *          ]
+   *      }
+   *  ]
+   * };
+   * const success = await api.external.handle(params, authorization);
+   */
+  async handle(params, authorization) {
+    const self = this;
+
+    try {
+      Joi.assert(params, Joi.object().required().error(new Error('params is required')));
+      Joi.assert(params.payload, Joi.array().required().error(new Error('form payload is required')));
+      Joi.assert(authorization, Joi.string().required().error(new Error('authorization is required')));
+
+      const apiCall = self._client
+          .put('/external/forms', params, self._setHeader(authorization));
+
+      return self._returnData(await apiCall);
+    } catch (ex) {
+      throw ex;
+    }
+  }
+
 }
 
 export default External;

package/dist/bundle.cjs

@@ -11700,6 +11700,52 @@ class External {
     }
   }
 
+  /**
+   * @author CloudBrasil <abernardo.br@gmail.com>
+   * @description Handles the execution of an external form
+   * @param {string} authorization a legal authorization
+   * @param {object} params the parameters to handle the execution of an external form
+   * @param {array<object>} params.payload the payload of the external form. It should represent the form groups of the external form
+   * @param {string} params.payload.name the name of the group
+   * @param {array<object>} params.payload.fields the fields that belong to each group
+   * @param {*|{}} params.payload.fields.value besides all the data inside a field, it should have the value of the the field
+   * @returns {Promise<boolean>} true|false if success
+   * @public
+   * @async
+   * @example
+   *
+   * const API = require('@docbrasil/api-systemmanager');
+   * const api = new API();
+   * const authorization = '...';
+   * const params = {
+   *  payload: [
+   *      {
+   *          name: 'My Group One',
+   *          fields: [
+   *              {}
+   *          ]
+   *      }
+   *  ]
+   * };
+   * const success = await api.external.handle(params, authorization);
+   */
+  async handle(params, authorization) {
+    const self = this;
+
+    try {
+      Joi__default["default"].assert(params, Joi__default["default"].object().required().error(new Error('params is required')));
+      Joi__default["default"].assert(params.payload, Joi__default["default"].array().required().error(new Error('form payload is required')));
+      Joi__default["default"].assert(authorization, Joi__default["default"].string().required().error(new Error('authorization is required')));
+
+      const apiCall = self._client
+          .put('/external/forms', params, self._setHeader(authorization));
+
+      return self._returnData(await apiCall);
+    } catch (ex) {
+      throw ex;
+    }
+  }
+
 }
 
 /**