Skip to content

Commit

Permalink
feat: update schema and add more signals
Browse files Browse the repository at this point in the history
  • Loading branch information
ilfa committed May 10, 2023
1 parent 2d071a9 commit 8a7b0c3
Show file tree
Hide file tree
Showing 80 changed files with 1,411 additions and 71 deletions.
32 changes: 31 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,6 @@ Class | Method | HTTP request | Description
## Documentation For Models

- [BotdDetectionResult](docs/BotdDetectionResult.md)
- [BotdError](docs/BotdError.md)
- [BotdResult](docs/BotdResult.md)
- [BrowserDetails](docs/BrowserDetails.md)
- [Confidence](docs/Confidence.md)
Expand All @@ -139,19 +138,50 @@ Class | Method | HTTP request | Description
- [ErrorVisits403](docs/ErrorVisits403.md)
- [EventResponse](docs/EventResponse.md)
- [IdentificationError](docs/IdentificationError.md)
- [IpBlockListResult](docs/IpBlockListResult.md)
- [IpBlockListResultDetails](docs/IpBlockListResultDetails.md)
- [IpInfoResult](docs/IpInfoResult.md)
- [IpInfoResultV4](docs/IpInfoResultV4.md)
- [IpInfoResultV6](docs/IpInfoResultV6.md)
- [IpLocation](docs/IpLocation.md)
- [IpLocationCity](docs/IpLocationCity.md)
- [Location](docs/Location.md)
- [ManyRequestsResponse](docs/ManyRequestsResponse.md)
- [ProductError](docs/ProductError.md)
- [ProductsResponse](docs/ProductsResponse.md)
- [ProductsResponseBotd](docs/ProductsResponseBotd.md)
- [ProductsResponseIdentification](docs/ProductsResponseIdentification.md)
- [ProductsResponseIdentificationData](docs/ProductsResponseIdentificationData.md)
- [Response](docs/Response.md)
- [ResponseVisits](docs/ResponseVisits.md)
- [SeenAt](docs/SeenAt.md)
- [SignalResponseEmulator](docs/SignalResponseEmulator.md)
- [SignalResponseEmulator1](docs/SignalResponseEmulator1.md)
- [SignalResponseEmulatorData](docs/SignalResponseEmulatorData.md)
- [SignalResponseIncognito](docs/SignalResponseIncognito.md)
- [SignalResponseIncognitoData](docs/SignalResponseIncognitoData.md)
- [SignalResponseIpBlocklist](docs/SignalResponseIpBlocklist.md)
- [SignalResponseIpBlocklist1](docs/SignalResponseIpBlocklist1.md)
- [SignalResponseIpInfo](docs/SignalResponseIpInfo.md)
- [SignalResponseIpInfo1](docs/SignalResponseIpInfo1.md)
- [SignalResponseProxy](docs/SignalResponseProxy.md)
- [SignalResponseProxy1](docs/SignalResponseProxy1.md)
- [SignalResponseProxyData](docs/SignalResponseProxyData.md)
- [SignalResponseRootApps](docs/SignalResponseRootApps.md)
- [SignalResponseRootApps1](docs/SignalResponseRootApps1.md)
- [SignalResponseRootAppsData](docs/SignalResponseRootAppsData.md)
- [SignalResponseTampering](docs/SignalResponseTampering.md)
- [SignalResponseTampering1](docs/SignalResponseTampering1.md)
- [SignalResponseTor](docs/SignalResponseTor.md)
- [SignalResponseTor1](docs/SignalResponseTor1.md)
- [SignalResponseTorData](docs/SignalResponseTorData.md)
- [SignalResponseVpn](docs/SignalResponseVpn.md)
- [SignalResponseVpn1](docs/SignalResponseVpn1.md)
- [Subdivision](docs/Subdivision.md)
- [TamperingResult](docs/TamperingResult.md)
- [Visit](docs/Visit.md)
- [VpnResult](docs/VpnResult.md)
- [VpnResultMethods](docs/VpnResultMethods.md)
- [WebhookVisit](docs/WebhookVisit.md)

## Documentation For Authorization
Expand Down
1 change: 1 addition & 0 deletions docs/BotdDetectionResult.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Result** | **string** | 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 | [default to null]
**Type_** | **string** | | [optional] [default to null]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

2 changes: 2 additions & 0 deletions docs/BotdResult.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ Name | Type | Description | Notes
**Ip** | **string** | IP address of the requesting browser or bot. | [default to null]
**Time** | [**time.Time**](time.Time.md) | Time in UTC when the request from the JS agent was made. We recommend to treat requests that are older than 2 minutes as malicious. Otherwise, request replay attacks are possible | [default to null]
**Url** | **string** | Page URL from which identification request was sent. | [default to null]
**UserAgent** | **string** | | [optional] [default to null]
**RequestId** | **string** | | [optional] [default to null]
**Bot** | [***BotdDetectionResult**](BotdDetectionResult.md) | | [default to null]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
Expand Down
10 changes: 10 additions & 0 deletions docs/IpBlockListResult.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# IpBlockListResult

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Result** | **bool** | `true` if request IP address is part of any database that we use to search for known malicious actors, `false` otherwise. | [optional] [default to null]
**Details** | [***IpBlockListResultDetails**](IpBlockListResult_details.md) | | [optional] [default to null]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

