Fix: allow partial user objects for created_by and last_edited_by page properties

devenv.nix

@@ -40,4 +40,8 @@
   scripts.format.exec = ''
     pre-commit run --all-files
   '';
+
+  enterTest = ''
+    poetry run pytest
+  '';
 }

pydantic_api/notion/models/objects/properties/page_property.py

@@ -9,7 +9,7 @@
 from pydantic import AnyUrl, Field, EmailStr
 
 from pydantic_api.base import BaseModel
-from ..user import UserObject, UserObjectFactory
+from ..user import DeletedUserObject, UserObject, UserObjectFactory
 from ..file import FileObject, FileObjectFactory
 from ..block import RichTextObject, RichTextObjectFactory
 from .common import (
@@ -55,7 +55,7 @@ def new(
 # created_by, Refer to https://developers.notion.com/reference/page-property-values#created_by
 class CreatedByProperty(BasePageProperty):
     type: Literal["created_by"] = "created_by"
-    created_by: UserObject
+    created_by: Union[UserObject, DeletedUserObject]
 
     @classmethod
     def new_from_person(
@@ -192,7 +192,7 @@ class FormulaProperty(BasePageProperty):
 # last_edited_by: Refer to https://developers.notion.com/reference/page-property-values#last_edited_by
 class LastEditedByProperty(BasePageProperty):
     type: Literal["last_edited_by"] = "last_edited_by"
-    last_edited_by: UserObject
+    last_edited_by: Union[UserObject, DeletedUserObject]
 
     @classmethod
     def new_from_person(

pydantic_api/notion/models/objects/user.py

@@ -102,6 +102,11 @@ class BotUserObject(_BaseUserObject):
     )
 
 
+class DeletedUserObject(PartialUser):
+    """A deleted user object."""
+    pass
+
+
 UserObject = Annotated[
     Union[PersonUserObject, BotUserObject], Field(discriminator="type")
 ]

pyproject.toml

@@ -27,6 +27,7 @@ pydantic-api-models = "^0.0.2"
 
 [tool.poetry.group.dev.dependencies]
 mypy = "^1.15.0"
+pytest = "^8.0.0"
 
 [build-system]
 requires = ["poetry-core>=1.5.0"]

tests/test_user_object.py

@@ -0,0 +1,18 @@
+import uuid
+from pydantic_api.notion.models.objects.properties.page_property import CreatedByProperty
+from pydantic_api.notion.models.objects.user import UserObject, DeletedUserObject
+
+
+def test_userobject_accepts_deleteduser():
+    user_id = uuid.uuid4()
+    data = {
+        "type": "created_by",
+        "created_by": {
+            "object": "user",
+            "id": user_id,
+        }
+    }
+    created_by = CreatedByProperty.model_validate(data)
+    assert isinstance(created_by.created_by, DeletedUserObject)
+    assert created_by.created_by.object == "user"
+    assert created_by.created_by.id == user_id