Coverage for fingerprint_pro_server_api_sdk/models/velocity.py: 92%

1# coding: utf-8 

2 

3""" 

4 Fingerprint Pro Server API 

5 

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 

7 

8 OpenAPI spec version: 3 

9 Contact: support@fingerprint.com 

10 Generated by: https://github.com/swagger-api/swagger-codegen.git 

11""" 

12 

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.velocity_data import VelocityData 

17from fingerprint_pro_server_api_sdk.models.velocity_data import VelocityData 

18from fingerprint_pro_server_api_sdk.models.velocity_data import VelocityData 

19from fingerprint_pro_server_api_sdk.models.velocity_data import VelocityData 

20from fingerprint_pro_server_api_sdk.models.velocity_data import VelocityData 

21from fingerprint_pro_server_api_sdk.models.velocity_data import VelocityData 

22from fingerprint_pro_server_api_sdk.models.velocity_data import VelocityData 

23 

24 

25class Velocity(BaseModel): 

26 """ 

27 Sums key data points for a specific `visitorId`, `ipAddress` and `linkedId` at three distinct time intervals: 5 minutes, 1 hour, and 24 hours as follows: - Number of distinct IP addresses associated to the visitor ID. - Number of distinct linked IDs associated with the visitor ID. - Number of distinct countries associated with the visitor ID. - Number of identification events associated with the visitor ID. - Number of identification events associated with the detected IP address. - Number of distinct IP addresses associated with the provided linked ID. - Number of distinct visitor IDs associated with the provided linked ID. The `24h` interval of `distinctIp`, `distinctLinkedId`, `distinctCountry`, `distinctIpByLinkedId` and `distinctVisitorIdByLinkedId` will be omitted if the number of `events` for the visitor ID in the last 24 hours (`events.intervals.['24h']`) is higher than 20.000.  

28 

29 NOTE: This class is auto generated by the swagger code generator program. 

30 

31 Do not edit the class manually. 

32 """ 

33 """ 

34 Attributes: 

35 swagger_types (dict): The key is attribute name 

36 and the value is attribute type. 

37 attribute_map (dict): The key is attribute name 

38 and the value is json key in definition. 

39 """ 

40 swagger_types = { 

41 'distinct_ip': 'VelocityData', 

42 'distinct_linked_id': 'VelocityData', 

43 'distinct_country': 'VelocityData', 

44 'events': 'VelocityData', 

45 'ip_events': 'VelocityData', 

46 'distinct_ip_by_linked_id': 'VelocityData', 

47 'distinct_visitor_id_by_linked_id': 'VelocityData' 

48 } 

49 

50 nullable_map = { 

51 'distinct_ip': False, 

52 'distinct_linked_id': False, 

53 'distinct_country': False, 

54 'events': False, 

55 'ip_events': False, 

56 'distinct_ip_by_linked_id': False, 

57 'distinct_visitor_id_by_linked_id': False 

58 } 

59 

60 attribute_map = { 

61 'distinct_ip': 'distinctIp', 

62 'distinct_linked_id': 'distinctLinkedId', 

63 'distinct_country': 'distinctCountry', 

64 'events': 'events', 

65 'ip_events': 'ipEvents', 

66 'distinct_ip_by_linked_id': 'distinctIpByLinkedId', 

67 'distinct_visitor_id_by_linked_id': 'distinctVisitorIdByLinkedId' 

68 } 

69 

70 def __init__(self, distinct_ip=None, distinct_linked_id=None, distinct_country=None, events=None, ip_events=None, distinct_ip_by_linked_id=None, distinct_visitor_id_by_linked_id=None): # noqa: E501 

71 """Velocity - a model defined in Swagger""" # noqa: E501 

72 self._distinct_ip = None 

73 self._distinct_linked_id = None 

74 self._distinct_country = None 

75 self._events = None 

76 self._ip_events = None 

77 self._distinct_ip_by_linked_id = None 

78 self._distinct_visitor_id_by_linked_id = None 

79 self.discriminator = None 

80 self.distinct_ip = distinct_ip 

81 self.distinct_linked_id = distinct_linked_id 

82 self.distinct_country = distinct_country 

83 self.events = events 

84 self.ip_events = ip_events 

85 self.distinct_ip_by_linked_id = distinct_ip_by_linked_id 

86 self.distinct_visitor_id_by_linked_id = distinct_visitor_id_by_linked_id 

87 

88 @property 

89 def distinct_ip(self) -> VelocityData: 

90 """Gets the distinct_ip of this Velocity. # noqa: E501 

91 

92 

93 :return: The distinct_ip of this Velocity. # noqa: E501 

94 """ 

95 return self._distinct_ip 

96 

97 @distinct_ip.setter 

98 def distinct_ip(self, distinct_ip: VelocityData): 

99 """Sets the distinct_ip of this Velocity. 

100 

101 

102 :param distinct_ip: The distinct_ip of this Velocity. # noqa: E501 

103 """ 

104 if distinct_ip is None: 

105 raise ValueError("Invalid value for `distinct_ip`, must not be `None`") # noqa: E501 

106 

107 self._distinct_ip = distinct_ip 

108 

109 @property 

110 def distinct_linked_id(self) -> VelocityData: 

111 """Gets the distinct_linked_id of this Velocity. # noqa: E501 

112 

113 

114 :return: The distinct_linked_id of this Velocity. # noqa: E501 

115 """ 

116 return self._distinct_linked_id 

117 

118 @distinct_linked_id.setter 

119 def distinct_linked_id(self, distinct_linked_id: VelocityData): 

120 """Sets the distinct_linked_id of this Velocity. 

121 

122 

123 :param distinct_linked_id: The distinct_linked_id of this Velocity. # noqa: E501 

124 """ 

125 if distinct_linked_id is None: 

126 raise ValueError("Invalid value for `distinct_linked_id`, must not be `None`") # noqa: E501 

127 

128 self._distinct_linked_id = distinct_linked_id 

129 

130 @property 

131 def distinct_country(self) -> VelocityData: 

132 """Gets the distinct_country of this Velocity. # noqa: E501 

133 

134 

135 :return: The distinct_country of this Velocity. # noqa: E501 

136 """ 

137 return self._distinct_country 

138 

139 @distinct_country.setter 

140 def distinct_country(self, distinct_country: VelocityData): 

141 """Sets the distinct_country of this Velocity. 

142 

143 

144 :param distinct_country: The distinct_country of this Velocity. # noqa: E501 

145 """ 

146 if distinct_country is None: 

147 raise ValueError("Invalid value for `distinct_country`, must not be `None`") # noqa: E501 

148 

149 self._distinct_country = distinct_country 

150 

151 @property 

152 def events(self) -> VelocityData: 

153 """Gets the events of this Velocity. # noqa: E501 

154 

155 

156 :return: The events of this Velocity. # noqa: E501 

157 """ 

158 return self._events 

159 

160 @events.setter 

161 def events(self, events: VelocityData): 

162 """Sets the events of this Velocity. 

163 

164 

165 :param events: The events of this Velocity. # noqa: E501 

166 """ 

167 if events is None: 

168 raise ValueError("Invalid value for `events`, must not be `None`") # noqa: E501 

169 

170 self._events = events 

171 

172 @property 

173 def ip_events(self) -> VelocityData: 

174 """Gets the ip_events of this Velocity. # noqa: E501 

175 

176 

177 :return: The ip_events of this Velocity. # noqa: E501 

178 """ 

179 return self._ip_events 

180 

181 @ip_events.setter 

182 def ip_events(self, ip_events: VelocityData): 

183 """Sets the ip_events of this Velocity. 

184 

185 

186 :param ip_events: The ip_events of this Velocity. # noqa: E501 

187 """ 

188 if ip_events is None: 

189 raise ValueError("Invalid value for `ip_events`, must not be `None`") # noqa: E501 

190 

191 self._ip_events = ip_events 

192 

193 @property 

194 def distinct_ip_by_linked_id(self) -> VelocityData: 

195 """Gets the distinct_ip_by_linked_id of this Velocity. # noqa: E501 

196 

197 

198 :return: The distinct_ip_by_linked_id of this Velocity. # noqa: E501 

199 """ 

200 return self._distinct_ip_by_linked_id 

201 

202 @distinct_ip_by_linked_id.setter 

203 def distinct_ip_by_linked_id(self, distinct_ip_by_linked_id: VelocityData): 

204 """Sets the distinct_ip_by_linked_id of this Velocity. 

205 

206 

207 :param distinct_ip_by_linked_id: The distinct_ip_by_linked_id of this Velocity. # noqa: E501 

208 """ 

209 if distinct_ip_by_linked_id is None: 

210 raise ValueError("Invalid value for `distinct_ip_by_linked_id`, must not be `None`") # noqa: E501 

211 

212 self._distinct_ip_by_linked_id = distinct_ip_by_linked_id 

213 

214 @property 

215 def distinct_visitor_id_by_linked_id(self) -> VelocityData: 

216 """Gets the distinct_visitor_id_by_linked_id of this Velocity. # noqa: E501 

217 

218 

219 :return: The distinct_visitor_id_by_linked_id of this Velocity. # noqa: E501 

220 """ 

221 return self._distinct_visitor_id_by_linked_id 

222 

223 @distinct_visitor_id_by_linked_id.setter 

224 def distinct_visitor_id_by_linked_id(self, distinct_visitor_id_by_linked_id: VelocityData): 

225 """Sets the distinct_visitor_id_by_linked_id of this Velocity. 

226 

227 

228 :param distinct_visitor_id_by_linked_id: The distinct_visitor_id_by_linked_id of this Velocity. # noqa: E501 

229 """ 

230 if distinct_visitor_id_by_linked_id is None: 

231 raise ValueError("Invalid value for `distinct_visitor_id_by_linked_id`, must not be `None`") # noqa: E501 

232 

233 self._distinct_visitor_id_by_linked_id = distinct_visitor_id_by_linked_id 

234