onfido-python 3.4.0__py3-none-any.whl

onfido/models/address_shared.py

@@ -0,0 +1,169 @@
+# 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, Field, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from typing_extensions import Annotated
+from onfido.models.country_codes import CountryCodes
+from typing import Optional, Set
+from typing_extensions import Self
+
+class AddressShared(BaseModel):
+    """
+    AddressShared
+    """ # noqa: E501
+    flat_number: Optional[StrictStr] = Field(default=None, description="The flat number of this address")
+    building_number: Optional[StrictStr] = Field(default=None, description="The building number of this address")
+    building_name: Optional[StrictStr] = Field(default=None, description="The building name of this address")
+    street: Optional[StrictStr] = Field(default=None, description="The street of the applicant's address")
+    sub_street: Optional[StrictStr] = Field(default=None, description="The sub-street of the applicant's address")
+    town: Optional[StrictStr] = Field(default=None, description="The town of the applicant's address")
+    postcode: StrictStr = Field(description="The postcode or ZIP of the applicant's address")
+    country: CountryCodes = Field(description="The 3 character ISO country code of this address. For example, GBR is the country code for the United Kingdom")
+    state: Optional[StrictStr] = Field(default=None, description="The address state. US states must use the USPS abbreviation (see also ISO 3166-2:US), for example AK, CA, or TX.")
+    line1: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="Line 1 of the applicant's address")
+    line2: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="Line 2 of the applicant's address")
+    line3: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="Line 3 of the applicant's address")
+    additional_properties: Dict[str, Any] = {}
+    __properties: ClassVar[List[str]] = ["flat_number", "building_number", "building_name", "street", "sub_street", "town", "postcode", "country", "state", "line1", "line2", "line3"]
+
+    @field_validator('line1')
+    def line1_validate_regular_expression(cls, value):
+        """Validates the regular expression"""
+        if value is None:
+            return value
+
+        if not re.match(r"^[^!$%^*=<>]*$", value):
+            raise ValueError(r"must validate the regular expression /^[^!$%^*=<>]*$/")
+        return value
+
+    @field_validator('line2')
+    def line2_validate_regular_expression(cls, value):
+        """Validates the regular expression"""
+        if value is None:
+            return value
+
+        if not re.match(r"^[^!$%^*=<>]*$", value):
+            raise ValueError(r"must validate the regular expression /^[^!$%^*=<>]*$/")
+        return value
+
+    @field_validator('line3')
+    def line3_validate_regular_expression(cls, value):
+        """Validates the regular expression"""
+        if value is None:
+            return value
+
+        if not re.match(r"^[^!$%^*=<>]*$", value):
+            raise ValueError(r"must validate the regular expression /^[^!$%^*=<>]*$/")
+        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 AddressShared 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
+
+        # set to None if line1 (nullable) is None
+        # and model_fields_set contains the field
+        if self.line1 is None and "line1" in self.model_fields_set:
+            _dict['line1'] = None
+
+        # set to None if line2 (nullable) is None
+        # and model_fields_set contains the field
+        if self.line2 is None and "line2" in self.model_fields_set:
+            _dict['line2'] = None
+
+        # set to None if line3 (nullable) is None
+        # and model_fields_set contains the field
+        if self.line3 is None and "line3" in self.model_fields_set:
+            _dict['line3'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of AddressShared from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "flat_number": obj.get("flat_number"),
+            "building_number": obj.get("building_number"),
+            "building_name": obj.get("building_name"),
+            "street": obj.get("street"),
+            "sub_street": obj.get("sub_street"),
+            "town": obj.get("town"),
+            "postcode": obj.get("postcode"),
+            "country": obj.get("country"),
+            "state": obj.get("state"),
+            "line1": obj.get("line1"),
+            "line2": obj.get("line2"),
+            "line3": obj.get("line3")
+        })
+        # 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/addresses_list.py

@@ -0,0 +1,108 @@
+# 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.address import Address
+from typing import Optional, Set
+from typing_extensions import Self
+
+class AddressesList(BaseModel):
+    """
+    AddressesList
+    """ # noqa: E501
+    addresses: Optional[List[Address]] = None
+    additional_properties: Dict[str, Any] = {}
+    __properties: ClassVar[List[str]] = ["addresses"]
+
+    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 AddressesList 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 each item in addresses (list)
+        _items = []
+        if self.addresses:
+            for _item in self.addresses:
+                if _item:
+                    _items.append(_item.to_dict())
+            _dict['addresses'] = _items
+        # 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 AddressesList from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "addresses": [Address.from_dict(_item) for _item in obj["addresses"]] if obj.get("addresses") 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/applicant.py

