Module: ApiBrasil::Generated::Catalog

Defined in:

lib/api_brasil/generated/catalog.rb

Overview

ARQUIVO GERADO AUTOMATICAMENTE - nao edite manualmente.

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

242 documentacoes, 549 endpoints, 210 tipos de consulta conhecidos.

Constant Summary

WHATSAPP_ACTIONS =

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

[
  "addParticipant",
  "addSubgroupsCommunity",
  "approveGroupMembershipRequest",
  "archiveChat",
  "blockContact",
  "checkNumberStatus",
  "clearChat",
  "close",
  "closeChat",
  "createCommunity",
  "createGroup",
  "deactivateCommunity",
  "deleteChat",
  "deleteMessage",
  "deleteSession",
  "demoteCommunityParticipant",
  "demoteParticipant",
  "downloadMediaByMessage",
  "fila",
  "forwardMessages",
  "getAllBroadcastList",
  "getAllChats",
  "getAllChatsWithMessages",
  "getAllContacts",
  "getAllGroups",
  "getAllGroupsFull",
  "getAllLabels",
  "getAllNewMessages",
  "getAutoDownloadSettings",
  "getBatteryLevel",
  "getBlockList",
  "getChat",
  "getCommonGroups",
  "getCommunityParticipants",
  "getConnectionState",
  "getConnectionStatus",
  "getGroupAdmins",
  "getGroupInfoFromInviteLink",
  "getGroupInviteLink",
  "getGroupMembers",
  "getGroupMembersIds",
  "getGroupMembershipRequests",
  "getGroupSizeLimit",
  "getMessagesChat",
  "getMessagesFromRowId",
  "getNumberProfile",
  "getPhoneNumberByLid",
  "getPlatformFromMessage",
  "getProducts",
  "getProfilePic",
  "getReactions",
  "getStatus",
  "getUnreadMessages",
  "getWid",
  "isAuthenticated",
  "isConnected",
  "isLoggedIn",
  "isMultiDevice",
  "joinGroup",
  "joinWebBeta",
  "leaveGroup",
  "loadEarlierMessages",
  "logout",
  "markPlayed",
  "openChat",
  "promoteCommunityParticipant",
  "promoteParticipant",
  "qrcode",
  "removeGroupIcon",
  "removeParticipant",
  "removeSubgroupsCommunity",
  "reply",
  "restartSession",
  "sendAudio",
  "sendAudio64",
  "sendButtons",
  "sendContact",
  "sendContactVcardList",
  "sendFile",
  "sendFile/queue",
  "sendFile64",
  "sendGif",
  "sendImageToStorie",
  "sendLink",
  "sendList",
  "sendLocation",
  "sendMentioned",
  "sendMessageWithThumb",
  "sendOrderMessage",
  "sendOrderMessage/queue",
  "sendPixKey",
  "sendPollMessage",
  "sendReadStatus",
  "sendSticker",
  "sendText",
  "sendText/queue",
  "sendTextToStorie",
  "sendVideo",
  "sendVideo/queue",
  "sendVideoAsGif",
  "sendVideoToStorie",
  "setAutoDownloadSettings",
  "setGroupDescription",
  "setGroupPic",
  "setGroupProperty",
  "setGroupSubject",
  "setMessagesAdminsOnly",
  "setProfileName",
  "setProfilePic",
  "setTemporaryMessages",
  "setTheme",
  "start",
  "startPhoneWatchdog",
  "startRecording",
  "startTyping",
  "stopPhoneWatchdog",
  "stopRecording",
  "stopTyping",
  "unblockContact",
  "verifyNumber",
  "whatsapp-versions",
].freeze

EVOLUTION_PATHS =

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

[
  "call/offer",
  "chat/deleteMessageForEveryone",
  "chat/fetchPrivacySettings",
  "chat/fetchProfile",
  "chat/fetchProfilePictureUrl",
  "chat/findChats",
  "chat/findContacts",
  "chat/findMessages",
  "chat/getBase64FromMediaMessage",
  "chat/removeProfilePicture",
  "chat/updatePrivacySettings",
  "chat/updateProfileName",
  "chat/updateProfilePicture",
  "chat/updateProfileStatus",
  "chat/whatsappNumbers",
  "group/create",
  "group/fetchAllGroups?getParticipants=true",
  "group/findGroupInfos?groupJid=120363314888103300",
  "group/inviteCode?groupJid=120363314888103300",
  "group/inviteInfo?groupJid=120363314888103300",
  "group/participants?groupJid=120363314888103300",
  "group/revokeInviteCode?groupJid=120363314888103300",
  "group/sendInvite",
  "group/updateGroupDescription?groupJid=120363314888103300",
  "group/updateGroupPicture?groupJid=120363314888103300",
  "group/updateGroupSubject?groupJid=120363314888103300",
  "group/updateParticipant?groupJid=120363314888103300",
  "group/updateSetting?groupJid=120363314888103300",
  "instance/connect",
  "instance/connectionState",
  "instance/create",
  "instance/delete",
  "instance/logout",
  "instance/restart",
  "label/findLabels",
  "label/handleLabel",
  "message/sendButtons",
  "message/sendContact",
  "message/sendLocation",
  "message/sendMedia",
  "message/sendPoll",
  "message/sendReaction",
  "message/sendStatus",
  "message/sendSticker",
  "message/sendText",
  "message/sendText/queue",
  "message/sendWhatsAppAudio",
  "settings/find",
  "settings/set",
].freeze

