cuenca-validations 2.1.9.dev1__tar.gz → 2.1.10__tar.gz

{cuenca_validations-2.1.9.dev1 → cuenca_validations-2.1.10}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cuenca_validations
-Version: 2.1.9.dev1
+Version: 2.1.10
 Summary: Cuenca common validations
 Home-page: https://github.com/cuenca-mx/cuenca-validations
 Author: Cuenca

{cuenca_validations-2.1.9.dev1 → cuenca_validations-2.1.10}/cuenca_validations/types/__init__.py

@@ -7,6 +7,7 @@ __all__ = [
     'BalanceEntryQuery',
     'BankAccountValidationQuery',
     'BankAccountValidationRequest',
+    'PostalCodeQuery',
     'BankAccountStatus',
     'BatchFileMetadata',
     'Beneficiary',
@@ -55,6 +56,7 @@ __all__ = [
     'PlatformRequest',
     'PlatformType',
     'PosCapability',
+    'Profession',
     'QueryParams',
     'Rfc',
     'QuestionnairesRequest',
@@ -134,6 +136,7 @@ from .enums import (
     Language,
     PlatformType,
     PosCapability,
+    Profession,
     SATRegimeCode,
     SavingCategory,
     ServiceProviderCategory,
@@ -183,6 +186,7 @@ from .queries import (
     EventQuery,
     FileQuery,
     IdentityQuery,
+    PostalCodeQuery,
     QueryParams,
     SessionQuery,
     StatementQuery,

{cuenca_validations-2.1.9.dev1 → cuenca_validations-2.1.10}/cuenca_validations/types/enums.py

@@ -688,3 +688,19 @@ class SATRegimeCode(str, Enum):
     ING_PREM = "615"  # Régimen de los ingresos por obtención de premios
     AE_PLAT_TEC = "625"  # Régimen de las Actividades Empresariales con ingresos a través de Plataformas Tecnológicas # noqa: E501
     RS_CONF = "626"  # Régimen Simplificado de Confianza
+
+
+class Profession(str, Enum):
+    artisticas = 'Actividades Artísticas'
+    agropecuario = 'Agricultura, Ganadería o Pesca'
+    comercio = 'Comercio'
+    estudiante = 'Estudiante'
+    empleado = 'Empleado(a/e)'
+    emprendimiento = 'Emprendimiento'
+    hogar = 'Hogar'
+    profesor = 'Profesor(a/e)'
+    profesionista = 'Profesionista'
+    servidor_publico = 'Servidor(a/e) Público'
+    sistemas = 'Sistemas y Comunicaciones'
+    independiente = 'Trabajador(a/e) Independiente'
+    oficios = 'Oficios Varios'

{cuenca_validations-2.1.9.dev1 → cuenca_validations-2.1.10}/cuenca_validations/types/identities.py

@@ -1,18 +1,11 @@
 import datetime as dt
-from typing import Annotated, Any, Optional
+from typing import Annotated, Optional
 
-from pydantic import (
-    BaseModel,
-    ConfigDict,
-    Field,
-    SecretStr,
-    StringConstraints,
-    model_validator,
-)
+from pydantic import BaseModel, ConfigDict, Field, SecretStr, StringConstraints
 from pydantic_extra_types.phone_numbers import PhoneNumber
 
 from .enums import Country, KYCFileType, State, VerificationStatus
-from .general import SerializableIPvAnyAddress
+from .general import NonEmptyStr, SerializableIPvAnyAddress
 
 Password = Annotated[
     SecretStr,
@@ -43,6 +36,13 @@ Rfc = Annotated[
     ),
 ]
 
+# NOTE:
+# The Address model is kept for compatibility with legacy models and data
+# that expect all address fields to be optional. This allows older systems
+# or stored data using Address to continue working without breaking changes.
+# For new request validation, use AddressRequest, which enforces required
+# fields and is intended for validating incoming data.
+
 
 class Address(BaseModel):
     street: Optional[str] = None
@@ -69,16 +69,24 @@ class Address(BaseModel):
         }
     )
 
-    @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 AddressRequest(BaseModel):
+    # This model is mainly for request validation, enforcing required fields.
+    street: NonEmptyStr
+    ext_number: NonEmptyStr
+    int_number: Optional[NonEmptyStr] = None
+    postal_code_id: NonEmptyStr
+
+    model_config = ConfigDict(
+        json_schema_extra={
+            "example": {
+                "street": "Reforma",
+                "ext_number": "265",
+                "int_number": "5",
+                "postal_code_id": "PC2ygq9j2bS9-9tsuVawzErA",
+            }
+        }
+    )
 
 
 class Beneficiary(BaseModel):
@@ -86,7 +94,7 @@ class Beneficiary(BaseModel):
     birth_date: dt.date
     phone_number: PhoneNumber
     user_relationship: str
-    percentage: int
+    percentage: Annotated[int, Field(ge=1, le=100)]
     model_config = ConfigDict(
         json_schema_extra={
             "example": {

{cuenca_validations-2.1.9.dev1 → cuenca_validations-2.1.10}/cuenca_validations/types/morals.py

@@ -3,7 +3,8 @@ from typing import Optional
 
 from pydantic import BaseModel, EmailStr
 
-from cuenca_validations.types import Address, Curp, PhoneNumber, Rfc
+from ..types import Curp, PhoneNumber, Rfc
+from .identities import AddressRequest
 
 
 class BusinessDetails(BaseModel):
@@ -60,7 +61,7 @@ class LegalRepresentative(PhysicalPerson):
     job: str
     phone_number: PhoneNumber
     email_address: EmailStr
-    address: Address
+    address: AddressRequest
 
 
 class ShareholderPhysical(PhysicalPerson):

{cuenca_validations-2.1.9.dev1 → cuenca_validations-2.1.10}/cuenca_validations/types/queries.py

@@ -7,6 +7,7 @@ from pydantic import (
     EmailStr,
     Field,
     PositiveInt,
+    StringConstraints,
     field_validator,
 )
 
@@ -174,8 +175,22 @@ class SessionQuery(QueryParams):
 
 class FileQuery(QueryParams):
     type: Optional[KYCFileType] = None
+    id: Optional[str] = None
+    user_id: Optional[str] = None
 
 
 class BankAccountValidationQuery(QueryParams):
     account_number: Optional[str] = None
     status: Optional[BankAccountStatus] = None
+
+
+class PostalCodeQuery(QueryParams):
+    postal_code: Annotated[
+        str,
+        StringConstraints(
+            strip_whitespace=True,
+            min_length=5,
+            max_length=5,
+            pattern=r'^\d+$',
+        ),
+    ]

{cuenca_validations-2.1.9.dev1 → cuenca_validations-2.1.10}/cuenca_validations/types/requests.py

@@ -1,5 +1,5 @@
 import datetime as dt
-from typing import Annotated, Optional, Union
+from typing import Annotated, Any, Optional, Union
 
 from clabe import Clabe
 from pydantic import (
@@ -7,11 +7,13 @@ from pydantic import (
     ConfigDict,
     EmailStr,
     Field,
+    GetCoreSchemaHandler,
     StrictStr,
     StringConstraints,
     field_validator,
     model_validator,
 )
+from pydantic_core import core_schema
 from pydantic_extra_types.coordinate import Coordinate
 
 from ..types.enums import (
@@ -32,6 +34,7 @@ from ..types.enums import (
     KYCValidationSource,
     PlatformType,
     PosCapability,
+    Profession,
     SavingCategory,
     SessionType,
     State,
@@ -39,7 +42,6 @@ from ..types.enums import (
     TrackDataMethod,
     TransactionTokenValidationStatus,
     UserCardNotification,
-    UserStatus,
     VerificationType,
     WalletTransactionType,
     WebhookEvent,
@@ -64,14 +66,13 @@ from .general import (
     StrictPositiveInt,
 )
 from .identities import (
-    Address,
+    AddressRequest,
     Beneficiary,
     Curp,
     KYCFile,
     Password,
     PhoneNumber,
     Rfc,
-    TOSAgreement,
 )
 from .morals import (
     AuditDetails,
@@ -83,6 +84,10 @@ from .morals import (
     VulnerableActivityDetails,
 )
 
+CUENCA_FILE_URL = (
+    r'^https:\/\/(?:stage|sandbox|api)\.cuenca\.com\/files\/([a-zA-Z0-9\-]+)$'
+)
+
 
 class BaseRequest(BaseModel):
     model_config = ConfigDict(extra="forbid")
@@ -404,50 +409,47 @@ class TOSRequest(BaseModel):
     ip: Optional[SerializableIPvAnyAddress] = None
 
 
+class FileCuencaUrl(str):
+
+    @property
+    def file_id(self) -> str:
+        return self.split('/')[-1]
+
+    @classmethod
+    def __get_pydantic_core_schema__(
+        cls, _source_type: Any, _handler: GetCoreSchemaHandler
+    ) -> core_schema.CoreSchema:
+        return core_schema.no_info_after_validator_function(
+            cls, core_schema.str_schema(pattern=CUENCA_FILE_URL)
+        )
+
+
 class UserTOSAgreementRequest(BaseModel):
     tos_id: str
     location: Coordinate
-    signature: SerializableHttpUrl | None = None
+    signature_image_url: Optional[FileCuencaUrl] = None
 
 
 class UserRequest(BaseModel):
-    id: Optional[str] = Field(
-        None, description='if you want to create with specific `id`'
-    )
     curp: Curp = Field(
-        description='Previously validated in `curp_validations`'
-    )
-    phone_number: Optional[PhoneNumber] = Field(
-        None, description='Only if you validated previously on your side'
-    )
-    email_address: Optional[EmailStr] = Field(
-        None, description='Only if you validated previously on your side'
+        description=(
+            'Mexican government ID (18 characters). ' 'Must be pre-validated.'
+        )
     )
-    profession: Optional[str] = None
-    address: Optional[Address] = None
-    status: Optional[UserStatus] = Field(
-        None,
-        description='Status that the user will have when created. '
-        'Defined by platform',
+
+    profession: Profession = Field(description='User profession or occupation')
+    address: AddressRequest = Field(
+        description='User residential address information'
     )
-    required_level: Optional[int] = Field(
-        None,
-        ge=1,
-        le=3,
-        description='Maximum level a User can reach. Defined by platform',
+    phone_verification_id: str = Field(
+        ...,
+        description='ID of previously validated phone verification',
     )
-    phone_verification_id: Optional[str] = Field(
-        None,
-        description='Only if you validated it previously with the '
-        'resource `verifications`',
+    email_verification_id: str = Field(
+        ...,
+        description='ID of previously validated email verification',
     )
-    email_verification_id: Optional[str] = Field(
-        None,
-        description='Only if you validated it previously with the '
-        'resource `verifications`',
-    )
-    terms_of_service: Optional[TOSRequest] = None
-    signature: Optional[KYCFile] = None
+
     model_config = ConfigDict(
         json_schema_extra={
             'example': {
@@ -455,7 +457,7 @@ class UserRequest(BaseModel):
                 'phone_number': '+525511223344',
                 'email_address': 'user@example.com',
                 'profession': 'engineer',
-                'address': Address.schema().get('example'),
+                'address': AddressRequest.model_json_schema().get('example'),
             }
         },
     )
@@ -480,21 +482,16 @@ class UserRequest(BaseModel):
 
 
 class UserUpdateRequest(BaseModel):
-    phone_number: Optional[PhoneNumber] = None
-    email_address: Optional[EmailStr] = None
-    profession: Optional[str] = None
+    profession: Optional[Profession] = None
     verification_id: Optional[str] = None
     email_verification_id: Optional[str] = None
     phone_verification_id: Optional[str] = None
-    address: Optional[Address] = None
+    address: Optional[AddressRequest] = None
     beneficiaries: Optional[list[Beneficiary]] = None
     govt_id: Optional[KYCFile] = None
     proof_of_address: Optional[KYCFile] = None
     proof_of_life: Optional[KYCFile] = None
     signature: Optional[KYCFile] = None
-    status: Optional[UserStatus] = None
-    terms_of_service: Optional[TOSRequest] = None
-    platform_terms_of_service: Optional[TOSAgreement] = None
     curp_document_uri: Optional[SerializableHttpUrl] = None
 
     @field_validator('beneficiaries')
@@ -502,8 +499,8 @@ class UserUpdateRequest(BaseModel):
     def beneficiary_percentage(
         cls, beneficiaries: Optional[list[Beneficiary]] = None
     ):
-        if beneficiaries and sum(b.percentage for b in beneficiaries) > 100:
-            raise ValueError('The total percentage is more than 100.')
+        if beneficiaries and sum(b.percentage for b in beneficiaries) != 100:
+            raise ValueError('The total percentage should be 100%')
         return beneficiaries
 
 
@@ -570,14 +567,12 @@ class VerificationRequest(BaseModel):
     recipient: Union[EmailStr, PhoneNumber] = Field(
         description='Phone or email to validate'
     )
-    platform_id: str
     model_config = ConfigDict(
         str_strip_whitespace=True,
         json_schema_extra={
             'example': {
                 'type': 'email',
                 'recipient': 'user@example.com',
-                'platform_id': 'PT8UEv02zBTcymd4Kd3MO6pg',
             }
         },
     )
@@ -710,7 +705,7 @@ class PartnerRequest(BaseRequest):
     web_site: str
     phone_number: PhoneNumber
     email_address: EmailStr
-    address: Address
+    address: AddressRequest
 
 
 class PartnerUpdateRequest(BaseRequest):
@@ -724,7 +719,7 @@ class PartnerUpdateRequest(BaseRequest):
     web_site: Optional[str] = None
     phone_number: Optional[PhoneNumber] = None
     email_address: Optional[EmailStr] = None
-    address: Optional[Address] = None
+    address: Optional[AddressRequest] = None
     business_details: Optional[BusinessDetails] = None
     transactional_profile: Optional[TransactionalProfile] = None
     external_account: Optional[Clabe] = None

cuenca_validations-2.1.10/cuenca_validations/version.py

@@ -0,0 +1 @@
+__version__ = '2.1.10'

{cuenca_validations-2.1.9.dev1 → cuenca_validations-2.1.10}/cuenca_validations.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cuenca_validations
-Version: 2.1.9.dev1
+Version: 2.1.10
 Summary: Cuenca common validations
 Home-page: https://github.com/cuenca-mx/cuenca-validations
 Author: Cuenca

{cuenca_validations-2.1.9.dev1 → cuenca_validations-2.1.10}/cuenca_validations.egg-info/SOURCES.txt

@@ -28,5 +28,6 @@ tests/__init__.py
 tests/test_card.py
 tests/test_errors.py
 tests/test_helpers.py
+tests/test_requests.py
 tests/test_statement.py
 tests/test_types.py

cuenca_validations-2.1.10/tests/test_requests.py

@@ -0,0 +1,31 @@
+import pytest
+from pydantic import ValidationError
+
+from cuenca_validations.types.requests import UserTOSAgreementRequest
+from cuenca_validations.typing import DictStrAny
+
+
+@pytest.mark.parametrize('environment', ['stage', 'sandbox', 'api'])
+def test_file_cuenca_url(environment: str) -> None:
+    request_data: DictStrAny = dict(
+        tos_id='TS67dcae8e74e81bba5a77bf47',
+        location=(19.432607, -99.133209),
+        signature_image_url=(
+            f'https://{environment}.cuenca.com/files/EFQL87ohvoRp-PkOTYgvQYFA'
+        ),
+    )
+    utos = UserTOSAgreementRequest(**request_data)
+    assert utos.signature_image_url is not None
+    assert utos.signature_image_url.file_id == 'EFQL87ohvoRp-PkOTYgvQYFA'
+
+
+def test_file_cuenca_url_invalid() -> None:
+    request_data: DictStrAny = dict(
+        tos_id='TS67dcae8e74e81bba5a77bf47',
+        location=(19.432607, -99.133209),
+        signature_image_url=(
+            'https://cuenca.com/files/EFQL87ohvoRp-PkOTYgvQYFA/invalid'
+        ),
+    )
+    with pytest.raises(ValidationError):
+        UserTOSAgreementRequest(**request_data)

{cuenca_validations-2.1.9.dev1 → cuenca_validations-2.1.10}/tests/test_types.py

@@ -10,7 +10,6 @@ from pydantic import AfterValidator, BaseModel, SecretStr, ValidationError
 from pydantic.fields import FieldInfo
 
 from cuenca_validations.types import (
-    Address,
     CardQuery,
     JSONEncoder,
     QueryParams,
@@ -21,8 +20,8 @@ from cuenca_validations.types import (
     get_state_name,
 )
 from cuenca_validations.types.enums import (
-    Country,
     EcommerceIndicator,
+    Profession,
     SessionType,
     State,
 )
@@ -303,60 +302,42 @@ def test_saving_update_request():
         SavingUpdateRequest(**data)
 
 
-def test_address_validation():
-    data = dict(
-        full_name='Varsovia 36, Col Cuahutemoc',
-    )
-    assert Address(**data)
-    with pytest.raises(ValueError) as v:
-        Address(**dict())
-    assert 'required street' in str(v)
-    data = dict(street='somestreet')
-    with pytest.raises(ValueError) as v:
-        Address(**data)
-    assert 'required ext_number' in str(v)
-    data = dict(
-        street='varsovia',
-        ext_number='36',
-        state=State.DF,
-        country=Country.MX,
+@freeze_time('2022-01-01')
+def test_user_request():
+    request = dict(
+        curp='ABCD920604HDFSRN03',
+        profession=Profession.empleado,
+        address=dict(
+            street='calle 1',
+            ext_number='2',
+            int_number='3',
+            postal_code_id='PC2ygq9j2bS9-9tsuVawzErA',
+        ),
+        phone_verification_id='VE12345678',
+        email_verification_id='VE0987654321',
     )
-    assert Address(**data)
+    assert UserRequest(**request).model_dump() == request
 
 
 @freeze_time('2022-01-01')
-def test_user_request():
+def test_user_request_underage():
     request = dict(
-        id=None,
-        curp='ABCD920604HDFSRN03',
-        phone_number='+525555555555',
-        email_address='email@email.com',
+        curp='ABCD060604HDFSRN03',  # underage CURP
         profession='worker',
-        status='active',
         address=dict(
             street='calle 1',
             ext_number='2',
             int_number='3',
-            colonia='Juarez',
-            postal_code='09900',
-            state=State.DF.value,
-            country=Country.MX,
-            city='Obrera',
-            full_name=None,
+            postal_code_id='PC2ygq9j2bS9-9tsuVawzErA',
         ),
         phone_verification_id='VE12345678',
         email_verification_id='VE0987654321',
-        required_level=3,
-        terms_of_service=None,
-        signature=None,
     )
-    assert UserRequest(**request).model_dump() == request
 
-    # changing curp so user is underage
-    request['curp'] = 'ABCD060604HDFSRN03'
     with pytest.raises(ValueError) as v:
         UserRequest(**request)
-        assert 'User does not meet age requirement.' in str(v)
+
+    assert 'User does not meet age requirement.' in str(v)
 
 
 @freeze_time('2022-01-01')
@@ -438,7 +419,7 @@ def test_user_update_request():
             birth_date=dt.date(2020, 1, 1).isoformat(),
             phone_number='+525555555555',
             user_relationship='brother',
-            percentage=50,
+            percentage=100,
         ),
     ]
     assert UserUpdateRequest(**request)
@@ -449,12 +430,21 @@ def test_user_update_request():
             birth_date=dt.date(2020, 1, 1).isoformat(),
             phone_number='+525555555555',
             user_relationship='brother',
-            percentage=101,
+            percentage=50,
+        ),
+        dict(
+            name='José Pérez',
+            birth_date=dt.date(2020, 1, 2).isoformat(),
+            phone_number='+525544444444',
+            user_relationship='brother',
+            percentage=51,
         ),
     ]
-    with pytest.raises(ValueError) as v:
+    with pytest.raises(ValidationError) as v:
         UserUpdateRequest(**request)
-        assert 'The total percentage is more than 100.' in str(v)
+
+    assert 'The total percentage should be 100%' in str(v)
+    request.pop('beneficiaries')
 
     tos_request = dict(
         terms_of_service=dict(
@@ -485,12 +475,6 @@ def test_user_update_request():
     )
     UserUpdateRequest(**kyc_request)
 
-    # chagning to invalid request
-    tos_request['terms_of_service']['ip'] = 'not valid ip'
-    with pytest.raises(ValueError) as v:
-        UserUpdateRequest(**tos_request)
-    assert 'not valid ip' in str(v.value)
-
 
 def test_session_request():
     data = dict(
@@ -522,7 +506,6 @@ def test_email_verification_request():
     data = dict(
         recipient='mail@cuenca.com',
         type='email_verification',
-        platform_id='PL01',
     )
     with pytest.raises(ValidationError):
         VerificationRequest(**data)
@@ -534,7 +517,6 @@ def test_phone_verification_request():
     data = dict(
         recipient='+525555555555',
         type='phone_verification',
-        platform_id='PL01',
     )
     with pytest.raises(ValidationError):
         VerificationRequest(**data)

cuenca_validations-2.1.9.dev1/cuenca_validations/version.py

@@ -1 +0,0 @@
-__version__ = '2.1.9.dev1'