com.squareup.square.legacy.models.SearchLoyaltyEventsRequest 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.JsonInclude;
import com.fasterxml.jackson.annotation.JsonProperty;
import java.util.Objects;

/**
 * This is a model class for SearchLoyaltyEventsRequest type.
 */
public class SearchLoyaltyEventsRequest {
    private final LoyaltyEventQuery query;
    private final Integer limit;
    private final String cursor;

    /**
     * Initialization constructor.
     * @param  query  LoyaltyEventQuery value for query.
     * @param  limit  Integer value for limit.
     * @param  cursor  String value for cursor.
     */
    @JsonCreator
    public SearchLoyaltyEventsRequest(
            @JsonProperty("query") LoyaltyEventQuery query,
            @JsonProperty("limit") Integer limit,
            @JsonProperty("cursor") String cursor) {
        this.query = query;
        this.limit = limit;
        this.cursor = cursor;
    }

    /**
     * Getter for Query.
     * Represents a query used to search for loyalty events.
     * @return Returns the LoyaltyEventQuery
     */
    @JsonGetter("query")
    @JsonInclude(JsonInclude.Include.NON_NULL)
    public LoyaltyEventQuery getQuery() {
        return query;
    }

    /**
     * Getter for Limit.
     * The maximum number of results to include in the response. The last page might contain fewer
     * events. The default is 30 events.
     * @return Returns the Integer
     */
    @JsonGetter("limit")
    @JsonInclude(JsonInclude.Include.NON_NULL)
    public Integer getLimit() {
        return limit;
    }

    /**
     * Getter for Cursor.
     * A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve
     * the next set of results for your original query. 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(query, limit, cursor);
    }

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

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

    /**
     * Builds a new {@link SearchLoyaltyEventsRequest.Builder} object.
     * Creates the instance with the state of the current model.
     * @return a new {@link SearchLoyaltyEventsRequest.Builder} object
     */
    public Builder toBuilder() {
        Builder builder = new Builder().query(getQuery()).limit(getLimit()).cursor(getCursor());
        return builder;
    }

    /**
     * Class to build instances of {@link SearchLoyaltyEventsRequest}.
     */
    public static class Builder {
        private LoyaltyEventQuery query;
        private Integer limit;
        private String cursor;

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

        /**
         * Setter for limit.
         * @param  limit  Integer value for limit.
         * @return Builder
         */
        public Builder limit(Integer limit) {
            this.limit = limit;
            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 SearchLoyaltyEventsRequest} object using the set fields.
         * @return {@link SearchLoyaltyEventsRequest}
         */
        public SearchLoyaltyEventsRequest build() {
            return new SearchLoyaltyEventsRequest(query, limit, cursor);
        }
    }
}