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 Classes

Modifier and Type	Class	Description
static class	RedemptionEntry.CustomTypeAdapterFactory
static enum	RedemptionEntry.ObjectEnum	Gets or Sets _object
static enum	RedemptionEntry.RelatedObjectTypeEnum	Defines the related object.
static enum	RedemptionEntry.ResultEnum	Redemption result.
static enum	RedemptionEntry.StatusEnum	Gets or Sets status

Field Summary

Fields

Modifier and Type	Field	Description
static HashSet<String>	openapiFields
static HashSet<String>	openapiRequiredFields
static final String	SERIALIZED_NAME_AMOUNT
static final String	SERIALIZED_NAME_CHANNEL
static final String	SERIALIZED_NAME_CUSTOMER
static final String	SERIALIZED_NAME_CUSTOMER_ID
static final String	SERIALIZED_NAME_DATE
static final String	SERIALIZED_NAME_FAILURE_CODE
static final String	SERIALIZED_NAME_FAILURE_MESSAGE
static final String	SERIALIZED_NAME_GIFT
static final String	SERIALIZED_NAME_ID
static final String	SERIALIZED_NAME_LOYALTY_CARD
static final String	SERIALIZED_NAME_METADATA
static final String	SERIALIZED_NAME_OBJECT
static final String	SERIALIZED_NAME_ORDER
static final String	SERIALIZED_NAME_PROMOTION_TIER
static final String	SERIALIZED_NAME_REASON
static final String	SERIALIZED_NAME_REDEMPTION
static final String	SERIALIZED_NAME_RELATED_OBJECT_ID
static final String	SERIALIZED_NAME_RELATED_OBJECT_TYPE
static final String	SERIALIZED_NAME_RELATED_REDEMPTIONS
static final String	SERIALIZED_NAME_RESULT
static final String	SERIALIZED_NAME_REWARD
static final String	SERIALIZED_NAME_STATUS
static final String	SERIALIZED_NAME_TRACKING_ID
static final String	SERIALIZED_NAME_VOUCHER

Constructor Summary

Constructors

Constructor	Description
RedemptionEntry()

Method Summary

