Skip to content

Commit

Permalink
Merge pull request #43 from fingerprintjs/feat/update-schema-INTER-431
Browse files Browse the repository at this point in the history
Add `highActivity` and `locationSpoofing` signals, support `originTimezone` for `vpn` signal
  • Loading branch information
ilfa authored Nov 27, 2023
2 parents ce0cf7f + 36793fe commit 5bfd670
Show file tree
Hide file tree
Showing 24 changed files with 811 additions and 113 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -164,6 +164,7 @@ Class | Method | HTTP request | Description
- [ErrorEvent404ResponseError](docs/ErrorEvent404ResponseError.md)
- [ErrorVisits403](docs/ErrorVisits403.md)
- [EventResponse](docs/EventResponse.md)
- [HighActivityResult](docs/HighActivityResult.md)
- [IPLocation](docs/IPLocation.md)
- [IPLocationCity](docs/IPLocationCity.md)
- [IdentificationError](docs/IdentificationError.md)
Expand All @@ -173,6 +174,7 @@ Class | Method | HTTP request | Description
- [IpInfoResultV4](docs/IpInfoResultV4.md)
- [IpInfoResultV6](docs/IpInfoResultV6.md)
- [Location](docs/Location.md)
- [LocationSpoofingResult](docs/LocationSpoofingResult.md)
- [ManyRequestsResponse](docs/ManyRequestsResponse.md)
- [ProductError](docs/ProductError.md)
- [ProductsResponse](docs/ProductsResponse.md)
Expand All @@ -191,12 +193,14 @@ Class | Method | HTTP request | Description
- [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)
Expand Down
10 changes: 10 additions & 0 deletions docs/HighActivityResult.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# HighActivityResult

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**result** | **bool** | Flag indicating whether the request came from a high activity visitor. | [optional]
**daily_requests** | **float** | Number of requests from the same visitor in the previous day. | [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)

2 changes: 1 addition & 1 deletion docs/IPLocation.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**accuracy_radius** | **int** | | [optional]
**accuracy_radius** | **int** | The IP address is likely to be within this radius (in km) of the specified location. | [optional]
**latitude** | **float** | | [optional]
**longitude** | **float** | | [optional]
**postal_code** | **str** | | [optional]
Expand Down
9 changes: 9 additions & 0 deletions docs/LocationSpoofingResult.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# LocationSpoofingResult

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**result** | **bool** | Flag indicating whether the request came from a device with location spoofing enabled. | [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)

