com.squareup.square.models

Class UpdateOrderRequest

java.lang.Object

com.squareup.square.models.UpdateOrderRequest

public class UpdateOrderRequest
extends Object

This is a model class for UpdateOrderRequest type.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UpdateOrderRequest.Builder Class to build instances of UpdateOrderRequest.

Constructor Summary

Constructors

Modifier	Constructor and Description
	UpdateOrderRequest(Order order, List<String> fieldsToClear, String idempotencyKey) Initialization constructor.
protected	UpdateOrderRequest(Order order, io.apimatic.core.types.OptionalNullable<List<String>> fieldsToClear, io.apimatic.core.types.OptionalNullable<String> idempotencyKey) Internal initialization constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
List<String>	getFieldsToClear() Getter for FieldsToClear.
String	getIdempotencyKey() Getter for IdempotencyKey.
Order	getOrder() Getter for Order.
int	hashCode()
protected io.apimatic.core.types.OptionalNullable<List<String>>	internalGetFieldsToClear() Internal Getter for FieldsToClear.
protected io.apimatic.core.types.OptionalNullable<String>	internalGetIdempotencyKey() Internal Getter for IdempotencyKey.
UpdateOrderRequest.Builder	toBuilder() Builds a new UpdateOrderRequest.Builder object.
String	toString() Converts this UpdateOrderRequest into string format.

Methods inherited from class java.lang.Object

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

Constructor Detail

UpdateOrderRequest

public UpdateOrderRequest(Order order,
                          List<String> fieldsToClear,
                          String idempotencyKey)

Initialization constructor.

Parameters:

order - Order value for order.

fieldsToClear - List of String value for fieldsToClear.

idempotencyKey - String value for idempotencyKey.

UpdateOrderRequest

protected UpdateOrderRequest(Order order,
                             io.apimatic.core.types.OptionalNullable<List<String>> fieldsToClear,
                             io.apimatic.core.types.OptionalNullable<String> idempotencyKey)

Internal initialization constructor.

Method Detail

getOrder

public Order getOrder()

Getter for Order. Contains all information related to a single order to process with Square, including line items that specify the products to purchase. `Order` objects also include information about any associated tenders, refunds, and returns. All Connect V2 Transactions have all been converted to Orders including all associated itemization data.

Returns:

Returns the Order

internalGetFieldsToClear

protected io.apimatic.core.types.OptionalNullable<List<String>> internalGetFieldsToClear()

Internal Getter for FieldsToClear. The [dot notation paths](https://developer.squareup.com/docs/orders-api/manage-orders/update-orders#identifying-fields-to-delete) fields to clear. For example, `line_items[uid].note`. For more information, see [Deleting fields](https://developer.squareup.com/docs/orders-api/manage-orders/update-orders#deleting-fields).

Returns:

Returns the Internal List of String

getFieldsToClear

public List<String> getFieldsToClear()

Getter for FieldsToClear. The [dot notation paths](https://developer.squareup.com/docs/orders-api/manage-orders/update-orders#identifying-fields-to-delete) fields to clear. For example, `line_items[uid].note`. For more information, see [Deleting fields](https://developer.squareup.com/docs/orders-api/manage-orders/update-orders#deleting-fields).

Returns:

Returns the List of String

internalGetIdempotencyKey

protected io.apimatic.core.types.OptionalNullable<String> internalGetIdempotencyKey()

Internal Getter for IdempotencyKey. A value you specify that uniquely identifies this update request. If you are unsure whether a particular update was applied to an order successfully, you can reattempt it with the same idempotency key without worrying about creating duplicate updates to the order. The latest order version is returned. For more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency).

Returns:

Returns the Internal String

getIdempotencyKey

public String getIdempotencyKey()

Getter for IdempotencyKey. A value you specify that uniquely identifies this update request. If you are unsure whether a particular update was applied to an order successfully, you can reattempt it with the same idempotency key without worrying about creating duplicate updates to the order. The latest order version is returned. For more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency).

Returns:

Returns the String

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Converts this UpdateOrderRequest into string format.

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public UpdateOrderRequest.Builder toBuilder()

Builds a new UpdateOrderRequest.Builder object. Creates the instance with the state of the current model.

Returns:

a new UpdateOrderRequest.Builder object