feat(smtp): add contactPixelTrackingConsent to transactional email recipients - #144
Open
piyush-sib wants to merge 1 commit into
Open
Conversation
Add the optional per-recipient `contactPixelTrackingConsent` boolean to the `to`, `cc` and `bcc` items of `POST /v3/smtp/email`, and to the same three recipient lists nested inside `messageVersions`: - SendTransacEmailRequestToItem - SendTransacEmailRequestCcItem - SendTransacEmailRequestBccItem - SendTransacEmailRequestMessageVersionsItemToItem - SendTransacEmailRequestMessageVersionsItemCcItem - SendTransacEmailRequestMessageVersionsItemBccItem The field is live in production and already present in the OpenAPI spec, but this SDK has not been regenerated since 2026-07-03, so it was missing. This is a hand-written stopgap that mirrors the Fern PHP generator output exactly (typed nullable property + `#[JsonProperty]` attribute, alphabetically ordered, constructor array-shape docblock entry, `?? null` default). Field descriptions are copied verbatim from the spec. NOTE: this repository is Fern-generated. The next `fern generate` will overwrite these files — that is expected and fine, since the regenerated output will contain the same field. No version bump: Fern owns versioning. Tri-state semantics verified end to end against the wire bytes: `true` -> `"contactPixelTrackingConsent":true`, `false` -> `false`, and when the key is omitted (or passed as PHP `null`) it is absent from the payload, because JsonSerializableType::jsonSerialize() drops null properties that were never marked explicitly set. The description text covers both open (pixel) and click tracking: per-contact consent gates click links as well, via an=1 stamped at send time by sendmail-personaliser #1231 and consumed by redirection #2384 (in production since 2026-08-03). The matching public-api spec wording update is still pending, so these descriptions are currently ahead of the published spec text. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
|
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Adds the optional per-recipient
contactPixelTrackingConsentboolean to theto,ccandbccitems ofPOST /v3/smtp/email, and to the same three recipient lists nested insidemessageVersions:SendTransacEmailRequestToItem/CcItem/BccItemSendTransacEmailRequestMessageVersionsItemToItem/CcItem/BccItemEach is a typed nullable property with a
#[JsonProperty]attribute, alphabetically ordered, plus the constructor array-shape docblock entry and?? nulldefault — mirroring the Fern PHP generator output exactly.Verified
phpstan(level max, 996 files) andphpunit(75 tests) green both before and afterphp -lclean on all six edited filestrue→"contactPixelTrackingConsent":true,false→false, and omitted (or PHPnull) → key absent, becauseJsonSerializableType::jsonSerialize()drops null properties never marked explicitly setapi.brevo.com/v3on prod test account 3143293:201, deliveredWhy this is hand-written
This repo is Fern-generated and has not been regenerated since 2026-07-03, so the field never appeared in the published SDK even though the spec has carried it for weeks. Rather than keep waiting on a
fern generaterun, this is a hand-written stopgap that matches what the generator would emit. The nextfern generatewill overwrite these files — that is expected and fine, because the regenerated output contains the same field. No version bump: Fern owns versioning.Six edits, not four: Fern inlines separate recipient copies for
messageVersions, matching the 6 occurrences in the spec.Description wording covers clicks too
Per-contact consent gates click links as well as the open pixel —
an=1is stamped at send time by DTSL/sendmail-personaliser#1231 and consumed by DTSL/redirection#2384, in production since 2026-08-03. The descriptions here reflect that. The matching spec wording update is DTSL/public-api#5895 (legacy client spec + OpenAPI bundle + generated v3, all in one PR). Until it merges this text is ahead of the published spec.Related
🤖 Generated with Claude Code