diff --git a/README.md b/README.md index 0acacf2a..8cd6346f 100644 --- a/README.md +++ b/README.md @@ -242,12 +242,13 @@ Class | Method | HTTP request | Description - [SignalResponseProxy](docs/SignalResponseProxy.md) - [SignalResponseRawDeviceAttributes](docs/SignalResponseRawDeviceAttributes.md) - [SignalResponseRootApps](docs/SignalResponseRootApps.md) - - [SignalResponseRootAppsData](docs/SignalResponseRootAppsData.md) + - [SignalResponseSuspectScore](docs/SignalResponseSuspectScore.md) - [SignalResponseTampering](docs/SignalResponseTampering.md) - [SignalResponseTor](docs/SignalResponseTor.md) - [SignalResponseVirtualMachine](docs/SignalResponseVirtualMachine.md) - [SignalResponseVpn](docs/SignalResponseVpn.md) - [Subdivision](docs/Subdivision.md) + - [SuspectScoreResult](docs/SuspectScoreResult.md) - [TamperingResult](docs/TamperingResult.md) - [TorResult](docs/TorResult.md) - [VirtualMachineResult](docs/VirtualMachineResult.md) diff --git a/docs/ProductsResponse.md b/docs/ProductsResponse.md index 2f0f6d80..009f3eed 100644 --- a/docs/ProductsResponse.md +++ b/docs/ProductsResponse.md @@ -24,6 +24,7 @@ Name | Type | Description | Notes **tampering** | [**SignalResponseTampering**](SignalResponseTampering.md) | | [optional] **high_activity** | [**SignalResponseHighActivity**](SignalResponseHighActivity.md) | | [optional] **location_spoofing** | [**SignalResponseLocationSpoofing**](SignalResponseLocationSpoofing.md) | | [optional] +**suspect_score** | [**SignalResponseSuspectScore**](SignalResponseSuspectScore.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) diff --git a/docs/SignalResponseSuspectScore.md b/docs/SignalResponseSuspectScore.md new file mode 100644 index 00000000..8adfe42c --- /dev/null +++ b/docs/SignalResponseSuspectScore.md @@ -0,0 +1,10 @@ +# SignalResponseSuspectScore + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**SuspectScoreResult**](SuspectScoreResult.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) + diff --git a/docs/SuspectScoreResult.md b/docs/SuspectScoreResult.md new file mode 100644 index 00000000..142be54b --- /dev/null +++ b/docs/SuspectScoreResult.md @@ -0,0 +1,9 @@ +# SuspectScoreResult + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**result** | **int** | Suspect Score is an easy way to integrate Smart Signals into your fraud protection work flow. It is a weighted representation of all Smart Signals present in the payload that helps identify suspicious activity. The value range is [0; S] where S is sum of all Smart Signals weights. See more details here: https://dev.fingerprint.com/docs/suspect-score | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/WebhookVisit.md b/docs/WebhookVisit.md index 5b5f821a..e2468ae9 100644 --- a/docs/WebhookVisit.md +++ b/docs/WebhookVisit.md @@ -25,6 +25,7 @@ Name | Type | Description | Notes **raw_device_attributes** | [**RawDeviceAttributesResult**](RawDeviceAttributesResult.md) | | [optional] **high_activity** | [**HighActivityResult**](HighActivityResult.md) | | [optional] **location_spoofing** | [**LocationSpoofingResult**](LocationSpoofingResult.md) | | [optional] +**suspect_score** | [**SuspectScoreResult**](SuspectScoreResult.md) | | [optional] **request_id** | **str** | Unique identifier of the user's identification request. | **browser_details** | [**BrowserDetails**](BrowserDetails.md) | | **ip** | **str** | | diff --git a/fingerprint_pro_server_api_sdk/__init__.py b/fingerprint_pro_server_api_sdk/__init__.py index cc421c58..f7d7b5f4 100644 --- a/fingerprint_pro_server_api_sdk/__init__.py +++ b/fingerprint_pro_server_api_sdk/__init__.py @@ -74,12 +74,13 @@ from fingerprint_pro_server_api_sdk.models.signal_response_proxy import SignalResponseProxy from fingerprint_pro_server_api_sdk.models.signal_response_raw_device_attributes import SignalResponseRawDeviceAttributes from fingerprint_pro_server_api_sdk.models.signal_response_root_apps import SignalResponseRootApps -from fingerprint_pro_server_api_sdk.models.signal_response_root_apps_data import SignalResponseRootAppsData +from fingerprint_pro_server_api_sdk.models.signal_response_suspect_score import SignalResponseSuspectScore from fingerprint_pro_server_api_sdk.models.signal_response_tampering import SignalResponseTampering from fingerprint_pro_server_api_sdk.models.signal_response_tor import SignalResponseTor from fingerprint_pro_server_api_sdk.models.signal_response_virtual_machine import SignalResponseVirtualMachine from fingerprint_pro_server_api_sdk.models.signal_response_vpn import SignalResponseVpn from fingerprint_pro_server_api_sdk.models.subdivision import Subdivision +from fingerprint_pro_server_api_sdk.models.suspect_score_result import SuspectScoreResult from fingerprint_pro_server_api_sdk.models.tampering_result import TamperingResult from fingerprint_pro_server_api_sdk.models.tor_result import TorResult from fingerprint_pro_server_api_sdk.models.virtual_machine_result import VirtualMachineResult diff --git a/fingerprint_pro_server_api_sdk/models/__init__.py b/fingerprint_pro_server_api_sdk/models/__init__.py index 6598d718..81e3854a 100644 --- a/fingerprint_pro_server_api_sdk/models/__init__.py +++ b/fingerprint_pro_server_api_sdk/models/__init__.py @@ -72,7 +72,7 @@ from fingerprint_pro_server_api_sdk.models.signal_response_proxy import SignalResponseProxy from fingerprint_pro_server_api_sdk.models.signal_response_raw_device_attributes import SignalResponseRawDeviceAttributes from fingerprint_pro_server_api_sdk.models.signal_response_root_apps import SignalResponseRootApps -from fingerprint_pro_server_api_sdk.models.signal_response_root_apps_data import SignalResponseRootAppsData +from fingerprint_pro_server_api_sdk.models.signal_response_suspect_score import SignalResponseSuspectScore from fingerprint_pro_server_api_sdk.models.signal_response_tampering import SignalResponseTampering from fingerprint_pro_server_api_sdk.models.signal_response_tor import SignalResponseTor from fingerprint_pro_server_api_sdk.models.signal_response_virtual_machine import SignalResponseVirtualMachine diff --git a/fingerprint_pro_server_api_sdk/models/products_response.py b/fingerprint_pro_server_api_sdk/models/products_response.py index ab325ee6..95d42dd9 100644 --- a/fingerprint_pro_server_api_sdk/models/products_response.py +++ b/fingerprint_pro_server_api_sdk/models/products_response.py @@ -50,6 +50,7 @@ class ProductsResponse(object): 'tampering': 'SignalResponseTampering', 'high_activity': 'SignalResponseHighActivity', 'location_spoofing': 'SignalResponseLocationSpoofing', + 'suspect_score': 'SignalResponseSuspectScore', 'raw_device_attributes': 'SignalResponseRawDeviceAttributes' } @@ -73,10 +74,11 @@ class ProductsResponse(object): 'tampering': 'tampering', 'high_activity': 'highActivity', 'location_spoofing': 'locationSpoofing', + 'suspect_score': 'suspectScore', 'raw_device_attributes': 'rawDeviceAttributes' } - def __init__(self, identification=None, botd=None, ip_info=None, incognito=None, root_apps=None, emulator=None, cloned_app=None, factory_reset=None, jailbroken=None, frida=None, ip_blocklist=None, tor=None, privacy_settings=None, virtual_machine=None, vpn=None, proxy=None, tampering=None, high_activity=None, location_spoofing=None, raw_device_attributes=None): # noqa: E501 + def __init__(self, identification=None, botd=None, ip_info=None, incognito=None, root_apps=None, emulator=None, cloned_app=None, factory_reset=None, jailbroken=None, frida=None, ip_blocklist=None, tor=None, privacy_settings=None, virtual_machine=None, vpn=None, proxy=None, tampering=None, high_activity=None, location_spoofing=None, suspect_score=None, raw_device_attributes=None): # noqa: E501 """ProductsResponse - a model defined in Swagger""" # noqa: E501 self._identification = None self._botd = None @@ -97,6 +99,7 @@ def __init__(self, identification=None, botd=None, ip_info=None, incognito=None, self._tampering = None self._high_activity = None self._location_spoofing = None + self._suspect_score = None self._raw_device_attributes = None self.discriminator = None if identification is not None: @@ -137,6 +140,8 @@ def __init__(self, identification=None, botd=None, ip_info=None, incognito=None, self.high_activity = high_activity if location_spoofing is not None: self.location_spoofing = location_spoofing + if suspect_score is not None: + self.suspect_score = suspect_score if raw_device_attributes is not None: self.raw_device_attributes = raw_device_attributes @@ -539,6 +544,27 @@ def location_spoofing(self, location_spoofing): self._location_spoofing = location_spoofing + @property + def suspect_score(self): + """Gets the suspect_score of this ProductsResponse. # noqa: E501 + + + :return: The suspect_score of this ProductsResponse. # noqa: E501 + :rtype: SignalResponseSuspectScore + """ + return self._suspect_score + + @suspect_score.setter + def suspect_score(self, suspect_score): + """Sets the suspect_score of this ProductsResponse. + + + :param suspect_score: The suspect_score of this ProductsResponse. # noqa: E501 + :type: SignalResponseSuspectScore + """ + + self._suspect_score = suspect_score + @property def raw_device_attributes(self): """Gets the raw_device_attributes of this ProductsResponse. # noqa: E501 diff --git a/fingerprint_pro_server_api_sdk/models/signal_response_suspect_score.py b/fingerprint_pro_server_api_sdk/models/signal_response_suspect_score.py new file mode 100644 index 00000000..d5fabff1 --- /dev/null +++ b/fingerprint_pro_server_api_sdk/models/signal_response_suspect_score.py @@ -0,0 +1,139 @@ +# 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: support@fingerprint.com + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class SignalResponseSuspectScore(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 = { + 'data': 'SuspectScoreResult', + 'error': 'ProductError' + } + + attribute_map = { + 'data': 'data', + 'error': 'error' + } + + def __init__(self, data=None, error=None): # noqa: E501 + """SignalResponseSuspectScore - a model defined in Swagger""" # noqa: E501 + self._data = None + self._error = None + self.discriminator = None + if data is not None: + self.data = data + if error is not None: + self.error = error + + @property + def data(self): + """Gets the data of this SignalResponseSuspectScore. # noqa: E501 + + + :return: The data of this SignalResponseSuspectScore. # noqa: E501 + :rtype: SuspectScoreResult + """ + return self._data + + @data.setter + def data(self, data): + """Sets the data of this SignalResponseSuspectScore. + + + :param data: The data of this SignalResponseSuspectScore. # noqa: E501 + :type: SuspectScoreResult + """ + + self._data = data + + @property + def error(self): + """Gets the error of this SignalResponseSuspectScore. # noqa: E501 + + + :return: The error of this SignalResponseSuspectScore. # noqa: E501 + :rtype: ProductError + """ + return self._error + + @error.setter + def error(self, error): + """Sets the error of this SignalResponseSuspectScore. + + + :param error: The error of this SignalResponseSuspectScore. # noqa: E501 + :type: ProductError + """ + + self._error = error + + 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(SignalResponseSuspectScore, 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, SignalResponseSuspectScore): + 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, SignalResponseSuspectScore): + return True + + return self.to_dict() != other.to_dict() diff --git a/fingerprint_pro_server_api_sdk/models/suspect_score_result.py b/fingerprint_pro_server_api_sdk/models/suspect_score_result.py new file mode 100644 index 00000000..b7684285 --- /dev/null +++ b/fingerprint_pro_server_api_sdk/models/suspect_score_result.py @@ -0,0 +1,116 @@ +# 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: support@fingerprint.com + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class SuspectScoreResult(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': 'int' + } + + attribute_map = { + 'result': 'result' + } + + def __init__(self, result=None): # noqa: E501 + """SuspectScoreResult - a model defined in Swagger""" # noqa: E501 + self._result = None + self.discriminator = None + self.result = result + + @property + def result(self): + """Gets the result of this SuspectScoreResult. # noqa: E501 + + Suspect Score is an easy way to integrate Smart Signals into your fraud protection work flow. It is a weighted representation of all Smart Signals present in the payload that helps identify suspicious activity. The value range is [0; S] where S is sum of all Smart Signals weights. See more details here: https://dev.fingerprint.com/docs/suspect-score # noqa: E501 + + :return: The result of this SuspectScoreResult. # noqa: E501 + :rtype: int + """ + return self._result + + @result.setter + def result(self, result): + """Sets the result of this SuspectScoreResult. + + Suspect Score is an easy way to integrate Smart Signals into your fraud protection work flow. It is a weighted representation of all Smart Signals present in the payload that helps identify suspicious activity. The value range is [0; S] where S is sum of all Smart Signals weights. See more details here: https://dev.fingerprint.com/docs/suspect-score # noqa: E501 + + :param result: The result of this SuspectScoreResult. # noqa: E501 + :type: int + """ + if result is None: + raise ValueError("Invalid value for `result`, must not be `None`") # noqa: E501 + + self._result = result + + 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(SuspectScoreResult, 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, SuspectScoreResult): + 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, SuspectScoreResult): + return True + + return self.to_dict() != other.to_dict() diff --git a/fingerprint_pro_server_api_sdk/models/webhook_visit.py b/fingerprint_pro_server_api_sdk/models/webhook_visit.py index 8de9932b..24fecf29 100644 --- a/fingerprint_pro_server_api_sdk/models/webhook_visit.py +++ b/fingerprint_pro_server_api_sdk/models/webhook_visit.py @@ -50,6 +50,7 @@ class WebhookVisit(object): 'raw_device_attributes': 'RawDeviceAttributesResult', 'high_activity': 'HighActivityResult', 'location_spoofing': 'LocationSpoofingResult', + 'suspect_score': 'SuspectScoreResult', 'request_id': 'str', 'browser_details': 'BrowserDetails', 'ip': 'str', @@ -88,6 +89,7 @@ class WebhookVisit(object): 'raw_device_attributes': 'rawDeviceAttributes', 'high_activity': 'highActivity', 'location_spoofing': 'locationSpoofing', + 'suspect_score': 'suspectScore', 'request_id': 'requestId', 'browser_details': 'browserDetails', 'ip': 'ip', @@ -103,7 +105,7 @@ class WebhookVisit(object): 'last_seen_at': 'lastSeenAt' } - def __init__(self, visitor_id=None, client_referrer=None, user_agent=None, bot=None, ip_info=None, incognito=None, root_apps=None, emulator=None, cloned_app=None, factory_reset=None, jailbroken=None, frida=None, ip_blocklist=None, tor=None, privacy_settings=None, virtual_machine=None, vpn=None, proxy=None, tampering=None, raw_device_attributes=None, high_activity=None, location_spoofing=None, request_id=None, browser_details=None, ip=None, ip_location=None, timestamp=None, time=None, url=None, tag=None, linked_id=None, confidence=None, visitor_found=None, first_seen_at=None, last_seen_at=None): # noqa: E501 + def __init__(self, visitor_id=None, client_referrer=None, user_agent=None, bot=None, ip_info=None, incognito=None, root_apps=None, emulator=None, cloned_app=None, factory_reset=None, jailbroken=None, frida=None, ip_blocklist=None, tor=None, privacy_settings=None, virtual_machine=None, vpn=None, proxy=None, tampering=None, raw_device_attributes=None, high_activity=None, location_spoofing=None, suspect_score=None, request_id=None, browser_details=None, ip=None, ip_location=None, timestamp=None, time=None, url=None, tag=None, linked_id=None, confidence=None, visitor_found=None, first_seen_at=None, last_seen_at=None): # noqa: E501 """WebhookVisit - a model defined in Swagger""" # noqa: E501 self._visitor_id = None self._client_referrer = None @@ -127,6 +129,7 @@ def __init__(self, visitor_id=None, client_referrer=None, user_agent=None, bot=N self._raw_device_attributes = None self._high_activity = None self._location_spoofing = None + self._suspect_score = None self._request_id = None self._browser_details = None self._ip = None @@ -183,6 +186,8 @@ def __init__(self, visitor_id=None, client_referrer=None, user_agent=None, bot=N self.high_activity = high_activity if location_spoofing is not None: self.location_spoofing = location_spoofing + if suspect_score is not None: + self.suspect_score = suspect_score self.request_id = request_id self.browser_details = browser_details self.ip = ip @@ -668,6 +673,27 @@ def location_spoofing(self, location_spoofing): self._location_spoofing = location_spoofing + @property + def suspect_score(self): + """Gets the suspect_score of this WebhookVisit. # noqa: E501 + + + :return: The suspect_score of this WebhookVisit. # noqa: E501 + :rtype: SuspectScoreResult + """ + return self._suspect_score + + @suspect_score.setter + def suspect_score(self, suspect_score): + """Sets the suspect_score of this WebhookVisit. + + + :param suspect_score: The suspect_score of this WebhookVisit. # noqa: E501 + :type: SuspectScoreResult + """ + + self._suspect_score = suspect_score + @property def request_id(self): """Gets the request_id of this WebhookVisit. # noqa: E501