diff --git a/README.md b/README.md index 1d732e75..885d5232 100644 --- a/README.md +++ b/README.md @@ -32,7 +32,7 @@

# Fingerprint Pro Server Python SDK -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. +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. This Python package is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project: diff --git a/docs/BotdDetectionResult.md b/docs/BotdDetectionResult.md index 59ab10f1..a514b2a0 100644 --- a/docs/BotdDetectionResult.md +++ b/docs/BotdDetectionResult.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**result** | **str** | Bot detection result: * `notDetected` - the visitor is not a bot * `good` - good bot detected, such as Google bot, Baidu Spider, AlexaBot and so on * `bad` - bad bot detected, such as Selenium, Puppeteer, Playwright, headless browsers, and so on | +**result** | **str** | Bot detection result: * `notDetected` - the visitor is not a bot * `good` - good bot detected, such as Google bot, Baidu Spider, AlexaBot and so on * `bad` - bad bot detected, such as Selenium, Puppeteer, Playwright, headless browsers, and so on | **type** | **str** | | [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/ErrorEvent403ResponseError.md b/docs/ErrorEvent403ResponseError.md index a25d3a97..100685ab 100644 --- a/docs/ErrorEvent403ResponseError.md +++ b/docs/ErrorEvent403ResponseError.md @@ -3,7 +3,7 @@ ## 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` - 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) diff --git a/docs/ErrorEvent404ResponseError.md b/docs/ErrorEvent404ResponseError.md index 5471a793..885f39b5 100644 --- 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` - 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) diff --git a/docs/FingerprintApi.md b/docs/FingerprintApi.md index 6970eb56..212e562f 100644 --- a/docs/FingerprintApi.md +++ b/docs/FingerprintApi.md @@ -12,7 +12,7 @@ Method | HTTP request | Description Get event 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. +This endpoint allows you to retrieve an individual analysis event with all the information from each activated product (Identification, Bot Detection, and others). Products that are not activated for your application or not relevant to the event's detected platform (web, iOS, Android) are not included in the response. 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**| requestId is the unique identifier of each request | + **request_id** | **str**| The unique [identifier](https://dev.fingerprint.com/docs/js-agent#requestid) of each analysis request. | ### Return type @@ -61,11 +61,11 @@ Name | Type | Description | Notes [[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) # **get_visits** -> Response get_visits(visitor_id, request_id=request_id, linked_id=linked_id, limit=limit, before=before) +> 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 -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. +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. ### Example ```python @@ -96,11 +96,12 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **visitor_id** | **str**| | - **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**| Timestamp (in milliseconds since epoch) used to paginate results | [optional] + **visitor_id** | **str**| Unique identifier of the visitor 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] + **pagination_key** | **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] + **before** | **int**| ⚠️ Deprecated pagination method, please use `paginationKey` instead. Timestamp (in milliseconds since epoch) used to paginate results. | [optional] ### Return type diff --git a/docs/IPLocation.md b/docs/IPLocation.md index b370ad49..a665bbb2 100644 --- a/docs/IPLocation.md +++ b/docs/IPLocation.md @@ -3,14 +3,14 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**accuracy_radius** | **int** | | -**latitude** | **float** | | -**longitude** | **float** | | +**accuracy_radius** | **int** | | [optional] +**latitude** | **float** | | [optional] +**longitude** | **float** | | [optional] **postal_code** | **str** | | [optional] -**timezone** | **str** | | +**timezone** | **str** | | [optional] **city** | [**IPLocationCity**](IPLocationCity.md) | | [optional] -**country** | [**Location**](Location.md) | | -**continent** | [**Location**](Location.md) | | +**country** | [**Location**](Location.md) | | [optional] +**continent** | [**Location**](Location.md) | | [optional] **subdivisions** | [**list[Subdivision]**](Subdivision.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/IdentificationError.md b/docs/IdentificationError.md index 090a3dcb..a66dacf2 100644 --- a/docs/IdentificationError.md +++ b/docs/IdentificationError.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**code** | **str** | Error code: * `429 Too Many Requests` - the limit on secret API key requests per second has been exceeded * `Failed` - internal server error | +**code** | **str** | Error code: * `429 Too Many Requests` - 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) diff --git a/docs/IpBlockListResult.md b/docs/IpBlockListResult.md index 8dcf9b0c..c8b610a7 100644 --- a/docs/IpBlockListResult.md +++ b/docs/IpBlockListResult.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**result** | **bool** | `true` if request IP address is part of any database that we use to search for known malicious actors, `false` otherwise. | [optional] +**result** | **bool** | `true` if request IP address is part of any database that we use to search for known malicious actors, `false` otherwise. | [optional] **details** | [**IpBlockListResultDetails**](IpBlockListResultDetails.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/ProductError.md b/docs/ProductError.md index 665121da..93141f9f 100644 --- a/docs/ProductError.md +++ b/docs/ProductError.md @@ -3,7 +3,7 @@ ## 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 | +**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) diff --git a/docs/ProductsResponseIdentificationData.md b/docs/ProductsResponseIdentificationData.md index 4797099c..ae2a1944 100644 --- a/docs/ProductsResponseIdentificationData.md +++ b/docs/ProductsResponseIdentificationData.md @@ -3,11 +3,11 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**request_id** | **str** | Unique identifier of the user's identification request. | +**request_id** | **str** | Unique identifier of the user's identification request. | **browser_details** | [**BrowserDetails**](BrowserDetails.md) | | **incognito** | **bool** | Flag if user used incognito session. | **ip** | **str** | | -**ip_location** | [**IPLocation**](IPLocation.md) | | +**ip_location** | [**IPLocation**](IPLocation.md) | | [optional] **timestamp** | **int** | Timestamp of the event with millisecond precision in Unix time. | **time** | **datetime** | Time expressed according to ISO 8601 in UTC format. | **url** | **str** | Page URL from which identification request was sent. | diff --git a/docs/Response.md b/docs/Response.md index 681e169a..06eac25f 100644 --- a/docs/Response.md +++ b/docs/Response.md @@ -5,8 +5,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **visitor_id** | **str** | | **visits** | [**list[ResponseVisits]**](ResponseVisits.md) | | -**last_timestamp** | **int** | When more results are available (e.g., you scanned 200 results using `limit` parameter, but a total of 600 results are available), a special `lastTimestamp` top-level attribute is added to the response. If you want to paginate the results further in the past, you should use the value of this attribute. | [optional] -**pagination_key** | **str** | Visit's `requestId` of the last visit in the current page. | [optional] +**last_timestamp** | **int** | ⚠️ Deprecated paging attribute, please use `paginationKey` instead. Timestamp of the last visit in the current page of results. | [optional] +**pagination_key** | **str** | Request ID of the last visit in the current page of results. Use this value in the following request as the `paginationKey` parameter to get the next page of results. | [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/ResponseVisits.md b/docs/ResponseVisits.md index 9af87c83..1ddca7f5 100644 --- a/docs/ResponseVisits.md +++ b/docs/ResponseVisits.md @@ -3,11 +3,11 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**request_id** | **str** | Unique identifier of the user's identification request. | +**request_id** | **str** | Unique identifier of the user's identification request. | **browser_details** | [**BrowserDetails**](BrowserDetails.md) | | **incognito** | **bool** | Flag if user used incognito session. | **ip** | **str** | | -**ip_location** | [**IPLocation**](IPLocation.md) | | +**ip_location** | [**IPLocation**](IPLocation.md) | | [optional] **timestamp** | **int** | Timestamp of the event with millisecond precision in Unix time. | **time** | **datetime** | Time expressed according to ISO 8601 in UTC format. | **url** | **str** | Page URL from which identification request was sent. | diff --git a/docs/SignalResponseEmulatorData.md b/docs/SignalResponseEmulatorData.md index 363425eb..926f9771 100644 --- a/docs/SignalResponseEmulatorData.md +++ b/docs/SignalResponseEmulatorData.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**result** | **bool** | Android specific emulator detection. There are 2 values: • `true` - Emulated environment detected (e.g. launch inside of AVD) • `false` - No signs of emulated environment detected Available only for events from Android client. The field will not be present for a browser or iOS event. | [optional] +**result** | **bool** | Android specific emulator detection. There are 2 values: • `true` - Emulated environment detected (e.g. launch inside of AVD) • `false` - No signs of emulated environment detected Available only for events from Android client. The field will not be present for a browser or iOS event. | [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/SignalResponseIncognitoData.md b/docs/SignalResponseIncognitoData.md index 51827bd8..0aa9885c 100644 --- a/docs/SignalResponseIncognitoData.md +++ b/docs/SignalResponseIncognitoData.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**result** | **bool** | `true` if we detected incognito mode used in the browser, `false` otherwise. | [optional] +**result** | **bool** | `true` if we detected incognito mode used in the browser, `false` otherwise. | [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/SignalResponseProxyData.md b/docs/SignalResponseProxyData.md index 8f369db7..2e1c2edf 100644 --- a/docs/SignalResponseProxyData.md +++ b/docs/SignalResponseProxyData.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**result** | **bool** | `true` if the request IP address is used by a public proxy provider, `false` otherwise. | [optional] +**result** | **bool** | `true` if the request IP address is used by a public proxy provider, `false` otherwise. | [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/SignalResponseRootAppsData.md b/docs/SignalResponseRootAppsData.md index 0ba51cb3..4323d725 100644 --- a/docs/SignalResponseRootAppsData.md +++ b/docs/SignalResponseRootAppsData.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**result** | **bool** | Android specific root management apps detection. There are 2 values: • `true` - Root Management Apps detected (e.g. Magisk) • `false` - No Root Management Apps detected Available only for events from Android client. The field will not be present for a browser or iOS event. | [optional] +**result** | **bool** | Android specific root management apps detection. There are 2 values: • `true` - Root Management Apps detected (e.g. Magisk) • `false` - No Root Management Apps detected Available only for events from Android client. The field will not be present for a browser or iOS event. | [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/SignalResponseTorData.md b/docs/SignalResponseTorData.md index 7b361bef..e307fa89 100644 --- a/docs/SignalResponseTorData.md +++ b/docs/SignalResponseTorData.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**result** | **bool** | `true` if the request IP address is a known tor exit node, `false` otherwise. | [optional] +**result** | **bool** | `true` if the request IP address is a known tor exit node, `false` otherwise. | [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/TamperingResult.md b/docs/TamperingResult.md index cf83fc26..18c531f3 100644 --- a/docs/TamperingResult.md +++ b/docs/TamperingResult.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **result** | **bool** | Flag indicating whether browser tampering was detected according to our internal thresholds. | [optional] -**anomaly_score** | **float** | Confidence score (`0.0 - 1.0`) for the tampering detection. Values above `0.5` suggest that we're reasonably sure there was a tampering attempt. Values below `0.5` are genuine browsers. | [optional] +**anomaly_score** | **float** | Confidence score (`0.0 - 1.0`) for the tampering detection. Values above `0.5` suggest that we're reasonably sure there was a tampering attempt. Values below `0.5` are genuine browsers. | [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/Visit.md b/docs/Visit.md index 94489f62..52c3bb60 100644 --- a/docs/Visit.md +++ b/docs/Visit.md @@ -3,11 +3,11 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**request_id** | **str** | Unique identifier of the user's identification request. | +**request_id** | **str** | Unique identifier of the user's identification request. | **browser_details** | [**BrowserDetails**](BrowserDetails.md) | | **incognito** | **bool** | Flag if user used incognito session. | **ip** | **str** | | -**ip_location** | [**IPLocation**](IPLocation.md) | | +**ip_location** | [**IPLocation**](IPLocation.md) | | [optional] **timestamp** | **int** | Timestamp of the event with millisecond precision in Unix time. | **time** | **datetime** | Time expressed according to ISO 8601 in UTC format. | **url** | **str** | Page URL from which identification request was sent. | diff --git a/docs/VpnResultMethods.md b/docs/VpnResultMethods.md index 04cc9910..29cf55cb 100644 --- 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. | [optional] +**timezone_mismatch** | **bool** | User's browser timezone doesn't match the timezone from which the request was originally made. | [optional] **public_vpn** | **bool** | Request IP address is owned and used by a public VPN service provider. | [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/WebhookSignalResponseEmulator.md b/docs/WebhookSignalResponseEmulator.md index bd686f32..df2276d5 100644 --- a/docs/WebhookSignalResponseEmulator.md +++ b/docs/WebhookSignalResponseEmulator.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**result** | **bool** | Android specific emulator detection. There are 2 values: • `true` - Emulated environment detected (e.g. launch inside of AVD) • `false` - No signs of emulated environment detected Available only for events from Android client. The field will not be present for a browser or iOS event. | [optional] +**result** | **bool** | Android specific emulator detection. There are 2 values: • `true` - Emulated environment detected (e.g. launch inside of AVD) • `false` - No signs of emulated environment detected Available only for events from Android client. The field will not be present for a browser or iOS event. | [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/WebhookSignalResponseProxy.md b/docs/WebhookSignalResponseProxy.md index a0322b19..4b9f6477 100644 --- a/docs/WebhookSignalResponseProxy.md +++ b/docs/WebhookSignalResponseProxy.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**result** | **bool** | `true` if the request IP address is used by a public proxy provider, `false` otherwise. | [optional] +**result** | **bool** | `true` if the request IP address is used by a public proxy provider, `false` otherwise. | [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/WebhookSignalResponseRootApps.md b/docs/WebhookSignalResponseRootApps.md index b026c2c9..842038b2 100644 --- a/docs/WebhookSignalResponseRootApps.md +++ b/docs/WebhookSignalResponseRootApps.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**result** | **bool** | Android specific root management apps detection. There are 2 values: • `true` - Root Management Apps detected (e.g. Magisk) • `false` - No Root Management Apps detected Available only for events from Android client. The field will not be present for a browser or iOS event. | [optional] +**result** | **bool** | Android specific root management apps detection. There are 2 values: • `true` - Root Management Apps detected (e.g. Magisk) • `false` - No Root Management Apps detected Available only for events from Android client. The field will not be present for a browser or iOS event. | [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/WebhookSignalResponseTor.md b/docs/WebhookSignalResponseTor.md index d5e7aa6d..605ec629 100644 --- a/docs/WebhookSignalResponseTor.md +++ b/docs/WebhookSignalResponseTor.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**result** | **bool** | `true` if the request IP address is a known tor exit node, `false` otherwise. | [optional] +**result** | **bool** | `true` if the request IP address is a known tor exit node, `false` otherwise. | [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/WebhookVisit.md b/docs/WebhookVisit.md index 98cc995f..fd4a957d 100644 --- a/docs/WebhookVisit.md +++ b/docs/WebhookVisit.md @@ -16,10 +16,10 @@ Name | Type | Description | Notes **vpn** | [**VpnResult**](VpnResult.md) | | [optional] **proxy** | [**WebhookSignalResponseProxy**](WebhookSignalResponseProxy.md) | | [optional] **tampering** | [**TamperingResult**](TamperingResult.md) | | [optional] -**request_id** | **str** | Unique identifier of the user's identification request. | +**request_id** | **str** | Unique identifier of the user's identification request. | **browser_details** | [**BrowserDetails**](BrowserDetails.md) | | **ip** | **str** | | -**ip_location** | [**IPLocation**](IPLocation.md) | | +**ip_location** | [**IPLocation**](IPLocation.md) | | [optional] **timestamp** | **int** | Timestamp of the event with millisecond precision in Unix time. | **time** | **datetime** | Time expressed according to ISO 8601 in UTC format. | **url** | **str** | Page URL from which identification request was sent. | diff --git a/fingerprint_pro_server_api_sdk/__init__.py b/fingerprint_pro_server_api_sdk/__init__.py index e88fa52c..a7d631be 100644 --- a/fingerprint_pro_server_api_sdk/__init__.py +++ b/fingerprint_pro_server_api_sdk/__init__.py @@ -5,7 +5,7 @@ """ Fingerprint Pro Server API - 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 + 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. # noqa: E501 OpenAPI spec version: 3 Contact: support@fingerprint.com diff --git a/fingerprint_pro_server_api_sdk/api/fingerprint_api.py b/fingerprint_pro_server_api_sdk/api/fingerprint_api.py index ee9e2589..750d01d2 100644 --- a/fingerprint_pro_server_api_sdk/api/fingerprint_api.py +++ b/fingerprint_pro_server_api_sdk/api/fingerprint_api.py @@ -3,7 +3,7 @@ """ Fingerprint Pro Server API - 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 + 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. # noqa: E501 OpenAPI spec version: 3 Contact: support@fingerprint.com @@ -37,14 +37,14 @@ def __init__(self, configuration=None): def get_event(self, request_id, **kwargs): # noqa: E501 """Get event 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 endpoint allows you to retrieve an individual analysis event with all the information from each activated product (Identification, Bot Detection, and others). Products that are not activated for your application or not relevant to the event's detected platform (web, iOS, Android) are not included in the response. Use `requestId` as the URL path 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: requestId is the unique identifier of each request (required) + :param str request_id: The unique [identifier](https://dev.fingerprint.com/docs/js-agent#requestid) of each analysis request. (required) :return: EventResponse If the method is called asynchronously, returns the request thread. @@ -59,14 +59,14 @@ def get_event(self, request_id, **kwargs): # noqa: E501 def get_event_with_http_info(self, request_id, **kwargs): # noqa: E501 """Get event 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 endpoint allows you to retrieve an individual analysis event with all the information from each activated product (Identification, Bot Detection, and others). Products that are not activated for your application or not relevant to the event's detected platform (web, iOS, Android) are not included in the response. Use `requestId` as the URL path 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: requestId is the unique identifier of each request (required) + :param str request_id: The unique [identifier](https://dev.fingerprint.com/docs/js-agent#requestid) of each analysis request. (required) :return: EventResponse If the method is called asynchronously, returns the request thread. @@ -142,18 +142,19 @@ def get_event_with_http_info(self, request_id, **kwargs): # noqa: E501 def get_visits(self, visitor_id, **kwargs): # 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 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. # 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_visits(visitor_id, async_req=True) >>> result = thread.get() :param async_req bool - :param str visitor_id: (required) - :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: Timestamp (in milliseconds since epoch) used to paginate results + :param str visitor_id: Unique identifier of the visitor issued by Fingerprint Pro. (required) + :param str request_id: 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. + :param str linked_id: 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. + :param int limit: 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. + :param str pagination_key: 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. + :param int before: ⚠️ Deprecated pagination method, please use `paginationKey` instead. Timestamp (in milliseconds since epoch) used to paginate results. :return: Response If the method is called asynchronously, returns the request thread. @@ -168,24 +169,25 @@ def get_visits(self, visitor_id, **kwargs): # noqa: E501 def get_visits_with_http_info(self, visitor_id, **kwargs): # 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 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. # 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_visits_with_http_info(visitor_id, async_req=True) >>> result = thread.get() :param async_req bool - :param str visitor_id: (required) - :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: Timestamp (in milliseconds since epoch) used to paginate results + :param str visitor_id: Unique identifier of the visitor issued by Fingerprint Pro. (required) + :param str request_id: 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. + :param str linked_id: 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. + :param int limit: 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. + :param str pagination_key: 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. + :param int before: ⚠️ Deprecated pagination method, please use `paginationKey` instead. Timestamp (in milliseconds since epoch) used to paginate results. :return: Response If the method is called asynchronously, returns the request thread. """ - all_params = ['visitor_id', 'request_id', 'linked_id', 'limit', 'before'] # noqa: E501 + all_params = ['visitor_id', 'request_id', 'linked_id', 'limit', 'pagination_key', 'before'] # noqa: E501 all_params.append('async_req') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -219,6 +221,8 @@ def get_visits_with_http_info(self, visitor_id, **kwargs): # noqa: E501 query_params.append(('linked_id', params['linked_id'])) # noqa: E501 if 'limit' in params: query_params.append(('limit', params['limit'])) # noqa: E501 + if 'pagination_key' in params: + query_params.append(('paginationKey', params['pagination_key'])) # noqa: E501 if 'before' in params: query_params.append(('before', params['before'])) # noqa: E501 diff --git a/fingerprint_pro_server_api_sdk/api_client.py b/fingerprint_pro_server_api_sdk/api_client.py index 0879b811..9326a286 100644 --- a/fingerprint_pro_server_api_sdk/api_client.py +++ b/fingerprint_pro_server_api_sdk/api_client.py @@ -2,7 +2,7 @@ """ Fingerprint Pro Server API - 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 + 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. # noqa: E501 OpenAPI spec version: 3 Contact: support@fingerprint.com diff --git a/fingerprint_pro_server_api_sdk/configuration.py b/fingerprint_pro_server_api_sdk/configuration.py index ea4f5f6c..c189e47a 100644 --- a/fingerprint_pro_server_api_sdk/configuration.py +++ b/fingerprint_pro_server_api_sdk/configuration.py @@ -3,7 +3,7 @@ """ Fingerprint Pro Server API - 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 + 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. # noqa: E501 OpenAPI spec version: 3 Contact: support@fingerprint.com diff --git a/fingerprint_pro_server_api_sdk/models/__init__.py b/fingerprint_pro_server_api_sdk/models/__init__.py index d76ee6f4..30bd29f0 100644 --- a/fingerprint_pro_server_api_sdk/models/__init__.py +++ b/fingerprint_pro_server_api_sdk/models/__init__.py @@ -4,7 +4,7 @@ """ Fingerprint Pro Server API - 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 + 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. # noqa: E501 OpenAPI spec version: 3 Contact: support@fingerprint.com diff --git a/fingerprint_pro_server_api_sdk/models/botd_detection_result.py b/fingerprint_pro_server_api_sdk/models/botd_detection_result.py index f6710c5b..77a7c0cf 100644 --- a/fingerprint_pro_server_api_sdk/models/botd_detection_result.py +++ b/fingerprint_pro_server_api_sdk/models/botd_detection_result.py @@ -3,7 +3,7 @@ """ Fingerprint Pro Server API - 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 + 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. # noqa: E501 OpenAPI spec version: 3 Contact: support@fingerprint.com diff --git a/fingerprint_pro_server_api_sdk/models/botd_result.py b/fingerprint_pro_server_api_sdk/models/botd_result.py index a85b6af8..5d9550ee 100644 --- a/fingerprint_pro_server_api_sdk/models/botd_result.py +++ b/fingerprint_pro_server_api_sdk/models/botd_result.py @@ -3,7 +3,7 @@ """ Fingerprint Pro Server API - 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 + 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. # noqa: E501 OpenAPI spec version: 3 Contact: support@fingerprint.com diff --git a/fingerprint_pro_server_api_sdk/models/browser_details.py b/fingerprint_pro_server_api_sdk/models/browser_details.py index 4f0e5be4..b81aac6f 100644 --- a/fingerprint_pro_server_api_sdk/models/browser_details.py +++ b/fingerprint_pro_server_api_sdk/models/browser_details.py @@ -3,7 +3,7 @@ """ Fingerprint Pro Server API - 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 + 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. # noqa: E501 OpenAPI spec version: 3 Contact: support@fingerprint.com diff --git a/fingerprint_pro_server_api_sdk/models/confidence.py b/fingerprint_pro_server_api_sdk/models/confidence.py index 59d58170..af078d21 100644 --- a/fingerprint_pro_server_api_sdk/models/confidence.py +++ b/fingerprint_pro_server_api_sdk/models/confidence.py @@ -3,7 +3,7 @@ """ Fingerprint Pro Server API - 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 + 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. # noqa: E501 OpenAPI spec version: 3 Contact: support@fingerprint.com diff --git a/fingerprint_pro_server_api_sdk/models/error_event403_response.py b/fingerprint_pro_server_api_sdk/models/error_event403_response.py index d3b77254..77289f81 100644 --- a/fingerprint_pro_server_api_sdk/models/error_event403_response.py +++ b/fingerprint_pro_server_api_sdk/models/error_event403_response.py @@ -3,7 +3,7 @@ """ Fingerprint Pro Server API - 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 + 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. # noqa: E501 OpenAPI spec version: 3 Contact: support@fingerprint.com diff --git a/fingerprint_pro_server_api_sdk/models/error_event403_response_error.py b/fingerprint_pro_server_api_sdk/models/error_event403_response_error.py index 070f9675..4dd075c1 100644 --- a/fingerprint_pro_server_api_sdk/models/error_event403_response_error.py +++ b/fingerprint_pro_server_api_sdk/models/error_event403_response_error.py @@ -3,7 +3,7 @@ """ Fingerprint Pro Server API - 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 + 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. # noqa: E501 OpenAPI spec version: 3 Contact: support@fingerprint.com diff --git a/fingerprint_pro_server_api_sdk/models/error_event404_response.py b/fingerprint_pro_server_api_sdk/models/error_event404_response.py index 269e2938..47fbdd32 100644 --- a/fingerprint_pro_server_api_sdk/models/error_event404_response.py +++ b/fingerprint_pro_server_api_sdk/models/error_event404_response.py @@ -3,7 +3,7 @@ """ Fingerprint Pro Server API - 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 + 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. # noqa: E501 OpenAPI spec version: 3 Contact: support@fingerprint.com diff --git a/fingerprint_pro_server_api_sdk/models/error_event404_response_error.py b/fingerprint_pro_server_api_sdk/models/error_event404_response_error.py index 1d616a34..af699771 100644 --- a/fingerprint_pro_server_api_sdk/models/error_event404_response_error.py +++ b/fingerprint_pro_server_api_sdk/models/error_event404_response_error.py @@ -3,7 +3,7 @@ """ Fingerprint Pro Server API - 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 + 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. # noqa: E501 OpenAPI spec version: 3 Contact: support@fingerprint.com diff --git a/fingerprint_pro_server_api_sdk/models/error_visits403.py b/fingerprint_pro_server_api_sdk/models/error_visits403.py index 2d147667..5911fa5b 100644 --- a/fingerprint_pro_server_api_sdk/models/error_visits403.py +++ b/fingerprint_pro_server_api_sdk/models/error_visits403.py @@ -3,7 +3,7 @@ """ Fingerprint Pro Server API - 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 + 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. # noqa: E501 OpenAPI spec version: 3 Contact: support@fingerprint.com diff --git a/fingerprint_pro_server_api_sdk/models/event_response.py b/fingerprint_pro_server_api_sdk/models/event_response.py index 9936b8b0..38cfbd70 100644 --- a/fingerprint_pro_server_api_sdk/models/event_response.py +++ b/fingerprint_pro_server_api_sdk/models/event_response.py @@ -3,7 +3,7 @@ """ Fingerprint Pro Server API - 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 + 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. # noqa: E501 OpenAPI spec version: 3 Contact: support@fingerprint.com diff --git a/fingerprint_pro_server_api_sdk/models/identification_error.py b/fingerprint_pro_server_api_sdk/models/identification_error.py index b2ad6eeb..0463ec29 100644 --- a/fingerprint_pro_server_api_sdk/models/identification_error.py +++ b/fingerprint_pro_server_api_sdk/models/identification_error.py @@ -3,7 +3,7 @@ """ Fingerprint Pro Server API - 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 + 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. # noqa: E501 OpenAPI spec version: 3 Contact: support@fingerprint.com diff --git a/fingerprint_pro_server_api_sdk/models/ip_block_list_result.py b/fingerprint_pro_server_api_sdk/models/ip_block_list_result.py index 5c1c020f..9c0c0119 100644 --- a/fingerprint_pro_server_api_sdk/models/ip_block_list_result.py +++ b/fingerprint_pro_server_api_sdk/models/ip_block_list_result.py @@ -3,7 +3,7 @@ """ Fingerprint Pro Server API - 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 + 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. # noqa: E501 OpenAPI spec version: 3 Contact: support@fingerprint.com diff --git a/fingerprint_pro_server_api_sdk/models/ip_block_list_result_details.py b/fingerprint_pro_server_api_sdk/models/ip_block_list_result_details.py index 48c22a20..b2adbe6c 100644 --- a/fingerprint_pro_server_api_sdk/models/ip_block_list_result_details.py +++ b/fingerprint_pro_server_api_sdk/models/ip_block_list_result_details.py @@ -3,7 +3,7 @@ """ Fingerprint Pro Server API - 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 + 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. # noqa: E501 OpenAPI spec version: 3 Contact: support@fingerprint.com diff --git a/fingerprint_pro_server_api_sdk/models/ip_info_result.py b/fingerprint_pro_server_api_sdk/models/ip_info_result.py index 24289b27..fad894eb 100644 --- a/fingerprint_pro_server_api_sdk/models/ip_info_result.py +++ b/fingerprint_pro_server_api_sdk/models/ip_info_result.py @@ -3,7 +3,7 @@ """ Fingerprint Pro Server API - 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 + 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. # noqa: E501 OpenAPI spec version: 3 Contact: support@fingerprint.com diff --git a/fingerprint_pro_server_api_sdk/models/ip_info_result_v4.py b/fingerprint_pro_server_api_sdk/models/ip_info_result_v4.py index 686a36ec..628d81e7 100644 --- a/fingerprint_pro_server_api_sdk/models/ip_info_result_v4.py +++ b/fingerprint_pro_server_api_sdk/models/ip_info_result_v4.py @@ -3,7 +3,7 @@ """ Fingerprint Pro Server API - 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 + 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. # noqa: E501 OpenAPI spec version: 3 Contact: support@fingerprint.com diff --git a/fingerprint_pro_server_api_sdk/models/ip_info_result_v6.py b/fingerprint_pro_server_api_sdk/models/ip_info_result_v6.py index da75d8c9..90610469 100644 --- a/fingerprint_pro_server_api_sdk/models/ip_info_result_v6.py +++ b/fingerprint_pro_server_api_sdk/models/ip_info_result_v6.py @@ -3,7 +3,7 @@ """ Fingerprint Pro Server API - 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 + 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. # noqa: E501 OpenAPI spec version: 3 Contact: support@fingerprint.com diff --git a/fingerprint_pro_server_api_sdk/models/ip_location.py b/fingerprint_pro_server_api_sdk/models/ip_location.py index ae3f36c8..3a27fa60 100644 --- a/fingerprint_pro_server_api_sdk/models/ip_location.py +++ b/fingerprint_pro_server_api_sdk/models/ip_location.py @@ -3,7 +3,7 @@ """ Fingerprint Pro Server API - 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 + 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. # noqa: E501 OpenAPI spec version: 3 Contact: support@fingerprint.com @@ -63,16 +63,22 @@ def __init__(self, accuracy_radius=None, latitude=None, longitude=None, postal_c self._continent = None self._subdivisions = None self.discriminator = None - self.accuracy_radius = accuracy_radius - self.latitude = latitude - self.longitude = longitude + if accuracy_radius is not None: + self.accuracy_radius = accuracy_radius + if latitude is not None: + self.latitude = latitude + if longitude is not None: + self.longitude = longitude if postal_code is not None: self.postal_code = postal_code - self.timezone = timezone + if timezone is not None: + self.timezone = timezone if city is not None: self.city = city - self.country = country - self.continent = continent + if country is not None: + self.country = country + if continent is not None: + self.continent = continent if subdivisions is not None: self.subdivisions = subdivisions @@ -94,8 +100,6 @@ def accuracy_radius(self, accuracy_radius): :param accuracy_radius: The accuracy_radius of this IPLocation. # noqa: E501 :type: int """ - if accuracy_radius is None: - raise ValueError("Invalid value for `accuracy_radius`, must not be `None`") # noqa: E501 self._accuracy_radius = accuracy_radius @@ -117,8 +121,6 @@ def latitude(self, latitude): :param latitude: The latitude of this IPLocation. # noqa: E501 :type: float """ - if latitude is None: - raise ValueError("Invalid value for `latitude`, must not be `None`") # noqa: E501 self._latitude = latitude @@ -140,8 +142,6 @@ def longitude(self, longitude): :param longitude: The longitude of this IPLocation. # noqa: E501 :type: float """ - if longitude is None: - raise ValueError("Invalid value for `longitude`, must not be `None`") # noqa: E501 self._longitude = longitude @@ -184,8 +184,6 @@ def timezone(self, timezone): :param timezone: The timezone of this IPLocation. # noqa: E501 :type: str """ - if timezone is None: - raise ValueError("Invalid value for `timezone`, must not be `None`") # noqa: E501 self._timezone = timezone @@ -228,8 +226,6 @@ def country(self, country): :param country: The country of this IPLocation. # noqa: E501 :type: Location """ - if country is None: - raise ValueError("Invalid value for `country`, must not be `None`") # noqa: E501 self._country = country @@ -251,8 +247,6 @@ def continent(self, continent): :param continent: The continent of this IPLocation. # noqa: E501 :type: Location """ - if continent is None: - raise ValueError("Invalid value for `continent`, must not be `None`") # noqa: E501 self._continent = continent diff --git a/fingerprint_pro_server_api_sdk/models/ip_location_city.py b/fingerprint_pro_server_api_sdk/models/ip_location_city.py index 8f2d55d7..cb82e9a5 100644 --- a/fingerprint_pro_server_api_sdk/models/ip_location_city.py +++ b/fingerprint_pro_server_api_sdk/models/ip_location_city.py @@ -3,7 +3,7 @@ """ Fingerprint Pro Server API - 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 + 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. # noqa: E501 OpenAPI spec version: 3 Contact: support@fingerprint.com diff --git a/fingerprint_pro_server_api_sdk/models/location.py b/fingerprint_pro_server_api_sdk/models/location.py index c2b17193..99b9dd59 100644 --- a/fingerprint_pro_server_api_sdk/models/location.py +++ b/fingerprint_pro_server_api_sdk/models/location.py @@ -3,7 +3,7 @@ """ Fingerprint Pro Server API - 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 + 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. # noqa: E501 OpenAPI spec version: 3 Contact: support@fingerprint.com diff --git a/fingerprint_pro_server_api_sdk/models/product_error.py b/fingerprint_pro_server_api_sdk/models/product_error.py index 46b35b79..f2873363 100644 --- a/fingerprint_pro_server_api_sdk/models/product_error.py +++ b/fingerprint_pro_server_api_sdk/models/product_error.py @@ -3,7 +3,7 @@ """ Fingerprint Pro Server API - 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 + 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. # noqa: E501 OpenAPI spec version: 3 Contact: support@fingerprint.com diff --git a/fingerprint_pro_server_api_sdk/models/products_response.py b/fingerprint_pro_server_api_sdk/models/products_response.py index 90cf6092..0f4ac65b 100644 --- a/fingerprint_pro_server_api_sdk/models/products_response.py +++ b/fingerprint_pro_server_api_sdk/models/products_response.py @@ -3,7 +3,7 @@ """ Fingerprint Pro Server API - 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 + 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. # noqa: E501 OpenAPI spec version: 3 Contact: support@fingerprint.com diff --git a/fingerprint_pro_server_api_sdk/models/products_response_botd.py b/fingerprint_pro_server_api_sdk/models/products_response_botd.py index 4207fef7..c49ea392 100644 --- a/fingerprint_pro_server_api_sdk/models/products_response_botd.py +++ b/fingerprint_pro_server_api_sdk/models/products_response_botd.py @@ -3,7 +3,7 @@ """ Fingerprint Pro Server API - 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 + 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. # noqa: E501 OpenAPI spec version: 3 Contact: support@fingerprint.com diff --git a/fingerprint_pro_server_api_sdk/models/products_response_identification.py b/fingerprint_pro_server_api_sdk/models/products_response_identification.py index 05a38527..b490ba5e 100644 --- a/fingerprint_pro_server_api_sdk/models/products_response_identification.py +++ b/fingerprint_pro_server_api_sdk/models/products_response_identification.py @@ -3,7 +3,7 @@ """ Fingerprint Pro Server API - 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 + 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. # noqa: E501 OpenAPI spec version: 3 Contact: support@fingerprint.com diff --git a/fingerprint_pro_server_api_sdk/models/products_response_identification_data.py b/fingerprint_pro_server_api_sdk/models/products_response_identification_data.py index 0fb17a9e..c6e80934 100644 --- a/fingerprint_pro_server_api_sdk/models/products_response_identification_data.py +++ b/fingerprint_pro_server_api_sdk/models/products_response_identification_data.py @@ -3,7 +3,7 @@ """ Fingerprint Pro Server API - 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 + 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. # noqa: E501 OpenAPI spec version: 3 Contact: support@fingerprint.com @@ -85,7 +85,8 @@ def __init__(self, request_id=None, browser_details=None, incognito=None, ip=Non self.browser_details = browser_details self.incognito = incognito self.ip = ip - self.ip_location = ip_location + if ip_location is not None: + self.ip_location = ip_location self.timestamp = timestamp self.time = time self.url = url @@ -213,8 +214,6 @@ def ip_location(self, ip_location): :param ip_location: The ip_location of this ProductsResponseIdentificationData. # noqa: E501 :type: IPLocation """ - if ip_location is None: - raise ValueError("Invalid value for `ip_location`, must not be `None`") # noqa: E501 self._ip_location = ip_location diff --git a/fingerprint_pro_server_api_sdk/models/response.py b/fingerprint_pro_server_api_sdk/models/response.py index f00ab3a6..3d426791 100644 --- a/fingerprint_pro_server_api_sdk/models/response.py +++ b/fingerprint_pro_server_api_sdk/models/response.py @@ -3,7 +3,7 @@ """ Fingerprint Pro Server API - 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 + 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. # noqa: E501 OpenAPI spec version: 3 Contact: support@fingerprint.com @@ -105,7 +105,7 @@ def visits(self, visits): def last_timestamp(self): """Gets the last_timestamp of this Response. # noqa: E501 - When more results are available (e.g., you scanned 200 results using `limit` parameter, but a total of 600 results are available), a special `lastTimestamp` top-level attribute is added to the response. If you want to paginate the results further in the past, you should use the value of this attribute. # noqa: E501 + ⚠️ Deprecated paging attribute, please use `paginationKey` instead. Timestamp of the last visit in the current page of results. # noqa: E501 :return: The last_timestamp of this Response. # noqa: E501 :rtype: int @@ -116,7 +116,7 @@ def last_timestamp(self): def last_timestamp(self, last_timestamp): """Sets the last_timestamp of this Response. - When more results are available (e.g., you scanned 200 results using `limit` parameter, but a total of 600 results are available), a special `lastTimestamp` top-level attribute is added to the response. If you want to paginate the results further in the past, you should use the value of this attribute. # noqa: E501 + ⚠️ Deprecated paging attribute, please use `paginationKey` instead. Timestamp of the last visit in the current page of results. # noqa: E501 :param last_timestamp: The last_timestamp of this Response. # noqa: E501 :type: int @@ -128,7 +128,7 @@ def last_timestamp(self, last_timestamp): def pagination_key(self): """Gets the pagination_key of this Response. # noqa: E501 - Visit's `requestId` of the last visit in the current page. # noqa: E501 + Request ID of the last visit in the current page of results. Use this value in the following request as the `paginationKey` parameter to get the next page of results. # noqa: E501 :return: The pagination_key of this Response. # noqa: E501 :rtype: str @@ -139,7 +139,7 @@ def pagination_key(self): def pagination_key(self, pagination_key): """Sets the pagination_key of this Response. - Visit's `requestId` of the last visit in the current page. # noqa: E501 + Request ID of the last visit in the current page of results. Use this value in the following request as the `paginationKey` parameter to get the next page of results. # noqa: E501 :param pagination_key: The pagination_key of this Response. # noqa: E501 :type: str diff --git a/fingerprint_pro_server_api_sdk/models/response_visits.py b/fingerprint_pro_server_api_sdk/models/response_visits.py index 1e2e92c3..71e419f6 100644 --- a/fingerprint_pro_server_api_sdk/models/response_visits.py +++ b/fingerprint_pro_server_api_sdk/models/response_visits.py @@ -3,7 +3,7 @@ """ Fingerprint Pro Server API - 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 + 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. # noqa: E501 OpenAPI spec version: 3 Contact: support@fingerprint.com @@ -82,7 +82,8 @@ def __init__(self, request_id=None, browser_details=None, incognito=None, ip=Non self.browser_details = browser_details self.incognito = incognito self.ip = ip - self.ip_location = ip_location + if ip_location is not None: + self.ip_location = ip_location self.timestamp = timestamp self.time = time self.url = url @@ -208,8 +209,6 @@ def ip_location(self, ip_location): :param ip_location: The ip_location of this ResponseVisits. # noqa: E501 :type: IPLocation """ - if ip_location is None: - raise ValueError("Invalid value for `ip_location`, must not be `None`") # noqa: E501 self._ip_location = ip_location diff --git a/fingerprint_pro_server_api_sdk/models/seen_at.py b/fingerprint_pro_server_api_sdk/models/seen_at.py index cc8f3b3d..837f3716 100644 --- a/fingerprint_pro_server_api_sdk/models/seen_at.py +++ b/fingerprint_pro_server_api_sdk/models/seen_at.py @@ -3,7 +3,7 @@ """ Fingerprint Pro Server API - 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 + 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. # noqa: E501 OpenAPI spec version: 3 Contact: support@fingerprint.com diff --git a/fingerprint_pro_server_api_sdk/models/signal_response_emulator.py b/fingerprint_pro_server_api_sdk/models/signal_response_emulator.py index 445f6386..519aa9ea 100644 --- a/fingerprint_pro_server_api_sdk/models/signal_response_emulator.py +++ b/fingerprint_pro_server_api_sdk/models/signal_response_emulator.py @@ -3,7 +3,7 @@ """ Fingerprint Pro Server API - 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 + 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. # noqa: E501 OpenAPI spec version: 3 Contact: support@fingerprint.com diff --git a/fingerprint_pro_server_api_sdk/models/signal_response_emulator_data.py b/fingerprint_pro_server_api_sdk/models/signal_response_emulator_data.py index bc08b520..6e384638 100644 --- a/fingerprint_pro_server_api_sdk/models/signal_response_emulator_data.py +++ b/fingerprint_pro_server_api_sdk/models/signal_response_emulator_data.py @@ -3,7 +3,7 @@ """ Fingerprint Pro Server API - 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 + 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. # noqa: E501 OpenAPI spec version: 3 Contact: support@fingerprint.com diff --git a/fingerprint_pro_server_api_sdk/models/signal_response_incognito.py b/fingerprint_pro_server_api_sdk/models/signal_response_incognito.py index fa4502ff..1309428d 100644 --- a/fingerprint_pro_server_api_sdk/models/signal_response_incognito.py +++ b/fingerprint_pro_server_api_sdk/models/signal_response_incognito.py @@ -3,7 +3,7 @@ """ Fingerprint Pro Server API - 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 + 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. # noqa: E501 OpenAPI spec version: 3 Contact: support@fingerprint.com diff --git a/fingerprint_pro_server_api_sdk/models/signal_response_incognito_data.py b/fingerprint_pro_server_api_sdk/models/signal_response_incognito_data.py index 7c368091..f9bc0993 100644 --- a/fingerprint_pro_server_api_sdk/models/signal_response_incognito_data.py +++ b/fingerprint_pro_server_api_sdk/models/signal_response_incognito_data.py @@ -3,7 +3,7 @@ """ Fingerprint Pro Server API - 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 + 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. # noqa: E501 OpenAPI spec version: 3 Contact: support@fingerprint.com diff --git a/fingerprint_pro_server_api_sdk/models/signal_response_ip_blocklist.py b/fingerprint_pro_server_api_sdk/models/signal_response_ip_blocklist.py index e2c38159..5acea552 100644 --- a/fingerprint_pro_server_api_sdk/models/signal_response_ip_blocklist.py +++ b/fingerprint_pro_server_api_sdk/models/signal_response_ip_blocklist.py @@ -3,7 +3,7 @@ """ Fingerprint Pro Server API - 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 + 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. # noqa: E501 OpenAPI spec version: 3 Contact: support@fingerprint.com diff --git a/fingerprint_pro_server_api_sdk/models/signal_response_ip_info.py b/fingerprint_pro_server_api_sdk/models/signal_response_ip_info.py index a595108f..6a2ca92c 100644 --- a/fingerprint_pro_server_api_sdk/models/signal_response_ip_info.py +++ b/fingerprint_pro_server_api_sdk/models/signal_response_ip_info.py @@ -3,7 +3,7 @@ """ Fingerprint Pro Server API - 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 + 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. # noqa: E501 OpenAPI spec version: 3 Contact: support@fingerprint.com diff --git a/fingerprint_pro_server_api_sdk/models/signal_response_proxy.py b/fingerprint_pro_server_api_sdk/models/signal_response_proxy.py index 9644a53b..9219f660 100644 --- a/fingerprint_pro_server_api_sdk/models/signal_response_proxy.py +++ b/fingerprint_pro_server_api_sdk/models/signal_response_proxy.py @@ -3,7 +3,7 @@ """ Fingerprint Pro Server API - 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 + 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. # noqa: E501 OpenAPI spec version: 3 Contact: support@fingerprint.com diff --git a/fingerprint_pro_server_api_sdk/models/signal_response_proxy_data.py b/fingerprint_pro_server_api_sdk/models/signal_response_proxy_data.py index 8af7c061..fb344c53 100644 --- a/fingerprint_pro_server_api_sdk/models/signal_response_proxy_data.py +++ b/fingerprint_pro_server_api_sdk/models/signal_response_proxy_data.py @@ -3,7 +3,7 @@ """ Fingerprint Pro Server API - 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 + 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. # noqa: E501 OpenAPI spec version: 3 Contact: support@fingerprint.com diff --git a/fingerprint_pro_server_api_sdk/models/signal_response_root_apps.py b/fingerprint_pro_server_api_sdk/models/signal_response_root_apps.py index 28005d89..38877157 100644 --- a/fingerprint_pro_server_api_sdk/models/signal_response_root_apps.py +++ b/fingerprint_pro_server_api_sdk/models/signal_response_root_apps.py @@ -3,7 +3,7 @@ """ Fingerprint Pro Server API - 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 + 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. # noqa: E501 OpenAPI spec version: 3 Contact: support@fingerprint.com diff --git a/fingerprint_pro_server_api_sdk/models/signal_response_root_apps_data.py b/fingerprint_pro_server_api_sdk/models/signal_response_root_apps_data.py index a1a1c5c1..167e75e2 100644 --- a/fingerprint_pro_server_api_sdk/models/signal_response_root_apps_data.py +++ b/fingerprint_pro_server_api_sdk/models/signal_response_root_apps_data.py @@ -3,7 +3,7 @@ """ Fingerprint Pro Server API - 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 + 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. # noqa: E501 OpenAPI spec version: 3 Contact: support@fingerprint.com diff --git a/fingerprint_pro_server_api_sdk/models/signal_response_tampering.py b/fingerprint_pro_server_api_sdk/models/signal_response_tampering.py index a7fbe539..28e8f52e 100644 --- a/fingerprint_pro_server_api_sdk/models/signal_response_tampering.py +++ b/fingerprint_pro_server_api_sdk/models/signal_response_tampering.py @@ -3,7 +3,7 @@ """ Fingerprint Pro Server API - 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 + 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. # noqa: E501 OpenAPI spec version: 3 Contact: support@fingerprint.com diff --git a/fingerprint_pro_server_api_sdk/models/signal_response_tor.py b/fingerprint_pro_server_api_sdk/models/signal_response_tor.py index a048ddc7..9785258b 100644 --- a/fingerprint_pro_server_api_sdk/models/signal_response_tor.py +++ b/fingerprint_pro_server_api_sdk/models/signal_response_tor.py @@ -3,7 +3,7 @@ """ Fingerprint Pro Server API - 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 + 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. # noqa: E501 OpenAPI spec version: 3 Contact: support@fingerprint.com diff --git a/fingerprint_pro_server_api_sdk/models/signal_response_tor_data.py b/fingerprint_pro_server_api_sdk/models/signal_response_tor_data.py index ee407f04..9f71b09f 100644 --- a/fingerprint_pro_server_api_sdk/models/signal_response_tor_data.py +++ b/fingerprint_pro_server_api_sdk/models/signal_response_tor_data.py @@ -3,7 +3,7 @@ """ Fingerprint Pro Server API - 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 + 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. # noqa: E501 OpenAPI spec version: 3 Contact: support@fingerprint.com diff --git a/fingerprint_pro_server_api_sdk/models/signal_response_vpn.py b/fingerprint_pro_server_api_sdk/models/signal_response_vpn.py index c61ceaa4..095c1ac2 100644 --- a/fingerprint_pro_server_api_sdk/models/signal_response_vpn.py +++ b/fingerprint_pro_server_api_sdk/models/signal_response_vpn.py @@ -3,7 +3,7 @@ """ Fingerprint Pro Server API - 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 + 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. # noqa: E501 OpenAPI spec version: 3 Contact: support@fingerprint.com diff --git a/fingerprint_pro_server_api_sdk/models/subdivision.py b/fingerprint_pro_server_api_sdk/models/subdivision.py index 8df66eee..37ca31a7 100644 --- a/fingerprint_pro_server_api_sdk/models/subdivision.py +++ b/fingerprint_pro_server_api_sdk/models/subdivision.py @@ -3,7 +3,7 @@ """ Fingerprint Pro Server API - 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 + 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. # noqa: E501 OpenAPI spec version: 3 Contact: support@fingerprint.com diff --git a/fingerprint_pro_server_api_sdk/models/tampering_result.py b/fingerprint_pro_server_api_sdk/models/tampering_result.py index 6661df40..24d87eb7 100644 --- a/fingerprint_pro_server_api_sdk/models/tampering_result.py +++ b/fingerprint_pro_server_api_sdk/models/tampering_result.py @@ -3,7 +3,7 @@ """ Fingerprint Pro Server API - 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 + 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. # noqa: E501 OpenAPI spec version: 3 Contact: support@fingerprint.com diff --git a/fingerprint_pro_server_api_sdk/models/visit.py b/fingerprint_pro_server_api_sdk/models/visit.py index ea70005b..cb80ae19 100644 --- a/fingerprint_pro_server_api_sdk/models/visit.py +++ b/fingerprint_pro_server_api_sdk/models/visit.py @@ -3,7 +3,7 @@ """ Fingerprint Pro Server API - 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 + 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. # noqa: E501 OpenAPI spec version: 3 Contact: support@fingerprint.com @@ -82,7 +82,8 @@ def __init__(self, request_id=None, browser_details=None, incognito=None, ip=Non self.browser_details = browser_details self.incognito = incognito self.ip = ip - self.ip_location = ip_location + if ip_location is not None: + self.ip_location = ip_location self.timestamp = timestamp self.time = time self.url = url @@ -209,8 +210,6 @@ def ip_location(self, ip_location): :param ip_location: The ip_location of this Visit. # noqa: E501 :type: IPLocation """ - if ip_location is None: - raise ValueError("Invalid value for `ip_location`, must not be `None`") # noqa: E501 self._ip_location = ip_location diff --git a/fingerprint_pro_server_api_sdk/models/vpn_result.py b/fingerprint_pro_server_api_sdk/models/vpn_result.py index b6b7e4e7..73e24dc8 100644 --- a/fingerprint_pro_server_api_sdk/models/vpn_result.py +++ b/fingerprint_pro_server_api_sdk/models/vpn_result.py @@ -3,7 +3,7 @@ """ Fingerprint Pro Server API - 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 + 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. # noqa: E501 OpenAPI spec version: 3 Contact: support@fingerprint.com diff --git a/fingerprint_pro_server_api_sdk/models/vpn_result_methods.py b/fingerprint_pro_server_api_sdk/models/vpn_result_methods.py index ea28e500..87ae7eef 100644 --- a/fingerprint_pro_server_api_sdk/models/vpn_result_methods.py +++ b/fingerprint_pro_server_api_sdk/models/vpn_result_methods.py @@ -3,7 +3,7 @@ """ Fingerprint Pro Server API - 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 + 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. # noqa: E501 OpenAPI spec version: 3 Contact: support@fingerprint.com diff --git a/fingerprint_pro_server_api_sdk/models/webhook_signal_response_emulator.py b/fingerprint_pro_server_api_sdk/models/webhook_signal_response_emulator.py index b39d9ec0..3ad6a198 100644 --- a/fingerprint_pro_server_api_sdk/models/webhook_signal_response_emulator.py +++ b/fingerprint_pro_server_api_sdk/models/webhook_signal_response_emulator.py @@ -3,7 +3,7 @@ """ Fingerprint Pro Server API - 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 + 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. # noqa: E501 OpenAPI spec version: 3 Contact: support@fingerprint.com diff --git a/fingerprint_pro_server_api_sdk/models/webhook_signal_response_proxy.py b/fingerprint_pro_server_api_sdk/models/webhook_signal_response_proxy.py index 3ad22b88..3182c09b 100644 --- a/fingerprint_pro_server_api_sdk/models/webhook_signal_response_proxy.py +++ b/fingerprint_pro_server_api_sdk/models/webhook_signal_response_proxy.py @@ -3,7 +3,7 @@ """ Fingerprint Pro Server API - 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 + 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. # noqa: E501 OpenAPI spec version: 3 Contact: support@fingerprint.com diff --git a/fingerprint_pro_server_api_sdk/models/webhook_signal_response_root_apps.py b/fingerprint_pro_server_api_sdk/models/webhook_signal_response_root_apps.py index 6d17e72c..cbf4f785 100644 --- a/fingerprint_pro_server_api_sdk/models/webhook_signal_response_root_apps.py +++ b/fingerprint_pro_server_api_sdk/models/webhook_signal_response_root_apps.py @@ -3,7 +3,7 @@ """ Fingerprint Pro Server API - 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 + 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. # noqa: E501 OpenAPI spec version: 3 Contact: support@fingerprint.com diff --git a/fingerprint_pro_server_api_sdk/models/webhook_signal_response_tor.py b/fingerprint_pro_server_api_sdk/models/webhook_signal_response_tor.py index 2fa80c68..830b6acf 100644 --- a/fingerprint_pro_server_api_sdk/models/webhook_signal_response_tor.py +++ b/fingerprint_pro_server_api_sdk/models/webhook_signal_response_tor.py @@ -3,7 +3,7 @@ """ Fingerprint Pro Server API - 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 + 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. # noqa: E501 OpenAPI spec version: 3 Contact: support@fingerprint.com diff --git a/fingerprint_pro_server_api_sdk/models/webhook_visit.py b/fingerprint_pro_server_api_sdk/models/webhook_visit.py index 785fde44..7cbae90f 100644 --- a/fingerprint_pro_server_api_sdk/models/webhook_visit.py +++ b/fingerprint_pro_server_api_sdk/models/webhook_visit.py @@ -3,7 +3,7 @@ """ Fingerprint Pro Server API - 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 + 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. # noqa: E501 OpenAPI spec version: 3 Contact: support@fingerprint.com @@ -141,7 +141,8 @@ def __init__(self, visitor_id=None, client_referrer=None, user_agent=None, bot=N self.request_id = request_id self.browser_details = browser_details self.ip = ip - self.ip_location = ip_location + if ip_location is not None: + self.ip_location = ip_location self.timestamp = timestamp self.time = time self.url = url @@ -522,8 +523,6 @@ def ip_location(self, ip_location): :param ip_location: The ip_location of this WebhookVisit. # noqa: E501 :type: IPLocation """ - if ip_location is None: - raise ValueError("Invalid value for `ip_location`, must not be `None`") # noqa: E501 self._ip_location = ip_location diff --git a/fingerprint_pro_server_api_sdk/rest.py b/fingerprint_pro_server_api_sdk/rest.py index 9f9ec8f5..cd9a938a 100644 --- a/fingerprint_pro_server_api_sdk/rest.py +++ b/fingerprint_pro_server_api_sdk/rest.py @@ -3,7 +3,7 @@ """ Fingerprint Pro Server API - 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 + 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. # noqa: E501 OpenAPI spec version: 3 Contact: support@fingerprint.com diff --git a/res/fingerprint-server-api.yaml b/res/fingerprint-server-api.yaml index 4873ffbb..7ece24c4 100644 --- a/res/fingerprint-server-api.yaml +++ b/res/fingerprint-server-api.yaml @@ -1,19 +1,25 @@ openapi: 3.0.3 info: title: Fingerprint Pro Server API - description: >- + description: > 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. + 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. version: '3' contact: name: Fingerprint Support email: support@fingerprint.com tags: - name: Fingerprint + description: >- + Using the Server API you can retrieve information about individual + analysis events or event history of individual visitors. externalDocs: description: API documentation - url: https://dev.fingerprint.com/docs/server-api + url: https://dev.fingerprint.com/reference/pro-server-api servers: - url: https://api.fpjs.io description: Global @@ -24,22 +30,41 @@ servers: security: - ApiKeyHeader: [] - ApiKeyQuery: [] +x-readme: + samples-languages: + - curl + - node + - php + - python + - csharp + - java + - go paths: /events/{request_id}: get: tags: - Fingerprint - summary: Get event by requestId - description: >- - 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. operationId: getEvent + summary: Get event by requestId + description: > + This endpoint allows you to retrieve an individual analysis event with + all the information from each activated product (Identification, Bot + Detection, and others). + + Products that are not activated for your application or not relevant to + the event's detected platform (web, iOS, Android) are not included in + the response. + + + Use `requestId` as the URL path parameter. This API method is scoped to + a request, i.e. all returned information is by `requestId`. parameters: - name: request_id in: path - description: requestId is the unique identifier of each request + description: >- + The unique + [identifier](https://dev.fingerprint.com/docs/js-agent#requestid) of + each analysis request. required: true schema: type: string @@ -160,7 +185,7 @@ paths: result: false anomalyScore: 0 allErrorsResponse: - summary: Example response with all failed signals + summary: All failed signals value: products: identification: @@ -208,7 +233,7 @@ paths: code: Failed message: internal server error withBotdError: - summary: Example error response with BotD error + summary: BotD error value: products: identification: @@ -260,9 +285,7 @@ paths: code: Failed message: internal server error withBotdTooManyRequestsError: - summary: >- - Example error response with BotD error when too many - requests are sent + summary: BotD too many requests error value: products: identification: @@ -314,7 +337,7 @@ paths: code: TooManyRequests message: too many requests withIdentificationError: - summary: Example error response with identification error + summary: Identification error value: products: identification: @@ -329,9 +352,7 @@ paths: ip: 61.127.217.15 time: '2019-05-21T16:40:13Z' withIdentificationTooManyRequestsError: - summary: >- - Example error response with identification error when too - many requests are sent + summary: Identification too many requests error value: products: identification: @@ -359,7 +380,7 @@ paths: code: TokenRequired message: secret key is required '404': - description: Bad Request + description: Not found content: application/json: schema: @@ -371,43 +392,275 @@ paths: error: code: RequestNotFound message: request id is not found + x-readme: + code-samples: + - language: node + name: Node SDK + install: npm install @fingerprintjs/fingerprintjs-pro-server-api + code: | + import { + FingerprintJsServerApiClient, + Region, + } from '@fingerprintjs/fingerprintjs-pro-server-api' + + const client = new FingerprintJsServerApiClient({ + apiKey: 'SERVER_API_KEY', // Replace with your key + region: Region.Global, // Replace with your region + }) + + // Get a specific fingerprinting event + client.getEvent('REQUEST_ID').then((event) => { + console.log(event) + }) + - language: php + name: PHP SDK + install: composer require fingerprint/fingerprint-pro-server-api-sdk + code: | + getEvent("REQUEST_ID"); + echo "
" . $response->__toString() . "
"; + } catch (Exception $e) { + echo $e->getMessage(), PHP_EOL; + } + - language: python + name: Python SDK + install: pip install fingerprint_pro_server_api_sdk + code: > + import fingerprint_pro_server_api_sdk + + from fingerprint_pro_server_api_sdk import EventResponse + + from fingerprint_pro_server_api_sdk import Response + + from fingerprint_pro_server_api_sdk.rest import ApiException + + + configuration = fingerprint_pro_server_api_sdk.Configuration( + api_key="SERVER_API_KEY", // Replace with your key + region="us" // Replace with your region + ) + + api_instance = + fingerprint_pro_server_api_sdk.FingerprintApi(configuration) + + + # Get a specific fingerprinting event + + try: + event: EventResponse = api_instance.get_event("REQUEST_ID") + print(event) + except ApiException as e: + print("Exception when getting an event: %s\n" % e) + - language: golang + name: Go SDK + install: go get github.com/fingerprintjs/fingerprint-pro-server-api-go-sdk + code: | + package main + + import ( + "context" + "fmt" + "github.com/antihax/optional" + "github.com/fingerprintjs/fingerprint-pro-server-api-go-sdk/v3/sdk" + "log" + ) + + func main() { + cfg := sdk.NewConfiguration() + client := sdk.NewAPIClient(cfg) + + auth := context.WithValue( + context.Background(), + sdk.ContextAPIKey, + sdk.APIKey{Key: "SERVER_API_KEY"}, // Replace with your key + ) + cfg.ChangeRegion(sdk.RegionUS) // Replace with your region + + // Get a specific fingerprinting event + event, eventHttpRes, eventErr := + client.FingerprintApi.GetEvent(auth, "REQUEST_ID") + if eventErr != nil { + log.Fatal(eventErr) + } + fmt.Printf("Event: %s", event) + } + - language: java + name: Java SDK + code: | + import com.fingerprint.api.FingerprintApi; + import com.fingerprint.models.EventResponse; + import com.fingerprint.models.Response; + import com.fingerprint.sdk.ApiClient; + import com.fingerprint.sdk.ApiException; + import com.fingerprint.sdk.Configuration; + import com.fingerprint.sdk.Region; + + public class FingerprintApiExample { + public static void main(String... args) { + ApiClient client = Configuration.getDefaultApiClient( + "SERVER_API_KEY", // Replace with your key + Region.GLOBAL // Replace with your region + ); + FingerprintApi api = new FingerprintApi(client); + + // Get a specific fingerprinting event + try { + EventResponse response = api.getEvent("REQUEST_ID"); + System.out.println(response.getProducts().toString()); + } catch (ApiException e) { + System.err.println(e.getMessage()); + } + } + } + - language: csharp + name: C# SDK + install: dotnet add package FingerprintPro.ServerSdk + code: > + using FingerprintPro.ServerSdk.Api; + + using FingerprintPro.ServerSdk.Client; + + + var configuration = new Configuration("SERVER_API_KEY"); // + Replace with your key + + configuration.Region = Region.Us; // Replace with your region + + + var api = new FingerprintApi( + configuration + ); + + + // Get a specific fingerprinting event + + var events = api.GetEvent("REQUEST_ID"); + + Console.WriteLine(events); /visitors/{visitor_id}: get: tags: - Fingerprint operationId: getVisits summary: Get visits by visitorId - description: >- - 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. + description: > + 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. parameters: - name: visitor_id + description: Unique identifier of the visitor issued by Fingerprint Pro. in: path required: true schema: type: string example: uYIm7Ksp5rf00SllPhFp - name: request_id - description: Filter visits by requestId + description: > + 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. in: query schema: type: string - name: linked_id - description: Filter visits by custom identifier + description: > + 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. in: query schema: type: string required: false - name: limit - description: Limit scanned results + description: > + 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. in: query schema: type: integer format: int32 minimum: 0 + - name: paginationKey + description: > + 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. + in: query + schema: + type: string + required: false - name: before - description: Timestamp (in milliseconds since epoch) used to paginate results + description: > + ⚠️ Deprecated pagination method, please use `paginationKey` instead. + Timestamp (in milliseconds since epoch) used to paginate results. in: query schema: type: integer @@ -718,17 +971,6 @@ paths: botProbability: 0 incognito: false ip: 45.86.200.137 - ipLocation: - accuracyRadius: 1000 - latitude: 52.3824 - longitude: 4.8995 - timezone: Europe/Amsterdam - country: - code: NL - name: Netherlands - continent: - code: EU - name: Europe timestamp: 1655106799878 time: '2022-06-13T07:53:19Z' url: https://fingerprint.com/ @@ -761,18 +1003,6 @@ paths: accuracyRadius: 20 latitude: 44.804 longitude: 20.4651 - timezone: Europe/Belgrade - city: - name: Belgrade - country: - code: RS - name: Serbia - continent: - code: EU - name: Europe - subdivisions: - - isoCode: '00' - name: Belgrade timestamp: 1654606475413 time: '2022-06-07T12:54:35Z' url: https://fingerprintjs.com/ @@ -802,22 +1032,7 @@ paths: incognito: false ip: 188.242.36.107 ipLocation: - accuracyRadius: 5 - latitude: 59.8983 - longitude: 30.2618 - postalCode: '190924' timezone: Europe/Moscow - city: - name: St Petersburg - country: - code: RU - name: Russia - continent: - code: EU - name: Europe - subdivisions: - - isoCode: SPE - name: St.-Petersburg timestamp: 1654594677430 time: '2022-06-07T09:37:57Z' url: https://fingerprintjs.com/ @@ -3099,7 +3314,7 @@ paths: global: '2022-03-08T12:33:05.677Z' subscription: '2022-03-08T12:33:05.677Z' '403': - description: Forbidden. Probably ApiKey is missed or provided the wrong one. + description: Forbidden. The API Key is probably missing or incorrect. content: application/json: schema: @@ -3114,8 +3329,8 @@ paths: headers: Retry-After: description: >- - Indicates how long the user should wait before attempting the - next request. + Indicates how long you should wait before attempting the next + request. schema: type: integer format: int32 @@ -3129,6 +3344,171 @@ paths: summary: Example too many requests error response value: error: too many requests + x-readme: + code-samples: + - language: node + name: Node SDK + install: npm install @fingerprintjs/fingerprintjs-pro-server-api + code: | + import { + FingerprintJsServerApiClient, + Region, + } from '@fingerprintjs/fingerprintjs-pro-server-api' + + const client = new FingerprintJsServerApiClient({ + apiKey: 'SERVER_API_KEY', // Replace with your key + region: Region.Global, // Replace with your region + }) + + // Get visit history of a specific visitor + client.getVisitorHistory('VISITOR_ID').then((visitorHistory) => { + console.log(visitorHistory) + }) + - language: php + name: PHP SDK + install: composer require fingerprint/fingerprint-pro-server-api-sdk + code: | + getVisits("VISITOR_ID"); + echo "
" . $response->__toString() . "
"; + } catch (Exception $e) { + echo $e->getMessage(), PHP_EOL; + } + - language: python + name: Python SDK + install: pip install fingerprint_pro_server_api_sdk + code: > + import fingerprint_pro_server_api_sdk + + from fingerprint_pro_server_api_sdk import EventResponse + + from fingerprint_pro_server_api_sdk import Response + + from fingerprint_pro_server_api_sdk.rest import ApiException + + + configuration = fingerprint_pro_server_api_sdk.Configuration( + api_key="SERVER_API_KEY", // Replace with your key + region="us" // Replace with your region + ) + + api_instance = + fingerprint_pro_server_api_sdk.FingerprintApi(configuration) + + + # Get visit history of a specific visitor + + try: + visits: Response = api_instance.get_visits("VISITOR_ID", limit=10) + print(visits) + except ApiException as e: + print("Exception when getting visits: %s\n" % e) + - language: golang + name: Go SDK + install: go get github.com/fingerprintjs/fingerprint-pro-server-api-go-sdk + code: | + package main + + import ( + "context" + "fmt" + "github.com/antihax/optional" + "github.com/fingerprintjs/fingerprint-pro-server-api-go-sdk/v3/sdk" + "log" + ) + + func main() { + cfg := sdk.NewConfiguration() + client := sdk.NewAPIClient(cfg) + + auth := context.WithValue( + context.Background(), + sdk.ContextAPIKey, + sdk.APIKey{Key: "SERVER_API_KEY"}, // Replace with your key + ) + cfg.ChangeRegion(sdk.RegionUS) // Replace with your region + + // Get visit history of a specific visitor + getVisitsOpts := sdk.FingerprintApiGetVisitsOpts{ + Limit: optional.NewInt32(10), + } + history, historyHttpRes, historyErr := + client.FingerprintApi.GetVisits(auth, "VISITOR_ID", &getVisitsOpts) + if err != nil { + log.Fatal(err) + } + fmt.Printf("Visitor history: %s", history) + } + - language: java + name: Java SDK + code: | + import com.fingerprint.api.FingerprintApi; + import com.fingerprint.models.EventResponse; + import com.fingerprint.models.Response; + import com.fingerprint.sdk.ApiClient; + import com.fingerprint.sdk.ApiException; + import com.fingerprint.sdk.Configuration; + import com.fingerprint.sdk.Region; + + public class FingerprintApiExample { + public static void main(String... args) { + ApiClient client = Configuration.getDefaultApiClient( + "SERVER_API_KEY", // Replace with your key + Region.GLOBAL // Replace with your region + ); + FingerprintApi api = new FingerprintApi(client); + + // Get visit history of a specific visitor + try { + Response response = api.getVisits("VISITOR_ID"); + System.out.println(response.getVisits().toString()); + } catch (ApiException e) { + System.err.println(e.getMessage()); + } + } + } + - language: csharp + name: C# SDK + install: dotnet add package FingerprintPro.ServerSdk + code: > + using FingerprintPro.ServerSdk.Api; + + using FingerprintPro.ServerSdk.Client; + + + var configuration = new Configuration("SERVER_API_KEY"); // + Replace with your key + + configuration.Region = Region.Us; // Replace with your region + + + var api = new FingerprintApi( + configuration + ); + + + // Get visit history of a specific visitor + + var visits = api.GetVisits("VISITOR_ID"); + + Console.WriteLine(visits); /webhook: trace: tags: @@ -3337,7 +3717,6 @@ components: - firstSeenAt - incognito - ip - - ipLocation - lastSeenAt - requestId - time @@ -3346,17 +3725,17 @@ components: - visitorFound - tag lastTimestamp: - description: >- - When more results are available (e.g., you scanned 200 results using - `limit` parameter, but a total of 600 results are available), a - special `lastTimestamp` top-level attribute is added to the - response. If you want to paginate the results further in the past, - you should use the value of this attribute. + description: > + ⚠️ Deprecated paging attribute, please use `paginationKey` instead. + Timestamp of the last visit in the current page of results. type: integer format: int64 example: 1654815517198 paginationKey: - description: Visit's `requestId` of the last visit in the current page. + description: >- + Request ID of the last visit in the current page of results. Use + this value in the following request as the `paginationKey` parameter + to get the next page of results. type: string example: 1654815517198.azN4IZ required: @@ -3568,7 +3947,6 @@ components: - firstSeenAt - incognito - ip - - ipLocation - lastSeenAt - requestId - time @@ -3634,7 +4012,6 @@ components: - firstSeenAt - incognito - ip - - ipLocation - lastSeenAt - requestId - time @@ -3759,13 +4136,6 @@ components: type: array items: $ref: '#/components/schemas/Subdivision' - required: - - accuracyRadius - - continent - - country - - latitude - - longitude - - timezone title: IPLocation Location: type: object @@ -3874,7 +4244,6 @@ components: - firstSeenAt - incognito - ip - - ipLocation - lastSeenAt - requestId - time @@ -4011,8 +4380,8 @@ components: $ref: '#/components/schemas/ProductError' EventResponse: description: >- - Contains event from activated products - Fingerprint Pro or Bot - Detection + Contains results from all activated products - Fingerprint Pro, Bot + Detection, and others. type: object additionalProperties: false properties: diff --git a/run_checks.py b/run_checks.py index 97db14fa..5032dcbb 100644 --- a/run_checks.py +++ b/run_checks.py @@ -15,8 +15,8 @@ try: api_response: Response = api_instance.get_visits(visitor_id, limit=2) - first_response_last_timestamp = api_response.last_timestamp - api_response: Response = api_instance.get_visits(visitor_id, limit=2, before=first_response_last_timestamp) + pagination_key = api_response.pagination_key + api_response: Response = api_instance.get_visits(visitor_id, limit=2, pagination_key=pagination_key) except ApiException as e: print("Exception when calling DefaultApi->visitors_visitor_id_get: %s\n" % e) diff --git a/setup.py b/setup.py index 7db89a4b..e903f9b0 100644 --- a/setup.py +++ b/setup.py @@ -3,7 +3,7 @@ """ Fingerprint Pro Server API - 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 + 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. # noqa: E501 OpenAPI spec version: 3 Contact: support@fingerprint.com @@ -40,7 +40,7 @@ setup( name=NAME, version=VERSION, - description="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.", + description="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. ", long_description=long_description, long_description_content_type='text/markdown', license="MIT", diff --git a/test/mocks/visits_limit_500.json b/test/mocks/visits_limit_500.json index 97731075..f0451331 100644 --- a/test/mocks/visits_limit_500.json +++ b/test/mocks/visits_limit_500.json @@ -290,20 +290,6 @@ }, "incognito": false, "ip": "45.86.200.137", - "ipLocation": { - "accuracyRadius": 1000, - "latitude": 52.3824, - "longitude": 4.8995, - "timezone": "Europe/Amsterdam", - "country": { - "code": "NL", - "name": "Netherlands" - }, - "continent": { - "code": "EU", - "name": "Europe" - } - }, "timestamp": 1655106799878, "time": "2022-06-13T07:53:19Z", "url": "https://fingerprint.com/", @@ -338,25 +324,7 @@ "ipLocation": { "accuracyRadius": 20, "latitude": 44.804, - "longitude": 20.4651, - "timezone": "Europe/Belgrade", - "city": { - "name": "Belgrade" - }, - "country": { - "code": "RS", - "name": "Serbia" - }, - "continent": { - "code": "EU", - "name": "Europe" - }, - "subdivisions": [ - { - "isoCode": "00", - "name": "Belgrade" - } - ] + "longitude": 20.4651 }, "timestamp": 1654606475413, "time": "2022-06-07T12:54:35Z", @@ -390,28 +358,7 @@ "incognito": false, "ip": "188.242.36.107", "ipLocation": { - "accuracyRadius": 5, - "latitude": 59.8983, - "longitude": 30.2618, - "postalCode": "190924", - "timezone": "Europe/Moscow", - "city": { - "name": "St Petersburg" - }, - "country": { - "code": "RU", - "name": "Russia" - }, - "continent": { - "code": "EU", - "name": "Europe" - }, - "subdivisions": [ - { - "isoCode": "SPE", - "name": "St.-Petersburg" - } - ] + "timezone": "Europe/Moscow" }, "timestamp": 1654594677430, "time": "2022-06-07T09:37:57Z", @@ -3142,4 +3089,4 @@ } } ] -} \ No newline at end of file +}