@@ -313,6 +313,24 @@ components:
313313 - duration
314314 title: AddUserGroupMembersResponse
315315 type: object
316+ AppDefaults:
317+ description: Request limit defaults applied by the server when the corresponding
318+ field is omitted.
319+ properties:
320+ get_or_create_channel:
321+ $ref: '#/components/schemas/GetOrCreateChannelDefaults'
322+ description: Defaults applied by the get-or-create channel endpoint.
323+ title: Get or create channel
324+ x-stream-index: "002"
325+ query_channels:
326+ $ref: '#/components/schemas/QueryChannelsDefaults'
327+ description: Defaults applied by the query channels endpoint.
328+ title: Query channels
329+ x-stream-index: "001"
330+ required:
331+ - query_channels
332+ - get_or_create_channel
333+ type: object
316334 AppEventResponse:
317335 properties:
318336 async_url_enrich_enabled:
@@ -357,6 +375,12 @@ components:
357375 title: Auto translation enabled
358376 type: boolean
359377 x-stream-index: "023"
378+ defaults:
379+ $ref: '#/components/schemas/AppDefaults'
380+ description: Request limit defaults the server applies when the corresponding
381+ field is omitted.
382+ title: Defaults
383+ x-stream-index: "038"
360384 file_upload_config:
361385 $ref: '#/components/schemas/FileUploadConfig'
362386 description: The file uploading configuration.
@@ -387,6 +411,7 @@ components:
387411 - auto_translation_enabled
388412 - file_upload_config
389413 - image_upload_config
414+ - defaults
390415 type: object
391416 AppUpdatedEvent:
392417 description: Emitted when app settings are updated
@@ -798,6 +823,68 @@ components:
798823 title: VoteData
799824 x-stream-index: "004"
800825 type: object
826+ ChannelBanResponse:
827+ nullable: true
828+ properties:
829+ channel_ban:
830+ $ref: '#/components/schemas/ChannelBanScopeResponse'
831+ x-stream-index: "004"
832+ created_at:
833+ format: date-time
834+ type: string
835+ x-stream-index: "002"
836+ future_channel_ban:
837+ $ref: '#/components/schemas/ChannelBanScopeResponse'
838+ x-stream-index: "005"
839+ scopes:
840+ items:
841+ type: string
842+ type: array
843+ x-stream-index: "003"
844+ user:
845+ $ref: '#/components/schemas/UserResponse'
846+ x-stream-index: "001"
847+ required:
848+ - created_at
849+ - scopes
850+ type: object
851+ ChannelBanScopeResponse:
852+ properties:
853+ banned_by:
854+ $ref: '#/components/schemas/UserResponse'
855+ x-stream-index: "001"
856+ created_at:
857+ format: date-time
858+ type: string
859+ x-stream-index: "005"
860+ expires:
861+ format: date-time
862+ type: string
863+ x-stream-index: "002"
864+ reason:
865+ type: string
866+ x-stream-index: "003"
867+ shadow:
868+ type: boolean
869+ x-stream-index: "004"
870+ required:
871+ - shadow
872+ - created_at
873+ type: object
874+ ChannelBansScopeTotals:
875+ properties:
876+ channel:
877+ format: int32
878+ type: integer
879+ x-stream-index: "001"
880+ future_channel:
881+ format: int32
882+ type: integer
883+ x-stream-index: "002"
884+ required:
885+ - channel
886+ - future_channel
887+ type: object
801888 ChannelConfigOverrides:
802889 description: Channel configuration overrides
803890 properties:
@@ -1785,6 +1872,7 @@ components:
17851872 type: string
17861873 x-stream-index: "001"
17871874 required:
1875+ - user_id
17881876 - custom
17891877 - created_at
17901878 - updated_at
@@ -2847,6 +2935,10 @@ components:
28472935 device:
28482936 $ref: '#/components/schemas/DeviceFields'
28492937 x-stream-index: "002"
2938+ event_protocol:
2939+ format: int32
2940+ type: integer
2941+ x-stream-index: "004"
28502942 member_custom_include:
28512943 items:
28522944 type: string
@@ -4594,6 +4686,23 @@ components:
45944686 title: Get OG Attachment
45954687 type: object
45964688 x-stream-docs-page-id: og
4689+ GetOrCreateChannelDefaults:
4690+ description: Defaults applied by the get-or-create channel endpoint.
4691+ properties:
4692+ members:
4693+ $ref: '#/components/schemas/PagerDefaults'
4694+ description: Defaults for the `members` pagination object.
4695+ title: Members
4696+ x-stream-index: "002"
4697+ messages:
4698+ $ref: '#/components/schemas/PagerDefaults'
4699+ description: Defaults for the `messages` pagination object.
4700+ title: Messages
4701+ x-stream-index: "001"
4702+ required:
4703+ - messages
4704+ - members
4705+ type: object
45974706 GetPinnedMessagesResponse:
45984707 nullable: true
45994708 properties:
@@ -8830,6 +8939,19 @@ components:
88308939 - total_unread_count
88318940 - unread_channels
88328941 - unread_threads
8942+ - blocked_user_ids
8943+ type: object
8944+ PagerDefaults:
8945+ description: Resolved defaults for a nested pagination object.
8946+ properties:
8947+ limit:
8948+ description: Number of records returned when `limit` is omitted.
8949+ format: int32
8950+ title: Limit
8951+ type: integer
8952+ x-stream-index: "001"
8953+ required:
8954+ - limit
88338955 type: object
88348956 PaginationParams:
88358957 properties:
@@ -9851,6 +9973,125 @@ components:
98519973 - bans
98529974 - duration
98539975 type: object
9976+ QueryChannelBansRequest:
9977+ nullable: true
9978+ properties:
9979+ exclude_expired_bans:
9980+ description: Whether to exclude expired bans or not
9981+ title: Exclude expired bans
9982+ type: boolean
9983+ x-stream-index: "002"
9984+ filter_conditions:
9985+ additionalProperties: {}
9986+ description: Filter conditions to apply to the query
9987+ title: Filter
9988+ type: object
9989+ x-stream-filter-fields:
9990+ user_id:
9991+ operators:
9992+ - $autocomplete
9993+ - $eq
9994+ - $in
9995+ type: string
9996+ x-stream-index: "001"
9997+ include_total:
9998+ description: 'When true, the response includes total and total_by_scope:
9999+ the number of banned users overall and per scope, independent of paging'
10000+ title: Include total
10001+ type: boolean
10002+ x-stream-index: "003"
10003+ limit:
10004+ format: int32
10005+ maximum: 100
10006+ minimum: 0
10007+ type: integer
10008+ x-stream-index: "007.001"
10009+ next:
10010+ type: string
10011+ x-stream-index: "007.002"
10012+ prev:
10013+ type: string
10014+ x-stream-index: "007.003"
10015+ type: object
10016+ QueryChannelBansResponse:
10017+ nullable: true
10018+ properties:
10019+ bans:
10020+ description: Users banned from the channel, one entry per user, newest ban
10021+ first
10022+ items:
10023+ $ref: '#/components/schemas/ChannelBanResponse'
10024+ title: ChannelBanResponse
10025+ type: array
10026+ x-stream-index: "001"
10027+ duration:
10028+ description: Duration of the request in milliseconds
10029+ title: Duration
10030+ type: string
10031+ x-stream-index: "005.001"
10032+ next:
10033+ type: string
10034+ x-stream-index: "004.001"
10035+ prev:
10036+ type: string
10037+ x-stream-index: "004.002"
10038+ total:
10039+ description: Number of banned users, each counted once, ignoring paging.
10040+ Counted per scope with a cap of 100000 each, so it can reach 200000. Only
10041+ present when include_total is set on the request; omitted when counting
10042+ timed out
10043+ format: int32
10044+ title: Total
10045+ type: integer
10046+ x-stream-index: "002"
10047+ total_by_scope:
10048+ $ref: '#/components/schemas/ChannelBansScopeTotals'
10049+ description: Number of banned users per scope, ignoring paging and capped
10050+ at 100000 per scope. Present together with total
10051+ title: Total by scope
10052+ x-stream-index: "003"
10053+ required:
10054+ - bans
10055+ - duration
10056+ type: object
10057+ QueryChannelsDefaults:
10058+ description: Defaults applied by the query channels endpoint.
10059+ properties:
10060+ limit:
10061+ description: Number of channels returned when `limit` is omitted.
10062+ format: int32
10063+ title: Limit
10064+ type: integer
10065+ x-stream-index: "001"
10066+ max_limit:
10067+ description: Largest number of channels returned for one request. A bigger
10068+ `limit` is silently clamped to this value rather than rejected. An app
10069+ with no per-app override gets a higher ceiling for the narrow case of
10070+ a request asking for at most one message and one member per channel.
10071+ format: int32
10072+ title: Max limit
10073+ type: integer
10074+ x-stream-index: "002"
10075+ member_limit:
10076+ description: Number of members returned per channel when `member_limit`
10077+ is omitted.
10078+ format: int32
10079+ title: Member limit
10080+ type: integer
10081+ x-stream-index: "004"
10082+ message_limit:
10083+ description: Number of messages returned per channel when `message_limit`
10084+ is omitted.
10085+ format: int32
10086+ title: Message limit
10087+ type: integer
10088+ x-stream-index: "003"
10089+ required:
10090+ - limit
10091+ - max_limit
10092+ - message_limit
10093+ - member_limit
10094+ type: object
985410095 QueryChannelsRequest:
985510096 nullable: true
985610097 properties:
@@ -17321,7 +17562,7 @@ components:
1732117562 type: apiKey
1732217563info:
1732317564 title: Stream API
17324- version: v239.67.1
17565+ version: v239.68.0
1732517566openapi: 3.0.3
1732617567paths:
1732717568 /app:
@@ -17867,6 +18108,58 @@ paths:
1786718108 summary: Update channel
1786818109 tags:
1786918110 - product:chat
18111+ /channels/{type}/{id}/bans/query:
18112+ post:
18113+ description: |
18114+ Lists the users banned from a channel, by a ban on the channel or by a future channel ban issued by the channel's creator, with one entry per user
18115+ operationId: QueryChannelBans
18116+ parameters:
18117+ - in: path
18118+ name: type
18119+ required: true
18120+ schema:
18121+ description: Channel type to interact with
18122+ title: Channel type
18123+ type: string
18124+ writeOnly: true
18125+ x-stream-index: "004.001"
18126+ - in: path
18127+ name: id
18128+ required: true
18129+ schema:
18130+ description: Channel ID to interact with
18131+ title: Channel ID
18132+ type: string
18133+ writeOnly: true
18134+ x-stream-index: "004.002"
18135+ requestBody:
18136+ content:
18137+ application/json:
18138+ schema:
18139+ $ref: '#/components/schemas/QueryChannelBansRequest'
18140+ required: true
18141+ responses:
18142+ "201":
18143+ content:
18144+ application/json:
18145+ schema:
18146+ $ref: '#/components/schemas/QueryChannelBansResponse'
18147+ description: Successful response
18148+ "400":
18149+ content:
18150+ application/json:
18151+ schema:
18152+ $ref: '#/components/schemas/APIError'
18153+ description: Bad request
18154+ "429":
18155+ content:
18156+ application/json:
18157+ schema:
18158+ $ref: '#/components/schemas/APIError'
18159+ description: Too many requests
18160+ summary: Query channel bans
18161+ tags:
18162+ - product:chat
1787018163 /channels/{type}/{id}/draft:
1787118164 delete:
1787218165 description: |
0 commit comments