import type * as Square from "../../../../index";
/**
 * @example
 *     {
 *         textFilter: "red",
 *         categoryIds: ["WINE_CATEGORY_ID"],
 *         stockLevels: ["OUT", "LOW"],
 *         enabledLocationIds: ["ATL_LOCATION_ID"],
 *         limit: 100,
 *         sortOrder: "ASC",
 *         productTypes: ["REGULAR"],
 *         customAttributeFilters: [{
 *                 customAttributeDefinitionId: "VEGAN_DEFINITION_ID",
 *                 boolFilter: true
 *             }, {
 *                 customAttributeDefinitionId: "BRAND_DEFINITION_ID",
 *                 stringFilter: "Dark Horse"
 *             }, {
 *                 key: "VINTAGE",
 *                 numberFilter: {
 *                     min: "min",
 *                     max: "max"
 *                 }
 *             }, {
 *                 customAttributeDefinitionId: "VARIETAL_DEFINITION_ID"
 *             }]
 *     }
 */
export interface SearchCatalogItemsRequest {
    /**
     * 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.
     */
    textFilter?: string;
    /** The category id query expression to return items containing the specified category IDs. */
    categoryIds?: string[];
    /**
     * The stock-level query expression to return item variations with the specified stock levels.
     * See [SearchCatalogItemsRequestStockLevel](#type-searchcatalogitemsrequeststocklevel) for possible values
     */
    stockLevels?: Square.SearchCatalogItemsRequestStockLevel[];
    /** The enabled-location query expression to return items and item variations having specified enabled locations. */
    enabledLocationIds?: string[];
    /** The pagination token, returned in the previous response, used to fetch the next batch of pending results. */
    cursor?: string;
    /** The maximum number of results to return per page. The default value is 100. */
    limit?: number;
    /**
     * The order to sort the results by item names. The default sort order is ascending (`ASC`).
     * See [SortOrder](#type-sortorder) for possible values
     */
    sortOrder?: Square.SortOrder;
    /** The product types query expression to return items or item variations having the specified product types. */
    productTypes?: Square.CatalogItemProductType[];
    /**
     * 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.
     */
    customAttributeFilters?: Square.CustomAttributeFilter[];
    /** The query filter to return not archived (`ARCHIVED_STATE_NOT_ARCHIVED`), archived (`ARCHIVED_STATE_ARCHIVED`), or either type (`ARCHIVED_STATE_ALL`) of items. */
    archivedState?: Square.ArchivedState;
    /** Options to include related resources in the response. */
    includeOptions?: Square.IncludeOptions;
}