defmodule Rea do
  @moduledoc """
  Elixir client for the REA Pricing API.

  This library provides a client for interacting with the REA Pricing API
  using OAuth2 authentication.

  ## Configuration

  Configure environments in your `config/config.exs`:

      config :rea,
        environments: [
          prod: [
            base_url: "https://api.realestate.com.au",
            client_id: System.get_env("REA_PROD_CLIENT_ID"),
            client_secret: System.get_env("REA_PROD_CLIENT_SECRET")
          ]
        ]

  ## Usage

      # Create a client for an environment
      client = Rea.Client.new(environment: :prod)

      # Get prices for realestate.com.au properties
      {:ok, prices} = Rea.Client.RealestateProperties.get_prices(client,
        agency_id: "FEXBNP",
        suburb: "Sydney",
        state: "NSW",
        postcode: "2000"
      )

      # Get prices for realcommercial.com.au properties
      {:ok, prices} = Rea.Client.CommercialProperties.get_prices(client,
        agency_id: "FEXBNP",
        suburb: "Sydney",
        state: "NSW",
        postcode: "2000"
      )
  """
end