Visão geralServiçosEventosRecursos
TermoWebhook

Solicitação de reprocessamento

4 funções do TermoWebhook para solicitação de reprocessamento.

// npm install termo_core --save-exact
import * as webhook from "termo_core/webhook";
// ou: import { webhook } from "termo_core";
FunçãoRotaO que faz
buscar_paginador_solicitacao_de_reprocessamentoGET /solicitacao_de_reprocessamentoLista solicitações de reprocessamento com paginação
criar_solicitacao_de_reprocessamentoPOST /solicitacao_de_reprocessamentoSolicita o reprocessamento de entregas
buscar_pelo_filtro_solicitacao_de_reprocessamentoGET /solicitacao_de_reprocessamento/filtroBusca solicitações de reprocessamento por filtro
buscar_pelo_id_solicitacao_de_reprocessamentoGET /solicitacao_de_reprocessamento/{id}Busca uma solicitação de reprocessamento pelo id

buscar_paginador_solicitacao_de_reprocessamento

GET/solicitacao_de_reprocessamento Exige credencial

Lista solicitações de reprocessamento com paginação

Exige a área monitoramento. As mais recentes vêm primeiro. pagina começa em 1 (padrão 1); tamanho tem padrão 10.

function buscar_paginador_solicitacao_de_reprocessamento(
  credencial_de_acesso: CredencialDeAcesso,
  parametros: ParametrosDeBuscarPaginadorSolicitacaoDeReprocessamento = {},
  opcoes_da_chamada?: OpcoesDaChamada,
): Promise<tipos.PaginaSolicitacaoDeReprocessamento>
Exemplo
import { CredencialDeAcesso } from "termo_core";
import { buscar_paginador_solicitacao_de_reprocessamento } from "termo_core/webhook";

const credencial_de_acesso = CredencialDeAcesso.token_do_usuario_logado(token_do_usuario);
const resposta = await buscar_paginador_solicitacao_de_reprocessamento(credencial_de_acesso, { pagina: 1 });

Argumentos

Nome

Tipo

Retorno: Promise<tipos.PaginaSolicitacaoDeReprocessamento> · Rust: Result<tipos::PaginaSolicitacaoDeReprocessamento, ErroAoChamarServico> · veja PaginaSolicitacaoDeReprocessamento.

criar_solicitacao_de_reprocessamento

POST/solicitacao_de_reprocessamento Exige credencial

Solicita o reprocessamento de entregas

Exige a área monitoramento com permissão de criar. motivo é obrigatório (até 500 caracteres) e fica no histórico junto com quem pediu. O alcance define o que é reenviado:

  • entrega: exige entrega_id. Reenvia aquela entrega agora, mesmo que já tenha sido entregue, cancelada ou esteja aguardando nova tentativa (se ela está pendente, nada muda). Para reenviar várias, faça uma solicitação por entrega.
  • fila_de_erro: exige assinatura_id. Reabre todas as entregas da assinatura que esgotaram as tentativas.
  • periodo: exige assinatura_id e eventos_desde; eventos_ate é opcional (sem ele, vai até agora) e não pode ser antes do início. Cria as entregas que faltam para os eventos recebidos no período e reabre as esgotadas e as canceladas; com incluir_entregues = true, reenvia também as já entregues.

Campos que não pertencem ao alcance escolhido são ignorados. A assinatura precisa estar ativa. Cada entrega reaberta recomeça o ciclo de tentativas. A resposta traz quantas entregas foram reabertas e quantas foram criadas.

function criar_solicitacao_de_reprocessamento(
  credencial_de_acesso: CredencialDeAcesso,
  corpo_da_requisicao: tipos.SolicitacaoDeReprocessamentoCriar,
  opcoes_da_chamada?: OpcoesDaChamada,
): Promise<tipos.SolicitacaoDeReprocessamento>
Exemplo
import { CredencialDeAcesso } from "termo_core";
import { criar_solicitacao_de_reprocessamento } from "termo_core/webhook";

const credencial_de_acesso = CredencialDeAcesso.token_do_usuario_logado(token_do_usuario);
const resposta = await criar_solicitacao_de_reprocessamento(credencial_de_acesso, corpo_da_requisicao);

Argumentos

Nome

Tipo

Retorno: Promise<tipos.SolicitacaoDeReprocessamento> · Rust: Result<tipos::SolicitacaoDeReprocessamento, ErroAoChamarServico> · veja SolicitacaoDeReprocessamento.

buscar_pelo_filtro_solicitacao_de_reprocessamento

GET/solicitacao_de_reprocessamento/filtro Exige credencial

Busca solicitações de reprocessamento por filtro

Exige a área monitoramento. Sem paginação: devolve no máximo 200 solicitações, as mais recentes primeiro. Filtros opcionais e somados: assinatura_id e alcance (entrega, fila_de_erro ou periodo; outro valor não encontra nada).

