com.squareup.square.models.RetrieveLoyaltyRewardResponse 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 RetrieveLoyaltyRewardResponse type.
 */
public class RetrieveLoyaltyRewardResponse {
    private HttpContext httpContext;
    private final List errors;
    private final LoyaltyReward reward;

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

    @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 Reward.
     * Represents a contract to redeem loyalty points for a [reward
     * tier]($m/LoyaltyProgramRewardTier) discount. Loyalty rewards can be in an ISSUED, REDEEMED,
     * or DELETED state. For more information, see [Manage loyalty
     * rewards](https://developer.squareup.com/docs/loyalty-api/loyalty-rewards).
     * @return Returns the LoyaltyReward
     */
    @JsonGetter("reward")
    @JsonInclude(JsonInclude.Include.NON_NULL)
    public LoyaltyReward getReward() {
        return reward;
    }

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

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

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

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

    /**
     * Class to build instances of {@link RetrieveLoyaltyRewardResponse}.
     */
    public static class Builder {
        private HttpContext httpContext;
        private List errors;
        private LoyaltyReward reward;



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

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