"""
pypix_api.banks.webhook_rec_methods
-----------------------------------
Este módulo implementa a classe `WebHookRecMethods`, que fornece métodos para operações de webhook de recorrência do PIX, conforme especificação do Banco Central do Brasil.
A classe `WebHookRecMethods` é utilizada como base para integração com APIs bancárias que suportam o PIX, permitindo configurar webhooks para notificações de recorrências. Os métodos abstraem detalhes de requisições HTTP, tratamento de erros e montagem de parâmetros, facilitando a integração de sistemas Python com provedores bancários.
Principais funcionalidades:
- Configuração de webhook para notificações de recorrências
- Consulta de webhook configurado
- Cancelamento de webhook
Esta classe é herdada por implementações específicas de bancos (ex: Banco do Brasil, Sicoob).
Dependências:
- session HTTP compatível (ex: requests.Session)
- Método auxiliar: `_request()`, fornecido por `BankPixAPIBase`
Exemplo de uso:
class MeuBanco(WebHookRecMethods):
...
banco = MeuBanco()
resposta = banco.configurar_webhook_rec(webhook_url="https://example.com/webhook/")
"""
from typing import Any
[docs]
class WebHookRecMethods: # pylint: disable=E1101
"""
Classe que implementa os métodos para operações de webhook de recorrência do PIX.
Esta classe é herdada pela BankPixAPIBase.
"""
[docs]
def configurar_webhook_rec(self, webhook_url: str) -> dict[str, Any]:
"""
Configurar o Webhook de Recorrência.
Endpoint para configuração do serviço de notificações acerca de recorrências.
Somente recorrências associadas ao usuário recebedor serão notificadas.
Args:
webhook_url: URL do webhook para notificações (ex: "https://example.com/api/webhookrec/")
Returns:
dict contendo os dados da configuração do webhook
Raises:
HTTPError: Para erros 400, 403, 404, 503
"""
body = {'webhookUrl': webhook_url}
resp = self._request('PUT', '/webhookrec', json=body)
return self._json_opcional(resp)
[docs]
def consultar_webhook_rec(self) -> dict[str, Any]:
"""
Consultar informações do Webhook de Recorrência.
Endpoint para recuperação de informações sobre o Webhook configurado.
Returns:
dict contendo as informações do webhook (incluindo URL e data de criação)
Raises:
HTTPError: Para erros 403, 404, 503
"""
resp = self._request('GET', '/webhookrec')
return self._json(resp)
[docs]
def excluir_webhook_rec(self) -> bool:
"""
Cancelar o Webhook de Recorrência.
Endpoint para cancelamento do webhook. Não é a única forma pela qual um webhook pode ser removido.
Returns:
bool: True se o webhook foi excluído com sucesso (status 204), False caso contrário
Raises:
HTTPError: Para erros 403, 404, 503
"""
resp = self._request('DELETE', '/webhookrec')
# `_request` já levantou em caso de erro: qualquer 2xx é exclusão
# bem-sucedida. A especificação prevê 204, mas um PSP que responda
# 200 não deve ser lido como "não excluiu".
return resp.ok