Coverage for fingerprint_server_sdk / models / integration.py: 71%

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. 

5 

6The version of the OpenAPI document: 4 

7Contact: support@fingerprint.com 

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

9 

10Do not edit the class manually. 

11""" # noqa: E501 

12 

13from __future__ import annotations 

14 

15import json 

16import pprint 

17import re # noqa: F401 

18from typing import Any, ClassVar, Optional 

19 

20from pydantic import BaseModel, ConfigDict, Field, StrictStr 

21from typing_extensions import Self 

22 

23from fingerprint_server_sdk.models.integration_subintegration import IntegrationSubintegration 

24 

25 

26class Integration(BaseModel): 

27 """ 

28 Integration 

29 """ 

30 

31 name: Optional[StrictStr] = Field( 

32 default=None, 

33 description='The name of the specific integration, e.g. "fingerprint-pro-react".', 

34 ) 

35 version: Optional[StrictStr] = Field( 

36 default=None, description='The version of the specific integration, e.g. "3.11.10".' 

37 ) 

38 subintegration: Optional[IntegrationSubintegration] = None 

39 __properties: ClassVar[list[str]] = ['name', 'version', 'subintegration'] 

40 

41 model_config = ConfigDict( 

42 populate_by_name=True, 

43 validate_assignment=True, 

44 protected_namespaces=(), 

45 ) 

46 

47 def to_str(self) -> str: 

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

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

50 

51 def to_json(self) -> str: 

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

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

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

55 

56 @classmethod 

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

58 """Create an instance of Integration from a JSON string""" 

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

60 

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

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

63 

64 This has the following differences from calling pydantic's 

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

66 

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

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

69 are ignored. 

70 """ 

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

72 

73 _dict = self.model_dump( 

74 by_alias=True, 

75 exclude=excluded_fields, 

76 exclude_none=True, 

77 ) 

78 # override the default output from pydantic by calling `to_dict()` of subintegration 

79 if self.subintegration: 

80 _dict['subintegration'] = self.subintegration.to_dict() 

81 return _dict 

82 

83 @classmethod 

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

85 """Create an instance of Integration 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 'name': obj.get('name'), 

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

96 'subintegration': IntegrationSubintegration.from_dict(obj['subintegration']) 

97 if obj.get('subintegration') is not None 

98 else None, 

99 } 

100 ) 

101 return _obj