Package io.voucherify.client.model

Class RedemptionsGetResponseBody

java.lang.Object

io.voucherify.client.model.RedemptionsGetResponseBody

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

RedemptionsGetResponseBody

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RedemptionsGetResponseBody.CustomTypeAdapterFactory
static enum	RedemptionsGetResponseBody.ObjectEnum	Gets or Sets _object
static enum	RedemptionsGetResponseBody.RelatedObjectTypeEnum	Defines the related object.
static enum	RedemptionsGetResponseBody.ResultEnum	Redemption result.
static enum	RedemptionsGetResponseBody.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
RedemptionsGetResponseBody()

Method Summary

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

RedemptionsGetResponseBody

public RedemptionsGetResponseBody()

Method Details

id

public RedemptionsGetResponseBody id(String id)

getId

@Nullable
public String getId()

Get id

Returns:

id

setId

public void setId(String id)

_object

public RedemptionsGetResponseBody _object(RedemptionsGetResponseBody.ObjectEnum _object)

getObject

@Nullable
public RedemptionsGetResponseBody.ObjectEnum getObject()

Get _object

Returns:

_object

setObject

public void setObject(RedemptionsGetResponseBody.ObjectEnum _object)

date

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

getTrackingId

@Nullable
public String getTrackingId()

Hashed customer source ID.

Returns:

trackingId

setTrackingId

public void setTrackingId(String trackingId)

metadata

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

getResult

@Nullable
public RedemptionsGetResponseBody.ResultEnum getResult()

Redemption result.

Returns:

result

setResult

public void setResult(RedemptionsGetResponseBody.ResultEnum result)

status

public RedemptionsGetResponseBody status(RedemptionsGetResponseBody.StatusEnum status)

getStatus

@Nullable
public RedemptionsGetResponseBody.StatusEnum getStatus()

Get status

Returns:

status

setStatus

public void setStatus(RedemptionsGetResponseBody.StatusEnum status)

relatedRedemptions

public RedemptionsGetResponseBody relatedRedemptions(RedemptionsGetResponseBodyRelatedRedemptions relatedRedemptions)

getRelatedRedemptions

@Nullable
public RedemptionsGetResponseBodyRelatedRedemptions getRelatedRedemptions()

Get relatedRedemptions

Returns:

relatedRedemptions

setRelatedRedemptions

public void setRelatedRedemptions(RedemptionsGetResponseBodyRelatedRedemptions relatedRedemptions)

failureCode

public RedemptionsGetResponseBody 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 RedemptionsGetResponseBody 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 RedemptionsGetResponseBody order(RedemptionsGetResponseBodyOrder order)

getOrder

@Nullable
public RedemptionsGetResponseBodyOrder getOrder()

Get order

Returns:

order

setOrder

public void setOrder(RedemptionsGetResponseBodyOrder order)

channel

public RedemptionsGetResponseBody channel(RedemptionsGetResponseBodyChannel channel)

getChannel

@Nullable
public RedemptionsGetResponseBodyChannel getChannel()

Get channel

Returns:

channel

setChannel

public void setChannel(RedemptionsGetResponseBodyChannel channel)

customer

public RedemptionsGetResponseBody customer(RedemptionsGetResponseBodyCustomer customer)

getCustomer

@Nullable
public RedemptionsGetResponseBodyCustomer getCustomer()

Get customer

Returns:

customer

setCustomer

public void setCustomer(RedemptionsGetResponseBodyCustomer customer)

relatedObjectType

public RedemptionsGetResponseBody relatedObjectType(RedemptionsGetResponseBody.RelatedObjectTypeEnum relatedObjectType)

getRelatedObjectType

@Nullable
public RedemptionsGetResponseBody.RelatedObjectTypeEnum getRelatedObjectType()

Defines the related object.

Returns:

relatedObjectType

setRelatedObjectType

public void setRelatedObjectType(RedemptionsGetResponseBody.RelatedObjectTypeEnum relatedObjectType)

relatedObjectId

public RedemptionsGetResponseBody relatedObjectId(String relatedObjectId)

getRelatedObjectId

@Nullable
public String getRelatedObjectId()

Get relatedObjectId

Returns:

relatedObjectId

setRelatedObjectId

public void setRelatedObjectId(String relatedObjectId)

promotionTier

public RedemptionsGetResponseBody promotionTier(RedemptionsGetResponseBodyPromotionTier promotionTier)

getPromotionTier

@Nullable
public RedemptionsGetResponseBodyPromotionTier getPromotionTier()

Get promotionTier

Returns:

promotionTier

setPromotionTier

public void setPromotionTier(RedemptionsGetResponseBodyPromotionTier promotionTier)

reward

public RedemptionsGetResponseBody reward(RedemptionRewardResult reward)

getReward

@Nullable
public RedemptionRewardResult getReward()

Get reward

Returns:

reward

setReward

public void setReward(RedemptionRewardResult reward)

gift

public RedemptionsGetResponseBody gift(RedemptionsGetResponseBodyGift gift)

getGift

@Nullable
public RedemptionsGetResponseBodyGift getGift()

Get gift

Returns:

gift

setGift

public void setGift(RedemptionsGetResponseBodyGift gift)

loyaltyCard

public RedemptionsGetResponseBody loyaltyCard(RedemptionsGetResponseBodyLoyaltyCard loyaltyCard)

getLoyaltyCard

@Nullable
public RedemptionsGetResponseBodyLoyaltyCard getLoyaltyCard()

Get loyaltyCard

Returns:

loyaltyCard

setLoyaltyCard

public void setLoyaltyCard(RedemptionsGetResponseBodyLoyaltyCard loyaltyCard)

voucher

public RedemptionsGetResponseBody voucher(RedemptionsGetResponseBodyVoucher voucher)

getVoucher

@Nullable
public RedemptionsGetResponseBodyVoucher getVoucher()

Get voucher

Returns:

voucher

setVoucher

public void setVoucher(RedemptionsGetResponseBodyVoucher voucher)

reason

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

Create an instance of RedemptionsGetResponseBody given an JSON string

Parameters:

jsonString - JSON string

Returns:

An instance of RedemptionsGetResponseBody

Throws:

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

toJson

public String toJson()

Convert an instance of RedemptionsGetResponseBody to an JSON string

Returns:

JSON string