WHATSMEOW_ACTIONS =

Actions conhecidas da WhatsMeow API (POST /whatsmeow/action).

[
  "chat/archive",
  "chat/mute",
  "chat/pin",
  "chat/unpin",
  "group/create",
  "group/info",
  "group/invitelink",
  "group/join",
  "group/list",
  "group/myall",
  "group/name",
  "group/participant",
  "group/photo",
  "instance/connect",
  "instance/create",
  "instance/delete/<devicekey>",
  "instance/disconnect",
  "instance/info/<devicekey>",
  "instance/logout",
  "instance/qr",
  "send/contact",
  "send/link",
  "send/location",
  "send/media",
  "send/poll",
  "send/sticker",
  "send/text",
  "user/avatar",
  "user/block",
  "user/blocklist",
  "user/check",
  "user/contacts",
  "user/info",
  "user/privacy",
  "user/profile",
  "user/unblock",
].freeze

CONSULTA_SERVICOS =

Servicos de consulta por credito (POST /consulta/service/credits).

[
  "api-rntrc",
  "cep",
  "cnpj",
  "cpf",
  "crbm",
  "crm",
  "cro",
  "ddd-anatel",
  "emissao-notas",
  "frete-antt",
  "geoip",
  "rastreio",
  "telefone",
  "vehicles",
  "veiculos",
  "weather-api",
].freeze

CONSULTA_TIPOS =

Metadados por tipo de consulta: servico da rota e campos do body de exemplo.

