sdk-node-apis-efi/src/methods/extratos.js

Module for integration with Efi Bank API

// @ts-nocheck
export class ExtratosMethods {

    /**
     * **GET /v1/extrato-cnab/arquivos**
     * 
     * Consultar arquivos gerados
     * 
     * Este endpoint é utilizado para consultar os arquivos CNAB gerados e associados a uma conta específica.
     * 
     * Para capturar uma falha utilize o `catch`, o campo disponível será `mensagem`.
     * 
     * @returns { Promise <{
     *  Array<{
     *      data_geracao: string,
     *      nome: string
     *  }>
     * }>}
     */
    listStatementFiles() { }

    /**
     * **GET /v1/extrato-cnab/download/:nome_arquivo**
     * 
     * Solicitar Download do extrato
     * 
     * Este endpoint é utilizado para Endpoint para solicitar download do extrato.
     * 
     * Para capturar uma falha utilize o `catch`, o campo disponível será `mensagem`.
     * 
     * @param { { nome_arquivo: string } } params
     * 
     * @returns { Promise<string> }
     */
    getStatementFile(params) { }

    /**
     * **GET /v1/extrato-cnab/agendamentos**
     * 
     * Consultar recorrências cadastradas
     * 
     * Este endpoint é utilizado para consultar os agendamentos de recorrências cadastradas em uma conta específica.
     * 
     * Para capturar uma falha utilize o `catch`, o campo disponível será `mensagem`.
     * 
     * @returns { Promise<{
     *  Array<{
     *      status: string,
     *      periodicidade: string,
     *      envia_email: boolean,
     *      comprimir_arquivos: boolean,
     *      data_criacao: string
     *  }>
     * }>}
     * 
     */
    listStatementRecurrences() { }

    /**
     * **POST /v1/extrato-cnab/agendar**
     * 
     * Criar recorrência
     * 
     * Este endpoint é utilizado para criar uma nova recorrência.
     * 
     * Para capturar uma falha utilize o `catch`, o campo disponível será `mensagem`.
     * 
     * @param { {} } params 
     * @param { {
     *  periodicidade: string,
     *  enviar_email: boolean,
     *  comprimir_arquivos: boolean    
     * } } body 
     * 
     * @returns { Promise<void> }
     */
    createStatementRecurrency(params, body) { }

    /**
     * **PATCH /v1/extrato-cnab/agendar/:identificador**
     * 
     * Revisar recorrência
     * 
     * Este endpoint é utilizado para atualizar ou modificar uma recorrência existente a partir do identificador. 
     * 
     * Para capturar uma falha utilize o `catch`, o campo disponível será `mensagem`.
     * 
     * @param { { identificador: string } } params 
     * @param {{
     *      periodicidade: string,
     *      status: string,
     *      envia_email: boolean,
     *      comprimir_arquivos: boolean,
     * }} body 
     * 
     * @returns { Promise<void> }
     */
    updateStatementRecurrency(params, body) { }

    /**
     * **POST /v1/extrato-cnab/gerar-chaves**
     * 
     * Gerar chave
     * 
     * Este endpoint é utilizado para gerar uma chave associada a uma conta específica.
     * 
     * Para capturar uma falha utilize o `catch`, o campo disponível será `mensagem`.
     * 
     * @returns { Promise<{
     *  privateKey: string
     * }>}
     */
    createSftpKey() { }
}