oneentry 1.0.152 → 1.0.153

package/dist/products/productsApi.js

@@ -69,6 +69,7 @@ class ProductsApi extends asyncModules_1.default {
      * @returns {Promise<IProductsResponse | IError>} Products response, or IError when isShell=true
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Fetch products with optional filters and pagination.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/products/getProducts getProducts} documentation.
      */
     async getProducts(body = [], langCode = this.state.lang, userQuery) {
         const query = {
@@ -102,6 +103,7 @@ class ProductsApi extends asyncModules_1.default {
      * @returns {Promise<IAggregatedProductGroup[] | IError>} Array with AggregatedProductGroup objects.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Search for all product page objects with pagination (and aggregation) that do not have a category.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/products/getProductsEmptyPage getProductsEmptyPage} documentation.
      */
     async getProductsEmptyPage(body = {}, langCode = this.state.lang, userQuery) {
         const query = { ...userQuery, langCode };
@@ -155,6 +157,7 @@ class ProductsApi extends asyncModules_1.default {
      * @returns {Promise<IProductsResponse | IError>} Array with ProductEntity objects
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Fetch products by page ID with optional filters and pagination.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/products/getProductsByPageId getProductsByPageId} documentation.
      */
     async getProductsByPageId(id, body = [], langCode = this.state.lang, userQuery) {
         const query = { ...userQuery };
@@ -185,6 +188,7 @@ class ProductsApi extends asyncModules_1.default {
      * @returns {Promise<IProductsInfo | IError>} Array with ProductInformation objects.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Search for information about products and prices for the selected category.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/products/getProductsPriceByPageUrl getProductsPriceByPageUrl} documentation.
      */
     async getProductsPriceByPageUrl(url, langCode = this.state.lang, userQuery) {
         const query = {
@@ -241,6 +245,7 @@ class ProductsApi extends asyncModules_1.default {
      * @returns {Promise<IProductsResponse | IError>} Array with ProductEntity objects.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Search for all products with pagination for the selected category.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/products/getProductsByPageUrl getProductsByPageUrl} documentation.
      */
     async getProductsByPageUrl(url, body = [], langCode = this.state.lang, userQuery) {
         const query = { ...userQuery };
@@ -276,6 +281,7 @@ class ProductsApi extends asyncModules_1.default {
      * @returns {Promise<IProductsResponse | IError>} Array with ProductEntity objects
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Find all related product page objects.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/products/getRelatedProductsById getRelatedProductsById} documentation.
      */
     async getRelatedProductsById(id, langCode = this.state.lang, userQuery) {
         const query = { ...userQuery };
@@ -314,6 +320,7 @@ class ProductsApi extends asyncModules_1.default {
      * @returns {Promise<IProductsEntity[] | IError>} Array with ProductEntity objects
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Find products by its ids.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/products/getProductsByIds getProductsByIds} documentation.
      */
     async getProductsByIds(ids, langCode = this.state.lang, userQuery) {
         const query = {
@@ -333,6 +340,7 @@ class ProductsApi extends asyncModules_1.default {
      * @returns {Promise<IProductsEntity | IError>} ProductEntity object.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Retrieve one product object.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/products/getProductById getProductById} documentation.
      */
     async getProductById(id, langCode = this.state.lang, isNormalized) {
         const query = { langCode };
@@ -350,6 +358,7 @@ class ProductsApi extends asyncModules_1.default {
      * @returns {Promise<IProductBlock | IError>} - Product block object.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Getting a product block object by product id.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/products/getProductBlockById getProductBlockById} documentation.
      */
     async getProductBlockById(id) {
         const response = await this._fetchGet(`/${id}/blocks`);
@@ -363,6 +372,7 @@ class ProductsApi extends asyncModules_1.default {
      * @returns {Promise<IProductsEntity[] | IError>} Array with ProductEntity objects
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Quick search for product page objects with limited output.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/products/searchProduct searchProduct} documentation.
      */
     async searchProduct(name, langCode = this.state.lang) {
         const searchProducts = await this._fetchGet(`/quick/search?langCode=${langCode}&name=${name}`);
@@ -406,6 +416,7 @@ class ProductsApi extends asyncModules_1.default {
      * @returns {Promise<IProductsCount | IError>} Object with product items count.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This method calculates and returns the total number of products present across the entire catalog, optionally applying specified filters.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/products/getProductsCount getProductsCount} documentation.
      */
     async getProductsCount(
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -434,6 +445,7 @@ class ProductsApi extends asyncModules_1.default {
      * @returns {Promise<IProductsCount | IError>} Object with product items count.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This method calculates and returns the number of products available on a given catalog page, identified by its page ID, with optional filtering.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/products/getProductsCountByPageId getProductsCountByPageId} documentation.
      */
     async getProductsCountByPageId(id, 
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -462,6 +474,7 @@ class ProductsApi extends asyncModules_1.default {
      * @returns {Promise<IProductsCount | IError>} Object with product items count.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This method calculates and returns the number of products available on a given catalog page, identified by its URL, with optional filtering.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/products/getProductsCountByPageUrl getProductsCountByPageUrl} documentation.
      */
     /**
      * Semantic (vector) search for products.
@@ -473,6 +486,7 @@ class ProductsApi extends asyncModules_1.default {
      * @returns {Promise<IProductsEntity[] | IError>} Array with ProductEntity objects.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This method performs a semantic (vector) search for products.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/products/getProductsByVectorSearch getProductsByVectorSearch} documentation.
      */
     async getProductsByVectorSearch(body, langCode = this.state.lang, offset = 0, limit = 30) {
         const query = {

package/dist/products/productsInterfaces.d.ts

@@ -257,7 +257,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
         [
@@ -367,7 +367,7 @@ interface IProductsQuery {
  * @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".

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 {

package/dist/users/usersApi.d.ts

@@ -24,6 +24,7 @@ export default class UsersApi extends AsyncModules implements IUsersApi {
      * @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/users/getUser getUser} documentation.
      */
     getUser(langCode?: string): Promise<IUserEntity | IError>;
     /**
@@ -100,6 +101,7 @@ export default class UsersApi extends AsyncModules implements IUsersApi {
      * @description This method updates the user's data. 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 For more information about {@link https://doc.oneentry.cloud/docs/forms/create-form registration forms}, see the documentation in the  {@link https://doc.oneentry.cloud/docs/forms/create-form forms configuration section}.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/users/updateUser updateUser} documentation.
      */
     updateUser(body: IUserBody, langCode?: string): Promise<boolean | IError>;
     /**
@@ -109,6 +111,7 @@ export default class UsersApi extends AsyncModules implements IUsersApi {
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This method archives a user object (marks it for deletion). This method requires user authorization.
      * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/auth-provider/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/users/archiveUser archiveUser} documentation.
      */
     archiveUser(): Promise<boolean | IError>;
     /**
@@ -118,6 +121,7 @@ export default class UsersApi extends AsyncModules implements IUsersApi {
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This method deletes the user from the system. 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/users/deleteUser deleteUser} documentation.
      */
     deleteUser(): Promise<boolean | IError>;
     /**
@@ -128,6 +132,7 @@ export default class UsersApi extends AsyncModules implements IUsersApi {
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This method adds an FCM token for sending push notifications. 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/users/addFCMToken addFCMToken} documentation.
      */
     addFCMToken(token: string): Promise<boolean | IError>;
     /**
@@ -138,6 +143,7 @@ export default class UsersApi extends AsyncModules implements IUsersApi {
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This method deletes an existing FCM token. 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/users/deleteFCMToken deleteFCMToken} documentation.
      */
     deleteFCMToken(token: string): Promise<boolean | IError>;
     /**
@@ -147,6 +153,7 @@ export default class UsersApi extends AsyncModules implements IUsersApi {
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This method requires user authorization (or a guest context).
      * @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/users/getCart getCart} documentation.
      */
     getCart(): Promise<ICartResponse | IError>;
     /**
@@ -157,6 +164,7 @@ export default class UsersApi extends AsyncModules implements IUsersApi {
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This method requires user authorization (or a guest context).
      * @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/users/setCart setCart} documentation.
      */
     setCart(body: ICartSet): Promise<ICartResponse | IError>;
     /**
@@ -167,6 +175,7 @@ export default class UsersApi extends AsyncModules implements IUsersApi {
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This method requires user authorization (or a guest context).
      * @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/users/addCartItem addCartItem} documentation.
      */
     addCartItem(body: ICartAddItem): Promise<ICartResponse | IError>;
     /**
@@ -177,6 +186,7 @@ export default class UsersApi extends AsyncModules implements IUsersApi {
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This method requires user authorization (or a guest context).
      * @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/users/removeCartItem removeCartItem} documentation.
      */
     removeCartItem(productId: number): Promise<ICartResponse | IError>;
     /**
@@ -186,6 +196,7 @@ export default class UsersApi extends AsyncModules implements IUsersApi {
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This method requires user authorization (or a guest context).
      * @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/users/getWishlist getWishlist} documentation.
      */
     getWishlist(): Promise<IWishlistResponse | IError>;
     /**
@@ -196,6 +207,7 @@ export default class UsersApi extends AsyncModules implements IUsersApi {
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This method requires user authorization (or a guest context).
      * @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/users/setWishlist setWishlist} documentation.
      */
     setWishlist(body: IWishlistSet): Promise<IWishlistResponse | IError>;
     /**
@@ -206,6 +218,7 @@ export default class UsersApi extends AsyncModules implements IUsersApi {
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This method requires user authorization (or a guest context).
      * @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/users/addWishlistItem addWishlistItem} documentation.
      */
     addWishlistItem(body: IWishlistAddItem): Promise<IWishlistResponse | IError>;
     /**
@@ -216,6 +229,7 @@ export default class UsersApi extends AsyncModules implements IUsersApi {
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This method requires user authorization (or a guest context).
      * @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/users/removeWishlistItem removeWishlistItem} documentation.
      */
     removeWishlistItem(productId: number): Promise<IWishlistResponse | IError>;
 }