oneentry 1.0.126 → 1.0.127

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

@@ -2,99 +2,95 @@ import type { IError } from '../base/utils';
 import type { IUploadingQuery } from '../file-uploading/fileUploadingInterfaces';
 /**
  * Interface for retrieving and posting form data in the system.
- *
  * @interface IFormsData
- *
- * @property {function} getFormsData - Get all forms data.
- * @property {function} postFormsData - Find all product page objects with pagination and multiple filtering.
- * @property {function} getFormsDataByMarker - Get one object of form data by marker.
+ * @property {Function} getFormsData         - Get all forms data.
+ * @property {Function} postFormsData        - Find all product page objects with pagination and multiple filtering.
+ * @property {Function} getFormsDataByMarker - Get one object of form data by marker.
  * @description This interface defines methods for retrieving and posting form data in the system.
  */
 interface IFormsData {
     /**
      * Retrieves all forms data.
-     *
-     * @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.
-     * @return {IFormsDataEntity} A promise that resolves to a collection of form data entities or an error.
+     * @handleName getFormsData
+     * @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 {IFormsDataEntity}          A promise that resolves to a collection of form data 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 data.
      */
     getFormsData(langCode: string, offset?: number, limit?: number): Promise<IFormsDataEntity | IError>;
     /**
      * Creating an object of data save information by form
-     *
      * @handleName postFormsData
-     *
-     * @param {IBodyPostFormData} body - Request body. Example:
-        {
-          "formIdentifier": "form",
-          "formData": [
-            {
-              "marker": "name",
-              "type": "string",
-              "value": "Jack"
-            }
-          ]
-        }
-     * @param {string} body.formIdentifier - The identifier for the form. Example: "form".
-     * @param {FormDataType[]} body.formData - Example:
-        [
-          {
-            "marker": "name",
-            "type": "string",
-            "value": "Jack"
-          }
-        ]
-     * @param {string} body.formData.marker - The marker identifying the form field. Example: "name".
-     * @param {string} body.formData.type - The type of the form field. Example: "string".
-     * @param {string} body.formData.value - The value of the form field. Example: "Jack".
-     * @param {string} [langCode] - Language code. Default: "en_US".
-     * @return {IPostFormResponse} Returns an object containing the created form data entry and message.
+     * @param   {IBodyPostFormData} body                 - Request body. Example:
+                                                         {
+                                                         "formIdentifier": "form",
+                                                         "formData": [
+                                                         {
+                                                         "marker": "name",
+                                                         "type": "string",
+                                                         "value": "Jack"
+                                                         }
+                                                         ]
+                                                         }
+     * @param   {string}            body.formIdentifier  - The identifier for the form. Example: "form".
+     * @param   {FormDataType[]}    body.formData        - Example:
+                                                         [
+                                                         {
+                                                         "marker": "name",
+                                                         "type": "string",
+                                                         "value": "Jack"
+                                                         }
+                                                         ]
+     * @param   {string}            body.formData.marker - The marker identifying the form field. Example: "name".
+     * @param   {string}            body.formData.type   - The type of the form field. Example: "string".
+     * @param   {string}            body.formData.value  - The value of the form field. Example: "Jack".
+     * @param   {string}            [langCode]           - Language code. Default: "en_US".
+     * @returns {IPostFormResponse}                      Returns an object containing the created form data entry and message.
      * @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.
      */
     postFormsData(body: IBodyPostFormData, langCode?: string): Promise<IPostFormResponse | IError>;
     /**
      * Retrieves form data by its marker.
-     *
-     * @param {string} marker - The marker identifying the form data. Example: "contact_form_data".
-     * @param {number} formModuleConfigId - Example: 4.
-     * @param {object} [body] - Default: {}. Example:
-        {
-          "entityIdentifier": "test",
-          "userIdentifier": "",
-          "status": "",
-          "dateFrom": "2025-08-11",
-          "dateTo": ""
-        }
-     * @param {any} [isNested] - Flag for getting hierarchical data. Example: 1.
-     * @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 {IFormsDataEntity} A promise that resolves to a form data entity or an error.
+     * @handleName getFormsDataByMarker
+     * @param   {string}                   marker             - The marker identifying the form data. Example: "contact_form_data".
+     * @param   {number}                   formModuleConfigId - The form module configuration ID. Example: 4.
+     * @param   {object}                   [body]             - Request body. Default: {}. Example:
+                                                              {
+                                                              "entityIdentifier": "test",
+                                                              "userIdentifier": "",
+                                                              "status": "",
+                                                              "dateFrom": "2025-08-11",
+                                                              "dateTo": ""
+                                                              }
+     * @param   {any}                      [isNested]         - Flag for getting hierarchical data. Example: 1.
+     * @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 {IFormsByMarkerDataEntity}                    A promise that resolves to a form data 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 form data by its marker.
      */
     getFormsDataByMarker(marker: string, formModuleConfigId: number, body?: object, isNested?: number, langCode?: string, offset?: number, limit?: number): Promise<IFormsDataEntity | IError>;
 }
 /**
  * Represents the structure of a form data entity.
- *
  * @interface IFormDataEntity
- *
- * @property {number} id - The unique identifier of the form page. Example: 12345.
- * @property {string} formIdentifier - The identifier of the page. Example: "contact_form".
- * @property {Date | string} time - The identifier of the form. Example: "2023-10-01T12:00:00Z".
- * @property {FormDataType[]} formData - Form data. Example:
-    [
-      {
-        "marker": "name",
-        "type": "string",
-        "value": "Test"
-      }
-    ]
- * @property {string | null} [attributeSetIdentifier] - Text identifier (marker) of the used attribute set. Example: "product_attributes".
- * @property {string | null} [actionMessage] - Action message for the form data. Example: "Form submitted successfully".
+ * @property {number}         id                       - The unique identifier of the form page. Example: 12345.
+ * @property {string}         formIdentifier           - The identifier of the page. Example: "contact_form".
+ * @property {Date | string}  time                     - The identifier of the form. Example: "2023-10-01T12:00:00Z".
+ * @property {FormDataType[]} formData                 - Form data. Example:
+                                                       [
+                                                       {
+                                                       "marker": "name",
+                                                       "type": "string",
+                                                       "value": "Test"
+                                                       }
+                                                       ]
+ * @property {string | null}  [attributeSetIdentifier] - Text identifier (marker) of the used attribute set. Example: "product_attributes".
+ * @property {string | null}  [actionMessage]          - Action message for the form data. Example: "Form submitted successfully".
  * @description This interface defines the structure of a form data entity, including its identifiers, form data, and optional attributes.
  */
 interface IFormDataEntity {
@@ -107,22 +103,20 @@ interface IFormDataEntity {
 }
 /**
  * Represents a collection of form data entities.
- *
  * @interface IFormsDataEntity
- *
  * @property {IFormDataEntity[]} items - Array of form data objects. Example:
-    [
-      {
-        "id": 1,
-        "formIdentifier": "form",
-        "time": "2025-06-06T19:07:45.993Z",
-        "formData": {},
-        "attributeSetIdentifier": "form",
-        "actionMessage": "Action message string"
-      }
-    ]
+                                       [
+                                       {
+                                       "id": 1,
+                                       "formIdentifier": "form",
+                                       "time": "2025-06-06T19:07:45.993Z",
+                                       "formData": {},
+                                       "attributeSetIdentifier": "form",
+                                       "actionMessage": "Action message string"
+                                       }
+                                       ]
  * @description This interface defines the structure of a collection of form data entities, including a total count and an array of items.
- * @property {number} total - Total number of found records. Example: 100.
+ * @property {number}            total - Total number of found records. Example: 100.
  */
 interface IFormsDataEntity {
     items: IFormDataEntity[];
@@ -130,30 +124,27 @@ interface IFormsDataEntity {
 }
 /**
  * Represents the structure of a form data entity.
- *
  * @interface IFormByMarkerDataEntity
- *
- * @property {number} id - The unique identifier of the form page. Example: 12345.
- * @property {null | number} parentId - The unique identifier of the parent form page. Example: 123.
- * @property {string} formIdentifier - The identifier of the page. Example: "contact_form".
- * @property {Date | string} time - The identifier of the form. Example: "2023-10-01T12:00:00Z".
- * @property {number} depth - Example: 1.
- * @property {FormDataType[]} formData - Form data. Example:
-    [
-      {
-        "marker": "name",
-        "type": "string",
-        "value": "Test"
-      }
-    ]
- * @property {string | null} [actionMessage] - Action message for the form data. Example: "Form submitted successfully".
- * @property {string | null} [attributeSetIdentifier] - Text identifier (marker) of the used attribute set. Example: "product_attributes".
- * @property {string | null} [ip] - Example: '127.0.0.1'.
- * @property {string | null} [status] - Example: ''.
- * @property {string | null} [userIdentifier] - Example: ''.
- * @property {string} [entityIdentifier] - Example: 'blog'.
- * @property {boolean} [isUserAdmin] - Example: false.
- * @property {number} [formModuleConfigId] - Example: 2.
+ * @property {number}         id                       - The unique identifier of the form page. Example: 12345.
+ * @property {null | number}  parentId                 - The unique identifier of the parent form page. Example: 123.
+ * @property {string}         formIdentifier           - The identifier of the page. Example: "contact_form".
+ * @property {number}         depth                    - Example: 1.
+ * @property {string | null}  [ip]                     - Ip. Example: '127.0.0.1'.
+ * @property {string | null}  [status]                 - Status. Example: 'approved'.
+ * @property {string | null}  [userIdentifier]         - Text identifier (marker) of the user. Example: "admin".
+ * @property {FormDataType[]} formData                 - Form data. Example:
+                                                       [
+                                                       {
+                                                       "marker": "name",
+                                                       "type": "string",
+                                                       "value": "Test"
+                                                       }
+                                                       ]
+ * @property {string | null}  [attributeSetIdentifier] - Text identifier (marker) of the used attribute set. Example: "product_attributes".
+ * @property {Date | string}  time                     - The identifier of the form. Example: "2023-10-01T12:00:00Z".
+ * @property {string}         [entityIdentifier]       - Text identifier (marker) of the entity. Example: "test".
+ * @property {boolean}        [isUserAdmin]            - Is user admin. Example: true.
+ * @property {number}         [formModuleConfigId]     - Form module config Id. Example: 2.
  * @description This interface defines the structure of a form data entity, including its identifiers, form data, and optional attributes.
  */
 interface IFormByMarkerDataEntity {
@@ -161,47 +152,72 @@ interface IFormByMarkerDataEntity {
     parentId: null | number;
     formIdentifier: string;
     depth: number;
-    time: Date | string;
-    formData: FormDataType[];
-    actionMessage?: string | null;
-    attributeSetIdentifier?: string | null;
     ip?: string | null;
     status?: string | null;
     userIdentifier?: string | null;
+    formData: FormDataType[];
+    attributeSetIdentifier?: string | null;
+    time: Date | string;
     entityIdentifier: string;
     isUserAdmin: boolean;
     formModuleConfigId: number;
 }
 /**
  * Represents a collection of form data entities.
- *
  * @interface IFormsByMarkerDataEntity
- *
  * @property {IFormByMarkerDataEntity[]} items - Array of form data objects. Example:
-    [
-      {
-        id: 42,
-        parentId: null,
-        formIdentifier: 'test-form',
-        depth: 0,
-        ip: null,
-        status: null,
-        userIdentifier: null,
-        formData: [{ marker: 'name', type: 'string', value: 'Test' }],
-        attributeSetIdentifier: 'form',
-        time: '2025-03-03T15:51:17.458Z',
-        entityIdentifier: 'blog',
-        isUserAdmin: false,
-        formModuleConfigId: 2
-      }
-    ]
- * @property {number} total - Total number of found records. Example: 100.
+                                               [
+                                               {
+                                               "id": 42,
+                                               "parentId": null,
+                                               "formIdentifier": "test-form",
+                                               "depth": 0,
+                                               "ip": null,
+                                               "status": null,
+                                               "userIdentifier": null,
+                                               "formData": [
+                                               {
+                                               "marker": "name",
+                                               "type": "string",
+                                               "value": "Test"
+                                               }
+                                               ],
+                                               "attributeSetIdentifier": "form",
+                                               "time": "2025-03-03T15:51:17.458Z",
+                                               "entityIdentifier": "blog",
+                                               "isUserAdmin": false,
+                                               "formModuleConfigId": 2
+                                               }
+                                               ]
+ * @property {number}                    total - Total number of found records. Example: 100.
  * @description This interface defines the structure of a collection of form data entities, including a total count and an array of items.
  */
 interface IFormsByMarkerDataEntity {
     items: IFormByMarkerDataEntity[];
     total: number;
 }
+/**
+ * Represents the structure of the response after posting form data.
+ * @interface IPostFormResponse
+ * @property {string}         actionMessage             - Action message for the form data. Example: "Form submitted successfully".
+ * @property {object}         formData                  - Form data. Example:
+ * @property {number}         formData.id               - The unique identifier of the form page. Example: 12345.
+ * @property {string}         formData.formIdentifier   - The identifier of the form. Example: "contact_form".
+ * @property {string}         formData.time             - The time of the form submit. Example: "2023-10-01T12:00:00Z".
+ * @property {string}         formData.entityIdentifier - The entity identifier. Example: "blog".
+ * @property {boolean}        formData.isUserAdmin      - Is user admin. Example: false.
+ * @property {number}         formData.formModuleId     - The form module identifier. Example: 2.
+ * @property {any}            formData.parentId         - The parent identifier. Example: null.
+ * @property {any}            formData.userIdentifier   - The user identifier. Example: null.
+ * @property {FormDataType[]} formData.formData         - Form fields data. Example:
+                                                        [
+                                                        {
+                                                        "marker": "name",
+                                                        "type": "string",
+                                                        "value": "Jack"
+                                                        }
+                                                        ]
+ */
 interface IPostFormResponse {
     actionMessage: string;
     formData: {
@@ -222,31 +238,29 @@ interface IPostFormResponse {
 type FormDataType = IBodyTypeStringNumberFloat | IBodyTypeTimeDate | IBodyTypeText | IBodyTypeTextWithHeader | IBodyTypeImageGroupOfImages | IBodyTypeFile | IBodyTypeRadioButtonList | Record<string, any>;
 /**
  * Represents the structure of the body for posting form data.
- *
  * @interface IBodyPostFormData
- *
- * @property {string} formIdentifier - Text identifier (marker) of the form. Example: "form".
- * @property {number} formModuleConfigId - Example: 2.
- * @property {string} moduleEntityIdentifier - Example: "blog".
- * @property {string | null} replayTo - Example: "".
- * @property {string} status - Example: "sent".
- * @property {FormDataType[]} formData - Array of form data objects. Example:
-    [
-      {
-        "marker": "name",
-        "type": "string",
-        "value": "Jack"
-      }
-    ]
- * @property {string} formData[index].marker - The marker identifying the form field. Example: "name".
- * @property {string} formData[index].type - The type of the form field. Example: "string".
- * @property {string} formData[index].value - The value of the form field. Example: "name".
- * @property {IUploadingQuery} [fileQuery] - Optional file query for uploading files. Example:
-    {
-      "type": "page",
-      "entity": "editor",
-      "id": 3787
-    }
+ * @property {string}          formIdentifier         - Text identifier (marker) of the form. Example: "form".
+ * @property {number}          formModuleConfigId     - The unique identifier of the form module configuration. Example: 2.
+ * @property {string}          moduleEntityIdentifier - Text identifier (marker) of the module entity. Example: "blog".
+ * @property {string | null}   replayTo               - Email to reply to. Example: "some@email.com".
+ * @property {string}          status                 - Status of the form. Example: "sent".
+ * @property {FormDataType[]}  formData               - Array of form data objects. Example:
+                                                      [
+                                                      {
+                                                      "marker": "name",
+                                                      "type": "string",
+                                                      "value": "Jack"
+                                                      }
+                                                      ]
+ * @property {string}          formData[index].marker - The marker identifying the form field. Example: "name".
+ * @property {string}          formData[index].type   - The type of the form field. Example: "string".
+ * @property {string}          formData[index].value  - The value of the form field. Example: "name".
+ * @property {IUploadingQuery} [fileQuery]            - Optional file query for uploading files. Example:
+                                                      {
+                                                      "type": "page",
+                                                      "entity": "editor",
+                                                      "id": 3787
+                                                      }
  * @description This interface defines the structure of a form post object, including its identifiers, time, form data, and optional file query.
  */
 interface IBodyPostFormData {
@@ -260,12 +274,10 @@ interface IBodyPostFormData {
 }
 /**
  * Represents a form data entity with a simple value.
- *
  * @interface IBodyTypeStringNumberFloat
- *
  * @property {string} marker - marker name. Example: "some_marker".
- * @property {string} type - Type value. "string" | "number" | "float". Example: "string".
- * @property {string} value - Value of the form data entity, which can be a "string", "number", or "float". Example: "string".
+ * @property {string} type   - Type value. "string" | "number" | "float". Example: "string".
+ * @property {string} value  - Value of the form data entity, which can be a "string", "number", or "float". Example: "string".
  * @description Represents a form data entity with a marker, type, and value.
  */
 interface IBodyTypeStringNumberFloat {
@@ -275,17 +287,15 @@ interface IBodyTypeStringNumberFloat {
 }
 /**
  * Represents a date/time form data entity.
- *
  * @interface IBodyTypeTimeDate
- *
  * @property {string} marker - marker name. Example: "ome_marker".
- * @property {string} type - Type value. 'date' | 'dateTime' | 'time' Example: "date".
- * @property {object} value - Date object. Contains fullDate, formattedValue, formatString. Example:
-    {
-      "fullDate": "2024-05-07T21:02:00.000Z",
-      "formattedValue": "08-05-2024 00:02",
-      "formatString": "DD-MM-YYYY HH:mm"
-    }
+ * @property {string} type   - Type value. 'date' | 'dateTime' | 'time' Example: "date".
+ * @property {object} value  - Date object. Contains fullDate, formattedValue, formatString. Example:
+                             {
+                             "fullDate": "2024-05-07T21:02:00.000Z",
+                             "formattedValue": "08-05-2024 00:02",
+                             "formatString": "DD-MM-YYYY HH:mm"
+                             }
  * @description Represents a date, dateTime, or time value in a structured format.
  */
 interface IBodyTypeTimeDate {
@@ -299,20 +309,18 @@ interface IBodyTypeTimeDate {
 }
 /**
  * Represents a text form data entity.
- *
  * @interface IBodyTypeText
- *
  * @property {string} marker - marker name. Example: "some_marker".
- * @property {string} type - Type value. Example: "text".
- * @property {object} value - Text Object. Contains html as string, plain text and params. Example:
-    {
-      "htmlValue": "<p>Hello world</p>",
-      "plainValue": "",
-      "params": {
-        "isEditorDisabled": false,
-        "isImageCompressed": true
-      }
-    }
+ * @property {string} type   - Type value. Example: "text".
+ * @property {object} value  - Text Object. Contains html as string, plain text and params. Example:
+                             {
+                             "htmlValue": "<p>Hello world</p>",
+                             "plainValue": "",
+                             "params": {
+                             "isEditorDisabled": false,
+                             "isImageCompressed": true
+                             }
+                             }
  * @description Represents a text value with HTML and plain text representations, along with parameters for editor and image compression settings.
  */
 interface IBodyTypeText {
@@ -329,21 +337,19 @@ interface IBodyTypeText {
 }
 /**
  * Represents a text with header form data entity.
- *
  * @interface IBodyTypeTextWithHeader
- *
  * @property {string} marker - marker name. Example: "about".
- * @property {string} type - Type value. Example: "textWithHeader".
- * @property {object} value - Text Object. Contains html as string, header and params. Example:
-    {
-      "header": "Headline",
-      "htmlValue": "<p>Hello World</p>",
-      "plainValue": "",
-      "params": {
-        "isEditorDisabled": false,
-        "isImageCompressed": true
-      }
-    }
+ * @property {string} type   - Type value. Example: "textWithHeader".
+ * @property {object} value  - Text Object. Contains html as string, header and params. Example:
+                             {
+                             "header": "Headline",
+                             "htmlValue": "<p>Hello World</p>",
+                             "plainValue": "",
+                             "params": {
+                             "isEditorDisabled": false,
+                             "isImageCompressed": true
+                             }
+                             }
  * @description Represents a text value with a header, HTML and plain text representations, along with parameters for editor and image compression settings.
  */
 interface IBodyTypeTextWithHeader {
@@ -361,23 +367,21 @@ interface IBodyTypeTextWithHeader {
 }
 /**
  * Represents an image or group of images form data entity.
- *
  * @interface IBodyTypeImageGroupOfImages
- *
- * @property {string} marker - marker name. Example: "avatar".
- * @property {'image' | 'groupOfImage'} type - Type value. Example: "image".
- * @property {object} value - Image Object. Contains image information. Example:
-    [
-      {
-        "filename": "files/project/page/10/image/Screenshot-from-2024-05-02-15-23-14.png",
-        "downloadLink": "http://my-site.com/cloud-static/files/project/page/10/image/Screenshot-from-2024-05-02-15-23-14.png",
-        "size": 392585,
-        "previewLink": "",
-        "params": {
-          "isImageCompressed": true
-        }
-      }
-    ]
+ * @property {string}                   marker - marker name. Example: "avatar".
+ * @property {'image' | 'groupOfImage'} type   - Type value. Example: "image".
+ * @property {object}                   value  - Image Object. Contains image information. Example:
+                                               [
+                                               {
+                                               "filename": "files/project/page/10/image/Screenshot-from-2024-05-02-15-23-14.png",
+                                               "downloadLink": "http://my-site.com/cloud-static/files/project/page/10/image/Screenshot-from-2024-05-02-15-23-14.png",
+                                               "size": 392585,
+                                               "previewLink": "",
+                                               "params": {
+                                               "isImageCompressed": true
+                                               }
+                                               }
+                                               ]
  * @description Represents an image or a group of images with their details, including filename, download link, size, preview link, and parameters for image compression.
  */
 interface IBodyTypeImageGroupOfImages {
@@ -403,19 +407,17 @@ interface IBodyTypeImageGroupOfImages {
 }
 /**
  * Represents a file form data entity.
- *
  * @interface IBodyTypeFile
- *
  * @property {string} marker - marker name. Example: "picture".
- * @property {'file'} type - Type value. Example: "file".
- * @property {object} value - File Object. Contains file information. Example:
-    [
-      {
-        "filename": "files/project/page/10/image/Screenshot-from-2024-05-02-15-23-14.png",
-        "downloadLink": "http://my-site.com/cloud-static/files/project/page/10/image/Screenshot-from-2024-05-02-15-23-14.png",
-        "size": 392585
-      }
-    ]
+ * @property {'file'} type   - Type value. Example: "file".
+ * @property {object} value  - File Object. Contains file information. Example:
+                             [
+                             {
+                             "filename": "files/project/page/10/image/Screenshot-from-2024-05-02-15-23-14.png",
+                             "downloadLink": "http://my-site.com/cloud-static/files/project/page/10/image/Screenshot-from-2024-05-02-15-23-14.png",
+                             "size": 392585
+                             }
+                             ]
  * @description Represents a file with its details, including filename, download link, and size.
  */
 interface IBodyTypeFile {
@@ -429,22 +431,20 @@ interface IBodyTypeFile {
 }
 /**
  * Represents a radio button or list selection form data entity.
- *
  * @interface IBodyTypeRadioButtonList
- *
  * @property {string} marker - marker name. Example: "selector".
- * @property {string} type - Type value. Example: 'list'.
- * @property {array} value - Array of list or radioButton bojects. Example:
-    [
-      {
-        "title": "red",
-        "value": "1",
-        "extended": {
-          "value": "red",
-          "type": "string"
-        }
-      }
-    ]
+ * @property {string} type   - Type value. Example: 'list'.
+ * @property {Array}  value  - Array of list or radioButton bojects. Example:
+                             [
+                             {
+                             "title": "red",
+                             "value": "1",
+                             "extended": {
+                             "value": "red",
+                             "type": "string"
+                             }
+                             }
+                             ]
  * @description Represents a list or radio button selection with multiple options, each containing a title, value, and extended information.
  */
 interface IBodyTypeRadioButtonList {