Skip to content

Commit

Permalink
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: update OpenAPI schema
Browse files Browse the repository at this point in the history
TheUnderScorer committed Oct 7, 2024

Verified

This commit was signed with the committer’s verified signature.
dtolnay David Tolnay
1 parent a0c009b commit 4ef9771
Showing 27 changed files with 1,471 additions and 2,220 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
5 changes: 5 additions & 0 deletions .changeset/wild-oranges-feel.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'fingerprint-pro-server-api-python-sdk': minor
---

**events**: Introduce `PUT` endpoint for `/events` API
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
@@ -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)
2 changes: 1 addition & 1 deletion docs/FingerprintApi.md
Original file line number Diff line number Diff line change
@@ -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
22 changes: 0 additions & 22 deletions docs/Visit.md

This file was deleted.

1 change: 0 additions & 1 deletion fingerprint_pro_server_api_sdk/__init__.py
Original file line number Diff line number Diff line change
@@ -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
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
@@ -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)
@@ -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)
1 change: 0 additions & 1 deletion fingerprint_pro_server_api_sdk/models/__init__.py
Original file line number Diff line number Diff line change
@@ -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
407 changes: 0 additions & 407 deletions fingerprint_pro_server_api_sdk/models/visit.py

This file was deleted.

2,716 changes: 1,322 additions & 1,394 deletions res/fingerprint-server-api.yaml

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
@@ -0,0 +1,112 @@
{
"products": {
"identification": {
"error": {
"code": "429 Too Many Requests",
"message": "too many requests"
}
},
"botd": {
"error": {
"code": "TooManyRequests",
"message": "too many requests"
}
},
"rootApps": {
"error": {
"code": "TooManyRequests",
"message": "too many requests"
}
},
"emulator": {
"error": {
"code": "TooManyRequests",
"message": "too many requests"
}
},
"ipInfo": {
"error": {
"code": "TooManyRequests",
"message": "too many requests"
}
},
"ipBlocklist": {
"error": {
"code": "TooManyRequests",
"message": "too many requests"
}
},
"tor": {
"error": {
"code": "TooManyRequests",
"message": "too many requests"
}
},
"vpn": {
"error": {
"code": "TooManyRequests",
"message": "too many requests"
}
},
"proxy": {
"error": {
"code": "TooManyRequests",
"message": "too many requests"
}
},
"incognito": {
"error": {
"code": "429 Too Many Requests",
"message": "too many requests"
}
},
"tampering": {
"error": {
"code": "429 Too Many Requests",
"message": "too many requests"
}
},
"clonedApp": {
"error": {
"code": "TooManyRequests",
"message": "too many requests"
}
},
"factoryReset": {
"error": {
"code": "TooManyRequests",
"message": "too many requests"
}
},
"jailbroken": {
"error": {
"code": "TooManyRequests",
"message": "too many requests"
}
},
"frida": {
"error": {
"code": "TooManyRequests",
"message": "too many requests"
}
},
"privacySettings": {
"error": {
"code": "TooManyRequests",
"message": "too many requests"
}
},
"virtualMachine": {
"error": {
"code": "TooManyRequests",
"message": "too many requests"
}
},
"rawDeviceAttributes": {
"error": {
"code": "429 Too Many Requests",
"message": "too many requests"
}
}
}
}
310 changes: 0 additions & 310 deletions test/mocks/get_event_200_wrong_shape.json

This file was deleted.

This file was deleted.

10 changes: 10 additions & 0 deletions test/mocks/related-visitors/get_related_visitors_200.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{
"relatedVisitors": [
{
"visitorId": "NtCUJGceWX9RpvSbhvOm"
},
{
"visitorId": "25ee02iZwGxeyT0jMNkZ"
}
]
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"relatedVisitors": []
}
78 changes: 0 additions & 78 deletions test/mocks/sealed_result.json

This file was deleted.

File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
7 changes: 7 additions & 0 deletions test/mocks/update_event_multiple_fields_request.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"linkedId": "myNewLinkedId",
"tag": {
"myTag": "myNewValue"
},
"suspect": true
}
3 changes: 3 additions & 0 deletions test/mocks/update_event_one_field_request.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"linkedId": "myNewLinkedId"
}

0 comments on commit 4ef9771

Please sign in to comment.