com.squareup.square.models

Class CatalogCategory

java.lang.Object

com.squareup.square.models.CatalogCategory

public class CatalogCategory
extends Object

This is a model class for CatalogCategory type.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CatalogCategory(io.apimatic.core.types.OptionalNullable<String> name, io.apimatic.core.types.OptionalNullable<List<String>> imageIds, String categoryType, CatalogObjectCategory parentCategory, io.apimatic.core.types.OptionalNullable<Boolean> isTopLevel, io.apimatic.core.types.OptionalNullable<List<String>> channels, io.apimatic.core.types.OptionalNullable<List<String>> availabilityPeriodIds, io.apimatic.core.types.OptionalNullable<Boolean> onlineVisibility, String rootCategory, CatalogEcomSeoData ecomSeoData, io.apimatic.core.types.OptionalNullable<List<CategoryPathToRootNode>> pathToRoot) Initialization constructor.
	CatalogCategory(String name, List<String> imageIds, String categoryType, CatalogObjectCategory parentCategory, Boolean isTopLevel, List<String> channels, List<String> availabilityPeriodIds, Boolean onlineVisibility, String rootCategory, CatalogEcomSeoData ecomSeoData, List<CategoryPathToRootNode> pathToRoot) Initialization constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
List<String>	getAvailabilityPeriodIds() Getter for AvailabilityPeriodIds.
String	getCategoryType() Getter for CategoryType.
List<String>	getChannels() Getter for Channels.
CatalogEcomSeoData	getEcomSeoData() Getter for EcomSeoData.
List<String>	getImageIds() Getter for ImageIds.
Boolean	getIsTopLevel() Getter for IsTopLevel.
String	getName() Getter for Name.
Boolean	getOnlineVisibility() Getter for OnlineVisibility.
CatalogObjectCategory	getParentCategory() Getter for ParentCategory.
List<CategoryPathToRootNode>	getPathToRoot() Getter for PathToRoot.
String	getRootCategory() Getter for RootCategory.
int	hashCode()
protected io.apimatic.core.types.OptionalNullable<List<String>>	internalGetAvailabilityPeriodIds() Internal Getter for AvailabilityPeriodIds.
protected io.apimatic.core.types.OptionalNullable<List<String>>	internalGetChannels() Internal Getter for Channels.
protected io.apimatic.core.types.OptionalNullable<List<String>>	internalGetImageIds() Internal Getter for ImageIds.
protected io.apimatic.core.types.OptionalNullable<Boolean>	internalGetIsTopLevel() Internal Getter for IsTopLevel.
protected io.apimatic.core.types.OptionalNullable<String>	internalGetName() Internal Getter for Name.
protected io.apimatic.core.types.OptionalNullable<Boolean>	internalGetOnlineVisibility() Internal Getter for OnlineVisibility.
protected io.apimatic.core.types.OptionalNullable<List<CategoryPathToRootNode>>	internalGetPathToRoot() Internal Getter for PathToRoot.
CatalogCategory.Builder	toBuilder() Builds a new CatalogCategory.Builder object.
String	toString() Converts this CatalogCategory into string format.

Methods inherited from class java.lang.Object

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

Constructor Detail

CatalogCategory

public CatalogCategory(String name,
                       List<String> imageIds,
                       String categoryType,
                       CatalogObjectCategory parentCategory,
                       Boolean isTopLevel,
                       List<String> channels,
                       List<String> availabilityPeriodIds,
                       Boolean onlineVisibility,
                       String rootCategory,
                       CatalogEcomSeoData ecomSeoData,
                       List<CategoryPathToRootNode> pathToRoot)

Initialization constructor.

Parameters:

name - String value for name.

imageIds - List of String value for imageIds.

categoryType - String value for categoryType.

parentCategory - CatalogObjectCategory value for parentCategory.

isTopLevel - Boolean value for isTopLevel.

channels - List of String value for channels.

availabilityPeriodIds - List of String value for availabilityPeriodIds.

onlineVisibility - Boolean value for onlineVisibility.

rootCategory - String value for rootCategory.

ecomSeoData - CatalogEcomSeoData value for ecomSeoData.

pathToRoot - List of CategoryPathToRootNode value for pathToRoot.

CatalogCategory

protected CatalogCategory(io.apimatic.core.types.OptionalNullable<String> name,
                          io.apimatic.core.types.OptionalNullable<List<String>> imageIds,
                          String categoryType,
                          CatalogObjectCategory parentCategory,
                          io.apimatic.core.types.OptionalNullable<Boolean> isTopLevel,
                          io.apimatic.core.types.OptionalNullable<List<String>> channels,
                          io.apimatic.core.types.OptionalNullable<List<String>> availabilityPeriodIds,
                          io.apimatic.core.types.OptionalNullable<Boolean> onlineVisibility,
                          String rootCategory,
                          CatalogEcomSeoData ecomSeoData,
                          io.apimatic.core.types.OptionalNullable<List<CategoryPathToRootNode>> pathToRoot)

