OpenAPI schema sync (v3.9.0)

.changeset/deprecate-504-events-search.md

@@ -0,0 +1,5 @@
+---
+'java-sdk': minor
+---
+
+**events-search**: The `504` response for the Events Search endpoint is deprecated and will no longer be generated by the Server API.

.changeset/deprecate-504-events.md

@@ -0,0 +1,5 @@
+---
+'java-sdk': minor
+---
+
+**events**: The `504` response for the Get Event endpoint is deprecated and will no longer be generated by the Server API.

.changeset/error-response-503-events-search.md

@@ -0,0 +1,5 @@
+---
+'java-sdk': minor
+---
+
+**events-search**: Add `503` Service Temporarily Unavailable response to the Events Search endpoint

.changeset/error-response-503-events.md

@@ -0,0 +1,5 @@
+---
+'java-sdk': minor
+---
+
+**events**: Add `503` Service Temporarily Unavailable response to the Get Event endpoint

.changeset/pre.json

@@ -0,0 +1,8 @@
+{
+  "mode": "pre",
+  "tag": "rc",
+  "initialVersions": {
+    "java-sdk": "8.8.0"
+  },
+  "changesets": []
+}

.schema-version

@@ -1 +1 @@
-v3.8.0
+v3.9.0

docs/DeviceDetails.md

