Coverage for fingerprint_server_sdk/models/proximity.py: 75%

1""" 

2Server API 

3Fingerprint Server API allows you to get, search, and update Events in a server environment. It can be used for data exports, decision-making, and data analysis scenarios. 

4Server 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. 

5The API also supports collection of Automation Intelligence for requests to your server in edge, pre-origin, or middleware contexts. 

6 

7The version of the OpenAPI document: 4 

8Contact: support@fingerprint.com 

9Generated by OpenAPI Generator (https://openapi-generator.tech) 

10 

11Do not edit the class manually. 

12""" # noqa: E501 

13 

14from __future__ import annotations 

15 

16import json 

17import pprint 

18import re # noqa: F401 

19from typing import Annotated, Any, ClassVar, Optional, Union 

20 

21from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr 

22from typing_extensions import Self 

23 

24 

25class Proximity(BaseModel): 

26 """ 

27 Proximity ID represents a fixed geographical zone in a discrete global grid within which the device is observed. 

28 """ 

29 

30 id: StrictStr = Field( 

31 description='A stable privacy-preserving identifier for a given proximity zone. ' 

32 ) 

33 precision_radius: StrictInt = Field( 

34 description='The radius of the proximity zone’s precision level, in meters. ' 

35 ) 

36 confidence: Union[ 

37 Annotated[float, Field(le=1, strict=True, ge=0)], 

38 Annotated[int, Field(le=1, strict=True, ge=0)], 

39 ] = Field( 

40 description='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. ' 

41 ) 

42 __properties: ClassVar[list[str]] = ['id', 'precision_radius', 'confidence'] 

43 

44 model_config = ConfigDict( 

45 populate_by_name=True, 

46 validate_assignment=True, 

47 protected_namespaces=(), 

48 ) 

49 

50 def to_str(self) -> str: 

51 """Returns the string representation of the model using alias""" 

52 return pprint.pformat(self.model_dump(by_alias=True)) 

53 

54 def to_json(self) -> str: 

55 """Returns the JSON representation of the model using alias""" 

56 # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead 

57 return json.dumps(self.to_dict()) 

58 

59 @classmethod 

60 def from_json(cls, json_str: str) -> Optional[Self]: 

61 """Create an instance of Proximity from a JSON string""" 

62 return cls.from_dict(json.loads(json_str)) 

63 

64 def to_dict(self) -> dict[str, Any]: 

65 """Return the dictionary representation of the model using alias. 

66 

67 This has the following differences from calling pydantic's 

68 `self.model_dump(by_alias=True)`: 

69 

70 * `None` is only added to the output dict for nullable fields that 

71 were set at model initialization. Other fields with value `None` 

72 are ignored. 

73 """ 

74 excluded_fields: set[str] = set([]) 

75 

76 _dict = self.model_dump( 

77 by_alias=True, 

78 exclude=excluded_fields, 

79 exclude_none=True, 

80 ) 

81 return _dict 

82 

83 @classmethod 

84 def from_dict(cls, obj: Optional[dict[str, Any]]) -> Optional[Self]: 

85 """Create an instance of Proximity from a dict""" 

86 if obj is None: 

87 return None 

88 

89 if not isinstance(obj, dict): 

90 return cls.model_validate(obj) 

91 

92 _obj = cls.model_validate( 

93 { 

94 'id': obj.get('id'), 

95 'precision_radius': obj.get('precision_radius'), 

96 'confidence': obj.get('confidence'), 

97 } 

98 ) 

99 return _obj