brasilapi 0.7.0 → 0.9.0

data/lib/brasil_api/ibge.rb

@@ -1,21 +1,185 @@
 # frozen_string_literal: true
 
+# Cliente Ruby da {https://brasilapi.com.br BrasilAPI}.
+#
+# @example Bancos participantes do STR
+#   BrasilAPI::Bank.all
+# @see https://brasilapi.com.br/docs
 module BrasilAPI
+  # Estados, municípios, regiões e CNAE do IBGE.
+  #
+  # @see https://brasilapi.com.br/docs#tag/IBGE
   class IBGE < Base
     class << self
+      # Lista as unidades federativas.
+      #
+      # @return [Array<Hash>] sigla, nome e região de cada UF
+      # @raise [BrasilAPI::BadRequest] quando a BrasilAPI responde 400
+      # @raise [BrasilAPI::NotFound] quando a BrasilAPI responde 404
+      # @raise [BrasilAPI::ServerError] quando a BrasilAPI responde 5xx
+      # @raise [BrasilAPI::Timeout] quando a requisição estoura o tempo limite
+      # @raise [BrasilAPI::Error] em outras respostas de erro
+      # @example
+      #   BrasilAPI::IBGE.states
+      # @see https://brasilapi.com.br/docs#tag/IBGE
       def states
         get("/ibge/uf/v1")
       end
 
+      # Busca uma unidade federativa pelo código ou pela sigla.
+      #
+      # @param code [String, Integer] código IBGE ou sigla, por exemplo +"PI"+
+      # @return [Hash] dados da UF
+      # @raise [BrasilAPI::BadRequest] quando a BrasilAPI responde 400
+      # @raise [BrasilAPI::NotFound] quando a UF não existe
+      # @raise [BrasilAPI::ServerError] quando a BrasilAPI responde 5xx
+      # @raise [BrasilAPI::Timeout] quando a requisição estoura o tempo limite
+      # @raise [BrasilAPI::Error] em outras respostas de erro
+      # @example
+      #   BrasilAPI::IBGE.find_state_by_code("PI")
+      # @see https://brasilapi.com.br/docs#tag/IBGE
       def find_state_by_code(code)
         get("/ibge/uf/v1/#{code}")
       end
 
+      # Lista os municípios de uma UF.
+      #
+      # +providers+ vazio omite a query. Valores aceitos: +"dados-abertos-br"+,
+      # +"gov"+ e +"wikipedia"+.
+      #
+      # @param state_abbr [String] sigla da UF
+      # @param providers [Array<String>] fontes consultadas, separadas por vírgula na API
+      # @return [Array<Hash>] nome e código de cada município
+      # @raise [BrasilAPI::BadRequest] quando a BrasilAPI responde 400
+      # @raise [BrasilAPI::NotFound] quando a UF não existe
+      # @raise [BrasilAPI::ServerError] quando a BrasilAPI responde 5xx
+      # @raise [BrasilAPI::Timeout] quando a requisição estoura o tempo limite
+      # @raise [BrasilAPI::Error] em outras respostas de erro
+      # @example Municípios do Piauí
+      #   BrasilAPI::IBGE.cities_by_state("PI", providers: ["gov"])
+      # @see https://brasilapi.com.br/docs#tag/IBGE
       def cities_by_state(state_abbr, providers: [])
         return get("/ibge/municipios/v1/#{state_abbr}") if providers.empty?
 
         get("/ibge/municipios/v1/#{state_abbr}", providers: providers.join(","))
       end
