Evento recusado
3 funções do TermoWebhook para evento recusado.
// npm install termo_core --save-exact
import * as webhook from "termo_core/webhook";
// ou: import { webhook } from "termo_core";| Função | Rota | O que faz |
|---|---|---|
buscar_paginador_evento_recusado | GET /evento_recusado | Lista eventos recusados com paginação |
buscar_pelo_filtro_evento_recusado | GET /evento_recusado/filtro | Busca eventos recusados por filtro |
buscar_pelo_id_evento_recusado | GET /evento_recusado/{id} | Busca um evento recusado pelo id |
buscar_paginador_evento_recusado
GET/evento_recusado Exige credencial
Lista eventos recusados com paginação
Exige a área monitoramento. Os mais recentes vêm primeiro. pagina começa em 1 (padrão 1); tamanho tem padrão 10. Recusados com mais de 30 dias são apagados pela limpeza diária.
function buscar_paginador_evento_recusado(
credencial_de_acesso: CredencialDeAcesso,
parametros: ParametrosDeBuscarPaginadorEventoRecusado = {},
opcoes_da_chamada?: OpcoesDaChamada,
): Promise<tipos.PaginaEventoRecusado>import { CredencialDeAcesso } from "termo_core";
import { buscar_paginador_evento_recusado } from "termo_core/webhook";
const credencial_de_acesso = CredencialDeAcesso.token_do_usuario_logado(token_do_usuario);
const resposta = await buscar_paginador_evento_recusado(credencial_de_acesso, { pagina: 1 });Argumentos
Nome
Tipo
Retorno: Promise<tipos.PaginaEventoRecusado> · Rust: Result<tipos::PaginaEventoRecusado, ErroAoChamarServico> · veja PaginaEventoRecusado.
buscar_pelo_filtro_evento_recusado
GET/evento_recusado/filtro Exige credencial
Busca eventos recusados por filtro
Exige a área monitoramento. Sem paginação: devolve no máximo 200 recusados, os mais recentes primeiro. Todos os filtros são opcionais e se somam. motivo é token_invalido, aplicativo_inativo, envelope_invalido, tipo_desconhecido, tipo_inativo, versao_inexistente, versao_desligada, publicador_nao_e_dono ou dados_fora_do_contrato. nome_do_tipo_informado procura parte do nome, sem diferenciar maiúsculas. desde e ate (data e hora ISO 8601, inclusivos) limitam o momento da recusa.
function buscar_pelo_filtro_evento_recusado(
credencial_de_acesso: CredencialDeAcesso,
parametros: ParametrosDeBuscarPeloFiltroEventoRecusado = {},
opcoes_da_chamada?: OpcoesDaChamada,
): Promise<Array<tipos.EventoRecusado>>import { CredencialDeAcesso } from "termo_core";
import { buscar_pelo_filtro_evento_recusado } from "termo_core/webhook";
const credencial_de_acesso = CredencialDeAcesso.token_do_usuario_logado(token_do_usuario);
const resposta = await buscar_pelo_filtro_evento_recusado(credencial_de_acesso, { motivo: "..." });Argumentos
Nome
Tipo
Retorno: Promise<Array<tipos.EventoRecusado>> · Rust: Result<Vec<tipos::EventoRecusado>, ErroAoChamarServico>
buscar_pelo_id_evento_recusado
GET/evento_recusado/{id} Exige credencial
Busca um evento recusado pelo id
Exige a área monitoramento. Devolve o que o publicador informou (aplicativo, id do evento, tipo e versão, quando foi possível ler), o motivo da recusa, os erros_de_validacao do JSON Schema (só em dados_fora_do_contrato) e um trecho do corpo recebido. Recusados ficam guardados por 30 dias.
function buscar_pelo_id_evento_recusado(
credencial_de_acesso: CredencialDeAcesso,
id: number,
opcoes_da_chamada?: OpcoesDaChamada,
): Promise<tipos.EventoRecusado>import { CredencialDeAcesso } from "termo_core";
import { buscar_pelo_id_evento_recusado } from "termo_core/webhook";
const credencial_de_acesso = CredencialDeAcesso.token_do_usuario_logado(token_do_usuario);
const resposta = await buscar_pelo_id_evento_recusado(credencial_de_acesso, id);Argumentos
Nome
Tipo
Retorno: Promise<tipos.EventoRecusado> · Rust: Result<tipos::EventoRecusado, ErroAoChamarServico> · veja EventoRecusado.
Tipos
Tipos usados pelas funções desta página. O nome é o mesmo nos dois pacotes.
EventoRecusado
import type { EventoRecusado } from "termo_core/webhook";
export interface EventoRecusado {
aplicativo_publicador_id?: string | null;
aplicativo_publicador_nome?: string | null;
erros_de_validacao?: unknown;
event_id_informado?: string | null;
id: number;
motivo: string;
nome_do_tipo_informado?: string | null;
recusado_em: string;
trecho_do_payload?: string | null;
versao_informada?: number | null;
}PaginaEventoRecusado
import type { PaginaEventoRecusado } from "termo_core/webhook";
export interface PaginaEventoRecusado {
itens: Array<PaginaEventoRecusadoItensItem>;
pagina: number;
tamanho: number;
total: number;
}PaginaEventoRecusadoItensItem
import type { PaginaEventoRecusadoItensItem } from "termo_core/webhook";
export interface PaginaEventoRecusadoItensItem {
aplicativo_publicador_id?: string | null;
aplicativo_publicador_nome?: string | null;
erros_de_validacao?: unknown;
event_id_informado?: string | null;
id: number;
motivo: string;
nome_do_tipo_informado?: string | null;
recusado_em: string;
trecho_do_payload?: string | null;
versao_informada?: number | null;
}