Package io.voucherify.client.model

Class RedemptionRollback

java.lang.Object

io.voucherify.client.model.RedemptionRollback

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

This is an object representing a redemption rollback.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
RedemptionRollback	_object(RedemptionRollback.ObjectEnum _object)
RedemptionRollback	amount(Integer amount)
RedemptionRollback	channel(RedemptionRollbackChannel channel)
RedemptionRollback	customer(SimpleCustomer customer)
RedemptionRollback	customerId(String customerId)
RedemptionRollback	date(OffsetDateTime date)
boolean	equals(Object o)
RedemptionRollback	failureCode(String failureCode)
RedemptionRollback	failureMessage(String failureMessage)
static RedemptionRollback	fromJson(String jsonString)	Create an instance of RedemptionRollback given an JSON string
Integer	getAmount()	For gift cards, this represents the number of the credits restored to the card in the rolledback redemption.
RedemptionRollbackChannel	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.
RedemptionRollbackGift	getGift()	Get gift
String	getId()	Unique identifier of the redemption rollback.
RedemptionRollbackLoyaltyCard	getLoyaltyCard()	Get loyaltyCard
Object	getMetadata()	The metadata object stores all custom attributes assigned to the redemption.
RedemptionRollback.ObjectEnum	getObject()	The type of the object represented by the JSON
OrderCalculated	getOrder()	Get order
PromotionTier	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()	Unique identifier of the related object.
RedemptionRollback.RelatedObjectTypeEnum	getRelatedObjectType()	Defines the related object.
RedemptionRollbackRelatedRedemptions	getRelatedRedemptions()	Get relatedRedemptions
RedemptionRollback.ResultEnum	getResult()	Redemption result.
RedemptionRewardResult	getReward()	Get reward
RedemptionRollback.StatusEnum	getStatus()	Redemption status.
String	getTrackingId()	Hashed customer source ID.
Voucher	getVoucher()	Get voucher
RedemptionRollback	gift(RedemptionRollbackGift gift)
int	hashCode()
RedemptionRollback	id(String id)
RedemptionRollback	loyaltyCard(RedemptionRollbackLoyaltyCard loyaltyCard)
RedemptionRollback	metadata(Object metadata)
RedemptionRollback	order(OrderCalculated order)
RedemptionRollback	promotionTier(PromotionTier promotionTier)
RedemptionRollback	reason(String reason)
RedemptionRollback	redemption(String redemption)
RedemptionRollback	relatedObjectId(String relatedObjectId)
RedemptionRollback	relatedObjectType(RedemptionRollback.RelatedObjectTypeEnum relatedObjectType)
RedemptionRollback	relatedRedemptions(RedemptionRollbackRelatedRedemptions relatedRedemptions)
RedemptionRollback	result(RedemptionRollback.ResultEnum result)
RedemptionRollback	reward(RedemptionRewardResult reward)
void	setAmount(Integer amount)
void	setChannel(RedemptionRollbackChannel channel)
void	setCustomer(SimpleCustomer customer)
void	setCustomerId(String customerId)
void	setDate(OffsetDateTime date)
void	setFailureCode(String failureCode)
void	setFailureMessage(String failureMessage)
void	setGift(RedemptionRollbackGift gift)
void	setId(String id)
void	setLoyaltyCard(RedemptionRollbackLoyaltyCard loyaltyCard)
void	setMetadata(Object metadata)
void	setObject(RedemptionRollback.ObjectEnum _object)
void	setOrder(OrderCalculated order)
void	setPromotionTier(PromotionTier promotionTier)
void	setReason(String reason)
void	setRedemption(String redemption)
void	setRelatedObjectId(String relatedObjectId)
void	setRelatedObjectType(RedemptionRollback.RelatedObjectTypeEnum relatedObjectType)
void	setRelatedRedemptions(RedemptionRollbackRelatedRedemptions relatedRedemptions)
void	setResult(RedemptionRollback.ResultEnum result)
void	setReward(RedemptionRewardResult reward)
void	setStatus(RedemptionRollback.StatusEnum status)
void	setTrackingId(String trackingId)
void	setVoucher(Voucher voucher)
RedemptionRollback	status(RedemptionRollback.StatusEnum status)
String	toJson()	Convert an instance of RedemptionRollback to an JSON string
String	toString()
RedemptionRollback	trackingId(String trackingId)
RedemptionRollback	voucher(Voucher 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_REASON

public static final String SERIALIZED_NAME_REASON

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_VOUCHER

public static final String SERIALIZED_NAME_VOUCHER

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

openapiFields

public static HashSet<String> openapiFields

openapiRequiredFields

public static HashSet<String> openapiRequiredFields

Constructor Details

RedemptionRollback

public RedemptionRollback()

Method Details

id

public RedemptionRollback id(String id)

getId

@Nullable
public String getId()

Unique identifier of the redemption rollback.

Returns:

id

setId

public void setId(String id)

_object

public RedemptionRollback _object(RedemptionRollback.ObjectEnum _object)

getObject

@Nullable
public RedemptionRollback.ObjectEnum getObject()

The type of the object represented by the JSON

Returns:

_object

setObject

public void setObject(RedemptionRollback.ObjectEnum _object)

date

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

getTrackingId

@Nullable
public String getTrackingId()

Hashed customer source ID.

Returns:

trackingId

setTrackingId

public void setTrackingId(String trackingId)

metadata

public RedemptionRollback 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 RedemptionRollback amount(Integer amount)

getAmount

@Nullable
public Integer getAmount()

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 RedemptionRollback redemption(String redemption)

getRedemption

@Nullable
public String getRedemption()

Unique redemption ID of the parent redemption.

Returns:

redemption

setRedemption

public void setRedemption(String redemption)

reason

public RedemptionRollback 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)

