oneentry 1.0.123 → 1.0.125

package/dist/payments/paymentsApi.d.ts

@@ -1,9 +1,10 @@
 import AsyncModules from '../base/asyncModules';
 import type StateModule from '../base/stateModule';
 import type { IError } from '../base/utils';
-import type { IAccountsEntity, IConnectedEntity, ICreateSessionEntity, IPaymentsApi, ISessionEntity, ISessionsEntity } from './paymentsInterfaces';
+import type { IAccountsEntity, ICreateSessionEntity, IPaymentsApi, ISessionEntity, ISessionsEntity } from './paymentsInterfaces';
 /**
  * Controllers for working with payments
+ *
  * @handle /api/content/payments
  */
 export default class PaymentsApi extends AsyncModules implements IPaymentsApi {
@@ -11,70 +12,83 @@ export default class PaymentsApi extends AsyncModules implements IPaymentsApi {
     protected _url: string;
     constructor(state: StateModule);
     /**
-     * Get list of payment sessions.
+     * Get list of payment sessions. This method requires user authorization.
      *
-     * @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} [offset] - Optional parameter for pagination, default is 0
-     * @param {number} [limit] - Optional parameter for pagination, default is 30
+     * @handleName getSessions
      *
-     * @returns Returns an array of SessionEntity objects.
+     * @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 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.
      */
     getSessions(offset?: number, limit?: number): Promise<ISessionsEntity | IError>;
     /**
-     * Get a single payment session object by its identifier.
-     * @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.
+     * Get a single payment session object by its identifier. This method requires user authorization.
      *
-     * @param {number} id - Identifier of the retrieved payment session object
+     * @handleName getSessionById
      *
-     * @returns Returns a single payment session object.
+     * @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 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.
      */
     getSessionById(id: number): Promise<ISessionEntity | IError>;
     /**
-     * Get one payment session object by order identifier 🔐
+     * Get one payment session object by order identifier
+     *
+     * @handleName getSessionByOrderId
      *
-     * @param id - order identifier
-     * @returns
+     * @param {number} id - Order identifier. Example: 12345.
+     * @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 one payment session object by order identifier. This method requires user authorization.
      */
-    getSessionByOrderId(id: number): Promise<IAccountsEntity | IError>;
+    getSessionByOrderId(id: number): Promise<ISessionEntity | IError>;
     /**
-     * Creation of payment session.
-     * @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.
+     * Creation of payment session. This method requires user authorization.
      *
-     * @param {number} [orderId] - Order identifier
-     * @param {'session' | 'intent'} [type] - Session type
-     * @param {boolean} [automaticTaxEnabled] - Automatic calculation of the tax rate
+     * @handleName createSession
      *
-     * @returns 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.
+     * @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 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.
      */
     createSession(orderId: number, type: 'session' | 'intent', automaticTaxEnabled?: boolean): Promise<ICreateSessionEntity | IError>;
     /**
-     * Get payment settings.
-     * @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.
+     * Get all payment accounts as an array. This method requires user authorization.
      *
-     * @returns Returns object PaymentsConnected or null.
-     */
-    getConnected(): Promise<IConnectedEntity | null | IError>;
-    /**
-     * Get all payment accounts as an array.
-     * @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.
+     * @handleName getAccounts
      *
-     * @returns Returns all created payment accounts as an array of PaymentAccountEntity objects.
+     * @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 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.
      */
-    getAccounts(): Promise<Array<IAccountsEntity> | IError>;
+    getAccounts(): Promise<IAccountsEntity[] | IError>;
     /**
-     * Get a single payment account object by its identifier.
-     * @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.
+     * Get a single payment account object by its identifier. This method requires user authorization.
      *
-     * @param {number} id - Identifier of the retrieved payment account object
+     * @handleName getAccountById
      *
-     * @returns Returns a single payment account object.
+     * @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.
      */
-    getAccountById(id: number): Promise<IAccountsEntity | IError>;
+    getAccountById(id: number, settings?: any): Promise<IAccountsEntity | IError>;
     /**
-     * Webhook for Stripe.
-     * @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.
+     * Webhook for payment account.
+     *
+     * @handleName webhookByMarker
      *
-     * @returns 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.
      */
-    webhookStripe(): Promise<boolean | IError>;
+    webhookByMarker(marker: string): Promise<any | IError>;
 }

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,13 +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.
      *
-     * @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} [offset] - Optional parameter for pagination, default is 0
-     * @param {number} [limit] - Optional parameter for pagination, default is 30
+     * @handleName getSessions
      *
