Skip to content

Commit e6d9549

Browse files
mcnulty-fpmcnulty-fp
authored
Merge pull request #175 from fingerprintjs/feat/open-api-v2.8.0
OpenAPI schema sync (v2.8.0)
2 parents 13fe0b5 + 098df62 commit e6d9549

File tree

9 files changed

+102
-202
lines changed

9 files changed

+102
-202
lines changed

‎.changeset/silent-frogs-beam.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
'fingerprint-pro-server-api-php-sdk': minor
3+
---
4+
5+
add `replayed` field to `identification` in Events and Webhooks

‎.schema-version‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
v2.7.0
1+
v2.8.0

‎docs/Model/Identification.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ Name | Type | Description | Notes
2020
**first_seen_at** | [**\Fingerprint\ServerAPI\Model\IdentificationSeenAt**](IdentificationSeenAt.md) | |
2121
**last_seen_at** | [**\Fingerprint\ServerAPI\Model\IdentificationSeenAt**](IdentificationSeenAt.md) | |
2222
**components** | array | | [optional]
23+
**replayed** | **bool** | `true` if we determined that this payload was replayed, `false` otherwise. | [optional]
2324

2425
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
2526

‎docs/Model/Webhook.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,7 @@ Name | Type | Description | Notes
4545
**velocity** | [**\Fingerprint\ServerAPI\Model\WebhookVelocity**](WebhookVelocity.md) | | [optional]
4646
**developer_tools** | [**\Fingerprint\ServerAPI\Model\WebhookDeveloperTools**](WebhookDeveloperTools.md) | | [optional]
4747
**mitm_attack** | [**\Fingerprint\ServerAPI\Model\WebhookMitMAttack**](WebhookMitMAttack.md) | | [optional]
48+
**replayed** | **bool** | `true` if we determined that this payload was replayed, `false` otherwise. | [optional]
4849

4950
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
5051

‎res/fingerprint-server-api.yaml‎

Lines changed: 22 additions & 187 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,10 @@ info:
1212
contact:
1313
name: Fingerprint Support
1414
email: [email protected]
15+
license:
16+
name: MIT
17+
url: >-
18+
https://github.com/fingerprintjs/fingerprint-pro-server-api-openapi/blob/main/LICENSE
1519
tags:
1620
- name: Fingerprint
1721
description: >-
@@ -818,6 +822,7 @@ paths:
818822
$ref: '#/components/schemas/ErrorResponse'
819823
/webhook:
820824
trace:
825+
summary: Dummy path to describe webhook format.
821826
tags:
822827
- Fingerprint
823828
description: >-
@@ -837,6 +842,7 @@ paths:
837842
webhook:
838843
webhook:
839844
post:
845+
summary: Webhook example
840846
description: >-
841847
You can use HTTP basic authentication and set up credentials in
842848
your [Fingerprint
@@ -846,193 +852,6 @@ paths:
846852
application/json:
847853
schema:
848854
$ref: '#/components/schemas/Webhook'
849-
example:
850-
value:
851-
requestId: Px6VxbRC6WBkA39yeNH3
852-
url: https://banking.example.com/signup
853-
ip: 216.3.128.12
854-
tag:
855-
requestType: signup
856-
yourCustomId: 45321
857-
time: '2019-10-12T07:20:50.52Z'
858-
timestamp: 1554910997788
859-
ipLocation:
860-
accuracyRadius: 1
861-
city:
862-
name: Bolingbrook
863-
continent:
864-
code: NA
865-
name: North America
866-
country:
867-
code: US
868-
name: United States
869-
latitude: 41.12933
870-
longitude: -88.9954
871-
postalCode: '60547'
872-
subdivisions:
873-
- isoCode: IL
874-
name: Illinois
875-
timezone: America/Chicago
876-
linkedId: any-string
877-
visitorId: 3HNey93AkBW6CRbxV6xP
878-
visitorFound: true
879-
confidence:
880-
score: 0.97
881-
firstSeenAt:
882-
global: '2022-03-16T11:26:45.362Z'
883-
subscription: '2022-03-16T11:31:01.101Z'
884-
lastSeenAt:
885-
global: '2022-03-16T11:28:34.023Z'
886-
subscription: null
887-
browserDetails:
888-
browserName: Chrome
889-
browserFullVersion: 73.0.3683.86
890-
browserMajorVersion: '73'
891-
os: Mac OS X
892-
osVersion: 10.14.3
893-
device: Other
894-
userAgent: >-
895-
(Macintosh; Intel Mac OS X 10_14_3)
896-
Chrome/73.0.3683.86
897-
incognito: false
898-
clientReferrer: https://google.com?search=banking+services
899-
bot:
900-
result: bad
901-
type: selenium
902-
userAgent: >-
903-
(Macintosh; Intel Mac OS X 10_14_3)
904-
Chrome/73.0.3683.86
905-
rootApps:
906-
result: false
907-
emulator:
908-
result: false
909-
ipInfo:
910-
v4:
911-
address: 94.142.239.124
912-
geolocation:
913-
accuracyRadius: 20
914-
latitude: 50.05
915-
longitude: 14.4
916-
postalCode: 150 00
917-
timezone: Europe/Prague
918-
city:
919-
name: Prague
920-
country:
921-
code: CZ
922-
name: Czechia
923-
continent:
924-
code: EU
925-
name: Europe
926-
subdivisions:
927-
- isoCode: '10'
928-
name: Hlavni mesto Praha
929-
asn:
930-
asn: '7922'
931-
name: COMCAST-7922
932-
network: 73.136.0.0/13
933-
datacenter:
934-
result: true
935-
name: DediPath
936-
ipBlocklist:
937-
result: false
938-
details:
939-
emailSpam: false
940-
attackSource: false
941-
tor:
942-
result: false
943-
vpn:
944-
result: false
945-
confidence: high
946-
originTimezone: Europe/Berlin
947-
originCountry: unknown
948-
methods:
949-
timezoneMismatch: false
950-
publicVPN: false
951-
auxiliaryMobile: false
952-
osMismatch: false
953-
relay: false
954-
proxy:
955-
result: false
956-
confidence: high
957-
tampering:
958-
result: false
959-
anomalyScore: 0
960-
antiDetectBrowser: false
961-
clonedApp:
962-
result: false
963-
factoryReset:
964-
time: '1970-01-01T00:00:00Z'
965-
timestamp: 0
966-
jailbroken:
967-
result: false
968-
frida:
969-
result: false
970-
privacySettings:
971-
result: false
972-
virtualMachine:
973-
result: false
974-
rawDeviceAttributes:
975-
architecture:
976-
value: 127
977-
audio:
978-
value: 35.73832903057337
979-
canvas:
980-
value:
981-
Winding: true
982-
Geometry: 4dce9d6017c3e0c052a77252f29f2b1c
983-
Text: dd2474a56ff78c1de3e7a07070ba3b7d
984-
colorDepth:
985-
value: 30
986-
colorGamut:
987-
value: srgb
988-
contrast:
989-
value: 0
990-
cookiesEnabled:
991-
value: true
992-
highActivity:
993-
result: false
994-
locationSpoofing:
995-
result: true
996-
suspectScore:
997-
result: 0
998-
remoteControl:
999-
result: false
1000-
velocity:
1001-
distinctIp:
1002-
intervals:
1003-
5m: 1
1004-
1h: 1
1005-
24h: 1
1006-
distinctLinkedId: {}
1007-
distinctCountry:
1008-
intervals:
1009-
5m: 1
1010-
1h: 2
1011-
24h: 2
1012-
events:
1013-
intervals:
1014-
5m: 1
1015-
1h: 5
1016-
24h: 5
1017-
ipEvents:
1018-
intervals:
1019-
5m: 1
1020-
1h: 5
1021-
24h: 5
1022-
distinctIpByLinkedId:
1023-
intervals:
1024-
5m: 1
1025-
1h: 5
1026-
24h: 5
1027-
distinctVisitorIdByLinkedId:
1028-
intervals:
1029-
5m: 1
1030-
1h: 5
1031-
24h: 5
1032-
developerTools:
1033-
result: false
1034-
mitmAttack:
1035-
result: false
1036855
responses:
1037856
default:
1038857
description: The server doesn't validate the answer.
@@ -1201,10 +1020,12 @@ components:
12011020
type: string
12021021
nullable: true
12031022
format: date-time
1023+
x-ogen-time-format: 2006-01-02T15:04:05.999Z07:00
12041024
subscription:
12051025
type: string
12061026
nullable: true
12071027
format: date-time
1028+
x-ogen-time-format: 2006-01-02T15:04:05.999Z07:00
12081029
RawDeviceAttributeError:
12091030
type: object
12101031
additionalProperties: false
@@ -1288,6 +1109,7 @@ components:
12881109
time:
12891110
type: string
12901111
format: date-time
1112+
x-ogen-time-format: 2006-01-02T15:04:05Z07:00
12911113
description: >-
12921114
Time expressed according to ISO 8601 in UTC format, when the request
12931115
from the JS agent was made. We recommend to treat requests that are
@@ -1309,6 +1131,11 @@ components:
13091131
$ref: '#/components/schemas/IdentificationSeenAt'
13101132
components:
13111133
$ref: '#/components/schemas/RawDeviceAttributes'
1134+
replayed:
1135+
type: boolean
1136+
description: >
1137+
`true` if we determined that this payload was replayed, `false`
1138+
otherwise.
13121139
ErrorCode:
13131140
type: string
13141141
enum:
@@ -1412,6 +1239,7 @@ components:
14121239
time:
14131240
type: string
14141241
format: date-time
1242+
x-ogen-time-format: 2006-01-02T15:04:05.999Z07:00
14151243
description: >-
14161244
Time in UTC when the request from the JS agent was made. We
14171245
recommend to treat requests that are older than 2 minutes as
@@ -2339,6 +2167,7 @@ components:
23392167
time:
23402168
type: string
23412169
format: date-time
2170+
x-ogen-time-format: 2006-01-02T15:04:05Z07:00
23422171
description: >-
23432172
Time expressed according to ISO 8601 in UTC format, when the request
23442173
from the client agent was made. We recommend to treat requests that
@@ -2776,6 +2605,7 @@ components:
27762605
time:
27772606
type: string
27782607
format: date-time
2608+
x-ogen-time-format: 2006-01-02T15:04:05.999Z07:00
27792609
description: >-
27802610
Time expressed according to ISO 8601 in UTC format, when the request
27812611
from the JS agent was made. We recommend to treat requests that are
@@ -2861,3 +2691,8 @@ components:
28612691
$ref: '#/components/schemas/WebhookDeveloperTools'
28622692
mitmAttack:
28632693
$ref: '#/components/schemas/WebhookMitMAttack'
2694+
replayed:
2695+
type: boolean
2696+
description: >
2697+
`true` if we determined that this payload was replayed, `false`
2698+
otherwise.

0 commit comments

Comments
 (0)