reconify-python 2.1.0__tar.gz → 2.2.0__tar.gz

reconify_python-2.2.0/.openapi-contract.json

@@ -0,0 +1,4 @@
+{
+  "version": "2.3.0",
+  "sha256": "cba4133401cc2364b4de7f270c4de43f151775be4d8930232888f2f5e70b6920"
+}

{reconify_python-2.1.0 → reconify_python-2.2.0}/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 2.2.0
+
+- Synced with the public API contract 2.3.0.
+- Added settlement event types, causation and revision metadata, financial
+  breakdowns, and settlement allocations.
+- Added single-event and bare-array ingestion payloads alongside wrapped batches.
+- Added synchronous and asynchronous on-chain evidence source registration.
+
 ## 2.1.0
 
 - Added optional `correlation_id` support to the typed monitoring event request

{reconify_python-2.1.0 → reconify_python-2.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: reconify-python
-Version: 2.1.0
+Version: 2.2.0
 Summary: Typed Python client for the Reconify Public API
 License: MIT
 License-File: LICENSE
@@ -41,8 +41,9 @@ staging or self-hosted endpoint, and URLs with or without `/v2` are accepted.
 
 ## Public resources
 
-The client exposes metadata, events, ingestion, issues, and organization. The
-current public contract contains exactly 13 operations. Python methods use
+The client exposes metadata, events, ingestion, issues, organization, and
+on-chain evidence registration. The current public contract contains exactly
+14 operations. Python methods use
 `snake_case` names and typed Pydantic v2 models from `reconify.models`.
 
 Sync and async clients provide cursor iterators:
@@ -81,6 +82,9 @@ Generated operation IDs use stable `resource_action` identifiers while the
 Python resource methods retain their snake_case names. See
 [UPGRADING.md](UPGRADING.md).
 
+Version `2.2.0` adds settlement event fields, flexible ingestion payloads, and
+on-chain evidence source registration. See [UPGRADING.md](UPGRADING.md).
+
 ## Build and release
 
 ```sh

{reconify_python-2.1.0 → reconify_python-2.2.0}/README.md

@@ -23,8 +23,9 @@ staging or self-hosted endpoint, and URLs with or without `/v2` are accepted.
 
 ## Public resources
 
-The client exposes metadata, events, ingestion, issues, and organization. The
-current public contract contains exactly 13 operations. Python methods use
+The client exposes metadata, events, ingestion, issues, organization, and
+on-chain evidence registration. The current public contract contains exactly
+14 operations. Python methods use
 `snake_case` names and typed Pydantic v2 models from `reconify.models`.
 
 Sync and async clients provide cursor iterators:
@@ -63,6 +64,9 @@ Generated operation IDs use stable `resource_action` identifiers while the
 Python resource methods retain their snake_case names. See
 [UPGRADING.md](UPGRADING.md).
 
+Version `2.2.0` adds settlement event fields, flexible ingestion payloads, and
+on-chain evidence source registration. See [UPGRADING.md](UPGRADING.md).
+
 ## Build and release
 
 ```sh

{reconify_python-2.1.0 → reconify_python-2.2.0}/UPGRADING.md

@@ -34,3 +34,28 @@ MonitoringEvent(
 
 The value is sent as event metadata and does not change operation grouping or
 evaluation behavior.
+
+## Upgrading to 2.2.0
+
+The 2.2.0 client follows public API contract 2.3.0. Monitoring ingestion now
+accepts a single `MonitoringEvent`, a list of events, or the existing
+`MonitoringBatchRequest` wrapper. Settlement flows and event types support
+financial breakdowns, allocations, causation IDs, and revision IDs.
+
+On-chain evidence enrichment can be queued for an accepted event:
+
+```python
+client.onchain.register_onchain_source(
+    OnchainSourceRequest(
+        flow="provider_to_settlement_account",
+        operation_reference="settlement-123",
+        source_event_id="evt_01J3Y0M8VJQ5W1R3E4J4K7N8P9",
+        kind="transaction",
+        locator=OnchainSourceLocator(
+            network="ethereum-mainnet",
+            transaction_reference="0x...",
+        ),
+    ),
+    idempotency_key="source-settlement-123",
+)
+```

{reconify_python-2.1.0 → reconify_python-2.2.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "reconify-python"
-version = "2.1.0"
+version = "2.2.0"
 description = "Typed Python client for the Reconify Public API"
 readme = "README.md"
 requires-python = ">=3.10"

{reconify_python-2.1.0 → reconify_python-2.2.0}/src/reconify/__init__.py

@@ -1,6 +1,6 @@
 """Typed clients for the Reconify Public API."""
 
-__version__ = "1.0.0"
+__version__ = "2.2.0"
 
 from .client import AsyncReconify, Reconify
 from .errors import (

{reconify_python-2.1.0 → reconify_python-2.2.0}/src/reconify/client.py

@@ -17,11 +17,13 @@ from .resources import (
     AsyncIngestion,
     AsyncIssues,
     AsyncMetadata,
+    AsyncOnchain,
     AsyncOrganization,
     Events,
     Ingestion,
     Issues,
     Metadata,
+    Onchain,
     Organization,
 )
 from .transport import AsyncTransport, RetryConfig, SyncTransport
@@ -51,6 +53,7 @@ class Reconify:
     ingestion: Ingestion
     issues: Issues
     organization: Organization
+    onchain: Onchain
 
     def __init__(
         self,
@@ -108,6 +111,7 @@ class AsyncReconify:
     ingestion: AsyncIngestion
     issues: AsyncIssues
     organization: AsyncOrganization
+    onchain: AsyncOnchain
 
     def __init__(
         self,

{reconify_python-2.1.0 → reconify_python-2.2.0}/src/reconify/models.py

@@ -36,6 +36,7 @@ class Flow(TolerantStrEnum):
     PAYMENT_TO_ORDER = "payment_to_order"
     WALLET_TO_WALLET = "wallet_to_wallet"
     WALLET_TO_PAYOUT = "wallet_to_payout"
+    PROVIDER_TO_SETTLEMENT_ACCOUNT = "provider_to_settlement_account"
 
 
 class EventType(TolerantStrEnum):
@@ -49,6 +50,13 @@ class EventType(TolerantStrEnum):
     WALLET_CREDITED = "wallet.credited"
     WALLET_DEBITED = "wallet.debited"
     WALLET_REFUNDED = "wallet.refunded"
+    SETTLEMENT_ALLOCATIONS_RECORDED = "settlement.allocations_recorded"
+    SETTLEMENT_CREATED = "settlement.created"
+    SETTLEMENT_DISBURSED = "settlement.disbursed"
+    SETTLEMENT_FAILED = "settlement.failed"
+    SETTLEMENT_FINALIZED = "settlement.finalized"
+    SETTLEMENT_RECEIVED = "settlement.received"
+    SETTLEMENT_REVISED = "settlement.revised"
 
 
 class EntityType(TolerantStrEnum):
@@ -102,6 +110,44 @@ class MonitoringErrorCode(TolerantStrEnum):
     MALFORMED_REQUEST = "malformed_request"
 
 
+class OnchainSourceKind(TolerantStrEnum):
+    PROVIDER_PAYMENT = "provider_payment"
+    TRANSACTION = "transaction"
+    ADDRESS_REFERENCE = "address_reference"
+
+
+class OnchainNetwork(TolerantStrEnum):
+    ETHEREUM_MAINNET = "ethereum-mainnet"
+    ETHEREUM_SEPOLIA = "ethereum-sepolia"
+    SOLANA_MAINNET = "solana-mainnet"
+    SOLANA_DEVNET = "solana-devnet"
+
+
+class OnchainSourceStatus(TolerantStrEnum):
+    QUEUED = "queued"
+
+
+class FinancialComponentKind(TolerantStrEnum):
+    FEE = "fee"
+    COMMISSION = "commission"
+    TAX = "tax"
+    RESERVE = "reserve"
+    ADJUSTMENT = "adjustment"
+    OTHER = "other"
+
+
+class FinancialComponentEffect(TolerantStrEnum):
+    ADD = "add"
+    DEDUCT = "deduct"
+    INCLUDED = "included"
+
+
+class SettlementAllocationType(TolerantStrEnum):
+    PAYMENT = "payment"
+    REFUND = "refund"
+    CHARGEBACK = "chargeback"
+
+
 class APIInfo(ResponseModel):
     name: str
     version: str
@@ -113,6 +159,31 @@ class Health(ResponseModel):
     status: str
 
 
+class FinancialComponent(RequestModel):
+    amount: str
+    kind: FinancialComponentKind
+    effect: FinancialComponentEffect
+    description: str | None = None
+    provider_type: str | None = None
+    reference: str | None = None
+    metadata: dict[str, str | int | float | bool] | None = None
+
+
+class FinancialBreakdown(RequestModel):
+    gross: str
+    net: str
+    components: list[FinancialComponent] = Field(max_length=100)
+
+
+class SettlementAllocation(RequestModel):
+    allocation_id: str
+    allocation_type: SettlementAllocationType
+    flow: str
+    reference: str
+    amount: str
+    event_id: str | None = None
+
+
 class MonitoringEventData(RequestModel):
     provider: str | None = None
     integration_ref: str | None = None
@@ -121,6 +192,8 @@ class MonitoringEventData(RequestModel):
     failure_code: str | None = None
     failure_message: str | None = None
     retryable: bool | None = None
+    revises_event_id: str | None = None
+    allocations: list[SettlementAllocation] | None = Field(default=None, max_length=500)
 
 
 class MonitoringEvent(RequestModel):
@@ -132,8 +205,10 @@ class MonitoringEvent(RequestModel):
     occurred_at: datetime | None = None
     amount: str | None = None
     correlation_id: str | None = None
+    causation_id: str | None = None
     currency: str | None = None
     data: MonitoringEventData | None = None
+    financial_breakdown: FinancialBreakdown | None = None
     metadata: dict[str, str | int | float | bool] | None = None
 
 
@@ -172,8 +247,17 @@ class Event(ResponseModel):
     received_at: datetime
     amount: str | None = None
     currency: str | None = None
+    causation_id: str | None = None
+    correlation_id: str | None = None
+    revises_event_id: str | None = None
     provider: str | None = None
     status: ReceiptStatus
+    gross: str | None = None
+    net: str | None = None
+    component_count: int | None = None
+    allocation_count: int | None = None
+    financial_breakdown: FinancialBreakdown | None = None
+    allocations: list[SettlementAllocation] | None = None
 
 
 class ListEventsResponse(ResponseModel):
@@ -244,5 +328,31 @@ class Error(ResponseModel):
     detail: str | None = None
 
 
+class OnchainSourceLocator(RequestModel):
+    integration_ref: str | None = None
+    network: OnchainNetwork | None = None
+    protocol_reference: str | None = None
+    provider_reference: str | None = None
+    provider_transaction_id: str | None = None
+    receiving_address: str | None = None
+    transaction_reference: str | None = None
+    window_end: datetime | None = None
+    window_start: datetime | None = None
+
+
+class OnchainSourceRequest(RequestModel):
+    flow: str
+    operation_reference: str = Field(min_length=1, max_length=256)
+    source_event_id: str = Field(min_length=1, max_length=256)
+    kind: OnchainSourceKind
+    locator: OnchainSourceLocator
+
+
+class OnchainSourceResponse(ResponseModel):
+    id: str
+    status: OnchainSourceStatus
+    duplicate: bool
+
+
 def model_dump(model: BaseModel) -> dict[str, Any]:
     return model.model_dump(mode="json", by_alias=True, exclude_none=True, exclude_unset=True)

{reconify_python-2.1.0 → reconify_python-2.2.0}/src/reconify/resources/__init__.py

@@ -4,6 +4,7 @@ from .events import AsyncEvents, Events
 from .ingestion import AsyncIngestion, Ingestion
 from .issues import AsyncIssues, Issues
 from .metadata import AsyncMetadata, Metadata
+from .onchain import AsyncOnchain, Onchain
 from .organization import AsyncOrganization, Organization
 
 SYNC_RESOURCE_CLASSES = {
@@ -12,6 +13,7 @@ SYNC_RESOURCE_CLASSES = {
     "ingestion": Ingestion,
     "issues": Issues,
     "organization": Organization,
+    "onchain": Onchain,
 }
 ASYNC_RESOURCE_CLASSES = {
     "metadata": AsyncMetadata,
@@ -19,6 +21,7 @@ ASYNC_RESOURCE_CLASSES = {
     "ingestion": AsyncIngestion,
     "issues": AsyncIssues,
     "organization": AsyncOrganization,
+    "onchain": AsyncOnchain,
 }
 
 OPERATION_SPECS = {
@@ -35,6 +38,7 @@ OPERATION_SPECS = {
     "issues_add_note": ("issues", "POST", "/issues/{issue_id}/notes"),
     "organization_get": ("organization", "GET", "/organization"),
     "organization_list_members": ("organization", "GET", "/organization/members"),
+    "register-onchain-source": ("onchain", "POST", "/onchain-sources"),
 }
 
 OPERATION_METHODS = {
@@ -51,6 +55,7 @@ OPERATION_METHODS = {
     "issues_add_note": "add_issue_note",
     "organization_get": "get_organization",
     "organization_list_members": "list_organization_members",
+    "register-onchain-source": "register_onchain_source",
 }
 
 __all__ = [
@@ -59,11 +64,13 @@ __all__ = [
     "AsyncIssues",
     "AsyncMetadata",
     "AsyncOrganization",
+    "AsyncOnchain",
     "Events",
     "Ingestion",
     "Issues",
     "Metadata",
     "Organization",
+    "Onchain",
     "ASYNC_RESOURCE_CLASSES",
     "OPERATION_SPECS",
     "OPERATION_METHODS",

{reconify_python-2.1.0 → reconify_python-2.2.0}/src/reconify/resources/ingestion.py

@@ -4,13 +4,16 @@ from __future__ import annotations
 
 from typing import Any
 
-from ..models import MonitoringBatchRequest, MonitoringBatchResponse
+from ..models import MonitoringBatchRequest, MonitoringBatchResponse, MonitoringEvent
 from .base import AsyncResource, SyncResource
 
 
 class Ingestion(SyncResource):
     def ingest_monitoring_events(
-        self, body: MonitoringBatchRequest, raw: bool = False, **query: Any
+        self,
+        body: MonitoringEvent | list[MonitoringEvent] | MonitoringBatchRequest,
+        raw: bool = False,
+        **query: Any,
     ) -> Any:
         return self._request(
             "POST",
@@ -24,7 +27,10 @@ class Ingestion(SyncResource):
 
 class AsyncIngestion(AsyncResource):
     async def ingest_monitoring_events(
-        self, body: MonitoringBatchRequest, raw: bool = False, **query: Any
+        self,
+        body: MonitoringEvent | list[MonitoringEvent] | MonitoringBatchRequest,
+        raw: bool = False,
+        **query: Any,
     ) -> Any:
         return await self._request(
             "POST",

reconify_python-2.2.0/src/reconify/resources/onchain.py

@@ -0,0 +1,57 @@
+"""On-chain evidence source registration resource client."""
+
+from __future__ import annotations
+
+from typing import Any
+
+from ..errors import ReconifyValidationError
+from ..models import OnchainSourceRequest, OnchainSourceResponse
+from .base import AsyncResource, SyncResource
+
+
+class Onchain(SyncResource):
+    def register_onchain_source(
+        self,
+        body: OnchainSourceRequest,
+        *,
+        idempotency_key: str,
+        raw: bool = False,
+        **query: Any,
+    ) -> Any:
+        if not idempotency_key or len(idempotency_key) > 200:
+            raise ReconifyValidationError("idempotency_key must be between 1 and 200 characters")
+        return self._request(
+            "POST",
+            "/onchain-sources",
+            params=query,
+            body=body,
+            response_model=OnchainSourceResponse,
+            raw=raw,
+            headers={"Idempotency-Key": idempotency_key},
+        )
+
+    register_source = register_onchain_source
+
+
+class AsyncOnchain(AsyncResource):
+    async def register_onchain_source(
+        self,
+        body: OnchainSourceRequest,
+        *,
+        idempotency_key: str,
+        raw: bool = False,
+        **query: Any,
+    ) -> Any:
+        if not idempotency_key or len(idempotency_key) > 200:
+            raise ReconifyValidationError("idempotency_key must be between 1 and 200 characters")
+        return await self._request(
+            "POST",
+            "/onchain-sources",
+            params=query,
+            body=body,
+            response_model=OnchainSourceResponse,
+            raw=raw,
+            headers={"Idempotency-Key": idempotency_key},
+        )
+
+    register_source = register_onchain_source

{reconify_python-2.1.0 → reconify_python-2.2.0}/src/reconify/transport.py

@@ -88,6 +88,8 @@ def _validate_request_body(body: Any) -> Any:
             return model_dump(body)
         except ValidationError as exc:
             raise ReconifyValidationError(str(exc)) from exc
+    if isinstance(body, list):
+        return [_validate_request_body(item) for item in body]
     return body
 
 

{reconify_python-2.1.0 → reconify_python-2.2.0}/tests/test_client.py

@@ -5,7 +5,7 @@ import json
 import httpx
 import pytest
 
-from reconify import Reconify
+from reconify import AsyncReconify, Reconify
 from reconify.errors import (
     ReconifyAuthenticationError,
     ReconifyConflictError,
@@ -19,6 +19,8 @@ from reconify.models import (
     AddNoteRequest,
     MonitoringBatchRequest,
     MonitoringEvent,
+    OnchainSourceLocator,
+    OnchainSourceRequest,
     PatchIssueRequest,
 )
 from reconify.transport import RetryConfig
@@ -144,6 +146,116 @@ def test_note_idempotency_header_and_issue_assignment() -> None:
     assert requests[1].method == "PATCH"
 
 
+def test_onchain_source_registration() -> None:
+    requests: list[httpx.Request] = []
+
+    def handler(request: httpx.Request) -> httpx.Response:
+        requests.append(request)
+        return httpx.Response(
+            202, json={"id": "src-1", "status": "queued", "duplicate": False}, request=request
+        )
+
+    body = OnchainSourceRequest(
+        flow="provider_to_settlement_account",
+        operation_reference="settlement-1",
+        source_event_id="evt_1",
+        kind="transaction",
+        locator=OnchainSourceLocator(network="ethereum-mainnet", transaction_reference="0xabc"),
+    )
+    with Reconify(
+        "rk_test",
+        base_url="http://api.test",
+        http_client=httpx.Client(transport=httpx.MockTransport(handler)),
+    ) as client:
+        result = client.onchain.register_onchain_source(body, idempotency_key="source-1")
+
+    assert result.id == "src-1"
+    assert requests[0].url.path == "/v2/onchain-sources"
+    assert requests[0].headers["Idempotency-Key"] == "source-1"
+    assert json.loads(requests[0].content)["locator"]["transaction_reference"] == "0xabc"
+
+
+async def test_async_onchain_source_registration() -> None:
+    requests: list[httpx.Request] = []
+
+    def handler(request: httpx.Request) -> httpx.Response:
+        requests.append(request)
+        return httpx.Response(
+            202, json={"id": "src-1", "status": "queued", "duplicate": False}, request=request
+        )
+
+    body = OnchainSourceRequest(
+        flow="provider_to_settlement_account",
+        operation_reference="settlement-1",
+        source_event_id="evt_1",
+        kind="transaction",
+        locator=OnchainSourceLocator(network="ethereum-mainnet"),
+    )
+    async with AsyncReconify(
+        "rk_test",
+        base_url="http://api.test",
+        http_client=httpx.AsyncClient(transport=httpx.MockTransport(handler)),
+    ) as client:
+        result = await client.onchain.register_onchain_source(body, idempotency_key="source-1")
+
+    assert result.status == "queued"
+    assert requests[0].headers["Idempotency-Key"] == "source-1"
+
+
+def test_expanded_event_fields_parse() -> None:
+    from reconify.models import Event
+
+    event = Event.model_validate(
+        {
+            **_event(),
+            "flow": "provider_to_settlement_account",
+            "event_type": "settlement.created",
+            "entity_type": "settlement_account",
+            "causation_id": "evt_prior",
+            "correlation_id": "settlement-1",
+            "revises_event_id": None,
+            "gross": "100.00",
+            "net": "98.00",
+            "component_count": 1,
+            "allocation_count": 0,
+        }
+    )
+
+    assert event.event_type.value == "settlement.created"
+    assert event.gross == "100.00"
+
+
+@pytest.mark.parametrize(
+    "body",
+    [
+        MonitoringEvent(
+            flow="payment_to_wallet", type="payment.succeeded", reference="r", entity_id="w"
+        ),
+        [
+            MonitoringEvent(
+                flow="payment_to_wallet", type="payment.succeeded", reference="r", entity_id="w"
+            )
+        ],
+    ],
+)
+def test_ingestion_accepts_single_and_bare_array(body: object) -> None:
+    requests: list[httpx.Request] = []
+
+    def handler(request: httpx.Request) -> httpx.Response:
+        requests.append(request)
+        return httpx.Response(202, json={"results": []}, request=request)
+
+    with Reconify(
+        "rk_test",
+        base_url="http://api.test",
+        http_client=httpx.Client(transport=httpx.MockTransport(handler)),
+    ) as client:
+        client.ingestion.ingest_monitoring_events(body)  # type: ignore[arg-type]
+
+    payload = json.loads(requests[0].content)
+    assert isinstance(payload, (dict, list))
+
+
 def test_errors_are_typed_and_safe() -> None:
     def handler(request: httpx.Request) -> httpx.Response:
         return httpx.Response(
@@ -179,9 +291,7 @@ def test_errors_are_typed_and_safe() -> None:
         (503, ReconifyServiceUnavailableError),
     ],
 )
-def test_public_error_statuses_are_typed(
-    status: int, error_type: type[Exception]
-) -> None:
+def test_public_error_statuses_are_typed(status: int, error_type: type[Exception]) -> None:
     def handler(request: httpx.Request) -> httpx.Response:
         return httpx.Response(
             status,

{reconify_python-2.1.0 → reconify_python-2.2.0}/tests/test_openapi_coverage.py

@@ -40,7 +40,7 @@ def test_openapi_contains_only_public_routes() -> None:
 
 def test_every_openapi_operation_has_a_public_method() -> None:
     operations = _operations()
-    assert len(operations) == 13
+    assert len(operations) == 14
     assert len({operation_id for operation_id, _, _ in operations}) == len(operations)
     assert len(OPERATION_SPECS) == len(operations)
     for operation_id, verb, route in operations:

reconify_python-2.1.0/.openapi-contract.json

@@ -1,4 +0,0 @@
-{
-  "version": "2.0.0",
-  "sha256": "5cccdf920a62fb325c7fcf9410728889858d156831a78760e41e3f98774db7f2"
-}