oneentry 1.0.173 → 1.0.174

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

@@ -17,7 +17,7 @@ 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 - Where the file lives in the storage. Required: without `type`, `entity` and `id` the endpoint answers `400 … should not be empty`.
+     * @param {IUploadingQuery} fileQuery - Where the file is stored. Required: without `type`, `entity` and `id` the endpoint answers `400 … should not be empty`.
      * @example
         {
           "type": "page",
@@ -28,9 +28,9 @@ interface IFileUploading {
           "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 {string} fileQuery.type - Storage type; determines the folder the file is stored in, for example `"page"`. Example: "page".
+     * @param {string} fileQuery.entity - Name of the entity the file belongs to; sets the folder name in the storage. Example: "editor".
+     * @param {number} fileQuery.id - ID of the object the file belongs to; sets 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.
@@ -43,7 +43,7 @@ interface IFileUploading {
      * Deletes a file from the cloud file storage.
      * @handleName delete
      * @param {string} [filename] - File name. Example: "file.png".
-     * @param {IUploadingQuery} fileQuery - Where the file lives in the storage. Required: without `type`, `entity` and `id` the endpoint answers `400 … should not be empty`.
+     * @param {IUploadingQuery} fileQuery - Where the file is stored. Required: without `type`, `entity` and `id` the endpoint answers `400 … should not be empty`.
      * @example
         {
           "type": "page",
@@ -51,9 +51,9 @@ interface IFileUploading {
           "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 {string} fileQuery.type - Storage type; determines the folder the file is stored in, for example `"page"`. Example: "page".
+     * @param {string} fileQuery.entity - Name of the entity the file belongs to; sets the folder name in the storage. Example: "editor".
+     * @param {number} fileQuery.id - ID of the object the file belongs to; sets the folder name in the storage. Example: 3787.
      * @param {number} [fileQuery.template] - preview template identifier. Example: 1.
      * @returns {boolean | IError} Returns a promise that resolves to true when the file was deleted 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.
@@ -62,11 +62,11 @@ interface IFileUploading {
     /**
      * 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".
+     * @param {number} id - ID of the object the file belongs to; sets the folder name in the storage. Example: 3787.
+     * @param {string} type - Storage type; determines the folder the file is stored in, for example `"page"`. Example: "page".
+     * @param {string} entity - Name of the entity the file belongs to; sets the folder name in the storage. Example: "editor".
+     * @param {string} filename - File name. Example: "file.png".
+     * @param {string} [template] - Preview template: its numeric ID or its marker, for example `"preview"`. Without it, no preview is generated. Example: "1".
      * @returns {Response | IError} Returns a promise that resolves to a Response 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.
      */
@@ -80,7 +80,7 @@ interface IFileUploading {
      * @param {string[]} [ownerTables] - Filter by the section the attached record belongs to. Example: ["products", "pages"].
      * @param {string[]} [localeCodes] - Filter by the locale of the link, not of the file content. Example: ["en_US"].
      * @param {boolean} [onlyTruncated] - Return only files whose extracted text was cut at the size ceiling.
-     * @param {number} [offset] - Parameter for pagination. Default: 0.
+     * @param {number} [offset] - Number of records to skip. Default: 0.
      * @param {number} [limit] - Parameter for pagination, 1 to 50. Default: 10.
      * @returns {IFileSearchResponse} Returns the found files with their matching fragments.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
@@ -100,13 +100,13 @@ 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 {string} type - Storage type; determines the folder the file is stored in, for example `"page"`. Example: "page".
+ * @property {string} entity - Name of the entity the file belongs to; sets the folder name in the storage. Example: "editor".
+ * @property {number} id - ID of the object the file belongs to; sets 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. `type`, `entity` and `id` are required by the endpoint: it answers `400 … should not be empty` without any of them (CMS-1085).
+ * @property {boolean} [compress] - Whether to compress (optimize) uploaded images. Example: true.
+ * @description Represents a query for uploading files, including type, entity, and optional parameters like width, height, and compression. `type`, `entity` and `id` are required by the endpoint: it answers `400 … should not be empty` without any of them.
  */
 interface IUploadingQuery {
     type: string;
@@ -117,7 +117,7 @@ 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 - File name with its 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 {string} contentType - MIME type of the uploaded file. Example: "image/png".
@@ -158,7 +158,7 @@ interface IFileSearchSnippet {
 /**
  * The `IFileSearchItem` interface describes one found file.
  * @interface IFileSearchItem
- * @property {number} id - Identifier of the indexed file. Example: 1077.
+ * @property {number} id - ID of the indexed file. Example: 1077.
  * @property {string} storageKey - Key of the object in the storage; the file link is built from it. Example: "files/project/file/644/product/db1918c4.pdf".
  * @property {string} extension - File extension. Example: "pdf".
  * @property {string | null} title - Title from the document metadata, `null` when the document carries none. Example: "Microsoft Word - COG Agenda.docx".
@@ -187,7 +187,7 @@ interface IFileSearchItem {
  * @interface IFileSearchQueryLanguage
  * @property {string[]} resolved - Languages the query was actually run in. Example: ["english"].
  * @property {string} source - How they were chosen: "explicit" when taken from `langCode`, otherwise detected. Example: "explicit".
- * @property {string[]} candidates - Languages considered. Example: ["english"].
+ * @property {string[]} candidates - Languages that were considered. Example: ["english"].
  * @description How the query language was resolved for the search.
  */
 interface IFileSearchQueryLanguage {
@@ -199,11 +199,11 @@ interface IFileSearchQueryLanguage {
  * The `IFileSearchResponse` interface describes the result of a file content search.
  * @interface IFileSearchResponse
  * @property {number} total - Total number of matching files. Example: 166.
- * @property {number} offset - Offset the page starts at. Example: 0.
- * @property {number} limit - Page size. Example: 10.
+ * @property {number} offset - Number of records to skip. Example: 0.
+ * @property {number} limit - Maximum number of records to return. Example: 10.
  * @property {IFileSearchQueryLanguage} queryLanguage - How the query language was resolved.
  * @property {string[]} warnings - Warnings about the search, empty when there are none.
- * @property {IFileSearchItem[]} items - The found files.
+ * @property {IFileSearchItem[]} items - Files that match the query.
  * @description The result of a file content search.
  */
 interface IFileSearchResponse {

package/esm/filters/filtersApi.d.ts

@@ -21,7 +21,7 @@ export default class FiltersApi extends AsyncModules implements IFiltersApi {
     /**
      * Get a filter by its marker (tree of items).
      * @handleName getFilterByMarker
-     * @param {string} marker - Filter marker. Example: "main".
+     * @param {string} marker - Marker of the filter. Example: "main".
      * @param {string} [langCode] - Language code. Default: "en_US".
      * @returns {Promise<IContentFilter | IError>} Returns the filter with its items tree.
      * @throws {IError} When isShell=false and an error occurs during the fetch

package/esm/filters/filtersApi.js

@@ -21,7 +21,7 @@ export default class FiltersApi extends AsyncModules {
     /**
      * Get a filter by its marker (tree of items).
      * @handleName getFilterByMarker
-     * @param {string} marker - Filter marker. Example: "main".
+     * @param {string} marker - Marker of the filter. Example: "main".
      * @param {string} [langCode] - Language code. Default: "en_US".
      * @returns {Promise<IContentFilter | IError>} Returns the filter with its items tree.
      * @throws {IError} When isShell=false and an error occurs during the fetch

package/esm/filters/filtersInterfaces.d.ts

@@ -8,7 +8,7 @@ interface IFiltersApi {
     /**
      * Get a filter by its marker (tree of items).
      * @handleName getFilterByMarker
-     * @param {string} marker - Filter marker. Example: "main".
+     * @param {string} marker - Marker of the filter. Example: "main".
      * @param {string} [langCode] - Language code. Default: "en_US".
      * @returns {Promise<IContentFilter | IError>} Returns the filter with its items tree.
      * @throws {IError} When isShell=false and an error occurs during the fetch
@@ -25,12 +25,12 @@ type TContentFilterItemType = 'page' | 'product' | 'admin' | 'attribute' | 'disc
  * Content filter item (tree node).
  * @interface IContentFilterItem
  * @property {TContentFilterItemType} type - Tree node type. Example: "page".
- * @property {string | null} [marker] - Marker of the linked entity, or null for type=page. Example: "about".
+ * @property {string | null} [marker] - Marker of the linked entity; `null` for `type=page`. Example: "about".
  * @property {string | null} [url] - Page URL (only for type=page; null otherwise). Example: "about".
- * @property {ILocalizeInfo} [localizeInfos] - Localized info of the linked entity in the requested locale.
+ * @property {ILocalizeInfo} [localizeInfos] - Localized data of the linked entity in the requested locale.
  * @property {string | string[] | null} [value] - Unified node value: an array of values in range for a range attribute, a resolved title for a legacy checkbox attribute, the discount value for discount/personal-discount/bonus, the object id for product/admin/payment-method, and null for a page. Example: ["25", "50", "75"].
- * @property {number} [position] - Numeric position (per-level). Example: 1.
- * @property {IContentFilterItem[]} [children] - Nested tree nodes (regular and custom items in a single array).
+ * @property {number} [position] - Position of the node among its siblings at the same level. Example: 1.
+ * @property {IContentFilterItem[]} [children] - Nested tree nodes; regular and custom items share one array.
  * @description A single node of a content filter items tree.
  */
 interface IContentFilterItem {
@@ -45,8 +45,8 @@ interface IContentFilterItem {
 /**
  * Content filter.
  * @interface IContentFilter
- * @property {ILocalizeInfo} localizeInfos - Localized info of the filter in the requested locale.
- * @property {IContentFilterItem[]} [items] - Filter items tree (regular items + custom items in a single array).
+ * @property {ILocalizeInfo} localizeInfos - Localized data of the filter in the requested locale.
+ * @property {IContentFilterItem[]} [items] - Tree of filter items: regular and custom items in one array.
  * @description A content filter with its localized info and items tree.
  */
 interface IContentFilter {

package/esm/forms/formsApi.d.ts

@@ -24,8 +24,8 @@ 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.
+     * @param {number} [offset] - Number of records to skip. Default: 0.
+     * @param {number} [limit] - Maximum number of records to return. Default: 30.
      * @returns {Promise<IFormsResponse | IError>} Returns paginated object with array of FormEntity and total count.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @see {@link https://js-sdk.oneentry.cloud/docs/forms/getAllForms getAllForms} documentation.
@@ -34,7 +34,7 @@ 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} marker - Marker of the form. Example: "contact_form".
      * @param {string} [langCode] - Language code. Default: "en_US".
      * @returns {Promise<IFormsEntity | IError>} Returns object of type FormEntity.
      * @throws {IError} When isShell=false and an error occurs during the fetch

package/esm/forms/formsApi.js

@@ -24,8 +24,8 @@ export default class FormsApi extends AsyncModules {
      * 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.
+     * @param {number} [offset] - Number of records to skip. Default: 0.
+     * @param {number} [limit] - Maximum number of records to return. Default: 30.
      * @returns {Promise<IFormsResponse | IError>} Returns paginated object with array of FormEntity and total count.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @see {@link https://js-sdk.oneentry.cloud/docs/forms/getAllForms getAllForms} documentation.
@@ -39,7 +39,7 @@ export default class FormsApi extends AsyncModules {
     /**
      * Get one form by form marker.
      * @handleName getFormByMarker
-     * @param {string} marker - Marker of form. Example: "contact_form".
+     * @param {string} marker - Marker of the form. Example: "contact_form".
      * @param {string} [langCode] - Language code. Default: "en_US".
      * @returns {Promise<IFormsEntity | IError>} Returns object of type FormEntity.
      * @throws {IError} When isShell=false and an error occurs during the fetch

package/esm/forms/formsInterfaces.d.ts

@@ -11,8 +11,8 @@ 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.
+     * @param {number} [offset] - Number of records to skip. Default: 0.
+     * @param {number} [limit] - Maximum number of records to return. 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.
@@ -32,7 +32,7 @@ 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} id - ID of the form data record. 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.
@@ -58,22 +58,22 @@ 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 {number} id - Object ID. Example: 12345.
+ * @property {number | null} attributeSetId - ID of the attribute set the form uses, or `null` if there is none. Example: 1234.
  * @property {string | null} type - Form type. Example: "contact".
- * @property {IFormLocalizeInfo} localizeInfos - The name of the form and form-side localization fields (success/error messages, processing config, etc.).
+ * @property {IFormLocalizeInfo} localizeInfos - Localized name of the form and form-side texts such as success and error messages.
  * @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 {number} version - Version number of the object; changes with each update. Example: 1.
+ * @property {number} position - Position of the object, used for sorting. Example: 1.
+ * @property {string} identifier - Text identifier (marker) of the object. Example: "form_contact_us".
+ * @property {string} processingType - How form submissions are processed, for example `"email"` or `"url"`. Example: "async".
+ * @property {number | null} templateId - ID of the template used by the form, or `null` when the form has no template. Example: 6789.
  * @property {IFormAttribute[]} attributes - Form fields with their localization, validators and form-specific flags, sorted by `position`. The API returns an empty object for forms with no attributes — the SDK normalizes it to an empty array.
  * @property {number | string} [total] - Total count of related entries. Example: "1".
- * @property {IFormConfig[]} [moduleFormConfigs] - Array of module form configurations associated with the form.
+ * @property {IFormConfig[]} [moduleFormConfigs] - Form configurations of the module associated with the form.
  * @description This interface defines the structure of a form entity, including its identifiers, attributes, and processing data.
  */
 interface IFormsEntity {
@@ -97,8 +97,8 @@ interface IFormsEntity {
  * @property {string} [successMessage] - Message shown to the user after successful submission.
  * @property {string} [unsuccessMessage] - Message shown to the user after a failed submission.
  * @property {string} [urlAddress] - URL where the form data is sent for processing (used by `processingType: "url"`).
- * @property {string} [database] - Database flag/id used by the form processor (stringly-typed in the API: "0" / "1" / id).
- * @property {string} [script] - Script flag/id used by the form processor (stringly-typed in the API: "0" / "1" / id).
+ * @property {string} [database] - Database flag or ID used by the form processor. The API sends it as a string: `"0"`, `"1"` or an ID.
+ * @property {string} [script] - Script flag or ID used by the form processor. The API sends it as a string: `"0"`, `"1"` or an ID.
  * @description Localization payload of a form — extends {@link ILocalizeInfo} with form-side fields (messages, processing config). Unlike the base type, `title` is optional here.
  */
 interface IFormLocalizeInfo extends Omit<ILocalizeInfo, 'title'> {
@@ -112,7 +112,7 @@ interface IFormLocalizeInfo extends Omit<ILocalizeInfo, 'title'> {
 }
 /**
  * @interface IFormAttribute
- * @property {string} marker - Field marker (machine name). Example: "email".
+ * @property {string} marker - Marker of the field. Example: "email".
  * @property {AttributeType} type - Attribute data type (e.g. "string", "file").
  * @property {number} position - Sort position of the field. Example: 1.
  * @property {boolean} isVisible - Whether the field is exposed to the user. Example: true.
@@ -122,14 +122,14 @@ interface IFormLocalizeInfo extends Omit<ILocalizeInfo, 'title'> {
  * @property {boolean} [multiselect] - For `list` fields — whether several options from `listTitles` may be selected. Optional. Example: false.
  * @property {IAttributeValidators} validators - Validation rules; empty object when no validators are configured.
  * @property {Record<string, unknown>} settings - Field-specific configuration; empty object by default.
- * @property {Record<string, IFormAttributeAdditionalField>} additionalFields - Nested sub-fields keyed by marker; empty object when none.
- * @property {boolean} [isLogin] - Whether this field carries the login value used for authentication. Optional — present only on attributes of sign-in/sign-up forms. Example: false.
- * @property {boolean} [isSignUp] - Whether this field is required during sign-up. Optional — present only on attributes of sign-in/sign-up forms. Example: false.
- * @property {boolean} [isPassword] - Whether this field carries the password value used for authentication. Optional — present only on attributes of sign-in/sign-up forms. Example: false.
- * @property {boolean} [isSignUpRequired] - Whether this field is required during sign-up. Optional — present only on attributes of sign-in/sign-up forms. Example: false.
- * @property {boolean} [isNotificationEmail] - Whether this field stores the email used for notifications. Optional — present only on attributes of sign-in/sign-up forms. Example: false.
- * @property {boolean} [isNotificationPhonePush] - Whether this field stores the phone number used for push notifications. Optional — present only on attributes of sign-in/sign-up forms. Example: false.
- * @property {boolean} [isNotificationPhoneSMS] - Whether this field stores the phone number used for SMS notifications. Optional — present only on attributes of sign-in/sign-up forms. Example: false.
+ * @property {Record<string, IFormAttributeAdditionalField>} additionalFields - Nested sub-fields keyed by marker; an empty object when there are none.
+ * @property {boolean} [isLogin] - Whether this field holds the login used for authentication. Present only on attributes of sign-in and sign-up forms. Example: false.
+ * @property {boolean} [isSignUp] - Whether this field is used during sign-up. Present only on attributes of sign-in and sign-up forms. Example: false.
+ * @property {boolean} [isPassword] - Whether this field holds the password used for authentication. Present only on attributes of sign-in and sign-up forms. Example: false.
+ * @property {boolean} [isSignUpRequired] - Whether this field is required during sign-up. Present only on attributes of sign-in and sign-up forms. Example: false.
+ * @property {boolean} [isNotificationEmail] - Whether this field holds the email used for notifications. Present only on attributes of sign-in and sign-up forms. Example: false.
+ * @property {boolean} [isNotificationPhonePush] - Whether this field holds the phone number used for push notifications. Present only on attributes of sign-in and sign-up forms. Example: false.
+ * @property {boolean} [isNotificationPhoneSMS] - Whether this field holds the phone number used for SMS notifications. Present only on attributes of sign-in and sign-up forms. Example: false.
  * @description Definition of a single field inside a form — extends a generic attribute with form-specific authentication / notification flags (returned only for sign-in/sign-up forms).
  */
 interface IFormAttribute {
@@ -168,26 +168,26 @@ interface IFormAttributeAdditionalField {
 /**
  * Represents the structure of a form configuration.
  * @interface IFormConfig
- * @property {number} id - The identifier of the form configuration. Example: 123.
- * @property {string} [formIdentifier] - The form identifier (only in products/pages API). Example: "review".
- * @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} [isModerate] - Indicates whether the form requires moderation (only in products/pages API). Example: false.
- * @property {boolean} [viewOnlyUserData] - Indicates whether the form configuration allows viewing user data (used in forms API). Example: true.
- * @property {boolean} [commentOnlyUserData] - Indicates whether the form configuration allows commenting on user data (used in forms API). Example: true.
+ * @property {number} id - ID of the form configuration. Example: 123.
+ * @property {string} [formIdentifier] - Marker of the form (products and pages API only). Example: "review".
+ * @property {string} moduleIdentifier - Marker of the module the form configuration belongs to. Example: "module_identifier".
+ * @property {boolean} isGlobal - Whether the form configuration is global. Example: true.
+ * @property {boolean} isClosed - Whether the form configuration is closed. Example: true.
+ * @property {boolean} [isModerate] - Whether the form requires moderation. Returned only by the Products and Pages APIs. Example: false.
+ * @property {boolean} [viewOnlyUserData] - Whether users see only the form data they submitted themselves. Example: true.
+ * @property {boolean} [commentOnlyUserData] - Whether commenting is limited to user data (forms API). Example: true.
  * @property {boolean} [viewOnlyMyData] - Indicates whether the form configuration allows viewing my data (used in products/pages API). Example: false.
- * @property {boolean} [commentOnlyMyData] - Indicates whether the form configuration allows commenting on my data (used in products/pages API). Example: false.
- * @property {object[]} entityIdentifiers - An array of entity identifiers associated with the form configuration.
+ * @property {boolean} [commentOnlyMyData] - Whether commenting is limited to the user's own data (products and pages API). Example: false.
+ * @property {object[]} entityIdentifiers - Entities the form configuration is attached to.
  * @property {string} entityIdentifiers[].id - Entity identifier. Example: "catalog".
  * @property {boolean} entityIdentifiers[].isNested - Indicates if entity is nested. Example: false.
- * @property {string[]} [nestedEntityIdentifiers] - An array of nested entity identifier strings (only in products/pages API). Example: ["catalog"].
- * @property {string[]} [exceptionIds] - An array of exception identifiers.
- * @property {number} [formDataCount] - Total count of form data entries (only in products/pages API). Example: 306.
- * @property {Record<string, number>} [entityFormDataCount] - Form data count per entity identifier (only in products/pages API). Example: `{"catalog": 306}`.
- * @property {boolean | null} [isRating] - Indicates whether this form config is for ratings. Example: null.
- * @property {boolean | null} [isAnonymous] - Indicates whether anonymous submissions are allowed. Example: null.
- * @property {boolean | null} [allowHalfRatings] - Indicates whether half ratings are allowed. Example: null.
+ * @property {string[]} [nestedEntityIdentifiers] - Markers of nested entities. Returned only by the Products and Pages APIs. Example: ["catalog"].
+ * @property {string[]} [exceptionIds] - Exception IDs.
+ * @property {number} [formDataCount] - Total number of form records (products and pages API only). Example: 306.
+ * @property {Record<string, number>} [entityFormDataCount] - Number of form records per entity ID (products and pages API only). Example: `{"catalog": 306}`.
+ * @property {boolean | null} [isRating] - Whether this form configuration collects ratings. Example: null.
+ * @property {boolean | null} [isAnonymous] - Whether anonymous submissions are allowed. Example: null.
+ * @property {boolean | null} [allowHalfRatings] - Whether half-star ratings are allowed. Example: null.
  * @property {boolean | null} [allowRerating] - Indicates whether re-rating is allowed. Example: null.
  * @property {number | null} [maxRatingScale] - Maximum rating scale value. Example: 5.
  * @property {string} [ratingCalculation] - Rating calculation method. Example: "average".
@@ -229,8 +229,8 @@ interface IEntityIdentifier {
 /**
  * Represents the paginated response structure for forms.
  * @interface IFormsResponse
- * @property {number} total - Total items count.
- * @property {IFormsEntity[]} items - Array of form entities.
+ * @property {number} total - Total number of forms.
+ * @property {IFormsEntity[]} items - Forms in this response.
  */
 interface IFormsResponse {
     total: number;

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

@@ -39,9 +39,9 @@ export default class FormsDataApi extends AsyncModules implements 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.
+     * @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
         [
           {
@@ -81,7 +81,7 @@ export default class FormsDataApi extends AsyncModules implements IFormsData {
      * 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.
      */
     private _stripContentType;
     /**
@@ -103,8 +103,8 @@ 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 {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",
@@ -120,10 +120,10 @@ export default class FormsDataApi extends AsyncModules implements IFormsData {
      * @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`.
@@ -137,7 +137,7 @@ export default class FormsDataApi extends AsyncModules implements IFormsData {
     /**
      * 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.
      */
@@ -145,7 +145,7 @@ export default class FormsDataApi extends AsyncModules implements IFormsData {
     /**
      * 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.
@@ -154,7 +154,7 @@ export default class FormsDataApi extends AsyncModules implements IFormsData {
     /**
      * 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.
      */
@@ -162,10 +162,10 @@ export default class FormsDataApi extends AsyncModules implements 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
      * @description This method performs a semantic (vector) search for form data.

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.