{
  "acerta-completo-positivo-pf" => { service: "cpf", fields: ["cpf"].freeze }.freeze,
  "acerta-essencial" => { service: "cpf", fields: ["cpf"].freeze }.freeze,
  "acerta-essencial-positivo" => { service: "cpf", fields: ["cpf"].freeze }.freeze,
  "acoes-processos-judiciais" => { service: "cpf", fields: ["//cnpj", "cpf"].freeze }.freeze,
  "agregados-basica" => { service: "veiculos", fields: ["placa"].freeze }.freeze,
  "agregados-chassi" => { service: "veiculos", fields: ["chassi"].freeze }.freeze,
  "agregados-indicio-sinistro" => { service: "veiculos", fields: ["placa"].freeze }.freeze,
  "agregados-propria" => { service: "veiculos", fields: ["placa"].freeze }.freeze,
  "agregados-renavam" => { service: "veiculos", fields: ["placa"].freeze }.freeze,
  "agregados-renavam-v2" => { service: "veiculos", fields: ["placa"].freeze }.freeze,
  "agregados-simples" => { service: "veiculos", fields: ["placa"].freeze }.freeze,
  "agregados-v2" => { service: "veiculos", fields: ["placa"].freeze }.freeze,
  "aml-vinculos-societarios" => { service: "cpf", fields: ["cpf"].freeze }.freeze,
  "analise-credito-basic-pf" => { service: "cpf", fields: ["cpf"].freeze }.freeze,
  "analise-credito-basic-pj" => { service: "cnpj", fields: ["cnpj"].freeze }.freeze,
  "analise-credito-business" => { service: "cnpj", fields: ["cnpj"].freeze }.freeze,
  "analise-credito-complete-pf" => { service: "cpf", fields: ["cpf"].freeze }.freeze,
  "analise-credito-essencial-pf" => { service: "cpf", fields: ["cpf"].freeze }.freeze,
  "analise-credito-plus-pf" => { service: "cpf", fields: ["cpf"].freeze }.freeze,
  "analitico-veicular" => { service: "veiculos", fields: ["extra", "placa", "whitelabel"].freeze }.freeze,
  "antecedentes-criminais" => { service: "cpf", fields: ["cpf", "rg", "uf"].freeze }.freeze,
  "antifraude-chave-pix" => { service: "cpf", fields: ["chave-pix", "documento", "tipo-chave"].freeze }.freeze,
  "bairros" => { service: "cep", fields: ["cidade"].freeze }.freeze,
  "banco-central-inabilitados" => { service: "cpf", fields: ["cpf"].freeze }.freeze,
  "base-estadual-v3" => { service: "veiculos", fields: ["placa"].freeze }.freeze,
  "base-estadual-v3-async" => { service: "vehicles", fields: ["placa", "webhook_url"].freeze }.freeze,
  "base-nacional-online" => { service: "veiculos", fields: ["placa"].freeze }.freeze,
  "base-nacional-v2" => { service: "veiculos", fields: ["placa"].freeze }.freeze,
  "beneficios-sociais-pf" => { service: "cpf", fields: ["cpf"].freeze }.freeze,
  "bet-safe-compliance" => { service: "cpf", fields: ["cpf"].freeze }.freeze,
  "boa-vista-acerta-pf" => { service: "cpf", fields: ["cpf"].freeze }.freeze,
  "boa-vista-define-score" => { service: "cnpj", fields: ["cnpj"].freeze }.freeze,
  "cadastral-premium-pj" => { service: "cnpj", fields: ["cnpj"].freeze }.freeze,
  "caf-pf" => { service: "cpf", fields: ["cpf"].freeze }.freeze,
  "calcula-frete" => { service: "frete-antt", fields: ["altoDesempenho", "composicaoVeicular", "dataReferencia", "distanciaKm", "eixos", "retornoVazio", "tipoCarga"].freeze }.freeze,
  "ccf-bacen" => { service: "cpf", fields: ["cpf"].freeze }.freeze,
  "cep" => { service: "cep", fields: ["cep"].freeze }.freeze,
  "certidao-conjunta-de-debitos-pessoa-fisica" => { service: "cpf", fields: ["cpf"].freeze }.freeze,
  "certidao-conjunta-de-debitos-pessoa-juridica" => { service: "cnpj", fields: ["cnpj"].freeze }.freeze,
  "certidao-negativa-de-debitos" => { service: "cpf", fields: ["cpf", "uf"].freeze }.freeze,
  "certidao-negativa-de-licitante-inidoneo" => { service: "cpf", fields: ["cpf"].freeze }.freeze,
  "certificado-upload" => { service: "emissao-notas", fields: ["dados"].freeze }.freeze,
  "check-list" => { service: "veiculos", fields: ["placa"].freeze }.freeze,
  "cidades" => { service: "cep", fields: ["uf"].freeze }.freeze,
  "cidadesPorDDD" => { service: "cep", fields: ["ddd"].freeze }.freeze,
  "city" => { service: "weather-api", fields: ["city"].freeze }.freeze,
  "cnh-criminals" => { service: "cpf", fields: ["cpf"].freeze }.freeze,
  "cnh-criminals-async" => { service: "cpf", fields: ["cpf", "webhook_url"].freeze }.freeze,
  "cnh-por-cpf" => { service: "cpf", fields: ["cpf"].freeze }.freeze,
  "cnpj-cadastral" => { service: "cnpj", fields: ["cnpj"].freeze }.freeze,
  "cnpj-search" => { service: "cnpj", fields: ["cnpj"].freeze }.freeze,
  "compliance-basic" => { service: "cpf", fields: ["cpf"].freeze }.freeze,
  "compliance-basic-pj" => { service: "cnpj", fields: ["cnpj"].freeze }.freeze,
  "compliance-complete" => { service: "cpf", fields: ["cpf"].freeze }.freeze,
  "compliance-complete-pj" => { service: "cnpj", fields: ["cnpj"].freeze }.freeze,
  "consulta-ano-modelo" => { service: "veiculos", fields: ["codigoMarca", "codigoModelo", "codigoTabelaReferencia", "codigoTipoVeiculo"].freeze }.freeze,
  "consulta-cgu" => { service: "cpf", fields: ["cpf", "tipo-agente"].freeze }.freeze,
  "consulta-chave" => { service: "vehicles", fields: ["job-id"].freeze }.freeze,
  "consulta-consolidada-de-pessoa-juridica" => { service: "cnpj", fields: ["cnpj"].freeze }.freeze,
  "consulta-marca" => { service: "veiculos", fields: ["codigoTabelaReferencia", "codigoTipoVeiculo"].freeze }.freeze,
  "consulta-modelo" => { service: "veiculos", fields: ["codigoMarca", "codigoTabelaReferencia", "codigoTipoVeiculo"].freeze }.freeze,
  "consulta-modelos-atraves-do-ano" => { service: "veiculos", fields: ["ano", "anoModelo", "codigoMarca", "codigoTabelaReferencia", "codigoTipoCombustivel", "codigoTipoVeiculo"].freeze }.freeze,
  "consulta-tabela-referencia" => { service: "veiculos", fields: [].freeze }.freeze,
  "consulta-valor-com-todos-parametros" => { service: "veiculos", fields: ["ano", "anoModelo", "codigoMarca", "codigoModelo", "codigoTabelaReferencia", "codigoTipoCombustivel", "codigoTipoVeiculo"].freeze }.freeze,
  "consultar-chave-base-estadual-v3" => { service: "vehicles", fields: ["job-id"].freeze }.freeze,
  "consultar-chave-cnh-criminals" => { service: "cpf", fields: ["job-id"].freeze }.freeze,
  "consultar-chave-csv-renainf-renajud-bin-proprietario" => { service: "vehicles", fields: ["job-id"].freeze }.freeze,
  "consultar-chave-leilao-v2" => { service: "vehicles", fields: ["job-id"].freeze }.freeze,
  "consultar-chave-veiculos-total" => { service: "vehicles", fields: ["job-id"].freeze }.freeze,
  "coordinates" => { service: "weather-api", fields: ["lat", "lon"].freeze }.freeze,
  "cpf-dados" => { service: "cpf", fields: ["cpf"].freeze }.freeze,
  "cpf-hotline" => { service: "cpf", fields: ["cpf"].freeze }.freeze,
  "cpf-impedidos" => { service: "cpf", fields: ["cpf"].freeze }.freeze,
  "cpf-lite" => { service: "cpf", fields: ["cpf"].freeze }.freeze,
  "cpf-obito-grupo-cadastral" => { service: "cpf", fields: ["cpf"].freeze }.freeze,
  "cpf-relatorio" => { service: "cpf", fields: ["cpf", "extra", "whitelabel"].freeze }.freeze,
  "cpf-search" => { service: "cpf", fields: ["cpf"].freeze }.freeze,
  "cpf-search-mae" => { service: "cpf", fields: ["cpf"].freeze }.freeze,
  "cpf-sociodemograficos" => { service: "cpf", fields: ["cpf"].freeze }.freeze,
  "crbm" => { service: "crbm", fields: ["numero_registro", "regiao"].freeze }.freeze,
  "creditos-simples-pf" => { service: "cpf", fields: ["cpf"].freeze }.freeze,
  "creditos-simples-pj" => { service: "cnpj", fields: ["cnpj"].freeze }.freeze,
  "crlve" => { service: "veiculos", fields: ["placa", "uf"].freeze }.freeze,
  "crm" => { service: "crm", fields: ["numero_registro", "uf"].freeze }.freeze,
  "cro" => { service: "cro", fields: ["categoria", "numero_registro", "uf"].freeze }.freeze,
  "csv-renainf-renajud-bin-proprietario" => { service: "veiculos", fields: ["placa"].freeze }.freeze,
  "csv-renainf-renajud-bin-proprietario-async" => { service: "veiculos", fields: ["placa", "webhook_url"].freeze }.freeze,
  "dados-cadastrais" => { service: "cpf", fields: ["cpf"].freeze }.freeze,
  "dados-processos" => { service: "cpf", fields: ["cpf", "whitelabel"].freeze }.freeze,
  "ddd-cidade" => { service: "ddd-anatel", fields: ["city"].freeze }.freeze,
  "debitos-restricoes" => { service: "veiculos", fields: ["placa"].freeze }.freeze,
  "debitos-v4" => { service: "veiculos", fields: ["placa"].freeze }.freeze,
  "debitos-v4-async" => { service: "vehicles", fields: ["placa", "webhook_url"].freeze }.freeze,
  "decodificador-agregados" => { service: "veiculos", fields: ["placa"].freeze }.freeze,
  "decodificador-precificador" => { service: "veiculos", fields: ["placa"].freeze }.freeze,
  "define-risco-pj" => { service: "cnpj", fields: ["cnpj"].freeze }.freeze,
  "detalhamento-negativo" => { service: "cnpj", fields: ["cnpj"].freeze }.freeze,
  "divida-ativa" => { service: "cpf", fields: ["cpf"].freeze }.freeze,
  "documento-crlv-ac" => { service: "veiculos", fields: ["cpf", "placa", "renavam"].freeze }.freeze,
  "documento-crlv-ap" => { service: "veiculos", fields: ["cpf", "placa", "renavam"].freeze }.freeze,
  "documento-crlv-ba" => { service: "veiculos", fields: ["cpf", "placa", "renavam"].freeze }.freeze,
  "documento-crlv-go" => { service: "veiculos", fields: ["cpf", "placa", "renavam"].freeze }.freeze,
  "documento-crlv-ma" => { service: "veiculos", fields: ["cpf", "placa", "renavam"].freeze }.freeze,
  "documento-crlv-mg" => { service: "veiculos", fields: ["cpf", "placa", "renavam"].freeze }.freeze,
  "documento-crlv-ms" => { service: "veiculos", fields: ["placa"].freeze }.freeze,
  "documento-crlv-mt" => { service: "veiculos", fields: ["cpf", "placa", "renavam"].freeze }.freeze,
  "documento-crlv-pi" => { service: "veiculos", fields: ["placa"].freeze }.freeze,
  "documento-crlv-ro" => { service: "veiculos", fields: ["placa"].freeze }.freeze,
  "documento-crlv-rr" => { service: "veiculos", fields: ["cpf", "placa", "renavam"].freeze }.freeze,
  "documento-crlv-to" => { service: "veiculos", fields: ["cpf", "placa", "renavam"].freeze }.freeze,
  "documento-frota" => { service: "cnpj", fields: ["cnpj"].freeze }.freeze,
  "emitentes-atualiza" => { service: "emissao-notas", fields: ["bairro", "cep", "cmun", "cnae", "cnpj", "crt", "documentos", "email", "emitente_id", "ie", "im", "logo", "municipio", "nome", "numero", "razao", "rua", "suframa", "telefone", "uf", "webhook_url"].freeze }.freeze,
  "emitentes-cadastro" => { service: "emissao-notas", fields: ["bairro", "cep", "cmun", "cnae", "cnpj", "crt", "documentos", "email", "ie", "im", "logo", "municipio", "nome", "numero", "razao", "rua", "suframa", "telefone", "uf", "webhook_url"].freeze }.freeze,
  "emitentes-lista" => { service: "emissao-notas", fields: ["emitente"].freeze }.freeze,
  "endereco-telefone-por-placa" => { service: "veiculos", fields: ["placa"].freeze }.freeze,
  "enriquecimento-de-lead" => { service: "cpf", fields: ["email"].freeze }.freeze,
  "estadual" => { service: "veiculos", fields: ["placa"].freeze }.freeze,
  "farol" => { service: "veiculos", fields: ["placa"].freeze }.freeze,
  "fgts-regularidade-do-empregador" => { service: "cnpj", fields: ["cnpj"].freeze }.freeze,
  "ficha-tecnica" => { service: "veiculos", fields: ["placa"].freeze }.freeze,
  "fipe" => { service: "veiculos", fields: ["placa"].freeze }.freeze,
  "fipe-chassi" => { service: "veiculos", fields: ["placa"].freeze }.freeze,
  "geoip" => { service: "geoip", fields: ["ip"].freeze }.freeze,
  "gravame" => { service: "veiculos", fields: ["placa"].freeze }.freeze,
  "gravame-v2" => { service: "veiculos", fields: ["placa"].freeze }.freeze,
  "historico-alteracoes-empresa" => { service: "cnpj", fields: ["cnpj"].freeze }.freeze,
  "historico-km" => { service: "veiculos", fields: ["placa"].freeze }.freeze,
  "historico-proprietario" => { service: "vehicles", fields: ["cnpj", "placa"].freeze }.freeze,
  "historico-veiculos-pf-pj" => { service: "cnpj", fields: ["cnpj"].freeze }.freeze,
  "leilao" => { service: "veiculos", fields: ["placa"].freeze }.freeze,
  "leilao-completo-score" => { service: "veiculos", fields: ["placa"].freeze }.freeze,
  "leilao-conjugado" => { service: "veiculos", fields: ["placa"].freeze }.freeze,
  "leilao-sintetico" => { service: "veiculos", fields: ["placa"].freeze }.freeze,
  "leilao-v2" => { service: "veiculos", fields: ["placa"].freeze }.freeze,
  "leilao-v2-async" => { service: "veiculos", fields: ["placa", "webhook_url"].freeze }.freeze,
  "limite-pj" => { service: "cnpj", fields: ["cnpj"].freeze }.freeze,
  "limite-positivo-pj" => { service: "cnpj", fields: ["cnpj"].freeze }.freeze,
  "localiza-cnpj" => { service: "cnpj", fields: ["cnpj"].freeze }.freeze,
  "modelos-carga" => { service: "frete-antt", fields: ["dataReferencia"].freeze }.freeze,
  "multas" => { service: "veiculos", fields: ["placa"].freeze }.freeze,
  "multas-prf" => { service: "veiculos", fields: ["placa", "renavam"].freeze }.freeze,
  "nacional" => { service: "veiculos", fields: ["placa"].freeze }.freeze,
  "nfse-consulta" => { service: "emissao-notas", fields: ["chave", "emitente_id"].freeze }.freeze,
  "nfse-envio" => { service: "emissao-notas", fields: ["dados", "emitente_id"].freeze }.freeze,
  "normativa-atual" => { service: "frete-antt", fields: ["dataReferencia"].freeze }.freeze,
  "obito" => { service: "cpf", fields: ["cpf"].freeze }.freeze,
  "opcoes-calculo" => { service: "frete-antt", fields: ["dataReferencia"].freeze }.freeze,
  "pep-lista-restritiva" => { service: "cpf", fields: ["cpf"].freeze }.freeze,
  "pessoa-exposta-politicamente" => { service: "cpf", fields: ["cpf"].freeze }.freeze,
  "pessoa-exposta-politicamente-parentesco" => { service: "cpf", fields: ["cpf"].freeze }.freeze,
  "pessoa-juridica-protesto" => { service: "cnpj", fields: ["cnpj"].freeze }.freeze,
  "proprietario-atual" => { service: "veiculos", fields: ["placa"].freeze }.freeze,
  "proprietario-atual-v2" => { service: "veiculos", fields: ["placa"].freeze }.freeze,
  "protesto-nacional-v2" => { service: "cpf", fields: ["cpf"].freeze }.freeze,
  "protestos-nacional-base" => { service: "cpf", fields: ["cpf"].freeze }.freeze,
  "protestos-sp" => { service: "cpf", fields: ["cpf"].freeze }.freeze,
  "quod-pj" => { service: "cnpj", fields: ["cnpj"].freeze }.freeze,
  "quod-restricao-pf" => { service: "cpf", fields: ["cpf"].freeze }.freeze,
  "rastreio" => { service: "rastreio", fields: ["code"].freeze }.freeze,
  "rating-avancado-pj" => { service: "cnpj", fields: ["cnpj"].freeze }.freeze,
  "recall" => { service: "veiculos", fields: ["placa"].freeze }.freeze,
  "recall-v2" => { service: "veiculos", fields: ["chassi"].freeze }.freeze,
  "receita-federal" => { service: "cpf", fields: ["cpf"].freeze }.freeze,
  "receita-federal-pf" => { service: "cpf", fields: ["cpf"].freeze }.freeze,
  "receita-federal-pf-v3" => { service: "cpf", fields: ["cpf"].freeze }.freeze,
  "receita-federal-pj" => { service: "cnpj", fields: ["cnpj"].freeze }.freeze,
  "receita-federal-pj-v3" => { service: "cnpj", fields: ["cnpj"].freeze }.freeze,
  "regularidade-transportadora" => { service: "cnpj", fields: ["cnpj", "rntrc"].freeze }.freeze,
  "relatorio-positivo" => { service: "cpf", fields: ["cpf"].freeze }.freeze,
  "relatorio-positivo-pj" => { service: "cnpj", fields: ["cnpj"].freeze }.freeze,
  "relatorio-veicular" => { service: "veiculos", fields: ["extra", "placa", "whitelabel"].freeze }.freeze,
  "relatorio-veicular-completo" => { service: "veiculos", fields: ["extra", "placa", "whitelabel"].freeze }.freeze,
  "renainf" => { service: "veiculos", fields: ["placa"].freeze }.freeze,
  "renajud" => { service: "veiculos", fields: ["documento", "placa", "renavam"].freeze }.freeze,
  "risco-positivo-pj" => { service: "cnpj", fields: ["cnpj"].freeze }.freeze,
  "roubo-furto" => { service: "veiculos", fields: ["placa"].freeze }.freeze,
  "roubo-furto-v2" => { service: "veiculos", fields: ["placa"].freeze }.freeze,
  "score-credito-quod" => { service: "cpf", fields: ["cpf"].freeze }.freeze,
  "scpc-net-pf" => { service: "cpf", fields: ["cpf"].freeze }.freeze,
  "scpc-net-pj" => { service: "cnpj", fields: ["cnpj"].freeze }.freeze,
  "scr-analitico-resumo-bacen" => { service: "cnpj", fields: ["cnpj"].freeze }.freeze,
  "scr-bacen" => { service: "cpf", fields: ["cpf"].freeze }.freeze,
  "scr-bacen-score" => { service: "cpf", fields: ["cpf"].freeze }.freeze,
  "search" => { service: "api-rntrc", fields: ["filters", "pagination", "sort"].freeze }.freeze,
  "secretaria-da-fazenda-sao-paulo" => { service: "cpf", fields: ["cpf"].freeze }.freeze,
  "serasa-real-time" => { service: "cnpj", fields: ["cnpj"].freeze }.freeze,
  "serasa-score-pf" => { service: "cpf", fields: ["cpf"].freeze }.freeze,
  "serasa-score-pj" => { service: "cnpj", fields: ["cnpj"].freeze }.freeze,
  "simples-nacional" => { service: "cnpj", fields: ["cnpj"].freeze }.freeze,
  "sincroniza-normativas" => { service: "frete-antt", fields: [].freeze }.freeze,
  "sintegra-cadastros-estaduais" => { service: "cnpj", fields: ["cnpj"].freeze }.freeze,
  "sintegra-ccc" => { service: "cnpj", fields: ["cnpj", "uf"].freeze }.freeze,
  "situacao-eleitoral" => { service: "cpf", fields: ["cpf"].freeze }.freeze,
  "spc-boa-vista" => { service: "cpf", fields: ["cpf"].freeze }.freeze,
  "spc-serasa" => { service: "cpf", fields: ["cpf"].freeze }.freeze,
  "spc-terceiros-pf" => { service: "cpf", fields: ["cpf"].freeze }.freeze,
  "spc-terceiros-pj" => { service: "cnpj", fields: ["cnpj"].freeze }.freeze,
  "telefone-operadora" => { service: "telefone", fields: ["numbers", "options"].freeze }.freeze,
  "transacional-pf" => { service: "cpf", fields: ["cpf"].freeze }.freeze,
  "transacional-pj" => { service: "cnpj", fields: ["cnpj"].freeze }.freeze,
  "var" => { service: "cpf", fields: ["cpf"].freeze }.freeze,
  "veicular-agrupados" => { service: "veiculos", fields: ["agrupados", "placa"].freeze }.freeze,
  "veiculos-dados-v1" => { service: "veiculos", fields: ["placa"].freeze }.freeze,
  "veiculos-documento-pf" => { service: "cpf", fields: ["cpf"].freeze }.freeze,
  "veiculos-documento-pj" => { service: "veiculos", fields: ["cnpj"].freeze }.freeze,
  "veiculos-total" => { service: "veiculos", fields: ["placa"].freeze }.freeze,
  "veiculos-total-async" => { service: "veiculos", fields: ["placa", "webhook_url"].freeze }.freeze,
  "versoes-normativas" => { service: "frete-antt", fields: [].freeze }.freeze,
  "vinculo-empregaticio" => { service: "cnpj", fields: ["cnpj"].freeze }.freeze,
  "vip-car" => { service: "veiculos", fields: ["placa"].freeze }.freeze,
}.freeze

