com.squareup.square.legacy.models.RetrieveOrderResponse Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of square-legacy Show documentation
There is a newer version: 44.2.0.20250521
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.squareup.square.legacy.http.client.HttpContext;
import java.util.List;
import java.util.Objects;

/**
 * This is a model class for RetrieveOrderResponse type.
 */
public class RetrieveOrderResponse {
    private HttpContext httpContext;
    private final Order order;
    private final List errors;

    /**
     * Initialization constructor.
     * @param  order  Order value for order.
     * @param  errors  List of Error value for errors.
     */
    @JsonCreator
    public RetrieveOrderResponse(@JsonProperty("order") Order order, @JsonProperty("errors") List errors) {
        this.order = order;
        this.errors = errors;
    }

    @JsonIgnore
    public HttpContext getContext() {
        return httpContext;
    }

    /**
     * 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;
    }

    /**
     * Getter for Errors.
     * Any errors that occurred during the request.
     * @return Returns the List of Error
     */
    @JsonGetter("errors")
    @JsonInclude(JsonInclude.Include.NON_NULL)
    public List getErrors() {
        return errors;
    }

    @Override
    public int hashCode() {
        return Objects.hash(order, errors);
    }

    @Override
    public boolean equals(Object obj) {
        if (obj == this) {
            return true;
        }
        if (!(obj instanceof RetrieveOrderResponse)) {
            return false;
        }
        RetrieveOrderResponse other = (RetrieveOrderResponse) obj;
        return Objects.equals(order, other.order) && Objects.equals(errors, other.errors);
    }

    /**
     * Converts this RetrieveOrderResponse into string format.
     * @return String representation of this class
     */
    @Override
    public String toString() {
        return "RetrieveOrderResponse [" + "order=" + order + ", errors=" + errors + "]";
    }

    /**
     * Builds a new {@link RetrieveOrderResponse.Builder} object.
     * Creates the instance with the state of the current model.
     * @return a new {@link RetrieveOrderResponse.Builder} object
     */
    public Builder toBuilder() {
        Builder builder = new Builder().order(getOrder()).errors(getErrors());
        return builder;
    }

    /**
     * Class to build instances of {@link RetrieveOrderResponse}.
     */
    public static class Builder {
        private HttpContext httpContext;
        private Order order;
        private List errors;

        /**
         * Setter for httpContext.
         * @param  httpContext  HttpContext value for httpContext.
         * @return Builder
         */
        public Builder httpContext(HttpContext httpContext) {
            this.httpContext = httpContext;
            return this;
        }

        /**
         * Setter for order.
         * @param  order  Order value for order.
         * @return Builder
         */
        public Builder order(Order order) {
            this.order = order;
            return this;
        }

        /**
         * Setter for errors.
         * @param  errors  List of Error value for errors.
         * @return Builder
         */
        public Builder errors(List errors) {
            this.errors = errors;
            return this;
        }

        /**
         * Builds a new {@link RetrieveOrderResponse} object using the set fields.
         * @return {@link RetrieveOrderResponse}
         */
        public RetrieveOrderResponse build() {
            RetrieveOrderResponse model = new RetrieveOrderResponse(order, errors);
            model.httpContext = httpContext;
            return model;
        }
    }
}