Skip to content

Add ability to force delete a visitor #5

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

Open
maarten00 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add ability to force delete a visitor #5

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
5 changes: 5 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,11 @@

All notable changes to `unifi-access-api` will be documented in this file

# 1.1.2 - 2025-10-25

**New features:**
- Update visitor delete method to allow force delete

## 1.1.1 - 2025-10-23

**Breaking:**
Expand Down
6 changes: 4 additions & 2 deletions src/API/VisitorClient.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,13 +92,15 @@ public function assignQrCode(UuidV4 $visitorId): UnifiResponse
}

/**
* @param bool $force If is_force is passed, physically delete this visitor; otherwise, update to canceled status.
*
* @throws InvalidResponseException
* @throws GuzzleException
* @throws UnifiApiErrorException
*/
public function delete(UuidV4 $visitorId): UnifiResponse
public function delete(UuidV4 $visitorId, bool $force = false): UnifiResponse
{
$response = $this->client->delete($this::ENDPOINT."/{$visitorId->getValue()}");
$response = $this->client->delete($this::ENDPOINT."/{$visitorId->getValue()}?is_force={($force ? 'true' : 'false')}");

$data = json_decode($response->getBody()->getContents(), true);

Expand Down