From ce2b5061b061e15f597d36ff74d6f94357844f3e Mon Sep 17 00:00:00 2001 From: joao-muniz-efi Date: Thu, 26 Dec 2024 17:10:11 +0000 Subject: [PATCH] =?UTF-8?q?=E2=9C=A8=20Release=201.2.13=20-=20Adicionado?= =?UTF-8?q?=20m=C3=A9todos=20e=20exemplos=20para=20API=20Extratos?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- dist/cjs/index.cjs | 154 +++++++++++++++++- dist/esm/index.mjs | 154 +++++++++++++++++- dist/types/lib/constants.d.ts | 55 +++++++ dist/types/methods/cobrancas.d.ts | 3 +- dist/types/methods/extratos.d.ts | 126 ++++++++++++++ .../statements/management/createSftpKey.js | 13 ++ .../management/createStatementRecurrency.js | 19 +++ .../statements/management/getStatementFile.js | 17 ++ .../management/listStatementFiles.js | 13 ++ .../management/listStatementRecurrences.js | 13 ++ .../management/updateStatementRecurrency.js | 20 +++ package-lock.json | 4 +- package.json | 2 +- src/lib/constants.js | 36 ++++ src/methods/cobrancas.js | 4 +- src/methods/extratos.js | 114 +++++++++++++ 16 files changed, 738 insertions(+), 9 deletions(-) create mode 100644 dist/types/methods/extratos.d.ts create mode 100644 examples/statements/management/createSftpKey.js create mode 100644 examples/statements/management/createStatementRecurrency.js create mode 100644 examples/statements/management/getStatementFile.js create mode 100644 examples/statements/management/listStatementFiles.js create mode 100644 examples/statements/management/listStatementRecurrences.js create mode 100644 examples/statements/management/updateStatementRecurrency.js create mode 100644 src/methods/extratos.js diff --git a/dist/cjs/index.cjs b/dist/cjs/index.cjs index 94ce3a4..4eb4146 100644 --- a/dist/cjs/index.cjs +++ b/dist/cjs/index.cjs @@ -569,6 +569,42 @@ var constants = { method: 'get' } } + }, + EXTRATOS: { + URL: { + PRODUCTION: 'https://extratos.api.efipay.com.br/v1', + SANDBOX: 'https://extratos-h.api.efipay.com.br/v1' + }, + ENDPOINTS: { + authorize: { + route: '/oauth/token', + method: 'post' + }, + listStatementFiles: { + route: '/extrato-cnab/arquivos', + method: 'get' + }, + getStatementFile: { + route: '/extrato-cnab/download/:nome_arquivo', + method: 'get' + }, + listStatementRecurrences: { + route: '/extrato-cnab/agendamentos', + method: 'get' + }, + createStatementRecurrency: { + route: '/extrato-cnab/agendar', + method: 'post' + }, + updateStatementRecurrency: { + route: '/extrato-cnab/agendar/:identificador', + method: 'patch' + }, + createSftpKey: { + route: '/extrato-cnab/gerar-chaves', + method: 'post' + } + } } } }; @@ -584,7 +620,7 @@ var exports$1 = { } }; var description = "Module for integration with Efi Bank API"; -var version = "1.2.12"; +var version = "1.2.13"; var author = "Efi Bank - Consultoria Técnica | João Vitor Oliveira | João Lucas"; var license = "MIT"; var repository = "efipay/sdk-node-apis-efi"; @@ -872,7 +908,121 @@ class Endpoints { } // @ts-nocheck -class CobrancasMethods { +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 } + */ + 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 } + */ + 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 } + */ + 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() {} +} + +// @ts-nocheck +class CobrancasMethods extends ExtratosMethods { /** * **POST /v1/charge/one-step** * diff --git a/dist/esm/index.mjs b/dist/esm/index.mjs index ddc06f6..e9cf46b 100644 --- a/dist/esm/index.mjs +++ b/dist/esm/index.mjs @@ -560,6 +560,42 @@ var constants = { method: 'get' } } + }, + EXTRATOS: { + URL: { + PRODUCTION: 'https://extratos.api.efipay.com.br/v1', + SANDBOX: 'https://extratos-h.api.efipay.com.br/v1' + }, + ENDPOINTS: { + authorize: { + route: '/oauth/token', + method: 'post' + }, + listStatementFiles: { + route: '/extrato-cnab/arquivos', + method: 'get' + }, + getStatementFile: { + route: '/extrato-cnab/download/:nome_arquivo', + method: 'get' + }, + listStatementRecurrences: { + route: '/extrato-cnab/agendamentos', + method: 'get' + }, + createStatementRecurrency: { + route: '/extrato-cnab/agendar', + method: 'post' + }, + updateStatementRecurrency: { + route: '/extrato-cnab/agendar/:identificador', + method: 'patch' + }, + createSftpKey: { + route: '/extrato-cnab/gerar-chaves', + method: 'post' + } + } } } }; @@ -575,7 +611,7 @@ var exports = { } }; var description = "Module for integration with Efi Bank API"; -var version = "1.2.12"; +var version = "1.2.13"; var author = "Efi Bank - Consultoria Técnica | João Vitor Oliveira | João Lucas"; var license = "MIT"; var repository = "efipay/sdk-node-apis-efi"; @@ -863,7 +899,121 @@ class Endpoints { } // @ts-nocheck -class CobrancasMethods { +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 } + */ + 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 } + */ + 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 } + */ + 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() {} +} + +// @ts-nocheck +class CobrancasMethods extends ExtratosMethods { /** * **POST /v1/charge/one-step** * diff --git a/dist/types/lib/constants.d.ts b/dist/types/lib/constants.d.ts index 5446e8c..15d21e8 100644 --- a/dist/types/lib/constants.d.ts +++ b/dist/types/lib/constants.d.ts @@ -832,6 +832,61 @@ declare namespace _default { } export { ENDPOINTS_4 as ENDPOINTS }; } + namespace EXTRATOS { + export namespace URL_5 { + const PRODUCTION_5: string; + export { PRODUCTION_5 as PRODUCTION }; + const SANDBOX_5: string; + export { SANDBOX_5 as SANDBOX }; + } + export { URL_5 as URL }; + export namespace ENDPOINTS_5 { + export namespace authorize_5 { + const route_129: string; + export { route_129 as route }; + const method_129: string; + export { method_129 as method }; + } + export { authorize_5 as authorize }; + export namespace listStatementFiles { + const route_130: string; + export { route_130 as route }; + const method_130: string; + export { method_130 as method }; + } + export namespace getStatementFile { + const route_131: string; + export { route_131 as route }; + const method_131: string; + export { method_131 as method }; + } + export namespace listStatementRecurrences { + const route_132: string; + export { route_132 as route }; + const method_132: string; + export { method_132 as method }; + } + export namespace createStatementRecurrency { + const route_133: string; + export { route_133 as route }; + const method_133: string; + export { method_133 as method }; + } + export namespace updateStatementRecurrency { + const route_134: string; + export { route_134 as route }; + const method_134: string; + export { method_134 as method }; + } + export namespace createSftpKey { + const route_135: string; + export { route_135 as route }; + const method_135: string; + export { method_135 as method }; + } + } + export { ENDPOINTS_5 as ENDPOINTS }; + } } } export default _default; diff --git a/dist/types/methods/cobrancas.d.ts b/dist/types/methods/cobrancas.d.ts index 6739507..7804ecc 100644 --- a/dist/types/methods/cobrancas.d.ts +++ b/dist/types/methods/cobrancas.d.ts @@ -1,4 +1,4 @@ -export class CobrancasMethods { +export class CobrancasMethods extends ExtratosMethods { /** * **POST /v1/charge/one-step** * @@ -3191,3 +3191,4 @@ export class CobrancasMethods { }>; }>; } +import { ExtratosMethods } from "./extratos"; diff --git a/dist/types/methods/extratos.d.ts b/dist/types/methods/extratos.d.ts new file mode 100644 index 0000000..62c1dea --- /dev/null +++ b/dist/types/methods/extratos.d.ts @@ -0,0 +1,126 @@ +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(): Promise<{ + Array(); + }>; + /** + * **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 } + */ + getStatementFile(params: { + nome_arquivo: string; + }): Promise; + /** + * **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(): Promise<{ + Array(); + }>; + /** + * **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 } + */ + createStatementRecurrency(params: {}, body: { + periodicidade: string; + enviar_email: boolean; + comprimir_arquivos: boolean; + }): Promise; + /** + * **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 } + */ + updateStatementRecurrency(params: { + identificador: string; + }, body: { + periodicidade: string; + status: string; + envia_email: boolean; + comprimir_arquivos: boolean; + }): Promise; + /** + * **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(): Promise<{ + privateKey: string; + }>; +} diff --git a/examples/statements/management/createSftpKey.js b/examples/statements/management/createSftpKey.js new file mode 100644 index 0000000..25f3aa9 --- /dev/null +++ b/examples/statements/management/createSftpKey.js @@ -0,0 +1,13 @@ +const EfiPay = require('sdk-node-apis-efi') +const options = require('../../../credentials') + +const efipay = new EfiPay(options) + +// O método createSftpKey indica os campos que devem ser enviados e que serão retornados +efipay.createSftpKey() + .then((resposta) => { + console.log(resposta) // Aqui você tera acesso a resposta da API e os campos retornados de forma intuitiva + }) + .catch((error) => { + console.log(error) + }) diff --git a/examples/statements/management/createStatementRecurrency.js b/examples/statements/management/createStatementRecurrency.js new file mode 100644 index 0000000..0f36c02 --- /dev/null +++ b/examples/statements/management/createStatementRecurrency.js @@ -0,0 +1,19 @@ +const EfiPay = require('sdk-node-apis-efi') +const options = require('../../../credentials') + +const efipay = new EfiPay(options) + +let body = { + periodicidade: "diario", + envia_email: true, + comprimir_arquivos: true +} + +// O método createStatementRecurrency indica os campos que devem ser enviados e que serão retornados +efipay.createStatementRecurrency({}, body) + .then((resposta) => { + console.log(resposta) // Aqui você tera acesso a resposta da API e os campos retornados de forma intuitiva + }) + .catch((error) => { + console.log(error) + }) diff --git a/examples/statements/management/getStatementFile.js b/examples/statements/management/getStatementFile.js new file mode 100644 index 0000000..ccc726a --- /dev/null +++ b/examples/statements/management/getStatementFile.js @@ -0,0 +1,17 @@ +const EfiPay = require('sdk-node-apis-efi') +const options = require('../../../credentials') + +const efipay = new EfiPay(options) + +let params = { + nome_arquivo: 'nome_arquivo' +} + +// O método getStatementFile indica os campos que devem ser enviados e que serão retornados +efipay.getStatementFile(params) + .then((resposta) => { + console.log(resposta) // Aqui você tera acesso a resposta da API e os campos retornados de forma intuitiva + }) + .catch((error) => { + console.log(error) + }) diff --git a/examples/statements/management/listStatementFiles.js b/examples/statements/management/listStatementFiles.js new file mode 100644 index 0000000..62714c2 --- /dev/null +++ b/examples/statements/management/listStatementFiles.js @@ -0,0 +1,13 @@ +const EfiPay = require('sdk-node-apis-efi') +const options = require('../../../credentials') + +const efipay = new EfiPay(options) + +// O método listStatementFiles indica os campos que devem ser enviados e que serão retornados +efipay.listStatementFiles() + .then((resposta) => { + console.log(resposta) // Aqui você tera acesso a resposta da API e os campos retornados de forma intuitiva + }) + .catch((error) => { + console.log(error) + }) diff --git a/examples/statements/management/listStatementRecurrences.js b/examples/statements/management/listStatementRecurrences.js new file mode 100644 index 0000000..edb592e --- /dev/null +++ b/examples/statements/management/listStatementRecurrences.js @@ -0,0 +1,13 @@ +const EfiPay = require('sdk-node-apis-efi') +const options = require('../../../credentials') + +const efipay = new EfiPay(options) + +// O método listStatementRecurrences indica os campos que devem ser enviados e que serão retornados +efipay.listStatementRecurrences() + .then((resposta) => { + console.log(resposta) // Aqui você tera acesso a resposta da API e os campos retornados de forma intuitiva + }) + .catch((error) => { + console.log(error) + }) diff --git a/examples/statements/management/updateStatementRecurrency.js b/examples/statements/management/updateStatementRecurrency.js new file mode 100644 index 0000000..fa77821 --- /dev/null +++ b/examples/statements/management/updateStatementRecurrency.js @@ -0,0 +1,20 @@ +const EfiPay = require('sdk-node-apis-efi') +const options = require('../../../credentials') + +const efipay = new EfiPay(options) + +let body = { + periodicidade: "diario", + status: "ativo", + envia_email: true, + comprimir_arquivos: true +} + +// O método updateStatementRecurrency indica os campos que devem ser enviados e que serão retornados +efipay.updateStatementRecurrency({}, body) + .then((resposta) => { + console.log(resposta) // Aqui você tera acesso a resposta da API e os campos retornados de forma intuitiva + }) + .catch((error) => { + console.log(error) + }) diff --git a/package-lock.json b/package-lock.json index eb8e787..8281e24 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "sdk-node-apis-efi", - "version": "1.2.12", + "version": "1.2.13", "lockfileVersion": 2, "requires": true, "packages": { "": { "name": "sdk-node-apis-efi", - "version": "1.2.12", + "version": "1.2.13", "license": "MIT", "dependencies": { "axios": "^1.2.2", diff --git a/package.json b/package.json index deceaa3..0e9c3fd 100755 --- a/package.json +++ b/package.json @@ -10,7 +10,7 @@ } }, "description": "Module for integration with Efi Bank API", - "version": "1.2.12", + "version": "1.2.13", "author": "Efi Bank - Consultoria Técnica | João Vitor Oliveira | João Lucas", "license": "MIT", "repository": "efipay/sdk-node-apis-efi", diff --git a/src/lib/constants.js b/src/lib/constants.js index 85dd814..0cea320 100644 --- a/src/lib/constants.js +++ b/src/lib/constants.js @@ -556,5 +556,41 @@ export default { }, }, }, + EXTRATOS: { + URL: { + PRODUCTION: 'https://extratos.api.efipay.com.br/v1', + SANDBOX: 'https://extratos-h.api.efipay.com.br/v1', + }, + ENDPOINTS: { + authorize: { + route: '/oauth/token', + method: 'post', + }, + listStatementFiles: { + route: '/extrato-cnab/arquivos', + method: 'get', + }, + getStatementFile: { + route: '/extrato-cnab/download/:nome_arquivo', + method: 'get', + }, + listStatementRecurrences: { + route: '/extrato-cnab/agendamentos', + method: 'get', + }, + createStatementRecurrency: { + route: '/extrato-cnab/agendar', + method: 'post', + }, + updateStatementRecurrency: { + route: '/extrato-cnab/agendar/:identificador', + method: 'patch', + }, + createSftpKey: { + route: '/extrato-cnab/gerar-chaves', + method: 'post', + } + } + } }, } diff --git a/src/methods/cobrancas.js b/src/methods/cobrancas.js index b43c87e..d592533 100644 --- a/src/methods/cobrancas.js +++ b/src/methods/cobrancas.js @@ -1,5 +1,7 @@ // @ts-nocheck -export class CobrancasMethods { +import { ExtratosMethods } from "./extratos"; + +export class CobrancasMethods extends ExtratosMethods { /** * **POST /v1/charge/one-step** diff --git a/src/methods/extratos.js b/src/methods/extratos.js new file mode 100644 index 0000000..608e194 --- /dev/null +++ b/src/methods/extratos.js @@ -0,0 +1,114 @@ +// @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 } + */ + 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 } + */ + 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 } + */ + 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() { } +}