fingerprint-pro-server-api-sdk 6.0.0.dev1__tar.gz → 7.0.0.dev1__tar.gz

{fingerprint-pro-server-api-sdk-6.0.0.dev1 → fingerprint_pro_server_api_sdk-7.0.0.dev1}/PKG-INFO

@@ -1,18 +1,16 @@
 Metadata-Version: 2.1
 Name: fingerprint-pro-server-api-sdk
-Version: 6.0.0.dev1
+Version: 7.0.0.dev1
 Summary: 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. 
 Home-page: https://github.com/fingerprintjs/fingerprint-pro-server-api-python-sdk
 Author: Fingerprint
 Author-email: support@fingerprint.com
 License: MIT
 Keywords: Swagger,Fingerprint Pro Server API,browser,detection,fingerprint,identification,fingerprinting,browser-fingerprinting,browser-fingerprint,fraud-detection,fraud,audio-fingerprinting,fingerprintjs,fingerprintjs-pro,visitor-identifier
-Platform: UNKNOWN
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Programming Language :: Python
-Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.12
@@ -22,6 +20,10 @@ Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Classifier: Topic :: Security
 Description-Content-Type: text/markdown
 License-File: LICENSE
+Requires-Dist: certifi>=2023.7.22
+Requires-Dist: python-dateutil>=2.5.3
+Requires-Dist: urllib3>=1.23
+Requires-Dist: cryptography
 
 <p align="center">
   <a href="https://fingerprint.com">
@@ -47,14 +49,14 @@ The Fingerprint Server Python SDK is an easy way to interact with the Fingerprin
 This Python package is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
 
 - API version: 3
-- Package version: 6.0.0.dev1
+- Package version: 7.0.0.dev1
 - Build package: io.swagger.codegen.v3.generators.python.PythonClientCodegen
 
 ## Requirements
 
 The following Python versions are supported:
 
-- Python >= 3.8
+- Python >= 3.9
 
 ## Installation & Usage
 ### pip install