Initialization constructor.

Parameters:

name - String value for name.

imageIds - List of String value for imageIds.

categoryType - String value for categoryType.

parentCategory - CatalogObjectCategory value for parentCategory.

isTopLevel - Boolean value for isTopLevel.

channels - List of String value for channels.

availabilityPeriodIds - List of String value for availabilityPeriodIds.

onlineVisibility - Boolean value for onlineVisibility.

rootCategory - String value for rootCategory.

ecomSeoData - CatalogEcomSeoData value for ecomSeoData.

pathToRoot - List of CategoryPathToRootNode value for pathToRoot.

Method Detail

internalGetName

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

Internal Getter for Name. The category name. This is a searchable attribute for use in applicable query filters, and its value length is of Unicode code points.

Returns:

Returns the Internal String

getName

public String getName()

Getter for Name. The category name. This is a searchable attribute for use in applicable query filters, and its value length is of Unicode code points.

Returns:

Returns the String

internalGetImageIds

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

Internal Getter for ImageIds. The IDs of images associated with this `CatalogCategory` instance. Currently these images are not displayed by Square, but are free to be displayed in 3rd party applications.

Returns:

Returns the Internal List of String

getImageIds

public List<String> getImageIds()

Getter for ImageIds. The IDs of images associated with this `CatalogCategory` instance. Currently these images are not displayed by Square, but are free to be displayed in 3rd party applications.

Returns:

Returns the List of String

getCategoryType

public String getCategoryType()

Getter for CategoryType. Indicates the type of a category.

Returns:

Returns the String

getParentCategory

public CatalogObjectCategory getParentCategory()

Getter for ParentCategory. A category that can be assigned to an item or a parent category that can be assigned to another category. For example, a clothing category can be assigned to a t-shirt item or be made as the parent category to the pants category.

Returns:

Returns the CatalogObjectCategory

internalGetIsTopLevel

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

Internal Getter for IsTopLevel. Indicates whether a category is a top level category, which does not have any parent_category.

Returns:

Returns the Internal Boolean

getIsTopLevel

public Boolean getIsTopLevel()

Getter for IsTopLevel. Indicates whether a category is a top level category, which does not have any parent_category.

Returns:

Returns the Boolean

internalGetChannels

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

Internal Getter for Channels. A list of IDs representing channels, such as a Square Online site, where the category can be made visible.

Returns:

Returns the Internal List of String

getChannels

public List<String> getChannels()

Getter for Channels. A list of IDs representing channels, such as a Square Online site, where the category can be made visible.

Returns:

Returns the List of String

internalGetAvailabilityPeriodIds

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

Internal Getter for AvailabilityPeriodIds. The IDs of the `CatalogAvailabilityPeriod` objects associated with the category.

Returns:

Returns the Internal List of String

getAvailabilityPeriodIds

public List<String> getAvailabilityPeriodIds()

Getter for AvailabilityPeriodIds. The IDs of the `CatalogAvailabilityPeriod` objects associated with the category.

Returns:

Returns the List of String

internalGetOnlineVisibility

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

Internal Getter for OnlineVisibility. Indicates whether the category is visible (`true`) or hidden (`false`) on all of the seller's Square Online sites.

Returns:

Returns the Internal Boolean

getOnlineVisibility

public Boolean getOnlineVisibility()

Getter for OnlineVisibility. Indicates whether the category is visible (`true`) or hidden (`false`) on all of the seller's Square Online sites.

Returns:

Returns the Boolean

getRootCategory

public String getRootCategory()

Getter for RootCategory. The top-level category in a category hierarchy.

Returns:

Returns the String

getEcomSeoData

public CatalogEcomSeoData getEcomSeoData()

Getter for EcomSeoData. SEO data for for a seller's Square Online store.

Returns:

Returns the CatalogEcomSeoData

internalGetPathToRoot

protected io.apimatic.core.types.OptionalNullable<List<CategoryPathToRootNode>> internalGetPathToRoot()

Internal Getter for PathToRoot. The path from the category to its root category. The first node of the path is the parent of the category and the last is the root category. The path is empty if the category is a root category.

Returns:

Returns the Internal List of CategoryPathToRootNode

getPathToRoot

public List<CategoryPathToRootNode> getPathToRoot()

Getter for PathToRoot. The path from the category to its root category. The first node of the path is the parent of the category and the last is the root category. The path is empty if the category is a root category.

Returns:

Returns the List of CategoryPathToRootNode

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

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public CatalogCategory.Builder toBuilder()

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

Returns:

a new CatalogCategory.Builder object