Package io.voucherify.client.model

Class OrdersUpdateResponseBody

java.lang.Object

io.voucherify.client.model.OrdersUpdateResponseBody

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

Response body schema for **PUT** `v1/orders/{orderId}`.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	OrdersUpdateResponseBody.CustomTypeAdapterFactory
static enum	OrdersUpdateResponseBody.ObjectEnum	The type of the object represented by JSON.
static enum	OrdersUpdateResponseBody.StatusEnum	The order 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_APPLIED_DISCOUNT_AMOUNT
static final String	SERIALIZED_NAME_CREATED_AT
static final String	SERIALIZED_NAME_CUSTOMER
static final String	SERIALIZED_NAME_CUSTOMER_ID
static final String	SERIALIZED_NAME_DISCOUNT_AMOUNT
static final String	SERIALIZED_NAME_ID
static final String	SERIALIZED_NAME_INITIAL_AMOUNT
static final String	SERIALIZED_NAME_ITEMS
static final String	SERIALIZED_NAME_ITEMS_APPLIED_DISCOUNT_AMOUNT
static final String	SERIALIZED_NAME_ITEMS_DISCOUNT_AMOUNT
static final String	SERIALIZED_NAME_METADATA
static final String	SERIALIZED_NAME_OBJECT
static final String	SERIALIZED_NAME_REDEMPTIONS
static final String	SERIALIZED_NAME_REFERRER
static final String	SERIALIZED_NAME_REFERRER_ID
static final String	SERIALIZED_NAME_SOURCE_ID
static final String	SERIALIZED_NAME_STATUS
static final String	SERIALIZED_NAME_TOTAL_AMOUNT
static final String	SERIALIZED_NAME_TOTAL_APPLIED_DISCOUNT_AMOUNT
static final String	SERIALIZED_NAME_TOTAL_DISCOUNT_AMOUNT
static final String	SERIALIZED_NAME_UPDATED_AT

Constructor Summary

Constructors

Constructor	Description
OrdersUpdateResponseBody()

Method Summary