SERVICE_ACTIONS =

Actions documentadas por servico do gateway.

{
  "api" => ["loterias/:sorteio"].freeze,
  "apis" => ["list"].freeze,
  "auth" => ["login", "logout"].freeze,
  "balance" => [].freeze,
  "cep" => ["bairros", "cep", "cidades", "cidadesPorDDD", "distancia/calcular", "estados"].freeze,
  "chip" => ["virtual/activation", "virtual/buy", "virtual/operators", "virtual/services"].freeze,
  "consulta" => ["api-rntrc/credits", "cep/credits", "cnpj/credits", "cpf/credits", "crbm/credits", "crm/credits", "cro/credits", "ddd-anatel/credits", "emissao-notas/credits", "frete-antt/credits", "geoip/credits", "rastreio/credits", "telefone/credits", "vehicles/credits", "veiculos/credits", "weather-api/credits"].freeze,
  "correios" => ["rastreio"].freeze,
  "dados" => ["byquery", "capital-social", "cep", "cnae", "cnpj", "cnpj/credits", "cpf", "lista-cnaes", "lista-socios", "uf"].freeze,
  "database" => ["ip"].freeze,
  "ddd" => [].freeze,
  "devices" => ["destroy", "requests", "search", "store"].freeze,
  "evolution" => ["call/offer", "chat/deleteMessageForEveryone", "chat/fetchPrivacySettings", "chat/fetchProfile", "chat/fetchProfilePictureUrl", "chat/findChats", "chat/findContacts", "chat/findMessages", "chat/getBase64FromMediaMessage", "chat/removeProfilePicture", "chat/updatePrivacySettings", "chat/updateProfileName", "chat/updateProfilePicture", "chat/updateProfileStatus", "chat/whatsappNumbers", "group/create", "group/fetchAllGroups?getParticipants=true", "group/findGroupInfos?groupJid=120363314888103300", "group/inviteCode?groupJid=120363314888103300", "group/inviteInfo?groupJid=120363314888103300", "group/participants?groupJid=120363314888103300", "group/revokeInviteCode?groupJid=120363314888103300", "group/sendInvite", "group/updateGroupDescription?groupJid=120363314888103300", "group/updateGroupPicture?groupJid=120363314888103300", "group/updateGroupSubject?groupJid=120363314888103300", "group/updateParticipant?groupJid=120363314888103300", "group/updateSetting?groupJid=120363314888103300", "instance/connect", "instance/connectionState", "instance/create", "instance/delete", "instance/logout", "instance/restart", "label/findLabels", "label/handleLabel", "message/sendButtons", "message/sendContact", "message/sendLocation", "message/sendMedia", "message/sendPoll", "message/sendReaction", "message/sendStatus", "message/sendSticker", "message/sendText", "message/sendText/queue", "message/sendWhatsAppAudio", "settings/find", "settings/set"].freeze,
  "fipe" => ["ConsultarAnoModelo", "ConsultarMarcas", "ConsultarModelos", "ConsultarModelosAtravesDoAno", "ConsultarTabelaDeReferencia", "ConsultarValorComTodosParametros"].freeze,
  "geolocation" => ["forward-geocoding", "geocode"].freeze,
  "geomatrix" => ["distance"].freeze,
  "holidays" => ["feriados"].freeze,
  "invoices" => [].freeze,
  "loterias" => [":sorteio/:concurso", ":sorteio/latest"].freeze,
  "plan" => [].freeze,
  "profile" => [].freeze,
  "proxy" => ["seller/credits"].freeze,
  "quod" => ["cnpj/credits"].freeze,
  "recharge" => [].freeze,
  "recharges" => [].freeze,
  "recognize" => ["base64", "uri"].freeze,
  "requests" => ["paginate"].freeze,
  "servers" => [].freeze,
  "sms" => ["send/credits"].freeze,
  "social" => ["github/callback?code=SEU_CODE&state=SEU_STATE", "github/url"].freeze,
  "ticket" => ["TCK-HKGMWHCW2S", "TCK-HKGMWHCW2S/messages"].freeze,
  "tickets" => [].freeze,
  "translate" => ["identify", "models"].freeze,
  "ura" => ["call/dialler", "call/status?callId="].freeze,
  "vehicles" => ["base/000/dados", "dados", "fipe"].freeze,
  "weather" => ["city", "coordenates"].freeze,
  "whatsapp" => ["addParticipant", "addSubgroupsCommunity", "approveGroupMembershipRequest", "archiveChat", "blockContact", "checkNumberStatus", "clearChat", "close", "closeChat", "createCommunity", "createGroup", "deactivateCommunity", "deleteChat", "deleteMessage", "deleteSession", "demoteCommunityParticipant", "demoteParticipant", "downloadMediaByMessage", "fila", "forwardMessages", "getAllBroadcastList", "getAllChats", "getAllChatsWithMessages", "getAllContacts", "getAllGroups", "getAllGroupsFull", "getAllLabels", "getAllNewMessages", "getAutoDownloadSettings", "getBatteryLevel", "getBlockList", "getChat", "getCommonGroups", "getCommunityParticipants", "getConnectionState", "getConnectionStatus", "getGroupAdmins", "getGroupInfoFromInviteLink", "getGroupInviteLink", "getGroupMembers", "getGroupMembersIds", "getGroupMembershipRequests", "getGroupSizeLimit", "getMessagesChat", "getMessagesFromRowId", "getNumberProfile", "getPhoneNumberByLid", "getPlatformFromMessage", "getProducts", "getProfilePic", "getReactions", "getStatus", "getUnreadMessages", "getWid", "isAuthenticated", "isConnected", "isLoggedIn", "isMultiDevice", "joinGroup", "joinWebBeta", "leaveGroup", "loadEarlierMessages", "logout", "markPlayed", "openChat", "promoteCommunityParticipant", "promoteParticipant", "qrcode", "removeGroupIcon", "removeParticipant", "removeSubgroupsCommunity", "reply", "restartSession", "sendAudio", "sendAudio64", "sendButtons", "sendContact", "sendContactVcardList", "sendFile", "sendFile/queue", "sendFile64", "sendGif", "sendImageToStorie", "sendLink", "sendList", "sendLocation", "sendMentioned", "sendMessageWithThumb", "sendOrderMessage", "sendOrderMessage/queue", "sendPixKey", "sendPollMessage", "sendReadStatus", "sendSticker", "sendText", "sendText/queue", "sendTextToStorie", "sendVideo", "sendVideo/queue", "sendVideoAsGif", "sendVideoToStorie", "setAutoDownloadSettings", "setGroupDescription", "setGroupPic", "setGroupProperty", "setGroupSubject", "setMessagesAdminsOnly", "setProfileName", "setProfilePic", "setTemporaryMessages", "setTheme", "start", "startPhoneWatchdog", "startRecording", "startTyping", "stopPhoneWatchdog", "stopRecording", "stopTyping", "unblockContact", "verifyNumber", "whatsapp-versions"].freeze,
  "whatsmeow" => ["chat/archive", "chat/mute", "chat/pin", "chat/unpin", "group/create", "group/info", "group/invitelink", "group/join", "group/list", "group/myall", "group/name", "group/participant", "group/photo", "instance/connect", "instance/create", "instance/delete/<devicekey>", "instance/disconnect", "instance/info/<devicekey>", "instance/logout", "instance/qr", "send/contact", "send/link", "send/location", "send/media", "send/poll", "send/sticker", "send/text", "user/avatar", "user/block", "user/blocklist", "user/check", "user/contacts", "user/info", "user/privacy", "user/profile", "user/unblock"].freeze,
}.freeze

Class Method Summary

• .consulta_tipo(tipo) ⇒ Hash^?

  Metadados de um tipo de consulta (nil quando desconhecido).

• .service_actions(service) ⇒ Array<String>

  Actions documentadas de um servico.

Class Method Details

.consulta_tipo(tipo) ⇒ Hash^?

Metadados de um tipo de consulta (nil quando desconhecido).

Parameters:

• tipo (String)

Returns:

• (Hash, nil)

# File 'lib/api_brasil/generated/catalog.rb', line 513

def consulta_tipo(tipo)
  CONSULTA_TIPOS[tipo.to_s]
end

.service_actions(service) ⇒ Array<String>

Actions documentadas de um servico.

Parameters:

• service (String)

Returns:

• (Array<String>)

# File 'lib/api_brasil/generated/catalog.rb', line 521

def service_actions(service)
  SERVICE_ACTIONS.fetch(service.to_s, [].freeze)
end