oneentry 1.0.152 → 1.0.154

package/dist/products/productsInterfaces.d.ts

@@ -35,163 +35,135 @@ interface IProductsApi {
           }
         ]
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @param {IProductsQuery} [userQuery] - Optional set query parameters.
+     * @param {IProductsQueryBase} [userQuery] - Optional set query parameters.
      * @example
         {
           "limit": 30,
           "offset": 0,
           "sortOrder": "DESC",
           "sortKey": "id",
-          "statusId": 123,
-          "statusMarker": "in_stock",
-          "conditionValue": "new",
-          "conditionMarker": "equals",
-          "attributeMarker": "color"
+          "signPrice": "orders"
         }
      * @returns {IProductsResponse} Array with ProductEntity objects
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      */
-    getProducts(body?: IFilterParams[], langCode?: string, userQuery?: IProductsQuery): Promise<IProductsResponse | IError>;
+    getProducts(body?: IFilterParams[], langCode?: string, userQuery?: IProductsQueryBase): Promise<IProductsResponse | IError>;
     /**
      * Search for all product page objects with pagination that do not have a category.
      * @handleName getProductsEmptyPage
      * @param body
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @param {IProductsQuery} [userQuery] - Optional set query parameters.
+     * @param {IProductsQueryBase} [userQuery] - Optional set query parameters.
      * @example
         {
           "limit": 30,
           "offset": 0,
           "sortOrder": "DESC",
           "sortKey": "id",
-          "statusId": 123,
-          "statusMarker": "in_stock",
-          "conditionValue": "new",
-          "conditionMarker": "equals",
-          "attributeMarker": "color"
+          "signPrice": "orders"
         }
      * @returns {IProductsResponse} Array with ProductEntity objects.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      * @description This method searches for all product page objects with pagination that do not have a category.
      */
-    getProductsEmptyPage(body?: object, langCode?: string, userQuery?: IProductsQuery): Promise<IAggregatedProductGroup[] | IError>;
+    getProductsEmptyPage(body?: object, langCode?: string, userQuery?: IProductsQueryBase): Promise<IAggregatedProductGroup[] | IError>;
     /**
      * Search for all products with pagination for the selected category.
      * @handleName getProductsByPageId
      * @param {number} id - Page id. Example: 12345.
      * @param {IFilterParams[]} [body] - Request body. Default: [].
      * @param {string} [langCode] - Language code. Default "en_US".
-     * @param {IProductsQuery} [userQuery] - Optional set query parameters.
+     * @param {IProductsQueryBase} [userQuery] - Optional set query parameters.
      * @example
         {
           "limit": 30,
           "offset": 0,
           "sortOrder": "DESC",
           "sortKey": "id",
-          "statusId": 123,
-          "statusMarker": "in_stock",
-          "conditionValue": "new",
-          "conditionMarker": "equals",
-          "attributeMarker": "color"
+          "signPrice": "orders"
         }
      * @returns {IProductsResponse} Array with ProductEntity objects
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      * @description This method searches for all products with pagination for the selected category.
      */
-    getProductsByPageId(id: number, body?: IFilterParams[], langCode?: string, userQuery?: IProductsQuery): Promise<IProductsResponse | IError>;
+    getProductsByPageId(id: number, body?: IFilterParams[], langCode?: string, userQuery?: IProductsQueryBase): Promise<IProductsResponse | IError>;
     /**
      * Search for information about products and prices for the selected category.
      * @handleName getProductsPriceByPageUrl
      * @param {string} [url] - Page url. Example: "23-laminat-floorwood-maxima".
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @param {IProductsQuery} [userQuery] - Optional set query parameters.
+     * @param {IProductsPriceQuery} [userQuery] - Optional set query parameters.
      * @example
         {
           "limit": 30,
           "offset": 0,
           "sortOrder": "DESC",
-          "sortKey": "id",
-          "statusId": 123,
-          "statusMarker": "in_stock",
-          "conditionValue": "new",
-          "conditionMarker": "equals",
-          "attributeMarker": "color"
+          "signPrice": "orders",
+          "statusMarker": "in_stock"
         }
      * @returns {IProductsInfo} Array with ProductInformation objects.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      * @description This method searches for information about products prices for the selected category.
      */
