From 6a1ccffd6a50d3091e2336e640573c4e2fd4847c Mon Sep 17 00:00:00 2001 From: joao-muniz-efi Date: Tue, 1 Oct 2024 17:39:27 +0000 Subject: [PATCH] =?UTF-8?q?=F0=9F=90=9B=20=F0=9F=93=9A=20Release=201.2.8?= =?UTF-8?q?=20Corrigido=20a=20tipagem=20dos=20m=C3=A9todos=20pixCreateImme?= =?UTF-8?q?diateCharge=20e=20pixCreateCharge=20Algumas=20mudan=C3=A7as=20n?= =?UTF-8?q?a=20descri=C3=A7=C3=A3o=20dos=20m=C3=A9todos=20da=20API=20Pix?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- dist/cjs/index.cjs | 80 +++++++++++++++++------------------ dist/esm/index.mjs | 80 +++++++++++++++++------------------ dist/types/methods/pix.d.ts | 84 ++++++++++++++++++------------------- package-lock.json | 4 +- package.json | 2 +- src/methods/pix.js | 78 +++++++++++++++++----------------- 6 files changed, 164 insertions(+), 164 deletions(-) diff --git a/dist/cjs/index.cjs b/dist/cjs/index.cjs index 8929c13..0c845dc 100644 --- a/dist/cjs/index.cjs +++ b/dist/cjs/index.cjs @@ -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"; @@ -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`. * @@ -2825,7 +2825,7 @@ class PixMethods extends CobrancasMethods { * }, * location: string, * status: string, - * devedor: { + * devedor?: { * cpf?: string, * cnpj?: string, * nome: string @@ -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`.` * @@ -2852,7 +2852,7 @@ class PixMethods extends CobrancasMethods { * calendario: { * expiracao: number * }, - * devedor: { + * devedor?: { * cpf?: string, * cnpj?: string, * nome: string @@ -2885,7 +2885,7 @@ class PixMethods extends CobrancasMethods { * }, * location: string, * status: string, - * devedor: { + * devedor?: { * cpf?: string, * cnpj?: string, * nome: string @@ -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 @@ -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`. * @@ -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`. * @@ -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`. * @@ -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`. * @@ -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`. * @@ -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`. * @@ -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`. * @@ -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`. * @@ -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`. * @@ -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`. * @@ -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` * @@ -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` * @@ -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` * @@ -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` * @@ -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`. * @@ -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`. * @@ -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`. * @@ -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`. * @@ -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`. * @@ -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`. * @@ -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`. * @@ -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`. * @@ -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`. * @@ -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`. * @@ -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`. * @@ -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`. * @@ -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`. * @@ -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`. * @@ -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`. * @@ -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`. * @@ -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`. * @@ -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`. * @@ -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`. * diff --git a/dist/esm/index.mjs b/dist/esm/index.mjs index 48fd29e..f3730e8 100644 --- a/dist/esm/index.mjs +++ b/dist/esm/index.mjs @@ -570,7 +570,7 @@ var exports = { } }; 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"; @@ -2774,7 +2774,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`. * @@ -2816,7 +2816,7 @@ class PixMethods extends CobrancasMethods { * }, * location: string, * status: string, - * devedor: { + * devedor?: { * cpf?: string, * cnpj?: string, * nome: string @@ -2834,7 +2834,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`.` * @@ -2843,7 +2843,7 @@ class PixMethods extends CobrancasMethods { * calendario: { * expiracao: number * }, - * devedor: { + * devedor?: { * cpf?: string, * cnpj?: string, * nome: string @@ -2876,7 +2876,7 @@ class PixMethods extends CobrancasMethods { * }, * location: string, * status: string, - * devedor: { + * devedor?: { * cpf?: string, * cnpj?: string, * nome: string @@ -2894,7 +2894,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 @@ -2948,7 +2948,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`. * @@ -3071,7 +3071,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`. * @@ -3189,7 +3189,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`. * @@ -3304,7 +3304,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`. * @@ -3353,7 +3353,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`. * @@ -3485,7 +3485,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`. * @@ -3523,7 +3523,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`. * @@ -3560,7 +3560,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`. * @@ -3602,7 +3602,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`. * @@ -3741,7 +3741,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`. * @@ -3806,7 +3806,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` * @@ -3840,7 +3840,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` * @@ -3859,7 +3859,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` * @@ -3876,7 +3876,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` * @@ -3894,7 +3894,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`. * @@ -3985,7 +3985,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`. * @@ -4044,7 +4044,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`. * @@ -4077,7 +4077,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`. * @@ -4114,7 +4114,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`. * @@ -4175,7 +4175,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`. * @@ -4236,7 +4236,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`. * @@ -4274,7 +4274,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`. * @@ -4287,7 +4287,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`. * @@ -4300,7 +4300,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`. * @@ -4313,7 +4313,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`. * @@ -4372,7 +4372,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`. * @@ -4428,7 +4428,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`. * @@ -4521,7 +4521,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`. * @@ -4534,7 +4534,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`. * @@ -4565,7 +4565,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`. * @@ -4609,7 +4609,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`. * @@ -4650,7 +4650,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`. * @@ -4713,7 +4713,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`. * diff --git a/dist/types/methods/pix.d.ts b/dist/types/methods/pix.d.ts index fd26956..d2682b3 100644 --- a/dist/types/methods/pix.d.ts +++ b/dist/types/methods/pix.d.ts @@ -2,7 +2,7 @@ export 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`. * @@ -44,7 +44,7 @@ export class PixMethods extends CobrancasMethods { * }, * location: string, * status: string, - * devedor: { + * devedor?: { * cpf?: string, * cnpj?: string, * nome: string @@ -92,7 +92,7 @@ export class PixMethods extends CobrancasMethods { }; location: string; status: string; - devedor: { + devedor?: { cpf?: string; cnpj?: string; nome: string; @@ -107,7 +107,7 @@ export 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`.` * @@ -116,7 +116,7 @@ export class PixMethods extends CobrancasMethods { * calendario: { * expiracao: number * }, - * devedor: { + * devedor?: { * cpf?: string, * cnpj?: string, * nome: string @@ -149,7 +149,7 @@ export class PixMethods extends CobrancasMethods { * }, * location: string, * status: string, - * devedor: { + * devedor?: { * cpf?: string, * cnpj?: string, * nome: string @@ -168,7 +168,7 @@ export class PixMethods extends CobrancasMethods { calendario: { expiracao: number; }; - devedor: { + devedor?: { cpf?: string; cnpj?: string; nome: string; @@ -199,7 +199,7 @@ export class PixMethods extends CobrancasMethods { }; location: string; status: string; - devedor: { + devedor?: { cpf?: string; cnpj?: string; nome: string; @@ -214,7 +214,7 @@ export 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 @@ -310,7 +310,7 @@ export 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`. * @@ -529,7 +529,7 @@ export 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`. * @@ -726,7 +726,7 @@ export 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`. * @@ -917,7 +917,7 @@ export 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`. * @@ -1003,7 +1003,7 @@ export 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`. * @@ -1240,7 +1240,7 @@ export 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`. * @@ -1304,7 +1304,7 @@ export 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`. * @@ -1368,7 +1368,7 @@ export 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`. * @@ -1440,7 +1440,7 @@ export 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`. * @@ -1673,7 +1673,7 @@ export 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`. * @@ -1766,7 +1766,7 @@ export 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` * @@ -1820,7 +1820,7 @@ export 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` * @@ -1846,7 +1846,7 @@ export 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` * @@ -1868,7 +1868,7 @@ export 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` * @@ -1892,7 +1892,7 @@ export 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`. * @@ -2033,7 +2033,7 @@ export 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`. * @@ -2137,7 +2137,7 @@ export 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`. * @@ -2189,7 +2189,7 @@ export 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`. * @@ -2249,7 +2249,7 @@ export 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`. * @@ -2355,7 +2355,7 @@ export 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`. * @@ -2463,7 +2463,7 @@ export 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`. * @@ -2527,7 +2527,7 @@ export 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`. * @@ -2542,7 +2542,7 @@ export 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`. * @@ -2557,7 +2557,7 @@ export 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`. * @@ -2571,7 +2571,7 @@ export 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`. * @@ -2665,7 +2665,7 @@ export 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`. * @@ -2763,7 +2763,7 @@ export 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`. * @@ -2886,7 +2886,7 @@ export 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`. * @@ -2900,7 +2900,7 @@ export 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`. * @@ -2938,7 +2938,7 @@ export 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`. * @@ -3011,7 +3011,7 @@ export 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`. * @@ -3081,7 +3081,7 @@ export 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`. * @@ -3193,7 +3193,7 @@ export 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`. * diff --git a/package-lock.json b/package-lock.json index b6952d8..dff2fe5 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "sdk-node-apis-efi", - "version": "1.2.7", + "version": "1.2.8", "lockfileVersion": 2, "requires": true, "packages": { "": { "name": "sdk-node-apis-efi", - "version": "1.2.7", + "version": "1.2.8", "license": "MIT", "dependencies": { "axios": "^1.2.2", diff --git a/package.json b/package.json index 8138e9a..c02b697 100755 --- a/package.json +++ b/package.json @@ -9,7 +9,7 @@ } }, "description": "Module for integration with Efi Bank API", - "version": "1.2.7", + "version": "1.2.8", "author": "Efi Bank - Consultoria Técnica | João Vitor Oliveira | João Lucas", "license": "MIT", "repository": "efipay/sdk-node-apis-efi", diff --git a/src/methods/pix.js b/src/methods/pix.js index 1242bc8..c5ec79e 100644 --- a/src/methods/pix.js +++ b/src/methods/pix.js @@ -8,7 +8,7 @@ export 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`. * @@ -50,7 +50,7 @@ export class PixMethods extends CobrancasMethods { * }, * location: string, * status: string, - * devedor: { + * devedor?: { * cpf?: string, * cnpj?: string, * nome: string @@ -69,7 +69,7 @@ export 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`.` * @@ -78,7 +78,7 @@ export class PixMethods extends CobrancasMethods { * calendario: { * expiracao: number * }, - * devedor: { + * devedor?: { * cpf?: string, * cnpj?: string, * nome: string @@ -111,7 +111,7 @@ export class PixMethods extends CobrancasMethods { * }, * location: string, * status: string, - * devedor: { + * devedor?: { * cpf?: string, * cnpj?: string, * nome: string @@ -129,7 +129,7 @@ export 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 @@ -183,7 +183,7 @@ export 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`. * @@ -306,7 +306,7 @@ export 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`. * @@ -424,7 +424,7 @@ export 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`. * @@ -539,7 +539,7 @@ export 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`. * @@ -588,7 +588,7 @@ export 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`. * @@ -720,7 +720,7 @@ export 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`. * @@ -758,7 +758,7 @@ export 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`. * @@ -795,7 +795,7 @@ export 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`. * @@ -837,7 +837,7 @@ export 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`. * @@ -976,7 +976,7 @@ export 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`. * @@ -1041,7 +1041,7 @@ export 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` * @@ -1075,7 +1075,7 @@ export 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` * @@ -1094,7 +1094,7 @@ export 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` * @@ -1111,7 +1111,7 @@ export 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` * @@ -1129,7 +1129,7 @@ export 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`. * @@ -1220,7 +1220,7 @@ export 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`. * @@ -1279,7 +1279,7 @@ export 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`. * @@ -1312,7 +1312,7 @@ export 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`. * @@ -1349,7 +1349,7 @@ export 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`. * @@ -1410,7 +1410,7 @@ export 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`. * @@ -1471,7 +1471,7 @@ export 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`. * @@ -1509,7 +1509,7 @@ export 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`. * @@ -1522,7 +1522,7 @@ export 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`. * @@ -1535,7 +1535,7 @@ export 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`. * @@ -1548,7 +1548,7 @@ export 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`. * @@ -1608,7 +1608,7 @@ export 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`. * @@ -1664,7 +1664,7 @@ export 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`. * @@ -1757,7 +1757,7 @@ export 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`. * @@ -1770,7 +1770,7 @@ export 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`. * @@ -1801,7 +1801,7 @@ export 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`. * @@ -1845,7 +1845,7 @@ export 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`. * @@ -1886,7 +1886,7 @@ export 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`. * @@ -1949,7 +1949,7 @@ export 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`. *