pdfengines.go

package gotenberg

import (
	"context"
	"io"
	"strconv"
	"time"
)

// Convert creates a request to convert PDFs to PDF/A & PDF/UA.
func (r *PDFEngines) Convert(ctx context.Context) *PDFEngines {
	r.Req = r.HttpStream.Multipart(ctx, "/forms/pdfengines/convert")
	return r
}

// MetadataRead creates a request to read metadata from PDFs.
func (r *PDFEngines) MetadataRead(ctx context.Context) *PDFEngines {
	r.Req = r.HttpStream.Multipart(ctx, "/forms/pdfengines/metadata/read")
	return r
}

// MetadataWrite creates a request to write metadata to PDFs.
func (r *PDFEngines) MetadataWrite(ctx context.Context) *PDFEngines {
	r.Req = r.HttpStream.Multipart(ctx, "/forms/pdfengines/metadata/write")
	return r
}

// Merge creates a request to merge PDFs.
func (r *PDFEngines) Merge(ctx context.Context) *PDFEngines {
	r.Req = r.HttpStream.Multipart(ctx, "/forms/pdfengines/merge")
	return r
}

// Split creates a request to split PDFs.
func (r *PDFEngines) Split(ctx context.Context) *PDFEngines {
	r.Req = r.HttpStream.Multipart(ctx, "/forms/pdfengines/split")
	return r
}

// Flatten creates a request to flatten PDFs.
func (r *PDFEngines) Flatten(ctx context.Context) *PDFEngines {
	r.Req = r.HttpStream.Multipart(ctx, "/forms/pdfengines/flatten")
	return r
}

// Watermark creates a request to apply a watermark behind page content.
func (r *PDFEngines) Watermark(ctx context.Context) *PDFEngines {
	r.Req = r.HttpStream.Multipart(ctx, "/forms/pdfengines/watermark")
	return r
}

// Stamp creates a request to apply a stamp on top of page content.
func (r *PDFEngines) Stamp(ctx context.Context) *PDFEngines {
	r.Req = r.HttpStream.Multipart(ctx, "/forms/pdfengines/stamp")
	return r
}

// Rotate creates a request to rotate PDF pages by 90°, 180°, or 270°.
func (r *PDFEngines) Rotate(ctx context.Context) *PDFEngines {
	r.Req = r.HttpStream.Multipart(ctx, "/forms/pdfengines/rotate")
	return r
}

// BookmarksRead creates a request to read the bookmark outline from PDF files as JSON.
func (r *PDFEngines) BookmarksRead(ctx context.Context) *PDFEngines {
	r.Req = r.HttpStream.Multipart(ctx, "/forms/pdfengines/bookmarks/read")
	return r
}

// BookmarksWrite creates a request to write bookmarks to PDF files.
func (r *PDFEngines) BookmarksWrite(ctx context.Context) *PDFEngines {
	r.Req = r.HttpStream.Multipart(ctx, "/forms/pdfengines/bookmarks/write")
	return r
}

// Send executes the request and returns the response.
func (r *PDFEngines) Send() (*Response, error) {
	return r.Request.Send()
}

// Header adds an HTTP header to the request.
func (r *PDFEngines) Header(key, value string) *PDFEngines {
	r.Request.Header(key, value)
	return r
}

// Param adds a form parameter to the request.
func (r *PDFEngines) Param(key, value string) *PDFEngines {
	r.Request.Param(key, value)
	return r
}

// Bool adds a boolean form parameter to the request.
func (r *PDFEngines) Bool(fieldName string, value bool) *PDFEngines {
	r.Request.Bool(fieldName, value)
	return r
}

// Float adds a float64 form parameter to the request.
func (r *PDFEngines) Float(fieldName string, value float64) *PDFEngines {
	r.Request.Float(fieldName, value)
	return r
}

// File adds a file to the request.
func (r *PDFEngines) File(filename string, content io.Reader) *PDFEngines {
	r.Request.File(filename, content)
	return r
}

// WebhookURL sets the webhook URL and HTTP method for successful operations.
func (r *PDFEngines) WebhookURL(url, method string) *PDFEngines {
	r.Request.WebhookURL(url, method)
	return r
}

// WebhookErrorURL sets the webhook URL and HTTP method for failed operations.
func (r *PDFEngines) WebhookErrorURL(url, method string) *PDFEngines {
	r.Request.WebhookErrorURL(url, method)
	return r
}

// WebhookEventsURL sets the webhook events URL for structured JSON event callbacks.
func (r *PDFEngines) WebhookEventsURL(url string) *PDFEngines {
	r.Request.WebhookEventsURL(url)
	return r
}

// WebhookHeader adds a custom header to be sent with webhook requests.
func (r *PDFEngines) WebhookHeader(key, value string) *PDFEngines {
	r.Request.WebhookHeader(key, value)
	return r
}

// DownloadFrom sets the downloadFrom parameter for downloading files from URLs.
func (r *PDFEngines) DownloadFrom(url string, headers map[string]string) *PDFEngines {
	r.Request.DownloadFrom(url, headers)
	return r
}

// OutputFilename sets the output filename.
func (r *PDFEngines) OutputFilename(filename string) *PDFEngines {
	r.Request.OutputFilename(filename)
	return r
}

// Trace sets the request trace identifier for debugging and monitoring.
func (r *PDFEngines) Trace(trace string) *PDFEngines {
	r.Request.Trace(trace)
	return r
}

// Timeout sets a timeout for the request.
func (r *PDFEngines) Timeout(duration time.Duration) *PDFEngines {
	r.Request.Timeout(duration)
	return r
}

