Add Import Form Data tool

Assisted-by: Codex

Author: datalogics-cgreen

src/pdfrest/client.py

@@ -88,6 +88,7 @@
     PdfFlattenAnnotationsPayload,
     PdfFlattenFormsPayload,
     PdfFlattenTransparenciesPayload,
+    PdfImportFormDataPayload,
     PdfInfoPayload,
     PdfLinearizePayload,
     PdfMergePayload,
@@ -2706,6 +2707,33 @@ def convert_to_word(
             timeout=timeout,
         )
 
+    def import_form_data(
+        self,
+        file: PdfRestFile | Sequence[PdfRestFile],
+        data_file: 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:
+        """Import form data from a data file into an existing PDF with form fields."""
+
+        payload: dict[str, Any] = {"files": file, "data_file": data_file}
+        if output is not None:
+            payload["output"] = output
+
+        return self._post_file_operation(
+            endpoint="/pdf-with-imported-form-data",
+            payload=payload,
+            payload_model=PdfImportFormDataPayload,
+            extra_query=extra_query,
+            extra_headers=extra_headers,
+            extra_body=extra_body,
+            timeout=timeout,
+        )
+
     def flatten_pdf_forms(
         self,
         file: PdfRestFile | Sequence[PdfRestFile],
@@ -3993,6 +4021,33 @@ async def convert_to_word(
             timeout=timeout,
         )
 
+    async def import_form_data(
+        self,
+        file: PdfRestFile | Sequence[PdfRestFile],
+        data_file: 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 import form data from a data file into a PDF."""
+
+        payload: dict[str, Any] = {"files": file, "data_file": data_file}
+        if output is not None:
+            payload["output"] = output
+
+        return await self._post_file_operation(
+            endpoint="/pdf-with-imported-form-data",
+            payload=payload,
+            payload_model=PdfImportFormDataPayload,
+            extra_query=extra_query,
+            extra_headers=extra_headers,
+            extra_body=extra_body,
+            timeout=timeout,
+        )
+
     async def flatten_pdf_forms(
         self,
         file: PdfRestFile | Sequence[PdfRestFile],

src/pdfrest/models/_internal.py

@@ -963,6 +963,52 @@ class PdfFlattenFormsPayload(BaseModel):
     ] = None
 
 
+class PdfImportFormDataPayload(BaseModel):
+    """Adapt caller options into a pdfRest-ready import-form-data request payload."""
+
+    files: Annotated[
+        list[PdfRestFile],
+        Field(
+            min_length=1,
+            max_length=1,
+            validation_alias=AliasChoices("file", "files"),
+            serialization_alias="id",
+        ),
+        BeforeValidator(_ensure_list),
+        AfterValidator(
+            _allowed_mime_types("application/pdf", error_msg="Must be a PDF file")
+        ),
+        PlainSerializer(_serialize_as_first_file_id),
+    ]
+    data_file: Annotated[
+        list[PdfRestFile],
+        Field(
+            min_length=1,
+            max_length=1,
+            validation_alias=AliasChoices("data_file", "data_files"),
+            serialization_alias="data_file_id",
+        ),
+        BeforeValidator(_ensure_list),
+        AfterValidator(
+            _allowed_mime_types(
+                "application/xml",
+                "text/xml",
+                "application/vnd.fdf",
+                "application/vnd.adobe.xfdf",
+                "application/vnd.adobe.xdp+xml",
+                "application/vnd.adobe.xfd+xml",
+                error_msg="Data file must be an XFDF, XDP, XFD, FDF, or XML file",
+            )
+        ),
+        PlainSerializer(_serialize_as_first_file_id),
+    ]
+    output: Annotated[
+        str | None,
+        Field(serialization_alias="output", min_length=1, default=None),
+        AfterValidator(_validate_output_prefix),
+    ] = None
+
+
 class PdfCompressPayload(BaseModel):
     """Adapt caller options into a pdfRest-ready compress request payload."""