/**
 * This file was auto-generated by Fern from our API Definition.
 */
import * as Flatfile from "../../../../index";
/**
 * @example
 *     {
 *         distinct: true,
 *         fieldKey: "firstName",
 *         sortField: "firstName",
 *         sortDirection: "asc",
 *         filter: "valid"
 *     }
 */
export interface GetFieldValuesRequest {
    fieldKey?: Flatfile.FieldKey;
    sortField?: Flatfile.SortField;
    sortDirection?: Flatfile.SortDirection;
    filter?: Flatfile.Filter;
    /**
     * Name of field by which to filter records
     */
    filterField?: Flatfile.FilterField;
    /**
     * Number of records to return in a page (default 1000 if pageNumber included)
     */
    pageSize?: Flatfile.PageSize;
    /**
     * Based on pageSize, which page of records to return
     */
    pageNumber?: Flatfile.PageNumber;
    /**
     * Must be set to true
     */
    distinct: Flatfile.Distinct;
    includeCounts?: Flatfile.IncludeCounts;
    /**
     * A value to find for a given field in a sheet. Wrap the value in "" for exact match
     */
    searchValue?: Flatfile.SearchValue;
    /**
     * An FFQL query used to filter the records to be queried
     */
    q?: string;
}