![\"pdf-template-id\"](\"https://user-images.githubusercontent.com/69169/73693549-4a598280-468b-11ea-81a3-5df4472de8a4.png\")
\n\nAn example:\n\n```js\nconst fs = require('fs')\n\n// PDF template you uploaded to Anvil\nconst pdfTemplateID = 'kA6Da9CuGqUtc6QiBDRR'\n\n// Your API key from your Anvil organization settings\nconst apiKey = '7j2JuUWmN4fGjBxsCltWaybHOEy3UEtt'\n\n// JSON data to fill the PDF\nconst payload = {\n \"title\": \"My PDF Title\",\n \"fontSize\": 10,\n \"textColor\": \"#CC0000\",\n \"data\": {\n \"someFieldId\": \"Hello World!\"\n }\n}\n// The 'options' parameter is optional\nconst options = {\n \"dataType\": \"buffer\"\n}\nconst anvilClient = new Anvil({ apiKey })\nconst { statusCode, data } = await anvilClient.fillPDF(pdfTemplateID, payload, options)\n\n// Be sure to write the file as raw bytes\nfs.writeFileSync('filled.pdf', data, { encoding: null })\n```\n\n* `pdfTemplateID` (String) - The id of your PDF template from the Anvil UI\n* `payload` (Object) - The JSON data that will fill the PDF template\n * `title` (String) - _optional_ Set the title encoded into the PDF document\n * `fontSize` (Number) - _optional_ Set the fontSize of all filled text. Default is 10.\n * `color` (String) - _optional_ Set the text color of all filled text. Default is dark blue.\n * `data` (Object) - The data to fill the PDF. The keys in this object will correspond to a field's ID in the PDF. These field IDs and their types are available on the `API Info` tab on your PDF template's page in the Anvil dashboard.\n * For example `{ \"someFieldId\": \"Hello World!\" }`\n* `options` (Object) - _optional_ Any additional options for the request\n * `dataType` (Enum[String]) - _optional_ Set the type of the `data` value that is returned in the resolved `Promise`. Defaults to `'buffer'`, but `'arrayBuffer'` and `'stream'` are also supported.\n* Returns a `Promise` that resolves to an `Object`\n * `statusCode` (Number) - the HTTP status code; `200` is success\n * `data` (Buffer | ArrayBuffer | Stream) - The raw binary data of the filled PDF if success. Will be either a Buffer, ArrayBuffer, or a Stream, depending on `dataType` option supplied to the request.\n * `errors` (Array of Objects) - Will be present if status >= 400. See Errors\n * `message` (String)\n\n##### generatePDF(payload[, options])\n\nDynamically generate a new PDF from your HTML and CSS or markdown.\n\nUseful for agreements, invoices, disclosures, or any other text-heavy documents. This does not require you do anything in the Anvil UI other than setup your API key, just send it data, get a PDF. See [the generate PDF docs](https://useanvil.com/api/generate-pdf) for full details.\n\n* [HTML to PDF docs](https://www.useanvil.com/docs/api/generate-pdf#html--css-to-pdf)\n* [Markdown to PDF docs](https://www.useanvil.com/docs/api/generate-pdf#markdown-to-pdf)\n\nCheck out our [HTML invoice template](https://github.com/anvilco/html-pdf-invoice-template) for a complete HTML to PDF example.\n\nAn example:\n\n```js\nconst fs = require('fs')\n\n// Your API key from your Anvil organization settings\nconst apiKey = '7j2JuUWmN4fGjBxsCltWaybHOEy3UEtt'\n\n// An example using an HTML to PDF payload\nconst payload = {\n title: 'Example',\n type: 'html',\n data: {\n html: `\n \n Lorem Ipsum is simply dummy text...\n
\n\n Contrary to popular belief, Lorem Ipsum is not simply random text\n
\n `,\n css: `\n body { font-size: 14px; color: #171717; }\n .header-one { text-decoration: underline; }\n .header-two { font-style: underline; }\n `,\n },\n}\n\n// An example using a Markdown payload\nconst payload = {\n title: 'Example Invoice',\n data: [{\n label: 'Name',\n content: 'Sally Jones',\n }, {\n content: 'Lorem **ipsum** dolor sit _amet_',\n }, {\n table: {\n firstRowHeaders: true,\n rows: [\n ['Description', 'Quantity', 'Price'],\n ['4x Large Widgets', '4', '$40.00'],\n ['10x Medium Sized Widgets in dark blue', '10', '$100.00'],\n ['10x Small Widgets in white', '6', '$60.00'],\n ],\n },\n }],\n}\n// The 'options' parameter is optional\nconst options = {\n \"dataType\": \"buffer\"\n}\nconst anvilClient = new Anvil({ apiKey })\nconst { statusCode, data } = await anvilClient.generatePDF(payload, options)\n\n// Be sure to write the file as raw bytes\nfs.writeFileSync('generated.pdf', data, { encoding: null })\n```\n\n* `payload` (Object) - The JSON data that will fill the PDF template\n * `title` (String) - _optional_ Set the title encoded into the PDF document\n * `data` (Array of Objects) - The data that generates the PDF. See [the docs](https://useanvil.com/docs/api/generate-pdf#supported-format-of-data) for all supported objects\n * For example `[{ \"label\": \"Hello World!\", \"content\": \"Test\" }]`\n* `options` (Object) - _optional_ Any additional options for the request\n * `dataType` (Enum[String]) - _optional_ Set the type of the `data` value that is returned in the resolved `Promise`. Defaults to `'buffer'`, but `'arrayBuffer'` and `'stream'` are also supported.\n* Returns a `Promise` that resolves to an `Object`\n * `statusCode` (Number) - the HTTP status code; `200` is success\n * `data` (Buffer | ArrayBuffer | Stream) - The raw binary data of the filled PDF if success. Will be either a Buffer, ArrayBuffer, or a Stream, depending on `dataType` option supplied to the request.\n * `errors` (Array of Objects) - Will be present if status >= 400. See Errors\n * `message` (String)\n\n##### createEtchPacket(options)\n\nCreates an Etch Packet and optionally sends it to the first signer.\n\n* `options` (Object) - An object with the following structure:\n * `variables` (Object) - See the [API Documentation](#api-documentation) area for details. See [Examples](#examples) area for examples.\n * `responseQuery` (String) - _optional_ A GraphQL Query compliant query to use for the data desired in the mutation response. Can be left out to use default.\n * `mutation` (String) - _optional_ If you'd like complete control of the GraphQL mutation, you can pass in a GraphQL Mutation compliant string that will be used in the mutation call. This string should also include your response query, as the `responseQuery` param is ignored if `mutation` is passed. Example:\n ```graphql\n mutation CreateEtchPacket (\n $name: String,\n ...\n ) {\n createEtchPacket (\n name: $name,\n ...\n ) {\n id\n eid\n ...\n }\n }\n ```\n\n##### getEtchPacket(options)\n\nGets the details of an Etch Packet.\n* `options` (Object) - An object with the following structure:\n * `variables` (Object) - Requires `eid`\n * `eid` (String) - your Etch Packet eid\n * `responseQuery` (String) - _optional_ A GraphQL Query compliant query to use for the data desired in the query response. Can be left out to use default.\n\n##### generateEtchSignUrl(options)\n\nGenerates an Etch sign URL for an Etch Packet signer. The Etch Packet and its signers must have already been created.\n* `options` (Object) - An object with the following structure:\n * `variables` (Object) - Requires `clientUserId` and `signerEid`\n * `clientUserId` (String) - your user eid\n * `signerEid` (String) - the eid of the Etch Packet signer, found in the response of the `createEtchPacket` instance method\n\n##### downloadDocuments(documentGroupEid[, options])\n\nReturns a Buffer, ArrayBuffer, or Stream of the document group specified by the documentGroupEid in Zip file format.\n* `documentGroupEid` (string) - the eid of the document group to download\n* `options` (Object) - _optional_ Any additional options for the request\n * `dataType` (Enum[String]) - _optional_ Set the type of the `data` value that is returned in the resolved `Promise`. Defaults to `'buffer'`, but `'arrayBuffer'` and `'stream'` are also supported.\n* Returns a `Promise` that resolves to an `Object`\n * `statusCode` (Number) - the HTTP status code, `200` is success\n * `response` (Object) - the Response object resulting from the client's request to the Anvil app\n * `data` (Buffer | ArrayBuffer | Stream) - The raw binary data of the downloaded documents if success. Will be in the format of either a Buffer, ArrayBuffer, or a Stream, depending on `dataType` option supplied to the request.\n * `errors` (Array of Objects) - Will be present if status >= 400. See Errors\n * `message` (String)\n\n\n##### requestGraphQL(queryInfo[, options])\n\nA fallback function for queries and mutations without a specialized function in this client.\n\nSee the [GraphQL reference](https://www.useanvil.com/docs/api/graphql/reference/) for a listing on all possible queries\n\n```js\nconst result = await client.requestGraphQL({\n query: `\n query WeldDataQuery ($eid: String!) {\n weldData (eid: $eid) {\n eid\n isComplete\n isTest\n }\n }\n `,\n variables: { eid: 'nxflNZqxDUbltLUbYWK' },\n})\nconst statusCode = result.statusCode\nconst httpErrors = result.errors\n\n// These will only be available if the statusCode === 200\nconst graphqlErrors = result.data.errors\nconst resultObject = result.data.data.weldData\n```\n\n* `queryInfo` (Object) - The JSON data that will fill the PDF template\n * `query` (String) - GraphQL query or mutation to run. See the [GraphQL reference](https://www.useanvil.com/docs/api/graphql/reference/) for a listing on all possible queries\n * `variables` (Object) - GraphQL variables for the query\n* Returns a `Promise` that resolves to an `Object`\n * `statusCode` (Number) - 200 when successful or when there is a GraphQL error. You will only see > 200 if your query is not found or malformed\n * `errors` (String) - HTTP errors when status code > 200\n * `data` (Object) - Contains query result and any GraphQL errors\n * `errors` (Array of Objects) - If there are validation errors or errors running the query, they will show here\n * `data` (Object) - Contains the actual result of the query\n * `[queryName]` (Object) - Use the query or mutation name to reference the data that you requested!\n\n##### requestREST(url, fetchOptions[, clientOptions])\n\nA fallback function for REST endpoints without a specialized function in this client.\n\nSee the [GraphQL reference](https://www.useanvil.com/docs/api/graphql/reference/) for a listing on all possible queries\n\n```js\nconst result = await this.requestREST(\n `/api/v1/fill/${pdfTemplateID}.pdf`,\n {\n method: 'POST',\n body: JSON.stringify(payload),\n headers: {\n 'Content-Type': 'application/json',\n },\n },\n {\n dataType: 'stream',\n },\n)\n```\n\n* `url` (String) - URL from the baseURL. e.g. `/api/v1/fill`\n* `fetchOptions` (Object) - Options passed to [node-fetch](https://github.com/node-fetch/node-fetch)\n* `clientOptions` (Object) - _optional_ Any additional options for the request\n * `dataType` (Enum[String]) - _optional_ Set the type of the `data` value that is returned in the resolved `Promise`. Defaults to `'buffer'`, `'arrayBuffer'`, `'stream'`, and `'json'` are also supported.\n* Returns a `Promise` that resolves to an `Object`\n * `statusCode` (Number) - the HTTP status code; `200` is success\n * `data` (Buffer | ArrayBuffer | Stream) - The raw binary data of the filled PDF if success. Will be either a Buffer, ArrayBuffer, or a Stream, depending on `dataType` option supplied to the request.\n * `errors` (Array of Objects) - Will be present if status >= 400. See Errors\n * `message` (String)\n\n### Class Methods\n\n* [prepareGraphQLFile(pathOrStreamLikeThing[, options])](#preparegraphqlfilepathorstreamlikething-options)\n\n##### prepareGraphQLFile(pathOrStreamLikeThing[, options])\n\nA nice helper to prepare a [File](https://developer.mozilla.org/en-US/docs/Web/API/File) upload for use with our GraphQL API. By default, this will upload your files as multipart uploads over the [jaydenseric / GraphQL multipart request spec](https://github.com/jaydenseric/graphql-multipart-request-spec). We use `node-fetch` under the hood, and you can see [this example](https://github.com/node-fetch/node-fetch#post-data-using-a-file) to get a bit of an understanding of what's happening behind the scenes. NOTE: Please see below about certain scenarios where you may need to manually provide a `filename`.\n\n* `pathOrSupportedInstance` (String | File | Blob | Stream | Buffer) - Can be one of several things. Here's a list of what's supported, in order of preference:\n 1. A `File` instance.\n 1. A `Blob` instance.\n 1. A `string` that is a path to a file to be used.\n 1. A `ReadStream` instance that must either have either:\n 1. A `path` property (this will usually be present when the stream was loaded from the local file system)\n 1. A `filename` provided in the `options` parameter.\n 1. A `Buffer` instance with a `filename` provided in the `options` parameter.\n* `options` (Object) - Options that may be required when providing certain types of values as the first parameter. For example, `Blob`s, `Buffer`s and certain kinds of `ReadStream`s will not have any notion of what the name of the file is or should be when uploaded.\n * `filename` (String) - Override the filename of the uploaded file here. If providing a generic ReadStream or Buffer, you will be required to provide a filename here\n * `mimetype` (String) - Optional mimetype to specify with the resulting file that can be used when a `string` path, `Buffer` or `ReadStream` are provided as the first parameter.\n* Returns an `Object` that is properly formatted to be coerced by the client for use against our GraphQL API wherever an `Upload` type is required.\n\n### Types\n\n* [Options](#options)\n\n##### Options\n\nOptions for the Anvil Client. Defaults are shown after each option key.\n\n```js\n{\n apiKey: