fix types

Author: YonkoSam

.coverage

@@ -15,7 +15,7 @@ A lightweight and robust Python SDK for interacting with the Wasender API ([http
 
 - **Pydantic Models:** Leverages Pydantic for robust request/response validation and serialization, especially for the generic `send()` method and webhook event parsing.
 - **Message Sending:**
-  - Simplified helper methods (e.g., `client.send_text(to=\"...\", text_body=\"...\")`, `client.send_image(to=\"...\", url=\"...\", caption=\"...\")`) that accept direct parameters for common message types.
+  - Simplified helper methods (e.g., `client.send_text(to="...", text_body="...")`, `client.send_image(to="...", url="...", caption="...")`) that accept direct parameters for common message types.
   - Generic `client.send(payload: BaseMessage)` method for advanced use cases or less common message types, accepting a Pydantic model.
   - Support for text, image, video, document, audio, sticker, contact card, and location messages.
 - **Contact Management:** List, retrieve details, get profile pictures, block, and unblock contacts.
@@ -26,7 +26,7 @@ A lightweight and robust Python SDK for interacting with the Wasender API ([http
 - **Error Handling:** Comprehensive `WasenderAPIError` class with detailed error information.
 - **Rate Limiting:** Access to rate limit information on API responses.
 - **Retry Mechanism:** Optional automatic retries for rate-limited requests (HTTP 429) via `RetryConfig`.
-- **Customizable HTTP Client:** Allows providing a custom `fetch_implementation` (compatible with `requests.request` or an async equivalent) for specialized HTTP handling or testing.
+- **Customizable HTTP Client:** Allows providing a custom `httpx.AsyncClient` instance for the asynchronous client.
 
 ## Prerequisites
 
@@ -172,38 +172,22 @@ async def send_async_text_message(client):
 # if __name__ == "__main__":
 #     asyncio.run(main_async_send_example()) # Example of how to run it
 ```
-# For this example, we'll use the default internal HTTP client.
-# custom_fetch_impl: Optional[FetchImplementation] = None 
-
-# This block seems like an old/outdated example of client initialization. 
-# The create_sync_wasender and create_async_wasender are the preferred ways now.
-# It also uses WasenderClient which was the old name and personal_token instead of personal_access_token.
-# I will comment it out for now as it's confusing and outdated.
-# wasender_client_full = WasenderClient(
-#     api_key=api_key,
-#     # base_url="https://www.wasenderapi.com/api", # Defaults to this
-#     # fetch_implementation=custom_fetch_impl,
-#     retry_config=retry_config,
-#     webhook_secret=webhook_secret,
-#     personal_token=persona_token
-# )
-# 
-# # Basic initialization (session-scoped endpoints only, no retries, no webhooks)
-# basic_wasender_client = WasenderClient(api_key=api_key)
-# 
-# # Initialize with persona token (for account management, no retries, no webhooks)
-# account_wasender_client = WasenderClient(
-#     api_key=api_key,
-#     personal_token=persona_token
-# )
-# 
-# # Initialize with webhook secret (for webhook handling, no retries, no account management)
-# webhook_handler_client = WasenderClient(
-#     api_key=api_key,
-#     webhook_secret=webhook_secret
-# )
-# 
-# print("WasenderClient initialized.")
+
+## Usage Overview
+
+Using the SDK involves calling methods on the initialized client instance. For example, to send a message with the synchronous client:
+
+```python
+from wasenderapi.errors import WasenderAPIError
+
+try:
+    response = sync_client.send_text(to="1234567890", text_body="Hello from Python SDK!")
+    print(f"Message sent successfully: {response.response.data.message_id}")
+    if response.rate_limit:
+        print(f"Rate limit info: Remaining {response.rate_limit.remaining}")
+except WasenderAPIError as e:
+    print(f"API Error: {e.message} (Status: {e.status_code})")
+```
 
 ## Authentication
 
@@ -284,7 +268,7 @@ Send various types of messages including text, media (images, videos, documents,
 
 - **Detailed Documentation & Examples:** [`docs/messages.md`](./docs/messages.md)
 
-**Using the Synchronous Client (`WasenderSyncClient`)**
+#### Using the Synchronous Client (`WasenderSyncClient`)
 
 ```python
 import os
@@ -332,7 +316,7 @@ def send_sync_messages_example():
 #     send_sync_messages_example()
 ```
 
-**Using the Asynchronous Client (`WasenderAsyncClient`)**
+#### Using the Asynchronous Client (`WasenderAsyncClient`)
 
 ```python
 import asyncio
@@ -728,45 +712,6 @@ async def manage_whatsapp_sessions_example():
 
 ## Advanced Topics
 
-### Custom HTTP Client Fetch Implementation
-
-For advanced scenarios, such as custom logging, request/response modification, or integration with specific HTTP libraries, you can provide your own HTTP fetch implementation.
-
-**Synchronous Client:**
-
-When initializing `WasenderSyncClient` (or using `create_sync_wasender`), the underlying HTTP calls are made using the `requests` library by default. If you need to customize this, you would typically do so by configuring the global `requests` behavior or by wrapping calls to the SDK if fine-grained control per request is needed (though the SDK doesn't directly expose a hook for a custom *sync* fetch function in its constructor anymore after recent refactoring focused on `httpx` for async and standard `requests` for sync internally).
-
-**Asynchronous Client:**
-
-The `WasenderAsyncClient` (and `create_async_wasender` factory) uses `httpx.AsyncClient` internally. You can pass your pre-configured `httpx.AsyncClient` instance during initialization:
-
-```python
-import httpx
-from wasenderapi import create_async_wasender
-from wasenderapi.models import RetryConfig # Ensure RetryConfig is imported if used
-
-# Example: Configure a custom httpx.AsyncClient with a timeout
-custom_http_client = httpx.AsyncClient(timeout=10.0) 
-
-# Example API key and retry config
-api_key = "YOUR_API_KEY"
-retry_conf = RetryConfig(enabled=True, max_retries=2)
-
-async_client_custom = create_async_wasender(
-    api_key=api_key, 
-    http_client=custom_http_client, 
-    retry_options=retry_conf
-)
-
-async def use_custom_client():
-    async with async_client_custom:
-        # Make API calls
-        # e.g., status = await async_client_custom.get_session_status("your_session_id")
-        print("Using async client with custom httpx client")
-
-# await use_custom_client()
-```
-
 ### Configuring Retries
 
 The SDK supports automatic retries, primarily for handling HTTP 429 (Too Many Requests) errors. This is configured via the `RetryConfig` object passed to `retry_options` during client initialization.

README.md

@@ -27,13 +27,12 @@ def mock_rate_limit_info_dict():
 @pytest.fixture
 def specific_contact_api_data_for_model_test(): # Renamed fixture
     return {
-        "jid": "[email protected]",
+        "id": "[email protected]",
         "name": "Contact Name API Model Test",
         "notify": "Contact Display API Model Test",
         "verifiedName": "Verified Business API Model Test",
         "imgUrl": "https://profile.pic.url/model_test.jpg",
-        "status": "API status: Model Test Active!",
-        "exists": True
+        "status": "API status: Model Test Active!"
     }
 
 @pytest.fixture
@@ -42,7 +41,7 @@ def mock_multiple_contacts_api_data(specific_contact_api_data_for_model_test): #
     # Assuming it still uses a general form, let's define one or use the name that might be from conftest if needed by other tests.
     # For now, let it use the renamed one to see the effect. Or, create another general one if needed.
     contact2 = specific_contact_api_data_for_model_test.copy()
-    contact2["jid"] = "[email protected]"
+    contact2["id"] = "[email protected]"
     contact2["name"] = "Another Contact API Model Test"
     return [specific_contact_api_data_for_model_test, contact2]
 
@@ -61,27 +60,26 @@ def test_contact_model_all_fields(self, specific_contact_api_data_for_model_test
         # Pydantic should use the aliases to populate the snake_case fields.
         contact = Contact(**specific_contact_api_data_for_model_test)
 
-        assert contact.jid == specific_contact_api_data_for_model_test["jid"]
+        assert contact.id == specific_contact_api_data_for_model_test["id"]
         assert contact.name == specific_contact_api_data_for_model_test["name"]
         # Now check the model's snake_case attributes against the fixture's camelCase values
         assert contact.verified_name == specific_contact_api_data_for_model_test["verifiedName"]
         assert contact.img_url == specific_contact_api_data_for_model_test["imgUrl"]
         assert contact.status == specific_contact_api_data_for_model_test["status"]
-        assert contact.exists == specific_contact_api_data_for_model_test["exists"]
 
         dumped_contact = contact.model_dump(by_alias=True)
         assert dumped_contact["verifiedName"] == specific_contact_api_data_for_model_test["verifiedName"]
         assert dumped_contact["imgUrl"] == specific_contact_api_data_for_model_test["imgUrl"]
 
     def test_contact_model_minimal_fields(self):
-        minimal_data = {"jid": "[email protected]"}
+        minimal_data = {"id": "[email protected]"}
         contact = Contact(**minimal_data)
-        assert contact.jid == minimal_data["jid"]
+        assert contact.id == minimal_data["id"]
         assert contact.name is None
         dumped_contact = contact.model_dump(by_alias=True, exclude_none=True)
         assert "name" not in dumped_contact
 
-    def test_contact_model_missing_jid_raises_error(self):
+    def test_contact_model_missing_id_raises_error(self):
         with pytest.raises(ValidationError):
             Contact(name="Test Name")
 
@@ -102,7 +100,7 @@ def test_get_all_contacts_result(self, mock_multiple_contacts_api_data, mock_rat
         assert result_model.response.message == "Fetched contacts successfully"
         assert len(result_model.response.data) == 2
         assert isinstance(result_model.response.data[0], Contact)
-        assert result_model.response.data[0].jid == mock_multiple_contacts_api_data[0]["jid"]
+        assert result_model.response.data[0].id == mock_multiple_contacts_api_data[0]["id"]
         assert result_model.response.data[0].name == mock_multiple_contacts_api_data[0]["name"]
         # Check aliasing for verifiedName and imgUrl from the first contact
         assert result_model.response.data[0].verified_name == mock_multiple_contacts_api_data[0]["verifiedName"]
@@ -126,7 +124,7 @@ def test_get_contact_info_result(self, specific_contact_api_data_for_model_test,
 
         assert result_model.response.success is True
         assert isinstance(result_model.response.data, Contact)
-        assert result_model.response.data.jid == specific_contact_api_data_for_model_test["jid"]
+        assert result_model.response.data.id == specific_contact_api_data_for_model_test["id"]
         assert result_model.response.data.status == specific_contact_api_data_for_model_test["status"]
         assert result_model.rate_limit.remaining == mock_rate_limit_info_dict["remaining"]
 
@@ -208,7 +206,7 @@ async def test_get_contact_info(self, async_client_contacts_mocked_internals, sp
 
         client._get_internal.assert_called_once_with(f"/contacts/{contact_phone}")
         assert isinstance(result, GetContactInfoResult)
-        assert result.response.data.jid == specific_contact_api_data_for_model_test["jid"]
+        assert result.response.data.id == specific_contact_api_data_for_model_test["id"]
 
     @pytest.mark.asyncio
     async def test_get_contact_profile_picture(self, async_client_contacts_mocked_internals, mock_rate_limit_info_dict):