ApiBrasil.Data.Ddd (APIBrasil v0.0.1)

Copy Markdown View Source

Consulta de DDD (device-based): POST /ddd/{action}.

O serviço não expõe funções nomeadas: use request/4 com a action desejada do catálogo (ApiBrasil.Generated.Catalog.service_actions("ddd")) — queue/4 executa a mesma action por fila.

Summary

Functions

Executa a action de forma assíncrona, por fila: POST /ddd/{action}/queue.

Executa qualquer action do serviço: POST /ddd/{action}.

Serviço do gateway coberto por este módulo: ddd.

Types

result()

@type result() :: {:ok, map()} | {:error, ApiBrasil.Core.Error.t()}

Functions

queue(client, action_name, body \\ nil, opts \\ [])

Executa a action de forma assíncrona, por fila: POST /ddd/{action}/queue.

queue!(client, action_name, body \\ nil, opts \\ [])

Como queue/4, mas levanta ApiBrasil.Core.Error em caso de falha.

request(client, action_name, body \\ nil, opts \\ [])

Executa qualquer action do serviço: POST /ddd/{action}.

As actions conhecidas estão em ApiBrasil.Generated.Catalog.service_actions("ddd"); a documentação completa fica em https://doc.apibrasil.io.

request!(client, action_name, body \\ nil, opts \\ [])

Como request/4, mas levanta ApiBrasil.Core.Error em caso de falha.

service()

@spec service() :: String.t()

Serviço do gateway coberto por este módulo: ddd.