docs: type listAwayStatusReasons response as list wrapper#569
Merged
Conversation
GET /away_status_reasons returns Intercom's standard list envelope
{ "type": "list", "data": [...] }, but the 200 response was modeled as a
bare array of away_status_reason objects. Add an away_status_reason_list
component (matching the tag_list/brand_list convention) and point the 200
response at it, across the versions that expose the endpoint: 2.14, 2.15,
and 0 (Preview).
Verified against the monolith: Api::V3::AwayStatusReasonsController#index
renders via AwayStatusReasonListResponse, which emits { type: "list", data }.
fern check reports no new errors or warnings vs main.
Refs intercom/intercom-node#520, FER-11398, #558.
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
zilleeizad-inter
approved these changes
Jun 29, 2026
zilleeizad-inter
left a comment
zilleeizad-inter
left a comment
There was a problem hiding this comment.
LGTM — schema fix is correct and consistent with the tag_list convention (no required array, matching all other list schemas). Version coverage across descriptions/0, 2.14, and 2.15 is complete. Verified symmetry with the companion developer-docs PR.
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
2 participants
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.
Why?
The published API reference and OpenAPI spec document
GET /away_status_reasons(listAwayStatusReasons)200as a bare array ofaway_status_reasonobjects. The endpoint actually returns Intercom's standard list envelope{ "type": "list", "data": [...] }. Verified against the monolith:Api::V3::AwayStatusReasonsController#indexrenders viaApi::V3::AdminStatus::Presenters::AwayStatusReasonListResponse, which hard-codestype: "list"anddata. The spec has always documented the wrong shape, misleading integrators and SDK codegen.How?
Add an
away_status_reason_listcomponent (matching the existingtag_list/brand_listconvention) and point the200response at it, in every version that exposes the endpoint: 2.14, 2.15, and 0 (Preview).fern checkreports no new errors or warnings vsmain.References
listAwayStatusReasonsintercom-node#520Generated with Claude Code