+
+      # Lista as cinco regiões do Brasil.
+      #
+      # @return [Array<Hash>] código, sigla e nome de cada região
+      # @raise [BrasilAPI::BadRequest] quando a BrasilAPI responde 400
+      # @raise [BrasilAPI::NotFound] quando a BrasilAPI responde 404
+      # @raise [BrasilAPI::ServerError] quando a BrasilAPI responde 5xx
+      # @raise [BrasilAPI::Timeout] quando a requisição estoura o tempo limite
+      # @raise [BrasilAPI::Error] em outras respostas de erro
+      # @example
+      #   BrasilAPI::IBGE.regions
+      # @see https://brasilapi.com.br/docs#tag/IBGE
+      def regions
+        get("/ibge/regioes/v1")
+      end
+
+      # Busca uma região pelo código IBGE.
+      #
+      # @param code [String, Integer] código da região, de 1 a 5
+      # @return [Hash] sigla e nome da região
+      # @raise [BrasilAPI::BadRequest] quando a BrasilAPI responde 400
+      # @raise [BrasilAPI::NotFound] quando a região não existe
+      # @raise [BrasilAPI::ServerError] quando a BrasilAPI responde 5xx
+      # @raise [BrasilAPI::Timeout] quando a requisição estoura o tempo limite
+      # @raise [BrasilAPI::Error] em outras respostas de erro
+      # @example Região Norte
+      #   BrasilAPI::IBGE.find_region_by_code(1)
+      # @see https://brasilapi.com.br/docs#tag/IBGE
+      def find_region_by_code(code)
+        get("/ibge/regioes/v1/#{code}")
+      end
+
+      # Lista as unidades federativas de uma região.
+      #
+      # @param code [String, Integer] código da região, de 1 a 5
+      # @return [Array<Hash>] UFs da região
+      # @raise [BrasilAPI::BadRequest] quando a BrasilAPI responde 400
+      # @raise [BrasilAPI::NotFound] quando a região não existe
+      # @raise [BrasilAPI::ServerError] quando a BrasilAPI responde 5xx
+      # @raise [BrasilAPI::Timeout] quando a requisição estoura o tempo limite
+      # @raise [BrasilAPI::Error] em outras respostas de erro
+      # @example Estados do Norte
+      #   BrasilAPI::IBGE.states_by_region(1)
+      # @see https://brasilapi.com.br/docs#tag/IBGE
+      def states_by_region(code)
+        get("/ibge/uf/v1/regiao/#{code}")
+      end
+    end
+
+    # Classificação Nacional de Atividades Econômicas.
+    #
+    # @see https://brasilapi.com.br/docs#tag/IBGE
+    class CNAE < Base
+      class << self
+        # Lista as classes CNAE.
+        #
+        # @return [Array<Hash>] código e descrição de cada classe
+        # @raise [BrasilAPI::BadRequest] quando a BrasilAPI responde 400
+        # @raise [BrasilAPI::NotFound] quando a BrasilAPI responde 404
+        # @raise [BrasilAPI::ServerError] quando a BrasilAPI responde 5xx
+        # @raise [BrasilAPI::Timeout] quando a requisição estoura o tempo limite
+        # @raise [BrasilAPI::Error] em outras respostas de erro
+        # @example
+        #   BrasilAPI::IBGE::CNAE.classes
+        # @see https://brasilapi.com.br/docs#tag/IBGE
+        def classes
+          get("/ibge/cnae/v1/classes")
+        end
+
+        # Busca uma classe CNAE pelo código.
+        #
+        # @param code [String, Integer] código da classe, por exemplo +"01113"+
+        # @return [Hash] descrição da classe e do grupo
+        # @raise [BrasilAPI::BadRequest] quando a BrasilAPI responde 400
+        # @raise [BrasilAPI::NotFound] quando a classe não existe
+        # @raise [BrasilAPI::ServerError] quando a BrasilAPI responde 5xx
+        # @raise [BrasilAPI::Timeout] quando a requisição estoura o tempo limite
+        # @raise [BrasilAPI::Error] em outras respostas de erro
+        # @example Cultivo de cereais
+        #   BrasilAPI::IBGE::CNAE.find_class("01113")
+        # @see https://brasilapi.com.br/docs#tag/IBGE
+        def find_class(code)
+          get("/ibge/cnae/v1/classes/#{code}")
+        end
+
+        # Busca uma divisão CNAE pelo código.
+        #
+        # @param code [String, Integer] código da divisão, por exemplo +"01"+
+        # @return [Hash] descrição da divisão
+        # @raise [BrasilAPI::BadRequest] quando a BrasilAPI responde 400
+        # @raise [BrasilAPI::NotFound] quando a divisão não existe
+        # @raise [BrasilAPI::ServerError] quando a BrasilAPI responde 5xx
+        # @raise [BrasilAPI::Timeout] quando a requisição estoura o tempo limite
+        # @raise [BrasilAPI::Error] em outras respostas de erro
+        # @example Agricultura, pecuária e serviços relacionados
+        #   BrasilAPI::IBGE::CNAE.find_division("01")
+        # @see https://brasilapi.com.br/docs#tag/IBGE
+        def find_division(code)
+          get("/ibge/cnae/v1/divisoes/#{code}")
+        end
+
+        # Busca um grupo CNAE pelo código.
+        #
+        # @param code [String, Integer] código do grupo, por exemplo +"011"+
+        # @return [Hash] descrição do grupo
+        # @raise [BrasilAPI::BadRequest] quando a BrasilAPI responde 400
+        # @raise [BrasilAPI::NotFound] quando o grupo não existe
+        # @raise [BrasilAPI::ServerError] quando a BrasilAPI responde 5xx
+        # @raise [BrasilAPI::Timeout] quando a requisição estoura o tempo limite
+        # @raise [BrasilAPI::Error] em outras respostas de erro
+        # @example Produção de lavouras temporárias
+        #   BrasilAPI::IBGE::CNAE.find_group("011")
+        # @see https://brasilapi.com.br/docs#tag/IBGE
+        def find_group(code)
+          get("/ibge/cnae/v1/grupos/#{code}")
+        end
+      end
     end
   end
 end

