com.squareup.square.legacy.models.SearchCatalogItemsRequest 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.JsonInclude;
import com.fasterxml.jackson.annotation.JsonProperty;
import java.util.List;
import java.util.Objects;
/**
* This is a model class for SearchCatalogItemsRequest type.
*/
public class SearchCatalogItemsRequest {
private final String textFilter;
private final List categoryIds;
private final List stockLevels;
private final List enabledLocationIds;
private final String cursor;
private final Integer limit;
private final String sortOrder;
private final List productTypes;
private final List customAttributeFilters;
private final String archivedState;
/**
* Initialization constructor.
* @param textFilter String value for textFilter.
* @param categoryIds List of String value for categoryIds.
* @param stockLevels List of String value for stockLevels.
* @param enabledLocationIds List of String value for enabledLocationIds.
* @param cursor String value for cursor.
* @param limit Integer value for limit.
* @param sortOrder String value for sortOrder.
* @param productTypes List of String value for productTypes.
* @param customAttributeFilters List of CustomAttributeFilter value for
* customAttributeFilters.
* @param archivedState String value for archivedState.
*/
@JsonCreator
public SearchCatalogItemsRequest(
@JsonProperty("text_filter") String textFilter,
@JsonProperty("category_ids") List categoryIds,
@JsonProperty("stock_levels") List stockLevels,
@JsonProperty("enabled_location_ids") List enabledLocationIds,
@JsonProperty("cursor") String cursor,
@JsonProperty("limit") Integer limit,
@JsonProperty("sort_order") String sortOrder,
@JsonProperty("product_types") List productTypes,
@JsonProperty("custom_attribute_filters") List customAttributeFilters,
@JsonProperty("archived_state") String archivedState) {
this.textFilter = textFilter;
this.categoryIds = categoryIds;
this.stockLevels = stockLevels;
this.enabledLocationIds = enabledLocationIds;
this.cursor = cursor;
this.limit = limit;
this.sortOrder = sortOrder;
this.productTypes = productTypes;
this.customAttributeFilters = customAttributeFilters;
this.archivedState = archivedState;
}
/**
* Getter for TextFilter.
* The text filter expression to return items or item variations containing specified text in
* the `name`, `description`, or `abbreviation` attribute value of an item, or in the `name`,
* `sku`, or `upc` attribute value of an item variation.
* @return Returns the String
*/
@JsonGetter("text_filter")
@JsonInclude(JsonInclude.Include.NON_NULL)
public String getTextFilter() {
return textFilter;
}
/**
* Getter for CategoryIds.
* The category id query expression to return items containing the specified category IDs.
* @return Returns the List of String
*/
@JsonGetter("category_ids")
@JsonInclude(JsonInclude.Include.NON_NULL)
public List getCategoryIds() {
return categoryIds;
}
/**
* Getter for StockLevels.
* The stock-level query expression to return item variations with the specified stock levels.
* See [SearchCatalogItemsRequestStockLevel](#type-searchcatalogitemsrequeststocklevel) for
* possible values
* @return Returns the List of String
*/
@JsonGetter("stock_levels")
@JsonInclude(JsonInclude.Include.NON_NULL)
public List getStockLevels() {
return stockLevels;
}
/**
* Getter for EnabledLocationIds.
* The enabled-location query expression to return items and item variations having specified
* enabled locations.
* @return Returns the List of String
*/
@JsonGetter("enabled_location_ids")
@JsonInclude(JsonInclude.Include.NON_NULL)
public List getEnabledLocationIds() {
return enabledLocationIds;
}
/**
* Getter for Cursor.
* The pagination token, returned in the previous response, used to fetch the next batch of
* pending results.
* @return Returns the String
*/
@JsonGetter("cursor")
@JsonInclude(JsonInclude.Include.NON_NULL)
public String getCursor() {
return cursor;
}
/**
* Getter for Limit.
* The maximum number of results to return per page. The default value is 100.
* @return Returns the Integer
*/
@JsonGetter("limit")
@JsonInclude(JsonInclude.Include.NON_NULL)
public Integer getLimit() {
return limit;
}
/**
* Getter for SortOrder.
* The order (e.g., chronological or alphabetical) in which results from a request are returned.
* @return Returns the String
*/
@JsonGetter("sort_order")
@JsonInclude(JsonInclude.Include.NON_NULL)
public String getSortOrder() {
return sortOrder;
}
/**
* Getter for ProductTypes.
* The product types query expression to return items or item variations having the specified
* product types.
* @return Returns the List of String
*/
@JsonGetter("product_types")
@JsonInclude(JsonInclude.Include.NON_NULL)
public List getProductTypes() {
return productTypes;
}
/**
* Getter for CustomAttributeFilters.
* The customer-attribute filter to return items or item variations matching the specified
* custom attribute expressions. A maximum number of 10 custom attribute expressions are
* supported in a single call to the
* [SearchCatalogItems](api-endpoint:Catalog-SearchCatalogItems) endpoint.
* @return Returns the List of CustomAttributeFilter
*/
@JsonGetter("custom_attribute_filters")
@JsonInclude(JsonInclude.Include.NON_NULL)
public List getCustomAttributeFilters() {
return customAttributeFilters;
}
/**
* Getter for ArchivedState.
* Defines the values for the `archived_state` query expression used in
* [SearchCatalogItems]($e/Catalog/SearchCatalogItems) to return the archived, not archived or
* either type of catalog items.
* @return Returns the String
*/
@JsonGetter("archived_state")
@JsonInclude(JsonInclude.Include.NON_NULL)
public String getArchivedState() {
return archivedState;
}
@Override
public int hashCode() {
return Objects.hash(
textFilter,
categoryIds,
stockLevels,
enabledLocationIds,
cursor,
limit,
sortOrder,
productTypes,
customAttributeFilters,
archivedState);
}
@Override
public boolean equals(Object obj) {
if (obj == this) {
return true;
}
if (!(obj instanceof SearchCatalogItemsRequest)) {
return false;
}
SearchCatalogItemsRequest other = (SearchCatalogItemsRequest) obj;
return Objects.equals(textFilter, other.textFilter)
&& Objects.equals(categoryIds, other.categoryIds)
&& Objects.equals(stockLevels, other.stockLevels)
&& Objects.equals(enabledLocationIds, other.enabledLocationIds)
&& Objects.equals(cursor, other.cursor)
&& Objects.equals(limit, other.limit)
&& Objects.equals(sortOrder, other.sortOrder)
&& Objects.equals(productTypes, other.productTypes)
&& Objects.equals(customAttributeFilters, other.customAttributeFilters)
&& Objects.equals(archivedState, other.archivedState);
}
/**
* Converts this SearchCatalogItemsRequest into string format.
* @return String representation of this class
*/
@Override
public String toString() {
return "SearchCatalogItemsRequest [" + "textFilter=" + textFilter + ", categoryIds="
+ categoryIds + ", stockLevels=" + stockLevels + ", enabledLocationIds="
+ enabledLocationIds + ", cursor=" + cursor + ", limit=" + limit + ", sortOrder="
+ sortOrder + ", productTypes=" + productTypes + ", customAttributeFilters="
+ customAttributeFilters + ", archivedState=" + archivedState + "]";
}
/**
* Builds a new {@link SearchCatalogItemsRequest.Builder} object.
* Creates the instance with the state of the current model.
* @return a new {@link SearchCatalogItemsRequest.Builder} object
*/
public Builder toBuilder() {
Builder builder = new Builder()
.textFilter(getTextFilter())
.categoryIds(getCategoryIds())
.stockLevels(getStockLevels())
.enabledLocationIds(getEnabledLocationIds())
.cursor(getCursor())
.limit(getLimit())
.sortOrder(getSortOrder())
.productTypes(getProductTypes())
.customAttributeFilters(getCustomAttributeFilters())
.archivedState(getArchivedState());
return builder;
}
/**
* Class to build instances of {@link SearchCatalogItemsRequest}.
*/
public static class Builder {
private String textFilter;
private List categoryIds;
private List stockLevels;
private List enabledLocationIds;
private String cursor;
private Integer limit;
private String sortOrder;
private List productTypes;
private List customAttributeFilters;
private String archivedState;
/**
* Setter for textFilter.
* @param textFilter String value for textFilter.
* @return Builder
*/
public Builder textFilter(String textFilter) {
this.textFilter = textFilter;
return this;
}
/**
* Setter for categoryIds.
* @param categoryIds List of String value for categoryIds.
* @return Builder
*/
public Builder categoryIds(List categoryIds) {
this.categoryIds = categoryIds;
return this;
}
/**
* Setter for stockLevels.
* @param stockLevels List of String value for stockLevels.
* @return Builder
*/
public Builder stockLevels(List stockLevels) {
this.stockLevels = stockLevels;
return this;
}
/**
* Setter for enabledLocationIds.
* @param enabledLocationIds List of String value for enabledLocationIds.
* @return Builder
*/
public Builder enabledLocationIds(List enabledLocationIds) {
this.enabledLocationIds = enabledLocationIds;
return this;
}
/**
* Setter for cursor.
* @param cursor String value for cursor.
* @return Builder
*/
public Builder cursor(String cursor) {
this.cursor = cursor;
return this;
}
/**
* Setter for limit.
* @param limit Integer value for limit.
* @return Builder
*/
public Builder limit(Integer limit) {
this.limit = limit;
return this;
}
/**
* Setter for sortOrder.
* @param sortOrder String value for sortOrder.
* @return Builder
*/
public Builder sortOrder(String sortOrder) {
this.sortOrder = sortOrder;
return this;
}
/**
* Setter for productTypes.
* @param productTypes List of String value for productTypes.
* @return Builder
*/
public Builder productTypes(List productTypes) {
this.productTypes = productTypes;
return this;
}
/**
* Setter for customAttributeFilters.
* @param customAttributeFilters List of CustomAttributeFilter value for
* customAttributeFilters.
* @return Builder
*/
public Builder customAttributeFilters(List customAttributeFilters) {
this.customAttributeFilters = customAttributeFilters;
return this;
}
/**
* Setter for archivedState.
* @param archivedState String value for archivedState.
* @return Builder
*/
public Builder archivedState(String archivedState) {
this.archivedState = archivedState;
return this;
}
/**
* Builds a new {@link SearchCatalogItemsRequest} object using the set fields.
* @return {@link SearchCatalogItemsRequest}
*/
public SearchCatalogItemsRequest build() {
return new SearchCatalogItemsRequest(
textFilter,
categoryIds,
stockLevels,
enabledLocationIds,
cursor,
limit,
sortOrder,
productTypes,
customAttributeFilters,
archivedState);
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy