feat!: update to mailchannels email api 0.11.0
#1
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Welcome to Codecov 🎉Once you merge this PR into your default branch, you're all set! Codecov will compare coverage reports and display results in all future pull requests. Thanks for integrating Codecov - We've got you covered ☂️ |
0.11.00.11.0
Sub-account creation now requires a company name parameter, validated to be 3-128 characters. Documentation, types, implementation, and tests have been updated to support and verify this change.
0.11.00.11.0
Deploying mailchannels with
|
| Latest commit: |
5440475
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://d1f05a3e.mailchannels-1ac.pages.dev |
| Branch Preview URL: | https://email-api-update.mailchannels-1ac.pages.dev |
263dc53 to
4dcbfd1
Compare
There was a problem hiding this comment.
Pull Request Overview
This PR updates the MailChannels Email API from version 0.7.0 to 0.11.0, implementing new endpoints and updating existing ones according to the breaking changes in the API specification.
- Adds new modules for Metrics and Suppressions functionality
- Updates Sub-accounts module with limit management and usage statistics endpoints
- Enhances Webhooks module with validation endpoint and endpoint length restrictions
- Updates Emails module with new campaignId and transactional options
Reviewed Changes
Copilot reviewed 48 out of 76 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| src/modules/webhooks.ts | Adds validate method and endpoint length validation for webhook enrollment |
| src/modules/suppressions.ts | New module implementing suppression list management endpoints |
| src/modules/sub-accounts.ts | Enhanced with limit management, usage stats, and updated create method requiring company name |
| src/modules/metrics.ts | New module for retrieving engagement, performance, volume and usage metrics |
| src/modules/emails.ts | Adds campaignId and transactional options to email sending |
| src/utils/errors.ts | Enhanced error handling for different response data types |
| test/ files | Comprehensive test coverage for all new functionality |
| docs/ files | Updated documentation for all new endpoints and changes |
| playground/ files | Example scripts for testing new endpoints |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
Co-authored-by: Copilot <[email protected]>
Co-authored-by: Copilot <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
MailChannels introduced some changes and new endpoints to the email API
Current version:
0.7.0Target version:
0.11.0Email API
New endpoints:
Updated endpoints:
Added
campaignIdandtransactionaloptions.Endpoint value length is now limited to a maximum of 8000 characters.
Sub-account creation now requires a company name parameter
In this PR docs must be updated accordingly and fix any type issues