Skip to content

PDFCLOUD-5554 Add client methods to watermark documents #19

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
datalogics-kam merged 12 commits into from
Feb 19, 2026
Merged

PDFCLOUD-5554 Add client methods to watermark documents #19

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
a3cf18e
Add Watermark PDF tool
datalogics-cgreen Jan 13, 2026
141c280
Add tests of Watermark PDF
datalogics-cgreen Jan 13, 2026
4ec78e7
Split `watermark_pdf` by text and image watermarking
datalogics-cgreen Feb 12, 2026
9b71d74
watermark-pdf: Omit `_merge_non_default_values()`
datalogics-cgreen Feb 18, 2026
eb0646b
watermark-pdf: Remediate live testing gaps
datalogics-cgreen Feb 18, 2026
de02401
watermark-pdf: Add tests of value bounds
datalogics-cgreen Feb 18, 2026
7466c82
watermark-pdf: Add live negative boundary tests for numeric fields
datalogics-cgreen Feb 18, 2026
01e398d
watermark-pdf: Fix types on text color parameter
datalogics-cgreen Feb 19, 2026
45471b1
watermark-pdf: Set default text color to RGB black
datalogics-cgreen Feb 19, 2026
46d6cff
watermark-pdf: Add missing image watermark test coverage
datalogics-cgreen Feb 19, 2026
2284c55
watermark-pdf: Serialize to strings for payload
datalogics-cgreen Feb 19, 2026
7a26a78
watermark-pdf: Stringify `behind_page` value
datalogics-cgreen Feb 19, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
205 changes: 205 additions & 0 deletions src/pdfrest/client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,6 +101,7 @@
PdfFlattenFormsPayload,
PdfFlattenLayersPayload,
PdfFlattenTransparenciesPayload,
PdfImageWatermarkPayload,
PdfImportFormDataPayload,
PdfInfoPayload,
PdfLinearizePayload,
Expand All @@ -111,6 +112,7 @@
PdfRestRawFileResponse,
PdfRestrictPayload,
PdfSplitPayload,
PdfTextWatermarkPayload,
PdfToExcelPayload,
PdfToPdfaPayload,
PdfToPdfxPayload,
Expand Down Expand Up @@ -154,12 +156,15 @@
PdfRedactionInstruction,
PdfRestriction,
PdfRGBColor,
PdfTextColor,
PdfXType,
PngColorModel,
SummaryFormat,
SummaryOutputFormat,
TiffColorModel,
TranslateOutputFormat,
WatermarkHorizontalAlignment,
WatermarkVerticalAlignment,
)

__all__ = ("AsyncPdfRestClient", "PdfRestClient")
Expand Down Expand Up @@ -3615,6 +3620,106 @@ def convert_url_to_pdf(
timeout=timeout,
)

def watermark_pdf_with_text(
self,
file: PdfRestFile | Sequence[PdfRestFile],
*,
watermark_text: str,
output: str | None = None,
font: str | None = None,
text_size: int = 72,
text_color: PdfTextColor = (0, 0, 0),
opacity: float = 0.5,
horizontal_alignment: WatermarkHorizontalAlignment = "center",
vertical_alignment: WatermarkVerticalAlignment = "center",
x: int = 0,
y: int = 0,
rotation: int = 0,
pages: PdfPageSelection | None = None,
behind_page: bool = False,
extra_query: Query | None = None,
extra_headers: AnyMapping | None = None,
extra_body: Body | None = None,
timeout: TimeoutTypes | None = None,
) -> PdfRestFileBasedResponse:
"""Apply a text watermark to a PDF."""

payload: dict[str, Any] = {
"files": file,
"watermark_text": watermark_text,
"output": output,
"font": font,
"text_size": text_size,
"text_color": text_color,
"opacity": opacity,
"horizontal_alignment": horizontal_alignment,
"vertical_alignment": vertical_alignment,
"x": x,
"y": y,
"rotation": rotation,
"pages": pages,
"behind_page": behind_page,
}
payload = {key: value for key, value in payload.items() if value is not None}

return self._post_file_operation(
endpoint="/watermarked-pdf",
payload=payload,
payload_model=PdfTextWatermarkPayload,
extra_query=extra_query,
extra_headers=extra_headers,
extra_body=extra_body,
timeout=timeout,
)

def watermark_pdf_with_image(
self,
file: PdfRestFile | Sequence[PdfRestFile],
*,
watermark_file: PdfRestFile | Sequence[PdfRestFile],
output: str | None = None,
watermark_file_scale: float = 0.5,
opacity: float = 0.5,
horizontal_alignment: WatermarkHorizontalAlignment = "center",
vertical_alignment: WatermarkVerticalAlignment = "center",
x: int = 0,
y: int = 0,
rotation: int = 0,
pages: PdfPageSelection | None = None,
behind_page: bool = False,
extra_query: Query | None = None,
extra_headers: AnyMapping | None = None,
extra_body: Body | None = None,
timeout: TimeoutTypes | None = None,
) -> PdfRestFileBasedResponse:
"""Apply an image watermark to a PDF."""

payload: dict[str, Any] = {
"files": file,
"watermark_file": watermark_file,
"output": output,
"watermark_file_scale": watermark_file_scale,
"opacity": opacity,
"horizontal_alignment": horizontal_alignment,
"vertical_alignment": vertical_alignment,
"x": x,
"y": y,
"rotation": rotation,
"pages": pages,
"behind_page": behind_page,
}
payload = {key: value for key, value in payload.items() if value is not None}

return self._post_file_operation(
endpoint="/watermarked-pdf",
payload=payload,
payload_model=PdfImageWatermarkPayload,
extra_query=extra_query,
extra_headers=extra_headers,
extra_body=extra_body,
timeout=timeout,
)

def convert_to_pdfa(
self,
file: PdfRestFile | Sequence[PdfRestFile],
Expand Down Expand Up @@ -5412,6 +5517,106 @@ async def convert_url_to_pdf(
timeout=timeout,
)

async def watermark_pdf_with_text(
self,
file: PdfRestFile | Sequence[PdfRestFile],
*,
watermark_text: str,
output: str | None = None,
font: str | None = None,
text_size: int = 72,
text_color: PdfTextColor = (0, 0, 0),
opacity: float = 0.5,
horizontal_alignment: WatermarkHorizontalAlignment = "center",
vertical_alignment: WatermarkVerticalAlignment = "center",
x: int = 0,
y: int = 0,
rotation: int = 0,
pages: PdfPageSelection | None = None,
behind_page: bool = False,
extra_query: Query | None = None,
extra_headers: AnyMapping | None = None,
extra_body: Body | None = None,
timeout: TimeoutTypes | None = None,
) -> PdfRestFileBasedResponse:
"""Asynchronously apply a text watermark to a PDF."""

payload: dict[str, Any] = {
"files": file,
"watermark_text": watermark_text,
"output": output,
"font": font,
"text_size": text_size,
"text_color": text_color,
"opacity": opacity,
"horizontal_alignment": horizontal_alignment,
"vertical_alignment": vertical_alignment,
"x": x,
"y": y,
"rotation": rotation,
"pages": pages,
"behind_page": behind_page,
}
payload = {key: value for key, value in payload.items() if value is not None}

return await self._post_file_operation(
endpoint="/watermarked-pdf",
payload=payload,
payload_model=PdfTextWatermarkPayload,
extra_query=extra_query,
extra_headers=extra_headers,
extra_body=extra_body,
timeout=timeout,
)

async def watermark_pdf_with_image(
self,
file: PdfRestFile | Sequence[PdfRestFile],
*,
watermark_file: PdfRestFile | Sequence[PdfRestFile],
output: str | None = None,
watermark_file_scale: float = 0.5,
opacity: float = 0.5,
horizontal_alignment: WatermarkHorizontalAlignment = "center",
vertical_alignment: WatermarkVerticalAlignment = "center",
x: int = 0,
y: int = 0,
rotation: int = 0,
pages: PdfPageSelection | None = None,
behind_page: bool = False,
extra_query: Query | None = None,
extra_headers: AnyMapping | None = None,
extra_body: Body | None = None,
timeout: TimeoutTypes | None = None,
) -> PdfRestFileBasedResponse:
"""Asynchronously apply an image watermark to a PDF."""

payload: dict[str, Any] = {
"files": file,
"watermark_file": watermark_file,
"output": output,
"watermark_file_scale": watermark_file_scale,
"opacity": opacity,
"horizontal_alignment": horizontal_alignment,
"vertical_alignment": vertical_alignment,
"x": x,
"y": y,
"rotation": rotation,
"pages": pages,
"behind_page": behind_page,
}
payload = {key: value for key, value in payload.items() if value is not None}

return await self._post_file_operation(
endpoint="/watermarked-pdf",
payload=payload,
payload_model=PdfImageWatermarkPayload,
extra_query=extra_query,
extra_headers=extra_headers,
extra_body=extra_body,
timeout=timeout,
)

async def convert_to_pdfa(
self,
file: PdfRestFile | Sequence[PdfRestFile],
Expand Down
Loading