update syntax for Pydantic v2 compatibility

Author: gabino

cuenca/resources/api_keys.py

@@ -2,6 +2,7 @@
 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 Config:
                 'user_id': 'USWqY5cvkISJOxHyEKjAKf8w',
             }
         }
+    )
 
     @property
     def active(self) -> bool:
@@ -74,4 +75,4 @@ def update(
         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

@@ -2,6 +2,7 @@
 from typing import ClassVar, Optional
 
 from cuenca_validations.types.requests import ARPCRequest
+from pydantic_extra_types.payment import PaymentCardNumber
 
 from ..http import Session, session as global_session
 from .base import Creatable
@@ -23,13 +24,13 @@ 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(
         cls,
-        number: str,
+        number: PaymentCardNumber,
         arqc: str,
         arpc_method: str,
         transaction_data: str,
@@ -52,4 +53,4 @@ def create(
             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/base.py

@@ -12,7 +12,7 @@
     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
@@ -25,11 +25,12 @@ 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):
@@ -78,7 +79,7 @@ def _update(
 
 
 class Deactivable(Resource):
-    deactivated_at: Optional[dt.datetime]
+    deactivated_at: Optional[dt.datetime] = None
 
     @classmethod
     def deactivate(
@@ -157,7 +158,7 @@ def one(
         **query_params: Any,
     ) -> R_co:
         q = cast(Queryable, cls)._query_params(limit=2, **query_params)
-        resp = session.get(cls._resource, q.dict())
+        resp = session.get(cls._resource, q.model_dump())
         items = resp['items']
         len_items = len(items)
         if not len_items:
@@ -174,7 +175,7 @@ def first(
         **query_params: Any,
     ) -> Optional[R_co]:
         q = cast(Queryable, cls)._query_params(limit=1, **query_params)
-        resp = session.get(cls._resource, q.dict())
+        resp = session.get(cls._resource, q.model_dump())
         try:
             item = resp['items'][0]
         except IndexError:
@@ -191,7 +192,7 @@ def count(
         **query_params: Any,
     ) -> int:
         q = cast(Queryable, cls)._query_params(count=True, **query_params)
-        resp = session.get(cls._resource, q.dict())
+        resp = session.get(cls._resource, q.model_dump())
         return resp['count']
 
     @classmethod
@@ -203,7 +204,7 @@ def all(
     ) -> Generator[R_co, None, None]:
         session = session or global_session
         q = cast(Queryable, cls)._query_params(**query_params)
-        next_page_uri = f'{cls._resource}?{urlencode(q.dict())}'
+        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

@@ -2,6 +2,7 @@
 from typing import ClassVar, Optional, cast
 
 from cuenca_validations.types.requests import CardActivationRequest
+from pydantic_extra_types.payment import PaymentCardNumber
 
 from ..http import Session, session as global_session
 from .base import Creatable
@@ -15,13 +16,13 @@ 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
     def create(
         cls,
-        number: str,
+        number: PaymentCardNumber,
         exp_month: int,
         exp_year: int,
         cvv2: str,
@@ -42,7 +43,7 @@ def create(
             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

@@ -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/resources/card_validations.py

@@ -3,6 +3,7 @@
 
 from cuenca_validations.types import CardStatus, CardType
 from cuenca_validations.types.requests import CardValidationRequest
+from pydantic_extra_types.payment import PaymentCardNumber
 
 from ..http import Session, session as global_session
 from .base import Creatable
@@ -18,19 +19,19 @@ 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
 
     @classmethod
     def create(
         cls,
-        number: str,
+        number: PaymentCardNumber,
         cvv: Optional[str] = None,
         cvv2: Optional[str] = None,
         icvv: Optional[str] = None,
@@ -51,7 +52,7 @@ def create(
             pin_block=pin_block,
             pin_attempts_exceeded=pin_attempts_exceeded,
         )
-        return cls._create(session=session, **req.dict())
+        return cls._create(session=session, **req.model_dump())
 
     @property
     def card(self) -> Card:

cuenca/resources/cards.py

@@ -9,6 +9,7 @@
 )
 from cuenca_validations.types.queries import CardQuery
 from cuenca_validations.types.requests import CardRequest, CardUpdateRequest
+from pydantic_extra_types.payment import PaymentCardNumber
 
 from cuenca.resources.base import Creatable, Queryable, Retrievable, Updateable
 
@@ -21,12 +22,12 @@ class Card(Retrievable, Queryable, Creatable, Updateable):
     _resource: ClassVar = 'cards'
     _query_params: ClassVar = CardQuery
 
-    user_id: Optional[str]
-    number: str
+    user_id: Optional[str] = None
+    number: PaymentCardNumber
     exp_month: int
     exp_year: int
     cvv2: str
-    pin: Optional[str]
+    pin: Optional[str] = None
     type: CardType
     status: CardStatus
     issuer: CardIssuer
@@ -81,7 +82,7 @@ def create(
             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 +107,7 @@ def update(
         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

@@ -8,6 +8,7 @@
     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,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[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 +71,8 @@ class Config:
                 'renapo_curp_match': True,
                 'renapo_full_match': True,
             }
-        }
+        },
+    )
 
     @classmethod
     def create(
@@ -98,4 +98,4 @@ def create(
             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: