Package io.voucherify.client.model
Class RedemptionEntry
java.lang.Object
io.voucherify.client.model.RedemptionEntry
@Generated("org.openapitools.codegen.languages.JavaClientCodegen")
public class RedemptionEntry
extends Object
RedemptionEntry
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classstatic enumGets or Sets _objectstatic enumDefines the related object.static enumRedemption result.static enumGets or Sets status -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final String -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescription_object(RedemptionEntry.ObjectEnum _object) channel(RedemptionEntryChannel channel) customer(RedemptionEntryCustomer customer) customerId(String customerId) date(OffsetDateTime date) booleanfailureCode(String failureCode) failureMessage(String failureMessage) static RedemptionEntryCreate an instance of RedemptionEntry given an JSON stringFor gift cards, this is a positive integer in the smallest currency unit (e.g.Get channelGet customerUnique customer ID of the redeeming customer.getDate()Timestamp representing the date and time when the object was created.If the result is `FAILURE`, this parameter will provide a generic reason as to why the redemption failed.If the result is `FAILURE`, this parameter will provide a more expanded reason as to why the redemption failed.getGift()Get giftgetId()Get idGet loyaltyCardThe metadata object stores all custom attributes assigned to the redemption.Get _objectgetOrder()Get orderGet promotionTierSystem generated cause for the redemption being invalid in the context of the provided parameters.Unique redemption ID of the parent redemption.Get relatedObjectIdDefines the related object.Get relatedRedemptionsRedemption result.Get rewardGet statusHashed customer source ID.Get vouchergift(RedemptionEntryGift gift) inthashCode()loyaltyCard(RedemptionEntryLoyaltyCard loyaltyCard) order(RedemptionEntryOrder order) promotionTier(RedemptionEntryPromotionTier promotionTier) redemption(String redemption) relatedObjectId(String relatedObjectId) relatedObjectType(RedemptionEntry.RelatedObjectTypeEnum relatedObjectType) relatedRedemptions(RedemptionEntryRelatedRedemptions relatedRedemptions) result(RedemptionEntry.ResultEnum result) reward(RedemptionRewardResult reward) voidvoidsetChannel(RedemptionEntryChannel channel) voidsetCustomer(RedemptionEntryCustomer customer) voidsetCustomerId(String customerId) voidsetDate(OffsetDateTime date) voidsetFailureCode(String failureCode) voidsetFailureMessage(String failureMessage) voidsetGift(RedemptionEntryGift gift) voidvoidsetLoyaltyCard(RedemptionEntryLoyaltyCard loyaltyCard) voidsetMetadata(Object metadata) voidsetObject(RedemptionEntry.ObjectEnum _object) voidsetOrder(RedemptionEntryOrder order) voidsetPromotionTier(RedemptionEntryPromotionTier promotionTier) voidvoidsetRedemption(String redemption) voidsetRelatedObjectId(String relatedObjectId) voidsetRelatedObjectType(RedemptionEntry.RelatedObjectTypeEnum relatedObjectType) voidsetRelatedRedemptions(RedemptionEntryRelatedRedemptions relatedRedemptions) voidsetResult(RedemptionEntry.ResultEnum result) voidsetReward(RedemptionRewardResult reward) voidsetStatus(RedemptionEntry.StatusEnum status) voidsetTrackingId(String trackingId) voidsetVoucher(RedemptionEntryVoucher voucher) status(RedemptionEntry.StatusEnum status) toJson()Convert an instance of RedemptionEntry to an JSON stringtoString()trackingId(String trackingId) voucher(RedemptionEntryVoucher voucher)
-
Field Details
-
SERIALIZED_NAME_ID
- See Also:
-
SERIALIZED_NAME_OBJECT
- See Also:
-
SERIALIZED_NAME_DATE
- See Also:
-
SERIALIZED_NAME_CUSTOMER_ID
- See Also:
-
SERIALIZED_NAME_TRACKING_ID
- See Also:
-
SERIALIZED_NAME_METADATA
- See Also:
-
SERIALIZED_NAME_AMOUNT
- See Also:
-
SERIALIZED_NAME_REDEMPTION
- See Also:
-
SERIALIZED_NAME_RESULT
- See Also:
-
SERIALIZED_NAME_STATUS
- See Also:
-
SERIALIZED_NAME_RELATED_REDEMPTIONS
- See Also:
-
SERIALIZED_NAME_FAILURE_CODE
- See Also:
-
SERIALIZED_NAME_FAILURE_MESSAGE
- See Also:
-
SERIALIZED_NAME_ORDER
- See Also:
-
SERIALIZED_NAME_CHANNEL
- See Also:
-
SERIALIZED_NAME_CUSTOMER
- See Also:
-
SERIALIZED_NAME_RELATED_OBJECT_TYPE
- See Also:
-
SERIALIZED_NAME_RELATED_OBJECT_ID
- See Also:
-
SERIALIZED_NAME_PROMOTION_TIER
- See Also:
-
SERIALIZED_NAME_REWARD
- See Also:
-
SERIALIZED_NAME_GIFT
- See Also:
-
SERIALIZED_NAME_LOYALTY_CARD
- See Also:
-
SERIALIZED_NAME_VOUCHER
- See Also:
-
SERIALIZED_NAME_REASON
- See Also:
-
openapiFields
-
openapiRequiredFields
-
-
Constructor Details
-
RedemptionEntry
public RedemptionEntry()
-
-
Method Details
-
id
-
getId
Get id- Returns:
- id
-
setId
-
_object
-
getObject
Get _object- Returns:
- _object
-
setObject
-
date
-
getDate
Timestamp representing the date and time when the object was created. The value is shown in the ISO 8601 format.- Returns:
- date
-
setDate
-
customerId
-
getCustomerId
Unique customer ID of the redeeming customer.- Returns:
- customerId
-
setCustomerId
-
trackingId
-
getTrackingId
Hashed customer source ID.- Returns:
- trackingId
-
setTrackingId
-
metadata
-
getMetadata
The metadata object stores all custom attributes assigned to the redemption.- Returns:
- metadata
-
setMetadata
-
amount
-
getAmount
For gift cards, this is a positive integer in the smallest currency unit (e.g. 100 cents for $1.00) representing the number of redeemed credits. For loyalty cards, this is the number of loyalty points used in the transaction. and For gift cards, this represents the number of the credits restored to the card in the rolledback redemption. The number is a negative integer in the smallest currency unit, e.g. -100 cents for $1.00 added back to the card. For loyalty cards, this represents the number of loyalty points restored to the card in the rolledback redemption. The number is a negative integer.- Returns:
- amount
-
setAmount
-
redemption
-
getRedemption
Unique redemption ID of the parent redemption.- Returns:
- redemption
-
setRedemption
-
result
-
getResult
Redemption result.- Returns:
- result
-
setResult
-
status
-
getStatus
Get status- Returns:
- status
-
setStatus
-
getRelatedRedemptions
Get relatedRedemptions- Returns:
- relatedRedemptions
-
setRelatedRedemptions
-
failureCode
-
getFailureCode
If the result is `FAILURE`, this parameter will provide a generic reason as to why the redemption failed.- Returns:
- failureCode
-
setFailureCode
-
failureMessage
-
getFailureMessage
If the result is `FAILURE`, this parameter will provide a more expanded reason as to why the redemption failed.- Returns:
- failureMessage
-
setFailureMessage
-
order
-
getOrder
Get order- Returns:
- order
-
setOrder
-
channel
-
getChannel
Get channel- Returns:
- channel
-
setChannel
-
customer
-
getCustomer
Get customer- Returns:
- customer
-
setCustomer
-
getRelatedObjectType
Defines the related object.- Returns:
- relatedObjectType
-
setRelatedObjectType
-
getRelatedObjectId
Get relatedObjectId- Returns:
- relatedObjectId
-
setRelatedObjectId
-
promotionTier
-
getPromotionTier
Get promotionTier- Returns:
- promotionTier
-
setPromotionTier
-
reward
-
getReward
Get reward- Returns:
- reward
-
setReward
-
gift
-
getGift
Get gift- Returns:
- gift
-
setGift
-
loyaltyCard
-
getLoyaltyCard
Get loyaltyCard- Returns:
- loyaltyCard
-
setLoyaltyCard
-
voucher
-
getVoucher
Get voucher- Returns:
- voucher
-
setVoucher
-
reason
-
getReason
System generated cause for the redemption being invalid in the context of the provided parameters.- Returns:
- reason
-
setReason
-
equals
-
hashCode
public int hashCode() -
toString
-
fromJson
Create an instance of RedemptionEntry given an JSON string- Parameters:
jsonString- JSON string- Returns:
- An instance of RedemptionEntry
- Throws:
IOException- if the JSON string is invalid with respect to RedemptionEntry
-
toJson
Convert an instance of RedemptionEntry to an JSON string- Returns:
- JSON string
-