@spec api(ApiBrasil.Client.t(), String.t(), keyword()) :: result()

Detalha uma API por identificador: GET /apis/{identifier}.

@spec api!(ApiBrasil.Client.t(), String.t(), keyword()) :: map()

Como api/3, mas levanta ApiBrasil.Core.Error em caso de falha.

@spec api_by_name(ApiBrasil.Client.t(), String.t(), keyword()) :: result()

Detalha uma API pelo nome: GET /apis/name/{name}.

@spec api_by_name!(ApiBrasil.Client.t(), String.t(), keyword()) :: map()

Como api_by_name/3, mas levanta ApiBrasil.Core.Error em caso de falha.

@spec api_categories(
  ApiBrasil.Client.t(),
  keyword()
) :: result()

Lista as categorias de APIs: GET /apis/categories.

@spec api_categories!(
  ApiBrasil.Client.t(),
  keyword()
) :: map()

Como api_categories/2, mas devolve o resultado direto e levanta ApiBrasil.Core.Error em caso de falha.

@spec apis(ApiBrasil.Client.t(), String.t() | nil, keyword()) :: result()

Lista/busca as APIs disponíveis: GET /apis?search=.

search é opcional: nil (ou string vazia) lista o catálogo inteiro.

@spec apis!(ApiBrasil.Client.t(), String.t() | nil, keyword()) :: map()

Como apis/3, mas levanta ApiBrasil.Core.Error em caso de falha.

@spec apis_by_device(ApiBrasil.Client.t(), String.t(), keyword()) :: result()

Lista as APIs vinculadas a um device: GET /apis/device/{device_token}.

@spec apis_by_device!(ApiBrasil.Client.t(), String.t(), keyword()) :: map()

Como apis_by_device/3, mas levanta ApiBrasil.Core.Error em caso de falha.

@spec documentations(
  ApiBrasil.Client.t(),
  keyword()
) :: result()

Lista as documentações: GET /documentations.

@spec documentations!(
  ApiBrasil.Client.t(),
  keyword()
) :: map()

Como documentations/2, mas devolve o resultado direto e levanta ApiBrasil.Core.Error em caso de falha.

@spec documentations_by_server(ApiBrasil.Client.t(), String.t(), keyword()) ::
  result()

Documentação por servidor: GET /documentations/server/{server_search}.

@spec documentations_by_server!(ApiBrasil.Client.t(), String.t(), keyword()) :: map()

Como documentations_by_server/3, mas levanta ApiBrasil.Core.Error em caso de falha.

@spec endpoint_body(ApiBrasil.Client.t(), term(), keyword()) :: result()

Body esperado por uma action: POST /endpoint/body.

@spec endpoint_body!(ApiBrasil.Client.t(), term(), keyword()) :: map()

Como endpoint_body/3, mas devolve o resultado direto e levanta ApiBrasil.Core.Error em caso de falha.

@spec endpoint_url(ApiBrasil.Client.t(), term(), keyword()) :: result()

Resolve a URL de uma action (descoberta dinâmica de endpoints): POST /endpoint/url.

@spec endpoint_url!(ApiBrasil.Client.t(), term(), keyword()) :: map()

Como endpoint_url/3, mas devolve o resultado direto e levanta ApiBrasil.Core.Error em caso de falha.

@spec my_apis(
  ApiBrasil.Client.t(),
  keyword()
) :: result()

Lista as APIs contratadas pelo usuário (autenticado): GET /apis/list.

@spec my_apis!(
  ApiBrasil.Client.t(),
  keyword()
) :: map()

Como my_apis/2, mas devolve o resultado direto e levanta ApiBrasil.Core.Error em caso de falha.

@spec plans(
  ApiBrasil.Client.t(),
  keyword()
) :: result()

Lista os planos disponíveis: GET /plans.

@spec plans!(
  ApiBrasil.Client.t(),
  keyword()
) :: map()

Como plans/2, mas devolve o resultado direto e levanta ApiBrasil.Core.Error em caso de falha.

@spec servers(
  ApiBrasil.Client.t(),
  keyword()
) :: result()

Lista os servidores disponíveis: GET /servers.

@spec servers!(
  ApiBrasil.Client.t(),
  keyword()
) :: map()

Como servers/2, mas devolve o resultado direto e levanta ApiBrasil.Core.Error em caso de falha.

@spec status(
  ApiBrasil.Client.t(),
  keyword()
) :: result()

Status do gateway: GET /status.

@spec status!(
  ApiBrasil.Client.t(),
  keyword()
) :: map()

Como status/2, mas devolve o resultado direto e levanta ApiBrasil.Core.Error em caso de falha.