@adobe/pdfservices-node-sdk
Version:
The Adobe PDF Services Node.js SDK provides APIs for creating, combining, exporting and manipulating PDFs.
45 lines (44 loc) • 1.91 kB
TypeScript
import { PDFServicesJobParams } from "../PDFServicesJobParams";
import { OutputFormat } from "./OutputFormat";
/**
* Parameters for document generation using {@link DocumentMergeJob}.
*/
export declare class DocumentMergeParams implements PDFServicesJobParams {
private readonly _jsonDataForMerge;
private readonly _outputFormat?;
private readonly _fragments?;
/**
* Constructs a new `DocumentMergeParams` instance.
*
* @param params - The parameters for constructing an instance of `DocumentMergeParams`.
* @param params.jsonDataForMerge - The JSON data to be used for merging. Cannot be undefined.
* @param [params.fragments] - The Fragments JSON object or a JSON array to resolve fragments in the document
* template. To know more about fragments use-case in document generation and document templates,
* please see the {@link http://www.adobe.com/go/dcdocgen_fragments_support documentation}.
* @param [params.outputFormat] - The target format of the generated output document.
* The default value is {@link OutputFormat#PDF PDF}.
*/
constructor(params: {
jsonDataForMerge: object;
fragments?: Array<object>;
outputFormat?: OutputFormat;
});
/**
* Represents the input datasource for the document merge process as a JSON object
*
* @returns the input JSON Data to be merged with document template
*/
get jsonDataForMerge(): JSON;
/**
* Returns the Fragments JSON object or a JSON array to resolve fragments in the document template.
*
* @returns the fragments to be used for merging.
*/
get fragments(): Array<JSON> | undefined;
/**
* Returns the intended {@link OutputFormat} of the generated document.
*
* @returns the {@link OutputFormat} of the generated document.
*/
get outputFormat(): OutputFormat | undefined;
}