oneentry 1.0.123 → 1.0.124

package/dist/payments/paymentsApi.js

@@ -16,11 +16,15 @@ class PaymentsApi extends asyncModules_1.default {
     /**
      * Get list of payment sessions.
      *
-     * @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
+     *
+     * @param {number} [offset] - Optional parameter for pagination. Default: 0.
+     * @param {number} [limit] - Optional parameter for pagination. Default: 30.
      *
-     * @returns Returns an array of SessionEntity objects.
+     * @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.
      */
     async getSessions(offset = 0, limit = 30) {
         const query = {
@@ -32,11 +36,15 @@ class PaymentsApi extends asyncModules_1.default {
     }
     /**
      * 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.
      *
-     * @param {number} id - Identifier of the retrieved payment session object
+     * @handleName getSessionById
+     *
+     * @param {number} id - Identifier of the retrieved payment session object. Example: 12345.
      *
-     * @returns Returns a single payment session object.
+     * @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.
      */
     async getSessionById(id) {
         const result = await this._fetchGet(`/sessions/${id}`);
@@ -45,8 +53,14 @@ class PaymentsApi extends asyncModules_1.default {
     /**
      * Get one payment session object by order identifier 🔐
      *
-     * @param id - order identifier
-     * @returns
+     * @handleName getSessionByOrderId
+     *
+     * @param {number} id - Order identifier. Example: 12345.
+     *
+     * @return {IAccountsEntity}
+     * @throws {IError} If there is an error during the fetch operation, it will return an error object.
+     *
+     * @description
      */
     async getSessionByOrderId(id) {
         const result = await this._fetchGet(`/sessions/order/${id}`);
@@ -54,13 +68,17 @@ class PaymentsApi extends asyncModules_1.default {
     }
     /**
      * 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.
      *
-     * @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 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', {
@@ -72,9 +90,13 @@ class PaymentsApi extends asyncModules_1.default {
     }
     /**
      * 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.
      *
-     * @returns Returns object PaymentsConnected or null.
+     * @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');
@@ -82,9 +104,13 @@ class PaymentsApi extends asyncModules_1.default {
     }
     /**
      * 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.
      *
-     * @returns Returns all created payment accounts as an array of PaymentAccountEntity objects.
+     * @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.
      */
     async getAccounts() {
         const result = await this._fetchGet('/accounts');
@@ -92,11 +118,15 @@ class PaymentsApi extends asyncModules_1.default {
     }
     /**
      * Get a single payment account object by its identifier.
+     *
+     * @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
+     * @param {number} id - Identifier of the retrieved payment account object. Example: 12345.
      *
-     * @returns Returns a single payment account object.
+     * @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.
      */
     async getAccountById(id) {
         const result = await this._fetchGet(`/accounts/${id}`);
@@ -104,9 +134,13 @@ class PaymentsApi extends asyncModules_1.default {
     }
     /**
      * 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.
      *
-     * @returns Returns true (in case of successful execution) or false (in case of unsuccessful execution)
+     * @handleName webhookStripe
+     *
+     * @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.
+     *
+     * @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', {});

package/dist/payments/paymentsInterfaces.d.ts

@@ -1,6 +1,6 @@
 import type { IError } 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.
@@ -10,32 +10,102 @@ import type { IError } from '../base/utils';
  * @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 {IAccountsEntity}
+     * @throws {IError} If there is an error during the fetch operation, it will return an error object.
+     */
+    getSessionByOrderId(id: number): Promise<IAccountsEntity | 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>;
+    /**
+     * 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>;
+    /**
+     * Get a single payment account object by its identifier.
+     *
+     * @param {number} id - Identifier of the retrieved payment account object. 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.
+     */
     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>;
 }
 /**
- * ISessionsEntity
+ * @interface ISessionsEntity
+ *
+ * @property {number} total - Total number of found records. Example: 100.
+ * @property {ISessionEntity} items - Array of session objects. Example: .
+ *
+ * @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
- * @property {number} quantity - Quantity information.
- * @property {number} amount - Amount information.
- * @property {string} currency - Currency information.
- * @property {string} name - Name.
- * @property {string} description - Description.
+ * @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".
+ *
+ * @description This interface defines the structure of a session entity, including its quantity, amount, currency, name, and description.
  */
 interface ISessionEntity {
     quantity: number;
@@ -45,28 +115,30 @@ interface ISessionEntity {
     description: string;
 }
 /**
- * IIntent
+ * @interface IIntent
+ *
+ * @property {number} amount - Amount of the payment intent. Example: 100.00.
+ * @property {string} currency - Currency of the payment intent. Example: "USD".
  *
- * @interface
- * @property {number} amount
- * @property {string} currency
+ * @description This interface defines the structure of a payment intent, including its amount and currency.
  */
 interface IIntent {
     amount: number;
     currency: string;
 }
 /**
- * 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.
+ * @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} 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 +151,15 @@ 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,25 +169,28 @@ interface ICreateSessionEntity {
     paymentUrl: string;
 }
 /**
- * IConnectedEntity
+ * @interface IConnectedEntity
+ *
+ * @property {string} stripeAccountId - Identifier of connected Stripe account. Example: "acct_12345".
+ * @property {string} stripePublishableKey - Stripe Connect public key. Example: "pk_test_4eC39HqLyjWDarjtT1zdp7dc".
  *
- * @interface
- * @property {string} [stripeAccountId] - Identifier of connected Stripe account.
- * @property {string} [stripePublishableKey] - Stripe Connect public key.
+ * @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;
 }
 /**
- * IAccountsEntity
+ * @interface IAccountsEntity
  *
- * @interface
- * @property {number} id - Object identifier.
- * @property {string} identifier - Text identifier for the recording field.
+ * @property {number} id - Object identifier. Example: 12345.
+ * @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'.
- * @property {boolean} isVisible - Visibility indicator of the payment account.
+ * @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;

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

@@ -13,35 +13,41 @@ 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
-     */
-    getProductStatuses(langCode?: string): Promise<Array<IProductStatusEntity> | IError>;
-    /**
-     * Search for a product status object by identifier.
+     * @param {string} [langCode] - Language code. Default: "en_US".
      *
-     * @param {number} [id] - Status id
-     * @param {string} [langCode] - language code
+     * @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.
      *
-     * @returns Returns a product status object
+     * @description
      */
-    getProductStatusesById(id: number, langCode?: string): Promise<IProductStatusEntity | IError>;
+    getProductStatuses(langCode?: string): Promise<Array<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
      */
     getProductsByStatusMarker(marker: string, langCode?: string): Promise<IProductStatusEntity | IError>;
     /**
      * Check the existence of a textual identifier.
      *
-     * @param {string} [marker] - Product marker
+     * @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.
+     * @throws {IError} If there is an error during the fetch operation, it will return an error object.
      *
-     * @returns Returns true if the textual identifier (marker) exists or false if it doesn't
+     * @description
      */
     validateMarker(marker: string): Promise<boolean | IError>;
 }

package/dist/product-statuses/productStatusesApi.js

@@ -16,33 +16,31 @@ 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
      */
     async getProductStatuses(langCode = this.state.lang) {
         const result = await this._fetchGet('');
         return this._normalizeData(result, langCode);
     }
     /**
-     * Search for a product status object by identifier.
+     * Search for a product status object by its textual identifier (marker).
      *
-     * @param {number} [id] - Status id
-     * @param {string} [langCode] - language code
+     * @handleName getProductsByStatusMarker
      *
-     * @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. Example: 'in_stock'.
+     * @param {string} [langCode] - Language code. Default: "en_US".
      *
-     * @param {string} [marker] - Product marker
-     * @param {string} [langCode] - language code
+     * @return {IProductStatusEntity} Returns a product status object.
+     * @throws {IError} If there is an error during the fetch operation, it will return an error object.
      *
-     * @returns Returns a product status object
+     * @description
      */
     async getProductsByStatusMarker(marker, langCode = this.state.lang) {
         const result = await this._fetchGet(`/marker/${marker}`);
@@ -51,9 +49,14 @@ class ProductStatusesApi extends asyncModules_1.default {
     /**
      * Check the existence of a textual identifier.
      *
-     * @param {string} [marker] - Product marker
+     * @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.
+     * @throws {IError} If there is an error during the fetch operation, it will return an error object.
      *
-     * @returns Returns true if the textual identifier (marker) exists or false if it doesn't
+     * @description
      */
     async validateMarker(marker) {
         const result = await this._fetchGet(`/marker-validation/${marker}`);

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

@@ -1,27 +1,55 @@
 import type { IError } from '../base/utils';
 /**
- * Represents an interface object of Product Statuses Api.
+ * @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.
+ *
+ * @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.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     */
     getProductStatuses(langCode: string): Promise<Array<IProductStatusEntity> | IError>;
-    getProductStatusesById(id: number, 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.
+     * @throws {IError} If there is an error during the fetch operation, it will return an error object.
+     */
     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.
+     * @throws {IError} If there is an error during the fetch operation, it will return an error object.
+     */
     validateMarker(marker: string): Promise<boolean | IError>;
 }
 /**
- * Represents a position object.
+ * @interface IProductStatusEntity
+ *
+ * @property {number} id - The unique identifier of the position. Example: 12345.
+ * @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.
  *
- * @interface
- * @property {number} id - The unique identifier of the position.
- * @property {number} version - The version number of the object.
- * @property {string} identifier - The textual identifier for the record field.
- * @property {number} position - Position number.
- * @property {Record<string, any>} localizeInfos - The name of the products statuses, taking into account localization.
+ * @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;