result

public RedemptionRollback result(RedemptionRollback.ResultEnum result)

getResult

@Nullable
public RedemptionRollback.ResultEnum getResult()

Redemption result.

Returns:

result

setResult

public void setResult(RedemptionRollback.ResultEnum result)

status

public RedemptionRollback status(RedemptionRollback.StatusEnum status)

getStatus

@Nullable
public RedemptionRollback.StatusEnum getStatus()

Redemption status.

Returns:

status

setStatus

public void setStatus(RedemptionRollback.StatusEnum status)

relatedRedemptions

public RedemptionRollback relatedRedemptions(RedemptionRollbackRelatedRedemptions relatedRedemptions)

getRelatedRedemptions

@Nullable
public RedemptionRollbackRelatedRedemptions getRelatedRedemptions()

Get relatedRedemptions

Returns:

relatedRedemptions

setRelatedRedemptions

public void setRelatedRedemptions(RedemptionRollbackRelatedRedemptions relatedRedemptions)

failureCode

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

getOrder

@Nullable
public OrderCalculated getOrder()

Get order

Returns:

order

setOrder

public void setOrder(OrderCalculated order)

channel

public RedemptionRollback channel(RedemptionRollbackChannel channel)

getChannel

@Nullable
public RedemptionRollbackChannel getChannel()

Get channel

Returns:

channel

setChannel

public void setChannel(RedemptionRollbackChannel channel)

customer

public RedemptionRollback customer(SimpleCustomer customer)

getCustomer

@Nullable
public SimpleCustomer getCustomer()

Get customer

Returns:

customer

setCustomer

public void setCustomer(SimpleCustomer customer)

relatedObjectType

public RedemptionRollback relatedObjectType(RedemptionRollback.RelatedObjectTypeEnum relatedObjectType)

getRelatedObjectType

@Nullable
public RedemptionRollback.RelatedObjectTypeEnum getRelatedObjectType()

Defines the related object.

Returns:

relatedObjectType

setRelatedObjectType

public void setRelatedObjectType(RedemptionRollback.RelatedObjectTypeEnum relatedObjectType)

relatedObjectId

public RedemptionRollback relatedObjectId(String relatedObjectId)

getRelatedObjectId

@Nullable
public String getRelatedObjectId()

Unique identifier of the related object. It is assigned by Voucherify, i.e. `v_lfZi4rcEGe0sN9gmnj40bzwK2FH6QUno` for a voucher.

Returns:

relatedObjectId

setRelatedObjectId

public void setRelatedObjectId(String relatedObjectId)

voucher

public RedemptionRollback voucher(Voucher voucher)

getVoucher

@Nullable
public Voucher getVoucher()

Get voucher

Returns:

voucher

setVoucher

public void setVoucher(Voucher voucher)

promotionTier

public RedemptionRollback promotionTier(PromotionTier promotionTier)

getPromotionTier

@Nullable
public PromotionTier getPromotionTier()

Get promotionTier

Returns:

promotionTier

setPromotionTier

public void setPromotionTier(PromotionTier promotionTier)

reward

public RedemptionRollback reward(RedemptionRewardResult reward)

getReward

@Nullable
public RedemptionRewardResult getReward()

Get reward

Returns:

reward

setReward

public void setReward(RedemptionRewardResult reward)

gift

public RedemptionRollback gift(RedemptionRollbackGift gift)

getGift

@Nullable
public RedemptionRollbackGift getGift()

Get gift

Returns:

gift

setGift

public void setGift(RedemptionRollbackGift gift)

loyaltyCard

public RedemptionRollback loyaltyCard(RedemptionRollbackLoyaltyCard loyaltyCard)

getLoyaltyCard

@Nullable
public RedemptionRollbackLoyaltyCard getLoyaltyCard()

Get loyaltyCard

Returns:

loyaltyCard

setLoyaltyCard

public void setLoyaltyCard(RedemptionRollbackLoyaltyCard loyaltyCard)

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

Create an instance of RedemptionRollback given an JSON string

Parameters:

jsonString - JSON string

Returns:

An instance of RedemptionRollback

Throws:

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

toJson

public String toJson()

Convert an instance of RedemptionRollback to an JSON string

Returns:

JSON string