positiva-consultas-python-sdk 1.0.0__py3-none-any.whl

positiva/consultas/__init__.py

@@ -0,0 +1,12 @@
+# -*- coding: utf-8 -*-
+"""SDK Python para a API Positiva Consultas (PositivaConnect)."""
+from positiva.consultas.api import PositivaConsultasApi
+from positiva.consultas.apis.juridico360 import Juridico360Api
+from positiva.consultas.dtos.enums import Juridico360ProductCode, MpKind
+
+__all__ = [
+  'PositivaConsultasApi',
+  'Juridico360Api',
+  'Juridico360ProductCode',
+  'MpKind',
+]

positiva/consultas/api.py

@@ -0,0 +1,106 @@
+# -*- coding: utf-8 -*-
+"""Cliente base Positiva Consultas — autenticacao OAuth 2.0 Client Credentials."""
+from __future__ import annotations
+
+import base64
+import logging
+import os
+
+import jsonpickle
+from fmconsult.http.api import ApiBase
+from fmconsult.utils.url import UrlUtil
+from http import HTTPMethod
+
+from positiva.consultas.dtos.auth import (
+  ClientMeResponse,
+  LogoutResponse,
+  TokenResponse,
+)
+
+
+class PositivaConsultasApi(ApiBase):
+  """API base com login automatico via ``POST /client/token`` (Basic Auth).
+
+  Variaveis de ambiente:
+  - ``positiva.consultas.api.client_id``
+  - ``positiva.consultas.api.client_secret``
+  """
+
+  API_BASE_URL = 'https://positivaconnect.positivaconsultas.com.br/api'
+
+  def __init__(self):
+    self.api_client_id = os.environ['positiva.consultas.api.client_id']
+    self.api_client_secret = os.environ['positiva.consultas.api.client_secret']
+    self.base_url = self.API_BASE_URL
+    self.access_token: str | None = None
+    self.token_expires_in: int | None = None
+    self.headers: dict[str, str] = {
+      'Accept': 'application/json',
+    }
+    self.__login()
+
+  def __basic_auth_header(self) -> str:
+    raw = f'{self.api_client_id}:{self.api_client_secret}'.encode()
+    return f'Basic {base64.b64encode(raw).decode()}'
+
+  def __apply_bearer(self, access_token: str, expires_in: int | None = None) -> None:
+    self.access_token = access_token
+    self.token_expires_in = expires_in
+    self.headers['Authorization'] = f'Bearer {access_token}'
+
+  def __login(self) -> TokenResponse:
+    """POST /client/token — Authorization Basic (client_id:client_secret)."""
+    logging.info('authenticating via Positiva Consultas /client/token...')
+    self.headers = {
+      'Accept': 'application/json',
+      'Authorization': self.__basic_auth_header(),
+    }
+    url = UrlUtil().make_url(self.base_url, ['client', 'token'])
+    res = self.call_request(http_method=HTTPMethod.POST, request_url=url)
+    data = jsonpickle.decode(res)
+    token = TokenResponse.from_dict(data)
+    if token is None or not token.access_token:
+      raise Exception(
+        data.get('error_description')
+        or data.get('message')
+        or 'Falha ao obter access_token'
+      )
+    self.__apply_bearer(token.access_token, token.expires_in)
+    return token
+
+  def me(self) -> ClientMeResponse:
+    """GET /client/me — dados do cliente autenticado."""
+    logging.info('fetching Positiva Consultas /client/me...')
+    url = UrlUtil().make_url(self.base_url, ['client', 'me'])
+    res = self.call_request(http_method=HTTPMethod.GET, request_url=url)
+    parsed = ClientMeResponse.from_dict(jsonpickle.decode(res))
+    if parsed is None or parsed.client is None:
+      raise Exception('Resposta inesperada de /client/me')
+    return parsed
+
+  def refresh(self) -> TokenResponse:
+    """POST /client/refresh — renova o Bearer atual."""
+    logging.info('refreshing Positiva Consultas token...')
+    url = UrlUtil().make_url(self.base_url, ['client', 'refresh'])
+    res = self.call_request(http_method=HTTPMethod.POST, request_url=url)
+    data = jsonpickle.decode(res)
+    token = TokenResponse.from_dict(data)
+    if token is None or not token.access_token:
+      raise Exception(
+        data.get('error_description')
+        or data.get('message')
+        or 'Falha ao renovar access_token'
+      )
+    self.__apply_bearer(token.access_token, token.expires_in)
+    return token
+
+  def logout(self) -> LogoutResponse:
+    """POST /client/logout — invalida o token atual."""
+    logging.info('logging out Positiva Consultas token...')
+    url = UrlUtil().make_url(self.base_url, ['client', 'logout'])
+    res = self.call_request(http_method=HTTPMethod.POST, request_url=url)
+    parsed = LogoutResponse.from_dict(jsonpickle.decode(res))
+    self.access_token = None
+    self.token_expires_in = None
+    self.headers.pop('Authorization', None)
+    return parsed or LogoutResponse()

