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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: attime-star-api-python-sdk
-Version: 1.8.0
+Version: 1.9.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.8.0 → attime_star_api_python_sdk-1.9.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "attime-star-api-python-sdk"
-version = "1.8.0"
+version = "1.9.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 → attime_star_api_python_sdk-1.9.0}/src/attime/star/apis/attime001.py

@@ -16,24 +16,27 @@ from attime.star.dtos.attime001 import (
   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')
+def _require_numero_contrato(payload: dict) -> None:
   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 _require_cancelamento_payload(payload: dict) -> None:
+  """Escopo via campos: declinio, ou identificadorItem ("" = contrato)."""
+  _require_numero_contrato(payload)
+  if payload.get('declinio'):
+    return
+  if 'identificadorItem' not in payload:
+    raise ValueError(
+      'identificadorItem é obrigatório ("" para contrato; CAC 25/nº para item) '
+      'ou informe o bloco declinio'
+    )
 
 
 def _parse_attime001_list_response(
@@ -96,27 +99,23 @@ class Attime001Api(ATTimeStarApi):
   def cancelamento(
     self, item: ApiAttime001CancelamentoDTO | dict
   ) -> list[ApiAttime001CancelamentoDTO]:
-    """POST /btc/ABTP0004/ApiAttime001/Cancelamento."""
+    """PUT /btc/ABTP0004/ApiAttime001/Cancelamento."""
     logging.info('cancelling via ApiAttime001 Cancelamento...')
     if isinstance(item, ApiAttime001CancelamentoDTO):
       payload = item.to_dict()
     else:
       payload = dict(item)
+      # Compat: ignore legacy field if caller still sends it.
+      payload.pop('escopoOperacao', None)
 
-    _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}'
-      )
+    _require_cancelamento_payload(payload)
 
     url = UrlUtil().make_url(
       self.base_url,
       ['btc', 'ABTP0004', 'ApiAttime001', 'Cancelamento'],
     )
     res = self.call_request(
-      http_method=HTTPMethod.POST,
+      http_method=HTTPMethod.PUT,
       request_url=url,
       payload=payload,
     )
@@ -130,21 +129,22 @@ class Attime001Api(ATTimeStarApi):
   def atualizacoes(
     self, item: ApiAttime001AtualizacoesDTO | dict
   ) -> list[ApiAttime001AtualizacoesDTO]:
-    """POST /btc/ABTP0004/ApiAttime001/Atualizacoes."""
+    """PUT /btc/ABTP0004/ApiAttime001/Atualizacoes."""
     logging.info('updating via ApiAttime001 Atualizacoes...')
     if isinstance(item, ApiAttime001AtualizacoesDTO):
       payload = item.to_dict()
     else:
       payload = dict(item)
+      payload.pop('escopoOperacao', None)
 
-    _require_escopo_e_contrato(payload)
+    _require_numero_contrato(payload)
 
     url = UrlUtil().make_url(
       self.base_url,
       ['btc', 'ABTP0004', 'ApiAttime001', 'Atualizacoes'],
     )
     res = self.call_request(
-      http_method=HTTPMethod.POST,
+      http_method=HTTPMethod.PUT,
       request_url=url,
       payload=payload,
     )

{attime_star_api_python_sdk-1.8.0 → attime_star_api_python_sdk-1.9.0}/src/attime/star/dtos/attime001.py

@@ -1,19 +1,20 @@
 # -*- coding: utf-8 -*-
 """DTOs ApiAttime001 (ABTP0004).
 
-Cancelamento: POST /btc/ABTP0004/ApiAttime001/Cancelamento
-Atualizacoes: POST /btc/ABTP0004/ApiAttime001/Atualizacoes
+Cancelamento: PUT /btc/ABTP0004/ApiAttime001/Cancelamento
+Atualizacoes: PUT /btc/ABTP0004/ApiAttime001/Atualizacoes
 InsereItem: POST /btc/ABTP0004/ApiAttime001/InsereItem
 RelacaoContrato: GET /btc/ABTP0004/ApiAttime001/RelacaoContrato
 RelacaoItens: GET /btc/ABTP0004/ApiAttime001/RelacaoItens
 
 Enums de domínio compartilhados: ``attime.star.dtos.enums``.
-``EscopoOperacao`` permanece aqui (específico Cancelamento/Atualizacoes).
+
+Escopo de Cancelamento/Atualizacoes é inferido pelos campos preenchidos
+(STAR removeu ``escopoOperacao`` do JSON).
 """
 from __future__ import annotations
 
 from dataclasses import dataclass
