From bdacfd11eb0815ea2ab12146cb5bf85e4bb036d1 Mon Sep 17 00:00:00 2001
From: Anupya Pamidimukkala <anupya@hotmail.ca>
Date: Sun, 22 Oct 2023 01:14:24 -0400
Subject: [PATCH] add autocomplete usernames endpoint

---
 README.rst               |  1 +
 berserk/clients/users.py | 20 ++++++++++++++++++++
 2 files changed, 21 insertions(+)

diff --git a/README.rst b/README.rst
index 32e49e1..0039320 100644
--- a/README.rst
+++ b/README.rst
@@ -199,6 +199,7 @@ Most of the API is available:
     client.users.get_live_streamers
     client.users.get_rating_history
     client.users.get_crosstable
+    client.users.get_autocomplete
     client.users.get_user_performance
 
 Details for each function can be found in the `documentation <https://lichess-org.github.io/berserk/>`_.
diff --git a/berserk/clients/users.py b/berserk/clients/users.py
index 393b919..c935729 100644
--- a/berserk/clients/users.py
+++ b/berserk/clients/users.py
@@ -123,6 +123,26 @@ def get_crosstable(
             path, params=params, fmt=JSON_LIST, converter=models.User.convert
         )
 
+    def get_autocomplete(
+        self,
+        incomplete_username: str,
+        only_followed_players: bool,
+        should_return_object: bool = False,
+    ) -> Dict[str, Any]:
+        """Provides autocomplete options for an incomplete username.
+
+        :param incomplete_username: beginning of a username, must be >=3 characters
+        :param only_followed_players: whether to return matching followed players only, if any exist
+        :param should_return_object: whether to return an object with matching users
+        """
+        path = "/api/player/auto-complete"
+        params = {
+            "term": incomplete_username,
+            "object": should_return_object,
+            "friend": only_followed_players,
+        }
+        return self._r.get(path=path, params=params)
+
     def get_user_performance(self, username: str, perf: str) -> List[Dict[str, Any]]:
         """Read performance statistics of a user, for a single performance.