fix(docs): correct PaymentResponse field access in documentation

Fixed incorrect access pattern for payment.ecommerce_id throughout documentation.
The correct path is payment.data.ecommerce_id since PaymentResponse contains
a nested PaymentData object.

- Updated all documentation examples to use payment.data.ecommerce_id
- Fixed 37 instances across 7 documentation files
- Prevents AttributeError when users follow the documentation examples

This ensures users correctly access the ecommerce_id field from the
PaymentResponse object returned by create_payment().

Author: rnegron

README.md

@@ -1,7 +1,8 @@
 # ATH Móvil Unofficial Python Library
 
-[![PyPI version](https://badge.fury.io/py/athm.svg)](https://badge.fury.io/py/athm)
+![PyPI - Version](https://img.shields.io/pypi/v/athm)
 [![Python Versions](https://img.shields.io/pypi/pyversions/athm.svg)](https://pypi.org/project/athm/)
+[![Read the Docs](https://img.shields.io/readthedocs/athm-python)](https://athm-python.readthedocs.io/en/latest/)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 [![Tests](https://github.com/django-athm/athm-python/actions/workflows/test.yml/badge.svg)](https://github.com/django-athm/athm-python/actions/workflows/test.yml)
 
@@ -54,10 +55,10 @@ payment = client.create_payment(
     ],
 )
 
-confirmed = client.wait_for_confirmation(payment.ecommerce_id)
+confirmed = client.wait_for_confirmation(payment.data.ecommerce_id)
 
 if confirmed:
-    result = client.authorize_payment(payment.ecommerce_id)
+    result = client.authorize_payment(payment.data.ecommerce_id)
     print(f"Payment completed: {result.data.reference_number}")
 ```
 
@@ -118,7 +119,7 @@ with ATHMovilClient(public_token="token") as client:
 ## Development
 
 ```bash
-git clone https://github.com/yourusername/athm-python.git
+git clone https://github.com/django-athm/athm-python.git
 cd athm-python
 uv sync --all-extras --dev
 uv run pytest
@@ -127,8 +128,8 @@ uv run pytest
 ### Code Quality
 
 ```bash
-uv run ruff format athm tests
-uv run ruff check athm tests --fix
+uv run ruff format
+uv run ruff check
 uv run mypy athm
 ```
 

docs/advanced.md

@@ -111,8 +111,8 @@ with ATHMovilClient(public_token="...") as client:
         tax="0.00"
     )
 
-    confirmed = client.wait_for_confirmation(payment.ecommerce_id)
-    result = client.authorize_payment(payment.ecommerce_id)
+    confirmed = client.wait_for_confirmation(payment.data.ecommerce_id)
+    result = client.authorize_payment(payment.data.ecommerce_id)
 
     print(f"Reference: {result.data.reference_number}")
 
@@ -186,7 +186,7 @@ payment = client.create_payment(...)  # Uses 30s timeout
 
 # Longer wait for confirmation
 confirmed = client.wait_for_confirmation(
-    payment.ecommerce_id,
+    payment.data.ecommerce_id,
     polling_interval=2.0,
     max_attempts=300  # 10 minutes (300 * 2s)
 )

docs/api-reference.md

@@ -278,9 +278,9 @@ Response from creating a payment.
 ```python
 payment = client.create_payment(...)
 
-print(payment.ecommerce_id)  # Payment ID
-print(payment.auth_token)    # Authorization token
-print(payment.expires_in)    # Expiry timestamp
+print(payment.data.ecommerce_id)  # Payment ID
+print(payment.data.auth_token)    # Authorization token
+print(payment.data.expires_in)    # Expiry timestamp
 ```
 
 **Fields:**
@@ -562,13 +562,13 @@ payment = client.create_payment(
 )
 
 # Check status
-status = client.find_payment(payment.ecommerce_id)
+status = client.find_payment(payment.data.ecommerce_id)
 
 # Wait for confirmation
-confirmed = client.wait_for_confirmation(payment.ecommerce_id)
+confirmed = client.wait_for_confirmation(payment.data.ecommerce_id)
 
 # Authorize
-result = client.authorize_payment(payment.ecommerce_id)
+result = client.authorize_payment(payment.data.ecommerce_id)
 
 # Refund (requires private_token)
 refund = client.refund_payment(

docs/errors.md

@@ -308,7 +308,7 @@ def create_payment_with_retry(
                 subtotal=amount,
                 tax="0.00"
             )
-            return payment.ecommerce_id
+            return payment.data.ecommerce_id
 
         except ValidationError as e:
             # Invalid data - don't retry, fix input
@@ -461,7 +461,7 @@ try:
         subtotal="50.00",
         tax="0.00"
     )
-    logger.info(f"Payment created: {payment.ecommerce_id}")
+    logger.info(f"Payment created: {payment.data.ecommerce_id}")
 
 except ATHMovilError as e:
     # Log error safely
@@ -487,7 +487,7 @@ try:
     payment = client.create_payment(...)
     logger.info(
         "payment_created",
-        ecommerce_id=payment.ecommerce_id,
+        ecommerce_id=payment.data.ecommerce_id,
         amount="50.00"
     )
 except ATHMovilError as e:

docs/guide.md

@@ -51,7 +51,7 @@ payment = client.create_payment(
     }]
 )
 
-print(f"Payment created: {payment.ecommerce_id}")
+print(f"Payment created: {payment.data.ecommerce_id}")
 print("Customer will receive a push notification")
 ```
 
@@ -68,14 +68,14 @@ The customer needs to open their ATH Móvil app and approve the payment:
 # Option 1: Automatic polling (recommended)
 try:
     confirmed = client.wait_for_confirmation(
-        payment.ecommerce_id,
+        payment.data.ecommerce_id,
         polling_interval=2.0,  # Check every 2 seconds
         max_attempts=150       # 5 minutes max (150 * 2s)
     )
     print("Customer confirmed!")
 except TimeoutError:
     print("Customer didn't confirm in time")
-    client.cancel_payment(payment.ecommerce_id)
+    client.cancel_payment(payment.data.ecommerce_id)
 ```
 
 ```python
@@ -86,7 +86,7 @@ max_wait = 300  # 5 minutes
 elapsed = 0
 
 while elapsed < max_wait:
-    status = client.find_payment(payment.ecommerce_id)
+    status = client.find_payment(payment.data.ecommerce_id)
 
     if status.data.status == "CONFIRM":
         print("Customer confirmed!")
@@ -118,7 +118,7 @@ Once confirmed, you must authorize to finalize:
 
 ```python
 # Authorize completes the payment
-result = client.authorize_payment(payment.ecommerce_id)
+result = client.authorize_payment(payment.data.ecommerce_id)
 
 print(f"Payment completed!")
 print(f"Reference number: {result.data.reference_number}")
@@ -166,17 +166,17 @@ try:
     # Wait for confirmation
     try:
         confirmed = client.wait_for_confirmation(
-            payment.ecommerce_id,
+            payment.data.ecommerce_id,
             max_attempts=150
         )
     except TimeoutError:
         # Customer didn't confirm, clean up
-        client.cancel_payment(payment.ecommerce_id)
+        client.cancel_payment(payment.data.ecommerce_id)
         print("Payment cancelled due to timeout")
         return
 
     # Authorize
-    result = client.authorize_payment(payment.ecommerce_id)
+    result = client.authorize_payment(payment.data.ecommerce_id)
     print(f"Success! Reference: {result.data.reference_number}")
 
 except ValidationError as e:
@@ -221,23 +221,23 @@ def process_payment(amount: str, phone: str, order_id: str) -> str | None:
             ],
         )
 
-        print(f"Payment created: {payment.ecommerce_id}")
+        print(f"Payment created: {payment.data.ecommerce_id}")
         print(f"Waiting for customer {phone} to confirm...")
 
         # 2. Wait for customer confirmation (5 minute timeout)
         try:
             client.wait_for_confirmation(
-                payment.ecommerce_id,
+                payment.data.ecommerce_id,
                 polling_interval=2.0,
                 max_attempts=150  # 5 minutes
             )
         except TimeoutError:
             print("Customer didn't confirm in time, cancelling...")
-            client.cancel_payment(payment.ecommerce_id)
+            client.cancel_payment(payment.data.ecommerce_id)
             return None
 
         # 3. Authorize payment
-        result = client.authorize_payment(payment.ecommerce_id)
+        result = client.authorize_payment(payment.data.ecommerce_id)
 
         print(f"Payment completed!")
         print(f"  Reference: {result.data.reference_number}")
@@ -321,12 +321,12 @@ If the customer provides a different phone number:
 ```python
 # After payment creation, before confirmation
 client.update_phone_number(
-    ecommerce_id=payment.ecommerce_id,
+    ecommerce_id=payment.data.ecommerce_id,
     phone_number="7875559999"
 )
 
 # Now wait for confirmation on the new number
-client.wait_for_confirmation(payment.ecommerce_id)
+client.wait_for_confirmation(payment.data.ecommerce_id)
 ```
 
 ## Common Patterns
@@ -339,15 +339,15 @@ If you don't want to poll, implement a customer redirect:
 # 1. Create payment
 payment = client.create_payment(...)
 
-# 2. Show customer a page with payment.ecommerce_id
+# 2. Show customer a page with payment.data.ecommerce_id
 #    Customer opens ATH Móvil app and confirms
 
 # 3. Customer returns to your site, you check status
-status = client.find_payment(payment.ecommerce_id)
+status = client.find_payment(payment.data.ecommerce_id)
 
 if status.data.status == "CONFIRM":
     # Authorize it
-    result = client.authorize_payment(payment.ecommerce_id)
+    result = client.authorize_payment(payment.data.ecommerce_id)
 ```
 
 ### Pattern: Background Job
@@ -357,8 +357,8 @@ For async frameworks:
 ```python
 # In request handler
 payment = client.create_payment(...)
-enqueue_job("check_payment", payment.ecommerce_id)
-return {"payment_id": payment.ecommerce_id}
+enqueue_job("check_payment", payment.data.ecommerce_id)
+return {"payment_id": payment.data.ecommerce_id}
 
 # In background worker
 def check_payment(ecommerce_id):

docs/index.md

@@ -38,10 +38,10 @@ payment = client.create_payment(
 )
 
 # Wait for customer to confirm on their phone
-confirmed = client.wait_for_confirmation(payment.ecommerce_id)
+confirmed = client.wait_for_confirmation(payment.data.ecommerce_id)
 
 # Authorize the payment
-result = client.authorize_payment(payment.ecommerce_id)
+result = client.authorize_payment(payment.data.ecommerce_id)
 print(f"Payment completed! Reference: {result.data.reference_number}")
 ```
 

docs/installation.md

@@ -146,10 +146,10 @@ try:
         tax="0.00",
         metadata1="Installation Test"
     )
-    print(f"Success! Payment ID: {payment.ecommerce_id}")
+    print(f"Success! Payment ID: {payment.data.ecommerce_id}")
 
     # Cancel the test payment
-    client.cancel_payment(payment.ecommerce_id)
+    client.cancel_payment(payment.data.ecommerce_id)
     print("Test payment cancelled")
 
 except Exception as e: