com.squareup.square.models.CatalogQuickAmount 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: 43.1.0.20250220

package com.squareup.square.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 CatalogQuickAmount type.
 */
public class CatalogQuickAmount {
    private final String type;
    private final Money amount;
    private final Long score;
    private final Long ordinal;

    /**
     * Initialization constructor.
     * @param  type  String value for type.
     * @param  amount  Money value for amount.
     * @param  score  Long value for score.
     * @param  ordinal  Long value for ordinal.
     */
    @JsonCreator
    public CatalogQuickAmount(
            @JsonProperty("type") String type,
            @JsonProperty("amount") Money amount,
            @JsonProperty("score") Long score,
            @JsonProperty("ordinal") Long ordinal) {
        this.type = type;
        this.amount = amount;
        this.score = score;
        this.ordinal = ordinal;
    }

    /**
     * Getter for Type.
     * Determines the type of a specific Quick Amount.
     * @return Returns the String
     */
    @JsonGetter("type")
    public String getType() {
        return type;
    }

    /**
     * Getter for Amount.
     * Represents an amount of money. `Money` fields can be signed or unsigned. Fields that do not
     * explicitly define whether they are signed or unsigned are considered unsigned and can only
     * hold positive amounts. For signed fields, the sign of the value indicates the purpose of the
     * money transfer. See [Working with Monetary
     * Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts) for
     * more information.
     * @return Returns the Money
     */
    @JsonGetter("amount")
    public Money getAmount() {
        return amount;
    }

    /**
     * Getter for Score.
     * Describes the ranking of the Quick Amount provided by machine learning model, in the range
     * [0, 100]. MANUAL type amount will always have score = 100.
     * @return Returns the Long
     */
    @JsonGetter("score")
    @JsonInclude(JsonInclude.Include.NON_NULL)
    public Long getScore() {
        return score;
    }

    /**
     * Getter for Ordinal.
     * The order in which this Quick Amount should be displayed.
     * @return Returns the Long
     */
    @JsonGetter("ordinal")
    @JsonInclude(JsonInclude.Include.NON_NULL)
    public Long getOrdinal() {
        return ordinal;
    }

    @Override
    public int hashCode() {
        return Objects.hash(type, amount, score, ordinal);
    }

    @Override
    public boolean equals(Object obj) {
        if (obj == this) {
            return true;
        }
        if (!(obj instanceof CatalogQuickAmount)) {
            return false;
        }
        CatalogQuickAmount other = (CatalogQuickAmount) obj;
        return Objects.equals(type, other.type)
            && Objects.equals(amount, other.amount)
            && Objects.equals(score, other.score)
            && Objects.equals(ordinal, other.ordinal);
    }

    /**
     * Converts this CatalogQuickAmount into string format.
     * @return String representation of this class
     */
    @Override
    public String toString() {
        return "CatalogQuickAmount [" + "type=" + type + ", amount=" + amount + ", score=" + score
                + ", ordinal=" + ordinal + "]";
    }

    /**
     * Builds a new {@link CatalogQuickAmount.Builder} object.
     * Creates the instance with the state of the current model.
     * @return a new {@link CatalogQuickAmount.Builder} object
     */
    public Builder toBuilder() {
        Builder builder = new Builder(type, amount)
                .score(getScore())
                .ordinal(getOrdinal());
        return builder;
    }

    /**
     * Class to build instances of {@link CatalogQuickAmount}.
     */
    public static class Builder {
        private String type;
        private Money amount;
        private Long score;
        private Long ordinal;

        /**
         * Initialization constructor.
         * @param  type  String value for type.
         * @param  amount  Money value for amount.
         */
        public Builder(String type, Money amount) {
            this.type = type;
            this.amount = amount;
        }

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

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

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

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

        /**
         * Builds a new {@link CatalogQuickAmount} object using the set fields.
         * @return {@link CatalogQuickAmount}
         */
        public CatalogQuickAmount build() {
            return new CatalogQuickAmount(type, amount, score, ordinal);
        }
    }
}