feat: deprecate IPLocation

fingerprintjs · Jan 10, 2024 · 035024d · 035024d
1 parent 1afccbe
commit 035024d
Show file tree

Hide file tree

Showing 6 changed files with 50 additions and 10 deletions.
diff --git a/resources/fingerprint-server-api.yaml b/resources/fingerprint-server-api.yaml
@@ -158,7 +158,7 @@ paths:
                               asn: '7922'
                               name: COMCAST-7922
                               network: 73.136.0.0/13
-                            dataCenter:
+                            datacenter:
                               result: true
                               name: DediPath
                       incognito:
@@ -3701,7 +3701,7 @@ paths:
                               asn: '7922'
                               name: COMCAST-7922
                               network: 73.136.0.0/13
-                            dataCenter:
+                            datacenter:
                               result: true
                               name: DediPath
                         rootApps:
@@ -4320,8 +4320,22 @@ components:
         - asn
         - network
       title: ASN
+    DataCenterInfo:
+      type: object
+      additionalProperties: false
+      properties:
+        result:
+          type: boolean
+        name:
+          type: string
+          example: DediPath
+      required:
+        - result
+      title: DataCenterInfo
     DataCenter:
       type: object
+      deprecated: true
+      description: '`dataCenter` is deprecated in favor of `datacenter`'
       additionalProperties: false
       properties:
         result:
@@ -4335,6 +4349,12 @@ 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: >-
@@ -4857,6 +4877,8 @@ components:
               $ref: '#/components/schemas/IPLocation'
             asn:
               $ref: '#/components/schemas/ASN'
+            datacenter:
+              $ref: '#/components/schemas/DataCenterInfo'
             dataCenter:
               $ref: '#/components/schemas/DataCenter'
         v6:
@@ -4871,6 +4893,8 @@ components:
               $ref: '#/components/schemas/IPLocation'
             asn:
               $ref: '#/components/schemas/ASN'
+            datacenter:
+              $ref: '#/components/schemas/DataCenterInfo'
             dataCenter:
               $ref: '#/components/schemas/DataCenter'
     IpBlockListResult:

diff --git a/src/generatedApiTypes.ts b/src/generatedApiTypes.ts
@@ -412,13 +412,27 @@ export interface components {
       /** @example COMCAST-7922 */
       name?: string;
     };
-    /** DataCenter */
+    /** DataCenterInfo */
+    DataCenterInfo: {
+      result: boolean;
+      /** @example DediPath */
+      name?: string;
+    };
+    /**
+     * DataCenter
+     * @deprecated
+     * @description `dataCenter` is deprecated in favor of `datacenter`
+     */
     DataCenter: {
       result: boolean;
       /** @example DediPath */
       name?: string;
     };
-    /** IPLocation */
+    /**
+     * IPLocation
+     * @deprecated
+     * @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.
+     */
     IPLocation: {
       /**
        * @description The IP address is likely to be within this radius (in km) of the specified location.
@@ -775,6 +789,7 @@ export interface components {
         address?: string;
         geolocation?: components['schemas']['IPLocation'];
         asn?: components['schemas']['ASN'];
+        datacenter?: components['schemas']['DataCenterInfo'];
         dataCenter?: components['schemas']['DataCenter'];
       };
       v6?: {
@@ -785,6 +800,7 @@ export interface components {
         address?: string;
         geolocation?: components['schemas']['IPLocation'];
         asn?: components['schemas']['ASN'];
+        datacenter?: components['schemas']['DataCenterInfo'];
         dataCenter?: components['schemas']['DataCenter'];
       };
     };

diff --git a/tests/mocked-responses-tests/__snapshots__/castVisitorWebhookTest.spec.ts.snap b/tests/mocked-responses-tests/__snapshots__/castVisitorWebhookTest.spec.ts.snap
@@ -56,7 +56,7 @@ Object {
         "name": "COMCAST-7922",
         "network": "73.136.0.0/13",
       },
-      "dataCenter": Object {
+      "datacenter": Object {
         "name": "DediPath",
         "result": true,
       },

diff --git a/tests/mocked-responses-tests/__snapshots__/getEventTests.spec.ts.snap b/tests/mocked-responses-tests/__snapshots__/getEventTests.spec.ts.snap
@@ -340,7 +340,7 @@ Object {
             "name": "COMCAST-7922",
             "network": "73.136.0.0/13",
           },
-          "dataCenter": Object {
+          "datacenter": Object {
             "name": "DediPath",
             "result": true,
           },

diff --git a/tests/mocked-responses-tests/mocked-responses-data/external/get_event.json b/tests/mocked-responses-tests/mocked-responses-data/external/get_event.json
@@ -100,7 +100,7 @@
             "name": "COMCAST-7922",
             "network": "73.136.0.0/13"
           },
-          "dataCenter": {
+          "datacenter": {
             "result": true,
             "name": "DediPath"
           }
@@ -229,4 +229,4 @@
       }
     }
   }
-}
+}
diff --git a/tests/mocked-responses-tests/mocked-responses-data/external/webhook.json b/tests/mocked-responses-tests/mocked-responses-data/external/webhook.json
@@ -94,7 +94,7 @@
         "name": "COMCAST-7922",
         "network": "73.136.0.0/13"
       },
-      "dataCenter": {
+      "datacenter": {
         "result": true,
         "name": "DediPath"
       }
@@ -184,4 +184,4 @@
   "locationSpoofing": {
     "result": true
   }
-}
+}