boarddata 6.8.2__tar.gz → 6.8.3__tar.gz

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

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

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

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

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

@@ -368,6 +368,7 @@ class ComexMixin:
         lti_grant_target_basis: str | None = None,
         lti_grant_target_value: str | None = None,
         lti_grant_cap_kind: str | None = None,
+        lti_max: str | None = None,
         performance_shares_number_level: str | None = None,
         performance_shares_level: str | None = None,
         policy_changed_midyear: bool | None = None,
@@ -442,6 +443,10 @@ class ComexMixin:
             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"``).
+            lti_max: LTI maximum as a MONEY amount in the row's own currency
+                (decimal string; never converted): grant ceiling × vesting max
+                ÷ 100, capped at a share-count / %-of-capital ceiling. ``"0.00"``
+                is an attested zero; omit (None) when not served.
             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
@@ -512,6 +517,7 @@ class ComexMixin:
             lti_grant_target_basis=lti_grant_target_basis,
             lti_grant_target_value=lti_grant_target_value,
             lti_grant_cap_kind=lti_grant_cap_kind,
+            lti_max=lti_max,
             performance_shares_number_level=performance_shares_number_level,
             performance_shares_level=performance_shares_level,
             policy_changed_midyear=policy_changed_midyear,
@@ -577,6 +583,7 @@ class ComexMixin:
         lti_grant_target_basis: str | None = None,
         lti_grant_target_value: str | None = None,
         lti_grant_cap_kind: str | None = None,
+        lti_max: str | None = None,
         performance_shares_number_level: str | None = None,
         performance_shares_level: str | None = None,
         policy_changed_midyear: bool | None = None,
@@ -651,6 +658,10 @@ class ComexMixin:
             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"``).
+            lti_max: LTI maximum as a MONEY amount in the row's own currency
+                (decimal string; never converted): grant ceiling × vesting max
+                ÷ 100, capped at a share-count / %-of-capital ceiling. ``"0.00"``
+                is an attested zero; omit (None) when not served.
             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
@@ -722,6 +733,7 @@ class ComexMixin:
             lti_grant_target_basis=lti_grant_target_basis,
             lti_grant_target_value=lti_grant_target_value,
             lti_grant_cap_kind=lti_grant_cap_kind,
+            lti_max=lti_max,
             performance_shares_number_level=performance_shares_number_level,
             performance_shares_level=performance_shares_level,
             policy_changed_midyear=policy_changed_midyear,

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

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

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

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

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

@@ -288,11 +288,51 @@ def test_envelope_scalar_kwargs_in_signatures():
             "reference_amount",
             "lti_grant_cap_basis",
             "lti_grant_cap_value",
+            "lti_max",
             "policy_changed_midyear",
         ):
             assert k in params, f"{method.__name__} missing {k}"
 
 
+def test_lti_max_reaches_the_wire_including_attested_zero():
+    c = make_client()
+    c._request.return_value = {"id": "1", "action": "created"}
+    c.replace_comex_compensation("uid", 2026, "politic", lti_max="0.00")
+    _, kwargs = c._request.call_args
+    assert kwargs["json"]["lti_max"] == "0.00"
+
+
+def test_lti_max_omitted_is_not_sent():
+    """None means 'not served' — the SDK must not write an explicit null
+    over a committed value on replace."""
+    c = make_client()
+    c._request.return_value = {"id": "1", "action": "created"}
+    c.replace_comex_compensation("uid", 2026, "politic", variable_max="1.00")
+    _, kwargs = c._request.call_args
+    assert "lti_max" not in kwargs["json"]
+
+
+def test_lti_max_declared_on_every_compensation_typeddict():
+    """Read + write contract parity: every TypedDict that carries the twin
+    lti_grant_cap_kind slot must also carry lti_max."""
+    from boarddata.types.comex import (
+        ComexCompensationDetail,
+        ComexCompensationExportItem,
+        ComexCompensationItem,
+        CreateComexCompensationPayload,
+        UpdateComexCompensationPayload,
+    )
+
+    for typed_dict in (
+        ComexCompensationItem,
+        ComexCompensationDetail,
+        CreateComexCompensationPayload,
+        UpdateComexCompensationPayload,
+        ComexCompensationExportItem,
+    ):
+        assert "lti_max" in typed_dict.__annotations__, typed_dict.__name__
+
+
 def test_envelope_scalars_reach_the_wire():
     c = make_client()
     c._request.return_value = {"id": "1", "action": "created"}

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

@@ -308,6 +308,7 @@ class ComexCompensationItem(TypedDict):
     lti_grant_target_basis: str
     lti_grant_target_value: str | None
     lti_grant_cap_kind: str
+    lti_max: str | None
     performance_shares_number_level: str
     performance_shares_level: str
     policy_changed_midyear: bool | None
@@ -373,6 +374,7 @@ class ComexCompensationDetail(TypedDict):
     lti_grant_target_basis: str
     lti_grant_target_value: str | None
     lti_grant_cap_kind: str
+    lti_max: str | None
     performance_shares_number_level: str
     performance_shares_level: str
     policy_changed_midyear: bool | None
@@ -437,6 +439,7 @@ class CreateComexCompensationPayload(TypedDict):
     lti_grant_target_basis: NotRequired[str]
     lti_grant_target_value: NotRequired[str | None]
     lti_grant_cap_kind: NotRequired[str]
+    lti_max: NotRequired[str | None]
     performance_shares_number_level: NotRequired[str]
     performance_shares_level: NotRequired[str]
     policy_changed_midyear: NotRequired[bool | None]
@@ -498,6 +501,7 @@ class UpdateComexCompensationPayload(TypedDict, total=False):
     lti_grant_target_basis: str
     lti_grant_target_value: str | None
     lti_grant_cap_kind: str
+    lti_max: str | None
     performance_shares_number_level: str
     performance_shares_level: str
     policy_changed_midyear: bool | None
@@ -640,6 +644,7 @@ class ComexCompensationExportItem(TypedDict, total=False):
     lti_grant_target_basis: str
     lti_grant_target_value: str | None
     lti_grant_cap_kind: str
+    lti_max: str | None
     performance_shares_number_level: str
     performance_shares_level: str
     policy_changed_midyear: bool | None