oneentry 1.0.159 → 1.0.161

package/esm/discounts/discountsApi.d.ts

@@ -0,0 +1,94 @@
+import AsyncModules from '../base/asyncModules.js';
+import type StateModule from '../base/stateModule.js';
+import type { IError } from '../base/utils.js';
+import type { IBonusBalanceEntity, IBonusTransactionEntity, IBonusTransactionType, ICouponValidationResult, IDiscountsApi, IDiscountsEntity, IDiscountsResponse, IDiscountsVectorSearch, IDiscountType } from './discountsInterfaces.js';
+/**
+ * Controllers for working with events
+ * @handle /api/content/events
+ * @class DiscountsApi
+ * @augments AsyncModules
+ * @implements {IDiscountsApi}
+ * @description This class provides methods to interact with events, including subscribing and unsubscribing to product events, and retrieving all subscriptions.
+ */
+export default class DiscountsApi extends AsyncModules implements IDiscountsApi {
+    protected state: StateModule;
+    protected _url: string;
+    /**
+     * Initializes the Constructor for DiscountsApi class with the provided state module.
+     * @class DiscountsApi
+     * @augments AsyncModules
+     * @implements {DiscountsApi}
+     * @param {StateModule} state - The state module containing the base URL and other configurations.
+     * @description Initializes the DiscountsApi with the provided state module.
+     */
+    constructor(state: StateModule);
+    /**
+     * Return all discounts.
+     * @handleName getAllDiscounts
+     * @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 {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.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/discounts/getAllDiscounts getAllDiscounts} documentation.
+     */
+    getAllDiscounts(langCode?: string, offset?: number, limit?: number, type?: IDiscountType): Promise<IDiscountsResponse | IError>;
+    /**
+     * Get discount by marker
+     * @handleName getDiscountByMarker
+     * @param {string} marker - Textual identifier of the discount storage object. Example: "discount_storage".
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @returns {Promise<IDiscountsEntity | IError>} Returns an object containing discount by marker or an error object if there was an issue.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description Fetches a discount by its marker.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/discounts/getDiscountByMarker getDiscountByMarker} documentation.
+     */
+    getDiscountByMarker(marker: string, langCode?: string): Promise<IDiscountsEntity | IError>;
+    /**
+     * Get bonus balance of the current user.
+     * @handleName getBonusBalance
+     * @returns {Promise<IBonusBalanceEntity | IError>} Returns bonus balance or an error object.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @see {@link https://js-sdk.oneentry.cloud/docs/discounts/getBonusBalance getBonusBalance} documentation.
+     */
+    getBonusBalance(): Promise<IBonusBalanceEntity | IError>;
+    /**
+     * Get bonus transaction history of the current user.
+     * @handleName getBonusHistory
+     * @param {IBonusTransactionType} [type] - Transaction type filter.
+     * @param {string} [dateFrom] - Start date filter.
+     * @param {string} [dateTo] - End date filter.
+     * @param {number} [discountId] - Discount id filter.
+     * @param {number} [moduleId] - Module id filter.
+     * @param {boolean} [isAdmin] - Admin filter.
+     * @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
+     * @see {@link https://js-sdk.oneentry.cloud/docs/discounts/getBonusHistory getBonusHistory} documentation.
+     */
+    getBonusHistory(type?: IBonusTransactionType, dateFrom?: string, dateTo?: string, discountId?: number, moduleId?: number, isAdmin?: boolean): Promise<IBonusTransactionEntity[] | IError>;
+    /**
+     * Validate discounts coupon
+     * @handleName validateDiscountsCoupon
+     * @param {string} code - The coupon code to validate.
+     * @returns {Promise<ICouponValidationResult | IError>} Returns an coupon validation result or an error object if there was an issue.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description This function validates a coupon code and returns the result.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/discounts/validateDiscountsCoupon validateDiscountsCoupon} documentation.
+     */
+    validateDiscountsCoupon(code: string): Promise<ICouponValidationResult | IError>;
+    /**
+     * Semantic (vector) search for discounts.
+     * @handleName getDiscountsByVectorSearch
+     * @param {IDiscountsVectorSearch} body - Vector search body. Example: `{ queryText: "winter sale" }`.
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @param {number} [offset] - Parameter for pagination. Default: 0.
+     * @param {number} [limit] - Parameter for pagination. Default: 30.
+     * @returns {Promise<IDiscountsResponse | IError>} Returns an object with an array of found discounts and total count.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description This method performs a semantic (vector) search for discounts.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/discounts/getDiscountsByVectorSearch getDiscountsByVectorSearch} documentation.
+     */
+    getDiscountsByVectorSearch(body: IDiscountsVectorSearch, langCode?: string, offset?: number, limit?: number): Promise<IDiscountsResponse | IError>;
+}

