oneentry 1.0.173 → 1.0.175

package/dist/orders/ordersInterfaces.d.ts

@@ -8,8 +8,8 @@ interface IOrdersApi {
      * Getting all the order storage objects.
      * @handleName getAllOrdersStorage
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @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 {Promise<IOrdersEntity[] | IError>} Returns an array of order storage objects.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      * @description This method gets all the order storage objects. This method requires user authorization.
@@ -19,10 +19,10 @@ interface IOrdersApi {
     /**
      * Getting all orders from the orders storage object created by the user.
      * @handleName getAllOrdersByMarker
-     * @param {string} marker - Textual identifier of the order storage object. Example: "order_storage_1".
+     * @param {string} marker - Marker of the order storage. Example: "order_storage_1".
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @param {number} [offset] - Offset parameter. Default: 0.
-     * @param {number} [limit] - Limit parameter. 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<IOrdersByMarkerEntity | IError>} Returns an object with the orders.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      * @description This method gets all orders from the orders storage object created by the user. This method requires user authorization.
@@ -32,7 +32,7 @@ interface IOrdersApi {
     /**
      * Retrieve one order storage object by marker.
      * @handleName getOrdersStorageByMarker
-     * @param {string} marker - Marker of the order object. Example: "order_storage_1".
+     * @param {string} marker - Marker of the order storage. Example: "order_storage_1".
      * @param {string} [langCode] - Language code. Default: "en_US".
      * @returns {Promise<IOrdersEntity | IError>} Return object of order information.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
@@ -43,8 +43,8 @@ interface IOrdersApi {
     /**
      * Getting a single order from the order storage object created by the user.
      * @handleName getOrderByMarkerAndId
-     * @param {string} marker - The text identifier of the order storage object. Example: "order_storage_1".
-     * @param {number} id - ID of the order object. Example: 12345.
+     * @param {string} marker - Marker of the order storage. Example: "order_storage_1".
+     * @param {number} id - Order ID. Example: 12345.
      * @param {string} [langCode] - Language code. Default: "en_US".
      * @returns {Promise<IOrderByMarkerEntity | IError>} Returns an object with the order.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
@@ -55,7 +55,7 @@ interface IOrdersApi {
     /**
      * Getting a single order created by the user, by its own id.
      * @handleName getOrderById
-     * @param {number} id - ID of the order object. Example: 12345.
+     * @param {number} id - Order ID. Example: 12345.
      * @param {string} [langCode] - Language code. Default: "en_US".
      * @returns {Promise<IOrderByMarkerEntity | IError>} Returns an object with the order.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
@@ -66,8 +66,8 @@ interface IOrdersApi {
     /**
      * Creation of an order in the order storage.
      * @handleName createOrder
-     * @param {string} marker - Textual identifier of the order storage object. Example: "order_storage_1".
-     * @param {IOrderData} body - Object for creating an order.
+     * @param {string} marker - Marker of the order storage. Example: "order_storage_1".
+     * @param {IOrderData} body - Data for the new order.
      * @example
         {
           "formIdentifier": "bar-orders-form",
@@ -94,9 +94,9 @@ interface IOrdersApi {
     /**
      * Changing an order in the orders storage
      * @handleName updateOrderByMarkerAndId
-     * @param {string} marker - The text identifier of the order storage object. Example: "order_storage_1".
-     * @param {number} id - ID of the order object. Example: 12345.
-     * @param {IOrderData} body - Object for updating an order.
+     * @param {string} marker - Marker of the order storage. Example: "order_storage_1".
+     * @param {number} id - Order ID. Example: 12345.
+     * @param {IOrderData} body - Data for updating the order.
      * @example
         {
           "formIdentifier": "bar-orders-form",
@@ -124,7 +124,7 @@ interface IOrdersApi {
     /**
      * Preview order calculation with discounts and coupons (without saving).
      * @handleName previewOrder
-     * @param {ICreateOrderPreview} body - Order preview body.
+     * @param {ICreateOrderPreview} body - Order preview parameters.
      * @param {string} [langCode] - Language code. Default: "en_US".
      * @returns {Promise<IOrderPreviewResponse | IError>} Returns an object with the order preview.
      * @throws {IError} When isShell=false and an error occurs during the fetch
@@ -135,10 +135,10 @@ interface IOrdersApi {
     /**
      * Get all orders statuses by Storage marker
      * @handleName getAllStatusesByStorageMarker
-     * @param {string} marker - Textual identifier of the order storage object. Example: "order_storage_1".
+     * @param {string} marker - Marker of the order storage. Example: "order_storage_1".
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @param {number} [offset] - Offset parameter. Default: 0.
-     * @param {number} [limit] - Limit parameter. 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<IOrderStatus[] | IError>} Returns an object with the orders statuses.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider authorization module}, see the documentation in the  {@link https://js-sdk.oneentry.cloud/docs/category/authprovider configuration settings section of the SDK}.
@@ -147,7 +147,7 @@ interface IOrdersApi {
     /**
      * Get all refund requests for an order.
      * @handleName getOrderRefunds
-     * @param {number} id - Order id.
+     * @param {number} id - Order ID.
      * @returns {Promise<IRefundRequest[] | IError>} Returns array of refund requests.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      */
@@ -155,8 +155,8 @@ interface IOrdersApi {
     /**
      * Create a refund request for an order.
      * @handleName createRefundRequest
-     * @param {number} id - Order id.
-     * @param {ICreateRefundRequest} body - Refund request body.
+     * @param {number} id - Order ID.
+     * @param {ICreateRefundRequest} body - Refund request data.
      * @returns {Promise<boolean | IError>} Returns true if the refund request was created successfully.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      */
@@ -164,7 +164,7 @@ interface IOrdersApi {
     /**
      * Cancel a refund request for an order.
      * @handleName cancelRefundRequest
-     * @param {number} id - Order id.
+     * @param {number} id - Order ID.
      * @returns {Promise<boolean | IError>} Returns order entity.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      */
@@ -172,10 +172,10 @@ interface IOrdersApi {
     /**
      * Semantic (vector) search for the current user's orders.
      * @handleName getOrdersByVectorSearch
-     * @param {IOrdersVectorSearch} body - Vector search body. Example: `{ queryText: "winter jacket" }`.
+     * @param {IOrdersVectorSearch} body - Vector search parameters. Example: `{ queryText: "winter jacket" }`.
      * @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<IOrdersByMarkerEntity> | IError>} Returns an object with an array of found orders and total count.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      */
@@ -186,8 +186,8 @@ interface IOrdersApi {
  * @interface IOrdersVectorSearch
  * @property {string} queryText - Natural-language search query. Example: "winter jacket".
  * @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 orders vector/search endpoint.
  */
 interface IOrdersVectorSearch {
@@ -199,7 +199,7 @@ interface IOrdersVectorSearch {
 /**
  * Interface for the orders storage object.
  * @interface IOrdersByMarkerEntity
- * @property {IOrderByMarkerEntity[]} items - Array of order storage objects.
+ * @property {IOrderByMarkerEntity[]} items - Order storages in this response.
  * @example
     [
       {
@@ -260,11 +260,11 @@ interface IPicture {
 /**
  * Interface representing a product in an order.
  * @interface IOrderProducts
- * @property {number} id - Product id. Example: 2957.
+ * @property {number} id - Product ID. Example: 2957.
  * @property {number} quantity - Product quantity. Example: 1.
  * @property {string} title - Product title. Example: "Cosmo".
- * @property {string | null} sku - Product sku. Example: "SKU".
- * @property {IPicture | null} previewImage - Product previewImage.
+ * @property {string | null} sku - Product SKU. Example: "SKU".
+ * @property {IPicture | null} previewImage - Preview image of the product.
  * @example
     {
       "filename": "image.jpg",
@@ -288,9 +288,9 @@ interface IOrderProducts {
 /**
  * Interface representing form data for orders.
  * @interface IOrdersFormData
- * @property {string} marker - Marker of form field. Example: "name_1".
- * @property {string} type - Type of value. Example: "string".
- * @property {string} value - Value. Example: "Name".
+ * @property {string} marker - Marker of the form field. Example: "name_1".
+ * @property {string} type - Type of the field value, for example `"string"`. Example: "string".
+ * @property {string} value - Field value. Example: "Name".
  * @description Represents a form data for orders.
  */
 interface IOrdersFormData {
@@ -301,9 +301,9 @@ interface IOrdersFormData {
 /**
  * Interface representing product data in an order.
  * @interface IOrderProductData
- * @property {number} productId - Product identifier. Example: 1.
+ * @property {number} productId - Product ID. Example: 1.
  * @property {number} quantity - Quantity of the product. Example: 2.
- * @property {string} [signedPrice] - The signed price of the product is obtained along with the product data when `signPrice` is set. Example: "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...".
+ * @property {string} [signedPrice] - Signed token (JWT) that fixes the product price for an order. Returned when `signPrice` is set. Example: "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...".
  * @see {@link https://js-sdk.oneentry.cloud/docs/orders/#Fixed-product-price-signedPrice Fixed product price} documentation.
  * @description Represents a product data in an order.
  */
@@ -315,7 +315,7 @@ interface IOrderProductData {
 /**
  * Interface representing product data in an order.
  * @interface IOrderProductsData
- * @property {number} productId - Product identifier. Example: 1.
+ * @property {number} productId - Product ID. Example: 1.
  * @property {number} quantity - Quantity of the product. Example: 2.
  * @description Represents a product data in an order.
  */
@@ -326,10 +326,10 @@ interface IOrderProductsData {
 /**
  * Interface representing an order storage object.
  * @interface IBaseOrdersEntity
- * @property {number} id - Object identifier. Example: 1.
- * @property {string} formIdentifier - Text identifier of the form. Example: "bar-orders-form".
- * @property {string} paymentAccountIdentifier - Text identifier of the order payment. Example: "payment-1".
- * @property {IOrdersFormData[]} formData - Data submitted by the form linked to the order store.
+ * @property {number} id - Object ID. Example: 1.
+ * @property {string} formIdentifier - Marker of the form. Example: "bar-orders-form".
+ * @property {string} paymentAccountIdentifier - Marker of the payment account. Example: "payment-1".
+ * @property {IOrdersFormData[]} formData - Data from the form linked to the order storage.
  * @example
     [
       {
@@ -338,7 +338,7 @@ interface IOrderProductsData {
         "type": "string"
       }
     ]
- * @property {IOrderProductsData[]} products - Array of products added to order.
+ * @property {IOrderProductsData[]} products - Products in the order.
  * @example
     [
       {
@@ -353,13 +353,13 @@ interface IOrderProductsData {
  * @property {string} currency - Currency used to pay for the order. Example: "USD".
  * @property {number} totalSum - Total order amount. Example: 150.
  * @property {string} [createdDate] - Order creation date. Example: "2023-10-01T12:00:00Z".
- * @property {string} [statusIdentifier] - Text identifier of order status object (if not set, default status will be assigned). Example: "status-1".
+ * @property {string} [statusIdentifier] - Marker of the order status. When omitted, the default status is assigned. Example: "status-1".
  * @property {ILocalizeInfo} [statusLocalizeInfos] - Localized status name assigned to the created/updated order.
  * @property {string} [couponCode] -
  * @property {string[]} [additionalDiscountsMarkers] -
  * @property {IOrderDiscountConfig} [discountConfig] - Resolved discount configuration applied to the order.
  * @property {number} [bonusAmount] - Bonus amount applied to the order.
- * @property {number} [bonusApplied] - Bonus applied to the order.
+ * @property {number} [bonusApplied] - Bonus amount applied to the order.
  * @property {number} [totalDue] - Total due after bonuses.
  */
 interface IBaseOrdersEntity {
@@ -418,14 +418,14 @@ interface IOrderDiscountSettings {
 }
 /**
  * @interface IOrderDiscountConfig
- * @property {IOrderDiscountBonus | null} [bonus] - Bonus calculation result, null when bonuses are not used, or omitted entirely when the order has no bonus context.
- * @property {unknown | null} coupon - Resolved coupon, or null when no coupon is applied.
+ * @property {IOrderDiscountBonus | null} [bonus] - Bonus calculation result: `null` when bonuses are not used; omitted when the order has no bonus context.
+ * @property {unknown | null} coupon - Applied coupon, or `null` when no coupon is applied.
  * @property {unknown[]} orderDiscounts - Order-level discounts that were matched and applied.
  * @property {unknown[]} productDiscounts - Product-level discounts that were matched and applied.
  * @property {IOrderDiscountSettings} settings - Stacking and cap settings used during calculation.
- * @property {string[]} [additionalDiscountsMarkers] - Markers of extra discounts requested by the client (omitted in preview responses).
- * @property {number} [bonusApplied] - Bonus amount applied to the order (omitted in preview responses). Example: 0.
- * @property {string[]} [excludedGiftProductIds] - Product ids excluded from gift selection (omitted in preview responses).
+ * @property {string[]} [additionalDiscountsMarkers] - Markers of additional discounts requested by the client. Omitted in preview responses.
+ * @property {number} [bonusApplied] - Bonus amount applied to the order. Omitted in preview responses. Example: 0.
+ * @property {string[]} [excludedGiftProductIds] - Product IDs excluded from gift selection. Omitted in preview responses.
  * @property {number} [totalDue] - Total amount due after discounts and bonuses (omitted in preview responses). Example: 300.
  * @property {number} [totalRaw] - Total amount before discounts (omitted in preview responses). Example: 300.
  * @property {number} [totalSumWithDiscount] - Total amount after discounts but before bonuses (omitted in preview responses). Example: 300.
@@ -447,7 +447,7 @@ interface IOrderDiscountConfig {
 /**
  * Interface representing a response from the order storage.
  * @interface IBaseOrdersEntityResponse
- * @property {IBaseOrdersEntity[]} items - Array of order storage objects.
+ * @property {IBaseOrdersEntity[]} items - Order storages in this response.
  * @example
     [
       {
@@ -469,17 +469,17 @@ interface IBaseOrdersEntityResponse {
 /**
  * Interface representing an order storage object.
  * @interface IOrdersEntity
- * @property {number} id - Object identifier. Example: 1.
- * @property {ILocalizeInfo} localizeInfos - Name considering localization.
+ * @property {number} id - Object ID. Example: 1.
+ * @property {ILocalizeInfo} localizeInfos - Localized name of the order storage.
  * @example
     {
       "title": "Cash"
     }
- * @property {number | null} position - Position in orders storage. Example: 1.
- * @property {string} identifier - Textual identifier for the record field. Example: "order_storage_1".
- * @property {string} formIdentifier - Textual identifier for the form used by the order storage. Example: "bar-orders-form".
- * @property {number | null} generalTypeId - Type identifier. Example: 1.
- * @property {IPaymentAccountIdentifiers[]} paymentAccountIdentifiers - Array of textual identifiers of payment accounts used by the order storage.
+ * @property {number | null} position - Position of the order storage, used for sorting. Example: 1.
+ * @property {string} identifier - Marker of the order storage. Example: "order_storage_1".
+ * @property {string} formIdentifier - Marker of the form used by the order storage. Example: "bar-orders-form".
+ * @property {number | null} generalTypeId - ID of the general type. Example: 1.
+ * @property {IPaymentAccountIdentifiers[]} paymentAccountIdentifiers - Markers of the payment accounts used by the order storage.
  * @example
     [
       {
@@ -500,7 +500,7 @@ interface IOrdersEntity {
 /**
  * Interface representing an identifier for a payment account used in an order.
  * @interface IPaymentAccountIdentifiers
- * @property {string} identifier - Textual identifier of the payment account. Example: "payment-1".
+ * @property {string} identifier - Marker of the payment account. Example: "payment-1".
  * @description Represents an identifier for a payment account used in an order.
  */
 interface IPaymentAccountIdentifiers {
@@ -509,9 +509,9 @@ interface IPaymentAccountIdentifiers {
 /**
  * Interface representing the data required to create or update an order in the order storage.
  * @interface IOrderData
- * @property {string} formIdentifier - Text identifier of the form object linked to the order repository. Example: "bar-orders-form".
- * @property {string} paymentAccountIdentifier - Text identifier of the payment object linked to the order repository. Example: "payment-1".
- * @property {IOrdersFormData | IOrdersFormData[]} formData - Form data linked to the order repository.
+ * @property {string} formIdentifier - Marker of the form linked to the order storage. Example: "bar-orders-form".
+ * @property {string} paymentAccountIdentifier - Marker of the payment account linked to the order storage. Example: "payment-1".
+ * @property {IOrdersFormData | IOrdersFormData[]} formData - Data from the form linked to the order storage.
  * @example
     [
       {
@@ -520,9 +520,9 @@ interface IPaymentAccountIdentifiers {
         "type": "string"
       }
     ]
- * @property {IOrderProductData[]} products - An array of ordered products. Example: [].
+ * @property {IOrderProductData[]} products - Ordered products. Example: [].
  * @property {string} [couponCode] - Coupon code.
- * @property {string[]} [additionalDiscountsMarkers] - Array of additional discount markers.
+ * @property {string[]} [additionalDiscountsMarkers] - Markers of additional discounts to apply.
  * @property {number} [bonusAmount] - Bonus amount to apply.
  * @description Represents the data required to create or update an order in the order storage.
  */
@@ -555,7 +555,7 @@ interface IOrderSplitStage {
 }
 /**
  * @interface IOrderSplit
- * @property {boolean} completed - Whether all split stages are completed. Example: false.
+ * @property {boolean} completed - Whether all split payment stages are completed. Example: false.
  * @property {boolean} partial - Whether the split is partially paid. Example: false.
  * @property {IOrderSplitStage[]} stages - Ordered list of split payment stages.
  * @description Split (staged) payment configuration of an order; returned by the by-id order endpoint.
@@ -568,12 +568,12 @@ interface IOrderSplit {
 /**
  * Interface representing an order product data.
  * @interface IOrderByMarkerEntity
- * @property {number} id - Object identifier. Example: 125.
- * @property {number} storageId - Identifier of the order storage object. Example: 1.
+ * @property {number} id - Object ID. Example: 125.
+ * @property {number} storageId - ID of the order storage. Example: 1.
  * @property {string} createdDate - Date when the order was created. Example: "2023-10-01T12:00:00Z".
- * @property {string} [statusIdentifier] - Text identifier of the order status. Example: "order-status-1".
- * @property {string} [formIdentifier] - Text identifier of the form. Example: "bar-orders-form".
- * @property {IOrdersFormData[]} formData - Data submitted by the form linked to the order store.
+ * @property {string} [statusIdentifier] - Marker of the order status. Example: "order-status-1".
+ * @property {string} [formIdentifier] - Marker of the form. Example: "bar-orders-form".
+ * @property {IOrdersFormData[]} formData - Data from the form linked to the order storage.
  * @example
     [
       {
@@ -582,17 +582,17 @@ interface IOrderSplit {
         "type": "string"
       }
     ]
- * @property {string | null} [attributeSetIdentifier] - Text identifier of the attribute set. Example: "attribute-set-1".
+ * @property {string | null} [attributeSetIdentifier] - Marker of the attribute set. Example: "attribute-set-1".
  * @property {string} totalSum - Total order amount. Example: "100.00".
  * @property {string} [totalSumRaw] - Raw total order amount with full precision. Example: "100.00".
  * @property {string} currency - Currency used to pay for the order. Example: "USD".
- * @property {string | null} [paymentAccountIdentifier] - Textual identifier for the order payment. Example: "payment-1".
- * @property {ILocalizeInfo} [paymentAccountLocalizeInfos] - Payment account name considering localization.
+ * @property {string | null} [paymentAccountIdentifier] - Marker of the payment account. Example: "payment-1".
+ * @property {ILocalizeInfo} [paymentAccountLocalizeInfos] - Localized name of the payment account.
  * @example
   {
     "title": "Cash"
   }
- * @property {IOrderProducts[]} products - Array of products added to order.
+ * @property {IOrderProducts[]} products - Products in the order.
  * @example
     [
       {
@@ -601,16 +601,16 @@ interface IOrderSplit {
         "quantity": 2
       }
     ]
- * @property {string | null} paymentUrl - Payment link. Example: "https://example.com/pay/123".
- * @property {boolean | null} isCompleted - Indicates that the order has been completed. Example: true.
- * @property {boolean | null} [isPartial] - Indicates that the order is partially paid; null on older orders where it was not tracked. Example: false.
+ * @property {string | null} paymentUrl - Payment page URL. Example: "https://example.com/pay/123".
+ * @property {boolean | null} isCompleted - Whether the order has been completed. Example: true.
+ * @property {boolean | null} [isPartial] - Whether the order is partially paid; `null` on older orders where this was not tracked. Example: false.
  * @property {string} [paymentStrategy] - Payment strategy of the order. Example: "once".
  * @property {ILocalizeInfo} [statusLocalizeInfos] - Localized status name.
- * @property {string | null} [fulfillmentStatusIdentifier] - Text identifier of the fulfillment (delivery) status; null while no fulfillment status is assigned. Example: "shipped".
+ * @property {string | null} [fulfillmentStatusIdentifier] - Marker of the fulfillment (delivery) status; `null` while no fulfillment status is assigned. Example: "shipped".
  * @property {ILocalizeInfo | null} [fulfillmentStatusLocalizeInfos] - Localized fulfillment status name; null while no fulfillment status is assigned.
- * @property {string | null} [paymentStatusIdentifier] - Text identifier of the payment status; null while no payment status is assigned. Example: "inProgress-payment".
- * @property {ILocalizeInfo | null} [paymentStatusLocalizeInfos] - Localized payment status name; null while no payment status is assigned.
- * @property {IOrderDiscountConfig | null} [discountConfig] - Resolved discount configuration applied to the order (orderDiscounts, productDiscounts, coupon, settings, bonus, totals); null on older orders without a resolved discount config.
+ * @property {string | null} [paymentStatusIdentifier] - Marker of the payment status; `null` while no payment status is assigned. Example: "inProgress-payment".
+ * @property {ILocalizeInfo | null} [paymentStatusLocalizeInfos] - Localized name of the payment status; `null` while no payment status is assigned.
+ * @property {IOrderDiscountConfig | null} [discountConfig] - Discount configuration resolved for the order: `orderDiscounts`, `productDiscounts`, `coupon`, `settings`, `bonus` and totals. `null` on older orders without a resolved configuration.
  * @property {IOrderSplit} [split] - Split (staged) payment configuration; present on the by-id order endpoint.
  * @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 Represents an order storage object created by the user.
@@ -645,12 +645,12 @@ interface IOrderByMarkerEntity {
 /**
  * Interface representing an order status object.
  * @interface IOrderStatus
- * @property {number} [id] - Status identifier. Example: 1.
- * @property {ILocalizeInfo} [localizeInfos] - Localized information for the status.
+ * @property {number} [id] - Status ID. Example: 1.
+ * @property {ILocalizeInfo} [localizeInfos] - Localized data of the status.
  * @property {string} [identifier] - Text identifier of the status. Example: "inProgress-payment".
- * @property {number} [position] - Position of the status. Example: 1.
+ * @property {number} [position] - Position of the status, used for sorting. Example: 1.
  * @property {boolean} [isUsed] - Whether the status is in use. Example: true.
- * @property {boolean} [isDefault] - Whether the status is the default status. Example: true.
+ * @property {boolean} [isDefault] - Whether this is the default status. Example: true.
  * @property {string} [axis] - Status axis (pipeline) the status belongs to. Example: "payment".
  * @property {boolean} [isCancelFinal] - Whether the status is a final cancellation status. Example: false.
  * @property {boolean} [isFinalSuccess] - Whether the status is a final successful status. Example: true.
@@ -671,7 +671,7 @@ interface IOrderStatus {
 /**
  * Interface representing a product in an order preview.
  * @interface IPreviewOrderProduct
- * @property {number} [productId] - Product identifier. Example: 1.
+ * @property {number} [productId] - Product ID. Example: 1.
  * @property {number} [quantity] - Quantity of the product. Example: 2.
  */
 interface IPreviewOrderProduct {
@@ -681,9 +681,9 @@ interface IPreviewOrderProduct {
 /**
  * Interface representing the body for order preview calculation.
  * @interface ICreateOrderPreview
- * @property {IPreviewOrderProduct[]} [products] - Array of products to preview.
+ * @property {IPreviewOrderProduct[]} [products] - Products to include in the preview.
  * @property {string} [couponCode] - Coupon code to apply.
- * @property {string[]} [additionalDiscountsMarkers] - Array of additional discount markers.
+ * @property {string[]} [additionalDiscountsMarkers] - Markers of additional discounts to apply.
  * @property {number} [bonusAmount] - Bonus amount to apply.
  */
 interface ICreateOrderPreview {
@@ -694,11 +694,11 @@ interface ICreateOrderPreview {
 }
 /**
  * @interface IOrderPreviewItem
- * @property {number} id - Product identifier. Example: 2954.
+ * @property {number} id - Product ID. Example: 2954.
  * @property {number} price - Product unit price before discounts. Example: 51.
  * @property {number} quantity - Quantity of the product. Example: 1.
  * @property {number | null} discountPrice - Unit price after discounts, or null when no discount applies. Example: null.
- * @property {boolean} isGift - Whether the product is delivered as a gift. Example: false.
+ * @property {boolean} isGift - Whether the product is a gift. Example: false.
  * @description A single line item in the order preview response.
  */
 interface IOrderPreviewItem {
@@ -715,8 +715,8 @@ interface IOrderPreviewItem {
  * @property {number} totalSumWithDiscount - Total order amount after discounts. Example: 250.
  * @property {IOrderDiscountConfig} discountConfig - Discount configuration applied to the order.
  * @property {string} currency - Currency of the order. Example: "USD".
- * @property {IOrderPreviewItem[]} orderPreview - Array of order preview items.
- * @property {number} bonusApplied - Bonus applied to the order.
+ * @property {IOrderPreviewItem[]} orderPreview - Preview of the order items.
+ * @property {number} bonusApplied - Bonus amount applied to the order.
  * @property {number} totalDue - Total due after bonuses.
  */
 interface IOrderPreviewResponse {
@@ -730,16 +730,16 @@ interface IOrderPreviewResponse {
 }
 /**
  * @interface IRefundRequest
- * @property {number} id - Refund request id.
+ * @property {number} id - Refund request ID.
  * @property {string} createdDate - Creation date.
  * @property {string} status - Refund status.
  * @property {number} amount - Refund amount.
  * @property {string} note - Refund note.
- * @property {Record<string, IRefundProduct>} products - Map of product id to refund details.
- * @property {number} orderId - Order id.
- * @property {number} orderStorageId - Order storage id.
- * @property {number} userId - User id.
- * @property {unknown} orderStorage - Order storage data.
+ * @property {Record<string, IRefundProduct>} products - Refund details keyed by product ID.
+ * @property {number} orderId - ID of the order.
+ * @property {number} orderStorageId - ID of the order storage.
+ * @property {number} userId - User ID.
+ * @property {unknown} orderStorage - Data of the order storage.
  * @property {unknown} user - User data.
  */
 interface IRefundRequest {
@@ -766,8 +766,8 @@ interface IRefundProduct {
 /**
  * @interface ICreateRefundRequest
  * @description Body for creating a refund request.
- * @property {Record<string, IRefundProduct>} products - Map of product id to refund details. Example: `{ "146": { "quantity": 1 } }`.
- * @property {string} [note] - Optional note for the refund request. Example: "test".
+ * @property {Record<string, IRefundProduct>} products - Refund details keyed by product ID. Example: `{ "146": { "quantity": 1 } }`.
+ * @property {string} [note] - Note attached to the refund request. Optional. Example: "test".
  */
 interface ICreateRefundRequest {
     products: Record<string, IRefundProduct>;

package/dist/pages/pagesApi.d.ts

@@ -39,7 +39,7 @@ export default class PagesApi extends AsyncModules implements 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: 1.
+     * @param {number} id - ID of the page to fetch. Example: 1.
      * @param {string} [langCode] - Language code. Default: "en_US".
      * @returns {Promise<IPagesEntity | IError>} Returns PageEntity object
      * @throws {IError} When isShell=false and an error occurs during the fetch
@@ -61,7 +61,7 @@ export default class PagesApi extends AsyncModules implements 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/our-team".
+     * @param {string} url - URL of the parent page whose child pages to fetch. Example: "about/our-team".
      * @param {string} [langCode] - Language code. Default: "en_US".
      * @returns {Promise<IPagesEntity | IError>} 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} When isShell=false and an error occurs during the fetch
@@ -83,7 +83,7 @@ export default class PagesApi extends AsyncModules implements 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] - Page URL. Example: "catalog".
      * @param {string} [langCode] - Language code. Default: "en_US".
      * @returns {Promise<IPagesEntity[] | IPageSearchResult[] | IError>} 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)
@@ -95,10 +95,10 @@ export default class PagesApi extends AsyncModules implements 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 {Promise<IVectorSearchResponse<IPagesResponse> | IError>} Returns an object with an array of found pages and total count.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This method performs a semantic (vector) search for pages.

package/dist/pages/pagesApi.js

@@ -98,7 +98,7 @@ class PagesApi extends asyncModules_1.default {
     /**
      * 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: 1.
+     * @param {number} id - ID of the page to fetch. Example: 1.
      * @param {string} [langCode] - Language code. Default: "en_US".
      * @returns {Promise<IPagesEntity | IError>} Returns PageEntity object
      * @throws {IError} When isShell=false and an error occurs during the fetch
@@ -138,7 +138,7 @@ class PagesApi extends asyncModules_1.default {
     /**
      * 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/our-team".
+     * @param {string} url - URL of the parent page whose child pages to fetch. Example: "about/our-team".
      * @param {string} [langCode] - Language code. Default: "en_US".
      * @returns {Promise<IPagesEntity | IError>} 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} When isShell=false and an error occurs during the fetch
@@ -215,7 +215,7 @@ class PagesApi extends asyncModules_1.default {
     /**
      * 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] - Page URL. Example: "catalog".
      * @param {string} [langCode] - Language code. Default: "en_US".
      * @returns {Promise<IPagesEntity[] | IPageSearchResult[] | IError>} 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)
@@ -249,10 +249,10 @@ class PagesApi extends asyncModules_1.default {
     /**
      * 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 {Promise<IVectorSearchResponse<IPagesResponse> | IError>} Returns an object with an array of found pages and total count.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This method performs a semantic (vector) search for pages.