Merge pull request #21 from fingerprintjs/update-definition

Update definition

.github/workflows/test.yml

@@ -9,7 +9,7 @@ on:
 jobs:
   tests:
     name: "Python ${{ matrix.python-version }}"
-    runs-on: "ubuntu-latest"
+    runs-on: "ubuntu-20.04"
 
     strategy:
       matrix:

.swagger-codegen-ignore

@@ -26,3 +26,4 @@
 .travis.yml
 git_push.sh
 tox.ini
+test/*.py

README.md

@@ -32,7 +32,7 @@
 </p>
 
 # Fingerprint Pro Server Python SDK
-Fingerprint Pro Server API provides a way for validating visitors’ data issued by Fingerprint Pro.
+Fingerprint Pro Server API allows you to get information about visitors and about individual events in a server environment. This API can be used for data exports, decision-making, and data analysis scenarios.
 
 This Python package is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
 
@@ -143,17 +143,20 @@ 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 request ID
-*FingerprintApi* | [**get_visits**](docs/FingerprintApi.md#get_visits) | **GET** /visitors/{visitor_id} | 
+*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
 
 ## Documentation For Models
 
  - [BotdDetectionResult](docs/BotdDetectionResult.md)
+ - [BotdError](docs/BotdError.md)
  - [BotdResult](docs/BotdResult.md)
  - [BrowserDetails](docs/BrowserDetails.md)
  - [Confidence](docs/Confidence.md)
- - [ErrorResponse](docs/ErrorResponse.md)
- - [ErrorResponseError](docs/ErrorResponseError.md)
+ - [ErrorEvent403Response](docs/ErrorEvent403Response.md)
+ - [ErrorEvent403ResponseError](docs/ErrorEvent403ResponseError.md)
+ - [ErrorEvent404Response](docs/ErrorEvent404Response.md)
+ - [ErrorEvent404ResponseError](docs/ErrorEvent404ResponseError.md)
  - [EventResponse](docs/EventResponse.md)
  - [IPLocation](docs/IPLocation.md)
  - [IPLocationCity](docs/IPLocationCity.md)
@@ -165,7 +168,7 @@ Class | Method | HTTP request | Description
  - [ProductsResponseIdentificationData](docs/ProductsResponseIdentificationData.md)
  - [Response](docs/Response.md)
  - [ResponseVisits](docs/ResponseVisits.md)
- - [StSeenAt](docs/StSeenAt.md)
+ - [SeenAt](docs/SeenAt.md)
  - [Subdivision](docs/Subdivision.md)
  - [Visit](docs/Visit.md)
  - [WebhookVisit](docs/WebhookVisit.md)

docs/BotdError.md

@@ -0,0 +1,10 @@
+# BotdError
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**code** | **str** | Error code:  * `TooManyRequests` - the limit on secret API key requests per second has been exceeded  * `Failed` - internal server error  | 
+**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)
+

docs/ErrorResponse.md → docs/ErrorEvent403Response.md

@@ -1,9 +1,9 @@
-# ErrorResponse
+# ErrorEvent403Response
 
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**error** | [**ErrorResponseError**](ErrorResponseError.md) |  | [optional] 
+**error** | [**ErrorEvent403ResponseError**](ErrorEvent403ResponseError.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)
 

docs/ErrorEvent403ResponseError.md

@@ -0,0 +1,10 @@
+# ErrorEvent403ResponseError
+
+## 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  | 
+**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)
+

docs/ErrorResponseError.md → docs/ErrorEvent404Response.md

@@ -1,10 +1,9 @@
-# ErrorResponseError
+# ErrorEvent404Response
 
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**code** | **str** |  | [optional] 
-**message** | **str** |  | [optional] 
+**error** | [**ErrorEvent404ResponseError**](ErrorEvent404ResponseError.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)
 

docs/ErrorEvent404ResponseError.md

@@ -0,0 +1,10 @@
+# ErrorEvent404ResponseError
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**code** | **str** | Error code:  * `RequestNotFound` - request not found for specified id  | 
+**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)
+

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 request ID
-[**get_visits**](FingerprintApi.md#get_visits) | **GET** /visitors/{visitor_id} | 
+[**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**
 > EventResponse get_event(request_id)
 
-Get event by request ID
+Get event by requestId
 
-This endpoint allows you to get events with all the information from each activated product - BOTD and Fingerprinting. Use the requestId as a URL path :request_id parameter. This API method is scoped to a request, i.e. all returned information is by requestId.
+This endpoint allows you to get events with all the information from each activated product (Fingerprint Pro or Bot Detection). Use the requestId as a URL path :request_id 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**| Request ID | 
+ **request_id** | **str**| requestId is the unique identifier of each request | 
 
 ### Return type
 
@@ -63,7 +63,7 @@ Name | Type | Description  | Notes
 # **get_visits**
 > Response get_visits(visitor_id, request_id=request_id, linked_id=linked_id, limit=limit, before=before)
 
-
+Get visits by visitorId
 
 This endpoint allows you to get a history of visits with all available information. Use the visitorId as a URL path parameter. This API method is scoped to a visitor, i.e. all returned information is by visitorId.
 
@@ -97,8 +97,8 @@ except ApiException as e:
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **visitor_id** | **str**|  | 
- **request_id** | **str**| Filter events by requestId | [optional] 
- **linked_id** | **str**| Filter events by custom identifier | [optional] 
+ **request_id** | **str**| Filter visits by requestId | [optional] 
+ **linked_id** | **str**| Filter visits by custom identifier | [optional] 
  **limit** | **int**| Limit scanned results | [optional] 
  **before** | **int**| Used to paginate results | [optional] 
 
@@ -113,7 +113,7 @@ Name | Type | Description  | Notes
 ### HTTP request headers
 
  - **Content-Type**: Not defined
- - **Accept**: application/json
+ - **Accept**: application/json, text/html
 
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
 

docs/ProductsResponseBotd.md

@@ -4,6 +4,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **data** | [**BotdResult**](BotdResult.md) |  | [optional] 
+**error** | [**BotdError**](BotdError.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)
 

docs/ProductsResponseIdentificationData.md

@@ -15,8 +15,8 @@ Name | Type | Description | Notes
 **linked_id** | **str** | A customer-provided id that was sent with identification request. | [optional] 
 **confidence** | [**Confidence**](Confidence.md) |  | 
 **visitor_found** | **bool** | Attribute represents if a visitor had been identified before. | 
-**first_seen_at** | [**StSeenAt**](StSeenAt.md) |  | 
-**last_seen_at** | [**StSeenAt**](StSeenAt.md) |  | 
+**first_seen_at** | [**SeenAt**](SeenAt.md) |  | 
+**last_seen_at** | [**SeenAt**](SeenAt.md) |  | 
 **visitor_id** | **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)

docs/ResponseVisits.md

@@ -15,8 +15,8 @@ Name | Type | Description | Notes
 **linked_id** | **str** | A customer-provided id that was sent with identification request. | [optional] 
 **confidence** | [**Confidence**](Confidence.md) |  | 
 **visitor_found** | **bool** | Attribute represents if a visitor had been identified before. | 
-**first_seen_at** | [**StSeenAt**](StSeenAt.md) |  | 
-**last_seen_at** | [**StSeenAt**](StSeenAt.md) |  | 
+**first_seen_at** | [**SeenAt**](SeenAt.md) |  | 
+**last_seen_at** | [**SeenAt**](SeenAt.md) |  | 
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 

docs/StSeenAt.md → docs/SeenAt.md

@@ -1,4 +1,4 @@
-# StSeenAt
+# SeenAt
 
 ## Properties
 Name | Type | Description | Notes

docs/Visit.md

@@ -15,8 +15,8 @@ Name | Type | Description | Notes
 **linked_id** | **str** | A customer-provided id that was sent with identification request. | [optional] 
 **confidence** | [**Confidence**](Confidence.md) |  | 
 **visitor_found** | **bool** | Attribute represents if a visitor had been identified before. | 
-**first_seen_at** | [**StSeenAt**](StSeenAt.md) |  | 
-**last_seen_at** | [**StSeenAt**](StSeenAt.md) |  | 
+**first_seen_at** | [**SeenAt**](SeenAt.md) |  | 
+**last_seen_at** | [**SeenAt**](SeenAt.md) |  | 
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 

docs/WebhookVisit.md

@@ -17,8 +17,8 @@ Name | Type | Description | Notes
 **linked_id** | **str** | A customer-provided id that was sent with identification request. | [optional] 
 **confidence** | [**Confidence**](Confidence.md) |  | 
 **visitor_found** | **bool** | Attribute represents if a visitor had been identified before. | 
-**first_seen_at** | [**StSeenAt**](StSeenAt.md) |  | 
-**last_seen_at** | [**StSeenAt**](StSeenAt.md) |  | 
+**first_seen_at** | [**SeenAt**](SeenAt.md) |  | 
+**last_seen_at** | [**SeenAt**](SeenAt.md) |  | 
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 

fingerprint_pro_server_api_sdk/__init__.py

@@ -5,7 +5,7 @@
 """
     Fingerprint Pro Server API
 
-    Fingerprint Pro Server API provides a way for validating visitors’ data issued by Fingerprint Pro.  # noqa: E501
+    Fingerprint Pro Server API allows you to get information about visitors and about individual events in a server environment. This API can be used for data exports, decision-making, and data analysis scenarios.  # noqa: E501
 
     OpenAPI spec version: 3
     Contact: [email protected]
@@ -21,11 +21,14 @@
 from fingerprint_pro_server_api_sdk.configuration import Configuration
 # import models into sdk package
 from fingerprint_pro_server_api_sdk.models.botd_detection_result import BotdDetectionResult
+from fingerprint_pro_server_api_sdk.models.botd_error import BotdError
 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.confidence import Confidence
-from fingerprint_pro_server_api_sdk.models.error_response import ErrorResponse
-from fingerprint_pro_server_api_sdk.models.error_response_error import ErrorResponseError
+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_event404_response import ErrorEvent404Response
+from fingerprint_pro_server_api_sdk.models.error_event404_response_error import ErrorEvent404ResponseError
 from fingerprint_pro_server_api_sdk.models.event_response import EventResponse
 from fingerprint_pro_server_api_sdk.models.ip_location import IPLocation
 from fingerprint_pro_server_api_sdk.models.ip_location_city import IPLocationCity
@@ -37,7 +40,7 @@
 from fingerprint_pro_server_api_sdk.models.products_response_identification_data import ProductsResponseIdentificationData
 from fingerprint_pro_server_api_sdk.models.response import Response
 from fingerprint_pro_server_api_sdk.models.response_visits import ResponseVisits
-from fingerprint_pro_server_api_sdk.models.st_seen_at import StSeenAt
+from fingerprint_pro_server_api_sdk.models.seen_at import SeenAt
 from fingerprint_pro_server_api_sdk.models.subdivision import Subdivision
 from fingerprint_pro_server_api_sdk.models.visit import Visit
 from fingerprint_pro_server_api_sdk.models.webhook_visit import WebhookVisit

fingerprint_pro_server_api_sdk/api/fingerprint_api.py

@@ -3,7 +3,7 @@
 """
     Fingerprint Pro Server API
 
-    Fingerprint Pro Server API provides a way for validating visitors’ data issued by Fingerprint Pro.  # noqa: E501
+    Fingerprint Pro Server API allows you to get information about visitors and about individual events in a server environment. This API can be used for data exports, decision-making, and data analysis scenarios.  # noqa: E501
 
     OpenAPI spec version: 3
     Contact: [email protected]
@@ -33,16 +33,16 @@ def __init__(self, configuration=None):
         self.api_client = ApiClient(configuration)
 
     def get_event(self, request_id, **kwargs):  # noqa: E501
-        """Get event by request ID  # noqa: E501
+        """Get event by requestId  # noqa: E501
 
-        This endpoint allows you to get events with all the information from each activated product - BOTD and Fingerprinting. Use the requestId as a URL path :request_id parameter. This API method is scoped to a request, i.e. all returned information is by requestId.  # noqa: E501
+        This endpoint allows you to get events with all the information from each activated product (Fingerprint Pro or Bot Detection). Use the requestId as a URL path :request_id parameter. This API method is scoped to a request, i.e. all returned information is by requestId.  # noqa: E501
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
         >>> thread = api.get_event(request_id, async_req=True)
         >>> result = thread.get()
 
         :param async_req bool
-        :param str request_id: Request ID (required)
+        :param str request_id: requestId is the unique identifier of each request (required)
         :return: EventResponse
                  If the method is called asynchronously,
                  returns the request thread.
@@ -55,16 +55,16 @@ def get_event(self, request_id, **kwargs):  # noqa: E501
             return data
 
     def get_event_with_http_info(self, request_id, **kwargs):  # noqa: E501
-        """Get event by request ID  # noqa: E501
+        """Get event by requestId  # noqa: E501
 
-        This endpoint allows you to get events with all the information from each activated product - BOTD and Fingerprinting. Use the requestId as a URL path :request_id parameter. This API method is scoped to a request, i.e. all returned information is by requestId.  # noqa: E501
+        This endpoint allows you to get events with all the information from each activated product (Fingerprint Pro or Bot Detection). Use the requestId as a URL path :request_id parameter. This API method is scoped to a request, i.e. all returned information is by requestId.  # noqa: E501
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
         >>> thread = api.get_event_with_http_info(request_id, async_req=True)
         >>> result = thread.get()
 
         :param async_req bool
-        :param str request_id: Request ID (required)
+        :param str request_id: requestId is the unique identifier of each request (required)
         :return: EventResponse
                  If the method is called asynchronously,
                  returns the request thread.
@@ -129,7 +129,7 @@ def get_event_with_http_info(self, request_id, **kwargs):  # noqa: E501
             collection_formats=collection_formats)
 
     def get_visits(self, visitor_id, **kwargs):  # noqa: E501
-        """get_visits  # noqa: E501
+        """Get visits by visitorId  # noqa: E501
 
         This endpoint allows you to get a history of visits with all available information. Use the visitorId as a URL path parameter. This API method is scoped to a visitor, i.e. all returned information is by visitorId.  # noqa: E501
         This method makes a synchronous HTTP request by default. To make an
@@ -139,8 +139,8 @@ def get_visits(self, visitor_id, **kwargs):  # noqa: E501
 
         :param async_req bool
         :param str visitor_id: (required)
-        :param str request_id: Filter events by requestId
-        :param str linked_id: Filter events by custom identifier
+        :param str request_id: Filter visits by requestId
+        :param str linked_id: Filter visits by custom identifier
         :param int limit: Limit scanned results
         :param int before: Used to paginate results
         :return: Response
@@ -155,7 +155,7 @@ def get_visits(self, visitor_id, **kwargs):  # noqa: E501
             return data
 
     def get_visits_with_http_info(self, visitor_id, **kwargs):  # noqa: E501
-        """get_visits  # noqa: E501
+        """Get visits by visitorId  # noqa: E501
 
         This endpoint allows you to get a history of visits with all available information. Use the visitorId as a URL path parameter. This API method is scoped to a visitor, i.e. all returned information is by visitorId.  # noqa: E501
         This method makes a synchronous HTTP request by default. To make an
@@ -165,8 +165,8 @@ def get_visits_with_http_info(self, visitor_id, **kwargs):  # noqa: E501
 
         :param async_req bool
         :param str visitor_id: (required)
-        :param str request_id: Filter events by requestId
-        :param str linked_id: Filter events by custom identifier
+        :param str request_id: Filter visits by requestId
+        :param str linked_id: Filter visits by custom identifier
         :param int limit: Limit scanned results
         :param int before: Used to paginate results
         :return: Response
@@ -219,7 +219,7 @@ def get_visits_with_http_info(self, visitor_id, **kwargs):  # noqa: E501
         body_params = None
         # HTTP header `Accept`
         header_params['Accept'] = self.api_client.select_header_accept(
-            ['application/json'])  # noqa: E501
+            ['application/json', 'text/html'])  # noqa: E501
 
         # Authentication setting
         auth_settings = ['ApiKeyHeader', 'ApiKeyQuery']  # noqa: E501

fingerprint_pro_server_api_sdk/api_client.py

@@ -2,7 +2,7 @@
 """
     Fingerprint Pro Server API
 
-    Fingerprint Pro Server API provides a way for validating visitors’ data issued by Fingerprint Pro.  # noqa: E501
+    Fingerprint Pro Server API allows you to get information about visitors and about individual events in a server environment. This API can be used for data exports, decision-making, and data analysis scenarios.  # noqa: E501
 
     OpenAPI spec version: 3
     Contact: [email protected]