package/esm/discounts/discountsApi.js

@@ -0,0 +1,136 @@
+import AsyncModules from '../base/asyncModules.js';
+/**
+ * Controllers for working with events
+ * @handle /api/content/events
+ * @class DiscountsApi
+ * @augments AsyncModules
+ * @implements {IDiscountsApi}
+ * @description This class provides methods to interact with events, including subscribing and unsubscribing to product events, and retrieving all subscriptions.
+ */
+export default class DiscountsApi extends AsyncModules {
+    /**
+     * Initializes the Constructor for DiscountsApi class with the provided state module.
+     * @class DiscountsApi
+     * @augments AsyncModules
+     * @implements {DiscountsApi}
+     * @param {StateModule} state - The state module containing the base URL and other configurations.
+     * @description Initializes the DiscountsApi with the provided state module.
+     */
+    constructor(state) {
+        super(state);
+        this._url = state.url + '/api/content/discounts';
+    }
+    /**
+     * Return all discounts.
+     * @handleName getAllDiscounts
+     * @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 {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.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/discounts/getAllDiscounts getAllDiscounts} documentation.
+     */
+    async getAllDiscounts(langCode = this.state.lang, offset = 0, limit = 30, type) {
+        const query = {
+            langCode,
+            offset,
+            limit,
+            type,
+        };
+        const data = await this._fetchGet(`?` + this._queryParamsToString(query));
+        return this._normalizeData(data);
+    }
+    /**
+     * Get discount by marker
+     * @handleName getDiscountByMarker
+     * @param {string} marker - Textual identifier of the discount storage object. Example: "discount_storage".
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @returns {Promise<IDiscountsEntity | IError>} Returns an object containing discount by marker or an error object if there was an issue.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description Fetches a discount by its marker.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/discounts/getDiscountByMarker getDiscountByMarker} documentation.
+     */
+    async getDiscountByMarker(marker, langCode = this.state.lang) {
+        const query = {
+            marker: '',
+            langCode,
+        };
+        const data = await this._fetchGet(`/marker/${marker}?` + this._queryParamsToString(query));
+        return this._normalizeData(data);
+    }
+    /**
+     * Get bonus balance of the current user.
+     * @handleName getBonusBalance
+     * @returns {Promise<IBonusBalanceEntity | IError>} Returns bonus balance or an error object.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @see {@link https://js-sdk.oneentry.cloud/docs/discounts/getBonusBalance getBonusBalance} documentation.
+     */
+    async getBonusBalance() {
+        const data = await this._fetchGet(`/bonus-balance`);
+        return this._normalizeData(data);
+    }
+    /**
+     * Get bonus transaction history of the current user.
+     * @handleName getBonusHistory
+     * @param {IBonusTransactionType} [type] - Transaction type filter.
+     * @param {string} [dateFrom] - Start date filter.
+     * @param {string} [dateTo] - End date filter.
+     * @param {number} [discountId] - Discount id filter.
+     * @param {number} [moduleId] - Module id filter.
+     * @param {boolean} [isAdmin] - Admin filter.
+     * @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
+     * @see {@link https://js-sdk.oneentry.cloud/docs/discounts/getBonusHistory getBonusHistory} documentation.
+     */
+    async getBonusHistory(type, dateFrom, dateTo, discountId, moduleId, isAdmin) {
+        const query = {
+            type,
+            dateFrom,
+            dateTo,
+            discountId,
+            moduleId,
+            isAdmin,
+        };
+        const data = await this._fetchGet(`/bonus-balance/history?` + this._queryParamsToString(query));
+        return this._normalizeData(data);
+    }
+    /**
+     * Validate discounts coupon
+     * @handleName validateDiscountsCoupon
+     * @param {string} code - The coupon code to validate.
+     * @returns {Promise<ICouponValidationResult | IError>} Returns an coupon validation result or an error object if there was an issue.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description This function validates a coupon code and returns the result.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/discounts/validateDiscountsCoupon validateDiscountsCoupon} documentation.
+     */
+    async validateDiscountsCoupon(code) {
+        const query = {
+            code,
+        };
+        const data = await this._fetchGet(`/coupons/validate?` + this._queryParamsToString(query));
+        return this._normalizeData(data);
+    }
+    /**
+     * Semantic (vector) search for discounts.
+     * @handleName getDiscountsByVectorSearch
+     * @param {IDiscountsVectorSearch} body - Vector search body. Example: `{ queryText: "winter sale" }`.
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @param {number} [offset] - Parameter for pagination. Default: 0.
+     * @param {number} [limit] - Parameter for pagination. Default: 30.
+     * @returns {Promise<IDiscountsResponse | IError>} Returns an object with an array of found discounts and total count.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description This method performs a semantic (vector) search for discounts.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/discounts/getDiscountsByVectorSearch getDiscountsByVectorSearch} documentation.
+     */
+    async getDiscountsByVectorSearch(body, langCode = this.state.lang, offset = 0, limit = 30) {
+        const query = {
+            langCode,
+            offset,
+            limit,
+        };
+        const data = await this._fetchPost(`/vector/search?` + this._queryParamsToString(query), body);
+        return this._normalizeData(data, langCode);
+    }
+}

