Skip to content

feat: add broadcasts->cancel() method #135

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
jayanratna merged 3 commits into from
Aug 11, 2026
Merged

feat: add broadcasts->cancel() method #135

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
491cd9c
feat: add broadcasts->cancel() method
dielduarte Aug 10, 2026
c019b18
docs: add PHPDoc for Broadcast::cancel()
dielduarte Aug 10, 2026
7a93e65
Bump SDK version from 1.7.0 to 1.8.0
jayanratna Aug 10, 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
2 changes: 1 addition & 1 deletion src/Resend.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ class Resend
/**
* The current SDK version.
*/
public const VERSION = '1.7.0';
public const VERSION = '1.8.0';

/**
* Creates a new Resend Client with the given API key.
Expand Down
14 changes: 14 additions & 0 deletions src/Service/Broadcast.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,20 @@ public function send(string $broadcastId, array $parameters): \Resend\Broadcast
return $this->createResource('broadcasts', $result);
}

/**
* Cancel a queued or scheduled broadcast.
*
* @see https://resend.com/docs/api-reference/broadcasts/cancel-broadcast
*/
public function cancel(string $id): \Resend\Broadcast
{
$payload = Payload::cancel('broadcasts', $id);

$result = $this->transporter->request($payload);

return $this->createResource('broadcasts', $result);
}

/**
* Remove an existing broadcast.
*
Expand Down
9 changes: 9 additions & 0 deletions tests/Service/Broadcast.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,15 @@
->id->toBe('559ac32e-9ef5-46fb-82a1-b76b840c0f7b');
});

it('can cancel a broadcast resource', function () {

@cubic-dev-ai cubic-dev-ai Bot Aug 10, 2026

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.

P2: Custom agent: API Key Permission Check SDK Methods

This PR introduces a new provider SDK operation, Broadcast::cancel() (calling POST /broadcasts/{id}/cancel), which is not previously used by this SDK. Since this adds a new broadcast-management permission scope, please confirm that the broadcast API keys used in production have the required permission for the cancel operation, so the call doesn't fail with a permission error after deployment.

Prompt for AI agents 
Check if this issue is valid — if so, understand the root cause and fix it. At tests/Service/Broadcast.php, line 65:

<comment>This PR introduces a new provider SDK operation, `Broadcast::cancel()` (calling `POST /broadcasts/{id}/cancel`), which is not previously used by this SDK. Since this adds a new broadcast-management permission scope, please confirm that the broadcast API keys used in production have the required permission for the `cancel` operation, so the call doesn't fail with a permission error after deployment.</comment>

<file context>
@@ -62,6 +62,15 @@
         ->id->toBe('559ac32e-9ef5-46fb-82a1-b76b840c0f7b');
 });
 
+it('can cancel a broadcast resource', function () {
+    $client = mockClient('POST', 'broadcasts/559ac32e-9ef5-46fb-82a1-b76b840c0f7b/cancel', [], [], broadcast());
+
</file context>

$client = mockClient('POST', 'broadcasts/559ac32e-9ef5-46fb-82a1-b76b840c0f7b/cancel', [], [], broadcast());

$result = $client->broadcasts->cancel('559ac32e-9ef5-46fb-82a1-b76b840c0f7b');

expect($result)->toBeInstanceOf(Broadcast::class)
->id->toBe('559ac32e-9ef5-46fb-82a1-b76b840c0f7b');
});

it('can remove a broadcast resource', function () {
$client = mockClient('DELETE', 'broadcasts/559ac32e-9ef5-46fb-82a1-b76b840c0f7b', [], [], broadcast());

Expand Down