@@ -4152,6 +4152,72 @@ components:
41524152 - duration
41534153 title: GetUserGroupResponse
41544154 type: object
4155+ GroupedChannelsBucket:
4156+ properties:
4157+ channels:
4158+ description: Channels returned for this bucket
4159+ items:
4160+ $ref: '#/components/schemas/ChannelStateResponseFields'
4161+ title: Channels
4162+ type: array
4163+ x-stream-index: "001"
4164+ unread_channels:
4165+ description: Unread channels currently classified into this bucket
4166+ format: int32
4167+ title: Unread Channels
4168+ type: integer
4169+ x-stream-index: "002"
4170+ required:
4171+ - channels
4172+ title: Grouped Channels Bucket
4173+ type: object
4174+ GroupedQueryChannelsRequest:
4175+ nullable: true
4176+ properties:
4177+ limit:
4178+ description: Max channels per bucket (default 10)
4179+ format: int32
4180+ maximum: 10
4181+ title: Limit
4182+ type: integer
4183+ x-stream-index: "001"
4184+ presence:
4185+ description: Whether to subscribe to presence events for channel members
4186+ title: Presence
4187+ type: boolean
4188+ x-stream-index: "003"
4189+ watch:
4190+ description: Whether to start watching found channels or not
4191+ title: Watch
4192+ type: boolean
4193+ x-stream-index: "002"
4194+ title: Grouped Query Channels Request
4195+ type: object
4196+ x-stream-docs-page-id: grouped_query_channels
4197+ GroupedQueryChannelsResponse:
4198+ nullable: true
4199+ properties:
4200+ duration:
4201+ description: Duration of the request in milliseconds
4202+ title: Duration
4203+ type: string
4204+ x-stream-index: "002.001"
4205+ groups:
4206+ additionalProperties:
4207+ $ref: '#/components/schemas/GroupedChannelsBucket'
4208+ description: Predefined channel groups keyed by group name
4209+ title: Groups
4210+ type: object
4211+ x-stream-index: "001"
4212+ x-stream-map:
4213+ description: Channels and unread counts for one group
4214+ key: group_name
4215+ title: Grouped Channels Bucket
4216+ required:
4217+ - groups
4218+ - duration
4219+ title: Grouped Query Channels Response
4220+ type: object
41554221 HealthCheckEvent:
41564222 nullable: true
41574223 properties:
@@ -5304,6 +5370,12 @@ components:
53045370 additionalProperties: {}
53055371 type: object
53065372 x-stream-index: 001.001.001.001.001.007
5373+ grouped_unread_channels:
5374+ additionalProperties:
5375+ format: int32
5376+ type: integer
5377+ type: object
5378+ x-stream-index: "010"
53075379 message:
53085380 $ref: '#/components/schemas/MessageResponse'
53095381 description: The new message
@@ -6793,6 +6865,12 @@ components:
67936865 additionalProperties: {}
67946866 type: object
67956867 x-stream-index: 001.001.001.001.001.007
6868+ grouped_unread_channels:
6869+ additionalProperties:
6870+ format: int32
6871+ type: integer
6872+ type: object
6873+ x-stream-index: "005"
67966874 received_at:
67976875 format: date-time
67986876 type: string
@@ -6930,6 +7008,12 @@ components:
69307008 additionalProperties: {}
69317009 type: object
69327010 x-stream-index: 001.001.001.001.001.007
7011+ grouped_unread_channels:
7012+ additionalProperties:
7013+ format: int32
7014+ type: integer
7015+ type: object
7016+ x-stream-index: "006"
69337017 message:
69347018 $ref: '#/components/schemas/MessageResponse'
69357019 description: The message regarding the update
@@ -7300,6 +7384,12 @@ components:
73007384 additionalProperties: {}
73017385 type: object
73027386 x-stream-index: 001.001.001.001.007
7387+ grouped_unread_channels:
7388+ additionalProperties:
7389+ format: int32
7390+ type: integer
7391+ type: object
7392+ x-stream-index: "010"
73037393 last_read_message_id:
73047394 description: The ID of the last read message
73057395 title: Last Read Message ID
@@ -7353,13 +7443,13 @@ components:
73537443 format: int32
73547444 title: Unread Thread Messages
73557445 type: integer
7356- x-stream-index: "011 "
7446+ x-stream-index: "012 "
73577447 unread_threads:
73587448 description: The number of unread threads
73597449 format: int32
73607450 title: Unread Threads
73617451 type: integer
7362- x-stream-index: "010 "
7452+ x-stream-index: "011 "
73637453 user:
73647454 $ref: '#/components/schemas/UserResponseCommonFields'
73657455 description: The user who marked the channel as read
@@ -7432,6 +7522,12 @@ components:
74327522 title: First Unread Message ID
74337523 type: string
74347524 x-stream-index: "005"
7525+ grouped_unread_channels:
7526+ additionalProperties:
7527+ format: int32
7528+ type: integer
7529+ type: object
7530+ x-stream-index: "012"
74357531 last_read_at:
74367532 description: The time when the channel/thread was marked as unread
74377533 format: date-time
@@ -7492,13 +7588,13 @@ components:
74927588 format: int32
74937589 title: Unread Thread Messages
74947590 type: integer
7495- x-stream-index: "013 "
7591+ x-stream-index: "014 "
74967592 unread_threads:
74977593 description: The number of unread threads
74987594 format: int32
74997595 title: Unread Threads
75007596 type: integer
7501- x-stream-index: "012 "
7597+ x-stream-index: "013 "
75027598 user:
75037599 $ref: '#/components/schemas/UserResponseCommonFields'
75047600 description: The user who marked the channel as unread
@@ -7602,6 +7698,12 @@ components:
76027698 additionalProperties: {}
76037699 type: object
76047700 x-stream-index: 001.001.001.001.001.007
7701+ grouped_unread_channels:
7702+ additionalProperties:
7703+ format: int32
7704+ type: integer
7705+ type: object
7706+ x-stream-index: "010"
76057707 message:
76067708 $ref: '#/components/schemas/MessageResponse'
76077709 description: The new message
@@ -9136,6 +9238,18 @@ components:
91369238 - $in
91379239 - $nin
91389240 type: string
9241+ message_count:
9242+ operators:
9243+ - $eq
9244+ - $exists
9245+ - $gt
9246+ - $gte
9247+ - $in
9248+ - $lt
9249+ - $lte
9250+ - $ne
9251+ - $nin
9252+ type: number
91399253 muted:
91409254 operators:
91419255 - $eq
@@ -11262,6 +11376,18 @@ components:
1126211376 - $in
1126311377 - $nin
1126411378 type: string
11379+ message_count:
11380+ operators:
11381+ - $eq
11382+ - $exists
11383+ - $gt
11384+ - $gte
11385+ - $in
11386+ - $lt
11387+ - $lte
11388+ - $ne
11389+ - $nin
11390+ type: number
1126511391 muted:
1126611392 operators:
1126711393 - $eq
@@ -15572,7 +15698,7 @@ components:
1557215698 type: apiKey
1557315699info:
1557415700 title: Stream API
15575- version: v226.17.1
15701+ version: v226.18.0
1557615702openapi: 3.0.3
1557715703paths:
1557815704 /app:
@@ -17036,6 +17162,46 @@ paths:
1703617162 summary: Mark channel message delivery status
1703717163 tags:
1703817164 - product:chat
17165+ /channels/grouped:
17166+ post:
17167+ description: |
17168+ Query channels grouped into predefined buckets. Only available for enterprise apps.
17169+ operationId: GroupedQueryChannels
17170+ parameters:
17171+ - in: query
17172+ name: connection_id
17173+ schema:
17174+ type: string
17175+ x-stream-index: "007.003"
17176+ requestBody:
17177+ content:
17178+ application/json:
17179+ schema:
17180+ $ref: '#/components/schemas/GroupedQueryChannelsRequest'
17181+ description: Grouped Query Channels Request
17182+ required: true
17183+ responses:
17184+ "201":
17185+ content:
17186+ application/json:
17187+ schema:
17188+ $ref: '#/components/schemas/GroupedQueryChannelsResponse'
17189+ description: Grouped Query Channels Response
17190+ "400":
17191+ content:
17192+ application/json:
17193+ schema:
17194+ $ref: '#/components/schemas/APIError'
17195+ description: Bad request
17196+ "429":
17197+ content:
17198+ application/json:
17199+ schema:
17200+ $ref: '#/components/schemas/APIError'
17201+ description: Too many requests
17202+ summary: Grouped query channels
17203+ tags:
17204+ - product:chat
1703917205 /channels/read:
1704017206 post:
1704117207 description: |
@@ -18145,6 +18311,12 @@ paths:
1814518311 type: boolean
1814618312 writeOnly: true
1814718313 x-stream-index: "006"
18314+ - in: query
18315+ name: reason
18316+ schema:
18317+ type: string
18318+ writeOnly: true
18319+ x-stream-index: "007"
1814818320 responses:
1814918321 "200":
1815018322 content:
0 commit comments