Skip to content

Commit 46d4345

Browse files
🐛 📚 Release 1.2.3
Corrigido a tipagem dos métodos pixCreateImmediateCharge e pixCreateCharge Algumas mudanças na descrição dos métodos da API Pix
1 parent bfddb6f commit 46d4345

File tree

6 files changed

+164
-164
lines changed

6 files changed

+164
-164
lines changed

dist/cjs/index.cjs

Lines changed: 40 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -579,7 +579,7 @@ var exports$1 = {
579579
}
580580
};
581581
var description = "Module for integration with Efi Bank API";
582-
var version = "1.2.2";
582+
var version = "1.2.3";
583583
var deprecated = "Este pacote será descontinuado. Use o 'sdk-node-apis-efi' no lugar.";
584584
var author = "Efi Bank - Consultoria Técnica | João Vitor Oliveira | João Lucas";
585585
var license = "MIT";
@@ -2819,7 +2819,7 @@ class PixMethods extends CobrancasMethods {
28192819
/**
28202820
* **POST /v2/cob**
28212821
*
2822-
* Cria uma nova cobrança com vencimento.
2822+
* Cria uma cobrança imediata (sem txid)
28232823
*
28242824
* Para capturar uma falha utilize o `catch`, os campos disponíveis no objeto serão `nome` e `mensagem`.
28252825
*
@@ -2861,7 +2861,7 @@ class PixMethods extends CobrancasMethods {
28612861
* },
28622862
* location: string,
28632863
* status: string,
2864-
* devedor: {
2864+
* devedor?: {
28652865
* cpf?: string,
28662866
* cnpj?: string,
28672867
* nome: string
@@ -2879,7 +2879,7 @@ class PixMethods extends CobrancasMethods {
28792879
/**
28802880
* **PUT /v2/cob/:txid**
28812881
*
2882-
* Atualiza uma cobrança existente.
2882+
* Cria uma cobrança imediata (com txid)
28832883
*
28842884
* Para capturar uma falha utilize o `catch`, os campos disponíveis no objeto serão `nome` e `mensagem`.`
28852885
*
@@ -2888,7 +2888,7 @@ class PixMethods extends CobrancasMethods {
28882888
* calendario: {
28892889
* expiracao: number
28902890
* },
2891-
* devedor: {
2891+
* devedor?: {
28922892
* cpf?: string,
28932893
* cnpj?: string,
28942894
* nome: string
@@ -2921,7 +2921,7 @@ class PixMethods extends CobrancasMethods {
29212921
* },
29222922
* location: string,
29232923
* status: string,
2924-
* devedor: {
2924+
* devedor?: {
29252925
* cpf?: string,
29262926
* cnpj?: string,
29272927
* nome: string
@@ -2939,7 +2939,7 @@ class PixMethods extends CobrancasMethods {
29392939
/**
29402940
* PATCH /v2/cob/:txid
29412941
*
2942-
* Atualiza informações de uma cobrança existente baseada no TXID.
2942+
* Revisar cobrança. Apenas os campos fornecidos serão atualizados.
29432943
*
29442944
* Para capturar uma falha utilize o `catch`, os campos disponíveis no objeto serão `nome` e `mensagem`.
29452945
* @param { { txid: string } } params
@@ -2993,7 +2993,7 @@ class PixMethods extends CobrancasMethods {
29932993
/**
29942994
* GET /v2/cob/:txid
29952995
*
2996-
* Recupera informações de uma cobrança existente baseada no TXID.
2996+
* Recupera informações de uma cobrança existente baseada no txid.
29972997
*
29982998
* Para capturar uma falha utilize o `catch`, os campos disponíveis no objeto serão `nome` e `mensagem`.
29992999
*
@@ -3116,7 +3116,7 @@ class PixMethods extends CobrancasMethods {
31163116
/**
31173117
* **PUT /v2/cobv/:txid**
31183118
*
3119-
* Atualiza uma cobrança com vencimento existente.
3119+
* Cria uma cobrança com vencimento (CobV).
31203120
*
31213121
* Para capturar uma falha utilize o `catch`, os campos disponíveis no objeto serão `type`, `title`, `status`, `detail` e dependendo da falha `violacoes`.
31223122
*
@@ -3234,7 +3234,7 @@ class PixMethods extends CobrancasMethods {
32343234
/**
32353235
* **PATCH /v2/cobv/:txid**
32363236
*
3237-
* Atualiza parcialmente uma cobrança com vencimento existente. Apenas os campos fornecidos serão atualizados.
3237+
* Revisar cobrança com vencimento (CobV). Apenas os campos fornecidos serão atualizados.
32383238
*
32393239
* Para capturar uma falha utilize o `catch`, os campos disponíveis no objeto serão `type`, `title`, `status`, `detail` e dependendo da falha `violacoes`.
32403240
*
@@ -3349,7 +3349,7 @@ class PixMethods extends CobrancasMethods {
33493349
/**
33503350
* **GET /v2/cobv/:txid**
33513351
*
3352-
* Obtém os detalhes de uma cobrança com vencimento existente.
3352+
* Obtém os detalhes de uma cobrança com vencimento (CobV) existente.
33533353
*
33543354
* Para capturar uma falha utilize o `catch`, os campos disponíveis no objeto serão `type`, `title`, `status`, `detail` e dependendo da falha `violacoes`.
33553355
*
@@ -3398,7 +3398,7 @@ class PixMethods extends CobrancasMethods {
33983398
/**
33993399
* **GET /v2/cobv**
34003400
*
3401-
* Obtém uma lista de cobranças com vencimento.
3401+
* Obtém uma lista de cobranças com vencimento (CobV).
34023402
*
34033403
* Para capturar uma falha utilize o `catch`, os campos disponíveis no objeto serão `type`, `title`, `status`, `detail` e dependendo da falha `violacoes`.
34043404
*
@@ -3530,7 +3530,7 @@ class PixMethods extends CobrancasMethods {
35303530
/**
35313531
* **GET /v2/gn/pix/enviados/:e2eId**
35323532
*
3533-
* Consulta os dados de uma transferência PIX enviada.
3533+
* Consulta os dados de uma transferência Pix enviada.
35343534
*
35353535
* Para capturar uma falha utilize o `catch`, os campos disponíveis no objeto serão `type`, `title`, `status`, `detail` e dependendo da falha `violacoes`.
35363536
*
@@ -3568,7 +3568,7 @@ class PixMethods extends CobrancasMethods {
35683568
/**
35693569
* **GET /v2/gn/pix/enviados/id-envio/:idEnvio**
35703570
*
3571-
* Consulta os dados de uma transferência PIX enviada pelo identificador de envio.
3571+
* Consulta os dados de uma transferência Pix enviada pelo identificador de envio.
35723572
*
35733573
* Para capturar uma falha utilize o `catch`, os campos disponíveis no objeto serão `type`, `title`, `status`, `detail` e dependendo da falha `violacoes`.
35743574
*
@@ -3605,7 +3605,7 @@ class PixMethods extends CobrancasMethods {
36053605
/**
36063606
* **GET /v2/gn/pix/enviados**
36073607
*
3608-
* Consulta as transferências PIX enviadas.
3608+
* Consulta as transferências Pix enviadas.
36093609
*
36103610
* Para capturar uma falha utilize o `catch`, os campos disponíveis no objeto serão `type`, `title`, `status`, `detail` e dependendo da falha `violacoes`.
36113611
*
@@ -3647,7 +3647,7 @@ class PixMethods extends CobrancasMethods {
36473647
/**
36483648
* **POST /v2/gn/qrcodes/detalhar**
36493649
*
3650-
* Detalha um QR Code PIX.
3650+
* Detalha um QR Code Pix.
36513651
*
36523652
* Para capturar uma falha utilize o `catch`, os campos disponíveis no objeto serão `type`, `title`, `status`, `detail` e dependendo da falha `violacoes`.
36533653
*
@@ -3786,7 +3786,7 @@ class PixMethods extends CobrancasMethods {
37863786
/**
37873787
* **PUT /v2/pix/:e2eId/devolucao/:id**
37883788
*
3789-
* Solicita a devolução de um pagamento Pix.
3789+
* Realiza a devolução de um pagamento Pix recebido.
37903790
*
37913791
* Para capturar uma falha utilize o `catch`, os campos disponíveis no objeto serão `nome` e `mensagem`.
37923792
*
@@ -3851,7 +3851,7 @@ class PixMethods extends CobrancasMethods {
38513851
/**
38523852
* **GET /v2/loc**
38533853
*
3854-
* Retorna uma lista de localizações (locations) de QR Codes.
3854+
* Retorna uma lista de location de QR Codes.
38553855
*
38563856
* Para capturar uma falha utilize o `catch`, os campos disponíveis no objeto serão `nome` e `mensagem`
38573857
*
@@ -3885,7 +3885,7 @@ class PixMethods extends CobrancasMethods {
38853885
/**
38863886
* **GET /v2/loc/:id**
38873887
*
3888-
* Retorna os detalhes de uma localização (location) específica de QR Code.
3888+
* Retorna os detalhes de um location específico de QR Code.
38893889
*
38903890
* Para capturar uma falha utilize o `catch`, os campos disponíveis no objeto serão `nome` e `mensagem`
38913891
*
@@ -3904,7 +3904,7 @@ class PixMethods extends CobrancasMethods {
39043904
/**
39053905
* **GET /v2/loc/:id/qrcode**
39063906
*
3907-
* Retorna os detalhes do QR Code de uma localização (location) específica de QR Code.
3907+
* Retorna os detalhes do QR Code de um location específico
39083908
*
39093909
* Para capturar uma falha utilize o `catch`, os campos disponíveis no objeto serão `nome` e `mensagem`
39103910
*
@@ -3921,7 +3921,7 @@ class PixMethods extends CobrancasMethods {
39213921
/**
39223922
* **DELETE /v2/loc/:id/txid**
39233923
*
3924-
* Remove o txid associado a uma localização (location) específica de QR Code.
3924+
* Remove o txid associado a um location específica.
39253925
*
39263926
* Para capturar uma falha utilize o `catch`, os campos disponíveis no objeto serão `nome` e `mensagem`
39273927
*
@@ -3939,7 +3939,7 @@ class PixMethods extends CobrancasMethods {
39393939
/**
39403940
* **PUT /v2/lotecobv/:id**
39413941
*
3942-
* Atualiza um lote de cobranças com vencimento (cobranças registradas).
3942+
* Cria/Altera um lote de cobranças com vencimento (CobV).
39433943
*
39443944
* Para capturar uma falha utilize o `catch`, os campos disponíveis no objeto serão `nome` e `mensagem`.
39453945
*
@@ -4030,7 +4030,7 @@ class PixMethods extends CobrancasMethods {
40304030
/**
40314031
* **PATCH /v2/lotecobv/:id**
40324032
*
4033-
* Atualiza parcialmente um lote de cobranças com vencimento.
4033+
* Revisar cobranças específicas de um lote.
40344034
*
40354035
* Para capturar uma falha utilize o `catch`, os campos disponíveis no objeto serão `nome` e `mensagem`.
40364036
*
@@ -4089,7 +4089,7 @@ class PixMethods extends CobrancasMethods {
40894089
/**
40904090
* **GET /v2/lotecobv/:id**
40914091
*
4092-
* Obtém informações sobre um lote de cobranças com vencimento.
4092+
* Obtém informações sobre um lote de cobranças com vencimento (CobV).
40934093
*
40944094
* Para capturar uma falha utilize o `catch`, os campos disponíveis no objeto serão `nome` e `mensagem`.
40954095
*
@@ -4122,7 +4122,7 @@ class PixMethods extends CobrancasMethods {
41224122
/**
41234123
* **GET /v2/lotecobv**
41244124
*
4125-
* Obtém uma lista de cobranças com vencimento.
4125+
* Obtém uma lista de cobranças com vencimento (CobV).
41264126
*
41274127
* Para capturar uma falha utilize o `catch`, os campos disponíveis no objeto serão `nome` e `mensagem`.
41284128
*
@@ -4159,7 +4159,7 @@ class PixMethods extends CobrancasMethods {
41594159
/**
41604160
* **POST /v2/gn/split/config**
41614161
*
4162-
* Configura a divisão de recebíveis (split).
4162+
* Cria uma configuração split de recebimentos (sem passar id)
41634163
*
41644164
* Para capturar uma falha utilize o `catch`, os campos disponíveis no objeto serão `type`, `title`, `status`, `detail` e dependendo da falha `violacoes`.
41654165
*
@@ -4220,7 +4220,7 @@ class PixMethods extends CobrancasMethods {
42204220
/**
42214221
* **PUT /v2/gn/split/config/:id**
42224222
*
4223-
* Atualiza a configuração de divisão de recebíveis (split).
4223+
* Cria/Atualiza uma configuração split de recebimentos (com id)
42244224
*
42254225
* Para capturar uma falha utilize o `catch`, os campos disponíveis no objeto serão `type`, `title`, `status`, `detail` e dependendo da falha `violacoes`.
42264226
*
@@ -4281,7 +4281,7 @@ class PixMethods extends CobrancasMethods {
42814281
/**
42824282
* **GET /v2/gn/split/config/:id**
42834283
*
4284-
* Obtém a configuração de divisão de recebíveis (split).
4284+
* Consulta uma configuração do Split pelo id
42854285
*
42864286
* Para capturar uma falha utilize o `catch`, os campos disponíveis no objeto serão `type`, `title`, `status`, `detail` e dependendo da falha `violacoes`.
42874287
*
@@ -4319,7 +4319,7 @@ class PixMethods extends CobrancasMethods {
43194319
/**
43204320
* **PUT /v2/gn/split/cob/:txid/vinculo/:splitConfigId**
43214321
*
4322-
* Vincula uma configuração de divisão de recebíveis (split) a uma cobrança Pix existente.
4322+
* Vincula uma cobrança a um Split de pagamento
43234323
*
43244324
* Para capturar uma falha utilize o `catch`, os campos disponíveis no objeto serão `type`, `title`, `status`, `detail` e dependendo da falha `violacoes`.
43254325
*
@@ -4332,7 +4332,7 @@ class PixMethods extends CobrancasMethods {
43324332
/**
43334333
* **PUT /v2/gn/split/cobv/:txid/vinculo/:splitConfigId**
43344334
*
4335-
* Vincula uma configuração de divisão de recebíveis (split) a uma cobrança com vencimento Pix existente.
4335+
* Vincula uma cobrança com vencimento (CobV) a um Split de pagamento
43364336
*
43374337
* Para capturar uma falha utilize o `catch`, os campos disponíveis no objeto serão `type`, `title`, `status`, `detail` e dependendo da falha `violacoes`.
43384338
*
@@ -4345,7 +4345,7 @@ class PixMethods extends CobrancasMethods {
43454345
/**
43464346
* **DELETE /v2/gn/split/cob/:txid/vinculo**
43474347
*
4348-
* Remove o vínculo de uma configuração de divisão de recebíveis (split) de uma cobrança Pix existente.
4348+
* Deleta o vínculo entre um Split de pagamento e uma cobrança
43494349
*
43504350
* Para capturar uma falha utilize o `catch`, os campos disponíveis no objeto serão `type`, `title`, `status`, `detail` e dependendo da falha `violacoes`.
43514351
*
@@ -4358,7 +4358,7 @@ class PixMethods extends CobrancasMethods {
43584358
/**
43594359
* **DELETE /v2/gn/split/cobv/:txid/vinculo**
43604360
*
4361-
* Remove o vínculo de uma configuração de divisão de recebíveis (split) de uma cobrança com vencimento Pix existente.
4361+
* Deleta o vínculo entre um Split de pagamento e uma cobrança com vencimento (CobV).
43624362
*
43634363
* Para capturar uma falha utilize o `catch`, os campos disponíveis no objeto serão `type`, `title`, `status`, `detail` e dependendo da falha `violacoes`.
43644364
*
@@ -4417,7 +4417,7 @@ class PixMethods extends CobrancasMethods {
44174417
/**
44184418
* **GET /v2/gn/split/cobv/:txid**
44194419
*
4420-
* Obtém os detalhes de uma cobrança com vencimento Pix (cobv) vinculada a uma configuração de divisão de recebíveis (split).
4420+
* Obtém os detalhes de uma cobrança com vencimento Pix (CobV) vinculada a uma configuração de divisão de recebíveis (split).
44214421
*
44224422
* Para capturar uma falha utilize o `catch`, os campos disponíveis no objeto serão `type`, `title`, `status`, `detail` e dependendo da falha `violacoes`.
44234423
*
@@ -4473,7 +4473,7 @@ class PixMethods extends CobrancasMethods {
44734473
/**
44744474
* **PUT /v2/webhook/:chave**
44754475
*
4476-
* Atualiza a URL do webhook associado à chave Pix.
4476+
* Configura a URL do webhook associado à chave Pix.
44774477
*
44784478
* Para capturar uma falha utilize o `catch`, os campos disponíveis no objeto serão `nome` e `mensagem`.
44794479
*
@@ -4566,7 +4566,7 @@ class PixMethods extends CobrancasMethods {
45664566
/**
45674567
* **GET /v2/gn/evp**
45684568
*
4569-
* Recupera todas as chaves EVP (Endereço Virtual de Pagamento).
4569+
* Recupera todas as chaves EVP.
45704570
*
45714571
* Para capturar uma falha utilize o `catch`, os campos disponíveis no objeto serão `nome` e `mensagem`.
45724572
*
@@ -4579,7 +4579,7 @@ class PixMethods extends CobrancasMethods {
45794579
/**
45804580
* **DELETE /v2/gn/evp/:chave**
45814581
*
4582-
* Deleta uma chave EVP (Endereço Virtual de Pagamento) específica.
4582+
* Deleta uma chave EVP específica.
45834583
*
45844584
* Para capturar uma falha utilize o `catch`, os campos disponíveis no objeto serão `nome` e `mensagem`.
45854585
*
@@ -4610,7 +4610,7 @@ class PixMethods extends CobrancasMethods {
46104610
/**
46114611
* **PUT /v2/gn/config**
46124612
*
4613-
* Configurações para recebimento e envio de PIX.
4613+
* Cria/modifica as configurações da conta.
46144614
*
46154615
* Para capturar uma falha utilize o `catch`, os campos disponíveis no objeto serão `nome` e `mensagem`.
46164616
*
@@ -4654,7 +4654,7 @@ class PixMethods extends CobrancasMethods {
46544654
/**
46554655
* **GET /v2/gn/config**
46564656
*
4657-
* Obtém as configurações para recebimento e envio de PIX.
4657+
* Lista as configurações da conta
46584658
*
46594659
* Para capturar uma falha utilize o `catch`, os campos disponíveis no objeto serão `nome` e `mensagem`.
46604660
*
@@ -4695,7 +4695,7 @@ class PixMethods extends CobrancasMethods {
46954695
/**
46964696
* **GET /v2/gn/infracoes**
46974697
*
4698-
* Obtém a lista de infrações no sistema.
4698+
* Lista as infrações MED da conta
46994699
*
47004700
* Para capturar uma falha utilize o `catch`, os campos disponíveis no objeto serão `type`, `title`, `status`, `detail` e dependendo da falha `violacoes`.
47014701
*
@@ -4758,7 +4758,7 @@ class PixMethods extends CobrancasMethods {
47584758
/**
47594759
* **POST /v2/gn/infracoes/:idInfracao/defesa**
47604760
*
4761-
* Envia a defesa para uma infração específica.
4761+
* Submete uma defesa de infração MED
47624762
*
47634763
* Para capturar uma falha utilize o `catch`, os campos disponíveis no objeto serão `type`, `title`, `status`, `detail` e dependendo da falha `violacoes`.
47644764
*

0 commit comments

Comments
 (0)