ApiBrasil.Generated.Catalog (APIBrasil v0.0.1)

Copy Markdown View Source

Catálogo de endpoints conhecidos da plataforma APIBrasil — ARQUIVO GERADO AUTOMATICAMENTE, não edite.

Fonte: https://gateway.apibrasil.io/api/v2/documentations Regenerar: mix apibrasil.codegen

242 documentações, 550 endpoints, 210 tipos de consulta conhecidos.

ApiBrasil.Generated.Catalog.has_action?("whatsapp", "sendText")
#=> true

ApiBrasil.Generated.Catalog.service_actions("correios")
#=> ["rastreio"]

ApiBrasil.Generated.Catalog.consulta_tipo("acerta-essencial")
#=> %{service: "cpf", fields: ["cpf"]}

Summary

Functions

Serviços de consulta por crédito (POST /consulta/{servico}/credits).

Metadados de um tipo de consulta — o serviço da rota (POST /consulta/{servico}/credits) e os campos do body de exemplo, fora tipo e homolog. Devolve nil quando o tipo não está no catálogo.

Metadados por tipo de consulta (campo tipo do body), ordenados por tipo.

Caminhos conhecidos da Evolution API (POST /evolution/{controller}/{action}).

Informa se uma action é documentada para o serviço.

Actions documentadas por serviço do gateway, ordenadas por serviço.

Actions documentadas de um serviço do gateway — lista vazia quando o serviço não está no catálogo.

Serviços do gateway presentes no catálogo, em ordem alfabética.

Fonte do catálogo.

Actions conhecidas da API de WhatsApp (POST /whatsapp/{action}).

Actions conhecidas do WhatsMeow (POST /whatsmeow/{action}).

Functions

consulta_servicos()

@spec consulta_servicos() :: [String.t()]

Serviços de consulta por crédito (POST /consulta/{servico}/credits).

consulta_tipo(tipo)

@spec consulta_tipo(String.t()) :: %{service: String.t(), fields: [String.t()]} | nil

Metadados de um tipo de consulta — o serviço da rota (POST /consulta/{servico}/credits) e os campos do body de exemplo, fora tipo e homolog. Devolve nil quando o tipo não está no catálogo.

ApiBrasil.Generated.Catalog.consulta_tipo("acerta-essencial")
#=> %{service: "cpf", fields: ["cpf"]}

consulta_tipos()

@spec consulta_tipos() :: %{
  required(String.t()) => %{service: String.t(), fields: [String.t()]}
}

Metadados por tipo de consulta (campo tipo do body), ordenados por tipo.

evolution_paths()

@spec evolution_paths() :: [String.t()]

Caminhos conhecidos da Evolution API (POST /evolution/{controller}/{action}).

has_action?(service, action)

@spec has_action?(String.t(), String.t()) :: boolean()

Informa se uma action é documentada para o serviço.

service_actions()

@spec service_actions() :: %{required(String.t()) => [String.t()]}

Actions documentadas por serviço do gateway, ordenadas por serviço.

service_actions(service)

@spec service_actions(String.t()) :: [String.t()]

Actions documentadas de um serviço do gateway — lista vazia quando o serviço não está no catálogo.

services()

@spec services() :: [String.t()]

Serviços do gateway presentes no catálogo, em ordem alfabética.

source()

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

Fonte do catálogo.

whatsapp_actions()

@spec whatsapp_actions() :: [String.t()]

Actions conhecidas da API de WhatsApp (POST /whatsapp/{action}).

whatsmeow_actions()

@spec whatsmeow_actions() :: [String.t()]

Actions conhecidas do WhatsMeow (POST /whatsmeow/{action}).