examples auth

Author: rogelioLpz

cuenca/resources/api_keys.py

@@ -15,6 +15,18 @@ class ApiKey(Creatable, Queryable, Retrievable, Updateable):
     deactivated_at: Optional[dt.datetime]
     user_id: Optional[str]
 
+    class Config:
+        schema_extra = {
+            "example": {
+                "id": "AK-123",
+                "updated_at": "2021-08-24T14:15:22Z",
+                "created_at": "2021-08-24T14:15:22Z",
+                "secret": "super-secret-random-string",
+                "deactivated_at": None,
+                "user_id": "US-123",
+            }
+        }
+
     @property
     def active(self) -> bool:
         return (

cuenca/resources/login_tokens.py

@@ -7,6 +7,9 @@
 class LoginToken(Creatable):
     _resource: ClassVar = 'login_tokens'
 
+    class Config:
+        schema_extra = {"example": {"id": "LT-123"}}
+
     @classmethod
     def create(cls, session: Session = global_session) -> 'LoginToken':
         """

cuenca/resources/sessions.py

@@ -20,6 +20,20 @@ class Session(Creatable, Retrievable, Queryable):
     failure_url: Optional[AnyUrl]
     type: Optional[SessionType]
 
+    class Config:
+        schema_extra = {
+            "example": {
+                "id": "SE-123",
+                "created_at": "2022-08-24T14:15:22Z",
+                "user_id": "US-123",
+                "platform_id": "PT-123",
+                "expires_at": "2022-08-24T14:30:22Z",
+                "success_url": "http://example_success.com",
+                "failure_url": "http://example_failure.com",
+                "type": "session.registration",
+            }
+        }
+
     @classmethod
     def create(
         cls,

cuenca/resources/user_logins.py

@@ -13,6 +13,15 @@ class UserLogin(Creatable):
     last_login_at: Optional[dt.datetime]
     success: bool
 
+    class Config:
+        schema_extra = {
+            "example": {
+                "id": "UL-123",
+                "last_login_at": "2022-01-01T14:15:22Z",
+                "success": True,
+            }
+        }
+
     @classmethod
     def create(
         cls, password: str, *, session: Session = global_session

cuenca/version.py

@@ -1,3 +1,3 @@
-__version__ = '0.10.0.dev2'
+__version__ = '0.10.0.dev3'
 CLIENT_VERSION = __version__
 API_VERSION = '2020-03-19'

requirements.txt

@@ -1,3 +1,3 @@
 requests==2.27.1
-cuenca-validations==0.10.7.dev2
+cuenca-validations==0.10.7.dev3
 dataclasses>=0.7;python_version<"3.7"