Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
62 changes: 62 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
# Changelog

All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [Unreleased]

### Added

- JSR-305 `@Nonnull` / `@Nullable` annotations across every public type (params, return values, getters, setters)
- Consistent **(required)** / **(optional)** Javadoc prefix on every builder setter, with constraint info (max length, mutual-exclusion, etc.)
- README section explaining how to tell required vs optional fields
- `compileOnly` dependency on `com.google.code.findbugs:jsr305:3.0.2`

## [0.2.0] - 2026-04-15

Full sync with the Lettr OpenAPI spec. All 27 documented endpoints are now covered.

### Added

- **Emails**: `listEvents()`, `schedule()`, `getScheduled()`, `cancelScheduled()`
- **Domains**: `verify()` with detailed DKIM/CNAME/DMARC/SPF validation results
- **Webhooks**: `create()`, `update()`, `delete()`
- **Templates**: `get()`, `update()`, `delete()`, `getMergeTags()`, `getHtml()`
- **Projects** service with `list()`
- **System** service with `health()` and `authCheck()`
- `CreateEmailOptions`: `cc`, `bcc`, `replyTo`, `replyToName`, `ampHtml`, `tag`, `headers`
- `EmailOptions`: `inlineCss`, `performSubstitutions`
- `EmailEvent`: type-specific fields (`bounceClass`, `targetLinkUrl`, `geoIp`, `userAgentParsed`, etc.) and many missing common properties
- `Domain`: `dmarcStatus`, `spfStatus`, `isPrimaryDomain`, `dnsProvider`
- HTTP client: `PUT` support and `DELETE` with query params
- Test suite (98 tests across 8 files)

### Changed

- `ListEmailsResponse` restructured to match the API's nested `events.data` shape (breaking)
- `GetEmailResponse` restructured to expose `transmissionId`, `state`, `recipients`, `events` (breaking)
- `EmailEvent`: `clickTracking`, `openTracking`, `transactional` now nullable `Boolean` (was primitive `boolean`); `msgSize` now nullable `Integer`
- `CreateEmailOptions`: `subject` no longer required when using `templateSlug`
- `MergeTag` extracted from `CreateTemplateResponse` into its own class; now exposes `type` and `children`

### Fixed

- DKIM record now includes the `headers` field
- DKIM response now includes `signingDomain`

## [0.1.0] - 2026-01-15

Initial release.

### Added

- Initial SDK with `Emails`, `Domains`, `Webhooks`, and `Templates` services
- Basic send, list, and get operations
- Bearer token auth, Gson-based JSON serialization
- Structured exceptions: `LettrException`, `LettrApiException`, `LettrValidationException`

[Unreleased]: https://github.com/lettr/lettr-java/compare/v0.2.0...HEAD
[0.2.0]: https://github.com/lettr/lettr-java/compare/v0.1.0...v0.2.0
[0.1.0]: https://github.com/lettr/lettr-java/releases/tag/v0.1.0
Loading
Loading