Package io.voucherify.client.model

Class LoyaltiesMembersRedemptionRedeemResponseBody

java.lang.Object

io.voucherify.client.model.LoyaltiesMembersRedemptionRedeemResponseBody

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

Response body schema for **POST** `v1/loyalties/{campaignId}/members/{memberId}/redemption` and for **POST** `v1/loyalties/members/{memberId}/redemption`.

Nested Class Summary

Nested Classes

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

Method Summary

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

LoyaltiesMembersRedemptionRedeemResponseBody

public LoyaltiesMembersRedemptionRedeemResponseBody()

Method Details

id

public LoyaltiesMembersRedemptionRedeemResponseBody id(String id)

getId

@Nullable
public String getId()

Unique redemption ID.

Returns:

id

setId

public void setId(String id)

_object

public LoyaltiesMembersRedemptionRedeemResponseBody _object(LoyaltiesMembersRedemptionRedeemResponseBody.ObjectEnum _object)

getObject

@Nullable
public LoyaltiesMembersRedemptionRedeemResponseBody.ObjectEnum getObject()

The type of the object represented by the JSON

Returns:

_object

setObject

public void setObject(LoyaltiesMembersRedemptionRedeemResponseBody.ObjectEnum _object)

date

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

getTrackingId

@Nullable
public String getTrackingId()

Hashed customer source ID.

Returns:

trackingId

setTrackingId

public void setTrackingId(String trackingId)

metadata

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

getResult

@Nullable
public LoyaltiesMembersRedemptionRedeemResponseBody.ResultEnum getResult()

Redemption result.

Returns:

result

setResult

public void setResult(LoyaltiesMembersRedemptionRedeemResponseBody.ResultEnum result)

status

public LoyaltiesMembersRedemptionRedeemResponseBody status(LoyaltiesMembersRedemptionRedeemResponseBody.StatusEnum status)

getStatus

@Nullable
public LoyaltiesMembersRedemptionRedeemResponseBody.StatusEnum getStatus()

Redemption status.

Returns:

status

setStatus

public void setStatus(LoyaltiesMembersRedemptionRedeemResponseBody.StatusEnum status)

relatedRedemptions

public LoyaltiesMembersRedemptionRedeemResponseBody relatedRedemptions(LoyaltiesMembersRedemptionRedeemResponseBodyRelatedRedemptions relatedRedemptions)

getRelatedRedemptions

@Nullable
public LoyaltiesMembersRedemptionRedeemResponseBodyRelatedRedemptions getRelatedRedemptions()

Get relatedRedemptions

Returns:

relatedRedemptions

setRelatedRedemptions

public void setRelatedRedemptions(LoyaltiesMembersRedemptionRedeemResponseBodyRelatedRedemptions relatedRedemptions)

failureCode

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

getOrder

@Nullable
public OrderCalculated getOrder()

Get order

Returns:

order

setOrder

public void setOrder(OrderCalculated order)

channel

public LoyaltiesMembersRedemptionRedeemResponseBody channel(LoyaltiesMembersRedemptionRedeemResponseBodyChannel channel)

getChannel

@Nullable
public LoyaltiesMembersRedemptionRedeemResponseBodyChannel getChannel()

Get channel

Returns:

channel

setChannel

public void setChannel(LoyaltiesMembersRedemptionRedeemResponseBodyChannel channel)

customer

public LoyaltiesMembersRedemptionRedeemResponseBody customer(SimpleCustomer customer)

getCustomer

@Nullable
public SimpleCustomer getCustomer()

Get customer

Returns:

customer

setCustomer

public void setCustomer(SimpleCustomer customer)

relatedObjectType

public LoyaltiesMembersRedemptionRedeemResponseBody relatedObjectType(LoyaltiesMembersRedemptionRedeemResponseBody.RelatedObjectTypeEnum relatedObjectType)

getRelatedObjectType

@Nullable
public LoyaltiesMembersRedemptionRedeemResponseBody.RelatedObjectTypeEnum getRelatedObjectType()

Defines the related object.

Returns:

relatedObjectType

setRelatedObjectType

public void setRelatedObjectType(LoyaltiesMembersRedemptionRedeemResponseBody.RelatedObjectTypeEnum relatedObjectType)

relatedObjectId

public LoyaltiesMembersRedemptionRedeemResponseBody 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 LoyaltiesMembersRedemptionRedeemResponseBody promotionTier(PromotionTier promotionTier)

getPromotionTier

@Nullable
public PromotionTier getPromotionTier()

Get promotionTier

Returns:

promotionTier

setPromotionTier

public void setPromotionTier(PromotionTier promotionTier)

reward

public LoyaltiesMembersRedemptionRedeemResponseBody reward(RedemptionRewardResult reward)

getReward

@Nullable
public RedemptionRewardResult getReward()

Get reward

Returns:

reward

setReward

public void setReward(RedemptionRewardResult reward)

gift

public LoyaltiesMembersRedemptionRedeemResponseBody gift(LoyaltiesMembersRedemptionRedeemResponseBodyGift gift)

getGift

@Nullable
public LoyaltiesMembersRedemptionRedeemResponseBodyGift getGift()

Get gift

Returns:

gift

setGift

public void setGift(LoyaltiesMembersRedemptionRedeemResponseBodyGift gift)

loyaltyCard

public LoyaltiesMembersRedemptionRedeemResponseBody loyaltyCard(LoyaltiesMembersRedemptionRedeemResponseBodyLoyaltyCard loyaltyCard)

getLoyaltyCard

@Nullable
public LoyaltiesMembersRedemptionRedeemResponseBodyLoyaltyCard getLoyaltyCard()

Get loyaltyCard

Returns:

loyaltyCard

setLoyaltyCard

public void setLoyaltyCard(LoyaltiesMembersRedemptionRedeemResponseBodyLoyaltyCard loyaltyCard)

voucher

public LoyaltiesMembersRedemptionRedeemResponseBody voucher(LoyaltiesMembersRedemptionRedeemResponseBodyVoucher voucher)

getVoucher

@Nullable
public LoyaltiesMembersRedemptionRedeemResponseBodyVoucher getVoucher()

Get voucher

Returns:

voucher

setVoucher

public void setVoucher(LoyaltiesMembersRedemptionRedeemResponseBodyVoucher 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 LoyaltiesMembersRedemptionRedeemResponseBody fromJson(String jsonString)
                                                             throws IOException

Create an instance of LoyaltiesMembersRedemptionRedeemResponseBody given an JSON string

Parameters:

jsonString - JSON string

Returns:

An instance of LoyaltiesMembersRedemptionRedeemResponseBody

Throws:

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

toJson

public String toJson()

Convert an instance of LoyaltiesMembersRedemptionRedeemResponseBody to an JSON string

Returns:

JSON string