Add ZIP tool

Assisted-by: Codex

Author: datalogics-cgreen

src/pdfrest/client.py

@@ -104,6 +104,7 @@
     TiffPdfRestPayload,
     TranslatePdfTextPayload,
     UploadURLs,
+    ZipPayload,
 )
 from .types import (
     ALL_PDF_INFO_QUERIES,
@@ -2554,6 +2555,32 @@ def merge_pdfs(
             timeout=timeout,
         )
 
+    def zip_files(
+        self,
+        files: PdfRestFile | Sequence[PdfRestFile],
+        *,
+        output: str | None = None,
+        extra_query: Query | None = None,
+        extra_headers: AnyMapping | None = None,
+        extra_body: Body | None = None,
+        timeout: TimeoutTypes | None = None,
+    ) -> PdfRestFileBasedResponse:
+        """Compress one or more files into a zip archive."""
+
+        payload: dict[str, Any] = {"files": files}
+        if output is not None:
+            payload["output"] = output
+
+        return self._post_file_operation(
+            endpoint="/zip",
+            payload=payload,
+            payload_model=ZipPayload,
+            extra_query=extra_query,
+            extra_headers=extra_headers,
+            extra_body=extra_body,
+            timeout=timeout,
+        )
+
     def convert_to_excel(
         self,
         file: PdfRestFile | Sequence[PdfRestFile],
@@ -3596,6 +3623,32 @@ async def merge_pdfs(
             timeout=timeout,
         )
 
+    async def zip_files(
+        self,
+        files: PdfRestFile | Sequence[PdfRestFile],
+        *,
+        output: str | None = None,
+        extra_query: Query | None = None,
+        extra_headers: AnyMapping | None = None,
+        extra_body: Body | None = None,
+        timeout: TimeoutTypes | None = None,
+    ) -> PdfRestFileBasedResponse:
+        """Asynchronously compress one or more files into a zip archive."""
+
+        payload: dict[str, Any] = {"files": files}
+        if output is not None:
+            payload["output"] = output
+
+        return await self._post_file_operation(
+            endpoint="/zip",
+            payload=payload,
+            payload_model=ZipPayload,
+            extra_query=extra_query,
+            extra_headers=extra_headers,
+            extra_body=extra_body,
+            timeout=timeout,
+        )
+
     async def convert_to_excel(
         self,
         file: PdfRestFile | Sequence[PdfRestFile],

src/pdfrest/models/_internal.py

@@ -122,6 +122,10 @@ def _serialize_file_ids(value: list[PdfRestFile]) -> str:
     return ",".join(str(file.id) for file in value)
 
 
+def _serialize_file_id_list(value: list[PdfRestFile]) -> list[str]:
+    return [str(file.id) for file in value]
+
+
 def _bool_to_on_off(value: Any) -> Any:
     if isinstance(value, bool):
         return "on" if value else "off"
@@ -239,6 +243,26 @@ class DeletePayload(BaseModel):
     ]
 
 
+class ZipPayload(BaseModel):
+    """Adapt caller options into a pdfRest-ready zip request payload."""
+
+    files: Annotated[
+        list[PdfRestFile],
+        Field(
+            min_length=1,
+            validation_alias=AliasChoices("file", "files"),
+            serialization_alias="id",
+        ),
+        BeforeValidator(_ensure_list),
+        PlainSerializer(_serialize_file_id_list),
+    ]
+    output: Annotated[
+        str | None,
+        Field(serialization_alias="output", min_length=1, default=None),
+        AfterValidator(_validate_output_prefix),
+    ] = None
+
+
 PageNumber = Annotated[int, Field(ge=1), PlainSerializer(lambda x: str(x))]