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.

ExpiryAtFilter

sealed class ExpiryAtFilter

Filter for the reward expiryAt field. Each subclass represents a comparison operation on the expiry date.

Filters

data class Filters(val expiryAtFilters: List<ExpiryAtFilter>)

Filters for filtering available rewards.

GetAllRewardRedemptionsParameters

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

Data class representing parameters for retrieving reward redemptions.

GetAvailableRewardsParameters

data class GetAvailableRewardsParameters(val limit: Int? = null, val offset: Int? = null, val filters: Filters? = null)

Data class representing parameters for retrieving available 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.

RedemptionList

data class RedemptionList(val redemptions: List<RewardRedemption>, val meta: PagingResultMeta)

Data class containing a list of redemptions and metadata for paginated results.

RedemptionStatus

enum RedemptionStatus : Enum<RedemptionStatus>

Enum class representing the status of the redemption.

Reward

data class Reward(val id: Int, val name: String, val inventoryCount: Int, val description: String, val maxRedemptionCount: Int, val cost: RewardValue?, val startAt: Calendar, val expiryAt: Calendar?, val imageUrl: String, val categories: List<String>)

Data class representing a reward in the loyalty program.

RewardBase

data class RewardBase(val id: Int, val name: String, val inventoryCount: Int)

Data class representing a base reward in the loyalty program.

RewardList

data class RewardList(val rewards: List<Reward>, val meta: PagingResultMeta)

Data class representing a list of rewards and metadata for paginated results.

RewardRedemption

data class RewardRedemption(val id: Int, val transactionId: String, val status: RedemptionStatus, val quantity: Int, val cost: RewardValue?, val requestedAt: Calendar, val expiryAt: Calendar?, val reward: RewardBase?, val balance: RewardValue?)

Data class representing the customer's redemption of a reward.

RewardRedemptionRequest

data class RewardRedemptionRequest(val quantity: Int)

Data class representing customer's request of a reward.

RewardValue

data class RewardValue(val amount: Int, val type: String)

Data class representing a numeric value with an associated type.