@anvilco/anvil/example/README.md

Anvil API Client

# Anvil API Client Examples

## fill-pdf.js script

Calls the fillPDF client function with data specified to fill a PDF with the Anvil API. Outputs the filled PDF in `example/script/fill.output.pdf`

Usage example:

```sh
# Fills a PDF then opens it in preview
yarn node example/script/fill-pdf.js <pdfTemplateID> <apiKey> <inputJSONFile>

# An example
yarn node example/script/fill-pdf.js idabc123 apiKeydef345 ./payload.json && open example/script/fill.output.pdf
```

`payload.json` is a json file with the JSON data used to fill the PDF. e.g.

```json
{
  "title": "My PDF Title",
  "fontSize": 10,
  "textColor": "#CC0000",
  "data": {
    "someFieldId": "Hello World!"
  }
}
```

## generate-pdf.js script

Calls the generatePDF client function with data specified to generate a PDF with the Anvil API. Outputs the generated PDF in `example/script/generate.output.pdf`

Usage example:

```sh
# Generates a PDF
yarn node example/script/generate-pdf.js <apiKey> [<inputJSONFile>]

# Generates a PDF with default data, then open the new PDF in preview
yarn node example/script/generate-pdf.js 5vqCxtgNsA2uzgMH0ps4cyQyadhA2Wdt && open example/script/generate.output.pdf

# Generate a PDF with your payload, then open the new PDF in preview
yarn node example/script/generate-pdf.js apiKeydef345 ./payload.json && open example/script/generate.output.pdf
```

`payload.json` is an optional JSON file with the JSON data used to generate the PDF. e.g.

```json
{
  "title": "My PDF Title",
  "data": [{
    "label": "Hello World!",
    "content": "Lorem **ipsum** dolor sit _amet_."
  }]
}
```

## create-etch-packet.js script

Calls the createEtchPacket Anvil endpoint with data specified to generate an Etch Packet with the Anvil API. Returns
the status and the generated packet.

Usage example:

```sh
# Creates an Etch Packet with given information, either a castEid or filename must be supplied
yarn node example/script/create-etch-packet.js <apiKey> <castEid> <filename>

# An example
yarn node example/script/create-etch-packet.js WHG3ylq0EE930IR2LZDtgoqgl55M3TwQ 99u7QvvHr8hDQ4BW9GYv ../../../simple-anvil-finovate-non-qualified.pdf
```

## get-etch-packet.js script

Calls the etchPacket Anvil endpoint with the specified Etch packet eid to get the packet details.

Usage example:

```sh
# Gets the details of an Etch Packet, a packet eid must be supplied
yarn node example/script/get-etch-packet.js <apiKey> <etchPacketEid>

# An example
yarn node example/script/get-etch-packet.js WHG3ylq0EE930IR2LZDtgoqgl55M3TwQ QJhbdpK75RHRQcgPz5Fc
```

## generate-etch-sign-url.js script

Calls the generateEtchSignUrl Anvil endpoint with data specified to generate an Etch sign link with the Anvil API. Returns the sign link.

Usage example:

```sh
# Generates a sign link for the given signer and client.
yarn node example/script/generate-etch-sign-url.js <apiKey> <clientUserId> <signerEid>

# An example
yarn node example/script/generate-etch-sign-url.js WHG3ylq0EE930IR2LZDtgoqgl55M3TwQ eBim2Vsv2GqCTJxpjTru ZTlbNhxP2lGkNFsNzcus
```

## download-documents.js script

Calls the downloadDocuments Anvil endpoint to download documents with the specified documentGroupEid in Zip file format. Outputs the downloaded Zip file in `example/script/{etchPacketName}.zip`. The default response data is returned in the form of a buffer. This can be changed by adding the `-s` flag to instead be returned as a PassThrough stream.

Usage example:

```sh
# Downloads a Document Group in a Zip file and outputs in the example/script folder
yarn node example/script/download-documents.js <apiKey> <documentGroupEid>

# An example
yarn node example/script/download-documents.js WHG3ylq0EE930IR2LZDtgoqgl55M3TwQ uQiXw4P4DTmXV1eNDmzH
```