Skip to content

Commit

Permalink
feat: fix ipLocation deprecation
Browse files Browse the repository at this point in the history 
BREAKING CHANGE: deprecated `ipLocation` field uses `DeprecatedIpLocation` model
  • Loading branch information
@TheUnderScorer
TheUnderScorer committed Feb 27, 2024
1 parent a94fd56 commit f61a78d
Show file tree
Hide file tree
Showing 18 changed files with 755 additions and 40 deletions.
3 changes: 3 additions & 0 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -257,6 +257,9 @@ Class | Method | HTTP request | Description
- [BrowserDetails](docs/BrowserDetails.md)
- [Confidence](docs/Confidence.md)
- [DataCenter](docs/DataCenter.md)
- [DeprecatedIPLocation](docs/DeprecatedIPLocation.md)
- [DeprecatedIPLocationCity](docs/DeprecatedIPLocationCity.md)
- [EmulatorResult](docs/EmulatorResult.md)
- [Error](docs/Error.md)
- [ErrorEvent403Response](docs/ErrorEvent403Response.md)
- [ErrorEvent403ResponseError](docs/ErrorEvent403ResponseError.md)
Expand Down
22 changes: 22 additions & 0 deletions docs/DeprecatedIPLocation.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@


# DeprecatedIPLocation

