INTER-1796: Migrate to Server API v4

.changeset/plenty-clouds-tie.md

@@ -0,0 +1,31 @@
+---
+"@fingerprint/python-sdk": major
+---
+
+Migrate to Server API v4.
+
+### Breaking Changes
+
+- Flatten event structure. Access fields directly intead of through `products` wrapper.
+- Remove `get_visitors` and `get_releated_visitors` endpoints (use `search_events` instead).
+- Remove deprecated v3 models (webhook models, product wrapper models, etc.)
+
+### Migration Guide
+
+**Event structure:**
+```diff
+- event.products.identification.data.visitor_id
++ event.identification.visitor_id
+```
+
+**Region parameter:**
+```diff
+- Configuration(api_key="key", region="us")
++ from fingerprint_server_sdk.configuration import Region
++ Configuration(api_key="key", region=Region.US)
+```
+
+**New Features:**
+
+- New exception classes: `TooManyRequestsException`, `ConflictException`, `UnprocessableEntityException`, ...
+- New v4 models: `BotInfo`, `Canvas`, `Emoji`, `EventRuleAction`, `FontPreferences`, ...

.env.example

@@ -1,5 +1,9 @@
 PRIVATE_KEY=<SECRET_API_KEY>
 VISITOR_ID_TO_DELETE=<VISITOR_ID_TO_DELETE>  # for delete visitor example
-REQUEST_ID_TO_UPDATE=<REQUEST_ID_TO_UPDATE>  # for update event example
+EVENT_ID_TO_UPDATE=<REQUEST_ID_TO_UPDATE>  # for update event example
 # put 'eu' or 'ap' if necessary, 'us' is default
 REGION=<REGION>
+
+# Sealed Results Example
+BASE64_SEALED_RESULT=
+BASE64_KEY=

.github/workflows/functional_tests.yml

@@ -17,7 +17,6 @@ jobs:
   functional_tests:
     name: Functional tests for Python ${{ matrix.python-version }}
     runs-on: "ubuntu-latest"
-    environment: test
 
     strategy:
       fail-fast: false
@@ -34,6 +33,7 @@ jobs:
         run: |
           python -m pip install --upgrade pip
           pip install -r requirements.txt
+          pip install -r test-requirements.txt
 
       - name: "Try to get data using SDK"
         run: "python ./run_checks.py"

.github/workflows/test.yml

@@ -1,9 +1,7 @@
 name: test
 
 on:
-  push:
-    branches-ignore:
-      - main
+  pull_request:
   workflow_dispatch:
 
 jobs:

.openapi-generator-ignore

