auth_error_reason() ::
  :timeout
  | :connect_timeout
  | :non_existent_domain
  | :not_found
  | bad_request()
  | :rate_limited
  | :overloaded
  | :bad_gateway
  | service_unavailable()
  | nonce_not_increasing()
  | :ip_forbidden
  | forbidden()
  | :invalid_signature
  | unauthorized()

auth_error_response() :: {:error, auth_error_reason(), rate_limit() | nil}

auth_response() :: auth_success_response() | auth_error_response()

auth_success_response() :: {:ok, map() | [map()], rate_limit()}

bad_request() :: {:bad_request, error :: map()}

credentials() :: ExBitmex.Credentials.t()

forbidden() :: {:forbidden, message()}

message() :: String.t()

non_auth_error_reason() ::
  :timeout | :not_found | bad_request() | :overloaded | service_unavailable()

non_auth_response() ::
  {:ok, map() | [map()], rate_limit()}
  | {:error, non_auth_error_reason(), rate_limit() | nil}

nonce_not_increasing() :: {:nonce_not_increasing, message()}

params() :: map()

path() :: String.t()

rate_limit() :: ExBitmex.RateLimit.t()

service_unavailable() :: {:service_unavailable, message()}

unauthorized() :: {:unauthorized, message()}