cuenca-validations 2.1.41.dev0__py3-none-any.whl → 2.1.41.dev2__py3-none-any.whl

cuenca_validations/types/__init__.py

@@ -60,11 +60,20 @@ __all__ = [
     'KYCValidationRequest',
     'KYCValidationSource',
     'Language',
+    'LegalPersonRequest',
+    'LegalPersonUpdateRequest',
     'LimitedWalletRequest',
     'MonthlyMovementsType',
     'MonthlySpendingType',
     'OperationalEventAction',
     'OperationalEventQuery',
+    'OperatorLoginRequest',
+    'OperatorLoginResponse',
+    'OperatorQuery',
+    'OperatorRequest',
+    'OperatorRole',
+    'OperatorStatus',
+    'OperatorUpdateRequest',
     'PartnerRequest',
     'PartnerUpdateRequest',
     'PasswordResetRequest',
@@ -82,8 +91,10 @@ __all__ = [
     'SavingRequest',
     'SavingUpdateRequest',
     'ServiceProviderCategory',
+    'SessionMetadata',
     'SessionQuery',
     'SessionRequest',
+    'SessionResponse',
     'SessionType',
     'State',
     'StatementQuery',
@@ -162,6 +173,8 @@ from .enums import (
     MonthlyMovementsType,
     MonthlySpendingType,
     OperationalEventAction,
+    OperatorRole,
+    OperatorStatus,
     PlatformType,
     PosCapability,
     Profession,
@@ -221,6 +234,7 @@ from .queries import (
     FileQuery,
     IdentityQuery,
     OperationalEventQuery,
+    OperatorQuery,
     PostalCodeQuery,
     QueryParams,
     SessionQuery,
@@ -248,7 +262,13 @@ from .requests import (
     FileUploadRequest,
     FraudFundsTransferRequest,
     KYCValidationRequest,
+    LegalPersonRequest,
+    LegalPersonUpdateRequest,
     LimitedWalletRequest,
+    OperatorLoginRequest,
+    OperatorLoginResponse,
+    OperatorRequest,
+    OperatorUpdateRequest,
     PartnerRequest,
     PartnerUpdateRequest,
     PasswordResetRequest,
@@ -256,7 +276,9 @@ from .requests import (
     QuestionnairesRequest,
     SavingRequest,
     SavingUpdateRequest,
+    SessionMetadata,
     SessionRequest,
+    SessionResponse,
     StrictTransferRequest,
     TOSRequest,
     TransferRequest,

cuenca_validations/types/enums.py

@@ -756,3 +756,13 @@ class OperationalEventAction(str, Enum):
     account_updated = 'account_updated'
     transfer_created = 'transfer_created'
     statement_downloaded = 'statement_downloaded'
+
+
+class OperatorRole(str, Enum):
+    operator = 'operator'
+    authorizer = 'authorizer'
+
+
+class OperatorStatus(str, Enum):
+    active = 'active'
+    disabled = 'disabled'

cuenca_validations/types/queries.py

@@ -159,6 +159,10 @@ class OperationalEventQuery(QueryParams):
     action: Optional[OperationalEventAction] = None
 
 
+class OperatorQuery(QueryParams):
+    email: Optional[EmailStr] = None
+
+
 class BalanceEntryQuery(QueryParams):
     funding_instrument_uri: Optional[str] = None
     wallet_id: str = 'default'

cuenca_validations/types/requests.py

@@ -37,6 +37,8 @@ from ..types.enums import (
     KYCValidationSource,
     MonthlyMovementsType,
     MonthlySpendingType,
+    OperatorRole,
+    OperatorStatus,
     PlatformType,
     PosCapability,
     Profession,
@@ -630,11 +632,29 @@ class UserLoginRequest(BaseRequest):
     )
 
 
+class SessionMetadata(BaseModel):
+    operator_id: Optional[str] = None
+    model_config = ConfigDict(extra='forbid')
+
+
+class SessionResponse(BaseModel):
+    id: str
+    created_at: dt.datetime
+    user_id: str
+    platform_id: str
+    expires_at: dt.datetime
+    type: SessionType
+    success_url: Optional[SerializableAnyUrl] = None
+    failure_url: Optional[SerializableAnyUrl] = None
+    metadata: Optional[SessionMetadata] = None
+
+
 class SessionRequest(BaseRequest):
     user_id: str
     type: SessionType
     success_url: Optional[SerializableAnyUrl] = None
     failure_url: Optional[SerializableAnyUrl] = None
+    metadata: Optional[SessionMetadata] = None
     model_config = ConfigDict(
         json_schema_extra={
             'example': {
@@ -897,5 +917,130 @@ class PartnerUpdateRequest(BaseRequest):
     shareholders: Optional[list[Shareholder]] = None
 
 
+class LegalPersonRequest(BaseRequest):
+    legal_name: str
+    rfc: Rfc
+    legal_representatives: list[LegalRepresentative]
+
+    model_config = ConfigDict(
+        json_schema_extra={
+            'example': {
+                'legal_name': 'Aceros del Norte SA de CV',
+                'rfc': 'ADN850101ABC',
+                'legal_representatives': [
+                    {
+                        'names': 'Juan',
+                        'first_surname': 'Perez',
+                        'job': 'Director General',
+                        'phone_number': '+525512345678',
+                        'email_address': 'juan.perez@aceros.com',
+                        'address': AddressRequest.model_json_schema().get(
+                            'example'
+                        ),
+                    }
+                ],
+            }
+        },
+    )
+
+    @field_validator('rfc')
+    @classmethod
+    def validate_legal_rfc(cls, rfc: Rfc) -> Rfc:
+        if len(rfc) != 12:
+            raise ValueError('RFC must be 12 characters for legal persons')
+        return rfc
+
+
+class LegalPersonUpdateRequest(BaseRequest):
+    legal_name: Optional[str] = None
+    rfc: Optional[Rfc] = None
+    legal_representatives: Optional[list[LegalRepresentative]] = None
+
+    @model_validator(mode="before")
+    @classmethod
+    def check_at_least_one_param(cls, values: DictStrAny) -> DictStrAny:
+        if not values:
+            raise ValueError('At least one parameter must be provided')
+        return values
+
+    @field_validator('rfc')
+    @classmethod
+    def validate_legal_rfc(cls, rfc: Optional[Rfc]) -> Optional[Rfc]:
+        if rfc is not None and len(rfc) != 12:
+            raise ValueError('RFC must be 12 characters for legal persons')
+        return rfc
+
+
+class OperatorRequest(BaseRequest):
+    name: str
+    email: EmailStr
+    phone: PhoneNumber
+    company_user_id: str
+    role: OperatorRole
+    status: OperatorStatus = OperatorStatus.active
+
+    model_config = ConfigDict(
+        json_schema_extra={
+            'example': {
+                'name': 'Maria Lopez',
+                'email': 'maria.lopez@aceros.com',
+                'phone': '+525512345678',
+                'company_user_id': 'USWqY5cvkISJOxHyEKjAKf8w',
+                'role': 'operator',
+            }
+        },
+    )
+
+    @field_validator('email', mode='before')
+    @classmethod
+    def validate_email(cls, email: str) -> str:
+        return normalize_email(email)
+
+
+class OperatorUpdateRequest(BaseRequest):
+    name: Optional[str] = None
+    phone: Optional[PhoneNumber] = None
+    role: Optional[OperatorRole] = None
+    status: Optional[OperatorStatus] = None
+
+    @model_validator(mode="before")
+    @classmethod
+    def check_at_least_one_param(cls, values: DictStrAny) -> DictStrAny:
+        if not values:
+            raise ValueError('At least one parameter must be provided')
+        return values
+
+
+class OperatorLoginRequest(BaseRequest):
+    email: EmailStr
+    password: Annotated[Password, LogConfig(masked=True)]
+
+    model_config = ConfigDict(
+        json_schema_extra={
+            'example': {
+                'email': 'maria.lopez@aceros.com',
+                'password': 'supersecret',
+            }
+        },
+    )
+
+    @field_validator('email', mode='before')
+    @classmethod
+    def validate_email(cls, email: str) -> str:
+        return normalize_email(email)
+
+
+class OperatorLoginResponse(BaseModel):
+    session_token: str
+
+    model_config = ConfigDict(
+        json_schema_extra={
+            'example': {
+                'session_token': 'SEWqY5cvkISJOxHyEKjAKf8w',
+            }
+        },
+    )
+
+
 class PhoneVerificationAssociationRequest(BaseRequest):
     verification_id: str

cuenca_validations/version.py

@@ -1 +1 @@
-__version__ = '2.1.41.dev0'
+__version__ = '2.1.41.dev2'

{cuenca_validations-2.1.41.dev0.dist-info → cuenca_validations-2.1.41.dev2.dist-info}/METADATA

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

{cuenca_validations-2.1.41.dev0.dist-info → cuenca_validations-2.1.41.dev2.dist-info}/RECORD

@@ -4,27 +4,27 @@ 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=zXSnU5-EMbQZBD-PfFXgP4Z6G7cm7KFDWXB7Nie6WUk,2682
-cuenca_validations/version.py,sha256=ubLWpnM5zm6k0bIqWBrnYr4Msp7aeytwO3zKPd4HR98,28
-cuenca_validations/types/__init__.py,sha256=n4mpy0wj_WIElwNXeT2cN4en1yKX5NtK59eoOeKU4WM,5981
+cuenca_validations/version.py,sha256=f6oBhe4tuXWBMavvc2zCkPloMISzZ6JOFutLe96ZTQc,28
+cuenca_validations/types/__init__.py,sha256=iBrQYsV3gnlA1HRdMZlkNcz1c1JI8OEfql7vf5-oHbQ,6511
 cuenca_validations/types/card.py,sha256=UGzz8NTFAverUmdUKAK1oGHnOnjSNTpIRUm93vKSSGY,1295
-cuenca_validations/types/enums.py,sha256=xl-J2uQYhhjioJWewySHODM692P3SLUNX3sabt78aw4,20923
+cuenca_validations/types/enums.py,sha256=FNh-jMeRor-HHdlLYSkeOzEJWQt_rY7gcJ_xxnJ92BA,21095
 cuenca_validations/types/files.py,sha256=2CszbwF9ytXV9suFFwyDjYG4XxY8UhCjRw3HttVXXNw,269
 cuenca_validations/types/general.py,sha256=eYFYwyx_a4_J480GYpqW3DFbZabDFcUjvLRMQbShIUc,5622
 cuenca_validations/types/helpers.py,sha256=4veeLZbugHHqZk0ezSim978VhH6Vq8XTrEhe1eE_r3A,1531
 cuenca_validations/types/identities.py,sha256=j2xxh3UYHJe6IbAwr9yNXJkebTth_-g3SUmHeiPez8M,5513
 cuenca_validations/types/morals.py,sha256=davabh5hAnFVQyM7-yCyDaT5ewXnm0cr1BtqDIwzkX8,1833
-cuenca_validations/types/queries.py,sha256=mcliWtNb6QAst1phf3KYQ24vj90cxBAn6FDlC-WAhKo,6021
-cuenca_validations/types/requests.py,sha256=gJD0zI6ADvO_9FiWZ2zfSjtsHr-_B2ILhd4IFtpqLkE,26550
-cuenca_validations-2.1.41.dev0.dist-info/licenses/LICENSE,sha256=wR76FmxBbfnQpwELkkE5iMF8sFIafEMgXLTE4N4WPTc,1063
+cuenca_validations/types/queries.py,sha256=ZakPAM9kiABA2qL-Z2z46GbFqaGXG4JKtqLn0ZTlW3Y,6094
+cuenca_validations/types/requests.py,sha256=MnONAIHdVitz_Hxv5xC4bhaTV7_UcA9o1xzR-_IEj5c,30683
+cuenca_validations-2.1.41.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=fx2R7y6oQO8XeQzevJe826NuHkBgvtznZicomchB3Gg,899
-tests/test_requests.py,sha256=9kzuWBikfhrQqH7sJ-HQN9UCJ-Fph0MPL4j6q1RfI4o,4320
+tests/test_requests.py,sha256=TNLQSATFzqLSnAdcoyoR7I8hLF2hE5sNw9ccNT0PCj8,10124
 tests/test_statement.py,sha256=IOE0rRRBgBZSJv_FLaETEyn5NzzXKMNTqgjv99GX-68,1436
 tests/test_types.py,sha256=rPjqPGfPU73MSdbeJpoW_ai5TAO25hWSnQAt_H7ZIeI,23055
 tests/test_validators.py,sha256=Jjr9gWTT4cRntGiKvQK4fncqx3JkEuTWkKm1VqpRHTs,1829
-cuenca_validations-2.1.41.dev0.dist-info/METADATA,sha256=sMBxw8wEViatzoxLp2Q3fdHYza0uh5Tgd9rqvGU_Nxs,1600
-cuenca_validations-2.1.41.dev0.dist-info/WHEEL,sha256=YVMoNqKzERt-wjUZwJ33xBGAwnFl-4cqbYkTtWa4itE,91
-cuenca_validations-2.1.41.dev0.dist-info/top_level.txt,sha256=4233xdOs2HtuT-GFRjcDcwK0IwdwvWdczOtk0fPB6Gw,25
-cuenca_validations-2.1.41.dev0.dist-info/RECORD,,
+cuenca_validations-2.1.41.dev2.dist-info/METADATA,sha256=qRdZW41d9lWeLaEHAc_siSZUZb22W-lYkVnnghx1Ohk,1600
+cuenca_validations-2.1.41.dev2.dist-info/WHEEL,sha256=YVMoNqKzERt-wjUZwJ33xBGAwnFl-4cqbYkTtWa4itE,91
+cuenca_validations-2.1.41.dev2.dist-info/top_level.txt,sha256=4233xdOs2HtuT-GFRjcDcwK0IwdwvWdczOtk0fPB6Gw,25
+cuenca_validations-2.1.41.dev2.dist-info/RECORD,,

tests/test_requests.py

@@ -2,9 +2,24 @@ import pytest
 from pydantic import ValidationError
 from pydantic_extra_types.phone_numbers import PhoneNumber
 
-from cuenca_validations.types.enums import Country, VerificationType
+from cuenca_validations.types.enums import (
+    Country,
+    OperatorRole,
+    OperatorStatus,
+    SessionType,
+    VerificationType,
+)
+from cuenca_validations.types.queries import OperatorQuery
 from cuenca_validations.types.requests import (
+    LegalPersonRequest,
+    LegalPersonUpdateRequest,
+    OperatorLoginRequest,
+    OperatorLoginResponse,
+    OperatorRequest,
+    OperatorUpdateRequest,
     PasswordResetRequest,
+    SessionMetadata,
+    SessionRequest,
     UpdateTransferRequest,
     UserTOSAgreementRequest,
     UserUpdateRequest,
@@ -12,6 +27,175 @@ from cuenca_validations.types.requests import (
 )
 from cuenca_validations.typing import DictStrAny
 
+LEGAL_REPRESENTATIVE: DictStrAny = {
+    'names': 'Juan',
+    'first_surname': 'Perez',
+    'job': 'Director General',
+    'phone_number': '+525512345678',
+    'email_address': 'juan.perez@aceros.com',
+    'address': {
+        'street': 'Reforma',
+        'ext_number': '265',
+        'postal_code_id': 'PC2ygq9j2bS9-9tsuVawzErA',
+    },
+}
+
+LEGAL_PERSON_REQUEST: DictStrAny = {
+    'legal_name': 'Aceros del Norte SA de CV',
+    'rfc': 'ADN850101ABC',
+    'legal_representatives': [LEGAL_REPRESENTATIVE],
+}
+
+
+def test_legal_person_request_valid() -> None:
+    req = LegalPersonRequest.model_validate(LEGAL_PERSON_REQUEST)
+    assert req.legal_name == 'Aceros del Norte SA de CV'
+    assert req.rfc == 'ADN850101ABC'
+
+
+def test_legal_person_request_rejects_physical_rfc() -> None:
+    with pytest.raises(ValidationError) as ex:
+        LegalPersonRequest.model_validate(
+            {**LEGAL_PERSON_REQUEST, 'rfc': 'GOCG650418TJ1'}
+        )
+    assert 'RFC must be 12 characters for legal persons' in str(ex.value)
+
+
+def test_legal_person_request_forbids_extra() -> None:
+    with pytest.raises(ValidationError) as ex:
+        LegalPersonRequest.model_validate(
+            {**LEGAL_PERSON_REQUEST, 'foo': 'bar'}
+        )
+    assert 'Extra inputs are not permitted' in str(ex.value)
+
+
+def test_legal_person_update_requires_at_least_one_param() -> None:
+    with pytest.raises(ValueError) as ex:
+        LegalPersonUpdateRequest()
+    assert 'At least one parameter must be provided' in str(ex.value)
+
+
+def test_legal_person_update_valid() -> None:
+    req = LegalPersonUpdateRequest.model_validate({'legal_name': 'New name'})
+    assert req.legal_name == 'New name'
+
+
+def test_legal_person_update_accepts_legal_rfc() -> None:
+    req = LegalPersonUpdateRequest.model_validate({'rfc': 'ADN850101ABC'})
+    assert req.rfc == 'ADN850101ABC'
+
+
+def test_legal_person_update_rejects_physical_rfc() -> None:
+    with pytest.raises(ValidationError) as ex:
+        LegalPersonUpdateRequest.model_validate({'rfc': 'GOCG650418TJ1'})
+    assert 'RFC must be 12 characters for legal persons' in str(ex.value)
+
+
+def test_operator_request_valid() -> None:
+    req = OperatorRequest(
+        name='Maria Lopez',
+        email='Maria+Tag@Aceros.com',
+        phone=PhoneNumber('+525512345678'),
+        company_user_id='USWqY5cvkISJOxHyEKjAKf8w',
+        role=OperatorRole.operator,
+    )
+    assert req.email == 'maria@aceros.com'
+    assert req.status == OperatorStatus.active
+
+
+def test_operator_request_rejects_invalid_role() -> None:
+    with pytest.raises(ValidationError) as ex:
+        OperatorRequest.model_validate(
+            {
+                'name': 'Maria Lopez',
+                'email': 'maria@aceros.com',
+                'phone': '+525512345678',
+                'company_user_id': 'USWqY5cvkISJOxHyEKjAKf8w',
+                'role': 'admin',
+            }
+        )
+    assert 'role' in str(ex.value)
+
+
+def test_operator_update_requires_at_least_one_param() -> None:
+    with pytest.raises(ValueError) as ex:
+        OperatorUpdateRequest()
+    assert 'At least one parameter must be provided' in str(ex.value)
+
+
+def test_operator_update_valid() -> None:
+    req = OperatorUpdateRequest.model_validate({'name': 'New name'})
+    assert req.name == 'New name'
+
+
+def test_operator_login_request_valid() -> None:
+    req = OperatorLoginRequest.model_validate(
+        {
+            'email': 'Operator+Tag@Aceros.com',
+            'password': 'supersecret',
+        }
+    )
+    assert req.email == 'operator@aceros.com'
+
+
+def test_operator_login_request_rejects_short_password() -> None:
+    with pytest.raises(ValidationError) as ex:
+        OperatorLoginRequest.model_validate(
+            {
+                'email': 'operator@aceros.com',
+                'password': 'short',
+            }
+        )
+    assert 'password' in str(ex.value)
+
+
+def test_operator_login_request_forbids_extra() -> None:
+    with pytest.raises(ValidationError) as ex:
+        OperatorLoginRequest.model_validate(
+            {
+                'email': 'operator@aceros.com',
+                'password': 'supersecret',
+                'foo': 'bar',
+            }
+        )
+    assert 'Extra inputs are not permitted' in str(ex.value)
+
+
+def test_operator_login_response_valid() -> None:
+    resp = OperatorLoginResponse(session_token='SEWqY5cvkISJOxHyEKjAKf8w')
+    assert resp.session_token == 'SEWqY5cvkISJOxHyEKjAKf8w'
+
+
+def test_operator_query_valid() -> None:
+    query = OperatorQuery.model_validate({'email': 'maria.lopez@aceros.com'})
+    assert str(query.email) == 'maria.lopez@aceros.com'
+
+
+def test_operator_query_forbids_extra() -> None:
+    with pytest.raises(ValidationError) as ex:
+        OperatorQuery.model_validate(
+            {'email': 'maria@aceros.com', 'foo': 'bar'}
+        )
+    assert 'Extra inputs are not permitted' in str(ex.value)
+
+
+def test_session_request_with_operator_metadata() -> None:
+    req = SessionRequest(
+        user_id='USWqY5cvkISJOxHyEKjAKf8w',
+        type=SessionType.registration,
+        metadata=SessionMetadata(operator_id='OPWqY5cvkISJOxHyEKjAKf8w'),
+    )
+    assert req.metadata is not None
+    assert req.metadata.operator_id == 'OPWqY5cvkISJOxHyEKjAKf8w'
+
+
+def test_session_request_metadata_forbids_extra() -> None:
+    with pytest.raises(ValidationError) as ex:
+        SessionMetadata.model_validate(
+            {'operator_id': 'OPWqY5cvkISJOxHyEKjAKf8w', 'foo': 'bar'}
+        )
+    assert 'Extra inputs are not permitted' in str(ex.value)
+
 
 @pytest.mark.parametrize('environment', ['api.stage', 'api.sandbox', 'api'])
 def test_file_cuenca_url(environment: str) -> None: