Skip to content

Commit

Permalink
Merge pull request #79 from fingerprintjs/feat/open-api-v1.2.0
Browse files Browse the repository at this point in the history
OpenAPI schema sync
  • Loading branch information
TheUnderScorer authored Oct 10, 2024
2 parents a0c009b + d66f13e commit d510a23
Show file tree
Hide file tree
Showing 33 changed files with 1,647 additions and 1,975 deletions.
5 changes: 5 additions & 0 deletions .changeset/orange-taxis-fetch.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'fingerprint-pro-server-api-python-sdk': minor
---

**visitors**: Add the confidence field to the VPN Detection Smart Signal
8 changes: 8 additions & 0 deletions .changeset/pre.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"mode": "pre",
"tag": "rc",
"initialVersions": {
"fingerprint-pro-server-api-python-sdk": "7.0.1"
},
"changesets": []
}
1 change: 1 addition & 0 deletions .schema-version
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
v1.2.0
1 change: 0 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -346,7 +346,6 @@ Class | Method | HTTP request | Description
- [VelocityIntervals](docs/VelocityIntervals.md)
- [VelocityResult](docs/VelocityResult.md)
- [VirtualMachineResult](docs/VirtualMachineResult.md)
- [Visit](docs/Visit.md)
- [VpnResult](docs/VpnResult.md)
- [VpnResultMethods](docs/VpnResultMethods.md)
- [WebhookVisit](docs/WebhookVisit.md)
Expand Down
2 changes: 1 addition & 1 deletion docs/FingerprintApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Method | HTTP request | Description
Delete data by visitor ID

