Implement /team/{teamId}/pm-all endpoint (#56)

* Update berserk/clients/teams.py Co-authored-by: Benedikt Werner <[email protected]> * Update README.rst * Update teams.py --------- Co-authored-by: Benedikt Werner <[email protected]>
lichess-org · Oct 29, 2023 · fa0286c · fa0286c
1 parent ec778ce
commit fa0286c
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 0 deletions.
diff --git a/README.rst b/README.rst
@@ -172,6 +172,7 @@ Most of the API is available:
     client.teams.teams_of_player
     client.teams.get_popular
     client.teams.search
+    client.teams.message_all_members
 
     client.tournaments.get
     client.tournaments.get_tournament

diff --git a/berserk/clients/teams.py b/berserk/clients/teams.py
@@ -121,3 +121,13 @@ def search(self, text: str, page: int = 1) -> PaginatedTeams:
         path = "/api/team/search"
         params: Params = {"text": text, "page": page}
         return cast(PaginatedTeams, self._r.get(path, params=params))
+
+    def message_all_members(self, team_id: str, message: str) -> None:
+        """Send a private message to all members of a team. You must be the team leader with the "Messages" permission.
+
+        :param team_id: team ID
+        :param message: message to send all team members
+        """
+        path = f"/team/{team_id}/pm-all"
+        payload = {"message": message}
+        self._r.post(path=path, payload=payload)