boarddata 6.7.4__tar.gz → 6.8.2__tar.gz

{boarddata-6.7.4 → boarddata-6.8.2}/PKG-INFO

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

{boarddata-6.7.4 → boarddata-6.8.2}/__init__.py

@@ -6,7 +6,7 @@ from .cache import FileTokenCache, ScalewaySecretTokenCache
 from .client import BoardDataClient
 from .errors import BoardDataError, ExportTooLargeError
 
-__version__ = "6.7.4"
+__version__ = "6.8.2"
 __all__ = [
     "Base",
     "BoardDataClient",

{boarddata-6.7.4 → boarddata-6.8.2}/_comex.py

@@ -365,6 +365,11 @@ class ComexMixin:
         reference_amount: str | None = None,
         lti_grant_cap_basis: str | None = None,
         lti_grant_cap_value: str | None = None,
+        lti_grant_target_basis: str | None = None,
+        lti_grant_target_value: str | None = None,
+        lti_grant_cap_kind: str | None = None,
+        performance_shares_number_level: str | None = None,
+        performance_shares_level: str | None = None,
         policy_changed_midyear: bool | None = None,
         currency: str | None = None,
         field_sources: list[FieldSourcePayload] | None = None,
@@ -415,19 +420,32 @@ class ComexMixin:
             subsidiary_remuneration: Subsidiary remuneration (decimal).
             remuneration_via_holding: Whether remuneration is provided via holding.
             sti_basis: Disclosed STI base form (frozen enum, e.g. ``"pct_of_fixed"``).
-            variable_max: STI cap in EUR (decimal string; always €, never
-                disclosed-basis — the disclosed-basis cap goes in
-                ``variable_max_value``).
+            variable_max: STI cap as a MONEY amount, in the row's own currency
+                (decimal string; never converted — the cap expressed in the
+                disclosed basis goes in ``variable_max_value``). The pair
+                separates money from basis, NOT euros from other currencies:
+                8 politic rows carry USD or GBP here today.
             variable_target_pct: STI target normalized to % of fixed (decimal
                 string; stated or derivation-backed, never back-solved).
             variable_max_pct: STI cap normalized to % of fixed (decimal string).
             variable_target_value: STI target in the DISCLOSED basis (decimal string;
                 interpretation governed by ``sti_basis`` — never converted).
             variable_max_value: STI cap in the DISCLOSED basis (decimal string).
-            reference_amount: STI reference base amount in EUR (decimal string;
-                ``sti_basis="pct_of_reference_amount"`` archetype).
+            reference_amount: STI reference base amount, in the row's own
+                currency (decimal string; ``sti_basis="pct_of_reference_amount"``
+                archetype). Its only holder today happens to be EUR, which is
+                why this said "in EUR" — accidentally true, never contractually
+                so; nothing converts on the way in.
             lti_grant_cap_basis: Disclosed LTI grant-cap basis (frozen enum).
             lti_grant_cap_value: LTI grant cap in the DISCLOSED basis (decimal string).
+            lti_grant_target_basis: Disclosed LTI grant-target basis (frozen enum).
+            lti_grant_target_value: LTI grant at TARGET in the DISCLOSED basis (decimal string).
+            lti_grant_cap_kind: Which kind of ceiling occupies the cap slot (frozen enum,
+                e.g. ``"individual_max"`` or ``"policy_cap"``).
+            performance_shares_number_level: Quote-cued disclosure level of the
+                performance-shares COUNT (frozen enum, e.g. ``"target"`` or ``"max"``).
+            performance_shares_level: Quote-cued disclosure level of the
+                performance-shares € valuation (frozen enum).
             policy_changed_midyear: Policy regime changed mid-year; the stored
                 row is the fiscal-year-end regime (D5).
             currency: Currency code (e.g. ``"EUR"``).
@@ -491,6 +509,11 @@ class ComexMixin:
             reference_amount=reference_amount,
             lti_grant_cap_basis=lti_grant_cap_basis,
             lti_grant_cap_value=lti_grant_cap_value,
+            lti_grant_target_basis=lti_grant_target_basis,
+            lti_grant_target_value=lti_grant_target_value,
+            lti_grant_cap_kind=lti_grant_cap_kind,
+            performance_shares_number_level=performance_shares_number_level,
+            performance_shares_level=performance_shares_level,
             policy_changed_midyear=policy_changed_midyear,
             currency=currency,
             field_sources=field_sources,
@@ -551,6 +574,11 @@ class ComexMixin:
         reference_amount: str | None = None,
         lti_grant_cap_basis: str | None = None,
         lti_grant_cap_value: str | None = None,
+        lti_grant_target_basis: str | None = None,
+        lti_grant_target_value: str | None = None,
+        lti_grant_cap_kind: str | None = None,
+        performance_shares_number_level: str | None = None,
+        performance_shares_level: str | None = None,
         policy_changed_midyear: bool | None = None,
         currency: str | None = None,
         field_sources: list[FieldSourcePayload] | None = None,
@@ -601,19 +629,32 @@ class ComexMixin:
             subsidiary_remuneration: Subsidiary remuneration (decimal).
             remuneration_via_holding: Whether remuneration is provided via holding.
             sti_basis: Disclosed STI base form (frozen enum, e.g. ``"pct_of_fixed"``).
-            variable_max: STI cap in EUR (decimal string; always €, never
-                disclosed-basis — the disclosed-basis cap goes in
-                ``variable_max_value``).
+            variable_max: STI cap as a MONEY amount, in the row's own currency
+                (decimal string; never converted — the cap expressed in the
+                disclosed basis goes in ``variable_max_value``). The pair
+                separates money from basis, NOT euros from other currencies:
+                8 politic rows carry USD or GBP here today.
             variable_target_pct: STI target normalized to % of fixed (decimal
                 string; stated or derivation-backed, never back-solved).
             variable_max_pct: STI cap normalized to % of fixed (decimal string).
             variable_target_value: STI target in the DISCLOSED basis (decimal string;
                 interpretation governed by ``sti_basis`` — never converted).
             variable_max_value: STI cap in the DISCLOSED basis (decimal string).
-            reference_amount: STI reference base amount in EUR (decimal string;
-                ``sti_basis="pct_of_reference_amount"`` archetype).
+            reference_amount: STI reference base amount, in the row's own
+                currency (decimal string; ``sti_basis="pct_of_reference_amount"``
+                archetype). Its only holder today happens to be EUR, which is
+                why this said "in EUR" — accidentally true, never contractually
+                so; nothing converts on the way in.
             lti_grant_cap_basis: Disclosed LTI grant-cap basis (frozen enum).
             lti_grant_cap_value: LTI grant cap in the DISCLOSED basis (decimal string).
+            lti_grant_target_basis: Disclosed LTI grant-target basis (frozen enum).
+            lti_grant_target_value: LTI grant at TARGET in the DISCLOSED basis (decimal string).
+            lti_grant_cap_kind: Which kind of ceiling occupies the cap slot (frozen enum,
+                e.g. ``"individual_max"`` or ``"policy_cap"``).
+            performance_shares_number_level: Quote-cued disclosure level of the
+                performance-shares COUNT (frozen enum, e.g. ``"target"`` or ``"max"``).
+            performance_shares_level: Quote-cued disclosure level of the
+                performance-shares € valuation (frozen enum).
             policy_changed_midyear: Policy regime changed mid-year; the stored
                 row is the fiscal-year-end regime (D5).
             currency: Currency code (e.g. ``"EUR"``).
@@ -678,6 +719,11 @@ class ComexMixin:
             reference_amount=reference_amount,
             lti_grant_cap_basis=lti_grant_cap_basis,
             lti_grant_cap_value=lti_grant_cap_value,
+            lti_grant_target_basis=lti_grant_target_basis,
+            lti_grant_target_value=lti_grant_target_value,
+            lti_grant_cap_kind=lti_grant_cap_kind,
+            performance_shares_number_level=performance_shares_number_level,
+            performance_shares_level=performance_shares_level,
             policy_changed_midyear=policy_changed_midyear,
             currency=currency,
             field_sources=field_sources,
@@ -690,6 +736,12 @@ class ComexMixin:
         self,
         comex_uid: str,
         pk: str,
+        *,
+        lti_grant_target_basis: str | None = None,
+        lti_grant_target_value: str | None = None,
+        lti_grant_cap_kind: str | None = None,
+        performance_shares_number_level: str | None = None,
+        performance_shares_level: str | None = None,
         **comp_fields: Any,
     ) -> ComexCompensationDetail:
         """Partial update a comex compensation.
@@ -697,6 +749,14 @@ class ComexMixin:
         Args:
             comex_uid: Comex mandate UUID.
             pk: Compensation entry ID.
+            lti_grant_target_basis: Disclosed LTI grant-target basis (frozen enum).
+            lti_grant_target_value: LTI grant at TARGET in the DISCLOSED basis (decimal string).
+            lti_grant_cap_kind: Which kind of ceiling occupies the cap slot (frozen enum,
+                e.g. ``"individual_max"`` or ``"policy_cap"``).
+            performance_shares_number_level: Quote-cued disclosure level of the
+                performance-shares COUNT (frozen enum, e.g. ``"target"`` or ``"max"``).
+            performance_shares_level: Quote-cued disclosure level of the
+                performance-shares € valuation (frozen enum).
             **comp_fields: Compensation fields to update (see create_comex_compensation).
 
         Returns:
@@ -705,7 +765,15 @@ class ComexMixin:
         Raises:
             BoardDataError: On non-2xx API response.
         """
