com.squareup.square.models

Class CatalogSubscriptionPlan

java.lang.Object

com.squareup.square.models.CatalogSubscriptionPlan

public class CatalogSubscriptionPlan
extends Object

This is a model class for CatalogSubscriptionPlan type.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	CatalogSubscriptionPlan(String name, List<SubscriptionPhase> phases, List<CatalogObject> subscriptionPlanVariations, List<String> eligibleItemIds, List<String> eligibleCategoryIds, Boolean allItems) Initialization constructor.
protected	CatalogSubscriptionPlan(String name, io.apimatic.core.types.OptionalNullable<List<SubscriptionPhase>> phases, io.apimatic.core.types.OptionalNullable<List<CatalogObject>> subscriptionPlanVariations, io.apimatic.core.types.OptionalNullable<List<String>> eligibleItemIds, io.apimatic.core.types.OptionalNullable<List<String>> eligibleCategoryIds, io.apimatic.core.types.OptionalNullable<Boolean> allItems) Internal initialization constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
Boolean	getAllItems() Getter for AllItems.
List<String>	getEligibleCategoryIds() Getter for EligibleCategoryIds.
List<String>	getEligibleItemIds() Getter for EligibleItemIds.
String	getName() Getter for Name.
List<SubscriptionPhase>	getPhases() Getter for Phases.
List<CatalogObject>	getSubscriptionPlanVariations() Getter for SubscriptionPlanVariations.
int	hashCode()
protected io.apimatic.core.types.OptionalNullable<Boolean>	internalGetAllItems() Internal Getter for AllItems.
protected io.apimatic.core.types.OptionalNullable<List<String>>	internalGetEligibleCategoryIds() Internal Getter for EligibleCategoryIds.
protected io.apimatic.core.types.OptionalNullable<List<String>>	internalGetEligibleItemIds() Internal Getter for EligibleItemIds.
protected io.apimatic.core.types.OptionalNullable<List<SubscriptionPhase>>	internalGetPhases() Internal Getter for Phases.
protected io.apimatic.core.types.OptionalNullable<List<CatalogObject>>	internalGetSubscriptionPlanVariations() Internal Getter for SubscriptionPlanVariations.
CatalogSubscriptionPlan.Builder	toBuilder() Builds a new CatalogSubscriptionPlan.Builder object.
String	toString() Converts this CatalogSubscriptionPlan into string format.

Methods inherited from class java.lang.Object

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

Constructor Detail

CatalogSubscriptionPlan

public CatalogSubscriptionPlan(String name,
                               List<SubscriptionPhase> phases,
                               List<CatalogObject> subscriptionPlanVariations,
                               List<String> eligibleItemIds,
                               List<String> eligibleCategoryIds,
                               Boolean allItems)

Initialization constructor.

Parameters:

name - String value for name.

phases - List of SubscriptionPhase value for phases.

subscriptionPlanVariations - List of CatalogObject value for subscriptionPlanVariations.

eligibleItemIds - List of String value for eligibleItemIds.

eligibleCategoryIds - List of String value for eligibleCategoryIds.

allItems - Boolean value for allItems.

CatalogSubscriptionPlan

protected CatalogSubscriptionPlan(String name,
                                  io.apimatic.core.types.OptionalNullable<List<SubscriptionPhase>> phases,
                                  io.apimatic.core.types.OptionalNullable<List<CatalogObject>> subscriptionPlanVariations,
                                  io.apimatic.core.types.OptionalNullable<List<String>> eligibleItemIds,
                                  io.apimatic.core.types.OptionalNullable<List<String>> eligibleCategoryIds,
                                  io.apimatic.core.types.OptionalNullable<Boolean> allItems)

Internal initialization constructor.

Method Detail

getName

public String getName()

Getter for Name. The name of the plan.

Returns:

Returns the String

internalGetPhases

protected io.apimatic.core.types.OptionalNullable<List<SubscriptionPhase>> internalGetPhases()

Internal Getter for Phases. A list of SubscriptionPhase containing the [SubscriptionPhase](entity:SubscriptionPhase) for this plan. This field it required. Not including this field will throw a REQUIRED_FIELD_MISSING error

Returns:

Returns the Internal List of SubscriptionPhase

getPhases

public List<SubscriptionPhase> getPhases()

Getter for Phases. A list of SubscriptionPhase containing the [SubscriptionPhase](entity:SubscriptionPhase) for this plan. This field it required. Not including this field will throw a REQUIRED_FIELD_MISSING error

Returns:

Returns the List of SubscriptionPhase

internalGetSubscriptionPlanVariations

protected io.apimatic.core.types.OptionalNullable<List<CatalogObject>> internalGetSubscriptionPlanVariations()

Internal Getter for SubscriptionPlanVariations. The list of subscription plan variations available for this product

Returns:

Returns the Internal List of CatalogObject

getSubscriptionPlanVariations

public List<CatalogObject> getSubscriptionPlanVariations()

Getter for SubscriptionPlanVariations. The list of subscription plan variations available for this product

Returns:

Returns the List of CatalogObject

internalGetEligibleItemIds

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

Internal Getter for EligibleItemIds. The list of IDs of `CatalogItems` that are eligible for subscription by this SubscriptionPlan's variations.

Returns:

Returns the Internal List of String

getEligibleItemIds

public List<String> getEligibleItemIds()

Getter for EligibleItemIds. The list of IDs of `CatalogItems` that are eligible for subscription by this SubscriptionPlan's variations.

Returns:

Returns the List of String

internalGetEligibleCategoryIds

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

Internal Getter for EligibleCategoryIds. The list of IDs of `CatalogCategory` that are eligible for subscription by this SubscriptionPlan's variations.

Returns:

Returns the Internal List of String

getEligibleCategoryIds

public List<String> getEligibleCategoryIds()

Getter for EligibleCategoryIds. The list of IDs of `CatalogCategory` that are eligible for subscription by this SubscriptionPlan's variations.

Returns:

Returns the List of String

internalGetAllItems

protected io.apimatic.core.types.OptionalNullable<Boolean> internalGetAllItems()

Internal Getter for AllItems. If true, all items in the merchant's catalog are subscribable by this SubscriptionPlan.

Returns:

Returns the Internal Boolean

getAllItems

public Boolean getAllItems()

Getter for AllItems. If true, all items in the merchant's catalog are subscribable by this SubscriptionPlan.

Returns:

Returns the Boolean

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 CatalogSubscriptionPlan into string format.

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public CatalogSubscriptionPlan.Builder toBuilder()

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

Returns:

a new CatalogSubscriptionPlan.Builder object