Modifier and Type	Method	Description
RedemptionEntry	_object(RedemptionEntry.ObjectEnum _object)
RedemptionEntry	amount(Integer amount)
RedemptionEntry	channel(RedemptionEntryChannel channel)
RedemptionEntry	customer(RedemptionEntryCustomer customer)
RedemptionEntry	customerId(String customerId)
RedemptionEntry	date(OffsetDateTime date)
boolean	equals(Object o)
RedemptionEntry	failureCode(String failureCode)
RedemptionEntry	failureMessage(String failureMessage)
static RedemptionEntry	fromJson(String jsonString)	Create an instance of RedemptionEntry given an JSON string
Integer	getAmount()	For gift cards, this is a positive integer in the smallest currency unit (e.g.
RedemptionEntryChannel	getChannel()	Get channel
RedemptionEntryCustomer	getCustomer()	Get customer
String	getCustomerId()	Unique customer ID of the redeeming customer.
OffsetDateTime	getDate()	Timestamp representing the date and time when the object was created.
String	getFailureCode()	If the result is `FAILURE`, this parameter will provide a generic reason as to why the redemption failed.
String	getFailureMessage()	If the result is `FAILURE`, this parameter will provide a more expanded reason as to why the redemption failed.
RedemptionEntryGift	getGift()	Get gift
String	getId()	Get id
RedemptionEntryLoyaltyCard	getLoyaltyCard()	Get loyaltyCard
Object	getMetadata()	The metadata object stores all custom attributes assigned to the redemption.
RedemptionEntry.ObjectEnum	getObject()	Get _object
RedemptionEntryOrder	getOrder()	Get order
RedemptionEntryPromotionTier	getPromotionTier()	Get promotionTier
String	getReason()	System generated cause for the redemption being invalid in the context of the provided parameters.
String	getRedemption()	Unique redemption ID of the parent redemption.
String	getRelatedObjectId()	Get relatedObjectId
RedemptionEntry.RelatedObjectTypeEnum	getRelatedObjectType()	Defines the related object.
RedemptionEntryRelatedRedemptions	getRelatedRedemptions()	Get relatedRedemptions
RedemptionEntry.ResultEnum	getResult()	Redemption result.
RedemptionRewardResult	getReward()	Get reward
RedemptionEntry.StatusEnum	getStatus()	Get status
String	getTrackingId()	Hashed customer source ID.
RedemptionEntryVoucher	getVoucher()	Get voucher
RedemptionEntry	gift(RedemptionEntryGift gift)
int	hashCode()
RedemptionEntry	id(String id)
RedemptionEntry	loyaltyCard(RedemptionEntryLoyaltyCard loyaltyCard)
RedemptionEntry	metadata(Object metadata)
RedemptionEntry	order(RedemptionEntryOrder order)
RedemptionEntry	promotionTier(RedemptionEntryPromotionTier promotionTier)
RedemptionEntry	reason(String reason)
RedemptionEntry	redemption(String redemption)
RedemptionEntry	relatedObjectId(String relatedObjectId)
RedemptionEntry	relatedObjectType(RedemptionEntry.RelatedObjectTypeEnum relatedObjectType)
RedemptionEntry	relatedRedemptions(RedemptionEntryRelatedRedemptions relatedRedemptions)
RedemptionEntry	result(RedemptionEntry.ResultEnum result)
RedemptionEntry	reward(RedemptionRewardResult reward)
void	setAmount(Integer amount)
void	setChannel(RedemptionEntryChannel channel)
void	setCustomer(RedemptionEntryCustomer customer)
void	setCustomerId(String customerId)
void	setDate(OffsetDateTime date)
void	setFailureCode(String failureCode)
void	setFailureMessage(String failureMessage)
void	setGift(RedemptionEntryGift gift)
void	setId(String id)
void	setLoyaltyCard(RedemptionEntryLoyaltyCard loyaltyCard)
void	setMetadata(Object metadata)
void	setObject(RedemptionEntry.ObjectEnum _object)
void	setOrder(RedemptionEntryOrder order)
void	setPromotionTier(RedemptionEntryPromotionTier promotionTier)
void	setReason(String reason)
void	setRedemption(String redemption)
void	setRelatedObjectId(String relatedObjectId)
void	setRelatedObjectType(RedemptionEntry.RelatedObjectTypeEnum relatedObjectType)
void	setRelatedRedemptions(RedemptionEntryRelatedRedemptions relatedRedemptions)
void	setResult(RedemptionEntry.ResultEnum result)
void	setReward(RedemptionRewardResult reward)
void	setStatus(RedemptionEntry.StatusEnum status)
void	setTrackingId(String trackingId)
void	setVoucher(RedemptionEntryVoucher voucher)
RedemptionEntry	status(RedemptionEntry.StatusEnum status)
String	toJson()	Convert an instance of RedemptionEntry to an JSON string
String	toString()
RedemptionEntry	trackingId(String trackingId)
RedemptionEntry	voucher(RedemptionEntryVoucher voucher)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

SERIALIZED_NAME_ID

public static final String SERIALIZED_NAME_ID

See Also:

• Constant Field Values

SERIALIZED_NAME_OBJECT

public static final String SERIALIZED_NAME_OBJECT

See Also:

• Constant Field Values

SERIALIZED_NAME_DATE

public static final String SERIALIZED_NAME_DATE

See Also:

• Constant Field Values

SERIALIZED_NAME_CUSTOMER_ID

public static final String SERIALIZED_NAME_CUSTOMER_ID

See Also:

• Constant Field Values

SERIALIZED_NAME_TRACKING_ID

public static final String SERIALIZED_NAME_TRACKING_ID

See Also:

• Constant Field Values

SERIALIZED_NAME_METADATA

public static final String SERIALIZED_NAME_METADATA

See Also:

• Constant Field Values

SERIALIZED_NAME_AMOUNT

public static final String SERIALIZED_NAME_AMOUNT

See Also:

• Constant Field Values

SERIALIZED_NAME_REDEMPTION

public static final String SERIALIZED_NAME_REDEMPTION

See Also:

• Constant Field Values

SERIALIZED_NAME_RESULT

public static final String SERIALIZED_NAME_RESULT

See Also:

• Constant Field Values

SERIALIZED_NAME_STATUS

public static final String SERIALIZED_NAME_STATUS

See Also:

• Constant Field Values

SERIALIZED_NAME_RELATED_REDEMPTIONS

public static final String SERIALIZED_NAME_RELATED_REDEMPTIONS

See Also:

• Constant Field Values

SERIALIZED_NAME_FAILURE_CODE

public static final String SERIALIZED_NAME_FAILURE_CODE

See Also:

• Constant Field Values

SERIALIZED_NAME_FAILURE_MESSAGE

public static final String SERIALIZED_NAME_FAILURE_MESSAGE

See Also:

• Constant Field Values

SERIALIZED_NAME_ORDER

public static final String SERIALIZED_NAME_ORDER

See Also:

• Constant Field Values

SERIALIZED_NAME_CHANNEL

public static final String SERIALIZED_NAME_CHANNEL

See Also:

• Constant Field Values

SERIALIZED_NAME_CUSTOMER

public static final String SERIALIZED_NAME_CUSTOMER

See Also:

• Constant Field Values

SERIALIZED_NAME_RELATED_OBJECT_TYPE

public static final String SERIALIZED_NAME_RELATED_OBJECT_TYPE

See Also:

• Constant Field Values

SERIALIZED_NAME_RELATED_OBJECT_ID

public static final String SERIALIZED_NAME_RELATED_OBJECT_ID

See Also:

• Constant Field Values

SERIALIZED_NAME_PROMOTION_TIER

public static final String SERIALIZED_NAME_PROMOTION_TIER

See Also:

• Constant Field Values

SERIALIZED_NAME_REWARD

public static final String SERIALIZED_NAME_REWARD

See Also:

• Constant Field Values

SERIALIZED_NAME_GIFT

public static final String SERIALIZED_NAME_GIFT

See Also:

• Constant Field Values

SERIALIZED_NAME_LOYALTY_CARD

public static final String SERIALIZED_NAME_LOYALTY_CARD

See Also:

• Constant Field Values

SERIALIZED_NAME_VOUCHER

public static final String SERIALIZED_NAME_VOUCHER

See Also:

• Constant Field Values

SERIALIZED_NAME_REASON

public static final String SERIALIZED_NAME_REASON

See Also:

• Constant Field Values

openapiFields

public static HashSet<String> openapiFields

openapiRequiredFields

public static HashSet<String> openapiRequiredFields

Constructor Details

RedemptionEntry

public RedemptionEntry()

Method Details

id

public RedemptionEntry id(String id)

getId

@Nullable
public String getId()

Get id

Returns:

id

setId

public void setId(String id)

_object

public RedemptionEntry _object(RedemptionEntry.ObjectEnum _object)

getObject

@Nullable
public RedemptionEntry.ObjectEnum getObject()

Get _object

Returns:

_object

setObject

public void setObject(RedemptionEntry.ObjectEnum _object)

date

public RedemptionEntry date(OffsetDateTime date)

getDate

@Nullable
public OffsetDateTime getDate()

Timestamp representing the date and time when the object was created. The value is shown in the ISO 8601 format.

Returns:

date

setDate

public void setDate(OffsetDateTime date)

customerId

public RedemptionEntry customerId(String customerId)

getCustomerId

@Nullable
public String getCustomerId()

Unique customer ID of the redeeming customer.

Returns:

customerId

setCustomerId

public void setCustomerId(String customerId)

trackingId

public RedemptionEntry trackingId(String trackingId)

getTrackingId

@Nullable
public String getTrackingId()

Hashed customer source ID.

Returns:

trackingId

setTrackingId

public void setTrackingId(String trackingId)

metadata

public RedemptionEntry metadata(Object metadata)

getMetadata

@Nullable
public Object getMetadata()

The metadata object stores all custom attributes assigned to the redemption.

Returns:

metadata

setMetadata

public void setMetadata(Object metadata)

amount

public RedemptionEntry amount(Integer amount)

getAmount

@Nullable
public Integer 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

public void setAmount(Integer amount)

redemption

public RedemptionEntry redemption(String redemption)

getRedemption

@Nullable
public String getRedemption()

Unique redemption ID of the parent redemption.

Returns:

redemption

setRedemption

public void setRedemption(String redemption)

result

public RedemptionEntry result(RedemptionEntry.ResultEnum result)

getResult

@Nullable
public RedemptionEntry.ResultEnum getResult()

Redemption result.

Returns:

result

setResult

public void setResult(RedemptionEntry.ResultEnum result)

status

public RedemptionEntry status(RedemptionEntry.StatusEnum status)

getStatus

@Nullable
public RedemptionEntry.StatusEnum getStatus()

Get status

Returns:

status

setStatus

public void setStatus(RedemptionEntry.StatusEnum status)

relatedRedemptions

public RedemptionEntry relatedRedemptions(RedemptionEntryRelatedRedemptions relatedRedemptions)

getRelatedRedemptions

@Nullable
public RedemptionEntryRelatedRedemptions getRelatedRedemptions()

Get relatedRedemptions

Returns:

relatedRedemptions

setRelatedRedemptions

public void setRelatedRedemptions(RedemptionEntryRelatedRedemptions relatedRedemptions)

failureCode

public RedemptionEntry failureCode(String failureCode)

getFailureCode

@Nullable
public String getFailureCode()

If the result is `FAILURE`, this parameter will provide a generic reason as to why the redemption failed.

Returns:

failureCode

setFailureCode

public void setFailureCode(String failureCode)

failureMessage

public RedemptionEntry failureMessage(String failureMessage)

getFailureMessage

@Nullable
public String getFailureMessage()

If the result is `FAILURE`, this parameter will provide a more expanded reason as to why the redemption failed.

Returns:

failureMessage

setFailureMessage

public void setFailureMessage(String failureMessage)

order

public RedemptionEntry order(RedemptionEntryOrder order)

getOrder

@Nullable
public RedemptionEntryOrder getOrder()

Get order

Returns:

order

setOrder

public void setOrder(RedemptionEntryOrder order)

channel

public RedemptionEntry channel(RedemptionEntryChannel channel)

getChannel

@Nullable
public RedemptionEntryChannel getChannel()

Get channel

Returns:

channel

setChannel

public void setChannel(RedemptionEntryChannel channel)

customer

public RedemptionEntry customer(RedemptionEntryCustomer customer)

getCustomer

@Nullable
public RedemptionEntryCustomer getCustomer()

Get customer

Returns:

customer

setCustomer

public void setCustomer(RedemptionEntryCustomer customer)

relatedObjectType

public RedemptionEntry relatedObjectType(RedemptionEntry.RelatedObjectTypeEnum relatedObjectType)

getRelatedObjectType

@Nullable
public RedemptionEntry.RelatedObjectTypeEnum getRelatedObjectType()

Defines the related object.

Returns:

relatedObjectType

setRelatedObjectType

public void setRelatedObjectType(RedemptionEntry.RelatedObjectTypeEnum relatedObjectType)

relatedObjectId

public RedemptionEntry relatedObjectId(String relatedObjectId)

getRelatedObjectId

@Nullable
public String getRelatedObjectId()

Get relatedObjectId

Returns:

relatedObjectId

setRelatedObjectId

public void setRelatedObjectId(String relatedObjectId)

promotionTier

public RedemptionEntry promotionTier(RedemptionEntryPromotionTier promotionTier)

getPromotionTier

@Nullable
public RedemptionEntryPromotionTier getPromotionTier()

Get promotionTier

Returns:

promotionTier

setPromotionTier

public void setPromotionTier(RedemptionEntryPromotionTier promotionTier)

reward

public RedemptionEntry reward(RedemptionRewardResult reward)

getReward

@Nullable
public RedemptionRewardResult getReward()

Get reward

Returns:

reward

setReward

public void setReward(RedemptionRewardResult reward)

gift

public RedemptionEntry gift(RedemptionEntryGift gift)

getGift

@Nullable
public RedemptionEntryGift getGift()

Get gift

Returns:

gift

setGift

public void setGift(RedemptionEntryGift gift)

loyaltyCard

public RedemptionEntry loyaltyCard(RedemptionEntryLoyaltyCard loyaltyCard)

getLoyaltyCard

@Nullable
public RedemptionEntryLoyaltyCard getLoyaltyCard()

Get loyaltyCard

Returns:

loyaltyCard

setLoyaltyCard

public void setLoyaltyCard(RedemptionEntryLoyaltyCard loyaltyCard)

voucher

public RedemptionEntry voucher(RedemptionEntryVoucher voucher)

getVoucher

@Nullable
public RedemptionEntryVoucher getVoucher()

Get voucher

Returns:

voucher

setVoucher

public void setVoucher(RedemptionEntryVoucher voucher)

reason

public RedemptionEntry reason(String reason)

getReason

@Nullable
public String getReason()

System generated cause for the redemption being invalid in the context of the provided parameters.

Returns:

reason

setReason

public void setReason(String reason)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

fromJson

public static RedemptionEntry fromJson(String jsonString)
                                throws IOException

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

public String toJson()

Convert an instance of RedemptionEntry to an JSON string

Returns:

JSON string