Skip to content

Commit c8366ac

Browse files
committed
api: Add remove_storage() helper to client. Fixes #637
1 parent 0a9b91f commit c8366ac

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

zulip/zulip/__init__.py

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1640,6 +1640,28 @@ def get_storage(self, request: Optional[Dict[str, Any]] = None) -> Dict[str, Any
16401640
method="GET",
16411641
request=request,
16421642
)
1643+
def remove_storage(self, request: Dict[str, Any]) -> Dict[str, Any]:
1644+
"""
1645+
Remove entries from the bot's storage.
1646+
1647+
Example:
1648+
>>> client.update_storage({'storage': {'a': '1', 'b': '2'}})
1649+
>>> client.remove_storage({'keys': ['a']})
1650+
>>> client.get_storage()
1651+
{'result': 'success', 'storage': {'b': '2'}, 'msg': ''}
1652+
1653+
Keyword args:
1654+
keys (List[str]): Keys to remove from storage.
1655+
1656+
Returns:
1657+
Dict[str, Any]: Standard Zulip API response dict.
1658+
"""
1659+
return self.call_endpoint(
1660+
url="bot_storage",
1661+
method="DELETE",
1662+
request=request or {},
1663+
)
1664+
16431665

16441666
def set_typing_status(self, request: Dict[str, Any]) -> Dict[str, Any]:
16451667
"""

0 commit comments

Comments
 (0)