OpenAPI schema sync (v3.6.0)

.changeset/add-event-source-field.md

@@ -0,0 +1,5 @@
+---
+'@fingerprint/php-sdk': minor
+---
+
+Add `source` field to `Event` and `EdgeResponse` to identify how the event was generated (`device` or `edge`)

.changeset/add-labels-v3.md

@@ -0,0 +1,5 @@
+---
+'@fingerprint/php-sdk': patch
+---
+
+**events**: Add `labels` signal to v3 schema

.openapi-generator/FILES

@@ -17,6 +17,7 @@ docs/Model/EventRuleAction.md
 docs/Model/EventRuleActionAllow.md
 docs/Model/EventRuleActionBlock.md
 docs/Model/EventSearch.md
+docs/Model/EventSource.md
 docs/Model/EventUpdate.md
 docs/Model/FontPreferences.md
 docs/Model/Geolocation.md
@@ -82,6 +83,7 @@ src/Model/EventRuleAction.php
 src/Model/EventRuleActionAllow.php
 src/Model/EventRuleActionBlock.php
 src/Model/EventSearch.php
+src/Model/EventSource.php
 src/Model/EventUpdate.php
 src/Model/FontPreferences.php
 src/Model/Geolocation.php
@@ -135,3 +137,4 @@ src/Sealed/Sealed.php
 src/Sealed/UnsealAggregateException.php
 src/Sealed/UnsealException.php
 src/Webhook/WebhookVerifier.php
+test/Model/EventSourceTest.php

.schema-version

@@ -1 +1 @@
-v3.5.1
+v3.6.0

README.md

@@ -263,6 +263,7 @@ Class | Method | HTTP request | Description
  - [EventRuleActionAllow](docs/Model/EventRuleActionAllow.md)
  - [EventRuleActionBlock](docs/Model/EventRuleActionBlock.md)
  - [EventSearch](docs/Model/EventSearch.md)
+ - [EventSource](docs/Model/EventSource.md)
  - [EventUpdate](docs/Model/EventUpdate.md)
  - [FontPreferences](docs/Model/FontPreferences.md)
  - [Geolocation](docs/Model/Geolocation.md)

docs/Model/Event.md

@@ -8,6 +8,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **event_id** | **string** | Unique identifier of the user's request. The first portion of the event_id is a unix epoch milliseconds timestamp. |
 **timestamp** | **int** | Timestamp of the event with millisecond precision in Unix time. |
+**source** | [**\Fingerprint\ServerSdk\Model\EventSource**](EventSource.md) |  | [optional]
 **incremental_identification_status** | [**\Fingerprint\ServerSdk\Model\IncrementalIdentificationStatus**](IncrementalIdentificationStatus.md) |  | [optional]
 **linked_id** | **string** | A customer-provided id that was sent with the request. | [optional]
 **environment_id** | **string** | Environment Id of the event. | [optional]

docs/Model/EventSource.md

@@ -0,0 +1,15 @@
+# EventSource Enum
+
+Identifies how the event was generated.
+- `device` - the event was generated by the JS agent or a mobile SDK running on an end-user device.
+- `edge` - the event was generated by the Automation Intelligence API (`/edge` endpoint), analyzing a request intercepted at the edge.
+
+
+## Values
+
+| Name | Value | Description |
+| --- | --- | --- |
+DEVICE | 'device' |  |
+EDGE | 'edge' |  |
+
+[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

res/fingerprint-server-api.yaml

@@ -1164,6 +1164,19 @@ components:
       format: int64
       examples:
         - 1708102555327
+    EventSource:
+      type: string
+      description: >
+        Identifies how the event was generated.
+
+        - `device` - the event was generated by the JS agent or a mobile SDK
+        running on an end-user device.
+
+        - `edge` - the event was generated by the Automation Intelligence API
+        (`/edge` endpoint), analyzing a request intercepted at the edge.
+      enum:
+        - device
+        - edge
     Url:
       type: string
       examples:
@@ -3070,6 +3083,12 @@ components:
             - android
             - ios
             - browser
+        source:
+          $ref: '#/components/schemas/EventSource'
+          x-platforms:
+            - android
+            - ios
+            - browser
         incremental_identification_status:
           $ref: '#/components/schemas/IncrementalIdentificationStatus'
           x-platforms:

src/Model/Event.php

@@ -65,6 +65,7 @@ class Event implements ModelInterface, \ArrayAccess, \JsonSerializable
     protected static array $openAPITypes = [
         'event_id' => 'string',
         'timestamp' => 'int',
+        'source' => '\Fingerprint\ServerSdk\Model\EventSource',
         'incremental_identification_status' => '\Fingerprint\ServerSdk\Model\IncrementalIdentificationStatus',
         'linked_id' => 'string',
         'environment_id' => 'string',
@@ -141,6 +142,7 @@ class Event implements ModelInterface, \ArrayAccess, \JsonSerializable
     protected static array $openAPIFormats = [
         'event_id' => null,
         'timestamp' => 'int64',
+        'source' => null,
         'incremental_identification_status' => null,
         'linked_id' => null,
         'environment_id' => null,
@@ -213,6 +215,7 @@ class Event implements ModelInterface, \ArrayAccess, \JsonSerializable
     protected static array $openAPINullables = [
         'event_id' => false,
         'timestamp' => false,
+        'source' => false,
         'incremental_identification_status' => false,
         'linked_id' => false,
         'environment_id' => false,
@@ -293,6 +296,7 @@ class Event implements ModelInterface, \ArrayAccess, \JsonSerializable
     protected static array $attributeMap = [
         'event_id' => 'event_id',
         'timestamp' => 'timestamp',
+        'source' => 'source',
         'incremental_identification_status' => 'incremental_identification_status',
         'linked_id' => 'linked_id',
         'environment_id' => 'environment_id',
@@ -365,6 +369,7 @@ class Event implements ModelInterface, \ArrayAccess, \JsonSerializable
     protected static array $setters = [
         'event_id' => 'setEventId',
         'timestamp' => 'setTimestamp',
+        'source' => 'setSource',
         'incremental_identification_status' => 'setIncrementalIdentificationStatus',
         'linked_id' => 'setLinkedId',
         'environment_id' => 'setEnvironmentId',
@@ -437,6 +442,7 @@ class Event implements ModelInterface, \ArrayAccess, \JsonSerializable
     protected static array $getters = [
         'event_id' => 'getEventId',
         'timestamp' => 'getTimestamp',
+        'source' => 'getSource',
         'incremental_identification_status' => 'getIncrementalIdentificationStatus',
         'linked_id' => 'getLinkedId',
         'environment_id' => 'getEnvironmentId',
@@ -518,6 +524,7 @@ public function __construct(?array $data = null)
     {
         $this->setIfExists('event_id', $data ?? [], null);
         $this->setIfExists('timestamp', $data ?? [], null);
+        $this->setIfExists('source', $data ?? [], null);
         $this->setIfExists('incremental_identification_status', $data ?? [], null);
         $this->setIfExists('linked_id', $data ?? [], null);
         $this->setIfExists('environment_id', $data ?? [], null);
@@ -771,6 +778,28 @@ public function setTimestamp(int $timestamp): self
         return $this;
     }
 
+    /**
+     * Gets source.
+     *
+     */
+    public function getSource(): EventSource|string|null
+    {
+        return $this->container['source'];
+    }
+
+    /**
+     * Sets source.
+     *
+     * @param EventSource|string $source source
+     *
+     */
+    public function setSource(EventSource|string $source): self
+    {
+        $this->container['source'] = $source;
+
+        return $this;
+    }
+
     /**
      * Gets incremental_identification_status.
      *

src/Model/EventSource.php

@@ -0,0 +1,52 @@
+<?php
+
+/**
+ * EventSource.
+ *
+ * @category Enum
+ *
+ * @author   Fingerprint
+ *
+ * @see      https://fingerprint.com
+ */
+
+/**
+ * Server API.
+ *
+ * Fingerprint Server API allows you to get, search, and update Events in a server environment. It can be used for data exports, decision-making, and data analysis scenarios. Server API is intended for server-side usage, it's not intended to be used from the client side, whether it's a browser or a mobile device. The API also supports collection of Automation Intelligence for requests to your server in edge, pre-origin, or middleware contexts.
+ *
+ * The version of the OpenAPI document: 4
+ * Contact: support@fingerprint.com
+ * Generated by: https://openapi-generator.tech
+ * Generator version: 7.23.0
+ */
+
+/**
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+namespace Fingerprint\ServerSdk\Model;
+
+/**
+ * Identifies how the event was generated.
+ * - `device` - the event was generated by the JS agent or a mobile SDK running on an end-user device.
+ * - `edge` - the event was generated by the Automation Intelligence API (`/edge` endpoint), analyzing a request intercepted at the edge.
+ *
+ * @category Enum
+ *
+ * @description Identifies how the event was generated. - &#x60;device&#x60; - the event was generated by the JS agent or a mobile SDK running on an end-user device. - &#x60;edge&#x60; - the event was generated by the Automation Intelligence API (&#x60;/edge&#x60; endpoint), analyzing a request intercepted at the edge.
+ *
+ * @author   Fingerprint
+ *
+ * @see      https://fingerprint.com
+ *
+ * @noinspection GrazieInspection
+ * @noinspection RedundantSuppression
+ */
+enum EventSource: string
+{
+    case DEVICE = 'device';
+    case EDGE = 'edge';
+}

test/Model/EventSourceTest.php

@@ -0,0 +1,81 @@
+<?php
+
+/**
+ * EventSourceTest.
+ *
+ * PHP version 8.1
+ *
+ * @category Class
+ *
+ * @author   OpenAPI Generator team
+ *
+ * @see     https://openapi-generator.tech
+ */
+
+/**
+ * Server API.
+ *
+ * Fingerprint Server API allows you to get, search, and update Events in a server environment. It can be used for data exports, decision-making, and data analysis scenarios. Server API is intended for server-side usage, it's not intended to be used from the client side, whether it's a browser or a mobile device. The API also supports collection of Automation Intelligence for requests to your server in edge, pre-origin, or middleware contexts.
+ *
+ * The version of the OpenAPI document: 4
+ * Contact: support@fingerprint.com
+ * Generated by: https://openapi-generator.tech
+ * Generator version: 7.23.0
+ */
+
+/**
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Please update the test case below to test the model.
+ */
+
+namespace Fingerprint\ServerSdk\Test\Model;
+
+use PHPUnit\Framework\TestCase;
+
+/**
+ * EventSourceTest Class Doc Comment.
+ *
+ * @category    Class
+ *
+ * @description Identifies how the event was generated. - &#x60;device&#x60; - the event was generated by the JS agent or a mobile SDK running on an end-user device. - &#x60;edge&#x60; - the event was generated by the Automation Intelligence API (&#x60;/edge&#x60; endpoint), analyzing a request intercepted at the edge.
+ *
+ * @author      OpenAPI Generator team
+ *
+ * @see        https://openapi-generator.tech
+ *
+ * @internal
+ *
+ * @coversNothing
+ */
+class EventSourceTest extends TestCase
+{
+    /**
+     * Setup before running any test case.
+     */
+    public static function setUpBeforeClass(): void {}
+
+    /**
+     * Clean up after running all test cases.
+     */
+    public static function tearDownAfterClass(): void {}
+
+    /**
+     * Setup before running each test case.
+     */
+    public function setUp(): void {}
+
+    /**
+     * Clean up after running each test case.
+     */
+    public function tearDown(): void {}
+
+    /**
+     * Test "EventSource".
+     */
+    public function testEventSource()
+    {
+        // TODO: implement
+        self::markTestIncomplete('Not implemented');
+    }
+}

test/mocks/errors/400_edge_ip_required.json

@@ -0,0 +1,6 @@
+{
+  "error": {
+    "code": "request_cannot_be_parsed",
+    "message": "at least one of ipv4_address or ipv6_address is required"
+  }
+}

test/mocks/errors/400_edge_unknown_field.json

@@ -0,0 +1,6 @@
+{
+  "error": {
+    "code": "request_cannot_be_parsed",
+    "message": "request body contains an unknown field \"unknown\""
+  }
+}

test/mocks/errors/400_request_read_timeout.json

@@ -0,0 +1,6 @@
+{
+  "error": {
+    "code": "request_read_timeout",
+    "message": "request read timeout"
+  }
+}

test/mocks/errors/413_payload_too_large.json

@@ -0,0 +1,6 @@
+{
+  "error": {
+    "code": "payload_too_large",
+    "message": "payload too large"
+  }
+}

test/mocks/errors/429_too_many_search_requests.json

@@ -0,0 +1,6 @@
+{
+  "error": {
+    "code": "too_many_requests",
+    "message": "too many search requests"
+  }
+}

test/mocks/events/get_event_200.json

@@ -3,6 +3,7 @@
   "tags": {},
   "timestamp": 1708102555327,
   "event_id": "1708102555327.NLOjmg",
+  "source": "device",
   "incremental_identification_status": "completed",
   "url": "https://www.example.com/login?hope{this{works[!",
   "ip_address": "61.127.217.15",

test/mocks/events/get_event_200_with_unknown_field.json

@@ -3,6 +3,7 @@
   "tags": {},
   "timestamp": 1708102555327,
   "event_id": "1708102555327.NLOjmg",
+  "source": "device",
   "incremental_identification_status": "completed",
   "url": "https://www.example.com/login?hope{this{works[!",
   "ip_address": "61.127.217.15",

test/mocks/events/get_event_ruleset_200.json

@@ -3,6 +3,7 @@
   "tags": {},
   "timestamp": 1708102555327,
   "event_id": "1708102555327.NLOjmg",
+  "source": "device",
   "incremental_identification_status": "completed",
   "url": "https://www.example.com/login?hope{this{works[!",
   "ip_address": "61.127.217.15",

test/mocks/events/get_event_with_bot_info_200.json

@@ -3,6 +3,7 @@
   "tags": {},
   "timestamp": 1708102555327,
   "event_id": "1708102555327.NLOjmg",
+  "source": "device",
   "incremental_identification_status": "completed",
   "url": "https://www.example.com/login?hope{this{works[!",
   "ip_address": "61.127.217.15",