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)Summary
Functions
Lista os bairros: POST /cep/bairros.
Como bairros/3, mas devolve o resultado direto e levanta ApiBrasil.Core.Error em caso de falha.
Calcula a distância entre CEPs: POST /cep/distancia/calcular.
Como calcular_distancia/3, mas devolve o resultado direto e levanta ApiBrasil.Core.Error em caso de falha.
Consulta um CEP: POST /cep/cep — body %{"cep" => "..."}.
Como cep/3, mas devolve o resultado direto e levanta ApiBrasil.Core.Error em caso de falha.
Lista as cidades: POST /cep/cidades.
Como cidades/3, mas devolve o resultado direto e levanta ApiBrasil.Core.Error em caso de falha.
Lista as cidades de um DDD: POST /cep/cidadesPorDDD.
Como cidades_por_ddd/3, mas devolve o resultado direto e levanta ApiBrasil.Core.Error em caso de falha.
Lista os estados: POST /cep/estados.
Como estados/3, mas devolve o resultado direto e levanta ApiBrasil.Core.Error em caso de falha.
Executa a action de forma assíncrona, por fila: POST /cep/{action}/queue.
Como queue/4, mas levanta ApiBrasil.Core.Error em caso de falha.
Executa qualquer action do serviço: POST /cep/{action}.
Como request/4, mas levanta ApiBrasil.Core.Error em caso de falha.
Serviço do gateway coberto por este módulo: cep.
Types
@type result() :: {:ok, map()} | {:error, ApiBrasil.Core.Error.t()}
Functions
@spec bairros(ApiBrasil.Client.t(), term(), keyword()) :: {:ok, ApiBrasil.Core.DeviceResponse.t()} | {:error, ApiBrasil.Core.Error.t()}
Lista os bairros: POST /cep/bairros.
@spec bairros!(ApiBrasil.Client.t(), term(), keyword()) :: ApiBrasil.Core.DeviceResponse.t()
Como bairros/3, mas devolve o resultado direto e levanta ApiBrasil.Core.Error em caso de falha.
@spec calcular_distancia(ApiBrasil.Client.t(), term(), keyword()) :: {:ok, ApiBrasil.Core.DeviceResponse.t()} | {:error, ApiBrasil.Core.Error.t()}
Calcula a distância entre CEPs: POST /cep/distancia/calcular.
@spec calcular_distancia!(ApiBrasil.Client.t(), term(), keyword()) :: ApiBrasil.Core.DeviceResponse.t()
Como calcular_distancia/3, mas devolve o resultado direto e levanta ApiBrasil.Core.Error em caso de falha.
@spec cep(ApiBrasil.Client.t(), term(), keyword()) :: {:ok, ApiBrasil.Core.DeviceResponse.t()} | {:error, ApiBrasil.Core.Error.t()}
Consulta um CEP: POST /cep/cep — body %{"cep" => "..."}.
@spec cep!(ApiBrasil.Client.t(), term(), keyword()) :: ApiBrasil.Core.DeviceResponse.t()
Como cep/3, mas devolve o resultado direto e levanta ApiBrasil.Core.Error em caso de falha.
@spec cidades(ApiBrasil.Client.t(), term(), keyword()) :: {:ok, ApiBrasil.Core.DeviceResponse.t()} | {:error, ApiBrasil.Core.Error.t()}
Lista as cidades: POST /cep/cidades.
@spec cidades!(ApiBrasil.Client.t(), term(), keyword()) :: ApiBrasil.Core.DeviceResponse.t()
Como cidades/3, mas devolve o resultado direto e levanta ApiBrasil.Core.Error em caso de falha.
@spec cidades_por_ddd(ApiBrasil.Client.t(), term(), keyword()) :: {:ok, ApiBrasil.Core.DeviceResponse.t()} | {:error, ApiBrasil.Core.Error.t()}
Lista as cidades de um DDD: POST /cep/cidadesPorDDD.
@spec cidades_por_ddd!(ApiBrasil.Client.t(), term(), keyword()) :: ApiBrasil.Core.DeviceResponse.t()
Como cidades_por_ddd/3, mas devolve o resultado direto e levanta ApiBrasil.Core.Error em caso de falha.
@spec estados(ApiBrasil.Client.t(), term(), keyword()) :: {:ok, ApiBrasil.Core.DeviceResponse.t()} | {:error, ApiBrasil.Core.Error.t()}
Lista os estados: POST /cep/estados.
@spec estados!(ApiBrasil.Client.t(), term(), keyword()) :: ApiBrasil.Core.DeviceResponse.t()
Como estados/3, mas devolve o resultado direto e levanta ApiBrasil.Core.Error em caso de falha.
@spec queue(ApiBrasil.Client.t(), String.t(), term(), keyword()) :: {:ok, ApiBrasil.Core.DeviceResponse.t()} | {:error, ApiBrasil.Core.Error.t()}
Executa a action de forma assíncrona, por fila: POST /cep/{action}/queue.
@spec queue!(ApiBrasil.Client.t(), String.t(), term(), keyword()) :: ApiBrasil.Core.DeviceResponse.t()
Como queue/4, mas levanta ApiBrasil.Core.Error em caso de falha.
@spec request(ApiBrasil.Client.t(), String.t(), term(), keyword()) :: {:ok, ApiBrasil.Core.DeviceResponse.t()} | {:error, ApiBrasil.Core.Error.t()}
Executa qualquer action do serviço: POST /cep/{action}.
As actions conhecidas estão em
ApiBrasil.Generated.Catalog.service_actions("cep"); a
documentação completa fica em https://doc.apibrasil.io.
@spec request!(ApiBrasil.Client.t(), String.t(), term(), keyword()) :: ApiBrasil.Core.DeviceResponse.t()
Como request/4, mas levanta ApiBrasil.Core.Error em caso de falha.
@spec service() :: String.t()
Serviço do gateway coberto por este módulo: cep.