oneentry 1.0.152 → 1.0.153

package/dist/blocks/blocksApi.js

@@ -3,6 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+/* eslint-disable jsdoc/reject-any-type */
 /* eslint-disable @typescript-eslint/no-explicit-any */
 const asyncModules_1 = __importDefault(require("../base/asyncModules"));
 const blocksSchemas_1 = require("./blocksSchemas");
@@ -31,6 +32,7 @@ class BlocksApi extends asyncModules_1.default {
      * @param {number} [limit] - Parameter for pagination. Default: 30.
      * @returns {Promise<IBlocksResponse | IError>} Returns BlocksEntity object.
      * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @see {@link https://js-sdk.oneentry.cloud/docs/blocks/getBlocks getBlocks} documentation.
      */
     async getBlocks(type, langCode = this.state.lang, offset = 0, limit = 30) {
         // type is omitted from the query when not provided — the API rejects an
@@ -41,41 +43,8 @@ class BlocksApi extends asyncModules_1.default {
         const validated = this._validateResponse(response, blocksSchemas_1.BlocksResponseSchema);
         if (!this.state.traficLimit) {
             const normalizeResponse = this._normalizeData(validated);
-            await Promise.all(normalizeResponse.items.map(async (block) => {
-                const customSettings = block.customSettings;
-                if (customSettings &&
-                    Object.prototype.hasOwnProperty.call(customSettings, 'productConfig')) {
-                    if (customSettings.productConfig.countElementsPerRow)
-                        block.countElementsPerRow =
-                            +customSettings.productConfig.countElementsPerRow;
-                    if (customSettings.productConfig.quantity)
-                        block.quantity = +customSettings.productConfig.quantity;
-                }
-                delete block.customSettings;
-                delete block.attributesSetIdentifier;
-                delete block.productPageUrls;
-                if (block.type === 'similar_products_block') {
-                    try {
-                        await this.getSimilarProducts(block.identifier, langCode, offset, limit).then((result) => {
-                            block.similarProducts = result;
-                        });
-                    }
-                    catch {
-                        block.similarProducts = [];
-                    }
-                }
-                else if (block.type === 'product_block') {
-                    try {
-                        await this.getProductsByBlockMarker(block.identifier, langCode, offset, limit).then((result) => {
-                            block.products = result;
-                        });
-                    }
-                    catch {
-                        block.products = [];
-                    }
-                }
-            }));
-            return this._normalizeData(normalizeResponse);
+            await Promise.all(normalizeResponse.items.map((block) => this._enrichBlock(block, langCode, offset, limit, true)));
+            return normalizeResponse;
         }
         return this._normalizeData(validated);
     }
@@ -89,47 +58,70 @@ class BlocksApi extends asyncModules_1.default {
      * @returns {Promise<IBlockEntity | IError>} - Returns a BlockEntity object.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This method retrieves a block by its marker and includes additional information such as similar products or products associated with the block.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/blocks/getBlockByMarker getBlockByMarker} documentation.
      */
     async getBlockByMarker(marker, langCode = this.state.lang, offset = 0, limit = 30) {
         const response = await this._fetchGet(`/marker/${marker}?langCode=${langCode}`);
         // Validate response if validation is enabled
         const validated = this._validateResponse(response, blocksSchemas_1.BlockEntitySchema);
         const normalizeResponse = this._normalizeData(validated);
-        const customSettings = normalizeResponse.customSettings;
+        await this._enrichBlock(normalizeResponse, langCode, offset, limit, !this.state.traficLimit);
+        return normalizeResponse;
+    }
+    /**
+     * Enrich a single block in place.
+     *
+     * Lifts product display settings from `customSettings.productConfig` to
+     * numeric top-level fields, strips internal-only fields, and — when
+     * `loadProducts` is true — fetches the related products for
+     * `similar_products_block` / `product_block` blocks. Shared by `getBlocks`
+     * (array) and `getBlockByMarker` (single block). Mutates `block` in place.
+     * @param {any} block - Normalized block to enrich (mutated in place).
+     * @param {string} langCode - Language code passed to product sub-requests.
+     * @param {number} offset - Pagination offset for product sub-requests.
+     * @param {number} limit - Pagination limit for product sub-requests.
+     * @param {boolean} loadProducts - Whether to fetch related products.
+     * @returns {Promise<void>} Resolves when enrichment (incl. sub-requests) is done.
+     */
+    async _enrichBlock(block, langCode, offset, limit, loadProducts) {
+        const customSettings = block.customSettings;
+        // Если у блока есть настройки отображения товаров (productConfig) —
+        // переносим их на верхний уровень блока в числовом формате (в API значения
+        // хранятся строками, поэтому приводим через «+»).
         if (customSettings &&
             Object.prototype.hasOwnProperty.call(customSettings, 'productConfig')) {
             if (customSettings.productConfig.countElementsPerRow)
-                normalizeResponse.countElementsPerRow =
+                block.countElementsPerRow =
                     +customSettings.productConfig.countElementsPerRow;
             if (customSettings.productConfig.quantity)
-                normalizeResponse.quantity = +customSettings.productConfig.quantity;
+                block.quantity = +customSettings.productConfig.quantity;
         }
-        delete normalizeResponse.customSettings;
-        delete normalizeResponse.attributesSetIdentifier;
-        delete normalizeResponse.productPageUrls;
-        if (!this.state.traficLimit) {
-            if (normalizeResponse.type === 'similar_products_block') {
-                try {
-                    await this.getSimilarProducts(normalizeResponse.identifier, langCode, offset, limit).then((result) => {
-                        normalizeResponse.similarProducts = result;
-                    });
-                }
-                catch {
-                    normalizeResponse.similarProducts = [];
-                }
+        // Убираем служебные/внутренние поля из итогового объекта блока.
+        delete block.customSettings;
+        delete block.attributesSetIdentifier;
+        delete block.productPageUrls;
+        // В режиме экономии трафика товары не подгружаем.
+        if (!loadProducts)
+            return;
+        // Подгружаем связанные товары по идентификатору блока. При ошибке запроса
+        // подставляем пустой массив, чтобы один упавший подзапрос не ронял весь
+        // ответ (в getBlocks — не ломал обработку остальных блоков).
+        if (block.type === 'similar_products_block') {
+            try {
+                block.similarProducts = await this.getSimilarProducts(block.identifier, langCode, offset, limit);
+            }
+            catch {
+                block.similarProducts = [];
+            }
+        }
+        else if (block.type === 'product_block') {
+            try {
+                block.products = await this.getProductsByBlockMarker(block.identifier, langCode, offset, limit);
             }
-            else if (normalizeResponse.type === 'product_block') {
-                try {
-                    await this.getProductsByBlockMarker(normalizeResponse.identifier, langCode, offset, limit).then((result) => {
-                        normalizeResponse.products = result;
-                    });
-                }
-                catch {
-                    normalizeResponse.products = [];
-                }
+            catch {
+                block.products = [];
             }
         }
-        return this._normalizeData(normalizeResponse);
     }
     /**
      * Get similar products by block marker.
@@ -140,8 +132,9 @@ class BlocksApi extends asyncModules_1.default {
      * @param {number} [limit] - Parameter for pagination. Default: 30.
      * @param {string} [signPrice] - Sign price.
      * @param {number} [productId] - Optional product id to find similar products for.
-     * @returns {Promise<IProductsResponse | IError>} - Returns the total count and an array of product items in object by specified block marker.
+     * @returns {Promise<IProductsResponse | IError>} Returns the total count and an array of product items in object by specified block marker.
      * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @see {@link https://js-sdk.oneentry.cloud/docs/blocks/getSimilarProducts getSimilarProducts} documentation.
      */
     async getSimilarProducts(marker, langCode = this.state.lang, offset = 0, limit = 30, signPrice, productId) {
         const query = {
@@ -164,6 +157,7 @@ class BlocksApi extends asyncModules_1.default {
      * @param {string} [signPrice] - Sign price.
      * @returns {Promise<IProductsEntity[] | IError>} Return array of BlocksEntity object.
      * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @see {@link https://js-sdk.oneentry.cloud/docs/blocks/getProductsByBlockMarker getProductsByBlockMarker} documentation.
      */
     async getProductsByBlockMarker(marker, langCode = this.state.lang, offset = 0, limit = 30, signPrice) {
         const query = {
@@ -184,6 +178,7 @@ class BlocksApi extends asyncModules_1.default {
      * @param {string} [signPrice] - Sign price.
      * @returns {Promise<IProductsResponse | IError>} Returns a products response with items and total.
      * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @see {@link https://js-sdk.oneentry.cloud/docs/blocks/getFrequentlyOrderedProducts getFrequentlyOrderedProducts} documentation.
      */
     async getFrequentlyOrderedProducts(productId, marker, langCode = this.state.lang, signPrice) {
         const query = {
@@ -201,6 +196,7 @@ class BlocksApi extends asyncModules_1.default {
      * @param {string} [langCode] - Language code. Default: "en_US".
      * @returns {Promise<ISearchBlock[] | IError>} Returns an array of ISearchBlock objects.
      * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @see {@link https://js-sdk.oneentry.cloud/docs/blocks/searchBlock searchBlock} documentation.
      */
     async searchBlock(name, langCode = this.state.lang) {
         const result = await this._fetchGet(`/quick/search?langCode=${langCode}&name=${name}`);
@@ -216,6 +212,7 @@ class BlocksApi extends asyncModules_1.default {
      * @param {string} [signPrice] - Sign price.
      * @returns {Promise<IProductsEntity[] | IError>} Returns an array of products.
      * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @see {@link https://js-sdk.oneentry.cloud/docs/blocks/getCartComplement getCartComplement} documentation.
      */
     async getCartComplement(marker, langCode = this.state.lang, signPrice) {
         const query = { langCode, signPrice };
@@ -234,6 +231,7 @@ class BlocksApi extends asyncModules_1.default {
         }
      * @returns {Promise<IProductsEntity[] | IError>} Returns an array of products.
      * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @see {@link https://js-sdk.oneentry.cloud/docs/blocks/getCartComplementByProductIds getCartComplementByProductIds} documentation.
      */
     async getCartComplementByProductIds(marker, body) {
         const data = await this._fetchPost(`/${marker}/cart-complement`, { langCode: this.state.lang, ...body });
@@ -247,6 +245,7 @@ class BlocksApi extends asyncModules_1.default {
      * @param {string} [signPrice] - Sign price.
      * @returns {Promise<IProductsEntity[] | IError>} Returns an array of products.
      * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @see {@link https://js-sdk.oneentry.cloud/docs/blocks/getCartSimilar getCartSimilar} documentation.
      */
     async getCartSimilar(marker, langCode = this.state.lang, signPrice) {
         const query = { langCode, signPrice };
@@ -265,6 +264,7 @@ class BlocksApi extends asyncModules_1.default {
         }
      * @returns {Promise<IProductsEntity[] | IError>} Returns an array of products.
      * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @see {@link https://js-sdk.oneentry.cloud/docs/blocks/getCartSimilarByProductIds getCartSimilarByProductIds} documentation.
      */
     async getCartSimilarByProductIds(marker, body) {
         const data = await this._fetchPost(`/${marker}/cart-similar`, { langCode: this.state.lang, ...body });
@@ -278,6 +278,7 @@ class BlocksApi extends asyncModules_1.default {
      * @param {string} [signPrice] - Sign price.
      * @returns {Promise<IProductsEntity[] | IError>} Returns an array of products.
      * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @see {@link https://js-sdk.oneentry.cloud/docs/blocks/getPersonalRecommendations getPersonalRecommendations} documentation.
      */
     async getPersonalRecommendations(marker, langCode = this.state.lang, signPrice) {
         const query = { langCode, signPrice };
@@ -292,6 +293,7 @@ class BlocksApi extends asyncModules_1.default {
      * @param {string} [signPrice] - Sign price.
      * @returns {Promise<IProductsEntity[] | IError>} Returns an array of products.
      * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @see {@link https://js-sdk.oneentry.cloud/docs/blocks/getRecentlyViewed getRecentlyViewed} documentation.
      */
     async getRecentlyViewed(marker, langCode = this.state.lang, signPrice) {
         const query = { langCode, signPrice };
@@ -306,6 +308,7 @@ class BlocksApi extends asyncModules_1.default {
      * @param {string} [signPrice] - Sign price.
      * @returns {Promise<IProductsEntity[] | IError>} Returns an array of products.
      * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @see {@link https://js-sdk.oneentry.cloud/docs/blocks/getRepeatPurchase getRepeatPurchase} documentation.
      */
     async getRepeatPurchase(marker, langCode = this.state.lang, signPrice) {
         const query = { langCode, signPrice };
@@ -318,6 +321,7 @@ class BlocksApi extends asyncModules_1.default {
      * @param {string} marker - Block marker. Example: "slider_block".
      * @returns {Promise<IBlockSlidesResponse | IError>} Returns the slides response.
      * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @see {@link https://js-sdk.oneentry.cloud/docs/blocks/getSlides getSlides} documentation.
      */
     async getSlides(marker) {
         const data = await this._fetchGet(`/${marker}/slides`);
@@ -331,6 +335,7 @@ class BlocksApi extends asyncModules_1.default {
      * @param {string} [signPrice] - Sign price.
      * @returns {Promise<IProductsEntity[] | IError>} Returns an array of products.
      * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @see {@link https://js-sdk.oneentry.cloud/docs/blocks/getTrending getTrending} documentation.
      */
     async getTrending(marker, langCode = this.state.lang, signPrice) {
         const query = { langCode, signPrice };
@@ -345,6 +350,7 @@ class BlocksApi extends asyncModules_1.default {
      * @param {string} [signPrice] - Sign price.
      * @returns {Promise<IProductsEntity[] | IError>} Returns an array of products.
      * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @see {@link https://js-sdk.oneentry.cloud/docs/blocks/getWishlistSimilar getWishlistSimilar} documentation.
      */
     async getWishlistSimilar(marker, langCode = this.state.lang, signPrice) {
         const query = { langCode, signPrice };
@@ -363,6 +369,7 @@ class BlocksApi extends asyncModules_1.default {
         }
      * @returns {Promise<IProductsEntity[] | IError>} Returns an array of products.
      * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @see {@link https://js-sdk.oneentry.cloud/docs/blocks/getWishlistSimilarByProductIds getWishlistSimilarByProductIds} documentation.
      */
     async getWishlistSimilarByProductIds(marker, body) {
         const data = await this._fetchPost(`/${marker}/wishlist-similar`, { langCode: this.state.lang, ...body });

package/dist/discounts/discountsApi.d.ts

@@ -32,6 +32,7 @@ export default class DiscountsApi extends AsyncModules implements IDiscountsApi
      * @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.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/discounts/getAllDiscounts getAllDiscounts} documentation.
      */
     getAllDiscounts(langCode?: string, offset?: number, limit?: number, type?: IDiscountType): Promise<IDiscountsResponse | IError>;
     /**
@@ -42,6 +43,7 @@ export default class DiscountsApi extends AsyncModules implements IDiscountsApi
      * @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
      * @description Fetches a discount by its marker.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/discounts/getDiscountByMarker getDiscountByMarker} documentation.
      */
     getDiscountByMarker(marker: string, langCode?: string): Promise<IDiscountsEntity | IError>;
     /**
@@ -49,6 +51,7 @@ export default class DiscountsApi extends AsyncModules implements IDiscountsApi
      * @handleName getBonusBalance
      * @returns {Promise<IBonusBalanceEntity | IError>} Returns bonus balance or an error object.
      * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @see {@link https://js-sdk.oneentry.cloud/docs/discounts/getBonusBalance getBonusBalance} documentation.
      */
     getBonusBalance(): Promise<IBonusBalanceEntity | IError>;
     /**
@@ -62,6 +65,7 @@ export default class DiscountsApi extends AsyncModules implements IDiscountsApi
      * @param {boolean} [isAdmin] - Admin filter.
      * @returns {Promise<IBonusTransactionEntity[] | IError>} Returns array of bonus transactions or an error object.
      * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @see {@link https://js-sdk.oneentry.cloud/docs/discounts/getBonusHistory getBonusHistory} documentation.
      */
     getBonusHistory(type?: IBonusTransactionType, dateFrom?: string, dateTo?: string, discountId?: number, moduleId?: number, isAdmin?: boolean): Promise<IBonusTransactionEntity[] | IError>;
     /**
@@ -71,6 +75,7 @@ export default class DiscountsApi extends AsyncModules implements IDiscountsApi
      * @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.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/discounts/validateDiscountsCoupon validateDiscountsCoupon} documentation.
      */
     validateDiscountsCoupon(code: string): Promise<ICouponValidationResult | IError>;
 }

package/dist/discounts/discountsApi.js

@@ -35,6 +35,7 @@ class DiscountsApi extends asyncModules_1.default {
      * @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.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/discounts/getAllDiscounts getAllDiscounts} documentation.
      */
     async getAllDiscounts(langCode = this.state.lang, offset = 0, limit = 30, type) {
         const query = {
@@ -54,6 +55,7 @@ class DiscountsApi extends asyncModules_1.default {
      * @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
      * @description Fetches a discount by its marker.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/discounts/getDiscountByMarker getDiscountByMarker} documentation.
      */
     async getDiscountByMarker(marker, langCode = this.state.lang) {
         const query = {
@@ -68,6 +70,7 @@ class DiscountsApi extends asyncModules_1.default {
      * @handleName getBonusBalance
      * @returns {Promise<IBonusBalanceEntity | IError>} Returns bonus balance or an error object.
      * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @see {@link https://js-sdk.oneentry.cloud/docs/discounts/getBonusBalance getBonusBalance} documentation.
      */
     async getBonusBalance() {
         const data = await this._fetchGet(`/bonus-balance`);
@@ -84,6 +87,7 @@ class DiscountsApi extends asyncModules_1.default {
      * @param {boolean} [isAdmin] - Admin filter.
      * @returns {Promise<IBonusTransactionEntity[] | IError>} Returns array of bonus transactions or an error object.
      * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @see {@link https://js-sdk.oneentry.cloud/docs/discounts/getBonusHistory getBonusHistory} documentation.
      */
     async getBonusHistory(type, dateFrom, dateTo, discountId, moduleId, isAdmin) {
         const query = {
@@ -104,6 +108,7 @@ class DiscountsApi extends asyncModules_1.default {
      * @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.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/discounts/validateDiscountsCoupon validateDiscountsCoupon} documentation.
      */
     async validateDiscountsCoupon(code) {
         const query = {

package/dist/events/eventsApi.d.ts

@@ -31,6 +31,7 @@ export default class EventsApi extends AsyncModules implements IEvents {
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This method requires user authorization.
      * @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}.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/events/getAllSubscriptions getAllSubscriptions} documentation.
      */
     getAllSubscriptions(offset?: number, limit?: number): Promise<ISubscriptions | IError>;
     /**
@@ -43,6 +44,7 @@ export default class EventsApi extends AsyncModules implements IEvents {
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This method requires user authorization.
      * @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}.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/events/subscribeByMarker subscribeByMarker} documentation.
      */
     subscribeByMarker(marker: string, productId: number, langCode?: string): Promise<boolean | IError>;
     /**
@@ -55,6 +57,7 @@ export default class EventsApi extends AsyncModules implements IEvents {
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This method requires user authorization.
      * @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}.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/events/unsubscribeByMarker unsubscribeByMarker} documentation.
      */
     unsubscribeByMarker(marker: string, productId: number, langCode?: string): Promise<boolean | IError>;
     /**
@@ -63,6 +66,7 @@ export default class EventsApi extends AsyncModules implements IEvents {
      * @returns {Promise<IContentApiEvent[] | IError>} Returns an array of available events.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This method returns all available events.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/events/getAllEvents getAllEvents} documentation.
      */
     getAllEvents(): Promise<IContentApiEvent[] | IError>;
     /**
@@ -74,6 +78,7 @@ export default class EventsApi extends AsyncModules implements IEvents {
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This method requires user authorization.
      * @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}.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/events/subscribeToForm subscribeToForm} documentation.
      */
     subscribeToForm(marker: string, body: ISubscribeFormEvent): Promise<boolean | IError>;
     /**
@@ -85,6 +90,7 @@ export default class EventsApi extends AsyncModules implements IEvents {
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This method requires user authorization.
      * @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}.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/events/getFormSubscriptions getFormSubscriptions} documentation.
      */
     getFormSubscriptions(offset?: number, limit?: number): Promise<IListFormSubscription[] | IError>;
     /**
@@ -96,6 +102,7 @@ export default class EventsApi extends AsyncModules implements IEvents {
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This method requires user authorization.
      * @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}.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/events/unsubscribeFromForm unsubscribeFromForm} documentation.
      */
     unsubscribeFromForm(marker: string, body: ISubscribeFormEvent): Promise<boolean | IError>;
 }

package/dist/events/eventsApi.js

@@ -36,6 +36,7 @@ class EventsApi extends asyncModules_1.default {
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This method requires user authorization.
      * @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}.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/events/getAllSubscriptions getAllSubscriptions} documentation.
      */
     async getAllSubscriptions(offset = 0, limit = 30) {
         const query = {
@@ -55,19 +56,14 @@ class EventsApi extends asyncModules_1.default {
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This method requires user authorization.
      * @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}.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/events/subscribeByMarker subscribeByMarker} documentation.
      */
     async subscribeByMarker(marker, productId, langCode = this.state.lang) {
         const body = {
             locale: langCode,
             productId,
         };
-        try {
-            await this._fetchPost(`/subscribe/marker/${marker}`, body);
-            return true;
-        }
-        catch (e) {
-            return e;
-        }
+        return this._fetchBoolean(() => this._fetchPost(`/subscribe/marker/${marker}`, body));
     }
     /**
      * Unsubscribing to an event on a product.
@@ -79,19 +75,14 @@ class EventsApi extends asyncModules_1.default {
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This method requires user authorization.
      * @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}.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/events/unsubscribeByMarker unsubscribeByMarker} documentation.
      */
     async unsubscribeByMarker(marker, productId, langCode = this.state.lang) {
         const body = {
             productId: productId,
             locale: langCode,
         };
-        try {
-            await this._fetchDelete(`/unsubscribe/marker/${marker}`, body);
-            return true;
-        }
-        catch (e) {
-            return e;
-        }
+        return this._fetchBoolean(() => this._fetchDelete(`/unsubscribe/marker/${marker}`, body));
     }
     /**
      * Returns all available events.
@@ -99,6 +90,7 @@ class EventsApi extends asyncModules_1.default {
      * @returns {Promise<IContentApiEvent[] | IError>} Returns an array of available events.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This method returns all available events.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/events/getAllEvents getAllEvents} documentation.
      */
     async getAllEvents() {
         const data = await this._fetchGet(`/all`);
@@ -113,15 +105,10 @@ class EventsApi extends asyncModules_1.default {
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This method requires user authorization.
      * @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}.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/events/subscribeToForm subscribeToForm} documentation.
      */
     async subscribeToForm(marker, body) {
-        try {
-            await this._fetchPost(`/forms/subscribe/marker/${marker}`, body);
-            return true;
-        }
-        catch (e) {
-            return e;
-        }
+        return this._fetchBoolean(() => this._fetchPost(`/forms/subscribe/marker/${marker}`, body));
     }
     /**
      * Returns all form subscriptions.
@@ -132,6 +119,7 @@ class EventsApi extends asyncModules_1.default {
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This method requires user authorization.
      * @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}.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/events/getFormSubscriptions getFormSubscriptions} documentation.
      */
     async getFormSubscriptions(offset = 0, limit = 30) {
         const query = {
@@ -150,15 +138,10 @@ class EventsApi extends asyncModules_1.default {
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This method requires user authorization.
      * @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}.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/events/unsubscribeFromForm unsubscribeFromForm} documentation.
      */
     async unsubscribeFromForm(marker, body) {
-        try {
-            await this._fetchDelete(`/forms/unsubscribe/marker/${marker}`, body);
-            return true;
-        }
-        catch (e) {
-            return e;
-        }
+        return this._fetchBoolean(() => this._fetchDelete(`/forms/unsubscribe/marker/${marker}`, body));
     }
 }
 exports.default = EventsApi;

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

@@ -43,6 +43,7 @@ export default class FileUploadingApi extends AsyncModules implements IFileUploa
      * @param {string | number} [fileQuery.template] - preview template identifier. Example: 1.
      * @returns {Promise<IUploadingReturn[] | IError>} Uploads a file to an Amazon S3-compatible cloud file storage.
      * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @see {@link https://js-sdk.oneentry.cloud/docs/file-uploading/upload upload} documentation.
      */
     upload(file: File | Blob, fileQuery?: IUploadingQuery): Promise<IUploadingReturn[] | IError>;
     /**
@@ -63,6 +64,7 @@ export default class FileUploadingApi extends AsyncModules implements IFileUploa
      * @param {number} [fileQuery.template] - preview template identifier. Example: 1.
      * @returns {Promise<boolean | IError>} Returns a promise that resolves to the result of the deletion operation 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/delete delete} documentation.
      */
     delete(filename: string, fileQuery?: IUploadingQuery): Promise<boolean | IError>;
     /**
@@ -80,9 +82,10 @@ export default class FileUploadingApi extends AsyncModules implements IFileUploa
      * @param {string} type - Type, determines the folder name in the storage. Example: "page".
      * @param {string} entity - Entity name, from which the file is uploaded, determines the folder name in the storage. Example: "editor".
      * @param {string} filename - Filename. Example: "file.png".
-     * @param {string} [template] - Preview template identifier. Example: 1.
+     * @param {string} [template] - Preview template identifier. 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.
      */
     getFile(id: number, type: string, entity: string, filename: string, template?: string): Promise<Response | IError>;
 }

package/dist/file-uploading/fileUploadingApi.js

@@ -55,6 +55,7 @@ class FileUploadingApi extends asyncModules_1.default {
      * @param {string | number} [fileQuery.template] - preview template identifier. Example: 1.
      * @returns {Promise<IUploadingReturn[] | IError>} Uploads a file to an Amazon S3-compatible cloud file storage.
      * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @see {@link https://js-sdk.oneentry.cloud/docs/file-uploading/upload upload} documentation.
      */
     async upload(file, fileQuery) {
         const query = { ...this._defaultQuery, ...fileQuery };
@@ -83,6 +84,7 @@ class FileUploadingApi extends asyncModules_1.default {
      * @param {number} [fileQuery.template] - preview template identifier. Example: 1.
      * @returns {Promise<boolean | IError>} Returns a promise that resolves to the result of the deletion operation 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/delete delete} documentation.
      */
     async delete(filename, fileQuery) {
         const query = { ...this._defaultQuery, ...fileQuery };
@@ -110,9 +112,10 @@ class FileUploadingApi extends asyncModules_1.default {
      * @param {string} type - Type, determines the folder name in the storage. Example: "page".
      * @param {string} entity - Entity name, from which the file is uploaded, determines the folder name in the storage. Example: "editor".
      * @param {string} filename - Filename. Example: "file.png".
-     * @param {string} [template] - Preview template identifier. Example: 1.
+     * @param {string} [template] - Preview template identifier. 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.
      */
     async getFile(id, type, entity, filename, template) {
         // eslint-disable-next-line no-undef

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

@@ -66,7 +66,7 @@ interface IFileUploading {
      * @param {string} type - Type, determines the folder name in the storage. Example: "page".
      * @param {string} entity - Entity name, from which the file is uploaded, determines the folder name in the storage. Example: "editor".
      * @param {string} filename - Filename. Example: "file.png".
-     * @param {string} [template] - Preview template identifier. Example: 1.
+     * @param {string} [template] - Preview template identifier. Example: "1".
      * @returns {Response | IError} Returns a promise that resolves to a Response object containing the file data or an error object if there was an issue.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      */

package/dist/filters/filtersApi.d.ts

@@ -26,6 +26,7 @@ export default class FiltersApi extends AsyncModules implements IFiltersApi {
      * @returns {Promise<IContentFilter | IError>} Returns the filter with its items tree.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Retrieves a single content filter by marker.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/filters/getFilterByMarker getFilterByMarker} documentation.
      */
     getFilterByMarker(marker: string, langCode?: string): Promise<IContentFilter | IError>;
 }

package/dist/filters/filtersApi.js

@@ -30,6 +30,7 @@ class FiltersApi extends asyncModules_1.default {
      * @returns {Promise<IContentFilter | IError>} Returns the filter with its items tree.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Retrieves a single content filter by marker.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/filters/getFilterByMarker getFilterByMarker} documentation.
      */
     async getFilterByMarker(marker, langCode = this.state.lang) {
         const data = await this._fetchGet(`/marker/${marker}?langCode=${langCode}`);

package/dist/forms/formsApi.d.ts

@@ -28,6 +28,7 @@ export default class FormsApi extends AsyncModules implements IForms {
      * @param {number} [limit] - Parameter for pagination. Default: 30.
      * @returns {Promise<IFormsResponse | IError>} Returns paginated object with array of FormEntity and total count.
      * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @see {@link https://js-sdk.oneentry.cloud/docs/forms/getAllForms getAllForms} documentation.
      */
     getAllForms(langCode?: string, offset?: number, limit?: number): Promise<IFormsResponse | IError>;
     /**
@@ -37,6 +38,7 @@ export default class FormsApi extends AsyncModules implements IForms {
      * @param {string} [langCode] - Language code. Default: "en_US".
      * @returns {Promise<IFormsEntity | IError>} Returns object of type FormEntity.
      * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @see {@link https://js-sdk.oneentry.cloud/docs/forms/getFormByMarker getFormByMarker} documentation.
      */
     getFormByMarker(marker: string, langCode?: string): Promise<IFormsEntity | IError>;
 }

package/dist/forms/formsApi.js

@@ -32,6 +32,7 @@ class FormsApi extends asyncModules_1.default {
      * @param {number} [limit] - Parameter for pagination. Default: 30.
      * @returns {Promise<IFormsResponse | IError>} Returns paginated object with array of FormEntity and total count.
      * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @see {@link https://js-sdk.oneentry.cloud/docs/forms/getAllForms getAllForms} documentation.
      */
     async getAllForms(langCode = this.state.lang, offset = 0, limit = 30) {
         const result = await this._fetchGet(`?langCode=${langCode}&offset=${offset}&limit=${limit}`);
@@ -46,6 +47,7 @@ class FormsApi extends asyncModules_1.default {
      * @param {string} [langCode] - Language code. Default: "en_US".
      * @returns {Promise<IFormsEntity | IError>} Returns object of type FormEntity.
      * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @see {@link https://js-sdk.oneentry.cloud/docs/forms/getFormByMarker getFormByMarker} documentation.
      */
     async getFormByMarker(marker, langCode = this.state.lang) {
         const result = await this._fetchGet(`/marker/${marker}?langCode=${langCode}`);