GotenbergElixir.Pdf (Gotenberg Elixir v0.1.1)

Copy Markdown View Source

Provides functionality for PDF-related operations

Summary

Types

convert_option()
files()
flatten_option()
merge_option()
metadata_option()
pdfa_pdfua_option()
split_option()
write_metadata_option()

Functions

convert(files, options \\ [])

Transforms one or more PDF files into the requested PDF/A format and/or PDF/UA.

flatten_pdf(files)

Flatten one or more PDF files.

merge_pdf(files, options \\ [])

Merges one or more PDF files.

read_pdf_metadata(files)

Returns metadata for one or more PDF files.

split_pdf(files, options \\ [])

Split one or more PDF files.

write_pdf_metadata(files, options \\ [])

Writes metadata for one or more PDF files.

Types

convert_option()

@type convert_option() :: pdfa_pdfua_option()

files()

@type files() :: [{String.t(), binary()}]

flatten_option()

@type flatten_option() :: {:flatten, boolean()}

merge_option()

@type merge_option() :: pdfa_pdfua_option() | metadata_option() | flatten_option()

metadata_option()

@type metadata_option() :: {:metadata, map()}

pdfa_pdfua_option()

@type pdfa_pdfua_option() :: {:pdfa, String.t()} | {:pdfua, boolean()}

split_option()

@type split_option() ::
  {:split_mode, String.t()}
  | {:split_span, String.t()}
  | {:split_unify, boolean()}
  | pdfa_pdfua_option()
  | metadata_option()
  | flatten_option()

write_metadata_option()

@type write_metadata_option() :: metadata_option()

Functions

convert(files, options \\ [])

@spec convert(files :: files(), options :: [convert_option()]) ::
  {:ok, GotenbergElixir.HttpClient.Behaviour.response()}
  | {:error, GotenbergElixir.HttpClient.Behaviour.error()}

Transforms one or more PDF files into the requested PDF/A format and/or PDF/UA.

## Parameters

  • files: A list of pdf files as {filename, file}
  • options: Optional parameters passed as a keyword list.

## Options For a list of all available options, refer to the official Gotenberg documentation.

flatten_pdf(files)

@spec flatten_pdf(files :: files()) ::
  {:ok, GotenbergElixir.HttpClient.Behaviour.response()}
  | {:error, GotenbergElixir.HttpClient.Behaviour.error()}

Flatten one or more PDF files.

## Parameters

  • files: A list of pdf files as {filename, file}

merge_pdf(files, options \\ [])

@spec merge_pdf(files :: files(), [merge_option()]) ::
  {:ok, GotenbergElixir.HttpClient.Behaviour.response()}
  | {:error, GotenbergElixir.HttpClient.Behaviour.error()}

Merges one or more PDF files.

## Parameters

  • files: A list of pdf files as {filename, file}
  • options: Optional parameters passed as a keyword list.

## Options For a list of all available options, refer to the official Gotenberg documentation.

read_pdf_metadata(files)

@spec read_pdf_metadata(files :: files()) ::
  {:ok, GotenbergElixir.HttpClient.Behaviour.response()}
  | {:error, GotenbergElixir.HttpClient.Behaviour.error()}

Returns metadata for one or more PDF files.

## Parameters

  • files: A list of file paths or URLs.

split_pdf(files, options \\ [])

@spec split_pdf(files :: files(), [split_option()]) ::
  {:ok, GotenbergElixir.HttpClient.Behaviour.response()}
  | {:error, GotenbergElixir.HttpClient.Behaviour.error()}

Split one or more PDF files.

## Parameters

  • files: A list of pdf files as {filename, file}
  • options: Optional parameters passed as a keyword list.

## Options For a list of all available options, refer to the official Gotenberg documentation.

write_pdf_metadata(files, options \\ [])

@spec write_pdf_metadata(files :: files(), [write_metadata_option()]) ::
  {:ok, GotenbergElixir.HttpClient.Behaviour.response()}
  | {:error, GotenbergElixir.HttpClient.Behaviour.error()}

Writes metadata for one or more PDF files.

## Parameters

  • files: A list of pdf files as {filename, file}
  • options: Optional parameters passed as a keyword list.

## Options For a list of all available options, refer to the official Gotenberg documentation.