oneentry 1.0.173 → 1.0.175

package/dist/discounts/discountsInterfaces.d.ts

@@ -12,9 +12,9 @@ interface IDiscountsApi {
      * Return all discounts.
      * @handleName getAllSubscriptions
      * @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 {IDiscountType} [type] - Optional parameter to filter discounts by type.
+     * @param {number} [offset] - Number of records to skip. Default: 0.
+     * @param {number} [limit] - Maximum number of records to return. Default: 30.
+     * @param {IDiscountType} [type] - Discount type to filter by. Optional.
      * @returns {Promise<IDiscountsResponse | IError>} Returns an object containing all discounts or an error object if there was an issue.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Fetches all discounts from the server.
@@ -23,7 +23,7 @@ interface IDiscountsApi {
     /**
      * Get discount by marker
      * @handleName getDiscountByMarker
-     * @param {string} marker - Textual identifier of the discount storage object. Example: "discount_storage".
+     * @param {string} marker - Marker of the discount storage. Example: "discount_storage".
      * @param {string} [langCode] - Language code. Default: "en_US".
      * @returns {Promise<IDiscountsEntity | IError>} Returns an object containing discount by marker or an error object if there was an issue.
      * @throws {IError} When isShell=false and an error occurs during the fetch
@@ -33,7 +33,7 @@ interface IDiscountsApi {
     /**
      * Validate discounts coupon
      * @handleName validateDiscountsCoupon
-     * @param {string} code - The coupon code to validate.
+     * @param {string} code - Coupon code to validate.
      * @returns {Promise<ICouponValidationResult | IError>} Returns an coupon validation result or an error object if there was an issue.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This function validates a coupon code and returns the result.
@@ -49,12 +49,12 @@ interface IDiscountsApi {
     /**
      * Get bonus transaction history of the current user.
      * @handleName getBonusHistory
-     * @param {string} [type] - Transaction type filter.
-     * @param {string} [dateFrom] - Start date filter.
-     * @param {string} [dateTo] - End date filter.
-     * @param {number} [discountId] - Discount id filter.
-     * @param {number} [moduleId] - Module id filter.
-     * @param {boolean} [isAdmin] - Admin filter.
+     * @param {string} [type] - Transaction type to filter by.
+     * @param {string} [dateFrom] - Start of the date range.
+     * @param {string} [dateTo] - End of the date range.
+     * @param {number} [discountId] - Return only transactions of this discount ID.
+     * @param {number} [moduleId] - Filter by module ID.
+     * @param {boolean} [isAdmin] - Filter by the transaction's `isAdmin` flag.
      * @returns {Promise<IBonusHistoryResponse | IError>} Returns the container with the transactions and their total, or an error object.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      */
@@ -62,10 +62,10 @@ interface IDiscountsApi {
     /**
      * Semantic (vector) search for discounts.
      * @handleName getDiscountsByVectorSearch
-     * @param {IDiscountsVectorSearch} body - Vector search body. Example: `{ queryText: "winter sale" }`.
+     * @param {IDiscountsVectorSearch} 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<IDiscountsResponse> | IError>} Returns an object with an array of found discounts and total count.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      */
@@ -76,8 +76,8 @@ interface IDiscountsApi {
  * @interface IDiscountsVectorSearch
  * @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 discounts vector/search endpoint.
  */
 interface IDiscountsVectorSearch {
@@ -113,26 +113,26 @@ interface IDiscountCondition {
 /**
  * Represents a discount entity.
  * @interface IDiscountsEntity
- * @property {number} id - The unique identifier of the discount.
- * @property {number | null} [attributeSetId] - The identifier of the attribute set linked to the discount, or `null` when no set is linked.
- * @property {ILocalizeInfo} [localizeInfos] - The name of the discount.
- * @property {number} [version] - The version of the discount.
- * @property {string} [identifier] - The identifier of the discount.
+ * @property {number} id - ID of the discount.
+ * @property {number | null} [attributeSetId] - ID of the attribute set linked to the discount, or `null` when no set is linked.
+ * @property {ILocalizeInfo} [localizeInfos] - Localized name of the discount.
+ * @property {number} [version] - Version number of the discount.
+ * @property {string} [identifier] - Marker of the discount.
  * @property {IDiscountType} type - The type of the discount.
  * @property {string} [startDate] - The start date of the discount.
- * @property {string} [endDate] - The end date of the discount.
- * @property {IDiscountValue} [discountValue] - The value of the discount, including its type and amount limits.
- * @property {string} [conditionLogic] - The logic of the discount. Possible values are "AND" | "OR".
- * @property {IDiscountCondition[]} [conditions] - The conditions of the discount.
- * @property {Record<string, unknown> | null} [exclusions] - The exclusions of the discount.
- * @property {Record<string, unknown> | null} [gifts] - The gifts of the discount.
+ * @property {string} [endDate] - End date of the discount.
+ * @property {IDiscountValue} [discountValue] - Discount value with its type and amount limits.
+ * @property {string} [conditionLogic] - How the conditions combine: `AND` or `OR`.
+ * @property {IDiscountCondition[]} [conditions] - Conditions of the discount.
+ * @property {Record<string, unknown> | null} [exclusions] - Exclusions of the discount.
+ * @property {Record<string, unknown> | null} [gifts] - Gifts of the discount.
  * @property {boolean} [giftsReplaceCartItems] - Whether the gifts replace cart items.
- * @property {Record<string, unknown> | null} [userGroups] - The user groups of the discount.
- * @property {Record<string, unknown> | null} [userExclusions] - The user exclusions of the discount.
- * @property {IAttributeValues} [attributeValues] - The attribute values of the discount.
- * @property {string} [attributeSetIdentifier] - The identifier of the attribute set.
+ * @property {Record<string, unknown> | null} [userGroups] - User groups the discount applies to.
+ * @property {Record<string, unknown> | null} [userExclusions] - Users excluded from the discount.
+ * @property {IAttributeValues} [attributeValues] - Attribute values of the discount.
+ * @property {string} [attributeSetIdentifier] - Marker of the attribute set.
  * @property {Record<string, unknown>} [bonusEvent] - Bonus event configuration.
- * @property {number} [position] - Position number for sorting. Example: 1.
+ * @property {number} [position] - Position used for sorting. Example: 1.
  * @property {number | string} [total] - Total count of related entries. Example: "1".
  * @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.
  */
@@ -163,7 +163,7 @@ interface IDiscountsEntity {
 /**
  * @interface IDiscountValue
  * @property {'TO_PRODUCT' | 'TO_ORDER'} applicability - What the discount applies to. Example: "TO_PRODUCT".
- * @property {'FIXED_AMOUNT' | 'PERCENT'} discountType - How the discount value is interpreted. Example: "FIXED_AMOUNT".
+ * @property {'FIXED_AMOUNT' | 'PERCENT'} discountType - How the discount value is applied. Example: "FIXED_AMOUNT".
  * @property {number} value - Discount amount (currency units for FIXED_AMOUNT, percentage points for PERCENT). Example: 10.
  * @property {number | null} [maxAmount] - Cap on the absolute discount applied, or `null` when uncapped. Example: 5.
  * @description Configuration of the discount calculation.
@@ -176,12 +176,12 @@ interface IDiscountValue {
 }
 /**
  * @interface ICouponEntity
- * @property {number} id - Coupon record id. Example: 1.
- * @property {number} discountId - Discount the coupon belongs to. Example: 1.
+ * @property {number} id - Coupon record ID. Example: 1.
+ * @property {number} discountId - ID of the discount the coupon belongs to. Example: 1.
  * @property {string} code - Coupon code. Example: "SUMMER-KBWZ-2428".
  * @property {boolean} isReusable - Whether the coupon can be used more than once. Example: false.
  * @property {boolean} isUsed - Whether the coupon has already been used. Example: false.
- * @property {number | null} orderId - Order id where the coupon was applied, or null. Example: null.
+ * @property {number | null} orderId - ID of the order the coupon was applied to, or `null`. Example: null.
  * @property {string | null} usedAt - When the coupon was used, or null. Example: null.
  * @description Coupon entity returned by the discounts API.
  */
@@ -197,7 +197,7 @@ interface ICouponEntity {
 /**
  * Paginated response for discounts list.
  * @interface IDiscountsResponse
- * @property {IDiscountsEntity[]} items - Array of discount entities.
+ * @property {IDiscountsEntity[]} items - Discounts in this response.
  * @property {number} total - Total number of discounts.
  */
 interface IDiscountsResponse {
@@ -207,7 +207,7 @@ interface IDiscountsResponse {
 /**
  * Request body for coupon validation.
  * @interface IDiscountsValidateCoupon
- * @property {string} code - The coupon code to validate.
+ * @property {string} code - Coupon code to validate.
  */
 interface IDiscountsValidateCoupon {
     code: string;
@@ -216,8 +216,8 @@ interface IDiscountsValidateCoupon {
  * Result of coupon validation.
  * @interface ICouponValidationResult
  * @property {boolean} valid - Whether the coupon is valid.
- * @property {ICouponEntity} [coupon] - Coupon data if the coupon is valid.
- * @property {string} [error] - Error message if the coupon is invalid.
+ * @property {ICouponEntity} [coupon] - Coupon data, if the coupon is valid.
+ * @property {string} [error] - Error message, if the coupon is invalid.
  */
 interface ICouponValidationResult {
     valid: boolean;
@@ -240,12 +240,12 @@ interface IDiscountByMarkerQuery {
 type IBonusTransactionType = 'ACCRUAL' | 'USAGE' | 'REDUCE' | 'REVERSAL_ACCRUAL' | 'REVERSAL_USAGE' | 'EXPIRATION';
 /**
  * @interface IBonusHistoryQuery
- * @property {IBonusTransactionType} [type] - Transaction type filter.
- * @property {string} [dateFrom] - Start date filter.
- * @property {string} [dateTo] - End date filter.
- * @property {number} [discountId] - Discount id filter.
- * @property {number} [moduleId] - Module id filter.
- * @property {boolean} [isAdmin] - Admin filter.
+ * @property {IBonusTransactionType} [type] - Transaction type to filter by.
+ * @property {string} [dateFrom] - Start of the date range.
+ * @property {string} [dateTo] - End of the date range.
+ * @property {number} [discountId] - Return only transactions of this discount ID.
+ * @property {number} [moduleId] - Filter by module ID.
+ * @property {boolean} [isAdmin] - Filter by the transaction's `isAdmin` flag.
  */
 interface IBonusHistoryQuery {
     type?: IBonusTransactionType;
@@ -257,16 +257,16 @@ interface IBonusHistoryQuery {
 }
 /**
  * @interface IBonusTransactionEntity
- * @property {number} balanceId - Balance id.
+ * @property {number} balanceId - ID of the bonus balance.
  * @property {number} amount - Transaction amount.
  * @property {IBonusTransactionType} type - Transaction type.
- * @property {number} [discountId] - Discount id.
- * @property {number} [moduleId] - Module id.
+ * @property {number} [discountId] - Discount ID.
+ * @property {number} [moduleId] - ID of the module.
  * @property {string} [entityIdentifier] - Entity identifier.
  * @property {string} [comment] - Comment.
  * @property {boolean} isAdmin - Admin flag.
  * @property {number} [remainingAmount] - Remaining amount.
- * @property {'EVENT' | 'SCHEDULED'} [triggerType] - Trigger type.
+ * @property {'EVENT' | 'SCHEDULED'} [triggerType] - What triggered the transaction: `"EVENT"` or `"SCHEDULED"`.
  * @property {string} [expiresAt] - Expiration date.
  * @property {string} [createdAt] - Creation date.
  */
@@ -286,7 +286,7 @@ interface IBonusTransactionEntity {
 }
 /**
  * @interface IBonusHistoryResponse
- * @property {IBonusTransactionEntity[]} items - The transactions of the current page.
+ * @property {IBonusTransactionEntity[]} items - Transactions on the current page.
  * @property {number} total - How many transactions the filter matches in total.
  * @description Container the bonus history arrives in. The endpoint answers
  * `{ items, total }`, not a bare array — measured on the SDK test stand,
@@ -299,7 +299,7 @@ interface IBonusHistoryResponse {
 /**
  * @interface IBonusBalanceEntity
  * @description Represents the balance of bonus points.
- * @property {number} balance - The balance of bonus points. Example: 100
+ * @property {number} balance - Bonus point balance. Example: 100
  */
 interface IBonusBalanceEntity {
     balance: number;

package/dist/events/eventsApi.d.ts

@@ -25,8 +25,8 @@ export default class EventsApi extends AsyncModules implements IEvents {
     /**
      * Return all subscriptions to product.
      * @handleName getAllSubscriptions
-     * @param {number} [offset] - Optional offset for pagination. Default: 0.
-     * @param {number} [limit] - Optional limit for pagination. Default: 30.
+     * @param {number} [offset] - Number of records to skip. Default: 0.
+     * @param {number} [limit] - Maximum number of records to return. Default: 30.
      * @returns {Promise<ISubscriptions | IError>} Returns an object containing all subscriptions 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.
@@ -37,9 +37,9 @@ export default class EventsApi extends AsyncModules implements IEvents {
     /**
      * Subscribing to an event on a product.
      * @handleName subscribeByMarker
-     * @param {string} marker - Event marker. Example: "product_price_change".
-     * @param {number} productId - Product id. Example: 12345.
-     * @param {string} [langCode] - Language code. Default: "en_US".=
+     * @param {string} marker - Marker of the event. Example: "product_price_change".
+     * @param {number} productId - Product ID. Example: 12345.
+     * @param {string} [langCode] - Language code. Default: "en_US".
      * @returns {Promise<boolean | IError>} Returns true if subscription was successful, 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.
@@ -50,8 +50,8 @@ export default class EventsApi extends AsyncModules implements IEvents {
     /**
      * Unsubscribing to an event on a product.
      * @handleName unsubscribeByMarker
-     * @param {string} marker - The marker of the event to unsubscribe from. Example: "product_price_change".
-     * @param {number} productId - The ID of the product to unsubscribe from. Example: 12345.
+     * @param {string} marker - Marker of the event to unsubscribe from. Example: "product_price_change".
+     * @param {number} productId - ID of the product to unsubscribe from. Example: 12345.
      * @param {string} [langCode] - Language code. Default: "en_US".
      * @returns {Promise<boolean | IError>} - Returns true if the unsubscription succeeded, or an error object if there was an issue.
      * @throws {IError} When isShell=false and an error occurs during the fetch
@@ -72,8 +72,8 @@ export default class EventsApi extends AsyncModules implements IEvents {
     /**
      * Subscribe to a form event by marker.
      * @handleName subscribeToForm
-     * @param {string} marker - Event marker. Example: "form_marker".
-     * @param {ISubscribeFormEvent} body - Subscription body. Example: `{ formDataId: 123 }`.
+     * @param {string} marker - Marker of the event. Example: "form_marker".
+     * @param {ISubscribeFormEvent} body - Subscription parameters. Example: `{ formDataId: 123 }`.
      * @returns {Promise<boolean | IError>} Returns true if the subscription was successful, or an error object.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This method requires user authorization.
@@ -84,8 +84,8 @@ export default class EventsApi extends AsyncModules implements IEvents {
     /**
      * Returns all form subscriptions.
      * @handleName getFormSubscriptions
-     * @param {number} [offset] - Optional offset for pagination. Default: 0.
-     * @param {number} [limit] - Optional limit for pagination. Default: 30.
+     * @param {number} [offset] - Number of records to skip. Default: 0.
+     * @param {number} [limit] - Maximum number of records to return. Default: 30.
      * @returns {Promise<IFormSubscriptionsResponse | IError>} Returns an object with an array of form subscriptions and total count.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This method requires user authorization.
@@ -96,8 +96,8 @@ export default class EventsApi extends AsyncModules implements IEvents {
     /**
      * Unsubscribe from form notifications by marker.
      * @handleName unsubscribeFromForm
-     * @param {string} marker - Event marker. Example: "form_marker".
-     * @param {ISubscribeFormEvent} body - Subscription body. Example: `{ formDataId: 123 }`.
+     * @param {string} marker - Marker of the event. Example: "form_marker".
+     * @param {ISubscribeFormEvent} body - Subscription parameters. Example: `{ formDataId: 123 }`.
      * @returns {Promise<boolean | IError>} Returns true if the unsubscription was successful, or an error object.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This method requires user authorization.

package/dist/events/eventsApi.js

@@ -29,8 +29,8 @@ class EventsApi extends asyncModules_1.default {
     /**
      * Return all subscriptions to product.
      * @handleName getAllSubscriptions
-     * @param {number} [offset] - Optional offset for pagination. Default: 0.
-     * @param {number} [limit] - Optional limit for pagination. Default: 30.
+     * @param {number} [offset] - Number of records to skip. Default: 0.
+     * @param {number} [limit] - Maximum number of records to return. Default: 30.
      * @returns {Promise<ISubscriptions | IError>} Returns an object containing all subscriptions 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.
@@ -48,9 +48,9 @@ class EventsApi extends asyncModules_1.default {
     /**
      * Subscribing to an event on a product.
      * @handleName subscribeByMarker
-     * @param {string} marker - Event marker. Example: "product_price_change".
-     * @param {number} productId - Product id. Example: 12345.
-     * @param {string} [langCode] - Language code. Default: "en_US".=
+     * @param {string} marker - Marker of the event. Example: "product_price_change".
+     * @param {number} productId - Product ID. Example: 12345.
+     * @param {string} [langCode] - Language code. Default: "en_US".
      * @returns {Promise<boolean | IError>} Returns true if subscription was successful, 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.
@@ -67,8 +67,8 @@ class EventsApi extends asyncModules_1.default {
     /**
      * Unsubscribing to an event on a product.
      * @handleName unsubscribeByMarker
-     * @param {string} marker - The marker of the event to unsubscribe from. Example: "product_price_change".
-     * @param {number} productId - The ID of the product to unsubscribe from. Example: 12345.
+     * @param {string} marker - Marker of the event to unsubscribe from. Example: "product_price_change".
+     * @param {number} productId - ID of the product to unsubscribe from. Example: 12345.
      * @param {string} [langCode] - Language code. Default: "en_US".
      * @returns {Promise<boolean | IError>} - Returns true if the unsubscription succeeded, or an error object if there was an issue.
      * @throws {IError} When isShell=false and an error occurs during the fetch
@@ -98,8 +98,8 @@ class EventsApi extends asyncModules_1.default {
     /**
      * Subscribe to a form event by marker.
      * @handleName subscribeToForm
-     * @param {string} marker - Event marker. Example: "form_marker".
-     * @param {ISubscribeFormEvent} body - Subscription body. Example: `{ formDataId: 123 }`.
+     * @param {string} marker - Marker of the event. Example: "form_marker".
+     * @param {ISubscribeFormEvent} body - Subscription parameters. Example: `{ formDataId: 123 }`.
      * @returns {Promise<boolean | IError>} Returns true if the subscription was successful, or an error object.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This method requires user authorization.
@@ -112,8 +112,8 @@ class EventsApi extends asyncModules_1.default {
     /**
      * Returns all form subscriptions.
      * @handleName getFormSubscriptions
-     * @param {number} [offset] - Optional offset for pagination. Default: 0.
-     * @param {number} [limit] - Optional limit for pagination. Default: 30.
+     * @param {number} [offset] - Number of records to skip. Default: 0.
+     * @param {number} [limit] - Maximum number of records to return. Default: 30.
      * @returns {Promise<IFormSubscriptionsResponse | IError>} Returns an object with an array of form subscriptions and total count.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This method requires user authorization.
@@ -131,8 +131,8 @@ class EventsApi extends asyncModules_1.default {
     /**
      * Unsubscribe from form notifications by marker.
      * @handleName unsubscribeFromForm
-     * @param {string} marker - Event marker. Example: "form_marker".
-     * @param {ISubscribeFormEvent} body - Subscription body. Example: `{ formDataId: 123 }`.
+     * @param {string} marker - Marker of the event. Example: "form_marker".
+     * @param {ISubscribeFormEvent} body - Subscription parameters. Example: `{ formDataId: 123 }`.
      * @returns {Promise<boolean | IError>} Returns true if the unsubscription was successful, or an error object.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This method requires user authorization.

package/dist/events/eventsInterfaces.d.ts

@@ -8,8 +8,8 @@ interface IEvents {
     /**
      * Retrieves all subscriptions to products.
      * @handleName getAllSubscriptions
-     * @param {number} [offset] - Optional offset for pagination. Default: 0.
-     * @param {number} [limit] - Optional limit for pagination. Default: 30.
+     * @param {number} [offset] - Number of records to skip. Default: 0.
+     * @param {number} [limit] - Maximum number of records to return. Default: 30.
      * @returns {Promise<ISubscriptions | IError>} A promise that resolves to a subscriptions object or an error.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      * @description This method retrieves all subscriptions to products.
@@ -30,7 +30,7 @@ interface IEvents {
      * Unsubscribes from an event on a product by its marker.
      * @handleName unsubscribeByMarker
      * @param {string} marker - The marker identifying the event. Example: "product_price_change".
-     * @param {number} productId - The ID of the product to unsubscribe from. Example: 12345.
+     * @param {number} productId - ID of the product to unsubscribe from. Example: 12345.
      * @param {string} [langCode] - Optional language code for localization. Default: "en_US".
      * @returns {Promise<boolean | IError>} A promise that resolves to any type or an error.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
@@ -48,8 +48,8 @@ interface IEvents {
     /**
      * Subscribe to a form event by marker.
      * @handleName subscribeToForm
-     * @param {string} marker - Event marker. Example: "form_marker".
-     * @param {ISubscribeFormEvent} body - Subscription body. Example: `{ formDataId: 123 }`.
+     * @param {string} marker - Marker of the event. Example: "form_marker".
+     * @param {ISubscribeFormEvent} body - Subscription parameters. Example: `{ formDataId: 123 }`.
      * @returns {Promise<boolean | IError>} A promise that resolves to true on success, or an error.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      * @description This method subscribes to a form event by marker. This method requires user authorization.
@@ -59,8 +59,8 @@ interface IEvents {
     /**
      * Returns all form subscriptions.
      * @handleName getFormSubscriptions
-     * @param {number} [offset] - Optional offset for pagination. Default: 0.
-     * @param {number} [limit] - Optional limit for pagination. Default: 30.
+     * @param {number} [offset] - Number of records to skip. Default: 0.
+     * @param {number} [limit] - Maximum number of records to return. Default: 30.
      * @returns {Promise<IFormSubscriptionsResponse | IError>} A promise that resolves to an object with an array of form subscriptions and total count, or an error.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      * @description This method returns all form subscriptions. This method requires user authorization.
@@ -70,8 +70,8 @@ interface IEvents {
     /**
      * Unsubscribe from form notifications by marker.
      * @handleName unsubscribeFromForm
-     * @param {string} marker - Event marker. Example: "form_marker".
-     * @param {ISubscribeFormEvent} body - Subscription body. Example: `{ formDataId: 123 }`.
+     * @param {string} marker - Marker of the event. Example: "form_marker".
+     * @param {ISubscribeFormEvent} body - Subscription parameters. Example: `{ formDataId: 123 }`.
      * @returns {Promise<boolean | IError>} A promise that resolves to true on success, or an error.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      * @description This method unsubscribes from form notifications by marker. This method requires user authorization.
@@ -83,7 +83,7 @@ interface IEvents {
  * Represents a response from the events API containing a total count and an array of subscription items.
  * @interface ISubscriptions
  * @property {number} total - Total number of found records. Example: 100.
- * @property {ISubscriptionItem[]} items - Array of subscription items, each containing an event marker and a product ID.
+ * @property {ISubscriptionItem[]} items - Subscriptions, each with an event marker and a product ID.
  * @example
  [
    {
@@ -128,10 +128,10 @@ interface ISubscribeBody {
 /**
  * Represents an event returned by the events API.
  * @interface IContentApiEvent
- * @property {number} id - Event identifier. Example: 1.
- * @property {string} identifier - Event text identifier. Example: "price_change".
- * @property {Record<string, unknown>} localizeInfos - Localized info of the event.
- * @property {string} [module] - Module the event belongs to; absent on system events not bound to a module (e.g. "send_code"). Example: "catalog".
+ * @property {number} id - Event ID. Example: 1.
+ * @property {string} identifier - Marker of the event. Example: "price_change".
+ * @property {Record<string, unknown>} localizeInfos - Localized data of the event.
+ * @property {string} [module] - Module the event belongs to; absent on system events that are not bound to a module, such as `send_code`. Example: "catalog".
  * @description Represents a single available event.
  */
 interface IContentApiEvent {
@@ -144,7 +144,7 @@ interface IContentApiEvent {
  * Represents a form subscription item.
  * @interface IListFormSubscription
  * @property {string} eventMarker - Event marker. Example: "form_marker".
- * @property {number} formDataId - Form data identifier. Example: 123.
+ * @property {number} formDataId - Form data ID. Example: 123.
  * @description Represents a single form subscription.
  */
 interface IListFormSubscription {
@@ -154,7 +154,7 @@ interface IListFormSubscription {
 /**
  * Represents the response of the form subscriptions list endpoint.
  * @interface IFormSubscriptionsResponse
- * @property {IListFormSubscription[]} items - Array of form subscriptions.
+ * @property {IListFormSubscription[]} items - Form subscriptions of the current user.
  * @property {number} total - Total number of subscriptions. Example: 0.
  * @description Container returned by `getFormSubscriptions`.
  */
@@ -165,8 +165,8 @@ interface IFormSubscriptionsResponse {
 /**
  * Body for subscribing to / unsubscribing from a form event.
  * @interface ISubscribeFormEvent
- * @property {number} formDataId - Form data identifier. Example: 123.
- * @property {string} [status] - Optional subscription status.
+ * @property {number} formDataId - Form data ID. Example: 123.
+ * @property {string} [status] - Moderation status of the form data to subscribe to, for example `"approved"`. Optional.
  * @description Body for the form subscribe/unsubscribe methods.
  */
 interface ISubscribeFormEvent {

package/dist/file-uploading/fileUploadingApi.d.ts

@@ -23,7 +23,7 @@ export default class FileUploadingApi extends AsyncModules implements IFileUploa
      * Upload file function.
      * @handleName upload
      * @param {File | Blob} file - File to upload. Example: `new File(["content"], "file.png", {"type": "image/png"})`
-     * @param {IUploadingQuery} fileQuery - Where the file lives in the storage. Required: without `type`, `entity` and `id` the endpoint answers `400 … should not be empty`.
+     * @param {IUploadingQuery} fileQuery - Where the file is stored. Required: without `type`, `entity` and `id` the endpoint answers `400 … should not be empty`.
      * @example
         {
           "type": "page",
@@ -34,9 +34,9 @@ export default class FileUploadingApi extends AsyncModules implements IFileUploa
           "compress": true,
           "template": 1
         }
-     * @param {string} fileQuery.type - Type, determines the folder name in the storage. Example: "page".
-     * @param {string} fileQuery.entity - Entity name from which the file is uploaded, determines the folder name in the storage. Example: "editor".
-     * @param {number} fileQuery.id - Identifier of the object from which the file is uploaded, determines the folder name in the storage. Example: 3787.
+     * @param {string} fileQuery.type - Storage type; determines the folder the file is stored in, for example `"page"`. Example: "page".
+     * @param {string} fileQuery.entity - Name of the entity the file belongs to; sets the folder name in the storage. Example: "editor".
+     * @param {number} fileQuery.id - ID of the object the file belongs to; sets the folder name in the storage. Example: 3787.
      * @param {number} [fileQuery.width] - Optional width parameter. Example: 0.
      * @param {number} [fileQuery.height] - Optional height parameter. Example: 0.
      * @param {boolean} [fileQuery.compress] - Optional flag of optimization (compression) for images. Example: true.
@@ -50,7 +50,7 @@ export default class FileUploadingApi extends AsyncModules implements IFileUploa
      * Deletes a file from the cloud file storage.
      * @handleName delete
      * @param {string} filename - File name. Example: "file.png".
-     * @param {IUploadingQuery} fileQuery - Where the file lives in the storage. Required: without `type`, `entity` and `id` the endpoint answers `400 … should not be empty`.
+     * @param {IUploadingQuery} fileQuery - Where the file is stored. Required: without `type`, `entity` and `id` the endpoint answers `400 … should not be empty`.
      * @example
         {
           "type": "page",
@@ -58,9 +58,9 @@ export default class FileUploadingApi extends AsyncModules implements IFileUploa
           "id": 3787,
           "template": 1
         }
-     * @param {string} fileQuery.type - Type, determines the folder name in the storage. Example: "page".
-     * @param {string} fileQuery.entity - Entity name from which the file is uploaded, determines the folder name in the storage. Example: "editor".
-     * @param {number} fileQuery.id - Identifier of the object from which the file is uploaded, determines the folder name in the storage. Example: 3787.
+     * @param {string} fileQuery.type - Storage type; determines the folder the file is stored in, for example `"page"`. Example: "page".
+     * @param {string} fileQuery.entity - Name of the entity the file belongs to; sets the folder name in the storage. Example: "editor".
+     * @param {number} fileQuery.id - ID of the object the file belongs to; sets the folder name in the storage. Example: 3787.
      * @param {number} [fileQuery.template] - preview template identifier. Example: 1.
      * @returns {Promise<boolean | IError>} Returns a promise that resolves to true when the file was deleted or an error object if there was an issue.
      * @throws {IError} When isShell=false and an error occurs during the fetch
@@ -76,7 +76,7 @@ export default class FileUploadingApi extends AsyncModules implements IFileUploa
      * @param {string[]} [ownerTables] - Filter by the section the attached record belongs to, sent comma-separated. Example: ["products", "pages"].
      * @param {string[]} [localeCodes] - Filter by the locale of the link, not of the file content. Example: ["en_US"].
      * @param {boolean} [onlyTruncated] - Return only files whose extracted text was cut at the size ceiling.
-     * @param {number} [offset] - Parameter for pagination. Default: 0.
+     * @param {number} [offset] - Number of records to skip. Default: 0.
      * @param {number} [limit] - Parameter for pagination. Default: 10, maximum 50 — a larger value is rejected with 400 "limit must not be greater than 50".
      * @returns {Promise<IFileSearchResponse | IError>} Returns the found files with their matching fragments.
      * @throws {IError} When isShell=false and an error occurs during the fetch
@@ -104,11 +104,11 @@ export default class FileUploadingApi extends AsyncModules implements IFileUploa
     /**
      * Get file by parameters.
      * @handleName getFile
-     * @param {number} id - Object identifier, from which the file is uploaded, determines the folder name in the storage. Example: 3787.
-     * @param {string} type - Type, determines the folder name in the storage. Example: "page".
-     * @param {string} entity - Entity name, from which the file is uploaded, determines the folder name in the storage. Example: "editor".
-     * @param {string} filename - Filename. Example: "file.png".
-     * @param {string} [template] - Preview template identifier. Example: "preview_template".
+     * @param {number} id - ID of the object the file belongs to; sets the folder name in the storage. Example: 3787.
+     * @param {string} type - Storage type; determines the folder the file is stored in, for example `"page"`. Example: "page".
+     * @param {string} entity - Name of the entity the file belongs to; sets the folder name in the storage. Example: "editor".
+     * @param {string} filename - File name. Example: "file.png".
+     * @param {string} [template] - Preview template: its numeric ID or its marker, for example `"preview"`. Without it, no preview is generated. Example: "preview_template".
      * @returns {Promise<Response | IError>} Returns a promise that resolves to a Response object containing the file data or an error object if there was an issue.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @see {@link https://js-sdk.oneentry.cloud/docs/file-uploading/getFile getFile} documentation.

package/dist/file-uploading/fileUploadingApi.js

@@ -66,7 +66,7 @@ class FileUploadingApi extends asyncModules_1.default {
      * Upload file function.
      * @handleName upload
      * @param {File | Blob} file - File to upload. Example: `new File(["content"], "file.png", {"type": "image/png"})`
-     * @param {IUploadingQuery} fileQuery - Where the file lives in the storage. Required: without `type`, `entity` and `id` the endpoint answers `400 … should not be empty`.
+     * @param {IUploadingQuery} fileQuery - Where the file is stored. Required: without `type`, `entity` and `id` the endpoint answers `400 … should not be empty`.
      * @example
         {
           "type": "page",
@@ -77,9 +77,9 @@ class FileUploadingApi extends asyncModules_1.default {
           "compress": true,
           "template": 1
         }
-     * @param {string} fileQuery.type - Type, determines the folder name in the storage. Example: "page".
-     * @param {string} fileQuery.entity - Entity name from which the file is uploaded, determines the folder name in the storage. Example: "editor".
-     * @param {number} fileQuery.id - Identifier of the object from which the file is uploaded, determines the folder name in the storage. Example: 3787.
+     * @param {string} fileQuery.type - Storage type; determines the folder the file is stored in, for example `"page"`. Example: "page".
+     * @param {string} fileQuery.entity - Name of the entity the file belongs to; sets the folder name in the storage. Example: "editor".
+     * @param {number} fileQuery.id - ID of the object the file belongs to; sets the folder name in the storage. Example: 3787.
      * @param {number} [fileQuery.width] - Optional width parameter. Example: 0.
      * @param {number} [fileQuery.height] - Optional height parameter. Example: 0.
      * @param {boolean} [fileQuery.compress] - Optional flag of optimization (compression) for images. Example: true.
@@ -101,7 +101,7 @@ class FileUploadingApi extends asyncModules_1.default {
      * Deletes a file from the cloud file storage.
      * @handleName delete
      * @param {string} filename - File name. Example: "file.png".
-     * @param {IUploadingQuery} fileQuery - Where the file lives in the storage. Required: without `type`, `entity` and `id` the endpoint answers `400 … should not be empty`.
+     * @param {IUploadingQuery} fileQuery - Where the file is stored. Required: without `type`, `entity` and `id` the endpoint answers `400 … should not be empty`.
      * @example
         {
           "type": "page",
@@ -109,9 +109,9 @@ class FileUploadingApi extends asyncModules_1.default {
           "id": 3787,
           "template": 1
         }
-     * @param {string} fileQuery.type - Type, determines the folder name in the storage. Example: "page".
-     * @param {string} fileQuery.entity - Entity name from which the file is uploaded, determines the folder name in the storage. Example: "editor".
-     * @param {number} fileQuery.id - Identifier of the object from which the file is uploaded, determines the folder name in the storage. Example: 3787.
+     * @param {string} fileQuery.type - Storage type; determines the folder the file is stored in, for example `"page"`. Example: "page".
+     * @param {string} fileQuery.entity - Name of the entity the file belongs to; sets the folder name in the storage. Example: "editor".
+     * @param {number} fileQuery.id - ID of the object the file belongs to; sets the folder name in the storage. Example: 3787.
      * @param {number} [fileQuery.template] - preview template identifier. Example: 1.
      * @returns {Promise<boolean | IError>} Returns a promise that resolves to true when the file was deleted or an error object if there was an issue.
      * @throws {IError} When isShell=false and an error occurs during the fetch
@@ -132,7 +132,7 @@ class FileUploadingApi extends asyncModules_1.default {
      * @param {string[]} [ownerTables] - Filter by the section the attached record belongs to, sent comma-separated. Example: ["products", "pages"].
      * @param {string[]} [localeCodes] - Filter by the locale of the link, not of the file content. Example: ["en_US"].
      * @param {boolean} [onlyTruncated] - Return only files whose extracted text was cut at the size ceiling.
-     * @param {number} [offset] - Parameter for pagination. Default: 0.
+     * @param {number} [offset] - Number of records to skip. Default: 0.
      * @param {number} [limit] - Parameter for pagination. Default: 10, maximum 50 — a larger value is rejected with 400 "limit must not be greater than 50".
      * @returns {Promise<IFileSearchResponse | IError>} Returns the found files with their matching fragments.
      * @throws {IError} When isShell=false and an error occurs during the fetch
@@ -182,11 +182,11 @@ class FileUploadingApi extends asyncModules_1.default {
     /**
      * Get file by parameters.
      * @handleName getFile
-     * @param {number} id - Object identifier, from which the file is uploaded, determines the folder name in the storage. Example: 3787.
-     * @param {string} type - Type, determines the folder name in the storage. Example: "page".
-     * @param {string} entity - Entity name, from which the file is uploaded, determines the folder name in the storage. Example: "editor".
-     * @param {string} filename - Filename. Example: "file.png".
-     * @param {string} [template] - Preview template identifier. Example: "preview_template".
+     * @param {number} id - ID of the object the file belongs to; sets the folder name in the storage. Example: 3787.
+     * @param {string} type - Storage type; determines the folder the file is stored in, for example `"page"`. Example: "page".
+     * @param {string} entity - Name of the entity the file belongs to; sets the folder name in the storage. Example: "editor".
+     * @param {string} filename - File name. Example: "file.png".
+     * @param {string} [template] - Preview template: its numeric ID or its marker, for example `"preview"`. Without it, no preview is generated. Example: "preview_template".
      * @returns {Promise<Response | IError>} Returns a promise that resolves to a Response object containing the file data or an error object if there was an issue.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @see {@link https://js-sdk.oneentry.cloud/docs/file-uploading/getFile getFile} documentation.