oneentry 1.0.124 → 1.0.126

package/dist/payments/paymentsApi.js

@@ -6,6 +6,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const asyncModules_1 = __importDefault(require("../base/asyncModules"));
 /**
  * Controllers for working with payments
+ *
  * @handle /api/content/payments
  */
 class PaymentsApi extends asyncModules_1.default {
@@ -14,17 +15,15 @@ class PaymentsApi extends asyncModules_1.default {
         this._url = state.url + '/api/content/payments';
     }
     /**
-     * Get list of payment sessions.
+     * 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.
      * @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.
+     * @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.
      */
     async getSessions(offset = 0, limit = 30) {
         const query = {
@@ -35,50 +34,44 @@ class PaymentsApi extends asyncModules_1.default {
         return result;
     }
     /**
-     * Get a single payment session object by its identifier.
+     * 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.
      * @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.
+     * @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.
      */
     async getSessionById(id) {
         const result = await this._fetchGet(`/sessions/${id}`);
         return result;
     }
     /**
-     * Get one payment session object by order identifier 🔐
+     * Get one payment session object by order identifier
      *
      * @handleName getSessionByOrderId
      *
      * @param {number} id - Order identifier. Example: 12345.
-     *
-     * @return {IAccountsEntity}
+     * @return {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
+     * @description Get one payment session object by order identifier. This method requires user authorization.
      */
     async getSessionByOrderId(id) {
         const result = await this._fetchGet(`/sessions/order/${id}`);
         return result;
     }
     /**
-     * Creation of payment session.
+     * 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 {'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.
      * @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.
+     * @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.
      */
     async createSession(orderId, type, automaticTaxEnabled = false) {
         const result = await this._fetchPost('/sessions', {
@@ -89,61 +82,49 @@ class PaymentsApi extends asyncModules_1.default {
         return result;
     }
     /**
-     * Get payment settings.
-     *
-     * @handleName getConnected
-     *
-     * @return {IConnectedEntity} Returns object PaymentsConnected or null.
-     * @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 getConnected() {
-        const result = await this._fetchGet('/connected');
-        return result;
-    }
-    /**
-     * Get all payment accounts as an array.
+     * 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.
      * @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.
+     * @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.
      */
     async getAccounts() {
         const result = await this._fetchGet('/accounts');
         return this._normalizeData(result);
     }
     /**
-     * Get a single payment account object by its identifier.
+     * Get a single payment account object by its identifier. This method requires user authorization.
      *
      * @handleName getAccountById
      *
-     * @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 {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.
      * @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) {
+    async getAccountById(id, 
+    // !!! куда добавлять settins? query? body?
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    settings) {
         const result = await this._fetchGet(`/accounts/${id}`);
         return result;
     }
     /**
-     * Webhook for Stripe.
+     * Webhook for payment account.
      *
-     * @handleName webhookStripe
+     * @handleName webhookByMarker
      *
-     * @return {boolean} Returns true (in case of successful execution) or false (in case of unsuccessful execution)
+     * @param {number} marker - marker. Example: "stripe".
+     * @return {boolean} Returns ...!!!
      * @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 webhookStripe() {
-        const result = await this._fetchPost('/webhook/stripe', {});
+    // 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,16 +1,13 @@
-import type { IError } from '../base/utils';
+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} getConnected - Get payment settings.
  * @property {function} getAccounts - Get all payment accounts as an array.
  * @property {function} getAccountById - Get a single payment account object by its identifier.
- * @property {function} webhookStripe - Webhook for Stripe.
  * @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 {
@@ -19,7 +16,6 @@ interface IPaymentsApi {
      *
      * @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.
      * @throws {IError} If there is an error during the fetch operation, it will return an error object.
      */
@@ -28,7 +24,6 @@ interface IPaymentsApi {
      * 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.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      */
@@ -37,59 +32,54 @@ interface IPaymentsApi {
      * Get one payment session object by order identifier 🔐
      *
      * @param {number} id - Order identifier. Example: 12345.
-     *
-     * @return {IAccountsEntity}
+     * @return {ISessionEntity}
      * @throws {IError} If there is an error during the fetch operation, it will return an error object.
      */
-    getSessionByOrderId(id: number): Promise<IAccountsEntity | IError>;
+    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 {'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.
      * @throws {IError} If there is an error during the fetch operation, it will return an error object.
      */
     createSession(orderId: number, type: 'session' | 'intent', automaticTaxEnabled?: boolean): Promise<ICreateSessionEntity | IError>;
-    /**
-     * Get payment settings.
-     *
-     * @return {IConnectedEntity} Returns object PaymentsConnected or null.
-     * @throws {IError} If there is an error during the fetch operation, it will return an error object.
-     */
-    getConnected(): Promise<IConnectedEntity | null | IError>;
     /**
      * Get all payment accounts as an array.
      *
      * @return {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.
      */
-    getAccounts(): Promise<Array<IAccountsEntity> | IError>;
+    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.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      */
-    getAccountById(id: number): Promise<IAccountsEntity | IError>;
-    /**
-     * Webhook for Stripe.
-     *
-     * @return {boolean} Returns true (in case of successful execution) or false (in case of unsuccessful execution)
-     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
-     */
-    webhookStripe(): Promise<boolean | IError>;
+    getAccountById(id: number, settings?: any): Promise<IAccountsEntity | IError>;
 }
 /**
  * @interface ISessionsEntity
  *
  * @property {number} total - Total number of found records. Example: 100.
- * @property {ISessionEntity} items - Array of session objects. Example: .
- *
+ * @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
+      }
+    ]
  * @description Represents a response from the payments API containing a total count and an array of session entities.
  */
 interface ISessionsEntity {
@@ -99,27 +89,31 @@ interface ISessionsEntity {
 /**
  * @interface ISessionEntity
  *
- * @property {number} quantity - Quantity information. Example: 2.
- * @property {number} amount - Amount information. Example: 100.00.
- * @property {string} currency - Currency information. Example: "USD".
- * @property {string} name - Name of the session. Example: "Checkout Session".
- * @property {string} description - Description. Example: "Payment for order #12345".
- *
+ * @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 {
-    quantity: number;
-    amount: number;
-    currency: string;
-    name: string;
-    description: string;
+    id: number;
+    createdDate: string;
+    updatedDate: string;
+    type: string;
+    status: string;
+    paymentAccountId: number;
+    orderId: number;
+    paymentUrl: string | null;
 }
 /**
  * @interface IIntent
  *
  * @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.
  */
 interface IIntent {
@@ -137,7 +131,6 @@ interface IIntent {
  * @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 {
@@ -158,7 +151,6 @@ interface ISessionItem {
  * @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 {
@@ -168,36 +160,26 @@ interface ICreateSessionEntity {
     identifier: string;
     paymentUrl: string;
 }
-/**
- * @interface IConnectedEntity
- *
- * @property {string} stripeAccountId - Identifier of connected Stripe account. Example: "acct_12345".
- * @property {string} stripePublishableKey - Stripe Connect public key. Example: "pk_test_4eC39HqLyjWDarjtT1zdp7dc".
- *
- * @description This interface defines the structure of a connected entity, which includes identifiers for a Stripe account and its publishable key.
- */
-interface IConnectedEntity {
-    stripeAccountId: string | null;
-    stripePublishableKey: string | null;
-}
 /**
  * @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 {Record<string, any>} localizeInfos - Json description of the payment account object.
  * @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 {
     id: number;
+    localizeInfos: ILocalizeInfo;
     identifier: string;
-    localizeInfos: Record<string, any>;
     type: 'stripe' | 'custom';
     isVisible: boolean;
     isUsed: boolean;
+    settings: any;
+    testMode: boolean;
+    testSettings: any;
 }
-export type { IAccountsEntity, IConnectedEntity, ICreateSessionEntity, IIntent, IPaymentsApi, ISessionEntity, ISessionItem, ISessionsEntity, };
+export type { IAccountsEntity, ICreateSessionEntity, IIntent, IPaymentsApi, ISessionEntity, ISessionItem, ISessionsEntity, };

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

@@ -16,25 +16,21 @@ export default class ProductStatusesApi extends AsyncModules implements IProduct
      * @handleName getProductStatuses
      *
      * @param {string} [langCode] - Language code. Default: "en_US".
-     *
      * @return {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
+     * @description Search for all product status objects.
      */
-    getProductStatuses(langCode?: string): Promise<Array<IProductStatusEntity> | IError>;
+    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} marker - Product marker. Example: "in_stock".
      * @param {string} [langCode] - Language code. Default: "en_US".
-     *
      * @return {IProductStatusEntity} Returns a product status object.
      * @throws {IError} If there is an error during the fetch operation, it will return an error object.
-     *
-     * @description
+     * @description Search for a product status object by its textual identifier (marker).
      */
     getProductsByStatusMarker(marker: string, langCode?: string): Promise<IProductStatusEntity | IError>;
     /**
@@ -42,12 +38,10 @@ export default class ProductStatusesApi extends AsyncModules implements IProduct
      *
      * @handleName validateMarker
      *
-     * @param {string} marker - Product marker. Example: 'in_stock'.
-     *
+     * @param {string} marker - Product marker. Example: "in_stock".
      * @return {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
+     * @description Check the existence of a textual identifier.
      */
     validateMarker(marker: string): Promise<boolean | IError>;
 }

package/dist/product-statuses/productStatusesApi.js

@@ -19,11 +19,9 @@ class ProductStatusesApi extends asyncModules_1.default {
      * @handleName getProductStatuses
      *
      * @param {string} [langCode] - Language code. Default: "en_US".
-     *
      * @return {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
+     * @description Search for all product status objects.
      */
     async getProductStatuses(langCode = this.state.lang) {
         const result = await this._fetchGet('');
@@ -34,13 +32,11 @@ class ProductStatusesApi extends asyncModules_1.default {
      *
      * @handleName getProductsByStatusMarker
      *
-     * @param {string} marker - Product marker. Example: 'in_stock'.
+     * @param {string} marker - Product marker. Example: "in_stock".
      * @param {string} [langCode] - Language code. Default: "en_US".
-     *
      * @return {IProductStatusEntity} Returns a product status object.
      * @throws {IError} If there is an error during the fetch operation, it will return an error object.
-     *
-     * @description
+     * @description Search for a product status object by its textual identifier (marker).
      */
     async getProductsByStatusMarker(marker, langCode = this.state.lang) {
         const result = await this._fetchGet(`/marker/${marker}`);
@@ -51,12 +47,10 @@ class ProductStatusesApi extends asyncModules_1.default {
      *
      * @handleName validateMarker
      *
-     * @param {string} marker - Product marker. Example: 'in_stock'.
-     *
+     * @param {string} marker - Product marker. Example: "in_stock".
      * @return {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
+     * @description Check the existence of a textual identifier.
      */
     async validateMarker(marker) {
         const result = await this._fetchGet(`/marker-validation/${marker}`);

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

@@ -1,4 +1,4 @@
-import type { IError } from '../base/utils';
+import type { IError, ILocalizeInfo } from '../base/utils';
 /**
  * @interface IProductStatuses
  *
@@ -6,7 +6,6 @@ import type { IError } from '../base/utils';
  * @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 {
@@ -14,17 +13,15 @@ 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.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      */
-    getProductStatuses(langCode: string): Promise<Array<IProductStatusEntity> | IError>;
+    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} marker - Product marker. Example: "in_stock".
      * @param {string} [langCode] - Language code. Default: "en_US".
-     *
      * @return {IProductStatusEntity} Returns a product status object.
      * @throws {IError} If there is an error during the fetch operation, it will return an error object.
      */
@@ -32,8 +29,7 @@ interface IProductStatuses {
     /**
      * Check the existence of a textual identifier.
      *
-     * @param {string} marker - Product marker. Example: 'in_stock'.
-     *
+     * @param {string} marker - Product marker. Example: "in_stock".
      * @return {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.
      */
@@ -43,20 +39,25 @@ interface IProductStatuses {
  * @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 {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 {string} identifier - The textual identifier for the record field. Example: 'in_stock'.
  * @property {number} position - Position number. Example: 1.
- * @property {Record<string, any>} localizeInfos - The name of the products statuses, taking into account localization. Example: .
- * @property {boolean} isDefault - Default status flag. Example: true.
- *
+    {
+      "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 {
     id: number;
-    position: number;
-    version: number;
     identifier: string;
-    localizeInfos: Record<string, any>;
+    localizeInfos: ILocalizeInfo;
     isDefault: boolean;
+    version: number;
+    position: number;
 }
 export type { IProductStatusEntity, IProductStatuses };