Skip to content

Commit aeb6249

Browse files
committed
zulip: Add remove_storage helper to Client.
Mirrors update_storage and get_storage, sending DELETE to /bot_storage. With no argument, removes all data stored for the bot; passing {"keys": [...]} removes only the specified entries. The corresponding endpoint is bot-only as of Zulip 12.0 (API feature level 494), so this helper only succeeds for bot users. Fixes #637.
1 parent 7bb8f4e commit aeb6249

1 file changed

Lines changed: 16 additions & 0 deletions

File tree

zulip/zulip/__init__.py

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1663,6 +1663,22 @@ def get_storage(self, request: Optional[Dict[str, Any]] = None) -> Dict[str, Any
16631663
request=request,
16641664
)
16651665

1666+
def remove_storage(self, request: Optional[Dict[str, Any]] = None) -> Dict[str, Any]:
1667+
"""
1668+
Example usage:
1669+
1670+
>>> client.update_storage({'storage': {"entry 1": "value 1", "entry 2": "value 2"}})
1671+
>>> client.remove_storage({'keys': ["entry 1"]})
1672+
{'result': 'success', 'msg': ''}
1673+
>>> client.remove_storage()
1674+
{'result': 'success', 'msg': ''}
1675+
"""
1676+
return self.call_endpoint(
1677+
url="bot_storage",
1678+
method="DELETE",
1679+
request=request,
1680+
)
1681+
16661682
def set_typing_status(self, request: Dict[str, Any]) -> Dict[str, Any]:
16671683
"""
16681684
Example usage:

0 commit comments

Comments
 (0)