positiva/consultas/apis/__init__.py

@@ -0,0 +1,4 @@
+# -*- coding: utf-8 -*-
+from positiva.consultas.apis.juridico360 import Juridico360Api
+
+__all__ = ['Juridico360Api']

positiva/consultas/apis/juridico360.py

@@ -0,0 +1,169 @@
+# -*- coding: utf-8 -*-
+"""Cliente HTTP Positiva Juridico 360."""
+from __future__ import annotations
+
+import logging
+from typing import Sequence
+
+import jsonpickle
+from fmconsult.utils.url import UrlUtil
+from http import HTTPMethod
+
+from positiva.consultas.api import PositivaConsultasApi
+from positiva.consultas.dtos.enums import Juridico360ProductCode
+from positiva.consultas.dtos.juridico360 import (
+  Juridico360Options,
+  Juridico360PdfResponse,
+  Juridico360Request,
+  Juridico360Response,
+)
+from positiva.consultas.dtos.serde import digits_only, to_wire
+
+_VALID_PRODUCTS = {p.value for p in Juridico360ProductCode}
+
+
+def _normalize_product_codes(
+  product_code: Sequence[str | Juridico360ProductCode],
+) -> list[str]:
+  if not product_code:
+    raise ValueError('product_code é obrigatório e não pode ser vazio')
+  normalized: list[str] = []
+  for code in product_code:
+    value = str(to_wire(code))
+    if value not in _VALID_PRODUCTS:
+      raise ValueError(
+        f'product_code inválido: {value!r}. '
+        f'Valores aceitos: {sorted(_VALID_PRODUCTS)}'
+      )
+    if value not in normalized:
+      normalized.append(value)
+  return normalized
+
+
+def _require_document(document: str | None) -> str:
+  digits = digits_only(document)
+  if len(digits) not in (11, 14):
+    raise ValueError(
+      'document deve ser CPF (11 dígitos) ou CNPJ (14 dígitos)'
+    )
+  return digits
+
+
+def _coerce_request(
+  request: Juridico360Request | dict,
+) -> Juridico360Request:
+  if isinstance(request, Juridico360Request):
+    return request
+  parsed = Juridico360Request.from_dict(request)
+  if parsed is None:
+    raise ValueError('request inválido')
+  return parsed
+
+
+class Juridico360Api(PositivaConsultasApi):
+  """Consulta processual Positiva Juridico 360."""
+
+  def consultar(
+    self, request: Juridico360Request | dict
+  ) -> Juridico360Response:
+    """POST /api/client/provider/juridico360."""
+    logging.info('consulting Positiva Juridico 360...')
+    req = _coerce_request(request)
+    payload = {
+      'document': _require_document(req.document),
+      'product_code': _normalize_product_codes(req.product_code),
+    }
+    if req.options is not None:
+      options = req.options.to_dict() if isinstance(req.options, Juridico360Options) else dict(req.options)
+      if options:
+        if options.get('page_size') is not None and int(options['page_size']) > 100:
+          raise ValueError('options.page_size máximo é 100')
+        payload['options'] = options
+
+    url = UrlUtil().make_url(
+      self.base_url, ['client', 'provider', 'juridico360']
+    )
+    res = self.call_request(
+      http_method=HTTPMethod.POST,
+      request_url=url,
+      payload=payload,
+    )
+    parsed = Juridico360Response.from_dict(jsonpickle.decode(res))
+    if parsed is None:
+      raise Exception('Resposta inesperada de Juridico 360')
+    return parsed
+
+  def consultar_por_documento(
+    self,
+    document: str,
+    product_code: Sequence[str | Juridico360ProductCode],
+    *,
+    options: Juridico360Options | dict | None = None,
+  ) -> Juridico360Response:
+    """Atalho tipado para ``consultar``."""
+    opts = None
+    if isinstance(options, Juridico360Options):
+      opts = options
+    elif isinstance(options, dict):
+      opts = Juridico360Options.from_dict(options)
+    return self.consultar(
+      Juridico360Request(
+        document=document,
+        product_code=list(product_code),
+        options=opts,
+      )
+    )
+
+  def gerar_pdf(
+    self,
+    request: Juridico360Request | dict | None = None,
+    *,
+    document: str | None = None,
+    product_code: Sequence[str | Juridico360ProductCode] | None = None,
+    options: Juridico360Options | dict | None = None,
+  ) -> Juridico360PdfResponse:
+    """POST /api/client/provider/juridico360/pdf — retorna PDF em Base64."""
+    logging.info('generating Positiva Juridico 360 PDF...')
+    if request is not None:
+      req = _coerce_request(request)
+    else:
+      if document is None or product_code is None:
+        raise ValueError(
+          'informe request ou (document + product_code) para gerar PDF'
+        )
+      opts = None
+      if isinstance(options, Juridico360Options):
+        opts = options
+      elif isinstance(options, dict):
+        opts = Juridico360Options.from_dict(options)
+      req = Juridico360Request(
+        document=document,
+        product_code=list(product_code),
+        options=opts,
+      )
+
+    payload = {
+      'document': _require_document(req.document),
+      'product_code': _normalize_product_codes(req.product_code),
+    }
+    if req.options is not None:
+      options_dict = (
+        req.options.to_dict()
+        if isinstance(req.options, Juridico360Options)
+        else dict(req.options)
+      )
+      if options_dict:
+        payload['options'] = options_dict
+
+    url = UrlUtil().make_url(
+      self.base_url, ['client', 'provider', 'juridico360', 'pdf']
+    )
+    res = self.call_request(
+      http_method=HTTPMethod.POST,
+      request_url=url,
+      payload=payload,
+    )
+    parsed = Juridico360PdfResponse.from_dict(jsonpickle.decode(res))
+    if parsed is None:
+      raise Exception('Resposta inesperada de Juridico 360 PDF')
+    return parsed

