oneentry 1.0.127 → 1.0.128

package/dist/payments/paymentsInterfaces.d.ts

@@ -1,10 +1,10 @@
 import type { IError, ILocalizeInfo } from '../base/utils';
 /**
  * @interface IPaymentsApi
- * @property {Function} getSessions    - Get list of payment sessions.
+ * @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} 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.
@@ -13,9 +13,9 @@ interface IPaymentsApi {
     /**
      * Get list of payment sessions.
      * @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.
+     * @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.
      */
@@ -23,8 +23,8 @@ interface IPaymentsApi {
     /**
      * Get a single payment session object by its identifier.
      * @handleName getSessionById
-     * @param   {number}         id - Identifier of the retrieved payment session object. Example: 12345.
-     * @returns {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 This method gets a single payment session object by its identifier.
      */
@@ -32,8 +32,8 @@ interface IPaymentsApi {
     /**
      * Get one payment session object by order identifier 🔐
      * @handleName getSessionByOrderId
-     * @param   {number}         id - Order identifier. Example: 12345.
-     * @returns {ISessionEntity}    Returns a single payment session object.
+     * @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.
      */
@@ -41,10 +41,10 @@ interface IPaymentsApi {
     /**
      * Creation of payment session.
      * @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.
+     * @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.
      */
@@ -60,8 +60,8 @@ interface IPaymentsApi {
     /**
      * Get a single payment account object by its identifier.
      * @handleName getAccountById
-     * @param   {number}          id - Identifier of the retrieved payment account object. Example: 12345.
-     * @returns {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 This method gets a single payment account object by its identifier.
      */
@@ -69,20 +69,20 @@ interface IPaymentsApi {
 }
 /**
  * @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 {
@@ -91,14 +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 {
@@ -113,7 +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.
  */
@@ -123,14 +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,11 +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 {
@@ -161,12 +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 {

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

@@ -19,8 +19,8 @@ export default class ProductStatusesApi extends AsyncModules implements IProduct
     /**
      * Search for all product status objects.
      * @handleName getProductStatuses
-     * @param   {string}                 [langCode] - Language code. Default: "en_US".
-     * @returns {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.
      */
@@ -28,9 +28,9 @@ export default class ProductStatusesApi extends AsyncModules implements IProduct
     /**
      * 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".
-     * @returns {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).
      */
@@ -38,8 +38,8 @@ export default class ProductStatusesApi extends AsyncModules implements IProduct
     /**
      * Check the existence of a textual identifier.
      * @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.
+     * @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

@@ -22,8 +22,8 @@ class ProductStatusesApi extends asyncModules_1.default {
     /**
      * Search for all product status objects.
      * @handleName getProductStatuses
-     * @param   {string}                 [langCode] - Language code. Default: "en_US".
-     * @returns {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.
      */
@@ -34,9 +34,9 @@ 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".
-     * @returns {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).
      */
@@ -47,8 +47,8 @@ class ProductStatusesApi extends asyncModules_1.default {
     /**
      * Check the existence of a textual identifier.
      * @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.
+     * @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,18 +1,18 @@
 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} 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} 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.
      * @handleName getProductStatuses
-     * @param   {string}                 [langCode] - Language code. Default: "en_US".
-     * @returns {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 This method searches for all product status objects.
      */
@@ -20,9 +20,9 @@ interface IProductStatuses {
     /**
      * 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".
-     * @returns {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 This method searches for a product status object by its textual identifier (marker).
      */
@@ -30,8 +30,8 @@ interface IProductStatuses {
     /**
      * Check the existence of a textual identifier.
      * @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.
+     * @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.
      */
@@ -40,18 +40,18 @@ interface IProductStatuses {
 /**
  * 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 {