@@ -0,0 +1,162 @@
+# 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 datetime import date, datetime
+from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from typing_extensions import Annotated
+from onfido.models.address import Address
+from onfido.models.id_number import IdNumber
+from onfido.models.location import Location
+from typing import Optional, Set
+from typing_extensions import Self
+
+class Applicant(BaseModel):
+    """
+    Applicant
+    """ # noqa: E501
+    email: Optional[StrictStr] = Field(default=None, description="The applicant's email address. Required if doing a US check, or a UK check for which `applicant_provides_data` is `true`.")
+    dob: Optional[date] = Field(default=None, description="The applicant's date of birth")
+    id_numbers: Optional[List[IdNumber]] = None
+    phone_number: Optional[StrictStr] = Field(default=None, description="The applicant's phone number")
+    first_name: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="The applicant's first name")
+    last_name: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="The applicant's surname")
+    id: StrictStr = Field(description="The unique identifier for the applicant.")
+    created_at: Optional[datetime] = Field(default=None, description="The date and time when this applicant was created.")
+    delete_at: Optional[datetime] = Field(default=None, description="The date and time when this applicant is scheduled to be deleted.")
+    href: Optional[StrictStr] = Field(default=None, description="The uri of this resource.")
+    sandbox: Optional[StrictBool] = None
+    address: Optional[Address] = None
+    location: Optional[Location] = None
+    additional_properties: Dict[str, Any] = {}
+    __properties: ClassVar[List[str]] = ["email", "dob", "id_numbers", "phone_number", "first_name", "last_name", "id", "created_at", "delete_at", "href", "sandbox", "address", "location"]
+
+    @field_validator('first_name')
+    def first_name_validate_regular_expression(cls, value):
+        """Validates the regular expression"""
+        if value is None:
+            return value
+
+        if not re.match(r"^[^!#$%*=<>;{}\"]*$", value):
+            raise ValueError(r"must validate the regular expression /^[^!#$%*=<>;{}\"]*$/")
+        return value
+
+    @field_validator('last_name')
+    def last_name_validate_regular_expression(cls, value):
+        """Validates the regular expression"""
+        if value is None:
+            return value
+
+        if not re.match(r"^[^!#$%*=<>;{}\"]*$", value):
+            raise ValueError(r"must validate the regular expression /^[^!#$%*=<>;{}\"]*$/")
+        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 Applicant 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 each item in id_numbers (list)
+        _items = []
+        if self.id_numbers:
+            for _item in self.id_numbers:
+                if _item:
+                    _items.append(_item.to_dict())
+            _dict['id_numbers'] = _items
+        # override the default output from pydantic by calling `to_dict()` of address
+        if self.address:
+            _dict['address'] = self.address.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of location
+        if self.location:
+            _dict['location'] = self.location.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 Applicant from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "email": obj.get("email"),
+            "dob": obj.get("dob"),
+            "id_numbers": [IdNumber.from_dict(_item) for _item in obj["id_numbers"]] if obj.get("id_numbers") is not None else None,
+            "phone_number": obj.get("phone_number"),
+            "first_name": obj.get("first_name"),
+            "last_name": obj.get("last_name"),
+            "id": obj.get("id"),
+            "created_at": obj.get("created_at"),
+            "delete_at": obj.get("delete_at"),
+            "href": obj.get("href"),
+            "sandbox": obj.get("sandbox"),
+            "address": Address.from_dict(obj["address"]) if obj.get("address") is not None else None,
+            "location": Location.from_dict(obj["location"]) if obj.get("location") 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/applicant_builder.py

@@ -0,0 +1,152 @@
+# 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 datetime import date
+from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from typing_extensions import Annotated
+from onfido.models.address_builder import AddressBuilder
+from onfido.models.consents_builder import ConsentsBuilder
+from onfido.models.id_number import IdNumber
+from onfido.models.location_builder import LocationBuilder
+from typing import Optional, Set
+from typing_extensions import Self
+
+class ApplicantBuilder(BaseModel):
+    """
+    ApplicantBuilder
+    """ # noqa: E501
+    email: Optional[StrictStr] = Field(default=None, description="The applicant's email address. Required if doing a US check, or a UK check for which `applicant_provides_data` is `true`.")
+    dob: Optional[date] = Field(default=None, description="The applicant's date of birth")
+    id_numbers: Optional[List[IdNumber]] = None
+    phone_number: Optional[StrictStr] = Field(default=None, description="The applicant's phone number")
+    consents: Optional[ConsentsBuilder] = None
+    address: Optional[AddressBuilder] = None
+    location: Optional[LocationBuilder] = None
+    first_name: Annotated[str, Field(strict=True)] = Field(description="The applicant's first name")
+    last_name: Annotated[str, Field(strict=True)] = Field(description="The applicant's surname")
+    additional_properties: Dict[str, Any] = {}
+    __properties: ClassVar[List[str]] = ["email", "dob", "id_numbers", "phone_number", "consents", "address", "location", "first_name", "last_name"]
+
+    @field_validator('first_name')
+    def first_name_validate_regular_expression(cls, value):
+        """Validates the regular expression"""
+        if not re.match(r"^[^!#$%*=<>;{}\"]*$", value):
+            raise ValueError(r"must validate the regular expression /^[^!#$%*=<>;{}\"]*$/")
+        return value
+
+    @field_validator('last_name')
+    def last_name_validate_regular_expression(cls, value):
+        """Validates the regular expression"""
+        if not re.match(r"^[^!#$%*=<>;{}\"]*$", value):
+            raise ValueError(r"must validate the regular expression /^[^!#$%*=<>;{}\"]*$/")
+        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 ApplicantBuilder 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 each item in id_numbers (list)
+        _items = []
+        if self.id_numbers:
+            for _item in self.id_numbers:
+                if _item:
+                    _items.append(_item.to_dict())
+            _dict['id_numbers'] = _items
+        # override the default output from pydantic by calling `to_dict()` of consents
+        if self.consents:
+            _dict['consents'] = self.consents.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of address
+        if self.address:
+            _dict['address'] = self.address.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of location
+        if self.location:
+            _dict['location'] = self.location.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 ApplicantBuilder from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "email": obj.get("email"),
+            "dob": obj.get("dob"),
+            "id_numbers": [IdNumber.from_dict(_item) for _item in obj["id_numbers"]] if obj.get("id_numbers") is not None else None,
+            "phone_number": obj.get("phone_number"),
+            "consents": ConsentsBuilder.from_dict(obj["consents"]) if obj.get("consents") is not None else None,
+            "address": AddressBuilder.from_dict(obj["address"]) if obj.get("address") is not None else None,
+            "location": LocationBuilder.from_dict(obj["location"]) if obj.get("location") is not None else None,
+            "first_name": obj.get("first_name"),
+            "last_name": obj.get("last_name")
+        })
+        # 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
+
+