// Metadata sets the metadata for the PDF.
func (r *PDFEngines) Metadata(key, value string) *PDFEngines {
	r.Request.Metadata(key, value)
	return r
}

// PDFA converts to PDF/A format.
func (r *PDFEngines) PDFA(pdfa string) *PDFEngines {
	return r.Param("pdfa", pdfa)
}

// PDFUA enables PDF for Universal Access.
func (r *PDFEngines) PDFUA(pdfua bool) *PDFEngines {
	return r.Bool("pdfua", pdfua)
}

// SplitMode sets the split mode.
func (r *PDFEngines) SplitMode(mode string) *PDFEngines {
	return r.Param("splitMode", mode)
}

// SplitSpan sets the split span.
func (r *PDFEngines) SplitSpan(span string) *PDFEngines {
	return r.Param("splitSpan", span)
}

// SplitUnify specifies whether to unify split pages.
func (r *PDFEngines) SplitUnify(unify bool) *PDFEngines {
	return r.Bool("splitUnify", unify)
}

// FlattenPDF sets the flatten flag.
func (r *PDFEngines) FlattenPDF(flatten bool) *PDFEngines {
	return r.Bool("flatten", flatten)
}

// RotateAngle sets the rotation angle for pages.
func (r *PDFEngines) RotateAngle(angle int) *PDFEngines {
	return r.Param("rotateAngle", strconv.Itoa(angle))
}

// RotatePages sets the page selection for rotation.
func (r *PDFEngines) RotatePages(pages string) *PDFEngines {
	return r.Param("rotatePages", pages)
}

// Bookmarks sets the bookmarks JSON.
func (r *PDFEngines) Bookmarks(json string) *PDFEngines {
	return r.Param("bookmarks", json)
}

// AutoIndexBookmarks extracts and reindexes existing bookmarks from input files during merge.
func (r *PDFEngines) AutoIndexBookmarks(v bool) *PDFEngines {
	return r.Bool("autoIndexBookmarks", v)
}

// WatermarkFile adds a watermark source file (image or PDF) to the request.
func (r *PDFEngines) WatermarkFile(filename string, content io.Reader) *PDFEngines {
	r.file("watermark", filename, content)
	return r
}

// StampFile adds a stamp source file (image or PDF) to the request.
func (r *PDFEngines) StampFile(filename string, content io.Reader) *PDFEngines {
	r.file("stamp", filename, content)
	return r
}

// EmbedsMetadata sets per-file metadata.
func (r *PDFEngines) EmbedsMetadata(metadataJSON string) *PDFEngines {
	return r.Param("embedsMetadata", metadataJSON)
}

// Embed creates a request to embed files into a PDF.
func (r *PDFEngines) Embed(ctx context.Context) *PDFEngines {
	r.Req = r.HttpStream.Multipart(ctx, "/forms/pdfengines/embed")
	return r
}

// FacturX creates a request to generate a Factur-X / ZUGFeRD e-invoice.
func (r *PDFEngines) FacturX(ctx context.Context) *PDFEngines {
	r.Req = r.HttpStream.Multipart(ctx, "/forms/pdfengines/factur-x")
	return r
}

// FacturXXml adds the CII invoice XML file.
func (r *PDFEngines) FacturXXml(filename string, content io.Reader) *PDFEngines {
	r.file("facturxXml", filename, content)
	return r
}

// FacturXConformanceLevel sets the conformance level recorded in XMP metadata.
func (r *PDFEngines) FacturXConformanceLevel(level string) *PDFEngines {
	return r.Param("facturxConformanceLevel", level)
}

// FacturXDocumentType sets the document type.
func (r *PDFEngines) FacturXDocumentType(docType string) *PDFEngines {
	return r.Param("facturxDocumentType", docType)
}

// FacturXVersion sets the version recorded in XMP metadata.
func (r *PDFEngines) FacturXVersion(version string) *PDFEngines {
	return r.Param("facturxVersion", version)
}

// UserPassword sets the password required to open the PDF.
func (r *PDFEngines) UserPassword(password string) *PDFEngines {
	r.Request.UserPassword(password)
	return r
}

// OwnerPassword sets the password required to change permissions or edit the PDF.
func (r *PDFEngines) OwnerPassword(password string) *PDFEngines {
	r.Request.OwnerPassword(password)
	return r
}

// AllowPrinting permits printing the document.
func (r *PDFEngines) AllowPrinting(allow bool) *PDFEngines {
	r.Request.AllowPrinting(allow)
	return r
}

// AllowCopying permits extracting text and graphics.
func (r *PDFEngines) AllowCopying(allow bool) *PDFEngines {
	r.Request.AllowCopying(allow)
	return r
}

// AllowModifying permits changing the document content.
func (r *PDFEngines) AllowModifying(allow bool) *PDFEngines {
	r.Request.AllowModifying(allow)
	return r
}

// AllowAnnotating permits adding or modifying annotations.
func (r *PDFEngines) AllowAnnotating(allow bool) *PDFEngines {
	r.Request.AllowAnnotating(allow)
	return r
}

// AllowFillingForms permits filling in form fields.
func (r *PDFEngines) AllowFillingForms(allow bool) *PDFEngines {
	r.Request.AllowFillingForms(allow)
	return r
}

// AllowAssembling permits inserting, deleting, and rotating pages.
func (r *PDFEngines) AllowAssembling(allow bool) *PDFEngines {
	r.Request.AllowAssembling(allow)
	return r
}

// Embeds adds a file to be embedded in the resulting PDF.
func (r *PDFEngines) Embeds(filename string, content io.Reader) *PDFEngines {
	r.Request.Embeds(filename, content)
	return r
}