Modifier and Type	Method	Description
OrdersUpdateResponseBody	_object(OrdersUpdateResponseBody.ObjectEnum _object)
OrdersUpdateResponseBody	addItemsItem(OrderCalculatedItem itemsItem)
OrdersUpdateResponseBody	amount(Integer amount)
OrdersUpdateResponseBody	appliedDiscountAmount(Integer appliedDiscountAmount)
OrdersUpdateResponseBody	createdAt(OffsetDateTime createdAt)
OrdersUpdateResponseBody	customer(CustomerId customer)
OrdersUpdateResponseBody	customerId(String customerId)
OrdersUpdateResponseBody	discountAmount(Integer discountAmount)
boolean	equals(Object o)
static OrdersUpdateResponseBody	fromJson(String jsonString)	Create an instance of OrdersUpdateResponseBody given an JSON string
Integer	getAmount()	A positive integer in the smallest currency unit (e.g.
Integer	getAppliedDiscountAmount()	This field shows the order-level discount applied.
OffsetDateTime	getCreatedAt()	Timestamp representing the date and time when the order was created.
CustomerId	getCustomer()	Get customer
String	getCustomerId()	Unique customer ID of the customer making the purchase.
Integer	getDiscountAmount()	Sum of all order-level discounts applied to the order.
String	getId()	Unique ID assigned by Voucherify of an existing order that will be linked to the redemption of this request.
Integer	getInitialAmount()	A positive integer in the smallest currency unit (e.g.
List<OrderCalculatedItem>	getItems()	Array of items applied to the order.
Integer	getItemsAppliedDiscountAmount()	Sum of all product-specific discounts applied in a particular request.
Integer	getItemsDiscountAmount()	Sum of all product-specific discounts applied to the order.
Object	getMetadata()	A set of custom key/value pairs that you can attach to an order.
OrdersUpdateResponseBody.ObjectEnum	getObject()	The type of the object represented by JSON.
Map<String,OrderRedemptionsEntry>	getRedemptions()	Get redemptions
ReferrerId	getReferrer()	Get referrer
String	getReferrerId()	Unique referrer ID.
String	getSourceId()	Unique source ID of an existing order that will be linked to the redemption of this request.
OrdersUpdateResponseBody.StatusEnum	getStatus()	The order status.
Integer	getTotalAmount()	Order amount after undoing all the discounts through the rollback redemption.
Integer	getTotalAppliedDiscountAmount()	Sum of all order-level AND all product-specific discounts applied in a particular request.
Integer	getTotalDiscountAmount()	Sum of all order-level AND all product-specific discounts applied to the order.
OffsetDateTime	getUpdatedAt()	Timestamp representing the date and time when the order was last updated in ISO 8601 format.
int	hashCode()
OrdersUpdateResponseBody	id(String id)
OrdersUpdateResponseBody	initialAmount(Integer initialAmount)
OrdersUpdateResponseBody	items(List<OrderCalculatedItem> items)
OrdersUpdateResponseBody	itemsAppliedDiscountAmount(Integer itemsAppliedDiscountAmount)
OrdersUpdateResponseBody	itemsDiscountAmount(Integer itemsDiscountAmount)
OrdersUpdateResponseBody	metadata(Object metadata)
OrdersUpdateResponseBody	putRedemptionsItem(String key, OrderRedemptionsEntry redemptionsItem)
OrdersUpdateResponseBody	redemptions(Map<String,OrderRedemptionsEntry> redemptions)
OrdersUpdateResponseBody	referrer(ReferrerId referrer)
OrdersUpdateResponseBody	referrerId(String referrerId)
void	setAmount(Integer amount)
void	setAppliedDiscountAmount(Integer appliedDiscountAmount)
void	setCreatedAt(OffsetDateTime createdAt)
void	setCustomer(CustomerId customer)
void	setCustomerId(String customerId)
void	setDiscountAmount(Integer discountAmount)
void	setId(String id)
void	setInitialAmount(Integer initialAmount)
void	setItems(List<OrderCalculatedItem> items)
void	setItemsAppliedDiscountAmount(Integer itemsAppliedDiscountAmount)
void	setItemsDiscountAmount(Integer itemsDiscountAmount)
void	setMetadata(Object metadata)
void	setObject(OrdersUpdateResponseBody.ObjectEnum _object)
void	setRedemptions(Map<String,OrderRedemptionsEntry> redemptions)
void	setReferrer(ReferrerId referrer)
void	setReferrerId(String referrerId)
void	setSourceId(String sourceId)
void	setStatus(OrdersUpdateResponseBody.StatusEnum status)
void	setTotalAmount(Integer totalAmount)
void	setTotalAppliedDiscountAmount(Integer totalAppliedDiscountAmount)
void	setTotalDiscountAmount(Integer totalDiscountAmount)
void	setUpdatedAt(OffsetDateTime updatedAt)
OrdersUpdateResponseBody	sourceId(String sourceId)
OrdersUpdateResponseBody	status(OrdersUpdateResponseBody.StatusEnum status)
String	toJson()	Convert an instance of OrdersUpdateResponseBody to an JSON string
String	toString()
OrdersUpdateResponseBody	totalAmount(Integer totalAmount)
OrdersUpdateResponseBody	totalAppliedDiscountAmount(Integer totalAppliedDiscountAmount)
OrdersUpdateResponseBody	totalDiscountAmount(Integer totalDiscountAmount)
OrdersUpdateResponseBody	updatedAt(OffsetDateTime updatedAt)

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_SOURCE_ID

public static final String SERIALIZED_NAME_SOURCE_ID

See Also:

• Constant Field Values

SERIALIZED_NAME_STATUS

public static final String SERIALIZED_NAME_STATUS

See Also:

• Constant Field Values

SERIALIZED_NAME_AMOUNT

public static final String SERIALIZED_NAME_AMOUNT

See Also:

• Constant Field Values

SERIALIZED_NAME_INITIAL_AMOUNT

public static final String SERIALIZED_NAME_INITIAL_AMOUNT

See Also:

• Constant Field Values

SERIALIZED_NAME_DISCOUNT_AMOUNT

public static final String SERIALIZED_NAME_DISCOUNT_AMOUNT

See Also:

• Constant Field Values

SERIALIZED_NAME_ITEMS_DISCOUNT_AMOUNT

public static final String SERIALIZED_NAME_ITEMS_DISCOUNT_AMOUNT

See Also:

• Constant Field Values

SERIALIZED_NAME_TOTAL_DISCOUNT_AMOUNT

public static final String SERIALIZED_NAME_TOTAL_DISCOUNT_AMOUNT

See Also:

• Constant Field Values

SERIALIZED_NAME_TOTAL_AMOUNT

public static final String SERIALIZED_NAME_TOTAL_AMOUNT

See Also:

• Constant Field Values

SERIALIZED_NAME_APPLIED_DISCOUNT_AMOUNT

public static final String SERIALIZED_NAME_APPLIED_DISCOUNT_AMOUNT

See Also:

• Constant Field Values

SERIALIZED_NAME_ITEMS_APPLIED_DISCOUNT_AMOUNT

public static final String SERIALIZED_NAME_ITEMS_APPLIED_DISCOUNT_AMOUNT

See Also:

• Constant Field Values

SERIALIZED_NAME_TOTAL_APPLIED_DISCOUNT_AMOUNT

public static final String SERIALIZED_NAME_TOTAL_APPLIED_DISCOUNT_AMOUNT

See Also:

• Constant Field Values

SERIALIZED_NAME_ITEMS

public static final String SERIALIZED_NAME_ITEMS

See Also:

• Constant Field Values

SERIALIZED_NAME_METADATA

public static final String SERIALIZED_NAME_METADATA

See Also:

• Constant Field Values

SERIALIZED_NAME_OBJECT

public static final String SERIALIZED_NAME_OBJECT

See Also:

• Constant Field Values

SERIALIZED_NAME_CREATED_AT

public static final String SERIALIZED_NAME_CREATED_AT

See Also:

• Constant Field Values

SERIALIZED_NAME_UPDATED_AT

public static final String SERIALIZED_NAME_UPDATED_AT

See Also:

• Constant Field Values

SERIALIZED_NAME_CUSTOMER_ID

public static final String SERIALIZED_NAME_CUSTOMER_ID

See Also:

• Constant Field Values

SERIALIZED_NAME_REFERRER_ID

public static final String SERIALIZED_NAME_REFERRER_ID

See Also:

• Constant Field Values

SERIALIZED_NAME_CUSTOMER

public static final String SERIALIZED_NAME_CUSTOMER

See Also:

• Constant Field Values

SERIALIZED_NAME_REFERRER

public static final String SERIALIZED_NAME_REFERRER

See Also:

• Constant Field Values

SERIALIZED_NAME_REDEMPTIONS

public static final String SERIALIZED_NAME_REDEMPTIONS

See Also:

• Constant Field Values

openapiFields

public static HashSet<String> openapiFields

openapiRequiredFields

public static HashSet<String> openapiRequiredFields

Constructor Details

OrdersUpdateResponseBody

public OrdersUpdateResponseBody()

Method Details

id

public OrdersUpdateResponseBody id(String id)

getId

@Nullable
public String getId()

Unique ID assigned by Voucherify of an existing order that will be linked to the redemption of this request.

Returns:

id

setId

public void setId(String id)

sourceId

public OrdersUpdateResponseBody sourceId(String sourceId)

getSourceId

@Nullable
public String getSourceId()

Unique source ID of an existing order that will be linked to the redemption of this request.

Returns:

sourceId

setSourceId

public void setSourceId(String sourceId)

status

public OrdersUpdateResponseBody status(OrdersUpdateResponseBody.StatusEnum status)

getStatus

@Nullable
public OrdersUpdateResponseBody.StatusEnum getStatus()

The order status.

Returns:

status

setStatus

public void setStatus(OrdersUpdateResponseBody.StatusEnum status)

amount

public OrdersUpdateResponseBody amount(Integer amount)

getAmount

@Nullable
public Integer getAmount()

A positive integer in the smallest currency unit (e.g. 100 cents for $1.00) representing the total amount of the order. This is the sum of the order items' amounts.

Returns:

amount

setAmount

public void setAmount(Integer amount)

initialAmount

public OrdersUpdateResponseBody initialAmount(Integer initialAmount)

getInitialAmount

@Nullable
public Integer getInitialAmount()

A positive integer in the smallest currency unit (e.g. 100 cents for $1.00) representing the total amount of the order. This is the sum of the order items' amounts.

Returns:

initialAmount

setInitialAmount

public void setInitialAmount(Integer initialAmount)

discountAmount

public OrdersUpdateResponseBody discountAmount(Integer discountAmount)

getDiscountAmount

@Nullable
public Integer getDiscountAmount()

Sum of all order-level discounts applied to the order.

Returns:

discountAmount

setDiscountAmount

public void setDiscountAmount(Integer discountAmount)

itemsDiscountAmount

public OrdersUpdateResponseBody itemsDiscountAmount(Integer itemsDiscountAmount)

getItemsDiscountAmount

@Nullable
public Integer getItemsDiscountAmount()

Sum of all product-specific discounts applied to the order.

Returns:

itemsDiscountAmount

setItemsDiscountAmount

public void setItemsDiscountAmount(Integer itemsDiscountAmount)

totalDiscountAmount

public OrdersUpdateResponseBody totalDiscountAmount(Integer totalDiscountAmount)

getTotalDiscountAmount

@Nullable
public Integer getTotalDiscountAmount()

Sum of all order-level AND all product-specific discounts applied to the order.

Returns:

totalDiscountAmount

setTotalDiscountAmount

public void setTotalDiscountAmount(Integer totalDiscountAmount)

totalAmount

public OrdersUpdateResponseBody totalAmount(Integer totalAmount)

getTotalAmount

@Nullable
public Integer getTotalAmount()

Order amount after undoing all the discounts through the rollback redemption.

Returns:

totalAmount

setTotalAmount

public void setTotalAmount(Integer totalAmount)

appliedDiscountAmount

public OrdersUpdateResponseBody appliedDiscountAmount(Integer appliedDiscountAmount)

getAppliedDiscountAmount

@Nullable
public Integer getAppliedDiscountAmount()

This field shows the order-level discount applied.

Returns:

appliedDiscountAmount

setAppliedDiscountAmount

public void setAppliedDiscountAmount(Integer appliedDiscountAmount)

itemsAppliedDiscountAmount

public OrdersUpdateResponseBody itemsAppliedDiscountAmount(Integer itemsAppliedDiscountAmount)

getItemsAppliedDiscountAmount

@Nullable
public Integer getItemsAppliedDiscountAmount()

Sum of all product-specific discounts applied in a particular request. `sum(items, i => i.applied_discount_amount)`

Returns:

itemsAppliedDiscountAmount

setItemsAppliedDiscountAmount

public void setItemsAppliedDiscountAmount(Integer itemsAppliedDiscountAmount)

totalAppliedDiscountAmount

public OrdersUpdateResponseBody totalAppliedDiscountAmount(Integer totalAppliedDiscountAmount)

getTotalAppliedDiscountAmount

@Nullable
public Integer getTotalAppliedDiscountAmount()

Sum of all order-level AND all product-specific discounts applied in a particular request. `total_applied_discount_amount` = `applied_discount_amount` + `items_applied_discount_amount`

Returns:

totalAppliedDiscountAmount

setTotalAppliedDiscountAmount

public void setTotalAppliedDiscountAmount(Integer totalAppliedDiscountAmount)

items

public OrdersUpdateResponseBody items(List<OrderCalculatedItem> items)

addItemsItem

public OrdersUpdateResponseBody addItemsItem(OrderCalculatedItem itemsItem)

getItems

@Nullable
public List<OrderCalculatedItem> getItems()

Array of items applied to the order. It can include up 500 items.

Returns:

items

setItems

public void setItems(List<OrderCalculatedItem> items)

metadata

public OrdersUpdateResponseBody metadata(Object metadata)

getMetadata

@Nullable
public Object getMetadata()

A set of custom key/value pairs that you can attach to an order. It can be useful for storing additional information about the order in a structured format.

Returns:

metadata

setMetadata

public void setMetadata(Object metadata)

_object

public OrdersUpdateResponseBody _object(OrdersUpdateResponseBody.ObjectEnum _object)

getObject

@Nullable
public OrdersUpdateResponseBody.ObjectEnum getObject()

The type of the object represented by JSON.

Returns:

_object

setObject

public void setObject(OrdersUpdateResponseBody.ObjectEnum _object)

createdAt

public OrdersUpdateResponseBody createdAt(OffsetDateTime createdAt)

getCreatedAt

@Nullable
public OffsetDateTime getCreatedAt()

Timestamp representing the date and time when the order was created. The value is shown in the ISO 8601 format.

Returns:

createdAt

setCreatedAt

public void setCreatedAt(OffsetDateTime createdAt)

updatedAt

public OrdersUpdateResponseBody updatedAt(OffsetDateTime updatedAt)

getUpdatedAt

@Nullable
public OffsetDateTime getUpdatedAt()

Timestamp representing the date and time when the order was last updated in ISO 8601 format.

Returns:

updatedAt

setUpdatedAt

public void setUpdatedAt(OffsetDateTime updatedAt)

customerId

public OrdersUpdateResponseBody customerId(String customerId)

getCustomerId

@Nullable
public String getCustomerId()

Unique customer ID of the customer making the purchase.

Returns:

customerId

setCustomerId

public void setCustomerId(String customerId)

referrerId

public OrdersUpdateResponseBody referrerId(String referrerId)

getReferrerId

@Nullable
public String getReferrerId()

Unique referrer ID.

Returns:

referrerId

setReferrerId

public void setReferrerId(String referrerId)

customer

public OrdersUpdateResponseBody customer(CustomerId customer)

getCustomer

@Nullable
public CustomerId getCustomer()

Get customer

Returns:

customer

setCustomer

public void setCustomer(CustomerId customer)

referrer

public OrdersUpdateResponseBody referrer(ReferrerId referrer)

getReferrer

@Nullable
public ReferrerId getReferrer()

Get referrer

Returns:

referrer

setReferrer

public void setReferrer(ReferrerId referrer)

redemptions

public OrdersUpdateResponseBody redemptions(Map<String,OrderRedemptionsEntry> redemptions)

putRedemptionsItem

public OrdersUpdateResponseBody putRedemptionsItem(String key,
 OrderRedemptionsEntry redemptionsItem)

getRedemptions

@Nullable
public Map<String,OrderRedemptionsEntry> getRedemptions()

Get redemptions

Returns:

redemptions

setRedemptions

public void setRedemptions(Map<String,OrderRedemptionsEntry> redemptions)

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

Create an instance of OrdersUpdateResponseBody given an JSON string

Parameters:

jsonString - JSON string

Returns:

An instance of OrdersUpdateResponseBody

Throws:

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

toJson

public String toJson()

Convert an instance of OrdersUpdateResponseBody to an JSON string

Returns:

JSON string