@@ -110,47 +112,88 @@ api_instance = fingerprint_pro_server_api_sdk.FingerprintApi(configuration)
 Fetching visits using visitorId:
 ```python
 import fingerprint_pro_server_api_sdk
-from fingerprint_pro_server_api_sdk import Response
 from fingerprint_pro_server_api_sdk.rest import ApiException, KnownApiException
 
 configuration = fingerprint_pro_server_api_sdk.Configuration(api_key="SECRET_API_KEY")
 api_instance = fingerprint_pro_server_api_sdk.FingerprintApi(configuration)
 
-visitor_id = 'visitor_id_example'  # str |
-#request_id = 'request_id_example'  # str | Filter events by requestId (optional)
-#linked_id = 'linked_id_example'  # str | Filter events by custom identifier (optional)
-limit = 10  # int | Limit scanned results (optional)
-#before = 56  # int | Used to paginate results (optional)
+visitor_id = 'visitor_id_example'  # str | Unique [visitor identifier](https://dev.fingerprint.com/docs/js-agent#visitorid) issued by Fingerprint Pro.
+#request_id = 'request_id_example'  # str | The unique event [identifier](https://dev.fingerprint.com/docs/js-agent#requestid).
+#linked_id = 'linked_id_example'  # str | Filter visits by your custom identifier.   You can use [`linkedId`](https://dev.fingerprint.com/docs/js-agent#linkedid) to associate identification requests with your own identifier, for example: session ID, purchase ID, or transaction ID. You can then use this `linked_id` parameter to retrieve all events associated with your custom identifier.  (optional)
+limit = 10  # int | Limit scanned results.   For performance reasons, the API first scans some number of events before filtering them. Use `limit` to specify how many events are scanned before they are filtered by `requestId` or `linkedId`. Results are always returned sorted by the timestamp (most recent first). By default, the most recent 100 visits are scanned, the maximum is 500.  (optional)
+#pagination_key = 'pagination_key_example' # str | Use `paginationKey` to get the next page of results.   When more results are available (e.g., you requested 200 results using `limit` parameter, but a total of 600 results are available), the `paginationKey` top-level attribute is added to the response. The key corresponds to the `requestId` of the last returned event. In the following request, use that value in the `paginationKey` parameter to get the next page of results:  1. First request, returning most recent 200 events: `GET api-base-url/visitors/:visitorId?limit=200` 2. Use `response.paginationKey` to get the next page of results: `GET api-base-url/visitors/:visitorId?limit=200&paginationKey=1683900801733.Ogvu1j`  Pagination happens during scanning and before filtering, so you can get less visits than the `limit` you specified with more available on the next page. When there are no more results available for scanning, the `paginationKey` attribute is not returned.  (optional)
 
 try:
-    api_response: Response = api_instance.get_visits(visitor_id, limit=2)
+    api_response = api_instance.get_visits(visitor_id, limit=2)
     print(api_response)
 except KnownApiException as e:
     structured_error = e.structured_error
     print("Error: %s\n" % structured_error.error)
 except ApiException as e:
-    print("Exception when calling DefaultApi->visitors_visitor_id_get: %s\n" % e)
+    print("Exception when calling FingerprintApi->visitors_visitor_id_get: %s\n" % e)
+```
+
+Delete visits using visitorId:
+```python
+import fingerprint_pro_server_api_sdk
+from fingerprint_pro_server_api_sdk.rest import ApiException, KnownApiException
+
+configuration = fingerprint_pro_server_api_sdk.Configuration(api_key="SECRET_API_KEY")
+api_instance = fingerprint_pro_server_api_sdk.FingerprintApi(configuration)
+
+visitor_id = 'visitor_id_example'  # str | Unique [visitor identifier](https://dev.fingerprint.com/docs/js-agent#visitorid) issued by Fingerprint Pro.
+
+try:
+    api_instance.delete_visitor_data(visitor_id)
+except KnownApiException as e:
+    structured_error = e.structured_error
+    print("Error: %s\n" % structured_error.error)
+except ApiException as e:
+    print("Exception when calling FingerprintApi->delete_visitor_data: %s\n" % e)
 ```
 
 Fetching events for requestId:
 ```python
 import fingerprint_pro_server_api_sdk
-from fingerprint_pro_server_api_sdk import EventResponse
 from fingerprint_pro_server_api_sdk.rest import ApiException, KnownApiException
 
 configuration = fingerprint_pro_server_api_sdk.Configuration(api_key="SECRET_API_KEY")
 api_instance = fingerprint_pro_server_api_sdk.FingerprintApi(configuration)
 
-request_id = 'request_id_example'  # str
+request_id = 'request_id_example'  # str | The unique event [identifier](https://dev.fingerprint.com/docs/js-agent#requestid).
 
 try:
-    events_response: EventResponse = api_instance.get_event(request_id)
+    events_response = api_instance.get_event(request_id)
 
 except KnownApiException as e:
     structured_error = e.structured_error
     print("Error code: %s. Error message: %s\n" % (structured_error.error.code, structured_error.error.message))
 except ApiException as e:
-    print("Exception when calling DefaultApi->get_event: %s\n" % e)
+    print("Exception when calling FingerprintApi->get_event: %s\n" % e)
+```
+
+Update event for requestId:
+```python
+import fingerprint_pro_server_api_sdk
+from fingerprint_pro_server_api_sdk import EventUpdateRequest
+from fingerprint_pro_server_api_sdk.rest import ApiException, KnownApiException
+
+configuration = fingerprint_pro_server_api_sdk.Configuration(api_key="SECRET_API_KEY")
+api_instance = fingerprint_pro_server_api_sdk.FingerprintApi(configuration)
+
+request_id = 'request_id_example'  # str | The unique event [identifier](https://dev.fingerprint.com/docs/js-agent#requestid).
+body = EventUpdateRequest(linked_id='foo')  # EventUpdateRequest |
+# body = EventUpdateRequest(tag={'bar': 123})
+# body = EventUpdateRequest(suspect=True)
+# body = EventUpdateRequest(linked_id='foo', tag={'bar': 123}, suspect=False)
+
+try:
+    api_instance.update_event(request_id, body)
+except KnownApiException as e:
+    structured_error = e.structured_error
+    print("Error code: %s. Error message: %s\n" % (structured_error.error.code, structured_error.error.message))
+except ApiException as e:
+    print("Exception when calling FingerprintApi->update_event: %s\n" % e)
 ```
 
 ## Sealed results
