boarddata 6.7.1__tar.gz → 6.7.3__tar.gz

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

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

{boarddata-6.7.1 → 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.1"
+__version__ = "6.7.3"
 __all__ = [
     "Base",
     "BoardDataClient",

{boarddata-6.7.1 → boarddata-6.7.3}/_assemblies.py

@@ -6,6 +6,7 @@ from typing import Any
 
 from .types.assemblies import (
     AssemblyDetail,
+    AssemblyDocumentLink,
     AssemblyExportItem,
     CreatePresentationPayload,
     CreateQuestionPayload,
@@ -456,6 +457,24 @@ class AssemblyMixin:
         """Delete a question."""
         self._delete(f"assemblies/{assembly_uid}/questions/{pk}/")  # type: ignore[attr-defined]
 
+    # --- Assembly document links ---
+    def link_assembly_document(
+        self, assembly_uid: str, document_id: str, category: str, doc_type: str
+    ) -> AssemblyDocumentLink:
+        """Link a document to an assembly (idempotent; returns the link row).
+
+        The backend refuses cross-company links: ``document`` must belong to the
+        assembly's company.
+        """
+        return self._post(  # type: ignore[attr-defined]
+            f"assemblies/{assembly_uid}/documents/",
+            {"document_id": document_id, "category": category, "doc_type": doc_type},
+        )
+
+    def unlink_assembly_document(self, assembly_uid: str, link_id: str) -> None:
+        """Delete an assembly-document link (the Document itself is untouched)."""
+        self._delete(f"assemblies/{assembly_uid}/documents/{link_id}/")  # type: ignore[attr-defined]
+
     # -- Resolutions --
 
     def list_resolutions(self, **params: Any) -> PaginatedResponse:

{boarddata-6.7.1 → 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.1 → boarddata-6.7.3}/boarddata.egg-info/PKG-INFO

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

{boarddata-6.7.1 → boarddata-6.7.3}/dq/apply.py

@@ -7,10 +7,10 @@ the pghistory audit trail. There is no direct DB write anywhere here.
 
 Reversibility, by action:
   * ``repoint`` — full. Restore the document's previous ISIN.
-  * ``delete``  — partial. The document row is recreated from a full pre-delete
-    snapshot, but its assembly↔document link(s) cannot be restored through the
-    current API (the link is read-only / has no create endpoint). The links are
-    recorded in the manifest so the gap is explicit, never silent.
+  * ``delete``  — full. The document row is recreated from a full pre-delete
+    snapshot, and its assembly↔document link(s) are re-created via
+    ``link_assembly_document``. A link that fails to restore (e.g. a
+    cross-company refusal) is recorded rather than aborting the revert.
   * ``merge``   — refused. Destructive and not yet revertible; ``apply`` raises
     rather than perform an irreversible operation.
 """
@@ -54,6 +54,9 @@ class FixClient(Protocol):
     def update_document(self, uid: str, **kwargs: Any) -> dict[str, Any]: ...
     def delete_document(self, uid: str, *, cascade_field_sources: bool = False) -> None: ...
     def merge_document(self, uid: str, *, into: str) -> dict[str, Any]: ...
+    def link_assembly_document(
+        self, assembly_uid: str, document_id: str, category: str, doc_type: str
+    ) -> dict[str, Any]: ...
 
 
 def _snapshot(client: FixClient, uid: str) -> dict[str, Any]:
@@ -78,9 +81,9 @@ def apply_action(action: FixAction, client: FixClient) -> dict[str, Any] | None:
             "action": "delete",
             "document_id": doc_id,
             "before": before,
-            # links are gone (backend cascade) and not API-restorable — record them
+            # links are gone (backend cascade); recorded so revert can re-create them
             "assembly_links": list(action.before_state.get("assembly_links", [])),
-            "reversible": "partial",
+            "reversible": "full",
         }
 
     if action.action == "repoint":
@@ -155,12 +158,24 @@ def revert_entry(entry: dict[str, Any], client: FixClient) -> dict[str, Any]:
             url=before.get("url"),
             original_url=before.get("original_url"),
         )
+        new_id = new.get("id")
+        restored: list[dict[str, Any]] = []
+        unrestored: list[dict[str, Any]] = []
+        for link in entry.get("assembly_links", []):
+            try:
+                client.link_assembly_document(
+                    link["assembly_id"], new_id, link.get("category", ""), link.get("doc_type", "")
+                )
+                restored.append(link)
+            except Exception as exc:  # noqa: BLE001 — best-effort restore; record, never abort the revert
+                unrestored.append({**link, "error": str(exc)})
         return {
             "document_id": doc_id,
             "reverted": "delete",
-            "status": "partial",  # doc recreated (new id); assembly links not restored
-            "new_document_id": new.get("id"),
-            "unrestored_assembly_links": list(entry.get("assembly_links", [])),
+            "status": "ok" if not unrestored else "partial",
+            "new_document_id": new_id,
+            "restored_assembly_links": restored,
+            "unrestored_assembly_links": unrestored,
         }
 
     raise ApplyError(f"cannot revert action {act!r} for document {doc_id}")

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

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

{boarddata-6.7.1 → boarddata-6.7.3}/tests/test_assemblies.py

@@ -161,3 +161,29 @@ class TestListPublishedAssemblies:
         c.list_published_assemblies(page=2, page_size=500)
         _, kwargs = c._request.call_args
         assert kwargs["params"] == {"page": 2, "page_size": 500}
+
+
+class TestLinkAssemblyDocument:
+    def test_posts_link_payload(self):
+        c = make_client()
+        c._request.return_value = {
+            "id": "link1",
+            "document_id": "doc1",
+            "url": "k.pdf",
+            "title": "Notice",
+            "document_type": "notice_of_gm",
+            "category": "ODJ",
+            "doc_type": "NOTICE",
+        }
+        out = c.link_assembly_document("asm1", "doc1", "ODJ", "NOTICE")
+        args, kwargs = c._request.call_args
+        assert args == ("POST", "assemblies/asm1/documents/")
+        assert kwargs["json"] == {"document_id": "doc1", "category": "ODJ", "doc_type": "NOTICE"}
+        assert out["id"] == "link1"
+
+    def test_unlink_issues_delete(self):
+        c = make_client()
+        c._request.return_value = None
+        c.unlink_assembly_document("asm1", "link1")
+        args, _ = c._request.call_args
+        assert args == ("DELETE", "assemblies/asm1/documents/link1/")

{boarddata-6.7.1 → 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.1 → boarddata-6.7.3}/types/assemblies.py

@@ -248,6 +248,18 @@ class _AssemblyDocumentInline(TypedDict):
     doc_type: str
 
 
+class AssemblyDocumentLink(TypedDict):
+    """A document↔assembly link row (the join shown on an AGM page)."""
+
+    id: str
+    document_id: str
+    url: str
+    title: str
+    document_type: str
+    category: str
+    doc_type: str
+
+
 # -- Assemblies --
 
 

{boarddata-6.7.1 → 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]]