Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion openapi/chat-openapi-clientside.json

Large diffs are not rendered by default.

83 changes: 80 additions & 3 deletions openapi/chat-openapi-clientside.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -1382,6 +1382,11 @@ components:
disabled:
type: boolean
x-stream-index: "014"
filter_tags:
items:
type: string
type: array
x-stream-index: "026"
frozen:
description: Freeze or unfreeze the channel
title: Frozen
Expand Down Expand Up @@ -2329,6 +2334,7 @@ components:
- domain
- domain_allowlist
- email
- email_allowlist
- word
title: Type
type: string
Expand Down Expand Up @@ -2667,6 +2673,15 @@ components:
- duration
title: Response
type: object
DeliveredMessagePayload:
properties:
cid:
type: string
x-stream-index: "001"
id:
type: string
x-stream-index: "002"
type: object
DeliveryReceipts:
properties:
enabled:
Expand Down Expand Up @@ -3667,7 +3682,7 @@ components:
reactions:
description: List of reactions
items:
$ref: '#/components/schemas/Reaction'
$ref: '#/components/schemas/ReactionResponse'
title: Reactions
type: array
x-stream-index: "001"
Expand Down Expand Up @@ -3992,6 +4007,28 @@ components:
type: object
x-stream-index: "001"
type: object
MarkDeliveredRequest:
nullable: true
properties:
latest_delivered_messages:
items:
$ref: '#/components/schemas/DeliveredMessagePayload'
type: array
x-stream-index: "001"
type: object
MarkDeliveredResponse:
description: Basic response information
nullable: true
properties:
duration:
description: Duration of the request in milliseconds
title: Duration
type: string
x-stream-index: "001.001"
required:
- duration
title: Response
type: object
MarkReadRequest:
nullable: true
properties:
Expand Down Expand Up @@ -4030,8 +4067,15 @@ components:
title: Message ID
type: string
x-stream-index: "001"
message_timestamp:
description: Timestamp of the message from where the channel is marked unread
format: date-time
title: Message Timestamp
type: string
x-stream-index: "004"
thread_id:
description: Mark a thread unread, specify both the thread and message id
description: Mark a thread unread, specify one of the thread, message timestamp,
or message id
title: Thread ID
type: string
x-stream-index: "003"
Expand Down Expand Up @@ -12167,7 +12211,7 @@ components:
type: apiKey
info:
title: Stream API
version: v200.1.0
version: v202.2.0
openapi: 3.0.3
paths:
/app:
Expand Down Expand Up @@ -13613,6 +13657,39 @@ paths:
summary: Deletes channels asynchronously
tags:
- product:chat
/channels/delivered:
post:
description: |
Mark the status of a channel message delivered.
operationId: MarkDelivered
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/MarkDeliveredRequest'
required: true
responses:
"201":
content:
application/json:
schema:
$ref: '#/components/schemas/MarkDeliveredResponse'
description: Response
"400":
content:
application/json:
schema:
$ref: '#/components/schemas/APIError'
description: Bad request
"429":
content:
application/json:
schema:
$ref: '#/components/schemas/APIError'
description: Too many requests
summary: Mark channel message delivery status
tags:
- product:chat
/channels/read:
post:
description: |
Expand Down
2 changes: 1 addition & 1 deletion openapi/chat-openapi.json

Large diffs are not rendered by default.

127 changes: 120 additions & 7 deletions openapi/chat-openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -1266,12 +1266,28 @@ components:
- updated_at
- recording_external_storage
type: object
CampaignChannelMember:
nullable: true
properties:
channel_role:
type: string
x-stream-index: "002"
custom:
additionalProperties: {}
type: object
x-stream-index: "003"
user_id:
type: string
x-stream-index: "001"
required:
- user_id
type: object
CampaignChannelTemplate:
properties:
custom:
additionalProperties: {}
type: object
x-stream-index: "005"
x-stream-index: "006"
id:
type: string
x-stream-index: "002"
Expand All @@ -1281,10 +1297,16 @@ components:
maximum: 1000
type: array
x-stream-index: "003"
members_template:
items:
$ref: '#/components/schemas/CampaignChannelMember'
maximum: 1000
type: array
x-stream-index: "004"
team:
maxLength: 1000
type: string
x-stream-index: "004"
x-stream-index: "005"
type:
maxLength: 64
type: string
Expand Down Expand Up @@ -2200,6 +2222,11 @@ components:
disabled:
type: boolean
x-stream-index: "014"
filter_tags:
items:
type: string
type: array
x-stream-index: "026"
frozen:
description: Freeze or unfreeze the channel
title: Frozen
Expand Down Expand Up @@ -3552,6 +3579,7 @@ components:
- domain
- domain_allowlist
- email
- email_allowlist
- word
title: Type
type: string
Expand Down Expand Up @@ -4692,6 +4720,15 @@ components:
- task_id
- duration
type: object
DeliveredMessagePayload:
properties:
cid:
type: string
x-stream-index: "001"
id:
type: string
x-stream-index: "002"
type: object
DeliveryReceipts:
properties:
enabled:
Expand Down Expand Up @@ -6346,7 +6383,7 @@ components:
reactions:
description: List of reactions
items:
$ref: '#/components/schemas/Reaction'
$ref: '#/components/schemas/ReactionResponse'
title: Reactions
type: array
x-stream-index: "001"
Expand Down Expand Up @@ -7127,6 +7164,28 @@ components:
type: string
x-stream-index: "002.001"
type: object
MarkDeliveredRequest:
nullable: true
properties:
latest_delivered_messages:
items:
$ref: '#/components/schemas/DeliveredMessagePayload'
type: array
x-stream-index: "001"
type: object
MarkDeliveredResponse:
description: Basic response information
nullable: true
properties:
duration:
description: Duration of the request in milliseconds
title: Duration
type: string
x-stream-index: "001.001"
required:
- duration
title: Response
type: object
MarkReadRequest:
nullable: true
properties:
Expand Down Expand Up @@ -7171,17 +7230,24 @@ components:
title: Message ID
type: string
x-stream-index: "001"
message_timestamp:
description: Timestamp of the message from where the channel is marked unread
format: date-time
title: Message Timestamp
type: string
x-stream-index: "004"
thread_id:
description: Mark a thread unread, specify both the thread and message id
description: Mark a thread unread, specify one of the thread, message timestamp,
or message id
title: Thread ID
type: string
x-stream-index: "003"
user:
$ref: '#/components/schemas/UserRequest'
x-stream-index: "004.002"
x-stream-index: "005.002"
user_id:
type: string
x-stream-index: "004.001"
x-stream-index: "005.001"
type: object
MemberAddedEvent:
properties:
Expand Down Expand Up @@ -16802,7 +16868,7 @@ components:
type: apiKey
info:
title: Stream API
version: v200.1.0
version: v202.2.0
openapi: 3.0.3
paths:
/app:
Expand Down Expand Up @@ -18381,6 +18447,46 @@ paths:
summary: Deletes channels asynchronously
tags:
- product:chat
/channels/delivered:
post:
description: |
Mark the status of a channel message delivered.
operationId: MarkDelivered
parameters:
- in: query
name: user_id
schema:
type: string
writeOnly: true
x-stream-index: "002.001"
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/MarkDeliveredRequest'
required: true
responses:
"201":
content:
application/json:
schema:
$ref: '#/components/schemas/MarkDeliveredResponse'
description: Response
"400":
content:
application/json:
schema:
$ref: '#/components/schemas/APIError'
description: Bad request
"429":
content:
application/json:
schema:
$ref: '#/components/schemas/APIError'
description: Too many requests
summary: Mark channel message delivery status
tags:
- product:chat
/channels/read:
post:
description: |
Expand Down Expand Up @@ -22255,6 +22361,13 @@ paths:
description: |
Fetch unread counts for a single user
operationId: UnreadCounts
parameters:
- in: query
name: user_id
schema:
type: string
writeOnly: true
x-stream-index: "001.001"
responses:
"200":
content:
Expand Down
2 changes: 1 addition & 1 deletion openapi/clientside-api.json

Large diffs are not rendered by default.

Loading