Merge pull request #18 from fingerprintjs/botd-url-field

Add to botd url field
fingerprintjs · Oct 25, 2022 · dd258f0 · dd258f0
2 parents a4310c7 + 24bfdf0
commit dd258f0
Show file tree

Hide file tree

Showing 6 changed files with 46 additions and 6 deletions.
diff --git a/docs/BotdResult.md b/docs/BotdResult.md
@@ -5,6 +5,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **ip** | **str** | IP address of the requesting browser or bot. | 
 **time** | **datetime** | Time in UTC when the request from the JS agent was made. We recommend to treat requests that are older than 2 minutes as malicious. Otherwise, request replay attacks are possible | 
+**url** | **str** | Page URL from which identification request was sent. | 
 **bot** | [**BotdDetectionResult**](BotdDetectionResult.md) |  | 
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

diff --git a/docs/FingerprintApi.md b/docs/FingerprintApi.md
@@ -41,6 +41,8 @@ except ApiException as e:
 
 ### Parameters
 
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
  **request_id** | **str**| Request ID | 
 
 ### Return type
@@ -92,6 +94,8 @@ except ApiException as e:
 
 ### Parameters
 
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
  **visitor_id** | **str**|  | 
  **request_id** | **str**| Filter events by requestId | [optional] 
  **linked_id** | **str**| Filter events by custom identifier | [optional] 

diff --git a/fingerprint_pro_server_api_sdk/models/botd_result.py b/fingerprint_pro_server_api_sdk/models/botd_result.py
@@ -30,23 +30,27 @@ class BotdResult(object):
     swagger_types = {
         'ip': 'str',
         'time': 'datetime',
+        'url': 'str',
         'bot': 'BotdDetectionResult'
     }
 
     attribute_map = {
         'ip': 'ip',
         'time': 'time',
+        'url': 'url',
         'bot': 'bot'
     }
 
-    def __init__(self, ip=None, time=None, bot=None):  # noqa: E501
+    def __init__(self, ip=None, time=None, url=None, bot=None):  # noqa: E501
         """BotdResult - a model defined in Swagger"""  # noqa: E501
         self._ip = None
         self._time = None
+        self._url = None
         self._bot = None
         self.discriminator = None
         self.ip = ip
         self.time = time
+        self.url = url
         self.bot = bot
 
     @property
@@ -99,6 +103,31 @@ def time(self, time):
 
         self._time = time
 
+    @property
+    def url(self):
+        """Gets the url of this BotdResult.  # noqa: E501
+
+        Page URL from which identification request was sent.  # noqa: E501
+
+        :return: The url of this BotdResult.  # noqa: E501
+        :rtype: str
+        """
+        return self._url
+
+    @url.setter
+    def url(self, url):
+        """Sets the url of this BotdResult.
+
+        Page URL from which identification request was sent.  # noqa: E501
+
+        :param url: The url of this BotdResult.  # noqa: E501
+        :type: str
+        """
+        if url is None:
+            raise ValueError("Invalid value for `url`, must not be `None`")  # noqa: E501
+
+        self._url = url
+
     @property
     def bot(self):
         """Gets the bot of this BotdResult.  # noqa: E501

diff --git a/res/fingerprint-server-api.yaml b/res/fingerprint-server-api.yaml
@@ -102,6 +102,7 @@ paths:
                         data:
                           bot:
                             result: notDetected
+                          url: https://www.example.com/login
                           ip: 61.127.217.15
                           time: '2019-05-21T16:40:13Z'
         '400':
@@ -3182,7 +3183,6 @@ components:
         - visitorFound
     Visit:
       type: object
-      additionalProperties: false
       properties:
         requestId:
           description: Unique identifier of the user's identification request.
@@ -3517,7 +3517,6 @@ components:
           $ref: '#/components/schemas/ProductsResponse'
     BotdResult:
       type: object
-      additionalProperties: false
       description: Contains all the information from BOTD product
       properties:
         ip:
@@ -3534,12 +3533,18 @@ components:
           type: string
           format: date-time
           example: '2022-06-09T22:58:36Z'
+        url:
+          description: Page URL from which identification request was sent.
+          type: string
+          format: uri-reference
+          example: https://b.fpjs.sh/
         bot:
           $ref: '#/components/schemas/BotdDetectionResult'
           example:
             result: notDetected
       required:
         - bot
+        - url
         - ip
         - time
     BotdDetectionResult:

diff --git a/template/api_doc.mustache b/template/api_doc.mustache
@@ -43,9 +43,9 @@ except ApiException as e:
 ```
 
 ### Parameters
-{{^allParams}}This endpoint does not need any parameter.
+{{^allParams}}This endpoint does not need any parameter.{{/allParams}}{{#allParams}}{{#@last}}
 Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------{{/allParams}}
+------------- | ------------- | ------------- | -------------{{/@last}}{{/allParams}}
 {{#allParams}} **{{paramName}}** | {{#isFile}}**{{dataType}}**{{/isFile}}{{^isFile}}{{#isPrimitiveType}}**{{dataType}}**{{/isPrimitiveType}}{{^isPrimitiveType}}[**{{dataType}}**]({{baseType}}.md){{/isPrimitiveType}}{{/isFile}}| {{description}} | {{^required}}[optional] {{/required}}{{#defaultValue}}[default to {{defaultValue}}]{{/defaultValue}}
 {{/allParams}}
 
@@ -55,7 +55,7 @@ Name | Type | Description  | Notes
 
 ### Authorization
 
-[ApiKeyHeader](../README.md#ApiKeyHeader), [ApiKeyQuery](../README.md#ApiKeyQuery)
+{{^authMethods}}No authorization required{{/authMethods}}{{#authMethods}}[{{{name}}}](../README.md#{{{name}}}){{^@last}}, {{/@last}}{{/authMethods}}
 
 ### HTTP request headers
 

diff --git a/test/mocks/get_event.json b/test/mocks/get_event.json
@@ -62,6 +62,7 @@
         "bot": {
           "result": "notDetected"
         },
+        "url": "https://www.example.com/login",
         "ip": "61.127.217.15",
         "time": "2019-05-21T16:40:13Z"
       }