Skip to content

Commit ce2b506

Browse files
joao-muniz-efijoao-muniz-efi
committed
✨ Release 1.2.13
- Adicionado métodos e exemplos para API Extratos
1 parent 818f8f6 commit ce2b506

16 files changed

+738
-9
lines changed

‎dist/cjs/index.cjs

Lines changed: 152 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -569,6 +569,42 @@ var constants = {
569569
method: 'get'
570570
}
571571
}
572+
},
573+
EXTRATOS: {
574+
URL: {
575+
PRODUCTION: 'https://extratos.api.efipay.com.br/v1',
576+
SANDBOX: 'https://extratos-h.api.efipay.com.br/v1'
577+
},
578+
ENDPOINTS: {
579+
authorize: {
580+
route: '/oauth/token',
581+
method: 'post'
582+
},
583+
listStatementFiles: {
584+
route: '/extrato-cnab/arquivos',
585+
method: 'get'
586+
},
587+
getStatementFile: {
588+
route: '/extrato-cnab/download/:nome_arquivo',
589+
method: 'get'
590+
},
591+
listStatementRecurrences: {
592+
route: '/extrato-cnab/agendamentos',
593+
method: 'get'
594+
},
595+
createStatementRecurrency: {
596+
route: '/extrato-cnab/agendar',
597+
method: 'post'
598+
},
599+
updateStatementRecurrency: {
600+
route: '/extrato-cnab/agendar/:identificador',
601+
method: 'patch'
602+
},
603+
createSftpKey: {
604+
route: '/extrato-cnab/gerar-chaves',
605+
method: 'post'
606+
}
607+
}
572608
}
573609
}
574610
};
@@ -584,7 +620,7 @@ var exports$1 = {
584620
}
585621
};
586622
var description = "Module for integration with Efi Bank API";
587-
var version = "1.2.12";
623+
var version = "1.2.13";
588624
var author = "Efi Bank - Consultoria Técnica | João Vitor Oliveira | João Lucas";
589625
var license = "MIT";
590626
var repository = "efipay/sdk-node-apis-efi";
@@ -872,7 +908,121 @@ class Endpoints {
872908
}
873909