@@ -0,0 +1,7 @@
+.gitignore
+.gitlab-ci.yml
+.travis.yml
+git_push.sh
+tox.ini
+test/*.py
+.github/workflows/python.yml

.openapi-generator/FILES

@@ -0,0 +1,115 @@
+README.md
+docs/BotInfo.md
+docs/BotResult.md
+docs/BrowserDetails.md
+docs/Canvas.md
+docs/DecryptionKey.md
+docs/Emoji.md
+docs/Error.md
+docs/ErrorCode.md
+docs/ErrorResponse.md
+docs/Event.md
+docs/EventRuleAction.md
+docs/EventRuleActionAllow.md
+docs/EventRuleActionBlock.md
+docs/EventSearch.md
+docs/EventUpdate.md
+docs/FingerprintApi.md
+docs/FontPreferences.md
+docs/Geolocation.md
+docs/GeolocationSubdivisionsInner.md
+docs/IPBlockList.md
+docs/IPInfo.md
+docs/IPInfoV4.md
+docs/IPInfoV6.md
+docs/Identification.md
+docs/IdentificationConfidence.md
+docs/Integration.md
+docs/IntegrationSubintegration.md
+docs/PluginsInner.md
+docs/PluginsInnerMimeTypesInner.md
+docs/Proximity.md
+docs/ProxyConfidence.md
+docs/ProxyDetails.md
+docs/RawDeviceAttributes.md
+docs/RequestHeaderModifications.md
+docs/RuleActionHeaderField.md
+docs/RuleActionType.md
+docs/SDK.md
+docs/SealedResults.md
+docs/SearchEventsBot.md
+docs/SearchEventsSdkPlatform.md
+docs/SearchEventsVpnConfidence.md
+docs/SupplementaryIDHighRecall.md
+docs/TamperingDetails.md
+docs/TouchSupport.md
+docs/Velocity.md
+docs/VelocityData.md
+docs/VpnConfidence.md
+docs/VpnMethods.md
+docs/WebGlBasics.md
+docs/WebGlExtensions.md
+fingerprint_server_sdk/__init__.py
+fingerprint_server_sdk/api/__init__.py
+fingerprint_server_sdk/api/fingerprint_api.py
+fingerprint_server_sdk/api_client.py
+fingerprint_server_sdk/api_response.py
+fingerprint_server_sdk/configuration.py
+fingerprint_server_sdk/exceptions.py
+fingerprint_server_sdk/models/__init__.py
+fingerprint_server_sdk/models/bot_info.py
+fingerprint_server_sdk/models/bot_result.py
+fingerprint_server_sdk/models/browser_details.py
+fingerprint_server_sdk/models/canvas.py
+fingerprint_server_sdk/models/emoji.py
+fingerprint_server_sdk/models/error.py
+fingerprint_server_sdk/models/error_code.py
+fingerprint_server_sdk/models/error_response.py
+fingerprint_server_sdk/models/event.py
+fingerprint_server_sdk/models/event_rule_action.py
+fingerprint_server_sdk/models/event_rule_action_allow.py
+fingerprint_server_sdk/models/event_rule_action_block.py
+fingerprint_server_sdk/models/event_search.py
+fingerprint_server_sdk/models/event_update.py
+fingerprint_server_sdk/models/font_preferences.py
+fingerprint_server_sdk/models/geolocation.py
+fingerprint_server_sdk/models/geolocation_subdivisions_inner.py
+fingerprint_server_sdk/models/identification.py
+fingerprint_server_sdk/models/identification_confidence.py
+fingerprint_server_sdk/models/integration.py
+fingerprint_server_sdk/models/integration_subintegration.py
+fingerprint_server_sdk/models/ip_block_list.py
+fingerprint_server_sdk/models/ip_info.py
+fingerprint_server_sdk/models/ip_info_v4.py
+fingerprint_server_sdk/models/ip_info_v6.py
+fingerprint_server_sdk/models/plugins_inner.py
+fingerprint_server_sdk/models/plugins_inner_mime_types_inner.py
+fingerprint_server_sdk/models/proximity.py
+fingerprint_server_sdk/models/proxy_confidence.py
+fingerprint_server_sdk/models/proxy_details.py
+fingerprint_server_sdk/models/raw_device_attributes.py
+fingerprint_server_sdk/models/request_header_modifications.py
+fingerprint_server_sdk/models/rule_action_header_field.py
+fingerprint_server_sdk/models/rule_action_type.py
+fingerprint_server_sdk/models/sdk.py
+fingerprint_server_sdk/models/search_events_bot.py
+fingerprint_server_sdk/models/search_events_sdk_platform.py
+fingerprint_server_sdk/models/search_events_vpn_confidence.py
+fingerprint_server_sdk/models/supplementary_id_high_recall.py
+fingerprint_server_sdk/models/tampering_details.py
+fingerprint_server_sdk/models/touch_support.py
+fingerprint_server_sdk/models/velocity.py
+fingerprint_server_sdk/models/velocity_data.py
+fingerprint_server_sdk/models/vpn_confidence.py
+fingerprint_server_sdk/models/vpn_methods.py
+fingerprint_server_sdk/models/web_gl_basics.py
+fingerprint_server_sdk/models/web_gl_extensions.py
+fingerprint_server_sdk/py.typed
+fingerprint_server_sdk/rest.py
+fingerprint_server_sdk/sealed.py
+fingerprint_server_sdk/webhook_validation.py
+pyproject.toml
+requirements.txt
+setup.cfg
+setup.py
+test-requirements.txt

.openapi-generator/VERSION

@@ -0,0 +1 @@
+7.19.0

.schema-version

@@ -1 +1 @@
-v2.12.0
+v3.0.1