Coverage for fingerprint_pro_server_api_sdk/models/proximity.py: 91%
43 statements
« prev ^ index » next coverage.py v7.10.6, created at 2025-09-15 16:20 +0000
1# coding: utf-8
3"""
4 Fingerprint Server API
6 Fingerprint Server API allows you to search, update, and delete identification 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
18class Proximity(BaseModel):
19 """
20 Proximity ID represents a fixed geographical zone in a discrete global grid within which the device is observed.
22 NOTE: This class is auto generated by the swagger code generator program.
24 Do not edit the class manually.
25 """
26 """
27 Attributes:
28 swagger_types (dict): The key is attribute name
29 and the value is attribute type.
30 attribute_map (dict): The key is attribute name
31 and the value is json key in definition.
32 """
33 swagger_types = {
34 'id': 'str',
35 'precision_radius': 'int',
36 'confidence': 'float'
37 }
39 nullable_map = {
40 'id': False,
41 'precision_radius': False,
42 'confidence': False
43 }
45 attribute_map = {
46 'id': 'id',
47 'precision_radius': 'precisionRadius',
48 'confidence': 'confidence'
49 }
51 def __init__(self, id=None, precision_radius=None, confidence=None): # noqa: E501
52 """Proximity - a model defined in Swagger""" # noqa: E501
53 self._id = None
54 self._precision_radius = None
55 self._confidence = None
56 self.discriminator = None
57 self.id = id
58 self.precision_radius = precision_radius
59 self.confidence = confidence
61 @property
62 def id(self) -> str:
63 """Gets the id of this Proximity. # noqa: E501
65 A stable privacy-preserving identifier for a given proximity zone. # noqa: E501
67 :return: The id of this Proximity. # noqa: E501
68 """
69 return self._id
71 @id.setter
72 def id(self, id: str):
73 """Sets the id of this Proximity.
75 A stable privacy-preserving identifier for a given proximity zone. # noqa: E501
77 :param id: The id of this Proximity. # noqa: E501
78 """
79 if id is None:
80 raise ValueError("Invalid value for `id`, must not be `None`") # noqa: E501
82 self._id = id
84 @property
85 def precision_radius(self) -> int:
86 """Gets the precision_radius of this Proximity. # noqa: E501
88 The radius of the proximity zone’s precision level, in meters. # noqa: E501
90 :return: The precision_radius of this Proximity. # noqa: E501
91 """
92 return self._precision_radius
94 @precision_radius.setter
95 def precision_radius(self, precision_radius: int):
96 """Sets the precision_radius of this Proximity.
98 The radius of the proximity zone’s precision level, in meters. # noqa: E501
100 :param precision_radius: The precision_radius of this Proximity. # noqa: E501
101 """
102 if precision_radius is None:
103 raise ValueError("Invalid value for `precision_radius`, must not be `None`") # noqa: E501
104 allowed_values = [10, 25, 65, 175, 450, 1200, 3300, 8500, 22500] # noqa: E501
105 if (precision_radius not in allowed_values):
106 raise ValueError(
107 "Invalid value for `precision_radius` ({0}), must be one of {1}" # noqa: E501
108 .format(precision_radius, allowed_values)
109 )
111 self._precision_radius = precision_radius
113 @property
114 def confidence(self) -> float:
115 """Gets the confidence of this Proximity. # noqa: E501
117 A value between `0` and `1` representing the likelihood that the true device location lies within the mapped proximity zone. * Scores closer to `1` indicate high confidence that the location is inside the mapped proximity zone. * Scores closer to `0` indicate lower confidence, suggesting the true location may fall in an adjacent zone. # noqa: E501
119 :return: The confidence of this Proximity. # noqa: E501
120 """
121 return self._confidence
123 @confidence.setter
124 def confidence(self, confidence: float):
125 """Sets the confidence of this Proximity.
127 A value between `0` and `1` representing the likelihood that the true device location lies within the mapped proximity zone. * Scores closer to `1` indicate high confidence that the location is inside the mapped proximity zone. * Scores closer to `0` indicate lower confidence, suggesting the true location may fall in an adjacent zone. # noqa: E501
129 :param confidence: The confidence of this Proximity. # noqa: E501
130 """
131 if confidence is None:
132 raise ValueError("Invalid value for `confidence`, must not be `None`") # noqa: E501
134 self._confidence = confidence