com.squareup.square.models.ListCatalogRequest Maven / Gradle / Ivy
package com.squareup.square.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 ListCatalogRequest type.
*/
public class ListCatalogRequest {
private final OptionalNullable cursor;
private final OptionalNullable types;
private final OptionalNullable catalogVersion;
/**
* Initialization constructor.
* @param cursor String value for cursor.
* @param types String value for types.
* @param catalogVersion Long value for catalogVersion.
*/
@JsonCreator
public ListCatalogRequest(
@JsonProperty("cursor") String cursor,
@JsonProperty("types") String types,
@JsonProperty("catalog_version") Long catalogVersion) {
this.cursor = OptionalNullable.of(cursor);
this.types = OptionalNullable.of(types);
this.catalogVersion = OptionalNullable.of(catalogVersion);
}
/**
* Initialization constructor.
* @param cursor String value for cursor.
* @param types String value for types.
* @param catalogVersion Long value for catalogVersion.
*/
protected ListCatalogRequest(OptionalNullable cursor, OptionalNullable types,
OptionalNullable catalogVersion) {
this.cursor = cursor;
this.types = types;
this.catalogVersion = catalogVersion;
}
/**
* Internal Getter for Cursor.
* The pagination cursor returned in the previous response. Leave unset for an initial request.
* The page size is currently set to be 100. See
* [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)
* for more information.
* @return Returns the Internal String
*/
@JsonGetter("cursor")
@JsonInclude(JsonInclude.Include.NON_NULL)
@JsonSerialize(using = OptionalNullable.Serializer.class)
protected OptionalNullable internalGetCursor() {
return this.cursor;
}
/**
* Getter for Cursor.
* The pagination cursor returned in the previous response. Leave unset for an initial request.
* The page size is currently set to be 100. See
* [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)
* for more information.
* @return Returns the String
*/
@JsonIgnore
public String getCursor() {
return OptionalNullable.getFrom(cursor);
}
/**
* Internal Getter for Types.
* An optional case-insensitive, comma-separated list of object types to retrieve. The valid
* values are defined in the [CatalogObjectType](entity:CatalogObjectType) enum, for example,
* `ITEM`, `ITEM_VARIATION`, `CATEGORY`, `DISCOUNT`, `TAX`, `MODIFIER`, `MODIFIER_LIST`,
* `IMAGE`, etc. If this is unspecified, the operation returns objects of all the top level
* types at the version of the Square API used to make the request. Object types that are nested
* onto other object types are not included in the defaults. At the current API version the
* default object types are: ITEM, CATEGORY, TAX, DISCOUNT, MODIFIER_LIST, PRICING_RULE,
* PRODUCT_SET, TIME_PERIOD, MEASUREMENT_UNIT, SUBSCRIPTION_PLAN, ITEM_OPTION,
* CUSTOM_ATTRIBUTE_DEFINITION, QUICK_AMOUNT_SETTINGS.
* @return Returns the Internal String
*/
@JsonGetter("types")
@JsonInclude(JsonInclude.Include.NON_NULL)
@JsonSerialize(using = OptionalNullable.Serializer.class)
protected OptionalNullable internalGetTypes() {
return this.types;
}
/**
* Getter for Types.
* An optional case-insensitive, comma-separated list of object types to retrieve. The valid
* values are defined in the [CatalogObjectType](entity:CatalogObjectType) enum, for example,
* `ITEM`, `ITEM_VARIATION`, `CATEGORY`, `DISCOUNT`, `TAX`, `MODIFIER`, `MODIFIER_LIST`,
* `IMAGE`, etc. If this is unspecified, the operation returns objects of all the top level
* types at the version of the Square API used to make the request. Object types that are nested
* onto other object types are not included in the defaults. At the current API version the
* default object types are: ITEM, CATEGORY, TAX, DISCOUNT, MODIFIER_LIST, PRICING_RULE,
* PRODUCT_SET, TIME_PERIOD, MEASUREMENT_UNIT, SUBSCRIPTION_PLAN, ITEM_OPTION,
* CUSTOM_ATTRIBUTE_DEFINITION, QUICK_AMOUNT_SETTINGS.
* @return Returns the String
*/
@JsonIgnore
public String getTypes() {
return OptionalNullable.getFrom(types);
}
/**
* Internal Getter for CatalogVersion.
* The specific version of the catalog objects to be included in the response. This allows you
* to retrieve historical versions of objects. The specified version value is matched against
* the [CatalogObject]($m/CatalogObject)s' `version` attribute. If not included, results will be
* from the current version of the catalog.
* @return Returns the Internal Long
*/
@JsonGetter("catalog_version")
@JsonInclude(JsonInclude.Include.NON_NULL)
@JsonSerialize(using = OptionalNullable.Serializer.class)
protected OptionalNullable internalGetCatalogVersion() {
return this.catalogVersion;
}
/**
* Getter for CatalogVersion.
* The specific version of the catalog objects to be included in the response. This allows you
* to retrieve historical versions of objects. The specified version value is matched against
* the [CatalogObject]($m/CatalogObject)s' `version` attribute. If not included, results will be
* from the current version of the catalog.
* @return Returns the Long
*/
@JsonIgnore
public Long getCatalogVersion() {
return OptionalNullable.getFrom(catalogVersion);
}
@Override
public int hashCode() {
return Objects.hash(cursor, types, catalogVersion);
}
@Override
public boolean equals(Object obj) {
if (obj == this) {
return true;
}
if (!(obj instanceof ListCatalogRequest)) {
return false;
}
ListCatalogRequest other = (ListCatalogRequest) obj;
return Objects.equals(cursor, other.cursor)
&& Objects.equals(types, other.types)
&& Objects.equals(catalogVersion, other.catalogVersion);
}
/**
* Converts this ListCatalogRequest into string format.
* @return String representation of this class
*/
@Override
public String toString() {
return "ListCatalogRequest [" + "cursor=" + cursor + ", types=" + types
+ ", catalogVersion=" + catalogVersion + "]";
}
/**
* Builds a new {@link ListCatalogRequest.Builder} object.
* Creates the instance with the state of the current model.
* @return a new {@link ListCatalogRequest.Builder} object
*/
public Builder toBuilder() {
Builder builder = new Builder();
builder.cursor = internalGetCursor();
builder.types = internalGetTypes();
builder.catalogVersion = internalGetCatalogVersion();
return builder;
}
/**
* Class to build instances of {@link ListCatalogRequest}.
*/
public static class Builder {
private OptionalNullable cursor;
private OptionalNullable types;
private OptionalNullable catalogVersion;
/**
* Setter for cursor.
* @param cursor String value for cursor.
* @return Builder
*/
public Builder cursor(String cursor) {
this.cursor = OptionalNullable.of(cursor);
return this;
}
/**
* UnSetter for cursor.
* @return Builder
*/
public Builder unsetCursor() {
cursor = null;
return this;
}
/**
* Setter for types.
* @param types String value for types.
* @return Builder
*/
public Builder types(String types) {
this.types = OptionalNullable.of(types);
return this;
}
/**
* UnSetter for types.
* @return Builder
*/
public Builder unsetTypes() {
types = null;
return this;
}
/**
* Setter for catalogVersion.
* @param catalogVersion Long value for catalogVersion.
* @return Builder
*/
public Builder catalogVersion(Long catalogVersion) {
this.catalogVersion = OptionalNullable.of(catalogVersion);
return this;
}
/**
* UnSetter for catalogVersion.
* @return Builder
*/
public Builder unsetCatalogVersion() {
catalogVersion = null;
return this;
}
/**
* Builds a new {@link ListCatalogRequest} object using the set fields.
* @return {@link ListCatalogRequest}
*/
public ListCatalogRequest build() {
return new ListCatalogRequest(cursor, types, catalogVersion);
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy