import { AssetSource } from "./assetSource";
import { Wellhead } from "./wellhead";
import { Distance } from "./distance";

export interface WellSource {
  /**
   * Unique identifier used to match wells from different sources. The matchingId must be unique within a source.
   */
  matchingId?: string;
  /**
   * Name of the well.
   */
  name: string;
  /**
   * Description of the well.
   */
  description?: string;
  /**
   * `uniqueWellIdentifier` (also called UWI) is a guaranteed unique identifier. All wells that share the same `matchingId` must also share the same `uniqueWellIdentifier`, or have it set to `null`.
   */
  uniqueWellIdentifier?: string;
  /**
   * The country the well is located in.
   */
  country?: string;
  /**
   * The quadrant of the well. This is the first part of the unique well identifier used on the Norwegian continental shelf. The well `15/9-19-RS` in the VOLVE field is in quadrant `15`.
   */
  quadrant?: string;
  /**
   * Region of the well.
   */
  region?: string;
  /**
   * The date a new well was _spudded_, or the date of first actual penetration of the earth with a drilling bit.
   */
  spudDate?: string;
  /**
   * The block of the well. This is the second part of the unique well identifer used on the Norwegian continental shelf. The well `15/9-19-RS` in the VOLVE field is in block `15/9`.
   */
  block?: string;
  /**
   * Field of the well.
   */
  field?: string;
  /**
   * Operator of the well.
   */
  operator?: string;
  /**
   * The type of the well, for example, exploration or development.
   */
  wellType?: string;
  /**
   * The name of the license this well is associated with.
   */
  license?: string;
  /**
   * Water depth of the well. Vertical distance from the mean sea level to the sea bed.
   */
  waterDepth?: Distance;
  wellhead?: Wellhead;
  /**
   * Connection between the well and the well asset with a given source.
   */
  source: AssetSource;
}