INTER-1799: Improve examples

README.md

@@ -114,6 +114,8 @@ except ApiException as e:
     print("Exception when calling FingerprintApi->delete_visitor_data: %s\n" % e)
 ```
 
+To learn more, refer to example located in [examples/delete_visitor_example.py](examples/delete_visitor_example.py).
+
 Fetching event details for `eventId`:
 ```python
 import os
@@ -137,6 +139,8 @@ except ApiException as e:
     print("Exception when calling FingerprintApi->get_event: %s\n" % e)
 ```
 
+To learn more, refer to example located in [examples/get_event_example.py](examples/get_event_example.py).
+
 Search events with custom filters:
 ```python
 import os
@@ -171,6 +175,8 @@ except ApiException as e:
     print("Exception when calling FingerprintApi->get_event: %s\n" % e)
 ```
 
+To learn more, refer to example located in [examples/search_events_example.py](examples/search_events_example.py).
+
 Update event for `eventId`:
 ```python
 import os
@@ -199,6 +205,8 @@ except ApiException as e:
     print("Exception when calling FingerprintApi->update_event: %s\n" % e)
 ```
 
+To learn more, refer to example located in [examples/update_event_example.py](examples/update_event_example.py).
+
 ## Sealed results
 
 This SDK provides utility methods for decoding [sealed results](https://dev.fingerprint.com/docs/sealed-client-results).
@@ -226,7 +234,7 @@ print("Unseal successful!")
 
 exit(0)
 ```
-To learn more, refer to example located in [sealed_results_example.py](sealed_results_example.py).
+To learn more, refer to example located in [examples/sealed_results_example.py](examples/sealed_results_example.py).
 
 ## Webhook signature validation
 
@@ -270,7 +278,7 @@ 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).
+To learn more, refer to example located in [examples/webhook_signature_example.py](examples/webhook_signature_example.py).
 
 ## Documentation for API Endpoints
 

examples/get_event_example.py

@@ -0,0 +1,56 @@
+import os
+
+from dotenv import load_dotenv
+
+import fingerprint_server_sdk
+from fingerprint_server_sdk.configuration import Region
+from fingerprint_server_sdk.rest import ApiException
+
+load_dotenv()
+
+# configure
+region_str = os.environ.get('REGION', 'us').upper()
+api_key = os.environ.get('PRIVATE_KEY')
+
+if not api_key:
+    print('API key not provided')
+    exit(1)
+
+configuration = fingerprint_server_sdk.Configuration(api_key=api_key, region=Region[region_str])
+
+# create an instance
+api_instance = fingerprint_server_sdk.FingerprintApi(configuration)
+event_id = os.environ.get('EVENT_ID', None)
+# RULESET_ID - when provided, the response will include rule_action data.
+# See https://docs.fingerprint.com/docs/rules-engine#ruleset-evaluation-using-server-api
+ruleset_id = os.environ.get('RULESET_ID', None)
+
+if not event_id:
+    print('Event id not provided')
+    exit(1)
+
+try:
+    event = api_instance.get_event(event_id, ruleset_id)
+    print(f'Event ID: {event.event_id}')
+    print(f'Timestamp: {event.timestamp}')
+    if event.identification:
+        print(f'Visitor ID: {event.identification.visitor_id}')
+        print(f'Confidence: {event.identification.confidence.score}')
+    if event.bot:
+        print(f'Bot detection result: {event.bot}')
+    if ruleset_id and event.rule_action:
+        rule_action = event.rule_action.actual_instance
+        print(f'Rule action: {rule_action.type}')
+        if rule_action.type == 'block':
+            print(f'Block with HTTP status code: `{rule_action.status_code}`')
+            print(f'Block with response body: `{rule_action.body}`')
+            print(f'Block with response headers: `{rule_action.headers}`')
+        elif rule_action.type == 'allow':
+            print(f'Allow with header modifications: `{rule_action.request_header_modifications}`')
+except ApiException as e:
+    print(f'Exception when calling get_event: {e}\n')
+    exit(1)
+
+print('\nGet event successful!')
+
+exit(0)

examples/search_events_example.py