-        payload = {k: v for k, v in comp_fields.items() if v is not None}
+        payload = {
+            **comp_fields,
+            "lti_grant_target_basis": lti_grant_target_basis,
+            "lti_grant_target_value": lti_grant_target_value,
+            "lti_grant_cap_kind": lti_grant_cap_kind,
+            "performance_shares_number_level": performance_shares_number_level,
+            "performance_shares_level": performance_shares_level,
+        }
+        payload = {k: v for k, v in payload.items() if v is not None}
         return self._patch(f"comex/{comex_uid}/compensations/{pk}/", payload)  # type: ignore[attr-defined]
 
     def delete_comex_compensation(self, comex_uid: str, pk: str) -> None:

{boarddata-6.7.4 → boarddata-6.8.2}/boarddata.egg-info/PKG-INFO

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

{boarddata-6.7.4 → boarddata-6.8.2}/pyproject.toml

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

{boarddata-6.7.4 → boarddata-6.8.2}/tests/test_comex.py

@@ -161,6 +161,113 @@ class TestReplaceComexCompensation:
         assert result["action"] == "created"
 
 
+class TestLtiEnvelopeLevelParams:
+    """Task 3b: the five LTI-envelope-level params (lti_grant_target_basis,
+    lti_grant_target_value, lti_grant_cap_kind, performance_shares_number_level,
+    performance_shares_level) must reach the wire from all three comex
+    compensation writers — create, replace, and update. The data-pipeline
+    committer's filter_to_signature drops any kwarg the SDK signature doesn't
+    declare, so a missing site here means the field never reaches prod."""
+
+    LTI_KWARGS = {
+        "lti_grant_target_basis": "pct_of_fixed",
+        "lti_grant_target_value": "120.0000",
+        "lti_grant_cap_kind": "individual_max",
+        "performance_shares_number_level": "target",
+        "performance_shares_level": "max",
+    }
+
+    def test_create_sends_lti_envelope_level_params(self):
+        c = make_client()
+        c._request.return_value = {"id": "comp1"}
+        c.create_comex_compensation("comex-uuid", 2024, "real", **self.LTI_KWARGS)
+        _, kwargs = c._request.call_args
+        payload = kwargs["json"]
+        for k, v in self.LTI_KWARGS.items():
+            assert payload[k] == v
+
+    def test_create_omits_lti_envelope_level_params_when_not_set(self):
+        c = make_client()
+        c._request.return_value = {"id": "comp1"}
+        c.create_comex_compensation("comex-uuid", 2024, "real", fixed="1.00")
+        _, kwargs = c._request.call_args
+        payload = kwargs["json"]
+        for k in self.LTI_KWARGS:
+            assert k not in payload
+
+    def test_replace_sends_lti_envelope_level_params(self):
+        c = make_client()
+        c._request.return_value = {"id": "comp9", "action": "replaced"}
+        c.replace_comex_compensation("comex-uuid", 2024, "real", **self.LTI_KWARGS)
+        _, kwargs = c._request.call_args
+        payload = kwargs["json"]
+        for k, v in self.LTI_KWARGS.items():
+            assert payload[k] == v
+
+    def test_replace_omits_lti_envelope_level_params_when_not_set(self):
+        c = make_client()
+        c._request.return_value = {"id": "comp9", "action": "replaced"}
+        c.replace_comex_compensation("comex-uuid", 2024, "real", fixed="1.00")
+        _, kwargs = c._request.call_args
+        payload = kwargs["json"]
+        for k in self.LTI_KWARGS:
+            assert k not in payload
+
+    def test_update_sends_lti_envelope_level_params(self):
+        c = make_client()
+        c._request.return_value = {"id": "comp1"}
+        c.update_comex_compensation("comex-uuid", "comp1", **self.LTI_KWARGS)
+        _, kwargs = c._request.call_args
+        assert kwargs["json"] == self.LTI_KWARGS
+
+    def test_update_omits_lti_envelope_level_params_when_not_set(self):
+        c = make_client()
+        c._request.return_value = {"id": "comp1"}
+        c.update_comex_compensation("comex-uuid", "comp1", fixed="1.00")
+        _, kwargs = c._request.call_args
+        payload = kwargs["json"]
+        for k in self.LTI_KWARGS:
+            assert k not in payload
+        assert payload["fixed"] == "1.00"
+
+    def test_update_still_passes_through_other_comp_fields(self):
+        """The five explicit params must not swallow the **comp_fields catch-all
+        that update_comex_compensation relies on for every other field."""
+        c = make_client()
+        c._request.return_value = {"id": "comp1"}
+        c.update_comex_compensation(
+            "comex-uuid",
+            "comp1",
+            fixed="500000.00",
+            lti_grant_target_basis="pct_of_fixed",
+        )
+        _, kwargs = c._request.call_args
+        payload = kwargs["json"]
+        assert payload["fixed"] == "500000.00"
+        assert payload["lti_grant_target_basis"] == "pct_of_fixed"
+
+
+def test_lti_envelope_level_kwargs_in_all_three_signatures():
+    import inspect
+
+    from boarddata import BoardDataClient
+
+    for method in (
+        BoardDataClient.create_comex_compensation,
+        BoardDataClient.replace_comex_compensation,
+        BoardDataClient.update_comex_compensation,
+    ):
+        params = inspect.signature(method).parameters
+        for k in (
+            "lti_grant_target_basis",
+            "lti_grant_target_value",
+            "lti_grant_cap_kind",
+            "performance_shares_number_level",
+            "performance_shares_level",
+        ):
+            assert k in params, f"{method.__name__} missing {k}"
+
+
 def test_envelope_scalar_kwargs_in_signatures():
     import inspect
 