data/lib/brasil_api/ibpt.rb

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+
+# Cliente Ruby da {https://brasilapi.com.br BrasilAPI}.
+#
+# @example Bancos participantes do STR
+#   BrasilAPI::Bank.all
+# @see https://brasilapi.com.br/docs
+module BrasilAPI
+  # Tabelas do Instituto Brasileiro de Planejamento e Tributação.
+  #
+  # @see https://brasilapi.com.br/docs#tag/IBPT
+  class IBPT < Base
+    class << self
+      # Informa a versão publicada das tabelas IBPT.
+      #
+      # @return [Hash] versão vigente
+      # @raise [BrasilAPI::BadRequest] quando a BrasilAPI responde 400
+      # @raise [BrasilAPI::NotFound] quando a BrasilAPI responde 404
+      # @raise [BrasilAPI::ServerError] quando a BrasilAPI responde 5xx
+      # @raise [BrasilAPI::Timeout] quando a requisição estoura o tempo limite
+      # @raise [BrasilAPI::Error] em outras respostas de erro
+      # @example
+      #   BrasilAPI::IBPT.version
+      # @see https://brasilapi.com.br/docs#tag/IBPT
+      def version
+        get("/ibpt/versao/v1")
+      end
+
+      # Consulta a tabela NCM do IBPT em uma UF.
+      #
+      # Sem +code+, devolve a tabela inteira da UF. +exception+ vira o parâmetro +ex+.
+      #
+      # @param state [String] sigla da UF
+      # @param code [String, nil] código NCM de oito dígitos
+      # @param exception [String, nil] exceção da TIPI, por exemplo +"01"+
+      # @return [Hash, Array<Hash>] alíquotas do item ou a tabela da UF
+      # @raise [BrasilAPI::BadRequest] quando a UF ou o código é inválido
+      # @raise [BrasilAPI::NotFound] quando o código não existe na UF
+      # @raise [BrasilAPI::ServerError] quando a BrasilAPI responde 5xx
+      # @raise [BrasilAPI::Timeout] quando a requisição estoura o tempo limite
+      # @raise [BrasilAPI::Error] em outras respostas de erro
+      # @example NCM de cavalos em São Paulo
+      #   BrasilAPI::IBPT.ncm("SP", "01012100")
+      # @see https://brasilapi.com.br/docs#tag/IBPT
+      def ncm(state, code = nil, exception: nil)
+        lookup("ncm", state, code, exception)
+      end
+
+      # Consulta a tabela NBS do IBPT em uma UF.
+      #
+      # Sem +code+, devolve a tabela inteira da UF. O código NBS tem nove dígitos.
+      #
+      # @param state [String] sigla da UF
+      # @param code [String, nil] código NBS
+      # @param exception [String, nil] exceção tributária (+ex+)
+      # @return [Hash, Array<Hash>] alíquotas do item ou a tabela da UF
+      # @raise [BrasilAPI::BadRequest] quando a UF ou o código é inválido
+      # @raise [BrasilAPI::NotFound] quando o código não existe na UF
+      # @raise [BrasilAPI::ServerError] quando a BrasilAPI responde 5xx
+      # @raise [BrasilAPI::Timeout] quando a requisição estoura o tempo limite
+      # @raise [BrasilAPI::Error] em outras respostas de erro
+      # @example
+      #   BrasilAPI::IBPT.nbs("SP", "101011000")
+      # @see https://brasilapi.com.br/docs#tag/IBPT
+      def nbs(state, code = nil, exception: nil)
+        lookup("nbs", state, code, exception)
+      end
+
+      # Consulta a tabela da LC 116 do IBPT em uma UF.
+      #
+      # Sem +code+, devolve a tabela inteira da UF. O código tem quatro dígitos, sem ponto.
+      #
+      # @param state [String] sigla da UF
+      # @param code [String, nil] código da LC 116, por exemplo +"0101"+
+      # @param exception [String, nil] exceção tributária (+ex+)
+      # @return [Hash, Array<Hash>] alíquotas do item ou a tabela da UF
+      # @raise [BrasilAPI::BadRequest] quando a UF ou o código é inválido
+      # @raise [BrasilAPI::NotFound] quando o código não existe na UF
+      # @raise [BrasilAPI::ServerError] quando a BrasilAPI responde 5xx
+      # @raise [BrasilAPI::Timeout] quando a requisição estoura o tempo limite
+      # @raise [BrasilAPI::Error] em outras respostas de erro
+      # @example
+      #   BrasilAPI::IBPT.lc116("SP", "0101")
+      # @see https://brasilapi.com.br/docs#tag/IBPT
+      def lc116(state, code = nil, exception: nil)
+        lookup("lc116", state, code, exception)
+      end
+
+      private
+
+      # Monta +/ibpt/{tipo}/v1/{uf}/{codigo}+ e envia a exceção em +ex+.
+      #
+      # @api private
+      # @param kind [String] +"ncm"+, +"nbs"+ ou +"lc116"+
+      # @param state [String] sigla da UF
+      # @param code [String, nil] código do item
+      # @param exception [String, nil] exceção tributária
+      # @return [Hash, Array<Hash>]
+      # @raise [BrasilAPI::Error]
+      def lookup(kind, state, code, exception)
+        path = ["/ibpt/#{kind}/v1", state, code].compact.join("/")
+        get(path, { ex: exception })
+      end
+    end
+  end
+end

