oneentry 1.0.172 → 1.0.174

package/esm/forms-data/formsDataApi.js

@@ -41,9 +41,9 @@ export default class FormsDataApi extends AsyncModules {
      * @param {string} body.formIdentifier - The identifier for the form. Example: "form".
      * @param {number} body.formModuleConfigId - The ID of the form module configuration. Example: 2.
      * @param {string} body.moduleEntityIdentifier - The identifier of the module entity. Example: "form".
-     * @param {string | null} [body.replayTo] - The email address to which the reply should be sent.
+     * @param {number | null} [body.replayTo] - Identifier of the parent form data record this one replies to (for threaded data such as comments); `null` for a top-level record. The platform stores it as `parentId`.
      * @param {string | null} [body.status] - The status of the form submission.
-     * @param {FormDataType[]} body.formData - Form data.
+     * @param {FormDataType[]} body.formData - Form fields.
      * @example
         [
           {
@@ -155,7 +155,7 @@ export default class FormsDataApi extends AsyncModules {
      * so it is stripped from an array of values and from a lone value object alike. A value
      * of any other shape is returned untouched and the endpoint names the field it cannot
      * read — instead of the library dying on `value.map is not a function` before the
-     * request is made (CMS-990).
+     * request is made.
      */
     _stripContentType(value) {
         // An entry carrying `contentType` is copied without it rather than edited:
@@ -199,8 +199,8 @@ export default class FormsDataApi extends AsyncModules {
      * 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 {IFormsDataFilter} [body] - Filter for the records to return. Every field is optional; an omitted or empty one is not applied.
+     * @param {number} formModuleConfigId - ID of the form module configuration. Example: 4.
+     * @param {IFormsDataFilter} [body] - Filter for the records to return. Every field is optional; an omitted or empty field is not applied.
      * @example
         {
           "entityIdentifier": "blog",
@@ -216,10 +216,10 @@ export default class FormsDataApi extends AsyncModules {
      * @param {FormDataStatus[]} [body.status] - Moderation statuses to keep: "sent", "moderation", "approved", "banned", "deleted". Must be an array; anything outside the set is rejected with `400 each value in status must be a valid enum value`. Example: ["approved"].
      * @param {string} [body.dateFrom] - Lower bound of the submission date, `YYYY-MM-DD`. An empty string means "no bound" — the SDK removes it from the body, because the endpoint answers `400 dateFrom must be a valid date in format "YYYY-MM-DD"` to one. An unparsable non-empty value still fails the request. Example: "2025-01-01".
      * @param {string} [body.dateTo] - Upper bound of the submission date, `YYYY-MM-DD`. An empty string means "no bound", handled like `dateFrom`. Example: "2025-12-31".
-     * @param {number} [isExtended] - Flag for getting additional fields. Example: 1.
+     * @param {number} [isExtended] - Pass `1` to return additional fields for each record. Default: `0`. 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.
+     * @param {number} [offset] - Number of records to skip. Default: 0.
+     * @param {number} [limit] - Maximum number of records to return. Default: 30.
      * @returns {Promise<IFormsByMarkerDataEntity | IError>} Returns an object containing the form data or an error object if there was an issue.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Each record's `formData` comes back **already unwrapped from its locale**. The API sends `formData: { "en_US": [ … ] }`; the SDK normalizes the response and hands over the array for `langCode`, so read `record.formData` — `record.formData[langCode]` is `undefined` and yields an empty list with no error. This holds for both values of `isExtended`.
@@ -238,7 +238,7 @@ export default class FormsDataApi extends AsyncModules {
     /**
      * Update one object of form data by id. Requires user authentication.
      * @handleName updateFormsDataByid
-     * @param {number} id - ID of the form data. Example: 1.
+     * @param {number} id - Form data ID. Example: 1.
      * @returns {Promise<IUpdateFormsData | IError>} Returns an object containing the updated form data or an error object if there was an issue.
      * @see {@link https://js-sdk.oneentry.cloud/docs/forms-data/updateFormsDataByid updateFormsDataByid} documentation.
      */
@@ -251,7 +251,7 @@ export default class FormsDataApi extends AsyncModules {
     /**
      * Update form data status by id. Requires user authentication.
      * @handleName updateFormsDataStatusByid
-     * @param {number} id - ID of the form data. Example: 1.
+     * @param {number} id - Form data ID. Example: 1.
      * @param {object} body - Request body.
      * @returns {Promise<boolean | IError>} Returns an object containing the updated form data or an error object if there was an issue.
      * @see {@link https://js-sdk.oneentry.cloud/docs/forms-data/updateFormsDataStatusByid updateFormsDataStatusByid} documentation.
@@ -263,7 +263,7 @@ export default class FormsDataApi extends AsyncModules {
     /**
      * Delete one object of form data by id. Requires user authentication.
      * @handleName deleteFormsDataByid
-     * @param {number} id - ID of the form data. Example: 1.
+     * @param {number} id - Form data ID. Example: 1.
      * @returns {Promise<boolean | IError>} Returns an object containing the deleted form data or an error object if there was an issue.
      * @see {@link https://js-sdk.oneentry.cloud/docs/forms-data/deleteFormsDataByid deleteFormsDataByid} documentation.
      */
@@ -274,10 +274,10 @@ export default class FormsDataApi extends AsyncModules {
     /**
      * Semantic (vector) search for form data.
      * @handleName getFormsDataByVectorSearch
-     * @param {IFormsDataVectorSearch} body - Vector search body. Example: `{ queryText: "order confirmation" }`.
+     * @param {IFormsDataVectorSearch} body - Vector search parameters. Example: `{ queryText: "order confirmation" }`.
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @param {number} [offset] - Parameter for pagination. Default: 0.
-     * @param {number} [limit] - Parameter for pagination. Default: 30.
+     * @param {number} [offset] - Number of records to skip. Default: 0.
+     * @param {number} [limit] - Maximum number of records to return. Default: 30.
      * @returns {Promise<IVectorSearchResponse<IFormsDataSearchResponse> | IError>} Returns an object with an array of found form data records and total count.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This method performs a semantic (vector) search for form data.

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

@@ -28,9 +28,9 @@ interface IFormsData {
      * @param {string} body.formIdentifier - The identifier for the form. Example: "form".
      * @param {number} body.formModuleConfigId - The ID of the form module configuration. Example: 2.
      * @param {string} body.moduleEntityIdentifier - The identifier of the module entity. Example: "form".
-     * @param {string | null} [body.replayTo] - The email address to which the reply should be sent. Example: null.
+     * @param {number | null} [body.replayTo] - Identifier of the parent form data record this one replies to (for threaded data such as comments); `null` for a top-level record. The platform stores it as `parentId`. Example: null.
      * @param {string | null} [body.status] - The status of the form submission. Example: "sent".
-     * @param {FormDataType[]} body.formData - Form data.
+     * @param {FormDataType[]} body.formData - Form fields.
      * @example
         [
           {
@@ -61,10 +61,10 @@ interface IFormsData {
           "dateFrom": "2025-08-11",
           "dateTo": ""
         }
-     * @param {number} [isExtended] - Flag for getting additional fields. Example: 1.
+     * @param {number} [isExtended] - Pass `1` to return additional fields for each record. Default: `0`. 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.
+     * @param {number} [offset] - Number of records to skip. Default: 0.
+     * @param {number} [limit] - Maximum number of records to return. 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. Each record's `formData` is returned **already unwrapped from its locale**: the API sends `{ "en_US": [ … ] }`, the SDK hands over the array for `langCode` — read `record.formData`, not `record.formData[langCode]`.
@@ -73,10 +73,10 @@ interface IFormsData {
     /**
      * Semantic (vector) search for form data.
      * @handleName getFormsDataByVectorSearch
-     * @param {IFormsDataVectorSearch} body - Vector search body. Example: `{ queryText: "order confirmation" }`.
+     * @param {IFormsDataVectorSearch} body - Vector search parameters. Example: `{ queryText: "order confirmation" }`.
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @param {number} [offset] - Parameter for pagination. Default: 0.
-     * @param {number} [limit] - Parameter for pagination. Default: 30.
+     * @param {number} [offset] - Number of records to skip. Default: 0.
+     * @param {number} [limit] - Maximum number of records to return. Default: 30.
      * @returns {Promise<IVectorSearchResponse<IFormsDataSearchResponse> | IError>} Returns an object with an array of found form data records and total count.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      */
@@ -87,8 +87,8 @@ interface IFormsData {
  * @interface IFormsDataVectorSearch
  * @property {string} queryText - Natural-language search query. Example: "order confirmation".
  * @property {number} [vectorDistanceThreshold] - Override of the cosine distance threshold (0..2). Example: 0.3.
- * @property {number} [maxHits] - Top-K candidates fetched before pagination. Default: 100. Max: 500. Example: 10.
- * @property {boolean} [debug] - When true, each returned item gets a `distance` field. Example: false.
+ * @property {number} [maxHits] - Number of top candidates fetched before pagination. Default: 100. Maximum: 500. Example: 10.
+ * @property {boolean} [debug] - When `true`, each returned item gets a `distance` field. Example: false.
  * @description Body for the form-data vector/search endpoint.
  */
 interface IFormsDataVectorSearch {
@@ -109,7 +109,7 @@ type FormDataStatus = 'sent' | 'moderation' | 'approved' | 'banned' | 'deleted';
 /**
  * Represents the filter body of `getFormsDataByMarker`.
  * @interface IFormsDataFilter
- * @property {string | number} [entityIdentifier] - Identifier of the entity the records belong to; an empty string means "no filter". Text marker for content entities ("blog"), the **numeric id for products** (2954), the login for users and admins. Example: "blog".
+ * @property {string | number} [entityIdentifier] - Identifier of the entity the records belong to; an empty string means no filter. A marker for content entities (`blog`), the **numeric ID for products** (`2954`), the login for users and admins. Example: "blog".
  * @property {number} [parentId] - Identifier of the parent record — the way to fetch replies to one comment. Example: 10.
  * @property {string} [userIdentifier] - Text identifier of the sender; an empty string means "no filter". Example: "admin".
  * @property {FormDataStatus[]} [status] - Moderation statuses to keep. Must be an array — a bare string is rejected with `400`. An empty array means "no filter". Example: ["approved"].
@@ -140,10 +140,10 @@ interface IFormsDataFilter {
 /**
  * Represents a form data record returned by the vector search endpoint.
  * @interface IFormDataSearchEntity
- * @property {number} [id] - The unique identifier of the form data record. Example: 12345.
- * @property {string} [formIdentifier] - Text identifier of the form. Example: "contact_form".
+ * @property {number} [id] - ID of the form data record. Example: 12345.
+ * @property {string} [formIdentifier] - Marker of the form. Example: "contact_form".
  * @property {Date | string} [time] - Date and time the form data was last changed. Example: "2023-02-12 10:56".
- * @property {FormDataType[]} [formData] - Data submitted by the form.
+ * @property {FormDataType[]} [formData] - Submitted form fields.
  * @example
     [
       {
@@ -153,13 +153,13 @@ interface IFormsDataFilter {
       }
     ]
  * @property {string | null} [userIdentifier] - Text identifier of the user who submitted the form, or `null` for an anonymous submission. Example: null.
- * @property {string} [entityIdentifier] - Text identifier of the entity the record belongs to. Example: "blog".
+ * @property {string} [entityIdentifier] - Marker of the entity the record belongs to. Example: "blog".
  * @property {number | null} [parentId] - Identifier of the parent form data record, or `null` for a top-level record. Example: null.
  * @property {string} [ip] - IP address the form was submitted from. Example: "127.0.0.1".
  * @property {string} [fingerprint] - Device fingerprint of the sender. Example: "UQ_123456_abcdef".
  * @property {boolean} [isUserAdmin] - Whether the record was submitted by an admin. Example: false.
  * @property {FormDataStatus} [status] - Moderation status of the record. Example: "sent".
- * @property {number} [formModuleId] - Identifier of the form module the record belongs to. Example: 2.
+ * @property {number} [formModuleId] - ID of the form module the record belongs to. Example: 2.
  * @property {number} [distance] - Cosine distance to the query. Returned only when `debug: true` is passed in the search body. Example: 0.12.
  * @description This interface defines a form data record as returned by the semantic (vector) search endpoint. Unlike IFormDataEntity it carries the moderation and sender fields of the raw record.
  */
@@ -180,7 +180,7 @@ interface IFormDataSearchEntity {
 }
 /**
  * @interface IFormsDataSearchResponse
- * @property {IFormDataSearchEntity[]} items - Array of found form data records.
+ * @property {IFormDataSearchEntity[]} items - Form data records that match the query.
  * @property {number} total - Total number of found records. Example: 100.
  * @description This interface defines the structure of the response returned by the form data vector search endpoint.
  */
@@ -191,9 +191,9 @@ interface IFormsDataSearchResponse {
 /**
  * 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 {number} id - ID of the form data record. Example: 12345.
+ * @property {string} formIdentifier - Marker of the form. Example: "contact_form".
+ * @property {Date | string} time - Date and time the form data was last changed. Example: "2023-10-01T12:00:00Z".
  * @property {FormDataType[]} formData - Submitted fields, **already unwrapped from the locale**: the API returns `{ "en_US": [ … ] }` and the SDK hands over the array for the requested `langCode`.
  * @example
     [
@@ -203,8 +203,8 @@ interface IFormsDataSearchResponse {
         "value": "Test"
       }
     ]
- * @property {string | null} [attributeSetIdentifier] - Text identifier (marker) of the used attribute set. Example: "product_attributes".
- * @property {string} [moduleIdentifier] - Module identifier. Example: "blog".
+ * @property {string | null} [attributeSetIdentifier] - Marker of the attribute set used by the form. Example: "product_attributes".
+ * @property {string} [moduleIdentifier] - Marker of the module. Example: "blog".
  * @description This interface defines the structure of a form data entity, including its identifiers, form data, and optional attributes.
  */
 interface IFormDataEntity {
@@ -218,7 +218,7 @@ interface IFormDataEntity {
 /**
  * Represents a collection of form data entities.
  * @interface IFormsDataEntity
- * @property {IFormDataEntity[]} items - Array of form data objects.
+ * @property {IFormDataEntity[]} items - Form data records.
  * @example
     [
       {
@@ -240,12 +240,12 @@ 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 {number} id - ID of the form data record. Example: 12345.
+ * @property {null | number} parentId - ID of the parent form data record; `null` for a top-level record. Example: 123.
+ * @property {string} formIdentifier - Marker of the form. Example: "contact_form".
  * @property {number} depth - Example: 1.
- * @property {string | null} ip - Ip. Example: '127.0.0.1'.
- * @property {string | null} fingerprint - Fingerprint. Example: 'fingerprint'.
+ * @property {string | null} ip - IP address the form was submitted from. Example: '127.0.0.1'.
+ * @property {string | null} fingerprint - Device fingerprint of the sender. Example: 'fingerprint'.
  * @property {string | null} status - Moderation status of the record: "sent", "moderation", "approved", "banned" or "deleted"; `null` when the form does not moderate. Example: 'approved'.
  * @property {string | null} userIdentifier - Text identifier (marker) of the user. Example: "admin".
  * @property {FormDataType[]} formData - Submitted fields, **already unwrapped from the locale**: the API returns `{ "en_US": [ … ] }` and the SDK hands over the array for the requested `langCode`. Read `formData` directly — `formData[langCode]` is `undefined`.
@@ -257,13 +257,13 @@ interface IFormsDataEntity {
         "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.
- * @property {string} [moduleIdentifier] - Module identifier. Example: "blog".
- * @property {number} entityId - Form module config Id. Example: 2.
+ * @property {string | null} attributeSetIdentifier - Marker of the attribute set used by the form. Example: "product_attributes".
+ * @property {Date | string} time - Date and time the form data was last changed. Example: "2023-10-01T12:00:00Z".
+ * @property {string} entityIdentifier - Marker of the entity the record belongs to. Example: "test".
+ * @property {boolean} isUserAdmin - Whether the record was submitted by an admin. Example: true.
+ * @property {number} formModuleConfigId - ID of the form module configuration. Example: 2.
+ * @property {string} [moduleIdentifier] - Marker of the module. Example: "blog".
+ * @property {number} entityId - ID of the entity the record belongs to. Example: 2.
  * @description This interface defines the structure of a form data entity, including its identifiers, form data, and optional attributes.
  */
 interface IFormByMarkerDataEntity {
@@ -287,7 +287,7 @@ interface IFormByMarkerDataEntity {
 /**
  * Represents a collection of form data entities.
  * @interface IFormsByMarkerDataEntity
- * @property {IFormByMarkerDataEntity[]} items - Array of form data objects.
+ * @property {IFormByMarkerDataEntity[]} items - Form data records.
  * @example
     [
       {
@@ -322,7 +322,7 @@ interface IFormsByMarkerDataEntity {
 /**
  * Represents the structure of the response after posting form data.
  * @interface IPostFormResponse
- * @property {object} formData - Form data.
+ * @property {object} formData - Form fields.
  * @example
     {
       "id": 42,
@@ -341,15 +341,15 @@ interface IFormsByMarkerDataEntity {
         }
       ]
     }
- * @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 {string | null} formData.userIdentifier - The user identifier. Example: null.
- * @property {number | null} formData.parentId - The parent identifier. Example: null.
- * @property {FormDataType[]} formData.formData - Form fields data.
+ * @property {number} formData.id - ID of the form data record. Example: 12345.
+ * @property {string} formData.formIdentifier - Marker of the form. Example: "contact_form".
+ * @property {string} formData.time - Date and time of the submission. Example: "2023-10-01T12:00:00Z".
+ * @property {string} formData.entityIdentifier - Identifier of the entity. Example: "blog".
+ * @property {boolean} formData.isUserAdmin - Whether the record was submitted by an admin. Example: false.
+ * @property {number} formData.formModuleId - ID of the form module. Example: 2.
+ * @property {string | null} formData.userIdentifier - Identifier (login) of the user who submitted the form. Example: null.
+ * @property {number | null} formData.parentId - ID of the parent record. Example: null.
+ * @property {FormDataType[]} formData.formData - Form fields.
  * @example
     [
       {
@@ -358,7 +358,7 @@ interface IFormsByMarkerDataEntity {
         "value": "Jack"
       }
     ]
- * @property {string} actionMessage - Action message for the form data (can be localized). Example: "Form submitted successfully".
+ * @property {string} actionMessage - Message shown after the form is submitted; can be localized. Example: "Form submitted successfully".
  */
 interface IPostFormResponse {
     formData: IPostFormResponseData;
@@ -393,16 +393,16 @@ interface IPostFormResponseData {
 /**
  * Represents the structure of the response after updating form data.
  * @interface IUpdateFormsData
- * @property {number} id - The unique identifier of the form page. Example: 12345.
- * @property {string} formIdentifier - The identifier of the form. Example: "contact_form".
- * @property {string} time - The time of the form submit. Example: "2023-10-01T12:00:00Z".
- * @property {FormDataType[]} formData - Form fields data.
- * @property {string} userIdentifier - The user identifier. Example: null.
- * @property {string} entityIdentifier - The entity identifier. Example: "blog".
- * @property {null | number} parentId - The parent identifier. Example: null.
- * @property {null | string} fingerprint - The fingerprint of the form. Example: null.
- * @property {boolean} isUserAdmin - Is user admin. Example: false.
- * @property {number} formModuleId - The form module identifier. Example: 2.
+ * @property {number} id - ID of the form data record. Example: 12345.
+ * @property {string} formIdentifier - Marker of the form. Example: "contact_form".
+ * @property {string} time - Date and time of the submission. Example: "2023-10-01T12:00:00Z".
+ * @property {FormDataType[]} formData - Form fields.
+ * @property {string} userIdentifier - Identifier (login) of the user who submitted the form. Example: null.
+ * @property {string} entityIdentifier - Identifier of the entity. Example: "blog".
+ * @property {null | number} parentId - ID of the parent record. Example: null.
+ * @property {null | string} fingerprint - Device fingerprint of the sender. Example: null.
+ * @property {boolean} isUserAdmin - Whether the record was submitted by an admin. Example: false.
+ * @property {number} formModuleId - ID of the form module. Example: 2.
  */
 interface IUpdateFormsData {
     id: number;
@@ -424,8 +424,7 @@ type FormDataType = IBodyTypeStringNumberFloat | IBodyTypeTimeDate | IBodyTypeTe
  * Value shapes accepted by a SUBMISSION (`POST /form-data`).
  *
  * For three field kinds they are not the shapes a page attribute uses, and a
- * body written from the read types is refused. Measured on
- * rwah2o.oneentry.cloud, 2026-09-12 and again 2026-09-28 (CMS-888).
+ * body written from the read types is refused.
  *
  * `list` takes a list of strings; the `[{ title, value }]` form of a page
  * attribute answers `400 formData's marker '<marker>' value[0] must be a string`.
@@ -550,12 +549,12 @@ interface ICaptchaValue {
 /**
  * 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 - The unique identifier of the form module configuration. Example: 2.
+ * @property {string} formIdentifier - Marker of the form. Example: "form".
+ * @property {number} formModuleConfigId - ID 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 {FormDataPostType[]} formData - Array of form data objects. A submission's value shapes differ from the read shapes — see FormDataPostType.
+ * @property {number | null} replayTo - Identifier of the parent form data record this one replies to (for threaded data such as comments); `null` for a top-level record. The platform stores it as `parentId`. Example: null.
+ * @property {string} status - Status of the submitted data, for example `"sent"`. Example: "sent".
+ * @property {FormDataPostType[]} formData - Form fields to submit. Submission value shapes differ from the read shapes; see `FormDataPostType`.
  * @example
     [
       {
@@ -567,7 +566,7 @@ interface ICaptchaValue {
  * @property {string} formData[].marker - The marker identifying the form field. Example: "name".
  * @property {string} formData[].type - The type of the form field. Example: "string".
  * @property {string} formData[].value - The value of the form field. Example: "name".
- * @property {IUploadingQuery} [fileQuery] - Optional file query for uploading files. Kept for compatibility: the SDK reads `fileQuery` from the **file field itself** (see IBodyTypeFile), not from the body, so one set here does not change where a file is uploaded.
+ * @property {IUploadingQuery} [fileQuery] - File storage parameters. Kept for compatibility: the SDK reads `fileQuery` from the **file field itself** (see `IBodyTypeFile`), not from the body, so setting it here does not change where the file is uploaded.
  * @example
     {
       "type": "page",
@@ -580,7 +579,7 @@ interface IBodyPostFormData {
     formIdentifier: string;
     formModuleConfigId: number;
     moduleEntityIdentifier: string;
-    replayTo: string | null;
+    replayTo: number | null;
     status: string;
     formData: FormDataPostType[];
     fileQuery?: IUploadingQuery;
@@ -715,7 +714,7 @@ interface ITextWithHeaderValue {
  * @interface IBodyTypeImageGroupOfImages
  * @property {string} marker - marker name. Example: "avatar".
  * @property {'image' | 'groupOfImages'} type - Type value — must match the attribute type in the set, note the plural in "groupOfImages". Example: "image".
- * @property {object} value - The attached image. The same three shapes as a `file` field accepts, mixable in one array: a `File`/`Blob` (also a `FileList`), which the SDK uploads first; the descriptor `FileUploading.upload` returns for an image **already in storage**, passed through as it is; or a hand-built {@link IImageValue}. In a SUBMISSION the value must be an **array**, as for `file` — a lone object answers `400 formData's marker '<marker>' value must be an array`. Measured on js-sdk-tests.oneentry.cloud, 2026-10-08 (CMS-990).
+ * @property {object} value - The attached image. The same three shapes as a `file` field accepts, mixable in one array: a `File`/`Blob` (also a `FileList`), which the SDK uploads first; the descriptor `FileUploading.upload` returns for an image **already in storage**, passed through as it is; or a hand-built {@link IImageValue}. In a SUBMISSION the value must be an **array**, as for `file` — a lone object answers `400 formData's marker '<marker>' value must be an array`.
  * @example
     [
       {
@@ -766,7 +765,7 @@ interface IImageValue {
  * @interface IBodyTypeFile
  * @property {string} marker - marker name. Example: "picture".
  * @property {'file'} type - Type value. Example: "file".
- * @property {object} value - The attached file. Three shapes are accepted and may be mixed in one array: a `File`/`Blob` (also a `FileList`), which the SDK uploads first; the descriptor `FileUploading.upload` returns for a file **already in storage**, which is passed through as it is; or a hand-built {@link IFileValue}. In a SUBMISSION the value must be an **array** — a lone descriptor or {@link IFileValue} answers `400 formData's marker '<marker>' value must be an array`, while a lone `File`/`Blob` is fine because the SDK wraps the upload result. A READ returns a single attached file as the object itself. Measured on js-sdk-tests.oneentry.cloud, 2026-10-08 (CMS-990).
+ * @property {object} value - The attached file. Three shapes are accepted and may be mixed in one array: a `File`/`Blob` (also a `FileList`), which the SDK uploads first; the descriptor `FileUploading.upload` returns for a file **already in storage**, which is passed through as it is; or a hand-built {@link IFileValue}. In a SUBMISSION the value must be an **array** — a lone descriptor or {@link IFileValue} answers `400 formData's marker '<marker>' value must be an array`, while a lone `File`/`Blob` is fine because the SDK wraps the upload result. A READ returns a single attached file as the object itself.
  * @example
     [
       {

package/esm/general-types/generalTypesInterfaces.d.ts

@@ -18,8 +18,8 @@ interface IGeneralTypes {
 /**
  * Represents a general type entity.
  * @interface IGeneralTypesEntity
- * @property {number} id - Type id. Example: 1.
- * @property {BlockType} type - Types enum. Example: "product", "category", "etc".
+ * @property {number} id - ID of the type. Example: 1.
+ * @property {BlockType} type - Type name: a `BlockType` value such as `"product"` or `"service"`. Example: "product", "category", "etc".
  * @description Represents a general type entity with an identifier and a type.
  */
 interface IGeneralTypesEntity {

package/esm/index.d.ts

@@ -136,7 +136,7 @@ interface IDefineApi {
  * @param {string} [config.guestId] - Optional guest identifier sent as the `x-guest-id` header for guest cart/wishlist/activity flows (only while unauthenticated). In the browser, if omitted, a stable per-device id is generated and persisted in localStorage. On the server you MUST pass a per-visitor `guestId` (or call `setGuestId`): the SDK never auto-generates a server id, to avoid sharing one guest across visitors.
  * @param {string} [config.deviceMetadata] - Optional device-metadata string sent as the `x-device-metadata` header instead of the environment-derived fingerprint. Refresh tokens are bound to this header, so a server issuing tokens for a browser (OAuth code exchange) must pass the browser's string (from `getDeviceMetadata()`), or the token will not be refreshable from that browser.
  * @param {string} [config.langCode] - Optional langCode parameter
- * @param {boolean} [config.traficLimit] - Some methods use multiple queries to make it easier to work with the API. Set this parameter to "false" to save traffic and decide for yourself what data you need.
+ * @param {boolean} [config.traficLimit] - Some methods use multiple queries to make it easier to work with the API. Set it to `true` to save traffic and decide for yourself what data you need: the SDK then skips its follow-up requests, and some results change shape (e.g. `searchPage` returns short `{ id, title }` cards). Default: false.
  * @param {string} [config.auth] - An object with authorization settings.
  * @param {boolean} [config.auth.customAuth] - Set this flag to true if you want to configure the authorization process yourself. Set the flag to false, or do not pass it at all to have automatic authorization and token renewal.
  * @param {string} [config.auth.refreshToken] - Transfer the refresh token here, for example from the local storage, to resume the user's session. Otherwise, the user will need to log in every time a new session is created.

package/esm/index.js

@@ -42,7 +42,7 @@ export { expandAttributeTimeIntervals, expandTimeIntervals, isTimeIntervalAttrib
  * @param {string} [config.guestId] - Optional guest identifier sent as the `x-guest-id` header for guest cart/wishlist/activity flows (only while unauthenticated). In the browser, if omitted, a stable per-device id is generated and persisted in localStorage. On the server you MUST pass a per-visitor `guestId` (or call `setGuestId`): the SDK never auto-generates a server id, to avoid sharing one guest across visitors.
  * @param {string} [config.deviceMetadata] - Optional device-metadata string sent as the `x-device-metadata` header instead of the environment-derived fingerprint. Refresh tokens are bound to this header, so a server issuing tokens for a browser (OAuth code exchange) must pass the browser's string (from `getDeviceMetadata()`), or the token will not be refreshable from that browser.
  * @param {string} [config.langCode] - Optional langCode parameter
- * @param {boolean} [config.traficLimit] - Some methods use multiple queries to make it easier to work with the API. Set this parameter to "false" to save traffic and decide for yourself what data you need.
+ * @param {boolean} [config.traficLimit] - Some methods use multiple queries to make it easier to work with the API. Set it to `true` to save traffic and decide for yourself what data you need: the SDK then skips its follow-up requests, and some results change shape (e.g. `searchPage` returns short `{ id, title }` cards). Default: false.
  * @param {string} [config.auth] - An object with authorization settings.
  * @param {boolean} [config.auth.customAuth] - Set this flag to true if you want to configure the authorization process yourself. Set the flag to false, or do not pass it at all to have automatic authorization and token renewal.
  * @param {string} [config.auth.refreshToken] - Transfer the refresh token here, for example from the local storage, to resume the user's session. Otherwise, the user will need to log in every time a new session is created.

package/esm/integration-collections/integrationCollectionsApi.d.ts

@@ -1,7 +1,7 @@
 import AsyncModules from '../base/asyncModules.js';
 import type StateModule from '../base/stateModule.js';
 import type { IError } from '../base/utils.js';
-import type { ICollectionEntity, ICollectionFormObject, ICollectionIsValid, ICollectionQuery, ICollectionRow, ICollectionRowsResponce, ICollectionsApi } from './integrationCollectionsInterfaces.js';
+import type { ICollectionEntity, ICollectionFormObject, ICollectionIsValid, ICollectionQuery, ICollectionRow, ICollectionRowsResponce, ICollectionsApi, ICollectionsListQuery } from './integrationCollectionsInterfaces.js';
 /**
  * Controllers for working with attributes.
  * @handle /api/content/integration-collections
@@ -22,26 +22,22 @@ export default class IntegrationCollectionsApi extends AsyncModules implements I
      * Get all collections.
      * @handleName getICollections
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @param {object} [userQuery] - Optional set query parameters.
+     * @param {ICollectionsListQuery} [userQuery] - Optional query parameters.
      * @example
         {
-          "limit": 0,
-          "offset": 30,
-          "entityType": "orders",
-          "entityId": 1
+          "limit": 30,
+          "offset": 0
         }
-     * @param {number} [userQuery.limit] - Optional parameter for pagination. Default: 0.
-     * @param {number} [userQuery.offset] - Optional parameter for pagination. Default: 30.
-     * @param {string} [userQuery.entityType] - Entity type. Example: "orders".
-     * @param {number} [userQuery.entityId] - Entity identifier. Example: 1.
+     * @param {number} [userQuery.limit] - Maximum number of records to return. Default: 30.
+     * @param {number} [userQuery.offset] - Number of records to skip. Default: 0.
      * @returns {Promise<ICollectionEntity[] | IError>} Returns an array of ICollection objects or an error object if there was an issue.
      * @see {@link https://js-sdk.oneentry.cloud/docs/integration-collections/getICollections getICollections} documentation.
      */
-    getICollections(langCode?: string, userQuery?: ICollectionQuery): Promise<ICollectionEntity[] | IError>;
+    getICollections(langCode?: string, userQuery?: ICollectionsListQuery): Promise<ICollectionEntity[] | IError>;
     /**
      * Get a single collection object by id.
      * @handleName getICollectionById
-     * @param {number} id - Collection id. Example: 1.
+     * @param {number} id - Collection ID. Example: 1.
      * @param {string} [langCode] - Language code. Default: "en_US".
      * @returns {Promise<ICollectionEntity | IError>} Returns an ICollection object or an error object if there was an issue.
      * @throws {IError} When isShell=false and an error occurs during the fetch
@@ -51,20 +47,20 @@ export default class IntegrationCollectionsApi extends AsyncModules implements I
     /**
      * Get all records belonging to the collection by collection id.
      * @handleName getICollectionRowsById
-     * @param {number} id - Collection id. Example: 1.
+     * @param {number} id - Collection ID. Example: 1.
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @param {any} [userQuery] - Optional set query parameters.
+     * @param {ICollectionQuery} [userQuery] - Optional query parameters.
      * @example
         {
-          "limit": 0,
-          "offset": 30,
+          "limit": 30,
+          "offset": 0,
           "entityType": "orders",
           "entityId": 1
         }
-     * @param {number} [userQuery.limit] - Optional parameter for pagination. Default: 0.
-     * @param {number} [userQuery.offset] - Optional parameter for pagination. Default: 30.
+     * @param {number} [userQuery.limit] - Maximum number of records to return. Default: 30.
+     * @param {number} [userQuery.offset] - Number of records to skip. Default: 0.
      * @param {string} [userQuery.entityType] - Entity type. Example: "orders".
-     * @param {number} [userQuery.entityId] - Entity identifier. Example: 1.
+     * @param {number} [userQuery.entityId] - Entity ID. Example: 1.
      * @returns {Promise<ICollectionRowsResponce | IError>} Returns object ItemsWithTotal, where items is an array of requested objects.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Get all records belonging to the collection by collection id.
@@ -74,7 +70,7 @@ export default class IntegrationCollectionsApi extends AsyncModules implements I
     /**
      * Check for the existence of a text identifier (marker).
      * @handleName validateICollectionMarker
-     * @param {string} marker - Collection marker. Example: "collection1".
+     * @param {string} marker - Marker of the collection. Example: "collection1".
      * @returns {Promise<ICollectionIsValid | IError>} Returns an object with a boolean property `valid` indicating whether the marker is valid or not.
      * @example
         {
@@ -88,7 +84,7 @@ export default class IntegrationCollectionsApi extends AsyncModules implements I
     /**
      * Getting all records from the collection.
      * @handleName getICollectionRowsByMarker
-     * @param {string} marker - Collection text identifier. Example: "collection1".
+     * @param {string} marker - Marker of the collection. Example: "collection1".
      * @param {string} [langCode] - Language code. Default: "en_US".
      * @returns {Promise<ICollectionRowsResponce | IError>} Returns CollectionRowEntity object.
      * @throws {IError} When isShell=false and an error occurs during the fetch
@@ -98,8 +94,8 @@ export default class IntegrationCollectionsApi extends AsyncModules implements I
     /**
      * Getting one record from the collection.
      * @handleName getICollectionRowByMarkerAndId
-     * @param {string} marker - Collection text identifier. Example: "collection1".
-     * @param {number} id - Collection record identifier. Example: 1.
+     * @param {string} marker - Marker of the collection. Example: "collection1".
+     * @param {number} id - Collection record ID. Example: 1.
      * @param {string} [langCode] - Language code. Default: "en_US".
      * @returns {Promise<ICollectionRow | IError>} Returns CollectionRowEntity object.
      * @throws {IError} When isShell=false and an error occurs during the fetch
@@ -109,8 +105,8 @@ export default class IntegrationCollectionsApi extends AsyncModules implements I
     /**
      * Create a record in the collection.
      * @handleName createICollectionRow
-     * @param {string} marker - Collection text identifier. Example: "collection1".
-     * @param {ICollectionFormObject} body - Object for creating a record.
+     * @param {string} marker - Marker of the collection. Example: "collection1".
+     * @param {ICollectionFormObject} body - Data for the new record.
      * @example
         {
           "formIdentifier": "collection-form",
@@ -132,9 +128,9 @@ export default class IntegrationCollectionsApi extends AsyncModules implements I
     /**
      * Edit a record in the collection.
      * @handleName updateICollectionRow
-     * @param {string} marker - Text identifier of the collection. Example: "collection1".
-     * @param {number} id - Row identifier in the collection. Example: 12.
-     * @param {object} body - Object for updating a record in the collection.
+     * @param {string} marker - Marker of the collection. Example: "collection1".
+     * @param {number} id - Row ID in the collection. Example: 12.
+     * @param {object} body - Data for updating the collection record.
      * @example
         {
           "formIdentifier": "collection-form",
@@ -161,8 +157,8 @@ export default class IntegrationCollectionsApi extends AsyncModules implements I
     /**
      * Deletion of collection record object
      * @handleName deleteICollectionRowByMarkerAndId
-     * @param {string} marker - text identifier of the collection Example: "collection1".
-     * @param {number} id - record identifier in the collection Example: 12.
+     * @param {string} marker - Marker of the collection. Example: "collection1".
+     * @param {number} id - ID of the collection row. Example: 12.
      * @returns {Promise<boolean | IError>} Returns true (in case of successful deletion) or false (in case of unsuccessful deletion) (permission "collections.row.delete" required for access)
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Deletion of collection record object