oneentry 1.0.127 → 1.0.128

package/dist/forms-data/formsDataApi.js

@@ -17,7 +17,7 @@ const fileUploadingApi_1 = __importDefault(require("../file-uploading/fileUpload
  */
 class FormsDataApi extends asyncModules_1.default {
     /**
-     *
+     * Constructor for FormsDataApi class.
      */
     constructor(state) {
         super(state);
@@ -26,10 +26,10 @@ class FormsDataApi extends asyncModules_1.default {
     /**
      * Get all forms data.
      * @handleName getFormsData
-     * @param   {string}           [langCode] - Language code. Default: "en_US".
-     * @param   {number}           [offset]   - Parameter for pagination. Default: 0.
-     * @param   {number}           [limit]    - Parameter for pagination. Default: 30.
-     * @returns {IFormsDataEntity}            Returns an object containing all forms data or an error object if there was an issue.
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @param {number} [offset] - Parameter for pagination. Default: 0.
+     * @param {number} [limit] - Parameter for pagination. Default: 30.
+     * @returns {IFormsDataEntity} Returns an object containing all forms data or an error object if there was an issue.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      * @description This method requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
      */
@@ -40,23 +40,23 @@ class FormsDataApi extends asyncModules_1.default {
     /**
      * Creating an object of data save information by form
      * @handleName postFormsData
-     * @param   {IBodyPostFormData} body       - Request body. Example:
-                                               {
-                                               "formIdentifier": "test-form",
-                                               "formModuleConfigId": 2,
-                                               "moduleEntityIdentifier": "blog",
-                                               "replayTo": null,
-                                               "status": "sent",
-                                               "formData": [
-                                               {
-                                               "marker": "name",
-                                               "type": "string",
-                                               "value": "Test"
-                                               }
-                                               ]
-                                               }
-     * @param   {string}            [langCode] - Language code. Default: "en_US".
-     * @returns {IPostFormResponse}            Returns an object containing the created form data entry or an error object if there was an issue.
+     * @param {IBodyPostFormData} body - Request body. Example:
+        {
+          "formIdentifier": "test-form",
+          "formModuleConfigId": 2,
+          "moduleEntityIdentifier": "blog",
+          "replayTo": null,
+          "status": "sent",
+          "formData": [
+            {
+            "marker": "name",
+            "type": "string",
+            "value": "Test"
+            }
+          ]
+        }
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @returns {IPostFormResponse} Returns an object containing the created form data entry or an error object if there was an issue.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      * @description This method requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
      */
@@ -116,26 +116,25 @@ class FormsDataApi extends asyncModules_1.default {
     /**
      * Get one object of form data by marker.
      * @handleName getFormsDataByMarker
-     * @param   {string}                   marker             - Marker of the form. Example: "contact_form".
-     * @param   {number}                   formModuleConfigId - Form module configuration ID. Example: 4.
-     * @param   {object}                   [body]             - Request body. Example:
-                                                              {
-                                                              "entityIdentifier": "test",
-                                                              "userIdentifier": "",
-                                                              "status": "",
-                                                              "dateFrom": "2025-08-11",
-                                                              "dateTo": ""
-                                                              }
-     * @param   {any}                      [isNested]         - Flag for getting hierarchical data. Example: 1.
-     * @param   {string}                   [langCode]         - Language code. Default: "en_US".
-     * @param   {number}                   [offset]           - Parameter for pagination. Default: 0.
-     * @param   {number}                   [limit]            - Parameter for pagination. Default: 30.
-     * @returns {IFormsByMarkerDataEntity}                    Returns an object containing the form data or an error object if there was an issue.
+     * @param {string} marker - Marker of the form. Example: "contact_form".
+     * @param {number} formModuleConfigId - Form module configuration ID. Example: 4.
+     * @param {object} [body] - Request body. Example:
+        {
+          "entityIdentifier": "test",
+          "userIdentifier": "",
+          "status": "",
+          "dateFrom": "2025-08-11",
+          "dateTo": ""
+        }
+     * @param {any} [isNested] - Flag for getting hierarchical data. Example: 1.
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @param {number} [offset] - Parameter for pagination. Default: 0.
+     * @param {number} [limit] - Parameter for pagination. Default: 30.
+     * @returns {IFormsByMarkerDataEntity} Returns an object containing the form data or an error object if there was an issue.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      * @description This method requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
      */
     async getFormsDataByMarker(marker, formModuleConfigId, body = {}, isNested = 1, langCode = this.state.lang, offset = 0, limit = 30) {
-        // ): Promise<IFormByMarkerDataEntity | IError> {
         const result = await this._fetchPost(`/marker/${marker}?formModuleConfigId=${formModuleConfigId}&isNested=${isNested}&langCode=${langCode}&offset=${offset}&limit=${limit}`, body);
         return this._dataPostProcess(result, langCode);
     }