cuenca-validations 0.11.33__tar.gz → 2.0.0__tar.gz

{cuenca_validations-0.11.33 → cuenca_validations-2.0.0}/PKG-INFO

@@ -1,23 +1,35 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: cuenca_validations
-Version: 0.11.33
+Version: 2.0.0
 Summary: Cuenca common validations
 Home-page: https://github.com/cuenca-mx/cuenca-validations
 Author: Cuenca
 Author-email: dev@cuenca.com
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.6
-Classifier: Programming Language :: Python :: 3.7
-Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
-Requires-Python: >=3.6
+Requires-Python: >=3.9
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: clabe<1.3,>=1.2
-Requires-Dist: pydantic[email]<2.0,>=1.10
-Requires-Dist: dataclasses>=0.6; python_version < "3.7"
-Requires-Dist: python-dateutil>=2.7.0
+Requires-Dist: clabe>=2.0.0
+Requires-Dist: pydantic[email]>=2.10.0
+Requires-Dist: pydantic-extra-types>=2.10.0
+Requires-Dist: python-dateutil>=2.9.0
+Requires-Dist: phonenumbers>=8.13.0
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
 
 # Cuenca - validations
 

{cuenca_validations-0.11.33 → cuenca_validations-2.0.0}/cuenca_validations/__init__.py

@@ -5,5 +5,9 @@ __all__ = [
     'validators',
 ]
 
+from pydantic_extra_types.phone_numbers import PhoneNumber
+
 from . import types, typing, validators
 from .version import __version__
+
+PhoneNumber.phone_format = 'E164'

{cuenca_validations-0.11.33 → cuenca_validations-2.0.0}/cuenca_validations/errors.py

@@ -1,39 +1,17 @@
 __all__ = [
     'ApiError',
     'AuthMethodNotAllowedError',
-    'CardBinValidationError',
     'CuencaError',
     'ERROR_CODES',
     'InvalidOTPCodeError',
     'MissingAuthorizationHeaderError',
     'NoPasswordFoundError',
-    'NotDigitError',
     'TooManyAttemptsError',
     'UserLocationError',
     'UserNotLoggedInError',
     'WrongCredsError',
 ]
 
-from pydantic.errors import (
-    NotDigitError as PydanticNotDigitError,
-    PydanticValueError,
-)
-
-
-class CardBinValidationError(PydanticValueError):
-    code = 'payment_card_number.bin'
-    msg_template = (
-        'The card number contains a BIN (first six digits) that does not have'
-        'a known association with a Mexican bank. To add the association,'
-        'please file an issue:'
-        'https://github.com/cuenca-mx/cuenca-validations/issues'
-    )
-
-
-class NotDigitError(PydanticNotDigitError):
-    code = 'digits'
-    msg_template = 'value is not all digits'
-
 
 class CuencaError(Exception):
     """Exceptions related to ApiKeys, Login, Password, etc"""

{cuenca_validations-0.11.33 → cuenca_validations-2.0.0}/cuenca_validations/types/__init__.py

@@ -22,7 +22,7 @@ __all__ = [
     'CardTransactionType',
     'CardType',
     'Country',
-    'CurpField',
+    'Curp',
     'CurpValidationRequest',
     'CommissionType',
     'DepositNetwork',
@@ -49,10 +49,8 @@ __all__ = [
     'KYCVerificationUpdateRequest',
     'Language',
     'LimitedWalletRequest',
-    'PageSize',
     'PartnerRequest',
     'PartnerUpdateRequest',
-    'PaymentCardNumber',
     'PhoneNumber',
     'PlatformRequest',
     'PlatformType',
@@ -73,7 +71,6 @@ __all__ = [
     'StatementQuery',
     'StrictPaymentCardNumber',
     'StrictPositiveInt',
-    'StrictPositiveFloat',
     'StrictTransferRequest',
     'TermsOfService',
     'TOSAgreement',
@@ -108,7 +105,7 @@ __all__ = [
     'get_state_name',
 ]
 
-from .card import PaymentCardNumber, StrictPaymentCardNumber
+from .card import StrictPaymentCardNumber
 from .enums import (
     AuthorizerTransaction,
     BankAccountStatus,
@@ -155,7 +152,6 @@ from .files import BatchFileMetadata
 from .general import (
     JSONEncoder,
     SantizedDict,
-    StrictPositiveFloat,
     StrictPositiveInt,
     digits,
     get_state_name,
@@ -163,7 +159,7 @@ from .general import (
 from .identities import (
     Address,
     Beneficiary,
-    CurpField,
+    Curp,
     KYCFile,
     PhoneNumber,
     Rfc,
@@ -182,7 +178,6 @@ from .queries import (
     EventQuery,
     FileQuery,
     IdentityQuery,
-    PageSize,
     QueryParams,
     SessionQuery,
     StatementQuery,

cuenca_validations-2.0.0/cuenca_validations/types/card.py

@@ -0,0 +1,41 @@
+from typing import Annotated
+
+from pydantic import Field, StringConstraints
+from pydantic_core import PydanticCustomError, core_schema
+from pydantic_extra_types.payment import PaymentCardNumber
+
+from ..card_bins import CARD_BINS
+
+ExpMonth = Annotated[int, Field(strict=True, ge=1, le=12)]
+ExpYear = Annotated[int, Field(strict=True, ge=1, le=99)]
+Cvv = Annotated[
+    str,
+    StringConstraints(
+        strip_whitespace=True,
+        min_length=3,
+        max_length=3,
+        pattern=r'\d{3}',
+    ),
+]
+
+
+class StrictPaymentCardNumber(PaymentCardNumber):
+
+    @classmethod
+    def validate(
+        cls, card_number: str, validation_info: core_schema.ValidationInfo
+    ) -> 'StrictPaymentCardNumber':
+        card = super().validate(card_number, validation_info)
+        if card.bin not in CARD_BINS:
+            raise PydanticCustomError(
+                'payment_card_number.bin',
+                'The card number contains a BIN (first six digits) that '
+                'does not have a known association with a Mexican bank. '
+                'To add the association, please file an issue: '
+                'https://github.com/cuenca-mx/cuenca-validations/issues',
+            )
+        return cls(card)
+
+    @property
+    def bank_code(self) -> str:
+        return CARD_BINS[self.bin]

{cuenca_validations-0.11.33 → cuenca_validations-2.0.0}/cuenca_validations/types/files.py

@@ -6,7 +6,7 @@ from .enums import KYCFileType
 
 
 class BatchFileMetadata(BaseModel):
-    id: Optional[str]
+    id: Optional[str] = None
     is_back: bool
     type: KYCFileType
     url: HttpUrl

{cuenca_validations-0.11.33 → cuenca_validations-2.0.0}/cuenca_validations/types/general.py

@@ -1,14 +1,11 @@
 import json
-from typing import TYPE_CHECKING, Optional, Type
+from typing import Annotated, Any, Optional
 
-from pydantic import ConstrainedFloat, ConstrainedInt, ConstrainedStr
+from pydantic import Field, StringConstraints
 
-from ..validators import sanitize_dict, sanitize_item, validate_digits
+from ..validators import sanitize_dict, sanitize_item
 from .enums import State
 
-if TYPE_CHECKING:
-    from pydantic.typing import CallableGenerator
-
 
 class SantizedDict(dict):
     def __init__(self, *args, **kwargs):
@@ -21,43 +18,25 @@ class JSONEncoder(json.JSONEncoder):
         return sanitize_item(o, default=super().default)
 
 
-class StrictPositiveInt(ConstrainedInt):
-    """
-    - strict: ensures a float isn't passed in by accident
-    - gt (greater than): ensures the value is strictly above 0
-    """
-
-    strict = True
-    gt = 0
-    le = 21_474_836_47  # Max value in DB
-
-    ...
-
+MAX_VALUE_IN_DB = 21_474_836_47
 
-class StrictPositiveFloat(ConstrainedFloat):
-    """
-    - strict: ensures an integer isn't passed in by accident
-    - ge (greater than or equal): ensures the value is above 0
-    """
-
-    strict = True
-    ge = 0
-
-    ...
+StrictPositiveInt = Annotated[
+    int, Field(strict=True, gt=0, le=MAX_VALUE_IN_DB)
+]
 
 
 def digits(
     min_length: Optional[int] = None, max_length: Optional[int] = None
-) -> Type[str]:
-    namespace = dict(min_length=min_length, max_length=max_length)
-    return type('DigitsValue', (Digits,), namespace)
-
-
-class Digits(ConstrainedStr):
-    @classmethod
-    def __get_validators__(cls) -> 'CallableGenerator':
-        yield from ConstrainedStr.__get_validators__()
-        yield validate_digits
+) -> Annotated[Any, StringConstraints]:
+    return Annotated[
+        str,
+        StringConstraints(
+            strip_whitespace=True,
+            min_length=min_length,
+            max_length=max_length,
+            pattern=r'^\d+$',
+        ),
+    ]
 
 
 names_state = {

cuenca_validations-2.0.0/cuenca_validations/types/identities.py

@@ -0,0 +1,173 @@
+import datetime as dt
+from typing import Annotated, Any, Optional
+
+from pydantic import (
+    BaseModel,
+    ConfigDict,
+    Field,
+    IPvAnyAddress,
+    StringConstraints,
+    model_validator,
+)
+from pydantic_extra_types.phone_numbers import PhoneNumber
+
+from .enums import Country, KYCFileType, State, VerificationStatus
+
+Password = Annotated[
+    str,
+    Field(
+        min_length=6,
+        max_length=128,
+        description=(
+            'Any str with at least 6 characters, maximum 128 characters'
+        ),
+    ),
+]
+
+Curp = Annotated[
+    str,
+    StringConstraints(
+        min_length=18,
+        max_length=18,
+        pattern=r'^[A-Z]{4}[0-9]{6}[A-Z]{6}[A-Z|0-9][0-9]$',
+    ),
+]
+
+
+Rfc = Annotated[
+    str,
+    StringConstraints(
+        min_length=12,
+        max_length=13,
+    ),
+]
+
+
+class Address(BaseModel):
+    street: Optional[str] = None
+    ext_number: Optional[str] = None
+    int_number: Optional[str] = None
+    colonia: Optional[str] = None
+    postal_code: Optional[str] = None
+    state: Optional[State] = None
+    country: Optional[Country] = None
+    city: Optional[str] = None
+    full_name: Optional[str] = None
+    model_config = ConfigDict(
+        json_schema_extra={
+            "example": {
+                "street": "Reforma",
+                "ext_number": "265",
+                "int_number": "5",
+                "colonia": "Cuauhtémoc",
+                "postal_code": "06500",
+                "state": "DF",
+                "country": "MX",
+                "city": "Cuauhtémoc",
+            }
+        }
+    )
+
+    @model_validator(mode='before')
+    @classmethod
+    def full_name_complete(cls, values: dict[str, Any]) -> dict[str, Any]:
+        if values.get('full_name'):
+            return values
+        if not values.get('street'):
+            raise ValueError('required street')
+        if not values.get('ext_number'):
+            raise ValueError('required ext_number')
+        return values
+
+
+class Beneficiary(BaseModel):
+    name: str
+    birth_date: dt.date
+    phone_number: PhoneNumber
+    user_relationship: str
+    percentage: int
+    model_config = ConfigDict(
+        json_schema_extra={
+            "example": {
+                "name": "Juan Perez",
+                "birth_date": "1907-07-06",
+                "phone_number": "+525500998877",
+                "user_relationship": "friend",
+                "percentage": 100,
+            }
+        }
+    )
+
+
+class VerificationErrors(BaseModel):
+    identifier: str = Field(
+        description='Unique identifier for the step validation'
+    )
+    error: str = Field(
+        description='Error throwed on validation,'
+        ' can be StepError or SystemError in case of '
+        'KYCProvider intermittence',
+    )
+    code: str = Field(description='Specific code of the failure in the step.')
+    message: Optional[str] = Field(None, description='Error description')
+    model_config = ConfigDict(
+        json_schema_extra={
+            "example": {
+                "identifier": "age-check",
+                "error": 'StepError',
+                "code": "underage.noDOB",
+                "message": "The date of birth could not be obtained",
+            }
+        },
+    )
+
+
+class KYCFile(BaseModel):
+    type: KYCFileType
+    uri_front: str = Field(description='API uri to fetch the file')
+    uri_back: Optional[str] = Field(
+        None, description='API uri to fetch the file'
+    )
+    is_mx: bool = True
+    data: Optional[dict] = None
+    status: Optional[VerificationStatus] = Field(
+        None, description='The status of the file depends on KYCValidation'
+    )
+    errors: Optional[list[VerificationErrors]] = Field(
+        None, description='List of document errors found during kyc validation'
+    )
+    verification_id: Optional[str] = Field(
+        None, description='The provider identifier of the validation result'
+    )
+    attempt: Optional[int] = Field(
+        None,
+        description='The number of kyc_validation intents for this document',
+    )
+    model_config = ConfigDict(
+        json_schema_extra={
+            "example": {
+                "type": "ine",
+                "is_mx": True,
+                "uri_front": "/files/FILE-01",
+                "uri_back": "/files/FILE-02",
+                "data": {},
+                "status": "created",
+                "errors": [],
+            }
+        },
+    )
+
+
+class TOSAgreement(BaseModel):
+    version: str
+    ip: IPvAnyAddress
+    location: Optional[str] = None
+    model_config = ConfigDict(
+        json_schema_extra={
+            "example": {
+                "version": "2022-01-01",
+                "ip": "192.168.0.1",
+                "location": "19.427224, -99.168082",
+            }
+        }
+    )

{cuenca_validations-0.11.33 → cuenca_validations-2.0.0}/cuenca_validations/types/morals.py

@@ -1,9 +1,9 @@
 import datetime as dt
-from typing import List, Optional
+from typing import Optional
 
 from pydantic import BaseModel, EmailStr
 
-from cuenca_validations.types import Address, CurpField, PhoneNumber, Rfc
+from cuenca_validations.types import Address, Curp, PhoneNumber, Rfc
 
 
 class BusinessDetails(BaseModel):
@@ -52,7 +52,7 @@ class PhysicalPerson(BaseModel):
     names: str
     first_surname: str
     second_surname: Optional[str] = None
-    curp: Optional[CurpField] = None
+    curp: Optional[Curp] = None
     rfc: Optional[Rfc] = None
 
 
@@ -70,5 +70,5 @@ class ShareholderPhysical(PhysicalPerson):
 class Shareholder(BaseModel):
     name: str
     percentage: int
-    shareholders: List[ShareholderPhysical]
-    legal_representatives: List[LegalRepresentative]
+    shareholders: list[ShareholderPhysical]
+    legal_representatives: list[LegalRepresentative]

{cuenca_validations-0.11.33 → cuenca_validations-2.0.0}/cuenca_validations/types/queries.py

@@ -1,8 +1,14 @@
 import datetime as dt
-from typing import Optional
-
-from pydantic import BaseModel, EmailStr, Extra, validator
-from pydantic.types import ConstrainedInt, PositiveInt
+from typing import Annotated, Optional
+
+from pydantic import (
+    BaseModel,
+    ConfigDict,
+    EmailStr,
+    Field,
+    PositiveInt,
+    field_validator,
+)
 
 from ..typing import DictStrAny
 from ..validators import sanitize_dict
@@ -18,19 +24,16 @@ from .enums import (
     TransferNetwork,
     UserStatus,
 )
-from .identities import CurpField
+from .identities import Curp
 
 MAX_PAGE_SIZE = 100
 
 
-class PageSize(ConstrainedInt):
-    gt = 0
-    le = MAX_PAGE_SIZE
-
-
 class QueryParams(BaseModel):
     count: bool = False
-    page_size: PageSize = PageSize(MAX_PAGE_SIZE)
+    page_size: Annotated[
+        int, Field(gt=0, le=MAX_PAGE_SIZE, default=MAX_PAGE_SIZE)
+    ]
     limit: Optional[PositiveInt] = None
     user_id: Optional[str] = None
     created_before: Optional[dt.datetime] = None
@@ -38,9 +41,9 @@ class QueryParams(BaseModel):
     related_transaction: Optional[str] = None
     platform_id: Optional[str] = None
 
-    class Config:
-        extra = Extra.forbid  # raise ValidationError if there are extra fields
-        fields = {
+    model_config = ConfigDict(
+        extra="forbid",
+        json_schema_extra={
             'count': {'description': 'Set `true` value to get only a counter'},
             'page_size': {'description': 'Number of items per page'},
             'limit': {'description': 'Limit of items to query'},
@@ -54,12 +57,13 @@ class QueryParams(BaseModel):
                 'or greater than this value, this field represents the min '
                 'creation date.'
             },
-        }
+        },
+    )
 
-    def dict(self, *args, **kwargs) -> DictStrAny:
+    def model_dump(self, *args, **kwargs) -> DictStrAny:
         kwargs.setdefault('exclude_none', True)
         kwargs.setdefault('exclude_unset', True)
-        d = super().dict(*args, **kwargs)
+        d = super().model_dump(*args, **kwargs)
         if self.count:
             d['count'] = 1
         sanitize_dict(d)
@@ -93,43 +97,34 @@ class CardTransactionQuery(TransactionQuery):
 class ApiKeyQuery(QueryParams):
     active: Optional[bool] = None
 
-    class Config(QueryParams.Config):
-        fields = {
-            **QueryParams.Config.fields,
-            'active': {
-                'description': 'Set `true` value to fetch active keys or '
-                '`false` to fetch deactivated keys'
-            },
-        }
+    model_config = ConfigDict(
+        extra="forbid",
+        json_schema_extra={
+            'properties': {
+                'active': {
+                    'description': 'Set `true` value to fetch active keys or '
+                    '`false` to fetch deactivated keys'
+                },
+            }
+        },
+    )
 
 
 class CardQuery(QueryParams):
     number: Optional[str] = None
-    exp_month: Optional[int] = None
-    exp_year: Optional[int] = None
-    cvv: Optional[str] = None
-    cvv2: Optional[str] = None
-    icvv: Optional[str] = None
-    pin_block: Optional[str] = None
     issuer: Optional[CardIssuer] = None
     funding_type: Optional[CardFundingType] = None
     status: Optional[CardStatus] = None
     type: Optional[CardType] = None
 
-    @validator('exp_month', 'exp_year', 'cvv2', 'cvv')
-    def query_by_exp_cvv_if_number_set(cls, v, values):
-        if not values['number']:
-            raise ValueError('Number must be set to query by exp or cvv')
-        return v
-
 
 class StatementQuery(QueryParams):
     year: int
     month: int
 
-    @validator('month')
+    @field_validator('month')
     def validate_year_month(cls, month, values):
-        year = values['year']
+        year = values.data['year']
         month_now = dt.date.today().replace(day=1)
         month_set = dt.date(year, month, 1)
         if month_set >= month_now:
@@ -163,7 +158,7 @@ class UserQuery(QueryParams):
 
 
 class IdentityQuery(QueryParams):
-    curp: Optional[CurpField] = None
+    curp: Optional[Curp] = None
     rfc: Optional[str] = None
     status: Optional[UserStatus] = None