oneentry 1.0.173 → 1.0.175

package/esm/pages/pagesInterfaces.d.ts

@@ -29,7 +29,7 @@ interface IPagesApi {
     /**
      * Get page object with information about forms, blocks, menus, linked to the page.
      * @handleName getPageById
-     * @param {number} id - The unique identifier of the page to be fetched. Example: 123.
+     * @param {number} id - ID of the page to fetch. Example: 123.
      * @param {string} [langCode] - Language code. Default: "en_US".
      * @returns {IPagesEntity} Returns PageEntity object
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
@@ -49,7 +49,7 @@ interface IPagesApi {
     /**
      * Get child pages object with information as an array.
      * @handleName getChildPagesByParentUrl
-     * @param {string} url - The URL of the parent page for which child pages are to be fetched. Example: "about".
+     * @param {string} url - URL of the parent page whose child pages to fetch. Example: "about".
      * @param {string} [langCode] - Language code. Default: "en_US".
      * @returns {IPagesEntity} Returns all created pages as an array of PageEntity objects or an empty array [] (if there is no data) for the selected parent
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
@@ -69,7 +69,7 @@ interface IPagesApi {
     /**
      * Quick search for page objects with limited output.
      * @handleName searchPage
-     * @param {string} name - Text for searching page objects (search is performed on the title field of the localizeInfos object with the language taken into account). Example: "About Us".
+     * @param {string} name - Text to search for in page titles (`localizeInfos.title`) in the requested language. Example: "About Us".
      * @param {string} [url] - Optional page URL to filter search results. Example: "catalog".
      * @param {string} [langCode] - Language code. Default: "en_US".
      * @returns {IPagesEntity[] | IPageSearchResult[]} Returns found pages as an array of PageEntity objects, an array of short PageSearchResult cards when the traficLimit config option is enabled, or an empty array [] (if there is no data)
@@ -80,10 +80,10 @@ interface IPagesApi {
     /**
      * Semantic (vector) search for pages.
      * @handleName getPagesByVectorSearch
-     * @param {IPagesVectorSearch} body - Vector search body. Example: `{ queryText: "winter sale" }`.
+     * @param {IPagesVectorSearch} body - Vector search parameters. Example: `{ queryText: "winter sale" }`.
      * @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 {IVectorSearchResponse<IPagesResponse>} A promise that resolves to a pages response (items + total + indexReady) or an error.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      * @description This method performs a semantic (vector) search for pages.
@@ -95,8 +95,8 @@ interface IPagesApi {
  * @interface IPagesVectorSearch
  * @property {string} queryText - Natural-language search query. Example: "winter sale".
  * @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 pages vector/search endpoint.
  */
 interface IPagesVectorSearch {
@@ -107,7 +107,7 @@ interface IPagesVectorSearch {
 }
 /**
  * @interface IPagesResponse
- * @property {IPagesEntity[]} items - Array of found page objects.
+ * @property {IPagesEntity[]} items - Pages that match the query.
  * @property {number} total - Total number of found records. Example: 100.
  * @description This interface defines the structure of a response containing multiple page entities, including the total count and an array of page items.
  */
@@ -117,12 +117,12 @@ interface IPagesResponse {
 }
 /**
  * @interface IPositionForm
- * @property {number} id - The identifier of the object. Example: 1764.
- * @property {number} version - The version number of the object. Example: 10.
- * @property {string} identifier - The textual identifier for the record field. Example: "catalog".
- * @property {number} attributeSetId - The identifier of the attribute set being used. Example: 0.
- * @property {string} processingType - Type of form processing. Example: "email".
- * @property {ILocalizeInfo} localizeInfos  - The name of the page, taking into account localization.
+ * @property {number} id - Object ID. Example: 1764.
+ * @property {number} version - Version number of the object; changes with each update. Example: 10.
+ * @property {string} identifier - Text identifier (marker) of the object. Example: "catalog".
+ * @property {number} attributeSetId - ID of the attribute set in use. Example: 0.
+ * @property {string} processingType - How form submissions are processed, for example `"email"` or `"url"`. Example: "email".
+ * @property {ILocalizeInfo} localizeInfos - Localized name and content of the page.
  * @example
     {
       "title": "Blog",
@@ -131,7 +131,7 @@ interface IPagesResponse {
       "plainContent": ""
     }
  * @property {object} processingData - Form data. Example: {}.
- * @property {number} position - The position of the object. Example: 0.
+ * @property {number} position - Position of the object, used for sorting. Example: 0.
  * @property {IAttributes[]} attributes - Array of attribute values from the used attribute set for displaying the form (taking into account the specified language).
  * @example
     [
@@ -175,9 +175,9 @@ interface IPositionForm {
 }
 /**
  * @interface IPositionBlock
- * @property {number} id - The identifier of the object. Example: 1.
- * @property {string | null} attributeSetIdentifier - Set of attributes id. Example: "block".
- * @property {ILocalizeInfo} localizeInfos - The name of the page, taking into account localization.
+ * @property {number} id - Object ID. Example: 1.
+ * @property {string | null} attributeSetIdentifier - Marker of the attribute set, or `null` if none is assigned. Example: "block".
+ * @property {ILocalizeInfo} localizeInfos - Localized title of the page.
  * @example
     {
       "title": "Blog",
@@ -185,14 +185,14 @@ interface IPositionForm {
       "htmlContent": "",
       "plainContent": ""
     }
- * @property {number} version - The version number of the object. Example: 0.
- * @property {number} position - The position of the object. Example: 1.
- * @property {string} identifier - The textual identifier for the record field. Example: "product_block".
+ * @property {number} version - Version number of the object; changes with each update. Example: 0.
+ * @property {number} position - Position of the object, used for sorting. Example: 1.
+ * @property {string} identifier - Text identifier (marker) of the object. Example: "product_block".
  * @property {BlockType} type - Block type. Example: "product".
- * @property {string | null} templateIdentifier     - User id of the linked template. Example: null.
- * @property {boolean} isVisible - A sign of page visibility. Example: true.
- * @property {boolean} isSync - Indication of page indexing. Example: false.
- * @property {IAttributeValues} attributeValues - Map of attribute values keyed by marker; empty object when none.
+ * @property {string | null} templateIdentifier - Marker of the linked template, or `null` when none is linked. Example: null.
+ * @property {boolean} isVisible - Whether the page is visible. Example: true.
+ * @property {boolean} isSync - Whether the page is indexed. Example: false.
+ * @property {IAttributeValues} attributeValues - Attribute values keyed by marker; an empty object when there are none.
  * @example
     {
       "block-text": {
@@ -202,8 +202,8 @@ interface IPositionForm {
         "additionalFields": []
       }
     }
- * @property {number} [countElementsPerRow] - Number of elements displayed per row in the block, if applicable. Example: 3.
- * @property {number} [quantity] - Quantity pages in block. Example: 1.
+ * @property {number} [countElementsPerRow] - Number of items per row in the block, if set. Example: 3.
+ * @property {number} [quantity] - Number of items in the block. Example: 1.
  * @property {IProductsResponse} [similarProducts] - Similar products response (total + items). Present only for "similar_products_block" blocks and only when traffic-saving mode is off.
  * @property {IProductsEntity[]} [products] - Array of products associated with the block. Present only for "product_block" blocks and only when traffic-saving mode is off.
  * @description This interface defines the structure of a position block entity, including its identifiers, attributes, and visibility.
@@ -233,11 +233,11 @@ interface IPositionBlock {
 type PageType = 'catalog_page' | 'common_page' | 'error_page' | 'external_page';
 /**
  * @interface IPagesEntity
- * @property {number} id - The identifier of the object. Example: 8.
- * @property {number | null} parentId - The id of the parent page, if it contains null, then it is the top-level page. Example: 10.
- * @property {string} pageUrl - Unique page Url. Example: "blog".
- * @property {number} depth - Page nesting depth relative to parentId. Example: 10.
- * @property {ILocalizeInfo} localizeInfos - The name of the page, taking into account localization.
+ * @property {number} id - Object ID. Example: 8.
+ * @property {number | null} parentId - ID of the parent page; `null` for a top-level page. Example: 10.
+ * @property {string} pageUrl - URL of the page. Example: "blog".
+ * @property {number} depth - Page nesting depth relative to `parentId`. Example: 10.
+ * @property {ILocalizeInfo} localizeInfos - Localized title of the page.
  * @example
     {
       "title": "Blog",
@@ -245,11 +245,11 @@ type PageType = 'catalog_page' | 'common_page' | 'error_page' | 'external_page';
       "htmlContent": "",
       "plainContent": ""
     }
- * @property {boolean} isVisible - A sign of page visibility. Example: true.
+ * @property {boolean} isVisible - Whether the page is visible. Example: true.
  * @property {PageType} type - Page type. Example: "common_page".
- * @property {string | null} templateIdentifier - User id of the linked template. Example: "template".
- * @property {string | null} attributeSetIdentifier - Set of attributes id. Example: "page".
- * @property {IAttributeValues} attributeValues - Map of attribute values keyed by marker; empty object when none.
+ * @property {string | null} templateIdentifier - Marker of the linked template. Example: "template".
+ * @property {string | null} attributeSetIdentifier - Marker of the attribute set, or `null` if none is assigned. Example: "page".
+ * @property {IAttributeValues} attributeValues - Attribute values keyed by marker; an empty object when there are none.
  * @example
     {
       "text": {
@@ -259,18 +259,18 @@ type PageType = 'catalog_page' | 'common_page' | 'error_page' | 'external_page';
         "additionalFields": []
       }
     }
- * @property {boolean} isSync - Indication of page indexing. Example: true.
- * @property {object} [template] - Template object. Example: {}.
- * @property {number} [position] - Item number (for sorting). Example: 2.
+ * @property {boolean} isSync - Whether the page is indexed. Example: true.
+ * @property {object} [template] - Template linked to the page. Example: {}.
+ * @property {number} [position] - Position used for sorting. Example: 2.
  * @property {Record<string, number>} [config] - Output settings for catalog pages.
  * @example
     {
       "rowsPerPage": 1,
       "productsPerRow": 1
     }
- * @property {number} [products] - The number of products linked to the page. Example: 0.
- * @property {number} [childrenCount] - Children count. Example: 1.
- * @property {IBlockEntity[] | string[]} [blocks] - blocks.
+ * @property {number} [products] - Number of products linked to the page. Example: 0.
+ * @property {number} [childrenCount] - Number of child pages. Example: 1.
+ * @property {IBlockEntity[] | string[]} [blocks] - Blocks attached to the page: block objects or their markers.
  * @example
     {
       "id": 4,
@@ -283,10 +283,10 @@ type PageType = 'catalog_page' | 'common_page' | 'error_page' | 'external_page';
       "attributeValues": {},
       "position": 1
     }
- * @property {Array<IFormConfig>} [moduleFormConfigs] - Module form configurations linked to the page.
- * @property {IRating} [rating] - Rating data.
+ * @property {Array<IFormConfig>} [moduleFormConfigs] - Form configurations of the module linked to the page.
+ * @property {IRating} [rating] - Rating data: average value, likes and dislikes, and the calculation method.
  * @property {string} [total] - Total number of products linked to the page. Example: "10".
- * @property {string | null} [categoryPath] - Category path string; null for nested pages that have no own category path. Example: "catalog".
+ * @property {string | null} [categoryPath] - Category path; `null` for nested pages that have no category path of their own. Example: "catalog".
  * @property {number} [distance] - Cosine distance to the query. Returned only by the semantic (vector) search endpoint when `debug: true` is passed in the search body. Example: 0.12.
  * @description This interface defines the structure of a page entity, including its identifiers, attributes, and hierarchical relationships.
  */

package/esm/payments/paymentsApi.d.ts

@@ -19,7 +19,7 @@ export default class PaymentsApi extends AsyncModules implements IPaymentsApi {
     /**
      * Get list of payment sessions.
      * @handleName getSessions
-     * @param {number} [offset] - Optional parameter for pagination. Default: 0.
+     * @param {number} [offset] - Number of records to skip. Default: 0.
      * @param {number} [limit]  - Optional parameter for pagination. Default: 30.
      * @returns {Promise<ISessionsEntity | IError>} Returns an array of SessionEntity objects.
      * @throws {IError} When isShell=false and an error occurs during the fetch
@@ -31,7 +31,7 @@ export default class PaymentsApi extends AsyncModules implements IPaymentsApi {
     /**
      * Get a single payment session object by its identifier.
      * @handleName getSessionById
-     * @param {number} id - Identifier of the retrieved payment session object. Example: 12345.
+     * @param {number} id - Payment session ID. Example: 12345.
      * @returns {Promise<ISessionEntity | IError>} Returns a single payment session object.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This method gets a single payment session object by its identifier. This method requires user authorization.
@@ -42,7 +42,7 @@ export default class PaymentsApi extends AsyncModules implements IPaymentsApi {
     /**
      * Get one payment session object by order identifier
      * @handleName getSessionByOrderId
-     * @param {number} id - Order identifier. Example: 12345.
+     * @param {number} id - Order ID. Example: 12345.
      * @returns {Promise<IAccountsEntity | IError>} Returns a single payment account object.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This method gets one payment session object by order identifier. This method requires user authorization.
@@ -53,9 +53,9 @@ export default class PaymentsApi extends AsyncModules implements IPaymentsApi {
     /**
      * Creation of payment session.
      * @handleName createSession
-     * @param {number} orderId - Order identifier. Example: 12345.
-     * @param {'session' | 'intent'} type - Session type. Possible values: "session" or "intent". Example:  'session'.
-     * @param {boolean} [automaticTaxEnabled] - Automatic calculation of the tax rate. Default: false.
+     * @param {number} orderId - ID of the order. Example: 12345.
+     * @param {'session' | 'intent'} type - Session type: "session" or "intent". Example:  'session'.
+     * @param {boolean} [automaticTaxEnabled] - Whether the tax rate is calculated automatically. Default: `false`.
      * @returns {Promise<ISessionEntity | IError>} Returns a single payment session object.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This method creates a payment session. This method requires user authorization.
@@ -76,7 +76,7 @@ export default class PaymentsApi extends AsyncModules implements IPaymentsApi {
     /**
      * Get a single payment account object by its identifier.
      * @handleName getAccountById
-     * @param {number} id - Identifier of the retrieved payment account object. Example: 12345.
+     * @param {number} id - Payment account ID. Example: 12345.
      * @returns {Promise<IAccountsEntity | IError>} Returns a single payment account object.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Get a single payment account object by its identifier.
@@ -88,7 +88,7 @@ export default class PaymentsApi extends AsyncModules implements IPaymentsApi {
     /**
      * Get the payment progress of an order: its stages and whether they are paid.
      * @handleName getPaymentStagesByOrderId
-     * @param {number} id - ID of the order object. Example: 1.
+     * @param {number} id - Order ID. Example: 1.
      * @returns {Promise<IPaymentProgress | IError>} Returns the payment progress of the order.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description An order can be paid in stages rather than in one payment — `partial` says

package/esm/payments/paymentsApi.js

@@ -19,7 +19,7 @@ export default class PaymentsApi extends AsyncModules {
     /**
      * Get list of payment sessions.
      * @handleName getSessions
-     * @param {number} [offset] - Optional parameter for pagination. Default: 0.
+     * @param {number} [offset] - Number of records to skip. Default: 0.
      * @param {number} [limit]  - Optional parameter for pagination. Default: 30.
      * @returns {Promise<ISessionsEntity | IError>} Returns an array of SessionEntity objects.
      * @throws {IError} When isShell=false and an error occurs during the fetch
@@ -40,7 +40,7 @@ export default class PaymentsApi extends AsyncModules {
     /**
      * Get a single payment session object by its identifier.
      * @handleName getSessionById
-     * @param {number} id - Identifier of the retrieved payment session object. Example: 12345.
+     * @param {number} id - Payment session ID. Example: 12345.
      * @returns {Promise<ISessionEntity | IError>} Returns a single payment session object.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This method gets a single payment session object by its identifier. This method requires user authorization.
@@ -54,7 +54,7 @@ export default class PaymentsApi extends AsyncModules {
     /**
      * Get one payment session object by order identifier
      * @handleName getSessionByOrderId
-     * @param {number} id - Order identifier. Example: 12345.
+     * @param {number} id - Order ID. Example: 12345.
      * @returns {Promise<IAccountsEntity | IError>} Returns a single payment account object.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This method gets one payment session object by order identifier. This method requires user authorization.
@@ -70,9 +70,9 @@ export default class PaymentsApi extends AsyncModules {
     /**
      * Creation of payment session.
      * @handleName createSession
-     * @param {number} orderId - Order identifier. Example: 12345.
-     * @param {'session' | 'intent'} type - Session type. Possible values: "session" or "intent". Example:  'session'.
-     * @param {boolean} [automaticTaxEnabled] - Automatic calculation of the tax rate. Default: false.
+     * @param {number} orderId - ID of the order. Example: 12345.
+     * @param {'session' | 'intent'} type - Session type: "session" or "intent". Example:  'session'.
+     * @param {boolean} [automaticTaxEnabled] - Whether the tax rate is calculated automatically. Default: `false`.
      * @returns {Promise<ISessionEntity | IError>} Returns a single payment session object.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This method creates a payment session. This method requires user authorization.
@@ -107,7 +107,7 @@ export default class PaymentsApi extends AsyncModules {
     /**
      * Get a single payment account object by its identifier.
      * @handleName getAccountById
-     * @param {number} id - Identifier of the retrieved payment account object. Example: 12345.
+     * @param {number} id - Payment account ID. Example: 12345.
      * @returns {Promise<IAccountsEntity | IError>} Returns a single payment account object.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Get a single payment account object by its identifier.
@@ -122,7 +122,7 @@ export default class PaymentsApi extends AsyncModules {
     /**
      * Get the payment progress of an order: its stages and whether they are paid.
      * @handleName getPaymentStagesByOrderId
-     * @param {number} id - ID of the order object. Example: 1.
+     * @param {number} id - Order ID. Example: 1.
      * @returns {Promise<IPaymentProgress | IError>} Returns the payment progress of the order.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description An order can be paid in stages rather than in one payment — `partial` says

package/esm/payments/paymentsInterfaces.d.ts

@@ -7,8 +7,8 @@ interface IPaymentsApi {
     /**
      * Get list of payment sessions.
      * @handleName getSessions
-     * @param {number} [offset] - Optional parameter for pagination. Default: 0.
-     * @param {number} [limit] - Optional 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 {ISessionsEntity} Returns an array of SessionEntity objects.
      * @throws {IError} If there is an error during the fetch operation, it will return an error object.
      * @description This method gets list of payment sessions. This method requires user authorization.
@@ -18,7 +18,7 @@ interface IPaymentsApi {
     /**
      * Get a single payment session object by its identifier.
      * @handleName getSessionById
-     * @param {number} id - Identifier of the retrieved payment session object. Example: 12345.
+     * @param {number} id - Payment session ID. Example: 12345.
      * @returns {ISessionEntity} Returns a single payment session object.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      * @description This method gets a single payment session object by its identifier. This method requires user authorization.
@@ -28,7 +28,7 @@ interface IPaymentsApi {
     /**
      * Get one payment session object by order identifier 🔐
      * @handleName getSessionByOrderId
-     * @param {number} id - Order identifier. Example: 12345.
+     * @param {number} id - Order ID. Example: 12345.
      * @returns {ISessionEntity} Returns a single payment session object.
      * @throws {IError} If there is an error during the fetch operation, it will return an error object.
      * @description This method gets one payment session object by order identifier. This method requires user authorization.
@@ -38,9 +38,9 @@ interface IPaymentsApi {
     /**
      * Creation of payment session.
      * @handleName createSession
-     * @param {number} orderId - Order identifier. Example: 12345.
-     * @param {'session' | 'intent'} type - Session type. Possible values: "session" or "intent". Example: "session".
-     * @param {boolean} [automaticTaxEnabled] - Automatic calculation of the tax rate. Default: false.
+     * @param {number} orderId - ID of the order. Example: 12345.
+     * @param {'session' | 'intent'} type - Session type: "session" or "intent". Example: "session".
+     * @param {boolean} [automaticTaxEnabled] - Whether the tax rate is calculated automatically. Default: `false`.
      * @returns {ISessionEntity} Returns a single payment session object.
      * @throws {IError} If there is an error during the fetch operation, it will return an error object.
      * @description This method creates a payment session. This method requires user authorization.
@@ -59,7 +59,7 @@ interface IPaymentsApi {
     /**
      * Get a single payment account object by its identifier.
      * @handleName getAccountById
-     * @param {number} id - Identifier of the retrieved payment account object. Example: 12345.
+     * @param {number} id - Payment account ID. Example: 12345.
      * @returns {IAccountsEntity} Returns a single payment account object.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      * @description This method gets a single payment account object by its identifier. This method requires user authorization.
@@ -69,7 +69,7 @@ interface IPaymentsApi {
     /**
      * Get the payment progress of an order: its stages and whether they are paid.
      * @handleName getPaymentStagesByOrderId
-     * @param {number} id - ID of the order object. Example: 1.
+     * @param {number} id - Order ID. Example: 1.
      * @returns {IPaymentProgress} Returns the payment progress of the order.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      * @description This method gets the payment stages of an order. This method requires user authorization.
@@ -80,7 +80,7 @@ interface IPaymentsApi {
 /**
  * @interface ISessionsEntity
  * @property {number} total - Total number of found records. Example: 100.
- * @property {ISessionEntity[]} items - Array of session objects.
+ * @property {ISessionEntity[]} items - Payment sessions in this response.
  * @example
     [
       {
@@ -102,16 +102,16 @@ interface ISessionsEntity {
 }
 /**
  * @interface ISessionEntity
- * @property {number} id - Object identifier. Example: 1764.
- * @property {string} createdDate - Object creation date. Example: "2025-02-26T10:13:16.839Z".
- * @property {string} updatedDate - Object modification date. Example: "2025-02-26T10:13:16.839Z".
- * @property {'session' | 'intent'} type - Type may be 'session' or 'intent'. Example: "session".
+ * @property {number} id - Object ID. Example: 1764.
+ * @property {string} createdDate - Creation date. Example: "2025-02-26T10:13:16.839Z".
+ * @property {string} updatedDate - Date the object was last modified. Example: "2025-02-26T10:13:16.839Z".
+ * @property {'session' | 'intent'} type - Session type: "session" or "intent". Example: "session".
  * @property {string} status - Payment status. Example: "completed".
- * @property {number} paymentAccountId - Payment account identifier. Example: 1.
- * @property {number} orderId - Order identifier. Example: 1.
- * @property {string | null} paymentUrl - payment link. Example: " https://www.sandbox.paypal.com/checkoutnow?token=9BE88048TU058770M".
- * @property {number | null} [amount] - Amount of the payment session. Example: 100.
- * @property {string} [clientSecret] - Client secret key returned by payment provider (e.g. Stripe) when creating a session. Example: "pi_3MtwBwLkdIwHu7ix28a3tqPa_secret_YrKJUKribcBjcG8HVhfZluoGH".
+ * @property {number} paymentAccountId - ID of the payment account. Example: 1.
+ * @property {number} orderId - ID of the order. Example: 1.
+ * @property {string | null} paymentUrl - Payment page URL. Example: " https://www.sandbox.paypal.com/checkoutnow?token=9BE88048TU058770M".
+ * @property {number | null} [amount] - Payment session amount. Example: 100.
+ * @property {string} [clientSecret] - Client secret returned by the payment provider (for example, Stripe) when the session is created. Example: "pi_3MtwBwLkdIwHu7ix28a3tqPa_secret_YrKJUKribcBjcG8HVhfZluoGH".
  * @description This interface defines the structure of a session entity, including its quantity, amount, currency, name, and description.
  */
 interface ISessionEntity {
@@ -138,16 +138,16 @@ interface IIntent {
 }
 /**
  * @interface IAccountsEntity
- * @property {number} id - Object identifier. Example: 12345.
- * @property {ILocalizeInfo} localizeInfos - Json description of the payment account object.
- * @property {string} identifier - Text identifier for the recording field. Example: "payment_12345".
+ * @property {number} id - Object ID. Example: 12345.
+ * @property {ILocalizeInfo} localizeInfos - Localized name and description of the payment account.
+ * @property {string} identifier - Marker of the payment account. Example: "payment_12345".
  * @property {'stripe' | 'yookassa' | 'midtrans' | 'xendit' | 'custom'} type - Payment provider type. Example: 'stripe'.
- * @property {boolean} isVisible - Visibility indicator of the payment account. Example: true.
- * @property {boolean} isUsed - Usage indicator of the payment account. Example: false.
- * @property {boolean} testMode - Indicates whether the payment account is in test mode. Example: true.
+ * @property {boolean} isVisible - Whether the payment account is visible. Example: true.
+ * @property {boolean} isUsed - Whether the payment account is in use. Example: false.
+ * @property {boolean} testMode - Whether the payment account is in test mode. Example: true.
  * @property {IPaymentAccountSettings} settings - Payment account settings. Example: `{ "status": "connected" }`.
  * @property {object} [testSettings] - Test mode settings for the payment account.
- * @property {string} updatedDate - Object modification date. Example: "2025-02-26T10:13:16.839Z".
+ * @property {string} updatedDate - Date the object was last modified. Example: "2025-02-26T10:13:16.839Z".
  * @description This interface defines the structure of a payment account entity, including its identifiers, localization information, type, visibility, and usage status.
  */
 interface IAccountsEntity {
@@ -199,8 +199,8 @@ interface IPaymentAccountTestSettings {
 /**
  * The `IPaymentProgress` interface describes the payment progress of an order.
  * @interface IPaymentProgress
- * @property {boolean} completed - True when every stage of the order has been paid. Example: false.
- * @property {boolean} partial - True when the order is paid in stages rather than in one payment. Example: true.
+ * @property {boolean} completed - `true` when every stage of the order has been paid. Example: false.
+ * @property {boolean} partial - `true` when the order is paid in stages rather than in one payment. Example: true.
  * @property {IPaymentStage[]} stages - The stages themselves, in the order the API returns them.
  * @description This interface describes the payment progress of an order — whether it is fully paid, whether it is split into stages, and the stages themselves.
  */
@@ -212,11 +212,11 @@ interface IPaymentProgress {
 /**
  * The `IPaymentStage` interface describes one payment stage of an order.
  * @interface IPaymentStage
- * @property {string} marker - Marker of the attribute that set the price of the stage. Example: "part_a".
+ * @property {string} marker - Marker of the attribute that sets the price of the stage. Example: "part_a".
  * @property {number} sessionId - Identifier of the payment session bound to the stage. Example: 100.
- * @property {number} productId - Identifier of the product the stage belongs to. Example: 200.
+ * @property {number} productId - ID of the product the stage belongs to. Example: 200.
  * @property {string} title - Title of the stage. Example: "Part A".
- * @property {number} value - Price of the stage. Example: 150.
+ * @property {number} value - Amount due for the stage. Example: 150.
  * @property {"planned" | "completed"} status - Stage status: "planned" — not paid yet, "completed" — paid. Example: "planned".
  * @description This interface describes one payment stage of an order.
  */

package/esm/product-statuses/productStatusesApi.d.ts

@@ -29,7 +29,7 @@ export default class ProductStatusesApi extends AsyncModules implements IProduct
     /**
      * Search for a product status object by its textual identifier (marker).
      * @handleName getProductsByStatusMarker
-     * @param {string} marker - Product status marker. Example: "in_stock".
+     * @param {string} marker - Marker of the product status. Example: "in_stock".
      * @param {string} [langCode] - Language code. Default: "en_US".
      * @returns {Promise<IProductStatusEntity | IError>} Returns a product status object.
      * @throws {IError} When isShell=false and an error occurs during the fetch
@@ -40,7 +40,7 @@ export default class ProductStatusesApi extends AsyncModules implements IProduct
     /**
      * Check the existence of a textual identifier.
      * @handleName validateMarker
-     * @param {string} marker - Product status marker. Example: "in_stock".
+     * @param {string} marker - Marker of the product status. Example: "in_stock".
      * @returns {Promise<boolean | IError>} Returns true if the textual identifier (marker) exists or false if it doesn't.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Check the existence of a textual identifier.

package/esm/product-statuses/productStatusesApi.js

@@ -34,7 +34,7 @@ export default class ProductStatusesApi extends AsyncModules {
     /**
      * Search for a product status object by its textual identifier (marker).
      * @handleName getProductsByStatusMarker
-     * @param {string} marker - Product status marker. Example: "in_stock".
+     * @param {string} marker - Marker of the product status. Example: "in_stock".
      * @param {string} [langCode] - Language code. Default: "en_US".
      * @returns {Promise<IProductStatusEntity | IError>} Returns a product status object.
      * @throws {IError} When isShell=false and an error occurs during the fetch
@@ -50,7 +50,7 @@ export default class ProductStatusesApi extends AsyncModules {
     /**
      * Check the existence of a textual identifier.
      * @handleName validateMarker
-     * @param {string} marker - Product status marker. Example: "in_stock".
+     * @param {string} marker - Marker of the product status. Example: "in_stock".
      * @returns {Promise<boolean | IError>} Returns true if the textual identifier (marker) exists or false if it doesn't.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Check the existence of a textual identifier.

package/esm/product-statuses/productStatusesInterfaces.d.ts

@@ -16,7 +16,7 @@ interface IProductStatusesApi {
     /**
      * Search for a product status object by its textual identifier (marker).
      * @handleName getProductsByStatusMarker
-     * @param {string} marker - Product status marker. Example: "in_stock".
+     * @param {string} marker - Marker of the product status. Example: "in_stock".
      * @param {string} [langCode] - Language code. Default: "en_US".
      * @returns {IProductStatusEntity} Returns a product status object.
      * @throws {IError} If there is an error during the fetch operation, it will return an error object.
@@ -26,7 +26,7 @@ interface IProductStatusesApi {
     /**
      * Check the existence of a textual identifier.
      * @handleName validateMarker
-     * @param {string} marker - Product status marker. Example: "in_stock".
+     * @param {string} marker - Marker of the product status. Example: "in_stock".
      * @returns {boolean} Returns true if the textual identifier (marker) exists or false if it doesn't.
      * @throws {IError} If there is an error during the fetch operation, it will return an error object.
      * @description This method checks the existence of a textual identifier.
@@ -36,9 +36,9 @@ interface IProductStatusesApi {
 /**
  * Product status entity structure
  * @interface IProductStatusEntity
- * @property {number} id - The unique identifier of the position. Example: 12345.
- * @property {string} identifier - The textual identifier for the record field. Example: "in_stock".
- * @property {ILocalizeInfo} localizeInfos - The name of the products statuses, taking into account localization.
+ * @property {number} id - ID of the object. Example: 12345.
+ * @property {string} identifier - Text identifier (marker) of the object. Example: "in_stock".
+ * @property {ILocalizeInfo} localizeInfos - Localized name of the product status.
  * @example
     {
       "title": "Catalog",
@@ -46,9 +46,9 @@ interface IProductStatusesApi {
       "htmlContent": "<b>Content for catalog</b>",
       "menuTitle": "Catalog"
     }
- * @property {boolean} isDefault - Default status flag. Example: true.
- * @property {number} version - The version number of the object. Example: 1.
- * @property {number} position - Position number. Example: 1.
+ * @property {boolean} isDefault - Whether this is the default status. Example: true.
+ * @property {number} version - Version number of the object; changes with each update. Example: 1.
+ * @property {number} position - Position used for sorting. Example: 1.
  * @description This interface defines the structure of a product status entity, including its identifiers, localization information, position, and default status flag.
  */
 interface IProductStatusEntity {