Skip to content
Merged
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.

134 changes: 128 additions & 6 deletions openapi/chat-openapi-clientside.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -286,16 +286,16 @@ components:
properties:
async_url_enrich_enabled:
type: boolean
x-stream-index: "019"
x-stream-index: "020"
auto_translation_enabled:
type: boolean
x-stream-index: "022"
x-stream-index: "023"
file_upload_config:
$ref: '#/components/schemas/FileUploadConfig'
x-stream-index: "032"
x-stream-index: "033"
image_upload_config:
$ref: '#/components/schemas/FileUploadConfig'
x-stream-index: "033"
x-stream-index: "034"
name:
type: string
x-stream-index: "001"
Expand Down Expand Up @@ -323,6 +323,7 @@ components:
- permission_version
- user_search_disallowed_roles
- multi_tenant_enabled
- allow_multi_user_devices
- image_moderation_enabled
- async_url_enrich_enabled
- auto_translation_enabled
Expand Down Expand Up @@ -2623,6 +2624,22 @@ components:
- duration
title: Response
type: object
DeliveryReceipts:
properties:
enabled:
type: boolean
x-stream-index: "001"
required:
- enabled
type: object
DeliveryReceiptsResponse:
properties:
enabled:
type: boolean
x-stream-index: "001"
required:
- enabled
type: object
Device:
nullable: true
properties:
Expand Down Expand Up @@ -4371,6 +4388,94 @@ components:
x-stream-event-doc-group: other
x-stream-is-event: true
x-stream-ws-base-event-name: VideoEvent
MessageDeliveredEvent:
description: Emitted when a message is marked as delivered.
nullable: true
properties:
channel:
$ref: '#/components/schemas/ChannelResponse'
x-stream-index: "003.001"
channel_custom:
additionalProperties: {}
type: object
x-stream-index: 001.001.006
channel_id:
description: The ID of the channel where the message was read
title: Channel ID
type: string
x-stream-index: 001.002.002
channel_member_count:
description: The number of members in the channel
format: int32
title: Channel Member Count
type: integer
x-stream-index: 001.001.004
channel_message_count:
description: The number of messages in the channel
format: int64
title: Channel Message Count
type: integer
x-stream-index: 001.001.005
channel_type:
description: The type of the channel where the message was read
title: Channel Type
type: string
x-stream-index: 001.002.001
cid:
description: The CID of the channel where the message was read
title: Channel CID
type: string
x-stream-index: 001.001.001.002
created_at:
description: Date/time of creation
format: date-time
title: Created at
type: string
x-stream-index: 001.001.001.001.003
custom:
additionalProperties: {}
type: object
x-stream-index: 001.001.001.001.007
last_delivered_at:
description: The time when the message was delivered
title: Last Delivered At
type: string
x-stream-index: "005"
last_delivered_message_id:
description: The ID of the last delivered message
title: Last Delivered Message ID
type: string
x-stream-index: "004"
received_at:
format: date-time
type: string
x-stream-index: 001.001.001.001.004
team:
description: The team ID
title: Team
type: string
x-stream-index: 001.001.003
type:
default: message.delivered
description: 'The type of event: "message.delivered" in this case'
title: Event Type
type: string
x-stream-index: 001.001.001.001.002
user:
$ref: '#/components/schemas/UserResponseCommonFields'
description: The user that received the message
title: User
x-stream-index: "002.001"
required:
- type
- created_at
- custom
title: MessageDeliveredEvent
type: object
x-stream-event-client-type: true
x-stream-event-doc-group: other
x-stream-is-event: true
x-stream-ws-base-event-name: VideoEvent
MessageFlagResponse:
nullable: true
properties:
Expand Down Expand Up @@ -4524,7 +4629,7 @@ components:
type: array
x-stream-index: "001.002"
type:
default: notification.thread_message_new
default: message.new
type: string
x-stream-index: "004.001"
user:
Expand Down Expand Up @@ -7234,6 +7339,9 @@ components:
type: object
PrivacySettings:
properties:
delivery_receipts:
$ref: '#/components/schemas/DeliveryReceipts'
x-stream-index: "003"
read_receipts:
$ref: '#/components/schemas/ReadReceipts'
x-stream-index: "002"
Expand All @@ -7243,6 +7351,9 @@ components:
type: object
PrivacySettingsResponse:
properties:
delivery_receipts:
$ref: '#/components/schemas/DeliveryReceiptsResponse'
x-stream-index: "003"
read_receipts:
$ref: '#/components/schemas/ReadReceiptsResponse'
x-stream-index: "002"
Expand Down Expand Up @@ -8266,6 +8377,13 @@ components:
type: object
ReadStateResponse:
properties:
last_delivered_at:
format: date-time
type: string
x-stream-index: "005"
last_delivered_message_id:
type: string
x-stream-index: "006"
last_read:
format: date-time
type: string
Expand Down Expand Up @@ -11597,6 +11715,7 @@ components:
draft.deleted: '#/components/schemas/DraftDeletedEvent'
draft.updated: '#/components/schemas/DraftUpdatedEvent'
health.check: '#/components/schemas/HealthCheckEvent'
message.delivered: '#/components/schemas/MessageDeliveredEvent'
message.pending: '#/components/schemas/PendingMessageEvent'
notification.reminder_due: '#/components/schemas/ReminderNotificationEvent'
poll.closed: '#/components/schemas/PollClosedEvent'
Expand All @@ -11616,6 +11735,7 @@ components:
- $ref: '#/components/schemas/DraftDeletedEvent'
- $ref: '#/components/schemas/DraftUpdatedEvent'
- $ref: '#/components/schemas/HealthCheckEvent'
- $ref: '#/components/schemas/MessageDeliveredEvent'
- $ref: '#/components/schemas/PendingMessageEvent'
- $ref: '#/components/schemas/PollClosedEvent'
- $ref: '#/components/schemas/PollDeletedEvent'
Expand Down Expand Up @@ -11656,6 +11776,7 @@ components:
member.removed: '#/components/schemas/MemberRemovedEvent'
member.updated: '#/components/schemas/MemberUpdatedEvent'
message.deleted: '#/components/schemas/MessageDeletedEvent'
message.delivered: '#/components/schemas/MessageDeliveredEvent'
message.new: '#/components/schemas/MessageNewEvent'
message.pending: '#/components/schemas/PendingMessageEvent'
message.read: '#/components/schemas/MessageReadEvent'
Expand Down Expand Up @@ -11725,6 +11846,7 @@ components:
- $ref: '#/components/schemas/MemberRemovedEvent'
- $ref: '#/components/schemas/MemberUpdatedEvent'
- $ref: '#/components/schemas/MessageDeletedEvent'
- $ref: '#/components/schemas/MessageDeliveredEvent'
- $ref: '#/components/schemas/MessageNewEvent'
- $ref: '#/components/schemas/MessageNewEvent'
- $ref: '#/components/schemas/MessageReadEvent'
Expand Down Expand Up @@ -11861,7 +11983,7 @@ components:
type: apiKey
info:
title: Stream API
version: v196.23.0
version: v198.1.0
openapi: 3.0.3
paths:
/app:
Expand Down
2 changes: 1 addition & 1 deletion openapi/chat-openapi.json

Large diffs are not rendered by default.

Loading