Skip to content

Commit 3432aa2

Browse files
[CHA-2354] Add ParsedPredefinedFilterResponse type
Add type definition for the new `predefined_filter` field returned in QueryChannels responses when a predefined filter is used. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
1 parent cdd180c commit 3432aa2

File tree

1 file changed

+18
-1
lines changed

1 file changed

+18
-1
lines changed

stream_chat/types/base.py

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
import sys
22
from enum import IntEnum
3-
from typing import Optional
3+
from typing import Any, Dict, List, Optional
44

55
if sys.version_info >= (3, 8):
66
from typing import TypedDict
@@ -43,3 +43,20 @@ class Pager(TypedDict, total=False):
4343
limit: Optional[int]
4444
next: Optional[str]
4545
prev: Optional[str]
46+
47+
48+
class ParsedPredefinedFilterResponse(TypedDict, total=False):
49+
"""
50+
Represents the parsed/interpolated predefined filter returned in QueryChannels response.
51+
52+
This is only present when a predefined filter is used in the query.
53+
54+
Parameters:
55+
name: The name of the predefined filter that was used.
56+
filter: The interpolated filter with placeholders replaced by actual values.
57+
sort: The interpolated sort parameters (optional).
58+
"""
59+
60+
name: str
61+
filter: Dict[str, Any]
62+
sort: Optional[List[SortParam]]

0 commit comments

Comments
 (0)