Free, Open Source, Self-Hosted WhatsApp API Gateway
TypeScript apibotgatewayself-hostedwhatsappwhatsapp-apiwhatsapp-automationwhatsapp-botwhatsapp-gatewaywhatsapp-gateway-apiwhatsapp-webwhatsapp-web-api
docs(sdk): escape the pipe in the Python get_presence signature
Yudhi Armyndharisd79123ba9d77
diff --git a/docs/18-sdk-design.md b/docs/18-sdk-design.mdindex b686ae37a..df80b3881 100644--- a/docs/18-sdk-design.md+++ b/docs/18-sdk-design.md@@ -600,19 +600,19 @@ Resources are accessed as properties on the client (e.g. `client.messages`). All#### `client.chats`-| Method | Signature | Description |-| -------------------- | ------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |-| `list` | `list(session_id, query=None) -> list[ChatSummary]` | List chats (`query`: `limit`, `offset`). |-| `subscribe_presence` | `subscribe_presence(session_id, body) -> SuccessResult` | Subscribe to a chat's presence; updates then arrive as `presence.update` events. The subscription belongs to the connection and does not survive a reconnect. **OPERATOR** |-| `get_presence` | `get_presence(session_id, chat_id) -> ChatPresence | None` | The last presence reported for a chat, or `null` when none has been. Held in memory, so a restart clears it. |-| `mark_read` | `mark_read(session_id, body) -> SuccessResult` | Mark a chat as read. **OPERATOR** |-| `mark_unread` | `mark_unread(session_id, body) -> SuccessResult` | Mark a chat as unread. **OPERATOR** |-| `archive` | `archive(session_id, body) -> SuccessResult` | Archive or unarchive a chat. `success: false` means the engine declined. **OPERATOR** |-| `pin` | `pin(session_id, body) -> SuccessResult` | Pin a chat to the top of the list, or unpin it. `success: false` means WhatsApp declined — three pins maximum. **OPERATOR** |-| `mute` | `mute(session_id, body) -> SuccessResult` | Mute a chat until an absolute epoch-MILLISECONDS timestamp, or unmute with `null`. **OPERATOR** |-| `clear_messages` | `clear_messages(session_id, chat_id) -> SuccessResult` | Delete every message in a chat, keeping the chat itself. **OPERATOR** |-| `delete` | `delete(session_id, body) -> SuccessResult` | Delete a chat. **OPERATOR** |-| `send_state` | `send_state(session_id, body) -> SuccessResult` | Send a typing/recording chat state. **OPERATOR** |+| Method | Signature | Description |+| -------------------- | ----------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |+| `list` | `list(session_id, query=None) -> list[ChatSummary]` | List chats (`query`: `limit`, `offset`). |+| `subscribe_presence` | `subscribe_presence(session_id, body) -> SuccessResult` | Subscribe to a chat's presence; updates then arrive as `presence.update` events. The subscription belongs to the connection and does not survive a reconnect. **OPERATOR** |+| `get_presence` | `get_presence(session_id, chat_id) -> ChatPresence \| None` | The last presence reported for a chat, or `null` when none has been. Held in memory, so a restart clears it. |+| `mark_read` | `mark_read(session_id, body) -> SuccessResult` | Mark a chat as read. **OPERATOR** |+| `mark_unread` | `mark_unread(session_id, body) -> SuccessResult` | Mark a chat as unread. **OPERATOR** |+| `archive` | `archive(session_id, body) -> SuccessResult` | Archive or unarchive a chat. `success: false` means the engine declined. **OPERATOR** |+| `pin` | `pin(session_id, body) -> SuccessResult` | Pin a chat to the top of the list, or unpin it. `success: false` means WhatsApp declined — three pins maximum. **OPERATOR** |+| `mute` | `mute(session_id, body) -> SuccessResult` | Mute a chat until an absolute epoch-MILLISECONDS timestamp, or unmute with `null`. **OPERATOR** |+| `clear_messages` | `clear_messages(session_id, chat_id) -> SuccessResult` | Delete every message in a chat, keeping the chat itself. **OPERATOR** |+| `delete` | `delete(session_id, body) -> SuccessResult` | Delete a chat. **OPERATOR** |+| `send_state` | `send_state(session_id, body) -> SuccessResult` | Send a typing/recording chat state. **OPERATOR** |#### `client.webhooks`