import type * as Square from "../../../../index";
/**
 * @example
 *     {
 *         locationIds: ["057P5VYJ4A5X1", "18YC4JDH91E1H"],
 *         query: {
 *             filter: {
 *                 stateFilter: {
 *                     states: ["COMPLETED"]
 *                 },
 *                 dateTimeFilter: {
 *                     closedAt: {
 *                         startAt: "2018-03-03T20:00:00+00:00",
 *                         endAt: "2019-03-04T21:54:45+00:00"
 *                     }
 *                 }
 *             },
 *             sort: {
 *                 sortField: "CLOSED_AT",
 *                 sortOrder: "DESC"
 *             }
 *         },
 *         limit: 3,
 *         returnEntries: true
 *     }
 */
export interface SearchOrdersRequest {
    /**
     * The location IDs for the orders to query. All locations must belong to
     * the same merchant.
     *
     * Max: 10 location IDs.
     */
    locationIds?: string[];
    /**
     * A pagination cursor returned by a previous call to this endpoint.
     * Provide this cursor to retrieve the next set of results for your original query.
     * For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).
     */
    cursor?: string;
    /**
     * Query conditions used to filter or sort the results. Note that when
     * retrieving additional pages using a cursor, you must use the original query.
     */
    query?: Square.SearchOrdersQuery;
    /**
     * The maximum number of results to be returned in a single page.
     *
     * Default: `500`
     * Max: `1000`
     */
    limit?: number;
    /**
     * A Boolean that controls the format of the search results. If `true`,
     * `SearchOrders` returns [OrderEntry](entity:OrderEntry) objects. If `false`, `SearchOrders`
     * returns complete order objects.
     *
     * Default: `false`.
     */
    returnEntries?: boolean;
}