oneentry 1.0.124 → 1.0.125

package/dist/menus/menusInterfaces.d.ts

@@ -1,9 +1,8 @@
-import type { IError, ILocalizeInfo } from '../base/utils';
+import type { IAttributeValues, IError, ILocalizeInfo } from '../base/utils';
 /**
  * @interface IMenus
  *
  * @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 {
@@ -12,7 +11,6 @@ interface IMenus {
      *
      * @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.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      */
@@ -21,22 +19,38 @@ interface IMenus {
 /**
  * @interface IMenusPages
  *
- * @property {Array<IMenusPages>} [children] - The optional parameter. Contains array with child page objects.
+ * @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: .
- * @property {IAttributesSets} attributeValues - Attributes sets. Example: { "color": "red", "size": "large" }.
+ * @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.
- *
  * @description This interface defines the structure of a menu page entity, including its identifiers, localization information, attributes, and hierarchical relationships.
  */
 interface IMenusPages {
-    children?: Array<IMenusPages> | IMenusPages;
+    children?: IMenusPages[] | IMenusPages;
     id: number | null;
     pageUrl: string | null;
     localizeInfos: ILocalizeInfo;
-    attributeValues: any;
+    attributeValues: IAttributeValues;
     position: number;
     parentId: number | null;
 }
@@ -45,15 +59,27 @@ interface IMenusPages {
  *
  * @property {number} id - The unique identifier of the menu. Example: 1.
  * @property {string} identifier - The menu identifier. Example: "main_menu".
- * @property {Record<string, any>} localizeInfos - The menu data, taking into account localization. Example: .
- * @property {Array<IMenusPages>} pages - Array of menu pages. Example: .
- *
+ * @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
+      }
+    ]
  * @description This interface defines the structure of a menu entity, including its identifiers, localization information, and associated pages.
  */
 interface IMenusEntity {
     id: number;
     identifier: string;
     localizeInfos: ILocalizeInfo;
-    pages: Array<IMenusPages> | IMenusPages;
+    pages: IMenusPages[] | IMenusPages;
 }
 export type { IMenus, IMenusEntity, IMenusPages };

package/dist/orders/ordersApi.d.ts

@@ -7,7 +7,6 @@ import type { IBaseOrdersEntity, IOrderByMarkerEntity, IOrderData, IOrdersApi, I
  *
  * @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.
  */
 export default class OrdersApi extends AsyncModules implements IOrdersApi {
@@ -19,16 +18,14 @@ export default class OrdersApi extends AsyncModules implements IOrdersApi {
      *
      * @handleName getAllOrdersStorage
      *
-     * @param {number} [langCode] - Language code. Default: "en_US".
+     * @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.
      * @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<Array<IOrdersEntity> | IError>;
+    getAllOrdersStorage(langCode?: string, offset?: number, limit?: number): Promise<IOrdersEntity[] | IError>;
     /**
      * Getting all orders from the orders storage object created by the user.
      *
@@ -38,10 +35,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.
-     *
      * @return {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>;
@@ -52,10 +47,8 @@ export default class OrdersApi extends AsyncModules implements IOrdersApi {
      *
      * @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.
      * @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>;
@@ -67,10 +60,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".
-     *
      * @return {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>;
@@ -80,15 +71,28 @@ export default class OrdersApi extends AsyncModules implements IOrdersApi {
      * @handleName createOrder
      *
      * @param {string} marker - Textual identifier of the order storage object. Example: "order_storage_1".
-     * @param {IOrderData} data - 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 {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.
      * @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, data: IOrderData, langCode?: string): Promise<IBaseOrdersEntity | IError>;
+    createOrder(marker: string, body: IOrderData, langCode?: string): Promise<IBaseOrdersEntity | IError>;
     /**
      * Changing an order in the orders storage
      *
@@ -96,12 +100,26 @@ 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 {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 {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.
      * @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.
      */
     updateOrderByMarkerAndId(marker: string, id: number, body: IOrderData, langCode?: string): Promise<IBaseOrdersEntity | IError>;

package/dist/orders/ordersApi.js

@@ -9,7 +9,6 @@ const asyncModules_1 = __importDefault(require("../base/asyncModules"));
  *
  * @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 {
@@ -22,13 +21,11 @@ class OrdersApi extends asyncModules_1.default {
      *
      * @handleName getAllOrdersStorage
      *
-     * @param {number} [langCode] - Language code. Default: "en_US".
+     * @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.
      * @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) {
@@ -44,10 +41,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.
-     *
      * @return {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) {
@@ -62,10 +57,8 @@ class OrdersApi extends asyncModules_1.default {
      *
      * @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.
      * @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 getOrderByMarker(marker, langCode = this.state.lang) {
@@ -80,10 +73,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".
-     *
      * @return {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.
      */
     async getOrderByMarkerAndId(marker, id, langCode = this.state.lang) {
@@ -96,22 +87,35 @@ class OrdersApi extends asyncModules_1.default {
      * @handleName createOrder
      *
      * @param {string} marker - Textual identifier of the order storage object. Example: "order_storage_1".
-     * @param {IOrderData} data - 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 {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.
      * @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 createOrder(marker, data, langCode = this.state.lang) {
+    async createOrder(marker, body, langCode = this.state.lang) {
         // eslint-disable-next-line @typescript-eslint/no-explicit-any
         const formData = {};
-        formData[langCode] = Array.isArray(data.formData)
-            ? data.formData
-            : [data.formData];
-        data.formData = formData;
-        const result = await this._fetchPost(`/marker/${marker}/orders`, data);
+        formData[langCode] = Array.isArray(body.formData)
+            ? body.formData
+            : [body.formData];
+        body.formData = formData;
+        const result = await this._fetchPost(`/marker/${marker}/orders`, body);
         return this._normalizeData(result);
     }
     /**
@@ -121,12 +125,26 @@ 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 {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 {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.
      * @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 updateOrderByMarkerAndId(marker, id, body, langCode = this.state.lang) {