oneentry 1.0.127 → 1.0.128

package/dist/file-uploading/fileUploadingApi.d.ts

@@ -21,25 +21,25 @@ export default class FileUploadingApi extends AsyncModules implements IFileUploa
     /**
      * Upload file function.
      * @handleName upload
-     * @param   {File | Blob}        file                 - File to upload. Example: `new File(["content"], "file.png", {"type": "image/png"})`
-     * @param   {IUploadingQuery}    [fileQuery]          - Optional set query parameters. Example:
-                                                          {
-                                                          "type": "page",
-                                                          "entity": "editor",
-                                                          "id": 3787,
-                                                          "width": 0,
-                                                          "height": 0,
-                                                          "compress": true,
-                                                          "template": 1
-                                                          }
-     * @param   {string}             [fileQuery.type]     - Type, determines the folder name in the storage. Example: "page".
-     * @param   {string}             [fileQuery.entity]   - Entity name from which the file is uploaded, determines the folder name in the storage. Example: "editor".
-     * @param   {number}             [fileQuery.id]       - Identifier of the object from which the file is uploaded, determines the folder name in the storage. Example: 3787.
-     * @param   {number}             [fileQuery.width]    - Optional width parameter. Example: 0.
-     * @param   {number}             [fileQuery.height]   - Optional height parameter. Example: 0.
-     * @param   {boolean}            [fileQuery.compress] - Optional flag of optimization (compression) for images. Example: true.
-     * @param   {any}                [fileQuery.template] - preview template identifier. Example: 1.
-     * @returns {IUploadingReturn[]}                      Uploads a file to an Amazon S3-compatible cloud file storage.
+     * @param {File | Blob} file - File to upload. Example: `new File(["content"], "file.png", {"type": "image/png"})`
+     * @param {IUploadingQuery} [fileQuery] - Optional set query parameters. Example:
+        {
+          "type": "page",
+          "entity": "editor",
+          "id": 3787,
+          "width": 0,
+          "height": 0,
+          "compress": true,
+          "template": 1
+        }
+     * @param {string} [fileQuery.type] - Type, determines the folder name in the storage. Example: "page".
+     * @param {string} [fileQuery.entity] - Entity name from which the file is uploaded, determines the folder name in the storage. Example: "editor".
+     * @param {number} [fileQuery.id] - Identifier of the object from which the file is uploaded, determines the folder name in the storage. Example: 3787.
+     * @param {number} [fileQuery.width] - Optional width parameter. Example: 0.
+     * @param {number} [fileQuery.height] - Optional height parameter. Example: 0.
+     * @param {boolean} [fileQuery.compress] - Optional flag of optimization (compression) for images. Example: true.
+     * @param {any} [fileQuery.template] - preview template identifier. Example: 1.
+     * @returns {IUploadingReturn[]} Uploads a file to an Amazon S3-compatible cloud file storage.
      * @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.
      */
@@ -47,19 +47,19 @@ export default class FileUploadingApi extends AsyncModules implements IFileUploa
     /**
      * Deletes a file from the cloud file storage.
      * @handleName delete
-     * @param   {string}          [filename]           - File name. Example: "file.png".
-     * @param   {IUploadingQuery} [fileQuery]          - Optional set query parameters. Example:
-                                                       {
-                                                       "type": "page",
-                                                       "entity": "editor",
-                                                       "id": 3787,
-                                                       "template": 1
-                                                       }
-     * @param   {string}          [fileQuery.type]     - Type, determines the folder name in the storage. Example: "page".
-     * @param   {string}          [fileQuery.entity]   - Entity name from which the file is uploaded, determines the folder name in the storage. Example: "editor".
-     * @param   {number}          [fileQuery.id]       - Identifier of the object from which the file is uploaded, determines the folder name in the storage. Example: 3787.
-     * @param   {number}          [fileQuery.template] - preview template identifier. Example: 1.
-     * @returns {any}                                  Returns a promise that resolves to the result of the deletion operation or an error object if there was an issue.
+     * @param {string} filename - File name. Example: "file.png".
+     * @param {IUploadingQuery} [fileQuery] - Optional set query parameters. Example:
+        {
+          "type": "page",
+          "entity": "editor",
+          "id": 3787,
+          "template": 1
+        }
+     * @param {string} [fileQuery.type] - Type, determines the folder name in the storage. Example: "page".
+     * @param {string} [fileQuery.entity] - Entity name from which the file is uploaded, determines the folder name in the storage. Example: "editor".
+     * @param {number} [fileQuery.id] - Identifier of the object from which the file is uploaded, determines the folder name in the storage. Example: 3787.
+     * @param {number} [fileQuery.template] - preview template identifier. Example: 1.
+     * @returns {any} Returns a promise that resolves to the result of the deletion operation 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.
      */
