compare changes

💅 Refactors

• ⚠️ Single import pattern module exports + update docs (#19)

Modular usage changed:

// before
import { MailChannelsClient } from 'mailchannels-sdk'
import { Emails } from 'mailchannels-sdk/modules'

// now
import { MailChannelsClient, Emails } from 'mailchannels-sdk'

📖 Documentation

• Update disclaimer (40dd4bc)
• Fix code block highlighting in guide example (8cae28a)
• Badge tip type not necessary (580e3e9)

🏡 Chore

• Simplify tsconfig (6fc6f48)

✅ Tests

• Add missing Promise rejection in mock implementations for api error handling scenarios (4387945)

⚠️ Breaking Changes

• ⚠️ Single import pattern module exports + update docs (#19)

❤️ Contributors

• Yizack Rangel (@Yizack)

compare changes

🩹 Fixes

• sub-accounts: Add missing listApiKeys options (d3c8454)

📖 Documentation

• Add modules list styling to search results (13291ea)
• Rename modules source plugin (7f403c1)
• Add vitepress-plugin-llms (ce959d7)
• Move openapi to .openapi to exclude from docs (ad8ad35)
• llm: Ignore contributors page (66079bb)
• emails: Update max email size error message to 30MB (771a2db)
• Prefer Badge component slot for better llms.txt (3711ea0)

🏡 Chore

• Improve project's tsconfig.json (67bdeed)

❤️ Contributors

• Yizack Rangel (@Yizack)

compare changes

🚀 Enhancements

• emails: Update checkDomain to support managed or stored DKIM (dc5692f)

🩹 Fixes

• emails: Allow sending email headers (dc2ea82)

📖 Documentation

• Update Email API version to 0.13.0 (c1846fc)

🏡 Chore

• Add MailChannels OpenAPI specs for control (267d059)

❤️ Contributors

• Yizack Rangel (@Yizack)

compare changes

📖 Documentation

• Improve readme features list (7136b82)
• lists: Fix typo (8e06389)
• Improve formatting and clarity (cd6dd19)
• Improve param types and add responses (#11)
• types: Add missing trailing periods (695373b)
• Improve params and response style in modules (1a37d5e)
• domains: Improve domain data docs (bf8c5c1)

🏡 Chore

• Prefer pnpm to run scripts (3bfeeff)

❤️ Contributors

• Yizack Rangel (@Yizack)

compare changes

🚀 Enhancements

• emails: Include message info in send data response (f706938)

  Move rendered message from data to data.rendered to accommodate additional send information. No breaking change as data was only used internally for dry-run testing.

  Send email response type is now:

  export interface EmailsSendResponse {
    success: boolean;
    data: {
      rendered?: string[];
      requestId?: string;
      results?: {
        index?: number;
        messageId: string;
        reason?: string;
        status: "sent" | "failed";
      }[];
    } | null;
    error: string | null;
  }

📖 Documentation

• Add important note about roadmap links (df7a81d)

🏡 Chore

• Configure renovate (1d72229)

❤️ Contributors

• Yizack Rangel (@Yizack)

compare changes

🩹 Fixes

• emails: privateKey type in send method can be undefined (343657d)

📖 Documentation

• emails: Mention active dkim keys (dd23703)

❤️ Contributors

• Yizack Rangel (@Yizack)

compare changes

🚀 Enhancements

• Update email api 0.12.0 (02e86f4)

New endpoints:

• 📧 Emails
  • Create DKIM Key Pair
  • Retrieve DKIM Keys
  • Update DKIM Key Status

🩹 Fixes

• domains: Fix bulkCreateLoginLinks response types (b61bb65)
• types: Fix length values (cfa81e2)
• Remove non existent import (ad3d43a)

📖 Documentation

• Update inbound api version (aab9149)
• Add new email api endpoints (aeb2773)
• Fix typos and inconsistencies (44948a3)
• domains: Fix list description (6fa040f)

🏡 Chore

• Build before release tag to avoid fail on github (57ad31c)

✅ Tests

• Add patch test (2bd2446)

❤️ Contributors

• Yizack Rangel (@Yizack)

compare changes

🚀 Enhancements

• domains: Add bulkCreateLoginLinks method (0edd816)

📖 Documentation

• suppressions: Fix suppression response (26953a5)
• domains: Fix typo (9d8d39f)
• Add features to readme (34f4f49)

🏡 Chore

• Export some missing types (9f63d72)
• ci: Add new line (1e9f7ec)
• types: Use explicit import path for consistency (75cc53a)

✅ Tests

• Remove unused imports (3bf659c)

🤖 CI

• Use npm trusted publishing (fd1d591)
• Use latest node for trusted publish (0125387)

❤️ Contributors

• Yizack Rangel (@Yizack)

compare changes

🚀 Enhancements

• ⚠️ Update to mailchannels email api 0.11.0 (#1)

New endpoints:

• 📢 Webhooks
  • Validate Enrolled Webhook
• 🪪 Sub-accounts
  • Retrieve Sub-account Limit
  • Set Sub-account Limit
  • Delete Sub-account Limit
  • Retrieve Sub-account Usage Stats
• 📊 Metrics
  • Retrieve Engagement Metrics
  • Retrieve Performance Metrics
  • Retrieve Recipient Behaviour Metrics
  • Retrieve Usage Stats
  • Retrieve Volume Metrics
• 🚫 Suppressions
  • Create Suppression Entries
  • Delete Suppression Entry
  • Retrieve Suppression List

Updated endpoints:

• 📧 Emails
  • Send an Email
    Added campaignId and transactional options.
• 📢 Webhooks
  • Enroll for Webhook Notifications
    Endpoint value length is now limited to a maximum of 8000 characters.
• 🪪 Sub-accounts
  • Create Sub-account
    Sub-account creation now requires a company name parameter

    // Before
    subAccounts.create('validhandle123')
    // Now
    subAccounts.create('My Company', 'validhandle123')

🩹 Fixes

• domains: Add missing returning type in addListEntry (14a755a)

📖 Documentation

• Update new endpoints list and add links (7880e36)

🏡 Chore

• lint: Add function-call-spacing stylistic rule (ac9055e)

✅ Tests

• Error prop must be truthy on error (ffed7a9)

🤖 CI

• Update to actions/checkout@v5 (964752b)
• Update autofix-ci (45c386a)

⚠️ Breaking Changes

• ⚠️ Update to mailchannels email api 0.11.0 (#1)

❤️ Contributors

• Yizack Rangel (@Yizack)

compare changes

📦 Build

• Update readme for each mirror package (5ee3e14)

❤️ Contributors

• Yizack Rangel (@Yizack)