Package io.voucherify.client.model
Class RedemptionsRollbackCreateResponseBody
java.lang.Object
io.voucherify.client.model.RedemptionsRollbackCreateResponseBody
@Generated("org.openapitools.codegen.languages.JavaClientCodegen")
public class RedemptionsRollbackCreateResponseBody
extends Object
Response body schema for **POST** `v1/redemptions/{redemptionId}/rollback`.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classstatic enumThe type of the object represented by the JSONstatic enumDefines the related object.static enumRedemption result.static enumRedemption status. -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final String -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptioncustomer(SimpleCustomer customer) customerId(String customerId) date(OffsetDateTime date) booleanfailureCode(String failureCode) failureMessage(String failureMessage) Create an instance of RedemptionsRollbackCreateResponseBody given an JSON stringFor gift cards, this represents the number of the credits restored to the card in the rolledback redemption.Get channelGet customerUnique customer ID of the redeeming customer.getDate()Timestamp representing the date and time when the object was created.If the result is `FAILURE`, this parameter will provide a generic reason as to why the redemption failed.If the result is `FAILURE`, this parameter will provide a more expanded reason as to why the redemption failed.getGift()Get giftgetId()Unique identifier of the redemption rollback.Get loyaltyCardThe metadata object stores all custom attributes assigned to the redemption.The type of the object represented by the JSONgetOrder()Get orderGet promotionTierSystem generated cause for the redemption being invalid in the context of the provided parameters.Unique redemption ID of the parent redemption.Unique identifier of the related object.Defines the related object.Get relatedRedemptionsRedemption result.Get rewardRedemption status.Hashed customer source ID.Get voucherinthashCode()order(OrderCalculated order) promotionTier(PromotionTier promotionTier) redemption(String redemption) relatedObjectId(String relatedObjectId) relatedObjectType(RedemptionsRollbackCreateResponseBody.RelatedObjectTypeEnum relatedObjectType) relatedRedemptions(RedemptionsRollbackCreateResponseBodyRelatedRedemptions relatedRedemptions) reward(RedemptionRewardResult reward) voidvoidvoidsetCustomer(SimpleCustomer customer) voidsetCustomerId(String customerId) voidsetDate(OffsetDateTime date) voidsetFailureCode(String failureCode) voidsetFailureMessage(String failureMessage) voidvoidvoidvoidsetMetadata(Object metadata) voidvoidsetOrder(OrderCalculated order) voidsetPromotionTier(PromotionTier promotionTier) voidvoidsetRedemption(String redemption) voidsetRelatedObjectId(String relatedObjectId) voidsetRelatedObjectType(RedemptionsRollbackCreateResponseBody.RelatedObjectTypeEnum relatedObjectType) voidsetRelatedRedemptions(RedemptionsRollbackCreateResponseBodyRelatedRedemptions relatedRedemptions) voidvoidsetReward(RedemptionRewardResult reward) voidvoidsetTrackingId(String trackingId) voidsetVoucher(Voucher voucher) toJson()Convert an instance of RedemptionsRollbackCreateResponseBody to an JSON stringtoString()trackingId(String trackingId)
-
Field Details
-
SERIALIZED_NAME_ID
- See Also:
-
SERIALIZED_NAME_OBJECT
- See Also:
-
SERIALIZED_NAME_DATE
- See Also:
-
SERIALIZED_NAME_CUSTOMER_ID
- See Also:
-
SERIALIZED_NAME_TRACKING_ID
- See Also:
-
SERIALIZED_NAME_METADATA
- See Also:
-
SERIALIZED_NAME_AMOUNT
- See Also:
-
SERIALIZED_NAME_REDEMPTION
- See Also:
-
SERIALIZED_NAME_REASON
- See Also:
-
SERIALIZED_NAME_RESULT
- See Also:
-
SERIALIZED_NAME_STATUS
- See Also:
-
SERIALIZED_NAME_RELATED_REDEMPTIONS
- See Also:
-
SERIALIZED_NAME_FAILURE_CODE
- See Also:
-
SERIALIZED_NAME_FAILURE_MESSAGE
- See Also:
-
SERIALIZED_NAME_ORDER
- See Also:
-
SERIALIZED_NAME_CHANNEL
- See Also:
-
SERIALIZED_NAME_CUSTOMER
- See Also:
-
SERIALIZED_NAME_RELATED_OBJECT_TYPE
- See Also:
-
SERIALIZED_NAME_RELATED_OBJECT_ID
- See Also:
-
SERIALIZED_NAME_VOUCHER
- See Also:
-
SERIALIZED_NAME_PROMOTION_TIER
- See Also:
-
SERIALIZED_NAME_REWARD
- See Also:
-
SERIALIZED_NAME_GIFT
- See Also:
-
SERIALIZED_NAME_LOYALTY_CARD
- See Also:
-
openapiFields
-
openapiRequiredFields
-
-
Constructor Details
-
RedemptionsRollbackCreateResponseBody
public RedemptionsRollbackCreateResponseBody()
-
-
Method Details
-
id
-
getId
Unique identifier of the redemption rollback.- Returns:
- id
-
setId
-
_object
public RedemptionsRollbackCreateResponseBody _object(RedemptionsRollbackCreateResponseBody.ObjectEnum _object) -
getObject
The type of the object represented by the JSON- Returns:
- _object
-
setObject
-
date
-
getDate
Timestamp representing the date and time when the object was created. The value is shown in the ISO 8601 format.- Returns:
- date
-
setDate
-
customerId
-
getCustomerId
Unique customer ID of the redeeming customer.- Returns:
- customerId
-
setCustomerId
-
trackingId
-
getTrackingId
Hashed customer source ID.- Returns:
- trackingId
-
setTrackingId
-
metadata
-
getMetadata
The metadata object stores all custom attributes assigned to the redemption.- Returns:
- metadata
-
setMetadata
-
amount
-
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
-
redemption
-
getRedemption
Unique redemption ID of the parent redemption.- Returns:
- redemption
-
setRedemption
-
reason
-
getReason
System generated cause for the redemption being invalid in the context of the provided parameters.- Returns:
- reason
-
setReason
-
result
public RedemptionsRollbackCreateResponseBody result(RedemptionsRollbackCreateResponseBody.ResultEnum result) -
getResult
Redemption result.- Returns:
- result
-
setResult
-
status
public RedemptionsRollbackCreateResponseBody status(RedemptionsRollbackCreateResponseBody.StatusEnum status) -
getStatus
Redemption status.- Returns:
- status
-
setStatus
-
getRelatedRedemptions
Get relatedRedemptions- Returns:
- relatedRedemptions
-
setRelatedRedemptions
public void setRelatedRedemptions(RedemptionsRollbackCreateResponseBodyRelatedRedemptions relatedRedemptions) -
failureCode
-
getFailureCode
If the result is `FAILURE`, this parameter will provide a generic reason as to why the redemption failed.- Returns:
- failureCode
-
setFailureCode
-
failureMessage
-
getFailureMessage
If the result is `FAILURE`, this parameter will provide a more expanded reason as to why the redemption failed.- Returns:
- failureMessage
-
setFailureMessage
-
order
-
getOrder
Get order- Returns:
- order
-
setOrder
-
channel
public RedemptionsRollbackCreateResponseBody channel(RedemptionsRollbackCreateResponseBodyChannel channel) -
getChannel
Get channel- Returns:
- channel
-
setChannel
-
customer
-
getCustomer
Get customer- Returns:
- customer
-
setCustomer
-
getRelatedObjectType
Defines the related object.- Returns:
- relatedObjectType
-
setRelatedObjectType
public void setRelatedObjectType(RedemptionsRollbackCreateResponseBody.RelatedObjectTypeEnum relatedObjectType) -
getRelatedObjectId
Unique identifier of the related object. It is assigned by Voucherify, i.e. `v_lfZi4rcEGe0sN9gmnj40bzwK2FH6QUno` for a voucher.- Returns:
- relatedObjectId
-
setRelatedObjectId
-
voucher
-
getVoucher
Get voucher- Returns:
- voucher
-
setVoucher
-
promotionTier
-
getPromotionTier
Get promotionTier- Returns:
- promotionTier
-
setPromotionTier
-
reward
-
getReward
Get reward- Returns:
- reward
-
setReward
-
gift
-
getGift
Get gift- Returns:
- gift
-
setGift
-
loyaltyCard
public RedemptionsRollbackCreateResponseBody loyaltyCard(RedemptionsRollbackCreateResponseBodyLoyaltyCard loyaltyCard) -
getLoyaltyCard
Get loyaltyCard- Returns:
- loyaltyCard
-
setLoyaltyCard
-
equals
-
hashCode
public int hashCode() -
toString
-
fromJson
Create an instance of RedemptionsRollbackCreateResponseBody given an JSON string- Parameters:
jsonString- JSON string- Returns:
- An instance of RedemptionsRollbackCreateResponseBody
- Throws:
IOException- if the JSON string is invalid with respect to RedemptionsRollbackCreateResponseBody
-
toJson
Convert an instance of RedemptionsRollbackCreateResponseBody to an JSON string- Returns:
- JSON string
-