Skip to content
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.

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

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

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

Conversation

usualdesigner
Copy link

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

  • I acknowledge that all my contributions will be made under the project's license
  • I have made a material change to the repo (functionality, testing, spelling, grammar)
  • I have read the Contribution Guidelines and my PR follows them
  • I have titled the PR appropriately
  • I have updated my branch with the main branch
  • I have added tests that prove my fix is effective or that my feature works
  • I have added the necessary documentation about the functionality in the appropriate .md file
  • I have added inline documentation to the code I modified

@Hainesy
Copy link

Hainesy commented Aug 13, 2024

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

@usualdesigner
Copy link
Author

I do not know. @thinkingserious can yo suggest?

@sbansla sbansla self-requested a review November 4, 2024 10:39
@sbansla
Copy link

sbansla commented Nov 5, 2024

Review in progress.

@sbansla sbansla self-requested a review November 20, 2024 04:07
@@ -16,7 +16,7 @@ const msg = {
filename: 'some-attachment.txt',
type: 'plain/text',
disposition: 'attachment',
content_id: 'mytext'
contentId: 'mytext'
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As per sendgrid open api specification, it is content_id

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ThecontentId property is used internally in the Attachment class. You are correct that the API expects the content_id property, and that is exactly what we send. The toJSON method of the Mail class handles this conversion, transforming the internal camelCase structure into the snake_case format expected by the API.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants