Package io.voucherify.client.model

Class OrdersUpdateRequestBody

java.lang.Object

io.voucherify.client.model.OrdersUpdateRequestBody

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

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	OrdersUpdateRequestBody.CustomTypeAdapterFactory
static enum	OrdersUpdateRequestBody.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_CREATED_AT
static final String	SERIALIZED_NAME_CUSTOMER
static final String	SERIALIZED_NAME_DISCOUNT_AMOUNT
static final String	SERIALIZED_NAME_INITIAL_AMOUNT
static final String	SERIALIZED_NAME_ITEMS
static final String	SERIALIZED_NAME_METADATA
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

Constructor Summary

Constructors

Constructor	Description
OrdersUpdateRequestBody()

Method Summary

Modifier and Type	Method	Description
OrdersUpdateRequestBody	addItemsItem(OrderItem itemsItem)
OrdersUpdateRequestBody	amount(Integer amount)
OrdersUpdateRequestBody	createdAt(OffsetDateTime createdAt)
OrdersUpdateRequestBody	customer(Customer customer)
OrdersUpdateRequestBody	discountAmount(Integer discountAmount)
boolean	equals(Object o)
static OrdersUpdateRequestBody	fromJson(String jsonString)	Create an instance of OrdersUpdateRequestBody given an JSON string
Integer	getAmount()	A positive integer in the smallest currency unit (e.g.
OffsetDateTime	getCreatedAt()	Timestamp representing the date and time when the order was created.
Customer	getCustomer()	Get customer
Integer	getDiscountAmount()	Sum of all order-level discounts applied to the order.
Integer	getInitialAmount()	A positive integer in the smallest currency unit (e.g.
List<OrderItem>	getItems()	Array of items applied to the order.
Object	getMetadata()	A set of custom key/value pairs that you can attach to an order.
Referrer	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.
OrdersUpdateRequestBody.StatusEnum	getStatus()	The order status.
int	hashCode()
OrdersUpdateRequestBody	initialAmount(Integer initialAmount)
OrdersUpdateRequestBody	items(List<OrderItem> items)
OrdersUpdateRequestBody	metadata(Object metadata)
OrdersUpdateRequestBody	referrer(Referrer referrer)
OrdersUpdateRequestBody	referrerId(String referrerId)
void	setAmount(Integer amount)
void	setCreatedAt(OffsetDateTime createdAt)
void	setCustomer(Customer customer)
void	setDiscountAmount(Integer discountAmount)
void	setInitialAmount(Integer initialAmount)
void	setItems(List<OrderItem> items)
void	setMetadata(Object metadata)
void	setReferrer(Referrer referrer)
void	setReferrerId(String referrerId)
void	setSourceId(String sourceId)
void	setStatus(OrdersUpdateRequestBody.StatusEnum status)
OrdersUpdateRequestBody	sourceId(String sourceId)
OrdersUpdateRequestBody	status(OrdersUpdateRequestBody.StatusEnum status)
String	toJson()	Convert an instance of OrdersUpdateRequestBody to an JSON string
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

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

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_CREATED_AT

public static final String SERIALIZED_NAME_CREATED_AT

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

openapiFields

public static HashSet<String> openapiFields

openapiRequiredFields

public static HashSet<String> openapiRequiredFields

Constructor Details

OrdersUpdateRequestBody

public OrdersUpdateRequestBody()

Method Details

sourceId

public OrdersUpdateRequestBody 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 OrdersUpdateRequestBody status(OrdersUpdateRequestBody.StatusEnum status)

getStatus

@Nullable
public OrdersUpdateRequestBody.StatusEnum getStatus()

The order status.

Returns:

status

setStatus

public void setStatus(OrdersUpdateRequestBody.StatusEnum status)

amount

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

items

public OrdersUpdateRequestBody items(List<OrderItem> items)

addItemsItem

public OrdersUpdateRequestBody addItemsItem(OrderItem itemsItem)

getItems

@Nullable
public List<OrderItem> getItems()

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

Returns:

items

setItems

public void setItems(List<OrderItem> items)

metadata

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

createdAt

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

referrerId

public OrdersUpdateRequestBody referrerId(String referrerId)

getReferrerId

@Nullable
public String getReferrerId()

Unique referrer ID.

Returns:

referrerId

setReferrerId

public void setReferrerId(String referrerId)

customer

public OrdersUpdateRequestBody customer(Customer customer)

getCustomer

@Nullable
public Customer getCustomer()

Get customer

Returns:

customer

setCustomer

public void setCustomer(Customer customer)

referrer

public OrdersUpdateRequestBody referrer(Referrer referrer)

getReferrer

@Nullable
public Referrer getReferrer()

Get referrer

Returns:

referrer

setReferrer

public void setReferrer(Referrer referrer)

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

Create an instance of OrdersUpdateRequestBody given an JSON string

Parameters:

jsonString - JSON string

Returns:

An instance of OrdersUpdateRequestBody

Throws:

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

toJson

public String toJson()

Convert an instance of OrdersUpdateRequestBody to an JSON string

Returns:

JSON string