-    getProductsPriceByPageUrl(url: string, langCode?: string, userQuery?: IProductsQuery): Promise<IProductsInfo | IError>;
+    getProductsPriceByPageUrl(url: string, langCode?: string, userQuery?: IProductsPriceQuery): Promise<IProductsInfo | IError>;
     /**
      * Search for all products with pagination for the selected category.
      * @handleName getProductsByPageUrl
      * @param {string} url - Page url. Example: "23-laminat-floorwood-maxima".
      * @param {IFilterParams[]} [body] - Request body. Default: [].
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @param {IProductsQuery} [userQuery] - Optional set query parameters.
+     * @param {IProductsQueryBase} [userQuery] - Optional set query parameters.
      * @example
         {
           "limit": 30,
           "offset": 0,
           "sortOrder": "DESC",
           "sortKey": "id",
-          "statusId": 123,
-          "statusMarker": "in_stock",
-          "conditionValue": "new",
-          "conditionMarker": "equals",
-          "attributeMarker": "color"
+          "signPrice": "orders"
         }
      * @returns {IProductsResponse} Array with ProductEntity objects.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      * @description This method searches for all products with pagination for the selected category.
      */
-    getProductsByPageUrl(url: string, body?: IFilterParams[], langCode?: string, userQuery?: IProductsQuery): Promise<IProductsResponse | IError>;
+    getProductsByPageUrl(url: string, body?: IFilterParams[], langCode?: string, userQuery?: IProductsQueryBase): Promise<IProductsResponse | IError>;
     /**
      * Find all related product page objects.
      * @handleName getRelatedProductsById
      * @param {number} [id] - Product page identifier for which to find relationship. Example: 12345.
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @param {IProductsQuery} [userQuery] - Optional set query parameters.
+     * @param {IProductsRelatedQuery} [userQuery] - Optional set query parameters.
      * @example
         {
           "limit": 30,
           "offset": 0,
           "sortOrder": "DESC",
           "sortKey": "id",
-          "statusId": 123,
+          "signPrice": "orders",
           "statusMarker": "in_stock",
-          "conditionValue": "new",
-          "conditionMarker": "equals",
-          "attributeMarker": "color"
+          "templateMarker": "template_12345"
         }
      * @returns {IProductsResponse} Array with ProductEntity objects
      * @throws {IError} If there is an error during the fetch operation, it will return an error object.
      * @description This method finds all related product page objects for the selected product page.
      */
-    getRelatedProductsById(id: number, langCode?: string, userQuery?: IProductsQuery): Promise<IProductsResponse | IError>;
+    getRelatedProductsById(id: number, langCode?: string, userQuery?: IProductsRelatedQuery): Promise<IProductsResponse | IError>;
     /**
      * Find products by its ids.
      * @handleName getProductsByIds
      * @param {string} ids - Product page identifiers for which to find relationships. Example: "12345,67890".
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @param {IProductsQuery} [userQuery] - Optional set query parameters.
+     * @param {IProductsByIdsQuery} [userQuery] - Optional set query parameters.
      * @example
         {
           "limit": 30,
           "offset": 0,
-          "sortOrder": "DESC",
-          "sortKey": "id",
-          "statusId": 123,
-          "statusMarker": "in_stock",
-          "conditionValue": "new",
-          "conditionMarker": "equals",
-          "attributeMarker": "color"
+          "signPrice": "orders"
         }
      * @returns {IProductsEntity[]} Array with ProductEntity objects
      * @throws {IError} If there is an error during the fetch operation, it will return an error object.
      * @description This method finds products by its ids.
      */
