brasilapi

defmodule Brasilapi do
  @moduledoc """
  A simple Elixir client for BrasilAPI.

  BrasilAPI is a public API that provides access to various Brazilian data
  such as postal codes, states, cities, banks, and more.

  ## Examples

      # Get all banks
      {:ok, banks} = Brasilapi.get_all_banks()

      # Get a specific bank by code
      {:ok, bank} = Brasilapi.get_bank_by_code(1)

      # Get CEP information
      {:ok, cep_data} = Brasilapi.get_cep("89010025")

      # Get CNPJ information
      {:ok, company} = Brasilapi.get_cnpj("19131243000197")

      # Get DDD information
      {:ok, ddd_info} = Brasilapi.get_ddd(11)

      # Get national holidays
      {:ok, holidays} = Brasilapi.get_holidays(2021)

      # Get all tax rates
      {:ok, rates} = Brasilapi.get_all_rates()

      # Get a specific tax rate
      {:ok, rate} = Brasilapi.get_rate_by_acronym("CDI")

      # Get PIX participants
      {:ok, participants} = Brasilapi.get_pix_participants()

      # Get domain information
      {:ok, domain} = Brasilapi.get_domain_info("brasilapi.com.br")

      # Get all currencies
      {:ok, currencies} = Brasilapi.get_currencies()

      # Get exchange rate
      {:ok, exchange_rate} = Brasilapi.get_exchange_rate("USD", "2025-02-13")

      # Get all brokerage firms
      {:ok, brokers} = Brasilapi.get_brokers()

      # Get specific brokerage firm by CNPJ
      {:ok, broker} = Brasilapi.get_broker_by_cnpj("02332886000104")

      # Get book information by ISBN
      {:ok, book} = Brasilapi.get_book("9788545702870")

  """

  alias Brasilapi.{
    Banks,
    Brokers,
    Cep,
    Cnpj,
    Ddd,
    Exchange,
    Feriados,
    Isbn,
    Pix,
    Rates,
    RegistroBr
  }

  @doc """
  Get all banks from BrasilAPI.
  """
  defdelegate get_all_banks(), to: Banks, as: :get_all

  @doc """
  Get a specific bank by its code.
  """
  defdelegate get_bank_by_code(code), to: Banks, as: :get_by_code

  @doc """
  Get CEP (postal code) information using the v2 endpoint.
  """
  defdelegate get_cep(cep), to: Cep, as: :get_by_cep

  @doc """
  Get company information by CNPJ.
  """
  defdelegate get_cnpj(cnpj), to: Cnpj, as: :get_by_cnpj

  @doc """
  Get DDD (area code) information including state and cities.
  """
  defdelegate get_ddd(ddd), to: Ddd, as: :get_by_ddd

  @doc """
  Get national holidays for a specific year.
  """
  defdelegate get_holidays(year), to: Feriados, as: :get_by_year

  @doc """
  Get all available tax rates and indices.
  """
  defdelegate get_all_rates(), to: Rates, as: :get_all

  @doc """
  Get a specific tax rate or index by its name/acronym.
  """
  defdelegate get_rate_by_acronym(acronym), to: Rates, as: :get_by_acronym

  @doc """
  Get all PIX participants.
  """
  defdelegate get_pix_participants(), to: Pix, as: :get_participants

  @doc """
  Get Brazilian domain (.br) registration information.
  """
  defdelegate get_domain_info(domain), to: RegistroBr, as: :get_domain_info

  @doc """
  Get all available currencies for exchange rate queries.
  """
  defdelegate get_currencies(), to: Exchange

  @doc """
  Get the exchange rate between Real and another currency for a specific date.
  """
  defdelegate get_exchange_rate(currency, date), to: Exchange

  @doc """
  Get all active brokerage firms registered with CVM.
  """
  defdelegate get_brokers(), to: Brokers

  @doc """
  Get a specific brokerage firm by its CNPJ from CVM records.
  """
  defdelegate get_broker_by_cnpj(cnpj), to: Brokers

  @doc """
  Get book information by ISBN from multiple providers.
  """
  defdelegate get_book(isbn, opts \\ []), to: Isbn
end