data/lib/brasil_api/igpm.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+# Cliente Ruby da {https://brasilapi.com.br BrasilAPI}.
+#
+# @example Bancos participantes do STR
+#   BrasilAPI::Bank.all
+# @see https://brasilapi.com.br/docs
+module BrasilAPI
+  # Índice Geral de Preços do Mercado.
+  #
+  # @see https://brasilapi.com.br/docs#tag/IGPM
+  class IGPM < Base
+    class << self
+      # Lista a série histórica do IGP-M.
+      #
+      # @return [Array<Hash>] mês e valor de cada apuração
+      # @raise [BrasilAPI::BadRequest] quando a BrasilAPI responde 400
+      # @raise [BrasilAPI::NotFound] quando a BrasilAPI responde 404
+      # @raise [BrasilAPI::ServerError] quando a BrasilAPI responde 5xx
+      # @raise [BrasilAPI::Timeout] quando a requisição estoura o tempo limite
+      # @raise [BrasilAPI::Error] em outras respostas de erro
+      # @example
+      #   BrasilAPI::IGPM.all
+      # @see https://brasilapi.com.br/docs#tag/IGPM
+      def all
+        get("/indices/igpm/v1")
+      end
+
+      # Devolve as apurações mais recentes.
+      #
+      # @param limit [Integer] quantidade de meses
+      # @return [Array<Hash>] últimas apurações, da mais nova para a mais antiga
+      # @raise [BrasilAPI::BadRequest] quando o limite é inválido
+      # @raise [BrasilAPI::NotFound] quando a BrasilAPI responde 404
+      # @raise [BrasilAPI::ServerError] quando a BrasilAPI responde 5xx
+      # @raise [BrasilAPI::Timeout] quando a requisição estoura o tempo limite
+      # @raise [BrasilAPI::Error] em outras respostas de erro
+      # @example Dois últimos meses
+      #   BrasilAPI::IGPM.last(2)
+      # @see https://brasilapi.com.br/docs#tag/IGPM
+      def last(limit)
+        get("/indices/igpm/v1/ultimos", { limit: limit })
+      end
+
+      # Lista as apurações entre duas datas.
+      #
+      # @param initial_date [Date, Time, DateTime, String] início do intervalo
+      # @param final_date [Date, Time, DateTime, String] fim do intervalo
+      # @return [Array<Hash>] apurações do período
+      # @raise [BrasilAPI::BadRequest] quando o intervalo é inválido
+      # @raise [BrasilAPI::NotFound] quando a BrasilAPI responde 404
+      # @raise [BrasilAPI::ServerError] quando a BrasilAPI responde 5xx
+      # @raise [BrasilAPI::Timeout] quando a requisição estoura o tempo limite
+      # @raise [BrasilAPI::Error] em outras respostas de erro
+      # @example Janeiro de 2024
+      #   BrasilAPI::IGPM.between("2024-01-01", "2024-02-01")
+      # @see https://brasilapi.com.br/docs#tag/IGPM
+      def between(initial_date, final_date)
+        get(
+          "/indices/igpm/v1/intervalo",
+          { initial_date: format_date(initial_date), final_date: format_date(final_date) }
+        )
+      end
+    end
+  end
+end

