tests: Assert encryption/password payloads via public payload models

- add `pdfrest.models.payloads` as a public export surface for
  `PdfEncryptPayload`, `PdfDecryptPayload`, `PdfRestrictPayload`, and
  `PdfUnrestrictPayload`
- re-export payload models from `pdfrest.models` for test usage without private
  imports
- update encrypt/restrict unit tests to build expected JSON via
  `model_validate(...).model_dump(...)` instead of hand-built dicts
- fix a circular import by importing `PdfRestFile` from `models.public` inside
  `_internal.py`

Assisted-by: Codex

Author: datalogics-cgreen

src/pdfrest/models/__init__.py

@@ -1,3 +1,9 @@
+from .payloads import (
+    PdfDecryptPayload,
+    PdfEncryptPayload,
+    PdfRestrictPayload,
+    PdfUnrestrictPayload,
+)
 from .public import (
     PdfRestDeletionResponse,
     PdfRestErrorResponse,
@@ -12,12 +18,16 @@
 )
 
 __all__ = [
+    "PdfDecryptPayload",
+    "PdfEncryptPayload",
     "PdfRestDeletionResponse",
     "PdfRestErrorResponse",
     "PdfRestFile",
     "PdfRestFileBasedResponse",
     "PdfRestFileID",
     "PdfRestInfoResponse",
+    "PdfRestrictPayload",
+    "PdfUnrestrictPayload",
     "SummarizePdfTextResponse",
     "TranslatePdfTextFileResponse",
     "TranslatePdfTextResponse",

src/pdfrest/models/_internal.py

@@ -33,8 +33,7 @@
     SummaryOutputType,
     TranslateOutputFormat,
 )
-from . import PdfRestFile
-from .public import PdfRestFileID
+from .public import PdfRestFile, PdfRestFileID
 
 
 def _ensure_list(value: Any) -> Any:

src/pdfrest/models/payloads.py

@@ -0,0 +1,15 @@
+"""Public payload models used to validate request serialization in tests."""
+
+from ._internal import (
+    PdfDecryptPayload,
+    PdfEncryptPayload,
+    PdfRestrictPayload,
+    PdfUnrestrictPayload,
+)
+
+__all__ = (
+    "PdfDecryptPayload",
+    "PdfEncryptPayload",
+    "PdfRestrictPayload",
+    "PdfUnrestrictPayload",
+)

tests/test_encrypt_pdf.py

@@ -8,7 +8,13 @@
 from pydantic import ValidationError
 
 from pdfrest import AsyncPdfRestClient, PdfRestClient
-from pdfrest.models import PdfRestFile, PdfRestFileBasedResponse, PdfRestFileID
+from pdfrest.models import (
+    PdfDecryptPayload,
+    PdfEncryptPayload,
+    PdfRestFile,
+    PdfRestFileBasedResponse,
+    PdfRestFileID,
+)
 
 from .graphics_test_helpers import (
     ASYNC_API_KEY,
@@ -39,18 +45,16 @@ def build_encrypt_payload(
     current_open_password: str | None = None,
     current_permissions_password: str | None = None,
     output: str | None = None,
-) -> dict[str, str]:
-    payload: dict[str, str] = {
-        "id": str(input_file.id),
-        "new_open_password": new_open_password,
-    }
-    if current_open_password is not None:
-        payload["current_open_password"] = current_open_password
-    if current_permissions_password is not None:
-        payload["current_permissions_password"] = current_permissions_password
-    if output is not None:
-        payload["output"] = output
-    return payload
+) -> dict[str, object]:
+    return PdfEncryptPayload.model_validate(
+        {
+            "files": [input_file],
+            "new_open_password": new_open_password,
+            "current_open_password": current_open_password,
+            "current_permissions_password": current_permissions_password,
+            "output": output,
+        }
+    ).model_dump(mode="json", by_alias=True, exclude_none=True, exclude_unset=True)
 
 
 def build_decrypt_payload(
@@ -59,16 +63,15 @@ def build_decrypt_payload(
     current_open_password: str,
     current_permissions_password: str | None = None,
     output: str | None = None,
-) -> dict[str, str]:
-    payload: dict[str, str] = {
-        "id": str(input_file.id),
-        "current_open_password": current_open_password,
-    }
-    if current_permissions_password is not None:
-        payload["current_permissions_password"] = current_permissions_password
-    if output is not None:
-        payload["output"] = output
-    return payload
+) -> dict[str, object]:
+    return PdfDecryptPayload.model_validate(
+        {
+            "files": [input_file],
+            "current_open_password": current_open_password,
+            "current_permissions_password": current_permissions_password,
+            "output": output,
+        }
+    ).model_dump(mode="json", by_alias=True, exclude_none=True, exclude_unset=True)
 
 
 @pytest.mark.parametrize(

tests/test_permissions_password.py

@@ -8,7 +8,13 @@
 from pydantic import ValidationError
 
 from pdfrest import AsyncPdfRestClient, PdfRestClient
-from pdfrest.models import PdfRestFile, PdfRestFileBasedResponse, PdfRestFileID
+from pdfrest.models import (
+    PdfRestFile,
+    PdfRestFileBasedResponse,
+    PdfRestFileID,
+    PdfRestrictPayload,
+    PdfUnrestrictPayload,
+)
 from pdfrest.types import PdfRestriction
 
 from .graphics_test_helpers import (
@@ -41,20 +47,17 @@ def build_restrict_payload(
     current_open_password: str | None = None,
     restrictions: list[PdfRestriction] | None = None,
     output: str | None = None,
-) -> dict[str, str | list[PdfRestriction]]:
-    payload: dict[str, str | list[PdfRestriction]] = {
-        "id": str(input_file.id),
-        "new_permissions_password": new_permissions_password,
-    }
-    if current_permissions_password is not None:
-        payload["current_permissions_password"] = current_permissions_password
-    if current_open_password is not None:
-        payload["current_open_password"] = current_open_password
-    if restrictions is not None:
-        payload["restrictions"] = restrictions
-    if output is not None:
-        payload["output"] = output
-    return payload
+) -> dict[str, object]:
+    return PdfRestrictPayload.model_validate(
+        {
+            "files": [input_file],
+            "new_permissions_password": new_permissions_password,
+            "current_permissions_password": current_permissions_password,
+            "current_open_password": current_open_password,
+            "restrictions": restrictions,
+            "output": output,
+        }
+    ).model_dump(mode="json", by_alias=True, exclude_none=True, exclude_unset=True)
 
 
 def build_unrestrict_payload(
@@ -63,16 +66,15 @@ def build_unrestrict_payload(
     current_permissions_password: str,
     current_open_password: str | None = None,
     output: str | None = None,
-) -> dict[str, str]:
-    payload: dict[str, str] = {
-        "id": str(input_file.id),
-        "current_permissions_password": current_permissions_password,
-    }
-    if current_open_password is not None:
-        payload["current_open_password"] = current_open_password
-    if output is not None:
-        payload["output"] = output
-    return payload
+) -> dict[str, object]:
+    return PdfUnrestrictPayload.model_validate(
+        {
+            "files": [input_file],
+            "current_permissions_password": current_permissions_password,
+            "current_open_password": current_open_password,
+            "output": output,
+        }
+    ).model_dump(mode="json", by_alias=True, exclude_none=True, exclude_unset=True)
 
 
 @pytest.mark.parametrize(