@@ -183,14 +226,60 @@ exit(0)
 ```
 To learn more, refer to example located in [sealed_results_example.py](sealed_results_example.py).
 
+## Webhook signature validation
+
+This SDK provides utility method for verifying the HMAC signature of the incoming webhook request.
+```python
+import os
+from flask import Flask, request, jsonify
+from fingerprint_pro_server_api_sdk import Webhook
+
+app = Flask(__name__)
+
+@app.route('/api/webhook', methods=['POST'])
+def webhook_handler():
+    try:
+        # Retrieve the secret key from environment variables
+        secret = os.getenv("WEBHOOK_SIGNATURE_SECRET")
+        if not secret:
+            return jsonify({"message": "Secret key is not configured."}), 400
+
+        # Get the "fpjs-event-signature" header from the incoming request
+        header = request.headers.get('fpjs-event-signature')
+        if not header:
+            return jsonify({"message": "Missing fpjs-event-signature header."}), 400
+
+        # Read the raw body of the incoming request
+        data = request.get_data()
+
+        # Validate the webhook signature
+        is_valid = Webhook.is_valid_webhook_signature(header, data, secret)
+        if not is_valid:
+            return jsonify({"message": "Webhook signature is invalid."}), 403
+
+        # Process the webhook data here
+        return jsonify({"message": "Webhook received."}), 200
+
+    except Exception as e:
+        # Handle any unexpected errors
+        return jsonify({"error": str(e)}), 500
+
+if __name__ == '__main__':
+    # Start the Flask application on the specified host and port
+    app.run(host='0.0.0.0', port=5000)
+```
+To learn more, refer to example located in [webhook_signature_example.py](webhook_signature_example.py).
+
 ## Documentation for API Endpoints
 
 All URIs are relative to *https://api.fpjs.io*
 
 Class | Method | HTTP request | Description
 ------------ | ------------- | ------------- | -------------
-*FingerprintApi* | [**get_event**](https://github.com/fingerprintjs/fingerprint-pro-server-api-python-sdk/blob/main/docs/FingerprintApi.md#get_event) | **GET** /events/{request_id} | Get event by requestId
-*FingerprintApi* | [**get_visits**](https://github.com/fingerprintjs/fingerprint-pro-server-api-python-sdk/blob/main/docs/FingerprintApi.md#get_visits) | **GET** /visitors/{visitor_id} | Get visits by visitorId
+*FingerprintApi* | [**delete_visitor_data**](https://github.com/fingerprintjs/fingerprint-pro-server-api-python-sdk/blob/main/docs/FingerprintApi.md#delete_visitor_data) | **DELETE** /visitors/{visitor_id} | Delete data by visitor ID
+*FingerprintApi* | [**get_event**](https://github.com/fingerprintjs/fingerprint-pro-server-api-python-sdk/blob/main/docs/FingerprintApi.md#get_event) | **GET** /events/{request_id} | Get event by request ID
+*FingerprintApi* | [**get_visits**](https://github.com/fingerprintjs/fingerprint-pro-server-api-python-sdk/blob/main/docs/FingerprintApi.md#get_visits) | **GET** /visitors/{visitor_id} | Get visits by visitor ID
+*FingerprintApi* | [**update_event**](https://github.com/fingerprintjs/fingerprint-pro-server-api-python-sdk/blob/main/docs/FingerprintApi.md#update_event) | **PUT** /events/{request_id} | Update an event with a given request ID
 
 ## Documentation For Models
 
@@ -199,17 +288,29 @@ Class | Method | HTTP request | Description
  - [BotdResult](https://github.com/fingerprintjs/fingerprint-pro-server-api-python-sdk/blob/main/docs/BotdResult.md)
  - [BrowserDetails](https://github.com/fingerprintjs/fingerprint-pro-server-api-python-sdk/blob/main/docs/BrowserDetails.md)
  - [ClonedAppResult](https://github.com/fingerprintjs/fingerprint-pro-server-api-python-sdk/blob/main/docs/ClonedAppResult.md)
+ - [Common403ErrorResponse](https://github.com/fingerprintjs/fingerprint-pro-server-api-python-sdk/blob/main/docs/Common403ErrorResponse.md)
  - [Confidence](https://github.com/fingerprintjs/fingerprint-pro-server-api-python-sdk/blob/main/docs/Confidence.md)
  - [DataCenter](https://github.com/fingerprintjs/fingerprint-pro-server-api-python-sdk/blob/main/docs/DataCenter.md)
  - [DeprecatedIPLocation](https://github.com/fingerprintjs/fingerprint-pro-server-api-python-sdk/blob/main/docs/DeprecatedIPLocation.md)
  - [DeprecatedIPLocationCity](https://github.com/fingerprintjs/fingerprint-pro-server-api-python-sdk/blob/main/docs/DeprecatedIPLocationCity.md)
+ - [DeveloperToolsResult](https://github.com/fingerprintjs/fingerprint-pro-server-api-python-sdk/blob/main/docs/DeveloperToolsResult.md)
  - [EmulatorResult](https://github.com/fingerprintjs/fingerprint-pro-server-api-python-sdk/blob/main/docs/EmulatorResult.md)
- - [ErrorEvent403Response](https://github.com/fingerprintjs/fingerprint-pro-server-api-python-sdk/blob/main/docs/ErrorEvent403Response.md)
- - [ErrorEvent403ResponseError](https://github.com/fingerprintjs/fingerprint-pro-server-api-python-sdk/blob/main/docs/ErrorEvent403ResponseError.md)
+ - [ErrorCommon403Response](https://github.com/fingerprintjs/fingerprint-pro-server-api-python-sdk/blob/main/docs/ErrorCommon403Response.md)
+ - [ErrorCommon429Response](https://github.com/fingerprintjs/fingerprint-pro-server-api-python-sdk/blob/main/docs/ErrorCommon429Response.md)
+ - [ErrorCommon429ResponseError](https://github.com/fingerprintjs/fingerprint-pro-server-api-python-sdk/blob/main/docs/ErrorCommon429ResponseError.md)
  - [ErrorEvent404Response](https://github.com/fingerprintjs/fingerprint-pro-server-api-python-sdk/blob/main/docs/ErrorEvent404Response.md)
  - [ErrorEvent404ResponseError](https://github.com/fingerprintjs/fingerprint-pro-server-api-python-sdk/blob/main/docs/ErrorEvent404ResponseError.md)
+ - [ErrorUpdateEvent400Response](https://github.com/fingerprintjs/fingerprint-pro-server-api-python-sdk/blob/main/docs/ErrorUpdateEvent400Response.md)
+ - [ErrorUpdateEvent400ResponseError](https://github.com/fingerprintjs/fingerprint-pro-server-api-python-sdk/blob/main/docs/ErrorUpdateEvent400ResponseError.md)
+ - [ErrorUpdateEvent409Response](https://github.com/fingerprintjs/fingerprint-pro-server-api-python-sdk/blob/main/docs/ErrorUpdateEvent409Response.md)
+ - [ErrorUpdateEvent409ResponseError](https://github.com/fingerprintjs/fingerprint-pro-server-api-python-sdk/blob/main/docs/ErrorUpdateEvent409ResponseError.md)
+ - [ErrorVisitor400Response](https://github.com/fingerprintjs/fingerprint-pro-server-api-python-sdk/blob/main/docs/ErrorVisitor400Response.md)
+ - [ErrorVisitor400ResponseError](https://github.com/fingerprintjs/fingerprint-pro-server-api-python-sdk/blob/main/docs/ErrorVisitor400ResponseError.md)
+ - [ErrorVisitor404Response](https://github.com/fingerprintjs/fingerprint-pro-server-api-python-sdk/blob/main/docs/ErrorVisitor404Response.md)
+ - [ErrorVisitor404ResponseError](https://github.com/fingerprintjs/fingerprint-pro-server-api-python-sdk/blob/main/docs/ErrorVisitor404ResponseError.md)
  - [ErrorVisits403](https://github.com/fingerprintjs/fingerprint-pro-server-api-python-sdk/blob/main/docs/ErrorVisits403.md)
  - [EventResponse](https://github.com/fingerprintjs/fingerprint-pro-server-api-python-sdk/blob/main/docs/EventResponse.md)
+ - [EventUpdateRequest](https://github.com/fingerprintjs/fingerprint-pro-server-api-python-sdk/blob/main/docs/EventUpdateRequest.md)
  - [FactoryResetResult](https://github.com/fingerprintjs/fingerprint-pro-server-api-python-sdk/blob/main/docs/FactoryResetResult.md)
  - [FridaResult](https://github.com/fingerprintjs/fingerprint-pro-server-api-python-sdk/blob/main/docs/FridaResult.md)
  - [HighActivityResult](https://github.com/fingerprintjs/fingerprint-pro-server-api-python-sdk/blob/main/docs/HighActivityResult.md)
@@ -225,7 +326,6 @@ Class | Method | HTTP request | Description
  - [JailbrokenResult](https://github.com/fingerprintjs/fingerprint-pro-server-api-python-sdk/blob/main/docs/JailbrokenResult.md)
  - [Location](https://github.com/fingerprintjs/fingerprint-pro-server-api-python-sdk/blob/main/docs/Location.md)
  - [LocationSpoofingResult](https://github.com/fingerprintjs/fingerprint-pro-server-api-python-sdk/blob/main/docs/LocationSpoofingResult.md)
- - [ManyRequestsResponse](https://github.com/fingerprintjs/fingerprint-pro-server-api-python-sdk/blob/main/docs/ManyRequestsResponse.md)
  - [PrivacySettingsResult](https://github.com/fingerprintjs/fingerprint-pro-server-api-python-sdk/blob/main/docs/PrivacySettingsResult.md)
  - [ProductError](https://github.com/fingerprintjs/fingerprint-pro-server-api-python-sdk/blob/main/docs/ProductError.md)
  - [ProductsResponse](https://github.com/fingerprintjs/fingerprint-pro-server-api-python-sdk/blob/main/docs/ProductsResponse.md)
@@ -234,11 +334,13 @@ Class | Method | HTTP request | Description
  - [ProductsResponseIdentificationData](https://github.com/fingerprintjs/fingerprint-pro-server-api-python-sdk/blob/main/docs/ProductsResponseIdentificationData.md)
  - [ProxyResult](https://github.com/fingerprintjs/fingerprint-pro-server-api-python-sdk/blob/main/docs/ProxyResult.md)
  - [RawDeviceAttributesResult](https://github.com/fingerprintjs/fingerprint-pro-server-api-python-sdk/blob/main/docs/RawDeviceAttributesResult.md)
+ - [RemoteControlResult](https://github.com/fingerprintjs/fingerprint-pro-server-api-python-sdk/blob/main/docs/RemoteControlResult.md)
  - [Response](https://github.com/fingerprintjs/fingerprint-pro-server-api-python-sdk/blob/main/docs/Response.md)
  - [ResponseVisits](https://github.com/fingerprintjs/fingerprint-pro-server-api-python-sdk/blob/main/docs/ResponseVisits.md)
  - [RootAppsResult](https://github.com/fingerprintjs/fingerprint-pro-server-api-python-sdk/blob/main/docs/RootAppsResult.md)
  - [SeenAt](https://github.com/fingerprintjs/fingerprint-pro-server-api-python-sdk/blob/main/docs/SeenAt.md)
  - [SignalResponseClonedApp](https://github.com/fingerprintjs/fingerprint-pro-server-api-python-sdk/blob/main/docs/SignalResponseClonedApp.md)
+ - [SignalResponseDeveloperTools](https://github.com/fingerprintjs/fingerprint-pro-server-api-python-sdk/blob/main/docs/SignalResponseDeveloperTools.md)
  - [SignalResponseEmulator](https://github.com/fingerprintjs/fingerprint-pro-server-api-python-sdk/blob/main/docs/SignalResponseEmulator.md)
  - [SignalResponseFactoryReset](https://github.com/fingerprintjs/fingerprint-pro-server-api-python-sdk/blob/main/docs/SignalResponseFactoryReset.md)
  - [SignalResponseFrida](https://github.com/fingerprintjs/fingerprint-pro-server-api-python-sdk/blob/main/docs/SignalResponseFrida.md)
@@ -251,16 +353,22 @@ Class | Method | HTTP request | Description
  - [SignalResponsePrivacySettings](https://github.com/fingerprintjs/fingerprint-pro-server-api-python-sdk/blob/main/docs/SignalResponsePrivacySettings.md)
  - [SignalResponseProxy](https://github.com/fingerprintjs/fingerprint-pro-server-api-python-sdk/blob/main/docs/SignalResponseProxy.md)
  - [SignalResponseRawDeviceAttributes](https://github.com/fingerprintjs/fingerprint-pro-server-api-python-sdk/blob/main/docs/SignalResponseRawDeviceAttributes.md)
+ - [SignalResponseRemoteControl](https://github.com/fingerprintjs/fingerprint-pro-server-api-python-sdk/blob/main/docs/SignalResponseRemoteControl.md)
  - [SignalResponseRootApps](https://github.com/fingerprintjs/fingerprint-pro-server-api-python-sdk/blob/main/docs/SignalResponseRootApps.md)
  - [SignalResponseSuspectScore](https://github.com/fingerprintjs/fingerprint-pro-server-api-python-sdk/blob/main/docs/SignalResponseSuspectScore.md)
  - [SignalResponseTampering](https://github.com/fingerprintjs/fingerprint-pro-server-api-python-sdk/blob/main/docs/SignalResponseTampering.md)
  - [SignalResponseTor](https://github.com/fingerprintjs/fingerprint-pro-server-api-python-sdk/blob/main/docs/SignalResponseTor.md)
+ - [SignalResponseVelocity](https://github.com/fingerprintjs/fingerprint-pro-server-api-python-sdk/blob/main/docs/SignalResponseVelocity.md)
  - [SignalResponseVirtualMachine](https://github.com/fingerprintjs/fingerprint-pro-server-api-python-sdk/blob/main/docs/SignalResponseVirtualMachine.md)
  - [SignalResponseVpn](https://github.com/fingerprintjs/fingerprint-pro-server-api-python-sdk/blob/main/docs/SignalResponseVpn.md)
  - [Subdivision](https://github.com/fingerprintjs/fingerprint-pro-server-api-python-sdk/blob/main/docs/Subdivision.md)
  - [SuspectScoreResult](https://github.com/fingerprintjs/fingerprint-pro-server-api-python-sdk/blob/main/docs/SuspectScoreResult.md)
  - [TamperingResult](https://github.com/fingerprintjs/fingerprint-pro-server-api-python-sdk/blob/main/docs/TamperingResult.md)
+ - [TooManyRequestsResponse](https://github.com/fingerprintjs/fingerprint-pro-server-api-python-sdk/blob/main/docs/TooManyRequestsResponse.md)
  - [TorResult](https://github.com/fingerprintjs/fingerprint-pro-server-api-python-sdk/blob/main/docs/TorResult.md)
+ - [VelocityIntervalResult](https://github.com/fingerprintjs/fingerprint-pro-server-api-python-sdk/blob/main/docs/VelocityIntervalResult.md)
+ - [VelocityIntervals](https://github.com/fingerprintjs/fingerprint-pro-server-api-python-sdk/blob/main/docs/VelocityIntervals.md)
+ - [VelocityResult](https://github.com/fingerprintjs/fingerprint-pro-server-api-python-sdk/blob/main/docs/VelocityResult.md)
  - [VirtualMachineResult](https://github.com/fingerprintjs/fingerprint-pro-server-api-python-sdk/blob/main/docs/VirtualMachineResult.md)
  - [Visit](https://github.com/fingerprintjs/fingerprint-pro-server-api-python-sdk/blob/main/docs/Visit.md)
  - [VpnResult](https://github.com/fingerprintjs/fingerprint-pro-server-api-python-sdk/blob/main/docs/VpnResult.md)
@@ -296,4 +404,3 @@ If you need private support, you can email us at [oss-support@fingerprint.com](m
 ## License
 
 This project is licensed under the [MIT License](https://github.com/fingerprintjs/fingerprint-pro-server-api-python-sdk/blob/main/LICENSE).
-

{fingerprint-pro-server-api-sdk-6.0.0.dev1 → fingerprint_pro_server_api_sdk-7.0.0.dev1}/README.md

@@ -26,14 +26,14 @@ The Fingerprint Server Python SDK is an easy way to interact with the Fingerprin
 This Python package is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
 
 - API version: 3
-- Package version: 6.0.0.dev1
+- Package version: 7.0.0.dev1
 - Build package: io.swagger.codegen.v3.generators.python.PythonClientCodegen
 
 ## Requirements
 
 The following Python versions are supported:
 
-- Python >= 3.8
+- Python >= 3.9
 
 ## Installation & Usage
 ### pip install
@@ -89,47 +89,88 @@ api_instance = fingerprint_pro_server_api_sdk.FingerprintApi(configuration)
 Fetching visits using visitorId:
 ```python
 import fingerprint_pro_server_api_sdk
-from fingerprint_pro_server_api_sdk import Response
 from fingerprint_pro_server_api_sdk.rest import ApiException, KnownApiException
 
 configuration = fingerprint_pro_server_api_sdk.Configuration(api_key="SECRET_API_KEY")
 api_instance = fingerprint_pro_server_api_sdk.FingerprintApi(configuration)
 
-visitor_id = 'visitor_id_example'  # str |
-#request_id = 'request_id_example'  # str | Filter events by requestId (optional)
-#linked_id = 'linked_id_example'  # str | Filter events by custom identifier (optional)
-limit = 10  # int | Limit scanned results (optional)
-#before = 56  # int | Used to paginate results (optional)
+visitor_id = 'visitor_id_example'  # str | Unique [visitor identifier](https://dev.fingerprint.com/docs/js-agent#visitorid) issued by Fingerprint Pro.
+#request_id = 'request_id_example'  # str | The unique event [identifier](https://dev.fingerprint.com/docs/js-agent#requestid).
+#linked_id = 'linked_id_example'  # str | Filter visits by your custom identifier.   You can use [`linkedId`](https://dev.fingerprint.com/docs/js-agent#linkedid) to associate identification requests with your own identifier, for example: session ID, purchase ID, or transaction ID. You can then use this `linked_id` parameter to retrieve all events associated with your custom identifier.  (optional)
+limit = 10  # int | Limit scanned results.   For performance reasons, the API first scans some number of events before filtering them. Use `limit` to specify how many events are scanned before they are filtered by `requestId` or `linkedId`. Results are always returned sorted by the timestamp (most recent first). By default, the most recent 100 visits are scanned, the maximum is 500.  (optional)
+#pagination_key = 'pagination_key_example' # str | Use `paginationKey` to get the next page of results.   When more results are available (e.g., you requested 200 results using `limit` parameter, but a total of 600 results are available), the `paginationKey` top-level attribute is added to the response. The key corresponds to the `requestId` of the last returned event. In the following request, use that value in the `paginationKey` parameter to get the next page of results:  1. First request, returning most recent 200 events: `GET api-base-url/visitors/:visitorId?limit=200` 2. Use `response.paginationKey` to get the next page of results: `GET api-base-url/visitors/:visitorId?limit=200&paginationKey=1683900801733.Ogvu1j`  Pagination happens during scanning and before filtering, so you can get less visits than the `limit` you specified with more available on the next page. When there are no more results available for scanning, the `paginationKey` attribute is not returned.  (optional)
 
 try:
