oneentry 1.0.137 → 1.0.138

package/dist/integration-collections/integrationCollectionsApi.js

@@ -43,7 +43,7 @@ class IntegrationCollectionsApi extends asyncModules_1.default {
      * @param {number} [userQuery.offset] - Optional parameter for pagination. Default: 30.
      * @param {string} [userQuery.entityType] - Entity type. Example: "orders".
      * @param {number} [userQuery.entityId] - Entity identifier. Example: 1.
-     * @returns {ICollectionEntity[]} Returns an array of ICollection objects or an error object if there was an issue.
+     * @returns {Promise<ICollectionEntity[] | IError>} Returns an array of ICollection objects or an error object if there was an issue.
      */
     async getICollections(langCode = this.state.lang, userQuery) {
         // eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -58,8 +58,8 @@ class IntegrationCollectionsApi extends asyncModules_1.default {
      * @handleName getICollectionById
      * @param {number} id - Collection id. Example: 1.
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @returns {ICollectionEntity} Returns an ICollection object or an error object if there was an issue.
-     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @returns {Promise<ICollectionEntity | IError>} Returns an ICollection object or an error object if there was an issue.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
      */
     async getICollectionById(id, langCode = this.state.lang) {
         const result = await this._fetchGet(`/${id}?` + this._queryParamsToString({ langCode }));
@@ -84,8 +84,8 @@ class IntegrationCollectionsApi extends asyncModules_1.default {
      * @param {number} [userQuery.offset] - Optional parameter for pagination. Default: 30.
      * @param {number} [userQuery.entityType] - Entity type. Example: "orders".
      * @param {number} [userQuery.entityId] - Entity identifier. Example: 1.
-     * @returns {ICollectionRowsResponce} Returns object ItemsWithTotal, where items is an array of requested objects.
-     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @returns {Promise<ICollectionRowsResponce | IError>} Returns object ItemsWithTotal, where items is an array of requested objects.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Get all records belonging to the collection by collection id.
      */
     async getICollectionRowsById(id, langCode = this.state.lang, userQuery) {
@@ -103,12 +103,12 @@ class IntegrationCollectionsApi extends asyncModules_1.default {
      * Check for the existence of a text identifier (marker).
      * @handleName validateICollectionMarker
      * @param {string} marker - Collection marker. Example: "collection1".
-     * @returns {ICollectionIsValid} Returns an object with a boolean property `valid` indicating whether the marker is valid or not.
+     * @returns {Promise<ICollectionIsValid | IError>} Returns an object with a boolean property `valid` indicating whether the marker is valid or not.
      * @example
         {
           "valid": true
         }
-     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Check for the existence of a text identifier (marker).
      */
     async validateICollectionMarker(marker) {
@@ -122,8 +122,8 @@ class IntegrationCollectionsApi extends asyncModules_1.default {
      * @handleName getICollectionRowsByMarker
      * @param {string} marker - Collection text identifier. Example: "collection1".
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @returns {ICollectionRowsResponce} Returns CollectionRowEntity object.
-     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @returns {Promise<ICollectionRowsResponce | IError>} Returns CollectionRowEntity object.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
      */
     async getICollectionRowsByMarker(marker, langCode = this.state.lang) {
         const result = await this._fetchGet(`/marker/${marker}/rows?langCode=${langCode}`);
@@ -137,8 +137,8 @@ class IntegrationCollectionsApi extends asyncModules_1.default {
      * @param {string} marker - Collection text identifier. Example: "collection1".
      * @param {number} id - Collection record identifier. Example: 1.
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @returns {ICollectionRow} Returns CollectionRowEntity object.
-     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @returns {Promise<ICollectionRow | IError>} Returns CollectionRowEntity object.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
      */
     async getICollectionRowByMarkerAndId(marker, id, langCode = this.state.lang) {
         const result = await this._fetchGet(`/marker/${marker}/rows/${id}?langCode=${langCode}`);
@@ -163,8 +163,8 @@ class IntegrationCollectionsApi extends asyncModules_1.default {
           ]
         }
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @returns {ICollectionRow} Returns object of type ICollectionRow.
-     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @returns {Promise<ICollectionRow | IError>} Returns object of type ICollectionRow.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Create a record in the collection.
      */
     async createICollectionRow(marker, body, langCode = this.state.lang) {
@@ -193,8 +193,8 @@ class IntegrationCollectionsApi extends asyncModules_1.default {
      * @param {string} body.formIdentifier - Textual identifier of the form. Example: "collection-form".
      * @param {any} body.formData - Object with the form data.
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @returns {ICollectionRow} Returns object of type ICollectionRow.
-     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @returns {Promise<ICollectionRow | IError>} Returns object of type ICollectionRow.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Edit a record in the collection.
      */
     async updateICollectionRow(marker, id, body, langCode = this.state.lang) {
@@ -208,8 +208,8 @@ class IntegrationCollectionsApi extends asyncModules_1.default {
      * @handleName deleteICollectionRowByMarkerAndId
      * @param {string} marker - text identifier of the collection Example: "collection1".
      * @param {number} id - record identifier in the collection Example: 12.
-     * @returns {boolean} Returns true (in case of successful deletion) or false (in case of unsuccessful deletion) (permission "collections.row.delete" required for access)
-     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @returns {Promise<boolean | IError>} Returns true (in case of successful deletion) or false (in case of unsuccessful deletion) (permission "collections.row.delete" required for access)
+     * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Deletion of collection record object
      */
     async deleteICollectionRowByMarkerAndId(marker, id) {

package/dist/locales/localesApi.d.ts

@@ -19,8 +19,8 @@ export default class LocalesApi extends AsyncModules implements ILocales {
     /**
      * Find all active language localization objects.
      * @handleName getLocales
-     * @returns {ILocalEntity[]} Returns an array of LocaleEntity objects.
-     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @returns {Promise<ILocalEntity[] | IError>} Returns an array of LocaleEntity objects.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Find all active language localization objects.
      */
     getLocales(): Promise<Array<ILocalEntity> | IError>;

package/dist/locales/localesApi.js

@@ -23,8 +23,8 @@ class LocalesApi extends asyncModules_1.default {
     /**
      * Find all active language localization objects.
      * @handleName getLocales
-     * @returns {ILocalEntity[]} Returns an array of LocaleEntity objects.
-     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @returns {Promise<ILocalEntity[] | IError>} Returns an array of LocaleEntity objects.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Find all active language localization objects.
      */
     async getLocales() {

package/dist/menus/menusApi.d.ts

@@ -21,8 +21,8 @@ export default class MenusApi extends AsyncModules implements IMenus {
      * @handleName getMenusByMarker
      * @param {string} marker - Menu marker. Example: "main_menu".
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @returns {IMenusEntity} Returns a single menu object as a ContentMenu object with included pages.
-     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @returns {Promise<IMenusEntity | IError>} Returns a single menu object as a ContentMenu object with included pages.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Get pages includes in menu by marker.
      */
     getMenusByMarker(marker: string, langCode?: string): Promise<IMenusEntity | IError>;

package/dist/menus/menusApi.js

@@ -25,8 +25,8 @@ class MenusApi extends asyncModules_1.default {
      * @handleName getMenusByMarker
      * @param {string} marker - Menu marker. Example: "main_menu".
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @returns {IMenusEntity} Returns a single menu object as a ContentMenu object with included pages.
-     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @returns {Promise<IMenusEntity | IError>} Returns a single menu object as a ContentMenu object with included pages.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Get pages includes in menu by marker.
      */
     async getMenusByMarker(marker, langCode = this.state.lang) {

package/dist/menus/menusInterfaces.d.ts

@@ -30,8 +30,8 @@ interface IMenus {
         "position": 1
       }
     ]
- * @property {number} id - The unique identifier of the menu. Example: 1.
- * @property {string} pageUrl - The page url string. Example: "about".
+ * @property {number | null} id - The unique identifier of the menu. Example: 1.
+ * @property {string | null} pageUrl - The page url string. Example: "about".
  * @property {ILocalizeInfo} localizeInfos - The menu data, taking into account localization.
  * @example
     {

package/dist/orders/ordersApi.d.ts

@@ -23,8 +23,8 @@ export default class OrdersApi extends AsyncModules implements IOrdersApi {
      * @param {string} [langCode] - Language code. Default: "en_US".
      * @param {number} [offset] - Optional parameter for pagination. Default: 0.
      * @param {number} [limit] - Optional parameter for pagination. Default: 30.
-     * @returns {IOrdersEntity[]} Returns an array of order storage objects.
-     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @returns {Promise<IOrdersEntity[] | IError>} Returns an array of order storage objects.
+     * @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}.
      */
@@ -36,8 +36,8 @@ export default class OrdersApi extends AsyncModules implements IOrdersApi {
      * @param {string} [langCode] - Language code. Default: "en_US".
      * @param {number} [offset] - Offset parameter. Default: 0.
      * @param {number} [limit] - Limit parameter. Default: 30.
-     * @returns {IOrdersByMarkerEntity} Returns an object with the orders.
-     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @returns {Promise<IOrdersByMarkerEntity | IError>} Returns an object with the orders.
+     * @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}.
      */
@@ -47,8 +47,8 @@ export default class OrdersApi extends AsyncModules implements IOrdersApi {
      * @handleName getOrderByMarker
      * @param {string} marker - Marker of the order object. Example: "order_storage_1".
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @returns {IOrdersEntity} Return object of order information.
-     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @returns {Promise<IOrdersEntity | IError>} Return object of order information.
+     * @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}.
      */
@@ -59,8 +59,8 @@ export default class OrdersApi extends AsyncModules implements IOrdersApi {
      * @param {string} marker - The text identifier of the order storage object. Example: "order_storage_1".
      * @param {number} id - ID of the order object. Example: 12345.
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @returns {IOrderByMarkerEntity} Returns an object with the order.
-     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @returns {Promise<IOrderByMarkerEntity | IError>} Returns an object with the order.
+     * @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}.
      */
@@ -87,8 +87,8 @@ export default class OrdersApi extends AsyncModules implements IOrdersApi {
           ]
         }
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @returns {IBaseOrdersEntity} Returns an object with the created order.
-     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @returns {Promise<IBaseOrdersEntity | IError>} Returns an object with the created order.
+     * @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}.
      */
@@ -117,8 +117,8 @@ export default class OrdersApi extends AsyncModules implements IOrdersApi {
           "currency": "USD"
         }
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @returns {IBaseOrdersEntity} Returns an object with the updated order.
-     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @returns {Promise<IBaseOrdersEntity | IError>} Returns an object with the updated order.
+     * @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}.
      */

package/dist/orders/ordersApi.js

@@ -27,8 +27,8 @@ class OrdersApi extends asyncModules_1.default {
      * @param {string} [langCode] - Language code. Default: "en_US".
      * @param {number} [offset] - Optional parameter for pagination. Default: 0.
      * @param {number} [limit] - Optional parameter for pagination. Default: 30.
-     * @returns {IOrdersEntity[]} Returns an array of order storage objects.
-     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @returns {Promise<IOrdersEntity[] | IError>} Returns an array of order storage objects.
+     * @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}.
      */
@@ -43,8 +43,8 @@ class OrdersApi extends asyncModules_1.default {
      * @param {string} [langCode] - Language code. Default: "en_US".
      * @param {number} [offset] - Offset parameter. Default: 0.
      * @param {number} [limit] - Limit parameter. Default: 30.
-     * @returns {IOrdersByMarkerEntity} Returns an object with the orders.
-     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @returns {Promise<IOrdersByMarkerEntity | IError>} Returns an object with the orders.
+     * @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}.
      */
@@ -59,8 +59,8 @@ class OrdersApi extends asyncModules_1.default {
      * @handleName getOrderByMarker
      * @param {string} marker - Marker of the order object. Example: "order_storage_1".
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @returns {IOrdersEntity} Return object of order information.
-     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @returns {Promise<IOrdersEntity | IError>} Return object of order information.
+     * @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}.
      */
@@ -74,8 +74,8 @@ class OrdersApi extends asyncModules_1.default {
      * @param {string} marker - The text identifier of the order storage object. Example: "order_storage_1".
      * @param {number} id - ID of the order object. Example: 12345.
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @returns {IOrderByMarkerEntity} Returns an object with the order.
-     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @returns {Promise<IOrderByMarkerEntity | IError>} Returns an object with the order.
+     * @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}.
      */
@@ -107,8 +107,8 @@ class OrdersApi extends asyncModules_1.default {
           ]
         }
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @returns {IBaseOrdersEntity} Returns an object with the created order.
-     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @returns {Promise<IBaseOrdersEntity | IError>} Returns an object with the created order.
+     * @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}.
      */
@@ -148,8 +148,8 @@ class OrdersApi extends asyncModules_1.default {
           "currency": "USD"
         }
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @returns {IBaseOrdersEntity} Returns an object with the updated order.
-     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @returns {Promise<IBaseOrdersEntity | IError>} Returns an object with the updated order.
+     * @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}.
      */

package/dist/orders/ordersInterfaces.d.ts

@@ -404,7 +404,8 @@ interface IOrderData {
         "quantity": 2
       }
     ]
- * @property {boolean} isCompleted - Indicates that the order has been completed. Example: true.
+ * @property {string | null} paymentUrl - Payment link. Example: "https://example.com/pay/123".
+ * @property {boolean | null} isCompleted - Indicates that the order has been completed. Example: true.
  * @description Represents an order storage object created by the user.
  */
 interface IOrderByMarkerEntity {

package/dist/pages/pagesApi.d.ts

@@ -20,8 +20,8 @@ export default class PageApi extends AsyncModules implements IPageApi {
      * Get all top-level page objects.
      * @handleName getRootPages
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @returns {IPagesEntity[]} Returns all created pages without parents as an array of PageEntity objects or an empty array [] (if there is no data)
-     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @returns {Promise<IPagesEntity[] | IError>} Returns all created pages without parents as an array of PageEntity objects or an empty array [] (if there is no data)
+     * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Get all top-level page objects.
      */
     getRootPages(langCode?: string): Promise<IPagesEntity[] | IError>;
@@ -29,8 +29,8 @@ export default class PageApi extends AsyncModules implements IPageApi {
      * Get all page objects with product information as an array.
      * @handleName getPages
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @returns {IPagesEntity[]} Returns all created pages as an array of PageEntity objects or an empty array [] (if there is no data).
-     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @returns {Promise<IPagesEntity[] | IError>} Returns all created pages as an array of PageEntity objects or an empty array [] (if there is no data).
+     * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Get all page objects with product information as an array.
      */
     getPages(langCode?: string): Promise<IPagesEntity[] | IError>;
@@ -39,8 +39,8 @@ export default class PageApi extends AsyncModules implements IPageApi {
      * @handleName getPageById
      * @param {number} id - The unique identifier of the page to be fetched. Example: 1.
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @returns {IPagesEntity} Returns PageEntity object
-     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @returns {Promise<IPagesEntity | IError>} Returns PageEntity object
+     * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Get page object with information about forms, blocks, menus, linked to the page.
      */
     getPageById(id: number, langCode?: string): Promise<IPagesEntity | IError>;
@@ -49,8 +49,8 @@ export default class PageApi extends AsyncModules implements IPageApi {
      * @handleName getPageByUrl
      * @param {string} url - Page URL. Example: "about".
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @returns {IPagesEntity} Returns PageEntity object
-     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @returns {Promise<IPagesEntity | IError>} Returns PageEntity object
+     * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Get page object with information about forms, blocks, menus, linked to the page by URL.
      */
     getPageByUrl(url: string, langCode?: string): Promise<IPagesEntity | IError>;
@@ -59,8 +59,8 @@ export default class PageApi extends AsyncModules implements IPageApi {
      * @handleName getChildPagesByParentUrl
      * @param {string} url - The URL of the parent page for which child pages are to be fetched. Example: "about/our-team".
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @returns {IPagesEntity} Returns all created pages as an array of PageEntity objects or an empty array [] (if there is no data) for the selected parent
-     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @returns {Promise<IPagesEntity | IError>} Returns all created pages as an array of PageEntity objects or an empty array [] (if there is no data) for the selected parent
+     * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Get child pages object with information as an array.
      */
     getChildPagesByParentUrl(url: string, langCode?: string): Promise<IPagesEntity[] | IError>;
@@ -69,8 +69,8 @@ export default class PageApi extends AsyncModules implements IPageApi {
      * @handleName getBlocksByPageUrl
      * @param {string} url - Page URL. Example: "about".
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @returns {IPositionBlock[]} Returns all blocks as an array of PositionBlock objects or an empty array [] (if there is no data) for the selected parent
-     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @returns {Promise<IPositionBlock[] | IError>} Returns all blocks as an array of PositionBlock objects or an empty array [] (if there is no data) for the selected parent
+     * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Get all blocks by page url.
      */
     getBlocksByPageUrl(url: string, langCode?: string): Promise<IPositionBlock[] | IError>;
@@ -78,8 +78,8 @@ export default class PageApi extends AsyncModules implements IPageApi {
      * Get settings for the page.
      * @handleName getConfigPageByUrl
      * @param {string} url - Page URL. Example: "about".
-     * @returns {IPageConfig} Returns a ConfigPage object with page display settings
-     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @returns {Promise<IPageConfig | IError>} Returns a ConfigPage object with page display settings
+     * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Get settings for the page.
      */
     getConfigPageByUrl(url: string): Promise<IPageConfig | IError>;
@@ -89,8 +89,8 @@ export default class PageApi extends AsyncModules implements IPageApi {
      * @param {string} name - Text for searching page objects (search is performed on the title field of the localizeInfos object with the language taken into account). Example: "About Us".
      * @param {string} [url] - Page URL. Example: "catalog".
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @returns {IPagesEntity[]} Returns all created pages as an array of PageEntity objects or an empty array [] (if there is no data)
-     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @returns {Promise<IPagesEntity[] | IError>} Returns all created pages as an array of PageEntity objects or an empty array [] (if there is no data)
+     * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Quick search for page objects with limited output.
      */
     searchPage(name: string, url?: string, langCode?: string): Promise<IPagesEntity[] | IError>;
@@ -133,8 +133,8 @@ export default class PageApi extends AsyncModules implements IPageApi {
             }
           }
         ]
-     * @returns {any} An array of page objects with template data added
-     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @returns {Promise<any | IError>} An array of page objects with template data added
+     * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Add template data to pages. Optimized to avoid N+1 query problem by fetching only unique templates in parallel.
      * For example, if 100 pages use 3 different templates, this method makes 3 requests instead of 100.
      */
@@ -143,8 +143,8 @@ export default class PageApi extends AsyncModules implements IPageApi {
      * Add template data to page by page templateIdentifier
      * @handleName addTemplateToPage
      * @param {IPagesEntity} data - Page object (IPagesEntity) to which template data will be added.
-     * @returns {any} An array of page objects with template data added
-     * @throws {IError} If there is an error during the fetch operation, it will return an error object.
+     * @returns {Promise<any | IError>} An array of page objects with template data added
+     * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Add template data to page by page templateIdentifier
      */
     protected addTemplateToPage(data: IPagesEntity): Promise<any | IError>;

package/dist/pages/pagesApi.js

@@ -27,8 +27,8 @@ class PageApi extends asyncModules_1.default {
      * Get all top-level page objects.
      * @handleName getRootPages
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @returns {IPagesEntity[]} Returns all created pages without parents as an array of PageEntity objects or an empty array [] (if there is no data)
-     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @returns {Promise<IPagesEntity[] | IError>} Returns all created pages without parents as an array of PageEntity objects or an empty array [] (if there is no data)
+     * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Get all top-level page objects.
      */
     async getRootPages(langCode = this.state.lang) {
@@ -45,8 +45,8 @@ class PageApi extends asyncModules_1.default {
      * Get all page objects with product information as an array.
      * @handleName getPages
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @returns {IPagesEntity[]} Returns all created pages as an array of PageEntity objects or an empty array [] (if there is no data).
-     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @returns {Promise<IPagesEntity[] | IError>} Returns all created pages as an array of PageEntity objects or an empty array [] (if there is no data).
+     * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Get all page objects with product information as an array.
      */
     async getPages(langCode = this.state.lang) {
@@ -64,8 +64,8 @@ class PageApi extends asyncModules_1.default {
      * @handleName getPageById
      * @param {number} id - The unique identifier of the page to be fetched. Example: 1.
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @returns {IPagesEntity} Returns PageEntity object
-     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @returns {Promise<IPagesEntity | IError>} Returns PageEntity object
+     * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Get page object with information about forms, blocks, menus, linked to the page.
      */
     async getPageById(id, langCode = this.state.lang) {
@@ -83,8 +83,8 @@ class PageApi extends asyncModules_1.default {
      * @handleName getPageByUrl
      * @param {string} url - Page URL. Example: "about".
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @returns {IPagesEntity} Returns PageEntity object
-     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @returns {Promise<IPagesEntity | IError>} Returns PageEntity object
+     * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Get page object with information about forms, blocks, menus, linked to the page by URL.
      */
     async getPageByUrl(url, langCode = this.state.lang) {
@@ -102,8 +102,8 @@ class PageApi extends asyncModules_1.default {
      * @handleName getChildPagesByParentUrl
      * @param {string} url - The URL of the parent page for which child pages are to be fetched. Example: "about/our-team".
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @returns {IPagesEntity} Returns all created pages as an array of PageEntity objects or an empty array [] (if there is no data) for the selected parent
-     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @returns {Promise<IPagesEntity | IError>} Returns all created pages as an array of PageEntity objects or an empty array [] (if there is no data) for the selected parent
+     * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Get child pages object with information as an array.
      */
     async getChildPagesByParentUrl(url, langCode = this.state.lang) {
@@ -121,8 +121,8 @@ class PageApi extends asyncModules_1.default {
      * @handleName getBlocksByPageUrl
      * @param {string} url - Page URL. Example: "about".
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @returns {IPositionBlock[]} Returns all blocks as an array of PositionBlock objects or an empty array [] (if there is no data) for the selected parent
-     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @returns {Promise<IPositionBlock[] | IError>} Returns all blocks as an array of PositionBlock objects or an empty array [] (if there is no data) for the selected parent
+     * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Get all blocks by page url.
      */
     async getBlocksByPageUrl(url, langCode = this.state.lang) {
@@ -189,8 +189,8 @@ class PageApi extends asyncModules_1.default {
      * Get settings for the page.
      * @handleName getConfigPageByUrl
      * @param {string} url - Page URL. Example: "about".
-     * @returns {IPageConfig} Returns a ConfigPage object with page display settings
-     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @returns {Promise<IPageConfig | IError>} Returns a ConfigPage object with page display settings
+     * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Get settings for the page.
      */
     async getConfigPageByUrl(url) {
@@ -207,8 +207,8 @@ class PageApi extends asyncModules_1.default {
      * @param {string} name - Text for searching page objects (search is performed on the title field of the localizeInfos object with the language taken into account). Example: "About Us".
      * @param {string} [url] - Page URL. Example: "catalog".
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @returns {IPagesEntity[]} Returns all created pages as an array of PageEntity objects or an empty array [] (if there is no data)
-     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @returns {Promise<IPagesEntity[] | IError>} Returns all created pages as an array of PageEntity objects or an empty array [] (if there is no data)
+     * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Quick search for page objects with limited output.
      */
     async searchPage(name, url, langCode = this.state.lang) {
@@ -275,8 +275,8 @@ class PageApi extends asyncModules_1.default {
             }
           }
         ]
-     * @returns {any} An array of page objects with template data added
-     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @returns {Promise<any | IError>} An array of page objects with template data added
+     * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Add template data to pages. Optimized to avoid N+1 query problem by fetching only unique templates in parallel.
      * For example, if 100 pages use 3 different templates, this method makes 3 requests instead of 100.
      */
@@ -329,8 +329,8 @@ class PageApi extends asyncModules_1.default {
      * Add template data to page by page templateIdentifier
      * @handleName addTemplateToPage
      * @param {IPagesEntity} data - Page object (IPagesEntity) to which template data will be added.
-     * @returns {any} An array of page objects with template data added
-     * @throws {IError} If there is an error during the fetch operation, it will return an error object.
+     * @returns {Promise<any | IError>} An array of page objects with template data added
+     * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Add template data to page by page templateIdentifier
      */
     async addTemplateToPage(data) {

package/dist/pages/pagesInterfaces.d.ts

@@ -1,7 +1,7 @@
-import type { IBlockEntity } from 'blocks/blocksInterfaces';
-import type { IFormConfig } from 'forms/formsInterfaces';
-import type { ITemplateEntity } from 'templates/templatesInterfaces';
 import type { AttributeType, IAttributes, IError, ILocalizeInfo, LangType, Types } from '../base/utils';
+import type { IBlockEntity } from '../blocks/blocksInterfaces';
+import type { IFormConfig } from '../forms/formsInterfaces';
+import type { ITemplateEntity } from '../templates/templatesInterfaces';
 /**
  * @interface IPageApi
  * @property {Function} getRootPages - Get all top-level page objects.
@@ -239,17 +239,17 @@ interface IPositionBlock {
       }
     }
  * @property {boolean} isSync - Indication of page indexing. Example: true.
- * @property {any} [template] - Template object. Example: {}.
+ * @property {object} [template] - Template object. Example: {}.
  * @property {number} [position] - Item number (for sorting). Example: 2.
- * @property {any} [config] - Output settings for catalog pages.
+ * @property {Record<string, number>} [config] - Output settings for catalog pages.
  * @example
     {
       "rowsPerPage": 1,
       "productsPerRow": 1
     }
  * @property {number} [products] - The number of products linked to the page. Example: 0.
- * @property {number} [childrenCount] - Children count. Example: 1.
- * @property {any} [blocks] - blocks.
+ * @property {string} [childrenCount] - Children count. Example: 1.
+ * @property {IBlockEntity[] | string[]} [blocks] - blocks.
  * @example
     {
       "id": 4,
@@ -262,6 +262,9 @@ interface IPositionBlock {
       "attributeValues": {},
       "position": 1
     }
+ * @property {Array<IFormConfig>} [moduleFormConfigs] - Module form configurations linked to the page.
+ * @property {string} [total] - Total number of products linked to the page. Example: "10".
+ * @property {string} [categoryPath] - Category path string. Example: "catalog".
  * @description This interface defines the structure of a page entity, including its identifiers, attributes, and hierarchical relationships.
  */
 interface IPagesEntity {