com.squareup.square.legacy.models.CatalogQuickAmount Maven / Gradle / Ivy
package com.squareup.square.legacy.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.fasterxml.jackson.databind.annotation.JsonSerialize;
import io.apimatic.core.types.OptionalNullable;
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 OptionalNullable score;
private final OptionalNullable 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 = OptionalNullable.of(score);
this.ordinal = OptionalNullable.of(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.
*/
protected CatalogQuickAmount(
String type, Money amount, OptionalNullable score, OptionalNullable 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;
}
/**
* Internal 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 Internal Long
*/
@JsonGetter("score")
@JsonInclude(JsonInclude.Include.NON_NULL)
@JsonSerialize(using = OptionalNullable.Serializer.class)
protected OptionalNullable internalGetScore() {
return this.score;
}
/**
* 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
*/
@JsonIgnore
public Long getScore() {
return OptionalNullable.getFrom(score);
}
/**
* Internal Getter for Ordinal.
* The order in which this Quick Amount should be displayed.
* @return Returns the Internal Long
*/
@JsonGetter("ordinal")
@JsonInclude(JsonInclude.Include.NON_NULL)
@JsonSerialize(using = OptionalNullable.Serializer.class)
protected OptionalNullable internalGetOrdinal() {
return this.ordinal;
}
/**
* Getter for Ordinal.
* The order in which this Quick Amount should be displayed.
* @return Returns the Long
*/
@JsonIgnore
public Long getOrdinal() {
return OptionalNullable.getFrom(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);
builder.score = internalGetScore();
builder.ordinal = internalGetOrdinal();
return builder;
}
/**
* Class to build instances of {@link CatalogQuickAmount}.
*/
public static class Builder {
private String type;
private Money amount;
private OptionalNullable score;
private OptionalNullable 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 = OptionalNullable.of(score);
return this;
}
/**
* UnSetter for score.
* @return Builder
*/
public Builder unsetScore() {
score = null;
return this;
}
/**
* Setter for ordinal.
* @param ordinal Long value for ordinal.
* @return Builder
*/
public Builder ordinal(Long ordinal) {
this.ordinal = OptionalNullable.of(ordinal);
return this;
}
/**
* UnSetter for ordinal.
* @return Builder
*/
public Builder unsetOrdinal() {
ordinal = null;
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);
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy