oneentry 1.0.145 → 1.0.146

package/dist/auth-provider/authProvidersInterfaces.d.ts

@@ -1,4 +1,4 @@
-import type { IError, ILocalizeInfo } from '../base/utils';
+import type { IError, ILocalizeInfo, IRating } from '../base/utils';
 /**
  * @interface IAuthProvider
  * @description This interface defines methods for user authentication and registration through various auth providers.
@@ -241,16 +241,14 @@ interface IOauthData {
  * @property {number} version - The version number of the sign-up entity. Example: 1.
  * @property {string} identifier - A unique string that identifies the sign-up entity. Example: "signup_12345".
  * @property {boolean} isActive - Indicates whether the sign-up entity is active. Example: true.
- * @property {Array<object> | Record<string, unknown>} formData - Form data, can be an array or a localized record.
+ * @property {Array<object>} formData - Form data array.
  * @example
-    {
-      "en_US": [
-        {
-          "marker": "first_name",
-          "value": "John"
-        }
-      ]
-    }
+    [
+      {
+        "marker": "first_name",
+        "value": "John"
+      }
+    ]
  * @property {object} notificationData - An object containing notification data, including email, phonePush, and phoneSMS.
  * @example
     {
@@ -264,7 +262,7 @@ interface IOauthData {
  * @property {string | null} [deletedAt] - Deletion date or null. Example: null.
  * @property {boolean} [isDeleted] - Whether the entity is deleted. Example: false.
  * @property {Record<string, unknown>} [state] - Additional state information. Example: {}.
- * @property {Record<string, unknown>} [rating] - Rating data. Example: {}.
+ * @property {IRating} [rating] - Rating data.
  * @description This interface defines the structure of a sign-up entity.
  */
 interface ISignUpEntity {
@@ -273,7 +271,7 @@ interface ISignUpEntity {
     version: number;
     identifier: string;
     isActive: boolean;
-    formData: Array<Record<string, any>> | Record<string, any>;
+    formData: Array<Record<string, any>>;
     notificationData: {
         email: string;
         phonePush: Array<string>;
@@ -285,7 +283,7 @@ interface ISignUpEntity {
     deletedAt?: string | null;
     isDeleted?: boolean;
     state?: Record<string, any>;
-    rating?: Record<string, unknown>;
+    rating?: IRating;
 }
 /**
  * Interface representing a code entity used for user registration or verification processes.

package/dist/base/utils.d.ts

@@ -139,6 +139,20 @@ interface IAttributeValues {
 interface IAttributeValue {
     [key: string]: any;
 }
+/**
+ * @interface IRating
+ * @property {number} value - Average rating value. Example: 4.5.
+ * @property {number} like - Number of likes. Example: 10.
+ * @property {number} dislike - Number of dislikes. Example: 2.
+ * @property {string} method - Rating calculation method. Example: "average".
+ * @description Interface for rating data.
+ */
+interface IRating {
+    value: number;
+    like: number;
+    dislike: number;
+    method: string;
+}
 /**
  * @interface IError
  * @property {string} message - Error message.
@@ -194,4 +208,4 @@ type LangType = string | Array<string>;
  * LocalizeType
  */
 type LocalizeType = ILocalizeInfos | ILocalizeInfo;
-export type { AttributeType, IAttributes, IAttributeValues, IConfig, IError, IHttpHeaders, IHttpOptions, ILocalizeInfo, ILocalizeInfos, LangType, LocalizeType, Types, };
+export type { AttributeType, IAttributes, IAttributeValues, IConfig, IError, IHttpHeaders, IHttpOptions, ILocalizeInfo, ILocalizeInfos, IRating, LangType, LocalizeType, Types, };

package/dist/discounts/discountsApi.d.ts

@@ -1,7 +1,7 @@
 import AsyncModules from '../base/asyncModules';
 import type StateModule from '../base/stateModule';
 import type { IError } from '../base/utils';
-import type { BonusTransactionType, IBonusTransactionEntity, ICouponValidationResult, IDiscountsApi, IDiscountsEntity, IDiscountsResponse } from './discountsInterfaces';
+import type { IBonusBalanceEntity, IBonusTransactionEntity, IBonusTransactionType, ICouponValidationResult, IDiscountsApi, IDiscountsEntity, IDiscountsResponse, IDiscountType } from './discountsInterfaces';
 /**
  * Controllers for working with events
  * @handle /api/content/events
@@ -28,12 +28,12 @@ export default class DiscountsApi extends AsyncModules implements IDiscountsApi
      * @param {string} [langCode] - Language code. Default: "en_US".
      * @param {number} [offset] - Optional parameter for pagination. Default: 0.
      * @param {number} [limit] - Optional parameter for pagination. Default: 30.
-     * @param {string} [type] - Optional parameter to filter discounts by type.
+     * @param {IDiscountType} [type] - Optional parameter to filter discounts by type.
      * @returns {Promise<IDiscountsResponse | IError>} Returns an object containing all discounts or an error object if there was an issue.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Fetches all discounts from the server.
      */
-    getAllDiscounts(langCode?: string, offset?: number, limit?: number, type?: 'DISCOUNT' | 'BONUS' | 'PERSONAL_DISCOUNT'): Promise<IDiscountsResponse | IError>;
+    getAllDiscounts(langCode?: string, offset?: number, limit?: number, type?: IDiscountType): Promise<IDiscountsResponse | IError>;
     /**
      * Get discount by marker
      * @handleName getDiscountByMarker
@@ -47,14 +47,14 @@ export default class DiscountsApi extends AsyncModules implements IDiscountsApi
     /**
      * Get bonus balance of the current user.
      * @handleName getBonusBalance
-     * @returns {Promise<IDiscountsEntity | IError>} Returns bonus balance or an error object.
+     * @returns {Promise<IBonusBalanceEntity | IError>} Returns bonus balance or an error object.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      */
-    getBonusBalance(): Promise<IDiscountsEntity | IError>;
+    getBonusBalance(): Promise<IBonusBalanceEntity | IError>;
     /**
      * Get bonus transaction history of the current user.
      * @handleName getBonusHistory
-     * @param {BonusTransactionType} [type] - Transaction type filter.
+     * @param {IBonusTransactionType} [type] - Transaction type filter.
      * @param {string} [dateFrom] - Start date filter.
      * @param {string} [dateTo] - End date filter.
      * @param {number} [discountId] - Discount id filter.
@@ -63,7 +63,7 @@ export default class DiscountsApi extends AsyncModules implements IDiscountsApi
      * @returns {Promise<IBonusTransactionEntity[] | IError>} Returns array of bonus transactions or an error object.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      */
-    getBonusHistory(type?: BonusTransactionType, dateFrom?: string, dateTo?: string, discountId?: number, moduleId?: number, isAdmin?: boolean): Promise<IBonusTransactionEntity[] | IError>;
+    getBonusHistory(type?: IBonusTransactionType, dateFrom?: string, dateTo?: string, discountId?: number, moduleId?: number, isAdmin?: boolean): Promise<IBonusTransactionEntity[] | IError>;
     /**
      * Validate discounts coupon
      * @handleName validateDiscountsCoupon

package/dist/discounts/discountsApi.js

@@ -31,7 +31,7 @@ class DiscountsApi extends asyncModules_1.default {
      * @param {string} [langCode] - Language code. Default: "en_US".
      * @param {number} [offset] - Optional parameter for pagination. Default: 0.
      * @param {number} [limit] - Optional parameter for pagination. Default: 30.
-     * @param {string} [type] - Optional parameter to filter discounts by type.
+     * @param {IDiscountType} [type] - Optional parameter to filter discounts by type.
      * @returns {Promise<IDiscountsResponse | IError>} Returns an object containing all discounts or an error object if there was an issue.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Fetches all discounts from the server.
@@ -66,7 +66,7 @@ class DiscountsApi extends asyncModules_1.default {
     /**
      * Get bonus balance of the current user.
      * @handleName getBonusBalance
-     * @returns {Promise<IDiscountsEntity | IError>} Returns bonus balance or an error object.
+     * @returns {Promise<IBonusBalanceEntity | IError>} Returns bonus balance or an error object.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      */
     async getBonusBalance() {
@@ -76,7 +76,7 @@ class DiscountsApi extends asyncModules_1.default {
     /**
      * Get bonus transaction history of the current user.
      * @handleName getBonusHistory
-     * @param {BonusTransactionType} [type] - Transaction type filter.
+     * @param {IBonusTransactionType} [type] - Transaction type filter.
      * @param {string} [dateFrom] - Start date filter.
      * @param {string} [dateTo] - End date filter.
      * @param {number} [discountId] - Discount id filter.

package/dist/discounts/discountsInterfaces.d.ts

@@ -1,4 +1,8 @@
 import type { IError } from '../base/utils';
+/**
+ * Discount type.
+ */
+type IDiscountType = 'DISCOUNT' | 'BONUS' | 'PERSONAL_DISCOUNT';
 /**
  * Interface for the Discounts API module.
  * @interface IDiscountsApi
@@ -10,12 +14,12 @@ interface IDiscountsApi {
      * @param {string} [langCode] - Language code. Default: "en_US".
      * @param {number} [offset] - Optional parameter for pagination. Default: 0.
      * @param {number} [limit] - Optional parameter for pagination. Default: 30.
-     * @param {string} [type] - Optional parameter to filter discounts by type.
+     * @param {IDiscountType} [type] - Optional parameter to filter discounts by type.
      * @returns {Promise<IDiscountsResponse | IError>} Returns an object containing all discounts or an error object if there was an issue.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Fetches all discounts from the server.
      */
-    getAllDiscounts(langCode?: string, offset?: number, limit?: number, type?: 'DISCOUNT' | 'BONUS' | 'PERSONAL_DISCOUNT'): Promise<IDiscountsResponse | IError>;
+    getAllDiscounts(langCode?: string, offset?: number, limit?: number, type?: IDiscountType): Promise<IDiscountsResponse | IError>;
     /**
      * Get discount by marker
      * @handleName getDiscountByMarker
@@ -38,10 +42,10 @@ interface IDiscountsApi {
     /**
      * Get bonus balance of the current user.
      * @handleName getBonusBalance
-     * @returns {Promise<IDiscountsEntity | IError>} Returns bonus balance or an error object.
+     * @returns {Promise<IBonusBalanceEntity | IError>} Returns bonus balance or an error object.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      */
-    getBonusBalance(): Promise<IDiscountsEntity | IError>;
+    getBonusBalance(): Promise<IBonusBalanceEntity | IError>;
     /**
      * Get bonus transaction history of the current user.
      * @handleName getBonusHistory
@@ -54,18 +58,18 @@ interface IDiscountsApi {
      * @returns {Promise<IBonusTransactionEntity[] | IError>} Returns array of bonus transactions or an error object.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      */
-    getBonusHistory(type?: BonusTransactionType, dateFrom?: string, dateTo?: string, discountId?: number, moduleId?: number, isAdmin?: boolean): Promise<IBonusTransactionEntity[] | IError>;
+    getBonusHistory(type?: IBonusTransactionType, dateFrom?: string, dateTo?: string, discountId?: number, moduleId?: number, isAdmin?: boolean): Promise<IBonusTransactionEntity[] | IError>;
 }
 /**
  * Query parameters for fetching discounts.
  * @interface IDiscountsQuery
- * @property {'DISCOUNT' | 'BONUS' | 'PERSONAL_DISCOUNT'} [type] - Filter discounts by type.
+ * @property {IDiscountType} [type] - Filter discounts by type.
  * @property {string} langCode - The language code for localization. Example: "en_US".
  * @property {number} [offset] - Offset for pagination. Default: 0.
  * @property {number} [limit] - Limit for pagination. Default: 30.
  */
 interface IDiscountsQuery {
-    type?: 'DISCOUNT' | 'BONUS' | 'PERSONAL_DISCOUNT';
+    type?: IDiscountType;
     langCode: string;
     offset?: number;
     limit?: number;
@@ -88,7 +92,7 @@ interface IDiscountCondition {
  * @property {object} [localizeInfos] - The name of the discount.
  * @property {number} [version] - The version of the discount.
  * @property {string} [identifier] - The identifier of the discount.
- * @property {string} [type] - The type of the discount.
+ * @property {IDiscountType} type - The type of the discount.
  * @property {string} [startDate] - The start date of the discount.
  * @property {string} [endDate] - The end date of the discount.
  * @property {Record<string, unknown>} [discountValue] - The value of the discount.
@@ -111,7 +115,7 @@ interface IDiscountsEntity {
     localizeInfos?: object;
     version?: number;
     identifier?: string;
-    type: 'DISCOUNT' | 'BONUS' | 'PERSONAL_DISCOUNT';
+    type: IDiscountType;
     startDate?: string;
     endDate?: string;
     discountValue?: Record<string, unknown>;
@@ -171,10 +175,10 @@ interface IDiscountByMarkerQuery {
 /**
  *
  */
-type BonusTransactionType = 'ACCRUAL' | 'USAGE' | 'REDUCE' | 'REVERSAL_ACCRUAL' | 'REVERSAL_USAGE' | 'EXPIRATION';
+type IBonusTransactionType = 'ACCRUAL' | 'USAGE' | 'REDUCE' | 'REVERSAL_ACCRUAL' | 'REVERSAL_USAGE' | 'EXPIRATION';
 /**
  * @interface IBonusHistoryQuery
- * @property {BonusTransactionType} [type] - Transaction type filter.
+ * @property {IBonusTransactionType} [type] - Transaction type filter.
  * @property {string} [dateFrom] - Start date filter.
  * @property {string} [dateTo] - End date filter.
  * @property {number} [discountId] - Discount id filter.
@@ -182,7 +186,7 @@ type BonusTransactionType = 'ACCRUAL' | 'USAGE' | 'REDUCE' | 'REVERSAL_ACCRUAL'
  * @property {boolean} [isAdmin] - Admin filter.
  */
 interface IBonusHistoryQuery {
-    type?: BonusTransactionType;
+    type?: IBonusTransactionType;
     dateFrom?: string;
     dateTo?: string;
     discountId?: number;
@@ -193,7 +197,7 @@ interface IBonusHistoryQuery {
  * @interface IBonusTransactionEntity
  * @property {number} balanceId - Balance id.
  * @property {number} amount - Transaction amount.
- * @property {BonusTransactionType} type - Transaction type.
+ * @property {IBonusTransactionType} type - Transaction type.
  * @property {number} [discountId] - Discount id.
  * @property {number} [moduleId] - Module id.
  * @property {string} [entityIdentifier] - Entity identifier.
@@ -207,7 +211,7 @@ interface IBonusHistoryQuery {
 interface IBonusTransactionEntity {
     balanceId: number;
     amount: number;
-    type: BonusTransactionType;
+    type: IBonusTransactionType;
     discountId?: number;
     moduleId?: number;
     entityIdentifier?: string;
@@ -218,4 +222,12 @@ interface IBonusTransactionEntity {
     expiresAt?: string;
     createdAt?: string;
 }
-export type { BonusTransactionType, IBonusHistoryQuery, IBonusTransactionEntity, ICouponValidationResult, IDiscountByMarkerQuery, IDiscountCondition, IDiscountsApi, IDiscountsEntity, IDiscountsQuery, IDiscountsResponse, IDiscountsValidateCoupon, };
+/**
+ * @interface IBonusBalanceEntity
+ * @description Represents the balance of bonus points.
+ * @property {number} balance - The balance of bonus points. Example: 100
+ */
+interface IBonusBalanceEntity {
+    balance: number;
+}
+export type { IBonusBalanceEntity, IBonusHistoryQuery, IBonusTransactionEntity, IBonusTransactionType, ICouponValidationResult, IDiscountByMarkerQuery, IDiscountCondition, IDiscountsApi, IDiscountsEntity, IDiscountsQuery, IDiscountsResponse, IDiscountsValidateCoupon, IDiscountType, };

package/dist/forms/formsInterfaces.d.ts

@@ -112,7 +112,7 @@ interface IFormsEntity {
  * @property {string[]} [nestedEntityIdentifiers] - An array of nested entity identifier strings (only in products/pages API). Example: ["catalog"].
  * @property {string[]} [exceptionIds] - An array of exception identifiers.
  * @property {number} [formDataCount] - Total count of form data entries (only in products/pages API). Example: 306.
- * @property {Record<string, number>} [entityFormDataCount] - Form data count per entity identifier (only in products/pages API). Example: {"catalog": 306}.
+ * @property {Record<string, number>} [entityFormDataCount] - Form data count per entity identifier (only in products/pages API). Example: `{"catalog": 306}`.
  * @property {boolean | null} [isRating] - Indicates whether this form config is for ratings. Example: null.
  * @property {boolean | null} [isAnonymous] - Indicates whether anonymous submissions are allowed. Example: null.
  * @property {boolean | null} [allowHalfRatings] - Indicates whether half ratings are allowed. Example: null.

package/dist/forms-data/formsDataInterfaces.d.ts

@@ -241,10 +241,9 @@ interface IFormsByMarkerDataEntity {
         "value": "Jack"
       }
     ]
- * @property {string | Record<string, string>} actionMessage - Action message for the form data (can be localized). Example: "Form submitted successfully" or { "en_US": "Success" }.
+ * @property {string} actionMessage - Action message for the form data (can be localized). Example: "Form submitted successfully".
  */
 interface IPostFormResponse {
-    actionMessage: string | Record<string, any>;
     formData: {
         id: number;
         formIdentifier: string;
@@ -257,6 +256,7 @@ interface IPostFormResponse {
         parentId: number | null;
         formData: FormDataType[] | Record<string, any>;
     };
+    actionMessage: string;
 }
 /**
  * Represents the structure of the response after updating form data.

package/dist/orders/ordersApi.d.ts

@@ -160,16 +160,16 @@ export default class OrdersApi extends AsyncModules implements IOrdersApi {
      * @handleName createRefundRequest
      * @param {number} id - Order id. Example: 1.
      * @param {ICreateRefundRequest} body - Refund request body.
-     * @returns {Promise<IOrdersEntity | IError>} Returns order entity.
+     * @returns {Promise<boolean | IError>} Returns true if the refund request was created successfully.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      */
-    createRefundRequest(id: number, body: ICreateRefundRequest): Promise<IOrdersEntity | IError>;
+    createRefundRequest(id: number, body: ICreateRefundRequest): Promise<boolean | IError>;
     /**
      * Cancel a refund request for an order.
      * @handleName cancelRefundRequest
      * @param {number} id - Order id. Example: 1.
-     * @returns {Promise<IOrdersEntity | IError>} Returns order entity.
+     * @returns {Promise<boolean | IError>} Returns true if the refund request was cancelled successfully.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      */
-    cancelRefundRequest(id: number): Promise<IOrdersEntity | IError>;
+    cancelRefundRequest(id: number): Promise<boolean | IError>;
 }

package/dist/orders/ordersApi.js

@@ -219,7 +219,7 @@ class OrdersApi extends asyncModules_1.default {
      * @handleName createRefundRequest
      * @param {number} id - Order id. Example: 1.
      * @param {ICreateRefundRequest} body - Refund request body.
-     * @returns {Promise<IOrdersEntity | IError>} Returns order entity.
+     * @returns {Promise<boolean | IError>} Returns true if the refund request was created successfully.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      */
     async createRefundRequest(id, body) {
@@ -233,7 +233,7 @@ class OrdersApi extends asyncModules_1.default {
      * Cancel a refund request for an order.
      * @handleName cancelRefundRequest
      * @param {number} id - Order id. Example: 1.
-     * @returns {Promise<IOrdersEntity | IError>} Returns order entity.
+     * @returns {Promise<boolean | IError>} Returns true if the refund request was cancelled successfully.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      */
     async cancelRefundRequest(id) {

package/dist/orders/ordersInterfaces.d.ts

@@ -146,18 +146,18 @@ interface IOrdersApi {
      * @handleName createRefundRequest
      * @param {number} id - Order id.
      * @param {ICreateRefundRequest} body - Refund request body.
-     * @returns {Promise<IOrdersEntity | IError>} Returns order entity.
+     * @returns {Promise<boolean | IError>} Returns true if the refund request was created successfully.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      */
-    createRefundRequest(id: number, body: ICreateRefundRequest): Promise<IOrdersEntity | IError>;
+    createRefundRequest(id: number, body: ICreateRefundRequest): Promise<boolean | IError>;
     /**
      * Cancel a refund request for an order.
      * @handleName cancelRefundRequest
      * @param {number} id - Order id.
-     * @returns {Promise<IOrdersEntity | IError>} Returns order entity.
+     * @returns {Promise<boolean | IError>} Returns order entity.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      */
-    cancelRefundRequest(id: number): Promise<IOrdersEntity | IError>;
+    cancelRefundRequest(id: number): Promise<boolean | IError>;
 }
 /**
  * Interface for the orders storage object.
@@ -585,11 +585,22 @@ interface IRefundRequest {
     orderStorage: unknown;
     user: unknown;
 }
+/**
+ * @interface IRefundProduct
+ * @description Refund details for a single product.
+ * @property {number} quantity - Quantity of the product to refund. Example: 1.
+ */
+interface IRefundProduct {
+    quantity: number;
+}
 /**
  * @interface ICreateRefundRequest
  * @description Body for creating a refund request.
+ * @property {Record<string, IRefundProduct>} products - Map of product id to refund details. Example: `{ "146": { "quantity": 1 } }`.
+ * @property {string} [note] - Optional note for the refund request. Example: "test".
  */
 interface ICreateRefundRequest {
-    [key: string]: unknown;
+    products: Record<string, IRefundProduct>;
+    note?: string;
 }
-export type { IBaseOrdersEntity, IBaseOrdersEntityResponse, ICreateOrderPreview, ICreateRefundRequest, IOrderByMarkerEntity, IOrderData, IOrderPreviewItem, IOrderPreviewResponse, IOrderProductData, IOrderProducts, IOrdersApi, IOrdersByMarkerEntity, IOrdersEntity, IOrdersFormData, IOrderStatus, IPaymentAccountIdentifiers, IPicture, IPreviewOrderProduct, IRefundRequest, };
+export type { IBaseOrdersEntity, IBaseOrdersEntityResponse, ICreateOrderPreview, ICreateRefundRequest, IOrderByMarkerEntity, IOrderData, IOrderPreviewItem, IOrderPreviewResponse, IOrderProductData, IOrderProducts, IOrdersApi, IOrdersByMarkerEntity, IOrdersEntity, IOrdersFormData, IOrderStatus, IPaymentAccountIdentifiers, IPicture, IPreviewOrderProduct, IRefundProduct, IRefundRequest, };

package/dist/payments/paymentsApi.d.ts

@@ -1,7 +1,7 @@
 import AsyncModules from '../base/asyncModules';
 import type StateModule from '../base/stateModule';
 import type { IError } from '../base/utils';
-import type { IAccountsEntity, ICreateSessionEntity, IPaymentsApi, ISessionEntity, ISessionsEntity } from './paymentsInterfaces';
+import type { IAccountsEntity, IPaymentsApi, ISessionEntity, ISessionsEntity } from './paymentsInterfaces';
 /**
  * Controllers for working with payments
  * @handle /api/content/payments
@@ -53,12 +53,12 @@ export default class PaymentsApi extends AsyncModules implements IPaymentsApi {
      * @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 {Promise<ICreateSessionEntity | IError>} Returns a single payment session object.
+     * @returns {Promise<ISessionEntity | IError>} Returns a single payment session object.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This method creates a payment session. This method requires user authorization.
      * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider authorization module}, see the documentation in the  {@link https://js-sdk.oneentry.cloud/docs/category/authprovider configuration settings section of the SDK}.
      */
-    createSession(orderId: number, type: 'session' | 'intent', automaticTaxEnabled?: boolean): Promise<ICreateSessionEntity | IError>;
+    createSession(orderId: number, type: 'session' | 'intent', automaticTaxEnabled?: boolean): Promise<ISessionEntity | IError>;
     /**
      * Get all payment accounts as an array.
      * @handleName getAccounts

package/dist/payments/paymentsApi.js

@@ -74,7 +74,7 @@ class PaymentsApi extends asyncModules_1.default {
      * @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 {Promise<ICreateSessionEntity | IError>} Returns a single payment session object.
+     * @returns {Promise<ISessionEntity | IError>} Returns a single payment session object.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This method creates a payment session. This method requires user authorization.
      * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider authorization module}, see the documentation in the  {@link https://js-sdk.oneentry.cloud/docs/category/authprovider configuration settings section of the SDK}.
@@ -86,7 +86,7 @@ class PaymentsApi extends asyncModules_1.default {
             automaticTaxEnabled,
         });
         // Validate response if validation is enabled
-        const validated = this._validateResponse(result, paymentsSchemas_1.CreateSessionResponseSchema);
+        const validated = this._validateResponse(result, paymentsSchemas_1.PaymentSessionSchema);
         return validated;
     }
     /**

package/dist/payments/paymentsInterfaces.d.ts

@@ -41,12 +41,12 @@ interface IPaymentsApi {
      * @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.
+     * @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 creates a payment session. This method requires user authorization.
      * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider authorization module}, see the documentation in the  {@link https://js-sdk.oneentry.cloud/docs/category/authprovider configuration settings section of the SDK}.
      */
-    createSession(orderId: number, type: 'session' | 'intent', automaticTaxEnabled?: boolean): Promise<ICreateSessionEntity | IError>;
+    createSession(orderId: number, type: 'session' | 'intent', automaticTaxEnabled?: boolean): Promise<ISessionEntity | IError>;
     /**
      * Get all payment accounts as an array.
      * @handleName getAccounts
@@ -101,6 +101,7 @@ interface ISessionsEntity {
  * @property {number} orderId - Order identifier. Example: 1.
  * @property {string | null} paymentUrl - payment link. Example: " https://www.sandbox.paypal.com/checkoutnow?token=9BE88048TU058770M".
  * @property {number | null} [amount] - Amount of the payment session. Example: 100.
+ * @property {string} [clientSecret] - Client secret key returned by payment provider (e.g. Stripe) when creating a session. Example: "pi_3MtwBwLkdIwHu7ix28a3tqPa_secret_YrKJUKribcBjcG8HVhfZluoGH".
  * @description This interface defines the structure of a session entity, including its quantity, amount, currency, name, and description.
  */
 interface ISessionEntity {
@@ -113,6 +114,7 @@ interface ISessionEntity {
     orderId: number;
     paymentUrl: string | null;
     amount?: number | null;
+    clientSecret?: string;
 }
 /**
  * @interface IIntent
@@ -124,44 +126,6 @@ interface IIntent {
     amount: number;
     currency: string;
 }
-/**
- * @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;
-    updatedDate: string;
-    type: 'session' | 'intent';
-    orderId: number;
-    paymentAccountId: number;
-    paymentUrl: string;
-    clientSecret: string;
-    status: string;
-}
-/**
- * @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;
-    updatedDate: string;
-    version: number;
-    identifier: string;
-    paymentUrl: string;
-}
 /**
  * @interface IAccountsEntity
  * @property {number} id - Object identifier. Example: 12345.
@@ -197,4 +161,4 @@ interface IAccountsEntity {
     };
     updatedDate: string;
 }
-export type { IAccountsEntity, ICreateSessionEntity, IIntent, IPaymentsApi, ISessionEntity, ISessionItem, ISessionsEntity, };
+export type { IAccountsEntity, IIntent, IPaymentsApi, ISessionEntity, ISessionsEntity, };

package/dist/payments/paymentsSchemas.d.ts

@@ -13,6 +13,7 @@ export declare const PaymentSessionSchema: z.ZodObject<{
     type: z.ZodString;
     paymentAccountId: z.ZodNumber;
     paymentUrl: z.ZodNullable<z.ZodString>;
+    clientSecret: z.ZodOptional<z.ZodString>;
 }, z.core.$strip>;
 /**
  * Payment sessions response schema
@@ -29,6 +30,7 @@ export declare const PaymentSessionsResponseSchema: z.ZodObject<{
         type: z.ZodString;
         paymentAccountId: z.ZodNumber;
         paymentUrl: z.ZodNullable<z.ZodString>;
+        clientSecret: z.ZodOptional<z.ZodString>;
     }, z.core.$strip>>;
     total: z.ZodNumber;
 }, z.core.$strip>;
@@ -46,6 +48,7 @@ export declare const SinglePaymentSessionSchema: z.ZodUnion<readonly [z.ZodObjec
     type: z.ZodString;
     paymentAccountId: z.ZodNumber;
     paymentUrl: z.ZodNullable<z.ZodString>;
+    clientSecret: z.ZodOptional<z.ZodString>;
 }, z.core.$strip>, z.ZodArray<z.ZodObject<{
     id: z.ZodNumber;
     orderId: z.ZodNumber;
@@ -56,6 +59,7 @@ export declare const SinglePaymentSessionSchema: z.ZodUnion<readonly [z.ZodObjec
     type: z.ZodString;
     paymentAccountId: z.ZodNumber;
     paymentUrl: z.ZodNullable<z.ZodString>;
+    clientSecret: z.ZodOptional<z.ZodString>;
 }, z.core.$strip>>]>;
 /**
  * Payment account schema
@@ -88,13 +92,3 @@ export declare const PaymentAccountsResponseSchema: z.ZodArray<z.ZodObject<{
     localizeInfos: z.ZodRecord<z.ZodString, z.ZodAny>;
     updatedDate: z.ZodString;
 }, z.core.$strip>>;
-/**
- * Create session response schema
- */
-export declare const CreateSessionResponseSchema: z.ZodObject<{
-    id: z.ZodNumber;
-    updatedDate: z.ZodString;
-    version: z.ZodNumber;
-    identifier: z.ZodString;
-    paymentUrl: z.ZodString;
-}, z.core.$strip>;

package/dist/payments/paymentsSchemas.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.CreateSessionResponseSchema = exports.PaymentAccountsResponseSchema = exports.PaymentAccountSchema = exports.SinglePaymentSessionSchema = exports.PaymentSessionsResponseSchema = exports.PaymentSessionSchema = void 0;
+exports.PaymentAccountsResponseSchema = exports.PaymentAccountSchema = exports.SinglePaymentSessionSchema = exports.PaymentSessionsResponseSchema = exports.PaymentSessionSchema = void 0;
 const zod_1 = require("zod");
 /**
  * Payment session schema
@@ -16,6 +16,7 @@ exports.PaymentSessionSchema = zod_1.z.object({
     type: zod_1.z.string(),
     paymentAccountId: zod_1.z.number(),
     paymentUrl: zod_1.z.string().nullable(),
+    clientSecret: zod_1.z.string().optional(),
 });
 /**
  * Payment sessions response schema
@@ -53,13 +54,3 @@ exports.PaymentAccountSchema = zod_1.z.object({
  * Payment accounts response schema
  */
 exports.PaymentAccountsResponseSchema = zod_1.z.array(exports.PaymentAccountSchema);
-/**
- * Create session response schema
- */
-exports.CreateSessionResponseSchema = zod_1.z.object({
-    id: zod_1.z.number(),
-    updatedDate: zod_1.z.string(),
-    version: zod_1.z.number(),
-    identifier: zod_1.z.string(),
-    paymentUrl: zod_1.z.string(),
-});

package/dist/sitemap/sitemapApi.d.ts

@@ -1,7 +1,7 @@
 import AsyncModules from '../base/asyncModules';
 import type StateModule from '../base/stateModule';
 import type { IError } from '../base/utils';
-import type { ISitemapApi, ISitemapEntity, ISitemapQuery } from './sitemapInterfaces';
+import type { ISitemapApi, ISitemapEntity } from './sitemapInterfaces';
 /**
  * Controllers for working with sitemaps.
  * @handle /api/content/sitemap
@@ -23,13 +23,13 @@ export default class SitemapApi extends AsyncModules implements ISitemapApi {
      * @returns {Promise<string[] | IError>} Returns an array of sitemap URLs.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      */
-    getSitemap(): Promise<ISitemapEntity[] | IError>;
+    getSitemap(): Promise<string[] | IError>;
     /**
      * Generates a new set of sitemaps.
      * @handleName updateSitemap
-     * @param {ISitemapQuery} body - Sitemap body params.
+     * @param {Array<ISitemapEntity>} body - Sitemap body params.
      * @returns {Promise<string[] | IError>} Returns an array of sitemap URLs.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      */
-    updateSitemap(body: ISitemapQuery): Promise<ISitemapEntity[] | IError>;
+    updateSitemap(body: Array<ISitemapEntity>): Promise<Array<ISitemapEntity> | IError>;
 }

package/dist/sitemap/sitemapApi.js

@@ -33,7 +33,7 @@ class SitemapApi extends asyncModules_1.default {
     /**
      * Generates a new set of sitemaps.
      * @handleName updateSitemap
-     * @param {ISitemapQuery} body - Sitemap body params.
+     * @param {Array<ISitemapEntity>} body - Sitemap body params.
      * @returns {Promise<string[] | IError>} Returns an array of sitemap URLs.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      */

package/dist/sitemap/sitemapInterfaces.d.ts

@@ -1,40 +1,49 @@
 import type { IError } from '../base/utils';
+/**
+ * Interface for the Sitemap API module.
+ * @interface ISitemapApi
+ */
+interface ISitemapApi {
+    /**
+     * Retrieves the set of sitemaps.
+     * @handleName getSitemap
+     * @returns {Promise<Array<string> | IError>}
+     */
+    getSitemap(): Promise<Array<string> | IError>;
+    /**
+     * Generates a new set of sitemaps.
+     * @handleName updateSitemap
+     * @param {Array<ISitemapQuery>} body - Sitemap body params.
+     * @returns {Promise<Array<ISitemapEntity> | IError>}
+     */
+    updateSitemap(body: Array<ISitemapQuery>): Promise<Array<ISitemapEntity> | IError>;
+}
 /**
  * Query parameters for sitemap requests.
  * @interface ISitemapQuery
+ * @property {string} url - URL of the sitemap entry.
+ * @property {string} lastmod - Last modification date.
+ * @property {string} changefreq - Frequency of changes.
+ * @property {number} priority - Priority of the entry.
  */
 interface ISitemapQuery {
-    [key: string]: unknown;
+    url: string;
+    lastmod: string;
+    changefreq: string;
+    priority: number;
 }
 /**
  * Entity interface for sitemap.
+ * @interface ISitemapEntity
  * @property {string} url - URL of the sitemap.
  * @property {string} lastmod - Last modification date of the sitemap.
  * @property {string} changefreq - Frequency of changes for the sitemap.
- * @property {string} priority - Priority of the sitemap.
- * @interface ISitemapEntity
+ * @property {number} priority - Priority of the sitemap.
  */
 interface ISitemapEntity {
     url: string;
     lastmod: string;
     changefreq: string;
-    priority: string;
-}
-/**
- * Interface for the Sitemap API module.
- * @interface ISitemapApi
- */
-interface ISitemapApi {
-    /**
-     * Retrieves the set of sitemaps.
-     * @returns {Promise<ISitemapEntity[] | IError>}
-     */
-    getSitemap(): Promise<ISitemapEntity[] | IError>;
-    /**
-     * Generates a new set of sitemaps.
-     * @param {ISitemapQuery} body - Sitemap body params.
-     * @returns {Promise<ISitemapEntity[] | IError>}
-     */
-    updateSitemap(body: ISitemapQuery): Promise<ISitemapEntity[] | IError>;
+    priority: number;
 }
 export type { ISitemapApi, ISitemapEntity, ISitemapQuery };

package/dist/users/usersInterfaces.d.ts

@@ -1,5 +1,5 @@
 import type { IAuthData, IAuthFormData } from '../auth-provider/authProvidersInterfaces';
-import type { IError } from '../base/utils';
+import type { IError, IRating } from '../base/utils';
 import type { IFormConfig } from '../forms/formsInterfaces';
 import type { FormDataType } from '../forms-data/formsDataInterfaces';
 /**
@@ -161,7 +161,7 @@ interface IUsersApi {
       "key": "value"
     }
  * @property {Array<IFormConfig>} [moduleFormConfigs] - Optional array of form configuration objects associated with the user.
- * @property {Record<string, unknown>} [rating] - Rating data.
+ * @property {IRating} [rating] - Rating data.
  * @description Represents a user entity with various properties, including identifiers, form data, and user groups.
  */
 interface IUserEntity {
@@ -174,7 +174,7 @@ interface IUserEntity {
     groups: Array<string | number>;
     state: Record<string, any>;
     moduleFormConfigs?: Array<IFormConfig>;
-    rating?: Record<string, unknown>;
+    rating?: IRating;
 }
 /**
  * @interface IUserBody

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "oneentry",
-  "version": "1.0.145",
+  "version": "1.0.146",
   "description": "OneEntry NPM package",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -10,7 +10,7 @@
   "bin": {
     "oneentry": "./configure.js"
   },
-  "author": "ONEENTRY PORTAL CO.",
+  "author": "ONEENTRY PORTAL LLC",
   "license": "ISC",
   "dependencies": {
     "socket.io-client": "^4.8.3",