Package-level declarations

A streak based on successful consecutive actions, independent of timing between them.

Data class representing the customer's progress on a ConsecutiveActionStreak.

Data class representing the available discount points balances and selectable discount options.

Data class representing one eligible discount line the customer can apply, including the monetary effect and how to reference it when confirming the payment.

Enum class representing DiscountOptionType.

Data class identifying a chosen DiscountOption for redemption APIs.

Data class representing an external voucher code the user presents at a merchant to apply a discount or stored value.

Data class representing parameters for retrieving available products.

Data class representing parameters for retrieving loyalty points.

Data class representing parameters for retrieving loyalty point transaction history.

Data class representing parameters for retrieving product orders.

Data class representing parameters for retrieving customer-owned rewards.

Data class representing parameters for retrieving streak milestones.

Data class representing parameters for retrieving streaks.

Data class representing parameters for retrieving a single streak milestone.

Data class representing parameters for retrieving a single streak.

Represents the structure of the loyalty access token used by the client to interact with the Loyalty SDK. It includes the access token and additional details required for client authentication.

Data class representing a customer action that can be used by loyalty features such as streaks.

Represents a customer enrolled in the loyalty program, including customer details and enrollment data.

Key-value pair attribute for the customer's embedded wallet in the loyalty application.

Data class representing response containing discount options and loyalty context.

Data class representing the transaction context submitted for resolving discount options.

Data class representing a named attribute for the discount options transaction context.

Enum class representing supported names for discount options attributes.

Represents the information required to enroll a customer in the loyalty program, including customer details and consent data.

Data class representing a loyalty point entity.

Data class representing a key-value attribute for a LoyaltyPoint.

Data class identifying the loyalty point type and amount referenced in a transaction.

Data class representing a paginated collection of loyalty points.

Data class representing a single loyalty point transaction (debit or credit).

Data class representing a paginated collection of loyalty point transactions.

Data class representing an order placed for products from the store. May possibly result in multiple associated rewards.

Data Class representing a paginated collection of orders.

Data class representing a request to place an order for a product from the product catalog.

A streak where customers must perform an action within a recurring time window (daily, weekly, monthly).

Data class representing the customer's progress on a PeriodicActionStreak.

Data class representing a product in the catalog.

Data class representing information describing a product available for ordering.

Data class representing a paginated collection of products.

Data class representing a reward acquired by placing an order for a product.

Content of the reward, possibly containing sensitive info intended only for the owner.

Enum class representing discriminator value identifying the ProductRewardInfo.

Data class representing a paginated collection of customer-owned rewards.

Data class representing lightweight reference to a reward.

Enum class representing the status of a product reward.

Data class representing a request to update an existing customer-owned reward.

A streak tracks a user's progress as they repeat a defined action consistently over time. It continues as long as the rules are met, and resets if interrupted.

Data class representing a paginated collection of streaks.

Data class representing a streak milestone - a reward checkpoint within a streak. Milestones allow rewards at incremental progress points (streak lengths), including the customer's achievement details.

Data class representing a summary of the customer's achievements of a streak milestone.

Data class representing a paginated collection of streak milestones.

Data class representing a lightweight reference to a streak milestone, containing its configuration without the customer's achievement details.

Enum class representing the type of a streak milestone.

Enum class representing the window within which the customer must perform an action in order to advance a periodic action streak.

Represents the customer's progress on a streak.

Enum class representing the current state of the customer's participation in a streak.

Enum class representing the type of a streak, which determines how progress is accumulated and when the streak resets.

Data class representing a sweepstake entry reward.

Data class representing a numeric value with an associated unit.

Enum class representing the type of units which can be used for ValueInUnits.