onfido-python 3.4.0__py3-none-any.whl

onfido/models/consent_item.py

@@ -0,0 +1,109 @@
+# coding: utf-8
+
+"""
+    Onfido API v3.6
+
+    The Onfido API (v3.6)
+
+    The version of the OpenAPI document: v3.6
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, StrictBool, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List
+from typing import Optional, Set
+from typing_extensions import Self
+
+class ConsentItem(BaseModel):
+    """
+    The applicant's consents
+    """ # noqa: E501
+    name: StrictStr
+    granted: StrictBool
+    additional_properties: Dict[str, Any] = {}
+    __properties: ClassVar[List[str]] = ["name", "granted"]
+
+    @field_validator('name')
+    def name_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(['privacy_notices_read', 'ssn_verification', 'phone_number_verification']):
+            raise ValueError("must be one of enum values ('privacy_notices_read', 'ssn_verification', 'phone_number_verification')")
+        return value
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of ConsentItem from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        * Fields in `self.additional_properties` are added to the output dict.
+        """
+        excluded_fields: Set[str] = set([
+            "additional_properties",
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # puts key-value pairs in additional_properties in the top level
+        if self.additional_properties is not None:
+            for _key, _value in self.additional_properties.items():
+                _dict[_key] = _value
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of ConsentItem from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "name": obj.get("name"),
+            "granted": obj.get("granted")
+        })
+        # store additional fields in additional_properties
+        for _key in obj.keys():
+            if _key not in cls.__properties:
+                _obj.additional_properties[_key] = obj.get(_key)
+
+        return _obj
+
+

onfido/models/consents_builder.py

@@ -0,0 +1,98 @@
+# coding: utf-8
+
+"""
+    Onfido API v3.6
+
+    The Onfido API (v3.6)
+
+    The version of the OpenAPI document: v3.6
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict
+from typing import Any, ClassVar, Dict, List
+from typing import Optional, Set
+from typing_extensions import Self
+
+class ConsentsBuilder(BaseModel):
+    """
+    ConsentsBuilder
+    """ # noqa: E501
+    additional_properties: Dict[str, Any] = {}
+    __properties: ClassVar[List[str]] = []
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of ConsentsBuilder from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        * Fields in `self.additional_properties` are added to the output dict.
+        """
+        excluded_fields: Set[str] = set([
+            "additional_properties",
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # puts key-value pairs in additional_properties in the top level
+        if self.additional_properties is not None:
+            for _key, _value in self.additional_properties.items():
+                _dict[_key] = _value
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of ConsentsBuilder from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+        })
+        # store additional fields in additional_properties
+        for _key in obj.keys():
+            if _key not in cls.__properties:
+                _obj.additional_properties[_key] = obj.get(_key)
+
+        return _obj
+
+

onfido/models/country_codes.py