function buscar_pelo_filtro_solicitacao_de_reprocessamento(
  credencial_de_acesso: CredencialDeAcesso,
  parametros: ParametrosDeBuscarPeloFiltroSolicitacaoDeReprocessamento = {},
  opcoes_da_chamada?: OpcoesDaChamada,
): Promise<Array<tipos.SolicitacaoDeReprocessamento>>
Exemplo
import { CredencialDeAcesso } from "termo_core";
import { buscar_pelo_filtro_solicitacao_de_reprocessamento } from "termo_core/webhook";

const credencial_de_acesso = CredencialDeAcesso.token_do_usuario_logado(token_do_usuario);
const resposta = await buscar_pelo_filtro_solicitacao_de_reprocessamento(credencial_de_acesso, { assinatura_id: "..." });

Argumentos

Nome

Tipo

Retorno: Promise<Array<tipos.SolicitacaoDeReprocessamento>> · Rust: Result<Vec<tipos::SolicitacaoDeReprocessamento>, ErroAoChamarServico>

buscar_pelo_id_solicitacao_de_reprocessamento

GET/solicitacao_de_reprocessamento/{id} Exige credencial

Busca uma solicitação de reprocessamento pelo id

Exige a área monitoramento. Devolve quem pediu, o motivo, o alcance com seus parâmetros, a assinatura (assinante e tipo de evento) e quantas entregas foram reabertas e criadas.

function buscar_pelo_id_solicitacao_de_reprocessamento(
  credencial_de_acesso: CredencialDeAcesso,
  id: string,
  opcoes_da_chamada?: OpcoesDaChamada,
): Promise<tipos.SolicitacaoDeReprocessamento>
Exemplo
import { CredencialDeAcesso } from "termo_core";
import { buscar_pelo_id_solicitacao_de_reprocessamento } from "termo_core/webhook";

const credencial_de_acesso = CredencialDeAcesso.token_do_usuario_logado(token_do_usuario);
const resposta = await buscar_pelo_id_solicitacao_de_reprocessamento(credencial_de_acesso, id);

Argumentos

Nome

Tipo

Retorno: Promise<tipos.SolicitacaoDeReprocessamento> · Rust: Result<tipos::SolicitacaoDeReprocessamento, ErroAoChamarServico> · veja SolicitacaoDeReprocessamento.

Tipos

Tipos usados pelas funções desta página. O nome é o mesmo nos dois pacotes.

PaginaSolicitacaoDeReprocessamento

import type { PaginaSolicitacaoDeReprocessamento } from "termo_core/webhook";

export interface PaginaSolicitacaoDeReprocessamento {
  itens: Array<PaginaSolicitacaoDeReprocessamentoItensItem>;
  pagina: number;
  tamanho: number;
  total: number;
}

PaginaSolicitacaoDeReprocessamentoItensItem

import type { PaginaSolicitacaoDeReprocessamentoItensItem } from "termo_core/webhook";

export interface PaginaSolicitacaoDeReprocessamentoItensItem {
  alcance: string;
  aplicativo_assinante_nome: string;
  assinatura_id: string;
  entrega_id?: string | null;
  eventos_ate?: string | null;
  eventos_desde?: string | null;
  id: string;
  incluir_entregues: boolean;
  motivo: string;
  quantidade_de_entregas_criadas: number;
  quantidade_de_entregas_reabertas: number;
  solicitada_em: string;
  solicitada_por_auth_id: string;
  solicitada_por_email: string;
  tipo_de_evento_nome: string;
}

SolicitacaoDeReprocessamento

import type { SolicitacaoDeReprocessamento } from "termo_core/webhook";

export interface SolicitacaoDeReprocessamento {
  alcance: string;
  aplicativo_assinante_nome: string;
  assinatura_id: string;
  entrega_id?: string | null;
  eventos_ate?: string | null;
  eventos_desde?: string | null;
  id: string;
  incluir_entregues: boolean;
  motivo: string;
  quantidade_de_entregas_criadas: number;
  quantidade_de_entregas_reabertas: number;
  solicitada_em: string;
  solicitada_por_auth_id: string;
  solicitada_por_email: string;
  tipo_de_evento_nome: string;
}

SolicitacaoDeReprocessamentoCriar

import type { SolicitacaoDeReprocessamentoCriar } from "termo_core/webhook";

export interface SolicitacaoDeReprocessamentoCriar {
  alcance: string;
  assinatura_id?: string | null;
  entrega_id?: string | null;
  eventos_ate?: string | null;
  eventos_desde?: string | null;
  incluir_entregues?: boolean;
  motivo: string;
}

Eventos

2 funções do TermoWebhook para eventos.

Tipo de evento

7 funções do TermoWebhook para tipo de evento.

Nesta página

buscar_paginador_solicitacao_de_reprocessamentocriar_solicitacao_de_reprocessamentobuscar_pelo_filtro_solicitacao_de_reprocessamentobuscar_pelo_id_solicitacao_de_reprocessamentoTiposPaginaSolicitacaoDeReprocessamentoPaginaSolicitacaoDeReprocessamentoItensItemSolicitacaoDeReprocessamentoSolicitacaoDeReprocessamentoCriar