From 8a336e3ce379e1a82aa8789adc0529c1e3ebe204 Mon Sep 17 00:00:00 2001 From: TheUnderScorer Date: Mon, 24 Feb 2025 14:43:17 +0000 Subject: [PATCH 1/2] feat: update OpenAPI schema --- .changeset/calm-parents-hunt.md | 5 +++++ .schema-version | 2 +- docs/FingerprintApi.md | 8 ++++---- .../api/fingerprint_api.py | 8 ++++---- res/fingerprint-server-api.yaml | 15 ++++++++++----- 5 files changed, 24 insertions(+), 14 deletions(-) create mode 100644 .changeset/calm-parents-hunt.md diff --git a/.changeset/calm-parents-hunt.md b/.changeset/calm-parents-hunt.md new file mode 100644 index 00000000..7bc7ea5b --- /dev/null +++ b/.changeset/calm-parents-hunt.md @@ -0,0 +1,5 @@ +--- +'fingerprint-pro-server-api-python-sdk': patch +--- + +**events-search**: Improve parameter descriptions for `bot`, `suspect` \ No newline at end of file diff --git a/.schema-version b/.schema-version index cf2dc0bc..55540107 100644 --- a/.schema-version +++ b/.schema-version @@ -1 +1 @@ -v2.2.0 \ No newline at end of file +v2.2.1 \ No newline at end of file diff --git a/docs/FingerprintApi.md b/docs/FingerprintApi.md index 7be00f20..ceefb585 100644 --- a/docs/FingerprintApi.md +++ b/docs/FingerprintApi.md @@ -241,13 +241,13 @@ api_instance = fingerprint_pro_server_api_sdk.FingerprintApi(configuration) limit = 56 # int | Limit the number of events returned. visitor_id = 'visitor_id_example' # str | Unique [visitor identifier](https://dev.fingerprint.com/reference/get-function#visitorid) issued by Fingerprint Pro. Filter for events matching this `visitor_id`. (optional) -bot = 'bot_example' # str | Filter events by the bot detection result, specifically: - events where any kind of bot was detected. - events where a good bot was detected. - events where a bad bot was detected. - events where no bot was detected. (optional) +bot = 'bot_example' # str | Filter events by the bot detection result, specifically: `all` - events where any kind of bot was detected. `good` - events where a good bot was detected. `bad` - events where a bad bot was detected. `none` - events where no bot was detected. (optional) ip_address = 'ip_address_example' # str | Filter events by IP address range. The range can be as specific as a single IP (/32 for IPv4 or /128 for IPv6) All ip_address filters must use CIDR notation, for example, 10.0.0.0/24, 192.168.0.1/32 (optional) linked_id = 'linked_id_example' # str | Filter events by your custom identifier. You can use [linked IDs](https://dev.fingerprint.com/reference/get-function#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) start = 789 # int | Filter events with a timestamp greater than the start time, in Unix time (milliseconds). (optional) end = 789 # int | Filter events with a timestamp smaller than the end time, in Unix time (milliseconds). (optional) reverse = true # bool | Sort events in reverse timestamp order. (optional) -suspect = true # bool | Filter events previously tagged as suspicious via the [Update API](https://dev.fingerprint.com/reference/updateevent). (optional) +suspect = true # bool | Filter events previously tagged as suspicious via the [Update API](https://dev.fingerprint.com/reference/updateevent). > Note: When using this parameter, only events with the `suspect` property explicitly set to `true` or `false` are returned. Events with undefined `suspect` property are left out of the response. (optional) try: # Get events via search @@ -263,13 +263,13 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **limit** | **int**| Limit the number of events returned. | **visitor_id** | **str**| Unique [visitor identifier](https://dev.fingerprint.com/reference/get-function#visitorid) issued by Fingerprint Pro. Filter for events matching this `visitor_id`. | [optional] - **bot** | **str**| Filter events by the bot detection result, specifically: - events where any kind of bot was detected. - events where a good bot was detected. - events where a bad bot was detected. - events where no bot was detected. | [optional] + **bot** | **str**| Filter events by the bot detection result, specifically: `all` - events where any kind of bot was detected. `good` - events where a good bot was detected. `bad` - events where a bad bot was detected. `none` - events where no bot was detected. | [optional] **ip_address** | **str**| Filter events by IP address range. The range can be as specific as a single IP (/32 for IPv4 or /128 for IPv6) All ip_address filters must use CIDR notation, for example, 10.0.0.0/24, 192.168.0.1/32 | [optional] **linked_id** | **str**| Filter events by your custom identifier. You can use [linked IDs](https://dev.fingerprint.com/reference/get-function#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] **start** | **int**| Filter events with a timestamp greater than the start time, in Unix time (milliseconds). | [optional] **end** | **int**| Filter events with a timestamp smaller than the end time, in Unix time (milliseconds). | [optional] **reverse** | **bool**| Sort events in reverse timestamp order. | [optional] - **suspect** | **bool**| Filter events previously tagged as suspicious via the [Update API](https://dev.fingerprint.com/reference/updateevent). | [optional] + **suspect** | **bool**| Filter events previously tagged as suspicious via the [Update API](https://dev.fingerprint.com/reference/updateevent). > Note: When using this parameter, only events with the `suspect` property explicitly set to `true` or `false` are returned. Events with undefined `suspect` property are left out of the response. | [optional] ### Return type diff --git a/fingerprint_pro_server_api_sdk/api/fingerprint_api.py b/fingerprint_pro_server_api_sdk/api/fingerprint_api.py index b69a7a37..e74d6815 100644 --- a/fingerprint_pro_server_api_sdk/api/fingerprint_api.py +++ b/fingerprint_pro_server_api_sdk/api/fingerprint_api.py @@ -508,13 +508,13 @@ def search_events(self, limit: int, **kwargs) -> Union[SearchEventsResponse, Asy :param async_req bool :param limit: Limit the number of events returned. (required) :param visitor_id: Unique [visitor identifier](https://dev.fingerprint.com/reference/get-function#visitorid) issued by Fingerprint Pro. Filter for events matching this `visitor_id`. - :param bot: Filter events by the bot detection result, specifically: - events where any kind of bot was detected. - events where a good bot was detected. - events where a bad bot was detected. - events where no bot was detected. + :param bot: Filter events by the bot detection result, specifically: `all` - events where any kind of bot was detected. `good` - events where a good bot was detected. `bad` - events where a bad bot was detected. `none` - events where no bot was detected. :param ip_address: Filter events by IP address range. The range can be as specific as a single IP (/32 for IPv4 or /128 for IPv6) All ip_address filters must use CIDR notation, for example, 10.0.0.0/24, 192.168.0.1/32 :param linked_id: Filter events by your custom identifier. You can use [linked IDs](https://dev.fingerprint.com/reference/get-function#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 start: Filter events with a timestamp greater than the start time, in Unix time (milliseconds). :param end: Filter events with a timestamp smaller than the end time, in Unix time (milliseconds). :param reverse: Sort events in reverse timestamp order. - :param suspect: Filter events previously tagged as suspicious via the [Update API](https://dev.fingerprint.com/reference/updateevent). + :param suspect: Filter events previously tagged as suspicious via the [Update API](https://dev.fingerprint.com/reference/updateevent). > Note: When using this parameter, only events with the `suspect` property explicitly set to `true` or `false` are returned. Events with undefined `suspect` property are left out of the response. :return: SearchEventsResponse If the method is called asynchronously, returns the request thread. @@ -538,13 +538,13 @@ def search_events_with_http_info(self, limit: int, **kwargs): # noqa: E501 :param async_req bool :param int limit: Limit the number of events returned. (required) :param str visitor_id: Unique [visitor identifier](https://dev.fingerprint.com/reference/get-function#visitorid) issued by Fingerprint Pro. Filter for events matching this `visitor_id`. - :param str bot: Filter events by the bot detection result, specifically: - events where any kind of bot was detected. - events where a good bot was detected. - events where a bad bot was detected. - events where no bot was detected. + :param str bot: Filter events by the bot detection result, specifically: `all` - events where any kind of bot was detected. `good` - events where a good bot was detected. `bad` - events where a bad bot was detected. `none` - events where no bot was detected. :param str ip_address: Filter events by IP address range. The range can be as specific as a single IP (/32 for IPv4 or /128 for IPv6) All ip_address filters must use CIDR notation, for example, 10.0.0.0/24, 192.168.0.1/32 :param str linked_id: Filter events by your custom identifier. You can use [linked IDs](https://dev.fingerprint.com/reference/get-function#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 start: Filter events with a timestamp greater than the start time, in Unix time (milliseconds). :param int end: Filter events with a timestamp smaller than the end time, in Unix time (milliseconds). :param bool reverse: Sort events in reverse timestamp order. - :param bool suspect: Filter events previously tagged as suspicious via the [Update API](https://dev.fingerprint.com/reference/updateevent). + :param bool suspect: Filter events previously tagged as suspicious via the [Update API](https://dev.fingerprint.com/reference/updateevent). > Note: When using this parameter, only events with the `suspect` property explicitly set to `true` or `false` are returned. Events with undefined `suspect` property are left out of the response. :return: SearchEventsResponse If the method is called asynchronously, returns the request thread. diff --git a/res/fingerprint-server-api.yaml b/res/fingerprint-server-api.yaml index fd40920f..6948fbcd 100644 --- a/res/fingerprint-server-api.yaml +++ b/res/fingerprint-server-api.yaml @@ -189,10 +189,10 @@ paths: - none description: | Filter events by the bot detection result, specifically: - - events where any kind of bot was detected. - - events where a good bot was detected. - - events where a bad bot was detected. - - events where no bot was detected. + `all` - events where any kind of bot was detected. + `good` - events where a good bot was detected. + `bad` - events where a bad bot was detected. + `none` - events where no bot was detected. - name: ip_address in: query schema: @@ -245,7 +245,11 @@ paths: type: boolean description: > Filter events previously tagged as suspicious via the [Update - API](https://dev.fingerprint.com/reference/updateevent). + API](https://dev.fingerprint.com/reference/updateevent). + + > Note: When using this parameter, only events with the `suspect` + property explicitly set to `true` or `false` are returned. Events + with undefined `suspect` property are left out of the response. responses: '200': description: Events matching the filter(s). @@ -1999,6 +2003,7 @@ components: suspect: type: boolean description: Suspect flag indicating observed suspicious or fraudulent event + x-go-skip-omitempty: true SearchEventsResponse: type: object description: >- From 5d24075a3a0fe7127fe919c293738b70fda787f2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Przemys=C5=82aw=20=C5=BBydek?= Date: Thu, 27 Feb 2025 12:22:30 +0100 Subject: [PATCH 2/2] build: exit pre-release mode --- .changeset/pre.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.changeset/pre.json b/.changeset/pre.json index 3bab18ea..edf09c18 100644 --- a/.changeset/pre.json +++ b/.changeset/pre.json @@ -1,5 +1,5 @@ { - "mode": "pre", + "mode": "exit", "tag": "rc", "initialVersions": { "fingerprint-pro-server-api-python-sdk": "8.2.1"