sienge-python 0.1.0__py3-none-any.whl

sienge/endpoints/comercial.py

@@ -0,0 +1,237 @@
+"""
+sienge.endpoints.comercial — Endpoints Comerciais (clientes, contratos, unidades).
+"""
+
+from __future__ import annotations
+
+from typing import Iterator
+
+from .base import BaseEndpoints
+from ..models.comercial import Cliente, Unidade
+from ..utils import paginate
+
+
+class ComercialEndpoints(BaseEndpoints):
+    """Endpoints Comerciais: clientes, contratos de venda, unidades."""
+
+    # ── Clientes ───────────────────────────────────────────────────────
+
+    def list_clientes(self, limit: int | None = None) -> list[Cliente]:
+        """Lista clientes.
+
+        Args:
+            limit: Limite de resultados (None = todos).
+
+        Returns:
+            Lista de Cliente.
+        """
+        return list(self.iter_clientes(max_results=limit))
+
+    def iter_clientes(self, max_results: int | None = None) -> Iterator[Cliente]:
+        """Itera sobre clientes com paginacao.
+
+        Yields:
+            Cliente.
+        """
+        def fetch(offset: int, limit: int) -> dict:
+            return self._get("/customers", params={"offset": offset, "limit": limit})
+
+        for item in paginate(fetch, max_results=max_results):
+            yield Cliente.from_api(item)
+
+    def get_cliente(self, client_id: int) -> Cliente:
+        """Busca um cliente pelo ID.
+
+        Args:
+            client_id: ID do cliente.
+
+        Returns:
+            Cliente.
+        """
+        data = self._get(f"/customers/{client_id}")
+        return Cliente.from_api(data)
+
+    def search_clientes(self, nome: str) -> list[Cliente]:
+        """Busca clientes pelo nome.
+
+        Args:
+            nome: Nome ou parte do nome.
+
+        Returns:
+            Lista de Cliente.
+        """
+        data = self._get("/customers", params={"name": nome})
+        results = data.get("results", data if isinstance(data, list) else [])
+        return [Cliente.from_api(r) for r in results]
+
+    # ── Contratos de Venda (/sales-contracts) ───────────────────────────
+
+    def list_contratos_venda(
+        self,
+        limit: int | None = None,
+    ) -> list[dict]:
+        """Lista contratos de venda.
+
+        NOTA: /contracts NAO EXISTE. Usar /sales-contracts.
+        Para contratos de suprimentos, usar SuprimentosEndpoints.
+
+        Args:
+            limit: Limite de resultados.
+
+        Returns:
+            Lista de dicts com contratos.
+        """
+        params: dict = {}
+        if limit:
+            params["limit"] = min(limit, 200)
+
+        data = self._get("/sales-contracts", params=params)
+        results = data.get("results", data if isinstance(data, list) else [])
+        return results
+
+    def get_contrato_venda(self, contract_id: int) -> dict:
+        """Busca um contrato de venda pelo ID.
+
+        Args:
+            contract_id: ID do contrato.
+
+        Returns:
+            Dict com dados do contrato.
+        """
+        return self._get(f"/sales-contracts/{contract_id}")
+
+    # ── Contas a Receber (/accounts-receivable) ──────────────────────
+
+    def list_titulos_receber(
+        self,
+        customer_id: int,
+        company_id: int | None = None,
+        cost_center_id: int | None = None,
+        limit: int | None = None,
+    ) -> list[dict]:
+        """Lista titulos a receber de um cliente.
+
+        NOTA: /receivable-bills NAO EXISTE.
+        Endpoint correto: /accounts-receivable/receivable-bills
+
+        Args:
+            customer_id: ID do cliente (OBRIGATORIO).
+            company_id: ID da empresa (opcional).
+            cost_center_id: ID do centro de custo (opcional).
+            limit: Limite de resultados.
+
+        Returns:
+            Lista de dicts com titulos a receber.
+        """
+        params: dict = {"customerId": customer_id}
+        if company_id:
+            params["companyId"] = company_id
+        if cost_center_id:
+            params["costCenterId"] = cost_center_id
+        if limit:
+            params["limit"] = min(limit, 200)
+
+        data = self._get("/accounts-receivable/receivable-bills", params=params)
+        results = data.get("results", data if isinstance(data, list) else [])
+        return results
+
+    # ── Unidades ───────────────────────────────────────────────────────
+
+    def list_unidades(
+        self,
+        building_id: int | None = None,
+        limit: int | None = None,
+    ) -> list[Unidade]:
+        """Lista unidades imobiliarias.
+
+        Args:
+            building_id: Filtrar por obra.
+            limit: Limite de resultados.
+
+        Returns:
+            Lista de Unidade.
+        """
+        params: dict = {}
+        if building_id:
+            params["buildingId"] = building_id
+        if limit:
+            params["limit"] = min(limit, 200)
+
+        data = self._get("/units", params=params)
+        results = data.get("results", data if isinstance(data, list) else [])
+        return [Unidade.from_api(r) for r in results]
+
+    def get_unidade(self, unit_id: int) -> Unidade:
+        """Busca uma unidade pelo ID.
+
+        Args:
+            unit_id: ID da unidade.
+
+        Returns:
+            Unidade.
+        """
+        data = self._get(f"/units/{unit_id}")
+        return Unidade.from_api(data)
+
+    # ── Tipos de Cliente (/customer-types) ───────────────────────────
+
+    def list_tipos_cliente(self) -> list[dict]:
+        """Lista tipos de cliente cadastrados.
+
+        Returns:
+            Lista de dicts com tipos de cliente.
+        """
+        data = self._get("/customer-types")
+        return data.get("results", data if isinstance(data, list) else [])
+
+    # ── Unidades — Detalhes Imobiliarios ─────────────────────────────
+
+    def list_caracteristicas_unidades(self) -> list[dict]:
+        """Lista caracteristicas de unidades imobiliarias.
+
+        Returns:
+            Lista de dicts com caracteristicas.
+        """
+        data = self._get("/units/characteristics")
+        return data.get("results", data if isinstance(data, list) else [])
+
+    def list_situacoes_unidades(self) -> list[dict]:
+        """Lista situacoes possiveis de unidades.
+
+        Returns:
+            Lista de dicts com situacoes.
+        """
+        data = self._get("/units/situations")
+        return data.get("results", data if isinstance(data, list) else [])
+
+    def list_tipos_imovel(self) -> list[dict]:
+        """Lista tipos de imovel.
+
+        Returns:
+            Lista de dicts com tipos (4 na CONIN).
+        """
+        data = self._get("/property-types")
+        return data.get("results", data if isinstance(data, list) else [])
+
+    def get_mapa_imobiliario(
+        self,
+        cost_center_id: int,
+        start_date: str,
+        end_date: str,
+    ) -> list[dict]:
+        """Busca mapa imobiliario (quadro de areas).
+
+        Args:
+            cost_center_id: ID do centro de custo (OBRIGATORIO).
+            start_date: Data inicio (YYYY-MM-DD).
+            end_date: Data fim (YYYY-MM-DD).
+
+        Returns:
+            Lista de dicts com dados do mapa.
+        """
+        data = self._get("/real-estate-map", params={
+            "costCentersId": cost_center_id,
+            "startDate": start_date,
+            "endDate": end_date,
+        })
+        return data.get("results", data if isinstance(data, list) else [])

sienge/endpoints/contabilidade.py

@@ -0,0 +1,165 @@
+"""
+sienge.endpoints.contabilidade — Endpoints de Contabilidade (lancamentos, plano de contas, lotes, empresas).
+"""
+
+from __future__ import annotations
+
+from datetime import datetime, timedelta
+from typing import Iterator
+
+from .base import BaseEndpoints
+from ..models.financeiro import ContaContabil, LancamentoContabil
+from ..utils import paginate
+
+
+class ContabilidadeEndpoints(BaseEndpoints):
+    """Endpoints de Contabilidade: lancamentos, plano de contas, lotes, empresas."""
+
+    # ── Lancamentos (/accountancy/entries) ───────────────────────────
+
+    def list_lancamentos(
+        self,
+        company_id: int,
+        start_date: str | None = None,
+        end_date: str | None = None,
+        limit: int | None = None,
+    ) -> list[LancamentoContabil]:
+        """Lista lancamentos contabeis.
+
+        Args:
+            company_id: ID da empresa (OBRIGATORIO).
+            start_date: Data inicio (YYYY-MM-DD). Default: 30 dias atras.
+            end_date: Data fim (YYYY-MM-DD). Default: hoje.
+            limit: Limite de resultados (None = todos).
+
+        Returns:
+            Lista de LancamentoContabil.
+        """
+        return list(self.iter_lancamentos(company_id, start_date, end_date, max_results=limit))
+
+    def iter_lancamentos(
+        self,
+        company_id: int,
+        start_date: str | None = None,
+        end_date: str | None = None,
+        max_results: int | None = None,
+    ) -> Iterator[LancamentoContabil]:
+        """Itera sobre lancamentos contabeis com paginacao automatica.
+
+        Args:
+            company_id: ID da empresa (OBRIGATORIO).
+            start_date: Data inicio (YYYY-MM-DD).
+            end_date: Data fim (YYYY-MM-DD).
+            max_results: Limite total.
+
+        Yields:
+            LancamentoContabil.
+        """
+        if not start_date:
+            start_date = (datetime.now() - timedelta(days=30)).strftime("%Y-%m-%d")
+        if not end_date:
+            end_date = datetime.now().strftime("%Y-%m-%d")
+
+        def fetch(offset: int, limit: int) -> dict:
+            return self._get("/accountancy/entries", params={
+                "companyId": company_id,
+                "startDate": start_date,
+                "endDate": end_date,
+                "offset": offset,
+                "limit": limit,
+            })
+
+        for item in paginate(fetch, max_results=max_results):
+            yield LancamentoContabil.from_api(item)
+
+    # ── Plano de Contas (/accountancy/accounts) ──────────────────────
+
+    def list_plano_contas(self, limit: int | None = None) -> list[ContaContabil]:
+        """Lista contas do plano de contas.
+
+        Args:
+            limit: Limite de resultados (None = todas, 8.235 na CONIN).
+
+        Returns:
+            Lista de ContaContabil.
+        """
+        return list(self.iter_plano_contas(max_results=limit))
+
+    def iter_plano_contas(self, max_results: int | None = None) -> Iterator[ContaContabil]:
+        """Itera sobre contas do plano de contas.
+
+        Yields:
+            ContaContabil.
+        """
+        def fetch(offset: int, limit: int) -> dict:
+            return self._get("/accountancy/accounts", params={"offset": offset, "limit": limit})
+
+        for item in paginate(fetch, max_results=max_results):
+            yield ContaContabil.from_api(item)
+
+    # ── Lotes Contabeis (/batch) ─────────────────────────────────────
+
+    def list_lotes(
+        self,
+        company_id: int,
+        start_date: str | None = None,
+        end_date: str | None = None,
+        limit: int | None = None,
+    ) -> list[dict]:
+        """Lista lotes contabeis.
+
+        Args:
+            company_id: ID da empresa (OBRIGATORIO).
+            start_date: Data inicio (YYYY-MM-DD). Default: 30 dias atras.
+            end_date: Data fim (YYYY-MM-DD). Default: hoje.
+            limit: Limite de resultados.
+
+        Returns:
+            Lista de dicts com lotes.
+        """
+        if not start_date:
+            start_date = (datetime.now() - timedelta(days=30)).strftime("%Y-%m-%d")
+        if not end_date:
+            end_date = datetime.now().strftime("%Y-%m-%d")
+
+        params: dict = {
+            "companyId": company_id,
+            "startDate": start_date,
+            "endDate": end_date,
+        }
+        if limit:
+            params["limit"] = min(limit, 200)
+        data = self._get("/batch", params=params)
+        return data.get("results", data if isinstance(data, list) else [])
+
+    # ── Fechamento Contabil (/closingaccountancy) ────────────────────
+
+    def get_fechamento(self, month_year: str) -> dict:
+        """Busca status de fechamento contabil de um periodo.
+
+        NOTA: Path correto e /closingaccountancy (NAO /accountancy/closing).
+
+        Args:
+            month_year: Periodo no formato YYYY-MM (OBRIGATORIO).
+
+        Returns:
+            Dict com dados do fechamento.
+        """
+        return self._get("/closingaccountancy", params={"monthYear": month_year})
+
+    # ── Empresas (/companies) ────────────────────────────────────────
+
+    def list_empresas(self, limit: int | None = None) -> list[dict]:
+        """Lista empresas cadastradas no Sienge.
+
+        Args:
+            limit: Limite de resultados.
+
+        Returns:
+            Lista de dicts com empresas (10 na CONIN).
+        """
+        params: dict = {}
+        if limit:
+            params["limit"] = min(limit, 200)
+        data = self._get("/companies", params=params)
+        return data.get("results", data if isinstance(data, list) else [])

sienge/endpoints/credores.py

@@ -0,0 +1,75 @@
+"""
+sienge.endpoints.credores — Endpoints de Credores (fornecedores).
+"""
+
+from __future__ import annotations
+
+from typing import Iterator
+
+from .base import BaseEndpoints
+from ..models.credores import Credor
+from ..utils import paginate
+
+
+class CredoresEndpoints(BaseEndpoints):
+    """Endpoints de Credores/Fornecedores."""
+
+    def list_credores(self, limit: int | None = None) -> list[Credor]:
+        """Lista credores/fornecedores.
+
+        Args:
+            limit: Limite de resultados (None = todos).
+
+        Returns:
+            Lista de Credor.
+        """
+        return list(self.iter_credores(max_results=limit))
+
+    def iter_credores(self, max_results: int | None = None) -> Iterator[Credor]:
+        """Itera sobre credores com paginacao.
+
+        Yields:
+            Credor.
+        """
+        def fetch(offset: int, limit: int) -> dict:
+            return self._get("/creditors", params={"offset": offset, "limit": limit})
+
+        for item in paginate(fetch, max_results=max_results):
+            yield Credor.from_api(item)
+
+    def get_credor(self, creditor_id: int) -> Credor:
+        """Busca um credor pelo ID.
+
+        Args:
+            creditor_id: ID do credor.
+
+        Returns:
+            Credor.
+        """
+        data = self._get(f"/creditors/{creditor_id}")
+        return Credor.from_api(data)
+
+    def search_credores(self, nome: str) -> list[Credor]:
+        """Busca credores pelo nome.
+
+        Args:
+            nome: Nome ou parte do nome.
+
+        Returns:
+            Lista de Credor.
+        """
+        data = self._get("/creditors", params={"name": nome})
+        results = data.get("results", data if isinstance(data, list) else [])
+        return [Credor.from_api(r) for r in results]
+
+    def get_info_bancaria(self, creditor_id: int) -> list[dict]:
+        """Lista informacoes bancarias de um credor.
+
+        Args:
+            creditor_id: ID do credor.
+
+        Returns:
+            Lista de dicts com dados bancarios.
+        """
+        data = self._get(f"/creditors/{creditor_id}/bank-accounts")
+        return data.get("results", data if isinstance(data, list) else [])

sienge/endpoints/engenharia.py

@@ -0,0 +1,200 @@
+"""
+sienge.endpoints.engenharia — Endpoints de Engenharia (empreendimentos, centros de custo como obras).
+
+IMPORTANTE: O Sienge NAO tem endpoint /buildings.
+- "Obras" no Sienge sao representadas como /enterprises (empreendimentos)
+- Centros de custo (/cost-centers) tambem representam obras
+- Pedidos de compra (/purchase-orders) referenciam buildingId = centro de custo
+"""
+
+from __future__ import annotations
+
+from typing import Iterator
+
+from .base import BaseEndpoints
+from ..models.obra import Obra
+from ..utils import paginate
+
+
+class EngenhariaEndpoints(BaseEndpoints):
+    """Endpoints de Engenharia: empreendimentos (obras), centros de custo."""
+
+    # ── Empreendimentos (/enterprises) ─────────────────────────────────
+    # Este e o conceito de "obra" no Sienge
+
+    def list_obras(self, limit: int | None = None) -> list[Obra]:
+        """Lista empreendimentos (obras/projetos).
+
+        No Sienge, obras sao "enterprises" (empreendimentos).
+        Retornados via GET /enterprises.
+
+        Args:
+            limit: Limite de resultados (None = todos via paginacao).
+
+        Returns:
+            Lista de Obra.
+        """
+        return list(self.iter_obras(max_results=limit))
+
+    def iter_obras(self, max_results: int | None = None) -> Iterator[Obra]:
+        """Itera sobre empreendimentos com paginacao automatica.
+
+        Yields:
+            Obra.
+        """
+        def fetch(offset: int, limit: int) -> dict:
+            return self._get("/enterprises", params={"offset": offset, "limit": limit})
+
+        for item in paginate(fetch, max_results=max_results):
+            yield Obra.from_api(item)
+
+    def get_obra(self, enterprise_id: int) -> Obra:
+        """Busca um empreendimento pelo ID.
+
+        Args:
+            enterprise_id: ID do empreendimento no Sienge.
+
+        Returns:
+            Obra.
+        """
+        data = self._get(f"/enterprises/{enterprise_id}")
+        return Obra.from_api(data)
+
+    def search_obra(self, nome: str) -> list[Obra]:
+        """Busca empreendimentos pelo nome.
+
+        Filtra localmente pois /enterprises nao tem parametro de busca por nome.
+
+        Args:
+            nome: Nome ou parte do nome.
+
+        Returns:
+            Lista de Obra encontradas.
+        """
+        nome_lower = nome.lower()
+        results = []
+        for obra in self.iter_obras():
+            if nome_lower in obra.nome.lower():
+                results.append(obra)
+            if len(results) >= 50:  # limite de seguranca
+                break
+        return results
+
+    # ── Orcamentos de Obra (/building-cost-estimations) ──────────────
+
+    def list_orcamento_planilhas(self, building_id: int) -> list[dict]:
+        """Lista planilhas do orcamento de uma obra.
+
+        Args:
+            building_id: ID do empreendimento.
+
+        Returns:
+            Lista de dicts com planilhas.
+        """
+        data = self._get(f"/building-cost-estimations/{building_id}/sheets")
+        return data.get("results", data if isinstance(data, list) else [])
+
+    def list_orcamento_insumos(self, building_id: int, limit: int | None = None) -> list[dict]:
+        """Lista insumos do orcamento de uma obra.
+
+        Args:
+            building_id: ID do empreendimento.
+            limit: Limite de resultados.
+
+        Returns:
+            Lista de dicts com insumos (631 para building_id=1 na CONIN).
+        """
+        params: dict = {}
+        if limit:
+            params["limit"] = min(limit, 200)
+        data = self._get(f"/building-cost-estimations/{building_id}/resources", params=params)
+        return data.get("results", data if isinstance(data, list) else [])
+
+    # ── Diario de Obra (/construction-daily-report) ──────────────────
+
+    def list_diarios_obra(self, limit: int | None = None) -> list[dict]:
+        """Lista diarios de obra.
+
+        NOTA: Path correto e /construction-daily-report (singular).
+        /construction-daily-reports (plural) retorna 404.
+
+        Args:
+            limit: Limite de resultados.
+
+        Returns:
+            Lista de dicts com diarios.
+        """
+        params: dict = {}
+        if limit:
+            params["limit"] = min(limit, 200)
+        data = self._get("/construction-daily-report", params=params)
+        return data.get("results", data if isinstance(data, list) else [])
+
+    # ── Calendario de Obra (/building-projects/{id}/calendar) ────────
+
+    def get_calendario_obra(self, building_id: int) -> dict:
+        """Busca calendario de uma obra.
+
+        NOTA: /building-calendar NAO EXISTE.
+        Path correto: /building-projects/{buildingId}/calendar
+
+        Args:
+            building_id: ID do empreendimento.
+
+        Returns:
+            Dict com configuracao do calendario.
+        """
+        return self._get(f"/building-projects/{building_id}/calendar")
+
+    # ── Tipos de Evento de Diario (/construction-daily-report/event-type) ──
+
+    def list_tipos_evento_diario(self) -> list[dict]:
+        """Lista tipos de evento para diario de obra.
+
+        Returns:
+            Lista de dicts com tipos de evento.
+        """
+        data = self._get("/construction-daily-report/event-type")
+        return data.get("results", data if isinstance(data, list) else [])
+
+    # ── Progresso de Obra (/building-projects/progress-logs) ─────────
+
+    def list_progresso_obra(self, limit: int | None = None) -> list[dict]:
+        """Lista logs de progresso de obras.
+
+        Args:
+            limit: Limite de resultados.
+
+        Returns:
+            Lista de dicts com logs de progresso.
+        """
+        params: dict = {}
+        if limit:
+            params["limit"] = min(limit, 200)
+        data = self._get("/building-projects/progress-logs", params=params)
+        return data.get("results", data if isinstance(data, list) else [])
+
+    # ── Canteiros de Obra (/sites) ───────────────────────────────────
+
+    def list_canteiros(self, building_id: int) -> list[dict]:
+        """Lista canteiros de obra.
+
+        Args:
+            building_id: ID do empreendimento (OBRIGATORIO).
+
+        Returns:
+            Lista de dicts com canteiros.
+        """
+        data = self._get("/sites", params={"buildingId": building_id})
+        return data.get("results", data if isinstance(data, list) else [])
+
+    # ── Bases de Custo (/cost-databases) ─────────────────────────────
+
+    def list_bases_custo(self) -> list[dict]:
+        """Lista bases de referencia de custo (SINAPI, SICRO, etc).
+
+        Returns:
+            Lista de dicts com bases de custo (2 na CONIN).
+        """
+        data = self._get("/cost-databases")
+        return data.get("results", data if isinstance(data, list) else [])