@@ -0,0 +1,285 @@
+# coding: utf-8
+
+"""
+    Onfido API v3.6
+
+    The Onfido API (v3.6)
+
+    The version of the OpenAPI document: v3.6
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import json
+from enum import Enum
+from typing_extensions import Self
+
+
+class CountryCodes(str, Enum):
+    """
+    CountryCodes
+    """
+
+    """
+    allowed enum values
+    """
+    ABW = 'ABW'
+    AFG = 'AFG'
+    AGO = 'AGO'
+    AIA = 'AIA'
+    ALA = 'ALA'
+    ALB = 'ALB'
+    AND = 'AND'
+    ARE = 'ARE'
+    ARG = 'ARG'
+    ARM = 'ARM'
+    ASM = 'ASM'
+    ATA = 'ATA'
+    ATF = 'ATF'
+    ATG = 'ATG'
+    AUS = 'AUS'
+    AUT = 'AUT'
+    AZE = 'AZE'
+    BDI = 'BDI'
+    BEL = 'BEL'
+    BEN = 'BEN'
+    BES = 'BES'
+    BFA = 'BFA'
+    BGD = 'BGD'
+    BGR = 'BGR'
+    BHR = 'BHR'
+    BHS = 'BHS'
+    BIH = 'BIH'
+    BLM = 'BLM'
+    BLR = 'BLR'
+    BLZ = 'BLZ'
+    BMU = 'BMU'
+    BOL = 'BOL'
+    BRA = 'BRA'
+    BRB = 'BRB'
+    BRN = 'BRN'
+    BTN = 'BTN'
+    BVT = 'BVT'
+    BWA = 'BWA'
+    CAF = 'CAF'
+    CAN = 'CAN'
+    CCK = 'CCK'
+    CHE = 'CHE'
+    CHL = 'CHL'
+    CHN = 'CHN'
+    CIV = 'CIV'
+    CMR = 'CMR'
+    COD = 'COD'
+    COG = 'COG'
+    COK = 'COK'
+    COL = 'COL'
+    COM = 'COM'
+    CPV = 'CPV'
+    CRI = 'CRI'
+    CUB = 'CUB'
+    CUW = 'CUW'
+    CXR = 'CXR'
+    CYM = 'CYM'
+    CYP = 'CYP'
+    CZE = 'CZE'
+    DEU = 'DEU'
+    DJI = 'DJI'
+    DMA = 'DMA'
+    DNK = 'DNK'
+    DOM = 'DOM'
+    DZA = 'DZA'
+    ECU = 'ECU'
+    EGY = 'EGY'
+    ERI = 'ERI'
+    ESH = 'ESH'
+    ESP = 'ESP'
+    EST = 'EST'
+    ETH = 'ETH'
+    FIN = 'FIN'
+    FJI = 'FJI'
+    FLK = 'FLK'
+    FRA = 'FRA'
+    FRO = 'FRO'
+    FSM = 'FSM'
+    GAB = 'GAB'
+    GBR = 'GBR'
+    GEO = 'GEO'
+    GGY = 'GGY'
+    GHA = 'GHA'
+    GIB = 'GIB'
+    GIN = 'GIN'
+    GLP = 'GLP'
+    GMB = 'GMB'
+    GNB = 'GNB'
+    GNQ = 'GNQ'
+    GRC = 'GRC'
+    GRD = 'GRD'
+    GRL = 'GRL'
+    GTM = 'GTM'
+    GUF = 'GUF'
+    GUM = 'GUM'
+    GUY = 'GUY'
+    HKG = 'HKG'
+    HMD = 'HMD'
+    HND = 'HND'
+    HRV = 'HRV'
+    HTI = 'HTI'
+    HUN = 'HUN'
+    IDN = 'IDN'
+    IMN = 'IMN'
+    IND = 'IND'
+    IOT = 'IOT'
+    IRL = 'IRL'
+    IRN = 'IRN'
+    IRQ = 'IRQ'
+    ISL = 'ISL'
+    ISR = 'ISR'
+    ITA = 'ITA'
+    JAM = 'JAM'
+    JEY = 'JEY'
+    JOR = 'JOR'
+    JPN = 'JPN'
+    KAZ = 'KAZ'
+    KEN = 'KEN'
+    KGZ = 'KGZ'
+    KHM = 'KHM'
+    KIR = 'KIR'
+    KNA = 'KNA'
+    KOR = 'KOR'
+    KWT = 'KWT'
+    LAO = 'LAO'
+    LBN = 'LBN'
+    LBR = 'LBR'
+    LBY = 'LBY'
+    LCA = 'LCA'
+    LIE = 'LIE'
+    LKA = 'LKA'
+    LSO = 'LSO'
+    LTU = 'LTU'
+    LUX = 'LUX'
+    LVA = 'LVA'
+    MAC = 'MAC'
+    MAF = 'MAF'
+    MAR = 'MAR'
+    MCO = 'MCO'
+    MDA = 'MDA'
+    MDG = 'MDG'
+    MDV = 'MDV'
+    MEX = 'MEX'
+    MHL = 'MHL'
+    MKD = 'MKD'
+    MLI = 'MLI'
+    MLT = 'MLT'
+    MMR = 'MMR'
+    MNE = 'MNE'
+    MNG = 'MNG'
+    MNP = 'MNP'
+    MOZ = 'MOZ'
+    MRT = 'MRT'
+    MSR = 'MSR'
+    MTQ = 'MTQ'
+    MUS = 'MUS'
+    MWI = 'MWI'
+    MYS = 'MYS'
+    MYT = 'MYT'
+    NAM = 'NAM'
+    NCL = 'NCL'
+    NER = 'NER'
+    NFK = 'NFK'
+    NGA = 'NGA'
+    NIC = 'NIC'
+    NIU = 'NIU'
+    NLD = 'NLD'
+    NOR = 'NOR'
+    NPL = 'NPL'
+    NRU = 'NRU'
+    NZL = 'NZL'
+    OMN = 'OMN'
+    PAK = 'PAK'
+    PAN = 'PAN'
+    PCN = 'PCN'
+    PER = 'PER'
+    PHL = 'PHL'
+    PLW = 'PLW'
+    PNG = 'PNG'
+    POL = 'POL'
+    PRI = 'PRI'
+    PRK = 'PRK'
+    PRT = 'PRT'
+    PRY = 'PRY'
+    PSE = 'PSE'
+    PYF = 'PYF'
+    QAT = 'QAT'
+    REU = 'REU'
+    RKS = 'RKS'
+    ROU = 'ROU'
+    RUS = 'RUS'
+    RWA = 'RWA'
+    SAU = 'SAU'
+    SDN = 'SDN'
+    SEN = 'SEN'
+    SGP = 'SGP'
+    SGS = 'SGS'
+    SHN = 'SHN'
+    SJM = 'SJM'
+    SLB = 'SLB'
+    SLE = 'SLE'
+    SLV = 'SLV'
+    SMR = 'SMR'
+    SOM = 'SOM'
+    SPM = 'SPM'
+    SRB = 'SRB'
+    SSD = 'SSD'
+    STP = 'STP'
+    SUR = 'SUR'
+    SVK = 'SVK'
+    SVN = 'SVN'
+    SWE = 'SWE'
+    SWZ = 'SWZ'
+    SXM = 'SXM'
+    SYC = 'SYC'
+    SYR = 'SYR'
+    TCA = 'TCA'
+    TCD = 'TCD'
+    TGO = 'TGO'
+    THA = 'THA'
+    TJK = 'TJK'
+    TKL = 'TKL'
+    TKM = 'TKM'
+    TLS = 'TLS'
+    TON = 'TON'
+    TTO = 'TTO'
+    TUN = 'TUN'
+    TUR = 'TUR'
+    TUV = 'TUV'
+    TWN = 'TWN'
+    TZA = 'TZA'
+    UGA = 'UGA'
+    UKR = 'UKR'
+    UMI = 'UMI'
+    URY = 'URY'
+    USA = 'USA'
+    UZB = 'UZB'
+    VAT = 'VAT'
+    VCT = 'VCT'
+    VEN = 'VEN'
+    VGB = 'VGB'
+    VIR = 'VIR'
+    VNM = 'VNM'
+    VUT = 'VUT'
+    WLF = 'WLF'
+    WSM = 'WSM'
+    YEM = 'YEM'
+    ZAF = 'ZAF'
+    ZMB = 'ZMB'
+    ZWE = 'ZWE'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of CountryCodes from a JSON string"""
+        return cls(json.loads(json_str))
+
+

