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

Prerelease fixes #86

Merged
merged 5 commits into from
Nov 25, 2024
Merged
Show file tree
Hide file tree
Changes from 2 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 docs/BotdBotResult.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,11 @@


# BotdBotResult
Bot detection result:
* `notDetected` - the visitor is not a bot
* `good` - good bot detected, such as Google bot, Baidu Spider, AlexaBot and so on
* `bad` - bad bot detected, such as Selenium, Puppeteer, Playwright, headless browsers, and so on


## Enum

Expand Down
19 changes: 19 additions & 0 deletions docs/ErrorCode.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,25 @@


# ErrorCode
Error code:
* `RequestCannotBeParsed` - the query parameters or JSON payload contains some errors
that prevented us from parsing it (wrong type/surpassed limits).
* `TokenRequired` - `Auth-API-Key` header is missing or empty.
* `TokenNotFound` - no Fingerprint application found for specified secret key.
* `SubscriptionNotActive` - Fingerprint application is not active.
* `WrongRegion` - server and application region differ.
* `FeatureNotEnabled` - this feature (for example, Delete API) is not enabled for your application.
* `RequestNotFound` - the specified request ID was not found. It never existed, expired, or it has been deleted.
* `VisitorNotFound` - The specified visitor ID was not found. It never existed or it may have already been deleted.
* `TooManyRequests` - the limit on secret API key requests per second has been exceeded.
* `429 Too Many Requests` - the limit on secret API key requests per second has been exceeded.
* `StateNotReady` - The event specified with request id is
not ready for updates yet. Try again.
This error happens in rare cases when update API is called immediately
after receiving the request id on the client. In case you need to send
information right away, we recommend using the JS agent API instead.
* `Failed` - internal server error.


## Enum

Expand Down
1 change: 1 addition & 0 deletions docs/VPNConfidence.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@


# VPNConfidence
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

Expand Down
17 changes: 16 additions & 1 deletion docs/Velocity.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,22 @@

# Velocity

Sums key data points for a specific `visitorId`, `ipAddress` and `linkedId` at three distinct time intervals: 5 minutes, 1 hour, and 24 hours as follows: - Number of distinct IP addresses associated to the visitor ID. - Number of distinct linked IDs associated with the visitor ID. - Number of distinct countries associated with the visitor ID. - Number of identification events associated with the visitor ID. - Number of identification events associated with the detected IP address. - Number of distinct IP addresses associated with the provided linked ID. - Number of distinct visitor IDs associated with the provided linked ID. The `24h` interval of `distinctIp`, `distinctLinkedId`, `distinctCountry`, `distinctIpByLinkedId` and `distinctVisitorIdByLinkedId` will be omitted if the number of `events` for the visitor ID in the last 24 hours (`events.intervals.['24h']`) is higher than 20.000.
Sums key data points for a specific `visitorId`, `ipAddress` and `linkedId` at three distinct time
intervals: 5 minutes, 1 hour, and 24 hours as follows:

- Number of distinct IP addresses associated to the visitor ID.
- Number of distinct linked IDs associated with the visitor ID.
- Number of distinct countries associated with the visitor ID.
- Number of identification events associated with the visitor ID.
- Number of identification events associated with the detected IP address.
- Number of distinct IP addresses associated with the provided linked ID.
- Number of distinct visitor IDs associated with the provided linked ID.

The `24h` interval of `distinctIp`, `distinctLinkedId`, `distinctCountry`,
`distinctIpByLinkedId` and `distinctVisitorIdByLinkedId` will be omitted
if the number of `events` for the visitor ID in the last 24
hours (`events.intervals.['24h']`) is higher than 20.000.


## Properties

Expand Down
3 changes: 2 additions & 1 deletion docs/VelocityIntervals.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@

# VelocityIntervals

Is absent if the velocity data could not be generated for the visitor ID.
Is absent if the velocity data could not be generated for the visitor ID.


## Properties

Expand Down
17 changes: 16 additions & 1 deletion docs/WebhookVelocity.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,22 @@

# WebhookVelocity

Sums key data points for a specific `visitorId`, `ipAddress` and `linkedId` at three distinct time intervals: 5 minutes, 1 hour, and 24 hours as follows: - Number of distinct IP addresses associated to the visitor ID. - Number of distinct linked IDs associated with the visitor ID. - Number of distinct countries associated with the visitor ID. - Number of identification events associated with the visitor ID. - Number of identification events associated with the detected IP address. - Number of distinct IP addresses associated with the provided linked ID. - Number of distinct visitor IDs associated with the provided linked ID. The `24h` interval of `distinctIp`, `distinctLinkedId`, `distinctCountry`, `distinctIpByLinkedId` and `distinctVisitorIdByLinkedId` will be omitted if the number of `events` for the visitor ID in the last 24 hours (`events.intervals.['24h']`) is higher than 20.000.
Sums key data points for a specific `visitorId`, `ipAddress` and `linkedId` at three distinct time
intervals: 5 minutes, 1 hour, and 24 hours as follows:

- Number of distinct IP addresses associated to the visitor ID.
- Number of distinct linked IDs associated with the visitor ID.
- Number of distinct countries associated with the visitor ID.
- Number of identification events associated with the visitor ID.
- Number of identification events associated with the detected IP address.
- Number of distinct IP addresses associated with the provided linked ID.
- Number of distinct visitor IDs associated with the provided linked ID.

The `24h` interval of `distinctIp`, `distinctLinkedId`, `distinctCountry`,
`distinctIpByLinkedId` and `distinctVisitorIdByLinkedId` will be omitted
if the number of `events` for the visitor ID in the last 24
hours (`events.intervals.['24h']`) is higher than 20.000.


## Properties

Expand Down
10 changes: 10 additions & 0 deletions template/enum_outer_doc.mustache
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# {{classname}}
{{#unescapedDescription}}
{{{.}}}

{{/unescapedDescription}}
## Enum

{{#allowableValues}}{{#enumVars}}
* `{{name}}` (value: `{{{value}}}`)
{{/enumVars}}{{/allowableValues}}
2 changes: 1 addition & 1 deletion template/pojo_doc.mustache
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# {{classname}}

{{#description}}
{{{description}}}
{{{unescapedDescription}}}
{{/description}}

## Properties
Expand Down
Loading