{boarddata-6.7.4 → boarddata-6.8.2}/types/comex.py

@@ -305,6 +305,11 @@ class ComexCompensationItem(TypedDict):
     reference_amount: str | None
     lti_grant_cap_basis: str
     lti_grant_cap_value: str | None
+    lti_grant_target_basis: str
+    lti_grant_target_value: str | None
+    lti_grant_cap_kind: str
+    performance_shares_number_level: str
+    performance_shares_level: str
     policy_changed_midyear: bool | None
     agm_date: str | None
     total: str | None
@@ -365,6 +370,11 @@ class ComexCompensationDetail(TypedDict):
     reference_amount: str | None
     lti_grant_cap_basis: str
     lti_grant_cap_value: str | None
+    lti_grant_target_basis: str
+    lti_grant_target_value: str | None
+    lti_grant_cap_kind: str
+    performance_shares_number_level: str
+    performance_shares_level: str
     policy_changed_midyear: bool | None
     agm_date: str | None
     currency: str
@@ -424,6 +434,11 @@ class CreateComexCompensationPayload(TypedDict):
     reference_amount: NotRequired[str | None]
     lti_grant_cap_basis: NotRequired[str]
     lti_grant_cap_value: NotRequired[str | None]
+    lti_grant_target_basis: NotRequired[str]
+    lti_grant_target_value: NotRequired[str | None]
+    lti_grant_cap_kind: NotRequired[str]
+    performance_shares_number_level: NotRequired[str]
+    performance_shares_level: NotRequired[str]
     policy_changed_midyear: NotRequired[bool | None]
     currency: NotRequired[str]
     field_sources: NotRequired[list[FieldSourcePayload]]
@@ -480,6 +495,11 @@ class UpdateComexCompensationPayload(TypedDict, total=False):
     reference_amount: str | None
     lti_grant_cap_basis: str
     lti_grant_cap_value: str | None
+    lti_grant_target_basis: str
+    lti_grant_target_value: str | None
+    lti_grant_cap_kind: str
+    performance_shares_number_level: str
+    performance_shares_level: str
     policy_changed_midyear: bool | None
     currency: str
     field_sources: list[FieldSourcePayload]
@@ -617,6 +637,11 @@ class ComexCompensationExportItem(TypedDict, total=False):
     reference_amount: str | None
     lti_grant_cap_basis: str
     lti_grant_cap_value: str | None
+    lti_grant_target_basis: str
+    lti_grant_target_value: str | None
+    lti_grant_cap_kind: str
+    performance_shares_number_level: str
+    performance_shares_level: str
     policy_changed_midyear: bool | None
     agm_date: str | None
     criteria: list[ComexCompensationCriteria]