Update compensated dataset model

src/datacollective/models.py

@@ -3,7 +3,14 @@
 from enum import Enum
 from typing import Any, ClassVar
 
-from pydantic import BaseModel, ConfigDict, Field, field_validator, model_validator
+from pydantic import (
+    BaseModel,
+    ConfigDict,
+    Field,
+    computed_field,
+    field_validator,
+    model_validator,
+)
 
 
 class UploadPart(BaseModel):
@@ -284,6 +291,13 @@ def _validate_pricing(self) -> DatasetSubmission:
             )
         return self
 
+    @computed_field(  # type: ignore[prop-decorator]
+        description="Currency for `basePriceCents`. Always `usd`, the only currency the platform currently supports."
+    )
+    @property
+    def currency(self) -> str | None:
+        return "usd" if self.isPaid else None
+
 
 class DatasetDetails(Dataset):
     """
@@ -377,6 +391,7 @@ def get(self, key: str, default: Any = None) -> Any:
     "exclusivityOptOut",
     "isPaid",
     "basePriceCents",
+    "currency",
 }
 SUBMIT_FIELDS = {"agreeToSubmit"}
 

tests/test_models.py

@@ -184,6 +184,21 @@ def test_price_requires_paid_dataset() -> None:
         DatasetSubmission(isPaid=False, basePriceCents=25_000)
 
 
+def test_currency_is_set_only_when_paid() -> None:
+    free = DatasetSubmission(name="Free")
+    assert free.currency is None
+    assert "currency" not in free.model_dump(exclude_none=True)
+
+    paid = DatasetSubmission(isPaid=True, basePriceCents=25_000)
+    assert paid.currency == "usd"
+    assert paid.model_dump(mode="json", exclude_none=True)["currency"] == "usd"
+
+
+def test_currency_is_not_a_settable_field() -> None:
+    with pytest.raises(ValidationError):
+        DatasetSubmission(isPaid=True, basePriceCents=25_000, currency="eur")
+
+
 def test_dataset_details_requires_id() -> None:
     with pytest.raises(ValidationError):
         DatasetDetails.model_validate({"filename": "dataset.tar.gz"})