cuenca 1.0.3.dev0__py3-none-any.whl → 2.0.0__py3-none-any.whl

cuenca/__init__.py

@@ -23,6 +23,7 @@ __all__ = [
     'KYCVerification',
     'LimitedWallet',
     'LoginToken',
+    'Otp',
     'Platform',
     'Questionnaires',
     'Saving',
@@ -43,8 +44,6 @@ __all__ = [
     'get_balance',
 ]
 
-from typing import cast
-
 from . import http
 from .resources import (
     Account,
@@ -70,6 +69,7 @@ from .resources import (
     KYCVerification,
     LimitedWallet,
     LoginToken,
+    Otp,
     Platform,
     Questionnaires,
     Saving,
@@ -94,5 +94,5 @@ session = http.session
 
 
 def get_balance(session: http.Session = session) -> int:
-    balance_entry = cast('BalanceEntry', BalanceEntry.first(session=session))
+    balance_entry = BalanceEntry.first(session=session)
     return balance_entry.rolling_balance if balance_entry else 0

cuenca/resources/__init__.py

@@ -22,6 +22,7 @@ __all__ = [
     'KYCVerification',
     'LimitedWallet',
     'LoginToken',
+    'Otp',
     'Platform',
     'Questionnaires',
     'Saving',
@@ -62,6 +63,7 @@ from .kyc_validations import KYCValidation
 from .kyc_verifications import KYCVerification
 from .limited_wallets import LimitedWallet
 from .login_tokens import LoginToken
+from .otps import Otp
 from .platforms import Platform
 from .questionnaires import Questionnaires
 from .resources import RESOURCES

cuenca/resources/api_keys.py

@@ -2,6 +2,7 @@ import datetime as dt
 from typing import ClassVar, Optional
 
 from cuenca_validations.types import ApiKeyQuery, ApiKeyUpdateRequest
+from pydantic import ConfigDict
 
 from ..http import Session, session as global_session
 from .base import Creatable, Queryable, Retrievable, Updateable
@@ -12,11 +13,10 @@ class ApiKey(Creatable, Queryable, Retrievable, Updateable):
     _query_params: ClassVar = ApiKeyQuery
 
     secret: str
-    deactivated_at: Optional[dt.datetime]
-    user_id: Optional[str]
-
-    class Config:
-        schema_extra = {
+    deactivated_at: Optional[dt.datetime] = None
+    user_id: Optional[str] = None
+    model_config = ConfigDict(
+        json_schema_extra={
             'example': {
                 'id': 'AKNEUInh69SuKXXmK95sROwQ',
                 'updated_at': '2021-08-24T14:15:22Z',
@@ -26,6 +26,7 @@ class ApiKey(Creatable, Queryable, Retrievable, Updateable):
                 'user_id': 'USWqY5cvkISJOxHyEKjAKf8w',
             }
         }
+    )
 
     @property
     def active(self) -> bool:
@@ -74,4 +75,4 @@ class ApiKey(Creatable, Queryable, Retrievable, Updateable):
         req = ApiKeyUpdateRequest(
             metadata=metadata, user_id=user_id, platform_id=platform_id
         )
-        return cls._update(api_key_id, **req.dict(), session=session)
+        return cls._update(api_key_id, **req.model_dump(), session=session)

cuenca/resources/arpc.py

@@ -23,8 +23,8 @@ class Arpc(Creatable):
 
     created_at: dt.datetime
     card_uri: str
-    is_valid_arqc: Optional[bool]
-    arpc: Optional[str]
+    is_valid_arqc: Optional[bool] = None
+    arpc: Optional[str] = None
 
     @classmethod
     def create(
@@ -52,4 +52,4 @@ class Arpc(Creatable):
             unique_number=unique_number,
             track_data_method=track_data_method,
         )
-        return cls._create(session=session, **req.dict())
+        return cls._create(session=session, **req.model_dump())

cuenca/resources/balance_entries.py

@@ -1,4 +1,4 @@
-from typing import ClassVar, TypeVar, cast
+from typing import ClassVar, Union, cast
 
 from cuenca_validations.types import BalanceEntryQuery, EntryType
 
@@ -8,9 +8,7 @@ from .cards import Card
 from .resources import retrieve_uri
 from .service_providers import ServiceProvider
 
-FundingInstrument = TypeVar(
-    'FundingInstrument', Account, ServiceProvider, Card
-)
+FundingInstrument = Union[Account, ServiceProvider, Card]
 
 
 class BalanceEntry(Retrievable, Queryable):

cuenca/resources/base.py

@@ -2,7 +2,7 @@ import base64
 import datetime as dt
 import json
 from io import BytesIO
-from typing import ClassVar, Generator, Optional, Type, TypeVar
+from typing import Any, ClassVar, Generator, Optional, Type, TypeVar, cast
 from urllib.parse import urlencode
 
 from cuenca_validations.types import (
@@ -12,13 +12,12 @@ from cuenca_validations.types import (
     TransactionQuery,
     TransactionStatus,
 )
-from pydantic import BaseModel, Extra
+from pydantic import BaseModel, ConfigDict
 
 from ..exc import MultipleResultsFound, NoResultFound
 from ..http import Session, session as global_session
 
 R_co = TypeVar('R_co', bound='Resource', covariant=True)
-Q_co = TypeVar('Q_co', bound='Queryable', covariant=True)
 
 
 class Resource(BaseModel):
@@ -26,17 +25,21 @@ class Resource(BaseModel):
 
     id: str
 
-    class Config:
-        extra = Extra.ignore
+    model_config = ConfigDict(
+        extra="ignore",
+    )
 
     def to_dict(self):
-        return SantizedDict(self.dict())
+        return SantizedDict(self.model_dump())
 
 
 class Retrievable(Resource):
     @classmethod
     def retrieve(
-        cls: Type[R_co], id: str, *, session: Session = global_session
+        cls: Type[R_co],
+        id: str,
+        *,
+        session: Session = global_session,
     ) -> R_co:
         resp = session.get(f'/{cls._resource}/{id}')
         return cls(**resp)
@@ -50,7 +53,10 @@ class Retrievable(Resource):
 class Creatable(Resource):
     @classmethod
     def _create(
-        cls: Type[R_co], *, session: Session = global_session, **data
+        cls: Type[R_co],
+        *,
+        session: Session = global_session,
+        **data: Any,
     ) -> R_co:
         resp = session.post(cls._resource, data)
         return cls(**resp)
@@ -62,18 +68,26 @@ class Updateable(Resource):
 
     @classmethod
     def _update(
-        cls: Type[R_co], id: str, *, session: Session = global_session, **data
+        cls: Type[R_co],
+        id: str,
+        *,
+        session: Session = global_session,
+        **data: Any,
     ) -> R_co:
         resp = session.patch(f'/{cls._resource}/{id}', data)
         return cls(**resp)
 
 
 class Deactivable(Resource):
-    deactivated_at: Optional[dt.datetime]
+    deactivated_at: Optional[dt.datetime] = None
 
     @classmethod
     def deactivate(
-        cls: Type[R_co], id: str, *, session: Session = global_session, **data
+        cls: Type[R_co],
+        id: str,
+        *,
+        session: Session = global_session,
+        **data: Any,
     ) -> R_co:
         resp = session.delete(f'/{cls._resource}/{id}', data)
         return cls(**resp)
@@ -116,7 +130,7 @@ class Uploadable(Resource):
         user_id: str,
         *,
         session: Session = global_session,
-        **data,
+        **data: Any,
     ) -> R_co:
         encoded_file = base64.b64encode(file)
         resp = session.request(
@@ -138,10 +152,13 @@ class Queryable(Resource):
 
     @classmethod
     def one(
-        cls: Type[Q_co], *, session: Session = global_session, **query_params
-    ) -> Q_co:
-        q = cls._query_params(limit=2, **query_params)
-        resp = session.get(cls._resource, q.dict())
+        cls: Type[R_co],
+        *,
+        session: Session = global_session,
+        **query_params: Any,
+    ) -> R_co:
+        q = cast(Queryable, cls)._query_params(limit=2, **query_params)
+        resp = session.get(cls._resource, q.model_dump())
         items = resp['items']
         len_items = len(items)
         if not len_items:
@@ -152,10 +169,13 @@ class Queryable(Resource):
 
     @classmethod
     def first(
-        cls: Type[Q_co], *, session: Session = global_session, **query_params
-    ) -> Optional[Q_co]:
-        q = cls._query_params(limit=1, **query_params)
-        resp = session.get(cls._resource, q.dict())
+        cls: Type[R_co],
+        *,
+        session: Session = global_session,
+        **query_params: Any,
+    ) -> Optional[R_co]:
+        q = cast(Queryable, cls)._query_params(limit=1, **query_params)
+        resp = session.get(cls._resource, q.model_dump())
         try:
             item = resp['items'][0]
         except IndexError:
@@ -166,19 +186,25 @@ class Queryable(Resource):
 
     @classmethod
     def count(
-        cls: Type[Q_co], *, session: Session = global_session, **query_params
+        cls: Type[R_co],
+        *,
+        session: Session = global_session,
+        **query_params: Any,
     ) -> int:
-        q = cls._query_params(count=True, **query_params)
-        resp = session.get(cls._resource, q.dict())
+        q = cast(Queryable, cls)._query_params(count=True, **query_params)
+        resp = session.get(cls._resource, q.model_dump())
         return resp['count']
 
     @classmethod
     def all(
-        cls: Type[Q_co], *, session: Session = global_session, **query_params
-    ) -> Generator[Q_co, None, None]:
+        cls: Type[R_co],
+        *,
+        session: Session = global_session,
+        **query_params: Any,
+    ) -> Generator[R_co, None, None]:
         session = session or global_session
-        q = cls._query_params(**query_params)
-        next_page_uri = f'{cls._resource}?{urlencode(q.dict())}'
+        q = cast(Queryable, cls)._query_params(**query_params)
+        next_page_uri = f'{cls._resource}?{urlencode(q.model_dump())}'
         while next_page_uri:
             page = session.get(next_page_uri)
             yield from (cls(**item) for item in page['items'])

cuenca/resources/card_activations.py

@@ -15,7 +15,7 @@ class CardActivation(Creatable):
     created_at: dt.datetime
     user_id: str
     ip_address: str
-    card_uri: Optional[str]
+    card_uri: Optional[str] = None
     success: bool
 
     @classmethod
@@ -42,7 +42,7 @@ class CardActivation(Creatable):
             exp_year=exp_year,
             cvv2=cvv2,
         )
-        return cls._create(session=session, **req.dict())
+        return cls._create(session=session, **req.model_dump())
 
     @property
     def card(self) -> Optional[Card]:

cuenca/resources/card_transactions.py

@@ -1,4 +1,4 @@
-from typing import ClassVar, List, Optional, cast
+from typing import ClassVar, Optional, cast
 
 from cuenca_validations.types import (
     CardErrorType,
@@ -19,19 +19,19 @@ class CardTransaction(Transaction):
 
     type: CardTransactionType
     network: CardNetwork
-    related_card_transaction_uris: List[str]
+    related_card_transaction_uris: list[str]
     card_uri: str
     card_last4: str
     card_type: CardType
     metadata: dict
-    error_type: Optional[CardErrorType]
+    error_type: Optional[CardErrorType] = None
 
     @property  # type: ignore
-    def related_card_transactions(self) -> Optional[List['CardTransaction']]:
+    def related_card_transactions(self) -> Optional[list['CardTransaction']]:
         if not self.related_card_transaction_uris:
             return []
         return cast(
-            List['CardTransaction'],
+            list['CardTransaction'],
             retrieve_uris(self.related_card_transaction_uris),
         )
 

cuenca/resources/card_validations.py

@@ -18,11 +18,11 @@ class CardValidation(Creatable):
     user_id: str
     card_status: CardStatus
     card_type: CardType
-    is_valid_cvv: Optional[bool]
-    is_valid_cvv2: Optional[bool]
-    is_valid_icvv: Optional[bool]
-    is_valid_pin_block: Optional[bool]
-    is_valid_exp_date: Optional[bool]
+    is_valid_cvv: Optional[bool] = None
+    is_valid_cvv2: Optional[bool] = None
+    is_valid_icvv: Optional[bool] = None
+    is_valid_pin_block: Optional[bool] = None
+    is_valid_exp_date: Optional[bool] = None
     is_pin_attempts_exceeded: bool
     is_expired: bool
     platform_id: Optional[str] = None
@@ -51,9 +51,7 @@ class CardValidation(Creatable):
             pin_block=pin_block,
             pin_attempts_exceeded=pin_attempts_exceeded,
         )
-        return cast(
-            'CardValidation', cls._create(session=session, **req.dict())
-        )
+        return cls._create(session=session, **req.model_dump())
 
     @property
     def card(self) -> Card:

cuenca/resources/cards.py

@@ -21,12 +21,12 @@ class Card(Retrievable, Queryable, Creatable, Updateable):
     _resource: ClassVar = 'cards'
     _query_params: ClassVar = CardQuery
 
-    user_id: Optional[str]
+    user_id: Optional[str] = None
     number: str
     exp_month: int
     exp_year: int
     cvv2: str
-    pin: Optional[str]
+    pin: Optional[str] = None
     type: CardType
     status: CardStatus
     issuer: CardIssuer
@@ -81,7 +81,7 @@ class Card(Retrievable, Queryable, Creatable, Updateable):
             card_holder_user_id=card_holder_user_id,
             is_dynamic_cvv=is_dynamic_cvv,
         )
-        return cls._create(session=session, **req.dict())
+        return cls._create(session=session, **req.model_dump())
 
     @classmethod
     def update(
@@ -106,7 +106,7 @@ class Card(Retrievable, Queryable, Creatable, Updateable):
         req = CardUpdateRequest(
             status=status, pin_block=pin_block, is_dynamic_cvv=is_dynamic_cvv
         )
-        return cls._update(card_id, session=session, **req.dict())
+        return cls._update(card_id, session=session, **req.model_dump())
 
     @classmethod
     def deactivate(

cuenca/resources/curp_validations.py

@@ -7,7 +7,8 @@ from cuenca_validations.types import (
     Gender,
     State,
 )
-from cuenca_validations.types.identities import CurpField
+from cuenca_validations.types.identities import Curp
+from pydantic import ConfigDict, Field
 
 from ..http import Session, session as global_session
 from .base import Creatable, Retrievable
@@ -17,44 +18,42 @@ class CurpValidation(Creatable, Retrievable):
     _resource: ClassVar = 'curp_validations'
 
     created_at: dt.datetime
-    names: Optional[str] = None
-    first_surname: Optional[str] = None
-    second_surname: Optional[str] = None
-    date_of_birth: Optional[dt.date] = None
-    country_of_birth: Optional[Country] = None
-    state_of_birth: Optional[State] = None
-    gender: Optional[Gender] = None
-    nationality: Optional[Country] = None
-    manual_curp: Optional[CurpField] = None
-    calculated_curp: CurpField
-    validated_curp: Optional[CurpField] = None
-    renapo_curp_match: bool
-    renapo_full_match: bool
-
-    class Config:
-        fields = {
-            'names': {'description': 'Official name from Renapo'},
-            'first_surname': {'description': 'Official surname from Renapo'},
-            'second_surname': {'description': 'Official surname from Renapo'},
-            'country_of_birth': {'description': 'In format ISO 3166 Alpha-2'},
-            'state_of_birth': {'description': 'In format ISO 3166 Alpha-2'},
-            'nationality': {'description': 'In format ISO 3166 Alpha-2'},
-            'manual_curp': {'description': 'curp provided in request'},
-            'calculated_curp': {
-                'description': 'Calculated CURP based on request data'
-            },
-            'validated_curp': {
-                'description': 'CURP validated in Renapo, null if not exists'
-            },
-            'renapo_curp_match': {
-                'description': 'True if CURP exists and is valid'
-            },
-            'renapo_full_match': {
-                'description': 'True if all fields provided match the response'
-                ' from RENAPO. Accents in names are ignored'
-            },
-        }
-        schema_extra = {
+    names: Optional[str] = Field(None, description='Official name from Renapo')
+    first_surname: Optional[str] = Field(
+        None, description='Official surname from Renapo'
+    )
+    second_surname: Optional[str] = Field(
+        None, description='Official surname from Renapo'
+    )
+    date_of_birth: Optional[dt.date] = Field(
+        None, description='In format ISO 3166 Alpha-2'
+    )
+    country_of_birth: Optional[Country] = Field(
+        None, description='In format ISO 3166 Alpha-2'
+    )
+    state_of_birth: Optional[State] = Field(None, description='State of birth')
+    gender: Optional[Gender] = Field(None, description='Gender')
+    nationality: Optional[Country] = Field(
+        None, description='In format ISO 3166 Alpha-2'
+    )
+    manual_curp: Optional[Curp] = Field(
+        None, description='curp provided in request'
+    )
+    calculated_curp: Curp = Field(
+        description='Calculated CURP based on request data'
+    )
+    validated_curp: Optional[Curp] = Field(
+        None, description='CURP validated in Renapo, null if not exists'
+    )
+    renapo_curp_match: bool = Field(
+        description='True if CURP exists and is valid'
+    )
+    renapo_full_match: bool = Field(
+        description='True if all fields provided match the response from '
+        'RENAPO. Accents in names are ignored',
+    )
+    model_config = ConfigDict(
+        json_schema_extra={
             'example': {
                 'id': 'CVNEUInh69SuKXXmK95sROwQ',
                 'created_at': '2019-08-24T14:15:22Z',
@@ -72,7 +71,8 @@ class CurpValidation(Creatable, Retrievable):
                 'renapo_curp_match': True,
                 'renapo_full_match': True,
             }
-        }
+        },
+    )
 
     @classmethod
     def create(
@@ -84,7 +84,7 @@ class CurpValidation(Creatable, Retrievable):
         state_of_birth: Optional[State] = None,
         gender: Optional[Gender] = None,
         second_surname: Optional[str] = None,
-        manual_curp: Optional[CurpField] = None,
+        manual_curp: Optional[Curp] = None,
         *,
         session: Session = global_session,
     ) -> 'CurpValidation':
@@ -98,4 +98,4 @@ class CurpValidation(Creatable, Retrievable):
             gender=gender,
             manual_curp=manual_curp,
         )
-        return cls._create(session=session, **req.dict())
+        return cls._create(session=session, **req.model_dump())

cuenca/resources/deposits.py

@@ -13,7 +13,7 @@ class Deposit(Transaction):
 
     network: DepositNetwork
     source_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 source(self) -> Account:

cuenca/resources/endpoints.py

@@ -1,11 +1,11 @@
-from typing import ClassVar, List, Optional
+from typing import ClassVar, Optional
 
 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,21 @@ 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,13 +45,14 @@ class Endpoint(Creatable, Deactivable, Retrievable, Queryable, Updateable):
                 ],
                 'is_enable': True,
             }
