-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathrequests.py
More file actions
773 lines (647 loc) · 22.1 KB
/
Copy pathrequests.py
File metadata and controls
773 lines (647 loc) · 22.1 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
import datetime as dt
from typing import Annotated, Any, Optional, Union
from clabe import Clabe
from pydantic import (
BaseModel,
ConfigDict,
EmailStr,
Field,
GetCoreSchemaHandler,
StrictStr,
StringConstraints,
field_validator,
model_validator,
)
from pydantic_core import core_schema
from pydantic_extra_types.coordinate import Coordinate
from ..types.enums import (
AccountUseType,
AuthorizerTransaction,
CardDesign,
CardFundingType,
CardholderVerificationMethod,
CardIssuer,
CardPackaging,
CardStatus,
CardType,
Country,
EcommerceIndicator,
FileExtension,
Gender,
IncomeType,
IssuerNetwork,
KYCFileType,
KYCValidationSource,
MonthlyMovementsType,
MonthlySpendingType,
PlatformType,
PosCapability,
Profession,
SATRegimeCode,
SavingCategory,
SessionType,
State,
TermsOfService,
TrackDataMethod,
TransactionTokenValidationStatus,
UserCardNotification,
UserStatus,
VerificationType,
WalletTransactionType,
WebhookEvent,
WebhookEventType,
WebhookObject,
)
from ..typing import DictStrAny
from .card import (
Cvv,
ExpMonth,
ExpYear,
PaymentCardNumber,
StrictPaymentCardNumber,
)
from .general import (
LogConfig,
NonEmptyStr,
SerializableAnyUrl,
SerializableHttpUrl,
SerializableIPvAnyAddress,
StrictPositiveInt,
)
from .helpers import validate_age_requirement
from .identities import (
AddressRequest,
Beneficiary,
Curp,
KYCFile,
Password,
PhoneNumber,
Rfc,
)
from .morals import (
AuditDetails,
BusinessDetails,
LegalRepresentative,
LicenseDetails,
Shareholder,
TransactionalProfile,
VulnerableActivityDetails,
)
CUENCA_FILE_URL = (
r'^https:\/\/(?:stage|sandbox|api)\.cuenca\.com\/files\/([a-zA-Z0-9\-_]+)$'
)
class BaseRequest(BaseModel):
model_config = ConfigDict(extra="forbid")
def model_dump(self, *args, **kwargs) -> DictStrAny:
kwargs.setdefault('exclude_none', True)
kwargs.setdefault('exclude_unset', True)
return super().model_dump(*args, **kwargs)
class BaseTransferRequest(BaseRequest):
recipient_name: StrictStr
amount: StrictPositiveInt = Field(
description='Always in cents, not in MXN pesos'
)
descriptor: StrictStr = Field(
description='Short description for the recipient'
)
idempotency_key: str = Field(
description='Custom Id, must be unique for each transfer'
)
user_id: Optional[str] = Field(
None, description='Source user to take the funds'
)
model_config = ConfigDict(
json_schema_extra={
'example': {
'recipient_name': 'Doroteo Arango',
'account_number': '646180157034181180',
'amount': 100_00, # 100.00 MXN Pesos
'descriptor': 'Mezcal, pulque y tequila',
'idempotency_key': 'UNIQUE-KEY-003',
'user_id': 'USWqY5cvkISJOxHyEKjAKf8w',
}
},
)
class TransferRequest(BaseTransferRequest):
account_number: Union[Clabe, PaymentCardNumber] = Field(
description='Destination Clabe or Card number'
)
class StrictTransferRequest(BaseTransferRequest):
account_number: Union[Clabe, StrictPaymentCardNumber] = Field(
description='Destination Clabe or Card number'
)
class CardUpdateRequest(BaseRequest):
status: Optional[CardStatus] = None
pin_block: Optional[str] = None
is_dynamic_cvv: Optional[bool] = None
class CardRequest(BaseRequest):
user_id: str = 'me'
issuer: CardIssuer
funding_type: CardFundingType
is_dynamic_cvv: Optional[bool] = None
card_holder_user_id: Optional[str] = None
class CardActivationRequest(BaseModel):
number: PaymentCardNumber
exp_month: ExpMonth
exp_year: ExpYear
cvv2: Cvv
class ApiKeyUpdateRequest(BaseRequest):
user_id: Optional[str] = None
platform_id: Optional[str] = None
metadata: Optional[DictStrAny] = None
class UserCredentialUpdateRequest(BaseRequest):
is_active: Optional[bool] = None
password: Optional[Password] = None
def model_dump(self, *args, **kwargs) -> DictStrAny:
# Password can be None but BaseRequest excludes None
return BaseModel.model_dump(self, *args, **kwargs)
@model_validator(mode="before")
@classmethod
def check_one_property_at_a_time(cls, values: DictStrAny) -> DictStrAny:
not_none_count = sum(1 for val in values.values() if val)
if not_none_count > 1:
raise ValueError('Only one property can be updated at a time')
return values
class UserCredentialRequest(BaseRequest):
password: Password
user_id: Optional[str] = None
class CardValidationRequest(BaseModel):
number: PaymentCardNumber
exp_month: Optional[ExpMonth] = None
exp_year: Optional[ExpYear] = None
cvv: Optional[Cvv] = None
cvv2: Optional[Cvv] = None
icvv: Optional[Cvv] = None
pin_block: Optional[
Annotated[str, StringConstraints(strip_whitespace=True)]
] = None
pin_attempts_exceeded: Optional[bool] = None
class ARPCRequest(BaseModel):
number: PaymentCardNumber
arqc: StrictStr
arpc_method: Annotated[
str,
StringConstraints(strict=True, min_length=1, max_length=1),
]
transaction_data: StrictStr
response_code: StrictStr
transaction_counter: StrictStr
pan_sequence: StrictStr
unique_number: StrictStr
track_data_method: TrackDataMethod
class CardBatchRequest(BaseRequest):
card_design: CardDesign
card_packaging: CardPackaging
number_of_cards: Annotated[int, Field(strict=True, ge=1, le=999999)]
class CardTransactionRequest(BaseModel):
card_id: str
user_id: str
# In some card_validations amount is equal to 0
amount: Annotated[int, Field(strict=True, ge=0)]
merchant_name: str
merchant_type: str
merchant_data: str
currency_code: str
prosa_transaction_id: str
retrieval_reference: str
card_type: CardType
card_status: CardStatus
transaction_type: AuthorizerTransaction
authorizer_number: Optional[str] = None
class ReverseRequest(CardTransactionRequest): ... # noqa: E701
class CardNotificationRequest(CardTransactionRequest):
track_data_method: TrackDataMethod
pos_capability: PosCapability
logical_network: Optional[str] = None
class ChargeRequest(CardNotificationRequest):
is_cvv: Optional[bool] = False
get_balance: Optional[bool] = False
atm_fee: Optional[StrictPositiveInt] = None
issuer: IssuerNetwork
cardholder_verification_method: Optional[CardholderVerificationMethod] = (
None
)
ecommerce_indicator: Optional[EcommerceIndicator] = None
fraud_validation_id: Optional[str] = None
class UserCardNotificationRequest(CardTransactionRequest):
type: UserCardNotification
class SavingBaseRequest(BaseRequest):
goal_amount: Optional[StrictPositiveInt] = None
goal_date: Optional[dt.datetime] = None
@field_validator('goal_date')
@classmethod
def validate_goal_date(
cls, v: Optional[dt.datetime]
) -> Optional[dt.datetime]:
if v and v <= dt.datetime.utcnow():
raise ValueError('The goal_date always need to be higher than now')
return v
class SavingRequest(SavingBaseRequest):
name: str
category: SavingCategory
class SavingUpdateRequest(SavingBaseRequest):
name: Optional[str] = None
category: Optional[SavingCategory] = None
class WalletTransactionRequest(BaseRequest):
wallet_uri: str
transaction_type: WalletTransactionType
amount: StrictPositiveInt
class FraudValidationRequest(BaseModel):
amount: StrictPositiveInt
merchant_name: str
merchant_type: str
merchant_data: str
currency_code: str
transaction_type: AuthorizerTransaction
track_data_method: TrackDataMethod
pos_capability: PosCapability
logical_network: Optional[str] = None
is_cvv: Optional[bool] = False
issuer: IssuerNetwork
cardholder_verification_method: Optional[CardholderVerificationMethod] = (
None
)
ecommerce_indicator: Optional[EcommerceIndicator] = None
card_id: Optional[str] = None
user_id: Optional[str] = None
card_type: Optional[CardType] = None
card_status: Optional[CardStatus] = None
class TransactionTokenValidationUpdateRequest(BaseRequest):
status: TransactionTokenValidationStatus
class UserPldRiskLevelRequest(BaseModel):
user_id: str
level: float = Field(ge=0.0, le=1.0)
class CurpValidationRequest(BaseModel):
names: Optional[str] = None
first_surname: Optional[str] = None
second_surname: Optional[str] = Field(
default=None, description='Not necessary for foreigners'
)
date_of_birth: Optional[dt.date] = None
state_of_birth: Optional[State] = Field(
default=None, description='In format ISO 3166 Alpha-2'
)
country_of_birth: Optional[Country] = Field(
default=None, description='In format ISO 3166 Alpha-2'
)
gender: Optional[Gender] = None
manual_curp: Optional[Curp] = Field(
None,
description='Force to validate this curp instead of use '
'the one we calculate',
)
model_config = ConfigDict(
str_strip_whitespace=True,
json_schema_extra={
'example': {
'names': 'Guillermo',
'first_surname': 'Gonzales',
'second_surname': 'Camarena',
'date_of_birth': '1965-04-18',
'state_of_birth': 'VZ',
'country_of_birth': 'MX',
'gender': 'male',
}
},
)
@field_validator('second_surname')
@classmethod
def validate_surname(cls, value: Optional[str]) -> Optional[str]:
return value if value else None # Empty strings as None
@field_validator('date_of_birth')
@classmethod
def validate_birth_date(
cls, date_of_birth: Optional[dt.date]
) -> Optional[dt.date]:
try:
validate_age_requirement(date_of_birth) if date_of_birth else None
except ValueError:
raise
return date_of_birth
@field_validator('manual_curp')
@classmethod
def validate_manual_curp_birth_date(
cls, manual_curp: Optional[Curp]
) -> Optional[Curp]:
if manual_curp:
validate_age_requirement(manual_curp)
return manual_curp
@model_validator(mode="before")
@classmethod
def validate_state_of_birth(cls, values: DictStrAny) -> DictStrAny:
if (
'country_of_birth' in values
and values['country_of_birth'] == 'MX'
and 'state_of_birth' not in values
):
raise ValueError('state_of_birth required')
return values
@model_validator(mode="before")
@classmethod
def validate_manual_curp(cls, values: DictStrAny) -> DictStrAny:
manual_curp = values.get('manual_curp')
required = [
'names',
'first_surname',
'date_of_birth',
'country_of_birth',
'gender',
]
missing = [r for r in required if r not in values.keys()]
if not manual_curp and missing:
raise ValueError(f'values required: {",".join(missing)}')
return values
class TOSRequest(BaseModel):
type: TermsOfService
version: str
location: Optional[str] = None
ip: Optional[SerializableIPvAnyAddress] = None
class FileCuencaUrl(str):
@property
def file_id(self) -> str:
return self.split('/')[-1]
@classmethod
def __get_pydantic_core_schema__(
cls, _source_type: Any, _handler: GetCoreSchemaHandler
) -> core_schema.CoreSchema:
return core_schema.no_info_after_validator_function(
cls, core_schema.str_schema(pattern=CUENCA_FILE_URL)
)
class UserTOSAgreementRequest(BaseModel):
tos_id: str
location: Coordinate
signature_image_url: Optional[FileCuencaUrl] = None
class UserRequest(BaseModel):
curp: Curp = Field(
description=(
'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'
)
phone_verification_id: str = Field(
...,
description='ID of previously validated phone verification',
)
email_verification_id: str = Field(
...,
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_verification_id': 'VEKp662Yrf6lMztl0-9qzk7Q',
'email_verification_id': 'VEwjDEcCMWZIk3JJ3p7P6T_A',
'profession': 'engineer',
'address': AddressRequest.model_json_schema().get('example'),
}
},
)
@field_validator('curp')
@classmethod
def validate_birth_date(cls, curp: Optional[Curp]) -> Optional[Curp]:
if curp:
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
email_verification_id: Optional[str] = None
phone_verification_id: Optional[str] = None
address: Optional[AddressRequest] = None
beneficiaries: Optional[list[Beneficiary]] = None
govt_id: Optional[KYCFile] = None
proof_of_address: Optional[KYCFile] = None
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
def beneficiary_percentage(
cls, beneficiaries: Optional[list[Beneficiary]] = 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[
str, LogConfig(masked=True)
] # Set password field to str for backward compatibility.
user_id: Optional[str] = Field(None, description='Deprecated field')
model_config = ConfigDict(
json_schema_extra={'example': {'password': 'supersecret'}},
)
class SessionRequest(BaseRequest):
user_id: str
type: SessionType
success_url: Optional[SerializableAnyUrl] = None
failure_url: Optional[SerializableAnyUrl] = None
resource_id: Optional[str] = None
@model_validator(mode='before')
@classmethod
def validate_metadata(cls, values: dict) -> dict:
type, resource_id = values['type'], values.get('resource_id')
if type == SessionType.onboarding_verification and not resource_id:
raise ValueError('Resource id expected for this session')
return values
model_config = ConfigDict(
json_schema_extra={
'example': {
'user_id': 'USWqY5cvkISJOxHyEKjAKf8w',
'type': 'session.registration',
'success_url': 'http://example_success.com',
'failure_url': 'http://example_failure.com',
'resource_id': 'some_resource_id',
}
}
)
class EndpointRequest(BaseRequest):
url: SerializableHttpUrl
events: Optional[list[WebhookEvent]] = None
user_id: Optional[str] = None
class EndpointUpdateRequest(BaseRequest):
url: Optional[SerializableHttpUrl] = None
is_enable: Optional[bool] = None
events: Optional[list[WebhookEvent]] = None
class FileUploadRequest(BaseRequest):
is_back: Optional[bool] = False
file: Union[bytes, str]
extension: Optional[FileExtension] = None
type: KYCFileType
user_id: str
class FileRequest(BaseModel):
is_back: Optional[bool] = False
url: SerializableHttpUrl
type: KYCFileType
class FileBatchUploadRequest(BaseModel):
files: list[FileRequest]
user_id: str
class VerificationRequest(BaseModel):
type: VerificationType
recipient: Union[EmailStr, PhoneNumber] = Field(
description='Phone or email to validate'
)
model_config = ConfigDict(
str_strip_whitespace=True,
json_schema_extra={
'example': {
'type': 'email',
'recipient': 'user@example.com',
}
},
)
@field_validator('recipient')
def validate_sender(cls, recipient: str, values):
return (
EmailStr(recipient)
if type == VerificationType.email
else PhoneNumber(recipient)
)
class VerificationAttemptRequest(BaseModel):
code: Annotated[
str,
StringConstraints(strict=True, min_length=6, max_length=6),
Field(description="Code sent to user via email or phone"),
]
model_config = ConfigDict(
json_schema_extra={'example': {'code': '123456'}},
)
class LimitedWalletRequest(BaseRequest):
allowed_curp: Curp
allowed_rfc: Optional[Rfc] = None
class PlatformRequest(BaseModel):
name: str
rfc: Optional[str] = None
establishment_date: Optional[dt.date] = None
country: Optional[Country] = None
state: Optional[State] = None
economic_activity: Optional[str] = None
phone_number: Optional[str] = None
email_address: Optional[str] = None
type: PlatformType = PlatformType.connect
class WebhookRequest(BaseModel):
id: str
event: WebhookEventType
object_type: WebhookObject
data: DictStrAny
class KYCValidationRequest(BaseRequest):
user_id: str
source_type: KYCValidationSource
force: bool = False
class BankAccountValidationRequest(BaseModel):
account_number: Union[Clabe, PaymentCardNumber]
class UserListsRequest(BaseModel):
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(
None, description='Account to review on lists'
)
names: Optional[NonEmptyStr] = Field(
None, description='Names of the user to review on lists'
)
first_surname: Optional[NonEmptyStr] = Field(
None, description='First surname of the user to review on lists'
)
second_surname: Optional[NonEmptyStr] = Field(
None, description='Second surname of the user to review on lists'
)
@model_validator(mode='before')
@classmethod
def check_request(cls, values):
if (
values.get('first_surname') or values.get('second_surname')
) and not values.get('names'):
raise ValueError(
'names is required when first_surname or second_surname '
'is provided'
)
if values.get('names') and not values.get('first_surname'):
raise ValueError(
'first_surname is required when names is provided'
)
has_name = all(values.get(f) for f in ['names', 'first_surname'])
curp, account, rfc = (
values.get('curp'),
values.get('account_number'),
values.get('rfc'),
)
if not any([curp, account, rfc, has_name]):
raise ValueError("At least 1 param is required")
return values
model_config = ConfigDict(
str_strip_whitespace=True,
json_schema_extra={
'example': {
'curp': 'GOCG650418HVZNML08',
'rfc': 'GOCG650418TJ1',
'account_number': '9203929392939292392',
'names': 'Pedrito',
'first_surname': 'Sola',
'second_surname': 'Sola',
}
},
)
class QuestionnairesRequest(BaseModel):
user_id: str
token: str
form_id: str
class PartnerRequest(BaseRequest):
legal_name: str
business_name: str
nationality: Country
incorporation_date: dt.date
folio: str
rfc: Rfc
documentation_url: str
web_site: str
phone_number: PhoneNumber
email_address: EmailStr
address: AddressRequest
class PartnerUpdateRequest(BaseRequest):
legal_name: Optional[str] = None
business_name: Optional[str] = None
nationality: Optional[Country] = None
incorporation_date: Optional[dt.date] = None
folio: Optional[str] = None
rfc: Optional[Rfc] = None
documentation_url: Optional[str] = None
web_site: Optional[str] = None
phone_number: Optional[PhoneNumber] = None
email_address: Optional[EmailStr] = None
address: Optional[AddressRequest] = None
business_details: Optional[BusinessDetails] = None
transactional_profile: Optional[TransactionalProfile] = None
external_account: Optional[Clabe] = None
license: Optional[LicenseDetails] = None
audit: Optional[AuditDetails] = None
vulnerable_activity: Optional[VulnerableActivityDetails] = None
legal_representatives: Optional[list[LegalRepresentative]] = None
shareholders: Optional[list[Shareholder]] = None
class PhoneVerificationAssociationRequest(BaseModel):
verification_id: str