Skip to content

Add campaign contact frequency caps to TypeScript SDK #351

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
purpshell merged 2 commits into from
Oct 17, 2026
Merged

Add campaign contact frequency caps to TypeScript SDK #351

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
83eb304
Add campaign contact frequency caps to TypeScript SDK
purpshell Oct 17, 2026
5583e43
Verify cap read projections and error codes
purpshell Oct 17, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -884,3 +884,16 @@
- Aligned call signaling and media behavior with the `voip-v2` implementation.

This is a Git development channel. No npm package has been published.

## Campaign contact frequency caps (beta)

`client.campaigns.getFrequencyCap()` reads team limits and their revision.
`client.campaigns.updateFrequencyCap({ maxPer24Hours: 2, maxPer7Days: 5, revision })`
replaces both windows. Send both limits as null to remove them. A stale revision
raises `PolymorfaConflictError`; read and reconcile before trying again. A new
limit requires beta access and can return `403 feature_unavailable`.
Campaign create/update accepts `frequencyCap`; null removes a campaign cap.
Recipient reads expose `failureReason` and accept `reason: "frequency_cap"`.
Analytics adds `frequencyCap.skippedRecipientCount`. Raising limits never retries
settled skips. `contracts/campaign-frequency-cap.json` pins the merged API source;
package publication and API availability remain separate release gates.
13 changes: 13 additions & 0 deletions contracts/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -619,3 +619,16 @@ create, update, recipient and analytics schemas from API `dev` merge commit
`87b25fd9e2494d90f01f7511fb47be6a28845fa1` (polymorfa/polymorfa#503), with both source paths and file
hashes. `campaign-follow-ups-contract.test.ts` checks the SDK types against it.
The full snapshots stay pinned to `contracts/source.json` until the next repin.

## Campaign contact frequency caps (beta)

`client.campaigns.getFrequencyCap()` reads team limits and their revision.
`client.campaigns.updateFrequencyCap({ maxPer24Hours: 2, maxPer7Days: 5, revision })`
replaces both windows. Send both limits as null to remove them. A stale revision
raises `PolymorfaConflictError`; read and reconcile before trying again. A new
limit requires beta access and can return `403 feature_unavailable`.
Campaign create/update accepts `frequencyCap`; null removes a campaign cap.
Recipient reads expose `failureReason` and accept `reason: "frequency_cap"`.
Analytics adds `frequencyCap.skippedRecipientCount`. Raising limits never retries
settled skips. `contracts/campaign-frequency-cap.json` pins the merged API source;
package publication and API availability remain separate release gates.
Loading
Loading