Merge pull request #105 from fingerprintjs/feat/open-api-v2.2.1

OpenAPI schema sync

Author: TheUnderScorer

.changeset/calm-parents-hunt.md

@@ -0,0 +1,5 @@
+---
+'fingerprint-pro-server-api-python-sdk': patch
+---
+
+**events-search**: Improve parameter descriptions for `bot`, `suspect`

.changeset/pre.json

@@ -1,5 +1,5 @@
 {
-  "mode": "pre",
+  "mode": "exit",
   "tag": "rc",
   "initialVersions": {
     "fingerprint-pro-server-api-python-sdk": "8.2.1"

.schema-version

@@ -1 +1 @@
-v2.2.0
+v2.2.1

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
 

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.

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: >-