import { WellSearch } from "./wellSearch";
import { WellFilter } from "./wellFilter";
import { WellFilterAggregatesEnum } from "./wellFilterAggregatesEnum";

/**
 * Filters to apply in well search.
 */
export interface WellFilterRequest {
  filter?: WellFilter;
  search?: WellSearch;
  /**
   * Specifies coordinate reference system (CRS) for output coordinates. The `outputCrs` must be on the format `EPSG:####` or `ESRI:####`. If not specified, the CRS will be the one the wells were ingested with.
   */
  outputCrs?: string;
  /**
   * If set, the `wellsCount` and `wellboresCount` properties in the response will be set to the total number of items that matched the query.
   */
  aggregates?: Array<WellFilterAggregatesEnum>;
  /**
   * Maximum number of rows returned in one request. If there is more data beyond this limit, a cursor will be returned to enable further fetching of data.
   */
  limit?: number;
  /**
   * Cursor for pagination returned from a previous request. Apart from cursor and limit, the rest of the request object must be the same as for the original request.
   */
  cursor?: string;
}