Skip to content

Free, Open Source, Self-Hosted WhatsApp API Gateway

docs(sdk): say when Python update_config changes take effect

Yudhi Armyndharisf09f51f0f15b
diff --git a/sdk/python/openwa/resources/sessions.py b/sdk/python/openwa/resources/sessions.py
index 58b7e83ef..26f0f99a9 100644
--- a/sdk/python/openwa/resources/sessions.py
+++ b/sdk/python/openwa/resources/sessions.py
@@ -51,9 +51,10 @@ class SessionsResource:
return self._http.request("GET", f"/api/sessions/{quote_segment(session_id)}/config")
def update_config(self, session_id: str, body: UpdateSessionConfigRequest) -> SessionConfig:
- """Update a RUNNING session's configuration -- no re-link and no QR scan.
+ """Update a session's configuration, in any state, with no restart, re-link or QR scan.
- All three fields were fixed at creation before this route existed.
+ All three fields were fixed at creation before this route existed. ``autoRejectCalls`` applies
+ immediately; ``maxReconnectAttempts`` and ``reconnectBaseDelay`` apply on the next start.
"""
return self._http.request(
"PATCH", f"/api/sessions/{quote_segment(session_id)}/config", body=body
diff --git a/sdk/python/openwa/types.py b/sdk/python/openwa/types.py
index 930186b1d..21296608f 100644
--- a/sdk/python/openwa/types.py
+++ b/sdk/python/openwa/types.py
@@ -284,7 +284,7 @@ class SessionConfig(TypedDict):
class UpdateSessionConfigRequest(TypedDict, total=False):
- """Partial update of a running session's config -- no re-link, no QR scan.
+ """Partial update of a session's config, in any state -- no re-link, no QR scan.
Send ``None`` for ``maxReconnectAttempts`` to restore unlimited retries, which no in-range number
can express.