data/lib/brasil_api/isbn.rb

@@ -1,8 +1,33 @@
 # frozen_string_literal: true
 
+# Cliente Ruby da {https://brasilapi.com.br BrasilAPI}.
+#
+# @example Bancos participantes do STR
+#   BrasilAPI::Bank.all
+# @see https://brasilapi.com.br/docs
 module BrasilAPI
+  # Metadados de livros a partir do ISBN.
+  #
+  # @see https://brasilapi.com.br/docs#tag/ISBN
   class ISBN < Base
     class << self
+      # Busca um livro pelo ISBN.
+      #
+      # A BrasilAPI valida ISBNs brasileiros (+978+ seguido de +65+ ou +85+).
+      # +providers+ vazio omite a query. Valores aceitos: +"cbl"+,
+      # +"mercado-editorial"+, +"open-library"+ e +"google-books"+.
+      #
+      # @param code [String] ISBN-13, com ou sem hífen
+      # @param providers [Array<String>] fontes consultadas, separadas por vírgula na API
+      # @return [Hash] título, autores e editora
+      # @raise [BrasilAPI::BadRequest] quando o ISBN não segue o padrão brasileiro
+      # @raise [BrasilAPI::NotFound] quando nenhuma fonte encontra o livro
+      # @raise [BrasilAPI::ServerError] quando a BrasilAPI responde 5xx
+      # @raise [BrasilAPI::Timeout] quando a requisição estoura o tempo limite
+      # @raise [BrasilAPI::Error] em outras respostas de erro
+      # @example Akira, volume 1
+      #   BrasilAPI::ISBN.search("9788545702870", providers: ["open-library"])
+      # @see https://brasilapi.com.br/docs#tag/ISBN
       def search(code, providers: [])
         return get("/isbn/v1/#{code}") if providers.empty?
 

data/lib/brasil_api/ncm.rb

@@ -1,16 +1,59 @@
 # frozen_string_literal: true
 
+# Cliente Ruby da {https://brasilapi.com.br BrasilAPI}.
+#
+# @example Bancos participantes do STR
+#   BrasilAPI::Bank.all
+# @see https://brasilapi.com.br/docs
 module BrasilAPI
+  # Nomenclatura Comum do Mercosul.
+  #
+  # @see https://brasilapi.com.br/docs#tag/NCM
   class NCM < Base
     class << self
+      # Lista todos os códigos NCM.
+      #
+      # @return [Array<Hash>] código e descrição de cada NCM
+      # @raise [BrasilAPI::BadRequest] quando a BrasilAPI responde 400
+      # @raise [BrasilAPI::NotFound] quando a BrasilAPI responde 404
+      # @raise [BrasilAPI::ServerError] quando a BrasilAPI responde 5xx
+      # @raise [BrasilAPI::Timeout] quando a requisição estoura o tempo limite
+      # @raise [BrasilAPI::Error] em outras respostas de erro
+      # @example
+      #   BrasilAPI::NCM.all
+      # @see https://brasilapi.com.br/docs#tag/NCM
       def all
         get("/ncm/v1")
       end
 
+      # Procura códigos NCM por texto ou por prefixo.
+      #
+      # @param code [String] termo de busca, por exemplo +"cafe"+
+      # @return [Array<Hash>] NCMs que correspondem à busca
+      # @raise [BrasilAPI::BadRequest] quando a BrasilAPI responde 400
+      # @raise [BrasilAPI::NotFound] quando nada corresponde
+      # @raise [BrasilAPI::ServerError] quando a BrasilAPI responde 5xx
+      # @raise [BrasilAPI::Timeout] quando a requisição estoura o tempo limite
+      # @raise [BrasilAPI::Error] em outras respostas de erro
+      # @example
+      #   BrasilAPI::NCM.search("cafe")
+      # @see https://brasilapi.com.br/docs#tag/NCM
       def search(code)
         get("/ncm/v1", { search: code })
       end
 
