Add App API transactional message management methods (CDP-6267)#231
Merged
Conversation
Batch 3 of the App API backfill. Adds nine methods to APIClient: - listTransactionalMessages / getTransactionalMessage - getTransactionalMessageContents / getTransactionalMessageLanguage - updateTransactionalMessageLanguage / updateTransactionalMessageContent - getTransactionalMessageDeliveries / getTransactionalMessageMetrics - getTransactionalMessageLinkMetrics Complements the existing sendEmail/sendPush/etc. send methods. Reuses the buildQueryString helper for deliveries/metrics query params. Includes unit tests (100% coverage), live integration coverage (workspace list + id-scoped reads gated on CIO_TEST_TRANSACTIONAL_ID), and docs in docs/app.md. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
yegorkay
approved these changes
Jul 7, 2026
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 adds more missing methods from the App API. This adds the transactional message management endpoints, complementing the existing
sendEmail/sendPush/etc. send methods.listTransactionalMessages/transactionalgetTransactionalMessage/transactional/{id}getTransactionalMessageContents/transactional/{id}/contentsgetTransactionalMessageLanguage/transactional/{id}/language/{language}updateTransactionalMessageLanguage/transactional/{id}/language/{language}getTransactionalMessageDeliveries/transactional/{id}/messagesgetTransactionalMessageMetrics/transactional/{id}/metricsgetTransactionalMessageLinkMetrics/transactional/{id}/metrics/linksupdateTransactionalMessageContent/transactional/{id}/content/{content_id}Assisted by AI 🤖
Note
Medium Risk
PUT methods can change live transactional templates in production workspaces; risk is mitigated by following existing API patterns and limiting live tests to read-only calls.
Overview
Adds nine
APIClientmethods for managing transactional messages via the App API (list/get metadata, contents, per-language translations, delivery listings, delivery and link metrics, and PUT updates for language and content variants). New option types (MetricsPeriod,TransactionalMetricsOptions,TransactionalLinkMetricsOptions,TransactionalDeliveriesOptions) type query filters for deliveries and metrics; list/filter endpoints use the existingbuildQueryStringhelper and the sameMissingParamErrorvalidation as other client methods.docs/app.mddocuments each new method. Unit tests cover paths, query strings, PUT bodies, and required-param errors. Live tests calllistTransactionalMessagesand read-only id-scoped endpoints whenCIO_TEST_TRANSACTIONAL_IDis set; mutating updates stay unit-tested only.Reviewed by Cursor Bugbot for commit e40a6fe. Bugbot is set up for automated code reviews on this repo. Configure here.