com.squareup.connect.models.OrderLineItemDiscount Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of connect Show documentation
Show all versions of connect Show documentation
Java client library for the Square Connect API
/*
* Square Connect API
* Client library for accessing the Square Connect APIs
*
* OpenAPI spec version: 2.0
* Contact: [email protected]
*
* NOTE: This class is auto generated by the swagger code generator program.
* https://github.com/swagger-api/swagger-codegen.git
* Do not edit the class manually.
*/
package com.squareup.connect.models;
import java.util.Objects;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonValue;
import com.squareup.connect.models.Money;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
/**
* Represents a discount that applies to one or more line items in an order. Fixed-amount, order-level discounts are distributed across all non-zero line item totals. The amount distributed to each line item is relative to that item’s contribution to the order subtotal.
*/
@ApiModel(description = "Represents a discount that applies to one or more line items in an order. Fixed-amount, order-level discounts are distributed across all non-zero line item totals. The amount distributed to each line item is relative to that item’s contribution to the order subtotal.")
public class OrderLineItemDiscount {
@JsonProperty("catalog_object_id")
private String catalogObjectId = null;
@JsonProperty("name")
private String name = null;
/**
* The type of the discount. If it is created by API, it would be either `FIXED_PERCENTAGE` or `FIXED_AMOUNT`. VARIABLE_* is not supported in API because the order is created at the time of sale and either percentage or amount has to be specified. See [OrderLineItemDiscountType](#type-orderlineitemdiscounttype) for possible values.
*/
public enum TypeEnum {
UNKNOWN_DISCOUNT("UNKNOWN_DISCOUNT"),
FIXED_PERCENTAGE("FIXED_PERCENTAGE"),
FIXED_AMOUNT("FIXED_AMOUNT"),
VARIABLE_PERCENTAGE("VARIABLE_PERCENTAGE"),
VARIABLE_AMOUNT("VARIABLE_AMOUNT");
private String value;
TypeEnum(String value) {
this.value = value;
}
@Override
public String toString() {
return String.valueOf(value);
}
@JsonCreator
public static TypeEnum fromValue(String text) {
for (TypeEnum b : TypeEnum.values()) {
if (String.valueOf(b.value).equals(text)) {
return b;
}
}
return null;
}
}
@JsonProperty("type")
private TypeEnum type = null;
@JsonProperty("percentage")
private String percentage = null;
@JsonProperty("amount_money")
private Money amountMoney = null;
@JsonProperty("applied_money")
private Money appliedMoney = null;
/**
* Indicates the level at which the discount applies. See [OrderLineItemDiscountScope](#type-orderlineitemdiscountscope) for possible values.
*/
public enum ScopeEnum {
OTHER_DISCOUNT_SCOPE("OTHER_DISCOUNT_SCOPE"),
LINE_ITEM("LINE_ITEM"),
ORDER("ORDER");
private String value;
ScopeEnum(String value) {
this.value = value;
}
@Override
public String toString() {
return String.valueOf(value);
}
@JsonCreator
public static ScopeEnum fromValue(String text) {
for (ScopeEnum b : ScopeEnum.values()) {
if (String.valueOf(b.value).equals(text)) {
return b;
}
}
return null;
}
}
@JsonProperty("scope")
private ScopeEnum scope = null;
public OrderLineItemDiscount catalogObjectId(String catalogObjectId) {
this.catalogObjectId = catalogObjectId;
return this;
}
/**
* The catalog object id referencing [CatalogDiscount](#type-catalogdiscount).
* @return catalogObjectId
**/
@ApiModelProperty(value = "The catalog object id referencing [CatalogDiscount](#type-catalogdiscount).")
public String getCatalogObjectId() {
return catalogObjectId;
}
public void setCatalogObjectId(String catalogObjectId) {
this.catalogObjectId = catalogObjectId;
}
public OrderLineItemDiscount name(String name) {
this.name = name;
return this;
}
/**
* The discount's name.
* @return name
**/
@ApiModelProperty(value = "The discount's name.")
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public OrderLineItemDiscount type(TypeEnum type) {
this.type = type;
return this;
}
/**
* The type of the discount. If it is created by API, it would be either `FIXED_PERCENTAGE` or `FIXED_AMOUNT`. VARIABLE_* is not supported in API because the order is created at the time of sale and either percentage or amount has to be specified. See [OrderLineItemDiscountType](#type-orderlineitemdiscounttype) for possible values.
* @return type
**/
@ApiModelProperty(value = "The type of the discount. If it is created by API, it would be either `FIXED_PERCENTAGE` or `FIXED_AMOUNT`. VARIABLE_* is not supported in API because the order is created at the time of sale and either percentage or amount has to be specified. See [OrderLineItemDiscountType](#type-orderlineitemdiscounttype) for possible values.")
public TypeEnum getType() {
return type;
}
public void setType(TypeEnum type) {
this.type = type;
}
public OrderLineItemDiscount percentage(String percentage) {
this.percentage = percentage;
return this;
}
/**
* The percentage of the tax, as a string representation of a decimal number. A value of `7.25` corresponds to a percentage of 7.25%. The percentage won't be set for an amount-based discount.
* @return percentage
**/
@ApiModelProperty(value = "The percentage of the tax, as a string representation of a decimal number. A value of `7.25` corresponds to a percentage of 7.25%. The percentage won't be set for an amount-based discount.")
public String getPercentage() {
return percentage;
}
public void setPercentage(String percentage) {
this.percentage = percentage;
}
public OrderLineItemDiscount amountMoney(Money amountMoney) {
this.amountMoney = amountMoney;
return this;
}
/**
* The total monetary amount of the applicable discount. If it is at order level, it is the value of the order level discount. If it is at line item level, it is the value of the line item level discount. The amount_money won't be set for a percentage-based discount.
* @return amountMoney
**/
@ApiModelProperty(value = "The total monetary amount of the applicable discount. If it is at order level, it is the value of the order level discount. If it is at line item level, it is the value of the line item level discount. The amount_money won't be set for a percentage-based discount.")
public Money getAmountMoney() {
return amountMoney;
}
public void setAmountMoney(Money amountMoney) {
this.amountMoney = amountMoney;
}
public OrderLineItemDiscount appliedMoney(Money appliedMoney) {
this.appliedMoney = appliedMoney;
return this;
}
/**
* The amount of discount actually applied to this line item. Represents the amount of money applied to a line item as a discount When an amount-based discount is at order-level, this value is different from `amount_money` because the discount is distributed across the line items.
* @return appliedMoney
**/
@ApiModelProperty(value = "The amount of discount actually applied to this line item. Represents the amount of money applied to a line item as a discount When an amount-based discount is at order-level, this value is different from `amount_money` because the discount is distributed across the line items.")
public Money getAppliedMoney() {
return appliedMoney;
}
public void setAppliedMoney(Money appliedMoney) {
this.appliedMoney = appliedMoney;
}
public OrderLineItemDiscount scope(ScopeEnum scope) {
this.scope = scope;
return this;
}
/**
* Indicates the level at which the discount applies. See [OrderLineItemDiscountScope](#type-orderlineitemdiscountscope) for possible values.
* @return scope
**/
@ApiModelProperty(value = "Indicates the level at which the discount applies. See [OrderLineItemDiscountScope](#type-orderlineitemdiscountscope) for possible values.")
public ScopeEnum getScope() {
return scope;
}
public void setScope(ScopeEnum scope) {
this.scope = scope;
}
@Override
public boolean equals(java.lang.Object o) {
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
OrderLineItemDiscount orderLineItemDiscount = (OrderLineItemDiscount) o;
return Objects.equals(this.catalogObjectId, orderLineItemDiscount.catalogObjectId) &&
Objects.equals(this.name, orderLineItemDiscount.name) &&
Objects.equals(this.type, orderLineItemDiscount.type) &&
Objects.equals(this.percentage, orderLineItemDiscount.percentage) &&
Objects.equals(this.amountMoney, orderLineItemDiscount.amountMoney) &&
Objects.equals(this.appliedMoney, orderLineItemDiscount.appliedMoney) &&
Objects.equals(this.scope, orderLineItemDiscount.scope);
}
@Override
public int hashCode() {
return Objects.hash(catalogObjectId, name, type, percentage, amountMoney, appliedMoney, scope);
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class OrderLineItemDiscount {\n");
sb.append(" catalogObjectId: ").append(toIndentedString(catalogObjectId)).append("\n");
sb.append(" name: ").append(toIndentedString(name)).append("\n");
sb.append(" type: ").append(toIndentedString(type)).append("\n");
sb.append(" percentage: ").append(toIndentedString(percentage)).append("\n");
sb.append(" amountMoney: ").append(toIndentedString(amountMoney)).append("\n");
sb.append(" appliedMoney: ").append(toIndentedString(appliedMoney)).append("\n");
sb.append(" scope: ").append(toIndentedString(scope)).append("\n");
sb.append("}");
return sb.toString();
}
/**
* Convert the given object to string with each line indented by 4 spaces
* (except the first line).
*/
private String toIndentedString(java.lang.Object o) {
if (o == null) {
return "null";
}
return o.toString().replace("\n", "\n ");
}
}