com.squareup.square.legacy.models.UpdateOrderRequest Maven / Gradle / Ivy
package com.squareup.square.legacy.models;
import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonGetter;
import com.fasterxml.jackson.annotation.JsonIgnore;
import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.databind.annotation.JsonSerialize;
import io.apimatic.core.types.OptionalNullable;
import java.util.List;
import java.util.Objects;
/**
* This is a model class for UpdateOrderRequest type.
*/
public class UpdateOrderRequest {
private final Order order;
private final OptionalNullable> fieldsToClear;
private final OptionalNullable idempotencyKey;
/**
* Initialization constructor.
* @param order Order value for order.
* @param fieldsToClear List of String value for fieldsToClear.
* @param idempotencyKey String value for idempotencyKey.
*/
@JsonCreator
public UpdateOrderRequest(
@JsonProperty("order") Order order,
@JsonProperty("fields_to_clear") List fieldsToClear,
@JsonProperty("idempotency_key") String idempotencyKey) {
this.order = order;
this.fieldsToClear = OptionalNullable.of(fieldsToClear);
this.idempotencyKey = OptionalNullable.of(idempotencyKey);
}
/**
* Initialization constructor.
* @param order Order value for order.
* @param fieldsToClear List of String value for fieldsToClear.
* @param idempotencyKey String value for idempotencyKey.
*/
protected UpdateOrderRequest(
Order order, OptionalNullable> fieldsToClear, OptionalNullable idempotencyKey) {
this.order = order;
this.fieldsToClear = fieldsToClear;
this.idempotencyKey = idempotencyKey;
}
/**
* 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.
* @return Returns the Order
*/
@JsonGetter("order")
@JsonInclude(JsonInclude.Include.NON_NULL)
public Order getOrder() {
return order;
}
/**
* 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).
* @return Returns the Internal List of String
*/
@JsonGetter("fields_to_clear")
@JsonInclude(JsonInclude.Include.NON_NULL)
@JsonSerialize(using = OptionalNullable.Serializer.class)
protected OptionalNullable> internalGetFieldsToClear() {
return this.fieldsToClear;
}
/**
* 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).
* @return Returns the List of String
*/
@JsonIgnore
public List getFieldsToClear() {
return OptionalNullable.getFrom(fieldsToClear);
}
/**
* 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).
* @return Returns the Internal String
*/
@JsonGetter("idempotency_key")
@JsonInclude(JsonInclude.Include.NON_NULL)
@JsonSerialize(using = OptionalNullable.Serializer.class)
protected OptionalNullable internalGetIdempotencyKey() {
return this.idempotencyKey;
}
/**
* 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).
* @return Returns the String
*/
@JsonIgnore
public String getIdempotencyKey() {
return OptionalNullable.getFrom(idempotencyKey);
}
@Override
public int hashCode() {
return Objects.hash(order, fieldsToClear, idempotencyKey);
}
@Override
public boolean equals(Object obj) {
if (obj == this) {
return true;
}
if (!(obj instanceof UpdateOrderRequest)) {
return false;
}
UpdateOrderRequest other = (UpdateOrderRequest) obj;
return Objects.equals(order, other.order)
&& Objects.equals(fieldsToClear, other.fieldsToClear)
&& Objects.equals(idempotencyKey, other.idempotencyKey);
}
/**
* Converts this UpdateOrderRequest into string format.
* @return String representation of this class
*/
@Override
public String toString() {
return "UpdateOrderRequest [" + "order=" + order + ", fieldsToClear=" + fieldsToClear + ", idempotencyKey="
+ idempotencyKey + "]";
}
/**
* Builds a new {@link UpdateOrderRequest.Builder} object.
* Creates the instance with the state of the current model.
* @return a new {@link UpdateOrderRequest.Builder} object
*/
public Builder toBuilder() {
Builder builder = new Builder().order(getOrder());
builder.fieldsToClear = internalGetFieldsToClear();
builder.idempotencyKey = internalGetIdempotencyKey();
return builder;
}
/**
* Class to build instances of {@link UpdateOrderRequest}.
*/
public static class Builder {
private Order order;
private OptionalNullable> fieldsToClear;
private OptionalNullable idempotencyKey;
/**
* Setter for order.
* @param order Order value for order.
* @return Builder
*/
public Builder order(Order order) {
this.order = order;
return this;
}
/**
* Setter for fieldsToClear.
* @param fieldsToClear List of String value for fieldsToClear.
* @return Builder
*/
public Builder fieldsToClear(List fieldsToClear) {
this.fieldsToClear = OptionalNullable.of(fieldsToClear);
return this;
}
/**
* UnSetter for fieldsToClear.
* @return Builder
*/
public Builder unsetFieldsToClear() {
fieldsToClear = null;
return this;
}
/**
* Setter for idempotencyKey.
* @param idempotencyKey String value for idempotencyKey.
* @return Builder
*/
public Builder idempotencyKey(String idempotencyKey) {
this.idempotencyKey = OptionalNullable.of(idempotencyKey);
return this;
}
/**
* UnSetter for idempotencyKey.
* @return Builder
*/
public Builder unsetIdempotencyKey() {
idempotencyKey = null;
return this;
}
/**
* Builds a new {@link UpdateOrderRequest} object using the set fields.
* @return {@link UpdateOrderRequest}
*/
public UpdateOrderRequest build() {
return new UpdateOrderRequest(order, fieldsToClear, idempotencyKey);
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy