Coverage for fingerprint_pro_server_api_sdk/models/visitors_get_response.py: 92%
48 statements
« prev ^ index » next coverage.py v7.6.9, created at 2024-12-09 17:50 +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 attribute_map = {
42 'visitor_id': 'visitorId',
43 'visits': 'visits',
44 'last_timestamp': 'lastTimestamp',
45 'pagination_key': 'paginationKey'
46 }
48 def __init__(self, visitor_id=None, visits=None, last_timestamp=None, pagination_key=None): # noqa: E501
49 """VisitorsGetResponse - a model defined in Swagger""" # noqa: E501
50 self._visitor_id = None
51 self._visits = None
52 self._last_timestamp = None
53 self._pagination_key = None
54 self.discriminator = None
55 self.visitor_id = visitor_id
56 self.visits = visits
57 if last_timestamp is not None:
58 self.last_timestamp = last_timestamp
59 if pagination_key is not None:
60 self.pagination_key = pagination_key
62 @property
63 def visitor_id(self) -> str:
64 """Gets the visitor_id of this VisitorsGetResponse. # noqa: E501
67 :return: The visitor_id of this VisitorsGetResponse. # noqa: E501
68 """
69 return self._visitor_id
71 @visitor_id.setter
72 def visitor_id(self, visitor_id: str):
73 """Sets the visitor_id of this VisitorsGetResponse.
76 :param visitor_id: The visitor_id of this VisitorsGetResponse. # noqa: E501
77 """
78 if visitor_id is None:
79 raise ValueError("Invalid value for `visitor_id`, must not be `None`") # noqa: E501
81 self._visitor_id = visitor_id
83 @property
84 def visits(self) -> List[Visit]:
85 """Gets the visits of this VisitorsGetResponse. # noqa: E501
88 :return: The visits of this VisitorsGetResponse. # noqa: E501
89 """
90 return self._visits
92 @visits.setter
93 def visits(self, visits: List[Visit]):
94 """Sets the visits of this VisitorsGetResponse.
97 :param visits: The visits of this VisitorsGetResponse. # noqa: E501
98 """
99 if visits is None:
100 raise ValueError("Invalid value for `visits`, must not be `None`") # noqa: E501
102 self._visits = visits
104 @property
105 def last_timestamp(self) -> Optional[int]:
106 """Gets the last_timestamp of this VisitorsGetResponse. # noqa: E501
108 ⚠️ Deprecated paging attribute, please use `paginationKey` instead. Timestamp of the last visit in the current page of results. # noqa: E501
110 :return: The last_timestamp of this VisitorsGetResponse. # noqa: E501
111 """
112 return self._last_timestamp
114 @last_timestamp.setter
115 def last_timestamp(self, last_timestamp: Optional[int]):
116 """Sets the last_timestamp of this VisitorsGetResponse.
118 ⚠️ Deprecated paging attribute, please use `paginationKey` instead. Timestamp of the last visit in the current page of results. # noqa: E501
120 :param last_timestamp: The last_timestamp of this VisitorsGetResponse. # noqa: E501
121 """
123 self._last_timestamp = last_timestamp
125 @property
126 def pagination_key(self) -> Optional[str]:
127 """Gets the pagination_key of this VisitorsGetResponse. # noqa: E501
129 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
131 :return: The pagination_key of this VisitorsGetResponse. # noqa: E501
132 """
133 return self._pagination_key
135 @pagination_key.setter
136 def pagination_key(self, pagination_key: Optional[str]):
137 """Sets the pagination_key of this VisitorsGetResponse.
139 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
141 :param pagination_key: The pagination_key of this VisitorsGetResponse. # noqa: E501
142 """
144 self._pagination_key = pagination_key