874910
// @ts-nocheck
875-
class CobrancasMethods {
911+
class ExtratosMethods {
912+
/**
913+
* **GET /v1/extrato-cnab/arquivos**
914+
*
915+
* Consultar arquivos gerados
916+
*
917+
* Este endpoint é utilizado para consultar os arquivos CNAB gerados e associados a uma conta específica.
918+
*
919+
* Para capturar uma falha utilize o `catch`, o campo disponível será `mensagem`.
920+
*
921+
* @returns { Promise <{
922+
* Array<{
923+
* data_geracao: string,
924+
* nome: string
925+
* }>
926+
* }>}
927+
*/
928+
listStatementFiles() {}
929+
930+
/**
931+
* **GET /v1/extrato-cnab/download/:nome_arquivo**
932+
*
933+
* Solicitar Download do extrato
934+
*
935+
* Este endpoint é utilizado para Endpoint para solicitar download do extrato.
936+
*
937+
* Para capturar uma falha utilize o `catch`, o campo disponível será `mensagem`.
938+
*
939+
* @param { { nome_arquivo: string } } params
940+
*
941+
* @returns { Promise<string> }
942+
*/
943+
getStatementFile(params) {}
944+
945+
/**
946+
* **GET /v1/extrato-cnab/agendamentos**
947+
*
948+
* Consultar recorrências cadastradas
949+
*
950+
* Este endpoint é utilizado para consultar os agendamentos de recorrências cadastradas em uma conta específica.
951+
*
952+
* Para capturar uma falha utilize o `catch`, o campo disponível será `mensagem`.
953+
*
954+
* @returns { Promise<{
955+
* Array<{
956+
* status: string,
957+
* periodicidade: string,
958+
* envia_email: boolean,
959+
* comprimir_arquivos: boolean,
960+
* data_criacao: string
961+
* }>
962+
* }>}
963+
*
964+
*/
965+
listStatementRecurrences() {}
966+
967+
/**
968+
* **POST /v1/extrato-cnab/agendar**
969+
*
970+
* Criar recorrência
971+
*
972+
* Este endpoint é utilizado para criar uma nova recorrência.
973+
*
974+
* Para capturar uma falha utilize o `catch`, o campo disponível será `mensagem`.
975+
*
976+
* @param { {} } params
977+
* @param { {
978+
* periodicidade: string,
979+
* enviar_email: boolean,
980+
* comprimir_arquivos: boolean
981+
* } } body
982+
*
983+
* @returns { Promise<void> }
984+
*/
985+
createStatementRecurrency(params, body) {}
986+
987+
/**
988+
* **PATCH /v1/extrato-cnab/agendar/:identificador**
989+
*
990+
* Revisar recorrência
991+
*
992+
* Este endpoint é utilizado para atualizar ou modificar uma recorrência existente a partir do identificador.
993+
*
994+
* Para capturar uma falha utilize o `catch`, o campo disponível será `mensagem`.
995+
*
996+
* @param { { identificador: string } } params
997+
* @param {{
998+
* periodicidade: string,
999+
* status: string,
1000+
* envia_email: boolean,
1001+
* comprimir_arquivos: boolean,
1002+
* }} body
1003+
*
1004+
* @returns { Promise<void> }
1005+
*/
1006+
updateStatementRecurrency(params, body) {}
1007+
1008+
/**
1009+
* **POST /v1/extrato-cnab/gerar-chaves**
1010+
*
1011+
* Gerar chave
1012+
*
1013+
* Este endpoint é utilizado para gerar uma chave associada a uma conta específica.
1014+
*
1015+
* Para capturar uma falha utilize o `catch`, o campo disponível será `mensagem`.
1016+
*
1017+
* @returns { Promise<{
1018+
* privateKey: string
1019+
* }>}
1020+
*/
1021+
createSftpKey() {}
1022+
}
1023+
1024+
// @ts-nocheck
1025+
class CobrancasMethods extends ExtratosMethods {
8761026
/**
8771027
* **POST /v1/charge/one-step**
8781028
*

‎dist/esm/index.mjs

Lines changed: 152 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -560,6 +560,42 @@ var constants = {
560560
method: 'get'
561561
}
562562
}
563+
},
564+
EXTRATOS: {
565+
URL: {
566+
PRODUCTION: 'https://extratos.api.efipay.com.br/v1',
567+
SANDBOX: 'https://extratos-h.api.efipay.com.br/v1'
568+
},
569+
ENDPOINTS: {
570+
authorize: {
571+
route: '/oauth/token',
572+
method: 'post'
573+
},
574+
listStatementFiles: {
575+
route: '/extrato-cnab/arquivos',
576+
method: 'get'
577+
},
578+
getStatementFile: {
579+
route: '/extrato-cnab/download/:nome_arquivo',
580+
method: 'get'
581+
},
582+
listStatementRecurrences: {
583+
route: '/extrato-cnab/agendamentos',
584+
method: 'get'
585+
},
586+
createStatementRecurrency: {
587+
route: '/extrato-cnab/agendar',
588+
method: 'post'
589+
},
590+
updateStatementRecurrency: {
591+
route: '/extrato-cnab/agendar/:identificador',
592+
method: 'patch'
593+
},
594+
createSftpKey: {
595+
route: '/extrato-cnab/gerar-chaves',
596+
method: 'post'
597+
}
598+
}
563599
}
564600
}
565601
};
@@ -575,7 +611,7 @@ var exports = {
575611
}
576612
};
577613
var description = "Module for integration with Efi Bank API";
578-
var version = "1.2.12";
614+
var version = "1.2.13";
579615
var author = "Efi Bank - Consultoria Técnica | João Vitor Oliveira | João Lucas";
580616
var license = "MIT";
581617
var repository = "efipay/sdk-node-apis-efi";
@@ -863,7 +899,121 @@ class Endpoints {
863899
}
864900

865901
// @ts-nocheck
866-
class CobrancasMethods {
902+
class ExtratosMethods {
903+
/**
904+
* **GET /v1/extrato-cnab/arquivos**
905+
*
906+
* Consultar arquivos gerados
907+
*
908+
* Este endpoint é utilizado para consultar os arquivos CNAB gerados e associados a uma conta específica.
909+
*
910+
* Para capturar uma falha utilize o `catch`, o campo disponível será `mensagem`.
911+
*
912+
* @returns { Promise <{
913+
* Array<{
914+
* data_geracao: string,
915+
* nome: string
916+
* }>
917+
* }>}
918+
*/
919+
listStatementFiles() {}
920+
921+
/**
922+
* **GET /v1/extrato-cnab/download/:nome_arquivo**
923+
*
924+
* Solicitar Download do extrato
925+
*
926+
* Este endpoint é utilizado para Endpoint para solicitar download do extrato.
927+
*
928+
* Para capturar uma falha utilize o `catch`, o campo disponível será `mensagem`.
929+
*
930+
* @param { { nome_arquivo: string } } params
931+
*
932+
* @returns { Promise<string> }
933+
*/
934+
getStatementFile(params) {}
935+
936+
/**
937+
* **GET /v1/extrato-cnab/agendamentos**
938+
*
939+
* Consultar recorrências cadastradas
940+
*
941+
* Este endpoint é utilizado para consultar os agendamentos de recorrências cadastradas em uma conta específica.
942+
*
943+
* Para capturar uma falha utilize o `catch`, o campo disponível será `mensagem`.
944+
*
945+
* @returns { Promise<{
946+
* Array<{
947+
* status: string,
948+
* periodicidade: string,
949+
* envia_email: boolean,
950+
* comprimir_arquivos: boolean,
951+
* data_criacao: string
952+
* }>
953+
* }>}
954+
*
955+
*/
956+
listStatementRecurrences() {}
957+
958+
/**
959+
* **POST /v1/extrato-cnab/agendar**
960+
*
961+
* Criar recorrência
962+
*
963+
* Este endpoint é utilizado para criar uma nova recorrência.
964+
*
965+
* Para capturar uma falha utilize o `catch`, o campo disponível será `mensagem`.
966+
*
967+
* @param { {} } params
968+
* @param { {
969+
* periodicidade: string,
970+
* enviar_email: boolean,
971+
* comprimir_arquivos: boolean
972+
* } } body
973+
*
974+
* @returns { Promise<void> }
975+
*/
976+
createStatementRecurrency(params, body) {}
977+
978+
/**
979+
* **PATCH /v1/extrato-cnab/agendar/:identificador**
980+
*
981+
* Revisar recorrência
982+
*
983+
* Este endpoint é utilizado para atualizar ou modificar uma recorrência existente a partir do identificador.
984+
*
985+
* Para capturar uma falha utilize o `catch`, o campo disponível será `mensagem`.
986+
*
987+
* @param { { identificador: string } } params
988+
* @param {{
989+
* periodicidade: string,
990+
* status: string,
991+
* envia_email: boolean,
992+
* comprimir_arquivos: boolean,
993+
* }} body
994+
*
995+
* @returns { Promise<void> }
996+
*/
997+
updateStatementRecurrency(params, body) {}
998+
999+
/**
1000+
* **POST /v1/extrato-cnab/gerar-chaves**
1001+
*
1002+
* Gerar chave
1003+
*
1004+
* Este endpoint é utilizado para gerar uma chave associada a uma conta específica.
1005+
*
1006+
* Para capturar uma falha utilize o `catch`, o campo disponível será `mensagem`.
1007+
*
1008+
* @returns { Promise<{
1009+
* privateKey: string
1010+
* }>}
1011+
*/
1012+
createSftpKey() {}
1013+
}
1014+
1015+
// @ts-nocheck
1016+
class CobrancasMethods extends ExtratosMethods {
8671017
/**
8681018
* **POST /v1/charge/one-step**
8691019
*

0 commit comments

Comments
 (0)