PDFCLOUD-5548 Add "Add to PDF" client methods

src/pdfrest/client.py

@@ -82,6 +82,9 @@
     GifPdfRestPayload,
     JpegPdfRestPayload,
     OcrPdfPayload,
+    PdfAddAttachmentPayload,
+    PdfAddImagePayload,
+    PdfAddTextPayload,
     PdfCompressPayload,
     PdfDecryptPayload,
     PdfEncryptPayload,
@@ -120,6 +123,7 @@
     GraphicSmoothing,
     JpegColorModel,
     OcrLanguage,
+    PdfAddTextObject,
     PdfAType,
     PdfInfoQuery,
     PdfMergeInput,
@@ -2547,6 +2551,72 @@ def apply_redactions(
             timeout=timeout,
         )
 
+    def add_text_to_pdf(
+        self,
+        file: PdfRestFile | Sequence[PdfRestFile],
+        *,
+        text_objects: PdfAddTextObject | Sequence[PdfAddTextObject],
+        output: str | None = None,
+        extra_query: Query | None = None,
+        extra_headers: AnyMapping | None = None,
+        extra_body: Body | None = None,
+        timeout: TimeoutTypes | None = None,
+    ) -> PdfRestFileBasedResponse:
+        """Insert one or more text blocks into a PDF."""
+
+        payload: dict[str, Any] = {
+            "files": file,
+            "text_objects": text_objects,
+        }
+        if output is not None:
+            payload["output"] = output
+
+        return self._post_file_operation(
+            endpoint="/pdf-with-added-text",
+            payload=payload,
+            payload_model=PdfAddTextPayload,
+            extra_query=extra_query,
+            extra_headers=extra_headers,
+            extra_body=extra_body,
+            timeout=timeout,
+        )
+
+    def add_image_to_pdf(
+        self,
+        file: PdfRestFile | Sequence[PdfRestFile],
+        *,
+        image: PdfRestFile | Sequence[PdfRestFile],
+        x: int,
+        y: int,
+        page: int,
+        output: str | None = None,
+        extra_query: Query | None = None,
+        extra_headers: AnyMapping | None = None,
+        extra_body: Body | None = None,
+        timeout: TimeoutTypes | None = None,
+    ) -> PdfRestFileBasedResponse:
+        """Insert an image into a single page of a PDF."""
+
+        payload: dict[str, Any] = {
+            "files": file,
+            "image": image,
+            "x": x,
+            "y": y,
+            "page": page,
+        }
+        if output is not None:
+            payload["output"] = output
+
+        return self._post_file_operation(
+            endpoint="/pdf-with-added-image",
+            payload=payload,
+            payload_model=PdfAddImagePayload,
+            extra_query=extra_query,
+            extra_headers=extra_headers,
+            extra_body=extra_body,
+            timeout=timeout,
+        )
+
     def split_pdf(
         self,
         file: PdfRestFile | Sequence[PdfRestFile],
@@ -2973,6 +3043,33 @@ def compress_pdf(
             timeout=timeout,
         )
 
+    def add_attachment_to_pdf(
+        self,
+        file: PdfRestFile | Sequence[PdfRestFile],
+        *,
+        attachment: 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:
+        """Attach an uploaded file to a PDF."""
+
+        payload: dict[str, Any] = {"files": file, "attachment": attachment}
+        if output is not None:
+            payload["output"] = output
+
+        return self._post_file_operation(
+            endpoint="/pdf-with-added-attachment",
+            payload=payload,
+            payload_model=PdfAddAttachmentPayload,
+            extra_query=extra_query,
+            extra_headers=extra_headers,
+            extra_body=extra_body,
+            timeout=timeout,
+        )
+
     def flatten_transparencies(
         self,
         file: PdfRestFile | Sequence[PdfRestFile],
@@ -3792,6 +3889,72 @@ async def apply_redactions(
             timeout=timeout,
         )
 
+    async def add_text_to_pdf(
+        self,
+        file: PdfRestFile | Sequence[PdfRestFile],
+        *,
+        text_objects: PdfAddTextObject | Sequence[PdfAddTextObject],
+        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 insert text blocks into a PDF."""
+
+        payload: dict[str, Any] = {
+            "files": file,
+            "text_objects": text_objects,
+        }
+        if output is not None:
+            payload["output"] = output
+
+        return await self._post_file_operation(
+            endpoint="/pdf-with-added-text",
+            payload=payload,
+            payload_model=PdfAddTextPayload,
+            extra_query=extra_query,
+            extra_headers=extra_headers,
+            extra_body=extra_body,
+            timeout=timeout,
+        )
+
+    async def add_image_to_pdf(
+        self,
+        file: PdfRestFile | Sequence[PdfRestFile],
+        *,
+        image: PdfRestFile | Sequence[PdfRestFile],
+        x: int,
+        y: int,
+        page: int,
+        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 insert an image into a PDF."""
+
+        payload: dict[str, Any] = {
+            "files": file,
+            "image": image,
+            "x": x,
+            "y": y,
+            "page": page,
+        }
+        if output is not None:
+            payload["output"] = output
+
+        return await self._post_file_operation(
+            endpoint="/pdf-with-added-image",
+            payload=payload,
+            payload_model=PdfAddImagePayload,
+            extra_query=extra_query,
+            extra_headers=extra_headers,
+            extra_body=extra_body,
+            timeout=timeout,
+        )
+
     async def up(
         self,
         *,
@@ -4260,6 +4423,33 @@ async def compress_pdf(
             timeout=timeout,
         )
 
+    async def add_attachment_to_pdf(
+        self,
+        file: PdfRestFile | Sequence[PdfRestFile],
+        *,
+        attachment: 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 attach an uploaded file to a PDF."""
+
+        payload: dict[str, Any] = {"files": file, "attachment": attachment}
+        if output is not None:
+            payload["output"] = output
+
+        return await self._post_file_operation(
+            endpoint="/pdf-with-added-attachment",
+            payload=payload,
+            payload_model=PdfAddAttachmentPayload,
+            extra_query=extra_query,
+            extra_headers=extra_headers,
+            extra_body=extra_body,
+            timeout=timeout,
+        )
+
     async def flatten_transparencies(
         self,
         file: PdfRestFile | Sequence[PdfRestFile],