Update cuenca-validations type annotations from Metadata to LogConfig

cuenca-mx · Jan 29, 2025 · d351e50 · d351e50
1 parent b286db3
commit d351e50
Show file tree

Hide file tree

Showing 6 changed files with 16 additions and 12 deletions.
diff --git a/cuenca/resources/api_keys.py b/cuenca/resources/api_keys.py
@@ -1,7 +1,11 @@
 import datetime as dt
 from typing import Annotated, ClassVar, Optional
 
-from cuenca_validations.types import ApiKeyQuery, ApiKeyUpdateRequest, Metadata
+from cuenca_validations.types import (
+    ApiKeyQuery,
+    ApiKeyUpdateRequest,
+    LogConfig,
+)
 from pydantic import ConfigDict
 
 from ..http import Session, session as global_session
@@ -12,7 +16,7 @@ class ApiKey(Creatable, Queryable, Retrievable, Updateable):
     _resource: ClassVar = 'api_keys'
     _query_params: ClassVar = ApiKeyQuery
 
-    secret: Annotated[str, Metadata(sensitive=True, log_chars=4)]
+    secret: Annotated[str, LogConfig(masked=True, unmasked_chars_length=4)]
     deactivated_at: Optional[dt.datetime] = None
     user_id: Optional[str] = None
     model_config = ConfigDict(

diff --git a/cuenca/resources/jwt_tokens.py b/cuenca/resources/jwt_tokens.py
@@ -1,7 +1,7 @@
 import datetime as dt
 from typing import Annotated, ClassVar
 
-from cuenca_validations.types import Metadata
+from cuenca_validations.types import LogConfig
 from pydantic import ConfigDict
 
 from ..http import Session, session as global_session
@@ -11,8 +11,8 @@
 class JwtToken(Creatable):
     _resource: ClassVar = 'token'
 
-    id: Annotated[str, Metadata(sensitive=True, log_chars=4)]
-    token: Annotated[str, Metadata(sensitive=True, log_chars=4)]
+    id: Annotated[str, LogConfig(masked=True, unmasked_chars_length=4)]
+    token: Annotated[str, LogConfig(masked=True, unmasked_chars_length=4)]
     created_at: dt.datetime
     api_key_uri: str
 

diff --git a/cuenca/resources/login_tokens.py b/cuenca/resources/login_tokens.py
@@ -1,6 +1,6 @@
 from typing import Annotated, ClassVar
 
-from cuenca_validations.types import Metadata
+from cuenca_validations.types import LogConfig
 from pydantic import ConfigDict
 
 from ..http import Session, session as global_session
@@ -10,7 +10,7 @@
 class LoginToken(Creatable):
     _resource: ClassVar = 'login_tokens'
 
-    id: Annotated[str, Metadata(sensitive=True, log_chars=4)]
+    id: Annotated[str, LogConfig(masked=True, unmasked_chars_length=4)]
 
     model_config = ConfigDict(
         json_schema_extra={'example': {'id': 'LTNEUInh69SuKXXmK95sROwQ'}}

diff --git a/cuenca/resources/otps.py b/cuenca/resources/otps.py
@@ -1,6 +1,6 @@
 from typing import Annotated, ClassVar
 
-from cuenca_validations.types import Metadata
+from cuenca_validations.types import LogConfig
 from pydantic import ConfigDict
 
 from ..http import Session, session as global_session
@@ -9,7 +9,7 @@
 
 class Otp(Creatable):
     _resource: ClassVar = 'otps'
-    secret: Annotated[str, Metadata(sensitive=True, log_chars=4)]
+    secret: Annotated[str, LogConfig(masked=True, unmasked_chars_length=4)]
 
     model_config = ConfigDict(
         json_schema_extra={

diff --git a/cuenca/resources/sessions.py b/cuenca/resources/sessions.py
@@ -1,7 +1,7 @@
 import datetime as dt
 from typing import Annotated, ClassVar, Optional
 
-from cuenca_validations.types import Metadata, SessionRequest, SessionType
+from cuenca_validations.types import LogConfig, SessionRequest, SessionType
 from cuenca_validations.types.general import SerializableAnyUrl
 from pydantic import ConfigDict
 
@@ -12,7 +12,7 @@
 class Session(Creatable, Retrievable, Queryable):
     _resource: ClassVar = 'sessions'
 
-    id: Annotated[str, Metadata(sensitive=True, log_chars=4)]
+    id: Annotated[str, LogConfig(masked=True, unmasked_chars_length=4)]
     created_at: dt.datetime
     user_id: str
     platform_id: str

diff --git a/requirements.txt b/requirements.txt
@@ -1,3 +1,3 @@
 requests==2.32.3
-cuenca-validations==2.0.5.dev3
+cuenca-validations==2.0.5.dev5
 pydantic-extra-types==2.10.2