Package io.voucherify.client.model

Class Redemption

java.lang.Object

io.voucherify.client.model.Redemption

@Generated("org.openapitools.codegen.languages.JavaClientCodegen")
public class Redemption
extends Object

This is an object representing a redemption for **POST** `v1/redemptions` and **POST** `/client/v1/redemptions`.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Redemption.CustomTypeAdapterFactory
static enum	Redemption.ObjectEnum	The type of the object represented by the JSON
static enum	Redemption.RelatedObjectTypeEnum	Defines the related object.
static enum	Redemption.ResultEnum	Redemption result.
static enum	Redemption.StatusEnum	Redemption 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_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
Redemption()

Method Summary

Modifier and Type	Method	Description
Redemption	_object(Redemption.ObjectEnum _object)
Redemption	amount(Integer amount)
Redemption	channel(RedemptionChannel channel)
Redemption	customer(SimpleCustomer customer)
Redemption	customerId(String customerId)
Redemption	date(OffsetDateTime date)
boolean	equals(Object o)
Redemption	failureCode(String failureCode)
Redemption	failureMessage(String failureMessage)
static Redemption	fromJson(String jsonString)	Create an instance of Redemption given an JSON string
Integer	getAmount()	For gift cards, this is a positive integer in the smallest currency unit (e.g.
RedemptionChannel	getChannel()	Get channel
SimpleCustomer	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.
RedemptionGift	getGift()	Get gift
String	getId()	Unique redemption ID.
RedemptionLoyaltyCard	getLoyaltyCard()	Get loyaltyCard
Object	getMetadata()	The metadata object stores all custom attributes assigned to the redemption.
Redemption.ObjectEnum	getObject()	The type of the object represented by the JSON
OrderCalculated	getOrder()	Get order
PromotionTier	getPromotionTier()	Get promotionTier
String	getRedemption()	Unique redemption ID of the parent redemption.
String	getRelatedObjectId()	Unique related object ID assigned by Voucherify, i.e.
Redemption.RelatedObjectTypeEnum	getRelatedObjectType()	Defines the related object.
RedemptionRelatedRedemptions	getRelatedRedemptions()	Get relatedRedemptions
Redemption.ResultEnum	getResult()	Redemption result.
RedemptionRewardResult	getReward()	Get reward
Redemption.StatusEnum	getStatus()	Redemption status.
String	getTrackingId()	Hashed customer source ID.
RedemptionVoucher	getVoucher()	Get voucher
Redemption	gift(RedemptionGift gift)
int	hashCode()
Redemption	id(String id)
Redemption	loyaltyCard(RedemptionLoyaltyCard loyaltyCard)
Redemption	metadata(Object metadata)
Redemption	order(OrderCalculated order)
Redemption	promotionTier(PromotionTier promotionTier)
Redemption	redemption(String redemption)
Redemption	relatedObjectId(String relatedObjectId)
Redemption	relatedObjectType(Redemption.RelatedObjectTypeEnum relatedObjectType)
Redemption	relatedRedemptions(RedemptionRelatedRedemptions relatedRedemptions)
Redemption	result(Redemption.ResultEnum result)
Redemption	reward(RedemptionRewardResult reward)
void	setAmount(Integer amount)
void	setChannel(RedemptionChannel channel)
void	setCustomer(SimpleCustomer customer)
void	setCustomerId(String customerId)
void	setDate(OffsetDateTime date)
void	setFailureCode(String failureCode)
void	setFailureMessage(String failureMessage)
void	setGift(RedemptionGift gift)
void	setId(String id)
void	setLoyaltyCard(RedemptionLoyaltyCard loyaltyCard)
void	setMetadata(Object metadata)
void	setObject(Redemption.ObjectEnum _object)
void	setOrder(OrderCalculated order)
void	setPromotionTier(PromotionTier promotionTier)
void	setRedemption(String redemption)
void	setRelatedObjectId(String relatedObjectId)
void	setRelatedObjectType(Redemption.RelatedObjectTypeEnum relatedObjectType)
void	setRelatedRedemptions(RedemptionRelatedRedemptions relatedRedemptions)
void	setResult(Redemption.ResultEnum result)
void	setReward(RedemptionRewardResult reward)
void	setStatus(Redemption.StatusEnum status)
void	setTrackingId(String trackingId)
void	setVoucher(RedemptionVoucher voucher)
Redemption	status(Redemption.StatusEnum status)
String	toJson()	Convert an instance of Redemption to an JSON string
String	toString()
Redemption	trackingId(String trackingId)
Redemption	voucher(RedemptionVoucher 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

openapiFields

public static HashSet<String> openapiFields

openapiRequiredFields

public static HashSet<String> openapiRequiredFields

Constructor Details

Redemption

public Redemption()

Method Details

id

public Redemption id(String id)

getId

@Nullable
public String getId()

Unique redemption ID.

Returns:

id

setId

public void setId(String id)

_object

public Redemption _object(Redemption.ObjectEnum _object)

getObject

@Nullable
public Redemption.ObjectEnum getObject()

The type of the object represented by the JSON

Returns:

_object

setObject

public void setObject(Redemption.ObjectEnum _object)

date

public Redemption 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 Redemption 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 Redemption trackingId(String trackingId)

getTrackingId

@Nullable
public String getTrackingId()

Hashed customer source ID.

Returns:

trackingId

setTrackingId

public void setTrackingId(String trackingId)

metadata

public Redemption 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 Redemption 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.

Returns:

amount

setAmount

public void setAmount(Integer amount)

redemption

public Redemption 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 Redemption result(Redemption.ResultEnum result)

getResult

@Nullable
public Redemption.ResultEnum getResult()

Redemption result.

Returns:

result

setResult

public void setResult(Redemption.ResultEnum result)

status

public Redemption status(Redemption.StatusEnum status)

getStatus

@Nullable
public Redemption.StatusEnum getStatus()

Redemption status.

Returns:

status

setStatus

public void setStatus(Redemption.StatusEnum status)

relatedRedemptions

public Redemption relatedRedemptions(RedemptionRelatedRedemptions relatedRedemptions)

getRelatedRedemptions

@Nullable
public RedemptionRelatedRedemptions getRelatedRedemptions()

Get relatedRedemptions

Returns:

relatedRedemptions

setRelatedRedemptions

public void setRelatedRedemptions(RedemptionRelatedRedemptions relatedRedemptions)

failureCode

public Redemption 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 Redemption 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 Redemption order(OrderCalculated order)

getOrder

@Nullable
public OrderCalculated getOrder()

Get order

Returns:

order

setOrder

public void setOrder(OrderCalculated order)

channel

public Redemption channel(RedemptionChannel channel)

getChannel

@Nullable
public RedemptionChannel getChannel()

Get channel

Returns:

channel

setChannel

public void setChannel(RedemptionChannel channel)

customer

public Redemption customer(SimpleCustomer customer)

getCustomer

@Nullable
public SimpleCustomer getCustomer()

Get customer

Returns:

customer

setCustomer

public void setCustomer(SimpleCustomer customer)

relatedObjectType

public Redemption relatedObjectType(Redemption.RelatedObjectTypeEnum relatedObjectType)

getRelatedObjectType

@Nullable
public Redemption.RelatedObjectTypeEnum getRelatedObjectType()

Defines the related object.

Returns:

relatedObjectType

setRelatedObjectType

public void setRelatedObjectType(Redemption.RelatedObjectTypeEnum relatedObjectType)

relatedObjectId

public Redemption relatedObjectId(String relatedObjectId)

getRelatedObjectId

@Nullable
public String getRelatedObjectId()

Unique related object ID assigned by Voucherify, i.e. v_lfZi4rcEGe0sN9gmnj40bzwK2FH6QUno for a voucher.

Returns:

relatedObjectId

setRelatedObjectId

public void setRelatedObjectId(String relatedObjectId)

promotionTier

public Redemption promotionTier(PromotionTier promotionTier)

getPromotionTier

@Nullable
public PromotionTier getPromotionTier()

Get promotionTier

Returns:

promotionTier

setPromotionTier

public void setPromotionTier(PromotionTier promotionTier)

reward

public Redemption reward(RedemptionRewardResult reward)

getReward

@Nullable
public RedemptionRewardResult getReward()

Get reward

Returns:

reward

setReward

public void setReward(RedemptionRewardResult reward)

gift

public Redemption gift(RedemptionGift gift)

getGift

@Nullable
public RedemptionGift getGift()

Get gift

Returns:

gift

setGift

public void setGift(RedemptionGift gift)

loyaltyCard

public Redemption loyaltyCard(RedemptionLoyaltyCard loyaltyCard)

getLoyaltyCard

@Nullable
public RedemptionLoyaltyCard getLoyaltyCard()

Get loyaltyCard

Returns:

loyaltyCard

setLoyaltyCard

public void setLoyaltyCard(RedemptionLoyaltyCard loyaltyCard)

voucher

public Redemption voucher(RedemptionVoucher voucher)

getVoucher

@Nullable
public RedemptionVoucher getVoucher()

Get voucher

Returns:

voucher

setVoucher

public void setVoucher(RedemptionVoucher voucher)

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 Redemption fromJson(String jsonString)
                           throws IOException

Create an instance of Redemption given an JSON string

Parameters:

jsonString - JSON string

Returns:

An instance of Redemption

Throws:

IOException - if the JSON string is invalid with respect to Redemption

toJson

public String toJson()

Convert an instance of Redemption to an JSON string

Returns:

JSON string