@@ -67,12 +67,12 @@ export default class FileUploadingApi extends AsyncModules implements IFileUploa
     /**
      * Get file by parameters.
      * @handleName getFile
-     * @param   {number} [id]       - Object identifier, from which the file is uploaded, determines the folder name in the storage. Example: 3787.
-     * @param   {string} [type]     - Type, determines the folder name in the storage. Example: "page".
-     * @param   {string} [entity]   - Entity name, from which the file is uploaded, determines the folder name in the storage. Example: "editor".
-     * @param   {string} [filename] - Filename. Example: "file.png".
-     * @param   {string} [template] - Preview template identifier. Example: 1.
-     * @returns {any}               Returns a promise that resolves to a Blob object containing the file data or an error object if there was an issue.
+     * @param {number} id - Object identifier, from which the file is uploaded, determines the folder name in the storage. Example: 3787.
+     * @param {string} type - Type, determines the folder name in the storage. Example: "page".
+     * @param {string} entity - Entity name, from which the file is uploaded, determines the folder name in the storage. Example: "editor".
+     * @param {string} filename - Filename. Example: "file.png".
+     * @param {string} [template] - Preview template identifier. Example: 1.
+     * @returns {any} Returns a promise that resolves to a Blob object containing the file 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.
      */

package/dist/file-uploading/fileUploadingApi.js

