mirror of
https://github.com/Kizuren/LidlConnect.py.git
synced 2025-12-21 21:16:13 +01:00
Updated apiDoc.md and README.md
This commit is contained in:
parent
d30235181b
commit
ecc9e4c275
2 changed files with 14 additions and 0 deletions
|
|
@ -51,6 +51,7 @@ print(f"EU Data: {eu_data_info['remaining']}/{eu_data_info['total']} GiB")
|
||||||
|
|
||||||
# Access account information
|
# Access account information
|
||||||
print(f"User: {client.user_name}")
|
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"Balance: €{client.balance if client.balance is not None else 'N/A'}")
|
||||||
print(f"Package valid until: {client.tariff_package_valid_to}")
|
print(f"Package valid until: {client.tariff_package_valid_to}")
|
||||||
|
|
||||||
|
|
|
||||||
13
apiDoc.md
13
apiDoc.md
|
|
@ -256,6 +256,18 @@ Get user's name.
|
||||||
print(f"User name: {client.user_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]
|
### user_type → Optional[str]
|
||||||
|
|
||||||
Get user's type (e.g., 'CUSTOMER').
|
Get user's type (e.g., 'CUSTOMER').
|
||||||
|
|
@ -504,6 +516,7 @@ Key caching parameters:
|
||||||
- Tariffs: 60 seconds TTL
|
- Tariffs: 60 seconds TTL
|
||||||
|
|
||||||
The cache is implemented using the `ttl_cache` decorator in helpers.py.
|
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
|
## Error Handling
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue