oneentry 1.0.122 → 1.0.124

package/dist/menus/menusInterfaces.d.ts

@@ -1,23 +1,35 @@
 import type { IError, ILocalizeInfo } from '../base/utils';
 /**
- * Represents an interface object of Menus Api.
+ * @interface IMenus
  *
- * @property {function} getAdminsInfo - 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.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     */
     getMenusByMarker(marker: string, langCode: string): Promise<IMenusEntity | IError>;
 }
 /**
- * Represents a position object.
+ * @interface IMenusPages
+ *
+ * @property {Array<IMenusPages>} [children] - The optional parameter. Contains array with child page objects.
+ * @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 {number} position - The menu position. Example: 1.
+ * @property {number | null} parentId - The menu parent id. Example: null.
  *
- * @interface
- * @property {Array<IMenusPages>} children - The optional parameter. Contains array with child page objects.
- * @property {number} id - The unique identifier of the menu.
- * @property {string} pageUrl - The page url string.
- * @property {ILocalizeInfo} localizeInfos - The menu data, taking into account localization.
- * @property {IAttributesSets} attributeValues - Attributes sets
- * @property {number} position - The menu position.
- * @property {number | null} parentId - The menu parent id.
+ * @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;
@@ -29,13 +41,14 @@ interface IMenusPages {
     parentId: number | null;
 }
 /**
- * Represents a position object.
+ * @interface IMenusEntity
+ *
+ * @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: .
  *
- * @interface
- * @property {number} id - The unique identifier of the menu.
- * @property {string} identifier - The menu identifier.
- * @property {Record<string, any>} localizeInfos - The menu data, taking into account localization.
- * @property {Array<IMenusPages>} pages - Array of menu pages.
+ * @description This interface defines the structure of a menu entity, including its identifiers, localization information, and associated pages.
  */
 interface IMenusEntity {
     id: number;

package/dist/orders/ordersApi.d.ts

@@ -3,106 +3,106 @@ import type StateModule from '../base/stateModule';
 import type { IError } from '../base/utils';
 import type { IBaseOrdersEntity, IOrderByMarkerEntity, IOrderData, IOrdersApi, IOrdersByMarkerEntity, IOrdersEntity } from './ordersInterfaces';
 /**
- * Controllers for working with orders
+ * 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.
  */
 export default class OrdersApi extends AsyncModules implements IOrdersApi {
     protected state: StateModule;
     protected _url: string;
     constructor(state: StateModule);
     /**
-     * Getting all the order storage objects
-     * @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.
+     * Getting all the order storage objects.
      *
-     * @param {number} [langCode] - Optional language field
-     * @param {number} [offset] - Optional parameter for pagination, default is 0
-     * @param {number} [limit] - Optional parameter for pagination, default is 30
-     */
+     * @handleName getAllOrdersStorage
+     *
+     * @param {number} [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>;
     /**
-     * Getting all orders from the orders storage object created by the user
+     * 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.
+     * @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.
-     * @param {string} [marker] - Textual identifier of the order storage object
-     * @param {string} [langCode] - Optional language field
-     * @param {number} [offset] - Offset parameter. Default 0
-     * @param {number} [limit] - Limit parameter. Default 30
      */
     getAllOrdersByMarker(marker: string, langCode?: string, offset?: number, limit?: number): Promise<IOrdersByMarkerEntity | IError>;
     /**
      * Retrieve one order storage object by marker.
      *
-     * @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.
-     * @param {string} [marker] - Marker of the order object
-     * @param {string} [langCode] - Language code
+     * @handleName getOrderByMarker
+     *
+     * @param {string} marker - Marker of the order object. Example: "order_storage_1".
+     * @param {string} [langCode] - Language code. Default: "en_US".
      *
-     * @returns Return object of order information.
+     * @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>;
     /**
-     * Getting a single order from the order storage object created by the user
+     * 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
-     * @param {number} [id] - ID of the order object
-     * @param {string} [langCode] - Optional language field
+     * @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>;
     /**
      * Creation of an order in the order storage.
      *
-     * @param {string} marker - Textual identifier of the order storage object
-     * @param {IOrderData} data - Object for creating an order
-     * @param {String} langCode - Optional language field
+     * @handleName createOrder
      *
-     * @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.
+     * @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 {String} [langCode] - Language code. Default: "en_US".
      *
-     * @example
-     * const body = {
-     *   "formIdentifier": "bar-orders-form",
-     *   "paymentAccountIdentifier": "usd-payment",
-     *   "formData": {
-     *       "marker": "name_1",
-     *       "value": "Name",
-     *       "type": "string"
-     *   },
-     *   "products": [
-     *     {
-     *       "productId": 1,
-     *       "quantity": 2,
-     *     }
-     *   ],
-     * }
-     *
-     * @returns Returns object for creating an order.
+     * @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>;
     /**
      * 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.
+     * @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.
-     * @param {string} [marker] - The text identifier of the order storage object
-     * @param {number} [id] - ID of the order object
-     * @param {IOrderData} [body] - Object for updating an order
-     * @param {string} [langCode] - Optional language field
-     *
-     * @example
-     * const body = {
-     *   "formIdentifier": "bar-orders-form",
-     *   "paymentAccountIdentifier": "usd-payment",
-     *   "formData": {
-     *       "marker": "name_1",
-     *       "value": "Name",
-     *       "type": "string"
-     *   },
-     *   "products": [
-     *     {
-     *       "productId": 1,
-     *       "quantity": 2
-     *     }
-     *   ],
-     *   "currency": "USD"
-     * }
      */
     updateOrderByMarkerAndId(marker: string, id: number, body: IOrderData, langCode?: string): Promise<IBaseOrdersEntity | IError>;
 }

package/dist/orders/ordersApi.js

@@ -3,11 +3,14 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-/* eslint-disable @typescript-eslint/no-explicit-any */
 const asyncModules_1 = __importDefault(require("../base/asyncModules"));
 /**
- * Controllers for working with orders
+ * 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 {
     constructor(state) {
@@ -15,50 +18,73 @@ class OrdersApi extends asyncModules_1.default {
         this._url = state.url + '/api/content/orders-storage';
     }
     /**
-     * Getting all the order storage objects
-     * @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.
+     * Getting all the order storage objects.
      *
-     * @param {number} [langCode] - Optional language field
-     * @param {number} [offset] - Optional parameter for pagination, default is 0
-     * @param {number} [limit] - Optional parameter for pagination, default is 30
-     */
+     * @handleName getAllOrdersStorage
+     *
+     * @param {number} [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) {
         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
+     * 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.
+     * @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.
-     * @param {string} [marker] - Textual identifier of the order storage object
-     * @param {string} [langCode] - Optional language field
-     * @param {number} [offset] - Offset parameter. Default 0
-     * @param {number} [limit] - Limit parameter. Default 30
      */
     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.
      *
-     * @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.
-     * @param {string} [marker] - Marker of the order object
-     * @param {string} [langCode] - Language code
+     * @handleName getOrderByMarker
+     *
+     * @param {string} marker - Marker of the order object. Example: "order_storage_1".
+     * @param {string} [langCode] - Language code. Default: "en_US".
      *
-     * @returns Return object of order information.
+     * @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) {
         const result = await this._fetchGet(`/marker/${marker}?langCode=${langCode}`);
         return this._normalizeData(result);
     }
     /**
-     * Getting a single order from the order storage object created by the user
+     * 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
-     * @param {number} [id] - ID of the order object
-     * @param {string} [langCode] - Optional language field
+     * @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) {
         const result = await this._fetchGet(`/marker/${marker}/orders/${id}?langCode=${langCode}`);
@@ -67,32 +93,19 @@ class OrdersApi extends asyncModules_1.default {
     /**
      * Creation of an order in the order storage.
      *
-     * @param {string} marker - Textual identifier of the order storage object
-     * @param {IOrderData} data - Object for creating an order
-     * @param {String} langCode - Optional language field
+     * @handleName createOrder
      *
-     * @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.
+     * @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 {String} [langCode] - Language code. Default: "en_US".
      *
-     * @example
-     * const body = {
-     *   "formIdentifier": "bar-orders-form",
-     *   "paymentAccountIdentifier": "usd-payment",
-     *   "formData": {
-     *       "marker": "name_1",
-     *       "value": "Name",
-     *       "type": "string"
-     *   },
-     *   "products": [
-     *     {
-     *       "productId": 1,
-     *       "quantity": 2,
-     *     }
-     *   ],
-     * }
-     *
-     * @returns Returns object for creating an order.
+     * @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) {
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
         const formData = {};
         formData[langCode] = Array.isArray(data.formData)
             ? data.formData
@@ -104,31 +117,20 @@ 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.
+     * @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.
-     * @param {string} [marker] - The text identifier of the order storage object
-     * @param {number} [id] - ID of the order object
-     * @param {IOrderData} [body] - Object for updating an order
-     * @param {string} [langCode] - Optional language field
-     *
-     * @example
-     * const body = {
-     *   "formIdentifier": "bar-orders-form",
-     *   "paymentAccountIdentifier": "usd-payment",
-     *   "formData": {
-     *       "marker": "name_1",
-     *       "value": "Name",
-     *       "type": "string"
-     *   },
-     *   "products": [
-     *     {
-     *       "productId": 1,
-     *       "quantity": 2
-     *     }
-     *   ],
-     *   "currency": "USD"
-     * }
      */
     async updateOrderByMarkerAndId(marker, id, body, langCode = this.state.lang) {
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
         const formData = {};
         formData[langCode] = Array.isArray(body.formData)
             ? body.formData