attime-star-api-python-sdk 1.4.0__tar.gz → 1.8.0__tar.gz

{attime_star_api_python_sdk-1.4.0/src/attime_star_api_python_sdk.egg-info → attime_star_api_python_sdk-1.8.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: attime-star-api-python-sdk
-Version: 1.4.0
+Version: 1.8.0
 Summary: Client HTTP de comunicacao com a API da ATTime Star
 Author-email: Filipe Coelho <filipe@fmconsult.com.br>
 License: MIT License

{attime_star_api_python_sdk-1.4.0 → attime_star_api_python_sdk-1.8.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "attime-star-api-python-sdk"
-version = "1.4.0"
+version = "1.8.0"
 description = "Client HTTP de comunicacao com a API da ATTime Star"
 readme = "README.md"
 requires-python = ">=3.11"

attime_star_api_python_sdk-1.8.0/src/attime/star/apis/attime001.py

@@ -0,0 +1,293 @@
+# -*- coding: utf-8 -*-
+"""Cliente HTTP ApiAttime001 (ABTP0004)."""
+from __future__ import annotations
+
+import logging
+from typing import Callable, TypeVar
+
+import jsonpickle
+from fmconsult.utils.url import UrlUtil
+from http import HTTPMethod
+
+from attime.star.api import ATTimeStarApi
+from attime.star.dtos.attime001 import (
+  ApiAttime001AtualizacoesDTO,
+  ApiAttime001CancelamentoDTO,
+  ApiAttime001EmitirItemDTO,
+  ApiAttime001RelacaoContratoCpfItemDTO,
+  ApiAttime001RelacaoItemDTO,
+  EscopoOperacao,
+)
+from attime.star.dtos.ecommerce import ApiAttime001ImportarEcommerceDTO
+
+T = TypeVar('T')
+
+
+def _require_escopo_e_contrato(payload: dict) -> None:
+  if payload.get('escopoOperacao') in (None, ''):
+    raise ValueError('escopoOperacao é obrigatório')
+  if payload.get('numeroContrato') in (None, ''):
+    raise ValueError('numeroContrato é obrigatório')
+
+
+def _escopo_is(value: object, expected: EscopoOperacao) -> bool:
+  if value is None:
+    return False
+  return str(value).casefold() == expected.value.casefold()
+
+
+def _parse_attime001_list_response(
+  res: object,
+  *,
+  from_dict: Callable[[object], T | None],
+  endpoint_label: str,
+) -> list[T]:
+  """Normaliza lista / {dados} / {codigo} no padrão STAR BTC."""
+  if isinstance(res, list):
+    return [row for row in (from_dict(r) for r in res) if row is not None]
+
+  if isinstance(res, dict):
+    if 'dados' in res:
+      dados = res['dados']
+      if isinstance(dados, list):
+        return [
+          row for row in (from_dict(r) for r in dados) if row is not None
+        ]
+      if isinstance(dados, dict):
+        parsed = from_dict(dados)
+        return [parsed] if parsed is not None else []
+      raise Exception(res.get('mensagem', 'Resposta inesperada em dados'))
+
+    if 'codigo' in res:
+      raise Exception(res.get('mensagem', 'Erro desconhecido'))
+
+    parsed = from_dict(res)
+    return [parsed] if parsed is not None else []
+
+  raise Exception(f'Resposta inesperada da API Attime001 {endpoint_label}')
+
+
+def _parse_attime001_object_response(
+  res: object,
+  *,
+  from_dict: Callable[[object], T | None],
+  endpoint_label: str,
+) -> T:
+  """Como a lista, mas exige exatamente um objeto (ex.: InsereItem)."""
+  rows = _parse_attime001_list_response(
+    res, from_dict=from_dict, endpoint_label=endpoint_label
+  )
+  if not rows:
+    raise Exception(
+      f'Resposta vazia da API Attime001 {endpoint_label}'
+    )
+  return rows[0]
+
+
+def _require_emitir_item_keys(payload: dict) -> None:
+  for key in ('codigoProduto', 'codigoSucursal', 'sequencialContrato'):
+    if payload.get(key) in (None, ''):
+      raise ValueError(f'{key} é obrigatório')
+
+
+class Attime001Api(ATTimeStarApi):
+  """Rotinas ApiAttime001 — emissão, manutenção e consultas Relacao."""
+
+  def cancelamento(
+    self, item: ApiAttime001CancelamentoDTO | dict
+  ) -> list[ApiAttime001CancelamentoDTO]:
+    """POST /btc/ABTP0004/ApiAttime001/Cancelamento."""
+    logging.info('cancelling via ApiAttime001 Cancelamento...')
+    if isinstance(item, ApiAttime001CancelamentoDTO):
+      payload = item.to_dict()
+    else:
+      payload = dict(item)
+
+    _require_escopo_e_contrato(payload)
+    if _escopo_is(payload.get('escopoOperacao'), EscopoOperacao.DECLINIO) and not payload.get(
+      'declinio'
+    ):
+      raise ValueError(
+        f'declinio é obrigatório quando escopoOperacao={EscopoOperacao.DECLINIO}'
+      )
+
+    url = UrlUtil().make_url(
+      self.base_url,
+      ['btc', 'ABTP0004', 'ApiAttime001', 'Cancelamento'],
+    )
+    res = self.call_request(
+      http_method=HTTPMethod.POST,
+      request_url=url,
+      payload=payload,
+    )
+    res = jsonpickle.decode(res)
+    return _parse_attime001_list_response(
+      res,
+      from_dict=ApiAttime001CancelamentoDTO.from_dict,
+      endpoint_label='Cancelamento',
+    )
+
+  def atualizacoes(
+    self, item: ApiAttime001AtualizacoesDTO | dict
+  ) -> list[ApiAttime001AtualizacoesDTO]:
+    """POST /btc/ABTP0004/ApiAttime001/Atualizacoes."""
+    logging.info('updating via ApiAttime001 Atualizacoes...')
+    if isinstance(item, ApiAttime001AtualizacoesDTO):
+      payload = item.to_dict()
+    else:
+      payload = dict(item)
+
+    _require_escopo_e_contrato(payload)
+
+    url = UrlUtil().make_url(
+      self.base_url,
+      ['btc', 'ABTP0004', 'ApiAttime001', 'Atualizacoes'],
+    )
+    res = self.call_request(
+      http_method=HTTPMethod.POST,
+      request_url=url,
+      payload=payload,
+    )
+    res = jsonpickle.decode(res)
+    return _parse_attime001_list_response(
+      res,
+      from_dict=ApiAttime001AtualizacoesDTO.from_dict,
+      endpoint_label='Atualizacoes',
+    )
+
+  def insere_item(
+    self, item: ApiAttime001EmitirItemDTO | dict
+  ) -> ApiAttime001EmitirItemDTO:
+    """POST /btc/ABTP0004/ApiAttime001/InsereItem.
+
+    Disponível em homologação; produção ainda em liberação (STAR).
+    """
+    logging.info('inserting item via ApiAttime001 InsereItem...')
+    if isinstance(item, ApiAttime001EmitirItemDTO):
+      payload = item.to_dict()
+    else:
+      payload = dict(item)
+
+    _require_emitir_item_keys(payload)
+
+    url = UrlUtil().make_url(
+      self.base_url,
+      ['btc', 'ABTP0004', 'ApiAttime001', 'InsereItem'],
+    )
+    res = self.call_request(
+      http_method=HTTPMethod.POST,
+      request_url=url,
+      payload=payload,
+    )
+    res = jsonpickle.decode(res)
+    return _parse_attime001_object_response(
+      res,
+      from_dict=ApiAttime001EmitirItemDTO.from_dict,
+      endpoint_label='InsereItem',
+    )
+
+  def importar_ecommerce(
+    self, item: ApiAttime001ImportarEcommerceDTO | dict
+  ) -> ApiAttime001ImportarEcommerceDTO:
+    """POST /btc/ABTP0004/ApiAttime001/ImportarEcommerce."""
+    logging.info('importing ecommerce via ApiAttime001 ImportarEcommerce...')
+    if isinstance(item, ApiAttime001ImportarEcommerceDTO):
+      payload = item.to_dict()
+    else:
+      payload = dict(item)
+
+    if not payload.get('emissao'):
+      raise ValueError('emissao é obrigatório')
+    emissao = payload['emissao']
+    if isinstance(emissao, dict):
+      if not emissao.get('clientes'):
+        raise ValueError('emissao.clientes é obrigatório')
+      if not emissao.get('contratos'):
+        raise ValueError('emissao.contratos é obrigatório')
+
+    url = UrlUtil().make_url(
+      self.base_url,
+      ['btc', 'ABTP0004', 'ApiAttime001', 'ImportarEcommerce'],
+    )
+    res = self.call_request(
+      http_method=HTTPMethod.POST,
+      request_url=url,
+      payload=payload,
+    )
+    res = jsonpickle.decode(res)
+    return _parse_attime001_object_response(
+      res,
+      from_dict=ApiAttime001ImportarEcommerceDTO.from_dict,
+      endpoint_label='ImportarEcommerce',
+    )
+
+  def relacao_contrato(
+    self,
+    *,
+    cpf: str,
+    data_inicio_vigencia: str | None = None,
+    ramo: str | None = None,
+  ) -> list[ApiAttime001RelacaoContratoCpfItemDTO]:
+    """GET /btc/ABTP0004/ApiAttime001/RelacaoContrato.
+
+    Consulta contratos vinculados a um CPF (conferência pós-emissão).
+    """
+    logging.info('querying RelacaoContrato via ApiAttime001...')
+    if cpf in (None, ''):
+      raise ValueError('cpf é obrigatório')
+
+    params = {'Cpf': cpf}
+    if data_inicio_vigencia not in (None, ''):
+      params['DataInicioVigencia'] = data_inicio_vigencia
+    if ramo not in (None, ''):
+      params['Ramo'] = ramo
+
+    url = UrlUtil().make_url(
+      self.base_url,
+      ['btc', 'ABTP0004', 'ApiAttime001', 'RelacaoContrato'],
+    )
+    res = self.call_request(
+      http_method=HTTPMethod.GET,
+      request_url=url,
+      params=params,
+    )
+    res = jsonpickle.decode(res)
+    return _parse_attime001_list_response(
+      res,
+      from_dict=ApiAttime001RelacaoContratoCpfItemDTO.from_dict,
+      endpoint_label='RelacaoContrato',
+    )
+
+  def relacao_itens(
+    self,
+    *,
+    numero_contrato: str,
+    data_ref: str | None = None,
+  ) -> list[ApiAttime001RelacaoItemDTO]:
+    """GET /btc/ABTP0004/ApiAttime001/RelacaoItens.
+
+    Consulta itens de um contrato (conferência pós-emissão).
+    """
+    logging.info('querying RelacaoItens via ApiAttime001...')
+    if numero_contrato in (None, ''):
+      raise ValueError('numero_contrato é obrigatório')
+
+    params = {'NumeroContrato': numero_contrato}
+    if data_ref not in (None, ''):
+      params['DataRef'] = data_ref
+
+    url = UrlUtil().make_url(
+      self.base_url,
+      ['btc', 'ABTP0004', 'ApiAttime001', 'RelacaoItens'],
+    )
+    res = self.call_request(
+      http_method=HTTPMethod.GET,
+      request_url=url,
+      params=params,
+    )
+    res = jsonpickle.decode(res)
+    return _parse_attime001_list_response(
+      res,
+      from_dict=ApiAttime001RelacaoItemDTO.from_dict,
+      endpoint_label='RelacaoItens',
+    )