package/esm/discounts/discountsInterfaces.d.ts

@@ -0,0 +1,293 @@
+import type { IAttributeValues, IError, ILocalizeInfo } from '../base/utils.js';
+/**
+ * Discount type.
+ */
+type IDiscountType = 'DISCOUNT' | 'BONUS' | 'PERSONAL_DISCOUNT';
+/**
+ * Interface for the Discounts API module.
+ * @interface IDiscountsApi
+ */
+interface IDiscountsApi {
+    /**
+     * Return all discounts.
+     * @handleName getAllSubscriptions
+     * @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 {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?: IDiscountType): Promise<IDiscountsResponse | IError>;
+    /**
+     * Get discount by marker
+     * @handleName getDiscountByMarker
+     * @param {string} marker - Textual identifier of the discount storage object. Example: "discount_storage".
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @returns {Promise<IDiscountsEntity | IError>} Returns an object containing discount by marker or an error object if there was an issue.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description Fetches a discount by its marker.
+     */
+    getDiscountByMarker(marker: string, langCode: string): Promise<IDiscountsEntity | IError>;
+    /**
+     * Validate discounts coupon
+     * @handleName validateDiscountsCoupon
+     * @param {string} code - The coupon code to validate.
+     * @returns {Promise<ICouponValidationResult | IError>} Returns an coupon validation result or an error object if there was an issue.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description This function validates a coupon code and returns the result.
+     */
+    validateDiscountsCoupon(code: string): Promise<ICouponValidationResult | IError>;
+    /**
+     * Get bonus balance of the current user.
+     * @handleName getBonusBalance
+     * @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<IBonusBalanceEntity | IError>;
+    /**
+     * Get bonus transaction history of the current user.
+     * @handleName getBonusHistory
+     * @param {string} [type] - Transaction type filter.
+     * @param {string} [dateFrom] - Start date filter.
+     * @param {string} [dateTo] - End date filter.
+     * @param {number} [discountId] - Discount id filter.
+     * @param {number} [moduleId] - Module id filter.
+     * @param {boolean} [isAdmin] - Admin filter.
+     * @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?: IBonusTransactionType, dateFrom?: string, dateTo?: string, discountId?: number, moduleId?: number, isAdmin?: boolean): Promise<IBonusTransactionEntity[] | IError>;
+    /**
+     * Semantic (vector) search for discounts.
+     * @handleName getDiscountsByVectorSearch
+     * @param {IDiscountsVectorSearch} body - Vector search body. Example: `{ queryText: "winter sale" }`.
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @param {number} [offset] - Parameter for pagination. Default: 0.
+     * @param {number} [limit] - Parameter for pagination. Default: 30.
+     * @returns {Promise<IDiscountsResponse | IError>} Returns an object with an array of found discounts and total count.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     */
+    getDiscountsByVectorSearch(body: IDiscountsVectorSearch, langCode?: string, offset?: number, limit?: number): Promise<IDiscountsResponse | IError>;
+}
+/**
+ * Body for semantic (vector) discount search.
+ * @interface IDiscountsVectorSearch
+ * @property {string} queryText - Natural-language search query. Example: "winter sale".
+ * @property {number} [vectorDistanceThreshold] - Override of the cosine distance threshold (0..2). Example: 0.3.
+ * @property {number} [maxHits] - Top-K candidates fetched before pagination. Default: 100. Max: 500. Example: 10.
+ * @property {boolean} [debug] - When true, each returned item gets a `distance` field. Example: false.
+ * @description Body for the discounts vector/search endpoint.
+ */
+interface IDiscountsVectorSearch {
+    queryText: string;
+    vectorDistanceThreshold?: number;
+    maxHits?: number;
+    debug?: boolean;
+}
+/**
+ * Query parameters for fetching discounts.
+ * @interface IDiscountsQuery
+ * @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?: IDiscountType;
+    langCode: string;
+    offset?: number;
+    limit?: number;
+}
+/**
+ * Represents a discount condition.
+ * @interface IDiscountCondition
+ * @property {string} type - The type of discount condition.
+ * @property {string} [value] - The value associated with the discount condition.
+ */
+interface IDiscountCondition {
+    type: 'PRODUCT' | 'CATEGORY' | 'ATTRIBUTE' | 'PRODUCT_IN_CART' | 'CATEGORY_IN_CART' | 'MIN_CART_AMOUNT' | 'USER_LTV' | 'USER_ATTRIBUTE';
+    value: string;
+}
+/**
+ * Represents a discount entity.
+ * @interface IDiscountsEntity
+ * @property {number} id - The unique identifier of the discount.
+ * @property {number | null} [attributeSetId] - The identifier of the attribute set linked to the discount, or `null` when no set is linked.
+ * @property {ILocalizeInfo} [localizeInfos] - The name of the discount.
+ * @property {number} [version] - The version of the discount.
+ * @property {string} [identifier] - The identifier 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 {IDiscountValue} [discountValue] - The value of the discount, including its type and amount limits.
+ * @property {string} [conditionLogic] - The logic of the discount. Possible values are "AND" | "OR".
+ * @property {IDiscountCondition[]} [conditions] - The conditions of the discount.
+ * @property {Record<string, unknown> | null} [exclusions] - The exclusions of the discount.
+ * @property {Record<string, unknown> | null} [gifts] - The gifts of the discount.
+ * @property {boolean} [giftsReplaceCartItems] - Whether the gifts replace cart items.
+ * @property {Record<string, unknown> | null} [userGroups] - The user groups of the discount.
+ * @property {Record<string, unknown> | null} [userExclusions] - The user exclusions of the discount.
+ * @property {IAttributeValues} [attributeValues] - The attribute values of the discount.
+ * @property {string} [attributeSetIdentifier] - The identifier of the attribute set.
+ * @property {Record<string, unknown>} [bonusEvent] - Bonus event configuration.
+ * @property {number} [position] - Position number for sorting. Example: 1.
+ * @property {number | string} [total] - Total count of related entries. Example: "1".
+ */
+interface IDiscountsEntity {
+    id: number;
+    attributeSetId?: number | null;
+    localizeInfos?: ILocalizeInfo;
+    version?: number;
+    identifier?: string;
+    type: IDiscountType;
+    startDate?: string;
+    endDate?: string;
+    discountValue?: IDiscountValue;
+    conditionLogic?: 'AND' | 'OR';
+    conditions?: IDiscountCondition[];
+    exclusions?: Record<string, unknown> | null;
+    gifts?: Record<string, unknown> | null;
+    giftsReplaceCartItems?: boolean;
+    userGroups?: Record<string, unknown> | null;
+    userExclusions?: Record<string, unknown> | null;
+    attributeValues?: IAttributeValues;
+    attributeSetIdentifier?: string;
+    bonusEvent?: Record<string, unknown> | null;
+    position?: number;
+    total?: number | string;
+}
+/**
+ * @interface IDiscountValue
+ * @property {'TO_PRODUCT' | 'TO_ORDER'} applicability - What the discount applies to. Example: "TO_PRODUCT".
+ * @property {'FIXED_AMOUNT' | 'PERCENT'} discountType - How the discount value is interpreted. Example: "FIXED_AMOUNT".
+ * @property {number} value - Discount amount (currency units for FIXED_AMOUNT, percentage points for PERCENT). Example: 10.
+ * @property {number | null} [maxAmount] - Cap on the absolute discount applied, or `null` when uncapped. Example: 5.
+ * @description Configuration of the discount calculation.
+ */
+interface IDiscountValue {
+    applicability: 'TO_PRODUCT' | 'TO_ORDER';
+    discountType: 'FIXED_AMOUNT' | 'PERCENT';
+    value: number;
+    maxAmount?: number | null;
+}
+/**
+ * @interface ICouponEntity
+ * @property {number} id - Coupon record id. Example: 1.
+ * @property {number} discountId - Discount the coupon belongs to. Example: 1.
+ * @property {string} code - Coupon code. Example: "SUMMER-KBWZ-2428".
+ * @property {boolean} isReusable - Whether the coupon can be used more than once. Example: false.
+ * @property {boolean} isUsed - Whether the coupon has already been used. Example: false.
+ * @property {number | null} orderId - Order id where the coupon was applied, or null. Example: null.
+ * @property {string | null} usedAt - When the coupon was used, or null. Example: null.
+ * @description Coupon entity returned by the discounts API.
+ */
+interface ICouponEntity {
+    id: number;
+    discountId: number;
+    code: string;
+    isReusable: boolean;
+    isUsed: boolean;
+    orderId: number | null;
+    usedAt: string | null;
+}
+/**
+ * Paginated response for discounts list.
+ * @interface IDiscountsResponse
+ * @property {IDiscountsEntity[]} items - Array of discount entities.
+ * @property {number} total - Total number of discounts.
+ */
+interface IDiscountsResponse {
+    items: IDiscountsEntity[];
+    total: number;
+}
+/**
+ * Request body for coupon validation.
+ * @interface IDiscountsValidateCoupon
+ * @property {string} code - The coupon code to validate.
+ */
+interface IDiscountsValidateCoupon {
+    code: string;
+}
+/**
+ * Result of coupon validation.
+ * @interface ICouponValidationResult
+ * @property {boolean} valid - Whether the coupon is valid.
+ * @property {ICouponEntity} [coupon] - Coupon data if the coupon is valid.
+ * @property {string} [error] - Error message if the coupon is invalid.
+ */
+interface ICouponValidationResult {
+    valid: boolean;
+    coupon?: ICouponEntity;
+    error?: string;
+}
+/**
+ * Query parameters for fetching a discount by marker.
+ * @interface IDiscountByMarkerQuery
+ * @property {string} langCode - The language code for localization. Example: "en_US".
+ * @property {string} marker - Textual identifier of the discount. Example: "example_discount".
+ */
+interface IDiscountByMarkerQuery {
+    langCode: string;
+    marker: string;
+}
+/**
+ *
+ */
+type IBonusTransactionType = 'ACCRUAL' | 'USAGE' | 'REDUCE' | 'REVERSAL_ACCRUAL' | 'REVERSAL_USAGE' | 'EXPIRATION';
+/**
+ * @interface IBonusHistoryQuery
+ * @property {IBonusTransactionType} [type] - Transaction type filter.
+ * @property {string} [dateFrom] - Start date filter.
+ * @property {string} [dateTo] - End date filter.
+ * @property {number} [discountId] - Discount id filter.
+ * @property {number} [moduleId] - Module id filter.
+ * @property {boolean} [isAdmin] - Admin filter.
+ */
+interface IBonusHistoryQuery {
+    type?: IBonusTransactionType;
+    dateFrom?: string;
+    dateTo?: string;
+    discountId?: number;
+    moduleId?: number;
+    isAdmin?: boolean;
+}
+/**
+ * @interface IBonusTransactionEntity
+ * @property {number} balanceId - Balance id.
+ * @property {number} amount - Transaction amount.
+ * @property {IBonusTransactionType} type - Transaction type.
+ * @property {number} [discountId] - Discount id.
+ * @property {number} [moduleId] - Module id.
+ * @property {string} [entityIdentifier] - Entity identifier.
+ * @property {string} [comment] - Comment.
+ * @property {boolean} isAdmin - Admin flag.
+ * @property {number} [remainingAmount] - Remaining amount.
+ * @property {'EVENT' | 'SCHEDULED'} [triggerType] - Trigger type.
+ * @property {string} [expiresAt] - Expiration date.
+ * @property {string} [createdAt] - Creation date.
+ */
+interface IBonusTransactionEntity {
+    balanceId: number;
+    amount: number;
+    type: IBonusTransactionType;
+    discountId?: number;
+    moduleId?: number;
+    entityIdentifier?: string;
+    comment?: string;
+    isAdmin: boolean;
+    remainingAmount?: number;
+    triggerType?: 'EVENT' | 'SCHEDULED';
+    expiresAt?: string;
+    createdAt?: string;
+}
+/**
+ * @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, ICouponEntity, ICouponValidationResult, IDiscountByMarkerQuery, IDiscountCondition, IDiscountsApi, IDiscountsEntity, IDiscountsQuery, IDiscountsResponse, IDiscountsValidateCoupon, IDiscountsVectorSearch, IDiscountType, IDiscountValue, };

package/esm/discounts/discountsInterfaces.js

@@ -0,0 +1 @@
+export {};

package/esm/events/eventsApi.d.ts

@@ -0,0 +1,108 @@
+import AsyncModules from '../base/asyncModules.js';
+import type StateModule from '../base/stateModule.js';
+import type { IError } from '../base/utils.js';
+import type { IContentApiEvent, IEvents, IFormSubscriptionsResponse, ISubscribeFormEvent, ISubscriptions } from './eventsInterfaces.js';
+/**
+ * Controllers for working with events
+ * @handle /api/content/events
+ * @class EventsApi
+ * @augments AsyncModules
+ * @implements {IEvents}
+ * @description This class provides methods to interact with events, including subscribing and unsubscribing to product events, and retrieving all subscriptions.
+ */
+export default class EventsApi extends AsyncModules implements IEvents {
+    protected state: StateModule;
+    protected _url: string;
+    /**
+     * Initializes the EventsApi with the provided state module.
+     * @class EventsApi
+     * @augments AsyncModules
+     * @implements {IEvents}
+     * @param {StateModule} state - The state module containing the base URL and other configurations.
+     * @description Initializes the EventsApi with the provided state module.
+     */
+    constructor(state: StateModule);
+    /**
+     * Return all subscriptions to product.
+     * @handleName getAllSubscriptions
+     * @param {number} [offset] - Optional offset for pagination. Default: 0.
+     * @param {number} [limit] - Optional limit for pagination. Default: 30.
+     * @returns {Promise<ISubscriptions | IError>} Returns an object containing all subscriptions or an error object if there was an issue.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description 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}.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/events/getAllSubscriptions getAllSubscriptions} documentation.
+     */
+    getAllSubscriptions(offset?: number, limit?: number): Promise<ISubscriptions | IError>;
+    /**
+     * Subscribing to an event on a product.
+     * @handleName subscribeByMarker
+     * @param {string} marker - Event marker. Example: "product_price_change".
+     * @param {number} productId - Product id. Example: 12345.
+     * @param {string} [langCode] - Language code. Default: "en_US".=
+     * @returns {Promise<boolean | IError>} Returns true if subscription was successful, or an error object if there was an issue.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description 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}.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/events/subscribeByMarker subscribeByMarker} documentation.
+     */
+    subscribeByMarker(marker: string, productId: number, langCode?: string): Promise<boolean | IError>;
+    /**
+     * Unsubscribing to an event on a product.
+     * @handleName unsubscribeByMarker
+     * @param {string} marker - The marker of the event to unsubscribe from. Example: "product_price_change".
+     * @param {number} productId - The ID of the product to unsubscribe from. Example: 12345.
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @returns {Promise<any | IError>} - Returns a promise that resolves to the result of the unsubscription operation or an error object if there was an issue.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description 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}.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/events/unsubscribeByMarker unsubscribeByMarker} documentation.
+     */
+    unsubscribeByMarker(marker: string, productId: number, langCode?: string): Promise<boolean | IError>;
+    /**
+     * Returns all available events.
+     * @handleName getAllEvents
+     * @returns {Promise<IContentApiEvent[] | IError>} Returns an array of available events.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description This method returns all available events.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/events/getAllEvents getAllEvents} documentation.
+     */
+    getAllEvents(): Promise<IContentApiEvent[] | IError>;
+    /**
+     * Subscribe to a form event by marker.
+     * @handleName subscribeToForm
+     * @param {string} marker - Event marker. Example: "form_marker".
+     * @param {ISubscribeFormEvent} body - Subscription body. Example: `{ formDataId: 123 }`.
+     * @returns {Promise<boolean | IError>} Returns true if the subscription was successful, or an error object.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description 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}.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/events/subscribeToForm subscribeToForm} documentation.
+     */
+    subscribeToForm(marker: string, body: ISubscribeFormEvent): Promise<boolean | IError>;
+    /**
+     * Returns all form subscriptions.
+     * @handleName getFormSubscriptions
+     * @param {number} [offset] - Optional offset for pagination. Default: 0.
+     * @param {number} [limit] - Optional limit for pagination. Default: 30.
+     * @returns {Promise<IFormSubscriptionsResponse | IError>} Returns an object with an array of form subscriptions and total count.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description 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}.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/events/getFormSubscriptions getFormSubscriptions} documentation.
+     */
+    getFormSubscriptions(offset?: number, limit?: number): Promise<IFormSubscriptionsResponse | IError>;
+    /**
+     * Unsubscribe from form notifications by marker.
+     * @handleName unsubscribeFromForm
+     * @param {string} marker - Event marker. Example: "form_marker".
+     * @param {ISubscribeFormEvent} body - Subscription body. Example: `{ formDataId: 123 }`.
+     * @returns {Promise<boolean | IError>} Returns true if the unsubscription was successful, or an error object.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description 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}.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/events/unsubscribeFromForm unsubscribeFromForm} documentation.
+     */
+    unsubscribeFromForm(marker: string, body: ISubscribeFormEvent): Promise<boolean | IError>;
+}