This field is **deprecated** and will not return a result for **applications created after January 23rd, 2024**. Please use the [IP Geolocation Smart signal](https://dev.fingerprint.com/docs/smart-signals-overview#ip-geolocation) for geolocation information.

## Properties

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**accuracyRadius** | **Integer** | The IP address is likely to be within this radius (in km) of the specified location. | [optional] |
|**latitude** | **Double** | | [optional] |
|**longitude** | **Double** | | [optional] |
|**postalCode** | **String** | | [optional] |
|**timezone** | **String** | | [optional] |
|**city** | [**DeprecatedIPLocationCity**](DeprecatedIPLocationCity.md) | | [optional] |
|**country** | [**Location**](Location.md) | | [optional] |
|**continent** | [**Location**](Location.md) | | [optional] |
|**subdivisions** | [**List<Subdivision>**](Subdivision.md) | | [optional] |



13 changes: 13 additions & 0 deletions docs/DeprecatedIPLocationCity.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@


# DeprecatedIPLocationCity


## Properties

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**name** | **String** | | [optional] |



1 change: 0 additions & 1 deletion docs/IPLocation.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@

# IPLocation

This field is **deprecated** and will not return a result for **accounts created after December 18th, 2023**. Please use the [`ipInfo` Smart signal](https://dev.fingerprint.com/docs/smart-signals-overview#ip-geolocation) for geolocation information.

## Properties

Expand Down
2 changes: 1 addition & 1 deletion docs/ProductsResponseIdentificationData.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
|**browserDetails** | [**BrowserDetails**](BrowserDetails.md) | | |
|**incognito** | **Boolean** | Flag if user used incognito session. | |
|**ip** | **String** | | |
|**ipLocation** | [**IPLocation**](IPLocation.md) | | [optional] |
|**ipLocation** | [**DeprecatedIPLocation**](DeprecatedIPLocation.md) | | [optional] |
|**timestamp** | **Long** | Timestamp of the event with millisecond precision in Unix time. | |
|**time** | **OffsetDateTime** | Time expressed according to ISO 8601 in UTC format. | |
|**url** | **URI** | Page URL from which identification request was sent. | |
Expand Down
2 changes: 1 addition & 1 deletion docs/ResponseVisits.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
|**browserDetails** | [**BrowserDetails**](BrowserDetails.md) | | |
|**incognito** | **Boolean** | Flag if user used incognito session. | |
|**ip** | **String** | | |
|**ipLocation** | [**IPLocation**](IPLocation.md) | | [optional] |
|**ipLocation** | [**DeprecatedIPLocation**](DeprecatedIPLocation.md) | | [optional] |
|**timestamp** | **Long** | Timestamp of the event with millisecond precision in Unix time. | |
|**time** | **OffsetDateTime** | Time expressed according to ISO 8601 in UTC format. | |
|**url** | **URI** | Page URL from which identification request was sent. | |
Expand Down
2 changes: 1 addition & 1 deletion docs/Visit.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
|**browserDetails** | [**BrowserDetails**](BrowserDetails.md) | | |
|**incognito** | **Boolean** | Flag if user used incognito session. | |
|**ip** | **String** | | |
|**ipLocation** | [**IPLocation**](IPLocation.md) | | [optional] |
|**ipLocation** | [**DeprecatedIPLocation**](DeprecatedIPLocation.md) | | [optional] |
|**timestamp** | **Long** | Timestamp of the event with millisecond precision in Unix time. | |
|**time** | **OffsetDateTime** | Time expressed according to ISO 8601 in UTC format. | |
|**url** | **URI** | Page URL from which the identification request was sent. | |
Expand Down
2 changes: 1 addition & 1 deletion docs/WebhookVisit.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
|**requestId** | **String** | Unique identifier of the user's identification request. | |
|**browserDetails** | [**BrowserDetails**](BrowserDetails.md) | | |
|**ip** | **String** | | |
|**ipLocation** | [**IPLocation**](IPLocation.md) | | [optional] |
|**ipLocation** | [**DeprecatedIPLocation**](DeprecatedIPLocation.md) | | [optional] |
|**timestamp** | **Long** | Timestamp of the event with millisecond precision in Unix time. | |
|**time** | **OffsetDateTime** | Time expressed according to ISO 8601 in UTC format. | |
|**url** | **URI** | Page URL from which identification request was sent. | |
Expand Down
198 changes: 188 additions & 10 deletions res/fingerprint-server-api.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3802,7 +3802,53 @@ components:
format: ipv4
example: 8.8.8.8
ipLocation:
$ref: '#/components/schemas/IPLocation'
type: object
additionalProperties: false
deprecated: true
description: >-
This field is **deprecated** and will not return a result for
**applications created after January 23rd, 2024**. Please use
the [IP Geolocation Smart
signal](https://dev.fingerprint.com/docs/smart-signals-overview#ip-geolocation)
for geolocation information.
properties:
accuracyRadius:
description: >-
The IP address is likely to be within this radius (in km)
of the specified location.
type: integer
minimum: 0
latitude:
type: number
format: double
minimum: -90
maximum: 90
longitude:
type: number
format: double
minimum: -180
maximum: 180
postalCode:
type: string
timezone:
type: string
format: timezone
city:
type: object
additionalProperties: false
title: DeprecatedIPLocationCity
properties:
name:
type: string
country:
$ref: '#/components/schemas/Location'
continent:
$ref: '#/components/schemas/Location'
subdivisions:
type: array
items:
$ref: '#/components/schemas/Subdivision'
title: DeprecatedIPLocation
timestamp:
description: >-
Timestamp of the event with millisecond precision in Unix
Expand Down Expand Up @@ -4113,7 +4159,53 @@ components:
format: ipv4
example: 8.8.8.8
ipLocation:
$ref: '#/components/schemas/IPLocation'
type: object
additionalProperties: false
deprecated: true
description: >-
This field is **deprecated** and will not return a result for
**applications created after January 23rd, 2024**. Please use the
[IP Geolocation Smart
signal](https://dev.fingerprint.com/docs/smart-signals-overview#ip-geolocation)
for geolocation information.
properties:
accuracyRadius:
description: >-
The IP address is likely to be within this radius (in km) of the
specified location.
type: integer
minimum: 0
latitude:
type: number
format: double
minimum: -90
maximum: 90
longitude:
type: number
format: double
minimum: -180
maximum: 180
postalCode:
type: string
timezone:
type: string
format: timezone
city:
type: object
additionalProperties: false
title: DeprecatedIPLocationCity
properties:
name:
type: string
country:
$ref: '#/components/schemas/Location'
continent:
$ref: '#/components/schemas/Location'
subdivisions:
type: array
items:
$ref: '#/components/schemas/Subdivision'
title: DeprecatedIPLocation
timestamp:
description: Timestamp of the event with millisecond precision in Unix time.
type: integer
Expand Down Expand Up @@ -4180,7 +4272,53 @@ components:
format: ipv4
example: 8.8.8.8
ipLocation:
$ref: '#/components/schemas/IPLocation'
type: object
additionalProperties: false
deprecated: true
description: >-
This field is **deprecated** and will not return a result for
**applications created after January 23rd, 2024**. Please use the
[IP Geolocation Smart
signal](https://dev.fingerprint.com/docs/smart-signals-overview#ip-geolocation)
for geolocation information.
properties:
accuracyRadius:
description: >-
The IP address is likely to be within this radius (in km) of the
specified location.
type: integer
minimum: 0
latitude:
type: number
format: double
minimum: -90
maximum: 90
longitude:
type: number
format: double
minimum: -180
maximum: 180
postalCode:
type: string
timezone:
type: string
format: timezone
city:
type: object
additionalProperties: false
title: DeprecatedIPLocationCity
properties:
name:
type: string
country:
$ref: '#/components/schemas/Location'
continent:
$ref: '#/components/schemas/Location'
subdivisions:
type: array
items:
$ref: '#/components/schemas/Subdivision'
title: DeprecatedIPLocation
timestamp:
description: Timestamp of the event with millisecond precision in Unix time.
type: integer
Expand Down Expand Up @@ -4335,12 +4473,6 @@ components:
IPLocation:
type: object
additionalProperties: false
deprecated: true
description: >-
This field is **deprecated** and will not return a result for **accounts
created after December 18th, 2023**. Please use the [`ipInfo` Smart
signal](https://dev.fingerprint.com/docs/smart-signals-overview#ip-geolocation)
for geolocation information.
properties:
accuracyRadius:
description: >-
Expand Down Expand Up @@ -4441,7 +4573,53 @@ components:
format: ipv4
example: 8.8.8.8
ipLocation:
$ref: '#/components/schemas/IPLocation'
type: object
additionalProperties: false
deprecated: true
description: >-
This field is **deprecated** and will not return a result
for **applications created after January 23rd, 2024**.
Please use the [IP Geolocation Smart
signal](https://dev.fingerprint.com/docs/smart-signals-overview#ip-geolocation)
for geolocation information.
properties:
accuracyRadius:
description: >-
The IP address is likely to be within this radius (in
km) of the specified location.
type: integer
minimum: 0
latitude:
type: number
format: double
minimum: -90
maximum: 90
longitude:
type: number
format: double
minimum: -180
maximum: 180
postalCode:
type: string
timezone:
type: string
format: timezone
city:
type: object
additionalProperties: false
title: DeprecatedIPLocationCity
properties:
name:
type: string
country:
$ref: '#/components/schemas/Location'
continent:
$ref: '#/components/schemas/Location'
subdivisions:
type: array
items:
$ref: '#/components/schemas/Subdivision'
title: DeprecatedIPLocation
timestamp:
description: >-
Timestamp of the event with millisecond precision in Unix
Expand Down
Loading

0 comments on commit f61a78d

Please sign in to comment.