cuenca-validations 2.1.16.dev100__tar.gz → 2.1.17__tar.gz

{cuenca_validations-2.1.16.dev100 → cuenca_validations-2.1.17}/PKG-INFO

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

{cuenca_validations-2.1.16.dev100 → cuenca_validations-2.1.17}/cuenca_validations/types/__init__.py

@@ -14,6 +14,7 @@ __all__ = [
     'BankAccountStatus',
     'BatchFileMetadata',
     'Beneficiary',
+    'BeneficiaryRequest',
     'BillPaymentQuery',
     'CardErrorType',
     'CardFundingType',
@@ -221,6 +222,7 @@ from .queries import (
 from .requests import (
     ApiKeyUpdateRequest,
     BankAccountValidationRequest,
+    BeneficiaryRequest,
     CurpValidationRequest,
     EndpointRequest,
     EndpointUpdateRequest,

{cuenca_validations-2.1.16.dev100 → cuenca_validations-2.1.17}/cuenca_validations/types/enums.py

@@ -588,7 +588,6 @@ class SessionType(str, Enum):
     account_entries = 'session.account_entries'
     download_file = 'session.download_file'
     upload_file = 'session.upload_file'
-    metamap_verification = 'session.metamap_verification'
 
 
 class WebhookObject(str, Enum):
@@ -705,7 +704,7 @@ class Profession(str, Enum):
     sistemas = 'sistemas'
     independiente = 'independiente'
     oficios = 'oficios'
-    otros = 'otros'
+    otro = 'otro'
 
 
 class AccountUseType(str, Enum):

{cuenca_validations-2.1.16.dev100 → cuenca_validations-2.1.17}/cuenca_validations/types/general.py

@@ -121,7 +121,7 @@ names_professions = {
     Profession.sistemas: 'Sistemas y Comunicaciones',
     Profession.independiente: 'Trabajador(a/e) Independiente',
     Profession.oficios: 'Oficios Varios',
-    Profession.otros: 'Otros',
+    Profession.otro: 'Otro',
 }
 
 

{cuenca_validations-2.1.16.dev100 → cuenca_validations-2.1.17}/cuenca_validations/types/identities.py

@@ -1,5 +1,5 @@
 import datetime as dt
-from typing import Annotated, Optional
+from typing import Annotated, Optional, Union
 
 from pydantic import BaseModel, ConfigDict, Field, SecretStr, StringConstraints
 from pydantic_extra_types.phone_numbers import PhoneNumber
@@ -89,12 +89,12 @@ class AddressRequest(BaseModel):
     )
 
 
-class Beneficiary(BaseModel):
+class BaseBeneficiary(BaseModel):
     name: str
     birth_date: dt.date
-    phone_number: PhoneNumber
     user_relationship: str
     percentage: Annotated[int, Field(ge=1, le=100)]
+
     model_config = ConfigDict(
         json_schema_extra={
             "example": {
@@ -108,6 +108,10 @@ class Beneficiary(BaseModel):
     )
 
 
+class Beneficiary(BaseBeneficiary):
+    phone_number: Union[PhoneNumber, str]
+
+
 class VerificationErrors(BaseModel):
     identifier: str = Field(
         description='Unique identifier for the step validation'

{cuenca_validations-2.1.16.dev100 → cuenca_validations-2.1.17}/cuenca_validations/types/requests.py

@@ -73,7 +73,7 @@ from .general import (
 from .helpers import validate_age_requirement
 from .identities import (
     AddressRequest,
-    Beneficiary,
+    BaseBeneficiary,
     Curp,
     KYCFile,
     Password,
@@ -330,7 +330,7 @@ class UserPldRiskLevelRequest(BaseModel):
     level: float = Field(ge=0.0, le=1.0)
 
 
-class CurpValidationRequest(BaseModel):
+class CurpValidationRequest(BaseRequest):
     names: Optional[str] = None
     first_surname: Optional[str] = None
     second_surname: Optional[str] = Field(
@@ -439,13 +439,13 @@ class FileCuencaUrl(str):
         )
 
 
-class UserTOSAgreementRequest(BaseModel):
+class UserTOSAgreementRequest(BaseRequest):
     tos_id: str
     location: Coordinate
     signature_image_url: Optional[FileCuencaUrl] = None
 
 
-class UserRequest(BaseModel):
+class UserRequest(BaseRequest):
     curp: Curp = Field(
         description=(
             'Mexican government ID (18 characters). ' 'Must be pre-validated.'
@@ -487,13 +487,24 @@ class UserRequest(BaseModel):
             validate_age_requirement(curp)
         return curp
 
+    @field_validator('profession')
+    @classmethod
+    def validate_profession(cls, profession: Profession) -> Profession:
+        if profession == Profession.otro:
+            raise ValueError('Profession "otro" is not allowed')
+        return profession
+
+
+class BeneficiaryRequest(BaseBeneficiary, BaseRequest):
+    phone_number: PhoneNumber
+
 
-class UserUpdateRequest(BaseModel):
+class UserUpdateRequest(BaseRequest):
     profession: Optional[Profession] = None
     email_verification_id: Optional[str] = None
     phone_verification_id: Optional[str] = None
     address: Optional[AddressRequest] = None
-    beneficiaries: Optional[list[Beneficiary]] = None
+    beneficiaries: Optional[list[BeneficiaryRequest]] = None
     govt_id: Optional[KYCFile] = None
     proof_of_address: Optional[KYCFile] = None
     proof_of_life: Optional[KYCFile] = None
@@ -511,12 +522,19 @@ class UserUpdateRequest(BaseModel):
     @field_validator('beneficiaries')
     @classmethod
     def beneficiary_percentage(
-        cls, beneficiaries: Optional[list[Beneficiary]] = None
+        cls, beneficiaries: Optional[list[BeneficiaryRequest]] = None
     ):
         if beneficiaries and sum(b.percentage for b in beneficiaries) != 100:
             raise ValueError('The total percentage should be 100%')
         return beneficiaries
 
+    @field_validator('profession')
+    @classmethod
+    def validate_profession(cls, profession: Profession) -> Profession:
+        if profession == Profession.otro:
+            raise ValueError('Profession "otro" is not allowed')
+        return profession
+
 
 class UserLoginRequest(BaseRequest):
     password: Annotated[
@@ -533,17 +551,6 @@ class SessionRequest(BaseRequest):
     type: SessionType
     success_url: Optional[SerializableAnyUrl] = None
     failure_url: Optional[SerializableAnyUrl] = None
-    metadata: Optional[dict] = None
-
-    @model_validator(mode='before')
-    @classmethod
-    def validate_metadata(cls, values: dict) -> dict:
-        if values[
-            'type'
-        ] == SessionType.metamap_verification and not values.get('metadata'):
-            raise ValueError('Metadata expected for this session')
-        return values
-
     model_config = ConfigDict(
         json_schema_extra={
             'example': {
@@ -551,7 +558,6 @@ class SessionRequest(BaseRequest):
                 'type': 'session.registration',
                 'success_url': 'http://example_success.com',
                 'failure_url': 'http://example_failure.com',
-                'metadata': {'verification_id': 'some_verification_id'},
             }
         }
     )
@@ -588,7 +594,7 @@ class FileBatchUploadRequest(BaseModel):
     user_id: str
 
 
-class VerificationRequest(BaseModel):
+class VerificationRequest(BaseRequest):
     type: VerificationType
     recipient: Union[EmailStr, PhoneNumber] = Field(
         description='Phone or email to validate'
@@ -612,7 +618,7 @@ class VerificationRequest(BaseModel):
         )
 
 
-class VerificationAttemptRequest(BaseModel):
+class VerificationAttemptRequest(BaseRequest):
     code: Annotated[
         str,
         StringConstraints(strict=True, min_length=6, max_length=6),
@@ -653,11 +659,11 @@ class KYCValidationRequest(BaseRequest):
     force: bool = False
 
 
-class BankAccountValidationRequest(BaseModel):
+class BankAccountValidationRequest(BaseRequest):
     account_number: Union[Clabe, PaymentCardNumber]
 
 
-class UserListsRequest(BaseModel):
+class UserListsRequest(BaseRequest):
     curp: Optional[Curp] = Field(None, description='Curp to review on lists')
     rfc: Optional[Rfc] = Field(None, description='Rfc to review on lists')
     account_number: Optional[Union[Clabe, PaymentCardNumber]] = Field(
@@ -756,5 +762,5 @@ class PartnerUpdateRequest(BaseRequest):
     shareholders: Optional[list[Shareholder]] = None
 
 
-class PhoneVerificationAssociationRequest(BaseModel):
+class PhoneVerificationAssociationRequest(BaseRequest):
     verification_id: str

cuenca_validations-2.1.17/cuenca_validations/version.py

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

{cuenca_validations-2.1.16.dev100 → cuenca_validations-2.1.17}/cuenca_validations.egg-info/PKG-INFO

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

cuenca_validations-2.1.17/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/EFQL8_ohvoRp-PkOTYgvQYFA'
+        ),
+    )
+    utos = UserTOSAgreementRequest(**request_data)
+    assert utos.signature_image_url is not None
+    assert utos.signature_image_url.file_id == 'EFQL8_ohvoRp-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.16.dev100 → cuenca_validations-2.1.17}/tests/test_types.py

@@ -328,6 +328,23 @@ def test_user_request():
     assert UserRequest(**request).model_dump(exclude_none=True) == request
 
 
+def test_user_request_invalid_profession():
+    request = dict(
+        curp='ABCD920604HDFSRN03',
+        profession=Profession.otro,
+        address=dict(
+            street='calle 1',
+            ext_number='2',
+            int_number='3',
+            postal_code_id='PC2ygq9j2bS9-9tsuVawzErA',
+        ),
+        phone_verification_id='VE12345678',
+        email_verification_id='VE0987654321',
+    )
+    with pytest.raises(ValidationError):
+        UserRequest(**request)
+
+
 @freeze_time('2022-01-01')
 def test_user_request_underage():
     request = dict(
@@ -377,7 +394,9 @@ def test_curp_validation_request():
     assert all(field in error_msg for field in required_fields)
 
     req_curp = CurpValidationRequest(**request)
-    assert req_curp.model_dump() == request
+    # exclude_none=False to test that the request equals the original dict,
+    # since normally exclude_none defaults to True in BaseRequest.model_dump()
+    assert req_curp.model_dump(exclude_none=False) == request
 
     request['date_of_birth'] = dt.date(2006, 5, 17)
 
@@ -418,15 +437,12 @@ def test_user_update_request():
                 percentage=50,
             ),
         ],
-        curp_document_uri='https://sandbox.cuenca.com/files/EF123',
+        profession=Profession.empleado,
     )
     update_req = UserUpdateRequest(**request)
     beneficiaries = [b.model_dump() for b in update_req.beneficiaries]
     assert beneficiaries == request['beneficiaries']
-    assert (
-        update_req.curp_document_uri.unicode_string()
-        == request['curp_document_uri']
-    )
+    assert update_req.profession == Profession.empleado
 
     request['beneficiaries'] = [
         dict(
@@ -461,26 +477,6 @@ def test_user_update_request():
     assert 'The total percentage should be 100%' in str(v)
     request.pop('beneficiaries')
 
-    tos_request = dict(
-        terms_of_service=dict(
-            version='2022-01-01',
-            ip='127.0.0.1',
-            location='1111,1111',
-            type='ifpe',
-        )
-    )
-    UserUpdateRequest(**tos_request)
-
-    tos_request = dict(
-        terms_of_service=dict(
-            version='2022-01-01',
-            ip='2001:0db8:0000:0000:0000:ff00:0042:8329',
-            location='1111,1111',
-            type='ifpe',
-        )
-    )
-    UserUpdateRequest(**tos_request)
-
     kyc_request = dict(
         govt_id=dict(
             type='ine',
@@ -490,6 +486,10 @@ def test_user_update_request():
     )
     UserUpdateRequest(**kyc_request)
 
+    request['profession'] = Profession.otro
+    with pytest.raises(ValidationError) as v:
+        UserUpdateRequest(**request)
+
 
 def test_session_request():
     data = dict(

cuenca_validations-2.1.16.dev100/cuenca_validations/version.py

@@ -1 +0,0 @@
-__version__ = '2.1.16.dev100'

cuenca_validations-2.1.16.dev100/tests/test_requests.py

@@ -1,70 +0,0 @@
-import pytest
-from pydantic import ValidationError
-
-from cuenca_validations.types.enums import SessionType
-from cuenca_validations.types.requests import (
-    SessionRequest,
-    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/EFQL8_ohvoRp-PkOTYgvQYFA'
-        ),
-    )
-    utos = UserTOSAgreementRequest(**request_data)
-    assert utos.signature_image_url is not None
-    assert utos.signature_image_url.file_id == 'EFQL8_ohvoRp-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)
-
-
-def test_session_request_without_metadata():
-    request_data = {
-        'user_id': 'USWqY5cvkISJOxHyEKjAKf8w',
-        'type': 'session.curp_validation',
-    }
-    request = SessionRequest(**request_data)
-    assert request.type == SessionType.curp_validation
-    assert request.user_id == 'USWqY5cvkISJOxHyEKjAKf8w'
-
-
-def test_session_request_with_metadata():
-    request_data = {
-        'user_id': 'USWqY5cvkISJOxHyEKjAKf8w',
-        'type': 'session.metamap_verification',
-        'metadata': {'verification_id': 'some_verification'},
-    }
-    request = SessionRequest(**request_data)
-    assert request.type == SessionType.metamap_verification
-    assert request.user_id == 'USWqY5cvkISJOxHyEKjAKf8w'
-    assert request.metadata
-    assert request.metadata['verification_id'] == 'some_verification'
-
-
-def test_metamap_session_request_without_metadata():
-    request_data = {
-        'user_id': 'USWqY5cvkISJOxHyEKjAKf8w',
-        'type': 'session.metamap_verification',
-    }
-
-    with pytest.raises(ValidationError) as exception:
-        SessionRequest(**request_data)
-
-    assert 'Metadata expected for this session' in str(exception)