intopays/dist/core/services/BoletoService.d.ts

Intopays - Gateway de integração bancária

import { BoletoRemote } from "../../infra/http/BoletoRemote";
import { Boleto } from "../models/Boleto";
/**
 * Serviço responsável pela lógica de negócios relacionada aos boletos.
 */
export declare class BoletoService {
    private readonly remote;
    /**
     * Construtor da classe BoletoService.
     * @param remote - Instância da classe BoletoRemote responsável pela comunicação com o servidor.
     */
    constructor(remote: BoletoRemote);
    /**
     * Cria um novo boleto no sistema.
     * @param data - Dados necessários para a criação do boleto.
     * @returns O objeto Boleto criado.
     */
    create(data: Boleto): Promise<Boleto>;
    /**
     * Busca uma lista de boletos com base em dados de filtro fornecidos.
     * @param data - Dados para filtrar os boletos (opcional).
     * @returns Lista de boletos que atendem aos critérios fornecidos.
     */
    search(data?: Partial<Boleto>): Promise<Array<Boleto>>;
    /**
     * Encontra um boleto específico pelo seu ID.
     * @param id - ID do boleto a ser buscado.
     * @returns O objeto Boleto encontrado.
     */
    find(id: number): Promise<Boleto>;
    /**
     * Anula um boleto específico.
     * @param id - ID do boleto a ser anulado.
     * @returns Retorna um booleano indicando o sucesso ou falha da operação.
     */
    void(id: number | string): Promise<boolean>;
}