-     * @returns Returns an array of SessionEntity objects.
+     * @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 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 = {
@@ -31,36 +34,44 @@ class PaymentsApi extends asyncModules_1.default {
         return result;
     }
     /**
-     * Get a single payment session object by its identifier.
-     * @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.
+     * Get a single payment session object by its identifier. This method requires user authorization.
      *
-     * @param {number} id - Identifier of the retrieved payment session object
+     * @handleName getSessionById
      *
-     * @returns Returns a single payment session object.
+     * @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 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
      *
-     * @param id - order identifier
-     * @returns
+     * @handleName getSessionByOrderId
+     *
+     * @param {number} id - Order identifier. Example: 12345.
+     * @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 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.
-     * @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.
+     * Creation of payment session. This method requires user authorization.
      *
-     * @param {number} [orderId] - Order identifier
-     * @param {'session' | 'intent'} [type] - Session type
-     * @param {boolean} [automaticTaxEnabled] - Automatic calculation of the tax rate
+     * @handleName createSession
      *
-     * @returns 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.
+     * @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 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', {
@@ -71,45 +82,49 @@ class PaymentsApi extends asyncModules_1.default {
         return result;
     }
     /**
-     * Get payment settings.
-     * @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.
+     * Get all payment accounts as an array. This method requires user authorization.
      *
-     * @returns Returns object PaymentsConnected or null.
-     */
-    async getConnected() {
-        const result = await this._fetchGet('/connected');
-        return result;
-    }
-    /**
-     * Get all payment accounts as an array.
-     * @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.
+     * @handleName getAccounts
      *
-     * @returns Returns all created payment accounts as an array of PaymentAccountEntity objects.
+     * @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 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.
-     * @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.
+     * Get a single payment account object by its identifier. This method requires user authorization.
      *
-     * @param {number} id - Identifier of the retrieved payment account object
+     * @handleName getAccountById
      *
-     * @returns Returns a single payment account object.
+     * @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.
-     * @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.
+     * Webhook for payment account.
+     *
+     * @handleName webhookByMarker
      *
-     * @returns 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,72 +1,137 @@
-import type { IError } from '../base/utils';
+import type { IError, ILocalizeInfo } from '../base/utils';
 /**
- * Represents an interface object of Orders Api.
+ * @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 {
+    /**
+     * 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.
+     * @throws {IError} If there is an error during the fetch operation, it will return an error object.
+     */
     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.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     */
     getSessionById(id: number): Promise<ISessionEntity | IError>;
+    /**
+     * Get one payment session object by order identifier 🔐
+     *
+     * @param {number} id - Order identifier. Example: 12345.
+     * @return {ISessionEntity}
+     * @throws {IError} If there is an error during the fetch operation, it will return an error object.
+     */
+    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.
+     * @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>;
-    getConnected(): Promise<IConnectedEntity | null | IError>;
-    getAccounts(): Promise<Array<IAccountsEntity> | IError>;
-    getAccountById(id: number): Promise<IAccountsEntity | IError>;
-    webhookStripe(): Promise<boolean | 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<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, settings?: any): Promise<IAccountsEntity | IError>;
 }
 /**
- * ISessionsEntity
+ * @interface ISessionsEntity
+ *
+ * @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
+      }
+    ]
+ * @description Represents a response from the payments API containing a total count and an array of session entities.
  */
 interface ISessionsEntity {
     total: number;
     items: ISessionEntity;
 }
 /**
- * ISessionEntity
+ * @interface ISessionEntity
  *
- * @interface
- * @property {number} quantity - Quantity information.
- * @property {number} amount - Amount information.
- * @property {string} currency - Currency information.
- * @property {string} name - Name.
- * @property {string} description - Description.
+ * @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;
 }
 /**
- * IIntent
+ * @interface IIntent
  *
- * @interface
- * @property {number} amount
- * @property {string} currency
+ * @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 {
     amount: number;
     currency: string;
 }
 /**
- * ISessionItem
+ * @interface ISessionItem
  *
- * @interface
- * @property {number} id - Object identifier.
- * @property {string} updatedDate - Object modification date.
- * @property {string} type - Type may be 'session' or 'intent'.
- * @property {string} status - payment status.
- * @property {number} orderId - Order identifier.
- * @property {number} paymentAccountId - Payment account object identifier.
- * @property {string} paymentUrl - Payment link.
- * @property {string} clientSecret - Client secret key.
+ * @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".
+ * @description This interface defines the structure of a session item, which includes identifiers, payment details, and status information.
  */
 interface ISessionItem {
     id: number;
@@ -79,7 +144,14 @@ interface ISessionItem {
     status: string;
 }
 /**
- * ICreateSessionEntity
+ * @interface ICreateSessionEntity
+ *
+ * @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".
+ * @description This interface defines the structure of a session entity created during the payment process, including its identifiers, version, and payment URL.
  */
 interface ICreateSessionEntity {
     id: number;
@@ -89,32 +161,25 @@ interface ICreateSessionEntity {
     paymentUrl: string;
 }
 /**
- * IConnectedEntity
- *
- * @interface
- * @property {string} [stripeAccountId] - Identifier of connected Stripe account.
- * @property {string} [stripePublishableKey] - Stripe Connect public key.
- */
-interface IConnectedEntity {
-    stripeAccountId: string | null;
-    stripePublishableKey: string | null;
-}
-/**
- * IAccountsEntity
+ * @interface IAccountsEntity
  *
- * @interface
- * @property {number} id - Object identifier.
- * @property {string} identifier - Text identifier for the recording field.
- * @property {Record<string, any>} localizeInfos - Json description of the payment account object.
- * @property {'stripe' | 'custom'} type - Type may be 'stripe' or 'custom'.
- * @property {boolean} isVisible - Visibility indicator of the payment account.
+ * @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 {
     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

@@ -13,35 +13,35 @@ export default class ProductStatusesApi extends AsyncModules implements IProduct
     /**
      * Search for all product status objects.
      *
-     * @param {string} [langCode] - language code
+     * @handleName getProductStatuses
      *
-     * @returns Returns an array of 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.
+     * @description Search for all product status objects.
      */
-    getProductStatuses(langCode?: string): Promise<Array<IProductStatusEntity> | IError>;
-    /**
-     * Search for a product status object by identifier.
-     *
-     * @param {number} [id] - Status id
-     * @param {string} [langCode] - language code
-     *
-     * @returns Returns a product status object
-     */
-    getProductStatusesById(id: number, langCode?: string): Promise<IProductStatusEntity | IError>;
+    getProductStatuses(langCode?: string): Promise<IProductStatusEntity[] | IError>;
     /**
      * Search for a product status object by its textual identifier (marker).
      *
-     * @param {string} [marker] - Product marker
-     * @param {string} [langCode] - language code
+     * @handleName getProductsByStatusMarker
      *
-     * @returns Returns a product status object
+     * @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 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.
      *
-     * @param {string} [marker] - Product marker
+     * @handleName validateMarker
      *
-     * @returns Returns true if the textual identifier (marker) exists or false if it doesn't
+     * @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 Check the existence of a textual identifier.
      */
     validateMarker(marker: string): Promise<boolean | IError>;
 }

package/dist/product-statuses/productStatusesApi.js

@@ -16,33 +16,27 @@ class ProductStatusesApi extends asyncModules_1.default {
     /**
      * Search for all product status objects.
      *
-     * @param {string} [langCode] - language code
+     * @handleName getProductStatuses
      *
-     * @returns Returns an array of 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.
+     * @description Search for all product status objects.
      */
     async getProductStatuses(langCode = this.state.lang) {
         const result = await this._fetchGet('');
         return this._normalizeData(result, langCode);
     }
-    /**
-     * Search for a product status object by identifier.
-     *
-     * @param {number} [id] - Status id
-     * @param {string} [langCode] - language code
-     *
-     * @returns Returns a product status object
-     */
-    async getProductStatusesById(id, langCode = this.state.lang) {
-        const result = await this._fetchGet(`/${id}`);
-        return this._normalizeData(result, langCode);
-    }
     /**
      * Search for a product status object by its textual identifier (marker).
      *
-     * @param {string} [marker] - Product marker
-     * @param {string} [langCode] - language code
+     * @handleName getProductsByStatusMarker
      *
-     * @returns Returns a product status object
+     * @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 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,9 +45,12 @@ class ProductStatusesApi extends asyncModules_1.default {
     /**
      * Check the existence of a textual identifier.
      *
-     * @param {string} [marker] - Product marker
+     * @handleName validateMarker
      *
-     * @returns Returns true if the textual identifier (marker) exists or false if it doesn't
+     * @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 Check the existence of a textual identifier.
      */
     async validateMarker(marker) {
         const result = await this._fetchGet(`/marker-validation/${marker}`);