com.squareup.square.models

Class CatalogPricingRule

java.lang.Object

com.squareup.square.models.CatalogPricingRule

public class CatalogPricingRule
extends Object

This is a model class for CatalogPricingRule type.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CatalogPricingRule.Builder Class to build instances of CatalogPricingRule.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CatalogPricingRule(io.apimatic.core.types.OptionalNullable<String> name, io.apimatic.core.types.OptionalNullable<List<String>> timePeriodIds, io.apimatic.core.types.OptionalNullable<String> discountId, io.apimatic.core.types.OptionalNullable<String> matchProductsId, io.apimatic.core.types.OptionalNullable<String> applyProductsId, io.apimatic.core.types.OptionalNullable<String> excludeProductsId, io.apimatic.core.types.OptionalNullable<String> validFromDate, io.apimatic.core.types.OptionalNullable<String> validFromLocalTime, io.apimatic.core.types.OptionalNullable<String> validUntilDate, io.apimatic.core.types.OptionalNullable<String> validUntilLocalTime, String excludeStrategy, Money minimumOrderSubtotalMoney, io.apimatic.core.types.OptionalNullable<List<String>> customerGroupIdsAny) Internal initialization constructor.
	CatalogPricingRule(String name, List<String> timePeriodIds, String discountId, String matchProductsId, String applyProductsId, String excludeProductsId, String validFromDate, String validFromLocalTime, String validUntilDate, String validUntilLocalTime, String excludeStrategy, Money minimumOrderSubtotalMoney, List<String> customerGroupIdsAny) Initialization constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getApplyProductsId() Getter for ApplyProductsId.
List<String>	getCustomerGroupIdsAny() Getter for CustomerGroupIdsAny.
String	getDiscountId() Getter for DiscountId.
String	getExcludeProductsId() Getter for ExcludeProductsId.
String	getExcludeStrategy() Getter for ExcludeStrategy.
String	getMatchProductsId() Getter for MatchProductsId.
Money	getMinimumOrderSubtotalMoney() Getter for MinimumOrderSubtotalMoney.
String	getName() Getter for Name.
List<String>	getTimePeriodIds() Getter for TimePeriodIds.
String	getValidFromDate() Getter for ValidFromDate.
String	getValidFromLocalTime() Getter for ValidFromLocalTime.
String	getValidUntilDate() Getter for ValidUntilDate.
String	getValidUntilLocalTime() Getter for ValidUntilLocalTime.
int	hashCode()
protected io.apimatic.core.types.OptionalNullable<String>	internalGetApplyProductsId() Internal Getter for ApplyProductsId.
protected io.apimatic.core.types.OptionalNullable<List<String>>	internalGetCustomerGroupIdsAny() Internal Getter for CustomerGroupIdsAny.
protected io.apimatic.core.types.OptionalNullable<String>	internalGetDiscountId() Internal Getter for DiscountId.
protected io.apimatic.core.types.OptionalNullable<String>	internalGetExcludeProductsId() Internal Getter for ExcludeProductsId.
protected io.apimatic.core.types.OptionalNullable<String>	internalGetMatchProductsId() Internal Getter for MatchProductsId.
protected io.apimatic.core.types.OptionalNullable<String>	internalGetName() Internal Getter for Name.
protected io.apimatic.core.types.OptionalNullable<List<String>>	internalGetTimePeriodIds() Internal Getter for TimePeriodIds.
protected io.apimatic.core.types.OptionalNullable<String>	internalGetValidFromDate() Internal Getter for ValidFromDate.
protected io.apimatic.core.types.OptionalNullable<String>	internalGetValidFromLocalTime() Internal Getter for ValidFromLocalTime.
protected io.apimatic.core.types.OptionalNullable<String>	internalGetValidUntilDate() Internal Getter for ValidUntilDate.
protected io.apimatic.core.types.OptionalNullable<String>	internalGetValidUntilLocalTime() Internal Getter for ValidUntilLocalTime.
CatalogPricingRule.Builder	toBuilder() Builds a new CatalogPricingRule.Builder object.
String	toString() Converts this CatalogPricingRule into string format.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CatalogPricingRule

public CatalogPricingRule(String name,
                          List<String> timePeriodIds,
                          String discountId,
                          String matchProductsId,
                          String applyProductsId,
                          String excludeProductsId,
                          String validFromDate,
                          String validFromLocalTime,
                          String validUntilDate,
                          String validUntilLocalTime,
                          String excludeStrategy,
                          Money minimumOrderSubtotalMoney,
                          List<String> customerGroupIdsAny)

Initialization constructor.

Parameters:

name - String value for name.

timePeriodIds - List of String value for timePeriodIds.

discountId - String value for discountId.

matchProductsId - String value for matchProductsId.

applyProductsId - String value for applyProductsId.

