"""
Módulo para métodos de recorrência da API Pix.
Este módulo implementa os métodos relacionados ao gerenciamento de recorrências
conforme especificado na API OpenAPI. Inclui operações para:
- Criar recorrências
- Consultar recorrência específica
- Revisar recorrências existentes
- Listar recorrências com filtros
Classes:
RecMethods: Classe base com métodos para operações de recorrência
"""
from typing import Any
[docs]
class RecMethods: # pylint: disable=E1101
"""
Classe que implementa métodos para operações de recorrência da API Pix.
Esta classe fornece métodos para gerenciar recorrências, incluindo criação,
consulta, revisão e listagem de recorrências com diversos filtros disponíveis.
"""
[docs]
def criar_recorrencia(self, body: dict[str, Any]) -> dict[str, Any]:
"""
Criar uma nova recorrência.
Endpoint para criar uma recorrência via POST /rec.
O idRec deve ser informado no corpo da requisição.
Args:
body: Dados da recorrência contendo obrigatoriamente o idRec
Returns:
dict contendo os dados da recorrência criada
Raises:
HTTPError: Para erros 400, 403, 503
"""
headers = self._create_headers()
url = f'{self.get_base_url()}/rec'
resp = self.session.post(url, headers=headers, json=body)
self._handle_error_response(resp)
return resp.json()
[docs]
def revisar_recorrencia(self, id_rec: str, body: dict[str, Any]) -> dict[str, Any]:
"""
Revisar uma recorrência existente.
"""
headers = self._create_headers()
url = f'{self.get_base_url()}/rec/{id_rec}'
resp = self.session.patch(url, headers=headers, json=body)
self._handle_error_response(resp, error_class=None)
return resp.json()
[docs]
def consultar_recorrencia(
self, id_rec: str, txid: str | None = None
) -> dict[str, Any]:
"""
Consultar uma recorrência específica.
"""
headers = self._create_headers()
params = {}
if txid:
params['txid'] = txid
url = f'{self.get_base_url()}/rec/{id_rec}'
resp = self.session.get(url, headers=headers, params=params)
self._handle_error_response(resp, error_class=None)
return resp.json()
[docs]
def listar_recorrencias(
self,
inicio: str,
fim: str,
cpf: str | None = None,
cnpj: str | None = None,
location_presente: bool | None = None,
status: str | None = None,
convenio: str | None = None,
pagina_atual: int | None = None,
itens_por_pagina: int | None = None,
) -> dict[str, Any]:
"""
Consultar lista de recorrências com filtros.
"""
if cpf and cnpj:
raise ValueError('CPF e CNPJ não podem ser utilizados simultaneamente')
headers = self._create_headers()
params = {'inicio': inicio, 'fim': fim}
if cpf:
params['cpf'] = cpf
if cnpj:
params['cnpj'] = cnpj
if location_presente is not None:
params['locationPresente'] = str(location_presente).lower()
if status:
params['status'] = status
if convenio:
params['convenio'] = convenio
if pagina_atual is not None:
params['paginacao.paginaAtual'] = str(pagina_atual)
if itens_por_pagina is not None:
params['paginacao.itensPorPagina'] = str(itens_por_pagina)
url = f'{self.get_base_url()}/rec'
resp = self.session.get(url, headers=headers, params=params)
self._handle_error_response(resp)
return resp.json()