Skip to content

feat: support members_template property for campaigns #209

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 10, 2025
Merged

feat: support members_template property for campaigns #209

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions stream_chat/types/campaign.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,21 @@ class MessageTemplate(TypedDict, total=False):
custom: Optional[Dict]


class MemberTemplate(TypedDict, total=False):
"""
Represents the data structure for a member in the members_template.

Parameters:
user_id: The ID of the user.
channel_role: The role of the user in the channel.
custom: Custom data for the member.
"""

user_id: str
channel_role: Optional[str]
custom: Optional[Dict]


class ChannelTemplate(TypedDict, total=False):
"""
Represents the data structure for a channel template.
Expand All @@ -32,12 +47,14 @@ class ChannelTemplate(TypedDict, total=False):
type: The type of channel.
id: The ID of the channel.
members: List of member IDs.
members_template: List of member templates with roles and custom data.
custom: Custom data.
"""

type: str
id: Optional[str]
members: Optional[List[str]]
members_template: Optional[List[MemberTemplate]]
custom: Optional[Dict]


Expand Down