+      # Busca um NCM pelo código completo.
+      #
+      # @param code [String] código NCM de oito dígitos
+      # @return [Hash] descrição e vigência do código
+      # @raise [BrasilAPI::BadRequest] quando a BrasilAPI responde 400
+      # @raise [BrasilAPI::NotFound] quando o código não existe
+      # @raise [BrasilAPI::ServerError] quando a BrasilAPI responde 5xx
+      # @raise [BrasilAPI::Timeout] quando a requisição estoura o tempo limite
+      # @raise [BrasilAPI::Error] em outras respostas de erro
+      # @example Cavalos reprodutores de raça pura
+      #   BrasilAPI::NCM.find_by_code("01012100")
+      # @see https://brasilapi.com.br/docs#tag/NCM
       def find_by_code(code)
         get("/ncm/v1/#{code}")
       end

data/lib/brasil_api/pix.rb

@@ -1,8 +1,27 @@
 # frozen_string_literal: true
 
+# Cliente Ruby da {https://brasilapi.com.br BrasilAPI}.
+#
+# @example Bancos participantes do STR
+#   BrasilAPI::Bank.all
+# @see https://brasilapi.com.br/docs
 module BrasilAPI
+  # Participantes do arranjo de pagamentos PIX.
+  #
+  # @see https://brasilapi.com.br/docs#tag/PIX
   class PIX < Base
     class << self
+      # Lista as instituições participantes do PIX.
+      #
+      # @return [Array<Hash>] ISPB, nome e modalidade de cada participante
+      # @raise [BrasilAPI::BadRequest] quando a BrasilAPI responde 400
+      # @raise [BrasilAPI::NotFound] quando a BrasilAPI responde 404
+      # @raise [BrasilAPI::ServerError] quando a BrasilAPI responde 5xx
+      # @raise [BrasilAPI::Timeout] quando a requisição estoura o tempo limite
+      # @raise [BrasilAPI::Error] em outras respostas de erro
+      # @example
+      #   BrasilAPI::PIX.all
+      # @see https://brasilapi.com.br/docs#tag/PIX
       def all
         get("/pix/v1/participants")
       end

data/lib/brasil_api/registrobr.rb

@@ -1,8 +1,28 @@
 # frozen_string_literal: true
 
+# Cliente Ruby da {https://brasilapi.com.br BrasilAPI}.
+#
+# @example Bancos participantes do STR
+#   BrasilAPI::Bank.all
+# @see https://brasilapi.com.br/docs
 module BrasilAPI
+  # Disponibilidade de domínios +.br+ no Registro.br.
+  #
+  # @see https://brasilapi.com.br/docs#tag/REGISTRO-BR
   class RegistroBR < Base
     class << self
+      # Consulta o status de um domínio +.br+.
+      #
+      # @param domain [String] domínio, por exemplo +"google.com.br"+
+      # @return [Hash] status +"REGISTERED"+ ou +"AVAILABLE"+ e as datas conhecidas
+      # @raise [BrasilAPI::BadRequest] quando o domínio é inválido
+      # @raise [BrasilAPI::NotFound] quando a BrasilAPI responde 404
+      # @raise [BrasilAPI::ServerError] quando a BrasilAPI responde 5xx
+      # @raise [BrasilAPI::Timeout] quando a requisição estoura o tempo limite
+      # @raise [BrasilAPI::Error] em outras respostas de erro
+      # @example
+      #   BrasilAPI::RegistroBR.whois("google.com.br")
+      # @see https://brasilapi.com.br/docs#tag/REGISTRO-BR
       def whois(domain)
         get("/registrobr/v1/#{domain}")
       end

