Add App API broadcast methods#233
Merged
Merged
Conversation
![cursor[bot]](https://avatars.githubusercontent.com/in/1210556?s=60&v=4){kind=small}
There was a problem hiding this comment.
Cursor Bugbot has reviewed your changes and found 1 potential issue.
❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, have a team admin enable autofix in the Cursor dashboard.
Reviewed by Cursor Bugbot for commit 936d0f8. Configure here.
| throw new MissingParamError('broadcastId'); | ||
| } | ||
|
|
||
| return this.request.get(`${this.resourceBase('broadcasts', broadcastId)}/actions`); |
There was a problem hiding this comment.
Missing actions pagination cursor
Medium Severity
getBroadcastActions always requests /actions with no query string, while the parallel getCampaignActions accepts an optional start cursor on the same sub-resource pattern documented via resourceBase. Broadcasts with paginated action lists cannot be fetched beyond the first page.
Reviewed by Cursor Bugbot for commit 936d0f8. Configure here.
mike-engel
changed the title
yegorkay
previously approved these changes
Jul 7, 2026
Batch 5 of the App API backfill, stacked on Batch 4 (Campaigns). Adds thirteen broadcast methods to APIClient: - listBroadcasts / getBroadcast - getBroadcastActions / getBroadcastAction / updateBroadcastAction - getBroadcastActionLanguage / updateBroadcastActionLanguage - getBroadcastActionMetrics / getBroadcastActionMetricsLinks - getBroadcastMetrics / getBroadcastMetricsLinks - getBroadcastMessages / getBroadcastTriggers Reuses the shared metric types and the private resourceBase() helper introduced in Batch 4. Adds a BroadcastMessagesOptions type. Includes unit tests (100% coverage), live integration coverage (gated on the existing CIO_TEST_BROADCAST_ID), and docs in docs/app.md. Stacked on cdp-6268; rebase onto main once Batch 4 lands. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
De-duplicate the delivery-state union ('failed' | 'sent' | 'drafted' |
'attempted') into an exported DeliveryState type, used by
BroadcastMessagesOptions. TransactionalDeliveriesOptions (on the separate
cdp-6267 branch) can converge on the same type once both land on main.
Co-Authored-By: Claude Opus 4.8 (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
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.
This is the next set of the App API backfill, which adds the broadcast endpoints to
APIClient.New methods (13)
listBroadcasts,getBroadcast,getBroadcastActions,getBroadcastAction,updateBroadcastAction,getBroadcastActionLanguage,updateBroadcastActionLanguage,getBroadcastActionMetrics,getBroadcastActionMetricsLinks,getBroadcastMetrics,getBroadcastMetricsLinks,getBroadcastMessages,getBroadcastTriggers.Assisted by AI 🤖
Note
Low Risk
Additive SDK surface and documentation with established patterns; PUT update methods are tested in unit tests only in live runs, limiting production mutation risk.
Overview
Extends
APIClientwith 13 broadcast App API methods (list/get broadcast, actions, localized action content, metrics, messages, and triggers), calling/broadcasts/...via the existingresourceBase('broadcasts', ...)helper.Adds shared
DeliveryStateandBroadcastMessagesOptionstypes (transactional delivery listing now usesDeliveryStatetoo).docs/app.mddocuments the new methods;test/api.tscovers URLs, query params, and validation;test/integration/live.tsadds read-only live checks (mutating action updates stay unit-tested only).Reviewed by Cursor Bugbot for commit f952976. Bugbot is set up for automated code reviews on this repo. Configure here.