-    getProductsByIds(ids: string, langCode?: string, userQuery?: IProductsQuery): Promise<IProductsEntity[] | IError>;
+    getProductsByIds(ids: string, langCode?: string, userQuery?: IProductsByIdsQuery): Promise<IProductsEntity[] | IError>;
     /**
      * Retrieve one product object.
      * @handleName getProductById
@@ -257,7 +229,7 @@ interface IProductsApi {
     /**
      * Getting the number of products on a catalog page by page ID.
      * @handleName getProductsCountByPageId
-     * @param {string} id - Page id. Example: 12345.
+     * @param {string} id - Page id. Example: "12345".
      * @param {object[]} body - Body parameters for filter. Deault: [].
      * @example
         [
@@ -334,40 +306,68 @@ interface IProductsApi {
     getProductsByVectorSearch(body: IVectorSearchProducts, langCode?: string, offset?: number, limit?: number): Promise<IProductsEntity[] | IError>;
 }
 /**
- * @interface IProductsQuery
+ * @interface IProductsQueryBase
  * @property {number} offset - Parameter for pagination. Default: 0.
  * @property {number} limit - Parameter for pagination. Default: 30.
  * @property {string} sortOrder - Sort order "DESC" | "ASC". Default: "DESC".
  * @property {string} sortKey - Field for sorting (default - null). Possible values: "id", "position", "title", "date", "price". Default: null.
- * @property {string} [signPrice] - Price sign. Default: null.
- * @property {string | null} [templateMarker] - Product page template marker, default null. Example: "template_12345".
- * @property {string | null} [statusMarker] - Product page status marker, default null. Example: "in_stock".
- * @property {string | null} [conditionValue] - The value that is being searched for, default null. Example: "new".
- * @property {string | null} [attributeMarker] - The text identifier of the indexed attribute by which values are filtered, default null. Example: "color".
- * @property {string | null} [conditionMarker] - Marker of the filter condition by which the values are filtered, default null. Example: "equals".
- * @property {string} [langCode] - Language code. Default: "en_US".
- * @property {string} [ids] - Comma-separated list of product ids — used by `getProductsByIds`. Example: "1,2,3".
- * @description This interface defines the structure of a query for retrieving products, including pagination, sorting, and filtering parameters.
+ * @property {string} [signPrice] - Order storage marker for price fixing. If the parameter is set, the price is fixed for a certain time.
+ * @see {@link https://js-sdk.oneentry.cloud/docs/products/#Fixing-the-price-signPrice Fixing the price} documentation.
+ * @description Base query parameters shared by the product listing endpoints (getProducts, getProductsEmptyPage, getProductsByPageId, getProductsByPageUrl): pagination, sorting and price fixing.
  */
