From 3eec745c25b5aa62c1437cb7cfc1e26999be7aa1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Przemys=C5=82aw=20=C5=BBydek?= Date: Fri, 9 Sep 2022 11:11:49 +0100 Subject: [PATCH] chore: update schema --- docs/ProductsResponseIdentificationData.md | 14 + docs/Visit.md | 14 + docs/WebhookVisit.md | 14 + .../products_response_identification_data.py | 394 ++++++++++++++++- .../models/visit.py | 394 ++++++++++++++++- .../models/webhook_visit.py | 398 +++++++++++++++++- res/fingerprint-server-api.yaml | 241 ++++++++--- 7 files changed, 1408 insertions(+), 61 deletions(-) diff --git a/docs/ProductsResponseIdentificationData.md b/docs/ProductsResponseIdentificationData.md index 7a486c84..7e4a91f4 100644 --- a/docs/ProductsResponseIdentificationData.md +++ b/docs/ProductsResponseIdentificationData.md @@ -3,6 +3,20 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- +**request_id** | **str** | Unique identifier of the user's identification request. | +**browser_details** | [**BrowserDetails**](BrowserDetails.md) | | +**incognito** | **bool** | Flag if user used incognito session. | +**ip** | **str** | | +**ip_location** | [**IPLocation**](IPLocation.md) | | +**timestamp** | **int** | Timestamp of the event with millisecond precision in Unix time. | +**time** | **datetime** | Time expressed according to ISO 8601 in UTC format. | +**url** | **str** | Page URL from which identification request was sent. | +**tag** | **dict(str, object)** | A customer-provided value or an object that was sent with identification request. | [optional] +**linked_id** | **str** | A customer-provided id that was sent with identification request. | [optional] +**confidence** | [**Confidence**](Confidence.md) | | +**visitor_found** | **bool** | Attribute represents if a visitor had been identified before. | +**first_seen_at** | [**StSeenAt**](StSeenAt.md) | | +**last_seen_at** | [**StSeenAt**](StSeenAt.md) | | **visitor_id** | **str** | | [[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/Visit.md b/docs/Visit.md index ac025723..2b8c6b6f 100644 --- a/docs/Visit.md +++ b/docs/Visit.md @@ -3,6 +3,20 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- +**request_id** | **str** | Unique identifier of the user's identification request. | +**browser_details** | [**BrowserDetails**](BrowserDetails.md) | | +**incognito** | **bool** | Flag if user used incognito session. | +**ip** | **str** | | +**ip_location** | [**IPLocation**](IPLocation.md) | | +**timestamp** | **int** | Timestamp of the event with millisecond precision in Unix time. | +**time** | **datetime** | Time expressed according to ISO 8601 in UTC format. | +**url** | **str** | Page URL from which identification request was sent. | +**tag** | **dict(str, object)** | A customer-provided value or an object that was sent with identification request. | [optional] +**linked_id** | **str** | A customer-provided id that was sent with identification request. | [optional] +**confidence** | [**Confidence**](Confidence.md) | | +**visitor_found** | **bool** | Attribute represents if a visitor had been identified before. | +**first_seen_at** | [**StSeenAt**](StSeenAt.md) | | +**last_seen_at** | [**StSeenAt**](StSeenAt.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/WebhookVisit.md b/docs/WebhookVisit.md index bf3a7571..e12857c3 100644 --- a/docs/WebhookVisit.md +++ b/docs/WebhookVisit.md @@ -5,6 +5,20 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **visitor_id** | **str** | | **client_referrer** | **str** | | [optional] +**request_id** | **str** | Unique identifier of the user's identification request. | +**browser_details** | [**BrowserDetails**](BrowserDetails.md) | | +**incognito** | **bool** | Flag if user used incognito session. | +**ip** | **str** | | +**ip_location** | [**IPLocation**](IPLocation.md) | | +**timestamp** | **int** | Timestamp of the event with millisecond precision in Unix time. | +**time** | **datetime** | Time expressed according to ISO 8601 in UTC format. | +**url** | **str** | Page URL from which identification request was sent. | +**tag** | **dict(str, object)** | A customer-provided value or an object that was sent with identification request. | [optional] +**linked_id** | **str** | A customer-provided id that was sent with identification request. | [optional] +**confidence** | [**Confidence**](Confidence.md) | | +**visitor_found** | **bool** | Attribute represents if a visitor had been identified before. | +**first_seen_at** | [**StSeenAt**](StSeenAt.md) | | +**last_seen_at** | [**StSeenAt**](StSeenAt.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/models/products_response_identification_data.py b/fingerprint_pro_server_api_sdk/models/products_response_identification_data.py index 300d29ef..f210618a 100644 --- a/fingerprint_pro_server_api_sdk/models/products_response_identification_data.py +++ b/fingerprint_pro_server_api_sdk/models/products_response_identification_data.py @@ -28,19 +28,411 @@ class ProductsResponseIdentificationData(object): and the value is json key in definition. """ swagger_types = { + 'request_id': 'str', + 'browser_details': 'BrowserDetails', + 'incognito': 'bool', + 'ip': 'str', + 'ip_location': 'IPLocation', + 'timestamp': 'int', + 'time': 'datetime', + 'url': 'str', + 'tag': 'dict(str, object)', + 'linked_id': 'str', + 'confidence': 'Confidence', + 'visitor_found': 'bool', + 'first_seen_at': 'StSeenAt', + 'last_seen_at': 'StSeenAt', 'visitor_id': 'str' } attribute_map = { + 'request_id': 'requestId', + 'browser_details': 'browserDetails', + 'incognito': 'incognito', + 'ip': 'ip', + 'ip_location': 'ipLocation', + 'timestamp': 'timestamp', + 'time': 'time', + 'url': 'url', + 'tag': 'tag', + 'linked_id': 'linkedId', + 'confidence': 'confidence', + 'visitor_found': 'visitorFound', + 'first_seen_at': 'firstSeenAt', + 'last_seen_at': 'lastSeenAt', 'visitor_id': 'visitorId' } - def __init__(self, visitor_id=None): # noqa: E501 + def __init__(self, request_id=None, browser_details=None, incognito=None, ip=None, ip_location=None, timestamp=None, time=None, url=None, tag=None, linked_id=None, confidence=None, visitor_found=None, first_seen_at=None, last_seen_at=None, visitor_id=None): # noqa: E501 """ProductsResponseIdentificationData - a model defined in Swagger""" # noqa: E501 + self._request_id = None + self._browser_details = None + self._incognito = None + self._ip = None + self._ip_location = None + self._timestamp = None + self._time = None + self._url = None + self._tag = None + self._linked_id = None + self._confidence = None + self._visitor_found = None + self._first_seen_at = None + self._last_seen_at = None self._visitor_id = None self.discriminator = None + self.request_id = request_id + self.browser_details = browser_details + self.incognito = incognito + self.ip = ip + self.ip_location = ip_location + self.timestamp = timestamp + self.time = time + self.url = url + if tag is not None: + self.tag = tag + if linked_id is not None: + self.linked_id = linked_id + self.confidence = confidence + self.visitor_found = visitor_found + self.first_seen_at = first_seen_at + self.last_seen_at = last_seen_at self.visitor_id = visitor_id + @property + def request_id(self): + """Gets the request_id of this ProductsResponseIdentificationData. # noqa: E501 + + Unique identifier of the user's identification request. # noqa: E501 + + :return: The request_id of this ProductsResponseIdentificationData. # noqa: E501 + :rtype: str + """ + return self._request_id + + @request_id.setter + def request_id(self, request_id): + """Sets the request_id of this ProductsResponseIdentificationData. + + Unique identifier of the user's identification request. # noqa: E501 + + :param request_id: The request_id of this ProductsResponseIdentificationData. # noqa: E501 + :type: str + """ + if request_id is None: + raise ValueError("Invalid value for `request_id`, must not be `None`") # noqa: E501 + + self._request_id = request_id + + @property + def browser_details(self): + """Gets the browser_details of this ProductsResponseIdentificationData. # noqa: E501 + + + :return: The browser_details of this ProductsResponseIdentificationData. # noqa: E501 + :rtype: BrowserDetails + """ + return self._browser_details + + @browser_details.setter + def browser_details(self, browser_details): + """Sets the browser_details of this ProductsResponseIdentificationData. + + + :param browser_details: The browser_details of this ProductsResponseIdentificationData. # noqa: E501 + :type: BrowserDetails + """ + if browser_details is None: + raise ValueError("Invalid value for `browser_details`, must not be `None`") # noqa: E501 + + self._browser_details = browser_details + + @property + def incognito(self): + """Gets the incognito of this ProductsResponseIdentificationData. # noqa: E501 + + Flag if user used incognito session. # noqa: E501 + + :return: The incognito of this ProductsResponseIdentificationData. # noqa: E501 + :rtype: bool + """ + return self._incognito + + @incognito.setter + def incognito(self, incognito): + """Sets the incognito of this ProductsResponseIdentificationData. + + Flag if user used incognito session. # noqa: E501 + + :param incognito: The incognito of this ProductsResponseIdentificationData. # noqa: E501 + :type: bool + """ + if incognito is None: + raise ValueError("Invalid value for `incognito`, must not be `None`") # noqa: E501 + + self._incognito = incognito + + @property + def ip(self): + """Gets the ip of this ProductsResponseIdentificationData. # noqa: E501 + + + :return: The ip of this ProductsResponseIdentificationData. # noqa: E501 + :rtype: str + """ + return self._ip + + @ip.setter + def ip(self, ip): + """Sets the ip of this ProductsResponseIdentificationData. + + + :param ip: The ip of this ProductsResponseIdentificationData. # noqa: E501 + :type: str + """ + if ip is None: + raise ValueError("Invalid value for `ip`, must not be `None`") # noqa: E501 + + self._ip = ip + + @property + def ip_location(self): + """Gets the ip_location of this ProductsResponseIdentificationData. # noqa: E501 + + + :return: The ip_location of this ProductsResponseIdentificationData. # noqa: E501 + :rtype: IPLocation + """ + return self._ip_location + + @ip_location.setter + def ip_location(self, ip_location): + """Sets the ip_location of this ProductsResponseIdentificationData. + + + :param ip_location: The ip_location of this ProductsResponseIdentificationData. # noqa: E501 + :type: IPLocation + """ + if ip_location is None: + raise ValueError("Invalid value for `ip_location`, must not be `None`") # noqa: E501 + + self._ip_location = ip_location + + @property + def timestamp(self): + """Gets the timestamp of this ProductsResponseIdentificationData. # noqa: E501 + + Timestamp of the event with millisecond precision in Unix time. # noqa: E501 + + :return: The timestamp of this ProductsResponseIdentificationData. # noqa: E501 + :rtype: int + """ + return self._timestamp + + @timestamp.setter + def timestamp(self, timestamp): + """Sets the timestamp of this ProductsResponseIdentificationData. + + Timestamp of the event with millisecond precision in Unix time. # noqa: E501 + + :param timestamp: The timestamp of this ProductsResponseIdentificationData. # noqa: E501 + :type: int + """ + if timestamp is None: + raise ValueError("Invalid value for `timestamp`, must not be `None`") # noqa: E501 + + self._timestamp = timestamp + + @property + def time(self): + """Gets the time of this ProductsResponseIdentificationData. # noqa: E501 + + Time expressed according to ISO 8601 in UTC format. # noqa: E501 + + :return: The time of this ProductsResponseIdentificationData. # noqa: E501 + :rtype: datetime + """ + return self._time + + @time.setter + def time(self, time): + """Sets the time of this ProductsResponseIdentificationData. + + Time expressed according to ISO 8601 in UTC format. # noqa: E501 + + :param time: The time of this ProductsResponseIdentificationData. # noqa: E501 + :type: datetime + """ + if time is None: + raise ValueError("Invalid value for `time`, must not be `None`") # noqa: E501 + + self._time = time + + @property + def url(self): + """Gets the url of this ProductsResponseIdentificationData. # noqa: E501 + + Page URL from which identification request was sent. # noqa: E501 + + :return: The url of this ProductsResponseIdentificationData. # noqa: E501 + :rtype: str + """ + return self._url + + @url.setter + def url(self, url): + """Sets the url of this ProductsResponseIdentificationData. + + Page URL from which identification request was sent. # noqa: E501 + + :param url: The url of this ProductsResponseIdentificationData. # 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 tag(self): + """Gets the tag of this ProductsResponseIdentificationData. # noqa: E501 + + A customer-provided value or an object that was sent with identification request. # noqa: E501 + + :return: The tag of this ProductsResponseIdentificationData. # noqa: E501 + :rtype: dict(str, object) + """ + return self._tag + + @tag.setter + def tag(self, tag): + """Sets the tag of this ProductsResponseIdentificationData. + + A customer-provided value or an object that was sent with identification request. # noqa: E501 + + :param tag: The tag of this ProductsResponseIdentificationData. # noqa: E501 + :type: dict(str, object) + """ + + self._tag = tag + + @property + def linked_id(self): + """Gets the linked_id of this ProductsResponseIdentificationData. # noqa: E501 + + A customer-provided id that was sent with identification request. # noqa: E501 + + :return: The linked_id of this ProductsResponseIdentificationData. # noqa: E501 + :rtype: str + """ + return self._linked_id + + @linked_id.setter + def linked_id(self, linked_id): + """Sets the linked_id of this ProductsResponseIdentificationData. + + A customer-provided id that was sent with identification request. # noqa: E501 + + :param linked_id: The linked_id of this ProductsResponseIdentificationData. # noqa: E501 + :type: str + """ + + self._linked_id = linked_id + + @property + def confidence(self): + """Gets the confidence of this ProductsResponseIdentificationData. # noqa: E501 + + + :return: The confidence of this ProductsResponseIdentificationData. # noqa: E501 + :rtype: Confidence + """ + return self._confidence + + @confidence.setter + def confidence(self, confidence): + """Sets the confidence of this ProductsResponseIdentificationData. + + + :param confidence: The confidence of this ProductsResponseIdentificationData. # noqa: E501 + :type: Confidence + """ + if confidence is None: + raise ValueError("Invalid value for `confidence`, must not be `None`") # noqa: E501 + + self._confidence = confidence + + @property + def visitor_found(self): + """Gets the visitor_found of this ProductsResponseIdentificationData. # noqa: E501 + + Attribute represents if a visitor had been identified before. # noqa: E501 + + :return: The visitor_found of this ProductsResponseIdentificationData. # noqa: E501 + :rtype: bool + """ + return self._visitor_found + + @visitor_found.setter + def visitor_found(self, visitor_found): + """Sets the visitor_found of this ProductsResponseIdentificationData. + + Attribute represents if a visitor had been identified before. # noqa: E501 + + :param visitor_found: The visitor_found of this ProductsResponseIdentificationData. # noqa: E501 + :type: bool + """ + if visitor_found is None: + raise ValueError("Invalid value for `visitor_found`, must not be `None`") # noqa: E501 + + self._visitor_found = visitor_found + + @property + def first_seen_at(self): + """Gets the first_seen_at of this ProductsResponseIdentificationData. # noqa: E501 + + + :return: The first_seen_at of this ProductsResponseIdentificationData. # noqa: E501 + :rtype: StSeenAt + """ + return self._first_seen_at + + @first_seen_at.setter + def first_seen_at(self, first_seen_at): + """Sets the first_seen_at of this ProductsResponseIdentificationData. + + + :param first_seen_at: The first_seen_at of this ProductsResponseIdentificationData. # noqa: E501 + :type: StSeenAt + """ + if first_seen_at is None: + raise ValueError("Invalid value for `first_seen_at`, must not be `None`") # noqa: E501 + + self._first_seen_at = first_seen_at + + @property + def last_seen_at(self): + """Gets the last_seen_at of this ProductsResponseIdentificationData. # noqa: E501 + + + :return: The last_seen_at of this ProductsResponseIdentificationData. # noqa: E501 + :rtype: StSeenAt + """ + return self._last_seen_at + + @last_seen_at.setter + def last_seen_at(self, last_seen_at): + """Sets the last_seen_at of this ProductsResponseIdentificationData. + + + :param last_seen_at: The last_seen_at of this ProductsResponseIdentificationData. # noqa: E501 + :type: StSeenAt + """ + if last_seen_at is None: + raise ValueError("Invalid value for `last_seen_at`, must not be `None`") # noqa: E501 + + self._last_seen_at = last_seen_at + @property def visitor_id(self): """Gets the visitor_id of this ProductsResponseIdentificationData. # noqa: E501 diff --git a/fingerprint_pro_server_api_sdk/models/visit.py b/fingerprint_pro_server_api_sdk/models/visit.py index 06753aaf..b49154e2 100644 --- a/fingerprint_pro_server_api_sdk/models/visit.py +++ b/fingerprint_pro_server_api_sdk/models/visit.py @@ -28,14 +28,406 @@ class Visit(object): and the value is json key in definition. """ swagger_types = { + 'request_id': 'str', + 'browser_details': 'BrowserDetails', + 'incognito': 'bool', + 'ip': 'str', + 'ip_location': 'IPLocation', + 'timestamp': 'int', + 'time': 'datetime', + 'url': 'str', + 'tag': 'dict(str, object)', + 'linked_id': 'str', + 'confidence': 'Confidence', + 'visitor_found': 'bool', + 'first_seen_at': 'StSeenAt', + 'last_seen_at': 'StSeenAt' } attribute_map = { + 'request_id': 'requestId', + 'browser_details': 'browserDetails', + 'incognito': 'incognito', + 'ip': 'ip', + 'ip_location': 'ipLocation', + 'timestamp': 'timestamp', + 'time': 'time', + 'url': 'url', + 'tag': 'tag', + 'linked_id': 'linkedId', + 'confidence': 'confidence', + 'visitor_found': 'visitorFound', + 'first_seen_at': 'firstSeenAt', + 'last_seen_at': 'lastSeenAt' } - def __init__(self): # noqa: E501 + def __init__(self, request_id=None, browser_details=None, incognito=None, ip=None, ip_location=None, timestamp=None, time=None, url=None, tag=None, linked_id=None, confidence=None, visitor_found=None, first_seen_at=None, last_seen_at=None): # noqa: E501 """Visit - a model defined in Swagger""" # noqa: E501 + self._request_id = None + self._browser_details = None + self._incognito = None + self._ip = None + self._ip_location = None + self._timestamp = None + self._time = None + self._url = None + self._tag = None + self._linked_id = None + self._confidence = None + self._visitor_found = None + self._first_seen_at = None + self._last_seen_at = None self.discriminator = None + self.request_id = request_id + self.browser_details = browser_details + self.incognito = incognito + self.ip = ip + self.ip_location = ip_location + self.timestamp = timestamp + self.time = time + self.url = url + if tag is not None: + self.tag = tag + if linked_id is not None: + self.linked_id = linked_id + self.confidence = confidence + self.visitor_found = visitor_found + self.first_seen_at = first_seen_at + self.last_seen_at = last_seen_at + + @property + def request_id(self): + """Gets the request_id of this Visit. # noqa: E501 + + Unique identifier of the user's identification request. # noqa: E501 + + :return: The request_id of this Visit. # noqa: E501 + :rtype: str + """ + return self._request_id + + @request_id.setter + def request_id(self, request_id): + """Sets the request_id of this Visit. + + Unique identifier of the user's identification request. # noqa: E501 + + :param request_id: The request_id of this Visit. # noqa: E501 + :type: str + """ + if request_id is None: + raise ValueError("Invalid value for `request_id`, must not be `None`") # noqa: E501 + + self._request_id = request_id + + @property + def browser_details(self): + """Gets the browser_details of this Visit. # noqa: E501 + + + :return: The browser_details of this Visit. # noqa: E501 + :rtype: BrowserDetails + """ + return self._browser_details + + @browser_details.setter + def browser_details(self, browser_details): + """Sets the browser_details of this Visit. + + + :param browser_details: The browser_details of this Visit. # noqa: E501 + :type: BrowserDetails + """ + if browser_details is None: + raise ValueError("Invalid value for `browser_details`, must not be `None`") # noqa: E501 + + self._browser_details = browser_details + + @property + def incognito(self): + """Gets the incognito of this Visit. # noqa: E501 + + Flag if user used incognito session. # noqa: E501 + + :return: The incognito of this Visit. # noqa: E501 + :rtype: bool + """ + return self._incognito + + @incognito.setter + def incognito(self, incognito): + """Sets the incognito of this Visit. + + Flag if user used incognito session. # noqa: E501 + + :param incognito: The incognito of this Visit. # noqa: E501 + :type: bool + """ + if incognito is None: + raise ValueError("Invalid value for `incognito`, must not be `None`") # noqa: E501 + + self._incognito = incognito + + @property + def ip(self): + """Gets the ip of this Visit. # noqa: E501 + + + :return: The ip of this Visit. # noqa: E501 + :rtype: str + """ + return self._ip + + @ip.setter + def ip(self, ip): + """Sets the ip of this Visit. + + + :param ip: The ip of this Visit. # noqa: E501 + :type: str + """ + if ip is None: + raise ValueError("Invalid value for `ip`, must not be `None`") # noqa: E501 + + self._ip = ip + + @property + def ip_location(self): + """Gets the ip_location of this Visit. # noqa: E501 + + + :return: The ip_location of this Visit. # noqa: E501 + :rtype: IPLocation + """ + return self._ip_location + + @ip_location.setter + def ip_location(self, ip_location): + """Sets the ip_location of this Visit. + + + :param ip_location: The ip_location of this Visit. # noqa: E501 + :type: IPLocation + """ + if ip_location is None: + raise ValueError("Invalid value for `ip_location`, must not be `None`") # noqa: E501 + + self._ip_location = ip_location + + @property + def timestamp(self): + """Gets the timestamp of this Visit. # noqa: E501 + + Timestamp of the event with millisecond precision in Unix time. # noqa: E501 + + :return: The timestamp of this Visit. # noqa: E501 + :rtype: int + """ + return self._timestamp + + @timestamp.setter + def timestamp(self, timestamp): + """Sets the timestamp of this Visit. + + Timestamp of the event with millisecond precision in Unix time. # noqa: E501 + + :param timestamp: The timestamp of this Visit. # noqa: E501 + :type: int + """ + if timestamp is None: + raise ValueError("Invalid value for `timestamp`, must not be `None`") # noqa: E501 + + self._timestamp = timestamp + + @property + def time(self): + """Gets the time of this Visit. # noqa: E501 + + Time expressed according to ISO 8601 in UTC format. # noqa: E501 + + :return: The time of this Visit. # noqa: E501 + :rtype: datetime + """ + return self._time + + @time.setter + def time(self, time): + """Sets the time of this Visit. + + Time expressed according to ISO 8601 in UTC format. # noqa: E501 + + :param time: The time of this Visit. # noqa: E501 + :type: datetime + """ + if time is None: + raise ValueError("Invalid value for `time`, must not be `None`") # noqa: E501 + + self._time = time + + @property + def url(self): + """Gets the url of this Visit. # noqa: E501 + + Page URL from which identification request was sent. # noqa: E501 + + :return: The url of this Visit. # noqa: E501 + :rtype: str + """ + return self._url + + @url.setter + def url(self, url): + """Sets the url of this Visit. + + Page URL from which identification request was sent. # noqa: E501 + + :param url: The url of this Visit. # 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 tag(self): + """Gets the tag of this Visit. # noqa: E501 + + A customer-provided value or an object that was sent with identification request. # noqa: E501 + + :return: The tag of this Visit. # noqa: E501 + :rtype: dict(str, object) + """ + return self._tag + + @tag.setter + def tag(self, tag): + """Sets the tag of this Visit. + + A customer-provided value or an object that was sent with identification request. # noqa: E501 + + :param tag: The tag of this Visit. # noqa: E501 + :type: dict(str, object) + """ + + self._tag = tag + + @property + def linked_id(self): + """Gets the linked_id of this Visit. # noqa: E501 + + A customer-provided id that was sent with identification request. # noqa: E501 + + :return: The linked_id of this Visit. # noqa: E501 + :rtype: str + """ + return self._linked_id + + @linked_id.setter + def linked_id(self, linked_id): + """Sets the linked_id of this Visit. + + A customer-provided id that was sent with identification request. # noqa: E501 + + :param linked_id: The linked_id of this Visit. # noqa: E501 + :type: str + """ + + self._linked_id = linked_id + + @property + def confidence(self): + """Gets the confidence of this Visit. # noqa: E501 + + + :return: The confidence of this Visit. # noqa: E501 + :rtype: Confidence + """ + return self._confidence + + @confidence.setter + def confidence(self, confidence): + """Sets the confidence of this Visit. + + + :param confidence: The confidence of this Visit. # noqa: E501 + :type: Confidence + """ + if confidence is None: + raise ValueError("Invalid value for `confidence`, must not be `None`") # noqa: E501 + + self._confidence = confidence + + @property + def visitor_found(self): + """Gets the visitor_found of this Visit. # noqa: E501 + + Attribute represents if a visitor had been identified before. # noqa: E501 + + :return: The visitor_found of this Visit. # noqa: E501 + :rtype: bool + """ + return self._visitor_found + + @visitor_found.setter + def visitor_found(self, visitor_found): + """Sets the visitor_found of this Visit. + + Attribute represents if a visitor had been identified before. # noqa: E501 + + :param visitor_found: The visitor_found of this Visit. # noqa: E501 + :type: bool + """ + if visitor_found is None: + raise ValueError("Invalid value for `visitor_found`, must not be `None`") # noqa: E501 + + self._visitor_found = visitor_found + + @property + def first_seen_at(self): + """Gets the first_seen_at of this Visit. # noqa: E501 + + + :return: The first_seen_at of this Visit. # noqa: E501 + :rtype: StSeenAt + """ + return self._first_seen_at + + @first_seen_at.setter + def first_seen_at(self, first_seen_at): + """Sets the first_seen_at of this Visit. + + + :param first_seen_at: The first_seen_at of this Visit. # noqa: E501 + :type: StSeenAt + """ + if first_seen_at is None: + raise ValueError("Invalid value for `first_seen_at`, must not be `None`") # noqa: E501 + + self._first_seen_at = first_seen_at + + @property + def last_seen_at(self): + """Gets the last_seen_at of this Visit. # noqa: E501 + + + :return: The last_seen_at of this Visit. # noqa: E501 + :rtype: StSeenAt + """ + return self._last_seen_at + + @last_seen_at.setter + def last_seen_at(self, last_seen_at): + """Sets the last_seen_at of this Visit. + + + :param last_seen_at: The last_seen_at of this Visit. # noqa: E501 + :type: StSeenAt + """ + if last_seen_at is None: + raise ValueError("Invalid value for `last_seen_at`, must not be `None`") # noqa: E501 + + self._last_seen_at = last_seen_at def to_dict(self): """Returns the model properties as a dict""" diff --git a/fingerprint_pro_server_api_sdk/models/webhook_visit.py b/fingerprint_pro_server_api_sdk/models/webhook_visit.py index c3c1667a..0b0f6ebf 100644 --- a/fingerprint_pro_server_api_sdk/models/webhook_visit.py +++ b/fingerprint_pro_server_api_sdk/models/webhook_visit.py @@ -29,22 +29,80 @@ class WebhookVisit(object): """ swagger_types = { 'visitor_id': 'str', - 'client_referrer': 'str' + 'client_referrer': 'str', + 'request_id': 'str', + 'browser_details': 'BrowserDetails', + 'incognito': 'bool', + 'ip': 'str', + 'ip_location': 'IPLocation', + 'timestamp': 'int', + 'time': 'datetime', + 'url': 'str', + 'tag': 'dict(str, object)', + 'linked_id': 'str', + 'confidence': 'Confidence', + 'visitor_found': 'bool', + 'first_seen_at': 'StSeenAt', + 'last_seen_at': 'StSeenAt' } attribute_map = { 'visitor_id': 'visitorId', - 'client_referrer': 'clientReferrer' + 'client_referrer': 'clientReferrer', + 'request_id': 'requestId', + 'browser_details': 'browserDetails', + 'incognito': 'incognito', + 'ip': 'ip', + 'ip_location': 'ipLocation', + 'timestamp': 'timestamp', + 'time': 'time', + 'url': 'url', + 'tag': 'tag', + 'linked_id': 'linkedId', + 'confidence': 'confidence', + 'visitor_found': 'visitorFound', + 'first_seen_at': 'firstSeenAt', + 'last_seen_at': 'lastSeenAt' } - def __init__(self, visitor_id=None, client_referrer=None): # noqa: E501 + def __init__(self, visitor_id=None, client_referrer=None, request_id=None, browser_details=None, incognito=None, ip=None, ip_location=None, timestamp=None, time=None, url=None, tag=None, linked_id=None, confidence=None, visitor_found=None, first_seen_at=None, last_seen_at=None): # noqa: E501 """WebhookVisit - a model defined in Swagger""" # noqa: E501 self._visitor_id = None self._client_referrer = None + self._request_id = None + self._browser_details = None + self._incognito = None + self._ip = None + self._ip_location = None + self._timestamp = None + self._time = None + self._url = None + self._tag = None + self._linked_id = None + self._confidence = None + self._visitor_found = None + self._first_seen_at = None + self._last_seen_at = None self.discriminator = None self.visitor_id = visitor_id if client_referrer is not None: self.client_referrer = client_referrer + self.request_id = request_id + self.browser_details = browser_details + self.incognito = incognito + self.ip = ip + self.ip_location = ip_location + self.timestamp = timestamp + self.time = time + self.url = url + if tag is not None: + self.tag = tag + if linked_id is not None: + self.linked_id = linked_id + self.confidence = confidence + self.visitor_found = visitor_found + self.first_seen_at = first_seen_at + self.last_seen_at = last_seen_at @property def visitor_id(self): @@ -90,6 +148,340 @@ def client_referrer(self, client_referrer): self._client_referrer = client_referrer + @property + def request_id(self): + """Gets the request_id of this WebhookVisit. # noqa: E501 + + Unique identifier of the user's identification request. # noqa: E501 + + :return: The request_id of this WebhookVisit. # noqa: E501 + :rtype: str + """ + return self._request_id + + @request_id.setter + def request_id(self, request_id): + """Sets the request_id of this WebhookVisit. + + Unique identifier of the user's identification request. # noqa: E501 + + :param request_id: The request_id of this WebhookVisit. # noqa: E501 + :type: str + """ + if request_id is None: + raise ValueError("Invalid value for `request_id`, must not be `None`") # noqa: E501 + + self._request_id = request_id + + @property + def browser_details(self): + """Gets the browser_details of this WebhookVisit. # noqa: E501 + + + :return: The browser_details of this WebhookVisit. # noqa: E501 + :rtype: BrowserDetails + """ + return self._browser_details + + @browser_details.setter + def browser_details(self, browser_details): + """Sets the browser_details of this WebhookVisit. + + + :param browser_details: The browser_details of this WebhookVisit. # noqa: E501 + :type: BrowserDetails + """ + if browser_details is None: + raise ValueError("Invalid value for `browser_details`, must not be `None`") # noqa: E501 + + self._browser_details = browser_details + + @property + def incognito(self): + """Gets the incognito of this WebhookVisit. # noqa: E501 + + Flag if user used incognito session. # noqa: E501 + + :return: The incognito of this WebhookVisit. # noqa: E501 + :rtype: bool + """ + return self._incognito + + @incognito.setter + def incognito(self, incognito): + """Sets the incognito of this WebhookVisit. + + Flag if user used incognito session. # noqa: E501 + + :param incognito: The incognito of this WebhookVisit. # noqa: E501 + :type: bool + """ + if incognito is None: + raise ValueError("Invalid value for `incognito`, must not be `None`") # noqa: E501 + + self._incognito = incognito + + @property + def ip(self): + """Gets the ip of this WebhookVisit. # noqa: E501 + + + :return: The ip of this WebhookVisit. # noqa: E501 + :rtype: str + """ + return self._ip + + @ip.setter + def ip(self, ip): + """Sets the ip of this WebhookVisit. + + + :param ip: The ip of this WebhookVisit. # noqa: E501 + :type: str + """ + if ip is None: + raise ValueError("Invalid value for `ip`, must not be `None`") # noqa: E501 + + self._ip = ip + + @property + def ip_location(self): + """Gets the ip_location of this WebhookVisit. # noqa: E501 + + + :return: The ip_location of this WebhookVisit. # noqa: E501 + :rtype: IPLocation + """ + return self._ip_location + + @ip_location.setter + def ip_location(self, ip_location): + """Sets the ip_location of this WebhookVisit. + + + :param ip_location: The ip_location of this WebhookVisit. # noqa: E501 + :type: IPLocation + """ + if ip_location is None: + raise ValueError("Invalid value for `ip_location`, must not be `None`") # noqa: E501 + + self._ip_location = ip_location + + @property + def timestamp(self): + """Gets the timestamp of this WebhookVisit. # noqa: E501 + + Timestamp of the event with millisecond precision in Unix time. # noqa: E501 + + :return: The timestamp of this WebhookVisit. # noqa: E501 + :rtype: int + """ + return self._timestamp + + @timestamp.setter + def timestamp(self, timestamp): + """Sets the timestamp of this WebhookVisit. + + Timestamp of the event with millisecond precision in Unix time. # noqa: E501 + + :param timestamp: The timestamp of this WebhookVisit. # noqa: E501 + :type: int + """ + if timestamp is None: + raise ValueError("Invalid value for `timestamp`, must not be `None`") # noqa: E501 + + self._timestamp = timestamp + + @property + def time(self): + """Gets the time of this WebhookVisit. # noqa: E501 + + Time expressed according to ISO 8601 in UTC format. # noqa: E501 + + :return: The time of this WebhookVisit. # noqa: E501 + :rtype: datetime + """ + return self._time + + @time.setter + def time(self, time): + """Sets the time of this WebhookVisit. + + Time expressed according to ISO 8601 in UTC format. # noqa: E501 + + :param time: The time of this WebhookVisit. # noqa: E501 + :type: datetime + """ + if time is None: + raise ValueError("Invalid value for `time`, must not be `None`") # noqa: E501 + + self._time = time + + @property + def url(self): + """Gets the url of this WebhookVisit. # noqa: E501 + + Page URL from which identification request was sent. # noqa: E501 + + :return: The url of this WebhookVisit. # noqa: E501 + :rtype: str + """ + return self._url + + @url.setter + def url(self, url): + """Sets the url of this WebhookVisit. + + Page URL from which identification request was sent. # noqa: E501 + + :param url: The url of this WebhookVisit. # 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 tag(self): + """Gets the tag of this WebhookVisit. # noqa: E501 + + A customer-provided value or an object that was sent with identification request. # noqa: E501 + + :return: The tag of this WebhookVisit. # noqa: E501 + :rtype: dict(str, object) + """ + return self._tag + + @tag.setter + def tag(self, tag): + """Sets the tag of this WebhookVisit. + + A customer-provided value or an object that was sent with identification request. # noqa: E501 + + :param tag: The tag of this WebhookVisit. # noqa: E501 + :type: dict(str, object) + """ + + self._tag = tag + + @property + def linked_id(self): + """Gets the linked_id of this WebhookVisit. # noqa: E501 + + A customer-provided id that was sent with identification request. # noqa: E501 + + :return: The linked_id of this WebhookVisit. # noqa: E501 + :rtype: str + """ + return self._linked_id + + @linked_id.setter + def linked_id(self, linked_id): + """Sets the linked_id of this WebhookVisit. + + A customer-provided id that was sent with identification request. # noqa: E501 + + :param linked_id: The linked_id of this WebhookVisit. # noqa: E501 + :type: str + """ + + self._linked_id = linked_id + + @property + def confidence(self): + """Gets the confidence of this WebhookVisit. # noqa: E501 + + + :return: The confidence of this WebhookVisit. # noqa: E501 + :rtype: Confidence + """ + return self._confidence + + @confidence.setter + def confidence(self, confidence): + """Sets the confidence of this WebhookVisit. + + + :param confidence: The confidence of this WebhookVisit. # noqa: E501 + :type: Confidence + """ + if confidence is None: + raise ValueError("Invalid value for `confidence`, must not be `None`") # noqa: E501 + + self._confidence = confidence + + @property + def visitor_found(self): + """Gets the visitor_found of this WebhookVisit. # noqa: E501 + + Attribute represents if a visitor had been identified before. # noqa: E501 + + :return: The visitor_found of this WebhookVisit. # noqa: E501 + :rtype: bool + """ + return self._visitor_found + + @visitor_found.setter + def visitor_found(self, visitor_found): + """Sets the visitor_found of this WebhookVisit. + + Attribute represents if a visitor had been identified before. # noqa: E501 + + :param visitor_found: The visitor_found of this WebhookVisit. # noqa: E501 + :type: bool + """ + if visitor_found is None: + raise ValueError("Invalid value for `visitor_found`, must not be `None`") # noqa: E501 + + self._visitor_found = visitor_found + + @property + def first_seen_at(self): + """Gets the first_seen_at of this WebhookVisit. # noqa: E501 + + + :return: The first_seen_at of this WebhookVisit. # noqa: E501 + :rtype: StSeenAt + """ + return self._first_seen_at + + @first_seen_at.setter + def first_seen_at(self, first_seen_at): + """Sets the first_seen_at of this WebhookVisit. + + + :param first_seen_at: The first_seen_at of this WebhookVisit. # noqa: E501 + :type: StSeenAt + """ + if first_seen_at is None: + raise ValueError("Invalid value for `first_seen_at`, must not be `None`") # noqa: E501 + + self._first_seen_at = first_seen_at + + @property + def last_seen_at(self): + """Gets the last_seen_at of this WebhookVisit. # noqa: E501 + + + :return: The last_seen_at of this WebhookVisit. # noqa: E501 + :rtype: StSeenAt + """ + return self._last_seen_at + + @last_seen_at.setter + def last_seen_at(self, last_seen_at): + """Sets the last_seen_at of this WebhookVisit. + + + :param last_seen_at: The last_seen_at of this WebhookVisit. # noqa: E501 + :type: StSeenAt + """ + if last_seen_at is None: + raise ValueError("Invalid value for `last_seen_at`, must not be `None`") # noqa: E501 + + self._last_seen_at = last_seen_at + def to_dict(self): """Returns the model properties as a dict""" result = {} diff --git a/res/fingerprint-server-api.yaml b/res/fingerprint-server-api.yaml index 1f64d4b9..04882cb9 100644 --- a/res/fingerprint-server-api.yaml +++ b/res/fingerprint-server-api.yaml @@ -2980,61 +2980,61 @@ components: items: type: object properties: - requestId: &ref_0 + requestId: description: Unique identifier of the user's identification request. type: string example: 1654815516083.OX6kx8 - browserDetails: &ref_1 + browserDetails: $ref: '#/components/schemas/BrowserDetails' - incognito: &ref_2 + incognito: description: Flag if user used incognito session. type: boolean - ip: &ref_3 + ip: type: string format: ipv4 example: 8.8.8.8 - ipLocation: &ref_4 + ipLocation: $ref: '#/components/schemas/IPLocation' - timestamp: &ref_5 + timestamp: description: >- Timestamp of the event with millisecond precision in Unix time. type: integer format: int64 example: 1654815516086 - time: &ref_6 + time: description: Time expressed according to ISO 8601 in UTC format. type: string format: date-time example: '2022-06-09T22:58:36Z' - url: &ref_7 + url: description: Page URL from which identification request was sent. type: string format: uri example: https://some.website/path?query=params - tag: &ref_8 + tag: description: >- A customer-provided value or an object that was sent with identification request. type: object additionalProperties: true - linkedId: &ref_9 + linkedId: description: >- A customer-provided id that was sent with identification request. type: string example: someID - confidence: &ref_10 + confidence: $ref: '#/components/schemas/Confidence' - visitorFound: &ref_11 + visitorFound: description: Attribute represents if a visitor had been identified before. type: boolean - firstSeenAt: &ref_12 + firstSeenAt: $ref: '#/components/schemas/StSeenAt' example: global: '2022-05-05T18:28:54.535Z' subscription: '2022-06-09T22:58:05.576Z' - lastSeenAt: &ref_13 + lastSeenAt: $ref: '#/components/schemas/StSeenAt' example: global: '2022-06-09T22:58:35.795Z' @@ -3106,20 +3106,61 @@ components: type: string clientReferrer: type: string - requestId: *ref_0 - browserDetails: *ref_1 - incognito: *ref_2 - ip: *ref_3 - ipLocation: *ref_4 - timestamp: *ref_5 - time: *ref_6 - url: *ref_7 - tag: *ref_8 - linkedId: *ref_9 - confidence: *ref_10 - visitorFound: *ref_11 - firstSeenAt: *ref_12 - lastSeenAt: *ref_13 + requestId: + description: Unique identifier of the user's identification request. + type: string + example: 1654815516083.OX6kx8 + browserDetails: + $ref: '#/components/schemas/BrowserDetails' + incognito: + description: Flag if user used incognito session. + type: boolean + ip: + type: string + format: ipv4 + example: 8.8.8.8 + ipLocation: + $ref: '#/components/schemas/IPLocation' + timestamp: + description: Timestamp of the event with millisecond precision in Unix time. + type: integer + format: int64 + example: 1654815516086 + time: + description: Time expressed according to ISO 8601 in UTC format. + 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 + example: https://some.website/path?query=params + tag: + description: >- + A customer-provided value or an object that was sent with + identification request. + type: object + additionalProperties: true + linkedId: + description: A customer-provided id that was sent with identification request. + type: string + example: someID + confidence: + $ref: '#/components/schemas/Confidence' + visitorFound: + description: Attribute represents if a visitor had been identified before. + type: boolean + firstSeenAt: + $ref: '#/components/schemas/StSeenAt' + example: + global: '2022-05-05T18:28:54.535Z' + subscription: '2022-06-09T22:58:05.576Z' + lastSeenAt: + $ref: '#/components/schemas/StSeenAt' + example: + global: '2022-06-09T22:58:35.795Z' + subscription: null additionalProperties: false required: - visitorId @@ -3139,20 +3180,61 @@ components: type: object additionalProperties: false properties: - requestId: *ref_0 - browserDetails: *ref_1 - incognito: *ref_2 - ip: *ref_3 - ipLocation: *ref_4 - timestamp: *ref_5 - time: *ref_6 - url: *ref_7 - tag: *ref_8 - linkedId: *ref_9 - confidence: *ref_10 - visitorFound: *ref_11 - firstSeenAt: *ref_12 - lastSeenAt: *ref_13 + requestId: + description: Unique identifier of the user's identification request. + type: string + example: 1654815516083.OX6kx8 + browserDetails: + $ref: '#/components/schemas/BrowserDetails' + incognito: + description: Flag if user used incognito session. + type: boolean + ip: + type: string + format: ipv4 + example: 8.8.8.8 + ipLocation: + $ref: '#/components/schemas/IPLocation' + timestamp: + description: Timestamp of the event with millisecond precision in Unix time. + type: integer + format: int64 + example: 1654815516086 + time: + description: Time expressed according to ISO 8601 in UTC format. + 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 + example: https://some.website/path?query=params + tag: + description: >- + A customer-provided value or an object that was sent with + identification request. + type: object + additionalProperties: true + linkedId: + description: A customer-provided id that was sent with identification request. + type: string + example: someID + confidence: + $ref: '#/components/schemas/Confidence' + visitorFound: + description: Attribute represents if a visitor had been identified before. + type: boolean + firstSeenAt: + $ref: '#/components/schemas/StSeenAt' + example: + global: '2022-05-05T18:28:54.535Z' + subscription: '2022-06-09T22:58:05.576Z' + lastSeenAt: + $ref: '#/components/schemas/StSeenAt' + example: + global: '2022-06-09T22:58:35.795Z' + subscription: null required: - browserDetails - confidence @@ -3332,20 +3414,67 @@ components: data: type: object properties: - requestId: *ref_0 - browserDetails: *ref_1 - incognito: *ref_2 - ip: *ref_3 - ipLocation: *ref_4 - timestamp: *ref_5 - time: *ref_6 - url: *ref_7 - tag: *ref_8 - linkedId: *ref_9 - confidence: *ref_10 - visitorFound: *ref_11 - firstSeenAt: *ref_12 - lastSeenAt: *ref_13 + requestId: + description: Unique identifier of the user's identification request. + type: string + example: 1654815516083.OX6kx8 + browserDetails: + $ref: '#/components/schemas/BrowserDetails' + incognito: + description: Flag if user used incognito session. + type: boolean + ip: + type: string + format: ipv4 + example: 8.8.8.8 + ipLocation: + $ref: '#/components/schemas/IPLocation' + timestamp: + description: >- + Timestamp of the event with millisecond precision in Unix + time. + type: integer + format: int64 + example: 1654815516086 + time: + description: Time expressed according to ISO 8601 in UTC format. + 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 + example: https://some.website/path?query=params + tag: + description: >- + A customer-provided value or an object that was sent with + identification request. + type: object + additionalProperties: true + linkedId: + description: >- + A customer-provided id that was sent with identification + request. + type: string + example: someID + confidence: + $ref: '#/components/schemas/Confidence' + visitorFound: + description: >- + Attribute represents if a visitor had been identified + before. + type: boolean + firstSeenAt: + $ref: '#/components/schemas/StSeenAt' + example: + global: '2022-05-05T18:28:54.535Z' + subscription: '2022-06-09T22:58:05.576Z' + lastSeenAt: + $ref: '#/components/schemas/StSeenAt' + example: + global: '2022-06-09T22:58:35.795Z' + subscription: null visitorId: type: string additionalProperties: false