@type body() :: nil | iodata() | map()

@type client() :: module()

@type endpoint() :: url() | {url(), headers()} | {url(), headers(), options()}

@type faceting_struct() ::
  Hui.Query.Facet.t() | Hui.Query.FacetRange.t() | Hui.Query.FacetInterval.t()

@type headers() :: list()

@type highlighting_struct() ::
  Hui.Query.Highlight.t()
  | Hui.Query.HighlighterUnified.t()
  | Hui.Query.HighlighterOriginal.t()
  | Hui.Query.HighlighterFastVector.t()

@type method() :: :get | :post

@type misc_struct() ::
  Hui.Query.MoreLikeThis.t()
  | Hui.Query.Suggest.t()
  | Hui.Query.SpellCheck.t()
  | Hui.Query.Metrics.t()

@type options() :: list()

@type query() :: keyword() | map() | solr_struct() | [solr_struct()]

@type querying_struct() ::
  Hui.Query.Standard.t() | Hui.Query.Common.t() | Hui.Query.DisMax.t()

@type request_url() :: iodata()

@type response() :: {:ok, t()} | {:error, Hui.Error.t()}

@type solr_struct() ::
  querying_struct() | faceting_struct() | highlighting_struct() | misc_struct()

@type t() :: %Hui.Http{
  body: body(),
  client: module(),
  headers: list(),
  method: :get | :post,
  options: keyword(),
  response_parser: module(),
  status: nil | integer(),
  url: request_url()
}

@type update_query() :: binary() | map() | [map()] | Hui.Query.Update.t()

@type url() :: binary() | atom()