[CHA-536] support campaign user pagination

Author: kanat

stream_chat/async_chat/campaign.py

@@ -2,7 +2,7 @@
 from typing import Any, Optional, Union
 
 from stream_chat.base.campaign import CampaignInterface
-from stream_chat.types.campaign import CampaignData
+from stream_chat.types.campaign import CampaignData, GetCampaignOptions
 from stream_chat.types.stream_response import StreamResponse
 
 
@@ -22,9 +22,9 @@ async def create(
             self.campaign_id = state["campaign"]["id"]
         return state
 
-    async def get(self) -> StreamResponse:
+    async def get(self, options: Optional[GetCampaignOptions] = None) -> StreamResponse:
         return await self.client.get_campaign(  # type: ignore
-            campaign_id=self.campaign_id
+            campaign_id=self.campaign_id, options=options
         )
 
     async def update(self, data: CampaignData) -> StreamResponse:

stream_chat/async_chat/client.py

@@ -20,7 +20,7 @@
 from stream_chat.async_chat.campaign import Campaign
 from stream_chat.async_chat.segment import Segment
 from stream_chat.types.base import SortParam
-from stream_chat.types.campaign import CampaignData, QueryCampaignsOptions
+from stream_chat.types.campaign import CampaignData, QueryCampaignsOptions, GetCampaignOptions
 from stream_chat.types.segment import (
     QuerySegmentsOptions,
     QuerySegmentTargetsOptions,
@@ -664,8 +664,11 @@ async def create_campaign(
             payload.update(cast(dict, data))
         return await self.post("campaigns", data=payload)
 
-    async def get_campaign(self, campaign_id: str) -> StreamResponse:
-        return await self.get(f"campaigns/{campaign_id}")
+    async def get_campaign(self, campaign_id: str, options: Optional[GetCampaignOptions] = None) -> StreamResponse:
+        params = {}
+        if options and "users" in options:
+            params.update(options["users"])
+        return await self.get(f"campaigns/{campaign_id}", params)
 
     async def query_campaigns(
         self,

stream_chat/base/campaign.py

@@ -3,7 +3,7 @@
 from typing import Awaitable, Optional, Union
 
 from stream_chat.base.client import StreamChatInterface
-from stream_chat.types.campaign import CampaignData
+from stream_chat.types.campaign import CampaignData, GetCampaignOptions
 from stream_chat.types.stream_response import StreamResponse
 
 
@@ -25,7 +25,9 @@ def create(
         pass
 
     @abc.abstractmethod
-    def get(self) -> Union[StreamResponse, Awaitable[StreamResponse]]:
+    def get(
+        self, options: Optional[GetCampaignOptions] = None
+    ) -> Union[StreamResponse, Awaitable[StreamResponse]]:
         pass
 
     @abc.abstractmethod

stream_chat/base/client.py

@@ -8,7 +8,7 @@
 from typing import Any, Awaitable, Dict, Iterable, List, Optional, TypeVar, Union
 
 from stream_chat.types.base import SortParam
-from stream_chat.types.campaign import CampaignData, QueryCampaignsOptions
+from stream_chat.types.campaign import CampaignData, QueryCampaignsOptions, GetCampaignOptions
 from stream_chat.types.segment import (
     QuerySegmentsOptions,
     QuerySegmentTargetsOptions,
@@ -1084,10 +1084,14 @@ def create_campaign(
 
     @abc.abstractmethod
     def get_campaign(
-        self, campaign_id: str
+        self, campaign_id: str, options: Optional[GetCampaignOptions] = None
     ) -> Union[StreamResponse, Awaitable[StreamResponse]]:
         """
-        Create a campaign
+        Get a campaign
+        
+        :param campaign_id: ID of the campaign to get
+        :param options: Optional parameters for the request
+        :return: Campaign data
         """
         pass
 

stream_chat/campaign.py

@@ -2,7 +2,7 @@
 from typing import Any, Optional, Union
 
 from stream_chat.base.campaign import CampaignInterface
-from stream_chat.types.campaign import CampaignData
+from stream_chat.types.campaign import CampaignData, GetCampaignOptions
 from stream_chat.types.stream_response import StreamResponse
 
 
@@ -22,8 +22,8 @@ def create(
             self.campaign_id = state["campaign"]["id"]  # type: ignore
         return state  # type: ignore
 
-    def get(self) -> StreamResponse:
-        return self.client.get_campaign(campaign_id=self.campaign_id)  # type: ignore
+    def get(self, options: Optional[GetCampaignOptions] = None) -> StreamResponse:
+        return self.client.get_campaign(campaign_id=self.campaign_id, options=options)  # type: ignore
 
     def update(self, data: CampaignData) -> StreamResponse:
         return self.client.update_campaign(  # type: ignore

stream_chat/client.py

@@ -9,7 +9,7 @@
 from stream_chat.campaign import Campaign
 from stream_chat.segment import Segment
 from stream_chat.types.base import SortParam
-from stream_chat.types.campaign import CampaignData, QueryCampaignsOptions
+from stream_chat.types.campaign import CampaignData, QueryCampaignsOptions, GetCampaignOptions
 from stream_chat.types.segment import (
     QuerySegmentsOptions,
     QuerySegmentTargetsOptions,
@@ -636,8 +636,11 @@ def create_campaign(
             payload.update(cast(dict, data))
         return self.post("campaigns", data=payload)
 
-    def get_campaign(self, campaign_id: str) -> StreamResponse:
-        return self.get(f"campaigns/{campaign_id}")
+    def get_campaign(self, campaign_id: str, options: Optional[GetCampaignOptions] = None) -> StreamResponse:
+        params = {}
+        if options and "users" in options:
+            params.update(options["users"])
+        return self.get(f"campaigns/{campaign_id}", params)
 
     def query_campaigns(
         self,

stream_chat/tests/async_chat/test_campaign.py

@@ -1,5 +1,5 @@
 import datetime
-from typing import Dict
+from typing import Dict, List
 
 import pytest
 
@@ -61,6 +61,36 @@ async def test_campaign_crud(self, client: StreamChatAsync, random_user: Dict):
 
         await client.delete_segment(segment_id=segment_id)
 
+    async def test_get_campaign_with_user_pagination(self, client: StreamChatAsync, random_users: List[Dict]):
+        # Create a campaign with user_ids
+        campaign = client.campaign(
+            data={
+                "message_template": {
+                    "text": "Test message",
+                },
+                "user_ids": [user["id"] for user in random_users],
+                "sender_id": random_users[0]["id"],
+                "name": "test campaign with users",
+            }
+        )
+        created = await campaign.create()
+        assert created.is_ok()
+        campaign_id = created["campaign"]["id"]
+
+        # Test get_campaign with user pagination options
+        response = await client.get_campaign(
+            campaign_id=campaign_id,
+            options={"users": {"limit": 2}}  # Limit to 2 users per page
+        )
+        assert response.is_ok()
+        assert "campaign" in response
+        assert response["campaign"]["id"] == campaign_id
+        assert "users" in response["campaign"]
+        assert len(response["campaign"]["users"]) <= 2  # Verify pagination limit worked
+
+        # Cleanup
+        await client.delete_campaign(campaign_id=campaign_id)
+
     async def test_campaign_start_stop(
         self, client: StreamChatAsync, random_user: Dict
     ):

stream_chat/tests/test_campaign.py

@@ -1,5 +1,5 @@
 import datetime
-from typing import Dict
+from typing import Dict, List
 
 import pytest
 
@@ -67,6 +67,36 @@ def test_campaign_crud(self, client: StreamChat, random_user: Dict):
         segment_deleted = client.delete_segment(segment_id=segment_id)
         assert segment_deleted.is_ok()
 
+    def test_get_campaign_with_user_pagination(self, client: StreamChat, random_users: List[Dict]):
+        # Create a campaign with user_ids
+        campaign = client.campaign(
+            data={
+                "message_template": {
+                    "text": "Test message",
+                },
+                "user_ids": [user["id"] for user in random_users],
+                "sender_id": random_users[0]["id"],
+                "name": "test campaign with users",
+            }
+        )
+        created = campaign.create()
+        assert created.is_ok()
+        campaign_id = created["campaign"]["id"]
+
+        # Test get_campaign with user pagination options
+        response = client.get_campaign(
+            campaign_id=campaign_id,
+            options={"users": {"limit": 2}}  # Limit to 2 users per page
+        )
+        assert response.is_ok()
+        assert "campaign" in response
+        assert response["campaign"]["id"] == campaign_id
+        assert "users" in response["campaign"]
+        assert len(response["campaign"]["users"]) <= 2  # Verify pagination limit worked
+
+        # Cleanup
+        client.delete_campaign(campaign_id=campaign_id)
+
     def test_campaign_start_stop(self, client: StreamChat, random_user: Dict):
         segment = client.create_segment(segment_type=SegmentType.USER)
         segment_id = segment["segment"]["id"]

stream_chat/types/campaign.py

@@ -1,5 +1,5 @@
 import sys
-from typing import Dict, List, Optional
+from typing import Dict, List, Optional, Union
 
 if sys.version_info >= (3, 8):
     from typing import TypedDict
@@ -76,3 +76,13 @@ class CampaignData(TypedDict, total=False):
 
 class QueryCampaignsOptions(Pager, total=False):
     pass
+
+
+class GetCampaignOptions(TypedDict, total=False):
+    """
+    Options for getting a campaign.
+
+    Parameters:
+        users: Optional Pager containing pagination options for users
+    """
+    users: Optional[Pager]