sendgrid / sendgrid-nodejs

The Official Twilio SendGrid Led, Community Driven Node.js API Library
https://sendgrid.com
MIT License
3k stars 782 forks source link

fix(client): Fix typescript issue in the Attachment model #1402

Open usualdesigner opened 4 months ago

usualdesigner commented 4 months ago

Fixes

Motivation This PR addresses an inconsistency in the TypeScript type definition for the Attachment model that prevents proper use of TypeScript with the library.

Issue The Attachment model's TypeScript type definition does not match the expected data structure for the SendGrid API. Specifically, the contentId field should be content_id to align with the API requirements. This discrepancy does not impact JavaScript users but hinders TypeScript usage by causing type errors.

Solution I store attachment details in the appropriate class with the toJSON method to ensure the content_id field is correctly included in the API request payload.

Also, I added tests to confirm the content_id field is correctly handled and included in the API request payload.

Checklist

Hainesy commented 2 months ago

I've just hit this issue... what needs to happen to get this PR reivewed?

usualdesigner commented 1 month ago

I do not know. @thinkingserious can yo suggest?