-    api_response: Response = api_instance.get_visits(visitor_id, limit=2)
+    api_response = api_instance.get_visits(visitor_id, limit=2)
     print(api_response)
 except KnownApiException as e:
     structured_error = e.structured_error
     print("Error: %s\n" % structured_error.error)
 except ApiException as e:
-    print("Exception when calling DefaultApi->visitors_visitor_id_get: %s\n" % e)
+    print("Exception when calling FingerprintApi->visitors_visitor_id_get: %s\n" % e)
+```
+
+Delete visits using visitorId:
+```python
+import fingerprint_pro_server_api_sdk
+from fingerprint_pro_server_api_sdk.rest import ApiException, KnownApiException
+
+configuration = fingerprint_pro_server_api_sdk.Configuration(api_key="SECRET_API_KEY")
+api_instance = fingerprint_pro_server_api_sdk.FingerprintApi(configuration)
+
+visitor_id = 'visitor_id_example'  # str | Unique [visitor identifier](https://dev.fingerprint.com/docs/js-agent#visitorid) issued by Fingerprint Pro.
+
+try:
+    api_instance.delete_visitor_data(visitor_id)
+except KnownApiException as e:
+    structured_error = e.structured_error
+    print("Error: %s\n" % structured_error.error)
+except ApiException as e:
+    print("Exception when calling FingerprintApi->delete_visitor_data: %s\n" % e)
 ```
 
 Fetching events for requestId:
 ```python
 import fingerprint_pro_server_api_sdk
