Skip to content

Commit

Permalink
feat: use shared structures for webhooks and event
Browse files Browse the repository at this point in the history
BREAKING CHANGE: change models for the most smart signals
  • Loading branch information
ilfa committed Mar 15, 2024
1 parent 62dcfc5 commit c15ae21
Show file tree
Hide file tree
Showing 69 changed files with 285 additions and 1,569 deletions.
30 changes: 10 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -191,6 +191,7 @@ Class | Method | HTTP request | Description
- [BotdDetectionResult](docs/BotdDetectionResult.md)
- [BotdResult](docs/BotdResult.md)
- [BrowserDetails](docs/BrowserDetails.md)
- [ClonedAppResult](docs/ClonedAppResult.md)
- [Confidence](docs/Confidence.md)
- [DataCenter](docs/DataCenter.md)
- [ErrorEvent403Response](docs/ErrorEvent403Response.md)
Expand All @@ -199,71 +200,60 @@ Class | Method | HTTP request | Description
- [ErrorEvent404ResponseError](docs/ErrorEvent404ResponseError.md)
- [ErrorVisits403](docs/ErrorVisits403.md)
- [EventResponse](docs/EventResponse.md)
- [FactoryResetResult](docs/FactoryResetResult.md)
- [FridaResult](docs/FridaResult.md)
- [HighActivityResult](docs/HighActivityResult.md)
- [IPLocation](docs/IPLocation.md)
- [IPLocationCity](docs/IPLocationCity.md)
- [IdentificationError](docs/IdentificationError.md)
- [IncognitoResult](docs/IncognitoResult.md)
- [IpBlockListResult](docs/IpBlockListResult.md)
- [IpBlockListResultDetails](docs/IpBlockListResultDetails.md)
- [IpInfoResult](docs/IpInfoResult.md)
- [IpInfoResultV4](docs/IpInfoResultV4.md)
- [IpInfoResultV6](docs/IpInfoResultV6.md)
- [JailbrokenResult](docs/JailbrokenResult.md)
- [Location](docs/Location.md)
- [LocationSpoofingResult](docs/LocationSpoofingResult.md)
- [ManyRequestsResponse](docs/ManyRequestsResponse.md)
- [PrivacySettingsResult](docs/PrivacySettingsResult.md)
- [ProductError](docs/ProductError.md)
- [ProductsResponse](docs/ProductsResponse.md)
- [ProductsResponseBotd](docs/ProductsResponseBotd.md)
- [ProductsResponseIdentification](docs/ProductsResponseIdentification.md)
- [ProductsResponseIdentificationData](docs/ProductsResponseIdentificationData.md)
- [ProxyResult](docs/ProxyResult.md)
- [RawDeviceAttributesResult](docs/RawDeviceAttributesResult.md)
- [Response](docs/Response.md)
- [ResponseVisits](docs/ResponseVisits.md)
- [RootAppsResult](docs/RootAppsResult.md)
- [SeenAt](docs/SeenAt.md)
- [SignalResponseClonedApp](docs/SignalResponseClonedApp.md)
- [SignalResponseClonedAppData](docs/SignalResponseClonedAppData.md)
- [SignalResponseEmulator](docs/SignalResponseEmulator.md)
- [SignalResponseEmulatorData](docs/SignalResponseEmulatorData.md)
- [SignalResponseFactoryReset](docs/SignalResponseFactoryReset.md)
- [SignalResponseFactoryResetData](docs/SignalResponseFactoryResetData.md)
- [SignalResponseFrida](docs/SignalResponseFrida.md)
- [SignalResponseFridaData](docs/SignalResponseFridaData.md)
- [SignalResponseHighActivity](docs/SignalResponseHighActivity.md)
- [SignalResponseIncognito](docs/SignalResponseIncognito.md)
- [SignalResponseIncognitoData](docs/SignalResponseIncognitoData.md)
- [SignalResponseIpBlocklist](docs/SignalResponseIpBlocklist.md)
- [SignalResponseIpInfo](docs/SignalResponseIpInfo.md)
- [SignalResponseJailbroken](docs/SignalResponseJailbroken.md)
- [SignalResponseJailbrokenData](docs/SignalResponseJailbrokenData.md)
- [SignalResponseLocationSpoofing](docs/SignalResponseLocationSpoofing.md)
- [SignalResponsePrivacySettings](docs/SignalResponsePrivacySettings.md)
- [SignalResponsePrivacySettingsData](docs/SignalResponsePrivacySettingsData.md)
- [SignalResponseProxy](docs/SignalResponseProxy.md)
- [SignalResponseProxyData](docs/SignalResponseProxyData.md)
- [SignalResponseRawDeviceAttributes](docs/SignalResponseRawDeviceAttributes.md)
- [SignalResponseRootApps](docs/SignalResponseRootApps.md)
- [SignalResponseRootAppsData](docs/SignalResponseRootAppsData.md)
- [SignalResponseTampering](docs/SignalResponseTampering.md)
- [SignalResponseTor](docs/SignalResponseTor.md)
- [SignalResponseTorData](docs/SignalResponseTorData.md)
- [SignalResponseVirtualMachine](docs/SignalResponseVirtualMachine.md)
- [SignalResponseVirtualMachineData](docs/SignalResponseVirtualMachineData.md)
- [SignalResponseVpn](docs/SignalResponseVpn.md)
- [Subdivision](docs/Subdivision.md)
- [TamperingResult](docs/TamperingResult.md)
- [TorResult](docs/TorResult.md)
- [VirtualMachineResult](docs/VirtualMachineResult.md)
- [Visit](docs/Visit.md)
- [VpnResult](docs/VpnResult.md)
- [VpnResultMethods](docs/VpnResultMethods.md)
- [WebhookSignalResponseClonedApp](docs/WebhookSignalResponseClonedApp.md)
- [WebhookSignalResponseEmulator](docs/WebhookSignalResponseEmulator.md)
- [WebhookSignalResponseFactoryReset](docs/WebhookSignalResponseFactoryReset.md)
- [WebhookSignalResponseFrida](docs/WebhookSignalResponseFrida.md)
- [WebhookSignalResponseJailbroken](docs/WebhookSignalResponseJailbroken.md)
- [WebhookSignalResponsePrivacySettings](docs/WebhookSignalResponsePrivacySettings.md)
- [WebhookSignalResponseProxy](docs/WebhookSignalResponseProxy.md)
- [WebhookSignalResponseRootApps](docs/WebhookSignalResponseRootApps.md)
- [WebhookSignalResponseTor](docs/WebhookSignalResponseTor.md)
- [WebhookSignalResponseVirtualMachine](docs/WebhookSignalResponseVirtualMachine.md)
- [WebhookVisit](docs/WebhookVisit.md)