positiva/consultas/dtos/__init__.py

@@ -0,0 +1,40 @@
+# -*- coding: utf-8 -*-
+from positiva.consultas.dtos.auth import (
+  AvailableProduct,
+  ClientInfo,
+  ClientMeResponse,
+  LogoutResponse,
+  ProductFeature,
+  ProviderProduct,
+  TokenResponse,
+)
+from positiva.consultas.dtos.enums import DocumentType, Juridico360ProductCode, MpKind
+from positiva.consultas.dtos.juridico360 import (
+  Juridico360Options,
+  Juridico360PdfResponse,
+  Juridico360ProductData,
+  Juridico360ProductResult,
+  Juridico360Request,
+  Juridico360Response,
+  PenaPrevista,
+)
+
+__all__ = [
+  'AvailableProduct',
+  'ClientInfo',
+  'ClientMeResponse',
+  'DocumentType',
+  'Juridico360Options',
+  'Juridico360PdfResponse',
+  'Juridico360ProductCode',
+  'Juridico360ProductData',
+  'Juridico360ProductResult',
+  'Juridico360Request',
+  'Juridico360Response',
+  'LogoutResponse',
+  'MpKind',
+  'PenaPrevista',
+  'ProductFeature',
+  'ProviderProduct',
+  'TokenResponse',
+]

positiva/consultas/dtos/auth.py