@@ -33,25 +33,25 @@ class FileUploadingApi extends asyncModules_1.default {
     /**
      * Upload file function.
      * @handleName upload
-     * @param   {File | Blob}        file                 - File to upload. Example: `new File(["content"], "file.png", {"type": "image/png"})`
-     * @param   {IUploadingQuery}    [fileQuery]          - Optional set query parameters. Example:
-                                                          {
-                                                          "type": "page",
-                                                          "entity": "editor",
-                                                          "id": 3787,
-                                                          "width": 0,
-                                                          "height": 0,
-                                                          "compress": true,
-                                                          "template": 1
-                                                          }
-     * @param   {string}             [fileQuery.type]     - Type, determines the folder name in the storage. Example: "page".
-     * @param   {string}             [fileQuery.entity]   - Entity name from which the file is uploaded, determines the folder name in the storage. Example: "editor".
-     * @param   {number}             [fileQuery.id]       - Identifier of the object from which the file is uploaded, determines the folder name in the storage. Example: 3787.
-     * @param   {number}             [fileQuery.width]    - Optional width parameter. Example: 0.
-     * @param   {number}             [fileQuery.height]   - Optional height parameter. Example: 0.
-     * @param   {boolean}            [fileQuery.compress] - Optional flag of optimization (compression) for images. Example: true.
-     * @param   {any}                [fileQuery.template] - preview template identifier. Example: 1.
-     * @returns {IUploadingReturn[]}                      Uploads a file to an Amazon S3-compatible cloud file storage.
+     * @param {File | Blob} file - File to upload. Example: `new File(["content"], "file.png", {"type": "image/png"})`
+     * @param {IUploadingQuery} [fileQuery] - Optional set query parameters. Example:
+        {
+          "type": "page",
+          "entity": "editor",
+          "id": 3787,
+          "width": 0,
+          "height": 0,
+          "compress": true,
+          "template": 1
+        }
+     * @param {string} [fileQuery.type] - Type, determines the folder name in the storage. Example: "page".
+     * @param {string} [fileQuery.entity] - Entity name from which the file is uploaded, determines the folder name in the storage. Example: "editor".
+     * @param {number} [fileQuery.id] - Identifier of the object from which the file is uploaded, determines the folder name in the storage. Example: 3787.
+     * @param {number} [fileQuery.width] - Optional width parameter. Example: 0.
+     * @param {number} [fileQuery.height] - Optional height parameter. Example: 0.
+     * @param {boolean} [fileQuery.compress] - Optional flag of optimization (compression) for images. Example: true.
+     * @param {any} [fileQuery.template] - preview template identifier. Example: 1.
+     * @returns {IUploadingReturn[]} Uploads a file to an Amazon S3-compatible cloud file storage.
      * @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.
      */
@@ -65,19 +65,19 @@ class FileUploadingApi extends asyncModules_1.default {
     /**
      * Deletes a file from the cloud file storage.
      * @handleName delete
-     * @param   {string}          [filename]           - File name. Example: "file.png".
-     * @param   {IUploadingQuery} [fileQuery]          - Optional set query parameters. Example:
-                                                       {
-                                                       "type": "page",
-                                                       "entity": "editor",
-                                                       "id": 3787,
-                                                       "template": 1
-                                                       }
-     * @param   {string}          [fileQuery.type]     - Type, determines the folder name in the storage. Example: "page".
-     * @param   {string}          [fileQuery.entity]   - Entity name from which the file is uploaded, determines the folder name in the storage. Example: "editor".
-     * @param   {number}          [fileQuery.id]       - Identifier of the object from which the file is uploaded, determines the folder name in the storage. Example: 3787.
-     * @param   {number}          [fileQuery.template] - preview template identifier. Example: 1.
-     * @returns {any}                                  Returns a promise that resolves to the result of the deletion operation or an error object if there was an issue.
+     * @param {string} filename - File name. Example: "file.png".
+     * @param {IUploadingQuery} [fileQuery] - Optional set query parameters. Example:
+        {
+          "type": "page",
+          "entity": "editor",
+          "id": 3787,
+          "template": 1
+        }
+     * @param {string} [fileQuery.type] - Type, determines the folder name in the storage. Example: "page".
+     * @param {string} [fileQuery.entity] - Entity name from which the file is uploaded, determines the folder name in the storage. Example: "editor".
+     * @param {number} [fileQuery.id] - Identifier of the object from which the file is uploaded, determines the folder name in the storage. Example: 3787.
+     * @param {number} [fileQuery.template] - preview template identifier. Example: 1.
+     * @returns {any} Returns a promise that resolves to the result of the deletion operation 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.
      */
@@ -89,12 +89,12 @@ class FileUploadingApi extends asyncModules_1.default {
     /**
      * Get file by parameters.
      * @handleName getFile
-     * @param   {number} [id]       - Object identifier, from which the file is uploaded, determines the folder name in the storage. Example: 3787.
-     * @param   {string} [type]     - Type, determines the folder name in the storage. Example: "page".
-     * @param   {string} [entity]   - Entity name, from which the file is uploaded, determines the folder name in the storage. Example: "editor".
-     * @param   {string} [filename] - Filename. Example: "file.png".
-     * @param   {string} [template] - Preview template identifier. Example: 1.
-     * @returns {any}               Returns a promise that resolves to a Blob object containing the file data or an error object if there was an issue.
+     * @param {number} id - Object identifier, from which the file is uploaded, determines the folder name in the storage. Example: 3787.
+     * @param {string} type - Type, determines the folder name in the storage. Example: "page".
+     * @param {string} entity - Entity name, from which the file is uploaded, determines the folder name in the storage. Example: "editor".
+     * @param {string} filename - Filename. Example: "file.png".
+     * @param {string} [template] - Preview template identifier. Example: 1.
+     * @returns {any} Returns a promise that resolves to a Blob object containing the file 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.
      */

package/dist/file-uploading/fileUploadingInterfaces.d.ts

@@ -11,25 +11,25 @@ interface IFileUploading {
     /**
      * Upload file function.
      * @handleName upload
-     * @param   {File | Blob}        file                 - File to upload. Example: `new File(["content"], "file.png", {"type": "image/png"})`
-     * @param   {IUploadingQuery}    [fileQuery]          - Optional set query parameters. Example:
-                                                          {
-                                                          "type": "page",
-                                                          "entity": "editor",
-                                                          "id": 3787,
-                                                          "width": 0,
-                                                          "height": 0,
-                                                          "compress": true,
-                                                          "template": 1
-                                                          }
-     * @param   {string}             [fileQuery.type]     - Type, determines the folder name in the storage. Example: "page".
-     * @param   {string}             [fileQuery.entity]   - Entity name from which the file is uploaded, determines the folder name in the storage. Example: "editor".
-     * @param   {number}             [fileQuery.id]       - Identifier of the object from which the file is uploaded, determines the folder name in the storage. Example: 3787.
-     * @param   {number}             [fileQuery.width]    - Optional width parameter. Example: 0.
-     * @param   {number}             [fileQuery.height]   - Optional height parameter. Example: 0.
-     * @param   {boolean}            [fileQuery.compress] - Optional flag of optimization (compression) for images. Example: true.
-     * @param   {any}                [fileQuery.template] - preview template identifier. Example: 1.
-     * @returns {IUploadingReturn[]}                      Uploads a file to an Amazon S3-compatible cloud file storage.
+     * @param {File | Blob} file - File to upload. Example: `new File(["content"], "file.png", {"type": "image/png"})`
+     * @param {IUploadingQuery} [fileQuery] - Optional set query parameters. Example:
+        {
+          "type": "page",
+          "entity": "editor",
+          "id": 3787,
+          "width": 0,
+          "height": 0,
+          "compress": true,
+          "template": 1
+        }
+     * @param {string} [fileQuery.type] - Type, determines the folder name in the storage. Example: "page".
+     * @param {string} [fileQuery.entity] - Entity name from which the file is uploaded, determines the folder name in the storage. Example: "editor".
+     * @param {number} [fileQuery.id] - Identifier of the object from which the file is uploaded, determines the folder name in the storage. Example: 3787.
+     * @param {number} [fileQuery.width] - Optional width parameter. Example: 0.
+     * @param {number} [fileQuery.height] - Optional height parameter. Example: 0.
+     * @param {boolean} [fileQuery.compress] - Optional flag of optimization (compression) for images. Example: true.
+     * @param {any} [fileQuery.template] - preview template identifier. Example: 1.
+     * @returns {IUploadingReturn[]} Uploads a file to an Amazon S3-compatible cloud file storage.
      * @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.
      */
@@ -37,19 +37,19 @@ interface IFileUploading {
     /**
      * Deletes a file from the cloud file storage.
      * @handleName delete
-     * @param   {string}          [filename]           - File name. Example: "file.png".
-     * @param   {IUploadingQuery} [fileQuery]          - Optional set query parameters. Example:
-                                                       {
-                                                       "type": "page",
-                                                       "entity": "editor",
-                                                       "id": 3787,
-                                                       "template": 1
-                                                       }
-     * @param   {string}          [fileQuery.type]     - Type, determines the folder name in the storage. Example: "page".
-     * @param   {string}          [fileQuery.entity]   - Entity name from which the file is uploaded, determines the folder name in the storage. Example: "editor".
-     * @param   {number}          [fileQuery.id]       - Identifier of the object from which the file is uploaded, determines the folder name in the storage. Example: 3787.
-     * @param   {number}          [fileQuery.template] - preview template identifier. Example: 1.
-     * @returns {any}                                  Returns a promise that resolves to the result of the deletion operation or an error object if there was an issue.
+     * @param {string} [filename] - File name. Example: "file.png".
+     * @param {IUploadingQuery} [fileQuery] - Optional set query parameters. Example:
+        {
+          "type": "page",
+          "entity": "editor",
+          "id": 3787,
+          "template": 1
+        }
+     * @param {string} [fileQuery.type] - Type, determines the folder name in the storage. Example: "page".
+     * @param {string} [fileQuery.entity] - Entity name from which the file is uploaded, determines the folder name in the storage. Example: "editor".
+     * @param {number} [fileQuery.id] - Identifier of the object from which the file is uploaded, determines the folder name in the storage. Example: 3787.
+     * @param {number} [fileQuery.template] - preview template identifier. Example: 1.
+     * @returns {any} Returns a promise that resolves to the result of the deletion operation 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.
      */
@@ -57,11 +57,11 @@ interface IFileUploading {
     /**
      * Retrieves a file by its parameters.
      * @handleName getFile
-     * @param   {number} id         - The ID of the file entity. Example: 3787.
-     * @param   {string} type       - The type of the file. Example: "page".
-     * @param   {string} entity     - The entity associated with the file. Example: "editor".
-     * @param   {string} [filename] - Optional filename to retrieve. Example: "file.png".
-     * @returns {Blob}              A promise that resolves to a Blob object or an error.
+     * @param {number} id - The ID of the file entity. Example: 3787.
+     * @param {string} type - The type of the file. Example: "page".
+     * @param {string} entity - The entity associated with the file. Example: "editor".
+     * @param {string} [filename] - Optional filename to retrieve. Example: "file.png".
+     * @returns {Blob} A promise that resolves to a Blob object or an error.
      * @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.
      */
@@ -79,11 +79,11 @@ interface IFileEntity {
 /**
  * Represents a query for uploading files, including type, entity, and optional parameters like width, height, and compression.
  * @interface IUploadingQuery
- * @property {string}  type       - Type, determines the folder name in the storage. Example: "page".
- * @property {string}  entity     - Entity name from which the file is uploaded, determines the folder name in the storage. Example: "editor".
- * @property {number}  id         - Identifier of the object from which the file is uploaded, determines the folder name in the storage. Example: 3787.
- * @property {number}  [width]    - Width parameter. Example: 0.
- * @property {number}  [height]   - Height parameter. Example: 0.
+ * @property {string} type - Type, determines the folder name in the storage. Example: "page".
+ * @property {string} entity - Entity name from which the file is uploaded, determines the folder name in the storage. Example: "editor".
+ * @property {number} id - Identifier of the object from which the file is uploaded, determines the folder name in the storage. Example: 3787.
+ * @property {number} [width] - Width parameter. Example: 0.
+ * @property {number} [height] - Height parameter. Example: 0.
  * @property {boolean} [compress] - Flag of optimization (compression) for images. Example: true.
  * @description Represents a query for uploading files, including type, entity, and optional parameters like width, height, and compression.
  */
@@ -96,9 +96,9 @@ interface IUploadingQuery {
 /**
  * Represents the return value of an uploading operation, including the filename, download link, and file size.
  * @interface IUploadingReturn
- * @property {string} filename     - Filename with relative path. Example: "uploads/file.png".
+ * @property {string} filename - Filename with relative path. Example: "uploads/file.png".
  * @property {string} downloadLink - Link for downloading the file. Example: "https://example.com/uploads/file.png".
- * @property {number} size         - Size of the file in bytes. Example: 1024.
+ * @property {number} size - Size of the file in bytes. Example: 1024.
  * @description Represents the return value of an uploading operation, including the filename, download link, and file size.
  */
 interface IUploadingReturn {

package/dist/forms/formsApi.d.ts

@@ -23,10 +23,10 @@ export default class FormsApi extends AsyncModules implements IForms {
     /**
      * Get all forms.
      * @handleName getAllForms
-     * @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 {IFormsEntity[]}            Returns array for all objects of type FormEntity.
+     * @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 {IFormsEntity[]} Returns array for all objects of type FormEntity.
      * @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.
      */
@@ -34,9 +34,9 @@ export default class FormsApi extends AsyncModules implements IForms {
     /**
      * Get one form by form marker.
      * @handleName getFormByMarker
-     * @param   {string}       marker     - Marker of form. Example: "contact_form".
-     * @param   {string}       [langCode] - Language code. Default: "en_US".
-     * @returns {IFormsEntity}            Returns object of type FormEntity.
+     * @param {string} marker - Marker of form. Example: "contact_form".
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @returns {IFormsEntity} Returns object of type FormEntity.
      * @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.
      */

package/dist/forms/formsApi.js

@@ -26,10 +26,10 @@ class FormsApi extends asyncModules_1.default {
     /**
      * Get all forms.
      * @handleName getAllForms
-     * @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 {IFormsEntity[]}            Returns array for all objects of type FormEntity.
+     * @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 {IFormsEntity[]} Returns array for all objects of type FormEntity.
      * @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,9 +40,9 @@ class FormsApi extends asyncModules_1.default {
     /**
      * Get one form by form marker.
      * @handleName getFormByMarker
-     * @param   {string}       marker     - Marker of form. Example: "contact_form".
-     * @param   {string}       [langCode] - Language code. Default: "en_US".
-     * @returns {IFormsEntity}            Returns object of type FormEntity.
+     * @param {string} marker - Marker of form. Example: "contact_form".
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @returns {IFormsEntity} Returns object of type FormEntity.
      * @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.
      */

package/dist/forms/formsInterfaces.d.ts

@@ -3,7 +3,7 @@ import type { IAttributes, IError, ILocalizeInfo } from '../base/utils';
 /**
  * Interface for retrieving forms in the system.
  * @interface IForms
- * @property {Function} getAllForms     - Get all forms in array.
+ * @property {Function} getAllForms - Get all forms in array.
  * @property {Function} getFormByMarker - Get one form by form marker.
  * @description This interface defines methods for retrieving forms in the system.
  */
@@ -11,10 +11,10 @@ interface IForms {
     /**
      * Retrieves all forms in the system.
      * @handleName getAllForms
-     * @param   {string}         [langCode] - The language code for localization. Default: "en_US".
-     * @param   {number}         [offset]   - Optional offset for pagination. Default: 0.
-     * @param   {number}         [limit]    - Optional limit for pagination. Default: 30.
-     * @returns {IFormsEntity[]}            A promise that resolves to an array of form entities or an error.
+     * @param {string} [langCode] - The language code for localization. Default: "en_US".
+     * @param {number} [offset] - Optional offset for pagination. Default: 0.
+     * @param {number} [limit] - Optional limit for pagination. Default: 30.
+     * @returns {IFormsEntity[]} A promise that resolves to an array of form entities or an error.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      * @description This method retrieves all forms in the system.
      */
@@ -22,9 +22,9 @@ interface IForms {
     /**
      * Retrieves a form by its marker.
      * @handleName getFormByMarker
-     * @param   {string}       marker     - The marker identifying the form. Example: "contact_form".
-     * @param   {string}       [langCode] - The language code for localization. Default: "en_US".
-     * @returns {IFormsEntity}            A promise that resolves to a form entity or an error.
+     * @param {string} marker - The marker identifying the form. Example: "contact_form".
+     * @param {string} [langCode] - The language code for localization. Default: "en_US".
+     * @returns {IFormsEntity} A promise that resolves to a form entity or an error.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      * @description This method retrieves a form by its marker.
      */
@@ -33,19 +33,19 @@ interface IForms {
 /**
  * Represents the structure of a form page.
  * @interface IFromPages
- * @property {number}    id         - The unique identifier of the form page. Example: 123.
- * @property {number}    pageId     - The identifier of the page. Example: 12.
- * @property {number}    formId     - The identifier of the form. Example: 321.
- * @property {number}    positionId - The identifier of the position. Example: 1.
- * @property {IPosition} position   - The position object. Example:
-                                    {
-                                    "id": 1,
-                                    "position": 1,
-                                    "objectId": 2,
-                                    "objectType": "admin",
-                                    "isLocked": false,
-                                    "objectCategoryId": 1
-                                    }
+ * @property {number} id - The unique identifier of the form page. Example: 123.
+ * @property {number} pageId - The identifier of the page. Example: 12.
+ * @property {number} formId - The identifier of the form. Example: 321.
+ * @property {number} positionId - The identifier of the position. Example: 1.
+ * @property {IPosition} position - The position object. Example:
+    {
+      "id": 1,
+      "position": 1,
+      "objectId": 2,
+      "objectType": "admin",
+      "isLocked": false,
+      "objectCategoryId": 1
+    }
  * @description This interface defines the structure of a form page.
  */
 interface IFromPages {
@@ -58,16 +58,16 @@ interface IFromPages {
 /**
  * Represents the structure of a form entity.
  * @interface IFormsEntity
- * @property {number}                              id             - The identifier of the object. Example: 12345.
- * @property {number | null}                       attributeSetId - The identifier of the attribute set being used, or null if not applicable. Example: 1234.
- * @property {string | null}                       type           - Form type. Example: "contact".
- * @property {ILocalizeInfo}                       localizeInfos  - The name of the form, taking into account localization. Example: {"key": "value"}.
- * @property {number}                              version        - The version number of the object. Example: 1.
- * @property {number}                              position       - The position of the object. Example: 1.
- * @property {string}                              identifier     - The textual identifier for the record field. Example: "form_contact_us".
- * @property {string}                              processingType - Type of form processing. Example: "async".
- * @property {number | null}                       templateId     - The identifier of the template used by the form, or null if no template is used. Example: 6789.
- * @property {IAttributes[] | Record<string, any>} attributes     - The attributes of the form, which can be an array of attribute objects or a record of key-value pairs. Example: {"key": "value"}.
+ * @property {number} id - The identifier of the object. Example: 12345.
+ * @property {number | null} attributeSetId - The identifier of the attribute set being used, or null if not applicable. Example: 1234.
+ * @property {string | null} type - Form type. Example: "contact".
+ * @property {ILocalizeInfo} localizeInfos - The name of the form, taking into account localization. Example: {"key": "value"}.
+ * @property {number} version - The version number of the object. Example: 1.
+ * @property {number} position - The position of the object. Example: 1.
+ * @property {string} identifier - The textual identifier for the record field. Example: "form_contact_us".
+ * @property {string} processingType - Type of form processing. Example: "async".
+ * @property {number | null} templateId - The identifier of the template used by the form, or null if no template is used. Example: 6789.
+ * @property {IAttributes[] | Record<string, any>} attributes - The attributes of the form, which can be an array of attribute objects or a record of key-value pairs. Example: {"key": "value"}.
  * @description This interface defines the structure of a form entity, including its identifiers, attributes, and processing data.
  */
 interface IFormsEntity {
@@ -83,6 +83,18 @@ interface IFormsEntity {
     attributes: IAttributes[] | Record<string, any>;
     moduleFormConfigs?: Array<IFormConfig>;
 }
+/**
+ * Represents the structure of a form configuration.
+ * @interface IFormConfig
+ * @property {number} id - The identifier of the form configuration. Example: 123.
+ * @property {string} moduleIdentifier - The identifier of the module associated with the form configuration. Example: "module_identifier".
+ * @property {boolean} isGlobal - Indicates whether the form configuration is global. Example: true.
+ * @property {boolean} isClosed - Indicates whether the form configuration is closed. Example: true.
+ * @property {boolean} viewOnlyUserData - Indicates whether the form configuration allows viewing user data. Example: true.
+ * @property {boolean} commentOnlyUserData - Indicates whether the form configuration allows commenting on user data. Example: true.
+ * @property {string[]} entityIdentifiers - An array of entity identifiers associated with the form configuration. Example: ["entity_identifier_1", "entity_identifier_2"].
+ * @description This interface defines the structure of a form configuration, including its identifiers, module association, and entity identifiers.
+ */
 interface IFormConfig {
     id: number;
     moduleIdentifier: string;

package/dist/forms-data/formsDataApi.d.ts

@@ -14,16 +14,16 @@ export default class FormsDataApi extends AsyncModules implements IFormsData {
     protected state: StateModule;
     protected _url: string;
     /**
-     *
+     * Constructor for FormsDataApi class.
      */
     constructor(state: StateModule);
     /**
      * 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.
      */
@@ -31,23 +31,23 @@ export default class FormsDataApi extends AsyncModules implements IFormsData {
     /**
      * 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.
      */
@@ -55,21 +55,21 @@ export default class FormsDataApi extends AsyncModules implements IFormsData {
     /**
      * 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.
      */