10 changes: 10 additions & 0 deletions docs/IpBlockListResultDetails.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# IpBlockListResultDetails

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**EmailSpam** | **bool** | IP address was part of a known email spam attack (SMTP). | [optional] [default to null]
**AttackSource** | **bool** | IP address was part of a known network attack (SSH/HTTPS). | [optional] [default to null]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

10 changes: 10 additions & 0 deletions docs/IpInfoResult.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# IpInfoResult

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**V4** | [***IpInfoResultV4**](IpInfoResult_v4.md) | | [optional] [default to null]
**V6** | [***IpInfoResultV6**](IpInfoResult_v6.md) | | [optional] [default to null]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

10 changes: 10 additions & 0 deletions docs/IpInfoResultV4.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# IpInfoResultV4

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Address** | **string** | | [optional] [default to null]
**Geolocation** | [***IpLocation**](IPLocation.md) | | [optional] [default to null]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

10 changes: 10 additions & 0 deletions docs/IpInfoResultV6.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# IpInfoResultV6

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Address** | **string** | | [optional] [default to null]
**Geolocation** | [***IpLocation**](IPLocation.md) | | [optional] [default to null]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

2 changes: 1 addition & 1 deletion docs/BotdError.md → docs/ProductError.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# BotdError
# ProductError

## Properties
Name | Type | Description | Notes
Expand Down
9 changes: 9 additions & 0 deletions docs/ProductsResponse.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,15 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Identification** | [***ProductsResponseIdentification**](ProductsResponseIdentification.md) | | [optional] [default to null]
**Botd** | [***ProductsResponseBotd**](ProductsResponseBotd.md) | | [optional] [default to null]
**IpInfo** | [***SignalResponseIpInfo1**](SignalResponseIpInfo_1.md) | | [optional] [default to null]
**Incognito** | [***SignalResponseIncognito**](SignalResponseIncognito.md) | | [optional] [default to null]
**RootApps** | [***SignalResponseRootApps1**](SignalResponseRootApps_1.md) | | [optional] [default to null]
**Emulator** | [***SignalResponseEmulator1**](SignalResponseEmulator_1.md) | | [optional] [default to null]
**IpBlocklist** | [***SignalResponseIpBlocklist1**](SignalResponseIpBlocklist_1.md) | | [optional] [default to null]
**Tor** | [***SignalResponseTor1**](SignalResponseTor_1.md) | | [optional] [default to null]
**Vpn** | [***SignalResponseVpn1**](SignalResponseVpn_1.md) | | [optional] [default to null]
**Proxy** | [***SignalResponseProxy1**](SignalResponseProxy_1.md) | | [optional] [default to null]
**Tampering** | [***SignalResponseTampering1**](SignalResponseTampering_1.md) | | [optional] [default to null]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

2 changes: 1 addition & 1 deletion docs/ProductsResponseBotd.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Data** | [***BotdResult**](BotdResult.md) | | [optional] [default to null]
**Error_** | [***BotdError**](BotdError.md) | | [optional] [default to null]
**Error_** | [***ProductError**](ProductError.md) | | [optional] [default to null]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

9 changes: 9 additions & 0 deletions docs/SignalResponseEmulator.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# SignalResponseEmulator

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Data** | [***SignalResponseEmulatorData**](SignalResponseEmulator_data.md) | | [optional] [default to null]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

10 changes: 10 additions & 0 deletions docs/SignalResponseEmulator1.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# SignalResponseEmulator1

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Data** | [***SignalResponseEmulatorData**](SignalResponseEmulator_data.md) | | [optional] [default to null]
**Error_** | [***ProductError**](ProductError.md) | | [optional] [default to null]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

9 changes: 9 additions & 0 deletions docs/SignalResponseEmulatorData.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# SignalResponseEmulatorData

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Result** | **bool** | Android specific emulator detection. There are 2 values: • `true` - Emulated environment detected (e.g. launch inside of AVD) • `false` - No signs of emulated environment detected Available only for events from Android client. The field will be empty for a browser/iOS event. | [optional] [default to null]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

10 changes: 10 additions & 0 deletions docs/SignalResponseIncognito.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# SignalResponseIncognito

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Data** | [***SignalResponseIncognitoData**](SignalResponseIncognito_data.md) | | [optional] [default to null]
**Error_** | [***ProductError**](ProductError.md) | | [optional] [default to null]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

9 changes: 9 additions & 0 deletions docs/SignalResponseIncognitoData.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# SignalResponseIncognitoData

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Result** | **bool** | `true` if we detected incognito mode used in the browser, `false` otherwise. | [optional] [default to null]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

9 changes: 9 additions & 0 deletions docs/SignalResponseIpBlocklist.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# SignalResponseIpBlocklist

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Data** | [***IpBlockListResult**](IpBlockListResult.md) | | [optional] [default to null]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

10 changes: 10 additions & 0 deletions docs/SignalResponseIpBlocklist1.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# SignalResponseIpBlocklist1

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Data** | [***IpBlockListResult**](IpBlockListResult.md) | | [optional] [default to null]
**Error_** | [***ProductError**](ProductError.md) | | [optional] [default to null]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

9 changes: 9 additions & 0 deletions docs/SignalResponseIpInfo.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# SignalResponseIpInfo

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Data** | [***IpInfoResult**](IpInfoResult.md) | | [optional] [default to null]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

10 changes: 10 additions & 0 deletions docs/SignalResponseIpInfo1.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# SignalResponseIpInfo1

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Data** | [***IpInfoResult**](IpInfoResult.md) | | [optional] [default to null]
**Error_** | [***ProductError**](ProductError.md) | | [optional] [default to null]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

9 changes: 9 additions & 0 deletions docs/SignalResponseProxy.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# SignalResponseProxy

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Data** | [***SignalResponseProxyData**](SignalResponseProxy_data.md) | | [optional] [default to null]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

10 changes: 10 additions & 0 deletions docs/SignalResponseProxy1.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# SignalResponseProxy1

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Data** | [***SignalResponseProxyData**](SignalResponseProxy_data.md) | | [optional] [default to null]
**Error_** | [***ProductError**](ProductError.md) | | [optional] [default to null]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

9 changes: 9 additions & 0 deletions docs/SignalResponseProxyData.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# SignalResponseProxyData

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Result** | **bool** | `true` if the request IP address is used by a public proxy provider, `false` otherwise. | [optional] [default to null]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

9 changes: 9 additions & 0 deletions docs/SignalResponseRootApps.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# SignalResponseRootApps

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Data** | [***SignalResponseRootAppsData**](SignalResponseRootApps_data.md) | | [optional] [default to null]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

10 changes: 10 additions & 0 deletions docs/SignalResponseRootApps1.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# SignalResponseRootApps1

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Data** | [***SignalResponseRootAppsData**](SignalResponseRootApps_data.md) | | [optional] [default to null]
**Error_** | [***ProductError**](ProductError.md) | | [optional] [default to null]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

9 changes: 9 additions & 0 deletions docs/SignalResponseRootAppsData.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# SignalResponseRootAppsData

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Result** | **bool** | Android specific root management apps detection. There are 2 values: • `true` - Root Management Apps detected (e.g. Magisk) • `false` - No Root Management Apps detected Available only for events from Android client. The field will be empty for a browser/iOS event. | [optional] [default to null]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

9 changes: 9 additions & 0 deletions docs/SignalResponseTampering.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# SignalResponseTampering

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Data** | [***TamperingResult**](TamperingResult.md) | | [optional] [default to null]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

10 changes: 10 additions & 0 deletions docs/SignalResponseTampering1.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# SignalResponseTampering1

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Data** | [***TamperingResult**](TamperingResult.md) | | [optional] [default to null]
**Error_** | [***ProductError**](ProductError.md) | | [optional] [default to null]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

9 changes: 9 additions & 0 deletions docs/SignalResponseTor.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# SignalResponseTor

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Data** | [***SignalResponseTorData**](SignalResponseTor_data.md) | | [optional] [default to null]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

10 changes: 10 additions & 0 deletions docs/SignalResponseTor1.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# SignalResponseTor1

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Data** | [***SignalResponseTorData**](SignalResponseTor_data.md) | | [optional] [default to null]
**Error_** | [***ProductError**](ProductError.md) | | [optional] [default to null]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

9 changes: 9 additions & 0 deletions docs/SignalResponseTorData.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# SignalResponseTorData

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Result** | **bool** | `true` if the request IP address is a known tor exit node, `false` otherwise. | [optional] [default to null]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

9 changes: 9 additions & 0 deletions docs/SignalResponseVpn.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# SignalResponseVpn

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Data** | [***VpnResult**](VpnResult.md) | | [optional] [default to null]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

10 changes: 10 additions & 0 deletions docs/SignalResponseVpn1.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# SignalResponseVpn1

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Data** | [***VpnResult**](VpnResult.md) | | [optional] [default to null]
**Error_** | [***ProductError**](ProductError.md) | | [optional] [default to null]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

Loading

0 comments on commit 8a7b0c3

Please sign in to comment.