@@ -0,0 +1,50 @@
+import os
+from datetime import datetime, timedelta, timezone
+
+from dotenv import load_dotenv
+
+import fingerprint_server_sdk
+from fingerprint_server_sdk.configuration import Region
+from fingerprint_server_sdk.rest import ApiException
+
+load_dotenv()
+
+# configure
+region_str = os.environ.get('REGION', 'us').upper()
+configuration = fingerprint_server_sdk.Configuration(
+    api_key=os.environ['PRIVATE_KEY'], region=Region[region_str]
+)
+
+# create an instance
+api_instance = fingerprint_server_sdk.FingerprintApi(configuration)
+
+end = datetime.now(tz=timezone.utc)
+start = end - timedelta(days=7)
+start_timestamp = int(start.timestamp() * 1000)
+end_timestamp = int(end.timestamp() * 1000)
+
+try:
+    response = api_instance.search_events(limit=10, start=start_timestamp, end=end_timestamp)
+
+    print(f'Found {len(response.events)} events')
+    for event in response.events:
+        event_visitor_id = event.identification.visitor_id if event.identification else '-'
+        print(f'Event ID: {event.event_id}, Visitor ID: {event_visitor_id}')
+
+    if response.pagination_key:
+        print(f'Fetching next page with pagination_key: {response.pagination_key}')
+        next_page = api_instance.search_events(
+            limit=10,
+            start=start_timestamp,
+            end=end_timestamp,
+            pagination_key=response.pagination_key,
+        )
+        print(f'Found {len(next_page.events)} more events on next page')
+
+except ApiException as e:
+    print(f'Exception when calling search_events: {e}')
+    exit(1)
+
+print('Search events successful!')
+
+exit(0)

pyproject.toml

@@ -18,6 +18,9 @@ dependencies = [
   "cryptography"
 ]
 
+[project.optional-dependencies]
+examples = ["python-dotenv (>=1.0.0)"]
+
 [project.urls]
 Repository = "https://github.com/fingerprintjs/python-sdk"
 

template/common_README.mustache

@@ -32,6 +32,8 @@ except ApiException as e:
     print("Exception when calling FingerprintApi->delete_visitor_data: %s\n" % e)
 ```
 
+To learn more, refer to example located in [examples/delete_visitor_example.py](examples/delete_visitor_example.py).
+
 Fetching event details for `eventId`:
 ```python
 import os
@@ -52,6 +54,8 @@ except ApiException as e:
     print("Exception when calling FingerprintApi->get_event: %s\n" % e)
 ```
 
+To learn more, refer to example located in [examples/get_event_example.py](examples/get_event_example.py).
+
 Search events with custom filters:
 ```python
 import os
@@ -83,6 +87,8 @@ except ApiException as e:
     print("Exception when calling FingerprintApi->get_event: %s\n" % e)
 ```
 
+To learn more, refer to example located in [examples/search_events_example.py](examples/search_events_example.py).
+
 Update event for `eventId`:
 ```python
 import os
@@ -108,6 +114,8 @@ except ApiException as e:
     print("Exception when calling FingerprintApi->update_event: %s\n" % e)
 ```
 
+To learn more, refer to example located in [examples/update_event_example.py](examples/update_event_example.py).
+
 ## Sealed results
 
 This SDK provides utility methods for decoding [sealed results](https://dev.fingerprint.com/docs/sealed-client-results).
@@ -135,7 +143,7 @@ print("Unseal successful!")
 
 exit(0)
 ```
-To learn more, refer to example located in [sealed_results_example.py](sealed_results_example.py).
+To learn more, refer to example located in [examples/sealed_results_example.py](examples/sealed_results_example.py).
 
 ## Webhook signature validation
 
@@ -179,7 +187,7 @@ 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).
+To learn more, refer to example located in [examples/webhook_signature_example.py](examples/webhook_signature_example.py).
 
 ## Documentation for API Endpoints
 

template/pyproject.mustache

@@ -89,6 +89,9 @@ dependencies = [
   "cryptography"
 ]
 
+[project.optional-dependencies]
+examples = ["python-dotenv (>=1.0.0)"]
+
 [project.urls]
 Repository = "https://{{{gitHost}}}/{{{gitUserId}}}/{{{gitRepoId}}}"