Document translated admin reply topics and translations field in 2.16 - #692
Conversation
Mirrors what Preview PRs #621, #638, #654 and #668 added into the 2.16 spec, matching the promotion in intercom/intercom#585326. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
geetikabagga
left a comment
There was a problem hiding this comment.
Thanks Yasser, this looks right. I checked the schema against the serializers and the structure of the spec. Two small things, neither blocking:
1. The body sentence isn't true when include_translations=true.
All three schemas say "The translations field does not modify body; body carries the reply as authored." But 2.16 also has include_translations on Retrieve a conversation (AddIncludeTranslationsParameter is in 2.14). With it set to true, body is rendered translated (VersionedConversationPartResponse#body → render_localized_body(…, translation_enabled:)). Suggested wording:
translationsdoes not changebody.bodycarries the reply as authored, unless you retrieve the conversation withinclude_translations=true.
The same sentence is in the developer-docs#1181 changelog, so please change both. The two spec copies need to stay identical.
2. (nit) The new Admin reply response example on replyTicket has no matching request example.
Fern pairs request and response examples by position, so in the generated definition the user_reply request now shows the admin comment response. 2.16 isn't SDK-generated today, so this is cosmetic. Renaming it, or adding an admin_reply request example, would keep the pairs meaningful.
What I checked, so nobody needs to redo it:
- Base vs head: 232/232 operations, no duplicate keys, null paths or dangling refs. Only
conversation_part,ticket_part,ticket_replyand three examples change. fern write-definitionpointed at 2.16: identical 235 endpoints, plus three inline types.fern checkon 2.16: the same 20 pre-existing errors before and after.- The CI Fern Check only covers 2.14 and Preview, so it doesn't speak to this change.
- The 112 added lines are identical to developer-docs#1181.
anubhav-intercom
left a comment
There was a problem hiding this comment.
Wording changes to match the docs guardrails in intercom#583317 (ship-public-api/references/documentation.md §5). The inline suggestions shorten the three translations descriptions, and dropping the body sentence also covers Geetika's include_translations note. Please use the same text in developer-docs#1181 so both repos stay byte-identical.
Limits them to what the field contains and drops the body sentence, which is wrong when a conversation is retrieved with include_translations=true. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Pairs with the new Admin reply response example, so the request shown next to it is an admin comment instead of the user reply. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Why?
API version 2.16 now includes the
conversation.admin.replied.translatedandticket.admin.replied.translatedwebhook topics and thetranslationsfield on conversation and ticket parts, but the 2.16 spec doesn't describe them yet.How?
Adds the
translationsfield and matching examples to the 2.16 spec, using the same wording as the Preview spec.Generated with Claude Code