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

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 attribute_map = { 

51 'distinct_ip': 'distinctIp', 

52 'distinct_linked_id': 'distinctLinkedId', 

53 'distinct_country': 'distinctCountry', 

54 'events': 'events', 

55 'ip_events': 'ipEvents', 

56 'distinct_ip_by_linked_id': 'distinctIpByLinkedId', 

57 'distinct_visitor_id_by_linked_id': 'distinctVisitorIdByLinkedId' 

58 } 

59 

60 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 

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

62 self._distinct_ip = None 

63 self._distinct_linked_id = None 

64 self._distinct_country = None 

65 self._events = None 

66 self._ip_events = None 

67 self._distinct_ip_by_linked_id = None 

68 self._distinct_visitor_id_by_linked_id = None 

69 self.discriminator = None 

70 self.distinct_ip = distinct_ip 

71 self.distinct_linked_id = distinct_linked_id 

72 self.distinct_country = distinct_country 

73 self.events = events 

74 self.ip_events = ip_events 

75 self.distinct_ip_by_linked_id = distinct_ip_by_linked_id 

76 self.distinct_visitor_id_by_linked_id = distinct_visitor_id_by_linked_id 

77 

78 @property 

79 def distinct_ip(self) -> VelocityData: 

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

81 

82 

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

84 """ 

85 return self._distinct_ip 

86 

87 @distinct_ip.setter 

88 def distinct_ip(self, distinct_ip: VelocityData): 

89 """Sets the distinct_ip of this Velocity. 

90 

91 

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

93 """ 

94 if distinct_ip is None: 

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

96 

97 self._distinct_ip = distinct_ip 

98 

99 @property 

100 def distinct_linked_id(self) -> VelocityData: 

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

102 

103 

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

105 """ 

106 return self._distinct_linked_id 

107 

108 @distinct_linked_id.setter 

109 def distinct_linked_id(self, distinct_linked_id: VelocityData): 

110 """Sets the distinct_linked_id of this Velocity. 

111 

112 

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

114 """ 

115 if distinct_linked_id is None: 

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

117 

118 self._distinct_linked_id = distinct_linked_id 

119 

120 @property 

121 def distinct_country(self) -> VelocityData: 

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

123 

124 

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

126 """ 

127 return self._distinct_country 

128 

129 @distinct_country.setter 

130 def distinct_country(self, distinct_country: VelocityData): 

131 """Sets the distinct_country of this Velocity. 

132 

133 

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

135 """ 

136 if distinct_country is None: 

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

138 

139 self._distinct_country = distinct_country 

140 

141 @property 

142 def events(self) -> VelocityData: 

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

144 

145 

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

147 """ 

148 return self._events 

149 

150 @events.setter 

151 def events(self, events: VelocityData): 

152 """Sets the events of this Velocity. 

153 

154 

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

156 """ 

157 if events is None: 

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

159 

160 self._events = events 

161 

162 @property 

163 def ip_events(self) -> VelocityData: 

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

165 

166 

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

168 """ 

169 return self._ip_events 

170 

171 @ip_events.setter 

172 def ip_events(self, ip_events: VelocityData): 

173 """Sets the ip_events of this Velocity. 

174 

175 

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

177 """ 

178 if ip_events is None: 

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

180 

181 self._ip_events = ip_events 

182 

183 @property 

184 def distinct_ip_by_linked_id(self) -> VelocityData: 

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

186 

187 

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

189 """ 

190 return self._distinct_ip_by_linked_id 

191 

192 @distinct_ip_by_linked_id.setter 

193 def distinct_ip_by_linked_id(self, distinct_ip_by_linked_id: VelocityData): 

194 """Sets the distinct_ip_by_linked_id of this Velocity. 

195 

196 

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

198 """ 

199 if distinct_ip_by_linked_id is None: 

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

201 

202 self._distinct_ip_by_linked_id = distinct_ip_by_linked_id 

203 

204 @property 

205 def distinct_visitor_id_by_linked_id(self) -> VelocityData: 

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

207 

208 

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

210 """ 

211 return self._distinct_visitor_id_by_linked_id 

212 

213 @distinct_visitor_id_by_linked_id.setter 

214 def distinct_visitor_id_by_linked_id(self, distinct_visitor_id_by_linked_id: VelocityData): 

215 """Sets the distinct_visitor_id_by_linked_id of this Velocity. 

216 

217 

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

219 """ 

220 if distinct_visitor_id_by_linked_id is None: 

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

222 

223 self._distinct_visitor_id_by_linked_id = distinct_visitor_id_by_linked_id 

224