com.squareup.square.legacy.models.ItemVariationLocationOverrides 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 ItemVariationLocationOverrides type.
*/
public class ItemVariationLocationOverrides {
private final OptionalNullable locationId;
private final Money priceMoney;
private final String pricingType;
private final OptionalNullable trackInventory;
private final String inventoryAlertType;
private final OptionalNullable inventoryAlertThreshold;
private final Boolean soldOut;
private final String soldOutValidUntil;
/**
* Initialization constructor.
* @param locationId String value for locationId.
* @param priceMoney Money value for priceMoney.
* @param pricingType String value for pricingType.
* @param trackInventory Boolean value for trackInventory.
* @param inventoryAlertType String value for inventoryAlertType.
* @param inventoryAlertThreshold Long value for inventoryAlertThreshold.
* @param soldOut Boolean value for soldOut.
* @param soldOutValidUntil String value for soldOutValidUntil.
*/
@JsonCreator
public ItemVariationLocationOverrides(
@JsonProperty("location_id") String locationId,
@JsonProperty("price_money") Money priceMoney,
@JsonProperty("pricing_type") String pricingType,
@JsonProperty("track_inventory") Boolean trackInventory,
@JsonProperty("inventory_alert_type") String inventoryAlertType,
@JsonProperty("inventory_alert_threshold") Long inventoryAlertThreshold,
@JsonProperty("sold_out") Boolean soldOut,
@JsonProperty("sold_out_valid_until") String soldOutValidUntil) {
this.locationId = OptionalNullable.of(locationId);
this.priceMoney = priceMoney;
this.pricingType = pricingType;
this.trackInventory = OptionalNullable.of(trackInventory);
this.inventoryAlertType = inventoryAlertType;
this.inventoryAlertThreshold = OptionalNullable.of(inventoryAlertThreshold);
this.soldOut = soldOut;
this.soldOutValidUntil = soldOutValidUntil;
}
/**
* Initialization constructor.
* @param locationId String value for locationId.
* @param priceMoney Money value for priceMoney.
* @param pricingType String value for pricingType.
* @param trackInventory Boolean value for trackInventory.
* @param inventoryAlertType String value for inventoryAlertType.
* @param inventoryAlertThreshold Long value for inventoryAlertThreshold.
* @param soldOut Boolean value for soldOut.
* @param soldOutValidUntil String value for soldOutValidUntil.
*/
protected ItemVariationLocationOverrides(
OptionalNullable locationId,
Money priceMoney,
String pricingType,
OptionalNullable trackInventory,
String inventoryAlertType,
OptionalNullable inventoryAlertThreshold,
Boolean soldOut,
String soldOutValidUntil) {
this.locationId = locationId;
this.priceMoney = priceMoney;
this.pricingType = pricingType;
this.trackInventory = trackInventory;
this.inventoryAlertType = inventoryAlertType;
this.inventoryAlertThreshold = inventoryAlertThreshold;
this.soldOut = soldOut;
this.soldOutValidUntil = soldOutValidUntil;
}
/**
* Internal Getter for LocationId.
* The ID of the `Location`. This can include locations that are deactivated.
* @return Returns the Internal String
*/
@JsonGetter("location_id")
@JsonInclude(JsonInclude.Include.NON_NULL)
@JsonSerialize(using = OptionalNullable.Serializer.class)
protected OptionalNullable internalGetLocationId() {
return this.locationId;
}
/**
* Getter for LocationId.
* The ID of the `Location`. This can include locations that are deactivated.
* @return Returns the String
*/
@JsonIgnore
public String getLocationId() {
return OptionalNullable.getFrom(locationId);
}
/**
* Getter for PriceMoney.
* 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("price_money")
@JsonInclude(JsonInclude.Include.NON_NULL)
public Money getPriceMoney() {
return priceMoney;
}
/**
* Getter for PricingType.
* Indicates whether the price of a CatalogItemVariation should be entered manually at the time
* of sale.
* @return Returns the String
*/
@JsonGetter("pricing_type")
@JsonInclude(JsonInclude.Include.NON_NULL)
public String getPricingType() {
return pricingType;
}
/**
* Internal Getter for TrackInventory.
* If `true`, inventory tracking is active for the `CatalogItemVariation` at this `Location`.
* @return Returns the Internal Boolean
*/
@JsonGetter("track_inventory")
@JsonInclude(JsonInclude.Include.NON_NULL)
@JsonSerialize(using = OptionalNullable.Serializer.class)
protected OptionalNullable internalGetTrackInventory() {
return this.trackInventory;
}
/**
* Getter for TrackInventory.
* If `true`, inventory tracking is active for the `CatalogItemVariation` at this `Location`.
* @return Returns the Boolean
*/
@JsonIgnore
public Boolean getTrackInventory() {
return OptionalNullable.getFrom(trackInventory);
}
/**
* Getter for InventoryAlertType.
* Indicates whether Square should alert the merchant when the inventory quantity of a
* CatalogItemVariation is low.
* @return Returns the String
*/
@JsonGetter("inventory_alert_type")
@JsonInclude(JsonInclude.Include.NON_NULL)
public String getInventoryAlertType() {
return inventoryAlertType;
}
/**
* Internal Getter for InventoryAlertThreshold.
* If the inventory quantity for the variation is less than or equal to this value and
* `inventory_alert_type` is `LOW_QUANTITY`, the variation displays an alert in the merchant
* dashboard. This value is always an integer.
* @return Returns the Internal Long
*/
@JsonGetter("inventory_alert_threshold")
@JsonInclude(JsonInclude.Include.NON_NULL)
@JsonSerialize(using = OptionalNullable.Serializer.class)
protected OptionalNullable internalGetInventoryAlertThreshold() {
return this.inventoryAlertThreshold;
}
/**
* Getter for InventoryAlertThreshold.
* If the inventory quantity for the variation is less than or equal to this value and
* `inventory_alert_type` is `LOW_QUANTITY`, the variation displays an alert in the merchant
* dashboard. This value is always an integer.
* @return Returns the Long
*/
@JsonIgnore
public Long getInventoryAlertThreshold() {
return OptionalNullable.getFrom(inventoryAlertThreshold);
}
/**
* Getter for SoldOut.
* Indicates whether the overridden item variation is sold out at the specified location. When
* inventory tracking is enabled on the item variation either globally or at the specified
* location, the item variation is automatically marked as sold out when its inventory count
* reaches zero. The seller can manually set the item variation as sold out even when the
* inventory count is greater than zero. Attempts by an application to set this attribute are
* ignored. Regardless how the sold-out status is set, applications should treat its inventory
* count as zero when this attribute value is `true`.
* @return Returns the Boolean
*/
@JsonGetter("sold_out")
@JsonInclude(JsonInclude.Include.NON_NULL)
public Boolean getSoldOut() {
return soldOut;
}
/**
* Getter for SoldOutValidUntil.
* The seller-assigned timestamp, of the RFC 3339 format, to indicate when this sold-out
* variation becomes available again at the specified location. Attempts by an application to
* set this attribute are ignored. When the current time is later than this attribute value, the
* affected item variation is no longer sold out.
* @return Returns the String
*/
@JsonGetter("sold_out_valid_until")
@JsonInclude(JsonInclude.Include.NON_NULL)
public String getSoldOutValidUntil() {
return soldOutValidUntil;
}
@Override
public int hashCode() {
return Objects.hash(
locationId,
priceMoney,
pricingType,
trackInventory,
inventoryAlertType,
inventoryAlertThreshold,
soldOut,
soldOutValidUntil);
}
@Override
public boolean equals(Object obj) {
if (obj == this) {
return true;
}
if (!(obj instanceof ItemVariationLocationOverrides)) {
return false;
}
ItemVariationLocationOverrides other = (ItemVariationLocationOverrides) obj;
return Objects.equals(locationId, other.locationId)
&& Objects.equals(priceMoney, other.priceMoney)
&& Objects.equals(pricingType, other.pricingType)
&& Objects.equals(trackInventory, other.trackInventory)
&& Objects.equals(inventoryAlertType, other.inventoryAlertType)
&& Objects.equals(inventoryAlertThreshold, other.inventoryAlertThreshold)
&& Objects.equals(soldOut, other.soldOut)
&& Objects.equals(soldOutValidUntil, other.soldOutValidUntil);
}
/**
* Converts this ItemVariationLocationOverrides into string format.
* @return String representation of this class
*/
@Override
public String toString() {
return "ItemVariationLocationOverrides [" + "locationId=" + locationId + ", priceMoney="
+ priceMoney + ", pricingType=" + pricingType + ", trackInventory=" + trackInventory
+ ", inventoryAlertType=" + inventoryAlertType + ", inventoryAlertThreshold="
+ inventoryAlertThreshold + ", soldOut=" + soldOut + ", soldOutValidUntil="
+ soldOutValidUntil + "]";
}
/**
* Builds a new {@link ItemVariationLocationOverrides.Builder} object.
* Creates the instance with the state of the current model.
* @return a new {@link ItemVariationLocationOverrides.Builder} object
*/
public Builder toBuilder() {
Builder builder = new Builder()
.priceMoney(getPriceMoney())
.pricingType(getPricingType())
.inventoryAlertType(getInventoryAlertType())
.soldOut(getSoldOut())
.soldOutValidUntil(getSoldOutValidUntil());
builder.locationId = internalGetLocationId();
builder.trackInventory = internalGetTrackInventory();
builder.inventoryAlertThreshold = internalGetInventoryAlertThreshold();
return builder;
}
/**
* Class to build instances of {@link ItemVariationLocationOverrides}.
*/
public static class Builder {
private OptionalNullable locationId;
private Money priceMoney;
private String pricingType;
private OptionalNullable trackInventory;
private String inventoryAlertType;
private OptionalNullable inventoryAlertThreshold;
private Boolean soldOut;
private String soldOutValidUntil;
/**
* Setter for locationId.
* @param locationId String value for locationId.
* @return Builder
*/
public Builder locationId(String locationId) {
this.locationId = OptionalNullable.of(locationId);
return this;
}
/**
* UnSetter for locationId.
* @return Builder
*/
public Builder unsetLocationId() {
locationId = null;
return this;
}
/**
* Setter for priceMoney.
* @param priceMoney Money value for priceMoney.
* @return Builder
*/
public Builder priceMoney(Money priceMoney) {
this.priceMoney = priceMoney;
return this;
}
/**
* Setter for pricingType.
* @param pricingType String value for pricingType.
* @return Builder
*/
public Builder pricingType(String pricingType) {
this.pricingType = pricingType;
return this;
}
/**
* Setter for trackInventory.
* @param trackInventory Boolean value for trackInventory.
* @return Builder
*/
public Builder trackInventory(Boolean trackInventory) {
this.trackInventory = OptionalNullable.of(trackInventory);
return this;
}
/**
* UnSetter for trackInventory.
* @return Builder
*/
public Builder unsetTrackInventory() {
trackInventory = null;
return this;
}
/**
* Setter for inventoryAlertType.
* @param inventoryAlertType String value for inventoryAlertType.
* @return Builder
*/
public Builder inventoryAlertType(String inventoryAlertType) {
this.inventoryAlertType = inventoryAlertType;
return this;
}
/**
* Setter for inventoryAlertThreshold.
* @param inventoryAlertThreshold Long value for inventoryAlertThreshold.
* @return Builder
*/
public Builder inventoryAlertThreshold(Long inventoryAlertThreshold) {
this.inventoryAlertThreshold = OptionalNullable.of(inventoryAlertThreshold);
return this;
}
/**
* UnSetter for inventoryAlertThreshold.
* @return Builder
*/
public Builder unsetInventoryAlertThreshold() {
inventoryAlertThreshold = null;
return this;
}
/**
* Setter for soldOut.
* @param soldOut Boolean value for soldOut.
* @return Builder
*/
public Builder soldOut(Boolean soldOut) {
this.soldOut = soldOut;
return this;
}
/**
* Setter for soldOutValidUntil.
* @param soldOutValidUntil String value for soldOutValidUntil.
* @return Builder
*/
public Builder soldOutValidUntil(String soldOutValidUntil) {
this.soldOutValidUntil = soldOutValidUntil;
return this;
}
/**
* Builds a new {@link ItemVariationLocationOverrides} object using the set fields.
* @return {@link ItemVariationLocationOverrides}
*/
public ItemVariationLocationOverrides build() {
return new ItemVariationLocationOverrides(
locationId,
priceMoney,
pricingType,
trackInventory,
inventoryAlertType,
inventoryAlertThreshold,
soldOut,
soldOutValidUntil);
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy