boarddata 4.0.0__tar.gz → 4.0.2__tar.gz

{boarddata-4.0.0 → boarddata-4.0.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: boarddata
-Version: 4.0.0
+Version: 4.0.2
 Summary: Python SDK for the BoardData V2 REST API
 License: MIT
 Classifier: Development Status :: 4 - Beta

{boarddata-4.0.0 → boarddata-4.0.2}/__init__.py

@@ -7,7 +7,7 @@ from .errors import BoardDataError
 
 from . import types as types  # noqa: F401 — makes types accessible as boarddata.types
 
-__version__ = "4.0.0"
+__version__ = "4.0.2"
 __all__ = [
     "Base",
     "BoardDataClient",

{boarddata-4.0.0 → boarddata-4.0.2}/_comex.py

@@ -288,6 +288,7 @@ class ComexMixin:
         has_employment_contract: bool | None = None,
         discretionary_grant: bool | None = None,
         subsidiary_remuneration: str | None = None,
+        remuneration_via_holding: bool | None = None,
         currency: str | None = None,
         field_sources: list[FieldSourcePayload] | None = None,
         criteria: list[dict[str, Any]] | None = None,
@@ -335,6 +336,7 @@ class ComexMixin:
             has_employment_contract: Whether has employment contract.
             discretionary_grant: Whether discretionary grant applies.
             subsidiary_remuneration: Subsidiary remuneration (decimal).
+            remuneration_via_holding: Whether remuneration is provided via holding.
             currency: Currency code (e.g. ``"EUR"``).
             field_sources: Document provenance for fields.
             criteria: List of compensation criteria dicts.
@@ -385,6 +387,7 @@ class ComexMixin:
             has_employment_contract=has_employment_contract,
             discretionary_grant=discretionary_grant,
             subsidiary_remuneration=subsidiary_remuneration,
+            remuneration_via_holding=remuneration_via_holding,
             currency=currency,
             field_sources=field_sources,
             criteria=criteria,

boarddata-4.0.2/_criteria.py

@@ -0,0 +1,68 @@
+"""Criteria catalog and theme methods."""
+
+from __future__ import annotations
+
+from typing import Any
+
+from .types.criteria import CriteriaCatalogItem, CriteriaThemeItem
+
+
+class CriteriaMixin:
+    """Criteria catalog and theme API methods.
+
+    Provides access to the shared criteria catalog used by compensation
+    records across all comex mandates.
+    """
+
+    def list_criteria_themes(self) -> list[CriteriaThemeItem]:
+        """List all criteria themes.
+
+        Returns:
+            List of criteria themes (not paginated).
+
+        Raises:
+            BoardDataError: On non-2xx API response.
+        """
+        return self._get("criteria-themes/")  # type: ignore[attr-defined]
+
+    def list_criteria(
+        self,
+        theme: str | None = None,
+    ) -> list[CriteriaCatalogItem]:
+        """List all criteria catalog entries.
+
+        Args:
+            theme: Filter by criteria theme UUID.
+
+        Returns:
+            List of criteria (not paginated).
+
+        Raises:
+            BoardDataError: On non-2xx API response.
+        """
+        params: dict[str, Any] = {}
+        if theme is not None:
+            params["theme"] = theme
+        return self._get("criteria/", **params)  # type: ignore[attr-defined]
+
+    def create_criteria(
+        self,
+        name: str,
+        theme_id: str | None = None,
+    ) -> CriteriaCatalogItem:
+        """Create a criteria catalog entry.
+
+        Args:
+            name: Standardized criterion name (e.g. ``"Revenue Growth"``).
+            theme_id: UUID of the criteria theme.
+
+        Returns:
+            Created criteria entry.
+
+        Raises:
+            BoardDataError: On non-2xx API response.
+        """
+        payload: dict[str, Any] = {"name": name}
+        if theme_id is not None:
+            payload["theme_id"] = theme_id
+        return self._post("criteria/", payload)  # type: ignore[attr-defined]

{boarddata-4.0.0 → boarddata-4.0.2}/_esg.py

@@ -4,8 +4,10 @@ from __future__ import annotations
 
 from typing import Any
 
-from .types.core import PaginatedResponse
+from .types.core import FieldSourcePayload, PaginatedResponse
 from .types.esg import (
+    IROBatchItemPayload,
+    IROBatchResultItem,
     IRODetail,
     TransitionFinancePayload,
     TransitionGovernancePayload,
@@ -56,6 +58,7 @@ class ESGMixin:
         iro_types: list[int] | None = None,
         page_number: int | None = None,
         evidence_text: str | None = None,
+        field_sources: list[FieldSourcePayload] | None = None,
     ) -> IRODetail:
         """Create an IRO.
 
@@ -68,6 +71,7 @@ class ESGMixin:
             iro_types: List of IROType IDs to associate.
             page_number: Source document page number.
             evidence_text: Supporting evidence text.
+            field_sources: List of field source entries for traceability.
 
         Returns:
             Created IRODetail.
@@ -84,6 +88,7 @@ class ESGMixin:
             iro_types=iro_types,
             page_number=page_number,
             evidence_text=evidence_text,
+            field_sources=field_sources,
         )
         return self._post("iros/", payload)  # type: ignore[attr-defined]
 
@@ -99,6 +104,7 @@ class ESGMixin:
         iro_types: list[int] | None = None,
         page_number: int | None = None,
         evidence_text: str | None = None,
+        field_sources: list[FieldSourcePayload] | None = None,
     ) -> IRODetail:
         """Partial update an IRO."""
         payload = self._build_payload(  # type: ignore[attr-defined]
@@ -110,6 +116,7 @@ class ESGMixin:
             iro_types=iro_types,
             page_number=page_number,
             evidence_text=evidence_text,
+            field_sources=field_sources,
         )
         return self._patch(f"iros/{uid}/", payload)  # type: ignore[attr-defined]
 
@@ -117,6 +124,27 @@ class ESGMixin:
         """Delete an IRO."""
         self._delete(f"iros/{uid}/")  # type: ignore[attr-defined]
 
+    def batch_create_iro(
+        self,
+        items: list[IROBatchItemPayload],
+    ) -> list[IROBatchResultItem]:
+        """Batch upsert IROs.
+
+        Each item is matched by ``(company, date_publication, name)``.
+        Existing records are updated; new ones are created.
+
+        Args:
+            items: List of IRO payloads to upsert.
+
+        Returns:
+            List of results with ``name``, ``iro_id``, and ``action``
+            (``"created"`` or ``"updated"``).
+
+        Raises:
+            BoardDataError: On non-2xx API response.
+        """
+        return self._post("iros/batch/", items)  # type: ignore[attr-defined]
+
     # ------------------------------------------------------------------
     # Transition Plans
     # ------------------------------------------------------------------
@@ -159,6 +187,7 @@ class ESGMixin:
         levers: list[TransitionLeverPayload] | None = None,
         finances: list[TransitionFinancePayload] | None = None,
         governances: list[TransitionGovernancePayload] | None = None,
+        field_sources: list[FieldSourcePayload] | None = None,
     ) -> TransitionPlanDetail:
         """Create a transition plan with optional nested children.
 
@@ -176,6 +205,7 @@ class ESGMixin:
             levers: Nested decarbonisation levers.
             finances: Nested financial commitments.
             governances: Nested governance mechanisms.
+            field_sources: List of field source entries for traceability.
 
         Returns:
             Created TransitionPlanDetail with nested children.
@@ -197,6 +227,7 @@ class ESGMixin:
             levers=levers,
             finances=finances,
             governances=governances,
+            field_sources=field_sources,
         )
         return self._post("transition-plans/", payload)  # type: ignore[attr-defined]
 
@@ -217,6 +248,7 @@ class ESGMixin:
         levers: list[TransitionLeverPayload] | None = None,
         finances: list[TransitionFinancePayload] | None = None,
         governances: list[TransitionGovernancePayload] | None = None,
+        field_sources: list[FieldSourcePayload] | None = None,
     ) -> TransitionPlanDetail:
         """Partial update a transition plan.
 
@@ -237,6 +269,7 @@ class ESGMixin:
             levers=levers,
             finances=finances,
             governances=governances,
+            field_sources=field_sources,
         )
         return self._patch(f"transition-plans/{uid}/", payload)  # type: ignore[attr-defined]
 

{boarddata-4.0.0 → boarddata-4.0.2}/boarddata.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: boarddata
-Version: 4.0.0
+Version: 4.0.2
 Summary: Python SDK for the BoardData V2 REST API
 License: MIT
 Classifier: Development Status :: 4 - Beta

{boarddata-4.0.0 → boarddata-4.0.2}/boarddata.egg-info/SOURCES.txt

@@ -6,6 +6,7 @@ _auditors.py
 _base.py
 _comex.py
 _companies.py
+_criteria.py
 _directors.py
 _documents.py
 _esg.py
@@ -24,6 +25,7 @@ pyproject.toml
 ./_base.py
 ./_comex.py
 ./_companies.py
+./_criteria.py
 ./_directors.py
 ./_documents.py
 ./_esg.py
@@ -49,6 +51,7 @@ tests/test_cache.py
 tests/test_comex.py
 tests/test_companies.py
 tests/test_config.py
+tests/test_criteria.py
 tests/test_directors.py
 tests/test_documents.py
 tests/test_esg.py
@@ -61,6 +64,7 @@ types/auditors.py
 types/comex.py
 types/companies.py
 types/core.py
+types/criteria.py
 types/directors.py
 types/documents.py
 types/esg.py

{boarddata-4.0.0 → boarddata-4.0.2}/client.py

@@ -7,6 +7,7 @@ from ._auditors import AuditorMixin
 from ._base import Base
 from ._comex import ComexMixin
 from ._companies import CompanyMixin
+from ._criteria import CriteriaMixin
 from ._directors import DirectorMixin
 from ._documents import DocumentMixin
 from ._esg import ESGMixin
@@ -25,6 +26,7 @@ class BoardDataClient(
     AssemblyMixin,
     ESGMixin,
     SentinelMixin,
+    CriteriaMixin,
     UtilitiesMixin,
     Base,
 ):

{boarddata-4.0.0 → boarddata-4.0.2}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "boarddata"
-version = "4.0.0"
+version = "4.0.2"
 description = "Python SDK for the BoardData V2 REST API"
 readme = "README.md"
 license = {text = "MIT"}

{boarddata-4.0.0 → boarddata-4.0.2}/tests/test_comex.py

@@ -26,12 +26,14 @@ class TestCreateComexCompensation:
         c.create_comex_compensation(
             "comex-uuid", 2024, "REAL",
             fixed="500000.00", variable="200000.00", currency="EUR",
+            remuneration_via_holding=True,
         )
         _, kwargs = c._request.call_args
         payload = kwargs["json"]
         assert payload["fixed"] == "500000.00"
         assert payload["variable"] == "200000.00"
         assert payload["currency"] == "EUR"
+        assert payload["remuneration_via_holding"] is True
         assert "token_personal" not in payload  # board field, not comex
 
 

boarddata-4.0.2/tests/test_criteria.py

@@ -0,0 +1,68 @@
+"""Tests for CriteriaMixin methods."""
+
+from __future__ import annotations
+
+from unittest.mock import MagicMock
+
+
+def make_client():
+    from boarddata._criteria import CriteriaMixin
+    from boarddata._base import Base
+
+    class TestClient(CriteriaMixin, Base):
+        pass
+
+    client = TestClient.__new__(TestClient)
+    client._request = MagicMock()
+    client._get_token = MagicMock(return_value="fake-token")
+    client.base_url = "https://api.example.com"
+    client.timeout = 30
+    return client
+
+
+class TestListCriteriaThemes:
+    def test_calls_correct_path(self):
+        c = make_client()
+        c._request.return_value = [{"id": "t1", "name": "Financial"}]
+        result = c.list_criteria_themes()
+        args, _ = c._request.call_args
+        assert args == ("GET", "criteria-themes/")
+        assert result[0]["name"] == "Financial"
+
+
+class TestListCriteria:
+    def test_calls_correct_path(self):
+        c = make_client()
+        c._request.return_value = [{"id": "c1", "name": "Revenue Growth"}]
+        result = c.list_criteria()
+        args, _ = c._request.call_args
+        assert args == ("GET", "criteria/")
+        assert result[0]["name"] == "Revenue Growth"
+
+    def test_filters_by_theme(self):
+        c = make_client()
+        c._request.return_value = []
+        c.list_criteria(theme="theme-uuid")
+        _, kwargs = c._request.call_args
+        assert kwargs["params"]["theme"] == "theme-uuid"
+
+
+class TestCreateCriteria:
+    def test_sends_payload(self):
+        c = make_client()
+        c._request.return_value = {"id": "c1", "name": "Revenue Growth"}
+        result = c.create_criteria("Revenue Growth", theme_id="theme-uuid")
+        _, kwargs = c._request.call_args
+        payload = kwargs["json"]
+        assert payload["name"] == "Revenue Growth"
+        assert payload["theme_id"] == "theme-uuid"
+        assert result["id"] == "c1"
+
+    def test_without_theme(self):
+        c = make_client()
+        c._request.return_value = {"id": "c2", "name": "Safety Rate"}
+        c.create_criteria("Safety Rate")
+        _, kwargs = c._request.call_args
+        payload = kwargs["json"]
+        assert payload["name"] == "Safety Rate"
+        assert "theme_id" not in payload

{boarddata-4.0.0 → boarddata-4.0.2}/types/__init__.py

@@ -2,6 +2,8 @@
 
 from .esg import (
     CompanyESGBenchmarkItem,
+    IROBatchItemPayload,
+    IROBatchResultItem,
     IRODetail,
     IROTypeItem,
     TransitionFinanceItem,
@@ -117,6 +119,8 @@ from .sentinel import (
 __all__ = [
     # esg
     "CompanyESGBenchmarkItem",
+    "IROBatchItemPayload",
+    "IROBatchResultItem",
     "IRODetail",
     "IROTypeItem",
     "TransitionFinanceItem",

{boarddata-4.0.0 → boarddata-4.0.2}/types/comex.py

@@ -103,6 +103,7 @@ class ComexCompensationItem(TypedDict):
     subsidiary_remuneration: str | None
     holding: bool
     has_employment_contract: bool
+    remuneration_via_holding: bool
     total: str | None
     total_paid: str | None
     currency: str
@@ -149,6 +150,7 @@ class ComexCompensationDetail(TypedDict):
     has_employment_contract: bool
     discretionary_grant: bool
     subsidiary_remuneration: str | None
+    remuneration_via_holding: bool
     currency: str
     total: str | None
     total_paid: str | None
@@ -196,6 +198,7 @@ class CreateComexCompensationPayload(TypedDict):
     has_employment_contract: NotRequired[bool]
     discretionary_grant: NotRequired[bool]
     subsidiary_remuneration: NotRequired[str | None]
+    remuneration_via_holding: NotRequired[bool]
     currency: NotRequired[str]
     field_sources: NotRequired[list[FieldSourcePayload]]
     criteria: NotRequired[list[dict[str, Any]]]
@@ -241,6 +244,7 @@ class UpdateComexCompensationPayload(TypedDict, total=False):
     has_employment_contract: bool
     discretionary_grant: bool
     subsidiary_remuneration: str | None
+    remuneration_via_holding: bool
     currency: str
     field_sources: list[FieldSourcePayload]
     criteria: list[dict[str, Any]]

boarddata-4.0.2/types/criteria.py

@@ -0,0 +1,34 @@
+"""Criteria catalog types."""
+
+from __future__ import annotations
+
+try:
+    from typing import NotRequired, TypedDict
+except ImportError:
+    from typing_extensions import NotRequired, TypedDict
+
+
+class CriteriaThemeItem(TypedDict):
+    """Criteria theme as returned by the criteria-themes endpoint."""
+
+    id: str
+    name: str
+    description: str
+    category: str
+
+
+class CriteriaCatalogItem(TypedDict):
+    """Criteria catalog entry as returned by the criteria endpoint."""
+
+    id: str
+    name: str
+    theme_id: str | None
+    theme_name: str
+    theme_category: str
+
+
+class CreateCriteriaPayload(TypedDict, total=False):
+    """Payload for creating a criteria catalog entry."""
+
+    name: str
+    theme_id: str | None

{boarddata-4.0.0 → boarddata-4.0.2}/types/esg.py

@@ -7,6 +7,8 @@ try:
 except ImportError:
     from typing_extensions import Any, NotRequired, TypedDict
 
+from .core import FieldSourcePayload
+
 
 # -- IRO Types --
 
@@ -30,6 +32,24 @@ class IRODetail(TypedDict):
     evidence_text: str
 
 
+class IROBatchItemPayload(TypedDict):
+    """Payload for a single item in a batch IRO upsert."""
+    company: str
+    date_publication: str
+    name: str
+    esg_type: str
+    description: NotRequired[str]
+    iro_types: NotRequired[list[int]]
+    field_sources: NotRequired[list[FieldSourcePayload]]
+
+
+class IROBatchResultItem(TypedDict):
+    """Result for a single item in a batch IRO upsert response."""
+    name: str
+    iro_id: str
+    action: str
+
+
 # -- Transition Plan children --
 
 class TransitionTargetItem(TypedDict):
@@ -63,6 +83,7 @@ class TransitionTargetPayload(TypedDict):
     sbti_pathway: NotRequired[str]
     source_page: NotRequired[int | None]
     evidence_text: NotRequired[str]
+    field_sources: NotRequired[list[FieldSourcePayload]]
 
 
 class TransitionLeverItem(TypedDict):
@@ -88,6 +109,7 @@ class TransitionLeverPayload(TypedDict):
     kpi_or_milestone: NotRequired[str]
     source_page: NotRequired[int | None]
     evidence_text: NotRequired[str]
+    field_sources: NotRequired[list[FieldSourcePayload]]
 
 
 class TransitionFinanceItem(TypedDict):
@@ -117,6 +139,7 @@ class TransitionFinancePayload(TypedDict):
     description: NotRequired[str]
     source_page: NotRequired[int | None]
     evidence_text: NotRequired[str]
+    field_sources: NotRequired[list[FieldSourcePayload]]
 
 
 class TransitionGovernanceItem(TypedDict):
@@ -144,6 +167,7 @@ class TransitionGovernancePayload(TypedDict):
     metric: NotRequired[str]
     source_page: NotRequired[int | None]
     evidence_text: NotRequired[str]
+    field_sources: NotRequired[list[FieldSourcePayload]]
 
 
 # -- Transition Plan --