Packages

SDK oficial Elixir da plataforma APIBrasil: WhatsApp, SMS, consultas de CPF/CNPJ, veiculos, CEP, correios, pagamentos PIX/boleto e mais.

Current section

Files

Jump to
apibrasil lib api_brasil data cep.ex
Raw

lib/api_brasil/data/cep.ex

defmodule ApiBrasil.Data.Cep do
@moduledoc """
CEP + geolocalização (device-based): `POST /cep/{action}`.
Além das funções nomeadas, `request/4` aceita qualquer action do catálogo e
`queue/4` executa a mesma action por fila.
{:ok, envelope} = ApiBrasil.Data.Cep.cep(client, %{"cep" => "01001000"})
ApiBrasil.Core.DeviceResponse.response(envelope)
"""
use ApiBrasil.Core.Service, device: "cep"
action(:cep, "cep", "Consulta um CEP: `POST /cep/cep` — body `%{\"cep\" => \"...\"}`.")
action(:bairros, "bairros", "Lista os bairros: `POST /cep/bairros`.")
action(:cidades, "cidades", "Lista as cidades: `POST /cep/cidades`.")
action(
:cidades_por_ddd,
"cidadesPorDDD",
"Lista as cidades de um DDD: `POST /cep/cidadesPorDDD`."
)
action(:estados, "estados", "Lista os estados: `POST /cep/estados`.")
action(
:calcular_distancia,
"distancia/calcular",
"Calcula a distância entre CEPs: `POST /cep/distancia/calcular`."
)
end