Skip to content

OpenAPI schema sync #150

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.

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
merged 18 commits into from
Feb 11, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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 .changeset/good-experts-watch.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'fingerprint-pro-server-api-php-sdk': minor
---

**events-search**: Add a new `events/search` API endpoint. Allow users to search for identification events matching one or more search criteria, for example, visitor ID, IP address, bot detection result, etc.
8 changes: 8 additions & 0 deletions .changeset/pre.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"mode": "pre",
"tag": "develop",
"initialVersions": {
"fingerprint-pro-server-api-php-sdk": "6.2.1"
},
"changesets": []
}
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -122,6 +122,15 @@ try {
echo 'Exception when calling FingerprintApi->getVisits: ', $e->getMessage(), PHP_EOL;
}

// Search for specific events
try {
// Search events for given visitor id marked as suspicious and "bad" bot
list($model, $response) = $client->searchEvents(LIMIT, FPJS_VISITOR_ID, 'bad', null, null, null, null, null, true);
echo "<pre>" . $response->getBody()->getContents() . "</pre>";
} catch (Exception $e) {
echo 'Exception when calling FingerprintApi->searchEvents: ', $e->getMessage(), PHP_EOL;
}

// Get a specific visitor's all visits with a linkedId
try {
// Fetch all visits with a given visitorId, with a page limit, skipping the first visit
Expand Down Expand Up @@ -239,6 +248,7 @@ Class | Method | HTTP request | Description
*FingerprintApi* | [**getEvent**](docs/Api/FingerprintApi.md#getevent) | **GET** /events/{request_id} | Get event by request ID
*FingerprintApi* | [**getRelatedVisitors**](docs/Api/FingerprintApi.md#getrelatedvisitors) | **GET** /related-visitors | Get Related Visitors
*FingerprintApi* | [**getVisits**](docs/Api/FingerprintApi.md#getvisits) | **GET** /visitors/{visitor_id} | Get visits by visitor ID
*FingerprintApi* | [**searchEvents**](docs/Api/FingerprintApi.md#searchevents) | **GET** /events/search | Get events via search
*FingerprintApi* | [**updateEvent**](docs/Api/FingerprintApi.md#updateevent) | **PUT** /events/{request_id} | Update an event with a given request ID

## Documentation for Models
Expand Down Expand Up @@ -308,6 +318,8 @@ Class | Method | HTTP request | Description
- [RelatedVisitorsResponse](docs/Model/RelatedVisitorsResponse.md)
- [RemoteControl](docs/Model/RemoteControl.md)
- [RootApps](docs/Model/RootApps.md)
- [SearchEventsResponse](docs/Model/SearchEventsResponse.md)
- [SearchEventsResponseEvents](docs/Model/SearchEventsResponseEvents.md)
- [SuspectScore](docs/Model/SuspectScore.md)
- [Tampering](docs/Model/Tampering.md)
- [Tor](docs/Model/Tor.md)
Expand Down
2 changes: 1 addition & 1 deletion composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@
"ext-openssl": "*"
},
"require-dev": {
"phpunit/phpunit": "9.3.0",
"phpunit/phpunit": "^11.5",
"vlucas/phpdotenv": "^5.6"
},
"autoload": {
Expand Down
Loading
Loading