cuenca-validations 2.1.46__tar.gz → 2.1.47__tar.gz

{cuenca_validations-2.1.46 → cuenca_validations-2.1.47}/PKG-INFO

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

{cuenca_validations-2.1.46 → cuenca_validations-2.1.47}/cuenca_validations/types/__init__.py

@@ -82,6 +82,7 @@ __all__ = [
     'Profession',
     'QueryParams',
     'ReferencedClabeRequest',
+    'RejectTransferOrderRequest',
     'LegalRfc',
     'Rfc',
     'QuestionnairesRequest',
@@ -106,6 +107,11 @@ __all__ = [
     'TransactionQuery',
     'TransactionStatus',
     'TransferNetwork',
+    'TransferOrderLineRequest',
+    'TransferOrderLineStatus',
+    'TransferOrderQuery',
+    'TransferOrderRequest',
+    'TransferOrderStatus',
     'TransferQuery',
     'TransferRequest',
     'UpdateTransferRequest',
@@ -184,6 +190,8 @@ from .enums import (
     TrackDataMethod,
     TransactionStatus,
     TransferNetwork,
+    TransferOrderLineStatus,
+    TransferOrderStatus,
     UserCardNotification,
     UserStatus,
     UserType,
@@ -238,6 +246,7 @@ from .queries import (
     StatementQuery,
     TOSQuery,
     TransactionQuery,
+    TransferOrderQuery,
     TransferQuery,
     UserQuery,
     UsersTOSQuery,
@@ -271,11 +280,14 @@ from .requests import (
     PlatformRequest,
     QuestionnairesRequest,
     ReferencedClabeRequest,
+    RejectTransferOrderRequest,
     SavingRequest,
     SavingUpdateRequest,
     SessionRequest,
     StrictTransferRequest,
     TOSRequest,
+    TransferOrderLineRequest,
+    TransferOrderRequest,
     TransferRequest,
     UpdateTransferRequest,
     UserCredentialRequest,

{cuenca_validations-2.1.46 → cuenca_validations-2.1.47}/cuenca_validations/types/enums.py

@@ -761,3 +761,17 @@ class OperatorRole(str, Enum):
 class OperatorStatus(str, Enum):
     active = 'active'
     deactivated = 'deactivated'
+
+
+class TransferOrderStatus(str, Enum):
+    created = 'created'
+    authorizing = 'authorizing'
+    authorized = 'authorized'
+    rejected = 'rejected'
+    expired = 'expired'
+
+
+class TransferOrderLineStatus(str, Enum):
+    pending = 'pending'
+    invalid = 'invalid'
+    submitted = 'submitted'

{cuenca_validations-2.1.46 → cuenca_validations-2.1.47}/cuenca_validations/types/queries.py

@@ -25,6 +25,7 @@ from .enums import (
     SessionType,
     TermsOfService,
     TransferNetwork,
+    TransferOrderStatus,
     UserStatus,
 )
 from .general import NormalizedName
@@ -233,3 +234,7 @@ class TOSQuery(QueryParams):
 
 class UsersTOSQuery(QueryParams):
     type: TermsOfService
+
+
+class TransferOrderQuery(QueryParams):
+    status: Optional[TransferOrderStatus] = None

{cuenca_validations-2.1.46 → cuenca_validations-2.1.47}/cuenca_validations/types/requests.py

@@ -1009,3 +1009,90 @@ class ReferencedClabeRequest(BaseRequest):
 
 class PhoneVerificationAssociationRequest(BaseRequest):
     verification_id: str
+
+
+MAX_TRANSFER_ORDER_BATCH_LINES = 5000
+MAX_TRANSFER_ORDER_EXPIRATION_HOURS = 24 * 7
+
+
+class TransferOrderLineRequest(BaseRequest):
+    account_number: str
+    recipient_name: str
+    amount: int
+    descriptor: str
+
+    model_config = ConfigDict(
+        json_schema_extra={
+            'example': {
+                'account_number': '646180157034181180',
+                'recipient_name': 'Doroteo Arango',
+                'amount': 100_00,
+                'descriptor': 'Mezcal, pulque y tequila',
+            }
+        },
+    )
+
+
+class TransferOrderRequest(BaseRequest):
+    account_number: Optional[str] = None
+    recipient_name: Optional[str] = None
+    amount: Optional[int] = None
+    descriptor: Optional[str] = None
+    idempotency_key: str
+    user_id: Optional[str] = None
+    items: Optional[list[TransferOrderLineRequest]] = None
+    expires_in_hours: Optional[int] = Field(
+        default=None,
+        gt=0,
+        le=MAX_TRANSFER_ORDER_EXPIRATION_HOURS,
+    )
+
+    model_config = ConfigDict(
+        json_schema_extra={
+            'example': {
+                'account_number': '646180157034181180',
+                'recipient_name': 'Doroteo Arango',
+                'amount': 100_00,
+                'descriptor': 'Mezcal, pulque y tequila',
+                'idempotency_key': 'UNIQUE-KEY-003',
+                'user_id': 'USWqY5cvkISJOxHyEKjAKf8w',
+            }
+        },
+    )
+
+    @model_validator(mode='after')
+    def require_unitario_or_batch(self) -> 'TransferOrderRequest':
+        has_items = bool(self.items)
+        has_flat = all(
+            (
+                self.account_number is not None,
+                self.recipient_name is not None,
+                self.amount is not None,
+                self.descriptor is not None,
+            )
+        )
+        if has_items == has_flat:
+            raise ValueError(
+                'Provide either a single transfer (account_number, '
+                'recipient_name, amount, descriptor) or items[] for a batch, '
+                'not both'
+            )
+        if self.items is not None:
+            if len(self.items) > MAX_TRANSFER_ORDER_BATCH_LINES:
+                raise ValueError(
+                    'Batch exceeds maximum of '
+                    f'{MAX_TRANSFER_ORDER_BATCH_LINES} lines'
+                )
+            if len(self.items) == 0:
+                raise ValueError('items must not be empty')
+        return self
+
+
+class RejectTransferOrderRequest(BaseRequest):
+    rejection_reason: str
+
+    model_config = ConfigDict(
+        json_schema_extra={
+            'example': {'rejection_reason': 'Monto incorrecto'},
+        },
+    )

cuenca_validations-2.1.47/cuenca_validations/version.py

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

{cuenca_validations-2.1.46 → cuenca_validations-2.1.47}/cuenca_validations.egg-info/PKG-INFO

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

{cuenca_validations-2.1.46 → cuenca_validations-2.1.47}/tests/test_requests.py

@@ -9,10 +9,12 @@ from cuenca_validations.types.enums import (
 )
 from cuenca_validations.types.queries import OperatorQuery
 from cuenca_validations.types.requests import (
+    MAX_TRANSFER_ORDER_BATCH_LINES,
     OperatorLoginRequest,
     OperatorRequest,
     OperatorUpdateRequest,
     PasswordResetRequest,
+    TransferOrderRequest,
     UpdateTransferRequest,
     UserTOSAgreementRequest,
     UserUpdateRequest,
@@ -218,3 +220,36 @@ def test_update_transfer_request_forbids_extra() -> None:
             {'status': 'succeeded', 'foo': 'bar'}
         )
     assert 'Extra inputs are not permitted' in str(ex.value)
+
+
+def test_transfer_order_request_shape() -> None:
+    line = {
+        'account_number': '646180157034181180',
+        'recipient_name': 'Doroteo Arango',
+        'amount': 100_00,
+        'descriptor': 'Mezcal',
+    }
+    single = TransferOrderRequest.model_validate(
+        {**line, 'idempotency_key': 'single'}
+    )
+    assert single.items is None
+    batch = TransferOrderRequest.model_validate(
+        {'idempotency_key': 'batch', 'items': [line]}
+    )
+    assert batch.items is not None
+
+    with pytest.raises(ValidationError, match='not both'):
+        TransferOrderRequest.model_validate(
+            {**line, 'idempotency_key': 'both', 'items': [line]}
+        )
+    with pytest.raises(ValidationError, match='items must not be empty'):
+        TransferOrderRequest.model_validate(
+            {**line, 'idempotency_key': 'empty', 'items': []}
+        )
+    with pytest.raises(ValidationError, match='Batch exceeds maximum'):
+        TransferOrderRequest.model_validate(
+            {
+                'idempotency_key': 'too-many',
+                'items': [line] * (MAX_TRANSFER_ORDER_BATCH_LINES + 1),
+            }
+        )

cuenca_validations-2.1.46/cuenca_validations/version.py

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