UNPKG

@adobe/pdfservices-node-sdk

Version:

The Adobe PDF Services Node.js SDK provides APIs for creating, combining, exporting and manipulating PDFs.

64 lines (63 loc) 2.48 kB
import { PDFServicesJob } from "./PDFServicesJob"; import { Asset } from "../../io/Asset"; import { CreatePDFParams } from "../params/createpdf/CreatePDFParams"; import { ExecutionContext } from "../../internal/ExecutionContext"; import { NotifierConfig } from "../../config/notifier/NotifierConfig"; /** * A job that converts a non-PDF file to a PDF file. Some source formats may have associated conversion parameters * which can be set using the {@link CreatePDFParams}. * * @example * Sample Usage: * ```js * const readStream = fs.createReadStream("<SOURCE_PATH>"); * * const credentials = new ServicePrincipalCredentials({ * clientId: process.env.PDF_SERVICES_CLIENT_ID, * clientSecret: process.env.PDF_SERVICES_CLIENT_SECRET * }); * * const pdfServices = new PDFServices({credentials}); * * const inputAsset = await pdfServices.upload({ * readStream, * mimeType: MimeType.DOCX * }); * * const job = new CreatePDFJob({inputAsset}); * * const pollingURL = await pdfServices.submit({job}); * * const pdfServicesResponse = await pdfServices.getJobResult({ * pollingURL, * resultType: CreatePDFResult * }); * * const resultAsset = pdfServicesResponse.result.asset; * const streamAsset = await pdfServices.getContent({asset: resultAsset}); * ``` **/ export declare class CreatePDFJob extends PDFServicesJob { private readonly _inputAsset; private readonly _outputAsset?; private readonly _createPDFParams?; /** Constructs a new `CreatePDFJob` instance. * * @param params The parameters for constructing an instance of `CreatePDFJob`. * @param params.inputAsset The input asset for the job. Cannot be undefined. * @param [params.params] {@link CreatePDFParams} object to specify the conversion parameters for the different * source media types. * @param [params.outputAsset] {@link Asset} object representing the output asset. * @remarks External assets can be set as output only when input is external asset as well. */ constructor(params: { inputAsset: Asset; params?: CreatePDFParams; outputAsset?: Asset; }); /** * @hidden */ process(executionContext: ExecutionContext, notifierConfigList?: NotifierConfig[]): Promise<string>; private generatePDFServicesAPIRequest; }