oneentry 1.0.130 → 1.0.133

package/dist/payments/paymentsApi.js

@@ -20,13 +20,14 @@ class PaymentsApi extends asyncModules_1.default {
         this._url = state.url + '/api/content/payments';
     }
     /**
-     * Get list of payment sessions. This method requires user authorization.
+     * Get list of payment sessions.
      * @handleName getSessions
      * @param {number} [offset] - Optional parameter for pagination. Default: 0.
      * @param {number} [limit]  - Optional parameter for pagination. Default: 30.
      * @returns {ISessionsEntity} Returns an array of SessionEntity objects.
      * @throws {IError} If there is an error during the fetch operation, it will return an error object.
-     * @description Get list of payment sessions. This method requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
+     * @description This method gets list of payment sessions. 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}.
      */
     async getSessions(offset = 0, limit = 30) {
         const query = {
@@ -37,12 +38,13 @@ class PaymentsApi extends asyncModules_1.default {
         return result;
     }
     /**
-     * Get a single payment session object by its identifier. This method requires user authorization.
+     * Get a single payment session object by its identifier.
      * @handleName getSessionById
      * @param {number} id - Identifier of the retrieved payment session object. Example: 12345.
      * @returns {ISessionEntity} Returns a single payment session object.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
-     * @description Get a single payment session object by its identifier. This method requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
+     * @description This method gets a single payment session object by its identifier. 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}.
      */
     async getSessionById(id) {
         const result = await this._fetchGet(`/sessions/${id}`);
@@ -54,21 +56,23 @@ class PaymentsApi extends asyncModules_1.default {
      * @param {number} id - Order identifier. Example: 12345.
      * @returns {IAccountsEntity} Returns a single payment account object.
      * @throws {IError} If there is an error during the fetch operation, it will return an error object.
-     * @description Get one payment session object by order identifier. This method requires user authorization.
+     * @description This method gets one payment session object by order identifier. 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}.
      */
     async getSessionByOrderId(id) {
         const result = await this._fetchGet(`/sessions/order/${id}`);
         return result;
     }
     /**
-     * Creation of payment session. This method requires user authorization.
+     * Creation of payment session.
      * @handleName createSession
      * @param {number} orderId - Order identifier. Example: 12345.
      * @param {'session' | 'intent'} type - Session type. Possible values: "session" or "intent". Example:  'session'.
      * @param {boolean} [automaticTaxEnabled] - Automatic calculation of the tax rate. Default: false.
      * @returns {ICreateSessionEntity} Returns a single payment session object.
      * @throws {IError} If there is an error during the fetch operation, it will return an error object.
-     * @description Creation of payment session. This method requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
+     * @description This method creates a payment session. 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}.
      */
     async createSession(orderId, type, automaticTaxEnabled = false) {
         const result = await this._fetchPost('/sessions', {
@@ -79,23 +83,26 @@ class PaymentsApi extends asyncModules_1.default {
         return result;
     }
     /**
-     * Get all payment accounts as an array. This method requires user authorization.
+     * Get all payment accounts as an array.
      * @handleName getAccounts
      * @returns {IAccountsEntity} Returns all created payment accounts as an array of PaymentAccountEntity objects.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
-     * @description Get all payment accounts as an array. This method requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
+     * @description This method gets all payment accounts as an array. 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}.
      */
     async getAccounts() {
         const result = await this._fetchGet('/accounts');
         return this._normalizeData(result);
     }
     /**
-     * Get a single payment account object by its identifier. This method requires user authorization.
+     * Get a single payment account object by its identifier.
      * @handleName getAccountById
      * @param {number} id - Identifier of the retrieved payment account object. Example: 12345.
      * @returns {IAccountsEntity} Returns a single payment account object.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
-     * @description Get a single payment account object by its identifier. This method requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
+     * @description Get a single payment account object by its identifier.
+     * @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}.
      */
     async getAccountById(id) {
         const result = await this._fetchGet(`/accounts/${id}`);
@@ -107,7 +114,8 @@ class PaymentsApi extends asyncModules_1.default {
      * @param {string} marker - marker. Example: "stripe".
      * @returns {boolean} Returns true if the webhook was processed successfully.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
-     * @description This method requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
+     * @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}.
      */
     async webhookByMarker(marker) {
         const result = await this._fetchPost(`/webhook/${marker}`, {});

package/dist/payments/paymentsInterfaces.d.ts

@@ -17,7 +17,8 @@ interface IPaymentsApi {
      * @param {number} [limit] - Optional parameter for pagination. Default: 30.
      * @returns {ISessionsEntity} Returns an array of SessionEntity objects.
      * @throws {IError} If there is an error during the fetch operation, it will return an error object.
-     * @description This method gets list of payment sessions.
+     * @description This method gets list of payment sessions. 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}.
      */
     getSessions(offset: number, limit: number): Promise<ISessionsEntity | IError>;
     /**
@@ -26,7 +27,8 @@ interface IPaymentsApi {
      * @param {number} id - Identifier of the retrieved payment session object. Example: 12345.
      * @returns {ISessionEntity} Returns a single payment session object.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
-     * @description This method gets a single payment session object by its identifier.
+     * @description This method gets a single payment session object by its identifier. 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}.
      */
     getSessionById(id: number): Promise<ISessionEntity | IError>;
     /**
@@ -35,7 +37,8 @@ interface IPaymentsApi {
      * @param {number} id - Order identifier. Example: 12345.
      * @returns {ISessionEntity} Returns a single payment session object.
      * @throws {IError} If there is an error during the fetch operation, it will return an error object.
-     * @description This method gets one payment session object by order identifier.
+     * @description This method gets one payment session object by order identifier. 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}.
      */
     getSessionByOrderId(id: number): Promise<ISessionEntity | IError>;
     /**
@@ -46,7 +49,8 @@ interface IPaymentsApi {
      * @param {boolean} [automaticTaxEnabled] - Automatic calculation of the tax rate. Default: false.
      * @returns {ICreateSessionEntity} Returns a single payment session object.
      * @throws {IError} If there is an error during the fetch operation, it will return an error object.
-     * @description This method creates a payment session.
+     * @description This method creates a payment session. 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}.
      */
     createSession(orderId: number, type: 'session' | 'intent', automaticTaxEnabled?: boolean): Promise<ICreateSessionEntity | IError>;
     /**
@@ -54,7 +58,8 @@ interface IPaymentsApi {
      * @handleName getAccounts
      * @returns {IAccountsEntity} Returns all created payment accounts as an array of PaymentAccountEntity objects.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
-     * @description This method gets all payment accounts as an array.
+     * @description This method gets all payment accounts as an array. 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}.
      */
     getAccounts(): Promise<IAccountsEntity[] | IError>;
     /**
@@ -63,14 +68,26 @@ interface IPaymentsApi {
      * @param {number} id - Identifier of the retrieved payment account object. Example: 12345.
      * @returns {IAccountsEntity} Returns a single payment account object.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
-     * @description This method gets a single payment account object by its identifier.
+     * @description This method gets a single payment account object by its identifier. 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}.
      */
     getAccountById(id: number): Promise<IAccountsEntity | IError>;
+    /**
+     * Webhook for payment account.
+     * @handleName webhookByMarker
+     * @param {string} marker - marker. Example: "stripe".
+     * @returns {boolean} Returns true if the webhook was processed successfully.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @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}.
+     */
+    webhookByMarker(marker: string): Promise<boolean | IError>;
 }
 /**
  * @interface ISessionsEntity
  * @property {number} total - Total number of found records. Example: 100.
- * @property {ISessionEntity} items - Array of session objects. Example:
+ * @property {ISessionEntity} items - Array of session objects.
+ * @example
     [
       {
         "id": 27,
@@ -188,5 +205,6 @@ interface IAccountsEntity {
         stripePublishableKey?: string;
         status: string;
     };
+    updatedDate: string;
 }
 export type { IAccountsEntity, ICreateSessionEntity, IIntent, IPaymentsApi, ISessionEntity, ISessionItem, ISessionsEntity, };

package/dist/product-statuses/productStatusesInterfaces.d.ts

@@ -42,16 +42,17 @@ interface IProductStatuses {
  * @interface IProductStatusEntity
  * @property {number} id - The unique identifier of the position. Example: 12345.
  * @property {string} identifier - The textual identifier for the record field. Example: "in_stock".
- * @property {ILocalizeInfo} localizeInfos - The name of the products statuses, taking into account localization. Example:
- * @property {boolean} isDefault - Default status flag. Example: true.
- * @property {number} version - The version number of the object. Example: 1.
- * @property {number} position - Position number. Example: 1.
+ * @property {ILocalizeInfo} localizeInfos - The name of the products statuses, taking into account localization.
+ * @example
     {
       "title": "Catalog",
       "plainContent": "Content for catalog",
       "htmlContent": "<b>Content for catalog</b>",
       "menuTitle": "Catalog"
     }
+ * @property {boolean} isDefault - Default status flag. Example: true.
+ * @property {number} version - The version number of the object. Example: 1.
+ * @property {number} position - Position number. Example: 1.
  * @description This interface defines the structure of a product status entity, including its identifiers, localization information, position, and default status flag.
  */
 interface IProductStatusEntity {

package/dist/products/productsApi.d.ts

@@ -20,7 +20,8 @@ export default class ProductApi extends AsyncModules implements IProductApi {
     /**
      * Search for all products with pagination and filter.
      * @handleName getProducts
-     * @param {IFilterParams[]} [body] - Request body. Default: []. Example:
+     * @param {IFilterParams[]} [body] - Request body. Default: [].
+     * @example
         [
           {
             "attributeMarker": "price",
@@ -45,7 +46,8 @@ export default class ProductApi extends AsyncModules implements IProductApi {
           }
         ]
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @param {IProductsQuery} [userQuery] - Optional set query parameters. Example:
+     * @param {IProductsQuery} [userQuery] - Optional set query parameters.
+     * @example
         {
           "limit": 30,
           "offset": 0,
@@ -66,7 +68,8 @@ export default class ProductApi extends AsyncModules implements IProductApi {
      * Search for all product page objects with pagination that do not have a category.
      * @handleName getProductsEmptyPage
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @param {IProductsQuery} [userQuery] - Optional set query parameters. Example:
+     * @param {IProductsQuery} [userQuery] - Optional set query parameters.
+     * @example
         {
           "limit": 30,
           "offset": 0,
@@ -87,7 +90,8 @@ export default class ProductApi extends AsyncModules implements IProductApi {
      * Search for all products with pagination for the selected category.
      * @handleName getProductsByPageId
      * @param {number} id - Page id. Example: 2492.
-     * @param {IFilterParams[]} [body] - Request body. Default: []. Example:
+     * @param {IFilterParams[]} [body] - Request body. Default: [].
+     * @example
         [
           {
             "attributeMarker": "price",
@@ -112,7 +116,8 @@ export default class ProductApi extends AsyncModules implements IProductApi {
           }
         ]
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @param {IProductsQuery} [userQuery] - Optional set query parameters. Example:
+     * @param {IProductsQuery} [userQuery] - Optional set query parameters.
+     * @example
         {
           "limit": 30,
           "offset": 0,
@@ -134,7 +139,8 @@ export default class ProductApi extends AsyncModules implements IProductApi {
      * @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. Example:
+     * @param {IProductsQuery} [userQuery] - Optional set query parameters.
+     * @example
         {
           "limit": 30,
           "offset": 0,
@@ -155,7 +161,8 @@ export default class ProductApi extends AsyncModules implements IProductApi {
      * Search for all products with pagination for the selected category.
      * @handleName getProductsByPageUrl
      * @param {string} url - Page url. Example: "catalog".
-     * @param {IFilterParams[]} [body] - Request body. Default: []. Example:
+     * @param {IFilterParams[]} [body] - Request body. Default: [].
+     * @example
         [
           {
             "attributeMarker": "price",
@@ -180,7 +187,8 @@ export default class ProductApi extends AsyncModules implements IProductApi {
           }
         ]
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @param {IProductsQuery} [userQuery] - Optional set query parameters. Example:
+     * @param {IProductsQuery} [userQuery] - Optional set query parameters.
+     * @example
         {
           "limit": 30,
           "offset": 0,
@@ -202,7 +210,8 @@ export default class ProductApi extends AsyncModules implements IProductApi {
      * @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. Example:
+     * @param {IProductsQuery} [userQuery] - Optional set query parameters.
+     * @example
         {
           "limit": 30,
           "offset": 0,
@@ -226,9 +235,10 @@ export default class ProductApi extends AsyncModules implements IProductApi {
     /**
      * Find products by its ids.
      * @handleName getProductsByIds
-     * @param {string} [ids] - Product page identifiers for which to find relationships. Example: "12345,67890".
+     * @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. Example:
+     * @param {IProductsQuery} [userQuery] - Optional set query parameters.
+     * @example
         {
           "limit": 30,
           "offset": 0,
@@ -257,7 +267,7 @@ export default class ProductApi extends AsyncModules implements IProductApi {
     /**
      * Retrieve one product object.
      * @handleName getProductById
-     * @param {number} [id] - Product id. Example: 12345.
+     * @param {number} id - Product id. Example: 12345.
      * @param {string} [langCode] - Language code. Default: "en_US".
      * @returns {IProductsEntity} ProductEntity object.
      * @throws {IError} If there is an error during the fetch operation, it will return an error object.
@@ -286,7 +296,8 @@ export default class ProductApi extends AsyncModules implements IProductApi {
     /**
      * Getting the number of products for the entire catalog.
      * @handleName getProductsCount
-     * @param {any[]} body - Body parameters for filter. Deault: []. Example:
+     * @param {any[]} body - Body parameters for filter. Deault: [].
+     * @example
         [
           {
             "attributeMarker": "price",
@@ -308,7 +319,8 @@ export default class ProductApi extends AsyncModules implements IProductApi {
      * Getting the number of products on a catalog page by page ID.
      * @handleName getProductsCountByPageId
      * @param {string} id - Page ID.
-     * @param {any[]} body - Body parameters for filter. Deault: []. Example:
+     * @param {any[]} body - Body parameters for filter. Deault: [].
+     * @example
         [
           {
             "attributeMarker": "price",
@@ -330,7 +342,8 @@ export default class ProductApi extends AsyncModules implements IProductApi {
      * Getting the number of products for the catalog page by page url.
      * @handleName getProductsCountByPageUrl
      * @param {string} url - Page url.
-     * @param {any[]} body - Body parameters for filter. Deault: []. Example:
+     * @param {any[]} body - Body parameters for filter. Deault: [].
+     * @example
         [
           {
             "attributeMarker": "price",

package/dist/products/productsApi.js

@@ -29,7 +29,8 @@ class ProductApi extends asyncModules_1.default {
     /**
      * Search for all products with pagination and filter.
      * @handleName getProducts
-     * @param {IFilterParams[]} [body] - Request body. Default: []. Example:
+     * @param {IFilterParams[]} [body] - Request body. Default: [].
+     * @example
         [
           {
             "attributeMarker": "price",
@@ -54,7 +55,8 @@ class ProductApi extends asyncModules_1.default {
           }
         ]
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @param {IProductsQuery} [userQuery] - Optional set query parameters. Example:
+     * @param {IProductsQuery} [userQuery] - Optional set query parameters.
+     * @example
         {
           "limit": 30,
           "offset": 0,
@@ -83,7 +85,8 @@ class ProductApi extends asyncModules_1.default {
      * Search for all product page objects with pagination that do not have a category.
      * @handleName getProductsEmptyPage
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @param {IProductsQuery} [userQuery] - Optional set query parameters. Example:
+     * @param {IProductsQuery} [userQuery] - Optional set query parameters.
+     * @example
         {
           "limit": 30,
           "offset": 0,
@@ -108,7 +111,8 @@ class ProductApi extends asyncModules_1.default {
      * Search for all products with pagination for the selected category.
      * @handleName getProductsByPageId
      * @param {number} id - Page id. Example: 2492.
-     * @param {IFilterParams[]} [body] - Request body. Default: []. Example:
+     * @param {IFilterParams[]} [body] - Request body. Default: [].
+     * @example
         [
           {
             "attributeMarker": "price",
@@ -133,7 +137,8 @@ class ProductApi extends asyncModules_1.default {
           }
         ]
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @param {IProductsQuery} [userQuery] - Optional set query parameters. Example:
+     * @param {IProductsQuery} [userQuery] - Optional set query parameters.
+     * @example
         {
           "limit": 30,
           "offset": 0,
@@ -159,7 +164,8 @@ class ProductApi extends asyncModules_1.default {
      * @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. Example:
+     * @param {IProductsQuery} [userQuery] - Optional set query parameters.
+     * @example
         {
           "limit": 30,
           "offset": 0,
@@ -188,7 +194,8 @@ class ProductApi extends asyncModules_1.default {
      * Search for all products with pagination for the selected category.
      * @handleName getProductsByPageUrl
      * @param {string} url - Page url. Example: "catalog".
-     * @param {IFilterParams[]} [body] - Request body. Default: []. Example:
+     * @param {IFilterParams[]} [body] - Request body. Default: [].
+     * @example
         [
           {
             "attributeMarker": "price",
@@ -213,7 +220,8 @@ class ProductApi extends asyncModules_1.default {
           }
         ]
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @param {IProductsQuery} [userQuery] - Optional set query parameters. Example:
+     * @param {IProductsQuery} [userQuery] - Optional set query parameters.
+     * @example
         {
           "limit": 30,
           "offset": 0,
@@ -240,7 +248,8 @@ class ProductApi extends asyncModules_1.default {
      * @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. Example:
+     * @param {IProductsQuery} [userQuery] - Optional set query parameters.
+     * @example
         {
           "limit": 30,
           "offset": 0,
@@ -268,9 +277,10 @@ class ProductApi extends asyncModules_1.default {
     /**
      * Find products by its ids.
      * @handleName getProductsByIds
-     * @param {string} [ids] - Product page identifiers for which to find relationships. Example: "12345,67890".
+     * @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. Example:
+     * @param {IProductsQuery} [userQuery] - Optional set query parameters.
+     * @example
         {
           "limit": 30,
           "offset": 0,
@@ -308,7 +318,7 @@ class ProductApi extends asyncModules_1.default {
     /**
      * Retrieve one product object.
      * @handleName getProductById
-     * @param {number} [id] - Product id. Example: 12345.
+     * @param {number} id - Product id. Example: 12345.
      * @param {string} [langCode] - Language code. Default: "en_US".
      * @returns {IProductsEntity} ProductEntity object.
      * @throws {IError} If there is an error during the fetch operation, it will return an error object.
@@ -356,7 +366,8 @@ class ProductApi extends asyncModules_1.default {
     /**
      * Getting the number of products for the entire catalog.
      * @handleName getProductsCount
-     * @param {any[]} body - Body parameters for filter. Deault: []. Example:
+     * @param {any[]} body - Body parameters for filter. Deault: [].
+     * @example
         [
           {
             "attributeMarker": "price",
@@ -383,7 +394,8 @@ class ProductApi extends asyncModules_1.default {
      * Getting the number of products on a catalog page by page ID.
      * @handleName getProductsCountByPageId
      * @param {string} id - Page ID.
-     * @param {any[]} body - Body parameters for filter. Deault: []. Example:
+     * @param {any[]} body - Body parameters for filter. Deault: [].
+     * @example
         [
           {
             "attributeMarker": "price",
@@ -410,7 +422,8 @@ class ProductApi extends asyncModules_1.default {
      * Getting the number of products for the catalog page by page url.
      * @handleName getProductsCountByPageUrl
      * @param {string} url - Page url.
-     * @param {any[]} body - Body parameters for filter. Deault: []. Example:
+     * @param {any[]} body - Body parameters for filter. Deault: [].
+     * @example
         [
           {
             "attributeMarker": "price",