OpenAPI schema sync

.changeset/calm-parents-hunt.md

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

.schema-version

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

docs/Api/FingerprintApi.md

@@ -297,13 +297,13 @@ $config
 
 $limit = 56; // int | Limit the number of events returned.
 $visitor_id = "visitor_id_example"; // string | Unique [visitor identifier](https://dev.fingerprint.com/reference/get-function#visitorid) issued by Fingerprint Pro. Filter for events matching this `visitor_id`.
-$bot = "bot_example"; // string | 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.
+$bot = "bot_example"; // string | 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.
 $ip_address = "ip_address_example"; // string | 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
 $linked_id = "linked_id_example"; // string | 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.
 $start = 789; // int | Filter events with a timestamp greater than the start time, in Unix time (milliseconds).
 $end = 789; // int | Filter events with a timestamp smaller than the end time, in Unix time (milliseconds).
 $reverse = true; // bool | Sort events in reverse timestamp order.
-$suspect = true; // bool | Filter events previously tagged as suspicious via the [Update API](https://dev.fingerprint.com/reference/updateevent).
+$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.
 
 try {
     list($model, $httpResponse) = $client->searchEvents($limit, $visitor_id, $bot, $ip_address, $linked_id, $start, $end, $reverse, $suspect);
@@ -320,13 +320,13 @@ Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **limit** | **int**| Limit the number of events returned. |
  **visitor_id** | **string**| Unique [visitor identifier](https://dev.fingerprint.com/reference/get-function#visitorid) issued by Fingerprint Pro. Filter for events matching this `visitor_id`. | [optional]
- **bot** | **string**| 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** | **string**| 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** | **string**| 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** | **string**| 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
 

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

src/Api/FingerprintApi.php

@@ -825,13 +825,13 @@ function ($e) {
      *
      * @param int    $limit      Limit the number of events returned. (required)
      * @param string $visitor_id Unique [visitor identifier](https://dev.fingerprint.com/reference/get-function#visitorid) issued by Fingerprint Pro. Filter for events matching this `visitor_id`. (optional)
-     * @param string $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. (optional)
+     * @param string $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. (optional)
      * @param string $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 (optional)
      * @param string $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. (optional)
      * @param int    $start      Filter events with a timestamp greater than the start time, in Unix time (milliseconds). (optional)
      * @param int    $end        Filter events with a timestamp smaller than the end time, in Unix time (milliseconds). (optional)
      * @param bool   $reverse    Sort events in reverse timestamp order. (optional)
-     * @param bool   $suspect    Filter events previously tagged as suspicious via the [Update API](https://dev.fingerprint.com/reference/updateevent). (optional)
+     * @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. (optional)
      *
      * @return array{ \Fingerprint\ServerAPI\Model\SearchEventsResponse|null, \Psr\Http\Message\ResponseInterface }
      *
@@ -924,13 +924,13 @@ public function searchEvents(int $limit, ?string $visitor_id = null, ?string $bo
      *
      * @param int    $limit      Limit the number of events returned. (required)
      * @param string $visitor_id Unique [visitor identifier](https://dev.fingerprint.com/reference/get-function#visitorid) issued by Fingerprint Pro. Filter for events matching this `visitor_id`. (optional)
-     * @param string $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. (optional)
+     * @param string $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. (optional)
      * @param string $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 (optional)
      * @param string $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. (optional)
      * @param int    $start      Filter events with a timestamp greater than the start time, in Unix time (milliseconds). (optional)
      * @param int    $end        Filter events with a timestamp smaller than the end time, in Unix time (milliseconds). (optional)
      * @param bool   $reverse    Sort events in reverse timestamp order. (optional)
-     * @param bool   $suspect    Filter events previously tagged as suspicious via the [Update API](https://dev.fingerprint.com/reference/updateevent). (optional)
+     * @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. (optional)
      *
      * @throws \InvalidArgumentException
      * @throws SerializationException