## Documentation For Authorization
Expand Down
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# SignalResponseClonedAppData
# ClonedAppResult

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**result** | **bool** | Android specific cloned application detection. There are 2 values: • `true` - Presence of app cloners work detected (e.g. fully cloned application found or launch of it inside of a not main working profile detected). • `false` - No signs of cloned application detected or the client is not Android. | [optional]
**result** | **bool** | Android specific cloned application detection. There are 2 values: • `true` - Presence of app cloners work detected (e.g. fully cloned application found or launch of it inside of a not main working profile detected). • `false` - No signs of cloned application detected or the client is not Android. |

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

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

## 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 or the client is not Android. | [optional]
**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 or the client is not Android. |

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

Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# WebhookSignalResponseFactoryReset
# FactoryResetResult

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**time** | **datetime** | Time in UTC for the Android client when recent factory reset was done. If there is no sign of factory reset or the client isn't Android, the field will be epoch time. | [optional]
**timestamp** | **int** | Same value as it's in the `time` field but represented in timestamp format. | [optional]
**time** | **datetime** | Time in UTC when the most recent factory reset of the Android or iOS device was done. If there is no sign of factory reset or the client is not a mobile device, the field will contain the epoch time (1 January 1970) in UTC. |
**timestamp** | **int** | Same value as it's in the `time` field but represented in timestamp format. |

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

4 changes: 2 additions & 2 deletions docs/SignalResponseFridaData.md → docs/FridaResult.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# SignalResponseFridaData
# FridaResult

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**result** | **bool** | iOS specific [Frida](https://frida.re/docs/ios/) detection. There are 2 values: • `true` - Frida detected • `false` - No signs of Frida or the client is not iOS. | [optional]
**result** | **bool** | [Frida](https://frida.re/docs/) detection for Android and iOS devices. There are 2 values: • `true` - Frida detected • `false` - No signs of Frida or the client is not a mobile device. |

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

Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# SignalResponseIncognitoData
# IncognitoResult

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

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

Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# SignalResponseJailbrokenData
# JailbrokenResult

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**result** | **bool** | iOS specific jailbreak detection. There are 2 values: • `true` - Jailbreak detected • `false` - No signs of jailbreak or the client is not iOS. | [optional]
**result** | **bool** | iOS specific jailbreak detection. There are 2 values: • `true` - Jailbreak detected • `false` - No signs of jailbreak or the client is not iOS. |

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

Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# SignalResponsePrivacySettingsData
# PrivacySettingsResult

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**result** | **bool** | `true` if the request is from a privacy aware browser (e.g. Tor) or from a browser in which fingerprinting is blocked. Otherwise `false`. | [optional]
**result** | **bool** | `true` if the request is from a privacy aware browser (e.g. Tor) or from a browser in which fingerprinting is blocked. Otherwise `false`. |

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

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

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

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

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

## 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 or the client is not Android. | [optional]
**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 or the client isn't Android. |

[[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/SignalResponseClonedApp.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**data** | [**SignalResponseClonedAppData**](SignalResponseClonedAppData.md) | | [optional]
**data** | [**ClonedAppResult**](ClonedAppResult.md) | | [optional]
**error** | [**ProductError**](ProductError.md) | | [optional]

[[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
2 changes: 1 addition & 1 deletion docs/SignalResponseEmulator.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**data** | [**SignalResponseEmulatorData**](SignalResponseEmulatorData.md) | | [optional]
**data** | [**EmulatorResult**](EmulatorResult.md) | | [optional]
**error** | [**ProductError**](ProductError.md) | | [optional]

[[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
2 changes: 1 addition & 1 deletion docs/SignalResponseFactoryReset.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**data** | [**SignalResponseFactoryResetData**](SignalResponseFactoryResetData.md) | | [optional]
**data** | [**FactoryResetResult**](FactoryResetResult.md) | | [optional]
**error** | [**ProductError**](ProductError.md) | | [optional]

[[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: 0 additions & 10 deletions docs/SignalResponseFactoryResetData.md

This file was deleted.

2 changes: 1 addition & 1 deletion docs/SignalResponseFrida.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**data** | [**SignalResponseFridaData**](SignalResponseFridaData.md) | | [optional]
**data** | [**FridaResult**](FridaResult.md) | | [optional]
**error** | [**ProductError**](ProductError.md) | | [optional]

[[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
2 changes: 1 addition & 1 deletion docs/SignalResponseIncognito.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**data** | [**SignalResponseIncognitoData**](SignalResponseIncognitoData.md) | | [optional]
**data** | [**IncognitoResult**](IncognitoResult.md) | | [optional]
**error** | [**ProductError**](ProductError.md) | | [optional]

[[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
2 changes: 1 addition & 1 deletion docs/SignalResponseJailbroken.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**data** | [**SignalResponseJailbrokenData**](SignalResponseJailbrokenData.md) | | [optional]
**data** | [**JailbrokenResult**](JailbrokenResult.md) | | [optional]
**error** | [**ProductError**](ProductError.md) | | [optional]

[[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
2 changes: 1 addition & 1 deletion docs/SignalResponsePrivacySettings.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**data** | [**SignalResponsePrivacySettingsData**](SignalResponsePrivacySettingsData.md) | | [optional]
**data** | [**PrivacySettingsResult**](PrivacySettingsResult.md) | | [optional]
**error** | [**ProductError**](ProductError.md) | | [optional]

[[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
2 changes: 1 addition & 1 deletion docs/SignalResponseProxy.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**data** | [**SignalResponseProxyData**](SignalResponseProxyData.md) | | [optional]
**data** | [**ProxyResult**](ProxyResult.md) | | [optional]
**error** | [**ProductError**](ProductError.md) | | [optional]

[[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
2 changes: 1 addition & 1 deletion docs/SignalResponseRootApps.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**data** | [**SignalResponseRootAppsData**](SignalResponseRootAppsData.md) | | [optional]
**data** | [**RootAppsResult**](RootAppsResult.md) | | [optional]
**error** | [**ProductError**](ProductError.md) | | [optional]

[[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
2 changes: 1 addition & 1 deletion docs/SignalResponseTor.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**data** | [**SignalResponseTorData**](SignalResponseTorData.md) | | [optional]
**data** | [**TorResult**](TorResult.md) | | [optional]
**error** | [**ProductError**](ProductError.md) | | [optional]

[[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
2 changes: 1 addition & 1 deletion docs/SignalResponseVirtualMachine.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**data** | [**SignalResponseVirtualMachineData**](SignalResponseVirtualMachineData.md) | | [optional]
**data** | [**VirtualMachineResult**](VirtualMachineResult.md) | | [optional]
**error** | [**ProductError**](ProductError.md) | | [optional]

[[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
4 changes: 2 additions & 2 deletions docs/SignalResponseTorData.md → docs/TorResult.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# SignalResponseTorData
# TorResult

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

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

Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# SignalResponseVirtualMachineData
# VirtualMachineResult

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**result** | **bool** | `true` if the request came from a browser running inside a virtual machine (e.g. VMWare), `false` otherwise. | [optional]
**result** | **bool** | `true` if the request came from a browser running inside a virtual machine (e.g. VMWare), `false` otherwise. |

[[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: 0 additions & 9 deletions docs/WebhookSignalResponseClonedApp.md

This file was deleted.

Loading

0 comments on commit c15ae21

Please sign in to comment.