-from fingerprint_pro_server_api_sdk import EventResponse
 from fingerprint_pro_server_api_sdk.rest import ApiException, KnownApiException
 
 configuration = fingerprint_pro_server_api_sdk.Configuration(api_key="SECRET_API_KEY")
 api_instance = fingerprint_pro_server_api_sdk.FingerprintApi(configuration)
 
-request_id = 'request_id_example'  # str
+request_id = 'request_id_example'  # str | The unique event [identifier](https://dev.fingerprint.com/docs/js-agent#requestid).
 
 try:
-    events_response: EventResponse = api_instance.get_event(request_id)
+    events_response = api_instance.get_event(request_id)
+
+except KnownApiException as e:
+    structured_error = e.structured_error
+    print("Error code: %s. Error message: %s\n" % (structured_error.error.code, structured_error.error.message))
+except ApiException as e:
+    print("Exception when calling FingerprintApi->get_event: %s\n" % e)
+```
+
+Update event for requestId:
+```python
+import fingerprint_pro_server_api_sdk
+from fingerprint_pro_server_api_sdk import EventUpdateRequest
+from fingerprint_pro_server_api_sdk.rest import ApiException, KnownApiException
+
+configuration = fingerprint_pro_server_api_sdk.Configuration(api_key="SECRET_API_KEY")
+api_instance = fingerprint_pro_server_api_sdk.FingerprintApi(configuration)
+
+request_id = 'request_id_example'  # str | The unique event [identifier](https://dev.fingerprint.com/docs/js-agent#requestid).
+body = EventUpdateRequest(linked_id='foo')  # EventUpdateRequest |
+# body = EventUpdateRequest(tag={'bar': 123})
+# body = EventUpdateRequest(suspect=True)
+# body = EventUpdateRequest(linked_id='foo', tag={'bar': 123}, suspect=False)
 
