oneentry 1.0.172 → 1.0.174

package/dist/subscriptions/subscriptionsInterfaces.d.ts

@@ -8,7 +8,7 @@ interface ISubscriptionsApi {
     /**
      * Create a new subscription and get a payment session for it.
      * @handleName subscribe
-     * @param {ISubscribe} body - Subscription body. Example: `{ marker: "premium" }`.
+     * @param {ISubscribe} body - Subscription parameters. Example: `{ marker: "premium" }`.
      * @returns {Promise<ICreatedSubscription | IError>} Returns the created payment session for the subscription.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This method requires user authorization.
@@ -18,7 +18,7 @@ interface ISubscriptionsApi {
     /**
      * Cancel a subscription.
      * @handleName cancelSubscription
-     * @param {ICancelSubscription} body - Subscription body. Example: `{ marker: "premium" }`.
+     * @param {ICancelSubscription} body - Subscription parameters. Example: `{ marker: "premium" }`.
      * @returns {Promise<boolean | IError>} Returns true if the subscription was cancelled, or an error object if there was an issue.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This method requires user authorization.
@@ -46,7 +46,7 @@ interface ISubscriptionsApi {
     /**
      * Recover a subscription through the Stripe Billing Portal.
      * @handleName recoverSubscriptions
-     * @param {ICancelSubscription} body - Subscription body. Example: `{ marker: "premium" }`.
+     * @param {ICancelSubscription} body - Subscription parameters. Example: `{ marker: "premium" }`.
      * @returns {Promise<boolean | IError>} Returns true if the recovery request was accepted, or an error object if there was an issue.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This method requires user authorization.
@@ -57,7 +57,7 @@ interface ISubscriptionsApi {
 /**
  * Body for creating a subscription.
  * @interface ISubscribe
- * @property {string} marker - Subscription marker. Example: "premium".
+ * @property {string} marker - Marker of the subscription. Example: "premium".
  * @description Body for creating a subscription.
  */
 interface ISubscribe {
@@ -66,7 +66,7 @@ interface ISubscribe {
 /**
  * Body for cancelling or recovering a subscription.
  * @interface ICancelSubscription
- * @property {string} marker - Subscription marker. Example: "premium".
+ * @property {string} marker - Marker of the subscription. Example: "premium".
  * @description Body for cancelling or recovering a subscription.
  */
 interface ICancelSubscription {
@@ -75,7 +75,7 @@ interface ICancelSubscription {
 /**
  * Created subscription payment session.
  * @interface ICreatedSubscription
- * @property {number} id - Payment session identifier. Example: 1.
+ * @property {number} id - Payment session ID. Example: 1.
  * @property {number} amount - Amount to be paid. Example: 100.
  * @property {string} paymentUrl - Payment page URL. Example: "https://checkout.stripe.com/c/pay/...".
  * @property {string} status - Payment session status. Example: "waiting".
@@ -90,13 +90,13 @@ interface ICreatedSubscription {
 /**
  * Available subscription.
  * @interface ISubscriptionEntity
- * @property {number} id - Subscription identifier. Example: 1.
- * @property {string} identifier - Subscription textual identifier (marker). Example: "test_subscription".
- * @property {ILocalizeInfo} localizeInfos - Localized subscription info for the current language. Example: `{ title: "Test subscription" }`.
- * @property {number[]} productIds - Identifiers of the products included in the subscription. Example: [3445].
+ * @property {number} id - Subscription ID. Example: 1.
+ * @property {string} identifier - Marker of the subscription. Example: "test_subscription".
+ * @property {ILocalizeInfo} localizeInfos - Localized data of the subscription in the current language. Example: `{ title: "Test subscription" }`.
+ * @property {number[]} productIds - IDs of the products included in the subscription. Example: [3445].
  * @property {number} periodInDays - Subscription period in days. Example: 30.
  * @property {number} paymentAccountId - Identifier of the payment account the subscription is billed through. Example: 1.
- * @property {boolean} isUsed - Indicates whether the subscription is in use. Example: false.
+ * @property {boolean} isUsed - Whether the subscription is in use. Example: false.
  * @description Subscription configured in the project, returned by getAllSubscriptions.
  */
 interface ISubscriptionEntity {

package/dist/system/systemApi.d.ts

@@ -1,7 +1,7 @@
 import AsyncModules from '../base/asyncModules';
 import type StateModule from '../base/stateModule';
 import type { IError } from '../base/utils';
-import type { ISystemApi } from './systemInterfaces';
+import type { IApiStatEntry, ISystemApi } from './systemInterfaces';
 /**
  * Controllers for working with system components
  * @handle /api/content/system
@@ -37,10 +37,10 @@ export default class SystemApi extends AsyncModules implements ISystemApi {
     /**
      * Getting the number of requests to API.
      * @handleName getApiStat
-     * @returns {Promise<unknown | IError>} Return object with date and count.
+     * @returns {Promise<IApiStatEntry[] | IError>} Array of one-key objects `{ [YYYY-MM-DD]: count }`, one per day. Example: `[{ "2026-10-25": 17280 }, { "2026-10-26": 13671 }]`.
      * @throws {IError} When isShell=false and an error occurs during the fetch
-     * @description Getting the number of requests to API.
+     * @description Getting the number of requests to API, per day.
      * @see {@link https://js-sdk.oneentry.cloud/docs/system/getApiStat getApiStat} documentation.
      */
-    getApiStat(): Promise<unknown>;
+    getApiStat(): Promise<IApiStatEntry[] | IError>;
 }

package/dist/system/systemApi.js

@@ -46,9 +46,9 @@ class SystemApi extends asyncModules_1.default {
     /**
      * Getting the number of requests to API.
      * @handleName getApiStat
-     * @returns {Promise<unknown | IError>} Return object with date and count.
+     * @returns {Promise<IApiStatEntry[] | IError>} Array of one-key objects `{ [YYYY-MM-DD]: count }`, one per day. Example: `[{ "2026-10-25": 17280 }, { "2026-10-26": 13671 }]`.
      * @throws {IError} When isShell=false and an error occurs during the fetch
-     * @description Getting the number of requests to API.
+     * @description Getting the number of requests to API, per day.
      * @see {@link https://js-sdk.oneentry.cloud/docs/system/getApiStat getApiStat} documentation.
      */
     async getApiStat() {

package/dist/system/systemInterfaces.d.ts

@@ -19,11 +19,17 @@ interface ISystemApi {
      */
     test500(): Promise<unknown | IError>;
     /**
-     * getApiStat
+     * Getting the number of requests to API.
      * @handleName getApiStat
-     * @returns {unknown} Returns a Promise that resolves with any data.
-     * @description This method getApiStat.
+     * @returns {Promise<IApiStatEntry[] | IError>} Array of one-key objects `{ [YYYY-MM-DD]: count }`, one per day. Example: `[{ "2026-10-25": 17280 }, { "2026-10-26": 13671 }]`.
+     * @description Getting the number of requests to API, per day.
      */
-    getApiStat(): Promise<unknown>;
+    getApiStat(): Promise<IApiStatEntry[] | IError>;
 }
-export type { ISystemApi };
+/**
+ * One day of API request statistics: a single key — the date `YYYY-MM-DD` — holding the number of requests.
+ * @typedef {Record<string, number>} IApiStatEntry
+ * @description Element of the array returned by getApiStat. Example: `{ "2026-10-26": 13671 }`.
+ */
+type IApiStatEntry = Record<string, number>;
+export type { IApiStatEntry, ISystemApi };

package/dist/templates/templatesApi.d.ts

@@ -22,7 +22,7 @@ export default class TemplatesPreviewApi extends AsyncModules implements ITempla
      * Get all template objects grouped by types.
      * @handleName getAllTemplates
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @returns {Promise<Record<BlockType, ITemplateEntity[]> | IError>} Returns an object GroupedTemplatesObject, which contains an array of template objects TemplateEntity
+     * @returns {Promise<Record<BlockType, ITemplateEntity[]> | IError>} Object keyed by `BlockType`; each value is an array of `ITemplateEntity` of that type.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This function is designed to fetch organized template objects in groups based on their types.
      * @see {@link https://js-sdk.oneentry.cloud/docs/templates/getAllTemplates getAllTemplates} documentation.
@@ -31,9 +31,9 @@ export default class TemplatesPreviewApi extends AsyncModules implements ITempla
     /**
      * Get template objects by type.
      * @handleName getTemplateByType
-     * @param {BlockType} type - The type of templates to retrieve. This parameter specifies the category or classification of templates being requested. Example: "product".
+     * @param {BlockType} type - Type of templates to fetch. Example: "product".
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @returns {Promise<ITemplateEntity[] | IError>} Returns a TemplateEntity object.
+     * @returns {Promise<ITemplateEntity[] | IError>} Array of `ITemplateEntity` objects of the given type.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Fetch template objects that belong to a specific type, with an optional filter by language.
      * @see {@link https://js-sdk.oneentry.cloud/docs/templates/getTemplateByType getTemplateByType} documentation.
@@ -42,9 +42,9 @@ export default class TemplatesPreviewApi extends AsyncModules implements ITempla
     /**
      * Get one template object by marker.
      * @handleName getTemplateByMarker
-     * @param {string} marker - The unique marker of the template to retrieve. Example: "template_12345".
+     * @param {string} marker - Marker of the template to fetch. Example: "template_12345".
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @returns {Promise<ITemplateEntity | IError>} Returns a TemplateEntity object
+     * @returns {Promise<ITemplateEntity | IError>} Returns an `ITemplateEntity` object
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Fetch a specific template object based on its unique marker.
      * @see {@link https://js-sdk.oneentry.cloud/docs/templates/getTemplateByMarker getTemplateByMarker} documentation.

package/dist/templates/templatesApi.js

@@ -60,7 +60,7 @@ class TemplatesPreviewApi extends asyncModules_1.default {
      * Get all template objects grouped by types.
      * @handleName getAllTemplates
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @returns {Promise<Record<BlockType, ITemplateEntity[]> | IError>} Returns an object GroupedTemplatesObject, which contains an array of template objects TemplateEntity
+     * @returns {Promise<Record<BlockType, ITemplateEntity[]> | IError>} Object keyed by `BlockType`; each value is an array of `ITemplateEntity` of that type.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This function is designed to fetch organized template objects in groups based on their types.
      * @see {@link https://js-sdk.oneentry.cloud/docs/templates/getAllTemplates getAllTemplates} documentation.
@@ -84,9 +84,9 @@ class TemplatesPreviewApi extends asyncModules_1.default {
     /**
      * Get template objects by type.
      * @handleName getTemplateByType
-     * @param {BlockType} type - The type of templates to retrieve. This parameter specifies the category or classification of templates being requested. Example: "product".
+     * @param {BlockType} type - Type of templates to fetch. Example: "product".
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @returns {Promise<ITemplateEntity[] | IError>} Returns a TemplateEntity object.
+     * @returns {Promise<ITemplateEntity[] | IError>} Array of `ITemplateEntity` objects of the given type.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Fetch template objects that belong to a specific type, with an optional filter by language.
      * @see {@link https://js-sdk.oneentry.cloud/docs/templates/getTemplateByType getTemplateByType} documentation.
@@ -100,9 +100,9 @@ class TemplatesPreviewApi extends asyncModules_1.default {
     /**
      * Get one template object by marker.
      * @handleName getTemplateByMarker
-     * @param {string} marker - The unique marker of the template to retrieve. Example: "template_12345".
+     * @param {string} marker - Marker of the template to fetch. Example: "template_12345".
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @returns {Promise<ITemplateEntity | IError>} Returns a TemplateEntity object
+     * @returns {Promise<ITemplateEntity | IError>} Returns an `ITemplateEntity` object
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Fetch a specific template object based on its unique marker.
      * @see {@link https://js-sdk.oneentry.cloud/docs/templates/getTemplateByMarker getTemplateByMarker} documentation.

package/dist/templates/templatesInterfaces.d.ts

@@ -9,7 +9,7 @@ interface ITemplatesApi {
      * Get all template objects grouped by types.
      * @handleName getAllTemplates
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @returns {Record<BlockType, ITemplateEntity[]>} Returns an object GroupedTemplatesObject, which contains an array of template objects TemplateEntity
+     * @returns {Record<BlockType, ITemplateEntity[]>} Object keyed by `BlockType`; each value is an array of `ITemplateEntity` of that type.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      * @description This method gets all template objects grouped by types.
      */
@@ -17,9 +17,9 @@ interface ITemplatesApi {
     /**
      * Get template objects by type.
      * @handleName getTemplateByType
-     * @param {BlockType} type - The type of templates to retrieve. This parameter specifies the category or classification of templates being requested. Example: "product".
+     * @param {BlockType} type - Type of templates to fetch. Example: "product".
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @returns {ITemplateEntity[]} Returns a TemplateEntity object.
+     * @returns {ITemplateEntity[]} Array of `ITemplateEntity` objects of the given type.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      * @description This method gets template objects by type.
      */
@@ -27,9 +27,9 @@ interface ITemplatesApi {
     /**
      * Get one template object by id.
      * @handleName getTemplateByMarker
-     * @param {string} marker - The unique marker of the template to retrieve. Example: "template_12345".
+     * @param {string} marker - Marker of the template to fetch. Example: "template_12345".
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @returns {ITemplateEntity} Returns a TemplateEntity object
+     * @returns {ITemplateEntity} Returns an `ITemplateEntity` object
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      * @description This method gets one template object by id.
      */
@@ -38,20 +38,20 @@ interface ITemplatesApi {
 /**
  * The template entity interface
  * @interface ITemplateEntity
- * @property {number} id - The unique identifier of the position. Example: 12345.
- * @property {string | null} attributeSetIdentifier - Set of attributes id. Example: "attribute_set_1".
- * @property {string} title - The name of the template. Example: "Product Template".
- * @property {number} generalTypeId - General type Entity id. Example: 67890.
- * @property {string} identifier - The textual identifier for the record field. Example: "template_12345".
- * @property {number} version - The version number of the object. Example: 1.
+ * @property {number} id - ID of the object. Example: 12345.
+ * @property {string | null} attributeSetIdentifier - Marker of the attribute set, or `null` if none is assigned. Example: "attribute_set_1".
+ * @property {string} title - Name of the template. Example: "Product Template".
+ * @property {number} generalTypeId - ID of the general type. Example: 67890.
+ * @property {string} identifier - Text identifier (marker) of the object. Example: "template_12345".
+ * @property {number} version - Version number of the object; changes with each update. Example: 1.
  * @property {BlockType} generalTypeName - General type name. Example: "product".
- * @property {IAttributeValues} attributeValues - Map of attribute values keyed by marker; empty object when none.
+ * @property {IAttributeValues} attributeValues - Attribute values keyed by marker; an empty object when there are none.
  * @example
     {
       "id": 1,
       "value": "some"
     }
- * @property {number} position - The position of the object. Example: 1.
+ * @property {number} position - Position of the object, used for sorting. Example: 1.
  * @description This interface defines the structure of a template entity, including its identifiers, attributes, and general type information.
  */
 interface ITemplateEntity {

package/dist/templates-preview/templatesPreviewApi.d.ts

@@ -29,7 +29,7 @@ export default class TemplatePreviewsApi extends AsyncModules implements ITempla
     /**
      * Retrieves a template object by its marker.
      * @handleName getTemplatePreviewByMarker
-     * @param {string} marker - The unique product marker used to identify the template. If not provided, a default behavior or error may occur. Example: "template_12345".
+     * @param {string} marker - Marker of the template preview to fetch. Example: "template_12345".
      * @param {string} [langCode] - Language code. Default: "en_US".
      * @returns {Promise<ITemplatesPreviewEntity | IError>} - A promise that resolves to a TemplatePreviewsEntity object representing the template.
      * @throws {IError} When isShell=false and an error occurs during the fetch

package/dist/templates-preview/templatesPreviewApi.js

@@ -72,7 +72,7 @@ class TemplatePreviewsApi extends asyncModules_1.default {
     /**
      * Retrieves a template object by its marker.
      * @handleName getTemplatePreviewByMarker
-     * @param {string} marker - The unique product marker used to identify the template. If not provided, a default behavior or error may occur. Example: "template_12345".
+     * @param {string} marker - Marker of the template preview to fetch. Example: "template_12345".
      * @param {string} [langCode] - Language code. Default: "en_US".
      * @returns {Promise<ITemplatesPreviewEntity | IError>} - A promise that resolves to a TemplatePreviewsEntity object representing the template.
      * @throws {IError} When isShell=false and an error occurs during the fetch

package/dist/templates-preview/templatesPreviewInterfaces.d.ts

@@ -6,7 +6,7 @@ import type { IError } from '../base/utils';
 interface ITemplatesPreviewApi {
     /**
      * Retrieves all template preview objects.
-     * @param {string} langCode - Language code for localization. Default: "en_US".
+     * @param {string} langCode - Language code. Default: "en_US".
      * @returns {ITemplatesPreviewEntity[]} A promise resolving to an array of template preview entities or an error.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      */
@@ -15,7 +15,7 @@ interface ITemplatesPreviewApi {
      * Retrieves a specific template preview object by its marker.
      * @handleName getTemplatePreviewByMarker
      * @param {string} marker     - The marker of the template preview. Example: "template_12345".
-     * @param {string} [langCode] - Language code for localization. Default: "en_US".
+     * @param {string} [langCode] - Language code. Default: "en_US".
      * @returns {ITemplatesPreviewEntity | IError} A promise resolving to the template preview entity or an error.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      * @description This method retrieves a specific template preview object by its marker.
@@ -25,9 +25,9 @@ interface ITemplatesPreviewApi {
 /**
  * The `ITemplatesPreview` interface defines the structure of template preview entities.
  * @interface ITemplatesPreviewEntity
- * @property {number} id - The unique identifier of the position. Example: 3.
- * @property {string} title - The name of the template preview. Example: "Product Template"..
- * @property {object} proportions - Object contains info by proportions template preview.
+ * @property {number} id - ID of the object. Example: 3.
+ * @property {string} title - Name of the preview template. Example: "Product Template".
+ * @property {object} proportions - Preview proportions: the horizontal, vertical and square variants.
  * @example
     {
       "default": {
@@ -47,30 +47,30 @@ interface ITemplatesPreviewApi {
         }
       }
     }
- * @property {IProportion | null} proportions.horizontal - Horizontal proportion of the template preview.
+ * @property {IProportion | null} proportions.horizontal - Horizontal proportion of the preview.
  * @example
     {
       "width": 234,
       "height": 324,
       "alignmentType": "middleBottom"
     }
- * @property {IProportion | null} proportions.vertical - Vertical proportion of the template preview.
+ * @property {IProportion | null} proportions.vertical - Vertical variant of the preview, or `null`.
  * @example
     {
       "width": 2,
       "height": 3,
       "alignmentType": "leftTop"
     }
- * @property {ISquare} proportions.square - Square proportion of the template preview.
+ * @property {ISquare} proportions.square - Square variant of the preview.
  * @example
     {
       "side": 3,
       "alignmentType": "leftTop"
     }
- * @property {string} identifier - The textual identifier for the record field. Example: "preview-templates"
- * @property {number} version - The version number of the object. Example: 1.
- * @property {number} position - The position of the object. Example: 1.
- * @property {boolean} isUsed - Indicates whether the template preview is used. Example: true.
+ * @property {string} identifier - Text identifier (marker) of the object. Example: "preview-templates"
+ * @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 {boolean} isUsed - Whether the template preview is in use. Example: true.
  * @description This interface defines the structure of a template preview entity, including its identifiers, attributes, proportions, and title.
  */
 interface ITemplatesPreviewEntity {
@@ -105,9 +105,9 @@ interface ITemplatesPreviewProportionVariants {
 /**
  * The `IProportion` interface defines the structure of a proportion object used in template previews.
  * @interface IProportion
- * @property {string | number | null} width - width of the template preview. Example: 100.
- * @property {string | number | null} height - height of the template preview. Example: 200.
- * @property {string} alignmentType - alignment type of the template preview. Example: "center".
+ * @property {string | number | null} width - Width of the preview. Example: 100.
+ * @property {string | number | null} height - Height of the preview. Example: 200.
+ * @property {string} alignmentType - Alignment of the preview, such as `center`. Example: "center".
  * @description Represents a proportion object used in template previews.
  */
 interface IProportion {
@@ -118,8 +118,8 @@ interface IProportion {
 /**
  * The `ISquare` interface defines the structure of a square proportion object used in template previews.
  * @interface ISquare
- * @property {number | string} side - Side length of the square template preview, can be a number or string. Example: 100.
- * @property {string} alignmentType - Alignment type of the square template preview. Example: "center".
+ * @property {number | string} side - Side length of the square preview, as a number or a string. Example: 100.
+ * @property {string} alignmentType - Alignment of the square preview, such as `center`. Example: "center".
  * @description Represents a square proportion object used in template previews.
  */
 interface ISquare {

package/dist/user-activity/userActivityApi.d.ts

@@ -21,7 +21,7 @@ export default class UserActivityApi extends AsyncModules implements IUserActivi
     /**
      * Track a user or guest activity event.
      * @handleName trackUserActivity
-     * @param {ITrackActivity} body - Activity event body. Example: `{ type: "product_view", productId: 12345 }`.
+     * @param {ITrackActivity} body - Activity event to record. Example: `{ type: "product_view", productId: 12345 }`.
      * @returns {Promise<boolean | IError>} Returns true if the event was recorded, or an error object if there was an issue.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Records an activity event for the current authorized user or guest.

package/dist/user-activity/userActivityApi.js

@@ -24,7 +24,7 @@ class UserActivityApi extends asyncModules_1.default {
     /**
      * Track a user or guest activity event.
      * @handleName trackUserActivity
-     * @param {ITrackActivity} body - Activity event body. Example: `{ type: "product_view", productId: 12345 }`.
+     * @param {ITrackActivity} body - Activity event to record. Example: `{ type: "product_view", productId: 12345 }`.
      * @returns {Promise<boolean | IError>} Returns true if the event was recorded, or an error object if there was an issue.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Records an activity event for the current authorized user or guest.

package/dist/user-activity/userActivityInterfaces.d.ts

@@ -8,7 +8,7 @@ interface IUserActivityApi {
     /**
      * Track a user or guest activity event.
      * @handleName trackUserActivity
-     * @param {ITrackActivity} body - Activity event body. Example: `{ type: "product_view", productId: 12345 }`.
+     * @param {ITrackActivity} body - Activity event to record. Example: `{ type: "product_view", productId: 12345 }`.
      * @returns {Promise<boolean | IError>} Returns true if the event was recorded, or an error object if there was an issue.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Records an activity event for the current authorized user or guest.
@@ -24,9 +24,9 @@ type TUserActivityType = 'product_view' | 'page_view' | 'category_view' | 'searc
  * Body for tracking a user activity event.
  * @interface ITrackActivity
  * @property {TUserActivityType} type - Activity event type. Example: "product_view".
- * @property {number} [productId] - Product identifier. Example: 12345.
- * @property {number} [pageId] - Page identifier (for page_view, category_view). Example: 7.
- * @property {number} [categoryId] - Legacy category identifier. Example: 67.
+ * @property {number} [productId] - Product ID. Example: 12345.
+ * @property {number} [pageId] - ID of the page, for `page_view` and `category_view` events. Example: 7.
+ * @property {number} [categoryId] - Category ID (legacy). Example: 67.
  * @property {string} [query] - Search query (for type=search). Example: "iphone case".
  * @property {Record<string, unknown>} [meta] - Arbitrary meta information (source block, A/B variant, scroll-depth).
  * @description Body for tracking a user activity event.

package/dist/user-groups/userGroupsApi.d.ts

@@ -47,7 +47,7 @@ export default class UserGroupsApi extends AsyncModules implements IUserGroups {
     /**
      * Get a single user group object by its identifier.
      * @handleName getUserGroupById
-     * @param {number} id - Identifier of the user group. Example: 1.
+     * @param {number} id - User group ID. Example: 1.
      * @param {string} [langCode] - Language code. Default: "en_US".
      * @returns {Promise<IUserGroupEntity | IError>} Returns a single user group object.
      * @throws {IError} When isShell=false and an error occurs during the fetch

package/dist/user-groups/userGroupsApi.js

@@ -95,7 +95,7 @@ class UserGroupsApi extends asyncModules_1.default {
     /**
      * Get a single user group object by its identifier.
      * @handleName getUserGroupById
-     * @param {number} id - Identifier of the user group. Example: 1.
+     * @param {number} id - User group ID. Example: 1.
      * @param {string} [langCode] - Language code. Default: "en_US".
      * @returns {Promise<IUserGroupEntity | IError>} Returns a single user group object.
      * @throws {IError} When isShell=false and an error occurs during the fetch

package/dist/user-groups/userGroupsInterfaces.d.ts

@@ -27,7 +27,7 @@ interface IUserGroups {
     /**
      * Get a single user group object by its identifier.
      * @handleName getUserGroupById
-     * @param {number} id - Identifier of the user group. Example: 1.
+     * @param {number} id - User group ID. Example: 1.
      * @param {string} [langCode] - Language code. Default: "en_US".
      * @returns {IUserGroupEntity} Returns a single user group object.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
@@ -58,12 +58,12 @@ interface IUserGroups {
 /**
  * The `IUserGroupEntity` interface defines the structure of a user group object.
  * @interface IUserGroupEntity
- * @property {number} id - Identifier of the user group. Example: 1.
+ * @property {number} id - User group ID. Example: 1.
  * @property {number} depth - Nesting depth relative to the parent. Example: 0.
  * @property {number | null} parentId - Identifier of the parent group, `null` for a top-level group. Example: null.
- * @property {ILocalizeInfo} localizeInfos - Title of the group, taking localization into account.
- * @property {boolean} isVisible - Visibility flag. Example: true.
- * @property {string} childrenCount - Number of child groups. The API sends it as a **string**, not a number. Example: "0".
+ * @property {ILocalizeInfo} localizeInfos - Localized title of the group.
+ * @property {boolean} isVisible - Whether the group is visible. Example: true.
+ * @property {string} childrenCount - Number of child groups. The API sends it as a string, not a number. Example: "0".
  * @property {string} identifier - Text identifier (marker) of the group. Example: "guest".
  * @property {boolean} isSync - Synchronization flag. Example: false.
  * @property {IAttributeValues} attributeValues - Attribute values of the group.

package/dist/users/usersApi.d.ts

@@ -127,7 +127,7 @@ export default class UsersApi extends AsyncModules implements IUsersApi {
     /**
      * Adds an FCM (Firebase Cloud Messaging) token for sending push notifications.
      * @handleName addFCMToken
-     * @param {string} token - The cloud messaging token to be added. This token is used to identify the user's device for push notifications. Example: "fcm_token_1234567890abcdefg".
+     * @param {string} token - Firebase Cloud Messaging token that identifies the user's device for push notifications. Example: "fcm_token_1234567890abcdefg".
      * @returns {Promise<boolean | IError>} Returns `true` if the token was successfully added; otherwise, returns an error object.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This method adds an FCM token for sending push notifications. This method requires user authorization.
@@ -138,7 +138,7 @@ export default class UsersApi extends AsyncModules implements IUsersApi {
     /**
      * Deletes an FCM (Firebase Cloud Messaging) token.
      * @handleName deleteFCMToken
-     * @param {string} token - The cloud messaging token to be deleted. This token is used to identify the user's device for push notifications and will be removed. Example: "fcm_token_1234567890abcdefg".
+     * @param {string} token - Firebase Cloud Messaging token to remove from the user's devices. Example: "fcm_token_1234567890abcdefg".
      * @returns {Promise<boolean | IError>} Returns `true` if the token was successfully deleted; otherwise, returns an error object.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This method deletes an existing FCM token. This method requires user authorization.
@@ -181,7 +181,7 @@ export default class UsersApi extends AsyncModules implements IUsersApi {
     /**
      * Remove an item from the cart.
      * @handleName removeCartItem
-     * @param {number} productId - Product identifier. Example: 12345.
+     * @param {number} productId - Product ID. Example: 12345.
      * @returns {Promise<ICartResponse | IError>} Returns the updated cart.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This method requires user authorization (or a guest context).
@@ -224,7 +224,7 @@ export default class UsersApi extends AsyncModules implements IUsersApi {
     /**
      * Remove an item from the wishlist.
      * @handleName removeWishlistItem
-     * @param {number} productId - Product identifier. Example: 12345.
+     * @param {number} productId - Product ID. Example: 12345.
      * @returns {Promise<IWishlistResponse | IError>} Returns the updated wishlist.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This method requires user authorization (or a guest context).
@@ -235,10 +235,10 @@ export default class UsersApi extends AsyncModules implements IUsersApi {
     /**
      * Semantic (vector) search for users.
      * @handleName getUsersByVectorSearch
-     * @param {IUsersVectorSearch} body - Vector search body. Example: `{ queryText: "john" }`.
+     * @param {IUsersVectorSearch} body - Vector search parameters. Example: `{ queryText: "john" }`.
      * @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<IUsersResponse> | IError>} Returns an object with an array of found users and total count.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This method performs a semantic (vector) search for users. It requires user authorization.

package/dist/users/usersApi.js

@@ -182,7 +182,7 @@ class UsersApi extends asyncModules_1.default {
     /**
      * Adds an FCM (Firebase Cloud Messaging) token for sending push notifications.
      * @handleName addFCMToken
-     * @param {string} token - The cloud messaging token to be added. This token is used to identify the user's device for push notifications. Example: "fcm_token_1234567890abcdefg".
+     * @param {string} token - Firebase Cloud Messaging token that identifies the user's device for push notifications. Example: "fcm_token_1234567890abcdefg".
      * @returns {Promise<boolean | IError>} Returns `true` if the token was successfully added; otherwise, returns an error object.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This method adds an FCM token for sending push notifications. This method requires user authorization.
@@ -196,7 +196,7 @@ class UsersApi extends asyncModules_1.default {
     /**
      * Deletes an FCM (Firebase Cloud Messaging) token.
      * @handleName deleteFCMToken
-     * @param {string} token - The cloud messaging token to be deleted. This token is used to identify the user's device for push notifications and will be removed. Example: "fcm_token_1234567890abcdefg".
+     * @param {string} token - Firebase Cloud Messaging token to remove from the user's devices. Example: "fcm_token_1234567890abcdefg".
      * @returns {Promise<boolean | IError>} Returns `true` if the token was successfully deleted; otherwise, returns an error object.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This method deletes an existing FCM token. This method requires user authorization.
@@ -254,7 +254,7 @@ class UsersApi extends asyncModules_1.default {
     /**
      * Remove an item from the cart.
      * @handleName removeCartItem
-     * @param {number} productId - Product identifier. Example: 12345.
+     * @param {number} productId - Product ID. Example: 12345.
      * @returns {Promise<ICartResponse | IError>} Returns the updated cart.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This method requires user authorization (or a guest context).
@@ -313,7 +313,7 @@ class UsersApi extends asyncModules_1.default {
     /**
      * Remove an item from the wishlist.
      * @handleName removeWishlistItem
-     * @param {number} productId - Product identifier. Example: 12345.
+     * @param {number} productId - Product ID. Example: 12345.
      * @returns {Promise<IWishlistResponse | IError>} Returns the updated wishlist.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This method requires user authorization (or a guest context).
@@ -328,10 +328,10 @@ class UsersApi extends asyncModules_1.default {
     /**
      * Semantic (vector) search for users.
      * @handleName getUsersByVectorSearch
-     * @param {IUsersVectorSearch} body - Vector search body. Example: `{ queryText: "john" }`.
+     * @param {IUsersVectorSearch} body - Vector search parameters. Example: `{ queryText: "john" }`.
      * @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<IUsersResponse> | IError>} Returns an object with an array of found users and total count.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This method performs a semantic (vector) search for users. It requires user authorization.