oneentry 1.0.126 → 1.0.127

package/dist/payments/paymentsApi.js

@@ -6,22 +6,25 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const asyncModules_1 = __importDefault(require("../base/asyncModules"));
 /**
  * Controllers for working with payments
- *
  * @handle /api/content/payments
+ * @description Controllers for working with payments
  */
 class PaymentsApi extends asyncModules_1.default {
+    /**
+     * Constructor
+     * @param {StateModule} state - StateModule instance
+     * @description Constructor initializes the PaymentsApi with a given state.
+     */
     constructor(state) {
         super(state);
         this._url = state.url + '/api/content/payments';
     }
     /**
      * Get list of payment sessions. This method requires user authorization.
-     *
      * @handleName getSessions
-     *
-     * @param {number} [offset] - Optional parameter for pagination. Default: 0.
-     * @param {number} [limit] - Optional parameter for pagination. Default: 30.
-     * @return {ISessionsEntity} Returns an array of SessionEntity objects.
+     * @param   {number}          [offset] - Optional parameter for pagination. Default: 0.
+     * @param   {number}          [limit]  - Optional parameter for pagination. Default: 30.
+     * @returns {ISessionsEntity}          Returns an array of SessionEntity objects.
      * @throws {IError} If there is an error during the fetch operation, it will return an error object.
      * @description Get list of payment sessions. This method requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
      */
@@ -35,11 +38,9 @@ class PaymentsApi extends asyncModules_1.default {
     }
     /**
      * Get a single payment session object by its identifier. This method requires user authorization.
-     *
      * @handleName getSessionById
-     *
-     * @param {number} id - Identifier of the retrieved payment session object. Example: 12345.
-     * @return {ISessionEntity} Returns a single payment session object.
+     * @param   {number}         id - Identifier of the retrieved payment session object. Example: 12345.
+     * @returns {ISessionEntity}    Returns a single payment session object.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      * @description Get a single payment session object by its identifier. This method requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
      */
@@ -49,11 +50,9 @@ class PaymentsApi extends asyncModules_1.default {
     }
     /**
      * Get one payment session object by order identifier
-     *
      * @handleName getSessionByOrderId
-     *
-     * @param {number} id - Order identifier. Example: 12345.
-     * @return {IAccountsEntity} Returns a single payment account object.
+     * @param   {number}          id - Order identifier. Example: 12345.
+     * @returns {IAccountsEntity}    Returns a single payment account object.
      * @throws {IError} If there is an error during the fetch operation, it will return an error object.
      * @description Get one payment session object by order identifier. This method requires user authorization.
      */
@@ -63,13 +62,11 @@ class PaymentsApi extends asyncModules_1.default {
     }
     /**
      * Creation of payment session. This method requires user authorization.
-     *
      * @handleName createSession
-     *
-     * @param {number} orderId - Order identifier. Example: 12345.
-     * @param {'session' | 'intent'} type - Session type. Possible values: "session" or "intent". Example:  'session'.
-     * @param {boolean} [automaticTaxEnabled] - Automatic calculation of the tax rate. Default: false.
-     * @return {ICreateSessionEntity} Returns a single payment session object.
+     * @param   {number}               orderId               - Order identifier. Example: 12345.
+     * @param   {'session' | 'intent'} type                  - Session type. Possible values: "session" or "intent". Example:  'session'.
+     * @param   {boolean}              [automaticTaxEnabled] - Automatic calculation of the tax rate. Default: false.
+     * @returns {ICreateSessionEntity}                       Returns a single payment session object.
      * @throws {IError} If there is an error during the fetch operation, it will return an error object.
      * @description Creation of payment session. 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,10 +80,8 @@ class PaymentsApi extends asyncModules_1.default {
     }
     /**
      * Get all payment accounts as an array. This method requires user authorization.
-     *
      * @handleName getAccounts
-     *
-     * @return {IAccountsEntity} Returns all created payment accounts as an array of PaymentAccountEntity objects.
+     * @returns {IAccountsEntity} Returns all created payment accounts as an array of PaymentAccountEntity objects.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      * @description Get all payment accounts as an array. This method requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
      */
@@ -96,33 +91,24 @@ class PaymentsApi extends asyncModules_1.default {
     }
     /**
      * Get a single payment account object by its identifier. This method requires user authorization.
-     *
      * @handleName getAccountById
-     *
-     * @param {number} id - Identifier of the retrieved payment account object. Example: 12345.
-     * @param {any} settings - Settings object. Example: !!!
-     * @return {IAccountsEntity} Returns a single payment account object.
+     * @param   {number}          id - Identifier of the retrieved payment account object. Example: 12345.
+     * @returns {IAccountsEntity}    Returns a single payment account object.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      * @description Get a single payment account object by its identifier. 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 getAccountById(id, 
-    // !!! куда добавлять settins? query? body?
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    settings) {
+    async getAccountById(id) {
         const result = await this._fetchGet(`/accounts/${id}`);
-        return result;
+        return this._normalizeData(result);
     }
     /**
      * Webhook for payment account.
-     *
      * @handleName webhookByMarker
-     *
-     * @param {number} marker - marker. Example: "stripe".
-     * @return {boolean} Returns ...!!!
+     * @param   {string}  marker - marker. Example: "stripe".
+     * @returns {boolean}        Returns true if the webhook was processed successfully.
      * @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.
      */
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
     async webhookByMarker(marker) {
         const result = await this._fetchPost(`/webhook/${marker}`, {});
         return result;

package/dist/payments/paymentsInterfaces.d.ts

@@ -1,85 +1,88 @@
 import type { IError, ILocalizeInfo } from '../base/utils';
 /**
  * @interface IPaymentsApi
- *
- * @property {function} getSessions - Get list of payment sessions.
- * @property {function} getSessionById - Get a single payment session object by its identifier.
- * @property {function} createSession - Creation of payment session.
- * @property {function} getAccounts - Get all payment accounts as an array.
- * @property {function} getAccountById - Get a single payment account object by its identifier.
- * @property {function} setAccessToken - Only for custom authorization. An intermediate method for setting up an access token.
+ * @property {Function} getSessions    - Get list of payment sessions.
+ * @property {Function} getSessionById - Get a single payment session object by its identifier.
+ * @property {Function} createSession  - Creation of payment session.
+ * @property {Function} getAccounts    - Get all payment accounts as an array.
+ * @property {Function} getAccountById - Get a single payment account object by its identifier.
+ * @property {Function} setAccessToken - Only for custom authorization. An intermediate method for setting up an access token.
  * @description This interface defines methods for managing payment sessions, accounts, and connected payment settings in the system.
  */
 interface IPaymentsApi {
     /**
      * Get list of payment sessions.
-     *
-     * @param {number} [offset] - Optional parameter for pagination. Default: 0.
-     * @param {number} [limit] - Optional parameter for pagination. Default: 30.
-     * @return {ISessionsEntity} Returns an array of SessionEntity objects.
+     * @handleName getSessions
+     * @param   {number}          [offset] - Optional parameter for pagination. Default: 0.
+     * @param   {number}          [limit]  - Optional parameter for pagination. Default: 30.
+     * @returns {ISessionsEntity}          Returns an array of SessionEntity objects.
      * @throws {IError} If there is an error during the fetch operation, it will return an error object.
+     * @description This method gets list of payment sessions.
      */
     getSessions(offset: number, limit: number): Promise<ISessionsEntity | IError>;
     /**
      * Get a single payment session object by its identifier.
-     *
-     * @param {number} id - Identifier of the retrieved payment session object. Example: 12345.
-     * @return {ISessionEntity} Returns a single payment session object.
+     * @handleName getSessionById
+     * @param   {number}         id - Identifier of the retrieved payment session object. Example: 12345.
+     * @returns {ISessionEntity}    Returns a single payment session object.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description This method gets a single payment session object by its identifier.
      */
     getSessionById(id: number): Promise<ISessionEntity | IError>;
     /**
      * Get one payment session object by order identifier 🔐
-     *
-     * @param {number} id - Order identifier. Example: 12345.
-     * @return {ISessionEntity}
+     * @handleName getSessionByOrderId
+     * @param   {number}         id - Order identifier. Example: 12345.
+     * @returns {ISessionEntity}    Returns a single payment session object.
      * @throws {IError} If there is an error during the fetch operation, it will return an error object.
+     * @description This method gets one payment session object by order identifier.
      */
     getSessionByOrderId(id: number): Promise<ISessionEntity | IError>;
     /**
      * Creation of payment session.
-     *
-     * @param {number} orderId - Order identifier. Example: 12345.
-     * @param {'session' | 'intent'} type - Session type. Possible values: "session" or "intent". Example: "session".
-     * @param {boolean} [automaticTaxEnabled] - Automatic calculation of the tax rate. Default: false.
-     * @return {ICreateSessionEntity} Returns a single payment session object.
+     * @handleName createSession
+     * @param   {number}               orderId               - Order identifier. Example: 12345.
+     * @param   {'session' | 'intent'} type                  - Session type. Possible values: "session" or "intent". Example: "session".
+     * @param   {boolean}              [automaticTaxEnabled] - Automatic calculation of the tax rate. Default: false.
+     * @returns {ICreateSessionEntity}                       Returns a single payment session object.
      * @throws {IError} If there is an error during the fetch operation, it will return an error object.
+     * @description This method creates a payment session.
      */
     createSession(orderId: number, type: 'session' | 'intent', automaticTaxEnabled?: boolean): Promise<ICreateSessionEntity | IError>;
     /**
      * Get all payment accounts as an array.
-     *
-     * @return {IAccountsEntity} Returns all created payment accounts as an array of PaymentAccountEntity objects.
+     * @handleName getAccounts
+     * @returns {IAccountsEntity} Returns all created payment accounts as an array of PaymentAccountEntity objects.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description This method gets all payment accounts as an array.
      */
     getAccounts(): Promise<IAccountsEntity[] | IError>;
     /**
      * Get a single payment account object by its identifier.
-     *
-     * @param {number} id - Identifier of the retrieved payment account object. Example: 12345.
-     * @param {any} settings - Settings object. Example: ...!!!
-     * @return {IAccountsEntity} Returns a single payment account object.
+     * @handleName getAccountById
+     * @param   {number}          id - Identifier of the retrieved payment account object. Example: 12345.
+     * @returns {IAccountsEntity}    Returns a single payment account object.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description This method gets a single payment account object by its identifier.
      */
-    getAccountById(id: number, settings?: any): Promise<IAccountsEntity | IError>;
+    getAccountById(id: number): Promise<IAccountsEntity | IError>;
 }
 /**
  * @interface ISessionsEntity
- *
- * @property {number} total - Total number of found records. Example: 100.
+ * @property {number}         total - Total number of found records. Example: 100.
  * @property {ISessionEntity} items - Array of session objects. Example:
-    [
-      {
-        "id": 27,
-        "createdDate": "2025-06-04T04:38:32.849Z",
-        "updatedDate": "2025-06-04T04:38:32.849Z",
-        "type": "session",
-        "status": "waiting",
-        "paymentAccountId": 1,
-        "orderId": 55,
-        "paymentUrl": null
-      }
-    ]
+                                    [
+                                    {
+                                    "id": 27,
+                                    "createdDate": "2025-06-04T04:38:32.849Z",
+                                    "updatedDate": "2025-06-04T04:38:32.849Z",
+                                    "type": "session",
+                                    "status": "waiting",
+                                    "paymentAccountId": 1,
+                                    "orderId": 55,
+                                    "paymentUrl": null
+                                    }
+                                    ]
  * @description Represents a response from the payments API containing a total count and an array of session entities.
  */
 interface ISessionsEntity {
@@ -88,15 +91,14 @@ interface ISessionsEntity {
 }
 /**
  * @interface ISessionEntity
- *
- * @property {number} id - Object identifier. Example: 1764.
- * @property {string} createdDate - Object creation date. Example: "2025-02-26T10:13:16.839Z".
- * @property {string} updatedDate - Object modification date. Example: "2025-02-26T10:13:16.839Z".
- * @property {string} type - Type may be 'session' or 'intent'. Example: "session".
- * @property {string} status - Payment status. Example: "completed".
- * @property {number} paymentAccountId - Payment ID from an external provider. Example: "9BE88048TU058770M".
- * @property {number} orderId - Order identifier. Example: 1.
- * @property {string | null} paymentUrl - payment link. Example: " https://www.sandbox.paypal.com/checkoutnow?token=9BE88048TU058770M".
+ * @property {number}        id               - Object identifier. Example: 1764.
+ * @property {string}        createdDate      - Object creation date. Example: "2025-02-26T10:13:16.839Z".
+ * @property {string}        updatedDate      - Object modification date. Example: "2025-02-26T10:13:16.839Z".
+ * @property {string}        type             - Type may be 'session' or 'intent'. Example: "session".
+ * @property {string}        status           - Payment status. Example: "completed".
+ * @property {number}        paymentAccountId - Payment ID from an external provider. Example: "9BE88048TU058770M".
+ * @property {number}        orderId          - Order identifier. Example: 1.
+ * @property {string | null} paymentUrl       - payment link. Example: " https://www.sandbox.paypal.com/checkoutnow?token=9BE88048TU058770M".
  * @description This interface defines the structure of a session entity, including its quantity, amount, currency, name, and description.
  */
 interface ISessionEntity {
@@ -111,8 +113,7 @@ interface ISessionEntity {
 }
 /**
  * @interface IIntent
- *
- * @property {number} amount - Amount of the payment intent. Example: 100.00.
+ * @property {number} amount   - Amount of the payment intent. Example: 100.00.
  * @property {string} currency - Currency of the payment intent. Example: "USD".
  * @description This interface defines the structure of a payment intent, including its amount and currency.
  */
@@ -122,15 +123,14 @@ interface IIntent {
 }
 /**
  * @interface ISessionItem
- *
- * @property {number} id - Object identifier. Example: 12345.
- * @property {string} updatedDate - Object modification date. Example: "2023-10-01T12:00:00Z".
- * @property {string} type - Type may be 'session' or 'intent'. Example: 'session'.
- * @property {number} orderId - Order identifier. Example: 12345.
+ * @property {number} id               - Object identifier. Example: 12345.
+ * @property {string} updatedDate      - Object modification date. Example: "2023-10-01T12:00:00Z".
+ * @property {string} type             - Type may be 'session' or 'intent'. Example: 'session'.
+ * @property {number} orderId          - Order identifier. Example: 12345.
  * @property {number} paymentAccountId - Payment account object identifier. Example: 12345.
- * @property {string} paymentUrl - Payment link. Example: "https://example.com/payment/12345".
- * @property {string} clientSecret - Client secret key. Example: "sk_test_4eC39HqLyjWDarjtT1zdp7dc".
- * @property {string} status - payment status. Example: "pending".
+ * @property {string} paymentUrl       - Payment link. Example: "https://example.com/payment/12345".
+ * @property {string} clientSecret     - Client secret key. Example: "sk_test_4eC39HqLyjWDarjtT1zdp7dc".
+ * @property {string} status           - payment status. Example: "pending".
  * @description This interface defines the structure of a session item, which includes identifiers, payment details, and status information.
  */
 interface ISessionItem {
@@ -145,12 +145,11 @@ interface ISessionItem {
 }
 /**
  * @interface ICreateSessionEntity
- *
- * @property {number} id - Object identifier. Example: 12345.
+ * @property {number} id          - Object identifier. Example: 12345.
  * @property {string} updatedDate - Object modification date. Example: "2023-10-01T12:00:00Z".
- * @property {number} version - Version of the object. Example: 1.
- * @property {string} identifier - Text identifier for the recording field. Example: "payment_12345".
- * @property {string} paymentUrl - Payment link. Example: "https://example.com/payment/12345".
+ * @property {number} version     - Version of the object. Example: 1.
+ * @property {string} identifier  - Text identifier for the recording field. Example: "payment_12345".
+ * @property {string} paymentUrl  - Payment link. Example: "https://example.com/payment/12345".
  * @description This interface defines the structure of a session entity created during the payment process, including its identifiers, version, and payment URL.
  */
 interface ICreateSessionEntity {
@@ -162,13 +161,12 @@ interface ICreateSessionEntity {
 }
 /**
  * @interface IAccountsEntity
- *
- * @property {number} id - Object identifier. Example: 12345.
- * @property {ILocalizeInfo} localizeInfos - Json description of the payment account object.
- * @property {string} identifier - Text identifier for the recording field. Example: "payment_12345".
- * @property {'stripe' | 'custom'} type - Type may be 'stripe' or 'custom'. Example: 'stripe'.
- * @property {boolean} isVisible - Visibility indicator of the payment account. Example: true.
- * @property {boolean} isUsed - Usage indicator of the payment account. Example: false.
+ * @property {number}              id            - Object identifier. Example: 12345.
+ * @property {ILocalizeInfo}       localizeInfos - Json description of the payment account object.
+ * @property {string}              identifier    - Text identifier for the recording field. Example: "payment_12345".
+ * @property {'stripe' | 'custom'} type          - Type may be 'stripe' or 'custom'. Example: 'stripe'.
+ * @property {boolean}             isVisible     - Visibility indicator of the payment account. Example: true.
+ * @property {boolean}             isUsed        - Usage indicator of the payment account. Example: false.
  * @description This interface defines the structure of a payment account entity, including its identifiers, localization information, type, visibility, and usage status.
  */
 interface IAccountsEntity {
@@ -178,8 +176,16 @@ interface IAccountsEntity {
     type: 'stripe' | 'custom';
     isVisible: boolean;
     isUsed: boolean;
-    settings: any;
     testMode: boolean;
-    testSettings: any;
+    settings: any;
+    testSettings: {
+        status: string;
+        cancelUrl?: string;
+        successUrl?: string;
+        sessionTimeout?: number;
+        stripeAccountId?: string;
+        stripeRedirectUrl?: string;
+        stripeOnboardingComplete?: boolean;
+    };
 }
 export type { IAccountsEntity, ICreateSessionEntity, IIntent, IPaymentsApi, ISessionEntity, ISessionItem, ISessionsEntity, };

package/dist/product-statuses/productStatusesApi.d.ts

@@ -5,41 +5,41 @@ import type { IProductStatusEntity, IProductStatuses } from './productStatusesIn
 /**
  * Controllers for working with product statuses
  * @handle /api/content/product-statuses
+ * @description Controllers for working with product statuses
  */
 export default class ProductStatusesApi extends AsyncModules implements IProductStatuses {
     protected state: StateModule;
     protected _url: string;
+    /**
+     * Constructor
+     * @param {StateModule} state - State module instance
+     * @description Constructor initializes the ProductStatusesApi with a given state.
+     */
     constructor(state: StateModule);
     /**
      * Search for all product status objects.
-     *
      * @handleName getProductStatuses
-     *
-     * @param {string} [langCode] - Language code. Default: "en_US".
-     * @return {IProductStatusEntity[]} Returns an array of product status objects.
+     * @param   {string}                 [langCode] - Language code. Default: "en_US".
+     * @returns {IProductStatusEntity[]}            Returns an array of product status objects.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      * @description Search for all product status objects.
      */
     getProductStatuses(langCode?: string): Promise<IProductStatusEntity[] | IError>;
     /**
      * Search for a product status object by its textual identifier (marker).
-     *
      * @handleName getProductsByStatusMarker
-     *
-     * @param {string} marker - Product marker. Example: "in_stock".
-     * @param {string} [langCode] - Language code. Default: "en_US".
-     * @return {IProductStatusEntity} Returns a product status object.
+     * @param   {string}               marker     - Product marker. Example: "in_stock".
+     * @param   {string}               [langCode] - Language code. Default: "en_US".
+     * @returns {IProductStatusEntity}            Returns a product status object.
      * @throws {IError} If there is an error during the fetch operation, it will return an error object.
      * @description Search for a product status object by its textual identifier (marker).
      */
     getProductsByStatusMarker(marker: string, langCode?: string): Promise<IProductStatusEntity | IError>;
     /**
      * Check the existence of a textual identifier.
-     *
      * @handleName validateMarker
-     *
-     * @param {string} marker - Product marker. Example: "in_stock".
-     * @return {boolean} Returns true if the textual identifier (marker) exists or false if it doesn't.
+     * @param   {string}  marker - Product marker. Example: "in_stock".
+     * @returns {boolean}        Returns true if the textual identifier (marker) exists or false if it doesn't.
      * @throws {IError} If there is an error during the fetch operation, it will return an error object.
      * @description Check the existence of a textual identifier.
      */

package/dist/product-statuses/productStatusesApi.js

@@ -7,19 +7,23 @@ const asyncModules_1 = __importDefault(require("../base/asyncModules"));
 /**
  * Controllers for working with product statuses
  * @handle /api/content/product-statuses
+ * @description Controllers for working with product statuses
  */
 class ProductStatusesApi extends asyncModules_1.default {
+    /**
+     * Constructor
+     * @param {StateModule} state - State module instance
+     * @description Constructor initializes the ProductStatusesApi with a given state.
+     */
     constructor(state) {
         super(state);
         this._url = state.url + '/api/content/product-statuses';
     }
     /**
      * Search for all product status objects.
-     *
      * @handleName getProductStatuses
-     *
-     * @param {string} [langCode] - Language code. Default: "en_US".
-     * @return {IProductStatusEntity[]} Returns an array of product status objects.
+     * @param   {string}                 [langCode] - Language code. Default: "en_US".
+     * @returns {IProductStatusEntity[]}            Returns an array of product status objects.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      * @description Search for all product status objects.
      */
@@ -29,12 +33,10 @@ class ProductStatusesApi extends asyncModules_1.default {
     }
     /**
      * Search for a product status object by its textual identifier (marker).
-     *
      * @handleName getProductsByStatusMarker
-     *
-     * @param {string} marker - Product marker. Example: "in_stock".
-     * @param {string} [langCode] - Language code. Default: "en_US".
-     * @return {IProductStatusEntity} Returns a product status object.
+     * @param   {string}               marker     - Product marker. Example: "in_stock".
+     * @param   {string}               [langCode] - Language code. Default: "en_US".
+     * @returns {IProductStatusEntity}            Returns a product status object.
      * @throws {IError} If there is an error during the fetch operation, it will return an error object.
      * @description Search for a product status object by its textual identifier (marker).
      */
@@ -44,11 +46,9 @@ class ProductStatusesApi extends asyncModules_1.default {
     }
     /**
      * Check the existence of a textual identifier.
-     *
      * @handleName validateMarker
-     *
-     * @param {string} marker - Product marker. Example: "in_stock".
-     * @return {boolean} Returns true if the textual identifier (marker) exists or false if it doesn't.
+     * @param   {string}  marker - Product marker. Example: "in_stock".
+     * @returns {boolean}        Returns true if the textual identifier (marker) exists or false if it doesn't.
      * @throws {IError} If there is an error during the fetch operation, it will return an error object.
      * @description Check the existence of a textual identifier.
      */

package/dist/product-statuses/productStatusesInterfaces.d.ts

@@ -1,55 +1,57 @@
 import type { IError, ILocalizeInfo } from '../base/utils';
 /**
  * @interface IProductStatuses
- *
- * @property {function} getProductStatuses - Search for all product status objects.
- * @property {function} getProductStatusesById - Search for a product status object by identifier.
- * @property {function} getProductsByStatusMarker - Search for a product status object by its textual identifier (marker).
- * @property {function} validateMarker - Check the existence of a textual identifier.
+ * @property {Function} getProductStatuses        - Search for all product status objects.
+ * @property {Function} getProductStatusesById    - Search for a product status object by identifier.
+ * @property {Function} getProductsByStatusMarker - Search for a product status object by its textual identifier (marker).
+ * @property {Function} validateMarker            - Check the existence of a textual identifier.
  * @description This interface defines methods for retrieving and managing product statuses in the system.
  */
 interface IProductStatuses {
     /**
      * Search for all product status objects.
-     *
-     * @param {string} [langCode] - Language code. Default: "en_US".
-     * @return {IProductStatusEntity[]} Returns an array of product status objects.
+     * @handleName getProductStatuses
+     * @param   {string}                 [langCode] - Language code. Default: "en_US".
+     * @returns {IProductStatusEntity[]}            Returns an array of product status objects.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description This method searches for all product status objects.
      */
     getProductStatuses(langCode: string): Promise<IProductStatusEntity[] | IError>;
     /**
      * Search for a product status object by its textual identifier (marker).
-     *
-     * @param {string} marker - Product marker. Example: "in_stock".
-     * @param {string} [langCode] - Language code. Default: "en_US".
-     * @return {IProductStatusEntity} Returns a product status object.
+     * @handleName getProductsByStatusMarker
+     * @param   {string}               marker     - Product marker. Example: "in_stock".
+     * @param   {string}               [langCode] - Language code. Default: "en_US".
+     * @returns {IProductStatusEntity}            Returns a product status object.
      * @throws {IError} If there is an error during the fetch operation, it will return an error object.
+     * @description This method searches for a product status object by its textual identifier (marker).
      */
     getProductsByStatusMarker(marker: string, langCode: string): Promise<IProductStatusEntity | IError>;
     /**
      * Check the existence of a textual identifier.
-     *
-     * @param {string} marker - Product marker. Example: "in_stock".
-     * @return {boolean} Returns true if the textual identifier (marker) exists or false if it doesn't.
+     * @handleName validateMarker
+     * @param   {string}  marker - Product marker. Example: "in_stock".
+     * @returns {boolean}        Returns true if the textual identifier (marker) exists or false if it doesn't.
      * @throws {IError} If there is an error during the fetch operation, it will return an error object.
+     * @description This method checks the existence of a textual identifier.
      */
     validateMarker(marker: string): Promise<boolean | IError>;
 }
 /**
+ * Product status entity structure
  * @interface IProductStatusEntity
- *
- * @property {number} id - The unique identifier of the position. Example: 12345.
- * @property {string} identifier - The textual identifier for the record field. Example: "in_stock".
+ * @property {number}        id            - The unique identifier of the position. Example: 12345.
+ * @property {string}        identifier    - The textual identifier for the record field. Example: "in_stock".
  * @property {ILocalizeInfo} localizeInfos - The name of the products statuses, taking into account localization. Example:
- * @property {boolean} isDefault - Default status flag. Example: true.
- * @property {number} version - The version number of the object. Example: 1.
- * @property {number} position - Position number. Example: 1.
-    {
-      "title": "Catalog",
-      "plainContent": "Content for catalog",
-      "htmlContent": "<b>Content for catalog</b>",
-      "menuTitle": "Catalog"
-    }
+ * @property {boolean}       isDefault     - Default status flag. Example: true.
+ * @property {number}        version       - The version number of the object. Example: 1.
+ * @property {number}        position      - Position number. Example: 1.
+                                           {
+                                           "title": "Catalog",
+                                           "plainContent": "Content for catalog",
+                                           "htmlContent": "<b>Content for catalog</b>",
+                                           "menuTitle": "Catalog"
+                                           }
  * @description This interface defines the structure of a product status entity, including its identifiers, localization information, position, and default status flag.
  */
 interface IProductStatusEntity {