Add query members support (#37)

Author: ferhatelmas

stream_chat/channel.py

@@ -1,3 +1,5 @@
+import json
+
 from stream_chat.exceptions import StreamChannelException
 
 
@@ -94,6 +96,32 @@ def query(self, **options):
 
         return state
 
+    def query_members(self, filter_conditions, sort=None, **options):
+        """
+        Query the API for this channel to filter, sort and paginate its members efficiently.
+
+        :param filter_conditions: filters, checks docs on https://getstream.io/chat/docs/
+        :param sort: sorting field and direction slice, check docs on https://getstream.io/chat/docs/
+        :param options: pagination or members based channel searching details
+        :return: Returns members response
+
+        eg.
+        channel.query_members(filter_conditions={"name": "tommaso"},
+                              sort=[{"field": "created_at", "direction": -1}],
+                              offset=0,
+                              limit=10)
+        """
+
+        payload = {
+            "id": self.id,
+            "type": self.channel_type,
+            "filter_conditions": filter_conditions,
+            "sort": sort or [],
+            **options,
+        }
+        response = self.client.get("members", params={"payload": json.dumps(payload)})
+        return response["members"]
+
     def update(self, channel_data, update_message=None):
         """
         Edit the channel's custom properties

stream_chat/tests/test_channel.py

@@ -224,3 +224,20 @@ def test_invites(self, client, channel):
         # cannot reject again
         with pytest.raises(StreamAPIException):
             reject = channel.reject_invite("eric")
+
+    def test_query_members(self, client, channel):
+        members = ["paul", "george", "john", "jessica", "john2"]
+        client.update_users([{"id": m, "name": m} for m in members])
+        for member in members:
+            channel.add_members([member])
+
+        response = channel.query_members(
+            filter_conditions={"name": {"$autocomplete": "j"}},
+            sort=[{"field": "created_at", "direction": 1}],
+            offset=1,
+            limit=10,
+        )
+
+        assert len(response) == 2
+        assert response[0]["user_id"] == "jessica"
+        assert response[1]["user_id"] == "john2"