Skip to content

feat: add broadcasts.recipients() method - #261

Merged
dielduarte merged 1 commit into
mainfrom
feat/broadcasts-recipients
Aug 24, 2026
Merged

feat: add broadcasts.recipients() method#261
dielduarte merged 1 commit into
mainfrom
feat/broadcasts-recipients

Conversation

@dielduarte

@dielduarte dielduarte commented Aug 22, 2026

Copy link
Copy Markdown
Contributor

Adds Broadcasts.recipients() / recipients_async() for GET /broadcasts/{id}/recipients.

Spec: resend/resend-openapi#97
Node reference: resend/resend-node#1078

Tests: 584 passed. flake8 + mypy clean.


Summary by cubic

Adds resend.Broadcasts.recipients() and resend.Broadcasts.recipients_async() to list a broadcast’s recipients by event type with filters and cursor pagination. Previously recipient-level delivery and engagement data was not available; now clients can query sent, delivered, opened, clicked, bounced, and more, with counts and clicked links when applicable.

  • Public API: exports RecipientsParams, RecipientsResponse, BroadcastRecipient, BroadcastRecipientEventType, BroadcastRecipientBounceType, and BroadcastRecipientClickedLink via resend.__init__.
  • Request: requires broadcast_id (path) and type; optional email, bounce_type (only with type="bounced"), limit (1–100), and cursor params after/before (mutually exclusive).
  • Response: returns object="list", data: List[BroadcastRecipient], has_more; optional count for opened/clicked, bounce_type for bounced, and clicked_links for clicked.
  • Errors and examples: raises ResendError on 404 and NoContentError on empty responses; adds sync/async examples and tests covering success, pagination, optional fields, and error cases.

Written for commit 7a29780. Summary will update on new commits.

Review in cubic

@cubic-dev-ai cubic-dev-ai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No issues found across 7 files

Confidence score: 5/5

  • Automated review surfaced no issues in the provided summaries.
  • No files require special attention.

Requires human review: Adds new recipients and recipients_async methods to the Broadcasts module, along with supporting data models and tests for the new API endpoint.

Re-trigger cubic

@dielduarte
dielduarte marked this pull request as ready for review August 22, 2026 01:54
@github-actions github-actions Bot added the linear-synced PR has been synced to Linear label Aug 22, 2026
Wraps GET /broadcasts/{id}/recipients to list a broadcast's recipients
for a given event type, with support for email/bounce_type filters
and cursor pagination.
@dielduarte
dielduarte force-pushed the feat/broadcasts-recipients branch from 4abdc68 to 7a29780 Compare August 24, 2026 14:31
@dielduarte
dielduarte merged commit c03bd15 into main Aug 24, 2026
20 checks passed
@dielduarte
dielduarte deleted the feat/broadcasts-recipients branch August 24, 2026 15:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

linear-synced PR has been synced to Linear

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants