Correios (device-based): POST /correios/{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.Correios.rastreio(client, %{"code" => "AA123456789BR"})
ApiBrasil.Core.DeviceResponse.response(envelope)Summary
Functions
Executa a action de forma assíncrona, por fila: POST /correios/{action}/queue.
Como queue/4, mas levanta ApiBrasil.Core.Error em caso de falha.
Rastreia uma encomenda: POST /correios/rastreio.
Como rastreio/3, mas devolve o resultado direto e levanta ApiBrasil.Core.Error em caso de falha.
Executa qualquer action do serviço: POST /correios/{action}.
Como request/4, mas levanta ApiBrasil.Core.Error em caso de falha.
Serviço do gateway coberto por este módulo: correios.
Types
@type result() :: {:ok, map()} | {:error, ApiBrasil.Core.Error.t()}
Functions
@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 /correios/{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 rastreio(ApiBrasil.Client.t(), term(), keyword()) :: {:ok, ApiBrasil.Core.DeviceResponse.t()} | {:error, ApiBrasil.Core.Error.t()}
Rastreia uma encomenda: POST /correios/rastreio.
@spec rastreio!(ApiBrasil.Client.t(), term(), keyword()) :: ApiBrasil.Core.DeviceResponse.t()
Como rastreio/3, mas devolve o resultado direto e 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 /correios/{action}.
As actions conhecidas estão em
ApiBrasil.Generated.Catalog.service_actions("correios"); 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: correios.