com.squareup.square.legacy.models.GetPaymentRefundResponse 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 GetPaymentRefundResponse type.
 */
public class GetPaymentRefundResponse {
    private HttpContext httpContext;
    private final List errors;
    private final PaymentRefund refund;

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

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

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

    /**
     * Getter for Refund.
     * Represents a refund of a payment made using Square. Contains information about the original
     * payment and the amount of money refunded.
     * @return Returns the PaymentRefund
     */
    @JsonGetter("refund")
    @JsonInclude(JsonInclude.Include.NON_NULL)
    public PaymentRefund getRefund() {
        return refund;
    }

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

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

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

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

    /**
     * Class to build instances of {@link GetPaymentRefundResponse}.
     */
    public static class Builder {
        private HttpContext httpContext;
        private List errors;
        private PaymentRefund refund;

        /**
         * Setter for httpContext.
         * @param  httpContext  HttpContext value for httpContext.
         * @return Builder
         */
        public Builder httpContext(HttpContext httpContext) {
            this.httpContext = httpContext;
            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;
        }

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

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