Skip to content
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

OpenAPI schema sync #77

Merged
merged 2 commits into from
Oct 10, 2024
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/orange-taxis-fetch.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'fingerprint-pro-server-api-java-sdk': minor
---

**visitors**: Add the confidence field to the VPN Detection Smart Signal
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-java-sdk": "6.1.0"
},
"changesets": []
}
1 change: 1 addition & 0 deletions .schema-version
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
v1.2.0
1 change: 0 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -369,7 +369,6 @@ Class | Method | HTTP request | Description
- [VelocityIntervals](docs/VelocityIntervals.md)
- [VelocityResult](docs/VelocityResult.md)
- [VirtualMachineResult](docs/VirtualMachineResult.md)
- [Visit](docs/Visit.md)
- [VpnResult](docs/VpnResult.md)
- [VpnResultMethods](docs/VpnResultMethods.md)
- [WebhookVisit](docs/WebhookVisit.md)
Expand Down
28 changes: 22 additions & 6 deletions docs/FingerprintApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,12 +19,28 @@ All URIs are relative to *https://api.fpjs.io*
Delete data by visitor ID

Request deleting all data associated with the specified visitor ID. This API is useful for compliance with privacy regulations.
All delete requests are queued:

* Recent data (10 days or newer) belonging to the specified visitor will be deleted within 24 hours.
* Data from older (11 days or more) identification events will be deleted after 90 days.

If you are interested in using this API, please [contact our support team](https://fingerprint.com/support/) to enable it for you. Otherwise, you will receive a 403.
### Which data is deleted?
- Browser (or device) properties
- Identification requests made from this browser (or device)

#### Browser (or device) properties
- Represents the data that Fingerprint collected from this specific browser (or device) and everything inferred and derived from it.
- Upon request to delete, this data is deleted asynchronously (typically within a few minutes) and it will no longer be used to identify this browser (or device) for your [Fingerprint Application](https://dev.fingerprint.com/docs/glossary#fingerprint-application).

#### Identification requests made from this browser (or device)
- Fingerprint stores the identification requests made from a browser (or device) for up to 30 (or 90) days depending on your plan. To learn more, see [Data Retention](https://dev.fingerprint.com/docs/regions#data-retention).
- Upon request to delete, the identification requests that were made by this browser
- Within the past 10 days are deleted within 24 hrs.
- Outside of 10 days are allowed to purge as per your data retention period.

### Corollary
After requesting to delete a visitor ID,
- If the same browser (or device) requests to identify, it will receive a different visitor ID.
- If you request [`/events` API](https://dev.fingerprint.com/reference/getevent) with a `request_id` that was made outside of the 10 days, you will still receive a valid response.
- If you request [`/visitors` API](https://dev.fingerprint.com/reference/getvisits) for the deleted visitor ID, the response will include identification requests that were made outside of those 10 days.

### Interested?
Please [contact our support team](https://fingerprint.com/support/) to enable it for you. Otherwise, you will receive a 403.


### Example
Expand Down
26 changes: 0 additions & 26 deletions docs/Visit.md

This file was deleted.

10 changes: 10 additions & 0 deletions docs/VpnResult.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,16 @@
|**originTimezone** | **String** | Local timezone which is used in timezoneMismatch method. | |
|**originCountry** | **String** | Country of the request (only for Android SDK version >= 2.4.0, ISO 3166 format or unknown). | [optional] |
|**methods** | [**VpnResultMethods**](VpnResultMethods.md) | | |
|**confidence** | [**ConfidenceEnum**](#ConfidenceEnum) | A confidence rating for the VPN detection result — \"low\", \"medium\", or \"high\". Depends on the combination of results returned from all VPN detection methods. | |


## Enum: ConfidenceEnum

| Name | Value |
|---- | ----- |
| LOW | "low" |
| MEDIUM | "medium" |
| HIGH | "high" |



Loading
Loading