You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: dist/cjs/index.cjs
+40-40Lines changed: 40 additions & 40 deletions
Original file line number
Diff line number
Diff line change
@@ -579,7 +579,7 @@ var exports$1 = {
579
579
}
580
580
};
581
581
vardescription="Module for integration with Efi Bank API";
582
-
varversion="1.2.2";
582
+
varversion="1.2.3";
583
583
vardeprecated="Este pacote será descontinuado. Use o 'sdk-node-apis-efi' no lugar.";
584
584
varauthor="Efi Bank - Consultoria Técnica | João Vitor Oliveira | João Lucas";
585
585
varlicense="MIT";
@@ -2819,7 +2819,7 @@ class PixMethods extends CobrancasMethods {
2819
2819
/**
2820
2820
* **POST /v2/cob**
2821
2821
*
2822
-
* Cria uma nova cobrança com vencimento.
2822
+
* Cria uma cobrança imediata (sem txid)
2823
2823
*
2824
2824
* Para capturar uma falha utilize o `catch`, os campos disponíveis no objeto serão `nome` e `mensagem`.
2825
2825
*
@@ -2861,7 +2861,7 @@ class PixMethods extends CobrancasMethods {
2861
2861
* },
2862
2862
* location: string,
2863
2863
* status: string,
2864
-
* devedor: {
2864
+
* devedor?: {
2865
2865
* cpf?: string,
2866
2866
* cnpj?: string,
2867
2867
* nome: string
@@ -2879,7 +2879,7 @@ class PixMethods extends CobrancasMethods {
2879
2879
/**
2880
2880
* **PUT /v2/cob/:txid**
2881
2881
*
2882
-
* Atualiza uma cobrança existente.
2882
+
* Cria uma cobrança imediata (com txid)
2883
2883
*
2884
2884
* Para capturar uma falha utilize o `catch`, os campos disponíveis no objeto serão `nome` e `mensagem`.`
2885
2885
*
@@ -2888,7 +2888,7 @@ class PixMethods extends CobrancasMethods {
2888
2888
* calendario: {
2889
2889
* expiracao: number
2890
2890
* },
2891
-
* devedor: {
2891
+
* devedor?: {
2892
2892
* cpf?: string,
2893
2893
* cnpj?: string,
2894
2894
* nome: string
@@ -2921,7 +2921,7 @@ class PixMethods extends CobrancasMethods {
2921
2921
* },
2922
2922
* location: string,
2923
2923
* status: string,
2924
-
* devedor: {
2924
+
* devedor?: {
2925
2925
* cpf?: string,
2926
2926
* cnpj?: string,
2927
2927
* nome: string
@@ -2939,7 +2939,7 @@ class PixMethods extends CobrancasMethods {
2939
2939
/**
2940
2940
* PATCH /v2/cob/:txid
2941
2941
*
2942
-
* Atualiza informações de uma cobrança existente baseada no TXID.
2942
+
* Revisar cobrança. Apenas os campos fornecidos serão atualizados.
2943
2943
*
2944
2944
* Para capturar uma falha utilize o `catch`, os campos disponíveis no objeto serão `nome` e `mensagem`.
2945
2945
* @param { { txid: string } } params
@@ -2993,7 +2993,7 @@ class PixMethods extends CobrancasMethods {
2993
2993
/**
2994
2994
* GET /v2/cob/:txid
2995
2995
*
2996
-
* Recupera informações de uma cobrança existente baseada no TXID.
2996
+
* Recupera informações de uma cobrança existente baseada no txid.
2997
2997
*
2998
2998
* Para capturar uma falha utilize o `catch`, os campos disponíveis no objeto serão `nome` e `mensagem`.
2999
2999
*
@@ -3116,7 +3116,7 @@ class PixMethods extends CobrancasMethods {
3116
3116
/**
3117
3117
* **PUT /v2/cobv/:txid**
3118
3118
*
3119
-
* Atualiza uma cobrança com vencimento existente.
3119
+
* Cria uma cobrança com vencimento (CobV).
3120
3120
*
3121
3121
* Para capturar uma falha utilize o `catch`, os campos disponíveis no objeto serão `type`, `title`, `status`, `detail` e dependendo da falha `violacoes`.
3122
3122
*
@@ -3234,7 +3234,7 @@ class PixMethods extends CobrancasMethods {
3234
3234
/**
3235
3235
* **PATCH /v2/cobv/:txid**
3236
3236
*
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.
3238
3238
*
3239
3239
* Para capturar uma falha utilize o `catch`, os campos disponíveis no objeto serão `type`, `title`, `status`, `detail` e dependendo da falha `violacoes`.
3240
3240
*
@@ -3349,7 +3349,7 @@ class PixMethods extends CobrancasMethods {
3349
3349
/**
3350
3350
* **GET /v2/cobv/:txid**
3351
3351
*
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.
3353
3353
*
3354
3354
* Para capturar uma falha utilize o `catch`, os campos disponíveis no objeto serão `type`, `title`, `status`, `detail` e dependendo da falha `violacoes`.
3355
3355
*
@@ -3398,7 +3398,7 @@ class PixMethods extends CobrancasMethods {
3398
3398
/**
3399
3399
* **GET /v2/cobv**
3400
3400
*
3401
-
* Obtém uma lista de cobranças com vencimento.
3401
+
* Obtém uma lista de cobranças com vencimento (CobV).
3402
3402
*
3403
3403
* Para capturar uma falha utilize o `catch`, os campos disponíveis no objeto serão `type`, `title`, `status`, `detail` e dependendo da falha `violacoes`.
3404
3404
*
@@ -3530,7 +3530,7 @@ class PixMethods extends CobrancasMethods {
3530
3530
/**
3531
3531
* **GET /v2/gn/pix/enviados/:e2eId**
3532
3532
*
3533
-
* Consulta os dados de uma transferência PIX enviada.
3533
+
* Consulta os dados de uma transferência Pix enviada.
3534
3534
*
3535
3535
* Para capturar uma falha utilize o `catch`, os campos disponíveis no objeto serão `type`, `title`, `status`, `detail` e dependendo da falha `violacoes`.
3536
3536
*
@@ -3568,7 +3568,7 @@ class PixMethods extends CobrancasMethods {
3568
3568
/**
3569
3569
* **GET /v2/gn/pix/enviados/id-envio/:idEnvio**
3570
3570
*
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.
3572
3572
*
3573
3573
* Para capturar uma falha utilize o `catch`, os campos disponíveis no objeto serão `type`, `title`, `status`, `detail` e dependendo da falha `violacoes`.
3574
3574
*
@@ -3605,7 +3605,7 @@ class PixMethods extends CobrancasMethods {
3605
3605
/**
3606
3606
* **GET /v2/gn/pix/enviados**
3607
3607
*
3608
-
* Consulta as transferências PIX enviadas.
3608
+
* Consulta as transferências Pix enviadas.
3609
3609
*
3610
3610
* Para capturar uma falha utilize o `catch`, os campos disponíveis no objeto serão `type`, `title`, `status`, `detail` e dependendo da falha `violacoes`.
3611
3611
*
@@ -3647,7 +3647,7 @@ class PixMethods extends CobrancasMethods {
3647
3647
/**
3648
3648
* **POST /v2/gn/qrcodes/detalhar**
3649
3649
*
3650
-
* Detalha um QR Code PIX.
3650
+
* Detalha um QR Code Pix.
3651
3651
*
3652
3652
* Para capturar uma falha utilize o `catch`, os campos disponíveis no objeto serão `type`, `title`, `status`, `detail` e dependendo da falha `violacoes`.
3653
3653
*
@@ -3786,7 +3786,7 @@ class PixMethods extends CobrancasMethods {
3786
3786
/**
3787
3787
* **PUT /v2/pix/:e2eId/devolucao/:id**
3788
3788
*
3789
-
* Solicita a devolução de um pagamento Pix.
3789
+
* Realiza a devolução de um pagamento Pix recebido.
3790
3790
*
3791
3791
* Para capturar uma falha utilize o `catch`, os campos disponíveis no objeto serão `nome` e `mensagem`.
3792
3792
*
@@ -3851,7 +3851,7 @@ class PixMethods extends CobrancasMethods {
3851
3851
/**
3852
3852
* **GET /v2/loc**
3853
3853
*
3854
-
* Retorna uma lista de localizações (locations) de QR Codes.
3854
+
* Retorna uma lista de location de QR Codes.
3855
3855
*
3856
3856
* Para capturar uma falha utilize o `catch`, os campos disponíveis no objeto serão `nome` e `mensagem`
3857
3857
*
@@ -3885,7 +3885,7 @@ class PixMethods extends CobrancasMethods {
3885
3885
/**
3886
3886
* **GET /v2/loc/:id**
3887
3887
*
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.
3889
3889
*
3890
3890
* Para capturar uma falha utilize o `catch`, os campos disponíveis no objeto serão `nome` e `mensagem`
3891
3891
*
@@ -3904,7 +3904,7 @@ class PixMethods extends CobrancasMethods {
3904
3904
/**
3905
3905
* **GET /v2/loc/:id/qrcode**
3906
3906
*
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
3908
3908
*
3909
3909
* Para capturar uma falha utilize o `catch`, os campos disponíveis no objeto serão `nome` e `mensagem`
3910
3910
*
@@ -3921,7 +3921,7 @@ class PixMethods extends CobrancasMethods {
3921
3921
/**
3922
3922
* **DELETE /v2/loc/:id/txid**
3923
3923
*
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.
3925
3925
*
3926
3926
* Para capturar uma falha utilize o `catch`, os campos disponíveis no objeto serão `nome` e `mensagem`
3927
3927
*
@@ -3939,7 +3939,7 @@ class PixMethods extends CobrancasMethods {
3939
3939
/**
3940
3940
* **PUT /v2/lotecobv/:id**
3941
3941
*
3942
-
* Atualiza um lote de cobranças com vencimento (cobranças registradas).
3942
+
* Cria/Altera um lote de cobranças com vencimento (CobV).
3943
3943
*
3944
3944
* Para capturar uma falha utilize o `catch`, os campos disponíveis no objeto serão `nome` e `mensagem`.
3945
3945
*
@@ -4030,7 +4030,7 @@ class PixMethods extends CobrancasMethods {
4030
4030
/**
4031
4031
* **PATCH /v2/lotecobv/:id**
4032
4032
*
4033
-
* Atualiza parcialmente um lote de cobranças com vencimento.
4033
+
* Revisar cobranças específicas de um lote.
4034
4034
*
4035
4035
* Para capturar uma falha utilize o `catch`, os campos disponíveis no objeto serão `nome` e `mensagem`.
4036
4036
*
@@ -4089,7 +4089,7 @@ class PixMethods extends CobrancasMethods {
4089
4089
/**
4090
4090
* **GET /v2/lotecobv/:id**
4091
4091
*
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).
4093
4093
*
4094
4094
* Para capturar uma falha utilize o `catch`, os campos disponíveis no objeto serão `nome` e `mensagem`.
4095
4095
*
@@ -4122,7 +4122,7 @@ class PixMethods extends CobrancasMethods {
4122
4122
/**
4123
4123
* **GET /v2/lotecobv**
4124
4124
*
4125
-
* Obtém uma lista de cobranças com vencimento.
4125
+
* Obtém uma lista de cobranças com vencimento (CobV).
4126
4126
*
4127
4127
* Para capturar uma falha utilize o `catch`, os campos disponíveis no objeto serão `nome` e `mensagem`.
4128
4128
*
@@ -4159,7 +4159,7 @@ class PixMethods extends CobrancasMethods {
4159
4159
/**
4160
4160
* **POST /v2/gn/split/config**
4161
4161
*
4162
-
* Configura a divisão de recebíveis (split).
4162
+
* Cria uma configuração split de recebimentos (sem passar id)
4163
4163
*
4164
4164
* Para capturar uma falha utilize o `catch`, os campos disponíveis no objeto serão `type`, `title`, `status`, `detail` e dependendo da falha `violacoes`.
4165
4165
*
@@ -4220,7 +4220,7 @@ class PixMethods extends CobrancasMethods {
4220
4220
/**
4221
4221
* **PUT /v2/gn/split/config/:id**
4222
4222
*
4223
-
* Atualiza a configuração de divisão de recebíveis (split).
4223
+
* Cria/Atualiza uma configuração split de recebimentos (com id)
4224
4224
*
4225
4225
* Para capturar uma falha utilize o `catch`, os campos disponíveis no objeto serão `type`, `title`, `status`, `detail` e dependendo da falha `violacoes`.
4226
4226
*
@@ -4281,7 +4281,7 @@ class PixMethods extends CobrancasMethods {
4281
4281
/**
4282
4282
* **GET /v2/gn/split/config/:id**
4283
4283
*
4284
-
* Obtém a configuração de divisão de recebíveis (split).
4284
+
* Consulta uma configuração do Split pelo id
4285
4285
*
4286
4286
* Para capturar uma falha utilize o `catch`, os campos disponíveis no objeto serão `type`, `title`, `status`, `detail` e dependendo da falha `violacoes`.
4287
4287
*
@@ -4319,7 +4319,7 @@ class PixMethods extends CobrancasMethods {
* 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
4323
4323
*
4324
4324
* Para capturar uma falha utilize o `catch`, os campos disponíveis no objeto serão `type`, `title`, `status`, `detail` e dependendo da falha `violacoes`.
4325
4325
*
@@ -4332,7 +4332,7 @@ class PixMethods extends CobrancasMethods {
* 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
4336
4336
*
4337
4337
* Para capturar uma falha utilize o `catch`, os campos disponíveis no objeto serão `type`, `title`, `status`, `detail` e dependendo da falha `violacoes`.
4338
4338
*
@@ -4345,7 +4345,7 @@ class PixMethods extends CobrancasMethods {
4345
4345
/**
4346
4346
* **DELETE /v2/gn/split/cob/:txid/vinculo**
4347
4347
*
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
4349
4349
*
4350
4350
* Para capturar uma falha utilize o `catch`, os campos disponíveis no objeto serão `type`, `title`, `status`, `detail` e dependendo da falha `violacoes`.
4351
4351
*
@@ -4358,7 +4358,7 @@ class PixMethods extends CobrancasMethods {
4358
4358
/**
4359
4359
* **DELETE /v2/gn/split/cobv/:txid/vinculo**
4360
4360
*
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).
4362
4362
*
4363
4363
* Para capturar uma falha utilize o `catch`, os campos disponíveis no objeto serão `type`, `title`, `status`, `detail` e dependendo da falha `violacoes`.
4364
4364
*
@@ -4417,7 +4417,7 @@ class PixMethods extends CobrancasMethods {
4417
4417
/**
4418
4418
* **GET /v2/gn/split/cobv/:txid**
4419
4419
*
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).
4421
4421
*
4422
4422
* Para capturar uma falha utilize o `catch`, os campos disponíveis no objeto serão `type`, `title`, `status`, `detail` e dependendo da falha `violacoes`.
4423
4423
*
@@ -4473,7 +4473,7 @@ class PixMethods extends CobrancasMethods {
4473
4473
/**
4474
4474
* **PUT /v2/webhook/:chave**
4475
4475
*
4476
-
* Atualiza a URL do webhook associado à chave Pix.
4476
+
* Configura a URL do webhook associado à chave Pix.
4477
4477
*
4478
4478
* Para capturar uma falha utilize o `catch`, os campos disponíveis no objeto serão `nome` e `mensagem`.
4479
4479
*
@@ -4566,7 +4566,7 @@ class PixMethods extends CobrancasMethods {
4566
4566
/**
4567
4567
* **GET /v2/gn/evp**
4568
4568
*
4569
-
* Recupera todas as chaves EVP (Endereço Virtual de Pagamento).
4569
+
* Recupera todas as chaves EVP.
4570
4570
*
4571
4571
* Para capturar uma falha utilize o `catch`, os campos disponíveis no objeto serão `nome` e `mensagem`.
4572
4572
*
@@ -4579,7 +4579,7 @@ class PixMethods extends CobrancasMethods {
4579
4579
/**
4580
4580
* **DELETE /v2/gn/evp/:chave**
4581
4581
*
4582
-
* Deleta uma chave EVP (Endereço Virtual de Pagamento) específica.
4582
+
* Deleta uma chave EVP específica.
4583
4583
*
4584
4584
* Para capturar uma falha utilize o `catch`, os campos disponíveis no objeto serão `nome` e `mensagem`.
4585
4585
*
@@ -4610,7 +4610,7 @@ class PixMethods extends CobrancasMethods {
4610
4610
/**
4611
4611
* **PUT /v2/gn/config**
4612
4612
*
4613
-
* Configurações para recebimento e envio de PIX.
4613
+
* Cria/modifica as configurações da conta.
4614
4614
*
4615
4615
* Para capturar uma falha utilize o `catch`, os campos disponíveis no objeto serão `nome` e `mensagem`.
4616
4616
*
@@ -4654,7 +4654,7 @@ class PixMethods extends CobrancasMethods {
4654
4654
/**
4655
4655
* **GET /v2/gn/config**
4656
4656
*
4657
-
* Obtém as configurações para recebimento e envio de PIX.
4657
+
* Lista as configurações da conta
4658
4658
*
4659
4659
* Para capturar uma falha utilize o `catch`, os campos disponíveis no objeto serão `nome` e `mensagem`.
4660
4660
*
@@ -4695,7 +4695,7 @@ class PixMethods extends CobrancasMethods {
4695
4695
/**
4696
4696
* **GET /v2/gn/infracoes**
4697
4697
*
4698
-
* Obtém a lista de infrações no sistema.
4698
+
* Lista as infrações MED da conta
4699
4699
*
4700
4700
* Para capturar uma falha utilize o `catch`, os campos disponíveis no objeto serão `type`, `title`, `status`, `detail` e dependendo da falha `violacoes`.
4701
4701
*
@@ -4758,7 +4758,7 @@ class PixMethods extends CobrancasMethods {
4758
4758
/**
4759
4759
* **POST /v2/gn/infracoes/:idInfracao/defesa**
4760
4760
*
4761
-
* Envia a defesa para uma infração específica.
4761
+
* Submete uma defesa de infração MED
4762
4762
*
4763
4763
* Para capturar uma falha utilize o `catch`, os campos disponíveis no objeto serão `type`, `title`, `status`, `detail` e dependendo da falha `violacoes`.
0 commit comments