cuenca-validations 2.1.15__tar.gz → 2.1.16__tar.gz

{cuenca_validations-2.1.15 → cuenca_validations-2.1.16}/PKG-INFO

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

{cuenca_validations-2.1.15 → cuenca_validations-2.1.16}/cuenca_validations/types/__init__.py

@@ -1,4 +1,5 @@
 __all__ = [
+    'AccountUseType',
     'AccountQuery',
     'Address',
     'ApiKeyQuery',
@@ -43,6 +44,7 @@ __all__ = [
     'FileRequest',
     'FileUploadRequest',
     'Gender',
+    'IncomeType',
     'IssuerNetwork',
     'IdentityQuery',
     'JSONEncoder',
@@ -52,6 +54,8 @@ __all__ = [
     'KYCValidationSource',
     'Language',
     'LimitedWalletRequest',
+    'MonthlyMovementsType',
+    'MonthlySpendingType',
     'PartnerRequest',
     'PartnerUpdateRequest',
     'PhoneNumber',
@@ -107,12 +111,18 @@ __all__ = [
     'WebhookEvent',
     'digits',
     'get_state_name',
+    'get_profession_name',
+    'get_income_type_name',
+    'get_account_use_type_name',
+    'get_monthly_movements_type_name',
+    'get_monthly_spending_type_name',
     'uuid_field',
     'LogConfig',
 ]
 
 from .card import StrictPaymentCardNumber
 from .enums import (
+    AccountUseType,
     AuthorizerTransaction,
     BankAccountStatus,
     CardErrorType,
@@ -132,10 +142,13 @@ from .enums import (
     FileExtension,
     FileFormat,
     Gender,
+    IncomeType,
     IssuerNetwork,
     KYCFileType,
     KYCValidationSource,
     Language,
+    MonthlyMovementsType,
+    MonthlySpendingType,
     PlatformType,
     PosCapability,
     Profession,
@@ -163,6 +176,11 @@ from .general import (
     SantizedDict,
     StrictPositiveInt,
     digits,
+    get_account_use_type_name,
+    get_income_type_name,
+    get_monthly_movements_type_name,
+    get_monthly_spending_type_name,
+    get_profession_name,
     get_state_name,
 )
 from .helpers import uuid_field

{cuenca_validations-2.1.15 → cuenca_validations-2.1.16}/cuenca_validations/types/enums.py

@@ -691,16 +691,47 @@ class SATRegimeCode(str, Enum):
 
 
 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'
+    artisticas = 'artisticas'
+    agropecuario = 'agropecuario'
+    comercio = 'comercio'
+    estudiante = 'estudiante'
+    empleado = 'empleado'
+    emprendimiento = 'emprendimiento'
+    hogar = 'hogar'
+    profesor = 'profesor'
+    profesionista = 'profesionista'
+    servidor_publico = 'servidor_publico'
+    sistemas = 'sistemas'
+    independiente = 'independiente'
+    oficios = 'oficios'
+    otro = 'otro'
+
+
+class AccountUseType(str, Enum):
+    personal_expenses = 'personal_expenses'
+    business_expenses = 'business_expenses'
+    payment_of_goods_or_services = 'payment_of_goods_or_services'
+    send_or_receive_transfers = 'send_or_receive_transfers'
+
+
+class MonthlyMovementsType(str, Enum):
+    between_1_and_20 = 'between_1_and_20'
+    between_20_and_40 = 'between_20_and_40'
+    between_40_and_60 = 'between_40_and_60'
+    more_than_60 = 'more_than_60'
+
+
+class MonthlySpendingType(str, Enum):
+    less_than_1k = 'less_than_1k'
+    between_1k_and_10k = 'between_1k_and_10k'
+    between_10k_and_20k = 'between_10k_and_20k'
+    between_20k_and_50k = 'between_20k_and_50k'
+    between_50k_and_100k = 'between_50k_and_100k'
+    more_than_100k = 'more_than_100k'
+
+
+class IncomeType(str, Enum):
+    salary = 'salary'
+    freelance = 'freelance'
+    support_from_third_party = 'support_from_third_party'
+    variable = 'variable'

cuenca_validations-2.1.16/cuenca_validations/types/general.py

@@ -0,0 +1,194 @@
+import json
+from dataclasses import dataclass
+from typing import Annotated, Any, Optional
+
+from pydantic import (
+    AnyUrl,
+    Field,
+    HttpUrl,
+    IPvAnyAddress,
+    PlainSerializer,
+    StringConstraints,
+)
+
+from ..validators import sanitize_dict, sanitize_item
+from .enums import (
+    AccountUseType,
+    IncomeType,
+    MonthlyMovementsType,
+    MonthlySpendingType,
+    Profession,
+    State,
+)
+
+# We use custom serializers for IP addresses and URLs because
+# Pydantic's IPvAnyAddress, AnyUrl, HttpUrl types are not JSON serializable.
+SerializableHttpUrl = Annotated[HttpUrl, PlainSerializer(str, return_type=str)]
+SerializableAnyUrl = Annotated[AnyUrl, PlainSerializer(str, return_type=str)]
+SerializableIPvAnyAddress = Annotated[
+    IPvAnyAddress, PlainSerializer(str, return_type=str)
+]
+
+NonEmptyStr = Annotated[
+    str, StringConstraints(strip_whitespace=True, min_length=1)
+]
+
+
+class SantizedDict(dict):
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        sanitize_dict(self)
+
+
+class JSONEncoder(json.JSONEncoder):
+    def default(self, o):
+        return sanitize_item(o, default=super().default)
+
+
+MAX_VALUE_IN_DB = 21_474_836_47
+
+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
+) -> Annotated[Any, StringConstraints]:
+    return Annotated[
+        str,
+        StringConstraints(
+            strip_whitespace=True,
+            min_length=min_length,
+            max_length=max_length,
+            pattern=r'^\d+$',
+        ),
+    ]
+
+
+names_state = {
+    State.NE: 'Nacido en el Extranjero',
+    State.AS: 'Aguascalientes',
+    State.BC: 'Baja California',
+    State.BS: 'Baja California Sur',
+    State.CC: 'Campeche',
+    State.CS: 'Chiapas',
+    State.CH: 'Chihuahua',
+    State.CL: 'Coahuila',
+    State.CM: 'Colima',
+    State.DF: 'Ciudad de México',
+    State.DG: 'Durango',
+    State.GT: 'Guanajuato',
+    State.GR: 'Guerrero',
+    State.HG: 'Hidalgo',
+    State.JC: 'Jalisco',
+    State.MC: 'México',
+    State.MN: 'Michoacán',
+    State.MS: 'Morelos',
+    State.NT: 'Nayarit',
+    State.NL: 'Nuevo León',
+    State.OC: 'Oaxaca',
+    State.PL: 'Puebla',
+    State.QT: 'Querétaro',
+    State.QR: 'Quintana Roo',
+    State.SP: 'San Luis Potosí',
+    State.SL: 'Sinaloa',
+    State.SR: 'Sonora',
+    State.TC: 'Tabasco',
+    State.TL: 'Tlaxcala',
+    State.TS: 'Tamaulipas',
+    State.VZ: 'Veracruz',
+    State.YN: 'Yucatán',
+    State.ZS: 'Zacatecas',
+}
+
+
+def get_state_name(state: State) -> str:
+    return names_state[state]
+
+
+names_professions = {
+    Profession.artisticas: 'Actividades Artísticas',
+    Profession.agropecuario: 'Agricultura, Ganadería o Pesca',
+    Profession.comercio: 'Comercio',
+    Profession.estudiante: 'Estudiante',
+    Profession.empleado: 'Empleado(a/e)',
+    Profession.emprendimiento: 'Emprendimiento',
+    Profession.hogar: 'Hogar',
+    Profession.profesor: 'Profesor(a/e)',
+    Profession.profesionista: 'Profesionista',
+    Profession.servidor_publico: 'Servidor(a/e) Público',
+    Profession.sistemas: 'Sistemas y Comunicaciones',
+    Profession.independiente: 'Trabajador(a/e) Independiente',
+    Profession.oficios: 'Oficios Varios',
+    Profession.otro: 'Otro',
+}
+
+
+def get_profession_name(profession: Profession) -> str:
+    return names_professions[profession]
+
+
+names_account_use_types = {
+    AccountUseType.personal_expenses: 'Gastos personales o familiares',
+    AccountUseType.business_expenses: (
+        'Gastos relacionados con tu actividad económica'
+    ),
+    AccountUseType.payment_of_goods_or_services: 'Pago de bienes o servicios',
+    AccountUseType.send_or_receive_transfers: (
+        'Enviar o recibir transferencias'
+    ),
+}
+
+
+def get_account_use_type_name(account_use_type: AccountUseType) -> str:
+    return names_account_use_types[account_use_type]
+
+
+names_monthly_movements_types = {
+    MonthlyMovementsType.between_1_and_20: 'Entre 1 y 20 movimientos',
+    MonthlyMovementsType.between_20_and_40: 'Entre 20 y 40 movimientos',
+    MonthlyMovementsType.between_40_and_60: 'Entre 40 y 60 movimientos',
+    MonthlyMovementsType.more_than_60: 'Más de 60 movimientos',
+}
+
+
+def get_monthly_movements_type_name(
+    monthly_movements_type: MonthlyMovementsType,
+) -> str:
+    return names_monthly_movements_types[monthly_movements_type]
+
+
+names_monthly_spending_types = {
+    MonthlySpendingType.less_than_1k: 'Menos de $1,000',
+    MonthlySpendingType.between_1k_and_10k: 'Entre $1,000 y $10,000',
+    MonthlySpendingType.between_10k_and_20k: 'Entre $10,000 y $20,000',
+    MonthlySpendingType.between_20k_and_50k: 'Entre $20,000 y $50,000',
+    MonthlySpendingType.between_50k_and_100k: 'Entre $50,000 y $100,000',
+    MonthlySpendingType.more_than_100k: 'Más de $100,000',
+}
+
+
+def get_monthly_spending_type_name(
+    monthly_spending_type: MonthlySpendingType,
+) -> str:
+    return names_monthly_spending_types[monthly_spending_type]
+
+
+names_income_types = {
+    IncomeType.salary: 'Sueldo o salario fijo',
+    IncomeType.freelance: 'Independiente',
+    IncomeType.support_from_third_party: 'Apoyo de terceros o familiares',
+    IncomeType.variable: 'Variable',
+}
+
+
+def get_income_type_name(income_type: IncomeType) -> str:
+    return names_income_types[income_type]
+
+
+@dataclass
+class LogConfig:
+    masked: bool = False
+    unmasked_chars_length: int = 0
+    excluded: bool = False

{cuenca_validations-2.1.15 → cuenca_validations-2.1.16}/cuenca_validations/types/requests.py

@@ -17,6 +17,7 @@ from pydantic_core import core_schema
 from pydantic_extra_types.coordinate import Coordinate
 
 from ..types.enums import (
+    AccountUseType,
     AuthorizerTransaction,
     CardDesign,
     CardFundingType,
@@ -29,9 +30,12 @@ from ..types.enums import (
     EcommerceIndicator,
     FileExtension,
     Gender,
+    IncomeType,
     IssuerNetwork,
     KYCFileType,
     KYCValidationSource,
+    MonthlyMovementsType,
+    MonthlySpendingType,
     PlatformType,
     PosCapability,
     Profession,
@@ -447,7 +451,6 @@ class UserRequest(BaseModel):
             'Mexican government ID (18 characters). ' 'Must be pre-validated.'
         )
     )
-
     profession: Profession = Field(description='User profession or occupation')
     address: AddressRequest = Field(
         description='User residential address information'
@@ -460,13 +463,17 @@ class UserRequest(BaseModel):
         ...,
         description='ID of previously validated email verification',
     )
+    account_use_type: Optional[AccountUseType] = None
+    monthly_movements_type: Optional[MonthlyMovementsType] = None
+    monthly_spending_type: Optional[MonthlySpendingType] = None
+    income_type: Optional[IncomeType] = None
 
     model_config = ConfigDict(
         json_schema_extra={
             'example': {
                 'curp': 'GOCG650418HVZNML08',
-                'phone_number': '+525511223344',
-                'email_address': 'user@example.com',
+                'phone_verification_id': 'VEKp662Yrf6lMztl0-9qzk7Q',
+                'email_verification_id': 'VEwjDEcCMWZIk3JJ3p7P6T_A',
                 'profession': 'engineer',
                 'address': AddressRequest.model_json_schema().get('example'),
             }
@@ -480,6 +487,13 @@ 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 UserUpdateRequest(BaseModel):
     profession: Optional[Profession] = None
@@ -492,9 +506,14 @@ class UserUpdateRequest(BaseModel):
     proof_of_life: Optional[KYCFile] = None
     curp_document_uri: Optional[SerializableHttpUrl] = None
     fiscal_regime_code: Optional[SATRegimeCode] = None
+    fiscal_address: Optional[AddressRequest] = None
     pronouns: Optional[str] = None
     status: Optional[UserStatus] = None
     required_level: Optional[int] = None
+    account_use_type: Optional[AccountUseType] = None
+    monthly_movements_type: Optional[MonthlyMovementsType] = None
+    monthly_spending_type: Optional[MonthlySpendingType] = None
+    income_type: Optional[IncomeType] = None
 
     @field_validator('beneficiaries')
     @classmethod
@@ -505,6 +524,13 @@ class UserUpdateRequest(BaseModel):
             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[

cuenca_validations-2.1.16/cuenca_validations/version.py

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

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

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

{cuenca_validations-2.1.15 → cuenca_validations-2.1.16}/tests/test_types.py

@@ -17,10 +17,19 @@ from cuenca_validations.types import (
     SessionRequest,
     TransactionStatus,
     digits,
+    get_account_use_type_name,
+    get_income_type_name,
+    get_monthly_movements_type_name,
+    get_monthly_spending_type_name,
+    get_profession_name,
     get_state_name,
 )
 from cuenca_validations.types.enums import (
+    AccountUseType,
     EcommerceIndicator,
+    IncomeType,
+    MonthlyMovementsType,
+    MonthlySpendingType,
     Profession,
     SessionType,
     State,
@@ -316,7 +325,24 @@ def test_user_request():
         phone_verification_id='VE12345678',
         email_verification_id='VE0987654321',
     )
-    assert UserRequest(**request).model_dump() == 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')
@@ -410,6 +436,7 @@ def test_user_update_request():
             ),
         ],
         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]
@@ -418,6 +445,7 @@ def test_user_update_request():
         update_req.curp_document_uri.unicode_string()
         == request['curp_document_uri']
     )
+    assert update_req.profession == Profession.empleado
 
     request['beneficiaries'] = [
         dict(
@@ -481,6 +509,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(
@@ -544,10 +576,39 @@ def test_limited_wallet_request():
     assert LimitedWalletRequest(allowed_curp=curp, allowed_rfc=rfc)
 
 
-def test_get_state_name():
+def test_get_state_name() -> None:
     assert get_state_name(State.VZ) == 'Veracruz'
 
 
+def test_get_profession_name() -> None:
+    assert get_profession_name(Profession.empleado) == 'Empleado(a/e)'
+
+
+def test_get_income_type_name() -> None:
+    assert get_income_type_name(IncomeType.salary) == 'Sueldo o salario fijo'
+
+
+def test_get_account_use_type_name() -> None:
+    assert (
+        get_account_use_type_name(AccountUseType.personal_expenses)
+        == 'Gastos personales o familiares'
+    )
+
+
+def test_get_monthly_spending_type_name() -> None:
+    assert (
+        get_monthly_spending_type_name(MonthlySpendingType.less_than_1k)
+        == 'Menos de $1,000'
+    )
+
+
+def test_get_monthly_movements_type_name() -> None:
+    assert (
+        get_monthly_movements_type_name(MonthlyMovementsType.between_1_and_20)
+        == 'Entre 1 y 20 movimientos'
+    )
+
+
 def test_bank_account_validation_clabe_request():
     assert BankAccountValidationRequest(account_number='646180157098510917')
 

cuenca_validations-2.1.15/cuenca_validations/types/general.py

@@ -1,107 +0,0 @@
-import json
-from dataclasses import dataclass
-from typing import Annotated, Any, Optional
-
-from pydantic import (
-    AnyUrl,
-    Field,
-    HttpUrl,
-    IPvAnyAddress,
-    PlainSerializer,
-    StringConstraints,
-)
-
-from ..validators import sanitize_dict, sanitize_item
-from .enums import State
-
-# We use custom serializers for IP addresses and URLs because
-# Pydantic's IPvAnyAddress, AnyUrl, HttpUrl types are not JSON serializable.
-SerializableHttpUrl = Annotated[HttpUrl, PlainSerializer(str, return_type=str)]
-SerializableAnyUrl = Annotated[AnyUrl, PlainSerializer(str, return_type=str)]
-SerializableIPvAnyAddress = Annotated[
-    IPvAnyAddress, PlainSerializer(str, return_type=str)
-]
-
-NonEmptyStr = Annotated[
-    str, StringConstraints(strip_whitespace=True, min_length=1)
-]
-
-
-class SantizedDict(dict):
-    def __init__(self, *args, **kwargs):
-        super().__init__(*args, **kwargs)
-        sanitize_dict(self)
-
-
-class JSONEncoder(json.JSONEncoder):
-    def default(self, o):
-        return sanitize_item(o, default=super().default)
-
-
-MAX_VALUE_IN_DB = 21_474_836_47
-
-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
-) -> Annotated[Any, StringConstraints]:
-    return Annotated[
-        str,
-        StringConstraints(
-            strip_whitespace=True,
-            min_length=min_length,
-            max_length=max_length,
-            pattern=r'^\d+$',
-        ),
-    ]
-
-
-names_state = {
-    State.NE: 'Nacido en el Extranjero',
-    State.AS: 'Aguascalientes',
-    State.BC: 'Baja California',
-    State.BS: 'Baja California Sur',
-    State.CC: 'Campeche',
-    State.CS: 'Chiapas',
-    State.CH: 'Chihuahua',
-    State.CL: 'Coahuila',
-    State.CM: 'Colima',
-    State.DF: 'Ciudad de México',
-    State.DG: 'Durango',
-    State.GT: 'Guanajuato',
-    State.GR: 'Guerrero',
-    State.HG: 'Hidalgo',
-    State.JC: 'Jalisco',
-    State.MC: 'México',
-    State.MN: 'Michoacan',
-    State.MS: 'Morelos',
-    State.NT: 'Nayarit',
-    State.NL: 'Nuevo León',
-    State.OC: 'Oaxaca',
-    State.PL: 'Puebla',
-    State.QT: 'Querétaro',
-    State.QR: 'Quintana Roo',
-    State.SP: 'San Luis Potosí',
-    State.SL: 'Sinaloa',
-    State.SR: 'Sonora',
-    State.TC: 'Tabasco',
-    State.TL: 'Tlaxcala',
-    State.TS: 'Tamaulipas',
-    State.VZ: 'Veracruz',
-    State.YN: 'Yucatán',
-    State.ZS: 'Zacatecas',
-}
-
-
-def get_state_name(state: State):
-    return names_state[state]
-
-
-@dataclass
-class LogConfig:
-    masked: bool = False
-    unmasked_chars_length: int = 0
-    excluded: bool = False

cuenca_validations-2.1.15/cuenca_validations/version.py

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