-interface IProductsQuery {
+interface IProductsQueryBase {
     offset?: number;
     limit?: number;
-    langCode?: string;
-    ids?: string;
     sortOrder?: 'DESC' | 'ASC' | null;
     sortKey?: 'id' | 'position' | 'title' | 'date' | 'price' | null;
     signPrice?: string;
-    templateMarker?: string | null;
+}
+/**
+ * @interface IProductsRelatedQuery
+ * @augments IProductsQueryBase
+ * @property {string | null} [statusMarker] - Product page status marker, default null. Example: "in_stock".
+ * @property {string | null} [templateMarker] - Product page template marker, default null. Example: "template_12345".
+ * @description Query parameters for getRelatedProductsById: the base query plus product page status and template markers.
+ */
+interface IProductsRelatedQuery extends IProductsQueryBase {
     statusMarker?: string | null;
-    conditionValue?: string | null;
-    attributeMarker?: string | null;
-    conditionMarker?: 'in' /** in - Contains */ | 'nin' /** nin - Does not contain */ | 'eq' /** 'eq' - Equal */ | 'neq' /** 'neq' - Not equal */ | 'mth' /** 'mth' - Greater than */ | 'lth' /** 'lth' - Less than */ | 'exs' /** 'exs' - Exists */ | 'nexs' /** 'nexs' - Does not exist */ | null;
+    templateMarker?: string | null;
 }
+/**
+ * Query parameters for getProductsPriceByPageUrl: the base query without
+ * `sortKey`, plus the product page status marker.
+ * @typedef {object} IProductsPriceQuery
+ * @property {number} [offset] - Parameter for pagination. Default: 0.
+ * @property {number} [limit] - Parameter for pagination. Default: 30.
+ * @property {string} [sortOrder] - Sort order "DESC" | "ASC". Default: "DESC".
+ * @property {string} [signPrice] - Order storage marker for price fixing.
+ * @property {string | null} [statusMarker] - Product page status marker, default null. Example: "in_stock".
+ */
+type IProductsPriceQuery = Omit<IProductsQueryBase, 'sortKey'> & {
+    statusMarker?: string | null;
+};
+/**
+ * Query parameters for getProductsByIds: only price fixing — `ids` is passed
+ * as a dedicated method argument.
+ * @typedef {object} IProductsByIdsQuery
+ * @property {string} [signPrice] - Order storage marker for price fixing.
+ */
+type IProductsByIdsQuery = Pick<IProductsQueryBase, 'signPrice'>;
+/**
+ * Query parameters for retrieving products.
+ * @deprecated Use the per-method query types instead — IProductsQueryBase
+ * (getProducts / getProductsEmptyPage / getProductsByPageId / getProductsByPageUrl),
+ * IProductsRelatedQuery (getRelatedProductsById), IProductsPriceQuery
+ * (getProductsPriceByPageUrl) or IProductsByIdsQuery (getProductsByIds).
+ * Kept as an alias of the base query for backward compatibility.
+ * @typedef {IProductsQueryBase} IProductsQuery
+ */
+type IProductsQuery = IProductsQueryBase;
 /**
  * @interface IFilterParams
  * @property {string | null} attributeMarker - The text identifier of the indexed attribute by which values are filtered. Default: null. Example: "color".
  * @property {string | null} [conditionMarker] - Id of the filter condition by which the values are filtered. Default: null. Example: "equals".
- * @property {number | null} conditionValue - The value that is being searched for, default null. Example: "new".
+ * @property {number | string | null} conditionValue - The value that is being searched for, default null. Example: "new".
  * @property {string | null} [pageUrl] - Url of the category page object. Example: ["23-laminat-floorwood-maxima"].
  * @property {string[] | null} [pageUrls] - Url of the category page object. Example: ["23-laminat-floorwood-maxima"].
  * @property {string | null} [statusMarker] - Text identifier of the product page status (default not set). Example: "in_stock".
@@ -470,7 +470,8 @@ interface IProductPageRef {
  * @property {Record<string, unknown>} [discountConfig] - Discount configuration object. Example: {}.
  * @property {string | null} [templateIdentifier] - User id of the linked template. Example: "template_12345".
  * @property {string | null} [shortDescTemplateIdentifier] - User id of the linked template for a short description. Example: "short_desc_template_12345".
- * @property {string} [signedPrice] - Price sign.
+ * @property {string} [signedPrice] - The signed price of the product is obtained along with the product data when `signPrice` is set. Example: "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
+ * @see {@link https://js-sdk.oneentry.cloud/docs/orders/#Fixed-product-price-signedPrice Fixed product price} documentation.
  * @property {IProductPageRef[]} [productPages] - Array of product page references linking the product to its pages.
  * @example
     [
@@ -575,11 +576,14 @@ interface IProductsInfo {
  * @interface IProductInfo
  * @property {number} id - The unique identifier of the product. Example: 12345.
  * @property {number} price - The price of the product. Example: 150.00.
+ * @property {string} [signedPrice] - The signed (fixed) price of the product, 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 This interface defines the structure of a product information object, including its identifier and price.
  */
 interface IProductInfo {
     id: number;
     price: number;
+    signedPrice?: string;
 }
 /**
  * @interface IProductBlock
@@ -696,4 +700,4 @@ interface IVectorSearchProducts {
     maxHits?: number;
     debug?: boolean;
 }
-export type { IAggregatedProductGroup, IFilterParams, IProductBlock, IProductInfo, IProductsApi, IProductsCount, IProductsEntity, IProductsInfo, IProductsQuery, IProductsResponse, IVectorSearchProducts, };
+export type { IAggregatedProductGroup, IFilterParams, IProductBlock, IProductInfo, IProductsApi, IProductsByIdsQuery, IProductsCount, IProductsEntity, IProductsInfo, IProductsPriceQuery, IProductsQuery, IProductsQueryBase, IProductsRelatedQuery, IProductsResponse, IVectorSearchProducts, };

package/dist/sitemap/sitemapApi.d.ts

@@ -22,6 +22,7 @@ export default class SitemapApi extends AsyncModules implements ISitemapApi {
      * @handleName getSitemap
      * @returns {Promise<string[] | IError>} Returns an array of sitemap URLs.
      * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @see {@link https://js-sdk.oneentry.cloud/docs/sitemap/getSitemap getSitemap} documentation.
      */
     getSitemap(): Promise<string[] | IError>;
     /**
@@ -30,6 +31,7 @@ export default class SitemapApi extends AsyncModules implements ISitemapApi {
      * @param {ISitemapQuery} body - Sitemap body params (e.g. `{ baseUrls: { en_US: "https://…" } }`).
      * @returns {Promise<string[] | IError>} Returns an array of generated sitemap URLs.
      * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @see {@link https://js-sdk.oneentry.cloud/docs/sitemap/updateSitemap updateSitemap} documentation.
      */
     updateSitemap(body: ISitemapQuery): Promise<string[] | IError>;
 }

