mailchannels-sdk 0.4.7 → 0.6.0

package/README.md

@@ -1,6 +1,6 @@
-![MailChannels](/docs/public/images/presentation.png)
+![MailChannels Node.js SDK](/docs/public/images/presentation.png)
 
-# MailChannels
+# MailChannels Node.js SDK
 
 [![npm version][npm-version-src]][npm-version-href]
 [![npm downloads][npm-downloads-src]][npm-downloads-href]
@@ -13,8 +13,8 @@ This library provides a simple way to interact with the [MailChannels API](https
 <!-- #endregion overview -->
 
 <!-- #region note -->
-> [!NOTE]
-> This library is NOT officially maintained by [MailChannels Corporation](https://mailchannels.com/).
+> [!IMPORTANT]
+> **Disclaimer**: This library is not associated with [MailChannels Corporation](https://mailchannels.com/).
 <!-- #endregion note -->
 
 - [✨ Release Notes](CHANGELOG.md)
@@ -70,7 +70,7 @@ pnpm add mailchannels-sdk
 
 Already implemented features are marked with a checkmark. Please open an issue if you find any bugs or missing features.
 
-> [!IMPORTANT]
+> [!NOTE]
 > Links below point to the official MailChannels API documentation, options and responses may differ slightly when using this SDK. Please refer to the [documentation](https://mailchannels.yizack.com) for the correct usage of each feature.
 
 ### [Email API](https://docs.mailchannels.net/email-api/api-reference/email-api)
@@ -81,6 +81,7 @@ Already implemented features are marked with a checkmark. Please open an issue i
   - ✅ [Create DKIM Key Pair](https://docs.mailchannels.net/email-api/api-reference/create-dkim-key-pair)
   - ✅ [Retrieve DKIM Keys](https://docs.mailchannels.net/email-api/api-reference/retrieve-dkim-keys)
   - ✅ [Update DKIM Key Status](https://docs.mailchannels.net/email-api/api-reference/update-dkim-key-status)
+  - ✅ [Rotate DKIM Key Pair](https://docs.mailchannels.net/email-api/api-reference/rotate-dkim-key-pair)
 - 📢 Webhooks
   - ✅ [Enroll for Webhook Notifications](https://docs.mailchannels.net/email-api/api-reference/enroll-for-webhook-notifications)
   - ✅ [Retrieve Customer Webhooks](https://docs.mailchannels.net/email-api/api-reference/retrieve-customer-webhooks)
@@ -109,6 +110,7 @@ Already implemented features are marked with a checkmark. Please open an issue i
   - ✅ [Retrieve Recipient Behaviour Metrics](https://docs.mailchannels.net/email-api/api-reference/retrieve-recipient-behaviour-metrics)
   - ✅ [Retrieve Usage Stats](https://docs.mailchannels.net/email-api/api-reference/retrieve-usage-stats)
   - ✅ [Retrieve Volume Metrics](https://docs.mailchannels.net/email-api/api-reference/retrieve-volume-metrics)
+  - ✅ [Retrieve Sender Metrics](https://docs.mailchannels.net/email-api/api-reference/retrieve-sender-metrics)
 - 🚫 Suppressions
   - ✅ [Create Suppression Entries](https://docs.mailchannels.net/email-api/api-reference/create-suppression-entries)
   - ✅ [Delete Suppression Entry](https://docs.mailchannels.net/email-api/api-reference/delete-suppression-entry)
@@ -154,20 +156,20 @@ Already implemented features are marked with a checkmark. Please open an issue i
 pnpm install
 
 # Build the package
-npm run build
+pnpm build
 
 # Run ESLint
-npm run lint
+pnpm lint
 
 # Run Vitest
-npm run test
-npm run test:watch
+pnpm test
+pnpm test:watch
 
 # Run typecheck
-npm run test:types
+pnpm test:types
 
 # Release new version
-npm run release
+pnpm release
 ```
 
 </details>