Skip to content

Commit

Permalink
🐛 📚 Release 1.2.8
Browse files Browse the repository at this point in the history 
Corrigido a tipagem dos métodos pixCreateImmediateCharge e pixCreateCharge
Algumas mudanças na descrição dos métodos da API Pix
  • Loading branch information
@joao-muniz-efi
joao-muniz-efi committed Oct 1, 2024
1 parent 054319d commit 6a1ccff
Show file tree
Hide file tree
Showing 6 changed files with 164 additions and 164 deletions.
80 changes: 40 additions & 40 deletions dist/cjs/index.cjs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -579,7 +579,7 @@ var exports$1 = {
}
};
var description = "Module for integration with Efi Bank API";
var version = "1.2.7";
var version = "1.2.8";
var author = "Efi Bank - Consultoria Técnica | João Vitor Oliveira | João Lucas";
var license = "MIT";
var repository = "efipay/sdk-node-apis-efi";
Expand Down Expand Up @@ -2783,7 +2783,7 @@ class PixMethods extends CobrancasMethods {
/**
* **POST /v2/cob**
*
* Cria uma nova cobrança com vencimento.
* Cria uma cobrança imediata (sem txid)
*
* Para capturar uma falha utilize o `catch`, os campos disponíveis no objeto serão `nome` e `mensagem`.
*
Expand Down Expand Up @@ -2825,7 +2825,7 @@ class PixMethods extends CobrancasMethods {
* },
* location: string,
* status: string,
* devedor: {
* devedor?: {
* cpf?: string,
* cnpj?: string,
* nome: string
Expand All @@ -2843,7 +2843,7 @@ class PixMethods extends CobrancasMethods {
/**
* **PUT /v2/cob/:txid**
*
* Atualiza uma cobrança existente.
* Cria uma cobrança imediata (com txid)
*
* Para capturar uma falha utilize o `catch`, os campos disponíveis no objeto serão `nome` e `mensagem`.`
*
Expand All @@ -2852,7 +2852,7 @@ class PixMethods extends CobrancasMethods {
* calendario: {
* expiracao: number
* },
* devedor: {
* devedor?: {
* cpf?: string,
* cnpj?: string,
* nome: string
Expand Down Expand Up @@ -2885,7 +2885,7 @@ class PixMethods extends CobrancasMethods {
* },
* location: string,
* status: string,
* devedor: {
* devedor?: {
* cpf?: string,
* cnpj?: string,
* nome: string
Expand All @@ -2903,7 +2903,7 @@ class PixMethods extends CobrancasMethods {
/**
* PATCH /v2/cob/:txid
*
* Atualiza informações de uma cobrança existente baseada no TXID.
* Revisar cobrança. Apenas os campos fornecidos serão atualizados.
*
* Para capturar uma falha utilize o `catch`, os campos disponíveis no objeto serão `nome` e `mensagem`.
* @param { { txid: string } } params
Expand Down Expand Up @@ -2957,7 +2957,7 @@ class PixMethods extends CobrancasMethods {
/**
* GET /v2/cob/:txid
*
* Recupera informações de uma cobrança existente baseada no TXID.
* Recupera informações de uma cobrança existente baseada no txid.
*
* Para capturar uma falha utilize o `catch`, os campos disponíveis no objeto serão `nome` e `mensagem`.
*
Expand Down Expand Up @@ -3080,7 +3080,7 @@ class PixMethods extends CobrancasMethods {
/**
* **PUT /v2/cobv/:txid**
*
* Atualiza uma cobrança com vencimento existente.
* Cria uma cobrança com vencimento (CobV).
*
* Para capturar uma falha utilize o `catch`, os campos disponíveis no objeto serão `type`, `title`, `status`, `detail` e dependendo da falha `violacoes`.
*
Expand Down Expand Up @@ -3198,7 +3198,7 @@ class PixMethods extends CobrancasMethods {
/**
* **PATCH /v2/cobv/:txid**
*
* Atualiza parcialmente uma cobrança com vencimento existente. Apenas os campos fornecidos serão atualizados.
* Revisar cobrança com vencimento (CobV). Apenas os campos fornecidos serão atualizados.
*
* Para capturar uma falha utilize o `catch`, os campos disponíveis no objeto serão `type`, `title`, `status`, `detail` e dependendo da falha `violacoes`.
*
Expand Down Expand Up @@ -3313,7 +3313,7 @@ class PixMethods extends CobrancasMethods {
/**
* **GET /v2/cobv/:txid**
*
* Obtém os detalhes de uma cobrança com vencimento existente.
* Obtém os detalhes de uma cobrança com vencimento (CobV) existente.
*
* Para capturar uma falha utilize o `catch`, os campos disponíveis no objeto serão `type`, `title`, `status`, `detail` e dependendo da falha `violacoes`.
*
Expand Down Expand Up @@ -3362,7 +3362,7 @@ class PixMethods extends CobrancasMethods {
/**
* **GET /v2/cobv**
*
* Obtém uma lista de cobranças com vencimento.
* Obtém uma lista de cobranças com vencimento (CobV).
*
* Para capturar uma falha utilize o `catch`, os campos disponíveis no objeto serão `type`, `title`, `status`, `detail` e dependendo da falha `violacoes`.
*
Expand Down Expand Up @@ -3494,7 +3494,7 @@ class PixMethods extends CobrancasMethods {
/**
* **GET /v2/gn/pix/enviados/:e2eId**
*
* Consulta os dados de uma transferência PIX enviada.
* Consulta os dados de uma transferência Pix enviada.
*
* Para capturar uma falha utilize o `catch`, os campos disponíveis no objeto serão `type`, `title`, `status`, `detail` e dependendo da falha `violacoes`.
*
Expand Down Expand Up @@ -3532,7 +3532,7 @@ class PixMethods extends CobrancasMethods {
/**
* **GET /v2/gn/pix/enviados/id-envio/:idEnvio**
*
* Consulta os dados de uma transferência PIX enviada pelo identificador de envio.
* Consulta os dados de uma transferência Pix enviada pelo identificador de envio.
*
* Para capturar uma falha utilize o `catch`, os campos disponíveis no objeto serão `type`, `title`, `status`, `detail` e dependendo da falha `violacoes`.
*
Expand Down Expand Up @@ -3569,7 +3569,7 @@ class PixMethods extends CobrancasMethods {
/**
* **GET /v2/gn/pix/enviados**
*
* Consulta as transferências PIX enviadas.
* Consulta as transferências Pix enviadas.
*
* Para capturar uma falha utilize o `catch`, os campos disponíveis no objeto serão `type`, `title`, `status`, `detail` e dependendo da falha `violacoes`.
*
Expand Down Expand Up @@ -3611,7 +3611,7 @@ class PixMethods extends CobrancasMethods {
/**
* **POST /v2/gn/qrcodes/detalhar**
*
* Detalha um QR Code PIX.
* Detalha um QR Code Pix.
*
* Para capturar uma falha utilize o `catch`, os campos disponíveis no objeto serão `type`, `title`, `status`, `detail` e dependendo da falha `violacoes`.
*
Expand Down Expand Up @@ -3750,7 +3750,7 @@ class PixMethods extends CobrancasMethods {
/**
* **PUT /v2/pix/:e2eId/devolucao/:id**
*
* Solicita a devolução de um pagamento Pix.
* Realiza a devolução de um pagamento Pix recebido.
*
* Para capturar uma falha utilize o `catch`, os campos disponíveis no objeto serão `nome` e `mensagem`.
*
Expand Down Expand Up @@ -3815,7 +3815,7 @@ class PixMethods extends CobrancasMethods {
/**
* **GET /v2/loc**
*
* Retorna uma lista de localizações (locations) de QR Codes.
* Retorna uma lista de location de QR Codes.
*
* Para capturar uma falha utilize o `catch`, os campos disponíveis no objeto serão `nome` e `mensagem`
*
Expand Down Expand Up @@ -3849,7 +3849,7 @@ class PixMethods extends CobrancasMethods {
/**
* **GET /v2/loc/:id**
*
* Retorna os detalhes de uma localização (location) específica de QR Code.
* Retorna os detalhes de um location específico de QR Code.
*
* Para capturar uma falha utilize o `catch`, os campos disponíveis no objeto serão `nome` e `mensagem`
*
Expand All @@ -3868,7 +3868,7 @@ class PixMethods extends CobrancasMethods {
/**
* **GET /v2/loc/:id/qrcode**
*
* Retorna os detalhes do QR Code de uma localização (location) específica de QR Code.
* Retorna os detalhes do QR Code de um location específico
*
* Para capturar uma falha utilize o `catch`, os campos disponíveis no objeto serão `nome` e `mensagem`
*
Expand All @@ -3885,7 +3885,7 @@ class PixMethods extends CobrancasMethods {
/**
* **DELETE /v2/loc/:id/txid**
*
* Remove o txid associado a uma localização (location) específica de QR Code.
* Remove o txid associado a um location específica.
*
* Para capturar uma falha utilize o `catch`, os campos disponíveis no objeto serão `nome` e `mensagem`
*
Expand All @@ -3903,7 +3903,7 @@ class PixMethods extends CobrancasMethods {
/**
* **PUT /v2/lotecobv/:id**
*
* Atualiza um lote de cobranças com vencimento (cobranças registradas).
* Cria/Altera um lote de cobranças com vencimento (CobV).
*
* Para capturar uma falha utilize o `catch`, os campos disponíveis no objeto serão `nome` e `mensagem`.
*
Expand Down Expand Up @@ -3994,7 +3994,7 @@ class PixMethods extends CobrancasMethods {
/**
* **PATCH /v2/lotecobv/:id**
*
* Atualiza parcialmente um lote de cobranças com vencimento.
* Revisar cobranças específicas de um lote.
*
* Para capturar uma falha utilize o `catch`, os campos disponíveis no objeto serão `nome` e `mensagem`.
*
Expand Down Expand Up @@ -4053,7 +4053,7 @@ class PixMethods extends CobrancasMethods {
/**
* **GET /v2/lotecobv/:id**
*
* Obtém informações sobre um lote de cobranças com vencimento.
* Obtém informações sobre um lote de cobranças com vencimento (CobV).
*
* Para capturar uma falha utilize o `catch`, os campos disponíveis no objeto serão `nome` e `mensagem`.
*
Expand Down Expand Up @@ -4086,7 +4086,7 @@ class PixMethods extends CobrancasMethods {
/**
* **GET /v2/lotecobv**
*
* Obtém uma lista de cobranças com vencimento.
* Obtém uma lista de cobranças com vencimento (CobV).
*
* Para capturar uma falha utilize o `catch`, os campos disponíveis no objeto serão `nome` e `mensagem`.
*
Expand Down Expand Up @@ -4123,7 +4123,7 @@ class PixMethods extends CobrancasMethods {
/**
* **POST /v2/gn/split/config**
*
* Configura a divisão de recebíveis (split).
* Cria uma configuração split de recebimentos (sem passar id)
*
* Para capturar uma falha utilize o `catch`, os campos disponíveis no objeto serão `type`, `title`, `status`, `detail` e dependendo da falha `violacoes`.
*
Expand Down Expand Up @@ -4184,7 +4184,7 @@ class PixMethods extends CobrancasMethods {
/**
* **PUT /v2/gn/split/config/:id**
*
* Atualiza a configuração de divisão de recebíveis (split).
* Cria/Atualiza uma configuração split de recebimentos (com id)
*
* Para capturar uma falha utilize o `catch`, os campos disponíveis no objeto serão `type`, `title`, `status`, `detail` e dependendo da falha `violacoes`.
*
Expand Down Expand Up @@ -4245,7 +4245,7 @@ class PixMethods extends CobrancasMethods {
/**
* **GET /v2/gn/split/config/:id**
*
* Obtém a configuração de divisão de recebíveis (split).
* Consulta uma configuração do Split pelo id
*
* Para capturar uma falha utilize o `catch`, os campos disponíveis no objeto serão `type`, `title`, `status`, `detail` e dependendo da falha `violacoes`.
*
Expand Down Expand Up @@ -4283,7 +4283,7 @@ class PixMethods extends CobrancasMethods {
/**
* **PUT /v2/gn/split/cob/:txid/vinculo/:splitConfigId**
*
* Vincula uma configuração de divisão de recebíveis (split) a uma cobrança Pix existente.
* Vincula uma cobrança a um Split de pagamento
*
* Para capturar uma falha utilize o `catch`, os campos disponíveis no objeto serão `type`, `title`, `status`, `detail` e dependendo da falha `violacoes`.
*
Expand All @@ -4296,7 +4296,7 @@ class PixMethods extends CobrancasMethods {
/**
* **PUT /v2/gn/split/cobv/:txid/vinculo/:splitConfigId**
*
* Vincula uma configuração de divisão de recebíveis (split) a uma cobrança com vencimento Pix existente.
* Vincula uma cobrança com vencimento (CobV) a um Split de pagamento
*
* Para capturar uma falha utilize o `catch`, os campos disponíveis no objeto serão `type`, `title`, `status`, `detail` e dependendo da falha `violacoes`.
*
Expand All @@ -4309,7 +4309,7 @@ class PixMethods extends CobrancasMethods {
/**
* **DELETE /v2/gn/split/cob/:txid/vinculo**
*
* Remove o vínculo de uma configuração de divisão de recebíveis (split) de uma cobrança Pix existente.
* Deleta o vínculo entre um Split de pagamento e uma cobrança
*
* Para capturar uma falha utilize o `catch`, os campos disponíveis no objeto serão `type`, `title`, `status`, `detail` e dependendo da falha `violacoes`.
*
Expand All @@ -4322,7 +4322,7 @@ class PixMethods extends CobrancasMethods {
/**
* **DELETE /v2/gn/split/cobv/:txid/vinculo**
*
* Remove o vínculo de uma configuração de divisão de recebíveis (split) de uma cobrança com vencimento Pix existente.
* Deleta o vínculo entre um Split de pagamento e uma cobrança com vencimento (CobV).
*
* Para capturar uma falha utilize o `catch`, os campos disponíveis no objeto serão `type`, `title`, `status`, `detail` e dependendo da falha `violacoes`.
*
Expand Down Expand Up @@ -4381,7 +4381,7 @@ class PixMethods extends CobrancasMethods {
/**
* **GET /v2/gn/split/cobv/:txid**
*
* Obtém os detalhes de uma cobrança com vencimento Pix (cobv) vinculada a uma configuração de divisão de recebíveis (split).
* Obtém os detalhes de uma cobrança com vencimento Pix (CobV) vinculada a uma configuração de divisão de recebíveis (split).
*
* Para capturar uma falha utilize o `catch`, os campos disponíveis no objeto serão `type`, `title`, `status`, `detail` e dependendo da falha `violacoes`.
*
Expand Down Expand Up @@ -4437,7 +4437,7 @@ class PixMethods extends CobrancasMethods {
/**
* **PUT /v2/webhook/:chave**
*
* Atualiza a URL do webhook associado à chave Pix.
* Configura a URL do webhook associado à chave Pix.
*
* Para capturar uma falha utilize o `catch`, os campos disponíveis no objeto serão `nome` e `mensagem`.
*
Expand Down Expand Up @@ -4530,7 +4530,7 @@ class PixMethods extends CobrancasMethods {
/**
* **GET /v2/gn/evp**
*
* Recupera todas as chaves EVP (Endereço Virtual de Pagamento).
* Recupera todas as chaves EVP.
*
* Para capturar uma falha utilize o `catch`, os campos disponíveis no objeto serão `nome` e `mensagem`.
*
Expand All @@ -4543,7 +4543,7 @@ class PixMethods extends CobrancasMethods {
/**
* **DELETE /v2/gn/evp/:chave**
*
* Deleta uma chave EVP (Endereço Virtual de Pagamento) específica.
* Deleta uma chave EVP específica.
*
* Para capturar uma falha utilize o `catch`, os campos disponíveis no objeto serão `nome` e `mensagem`.
*
Expand Down Expand Up @@ -4574,7 +4574,7 @@ class PixMethods extends CobrancasMethods {
/**
* **PUT /v2/gn/config**
*
* Configurações para recebimento e envio de PIX.
* Cria/modifica as configurações da conta.
*
* Para capturar uma falha utilize o `catch`, os campos disponíveis no objeto serão `nome` e `mensagem`.
*
Expand Down Expand Up @@ -4618,7 +4618,7 @@ class PixMethods extends CobrancasMethods {
/**
* **GET /v2/gn/config**
*
* Obtém as configurações para recebimento e envio de PIX.
* Lista as configurações da conta
*
* Para capturar uma falha utilize o `catch`, os campos disponíveis no objeto serão `nome` e `mensagem`.
*
Expand Down Expand Up @@ -4659,7 +4659,7 @@ class PixMethods extends CobrancasMethods {
/**
* **GET /v2/gn/infracoes**
*
* Obtém a lista de infrações no sistema.
* Lista as infrações MED da conta
*
* Para capturar uma falha utilize o `catch`, os campos disponíveis no objeto serão `type`, `title`, `status`, `detail` e dependendo da falha `violacoes`.
*
Expand Down Expand Up @@ -4722,7 +4722,7 @@ class PixMethods extends CobrancasMethods {
/**
* **POST /v2/gn/infracoes/:idInfracao/defesa**
*
* Envia a defesa para uma infração específica.
* Submete uma defesa de infração MED
*
* Para capturar uma falha utilize o `catch`, os campos disponíveis no objeto serão `type`, `title`, `status`, `detail` e dependendo da falha `violacoes`.
*
Expand Down
Loading

0 comments on commit 6a1ccff

Please sign in to comment.