Coverage for fingerprint_pro_server_api_sdk/models/visitors_get_response.py: 92%
49 statements
« prev ^ index » next coverage.py v7.6.12, created at 2025-02-21 15:03 +0000
« prev ^ index » next coverage.py v7.6.12, created at 2025-02-21 15:03 +0000
1# coding: utf-8
3"""
4 Fingerprint Pro Server API
6 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
8 OpenAPI spec version: 3
9 Contact: support@fingerprint.com
10 Generated by: https://github.com/swagger-api/swagger-codegen.git
11"""
13import re # noqa: F401
14from typing import Dict, List, Optional # noqa: F401
15from fingerprint_pro_server_api_sdk.base_model import BaseModel
16from fingerprint_pro_server_api_sdk.models.visit import Visit
19class VisitorsGetResponse(BaseModel):
20 """
21 Pagination-related fields `lastTimestamp` and `paginationKey` are included if you use a pagination parameter like `limit` or `before` and there is more data available on the next page.
23 NOTE: This class is auto generated by the swagger code generator program.
25 Do not edit the class manually.
26 """
27 """
28 Attributes:
29 swagger_types (dict): The key is attribute name
30 and the value is attribute type.
31 attribute_map (dict): The key is attribute name
32 and the value is json key in definition.
33 """
34 swagger_types = {
35 'visitor_id': 'str',
36 'visits': 'list[Visit]',
37 'last_timestamp': 'int',
38 'pagination_key': 'str'
39 }
41 nullable_map = {
42 'visitor_id': False,
43 'visits': False,
44 'last_timestamp': False,
45 'pagination_key': False
46 }
48 attribute_map = {
49 'visitor_id': 'visitorId',
50 'visits': 'visits',
51 'last_timestamp': 'lastTimestamp',
52 'pagination_key': 'paginationKey'
53 }
55 def __init__(self, visitor_id=None, visits=None, last_timestamp=None, pagination_key=None): # noqa: E501
56 """VisitorsGetResponse - a model defined in Swagger""" # noqa: E501
57 self._visitor_id = None
58 self._visits = None
59 self._last_timestamp = None
60 self._pagination_key = None
61 self.discriminator = None
62 self.visitor_id = visitor_id
63 self.visits = visits
64 if last_timestamp is not None:
65 self.last_timestamp = last_timestamp
66 if pagination_key is not None:
67 self.pagination_key = pagination_key
69 @property
70 def visitor_id(self) -> str:
71 """Gets the visitor_id of this VisitorsGetResponse. # noqa: E501
74 :return: The visitor_id of this VisitorsGetResponse. # noqa: E501
75 """
76 return self._visitor_id
78 @visitor_id.setter
79 def visitor_id(self, visitor_id: str):
80 """Sets the visitor_id of this VisitorsGetResponse.
83 :param visitor_id: The visitor_id of this VisitorsGetResponse. # noqa: E501
84 """
85 if visitor_id is None:
86 raise ValueError("Invalid value for `visitor_id`, must not be `None`") # noqa: E501
88 self._visitor_id = visitor_id
90 @property
91 def visits(self) -> List[Visit]:
92 """Gets the visits of this VisitorsGetResponse. # noqa: E501
95 :return: The visits of this VisitorsGetResponse. # noqa: E501
96 """
97 return self._visits
99 @visits.setter
100 def visits(self, visits: List[Visit]):
101 """Sets the visits of this VisitorsGetResponse.
104 :param visits: The visits of this VisitorsGetResponse. # noqa: E501
105 """
106 if visits is None:
107 raise ValueError("Invalid value for `visits`, must not be `None`") # noqa: E501
109 self._visits = visits
111 @property
112 def last_timestamp(self) -> Optional[int]:
113 """Gets the last_timestamp of this VisitorsGetResponse. # noqa: E501
115 ⚠️ Deprecated paging attribute, please use `paginationKey` instead. Timestamp of the last visit in the current page of results. # noqa: E501
117 :return: The last_timestamp of this VisitorsGetResponse. # noqa: E501
118 """
119 return self._last_timestamp
121 @last_timestamp.setter
122 def last_timestamp(self, last_timestamp: Optional[int]):
123 """Sets the last_timestamp of this VisitorsGetResponse.
125 ⚠️ Deprecated paging attribute, please use `paginationKey` instead. Timestamp of the last visit in the current page of results. # noqa: E501
127 :param last_timestamp: The last_timestamp of this VisitorsGetResponse. # noqa: E501
128 """
130 self._last_timestamp = last_timestamp
132 @property
133 def pagination_key(self) -> Optional[str]:
134 """Gets the pagination_key of this VisitorsGetResponse. # noqa: E501
136 Request ID of the last visit in the current page of results. Use this value in the following request as the `paginationKey` parameter to get the next page of results. # noqa: E501
138 :return: The pagination_key of this VisitorsGetResponse. # noqa: E501
139 """
140 return self._pagination_key
142 @pagination_key.setter
143 def pagination_key(self, pagination_key: Optional[str]):
144 """Sets the pagination_key of this VisitorsGetResponse.
146 Request ID of the last visit in the current page of results. Use this value in the following request as the `paginationKey` parameter to get the next page of results. # noqa: E501
148 :param pagination_key: The pagination_key of this VisitorsGetResponse. # noqa: E501
149 """
151 self._pagination_key = pagination_key