boarddata 6.7.2__tar.gz → 6.7.3__tar.gz

{boarddata-6.7.2 → boarddata-6.7.3}/PKG-INFO

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

{boarddata-6.7.2 → boarddata-6.7.3}/__init__.py

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

{boarddata-6.7.2 → boarddata-6.7.3}/_comex.py

@@ -349,6 +349,11 @@ class ComexMixin:
         discretionary_grant: bool | None = None,
         subsidiary_remuneration: str | None = None,
         remuneration_via_holding: bool | None = None,
+        sti_basis: str | None = None,
+        variable_target_value: str | None = None,
+        variable_max_value: str | None = None,
+        lti_grant_cap_basis: str | None = None,
+        lti_grant_cap_value: str | None = None,
         currency: str | None = None,
         field_sources: list[FieldSourcePayload] | None = None,
         criteria: list[dict[str, Any]] | None = None,
@@ -397,6 +402,12 @@ class ComexMixin:
             discretionary_grant: Whether discretionary grant applies.
             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_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).
+            lti_grant_cap_basis: Disclosed LTI grant-cap basis (frozen enum).
+            lti_grant_cap_value: LTI grant cap in the DISCLOSED basis (decimal string).
             currency: Currency code (e.g. ``"EUR"``).
             field_sources: Document provenance for fields.
             criteria: List of compensation criteria dicts.
@@ -448,6 +459,11 @@ class ComexMixin:
             discretionary_grant=discretionary_grant,
             subsidiary_remuneration=subsidiary_remuneration,
             remuneration_via_holding=remuneration_via_holding,
+            sti_basis=sti_basis,
+            variable_target_value=variable_target_value,
+            variable_max_value=variable_max_value,
+            lti_grant_cap_basis=lti_grant_cap_basis,
+            lti_grant_cap_value=lti_grant_cap_value,
             currency=currency,
             field_sources=field_sources,
             criteria=criteria,
@@ -498,6 +514,11 @@ class ComexMixin:
         discretionary_grant: bool | None = None,
         subsidiary_remuneration: str | None = None,
         remuneration_via_holding: bool | None = None,
+        sti_basis: str | None = None,
+        variable_target_value: str | None = None,
+        variable_max_value: str | None = None,
+        lti_grant_cap_basis: str | None = None,
+        lti_grant_cap_value: str | None = None,
         currency: str | None = None,
         field_sources: list[FieldSourcePayload] | None = None,
         criteria: list[dict[str, Any]] | None = None,
@@ -546,6 +567,12 @@ class ComexMixin:
             discretionary_grant: Whether discretionary grant applies.
             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_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).
+            lti_grant_cap_basis: Disclosed LTI grant-cap basis (frozen enum).
+            lti_grant_cap_value: LTI grant cap in the DISCLOSED basis (decimal string).
             currency: Currency code (e.g. ``"EUR"``).
             field_sources: Document provenance for fields.
             criteria: List of compensation criteria dicts.
@@ -597,6 +624,11 @@ class ComexMixin:
             discretionary_grant=discretionary_grant,
             subsidiary_remuneration=subsidiary_remuneration,
             remuneration_via_holding=remuneration_via_holding,
+            sti_basis=sti_basis,
+            variable_target_value=variable_target_value,
+            variable_max_value=variable_max_value,
+            lti_grant_cap_basis=lti_grant_cap_basis,
+            lti_grant_cap_value=lti_grant_cap_value,
             currency=currency,
             field_sources=field_sources,
             criteria=criteria,

{boarddata-6.7.2 → boarddata-6.7.3}/boarddata.egg-info/PKG-INFO

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

{boarddata-6.7.2 → boarddata-6.7.3}/pyproject.toml

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

{boarddata-6.7.2 → boarddata-6.7.3}/tests/test_comex.py

@@ -159,3 +159,45 @@ class TestReplaceComexCompensation:
         c._request.return_value = {"id": "comp10", "action": "created"}
         result = c.replace_comex_compensation("comex-uuid", 2024, "POLITIC", fixed="1.00")
         assert result["action"] == "created"
+
+
+def test_envelope_scalar_kwargs_in_signatures():
+    import inspect
+
+    from boarddata import BoardDataClient
+
+    for method in (
+        BoardDataClient.create_comex_compensation,
+        BoardDataClient.replace_comex_compensation,
+    ):
+        params = inspect.signature(method).parameters
+        for k in (
+            "sti_basis",
+            "variable_target_value",
+            "variable_max_value",
+            "lti_grant_cap_basis",
+            "lti_grant_cap_value",
+        ):
+            assert k in params, f"{method.__name__} missing {k}"
+
+
+def test_envelope_scalars_reach_the_wire():
+    c = make_client()
+    c._request.return_value = {"id": "1", "action": "created"}
+    c.replace_comex_compensation(
+        "uid",
+        2025,
+        "real",
+        sti_basis="pct_of_fixed",
+        variable_target_value="150",
+        variable_max_value="180",
+        lti_grant_cap_basis="pct_of_fixed",
+        lti_grant_cap_value="150",
+    )
+    _, kwargs = c._request.call_args
+    p = kwargs["json"]
+    assert p["sti_basis"] == "pct_of_fixed"
+    assert p["variable_target_value"] == "150"
+    assert p["variable_max_value"] == "180"
+    assert p["lti_grant_cap_basis"] == "pct_of_fixed"
+    assert p["lti_grant_cap_value"] == "150"

{boarddata-6.7.2 → boarddata-6.7.3}/types/comex.py

@@ -110,6 +110,11 @@ class ComexCompensationItem(TypedDict):
     holding: bool
     has_employment_contract: bool
     remuneration_via_holding: bool
+    sti_basis: str
+    variable_target_value: str | None
+    variable_max_value: str | None
+    lti_grant_cap_basis: str
+    lti_grant_cap_value: str | None
     total: str | None
     total_paid: str | None
     currency: str
@@ -158,6 +163,11 @@ class ComexCompensationDetail(TypedDict):
     discretionary_grant: bool
     subsidiary_remuneration: str | None
     remuneration_via_holding: bool
+    sti_basis: str
+    variable_target_value: str | None
+    variable_max_value: str | None
+    lti_grant_cap_basis: str
+    lti_grant_cap_value: str | None
     currency: str
     total: str | None
     total_paid: str | None
@@ -206,6 +216,11 @@ class CreateComexCompensationPayload(TypedDict):
     discretionary_grant: NotRequired[bool]
     subsidiary_remuneration: NotRequired[str | None]
     remuneration_via_holding: NotRequired[bool]
+    sti_basis: NotRequired[str]
+    variable_target_value: NotRequired[str | None]
+    variable_max_value: NotRequired[str | None]
+    lti_grant_cap_basis: NotRequired[str]
+    lti_grant_cap_value: NotRequired[str | None]
     currency: NotRequired[str]
     field_sources: NotRequired[list[FieldSourcePayload]]
     criteria: NotRequired[list[dict[str, Any]]]
@@ -252,6 +267,11 @@ class UpdateComexCompensationPayload(TypedDict, total=False):
     discretionary_grant: bool
     subsidiary_remuneration: str | None
     remuneration_via_holding: bool
+    sti_basis: str
+    variable_target_value: str | None
+    variable_max_value: str | None
+    lti_grant_cap_basis: str
+    lti_grant_cap_value: str | None
     currency: str
     field_sources: list[FieldSourcePayload]
     criteria: list[dict[str, Any]]