cuenca 1.0.3.dev1__py3-none-any.whl → 2.0.0.dev2__py3-none-any.whl

cuenca/resources/endpoints.py

@@ -1,11 +1,11 @@
-from typing import ClassVar, List, Optional
+from typing import ClassVar, List, Optional, cast
 
 from cuenca_validations.types.enums import WebhookEvent
 from cuenca_validations.types.requests import (
     EndpointRequest,
     EndpointUpdateRequest,
 )
-from pydantic import HttpUrl
+from pydantic import ConfigDict, Field, HttpUrl
 
 from ..http import Session, session as global_session
 from .base import Creatable, Deactivable, Queryable, Retrievable, Updateable
@@ -14,28 +14,24 @@ from .base import Creatable, Deactivable, Queryable, Retrievable, Updateable
 class Endpoint(Creatable, Deactivable, Retrievable, Queryable, Updateable):
     _resource: ClassVar = 'endpoints'
 
-    url: HttpUrl
-    secret: str
-    is_enable: bool
-    events: List[WebhookEvent]
-
-    class Config:
-        fields = {
-            'url': {'description': 'HTTPS url to send webhooks'},
-            'secret': {
-                'description': 'token to verify the webhook is sent by Cuenca '
-                'using HMAC algorithm'
-            },
-            'is_enable': {
-                'description': 'Allows user to turn-off the endpoint '
-                'without the need of deleting it'
-            },
-            'events': {
-                'description': 'list of enabled events. If None, '
-                'all events will be enabled for this Endpoint'
-            },
-        }
-        schema_extra = {
+    url: HttpUrl = Field(..., description='HTTPS url to send webhooks')
+    secret: str = Field(
+        ...,
+        description='token to verify the webhook is sent by Cuenca '
+        'using HMAC algorithm',
+    )
+    is_enable: bool = Field(
+        ...,
+        description='Allows user to turn-off the endpoint without the '
+        'need of deleting it',
+    )
+    events: List[WebhookEvent] = Field(
+        ...,
+        description='list of enabled events. If None, all events will '
+        'be enabled for this Endpoint',
+    )
+    model_config = ConfigDict(
+        json_schema_extra={
             'example': {
                 '_id': 'ENxxne2Z5VSTKZm_w8Hzffcw',
                 'platform_id': 'PTZoPrrPT6Ts-9myamq5h1bA',
@@ -52,7 +48,8 @@ class Endpoint(Creatable, Deactivable, Retrievable, Queryable, Updateable):
                 ],
                 'is_enable': True,
             }
-        }
+        },
+    )
 
     @classmethod
     def create(
@@ -72,7 +69,7 @@ class Endpoint(Creatable, Deactivable, Retrievable, Queryable, Updateable):
         :return: New active endpoint
         """
         req = EndpointRequest(url=url, events=events)
-        return cls._create(session=session, **req.dict())
+        return cast('Endpoint', cls._create(session=session, **req.dict()))
 
     @classmethod
     def update(
@@ -96,4 +93,5 @@ class Endpoint(Creatable, Deactivable, Retrievable, Queryable, Updateable):
         req = EndpointUpdateRequest(
             url=url, is_enable=is_enable, events=events
         )
-        return cls._update(endpoint_id, session=session, **req.dict())
+        resp = cls._update(endpoint_id, session=session, **req.dict())
+        return cast('Endpoint', resp)

cuenca/resources/file_batches.py

@@ -1,6 +1,10 @@
-from typing import ClassVar, Dict, List
+from typing import ClassVar, Dict, List, cast
 
-from cuenca_validations.types import BatchFileMetadata, FileBatchUploadRequest
+from cuenca_validations.types import (
+    BatchFileMetadata,
+    FileBatchUploadRequest,
+    FileRequest,
+)
 
 from ..http import Session, session as global_session
 from .base import Creatable, Queryable
@@ -21,5 +25,9 @@ class FileBatch(Creatable, Queryable):
         *,
         session: Session = global_session,
     ) -> 'FileBatch':
-        req = FileBatchUploadRequest(files=files, user_id=user_id)
-        return cls._create(session=session, **req.dict())
+        req = FileBatchUploadRequest(
+            files=cast(List[FileRequest], files), user_id=user_id
+        )
+        return cast(
+            'FileBatch', cls._create(session=session, **req.model_dump())
+        )

cuenca/resources/files.py

@@ -1,7 +1,12 @@
 from io import BytesIO
-from typing import ClassVar, Optional
+from typing import ClassVar, Optional, cast
 
-from cuenca_validations.types import FileQuery, FileUploadRequest, KYCFileType
+from cuenca_validations.types import (
+    FileExtension,
+    FileQuery,
+    FileUploadRequest,
+    KYCFileType,
+)
 from pydantic import HttpUrl
 
 from ..http import Session, session as global_session
@@ -40,11 +45,17 @@ class File(Downloadable, Queryable, Uploadable):
         req = FileUploadRequest(
             file=file.read(),
             type=file_type,
-            extension=extension,
+            extension=cast(FileExtension, extension),
             is_back=is_back,
             user_id=user_id,
         )
-        return cls._upload(session=session, **req.dict())
+        return cast(
+            'File',
+            cls._upload(
+                session=session,
+                **req.dict(),
+            ),
+        )
 
     @property
     def file(self) -> bytes:

cuenca/resources/identities.py

@@ -23,17 +23,17 @@ class Identity(Retrievable, Queryable):
     created_at: dt.datetime
     names: str
     first_surname: str
-    second_surname: Optional[str]
-    curp: Optional[CurpField]
-    rfc: Optional[str]
+    second_surname: Optional[str] = None
+    curp: Optional[CurpField] = None
+    rfc: Optional[str] = None
     gender: Gender
-    date_of_birth: Optional[dt.date]
-    state_of_birth: Optional[State]
-    country_of_birth: Optional[str]
-    status: Optional[UserStatus]
-    tos_agreement: Optional[TOSAgreement]
-    blacklist_validation_status: Optional[VerificationStatus]
-    address: Optional[Address]
-    govt_id: Optional[KYCFile]
-    proof_of_address: Optional[KYCFile]
-    proof_of_life: Optional[KYCFile]
+    date_of_birth: Optional[dt.date] = None
+    state_of_birth: Optional[State] = None
+    country_of_birth: Optional[str] = None
+    status: Optional[UserStatus] = None
+    tos_agreement: Optional[TOSAgreement] = None
+    blacklist_validation_status: Optional[VerificationStatus] = None
+    address: Optional[Address] = None
+    govt_id: Optional[KYCFile] = None
+    proof_of_address: Optional[KYCFile] = None
+    proof_of_life: Optional[KYCFile] = None

cuenca/resources/kyc_validations.py

@@ -1,6 +1,7 @@
-from typing import ClassVar, List, Optional
+from typing import ClassVar, List, Optional, cast
 
 from cuenca_validations.types import KYCFile, KYCValidationRequest
+from pydantic import ConfigDict
 
 from ..http import Session, session as global_session
 from .base import Creatable, Queryable, Retrievable
@@ -9,12 +10,11 @@ from .base import Creatable, Queryable, Retrievable
 class KYCValidation(Creatable, Retrievable, Queryable):
     _resource: ClassVar = 'kyc_validations'
     platform_id: str
-    attemps: Optional[int]
-    verification_id: Optional[str]
-    files_uri: Optional[List[str]]
-
-    class Config:
-        schema_extra = {
+    attemps: Optional[int] = None
+    verification_id: Optional[str] = None
+    files_uri: Optional[List[str]] = None
+    model_config = ConfigDict(
+        json_schema_extra={
             'example': {
                 'id': 'KVNEUInh69SuKXXmK95sROwQ',
                 'platform_id': 'PT8UEv02zBTcymd4Kd3MO6pg',
@@ -24,6 +24,7 @@ class KYCValidation(Creatable, Retrievable, Queryable):
                 'attemps': '1',
             }
         }
+    )
 
     @classmethod
     def create(
@@ -38,4 +39,6 @@ class KYCValidation(Creatable, Retrievable, Queryable):
             force=force,
             documents=documents,
         )
-        return cls._create(**req.dict(), session=session)
+        return cast(
+            'KYCValidation', cls._create(**req.dict(), session=session)
+        )

cuenca/resources/kyc_verifications.py

@@ -1,5 +1,5 @@
 import datetime as dt
-from typing import ClassVar, Optional
+from typing import ClassVar, Optional, cast
 
 from cuenca_validations.types import (
     Address,
@@ -7,6 +7,7 @@ from cuenca_validations.types import (
     KYCVerificationUpdateRequest,
     Rfc,
 )
+from pydantic import ConfigDict
 
 from ..http import Session, session as global_session
 from .base import Creatable, Retrievable, Updateable
@@ -17,14 +18,13 @@ class KYCVerification(Creatable, Retrievable, Updateable):
 
     platform_id: str
     created_at: dt.datetime
-    deactivated_at: Optional[dt.datetime]
-    verification_id: Optional[str]
+    deactivated_at: Optional[dt.datetime] = None
+    verification_id: Optional[str] = None
     curp: Optional[CurpField] = None
     rfc: Optional[Rfc] = None
     address: Optional[Address] = None
-
-    class Config:
-        schema_extra = {
+    model_config = ConfigDict(
+        json_schema_extra={
             'example': {
                 'id': 'KVNEUInh69SuKXXmK95sROwQ',
                 'updated_at': '2020-05-24T14:15:22Z',
@@ -36,16 +36,17 @@ class KYCVerification(Creatable, Retrievable, Updateable):
                 'address': Address.schema().get('example'),
             }
         }
+    )
 
     @classmethod
     def create(cls, session: Session = global_session) -> 'KYCVerification':
-        return cls._create(session=session)
+        return cast('KYCVerification', cls._create(session=session))
 
     @classmethod
     def update(
         cls,
         kyc_id: str,
-        curp: Optional[CurpField] = None,
+        curp: CurpField,
     ) -> 'KYCVerification':
         req = KYCVerificationUpdateRequest(curp=curp)
-        return cls._update(id=kyc_id, **req.dict())
+        return cast('KYCVerification', cls._update(id=kyc_id, **req.dict()))

cuenca/resources/limited_wallets.py

@@ -1,4 +1,4 @@
-from typing import ClassVar, Optional
+from typing import ClassVar, Optional, cast
 
 from clabe import Clabe
 from cuenca_validations.types import (
@@ -15,13 +15,13 @@ class LimitedWallet(Wallet):
     _resource: ClassVar = 'limited_wallets'
     _query_params: ClassVar = AccountQuery
     account_number: Clabe
-    allowed_rfc: Optional[Rfc]
+    allowed_rfc: Optional[Rfc] = None
     allowed_curp: CurpField
 
     @classmethod
     def create(
         cls,
-        allowed_curp: Optional[CurpField] = None,
+        allowed_curp: CurpField,
         allowed_rfc: Optional[Rfc] = None,
     ) -> 'LimitedWallet':
         """
@@ -37,4 +37,4 @@ class LimitedWallet(Wallet):
             allowed_curp=allowed_curp,
             allowed_rfc=allowed_rfc,
         )