data/lib/brasil_api/solar.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+# Cliente Ruby da {https://brasilapi.com.br BrasilAPI}.
+#
+# @example Bancos participantes do STR
+#   BrasilAPI::Bank.all
+# @see https://brasilapi.com.br/docs
+module BrasilAPI
+  # Irradiação solar média por localidade.
+  #
+  # @see https://brasilapi.com.br/docs#tag/SOLAR
+  class Solar < Base
+    class << self
+      # Consulta a incidência solar de uma localidade.
+      #
+      # A rota é +/solar/v1+ e +location+ pode ser uma cidade ou um par latitude,longitude.
+      #
+      # @param location [String] localidade, por exemplo +"Teresina"+
+      # @return [Hash] irradiação média da localidade
+      # @raise [BrasilAPI::BadRequest] quando a localidade é inválida
+      # @raise [BrasilAPI::NotFound] quando a localidade não é encontrada
+      # @raise [BrasilAPI::ServerError] quando a BrasilAPI responde 5xx
+      # @raise [BrasilAPI::Timeout] quando a requisição estoura o tempo limite
+      # @raise [BrasilAPI::Error] em outras respostas de erro
+      # @example
+      #   BrasilAPI::Solar.incidence("Teresina")
+      # @see https://brasilapi.com.br/docs#tag/SOLAR
+      def incidence(location)
+        get("/solar/v1", { location: location })
+      end
+    end
+  end
+end

data/lib/brasil_api/status.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+# Cliente Ruby da {https://brasilapi.com.br BrasilAPI}.
+#
+# @example Bancos participantes do STR
+#   BrasilAPI::Bank.all
+# @see https://brasilapi.com.br/docs
+module BrasilAPI
+  # Saúde dos serviços da BrasilAPI.
+  #
+  # @see https://brasilapi.com.br/docs#tag/STATUS
+  class Status < Base
+    class << self
+      # Consulta o status atual da BrasilAPI.
+      #
+      # @return [Hash] status geral e a situação de cada serviço
+      # @raise [BrasilAPI::BadRequest] quando a BrasilAPI responde 400
+      # @raise [BrasilAPI::NotFound] quando a BrasilAPI responde 404
+      # @raise [BrasilAPI::ServerError] quando a BrasilAPI responde 5xx
+      # @raise [BrasilAPI::Timeout] quando a requisição estoura o tempo limite
+      # @raise [BrasilAPI::Error] em outras respostas de erro
+      # @example
+      #   BrasilAPI::Status.check
+      # @see https://brasilapi.com.br/docs#tag/STATUS
+      def check
+        get("/status/v1")
+      end
+    end
+  end
+end

data/lib/brasil_api/taxas.rb

@@ -1,12 +1,43 @@
 # frozen_string_literal: true
 
+# Cliente Ruby da {https://brasilapi.com.br BrasilAPI}.
+#
+# @example Bancos participantes do STR
+#   BrasilAPI::Bank.all
+# @see https://brasilapi.com.br/docs
 module BrasilAPI
+  # Taxas de juros e índices oficiais.
+  #
+  # @see https://brasilapi.com.br/docs#tag/TAXAS
   class Taxas < Base
     class << self
+      # Lista as taxas e os índices acompanhados pela BrasilAPI.
+      #
+      # @return [Array<Hash>] nome e valor de cada taxa
+      # @raise [BrasilAPI::BadRequest] quando a BrasilAPI responde 400
+      # @raise [BrasilAPI::NotFound] quando a BrasilAPI responde 404
+      # @raise [BrasilAPI::ServerError] quando a BrasilAPI responde 5xx
+      # @raise [BrasilAPI::Timeout] quando a requisição estoura o tempo limite
+      # @raise [BrasilAPI::Error] em outras respostas de erro
+      # @example
+      #   BrasilAPI::Taxas.all
+      # @see https://brasilapi.com.br/docs#tag/TAXAS
       def all
         get("/taxas/v1")
       end
 
+      # Busca uma taxa pelo nome.
+      #
+      # @param name [String] nome da taxa, por exemplo +"selic"+ ou +"ipca"+
+      # @return [Hash] nome e valor da taxa
+      # @raise [BrasilAPI::BadRequest] quando a BrasilAPI responde 400
+      # @raise [BrasilAPI::NotFound] quando o nome não existe
+      # @raise [BrasilAPI::ServerError] quando a fonte da taxa está indisponível
+      # @raise [BrasilAPI::Timeout] quando a requisição estoura o tempo limite
+      # @raise [BrasilAPI::Error] em outras respostas de erro
+      # @example Taxa Selic
+      #   BrasilAPI::Taxas.find_by_name("selic")
+      # @see https://brasilapi.com.br/docs#tag/TAXAS
       def find_by_name(name)
         get("/taxas/v1/#{name}")
       end