feat: update OpenAPI schema

TheUnderScorer · TheUnderScorer · commit d5108b4ef764 · 2025-01-08T14:32:38.000Z
diff --git a/.changeset/forty-seas-prove.md b/.changeset/forty-seas-prove.md
@@ -0,0 +1,5 @@
+---
+'fingerprint-pro-server-api-python-sdk': minor
+---
+
+Add `relay` detection method to the VPN Detection Smart Signal
diff --git a/.changeset/orange-poets-drive.md b/.changeset/orange-poets-drive.md
@@ -0,0 +1,5 @@
+---
+'fingerprint-pro-server-api-python-sdk': minor
+---
+
+**events**: Add a `suspect` field to the `identification` product schema
diff --git a/README.md b/README.md
@@ -254,6 +254,7 @@ Class | Method | HTTP request | Description
 ------------ | ------------- | ------------- | -------------
 *FingerprintApi* | [**delete_visitor_data**](docs/FingerprintApi.md#delete_visitor_data) | **DELETE** /visitors/{visitor_id} | Delete data by visitor ID
 *FingerprintApi* | [**get_event**](docs/FingerprintApi.md#get_event) | **GET** /events/{request_id} | Get event by request ID
+*FingerprintApi* | [**get_related_visitors**](docs/FingerprintApi.md#get_related_visitors) | **GET** /related-visitors | Get Related Visitors
 *FingerprintApi* | [**get_visits**](docs/FingerprintApi.md#get_visits) | **GET** /visitors/{visitor_id} | Get visits by visitor ID
 *FingerprintApi* | [**update_event**](docs/FingerprintApi.md#update_event) | **PUT** /events/{request_id} | Update an event with a given request ID
 
@@ -325,6 +326,8 @@ Class | Method | HTTP request | Description
  - [RawDeviceAttribute](docs/RawDeviceAttribute.md)
  - [RawDeviceAttributeError](docs/RawDeviceAttributeError.md)
  - [RawDeviceAttributes](docs/RawDeviceAttributes.md)
+ - [RelatedVisitor](docs/RelatedVisitor.md)
+ - [RelatedVisitorsResponse](docs/RelatedVisitorsResponse.md)
  - [RemoteControl](docs/RemoteControl.md)
  - [RootApps](docs/RootApps.md)
  - [SuspectScore](docs/SuspectScore.md)
diff --git a/docs/FingerprintApi.md b/docs/FingerprintApi.md
@@ -6,6 +6,7 @@ Method | HTTP request | Description
 ------------- | ------------- | -------------
 [**delete_visitor_data**](FingerprintApi.md#delete_visitor_data) | **DELETE** /visitors/{visitor_id} | Delete data by visitor ID
 [**get_event**](FingerprintApi.md#get_event) | **GET** /events/{request_id} | Get event by request ID
+[**get_related_visitors**](FingerprintApi.md#get_related_visitors) | **GET** /related-visitors | Get Related Visitors
 [**get_visits**](FingerprintApi.md#get_visits) | **GET** /visitors/{visitor_id} | Get visits by visitor ID
 [**update_event**](FingerprintApi.md#update_event) | **PUT** /events/{request_id} | Update an event with a given request ID
 
@@ -108,6 +109,56 @@ Name | Type | Description  | Notes
 
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
 
+# **get_related_visitors**
+> RelatedVisitorsResponse get_related_visitors(visitor_id)
+
+Get Related Visitors
+
+Related visitors API lets you link web visits and in-app browser visits that originated from the same mobile device. It searches the past 6 months of identification events to find the visitor IDs that belong to the same mobile device as the given visitor ID.  ⚠️ Please note that this API is not enabled by default and is billable separately. ⚠️  If you would like to use Related visitors API, please contact our [support team](https://fingerprint.com/support). To learn more, see [Related visitors API reference](https://dev.fingerprint.com/reference/related-visitors-api). 
+
+### Example
+```python
+import fingerprint_pro_server_api_sdk
+from fingerprint_pro_server_api_sdk.rest import ApiException
+
+# Configure API key authorization and region
+configuration = fingerprint_pro_server_api_sdk.Configuration(api_key="SECRET_API_KEY")
+# configuration = fingerprint_pro_server_api_sdk.Configuration(api_key="SECRET_API_KEY", region="eu")
+
+# create an instance of the API class
+api_instance = fingerprint_pro_server_api_sdk.FingerprintApi(configuration)
+
+visitor_id = 'visitor_id_example' # str | The [visitor ID](https://dev.fingerprint.com/reference/get-function#visitorid) for which you want to find the other visitor IDs that originated from the same mobile device.
+
+try:
+    # Get Related Visitors
+    api_response = api_instance.get_related_visitors(visitor_id)
+    print(api_response)
+except ApiException as e:
+    print("Exception when calling FingerprintApi->get_related_visitors: %s\n" % e)
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **visitor_id** | **str**| The [visitor ID](https://dev.fingerprint.com/reference/get-function#visitorid) for which you want to find the other visitor IDs that originated from the same mobile device. | 
+
+### Return type
+
+[**RelatedVisitorsResponse**](RelatedVisitorsResponse.md)
+
+### Authorization
+
+[ApiKeyHeader](../README.md#ApiKeyHeader), [ApiKeyQuery](../README.md#ApiKeyQuery)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
 # **get_visits**
 > VisitorsGetResponse get_visits(visitor_id, request_id=request_id, linked_id=linked_id, limit=limit, pagination_key=pagination_key, before=before)
 
diff --git a/docs/RelatedVisitor.md b/docs/RelatedVisitor.md
@@ -0,0 +1,9 @@
+# RelatedVisitor
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**visitor_id** | **str** | Visitor ID of a browser that originates from the same mobile device as the input visitor ID. | 
+
+[[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/RelatedVisitorsResponse.md b/docs/RelatedVisitorsResponse.md
@@ -0,0 +1,9 @@
+# RelatedVisitorsResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**related_visitors** | [**list[RelatedVisitor]**](RelatedVisitor.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/fingerprint_pro_server_api_sdk/__init__.py b/fingerprint_pro_server_api_sdk/__init__.py
@@ -86,6 +86,8 @@
 from fingerprint_pro_server_api_sdk.models.raw_device_attribute import RawDeviceAttribute
 from fingerprint_pro_server_api_sdk.models.raw_device_attribute_error import RawDeviceAttributeError
 from fingerprint_pro_server_api_sdk.models.raw_device_attributes import RawDeviceAttributes
+from fingerprint_pro_server_api_sdk.models.related_visitor import RelatedVisitor
+from fingerprint_pro_server_api_sdk.models.related_visitors_response import RelatedVisitorsResponse
 from fingerprint_pro_server_api_sdk.models.remote_control import RemoteControl
 from fingerprint_pro_server_api_sdk.models.root_apps import RootApps
 from fingerprint_pro_server_api_sdk.models.suspect_score import SuspectScore
diff --git a/fingerprint_pro_server_api_sdk/api/fingerprint_api.py b/fingerprint_pro_server_api_sdk/api/fingerprint_api.py
@@ -23,6 +23,7 @@
 from fingerprint_pro_server_api_sdk.models.error_response import ErrorResponse  # noqa: F401
 from fingerprint_pro_server_api_sdk.models.events_get_response import EventsGetResponse  # noqa: F401
 from fingerprint_pro_server_api_sdk.models.events_update_request import EventsUpdateRequest  # noqa: F401
+from fingerprint_pro_server_api_sdk.models.related_visitors_response import RelatedVisitorsResponse  # noqa: F401
 from fingerprint_pro_server_api_sdk.models.visitors_get_response import VisitorsGetResponse  # noqa: F401
 
 
@@ -252,6 +253,116 @@ def get_event_with_http_info(self, request_id: str, **kwargs):  # noqa: E501
                 raise extend_exception(e, error)
             raise e
 
+    def get_related_visitors(self, visitor_id: str, **kwargs) -> Union[RelatedVisitorsResponse, AsyncResult[RelatedVisitorsResponse]]:  # noqa: E501
+        """Get Related Visitors  # noqa: E501
+
+        Related visitors API lets you link web visits and in-app browser visits that originated from the same mobile device. It searches the past 6 months of identification events to find the visitor IDs that belong to the same mobile device as the given visitor ID.  ⚠️ Please note that this API is not enabled by default and is billable separately. ⚠️  If you would like to use Related visitors API, please contact our [support team](https://fingerprint.com/support). To learn more, see [Related visitors API reference](https://dev.fingerprint.com/reference/related-visitors-api).   # noqa: E501
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please pass async_req=True
+        >>> thread = api.get_related_visitors(visitor_id, async_req=True)
+        >>> result = thread.get()
+
+        :param async_req bool
+        :param visitor_id: The [visitor ID](https://dev.fingerprint.com/reference/get-function#visitorid) for which you want to find the other visitor IDs that originated from the same mobile device. (required)
+        :return: RelatedVisitorsResponse
+                 If the method is called asynchronously,
+                 returns the request thread.
+        """
+        kwargs['_return_http_data_only'] = True
+        if kwargs.get('async_req'):
+            return self.get_related_visitors_with_http_info(visitor_id, **kwargs)  # noqa: E501
+        else:
+            (data) = self.get_related_visitors_with_http_info(visitor_id, **kwargs)  # noqa: E501
+            return data
+
+    def get_related_visitors_with_http_info(self, visitor_id: str, **kwargs):  # noqa: E501
+        """Get Related Visitors  # noqa: E501
+
+        Related visitors API lets you link web visits and in-app browser visits that originated from the same mobile device. It searches the past 6 months of identification events to find the visitor IDs that belong to the same mobile device as the given visitor ID.  ⚠️ Please note that this API is not enabled by default and is billable separately. ⚠️  If you would like to use Related visitors API, please contact our [support team](https://fingerprint.com/support). To learn more, see [Related visitors API reference](https://dev.fingerprint.com/reference/related-visitors-api).   # noqa: E501
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please pass async_req=True
+        >>> thread = api.get_related_visitors_with_http_info(visitor_id, async_req=True)
+        >>> result = thread.get()
+
+        :param async_req bool
+        :param str visitor_id: The [visitor ID](https://dev.fingerprint.com/reference/get-function#visitorid) for which you want to find the other visitor IDs that originated from the same mobile device. (required)
+        :return: RelatedVisitorsResponse
+                 If the method is called asynchronously,
+                 returns the request thread.
+        """
+
+        all_params = [
+            'visitor_id',
+            'async_req',
+            '_return_http_data_only',
+            '_preload_content',
+            '_request_timeout']
+
+        params = locals()
+        for key, val in params['kwargs'].items():
+            if key not in all_params:
+                raise TypeError(
+                    "Got an unexpected keyword argument '%s'"
+                    " to method get_related_visitors" % key
+                )
+            params[key] = val
+        del params['kwargs']
+        # verify the required parameter 'visitor_id' is set
+        if 'visitor_id' not in params or params['visitor_id'] is None:
+            raise ValueError("Missing the required parameter `visitor_id` when calling `get_related_visitors`")  # noqa: E501
+
+        collection_formats = {}
+
+        path_params = {}
+
+        query_params = [('ii', 'fingerprint-pro-server-python-sdk/8.1.0')]
+        if 'visitor_id' in params:
+            query_params.append(('visitor_id', params['visitor_id']))  # noqa: E501
+
+        header_params = {}
+
+        form_params = []
+        local_var_files = {}
+
+        body_params = None
+        # HTTP header `Accept`
+        header_params['Accept'] = self.api_client.select_header_accept(
+            ['application/json'])  # noqa: E501
+
+        # Authentication setting
+        auth_settings = ['ApiKeyHeader', 'ApiKeyQuery']  # noqa: E501
+
+        try:
+            return self.api_client.call_api(
+                '/related-visitors', 'GET',
+                path_params,
+                query_params,
+                header_params,
+                body=body_params,
+                post_params=form_params,
+                files=local_var_files,
+                response_type='RelatedVisitorsResponse',  # noqa: E501
+                auth_settings=auth_settings,
+                async_req=params.get('async_req'),
+                _return_http_data_only=params.get('_return_http_data_only'),
+                _preload_content=params.get('_preload_content', True),
+                _request_timeout=params.get('_request_timeout'),
+                collection_formats=collection_formats)
+        except ApiException as e:
+            if e.status == 400:
+                error = self.api_client.deserialize(e, 'ErrorResponse', True)
+                raise extend_exception(e, error)
+            if e.status == 403:
+                error = self.api_client.deserialize(e, 'ErrorResponse', True)
+                raise extend_exception(e, error)
+            if e.status == 404:
+                error = self.api_client.deserialize(e, 'ErrorResponse', True)
+                raise extend_exception(e, error)
+            if e.status == 429:
+                error = self.api_client.deserialize(e, 'ErrorResponse', True)
+                raise extend_exception(e, error)
+            raise e
+
     def get_visits(self, visitor_id: str, **kwargs) -> Union[VisitorsGetResponse, AsyncResult[VisitorsGetResponse]]:  # noqa: E501
         """Get visits by visitor ID  # noqa: E501
 
diff --git a/fingerprint_pro_server_api_sdk/models/__init__.py b/fingerprint_pro_server_api_sdk/models/__init__.py
@@ -78,6 +78,8 @@
 from fingerprint_pro_server_api_sdk.models.raw_device_attribute import RawDeviceAttribute
 from fingerprint_pro_server_api_sdk.models.raw_device_attribute_error import RawDeviceAttributeError
 from fingerprint_pro_server_api_sdk.models.raw_device_attributes import RawDeviceAttributes
+from fingerprint_pro_server_api_sdk.models.related_visitor import RelatedVisitor
+from fingerprint_pro_server_api_sdk.models.related_visitors_response import RelatedVisitorsResponse
 from fingerprint_pro_server_api_sdk.models.remote_control import RemoteControl
 from fingerprint_pro_server_api_sdk.models.root_apps import RootApps
 from fingerprint_pro_server_api_sdk.models.suspect_score import SuspectScore
diff --git a/fingerprint_pro_server_api_sdk/models/related_visitor.py b/fingerprint_pro_server_api_sdk/models/related_visitor.py
@@ -0,0 +1,66 @@
+# coding: utf-8
+
+"""
+    Fingerprint Pro Server API
+
+    Fingerprint Pro Server API allows you to get information about visitors and about individual 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.   # noqa: E501
+
+    OpenAPI spec version: 3
+    Contact: support@fingerprint.com
+    Generated by: https://github.com/swagger-api/swagger-codegen.git
+"""
+
+import re  # noqa: F401
+from typing import Dict, List, Optional  # noqa: F401
+from fingerprint_pro_server_api_sdk.base_model import BaseModel
+
+
+class RelatedVisitor(BaseModel):
+    """NOTE: This class is auto generated by the swagger code generator program.
+
+    Do not edit the class manually.
+    """
+    """
+    Attributes:
+      swagger_types (dict): The key is attribute name
+                            and the value is attribute type.
+      attribute_map (dict): The key is attribute name
+                            and the value is json key in definition.
+    """
+    swagger_types = {
+        'visitor_id': 'str'
+    }
+
+    attribute_map = {
+        'visitor_id': 'visitorId'
+    }
+
+    def __init__(self, visitor_id=None):  # noqa: E501
+        """RelatedVisitor - a model defined in Swagger"""  # noqa: E501
+        self._visitor_id = None
+        self.discriminator = None
+        self.visitor_id = visitor_id
+
+    @property
+    def visitor_id(self) -> str:
+        """Gets the visitor_id of this RelatedVisitor.  # noqa: E501
+
+        Visitor ID of a browser that originates from the same mobile device as the input visitor ID.  # noqa: E501
+
+        :return: The visitor_id of this RelatedVisitor.  # noqa: E501
+        """
+        return self._visitor_id
+
+    @visitor_id.setter
+    def visitor_id(self, visitor_id: str):
+        """Sets the visitor_id of this RelatedVisitor.
+
+        Visitor ID of a browser that originates from the same mobile device as the input visitor ID.  # noqa: E501
+
+        :param visitor_id: The visitor_id of this RelatedVisitor.  # noqa: E501
+        """
+        if visitor_id is None:
+            raise ValueError("Invalid value for `visitor_id`, must not be `None`")  # noqa: E501
+
+        self._visitor_id = visitor_id
+
diff --git a/fingerprint_pro_server_api_sdk/models/related_visitors_response.py b/fingerprint_pro_server_api_sdk/models/related_visitors_response.py
@@ -0,0 +1,65 @@
+# coding: utf-8
+
+"""
+    Fingerprint Pro Server API
+
+    Fingerprint Pro Server API allows you to get information about visitors and about individual 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.   # noqa: E501
+
+    OpenAPI spec version: 3
+    Contact: support@fingerprint.com
+    Generated by: https://github.com/swagger-api/swagger-codegen.git
+"""
+
+import re  # noqa: F401
+from typing import Dict, List, Optional  # noqa: F401
+from fingerprint_pro_server_api_sdk.base_model import BaseModel
+from fingerprint_pro_server_api_sdk.models.related_visitor import RelatedVisitor
+
+
+class RelatedVisitorsResponse(BaseModel):
+    """NOTE: This class is auto generated by the swagger code generator program.
+
+    Do not edit the class manually.
+    """
+    """
+    Attributes:
+      swagger_types (dict): The key is attribute name
+                            and the value is attribute type.
+      attribute_map (dict): The key is attribute name
+                            and the value is json key in definition.
+    """
+    swagger_types = {
+        'related_visitors': 'list[RelatedVisitor]'
+    }
+
+    attribute_map = {
+        'related_visitors': 'relatedVisitors'
+    }
+
+    def __init__(self, related_visitors=None):  # noqa: E501
+        """RelatedVisitorsResponse - a model defined in Swagger"""  # noqa: E501
+        self._related_visitors = None
+        self.discriminator = None
+        self.related_visitors = related_visitors
+
+    @property
+    def related_visitors(self) -> List[RelatedVisitor]:
+        """Gets the related_visitors of this RelatedVisitorsResponse.  # noqa: E501
+
+
+        :return: The related_visitors of this RelatedVisitorsResponse.  # noqa: E501
+        """
+        return self._related_visitors
+
+    @related_visitors.setter
+    def related_visitors(self, related_visitors: List[RelatedVisitor]):
+        """Sets the related_visitors of this RelatedVisitorsResponse.
+
+
+        :param related_visitors: The related_visitors of this RelatedVisitorsResponse.  # noqa: E501
+        """
+        if related_visitors is None:
+            raise ValueError("Invalid value for `related_visitors`, must not be `None`")  # noqa: E501
+
+        self._related_visitors = related_visitors
+
diff --git a/res/fingerprint-server-api.yaml b/res/fingerprint-server-api.yaml

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +---
 +'fingerprint-pro-server-api-python-sdk': minor
 +---
++
 +Add `relay` detection method to the VPN Detection Smart Signal