Skip to content

Commit dad3748

Browse files
✨ Release 1.2.5
- Alinhando com a versão https://github.com/efipay/sdk-node-apis-efi/releases/tag/1.2.16 do SDK de Node
1 parent dc78cc3 commit dad3748

17 files changed

+782
-45
lines changed

dist/cjs/index.cjs

Lines changed: 160 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -579,11 +579,12 @@ var types = "dist/types/index.d.ts";
579579
var exports$1 = {
580580
".": {
581581
require: "./dist/cjs/index.cjs",
582-
"import": "./dist/cjs/index.cjs"
582+
"import": "./dist/cjs/index.cjs",
583+
types: "./dist/types/index.d.ts"
583584
}
584585
};
585586
var description = "Module for integration with Efi Bank API";
586-
var version = "1.2.4";
587+
var version = "1.2.5";
587588
var deprecated = "Este pacote será descontinuado. Use o 'sdk-node-apis-efi' no lugar.";
588589
var author = "Efi Bank - Consultoria Técnica | João Vitor Oliveira | João Lucas";
589590
var license = "MIT";
@@ -873,7 +874,121 @@ class Endpoints {
873874
}
874875

875876
// @ts-nocheck
876-
class CobrancasMethods {
877+
class ExtratosMethods {
878+
/**
879+
* **GET /v1/extrato-cnab/arquivos**
880+
*
881+
* Consultar arquivos gerados
882+
*
883+
* Este endpoint é utilizado para consultar os arquivos CNAB gerados e associados a uma conta específica.
884+
*
885+
* Para capturar uma falha utilize o `catch`, o campo disponível será `mensagem`.
886+
*
887+
* @returns { Promise <{
888+
* Array<{
889+
* data_geracao: string,
890+
* nome: string
891+
* }>
892+
* }>}
893+
*/
894+
listStatementFiles() {}
895+
896+
/**
897+
* **GET /v1/extrato-cnab/download/:nome_arquivo**
898+
*
899+
* Solicitar Download do extrato
900+
*
901+
* Este endpoint é utilizado para Endpoint para solicitar download do extrato.
902+
*
903+
* Para capturar uma falha utilize o `catch`, o campo disponível será `mensagem`.
904+
*
905+
* @param { { nome_arquivo: string } } params
906+
*
907+
* @returns { Promise<string> }
908+
*/
909+
getStatementFile(params) {}
910+
911+
/**
912+
* **GET /v1/extrato-cnab/agendamentos**
913+
*
914+
* Consultar recorrências cadastradas
915+
*
916+
* Este endpoint é utilizado para consultar os agendamentos de recorrências cadastradas em uma conta específica.
917+
*
918+
* Para capturar uma falha utilize o `catch`, o campo disponível será `mensagem`.
919+
*
920+
* @returns { Promise<{
921+
* Array<{
922+
* status: string,
923+
* periodicidade: string,
924+
* envia_email: boolean,
925+
* comprimir_arquivos: boolean,
926+
* data_criacao: string
927+
* }>
928+
* }>}
929+
*
930+
*/
931+
listStatementRecurrences() {}
932+
933+
/**
934+
* **POST /v1/extrato-cnab/agendar**
935+
*
936+
* Criar recorrência
937+
*
938+
* Este endpoint é utilizado para criar uma nova recorrência.
939+
*
940+
* Para capturar uma falha utilize o `catch`, o campo disponível será `mensagem`.
941+
*
942+
* @param { {} } params
943+
* @param { {
944+
* periodicidade: string,
945+
* enviar_email: boolean,
946+
* comprimir_arquivos: boolean
947+
* } } body
948+
*
949+
* @returns { Promise<void> }
950+
*/
951+
createStatementRecurrency(params, body) {}
952+
953+
/**
954+
* **PATCH /v1/extrato-cnab/agendar/:identificador**
955+
*
956+
* Revisar recorrência
957+
*
958+
* Este endpoint é utilizado para atualizar ou modificar uma recorrência existente a partir do identificador.
959+
*
960+
* Para capturar uma falha utilize o `catch`, o campo disponível será `mensagem`.
961+
*
962+
* @param { { identificador: string } } params
963+
* @param {{
964+
* periodicidade: string,
965+
* status: string,
966+
* envia_email: boolean,
967+
* comprimir_arquivos: boolean,
968+
* }} body
969+
*
970+
* @returns { Promise<void> }
971+
*/
972+
updateStatementRecurrency(params, body) {}
973+
974+
/**
975+
* **POST /v1/extrato-cnab/gerar-chaves**
976+
*
977+
* Gerar chave
978+
*
979+
* Este endpoint é utilizado para gerar uma chave associada a uma conta específica.
980+
*
981+
* Para capturar uma falha utilize o `catch`, o campo disponível será `mensagem`.
982+
*
983+
* @returns { Promise<{
984+
* privateKey: string
985+
* }>}
986+
*/
987+
createSftpKey() {}
988+
}
989+
990+
// @ts-nocheck
991+
class CobrancasMethods extends ExtratosMethods {
877992
/**
878993
* **POST /v1/charge/one-step**
879994
*
@@ -958,7 +1073,7 @@ class CobrancasMethods {
9581073
* email: string,
9591074
* phone_number?: string,
9601075
* birth?: string,
961-
* address: {
1076+
* address?: {
9621077
* street: string,
9631078
* number: string,
9641079
* neighborhood: string,
@@ -977,7 +1092,7 @@ class CobrancasMethods {
9771092
* type: 'percentage' | 'currency',
9781093
* value: number
9791094
* },
980-
* billing_address: {
1095+
* billing_address?: {
9811096
* street: string,
9821097
* number: string,
9831098
* neighborhood: string,
@@ -3498,13 +3613,13 @@ class PixMethods extends CobrancasMethods {
34983613
pixSend(params, body) {}
34993614

35003615
/**
3501-
* **GET /v2/gn/pix/enviados/:e2eId**
3616+
* **GET /v2/gn/pix/enviados/:e2eid**
35023617
*
35033618
* Consulta os dados de uma transferência Pix enviada.
35043619
*
35053620
* Para capturar uma falha utilize o `catch`, os campos disponíveis no objeto serão `type`, `title`, `status`, `detail` e dependendo da falha `violacoes`.
35063621
*
3507-
* @param { { e2eId: string } } params
3622+
* @param { { e2eid: string } } params
35083623
*
35093624
* @returns {Promise<{
35103625
* endToEndId: string,
@@ -3582,8 +3697,10 @@ class PixMethods extends CobrancasMethods {
35823697
* @param { {
35833698
* inicio: string,
35843699
* fim: string,
3585-
* status: string,
3586-
* devolucaoPresente: boolean
3700+
* status?: string,
3701+
* devolucaoPresente?: boolean,
3702+
* "paginacao.itensPorPagina"?: number,
3703+
* "paginacao.paginaAtual"?: number
35873704
* } } params
35883705
*
35893706
* @returns {Promise<Array<{
@@ -3719,7 +3836,9 @@ class PixMethods extends CobrancasMethods {
37193836
* txIdPresente?: boolean,
37203837
* devolucaoPresente?: boolean,
37213838
* cpf?: string,
3722-
* cnpj?: string
3839+
* cnpj?: string,
3840+
* "paginacao.itensPorPagina"?: number,
3841+
* "paginacao.paginaAtual"?: number
37233842
* } } params
37243843
*
37253844
* @returns {Promise<{
@@ -4802,6 +4921,37 @@ class PixMethods extends CobrancasMethods {
48024921
* } | string>}
48034922
*/
48044923
detailReport(params) {}
4924+
4925+
/**
4926+
* **POST /v2/gn/webhook/reenviar**
4927+
*
4928+
* Reenviar webhook Pix
4929+
*
4930+
* Endpoint que permite reenviar webhook pix.
4931+
*
4932+
* É possível solicitar o reenvio de Webhooks para transações que ocorreram a partir do dia 27/12 às 10:00 da manhã.
4933+
*
4934+
* O reenvio de webhook para uma transação fica disponível por um prazo máximo de 30 dias.
4935+
*
4936+
* A tentativa de reenvio ocorre uma vez para cada webhook, NÃO existe reagendamentos como ocorre no envio normal. Caso o servidor do cliente esteja inoperante, o cliente terá que solicitar novamente o reenvio.
4937+
*
4938+
* Nos casos de webhooks de devoluções (recebimento e envio) ocorre o reenvio de um webhook com todo o array de devolução ao invés de um webhook por devolução. Por exemplo, se você realizar duas devoluções relacionadas a um mesmo endToEndId, no envio, você receberá dois webhooks distintos. Porém, ao solicitar o reenvio, receberá apenas um webhook.
4939+
*
4940+
*
4941+
* Para capturar uma falha utilize o `catch`, os campos disponíveis no objeto serão `type`, `title`, `status`, `detail` e dependendo da falha `violacoes`.
4942+
*
4943+
* Obs: Se o extrato ainda não tiver sido processado, a resposta será sucesso(202) e o retorno será semelhante ao que é retornado na solicitação, informando em qual etapa de processamento está a solicitação.
4944+
*
4945+
* @param { {} } params
4946+
* @param { {
4947+
* tipo: 'PIX_RECEBIDO' | 'PIX_ENVIADO' | 'DEVOLUCAO_RECEBIDA' | 'DEVOLUCAO_ENVIADA',
4948+
* e2eids: Array<string>
4949+
* } } body
4950+
*
4951+
* @returns { Promise<void> }
4952+
*
4953+
*/
4954+
pixResendWebhook(params, body) {}
48054955
}
48064956

48074957
// @ts-nocheck

0 commit comments

Comments
 (0)