boarddata 6.8.2__tar.gz → 6.8.4__tar.gz

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

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

{boarddata-6.8.2 → boarddata-6.8.4}/__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.4"
 __all__ = [
     "Base",
     "BoardDataClient",

{boarddata-6.8.2 → boarddata-6.8.4}/_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.4}/boarddata.egg-info/PKG-INFO

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

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

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

{boarddata-6.8.2 → boarddata-6.8.4}/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.4}/tests/test_types_politic.py

@@ -70,6 +70,10 @@ class TestFieldSourcePayload:
             "extracted_by",
             "notes",
             "derivation",
+            # F-08 English twins
+            "extracted_value_en",
+            "notes_en",
+            "derivation_en",
         }
         assert required_keys(FieldSourcePayload) == {"document", "field_name"}
 
@@ -89,6 +93,10 @@ class TestFieldSourceReadShapes:
         "extracted_by",
         "notes",
         "derivation",
+        # F-08 English twins (absent on servers before core/0035)
+        "extracted_value_en",
+        "notes_en",
+        "derivation_en",
         # provenance bundle (slice 7a)
         "source",
         "provenance",
@@ -108,6 +116,9 @@ class TestFieldSourceReadShapes:
             "cause_end",
             "cause_end_display",
             "terminal_departure",
+            "extracted_value_en",
+            "notes_en",
+            "derivation_en",
         }
 
     def test_item_is_record_plus_field_name(self):
@@ -247,7 +258,18 @@ class TestWritePayloadTypes:
             "max_value",
             "payout_curve",
             "disclosure",
+            "plan_stage",
+            "plan_vintage",
             "field_sources",
+            # F-08 English twins
+            "label_en",
+            "target_value_en",
+            "achieved_value_en",
+            "min_value_en",
+            "max_value_en",
+            "plan_vintage_en",
+            "disclosure_note_en",
+            "payout_curve_en",
         }
         assert required_keys(CriterionWritePayload) == {"component_type"}
         # Server-stamped fields must never be sendable:
@@ -271,7 +293,15 @@ class TestWritePayloadTypes:
             "rate_basis",
             "disclosure",
             "payout_curve",
+            "achievement_plan",
+            "quote",
+            "page",
             "field_sources",
+            # F-08 English twins
+            "achievement_plan_en",
+            "quote_en",
+            "disclosure_note_en",
+            "payout_curve_en",
         }
         assert required_keys(ComponentAchievementRateWritePayload) == {"component_type"}
 
@@ -349,6 +379,43 @@ class TestReadTypeRefresh:
         missing = {"id", "rate_basis", "disclosure", "payout_curve"} - set(ComponentAchievementRate.__annotations__)
         assert not missing, sorted(missing)
 
+    def test_en_twins_are_typed_beside_their_originals(self):
+        # F-08: every served/accepted *_en twin is typed, NotRequired (older
+        # servers omit it), and never without its original.
+        from boarddata.types.comex import (
+            ComexCompensationCriteria,
+            ComponentAchievementRate,
+            ComponentAchievementRateWritePayload,
+            CriterionWritePayload,
+        )
+
+        criteria_twins = {
+            "label_en": "label",
+            "target_value_en": "target_value",
+            "achieved_value_en": "achieved_value",
+            "min_value_en": "min_value",
+            "max_value_en": "max_value",
+            "plan_vintage_en": "plan_vintage",
+            "disclosure_note_en": "disclosure",
+            "payout_curve_en": "payout_curve",
+        }
+        rate_twins = {
+            "achievement_plan_en": "achievement_plan",
+            "quote_en": "quote",
+            "disclosure_note_en": "disclosure",
+            "payout_curve_en": "payout_curve",
+        }
+        for td, twins in (
+            (ComexCompensationCriteria, criteria_twins),
+            (CriterionWritePayload, criteria_twins),
+            (ComponentAchievementRate, rate_twins),
+            (ComponentAchievementRateWritePayload, rate_twins),
+        ):
+            keys = set(td.__annotations__)
+            assert {k for k in keys if k.endswith("_en")} == set(twins), td.__name__
+            assert set(twins.values()) <= keys, td.__name__
+            assert set(twins) <= optional_keys(td), td.__name__
+
     def test_sources_are_dicts(self):
         """The API serves ``{field_name: [entry, ...]}`` (SourceTrackingMixin) —
         the list typing was a long-standing SDK bug."""

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

@@ -155,6 +155,22 @@ class ComexCompensationCriteria(TypedDict):
     family_source: str
     families: list[CriteriaFamilyWeightItem]
     classification_expected: bool