onfido/models/device_intelligence_breakdown.py

@@ -0,0 +1,110 @@
+# coding: utf-8
+
+"""
+    Onfido API v3.6
+
+    The Onfido API (v3.6)
+
+    The version of the OpenAPI document: v3.6
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict
+from typing import Any, ClassVar, Dict, List, Optional
+from onfido.models.device_intelligence_breakdown_breakdown import DeviceIntelligenceBreakdownBreakdown
+from onfido.models.device_intelligence_breakdown_properties import DeviceIntelligenceBreakdownProperties
+from typing import Optional, Set
+from typing_extensions import Self
+
+class DeviceIntelligenceBreakdown(BaseModel):
+    """
+    DeviceIntelligenceBreakdown
+    """ # noqa: E501
+    breakdown: Optional[DeviceIntelligenceBreakdownBreakdown] = None
+    properties: Optional[DeviceIntelligenceBreakdownProperties] = None
+    additional_properties: Dict[str, Any] = {}
+    __properties: ClassVar[List[str]] = ["breakdown", "properties"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of DeviceIntelligenceBreakdown from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        * Fields in `self.additional_properties` are added to the output dict.
+        """
+        excluded_fields: Set[str] = set([
+            "additional_properties",
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of breakdown
+        if self.breakdown:
+            _dict['breakdown'] = self.breakdown.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of properties
+        if self.properties:
+            _dict['properties'] = self.properties.to_dict()
+        # puts key-value pairs in additional_properties in the top level
+        if self.additional_properties is not None:
+            for _key, _value in self.additional_properties.items():
+                _dict[_key] = _value
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of DeviceIntelligenceBreakdown from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "breakdown": DeviceIntelligenceBreakdownBreakdown.from_dict(obj["breakdown"]) if obj.get("breakdown") is not None else None,
+            "properties": DeviceIntelligenceBreakdownProperties.from_dict(obj["properties"]) if obj.get("properties") is not None else None
+        })
+        # store additional fields in additional_properties
+        for _key in obj.keys():
+            if _key not in cls.__properties:
+                _obj.additional_properties[_key] = obj.get(_key)
+
+        return _obj
+
+

onfido/models/device_intelligence_breakdown_breakdown.py

@@ -0,0 +1,104 @@
+# coding: utf-8
+
+"""
+    Onfido API v3.6
+
+    The Onfido API (v3.6)
+
+    The version of the OpenAPI document: v3.6
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict
+from typing import Any, ClassVar, Dict, List, Optional
+from onfido.models.device_intelligence_breakdown_breakdown_device import DeviceIntelligenceBreakdownBreakdownDevice
+from typing import Optional, Set
+from typing_extensions import Self
+
+class DeviceIntelligenceBreakdownBreakdown(BaseModel):
+    """
+    DeviceIntelligenceBreakdownBreakdown
+    """ # noqa: E501
+    device: Optional[DeviceIntelligenceBreakdownBreakdownDevice] = None
+    additional_properties: Dict[str, Any] = {}
+    __properties: ClassVar[List[str]] = ["device"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of DeviceIntelligenceBreakdownBreakdown from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        * Fields in `self.additional_properties` are added to the output dict.
+        """
+        excluded_fields: Set[str] = set([
+            "additional_properties",
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of device
+        if self.device:
+            _dict['device'] = self.device.to_dict()
+        # puts key-value pairs in additional_properties in the top level
+        if self.additional_properties is not None:
+            for _key, _value in self.additional_properties.items():
+                _dict[_key] = _value
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of DeviceIntelligenceBreakdownBreakdown from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "device": DeviceIntelligenceBreakdownBreakdownDevice.from_dict(obj["device"]) if obj.get("device") is not None else None
+        })
+        # store additional fields in additional_properties
+        for _key in obj.keys():
+            if _key not in cls.__properties:
+                _obj.additional_properties[_key] = obj.get(_key)
+
+        return _obj
+
+