Coverage for fingerprint_pro_server_api_sdk/models/botd.py: 91%

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.botd_bot import BotdBot 

17from fingerprint_pro_server_api_sdk.models.tag import Tag 

18from datetime import datetime 

19 

20 

21class Botd(BaseModel): 

22 """ 

23 Contains all the information from Bot Detection product 

24 

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

26 

27 Do not edit the class manually. 

28 """ 

29 """ 

30 Attributes: 

31 swagger_types (dict): The key is attribute name 

32 and the value is attribute type. 

33 attribute_map (dict): The key is attribute name 

34 and the value is json key in definition. 

35 """ 

36 swagger_types = { 

37 'bot': 'BotdBot', 

38 'meta': 'Tag', 

39 'linked_id': 'str', 

40 'url': 'str', 

41 'ip': 'str', 

42 'time': 'datetime', 

43 'user_agent': 'str', 

44 'request_id': 'str' 

45 } 

46 

47 attribute_map = { 

48 'bot': 'bot', 

49 'meta': 'meta', 

50 'linked_id': 'linkedId', 

51 'url': 'url', 

52 'ip': 'ip', 

53 'time': 'time', 

54 'user_agent': 'userAgent', 

55 'request_id': 'requestId' 

56 } 

57 

58 def __init__(self, bot=None, meta=None, linked_id=None, url=None, ip=None, time=None, user_agent=None, request_id=None): # noqa: E501 

59 """Botd - a model defined in Swagger""" # noqa: E501 

60 self._bot = None 

61 self._meta = None 

62 self._linked_id = None 

63 self._url = None 

64 self._ip = None 

65 self._time = None 

66 self._user_agent = None 

67 self._request_id = None 

68 self.discriminator = None 

69 self.bot = bot 

70 if meta is not None: 

71 self.meta = meta 

72 if linked_id is not None: 

73 self.linked_id = linked_id 

74 self.url = url 

75 self.ip = ip 

76 self.time = time 

77 self.user_agent = user_agent 

78 self.request_id = request_id 

79 

80 @property 

81 def bot(self) -> BotdBot: 

82 """Gets the bot of this Botd. # noqa: E501 

83 

84 

85 :return: The bot of this Botd. # noqa: E501 

86 """ 

87 return self._bot 

88 

89 @bot.setter 

90 def bot(self, bot: BotdBot): 

91 """Sets the bot of this Botd. 

92 

93 

94 :param bot: The bot of this Botd. # noqa: E501 

95 """ 

96 if bot is None: 

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

98 

99 self._bot = bot 

100 

101 @property 

102 def meta(self) -> Optional[Tag]: 

103 """Gets the meta of this Botd. # noqa: E501 

104 

105 

106 :return: The meta of this Botd. # noqa: E501 

107 """ 

108 return self._meta 

109 

110 @meta.setter 

111 def meta(self, meta: Optional[Tag]): 

112 """Sets the meta of this Botd. 

113 

114 

115 :param meta: The meta of this Botd. # noqa: E501 

116 """ 

117 

118 self._meta = meta 

119 

120 @property 

121 def linked_id(self) -> Optional[str]: 

122 """Gets the linked_id of this Botd. # noqa: E501 

123 

124 A customer-provided id that was sent with the request. # noqa: E501 

125 

126 :return: The linked_id of this Botd. # noqa: E501 

127 """ 

128 return self._linked_id 

129 

130 @linked_id.setter 

131 def linked_id(self, linked_id: Optional[str]): 

132 """Sets the linked_id of this Botd. 

133 

134 A customer-provided id that was sent with the request. # noqa: E501 

135 

136 :param linked_id: The linked_id of this Botd. # noqa: E501 

137 """ 

138 

139 self._linked_id = linked_id 

140 

141 @property 

142 def url(self) -> str: 

143 """Gets the url of this Botd. # noqa: E501 

144 

145 Page URL from which the request was sent. # noqa: E501 

146 

147 :return: The url of this Botd. # noqa: E501 

148 """ 

149 return self._url 

150 

151 @url.setter 

152 def url(self, url: str): 

153 """Sets the url of this Botd. 

154 

155 Page URL from which the request was sent. # noqa: E501 

156 

157 :param url: The url of this Botd. # noqa: E501 

158 """ 

159 if url is None: 

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

161 

162 self._url = url 

163 

164 @property 

165 def ip(self) -> str: 

166 """Gets the ip of this Botd. # noqa: E501 

167 

168 IP address of the requesting browser or bot. # noqa: E501 

169 

170 :return: The ip of this Botd. # noqa: E501 

171 """ 

172 return self._ip 

173 

174 @ip.setter 

175 def ip(self, ip: str): 

176 """Sets the ip of this Botd. 

177 

178 IP address of the requesting browser or bot. # noqa: E501 

179 

180 :param ip: The ip of this Botd. # noqa: E501 

181 """ 

182 if ip is None: 

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

184 

185 self._ip = ip 

186 

187 @property 

188 def time(self) -> datetime: 

189 """Gets the time of this Botd. # noqa: E501 

190 

191 Time in UTC when the request from the JS agent was made. We recommend to treat requests that are older than 2 minutes as malicious. Otherwise, request replay attacks are possible. # noqa: E501 

192 

193 :return: The time of this Botd. # noqa: E501 

194 """ 

195 return self._time 

196 

197 @time.setter 

198 def time(self, time: datetime): 

199 """Sets the time of this Botd. 

200 

201 Time in UTC when the request from the JS agent was made. We recommend to treat requests that are older than 2 minutes as malicious. Otherwise, request replay attacks are possible. # noqa: E501 

202 

203 :param time: The time of this Botd. # noqa: E501 

204 """ 

205 if time is None: 

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

207 

208 self._time = time 

209 

210 @property 

211 def user_agent(self) -> str: 

212 """Gets the user_agent of this Botd. # noqa: E501 

213 

214 

215 :return: The user_agent of this Botd. # noqa: E501 

216 """ 

217 return self._user_agent 

218 

219 @user_agent.setter 

220 def user_agent(self, user_agent: str): 

221 """Sets the user_agent of this Botd. 

222 

223 

224 :param user_agent: The user_agent of this Botd. # noqa: E501 

225 """ 

226 if user_agent is None: 

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

228 

229 self._user_agent = user_agent 

230 

231 @property 

232 def request_id(self) -> str: 

233 """Gets the request_id of this Botd. # noqa: E501 

234 

235 Unique identifier of the user's request. # noqa: E501 

236 

237 :return: The request_id of this Botd. # noqa: E501 

238 """ 

239 return self._request_id 

240 

241 @request_id.setter 

242 def request_id(self, request_id: str): 

243 """Sets the request_id of this Botd. 

244 

245 Unique identifier of the user's request. # noqa: E501 

246 

247 :param request_id: The request_id of this Botd. # noqa: E501 

248 """ 

249 if request_id is None: 

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

251 

252 self._request_id = request_id 

253