@@ -9,7 +9,7 @@ Native, SDK-collected mobile device identification signals (manufacturer, model,
 | Name | Type | Description | Notes |
 |------------ | ------------- | ------------- | -------------|
 |**deviceManufacturer** | **String** | Raw device manufacturer string as reported by the device OS. Not normalized: casing is vendor-defined (samsung, Xiaomi, OPPO, HUAWEI). Always `Apple` on iOS. |  [optional] |
-|**deviceModel** | **String** | Raw device model identifier, as reported by the mobile OS. |  [optional] |
+|**deviceModel** | **String** | Raw device model identifier, as reported by the mobile OS. On Android, this is the vendor-defined model string (e.g., `SM-G991U`). On iOS, this is an Apple board code (e.g., `D84AP`). |  [optional] |
 |**osVersion** | **String** | Mobile operating system version. Component count is not fixed and must not be assumed by consumers: iOS always reports `major.minor.patch` (e.g. `17.4.1`), while Android's precision varies by OS era and which raw signal resolved it — `major` only (`9`, `13`) since Android 10 dropped point releases, `major.minor` (`16.1`) from Android 16 (API 36+) reintroducing a minor component, or a genuine `major.minor.patch` (`8.1.0`) on pre-Android 10 devices that shipped real point releases. Never a fabricated/zero-padded component. |  [optional] |
 
 

docs/FingerprintApi.md

@@ -202,9 +202,10 @@ Object containing optional parameters for API method. Supports a fluent interfac
 | **400** | Bad request. The event ID provided is not valid. |  -  |
 | **403** | Forbidden. Access to this API is denied. |  -  |
 | **404** | Not found. The event ID cannot be found in this workspace's data. |  -  |
-| **429** | Too Many Requests. The request is throttled. To protect service stability during rare periods of extreme load, we may return HTTP 429 responses with message `too many search requests` even if you are within your assigned rate limits.  |  -  |
+| **429** | Too Many Requests. The request is throttled.  |  -  |
 | **500** | Workspace error. |  -  |
-| **504** | Gateway Timeout. Search execution exceeded the allowed timeout window. |  -  |
+| **503** | Service Temporarily Unavailable. |  -  |
+| **504** | Gateway Timeout. |  -  |
 
 
 ## searchEvents
@@ -475,9 +476,10 @@ Object containing optional parameters for API method. Supports a fluent interfac
 | **400** | Bad request. One or more supplied search parameters are invalid, or a required parameter is missing. |  -  |
 | **403** | Forbidden. Access to this API is denied. |  -  |
 | **404** | Not found. The requested visitor does not exist in this workspace's data. |  -  |
-| **429** | Too Many Requests. The request is throttled. To protect service stability during rare periods of extreme load, we may return HTTP 429 responses with message `too many search requests` even if you are within your assigned rate limits.  |  -  |
+| **429** | Too Many Requests. The request is throttled.  |  -  |
 | **500** | Workspace error. |  -  |
-| **504** | Gateway Timeout. Search execution exceeded the allowed timeout window. |  -  |
+| **503** | Service Temporarily Unavailable. |  -  |
+| **504** | Gateway Timeout. |  -  |
 
 
 ## updateEvent

res/fingerprint-server-api.yaml

@@ -17,8 +17,7 @@ info:
     email: support@fingerprint.com
   license:
     name: MIT
-    url: >-
-      https://github.com/fingerprintjs/fingerprint-pro-server-api-openapi/blob/main/LICENSE
+    url: https://github.com/fingerprintjs/openapi/blob/main/LICENSE
 tags:
   - name: Fingerprint
     description: >-
@@ -104,12 +103,8 @@ paths:
               schema:
                 $ref: '#/components/schemas/ErrorResponse'
         '429':
-          description: >
+          description: |
             Too Many Requests. The request is throttled.
-
-            To protect service stability during rare periods of extreme load, we
-            may return HTTP 429 responses with message `too many search
-            requests` even if you are within your assigned rate limits.
           content:
             application/json:
               schema:
@@ -120,10 +115,15 @@ paths:
             application/json:
               schema:
                 $ref: '#/components/schemas/ErrorResponse'
+        '503':
+          description: Service Temporarily Unavailable.
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
         '504':
-          description: >-
-            Gateway Timeout. Search execution exceeded the allowed timeout
-            window.
+          description: Gateway Timeout.
+          x-deprecated-response: true
           content:
             application/json:
               schema:
@@ -1019,12 +1019,8 @@ paths:
               schema:
                 $ref: '#/components/schemas/ErrorResponse'
         '429':
-          description: >
+          description: |
             Too Many Requests. The request is throttled.
-
-            To protect service stability during rare periods of extreme load, we
-            may return HTTP 429 responses with message `too many search
-            requests` even if you are within your assigned rate limits.
           content:
             application/json:
               schema:
@@ -1035,10 +1031,15 @@ paths:
             application/json:
               schema:
                 $ref: '#/components/schemas/ErrorResponse'
+        '503':
+          description: Service Temporarily Unavailable.
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
         '504':
-          description: >-
-            Gateway Timeout. Search execution exceeded the allowed timeout
-            window.
+          description: Gateway Timeout.
+          x-deprecated-response: true
           content:
             application/json:
               schema:
@@ -2102,8 +2103,11 @@ components:
           type: string
           examples:
             - SM-G991U
-            - iPhone14,5
-          description: Raw device model identifier, as reported by the mobile OS.
+            - D84AP
+          description: >-
+            Raw device model identifier, as reported by the mobile OS. On
+            Android, this is the vendor-defined model string (e.g., `SM-G991U`).
+            On iOS, this is an Apple board code (e.g., `D84AP`).
         os_version:
           type: string
           examples:

scripts/sync.sh

@@ -52,6 +52,7 @@ examples=(
   'errors/409_state_not_ready.json'
   'errors/429_too_many_requests.json'
   'errors/500_internal_server_error.json'
+  'errors/503_service_unavailable.json'
 )
 
 for example in "${examples[@]}"; do

sdk/src/main/java/com/fingerprint/v4/api/FingerprintApi.java

@@ -183,9 +183,10 @@ public GetEventOptionalParams setRulesetId(String rulesetId) {
    * <tr><td> 400 </td><td> Bad request. The event ID provided is not valid. </td><td>  -  </td></tr>
    * <tr><td> 403 </td><td> Forbidden. Access to this API is denied. </td><td>  -  </td></tr>
    * <tr><td> 404 </td><td> Not found. The event ID cannot be found in this workspace&#39;s data. </td><td>  -  </td></tr>
-   * <tr><td> 429 </td><td> Too Many Requests. The request is throttled. To protect service stability during rare periods of extreme load, we may return HTTP 429 responses with message &#x60;too many search requests&#x60; even if you are within your assigned rate limits.  </td><td>  -  </td></tr>
+   * <tr><td> 429 </td><td> Too Many Requests. The request is throttled.  </td><td>  -  </td></tr>
    * <tr><td> 500 </td><td> Workspace error. </td><td>  -  </td></tr>
-   * <tr><td> 504 </td><td> Gateway Timeout. Search execution exceeded the allowed timeout window. </td><td>  -  </td></tr>
+   * <tr><td> 503 </td><td> Service Temporarily Unavailable. </td><td>  -  </td></tr>
+   * <tr><td> 504 </td><td> Gateway Timeout. </td><td>  -  </td></tr>
    * </table>
    */
   public Event getEvent(String eventId) throws ApiException {
@@ -206,9 +207,10 @@ public Event getEvent(String eventId) throws ApiException {
    * <tr><td> 400 </td><td> Bad request. The event ID provided is not valid. </td><td>  -  </td></tr>
    * <tr><td> 403 </td><td> Forbidden. Access to this API is denied. </td><td>  -  </td></tr>
    * <tr><td> 404 </td><td> Not found. The event ID cannot be found in this workspace&#39;s data. </td><td>  -  </td></tr>
-   * <tr><td> 429 </td><td> Too Many Requests. The request is throttled. To protect service stability during rare periods of extreme load, we may return HTTP 429 responses with message &#x60;too many search requests&#x60; even if you are within your assigned rate limits.  </td><td>  -  </td></tr>
+   * <tr><td> 429 </td><td> Too Many Requests. The request is throttled.  </td><td>  -  </td></tr>
    * <tr><td> 500 </td><td> Workspace error. </td><td>  -  </td></tr>
-   * <tr><td> 504 </td><td> Gateway Timeout. Search execution exceeded the allowed timeout window. </td><td>  -  </td></tr>
+   * <tr><td> 503 </td><td> Service Temporarily Unavailable. </td><td>  -  </td></tr>
+   * <tr><td> 504 </td><td> Gateway Timeout. </td><td>  -  </td></tr>
    * </table>
    */
   public Event getEvent(String eventId, GetEventOptionalParams getEventOptionalParams)
@@ -230,9 +232,10 @@ public Event getEvent(String eventId, GetEventOptionalParams getEventOptionalPar
    * <tr><td> 400 </td><td> Bad request. The event ID provided is not valid. </td><td>  -  </td></tr>
    * <tr><td> 403 </td><td> Forbidden. Access to this API is denied. </td><td>  -  </td></tr>
    * <tr><td> 404 </td><td> Not found. The event ID cannot be found in this workspace&#39;s data. </td><td>  -  </td></tr>
-   * <tr><td> 429 </td><td> Too Many Requests. The request is throttled. To protect service stability during rare periods of extreme load, we may return HTTP 429 responses with message &#x60;too many search requests&#x60; even if you are within your assigned rate limits.  </td><td>  -  </td></tr>
+   * <tr><td> 429 </td><td> Too Many Requests. The request is throttled.  </td><td>  -  </td></tr>
    * <tr><td> 500 </td><td> Workspace error. </td><td>  -  </td></tr>
-   * <tr><td> 504 </td><td> Gateway Timeout. Search execution exceeded the allowed timeout window. </td><td>  -  </td></tr>
+   * <tr><td> 503 </td><td> Service Temporarily Unavailable. </td><td>  -  </td></tr>
+   * <tr><td> 504 </td><td> Gateway Timeout. </td><td>  -  </td></tr>
    * </table>
    */
   public ApiResponse<Event> getEventWithHttpInfo(
@@ -1199,9 +1202,10 @@ public SearchEventsOptionalParams setSource(List<SearchEventsSource> source) {
    * <tr><td> 400 </td><td> Bad request. One or more supplied search parameters are invalid, or a required parameter is missing. </td><td>  -  </td></tr>
    * <tr><td> 403 </td><td> Forbidden. Access to this API is denied. </td><td>  -  </td></tr>
    * <tr><td> 404 </td><td> Not found. The requested visitor does not exist in this workspace&#39;s data. </td><td>  -  </td></tr>
-   * <tr><td> 429 </td><td> Too Many Requests. The request is throttled. To protect service stability during rare periods of extreme load, we may return HTTP 429 responses with message &#x60;too many search requests&#x60; even if you are within your assigned rate limits.  </td><td>  -  </td></tr>
+   * <tr><td> 429 </td><td> Too Many Requests. The request is throttled.  </td><td>  -  </td></tr>
    * <tr><td> 500 </td><td> Workspace error. </td><td>  -  </td></tr>
-   * <tr><td> 504 </td><td> Gateway Timeout. Search execution exceeded the allowed timeout window. </td><td>  -  </td></tr>
+   * <tr><td> 503 </td><td> Service Temporarily Unavailable. </td><td>  -  </td></tr>
+   * <tr><td> 504 </td><td> Gateway Timeout. </td><td>  -  </td></tr>
    * </table>
    */
   public EventSearch searchEvents(SearchEventsOptionalParams searchEventsOptionalParams)
@@ -1222,9 +1226,10 @@ public EventSearch searchEvents(SearchEventsOptionalParams searchEventsOptionalP
    * <tr><td> 400 </td><td> Bad request. One or more supplied search parameters are invalid, or a required parameter is missing. </td><td>  -  </td></tr>
    * <tr><td> 403 </td><td> Forbidden. Access to this API is denied. </td><td>  -  </td></tr>
    * <tr><td> 404 </td><td> Not found. The requested visitor does not exist in this workspace&#39;s data. </td><td>  -  </td></tr>
-   * <tr><td> 429 </td><td> Too Many Requests. The request is throttled. To protect service stability during rare periods of extreme load, we may return HTTP 429 responses with message &#x60;too many search requests&#x60; even if you are within your assigned rate limits.  </td><td>  -  </td></tr>
+   * <tr><td> 429 </td><td> Too Many Requests. The request is throttled.  </td><td>  -  </td></tr>
    * <tr><td> 500 </td><td> Workspace error. </td><td>  -  </td></tr>
-   * <tr><td> 504 </td><td> Gateway Timeout. Search execution exceeded the allowed timeout window. </td><td>  -  </td></tr>
+   * <tr><td> 503 </td><td> Service Temporarily Unavailable. </td><td>  -  </td></tr>
+   * <tr><td> 504 </td><td> Gateway Timeout. </td><td>  -  </td></tr>
    * </table>
    */
   public ApiResponse<EventSearch> searchEventsWithHttpInfo(

sdk/src/main/java/com/fingerprint/v4/model/DeviceDetails.java

@@ -68,7 +68,7 @@ public DeviceDetails deviceModel(@jakarta.annotation.Nullable String deviceModel
   }
 
   /**
-   * Raw device model identifier, as reported by the mobile OS.
+   * Raw device model identifier, as reported by the mobile OS. On Android, this is the vendor-defined model string (e.g., `SM-G991U`). On iOS, this is an Apple board code (e.g., `D84AP`).
    * @return deviceModel
    */
   @jakarta.annotation.Nullable

sdk/src/test/resources/mocks/errors/503_service_unavailable.json

@@ -0,0 +1,6 @@
+{
+  "error": {
+    "code": "service_unavailable",
+    "message": "service temporarily unavailable"
+  }
+}