Skip to content

Add support for attachedPDF form field #31

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
earlofurl wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Add support for attachedPDF form field #31

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
70d7df3
add support for attachedPdf in letter creation
earlofurl Feb 24, 2025
46f2369
Merge pull request #1 from earlofurl/feat/letter-attached-pdf
earlofurl Feb 24, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 15 additions & 1 deletion src/letter.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -127,6 +127,10 @@ export class LetterApi {
metadata?: any;
express?: boolean;
extraService?: string;
attachedPDF?: {
placement: 'before_template' | 'after_template';
file: string | Buffer;
};
}, options?: {
idempotencyKey?: string;
}): Promise<{
Expand All @@ -144,7 +148,7 @@ export class LetterApi {
letter.doubleSided = letter.doubleSided || false
letter.addressPlacement = letter.addressPlacement || 'insert_blank_page'
let body = letter
if (Buffer.isBuffer(letter.pdf)) {
if (Buffer.isBuffer(letter.pdf) || letter.attachedPDF?.file) {
const form = new FormData()
for (const [k, v] of Object.entries(letter)) {
// only add in the entries that have a non-null or defined, value...
Expand All @@ -164,6 +168,16 @@ export class LetterApi {
form.append(k, v.toString())
}
break
case 'attachedPDF':
if (v.placement) {
form.append('attachedPDF[placement]', v.placement)
}
if (Buffer.isBuffer(v.file)) {
form.append('attachedPDF[file]', v.file, 'attachment.pdf')
} else {
form.append('attachedPDF[file]', v.file)
}
break
case 'pdf':
form.append(k, letter.pdf, 'upload-content.pdf')
break
Expand Down
2 changes: 1 addition & 1 deletion tests/letter.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import { PostGrid } from '../src/index'
console.log('creating a single Letter...')
const what = {
description: 'Cool new letter',
pdf: 'https://www.icnaam.org/documents/8x11singlesample.pdf',
pdf: 'https://icnaam.org/wp-content/uploads/2024/10/AIP-CP-2017-Troubleshooting.pdf',
to: {
firstName: 'Steve',
lastName: 'Smith',
Expand Down