excludeProductsId - String value for excludeProductsId.

validFromDate - String value for validFromDate.

validFromLocalTime - String value for validFromLocalTime.

validUntilDate - String value for validUntilDate.

validUntilLocalTime - String value for validUntilLocalTime.

excludeStrategy - String value for excludeStrategy.

minimumOrderSubtotalMoney - Money value for minimumOrderSubtotalMoney.

customerGroupIdsAny - List of String value for customerGroupIdsAny.

CatalogPricingRule

protected CatalogPricingRule(io.apimatic.core.types.OptionalNullable<String> name,
                             io.apimatic.core.types.OptionalNullable<List<String>> timePeriodIds,
                             io.apimatic.core.types.OptionalNullable<String> discountId,
                             io.apimatic.core.types.OptionalNullable<String> matchProductsId,
                             io.apimatic.core.types.OptionalNullable<String> applyProductsId,
                             io.apimatic.core.types.OptionalNullable<String> excludeProductsId,
                             io.apimatic.core.types.OptionalNullable<String> validFromDate,
                             io.apimatic.core.types.OptionalNullable<String> validFromLocalTime,
                             io.apimatic.core.types.OptionalNullable<String> validUntilDate,
                             io.apimatic.core.types.OptionalNullable<String> validUntilLocalTime,
                             String excludeStrategy,
                             Money minimumOrderSubtotalMoney,
                             io.apimatic.core.types.OptionalNullable<List<String>> customerGroupIdsAny)

Internal initialization constructor.

Method Detail

internalGetName

protected io.apimatic.core.types.OptionalNullable<String> internalGetName()

Internal Getter for Name. User-defined name for the pricing rule. For example, "Buy one get one free" or "10% off".

Returns:

Returns the Internal String

getName

public String getName()

Getter for Name. User-defined name for the pricing rule. For example, "Buy one get one free" or "10% off".

Returns:

Returns the String

internalGetTimePeriodIds

protected io.apimatic.core.types.OptionalNullable<List<String>> internalGetTimePeriodIds()

Internal Getter for TimePeriodIds. A list of unique IDs for the catalog time periods when this pricing rule is in effect. If left unset, the pricing rule is always in effect.

Returns:

Returns the Internal List of String

getTimePeriodIds

public List<String> getTimePeriodIds()

Getter for TimePeriodIds. A list of unique IDs for the catalog time periods when this pricing rule is in effect. If left unset, the pricing rule is always in effect.

Returns:

Returns the List of String

internalGetDiscountId

protected io.apimatic.core.types.OptionalNullable<String> internalGetDiscountId()

Internal Getter for DiscountId. Unique ID for the `CatalogDiscount` to take off the price of all matched items.

Returns:

Returns the Internal String

getDiscountId

public String getDiscountId()

Getter for DiscountId. Unique ID for the `CatalogDiscount` to take off the price of all matched items.

Returns:

Returns the String

internalGetMatchProductsId

protected io.apimatic.core.types.OptionalNullable<String> internalGetMatchProductsId()

Internal Getter for MatchProductsId. Unique ID for the `CatalogProductSet` that will be matched by this rule. A match rule matches within the entire cart, and can match multiple times. This field will always be set.

Returns:

Returns the Internal String

getMatchProductsId

public String getMatchProductsId()

Getter for MatchProductsId. Unique ID for the `CatalogProductSet` that will be matched by this rule. A match rule matches within the entire cart, and can match multiple times. This field will always be set.

Returns:

Returns the String

internalGetApplyProductsId

protected io.apimatic.core.types.OptionalNullable<String> internalGetApplyProductsId()

Internal Getter for ApplyProductsId. __Deprecated__: Please use the `exclude_products_id` field to apply an exclude set instead. Exclude sets allow better control over quantity ranges and offer more flexibility for which matched items receive a discount. `CatalogProductSet` to apply the pricing to. An apply rule matches within the subset of the cart that fits the match rules (the match set). An apply rule can only match once in the match set. If not supplied, the pricing will be applied to all products in the match set. Other products retain their base price, or a price generated by other rules.

Returns:

Returns the Internal String

getApplyProductsId

public String getApplyProductsId()

Getter for ApplyProductsId. __Deprecated__: Please use the `exclude_products_id` field to apply an exclude set instead. Exclude sets allow better control over quantity ranges and offer more flexibility for which matched items receive a discount. `CatalogProductSet` to apply the pricing to. An apply rule matches within the subset of the cart that fits the match rules (the match set). An apply rule can only match once in the match set. If not supplied, the pricing will be applied to all products in the match set. Other products retain their base price, or a price generated by other rules.

Returns:

Returns the String

internalGetExcludeProductsId

protected io.apimatic.core.types.OptionalNullable<String> internalGetExcludeProductsId()

Internal Getter for ExcludeProductsId. `CatalogProductSet` to exclude from the pricing rule. An exclude rule matches within the subset of the cart that fits the match rules (the match set). An exclude rule can only match once in the match set. If not supplied, the pricing will be applied to all products in the match set. Other products retain their base price, or a price generated by other rules.

Returns:

Returns the Internal String

getExcludeProductsId

public String getExcludeProductsId()

Getter for ExcludeProductsId. `CatalogProductSet` to exclude from the pricing rule. An exclude rule matches within the subset of the cart that fits the match rules (the match set). An exclude rule can only match once in the match set. If not supplied, the pricing will be applied to all products in the match set. Other products retain their base price, or a price generated by other rules.

Returns:

Returns the String

internalGetValidFromDate

protected io.apimatic.core.types.OptionalNullable<String> internalGetValidFromDate()

Internal Getter for ValidFromDate. Represents the date the Pricing Rule is valid from. Represented in RFC 3339 full-date format (YYYY-MM-DD).

Returns:

Returns the Internal String

getValidFromDate

public String getValidFromDate()

Getter for ValidFromDate. Represents the date the Pricing Rule is valid from. Represented in RFC 3339 full-date format (YYYY-MM-DD).

Returns:

Returns the String

internalGetValidFromLocalTime

protected io.apimatic.core.types.OptionalNullable<String> internalGetValidFromLocalTime()

Internal Getter for ValidFromLocalTime. Represents the local time the pricing rule should be valid from. Represented in RFC 3339 partial-time format (HH:MM:SS). Partial seconds will be truncated.

Returns:

Returns the Internal String

getValidFromLocalTime

public String getValidFromLocalTime()

Getter for ValidFromLocalTime. Represents the local time the pricing rule should be valid from. Represented in RFC 3339 partial-time format (HH:MM:SS). Partial seconds will be truncated.

Returns:

Returns the String

internalGetValidUntilDate

protected io.apimatic.core.types.OptionalNullable<String> internalGetValidUntilDate()

Internal Getter for ValidUntilDate. Represents the date the Pricing Rule is valid until. Represented in RFC 3339 full-date format (YYYY-MM-DD).

Returns:

Returns the Internal String

getValidUntilDate

public String getValidUntilDate()

Getter for ValidUntilDate. Represents the date the Pricing Rule is valid until. Represented in RFC 3339 full-date format (YYYY-MM-DD).

Returns:

Returns the String

internalGetValidUntilLocalTime

protected io.apimatic.core.types.OptionalNullable<String> internalGetValidUntilLocalTime()

Internal Getter for ValidUntilLocalTime. Represents the local time the pricing rule should be valid until. Represented in RFC 3339 partial-time format (HH:MM:SS). Partial seconds will be truncated.

Returns:

Returns the Internal String

getValidUntilLocalTime

public String getValidUntilLocalTime()

Getter for ValidUntilLocalTime. Represents the local time the pricing rule should be valid until. Represented in RFC 3339 partial-time format (HH:MM:SS). Partial seconds will be truncated.

Returns:

Returns the String

getExcludeStrategy

public String getExcludeStrategy()

Getter for ExcludeStrategy. Indicates which products matched by a CatalogPricingRule will be excluded if the pricing rule uses an exclude set.

Returns:

Returns the String

getMinimumOrderSubtotalMoney

public Money getMinimumOrderSubtotalMoney()

Getter for MinimumOrderSubtotalMoney. 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.

Returns:

Returns the Money

internalGetCustomerGroupIdsAny

protected io.apimatic.core.types.OptionalNullable<List<String>> internalGetCustomerGroupIdsAny()

Internal Getter for CustomerGroupIdsAny. A list of IDs of customer groups, the members of which are eligible for discounts specified in this pricing rule. Notice that a group ID is generated by the Customers API. If this field is not set, the specified discount applies to matched products sold to anyone whether the buyer has a customer profile created or not. If this `customer_group_ids_any` field is set, the specified discount applies only to matched products sold to customers belonging to the specified customer groups.

Returns:

Returns the Internal List of String

getCustomerGroupIdsAny

public List<String> getCustomerGroupIdsAny()

Getter for CustomerGroupIdsAny. A list of IDs of customer groups, the members of which are eligible for discounts specified in this pricing rule. Notice that a group ID is generated by the Customers API. If this field is not set, the specified discount applies to matched products sold to anyone whether the buyer has a customer profile created or not. If this `customer_group_ids_any` field is set, the specified discount applies only to matched products sold to customers belonging to the specified customer groups.

Returns:

Returns the List of String

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Converts this CatalogPricingRule into string format.

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public CatalogPricingRule.Builder toBuilder()

Builds a new CatalogPricingRule.Builder object. Creates the instance with the state of the current model.

Returns:

a new CatalogPricingRule.Builder object