Request deleting all data associated with the specified visitor ID. This API is useful for compliance with privacy regulations. All delete requests are queued: * Recent data (10 days or newer) belonging to the specified visitor will be deleted within 24 hours. * Data from older (11 days or more) identification events will be deleted after 90 days. If you are interested in using this API, please [contact our support team](https://fingerprint.com/support/) to enable it for you. Otherwise, you will receive a 403.
Request deleting all data associated with the specified visitor ID. This API is useful for compliance with privacy regulations. ### Which data is deleted? - Browser (or device) properties - Identification requests made from this browser (or device) #### Browser (or device) properties - Represents the data that Fingerprint collected from this specific browser (or device) and everything inferred and derived from it. - Upon request to delete, this data is deleted asynchronously (typically within a few minutes) and it will no longer be used to identify this browser (or device) for your [Fingerprint Application](https://dev.fingerprint.com/docs/glossary#fingerprint-application). #### Identification requests made from this browser (or device) - Fingerprint stores the identification requests made from a browser (or device) for up to 30 (or 90) days depending on your plan. To learn more, see [Data Retention](https://dev.fingerprint.com/docs/regions#data-retention). - Upon request to delete, the identification requests that were made by this browser - Within the past 10 days are deleted within 24 hrs. - Outside of 10 days are allowed to purge as per your data retention period. ### Corollary After requesting to delete a visitor ID, - If the same browser (or device) requests to identify, it will receive a different visitor ID. - If you request [`/events` API](https://dev.fingerprint.com/reference/getevent) with a `request_id` that was made outside of the 10 days, you will still receive a valid response. - If you request [`/visitors` API](https://dev.fingerprint.com/reference/getvisits) for the deleted visitor ID, the response will include identification requests that were made outside of those 10 days. ### Interested? Please [contact our support team](https://fingerprint.com/support/) to enable it for you. Otherwise, you will receive a 403.

### Example
```python
Expand Down
22 changes: 0 additions & 22 deletions docs/Visit.md

This file was deleted.

1 change: 1 addition & 0 deletions docs/VpnResult.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ Name | Type | Description | Notes
**origin_timezone** | **str** | Local timezone which is used in timezoneMismatch method. |
**origin_country** | **str** | Country of the request (only for Android SDK version >= 2.4.0, ISO 3166 format or unknown). | [optional]
**methods** | [**VpnResultMethods**](VpnResultMethods.md) | |
**confidence** | **str** | A confidence rating for the VPN detection result — \"low\", \"medium\", or \"high\". Depends on the combination of results returned from all VPN detection methods. |

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

1 change: 0 additions & 1 deletion fingerprint_pro_server_api_sdk/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,6 @@
from fingerprint_pro_server_api_sdk.models.velocity_intervals import VelocityIntervals
from fingerprint_pro_server_api_sdk.models.velocity_result import VelocityResult
from fingerprint_pro_server_api_sdk.models.virtual_machine_result import VirtualMachineResult
from fingerprint_pro_server_api_sdk.models.visit import Visit
from fingerprint_pro_server_api_sdk.models.vpn_result import VpnResult
from fingerprint_pro_server_api_sdk.models.vpn_result_methods import VpnResultMethods
from fingerprint_pro_server_api_sdk.models.webhook_visit import WebhookVisit
Expand Down
4 changes: 2 additions & 2 deletions fingerprint_pro_server_api_sdk/api/fingerprint_api.py
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ def __init__(self, configuration: Optional[Configuration] = None, pool: Optional
def delete_visitor_data(self, visitor_id: str, **kwargs) -> Union[None, AsyncResult[None]]: # noqa: E501
"""Delete data by visitor ID # noqa: E501
Request deleting all data associated with the specified visitor ID. This API is useful for compliance with privacy regulations. All delete requests are queued: * Recent data (10 days or newer) belonging to the specified visitor will be deleted within 24 hours. * Data from older (11 days or more) identification events will be deleted after 90 days. If you are interested in using this API, please [contact our support team](https://fingerprint.com/support/) to enable it for you. Otherwise, you will receive a 403. # noqa: E501
Request deleting all data associated with the specified visitor ID. This API is useful for compliance with privacy regulations. ### Which data is deleted? - Browser (or device) properties - Identification requests made from this browser (or device) #### Browser (or device) properties - Represents the data that Fingerprint collected from this specific browser (or device) and everything inferred and derived from it. - Upon request to delete, this data is deleted asynchronously (typically within a few minutes) and it will no longer be used to identify this browser (or device) for your [Fingerprint Application](https://dev.fingerprint.com/docs/glossary#fingerprint-application). #### Identification requests made from this browser (or device) - Fingerprint stores the identification requests made from a browser (or device) for up to 30 (or 90) days depending on your plan. To learn more, see [Data Retention](https://dev.fingerprint.com/docs/regions#data-retention). - Upon request to delete, the identification requests that were made by this browser - Within the past 10 days are deleted within 24 hrs. - Outside of 10 days are allowed to purge as per your data retention period. ### Corollary After requesting to delete a visitor ID, - If the same browser (or device) requests to identify, it will receive a different visitor ID. - If you request [`/events` API](https://dev.fingerprint.com/reference/getevent) with a `request_id` that was made outside of the 10 days, you will still receive a valid response. - If you request [`/visitors` API](https://dev.fingerprint.com/reference/getvisits) for the deleted visitor ID, the response will include identification requests that were made outside of those 10 days. ### Interested? Please [contact our support team](https://fingerprint.com/support/) to enable it for you. Otherwise, you will receive a 403. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.delete_visitor_data(visitor_id, async_req=True)
Expand All @@ -70,7 +70,7 @@ def delete_visitor_data(self, visitor_id: str, **kwargs) -> Union[None, AsyncRes
def delete_visitor_data_with_http_info(self, visitor_id: str, **kwargs): # noqa: E501
"""Delete data by visitor ID # noqa: E501
Request deleting all data associated with the specified visitor ID. This API is useful for compliance with privacy regulations. All delete requests are queued: * Recent data (10 days or newer) belonging to the specified visitor will be deleted within 24 hours. * Data from older (11 days or more) identification events will be deleted after 90 days. If you are interested in using this API, please [contact our support team](https://fingerprint.com/support/) to enable it for you. Otherwise, you will receive a 403. # noqa: E501
Request deleting all data associated with the specified visitor ID. This API is useful for compliance with privacy regulations. ### Which data is deleted? - Browser (or device) properties - Identification requests made from this browser (or device) #### Browser (or device) properties - Represents the data that Fingerprint collected from this specific browser (or device) and everything inferred and derived from it. - Upon request to delete, this data is deleted asynchronously (typically within a few minutes) and it will no longer be used to identify this browser (or device) for your [Fingerprint Application](https://dev.fingerprint.com/docs/glossary#fingerprint-application). #### Identification requests made from this browser (or device) - Fingerprint stores the identification requests made from a browser (or device) for up to 30 (or 90) days depending on your plan. To learn more, see [Data Retention](https://dev.fingerprint.com/docs/regions#data-retention). - Upon request to delete, the identification requests that were made by this browser - Within the past 10 days are deleted within 24 hrs. - Outside of 10 days are allowed to purge as per your data retention period. ### Corollary After requesting to delete a visitor ID, - If the same browser (or device) requests to identify, it will receive a different visitor ID. - If you request [`/events` API](https://dev.fingerprint.com/reference/getevent) with a `request_id` that was made outside of the 10 days, you will still receive a valid response. - If you request [`/visitors` API](https://dev.fingerprint.com/reference/getvisits) for the deleted visitor ID, the response will include identification requests that were made outside of those 10 days. ### Interested? Please [contact our support team](https://fingerprint.com/support/) to enable it for you. Otherwise, you will receive a 403. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.delete_visitor_data_with_http_info(visitor_id, async_req=True)
Expand Down
1 change: 0 additions & 1 deletion fingerprint_pro_server_api_sdk/models/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,6 @@
from fingerprint_pro_server_api_sdk.models.velocity_intervals import VelocityIntervals
from fingerprint_pro_server_api_sdk.models.velocity_result import VelocityResult
from fingerprint_pro_server_api_sdk.models.virtual_machine_result import VirtualMachineResult
from fingerprint_pro_server_api_sdk.models.visit import Visit
from fingerprint_pro_server_api_sdk.models.vpn_result import VpnResult
from fingerprint_pro_server_api_sdk.models.vpn_result_methods import VpnResultMethods
from fingerprint_pro_server_api_sdk.models.webhook_visit import WebhookVisit
Loading

0 comments on commit d510a23

Please sign in to comment.