cuenca-validations 2.1.7.dev6__py3-none-any.whl → 2.1.8.dev2__py3-none-any.whl

cuenca_validations/types/__init__.py

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

cuenca_validations/types/enums.py

@@ -688,19 +688,3 @@ 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):
-    arts = 'arts'
-    agriculture = 'agriculture'
-    commerce = 'commerce'
-    student = 'student'
-    employee = 'employee'
-    entrepreneur = 'entrepreneur'
-    homemaker = 'homemaker'
-    teacher = 'teacher'
-    professional = 'professional'
-    public_servant = 'public_servant'
-    it_communications = 'it_communications'
-    freelancer = 'freelancer'
-    skilled_trades = 'skilled_trades'

cuenca_validations/types/identities.py

@@ -1,11 +1,18 @@
 import datetime as dt
-from typing import Annotated, Optional
+from typing import Annotated, Any, Optional
 
-from pydantic import BaseModel, ConfigDict, Field, SecretStr, StringConstraints
+from pydantic import (
+    BaseModel,
+    ConfigDict,
+    Field,
+    SecretStr,
+    StringConstraints,
+    model_validator,
+)
 from pydantic_extra_types.phone_numbers import PhoneNumber
 
 from .enums import Country, KYCFileType, State, VerificationStatus
-from .general import NonEmptyStr, SerializableIPvAnyAddress
+from .general import SerializableIPvAnyAddress
 
 Password = Annotated[
     SecretStr,
@@ -38,15 +45,15 @@ Rfc = Annotated[
 
 
 class Address(BaseModel):
-    street: NonEmptyStr
-    ext_number: NonEmptyStr
-    int_number: Optional[NonEmptyStr] = None
-    colonia: NonEmptyStr
-    postal_code: NonEmptyStr
+    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: Country
-    city: NonEmptyStr
-
+    country: Optional[Country] = None
+    city: Optional[str] = None
+    full_name: Optional[str] = None
     model_config = ConfigDict(
         json_schema_extra={
             "example": {
@@ -62,13 +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 Beneficiary(BaseModel):
     name: str
     birth_date: dt.date
     phone_number: PhoneNumber
     user_relationship: str
-    percentage: Annotated[int, Field(ge=1, le=100)]
+    percentage: int
     model_config = ConfigDict(
         json_schema_extra={
             "example": {

cuenca_validations/types/queries.py

@@ -179,3 +179,7 @@ class FileQuery(QueryParams):
 class BankAccountValidationQuery(QueryParams):
     account_number: Optional[str] = None
     status: Optional[BankAccountStatus] = None
+
+
+class PostalCodeQuery(QueryParams):
+    postal_code: str

cuenca_validations/types/requests.py

@@ -32,7 +32,6 @@ from ..types.enums import (
     KYCValidationSource,
     PlatformType,
     PosCapability,
-    Profession,
     SavingCategory,
     SessionType,
     State,
@@ -40,6 +39,7 @@ from ..types.enums import (
     TrackDataMethod,
     TransactionTokenValidationStatus,
     UserCardNotification,
+    UserStatus,
     VerificationType,
     WalletTransactionType,
     WebhookEvent,
@@ -71,6 +71,7 @@ from .identities import (
     Password,
     PhoneNumber,
     Rfc,
+    TOSAgreement,
 )
 from .morals import (
     AuditDetails,
@@ -409,25 +410,43 @@ class UserTOSAgreementRequest(BaseModel):
 
 
 class UserRequest(BaseModel):
+    id: Optional[str] = Field(
+        None, description='if you want to create with specific `id`'
+    )
     curp: Curp = Field(
-        description=(
-            'Mexican government ID (18 characters). ' 'Must be pre-validated.'
-        )
+        description='Previously validated in `curp_validations`'
     )
-
-    profession: Profession = Field(description='User profession or occupation')
-    address: Address = Field(
-        description='User residential address information'
+    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'
     )
-    phone_verification_id: str = Field(
-        ...,
-        description='ID of previously validated phone verification',
+    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',
     )
-    email_verification_id: str = Field(
-        ...,
-        description='ID of previously validated email verification',
+    required_level: Optional[int] = Field(
+        None,
+        ge=1,
+        le=3,
+        description='Maximum level a User can reach. Defined by platform',
     )
-
+    phone_verification_id: Optional[str] = Field(
+        None,
+        description='Only if you validated it previously with the '
+        'resource `verifications`',
+    )
+    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': {
@@ -435,7 +454,7 @@ class UserRequest(BaseModel):
                 'phone_number': '+525511223344',
                 'email_address': 'user@example.com',
                 'profession': 'engineer',
-                'address': Address.model_json_schema().get('example'),
+                'address': Address.schema().get('example'),
             }
         },
     )
@@ -460,7 +479,9 @@ class UserRequest(BaseModel):
 
 
 class UserUpdateRequest(BaseModel):
-    profession: Optional[Profession] = None
+    phone_number: Optional[PhoneNumber] = None
+    email_address: Optional[EmailStr] = None
+    profession: Optional[str] = None
     verification_id: Optional[str] = None
     email_verification_id: Optional[str] = None
     phone_verification_id: Optional[str] = None
@@ -470,6 +491,9 @@ class UserUpdateRequest(BaseModel):
     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')
@@ -477,8 +501,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 should be 100%')
+        if beneficiaries and sum(b.percentage for b in beneficiaries) > 100:
+            raise ValueError('The total percentage is more than 100.')
         return beneficiaries
 
 

cuenca_validations/version.py

@@ -1 +1 @@
-__version__ = '2.1.7.dev6'
+__version__ = '2.1.8.dev2'

{cuenca_validations-2.1.7.dev6.dist-info → cuenca_validations-2.1.8.dev2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cuenca_validations
-Version: 2.1.7.dev6
+Version: 2.1.8.dev2
 Summary: Cuenca common validations
 Home-page: https://github.com/cuenca-mx/cuenca-validations
 Author: Cuenca

{cuenca_validations-2.1.7.dev6.dist-info → cuenca_validations-2.1.8.dev2.dist-info}/RECORD

@@ -4,25 +4,25 @@ cuenca_validations/errors.py,sha256=OtM8EgiKqYdz9Hn66AbBO96orL1or7efkyt0vh0Zxbs,
 cuenca_validations/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 cuenca_validations/typing.py,sha256=1QCu81IbVZZpyInjyeAuO-nF36gpT5Gi4o6V9PozuOU,204
 cuenca_validations/validators.py,sha256=wzwLnJ4wHggZvqp3mearbFkzvDERGeTNvJkuofQnuMc,1484
-cuenca_validations/version.py,sha256=xNYuWD95tiTllFVfWM7FmDp_XLbRZ6ABQ89u9YqAhXw,27
-cuenca_validations/types/__init__.py,sha256=1xGfD2tlFsPlhIy-T7BZPs-vvEgDoc6ZW2iXFLbyQpM,4799
+cuenca_validations/version.py,sha256=oVQ93g6Jkbs7y5hpmfGYVhe60FLyj4UUZEOwspYR52E,27
+cuenca_validations/types/__init__.py,sha256=jSc37T7oFYbaJFQhES7AQSWnMsgJtc21oPXb39V9SNg,4809
 cuenca_validations/types/card.py,sha256=UGzz8NTFAverUmdUKAK1oGHnOnjSNTpIRUm93vKSSGY,1295
-cuenca_validations/types/enums.py,sha256=o2XmufNIBhx88KDVARnpoXqLkyXVP89XMW0DDPDH9NI,19424
+cuenca_validations/types/enums.py,sha256=Vm9HGf83jPkEp8iZ-KGtKGWQGx5q-cIUuQj32y_QcvU,18997
 cuenca_validations/types/files.py,sha256=2CszbwF9ytXV9suFFwyDjYG4XxY8UhCjRw3HttVXXNw,269
 cuenca_validations/types/general.py,sha256=vJmQBD_Iv_hsxD8x3_Bip-NlYAiE2rmXSPQKj4kTtto,2621
 cuenca_validations/types/helpers.py,sha256=6rHUhwoQ7jJZtGcW3LX-W5ZDl42PWE1RoBpGme7KCkk,610
-cuenca_validations/types/identities.py,sha256=FBpWUwRfy99jBr2Zhuv9gArnnUe12o3A2kbs25i9nwo,4470
+cuenca_validations/types/identities.py,sha256=-TWRDRpmIaCI4nE4hVy1FQtQtlxuErtmEtzJW1FBzec,4956
 cuenca_validations/types/morals.py,sha256=m8kAedevmwfSPTA9GYe03l7pkgipynwYgKfejyVtnuI,1813
-cuenca_validations/types/queries.py,sha256=KCRx0sPzWDtDDbZysmFGVgANgfqil17EITWaG7tGQ-A,4700
-cuenca_validations/types/requests.py,sha256=SdLE0N-3bRNVUQRQ2IWtShjR8Iok_Ev818o9UbcraTU,20370
-cuenca_validations-2.1.7.dev6.dist-info/licenses/LICENSE,sha256=wR76FmxBbfnQpwELkkE5iMF8sFIafEMgXLTE4N4WPTc,1063
+cuenca_validations/types/queries.py,sha256=fDXm2LIpM4IrkaANTDTr3_tqqAK6nvs5-CGCTjjK9Oo,4759
+cuenca_validations/types/requests.py,sha256=6aEoMe7e-FPJs3_ouECV_Y6ZtyyJVyXfTed8wHtx_xw,21338
+cuenca_validations-2.1.8.dev2.dist-info/licenses/LICENSE,sha256=wR76FmxBbfnQpwELkkE5iMF8sFIafEMgXLTE4N4WPTc,1063
 tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 tests/test_card.py,sha256=QAfRz7e11gWICPnFJZ2tiYgUsFV3C9TwzJXrDnDNXFw,1202
 tests/test_errors.py,sha256=ixiIgEuBuzfsL5p4uCFdF32XqFRtTPF6EVhGJ0keOrI,930
 tests/test_helpers.py,sha256=ubzpi1UXCryLQdgsT_Zm2IX-XE_4L0dnHnhLwH06xK8,748
 tests/test_statement.py,sha256=IOE0rRRBgBZSJv_FLaETEyn5NzzXKMNTqgjv99GX-68,1436
-tests/test_types.py,sha256=TimSUqe0YX83qIzo7p6XUy8YYuf19a7M3iPkVKw0iMg,19203
-cuenca_validations-2.1.7.dev6.dist-info/METADATA,sha256=bN1iprUBHlSHDDvjNOOo9I-l8_fZN207JIm9Jkwvp-w,1599
-cuenca_validations-2.1.7.dev6.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-cuenca_validations-2.1.7.dev6.dist-info/top_level.txt,sha256=4233xdOs2HtuT-GFRjcDcwK0IwdwvWdczOtk0fPB6Gw,25
-cuenca_validations-2.1.7.dev6.dist-info/RECORD,,
+tests/test_types.py,sha256=K_YNFz0Kac3k8fJNeXuYGkL1hjXDQu084jCX6xEMEE4,19348
+cuenca_validations-2.1.8.dev2.dist-info/METADATA,sha256=pS4SwCIG4fjA8nrih50MBurrHtHqtPTLhLcMNJ2rD-A,1599
+cuenca_validations-2.1.8.dev2.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+cuenca_validations-2.1.8.dev2.dist-info/top_level.txt,sha256=4233xdOs2HtuT-GFRjcDcwK0IwdwvWdczOtk0fPB6Gw,25
+cuenca_validations-2.1.8.dev2.dist-info/RECORD,,

tests/test_types.py

@@ -10,6 +10,7 @@ from pydantic import AfterValidator, BaseModel, SecretStr, ValidationError
 from pydantic.fields import FieldInfo
 
 from cuenca_validations.types import (
+    Address,
     CardQuery,
     JSONEncoder,
     QueryParams,
@@ -22,7 +23,6 @@ from cuenca_validations.types import (
 from cuenca_validations.types.enums import (
     Country,
     EcommerceIndicator,
-    Profession,
     SessionType,
     State,
 )
@@ -303,54 +303,60 @@ def test_saving_update_request():
         SavingUpdateRequest(**data)
 
 
-@freeze_time('2022-01-01')
-def test_user_request():
-    request = dict(
-        curp='ABCD920604HDFSRN03',
-        profession=Profession.employee,
-        address=dict(
-            street='calle 1',
-            ext_number='2',
-            int_number='3',
-            colonia='Juarez',
-            postal_code='09900',
-            state=State.DF,
-            country=Country.MX,
-            city='Obrera',
-        ),
-        phone_verification_id='VE12345678',
-        email_verification_id='VE0987654321',
-        tos_agreement=dict(
-            tos_id='TOS123',
-            location=dict(latitude=19.4326, longitude=-99.1332),
-        ),
+def test_address_validation():
+    data = dict(
+        full_name='Varsovia 36, Col Cuahutemoc',
     )
-    assert UserRequest(**request).model_dump() == request
+    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,
+    )
+    assert Address(**data)
 
 
 @freeze_time('2022-01-01')
-def test_user_request_underage():
+def test_user_request():
     request = dict(
-        curp='ABCD060604HDFSRN03',  # underage CURP
+        id=None,
+        curp='ABCD920604HDFSRN03',
+        phone_number='+525555555555',
+        email_address='email@email.com',
         profession='worker',
+        status='active',
         address=dict(
             street='calle 1',
             ext_number='2',
             int_number='3',
             colonia='Juarez',
             postal_code='09900',
-            state=State.DF,
+            state=State.DF.value,
             country=Country.MX,
             city='Obrera',
+            full_name=None,
         ),
         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')
@@ -432,7 +438,7 @@ def test_user_update_request():
             birth_date=dt.date(2020, 1, 1).isoformat(),
             phone_number='+525555555555',
             user_relationship='brother',
-            percentage=100,
+            percentage=50,
         ),
     ]
     assert UserUpdateRequest(**request)
@@ -443,21 +449,12 @@ def test_user_update_request():
             birth_date=dt.date(2020, 1, 1).isoformat(),
             phone_number='+525555555555',
             user_relationship='brother',
-            percentage=50,
-        ),
-        dict(
-            name='José Pérez',
-            birth_date=dt.date(2020, 1, 2).isoformat(),
-            phone_number='+525544444444',
-            user_relationship='brother',
-            percentage=51,
+            percentage=101,
         ),
     ]
-    with pytest.raises(ValidationError) as v:
+    with pytest.raises(ValueError) as v:
         UserUpdateRequest(**request)
-
-    assert 'The total percentage should be 100%' in str(v)
-    request.pop('beneficiaries')
+        assert 'The total percentage is more than 100.' in str(v)
 
     tos_request = dict(
         terms_of_service=dict(
@@ -488,6 +485,12 @@ 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(