feat: update schema

BREAKING CHANGE: rename `error_event403_response`, `error_event403_response_error`, `many_requests_response` to `common403_error_response`, `error_common403_response` `too_many_requests_response`
fingerprintjs · Jul 11, 2024 · c2e99cd · c2e99cd
1 parent f3eab65
commit c2e99cd
Show file tree

Hide file tree

Showing 25 changed files with 132 additions and 129 deletions.
diff --git a/.swagger-codegen-ignore b/.swagger-codegen-ignore
@@ -27,6 +27,6 @@
 git_push.sh
 tox.ini
 test/*.py
-fingerprint_pro_server_api_sdk/models/many_requests_response.py
+fingerprint_pro_server_api_sdk/models/too_many_requests_response.py
 requirements.txt
-test-requirements.txt
+test-requirements.txt
diff --git a/README.md b/README.md
@@ -168,8 +168,8 @@ 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* | [**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
 
 ## Documentation For Models
 
@@ -178,13 +178,13 @@ 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)
  - [EmulatorResult](docs/EmulatorResult.md)
- - [ErrorEvent403Response](docs/ErrorEvent403Response.md)
- - [ErrorEvent403ResponseError](docs/ErrorEvent403ResponseError.md)
+ - [ErrorCommon403Response](docs/ErrorCommon403Response.md)
  - [ErrorEvent404Response](docs/ErrorEvent404Response.md)
  - [ErrorEvent404ResponseError](docs/ErrorEvent404ResponseError.md)
  - [ErrorVisits403](docs/ErrorVisits403.md)
@@ -204,7 +204,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)
@@ -239,6 +238,7 @@ Class | Method | HTTP request | Description
  - [Subdivision](docs/Subdivision.md)
  - [SuspectScoreResult](docs/SuspectScoreResult.md)
  - [TamperingResult](docs/TamperingResult.md)
+ - [TooManyRequestsResponse](docs/TooManyRequestsResponse.md)
  - [TorResult](docs/TorResult.md)
  - [VirtualMachineResult](docs/VirtualMachineResult.md)
  - [Visit](docs/Visit.md)

diff --git a/docs/ErrorEvent403ResponseError.md → docs/Common403ErrorResponse.md b/docs/ErrorEvent403ResponseError.md → docs/Common403ErrorResponse.md
@@ -1,9 +1,9 @@
-# ErrorEvent403ResponseError
+# Common403ErrorResponse
 
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**code** | **str** | Error code:  * `TokenRequired` - `Auth-API-Key` header is missing or empty  * `TokenNotFound` - subscription not found for specified secret key  * `SubscriptionNotActive` - subscription is not active  * `WrongRegion` - server and subscription region differ  | 
+**code** | **str** | Error code:  * `TokenRequired` - `Auth-API-Key` header is missing or empty  * `TokenNotFound` - No Fingerprint application found for specified secret key  * `SubscriptionNotActive` - Fingerprint application is not active  * `WrongRegion` - server and application region differ  * `FeatureNotEnabled` - this feature (for example, Delete API) is not enabled for your application  | 
 **message** | **str** |  | 
 
 [[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/ErrorEvent403Response.md → docs/ErrorCommon403Response.md b/docs/ErrorEvent403Response.md → docs/ErrorCommon403Response.md
@@ -1,9 +1,9 @@
-# ErrorEvent403Response
+# ErrorCommon403Response
 
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**error** | [**ErrorEvent403ResponseError**](ErrorEvent403ResponseError.md) |  | [optional] 
+**error** | [**Common403ErrorResponse**](Common403ErrorResponse.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/ErrorEvent404ResponseError.md b/docs/ErrorEvent404ResponseError.md
@@ -3,7 +3,7 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**code** | **str** | Error code:  * `RequestNotFound` - request not found for specified id  | 
+**code** | **str** | Error code:  * `RequestNotFound` - The specified request ID was not found. It never existed, expired, or it has been deleted.  | 
 **message** | **str** |  | 
 
 [[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/FingerprintApi.md b/docs/FingerprintApi.md
@@ -4,15 +4,15 @@ All URIs are relative to *https://api.fpjs.io*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
-[**get_event**](FingerprintApi.md#get_event) | **GET** /events/{request_id} | Get event by requestId
-[**get_visits**](FingerprintApi.md#get_visits) | **GET** /visitors/{visitor_id} | Get visits by visitorId
+[**get_event**](FingerprintApi.md#get_event) | **GET** /events/{request_id} | Get event by request ID
+[**get_visits**](FingerprintApi.md#get_visits) | **GET** /visitors/{visitor_id} | Get visits by visitor ID
 
 # **get_event**
 > EventResponse get_event(request_id)
 
-Get event by requestId
+Get event by request ID
 
-This endpoint allows you to get a detailed analysis of an individual request.  **Only for Enterprise customers:** Please note that the response includes mobile signals (e.g. `rootApps`) even if the request originated from a non-mobile platform. It is highly recommended that you **ignore** the mobile signals for such requests.   Use `requestId` as the URL path parameter. This API method is scoped to a request, i.e. all returned information is by `requestId`. 
+Get a detailed analysis of an individual identification event, including Smart Signals.  Please note that the response includes mobile signals (e.g. `rootApps`) even if the request originated from a non-mobile platform. It is highly recommended that you **ignore** the mobile signals for such requests.   Use `requestId` as the URL path parameter. This API method is scoped to a request, i.e. all returned information is by `requestId`. 
 
 ### Example
 ```python
@@ -43,7 +43,7 @@ except ApiException as e:
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **request_id** | **str**| The unique [identifier](https://dev.fingerprint.com/docs/js-agent#requestid) of each analysis request. | 
+ **request_id** | **str**| The unique [identifier](https://dev.fingerprint.com/docs/js-agent#requestid) of each identification request. | 
 
 ### Return type
 
@@ -63,9 +63,9 @@ Name | Type | Description  | Notes
 # **get_visits**
 > Response get_visits(visitor_id, request_id=request_id, linked_id=linked_id, limit=limit, pagination_key=pagination_key, before=before)
 
-Get visits by visitorId
+Get visits by visitor ID
 
-This endpoint allows you to get a history of visits for a specific `visitorId`. Use the `visitorId` as a URL path parameter. Only information from the _Identification_ product is returned.  #### Headers  * `Retry-After` — Present in case of `429 Too many requests`. Indicates how long you should wait before making a follow-up request. The value is non-negative decimal integer indicating the seconds to delay after the response is received. 
+Get a history of visits (identification events) for a specific `visitorId`. Use the `visitorId` as a URL path parameter. Only information from the _Identification_ product is returned.  #### Headers  * `Retry-After` — Present in case of `429 Too many requests`. Indicates how long you should wait before making a follow-up request. The value is non-negative decimal integer indicating the seconds to delay after the response is received. 
 
 ### Example
 ```python
@@ -96,7 +96,7 @@ except ApiException as e:
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **visitor_id** | **str**| Unique identifier of the visitor issued by Fingerprint Pro. | 
+ **visitor_id** | **str**| Unique [visitor identifier](https://dev.fingerprint.com/docs/js-agent#visitorid) issued by Fingerprint Pro. | 
  **request_id** | **str**| Filter visits by `requestId`.   Every identification request has a unique identifier associated with it called `requestId`. This identifier is returned to the client in the identification [result](https://dev.fingerprint.com/docs/js-agent#requestid). When you filter visits by `requestId`, only one visit will be returned.  | [optional] 
  **linked_id** | **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** | **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] 

diff --git a/docs/SignalResponseIncognito.md b/docs/SignalResponseIncognito.md
@@ -4,7 +4,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **data** | [**IncognitoResult**](IncognitoResult.md) |  | [optional] 
-**error** | [**ProductError**](ProductError.md) |  | [optional] 
+**error** | [**IdentificationError**](IdentificationError.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/SignalResponseRawDeviceAttributes.md b/docs/SignalResponseRawDeviceAttributes.md
@@ -4,7 +4,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **data** | [**RawDeviceAttributesResult**](RawDeviceAttributesResult.md) |  | [optional] 
-**error** | [**ProductError**](ProductError.md) |  | [optional] 
+**error** | [**IdentificationError**](IdentificationError.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/SignalResponseTampering.md b/docs/SignalResponseTampering.md
@@ -4,7 +4,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **data** | [**TamperingResult**](TamperingResult.md) |  | [optional] 
-**error** | [**ProductError**](ProductError.md) |  | [optional] 
+**error** | [**IdentificationError**](IdentificationError.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/ManyRequestsResponse.md → docs/TooManyRequestsResponse.md b/docs/ManyRequestsResponse.md → docs/TooManyRequestsResponse.md
@@ -1,4 +1,4 @@
-# ManyRequestsResponse
+# TooManyRequestsResponse
 
 ## Properties
 Name | Type | Description | Notes

diff --git a/docs/VpnResultMethods.md b/docs/VpnResultMethods.md
@@ -3,7 +3,7 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**timezone_mismatch** | **bool** | User's browser timezone doesn't match the timezone from which the request was originally made. | 
+**timezone_mismatch** | **bool** | The browser timezone doesn't match the timezone inferred from the request IP address. | 
 **public_vpn** | **bool** | Request IP address is owned and used by a public VPN service provider. | 
 **auxiliary_mobile** | **bool** | This method applies to mobile devices only. Indicates the result of additional methods used to detect a VPN in mobile devices. | 
 

diff --git a/fingerprint_pro_server_api_sdk/__init__.py b/fingerprint_pro_server_api_sdk/__init__.py
@@ -25,13 +25,13 @@
 from fingerprint_pro_server_api_sdk.models.botd_result import BotdResult
 from fingerprint_pro_server_api_sdk.models.browser_details import BrowserDetails
 from fingerprint_pro_server_api_sdk.models.cloned_app_result import ClonedAppResult
+from fingerprint_pro_server_api_sdk.models.common403_error_response import Common403ErrorResponse
 from fingerprint_pro_server_api_sdk.models.confidence import Confidence
 from fingerprint_pro_server_api_sdk.models.data_center import DataCenter
 from fingerprint_pro_server_api_sdk.models.deprecated_ip_location import DeprecatedIPLocation
 from fingerprint_pro_server_api_sdk.models.deprecated_ip_location_city import DeprecatedIPLocationCity
 from fingerprint_pro_server_api_sdk.models.emulator_result import EmulatorResult
-from fingerprint_pro_server_api_sdk.models.error_event403_response import ErrorEvent403Response
-from fingerprint_pro_server_api_sdk.models.error_event403_response_error import ErrorEvent403ResponseError
+from fingerprint_pro_server_api_sdk.models.error_common403_response import ErrorCommon403Response
 from fingerprint_pro_server_api_sdk.models.error_event404_response import ErrorEvent404Response
 from fingerprint_pro_server_api_sdk.models.error_event404_response_error import ErrorEvent404ResponseError
 from fingerprint_pro_server_api_sdk.models.error_visits403 import ErrorVisits403
@@ -51,7 +51,6 @@
 from fingerprint_pro_server_api_sdk.models.jailbroken_result import JailbrokenResult
 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.privacy_settings_result import PrivacySettingsResult
 from fingerprint_pro_server_api_sdk.models.product_error import ProductError
 from fingerprint_pro_server_api_sdk.models.products_response import ProductsResponse
@@ -86,6 +85,7 @@
 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.too_many_requests_response import TooManyRequestsResponse
 from fingerprint_pro_server_api_sdk.models.tor_result import TorResult
 from fingerprint_pro_server_api_sdk.models.virtual_machine_result import VirtualMachineResult
 from fingerprint_pro_server_api_sdk.models.visit import Visit