feat: webapp PM portal types

cuenca_validations/types/__init__.py

@@ -1,6 +1,9 @@
 __all__ = [
     'AccountUseType',
     'AccountQuery',
+    'AccountRequest',
+    'AccountUpdateRequest',
+    'AccountValidationStatus',
     'Address',
     'AgentQuery',
     'AgentRequest',
@@ -57,11 +60,20 @@
     'KYCValidationRequest',
     'KYCValidationSource',
     'Language',
+    'LegalPersonRequest',
+    'LegalPersonUpdateRequest',
     'LimitedWalletRequest',
     'MonthlyMovementsType',
     'MonthlySpendingType',
-    'LegalPersonRequest',
-    'LegalPersonUpdateRequest',
+    'OperationalEventAction',
+    'OperationalEventQuery',
+    'OperatorLoginRequest',
+    'OperatorLoginResponse',
+    'OperatorQuery',
+    'OperatorRequest',
+    'OperatorRole',
+    'OperatorStatus',
+    'OperatorUpdateRequest',
     'PartnerRequest',
     'PartnerUpdateRequest',
     'PasswordResetRequest',
@@ -80,8 +92,10 @@
     'SavingRequest',
     'SavingUpdateRequest',
     'ServiceProviderCategory',
+    'SessionMetadata',
     'SessionQuery',
     'SessionRequest',
+    'SessionResponse',
     'SessionType',
     'State',
     'StatementQuery',
@@ -132,6 +146,7 @@
 from .card import StrictPaymentCardNumber
 from .enums import (
     AccountUseType,
+    AccountValidationStatus,
     AuthorizerTransaction,
     BankAccountStatus,
     CardErrorType,
@@ -158,6 +173,9 @@
     Language,
     MonthlyMovementsType,
     MonthlySpendingType,
+    OperationalEventAction,
+    OperatorRole,
+    OperatorStatus,
     PlatformType,
     PosCapability,
     Profession,
@@ -216,6 +234,8 @@
     EventQuery,
     FileQuery,
     IdentityQuery,
+    OperationalEventQuery,
+    OperatorQuery,
     PostalCodeQuery,
     QueryParams,
     SessionQuery,
@@ -229,6 +249,8 @@
     WalletTransactionQuery,
 )
 from .requests import (
+    AccountRequest,
+    AccountUpdateRequest,
     AgentRequest,
     ApiKeyUpdateRequest,
     BankAccountValidationRequest,
@@ -244,14 +266,20 @@
     LegalPersonRequest,
     LegalPersonUpdateRequest,
     LimitedWalletRequest,
+    OperatorLoginRequest,
+    OperatorLoginResponse,
+    OperatorRequest,
+    OperatorUpdateRequest,
     PartnerRequest,
     PartnerUpdateRequest,
     PasswordResetRequest,
     PlatformRequest,
     QuestionnairesRequest,
     SavingRequest,
     SavingUpdateRequest,
+    SessionMetadata,
     SessionRequest,
+    SessionResponse,
     StrictTransferRequest,
     TOSRequest,
     TransferRequest,

cuenca_validations/types/enums.py

@@ -745,3 +745,25 @@ class RequiredAction(str, Enum):
     level_up_required = 'level_up_required'
     level_up_invitation = 'level_up_invitation'
     fix_documents = 'fix_documents'
+
+
+class AccountValidationStatus(str, Enum):
+    verified = 'verified'
+    pending = 'pending'
+
+
+class OperationalEventAction(str, Enum):
+    account_created = 'account_created'
+    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

@@ -22,6 +22,7 @@
     CardType,
     EventType,
     KYCFileType,
+    OperationalEventAction,
     SessionType,
     TermsOfService,
     TransferNetwork,
@@ -153,6 +154,15 @@ class AccountQuery(QueryParams):
     account_number: Optional[str] = None
 
 
+class OperationalEventQuery(QueryParams):
+    actor_id: Optional[str] = None
+    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

@@ -18,6 +18,7 @@
 
 from ..types.enums import (
     AccountUseType,
+    AccountValidationStatus,
     AuthorizerTransaction,
     CardDesign,
     CardFundingType,
@@ -36,6 +37,8 @@
     KYCValidationSource,
     MonthlyMovementsType,
     MonthlySpendingType,
+    OperatorRole,
+    OperatorStatus,
     PlatformType,
     PosCapability,
     Profession,
@@ -629,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': {
@@ -735,6 +756,39 @@ class LimitedWalletRequest(BaseRequest):
     allowed_rfc: Optional[Rfc] = None
 
 
+class AccountRequest(BaseRequest):
+    name: StrictStr
+    account_number: Clabe
+    alias: Optional[StrictStr] = None
+    curp: Optional[Curp] = None
+    rfc: Optional[Rfc] = None
+
+    model_config = ConfigDict(
+        json_schema_extra={
+            'example': {
+                'name': 'Aceros del Norte SA de CV',
+                'account_number': '072691004495711499',
+                'alias': 'Proveedor acero',
+            }
+        },
+    )
+
+
+class AccountUpdateRequest(BaseRequest):
+    name: Optional[StrictStr] = None
+    alias: Optional[StrictStr] = None
+    validation_status: Optional[AccountValidationStatus] = None
+
+    model_config = ConfigDict(
+        json_schema_extra={
+            'example': {
+                'alias': 'Fletes',
+                'validation_status': 'verified',
+            }
+        },
+    )
+
+
 class PlatformRequest(BaseModel):
     name: str
     rfc: Optional[str] = None
@@ -891,13 +945,111 @@ class LegalPersonRequest(BaseRequest):
         },
     )
 
+    @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
     address: Optional[AddressRequest] = 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
+    operator_id: str
+    role: OperatorRole
+    company_user_id: str
+
+    model_config = ConfigDict(
+        json_schema_extra={
+            'example': {
+                'session_token': 'SEWqY5cvkISJOxHyEKjAKf8w',
+                'operator_id': 'OPWqY5cvkISJOxHyEKjAKf8w',
+                'role': 'authorizer',
+                'company_user_id': 'USWqY5cvkISJOxHyEKjAKf8w',
+            }
+        },
+    )
+
 
 class PhoneVerificationAssociationRequest(BaseRequest):
     verification_id: str

cuenca_validations/version.py

@@ -1 +1 @@
-__version__ = '2.1.42'
+__version__ = '2.1.41.dev5'