Tabela FIPE (device-based): POST /fipe/{action}.
Além das funções nomeadas, request/4 aceita qualquer action do catálogo e
queue/4 executa a mesma action por fila.
body = %{"codigoTabelaReferencia" => 300, "codigoTipoVeiculo" => 1}
{:ok, envelope} = ApiBrasil.Data.Fipe.consultar_marcas(client, body)
ApiBrasil.Core.DeviceResponse.response(envelope)Summary
Functions
Lista os anos de um modelo: POST /fipe/ConsultarAnoModelo.
Como consultar_ano_modelo/3, mas devolve o resultado direto e levanta ApiBrasil.Core.Error em caso de falha.
Lista as marcas: POST /fipe/ConsultarMarcas.
Como consultar_marcas/3, mas devolve o resultado direto e levanta ApiBrasil.Core.Error em caso de falha.
Lista os modelos de uma marca: POST /fipe/ConsultarModelos.
Como consultar_modelos/3, mas devolve o resultado direto e levanta ApiBrasil.Core.Error em caso de falha.
Lista os modelos de um ano: POST /fipe/ConsultarModelosAtravesDoAno.
Como consultar_modelos_atraves_do_ano/3, mas devolve o resultado direto e levanta ApiBrasil.Core.Error em caso de falha.
Lista as tabelas de referência: POST /fipe/ConsultarTabelaDeReferencia.
Como consultar_tabela_de_referencia/3, mas devolve o resultado direto e levanta ApiBrasil.Core.Error em caso de falha.
Consulta o preço FIPE: POST /fipe/ConsultarValorComTodosParametros.
Como consultar_valor_com_todos_parametros/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 /fipe/{action}/queue.
Como queue/4, mas levanta ApiBrasil.Core.Error em caso de falha.
Executa qualquer action do serviço: POST /fipe/{action}.
Como request/4, mas levanta ApiBrasil.Core.Error em caso de falha.
Serviço do gateway coberto por este módulo: fipe.
Types
@type result() :: {:ok, map()} | {:error, ApiBrasil.Core.Error.t()}
Functions
@spec consultar_ano_modelo(ApiBrasil.Client.t(), term(), keyword()) :: {:ok, ApiBrasil.Core.DeviceResponse.t()} | {:error, ApiBrasil.Core.Error.t()}
Lista os anos de um modelo: POST /fipe/ConsultarAnoModelo.
@spec consultar_ano_modelo!(ApiBrasil.Client.t(), term(), keyword()) :: ApiBrasil.Core.DeviceResponse.t()
Como consultar_ano_modelo/3, mas devolve o resultado direto e levanta ApiBrasil.Core.Error em caso de falha.
@spec consultar_marcas(ApiBrasil.Client.t(), term(), keyword()) :: {:ok, ApiBrasil.Core.DeviceResponse.t()} | {:error, ApiBrasil.Core.Error.t()}
Lista as marcas: POST /fipe/ConsultarMarcas.
@spec consultar_marcas!(ApiBrasil.Client.t(), term(), keyword()) :: ApiBrasil.Core.DeviceResponse.t()
Como consultar_marcas/3, mas devolve o resultado direto e levanta ApiBrasil.Core.Error em caso de falha.
@spec consultar_modelos(ApiBrasil.Client.t(), term(), keyword()) :: {:ok, ApiBrasil.Core.DeviceResponse.t()} | {:error, ApiBrasil.Core.Error.t()}
Lista os modelos de uma marca: POST /fipe/ConsultarModelos.
@spec consultar_modelos!(ApiBrasil.Client.t(), term(), keyword()) :: ApiBrasil.Core.DeviceResponse.t()
Como consultar_modelos/3, mas devolve o resultado direto e levanta ApiBrasil.Core.Error em caso de falha.
@spec consultar_modelos_atraves_do_ano(ApiBrasil.Client.t(), term(), keyword()) :: {:ok, ApiBrasil.Core.DeviceResponse.t()} | {:error, ApiBrasil.Core.Error.t()}
Lista os modelos de um ano: POST /fipe/ConsultarModelosAtravesDoAno.
@spec consultar_modelos_atraves_do_ano!(ApiBrasil.Client.t(), term(), keyword()) :: ApiBrasil.Core.DeviceResponse.t()
Como consultar_modelos_atraves_do_ano/3, mas devolve o resultado direto e levanta ApiBrasil.Core.Error em caso de falha.
@spec consultar_tabela_de_referencia(ApiBrasil.Client.t(), term(), keyword()) :: {:ok, ApiBrasil.Core.DeviceResponse.t()} | {:error, ApiBrasil.Core.Error.t()}
Lista as tabelas de referência: POST /fipe/ConsultarTabelaDeReferencia.
@spec consultar_tabela_de_referencia!(ApiBrasil.Client.t(), term(), keyword()) :: ApiBrasil.Core.DeviceResponse.t()
Como consultar_tabela_de_referencia/3, mas devolve o resultado direto e levanta ApiBrasil.Core.Error em caso de falha.
@spec consultar_valor_com_todos_parametros(ApiBrasil.Client.t(), term(), keyword()) :: {:ok, ApiBrasil.Core.DeviceResponse.t()} | {:error, ApiBrasil.Core.Error.t()}
Consulta o preço FIPE: POST /fipe/ConsultarValorComTodosParametros.
@spec consultar_valor_com_todos_parametros!(ApiBrasil.Client.t(), term(), keyword()) :: ApiBrasil.Core.DeviceResponse.t()
Como consultar_valor_com_todos_parametros/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 /fipe/{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 /fipe/{action}.
As actions conhecidas estão em
ApiBrasil.Generated.Catalog.service_actions("fipe"); 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: fipe.