From ecc9e4c27506ebffce8e0efa9d352a20af920819 Mon Sep 17 00:00:00 2001 From: MarcUs7i <96580944+MarcUs7i@users.noreply.github.com> Date: Tue, 15 Jul 2025 12:45:28 +0200 Subject: [PATCH] Updated apiDoc.md and README.md --- README.md | 1 + apiDoc.md | 13 +++++++++++++ 2 files changed, 14 insertions(+) diff --git a/README.md b/README.md index 54d6f32..ef6aab2 100644 --- a/README.md +++ b/README.md @@ -51,6 +51,7 @@ print(f"EU Data: {eu_data_info['remaining']}/{eu_data_info['total']} GiB") # Access account information print(f"User: {client.user_name}") +print(f"Phone Number: {client.phone_number}") print(f"Balance: €{client.balance if client.balance is not None else 'N/A'}") print(f"Package valid until: {client.tariff_package_valid_to}") diff --git a/apiDoc.md b/apiDoc.md index 385df86..7572ee3 100644 --- a/apiDoc.md +++ b/apiDoc.md @@ -256,6 +256,18 @@ Get user's name. print(f"User name: {client.user_name}") ``` +### phone_number → Optional[str] + +Get user's phone number. + +**Returns:** +- `str`: User's phone number or None if not available + +**Example:** +```python +print(f"Phone number: {client.phone_number}") +``` + ### user_type → Optional[str] Get user's type (e.g., 'CUSTOMER'). @@ -504,6 +516,7 @@ Key caching parameters: - Tariffs: 60 seconds TTL The cache is implemented using the `ttl_cache` decorator in helpers.py. +The user data cache is cleared automatically when a credit top-up occurs. ## Error Handling