oneentry 1.0.127 → 1.0.128

package/dist/pages/pagesApi.d.ts

@@ -19,8 +19,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)
+     * @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.
      * @description Get all top-level page objects.
      */
@@ -28,8 +28,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).
+     * @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.
      * @description Get all page objects with product information as an array.
      */
@@ -37,9 +37,9 @@ export default class PageApi extends AsyncModules implements IPageApi {
     /**
      * Get page object with information about forms, blocks, menus, linked to the page.
      * @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
+     * @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.
      * @description Get page object with information about forms, blocks, menus, linked to the page.
      */
@@ -47,9 +47,9 @@ export default class PageApi extends AsyncModules implements IPageApi {
     /**
      * Get page object with information about forms, blocks, menus, linked to the page by URL.
      * @handleName getPageByUrl
-     * @param   {string}       url        - Page URL. Example: "about".
-     * @param   {string}       [langCode] - Language code. Default: "en_US".
-     * @returns {IPagesEntity}            Returns PageEntity object
+     * @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.
      * @description Get page object with information about forms, blocks, menus, linked to the page by URL.
      */
@@ -57,9 +57,9 @@ export default class PageApi extends AsyncModules implements IPageApi {
     /**
      * Get child pages object with information as an array.
      * @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
+     * @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.
      * @description Get child pages object with information as an array.
      */
@@ -67,9 +67,9 @@ export default class PageApi extends AsyncModules implements IPageApi {
     /**
      * Get all blocks by page url.
      * @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
+     * @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.
      * @description Get all blocks by page url.
      */
@@ -77,8 +77,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
+     * @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.
      * @description Get settings for the page.
      */
@@ -86,10 +86,10 @@ export default class PageApi extends AsyncModules implements IPageApi {
     /**
      * Quick search for page objects with limited output.
      * @handleName searchPage
-     * @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)
+     * @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.
      * @description Quick search for page objects with limited output.
      */
@@ -97,42 +97,42 @@ export default class PageApi extends AsyncModules implements IPageApi {
     /**
      * Add template data to pages
      * @handleName addTemplateToPages
-     * @param   {IPagesEntity[]} data - An array of page objects (IPagesEntity[]) to which template data will be added. Example:
-                                      [
-                                      {
-                                      id: 8,
-                                      parentId: null,
-                                      moduleFormConfigs: [],
-                                      pageUrl: 'blog',
-                                      depth: 0,
-                                      localizeInfos: {
-                                      title: 'Blog',
-                                      menuTitle: 'Blog',
-                                      htmlContent: '',
-                                      plainContent: '',
-                                      },
-                                      isVisible: true,
-                                      forms: [],
-                                      blocks: [],
-                                      type: 'common_page',
-                                      templateIdentifier: 'template',
-                                      attributeSetIdentifier: 'page',
-                                      attributeValues: {},
-                                      isSync: true,
-                                      template: {
-                                      id: 4,
-                                      attributeSetIdentifier: null,
-                                      title: 'Template',
-                                      generalTypeId: 4,
-                                      identifier: 'template',
-                                      version: 0,
-                                      generalTypeName: 'catalog_page',
-                                      attributeValues: {},
-                                      position: 1,
-                                      },
-                                      }
-                                      ]
-     * @returns {any}                 An array of page objects with template data added
+     * @param {IPagesEntity[]} data - An array of page objects (IPagesEntity[]) to which template data will be added. Example:
+        [
+          {
+            "id": 8,
+            "parentId": null,
+            "moduleFormConfigs": [],
+            "pageUrl": "blog",
+            "depth": 0,
+            "localizeInfos": {
+              "title": "Blog",
+              "menuTitle": "Blog",
+              "htmlContent": "",
+              "plainContent": "",
+            },
+            "isVisible": true,
+            "forms": [],
+            "blocks": [],
+            "type": "common_page",
+            "templateIdentifier": "template",
+            "attributeSetIdentifier": "page",
+            "attributeValues": {},
+            "isSync": true,
+            "template": {
+              "id": 4,
+              "attributeSetIdentifier": null,
+              "title": "Template",
+              "generalTypeId": 4,
+              "identifier": "template",
+              "version": 0,
+              "generalTypeName": "catalog_page",
+              "attributeValues": {},
+              "position": 1,
+            }
+          }
+        ]
+     * @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.
      * @description Add template data to pages
      */
@@ -140,8 +140,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
+     * @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.
      * @description Add template data to page by page templateIdentifier
      */

package/dist/pages/pagesApi.js

@@ -25,8 +25,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)
+     * @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.
      * @description Get all top-level page objects.
      */
@@ -41,8 +41,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).
+     * @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.
      * @description Get all page objects with product information as an array.
      */
@@ -57,9 +57,9 @@ class PageApi extends asyncModules_1.default {
     /**
      * Get page object with information about forms, blocks, menus, linked to the page.
      * @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
+     * @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.
      * @description Get page object with information about forms, blocks, menus, linked to the page.
      */
@@ -74,9 +74,9 @@ class PageApi extends asyncModules_1.default {
     /**
      * Get page object with information about forms, blocks, menus, linked to the page by URL.
      * @handleName getPageByUrl
-     * @param   {string}       url        - Page URL. Example: "about".
-     * @param   {string}       [langCode] - Language code. Default: "en_US".
-     * @returns {IPagesEntity}            Returns PageEntity object
+     * @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.
      * @description Get page object with information about forms, blocks, menus, linked to the page by URL.
      */
@@ -91,9 +91,9 @@ class PageApi extends asyncModules_1.default {
     /**
      * Get child pages object with information as an array.
      * @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
+     * @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.
      * @description Get child pages object with information as an array.
      */
@@ -108,9 +108,9 @@ class PageApi extends asyncModules_1.default {
     /**
      * Get all blocks by page url.
      * @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
+     * @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.
      * @description Get all blocks by page url.
      */
@@ -196,8 +196,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
+     * @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.
      * @description Get settings for the page.
      */
@@ -210,10 +210,10 @@ class PageApi extends asyncModules_1.default {
     /**
      * Quick search for page objects with limited output.
      * @handleName searchPage
-     * @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)
+     * @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.
      * @description Quick search for page objects with limited output.
      */
@@ -245,42 +245,42 @@ class PageApi extends asyncModules_1.default {
     /**
      * Add template data to pages
      * @handleName addTemplateToPages
-     * @param   {IPagesEntity[]} data - An array of page objects (IPagesEntity[]) to which template data will be added. Example:
-                                      [
-                                      {
-                                      id: 8,
-                                      parentId: null,
-                                      moduleFormConfigs: [],
-                                      pageUrl: 'blog',
-                                      depth: 0,
-                                      localizeInfos: {
-                                      title: 'Blog',
-                                      menuTitle: 'Blog',
-                                      htmlContent: '',
-                                      plainContent: '',
-                                      },
-                                      isVisible: true,
-                                      forms: [],
-                                      blocks: [],
-                                      type: 'common_page',
-                                      templateIdentifier: 'template',
-                                      attributeSetIdentifier: 'page',
-                                      attributeValues: {},
-                                      isSync: true,
-                                      template: {
-                                      id: 4,
-                                      attributeSetIdentifier: null,
-                                      title: 'Template',
-                                      generalTypeId: 4,
-                                      identifier: 'template',
-                                      version: 0,
-                                      generalTypeName: 'catalog_page',
-                                      attributeValues: {},
-                                      position: 1,
-                                      },
-                                      }
-                                      ]
-     * @returns {any}                 An array of page objects with template data added
+     * @param {IPagesEntity[]} data - An array of page objects (IPagesEntity[]) to which template data will be added. Example:
+        [
+          {
+            "id": 8,
+            "parentId": null,
+            "moduleFormConfigs": [],
+            "pageUrl": "blog",
+            "depth": 0,
+            "localizeInfos": {
+              "title": "Blog",
+              "menuTitle": "Blog",
+              "htmlContent": "",
+              "plainContent": "",
+            },
+            "isVisible": true,
+            "forms": [],
+            "blocks": [],
+            "type": "common_page",
+            "templateIdentifier": "template",
+            "attributeSetIdentifier": "page",
+            "attributeValues": {},
+            "isSync": true,
+            "template": {
+              "id": 4,
+              "attributeSetIdentifier": null,
+              "title": "Template",
+              "generalTypeId": 4,
+              "identifier": "template",
+              "version": 0,
+              "generalTypeName": "catalog_page",
+              "attributeValues": {},
+              "position": 1,
+            }
+          }
+        ]
+     * @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.
      * @description Add template data to pages
      */
@@ -296,8 +296,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
+     * @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.
      * @description Add template data to page by page templateIdentifier
      */