com.squareup.square.models.SearchInvoicesResponse 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: 42.1.0.20241218

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 SearchInvoicesResponse type.
 */
public class SearchInvoicesResponse {
    private HttpContext httpContext;
    private final List invoices;
    private final String cursor;
    private final List errors;

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

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

    /**
     * Getter for Invoices.
     * The list of invoices returned by the search.
     * @return Returns the List of Invoice
     */
    @JsonGetter("invoices")
    @JsonInclude(JsonInclude.Include.NON_NULL)
    public List getInvoices() {
        return invoices;
    }

    /**
     * Getter for Cursor.
     * When a response is truncated, it includes a cursor that you can use in a subsequent request
     * to fetch the next set of invoices. If empty, this is the final response. For more
     * information, see
     * [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination).
     * @return Returns the String
     */
    @JsonGetter("cursor")
    @JsonInclude(JsonInclude.Include.NON_NULL)
    public String getCursor() {
        return cursor;
    }

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

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

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

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

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

    /**
     * Class to build instances of {@link SearchInvoicesResponse}.
     */
    public static class Builder {
        private HttpContext httpContext;
        private List invoices;
        private String cursor;
        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 invoices.
         * @param  invoices  List of Invoice value for invoices.
         * @return Builder
         */
        public Builder invoices(List invoices) {
            this.invoices = invoices;
            return this;
        }

        /**
         * Setter for cursor.
         * @param  cursor  String value for cursor.
         * @return Builder
         */
        public Builder cursor(String cursor) {
            this.cursor = cursor;
            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 SearchInvoicesResponse} object using the set fields.
         * @return {@link SearchInvoicesResponse}
         */
        public SearchInvoicesResponse build() {
            SearchInvoicesResponse model =
                    new SearchInvoicesResponse(invoices, cursor, errors);
            model.httpContext = httpContext;
            return model;
        }
    }
}