oneentry 1.0.126 → 1.0.127

package/dist/menus/menusInterfaces.d.ts

@@ -1,48 +1,47 @@
 import type { IAttributeValues, IError, ILocalizeInfo } from '../base/utils';
 /**
  * @interface IMenus
- *
- * @property {function} getMenusByMarker - Get pages includes in menu by marker.
+ * @property {Function} getMenusByMarker - Get pages includes in menu by marker.
  * @description This interface defines a method for retrieving menu pages by a specific marker and language code.
  */
 interface IMenus {
     /**
      * Get pages includes in menu by marker.
-     *
-     * @param {string} marker - Menu marker. Example: "main_menu".
-     * @param {string} [langCode] - Language code. Default: "en_US".
-     * @return {IMenusEntity} Returns a single menu object as a ContentMenu object with included pages.
+     * @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.
+     * @description This method gets pages includes in menu by marker.
      */
     getMenusByMarker(marker: string, langCode: string): Promise<IMenusEntity | IError>;
 }
 /**
  * @interface IMenusPages
- *
- * @property {IMenusPages[]} children - Contains array with child page objects. Example:
-    [
-      {
-        "id": null,
-        "pageUrl": null,
-        "localizeInfos": {},
-        "attributeValues": {},
-        "parentId": null,
-        "position": 1
-      }
-    ]
- * @property {number} id - The unique identifier of the menu. Example: 1.
- * @property {string} pageUrl - The page url string. Example: "about".
- * @property {ILocalizeInfo} localizeInfos - The menu data, taking into account localization. Example:
-    {
-      "title": "menu"
-    }
+ * @property {IMenusPages[]}    children        - Contains array with child page objects. Example:
+                                                [
+                                                {
+                                                "id": null,
+                                                "pageUrl": null,
+                                                "localizeInfos": {},
+                                                "attributeValues": {},
+                                                "parentId": null,
+                                                "position": 1
+                                                }
+                                                ]
+ * @property {number}           id              - The unique identifier of the menu. Example: 1.
+ * @property {string}           pageUrl         - The page url string. Example: "about".
+ * @property {ILocalizeInfo}    localizeInfos   - The menu data, taking into account localization. Example:
+                                                {
+                                                "title": "menu"
+                                                }
  * @property {IAttributeValues} attributeValues - Attributes sets. Example:
-    {
-      "color": "red",
-      "size": "large"
-    }
- * @property {number} position - The menu position. Example: 1.
- * @property {number | null} parentId - The menu parent id. Example: null.
+                                                {
+                                                "color": "red",
+                                                "size": "large"
+                                                }
+ * @property {number}           position        - The menu position. Example: 1.
+ * @property {number | null}    parentId        - The menu parent id. Example: null.
  * @description This interface defines the structure of a menu page entity, including its identifiers, localization information, attributes, and hierarchical relationships.
  */
 interface IMenusPages {
@@ -56,24 +55,20 @@ interface IMenusPages {
 }
 /**
  * @interface IMenusEntity
- *
- * @property {number} id - The unique identifier of the menu. Example: 1.
- * @property {string} identifier - The menu identifier. Example: "main_menu".
- * @property {ILocalizeInfo} localizeInfos - The menu data, taking into account localization. Example:
-    {
-      "title": "menu"
-    }
- * @property {IMenusPages[]} pages - Array of menu pages. Example:
-    [
-      {
-        "id": null,
-        "pageUrl": null,
-        "localizeInfos": {},
-        "attributeValues": {},
-        "parentId": null,
-        "position": 1
-      }
-    ]
+ * @property {number}        id            - The unique identifier of the menu. Example: 1.
+ * @property {string}        identifier    - The menu identifier. Example: "main_menu".
+ * @property {ILocalizeInfo} localizeInfos - Contains localization information. Example: {"title": "menu"}.
+ * @property {IMenusPages[]} pages         - Array of menu pages. Example:
+                                           [
+                                           {
+                                           "id": null,
+                                           "pageUrl": null,
+                                           "localizeInfos": {},
+                                           "attributeValues": {},
+                                           "parentId": null,
+                                           "position": 1
+                                           }
+                                           ]
  * @description This interface defines the structure of a menu entity, including its identifiers, localization information, and associated pages.
  */
 interface IMenusEntity {

package/dist/menus/menusInterfaces.js

@@ -1,3 +1,4 @@
 "use strict";
+/* eslint-disable jsdoc/reject-function-type */
 // import type { IAttributesSets } from 'attribute-sets/attributeSetsInterfaces';
 Object.defineProperty(exports, "__esModule", { value: true });

package/dist/orders/ordersApi.d.ts

@@ -4,7 +4,6 @@ import type { IError } from '../base/utils';
 import type { IBaseOrdersEntity, IOrderByMarkerEntity, IOrderData, IOrdersApi, IOrdersByMarkerEntity, IOrdersEntity } from './ordersInterfaces';
 /**
  * Controllers for working with orders.
- *
  * @handle /api/content/orders-storage
  * @module OrdersApi
  * @description This module provides methods for working with orders, including retrieving, creating, and updating orders in the order storage.
@@ -12,113 +11,106 @@ import type { IBaseOrdersEntity, IOrderByMarkerEntity, IOrderData, IOrdersApi, I
 export default class OrdersApi extends AsyncModules implements IOrdersApi {
     protected state: StateModule;
     protected _url: string;
+    /**
+     * Constructs an instance of the OrdersApi class.
+     * @param {StateModule} state - The state module containing the necessary information for making API calls.
+     * @description Constructor initializes the OrdersApi with a given state.
+     */
     constructor(state: StateModule);
     /**
      * Getting all the order storage objects.
-     *
      * @handleName getAllOrdersStorage
-     *
-     * @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.
-     * @return {IOrdersEntity[]} Returns an array of order storage objects.
+     * @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.
      * @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.
-     **/
+     */
     getAllOrdersStorage(langCode?: string, offset?: number, limit?: number): Promise<IOrdersEntity[] | IError>;
     /**
      * Getting all orders from the orders storage object created by the user.
-     *
      * @handleName getAllOrdersByMarker
-     *
-     * @param {string} marker - Textual identifier of the order storage object. Example: "order_storage_1".
-     * @param {string} [langCode] - Language code. Default: "en_US".
-     * @param {number} [offset] - Offset parameter. Default: 0.
-     * @param {number} [limit] - Limit parameter. Default: 30.
-     * @return {IOrdersByMarkerEntity} Returns an object with the orders.
+     * @param   {string}                marker     - Textual identifier of the order storage object. Example: "order_storage_1".
+     * @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.
      * @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.
      */
     getAllOrdersByMarker(marker: string, langCode?: string, offset?: number, limit?: number): Promise<IOrdersByMarkerEntity | IError>;
     /**
      * Retrieve one order storage object by marker.
-     *
      * @handleName getOrderByMarker
-     *
-     * @param {string} marker - Marker of the order object. Example: "order_storage_1".
-     * @param {string} [langCode] - Language code. Default: "en_US".
-     * @return {IOrdersEntity} Return object of order information.
+     * @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.
      * @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.
      */
     getOrderByMarker(marker: string, langCode?: string): Promise<IOrdersEntity | IError>;
     /**
      * Getting a single order from the order storage object created by the user.
-     *
      * @handleName getOrderByMarkerAndId
-     *
-     * @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".
-     * @return {IOrderByMarkerEntity} Returns an object with the order.
+     * @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.
      * @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.
      */
     getOrderByMarkerAndId(marker: string, id: number, langCode?: string): Promise<IOrderByMarkerEntity | IError>;
     /**
      * Creation of an order in the order storage.
-     *
      * @handleName createOrder
-     *
-     * @param {string} marker - Textual identifier of the order storage object. Example: "order_storage_1".
-     * @param {IOrderData} body - Object for creating an order. Example:
-        {
-          "formIdentifier": "bar-orders-form",
-          "paymentAccountIdentifier": "usd-payment",
-          "formData": {
-            "marker": "name_1",
-            "value": "Name",
-            "type": "string"
-          },
-          "products": [
-            {
-              "productId": 1,
-              "quantity": 2
-            }
-          ]
-        }
-     * @param {String} [langCode] - Language code. Default: "en_US".
-     * @return {IBaseOrdersEntity} Returns an object with the created order.
+     * @param   {string}            marker     - Textual identifier of the order storage object. Example: "order_storage_1".
+     * @param   {IOrderData}        body       - Object for creating an order. Example:
+                                               {
+                                               "formIdentifier": "bar-orders-form",
+                                               "paymentAccountIdentifier": "usd-payment",
+                                               "formData": {
+                                               "marker": "name_1",
+                                               "value": "Name",
+                                               "type": "string"
+                                               },
+                                               "products": [
+                                               {
+                                               "productId": 1,
+                                               "quantity": 2
+                                               }
+                                               ]
+                                               }
+     * @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.
      * @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.
      */
     createOrder(marker: string, body: IOrderData, langCode?: string): Promise<IBaseOrdersEntity | IError>;
     /**
      * Changing an order in the orders storage
-     *
      * @handleName updateOrderByMarkerAndId
-     *
-     * @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 {IOrderData} body - Object for updating an order. Example:
-        {
-          "formIdentifier": "bar-orders-form",
-          "paymentAccountIdentifier": "usd-payment",
-          "formData": {
-            "marker": "name_1",
-            "value": "Name",
-            "type": "string"
-          },
-          "products": [
-            {
-              "productId": 1,
-              "quantity": 2
-            }
-          ],
-          "currency": "USD"
-        }
-     * @param {string} [langCode] - Language code. Default: "en_US".
-     * @return {IBaseOrdersEntity} Returns an object with the updated order.
+     * @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   {IOrderData}        body       - Object for updating an order. Example:
+                                               {
+                                               "formIdentifier": "bar-orders-form",
+                                               "paymentAccountIdentifier": "usd-payment",
+                                               "formData": {
+                                               "marker": "name_1",
+                                               "value": "Name",
+                                               "type": "string"
+                                               },
+                                               "products": [
+                                               {
+                                               "productId": 1,
+                                               "quantity": 2
+                                               }
+                                               ],
+                                               "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.
      * @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.
      */

package/dist/orders/ordersApi.js

@@ -6,58 +6,55 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const asyncModules_1 = __importDefault(require("../base/asyncModules"));
 /**
  * Controllers for working with orders.
- *
  * @handle /api/content/orders-storage
  * @module OrdersApi
  * @description This module provides methods for working with orders, including retrieving, creating, and updating orders in the order storage.
  */
 class OrdersApi extends asyncModules_1.default {
+    /**
+     * Constructs an instance of the OrdersApi class.
+     * @param {StateModule} state - The state module containing the necessary information for making API calls.
+     * @description Constructor initializes the OrdersApi with a given state.
+     */
     constructor(state) {
         super(state);
         this._url = state.url + '/api/content/orders-storage';
     }
     /**
      * Getting all the order storage objects.
-     *
      * @handleName getAllOrdersStorage
-     *
-     * @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.
-     * @return {IOrdersEntity[]} Returns an array of order storage objects.
+     * @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.
      * @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.
-     **/
+     */
     async getAllOrdersStorage(langCode = this.state.lang, offset = 0, limit = 30) {
         const result = await this._fetchGet(`?langCode=${langCode}&limit=${limit}&offset=${offset}`);
         return this._normalizeData(result);
     }
     /**
      * Getting all orders from the orders storage object created by the user.
-     *
      * @handleName getAllOrdersByMarker
-     *
-     * @param {string} marker - Textual identifier of the order storage object. Example: "order_storage_1".
-     * @param {string} [langCode] - Language code. Default: "en_US".
-     * @param {number} [offset] - Offset parameter. Default: 0.
-     * @param {number} [limit] - Limit parameter. Default: 30.
-     * @return {IOrdersByMarkerEntity} Returns an object with the orders.
+     * @param   {string}                marker     - Textual identifier of the order storage object. Example: "order_storage_1".
+     * @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.
      * @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.
      */
     async getAllOrdersByMarker(marker, langCode = this.state.lang, offset = 0, limit = 30) {
-        // eslint-disable-next-line @typescript-eslint/no-explicit-any
         const result = await this._fetchGet(`/marker/${marker}/orders?langCode=${langCode}&limit=${limit}&offset=${offset}`);
         return this._normalizeData(result);
     }
     /**
      * Retrieve one order storage object by marker.
-     *
      * @handleName getOrderByMarker
-     *
-     * @param {string} marker - Marker of the order object. Example: "order_storage_1".
-     * @param {string} [langCode] - Language code. Default: "en_US".
-     * @return {IOrdersEntity} Return object of order information.
+     * @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.
      * @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.
      */
@@ -67,13 +64,11 @@ class OrdersApi extends asyncModules_1.default {
     }
     /**
      * Getting a single order from the order storage object created by the user.
-     *
      * @handleName getOrderByMarkerAndId
-     *
-     * @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".
-     * @return {IOrderByMarkerEntity} Returns an object with the order.
+     * @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.
      * @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.
      */
@@ -83,28 +78,26 @@ class OrdersApi extends asyncModules_1.default {
     }
     /**
      * Creation of an order in the order storage.
-     *
      * @handleName createOrder
-     *
-     * @param {string} marker - Textual identifier of the order storage object. Example: "order_storage_1".
-     * @param {IOrderData} body - Object for creating an order. Example:
-        {
-          "formIdentifier": "bar-orders-form",
-          "paymentAccountIdentifier": "usd-payment",
-          "formData": {
-            "marker": "name_1",
-            "value": "Name",
-            "type": "string"
-          },
-          "products": [
-            {
-              "productId": 1,
-              "quantity": 2
-            }
-          ]
-        }
-     * @param {String} [langCode] - Language code. Default: "en_US".
-     * @return {IBaseOrdersEntity} Returns an object with the created order.
+     * @param   {string}            marker     - Textual identifier of the order storage object. Example: "order_storage_1".
+     * @param   {IOrderData}        body       - Object for creating an order. Example:
+                                               {
+                                               "formIdentifier": "bar-orders-form",
+                                               "paymentAccountIdentifier": "usd-payment",
+                                               "formData": {
+                                               "marker": "name_1",
+                                               "value": "Name",
+                                               "type": "string"
+                                               },
+                                               "products": [
+                                               {
+                                               "productId": 1,
+                                               "quantity": 2
+                                               }
+                                               ]
+                                               }
+     * @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.
      * @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.
      */
@@ -120,30 +113,28 @@ class OrdersApi extends asyncModules_1.default {
     }
     /**
      * Changing an order in the orders storage
-     *
      * @handleName updateOrderByMarkerAndId
-     *
-     * @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 {IOrderData} body - Object for updating an order. Example:
-        {
-          "formIdentifier": "bar-orders-form",
-          "paymentAccountIdentifier": "usd-payment",
-          "formData": {
-            "marker": "name_1",
-            "value": "Name",
-            "type": "string"
-          },
-          "products": [
-            {
-              "productId": 1,
-              "quantity": 2
-            }
-          ],
-          "currency": "USD"
-        }
-     * @param {string} [langCode] - Language code. Default: "en_US".
-     * @return {IBaseOrdersEntity} Returns an object with the updated order.
+     * @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   {IOrderData}        body       - Object for updating an order. Example:
+                                               {
+                                               "formIdentifier": "bar-orders-form",
+                                               "paymentAccountIdentifier": "usd-payment",
+                                               "formData": {
+                                               "marker": "name_1",
+                                               "value": "Name",
+                                               "type": "string"
+                                               },
+                                               "products": [
+                                               {
+                                               "productId": 1,
+                                               "quantity": 2
+                                               }
+                                               ],
+                                               "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.
      * @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.
      */