-from enum import StrEnum
 from typing import Optional
 
 from attime.star.dtos.enums import (
@@ -36,21 +37,6 @@ _WIRE_CARACTERISTICA = {
 _WIRE_CARACTERISTICA_REV = {v: k for k, v in _WIRE_CARACTERISTICA.items()}
 
 
-class EscopoOperacao(StrEnum):
-  """Literais de ``escopoOperacao`` conforme description do OpenAPI (Title Case).
-
-  Cancelamento inclui DECLINIO; Atualizacoes não. Específico deste endpoint.
-  """
-
-  CONTRATO = 'Contrato'
-  ITEM = 'Item'
-  CARACTERISTICA = 'Caracteristica'
-  COBERTURA = 'Cobertura'
-  SERVICO = 'Servico'
-  BENEFICIARIO = 'Beneficiario'
-  DECLINIO = 'Declinio'
-
-
 # ---------------------------------------------------------------------------
 # Cancelamento
 # ---------------------------------------------------------------------------
@@ -103,9 +89,13 @@ class DeclinioDto:
 
 @dataclass
 class ApiAttime001CancelamentoDTO:
-  """Payload/resposta de Cancelamento (ApiAttime001CancelamentoDTO)."""
+  """Payload/resposta de Cancelamento (ApiAttime001CancelamentoDTO).
+
+  Escopo é inferido pelos campos: contrato inteiro usa ``identificadorItem=""``;
+  item/parcial exige ``identificadorItem`` (CAC 25 ou nº do item); Declínio
+  exige o bloco ``declinio``.
+  """
 
-  escopoOperacao: str | EscopoOperacao
   numeroContrato: str
   manutencaoUsuarioCpf: Optional[str] = None
   manutencaoUsuarioDataHora: Optional[str] = None  # ISO date-time
@@ -118,7 +108,6 @@ class ApiAttime001CancelamentoDTO:
 
   def to_dict(self) -> dict:
     return omit_none({
-      'escopoOperacao': to_wire(self.escopoOperacao),
       'numeroContrato': self.numeroContrato,
       'manutencaoUsuarioCpf': self.manutencaoUsuarioCpf,
       'manutencaoUsuarioDataHora': self.manutencaoUsuarioDataHora,
@@ -143,7 +132,6 @@ class ApiAttime001CancelamentoDTO:
         f'ApiAttime001CancelamentoDTO.from_dict espera dict, recebeu {type(data)!r}'
       )
     return cls(
-      escopoOperacao=data.get('escopoOperacao'),
       numeroContrato=data.get('numeroContrato'),
       manutencaoUsuarioCpf=data.get('manutencaoUsuarioCpf'),
       manutencaoUsuarioDataHora=data.get('manutencaoUsuarioDataHora'),
@@ -163,11 +151,9 @@ class ApiAttime001CancelamentoDTO:
     identificadorItem: str,
     manutencaoUsuarioCpf: Optional[str] = None,
     manutencaoUsuarioDataHora: Optional[str] = None,
-    escopoOperacao: str = EscopoOperacao.ITEM,
   ) -> ApiAttime001CancelamentoDTO:
-    """Atalho para cancelar um item do contrato."""
+    """Atalho para cancelar um item (CAC 25 ou número do item)."""
     return cls(
-      escopoOperacao=escopoOperacao,
       numeroContrato=numeroContrato,
       identificadorItem=identificadorItem,
       manutencaoUsuarioCpf=manutencaoUsuarioCpf,
@@ -181,12 +167,11 @@ class ApiAttime001CancelamentoDTO:
     numeroContrato: str,
     manutencaoUsuarioCpf: Optional[str] = None,
     manutencaoUsuarioDataHora: Optional[str] = None,
-    escopoOperacao: str = EscopoOperacao.CONTRATO,
   ) -> ApiAttime001CancelamentoDTO:
-    """Atalho para cancelar o contrato inteiro."""
+    """Atalho para cancelar o contrato inteiro (``identificadorItem=""``)."""
     return cls(
-      escopoOperacao=escopoOperacao,
       numeroContrato=numeroContrato,
+      identificadorItem='',
       manutencaoUsuarioCpf=manutencaoUsuarioCpf,
       manutencaoUsuarioDataHora=manutencaoUsuarioDataHora,
     )
@@ -199,16 +184,14 @@ class ApiAttime001CancelamentoDTO:
     declinio_itens: list[DeclinioItemCobertura] | list[dict],
     manutencaoUsuarioCpf: Optional[str] = None,
     manutencaoUsuarioDataHora: Optional[str] = None,
-    escopoOperacao: str = EscopoOperacao.DECLINIO,
   ) -> ApiAttime001CancelamentoDTO:
-    """Atalho para escopo Declínio (bloco declinio obrigatório)."""
+    """Atalho para Declínio (bloco ``declinio`` obrigatório)."""
     itens: list[DeclinioItemCobertura] = []
     for row in declinio_itens:
       parsed = DeclinioItemCobertura.from_dict(row)
       if parsed is not None:
         itens.append(parsed)
     return cls(
-      escopoOperacao=escopoOperacao,
       numeroContrato=numeroContrato,
       manutencaoUsuarioCpf=manutencaoUsuarioCpf,
       manutencaoUsuarioDataHora=manutencaoUsuarioDataHora,
@@ -391,9 +374,13 @@ class AtualizacaoItemBeneficiarioDto:
 
 @dataclass
 class ApiAttime001AtualizacoesDTO:
-  """Payload/resposta de Atualizacoes (ApiAttime001AtualizacoesDTO)."""
+  """Payload/resposta de Atualizacoes (ApiAttime001AtualizacoesDTO).
+
+  Escopo é inferido pelos blocos presentes (``contrato``, ``item``,
+  ``itemCaracteristica``, ``itemCobertura``, ``itemCoberturaServico``,
+  ``itemBeneficiario``).
+  """
 
-  escopoOperacao: str | EscopoOperacao
   numeroContrato: str
   manutencaoUsuarioCpf: Optional[str] = None
   manutencaoUsuarioDataHora: Optional[str] = None
@@ -406,7 +393,6 @@ class ApiAttime001AtualizacoesDTO:
 
   def to_dict(self) -> dict:
     return omit_none({
-      'escopoOperacao': to_wire(self.escopoOperacao),
       'numeroContrato': self.numeroContrato,
       'manutencaoUsuarioCpf': self.manutencaoUsuarioCpf,
       'manutencaoUsuarioDataHora': self.manutencaoUsuarioDataHora,
@@ -438,7 +424,6 @@ class ApiAttime001AtualizacoesDTO:
       return [nested_cls.from_dict(i) for i in rows if i is not None]
 
     return cls(
-      escopoOperacao=data.get('escopoOperacao'),
       numeroContrato=data.get('numeroContrato'),
       manutencaoUsuarioCpf=data.get('manutencaoUsuarioCpf'),
       manutencaoUsuarioDataHora=data.get('manutencaoUsuarioDataHora'),

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: attime-star-api-python-sdk
-Version: 1.8.0
+Version: 1.9.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.8.0 → attime_star_api_python_sdk-1.9.0}/tests/test_attime001_atualizacoes.py

@@ -3,6 +3,7 @@
 from __future__ import annotations
 
 import unittest
+from http import HTTPMethod
 from unittest.mock import MagicMock, patch
 
 from attime.star.dtos.attime001 import (
@@ -10,7 +11,6 @@ from attime.star.dtos.attime001 import (
   AtualizacaoContratoDto,
   AtualizacaoItemCaracteristicaDto,
   AtualizacaoItemCoberturaDto,
-  EscopoOperacao,
 )
 from attime.star.dtos.enums import Sexo, SimNao
 
@@ -18,7 +18,6 @@ from attime.star.dtos.enums import Sexo, SimNao
 class TestApiAttime001AtualizacoesDTO(unittest.TestCase):
   def test_to_dict_omits_none_and_maps_caracteristica_wire(self):
     dto = ApiAttime001AtualizacoesDTO(
-      escopoOperacao=EscopoOperacao.CARACTERISTICA,
       numeroContrato='016501000280',
       itemCaracteristica=[
         AtualizacaoItemCaracteristicaDto(
@@ -29,6 +28,7 @@ class TestApiAttime001AtualizacoesDTO(unittest.TestCase):
       ],
     )
     data = dto.to_dict()
+    self.assertNotIn('escopoOperacao', data)
     self.assertNotIn('contrato', data)
     self.assertNotIn('itemCobertura', data)
     row = data['itemCaracteristica'][0]
@@ -38,7 +38,6 @@ class TestApiAttime001AtualizacoesDTO(unittest.TestCase):
 
   def test_from_dict_accepts_openapi_typo(self):
     raw = {
-      'escopoOperacao': 'CARACTERISTICA',
       'numeroContrato': '016501000280',
       'itemCaracteristica': [
         {
@@ -56,7 +55,6 @@ class TestApiAttime001AtualizacoesDTO(unittest.TestCase):
 
   def test_contrato_and_cobertura_roundtrip(self):
     dto = ApiAttime001AtualizacoesDTO(
-      escopoOperacao=EscopoOperacao.CONTRATO,
       numeroContrato='016501000280',
       manutencaoUsuarioCpf='12345678901',
       contrato=AtualizacaoContratoDto(
@@ -74,7 +72,7 @@ class TestApiAttime001AtualizacoesDTO(unittest.TestCase):
       ],
     )
     data = dto.to_dict()
-    self.assertEqual(data['escopoOperacao'], 'Contrato')
+    self.assertNotIn('escopoOperacao', data)
     self.assertEqual(data['contrato']['sexo'], 'M')
     self.assertEqual(data['contrato']['contratoGarantia'], 'N')
     again = ApiAttime001AtualizacoesDTO.from_dict(data)
@@ -83,17 +81,17 @@ class TestApiAttime001AtualizacoesDTO(unittest.TestCase):
 
 
 class TestAttime001ApiAtualizacoes(unittest.TestCase):
-  def test_requires_escopo_and_numero(self):
+  def test_requires_numero(self):
     from attime.star.apis.attime001 import Attime001Api
 
     with patch.object(Attime001Api, '__init__', lambda self: None):
       api = Attime001Api()
       with self.assertRaises(ValueError):
-        api.atualizacoes({'numeroContrato': '016501000280'})
+        api.atualizacoes({})
       with self.assertRaises(ValueError):
         api.atualizacoes({'escopoOperacao': 'ITEM'})
 
-  def test_posts_to_atualizacoes_path(self):
+  def test_puts_to_atualizacoes_path(self):
     from attime.star.apis.attime001 import Attime001Api
 
     with patch.object(Attime001Api, '__init__', lambda self: None):
@@ -103,22 +101,22 @@ class TestAttime001ApiAtualizacoes(unittest.TestCase):
       with patch('attime.star.apis.attime001.jsonpickle.decode') as decode:
         decode.return_value = [
           {
-            'escopoOperacao': 'ITEM',
             'numeroContrato': '016501000280',
             'item': [{'itemNumero': 1, 'dataFimVigencia': '2027-01-01'}],
           }
         ]
         rows = api.atualizacoes(
           ApiAttime001AtualizacoesDTO(
-            escopoOperacao=EscopoOperacao.ITEM,
             numeroContrato='016501000280',
+            item=[{'itemNumero': 1, 'dataFimVigencia': '2027-01-01'}],
           )
         )
       self.assertEqual(len(rows), 1)
       self.assertEqual(rows[0].item[0].itemNumero, 1)
       kwargs = api.call_request.call_args.kwargs
+      self.assertEqual(kwargs['http_method'], HTTPMethod.PUT)
       self.assertIn('/ABTP0004/ApiAttime001/Atualizacoes', kwargs['request_url'])
-      self.assertEqual(kwargs['payload']['escopoOperacao'], 'Item')
+      self.assertNotIn('escopoOperacao', kwargs['payload'])
 
 
 if __name__ == '__main__':

{attime_star_api_python_sdk-1.8.0 → attime_star_api_python_sdk-1.9.0}/tests/test_attime001_cancelamento.py

@@ -3,12 +3,12 @@
 from __future__ import annotations
 
 import unittest
+from http import HTTPMethod
 from unittest.mock import MagicMock, patch
 
 from attime.star.dtos.attime001 import (
   ApiAttime001CancelamentoDTO,
   DeclinioItemCobertura,
-  EscopoOperacao,
 )
 
 
@@ -19,7 +19,7 @@ class TestApiAttime001CancelamentoDTO(unittest.TestCase):
       identificadorItem='12345678901',
     )
     data = dto.to_dict()
-    self.assertEqual(data['escopoOperacao'], EscopoOperacao.ITEM)
+    self.assertNotIn('escopoOperacao', data)
     self.assertEqual(data['numeroContrato'], '002501000089')
     self.assertEqual(data['identificadorItem'], '12345678901')
     self.assertNotIn('coberturaCodigo', data)
@@ -28,7 +28,6 @@ class TestApiAttime001CancelamentoDTO(unittest.TestCase):
 
   def test_from_dict_roundtrip(self):
     raw = {
-      'escopoOperacao': 'ITEM',
       'numeroContrato': '002501000089',
       'identificadorItem': '999',
       'coberturaCodigo': 81,
@@ -37,11 +36,13 @@ class TestApiAttime001CancelamentoDTO(unittest.TestCase):
     self.assertIsNotNone(dto)
     self.assertEqual(dto.coberturaCodigo, 81)
     self.assertEqual(dto.to_dict()['coberturaCodigo'], 81)
+    self.assertNotIn('escopoOperacao', dto.to_dict())
 
-  def test_for_contrato(self):
+  def test_for_contrato_uses_empty_identificador(self):
     dto = ApiAttime001CancelamentoDTO.for_contrato(numeroContrato='002501000001')
-    self.assertEqual(dto.escopoOperacao, EscopoOperacao.CONTRATO)
-    self.assertIsNone(dto.identificadorItem)
+    data = dto.to_dict()
+    self.assertEqual(data['identificadorItem'], '')
+    self.assertNotIn('escopoOperacao', data)
 
   def test_for_declinio_serializes_nested(self):
     dto = ApiAttime001CancelamentoDTO.for_declinio(
@@ -56,8 +57,7 @@ class TestApiAttime001CancelamentoDTO(unittest.TestCase):
       ],
     )
     data = dto.to_dict()
-    self.assertEqual(data['escopoOperacao'], 'Declinio')
-    self.assertEqual(data['escopoOperacao'], EscopoOperacao.DECLINIO)
+    self.assertNotIn('escopoOperacao', data)
     self.assertEqual(
       data['declinio']['declinioItemCobertura'][0]['coberturaCodigo'], 101
     )
@@ -67,7 +67,6 @@ class TestApiAttime001CancelamentoDTO(unittest.TestCase):
 
   def test_declinio_from_dict_roundtrip(self):
     raw = {
-      'escopoOperacao': 'DECLINIO',
       'numeroContrato': '016501000280',
       'declinio': {
         'declinioItemCobertura': [
@@ -86,41 +85,28 @@ class TestApiAttime001CancelamentoDTO(unittest.TestCase):
 
 
 class TestAttime001ApiCancelamento(unittest.TestCase):
-  def test_requires_escopo_and_numero(self):
+  def test_requires_numero_and_identificador_or_declinio(self):
     from attime.star.apis.attime001 import Attime001Api
 
     with patch.object(Attime001Api, '__init__', lambda self: None):
       api = Attime001Api()
       with self.assertRaises(ValueError):
-        api.cancelamento({'numeroContrato': '002501000001'})
+        api.cancelamento({})
       with self.assertRaises(ValueError):
-        api.cancelamento({'escopoOperacao': 'ITEM'})
-
-  def test_requires_declinio_block(self):
-    from attime.star.apis.attime001 import Attime001Api
-
-    with patch.object(Attime001Api, '__init__', lambda self: None):
-      api = Attime001Api()
-      with self.assertRaises(ValueError) as ctx:
-        api.cancelamento({
-          'escopoOperacao': 'DECLINIO',
-          'numeroContrato': '016501000280',
-        })
-      self.assertIn('declinio', str(ctx.exception))
+        api.cancelamento({'numeroContrato': '002501000001'})
 
-  def test_posts_to_cancelamento_path(self):
+  def test_puts_to_cancelamento_path(self):
     from attime.star.apis.attime001 import Attime001Api
 
     with patch.object(Attime001Api, '__init__', lambda self: None):
       api = Attime001Api()
       api.base_url = 'https://starbackhom.attime.inf.br'
       api.call_request = MagicMock(
-        return_value='[{"escopoOperacao":"ITEM","numeroContrato":"002501000089","identificadorItem":"1"}]'
+        return_value='[{"numeroContrato":"002501000089","identificadorItem":"1"}]'
       )
       with patch('attime.star.apis.attime001.jsonpickle.decode') as decode:
         decode.return_value = [
           {
-            'escopoOperacao': 'ITEM',
             'numeroContrato': '002501000089',
             'identificadorItem': '1',
           }
@@ -134,8 +120,10 @@ class TestAttime001ApiCancelamento(unittest.TestCase):
       self.assertEqual(len(rows), 1)
       self.assertEqual(rows[0].identificadorItem, '1')
       kwargs = api.call_request.call_args.kwargs
+      self.assertEqual(kwargs['http_method'], HTTPMethod.PUT)
       self.assertIn('/ABTP0004/ApiAttime001/Cancelamento', kwargs['request_url'])
-      self.assertEqual(kwargs['payload']['escopoOperacao'], 'Item')
+      self.assertNotIn('escopoOperacao', kwargs['payload'])
+      self.assertEqual(kwargs['payload']['identificadorItem'], '1')
 
 
 if __name__ == '__main__':