package/dist/sitemap/sitemapApi.js

@@ -25,6 +25,7 @@ class SitemapApi extends asyncModules_1.default {
      * @handleName getSitemap
      * @returns {Promise<string[] | IError>} Returns an array of sitemap URLs.
      * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @see {@link https://js-sdk.oneentry.cloud/docs/sitemap/getSitemap getSitemap} documentation.
      */
     async getSitemap() {
         const data = await this._fetchGet(`/`);
@@ -36,6 +37,7 @@ class SitemapApi extends asyncModules_1.default {
      * @param {ISitemapQuery} body - Sitemap body params (e.g. `{ baseUrls: { en_US: "https://…" } }`).
      * @returns {Promise<string[] | IError>} Returns an array of generated sitemap URLs.
      * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @see {@link https://js-sdk.oneentry.cloud/docs/sitemap/updateSitemap updateSitemap} documentation.
      */
     async updateSitemap(body) {
         const data = await this._fetchPost(`/`, body);

package/dist/subscriptions/subscriptionsApi.d.ts

@@ -26,6 +26,7 @@ export default class SubscriptionsApi extends AsyncModules implements ISubscript
      * @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/subscriptions/subscribe subscribe} documentation.
      */
     subscribe(body: ISubscribe): Promise<ICreatedSubscription | IError>;
     /**
@@ -36,6 +37,7 @@ export default class SubscriptionsApi extends AsyncModules implements ISubscript
      * @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/subscriptions/cancelSubscription cancelSubscription} documentation.
      */
     cancelSubscription(body: ICancelSubscription): Promise<boolean | IError>;
     /**
@@ -45,6 +47,7 @@ export default class SubscriptionsApi extends AsyncModules implements ISubscript
      * @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/subscriptions/getAllSubscriptions getAllSubscriptions} documentation.
      */
     getAllSubscriptions(): Promise<string[] | IError>;
     /**
@@ -54,6 +57,7 @@ export default class SubscriptionsApi extends AsyncModules implements ISubscript
      * @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/subscriptions/getActiveSubscriptions getActiveSubscriptions} documentation.
      */
     getActiveSubscriptions(): Promise<string[] | IError>;
     /**
@@ -64,6 +68,7 @@ export default class SubscriptionsApi extends AsyncModules implements ISubscript
      * @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/subscriptions/recoverSubscriptions recoverSubscriptions} documentation.
      */
     recoverSubscriptions(body: ICancelSubscription): Promise<boolean | IError>;
 }

package/dist/subscriptions/subscriptionsApi.js

@@ -30,6 +30,7 @@ class SubscriptionsApi 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/subscriptions/subscribe subscribe} documentation.
      */
     async subscribe(body) {
         const data = await this._fetchPost(``, body);
@@ -44,15 +45,10 @@ class SubscriptionsApi 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/subscriptions/cancelSubscription cancelSubscription} documentation.
      */
     async cancelSubscription(body) {
-        try {
-            await this._fetchDelete(``, body);
-            return true;
-        }
-        catch (e) {
-            return e;
-        }
+        return this._fetchBoolean(() => this._fetchDelete(``, body));
     }
     /**
      * Get all available subscription markers.
@@ -61,6 +57,7 @@ class SubscriptionsApi 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/subscriptions/getAllSubscriptions getAllSubscriptions} documentation.
      */
     async getAllSubscriptions() {
         const data = await this._fetchGet(``);
@@ -74,6 +71,7 @@ class SubscriptionsApi 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/subscriptions/getActiveSubscriptions getActiveSubscriptions} documentation.
      */
     async getActiveSubscriptions() {
         const data = await this._fetchGet(`/active`);
@@ -88,15 +86,10 @@ class SubscriptionsApi 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/subscriptions/recoverSubscriptions recoverSubscriptions} documentation.
      */
     async recoverSubscriptions(body) {
-        try {
-            await this._fetchPost(`/recover`, body);
-            return true;
-        }
-        catch (e) {
-            return e;
-        }
+        return this._fetchBoolean(() => this._fetchPost(`/recover`, body));
     }
 }
 exports.default = SubscriptionsApi;

package/dist/system/systemApi.d.ts

@@ -22,6 +22,7 @@ export default class SystemApi extends AsyncModules implements ISystemApi {
      * @returns {Promise<unknown | IError>} The response from the server after fetching data from the '/test404' endpoint.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This method is used to test the 404 error handling by sending a GET request to a specific endpoint.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/system/test404 test404} documentation.
      */
     test404(): Promise<unknown | IError>;
     /**
@@ -30,6 +31,7 @@ export default class SystemApi extends AsyncModules implements ISystemApi {
      * @returns {Promise<unknown | IError>} The response from the server after fetching data from the '/test500' endpoint.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This method is used to test the 500 error handling by sending a GET request to a specific endpoint.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/system/test500 test500} documentation.
      */
     test500(): Promise<unknown | IError>;
     /**
@@ -38,6 +40,7 @@ export default class SystemApi extends AsyncModules implements ISystemApi {
      * @returns {Promise<unknown | IError>} Return object with date and count.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Getting the number of requests to API.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/system/getApiStat getApiStat} documentation.
      */
     getApiStat(): Promise<unknown>;
 }

package/dist/system/systemApi.js

@@ -25,6 +25,7 @@ class SystemApi extends asyncModules_1.default {
      * @returns {Promise<unknown | IError>} The response from the server after fetching data from the '/test404' endpoint.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This method is used to test the 404 error handling by sending a GET request to a specific endpoint.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/system/test404 test404} documentation.
      */
     async test404() {
         const result = await this._fetchGet('/test404');
@@ -36,6 +37,7 @@ class SystemApi extends asyncModules_1.default {
      * @returns {Promise<unknown | IError>} The response from the server after fetching data from the '/test500' endpoint.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This method is used to test the 500 error handling by sending a GET request to a specific endpoint.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/system/test500 test500} documentation.
      */
     async test500() {
         const result = await this._fetchGet('/test500');
@@ -47,6 +49,7 @@ class SystemApi extends asyncModules_1.default {
      * @returns {Promise<unknown | IError>} Return object with date and count.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Getting the number of requests to API.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/system/getApiStat getApiStat} documentation.
      */
     async getApiStat() {
         const result = await this._fetchGet('/api-stat');

package/dist/templates/templatesApi.d.ts

@@ -25,6 +25,7 @@ export default class TemplatesPreviewApi extends AsyncModules implements ITempla
      * @returns {Promise<Record<BlockType, ITemplateEntity[]> | IError>} Returns an object GroupedTemplatesObject, which contains an array of template objects TemplateEntity
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This function is designed to fetch organized template objects in groups based on their types.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/templates/getAllTemplates getAllTemplates} documentation.
      */
     getAllTemplates(langCode?: string): Promise<Record<BlockType, ITemplateEntity[]> | IError>;
     /**
@@ -35,6 +36,7 @@ export default class TemplatesPreviewApi extends AsyncModules implements ITempla
      * @returns {Promise<ITemplateEntity[] | IError>} Returns a TemplateEntity object.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Fetch template objects that belong to a specific type, with an optional filter by language.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/templates/getTemplateByType getTemplateByType} documentation.
      */
     getTemplateByType(type: BlockType, langCode?: string): Promise<ITemplateEntity[] | IError>;
     /**
@@ -45,6 +47,7 @@ export default class TemplatesPreviewApi extends AsyncModules implements ITempla
      * @returns {Promise<ITemplateEntity | IError>} Returns a TemplateEntity object
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Fetch a specific template object based on its unique marker.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/templates/getTemplateByMarker getTemplateByMarker} documentation.
      */
     getTemplateByMarker(marker: string, langCode?: string): Promise<ITemplateEntity | IError>;
 }

package/dist/templates/templatesApi.js

@@ -29,6 +29,7 @@ class TemplatesPreviewApi extends asyncModules_1.default {
      * @returns {Promise<Record<BlockType, ITemplateEntity[]> | IError>} Returns an object GroupedTemplatesObject, which contains an array of template objects TemplateEntity
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This function is designed to fetch organized template objects in groups based on their types.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/templates/getAllTemplates getAllTemplates} documentation.
      */
     async getAllTemplates(langCode = this.state.lang) {
         const response = await this._fetchGet(`/all?langCode=${langCode}`);
@@ -54,6 +55,7 @@ class TemplatesPreviewApi extends asyncModules_1.default {
      * @returns {Promise<ITemplateEntity[] | IError>} Returns a TemplateEntity object.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Fetch template objects that belong to a specific type, with an optional filter by language.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/templates/getTemplateByType getTemplateByType} documentation.
      */
     async getTemplateByType(type, langCode = this.state.lang) {
         const result = await this._fetchGet(`?type=${type}&langCode=${langCode}`);
@@ -69,6 +71,7 @@ class TemplatesPreviewApi extends asyncModules_1.default {
      * @returns {Promise<ITemplateEntity | IError>} Returns a TemplateEntity object
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Fetch a specific template object based on its unique marker.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/templates/getTemplateByMarker getTemplateByMarker} documentation.
      */
     async getTemplateByMarker(marker, langCode = this.state.lang) {
         const result = await this._fetchGet(`/marker/${marker}?langCode=${langCode}`);

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

@@ -23,6 +23,7 @@ export default class TemplatePreviewsApi extends AsyncModules implements ITempla
      * @returns {Promise<ITemplatesPreviewEntity[] | IError>} - Returns all TemplatePreviewsEntity template objects.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This method is used to fetch all available template objects.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/templates-preview/getTemplatePreviews getTemplatePreviews} documentation.
      */
     getTemplatePreviews(langCode?: string): Promise<ITemplatesPreviewEntity[] | IError>;
     /**
@@ -33,6 +34,7 @@ export default class TemplatePreviewsApi extends AsyncModules implements ITempla
      * @returns {Promise<ITemplatesPreviewEntity | IError>} - A promise that resolves to a TemplatePreviewsEntity object representing the template.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This method is used to fetch a specific template object based on the provided marker.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/templates-preview/getTemplatePreviewByMarker getTemplatePreviewByMarker} documentation.
      */
     getTemplatePreviewByMarker(marker: string, langCode?: string): Promise<ITemplatesPreviewEntity | IError>;
 }

package/dist/templates-preview/templatesPreviewApi.js

@@ -27,6 +27,7 @@ class TemplatePreviewsApi extends asyncModules_1.default {
      * @returns {Promise<ITemplatesPreviewEntity[] | IError>} - Returns all TemplatePreviewsEntity template objects.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This method is used to fetch all available template objects.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/templates-preview/getTemplatePreviews getTemplatePreviews} documentation.
      */
     async getTemplatePreviews(langCode = this.state.lang) {
         const result = await this._fetchGet(`?langCode=${langCode}`);
@@ -42,6 +43,7 @@ class TemplatePreviewsApi extends asyncModules_1.default {
      * @returns {Promise<ITemplatesPreviewEntity | IError>} - A promise that resolves to a TemplatePreviewsEntity object representing the template.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This method is used to fetch a specific template object based on the provided marker.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/templates-preview/getTemplatePreviewByMarker getTemplatePreviewByMarker} documentation.
      */
     async getTemplatePreviewByMarker(marker, langCode = this.state.lang) {
         const result = await this._fetchGet(`/marker/${marker}?langCode=${langCode}`);

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

@@ -25,6 +25,7 @@ export default class UserActivityApi extends AsyncModules implements IUserActivi
      * @returns {Promise<boolean | IError>} Returns true if the event was recorded, or an error object if there was an issue.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Records an activity event for the current authorized user or guest.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/user-activity/trackUserActivity trackUserActivity} documentation.
      */
     trackUserActivity(body: ITrackActivity): Promise<boolean | IError>;
 }

package/dist/user-activity/userActivityApi.js

@@ -28,6 +28,7 @@ class UserActivityApi extends asyncModules_1.default {
      * @returns {Promise<boolean | IError>} Returns true if the event was recorded, or an error object if there was an issue.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Records an activity event for the current authorized user or guest.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/user-activity/trackUserActivity trackUserActivity} documentation.
      */
     async trackUserActivity(body) {
         try {