@@ -0,0 +1,173 @@
+# -*- coding: utf-8 -*-
+"""DTOs de autenticacao (/client/token, /client/me, /client/refresh, /client/logout)."""
+from __future__ import annotations
+
+from dataclasses import dataclass
+
+from positiva.consultas.dtos.serde import as_wire_dict, from_dataclass, omit_none, to_wire
+
+
+@dataclass
+class ProductFeature:
+  code: str | None = None
+  name: str | None = None
+
+  def to_dict(self) -> dict:
+    return as_wire_dict(self)
+
+  @classmethod
+  def from_dict(cls, data: dict | ProductFeature | None) -> ProductFeature | None:
+    return from_dataclass(cls, data)
+
+
+@dataclass
+class AvailableProduct:
+  code: str | None = None
+  name: str | None = None
+  has_additionals: bool | None = None
+  features: list[ProductFeature] | None = None
+
+  def to_dict(self) -> dict:
+    return omit_none({
+      'code': self.code,
+      'name': self.name,
+      'has_additionals': self.has_additionals,
+      'features': to_wire(self.features),
+    })
+
+  @classmethod
+  def from_dict(cls, data: dict | AvailableProduct | None) -> AvailableProduct | None:
+    if data is None:
+      return None
+    if isinstance(data, cls):
+      return data
+    if not isinstance(data, dict):
+      raise TypeError(f'AvailableProduct.from_dict espera dict, recebeu {type(data)!r}')
+    features = data.get('features')
+    return cls(
+      code=data.get('code'),
+      name=data.get('name'),
+      has_additionals=data.get('has_additionals'),
+      features=[ProductFeature.from_dict(f) for f in features] if features else None,
+    )
+
+
+@dataclass
+class ProviderProduct:
+  """Produto de provider (ex.: Juridico 360) exposto em ``provider_products``."""
+
+  code: str | None = None
+  name: str | None = None
+
+  def to_dict(self) -> dict:
+    return as_wire_dict(self)
+
+  @classmethod
+  def from_dict(cls, data: dict | ProviderProduct | None) -> ProviderProduct | None:
+    return from_dataclass(cls, data)
+
+
+@dataclass
+class ClientInfo:
+  name: str | None = None
+  email: str | None = None
+  cnpj: str | None = None
+  phone: str | None = None
+  active: bool | None = None
+
+  def to_dict(self) -> dict:
+    return as_wire_dict(self)
+
+  @classmethod
+  def from_dict(cls, data: dict | ClientInfo | None) -> ClientInfo | None:
+    return from_dataclass(cls, data)
+
+
+@dataclass
+class TokenResponse:
+  access_token: str | None = None
+  token_type: str | None = None
+  expires_in: int | None = None
+  client: ClientInfo | None = None
+  products: list[AvailableProduct] | None = None
+  # Ambiente por provider, ex.: {"juridico360": "homolog"|"production"}
+  provider_environments: dict[str, str] | None = None
+  # Produtos contratados por provider, ex.: {"juridico360": [{"code","name"}, ...]}
+  provider_products: dict[str, list[ProviderProduct]] | None = None
+
+  def to_dict(self) -> dict:
+    return omit_none({
+      'access_token': self.access_token,
+      'token_type': self.token_type,
+      'expires_in': self.expires_in,
+      'client': to_wire(self.client),
+      'products': to_wire(self.products),
+      'provider_environments': self.provider_environments,
+      'provider_products': {
+        key: to_wire(value)
+        for key, value in (self.provider_products or {}).items()
+      }
+      if self.provider_products is not None
+      else None,
+    })
+
+  @classmethod
+  def from_dict(cls, data: dict | TokenResponse | None) -> TokenResponse | None:
+    if data is None:
+      return None
+    if isinstance(data, cls):
+      return data
+    if not isinstance(data, dict):
+      raise TypeError(f'TokenResponse.from_dict espera dict, recebeu {type(data)!r}')
+    products = data.get('products')
+    raw_provider_products = data.get('provider_products')
+    provider_products = None
+    if isinstance(raw_provider_products, dict):
+      provider_products = {
+        key: [
+          ProviderProduct.from_dict(item)
+          for item in (value or [])
+          if isinstance(item, dict)
+        ]
+        for key, value in raw_provider_products.items()
+      }
+    environments = data.get('provider_environments')
+    return cls(
+      access_token=data.get('access_token'),
+      token_type=data.get('token_type'),
+      expires_in=data.get('expires_in'),
+      client=ClientInfo.from_dict(data.get('client')),
+      products=[AvailableProduct.from_dict(p) for p in products] if products else None,
+      provider_environments=dict(environments) if isinstance(environments, dict) else None,
+      provider_products=provider_products,
+    )
+
+
+@dataclass
+class ClientMeResponse:
+  client: ClientInfo | None = None
+
+  def to_dict(self) -> dict:
+    return omit_none({'client': to_wire(self.client)})
+
+  @classmethod
+  def from_dict(cls, data: dict | ClientMeResponse | None) -> ClientMeResponse | None:
+    if data is None:
+      return None
+    if isinstance(data, cls):
+      return data
+    if not isinstance(data, dict):
+      raise TypeError(f'ClientMeResponse.from_dict espera dict, recebeu {type(data)!r}')
+    return cls(client=ClientInfo.from_dict(data.get('client')))
+
+
+@dataclass
+class LogoutResponse:
+  message: str | None = None
+
+  def to_dict(self) -> dict:
+    return as_wire_dict(self)
+
+  @classmethod
+  def from_dict(cls, data: dict | LogoutResponse | None) -> LogoutResponse | None:
+    return from_dataclass(cls, data)

positiva/consultas/dtos/enums.py

@@ -0,0 +1,28 @@
+# -*- coding: utf-8 -*-
+"""Enums de domínio da API Positiva Consultas."""
+from __future__ import annotations
+
+from enum import StrEnum
+
+
+class Juridico360ProductCode(StrEnum):
+  """Codigos de produto do endpoint Juridico 360."""
+
+  CRIMINAL = 'CRIMINAL'
+  CIVIL = 'CIVIL'
+  TRABALHISTA = 'TRABALHISTA'
+  MP = 'MP'
+  BNMP = 'BNMP'
+  EMPREGADOR_IRREGULAR = 'EMPREGADOR_IRREGULAR'
+
+
+class MpKind(StrEnum):
+  """Filtro opcional ``options.kind`` para produtos MP/BNMP."""
+
+  CRIMINAL = 'CRIMINAL'
+  CIVIL = 'CIVIL'
+
+
+class DocumentType(StrEnum):
+  CPF = 'CPF'
+  CNPJ = 'CNPJ'