import { TimeRange } from "./timeRange";
import { Identifier } from "./identifier";
import { DistanceRange } from "./distanceRange";
import { Distance } from "./distance";

/**
 * Specifies filtering parameters for hole sections.
 */
export interface HoleSectionFilter {
  /**
   * Filter hole sections that are related to one of given wellbores.
   */
  wellboreIds?: Array<Identifier>;
  /**
   * Filter hole sections with a specific hole size.
   */
  bitSize?: Distance;
  /**
   * Filter hole sections with a specific bit size.
   */
  holeSize?: Distance;
  /**
   * Filter hole sections with hole top in a given measured depth range.
   */
  topMeasuredDepth?: DistanceRange;
  /**
   * Filter hole sections with hole base in a given measured depth range.
   */
  baseMeasuredDepth?: DistanceRange;
  /**
   * Filter hole sections with construction start time within a given time range.
   */
  startTime?: TimeRange;
  /**
   * Filter hole sections with construction end time within a given time range.
   */
  endTime?: TimeRange;
  /**
   * Specifies if the query is to return only definitive or not. If value is not set, all hole sections are returned.
   */
  isDefinitive?: boolean;
}