+try:
+    api_instance.update_event(request_id, body)
 except KnownApiException as e:
     structured_error = e.structured_error
     print("Error code: %s. Error message: %s\n" % (structured_error.error.code, structured_error.error.message))
 except ApiException as e:
-    print("Exception when calling DefaultApi->get_event: %s\n" % e)
+    print("Exception when calling FingerprintApi->update_event: %s\n" % e)
 ```
 
 ## Sealed results
@@ -162,14 +203,60 @@ exit(0)
 ```
 To learn more, refer to example located in [sealed_results_example.py](sealed_results_example.py).
 
+## Webhook signature validation
+
+This SDK provides utility method for verifying the HMAC signature of the incoming webhook request.
+```python
+import os
+from flask import Flask, request, jsonify
+from fingerprint_pro_server_api_sdk import Webhook
+
+app = Flask(__name__)
+
+@app.route('/api/webhook', methods=['POST'])
+def webhook_handler():
+    try:
+        # Retrieve the secret key from environment variables
+        secret = os.getenv("WEBHOOK_SIGNATURE_SECRET")
+        if not secret:
+            return jsonify({"message": "Secret key is not configured."}), 400
+
+        # Get the "fpjs-event-signature" header from the incoming request
+        header = request.headers.get('fpjs-event-signature')
+        if not header:
+            return jsonify({"message": "Missing fpjs-event-signature header."}), 400
+
+        # Read the raw body of the incoming request
+        data = request.get_data()
+
+        # Validate the webhook signature
+        is_valid = Webhook.is_valid_webhook_signature(header, data, secret)
+        if not is_valid:
+            return jsonify({"message": "Webhook signature is invalid."}), 403
+
+        # Process the webhook data here
+        return jsonify({"message": "Webhook received."}), 200
+
+    except Exception as e:
+        # Handle any unexpected errors
+        return jsonify({"error": str(e)}), 500
+
+if __name__ == '__main__':
+    # Start the Flask application on the specified host and port
+    app.run(host='0.0.0.0', port=5000)
+```
+To learn more, refer to example located in [webhook_signature_example.py](webhook_signature_example.py).
+
 ## Documentation for API Endpoints
 
 All URIs are relative to *https://api.fpjs.io*
 
 Class | Method | HTTP request | Description
 ------------ | ------------- | ------------- | -------------
