cuenca 1.0.3.dev1__tar.gz → 2.0.0.dev1__tar.gz

{cuenca-1.0.3.dev1 → cuenca-2.0.0.dev1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: cuenca
-Version: 1.0.3.dev1
+Version: 2.0.0.dev1
 Summary: Cuenca API Client
 Home-page: https://github.com/cuenca-mx/cuenca-python
 Author: Cuenca

{cuenca-1.0.3.dev1 → cuenca-2.0.0.dev1}/cuenca/resources/api_keys.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 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:
@@ -36,7 +37,7 @@ class ApiKey(Creatable, Queryable, Retrievable, Updateable):
 
     @classmethod
     def create(cls, *, session: Session = global_session) -> 'ApiKey':
-        return cls._create(session=session)
+        return cast('ApiKey', cls._create(session=session))
 
     @classmethod
     def deactivate(
@@ -55,7 +56,7 @@ class ApiKey(Creatable, Queryable, Retrievable, Updateable):
         """
         url = cls._resource + f'/{api_key_id}'
         resp = session.delete(url, dict(minutes=minutes))
-        return cls(**resp)
+        return cast('ApiKey', cls._from_dict(resp))
 
     @classmethod
     def update(
@@ -74,4 +75,5 @@ 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)
+        resp = cls._update(api_key_id, **req.dict(), session=session)
+        return cast('ApiKey', resp)

{cuenca-1.0.3.dev1 → cuenca-2.0.0.dev1}/cuenca/resources/arpc.py

@@ -1,6 +1,7 @@
 import datetime as dt
-from typing import ClassVar, Optional
+from typing import ClassVar, Optional, cast
 
+from cuenca_validations.types.enums import TrackDataMethod
 from cuenca_validations.types.requests import ARPCRequest
 
 from ..http import Session, session as global_session
@@ -23,8 +24,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(
@@ -50,6 +51,6 @@ class Arpc(Creatable):
             transaction_counter=transaction_counter,
             pan_sequence=pan_sequence,
             unique_number=unique_number,
-            track_data_method=track_data_method,
+            track_data_method=cast(TrackDataMethod, track_data_method),
         )
-        return cls._create(session=session, **req.dict())
+        return cast('Arpc', cls._create(session=session, **req.model_dump()))

{cuenca-1.0.3.dev1 → cuenca-2.0.0.dev1}/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-1.0.3.dev1 → cuenca-2.0.0.dev1}/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, cast
+from typing import Any, ClassVar, Dict, Generator, Optional
 from urllib.parse import urlencode
 
 from cuenca_validations.types import (
@@ -12,35 +12,48 @@ from cuenca_validations.types import (
     TransactionQuery,
     TransactionStatus,
 )
-from pydantic import BaseModel, Extra
+from pydantic import BaseModel
 
 from ..exc import MultipleResultsFound, NoResultFound
 from ..http import Session, session as global_session
 
-R_co = TypeVar('R_co', bound='Resource', covariant=True)
-
 
 class Resource(BaseModel):
     _resource: ClassVar[str]
 
     id: str
 
-    class Config:
-        extra = Extra.ignore
+    @classmethod
+    def _from_dict(cls, obj_dict: Dict[str, Any]) -> 'Resource':
+        cls._filter_excess_fields(obj_dict)
+        return cls(**obj_dict)
+
+    @classmethod
+    def _filter_excess_fields(cls, obj_dict):
+        """
+        dataclasses don't allow __init__ to be called with excess fields. This
+        method allows the API to add fields in the response body without
+        breaking the client
+        """
+        excess = set(obj_dict.keys()) - set(
+            cls.schema().get("properties").keys()
+        )
+        for f in excess:
+            del obj_dict[f]
 
     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
-    ) -> R_co:
+        cls, id: str, *, session: Session = global_session
+    ) -> Resource:
         resp = session.get(f'/{cls._resource}/{id}')
-        return cls(**resp)
+        return cls._from_dict(resp)
 
-    def refresh(self, *, session: Session = global_session) -> None:
+    def refresh(self, *, session: Session = global_session):
         new = self.retrieve(self.id, session=session)
         for attr, value in new.__dict__.items():
             setattr(self, attr, value)
@@ -48,11 +61,9 @@ class Retrievable(Resource):
 
 class Creatable(Resource):
     @classmethod
-    def _create(
-        cls: Type[R_co], *, session: Session = global_session, **data
-    ) -> R_co:
+    def _create(cls, *, session: Session = global_session, **data) -> Resource:
         resp = session.post(cls._resource, data)
-        return cls(**resp)
+        return cls._from_dict(resp)
 
 
 class Updateable(Resource):
@@ -61,31 +72,31 @@ class Updateable(Resource):
 
     @classmethod
     def _update(
-        cls: Type[R_co], id: str, *, session: Session = global_session, **data
-    ) -> R_co:
+        cls, id: str, *, session: Session = global_session, **data
+    ) -> Resource:
         resp = session.patch(f'/{cls._resource}/{id}', data)
-        return cls(**resp)
+        return cls._from_dict(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
-    ) -> R_co:
+        cls, id: str, *, session: Session = global_session, **data
+    ) -> Resource:
         resp = session.delete(f'/{cls._resource}/{id}', data)
-        return cls(**resp)
+        return cls._from_dict(resp)
 
     @property
-    def is_active(self) -> bool:
+    def is_active(self):
         return not self.deactivated_at
 
 
 class Downloadable(Resource):
     @classmethod
     def download(
-        cls: Type[R_co],
+        cls,
         id: str,
         file_format: FileFormat = FileFormat.any,
         *,
@@ -110,13 +121,13 @@ class Downloadable(Resource):
 class Uploadable(Resource):
     @classmethod
     def _upload(
-        cls: Type[R_co],
+        cls,
         file: bytes,
         user_id: str,
         *,
         session: Session = global_session,
         **data,
-    ) -> R_co:
+    ) -> Resource:
         encoded_file = base64.b64encode(file)
         resp = session.request(
             'post',
@@ -127,7 +138,7 @@ class Uploadable(Resource):
                 **{k: (None, v) for k, v in data.items()},
             ),
         )
-        return cls(**json.loads(resp))
+        return cls._from_dict(json.loads(resp))
 
 
 class Queryable(Resource):
@@ -137,9 +148,9 @@ class Queryable(Resource):
 
     @classmethod
     def one(
-        cls: Type[R_co], *, session: Session = global_session, **query_params
-    ) -> R_co:
-        q = cast(Queryable, cls)._query_params(limit=2, **query_params)
+        cls, *, session: Session = global_session, **query_params
+    ) -> Resource:
+        q = cls._query_params(limit=2, **query_params)
         resp = session.get(cls._resource, q.dict())
         items = resp['items']
         len_items = len(items)
@@ -147,40 +158,40 @@ class Queryable(Resource):
             raise NoResultFound
         if len_items > 1:
             raise MultipleResultsFound
-        return cls(**items[0])
+        return cls._from_dict(items[0])
 
     @classmethod
     def first(
-        cls: Type[R_co], *, session: Session = global_session, **query_params
-    ) -> Optional[R_co]:
-        q = cast(Queryable, cls)._query_params(limit=1, **query_params)
+        cls, *, session: Session = global_session, **query_params
+    ) -> Optional[Resource]:
+        q = cls._query_params(limit=1, **query_params)
         resp = session.get(cls._resource, q.dict())
         try:
             item = resp['items'][0]
         except IndexError:
             rv = None
         else:
-            rv = cls(**item)
+            rv = cls._from_dict(item)
         return rv
 
     @classmethod
     def count(
-        cls: Type[R_co], *, session: Session = global_session, **query_params
+        cls, *, session: Session = global_session, **query_params
     ) -> int:
-        q = cast(Queryable, cls)._query_params(count=True, **query_params)
+        q = cls._query_params(count=True, **query_params)
         resp = session.get(cls._resource, q.dict())
         return resp['count']
 
     @classmethod
     def all(
-        cls: Type[R_co], *, session: Session = global_session, **query_params
-    ) -> Generator[R_co, None, None]:
+        cls, *, session: Session = global_session, **query_params
+    ) -> Generator[Resource, None, None]:
         session = session or global_session
-        q = cast(Queryable, cls)._query_params(**query_params)
+        q = cls._query_params(**query_params)
         next_page_uri = f'{cls._resource}?{urlencode(q.dict())}'
         while next_page_uri:
             page = session.get(next_page_uri)
-            yield from (cls(**item) for item in page['items'])
+            yield from (cls._from_dict(item) for item in page['items'])
             next_page_uri = page['next_page_uri']
 
 

{cuenca-1.0.3.dev1 → cuenca-2.0.0.dev1}/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,9 @@ class CardActivation(Creatable):
             exp_year=exp_year,
             cvv2=cvv2,
         )
-        return cls._create(session=session, **req.dict())
+        return cast(
+            'CardActivation', cls._create(session=session, **req.model_dump())
+        )
 
     @property
     def card(self) -> Optional[Card]:

{cuenca-1.0.3.dev1 → cuenca-2.0.0.dev1}/cuenca/resources/card_transactions.py

@@ -24,7 +24,7 @@ class CardTransaction(Transaction):
     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']]:

{cuenca-1.0.3.dev1 → cuenca-2.0.0.dev1}/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
@@ -37,7 +37,7 @@ class CardValidation(Creatable):
         exp_month: Optional[int] = None,
         exp_year: Optional[int] = None,
         pin_block: Optional[str] = None,
-        pin_attempts_exceeded: Optional[str] = None,
+        pin_attempts_exceeded: Optional[bool] = None,
         *,
         session: Session = global_session,
     ) -> 'CardValidation':
@@ -52,7 +52,7 @@ class CardValidation(Creatable):
             pin_attempts_exceeded=pin_attempts_exceeded,
         )
         return cast(
-            'CardValidation', cls._create(session=session, **req.dict())
+            'CardValidation', cls._create(session=session, **req.model_dump())
         )
 
     @property

{cuenca-1.0.3.dev1 → cuenca-2.0.0.dev1}/cuenca/resources/cards.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 (
     CardFundingType,
@@ -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 cast('Card', cls._create(session=session, **req.dict()))
 
     @classmethod
     def update(
@@ -106,7 +106,8 @@ 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())
+        resp = cls._update(card_id, session=session, **req.dict())
+        return cast('Card', resp)
 
     @classmethod
     def deactivate(
@@ -117,4 +118,4 @@ class Card(Retrievable, Queryable, Creatable, Updateable):
         """
         url = f'{cls._resource}/{card_id}'
         resp = session.delete(url)
-        return cls(**resp)
+        return cast('Card', cls._from_dict(resp))

{cuenca-1.0.3.dev1 → cuenca-2.0.0.dev1}/cuenca/resources/clabes.py

@@ -1,4 +1,4 @@
-from typing import ClassVar
+from typing import ClassVar, cast
 
 from ..http import Session, session as global_session
 from .base import Creatable, Queryable, Retrievable
@@ -11,4 +11,4 @@ class Clabe(Creatable, Queryable, Retrievable):
 
     @classmethod
     def create(cls, session: Session = global_session):
-        return cls._create(session=session)
+        return cast('Clabe', cls._create(session=session))

{cuenca-1.0.3.dev1 → cuenca-2.0.0.dev1}/cuenca/resources/curp_validations.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 (
     Country,
@@ -8,6 +8,7 @@ from cuenca_validations.types import (
     State,
 )
 from cuenca_validations.types.identities import CurpField
+from pydantic import ConfigDict, Field
 
 from ..http import Session, session as global_session
 from .base import Creatable, Retrievable
@@ -17,44 +18,43 @@ 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[CurpField] = Field(
+        None, description='curp provided in request'
+    )
+    calculated_curp: CurpField = Field(
+        ..., description='Calculated CURP based on request data'
+    )
+    validated_curp: Optional[CurpField] = 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 +72,8 @@ class CurpValidation(Creatable, Retrievable):
                 'renapo_curp_match': True,
                 'renapo_full_match': True,
             }
-        }
+        },
+    )
 
     @classmethod
     def create(
@@ -94,8 +95,11 @@ class CurpValidation(Creatable, Retrievable):
             second_surname=second_surname,
             date_of_birth=date_of_birth,
             state_of_birth=state_of_birth,
-            country_of_birth=country_of_birth,
+            country_of_birth=cast(Country, country_of_birth),
             gender=gender,
             manual_curp=manual_curp,
         )
-        return cls._create(session=session, **req.dict())
+        return cast(
+            'CurpValidation',
+            cls._create(session=session, **req.model_dump()),
+        )

{cuenca-1.0.3.dev1 → cuenca-2.0.0.dev1}/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-1.0.3.dev1 → cuenca-2.0.0.dev1}/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)