com.squareup.square.models.ListCustomerGroupsResponse 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 ListCustomerGroupsResponse type.
 */
public class ListCustomerGroupsResponse {
    private HttpContext httpContext;
    private final List errors;
    private final List groups;
    private final String cursor;

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

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

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

    /**
     * Getter for Groups.
     * A list of customer groups belonging to the current seller.
     * @return Returns the List of CustomerGroup
     */
    @JsonGetter("groups")
    @JsonInclude(JsonInclude.Include.NON_NULL)
    public List getGroups() {
        return groups;
    }

    /**
     * Getter for Cursor.
     * A pagination cursor to retrieve the next set of results for your original query to the
     * endpoint. This value is present only if the request succeeded and additional results are
     * available. 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, groups, cursor);
    }

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

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

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

    /**
     * Class to build instances of {@link ListCustomerGroupsResponse}.
     */
    public static class Builder {
        private HttpContext httpContext;
        private List errors;
        private List groups;
        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 groups.
         * @param  groups  List of CustomerGroup value for groups.
         * @return Builder
         */
        public Builder groups(List groups) {
            this.groups = groups;
            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 ListCustomerGroupsResponse} object using the set fields.
         * @return {@link ListCustomerGroupsResponse}
         */
        public ListCustomerGroupsResponse build() {
            ListCustomerGroupsResponse model =
                    new ListCustomerGroupsResponse(errors, groups, cursor);
            model.httpContext = httpContext;
            return model;
        }
    }
}