-*FingerprintApi* | [**get_event**](docs/FingerprintApi.md#get_event) | **GET** /events/{request_id} | Get event by requestId
-*FingerprintApi* | [**get_visits**](docs/FingerprintApi.md#get_visits) | **GET** /visitors/{visitor_id} | Get visits by visitorId
+*FingerprintApi* | [**delete_visitor_data**](docs/FingerprintApi.md#delete_visitor_data) | **DELETE** /visitors/{visitor_id} | Delete data by visitor ID
+*FingerprintApi* | [**get_event**](docs/FingerprintApi.md#get_event) | **GET** /events/{request_id} | Get event by request ID
+*FingerprintApi* | [**get_visits**](docs/FingerprintApi.md#get_visits) | **GET** /visitors/{visitor_id} | Get visits by visitor ID
+*FingerprintApi* | [**update_event**](docs/FingerprintApi.md#update_event) | **PUT** /events/{request_id} | Update an event with a given request ID
 
 ## Documentation For Models
 
@@ -178,17 +265,29 @@ Class | Method | HTTP request | Description
  - [BotdResult](docs/BotdResult.md)
  - [BrowserDetails](docs/BrowserDetails.md)
  - [ClonedAppResult](docs/ClonedAppResult.md)
+ - [Common403ErrorResponse](docs/Common403ErrorResponse.md)
  - [Confidence](docs/Confidence.md)
  - [DataCenter](docs/DataCenter.md)
  - [DeprecatedIPLocation](docs/DeprecatedIPLocation.md)
  - [DeprecatedIPLocationCity](docs/DeprecatedIPLocationCity.md)
+ - [DeveloperToolsResult](docs/DeveloperToolsResult.md)
  - [EmulatorResult](docs/EmulatorResult.md)
- - [ErrorEvent403Response](docs/ErrorEvent403Response.md)
- - [ErrorEvent403ResponseError](docs/ErrorEvent403ResponseError.md)
+ - [ErrorCommon403Response](docs/ErrorCommon403Response.md)
+ - [ErrorCommon429Response](docs/ErrorCommon429Response.md)
+ - [ErrorCommon429ResponseError](docs/ErrorCommon429ResponseError.md)
  - [ErrorEvent404Response](docs/ErrorEvent404Response.md)
  - [ErrorEvent404ResponseError](docs/ErrorEvent404ResponseError.md)
+ - [ErrorUpdateEvent400Response](docs/ErrorUpdateEvent400Response.md)
+ - [ErrorUpdateEvent400ResponseError](docs/ErrorUpdateEvent400ResponseError.md)
+ - [ErrorUpdateEvent409Response](docs/ErrorUpdateEvent409Response.md)
+ - [ErrorUpdateEvent409ResponseError](docs/ErrorUpdateEvent409ResponseError.md)
+ - [ErrorVisitor400Response](docs/ErrorVisitor400Response.md)
+ - [ErrorVisitor400ResponseError](docs/ErrorVisitor400ResponseError.md)
+ - [ErrorVisitor404Response](docs/ErrorVisitor404Response.md)
+ - [ErrorVisitor404ResponseError](docs/ErrorVisitor404ResponseError.md)
  - [ErrorVisits403](docs/ErrorVisits403.md)
  - [EventResponse](docs/EventResponse.md)
+ - [EventUpdateRequest](docs/EventUpdateRequest.md)
  - [FactoryResetResult](docs/FactoryResetResult.md)
  - [FridaResult](docs/FridaResult.md)
  - [HighActivityResult](docs/HighActivityResult.md)
@@ -204,7 +303,6 @@ Class | Method | HTTP request | Description
  - [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)
@@ -213,11 +311,13 @@ Class | Method | HTTP request | Description
  - [ProductsResponseIdentificationData](docs/ProductsResponseIdentificationData.md)
  - [ProxyResult](docs/ProxyResult.md)
  - [RawDeviceAttributesResult](docs/RawDeviceAttributesResult.md)
+ - [RemoteControlResult](docs/RemoteControlResult.md)
  - [Response](docs/Response.md)
  - [ResponseVisits](docs/ResponseVisits.md)
  - [RootAppsResult](docs/RootAppsResult.md)
  - [SeenAt](docs/SeenAt.md)
  - [SignalResponseClonedApp](docs/SignalResponseClonedApp.md)
+ - [SignalResponseDeveloperTools](docs/SignalResponseDeveloperTools.md)
  - [SignalResponseEmulator](docs/SignalResponseEmulator.md)
  - [SignalResponseFactoryReset](docs/SignalResponseFactoryReset.md)
  - [SignalResponseFrida](docs/SignalResponseFrida.md)
@@ -230,16 +330,22 @@ Class | Method | HTTP request | Description
  - [SignalResponsePrivacySettings](docs/SignalResponsePrivacySettings.md)
  - [SignalResponseProxy](docs/SignalResponseProxy.md)
  - [SignalResponseRawDeviceAttributes](docs/SignalResponseRawDeviceAttributes.md)
+ - [SignalResponseRemoteControl](docs/SignalResponseRemoteControl.md)
  - [SignalResponseRootApps](docs/SignalResponseRootApps.md)
  - [SignalResponseSuspectScore](docs/SignalResponseSuspectScore.md)
  - [SignalResponseTampering](docs/SignalResponseTampering.md)
  - [SignalResponseTor](docs/SignalResponseTor.md)
+ - [SignalResponseVelocity](docs/SignalResponseVelocity.md)
  - [SignalResponseVirtualMachine](docs/SignalResponseVirtualMachine.md)
  - [SignalResponseVpn](docs/SignalResponseVpn.md)
  - [Subdivision](docs/Subdivision.md)
  - [SuspectScoreResult](docs/SuspectScoreResult.md)
  - [TamperingResult](docs/TamperingResult.md)
+ - [TooManyRequestsResponse](docs/TooManyRequestsResponse.md)
  - [TorResult](docs/TorResult.md)
+ - [VelocityIntervalResult](docs/VelocityIntervalResult.md)
+ - [VelocityIntervals](docs/VelocityIntervals.md)
+ - [VelocityResult](docs/VelocityResult.md)
  - [VirtualMachineResult](docs/VirtualMachineResult.md)
  - [Visit](docs/Visit.md)
  - [VpnResult](docs/VpnResult.md)
@@ -274,4 +380,4 @@ If you need private support, you can email us at [oss-support@fingerprint.com](m
 
 ## License
 
-This project is licensed under the [MIT License](https://github.com/fingerprintjs/fingerprint-pro-server-api-python-sdk/blob/main/LICENSE).
+This project is licensed under the [MIT License](https://github.com/fingerprintjs/fingerprint-pro-server-api-python-sdk/blob/main/LICENSE).