adobe.pdfservices.operation.pdfjobs.params.documentmerge package

Submodules

adobe.pdfservices.operation.pdfjobs.params.documentmerge.document_merge_params module

class adobe.pdfservices.operation.pdfjobs.params.documentmerge.document_merge_params.DocumentMergeParams(json_data_for_merge: Any, *, output_format: OutputFormat = OutputFormat.PDF, fragments: Fragments = None)

Bases: PDFServicesJobParams

Parameters for document generation using DocumentMergeJob

Constructs a new DocumentMergeParams instance

Parameters:

  • json_data_for_merge (Any) – json to be used in the document merge job; can not be None.

  • output_format (OutputFormat) – output format for the document merge result; (Optional, use key-value)

  • fragments (Fragments) – fragments for document merge job; (Optional, use key-value)

Returns:

DocumentMergeParams

get_fragments()
Returns:

fragments for document merge job

get_json_data_for_merge()
Returns:

JSON data for the document merge process

get_output_format()
Returns:

output format for the document merge result

adobe.pdfservices.operation.pdfjobs.params.documentmerge.fragments module

class adobe.pdfservices.operation.pdfjobs.params.documentmerge.fragments.Fragments

Bases: object

Class for providing support for Fragments. To know more about fragments use-case in document generation and document templates, Click Here.

Constructs a new Fragments instance

add_fragment(fragment)

To add fragment dictionary into the fragments list.

Parameters:

fragment – fragment dictionary to be added into the fragments list.

add_fragments(fragments: List)

To add List of fragment dictionaries into the fragments list.

Parameters:

fragments – fragment dictionary list to be added into the fragments list.

get_fragments_list()
Returns:

list of fragments.

adobe.pdfservices.operation.pdfjobs.params.documentmerge.output_format module

class adobe.pdfservices.operation.pdfjobs.params.documentmerge.output_format.OutputFormat(value, names=None, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

Supported output formats for adobe.pdfservices.operation.pdfjobs.jobs.document_merge_job.py

Constructs output format with its string representation

Parameters:

output_format – String representation

DOCX = 'docx'

Represents “application/vnd.openxmlformats-officedocument.wordprocessingml.document” media type

PDF = 'pdf'

Represents “application/pdf” media type

get_format()
Returns:

String representation of this outputformat

Module contents