com.squareup.square.models.ListPaymentsResponse Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of square Show documentation
Java client library for the Square API
There is a newer version: 41.2.0.20241017

package com.squareup.square.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.http.client.HttpContext;
import java.util.List;
import java.util.Objects;

/**
 * This is a model class for ListPaymentsResponse type.
 */
public class ListPaymentsResponse {
    private HttpContext httpContext;
    private final List errors;
    private final List payments;
    private final String cursor;

    /**
     * Initialization constructor.
     * @param  errors  List of Error value for errors.
     * @param  payments  List of Payment value for payments.
     * @param  cursor  String value for cursor.
     */
    @JsonCreator
    public ListPaymentsResponse(
            @JsonProperty("errors") List errors,
            @JsonProperty("payments") List payments,
            @JsonProperty("cursor") String cursor) {
        this.errors = errors;
        this.payments = payments;
        this.cursor = cursor;
    }

    @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 Payments.
     * The requested list of payments.
     * @return Returns the List of Payment
     */
    @JsonGetter("payments")
    @JsonInclude(JsonInclude.Include.NON_NULL)
    public List getPayments() {
        return payments;
    }

    /**
     * Getter for Cursor.
     * The pagination cursor to be used in a subsequent request. If empty, this is the final
     * response. For more information, see
     * [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).
     * @return Returns the String
     */
    @JsonGetter("cursor")
    @JsonInclude(JsonInclude.Include.NON_NULL)
    public String getCursor() {
        return cursor;
    }

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

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

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

    /**
     * Builds a new {@link ListPaymentsResponse.Builder} object.
     * Creates the instance with the state of the current model.
     * @return a new {@link ListPaymentsResponse.Builder} object
     */
    public Builder toBuilder() {
        Builder builder = new Builder()
                .errors(getErrors())
                .payments(getPayments())
                .cursor(getCursor());
        return builder;
    }

    /**
     * Class to build instances of {@link ListPaymentsResponse}.
     */
    public static class Builder {
        private HttpContext httpContext;
        private List errors;
        private List payments;
        private String cursor;



        /**
         * 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 payments.
         * @param  payments  List of Payment value for payments.
         * @return Builder
         */
        public Builder payments(List payments) {
            this.payments = payments;
            return this;
        }

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

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