+    # Plan keying (NULL = legacy/unkeyed row)
+    plan_stage: NotRequired[str | None]  # grant | vested
+    plan_vintage: NotRequired[str | None]
+    # F-08 English twins: "" / {} = no translation (the original is English
+    # or not yet translated). Servers before mandates/0047 omit them.
+    # payout_curve_en is keyed by path ("points.<i>.metric_level",
+    # "overlays.<i>.description", ...), disclosure_note_en translates
+    # disclosure["note"].
+    label_en: NotRequired[str]
+    target_value_en: NotRequired[str]
+    achieved_value_en: NotRequired[str]
+    min_value_en: NotRequired[str]
+    max_value_en: NotRequired[str]
+    plan_vintage_en: NotRequired[str]
+    disclosure_note_en: NotRequired[str]
+    payout_curve_en: NotRequired[dict[str, str]]
 
 
 class ComponentAchievementRate(TypedDict):
@@ -173,6 +189,15 @@ class ComponentAchievementRate(TypedDict):
     rate_basis: str
     disclosure: DisclosureMap
     payout_curve: PayoutCurvePayload | None
+    achievement_plan: NotRequired[str]
+    quote: NotRequired[str]
+    page: NotRequired[int | None]
+    # F-08 English twins: "" / {} = no translation. Servers before
+    # mandates/0047 omit them.
+    achievement_plan_en: NotRequired[str]
+    quote_en: NotRequired[str]
+    disclosure_note_en: NotRequired[str]
+    payout_curve_en: NotRequired[dict[str, str]]
 
 
 class CriteriaFamilyWeightPayload(TypedDict):
@@ -228,7 +253,22 @@ class CriterionWritePayload(TypedDict):
     max_value: NotRequired[str | None]
     payout_curve: NotRequired[PayoutCurvePayload | None]
     disclosure: NotRequired[DisclosureMap | None]
+    plan_stage: NotRequired[str | None]  # grant | vested
+    plan_vintage: NotRequired[str | None]
     field_sources: NotRequired[list[FieldSourcePayload]]
+    # F-08 English twins (server >= mandates/0047). Send one only when its
+    # original is not English. Absent or null keeps the stored English only
+    # while the original is unchanged; "" clears it; a value must translate
+    # the originals in THIS payload (400 on an empty original or on a
+    # payout_curve_en path that does not resolve to a non-empty text).
+    label_en: NotRequired[str | None]
+    target_value_en: NotRequired[str | None]
+    achieved_value_en: NotRequired[str | None]
+    min_value_en: NotRequired[str | None]
+    max_value_en: NotRequired[str | None]
+    plan_vintage_en: NotRequired[str | None]
+    disclosure_note_en: NotRequired[str | None]  # translates disclosure["note"]
+    payout_curve_en: NotRequired[dict[str, str] | None]
 
 
 class ComponentAchievementRateWritePayload(TypedDict):
@@ -249,7 +289,19 @@ class ComponentAchievementRateWritePayload(TypedDict):
     rate_basis: NotRequired[str | None]
     disclosure: NotRequired[DisclosureMap | None]
     payout_curve: NotRequired[PayoutCurvePayload | None]
+    achievement_plan: NotRequired[str | None]
+    quote: NotRequired[str | None]
+    page: NotRequired[int | None]
     field_sources: NotRequired[list[FieldSourcePayload]]
+    # F-08 English twins (server >= mandates/0047). Send one only when its
+    # original is not English. Absent or null keeps the stored English only
+    # while the original is unchanged; "" clears it; a value must translate
+    # the originals in THIS payload (400 on an empty original or on a
+    # payout_curve_en path that does not resolve to a non-empty text).
+    achievement_plan_en: NotRequired[str | None]
+    quote_en: NotRequired[str | None]
+    disclosure_note_en: NotRequired[str | None]  # translates disclosure["note"]
+    payout_curve_en: NotRequired[dict[str, str] | None]
 
 
 # -- Comex compensation --
@@ -308,6 +360,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 +426,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 +491,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 +553,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 +696,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

{boarddata-6.8.2 → boarddata-6.8.4}/types/core.py

@@ -73,6 +73,15 @@ class FieldSourcePayload(TypedDict):
     extracted_by: NotRequired[str]
     notes: NotRequired[str]
     derivation: NotRequired[DerivationPayload | None]
+    # F-08 English twins (server >= core/0035). Send one only when its
+    # original is not English. Absent or null keeps the stored English only
+    # while the original is unchanged; "" clears it; a value must translate
+    # the originals in THIS entry (a text equal to its original is stored
+    # as ""). derivation_en is keyed by path: "formula_display",
+    # "inputs.<i>.quote", "missing_inputs.<i>".
+    extracted_value_en: NotRequired[str | None]
+    notes_en: NotRequired[str | None]
+    derivation_en: NotRequired[dict[str, str] | None]
 
 
 # -- Shared response types --
@@ -122,6 +131,11 @@ class FieldSourceRecord(TypedDict):
     extracted_by: str
     notes: str
     derivation: DerivationPayload | None
+    # F-08 English twins: "" / {} = no translation (the original is English
+    # or not yet translated). Servers before core/0035 omit them.
+    extracted_value_en: NotRequired[str]
+    notes_en: NotRequired[str]
+    derivation_en: NotRequired[dict[str, str]]
     # Normalized provenance bundle (slice 7a), merged server-side:
     source: str
     provenance: str