-        }
+        },
+    )
 
     @classmethod
     def create(
         cls,
         url: HttpUrl,
-        events: Optional[List[WebhookEvent]] = None,
+        events: Optional[list[WebhookEvent]] = None,
         *,
         session: Session = global_session,
     ) -> 'Endpoint':
@@ -72,14 +66,14 @@ 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 cls._create(session=session, **req.model_dump())
 
     @classmethod
     def update(
         cls,
         endpoint_id: str,
         url: Optional[HttpUrl] = None,
-        events: Optional[List[WebhookEvent]] = None,
+        events: Optional[list[WebhookEvent]] = None,
         is_enable: Optional[bool] = None,
         *,
         session: Session = global_session,
@@ -89,6 +83,7 @@ class Endpoint(Creatable, Deactivable, Retrievable, Queryable, Updateable):
         like url and is_active.
         :param endpoint_id: existing endpoint_id
         :param url
+        :param events: Optional list of enabled events to update
         :param is_enable
         :param session
         :return: Updated endpoint object
@@ -96,4 +91,4 @@ 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())
+        return cls._update(endpoint_id, session=session, **req.model_dump())

cuenca/resources/file_batches.py

@@ -1,6 +1,10 @@
-from typing import ClassVar, Dict, List
+from typing import ClassVar
 
-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
@@ -9,17 +13,20 @@ from .base import Creatable, Queryable
 class FileBatch(Creatable, Queryable):
     _resource: ClassVar = 'file_batches'
 
-    received_files: List[BatchFileMetadata]
-    uploaded_files: List[BatchFileMetadata]
+    received_files: list[BatchFileMetadata]
+    uploaded_files: list[BatchFileMetadata]
     user_id: str
 
     @classmethod
     def create(
         cls,
-        files: List[Dict],
+        files: list[dict],
         user_id: str,
         *,
         session: Session = global_session,
     ) -> 'FileBatch':
-        req = FileBatchUploadRequest(files=files, user_id=user_id)
-        return cls._create(session=session, **req.dict())
+        req = FileBatchUploadRequest(
+            files=[FileRequest(**f) for f in files],
+            user_id=user_id,
+        )
+        return cls._create(session=session, **req.model_dump())