-        return cls._create(**request.dict())
+        return cast('LimitedWallet', cls._create(**request.dict()))

cuenca/resources/login_tokens.py

@@ -1,4 +1,6 @@
-from typing import ClassVar
+from typing import ClassVar, cast
+
+from pydantic import ConfigDict
 
 from ..http import Session, session as global_session
 from .base import Creatable
@@ -6,9 +8,9 @@ from .base import Creatable
 
 class LoginToken(Creatable):
     _resource: ClassVar = 'login_tokens'
-
-    class Config:
-        schema_extra = {'example': {'id': 'LTNEUInh69SuKXXmK95sROwQ'}}
+    model_config = ConfigDict(
+        json_schema_extra={'example': {'id': 'LTNEUInh69SuKXXmK95sROwQ'}}
+    )
 
     @classmethod
     def create(cls, session: Session = global_session) -> 'LoginToken':
@@ -17,4 +19,4 @@ class LoginToken(Creatable):
         Make sure to store this token in a safe place
         :return: Token that you can use in cuenca.configure
         """
-        return cls._create(session=session)
+        return cast('LoginToken', cls._create(session=session))

cuenca/resources/otps.py

@@ -1,5 +1,7 @@
 from typing import ClassVar, cast
 
+from pydantic import ConfigDict
+
 from ..http import Session, session as global_session
 from .base import Creatable
 
@@ -7,14 +9,14 @@ from .base import Creatable
 class Otp(Creatable):
     _resource: ClassVar = 'otps'
     secret: str
-
-    class Config:
-        schema_extra = {
+    model_config = ConfigDict(
+        json_schema_extra={
             'example': {
                 'id': 'OTNEUInh69SuKXXmK95sROwQ',
                 'secret': 'somesecret',
             }
         }
+    )
 
     @classmethod
     def create(cls, session: Session = global_session) -> 'Otp':

cuenca/resources/platforms.py

@@ -1,7 +1,8 @@
 import datetime as dt
-from typing import ClassVar, Optional
+from typing import ClassVar, Optional, cast
 
 from cuenca_validations.types import Country, PlatformRequest, State
+from pydantic import ConfigDict, Field
 
 from ..http import Session, session as global_session
 from .base import Creatable
@@ -11,33 +12,28 @@ class Platform(Creatable):
     _resource: ClassVar = 'platforms'
 
     created_at: dt.datetime
-    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
-    email_address: Optional[str] = None
-    phone_number: Optional[str] = None
-
-    class Config:
-        fields = {
-            'name': {'description': 'name of the platform being created'},
-            'rfc': {'description': 'RFC or CURP of the platform'},
-            'establishment_date': {
-                'description': 'when the platform was established'
-            },
-            'country': {'description': 'country where the platform resides'},
-            'state': {'description': 'state where the platform resides'},
-            'economic_activity': {'description': 'what the platform does'},
-            'phone_number': {
-                'description': 'phone number to contact the platform'
-            },
-            'email_address': {
-                'description': 'email address to contact the platform'
-            },
-        }
-        schema_extra = {
+    name: str = Field(..., description='name of the platform being created')
+    rfc: Optional[str] = Field(None, description='RFC or CURP of the platform')
+    establishment_date: Optional[dt.date] = Field(
+        None, description='when the platform was established'
+    )
+    country: Optional[Country] = Field(
+        None, description='country where the platform resides'
+    )
+    state: Optional[State] = Field(
+        None, description='state where the platform resides'
+    )
+    economic_activity: Optional[str] = Field(
+        None, description='what the platform does'
+    )
+    email_address: Optional[str] = Field(
+        None, description='email address to contact the platform'
+    )
+    phone_number: Optional[str] = Field(
+        None, description='phone number to contact the platform'
+    )
+    model_config = ConfigDict(
+        json_schema_extra={
             'example': {
                 'id': 'PT0123456789',
                 'name': 'Arteria',
@@ -50,14 +46,15 @@ class Platform(Creatable):
                 'phone_number': '+525555555555',
                 'email_address': 'art@eria.com',
             }
-        }
+        },
+    )
 
     @classmethod
     def create(
         cls,
         name: str,
         rfc: Optional[str] = None,
-        establishment_date: Optional[str] = None,
+        establishment_date: Optional[dt.date] = None,
         country: Optional[Country] = None,
         state: Optional[State] = None,
         economic_activity: Optional[str] = None,
@@ -76,4 +73,6 @@ class Platform(Creatable):
             phone_number=phone_number,
             email_address=email_address,
         )
-        return cls._create(session=session, **req.dict())
+        return cast(
+            'Platform', cls._create(session=session, **req.model_dump())
+        )

cuenca/resources/questionnaires.py

@@ -1,7 +1,8 @@
 import datetime as dt
-from typing import ClassVar
+from typing import ClassVar, cast
 
 from cuenca_validations.types import QuestionnairesRequest
+from pydantic import ConfigDict
 
 from ..http import Session, session as global_session
 from .base import Creatable, Retrievable
@@ -14,15 +15,15 @@ class Questionnaires(Creatable, Retrievable):
     token: str
     form_id: str
     user_id: str
-
-    class Config:
-        schema_extra = {
+    model_config = ConfigDict(
+        json_schema_extra={
             'example': {
                 'user_id': 'US234i23jh23h4h23',
                 'token': '3223j23ij23ij3',
                 'alert_id': 'ALewifjwiejf',
             }
         }
+    )
 
     @classmethod
     def create(
@@ -38,4 +39,6 @@ class Questionnaires(Creatable, Retrievable):
             token=token,
             form_id=form_id,
         )
-        return cls._create(session=session, **req.dict())
+        return cast(
+            'Questionnaires', cls._create(session=session, **req.model_dump())
+        )

cuenca/resources/resources.py

@@ -1,6 +1,6 @@
 import re
 from concurrent.futures import ThreadPoolExecutor
-from typing import Dict, List
+from typing import Dict, List, cast
 
 from .base import Retrievable
 
@@ -13,7 +13,7 @@ def retrieve_uri(uri: str) -> Retrievable:
     if not m:
         raise ValueError(f'uri is not a valid format: {uri}')
     resource, id_ = m.groups()
-    return RESOURCES[resource].retrieve(id_)
+    return cast(Retrievable, RESOURCES[resource].retrieve(id_))
 
 
 def retrieve_uris(uris: List[str]) -> List[Retrievable]:

cuenca/resources/savings.py

@@ -1,5 +1,5 @@
 import datetime as dt
-from typing import ClassVar, Optional
+from typing import ClassVar, Optional, cast
 
 from cuenca_validations.types import (
     SavingCategory,
@@ -17,8 +17,8 @@ class Saving(Wallet, Updateable):
     _query_params: ClassVar = WalletQuery
     name: str
     category: SavingCategory
-    goal_amount: Optional[StrictPositiveInt]
-    goal_date: Optional[dt.datetime]
+    goal_amount: Optional[StrictPositiveInt] = None
+    goal_date: Optional[dt.datetime] = None
 
     @classmethod
     def create(
@@ -34,7 +34,7 @@ class Saving(Wallet, Updateable):
             goal_amount=goal_amount,
             goal_date=goal_date,
         )
-        return cls._create(**request.dict())
+        return cast('Saving', cls._create(**request.dict()))
 
     @classmethod
     def update(
@@ -51,4 +51,4 @@ class Saving(Wallet, Updateable):
             goal_amount=goal_amount,
             goal_date=goal_date,
         )
-        return cls._update(id=saving_id, **request.dict())
+        return cast('Saving', cls._update(id=saving_id, **request.dict()))

cuenca/resources/sessions.py

@@ -1,8 +1,8 @@
 import datetime as dt
-from typing import ClassVar, Optional
+from typing import ClassVar, Optional, cast
 
 from cuenca_validations.types import SessionRequest, SessionType
-from pydantic import AnyUrl
+from pydantic import AnyUrl, ConfigDict
 
 from .. import http
 from .base import Creatable, Queryable, Retrievable
@@ -16,12 +16,11 @@ class Session(Creatable, Retrievable, Queryable):
     user_id: str
     platform_id: str
     expires_at: dt.datetime
-    success_url: Optional[AnyUrl]
-    failure_url: Optional[AnyUrl]
-    type: Optional[SessionType]
-
-    class Config:
-        schema_extra = {
+    success_url: Optional[AnyUrl] = None
+    failure_url: Optional[AnyUrl] = None
+    type: Optional[SessionType] = None
+    model_config = ConfigDict(
+        json_schema_extra={
             'example': {
                 'id': 'SENEUInh69SuKXXmK95sROwQ',
                 'created_at': '2022-08-24T14:15:22Z',
@@ -33,14 +32,15 @@ class Session(Creatable, Retrievable, Queryable):
                 'type': 'session.registration',
             }
         }
+    )
 
     @classmethod
     def create(
         cls,
         user_id: str,
         type: SessionType,
-        success_url: Optional[str] = None,
-        failure_url: Optional[str] = None,
+        success_url=cast(Optional[AnyUrl], success_url),
+        failure_url=cast(Optional[AnyUrl], failure_url),
         *,
         session: http.Session = http.session,
     ) -> 'Session':
@@ -50,4 +50,4 @@ class Session(Creatable, Retrievable, Queryable):
             success_url=success_url,
             failure_url=failure_url,
         )
-        return cls._create(session=session, **req.dict())
+        return cast('Session', cls._create(session=session, **req.dict()))

cuenca/resources/transfers.py

@@ -1,6 +1,7 @@
 import datetime as dt
 from typing import ClassVar, List, Optional, cast
 
+from clabe import Clabe
 from cuenca_validations.types import (
     TransferNetwork,
     TransferQuery,
@@ -25,7 +26,7 @@ class Transfer(Transaction, Creatable):
     idempotency_key: str
     network: TransferNetwork
     destination_uri: str
-    tracking_key: Optional[str]  # clave rastreo if network is SPEI
+    tracking_key: Optional[str] = None  # clave rastreo if network is SPEI
 
     @property  # type: ignore
     def destination(self) -> Account:
@@ -62,14 +63,14 @@ class Transfer(Transaction, Creatable):
         if not idempotency_key:
             idempotency_key = cls._gen_idempotency_key(account_number, amount)
         req = TransferRequest(
-            account_number=account_number,
+            account_number=cast(Clabe, account_number),
             amount=amount,
             descriptor=descriptor,
             recipient_name=recipient_name,
             idempotency_key=idempotency_key,
             user_id=user_id,
         )
-        return cls._create(**req.dict())
+        return cast('Transfer', cls._create(**req.dict()))
 
     @classmethod
     def create_many(cls, requests: List[TransferRequest]) -> DictStrAny:
@@ -90,4 +91,4 @@ class Transfer(Transaction, Creatable):
         idempotency_key, but this provides some level of protection against
         submitting duplicate transfers
         """
-        return f'{dt.datetime.utcnow().date()}:{account_number}:{amount}'
+        return f'{dt.datetime.utcnow().date()}: {account_number}: {amount}'

cuenca/resources/user_credentials.py

@@ -1,5 +1,5 @@
 import datetime as dt
-from typing import ClassVar, Optional
+from typing import ClassVar, Optional, cast
 
 from cuenca_validations.types.requests import (
     UserCredentialRequest,
@@ -25,7 +25,9 @@ class UserCredential(Creatable, Updateable):
         session: Session = global_session,
     ) -> 'UserCredential':
         req = UserCredentialRequest(password=password, user_id=user_id)
-        return cls._create(**req.dict(), session=session)
+        return cast(
+            'UserCredential', cls._create(**req.dict(), session=session)
+        )
 
     @classmethod
     def update(
@@ -40,4 +42,7 @@ class UserCredential(Creatable, Updateable):
             is_active=is_active,
             password=password,
         )
-        return cls._update(id=user_id, **req.dict(), session=session)
+        return cast(
+            'UserCredential',
+            cls._update(id=user_id, **req.dict(), session=session),
+        )