2 changes: 2 additions & 0 deletions docs/ProductsResponse.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,8 @@ Name | Type | Description | Notes
**vpn** | [**SignalResponseVpn**](SignalResponseVpn.md) | | [optional]
**proxy** | [**SignalResponseProxy**](SignalResponseProxy.md) | | [optional]
**tampering** | [**SignalResponseTampering**](SignalResponseTampering.md) | | [optional]
**high_activity** | [**SignalResponseHighActivity**](SignalResponseHighActivity.md) | | [optional]
**location_spoofing** | [**SignalResponseLocationSpoofing**](SignalResponseLocationSpoofing.md) | | [optional]
**raw_device_attributes** | [**SignalResponseRawDeviceAttributes**](SignalResponseRawDeviceAttributes.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/ProductsResponseIdentificationData.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Name | Type | Description | Notes
**visitor_found** | **bool** | Attribute represents if a visitor had been identified before. |
**first_seen_at** | [**SeenAt**](SeenAt.md) | |
**last_seen_at** | [**SeenAt**](SeenAt.md) | |
**visitor_id** | **str** | String of 20 characters that uniquely identifies the visitor's browser. **Pro Plus:** If a bot is detected (`products.botd.bot.result != \"notDetected\"`), the `visitorId` value contains a placeholder string `BotDetected000000000`. |
**visitor_id** | **str** | String of 20 characters that uniquely identifies the visitor's browser. |

[[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/SignalResponseHighActivity.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# SignalResponseHighActivity

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**data** | [**HighActivityResult**](HighActivityResult.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)

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

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**data** | [**LocationSpoofingResult**](LocationSpoofingResult.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)

1 change: 1 addition & 0 deletions docs/VpnResult.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**result** | **bool** | VPN or other anonymizing service has been used when sending the request. | [optional]
**origin_timezone** | **str** | Local timezone which is used in timezoneMismatch method. | [optional]
**methods** | [**VpnResultMethods**](VpnResultMethods.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: 2 additions & 0 deletions docs/WebhookVisit.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,8 @@ Name | Type | Description | Notes
**proxy** | [**WebhookSignalResponseProxy**](WebhookSignalResponseProxy.md) | | [optional]
**tampering** | [**TamperingResult**](TamperingResult.md) | | [optional]
**raw_device_attributes** | [**RawDeviceAttributesResult**](RawDeviceAttributesResult.md) | | [optional]
**high_activity** | [**HighActivityResult**](HighActivityResult.md) | | [optional]
**location_spoofing** | [**LocationSpoofingResult**](LocationSpoofingResult.md) | | [optional]
**request_id** | **str** | Unique identifier of the user's identification request. |
**browser_details** | [**BrowserDetails**](BrowserDetails.md) | |
**ip** | **str** | |
Expand Down
4 changes: 4 additions & 0 deletions fingerprint_pro_server_api_sdk/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@
from fingerprint_pro_server_api_sdk.models.error_event404_response_error import ErrorEvent404ResponseError
from fingerprint_pro_server_api_sdk.models.error_visits403 import ErrorVisits403
from fingerprint_pro_server_api_sdk.models.event_response import EventResponse
from fingerprint_pro_server_api_sdk.models.high_activity_result import HighActivityResult
from fingerprint_pro_server_api_sdk.models.ip_location import IPLocation
from fingerprint_pro_server_api_sdk.models.ip_location_city import IPLocationCity
from fingerprint_pro_server_api_sdk.models.identification_error import IdentificationError
Expand All @@ -41,6 +42,7 @@
from fingerprint_pro_server_api_sdk.models.ip_info_result_v4 import IpInfoResultV4
from fingerprint_pro_server_api_sdk.models.ip_info_result_v6 import IpInfoResultV6
from fingerprint_pro_server_api_sdk.models.location import Location
from fingerprint_pro_server_api_sdk.models.location_spoofing_result import LocationSpoofingResult
from fingerprint_pro_server_api_sdk.models.many_requests_response import ManyRequestsResponse
from fingerprint_pro_server_api_sdk.models.product_error import ProductError
from fingerprint_pro_server_api_sdk.models.products_response import ProductsResponse
Expand All @@ -59,12 +61,14 @@
from fingerprint_pro_server_api_sdk.models.signal_response_factory_reset_data import SignalResponseFactoryResetData
from fingerprint_pro_server_api_sdk.models.signal_response_frida import SignalResponseFrida
from fingerprint_pro_server_api_sdk.models.signal_response_frida_data import SignalResponseFridaData
from fingerprint_pro_server_api_sdk.models.signal_response_high_activity import SignalResponseHighActivity
from fingerprint_pro_server_api_sdk.models.signal_response_incognito import SignalResponseIncognito
from fingerprint_pro_server_api_sdk.models.signal_response_incognito_data import SignalResponseIncognitoData
from fingerprint_pro_server_api_sdk.models.signal_response_ip_blocklist import SignalResponseIpBlocklist
from fingerprint_pro_server_api_sdk.models.signal_response_ip_info import SignalResponseIpInfo
from fingerprint_pro_server_api_sdk.models.signal_response_jailbroken import SignalResponseJailbroken
from fingerprint_pro_server_api_sdk.models.signal_response_jailbroken_data import SignalResponseJailbrokenData
from fingerprint_pro_server_api_sdk.models.signal_response_location_spoofing import SignalResponseLocationSpoofing
from fingerprint_pro_server_api_sdk.models.signal_response_privacy_settings import SignalResponsePrivacySettings
from fingerprint_pro_server_api_sdk.models.signal_response_privacy_settings_data import SignalResponsePrivacySettingsData
from fingerprint_pro_server_api_sdk.models.signal_response_proxy import SignalResponseProxy
Expand Down
4 changes: 4 additions & 0 deletions fingerprint_pro_server_api_sdk/models/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@
from fingerprint_pro_server_api_sdk.models.error_event404_response_error import ErrorEvent404ResponseError
from fingerprint_pro_server_api_sdk.models.error_visits403 import ErrorVisits403
from fingerprint_pro_server_api_sdk.models.event_response import EventResponse
from fingerprint_pro_server_api_sdk.models.high_activity_result import HighActivityResult
from fingerprint_pro_server_api_sdk.models.ip_location import IPLocation
from fingerprint_pro_server_api_sdk.models.ip_location_city import IPLocationCity
from fingerprint_pro_server_api_sdk.models.identification_error import IdentificationError
Expand All @@ -35,6 +36,7 @@
from fingerprint_pro_server_api_sdk.models.ip_info_result_v4 import IpInfoResultV4
from fingerprint_pro_server_api_sdk.models.ip_info_result_v6 import IpInfoResultV6
from fingerprint_pro_server_api_sdk.models.location import Location
from fingerprint_pro_server_api_sdk.models.location_spoofing_result import LocationSpoofingResult
from fingerprint_pro_server_api_sdk.models.many_requests_response import ManyRequestsResponse
from fingerprint_pro_server_api_sdk.models.product_error import ProductError
from fingerprint_pro_server_api_sdk.models.products_response import ProductsResponse
Expand All @@ -53,12 +55,14 @@
from fingerprint_pro_server_api_sdk.models.signal_response_factory_reset_data import SignalResponseFactoryResetData
from fingerprint_pro_server_api_sdk.models.signal_response_frida import SignalResponseFrida
from fingerprint_pro_server_api_sdk.models.signal_response_frida_data import SignalResponseFridaData
from fingerprint_pro_server_api_sdk.models.signal_response_high_activity import SignalResponseHighActivity
from fingerprint_pro_server_api_sdk.models.signal_response_incognito import SignalResponseIncognito
from fingerprint_pro_server_api_sdk.models.signal_response_incognito_data import SignalResponseIncognitoData
from fingerprint_pro_server_api_sdk.models.signal_response_ip_blocklist import SignalResponseIpBlocklist
from fingerprint_pro_server_api_sdk.models.signal_response_ip_info import SignalResponseIpInfo
from fingerprint_pro_server_api_sdk.models.signal_response_jailbroken import SignalResponseJailbroken
from fingerprint_pro_server_api_sdk.models.signal_response_jailbroken_data import SignalResponseJailbrokenData
from fingerprint_pro_server_api_sdk.models.signal_response_location_spoofing import SignalResponseLocationSpoofing
from fingerprint_pro_server_api_sdk.models.signal_response_privacy_settings import SignalResponsePrivacySettings
from fingerprint_pro_server_api_sdk.models.signal_response_privacy_settings_data import SignalResponsePrivacySettingsData
from fingerprint_pro_server_api_sdk.models.signal_response_proxy import SignalResponseProxy
Expand Down
143 changes: 143 additions & 0 deletions fingerprint_pro_server_api_sdk/models/high_activity_result.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,143 @@
# coding: utf-8

"""
Fingerprint Pro Server API
Fingerprint Pro Server API allows you to get information about visitors and about individual events in a server environment. It can be used for data exports, decision-making, and data analysis scenarios. Server API is intended for server-side usage, it's not intended to be used from the client side, whether it's a browser or a mobile device. # noqa: E501
OpenAPI spec version: 3
Contact: [email protected]
Generated by: https://github.com/swagger-api/swagger-codegen.git
"""

import pprint
import re # noqa: F401

import six

class HighActivityResult(object):
"""NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
"""
"""
Attributes:
swagger_types (dict): The key is attribute name
and the value is attribute type.
attribute_map (dict): The key is attribute name
and the value is json key in definition.
"""
swagger_types = {
'result': 'bool',
'daily_requests': 'float'
}

attribute_map = {
'result': 'result',
'daily_requests': 'dailyRequests'
}

def __init__(self, result=None, daily_requests=None): # noqa: E501
"""HighActivityResult - a model defined in Swagger""" # noqa: E501
self._result = None
self._daily_requests = None
self.discriminator = None
if result is not None:
self.result = result
if daily_requests is not None:
self.daily_requests = daily_requests

@property
def result(self):
"""Gets the result of this HighActivityResult. # noqa: E501
Flag indicating whether the request came from a high activity visitor. # noqa: E501
:return: The result of this HighActivityResult. # noqa: E501
:rtype: bool
"""
return self._result

@result.setter
def result(self, result):
"""Sets the result of this HighActivityResult.
Flag indicating whether the request came from a high activity visitor. # noqa: E501
:param result: The result of this HighActivityResult. # noqa: E501
:type: bool
"""

self._result = result

@property
def daily_requests(self):
"""Gets the daily_requests of this HighActivityResult. # noqa: E501
Number of requests from the same visitor in the previous day. # noqa: E501
:return: The daily_requests of this HighActivityResult. # noqa: E501
:rtype: float
"""
return self._daily_requests

@daily_requests.setter
def daily_requests(self, daily_requests):
"""Sets the daily_requests of this HighActivityResult.
Number of requests from the same visitor in the previous day. # noqa: E501
:param daily_requests: The daily_requests of this HighActivityResult. # noqa: E501
:type: float
"""

self._daily_requests = daily_requests

def to_dict(self):
"""Returns the model properties as a dict"""
result = {}

for attr, _ in six.iteritems(self.swagger_types):
value = getattr(self, attr)
if isinstance(value, list):
result[attr] = list(map(
lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
value
))
elif hasattr(value, "to_dict"):
result[attr] = value.to_dict()
elif isinstance(value, dict):
result[attr] = dict(map(
lambda item: (item[0], item[1].to_dict())
if hasattr(item[1], "to_dict") else item,
value.items()
))
else:
result[attr] = value
if issubclass(HighActivityResult, dict):
for key, value in self.items():
result[key] = value

return result

def to_str(self):
"""Returns the string representation of the model"""
return pprint.pformat(self.to_dict())

def __repr__(self):
"""For `print` and `pprint`"""
return self.to_str()

def __eq__(self, other):
"""Returns true if both objects are equal"""
if not isinstance(other, HighActivityResult):
return False

return self.to_dict() == other.to_dict()

def __ne__(self, other):
"""Returns true if both objects are not equal"""
if not isinstance(other, HighActivityResult):
return True

return self.to_dict() != other.to_dict()
2 changes: 2 additions & 0 deletions fingerprint_pro_server_api_sdk/models/ip_location.py
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,7 @@ def __init__(self, accuracy_radius=None, latitude=None, longitude=None, postal_c
def accuracy_radius(self):
"""Gets the accuracy_radius of this IPLocation. # noqa: E501
The IP address is likely to be within this radius (in km) of the specified location. # noqa: E501
:return: The accuracy_radius of this IPLocation. # noqa: E501
:rtype: int
Expand All @@ -96,6 +97,7 @@ def accuracy_radius(self):
def accuracy_radius(self, accuracy_radius):
"""Sets the accuracy_radius of this IPLocation.
The IP address is likely to be within this radius (in km) of the specified location. # noqa: E501
:param accuracy_radius: The accuracy_radius of this IPLocation. # noqa: E501
:type: int
Expand Down
Loading

0 comments on commit 5bfd670

Please sign in to comment.