core/com.paysafe.wallet.android.core.loyalty.model

Package-level declarations

Types

data class DiscountDetails(val maxDiscounts: Int, val availablePoints: LoyaltyPoint, val options: List<DiscountOption>)

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

data class DiscountOption(val amount: Long, val currencyCode: String, val type: DiscountOptionType, val redemption: DiscountRedemption?)

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

DiscountOptionType

enum DiscountOptionType : Enum<DiscountOptionType>

Enum class representing DiscountOptionType.

DiscountRedemption

data class DiscountRedemption(val reference: String, val displayName: String?)

Data class identifying a chosen DiscountOption for redemption APIs.

ExternalVoucherProductRewardInfo

data class ExternalVoucherProductRewardInfo(val code: String, val expirationTime: Calendar?) : ProductRewardInfo

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

GetAllAvailableProductsParameters

data class GetAllAvailableProductsParameters(val limit: Int? = null, val offset: Int? = null)

Data class representing parameters for retrieving available products.

GetAllOrdersParameters

data class GetAllOrdersParameters(val limit: Int? = null, val offset: Int? = null)

Data class representing parameters for retrieving product orders.

GetAllProductRewardsParameters

data class GetAllProductRewardsParameters(val limit: Int? = null, val offset: Int? = null)

Data class representing parameters for retrieving customer-owned rewards.

LoyaltyAccessToken

data class LoyaltyAccessToken(val accessToken: String, val expiresIn: Int?, val tokenType: String, val scope: String?)

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.

LoyaltyCustomer

data class LoyaltyCustomer(val clientId: String, val profileId: String, val customerId: String, val nickname: String?, val attributes: List<LoyaltyCustomerAttributes>?, val creationTime: Calendar)

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

LoyaltyCustomerAttributes

data class LoyaltyCustomerAttributes(val key: String?, val value: String?)

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

LoyaltyDiscountOptionsResponse

data class LoyaltyDiscountOptionsResponse(val customerId: String, val transactionContext: LoyaltyDiscountOptionsTransaction, val discountDetails: DiscountDetails?)

Data class representing response containing discount options and loyalty context.

LoyaltyDiscountOptionsTransaction

data class LoyaltyDiscountOptionsTransaction(val transactionType: TransactionType, val amount: Long, val currencyCode: String, val attributes: List<LoyaltyDiscountOptionsTransactionAttribute>? = null)

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

LoyaltyDiscountOptionsTransactionAttribute

data class LoyaltyDiscountOptionsTransactionAttribute(val name: LoyaltyDiscountOptionsTransactionAttributeName, val value: String)

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

LoyaltyDiscountOptionsTransactionAttributeName

enum LoyaltyDiscountOptionsTransactionAttributeName : Enum<LoyaltyDiscountOptionsTransactionAttributeName>

Enum class representing supported names for discount options attributes.

LoyaltyEnrollment

data class LoyaltyEnrollment(val nickname: String?, val enrollmentConsent: Boolean)

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

LoyaltyPoint

data class LoyaltyPoint(val id: String, val name: String, val attributes: List<LoyaltyPointAttribute>, val balance: Int)

Data class representing a loyalty point entity.

LoyaltyPointAttribute

data class LoyaltyPointAttribute(val key: String?, val value: String?)

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

Order

data class Order(val id: String, val productId: String, val productInfo: ProductInfo, val quantity: Int, val cost: ValueInUnits, val transactionId: String, val requestTime: Calendar, val rewards: List<ProductRewardReference>)

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

OrderList

data class OrderList(val orders: List<Order>, val meta: PagingResultMeta)

Data Class representing a paginated collection of orders.

OrderRequest

data class OrderRequest(val productId: String, val quantity: Int)

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

Product

data class Product(val id: String, val info: ProductInfo, val inventoryCount: Int, val maxOrderCount: Int, val startTime: Calendar, val expirationTime: Calendar?)

Data class representing a product in the catalog.

ProductInfo

data class ProductInfo(val name: String, val description: String, val imageUrl: String?, val cost: ValueInUnits)

Data class representing information describing a product available for ordering.

ProductList

data class ProductList(val products: List<Product>, val meta: PagingResultMeta)

Data class representing a paginated collection of products.

ProductReward

data class ProductReward(val id: String, val productId: String, val productInfo: ProductInfo, val orderId: String, val rewardInfo: ProductRewardInfo, val status: ProductRewardStatus, val expired: Boolean, val requestTime: Calendar)

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

ProductRewardInfo

interface ProductRewardInfo

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

ProductRewardInfoType

enum ProductRewardInfoType : Enum<ProductRewardInfoType>

Enum class representing discriminator value identifying the ProductRewardInfo.

ProductRewardList

data class ProductRewardList(val rewards: List<ProductReward>, val meta: PagingResultMeta)

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

ProductRewardReference

data class ProductRewardReference(val id: String)

Data class representing lightweight reference to a reward.

ProductRewardStatus

enum ProductRewardStatus : Enum<ProductRewardStatus>

Enum class representing the status of a product reward.

ProductRewardUpdateRequest

data class ProductRewardUpdateRequest(val status: ProductRewardStatus)

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

SweepstakeProductRewardInfo

data class SweepstakeProductRewardInfo(val expirationTime: Calendar?) : ProductRewardInfo

Data class representing a sweepstake entry reward.

ValueInUnits

data class ValueInUnits(val amount: Int, val unit: ValueInUnitsType)

Data class representing a numeric value with an associated unit.

ValueInUnitsType

enum ValueInUnitsType : Enum<ValueInUnitsType>

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